DescribeDrdsDBs - PolarDB - Alibaba Cloud Documentation Center

Queries the details of databases in a specified instance by calling the DescribeDrdsDBs 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

drds:DescribeDrdsDBs

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drdshbga1138****
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
RegionId	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
PageSize	string	The number of entries per page.	30
PageNumber	string	The page number.	1
RequestId	string	The request ID.	006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T
Total	string	The total number of databases.	1
Success	boolean	Indicates whether the request was successful.	true
Data	object
Db	array<object>	The list of databases.
	object
Status	string	The state of the database.	NORMAL
DbName	string	The name of the database.	drds_test
Schema	string	The schema ID that is assigned to the partitioned database.	drds_test_1563773871118kxqd
CreateTime	string	The time when the database is created. The value of this parameter is a UNIX timestamp. Unit: ms.	1563773824000
Mode	string	The partitioning mode of the database. Valid values: HORIZONTAL: The database is horizontally partitioned. VERTICAL: The database is vertically partitioned.	HORIZONTAL
DbInstType	string	The type of the database. Valid values: RDS and POLARDB.	RDS

Examples

Success response

JSON format

{
  "PageSize": "30",
  "PageNumber": "1",
  "RequestId": "006B7D19-8CDB-4AA6-AAE7-23C107GS3W2T",
  "Total": "1",
  "Success": true,
  "Data": {
    "Db": [
      {
        "Status": "NORMAL",
        "DbName": "drds_test",
        "Schema": "drds_test_1563773871118kxqd",
        "CreateTime": "1563773824000",
        "Mode": "HORIZONTAL",
        "DbInstType": "RDS"
      }
    ]
  }
}

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.