文档首页/ 数据安全中心 DSC/ API参考/ API/ 元数据任务管理/ 获取元数据扫描实例列表 - ListTaskInstances
更新时间:2026-11-13 GMT+08:00
分享

获取元数据扫描实例列表 - ListTaskInstances

功能介绍

功能介绍:获取元数据扫描实例列表

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/metadata/task-templates/{template_id}/task-instances

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识当前请求所属的华为云项目,可参考获取项目ID相关文档获取

约束限制:

满足正则匹配"^[a-z0-9]{32}$",32位小写字母和数字

取值范围:

长度为32个字符,只能由小写英文字母和数字组成

默认取值:

不涉及

template_id

是

Long

参数解释:

模板ID,标识一个元数据任务模板,可通过查询元数据任务模板列表接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

page_num

否

Integer

参数解释:

页码

约束限制:

不涉及

取值范围:

不涉及

默认取值:

1

page_size

否

Integer

参数解释:

每页条数

约束限制:

不涉及

取值范围:

0~200

默认取值:

10

reverse

否

Boolean

参数解释:

是否倒序

约束限制:

不涉及

取值范围:

不涉及

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。通过调用IAM服务查询用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

result

Array of MetaDataInstanceTaskDetail objects

参数解释:

查询结果列表,数组元素为任务实例对象

取值范围:

不涉及

total_num

Long

参数解释:

查询结果总数,表示查询返回的结果条数

取值范围:

不涉及

表5 MetaDataInstanceTaskDetail

参数

参数类型

描述

id

Long

参数解释:

任务实例ID,唯一标识一次元数据扫描任务执行

取值范围:

不涉及

task_create_time

Long

参数解释:

任务创建时间,Unix毫秒时间戳

取值范围:

不涉及

task_update_time

Long

参数解释:

任务更新时间,Unix毫秒时间戳

取值范围:

不涉及

task_end_time

Long

参数解释:

任务结束时间,Unix毫秒时间戳

取值范围:

不涉及

schedule_type

String

参数解释:

调度类型,标识任务执行周期

取值范围:

  • ONCE-单次

  • DAY-每天

  • WEEK-每周

  • MONTH-每月

error_msg

String

参数解释:

错误信息,任务失败时的错误描述

取值范围:

不涉及

task_status

String

参数解释:

任务状态,标识任务执行结果

取值范围:

  • SCHEDULED-调度中

  • PROCESSING-处理中

  • PARTIAL-部分完成

  • FINISHED-已完成

  • FAILED-失败

请求示例

获取元数据扫描实例列表

/v1/2b31ed5200000ebedb6e570000000000/metadata/task-templates/1000/task-instances

响应示例

状态码:200

{
  "result" : [ {
    "id" : 1,
    "task_create_time" : 1717977600000,
    "task_update_time" : 1717977600000,
    "task_end_time" : 1717977600000,
    "schedule_type" : "ONCE",
    "error_msg" : "",
    "task_status" : "FINISHED"
  } ],
  "total_num" : 1
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档