更新元数据任务模板 - UpdateTaskTemplates
功能介绍
功能介绍:更新元数据任务模板
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/metadata/task-templates/{template_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| template_id | 是 | Long | 参数解释: 模板ID,标识一个元数据任务模板,可通过查询元数据任务模板列表接口获取 约束限制: 不涉及 取值范围: 1到64个字符,只能由英文字母、数字及短横线、下划线组成 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| data_sources | 是 | Array of DataSource objects | 参数解释: 数据源列表,数组元素为DataSource对象 约束限制: 最少1个,最多5个,且 ins_id 不能重复 取值范围: 不涉及 默认取值: 不涉及 |
| task_name | 是 | String | 参数解释: 任务名称 约束限制: 不涉及 取值范围: 1到255个字符,只能由中文字符、英文字母、数字及下划线、连字符组成 默认取值: 不涉及 |
| task_description | 是 | String | 参数解释: 任务描述 约束限制: 不涉及 取值范围: 最多255个字符 默认取值: 不涉及 |
| schedule_type | 否 | String | 参数解释: 调度类型,用于指定任务执行的调度频率 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| start_time | 否 | Long | 参数解释: 开始时间,Unix时间戳,单位为毫秒 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| start_now | 否 | Boolean | 参数解释: 是否立即开始执行 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| delete_failed_meta | 否 | Boolean | 参数解释: 是否删除失败元数据 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| schedule_switch | 否 | Boolean | 参数解释: 是否开启调度 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: true |
| scan_config | 否 | ScanConfig object | 参数解释: 扫描配置 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| create_user | 否 | String | 参数解释: 创建者用户名 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| manual_operate | 否 | Boolean | 参数解释: 是否手动操作任务模板 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| ins_id | 否 | String | 参数解释: 实例ID,标识一个数据源实例,可通过查询数据源实例列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| db_type | 是 | String | 参数解释: 数据库类型,标识数据库所属的引擎类别 约束限制: 不涉及 取值范围: 受支持的数据库类型(如 MySQL、PostgreSQL、Oracle、DWS、MRS_HIVE 等) 默认取值: 不涉及 |
| asset_id | 否 | String | 参数解释: 资产ID,标识一个数据资产,可通过查询资产列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| ins_type | 否 | String | 参数解释: 数据源实例类型,标识实例所属的类别 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| ins_name | 否 | String | 参数解释: 实例名称,标识一个数据源实例 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| asset_name | 否 | String | 参数解释: 资产名称,标识一个数据资产 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| scan_views | 否 | Boolean | 参数解释: 是否扫描视图 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| scan_tables | 否 | Boolean | 参数解释: 是否扫描表 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: true |
| scan_privileges | 否 | Boolean | 参数解释: 是否扫描权限 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| scan_comment | 否 | Boolean | 参数解释: 是否扫描注释 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| scan_system_db | 否 | Boolean | 参数解释: 是否扫描系统库 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| scan_column_constraints | 否 | Boolean | 参数解释: 是否扫描列约束 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
| scan_sample_data | 否 | Boolean | 参数解释: 是否扫描样本数据 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: false |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态,标识操作的处理结果,如成功、失败等 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源唯一标识ID,唯一标识一条资源记录,可通过查询资源列表接口获取 取值范围: 0到1024个字符,只能由英文字母、数字组成 |
请求示例
资产中心更新操作:UpdateTaskTemplates
{
"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
}
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "操作成功",
"id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。