modify-data-box-frame-admin-infra
- Print
- PDF
modify-data-box-frame-admin-infra
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It requests to modify the Data Box Frame Admin infrastructure.
- It takes time to create/return/change the infrastructure and operates asynchronously.
- If the request was sent successfully, a fixed message is returned.
POST https://{endpoint}/data-box-frame/modify-data-box-frame-admin-infra
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| dataBoxFrameNo | Yes | Integer | Data Box Frame number | |
| memo | Yes | String | Data Box Frame memo | |
| adminServerList.actionType | Yes | String | CREATE: create UPDATE: modify DELETE: return | Processing type |
| adminServerList.adminServerInstanceNo | No | Integer | Invalid if actionType is CREATE | Instance number of the Admin server |
| adminServerList.userPassword | Yes | String | - Between 8 to 14 characters - Must contain 1 character of the following 4 categories: English lowercase, English uppercase, special characters, and numbers - The following special characters are not allowed: ( ' , ' , ' , $ , / , & , $, space ) | Password to be applied to the Admin server |
| adminServerList.prodSpecId | No | Integer | Invalid if actionType is DELETE | Product Spec Code |
| nasList.actionType | Yes | String | CREATE: create DELETE: return | Processing type |
| nasList.nasInstanceNo | No | Integer | Invalid if actionType is CREATE | NAS Instance number |
| nasList.nasSize | No | Integer | Invalid if actionType is DELETE | NAS size |
| nasList.count | No | Integer | Invalid if actionType is DELETE | NAS count |
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
{
"adminServerList": [
{
"actionType": "CREATE",
"adminServerInstanceNo": -,
"prodSpecId": 1004,
"userPassword": "-"
}
],
"dataBoxSetNo": "1046",
"memo": "test",
"nasList": [
{
"actionType": "CREATE",
"count": 1,
"nasInstanceNo": -,
"nasSize": 600
}
]
}
Response examples
{
"returnMessage" : "Modification of the Data Box Frame infrastructure has been requested."
}
Properties
| Items | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| totalCount | Yes | Integer | Total quantity of infrastructure in Data Box | |
| productCode | Yes | String | Product Code | |
| productType | Yes | String | Product detailed types | |
| prodSpecId | Yes | Integer | Product Spec Code | |
| instanceNo | Yes | String | Instance No of the server | |
| instanceName | Yes | String | Instance name of the server | |
| blockStorageInstanceNo | No | String | Block Storage Instance No mounted on the server | |
| privateIp | No | String | Private IP of the server (NAS is not exposed) | |
| specName | Yes | String | Spec name of the server (NAS is size) | |
| connectionInfo1 | No | String | Access account name of the server (NAS is the mount path) | |
| connectionInfo2 | No | String | Name of the second account on the Connect server | |
| statusCode | Yes | String | Infra status code | |
| statusName | Yes | String | Infra status name | |
| instanceStatusCode | No | String | Current status code of the server (NAS is not exposed) |
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?