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.
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
Response examples
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?