apply-file-import

Available in VPC

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

Request

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

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

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request body

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

Field	Type	Required	Description
`dataBoxFrameNo`	Integer	Required	Data Box Frame number See get-data-box-frame-list.
`dataBoxNo`	Integer	Required	Data Box number See get-data-box-list.
`memo`	String	Optional	Description for the import request 1-50 characters
`sourceBucketName`	String	Required	Source bucket name
`sourceFileInfoList`	Array	Required	Import file information list
`targetNasInstanceNo`	Integer	Required	Target NAS instance number See get-target-nas-list.

`sourceFileInfoList`

The following describes sourceFileInfoList.

Field	Type	Required	Description
`fileName`	String	Required	Import file name list Up to 5 files can be imported at a time. Individual file size: 500 MB or less

Request example

The request example is as follows:

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/import/apply-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 '{
  "dataBoxFrameNo": 83,
  "dataBoxNo": 381,
  "memo": "dbf001",
  "sourceBucketName": "testddfdas",
  "sourceFileInfoList": [
    {
      "fileName": "sample.xlsx"
    }
  ],
  "targetNasInstanceNo": *********
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`totalCount`	Integer	-	Number of response results
`importApplyId`	String	-	Import request ID
`dataBoxNo`	String	-	Data Box number
`dataBoxName`	String	-	Data Box name
`nasInstanceName`	String	-	Target NAS name
`sourceBucketName`	String	-	Source bucket name
`sourceBucketFileName`	String	-	Import file name
`status`	String	-	Import status code See File import status code.

Response status codes

For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.

Response example

The response example is as follows:

{
    "totalCount": 1,
    "content": [
        {
            "importApplyId": 881,
            "dataBoxNo": "381",
            "dataBoxName": "BOX#1",
            "nasInstanceName": "nasw381n1",
            "sourceBucketName": "testddfdas",
            "sourceBucketFileName": "sample.xlsx",
            "status": "INIT"
        }
    ]
}