Get pending plan

edit

Retrieves the pending plan of a cluster.

Request

edit

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

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.

Responses

edit
200

(ElasticsearchClusterPlan) The cluster has a pending plan currently being applied to the cluster

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The version of the resource - used to avoid update conflicts from multiple concurrent operations
404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')

412

(BasicFailedReply) There is not currently applied plan - eg the cluster has not finished provisioning, or the provisioning failed (code: 'clusters.cluster_plan_state_error')

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/pending \
-u $CLOUD_USER:$CLOUD_KEY