Call the InstallUniBackupAgent API to install the anti-ransomware agent for databases - Security Center - Alibaba Cloud - Security Center

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PolicyId	integer	Yes	The ID of the anti-ransomware backup policy for databases. Note You can call the DescribeUniBackupPolicies operation to obtain this parameter. Before calling this operation, call DescribeUniBackupPolicies to confirm that AgentStatus is not INSTALLING. If the status is INSTALLING, wait for the current installation to complete before calling this operation. Before obtaining a valid PolicyId, install the Security Center agent on the ECS instance, complete database discovery or manual registration, 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. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	53ACA55D-0325-5056-A72D-D0EC0B9C****

Examples

Success response

JSON format

{
  "RequestId": "53ACA55D-0325-5056-A72D-D0EC0B9C****"
}

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.