You can call this operation to query detailed information of 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 GetLogicDatabase

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

DbId String Yes 1

The ID of the logical database.

Tid Long Yes 0

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

Response parameters

Parameter Type Example Description
ErrorCode String UnknownError

The error code.

ErrorMessage String UnknownError

The error message.

LogicDatabase

The detailed information of the logical database.

DatabaseId String 1

The ID of the logical database.

DbType String mysql

The type of the logical database.

EnvType String dev

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 database owners.

OwnerIds

The ID of a database owner.

OwnerNameList owner_name

The nicknames of database owners.

OwnerNames

The nickname of a database owner.

SchemaName String test_logic_db

The name of the logical database.

SearchName String test_logic_db[xxx]

The query name of the logical database.

RequestId String 90260530-565C-42B9-A6E8-893481FE6AB6

The ID of the request.

Success Boolean true

Indicates whether the request was successful.

Examples

Sample requests


http(s)://[Endpoint]/? Action=GetLogicDatabase
&DbId=1
&Tid=0
&<Common request parameters>

Sample success responses

XML format

<LogicDatabase>
    <Logic>true</Logic>
    <OwnerNameList>
        <OwnerNames>xxx</OwnerNames>
        <OwnerNames>xxx</OwnerNames>
        <OwnerNames>xxx</OwnerNames>
    </OwnerNameList>
    <DatabaseId>265</DatabaseId>
    <SearchName>test_logic_db[xxx]</SearchName>
    <DbType>mysql</DbType>
    <OwnerIdList>
        <OwnerIds>88653</OwnerIds>
        <OwnerIds>97787</OwnerIds>
        <OwnerIds>88654</OwnerIds>
    </OwnerIdList>
    <EnvType>dev</EnvType>
    <SchemaName>test_logic_db</SchemaName>
</LogicDatabase>
<RequestId>90260530-565C-42B9-A6E8-893481FE6AB6</RequestId>
<Success>true</Success>

JSON format

{
	"LogicDatabase":{
		"Logic":true,
		"OwnerNameList":{
			"OwnerNames":[
				"xxx",
				"xxx",
				"xxx"
			]
		},
		"DatabaseId":265,
		"SearchName":"test_logic_db[xxx]",
		"DbType":"mysql",
		"EnvType":"dev",
		"OwnerIdList":{
			"OwnerIds":[
				88653,
				97787,
				88654
			]
		},
		"SchemaName":"test_logic_db"
	},
	"RequestId":"90260530-565C-42B9-A6E8-893481FE6AB6",
	"Success":true
}

Error codes

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