変更¶
POST /api/v1/logging_query_rule/{logging_query_rule_uuid}/modify
概要¶
ログアクセスルールを全体更新します。
呼び出し前の確認と使用手順¶
まず詳細を読み取り、バックアップして、書き込み可能なすべてのフィールドを埋め戻してください。この API は全体を置換します。desc/indexes/sources/conditions/extend/logic/maskFields/reExprs を省略すると、それぞれ空文字列/[]/{} などのデフォルトに戻ります。名前だけを送信して他の設定が変わらないことを期待することはできません。regionCode を送信しない場合は空文字列が保存されます。タイプは元のレコードを引き継ぎ、この Body では変更できません。
この旧エンドポイントは regionCode を受け付けません。未指定の場合は空文字列が保存され、読み取り/クエリ時に現在のサイトとして解釈されます。明示的なソースサイトを保持する必要があるルールの変更には使用しないでください。
書き込みは設定を置換し、データベースへコミットした後、ルールキャッシュをクリアして監査を記録します。クロスサイト検証では、リソース情報の読み取り/更新も行われる場合があります。この手順は単一のアトミックトランザクションではありません。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 | 明示的な 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 と組み合わせて使用します。 |
|
| 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"}] |
リクエスト例¶
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 | 保存値:明示的な 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 を再取得してください。 |