# 展示数据库脱敏任务 - ListTemplatesDb #### 功能介绍 展示数据库脱敏任务 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dsc/dsc_02_0008.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dsc/dsc_02_0031.html)。 - 如果使用身份策略授权，当前API调用无需身份策略权限。 #### URI GET /v1/{project_id}/sdg/server/mask/dbs/templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，长度为32个字符，满足正则匹配"\^\[a-z0-9\]{32}$" **默认取值：** 不涉及 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 分页查询时每页返回的最大记录数 **约束分页查询时每页返回的最大记录数：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | template_name | 否 | String | **参数解释：** 模板名称 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | type | 否 | String | **参数解释：** 模板类型，用于区分不同的脱敏模板 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | sequence | 否 | String | **参数解释：** 排序序列号，用于指定模板的排序方式 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于接口请求的身份认证。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 总记录数 **取值范围：** 不涉及 | | template_list | Array of [SingleDBTemplate] objects | **参数解释：** 模板列表 **取值范围：** 不涉及 列表元素引用 不涉及 **取值范围：** 不涉及 不涉及' | 表5SingleDBTemplate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | task_source | String | **参数解释：** 任务来源 **取值范围：** 不涉及 | | id | String | **参数解释：** 模板ID **取值范围：** 不涉及 | | type | String | **参数解释：** 模板类型 **取值范围：** 不涉及 | | db_type | String | **参数解释：** 数据库类型 **取值范围：** 不涉及 | | status | Integer | **参数解释：** 任务状态 **取值范围：** 不涉及 | | run_status | String | **参数解释：** 任务运行状态 **取值范围：** 不涉及 | | progress | Integer | **参数解释：** 任务执行进度，以百分比表示，取值0\~100，用于标识脱敏任务当前完成的进度 **取值范围：** 0\~100，以百分比表示 | | template_name | String | **参数解释：** 模板名称 **取值范围：** 不涉及 | | data_source | Array of [MaskDBTemplateDataSource] objects | **参数解释：** 数据源配置列表，数组中的每个元素为MaskDBTemplateDataSource对象，包含源实例ID、数据源ID、库名、表名、选择列等信息 **取值范围：** 不涉及 | | data_dest | Array of [MaskDBTemplateDataDest] objects | **参数解释：** 数据目的端配置列表，数组中的每个元素为MaskDBTemplateDataDest对象，包含目的端实例ID、数据目的ID、库名、表名等信息 **取值范围：** 不涉及 | | strategy | Array of [MaskDBTemplateStrategy] objects | **参数解释：** 脱敏策略列表，数组中的每个元素为MaskDBTemplateStrategy对象，包含源字段名、目标字段名、脱敏算法等信息 **取值范围：** 不涉及 | | trigger_time | String | **参数解释：** 任务触发时间，格式为yyyy-MM-ddTHH:mm:ssZ，为UTC时间，表示脱敏任务触发的时刻 **取值范围：** 不涉及 | | workspace_id | String | **参数解释：** 工作空间ID **取值范围：** 不涉及 | | create_time | Long | **参数解释：** 创建时间，为毫秒级Unix时间戳，表示脱敏模板创建的时间点 **取值范围：** 毫秒级Unix时间戳 | | mask_ratio | Integer | **参数解释：** 脱敏比例，以百分比表示，取值0\~100，用于指定对源数据进行脱敏处理的数据量占总体数据的比例 **取值范围：** 0\~100，以百分比表示 | | increment_key | String | **参数解释：** 增量同步键 **取值范围：** 不涉及 | | scan_template_id | String | **参数解释：** 扫描模板ID **取值范围：** 不涉及 | | mask_template_id | String | **参数解释：** 脱敏模板ID **取值范围：** 不涉及 | | partition_filter | String | **参数解释：** 分区过滤条件 **取值范围：** 不涉及 | | partition_filter_type | String | **参数解释：** 分区过滤类型 **取值范围：** 不涉及 | | algorithm | String | **参数解释：** 脱敏算法，标识该脱敏模板项所采用的数据库脱敏算法 **取值范围：** 不涉及 | | algorithm_id | String | **参数解释：** 算法ID **取值范围：** 不涉及 | | algorithm_type | String | **参数解释：** 算法类型 **取值范围：** 不涉及 | | bucket | String | **参数解释：** OBS对象存储桶名称，用于指定脱敏数据存储或读取所对应的OBS桶 **取值范围：** 不涉及 | | choosing_columns | Array of strings | **参数解释：** 选择列列表，列表中的每个元素为列名称字符串，用于标识需要参与脱敏的列 **取值范围：** 不涉及 | | data_source_id | String | **参数解释：** 数据源ID **取值范围：** 不涉及 | | db_name | String | **参数解释：** 数据库名称 **取值范围：** 不涉及 | | dest_column_name | String | **参数解释：** 目标列名 **取值范围：** 不涉及 | | dest_ins_id | String | **参数解释：** 目的实例ID **取值范围：** 不涉及 | | dst_asset_id | String | **参数解释：** 目标资产ID **取值范围：** 不涉及 | | dst_obs_bucket_name | String | **参数解释：** 目标OBS桶名称 **取值范围：** 不涉及 | | dst_obs_path | String | **参数解释：** 目标OBS路径 **取值范围：** 不涉及 | | enable | Boolean | **参数解释：** 是否启用 **取值范围：** true-是，false-否 **参数解释：** 文件名 **取值范围：** 不涉及 | | file_name_prefix | String | **参数解释：** 文件名前缀 **取值范围：** 不涉及 | | file_name_suffix | String | **参数解释：** 文件名后缀 **取值范围：** 不涉及 | | file_path | String | **参数解释：** 文件路径 **取值范围：** 不涉及 | | mask_type | String | **参数解释：** 脱敏类型，标识脱敏任务执行时所采用的脱敏方式 **取值范围：** 不涉及 | | parameter | Object | **参数解释：** 脱敏算法的配置参数，用于指定脱敏算法执行时的具体配置项 **取值范围：** 不涉及 **参数解释：** 是否递归 **取值范围：** true-是，false-否 **参数解释：** 规则名称 **取值范围：** 不涉及 | | schema | String | **参数解释：** Schema名称 **取值范围：** 不涉及 | | source_ins_id | String | **参数解释：** 来源实例ID **取值范围：** 不涉及 | | src_asset_id | String | **参数解释：** 源资产ID **取值范围：** 不涉及 | | src_column_name | String | **参数解释：** 源列名 **取值范围：** 不涉及 | | src_obs_bucket_name | String | **参数解释：** 源OBS桶名称 **取值范围：** 不涉及 | | src_obs_path | String | **参数解释：** 源OBS路径 **取值范围：** 不涉及 | | table_name | String | **参数解释：** 表名 **取值范围：** 不涉及 | | template_id | String | **参数解释：** 模板ID **取值范围：** 不涉及 | 表6MaskDBTemplateDataSource | 参数 | 参数类型 | 描述 | |:---|:---|:---| | source_ins_id | String | **参数解释：** 源实例ID **取值范围：** 不涉及 | | data_source_id | String | **参数解释：** 数据源ID **取值范围：** 不涉及 | | db_name | String | **参数解释：** 数据库名称 **取值范围：** 不涉及 | | table_name | String | **参数解释：** 脱敏数据库模板数据源名称 **取值范围：** 不涉及 | | choosing_columns | Array of strings | **参数解释：** 选择的列 **取值范围：** 不涉及 | | cluster_id | String | **参数解释：** 脱敏数据库模板数据源ID **取值范围：** 不涉及 | | partition_filter | String | **参数解释：** Hive分区筛选WHERE语句 **取值范围：** 不涉及 | | partition_filter_type | String | **参数解释：** Hive分区筛选类型（AUTO/MANUAL） **取值范围：** 不涉及 | | schema | String | **参数解释：** schema名称 **取值范围：** 不涉及 | | src_asset_id | String | **参数解释：** 源资产ID **取值范围：** 不涉及 | | src_obs_bucket_name | String | **参数解释：** 源OBS桶名 **取值范围：** 不涉及 | | src_obs_path | String | **参数解释：** 源OBS路径 **取值范围：** 不涉及 | | recursive | Boolean | **参数解释：** 是否递归 **取值范围：** 不涉及 | | file_name_prefix | String | **参数解释：** 文件名前缀 **取值范围：** 不涉及 | | file_name_suffix | String | **参数解释：** 文件名后缀 **取值范围：** 不涉及 | | mask_type | String | **参数解释：** 说明OBS具体脱敏任务类型，文本脱敏还是图片脱敏 **取值范围：** - "text" 文本脱敏 - "picture" 图片脱敏 | 表7MaskDBTemplateDataDest | 参数 | 参数类型 | 描述 | |:---|:---|:---| | dest_ins_id | String | **参数解释：** 目标实例ID **取值范围：** 不涉及 | | data_dest_id | String | **参数解释：** 数据目的ID **取值范围：** 不涉及 | | db_name | String | **参数解释：** 数据库名称 **取值范围：** 不涉及 | | table_name | String | **参数解释：** 脱敏数据库模板数据目标名称 **取值范围：** 不涉及 | | cluster_id | String | **参数解释：** 脱敏数据库模板数据目标ID **取值范围：** 不涉及 | | type | String | **参数解释：** 目的端类型 **取值范围：** 不涉及 | | bucket | String | **参数解释：** OBS桶名 **取值范围：** 不涉及 | | file_path | String | **参数解释：** 脱敏数据库模板数据目标路径 **取值范围：** 不涉及 | | file_name | String | **参数解释：** 脱敏数据库模板数据目标名称 **取值范围：** 不涉及 | | schema | String | **参数解释：** schema名称 **取值范围：** 不涉及 | | dst_asset_id | String | **参数解释：** 目标资产ID **取值范围：** 不涉及 | | dst_obs_bucket_name | String | **参数解释：** 目标OBS桶名 **取值范围：** 不涉及 | | dst_obs_path | String | **参数解释：** 目标OBS路径 **取值范围：** 不涉及 | 表8MaskDBTemplateStrategy | 参数 | 参数类型 | 描述 | |:---|:---|:---| | src_column_name | String | **参数解释：** 脱敏数据库模板策略名称 **取值范围：** 不涉及 | | dest_column_name | String | **参数解释：** 目标列名 **取值范围：** 不涉及 | | algorithm | String | **参数解释：** 脱敏算法 **取值范围：** 不涉及 | | algorithm_type | String | **参数解释：** 算法类型 **取值范围：** 不涉及 | | parameter | String | **参数解释：** 算法参数 **取值范围：** 不涉及 | | algorithm_id | String | **参数解释：** 脱敏算法ID **取值范围：** 不涉及 | | rule_name | String | **参数解释：** 规则名称 **取值范围：** 不涉及 | | enable | Boolean | **参数解释：** 是否启用 **取值范围：** 不涉及 | #### 请求示例 展示数据库脱敏任务 ``` /v1/2b31ed520abcd1234ebedb6e57123456/sdg/server/mask/dbs/templates ``` #### 响应示例 **状态码：200** ``` { "total" : 1, "template_list" : [ { "task_source" : "DB", "type" : "MYSQL", "db_type" : "MYSQL", "status" : 1, "run_status" : "FINISHED", "progress" : 100, "template_name" : "db-mask-template-01", "data_source" : [ { "source_ins_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "data_source_id" : "src-customer-db", "db_name" : "customer_db", "table_name" : "customer_info" } ], "data_dest" : [ { "dest_ins_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "data_dest_id" : "dst-mask-db", "db_name" : "mask_db", "table_name" : "customer_info_masked" } ], "strategy" : [ { "src_column_name" : "phone", "dest_column_name" : "phone_masked", "algorithm" : "SHA256", "algorithm_type" : "MASK_BY_HASH" } ], "trigger_time" : "0 0 2 * * ?", "workspace_id" : "2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d", "create_time" : 1700000000000, "mask_ratio" : 80, "increment_key" : "id", "scan_template_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "mask_template_id" : "9f2a3b4c-5d6e-4f7a-8b9c-0d1e2f3a4b5c", "partition_filter" : "dt='20260101'", "partition_filter_type" : "AUTO", "template_id" : "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 展示数据库脱敏模版成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。