DescribeDrdsDB - PolarDB - Alibaba Cloud Documentation Center

Queries the details of a database in an instance by calling the DescribeDrdsDB 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:DescribeDrdsDB

get

*instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drds*********
DbName	string	Yes	The database name.	db_test

Response elements

Element	Type	Description	Example
	object
Success	boolean	The result of the request.	true
RequestId	string	The request ID.	58FB0EC7-CF71-4E48-92FB-CF070D******
Data	object	The database details.
Status	string	The database status. Valid values: TO_BE_INIT: Being created. NORMAL: Running.	NORMAL
DbName	string	The database name.	db_test
Schema	string	The physical name of the database.	db_test*******************
CreateTime	string	The time when the database was created. The value is a UNIX timestamp in milliseconds (ms).	1602050276000
Mode	string	The partitioning mode of the database. Valid values: HORIZONTAL: horizontal partitioning VERTICAL: vertical partitioning.	HORIZONTAL
DbInstType	string	The storage type of the database.	RDS
InstRole	string	The type of the instance to which the database belongs. Valid values: MASTER: primary instance SLAVE: read-only instance.	MASTER

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "58FB0EC7-CF71-4E48-92FB-CF070D******",
  "Data": {
    "Status": "NORMAL",
    "DbName": "db_test",
    "Schema": "db_test*******************",
    "CreateTime": "1602050276000",
    "Mode": "HORIZONTAL",
    "DbInstType": "RDS",
    "InstRole": "MASTER"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDbName.NotFound	The Drds DbName provided does not exist in our records.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.