compute
GET /v1/compute/regions/resolve
Answer "can I have a machine in this place?" without placing anything.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/compute/regions/resolve?location=<location> \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
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.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
location (query) | string | Да | Where the machine is wanted — a city or a country, in any spelling. |
org_id (query) | Uuid | Не | The organisation to resolve for. Required only when the caller belongs to more than one; omitted, it is their own. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
data | ComputeRegionResolution | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 422 · 429 · 503