Enabling Ransomware Protection 2.0 in Batches
Function
Enable ransomware prevention for multiple servers at a time. If you want to enable backup, ensure CBR is available in the region.
Calling Method
For details, see Calling APIs.
URI
POST /v5/{project_id}/ransomware/protection/batch-open
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 |
---|---|---|---|
operating_system |
Yes |
String |
OS. Its value can be:
|
ransom_protection_status |
Yes |
String |
Whether ransomware protection is enabled. Its value can be:
If this parameter is enabled, protection_policy_id must be specified. |
protection_policy_id |
No |
String |
Protection policy ID. This parameter is mandatory if ransom_protection_status is opened. |
backup_protection_status |
Yes |
String |
Whether to back up data on the server. Its value can be:
If server backup is enabled, vault_id is mandatory. |
vault_id |
No |
String |
ID of the repository to be bound. This parameter is mandatory if backup_protection_status is opened. |
host_id_list |
Yes |
Array of strings |
IDs of servers where protection is enabled |
Response Parameters
Status code: 200
Request succeeded.
None
Example Requests
Enable ransomware protection for the server. The OS type is Linux, the target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the protection policy ID is d6439f9b-4407-3ebd-a14d-26b2e625fe17. Server backup is disabled.
{ "ransom_protection_status" : "opened", "backup_protection_status" : "closed", "operating_system" : "Linux", "protection_policy_id" : "d6439f9b-4407-3ebd-a14d-26b2e625fe17", "host_id_list" : [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ] }
Example Responses
None
SDK Sample Code
The SDK sample code is as follows.
Enable ransomware protection for the server. The OS type is Linux, the target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the protection policy ID is d6439f9b-4407-3ebd-a14d-26b2e625fe17. Server backup is disabled.
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 |
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 BatchStartProtectionSolution { 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(); BatchStartProtectionRequest request = new BatchStartProtectionRequest(); BatchStartProtectionRequestInfo body = new BatchStartProtectionRequestInfo(); List<String> listbodyHostIdList = new ArrayList<>(); listbodyHostIdList.add("71a15ecc-049f-4cca-bd28-5e90aca1817f"); body.withHostIdList(listbodyHostIdList); body.withBackupProtectionStatus("closed"); body.withProtectionPolicyId("d6439f9b-4407-3ebd-a14d-26b2e625fe17"); body.withRansomProtectionStatus("opened"); body.withOperatingSystem("Linux"); request.withBody(body); try { BatchStartProtectionResponse response = client.batchStartProtection(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()); } } } |
Enable ransomware protection for the server. The OS type is Linux, the target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the protection policy ID is d6439f9b-4407-3ebd-a14d-26b2e625fe17. Server backup is disabled.
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 |
# 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 = BatchStartProtectionRequest() listHostIdListbody = [ "71a15ecc-049f-4cca-bd28-5e90aca1817f" ] request.body = BatchStartProtectionRequestInfo( host_id_list=listHostIdListbody, backup_protection_status="closed", protection_policy_id="d6439f9b-4407-3ebd-a14d-26b2e625fe17", ransom_protection_status="opened", operating_system="Linux" ) response = client.batch_start_protection(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Enable ransomware protection for the server. The OS type is Linux, the target server ID is 71a15ecc-049f-4cca-bd28-5e90aca1817f, and the protection policy ID is d6439f9b-4407-3ebd-a14d-26b2e625fe17. Server backup is disabled.
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 |
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.BatchStartProtectionRequest{} var listHostIdListbody = []string{ "71a15ecc-049f-4cca-bd28-5e90aca1817f", } protectionPolicyIdBatchStartProtectionRequestInfo:= "d6439f9b-4407-3ebd-a14d-26b2e625fe17" request.Body = &model.BatchStartProtectionRequestInfo{ HostIdList: listHostIdListbody, BackupProtectionStatus: "closed", ProtectionPolicyId: &protectionPolicyIdBatchStartProtectionRequestInfo, RansomProtectionStatus: "opened", OperatingSystem: "Linux", } response, err := client.BatchStartProtection(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