mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 05:28:34 +00:00
10ed1ae1d2
The additional change to the original PR (#49657), is that `org.elasticsearch.client.cluster.RemoteConnectionInfo` now parses the initial_connect_timeout field as a string instead of a TimeValue instance. The reason that this is needed is because that the initial_connect_timeout field in the remote connection api is serialized for human consumption, but not for parsing purposes. Therefore the HLRC can't parse it correctly (which caused test failures in CI, but not in the PR CI :( ). The way this field is serialized needs to be changed in the remote connection api, but that is a breaking change. We should wait making this change until rest api versioning is introduced. Co-Authored-By: j-bean <anton.shuvaev91@gmail.com> Co-authored-by: j-bean <anton.shuvaev91@gmail.com>
33 lines
946 B
Plaintext
33 lines
946 B
Plaintext
--
|
|
:api: remote-info
|
|
:request: RemoteInfoRequest
|
|
:response: RemoteInfoResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Remote Cluster Info API
|
|
|
|
The Remote cluster info API allows to get all of the configured remote cluster information.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Remote Cluster Info Request
|
|
|
|
A +{request}+:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
|
|
There are no required parameters.
|
|
|
|
==== Remote Cluster Info Response
|
|
|
|
The returned +{response}+ allows to retrieve remote cluster information.
|
|
It returns connection and endpoint information keyed by the configured remote cluster alias.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|