Optionally retrieve the specified config version of the IC (otherwise retrieves the latest/only version)
show_deletedboolean
If true, if the instance configuration has been marked for deletion it is still returned. Otherwise, instance configurations marked for deletion generate a 404
show_max_zonesboolean · default: false
If true, will populate the max_zones field of the instance configuration.
If the IC is configuration controlled, this field is the version either being read back (reads return the latest IC unless specified by the 'config_version' URL param), or the version to update. Cannot be used in creates. For unversioned IC reads it is left empty.
descriptionstring
Optional description for the instance configuration
instance_typeenum
The type of instance. For instance configurations where the type is specified in the 'id', the default value of 'instance_type' will be automatically inferred.
Node types (master, data) for the instance. For instance configurations where the type (and tier) is specified in the 'id', the default value of 'node_types' will be automatically inferred.
discrete_sizesobjectrequired
Instance sizes that are supported by the Elasticsearch instance, Kibana instance, or APM Server configuration.
sizesinteger[] · format: int32required
List of supported sizes
default_sizeinteger · format: int32
The default size
resourceenum
The unit that each size represents. If not specified, it will default to 'memory'.
Values:memorystorage
allocator_filterobject
The container for all of the allowed Elasticsearch queries. Specify only one property each time.
matchmapstring to object
<string>object
querystringrequired
The text/numeric/date to query for.
operatorstring
The operator flag can be set to or or and to control the boolean clauses (defaults to or).
minimum_should_matchinteger · format: int32
The minimum number of optional should clauses to match.
analyzerstring
The analyzer that will be used to perform the analysis process on the text. Defaults to the analyzer that was used to index the field.
match_allobject
A query that matches all documents.
match_noneobject
A query that doesn't match any documents.
termmapstring to object
<string>object
valuestringrequired
The exact value to query for.
boolobject
A query for documents that match boolean combinations of other queries.
Allows to specify how inner children matching affects score of the parent. Refer to the Elasticsearch documentation for details.
Values:avgsumminmaxnone
prefixmapstring to object
<string>object
valuestringrequired
The prefix to search for.
boostnumber · format: float
An optional boost value to apply to the query.
existsobject
Matches documents that have at least one non-null value in the original field.
fieldstringrequired
The field to check for non-null values in.
rangemapstring to object
<string>object
gtobject
Greater-than
gteobject
Greater-than or equal to
ltobject
Less-than
lteobject
Less-than or equal to.
boostnumber · format: float
An optional boost value to apply to the query.
formatstring
Formatted dates will be parsed using the format specified on the date field by default, but it can be overridden by passing the format parameter.
time_zonestring
Dates can be converted from another timezone to UTC either by specifying the time zone in the date value itself (if the format accepts it), or it can be specified as the time_zone parameter.
simple_query_stringobject
A query that uses simple query string syntax. Will ignore invalid syntax.
querystringrequired
The query expressed in simple query string syntax.
fieldsstring[]
Array of fields to search
default_operatorstring
The boolean operator used to combine the terms of the query. Valid values are OR (default) and AND.
analyze_wildcardboolean
If true, the query attempts to analyze wildcard terms. Defaults to false.
analyzerstring
The name of the analyzer to use to convert the query text into tokens.
auto_generate_synonyms_phrase_queryboolean
If true, the parse creates a match_phrase uery for each multi-position token. Defaults to true.
flagsstring
List of enabled operators for the simple query string syntax. Defaults to ALL.
fuzzy_max_expansionsinteger · format: int32
Maximum number of terms to which the query expands for fuzzy matching. Defaults to 50.
fuzzy_prefix_lengthinteger · format: int32
Number of beginning characters left unchanged for fuzzy matching. Defaults to 0.
fuzzy_transpositionsboolean
If true, edits for fuzzy matching include transpositions of two adjacent characters. Defaults to false.
lenientboolean
If true, format-based errors, such as providing a text value for a numeric field are ignored. Defaults to false.
minimum_should_matchstring
Minimum number of clauses that must match for a document to be returned.
quote_field_suffixstring
Suffix appended to quoted text in the query string.
storage_multipliernumber · format: double
Settings for the instance storage multiplier
deleted_onstring · format: date-time
Date/time that this instance configuration was marked for deletion
system_ownedboolean
Indicates if a instance configuration is system owned (restricts the set of operations that can be performed on it)
metadataobject
Optional arbitrary metadata to associate with this template.
cpu_multipliernumber · format: double
Settings for the instance CPU multiplier
allowed_zonesstring[]
The zones this instance configuration may exist in. Leaving out this parameter or specifying an empty list implies all zones are allowed. Normally not needed, but can be useful for exceptional infrastructure constraints.
max_zonesinteger · format: int32
The maximum number of availability zones in which this instance configuration has allocators. This field will be missing unless explicitly requested with the show_max_zones parameter.
Instance configuration specified by {id} cannot be found (code: 'configuration.instance_configuration_not_found')
application/octet-stream
errorsobject[]required
A list of errors that occurred in the failing request
codestringrequired
A structured code representing the error type that occurred
messagestringrequired
A human readable message describing the error that occurred
fieldsstring[]
If the error can be tied to a specific field or fields in the user request, this lists those fields