単一のデータアクセスルールを変更¶
POST /api/v1/logging_query_rule/{logging_query_rule_uuid}/modify
概要¶
ログアクセスルールを全体的に変更します(v2 の履歴宣言)。
呼び出し前の準備と使用手順¶
まず詳細を読み取り、バックアップして書き込み可能なフィールドをすべて埋め戻してください。このインターフェースは全体を置き換えます。desc/indexes/sources/conditions/extend/logic/maskFields/reExprs を省略すると、それぞれ空文字列/[]/{}などのデフォルトに戻ります。名前だけを送信して他の設定が変わらないことを期待することはできません。regionCode を渡さない場合は空文字列が保存されます。型は元のレコードを引き継ぎ、この Body では変更できません。
現在の v2 宣言は旧インターフェースと同じ Method と URL を持ちますが、実際の HTTP では先に旧エントリポイントにマッチします。regionCode を渡すと未知の Body フィールドとして ft.ParameterValidationFailed が返されます。本ページの宣言表にある regionCode は歴史的な v2 契約を反映しており、現在これに基づいてクロスサイト機能を呼び出すことはできません。以下の実行可能な例では同じパスの旧エントリポイントの有効なフィールドを使用し、regionCode は渡しません。レスポンスも旧エントリポイントの保存結果です。明示的なサイトが必要な機能は、到達可能な汎用作成インターフェース data_query_rule.add_v2 またはコンソールを使用し、架空の /v2 パスを追加しようとしないでください。
書き込みは設定を置き換え、データベースにコミットし、その後ルールキャッシュをクリアして監査を記録します。クロスサイト検証ではリソース情報の読み取り/更新も行われる場合があります。手順は単一のアトミックトランザクションではないため、500/タイムアウト後はまず一覧/詳細から保存済みかどうかを確認し、盲目的な重複作成を避けてください。
ルールの保存は、以降に条件を満たす身元のデータクエリ範囲/結果マスキングに影響しますが、元データの変更、削除、再収集は行わず、ロールの基礎クエリ権限も追加しません。複数のロールおよびルールはクエリ側のポリシーに従ってマージされるため、単一のルールだけで最終的な権限を推測することはできません。Owner は免除され、管理者およびワークスペースの「データアクセス範囲制限」設定は一致するロールがない場合の処理を変えるため、代表的なメンバーで実際にクエリを実行して受け入れ確認してください。保存後はルールキャッシュが無効化されますが、すべての進行中のクエリが即時に切り替わることを保証するものではありません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| logging_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 文字列で使用する場合、バックスラッシュは二重に記述する必要があります。 |
|
| conditions | string | Y | フィルタ式のみを記入し、クエリ全体や外側の中括弧は記入しません。本モジュールでは必須の文字列として宣言されています。4048 文字以内を推奨します。keyevent は Python の文字数で ≤4048 文字として専用にチェックされ、E クエリ構文を解析します。その他の型は保存時に条件の意味が全面的に検証されないため、成功しても将来のクエリの成功を保証するものではありません。このルールはアクセスを許可するデータ範囲を定義します。 null 許容: False 例: `env` = 'production'取得または入力方法: 対象データの実際のタグ/フィールドから DQL フィルタ条件を構築し、まず同じソースでクエリを実行して検証します。 |
| desc | string | オプション。最大 256(上記と同じカウント単位)。省略/空文字列の場合は空にクリアされます。変更時は元の値が保持されるわけではありません。 空文字列許容: True null 許容: False 最大長: 256 例: 仅允许查看生产环境数据。取得または入力方法: 業務側がルールの目的と適用対象を記入します。 |
|
| extend | json | 任意の JSON をオプションでエコーバックできます。省略時は {}。統一された必須サブキーや単位はなく、サーバーはこれから conditions を自動生成しません。変更時は全体を置き換えます。資格情報を保存しないでください。 null 許容: False 例: {}取得または入力方法: クライアントは自身のエディタの必要に応じて表示用設定を保存します。不要な場合は {}。 |
|
| indexes | array | Y | ログルールでは明確に指定する必要があります。本モジュールでは必須として宣言されています。["*"] は利用可能なすべてのログインデックスを表します。* は単独で使用することを推奨します。[] はすべてを表しません。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 | 省略可能。省略/空文字列の場合は呼び出し身元の表示名と現在の Unix 秒に基づいて生成が試みられます。変更時も同様に再生成され、旧名称は保持されません。最大 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 と組み合わせて使用します。 |
|
| regionCode | string | Y | v2 宣言では必須のソースサイトコードです。同一ルールのログインデックスは同じサイトに属し、この値と一致する必要があります。旧エントリポイントはこのフィールドを受け付けません。データアクセスルールはクロスサイト/クロスワークスペース認可の代替にはなりません。イベントのクロスサイトには keyevent または * を含む有効な認可が必要です。下部の重複ルートの実際の到達可能性に関する説明に注意してください。 空文字列許容: False null 許容: False 例: example-region取得または入力方法: 対象ソースサイトおよび有効なクロスワークスペース認可一覧 から実際の regionCode を確認します。現在のサイトもその正式なコードを使用し、例のリテラル値を入力しないでください。 |
| roleUUIDs | array | Y | 必須の配列です。["*"] は各ロールを表し、Owner は引き続きデータアクセス制限を受けません。[] はどのロールにも一致せず、すべてを表すわけではありません。イベント keyevent は空でない文字列配列である必要があり、* は単独でのみ出現できます。その他の型はスコープ内のロールの存在を検証しますが、ロールの status=0 は保証しません。基礎クエリ権限は別途備えている必要があります。 null 許容: False 例: ["role_example"]取得または入力方法: ロール一覧 から本ワークスペースのロール uuid を取得します。ワークスペースメンバー一覧 でメンバーの実際のロールを確認できます。 |
パラメータ補足説明¶
データ説明。*
1. ロール認可アクセスの説明 1. 指定されたロールは、指定されたクエリ範囲内のデータのみをクエリできます。 2. ユーザーが複数のロールを持つ場合、そのユーザーのロールがこのルールのロールに含まれていなければ、このデータアクセスルールはそのユーザーに対して有効にならず、クエリ範囲を制限しません。 3. 1 つのワークスペース内の複数のログデータアクセスルール間の論理は or 関係です。
2. リクエストパラメータの説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | 名前 |
| desc | String | N | 説明 |
| indexes | array | Y | ログインデックス情報。本ワークスペース以外(ワークスペース認可が必要)のインデックス認可の場合は、ワークスペース UUID:インデックス UUID を使用します。例: ["wksp_111:lgim_222", "wksp_333:lgim_444"] |
| 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"}] |
| regionCode | string | Y | サイト code(workspace/website/list インターフェースで取得可能)。データアクセス設定のサイト情報で、デフォルトでは現在のサイトのデータを認可します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/logging_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"],"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。2 つのモジュールが実体と識別子を共有します。 |
| content.workspaceUUID | string | このルールが属するワークスペース。ソースワークスペースとは区別されます。 |
| content.status | integer | 0 有効、2 無効、3 削除。本モジュールの読み取りは削除されていないもののみです。 |
| content.creator | string | 作成した身元。 |
| content.updator | string | 最後に更新した身元。初期は空の場合があります。 |
| content.createAt | integer | 作成 Unix 秒。 |
| content.updateAt | integer | 更新 Unix 秒。未更新の場合は -1。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除の場合は -1。 |
| content.name | string | 保存値: 省略可能。省略/空文字列の場合は呼び出し身元の表示名と現在の Unix 秒に基づいて生成が試みられ、変更時も同様に再生成され、旧名称は保持されません。最大 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 | 共通宣言。書き込みレスポンスにはソース/ロール/身元の概要が自動的に付加されません。 |
{
"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 を提供してください。 |
| 404 | ft.NotFoundDataQueryRuleCfg | 本ワークスペースの対象ルールが存在しないか削除済み、ログエントリポイントではさらに logging に限定される | 指定されたログクエリルール設定が見つかりません | 正しいモジュールの一覧から UUID を再取得してください。 |