コンテンツにスキップ

使用量制限の照会



GET /api/v1/workspace/{workspace_uuid}/usage_limit/get

概要

指定されたワークスペースに保存されている使用量制限設定を読み取ります。

呼び出し前および使用手順

ワークスペース一覧の UUID を使用して照会します。有効なレコードがまだ存在しない場合、HTTP 200 かつ content は {} です。空のオブジェクトは、そのワークスペース専用の制限レコードが見つからなかったことのみを示します。書き込みを継続できるかどうかを判断するには、サイトと製品のクォータも確認する必要があります。

例では External API 署名バージョン v20240417 を使用します。対象サイトの External API アドレス、Access Key、Secret Key をそれぞれ DF_EXTERNAL_API_URL、DF_EXTERNAL_ACCESS_KEY、DF_EXTERNAL_SECRET_KEY に設定します。例内の ID は実際の値に置き換えてください。

ルートパラメータ

パラメータ名 型 必須 説明
workspace_uuid string Y 対象ワークスペースの UUID。
例: wksp_example
取得または入力方法: ワークスペース一覧のレスポンスにある content.data[].uuid から取得し、元の値を使用します。

リクエストヘッダー

パラメータ名 型 必須 説明
X-Df-SVersion string 署名バージョン。以下の例では v20240417 を使用します。
例: v20240417
取得または入力方法: 例のとおりに入力し、署名アルゴリズムに対応させます。
X-Df-Access-Key string Y リクエストの AK 情報
例: <access-key>
取得または入力方法: External API 管理者によって割り当てられます。
X-Df-Signature string Y 署名情報
例: <hex-signature>
取得または入力方法: Secret Key を使用し、GET、nonce、リクエストパスと元のクエリ文字列、タイムスタンプ、空文字列で構成されるテキストに対して HMAC-SHA256 を実行し、16 進数の結果を取得します。
X-Df-Timestamp string Y リクエスト時のタイムスタンプ
例: 1785456000
取得または入力方法: 呼び出し時の現在の Unix 秒を入力します。例: date +%s を実行します。
X-Df-Nonce string Y リクエスト時に生成する一時コード
例: b53b47e12e514616ad8cb1f17cb66dce
取得または入力方法: リクエストごとに新しいランダム値を生成します。例: uuid.uuid4().hex。

パラメータの補足説明

現在の対象サイトに割り当てられた External API 署名認証情報を使用します。

リクエスト例

import hmac
import os
import time
import uuid
from urllib.parse import urlencode
import requests

server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/workspace/wksp_example/usage_limit/get"
query = {}
if query:
    path += "?" + urlencode(query)
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = " ".join(("GET", nonce, path, timestamp, ""))
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload.encode(), "sha256").hex()
headers = {
    "X-Df-Access-Key": os.environ["DF_EXTERNAL_ACCESS_KEY"],
    "X-Df-Timestamp": timestamp,
    "X-Df-Nonce": nonce,
    "X-Df-SVersion": "v20240417",
    "X-Df-Signature": signature,
}
result = requests.get(server + path, headers=headers, timeout=15)
result.raise_for_status()
data = result.json()["content"]

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.workspaceUUID string 制限が属するワークスペース。
content.keyCode string 設定キー。現在は UsageLimit です。
content.config object データタイプごとに構成された制限設定。例: logging。各タイプの制限はそれぞれの単位を使用します。
content.config.<データタイプ>.openLimit boolean そのデータタイプの制限設定が有効かどうか。
content.config.<データタイプ>.value integer 任意の制限値。単位はデータタイプによって決まります。
{
  "code": 200,
  "content": {
    "workspaceUUID": "wksp_example",
    "keyCode": "UsageLimit",
    "config": {
      "logging": {
        "openLimit": true,
        "value": 1000
      }
    }
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

照会にはワークスペースが存在しない場合の個別エラーはありません。共通の認証エラーおよび実際のレスポンス内容に基づいて判断してください。

フィードバック

このページは役に立ちましたか?