削除¶
POST /api/v1/data_mask_rule/delete
概要¶
現在のワークスペースのマスキングルールを一括でソフト削除します。
呼び出し前の準備と使用手順¶
この書き込みエンドポイントには dataRightsManage.workspaceConfigManage の管理権限が必要です。
対象ワークスペースの API Key を使用します。この設定グループはクエリ返却段階の独立した機密ルールを構成するものであり、元の保存データを書き換えず、フィールドも作成しません。また、恒久的な削除や匿名化を行うインターフェースでもありません。
本インターフェースは一致するルールをソフト削除しますが、ソースデータは削除せず、すでに顧客に返却されたクエリ結果もロールバックしません。true が返されても、リクエスト配列の各項目がすべて一致したことを示すわけではありません。空のバッチやまったく一致しない場合でも成功することがあります。リストを安全に確認したうえで既知の状態を再処理し、非一致を変更成功とみなさないでください。データベースのコミット後、一致カテゴリに応じてルールキャッシュをクリアします。キャッシュクリアに失敗すると 500 が返る可能性がありますが、状態はすでにコミットされています。再試行前に読み戻してください。
有効性は、対象のクエリチェーン、データカテゴリ、実際のロール集合にも依存します。ロール設定はデータクエリの認可そのものではありません。同一アカウント/Key にそのカテゴリのクエリ権限を持つロールが複数ある場合、1 つのロールに適用可能な機密ルールがないと、このルールグループ全体が適用されない可能性があります。1 つのロールだけをバインドして、すべての閲覧者に強制マスキングされると仮定しないでください。実際のロール/Key を使用して、データをクエリ および対象の表示面で検証してください。現在の正規表現置換は文字列値のみを処理します。数値、オブジェクト、配列、ブール値、null は自動的に文字列化してマスクされません。標準クエリで一致した文字列部分は *** に置換され、その他のテキストは保持されます。保存時の正規表現チェックには regex ライブラリを使用し、クエリ実行パスでは標準 re を使用するため、Python 標準 re と互換性のある構文のみを使用することを推奨します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dataMaskRuleUUIDs[*] | string | 各項目が空でない文字列であることを推奨します。true で全 UUID が一致したと判断しないでください。 例: wdmk_example取得または入力方法: 単一のルール UUID を入力します(名前ではありません)。 |
|
| dataMaskRuleUUIDs | array | Y | 必須の配列です。[] でも成功しますが、ルールは変更されません。現在のワークスペースの未削除レコードのみを処理し、不明な UUID、別ワークスペースの UUID、削除済み UUID は一致せず、項目ごとのエラーも発生しません。 null の許可: False 例: ["wdmk_example"]取得または入力方法: マスキングルール一覧 から対象ルールの uuid を項目ごとに選択します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/data_mask_rule/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"dataMaskRuleUUIDs":["wdmk_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 ファイル形式エラー | 例に従ってオブジェクトを送信してください。 |
| 500 | ft.InternalServerError | ストレージまたは応答に失敗しました。書き込みコミット後のキャッシュクリア失敗でも 500 になる可能性があります | 内部エラー | 書き込みリクエストは、まず一覧/詳細で読み戻してから再試行を判断してください。traceId を保持して管理者に連絡してください。 |