Queries the Elasticsearch clusters that can be connected to a specified Elasticsearch cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers.

Request syntax

GET /openapi/instances/{InstanceId}/connectable-clusters HTTP/1.1

Request parameters

Parameter Type Position Required Example Description
InstanceId String Path Yes es-cn-n6w1o1x0w001c****

The ID of the current instance.

alreadySetItems Boolean Query No true

Specifies whether to return interconnected instances:

  • true (default): The returned instance list includes instances that are connected to each other.
  • false: The returned instance list does not include interconnected instances.

Response parameters

Parameter Type Example Description
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

The ID of the request.

Result Array of ConnectableClustersInfo

The returned data.

networkType String vpc

The network type of the instance.

instances String es-cn-xxx

The ID of the instance that can communicate with each other.

Examples

Sample requests

GET /openapi/instances/es-cn-n6w1o1x0w001c****/connectable-clusters?alreadySetItems=true HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

Sample success responses

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : [ {
    "instanceId" : "es-cn-09k1rgid9000g****",
    "networkType" : "vpc"
  } ],
  "RequestId" : "506B7495-0887-4F05-BC76-5AE7AC1D****"
}

Error code

For a list of error codes, visit the API Error Center.