Creating a Custom Scan Policy
Function
This API is used to create a custom scan policy.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/antivirus/policy
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 |
---|---|---|---|
policy_name |
Yes |
String |
Policy name |
start_type |
Yes |
String |
Start type. Its value can be:
|
scan_period |
No |
String |
Start type. Its value can be:
|
scan_period_date |
No |
Integer |
Scan period date. (1-28) When the scan period is week, 1-7 indicates Sunday to Saturday. When the scan period is month, 1-28 indicates the first day to 28th day of each month. |
scan_time |
No |
Integer |
Scan timestamp, in milliseconds. (This parameter is valid only when the startup type is later.) |
scan_hour |
No |
Integer |
Scan hours (The parameter is available only when the startup type is period.) |
scan_minute |
No |
Integer |
Scan minutes (This parameter is valid only when the startup type is period.) |
timezone_offset |
No |
Integer |
Time zone offset (unit: minute). This parameter is valid only when the start type is period. |
file_types |
Yes |
Array of integers |
File type. The options are as follows:
|
scan_dir |
No |
String |
Scan directories. Use semicolons (;) to separate multiple directories. |
ignore_dir |
No |
String |
Excluded directories. Use semicolons (;) to separate multiple directories. |
action |
Yes |
String |
Handling mode. It can be:
|
whether_paid_task |
Yes |
Boolean |
Whether the scan task is paid. |
task_id |
No |
String |
Task ID |
host_ids |
Yes |
Array of strings |
Policy management server list |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Create a custom scan policy. Set the policy name to Custom scan-20250416174356, scan directory to /root, handling action to Auto handling, server list to 09724867-7b91-482d-9702-daf9113f1b62, and start type to Immediate. The scan task does not consume the pay-per-use quota.
{ "policy_name" : "Custom scan - 20250416174356", "start_type" : "now", "file_types" : [ 1, 2, 3, 4 ], "scan_dir" : "/root", "action" : "auto", "whether_paid_task" : false, "host_ids" : [ "09724867-7b91-482d-9702-daf9113f1b62" ] }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Create a custom scan policy. Set the policy name to Custom scan-20250416174356, scan directory to /root, handling action to Auto handling, server list to 09724867-7b91-482d-9702-daf9113f1b62, and start type to Immediate. The scan task does not consume the pay-per-use quota.
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 |
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 CreateAntiVirusPolicySolution { 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(); CreateAntiVirusPolicyRequest request = new CreateAntiVirusPolicyRequest(); CreateAntiVirusPolicyRequestBody body = new CreateAntiVirusPolicyRequestBody(); List<String> listbodyHostIds = new ArrayList<>(); listbodyHostIds.add("09724867-7b91-482d-9702-daf9113f1b62"); List<Integer> listbodyFileTypes = new ArrayList<>(); listbodyFileTypes.add(1); listbodyFileTypes.add(2); listbodyFileTypes.add(3); listbodyFileTypes.add(4); body.withHostIds(listbodyHostIds); body.withWhetherPaidTask(false); body.withAction("auto"); body.withScanDir("/root"); body.withFileTypes(listbodyFileTypes); body.withStartType("now"); body.withPolicyName("Custom scan - 20250416174356"); request.withBody(body); try { CreateAntiVirusPolicyResponse response = client.createAntiVirusPolicy(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()); } } } |
Create a custom scan policy. Set the policy name to Custom scan-20250416174356, scan directory to /root, handling action to Auto handling, server list to 09724867-7b91-482d-9702-daf9113f1b62, and start type to Immediate. The scan task does not consume the pay-per-use quota.
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 |
# 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 = CreateAntiVirusPolicyRequest() listHostIdsbody = [ "09724867-7b91-482d-9702-daf9113f1b62" ] listFileTypesbody = [ 1, 2, 3, 4 ] request.body = CreateAntiVirusPolicyRequestBody( host_ids=listHostIdsbody, whether_paid_task=False, action="auto", scan_dir="/root", file_types=listFileTypesbody, start_type="now", policy_name="Custom scan - 20250416174356" ) response = client.create_anti_virus_policy(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create a custom scan policy. Set the policy name to Custom scan-20250416174356, scan directory to /root, handling action to Auto handling, server list to 09724867-7b91-482d-9702-daf9113f1b62, and start type to Immediate. The scan task does not consume the pay-per-use quota.
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 |
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.CreateAntiVirusPolicyRequest{} var listHostIdsbody = []string{ "09724867-7b91-482d-9702-daf9113f1b62", } var listFileTypesbody = []int32{ int32(1), int32(2), int32(3), int32(4), } scanDirCreateAntiVirusPolicyRequestBody:= "/root" request.Body = &model.CreateAntiVirusPolicyRequestBody{ HostIds: listHostIdsbody, WhetherPaidTask: false, Action: "auto", ScanDir: &scanDirCreateAntiVirusPolicyRequestBody, FileTypes: listFileTypesbody, StartType: "now", PolicyName: "Custom scan - 20250416174356", } response, err := client.CreateAntiVirusPolicy(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