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

调试

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

请求参数

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

系统规定参数,取值为DescribeTables。

DbName String test

数据库名称。

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

实例ID。

Query String drds************

查询条件,取值为目标实例ID。

RegionId String cn-hangzhou

地域ID。

PageSize Integer 10

每页大小。

CurrentPage Integer 1

当前页数。

返回数据

名称 类型 示例值 描述
List Array

返回集合对象 。

AllowFullTableScan Boolean false

是否允许全表扫描。

Broadcast Boolean false

是否为广播表。

DbInstType Integer 0

实例类型,取值范围如下:

  • 0:独享型。
  • 1:共享型。
IsLocked Boolean false

是否锁定。

IsShard Boolean false

是否拆分。

ShardKey String null

拆分键。

Status Integer 0

拆分任务状态,取值范围如下:

  • 0:正常、无任务。
  • 1:变更中、有拆分任务。
Table String test

表名。

PageNumber Integer 1

页数。

PageSize Integer 10

每页大小。

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

请求ID。

Success Boolean true

当前API是否请求成功。

Total Integer 1

总数量。

示例

请求示例

http(s)://https://drds.aliyuncs.com/?Action=DescribeTables
&DbName=test
&DrdsInstanceId=drds************
&Query=drds************
&<公共请求参数>

正常返回示例

XML 格式

<code>200</code>
<data>
    <PageSize>40</PageSize>
    <RequestId>83AC3D7E-461C-4D87-8ACD-6CC295******</RequestId>
    <PageNumber>1</PageNumber>
    <Total>2</Total>
    <List>
        <DbInstType>0</DbInstType>
        <IsShard>false</IsShard>
        <Table>test</Table>
        <Broadcast>false</Broadcast>
        <ShardKey>null</ShardKey>
        <IsLocked>false</IsLocked>
        <AllowFullTableScan>false</AllowFullTableScan>
    </List>
    <List>
        <DbInstType>0</DbInstType>
        <IsShard>true</IsShard>
        <Table>test</Table>
        <Broadcast>false</Broadcast>
        <ShardKey>["id"]</ShardKey>
        <IsLocked>false</IsLocked>
        <AllowFullTableScan>true</AllowFullTableScan>
    </List>
    <Success>true</Success>
</data>
<requestId>83AC3D7E-461C-4D87-8ACD-6CC295******</requestId>
<successResponse>true</successResponse>

JSON 格式

{
  "code": "200",
  "data": {
    "PageSize": 40,
    "RequestId": "83AC3D7E-461C-4D87-8ACD-6CC295******",
    "PageNumber": 1,
    "Total": 2,
    "List": [
      {
        "DbInstType": 0,
        "IsShard": false,
        "Table": "test",
        "Broadcast": false,
        "ShardKey": "null",
        "IsLocked": false,
        "AllowFullTableScan": false
      },
      {
        "DbInstType": 0,
        "IsShard": true,
        "Table": "test",
        "Broadcast": false,
        "ShardKey": "[\"id\"]",
        "IsLocked": false,
        "AllowFullTableScan": true
      }
    ],
    "Success": true
  },
  "requestId": "83AC3D7E-461C-4D87-8ACD-6CC295******",
  "successResponse": true
}

错误码

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