Get plan activity | Elastic Cloud Enterprise Reference [2.2]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

Retrieves the active and historical plan information for the Elasticsearch cluster.

GET /api/v1/clusters/elasticsearch/{cluster_id}/plan/activity

Name	Type	Required	Description
`cluster_id`	`string`	Y	The Elasticsearch cluster identifier.

Name	Type	Required	Description
`convert_legacy_plans`	`boolean`; default: `false`	N	When `true`, converts the plans to the 2.0.x format. When `false`, uses the 1.x format. The default is `false`.
`enrich_with_template`	`boolean`; default: `false`	N	When plans are shown, includes the missing elements from the applicable deployment template.
`show_plan_defaults`	`boolean`; default: `false`	N	When plans are shown, includes the default values in the response. NOTE: This option results in large responses.
`show_plan_logs`	`boolean`; default: `true`	N	Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.

200: (ElasticsearchClusterPlansInfo) The Elasticsearch cluster plan activity is retrieved.
404: (BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

curl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/activity \
-u $CLOUD_USER:$CLOUD_KEY