获取元数据任务模板列表 - ListTaskTemplates
功能介绍
功能介绍:获取元数据任务模板列表
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/metadata/task-templates
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。可参考获取项目ID获取。 约束限制: 不涉及 取值范围: 以IAM服务接口返回值为准,字符长度32-32。 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| page_size | 否 | Integer | 参数解释: 每页条数 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 不涉及 |
| task_name | 否 | String | 参数解释: 任务名称 约束限制: 最大长度256字符 取值范围: 1到256个字符 默认取值: 不涉及 |
| schedule_types | 否 | Array of strings | 参数解释: 调度类型 约束限制: 最大长度1024字符 取值范围: ONCE-单次执行,DAY-每天,WEEK-每周,MONTH-每月 默认取值: 不涉及 |
| id | 否 | Long | 参数解释: ID标识 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: IAM服务查询用户Token接口为准 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | Array of TaskDetail objects | 参数解释: 查询结果 取值范围: 不涉及 |
| total_num | Long | 参数解释: 查询结果 取值范围: 不涉及 |
| create_user | String | 参数解释: 创建用户 取值范围: 不涉及 |
| data_source | Array of strings | 参数解释: 数据源 取值范围: 不涉及 |
| delete_failed_meta | Boolean | 参数解释: 是否删除失败元数据 取值范围: true-是,false-否 |
| id | Long | 参数解释: 唯一标识 取值范围: 不涉及 |
| last_end_time | Long | 参数解释: 最后结束时间 取值范围: 不涉及 |
| last_trigger_time | Long | 参数解释: 最后触发时间 取值范围: 不涉及 |
| scan_config | String | 参数解释: 扫描配置 取值范围: 不涉及 |
| schedule_switch | Boolean | 参数解释: 调度开关 取值范围: true-是,false-否 |
| schedule_type | String | 参数解释: 调度类型 取值范围: 不涉及 |
| start_now | Boolean | 参数解释: 是否立即启动 取值范围: true-是,false-否 |
| start_time | Long | 参数解释: 开始时间 取值范围: 不涉及 |
| task_description | String | 参数解释: 任务描述 取值范围: 不涉及 |
| task_name | String | 参数解释: 任务名称 取值范围: 不涉及 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Long | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
| task_name | String | 参数解释: 任务名称 取值范围: 不涉及 |
| file_name | String | 参数解释: 任务详情名称 取值范围: 不涉及 |
| water_describe | String | 参数解释: 水印描述 取值范围: 不涉及 |
| water_extract_result | String | 参数解释: 水印提取结果 取值范围: 不涉及 |
| error_msg | String | 参数解释: 错误信息 取值范围: 不涉及 |
| task_create_time | Long | 参数解释: 任务创建时间 取值范围: 不涉及 |
| task_end_time | Long | 参数解释: 任务结束时间 取值范围: 不涉及 |
| extract_running_flag | String | 参数解释: 提取运行标志 取值范围: |
请求示例
获取元数据任务模板列表
/v1/2b31ed520xxxxxxebedb6e57xxxxxxxx/metadata/task-templates
响应示例
状态码:200
{
"result" : [ {
"id" : "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
"task_name" : "asset-scan-task-01",
"file_name" : "file-resource-01",
"water_describe" : "asset-value-01",
"water_extract_result" : "asset-value-01",
"error_msg" : "asset-value-01",
"task_create_time" : 1700000000000,
"task_end_time" : 1700000000000,
"extract_running_flag" : "FINISHED_STATE"
} ],
"total_num" : 2
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。