mirror of https://gitee.com/bigwinds/arangodb
765 B
765 B
@startDocuBlock JSF_get_api_cluster_endpoints @brief This API call returns information about all coordinator endpoints (cluster only).
@RESTHEADER{GET /_api/cluster/endpoints, Get information about all coordinator endpoints}
@RESTDESCRIPTION
Returns an object with an attribute endpoints
, which contains an
array of objects, which each have the attribute endpoint
, whose value
is a string with the endpoint description. There is an entry for each
coordinator in the cluster. This method only works on coordinators in
cluster mode. In case of an error the error
attribute is set to
true
.
@RESTRETURNCODES
@RESTRETURNCODE{200} is returned when everything went well.
@RESTRETURNCODE{403} server is not a coordinator or method was not GET.
@endDocuBlock