Get Elasticsearch tiers

Auth

Retrieves the current memory size, zone count, and available sizes for all enabled Elasticsearch tiers in a Deployment. Disabled tiers are excluded.

Path parameters

deployment_id string required

Identifier for the Deployment

ref_id string required

User-specified RefId for the Resource (or '_main' if there is only one)

Responses

The size configuration of all enabled Elasticsearch tiers

application/json
hot_content object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

warm object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

cold object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

frozen object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

master object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

coordinating object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

ml object

Current configuration of an individual Elasticsearch tier

memory_size integer · format: int32

The memory size in MB for this tier.

zone_count integer · format: int32

The number of availability zones for this tier.

available_sizes integer[] · format: int32

Discrete memory sizes in MB from this tier's instance configuration. Sizes up to the allowed multiple of the maximum discrete size may also be valid.

  • The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
  • The Elasticsearch Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)
application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response