You can call this operation to query detailed information of logical databases.

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 ListLogicDatabases

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

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 50

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

LogicDatabaseList

The detailed information of logical databases.

LogicDatabase

The detailed information of a 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 1

The IDs of logical database owners.

OwnerIds

The ID of a logical database owner.

OwnerNameList owner_name

The nicknames of logical database owners.

OwnerNames

The nickname of a logical database owner.

SchemaName String logic_db

The name of the logical database.

SearchName String logic_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 request was successful.

TotalCount Long 13

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

Examples

Sample requests


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 am 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 am 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>

JSON format

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

Error codes

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