Creating a Virus Scan Task

This API is used to create a virus scan 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.

POST /v5/{project_id}/antivirus/task

**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

**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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
task_name	Yes	String	Definition Task Range Each tag value can contain a maximum of 255 Unicode characters.
task_id	No	String	Task ID. When a virus scan task is created, task_id is null. When the task is re-executed, task_id is not null and is the ID of the current task.
scan_type	Yes	String	Definition Job type Range Its value can be: quick: quick scan full: full disk scan custom: custom scan
action	Yes	String	Definition Action Range auto: automatic handling manual: manual handling
host_ids	Yes	Array of strings	Policy management server list

Status code: 200

Request succeeded.

None

Edit the virus scan task, set Task Type to Quick scan, Handling Action to Manual handling, and Server List to eab583a8-ff16-4b7a-aefc-e95ad3a78388.

{
  "task_name" : "Task",
  "scan_type" : "quick",
  "action" : "manual",
  "host_ids" : [ "eab583a8-ff16-4b7a-aefc-e95ad3a78388" ]
}

None

Status Code	Description
200	Request succeeded.

Parent Topic: Antivirus

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.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

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