A newer version is available. For the latest information, see the
current release documentation.
Get remote clusters
editGet remote clusters
editReturns the list of remote clusters for the elasticsearch resource.
Request
editGET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Responses
edit-
200 -
List of remote clusters for the resource
-
404 -
-
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
-
The Deployment specified by {deployment_id} cannot be found. (code:
Request example
editcurl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \
-H "Authorization: ApiKey $ECE_API_KEY"