compute

GET /v1/compute/catalogue

Get everything the server order screen is built from.

すべての compute エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。

組織 ID を入力する場所

このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。

組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

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

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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 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.

返信

名前タイプ必須これがその内容です
dataComputeProvider[]はいThe platforms a machine can be placed on.
tiersComputeTier[]はいThe tiers we sell on this range.
can_orderbooleanはい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_targetsDeployTarget[]いいえ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…

このエンドポイントが返すエラー

401 · 403 · 404 · 422 · 429 · 503