You can call this operation DescribeTables to query table information.

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 DescribeTables The operation that you want to perform. Set the value to DescribeTables.
DbName String Yes test The name of the DRDS database.
DrdsInstanceId String Yes drds************ The ID of the instance.
Query String Yes drds************ The query condition. Set the value to the ID of the target instance.
Region ID String Yes cn-hangzhou The ID of the region where the streaming domain resides.
PageSize String Optional 10 The number of entries per page.
CurrentPage String Optional 1 The page number of the returned page.

Response parameters

Parameter Type Example Description
List Array Returns the collection object.
AllowFullTableScan Boolean false Specifies whether to enable full table scan.
Broadcast Boolean false Indicates whether the table is a broadcast table.
DbInstType Integer 0 The type of the instances. Valid values:
  • 0: Dedicated instance.
  • 1: Shared instance.
IsLocked Boolean false

Indicates whether the table was locked.

IsShard Boolean false Indicates whether the table was partitioned.
ShardKey String null The shard key of the table.
Status Integer 0 The status of the split task. Valid values:
  • 0: no split task.
  • 1: a split task is ongoing.
Table String test The name of a table.
PageNumber Integer 1 The number of the returned page.
PageSize Integer 10 The number of entries per page.
RequestId String 83 AC3D7 E-461C-4D87-8ACD-6CC295****** The ID of the request.
Success Boolean True Indicates whether the request was successful.
Total Integer 1 The total number of channels returned.

Examples

Sample requests

http(s)://https://drds.aliyuncs.com/? Action=DescribeTables
&DbName=test
&DrdsInstanceId=drds************
&Query=drds************
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

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