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

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

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
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

返回参数

名称	类型	描述	示例值
	object	DescribePolicyBindingsResponse
PolicyBindings	array	绑定策略列表。
	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
AdvancedOptions	object	高级选项。
UdmDetail	object	整机备份详情。
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	long	仅当AppConsistent为true时，需要配置该参数。IO冻结超时时间。默认为30秒。	30
EnableWriters	boolean	仅当AppConsistent为true时，需要配置该参数。是否设置应用一致性快照： true：创建应用一致性快照 false：创建文件系统一致性快照默认为true。	true
SourceType	string	数据源类型，取值范围： UDM_ECS：表示ECS整机备份	UDM_ECS
CrossAccountType	string	跨账号备份类型。支持： SELF_ACCOUNT：本账号备份 CROSS_ACCOUNT：跨账号备份	CROSS_ACCOUNT
CrossAccountUserId	long	跨账号备份的原账号ID。	1480************
CrossAccountRoleName	string	用于跨账号备份的原账号RAM中创建的角色名。	hbrcrossrole
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,
      "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
        }
      },
      "SourceType": "UDM_ECS",
      "CrossAccountType": "CROSS_ACCOUNT",
      "CrossAccountUserId": 0,
      "CrossAccountRoleName": "hbrcrossrole"
    }
  ],
  "NextToken": "caeba0bbb2be03f84eb48b699f0a",
  "MaxResults": 10,
  "TotalCount": 38,
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "5225929A-4EBD-55EE-9FE1-4A130E582A76"
}

错误码

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