全部产品
Search

搜索本产品

    云安全中心：DescribeBackupPolicies - 查询备份策略列表

    文档中心

    云安全中心：DescribeBackupPolicies - 查询备份策略列表

    更新时间：Jun 15, 2026

    查询防勒索防护策略。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    yundun-sas:DescribeBackupPolicies

    list

    *全部资源

    *

    		 无 无

    请求参数

    名称

    类型

    必填

    描述

    示例值
    Name

    string

    否

    要查询的防勒索防护策略的名称。

    SecurityStrategy-20200303
    MachineRemark

    string

    否

    要查询的防勒索策略防护的服务器的识别信息。可输入服务器的 IP 地址或实例 ID。

    1.1.XX.XX
    Status

    string

    否

    防勒索防护策略的状态。

    • enabled：策略已手动启用。

    • disabled：策略已手动停用。策略停用后，正在运行的备份任务将停止。

    • closed：防勒索容量超出，系统停用策略。

    enabled
    PageSize

    integer

    是

    设置分页查询时，每页包含的备份策略的数量。默认值为 10，表示每页包含 10 个防护策略。

    10
    CurrentPage

    integer

    是

    设置从返回结果的第几页开始显示。默认值为 1，表示从第 1 页开始显示。

    1

    返回参数

    名称

    类型

    描述

    示例值

    object

    RequestId

    string

    本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。

    BE120DAB-F4E7-4C53-ADC3-A97578ABF384
    PageInfo

    object

    分页信息。

    CurrentPage

    integer

    返回数据当前页的页码。

    1
    PageSize

    integer

    分页查询时，每页包含的备份策略的数量。默认值为 10，表示每页包含 10 个备份策略。

    10
    TotalCount

    integer

    返回数据中备份策略的总数量。

    30
    Count

    integer

    分页查询时，当前页显示的数据条数。

    3
    Policies

    array<object>

    防护策略的详情。

    object

    ClientErrorCount

    integer

    防勒索客户端的报错数量。

    2
    Status

    string

    防勒索防护策略的状态。

    • enabled：策略已手动启用。

    • disabled：策略已手动停用。策略停用后，正在运行的备份任务将停止。

    • closed：防勒索容量超出，系统停用策略。

    enabled
    PolicyVersion

    string

    防护策略的版本。取值：

    • 1.0.0。

    • 2.0.0。

    2.0.0
    Policy

    string

    防勒索防护策略的内容。该参数为 JSON 格式，字段说明如下：

    • IsDefault：防护策略的类型。取值：

      • 1：推荐策略

      • 0：自定义策略

    • Include：要防护的文件类型。防护全部文件类型时，该参数设置为[]。

    • Source：要防护的服务器目录。需要防护全部目录时，该参数设置为[]。

    • ExcludeSystemPath：设置是否排除指定目录。要排除该参数设置为 true，不排除则无需设置该参数。

    • Exclude：设置指定的防护目录地址。不设置指定防护目录地址时，该参数设置为[]。

    • Schedule：设置数据备份任务的执行时间和执行间隔。建议指定在业务低峰期非整点。设置示例如下：

      • 例 1：I|1583216092|P21D 表示数据备份开始时间为 2020-03-03 14:14:52，备份策略执行间隔为 3 周。

      • 例 2：I|1583216092|PT24H 表示数据备份开始时间为 2020-03-03 14:14:52，备份策略执行间隔为 24 小时。

    • Retention：设置备份数据保留时间，单位为天。7 表示 1 周，365 表示 1 年，-1 表示永久。

    • SpeedLimiter：设置备份网络带宽限制。例如：0:24:30720 表示 0~24 时备份网络带宽限制为 30 MByte/s。

    • UseVss：是否启用 VSS（Windows）功能。取值：

      • true：启用

      • false：不启用

    说明

    VSS（Windows）功能仅为 Windows 系统开启，开启后会有效降低因进程占用导致的个别文件备份失败的问题，建议开启。启用该功能后，将不支持 exFAT 和 FAT32 磁盘格式的文件备份

    {"Exclude":["/bin/","/usr/bin/","/sbin/","/boot/","/proc/","/sys/","/srv/","/lib/","/selinux/","/usr/sbin/","/run/","/lib32/","/lib64/","/lost+found/","/var/lib/kubelet/","/var/lib/ntp/proc","/var/lib/container","Windows\\","Python27\\","Program Files (x86)\\","Program Files\\","Boot\\","$RECYCLE.BIN","System Volume Information\\","Users\\Administrator\\NTUSER.DAT*","ProgramData\\","pagefile.sys","Users\\Default\\NTUSER.DAT*","Users\\Administrator\\ntuser.*"],"ExcludeSystemPath":true,"Include":[],"IsDefault":1,"Retention":7,"Schedule":"I|1630689360|PT24H","Source":[],"SpeedLimiter":"","UseVss":true}
    UpgradeStatus

    string

    策略的升级状态。取值：

    • NotUpgraded：未升级

    • Upgrading：升级中

    • UpgradeFailed：升级失败

    • UpgradeSuccess：升级成功

    Upgrading
    ServiceErrorCount

    integer

    数据备份异常的服务器的数量。

    2
    PolicyRegionId

    string

    非阿里云服务器中安装防勒索客户端时选择的备份服务地域 ID。

    ch-hangzhou
    ClientStatus

    string

    防勒索客户端的状态。取值：

    • running：状态正常

    • exception：状态异常

    running
    Name

    string

    防勒索防护策略的名称。

    SecurityStrategy-20200303
    HealthClientCount

    integer

    状态为“正常”的客户端的数量。

    2
    Id

    integer

    防勒索防护策略的 ID。

    11
    ClientErrorUuidList

    array

    客户端状态异常UUID 列表。

    string

    客户端状态异常UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    RemarkedUuidList

    array

    请求参数 MachineRemark 检索后返回的服务器的 UUID 列表。

    string

    请求参数 MachineRemark 检索后返回的服务器的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    UuidList

    array

    防勒索防护策略防护的服务器的 UUID 列表。

    string

    防勒索防护策略防护的服务器的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    ServiceErrorUuidList

    array

    数据备份异常的服务器的 UUID 列表。

    string

    数据备份异常的服务器的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    HealthClientUuidList

    array

    状态为健康的客户端的 UUID 列表。

    string

    状态为健康的客户端的 UUID 列表。

    ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]
    ServerType

    string

    服务器类型。取值：

    • OUT_CLOUD：非阿里云服务器

    • ALIYUN：阿里云服务器

    • TRIPARTITE：轻量级应用服务器

    OUT_CLOUD
    LastStatusSyncTime

    integer

    防勒索防护策略状态最新更新时间，单位毫秒。

    1719488535027
    PreStatus

    string

    防勒索防护策略的上一次状态。

    • enabled：策略已手动启用。

    • disabled：策略已手动停用。策略停用后，正在运行的备份任务将停止。

    • closed：防勒索容量超出，系统停用策略。

    disabled

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 10,
    "TotalCount": 30,
    "Count": 3
  },
  "Policies": [
    {
      "ClientErrorCount": 2,
      "Status": "enabled",
      "PolicyVersion": "2.0.0",
      "Policy": "{\"Exclude\":[\"/bin/\",\"/usr/bin/\",\"/sbin/\",\"/boot/\",\"/proc/\",\"/sys/\",\"/srv/\",\"/lib/\",\"/selinux/\",\"/usr/sbin/\",\"/run/\",\"/lib32/\",\"/lib64/\",\"/lost+found/\",\"/var/lib/kubelet/\",\"/var/lib/ntp/proc\",\"/var/lib/container\",\"Windows\\\\\",\"Python27\\\\\",\"Program Files (x86)\\\\\",\"Program Files\\\\\",\"Boot\\\\\",\"$RECYCLE.BIN\",\"System Volume Information\\\\\",\"Users\\\\Administrator\\\\NTUSER.DAT*\",\"ProgramData\\\\\",\"pagefile.sys\",\"Users\\\\Default\\\\NTUSER.DAT*\",\"Users\\\\Administrator\\\\ntuser.*\"],\"ExcludeSystemPath\":true,\"Include\":[],\"IsDefault\":1,\"Retention\":7,\"Schedule\":\"I|1630689360|PT24H\",\"Source\":[],\"SpeedLimiter\":\"\",\"UseVss\":true}",
      "UpgradeStatus": "Upgrading",
      "ServiceErrorCount": 2,
      "PolicyRegionId": "ch-hangzhou",
      "ClientStatus": "running",
      "Name": "SecurityStrategy-20200303",
      "HealthClientCount": 2,
      "Id": 11,
      "ClientErrorUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "RemarkedUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "UuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "ServiceErrorUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "HealthClientUuidList": [
        "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]"
      ],
      "ServerType": "OUT_CLOUD",
      "LastStatusSyncTime": 1719488535027,
      "PreStatus": "disabled"
    }
  ]
}

    错误码

    HTTP status code

    错误码

    错误信息

    描述
    500 ServerError ServerError
    403 NoPermission caller has no permission

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

    变更历史

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