modify-data-box

Prev Next

Available in VPC

Change Data Box infrastructure settings. This is an infrastructure change 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/modify-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.dataBoxNo String Required Data Box number
dataBoxInfo.connectServerList Array Optional 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 Optional NAS list
dataBoxInfo.tensorFlowCpuServerList Array Optional TensorFlow CPU server list
dataBoxInfo.tensorFlowGpuServerList Array Optional TensorFlow GPU server list

connectServerList

The following describes dataBoxInfo.connectServerList.

Field Type Required Description
actionType String Optional Processing type
  • CREATE | UPDATE | DELETE
    • CREATE: create
    • UPDATE: edit
    • DELETE: terminate
blockStorageInstanceNo Integer Optional Instance number of block storage connected to the connect server
prodSpecId Integer Conditional Connect server spec code
serverInstanceNo Integer Conditional Connect server instance number
storageSize Integer Optional Connect server block storage size (GB)
  • Required if actionType is CREATE or UPDATE
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
  • Required if actionType is CREATE
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
  • Required if actionType is CREATE
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
  • Required if actionType is CREATE

hadoopList

The following describes dataBoxInfo.hadoopList.

Field Type Required Description
actionType String Optional Processing type
  • CREATE | UPDATE | DELETE
    • CREATE: create
    • UPDATE: edit
    • DELETE: terminate
hadoopInstanceNo Integer Conditional Hadoop cluster instance number
EdgeNodeProdSpecId Integer Conditional Edge node server spec code
masterNodeProdSpecId Integer Conditional Master node server spec code
masterNodeStorageSize Integer Optional Master node block storage size (GB)
  • Required if actionType is CREATE
workerNodeCount Integer Optional Worker node count
  • Required if actionType is CREATE
workerNodeProdSpecId Integer Conditional Worker node server spec code
workerNodeStorageSize Integer Optional Worker node block storage size (GB)
  • Required if actionType is CREATE
userPassword String Conditional 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
  • Required if actionType is CREATE

linuxServerList

The following describes dataBoxInfo.linuxServerList.

Field Type Required Description
actionType String Optional Processing type
  • CREATE | UPDATE | DELETE
    • CREATE: create
    • UPDATE: edit
    • DELETE: terminate
blockStorageInstanceNo Integer Optional Instance number of block storage connected to the Linux server
prodSpecId Integer Optional Linux server spec code
serverInstanceNo Integer Conditional Linux server instance number
storageSize Integer Optional Linux server block storage size (GB)
  • Required if actionType is CREATE or UPDATE
userPassword String Conditional 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
  • Required if actionType is CREATE

nasList

The following describes dataBoxInfo.nasList.

Field Type Required Description
actionType String Required Processing type
  • CREATE | DELETE
    • CREATE: create
    • DELETE: terminate
count Integer Optional NAS count
  • Required if actionType is CREATE
nasInstanceNo Integer Conditional NAS instance number
nasSize Integer Optional NAS volume size (GB)
  • Required if actionType is CREATE

tensorFlowCpuServerList

The following describes dataBoxInfo.tensorFlowCpuServerList.

Field Type Required Description
actionType String Optional Processing type
  • CREATE | UPDATE | DELETE
    • CREATE: create
    • UPDATE: edit
    • DELETE: terminate
blockStorageInstanceNo Integer Optional Instance number of block storage connected to the TensorFlow CPU server
prodSpecId Integer Optional TensorFlow CPU server spec code
serverInstanceNo Integer Conditional TensorFlow CPU server instance number
storageSize Integer Optional TensorFlow CPU server block storage size (GB)
  • Required if actionType is CREATE or UPDATE
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
actionType String Optional Processing type
  • CREATE | UPDATE | DELETE
    • CREATE: create
    • UPDATE: edit
    • DELETE: terminate
blockStorageInstanceNo Integer Optional Instance number of block storage connected to the TensorFlow GPU server
prodSpecId Integer Optional TensorFlow GPU server spec code
serverInstanceNo Integer Conditional TensorFlow GPU server instance number
storageSize Integer Optional TensorFlow GPU server block storage size (GB)
  • Required if actionType is CREATE or UPDATE
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/modify-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": {
    "dataBoxNo": "381",
    "connectServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId":4001 ,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "adminPassword": "********",
        "userPassword1": "********",
        "userPassword2": "********"
      }
    ],
    "hadoopList": [
      {
        "actionType": "CREATE",
        "hadoopInstanceNo": *********,
        "edgeNodeProdSpecId": 5001,
        "masterNodeProdSpecId": 5101,
        "masterNodeStorageSize": 500,
        "workerNodeCount": 2,
        "workerNodeProdSpecId": 5201,
        "workerNodeStorageSize": 500,
        "userPassword": "********"
      }
    ],
    "linuxServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId": 6001,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "userPassword": "********"
      }
    ],
    "memo": "dbf001",
    "nasList": [
      {
        "actionType": "CREATE",
        "count": 1,
        "nasInstanceNo": *********,
        "nasSize": 600
      }
    ],
    "tensorFlowCpuServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId": 7001,
        "serverInstanceNo": *********,
        "storageSize": 500,
        "userPassword": "********"
      }
    ],
    "tensorFlowGpuServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": *********,
        "prodSpecId": 7101,
        "serverInstanceNo": *********,
        "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": "Data Box infrastructure modification requested."
}