compute
GET /v1/compute/catalogue
Get everything the server order screen is built from.
Аутентификация
Отправьте ключ API в качестве токена носителя (bearer token). Ключ должен иметь разрешение sites.view; ключ без него отклоняется с кодом 403, а не 404.
Идентификатор вашей организации
Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.
Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/compute/catalogue \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The live provider / data-centre / machine-size matrix, merged with the tiers we actually sell. Nothing about a provider, a zone, a size or a stack optimisation is authored in a client: a combination a client invented is one the provider refuses *inside provisioning*, minutes after the customer chose it, where all they see is a machine that failed. ⛔ **Sizes carry no price, ever.** Retail price is catalogue data the customer sees on the plan; the provider's own figure is cost, and a cost rendered beside a size is a margin leak. Every numeric on a size is nullable and a null stays null — a size rendered as "0 GB RAM" reads as a broken product where a blank reads as "not stated", which is what it is. `spec_source` says whether the sizes came from the provider or, when it published none, from our own sold tiers — in which case a size id **is** a plan code and the two collapse at order time. `can_order` is what lets a screen say *"this cannot be ordered yet"* instead of rendering a button that `422`s. `?target=` selects the range (Zinn® Cloud by default); a target that is not a compute product is `404`, never a `403`. `?org_id=` is required only of a caller who belongs to more than one organisation, and is `422` when omitted by one who does — picking "the first org in scope" would configure against an arbitrary tenant. Requires `sites.view`.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
target (query) | string | Нет | Which compute range to describe. Defaults to Zinn® Cloud, the branded product; the VPS range is the same seam with a different target. |
org_id (query) | Uuid | Нет | The organisation to configure against. Required only when the caller belongs to more than one; omitted, it is their own. |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
data | ComputeProvider[] | Да | The platforms a machine can be placed on. |
tiers | ComputeTier[] | Да | The tiers we sell on this range. |
can_order | boolean | Да | Whether anything here can actually be ordered — any orderable tier, or any provider size. It exists so a screen can say *"this cannot be ordered yet"* instead of rendering a but… |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404 · 422 · 429 · 503