ListVirusScanTask - Security Center - Alibaba Cloud Documentation Center

Queries virus scan tasks based on conditions such as the task type, task status, and server information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	No	The ID of the virus scan task. Note You can call the ListVirusScanTask operation to query the ID.	1471d8ebb96795b41ede090b9758****
ScanType	string	No	The type of the virus scan task. Valid values: system: automatic scan task user: custom scan task	user
Status	integer	No	The status of the virus scan task. Valid values: 1: running 2: complete 3: failed 4: timed out	1
StartTime	long	No	The timestamp when the virus scan task started. Unit: milliseconds.	1680919232000
EndTime	long	No	The timestamp when the virus scan task ended. Unit: milliseconds.	1680919232999
RootTask	boolean	No	Specifies whether the virus scan task is the root task.	true
RootTaskId	string	No	The ID of the root task. Note You can call the GetVirusScanLatestTaskStatistic operation to query the ID.	89f5d7813bd59dd237580a8664b3xxxx
MachineName	string	No	The name of the server.	oracle-win-001****
InternetIp	string	No	The public IP address of the server.	120.27.XX.XX
IntranetIp	string	No	The private IP address of the server.	172.26.XX.XX
CurrentPage	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20.	20
StatusList	array	No	The statuses of virus scan tasks.
	integer	No	The status of the virus scan task. Valid values: 1: running 2: complete 3: failed 4: timed out	1
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
PageInfo	object	The pagination information.
CurrentPage	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
TotalCount	integer	The total number of entries returned.	224
List	object []	The returned virus scan tasks.
TaskId	string	The ID of the virus scan task.	2e75557bfa570381f5c516cad9b6xxxx
ScanType	string	The type of the virus scan task. Valid values: system: automatic scan task user: custom scan task	system
Status	integer	The status of the virus scan task. Valid values: 1: running 2: complete 3: failed 4: timed out	1
StartTime	long	The timestamp when the virus scan task started. Unit: milliseconds.	1651290987000
EndTime	long	The timestamp when the virus scan task ended. Unit: milliseconds.	1662343860051
InstanceName	string	The name of the server.	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 name of the virus scan task. The value is fixed as VIRUS_VUL_SCHEDULE_SCAN, which indicates a virus scan task.	VIRUS_VUL_SCHEDULE_SCAN
Progress	integer	The progress of the task in percentage.	62
ScanPath	array	The information about the file that is scanned.
	string	The path to the file.	C:/test1
Uuid	string	The UUID of the server.	49e25e0f-bb51-4a5a-a1b3-13a4ddaa****

Examples

Sample success responses

JSONformat

{
  "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
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.