Restarting Tasks

This API is used to re-run a task.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A
task_id	Yes	String	Definition Task ID. Constraints Mandatory Range The value can contain 1 to 64 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
task_type	Yes	String	Definition Task Type Constraints Mandatory Range cluster_scan: cluster scan. Default Value N/A
cluster_scan_info	No	cluster_scan_info object	When task_type is set to cluster_scan, this parameter is used to transfer parameters for re-executing a cluster scan task.

**Table 5** cluster_scan_info
Parameter	Mandatory	Type	Description
range_type	Yes	String	Definition Range to be rescanned. Constraints Mandatory Range all_failed_cluster: all clusters that fail to be scanned in the task. specific_cluster: specifies the cluster that fails to be scanned in a task. Default Value N/A
cluster_info_list	No	Array of cluster_info_list objects	Definition Specifies the scope of clusters to be rescanned when the scan scope is specific_cluster. Constraints N/A Range Minimum value: 1. Maximum value: 200.

**Table 6** cluster_info_list
Parameter	Mandatory	Type	Description
cluster_id	No	String	Definition Cluster ID. Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
scan_type_list	No	Array of strings	Definition List of scan items to be rescanned in the cluster. If this parameter is not specified, all failed scan items in the cluster are rescanned. Constraints N/A Range Minimum value: 1; maximum value: 3

Status code: 200

Request succeeded.

None

Retry all clusters that fail to be scanned in the task.

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

None

Status Code	Description
200	Request succeeded.

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.