機密データマスキングテスト¶
POST /api/v1/workspace/sensitive_mask_rule/test
概要¶
シミュレーションデータを使用して、指定したロールの組み合わせにおける機密フィールドのマスキング結果をプレビューします。
呼び出し前の確認と使用手順¶
routine.defaultAccess を持つ現在のワークスペース Key を使用します。まず機密フィールドルール一覧で namespace、有効状態、フィールド、正規表現、ロールを確認し、その後、シミュレーションデータと組み合わせる roleUUIDs を渡します。このエンドポイントは渡されたサンプルのみを計算し、元データのクエリ、ルールやサンプルの保存、現在の Key 権限の変更は行いません。
組み合わせは、ロールの読み取り権限とマスキングルールの両方に基づいて計算されます。参加する読み取り可能なロールのいずれかに、その型に適用されるルールがない場合、組み合わせはマスキングされない可能性があります。複数ロールを、無条件に最も厳しいルールを重ね合わせるものと解釈しないでください。空のロール配列、ルールなし、またはルール照会のフォールトトレランスによっても元のまま返される場合があり、これはルールが有効であることや、ルールが存在しないことを証明するものではありません。
各オブジェクトのトップレベルフィールドのみを走査し、フィールド名を * ワイルドカードルールと照合します。既存のルール順序に従って Python の re.sub で一致部分を *** に置換します。深い再帰や数値の自動文字列変換は行いません。データ形状の不一致、有効なルールの正規表現異常、または数値が正規表現で処理された場合は 500 になる可能性があります。例では、logging/general に phone が [0-9]{11} に一致する有効なルールが既に存在することを前提としています。未設定の場合は元の文字列が返される可能性があり、ルールと期待されるアサーションを照合する必要があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
ボディリクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| roleUUIDs[*] | string | 単一の文字列。現在のワークスペースで有効なロールを使用します。* を実際のロールとして扱い、すべてのロールを置き換えないでください。 例: general取得または入力方法: 実際のロール UUID を取得し、name は使用しません。複数ロールをまとめて実際の組み合わせをシミュレートします。 |
|
| data[*] | json | 単一のオブジェクト。{} は保持されます。誤った形状は、ルールが存在する場合に 500 になる可能性があります。型の寛容さを、すべてのデータ形式のサポートと解釈しないでください。 例: {"phone": "13800138000", "message": "示例记录"}取得または入力方法: フィールドは実レコードと同じで、値には架空の内容を使用したシミュレーションデータを 1 件作成します。 |
|
| data[*].フィールド名 | any | 動的フィールド値。フィールドまたは * ワイルドカードフィールドに一致する場合、ルール順序に従って Python 正規表現で一致部分を *** に置換します。複数のルールが連続して適用され、元のフィールド値は業務ストレージに書き込まれません。 例: 13800138000取得または入力方法: 検証する実際のフィールド名を使用し、架空の文字列で一致/不一致のサンプルを作成します。 |
|
| data | array | Y | 必須の配列。各項目は JSON オブジェクトを推奨します。トップレベルフィールドのみを処理し、ネストされた JSON を再帰処理しません。ルールに一致しない値は保持されます。一致ルールがあるフィールドは文字列である必要があり、数値は自動変換されません。 null を許可: False 例: [{"phone": "13800138000", "message": "示例记录"}]取得または入力方法: 実際の顧客の機密情報を含まないシミュレーション用 JSON オブジェクト配列を自身で用意します。フィールド名を置き換え、既存のルールに対応させます。 |
| namespace | string | Y | 必須。候補は lineage,logging,metric,object,custom_object,keyevent,tracing,rum,security,network,profiling,billing です。ログインデックス名ではありません。このエントリポイントは実際のログを照会しません。 空文字列を許可: False null を許可: False 選択可能な値: ['lineage', 'logging', 'metric', 'object', 'custom_object', 'keyevent', 'tracing', 'rum', 'security', 'network', 'profiling', 'billing'] 例: logging取得または入力方法: サンプルが属するデータ型を選択し、先に完全なルール一覧で同じ type を確認します。 |
| roleUUIDs | array | Y | 必須のロール UUID 配列。シミュレートするアイデンティティの組み合わせを表し、呼び出し Key のロールを変更するものではありません。サーバーは各ロールが依然として有効であることを個別に証明しません。未知のロール、適用可能なルールがない場合、またはロール権限の不一致時は、元のまま返される可能性があります。[] でロールがない場合はマスキングされません。 null を許可: False 例: ["general"]取得または入力方法: ロール一覧 の content.data[].uuid から、シミュレートするロールを取得します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/workspace/sensitive_mask_rule/test' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"roleUUIDs":["general"],"namespace":"logging","data":[{"phone":"13800138000","message":"示例记录"}]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | array | シミュレーション結果の配列。順序は入力に対応します。declaration は挿入されません。適用可能なルールがない場合、入力と完全に同じになることがあります。 |
| content[] | object または元の入力値 | 単一のサンプル。入力オブジェクトを推奨します。空のオブジェクトは保持されます。 |
| content[].フィールド名 | JSON | 入力フィールドと元の型。正規表現が作用する文字列の一致部分は *** に置換され、その他の値は変更されず、メタデータは追加されません。 |
{
"code": 200,
"content": [
{
"phone": "***",
"message": "示例记录"
}
],
"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 ファイル形式エラー | パラメータ表の JSON オブジェクトを送信します。 |
| 500 | ft.InternalServerError | ルール照会前のデータベース障害、非オブジェクト項目、非文字列フィールド、または無効な正規表現が処理時にエラー | 内部エラー | オブジェクト配列/文字列のサンプルでフィールドとルールを確認し、制御されたサンプルで再現します。設定エラーは権限のある管理者が修正し、traceId を提供します。 |