Querying the Protection Policy List of Ransomware
Function
This API is used to query the the protection policy list of ransomware.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/ransomware/protection/policy
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID Minimum: 1 Maximum: 256 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps. Default: 0 Minimum: 1 Maximum: 256 |
offset |
No |
Integer |
Offset, which specifies the start position of the record to be returned. Minimum: 0 Maximum: 2000000 Default: 0 |
limit |
No |
Integer |
Number of records displayed on each page. Minimum: 10 Maximum: 200 Default: 10 |
policy_name |
No |
String |
Policy name Minimum: 0 Maximum: 128 |
protect_policy_id |
No |
String |
Policy ID Minimum: 0 Maximum: 128 |
operating_system |
No |
String |
OSs supported by the policy. The options are as follows:
Minimum: 0 Maximum: 128 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 1 Maximum: 32768 |
region |
Yes |
String |
Region ID Minimum: 0 Maximum: 128 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Total number of policies Minimum: 0 Maximum: 2097152 |
data_list |
Array of ProtectionPolicyInfo objects |
Query the list of policies. Array Length: 0 - 10241 |
Parameter |
Type |
Description |
---|---|---|
policy_id |
String |
Policy ID Minimum: 0 Maximum: 128 |
policy_name |
String |
Policy name Minimum: 0 Maximum: 128 |
protection_mode |
String |
Action. Its value can be:
Minimum: 0 Maximum: 128 |
bait_protection_status |
String |
Whether to enable honeypot protection. By default, the protection is enabled. Its value can be:
Minimum: 0 Maximum: 128 |
deploy_mode |
String |
Whether to enable honeypot protection. The options are as follows. By default, dynamic honeypot protection is disabled.
Minimum: 0 Maximum: 128 |
protection_directory |
String |
Protected directory Minimum: 1 Maximum: 128 |
protection_type |
String |
Protected file type, for example, .docx, .txt, and .avi. Minimum: 0 Maximum: 128 |
exclude_directory |
String |
(Optional) excluded directory Minimum: 1 Maximum: 128 |
runtime_detection_status |
String |
Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved.
Minimum: 0 Maximum: 128 |
runtime_detection_directory |
String |
Directory to be checked during running. This field is reserved. Minimum: 1 Maximum: 128 |
count_associated_server |
Integer |
Number of associated servers Minimum: 0 Maximum: 2097152 |
operating_system |
String |
OS type.
Minimum: 0 Maximum: 128 |
process_whitelist |
Array of TrustProcessInfo objects |
Process whitelist Array Length: 0 - 20 |
default_policy |
Integer |
Indicates whether the policy is the default policy. The options are as follows:
Minimum: 0 Maximum: 10 |
Example Requests
Query the protection policy list of ransomware. If limit is not specified, 10 records are returned by default.
GET https://{endpoint}/v5/{project_id}/ransomware/protection/policy
Example Responses
Status code: 200
Protection policy list
{ "total_num" : 1, "data_list" : [ { "bait_protection_status" : "opened", "exclude_directory" : "/opt", "count_associated_server" : 0, "operating_system" : "Linux", "protection_mode" : "alarm_only", "policy_id" : "4117d16-074b-41ae-b7d7-9cc25ee258", "policy_name" : "test", "protection_directory" : "/dd", "protection_type" : "docx", "runtime_detection_status" : "closed" } ] }
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 48 49 50 51 |
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 ListProtectionPolicySolution { 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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListProtectionPolicyRequest request = new ListProtectionPolicyRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withOffset(<offset>); request.withLimit(<limit>); request.withPolicyName("<policy_name>"); request.withProtectPolicyId("<protect_policy_id>"); request.withOperatingSystem("<operating_system>"); try { ListProtectionPolicyResponse response = client.listProtectionPolicy(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 32 33 34 35 36 |
# 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"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListProtectionPolicyRequest() request.enterprise_project_id = "<enterprise_project_id>" request.offset = <offset> request.limit = <limit> request.policy_name = "<policy_name>" request.protect_policy_id = "<protect_policy_id>" request.operating_system = "<operating_system>" response = client.list_protection_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) |
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 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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListProtectionPolicyRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest policyNameRequest:= "<policy_name>" request.PolicyName = &policyNameRequest protectPolicyIdRequest:= "<protect_policy_id>" request.ProtectPolicyId = &protectPolicyIdRequest operatingSystemRequest:= "<operating_system>" request.OperatingSystem = &operatingSystemRequest response, err := client.ListProtectionPolicy(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 |
Protection policy 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