Querying the List of Historical Virus Scan Records

Function

This API is used to query the list of historical virus scan records.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/antivirus/handle-history

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
offset	Yes	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value N/A
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints Mandatory. Range Value range: 10 to 200 Default Value 10
malware_name	No	String	Definition Virus name. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
file_path	No	String	Definition File path. Constraints N/A Range The value contains 1 to 512 characters. Default Value N/A
severity_list	No	Array of strings	Definition Risk level. It has been deprecated. Constraints N/A Range Threat level. The options are as follows: Low Medium High Critical Default Value N/A
severities	No	String	Threat level. The options are as follows: Low Medium High Critical
host_name	No	String	Definition Server name. Constraints N/A Range The value contains 1 to 256 characters. Default Value N/A
private_ip	No	String	Definition Server private IP address. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A
public_ip	No	String	Definition Server EIP. Constraints N/A Range For IPv4, the value contains 7 to 15 characters. For IPv6, the value contains 15 to 39 characters. Default Value None
asset_value	No	String	Definition Asset importance. Constraints N/A Range important common test Default Value N/A
handle_method	No	String	Definition Handling method. Constraints N/A Range Handling method. Its value can be: mark_as_handled: Mark as handled ignore: Ignore add_to_alarm_whitelist: Add to the alarm whitelist manual_isolate_and_kill: manual isolation and killing auto_isolate_and_kill: automatic isolation and killing unhandle: Cancel manual handling do_not_ignore: Unignore remove_from_alarm_whitelist: Delete from the alarm whitelist do_not_isolate_or_kill: Cancel isolation of a file Default Value N/A
user_name	No	String	Definition Username Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A
sort_dir	No	String	Definition Sorting order. Constraints N/A Range asc: ascending desc: descending Default Value Sort in ascending order.
event_type	No	Integer	Definition Event type Constraints N/A Range 0 (virus scan) or 1 (malicious file handling) Default Value N/A
sort_dir	No	String	Sorting order. If sort_key is set, the returned results are sorted in ascending the order specified by sort_key. The default order is descending. The options are as follows: asc: ascending order desc: descending order
sort_key	No	String	Definition Sorting field. Constraints N/A Range handle_time: handling time Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range The value range is 0 to 2,147,483,647.
data_list	Array of AntiVirusHandleHistory objects	Definition History of the operations on the risks found in virus scans. Range The value range is 0 to 100.

**Table 5** AntiVirusHandleHistory
Parameter	Type	Description
result_id	String	Virus scan and removal result ID
malware_type	String	Definition Virus Type Range Trojan, Virus, Worm, etc.
malware_name	String	Definition Virus Name Range The value can contain 1 to 128 characters.
severity	String	Threat level. The options are as follows: Security Low Medium High Critical
file_path	String	Definition File path. Range The value can contain 1 to 256 characters.
host_name	String	Definition Server name. Range The value can contain 1 to 256 characters.
private_ip	String	Definition Server private IP address. Range The value can contain 1 to 128 characters.
public_ip	String	Definition Elastic IP Address (EIP) Range The value is a string of 1 to 256 characters and can be an IPv4 or IPv6 address. (An IPv4 address can contain 7 to 15 characters. An IPv6 address can contain 15 to 39 characters.)
asset_value	String	Definition Asset importance. Range important common test
occur_time	Integer	Definition Occurrence time, accurate to milliseconds Range The value ranges from 0 to 9223372036854775807. The time format is a timestamp (UTC time zone, starting from 1970-01-01 00:00:00), in milliseconds.
handle_status	String	Definition Handling status. Range unhandled handled
handle_method	String	Definition Handling Method Range Its value can be: mark_as_handled: Mark as handled ignore: Ignore add_to_alarm_whitelist: Add to alarm whitelist isolate_and_kill: Isolate a file unhandle: Cancel manual handling do_not_ignore: Unignore remove_from_alarm_whitelist: Remove from the alarm whitelist do_not_isolate_or_kill: Cancel isolation of a file
notes	String	Definition Remarks. Range The value can contain 0 to 512 characters.
handle_time	Long	Definition Handling Time Range Non-negative long integer. The time format is a digit timestamp (UTC time, starting from 1970-01-01 00:00:00), in milliseconds.
user_name	String	Definition Username Range The value can contain 1 to 64 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "result_id" : "d8980c20-fd83-418a-a9c1-1abe9044ee3a",
    "malware_name" : "Linux.Trojan.Ircbot",
    "malware_type" : "Trojan",
    "severity" : "High",
    "file_path" : "/root/Malware_Samples/IRC-Robot/c77ba47e",
    "host_name" : 111,
    "private_ip" : "192.168.0.93",
    "public_ip" : "100.93.10.247",
    "asset_value" : "common",
    "occur_time" : 1736923907117,
    "handle_status" : "handled",
    "handle_method" : "mark_as_handled",
    "notes" : "One file has been handled.",
    "handle_time" : 1736925153481,
    "user_name" : 1111
  } ]
}

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Security Operations

Previous topic: Security Operations

Next topic: Querying the List of Historical Alarm Records

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot