ListWarehouse
ウェアハウスの一覧を取得します。
操作説明
この操作では、ご利用のウェアハウスの一覧を取得します。
QPS 制限
この操作には、ユーザー単位で 1 秒あたり最大 10 回の QPS(Queries Per Second)制限があります。この制限を超えるリクエストはスロットルされ、ビジネスに影響を及ぼす可能性があります。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| WarehouseInstanceIds |
array |
任意 |
ウェアハウスインスタンス ID のリストです。 |
cas-wh-uc-gl2bsq |
|
string |
任意 |
ウェアハウスインスタンス ID です。 |
cas-wh-uc-gl2bsq |
|
| WarehouseTypes |
array |
任意 |
ウェアハウスタイプのリストです。 |
pcaCaCert |
|
string |
任意 |
ウェアハウスタイプです。 |
pcaCaCert |
|
| NextToken |
string |
任意 |
前回の応答から取得したページネーショントークンです。このトークンを使用して、次のページの結果を取得します。最初のリクエストでは、このパラメーターを省略してください。 |
1d2db86sca4384811e0b5e8707e68181f |
| MaxResults |
integer |
任意 |
各ページで返される最大エントリ数です。 |
20 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスボディです。 |
||
| TotalCount |
integer |
結果セット内のエントリ総数です。 |
10 |
| NextToken |
string |
次のページの結果を取得するためのトークンです。このパラメーターが応答に含まれていない場合は、すべての結果が取得済みです。 |
1d2db86sca4384811e0b5e8707e68181f |
| MaxResults |
integer |
各ページで返される最大エントリ数です。デフォルト値は 20 です。 |
20 |
| Data |
array<object> |
ウェアハウスオブジェクトのリストです。 |
|
|
object |
ウェアハウスオブジェクトの詳細です。 |
||
| WarehouseInstanceId |
string |
ウェアハウスインスタンス ID です。 |
cas-wh-Q7ID6V |
| WarehouseName |
string |
ウェアハウス名です。 |
default_warehouse |
| WarehouseType |
string |
ウェアハウスタイプです。 |
pcaCaCert |
| RequestId |
string |
リクエスト ID です。 |
5979d897-d69f-4fc9-87dd-f3bb73c40b80 |
例
成功レスポンス
JSONJSON
{
"TotalCount": 10,
"NextToken": "1d2db86sca4384811e0b5e8707e68181f",
"MaxResults": 20,
"Data": [
{
"WarehouseInstanceId": "cas-wh-Q7ID6V",
"WarehouseName": "default_warehouse",
"WarehouseType": "pcaCaCert"
}
],
"RequestId": "5979d897-d69f-4fc9-87dd-f3bb73c40b80"
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。