All Products
Search
Document Center

Security Center:ListVirusScanTask

Last Updated:Nov 25, 2024

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

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListVirusScanTaskget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringNo

The ID of the virus scan task.

Note You can call the ListVirusScanTask operation to query the ID.
1471d8ebb96795b41ede090b9758****
ScanTypestringNo

The type of the virus scan task. Valid values:

  • system: automatic scan task
  • user: custom scan task
user
StatusintegerNo

The status of the virus scan task. Valid values:

  • 1: running
  • 2: complete
  • 3: failed
  • 4: timed out
1
StartTimelongNo

The timestamp when the virus scan task started. Unit: milliseconds.

1680919232000
EndTimelongNo

The timestamp when the virus scan task ended. Unit: milliseconds.

1680919232999
RootTaskbooleanNo

Specifies whether the virus scan task is the root task.

true
RootTaskIdstringNo

The ID of the root task.

Note You can call the GetVirusScanLatestTaskStatistic operation to query the ID.
89f5d7813bd59dd237580a8664b3xxxx
MachineNamestringNo

The name of the server.

oracle-win-001****
InternetIpstringNo

The public IP address of the server.

120.27.XX.XX
IntranetIpstringNo

The private IP address of the server.

172.26.XX.XX
CurrentPageintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

20
StatusListarrayNo

The statuses of virus scan tasks.

integerNo

The status of the virus scan task. Valid values:

  • 1: running
  • 2: complete
  • 3: failed
  • 4: timed out
1
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
PageInfoobject

The pagination information.

CurrentPageinteger

The page number.

1
PageSizeinteger

The number of entries per page.

20
TotalCountinteger

The total number of entries returned.

224
Listarray<object>

The returned virus scan tasks.

listobject
TaskIdstring

The ID of the virus scan task.

2e75557bfa570381f5c516cad9b6xxxx
ScanTypestring

The type of the virus scan task. Valid values:

  • system: automatic scan task
  • user: custom scan task
system
Statusinteger

The status of the virus scan task. Valid values:

  • 1: running
  • 2: complete
  • 3: failed
  • 4: timed out
1
StartTimelong

The timestamp when the virus scan task started. Unit: milliseconds.

1651290987000
EndTimelong

The timestamp when the virus scan task ended. Unit: milliseconds.

1662343860051
InstanceNamestring

The name of the server.

sql-test-0****
InternetIpstring

The public IP address of the server.

8.210.XX.XX
IntranetIpstring

The private IP address of the server.

172.25.XX.XX
TaskNamestring

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
Progressinteger

The progress of the task in percentage.

62
ScanPatharray

The information about the file that is scanned.

scanPathstring

The path to the file.

C:/test1
Uuidstring

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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.