MENU
      modify-data-box-frame-admin-infra

        modify-data-box-frame-admin-infra


        Article summary

        It requests to modify the Data Box Frame Admin 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-frame/modify-data-box-frame-admin-infra
        HTTP

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        dataBoxFrameNoYesIntegerData Box Frame number
        memoYesStringData Box Frame memo
        adminServerList.actionTypeYesStringCREATE: create
        UPDATE: modify
        DELETE: return
        Processing type
        adminServerList.adminServerInstanceNoNoIntegerInvalid if actionType is CREATEInstance number of the Admin server
        adminServerList.userPasswordYesString- 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 )
        Password to be applied to the Admin server
        adminServerList.prodSpecIdNoIntegerInvalid if actionType is DELETEProduct Spec Code
        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

        {
          "adminServerList": [
            {
              "actionType": "CREATE",
              "adminServerInstanceNo": -,
              "prodSpecId": 1004,
              "userPassword": "-"
            }
          ],
          "dataBoxSetNo": "1046",
          "memo": "test",
          "nasList": [
            {
              "actionType": "CREATE",
              "count": 1,
              "nasInstanceNo": -,
              "nasSize": 600
            }
          ]
        }
        JSON

        Response examples

        {
          "returnMessage" : "Modification of the Data Box Frame infrastructure has been requested."
        }
        JSON

        Properties

        ItemsRequirement statusTypeRestrictionsDescription
        totalCountYesIntegerTotal quantity of infrastructure in Data Box
        productCodeYesStringProduct Code
        productTypeYesStringProduct detailed types
        prodSpecIdYesIntegerProduct Spec Code
        instanceNoYesStringInstance No of the server
        instanceNameYesStringInstance name of the server
        blockStorageInstanceNoNoStringBlock Storage Instance No mounted on the server
        privateIpNoStringPrivate IP of the server (NAS is not exposed)
        specNameYesStringSpec name of the server (NAS is size)
        connectionInfo1NoStringAccess account name of the server (NAS is the mount path)
        connectionInfo2NoStringName of the second account on the Connect server
        statusCodeYesStringInfra status code
        statusNameYesStringInfra status name
        instanceStatusCodeNoStringCurrent status code of the server (NAS is not exposed)

        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.