認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/compute/servers \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
data | ComputeServer[] | はい | The machines, across every organisation the caller can read. |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429 · 503