GetLogicDatabase API Reference for Logical Databases - Data Management - Alibaba Cloud - Data Management

Queries information about a logical database.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetLogicDatabase

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. Note To view the tenant ID, hover over the profile picture in the upper-right corner of the Data Management (DMS) console. 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 this ID.	1***

Response elements

Element	Type	Description	Example
	object
LogicDatabase	object	The details of the logical database.
DatabaseId	string	The ID of the logical database.	1***
OwnerIdList	object
OwnerIds	array	The IDs of the owners of the logical database.
	string	The ID of the owner of the logical database.	51****
DbType	string	The database engine. For valid values, see DbType parameter.	PolarDB
OwnerNameList	object
OwnerNames	array	The names of the owners of the logical database.
	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 used to search for the logical database.	test_logic_db[test_logic_alias]
EnvType	string	The environment type of the database. 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	object
DatabaseIds	array	The IDs of database shards of the logical database.
	integer	The ID of the database shard of the logical database.	12****
RequestId	string	The request ID.	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

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.