compute
GET /v1/compute/catalogue
Get everything the server order screen is built from.
Упълномощаване
Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението sites.view; ключ без него се отхвърля с 403, а не с 404.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/compute/catalogue \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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 422s. ?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… |
available_targets | DeployTarget[] | Не | The compute ranges that have a provider account behind them — derived from the platform's provider-account pool, never listed by hand. An order screen offers only these. A range… |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 429 · 503