DescribeDrdsDBCluster - PolarDB - Alibaba Cloud Documentation Center

Queries the details of a PolarDB cluster in a DRDS logical database.

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:DescribeDrdsDBCluster

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID of the DRDS instance.	drds*********
DbName	string	Yes	The name of the DRDS database.	drds_test
DbInstanceId	string	Yes	The ID of the PolarDB cluster.	pc-*****************

Response elements

Element	Type	Description	Example
	object
Success	boolean	The result of the request.	true
RequestId	string	The request ID.	60A77FD6-0DE4-4A34-B6FB-9C2673******
DbInstance	object	The information about the PolarDB instance.
ExpireTime	string	The expiration time of the PolarDB instance.	2019-09-27 11:22:33
PayType	string	The billing method of the PolarDB instance.	Postpaid
DBInstanceStatus	string	The instance status of the PolarDB instance.	1
NetworkType	string	The network type of the PolarDB instance.	VPC
Port	integer	The access port of the PolarDB instance.	3306
EngineVersion	string	The database engine version of the DRDS database storage DPI engine.	8.0
RdsInstType	string	The RDS instance type. This parameter is not supported for PolarDB clusters.	ignore
RemainDays	string	The remaining days of the PolarDB instance.	0
DBInstanceId	string	The ID of the PolarDB cluster.	pc-*****************
DbInstType	string	The storage type of the DRDS database.	POLARDB
Engine	string	The storage engine type of the DRDS database.	POLARDB
ReadMode	string	The read traffic configuration mode of DRDS when the database storage type is PolarDB. Valid values: DEFAULT: Default mode. All read traffic is sent to the PolarDB read/write node. CUSTOM: Custom mode. You can customize the traffic ratio between the read/write node and read-only nodes. BALANCE: Read balancing mode. Read traffic is automatically distributed by the read load balancing module of the PolarDB cluster, which means read traffic is evenly distributed across all nodes.	CUSTOM
Endpoints	object
Endpoint	array<object>	The endpoint of the PolarDB read /write splitting endpoint
	object
ReadWeight	integer	The read ratio of this connection address managed by the DRDS database.	85
EndpointId	string	The ID of the PolarDB connection address.	pe-*****************
NodeIds	string	The ID list of the nodes in the PolarDB connection string. Separate multiple nodes with commas (,).	pi-***************,pi-***************
DBNodes	object
DBNode	array<object>	The information about the nodes in the PolarDB Cluster.
	object
DBNodeRole	string	The role of a node in the apsaradb for PolarDB cluster. Valid values: Reader Writer	Reader
ZoneId	string	The ID of the zone where the node of the PolarDB cluster resides.	cn-hangzhou-i
DBNodeId	string	The ID of the node in the apsaradb for PolarDB cluster.	pi-***************
DBNodeStatus	string	The status of the nodes in the PolarDB cluster.	Running

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "60A77FD6-0DE4-4A34-B6FB-9C2673******",
  "DbInstance": {
    "ExpireTime": "2019-09-27 11:22:33",
    "PayType": "Postpaid",
    "DBInstanceStatus": "1",
    "NetworkType": "VPC",
    "Port": 3306,
    "EngineVersion": "8.0",
    "RdsInstType": "ignore",
    "RemainDays": "0",
    "DBInstanceId": "pc-*****************",
    "DbInstType": "POLARDB",
    "Engine": "POLARDB",
    "ReadMode": "CUSTOM",
    "Endpoints": {
      "Endpoint": [
        {
          "ReadWeight": 85,
          "EndpointId": "pe-*****************",
          "NodeIds": "pi-*****************,pi-*****************"
        }
      ]
    },
    "DBNodes": {
      "DBNode": [
        {
          "DBNodeRole": "Reader",
          "ZoneId": "cn-hangzhou-i",
          "DBNodeId": "pi-***************",
          "DBNodeStatus": "Running"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.MasterDbInstanceRelease	The master db instance has been released
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.