Get clusteredit
Retrieves the Elasticsearch cluster information.
Requestedit
GET /api/v1/clusters/elasticsearch/{cluster_id}
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When plans are shown, includes the missing elements from the applicable deployment template. |
|
|
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 Elasticsearch 2.x security information in the response. NOTE: Responses can include a large amount of metadata, as well as credentials. |
|
|
N |
Includes the cluster settings in the response. |
|
|
N |
The number of system alerts to include in the response. For example, the number of forced restarts caused from a limited amount of memory. Only numbers greater than zero return a field. NOTE: Responses can include a large number of system alerts. |
Responsesedit
-
200
-
(
ElasticsearchClusterInfo
) Returning the information for the specified Elasticsearch 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
-
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/elasticsearch/{cluster_id} \ -H "Authorization: ApiKey $ECE_API_KEY"