DescribeDbInstanceDbs - PolarDB - Alibaba Cloud Documentation Center

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

drds:DescribeDbInstanceDbs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds************
DbInstanceId	string	Yes	The ID of the instance to which the storage-layer database belongs.	pc-****************
AccountName	string	No	The name of the DRDS privileged account. If no privileged account exists, leave this parameter empty..	test
Password	string	No	The password of the DRDS privileged account. If no privileged account exists, leave this parameter empty..	pwd_111111
DbInstType	string	No	The database storage type. Valid values: POLARDB and RDS.	POLARDB

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E9F3D991-08DE-4B74-BE0E-06B809******
Success	boolean	The request result.	true
Total	string	The total number of databases.	1
Databases	object
Database	array<object>	The list of database details.
	object
Status	integer	Indicates the state of the storage-layer database. Valid values: 0: The database is being created. 1: The database is available. 3: The database is being deleted.	1
DbName	string	Indicates the name of a storage-layer database.	db_test
Description	string	Indicates the description of the storage-layer database.	test

Examples

Success response

JSON format

{
  "RequestId": "E9F3D991-08DE-4B74-BE0E-06B809******",
  "Success": true,
  "Total": "1",
  "Databases": {
    "Database": [
      {
        "Status": 1,
        "DbName": "db_test",
        "Description": "test"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	ActionUnauthorized	The specified action is not available for you
500	InternalError	The request processing has failed due to some unknown error.
404	InvalidDRDSInstanceId.NotFound	The DrdsInstanceId provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.