ListWarehouses - Hologres - Alibaba Cloud Documentation Center

Queries the list of virtual warehouse instances.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /api/v1/instances/{instanceId}/listWarehouses

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	hgpostcn-cn-x0r382joi001

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
requestId	string	The request ID.	819A7F0F-2951-540F-BD94-6A41ECF0281F
WarehouseList	object []	The list of virtual warehouse instances.
Id	long	The ID.	3
Cpu	long	The number of CPU cores.	32
Mem	long	The memory capacity.	128
Name	string	The name of the virtual warehouse instance.	MyWarehouse
Status	string	The status. Valid values: kRunning kSuspended kInit kFailed kAllocating	kRunning
NodeCount	long	The number of compute nodes.	2

Examples

Sample success responses

JSONformat

{
  "requestId": "819A7F0F-2951-540F-BD94-6A41ECF0281F",
  "WarehouseList": [
    {
      "Id": 3,
      "Cpu": 32,
      "Mem": 128,
      "Name": "MyWarehouse",
      "Status": "kRunning",
      "NodeCount": 2
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.