compute
GET /v1/compute/regions/resolve
Answer "can I have a machine in this place?" without placing anything.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie sites.view; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X GET https://api.zinndigital.com/v1/compute/regions/resolve?location=<location> \
-H "Authorization: Bearer zdk_live_…"Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
location (query) | string | Tak | Where the machine is wanted — a city or a country, in any spelling. |
org_id (query) | Uuid | Nie | The organisation to resolve for. Required only when the caller belongs to more than one; omitted, it is their own. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
data | ComputeRegionResolution | Tak | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 422 · 429 · 503