查询 DRDS 逻辑库下 PolarDB 集群具体信息

调试

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

请求参数

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

系统规定参数，取值：DescribeDrdsDBCluster
DbInstanceId String 是 pc-bp1qi24qs6jb53bi3

PolarDB 集群 ID
DbName String 是 drds_test

DRDS 数据库名
DrdsInstanceId String 是 drdssen1243as

DRDS 实例 ID
AccessKeyId String 否 ASsfdjkDFhshd723

Access Key

返回数据

名称 类型 示例值 描述
DbInstance

PolarDB 的实例信息
DBInstanceId String pc-bp1qi24qs6jb53bi3

PolarDB 集群 ID
DBInstanceStatus String 1

PolarDB 实例状态
DBNodes

PolarDB 集群中的节点信息
DBNode

PolarDB 集群中的节点信息
DBNodeId String pi-bp1346l7u2735393t

PolarDB 集群中节点 ID
DBNodeRole String Writer

PolarDB 集群节点角色
DBNodeStatus String Running

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

PolarDB 集群节点地区
DbInstType String POLARDB

DRDS 数据库类型
Endpoints

DRDS 管理的 PolarDB 读写分离 endpoints
Endpoint

DRDS 管理的 PolarDB 读写分离 endpoints
EndpointId String pe-bp1rlxn22qgh845un

PolarDB endpoint ID
NodeIds String pi-bp1hlua0p66jn1u80,pi-bp1zcdcsrzwo5dn14

PolarDB endpoint 下的节点 ID 列表
ReadWeight Integer 100

DRDS 数据库管理的该 endpoint 的读比例
Engine String POLARDB

DRDS 数据库存储实例类型
EngineVersion String 5.6

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 实例不使用
RemainDays String 0

PolarDB 实例剩余天数
RequestId String 4B20DB3B-9414-4425-A335-F47C708DA3AC

请求 ID
Success Boolean true

是否成功

示例

请求示例


http(s)://[Endpoint]/?Action=DescribeDrdsDBCluster
&DbInstanceId=pc-bp1qi24qs6jb53bi3
&DbName=drds_test
&DrdsInstanceId=drdssen1243as
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeDrdsDBCluster>
      <DbInstance>
            <RemainDays>0</RemainDays>
            <DBInstanceId>pc-bp1qi24qs6jb53bi3</DBInstanceId>
            <DbInstType>POLARDB</DbInstType>
            <Engine>POLARDB</Engine>
            <NetworkType>VPC</NetworkType>
            <Port>3306</Port>
            <Endpoints>
                  <Endpoint>
                        <EndpointId>pc-bp1qi24qs6jb53bi3</EndpointId>
                        <NodeIds>pi-bp1346l7u2735393t</NodeIds>
                        <ReadWeight>0</ReadWeight>
                  </Endpoint>
                  <Endpoint>
                        <EndpointId>pe-bp1rlxn22qgh845un</EndpointId>
                        <NodeIds>pi-bp1hlua0p66jn1u80,pi-bp1zcdcsrzwo5dn14</NodeIds>
                        <ReadWeight>100</ReadWeight>
                  </Endpoint>
            </Endpoints>
            <EngineVersion>5.6</EngineVersion>
            <DBNodes>
                  <DBNode>
                        <DBNodeRole>Writer</DBNodeRole>
                        <DBNodeStatus>Running</DBNodeStatus>
                        <ZoneId>cn-hangzhou-g</ZoneId>
                        <DBNodeId>pi-bp1346l7u2735393t</DBNodeId>
                  </DBNode>
                  <DBNode>
                        <DBNodeRole>Reader</DBNodeRole>
                        <DBNodeStatus>Running</DBNodeStatus>
                        <ZoneId>cn-hangzhou-g</ZoneId>
                        <DBNodeId>pi-bp1hlua0p66jn1u80</DBNodeId>
                  </DBNode>
                  <DBNode>
                        <DBNodeRole>Reader</DBNodeRole>
                        <DBNodeStatus>Running</DBNodeStatus>
                        <ZoneId>cn-hangzhou-g</ZoneId>
                        <DBNodeId>pi-bp1zcdcsrzwo5dn14</DBNodeId>
                  </DBNode>
            </DBNodes>
            <DBInstanceStatus>1</DBInstanceStatus>
            <PayType>Postpaid</PayType>
      </DbInstance>
      <RequestId>03F61B01-4DD6-4335-9D90-8F8A4A012977</RequestId>
      <Success>true</Success>
</DescribeDrdsDBCluster>

JSON 格式 

{
	"DbInstance":{
		"RemainDays":0,
		"NetworkType":"VPC",
		"Port":3306,
		"Endpoints":{
			"Endpoint":[
				{
					"EndpointId":"pc-bp1qi24qs6jb53bi3",
					"NodeIds":"pi-bp1346l7u2735393t",
					"ReadWeight":0
				},
				{
					"EndpointId":"pe-bp1rlxn22qgh845un",
					"NodeIds":"pi-bp1hlua0p66jn1u80,pi-bp1zcdcsrzwo5dn14",
					"ReadWeight":100
				}
			]
		},
		"DBInstanceId":"pc-bp1qi24qs6jb53bi3",
		"DbInstType":"POLARDB",
		"DBNodes":{
			"DBNode":[
				{
					"DBNodeRole":"Writer",
					"DBNodeStatus":"Running",
					"ZoneId":"cn-hangzhou-g",
					"DBNodeId":"pi-bp1346l7u2735393t"
				},
				{
					"DBNodeRole":"Reader",
					"DBNodeStatus":"Running",
					"ZoneId":"cn-hangzhou-g",
					"DBNodeId":"pi-bp1hlua0p66jn1u80"
				},
				{
					"DBNodeRole":"Reader",
					"DBNodeStatus":"Running",
					"ZoneId":"cn-hangzhou-g",
					"DBNodeId":"pi-bp1zcdcsrzwo5dn14"
				}
			]
		},
		"EngineVersion":"5.6",
		"DBInstanceStatus":1,
		"PayType":"Postpaid",
		"Engine":"POLARDB"
	},
	"RequestId":"03F61B01-4DD6-4335-9D90-8F8A4A012977",
	"Success":true
}

错误码

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