文档首页/ 云搜索服务 CSS/ API参考/ 参数配置接口/ 修改参数配置
更新时间：2024-10-17 GMT+08:00
查看PDF
分享

修改参数配置

功能介绍

该接口用于修改参数配置。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。获取方法请参见获取项目ID和名称。

cluster_id

是

String

指定修改参数配置的集群ID。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

edit

是

UpdateYmlsReqEdit object

配置文件信息。
表3 UpdateYmlsReqEdit

参数

是否必选

参数类型

描述

modify

是

UpdateYmlsReqEditModify object

配置文件操作。

  • modify: 修改参数配置。

  • delete: 删除参数配置。

  • reset: 重置参数配置。
表4 UpdateYmlsReqEditModify

参数

是否必选

参数类型

描述

elasticsearch.yml

是

Object

参数配置列表。值为需要修改的json数据。

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

acknowledged

Boolean

修改是否成功。

  • true: 修改成功。

  • false: 修改失败。

externalMessage

String

错误信息描述。当acknowledged为true时，该字段返回null。

httpErrorResponse

String

HTTP错误信息。默认为null。

请求示例

修改参数配置。

POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/ymls/update

{
  "edit" : {
    "modify" : {
      "elasticsearch.yml" : {
        "thread_pool.force_merge.size" : 1
      }
    }
  }
}

响应示例

状态码： 200

请求已成功。

{
  "acknowledged" : true,
  "externalMessage" : null,
  "httpErrorResponse" : null
}

状态码

状态码

描述

200

请求已成功。

400

非法请求。

建议直接修改该请求，不要重试该请求。

409

服务器在完成请求时发生冲突。

返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。

412

未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。

错误码

请参见错误码。

父主题： 参数配置接口