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 |
Project ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
ID of the enterprise project that a server belongs. An enterprise project can be configured only after the enterprise project function is enabled. Enterprise project ID. The value 0 indicates the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you have only the permission on an enterprise project, you need to transfer the enterprise project ID to query the server in the enterprise project. Otherwise, an error is reported due to insufficient permission. |
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. |
region |
No |
String |
Region ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
policy_id |
Yes |
String |
Parameter description: Policy ID Constraints: N/A Options: The value contains 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 |
Parameter description: Whether to enable dynamic bait protection. The options are as follows. By default, dynamic bait protection is disabled. Constraints: N/A Options: There are two types:
Default value: closed |
protection_directory |
Yes |
String |
Parameter description: Protected directory. Separate multiple directories with semicolons (;). You can configure up to 20 directories. Constraints: N/A Options: The value contains 0 to 128 characters. 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 |
Parameter description: (Optional) Excluded directory. Separate multiple directories with semicolons (;). You can configure up to 20 directories. Constraints: N/A Options: The value contains 0 to 128 characters. Default value: N/A |
agent_id_list |
No |
Array of strings |
Parameter description: IDs of the agents for which the ransomware protection policy is enabled Constraints: N/A Options: The list contains a maximum of 1000 records. The value contains 0 to 128 characters. 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 |
Parameter description: Whether to perform runtime checks. The options are as follows. Currently, it can only be disabled. This field is reserved.
Constraints: N/A Options: There are two types: N/A Default value: N/A |
process_whitelist |
No |
Array of TrustProcessInfo objects |
Process whitelist |
ai_protection_status |
No |
String |
Parameter description: Whether to enable AI ransomware protection. The options are as follows. By default, AI ransomware protection is disabled. Currently, only the Windows operating system is involved. Constraints: N/A Options: There are two types:
Default value: closed |
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