一覧取得¶
GET /api/v1/data_mask_rule/list
概要¶
現在のワークスペースで有効および無効な機密データマスキングルールをページングして一覧表示します。
呼び出し前の確認と使用手順¶
この読み取りエンドポイントは routine.defaultAccess の基本アクセス権限を宣言します。ルール情報を読み取れることは、変更権限があることを示しません。
対象ワークスペースの API Key を使用します。このグループ設定クエリはクエリ応答段階の独立した機密ルールを返し、元の保存データを書き換えません。フィールドを作成せず、恒久的な削除/匿名化インターフェースでもありません。
ルール名でクエリし、uuid、ステータス、完全な正規表現、ロール一覧を取得してから編集します。search は前後の空白を除去せず、名前のあいまい検索を行います。% は引き続き LIKE のワイルドカードとして解釈される可能性があります。この Query では type/ロールによる絞り込みはできません。クライアント側で読み取ってから絞り込むか、ページごとに処理してください。ページングのデフォルトは 1 ページ 100 件、最大 100 件で、id の降順です。ロール情報の表示は、そのロールが現在クエリ可能であること、またはマスキングが必ず有効になることを意味しません。
適用されるかどうかは、対象クエリチェーン、データ種別、実際のロール集合にも依存します。ロール設定はデータクエリの認可そのものではありません。同一アカウント/Key にその種別のクエリ権限を持つロールが複数ある場合、1 つのロールに適用可能な機密ルールがないと、このグループのルール全体が適用されない可能性があります。1 つのロールだけをバインドして、すべての閲覧者に強制マスキングが適用されると仮定しないでください。実際のロール/Key を使用して、データのクエリおよび対象の表示画面で検証してください。現在の正規表現置換は文字列値のみを処理します。数値、オブジェクト、配列、ブール値、null は自動的に文字列へ変換されてマスクされることはありません。標準クエリで一致した文字列部分は *** に置換され、その他のテキストは保持されます。保存時の正規表現チェックには regex ライブラリを使用し、クエリ実行パスでは標準 re を使用します。Python 標準 re と互換性のある構文のみを使用することを推奨します。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| pageIndex | integer | デフォルトは 1、最小値は 1。 null を許可: False $minValue: 1 例: 1取得または入力方法: 1 から開始し、pageInfo に従って続行します。 |
|
| pageSize | integer | デフォルトは 100、最大 100。 null を許可: False $maxValue: 100 $minValue: 1 例: 20取得または入力方法: 1 ~ 100 の範囲で入力します。 |
|
| search | string | 任意。名前で照合します。フィールドや正規表現は検索しません。 null を許可: False 例: 验证码取得または入力方法: ルール名のキーワードを入力します。不要な場合は省略します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/data_mask_rule/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.data | array<object> | このページのルール。id の降順。一致なし/範囲外の場合は []。無効なルールも含みます。 |
| content.declaration | object | ワークスペースの共通宣言。 |
| content.data[*].id | integer | レコード番号。アドレス指定には使用しません。 |
| content.data[*].uuid | string | wdmk_ ルール UUID。詳細、変更、一括操作に使用します。 |
| content.data[*].workspaceUUID | string | 所属ワークスペース。 |
| content.data[*].name | string | ルール名。現在のエンドポイントでは同名の一意性をチェックしません。 |
| content.data[*].type | string | データ種別。適用対象の namespace を決定します。 |
| content.data[*].field | string | フィールド設定の原文。カンマ区切り。利用側は各項目の前後の空白を自動削除しません。 |
| content.data[*].reExpr | string | 保存された正規表現。カスタム置換テキストは含みません。 |
| content.data[*].roleUUIDs | array<string> | 適用ロール UUID。[] はすべてのロールを意味しません。 |
| content.data[*].roleUUIDs[*] | string | 1 つのロール UUID。システムロール識別子またはカスタム role_ UUID の場合があります。 |
| content.data[*].status | integer | 0: 有効、2: 無効、3: 削除済み。一覧/詳細では 3 を除外し、2 は保持します。 |
| content.data[*].creator | string | 作成者。Key UUID の場合があります。 |
| content.data[*].updator | string | 更新者。まだ更新されていない場合は空文字列。 |
| content.data[*].createAt | integer | 作成日時(Unix 秒)。 |
| content.data[*].updateAt | integer | 更新日時(Unix 秒)。未更新の場合は -1 になることがあります。 |
| content.data[*].deleteAt | integer | 削除日時(Unix 秒)。未削除の場合は -1。 |
| content.data[*].roles | array<object> | 一覧/詳細でロール情報を補足します。表示可能なスコープ内で見つかったロールのみであり、過去に削除/無効化された状態を含む場合があります。roleUUIDs の数と一致することを保証しません。 |
| content.data[*].roles[*].uuid | string | ロール UUID。 |
| content.data[*].roles[*].name | string または null | ロールの表示名。 |
| content.data[*].roles[*].status | integer または null | ロールの現在のステータス。実際のレコードに基づきます。 |
| content.data[*].creatorInfo | object | 一覧でのみ作成者情報を補足します。見つからない場合は {}。システム ID の場合、キーが少ないことがあります。 |
| content.data[*].creatorInfo.uuid | string | 作成者 UUID。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.status | integer | 作成者のステータス。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータス。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.username | string | ユーザー名/Key 名。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.name | string | 名前。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.email | string | メールアドレスまたは Key 識別子。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.mobile | string | 携帯電話番号。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.countryCode | string | 国番号。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.iconUrl | string | アイコン URL。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].creatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo | object | 一覧でのみ更新者情報を補足します。見つからない場合は {}。システム ID の場合、キーが少ないことがあります。 |
| content.data[*].updatorInfo.uuid | string | 更新者 UUID。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.status | integer | 更新者のステータス。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.wsAccountStatus | integer | ワークスペースメンバーのステータス。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.username | string | ユーザー名/Key 名。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.name | string | 名前。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.email | string | メールアドレスまたは Key 識別子。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.mobile | string | 携帯電話番号。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.countryCode | string | 国番号。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.iconUrl | string | アイコン URL。省略または空の場合があります。実際の返却値に基づきます。 |
| content.data[*].updatorInfo.acntWsNickname | string | ワークスペースのニックネーム。省略または空の場合があります。実際の返却値に基づきます。 |
| pageInfo.pageIndex | integer | 現在のページ。1 から開始します。 |
| pageInfo.pageSize | integer | 1 ページあたりの件数。 |
| pageInfo.count | integer | 現在のページの件数。 |
| pageInfo.totalCount | integer | フィルタ後の合計件数。範囲外のページでも、ページングに基づいて合計件数を集計します。 |
{
"code": 200,
"content": {
"data": [
{
"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
}
],
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"pageIndex": 1,
"pageSize": 20,
"count": 1,
"totalCount": 1
}
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては、共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータがルールに違反している | パラメータの解析に失敗しました | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | ルールの読み取り、過去のロールデータ、またはレスポンスのフォーマットに失敗しました | 内部エラー | traceId を保持し、設定を確認してから再読み取りしてください。 |