get-data-box-infra-list

VPC環境で利用できます。

Data Boxインフラリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/data-box/get-data-box-infra-list

リクエストヘッダ

Data Box Frame APIで共通して使用されるヘッダの詳細は、Data Box Frameのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`dataBoxFrameNo`	Integer	Required	Data Box Frame番号 get-data-box-frame-listを参照
`dataBoxNo`	Integer	Required	Data Box番号 get-data-box-listを参照

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`totalCount`	Integer	-	レスポンス結果数
`content`	Array	-	Data Boxインフラリスト

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`productCode`	String	-	インフラのタイプコード Product Codeを参照
`productType`	String	-	インフラの詳細タイプ Product Spec Codeを参照
`prodSpecId`	Integer	-	サーバスペックコード Product Spec Codeを参照
`instanceNo`	String	-	サーバ番号
`contractInstanceNo`	String	-	サーバインスタンス番号
`instanceName`	String	-	サーバインスタンス名
`blockStorageInstanceNo`	String	-	サーバにマウントされたブロックストレージインスタンス番号
`blockStorageSize`	String	-	ブロックストレージ容量(GB)
`privateIp`	String	-	サーバのプライベート IPアドレス
`specName`	String	-	サーバスペック名または NAS容量(GB) Product Spec Codeを参照
`connectInfo1`	String	-	Connectサーバの1番目のアクセスアカウントまたは NASのマウントパス
`connectInfo2`	String	-	Connectサーバの2番目のアクセスアカウント
`statusCode`	String	-	Data Boxの状態コード `READY` \| `INIT` \| `USE` \| `ING` \| `RTN` \| `TERMT` `READY`: 申し込み中 `INIT`: 作成中 `USE`: 利用中 `ING`: 変更中 `RTN`: 返却中 `TERMT`: 返却完了
`statusName`	String	-	Data Boxの状態名 `Request for creating` \| `Initial State` \| `Using` \| `Changing` \| `Returning` \| `Terminated` `Request for creating`: 申し込み中 `Initial State`: 作成中 `Using`: 利用中 `Changing`: 変更中 `Returning`: 返却中 `Terminated`: 返却完了
`instanceStatusCode`	String	-	サーバの状態コード `RUN` \| `REBOOT` \| `SETTING` `RUN`: 利用中 `REBOOT`: 再起動中 `SETTING`: 設定中

レスポンスステータスコード

Data Box Frame APIで共通して使用されるレスポンスステータスコードの詳細は、Data Box Frame APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "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"
        }
    ]
}