ロールの機密データマスキングフィールドを取得¶
GET /api/v1/workspace/role/sensitive_mask_fields
概要¶
ワークスペース内の各ロールに適用される機密フィールドのマスキング式のサマリーを表示します。
呼び出し前の準備と使用手順¶
routine.defaultAccess を持つ現在のワークスペースの Key を使用します。Query/Body は不要です。削除されていないマスキングルールで参照されているロールUUIDに基づき、現在有効かつ利用可能なロールを取得し、各ロールのクエリ権限と有効なマスキングルールに従ってサマリーを生成します。すべてのロールの完全なカタログではありません。特定のロールから参照されず、* ワイルドカードルールにのみ出現するロールは、このサマリーに含まれない場合があります。ロール一覧と完全なルール設定を合わせて判断してください。
実際に一致するルールがあるデータタイプ/ロール/フィールドのみを一覧表示します。一致するものがない場合は content={} となり、空のマッピングだけでは、ルールが存在しないことや、すべてのクエリがマスキング対象外であることを証明できません。基盤のルールクエリにはフォールトトレランスがあり、異常時には空のルールが返される場合もあります。このページはルールの調査用であり、元の顧客データを返さず、ルールを変更せず、データ読み取り権限も作成しません。ルール全文/有効化・停止については機密フィールドルール一覧を使用してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/workspace/role/sensitive_mask_fields' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | namespace→ロールUUID→フィールド名で構成される動的マッピング。{} の場合があります。declaration は挿入しません。 |
| content.データタイプ | object | ヒット時のみ出現します。候補は lineage、logging、metric、object、custom_object、keyevent、tracing、rum、security、network、profiling、billing です。 |
| content.データタイプ.ロールUUID | object | 具体的な有効ロールのフィールドマッピング。Key はロールUUID であり、表示名ではありません。 |
| content.データタイプ.ロールUUID.フィールド名 | array<object> |
このフィールドに適用されるルールサマリーの配列。* はワイルドカードフィールドで、カンマを含むフィールドは複数のキーに分割されます。 |
| content.データタイプ.ロールUUID.フィールド名[].reExpr | string | 保存されている正規表現。 |
| content.データタイプ.ロールUUID.フィールド名[].name | string | マスキングルール名。空の場合があります。 |
| content.データタイプ.ロールUUID.フィールド名[].id | integer | マスキングルールのデータベース数値ID。変更パスのルール uuid ではありません。 |
| content.データタイプ.ロールUUID.フィールド名[].updateAt | integer | 最終更新の Unix 秒。履歴が未更新の場合は -1 になることがあります。 |
{
"code": 200,
"content": {
"logging": {
"general": {
"phone": [
{
"reExpr": "[0-9]{11}",
"name": "手机号示例",
"id": 101,
"updateAt": 1785427200
}
]
}
}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 500 | ft.InternalServerError | 初期ルール/ロール/権限データベースの読み取り、またはサマリーのフォーマットに失敗。内部の一部ルールエラーはフォールトトレランスにより {} として返される場合があります |
内部エラー | 完全なルール一覧と照合して確認し、空の結果をデータセキュリティの受け入れテストとして扱わないでください。継続的に失敗する場合は traceId を提供してください。 |