Type to search.

cloud hosted deployments get-deployment-apm-resource-info cli command

Serverless Preview

Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Serverless interfaces and procedures might differ from classic Elastic Stack deployments.

Stack Preview

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Preview

    This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Auth required
Shell 
elastic cloud hosted deployments get-deployment-apm-resource-info \
  --deployment-id <deployment-id> \
  --ref-id <ref-id> \
  [options]

Get Deployment APM Resource Info

Behaviour flags:

--dry-run — validate all inputs and exit without performing any action

--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).
--show-metadata
Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials.
--show-plans
Whether to include the full current and pending plan information in the response - can be large per cluster.
--show-plan-logs
Whether to include with the current and pending plan information the attempt log - can be very large per cluster.
--show-plan-history
Whether to include with the current and pending plan information the plan history- can be very large per cluster.
--show-plan-defaults
If showing plans, whether to show values that are left at their default value (less readable but more informative).
--show-settings
Whether to show cluster settings in the response.
--clear-transient
If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
--input-file string
path to a JSON file to use as command input
--dry-run
validate all inputs and exit without performing any action (preview changes without applying them)
--no-validate
skip input validation and send the request as-is
--output-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--json

output as JSON