You can call this operation to query the resource pool information of a cluster. This operation can be used only for AnalyticDB for MySQL elastic clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically 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-bpxxxxxxxx47

The ID of the cluster.

PoolName String Yes test

The name of the resource pool.

Response parameters

Parameter Type Example Description
PoolsInfo Array of PoolInfo

The list of resource pools.

CreateTime String 2020-10-28 18:13:23.0

The creation time.

NodeNum Integer 2

The number of nodes.

PoolName String test

The name of the resource pool.

PoolUsers String testb,testc

The list of accounts that are bound to the resource pool.

QueryType String batch

The query execution mode. Valid values:

  • etl: the batch mode
  • interactive: the interactive mode
  • default_type: the default mode

For more information, see Query execution modes.

UpdateTime String 2020-11-03 12:10:52.0

The update time.

RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeDBResourcePool
&DBClusterId=am-bpxxxxxxxx47
&PoolName=test
&<Common request parameters>

Sample success responses

XML format

<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<PoolsInfo>
    <NodeNum>2</NodeNum>
    <PoolName>test</PoolName>
    <CreateTime>2020-10-28 18:13:23.0</CreateTime>
    <UpdateTime>2020-11-03 12:10:52.0</UpdateTime>
    <PoolUsers>testb,testc</PoolUsers>
    <QueryType>batch</QueryType>
</PoolsInfo>

JSON format

{
    "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
    "PoolsInfo": {
        "NodeNum": 2,
        "PoolName": "test",
        "CreateTime": "2020-10-28 18:13:23.0",
        "UpdateTime": "2020-11-03 12:10:52.0",
        "PoolUsers": "testb,testc",
        "QueryType": "batch"
    }
}

Error codes

HttpCode 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 you specify the DBClusterId parameter correctly.

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