文档

DescribePolicyBindings - 查询绑定策略列表

更新时间:

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

调试

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

授权信息

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

请求参数

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

获取下一页策略与数据源关联所需的 Token。

caeba0bbb2be03f84eb48b699f0a
MaxResultsinteger

每次查询结果的个数。

取值范围:10~100。默认值:10。

10
PolicyIdstring

策略 ID。

po-000************hky
DataSourceIdsarray

数据源 ID 列表。

string

数据源 ID。

i-uf6************68n
SourceTypestring

数据源类型。取值范围:

  • UDM_ECS:表示 ECS 整机备份。
UDM_ECS
Filtersobject []

查询过滤器。

Keystring

查询过滤器中的键值。取值包括:

  • PolicyId:备份策略 ID
  • DataSourceId:ECS 实例 ID
  • DataSourceType:数据源类型
DataSourceType
Operatorstring

匹配方式。默认为 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
Valuesarray

查询过滤器中的待匹配的值。

string

查询过滤器中的待匹配的值。

UDM_ECS

返回参数

名称类型描述示例值
object

DescribePolicyBindingsResponse

PolicyBindingsobject []

绑定策略列表。

CreatedTimelong

创建时间。UNIX 时间,单位秒。

1661399570
UpdatedTimelong

更新时间。UNIX 时间,单位为秒。

1653611573
PolicyBindingIdstring

绑定策略 ID。

pd-000************slc
PolicyBindingDescriptionstring

绑定策略描述。

po-000************eslc-i-uf6************y5g
PolicyIdstring

策略 ID。

po-000************56y
DataSourceIdstring

数据源 ID。

i-8vb************5ly
Disabledboolean

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

  • true:暂停
  • false:未暂停
true
AdvancedOptionsobject

高级选项。

UdmDetailobject

整机备份高级选项。

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
DestinationKmsKeyIdstring

目标地域自定义 KMS 密钥 ID,该字段不为空且开启异地复制时,将使用该密钥进行加密异地复制。

4ed37b1e-da51-4187-aceb-9db4f9b7148b
OssDetailobject

OSS 备份高级选项。

InventoryIdstring

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

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

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

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

文件备份高级选项。

UseVSSboolean

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

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

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

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

本地 NAS 高级选项。

FullOnIncrementFailboolean

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

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

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

100000
ClientIdstring

备份客户端 ID。

c-0001eg6mcvjs93f46s2d
SourceTypestring

数据源类型,取值范围:

  • UDM_ECS:表示 ECS 整机备份
UDM_ECS
CrossAccountTypestring

跨账号备份类型。支持:

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

跨账号备份的原账号 ID。

1480************
CrossAccountRoleNamestring

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

hbrcrossrole
NextTokenstring

获取下一页策略与数据源绑定所需的 Token。

caeba0bbb2be03f84eb48b699f0a
MaxResultsinteger

每次查询结果的个数。

取值范围:10~100。默认值:10。

10
TotalCountlong

总记录数。

38
Successboolean

请求是否成功。

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

返回码,200 表示成功。

200
Messagestring

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

successful
RequestIdstring

请求 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,
          "DestinationKmsKeyId": "4ed37b1e-da51-4187-aceb-9db4f9b7148b"
        },
        "OssDetail": {
          "InventoryId": "inventory_test",
          "InventoryCleanupPolicy": "DELETE_CURRENT_AND_PREVIOUS"
        },
        "FileDetail": {
          "UseVSS": false,
          "AdvPolicy": false
        },
        "CommonNasDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 100000,
          "ClientId": "c-0001eg6mcvjs93f46s2d",
          "ClusterId": ""
        },
        "CommonFileSystemDetail": {
          "FullOnIncrementFail": true,
          "FetchSliceSize": 0
        }
      },
      "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"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-05OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-12-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-08-16OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Filters
出参OpenAPI 返回结构发生变更
2023-03-29OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈