Login
      Contents x
      modify-data-box
        • Print
        • PDF
        Contents

        modify-data-box

          • Print
          • PDF
          Article summary

          It requests to modify the Data Box 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/modify-data-box

          Requests

          Request parameters

          Parameter nameRequirement statusTypeRestrictionsDescription
          dataBoxFrameNoYesStringData Box Frame number
          dataBoxNoYesStringData Box number
          memoNoStringData Box memo
          connectServerList.actionTypeNoStringCREATE: create
          UPDATE: modify
          DELETE: return          		Processing type
          connectServerList.blockStorageInstanceNoNoIntegerInvalid if actionType is CREATE or DELETEConnect server block storage instance number
          connectServerList.prodSpecIdNoIntegerInvalid if actionType is DELETEProduct Spec Code
          connectServerList.serverInstanceNoNoIntegerInvalid if actionType is CREATE or DELETEConnect server instance number
          connectServerList.storageSizeNoIntegerInvalid if actionType is DELETEConnect server block storage size
          connectServerList.adminPasswordNoStringInvalid if actionType is UPDATE or DELETE
          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.userPassword1NoStringInvalid if actionType is UPDATE or DELETE
          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.userPassword2NoStringInvalid if actionType is UPDATE or DELETE
          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.actionTypeNoStringCREATE: create
          UPDATE: modify
          DELETE: return          		Processing type
          hadoopList.hadoopInstanceNoNoIntegerInvalid if actionType is CREATE or DELETEHadoop cluster instance number
          hadoopList.userPasswordNoStringInvalid if actionType is UPDATE or DELETE
          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.workerNodeCountNoIntegerInvalid if actionType is UPDATE or DELETENumber of Hadoop cluster worker nodes
          hadoopList.workerNodeProdSpecIdNoIntegerInvalid if actionType is DELETEProduct Spec Code
          hadoopList.EdgeNodeProdSpecIdNoIntegerInvalid if actionType is DELETEProduct Spec Code
          hadoopList.masterNodeProdSpecIdNoIntegerInvalid if actionType is DELETEProduct Spec Code
          hadoopList.masterNodeStorageSizeNoIntegerInvalid if actionType is UPDATE or DELETEHadoop cluster master node block storage size
          hadoopList.workerNodeStorageSizeNoIntegerInvalid if actionType is UPDATE or DELETEHadoop cluster worker node block storage size
          (tensorflow, linux).actionTypeNoStringCREATE: create
          UPDATE: modify
          DELETE: return          		Processing type
          (tensorflow, linux).blockStorageInstanceNoNoIntegerInvalid if actionType is CREATE or DELETEServer block storage instance number
          (tensorflow, linux).prodSpecIdNoIntegerInvalid if actionType is DELETEProduct Spec Code
          (tensorflow, linux).serverInstanceNoNoIntegerInvalid if actionType is CREATE or DELETEServer instance number
          (tensorflow, linux).storageSizeNoIntegerInvalid if actionType is DELETEServer block storage size
          (tensorflow, linux).userPasswordNoStringInvalid if actionType is UPDATE or DELETE
          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.actionTypeYesStringCREATE: create
          DELETE: return          		Processing type
          nasList.nasInstanceNoNoIntegerInvalid if actionType is CREATENAS Instance number
          nasList.nasSizeNoIntegerInvalid if actionType is DELETENAS size
          nasList.countNoIntegerInvalid if actionType is DELETENAS count

          Responses

          HTTP status codeDescription
          200Success
          400Request information error
          401Authentication failed
          403No permission to request information
          404Resource not found
          500Server error

          Examples

          Request examples

          {
  "dataBoxInfo": {
    "connectServerList": [
      {
        "actionType": "CREATE",
        "adminPassword": "-",
        "blockStorageInstanceNo": -,
        "prodSpecId":4003 ,
        "serverInstanceNo": -,
        "storageSize": -,
        "userPassword1": "-",
        "userPassword2": "-"
      }
    ],
    "dataBoxNo": "194",
    "hadoopList": [
      {
        "actionType": "CREATE",
        "workerNodeCount": 2,
        "workerNodeProdSpecId": 5201,
        "workerNodeStorageSize": 500,
        "edgeNodeProdSpecId": 5001,
        "hadoopInstanceNo": -,
        "masterNodeProdSpecId": 5101,
        "masterNodeStorageSize": 500,
        "userPassword": "-"
      }
    ],
    "linuxServerList": [
      {
        "actionType": "CREATE",
        "blockStorageInstanceNo": -,
        "prodSpecId": 6001,
        "serverInstanceNo": -,
        "storageSize": -,
        "userPassword": "-"
      }
    ],
    "memo": "test",
    "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": "-"
      }
    ]
  },
  "dataBoxFrameNo": "1046"
}

          Response examples

          {
  "returnMessage" : "Data Box infrastructure modification requested."
}

          Errors

          HTTP Status CodeReturn codeDescription
          200-Successful normal request
          40010001,
          130***          		Request information and parameter error
          40310002No permission to request information
          40410009Resource not found
          500130000Service internal error
          500139999Integration service API call error
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout