Update Elasticsearch tiers
https://api.elastic-cloud.com/api/v1
- PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/tiers
Updates the size and/or zone count of one or more Elasticsearch topology elements (tiers) within a Deployment.
Path Parameters
-
deployment_idstringrequired -
Identifier for the Deployment
-
ref_idstringrequired -
User-specified RefId for the Resource (or '_main' if there is only one)
Request
A map of tier IDs to their desired configuration
-
hot_contentTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
-
warmTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
-
coldTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
-
frozenTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
-
masterTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
-
coordinatingTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
-
mlTierConfig -
Desired configuration for an individual Elasticsearch tier
-
memory_sizeinteger -
The desired memory size in MB for this tier.
-
zone_countinteger -
The number of availability zones for this tier. If omitted, the current zone count is preserved.
Responses
The tier configuration was updated and a plan change was initiated.
-
idstringrequired -
The id of the deployment
-
namestringrequired -
The name of the deployment
-
aliasstring -
A user-defined alias to use in place of ResourceIds for user-friendly resource URLs
-
resourcesDeploymentResourcerequired -
List of resources that are part of the deployment after the update operation.
-
ref_idstringrequired -
A locally-unique friendly alias for this Elasticsearch cluster
-
elasticsearch_cluster_ref_idstring -
The Elasticsearch cluster that this resource depends on.
-
idstringrequired -
A system-unique id for the created resource
-
kindstringrequired -
The kind of resource
-
regionstringrequired -
Identifier of the region in which this resource runs.
-
cloud_idstring -
An encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana
-
credentialsClusterCredentials -
The username and password for the new Elasticsearch cluster, which is returned from the Elasticsearch cluster
createcommand. -
secret_tokenstring -
Secret token for using a created resource. Only provided on initial create and absent otherwise.
-
shutdown_resourcesOrphaned -
Details about orphaned resources.
-
elasticsearchOrphanedElasticsearchrequired -
List of orphaned Elasticsearch resources
-
idstringrequired -
The id of the orphaned resource
-
dependentsElasticsearchDependantrequired -
List of orphaned dependent resources
-
kibanastringrequired -
List of orphaned Kibana resource ids
-
apmstringrequired -
List of orphaned APM resource ids
-
appsearchstringrequired -
List of orphaned AppSearch resource ids
-
enterprise_searchstringrequired -
List of orphaned Enterprise Search resource ids
-
integrations_serverstringrequired -
List of orphaned Integrations Server resource ids
-
diagnosticsDeploymentDiagnostics -
Describes the diagnostics for a given Deployment-modifying payload
-
createsCreates -
Holds diagnostics for resources that will be created
-
elasticsearchElasticsearch -
Diagnostics for Elasticsearch clusters
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name for the cluster (defaults to the generated cluster id if not specified)
-
backend_planobjectrequired -
The backend plan as JSON
-
kibanaKibana -
Diagnostics for Kibanas
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
apmApm -
Diagnostics for APMs
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
integrations_serverIntegrationsServer -
Diagnostics for Integrations Server
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
appsearchAppSearch -
Diagnostics for AppSearches
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
enterprise_searchEnterpriseSearch -
Diagnostics for Enterprise Search resources
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
updatesUpdates -
Holds diagnostics for existing resources that might be updated
-
elasticsearchElasticsearch -
Diagnostics for Elasticsearch clusters
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name for the cluster (defaults to the generated cluster id if not specified)
-
backend_planobjectrequired -
The backend plan as JSON
-
kibanaKibana -
Diagnostics for Kibanas
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
apmApm -
Diagnostics for APMs
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
integrations_serverIntegrationsServer -
Diagnostics for Integrations Server
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
appsearchAppSearch -
Diagnostics for AppSearches
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
enterprise_searchEnterpriseSearch -
Diagnostics for Enterprise Search resources
-
ref_idstringrequired -
A locally-unique user-specified id
-
display_namestringrequired -
The human readable name (defaults to the generated cluster id if not specified)
-
elasticsearch_cluster_ref_idstringrequired -
The user-specified id of the Elasticsearch Cluster that this will link to
-
backend_planobjectrequired -
The backend plan as JSON
-
settingsDeploymentSettings -
Additional configuration about the current deployment object.
-
traffic_filter_settingsTrafficFilterSettings -
The configuration settings for the traffic filter.
-
rulesetsstringrequired -
IDs of the traffic filter rulesets
-
observabilityDeploymentObservabilitySettings -
The observability settings for a deployment
-
loggingDeploymentLoggingSettings -
The logging settings for a deployment
-
destinationObservabilityAbsoluteDeploymentrequired -
The destination to send logs and metrics to
-
deployment_idstringrequired -
The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
-
ref_idstring -
RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
-
metricsDeploymentMetricsSettings -
The metrics settings for a deployment
-
destinationObservabilityAbsoluteDeploymentrequired -
The destination to send logs and metrics to
-
deployment_idstringrequired -
The deployment to send logs and/or metrics to. Contains either the deployment's ID or 'self'.
-
ref_idstring -
RefId of the Elasticsearch cluster to send logs and/or metrics to. If not specified, refId is resolved automatically as long as the destination deployment contains a single Elasticsearch resource.
-
autoscaling_enabledboolean -
If autoscaling is enabled for this deployment.
-
auto_opsAutoOpsSettingsrequired -
AutoOps settings for this deployment.
-
status -
See AutoOps integration status for this deployment.
-
Values:
connectednot_connectedexcluded -
byokByokSettings -
Information required to create a Bring Your Own Key (BYOK) deployment.
-
key_resource_pathstringrequired -
Key path (i.e arn:aws:kms:us-east-1:1234567890:key/12345678-0000-0000-0000-000000000000).
-
solution_typestring -
An optional string that declares the deployment's expected application. Example supported values are: elasticsearch, observability, security.
- The Deployment specified by {deployment_id} cannot be found. (code:
deployments.deployment_not_found) - The Resource specified by {ref_id} cannot be found. (code:
deployments.deployment_resource_not_found) - One or more tier IDs in the request body are not valid for this deployment. (code:
deployments.tier_not_found)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response
We have failed you. (code: deployments.metadata_internal_error)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response