get-data-box-summary-info
- Print
- PDF
get-data-box-summary-info
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It views the summary information of Data Box in Data Box Frame.
GET https://{endpoint}/data-box/get-data-box-summary-info
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| dataBoxFrameNo | Yes | Integer | Data Box Frame number | |
| dataBoxNo | Yes | Integer | Data Box number |
Responses
| HTTP status code | Description |
|---|---|
| 200 | Success |
| 400 | Request information error |
| 401 | Authentication failed |
| 403 | No permission to request information |
| 404 | Resource not found |
| 500 | Server error |
Examples
Request examples
GET https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-summary-info?dataBoxFrameNo=1046&dataBoxNo=194
Response examples
{
"dataBoxName": "BOX#3",
"sslVpnCount": 1,
"connectSslVpnUrl": "https://sslvpn-kr-vpc-02.ncloud.com",
"webBlockStatus": true,
"mountCount": 0,
"nasCount": 1,
"nasTotalSize": 600,
"nasTotalUseSize": "0",
"createDate": "2023-04-04 16:24:37",
"statusCode": "USE",
"exportApplyCount": 1,
"memo": ""
}
Properties
| Items | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| dataBoxName | Yes | String | Data Box name | |
| sslVpnCount | Yes | Integer | Number of accounts available for SSL VPN of Data Box | |
| conectSslVpnUrl | Yes | String | SSL VPN access URL | |
| webBlockStatus | Yes | Boolean | Status to connect/block external network (true: block, false: connect) | |
| mountCount | Yes | Integer | Number of shared data views | |
| nasCount | Yes | Integer | Number of individual storages in Data Box | |
| nasTotalSize | Yes | Integer | Total capacity of the individual storage of Data Box | |
| nasTotalUseSize | Yes | String | Total usage of the individual storage of Data Box | |
| createDate | Yes | String | Created date of Data Box | |
| statusCode | Yes | String | Status code of Data Box | |
| exportApplyCount | Yes | Integer | Number of export review requests | |
| memo | Yes | String | Data Box memo |
Errors
| HTTP Status Code | Return code | Description |
|---|---|---|
| 200 | - | Successful normal request |
| 400 | 10001, 130*** | Request information and parameter error |
| 403 | 10002 | No permission to request information |
| 404 | 10009 | Resource not found |
| 500 | 130000 | Service internal error |
| 500 | 139999 | Integration service API call error |
Was this article helpful?