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 زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول 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