Get Deployment APM Resource Info
- GET /deployments/{deployment_id}/apm/{ref_id}
Get info about an APM Resource belonging to a given Deployment.
Path Parameters
-
deployment_idstringrequired -
Identifier for the Deployment
-
ref_idstringrequired -
User-specified RefId for the Resource (or '_main' if there is only one).
Query Parameters
-
show_metadataboolean · default: false Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.
-
show_plansboolean · default: true Whether to include the full current and pending plan information in the response - can be large per cluster.
-
show_plan_logsboolean · default: false Whether to include with the current and pending plan information the attempt log - can be very large per cluster.
-
show_plan_historyboolean · default: false Whether to include with the current and pending plan information the plan history- can be very large per cluster.
-
show_plan_defaultsboolean · default: false If showing plans, whether to show values that are left at their default value (less readable but more informative).
-
show_settingsboolean · default: false Whether to show cluster settings in the response.
-
clear_transientboolean · default: false If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
Responses
Standard response.
-
ref_idstringrequired -
The locally-unique user-specified id of a Resource
-
elasticsearch_cluster_ref_idstringrequired -
The Elasticsearch cluster that this resource depends on.
-
idstringrequired -
The randomly-generated id of a Resource
-
regionstringrequired -
The region where this resource exists
-
infoApmInforequired -
The overview information for the APM Server.
-
idstringrequired -
The id of the APM
-
namestringrequired -
The name of the APM
-
elasticsearch_clusterTargetElasticsearchClusterrequired -
Information about the specified Elasticsearch cluster.
-
elasticsearch_idstringrequired -
The Elasticsearch cluster Id
-
linksmap string to Hyperlink -
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
-
<string>Hyperlink -
need_elevated_permissionsboolean -
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
-
deployment_idstring -
The id of the deployment that this APM Server belongs to.
-
healthybooleanrequired -
Whether the APM is healthy or not (one or more of the info subsections will have healthy: false)
-
status -
APM status
-
Values:
initializingstoppingstoppedrebootingrestartingreconfiguringstarted -
plan_infoApmPlansInforequired -
Information about current, pending, and past APM Server plans.
-
healthybooleanrequired -
Whether the plan situation is healthy (if unhealthy, means the last plan attempt failed)
-
currentApmPlanInfo -
Information about the APM Server plan.
-
plan_attempt_idstring -
A UUID for each plan attempt
-
plan_attempt_namestring -
A human readable name for each plan attempt, only populated when retrieving plan histories
-
healthybooleanrequired -
Either the plan ended successfully, or is not yet completed (and no errors have occurred)
-
attempt_start_timestring -
When this plan attempt (ie to apply the plan to the APM) started (ISO format in UTC)
-
attempt_end_timestring -
If this plan completed or failed (ie is not pending), when the attempt ended (ISO format in UTC)
-
plan_end_timestring -
If this plan is not current or pending, when the plan was no longer active (ISO format in UTC)
-
planApmPlan -
The plan for the APM Server.
-
cluster_topologyApmTopologyElement -
instance_configuration_idstring -
Controls the allocation of this topology element as well as allowed sizes and node_types. It needs to match the id of an existing instance configuration.
-
instance_configuration_versioninteger -
The version of the Instance Configuration Id. If it is unset, the meaning depends on read vs writes. For deployment reads, it is equivalent to version 0 (or the IC is unversioned); for deployment creates and deployment template use, it is equivalent to 'the latest version'; and for deployment updates, it is equivalent to 'retain the current version'.
-
sizeTopologySize -
Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.
-
zone_countinteger -
number of zones in which nodes will be placed
-
apmApmConfiguration -
The configuration options for the APM Server.
-
versionstring -
The version of the Apm cluster (must be one of the ECE supported versions, and won't work unless it matches the APM version. Leave blank to auto-detect version.)
-
docker_imagestring -
A docker URI that allows overriding of the default docker image specified for this version
-
system_settingsApmSystemSettings -
A structure that defines a curated subset of the APM Server settings. TIP: To define the complete set of APM Server setting, use
ApmSystemSettingswithuser_settings_override_anduser_settings_. -
elasticsearch_usernamestring -
Optionally override the account within APM - defaults to a system account that always exists (if specified, the password must also be specified). Note that this field is never returned from the API, it is write only.
-
elasticsearch_passwordstring -
Optionally override the account within APM - defaults to a system account that always exists (if specified, the username must also be specified). Note that this field is never returned from the API, it is write only.
-
secret_tokenstring -
Optionally override the secret token within APM - defaults to the previously existing secretToken
-
debug_enabledboolean -
Optionally enable debug mode for APM servers - defaults false
-
user_settings_jsonobject -
An arbitrary JSON object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_yaml' is allowed), provided the parameters are on the allowlist and not on the denylist. (This field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
-
user_settings_yamlstring -
An arbitrary YAML object allowing (non-admin) cluster owners to set their parameters (only one of this and 'user_settings_json' is allowed), provided the parameters are on the allowlist and not on the denylist. (These field together with 'user_settings_override*' and 'system_settings' defines the total set of Apm settings)
-
user_settings_override_jsonobject -
An arbitrary JSON object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_yaml' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
-
user_settings_override_yamlstring -
An arbitrary YAML object allowing ECE admins owners to set clusters' parameters (only one of this and 'user_settings_override_json' is allowed), ie in addition to the documented 'system_settings'. (This field together with 'system_settings' and 'user_settings*' defines the total set of Apm settings)
-
apmApmConfigurationrequired -
The configuration options for the APM Server.
-
transientTransientApmPlanConfiguration -
Defines the configuration parameters that control how the plan is applied. For example, the Elasticsearch cluster topology and APM Server settings.
-
strategyPlanStrategy -
The options for performing a plan change. Specify only one property each time. The default is
grow_and_shrink. -
rollingRollingStrategyConfig -
Performs inline, rolling configuration changes that mutate existing containers. TIP: This is the fastest way to update a plan, but can fail for complex plan changes, such as topology changes. Also, this is less safe for configuration changes that leave a cluster in a non running state. NOTE: When you perform a major version upgrade, and 'group_by' is set to 'pass:macros[all]';, rolling is required.
-
group_bystring -
Specifies the grouping attribute to use when rolling several instances. Instances that share the same value for the provided attribute key are rolled together as a unit. Examples that make sense to use are '__all__' (roll all instances as a single unit), 'logical_zone_name' (roll instances by zone), '__name__' (roll one instance at a time, the default if not specified). Note that '__all__' is required when performing a major version upgrade
-
allow_inline_resizeboolean -
Whether we allow changing the capacity of instances (default false). This is currently implemented by stopping, re-creating then starting the affected instance on its associated allocator when performing the changes. NOTES: This requires a round-trip through the allocation infrastructure of the active constructor, as it has to reserve the target capacity without over-committing
-
skip_synced_flushboolean -
Whether to skip attempting to do a synced flush on the filesystem of the container (default: false), which is less safe but may be required if the container is unhealthy
-
shard_init_wait_timeinteger -
The time, in seconds, to wait for shards that show no progress of initializing before rolling the next group (default: 10 minutes)
-
grow_and_shrinkGrowShrinkStrategyConfig -
A strategy that creates instances with the new plan, migrates data from the old instances, then shuts down the old instances.
GrowShrinkStrategyConfigis safer than 'rolling' and ensures single node availability during a plan change, but can be a lot slower on larger clusters. -
rolling_grow_and_shrinkRollingGrowShrinkStrategyConfig -
A strategy that creates new Elasticsearch instances, Kibana instances, and APM Servers with the new plan, then migrates the node data to minimize the amount of spare capacity.
-
autodetectAutodetectStrategyConfig -
A strategy that lets constructor choose the most optimal way to execute the plan.
-
plan_configurationApmPlanControlConfiguration -
The plan control configuration options for the APM Server.
-
timeoutinteger -
The total timeout in seconds after which the plan is cancelled even if it is not complete. Defaults to 4x the max memory capacity per node (in MB)
-
calm_wait_timeinteger -
This timeout determines how long to give a cluster after it responds to API calls before performing actual operations on it. It defaults to 5s
-
move_instancesInstanceMoveRequest -
fromstringrequired -
The instance id that is going to be moved
-
tostring -
An optional list of allocator ids to which the instance should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
instance_downboolean -
Tells the infrastructure that the instance should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will automatically decide (currently: will treat the instances as up)
-
move_allocatorsAllocatorMoveRequest -
fromstringrequired -
The allocator id off which all instances in the cluster should be moved
-
tostring -
An optional list of allocator ids to which the instance(s) should be moved. If not specified then any available allocator can be used (including the current one if it is healthy)
-
allocator_downboolean -
Tells the infrastructure that all instances on the allocator should be considered as permanently down when deciding how to migrate data to new nodes. If left blank then the system will auto-decide (currently: will treat the allocator as up)
-
reallocate_instancesboolean -
If true (default: false) does not allow re-using any existing instances currently in the cluster, ie even unchanged instances will be re-created
-
preferred_allocatorsstring -
List of allocators on which instances are placed if possible (if not possible/not specified then any available allocator with space is used)
-
Map containing allocators tags in form of key value pairs, increasing the likelihood during move requests for allocators with matching tags, to be selected as target allocators
-
extended_maintenanceboolean -
If true (default false), does not clear the maintenance flag (which prevents its API from being accessed except by the constructor) on new instances added until after a snapshot has been restored, otherwise, the maintenance flag is cleared once the new instances successfully join the new cluster
-
override_failsafeboolean -
If false (the default), the plan fails if it determines that the request can result in unsafe operations. Setting this flag overrides some of these check restraints.
-
plan_attempt_logClusterPlanStepInforequired -
step_idstringrequired -
ID of current step
-
startedstringrequired -
When the step started (ISO format in UTC)
-
completedstring -
When the step completed (ISO format in UTC)
-
duration_in_millisinteger -
The duration of the step in MS
-
status -
The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)
-
Values:
successwarningerrorpending -
info_logClusterPlanStepLogMessageInforequired -
Human readable summaries of the step, including messages for each stage of the step
-
timestampstringrequired -
Timestamp marking on info log of step
-
delta_in_millisinteger -
Time in milliseconds since previous log message
-
messagestringrequired -
Human readable log message
-
detailsmap string to stringrequired -
A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.
-
internal_detailsmap string to string -
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
-
failure_typestring -
The failure type, in case the step failed
-
sourceChangeSourceInfo -
A container for information about the source of a change.
-
facilitatorstringrequired -
The service where the change originated from
-
actionstringrequired -
The type of plan change that was initiated
-
datestringrequired -
The time the change was initiated
-
user_idstring -
The user that requested the change
-
admin_idstring -
The admin user that requested the change
-
remote_addressesstring -
The host addresses of the user that originated the change
-
warningsClusterPlanWarningrequired -
errorClusterPlanAttemptError -
Information about an error during a plan attempt.
-
timestampstringrequired -
Timestamp marking on info log of step
-
messagestringrequired -
Human readable error message
-
detailsmap string to stringrequired -
A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.
-
failure_typestring -
The failure type
-
pendingApmPlanInfo -
Information about the APM Server plan.
-
historyApmPlanInforequired -
metadataClusterMetadataInfo -
Information about the public and internal state, and the configuration settings of an Elasticsearch cluster.
-
versionintegerrequired -
The resource version number of the cluster metadata
-
last_modifiedstringrequired -
The most recent time the cluster metadata was changed (ISO format in UTC)
-
endpointstring -
The DNS name of the cluster endpoint, if available
-
service_urlstring -
The full URL to access this deployment resource
-
aliased_endpointstring -
The DNS name of the cluster endpoint derived from the deployment alias, if available
-
aliased_urlstring -
The full aliased URL to access this deployment resource
-
cloud_idstring -
The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana (only present if both exist)
-
rawobject -
An unstructured JSON representation of the public and internal state (can be filtered out via URL parameter). The contents and structure of the
rawfield can change at any time. -
portsClusterMetadataPortInfo -
Information about the ports that allow communication between the Elasticsearch cluster and various protocols.
-
httpintegerrequired -
Port where the cluster listens for HTTP traffic
-
httpsintegerrequired -
Port where the cluster listens for HTTPS traffic
-
transport_passthroughintegerrequired -
Port where the cluster listens for transport traffic using TLS
-
services_urlsServiceUrl -
A list of the URLs to access services that the resource provides at this time. Note that if the service is not running or has not started yet, the URL to access it won't be available
-
topologyClusterTopologyInforequired -
The topology for Elasticsearch clusters, multiple Kibana instances, or multiple APM Servers. The
ClusterTopologyInfoalso includes the instances and containers, and where they are located. -
healthybooleanrequired -
Whether the cluster topology is healthy (ie all instances are started and the services they run - ie elasticsearch - are available
-
instancesClusterInstanceInforequired -
instance_namestringrequired -
The name of the instance in Elastic Cloud
-
instance_configurationClusterInstanceConfigurationInfo -
Information about a configuration that creates a Kibana instance or APM Server.
-
idstringrequired -
The id of the configuration used to create the instance
-
namestringrequired -
The name of the configuration used to create the instance
-
config_versioninteger -
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.
-
service_versionstring -
The version of the service that the instance is running (eg Elasticsearch or Kibana), if available
-
healthybooleanrequired -
Whether the instance is healthy (ie started and running)
-
container_startedbooleanrequired -
Whether the container has started (does not tell you anything about the service -ie Elasticsearch- running inside the container)
-
service_runningbooleanrequired -
Whether the service launched inside the container -ie Elasticsearch- is actually running
-
maintenance_modebooleanrequired -
Whether the service is is maintenance mode (meaning that the proxy is not routing external traffic to it)
-
zonestring -
The zone in which this instance is being allocated
-
allocator_idstring -
The id of the allocator on which this instance is running (if the container is started or starting)
-
memoryClusterInstanceMemoryInfo -
Information about the specific instances memory capacity and its usage
-
instance_capacityintegerrequired -
The memory capacity in MB of the instance
-
instance_capacity_plannedinteger -
The planned memory capacity in MB of the instance (only shown when an override is present)
-
memory_pressureinteger -
The % memory pressure of Elasticsearch JVM heap space if available (60-75% consider increasing capacity, >75% can incur significant performance and stability issues)
-
native_memory_pressureinteger -
The % memory pressure of the instance Docker container (if available)
-
diskClusterInstanceDiskInfo -
Information about the use and storage capacity of a Kibana instance or APM Server.
-
disk_space_availableinteger -
If known, the amount of total disk space available to the container in MB
-
disk_space_usedintegerrequired -
The amount of disk space being used by the service in MB
-
storage_multipliernumberrequired -
The storage multiplier originally defined to calculate disk space.
-
service_rolesstring -
List of roles assigned to the service running in the instance. Currently only populated for Elasticsearch, with possible values: master,data,ingest,ml
-
node_roles -
A list of the node roles assigned to the service running in the instance. Currently populated only for Elasticsearch.
-
Values:
masteringestmldata_hotdata_contentdata_warmdata_colddata_frozenremote_cluster_clienttransformvoting_only -
instance_overridesInstanceOverrides -
capacityinteger -
Sets the memory capacity for the instances container. Requires a restart to take effect.
-
storage_multipliernumber -
Overrides the disk quota multiplier for the instance
-
external_linksExternalHyperlink · uniquerequired -
External resources related to the APM
-
linksmap string to Hyperlink -
A map of application-specific operations (which map to 'operationId's in the Swagger API) to metadata about that operation
-
<string>Hyperlink -
need_elevated_permissionsboolean -
Whether the operation requires elevated permissions (when the field is present, elevated permissions are required).
-
settingsApmSettings -
The settings for the APM Server.
-
metadataClusterMetadataSettings -
The top-level configuration settings for the Elasticsearch cluster.
-
namestring -
The display name of the cluster
-
owner_idstring -
The user id (referencing whatever user database is in use) of the cluster owner
-
organization_idstring -
The organization that owns the deployment
-
subscription_levelstring -
Subscription level of the cluster
-
system_ownedboolean -
Indicates if a cluster is system owned (restricts the set of operations that can be performed on it)
-
contact_emailstring -
Contact email for the cluster
-
Whether or not this cluster is hidden from the normal clusters list
-
resourcesClusterMetadataResourcesSettings -
The top-level configuration settings for the Elasticsearch cluster resources.
-
cpuClusterMetadataCpuResourcesSettings -
Specifies the CPU resource settings for the Elasticsearch cluster.
-
boostboolean -
Indicates if the CPU boost flag is enabled or not.
-
hard_limitboolean -
Indicates if the CPU hard limit flag is enabled or not. When set to true (default), allocates CPU timeshare based on the total CPU time multiplied by the relative RAM capacity of the instance on a given host. When set to false, delegates CPU allocation to the operating system to schedule CPU timeshares.
-
regionstring -
The region that this APM belongs to. Only populated in SaaS or federated ECE.
The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_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.deployment_resource_no_longer_exists)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response