Connects Elasticsearch clusters.


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. For more information, see Common request parameters.

Request syntax

POST /openapi/instances/{InstanceId}/connected-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.

clientToken String Query No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can only contain ASCII characters and cannot exceed 64 characters in length.

String Body No { "instanceId":"es-cn-09k1rgid9000g****" }

The ID of the remote instance. Used to specify the ID of the remote instance to be connected to the network. It must be in the same Virtual Private Cloud as the current instance.

Response parameters

Parameter Type Example Description
Result Boolean true

The following information is returned:

  • true: The configuration is successful.
  • false: The configuration failed.
RequestId String 5A5D8E74-565C-43DC-B031-29289FA****

The ID of the request.


Sample requests

POST /openapi/instances/es-cn-n6w1o1x0w001c****/connected-clusters?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1

Sample success responses

JSON format

HTTP/1.1 200 OK

  "RequestId" : "5A5D8E74-565C-43DC-B031-29289FA****",
  "Result" : true

Error codes

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