Available in VPC
Create a box. This is an infrastructure creation that takes some time, so it will be processed asynchronously.
Request
This section describes the request format. The method and URI are as follows:
Method | URI |
---|---|
POST | /api/v1/box/create-box |
Request headers
For information about the headers common to all Datafence APIs, see Datafence request headers.
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
fenceId |
Integer | Required | Datafence number
|
description |
String | Optional | Box description |
createBoxInfo |
Object | Required | Box creation information |
createBoxInfo.connectServerList |
Array | Required | Connect server list
|
createBoxInfo.linuxServerList |
Array | Required | Linux server list |
createBoxInfo.windowsServerList |
Array | Conditional | Windows Server list
|
createBoxInfo.nasList |
Array | Required | NAS list |
createBoxInfo.hadoopList |
Array | Optional | Hadoop cluster list |
createBoxInfo.tensorFlowCpuServerList |
Array | Conditional | TensorFlow CPU server list
|
createBoxInfo.tensorFlowGpuServerList |
Array | Conditional | TensorFlow GPU server list
|
connectServerList
The following describes connectServerList
.
Field | Type | Required | Description |
---|---|---|---|
specCode |
String | Required | Connect server spec code
|
softwareCode |
String | Optional | Connect server software code
|
storageSize |
Integer | Required | Connect server block storage size (GB)
|
userPassword1 |
String | Conditional | Connect server ncp1 account password
|
userPassword2 |
String | Conditional | Connect server ncp2 account password
|
linuxServerList
The following describes linuxServerList
.
Field | Type | Required | Description |
---|---|---|---|
specCode |
String | Required | Linux server spec code
|
softwareCode |
String | Required | Linux server software code |
storageSize |
Integer | Required | Linux server block storage size (GB)
|
userPassword |
String | Required | Linux server account password
|
windowsServerList
The following describes windowsServerList
.
Field | Type | Required | Description |
---|---|---|---|
specCode |
String | Required | Windows server spec code
|
softwareCode |
String | Required | Windows server software code |
storageSize |
Integer | Required | Windows server block storage size (GB)
|
userPassword |
String | Required | Windows server account password
|
nasList
The following describes nasList
.
Field | Type | Required | Description |
---|---|---|---|
nasSize |
Integer | Optional | NAS volume size (GB)
|
count |
Integer | Optional | NAS count |
hadoopList
The following describes hadoopList
.
Field | Type | Required | Description |
---|---|---|---|
EdgeNodeSpecCode |
String | Optional | Edge node spec code
|
masterNodeSpecCode |
String | Optional | Master node spec code
|
masterNodeStorageSize |
Integer | Optional | Master node block storage size (GB)
|
workerNodeSpecCode |
String | Optional | Worker node spec code
|
workerNodeCount |
Integer | Optional | Worker node count |
workerNodeStorageSize |
Integer | Optional | Worker node block storage size (GB)
|
userPassword |
String | Conditional | Hadoop cluster account password
|
tensorFlowCpuServerList
The following describes tensorFlowCpuServerList
.
Field | Type | Required | Description |
---|---|---|---|
specCode |
String | Optional | TensorFlow CPU server spec code
|
softwareCode |
String | Optional | TensorFlow CPU server software code |
storageSize |
Integer | Optional | TensorFlow CPU server block storage size (GB)
|
userPassword |
String | Conditional | TensorFlow CPU server account password
|
tensorFlowGpuServerList
The following describes tensorFlowGpuServerList
.
Field | Type | Required | Description |
---|---|---|---|
specCode |
String | Optional | TensorFlow GPU server spec code
|
softwareCode |
String | Optional | TensorFlow GPU server software code |
storageSize |
Integer | Optional | TensorFlow GPU server block storage size (GB)
|
userPassword |
String | Conditional | TensorFlow GPU server account password
|
Request example
The request example is as follows:
curl --location --request POST 'https://datafence.apigw.ntruss.com/api/v1/box/create-box' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"fenceId": 26,
"createBoxInfo": {
"connectServerList": [
{
"specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B100.G002",
"softwareCode": "",
"storageSize": 300,
"userPassword1": "Password1000#",
"userPassword2": "Password1000#"
}
],
"linuxServerList": [
{
"specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B050.G002",
"softwareCode": "SW.VSVR.OS.LNX64.UBNTU.SVR2004.B050",
"storageSize": 500,
"userPassword": "Password1000#"
}
],
"windowsServerList": [
{
"specCode": "SVR.VSVR.STAND.C004.M016.NET.SSD.B100.G002",
"softwareCode": "SW.VSVR.OS.WND64.WND.SVR2019EN.B100",
"storageSize": 500,
"userPassword": "Password1000#"
}
],
"nasList": [
{
"nasSize": 500,
"count": 1
}
]
}
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
message |
String | - | API processing result message |
Response status codes
For information about the HTTP status codes common to all Datafence APIs, see Datafence API response status codes.
Response example
The response example is as follows:
{
"message": "Box creation requested."
}