Configure Anti-Ransomware Backup Policy via ModifyBackupPolicy API - Security Center - Alibaba Cloud - Security Center

Modifies an anti-ransomware policy.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ModifyBackupPolicy

update

*BackupPolicy

acs:yundun-sas:{#regionId}:{#accountId}:backuppolicy/{#BackupPolicyId}

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the anti-ransomware policy to modify.	11
Name	string	Yes	The name of the anti-ransomware policy to modify.	policy_name_A
Policy	object	Yes	The content of the policy to modify. The value is a JSON format character string that contains the following fields: Source: The server folder to protect. To protect all folders, set this field to []. Include: The file types to protect. Examples: ".jpg" and ".doc". Exclude: The custom folders to exclude. For example, "/home/user" excludes the /home/user folder. Invoke the DescribeExcludeSystemPath operation to obtain all folders, and then add the folders that you want to exclude. Schedule: The start time and interval of the data backup node. Specify a non-hourly time during off-peak hours. Example 1: I\|1583216092\|P21D indicates that the execute start time is 2020-03-03 14:14:52 and the interval is 3 weeks. Example 2: I\|1583216092\|PT24H indicates that the execute start time is 2020-03-03 14:14:52 and the interval is 24 hours. Retention: The retention period of backup data. Unit: days. 7 indicates 1 week, 365 indicates 1 year, and -1 indicates permanent retention. SpeedLimiter: The network bandwidth throttling for backup. For example, 12:15:15360\|6:12:5120 indicates 15 MB from 12:00 to 15:00 and 5 MB from 6:00 to 12:00. For cloud-based servers connected to the internal network, do not limit the backup network bandwidth. To remove the network bandwidth throttling, set this parameter to an empty character string ("").	{"Source":["home","admin"]}
PolicyVersion	string	No	The version of the policy. You can invoke the DescribeBackupPolicies operation to query the version. 1.0.0 2.0.0	2.0.0
PolicyRegionId	string	No	The region of the server for which you want to modify the policy. You can invoke the DescribeSupportRegion operation to query the regions supported by the anti-ransomware feature.	cn-hangzhou
UuidList	array	No	The list of UUIDs of the servers protected by the policy.	["3bb30859-b3b5-4f28-868f-b0892c98**", "3bb30859-b3b5-4f28-868f-b0892c98**"]
	string	No	The list of UUIDs of the servers to protect. Separate multiple UUIDs with commas (,). Note You can call the DescribeCloudCenterInstances operation to obtain the UUIDs of servers. This parameter is invalid when SelectType is set to ALL_MACHINE.	3bb30859-b3b5-4f28-868f-b0892c98****
ServerType	string	No	The server type. Valid values: ALIYUN: Alibaba Cloud server OUT_CLOUD: non-Alibaba Cloud server TRIPARTITE: simple application server	ALIYUN
SelectType	string	No	The method used to select assets. Valid values: ALL_MACHINE: all assets Note To cover all assets of the specified type, set this parameter to ALL_MACHINE. In this case, UuidList is invalid. Only one policy that covers all assets can exist for each server type.	ALL_MACHINE

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	D0D6E6E4-CB8C-4897-B852-46AEFDA04B21

Examples

Success response

JSON format

{
  "RequestId": "D0D6E6E4-CB8C-4897-B852-46AEFDA04B21"
}

Error codes

HTTP status code	Error code	Error message	Description
400	AgentNotOnline	The agent not online.	The error message returned because the Security Center agent is offline. Make sure that the Security Center agent is online and try again.
400	ServerTypeAllAssetPolicyExist	The policy for all asset of this server type already exists.	A policy that covers all assets already exists under the current type,do not configure it again.
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.