Get plan activityedit

This endpoint is deprecated and scheduled to be removed in the next major version. Use get deployment instead.

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

Requestedit

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

Path parametersedit

Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Query parametersedit

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.

Responsesedit

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)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response

Request exampleedit

curl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/activity \
-H "Authorization: ApiKey $ECE_API_KEY"