Query virus scan tasks with ListVirusScanTask - Security Center - Alibaba Cloud - Security Center

Queries virus scan tasks that match specified conditions such as scan type, scan status, and scanned machine information.

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:ListVirusScanTask

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the virus scan task to query. Note Call ListVirusScanTask to obtain this parameter.	1471d8ebb96795b41ede090b9758****
ScanType	string	No	The scan type of the virus scan task to query. Valid values: system: automatic system scan user: custom user scan.	user
Status	integer	No	The execution status of the virus scan task. Valid values: 1: Scanning. 2: Completed. 3: Failed. 4: Timed out.	1
StartTime	integer	No	The timestamp of the task start time to query, in milliseconds.	1680919232000
EndTime	integer	No	The timestamp of the task end time to query, in milliseconds.	1680919232999
RootTask	boolean	No	Specifies whether the task is the root task of the virus scan.	true
RootTaskId	string	No	The root task ID. Note Call GetVirusScanLatestTaskStatistic to obtain this parameter.	89f5d7813bd59dd237580a8664b3xxxx
MachineName	string	No	The name of the server.	oracle-win-001****
InternetIp	string	No	The public IP address.	120.27.XX.XX
IntranetIp	string	No	The private IP address.	172.26.XX.XX
CurrentPage	integer	No	The page number of the results to return. Default value: 1, which indicates that results start from page 1.	1
PageSize	integer	No	The number of tasks per page in a paged query. Default value: 20, which indicates that each page contains 20 tasks.	20
StatusList	array	No	The list of statuses used to filter tasks by multiple statuses.
	integer	No	The execution status of the virus scan task. Valid values: 1: Scanning. 2: Completed. 3: Failed. 4: Timed out.	1
Lang	string	No	The language type of the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
PageInfo	object	The pagination information.
CurrentPage	integer	The current page number in the paged query.	1
PageSize	integer	The maximum number of entries per page in the paged query.	20
TotalCount	integer	The total number of entries returned.	224
List	array<object>	The result list.
	object	The data entry in the list.
TaskId	string	The ID of the scan task.	2e75557bfa570381f5c516cad9b6xxxx
ScanType	string	The scan type of the virus scan task. Valid values: system: automatic system scan user: custom user scan.	system
Status	integer	The execution status of the virus scan task. Valid values: 1: Scanning. 2: Completed. 3: Failed. 4: Timed out.	1
StartTime	integer	The start timestamp, in milliseconds.	1651290987000
EndTime	integer	The end timestamp, in milliseconds.	1662343860051
InstanceName	string	The name of the server instance.	sql-test-0****
InternetIp	string	The public IP address of the server.	8.210.XX.XX
IntranetIp	string	The private IP address of the server.	172.25.XX.XX
TaskName	string	The task name. VIRUS_VUL_SCHEDULE_SCAN: virus scan.	VIRUS_VUL_SCHEDULE_SCAN
Progress	integer	The task progress percentage.	62
ScanPath	array	The scanned file information.
	string	The file path.	C:/test1
Uuid	string	The UUID of the server.	49e25e0f-bb51-4a5a-a1b3-13a4ddaa****

Examples

Success response

JSON format

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 224
  },
  "List": [
    {
      "TaskId": "2e75557bfa570381f5c516cad9b6xxxx",
      "ScanType": "system",
      "Status": 1,
      "StartTime": 1651290987000,
      "EndTime": 1662343860051,
      "InstanceName": "sql-test-0****",
      "InternetIp": "8.210.XX.XX",
      "IntranetIp": "172.25.XX.XX",
      "TaskName": "VIRUS_VUL_SCHEDULE_SCAN",
      "Progress": 62,
      "ScanPath": [
        "C:/test1"
      ],
      "Uuid": "49e25e0f-bb51-4a5a-a1b3-13a4ddaa****"
    }
  ]
}

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.