Queries tables based on a table type.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeTableListByType |
The operation that you want to perform. Set the value to DescribeTableListByType. |
DbName | String | Yes | drds_flash**** |
The name of the database. |
DrdsInstanceId | String | Yes | drdshbga76p6**** |
The ID of the PolarDB-X 1.0 instance. |
Query | String | Yes | drdshbga76p61861 |
The field that you specify for your query. |
TableType | String | Yes | SINGLE |
The type of tables. Valid values: |
RegionId | String | No | cn-hangzhou |
The ID of the region. |
PageSize | Integer | No | 10 |
The number of entries to return on each page. |
CurrentPage | Integer | No | 1 |
The number of the page to return. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
List | Array of List |
Indicates the information about tables. |
|
Property | String | single |
Indicates the property of a table. |
TableName | String | employee_split |
Indicates the name of the table. |
PageNumber | Integer | 1 |
Indicates the page number of the returned page. |
PageSize | Integer | 10 |
Indicates the number of entries returned per page. |
RequestId | String | B360F47B-59E3-4D1C-BA03-6BFB1C993F88 |
Indicates the unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure. |
Success | Boolean | true |
Indicates whether the request is successful. |
Total | Integer | 1 |
Indicates the total number of returned tables. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeTableListByType
&DbName=drds_flash****
&DrdsInstanceId=drdshbga76p6****
&Query=drdshbga76p61861
&TableType=SINGLE
&<Common request parameters>
Sample success responses
XML
format
<PageSize>10</PageSize>
<RequestId>B360F47B-59E3-4D1C-BA03-6BFB1C993F88</RequestId>
<PageNumber>1</PageNumber>
<Total>1</Total>
<List>
<TableName>employee_split</TableName>
<Property>single</Property>
</List>
<Success>true</Success>
JSON
format
{"PageSize":"10","RequestId":"B360F47B-59E3-4D1C-BA03-6BFB1C993F88","PageNumber":"1","Total":"1","List":[{"TableName":"employee_split","Property":"single"}],"Success":"true"}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
500 | InternalError | The request processing has failed due to some unknown error. | The error message returned because an internal error has occurred. |
For a list of error codes, visit the API Error Center.