调用DescribeBackupPolicies接口查询防勒索防护策略。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeBackupPolicies

需要执行的操作。

取值:DescribeBackupPolicies

CurrentPage Integer 1

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

PageSize Integer 10

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

Name String SecurityStrategy-20200303

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

MachineRemark String 1.1.XX.XX

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

Status String enabled

防勒索防护策略的状态。

  • enabled:策略已手动启用。
  • disabled:策略已手动停用。策略停用后,正在运行的备份任务将停止。
  • closed:防勒索容量超出,系统停用策略。

返回数据

名称 类型 示例值 描述
PageInfo Struct

返回数据的信息。

Count Integer 3

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

CurrentPage Integer 1

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

PageSize Integer 20

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

TotalCount Integer 30

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

Policies Array of BackupPolicy

防护策略的详情。

ClientErrorCount Integer 2

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

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

客户端状态异常UUID列表。

ClientStatus String running

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

  • running:状态正常
  • exception:状态异常
HealthClientCount Integer 2

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

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

状态为“异常”的客户端的UUID列表。

Id Long 11

防勒索防护策略的ID。

Name String SecurityStrategy-20200303

防勒索防护策略的名称。

Policy String {\"Source\":[\"/home/admin\",\"\\\\servername\\sharename\"],\"Exclude\":[\"/home/user\"],\"Schedule\":\"I|1583216092|P21D\",\"Retention\":365,\"SpeedLimiter\":\"12:15:15360|6:12:5120\",\"ExcludeSystemPath\":true}

防勒索防护策略的内容。

PolicyRegionId String ch-hangzhou

IDC服务器中安装防勒索客户端时选择的服务端地域ID。

PolicyVersion String 2.0.0

防护策略的版本。取值:

  • 1.0.0。
  • 2.0.0。
RemarkedUuidList List ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]

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

ServiceErrorCount Integer 2

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

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

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

Status String enabled

防勒索防护策略的状态。

  • enabled:策略已手动启用。
  • disabled:策略已手动停用。策略停用后,正在运行的备份任务将停止。
  • closed:防勒索容量超出,系统停用策略。
UpgradeStatus String Upgrading

策略的升级状态。取值:

  • NotUpgraded:未升级
  • Upgrading:升级中
  • UpgradeFailed:升级失败
  • UpgradeSuccess:升级成功
UuidList List ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]

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

RequestId String BE120DAB-F4E7-4C53-ADC3-A97578ABF384

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeBackupPolicies
&<公共请求参数>

正常返回示例

XML格式

<DescribeBackupPolicies>
  <PageInfo>
        <TotalCount>30</TotalCount>
        <PageSize>20</PageSize>
        <CurrentPage>1</CurrentPage>
        <Count>3</Count>
  </PageInfo>
  <Policies>
        <PolicyRegionId>ch-hangzhou</PolicyRegionId>
        <PolicyVersion>2.0.0</PolicyVersion>
        <Policy>{\"Source\":[\"/home/admin\",\"\\\\servername\\sharename\"],\"Exclude\":[\"/home/user\"],\"Schedule\":\"I|1583216092|P21D\",\"Retention\":365,\"SpeedLimiter\":\"12:15:15360|6:12:5120\",\"ExcludeSystemPath\":true}</Policy>
        <Status>enabled</Status>
        <ClientStatus>running</ClientStatus>
        <ServiceErrorCount>2</ServiceErrorCount>
        <ClientErrorCount>2</ClientErrorCount>
        <Id>11</Id>
        <HealthClientCount>2</HealthClientCount>
        <Name>SecurityStrategy-20200303</Name>
        <UuidList>["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]</UuidList>
        <RemarkedUuidList>["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]</RemarkedUuidList>
        <ClientErrorUuidList>["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]</ClientErrorUuidList>
        <ServiceErrorUuidList>["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]</ServiceErrorUuidList>
        <HealthClientUuidList>["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]</HealthClientUuidList>
  </Policies>
  <RequestId>BE120DAB-F4E7-4C53-ADC3-A97578ABF384</RequestId>
</DescribeBackupPolicies>

JSON格式

{
    "PageInfo": {
        "TotalCount": "30",
        "PageSize": "20",
        "CurrentPage": "1",
        "Count": "3"
    },
    "Policies": [
        {
            "PolicyRegionId": "ch-hangzhou",
            "PolicyVersion": "2.0.0",
            "Policy": "{\\\"Source\\\":[\\\"/home/admin\\\",\\\"\\\\\\\\servername\\\\sharename\\\"],\\\"Exclude\\\":[\\\"/home/user\\\"],\\\"Schedule\\\":\\\"I|1583216092|P21D\\\",\\\"Retention\\\":365,\\\"SpeedLimiter\\\":\\\"12:15:15360|6:12:5120\\\",\\\"ExcludeSystemPath\\\":true}",
            "Status": "enabled",
            "ClientStatus": "running",
            "UpgradeStatus": "Upgrading",
            "ServiceErrorCount": "2",
            "ClientErrorCount": "2",
            "Id": "11",
            "HealthClientCount": "2",
            "Name": "SecurityStrategy-20200303",
            "UuidList": "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]",
            "RemarkedUuidList": "[\"3bb30859-b3b5-4f28-868f-b0892c98****\",\"3bb30859-b3b5-4f28-868f-b0892c98****\"]",
            "ClientErrorUuidList": "[\"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****\"]"
        }
    ],
    "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384"
}

错误码

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