単一データアクセスルールの作成¶
POST /api/v1/logging_query_rule/add
概要¶
単一のデータアクセスルールを作成します。v2 では複数サイトにわたるデータアクセス設定をサポートしています。
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| name | string | 名称 (2024-09-04 リリースで追加、デフォルト名、作成者_作成時間) 空を許可: False 空文字列を許可: False 最大長: 64 |
|
| desc | string | 説明 (2024-09-04 リリースで追加) 例: 説明1 空を許可: False 空文字列を許可: True 最大長: 256 |
|
| regionCode | string | Y | サイトベースのデータアクセス認可 空を許可: False 空文字列を許可: False |
| indexes | array | Y | インデックス UUID。[""] はすべてを意味します 例: [''] 空を許可: False |
| roleUUIDs | array | Y | ロールのリスト 例: [] 空を許可: False |
| conditions | string | Y | フィルタ検索 例: search 空を許可: False |
| extend | json | フロントエンドカスタム拡張フィールド 例: xxx 空を許可: False |
|
| logic | string | Y | 論理フィールド 例: or 空を許可: False |
| maskFields | string | マスキングフィールド。複数のフィールドはカンマで区切ります 例: message,host 空を許可: False 空文字列を許可: True |
|
| reExprs | array | 正規表現 例: [{'name': 'jjj', 'reExpr': 'ss', 'enable': 0}, {'name': 'lll', 'reExpr': 'ss', 'enable': 1}] 空を許可: False |
パラメータ補足説明¶
データ説明.*
1. ロール認可アクセス説明
- 指定されたロールは、指定されたクエリ範囲内のデータのみをクエリできます。
- ユーザーが複数のロールを持つ場合、そのユーザーがこのルールのロールに含まれていないロールを持っている場合、そのデータアクセスルールはそのユーザーに適用されません。つまり、クエリ範囲は制限されません。
- 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 の構造内容を格納し、フロントエンドページの表示に使用します。例: |
| 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 | サイトコード（workspace/website/list エンドポイントから取得可能）。データアクセス設定のサイト情報。デフォルトでは現在のサイトのデータを認可します |
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/logging_query_rule/add' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw $'{"name":"temp_test","desc":"test openapi","roleUUIDs":["general","role_3ac3042991c046f0b03452771012b268"],"indexes":["wksp_4b57c7bab38e4a2d9630f675dc20015d:lgim_f2a50518520b467a920103a19133fa8b","wksp_eee1a762ed954b7588e30d9bccb717d5:lgim_72143917855c48abae5d4fb1d2fb7a1f"],"extend":{"city":["Tafuna"]},"maskFields":"message","logic":"and","reExprs":[{"name":"qq email maxk","reExpr":"[a-zA-Z0-9_]+@guance.com","enable":true}],"conditions":"`city` IN [\'Tafuna\']"}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"conditions": "`city` IN ['Tafuna']",
"createAt": 1730529443,
"creator": "wsak_cd83804176e24ac18a8a683260ab0746",
"declaration": {
"asd": "aa,bb,cc,1,True",
"asdasd": "dawdawd",
"business": "aaa",
"dd": "dd",
"fawf": "afawf",
"organization": "64fe7b4062f74d0007b46676"
},
"deleteAt": -1,
"desc": "test openapi",
"extend": {
"city": [
"Tafuna"
]
},
"id": null,
"indexes": [
"wksp_4b57c7bab38e4a2d9630f675dc20015d:lgim_f2a50518520b467a920103a19133fa8b",
"wksp_eee1a762ed954b7588e30d9bccb717d5:lgim_72143917855c48abae5d4fb1d2fb7a1f"
],
"logic": "and",
"maskFields": "message",
"name": "temp_test",
"reExprs": [
{
"enable": true,
"name": "qq email maxk",
"reExpr": "[a-zA-Z0-9_]+@guance.com"
}
],
"roleUUIDs": [
"general",
"role_3ac3042991c046f0b03452771012b268"
],
"sources": [],
"status": 0,
"type": "logging",
"updateAt": null,
"updator": null,
"uuid": "lqrl_9f1de1d1440f4af5917a534299d0ad09",
"workspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-25C229E5-150F-4DF1-8576-DE17259B7A16"
}