apply-file-export

Prev Next

Available in VPC

Request file export to export a file from Data Box to a bucket in Object Storage.

Request

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

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

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
dataBoxNo Integer Required Data Box number
exportPurpose String Required Export purpose
  • 1-1000 characters
memo String Optional Description for the export request
  • 0-50 characters
sourceFileInfoList Array Required Export request file information list
sourceNasInstanceNo Integer Required Source NAS instance number
sslVpnNo Integer Required SSL VPN number
targetBucketName String Required Target bucket name

sourceFileInfoList

The following describes sourceFileInfoList.

Field Type Required Description
description String Optional Description of the export request file
  • 0-1000 characters
fileName String Required Export request file name list
  • Up to 5 files can be exported at a time.
  • Individual file size: 10 MB or less

Request example

The request example is as follows:

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/export/apply-file-export' \
--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,
    "exportPurpose": "test",
    "memo": "export001",
    "sourceFileInfoList": [
        {
            "description": "export001",
            "fileName": "sample.xlsx"
        }
    ],
    "sourceNasInstanceNo": ********,
    "sslVpnNo": 776,
    "targetBucketName": "testddfdas"
}'

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 - Export request information list

content

The following describes content.

Field Type Required Description
exportApplyId Integer - Export request ID
dataBoxNo String - Data Box number
dataBoxName String - Data Box name
nasInstanceName String - Source NAS instance name
sourceNasFileName String - Export request file name
targetBucketName String - Target bucket name
status String - Export request 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": [
        {
            "exportApplyId": 1543,
            "dataBoxNo": "381",
            "dataBoxName": "BOX#1",
            "nasInstanceName": "nasw381n1",
            "sourceNasFileName": "sample.xlsx",
            "targetBucketName": "testddfdas",
            "status": "INIT"
        }
    ]
}