You can call this operation to search the table details list.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes SearchTable

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

Tid Long No -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 .
SearchKey String No test

The keyword to be matched.

PageNumber Integer No 1

The page number of the returned page.

PageSize Integer No 10

The number of the entries to return on each page.

EnvType String No test

The type of the environment.

SearchTarget String No SINGLE_TABLE

The table type. Values:

  • TABLE: The name of the physical TABLE.
  • LOGIC_TABLE: Creates a logical table.
SearchRange String No OWNER

The type of the permission. For more information, see SearchDatabase.

DbType String No MySQL

The type of the database. For more information, see RegisterInstance.

ReturnGuid Boolean No false

Specifies whether to return a table GUID.

Response parameters

Parameter Type Sample response Description
ErrorCode String UnknownError

The error codes.

ErrorMessage String UnknownError

The error message of the failure.

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

The ID of the request.

SearchTableList Array of SearchTable

Search for the table details list.

SearchTable
DBSearchName String test

The name of the database to which the table belongs.

DatabaseId String 1

The ID of the database to which the RDS instance belongs.

DbName String test

The schema of the PolarDB-X database.

DbType String mysql

The type of the database. For more information, see API of RegisterInstance.

Description String test

The description of the remote file.

Encoding String utf8

The table encoding.

Engine String innodb

The engine of the table.

EnvType String test

The type of the environment.

Logic Boolean false

Indicates whether the table is a logical table.

OwnerIdList List 1

The ID of a table Owner.

OwnerNameList List user

The nickname of the table Owner.

TableGuid String IDB_L_9032.db-test.yuyang_test

The GUID of the table.

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 to which the table belongs.

Success Boolean true

Indicates whether the call was successful.

TotalCount Long 1

The total number of records that met the search criteria.

Examples

Sample request


     http(s)://[Endpoint]/? Action=SearchTable &<common 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> </OwnerNameList> <DBSearchName> xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306 [xxx line lower reservoir] </DBSearchName> <DatabaseId> 117567 </DatabaseId> <Encoding> utf8mb4 </Encoding> <TableName> test_aaaa </TableName> <OwnerIdList> <OwnerIds> 88653 </OwnerIds> <OwnerIds> 88656 </OwnerIds> <OwnerIds> 104442 </OwnerIds> </OwnerIdList> <EnvType> dev </EnvType> <Engine> InnoDB </Engine> <TableId> 18396767 </TableId> </SearchTable> </SearchTableList> <TotalCount> 1 </TotalCount> <RequestId> 1489257F-1B5D-4B5B-89EF-923C12CEEBD1 </RequestId> <Success> true </Success> 
   

JSON


     {"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 database]", "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

For more information about error codes, see error center.