Queries information about tables in a PolarDB-X database.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. 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 DescribeDistributeTableList

The operation that you want to perform. Set the value to DescribeDistributeTableList.

RegionId String Yes cn-hangzhou

The ID of the region where your PolarDB-X instance is deployed.

DBInstanceName String Yes pxc-********

The name of the PolarDB-X instance.

DbName String Yes sbtest1

The name of the database.

Response parameters

Parameter Type Example Description
Message String Success

The message that is returned. If the request is successful, "success" is returned. If the request fails, an error code is returned.

RequestId String C458B1E8-1683-3645-B154-6BA32080EEA

The ID of the request.

Success Boolean true

Indicates whether the request is successful.
Data Object

The data that is returned.

Tables Array of Table

The list of tables.

TableName String sbtest1

The name of the table.

TableType String multi

The type of the table.

TbKey String ""

The primary key of the table.

DbKey String id

The primary key of the database.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeDistributeTableList
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&DbName=sbtest1
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeDistributeTableListResponse>
    <Message>Success</Message>
    <RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
    <Success>true</Success>
    <Data>
        <Tables>
            <TableName>sbtest1</TableName>
            <TableType>multi</TableType>
            <TbKey>""</TbKey>
            <DbKey>id</DbKey>
        </Tables>
    </Data>
</DescribeDistributeTableListResponse>

JSON format 

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

{
  "Message" : "Success",
  "RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Success" : true,
  "Data" : {
    "Tables" : [ {
      "TableName" : "sbtest1",
      "TableType" : "multi",
      "TbKey" : """",
      "DbKey" : "id"
    } ]
  }
}

Error codes

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