Use DescribeClusterResourceDetail to query cluster resource usage - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries resource usage details of an AnalyticDB for MySQL cluster.

Operation description

For information about the endpoints of AnalyticDB for MySQL, see Endpoints.

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

adb:DescribeClusterResourceDetail

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID. Note You can call the DescribeDBClusters operation to query the information about all AnalyticDB for MySQL clusters within a region, including cluster IDs.	am-bp1jj9xqft1po****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Code	integer	The HTTP status code.	200
Data	object	The queried resource usage.
DBClusterId	string	The cluster ID.	amv-adbxxxxx
ComputeResource	string	The amount of reserved computing resources. Unit: AnalyticDB compute units (ACUs). Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.	16ACU
FreeComputeResource	string	The amount of idle reserved computing resources. Unit: ACUs. Valid values: 0 to 4096. The value must be in increments of 16 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.	0ACU
StorageResource	string	The amount of reserved storage resources. Unit: ACUs. Valid values: 0 to 2064. The value must be in increments of 24 ACUs. Each ACU is equivalent to 1 core and 4 GB memory.	24ACU
ResourceGroupList	array<object>	The resource groups.
	object
PoolId	integer	The resource group ID.	17
PoolName	string	The name of the resource group.	testadb
PoolType	string	The type of the resource group.	interactive
MinComputeResource	string	The minimum amount of reserved computing resources.	16ACU
MaxComputeResource	string	The maximum amount of reserved computing resources.	128ACU
PoolUsers	string	The user of the resource group.	user1
Status	string	The status of the resource group. Valid values: running deleting scaling	running
ClusterSizeResource	string	A reserved parameter.	0
MinClusterCount	integer	A reserved parameter.	0
MaxClusterCount	integer	A reserved parameter.	0
RunningClusterCount	integer	A reserved parameter.	0
ClusterMode	string	A reserved parameter.	0
EnableSpot	boolean	Indicates whether the preemptible instance feature is enabled for the resource group. When this feature is enabled, resources are offered at a lower unit price but may be released. Valid values: true false A value of true is returned only for job resource groups.	true

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-adbxxxxx",
    "ComputeResource": "16ACU",
    "FreeComputeResource": "0ACU",
    "StorageResource": "24ACU",
    "ResourceGroupList": [
      {
        "PoolId": 17,
        "PoolName": "testadb",
        "PoolType": "interactive",
        "MinComputeResource": "16ACU",
        "MaxComputeResource": "128ACU",
        "PoolUsers": "user1",
        "Status": "running",
        "ClusterSizeResource": "0",
        "MinClusterCount": 0,
        "MaxClusterCount": 0,
        "RunningClusterCount": 0,
        "ClusterMode": "0",
        "EnableSpot": true
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.