# 创建元数据扫描模板 - CreateTaskTemplates #### 功能介绍 功能介绍：创建元数据扫描模板 #### 调用方法 请参见[如何调用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 POST /v1/{project_id}/metadata/task-templates 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID。可参考获取项目ID获取。 **约束限制：** 不涉及 **取值范围：** 以IAM服务接口返回值为准，字符长度32-32。 **默认取值：** 不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务查询用户Token接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及 **取值范围：** IAM服务查询用户Token接口为准 **默认取值：** 不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | data_sources | 否 | Array of [DataSource] objects | **参数解释：** 数据源列表 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | task_name | 否 | String | **参数解释：** 任务名称 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | task_description | 否 | String | **参数解释：** 任务描述 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | schedule_type | 否 | String | **参数解释：** 任务模板类型 **约束限制：** 最大长度256字符 **取值范围：** - ONCE-单次执行 - DAY-每天 - WEEK-每周 - MONTH-每月 **默认取值：** 不涉及 | | start_time | 否 | Long | **参数解释：** 开始时间 **约束限制：** 不涉及 **取值范围：** 0\~2147483647 **默认取值：** 不涉及 | | start_now | 否 | Boolean | **参数解释：** 开始立即 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | delete_failed_meta | 否 | Boolean | **参数解释：** 删除失败元数据 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | schedule_switch | 否 | Boolean | **参数解释：** 调度开关 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_config | 否 | [ScanConfig] object | **参数解释：** 扫描配置 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | create_user | 否 | String | **参数解释：** 创建者用户名 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | manual_operate | 否 | Boolean | **参数解释：** 任务模板操作 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | 表4DataSource | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ins_id | 否 | String | **参数解释：** 资产ID **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | db_type | 否 | String | **参数解释：** 数据库类型 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | asset_id | 否 | String | **参数解释：** 资产ID **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | ins_type | 否 | String | **参数解释：** 数据源类型 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | ins_name | 否 | String | **参数解释：** 数据源名称 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | | asset_name | 否 | String | **参数解释：** 资产名称 **约束限制：** 最大长度1024字符 **取值范围：** 0到1024个字符 **默认取值：** 不涉及 | 表5ScanConfig | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | scan_views | 否 | Boolean | **参数解释：** 是否扫描视图 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_tables | 否 | Boolean | **参数解释：** 是否扫描表 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_privileges | 否 | Boolean | **参数解释：** 是否扫描权限 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_comment | 否 | Boolean | **参数解释：** 是否扫描注释 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_system_db | 否 | Boolean | **参数解释：** 是否扫描系统库 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_column_constraints | 否 | Boolean | **参数解释：** 是否扫描列约束 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | | scan_sample_data | 否 | Boolean | **参数解释：** 是否扫描样本数据 **约束限制：** 不涉及 **取值范围：** true-是，false-否 **默认取值：** 不涉及 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 操作结果状态 **取值范围：** 不涉及 | | msg | String | **参数解释：** 操作结果描述信息 **取值范围：** 不涉及 | | id | String | **参数解释：** 资源ID，唯一标识 **取值范围：** 不涉及 | #### 请求示例 资产中心创建操作：CreateTaskTemplates ``` { "data_sources" : [ { "ins_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46", "db_type" : "MySQL", "asset_id" : "0cfd1d3e-2c4a-4d1f-8e2b-9a3c4d5e6f70", "ins_type" : "RDS", "ins_name" : "rds-instance-01", "asset_name" : "asset-db-01" } ], "task_name" : "asset-scan-task-01", "task_description" : "asset-value-01", "schedule_type" : "DAY", "start_time" : 1700000000000, "start_now" : true, "delete_failed_meta" : true, "schedule_switch" : true, "scan_config" : { "scan_views" : true, "scan_tables" : true, "scan_privileges" : true, "scan_comment" : true, "scan_system_db" : true, "scan_column_constraints" : true, "scan_sample_data" : true }, "create_user" : "asset-admin", "manual_operate" : true } ``` #### 响应示例 **状态码：200** ``` { "status" : "success", "msg" : "操作成功", "id" : "3a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求已成功 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dsc/ErrorCode.html)。