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 activityedit
DEPRECATED (Scheduled to be removed in the next major version): Retrieves the current and historical plan information for a APM cluster.
Requestedit
GET /api/v1/clusters/apm/{cluster_id}/plan/activity
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
When plans are shown, includes the default values in the response. NOTE: This option results in large responses. |
|
|
N |
Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses. |
Responsesedit
-
200 -
(
ApmPlansInfo) Returning the plan activity for the specified APM cluster -
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
-
Request exampleedit
curl -XGET https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/plan/activity \
-H "Authorization: ApiKey $ECE_API_KEY"