get-data-box-list

Prev Next

Available in VPC

Get the list of Data Boxes.

Request

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

Method URI
GET /api/v1/data-box/get-data-box-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
pageNo Integer Optional Page number
  • 1-100 (default: 1)
pageSize Integer Optional Page output count
  • 1-100 (default: 10)

Request example

The request example is as follows:

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-list?dataBoxFrameNo=83&pageNo=1&pageSize=10' \
--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 - Data Box list

content

The following describes content.

Field Type Required Description
dataBoxNo String - Data Box number
dataBoxName String - Data Box name
memo String - Data Box description
createDate String - Data Box creation date and time
  • YYYY-MM-DD HH:mm:ss format
statusCode String - Data Box status code
  • READY | INIT | USE | ING | RTN | TERMT
    • READY: requesting
    • INIT: creating
    • USE: in use
    • ING: changing
    • RTN: terminating
    • TERMT: termination completed
statusName String - Data Box status name
  • Request for creating | Initial State | Using | Changing | Returning | Terminated
    • Request for creating: requesting
    • Initial State: creating
    • Using: in use
    • Changing: changing
    • Returning: terminating
    • Terminated: termination completed
disabled Boolean - Data Box accessibility
  • true | false
  • Displayed for sub accounts

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": [
        {
            "dataBoxNo": "381",
            "dataBoxName": "BOX#1",
            "memo": "dbf001",
            "createDate": "2025-03-25 11:20:11",
            "statusCode": "USE",
            "statusName": "Using"
        }
    ]
}