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 clusteredit
Retrieves cluster information for a APM cluster.
Requestedit
GET /api/v1/clusters/apm/{cluster_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Includes all of the cluster metadata in the response. NOTE: Responses can include a large amount of metadata, as well as credentials. |
|
|
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. |
|
|
N |
Includes the active and pending plan information in the response. NOTE: This option can result in large responses. |
|
|
N |
Includes the cluster settings in the response. |
Responsesedit
-
200
-
(
ApmInfo
) Returning the information for the specified APM cluster -
404
-
(
BasicFailedReply
) The cluster specified by {cluster_id} cannot 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 exampleedit
curl -XGET {{hostname}}/api/v1/clusters/apm/{cluster_id} \ -u $CLOUD_USER:$CLOUD_KEY