hosting
GET /v1/sites/{siteId}/hosting/usage
Get a site's current-period hosting usage.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/hosting/usage \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Disk and **outbound** bandwidth for the site's package this period, read from the vendor — the same figures the metering basis uses (docs/62 §3.4). Inbound bytes are deliberately not reported: billing a customer for what was sent *to* their site would charge them for other people's traffic, including an attack. `periods` carries the daily/monthly/yearly series where the vendor publishes it, and is empty otherwise rather than fabricated. `404` for a site with no vendor package. Requires `sites.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
disk_used_mb | integer | はい | Disk used this period, in MB. |
bandwidth_mb | integer | はい | Outbound bandwidth this period, in MB. Inbound is never billed or shown. |
requests | integer | はい | Hits this period, as the vendor counts them. |
periods | object | はい | Daily / monthly / yearly hit and byte totals where the vendor publishes them; empty otherwise, never fabricated. |
このエンドポイントが返すエラー
401 · 403 · 404 · 429 · 503