compute
GET /v1/compute/regions/resolve
Answer "can I have a machine in this place?" without placing anything.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Où insérer l'ID de votre organisation
Cet point de terminaison prend org_id comme paramètre de requête. Omettez-le et l'appel couvrira l'ensemble de votre sous-arbre de location ; envoyez-le pour restreindre l'appel à une seule organisation.
L'identifiant de votre organisation se trouve sur l'écran des clés API de votre tableau de bord, à côté de la clé elle-même. Il s'agit du même identifiant pour chaque appel que vous effectuez.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/compute/regions/resolve?location=<location> \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
Free text — a city or a country — resolved against the regions available now. ⛔ A place we do not serve is never silently replaced by one we do. status is one of exact (build there — match is set), nearest (we know the place and do not serve it: alternatives are the closest regions, with great-circle distance and an estimated round trip), country (a country was named: alternatives are our regions in it, with no distance, because a country is not a point) or unrecognised (nothing is guessed). requires_confirmation is true for everything but exact, and the customer's own choice goes back through the ordinary order. latency_ms is an estimate from distance, never a measurement. Requires sites.view.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
location (query) | string | Oui | Where the machine is wanted — a city or a country, in any spelling. |
org_id (query) | Uuid | Non | The organisation to resolve for. Required only when the caller belongs to more than one; omitted, it is their own. |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
data | ComputeRegionResolution | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 422 · 429 · 503