compute
PUT /v1/compute/spend-cap
Set or clear the organisation's monthly limit on metered compute.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントは、JSONボディのフィールドとして org_id を受け取ります。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/compute/spend-cap \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "monthly_cap_minor": <object> }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
When this month's metered hours reach the limit, the organisation's pay-by-the-hour machines are stopped within the hour, and started again within the hour of the limit being raised or the month turning. ⛔ A stopped machine still exists and is still rated by the hour; deleting it is what stops the billing.
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
monthly_cap_minor | object | はい | The new limit in minor units of the billing currency, or null to clear it. |
org_id | object | いいえ | Required only when the caller belongs to more than one organisation. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
monthly_cap_minor | object | はい | The organisation's monthly limit on metered compute. null = no limit. |
currency | string | はい | The organisation's billing currency. |
month_to_date_minor | integer | はい | What metered machines have rated so far this month, in currency. |
このエンドポイントが返すエラー
401 · 403 · 422 · 429