更新时间:2025-10-31 GMT+08:00
分享

重新运行任务 - RetryTask

功能介绍

重新运行任务

授权信息

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

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

URI

PUT /v5/{project_id}/common/tasks/{task_id}/retry

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

task_id

String

参数解释

任务id

约束限制

必填

取值范围

字符长度1-64位

默认取值

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

task_type

String

参数解释

任务类型

约束限制:

必填

取值范围:

  • cluster_scan:集群扫描。

默认取值:

不涉及

cluster_scan_info

cluster_scan_info object

task_type值为“cluster_scan”时用于传递重新执行集群扫描任务的相关参数

表5 cluster_scan_info

参数

是否必选

参数类型

描述

range_type

String

参数解释

重新扫描的范围

约束限制:

必填

取值范围:

  • all_failed_cluster:任务下所有扫描失败的集群。

  • specific_cluster:任务下指定扫描失败的集群。

默认取值:

不涉及

cluster_info_list

Array of cluster_info_list objects

参数解释

扫描范围为specific_cluster时用于指定重新扫描的集群范围

约束限制:

不涉及

取值范围:

最小值1,最大值200

表6 cluster_info_list

参数

是否必选

参数类型

描述

cluster_id

String

参数解释:

集群id

约束限制:

不涉及

取值范围:

字符长度1-64位

默认取值:

不涉及

scan_type_list

Array of strings

参数解释

该集群重新扫描的扫描项列表,若不指定则重新扫描集群下所有扫描失败的扫描项

约束限制:

不涉及

取值范围:

最小值1,最大值3

响应参数

状态码:200

请求已成功

请求示例

重试任务下所有扫描失败的集群

{
  "task_type" : "cluster_scan",
  "cluster_scan_info" : {
    "range_type" : "all_failed_cluster"
  }
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档