get-data-box-frame-list

Available in VPC

Get the list of Data Box Frames.

Request

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

Method	URI
GET	/api/v1/data-box-frame/get-data-box-frame-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
`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-frame/get-data-box-frame-list' \
--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
`dataBoxFrameNo`	String	-	Data Box Frame number
`dataBoxFrameName`	String	-	Data Box Frame name
`dataBoxCount`	String	-	Data Box count
`createDate`	String	-	Data Box Frame creation date and time YYYY-MM-DD HH:mm:ss format
`statusCode`	String	-	Data Box Frame status code `SET_READY` \| `SET_INIT` \| `SET_USE` \| `SET_ING` \| `SET_RTN` \| `SET_TERMT` `SET_READY`: requesting `SET_INIT`: creating `SET_USE`: in use `SET_ING`: changing `SET_RTN`: terminating `SET_TERMT`: termination completed
`statusName`	String	-	Data Box Frame 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

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": [
        {
            "dataBoxFrameNo": "83",
            "dataBoxFrameName": "dbf001",
            "dataBoxCount": "1",
            "createDate": "2025-03-25 11:20:11",
            "statusCode": "SET_USE",
            "statusName": "Using"
        }
    ]
}