GetLogicDatabase - Data Management - Alibaba Cloud Documentation Center

Queries the details of a logical database.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	No	The ID of the tenant. Note To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see View information about the current tenant.	3***
DbId	string	Yes	The ID of the logical database. You can call the ListLogicDatabases or SearchDatabase operation to obtain the ID of the logical database.	1***

Response parameters

Parameter	Type	Description	Example
	object
LogicDatabase	object	The details of the logical database.
DatabaseId	string	The ID of the logical database.	1***
OwnerIdList	array	The IDs of the owners of the logical database.
OwnerIds	string	The ID of the owner of the logical database.	51****
DbType	string	The database engine. For more information about the valid values of the DbType parameter, see DbType parameter.	POLARDB
OwnerNameList	array	The names of the owners of the logical database.
OwnerNames	string	The names of the owners of the logical database.	owner_name
Logic	boolean	Indicates whether the database is a logical database. The return value is true.	true
SchemaName	string	The name of the logical database.	test_logic_db
SearchName	string	The name that is used to search for the logical database.	test_logic_db[test_logic_alias]
EnvType	string	The type of the environment to which the database belongs. Valid values: product: production environment dev: development environment pre: pre-release environment test: test environment sit: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: staging environment	dev
Alias	string	The alias of the logical database.	test_logic_alias
DatabaseIds	array	The IDs of database shards of the logical database.
DatabaseIds	long	The ID of the database shard of the logical database.	12****
RequestId	string	The ID of the request.	90260530-565C-42B9-A6E8-893481FE6AB6
ErrorCode	string	The status code.	UnknownError
ErrorMessage	string	The error message.	UnknownError
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

{
  "LogicDatabase": {
    "DatabaseId": "1***",
    "OwnerIdList": {
      "OwnerIds": [
        "51****"
      ]
    },
    "DbType": "POLARDB",
    "OwnerNameList": {
      "OwnerNames": [
        "owner_name"
      ]
    },
    "Logic": true,
    "SchemaName": "test_logic_db",
    "SearchName": "test_logic_db[test_logic_alias]",
    "EnvType": "dev",
    "Alias": "test_logic_alias",
    "DatabaseIds": {
      "DatabaseIds": [
        0
      ]
    }
  },
  "RequestId": "90260530-565C-42B9-A6E8-893481FE6AB6",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history