Queries the resource pool information of an AnalyticDB for MySQL cluster.

Description

This operation can be called only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeDBResourcePool

The operation that you want to perform. Set the value to DescribeDBResourcePool.

DBClusterId String Yes am-bp11q28kvl688****

The ID of the cluster.

PoolName String Yes USER_DEFAULT

The name of the resource pool.

Response parameters

Parameter Type Example Description
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

PoolsInfo Array of PoolInfo

The information of the resource pool.

QueryType String default_type

The query execution mode. Valid values:

  • etl: the batch mode
  • interactive: the interactive mode
  • default_type: the default mode
Note For more information, see Query execution modes.
UpdateTime String 2022-03-09 16:57:35.241

The time when the resource pool was updated.

PoolName String USER_DEFAULT

The name of the resource pool.

CreateTime String 2022-03-09 16:57:35.241

The time when the resource pool was created.

PoolUsers String testb,testc

The accounts that are bound to the resource pool.

NodeNum Integer 2

The number of nodes.

Examples

Sample requests

http(s)://adb.aliyuncs.com/?Action=DescribeDBResourcePool
&DBClusterId=am-bp11q28kvl688****
&PoolName=USER_DEFAULT
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBResourcePoolResponse>
    <RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
    <PoolsInfo>
        <QueryType>default_type</QueryType>
        <UpdateTime>2022-03-09 16:57:35.241</UpdateTime>
        <PoolName>USER_DEFAULT</PoolName>
        <CreateTime>2022-03-09 16:57:35.241</CreateTime>
        <PoolUsers>testb,testc</PoolUsers>
        <NodeNum>2</NodeNum>
    </PoolsInfo>
</DescribeDBResourcePoolResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code Error code Error message Description
404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The error message returned because the specified DBClusterId parameter does not exist. Check whether the cluster ID is valid.

For a list of error codes, visit the API Error Center.