Use DescribeUniBackupPolicyDetail to query the details of an anti-ransomware policy - Security Center - Alibaba Cloud - Security Center

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

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	string	Yes	The ID of the anti-ransomware backup policy for databases. Note Call the DescribeUniBackupPolicies operation to obtain this parameter. If DescribeUniBackupPolicies returns an empty list, activate the anti-ransomware feature of Security Center first, make sure that the Security Center agent is installed on the ECS instance and the database has been discovered, and then call CreateUniBackupPolicy to create a backup policy.	123

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 this ID to troubleshoot issues.	F35F45B0-5D6B-4238-BE02-A62D0760****
UniBackupPolicyDTO	object	The details of the anti-ransomware backup policy for databases.
PolicyStatus	string	The status of the anti-ransomware backup policy for databases. Valid values: initiating: Being initialized. opening: Enabled. closing: Disabled. deleting: Being deleted.	opening
DatabaseType	string	The database type. Valid values: MYSQL MSSQL Oracle	ORACLE
InstanceName	string	The name of the server instance.	sql-test-01
Retention	integer	The number of days for which backup snapshots are retained.	7
SpeedLimiter	integer	The network bandwidth throttling for backup. Unit: bytes.	5242880
PolicyName	string	The name of the anti-ransomware backup policy for databases.	auto_test_sql
InstanceId	string	The ID of the server instance.	i-2zefcy2id5d60m9t****
PolicyId	integer	The ID of the anti-ransomware backup policy for databases.	123
AgentStatus	string	The status of the database client agent. Valid values: UNKNOWN: Unknown. INSTALLED: Installed. INSTALL_FAILED: Installation failed. UNINSTALL_FAILED: Uninstallation failed.	INSTALLED
AccountName	string	The database account name.	admin
FullPlan	object	The details of the full backup policy.
StartTime	string	The start time of the full backup. Format: hh:mm:ss.	00:10:00
PlanType	string	The unit of the interval cycle. Valid values: hourly: hour daily: day weekly: week	daily
Interval	integer	The interval cycle.	2
Days	array	The days of the week on which the backup is performed.
	string	The day of the 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 incremental backup policy.
StartTime	string	The start time of the incremental backup. Format: hh:mm:ss.	00:10:00
PlanType	string	The unit of the interval cycle. Valid values: hourly: hour daily: day weekly: week	daily
Interval	integer	The interval cycle.	2
Days	array	The days of the week on which the backup is performed.
	string	The day of the 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

Success response

JSON format

{
  "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
500	ServerError	ServerError
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.