create-data-box
- Print
- PDF
create-data-box
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It requests creation of a Data Box in Data Box Frame.
- 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/create-data-box
Requests
Request parameters
Parameter name | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
dataBoxFrameNo | Yes | String | Data Box Frame number | |
dataBoxNo | Yes | String | Data Box number | |
memo | No | String | Data Box memo | |
sslVpnCount | Yes | Integer | Maximum number of Connect servers * 3 | Number of SSL VPN accounts |
connectServerList.prodSpecId | No | Integer | Product Spec Code | |
connectServerList.storageSize | No | Integer | Connect server block storage size | |
connectServerList.adminPassword | No | 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 ) | Connect server admin account password |
connectServerList.userPassword1 | No | 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 ) | Connect server ncp1 account password |
connectServerList.userPassword2 | No | 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 ) | Connect server ncp2 account password |
hadoopList.userPassword | No | 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 ) | Hadoop cluster password |
hadoopList.workerNodeCount | No | Integer | Number of Hadoop cluster worker nodes | |
hadoopList.workerNodeProdSpecId | No | Integer | Product Spec Code | |
hadoopList.EdgeNodeProdSpecId | No | Integer | Product Spec Code | |
hadoopList.masterNodeProdSpecId | No | Integer | Product Spec Code | |
hadoopList.masterNodeStorageSize | No | Integer | Hadoop cluster master node block storage size | |
hadoopList.workerNodeStorageSize | No | Integer | Hadoop cluster worker node block storage size | |
(tensorflow, linux).prodSpecId | No | Integer | Product Spec Code | |
(tensorflow, linux).storageSize | No | Integer | Server block storage size | |
(tensorflow, linux).userPassword | No | 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 ) | Server password |
nasList.nasSize | No | Integer | NAS size | |
nasList.count | No | Integer | 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
{
"dataBoxInfo": {
"connectServerList": [
{
"adminPassword": "-",
"prodSpecId": 4003,
"storageSize": 500,
"userPassword1": "-",
"userPassword2": "-"
}
],
"hadoopList": [
{
"workerNodeCount": 2,
"workerNodeProdSpecId": 5201,
"workerNodeStorageSize": 500,
"edgeNodeProdSpecId": 5001,
"masterNodeProdSpecId": 5101,
"masterNodeStorageSize": 500,
"userPassword": "-"
}
],
"linuxServerList": [
{
"prodSpecId": 6001,
"storageSize": 500,
"userPassword": "-"
}
],
"memo": "test",
"nasList": [
{
"count": 1,
"nasSize": 500
}
],
"sslVpnCount": 1,
"tensorFlowCpuServerList": [
{
"prodSpecId": 7001,
"storageSize": 500,
"userPassword": "-"
}
],
"tensorFlowGpuServerList": [
{
"prodSpecId": 7101,
"storageSize": 500,
"userPassword": "-"
}
]
},
"dataBoxFrameNo": 1046
}
Response examples
{
"returnMessage" : "A Data Box creation has been requested."
}
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?