调用DescribeDrdsDBCluster接口查询DRDS逻辑库下PolarDB集群具体信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDrdsDBCluster

系统规定参数。取值为DescribeDrdsDBCluster。

DbInstanceId String 是 pc-*****************

PolarDB集群ID。
DbName String 是 drds_test

DRDS数据库名称。
DrdsInstanceId String 是 drds*********

DRDS实例ID。

返回数据

名称 类型 示例值 描述
DbInstance Struct

PolarDB的实例信息。
DBInstanceId String pc-*****************

PolarDB集群ID。
DBInstanceStatus String 1

PolarDB实例状态。
DBNodes Array

PolarDB集群中的节点信息。
DBNode
DBNodeId String pi-***************

PolarDB集群中节点的ID。
DBNodeRole String Reader

PolarDB集群中节点的角色，取值范围如下：

  • Reader
  • Writer
DBNodeStatus String Running

PolarDB集群节点的状态。
ZoneId String cn-hangzhou-i

PolarDB集群节点的可用区ID。
DbInstType String POLARDB

DRDS数据库存储类型。
Endpoints Array

DRDS管理的PolarDB读写分离连接地址。
Endpoint
EndpointId String pe-*****************

PolarDB连接地址ID。
NodeIds String pi-*****************,pi-*****************

PolarDB连接地址下的节点ID列表，多个节点间用英文逗号（,）隔开。
ReadWeight Integer 85

DRDS数据库管理的该连接地址的读比例。
Engine String POLARDB

DRDS数据库存储引擎类型。
EngineVersion String 8.0

DRDS数据库存储引擎版本。
ExpireTime String 2019-09-27 11:22:33

PolarDB实例过期时间。
NetworkType String VPC

PolarDB实例网络类型。
PayType String Postpaid

PolarDB实例购买类型。
Port Integer 3306

PolarDB访问端口。
RdsInstType String ignore

RDS实例类型，PolarDB集群不支持该参数。
ReadMode String CUSTOM

数据库存储类型为PolarDB时，DRDS的读流量配置模式。

取值范围如下：

  • DEFAULT： 默认模式（即读流量全部发往PolarDB读写节点）。
  • CUSTOM： 用户自定义模式（即您可以自定义流量发往读写节点和只读节点的配比）。
  • BALANCE：读均衡模式（读流量由PolarDB集群的读负载模块自动分配，也可以理解为读流量均衡分配到各个节点）。
RemainDays String 0

PolarDB实例剩余天数。
RequestId String 60A77FD6-0DE4-4A34-B6FB-9C2673******

请求ID。
Success Boolean true

请求结果。

示例

请求示例

http(s)://drds.aliyuncs.com/?Action=DescribeDrdsDBCluster
&DbInstanceId=pc-*****************
&DbName=test
&DrdsInstanceId=drds*********
&<公共请求参数>

正常返回示例

XML 格式 

<RequestId>60A77FD6-0DE4-4A34-B6FB-9C2673******</RequestId>
<DbInstance>
    <DbInstType>POLARDB</DbInstType>
    <EngineVersion>8.0</EngineVersion>
    <DBInstanceStatus>1</DBInstanceStatus>
    <Port>3306</Port>
    <PayType>Postpaid</PayType>
    <Endpoints>
        <Endpoint>
            <ReadWeight>85</ReadWeight>
            <NodeIds>pi-*****************</NodeIds>
            <EndpointId>pc-*****************</EndpointId>
        </Endpoint>
        <Endpoint>
            <ReadWeight>15</ReadWeight>
            <NodeIds>pi-*****************,pi-*****************</NodeIds>
            <EndpointId>pe-*****************</EndpointId>
        </Endpoint>
    </Endpoints>
    <DBInstanceId>pc-*****************</DBInstanceId>
    <DBNodes>
        <DBNode>
            <DBNodeStatus>Running</DBNodeStatus>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Reader</DBNodeRole>
            <DBNodeId>pi-*****************</DBNodeId>
        </DBNode>
        <DBNode>
            <DBNodeStatus>Running</DBNodeStatus>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Writer</DBNodeRole>
            <DBNodeId>pi-*****************</DBNodeId>
        </DBNode>
        <DBNode>
            <DBNodeStatus>Running</DBNodeStatus>
            <ZoneId>cn-hangzhou-i</ZoneId>
            <DBNodeRole>Reader</DBNodeRole>
            <DBNodeId>pi-*****************</DBNodeId>
        </DBNode>
    </DBNodes>
    <NetworkType>VPC</NetworkType>
    <ReadMode>CUSTOM</ReadMode>
    <ExpireTime/>
    <RemainDays>0</RemainDays>
    <Engine>POLARDB</Engine>
</DbInstance>
<Success>true</Success>

JSON 格式 

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

错误码

访问错误中心查看更多错误码。