get-import-apply-list

Prev Next

Available in VPC

Get the list of file import requests in Data Box.

Request

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

Method URI
GET /api/v1/import/get-import-apply-list

Request headers

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

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
dataBoxFrameNo Integer Required Data Box Frame number
dataBoxNo Integer Optional Data Box number
applyStartDate String Optional Query start date and time
  • yyyyMMddHHmmss format
applyEndDate String Optional Query end date and time
  • yyyyMMddHHmmss format
pageNo Integer Optional Page number
  • 1-1000 (default: 1)
pageSize Integer Optional Page output count
  • 1-1000 (default: 10)
status String Optional Import status code

Request example

The request example is as follows:

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/import/get-import-apply-list?dataBoxFrameNo=83&dataBoxNo=381&applyStartDate=20250325000000&applyEndDate=20250329000000&pageNo=1&pageSize=1000&status=SCSS' \
--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
totalCount Integer - Number of response results
content Array - Import request list

content

The following describes content.

Field Type Required Description
importApplyId String - Import request ID
dataBoxName String - Data Box name
dataBoxNo String - Data Box number
targetNasName String - Target NAS name
sourceBucketName String - Source bucket name
sourceFileName String - Import file name
applyDate String - Import request date and time
  • YYYY-MM-DD HH:mm:ss format
completeDate String - Import completion date and time
  • YYYY-MM-DD HH:mm:ss format
status String - Import status code
memo String - Description for the import request

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",
            "dataBoxName": "BOX#1",
            "dataBoxNo": "381",
            "targetNasName": "nasw381n1",
            "sourceBucketName": "testddfdas",
            "sourceFileName": "sample.xlsx",
            "applyDate": "2025-03-27 15:19:34",
            "completeDate": "2025-03-27 15:19:37",
            "status": "SCSS",
            "memo": "import001"
        }
    ]
}