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

edit

Get plan

edit

DEPRECATED (Scheduled to be removed in the next major version): Retrieves the active plan of the Elasticsearch cluster. Transient settings are not show by this endpoint. To view the transient settings that have been applied with a specific plan, use the activity endpoint.

Request

edit

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

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

Responses

edit

200

(ElasticsearchClusterPlan) The cluster has a current applied plan

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

(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

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)

Headers

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

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

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

« Set monitoring Update plan »