create-data-box

Prev Next

Available in VPC

Create a Data Box in Data Box Frame. 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/data-box/create-data-box

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
dataBoxFrameNo String Required Data Box Frame number
dataBoxInfo Object Required Data Box information
dataBoxInfo.connectServerList Array Required Connect server list
dataBoxInfo.hadoopList Array Optional Hadoop cluster list
dataBoxInfo.linuxServerList Array Optional Linux server list
dataBoxInfo.memo String Optional Data Box description
dataBoxInfo.nasList Array Required NAS list
dataBoxInfo.sslVpnCount Integer Required Number of SSL VPN accounts to be used in Data Box
  • Up to 3 times the maximum number of Connect servers
dataBoxInfo.tensorFlowCpuServerList Array Conditional TensorFlow CPU server list
  • Required when not setting tensorFlowGpuServerList
dataBoxInfo.tensorFlowGpuServerList Array Conditional TensorFlow GPU server list
  • Required when not setting tensorFlowCpuServerList

connectServerList

The following describes dataBoxInfo.connectServerList.

Field Type Required Description
prodSpecId Integer Optional Connect server spec code
storageSize Integer Optional Connect server block storage size (GB)
adminPassword String Conditional Connect server admin account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space
userPassword1 String Conditional Connect server ncp1 account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space
userPassword2 String Conditional Connect server ncp2 account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space

hadoopList

The following describes dataBoxInfo.hadoopList.

Field Type Required Description
edgeNodeProdSpecId Integer Optional Edge node server spec code
masterNodeProdSpecId Integer Optional Master node server spec code
masterNodeStorageSize Integer Optional Master node block storage size (GB)
workerNodeProdSpecId Integer Optional Worker node server spec code
workerNodeCount Integer Optional Worker node count
workerNodeStorageSize Integer Optional Worker node block storage size (GB)
userPassword String Optional Hadoop cluster account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space

linuxServerList

The following describes dataBoxInfo.linuxServerList.

Field Type Required Description
prodSpecId Integer Optional Linux server spec code
storageSize Integer Optional Linux server block storage size (GB)
userPassword String Optional Linux server account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space

nasList

The following describes dataBoxInfo.nasList.

Field Type Required Description
count Integer Optional NAS count
nasSize Integer Optional NAS volume size (GB)
  • Valid if actionType is CREATE

tensorFlowCpuServerList

The following describes dataBoxInfo.tensorFlowCpuServerList.

Field Type Required Description
prodSpecId Integer Optional TensorFlow CPU server spec code
storageSize Integer Optional TensorFlow CPU server block storage size (GB)
userPassword String Conditional TensorFlow CPU server account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space
  • Required if actionType is CREATE

tensorFlowGpuServerList

The following describes dataBoxInfo.tensorFlowGpuServerList.

Field Type Required Description
prodSpecId Integer Optional TensorFlow GPU server spec code
storageSize Integer Optional TensorFlow GPU server block storage size (GB)
userPassword String Conditional TensorFlow GPU server account password
  • Enter 8 to 14 characters using a combination of uppercase/lowercase English letters, numbers, and special characters.
  • Unusable special characters: ', ", ₩, /, &, `, space
  • Required if actionType is CREATE

Request example

The request example is as follows:

curl --location --request POST 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/create-data-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 '{ 
    "dataBoxFrameNo": 83,
    "dataBoxInfo": {
        "connectServerList": [
            {
                "prodSpecId": 4003,
                "storageSize": 500,
                "userPassword1": "********",
                "userPassword2": "********",
                "adminPassword": "********"
            }
        ],
        "hadoopList": [
            {
                "edgeNodeProdSpecId": 5001,
                "masterNodeProdSpecId": 5101,
                "masterNodeStorageSize": 500,
                "workerNodeProdSpecId": 5201,
                "workerNodeCount": 2,
                "workerNodeStorageSize": 500,
                "userPassword": "********"
            }
        ],
        "linuxServerList": [
            {
                "prodSpecId": 6001,
                "storageSize": 500,
                "userPassword": "********"
            }
        ],
        "memo": "about data box frame",
        "nasList": [
            {
                "count": 1,
                "nasSize": 500
            }
        ],
        "sslVpnCount": 1,
        "tensorFlowCpuServerList": [
            {
                "prodSpecId": 7001,
                "storageSize": 500,
                "userPassword": "********"
            }
        ],
        "tensorFlowGpuServerList": [
            {
                "prodSpecId": 7101,
                "storageSize": 500,
                "userPassword": "********"
            }
        ]
    }
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
returnMessage String - API processing result message

Response status codes

For information about the response status codes common to all Data Box Frame APIs, see Data Box Frame API response status codes.

Response example

The response example is as follows:

{
    "returnMessage": "A Data Box creation has been requested."
}