Get certificate based remote clusters
- Base URL
-
https://api.elastic-cloud.com/api/v1
No auth
Returns the list of certificate based remote clusters for the elasticsearch resource.
-
deployment_id
string
required
-
Identifier for the Deployment.
-
ref_id
string
required
-
User-specified RefId for the Resource (or '_main' if there is only one).
List of certificate based remote clusters for the resource
-
resources
object[]
required
-
The remote resources
-
-
deployment_id
string
required
-
The id of the deployment
-
elasticsearch_ref_id
string
required
-
The locally-unique user-specified id of an Elasticsearch Resource
-
alias
string
required
-
The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores
-
skip_unavailable
boolean
-
If true, skip this cluster during search if it is disconnected. Default: false
-
info
object
-
Information about a Remote Cluster.
-
-
healthy
boolean
required
-
Whether or not the remote cluster is healthy
-
connected
boolean
required
-
Whether or not there is at least one connection to the remote cluster.
-
compatible
boolean
required
-
Whether or not the remote cluster version is compatible with this cluster version.
-
trusted
boolean
required
-
Whether or not the remote cluster is trusted by this cluster.
-
trusted_back
boolean
required
-
Whether or not the remote cluster trusts this cluster back.
- 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)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
code
string
required
-
A structured code representing the error type that occurred
-
message
string
required
-
A human readable message describing the error that occurred
-
fields
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields