Updates a backup plan.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
hbr:UpdateBackupPlan | update | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
PlanId | string | Yes | The ID of the backup plan. | plan-20211***735 |
PlanName | string | No | The name of the backup plan. | planname |
Schedule | string | No | The backup policy. Format:
| I|1602673264|P1D |
Retention | long | Yes | The retention period of the backup data. Minimum value: 1. Unit: days. | 7 |
Prefix | string | No | This parameter is required only if the SourceType parameter is set to OSS. This parameter specifies the prefix of objects that you want to back up. After a prefix is specified, only objects whose names start with the prefix are backed up. | oss-prefix |
VaultId | string | Yes | The ID of the backup vault. | v-0006******q |
Detail | object | No | The details about ECS instance backup. The value is a JSON string.
| {\"EnableFsFreeze\":true,\"appConsistent\":false,\"postScriptPath\":\"\",\"preScriptPath\":\"\",\"snapshotGroup\":true,\"timeoutInSeconds\":60} |
SourceType | string | No | The type of the data source. Valid values:
| ECS_FILE |
SpeedLimit | string | No | This parameter is required only if the SourceType parameter is set to ECS_FILE. This parameter specifies the throttling rules. To ensure business continuity, you can limit the bandwidth that is used for file backup during peak hours. Format:
| 0:24:5120 |
Include | string | No | This parameter is required only if the SourceType parameter is set to ECS_FILE. This parameter specifies the paths to the files that you want to back up. The value must be 1 to 255 characters in length. | ["/home/alice/*.pdf", "/home/bob/*.txt"] |
Exclude | string | No | This parameter is required only if the SourceType parameter is set to ECS_FILE. This parameter specifies the paths to the files that are excluded from the backup job. The value must be 1 to 255 characters in length. | ["/var", "/proc"] |
Options | string | No | This parameter is required only if the SourceType parameter is set to ECS_FILE. This parameter specifies whether to use Windows Volume Shadow Copy Service (VSS) to define a source path.
| {"UseVSS":false} |
UpdatePaths | boolean | No | Specifies whether to update the source path if the backup source is empty. Valid values:
| false |
Path | array | No | The source paths. | |
string | No | The source paths. The value must be 1 to 65,536 characters in length. You must specify source paths based on the following rules:
| ["/home"] | |
Rule | array<object> | No | The rule of the backup plan. | |
object | No | |||
DestinationRetention | long | No | The retention period of the backup data. Unit: days. | 7 |
Schedule | string | No | The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day. startTime: the time at which the system starts to run a backup job. The time must follow the UNIX time format. Unit: seconds. interval: the interval at which the system runs a backup job. The interval must follow the ISO 8601 standard. For example, PT1H specifies an interval of one hour. P1D specifies an interval of one day. | I|1631685600|P1D |
Disabled | boolean | No | Specifies whether to disable the policy. | false |
Retention | long | No | The retention period of the backup data. Minimum value: 1. Unit: days. | 7 |
DoCopy | boolean | No | Specifies whether to enable remote replication. | false |
DestinationRegionId | string | No | The ID of the region where the remote backup vault resides. | cn-shanghai |
RuleName | string | No | The name of the backup policy. | rule-test-name |
BackupType | string | No | The backup type. Valid value: COMPLETE, which indicates full backup. | COMPLETE |
OtsDetail | OtsDetail | No | The details about the Tablestore instance. | |
KeepLatestSnapshots | long | No | Specifies whether to enable the feature of keeping at least one backup version. Valid values:
| 1 |
ChangeListPath | string | No | The configurations of the incremental file synchronization. This parameter is required for data synchronization only. | {"dataSourceId": "ds-123456789", "path": "/changelist"} |
Response parameters
Examples
Sample success responses
JSON
format
{
"Code": "200",
"Message": "successful",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"Success": true
}
Error codes
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|