DescribeDbList - PolarDB - Alibaba Cloud Documentation Center

Queries the list of databases by calling the DescribeDbList operation.

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

polardbx:DescribeDbList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
DBInstanceName	string	Yes	The instance name.	pxc-********
DBName	string	No	The database name.	db_name

Response elements

Element	Type	Description	Example
	object
Message	string	The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.	Success
RequestId	string	The request ID.	C458B1E8-1683-3645-B154-6BA32080EEA
Success	boolean	Indicates whether the request is successful.	true
Data	array<object>	The list of databases.
	array<object>
DBName	string	The database name.	test
DBDescription	string	The database description.	test
DBInstanceName	string	The instance name.	pxc-********
CharacterSetName	string	The character set.	utf8mb4
Accounts	array<object>	The list of accounts.
	object
AccountPrivilege	string	The account privilege.	ReadWrite
AccountName	string	The account name.	root4test

Examples

Success response

JSON format

{
  "Message": "Success",
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Success": true,
  "Data": [
    {
      "DBName": "test",
      "DBDescription": "test",
      "DBInstanceName": "pxc-********",
      "CharacterSetName": "utf8mb4",
      "Accounts": [
        {
          "AccountPrivilege": "ReadWrite",
          "AccountName": "root4test"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.