get-data-box-summary-info

Available in VPC

Get the Data Box summary information.

Request

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

Method	URI
GET	/api/v1/data-box/get-data-box-summary-info

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 See get-data-box-frame-list.
`dataBoxNo`	Integer	Required	Data Box number See get-data-box-list.

Request example

The request example is as follows:

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-summary-info?dataBoxFrameNo=83&dataBoxNo=381' \
--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
`dataBoxName`	String	-	Data Box name
`sslVpnCount`	Integer	-	Number of accounts that can use SSL VPN
`connectSslVpnUrl`	String	-	SSL VPN Connection URL
`webBlockStatus`	Boolean	-	Whether external network is blocked `true` \| `false` `true`: blocked `false`: connected
`mountCount`	Integer	-	Number of times shared data was retrieved
`nasCount`	Integer	-	Number of Data Box storage
`nasTotalSize`	Integer	-	Total capacity of Data Box storage (GB)
`nasTotalUseSize`	String	-	Total usage of Data Box storage (GB)
`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
`exportApplyCount`	Integer	-	Export review request count
`memo`	String	-	Data Box description

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:

{
    "dataBoxName": "BOX#1",
    "sslVpnCount": 1,
    "connectSslVpnUrl": "https://sslvpn-kr-vpc-***.ncloud.com",
    "webBlockStatus": true,
    "mountCount": 0,
    "nasCount": 1,
    "nasTotalSize": 500,
    "nasTotalUseSize": "0",
    "createDate": "2025-03-25 11:20:11",
    "statusCode": "USE",
    "exportApplyCount": 0,
    "memo": "dbf001"
}