get-data-box-infra-list

Prev Next

Available in VPC

Get the list of Data Box infrastructures.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /api/v1/data-box/get-data-box-infra-list

Request headers

For information about the headers common to all Data Box Frame APIs, see Data Box Frame request headers.

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
dataBoxFrameNo Integer Required Data Box Frame number
dataBoxNo Integer Required Data Box number

Request example

The request example is as follows:

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box/get-data-box-infra-list?dataBoxFrameNo=83&dataBoxNo=381' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
totalCount Integer - Number of response results
content Array - Data Box infrastructure list

content

The following describes content.

Field Type Required Description
productCode String - Infrastructure type code
productType String - Infrastructure detailed type
prodSpecId Integer - Server spec code
instanceNo String - Server number
contractInstanceNo String - Server instance number
instanceName String - Server instance name
blockStorageInstanceNo String - Number of block storage instance mounted on the server
blockStorageSize String - Block storage size (GB)
privateIp String - Server's private IP
specName String - Server spec name or NAS capacity (GB)
connectInfo1 String - First access account for Connect server or NAS mount path
connectInfo2 String - Second access account for Connect server
statusCode String - Data Box status code
  • READY | INIT | USE | ING | RTN | TERMT
    • READY: requesting
    • INIT: creating
    • USE: in use
    • ING: changing
    • RTN: terminating
    • TERMT: termination completed
statusName String - Data Box status name
  • Request for creating | Initial State | Using | Changing | Returning | Terminated
    • Request for creating: requesting
    • Initial State: creating
    • Using: in use
    • Changing: changing
    • Returning: terminating
    • Terminated: termination completed
instanceStatusCode String - Server status code
  • RUN | REBOOT | SETTING
    • RUN: in use
    • REBOOT: restarting
    • SETTING: configuring

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:

{
    "totalCount": 9,
    "content": [
        {
            "productCode": "CON",
            "productType": "Connect Server",
            "prodSpecId": 4001,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "conn-83-381-1",
            "blockStorageInstanceNo": "*********",
            "blockStorageSize": 500,
            "privateIp": "***.***.***.***",
            "specName": "Connect Windows Server (S2 W1 : 2vCPU 8GB Mem)",
            "connectInfo1": "ncp1",
            "connectInfo2": "ncp2",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceStatusCode": "RUN"
        },
        {
            "productCode": "SVR_LNX_UBUNTU",
            "productType": "Linux Server(Ubuntu)",
            "prodSpecId": 6101,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "svrlnx-83-381-1",
            "blockStorageInstanceNo": "*********",
            "blockStorageSize": 500,
            "privateIp": "***.***.***.***",
            "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
            "connectInfo1": "root",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceStatusCode": "RUN"
        },
        {
            "productCode": "TF_CPU",
            "productType": "TensorFlow Server(CPU)",
            "prodSpecId": 7007,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "tfcpu-83-381-1",
            "blockStorageInstanceNo": "*********",
            "blockStorageSize": 500,
            "privateIp": "***.***.***.***",
            "specName": "Tensorflow CPU Linux Server (S2-L1 : 2vCPU 8GB Mem)",
            "connectInfo1": "root",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceStatusCode": "RUN"
        },
        {
            "productCode": "NAS",
            "productType": "NAS",
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "nasw381n1",
            "specName": "500",
            "connectInfo1": "/mnt/nasw381n1",
            "statusCode": "USE",
            "statusName": "Using"
        },
        {
            "productCode": "HD_E",
            "productType": "Hadoop Edge",
            "prodSpecId": 5001,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "e-001-hd-83-381-1-6va4-hd",
            "privateIp": "***.***.***.***",
            "specName": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "connectInfo1": "ncp",
            "statusCode": "USE",
            "statusName": "Using"
        },
        {
            "productCode": "HD_M",
            "productType": "Hadoop Master",
            "prodSpecId": 5101,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "m-001-hd-83-381-1-6va2-hd",
            "blockStorageInstanceNo": "****",
            "blockStorageSize": 500,
            "specName": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "statusCode": "USE",
            "statusName": "Using"
        },
        {
            "productCode": "HD_M",
            "productType": "Hadoop Master",
            "prodSpecId": 5101,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "m-002-hd-83-381-1-6va3-hd",
            "blockStorageInstanceNo": "****",
            "blockStorageSize": 500,
            "specName": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "statusCode": "USE",
            "statusName": "Using"
        },
        {
            "productCode": "HD_W",
            "productType": "Hadoop Worker",
            "prodSpecId": 5201,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "d-001-hd-83-381-1-6va5-hd",
            "blockStorageInstanceNo": "****",
            "blockStorageSize": 500,
            "specName": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "statusCode": "USE",
            "statusName": "Using"
        },
        {
            "productCode": "HD_W",
            "productType": "Hadoop Worker",
            "prodSpecId": 5201,
            "instanceNo": "*********",
            "contractInstanceNo":"-",
            "instanceName": "d-002-hd-83-381-1-6va6-hd",
            "blockStorageInstanceNo": "****",
            "blockStorageSize": 500,
            "specName": "Hadoop Linux Server (C8-H1 : 8vCPU 16GB Mem)",
            "statusCode": "USE",
            "statusName": "Using"
        }
    ]
}