Querying the Virus Scan Result List
Function
This API is used to query the virus scan result list.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/antivirus/result
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 |
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 N/A Range Value range: 10 to 200 Default Value 10 |
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 |
Server public IP address |
handle_status |
No |
String |
Handling status. It can be:
|
severity_list |
No |
Array of strings |
Threat level. The options are as follows:
|
asset_value |
No |
String |
Asset importance. The options are as follows:
|
malware_name |
No |
String |
Virus name |
file_path |
No |
String |
File path |
file_hash |
No |
String |
File hash. The current value is sha256. |
task_name |
No |
String |
Task name |
manual_isolate |
No |
Boolean |
Whether to use the manual isolation button |
Request 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 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Definition Total number. Range The value range is 0 to 2,147,483,647. |
data_list |
Array of AntiVirusResultResponseInfo objects |
Result list details |
Parameter |
Type |
Description |
---|---|---|
result_id |
String |
The result ID of virus scanning and removal |
malware_type |
String |
Virus type |
malware_name |
String |
Virus name |
severity |
String |
Threat level. The options are as follows:
|
task_id |
String |
Task ID |
task_name |
String |
Task name |
file_info |
ResultFileResponseInfo object |
File information. |
resource_info |
ResultResourceResponseInfo object |
Resource information |
event_type |
Integer |
Event type. |
occur_time |
Integer |
Definition Occurrence time, accurate to milliseconds Range The value range is 0 to 9,223,372,036,854,775,807. |
handle_status |
String |
Definition Handling status. Range
|
handle_method |
String |
Handling method. Its value can be:
|
memo |
String |
Remarks |
operate_accept_list |
Array of strings |
Supported processing operations |
operate_detail_list |
Array of ResultDetailResponseInfo objects |
Operation details list (Not displayed on the page) |
isolate_tag |
String |
Automatic isolation and killing flag |
Parameter |
Type |
Description |
---|---|---|
file_path |
String |
Definition File path. Range The value can contain 1 to 256 characters. |
file_hash |
String |
Definition File hash. Range The value can contain 1 to 256 characters. |
file_size |
Integer |
Definition File size. Constraints N/A Range The value range is 0 to 9,223,372,036,854,775,807. Default Value N/A |
file_owner |
String |
File attribute. |
file_attr |
String |
Definition File attribute. Range The value can contain 1 to 256 characters. |
file_ctime |
Integer |
File creation time |
file_mtime |
Integer |
File update time |
Parameter |
Type |
Description |
---|---|---|
host_name |
String |
Definition Server name. Range The value can contain 1 to 256 characters. |
host_id |
String |
Definition Host ID. Range Length: 1 to 64 characters |
agent_id |
String |
Definition Agent ID Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A |
private_ip |
String |
Definition Server private IP address. Range The value can contain 1 to 128 characters. |
public_ip |
String |
Definition EIP. Range The value can contain 1 to 256 characters. |
os_type |
String |
Definition OS type. Range
|
host_status |
String |
Server status. Its value can be:
|
agent_status |
String |
Agent status. Its value can be:
|
protect_status |
String |
Protection status. It can be:
|
asset_value |
String |
Asset importance. Its value can be:
|
os_name |
String |
OS name |
os_version |
String |
OS version |
Example Requests
None
Example Responses
Status code: 200
Virus scan and removal result list
{ "total_num" : 3849, "data_list" : [ { "result_id" : "f989**25-b3a4-4d88-b05a-cc***cd1205", "malware_type" : "Trojan", "malware_name" : "Linux.Trojan.Ircbot", "severity" : "High", "task_id" : "cc****7a-bf3c-4b6a-9f77-32857****5504", "task_name" : "Custom Scan-20250121211946", "file_info" : { "file_path" : "/root/Malware_Samples/IRC-Robot/a87b13391818*****5466b66363ea4d*******f2d3e30448d6930ab722b5", "file_hash" : "a87****80203c5466b66363ea4d5****5400f2d3e30448d6930ab722b5", "file_size" : 5028448, "file_owner" : "root", "file_attr" : "-rw-r--r--", "file_ctime" : 1737030295, "file_mtime" : 1700805582 }, "resource_info" : { "host_name" : "h00657476-linux", "host_id" : "b4****be-4c28-4bf3-8070-fde***c6689", "agent_id" : "50a1154572*****f934415cdd6817af90a905c5****951a2265003df8e9", "private_ip" : "192.168.0.**", "public_ip" : "100.93.10.***", "os_type" : "Linux", "host_status" : "ACTIVE", "agent_status" : "online", "protect_status" : "opened", "asset_value" : "common", "os_name" : "HCE OS", "os_version" : "2.0" }, "event_type" : 1004, "occur_time" : 1737465650731, "handle_status" : "unhandled", "operate_accept_list" : [ "mark_as_handled", "ignore", "add_to_alarm_whitelist", "manual_isolate_and_kill" ], "operate_detail_list" : [ { "keyword" : "a87b1339181880203c5******95400f2d3e30448d6930ab722b5", "hash" : "a87b1339181880203c5466b66363ea4d54*****d3e30448d6930ab722b5" } ] } ] }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListAntiVirusResultSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListAntiVirusResultRequest request = new ListAntiVirusResultRequest(); try { ListAntiVirusResultResponse response = client.listAntiVirusResult(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListAntiVirusResultRequest() response = client.list_anti_virus_result(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListAntiVirusResultRequest{} response, err := client.ListAntiVirusResult(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Virus scan and removal result list |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot