SearchTable - Data Management - Alibaba Cloud Documentation Center

Queries detailed information about tables.

Operation description

You can call this operation only for database instances that are managed in Security Collaboration mode.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dms:SearchTable	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.	1
SearchKey	string	No	The keyword that is used to query tables.	test
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10
EnvType	string	No	The type of the environment to which databases belong. For more information, see Change the environment type of an instance.	PRODUCT
SearchRange	string	No	The scope of tables that you want to query. Valid values: HAS_PERMSSION: the tables on which the current account has permissions. OWNER: the tables owned by the current account. MY_FOCUS: the tables that the current account follows. UNKNOWN: all tables.	OWNER
SearchTarget	string	No	The type of table that you want to query. Valid values: TABLE: physical and logical tables SINGLE_TABLE: physical tables LOGIC_TABLE: logical tables	LOGIC_TABLE
DbType	string	No	The type of database. Valid values: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	MySQL
ReturnGuid	boolean	No	Specifies whether to return the GUID of each table.	false

Response parameters

Parameter	Type	Description	Example
	object
SearchTableList	array<object>	The details of the tables.
SearchTable	object
DatabaseId	string	The ID of the database to which the table belongs.	1
TableName	string	The name of the table.	test_table
DBSearchName	string	The name that is used to search for the database to which the table belongs.	test
Logic	boolean	Indicates whether the table is a logical table. Valid values: true: The table is a logical table. false: The table is not a logical table.	false
EnvType	string	The type of the environment to which the database belongs.	test
DbName	string	The name of the database.	test
OwnerIdList	array	The IDs of the table owners.
OwnerIds	string	The ID of the table owner.	1
Description	string	The description of the table.	test
Encoding	string	The encoding format of the table.	utf8
DbType	string	The type of the database. Valid values: MySQL SQLServer PostgreSQL Oracle DRDS OceanBase Mongo Redis	mysql
OwnerNameList	array	The nicknames of the table owners.
OwnerNames	string	The nickname of the table owner.	user
TableSchemaName	string	The name of the database to which the table belongs.	test@xxx.xxx.xxx.xxx:3306
TableGuid	string	The GUID of the table.	IDB_L_9032.db-test.yuyang_test
Engine	string	The engine of the table.	innodb
TableId	string	The ID of the table.	1
TotalCount	long	The total number of entries that are returned.	1
RequestId	string	The ID of the request.	1489257F-1B5D-4B5B-89EF-923C12CEEBD1
ErrorCode	string	The error code returned if the request failed.	UnknownError
ErrorMessage	string	The error message returned if the request failed.	UnknownError
Success	boolean	Indicates whether the request was successful.	true

Examples

Sample success responses

JSONformat

{
  "SearchTableList": {
    "SearchTable": [
      {
        "DatabaseId": "1",
        "TableName": "test_table",
        "DBSearchName": "test",
        "Logic": false,
        "EnvType": "test",
        "DbName": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Description": "test",
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "Engine": "innodb",
        "TableId": "1"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history