Modifying Cluster Parameters

Updated on 2025-05-22 GMT+08:00

View PDF

Function

This API is used to modify the parameter settings of a cluster.

NOTE:

Set the values of any custom parameters to those that are supported by Elasticsearch. Otherwise, the cluster will fail to be restarted. Exercise caution when performing this operation.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name.
cluster_id	Yes	String	ID of the cluster whose parameter settings you want to be modify.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
edit	Yes	UpdateYmlsReqEdit object	Configuration file information.

**Table 3** UpdateYmlsReqEdit
Parameter	Mandatory	Type	Description
modify	Yes	UpdateYmlsReqEditModify object	Operations on the configuration file. modify: Modify parameter settings. delete: Delete parameter settings. reset: Reset parameter settings.

**Table 4** UpdateYmlsReqEditModify
Parameter	Mandatory	Type	Description
elasticsearch.yml	Yes	Object	Parameter configuration list. The value is the JSON data you want to modify.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
acknowledged	Boolean	Whether the modification is successful. true: The modification succeeded. false: The modification failed.
externalMessage	String	Error message. If acknowledged was set to true, null is returned for this field.
httpErrorResponse	String	HTTP error information. The default value is null.

Example Requests

Modify parameter settings.

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

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

Example Responses

Status code: 200

Request succeeded.

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

Status Codes


Status Code	Description
200	Request succeeded.
400	Invalid request. Modify the request before retry.
409	The request could not be completed due to a conflict with the current state of the resource. The resource that the client attempts to create already exists, or the update request fails to be processed because of a conflict.
412	The server did not meet one of the preconditions contained in the request.