DescribeDatabases-阿里云帮助中心

Operation description

Read-only API operation with synchronous responses (not processed asynchronously).
The data source is a direct connection to the instance (listDatabases), and no metadata is persisted. The response includes the system databases admin, local, and config, which are returned as-is without filtering. The control plane uses a short-term cache, so repeated calls within a short period may not return real-time results.
Supports cloud disk and local disk instances.
If the DBName (the database to which the account belongs) field in the account creation form is implemented as a drop-down list, this API operation serves as the data source. The local database must be filtered out from the drop-down list because the backend prohibits creating accounts in the local database, whereas the admin database can be retained.

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

dds:DescribeDatabases

get

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID.	dds-bp14bf67a76d****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	009D2572-6839-43C0-8D89-44DB46CBA2EA
Databases	object
Database	array	The list of databases.
	string	The list of databases.	admin

Examples

Success response

JSON format

{
  "RequestId": "009D2572-6839-43C0-8D89-44DB46CBA2EA",
  "Databases": {
    "Database": [
      "admin"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	ResponseEmptyError	The Response is empty, maybe server request timeout.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.