DescribeBackupPolicies - Security Center - Alibaba Cloud Documentation Center

Queries anti-ransomware policies.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeBackupPolicies	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the anti-ransomware policy that you want to query.	SecurityStrategy-20200303
MachineRemark	string	No	The information that you want to use to identify the servers protected by the anti-ransomware policy. You can enter the IP address or ID of a server.	1.1.XX.XX
Status	string	No	The status of the anti-ransomware policy. Valid values: enabled: The anti-ransomware policy is manually enabled. disabled: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops. closed: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.	enabled
PageSize	integer	Yes	The number of entries to return on each page. Default value: 10.	10
CurrentPage	integer	Yes	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	BE120DAB-F4E7-4C53-ADC3-A97578ABF384
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page. Default value: 10.	10
TotalCount	integer	The total number of anti-ransomware policies returned.	30
Count	integer	The number of entries returned on the current page.	3
Policies	array<object>	The details of the anti-ransomware policy.
BackupPolicy	object
ClientErrorCount	integer	The number of the servers on which the anti-ransomware agent is in an abnormal state.	2
Status	string	The status of the anti-ransomware policy. Valid values: enabled: The anti-ransomware policy is manually enabled. disabled: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops. closed: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.	enabled
PolicyVersion	string	The version of the anti-ransomware policy. Valid values: 1.0.0 2.0.0	2.0.0
Policy	string	The configurations of the anti-ransomware policy. The value of this parameter is in the JSON format and contains the following fields: IsDefault: the type of the anti-ransomware policy. Valid values: 1: recommended policy 0: custom policy Include: the format of the files that are protected. If the value of this field is [], all formats of files are protected. Source: the directory that is protected. If the value of this field is [], all directories are protected. ExcludeSystemPath: indicates whether a specified directory is excluded from the anti-ransomware policy. If the value of this field is true, a directory is excluded. If this field is left empty, no directories are excluded. Exclude: the directory that is excluded from the anti-ransomware policy. If the value of this field is [], no directories are excluded. Schedule: the start time and interval of a data backup task. We recommend that you specify a start time that begins during off-peak hours but does not start on the hour. Examples: If the value of this field is I\|1583216092\|P21D, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of three weeks. If the value of this field is I\|1583216092\|PT24H, the data backup task starts from 2020-03-03 14:14:52, and the task is run at an interval of 24 hours. Retention: the period during which backup data is retained. Unit: days. If the value of this field is 7, backup data is retained for a week. If the value of this field is 365, backup data is retained for a year. If the value of this field is -1, backup data is permanently retained. SpeedLimiter: the limit on the network bandwidth for data backup tasks. If the value of this field is 0:24:30720, the maximum bandwidth for a data backup task is 30 MB/s from 00:00 to 24:00. UseVss: indicates whether the VSS feature is enabled. The feature is available only for Windows servers. Valid values: true false Note The VSS feature is available only if you create the anti-ransomware policy for Windows servers. After you enable the feature, the number of backup failures due to running processes is significantly reduced. We recommend that you enable the VSS feature. After you enable the feature, the data of disks that are in the exFAT and FAT32 formats cannot be backed up.	{"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	The upgrade status of the anti-ransomware policy. Valid values: NotUpgraded Upgrading UpgradeFailed UpgradeSuccess	Upgrading
ServiceErrorCount	integer	The number of servers on which data backup is exceptional.	2
PolicyRegionId	string	The ID of the region that you specified for data backup when you installed the anti-ransomware agent for the server not deployed on Alibaba Cloud.	ch-hangzhou
ClientStatus	string	The status of the anti-ransomware agent. Valid values: running: normal exception: abnormal	running
Name	string	The name of the anti-ransomware policy.	SecurityStrategy-20200303
HealthClientCount	integer	The number of the servers on which the anti-ransomware agent is in a normal state.	2
Id	long	The ID of the anti-ransomware policy.	11
ClientErrorUuidList	array	The UUIDs of the servers on which the anti-ransomware agent is in an abnormal state.
StringItem	string	The UUID of the server on which the anti-ransomware agent is in an abnormal state.	["3bb30859-b3b5-4f28-868f-b0892c98**","3bb30859-b3b5-4f28-868f-b0892c98**"]
RemarkedUuidList	array	The UUIDs that are returned based on the value of the MachineRemark request parameter.
StringItem	string	The UUID that is returned based on the value of the MachineRemark request parameter.	["3bb30859-b3b5-4f28-868f-b0892c98**","3bb30859-b3b5-4f28-868f-b0892c98**"]
UuidList	array	The UUIDs of the servers to which the anti-ransomware policy is applied.
StringItem	string	The UUID of the server to which the anti-ransomware policy is applied.	["3bb30859-b3b5-4f28-868f-b0892c98**","3bb30859-b3b5-4f28-868f-b0892c98**"]
ServiceErrorUuidList	array	The UUIDs of the servers on which data backup is exceptional.
StringItem	string	The UUID of the server on which data backup is exceptional.	["3bb30859-b3b5-4f28-868f-b0892c98**","3bb30859-b3b5-4f28-868f-b0892c98**"]
HealthClientUuidList	array	The UUIDs of the servers on which the anti-ransomware agent is in a normal state.
StringItem	string	The UUID of the server on which the anti-ransomware agent is in a normal state.	["3bb30859-b3b5-4f28-868f-b0892c98**","3bb30859-b3b5-4f28-868f-b0892c98**"]
ServerType	string	The type of the server. Valid values: OUT_CLOUD: server not deployed on Alibaba Cloud ALIYUN: Elastic Compute Service (ECS) instance TRIPARTITE: simple application server	OUT_CLOUD
LastStatusSyncTime	long	The time when the anti-ransomware policy was last updated. Unit: milliseconds.	1719488535027
PreStatus	string	The previous status of the anti-ransomware policy. Valid values: enabled: The anti-ransomware policy is manually enabled. disabled: The anti-ransomware policy is manually disabled. After an anti-ransomware policy is disabled, the data backup task that is running based on the policy stops. closed: The anti-ransomware policy automatically stops because the anti-ransomware capacity is insufficient.	disabled

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-06-27	The response structure of the API has changed	View Change Details