CreatePolicyBindings - Cloud Backup - Alibaba Cloud Documentation Center

Binds one or more data sources to a backup policy.

Operation description

You can bind data sources to only one policy in each request.
Elastic Compute Service (ECS) instances can be bound to only one policy.

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	No	The ID of the backup policy.	po-000************8ep
PolicyBindingList	object []	No	The data sources that you want to bind to the backup policy.
PolicyBindingDescription	string	No	The description of the association.	Bind data sources to a backup policy
DataSourceId	string	No	The ID of the data source.	i-bp1************dl8
SourceType	string	No	The type of the data source. Valid values: UDM_ECS: ECS instance backup	UDM_ECS
Source	string	No	The prefix of the path to the folder that you want to back up. By default, the entire OSS bucket is backed up.	backup/
AdvancedOptions	object	No	Advanced options.
UdmDetail	object	No	The details of 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 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 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 advanced options for OSS backup.
InventoryId	string	No	OSS inventory name. If you want to back up more than 100 million OSS objects, we recommend that you use inventories to accelerate incremental backup. Storage fees for inventory lists are included into your OSS bills. OSS inventory file generation takes time. The backup may fail before the OSS inventory file is generated. You can wait for the next cycle to execute.	oss-inventory-default
InventoryCleanupPolicy	string	No	Whether delete inventory file after backup. NO_CLEANUP: Do not delete. DELETE_CURRENT: Delete current. DELETE_CURRENT_AND_PREVIOUS: Delete all.	NO_CLEANUP
CrossAccountType	string	No	Specifies whether data is backed up and restored within the same Alibaba Cloud account or across Alibaba Cloud accounts. Valid values: SELF_ACCOUNT: Data is backed up and restored within the same Alibaba Cloud account. CROSS_ACCOUNT: Data is backed up and restored across Alibaba Cloud accounts.	SELF_ACCOUNT
CrossAccountUserId	long	No	The source Alibaba Cloud account ID when backup across Alibaba Cloud accounts.	144**********732
CrossAccountRoleName	string	No	The name of the RAM role that is created within the source Alibaba Cloud account and assigned to the current Alibaba Cloud account to authorize the current Alibaba Cloud account to back up data across Alibaba Cloud accounts.	hbrcrossrole

Response parameters

Parameter	Type	Description	Example
	object	CreatePolicyBindingsResponse
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Code	string	The HTTP status code. The status code 200 indicates that the call is successful.	200
Message	string	The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.	successful
RequestId	string	The ID of the request.	82CC5B6C-72F7-5D39-92F6-67887DF9AD46

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "82CC5B6C-72F7-5D39-92F6-67887DF9AD46"
}

Error codes

HTTP status code	Error code	Error message
400	PolicyAlreadyBoundWithThisDataSource	This datasource has already been bound with the policy, please use another one.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history