Exporting the Virus Scan Result List
Function
This API is used to export the virus scan result list.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/antivirus/result/export
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 |
export_size |
No |
Integer |
Exported records |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
export_headers |
No |
Array<Array<String>> |
Export table header set |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Export task ID |
Example Requests
Header list of the exported table.
{ "group_id" : "eca40dbe-27f7-4229-8f9d-a58213129fdc", "group_name" : "test", "export_headers" : [ [ "malware_name", "Virus Name" ], [ "file_path", "Virus File Path" ], [ "severity", "Virus Level" ], [ "malware_type", "Virus Type" ], [ "host_name", "Affected Server Name" ], [ "host_id", "Server ID" ], [ "private_ip", "Private IP Address" ], [ "public_ip", "EIP" ], [ "occur_time", "Last Detected" ], [ "handle_method", "Status" ] ] }
Example Responses
Status code: 200
Virus scan and removal events
{ "task_id" : "9e8***4-d26b-426d-a2be-765930242984" }
SDK Sample Code
The SDK sample code is as follows.
Header list of the exported table.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
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.*; import java.util.List; import java.util.ArrayList; public class ExportAntiVirusResultSolution { 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(); ExportAntiVirusResultRequest request = new ExportAntiVirusResultRequest(); ExportAntiVirusResultRequestBody body = new ExportAntiVirusResultRequestBody(); List<String> listExportHeadersExportHeaders = new ArrayList<>(); listExportHeadersExportHeaders.add("handle_method"); listExportHeadersExportHeaders.add("Status"); List<String> listExportHeadersExportHeaders1 = new ArrayList<>(); listExportHeadersExportHeaders1.add("occur_time"); listExportHeadersExportHeaders1.add("Last Detected"); List<String> listExportHeadersExportHeaders2 = new ArrayList<>(); listExportHeadersExportHeaders2.add("public_ip"); listExportHeadersExportHeaders2.add("EIP"); List<String> listExportHeadersExportHeaders3 = new ArrayList<>(); listExportHeadersExportHeaders3.add("private_ip"); listExportHeadersExportHeaders3.add("Private IP Address"); List<String> listExportHeadersExportHeaders4 = new ArrayList<>(); listExportHeadersExportHeaders4.add("host_id"); listExportHeadersExportHeaders4.add("Server ID"); List<String> listExportHeadersExportHeaders5 = new ArrayList<>(); listExportHeadersExportHeaders5.add("host_name"); listExportHeadersExportHeaders5.add("Affected Server Name"); List<String> listExportHeadersExportHeaders6 = new ArrayList<>(); listExportHeadersExportHeaders6.add("malware_type"); listExportHeadersExportHeaders6.add("Virus Type"); List<String> listExportHeadersExportHeaders7 = new ArrayList<>(); listExportHeadersExportHeaders7.add("severity"); listExportHeadersExportHeaders7.add("Virus Level"); List<String> listExportHeadersExportHeaders8 = new ArrayList<>(); listExportHeadersExportHeaders8.add("file_path"); listExportHeadersExportHeaders8.add("Virus File Path"); List<String> listExportHeadersExportHeaders9 = new ArrayList<>(); listExportHeadersExportHeaders9.add("malware_name"); listExportHeadersExportHeaders9.add("Virus Name"); List<List<String>> listbodyExportHeaders = new ArrayList<>(); listbodyExportHeaders.add(listExportHeadersExportHeaders); listbodyExportHeaders.add(listExportHeadersExportHeaders1); listbodyExportHeaders.add(listExportHeadersExportHeaders2); listbodyExportHeaders.add(listExportHeadersExportHeaders3); listbodyExportHeaders.add(listExportHeadersExportHeaders4); listbodyExportHeaders.add(listExportHeadersExportHeaders5); listbodyExportHeaders.add(listExportHeadersExportHeaders6); listbodyExportHeaders.add(listExportHeadersExportHeaders7); listbodyExportHeaders.add(listExportHeadersExportHeaders8); listbodyExportHeaders.add(listExportHeadersExportHeaders9); body.withExportHeaders(listbodyExportHeaders); request.withBody(body); try { ExportAntiVirusResultResponse response = client.exportAntiVirusResult(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()); } } } |
Header list of the exported table.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# 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 = ExportAntiVirusResultRequest() listExportHeadersExportHeaders = [ "handle_method", "Status" ] listExportHeadersExportHeaders1 = [ "occur_time", "Last Detected" ] listExportHeadersExportHeaders2 = [ "public_ip", "EIP" ] listExportHeadersExportHeaders3 = [ "private_ip", "Private IP Address" ] listExportHeadersExportHeaders4 = [ "host_id", "Server ID" ] listExportHeadersExportHeaders5 = [ "host_name", "Affected Server Name" ] listExportHeadersExportHeaders6 = [ "malware_type", "Virus Type" ] listExportHeadersExportHeaders7 = [ "severity", "Virus Level" ] listExportHeadersExportHeaders8 = [ "file_path", "Virus File Path" ] listExportHeadersExportHeaders9 = [ "malware_name", "Virus Name" ] listExportHeadersbody = [ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, listExportHeadersExportHeaders2, listExportHeadersExportHeaders3, listExportHeadersExportHeaders4, listExportHeadersExportHeaders5, listExportHeadersExportHeaders6, listExportHeadersExportHeaders7, listExportHeadersExportHeaders8, listExportHeadersExportHeaders9 ] request.body = ExportAntiVirusResultRequestBody( export_headers=listExportHeadersbody ) response = client.export_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) |
Header list of the exported table.
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 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
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.ExportAntiVirusResultRequest{} var listExportHeadersExportHeaders = []string{ "handle_method", "Status", } var listExportHeadersExportHeaders1 = []string{ "occur_time", "Last Detected", } var listExportHeadersExportHeaders2 = []string{ "public_ip", "EIP", } var listExportHeadersExportHeaders3 = []string{ "private_ip", "Private IP Address", } var listExportHeadersExportHeaders4 = []string{ "host_id", "Server ID", } var listExportHeadersExportHeaders5 = []string{ "host_name", "Affected Server Name", } var listExportHeadersExportHeaders6 = []string{ "malware_type", "Virus Type", } var listExportHeadersExportHeaders7 = []string{ "severity", "Virus Level", } var listExportHeadersExportHeaders8 = []string{ "file_path", "Virus File Path", } var listExportHeadersExportHeaders9 = []string{ "malware_name", "Virus Name", } var listExportHeadersbody = [][]string{ listExportHeadersExportHeaders, listExportHeadersExportHeaders1, listExportHeadersExportHeaders2, listExportHeadersExportHeaders3, listExportHeadersExportHeaders4, listExportHeadersExportHeaders5, listExportHeadersExportHeaders6, listExportHeadersExportHeaders7, listExportHeadersExportHeaders8, listExportHeadersExportHeaders9, } request.Body = &model.ExportAntiVirusResultRequestBody{ ExportHeaders: &listExportHeadersbody, } response, err := client.ExportAntiVirusResult(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 events |
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