文档

DescribeDBClusterEndpoints - 查询PolarDB集群的地址信息

更新时间:

查询PolarDB集群的地址信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
polardb:DescribeDBClusterEndpointsRead
  • dbcluster
    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

请求参数

名称类型必填描述示例值
DBClusterIdstring

集群 ID。

说明 您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息,包括集群 ID。
pc-*************
DBEndpointIdstring

集群地址 ID。

pe-*************
DescribeTypestring

是否需要返回 ai 节点信息。

AI

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

2DC120BF-6EBA-4C63-BE99-B09F9E******
Itemsobject []

集群地址详情。

NodeWithRolesstring

目标连接地址下各节点的角色名称,其中主节点为 Writer;由于一个连接地址下可加入多个只读节点,因此每个只读节点的角色名称后会加上数字作为区分,如 Reader1Reader2,以此类推。

说明 仅 PolarDB PostgreSQL 版集群和 PolarDB PostgreSQL 版(兼容 Oracle)集群支持该参数。
Reader1
Nodesstring

连接地址配置的节点列表。

pi-***************,pi-***************
ReadWriteModestring

读写模式:

  • ReadWrite:可读可写(自动读写分离)。
  • ReadOnly:只读。
ReadOnly
AddressItemsobject []

连接串信息。

VSwitchIdstring

虚拟交换机 ID。

vsw-************
PrivateZoneConnectionStringstring

绑定的私有域名,

***.***.**.com
ConnectionStringstring

连接串。

********.rwlb.polardb-pg-public.rds.aliyuncs.com
NetTypestring

网络类型,取值范围如下:

  • Public:公网
  • Private:私网
  • Inner:经典网络

仅 PolarDB MySQL 版集群支持经典网络类型。

Private
Portstring

端口。

1521
VpcInstanceIdstring

VPC 实例 ID。

说明 仅 PolarDB MySQL 版集群会返回该参数。
pe-*************
VPCIdstring

专有网络 ID。

vpc-***************
IPAddressstring

IP 地址。

192.***.***.***
DBEndpointIdstring

连接地址 ID。

pe-*************
EndpointConfigstring

集群地址的高级配置。

  • DistributedTransaction:事务拆分状态,取值范围如下:

    • on:事务拆分已开启
    • off:事务拆分已关闭
  • ConsistLevel:会话一致性级别,取值范围如下:

    • 0:最终一致性
    • 1:会话一致性。
    • 2:全局一致性
  • LoadBalanceStrategy:负载均衡策略,基于负载的自动调度,取值固定为 load

  • MasterAcceptReads:主库是否接受读,取值范围如下:

    • on:主库接受读
    • off:主库不接受读
{\"DistributedTransaction\":\"off\",\"ConsistLevel\":\"0\",\"LoadBalanceStrategy\":\"load\",\"MasterAcceptReads\":\"on\"}
DBEndpointDescriptionstring

地址名称。

test
EndpointTypestring

集群地址类型:

  • Cluster:默认集群地址。
  • Primary:主地址。
  • Custom:自定义集群地址。
Custom
AutoAddNewNodesstring

新节点是否自动加入默认集群地址:

  • Enable
  • Disable
Enable
DBClusterIdstring

集群 ID。

pc-bp1s826a1up******

示例

正常返回示例

JSON格式

{
  "RequestId": "2DC120BF-6EBA-4C63-BE99-B09F9E******",
  "Items": [
    {
      "NodeWithRoles": "Reader1",
      "Nodes": "pi-***************,pi-***************",
      "ReadWriteMode": "ReadOnly",
      "AddressItems": [
        {
          "VSwitchId": "vsw-************",
          "PrivateZoneConnectionString": "***.***.**.com",
          "ConnectionString": "********.rwlb.polardb-pg-public.rds.aliyuncs.com",
          "NetType": "Private",
          "Port": "1521",
          "VpcInstanceId": "pe-*************",
          "VPCId": "vpc-***************",
          "IPAddress": "192.***.***.***"
        }
      ],
      "DBEndpointId": "pe-*************",
      "EndpointConfig": "{\\\"DistributedTransaction\\\":\\\"off\\\",\\\"ConsistLevel\\\":\\\"0\\\",\\\"LoadBalanceStrategy\\\":\\\"load\\\",\\\"MasterAcceptReads\\\":\\\"on\\\"}",
      "DBEndpointDescription": "test",
      "EndpointType": "Custom",
      "AutoAddNewNodes": "Enable",
      "DBClusterId": "pc-bp1s826a1up******"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的DBClusterId。
404InvalidDBClusterId.NotFoundThe DBClusterId provided does not exist in our records.当前的记录中不存在提供的 DBClusterId。
404InvalidDBClusterId.MalformedThe specified parameter DBClusterId is not valid.指定的参数DBClusterId无效

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

变更历史

变更时间变更内容概要操作
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更
2023-07-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DescribeType
2023-05-11OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
2022-07-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 404 变更