Trigger Virus Scans Programmatically with StartVirusScanTask API - 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:StartVirusScanTask

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TargetInfo	string	Yes	The asset to scan for viruses. You can specify servers or server groups. The value is a JSON array string. Each element is a JSON struct that contains the following fields: type: the type of the asset to scan. Valid values: groupId: server group. uuid: server. name: the name of the server or server group. target: the scan target. 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 elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam	Illegal param
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.