コンテンツにスキップ

変更



POST /api/v1/data_query_rule/{query_rule_uuid}/modify

概要

データアクセスルールを全体更新します。

呼び出し前の確認と使用手順

まず詳細を取得し、書き込み可能なすべてのフィールドをバックアップしてから埋め戻してください。この API は全体を置き換えます。desc/indexes/sources/conditions/extend/logic/maskFields/reExprs を省略すると、それぞれ空文字列/[]/{}などの既定値に戻ります。名前だけを送信して他の設定が変わらないことを期待することはできません。regionCode を渡さないと空文字列が保存されます。タイプは既存レコードを引き継ぎ、この Body では変更できません。

イベント(keyevent)の作成には add_v2 を使用し、現在のサイトの regionCode を明示することを推奨します。旧 add/modify で regionCode を省略すると空文字列としてクロスサイト認可チェックに入り、通常はリージョンエラーが返ります。また v2 の変更は旧ルートに隠蔽されるため、現在の公開された変更操作ではイベントルール/クロスサイトルールのサイトを確実に保持できません。このような変更はコンソールから行い、実際に有効になっているかを確認してください。

この旧エントリポイントは regionCode を受け付けません。指定がない場合は空文字列が保存され、読み取り/クエリ時に現在のサイトとして解釈されます。明示的なソースサイトを保持する必要があるルールの変更には使用しないでください。

書き込みは設定を置き換え、データベースへコミットした後、ルールキャッシュをクリアして監査を記録します。クロスサイト検証ではリソース情報の読み取り/更新も発生する場合があります。処理は単一のアトミックトランザクションではないため、500 やタイムアウトの後はまず一覧/詳細で保存済みかどうかを確認し、むやみに再作成しないでください。

ルールの保存は、以降に条件を満たす ID のデータクエリ範囲/結果のマスキングに影響しますが、元データの変更・削除・再収集は行わず、ロールの基本クエリ権限を追加することもありません。複数のロールおよびルールはクエリ側のポリシーでマージされるため、1 つのルールだけから最終的な権限を推測することはできません。Owner は適用外であり、管理者およびワークスペースの「データアクセス範囲制限」設定はロールが一致しない場合の扱いを変えるため、代表メンバーで実際にクエリして検証してください。保存後はルールキャッシュが無効になりますが、すべての進行中クエリが即座に切り替わることは保証されません。

ルートパラメータ

パラメータ名 型 必須 説明
query_rule_uuid string Y パスルール UUID。名前やロール UUID は使用できません。読み取り/変更は現在のワークスペースの未削除項目のみが対象です。
例: lqrl_example
取得/入力方法: データアクセスルール一覧の content.data[].uuid から取得します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得/入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
indexes[*] string 配列の要素には空でない文字列を推奨します。元の宣言では項目ごとの強制はなく、誤った型は 500 の原因になります。
例: default
取得/入力方法: 単一のログインデックス UUID または default、あるいは認可済みの wksp_ソース:lgim_インデックスを指定します。
roleUUIDs[*] string 有効なロールを使用してください。アカウント UUID は使用しないでください。
例: role_example
取得/入力方法: 本ワークスペースで利用可能なロール uuid、または単独の * を指定します。
extend.カスタムキー any 任意のシリアライズ可能な JSON 値です。追加の発効条件ではありません。
例: production
取得/入力方法: 呼び出し元が定義する表示/編集用コンテキストで、実際の conditions と一致させてください。
reExprs[*] json name/enable/reExpr のみを使用することを推奨します。配列要素は元の宣言で構造が強制されておらず、オブジェクト以外は 500 になる可能性があります。
例: {"name": "token", "enable": true, "reExpr": "tkn_[0-9A-Za-z]+"}
取得/入力方法: 各オブジェクトが 1 つのマスキング式を定義します。
reExprs[*].name string 任意の表示名です。マッチング式としては使用されず、省略しても正規表現のマッチングに影響しません。
例: token
取得/入力方法: 業務で独自に定義する正規表現の表示名です。
reExprs[*].enable boolean 明示的なブール値を推奨します。省略時は未有効として扱われます。無効化した正規表現も構文が有効である必要があります。
例: true
取得/入力方法: 適用する場合は true、一時保存して適用しない場合は false を指定します。
reExprs[*].reExpr string 空でない正規表現を推奨します。現在は省略時に空文字列としてチェックされるため、サーバー側で有効な式が補完されることを前提にしないでください。
例: tkn_[0-9A-Za-z]+
取得/入力方法: 実際の機密コンテンツのパターンを指定します。JSON 文字列で使用する場合、バックスラッシュは二重に記述してください。
sources[*] string 上位の type に従って解釈される単一のソースで、空でない文字列を推奨します。
例: monitor
取得/入力方法: 対応するデータクエリ結果/ソース一覧から実際の識別子を取得します。イベントの source にはイベント ID やモニター UUID を指定しないでください。
conditions string フィルタ式のみを指定し、クエリ全体や外側の中括弧は指定しません。任意項目で、既定値は空文字列です。空文字列の場合、追加の絞り込みは行いません。 4048 文字以下を推奨します。keyevent では Python の文字数で 4048 以下かつ E クエリ構文を解析できることが特に求められ、その他のタイプでは保存時に条件の意味が全面的に検証されないため、成功しても将来のクエリ成功は保証されません。このルールはアクセスを許可するデータ範囲を定義します。
空文字列を許可: True
null を許可: False
例: `env` = 'production'
取得/入力方法: 対象データの実際のタグ/フィールドから DQL フィルタ条件を構築し、同じソースのクエリで事前に検証してください。
desc string 任意項目。最大 256(上記と同じ文字数単位)。省略または空文字列の場合は空にクリアされます。変更時も元の値を保持するわけではありません。
空文字列を許可: True
null を許可: False
最大長: 256
例: 仅允许查看生产环境数据。
取得/入力方法: 業務側がルールの目的と適用対象を記入します。
extend json 任意の JSON 表示を指定できます。省略時は {} です。統一された必須サブキーや単位はなく、サーバーがここから conditions を自動生成することはありません。変更時は全体が置き換えられます。認証情報を保存しないでください。
null を許可: False
例: {}
取得/入力方法: クライアントが独自のエディタの必要に応じて表示用設定を保存します。不要な場合は {} を指定します。
indexes array ログルールでは明示的に指定してください。宣言上は任意ですが、ログクエリには有効なインデックス範囲が必要で、[] を省略しても自動的にすべてになるわけではありません。["*"] は利用可能なすべてのログインデックスを意味します。* は単独で使用することを推奨します。[] は「すべて」ではありません。keyevent では強制的に [] が保存され、その他の非ログタイプでは通常 [] を使用します。通常のインデックス名を UUID の代わりに使用することはできず、認可が自動作成されることもありません。保存に成功してもリモートのすべてのリソースが有効であることは証明されません。
null を許可: False
例: ["default"]
取得/入力方法: ログインデックス一覧から uuid を取得し、既定のインデックスには default を使用します。クロスワークスペースでは認可済みのソースワークスペース UUID:インデックス UUID を使用します。
logic string 互換用の表示フィールドで、通常は and/or です。任意項目です。 省略すると空文字列が保存されます。実際に有効なフィルタは conditions を直接使用し、logic を変更しても条件は書き換えられません。複数ロール/複数ルールのマージはこのフィールドでは制御されません。
null を許可: False
例: and
取得/入力方法: クライアントのフィルタエディタにおける条件の組み合わせ方と一致させてください。
maskFields string 任意項目。省略時は空文字列となり、このルールのフィールドマスキングは設定されません。変更時に省略するとクリアされます。フィールドを選択し reExprs=[] の場合、非 null 値はフィールド全体が *** にマスクされます。空でない正規表現リストを指定した場合は有効な正規表現のみが適用され、すべて無効にしてもフィールド全体のマスクにはなりません。ストレージ列に合わせて 256 文字以下を推奨します。
空文字列を許可: True
null を許可: False
例: message
取得/入力方法: クエリ結果の実際のフィールド名から選択し、複数は半角カンマで区切ります(例: message,user_email)。* で全選択する場合は単独で使用し、具体的なフィールドと混在させないでください。
name string Y 宣言上必須です。空でない一意な名前を推奨します。空文字列でも自動命名の分岐に入る可能性がありますが、この互換動作に依存しないでください。 最大 64 カウント単位(ASCII/半角カタカナは 1、その他の文字は 2)。有効・無効を問わず同タイプのルールが重複名チェックの対象です。
空文字列を許可: False
null を許可: False
最大長: 64
例: production_only
取得/入力方法: 業務側で命名します。事前にデータアクセスルール一覧で同タイプの既存名を確認してください。
reExprs array 任意項目。省略時は [] で、変更時は全体が置き換えられます。保存時には enable=false の項目も含め、各正規表現が検証されます。誤った正規表現は ft.ErrorRegularExpression を返します。任意の文字列を表すのに単独の * を使用せず、.* を使用してください。選択したフィールドに正規表現がない場合はフィールド全体が *** になります。正規表現は文字列内容のマッチ部分のみを処理し、マッチした内容を *** に置き換えます。保存時の検証と実行エンジンには差異があるため、保存成功後も代表的なクエリで検証してください。
null を許可: False
例: [{"name": "token", "enable": true, "reExpr": "tkn_[0-9A-Za-z]+"}]
取得/入力方法: 機密値の形式に合わせて Python re で実行可能な正規表現を記述し、あらかじめマスキング済みサンプルで検証してください。maskFields と組み合わせて使用します。
roleUUIDs array Y 必須の配列です。["*"] は各ロールを表し、Owner は引き続きデータアクセス制限の対象外です。[] はどのロールにも一致せず、「すべて」ではありません。イベント(keyevent)では空でない文字列配列が必須で、* は単独でのみ指定できます。その他のタイプではスコープ内にロールが存在するかを検証しますが、ロールの status=0 は保証されません。基本クエリ権限は別途必要です。
null を許可: False
例: ["role_example"]
取得/入力方法: ロール一覧から本ワークスペースのロール uuid を取得します。ワークスペースメンバー一覧でメンバーの実際のロールを確認できます。
sources array 非ログ範囲の配列です。["*"] は利用可能なすべてのソースを表します。[] を省略しても「すべて」を意味しません。logging では強制的に [] が保存されます。rum/lineage は認可済みワークスペース UUID:ソース識別子で限定できます。tracing/metric/keyevent は元のソース文字列を使用します。keyevent では空でない文字列配列が必須で、wksp_:ソース は受け付けず、* を他の値と混在させることもできません。rum は現在の regionCode を明示した場合にのみアプリの存在をクエリして確認します。その他のソースは保存に成功しても実際にデータがあることは証明されません。
null を許可: False
例: ["*"]
取得/入力方法: 非ログの場合は実際のデータソースに従って入力します。rum は RUM アプリケーション一覧 の appId、tracing は service、metric はメジャーメント名、lineage は実際のログソース source、keyevent は monitor などのイベント source を使用します。

パラメータ補足説明

1. リクエストパラメータの説明

パラメータ名 type 必須 説明
name string Y 名前
desc String N 説明
indexes array Y type が logging の場合は必須です。自ワークスペース以外(ワークスペース認可が必要)のインデックス認可の場合は、ワークスペース UUID:インデックス UUID を使用します。例: ["wksp_111:lgim_222", "wksp_333:lgim_444"]
sources array Y type が logging 以外の場合は必須です。type が rum の場合はアプリの appId リスト、type が tracing の場合はサービス名のリスト、type が metric の場合はメジャーメントのリストです。
roleUUIDs array Y ロール UUID リスト
conditions string N 実際に使用するデータ範囲のフィルタ条件。例: "device IN ['PC'] and session_has_replay IN ['1']"
extend dict Y 拡張フィールド。conditions の構造内容を保持し、フロントエンド画面の表示に使用します。例: {"device": [ "PC"], "session_has_replay": [1]}
logic string N 論理フィールド(and/or)。フィルタ条件の結合に使用します。
maskFields string N マスキング対象フィールド。複数のフィールドはカンマで区切ります。
reExprs array N 正規表現。例: [{"name":"1111","enable":true,"reExpr":"tkn_[\da-z]*"},{"name":"liuyltest","enable":true,"reExpr":"test"}]

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/data_query_rule/lqrl_example/modify' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"production_only","desc":"仅允许查看生产环境数据。","indexes":["default"],"sources":[],"roleUUIDs":["role_example"],"conditions":"`env` = '"'"'production'"'"'","extend":{},"logic":"and","maskFields":"message","reExprs":[{"name":"token","enable":true,"reExpr":"tkn_[0-9A-Za-z]+"}]}'

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。

フィールド 型 説明
content.id integer または null レコード番号。作成時はコミット前のスナップショットが返るため null になる可能性があり、以降の操作には uuid を使用します。
content.uuid string lqrl_ ルール UUID。両モジュールはエンティティと識別子を共有します。
content.workspaceUUID string このルールが属するワークスペース。ソースワークスペースとは区別されます。
content.status integer 0 有効、2 無効、3 削除。本モジュールの読み取りは未削除のみが対象です。
content.creator string 作成した ID。
content.updator string 最後に更新した ID。初期は空の場合があります。
content.createAt integer 作成時の Unix 秒。
content.updateAt integer 更新時の Unix 秒。未更新の場合は -1。
content.deleteAt integer 削除時の Unix 秒。未削除の場合は -1。
content.name string 保存値: 宣言上必須です。空でない一意な名前を推奨します。空文字列でも自動命名の分岐に入る可能性がありますが、この互換動作に依存しないでください。 最大 64 カウント単位(ASCII/半角カタカナは 1、その他の文字は 2)。有効・無効を問わず同タイプのルールが重複名チェックの対象です。
content.desc string 保存値: 任意項目。最大 256(上記と同じ文字数単位)。省略または空文字列の場合は空にクリアされます。変更時も元の値を保持するわけではありません。
content.indexes array 保存値: ログルールでは明示的に指定してください。宣言上は任意ですが、ログクエリには有効なインデックス範囲が必要で、[] を省略しても自動的にすべてになるわけではありません。["*"] は利用可能なすべてのログインデックスを意味します。* は単独で使用することを推奨します。[] は「すべて」ではありません。keyevent では強制的に [] が保存され、その他の非ログタイプでは通常 [] を使用します。通常のインデックス名を UUID の代わりに使用することはできず、認可が自動作成されることもありません。保存に成功してもリモートのすべてのリソースが有効であることは証明されません。
content.indexes[] string 保存値: 配列の要素には空でない文字列を推奨します。元の宣言では項目ごとの強制はなく、誤った型は 500 の原因になります。
content.roleUUIDs array 保存値: 必須の配列です。["*"] は各ロールを表し、Owner は引き続きデータアクセス制限の対象外です。[] はどのロールにも一致せず、「すべて」ではありません。イベント(keyevent)では空でない文字列配列が必須で、* は単独でのみ指定できます。その他のタイプではスコープ内にロールが存在するかを検証しますが、ロールの status=0 は保証されません。基本クエリ権限は別途必要です。
content.roleUUIDs[] string 保存値: 有効なロールを使用してください。アカウント UUID は使用しないでください。
content.conditions string 保存値: フィルタ式のみを指定し、クエリ全体や外側の中括弧は指定しません。任意項目で、既定値は空文字列です。空文字列の場合、追加の絞り込みは行いません。 4048 文字以下を推奨します。keyevent では Python の文字数で 4048 以下かつ E クエリ構文を解析できることが特に求められ、その他のタイプでは保存時に条件の意味が全面的に検証されないため、成功しても将来のクエリ成功は保証されません。このルールはアクセスを許可するデータ範囲を定義します。
content.extend json 保存値: 任意の JSON 表示を指定できます。省略時は {} です。統一された必須サブキーや単位はなく、サーバーがここから conditions を自動生成することはありません。変更時は全体が置き換えられます。認証情報を保存しないでください。
content.extend.カスタムキー any 保存値: 任意のシリアライズ可能な JSON 値です。追加の発効条件ではありません。
content.logic string 保存値: 互換用の表示フィールドで、通常は and/or です。任意項目です。 省略すると空文字列が保存されます。実際に有効なフィルタは conditions を直接使用し、logic を変更しても条件は書き換えられません。複数ロール/複数ルールのマージはこのフィールドでは制御されません。
content.maskFields string 保存値: 任意項目。省略時は空文字列となり、このルールのフィールドマスキングは設定されません。変更時に省略するとクリアされます。フィールドを選択し reExprs=[] の場合、非 null 値はフィールド全体が *** にマスクされます。空でない正規表現リストを指定した場合は有効な正規表現のみが適用され、すべて無効にしてもフィールド全体のマスクにはなりません。ストレージ列に合わせて 256 文字以下を推奨します。
content.reExprs array 保存値: 任意項目。省略時は [] で、変更時は全体が置き換えられます。保存時には enable=false の項目も含め、各正規表現が検証されます。誤った正規表現は ft.ErrorRegularExpression を返します。任意の文字列を表すのに単独の * を使用せず、.* を使用してください。選択したフィールドに正規表現がない場合はフィールド全体が *** になります。正規表現は文字列内容のマッチ部分のみを処理し、マッチした内容を *** に置き換えます。保存時の検証と実行エンジンには差異があるため、保存成功後も代表的なクエリで検証してください。
content.reExprs[] json 保存値: name/enable/reExpr のみを使用することを推奨します。配列要素は元の宣言で構造が強制されておらず、オブジェクト以外は 500 になる可能性があります。
content.reExprs[].name string 保存値: 任意の表示名です。マッチング式としては使用されず、省略しても正規表現のマッチングに影響しません。
content.reExprs[].enable boolean 保存値: 明示的なブール値を推奨します。省略時は未有効として扱われます。無効化した正規表現も構文が有効である必要があります。
content.reExprs[].reExpr string 保存値: 空でない正規表現を推奨します。現在は省略時に空文字列としてチェックされるため、サーバー側で有効な式が補完されることを前提にしないでください。
content.sources array 保存値: 非ログ範囲の配列です。["*"] は利用可能なすべてのソースを表します。[] を省略しても「すべて」を意味しません。logging では強制的に [] が保存されます。rum/lineage は認可済みワークスペース UUID:ソース識別子で限定できます。tracing/metric/keyevent は元のソース文字列を使用します。keyevent では空でない文字列配列が必須で、wksp_:ソース は受け付けず、* を他の値と混在させることもできません。rum は現在の regionCode を明示した場合にのみアプリの存在をクエリして確認します。その他のソースは保存に成功しても実際にデータがあることは証明されません。
content.sources[] string 保存値: 上位の type に従って解釈される単一のソースで、空でない文字列を推奨します。
content.type string 保存値: 新規作成時は logging/rum/tracing/metric/lineage/keyevent が必須です。宣言上は null を許可していますが、無効なタイプでは正常なクエリルールを形成できないため、常に上記の文字列を送信してください。変更では type を受け付けず、保存済みのタイプを引き継ぎます。
content.regionCode string 保存値: v2 では必須のソースサイトコードです。同一ルールのログインデックスは同一サイトに属し、この値と一致している必要があります。旧エントリポイントはこのフィールドを受け付けません。データアクセスルールはクロスサイト/クロスワークスペースの認可の代わりにはなりません。イベントのクロスサイトには keyevent または * を含む有効な認可が必要です。下部の重複ルートに関する実際の到達性の説明に注意してください。
content.declaration object 共通宣言。書き込みレスポンスにはソース/ロール/ID の要約は自動的に付加されません。
{
  "code": 200,
  "content": {
    "id": 100,
    "uuid": "lqrl_example",
    "workspaceUUID": "wksp_example",
    "name": "production_only",
    "desc": "仅允许查看生产环境数据。",
    "type": "logging",
    "indexes": [
      "default"
    ],
    "sources": [],
    "roleUUIDs": [
      "role_example"
    ],
    "conditions": "`env` = 'production'",
    "extend": {},
    "logic": "and",
    "maskFields": "message",
    "reExprs": [
      {
        "name": "token",
        "enable": true,
        "reExpr": "tkn_[0-9A-Za-z]+"
      }
    ],
    "regionCode": "",
    "status": 0,
    "creator": "wsak_example",
    "updator": "wsak_example",
    "createAt": 1785427200,
    "updateAt": 1785427300,
    "deleteAt": -1,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

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

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 パラメータの解析に失敗 パラメータの位置、フィールド名、型、値を確認してください。
400 ft.RequestJsonFormatError リクエスト JSON の構文が無効 リクエスト JSON の形式エラー content.reason、line、column に従って JSON を修正してください。
404 ft.NoInitOtherNodeCfg リモートのインデックス/RUM アプリケーションメタデータの読み取りまたは検証時に、利用可能なソースサイトアドレスが見つからない 他のノード設定が未初期化 管理者がソースサイト設定、アクセス可能なアドレス、有効なクロスワークスペース認可を確認し、修正後に再試行します。
400 ft.NameRepeat 本ワークスペースの同タイプに未削除の同名ルールが存在 名前は既に存在します 名前を変更するか、確認したうえで既存の UUID を更新してください。
400 ft.ErrorRegularExpression 無効化された項目を含め、いずれかの正規表現が無効 正規表現に誤りがあります すべての reExpr を修正してから再送信してください。単独の * は使用しないでください。
400 ft.InvalidRoleUUID ロールがワークスペースのスコープ内にない、または keyevent のロール配列が無効 無効なロール UUID: {} 本ワークスペースのロール一覧から有効な識別子を取得してください。イベントでは * を単独で使用します。
400 ft.InvalidLoggingIndex 現在のサイトのソースワークスペースで解析された通常インデックスが存在しない/削除済み 無効なインデックス:{} 有効なインデックス UUID/default を使用し、認可を確認してください。
400 ft.InvalidRegionDataQueryRuleIndex ログインデックスが複数サイトにまたがる、またはサイトが一致しない、イベントのクロスサイトに有効な認可がない {} サイトのインデックス情報が無効 サイトごとにルールを作成し、認可記録からソースとターゲットを確認してください。
500 ft.InternalServerError 配列項目の形状不一致、フィールドが保存長を超過、下流の一般的な 5xx、データベースまたはコミット後のキャッシュ失敗 内部エラー 本文の構造と長さを確認し、現在の設定を読み取って既に保存されているかを確認したうえで再試行を判断し、traceId を提供してください。
400 ft.InvalidSources keyevent のソース構造が無効、または現在のサイトを明示した rum ソースアプリが存在しない 無効なリソース情報:{} イベントには空でない source 文字列配列を指定し、* は単独で使用します。RUM は有効なアプリから appId を取得してください。
406 ft.InvalidParameter keyevent の conditions が文字列でない、または長さが 4048 文字を超えている パラメータ {} が無効 長さが規定内の DQL 条件文字列を使用してください。
406 ft.DqlParseError keyevent の条件を解析できない dql parser の解析に失敗: {} イベントクエリでフィルタ条件を検証し、元のエラーと traceId を保持してください。
404 ft.NotFoundDataQueryRuleCfg 本ワークスペースに対象ルールが存在しないか削除済み。ログエントリではさらに logging に限定 指定されたログクエリルール設定が見つかりません 正しいモジュールの一覧から UUID を再取得してください。

フィードバック

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