compute
GET /v1/compute/regions/resolve
Answer "can I have a machine in this place?" without placing anything.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение 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, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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 | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 422 · 429 · 503