create-data-box
    • PDF

    create-data-box

    • PDF

    Article summary

    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 nameRequirement statusTypeRestrictionsDescription
    dataBoxFrameNoYesStringData Box Frame number
    dataBoxNoYesStringData Box number
    memoNoStringData Box memo
    sslVpnCountYesIntegerMaximum number of Connect servers * 3Number of SSL VPN accounts
    connectServerList.prodSpecIdNoIntegerProduct Spec Code
    connectServerList.storageSizeNoIntegerConnect server block storage size
    connectServerList.adminPasswordNoStringBetween 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.userPassword1NoStringBetween 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.userPassword2NoStringBetween 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.userPasswordNoStringBetween 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.workerNodeCountNoIntegerNumber of Hadoop cluster worker nodes
    hadoopList.workerNodeProdSpecIdNoIntegerProduct Spec Code
    hadoopList.EdgeNodeProdSpecIdNoIntegerProduct Spec Code
    hadoopList.masterNodeProdSpecIdNoIntegerProduct Spec Code
    hadoopList.masterNodeStorageSizeNoIntegerHadoop cluster master node block storage size
    hadoopList.workerNodeStorageSizeNoIntegerHadoop cluster worker node block storage size
    (tensorflow, linux).prodSpecIdNoIntegerProduct Spec Code
    (tensorflow, linux).storageSizeNoIntegerServer block storage size
    (tensorflow, linux).userPasswordNoStringBetween 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.nasSizeNoIntegerNAS size
    nasList.countNoIntegerNAS 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": [
          {
            "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 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?

    Changing your password will log you out immediately. Use the new password to log back in.
    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.