GetLogicDatabase -

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.
Tid	Long	Yes	3***	The ID of the tenant. Note To view the ID of the tenant, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
DbId	String	Yes	1***	The ID of the logical database. You can call the ListLogicDatabases or SearchDatabase operation to obtain the ID of the logical database.
RegionId	String	No	cn-hangzhou	The ID of the region in which DMS is activated. For more information about the valid values of this parameter, see RegionID parameter. Note Set this parameter to the ID of the region that is in proximity to your applications.

Response parameters


Parameter	Type	Example	Description
LogicDatabase	Object		The details about the logical database.
DatabaseId	String	1***	The ID of the logical database.
OwnerIdList	Array of String	51****	The IDs of the owners of the logical database.
DbType	String	polardb	The type of the database. For more information about the valid values of the DbType parameter, see DbType parameter.
OwnerNameList	Array of String	owner_name	The names of the owners of the logical database.
Logic	Boolean	true	Indicates whether the database is a logical database. The return value is true.
SchemaName	String	test_logic_db	The name of the logical database.
SearchName	String	test_logic_db[test_logic_alias]	The name that is used to search for the logical database.
EnvType	String	dev	The type of the environment to which the database belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: SIT environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment
Alias	String	test_logic_alias	The alias of the logical database.
RequestId	String	90260530-565C-42B9-A6E8-893481FE6AB6	The ID of the request.
ErrorCode	String	UnknownError	The error code.
ErrorMessage	String	UnknownError	The error message.
Success	Boolean	true	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.

Examples

Sample requests

http(s)://dms-enterprise.aliyuncs.com/?Action=GetLogicDatabase
&Tid=3***
&DbId=1***
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetLogicDatabaseResponse>
    <LogicDatabase>
        <SearchName>test_logic_db [test_logic_alias]</SearchName>
        <Alias>test_logic_alias</Alias>
        <DatabaseId>1***</DatabaseId>
        <OwnerNameList>
            <OwnerNames>owner_name</OwnerNames>
        </OwnerNameList>
        <Logic>true</Logic>
        <DbType>polardb</DbType>
        <SchemaName>test_logic_db</SchemaName>
        <EnvType>dev</EnvType>
        <OwnerIdList>
            <OwnerIds>51****</OwnerIds>
        </OwnerIdList>
    </LogicDatabase>
    <RequestId>E057F5F6-298E-5A3D-B948-0E5328D56B54</RequestId>
    <Success>true</Success>
</GetLogicDatabaseResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "LogicDatabase" : {
    "SearchName" : "test_logic_db [test_logic_alias]",
    "Alias" : "test_logic_alias",
    "DatabaseId" : "1***",
    "OwnerNameList" : {
      "OwnerNames" : [ "owner_name" ]
    },
    "Logic" : true,
    "DbType" : "polardb",
    "SchemaName" : "test_logic_db",
    "EnvType" : "dev",
    "OwnerIdList" : {
      "OwnerIds" : [ "51****" ]
    }
  },
  "RequestId" : "E057F5F6-298E-5A3D-B948-0E5328D56B54",
  "Success" : true
}

Error codes

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