It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› › › ›

Get plan activity

edit

Get plan activity

edit

Retrieves the current and historical plan information for an Elasticsearch cluster.

Request

edit

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

Path parameters

edit

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

Query parameters

edit

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: `true`	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.

Responses

edit

200: (ElasticsearchClusterPlansInfo) Returning the plan activity for the specified Elasticsearch cluster
404: (BasicFailedReply) The cluster specified by {cluster_id} cannot 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.

Request example

edit

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

« Update plan Cancel pending plan »