Lists warehouses.
Operation description
This operation lists your warehouses.
QPS limit
This operation has a per-user QPS limit of 10 requests per second. Calls exceeding this limit are throttled, which can affect your business.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| WarehouseInstanceIds |
array |
No |
A list of warehouse instance IDs. |
cas-wh-uc-gl2bsq |
|
string |
No |
The warehouse instance ID. |
cas-wh-uc-gl2bsq |
|
| WarehouseTypes |
array |
No |
A list of warehouse types. |
pcaCaCert |
|
string |
No |
The warehouse type. |
pcaCaCert |
|
| NextToken |
string |
No |
The pagination token from a previous response. Use this token to retrieve the next page of results. Omit this parameter for the first request. |
1d2db86sca4384811e0b5e8707e68181f |
| MaxResults |
integer |
No |
The maximum number of entries to return on each page. |
20 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response body. |
||
| TotalCount |
integer |
The total number of entries in the result set. |
10 |
| NextToken |
string |
The token to retrieve the next page of results. If this parameter is not returned, all results have been retrieved. |
1d2db86sca4384811e0b5e8707e68181f |
| MaxResults |
integer |
The maximum number of entries returned on each page. The default value is 20. |
20 |
| Data |
array<object> |
A list of warehouse objects. |
|
|
object |
The details of a warehouse object. |
||
| WarehouseInstanceId |
string |
The warehouse instance ID. |
cas-wh-Q7ID6V |
| WarehouseName |
string |
The warehouse name. |
default_warehouse |
| WarehouseType |
string |
The warehouse type. |
pcaCaCert |
| RequestId |
string |
The request ID. |
5979d897-d69f-4fc9-87dd-f3bb73c40b80 |
Examples
Success response
JSON format
{
"TotalCount": 10,
"NextToken": "1d2db86sca4384811e0b5e8707e68181f",
"MaxResults": 20,
"Data": [
{
"WarehouseInstanceId": "cas-wh-Q7ID6V",
"WarehouseName": "default_warehouse",
"WarehouseType": "pcaCaCert"
}
],
"RequestId": "5979d897-d69f-4fc9-87dd-f3bb73c40b80"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.