get-data-box-frame-infra-list

VPC環境で利用できます。

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

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`dataBoxFrameNo`	Integer	Required	Data Box Frame番号 get-data-box-frame-listを参照
`pageNo`	Integer	Optional	ページ番号 1~100 (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~100 (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-infra-list?dataBoxFrameNo=83' \
--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 Frameリスト
`usePseudonymInfo`	String	-	インフラ管理権限を強化するかどうか `Y` \| `N`

`content`

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

フィールド	タイプ	必須の有無	説明
`infraType`	String	-	インフラタイプ `Server` \| `NAS`
`instanceName`	String	-	インフラ名
`privateIp`	String	-	インフラのプライベート IPアドレス `infraType`が`Server`の場合に表示
`publicIp`	String	-	インフラのグローバル IPアドレス `infraType`が`Server`の場合に表示
`osName`	String	-	サーバの OS名 `infraType`が`Server`の場合、表示
`specName`	String	-	サーバまたは NASスペック名 `infraType`が`NAS`の場合、容量を表示
`userName`	String	-	サーバアクセスアカウント名 `infraType`が`NAS`の場合、マウントパスを表示
`prodSpecId`	String	-	サーバスペックコード Product Spec Codeを参照 `infraType`が`Server`の場合、表示
`connectInfo`	String	-	アクセス情報アドミンサーバのユーザー名(Username)
`useData`	String	-	使用データ(GB) `infraType`が`NAS`の場合、表示
`createDate`	String	-	Data Box Frameの作成日時 YYYY-MM-DD HH:mm:ss形式
`statusCode`	String	-	Data Box Frameの状態コード `SET_READY` \| `SET_INIT` \| `SET_USE` \| `SET_ING` \| `SET_RTN` \| `SET_TERMT` `SET_READY`: 申し込み中 `SET_INIT`: 作成中 `SET_USE`: 利用中 `SET_ING`: 変更中 `SET_RTN`: 返却中 `SET_TERMT`: 返却完了
`statusName`	String	-	Data Box Frameの状態名 `Request for creating` \| `Initial State` \| `Using` \| `Changing` \| `Returning` \| `Terminated` `Request for creating`: 申し込み中 `Initial State`: 作成中 `Using`: 利用中 `Changing`: 変更中 `Returning`: 返却中 `Terminated`: 返却完了
`instanceNo`	String	-	インフラ番号
`contractInstanceNo`	String	-	インフラのインスタンス番号
`nasVolumeSize`	String	-	NASボリュームサイズ(GB) `infraType`が`NAS`の場合、表示

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

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

レスポンス例

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

{
    "totalCount": 2,
    "content": [
        {
            "infraType": "Server",
            "instanceName": "admin-83-1",
            "privateIp": "***.***.***.***",
            "publicIp": "***.***.***.***",
            "osName": "Ubuntu",
            "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
            "prodSpecId": 2001,
            "userName": "root",
            "connectInfo": "root",
            "createDate": "2025-03-25 11:20:10",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceNo": "*********",
            "contractInstanceNo": "-",
            "instanceStatusCode": "RUN"
        },
        {
            "infraType": "NAS",
            "instanceName": "pub83n1",
            "specName": "500",
            "userName": "root",
            "connectInfo": "/mnt/nasr/pub83n1",
            "useData": "0",
            "createDate": "2025-03-25 11:20:10",
            "statusCode": "USE",
            "statusName": "Using",
            "instanceNo": "********",
            "contractInstanceNo": "-",
            "nasVolumeSize": "500"
        }
    ],
    "usePseudonymInfo": "N"
}