Pular para o conteúdo

Check heartbeat

Requisição

Gets the health status of the xCurrent server's peers. This request requires authorization. The timeout for this operation is 5 seconds.

Segurança
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/pt-br/products/payments-odl/api-docs/ripplenet/reference/openapi/heartbeat \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respostas

Successful response.

Corpoapplication/json
time_checkedstring, (date)obrigatório

Time at which the heartbeat was checked, as an ISO-8601 timestamp in UTC.

Exemplo:"2019-10-01"
xcurrent_nodestringobrigatório

RippleNet address of the RippleNet server for which the heartbeat was checked. (Deprecated in favor of 'ripplenet_node' field, has exactly the same value).

Exemplo:"rn.us.ny.new_york"
ripplenet_nodestring

RippleNet address of the RippleNet server for which the heartbeat was checked.

Exemplo:"rn.us.ny.new_york"
peer_heartbeat_resultsobjectobrigatório

Provides a list of peer RippleNet addresses and their health statuses.

errorsArray of stringsobrigatório

If applicable, provides one or more messages describing the error.

Resposta
{
  "time_checked": "2019-10-01",
  "xcurrent_node": "rn.us.ny.new_york",
  "ripplenet_node": "rn.us.ny.new_york",
  "peer_heartbeat_results": {
    "property1": "HEALTHY",
    "property2": "HEALTHY"
  },
  "errors": [
    "string"
  ]
}