コンテンツにスキップ

Admin API:使用量

スペースと環境全体の、今の使用量と上限を取得する操作です。共通の決まり(認証、エラーの形、日時)は Admin API のリファレンス にあります。

例の <ホスト名> はあなたの環境のホスト名、<アクセストークン> は hako_pat_ で始まるアクセストークンに置き換えます。<slug> などのほかの山かっこの値は、各操作のパラメーターの表にあるものに置き換えます。

操作 メソッドとパス
スペースの使用量 GET /admin/api/spaces/{slug}/usage
環境全体の使用量 GET /admin/api/usage

スペースの使用量と、運営者が掛けた上限(max、null なら上限なし)。メンバーならだれでも見られる。

GET /admin/api/spaces/{slug}/usage
  • ログイン:要る(セッションかアクセストークン)

パラメーター:

名前 場所 型 必須 決まり 説明
slug パス 文字列 ○ スペースのスラッグ

返る値:

状態 本文
200 SpaceUsageView(application/json)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl "https://<ホスト名>.hakocms.net/admin/api/spaces/<slug>/usage" \
-H "Authorization: Bearer <アクセストークン>"

環境全体の使用量と上限。環境の管理者だけ。

GET /admin/api/usage
  • ログイン:要る(セッションかアクセストークン)

返る値:

状態 本文
200 InstanceUsageView(application/json)

うまくいかなかったときは、4xx か 5xx と、message を持つ JSON が返ります。状態ごとの意味は エラーの一覧 にあります。

例:

ターミナルウィンドウ
curl "https://<ホスト名>.hakocms.net/admin/api/usage" \
-H "Authorization: Bearer <アクセストークン>"