User Storage Usage API

概要: ユーザー（またはスペース）のストレージ使用量と上限（クォータ）を取得するAPIです。アップロード前に空き容量を確認できます。

GET /v1/user/storage/usage

ストレージ使用量とクォータを取得します。

GET /v1/user/storage/usage

Headers

• api-key : string(required) - rokadoc APIキー

Query Parameters

必須パラメータ

なし

オプショナルパラメータ

• space_id : string(optional) - スペース機能を利用する場合はIDを入力。指定するとそのスペースの使用量を取得します

Request Example

Python

import requests
import os

api_key = os.getenv("ROKADOC_API_KEY")
space_id = os.getenv("SPACE_ID")

url = "https://api.rokadoc.ntt.com/v1/user/storage/usage"

headers = {
    "api-key": api_key
}

params = {
    "space_id": space_id
}

response = requests.get(url, headers=headers, params=params)

print(response.json())

curl

curl -X 'GET' \
"https://api.rokadoc.ntt.com/v1/user/storage/usage?space_id=${SPACE_ID}" \
-H "api-key: ${ROKADOC_API_KEY}"

Response

200 OK - 使用量取得成功

{
    "code": 200,
    "data": {
        "used_bytes": 1048576,
        "quota_bytes": 10737418240,
        "free_bytes": 53687091200
    }
}

• code : integer - ステータスコード
• data : object - 使用量情報
  • used_bytes : integer - 使用量の合計バイト数
  • quota_bytes : integer | null - 上限バイト数。クォータが無効（無制限）の場合は null
  • free_bytes : integer | null - ストレージの物理的な空きバイト数。取得できない環境では null

注意事項

• used_bytes には、変換後PDFのほかJSONやページ画像などの派生ファイルも含まれます
• クォータを超えるアップロードは 413 で拒否されます
• スペースの使用量を取得する場合は、そのスペースの参照権限が必要です