compute
GET /v1/compute/catalogue
Get everything the server order screen is built from.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (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
التفاصيل
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