UpdatePolicyBinding - Cloud Backup - Alibaba Cloud Documentation Center

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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. true: disables the backup policy for the data source false: enables the backup policy for the data source	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: true: creates application-consistent snapshots. false: creates file system-consistent snapshots. 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. 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 in your OSS bills. An extended period 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 after a backup is complete. This parameter is available only when OSS inventory lists 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

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-01-05

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2023-10-17

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2023-08-16

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.

2023-03-29

The internal configuration of the API is changed, but the call is not affected

see changesets

Change item	Change content
	The internal configuration of the API is changed, but the call is not affected.