調用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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。