Sonde de vivacité

GET

/healthz

const url = 'https://api-equides.org/healthz';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://api-equides.org/healthz";

    let client = reqwest::Client::new();
    let response = client.get(url)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request GET \
  --url https://api-equides.org/healthz

Reste sur le port public : un répartiteur de charge doit pouvoir l’interroger sans accès au plan d’administration. La télémétrie Prometheus, elle, n’est servie que sur l’écoute privée.

Responses

200

Service opérationnel.

application/json

object

lignes

required

Lignes chargées en mémoire. Le service n’est prêt qu’au-delà de zéro.

integer

statut

required

string

Allowed values: ok indisponible

version

required

string

Example

{
  "statut": "ok"
}

304

Contenu inchangé depuis l’ETag fourni en If-None-Match. Aucun corps, et rien n’est recalculé côté service.

429

Quota de débit dépassé pour l’adresse appelante. Retry-After indique le délai.

application/problem+json

Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.

object

detail

required

Explication propre à cette occurrence.

string

documentation

string

indice

Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.

string

parametre

Extension : paramètre fautif, quand l’erreur en désigne un.

string

status

required

integer

title

required

Résumé lisible, stable pour un type donné.

string

type

required

URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.

string

Example

{
  "detail": "paramètre inconnu `rase`",
  "documentation": "https://docs.api-equides.org",
  "indice": "vouliez-vous dire `race` ?",
  "parametre": "rase",
  "status": 400,
  "title": "Paramètre invalide",
  "type": "/#erreur-parametre-invalide"
}

503

Aucune donnée chargée : le service n’est pas prêt.

application/json

object

lignes

required

Lignes chargées en mémoire. Le service n’est prêt qu’au-delà de zéro.

integer

statut

required

string

Allowed values: ok indisponible

version

required

string

Example

{
  "statut": "ok"
}