DescribeComputeResourceUsage - AnalyticDB - Alibaba Cloud Documentation Center

Queries the computing resource usage of a resource group in an AnalyticDB for MySQL cluster.

Operation description

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeComputeResourceUsage	get	*DBClusterLakeVersion `acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}`	none	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-bp1xxxxxxxx47
ResourceGroupName	string	Yes	The name of the resource group.	test
StartTime	string	Yes	The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-02-04T03:45:00Z
EndTime	string	Yes	The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2023-02-05T03:45:00Z

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEAW
Code	integer	The HTTP status code.	200
Data	object	The queried resource usage.
DBClusterId	string	The cluster ID.	amv-clusterxxx
ResourceGroupType	string	The type of the resource group.	interative
ResourceGroupName	string	The name of the resource group.	test
StartTime	string	The start time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-04-24T07:00:00Z
EndTime	string	The end time of the query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2023-06-07T02:37:00Z
AcuInfo	array<object>	The AnalyticDB compute unit (ACU) usage of the cluster.
acuInfo	object
Name	string	The resource usage metric. Valid values: `TotalAcuNumber`: the total number of ACUs. `ReservedAcuNumber`: the number of ACUs for the reserved resources. `ReservedAcuUsageNumber`: the number of ACUs for the reserved resources that are used.	TotalAcuNumber
Values	array	The values of the metric at specific points in time.
value	string	The value of the metric at a specific point in time.	16.0

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEAW",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-clusterxxx",
    "ResourceGroupType": "interative",
    "ResourceGroupName": "test",
    "StartTime": "2023-04-24T07:00:00Z",
    "EndTime": "2023-06-07T02:37:00Z",
    "AcuInfo": [
      {
        "Name": "TotalAcuNumber",
        "Values": [
          "16.0"
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-12-06	The internal configuration of the API is changed, but the call is not affected	View Change Details