Deployment - Remote Clustersedit
Get eligible remote clustersedit
Returns the list of deployments which contain eligible remote clusters for a specific version.
Requestedit
POST /api/v1/deployments/eligible-remote-clusters
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The version of the Elasticsearch cluster cluster that will potentially be configured to have remote clusters. |
Request bodyedit
(SearchRequest
) (Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched.
Responsesedit
-
200
-
List of deployments which contains eligible remote clusters for a specific version
-
400
-
The provided version is invalid. (code:
stackpack.invalid_version
)Headers
-
x-cloud-error-codes
(string
; allowed values: [stackpack.invalid_version
]) - The error codes associated with the response
-
Request exampleedit
curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/eligible-remote-clusters \ -H "Authorization: ApiKey $EC_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "_source" : {}, "from" : 0, "query" : { "bool" : { "filter" : [ null ], "minimum_should_match" : 0, "must" : [ null ], "must_not" : [ null ], "should" : [ null ] }, "exists" : { "field" : "string" }, "match" : { "some_property" : { "analyzer" : "string", "minimum_should_match" : 0, "operator" : "string", "query" : "string" } }, "match_all" : {}, "match_none" : {}, "nested" : { "path" : "string", "query" : null, "score_mode" : "string" }, "prefix" : { "some_property" : { "boost" : 0.1, "value" : "string" } }, "query_string" : { "allow_leading_wildcard" : true, "analyzer" : "string", "default_field" : "string", "default_operator" : "string", "query" : "string" }, "range" : { "some_property" : { "boost" : 0.1, "format" : "string", "gt" : {}, "gte" : {}, "lt" : {}, "lte" : {}, "time_zone" : "string" } }, "term" : { "some_property" : { "value" : "string" } } }, "size" : 0, "sort" : [ {} ] } '
Get eligible remote clustersedit
Returns the list of deployments which contain eligible remote clusters for the elasticsearch resource.
Requestedit
POST /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Request bodyedit
(SearchRequest
) (Optional) The search query to run against all deployments containing eligible remote clusters. When not specified, all the eligible deployments are matched.
Responsesedit
-
200
-
List of deployments which contains eligible remote clusters for the resource
-
400
-
The resource specified doesn't yet have a valid version for the current plan or the pending plan. (code:
deployments.resource_does_not_have_a_valid_version
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.resource_does_not_have_a_valid_version
]) - The error codes associated with the response
-
-
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 exampleedit
curl -XPOST https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/eligible-remote-clusters \ -H "Authorization: ApiKey $EC_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "_source" : {}, "from" : 0, "query" : { "bool" : { "filter" : [ null ], "minimum_should_match" : 0, "must" : [ null ], "must_not" : [ null ], "should" : [ null ] }, "exists" : { "field" : "string" }, "match" : { "some_property" : { "analyzer" : "string", "minimum_should_match" : 0, "operator" : "string", "query" : "string" } }, "match_all" : {}, "match_none" : {}, "nested" : { "path" : "string", "query" : null, "score_mode" : "string" }, "prefix" : { "some_property" : { "boost" : 0.1, "value" : "string" } }, "query_string" : { "allow_leading_wildcard" : true, "analyzer" : "string", "default_field" : "string", "default_operator" : "string", "query" : "string" }, "range" : { "some_property" : { "boost" : 0.1, "format" : "string", "gt" : {}, "gte" : {}, "lt" : {}, "lte" : {}, "time_zone" : "string" } }, "term" : { "some_property" : { "value" : "string" } } }, "size" : 0, "sort" : [ {} ] } '
Get remote clustersedit
Returns the list of remote clusters for the elasticsearch resource.
Requestedit
GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Responsesedit
-
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 exampleedit
curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \ -H "Authorization: ApiKey $EC_API_KEY"
Set remote clustersedit
Overwrites or creates the remote clusters for the elasticsearch resource.
Requestedit
PUT /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Request bodyedit
(RemoteResources
) (required) List of remote clusters for the resource
Responsesedit
-
202
-
The Remote Clusters were updated
-
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:
-
449
-
Elevated permissions are required. (code:
root.unauthorized.rbac.elevated_permissions_required
)Headers
-
x-cloud-error-codes
(string
; allowed values: [root.unauthorized.rbac.elevated_permissions_required
]) - The error codes associated with the response
-
Request exampleedit
curl -XPUT https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters \ -H "Authorization: ApiKey $EC_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "resources" : [ { "alias" : "string", "deployment_id" : "string", "elasticsearch_ref_id" : "string", "info" : { "compatible" : true, "connected" : true, "healthy" : true, "trusted" : true, "trusted_back" : true }, "skip_unavailable" : true } ] } '