All Products
Search
Document Center

Security Center:DescribeScanTaskProgress

Last Updated:Apr 28, 2023

Queries the progress of a virus scan task.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdlongYes

The ID of the virus scan task.

NoteYou can call the StartVirusScanTask operation to query the IDs of virus scan tasks.
282832

Response parameters

ParameterTypeDescriptionExample
object
TargetInfostring

The information about the asset on which the virus scan task runs. The value is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that contains 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 the server group or server.

  • target: the asset on which the virus scan task runs. The value of this field varies based on the value of the type field.

    • If the value of type is groupId, the value of this field is the ID of the server group.
    • If the value of type is uuid, the value of this field is the UUID of the server.
[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]
RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

EA15BA8A-D631-4375-8D40-CB7C769B0279
ScanTaskProgressstring

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.
Success

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.