All Products
Search
Document Center

Security Center:CreateUniBackupPolicy

Last Updated:Nov 13, 2024

Creates an anti-ransomware policy for a database.

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:CreateUniBackupPolicycreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
PolicyNamestringYes

The name of the anti-ransomware policy.

mysql-policy
InstanceIdstringYes

The ID of the Elastic Compute Service (ECS) instance.

Note You can call the DescribeUniBackupDatabase operation to query the IDs of ECS instances.
i-bp1fu4aqltf1huhc****
UuidstringNo

The UUID of the server whose data is backed up based on the anti-ransomware policy.

Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.
045cad48-eb08-4047-a70c-713aec7b****
DatabaseTypestringYes

The type of the database. Valid values:

  • MYSQL
  • ORACLE
  • MSSQL
MYSQL
RetentionintegerYes

The retention period of backup data.

7
SpeedLimiterlongYes

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

5242880
AccountNamestringNo

The name of the database account.

admin
AccountPasswordstringNo

The password of the database account.

Pass****
DatabaseAddByUserstringNo

Specifies whether the database is manually added. Valid values:

  • true: yes
  • false: no
true
UniRegionIdstringYes

The region in which the server resides.

cn-hangzhou
FullPlanobjectYes

The policy for full data backup. The value of this parameter is a JSON string. The JSON string 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"}
IncPlanobjectYes

The policy for incremental data backup. The value of this parameter is a JSON string. The JSON string 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"}

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

2FAEB7D0-C0B9-581C-877A-F80F50AA****

Examples

Sample success responses

JSONformat

{
  "RequestId": "2FAEB7D0-C0B9-581C-877A-F80F50AA****"
}

Error codes

HTTP status codeError codeError messageDescription
400FailedToActivateUniBackupInstanceFailed to activate unbackup instance.Password verification error, please try again!
400AntiRansomwareCapacityUseUpanti ransomware capacity use up-
400DatabaseTypeNotSupportDatabase type not supported.-
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
2024-10-08The Error code has changedView Change Details
2023-03-23The Error code has changedView Change Details