调用DescribeTables接口获取表信息列表。

调试

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

请求参数

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

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

DrdsInstanceId String 是 drds************

实例ID。
DbName String 是 test

数据库名称。
Query String 否 drds************

查询条件，取值为目标实例ID。
PageSize Integer 否 10

每页大小。
CurrentPage Integer 否 1

当前页数。
RegionId String 是 cn-hangzhou

地域ID。

返回数据

名称 类型 示例值 描述
PageSize Integer 10

每页大小。
PageNumber Integer 1

页数。
RequestId String 83AC3D7E-461C-4D87-8ACD-6CC295******

请求ID。
Total Integer 1

总数量。
Success Boolean true

请求是否成功。
List Array of List

返回的表信息列表。
Status Integer 0

拆分任务状态，取值范围如下：

  • 0：正常、无任务；
  • 1：变更中、有拆分任务。
IsLocked Boolean false

是否锁定。
ShardKey String null

拆分键。
IsShard Boolean false

是否拆分。
Broadcast Boolean false

是否为广播表。
AllowFullTableScan Boolean false

是否允许全表扫描。
Table String test

表名称。
DbInstType Integer 0

实例类型，取值范围如下：

  • 0：独享型；
  • 1：共享型。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeTables
&DrdsInstanceId=drds************
&DbName=test
&Query=drds************
&PageSize=10
&CurrentPage=1
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式 

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

<DescribeTablesResponse>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>83AC3D7E-461C-4D87-8ACD-6CC295******</RequestId>
    <Total>1</Total>
    <Success>true</Success>
    <List>
        <Status>0</Status>
        <IsLocked>false</IsLocked>
        <ShardKey>null</ShardKey>
        <IsShard>false</IsShard>
        <Broadcast>false</Broadcast>
        <AllowFullTableScan>false</AllowFullTableScan>
        <Table>test</Table>
        <DbInstType>0</DbInstType>
    </List>
</DescribeTablesResponse>

JSON格式 

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

{
  "PageSize" : 10,
  "PageNumber" : 1,
  "RequestId" : "83AC3D7E-461C-4D87-8ACD-6CC295******",
  "Total" : 1,
  "Success" : true,
  "List" : [ {
    "Status" : 0,
    "IsLocked" : false,
    "ShardKey" : "null",
    "IsShard" : false,
    "Broadcast" : false,
    "AllowFullTableScan" : false,
    "Table" : "test",
    "DbInstType" : 0
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError The request processing has failed due to some unknown error. 请求失败，内部错误

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