Modifying Ransomware Protection Policies
Function
This API is used to modify ransomware protection policies.
Calling Method
For details, see Calling APIs.
URI
PUT /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. |
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 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
policy_id |
Yes |
String |
Definition ID of a protection policy to be modified. You can obtain the ID by calling the API for Querying the Ransomware Protection Policy List. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
policy_name |
Yes |
String |
Parameter description: Policy Name Constraints: N/A Options: The value contains 0 to 128 characters. Default value: N/A |
protection_mode |
Yes |
String |
Parameter description: Protective Actions Constraints: N/A Options: There are two types:
Default value: N/A |
bait_protection_status |
No |
String |
Parameter description: Whether to enable honeypot protection Constraints: N/A Options:
Default value: N/A |
deploy_mode |
No |
String |
Definition Whether to enable dynamic honeypots. Constraints N/A Range The options are as follows:
Default Value closed |
protection_directory |
Yes |
String |
Definition Protected directory. Constraints Separate multiple directories with semicolons (;). You can configure up to 20 directories. Range The value can contain 0 to 128 characters. Only the following special characters are allowed: ._+-. The value cannot start with a space. Up to 256 characters are allowed. Default Value N/A |
protection_type |
Yes |
String |
Parameter description: Protected file type, for example, .docx, .txt, or .avi. Constraints: N/A Options: The value contains 0 to 128 characters. Default value: N/A |
exclude_directory |
No |
String |
Definition (Optional) Excluded directory. Constraints Separate multiple directories with semicolons (;). You can configure up to 20 excluded directories. Range The value can contain 0 to 128 characters. Only the following special characters are allowed: ._+-. The value cannot start with a space. Up to 256 characters are allowed. Default Value N/A |
agent_id_list |
No |
Array of strings |
Definition IDs of the agents for which the ransomware protection policy is enabled. Constraints N/A Range The maximum number of items in the list is 1,000. Default Value N/A |
operating_system |
Yes |
String |
Parameter description: Operating systems that support the policy Constraints: N/A Options: There are two types:
Default value: N/A |
runtime_detection_status |
No |
String |
Definition Whether to perform runtime checks. Constraints N/A Range The options are as follows. Currently, it can only be disabled. This field is reserved.
Default Value N/A |
process_whitelist |
No |
Array of TrustProcessInfo objects |
Process whitelist |
ai_protection_status |
No |
String |
Definition Whether to enable AI ransomware protection. The options are as follows: Constraints Currently, this parameter is available only for Windows. Range The options are as follows:
Default Value closed |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
path |
No |
String |
Definition Process path. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
hash |
No |
String |
Definition Process hash. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
PUT https://{endpoint}/v5/{project_id}/ransomware/protection/policy
{
"bait_protection_status" : "opened",
"protection_type" : "docx",
"exclude_directory" : "",
"operating_system" : "Linux",
"policy_id" : "0253edfd-30e7-439d-8f3f-17c54c997064",
"policy_name" : "aaa",
"protection_mode" : "alarm_only",
"protection_directory" : "/root",
"runtime_detection_status" : "closed",
"agent_id_list" : [ "" ]
}
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
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 |
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 UpdateProtectionPolicySolution {
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();
UpdateProtectionPolicyRequest request = new UpdateProtectionPolicyRequest();
UpdateProtectionPolicyInfoRequestInfo body = new UpdateProtectionPolicyInfoRequestInfo();
List<String> listbodyAgentIdList = new ArrayList<>();
listbodyAgentIdList.add("");
body.withRuntimeDetectionStatus("closed");
body.withOperatingSystem("Linux");
body.withAgentIdList(listbodyAgentIdList);
body.withExcludeDirectory("");
body.withProtectionType("docx");
body.withProtectionDirectory("/root");
body.withBaitProtectionStatus("opened");
body.withProtectionMode("alarm_only");
body.withPolicyName("aaa");
body.withPolicyId("0253edfd-30e7-439d-8f3f-17c54c997064");
request.withBody(body);
try {
UpdateProtectionPolicyResponse response = client.updateProtectionPolicy(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());
}
}
}
|
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
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 = UpdateProtectionPolicyRequest()
listAgentIdListbody = [
""
]
request.body = UpdateProtectionPolicyInfoRequestInfo(
runtime_detection_status="closed",
operating_system="Linux",
agent_id_list=listAgentIdListbody,
exclude_directory="",
protection_type="docx",
protection_directory="/root",
bait_protection_status="opened",
protection_mode="alarm_only",
policy_name="aaa",
policy_id="0253edfd-30e7-439d-8f3f-17c54c997064"
)
response = client.update_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)
|
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
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 |
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.UpdateProtectionPolicyRequest{}
var listAgentIdListbody = []string{
"",
}
runtimeDetectionStatusUpdateProtectionPolicyInfoRequestInfo:= "closed"
excludeDirectoryUpdateProtectionPolicyInfoRequestInfo:= ""
baitProtectionStatusUpdateProtectionPolicyInfoRequestInfo:= "opened"
request.Body = &model.UpdateProtectionPolicyInfoRequestInfo{
RuntimeDetectionStatus: &runtimeDetectionStatusUpdateProtectionPolicyInfoRequestInfo,
OperatingSystem: "Linux",
AgentIdList: &listAgentIdListbody,
ExcludeDirectory: &excludeDirectoryUpdateProtectionPolicyInfoRequestInfo,
ProtectionType: "docx",
ProtectionDirectory: "/root",
BaitProtectionStatus: &baitProtectionStatusUpdateProtectionPolicyInfoRequestInfo,
ProtectionMode: "alarm_only",
PolicyName: "aaa",
PolicyId: "0253edfd-30e7-439d-8f3f-17c54c997064",
}
response, err := client.UpdateProtectionPolicy(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.
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
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 |
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 UpdateProtectionPolicySolution {
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();
UpdateProtectionPolicyRequest request = new UpdateProtectionPolicyRequest();
UpdateProtectionPolicyInfoRequestInfo body = new UpdateProtectionPolicyInfoRequestInfo();
List<String> listbodyAgentIdList = new ArrayList<>();
listbodyAgentIdList.add("");
body.withRuntimeDetectionStatus("closed");
body.withOperatingSystem("Linux");
body.withAgentIdList(listbodyAgentIdList);
body.withExcludeDirectory("");
body.withProtectionType("docx");
body.withProtectionDirectory("/root");
body.withBaitProtectionStatus("opened");
body.withProtectionMode("alarm_only");
body.withPolicyName("aaa");
body.withPolicyId("0253edfd-30e7-439d-8f3f-17c54c997064");
request.withBody(body);
try {
UpdateProtectionPolicyResponse response = client.updateProtectionPolicy(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());
}
}
}
|
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
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 = UpdateProtectionPolicyRequest()
listAgentIdListbody = [
""
]
request.body = UpdateProtectionPolicyInfoRequestInfo(
runtime_detection_status="closed",
operating_system="Linux",
agent_id_list=listAgentIdListbody,
exclude_directory="",
protection_type="docx",
protection_directory="/root",
bait_protection_status="opened",
protection_mode="alarm_only",
policy_name="aaa",
policy_id="0253edfd-30e7-439d-8f3f-17c54c997064"
)
response = client.update_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)
|
Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.
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 |
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.UpdateProtectionPolicyRequest{}
var listAgentIdListbody = []string{
"",
}
runtimeDetectionStatusUpdateProtectionPolicyInfoRequestInfo:= "closed"
excludeDirectoryUpdateProtectionPolicyInfoRequestInfo:= ""
baitProtectionStatusUpdateProtectionPolicyInfoRequestInfo:= "opened"
request.Body = &model.UpdateProtectionPolicyInfoRequestInfo{
RuntimeDetectionStatus: &runtimeDetectionStatusUpdateProtectionPolicyInfoRequestInfo,
OperatingSystem: "Linux",
AgentIdList: &listAgentIdListbody,
ExcludeDirectory: &excludeDirectoryUpdateProtectionPolicyInfoRequestInfo,
ProtectionType: "docx",
ProtectionDirectory: "/root",
BaitProtectionStatus: &baitProtectionStatusUpdateProtectionPolicyInfoRequestInfo,
ProtectionMode: "alarm_only",
PolicyName: "aaa",
PolicyId: "0253edfd-30e7-439d-8f3f-17c54c997064",
}
response, err := client.UpdateProtectionPolicy(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