All Products
Search
Document Center

AnalyticDB:DescribeComputeResourceUsage

Last Updated:Aug 30, 2024

Operation description

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

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
adb:DescribeComputeResourceUsageget
  • DBClusterLakeVersion
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

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
ResourceGroupNamestringYes

The name of the resource group.

test
StartTimestringYes

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
EndTimestringYes

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

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-8A4442913CEAW
Codeinteger

The HTTP status code.

200
Dataobject

The queried resource usage.

DBClusterIdstring

The cluster ID.

amv-clusterxxx
ResourceGroupTypestring

The type of the resource group.

interative
ResourceGroupNamestring

The name of the resource group.

test
StartTimestring

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
EndTimestring

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
AcuInfoarray<object>

The AnalyticDB compute unit (ACU) usage of the cluster.

object
Namestring

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
Valuesarray

The values of the metric at specific points in time.

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 timeSummary of changesOperation
2023-12-06The internal configuration of the API is changed, but the call is not affectedView Change Details