This API is used to handle virus scan results.
Function
Handling Virus Scan Results
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/antivirus/result/operate
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. |
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 |
---|---|---|---|
operate_type |
Yes |
String |
Handling method. Its value can be:
|
memo |
No |
String |
Remarks |
operate_results |
No |
Array of OperateResultRequestInfo objects |
Handling result list |
event_white_rules |
No |
Array of AntiVirusEventWhiteRuleListRequestInfo objects |
Adding an alarm whitelist rule |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
agent_id |
Yes |
String |
Definition Agent ID Constraints N/A Range The value can contain 1 to 64 characters. Default Value N/A |
result_id |
Yes |
String |
The result ID of virus scanning and removal |
event_type |
Yes |
Integer |
Event type. |
occur_time |
No |
Integer |
Definition Occurrence time, accurate to milliseconds Range The value range is 0 to 9,223,372,036,854,775,807. |
file_hash |
Yes |
String |
Definition File hash. Range The value can contain 1 to 256 characters. |
file_path |
Yes |
String |
Definition File path. Range The value can contain 1 to 256 characters. |
file_attr |
Yes |
String |
Definition File attribute. Range The value can contain 1 to 256 characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
event_type |
Yes |
Integer |
Definition Event type. Range
|
field_key |
Yes |
String |
Whitelist fields. The options are as follows:
|
field_value |
Yes |
String |
Whitelist field value |
judge_type |
Yes |
String |
Wildcard. The options are as follows:
|
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Set the action to whitelist, agent ID to e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3, task ID to 9767484d-cc39-4de1-b214-621c3acce4b5, event type to virus, file hash to d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb, file path to /root/xx, and file attribute to -rw-r--r--.
{ "operate_type" : "add_to_alarm_whitelist", "memo" : "xxx", "operate_results" : [ { "agent_id" : "e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3", "result_id" : "9767484d-cc39-4de1-b214-621c3acce4b5", "event_type" : 1002, "file_hash" : "d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb", "file_path" : "/root/xx", "file_attr" : "-rw-r--r--" } ] }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Set the action to whitelist, agent ID to e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3, task ID to 9767484d-cc39-4de1-b214-621c3acce4b5, event type to virus, file hash to d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb, file path to /root/xx, and file attribute to -rw-r--r--.
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 |
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 HandleAntiVirusResultSolution { 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(); HandleAntiVirusResultRequest request = new HandleAntiVirusResultRequest(); OperateAntiVirusResultRequestInfo body = new OperateAntiVirusResultRequestInfo(); List<OperateResultRequestInfo> listbodyOperateResults = new ArrayList<>(); listbodyOperateResults.add( new OperateResultRequestInfo() .withAgentId("e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3") .withResultId("9767484d-cc39-4de1-b214-621c3acce4b5") .withEventType(1002) .withFileHash("d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb") .withFilePath("/root/xx") .withFileAttr("-rw-r--r--") ); body.withOperateResults(listbodyOperateResults); body.withMemo("xxx"); body.withOperateType("add_to_alarm_whitelist"); request.withBody(body); try { HandleAntiVirusResultResponse response = client.handleAntiVirusResult(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()); } } } |
Set the action to whitelist, agent ID to e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3, task ID to 9767484d-cc39-4de1-b214-621c3acce4b5, event type to virus, file hash to d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb, file path to /root/xx, and file attribute to -rw-r--r--.
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 |
# 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 = HandleAntiVirusResultRequest() listOperateResultsbody = [ OperateResultRequestInfo( agent_id="e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3", result_id="9767484d-cc39-4de1-b214-621c3acce4b5", event_type=1002, file_hash="d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb", file_path="/root/xx", file_attr="-rw-r--r--" ) ] request.body = OperateAntiVirusResultRequestInfo( operate_results=listOperateResultsbody, memo="xxx", operate_type="add_to_alarm_whitelist" ) response = client.handle_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) |
Set the action to whitelist, agent ID to e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3, task ID to 9767484d-cc39-4de1-b214-621c3acce4b5, event type to virus, file hash to d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb, file path to /root/xx, and file attribute to -rw-r--r--.
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 |
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.HandleAntiVirusResultRequest{} var listOperateResultsbody = []model.OperateResultRequestInfo{ { AgentId: "e2ad65100314897c3dc5b50857f49a5f53e78c4b495fbed3d8097249456830f3", ResultId: "9767484d-cc39-4de1-b214-621c3acce4b5", EventType: int32(1002), FileHash: "d36b44b1cd6d5767f788ba3265b075ad74d70ba8a1ce89db7c43ab6ea6e2c8eb", FilePath: "/root/xx", FileAttr: "-rw-r--r--", }, } memoOperateAntiVirusResultRequestInfo:= "xxx" request.Body = &model.OperateAntiVirusResultRequestInfo{ OperateResults: &listOperateResultsbody, Memo: &memoOperateAntiVirusResultRequestInfo, OperateType: "add_to_alarm_whitelist", } response, err := client.HandleAntiVirusResult(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 |
Request succeeded. |
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