查询PolarDB集群的地址信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| polardb:DescribeDBClusterEndpoints | get | *dbcluster acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBClusterId | string | 是 | 集群 ID。
您可以通过 DescribeDBClusters 接口查看账号下所有集群的详细信息，包括集群 ID。
| pc-************* |
| DBEndpointId | string | 否 | 集群地址 ID。 | pe-************* |
| DescribeType | string | 否 | 是否需要返回 ai 节点信息。 | AI |
返回参数
示例
正常返回示例
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.***.***.***",
"DashboardUsed": true
}
],
"DBEndpointId": "pe-*************",
"EndpointConfig": "{\\\"DistributedTransaction\\\":\\\"off\\\",\\\"ConsistLevel\\\":\\\"0\\\",\\\"LoadBalanceStrategy\\\":\\\"load\\\",\\\"MasterAcceptReads\\\":\\\"on\\\"}",
"DBEndpointDescription": "test",
"EndpointType": "Custom",
"AutoAddNewNodes": "Enable",
"DBClusterId": "pc-bp1s826a1up******",
"SccMode": "on",
"PolarSccTimeoutAction": "0",
"PolarSccWaitTimeout": "100"
}
]
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的DBClusterId。 |
| 404 | InvalidDBClusterId.NotFound | The DBClusterId provided does not exist in our records. | 当前的记录中不存在提供的 DBClusterId。 |
| 404 | InvalidDBClusterId.Malformed | The specified parameter DBClusterId is not valid. | 指定的参数DBClusterId无效 |
访问错误中心查看更多错误码。
