Anti-Ransomware Policy API Reference - Security Center - Alibaba Cloud - Security Center

Queries the details of an anti-ransomware protection policy for servers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:DescribeBackupPolicy

get

*BackupPolicy

acs:yundun-sas:{#regionId}:{#accountId}:backuppolicy/{#BackupPolicyId}

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	Yes	The ID of the anti-ransomware backup policy. Note You can call the DescribeBackupPolicies operation to obtain this parameter.	51880

Response elements

Element	Type	Description	Example
	object	The policy details.
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.	A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7
BackupPolicyDetail	object	The details of the policy.
Status	string	The status of the anti-ransomware protection policy. Valid values: enabled: The policy is manually enabled. disabled: The policy is manually disabled. After the policy is disabled, running backup tasks are stopped. closed: The policy is disabled by the system because the anti-ransomware capacity is exceeded.	closed
PolicyVersion	string	The version of the protection policy. Valid values: 1.0.0 2.0.0	2.0.0
Policy	string	The content of the anti-ransomware protection policy. This parameter is in JSON format. The following fields are included: IsDefault: The type of the protection policy. Valid values: 1: recommended policy 0: custom policy Include: The file types to protect. If all file types are protected, this parameter is set to []. Source: The server folders to protect. If all folders are protected, this parameter is set to []. ExcludeSystemPath: Specifies whether to exclude specified folders. Set this parameter to true to exclude folders. If no folders need to be excluded, you do not need to configure this parameter. Exclude: The specified protection folder addresses. If no specific protection folder addresses are configured, this parameter is set to []. Schedule: Settings for the execution time and interval of the data backup task. Specify an off-peak hour that is not on the hour. Examples: Example 1: I\|1583216092\|P21D indicates that the data backup starts at 2020-03-03 14:14:52 and the backup policy executes at an interval of 3 weeks. Example 2: I\|1583216092\|PT24H indicates that the data backup starts at 2020-03-03 14:14:52 and the backup policy executes at an interval of 24 hours. Retention: Settings for the retention period of backup data, in days. 7 indicates 1 week, 365 indicates 1 year, and -1 indicates permanent retention. SpeedLimiter: Settings for the backup network bandwidth throttling. For example, 0:24:30720 indicates that the backup network bandwidth throttling is 30 MB/s from 00:00 to 24:00. UseVss: Specifies whether to enable the Volume Shadow Copy Service (VSS) feature for Windows. Valid values: true: enabled false: not enabled Note The VSS feature is available only for Windows systems. After this feature is enabled, it effectively reduces the issue of individual file backup failures caused by process occupation. Enable this feature. After this feature is enabled, file backup for exFAT and FAT32 disk formats is not supported.	{ "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 }
ClientStatus	string	The status of the anti-ransomware client. Valid values: running: Normal. exception: Abnormal.	running
Name	string	The policy name.	testBuckUp
Id	integer	The ID of the anti-ransomware backup policy.	51880
RegionId	string	The region ID of the backup service.	cn-beijing
UuidList	array	The UUIDs of the servers for which the backup policy is enabled.
	string	The UUID of the server for which the backup policy is enabled.	inet-49611a6b-a98a-455d-a18a-92af9265****

Examples

Success response

JSON format

{
  "RequestId": "A4EB8B1C-1DEC-5E18-BCD0-D1BBB3936FA7",
  "BackupPolicyDetail": {
    "Status": "closed",
    "PolicyVersion": "2.0.0",
    "Policy": "{\n      \"Exclude\": [\n            \"/bin/\",\n            \"/usr/bin/\",\n            \"/sbin/\",\n            \"/boot/\",\n            \"/proc/\",\n            \"/sys/\",\n            \"/srv/\",\n            \"/lib/\",\n            \"/selinux/\",\n            \"/usr/sbin/\",\n            \"/run/\",\n            \"/lib32/\",\n            \"/lib64/\",\n            \"/lost+found/\",\n            \"/var/lib/kubelet/\",\n            \"/var/lib/ntp/proc\",\n            \"/var/lib/container\",\n            \"Windows\\\\\",\n            \"Python27\\\\\",\n            \"Program Files (x86)\\\\\",\n            \"Program Files\\\\\",\n            \"Boot\\\\\",\n            \"$RECYCLE.BIN\",\n            \"System Volume Information\\\\\",\n            \"Users\\\\Administrator\\\\NTUSER.DAT*\",\n            \"ProgramData\\\\\",\n            \"pagefile.sys\",\n            \"Users\\\\Default\\\\NTUSER.DAT*\",\n            \"Users\\\\Administrator\\\\ntuser.*\"\n      ],\n      \"ExcludeSystemPath\": true,\n      \"Include\": [],\n      \"IsDefault\": 1,\n      \"Retention\": 7,\n      \"Schedule\": \"I|1630689360|PT24H\",\n      \"Source\": [],\n      \"SpeedLimiter\": \"\",\n      \"UseVss\": true\n}",
    "ClientStatus": "running",
    "Name": "testBuckUp",
    "Id": 51880,
    "RegionId": "cn-beijing",
    "UuidList": [
      "inet-49611a6b-a98a-455d-a18a-92af9265****"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.