コンテンツにスキップ

有効化/無効化



POST /api/v1/data_mask_rule/set_disable

概要

現在のワークスペースのマスキングルールを一括で有効化または無効化します。

呼び出し前の準備と使用手順

この書き込みエンドポイントには dataRightsManage.workspaceConfigManage 管理権限が必要です。

対象ワークスペースの API キーを使用します。このグループはクエリ返却段階の独立した機密ルールを設定するものであり、元の保存データを書き換えず、フィールドを作成せず、恒久的な削除/匿名化インターフェースでもありません。

本バッチで一致したルールを一括で有効化または無効化します。無効化後、そのルールは有効な設定として後続のクエリに参加しなくなりますが、ロールによるクエリが禁止されることとは異なります。true を返しても、リクエスト配列の各項目がすべて一致したことを意味しません。空のバッチや完全に未一致の場合も成功する可能性があります。リストを安全に確認したうえで既知の状態を再処理し、未一致を変更成功と見なさないようにしてください。データベースコミット後、一致カテゴリごとにルールキャッシュをクリアします。キャッシュクリアに失敗すると 500 になる可能性がありますが、状態はすでにコミット済みです。再試行前に読み戻してください。

有効性は、対象のクエリチェーン、データカテゴリ、実際のロール集合にも依存します。ロール設定はデータクエリの認可そのものではありません。同一アカウント/キーにそのカテゴリのクエリ権限を持つロールが複数ある場合、1 つのロールに適用可能な機密ルールがないと、このグループのルール全体が適用されない可能性があります。1 つのロールだけをバインドして、すべての閲覧者にマスキングが強制されると仮定しないでください。実際のロール/キーを使用して、クエリデータおよび対象の表示画面で検証してください。現在の正規表現置換は文字列値のみを処理します。数値、オブジェクト、配列、ブール値、null は自動的に文字列に変換されてマスクされることはありません。標準クエリで一致した文字列部分は *** に置換され、その他のテキストは保持されます。保存時の正規表現チェックでは regex ライブラリを使用し、クエリ実行パスでは標準の re を使用します。Python 標準 re と互換性のある構文のみを使用することを推奨します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API キー管理から、この操作権限を持つ OpenAPI キーを取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
dataMaskRuleUUIDs[*] string 各項目を空でない文字列にすることを推奨します。true によってすべての UUID が一致したと判断しないでください。
例: wdmk_example
取得または入力方法: 単一のルール UUID を入力します。名前ではありません。
dataMaskRuleUUIDs array Y 必須の配列です。[] でも成功しますがルールは変更されません。現在のワークスペースの未削除レコードのみを処理し、未知/外部ワークスペース/削除済みの UUID は一致せず、項目ごとのエラーも発生しません。
null 許可: False
例: ["wdmk_example"]
取得または入力方法: マスキングルール一覧から対象ルールの uuid を項目ごとに選択します。
isDisable boolean Y 必須のブール値です。一致したルールに対して一律に status=2 または 0 を設定します。削除済みルールは復元しません。
null 許可: False
例: true
取得または入力方法: 無効化する場合は true、有効化する場合は false を入力します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/data_mask_rule/set_disable' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"dataMaskRuleUUIDs":["wdmk_example"],"isDisable":true}'

レスポンス

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 を保持して管理者に連絡してください。

フィードバック

このページは役に立ちましたか?