Track Virus Scan Progress in Real Time with DescribeScanTaskProgress - Security Center - Alibaba Cloud - Security Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeScanTaskProgress

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	integer	Yes	The ID of the virus scan task that you want to query. Note You can call the StartVirusScanTask operation to obtain this parameter.	282832

Response elements

Element	Type	Description	Example
	object
TargetInfo	string	The asset information scanned by the virus scan node. This parameter is a string converted from a JSON array in character format. The following fields are included: type: The Asset Type on which the virus scan is executed. Valid values: groupId: server group. uuid: server. name: The name of the server group or server. target: The asset on which the virus scan is executed. The following describes the values of this field: If type is set to groupId, this field specifies the server group ID. If type is set to uuid, this field specifies the UUID of the server.	[{"type":"uuid","name":"host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]
RequestId	string	The request ID. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	EA15BA8A-D631-4375-8D40-CB7C769B0279
ScanTaskProgress	string	The progress of the virus scan task. Valid values: init: The scan task is being initialized. Processing: The scan task is in progress. Success: The scan task is complete. Failed: The scan task failed.	Success

Examples

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.