Queries the protection policies that are used to prevent ransomware.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeBackupPolicies

The operation that you want to perform.

Set the value to DescribeBackupPolicies.

CurrentPage Integer Yes 1

The number of the page to return. Default value: 1.

PageSize Integer Yes 10

The number of entries to return on each page. Default value: 10.

Name String No SecurityStrategy-20200303

The name of the protection policy that you want to query.

MachineRemark String No 1.1.XX.XX

The information that is used to identify the server to which the protection policy is applied. You can enter the IP address or ID of a server.

Status String No enabled

The status of the protection policy.

  • enabled: The protection policy is manually enabled.
  • disabled: The protection policy is manually disabled. After a protection policy is disabled, the data backup task that is running based on the policy stops.
  • closed: The protection policy automatically stops because the anti-ransomware capacity is insufficient.

Response parameters

Parameter Type Example Description
PageInfo Struct

The pagination information.

Count Integer 3

The number of entries on the returned page.

CurrentPage Integer 1

The page number of the returned page. Pages start from page 1. Default value: 1.

PageSize Integer 20

The number of entries returned per page. Default value: 10.

TotalCount Integer 30

The total number of protection policies returned.

Policies Array of BackupPolicy

The details of the protection policy.

ClientErrorCount Integer 2

The number of the servers on which the anti-ransomware agent is in the abnormal state.

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

The UUIDs of the servers on which the anti-ransomware agent is in the abnormal state.

ClientStatus String running

The status of the anti-ransomware agent. Valid values:

  • running: normal
  • exception: abnormal
HealthClientCount Integer 2

The number of the servers on which the anti-ransomware agent is in the normal state.

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

The UUIDs of the servers on which the anti-ransomware agent is in the normal state.

Id Long 11

The ID of the protection policy.

Name String SecurityStrategy-20200303

The name of the protection policy.

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}

The configurations of the protection policy.

PolicyRegionId String ch-hangzhou

The ID of the region in which the server in a data center resides. This server refers to the server on which you install the anti-ransomware agent.

PolicyVersion String 2.0.0

The version of the protection policy. Valid values:

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

The UUIDs that are returned from the value of the MachineRemark request parameter.

ServiceErrorCount Integer 2

The number of servers on which data backup is exceptional.

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

The UUIDs of servers on which data backup is exceptional.

Status String enabled

The status of the protection policy.

  • enabled: The protection policy is manually enabled.
  • disabled: The protection policy is manually disabled. After a protection policy is disabled, the data backup task that is running based on the policy stops.
  • closed: The protection policy automatically stops because the anti-ransomware capacity is insufficient.
UpgradeStatus String Upgrading

The upgrade status of the protection policy. Valid values:

  • NotUpgraded
  • Upgrading
  • UpgradeFailed
  • UpgradeSuccess
UuidList List ["3bb30859-b3b5-4f28-868f-b0892c98****","3bb30859-b3b5-4f28-868f-b0892c98****"]

The UUIDs of the servers to which the protection policy is applied.

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

The ID of the request, which is used to locate and troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeBackupPolicies
&<Common request parameters>

Sample success responses

XML format

<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 format

{
    "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"
}

Error codes

For a list of error codes, visit the API Error Center.