调用DescribeDrdsShardingDbs接口查询PolarDB-X下的水平拆分数据库。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDrdsShardingDbs

系统规定参数。取值：DescribeDrdsShardingDbs。

DrdsInstanceId String 是 drdshbgaf3c63qbo

PolarDB-X的实例ID。
DbName String 是 drds_test

PolarDB-X实例的数据库名称。
DbNamePattern String 否 test

数据库匹配格式。
PageNumber Long 否 1

当前页数。
PageSize Long 否 20

每页大小。

返回数据

名称 类型 示例值 描述
Success Boolean true

请求是否成功。
RequestId String 509BDE17-505A-4B3B-854D-30D3F092502F

请求ID。
ShardingDbs Array of ShardingDb

返回结果列表。
ShardingDb
MinPoolSize Integer 5

连接池最小个数。
MaxPoolSize Integer 60

连接池最大个数。
DbInstanceId String rm-bp1hjzn0yv5j2****

RDS实例ID。
ConnectUrl String 100.100.64.100:11569

连接url。
GroupName String TEMP1_1568171495522SABE_KUP4_0000

物理分片名称。
DbType String mysql

数据库类型。
IdleTimeOut Integer 30

空闲超时时间。
ShardingDbName String temp1_zhk1_0000

物理分库名。
BlockingTimeout Integer 5000

控制事务为获取锁而需要等待的时长。
PreparedStatementCacheSize Integer 0

结果缓存大小。
ConnectionProperties String connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8

连接串属性。
UserName String pg284mi8

连接RDS的用户名。
DbStatus String running

数据库状态。
PageNumber String 1

当前页数。
PageSize String 20

每页大小。
Total String 1

返回的列表总数量。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDrdsShardingDbs
&DrdsInstanceId=drdshbgaf3c63qbo
&DbName=drds_test
&DbNamePattern=test
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式 

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

<DescribeDrdsShardingDbsResponse>
    <Success>true</Success>
    <RequestId>509BDE17-505A-4B3B-854D-30D3F092502F</RequestId>
    <ShardingDbs>
        <MinPoolSize>5</MinPoolSize>
        <MaxPoolSize>60</MaxPoolSize>
        <DbInstanceId>rm-bp1hjzn0yv5j2****</DbInstanceId>
        <ConnectUrl>100.100.64.100:11569</ConnectUrl>
        <GroupName>TEMP1_1568171495522SABE_KUP4_0000</GroupName>
        <DbType>mysql</DbType>
        <IdleTimeOut>30</IdleTimeOut>
        <ShardingDbName>temp1_zhk1_0000</ShardingDbName>
        <BlockingTimeout>5000</BlockingTimeout>
        <PreparedStatementCacheSize>0</PreparedStatementCacheSize>
        <ConnectionProperties>connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8</ConnectionProperties>
        <UserName>pg284mi8</UserName>
        <DbStatus>running</DbStatus>
    </ShardingDbs>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <Total>1</Total>
</DescribeDrdsShardingDbsResponse>

JSON格式 

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

{
  "Success" : true,
  "RequestId" : "509BDE17-505A-4B3B-854D-30D3F092502F",
  "ShardingDbs" : [ {
    "MinPoolSize" : 5,
    "MaxPoolSize" : 60,
    "DbInstanceId" : "rm-bp1hjzn0yv5j2****",
    "ConnectUrl" : "100.100.64.100:11569",
    "GroupName" : "TEMP1_1568171495522SABE_KUP4_0000",
    "DbType" : "mysql",
    "IdleTimeOut" : 30,
    "ShardingDbName" : "temp1_zhk1_0000",
    "BlockingTimeout" : 5000,
    "PreparedStatementCacheSize" : 0,
    "ConnectionProperties" : "connectTimeout=3000;autoReconnect=true;failOverReadOnly=false;socketTimeout=900000;rewriteBatchedStatements=true;characterEncoding=utf8",
    "UserName" : "pg284mi8",
    "DbStatus" : "running"
  } ],
  "PageNumber" : "1",
  "PageSize" : "20",
  "Total" : "1"
}

错误码

HttpCode 错误码 错误信息 描述
400 ActionUnauthorized The specified action is not available for you 指定的action未授权，请您先做RAM授权再进行操作。
500 InternalError The request processing has failed due to some unknown error. 请求失败，内部错误

访问错误中心查看更多错误码。