MENU
      get-data-box-frame-infra-list

        get-data-box-frame-infra-list


        Article summary

        It views the infrastructure list of Data Box Frame.

        GET https://{endpoint}/data-box-frame/get-data-box-frame-list
        HTTP

        Requests

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        dataBoxFrameNoNoIntegerData Box Frame number
        pageNoNoInteger1 ~ 100Page number
        pageSizeNoInteger1 ~ 100Number of items viewed per page

        Responses

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

        Examples

        Request examples

        GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-infra-list?dataBoxFrameNo=1046
        HTTP

        Response examples

        {
          "totalCount": 2,
          "content": [
            {
              "infraType": "Server",
              "instanceName": "admin-1046-1",
              "privateIp": "-.-.-.-",
              "publicIp": "-.-.-.-",
              "osName": "Ubuntu",
              "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
              "prodSpecId": 2001,
              "userName": "root",
              "useData": "",
              "createDate": "2023-03-15 10:53:09",
              "statusCode": "SET_USE",
              "statusName": "Using",
              "instanceNo": "-",
              "instanceStatusCode": "RUN"
            },
            {
              "infraType": "NAS",
              "instanceName": "pub1046n1",
              "privateIp": "",
              "osName": "",
              "specName": "500",
              "userName": "/mnt/nasr/pub1046n1",
              "useData": "0",
              "createDate": "2023-03-15 10:53:09",
              "statusCode": "USE",
              "statusName": "Using",
              "instanceNo": "-",
              "nasVolumeSize": "500"
            }
          ],
          "usePseudonymInfo": "Y"
        }
        JSON

        Properties

        ItemsRequirement statusTypeRestrictionsDescription
        totalCountYesIntegerTotal infra number of Data Box Frame
        infraTypeYesStringInfra type (Server, NAS
        instanceNameYesStringInfra name
        privateIpYesStringPrivate IP of infra
        publicIpNoStringPublic IP of infra
        osNameYesStringOS name of the server (for NAS, returns empty String)
        specNameYesStringSpec name of the server (for NAS, returns the capacity of the NAS)
        userNameYesStirngConnection account name of the server (for NAS, returns the mount path)
        createDateYesStringCreated date of Data Box Frame
        statusCodeYesStringStatus code of Data Box Frame
        statusNameYesStringStatus name of Data Box Frame
        instanceNoYes

        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.