احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

جایی که شناسه سازمان شما قرار می‌گیرد

این نقطه پایانی org_id را به عنوان یک پارامتر پرس‌وجو می‌پذیرد. آن را رها کنید تا فراخوانی کل زیردرخت اجاره‌ای شما را پوشش دهد؛ آن را ارسال کنید تا فراخوانی به یک سازمان محدود شود.

شناسه سازمان شما در صفحه کلیدهای API در داشبوردتان، در کنار خود کلید قرار دارد. این شناسه در تمام درخواست‌هایی که ارسال می‌کنید یکسان است.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X GET https://api.zinndigital.com/v1/compute/servers \
  -H "Authorization: Bearer zdk_live_…"

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

Every machine the caller can see, or — with ?org_id= — one organisation's. The scoped form is what a reseller's console sends. An organisation outside the readable scope narrows to nothing rather than 403-ing, exactly as listSites does: a 403 would confirm the organisation exists. ⛔ Resolved from our own rows, not from the provider's listing, which is every customer on the reseller account. status is ours (how far the order got) and power_state is the machine's (what it is doing now); they are separate facts and rounding the provider's word into ours would silently make an unrecognised state active, which is what unlocks the power and resize controls. operable is read rather than re-derived from status, so a screen never offers a control the engine refuses. Requires sites.view.

پارامترها

نامنوعالزامیچیست
org_id (query)UuidخیرNarrow the list to one organisation the caller can read.

پاسخ

نامنوعالزامیچیست
dataComputeServer[]بلهThe machines, across every organisation the caller can read.

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 422 · 429 · 503