调用GetNodeConfig获取节点配置信息_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取节点配置信息。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/node-config

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:GetNodeConfig	get	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

GET /openapi/ha3/instances/{instanceId}/node-config HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	ha-cn-pl32rf0****
type	string	否	节点类型 qrs：查询节点 search：数据节点 index：索引节点 cluster：集群	index
name	string	否	节点名称	ha-cn-30174dhoz53_qrs
clusterName	string	否	集群名称	vpc_sh_domain_2

请求示例

GET /openapi/ha3/instances/{instanceId}/node-config?type=qrs&name=test&

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	2AE63638-5420-56DC-BF59-37D8174039A0
result	object	返回结果
dataFragmentNumber	integer	数据分片数	1
dataDuplicateNumber	integer	数据副本数	1
minServicePercent	integer	最小服务比例	50
published	boolean	集群是否挂载	true
active	boolean	在线生效（索引是否从在线下掉）	true
flowRatio	integer	流量比例	100

返回示例

正确返回

{

  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",

  "result": {

    "dataFragmentNumber":1,

    "dataDuplicateNumber":1,

    "minServicePercent":20,

    "published":true,

    "active": true  // 在线是否生效

  }

}

示例

正常返回示例

JSON格式

{
  "requestId": "2AE63638-5420-56DC-BF59-37D8174039A0",
  "result": {
    "dataFragmentNumber": 1,
    "dataDuplicateNumber": 1,
    "minServicePercent": 50,
    "published": true,
    "active": true,
    "flowRatio": 100
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-03-20	OpenAPI 返回结构发生变更	查看变更详情
2023-08-28	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-01-12	新增 OpenAPI	查看变更详情