コンテンツにスキップ

使用量制限の更新



POST /api/v1/workspace/{workspace_uuid}/usage_limit/update

概要

指定したワークスペースの使用量制限設定を全体的に更新します。

呼び出し前の準備と使用手順

  1. 使用量制限の照会で現在の設定を読み取り、更新後の完全な config を準備します。この API は古い設定を全体置換するため、あるデータタイプを省略すると既存の設定項目が削除されます。

  2. 現在のサイトの External API 書き込み権限を使用して JSON を送信します。ワークスペース設定への書き込み後、サービスがデータサービスへ同期します。

  3. レスポンスエラーやタイムアウトが発生した場合は、まず当該ワークスペースに保存済みの config を確認して永続化されたかを判断し、その後に目標とする完全な設定で処理します。成功レスポンスを受信した場合、content は保存済みの設定レコードです。

DF_EXTERNAL_API_URL、DF_EXTERNAL_ACCESS_KEY、DF_EXTERNAL_SECRET_KEY を設定してからサンプルを実行します。サンプルのワークスペース UUID、ブランド、設定値を実際の値に置き換えてください。署名バージョンは v20240417 です。

ルートパラメータ

パラメータ名 型 必須 説明
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>
取得または入力方法: 例に従い、メソッド、nonce、パス、タイムスタンプ、および実際に送信する JSON のバイト列に対して HMAC-SHA256 を計算します。
X-Df-Timestamp string Y リクエスト時のタイムスタンプ
例: 1785456000
取得または入力方法: 呼び出し時の現在の Unix 秒を入力します(例: date +%s を実行)。
X-Df-Nonce string Y リクエスト時に生成する一時コード
例: b53b47e12e514616ad8cb1f17cb66dce
取得または入力方法: リクエストごとに新しいランダム値を生成します(例: uuid.uuid4().hex)。

Body リクエストパラメータ

パラメータ名 型 必須 説明
config json Y 使用可能なキーは logging(ログ)、tracing(分散型トレーシング)、rum(RUM)、dialing(Synthetic テスト)、profile(プロファイリング)、network(ネットワーク)、session_replay(セッションリプレイ)、keyevent(イベント)、siem(セキュリティ分析)、backup_log(ログバックアップ)、data_forwarding(データ転送)、metric(メトリクス)です。各項目の openLimit は必須のブール値、value は任意の整数です。{} を渡すと空の設定として保存されます。
null を許可: False
例: {"logging": {"openLimit": true, "value": 1000}}
取得または入力方法: 使用量制限の照会から既存の設定を読み取り、業務上の必要をマージしたうえで完全なオブジェクトを送信します。テナントの制限プランはサイト管理者が確認します。

パラメータ補足説明

対象のデータタイプごとに制限値を入力できます。データタイプごとに計量の基準が異なるため、実際の適用は対象サイトの設定に従います。

リクエスト例

import hmac
import json
import os
import time
import uuid
import requests

server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/workspace/wksp_example/usage_limit/update"
method = "POST"
body = json.dumps({'config': {'logging': {'openLimit': True, 'value': 1000}}}, ensure_ascii=False, separators=(',', ':')).encode('utf-8')
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = f"{method} {nonce} {path} {timestamp} ".encode("utf-8") + body
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload, "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,
    "Content-Type": "application/json",
}
response = requests.request(method, server + path, headers=headers, data=body, timeout=15)
response.raise_for_status()
data = response.json()["content"]

レスポンス

HTTP 200、application/json。

フィールド 型 説明
content.workspaceUUID string 設定が属するワークスペース。
content.keyCode string 設定キー。固定値は UsageLimit です。
content.config object 保存済みの完全な設定。
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"
}

エラー応答

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed フィールドの型、必須、または制約がパラメータ表に適合しない リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 フィールド、型、制約を確認します。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラーです。 content 内の reason、line、column を確認して修正します。
400 ft.JsonFormatError JSON 形式は有効だが、Body 全体が JSON オブジェクトではない JSON 形式エラーです。 パラメータを波括弧で構成した JSON オブジェクト内に配置します。
400 ft.ParamsValidateError 設定オブジェクトに未知のデータタイプやキーが含まれる、またはフィールドに openLimit がない/型が一致しない パラメータ検証に失敗しました。メッセージにフィールドの詳細が含まれます。 パラメータの説明に従って config の各項目を確認します。
406 ft.KodoCommonApiErr 同期または日次使用量の照会が 200 を返さず、他のステータスにも直接マッピングされていない。一部の上流エラーでは上流の HTTP ステータスが保持されます。 システム内部エラーです。上流のエラー内容が含まれる場合があります。 まず保存済みの設定を照会し、その後に同期状態を確認します。

フィードバック

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