Queries details of tables.


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

Element Type Required? Remarks Description
Action String Yes SearchTable

The operation that you want to perform. Valid values: SearchTable .

Tid Long No 1

The ID of the tenant.

Note Take the tenant ID information displayed in the upper right corner of the system. For details, see Tenant ID and Tenant .
SearchKey String Yes test

Search for the keyword of the table name.

PageNumber Integer No 1

The page number of the returned page.

PageSize Integer No 10

The number of entries returned per page.

EnvType String Yes PRODUCT

The environment type of the database. For more information, see Instance environment description .

SearchTarget String Yes LOGIC_TABLE

Search for the table type, with the following values:

  • TABLE : table, which contains physical tables and logical tables
  • SINGLE_TABLE : physical table
  • LOGIC_TABLE : logical table
SearchRange String Yes OWNER

The permission on the database. Valid values:

  • HAS_PERMSSION : Permitted
  • OWNER : My Owner's
  • MY_FOCUS : What I care about
  • UNKNOWN : unlimited
DbType String Yes MySQL

The type of the database instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
ReturnGuid Boolean No false

Whether to return the table GUID.

Response parameters

Element Type Sample response Description
ErrorCode String UnknownError

The error code returned.

ErrorMessage String UnknownError

The returned message.

RequestId String 1489257F-1B5D-4B5B-89EF-923C12CEEBD1

The ID of the request.

SearchTableList Array of SearchTable

The list of search table details.

DBSearchName String test

The search name of the database corresponding to the table.

DatabaseId String 1

The ID of the library to which it belongs.

DbName String test

The schema of the PolarDB-X database.

DbType String mysql

The type of the database instance. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
Description String test

The description of the instance.

Encoding String utf8

Table encoding.

Engine String innodb

Table engine.

EnvType String test

The environment type.

Logic Boolean false

Whether it is a logical table. Valid values:

  • true : Yes
  • false : No
OwnerIdList List 1

Table Owner ID list.

OwnerNameList List user

Table Owner nickname list.

TableGuid String IDB_L_9032.db-test.yuyang_test

Table GUID.

TableId String 1

The ID of the table.

TableName String test_table

The name of the table.

TableSchemaName String test@xxx.xxx.xxx.xxx:3306

The name of the database corresponding to the table.

Success Boolean true

Indicates whether the call was successful.

TotalCount Long 1

The total number of records that meet the search criteria.


Sample requests

     http(s)://[Endpoint]/?Action=SearchTable &<Public request parameters> 

Sample success responses

XML format

     <SearchTableList> <SearchTable> <TableGuid>IDB_L_9032.db-test.yuyang_test</TableGuid> <Logic>false</Logic> <TableSchemaName>xxx_0000</TableSchemaName> <OwnerNameList> <OwnerNames>xxx</OwnerNames> <OwnerNames>xxx</OwnerNames> <OwnerNames> <xxx</OwnerNames> </OwnerNames> </OwnerNames> </OwnerNameList> <DBSearchName>xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xxx offline library] </DBSearchName> <DatabaseId>117567</DatabaseId> <Encoding>utf8mb4</Encoding> <TableName>test_aaaa</TableName> <OwnerIdList> <OwnerIds>88653</OwnerIds> <OwnerIds>88656</OwnerIds> <OwnerIds>104442</OwnerIds>> <TableId>18396767</TableId> </SearchTable> </SearchTableList> <TotalCount>1</TotalCount> <RequestId> String </RequestId> <Success>true</Success> 

JSON Address format

     { "SearchTableList": { "SearchTable": [ { "TableGuid" : "IDB_L_9032.db-test.yuyang_test", "Logic": false, "TableSchemaName": "xxx_0000", "OwnerNameList": { "OwnerNames": [ "xxx", "xxx", "xxx" ] }, "DBSearchName": "xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xxx offline library]", "DatabaseId": 117567, "Encoding": "utf8mb4", "TableName": "test_aaaa", "OwnerIdList": { "OwnerIds": [ 88653, 88656, 104442 ] }, "EnvType": "dev", "Engine": "InnoDB", "TableId": 18396767 } ] }, "TotalCount": 1, "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1", "Success": true } 

Error codes

Go to the Error Center See more error codes.