create-file-import

Prev Next

Available in VPC

Request file import to import a file from an Object Storage bucket into a box.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/import/create-file-import

Request headers

For information about the headers common to all Datafence APIs, see Datafence request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
fenceId Integer Required Datafence number
boxId Integer Required Box number
sourceBucketName String Required Source bucket name
sourceFilePathList Array Required List of file names requested for import
  • Number of files that can be imported at the same time: 10
  • Maximum size per file: 2 GB
targetNasInstanceNo String Required Target NAS instance number
description String Required Description for the import request
  • 1-50 characters

Request example

The request example is as follows:

curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/import/create-file-import' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "fenceId": 26,
  "boxId": 74,
  "sourceBucketName": "test-bucket-for-fence",
  "sourceFilePathList": ["datafence001.txt", "datafence002.txt"],
  "targetNasInstanceNo": ********,
  "description": "File import request"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
message String - API processing result message

Response status codes

For information about the HTTP status codes common to all Datafence APIs, see Datafence API response status codes.

Response example

The response example is as follows:

{
    "message": "File import requested."
}