All Products
Search
Document Center

Security Center:DescribeRestorePlans

Last Updated:Nov 25, 2024

Queries restoration tasks.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeRestorePlansget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceNamestringNo

The name of the server.

sql-test-001
PageSizeintegerNo

The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 20 entries are returned on each page.

Note We recommend that you do not leave this parameter empty.
20
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
StatusstringNo

The status of the restoration task. Valid values:

  • init: initializing
  • created: creating
  • running: running
  • completed: complete
  • error: failed
  • restoring: restoring
running

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

BE120DAB-F4E7-4C53-ADC3-A97578AB****
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

33
Countinteger

The number of entries returned on the current page.

20
RestorePlansarray<object>

An array that consists of the restoration tasks.

RestorePlanobject

The information about the restoration task.

Statusstring

The status of the restoration task. Valid values:

  • init: initializing
  • created: creating
  • running: running
  • completed: complete
  • error: failed
  • restoring: restoring
running
RestorePointlong

The point in time to which data is restored.

165875100****
UpdatedTimelong

The timestamp when the restoration task was last updated. Unit: milliseconds.

166849080****
DatabaseNamestring

The name of the database.

Bankup****
InstanceNamestring

The name of the server on which the database resides.

sql-test-001
TargetInstanceNamestring

The name of the destination server.

hbr-detection-hh
TargetDatabaseNamestring

The name of the destination database.

OABak
PolicyNamestring

The name of the anti-ransomware policy.

KtDataBase
PolicyIdlong

The ID of the anti-ransomware policy.

123
TargetInstanceIdstring

The ID of the destination server.

i-2zehqflgbl9ep2he****
CreatedTimelong

The timestamp when the restoration task was created. Unit: milliseconds.

1655174753****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history