IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Get eligible remote clusters Set remote clusters »

› › › ›

Get remote clusters

edit

Get remote clusters

edit

Returns the list of remote clusters for the elasticsearch resource.

Request

edit

GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment.
`ref_id`	`string`	Y	User-specified RefId for the Resource.

Responses

edit

200

(RemoteResources)

List of remote clusters for the resource

404

(BasicFailedReply)

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

Request example

edit

curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \
-H "Authorization: ApiKey $ECE_API_KEY"

« Get eligible remote clusters Set remote clusters »