Modifies the association between a backup policy and a data source.
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 Resourcesis 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:UpdatePolicyBinding | update |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| PolicyId | string | Yes | The ID of the backup policy. | po-000************ky9 |
| DataSourceId | string | Yes | The ID of the data source. | i-bp1************dtv |
| SourceType | string | Yes | The type of the data source. Valid values:
| UDM_ECS |
| PolicyBindingDescription | string | No | The description of the association. | po-000************5xx-i-2ze************nw4 |
| Disabled | boolean | No | Specifies whether to disable the backup policy for the data source. Valid values:
| true |
| AdvancedOptions | object | No | The advanced options. | |
| UdmDetail | object | No | The backup details of the Elastic Compute Service (ECS) instance. | |
| ExcludeDiskIdList | array | No | The IDs of the disks that require no protection. This parameter is not required if the DiskIdList parameter is specified. | |
| string | No | The ID of the disk that requires no protection. | d-bp1************apo | |
| DiskIdList | array | No | The IDs of the disks that require protection. This parameter is not required if all disks require protection. | |
| string | No | The ID of the disk that requires protection. | d-bp1************apo | |
| SnapshotGroup | boolean | No | Specifies whether to create a snapshot-consistent group. You can create a snapshot-consistent group only if all disks are enhanced SSDs (ESSDs). | true |
| AppConsistent | boolean | No | Specifies whether to enable application consistency. You can enable application consistency only if all disks are ESSDs. | false |
| RamRoleName | string | No | This parameter is required only if the AppConsistent parameter is set to true. This parameter specifies the name of the Resource Access Management (RAM) role that is required to create application-consistent snapshots. | AliyunECSInstanceForHbrRole |
| PreScriptPath | string | No | This parameter is required only if the AppConsistent parameter is set to true. This parameter specifies the path of the pre-freeze scripts that are executed before application-consistent snapshots are created. | /tmp/prescript.sh |
| PostScriptPath | string | No | This parameter is required only if the AppConsistent parameter is set to true. This parameter specifies the path of the post-thaw scripts that are executed after application-consistent snapshots are created. | /tmp/postscript.sh |
| EnableFsFreeze | boolean | No | This parameter is required only if the AppConsistent parameter is set to true. This parameter specifies whether to enable Linux fsfreeze to put file systems into the read-only state before application-consistent snapshots are created. Default value: true. | true |
| TimeoutInSeconds | long | No | This parameter is required only if the AppConsistent parameter is set to true. This parameter specifies the I/O freeze timeout period. Default value: 30. Unit: seconds. | 30 |
| EnableWriters | boolean | No | This parameter is required only if the AppConsistent parameter is set to true. This parameter specifies whether to create application-consistent snapshots. Valid values:
Default value: true. | true |
| OssDetail | object | No | The details of the Object Storage Service (OSS) backup. | |
| InventoryId | string | No | The name of the OSS inventory list. The OSS inventory list specified for this parameter is used for performance optimization.
| 30663060 |
| InventoryCleanupPolicy | string | No | Specifies whether the system deletes the inventory lists after a backup is complete. This parameter is available only when OSS inventory lists are used. Valid values:
| NO_CLEANUP |
Response parameters
Examples
Sample success responses
JSONformat
{
"Success": true,
"Code": "200",
"Message": "successful",
"RequestId": "B6F24C46-54B9-519B-9AB8-A8988D705E67"
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-03-13 | The request parameters of the API has changed | View Change Details |
| 2024-01-05 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-10-17 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-08-16 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2023-03-29 | The internal configuration of the API is changed, but the call is not affected | View Change Details |