Get pending plan
editGet pending plan
editThis endpoint is deprecated and scheduled to be removed in the next major version. Use get deployment instead.
Retrieves the pending plan of the 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
-
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 resource version, which is used to avoid update conflicts with concurrent operations
-
-
404
-
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
-
-
412
-
There is not currently applied plan - eg the cluster has not finished provisioning, or the provisioning failed. (code:
clusters.cluster_plan_state_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [clusters.cluster_plan_state_error
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/plan/pending \ -H "Authorization: ApiKey $ECE_API_KEY"