全部产品

智能开放搜索 OpenSearch：ModifyClusterOnlineConfig - 修改集群的在线配置信息

更新时间：Oct 16, 2024

修改集群的在线配置信息。

接口说明

方法

PUT

URI

/openapi/ha3/instances/{instanceId}/cluster-online-config

调试

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

授权信息

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

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

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

请求语法

PUT /openapi/ha3/instances/{instanceId}/cluster-online-config HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 id	ha-cn-pl32rf0****
body	object	否	请求体参数
config	object	否	配置信息
	integer	否	配置版本号	2
clusters	array	否	集群信息
cluster	string	否	集群列表。	[ "hz_pre_vpc_domain_1" ]

请求示例

PUT /openapi/ha3/instances/ha3_instance_name/cluster-online-config

{
    "advancedConfigVersionId": 2,
    "clusters": [
      "hz_pre_vpc_domain_1"
    ]
}

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID	E7B7D598-B080-5C8E-AA35-D43EC0D5F886
result	object	返回结果。	{}

返回示例

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

详情可参考响应结构

示例

正常返回示例

JSON格式

{
  "requestId": "E7B7D598-B080-5C8E-AA35-D43EC0D5F886",
  "result": {}
}

错误码

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