All Products
Search
Document Center

DescribeRestoreTaskList

Last Updated: Mar 27, 2020

Description

You can call this operation to query one or more DBS restore tasks.

Request parameters

Parameter Type Required Description
Action String Yes The operation that you want to perform. Set the value to DescribeRestoreTaskList.
BackupPlanId String No The ID of the backup schedule.
RestoreTaskId String No The ID of the restore task. Separate multiple IDs with commas (,).
PageSize Integer No The number of entries to return on each page. Valid values: 30, 50, and 100. Default value: 30.
PageNum Integer No The number of the page to return. It must be greater than or equal to 0 and smaller than or equal to the maximum value of the Integer type. Default value: 0.

Response parameters

Parameter Type Description
Items List The details of the restore task. For more information, see the description of the RestoreTaskDetail parameter.
TotalPages Integer The total number of pages returned.
PageSize Integer The number of entries returned per page.
PageNum Integer The number of the page returned.
TotalElements Long The total number of restore tasks returned.

RestoreTaskDetail

Parameter Type Description
BackupPlanId String The ID of the backup schedule.
RestoreTaskId String The ID of the restore task.
RestoreStatus String The status of the restore task. Valid values:
  • init: The restore task was not started or did not pass the precheck.
  • running: The restore task was running.
  • stop: The restore task failed.
  • pause: The restore task was stopped.
  • check_pass: The restore task passed the precheck.
RestoreTaskCreateTime Long The time when the restore task was created. Example: 1554560477000.
RestoreTaskFinishTime Long The time when the restore task was finished. Example: 1554560477000.
RestoreTime Long The time point to which the database was restored. Example: 1554560477000.
BackupSetId String The ID of the full backup set used in the restore task.
DestinationEndpointInstanceType String The location of the database. Valid values:
  • rds
  • ecs
  • express: for databases connected to Alibaba Cloud through Express Connect, VPN Gateway, or Smart Access Gateway.
  • agent: for databases connected to Alibaba Cloud through a backup gateway.
  • dds: for ApsaraDB for MongoDB databases.
  • other: for databases connected to Alibaba Cloud through IP addresses and port numbers.
DestinationEndpointRegion String The region of the database.
DestinationEndpointInstanceID String The ID of the database instance.
DestinationEndpointIpPort String The connection endpoint of the database.
DestinationEndpointDatabaseName String The name of the database.
DestinationEndpointUserName String The username for logging on to the database.
DestinationEndpointOracleSID String The system ID (SID) of the Oracle database.
RestoreDir String The directory of the destination database to which the objects were restored.
BackupGatewayId Long The ID of the backup gateway.
RestoreTaskName String The name of the restore task.
RestoreObjects String The objects that were restored.
FullStruforeRestoreProgress Integer The progress of schema restore before full data restore.
FullDataRestoreProgress Integer The restore progress of the full backup data.
ContinuousRestoreProgress Integer The restore progress of the incremental log files.
FullStruAfterRestoreProgress Integer The progress of schema restore after full data restore.
ErrMessage String The error message.

Error codes

Error code Error message Description
RestoreTaskNotDescribe Restore Task not Describe. The error message returned because the restore tasks cannot be queried.