単一データアクセスルールの変更¶
POST /api/v1/data_query_rule/{query_rule_uuid}/modify
概要¶
単一のデータアクセスルールを変更します。v2 ではワークスペース間のデータアクセス設定をサポートします。
ルートパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| query_rule_uuid | string | Y | ルールの UUID |
Body リクエストパラメータ¶
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| name | string | Y | 名称 空を許可: False 空文字列を許可: False 最大長: 64 |
| desc | string | 説明 例: 説明1 空を許可: False 空文字列を許可: True 最大長: 256 |
|
| regionCode | string | Y | ワークスペースに基づくデータアクセス権限 空を許可: False 空文字列を許可: False |
| indexes | array | ログタイプの場合必須、インデックス UUID、[""] はすべてを意味します 例: [''] 空を許可: False |
|
| sources | array | リソース UUID、["*"] はすべてを意味します 例: ['appid_96357a78f84041d28b5d7aaa6201a424'] 空を許可: False |
|
| roleUUIDs | array | Y | ロールのリスト 例: [] 空を許可: False |
| conditions | string | フィルター検索 例: search 空を許可: False 空文字列を許可: True |
|
| extend | json | カスタム 例: xxx 空を許可: False |
|
| logic | string | 論理フィールド 例: or 空を許可: False |
|
| maskFields | string | マスクフィールド、複数フィールドはカンマ区切り 例: message,host 空を許可: False 空文字列を許可: True |
|
| reExprs | array | 正規表現 例: [{'name': 'AA', 'reExpr': 'ss', 'enable': 0}, {'name': 'BB', 'reExpr': '.*', 'enable': 1}] 空を許可: False |
パラメータ補足説明¶
1. リクエストパラメータ説明
| パラメータ名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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 のリスト、tracing の場合はサービス名のリスト、metric の場合はメジャーメントのリスト |
| 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/data_query_rule/lqrl_xxx/modify' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw $'{"name":"rum test","desc":"","roleUUIDs":["role_a1e8215c25474f0bb3809f2d56749ed9","role_aa49795a5a5a4753a2a6350ab57f9497"],"indexes":[],"sources":["a2727170_7b1a_11ef_9de6_855cb2bccffb"],"extend":{"env":["front"],"province":["jiangsu"]},"maskFields":"source","logic":"and","conditions":"`env` IN [\'front\'] and `province` IN [\'jiangsu\']","reExprs":[{"name":"liuyl","reExpr":".*","enable":true}]}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"conditions": "`env` IN ['front'] and `province` IN ['jiangsu']",
"createAt": 1730532068,
"creator": "wsak_cd83804176e24ac18a8a683260ab0746",
"declaration": {
"asd": "aa,bb,cc,1,True",
"asdasd": "dawdawd",
"business": "aaa",
"dd": "dd",
"fawf": "afawf",
"organization": "64fe7b4062f74d0007b46676"
},
"deleteAt": -1,
"desc": "",
"extend": {
"env": [
"front"
],
"province": [
"jiangsu"
]
},
"id": 351,
"indexes": [],
"logic": "and",
"maskFields": "source",
"name": "rum test",
"reExprs": [
{
"enable": true,
"name": "liuyl",
"reExpr": ".*"
}
],
"roleUUIDs": [
"role_a1e8215c25474f0bb3809f2d56749ed9",
"role_aa49795a5a5a4753a2a6350ab57f9497"
],
"sources": [
"a2727170_7b1a_11ef_9de6_855cb2bccffb"
],
"status": 0,
"type": "rum",
"updateAt": 1730532375.5740402,
"updator": "wsak_cd83804176e24ac18a8a683260ab0746",
"uuid": "lqrl_dfe6330883ef4311afae5d380e2294a1",
"workspaceUUID": "wksp_4b57c7bab38e4a2d9630f675dc20015d"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-289325B8-AA1E-4AE3-BDB8-D1BE195FB8A8"
}