ListLogicTables API Reference & Pagination Overview - Data Management - Alibaba Cloud - Data Management

Queries logical tables in a logical database.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:ListLogicTables

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see Manage DMS tenants.	-1
DatabaseId	string	Yes	The ID of the logical database.	1
PageNumber	integer	No	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 keyword that is used to search for the logical tables. Prefix match is supported.	test
ReturnGuid	boolean	No	Specifies whether to return the GUID of the table.	true

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of logical tables that meet the query conditions.	1
LogicTableList	object
LogicTable	array<object>	The details of the logical tables.
	array<object>
DatabaseId	string	The ID of the logical database.	1
TableName	string	The name of the logical table.	test
TableCount	string	The number of logical tables.	4
OwnerIdList	object
OwnerIds	array	The IDs of the owners of the logical tables.
	string	The ID of the owner of a logical table.	1
OwnerNameList	object
OwnerNames	array	The nicknames of the owners of the logical tables.
	string	The nickname of the owner of a logical table.	owner_name
SchemaName	string	The logical database to which the logical table belongs.	yuyang_test
Logic	boolean	Indicates whether the table is a logical table. The value is fixed to true.	true
TableExpr	string	The expression of the logical table.	test[1-4]
TableGuid	string	The GUID of the logical table.	IDB_L_308302.yuyang_test.test_ch
TableId	string	The ID of the logical table.	1
RequestId	string	The ID of the request.	F1E6484F-9DF1-4406-9BDE-0861C4629B69
ErrorCode	string	The error code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request is successful.	true

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "LogicTableList": {
    "LogicTable": [
      {
        "DatabaseId": "1",
        "TableName": "test",
        "TableCount": "4",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "SchemaName": "yuyang_test",
        "Logic": true,
        "TableExpr": "test[1-4]",
        "TableGuid": "IDB_L_308302.yuyang_test.test_ch",
        "TableId": "1"
      }
    ]
  },
  "RequestId": "F1E6484F-9DF1-4406-9BDE-0861C4629B69",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.