DescribeMigrateTaskById - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries a task that is used to import the backup data of an ApsaraDB RDS for SQL Server instance to an Object Storage Service (OSS) bucket.

Operation description

Supported database engines

SQL Server

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-bp11e1tzgxxxx4ox
MigrateTaskId	string	Yes	The migration task ID. You can call the DescribeMigrateTasks operation to query the migration task ID.	235943
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmy*****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Status	string	The status of the migration task. Valid values: NoStart: The task has not started. Running:The task is in progress. Success: The task is successful. Failed: The task failed. Waiting: The task is waiting for an incremental backup file to be imported.	Success
EndTime	string	The time when the migration task was completed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2021-05-30T15:15:05Z
DBInstanceName	string	The instance ID.	rm-uf6wjk5xxxxxxxxxx
RequestId	string	The ID of the request.	6ED3635A-01F9-47BD-B9C8-CB3FD70A336E
Description	string	The description of the migration task.	Success to DBCC checkdb asynchronously
CreateTime	string	The time when the migration task was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2020-05-30T12:11:04Z
DBName	string	The name of the database.	mytestdb
BackupMode	string	The type of the migration task. Valid values: FULL: The migration task migrates full backup files that can be used to restore the full data of the instance. UPDF: The migration task migrates incremental or log backup files that can be used to restore the incremental data of the instance.	FULL
MigrateTaskId	string	The ID of the migration task.	235943
IsDBReplaced	string	Indicates whether the imported data overwrites the existing data. Valid values: False: The imported data does not overwrite the existing data. True: The imported data overwrites the existing data.	False

Examples

Sample success responses

JSONformat

{
  "Status": "Success",
  "EndTime": "2021-05-30T15:15:05Z",
  "DBInstanceName": "rm-uf6wjk5xxxxxxxxxx",
  "RequestId": "6ED3635A-01F9-47BD-B9C8-CB3FD70A336E",
  "Description": "Success to DBCC checkdb asynchronously",
  "CreateTime": "2020-05-30T12:11:04Z",
  "DBName": "mytestdb",
  "BackupMode": "FULL",
  "MigrateTaskId": "235943",
  "IsDBReplaced": "False"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidStartTimeAndEndTime.Malformed	The end time must be greater than the start time.	The operation failed. The end time must be later than the start time. For example, you can set the start time to 2011-05-30 T12:11:20Z and set the end time to 2011-06-08 T12:09:20Z.
400	InvalidMigrateTask	The specified MigrateTaskId 237360 does not exist. Please check again.	The backup data migration task with the 237360 ID cannot be found.
403	InvalidInstanceState	The DB instance state does not support this operation.	The operation failed. The RDS instance is unavailable.

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

Change history

Change time	Summary of changes	Operation
2022-08-04	The Error code has changed. The request parameters of the API has changed	View Change Details