Enabling Ransomware Protection 2.0 in Batches
Function
This API is used to enable ransomware prevention for multiple servers at a time. If you want to enable backup, ensure CBR is available in the region.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
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
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
