文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 会话管理/ 查询关键视图下发节点信息
更新时间：2025-09-11 GMT+08:00
查看PDF
分享

查询关键视图下发节点信息

功能介绍

获取可以下发查询关键视图的节点信息。

接口约束

仅支持包含有CN或DN（主、备）组件的节点。

调试

您可以在API Explorer中调试该接口。

URI

POST /v3/{project_id}/instances/{instance_id}/key-view-execute-node

表1 参数说明

名称

是否必选

说明

project_id

是

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

instance_id

是

参数解释：

实例ID，此参数是用户创建实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

语言。

约束限制：

不涉及。

取值范围：

  • zh-cn
  • en-us

默认取值：

en-us。

响应参数

表3 响应Body参数

参数

参数类型

描述

nodes

Array of objects

参数解释：

节点信息列表，详细内容请参见表4。
表4 NodeList

参数

参数类型

描述

node_id

String

参数解释：

节点ID。

取值范围：

不涉及。

node_name

String

参数解释：

节点名称。

取值范围：

不涉及。

role

String

参数解释：

节点角色。

取值范围：

  • master：主节点。
  • slave：备节点。
  • secondary：日志节点。
  • readreplica：只读节点。

type

String

参数解释：

组件类型。

取值范围：

  • CN：CN组件。
  • DN：DN组件。

distributed_id

String

参数解释：

分布式ID。

取值范围：

不涉及。

component_id

String

参数解释：

组件ID。

取值范围：

不涉及。

detail

String

参数解释：

描述信息。

取值范围：

不涉及。

请求示例

查询关键视图下发节点信息。

POST https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/instances/3d39c18788b54a919bab633874c159dfin14/slow-sql-execute-node
{ 
}

响应示例

查询关键视图下发节点信息成功。 
{
    "nodes": [
        {
            "node_id": "3e5ff444e79e4703b77be19d6d993612no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5dn1_0",
            "role": "master",
            "type": "DN",
            "distributed_id": "60011",
            "component_id": "dn_6001",
            "detail": "Normal"
        },
        {
            "node_id": "833cbc8183264518879c966c418cdd92no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5dn1_1",
            "role": "slave",
            "type": "DN",
            "distributed_id": "60011",
            "component_id": "dn_6002",
            "detail": "Normal"
        },
        {
            "node_id": "b2c08b95d3264f85b66afb1751110f56no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5dn1_2",
            "role": "slave",
            "type": "DN",
            "distributed_id": "60011",
            "component_id": "dn_6003",
            "detail": "Normal"
        },
        {
            "node_id": "3763acd115da4209a7348e68260d3236no14",
            "node_name": "gauss-zzx-b8e7_gaussdbv5cn_0",
            "role": "master",
            "type": "CN",
            "distributed_id": "",
            "component_id": "cn_5001",
            "detail": ""
        }
    ]
}

状态码

错误码

请参见错误码。

父主题： 会话管理

相关文档