UpdatePolicyBinding - Cloud Backup - Alibaba Cloud Documentation Center

Modifies the association between a backup policy and a data source.

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.

Debug

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:UpdatePolicyBinding	update	All Resources ``	none	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: ECS instance backup	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: disables the backup policy for the data source false: enables the backup policy for the data source	true
Source	string	No	If the SourceType parameter is set to OSS, set the Source parameter to the prefix of the path to the folder that you want to back up. If you do not specify the Source parameter, the entire bucket (root directory) is backed up. If the SourceType parameter is set to ECS_FILE or File, set the Source parameter to the path to the files that you want to back up. If you do not specify the Source parameter, all paths backed up.	backup/
Include	string	No	This parameter is required only if you set the SourceType parameter to ECS_FILE or File. This parameter specifies the type of files to be backed up. All files of the specified type are backed up. The value can be up to 255 characters in length.	[\".doc\",\".xltm\"]
Exclude	string	No	This parameter is required only if you set the SourceType parameter to ECS_FILE or File. This parameter specifies the type of files that do not need to be backed up. No files of the specified type are backed up. The value can be up to 255 characters in length.	[\".doc\",\".xltm\"]
SpeedLimit	string	No	This parameter is required only if you set the SourceType parameter to ECS_FILE or File. This parameter specifies the throttling rules. Format: `{start}{end}{bandwidth}`. Separate multiple throttling rules with vertical bars (\|). The time ranges of the throttling rules cannot overlap. start: the start hour. end: the end hour. bandwidth: the bandwidth. Unit: KB/s.	0:24:5120
AdvancedOptions	object	No	The advanced options.
UdmDetail	object	No	The details about Elastic Compute Service (ECS) instance backup.
ExcludeDiskIdList	array	No	The IDs of the disks that do not need to be protected. If the DiskIdList parameter is not empty, this parameter is ignored.
	string	No	The ID of the disk that does not need to be protected.	d-bp1************apo
DiskIdList	array	No	The IDs of the disks that need to be protected. If all disks need to be protected, this parameter is empty.
	string	No	The ID of the disk that needs to be protected.	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 Enterprise 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 you set the AppConsistent parameter 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 you set the AppConsistent parameter 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 you set the AppConsistent parameter 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 you set the AppConsistent parameter 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 you set the AppConsistent parameter 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 you set the AppConsistent parameter to true. This parameter specifies whether to create application-consistent snapshots. Valid values: true: creates application-consistent snapshots false: creates file system-consistent snapshots Default value: true.	true
OssDetail	object	No	The details about Object Storage Service (OSS) backup.
InventoryId	string	No	The name of the OSS inventory. If this parameter is not empty, the OSS inventory is used for performance optimization. If you want to back up more than 100 million OSS objects, we recommend that you use inventory lists to accelerate incremental backup. Storage fees for inventory lists are included into your OSS bills. A certain amount of time is required for OSS to generate inventory lists. Before inventory lists are generated, OSS objects may fail to be backed up. In this case, you can back up the OSS objects in the next backup cycle.	30663060
InventoryCleanupPolicy	string	No	Specifies whether the system deletes the inventory lists when a backup is completed. This parameter is valid only when OSS inventories are used. Valid values: NO_CLEANUP: does not delete inventory lists. DELETE_CURRENT: deletes the current inventory list. DELETE_CURRENT_AND_PREVIOUS: deletes all inventory lists.	NO_CLEANUP
IgnoreArchiveObject	boolean	No	Do not prompt for archival type objects in task statistics and failed file lists.	true
CommonFileSystemDetail	object	No	The details about large-scale file system backup.
FullOnIncrementFail	boolean	No	Specifies whether the system performs full backup if incremental backup fails. Valid values: true: The system performs full backup if incremental backup fails. false: The system does not perform full backup if incremental backup fails.	true
FetchSliceSize	long	No	The size of backup shards (the number of files).	100000

Response parameters

Parameter	Type	Description	Example
	object	UpdatePolicyBindingResponse
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Code	string	The HTTP status code. The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, "successful" is returned. If the request failed, an error message is returned.	successful
RequestId	string	The request ID.	B6F24C46-54B9-519B-9AB8-A8988D705E67

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-11-13	The internal configuration of the API is changed, but the call is not affected	View Change Details
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