DescribePolicyBindings - 查询绑定策略列表 - 云备份

查询策略绑定的一个或多个数据源、查询数据源绑定的一个或多个策略。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hbr:DescribePolicyBindings	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
NextToken	string	否	获取下一页策略与数据源关联所需的 Token。	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	否	每次查询结果的个数。取值范围：10~100。默认值：10。	10
PolicyId	string	否	策略 ID。	po-000************hky
DataSourceIds	array	否	数据源 ID 列表。
	string	否	数据源 ID。	i-uf6************68n
SourceType	string	否	数据源类型。取值范围： UDM_ECS：表示 ECS 整机备份。	UDM_ECS
Filters	array<object>	否	查询过滤器。
	object	否	查询过滤器。
Key	string	否	查询过滤器中的键值。取值包括： PolicyId：备份策略 ID DataSourceId：ECS 实例 ID DataSourceType：数据源类型	DataSourceType
Operator	string	否	匹配方式。默认为 IN。即过滤器中 Key 和 Value 支持的匹配操作（Operator）方式，取值包括： EQUAL：等于 NOT_EQUAL：不等于 GREATER_THAN：大于 GREATER_THAN_OR_EQUAL：大于等于 LESS_THAN：小于 LESS_THAN_OR_EQUAL：小于等于 BETWEEN：区间，value 为 JSON 数组`[下届,上届]`。 IN：在集合中，value 为数组。	IN
Values	array	否	查询过滤器中的待匹配的值。
	string	否	查询过滤器中的待匹配的值。	UDM_ECS

返回参数

名称	类型	描述	示例值
	object	DescribePolicyBindingsResponse
PolicyBindings	array<object>	绑定策略列表。
Data	object	绑定策略详情。
CreatedTime	long	创建时间。UNIX 时间，单位秒。	1661399570
UpdatedTime	long	更新时间。UNIX 时间，单位为秒。	1653611573
PolicyBindingId	string	绑定策略 ID。	pd-000************slc
PolicyBindingDescription	string	绑定策略描述。	po-000**********eslc-i-uf6**********y5g
PolicyId	string	策略 ID。	po-000************56y
DataSourceId	string	数据源 ID。	i-8vb************5ly
Disabled	boolean	策略是否对该数据源生效。 true：暂停 false：未暂停	true
Source	string	当 SourceType 取值为 OSS 时，表示备份某个 prefix，如果不指定，则表示备份整个 Bucket 根目录。当 SourceType 取值为ECS_FILE或 File 时，表示备份的文件目录，如果不指定，则表示备份全部目录。	backup/
Include	string	仅当 SourceType 取值为ECS_FILE或 File 时，需要配置该参数。表示要进行备份的文件类型，这些类型的所有文件都备份。最多支持 255 个字符。	[\".doc\",\".xltm\"]
Exclude	string	仅当 SourceType 取值为ECS_FILE或 File 时，需要配置该参数。表示不需要进行备份的文件类型，该类型的所有文件都不备份。最多支持 255 个字符。	[\".doc\",\".xltm\"]
SpeedLimit	string	仅当 SourceType 取值为ECS_FILE或 File 时，需要配置该参数。表示备份流量控制。格式为`{start}{end}{bandwidth}`。多个流量控制配置使用分隔，并且配置时间不允许有重叠。 start：起始小时。 end：结束小时。 bandwidth：限制速率，单位 KB/s。	0:24:10240
AdvancedOptions	object	高级选项。
UdmDetail	object	整机备份高级选项。
ExcludeDiskIdList	array	不需要保护的云盘 ID 列表。当 DiskIdList 不为空时，将忽略该参数。
ExcludeDiskIdList	string	不需要保护的云盘 ID。	d-bp1************apo
DiskIdList	array	需要保护的云盘 ID 列表。保护所有云盘时，该值为空。
DiskIdList	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	long	仅当 AppConsistent 为 true 时，需要配置该参数。IO 冻结超时时间。默认为 30 秒。	30
EnableWriters	boolean	仅当 AppConsistent 为 true 时，需要配置该参数。是否设置应用一致性快照： true：创建应用一致性快照 false：创建文件系统一致性快照默认为 true。	true
DestinationKmsKeyId	string	目标地域自定义 KMS 密钥 ID，该字段不为空且开启异地复制时，将使用该密钥进行加密异地复制。	4ed37b1e-da51-4187-aceb-9db4f9b7148b
OssDetail	object	OSS 备份高级选项。
InventoryId	string	OSS 清单名称，该值不为空时将使用 OSS 清单用于性能调优。建议备份 1 亿以上 OSS 对象采用清单提升增量性能，由清单文件产生的存储费用由 OSS 服务单独收取。 OSS 清单文件生成需要时间，在 OSS 清单文件生成完成之前可能会备份失败，可以等待下个周期执行。	inventory_test
InventoryCleanupPolicy	string	备份后是否删除清单文件。仅当使用 OSS 清单时有效。支持： NO_CLEANUP：不删除。 DELETE_CURRENT：删除当前文件。 DELETE_CURRENT_AND_PREVIOUS：删除所有文件。	DELETE_CURRENT_AND_PREVIOUS
IgnoreArchiveObject	boolean	不在任务统计和失败文件列表中提示归档型对象	true
FileDetail	object	文件备份高级选项。
UseVSS	boolean	是否启用 VSS（Windows）功能。取值： true：启用。 false：不启用。	false
AdvPolicy	boolean	是否使用高级策略。取值： true：使用。 false：不适用。	false
CommonNasDetail	object	本地 NAS 高级选项。
FullOnIncrementFail	boolean	增量备份失败时是否转为全量备份。取值： true：失败时转为全量备份。 false：失败时不转为全量备份。	true
FetchSliceSize	long	备份分片大小（文件数）。	100000
ClientId	string	备份客户端 ID。	c-0001eg6mcvjs93f46s2d
ClusterId	string	客户端组 ID。	cl-000gkcofngi04j6k680a
CommonFileSystemDetail	object	大规模文件系统备份高级选项。
FullOnIncrementFail	boolean	增量备份失败时是否转为全量备份。取值： true：失败时转为全量备份。 false：失败时不转为全量备份。	true
FetchSliceSize	long	备份分片大小（文件数）。	100000
SourceType	string	数据源类型，取值范围： UDM_ECS：表示 ECS 整机备份	UDM_ECS
CrossAccountType	string	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	long	跨账号备份的原账号 ID。	1480************
CrossAccountRoleName	string	用于跨账号备份的原账号 RAM 中创建的角色名。	hbrcrossrole
CreatedByTag	boolean	资源是否通过备份策略资源标签自动关联。	false
HitTags	array<object>	命中的标签规则。
HitTag	object
Key	string	标签键。	env
Value	string	标签值。	prod
Operator	string	标签匹配规则。 EQUAL：匹配标签键和标签值。 NOT：匹配标签键，不匹配标签值。	EQUAL
NextToken	string	获取下一页策略与数据源绑定所需的 Token。	caeba0bbb2be03f84eb48b699f0a
MaxResults	integer	每次查询结果的个数。取值范围：10~100。默认值：10。	10
TotalCount	long	总记录数。	38
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
RequestId	string	请求 ID。	5225929A-4EBD-55EE-9FE1-4A130E582A76

示例

正常返回示例

JSON格式

{
  "PolicyBindings": [
    {
      "CreatedTime": 1661399570,
      "UpdatedTime": 1653611573,
      "PolicyBindingId": "pd-000************slc",
      "PolicyBindingDescription": "po-000************eslc-i-uf6************y5g",
      "PolicyId": "po-000************56y",
      "DataSourceId": "i-8vb************5ly",
      "Disabled": true,
      "Source": "backup/",
      "Include": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "Exclude": "[\\\"*.doc\\\",\\\"*.xltm\\\"]",
      "SpeedLimit": "0:24:10240",
      "AdvancedOptions": {
        "UdmDetail": {
          "ExcludeDiskIdList": [
            "d-bp1************apo\n"
          ],
          "DiskIdList": [
            "d-bp1************apo\n"
          ],
          "SnapshotGroup": true,
          "AppConsistent": false,
          "RamRoleName": "AliyunECSInstanceForHbrRole",
          "PreScriptPath": "/tmp/prescript.sh",
          "PostScriptPath": "/tmp/postscript.sh",
          "EnableFsFreeze": true,
          "TimeoutInSeconds": 30,
          "EnableWriters": true,
          "DestinationKmsKeyId": "4ed37b1e-da51-4187-aceb-9db4f9b7148b"
        },
        "OssDetail": {
          "InventoryId": "inventory_test",
          "InventoryCleanupPolicy": "DELETE_CURRENT_AND_PREVIOUS",
          "IgnoreArchiveObject": true
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": "cl-000gkcofngi04j6k680a"
        },
        "CommonFileSystemDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole",
      "CreatedByTag": false,
      "HitTags": [
        {
          "Key": "env",
          "Value": "prod",
          "Operator": "EQUAL"
        }
      ]
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-13	OpenAPI 返回结构发生变更	查看变更详情
2024-09-25	OpenAPI 返回结构发生变更	查看变更详情
2024-03-13	OpenAPI 返回结构发生变更	查看变更详情
2024-01-05	OpenAPI 返回结构发生变更	查看变更详情
2023-12-12	OpenAPI 返回结构发生变更	查看变更详情
2023-08-16	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-03-29	OpenAPI 返回结构发生变更	查看变更详情