get-box-infra-list

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`fenceId`	Integer	Required	Datafence番号 get-datafenceを参照
`boxId`	Integer	Required	Box番号 get-box-listを参照
`page`	Integer	Optional	ページ番号 0~100 (デフォルト: 0)
`size`	Integer	Optional	ページごとの項目数 1~100 (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-infra-list?fenceId=26&boxId=74&page=1&size=10' \
--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	-	Boxインフラリスト

`content`

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

フィールド	タイプ	必須の有無	説明
`infraType`	String	-	インフラのタイプコード Product Codeを参照
`instanceNo`	Integer	-	インフラのインスタンス番号
`instanceName`	String	-	インフラのインスタンス名
`blockStorageInstanceNo`	Integer	-	サーバにマウントされたブロックストレージインスタンス番号
`blockStorageSize`	Integer	-	ブロックストレージ容量(GB)
`privateIp`	String	-	サーバのプライベート IPアドレス
`specName`	String	-	サーバスペック名または NAS容量(GB) get-product-specを参照
`userName1`	String	-	サーバの1番目のアクセスアカウントまたは NASのマウントパス
`userName2`	String	-	サーバの2番目のアクセスアカウント
`statusCode`	String	-	Boxの状態コード `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: インフラ作成中 `USE`: 利用中 `ING`: 変更中 `RETURN`: 返却中 `TERMINATE`: 返却完了
`statusName`	String	-	Boxの状態名 `インフラ作成中` \| `利用中` \| `変更中` \| `返却中` \| `返却完了`
`instanceStatusCode`	String	-	インフラの状態コード `RUN` \| `REBOOT` \| `SETTING` `RUN`: 利用中 `REBOOT`: 再起動 `SETTING`: 設定中
`instanceStatus`	String	-	インフラの状態名 `利用中` \| `再起動` \| `設定中`

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

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

レスポンス例

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

{
    "totalCount": 5,
    "content": [
        {
            "infraType": "CON",
            "instanceNo": *********,
            "instanceName": "conn-26-74-1",
            "blockStorageInstanceNo": 1047*****,
            "blockStorageSize": 500,
            "privateIp": "10.0.1.70",
            "specName": "Connect Windows Server (S2 W1 : 2vCPU 8GB Mem)",
            "userName1": "ncp1",
            "userName2": "ncp2",
            "statusCode": "USE",
            "statusName": "利用中",
            "instanceStatus": "利用中",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "SVR_LNX_UBUNTU",
            "instanceNo": *********,
            "instanceName": "svrlnx-26-74-1",
            "blockStorageInstanceNo": 1047*****,
            "blockStorageSize": 500,
            "privateIp": "10.0.1.72",
            "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
            "userName1": "root",
            "statusCode": "USE",
            "statusName": "利用中",
            "instanceStatus": "利用中",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "TF_CPU",
            "instanceNo": *********,
            "instanceName": "tfcpu-26-74-1",
            "blockStorageInstanceNo": 1047*****,
            "blockStorageSize": 500,
            "privateIp": "10.0.1.71",
            "specName": "Tensorflow CPU Linux Server (S2-L1 : 2vCPU 8GB Mem)",
            "userName1": "root",
            "statusCode": "USE",
            "statusName": "利用中",
            "instanceStatus": "利用中",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "BOX_NAS",
            "instanceNo": *********,
            "instanceName": "74box1",
            "specName": "500",
            "userName1": "/mnt/74box1",
            "statusCode": "USE",
            "statusName": "利用中",
            "instanceStatus": "利用中",
            "instanceStatusCode": "USE"
        },
        {
            "infraType": "HD",
            "instanceNo": *********,
            "instanceName": "hd-26-74-1",
            "privateIp": "10.0.1.75",
            "specName": "2.2",
            "userName1": "sshuser",
            "statusCode": "USE",
            "statusName": "利用中",
            "instanceStatus": "利用中",
            "instanceStatusCode": "USE"
        }
    ]
}