All Products
Search
Document Center

AnalyticDB:DescribeClusterResourceDetail

最終更新日:Sep 11, 2024

Queries the information about resource usage of an AnalyticDB for MySQL cluster.

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:DescribeClusterResourceDetailget
  • 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-bp1jj9xqft1po****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The HTTP status code.

200
Dataobject

The queried resource usage.

DBClusterIdstring

The cluster ID.

amv-adbxxxxx
ComputeResourcestring

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
FreeComputeResourcestring

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
StorageResourcestring

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

The resource groups.

object
PoolIdlong

The resource group ID.

17
PoolNamestring

The name of the resource group.

testadb
PoolTypestring

The type of the resource group.

interactive
MinComputeResourcestring

The minimum amount of reserved computing resources.

16ACU
MaxComputeResourcestring

The maximum amount of reserved computing resources.

128ACU
PoolUsersstring

The user of the resource group.

user1
Statusstring

The status of the resource group. Valid values:

  • running
  • deleting
  • scaling
running
ClusterSizeResourcestring

A reserved parameter.

0
MinClusterCountinteger

A reserved parameter.

0
MaxClusterCountinteger

A reserved parameter.

0
RunningClusterCountinteger

A reserved parameter.

0
ClusterModestring

A reserved parameter.

0
EnableSpotboolean

Indicates whether the preemptible instance feature is enabled for the resource group. After the preemptible instance feature is enabled, you are charged for resources at a lower unit price but the resources are probably released. Valid values:

  • true
  • false

The True value is returned only for job resource groups.

true

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2024-01-26The response structure of the API has changedView Change Details
2023-12-06The internal configuration of the API is changed, but the call is not affectedView Change Details