DescribeRestorePlans API for querying restoration tasks - Security Center - Alibaba Cloud - Security Center

Queries restoration tasks.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceName	string	No	The name of the server.	sql-test-001
PageSize	integer	No	The number of entries per page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
Status	string	No	The status of the restoration task. Valid values: init: initializing created: creating running: running completed: complete error: failed restoring: restoring	running

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	BE120DAB-F4E7-4C53-ADC3-A97578AB****
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.	33
Count	integer	The number of entries returned on the current page.	20
RestorePlans	array<object>	The restoration tasks.
	object	The restoration task details.
Status	string	The status of the restoration task. Valid values: init: initializing created: creating running: running completed: complete error: failed restoring: restoring	running
RestorePoint	integer	The point in time to which data is restored.	165875100****
UpdatedTime	integer	The timestamp when the restoration task was last updated. Unit: milliseconds.	166849080****
DatabaseName	string	The name of the database.	Bankup****
InstanceName	string	The name of the server on which the database resides.	sql-test-001
TargetInstanceName	string	The name of the destination server.	hbr-detection-hh
TargetDatabaseName	string	The name of the destination database.	OABak
PolicyName	string	The name of the anti-ransomware policy.	KtDataBase
PolicyId	integer	The ID of the anti-ransomware policy.	123
TargetInstanceId	string	The ID of the destination server.	i-2zehqflgbl9ep2he****
CreatedTime	integer	The timestamp when the restoration task was created. Unit: milliseconds.	1655174753****

Examples

Success response

JSON format

{
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578AB****",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 33,
    "Count": 20
  },
  "RestorePlans": [
    {
      "Status": "running",
      "RestorePoint": 0,
      "UpdatedTime": 0,
      "DatabaseName": "Bankup****",
      "InstanceName": "sql-test-001",
      "TargetInstanceName": "hbr-detection-hh",
      "TargetDatabaseName": "OABak",
      "PolicyName": "KtDataBase",
      "PolicyId": 123,
      "TargetInstanceId": "i-2zehqflgbl9ep2he****",
      "CreatedTime": 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.