Use DescribeUniBackupPolicies to query anti-ransomware policies for databases - Security Center - Alibaba Cloud - Security Center

Queries the list of database anti-ransomware policies.

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:DescribeUniBackupPolicies

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyName	string	No	The name of the database anti-ransomware backup policy.	auto_oracle_Hpm
PageSize	integer	No	The maximum number of entries to display per page for a paginated query. The default number of entries per page is 20. If the PageSize parameter is left empty, 20 entries are returned by default. Note We recommend that you do not leave PageSize empty.	20
CurrentPage	integer	No	The page number from which to start displaying query results. Default value: 1, which indicates that query results are displayed starting from page 1.	1

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.	ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in a paginated query.	1
PageSize	integer	The number of database anti-ransomware policies displayed per page in a paginated query.	20
TotalCount	integer	The total number of database anti-ransomware policies.	100
Count	integer	The number of database anti-ransomware policies displayed on the current page.	20
UniBackupPolicies	array<object>	The collection of database anti-ransomware backup policies.
	object	The information about a database anti-ransomware backup policy.
PolicyStatus	string	The status of the database anti-ransomware backup policy. Valid values: initiating: Being initialized. opening: Being enabled. closing: Being disabled. deleting: Being deleted. enabled: Enabled. disabled: Disabled.	opening
ErrorMessage	string	The error message of the backup policy.	AttachRamRoleError
LatestBackResult	string	The result of the latest backup plan execution.	completed
UniRegionId	string	The region ID of the database server.	cn-hangzhou
PlanStatus	string	The status of the backup plan. Valid values: init: Being initialized. running: Running. completed: Completed. restoring: Being restored. creating: Being created. created: Created.	creating
InstanceUuid	string	The unique identifier of the server database backup client.	cf1bcad4063f11ed800000163e0e****
PolicyName	string	The name of the database anti-ransomware backup policy.	auto_oracle_37f
AgentErrorMessage	string	The error message of the client exception.	INSTALL_TIMEOUT
InstanceId	string	The instance ID of the server.	i-9dp7mubt5wit6g0h****
AgentStatus	string	The status of the database client agent. Valid values: UNKNOWN: Unknown. INSTALLED: Installed. INSTALL_FAILED: Installation failed. UNINSTALL_FAILED: Uninstallation failed.	INSTALLED
DatabaseType	string	The type of the database. Valid values: MYSQL MSSQL Oracle	MYSQL
ErrorCode	string	The error code returned when the backup plan execution fails.	EXPIRED
DatabaseName	string	The name of the database.	abc123
InstanceName	string	The name of the server instance.	sql-test-001
LatestBackupTime	string	The time when the latest backup plan was executed.	2022-01-01 00:00:11
InstanceStatus	string	The status of the ECS instance. Valid values: Stopped: Stopped. Running: Running.	Running
PolicyId	integer	The ID of the database anti-ransomware backup policy.	123

Examples

Success response

JSON format

{
  "RequestId": "ACF97412-FD09-4D1F-994F-34DF12BR****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "UniBackupPolicies": [
    {
      "PolicyStatus": "opening",
      "ErrorMessage": "AttachRamRoleError",
      "LatestBackResult": "completed",
      "UniRegionId": "cn-hangzhou",
      "PlanStatus": "creating",
      "InstanceUuid": "cf1bcad4063f11ed800000163e0e****",
      "PolicyName": "auto_oracle_37f",
      "AgentErrorMessage": "INSTALL_TIMEOUT",
      "InstanceId": "i-9dp7mubt5wit6g0h****",
      "AgentStatus": "INSTALLED",
      "DatabaseType": "MYSQL",
      "ErrorCode": "EXPIRED",
      "DatabaseName": "abc123",
      "InstanceName": "sql-test-001",
      "LatestBackupTime": "2022-01-01 00:00:11",
      "InstanceStatus": "Running",
      "PolicyId": 123
    }
  ]
}

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.