Modifying Cluster Parameters

Function

The core configuration information of an Elasticsearch cluster is stored in the elasticsearch.yml file, while that of an OpenSearch cluster is stored in the opensearch.yml file. You can modify a cluster's configuration file for purposes like accelerating queries, modifying cross-domain access configuration, adjusting the internal cache size, and managing the task queue size.

Before calling this API, call the Obtaining the Parameter Configuration List API to verify the cluster's parameter settings, and modify them as required.

Constraints

Set the values of any custom parameters to those supported by Elasticsearch. Otherwise, the cluster may fail to restart. Exercise caution when performing this operation.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints: N/A Value range: Project ID of the account. Default value: N/A
cluster_id	Yes	String	Definition: ID of the cluster whose parameter settings you want to be modify. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints: N/A Value range: Cluster ID. Default value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
edit	Yes	UpdateYmlsReqEdit object	Definition: Configuration file information. Constraints: N/A
inst_type	No	String	Node type. KooSearch clusters contain different types of nodes. kos: search control node kos-doc: document parsing node

**Table 3** UpdateYmlsReqEdit
Parameter	Mandatory	Type	Description
modify	No	UpdateYmlsReqEditModify object	Definition: Modify parameter settings. Constraints: modify, delete, and reset: at least one of them will take effect, and each operation can only be used once each time. Cannot perform multiple operations on the same parameter at the same time.
delete	No	UpdateYmlsReqEditModify object	Definition: Delete custom parameter settings. Constraints: Irrelevant to the input parameter value. modify, delete, and reset: at least one of them will take effect, and each operation can be used only once. Cannot perform multiple operations on the same parameter at the same time.
reset	No	UpdateYmlsReqEditModify object	Definition: Reset parameter settings. Constraints: Irrelevant to the input parameter value. Custom parameters cannot be reset. modify, delete, and reset: at least one of them will take effect, and each operation can be used only once. Cannot perform multiple operations on the same parameter at the same time.

**Table 4** UpdateYmlsReqEditModify
Parameter	Mandatory	Type	Description
elasticsearch.yml	Yes	Object	Definition: Parameter configuration list. The value is the JSON data to be modified. Constraints: This parameter is also used for OpenSearch clusters.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
acknowledged	Boolean	Definition: Parameter settings modified successfully or not. Value range: true: The modification is successful. false: The modification fails.
externalMessage	String	Definition: Error description. Value range: If acknowledged was set to true, null is returned for this field.
httpErrorResponse	String	Definition: HTTP error information. The default value is null. Value range: N/A

Example Requests

Modify parameter settings.

POST https://{Endpoint}/v1.0/{project_id}/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
}

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.