获取AnalyticDB PostgreSQL版实例的节点详情。
接口说明
本接口用于查看 AnalyticDB PostgreSQL 版实例的协调节点与计算节点分布与状态。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| gpdb:DescribeDBInstanceDiagnosisSummary | Read |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。
| gp-bp12ga6v69h86**** |
| PageSize | integer | 否 | 每页记录数，取值说明：
默认值：30。 | 30 |
| PageNumber | integer | 否 | 页码，大于 0 且不超过 Integer 的最大值，默认值：1。 | 1 |
| StartStatus | string | 否 | 节点运行状态，取值如下：
如果不填，则返回所有运行状态的信息。 | UP |
| SyncMode | string | 否 | 节点同步状态，取值如下：
如果不填，则返回所有同步状态的信息。 | synced |
| RolePreferd | string | 否 | 节点的角色状态，即是否发生主备切换，取值如下：
| normal |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "070534EC-78D5-5519-83CC-E7B1A9213483",
"TotalCount": "6",
"PageNumber": "1",
"Items": [
{
"Hostname": "gp-t4np568qe9710****-master-100984919",
"NodeAddress": "192.168.XX.XX",
"NodeType": "master",
"NodeName": "ap-southeast-1.i-t4n4c4ryr0yr441d****",
"NodePort": "3000",
"NodeID": "1",
"NodeStatus": "UP",
"NodeRole": "primary",
"NodePreferredRole": "primary",
"NodeReplicationMode": "Synced",
"NodeCID": "-1"
}
],
"MasterStatusInfo": {
"NormalNodeNum": 2,
"ExceptionNodeNum": 0,
"NotSyncingNodeNum": 0,
"SyncedNodeNum": 1,
"PreferredNodeNum": 2,
"NotPreferredNodeNum": 0
},
"SegmentStatusInfo": {
"NormalNodeNum": 4,
"ExceptionNodeNum": 0,
"NotSyncingNodeNum": 4,
"SyncedNodeNum": 0,
"PreferredNodeNum": 4,
"NotPreferredNodeNum": 0
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史