Queries the progress of a virus scan task.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeScanTaskProgress

The operation that you want to perform.

Set the value to DescribeScanTaskProgress.

TaskId Long Yes 282832

The ID of the virus scan task.

Note You can call the StartVirusScanTask operation to query the IDs of virus scan tasks.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String EA15BA8A-D631-4375-8D40-CB7C769B0279

The ID of the request.

ScanTaskProgress String Success

The progress of the virus scan task. Valid values:

  • init: The task is being initialized.
  • Processing: The task is running.
  • Success: The task is complete.
  • Failed: The task fails.
TargetInfo String [{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]

The information about the asset on which the virus scan task runs. This parameter is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that includes the following fields:

  • type: the type of the asset on which the virus scan task runs. Valid values:
    • groupId: server group
    • uuid: server
  • name: the name of a server group or server
  • target: the asset on which the virus scan task runs.
    • If type is set to groupId, the value of this field is the ID of the server group.
    • If type is set to uuid, the value of this field is the universally unique identifier (UUID) of the server.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeScanTaskProgress
&TaskId=282832
&<Common request parameters>

Sample success responses

XML format

<DescribeScanTaskProgressResponse>
      <TargetInfo>[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]</TargetInfo>
      <RequestId>EA15BA8A-D631-4375-8D40-CB7C769B0279</RequestId>
      <ScanTaskProgress>Success</ScanTaskProgress>
</DescribeScanTaskProgressResponse>

JSON format

{
	"TargetInfo": "[{\"type\":\"uuid\",\"name\":\"host001\",\"target\":\"503201a7-14c6-4280-801b-1169ed42****\"}]",
	"RequestId": "EA15BA8A-D631-4375-8D40-CB7C769B0279",
	"ScanTaskProgress": "Success"
}

Error codes

For a list of error codes, visit the API Error Center.