ListLogicTables - Data Management - Alibaba Cloud Documentation Center

Queries the details of the logical tables in a logical database.

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

There is currently no authorization information disclosed in the API.

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 Manage DMS tenants.	-1
DatabaseId	string	Yes	The ID of the logical database.	1
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 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 parameters

Parameter	Type	Description	Example
	object
TotalCount	long	The total number of logical tables that meet the query conditions.	1
LogicTableList	array<object>	The details of the logical tables.
LogicTable	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	array	The IDs of the owners of the logical tables.
OwnerIds	string	The ID of the owner of a logical table.	1
OwnerNameList	array	The nicknames of the owners of the logical tables.
OwnerNames	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

Sample success responses

JSONformat

{
  "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

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

Change history

Change time	Summary of changes	Operation

No change history