You can call this operation to query detailed information of tables.

Debugging

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 SearchTable

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

PageNumber Integer Yes 1

The number of the page to return.

SearchKey String Yes test

The keyword used to query tables.

Tid Long Yes -1

The ID of the tenant in Data Management (DMS) Enterprise.

EnvType String No test

The type of the environment.

PageSize Integer No 10

The number of entries to return on each page.

SearchRange String No OWNER

The permission on the table. For more information about the valid values, see the description of the SearchDatabase operation.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

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

The ID of the request.

SearchTableList

The detailed information of tables.

SearchTable

The detailed information of a table.

DBSearchName String test

The query name of the database to which the table belongs.

DatabaseId String 1

The ID of the database to which the table belongs.

Encoding String utf8

The encoding format of the table.

Engine String innodb

The engine of the table.

EnvType String test

The type of the environment.

Logic Boolean false

Indicates whether the table was a logical table.

OwnerIdList 1

The IDs of table owners.

OwnerIds

The ID of a table owner.

OwnerNameList user

The nicknames of table owners.

OwnerNames

The nickname of a table owner.

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 request was successful.

TotalCount Long 1

The total number of tables that met the query conditions.

Examples

Sample requests


http(s)://[Endpoint]/? Action=SearchTable
&PageNumber=1
&SearchKey=test
&Tid=-1
&<Common request parameters>

Sample success responses

XML format

<SearchTableList>
    <SearchTable>
        <Logic>false</Logic>
        <TableSchemaName>xxx_0000</TableSchemaName>
        <OwnerNameList>
            <OwnerNames>xxx</OwnerNames>
            <OwnerNames>xxx</OwnerNames>
            <OwnerNames>xxx[RAM user]</OwnerNames>
        </OwnerNameList>
        <DBSearchName>xxx_0000@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306[xxx offline database]</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 format

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

Error codes

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