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 pending plan
editGet pending plan
editRetrieves the pending plan of a cluster.
Request
editGET /api/v1/clusters/elasticsearch/{cluster_id}/plan/pending
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When plans are shown, includes the missing elements from the applicable deployment template. |
|
|
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 clusterHeaders
-
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
editcurl -XGET {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/pending \ -u $CLOUD_USER:$CLOUD_KEY