単一のデータアクセスルールを作成¶
POST /api/v1/logging_query_rule/add
概要¶
ログアクセスルール(v2 のレガシー宣言)を作成します。
呼び出し前の確認と使用手順¶
まずデータドメイン、ロール、ソース、DQL 条件を確定してから、一意の名前で作成します。新しいルールは status=0 で直ちに有効になりますが、書き込みが成功しても、ソースにデータが存在することや最終的なメンバー権限が想定どおりであることを証明するものではありません。
現在の v2 宣言は旧インターフェースと同じ Method と URL を持ちますが、実際の HTTP リクエストはまず旧エントリポイントに一致します。regionCode を渡すと、未知の Body フィールドとして ft.ParameterValidationFailed が返されます。本ページの宣言表にある regionCode は過去の v2 契約を反映したものであり、現在これに基づいてクロスサイト機能を呼び出すことはできません。以下の実行可能な例では、同じパスの旧エントリポイントで有効なフィールドを使用し、regionCode は渡しません。レスポンスも旧エントリポイントによる保存結果です。明示的なサイトが必要な機能では、到達可能な汎用作成インターフェース data_query_rule.add_v2 またはコンソールを使用し、存在しない /v2 パスを追加しようとしないでください。
書き込みでは設定を置き換えてデータベースにコミットし、その後ルールキャッシュをクリアして監査を記録します。クロスサイト検証ではリソース情報の読み取り/更新も行われる場合があります。この手順は単一のアトミックトランザクションではないため、500 やタイムアウトが発生した場合は、まず一覧/詳細で保存済みかどうかを確認し、むやみに重複作成しないでください。
ルールの保存は、以降に条件を満たすアイデンティティのデータクエリ範囲/結果マスキングに影響しますが、元データの変更、削除、再収集は行わず、ロールの基本クエリ権限を追加することもありません。複数のロールおよびルールはクエリ側のポリシーに従って統合されるため、単一のルールだけから最終権限を推測することはできません。Owner は免除され、管理者およびワークスペースの「データアクセス範囲制限」設定は、一致するロールがない場合の処理を変更します。代表的なメンバーを使用して実際のクエリで受け入れ確認を行ってください。保存後はルールキャッシュが無効になりますが、すべての進行中のクエリが即時に切り替わることを保証するものではありません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 | Y | 互換性のための表示用フィールドで、通常は 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/add' \
-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": null,
"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": "",
"createAt": 1785427200,
"updateAt": -1,
"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 を提供してください。 |