DescribeDBClusterEndpoints
该接口用于查询POLARDB集群的地址信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 否 | DescribeDBClusterEndpoints |
系统规定参数,取值:DescribeDBClusterEndpoints。 |
DBClusterId | String | 是 | pc-xxxxxxxxxx |
集群ID。 |
DBEndpointId | String | 否 | pe-xxxxxxxx |
集群地址ID。例如pe-xxxxxxxx。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | ABA96273-606B-4616-9394-336A06312713 |
请求ID。 |
Items | Array |
集群地址ID。 |
|
DBEndpointId | String | pe-xxxxxxxxxx |
地址ID。 |
EndpointType | String | Cluster |
集群地址类型:
|
Nodes | String | pi-xxxxxxxxxx,pi-xxxxxxxxxx |
连接地址配置的节点列表。 |
ReadWriteMode | String | ReadWrite |
读写模式:
|
AutoAddNewNodes | String | Enable |
新节点是否自动加入默认集群地址:
|
EndpointConfig | String | {\"DistributedTransaction\":\"off\",\"TrackLSNPerTab\":\"on\",\"ConsistLevel\":\"1\",\"StrictSPCalls\":\"on\",\"CausalConsistRead\":\"1\",\"StrictMultiStmt\":\"on\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\" |
集群地址的高级配置。
|
AddressItems | Array |
连接串信息。 |
|
ConnectionString | String | pc-xxxxxxxxxx.w.polardb.cn-qd-pldb1.rds.aliyuncs.com |
连接串。 |
IPAddress | String | 172.xx.xx.xx |
IP地址。 |
NetType | String | Private |
IP 网络类型:
|
Port | String | 3306 |
端口。 |
VPCId | String | vpc-xxxxxxxxxx |
专有网络ID。 |
VSwitchId | String | vsw-xxxxxxxxxx |
虚拟交换机ID。 |
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeDBClusterEndpoints
&DBClusterId=pc-xxxxxxxxxx
&<公共请求参数>
正常返回示例
XML
格式
<Items>
<EndpointType>Cluster</EndpointType>
<AutoAddNewNodes>Enable</AutoAddNewNodes>
<ReadWriteMode>ReadWrite</ReadWriteMode>
<AddressItems>
<Port>3306</Port>
<ConnectionString>pc-bpxxxxxxxx.rwlb.rds.aliyuncs.com</ConnectionString>
<VPCId>vpc-bpxxxxxxxx</VPCId>
<IPAddress>192.168.xx.xxx</IPAddress>
<NetType>Private</NetType>
<VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
</AddressItems>
<Nodes>pi-bpxxxxxxxx,pi-bpxxxxxxxx</Nodes>
<DBEndpointId>pe-bpxxxxxxxx</DBEndpointId>
<EndpointConfig>{"DistributedTransaction":"off","TrackLSNPerTab":"on","ConsistLevel":"1","StrictSPCalls":"on","CausalConsistRead":"1","StrictMultiStmt":"on","LoadBalanceStrategy":"load","MasterAcceptReads":"on"}</EndpointConfig>
</Items>
<Items>
<EndpointType>Primary</EndpointType>
<AddressItems>
<Port>3306</Port>
<ConnectionString>pc-bpxxxxxxxx.mysql.polardb.rds.aliyuncs.com</ConnectionString>
<VPCId>vpc-bpxxxxxxxx</VPCId>
<IPAddress>192.168.xx.xxx</IPAddress>
<NetType>Private</NetType>
<VSwitchId>vsw-bpxxxxxxxx</VSwitchId>
</AddressItems>
<Nodes>pi-bpxxxxxxxx</Nodes>
<DBEndpointId>pe-bpxxxxxxxx</DBEndpointId>
<EndpointConfig>{}</EndpointConfig>
</Items>
<RequestId>0E6CDE6C-107C-48C0-8995-BA976DF558A2</RequestId>
JSON
格式
{
"Items": [
{
"EndpointType": "Cluster",
"AutoAddNewNodes": "Enable",
"ReadWriteMode": "ReadWrite",
"AddressItems": [
{
"Port": "3306",
"ConnectionString": "pc-bpxxxxxxxx.rwlb.rds.aliyuncs.com",
"VPCId": "vpc-bpxxxxxxxx",
"IPAddress": "192.168.xx.xxx",
"NetType": "Private",
"VSwitchId": "vsw-bpxxxxxxxx"
}
],
"Nodes": "pi-bpxxxxxxxx,pi-bpxxxxxxxx",
"DBEndpointId": "pe-bpxxxxxxxx",
"EndpointConfig": "{\"DistributedTransaction\":\"off\",\"TrackLSNPerTab\":\"on\",\"ConsistLevel\":\"1\",\"StrictSPCalls\":\"on\",\"CausalConsistRead\":\"1\",\"StrictMultiStmt\":\"on\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}"
},
{
"EndpointType": "Primary",
"AddressItems": [
{
"Port": "3306",
"ConnectionString": "pc-bpxxxxxxxx.mysql.polardb.rds.aliyuncs.com",
"VPCId": "vpc-bpxxxxxxxx",
"IPAddress": "192.168.xx.xxx",
"NetType": "Private",
"VSwitchId": "vsw-bpxxxxxxxx"
}
],
"Nodes": "pi-bpxxxxxxxx",
"DBEndpointId": "pe-bpxxxxxxxx",
"EndpointConfig": "{}"
}
],
"RequestId": "0E6CDE6C-107C-48C0-8995-BA976DF558A2"
}
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论