DescribeUniBackupPolicies - Security Center - Alibaba Cloud Documentation Center

Queries the anti-ransomware policies that are created for databases.

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:DescribeUniBackupPolicies	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PolicyName	string	No	The name of the anti-ransomware policy.	auto_oracle_Hpm
PageSize	integer	No	The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page. Note We recommend that you do not leave this parameter empty.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	ACF97412-FD09-4D1F-994F-34DF12BR****
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	100
Count	integer	The number of entries returned on the current page.	20
UniBackupPolicies	array<object>	An array that consists of the anti-ransomware policies.
UniBackupPolicyDTO	object	The information about the anti-ransomware policy.
PolicyStatus	string	The status of the anti-ransomware policy. Valid values: initiating opening closing deleting enabled disabled	opening
ErrorMessage	string	The error message for the anti-ransomware policy.	AttachRamRoleError
LatestBackResult	string	The execution result of the last backup task.	completed
UniRegionId	string	The region ID of the server that hosts the database.	cn-hangzhou
PlanStatus	string	The status of the backup task. Valid values: init running completed restoring creating created	creating
InstanceUuid	string	The UUID of the agent that is used to back up the data of the database.	cf1bcad4063f11ed800000163e0e****
PolicyName	string	The name of the anti-ransomware policy.	auto_oracle_37f
AgentErrorMessage	string	The error message for the anti-ransomware agent.	INSTALL_TIMEOUT
InstanceId	string	The ID of the server.	i-9dp7mubt5wit6g0h****
AgentStatus	string	The status of the agent. Valid values: UNKNOWN INSTALLED INSTALL_FAILED UNINSTALL_FAILED	INSTALLED
DatabaseType	string	The type of the database. Valid values: MYSQL MSSQL Oracle	MYSQL
ErrorCode	string	The error code returned when the backup task fails.	EXPIRED
DatabaseName	string	The name of the database.	abc123
InstanceName	string	The name of the server.	sql-test-001
LatestBackupTime	string	The time when the last backup task was executed.	2022-01-01 00:00:11
InstanceStatus	string	The status of the Elastic Compute Service (ECS) instance. Valid values: Stopped Running	Running
PolicyId	long	The ID of the anti-ransomware policy.	123

Examples

Sample success responses

JSONformat

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

No change history