All Products
Search
Document Center

Data Management:ListLogicTables

Last Updated:Mar 14, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
dms:ListLogicTablesRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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
DatabaseIdstringYes

The ID of the logical database.

1
PageNumberintegerYes

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

10
SearchNamestringNo

The keyword that is used to search for the logical tables. Prefix match is supported.

test
ReturnGuidbooleanNo

Specifies whether to return the GUID of the table.

true

Response parameters

ParameterTypeDescriptionExample
object
TotalCountlong

The total number of logical tables that meet the query conditions.

1
LogicTableListobject []

The details of the logical tables.

DatabaseIdstring

The ID of the logical database.

1
TableNamestring

The name of the logical table.

test
TableCountstring

The number of logical tables.

4
OwnerIdListarray

The IDs of the owners of the logical tables.

string

The ID of the owner of a logical table.

1
OwnerNameListarray

The nicknames of the owners of the logical tables.

string

The nickname of the owner of a logical table.

owner_name
SchemaNamestring

The logical database to which the logical table belongs.

yuyang_test
Logicboolean

Indicates whether the table is a logical table. The value is fixed to true.

true
TableExprstring

The expression of the logical table.

test[1-4]
TableGuidstring

The GUID of the logical table.

IDB_L_308302.yuyang_test.test_ch
TableIdstring

The ID of the logical table.

1
RequestIdstring

The ID of the request.

F1E6484F-9DF1-4406-9BDE-0861C4629B69
ErrorCodestring

The error code.

UnknownError
ErrorMessagestring

The error message.

UnknownError
Successboolean

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 timeSummary of changesOperation
No change history