DescribeUniBackupPolicies - Security Center - Alibaba Cloud Documentation Center

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

Authorization information

There is currently no authorization information disclosed in the API.

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. NoteWe 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	An array that consists of the anti-ransomware policies.
	object	The information about the anti-ransomware policy.
PolicyStatus	string	The status of the anti-ransomware policy. Valid values: initiating: initializing opening: enabled closing: disabled deleting: deleting	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: initializing running: running completed: complete restoring: restoring creating: creating created: created	creating
InstanceUuid	string	The UUID of the Hybrid Backup Recovery (HBR) 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 anti-ransomware 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 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

Example

Normal return example

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 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 API error center.