Get plan activity

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get plan activity

edit

Retrieves details for a single plan activity for the given resource.

Request

edit

GET /api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id}

Path parameters

edit

Name	Type	Required	Description
`attempt_id`	`string`	Y	Attempt id for the activity
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one)
`resource_kind`	`string`; allowed values: [`elasticsearch`, `kibana`, `apm`, `appsearch`, `enterprise_search`, `integrations_server`]	Y	The kind of resource

Responses

edit

200

(CommonClusterPlanInfo)

Returning the single plan activity for the specified resource

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found, deployments.deployment_resource_not_found]): The error codes associated with the response

Request example

edit

curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/activity/{attempt_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

« Deployment Plan - Activity Deployment Resources - CRUD »