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 |
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 contains 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 |
No |
Integer |
Definition Start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value 0 |
limit |
No |
Integer |
Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10 |
policy_name |
No |
String |
Definition Protection policy name. Constraints N/A Range The value can contain 0 to 255 characters. Default Value N/A |
protect_policy_id |
No |
String |
Definition Protection policy ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
operating_system |
No |
String |
Definition OS supported by the policy. Constraints N/A Range Its value can be:
Default Value N/A |
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 |
region |
No |
String |
Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total_num |
Integer |
Definition Total number of policies. Range Value range: 0 to 2,097,152 |
data_list |
Array of ProtectionPolicyInfo objects |
Definition Query the protection policy list. Range Value range: 0 to 2,097,152 |
Parameter |
Type |
Description |
---|---|---|
policy_id |
String |
Parameter description: Policy ID Options: The value contains 0 to 128 characters. |
policy_name |
String |
Parameter description: Protection policy name Options: The value contains 1 to 128 characters. |
protection_mode |
String |
Definition Action. Range The options are as follows:
|
bait_protection_status |
String |
Definition Whether to enable honeypot protection. Range The options are as follows. By default, honeypot protection is enabled.
|
deploy_mode |
String |
Definition Whether to enable dynamic honeypot protection. Range The options are as follows. By default, dynamic honeypot protection is disabled.
|
protection_directory |
String |
Parameter description: Protected directory Options: The value contains 1 to 128 characters. |
protection_type |
String |
Parameter description: Protected file type, for example, .docx, .txt, or .avi. Options: The value contains 1 to 128 characters. |
exclude_directory |
String |
Parameter description: (Optional) excluded directory Options: The value contains 1 to 128 characters. |
runtime_detection_status |
String |
Definition Whether to perform runtime checks. Range The options are as follows. Currently, it can only be disabled. This field is reserved.
|
runtime_detection_directory |
String |
Parameter description: Runtime check directory. This field is reserved. Options: The value contains 1 to 128 characters. |
count_associated_server |
Integer |
Parameter description: Number of associated servers Options: Value range: 0-2097152 |
operating_system |
String |
Parameter description: OS type.
Options: The value contains 1 to 128 characters. |
process_whitelist |
Array of TrustProcessInfo objects |
Process whitelist |
default_policy |
Integer |
Definition Whether a policy is the default policy. Range The options are as follows:
|
ai_protection_status |
String |
Parameter description: Whether to enable AI ransomware protection. The options are as follows. By default, AI ransomware protection is enabled.
Options: The value contains 1 to 128 characters. |
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
Request succeeded.
{ "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 |
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"); 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(); ListProtectionPolicyRequest request = new ListProtectionPolicyRequest(); 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 |
# 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 = ListProtectionPolicyRequest() 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 |
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.ListProtectionPolicyRequest{} 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 |
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