All Products
Search
Document Center

AnalyticDB:DescribeDBResourcePool

Last Updated:Aug 30, 2024

Queries the information about resource groups of an AnalyticDB for MySQL cluster. You can call this operation only for AnalyticDB for MySQL Data Warehouse Edition clusters in elastic mode for Cluster Edition.

Operation description

This operation is applicable only for elastic clusters of 32 cores or more.

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:DescribeDBResourcePoolget
  • DBCluster
    acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.
am-bp11q28kvl688****
PoolNamestringYes

The name of the resource group.

USER_DEFAULT

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PoolsInfoarray<object>

Details of the resource group.

object
QueryTypestring

The mode in which SQL statements are executed.

  • batch
  • interactive
Note For more information, see Query execution modes.
default_type
UpdateTimestring

The time when the resource group was updated.

2022-03-09 16:57:35.241
PoolNamestring

The name of the resource group.

USER_DEFAULT
CreateTimestring

The time when the resource group was created.

2022-03-09 16:57:35.241
PoolUsersstring

The database accounts that are associated with the resource group.

testb,testc
NodeNuminteger

The number of nodes.

Note Each node consumes 16 cores and 64 GB memory.
2
DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

am-bp11q28kvl688****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PoolsInfo": [
    {
      "QueryType": "default_type",
      "UpdateTime": "2022-03-09 16:57:35.241",
      "PoolName": "USER_DEFAULT",
      "CreateTime": "2022-03-09 16:57:35.241",
      "PoolUsers": "testb,testc",
      "NodeNum": 2
    }
  ],
  "DBClusterId": "am-bp11q28kvl688****"
}

Error codes

HTTP status codeError codeError messageDescription
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

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