Modify an anti-ransomware policy for databases using ModifyUniBackupPolicy - Security Center - Alibaba Cloud - Security Center

Modifies an anti-ransomware backup policy for databases.

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:ModifyUniBackupPolicy

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	integer	Yes	The ID of the anti-ransomware backup policy for databases. Note You can call the DescribeUniBackupPolicies operation to obtain this parameter.	123
PolicyName	string	No	The name of the anti-ransomware backup policy for databases.	databak
Retention	integer	No	The number of days for which backup snapshots are retained.	7
SpeedLimiter	integer	No	The network bandwidth throttling for backup network bandwidth. Unit: bytes.	1048576
AccountName	string	No	The username of the database account.	sa
AccountPassword	string	No	The password of the database account.	Sa@****
FullPlan	object	No	The full backup policy. The value is in JSON format and contains the following fields: start: the backup start time. interval: the interval. type: the unit of the interval. days: the days of the week on which the backup is performed.	{"days":[4],"interval":1,"planType":"weekly","startTime":"22:00:00"}
IncPlan	object	No	The incremental backup policy. The value is in JSON format and contains the following fields: start: the backup start time. interval: the interval. type: the unit of the interval. days: the days of the week on which the backup is performed.	{"interval":1,"planType":"daily","startTime":"23:30:00"}
PolicyStatus	string	No	The status of the policy. Valid values: enabled: The policy is enabled. disabled: The policy is disabled.	enabled

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.	3F6FAB39-5AF7-5B2C-A17D-16D52AE0****

Examples

Success response

JSON format

{
  "RequestId": "3F6FAB39-5AF7-5B2C-A17D-16D52AE0****"
}

Error codes

HTTP status code	Error code	Error message
400	FailedToActivateUniBackupInstance	Failed to activate unbackup instance.
400	AntiRansomwareCapacityUseUp	anti ransomware capacity use up
400	InvalidParam	There was an error with your request.
400	UniBackupPlanNotFound	The backup plan cannot be found.
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.