List & Paginate Logical Databases via ListLogicDatabases API - Data Management - Alibaba Cloud - Data Management

Queries a paginated list of logical databases and their details.

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:ListLogicDatabases

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Tid	integer	No	The ID of the tenant. You can call the GetUserActiveTenant operation to query the tenant ID.	3***
PageNumber	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries to return on each page.	50

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of logical databases.	7
LogicDatabaseList	object
LogicDatabase	array<object>	The details of logical databases.
	array<object>	The details of logical databases.
DatabaseId	string	The ID of the logical database.	1***
OwnerIdList	object
OwnerIds	array	The IDs of the owners of the logical database.
	string	The owner ID of the logical database.	51****
DbType	string	The type of the logical database. For valid values, see DbType parameter.	POLARDB
OwnerNameList	object
OwnerNames	array	The names of the owners of the logical database.
	string	The name of the owner of the logical database.	owner_name
Logic	boolean	Whether the database is a logical database. Always returns true.	true
SchemaName	string	The name of the logical database.	logic_db
SearchName	string	The name that is used to search for the logical database. Note Do not use this parameter for business development. The format of the parameter value may change in later versions.	logic_db[logic_db_alias]
EnvType	string	The type of the environment to which the logical database belongs. Valid values: product: production environment dev: development environment pre: staging environment test: test environment sit: system integration testing (SIT) environment uat: user acceptance testing (UAT) environment pet: stress testing environment stag: STAG environment	test
Alias	string	The alias of the logical database.	logic_db_alias
DatabaseIds	object
DatabaseIds	array	The IDs of sub-databases in the logical database.
	integer	The ID of a sub-database in the logical database.	12****
RequestId	string	The ID of the request.	8068AF82-8A1A-592C-AC2E-6B75338BAB87
ErrorCode	string	The error code returned.	UnknownError
ErrorMessage	string	The error message returned.	UnknownError
Success	boolean	Whether the request was successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Success response

JSON format

{
  "TotalCount": 7,
  "LogicDatabaseList": {
    "LogicDatabase": [
      {
        "DatabaseId": "1***",
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "DbType": "POLARDB",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "Logic": true,
        "SchemaName": "logic_db",
        "SearchName": "logic_db[logic_db_alias]",
        "EnvType": "test",
        "Alias": "logic_db_alias",
        "DatabaseIds": {
          "DatabaseIds": [
            0
          ]
        }
      }
    ]
  },
  "RequestId": "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.