文档

CreatePolicyBindings - 创建策略与数据源关联

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PolicyIdstring

策略 ID。

po-000************8ep
PolicyBindingListobject []

策略绑定列表。

PolicyBindingDescriptionstring

策略绑定描述。

这是一个策略绑定的描述。
DataSourceIdstring

数据源 ID,根据 SourceType 字段表示不同含义:

  • UDM_ECS:ECS 实例 ID。
  • OSS:OSS bucket 名称。
  • NAS:阿里云 NAS 文件系统 ID。
  • COMMON_NAS:本地 NAS 实例 ID。
  • ECS_FILE:ECS 实例 ID。
  • File:云备份客户端 ID。
i-bp1************dl8
Disabledstring

策略对该数据源是否暂停生效。

  • true:暂停
  • false:未暂停
true
SourceTypestring

数据源类型。取值范围:

  • UDM_ECS:表示 ECS 整机备份。
  • OSS:表示 OSS 备份。
  • NAS:表示阿里云 NAS 备份。
  • COMMON_NAS:表示本地 NAS 备份。
  • ECS_FILE:表示 ECS 文件备份。
  • File:表示本地文件备份。
UDM_ECS
Sourcestring
  • 当 SourceType 取值为 OSS 时,表示备份某个 prefix,如果不指定,则表示备份整个 Bucket 根目录。
  • 当 SourceType 取值为ECS_FILEFile 时,表示备份的文件目录,如果不指定,则表示备份全部目录。
backup/
Includestring

仅当 SourceType 取值为ECS_FILEFile 时,需要配置该参数。表示要进行备份的文件类型,这些类型的所有文件都备份。最多支持 255 个字符。

[\"*.doc\",\"*.xltm\"]
Excludestring

仅当 SourceType 取值为ECS_FILEFile 时,需要配置该参数。表示不需要进行备份的文件类型,该类型的所有文件都不备份。最多支持 255 个字符。

[\"*.doc\",\"*.xltm\"]
SpeedLimitstring

仅当 SourceType 取值为ECS_FILEFile 时,需要配置该参数。表示备份流量控制。格式为{start}{end}{bandwidth}。多个流量控制配置使用分隔,并且配置时间不允许有重叠。

  • start:起始小时。
  • end:结束小时。
  • bandwidth:限制速率,单位 KB/s。
0:24:1024
AdvancedOptionsobject

高级选项。

UdmDetailobject

ECS 整机备份高级选项。

ExcludeDiskIdListarray

不需要保护的云盘 ID 列表。当 DiskIdList 不为空时,将忽略该参数。

string

无需保护的云盘 ID。

d-bp1************apo
DiskIdListarray

需要保护的云盘 ID 列表。保护所有云盘时,该值为空。

string

需要保护的云盘 ID。

d-bp1************apo
SnapshotGroupboolean

是否创建快照一致性组。仅云盘类型全部为 ESSD 时,支持创建快照一致性组。

true
AppConsistentboolean

是否创建应用一致性。仅云盘类型全部为 ESSD 时,支持创建快照应用一致性。

false
RamRoleNamestring

仅当 AppConsistenttrue 时,需要配置该参数。创建应用一致性快照需要配置的 RAM 角色名称。

AliyunECSInstanceForHbrRole
PreScriptPathstring

仅当 AppConsistenttrue 时,需要配置该参数。创建应用一致性快照前执行的冻结脚本路径。

/tmp/prescript.sh
PostScriptPathstring

仅当 AppConsistenttrue 时,需要配置该参数。创建应用一致性快照后执行的解冻脚本路径。

/tmp/postscript.sh
EnableFsFreezeboolean

仅当 AppConsistenttrue 时,需要配置该参数。是否在创建应用一致性快照前使用 Linux 的 FsFreeze 机制确保文件系统处于只读一致性。默认为 true。

true
TimeoutInSecondslong

仅当 AppConsistenttrue 时,需要配置该参数。IO 冻结超时时间。默认为 30 秒。

30
EnableWritersboolean

仅当 AppConsistenttrue 时,需要配置该参数。是否设置应用一致性快照:

  • true:创建应用一致性快照
  • false:创建文件系统一致性快照

默认为 true。

true
OssDetailobject

OSS 备份高级选项。

InventoryIdstring

OSS 清单名称,该值不为空时将使用 OSS 清单用于性能调优。

  • 建议备份 1 亿以上 OSS 对象采用清单提升增量性能,由清单文件产生的存储费用由 OSS 服务单独收取。
  • OSS 清单文件生成需要时间,在 OSS 清单文件生成完成之前可能会备份失败,可以等待下个周期执行。
oss-inventory-default
InventoryCleanupPolicystring

备份后是否删除清单文件。仅当使用 OSS 清单时有效。支持:

  • NO_CLEANUP:不删除。
  • DELETE_CURRENT:删除当前文件。
  • DELETE_CURRENT_AND_PREVIOUS:删除所有文件。
NO_CLEANUP
FileDetailobject

文件备份高级选项。

UseVSSboolean

是否启用 VSS(Windows)功能。取值:

  • true:启用。
  • false:不启用。
true
AdvPolicyboolean

是否使用高级策略。取值:

  • true:使用。
  • false:不适用。
true
CommonNasDetailobject

本地 NAS 备份高级选项。

FullOnIncrementFailboolean

增量备份失败时是否转为全量备份。取值:

  • true:失败时转为全量备份。
  • false:失败时不转为全量备份。
true
FetchSliceSizelong

备份分片大小(文件数)。

100000
ClusterIdstring

备份客户端组 ID。本地 NAS 备份将从备份客户端组中挑选客户端进行备份。

cl-000**************ggu
CommonFileSystemDetailobject

大规模文件系统备份高级选项。

FullOnIncrementFailboolean

增量备份失败时是否转为全量备份。取值:

  • true:失败时转为全量备份。
  • false:失败时不转为全量备份。
true
FetchSliceSizelong

备份分片大小(文件数)。

100000
CrossAccountTypestring

跨账号备份类型,默认值为 SELF_ACCOUNT。支持:

  • SELF_ACCOUNT:本账号备份。
  • CROSS_ACCOUNT:跨账号备份。
SELF_ACCOUNT
CrossAccountUserIdlong

用于跨账号备份的原账号阿里云 UID。

144**********732
CrossAccountRoleNamestring

用于跨账号备份的原账号 RAM 中创建的角色名。

hbrcrossrole

返回参数

名称类型描述示例值
object

返回数据。

Successboolean

请求是否成功。

  • true:成功
  • false:失败
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
RequestIdstring

请求 ID。

82CC5B6C-72F7-5D39-92F6-67887DF9AD46

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

变更时间变更内容概要操作
2024-03-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400