Set settings overrides (all instances)edit
Overrides the settings for all of the instances in the Elasticsearch cluster.
Requestedit
PUT /api/v1/clusters/elasticsearch/{cluster_id}/instances/settings
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
After overrides are applied, restarts the instances. |
Request bodyedit
(ElasticsearchClusterInstanceSettingsOverrides) (required) The settings to override for the instances
Responsesedit
-
200 -
(
ElasticsearchClusterInstanceSettingsOverrides) Returns the updated settings overrides for the specified instances -
404 -
(
BasicFailedReply) The cluster specified at {cluster_id} could not be found. (code:clusters.cluster_not_found)Headers
-
x-cloud-error-codes(string; allowed values: [clusters.cluster_not_found]) - The error codes associated with the response
-
-
449 -
(
BasicFailedReply) Elevated permissions are required. (code:root.unauthorized.rbac.elevated_permissions_required)Headers
-
x-cloud-error-codes(string; allowed values: [root.unauthorized.rbac.elevated_permissions_required]) - The error codes associated with the response
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/instances/settings \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
"instance_capacity" : 0,
"storage_multiplier" : 0.1
}
'