apply-file-import

Available in VPC

Request file import to import a file from an Object Storage bucket into a 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 Cloud Data Box APIs, see Cloud Data Box request headers.

Request body

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

Field	Type	Required	Description
`dataBoxNo`	Integer	Required	Data box number Number displayed in common for server names in the Infrastructure tab menu that appears after clicking the [View Server Details] button in the My Space menu of the NAVER Cloud Platform Console. How to check data box details: See Cloud Data Box User Guide.
`bucketName`	String	Required	Source bucket name See get-bucket-list.
`fileList`	Array	Required	Import file information
`nasInstanceNo`	Integer	Required	Target NAS name See get-nas-list.

`fileList`

The following describes fileList.

Field	Type	Required	Description
`name`	String	Required	File name Enter the same name as registered in the bucket, including the extension. Up to 5 can be entered. Capacity per file: 500 MB or less

Request example

The request example is as follows:

curl --location --request POST 'https://databox.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 '{
    "dataBoxNo": ****,
    "bucketName": "testddfdas",
    "fileList": [
        {
            "name": "Glossary_2.xlsx"
        },
        {
            "name": "Glossary_3.xlsx"
        }
    ],
    "nasInstanceNo": ********
}'

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
`content`	Array	-	Import request information

content

The following describes content.

Field	Type	Required	Description
`importNo`	Integer	-	Import request number
`nasInstanceNo`	Integer	-	Target NAS instance number
`bucketName`	String	-	Source bucket name
`nasName`	String	-	Target NAS name
`fileName`	String	-	Import file name
`statusCode`	String	-	Import status code `INIT` \| `ING` \| `SCSS` \| `ERR_FILE` \| `ERR_SYS` \| `ERR_SEC` `INIT`: import requested (before file transfer) `ING`: import in progress `SCSS`: import completed `ERR_FILE`: failure (file error) `ERR_SYS`: failure (system error) `ERR_SEC`: failure (file security check failure)
`status`	String	-	Import status
`applyDate`	String	-	Request date and time

Response status codes

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

Response example

The response example is as follows:

{
    "totalCount": 2,
    "content": [
        {
            "importNo": 3292,
            "nasInstanceNo": ********,
            "bucketName": "testddfdas",
            "nasName": "nasw1",
            "fileName": "Glossary_3.xlsx",
            "statusCode": "INIT",
            "status": "Import requested (before file transfer)",
            "applyDate": "2025-03-04 10:26:57"
        },
        {
            "importNo": 3291,
            "nasInstanceNo": ********,
            "bucketName": "testddfdas",
            "nasName": "nasw1",
            "fileName": "Glossary_2.xlsx",
            "statusCode": "INIT",
            "status": "Import requested (before file transfer)",
            "applyDate": "2025-03-04 10:26:57"
        },
        {
            "importNo": 3288,
            "nasInstanceNo": ********,
            "bucketName": "testddfdas",
            "nasName": "nasw1",
            "fileName": "Glossary_1.xlsx",
            "statusCode": "SCSS",
            "status": "Import completed",
            "applyDate": "2025-03-04 08:48:30"
        }
    ]
}