DescribeUniBackupPolicyDetail - Security Center - Alibaba Cloud Documentation Center

Queries the details of an anti-ransomware policy for databases.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeUniBackupPolicyDetail	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	string	Yes	The ID of the anti-ransomware policy. Note You can call the DescribeUniBackupPolicies operation to query the IDs of anti-ransomware policies.	123

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	F35F45B0-5D6B-4238-BE02-A62D0760****
UniBackupPolicyDTO	object	The details of the anti-ransomware policy.
PolicyStatus	string	The status of the anti-ransomware policy. Valid values: initiating: initializing opening: enabled closing: disabled deleting: deleting	opening
DatabaseType	string	The type of the database. Valid values: MYSQL MSSQL Oracle	ORACLE
InstanceName	string	The name of the server.	sql-test-01
Retention	integer	The retention period of the backup snapshot.	7
SpeedLimiter	long	The maximum network bandwidth that is allowed during data backup. Unit: bytes.	5242880
PolicyName	string	The name of the anti-ransomware policy.	auto_test_sql
InstanceId	string	The ID of the server.	i-2zefcy2id5d60m9t****
PolicyId	long	The ID of the anti-ransomware policy.	123
AgentStatus	string	The status of the database client. Valid values: UNKNOWN: unknown INSTALLED: installed INSTALL_FAILED: installation failed UNINSTALL_FAILED: uninstallation failed	INSTALLED
AccountName	string	The name of the database account.	admin
FullPlan	object	The details of the policy for full backup.
StartTime	string	The time when the full backup started. The time is in the HH:mm:ss format.	00:10:00
PlanType	string	The unit of the interval. Valid values: hourly: hour daily: day weekly: week	daily
Interval	integer	The interval of backup tasks.	2
Days	array	An array that consists of the days of a week on which the backup is performed.
	string	The day of a week on which the backup is performed. Valid values: 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday	0
IncPlan	object	The policy for incremental data backup.
StartTime	string	The time when the incremental data backup starts. The time is in the hh:mm:ss format.	00:10:00
PlanType	string	The unit of the interval. Valid values: hourly: hour daily: day weekly: week	daily
Interval	integer	The interval of backup tasks.	2
Days	array	An array that consists of the days of a week on which the backup is performed.
	string	The day of a week on which the backup is performed. Valid values: 0: Sunday 1: Monday 2: Tuesday 3: Wednesday 4: Thursday 5: Friday 6: Saturday	0

Examples

Sample success responses

JSONformat

{
  "RequestId": "F35F45B0-5D6B-4238-BE02-A62D0760****",
  "UniBackupPolicyDTO": {
    "PolicyStatus": "opening",
    "DatabaseType": "ORACLE",
    "InstanceName": "sql-test-01",
    "Retention": 7,
    "SpeedLimiter": 5242880,
    "PolicyName": "auto_test_sql",
    "InstanceId": "i-2zefcy2id5d60m9t****",
    "PolicyId": 123,
    "AgentStatus": "INSTALLED",
    "AccountName": "admin",
    "FullPlan": {
      "StartTime": "00:10:00",
      "PlanType": "daily",
      "Interval": 2,
      "Days": [
        "0"
      ]
    },
    "IncPlan": {
      "StartTime": "00:10:00",
      "PlanType": "daily",
      "Interval": 2,
      "Days": [
        "0"
      ]
    }
  }
}

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.