ListTables - Data Management - Alibaba Cloud Documentation Center

Queries the tables in a database.

Operation description

You can call this operation only for database instances whose control mode is Security Collaboration.

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:ListTables	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to query the tenant ID.	3***
DatabaseId	string	Yes	The ID of the physical database. You can call the ListDatabases or SearchDatabase operation to obtain the ID of the physical database.	1860****
PageNumber	integer	Yes	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	10
SearchName	string	No	The name used to search for tables. Fuzzy search is supported.	test
ReturnGuid	boolean	No	Specifies whether to return the GUID of a table. Valid values: true: returns the GUID of a table. false: does not return the GUID of a table.	true

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of tables that meet the query conditions.	1
RequestId	string	The ID of the request.	B16FB618-5E96-4FFD-BB0D-490C890A4030
ErrorCode	string	The error code returned.	UnknownError
TableList	array<object>	The details of the tables.
Table	object
DatabaseId	string	The ID of the physical database.	1860****
TableName	string	The table name.	consumption_records
StoreCapacity	long	The storage space that is occupied by the table. This is a statistical value and does not indicate the accurate storage space. Unit: MB.	1024
OwnerIdList	array	The ID list of the table owners.
OwnerIds	string	The ID of the table owner.	51****
Description	string	The description of the table.	test
Encoding	string	The encoding format of the table.	utf8
OwnerNameList	array	The nickname list of the table owners.
OwnerNames	string	The nickname of the table owner.	owner_name
TableSchemaName	string	The database in which the table resides.	qntest
TableType	string	The type of the table. Default value: NORMAL.	NORMAL
TableGuid	string	The GUID of the table in DMS.	IDB_44743****.qntest.consumption_records
Engine	string	The engine of the table.	InnoDB
NumRows	long	The number of rows in the table. This is a statistical value and does not indicate the actual number of rows.	10085
TableId	string	The ID of the table.	44743****
ErrorMessage	string	The error message returned.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "B16FB618-5E96-4FFD-BB0D-490C890A4030",
  "ErrorCode": "UnknownError",
  "TableList": {
    "Table": [
      {
        "DatabaseId": "1860****",
        "TableName": "consumption_records",
        "StoreCapacity": 1024,
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "Description": "test",
        "Encoding": "utf8",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "TableSchemaName": "qntest",
        "TableType": "NORMAL",
        "TableGuid": "IDB_44743****.qntest.consumption_records",
        "Engine": "InnoDB",
        "NumRows": 10085,
        "TableId": "44743****"
      }
    ]
  },
  "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