get-data-box-frame-infra-list
- 印刷する
- PDF
get-data-box-frame-infra-list
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Data Box Frameのインフラリストを照会します。
GET https://{endpoint}/data-box-frame/get-data-box-frame-list
リクエスト
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| dataBoxFrameNo | No | Integer | Data Box Frame番号 | |
| pageNo | No | Integer | 1 ~ 100 | ページ番号 |
| pageSize | No | Integer | 1 ~ 100 | ページごとに照会する項目数 |
レスポンス
| HTTPステータスコード | 説明 |
|---|---|
| 200 | 成功 |
| 400 | リクエスト情報エラー |
| 401 | 認証失敗 |
| 403 | リクエスト情報に対する権限なし |
| 404 | リソースが存在しない |
| 500 | サーバエラー |
例
リクエスト例
GET https://databoxframe.apigw.ntruss.com/api/v1/data-box-frame/get-data-box-frame-infra-list?dataBoxFrameNo=1046
レスポンス例
{
"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"
}
プロパティ
| 項目 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| totalCount | Yes | Integer | Data Box Frameの Infra数 | |
| infraType | Yes | String | Infraのタイプ(Server、NAS | |
| instanceName | Yes | String | Infra名 | |
| privateIp | Yes | String | Infraのプライベート IPアドレス | |
| publicIp | No | String | Infraのグローバル IPアドレス | |
| osName | Yes | String | サーバの OS名(NASの場合、空 Stringをリターン) | |
| specName | Yes | String | サーバのスペック名(NASの場合、NASの容量をリターン) | |
| userName | Yes | Stirng | サーバのアクセスアカウント名(NASの場合、マウントパスを変換) | |
| createDate | Yes | String | Data Box Frameの作成日時 | |
| statusCode | Yes | String | Data Box Frameのステータスコード | |
| statusName | Yes | String | Data Box Frameのステータス名 | |
| instanceNo | Yes |
エラーコード
| HTTP Status Code | リターンコード | 説明 |
|---|---|---|
| 200 | - | 一般的なリクエスト成功 |
| 400 | 10001, 130*** | リクエスト情報とパラメータエラー |
| 403 | 10002 | リクエスト情報に対する権限なし |
| 404 | 10009 | リソースが存在しない |
| 500 | 130000 | サービス内部エラー |
| 500 | 139999 | 連携サービス APIの呼び出しエラー |
この記事は役に立ちましたか?