Get remote clusters

开发环境

http://127.0.0.1

GET

/deployments/{deployment_id}/elasticsearch/{ref_id}/remote-clusters

Deployments

Returns the list of remote clusters for the elasticsearch resource.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://127.0.0.1/deployments//elasticsearch//remote-clusters' \
--header 'Authorization: ApiKey {{EC_API_KEY}}'

响应示例

200 - 示例 1

{
    "resources": [
        {
            "info": {
                "healthy": true,
                "compatible": true,
                "connected": true,
                "trusted": true,
                "trusted_back": true
            },
            "elasticsearch_ref_id": "string",
            "deployment_id": "string",
            "skip_unavailable": true,
            "alias": "string"
        }
    ]
}

请求参数

Path 参数

deployment_id

必需

Identifier for the Deployment.

ref_id

必需

User-specified RefId for the Resource.

Header 参数

Authorization

string

可选

默认值:

ApiKey {{EC_API_KEY}}

返回响应

🟢200List of remote clusters for the resource

application/json

Body

The list of resources used as remote clusters

resources

array[object (RemoteResourceRef) {5}]

必需

The remote resources

info

object (RemoteResourceInfo)

可选

Information about a Remote Cluster.

elasticsearch_ref_id

string

必需

The locally-unique user-specified id of an Elasticsearch Resource

deployment_id

string

必需

The id of the deployment

skip_unavailable

boolean

可选

If true, skip this cluster during search if it is disconnected. Default: false

alias

string

必需

The alias for this remote cluster. Aliases must only contain letters, digits, dashes and underscores

🟠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`)

Set remote clusters

Stop instances