文档

DescribeDBInstanceDiagnosisSummary - 查看节点详情

更新时间:

获取AnalyticDB PostgreSQL版实例的节点详情。

接口说明

本接口用于查看 AnalyticDB PostgreSQL 版实例的协调节点与计算节点分布与状态。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-bp12ga6v69h86****
PageSizeinteger

每页记录数,取值说明:

  • 30
  • 50
  • 100

默认值:30

30
PageNumberinteger

页码,大于 0 且不超过 Integer 的最大值,默认值:1

1
StartStatusstring

节点运行状态,取值如下:

  • UP:节点运行中。
  • DOWN:节点故障。

如果不填,则返回所有运行状态的信息。

UP
SyncModestring

节点同步状态,取值如下:

  • synced:已同步。
  • notSyncing:未同步。

如果不填,则返回所有同步状态的信息。

synced
RolePreferdstring

节点的角色状态,即是否发生主备切换,取值如下:

  • normal:角色状态正常,即未发生主备切换。
  • reverse:角色反转,即发生了主备切换。
normal

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

070534EC-78D5-5519-83CC-E7B1A9213483
TotalCountstring

总记录数。

6
PageNumberstring

当前页码。

1
Itemsobject []

实例节点详情列表。

Hostnamestring

节点名称。

gp-t4np568qe9710****-master-100984919
NodeAddressstring

节点的 IP 地址。

192.168.XX.XX
NodeTypestring

节点类型,取值如下:

  • master:协调节点。
  • slave:备协调节点。
  • segment:计算节点。
master
NodeNamestring

节点所在的宿主名。

ap-southeast-1.i-t4n4c4ryr0yr441d****
NodePortstring

节点的端口号。

3000
NodeIDstring

节点 ID。

1
NodeStatusstring

节点运行状态,取值如下:

  • UP:节点运行中。
  • DOWN:节点故障。
UP
NodeRolestring

节点当前所属角色,取值如下:

  • primary:主节点。
  • mirror:副本节点。
primary
NodePreferredRolestring

节点最初所属角色,取值如下:

  • primary:主节点。
  • mirror:副本节点。

如果该参数值与 NodeRole 参数的值一致,表示没有发生过角色反转(主备切换);如果该参数值与 NodeRole 参数的值不一致,表示发生过角色反转。

primary
NodeReplicationModestring

节点数据同步状态,取值如下:

  • Synced:已同步。
  • Not Syncing:未同步。
  • No sync required:无需同步,仅协调节点会出现该模式。
Synced
NodeCIDstring

分组 ID。

-1
MasterStatusInfoobject

协调节点状态统计信息。

NormalNodeNuminteger

正常状态节点数量。

2
ExceptionNodeNuminteger

异常状态节点数量。

0
NotSyncingNodeNuminteger

未同步节点数量。

0
SyncedNodeNuminteger

已同步节点数量。

1
PreferredNodeNuminteger

正常角色节点数量。

2
NotPreferredNodeNuminteger

主从切换角色节点数量。

0
SegmentStatusInfoobject

计算节点状态统计信息。

NormalNodeNuminteger

正常状态节点数量。

4
ExceptionNodeNuminteger

异常状态节点数量。

0
NotSyncingNodeNuminteger

未同步节点数量。

4
SyncedNodeNuminteger

已同步节点数量。

0
PreferredNodeNuminteger

正常角色节点数量。

4
NotPreferredNodeNuminteger

主从切换角色节点数量。

0

示例

正常返回示例

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

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)