get-data-box-infra-list
- Print
- PDF
get-data-box-infra-list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Views the list of infrastructure of Data Box in Data Box Frame.
GET https://{endpoint}/data-box/get-data-box-infra-list
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 | Succeeded |
| 400 | Request information error |
| 401 | Authentication failed |
| 403 | No permission for request information |
| 404 | Resource does not exist |
| 500 | Server error |
Examples
Request examples
GET https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-infra-list?dataBoxFrameNo=1046&dataBoxNo=194
Response examples
{
"totalCount": 5,
"content": [
{
"productCode": "CON",
"productType": "Connect Server",
"prodSpecId": 4002,
"instanceNo": "-",
"instanceName": "conn-1046-194-1",
"blockStorageInstanceNo": "-",
"blockStorageSize": "500",
"privateIp": "-.-.-.-",
"specName": "Connect Windows Server (C2 W1 : 2vCPU 4GB Mem)",
"connectInfo1": "ncp1",
"connectInfo2": "ncp2",
"statusCode": "USE",
"statusName": "Using",
"instanceStatusCode": "RUN"
},
{
"productCode": "SVR_LNX_CENT",
"productType": "Linux Server(CentOS)",
"prodSpecId": 6001,
"instanceNo": "-",
"instanceName": "svrlnx-1046-194-2",
"blockStorageInstanceNo": "-",
"blockStorageSize": "500",
"privateIp": "-.-.-.-",
"specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
"connectInfo1": "root",
"statusCode": "USE",
"statusName": "Using",
"instanceStatusCode": "RUN"
},
{
"productCode": "SVR_LNX_UBUNTU",
"productType": "Linux Server(Ubuntu)",
"prodSpecId": 6101,
"instanceNo": "-",
"instanceName": "svrlnx-1046-194-1",
"blockStorageInstanceNo": "-",
"blockStorageSize": "500",
"privateIp": "-.-.-.-",
"specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
"connectInfo1": "root",
"statusCode": "USE",
"statusName": "Using",
"instanceStatusCode": "RUN"
},
{
"productCode": "TF_CPU",
"productType": "TensorFlow Server(CPU)",
"prodSpecId": 7002,
"instanceNo": "-",
"instanceName": "tfcpu-1046-194-1",
"blockStorageInstanceNo": "-",
"blockStorageSize": "500",
"privateIp": "-.-.-.-",
"specName": "Tensorflow CPU Linux Server (S8-L1 : 8vCPU 32GB Mem)",
"connectInfo1": "root",
"statusCode": "USE",
"statusName": "Using",
"instanceStatusCode": "RUN"
},
{
"productCode": "NAS",
"productType": "NAS",
"instanceNo": "-",
"instanceName": "nasw194n1",
"specName": "600",
"connectInfo1": "/mnt/nasw194n1",
"statusCode": "USE",
"statusName": "Using"
}
]
}
Property
| Item | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| totalCount | Yes | Integer | Total quantity of infrastructure of Data Box | |
| productCode | Yes | String | Product Code | |
| productType | Yes | String | Product detailed type | |
| prodSpecId | Yes | Integer | Product Spec Code | |
| instanceNo | Yes | String | Instance number of the server | |
| instanceName | Yes | String | Instance name of the server | |
| blockStorageInstanceNo | No | String | Block Storage Instance number mounted on the server | |
| blockStorageSize | No | String | Block Storage size (server without Block Storage not exposed) | |
| privateIp | No | String | Server's private IP (NAS not exposed) | |
| specName | Yes | String | Spec name of the server (NAS: size) | |
| connectionInfo1 | No | String | Access account name of the server (NAS: mount path) | |
| connectionInfo2 | No | String | Second account name of the connect server | |
| statusCode | Yes | String | Infrastructure status code | |
| statusName | Yes | String | Status name of the infrastructure | |
| instanceStatusCode | No | String | Current status code of the server (NAS: not exposed) |
Error codes
| HTTP Status Code | Return code | Description |
|---|---|---|
| 200 | - | General successful request |
| 400 | 10001, 130*** | Request information and parameter error |
| 403 | 10002 | No permission for request information |
| 404 | 10009 | Resource does not exist |
| 500 | 130000 | Internal service error |
| 500 | 139999 | Integration service API call error |
Was this article helpful?