All Products
Search
Document Center

Database Backup:DescribeRestoreTaskList

Last Updated:Nov 09, 2022

Queries restore tasks.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

  • 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 keyword: refers to the condition keyword defined by the cloud product itself.
  • 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.
Operateaccess levelResource typeconditional keywordAssociation operation
dbs:DescribeRestoreTaskListRead
    All resources
    without
without

Request parameters

ParameterTypeRequiredDescriptionExample
BackupPlanIdstringNo

The ID of the backup schedule.

dbs1hvb0wwwXXXXX
RestoreTaskIdstringNo

The ID of the restore task. You can query multiple restore tasks. Separate multiple IDs with commas (,). You can call the CreateRestoreTask operation to obtain the ID of the restore task.

NoteYou can set either the RestoreTaskId parameter or the BackupPlanId parameter. If both parameters are set, an error occurs.
s102h7rf5anq
PageSizeintegerNo

The number of entries to return on each page. Valid values:

  • 30
  • 50
  • 100
NoteDefault value: 30.
30
PageNumintegerNo

The number of the page to return. The value must be a positive integer. Default value: 0.

1
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request.

ETnLKlblzczshOTUbOCzxxxxxxx
StartTimestamplongNo

The beginning of the time range to query.

1570701361528
EndTimestamplongNo

The end of the time range to query.

1570701361528

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code.

200
PageNuminteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

9C397502-B4F2-4E22-AD97-C81F0049F3F3
ErrCodestring

The error code.

Param.NotFound
Successboolean

Indicates whether the request is successful.

true
ErrMessagestring

The error message.

The specified parameter %s value is not valid.
TotalPagesinteger

The total number of returned pages.

1
TotalElementsinteger

The total number of restore tasks.

1
PageSizeinteger

The number of entries returned on each page.

30
Itemsarray

The details of the backup schedule.

object
RestoreStatusstring

The status of the restore task. Valid values:

  • init: The restore task is not started or does not pass the precheck.
  • running: The restore task is running.
  • stop: The restore task failed.
  • pause: The restore task is stopped.
  • check_pass: The restore task passed the precheck.
running
FullStruAfterRestoreProgressinteger

The progress of schema restore after full data restore.

100
CrossRoleNamestring

The name of the RAM role that can be used to perform backups cross Alibaba Cloud accounts.

test123
RestoreDirstring

The directory of the destination database to which the objects were restored.

100.X.X.10:33204
CrossAliyunIdstring

The unique ID (UID) of the Alibaba Cloud account to which the backup schedule belongs.

2xxx7778xxxxxxxxxx
RestoreObjectsstring

The objects to be restored.

[ { \"DBName\":\"test\" } ]
BackupPlanIdstring

The ID of the backup schedule.

dbs1hvb0wXXXX
DestinationEndpointRegionstring

The region in which the database is deployed.

cn-hangzhou
RestoreTaskCreateTimelong

The time when the restore task was created, such as 1554560477000.

1554560477000
DestinationEndpointUserNamestring

The username of the account that is used to connect to the database.

test
RestoreTaskFinishTimelong

The time when the restore task was complete, such as 1554560477000.

1554560477000
DestinationEndpointIpPortstring

The endpoint that is used to connect to the database.

100.X.X.10:33204
DestinationEndpointDatabaseNamestring

The name of the database.

test
DestinationEndpointInstanceTypestring

The location of the database. Valid values:

  • RDS
  • ECS
  • Express: The database is connected to DBS by using Express Connect, VPN Gateway, or Smart Access Gateway.
  • Agent: The database is connected to DBS over a DBS backup gateway.
  • DDS: The database is an ApsaraDB for MongoDB database.
  • Other: The database is connected to DBS by using the IP address and port of the database.
RDS
DestinationEndpointOracleSIDstring

The SID of the Oracle database.

test
FullStruforeRestoreProgressinteger

The progress of schema restore before full data restore.

0
ErrMessagestring

The error message.

NULL
RestoreTaskIdstring

The ID of the restore task.

s1XXXXXX
FullDataRestoreProgressinteger

The restore progress of the full backup data.

100
ContinuousRestoreProgressinteger

The restore progress of the incremental log files.

100
DestinationEndpointInstanceIDstring

The ID of the database instance.

rm-bp1p8c2947XXX
BackupSetIdstring

The ID of the full backup set that is used in the restore task.

1ibh2f5uXXX
BackupGatewayIdlong

The ID of the backup gateway.

324234332
RestoreTaskNamestring

The name of the restore task.

test
RestoreTimelong

The time to run the restore task, such as 1554560477000.

1554560477000

Example

Normal return example

JSONFormat

{
  "HttpStatusCode": 200,
  "PageNum": 1,
  "RequestId": "9C397502-B4F2-4E22-AD97-C81F0049F3F3",
  "ErrCode": "Param.NotFound",
  "Success": true,
  "ErrMessage": "The specified parameter %s value is not valid. ",
  "TotalPages": 1,
  "TotalElements": 1,
  "PageSize": 30,
  "Items": [
    {
      "RestoreStatus": "running",
      "FullStruAfterRestoreProgress": 100,
      "CrossRoleName": "test123",
      "RestoreDir": "100.X.X.10:33204",
      "CrossAliyunId": "2xxx7778xxxxxxxxxx",
      "RestoreObjects": "[     {         \\\"DBName\\\":\\\"test\\\"       } ]",
      "BackupPlanId": "dbs1hvb0wXXXX",
      "DestinationEndpointRegion": "cn-hangzhou",
      "RestoreTaskCreateTime": 1554560477000,
      "DestinationEndpointUserName": "test",
      "RestoreTaskFinishTime": 1554560477000,
      "DestinationEndpointIpPort": "100.X.X.10:33204",
      "DestinationEndpointDatabaseName": "test",
      "DestinationEndpointInstanceType": "RDS",
      "DestinationEndpointOracleSID": "test",
      "FullStruforeRestoreProgress": 0,
      "ErrMessage": "NULL",
      "RestoreTaskId": "s1XXXXXX",
      "FullDataRestoreProgress": 100,
      "ContinuousRestoreProgress": 100,
      "DestinationEndpointInstanceID": "rm-bp1p8c2947XXX",
      "BackupSetId": "1ibh2f5uXXX",
      "BackupGatewayId": 324234332,
      "RestoreTaskName": "test",
      "RestoreTime": 1554560477000
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.