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 activity
editGet plan activity
editRetrieves the current and historical plan information for a APM cluster.
Request
editGET /api/v1/clusters/apm/{cluster_id}/plan/activity
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Query parameters
editName | 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. |
Responses
edit-
200
-
(
ApmPlansInfo
) The APM server plan activity is retrieved. -
404
-
(
BasicFailedReply
) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')
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/apm/{cluster_id}/plan/activity \ -u $CLOUD_USER:$CLOUD_KEY