取得¶
GET /api/v1/data_mask_rule/{data_mask_rule_uuid}/get
概要¶
現在のワークスペース内の削除されていないマスキングルールとロール情報を読み取ります。
呼び出し前の準備と使用手順¶
この読み取りエンドポイントは routine.defaultAccess の基本アクセス権限を宣言しています。ルール情報を読み取れることは、変更権限があることを意味しません。
対象ワークスペースの API Key を使用します。この設定グループは、クエリの返却段階で独立した機密ルールを適用するものであり、元の保存データを書き換えず、フィールドを作成せず、永続削除や匿名化を行うインターフェースでもありません。
一覧の uuid を使用して読み取り、有効または無効のレコードを含みます。保存された完全な設定を返し、roles は補完しますが、一覧の creatorInfo/updatorInfo は補完しません。ロール一覧には履歴上の非有効状態が含まれる場合があり、書き戻し前の有効性チェックとしては使用されません。
適用されるかどうかは、対象のクエリチェーン、データカテゴリ、実際のロール集合にも依存します。ロール設定自体はデータクエリの認可ではありません。同一アカウント/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 を取得します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/data_mask_rule/wdmk_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | レコード番号。アドレス指定には使用しません。 |
| content.uuid | string | wdmk_ ルール UUID。詳細、変更、一括操作に使用します。 |
| content.workspaceUUID | string | 所属ワークスペース。 |
| content.name | string | ルール名。現在のエンドポイントでは同名の一意性をチェックしません。 |
| content.type | string | データカテゴリ。適用される namespace を決定します。 |
| content.field | string | フィールド設定の原文。カンマ区切りです。コンシューマーは各項目の先頭と末尾の空白を自動的に削除しません。 |
| content.reExpr | string | 保存された正規表現。カスタム置換テキストは含みません。 |
| content.roleUUIDs | array<string> | 適用ロール UUID。[] はすべてのロールを意味しません。 |
| content.roleUUIDs[*] | string | 1 つのロール UUID。システムロール識別子またはカスタム role_ UUID の場合があります。 |
| content.status | integer | 0 は有効、2 は無効、3 は削除済み。一覧/詳細では 3 を除外し、2 は保持します。 |
| content.creator | string | 作成者識別子。Key UUID の場合があります。 |
| content.updator | string | 更新者識別子。未更新の場合は空文字列です。 |
| content.createAt | integer | 作成時間(Unix 秒)。 |
| content.updateAt | integer | 更新時間(Unix 秒)。未更新の場合は -1 の場合があります。 |
| content.deleteAt | integer | 削除時間(Unix 秒)。未削除の場合は -1。 |
| content.roles | array<object> | 一覧/詳細で補完されるロール情報。表示可能なスコープ内で見つかったロールのみで、履歴上の削除済み/無効状態を含む場合があり、roleUUIDs の数と一致するとは限りません。 |
| content.roles[*].uuid | string | ロール UUID。 |
| content.roles[*].name | string または null | ロールの表示名。 |
| content.roles[*].status | integer または null | ロールの現在の状態。実際のレコードに基づきます。 |
| content.declaration | object | ワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 10,
"uuid": "wdmk_example",
"workspaceUUID": "wksp_example",
"name": "验证码脱敏",
"type": "logging",
"field": "message",
"reExpr": "(?<=验证码=)[0-9]{6}",
"roleUUIDs": [
"role_example"
],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"roles": [
{
"uuid": "role_example",
"name": "自定义只读角色",
"status": 0
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.ObjectNotExists | 対象 UUID が現在のワークスペースに属していない、存在しない、または削除済み | 指定されたオブジェクトは存在しません | 現在のワークスペースの一覧から有効な UUID を取得します。無効なルールも引き続き読み取れます。 |
| 500 | ft.InternalServerError | ルールの読み取り、履歴ロールデータ、またはレスポンスのフォーマットに失敗 | 内部エラー | traceId を保持して設定を確認した後、再読み取りします。 |