You can call this operation to query detailed information of logical tables in a specified logical database.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListLogicTables

The operation that you want to perform. Set the value to ListLogicTables.

DatabaseId String Yes 1

The ID of the logical database.

PageNumber Integer Yes 1

The number of the page to return.

Tid Long Yes -1

The ID of the tenant in Data Management (DMS) Enterprise.

PageSize Integer No 10

The number of entries to return on each page.

SearchName String No test

The keyword used to query logical tables. Prefix match is supported.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

LogicTableList

The detailed information of logical tables.

LogicTable

The detailed information of a logical table.

DatabaseId String 1

The ID of the logical database.

Logic Boolean true

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

OwnerIdList 1

The IDs of logical table owners.

OwnerIds

The ID of a logical table owner.

OwnerNameList owner_name

The nicknames of logical table owners.

OwnerNames

The nickname of a logical table owner.

TableCount String 4

The number of partitions in the logical table.

TableExpr String test[1-4]

The expression of the logical table.

TableId String 1

The ID of the logical table.

TableName String test

The name of the logical table.

RequestId String F1E6484F-9DF1-4406-9BDE-0861C4629B69

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

TotalCount Long 1

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

Examples

Sample requests


http(s)://[Endpoint]/? Action=ListLogicTables
&<Common request parameters>

Sample success responses

XML format

<TotalCount>1</TotalCount>
<RequestId>F1E6484F-9DF1-4406-9BDE-0861C4629B69</RequestId>
<LogicTableList>
    <LogicTable>
        <Logic>true</Logic>
        <OwnerNameList>
            <OwnerNames>xxx</OwnerNames>
            <OwnerNames>xxx[RAM user]</OwnerNames>
        </OwnerNameList>
        <TableExpr>t[1-4]</TableExpr>
        <DatabaseId>267</DatabaseId>
        <TableName>t</TableName>
        <TableCount>4</TableCount>
        <OwnerIdList>
            <OwnerIds>88653</OwnerIds>
            <OwnerIds>104442</OwnerIds>
        </OwnerIdList>
        <TableId>3057</TableId>
    </LogicTable>
</LogicTableList>
<Success>true</Success>

JSON format

{
	"TotalCount":1,
	"RequestId":"F1E6484F-9DF1-4406-9BDE-0861C4629B69",
	"LogicTableList":{
		"LogicTable":[
			{
				"Logic":true,
				"OwnerNameList":{
					"OwnerNames":[
						"xxx",
						"xxx[RAM user]"
					]
				},
				"DatabaseId":267,
				"TableExpr":"t[1-4]",
				"TableName":"t",
				"TableCount":4,
				"OwnerIdList":{
					"OwnerIds":[
						88653,
						104442
					]
				},
				"TableId":3057
			}
		]
	},
	"Success":true
}

Error codes

For a list of error codes, visit the API Error Center.