Modifying Cluster Parameters
Function
This API is used to modify the parameter settings of a cluster.
URI
POST /v1.0/{project_id}/clusters/{cluster_id}/ymls/update
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID and name, see Obtaining a Project ID and Name. |
cluster_id |
Yes |
String |
ID of the cluster whose parameter settings you want to be modify. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
edit |
Yes |
UpdateYmlsReqEdit object |
Configuration file information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
modify |
Yes |
UpdateYmlsReqEditModify object |
Operations on the configuration file.
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
acknowledged |
Boolean |
Whether the modification is successful.
|
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
{ "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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.