Sonde de disponibilité

GET

/readyz

const url = 'https://api-equides.org/readyz';
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/readyz";

    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/readyz

Identique à /healthz : l’image de données étant chargée avant la première écoute, vivacité et disponibilité se confondent ici. Les deux routes existent pour les orchestrateurs qui distinguent les deux sondes.

Responses

200

Service 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"
}

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.

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"
}