DescribeScanTaskProgress - Security Center - Alibaba Cloud Documentation Center

Queries the progress of a virus scan task.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	long	Yes	The ID of the virus scan task. Note You can call the StartVirusScanTask operation to query the IDs of virus scan tasks.	282832

Response parameters

Parameter	Type	Description	Example
	object
TargetInfo	string	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 you want to perform a virus scan task. 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 type field is set to groupId, the value of this field is the ID of the server group. If the type field is set to uuid, the value of this field is the universally unique identifier (UUID) of the server.	[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	EA15BA8A-D631-4375-8D40-CB7C769B0279
ScanTaskProgress	string	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 code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation

No change history