Beta

使用量取得

GEThttps://api.youvico.com/api/workspace/usage
レート制限
Default
スコープ
usage:read
ワークスペースロール
所有者管理者メンバー

ワークスペースの使用量をプランの上限とともに取得します。

credits は、APIキーまたは連携に credits:read スコープもある場合にのみ返され、ない場合は null です。

例

curl 'https://api.youvico.com/api/workspace/usage' \
  -H 'Authorization: Bearer YOUR_API_KEY'
{
  "data": {
    "member": {
      "current": 12,
      "max": 50
    },
    "project": {
      "current": 4,
      "max": 10
    },
    "storage": {
      "current": 104857600,
      "max": 53687091200
    },
    "credits": {
      "plan": 900,
      "reservedPlan": 50,
      "max": 1500,
      "purchased": 600,
      "reservedPurchased": 100
    }
  }
}
リクエスト
curl -X GET 'https://api.youvico.com/api/workspace/usage' \
-H 'Authorization: Bearer YOUR_API_KEY'
レスポンス200 OK
{
  "data": {
    "member": {
      "current": 12,
      "max": 50
    },
    "project": {
      "current": 4,
      "max": 10
    },
    "storage": {
      "current": 104857600,
      "max": 53687091200
    },
    "credits": {
      "plan": 900,
      "reservedPlan": 50,
      "max": 1500,
      "purchased": 600,
      "reservedPurchased": 100
    }
  }
}

リクエスト

パラメータはありません。

レスポンス

200 OK を返します。

dataobject
使用量
data.memberobject
メンバーの使用量
data.projectobject
プロジェクトの使用量
data.storageobject
ストレージの使用量
data.creditsobject?
クレジット。credits:read がない場合は null