get-data-box-frame-infra-list
- Print
- PDF
get-data-box-frame-infra-list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It views the infrastructure list of Data Box Frame.
GET https://{endpoint}/data-box-frame/get-data-box-frame-list
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| dataBoxFrameNo | No | Integer | Data Box Frame number | |
| pageNo | No | Integer | 1 ~ 100 | Page number |
| pageSize | No | Integer | 1 ~ 100 | Number of items viewed per page |
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-frame/get-data-box-frame-infra-list?dataBoxFrameNo=1046
Response examples
{
"totalCount": 2,
"content": [
{
"infraType": "Server",
"instanceName": "admin-1046-1",
"privateIp": "-.-.-.-",
"publicIp": "-.-.-.-",
"osName": "Ubuntu",
"specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
"prodSpecId": 2001,
"userName": "root",
"useData": "",
"createDate": "2023-03-15 10:53:09",
"statusCode": "SET_USE",
"statusName": "Using",
"instanceNo": "-",
"instanceStatusCode": "RUN"
},
{
"infraType": "NAS",
"instanceName": "pub1046n1",
"privateIp": "",
"osName": "",
"specName": "500",
"userName": "/mnt/nasr/pub1046n1",
"useData": "0",
"createDate": "2023-03-15 10:53:09",
"statusCode": "USE",
"statusName": "Using",
"instanceNo": "-",
"nasVolumeSize": "500"
}
],
"usePseudonymInfo": "Y"
}
Properties
| Items | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| totalCount | Yes | Integer | Total infra number of Data Box Frame | |
| infraType | Yes | String | Infra type (Server, NAS | |
| instanceName | Yes | String | Infra name | |
| privateIp | Yes | String | Private IP of infra | |
| publicIp | No | String | Public IP of infra | |
| osName | Yes | String | OS name of the server (for NAS, returns empty String) | |
| specName | Yes | String | Spec name of the server (for NAS, returns the capacity of the NAS) | |
| userName | Yes | Stirng | Connection account name of the server (for NAS, returns the mount path) | |
| createDate | Yes | String | Created date of Data Box Frame | |
| statusCode | Yes | String | Status code of Data Box Frame | |
| statusName | Yes | String | Status name of Data Box Frame | |
| instanceNo | Yes |
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?