You can call the DescribeMigrateTaskById operation to query a single task that is used to migrate the backup data of an ApsaraDB RDS for SQL Server instance to an Object Storage Service (OSS) bucket.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeMigrateTaskById

The operation that you want to perform. Set the value to DescribeMigrateTaskById.

DBInstanceId String Yes rm-bp11e1tzgxxxx4ox

The ID of the instance.

MigrateTaskId String Yes 235943

The ID of the migration task. You can call the DescribeMigrateTasks operation to query the ID of the migration task.

ResourceGroupId String No rg-acfmy*****

The ID of the resource group.

Response parameters

Parameter Type Example Description
Status String Success

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.
EndTime String 2021-05-30T15:15:05Z

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.

DBInstanceName String rm-uf6wjk5xxxxxxxxxx

The ID of the instance.

RequestId String 6ED3635A-01F9-47BD-B9C8-CB3FD70A336E

The ID of the request.

Description String Success to DBCC checkdb asynchronously

The description of the migration task.

CreateTime String 2020-05-30T12:11:04Z

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.

DBName String mytestdb

The name of the database.

BackupMode String FULL

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.
MigrateTaskId String 235943

The ID of the migration task.

IsDBReplaced String False

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.

Examples

Sample requests

http(s)://rds.aliyuncs.com/?Action=DescribeMigrateTaskById
&DBInstanceId=rm-bp11e1tzgxxxx4ox
&MigrateTaskId=235943
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeMigrateTaskByIdResponse>
  <Status>Success</Status>
  <Description>Success to DBCC checkdb asynchronously</Description>
  <RequestId>B994DF29-44A1-43FD-A693-917930DFEBCE</RequestId>
  <EndTime>2021-03-04T13:50:23Z</EndTime>
  <MigrateTaskId>235943</MigrateTaskId>
  <CreateTime>2021-03-04T13:47:17Z</CreateTime>
  <BackupMode>FULL</BackupMode>
  <DBName>mytestdb</DBName>
  <DBInstanceName>rm-bp11e1tzgxxxxx4ox</DBInstanceName>
</DescribeMigrateTaskByIdResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Status" : "Success",
  "Description" : "Success",
  "RequestId" : "6ED3635A-01F9-47BD-B9C8-CB3FD70A336E",
  "EndTime" : "2021-03-04T13:50:23Z",
  "MigrateTaskId" : "235943",
  "CreateTime" : "2021-03-04T13:47:17Z",
  "BackupMode" : "FULL",
  "DBName" : "mytestdb",
  "DBInstanceName" : "rm-bp11e1tzgxxxxx4ox"
}

Error codes

HTTP status code Error code Error message Description
400 InvalidStartTimeAndEndTime.Malformed The end time must be greater than the start time. The error message returned because the start time must be earlier than the end time. For example, the start time is 2011-05-30 T12:11:20Z, and the end time is 2011-06-08 T12:09:20Z.
400 InvalidMigrateTask The specified MigrateTaskId 237360 does not exist. Please check again. The error message returned because the task ID 237360 that you specified cannot be found.
403 InvalidInstanceState The DB instance state does not support this operation. The error message returned because the status of the instance does not support this operation.

For a list of error codes, visit the API Error Center.