调用CreatePolicyBindings API将数据源绑定到备份策略-云备份-阿里云-云备份(Cloud Backup)-阿里云帮助中心

将一个或多个数据源绑定到某个策略。

接口说明

每次调用仅支持将相同类型的数据源绑定到同一个策略。
ECS 整机仅支持绑定到一个策略。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:CreatePolicyBindings

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
PolicyId	string	否	策略 ID。	po-000************8ep
PolicyBindingList	array<object>	否	策略绑定列表。
	array<object>	否	策略绑定详情。
PolicyBindingDescription	string	否	策略绑定描述。	这是一个策略绑定的描述。
DataSourceId	string	否	数据源 ID，根据 SourceType 字段表示不同含义： UDM_ECS：ECS 实例 ID。 OSS：OSS bucket 名称。 NAS：阿里云 NAS 文件系统 ID。 COMMON_NAS：本地 NAS 实例 ID。 ECS_FILE：ECS 实例 ID。 File：云备份客户端 ID。 COMMON_FILE_SYSTEM：CPFS 备份数据源 ID。	i-bp1************dl8
Disabled	string	否	策略对该数据源是否暂停生效。 true：暂停 false：未暂停	true
SourceType	string	否	数据源类型。取值范围： UDM_ECS：表示 ECS 整机备份。 OSS：表示 OSS 备份。 NAS：表示阿里云 NAS 备份。 COMMON_NAS：表示本地 NAS 备份。 ECS_FILE：表示 ECS 文件备份标准版。 File：表示本地文件备份。 COMMON_FILE_SYSTEM：表示 CPFS 备份。 OTS: 表示 Tablestore 备份。	UDM_ECS
Source	string	否	根据 SourceType 取值表示不同的含义，SourceType 为 OSS：表示备份某个 prefix，如果不指定，则表示备份整个 Bucket 根目录，仅支持单个 prefix。如果要备份/backup，则填写/backup ECS_FILE：表示备份的文件目录，如果不指定，则表示备份全部目录，支持同时指定多个目录。如果要备份路径/a 和路径/b 下的文件，则填写["/a", "/b"]。 File：表示备份的文件目录，如果不指定，则表示备份全部目录，支持同时指定多个目录。如果要备份/a 目录和/b 目录下的文件，则填写["/a", "/b"]。 COMMON_FILE_SYSTEM：必填，表示备份路径，支持同时指定多个路径。如果要备份/a 路径和/b 路径，则填写["/a", "/b"]，如果要备份根路径则填写["/"]。 COMMON_NAS：必填，表示备份路径，仅支持单个路径。如果要备份/a 路径则填写["/a"]，如果要备份根路径则填写["/"] OTS：表示备份的数据表列表，如果不指定，则表示备份全部数据表。支持同时指定多个数据表。如果要备份数据表 a 和数据表 b，则填写["a", "b"]。	backup/
Include	string	否	当 SourceType 取值为ECS_FILE、File、NAS、COMMON_NAS、COMMON_FILE_SYSTEM时，可以配置该参数。表示要进行备份的文件类型，这些类型的所有文件都备份。最多支持 255 个字符。	[\".doc\",\".xltm\"]
Exclude	string	否	当 SourceType 取值为ECS_FILE、File、NAS、COMMON_NAS、COMMON_FILE_SYSTEM时，可以配置该参数。表示不需要进行备份的文件类型，该类型的所有文件都不备份。最多支持 255 个字符。	[\".doc\",\".xltm\"]
SpeedLimit	string	否	仅当 SourceType 取值为ECS_FILE或 File 时，需要配置该参数。表示备份流量控制。格式为`{start}{end}{bandwidth}`。多个流量控制配置使用分隔，并且配置时间不允许有重叠。 start：起始小时。 end：结束小时。 bandwidth：限制速率，单位 KB/s。	0:24:1024
AdvancedOptions	object	否	高级选项。
UdmDetail	object	否	ECS 整机备份高级选项。
ExcludeDiskIdList	array	否	不需要保护的云盘 ID 列表。当 DiskIdList 不为空时，将忽略该参数。
	string	否	无需保护的云盘 ID。	d-bp1************apo
DiskIdList	array	否	需要保护的云盘 ID 列表。保护所有云盘时，该值为空。
	string	否	需要保护的云盘 ID。	d-bp1************apo
SnapshotGroup	boolean	否	是否创建快照一致性组。仅云盘类型全部为 ESSD 时，支持创建快照一致性组。	true
AppConsistent	boolean	否	是否创建应用一致性。仅云盘类型全部为 ESSD 时，支持创建快照应用一致性。	false
RamRoleName	string	否	仅当 AppConsistent 为 true 时，需要配置该参数。创建应用一致性快照需要配置的 RAM 角色名称。	AliyunECSInstanceForHbrRole
PreScriptPath	string	否	仅当 AppConsistent 为 true 时，需要配置该参数。创建应用一致性快照前执行的冻结脚本路径。	/tmp/prescript.sh
PostScriptPath	string	否	仅当 AppConsistent 为 true 时，需要配置该参数。创建应用一致性快照后执行的解冻脚本路径。	/tmp/postscript.sh
EnableFsFreeze	boolean	否	仅当 AppConsistent 为 true 时，需要配置该参数。是否在创建应用一致性快照前使用 Linux 的 FsFreeze 机制确保文件系统处于只读一致性。默认为 true。	true
TimeoutInSeconds	integer	否	仅当 AppConsistent 为 true 时，需要配置该参数。IO 冻结超时时间，单位为秒（s）。默认为 30 秒。	30
EnableWriters	boolean	否	仅当 AppConsistent 为 true 时，需要配置该参数。是否设置应用一致性快照： true：创建应用一致性快照 false：创建文件系统一致性快照默认为 true。	true
OssDetail	object	否	OSS 备份高级选项。
InventoryId	string	否	OSS 清单名称，该值不为空时将使用 OSS 清单用于性能调优。建议备份 1 亿以上 OSS 对象采用清单提升增量性能，由清单文件产生的存储费用由 OSS 服务单独收取。 OSS 清单文件生成需要时间，在 OSS 清单文件生成完成之前可能会备份失败，可以等待下个周期执行。	oss-inventory-default
InventoryCleanupPolicy	string	否	备份后是否删除清单文件。仅当使用 OSS 清单时有效。支持： NO_CLEANUP：不删除。 DELETE_CURRENT：删除当前文件。 DELETE_CURRENT_AND_PREVIOUS：删除所有文件。	NO_CLEANUP
IgnoreArchiveObject	boolean	否	不在任务统计和失败文件列表中提示归档型对象	true
FileDetail	object	否	文件备份高级选项。
UseVSS	boolean	否	是否启用 VSS（Windows）功能。取值： true：启用。 false：不启用。	true
AdvPolicy	boolean	否	是否使用高级策略。取值： true：使用。 false：不适用。	true
CommonNasDetail	object	否	本地 NAS 备份高级选项。
FullOnIncrementFail	boolean	否	增量备份失败时是否转为全量备份。取值： true：失败时转为全量备份。 false：失败时不转为全量备份。	true
FetchSliceSize	integer	否	备份分片大小（文件数）。	100000
ClusterId	string	否	备份客户端组 ID。本地 NAS 备份将从备份客户端组中挑选客户端进行备份。	cl-000**************ggu
CommonFileSystemDetail	object	否	CPFS 备份高级选项。
FullOnIncrementFail	boolean	否	增量备份失败时是否转为全量备份。取值： true：失败时转为全量备份。 false：失败时不转为全量备份。	true
FetchSliceSize	integer	否	备份分片大小（文件数）。	100000
CrossAccountType	string	否	跨账号备份类型，默认值为 SELF_ACCOUNT。支持： SELF_ACCOUNT：本账号备份。 CROSS_ACCOUNT：跨账号备份。	SELF_ACCOUNT
CrossAccountUserId	integer	否	用于跨账号备份的原账号阿里云 UID。	144**********732
CrossAccountRoleName	string	否	用于跨账号备份的原账号 RAM 中创建的角色名。	hbrcrossrole

返回参数

名称	类型	描述	示例值
	object	返回数据。
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
RequestId	string	请求 ID。	82CC5B6C-72F7-5D39-92F6-67887DF9AD46

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	PolicyAlreadyBoundWithThisDataSource	This datasource has already been bound with the policy, please use another one.	数据源已绑定该策略，请尝试使用新的策略进行绑定。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。