All Products
Search
Document Center

Security Center:GetVirusScanLatestTaskStatistic

Last Updated:Feb 20, 2024

Queries the information about the latest virus scan task.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1
Dataobject

The information about the virus scan task.

TaskIdstring

The ID of the virus scan task.

fc98d58eb56f699d49bf7ebbd6d7****
ScanTimelong

The timestamp generated when the virus scan task was performed. Unit: milliseconds.

1681145862000
Statusinteger

The status of the virus scan task.

Valid values for a main task:

  • 0: The main task is to be started.
  • 10: The main task is running.
  • 100: The main task is complete.

Valid values for a subtask:

  • 0: The subtask is to be started.
  • 20: The scan script is sent.
  • 50: The subtask is running.
  • 100: The subtask is complete.
0
SuspiciousCountinteger

The number of alerts that are detected.

2
SuspiciousMachineinteger

The number of suspicious machines that are detected.

2
SafeMachineinteger

The number of safe machines that are detected.

1
ScanMachineinteger

The number of machines that are scanned.

3
ScanTypestring

The type of the virus scan. Valid values:

  • system: automatic scan.
  • user: custom scan.
system
ScanPatharray

The paths of files that were scanned. This value is returned only when ScanType is set to user.

string

The path of the file.

C:/test1
Progressstring

The progress of the virus scan task in percentage.

92
MachineNamestring

The name of the machine.

testMahine1
CompleteMachineinteger

The number of machines on which the virus scan task is complete.

2
UnCompleteMachineinteger

The number of machines on which the virus scan task was not complete or failed.

1
RiskLevelstring

The highest risk level of the detected alerts. Valid values:

  • high
  • medium
  • low
medium

Examples

Sample success responses

JSONformat

{
  "RequestId": "7532B7EE-7CE7-5F4D-BF04-B12447DDCAE1",
  "Data": {
    "TaskId": "fc98d58eb56f699d49bf7ebbd6d7****",
    "ScanTime": 1681145862000,
    "Status": 0,
    "SuspiciousCount": 2,
    "SuspiciousMachine": 2,
    "SafeMachine": 1,
    "ScanMachine": 3,
    "ScanType": "system",
    "ScanPath": [
      "C:/test1"
    ],
    "Progress": "92",
    "MachineName": "testMahine1",
    "CompleteMachine": 2,
    "UnCompleteMachine": 1,
    "RiskLevel": "medium"
  }
}

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.