GetWarehouseDetail - Hologres - Alibaba Cloud Documentation Center

Queries details of a virtual warehouse instance.

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}/getWarehouseDetail

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	No	The instance ID.	hgprecn-cn-i7m2ucpyu005

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
WarehouseDetail	object	The values returned.
ReservedCpu	string	The reserved computing resources. The amount of computing resources in all running virtual warehouses in an instance cannot exceed the amount of reserved computing resources in the virtual warehouses.	64
RemainingCpu	string	The remaining unallocated computing resources of the virtual warehouse instance.	32
WarehouseList	object []	The list of virtual warehouses.
Cpu	long	The number of CPU cores.	32
Mem	long	The memory capacity.	128
Id	long	The ID.	2
Status	string	The status. Valid values: kRunning kSuspended kInit kFailed kAllocating	kRunning
NodeCount	long	The number of compute nodes.	2
Name	string	The name of the virtual warehouse instance.	MyWarehouse

Examples

Sample success responses

JSONformat

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "WarehouseDetail": {
    "ReservedCpu": "64",
    "RemainingCpu": "32",
    "WarehouseList": [
      {
        "Cpu": 32,
        "Mem": 128,
        "Id": 2,
        "Status": "kRunning",
        "NodeCount": 2,
        "Name": "MyWarehouse"
      }
    ]
  }
}

Error codes

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