Call ListLogicDatabases returns logical database details List


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListLogicDatabases

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

PageNumber Integer Yes 1

The page number of the returned page.

Tid Long Yes -1

The ID of the tenant.

Note The tenant ID is taken from the tenant ID displayed when you move the pointer on your profile picture. For more information, see View tenant information .
PageSize Integer No 50

The number of entries to return on each page.

Response parameters

Parameter Type Sample response Description
ErrorCode String UnknownError

The error codes.

ErrorMessage String UnknownError

The error message of the failure.

LogicDatabaseList Array of LogicDatabase

The details of the logical database.

DatabaseId String 1

The ID of the logical database.

DbType String mysql

The type of the logical database.

EnvType String test

The type of the environment to which the logical database belongs.

Logic Boolean true

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

OwnerIdList List 1

The ID of a logical database owner.

OwnerNameList List owner_name

The nickname of a logical database owner.

SchemaName String logic_db

The name of the logical database.

SearchName String loigc_db

The query name of the logical database.

RequestId String BAD154C0-DA38-48FA-97AB-E72912EEAA24

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

TotalCount Long 13

The total number of logical databases.


Sample request

     http(s)://[Endpoint]/? Action=ListLogicDatabases &PageNumber=1 &Tid=-1 &<common request parameters> 

Sample success responses

XML format

     <TotalCount> 13 </TotalCount> <RequestId> bad154c0-da38-48fa-97ab-e72912eeaa24 </RequestId> <LogicDatabaseList> <LogicDatabase> <Logic> true </Logic> <OwnerNameList> <OwnerNames> xxx </OwnerNames> </OwnerNameList> <DatabaseId> 257 </DatabaseId> <SearchName> test_db (I is a logical database) </SearchName> <DbType> mysql </DbType> <OwnerIdList> <OwnerIds> 88653 </OwnerIds> </OwnerIdList> <EnvType> dev </EnvType> <SchemaName> test_db </SchemaName> </LogicDatabase> <LogicDatabase> <Logic> true </Logic> <OwnerNameList> <OwnerNames> xxx </OwnerNames> <OwnerNames> xxx </OwnerNames> <OwnerNames> xxx </OwnerNames> </OwnerNameList> <DatabaseId> 258 </DatabaseId> <SearchName> xxx_test (I is a logical database) </SearchName> <DbType> mysql </DbType> <OwnerIdList> <OwnerIds> 88656 </OwnerIds> <OwnerIds> 88653 </OwnerIds> <OwnerIds> 101252 </OwnerIds> </OwnerIdList> <EnvType> product </EnvType> <SchemaName> idb_test </SchemaName> </LogicDatabase> </LogicDatabaseList> <Success> true </Success> 


     {"TotalCount": 13, "RequestId": "BAD154C0-DA38-48 FA-97AB-E72912EEAA24", "LogicDatabaseList": { "LogicDatabase": [ { "Logic": true, "OwnerNameList": { "OwnerNames": [ "xxx" ] }, "DatabaseId": 257, "SearchName": "test_db (I am a logical database)", "DbType": "mysql", "OwnerIdList": {"OwnerIds": [ 88653 ] }, "EnvType": "dev", "SchemaName": "test_db" }, { "Logic": true, "OwnerNameList": { "OwnerNames": [ "xxx", "xxx", "xxx" ] }, "DatabaseId": 78, "SearchName": "xxx_test (I am a logical database)", "DbType": "mysql", "OwnerIdList": { "OwnerIds": [ 88656, 88653, 101252 ] }, "EnvType": "product", "SchemaName": "idb_test" } ] }, "Success": true} 

Error codes

For more information about error codes, see error center.