変更¶
POST /api/v1/data_mask_rule/{data_mask_rule_uuid}/modify
概要¶
現在のワークスペースのマスキングルール設定を全体として変更し、有効/無効状態を維持します。
呼び出し前と使用手順¶
この書き込みエンドポイントには dataRightsManage.workspaceConfigManage の管理権限が必要です。
対象ワークスペースの API Key を使用します。この設定グループは、クエリ応答段階における独立した機密ルールを構成するものであり、元の保存データを書き換えず、フィールドを作成せず、恒久的な削除/匿名化インターフェースでもありません。
まず詳細を読み取ってバックアップし、ルール UUID を指定して name/type/field/reExpr/roleUUIDs をすべて送信します。これは部分更新ではなく完全な設定の上書きです。ステータスは維持され、有効化/無効化には別のインターフェースを使用します。
書き込みは先に送信してから、対応するデータカテゴリのルールキャッシュを削除します(変更時は新旧のカテゴリをクリアします)。キャッシュの失敗は送信後に発生する可能性があります。その後、実際の読み取り主体でテストします。ルール一覧の保存成功は、すべてのクエリ対象とキャッシュで有効性が検証済みであることを意味しません。
有効化は対象のクエリチェーン、データカテゴリ、実際のロール集合にも依存します。ロール設定はデータクエリの認可そのものではありません。同一アカウント/Key がそのカテゴリのクエリ権限を持つ複数のロールに属する場合、いずれか 1 つのロールに適用可能な機密ルールがないと、このルールグループ全体が適用されない可能性があります。1 つのロールだけを紐付けて、すべての読み取り者にマスキングが強制されると仮定しないでください。実際のロール/Key を使用し、データのクエリおよび対象の表示画面で検証してください。現在の正規表現置換は文字列値のみを処理します。数値、オブジェクト、配列、ブール値、null は自動的に文字列に変換してマスクされることはありません。標準クエリで一致した文字列部分は *** に置換され、それ以外のテキストは保持されます。保存時の正規表現チェックでは regex ライブラリを使用し、クエリ実行パスでは標準の re を使用するため、Python 標準の re と互換性のある構文のみを使用することを推奨します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| data_mask_rule_uuid | string | Y | 現在のワークスペース内の未削除ルールの UUID。無効状態でも読み取り/変更できます。 例: wdmk_example取得または入力方法: マスキングルール一覧 のレスポンス content.data[*].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト Body パラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| roleUUIDs[*] | string | 1 つのロール UUID。書き込み前に、サーバー側でワークスペースの利用可能なロール集合に含まれるかどうかを確認します。 例: role_example取得または入力方法: ロール一覧の UUID を 1 項目ずつ入力します。ロール名は使用しません。 |
|
| field | string | Y | 必須入力で空にはできません。最大 128 文字。複数フィールドを指定する場合は半角カンマで区切り、スペースは入れません(例: message,phone)。* を含めると一致するすべてのフィールドに適用されます。範囲を明確にするため、* は単独で使用することを推奨します。 空文字列を許可: False null を許可: False 最大長: 128 例: message取得または入力方法: 対応するデータフィールドのクエリから元のフィールド名を取得し、別名は入力しません。 |
| name | string | Y | 必須入力で空にはできません。最大 128 文字。現在は同名を許可しており、名前による冪等性は保証されません。 空文字列を許可: False null を許可: False 最大長: 128 例: 验证码脱敏取得または入力方法: ルールの用途を入力します。タイムアウト後に重複作成しないよう、先に一覧で既存設定を確認してください。 |
| reExpr | string | Y | 必須入力で空にはできません。最大 5000 文字。例では 验证码=123456 を 验证码=*** に変換します。カスタム置換パラメータはサポートされません。一部の regex 拡張構文は保存できても標準の re では実行に失敗するため、保存成功だけで使用可能と判断しないでください。 空文字列を許可: False null を許可: False 最大長: 5000 例: (?<=验证码=)[0-9]{6}取得または入力方法: Python 標準の re と互換性のある式を入力し、JSON エスケープを行います。事前にマスキングテストで制御されたサンプルを使用してテストできます。 |
| roleUUIDs | array | Y | 必須の配列。現在のチェックでは削除済みロールを除外しますが、無効化済みで未削除のロールは通過する可能性があります。[] は明確に一致するロールがないことを表し、すべてのロールを意味するものではありません。* をこの公開インターフェースの検証免除ワイルドカードロールとして扱わないでください。通常のロールテーブルに該当 UUID が含まれない場合は 404 になります。 null を許可: False 例: ["role_example"]取得または入力方法: ロール一覧 から現在のワークスペースで利用可能かつ未削除のロール UUID を取得します。システムロールは一覧上の実際の識別子を使用します。 |
| type | string | Y | 必須。過去の宣言では null を許可していますが、クライアントは実際にサポートされるカテゴリを選択する必要があり、null をすべてのカテゴリとして扱わないでください。null では信頼できる有効なルールを形成できず、変更時に非 null の保存制約に違反する可能性があります。 null を許可: True 選択可能な値: ['lineage', 'logging', 'metric', 'object', 'custom_object', 'keyevent', 'tracing', 'rum', 'security', 'network', 'profiling', 'billing'] 例: logging取得または入力方法: 実際にクエリするデータカテゴリに応じて lineage/logging/metric/object/custom_object/keyevent/tracing/rum/security/network/profiling/billing から選択します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/data_mask_rule/wdmk_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"验证码脱敏","type":"logging","field":"message","reExpr":"(?<=验证码=)[0-9]{6}","roleUUIDs":["role_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true を返します。詳細を読み戻して設定を確認してください。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータの解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | リクエスト JSON のトップレベルがオブジェクトではない | 一部の json ファイルの形式エラー | 例に従ってオブジェクトを送信してください。 |
| 404 | ft.ObjectNotExists | 対象 UUID が現在のワークスペースに属していない、存在しない、または削除済み | 指定されたオブジェクトが存在しない | 現在のワークスペースの一覧から有効な UUID を取得してください。無効化されたルールも引き続き読み取れます。 |
| 404 | ft.NotFoundRole | roleUUIDs のいずれかのメンバーが、現在のワークスペースで利用可能な未削除ロールの集合に含まれていない | 指定されたロールが見つからない、またはロールが削除済み | ロール一覧から UUID を再取得してください。名前、外部ワークスペースのロール、* は使用しないでください。 |
| 400 | ft.ErrorRegularExpression | 保存時の正規表現事前チェックに失敗 | 正規表現に誤りがある | 有効かつ標準の re と互換性のある式に変更し、JSON のバックスラッシュエスケープを確認してください。 |
| 500 | ft.InternalServerError | 保存または応答に失敗。書き込み送信後のキャッシュクリア失敗でも 500 になる可能性がある | 内部エラー | 書き込みリクエストは、まず一覧/詳細を読み戻してから再試行を判断してください。traceId を保持して管理者に連絡してください。 |