StartVirusScanTask - Security Center - Alibaba Cloud Documentation Center

Performs a virus scan task on a server or multiple servers.

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

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:StartVirusScanTask	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TargetInfo	string	Yes	The asset on which you want to perform a virus scan task. You can select servers or server groups to scan for viruses. 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 or server group. target: the asset on which you want to perform a virus scan task. Valid values: If you set type to groupId, you must set this field to the ID of the server group. You can call the DescribeAllGroups operation to query the IDs of server groups. If you set type to uuid, you must set this field to the UUID of the server. You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.	[{"type":"uuid","name":"Host001","target":"503201a7-14c6-4280-801b-1169ed42****"}]

Response parameters

Parameter	Type	Description	Example
	object
ScanTaskId	long	The ID of the virus scan task.	282832
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	DAE17926-4ABE-4DBD-9600-DDCB9B200F35

Examples

Sample success responses

JSONformat

{
  "ScanTaskId": 282832,
  "RequestId": "DAE17926-4ABE-4DBD-9600-DDCB9B200F35"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam	Illegal param	-
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
2022-08-01	The Error code has changed	View Change Details
2022-08-01	The Error code has changed	View Change Details