Available in VPC
Request file export to export a file from a 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/create-file-export |
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
|
sourceNasInstanceNo |
Integer | Required | Source NAS instance number
|
sourceFilePathList |
List | Required | List of file names requested for export
|
targetBucketName |
String | Required | Target bucket name |
fileDescription |
String | Required | Description of the export request file
|
exportPurpose |
String | Required | Export purpose
|
description |
String | Required | Description for the export request
|
Request example
The request example is as follows:
curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/export/create-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 '{
"fenceId": 26,
"boxId": 74,
"sourceNasInstanceNo": ********,
"sourceFilePathList": ["108_datafence001.csv"],
"targetBucketName": "test-bucket-for-fence",
"fileDescription": "Test file",
"exportPurpose": "File export test",
"description": "File export test"
}'
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 export requested."
}