You can call this operation to query the list of migration tasks.

You can query the migration tasks of the instance in the last week through this operation.

Note
  • The backup data files which are uploaded to OSS must be full backup files.
  • This operation is not applicable to SQL 2017 cluster instances.

Debugging

You can use API Explorer to perform debugging. API Explorer allows you to perform various operations to simplify API usage. For example, you can retrieve APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required? Example Description
Action String Yes DescribeMigrateTasks

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

DBInstanceId String Yes rm-uf6wjk5xxxxxxx

The ID of the instance.

StartTime String Yes 2017-10-20T01:00Z

The start time of the query. Format: yyyy-MM-ddTHH:mm:ssZ.

EndTime String Yes 2017-10-25T01:00Z

The end time of the query. It must be later than the start time. Format: yyyy-MM-ddTHH:mm:ssZ.

PageSize Integer No 30000

The number of records on each page. Valid values:

  • 30.
  • 50.
  • 100.

Default value: 30.

PageNumber Integer No 1

The page number. It must be greater than 0 and cannot exceed the maximum value of the given Integer.

Default value: 1.

AccessKeyId String No LTAIfCxxxxxxx

The AccessKey ID issued by Alibaba Cloud for users to access services.

Response parameters

Parameter Type Example Description
DBInstanceId String rm-uf6wjk5xxxxxxx

The ID of the instance.

Items

The list of migration tasks.

└BackupMode String FULL

The type of the migration task. Valid values:

  • FULL: indicates that full backup files are used to restore the data.
  • UPDF: indicates that incremental files or log files are used to restore the data.
└CreateTime String 2017-05-30T12:11:04Z

The creation time of the migration task.

└DBName String testDB

The name of the database.

└Description String Api description

The description of the migration task.

└EndTime String 2017-05-30T13:11:04Z

The end time of the migration task.

└IsDBReplaced String True

Indicates whether the imported data overwrites the existing data.

└MigrateTaskId String 564522545

The ID of the migratioin task.

└Status String Success

The status of the migration task. Valid values:

  • NoStart.
  • Running.
  • Success.
  • Failed.
  • Waiting: waiting to import incremental backup files.
PageRecordCount Integer 10

The number of records on each page.

PageNumber Integer   1

The number of the page that contains the expected data.

RequestId String 4E356DDF-6B83-45DB-99D5-4B1E8A0D286B

The ID of the request.

TotalRecordCount Integer 30

The total number of records.

Examples

Sample requests


http(s)://rds.aliyuncs.com/? Action=DescribeMigrateTasks
&DBInstanceId=rm-uf6wjk5xxxxxxx 
&StartTime=2017-10-20T01:00Z 
&EndTime=2017-10-25T01:00Z 
&<Common request parameters>

Successful response examples

XML format

<DescribeMigrateTasksResponse> 
  <RequestId>A5409D02-D661-4BF3-8F3D-0A814D0574E7</RequestId> 
  <PageRecordCount>1</PageRecordCount> 
  <PageNumber>1</PageNumber>
  <TotalRecordCount>10</TotalRecordCount>
  <Items>
    <MigrateTaskId>rm-bp1842vxxxxx</MigrateTaskId>
    <DBName>test02</DBName>
    <CreateTime>2017-05-30 T12:11:4Z</CreateTime>
    <EndTime>2017-05-30 T12:11:4Z</EndTime> 
    <IsDBReplaced>True</IsDBReplaced> 
    <Status>Success</Status> 
    <BackupMode>FULL</BackupMode>
    <Description>Api description</Description>
  </Items>
</DescribeMigrateTasksResponse>

JSON format

{
	"Items":{
		"Status":"Success",
		"MigrateTaskId":"rm-bp1842vxxxxx",
		"Description":"Api description",
		"IsDBReplaced":"True",
		"CreateTime":"2017-05-30 T12:11:4Z",
		"BackupMode":"FULL",
		"EndTime":"2017-05-30 T12:11:4Z",
		"DBName":"test02"
	},
	"TotalRecordCount":10,
	"PageNumber":1,
	"RequestId":"A5409D02-D661-4BF3-8F3D-0A814D0574E7",
	"PageRecordCount":1
}

Error codes

View error codes