You can call this ListLogicTables to query detailed information of logical tables in a specified logical database.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | ListLogicTables |
The operation that you want to perform. Set the value to ListLogicTables. |
DatabaseId | String | Yes | 1 |
The ID of the logical database. |
PageNumber | Integer | Yes | 1 |
The page number of the returned page. |
Tid | Long | Yes | -1 |
The ID of the tenant. Note
The tenant ID is
taken from the tenant ID displayed when you move the pointer on your profile picture.
For more information, see
View tenant information
.
|
PageSize | Integer | No | 10 |
The number of the entries to return on each page. |
SearchName | String | No | test |
The keyword used to query logical tables. Prefix is used as the keyword to match logical tables. |
ReturnGuid | Boolean | No | true |
Specifies whether to return the GUID of the table. |
Response parameters
Parameter | Type | Sample response | Description |
---|---|---|---|
ErrorCode | String | UnknownError |
The error codes. |
ErrorMessage | String | UnknownError |
The error message of the failure. |
LogicTableList | Array of LogicTable |
The details of a logical table. |
|
LogicTable | |||
DatabaseId | String | 1 |
The ID of the logical database. |
Logic | Boolean | true |
Indicates whether the table was a logical table. The value is fixed to true. |
OwnerIdList | List | 1 |
The ID of a logical table Owner. |
OwnerNameList | List | owner_name |
The nickname of the logical table Owner. |
SchemaName | String | yuyang_test |
The name of the logical database that corresponds to the current logical table. |
TableCount | String | 4 |
The number of table shards. |
TableExpr | String | test[1-4] |
The expression of the logical table. |
TableGuid | String | IDB_L_308302.yuyang_test.test_ch |
The GUID of the logical table. |
TableId | String | 1 |
The ID of the logical table. |
TableName | String | test |
The name of the logical table. |
RequestId | String | F1E6484F-9DF1-4406-9BDE-0861C4629B69 |
The ID of the request. |
Success | Boolean | true |
Indicates whether the call was successful. |
TotalCount | Long | 1 |
The number of records that met the condition. |
Examples
Sample request
http(s)://[Endpoint]/? Action=ListLogicTables &<common request parameters>
Sample success responses
XML
format
<TotalCount>1</TotalCount> <RequestId>F1E6484F-9DF1-4406-9BDE-0861C4629B69</RequestId> <LogicTableList> <LogicTable> <Logic>true</Logic> <OwnerNameList> <OwnerNames>xxx</OwnerNames> <OwnerNames>xxx</OwnerNames> </OwnerNameList> <TableExpr>t[1-4]</TableExpr> <DatabaseId>267</DatabaseId> <SchemaName>yuyang_test</SchemaName> <TableName>t</TableName> <TableGuid>IDB_L_3057.yuyang_test.t</TableGuid> <TableCount>4</TableCount> <OwnerIdList> <OwnerIds>88653</OwnerIds> <OwnerIds>104442</OwnerIds> </OwnerIdList> <TableId>3057</TableId> </LogicTable> </LogicTableList> <Success>true</Success>
JSON
{ "TotalCount": 1, "RequestId": "F1E6484F-9DF1-4406-9BDE-0861C4629B69", "LogicTableList": { "LogicTable": [ { "Logic": true, "OwnerNameList": { "OwnerNames": [ "xxx", "xxx" ] }, "TableExpr": "t[1-4]", "DatabaseId": 267, "SchemaName": "yuyang_test", "TableName": "t", "TableGuid": "IDB_L_3057.yuyang_test.t", "TableCount": 4, "OwnerIdList": { "OwnerIds": [ 88653, 104442 ] }, "TableId": 3057 } ] }, "Success": true }
Error codes
For more information about error codes, see error center .