get-import-detail

Prev Next

Available in VPC

Get the details of a import request into a datafence.

Request

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

Method URI
GET /api/v1/import/get-import-detail

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
fenceId Integer Required Datafence number
boxId Integer Required Box number
fileId Integer Required Import request number

Request example

The request example is as follows:

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/import/get-import-detail?fenceId=26&boxId=74&fileId=111' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
fileId Integer - Import request number
fenceId Integer - Datafence number
boxId Integer - Box number
boxName String - Box name
sourceBucketName String - Source bucket name
sourceFilePath String - Import request target file name
targetNasName String - Target NAS name
description String - Description for the import request
statusCode String - Import request status code
statusName String - Import request status name
createDate String - Import request date and time
  • ISO 8601 format (including UTC+9)
completeDate String - Import completion date and time
  • ISO 8601 format (including UTC+9)

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:

{
    "fileId": 111,
    "fenceId": 26,
    "boxId": 74,
    "boxName": "box1",
    "sourceBucketName": "test-bucket-for-fence",
    "sourceFilePath": "archive.zip",
    "targetNasName": "74box1",
    "description": "File import request",
    "statusCode": "IMPORTED",
    "statusName": "Import completed",
    "createDate": "2025-04-25T11:22:07+09:00",
    "completeDate": "2025-04-25T11:22:44+09:00"
}