compute

PUT /v1/compute/spend-cap

Set or clear the organisation's monthly limit on metered compute.

所有 compute 端点

所有开发者文档

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

您的组织 ID 应填在此处

此端点接受 org_id 作为 JSON 正文中的一个字段。

您的组织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_minorobjectThe new limit in minor units of the billing currency, or null to clear it.
org_idobjectRequired only when the caller belongs to more than one organisation.

响应

名称类型必填内容简介
monthly_cap_minorobjectThe organisation's monthly limit on metered compute. null = no limit.
currencystringThe organisation's billing currency.
month_to_date_minorintegerWhat metered machines have rated so far this month, in currency.

此端点可能返回的错误

401 · 403 · 422 · 429