All Products
Search
Document Center

Security Center:CreateUniRestorePlan

Last Updated:Jun 15, 2026

Creates a database anti-ransomware restoration task.

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

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

TimePoint

integer

Yes

The point in time to which you want to restore the database.

Note

Call the DescribeRestorePlans operation to obtain this parameter.

1656957664000

PolicyId

integer

Yes

The ID of the database anti-ransomware backup policy.

Note

Call the DescribeUniBackupPolicies operation to obtain this parameter.

123

Database

string

No

The name of the database.

qtc

InstanceUuid

string

No

The unique identifier of the database backup client on the destination server for restoration.

Note

Call the DescribeUniBackupDatabase operation to obtain this parameter.

ac457b30598d11ed800000163e02****

ResetTime

string

No

The reset_time value of the selected record from the recoverable points in time when you query backups for an Oracle database.

Note

Call the DescribeUniRecoverableList operation to obtain this parameter.

2022-10-29 01:06:24

ResetScn

string

No

The reset_scn value of the selected record from the recoverable points in time when you query backups for an Oracle database.

Note

Call the DescribeUniRecoverableList operation to obtain this parameter.

925702.0

RestoreInfo

string

No

The database restoration information when the database type is MSSQL. The value is a JSON string. Valid values:

  • name: the name of the database.

  • files: the file path of the database.

Note

Call the DescribeUniRecoverableList operation to obtain this parameter.

{"files": {"qtc":"F:\\database\\qtc.mdf","qtc_log":"F:\\database\\qtc_0.ldf"}, "name":"qtc"}

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.

F5CF78A7-30AA-59DB-847F-13EE3AE7****

Examples

Success response

JSON format

{
  "RequestId": "F5CF78A7-30AA-59DB-847F-13EE3AE7****"
}

Error codes

HTTP status code

Error code

Error message

Description

500 ServerError ServerError
403 NoPermission caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.