获取元数据任务模板列表 - ListTaskTemplates
功能介绍
功能介绍:获取元数据任务模板列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/metadata/task-templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字 取值范围: 长度为32个字符,只能由小写英文字母和数字组成 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| page_num | 否 | Integer | 参数解释: 页码 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1 |
| page_size | 否 | Integer | 参数解释: 每页条数 约束限制: 不涉及 取值范围: 0~200 默认取值: 10 |
| task_name | 否 | String | 参数解释: 任务名称,用于标识一个元数据探索任务 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| schedule_type | 否 | String | 参数解释: 调度类型,多个以逗号分隔,用于指定任务执行的调度频率 约束限制: 不涉及 取值范围: ONCE-单次执行、DAY-每天、WEEK-每周、MONTH-每月 默认取值: 不涉及 |
| id | 否 | Long | 参数解释: 元数据资源ID,标识一条元数据记录,可通过查询元数据列表接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值) 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of TaskDetail objects | 参数解释: 查询结果列表,数组元素为TaskDetail对象,包含任务执行结果或实例的详细信息 取值范围: 不涉及 |
| total_num | Long | 参数解释: 查询结果总数,表示查询返回的结果条数 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 任务模板ID,唯一标识一个元数据扫描任务模板 取值范围: 不涉及 |
| data_source | Array of DataSource objects | 参数解释: 数据源列表,数组元素为数据源对象 取值范围: 不涉及 |
| task_name | String | 参数解释: 任务名称,标识元数据扫描任务 取值范围: 不涉及 |
| task_description | String | 参数解释: 任务描述,说明扫描任务用途 取值范围: 不涉及 |
| schedule_type | String | 参数解释: 调度类型,标识任务执行周期 取值范围: |
| schedule_switch | Boolean | 参数解释: 调度开关,标识是否启用定时调度 取值范围: 不涉及 |
| start_time | Long | 参数解释: 任务开始时间,Unix毫秒时间戳 取值范围: 不涉及 |
| last_end_time | Long | 参数解释: 上次任务结束时间,Unix毫秒时间戳 取值范围: 不涉及 |
| start_now | Boolean | 参数解释: 是否立即启动,true-立即启动,false-不启动 取值范围: 不涉及 |
| scan_config | ScanConfig object | 参数解释: 扫描配置,标识扫描范围与选项 取值范围: 不涉及 |
| last_trigger_time | Long | 参数解释: 上次触发时间,Unix毫秒时间戳 取值范围: 不涉及 |
| create_user | String | 参数解释: 创建用户,标识任务创建者 取值范围: 不涉及 |
| delete_failed_meta | 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-否 |
| 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-否 |
请求示例
获取元数据任务模板列表
/v1/2b31ed5200000ebedb6e570000000000/metadata/task-templates
响应示例
状态码:200
{
"result" : [ {
"id" : 1001,
"data_source" : [ {
"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",
"schedule_switch" : true,
"start_time" : 1700000000000,
"last_end_time" : 1700000000000,
"start_now" : 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
},
"last_trigger_time" : 1700000000000,
"create_user" : "asset-admin",
"delete_failed_meta" : false
} ],
"total_num" : 1
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。