All Products
Search
Document Center

Security Center:ModifyUniBackupPolicy

Last Updated:Nov 13, 2024

Modifies an anti-ransomware policy for databases.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ModifyUniBackupPolicyupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyIdlongYes

The ID of the anti-ransomware policy.

Note You can call the DescribeUniBackupPolicies operation to query the IDs of anti-ransomware policies.
123
PolicyNamestringNo

The name of the anti-ransomware policy.

databak
RetentionintegerNo

The retention period of the backup snapshot.

7
SpeedLimiterlongNo

The maximum network bandwidth that is allowed during data backup. Unit: bytes.

1048576
AccountNamestringNo

The name of the database account.

sa
AccountPasswordstringNo

The password of the database account.

Sa@****
FullPlanobjectNo

The policy for full backup. The value of this parameter is a JSON string that contains the following fields:

  • start: the start time of a backup task
  • interval: the interval of backup tasks
  • type: the unit of the interval
  • days: the days of a week on which a backup task is performed
{"days":[4],"interval":1,"planType":"weekly","startTime":"22:00:00"}
IncPlanobjectNo

The policy for incremental backup. The value of this parameter is a JSON string that contains the following fields:

  • start: the start time of a backup task
  • interval: the interval of backup tasks
  • type: the unit of the interval
  • days: the days of a week on which a backup task is performed
{"interval":1,"planType":"daily","startTime":"23:30:00"}
PolicyStatusstringNo

The status of the anti-ransomware policy. Valid values:

  • enabled
  • disabled
enabled

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

3F6FAB39-5AF7-5B2C-A17D-16D52AE0****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400FailedToActivateUniBackupInstanceFailed to activate unbackup instance.Password verification error, please try again!
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-03-23The Error code has changedView Change Details