Retrieve Compute Group Details via GetWarehouseDetail API - Hologres - Alibaba Cloud - Hologres

Retrieves the details of a virtual warehouse.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hologram:GetWarehouseDetail

get

*Instance

acs:hologram:{#regionId}:{#accountId}:instance/{#InstanceId}

None

Request syntax

GET /api/v1/instances/{instanceId}/getWarehouseDetail HTTP/1.1

Path Parameters

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

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70
WarehouseDetail	object	The return value.
ReservedCpu	string	The reserved computing resources. The total computing resources of all running virtual warehouses in the instance cannot exceed this value.	64
RemainingCpu	string	The unallocated computing resources in the instance.	32
WarehouseList	array<object>	The warehouses.
	object	Warehouse
Cpu	integer	The number of CPU cores.	32
Mem	integer	The memory size.	128
Id	integer	The ID.	2
Status	string	The status. Valid values: kRunning : The virtual warehouse is running. kSuspended : The virtual warehouse is suspended. kInit : The virtual warehouse is being initialized. kFailed : The virtual warehouse failed to start. kAllocating : Resources are being allocated to the virtual warehouse.	kRunning
NodeCount	integer	The number of compute nodes.	2
Name	string	The name of the virtual warehouse.	MyWarehouse
ElasticCpu	integer	The elastic computing resources.	32
DefaultWarehouse	boolean	Indicates whether this is the default virtual warehouse. Valid values: true : Yes false : No	true
RebalanceStatus	string	The rebalancing status of the virtual warehouse. Valid values: DONE : The rebalancing is complete. DOING : The rebalancing is in progress.	DONE
ClusterCpu	string	The cluster specifications.	32
ElasticType	string	The type of elasticity.	auto
InitClusterCount	string	The number of reserved clusters.	2
ClusterCount	string	The number of clusters.	2
MaxClusterCount	string	The maximum number of clusters.	4
AutoScaleType	string	The auto scaling type.	Standard
TimedElasticCpu	string	The total current scheduled elastic computing resources of the virtual warehouse.	64
AutoElasticCpu	string	The total current auto elastic computing resources of the virtual warehouse.	32

Examples

Success response

JSON format

{
  "RequestId": "D3AE84AB-0873-5FC7-A4C4-8CF869D2FA70",
  "WarehouseDetail": {
    "ReservedCpu": "64",
    "RemainingCpu": "32",
    "WarehouseList": [
      {
        "Cpu": 32,
        "Mem": 128,
        "Id": 2,
        "Status": "kRunning",
        "NodeCount": 2,
        "Name": "MyWarehouse",
        "ElasticCpu": 32,
        "DefaultWarehouse": true,
        "RebalanceStatus": "DONE",
        "ClusterCpu": "32",
        "ElasticType": "auto",
        "InitClusterCount": "2",
        "ClusterCount": "2",
        "MaxClusterCount": "4",
        "AutoScaleType": "Standard"
      }
    ],
    "TimedElasticCpu": "64",
    "AutoElasticCpu": "32"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.