调用DescribeMigrateTasks接口查询RDS SQL Server实例备份数据上云任务列表。

该接口可以查询实例在最近一周内的备份数据上云任务记录。

说明
  • 备份数据上云的源备份文件必须是全量备份(FULL)文件。
  • 暂不支持SQL Server 2017集群版实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMigrateTasks

系统规定参数。取值:DescribeMigrateTasks

DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

StartTime String 2017-10-20T01:00Z

查询开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

EndTime String 2017-10-25T01:00Z

查询结束时间,必须大于开始时间。格式:yyyy-MM-ddTHH:mmZ(UTC时间)。

PageSize Integer 30

每页记录数,取值:30~100。默认值:30

PageNumber Integer 1

页码,取值:大于0且不超过Integer的最大值。

默认值:1

ResourceGroupId String rg-acfmy*****

资源组ID。

返回数据

名称 类型 示例值 描述
DBInstanceId String rm-uf6wjk5xxxxxxx

实例ID。

PageNumber Integer 1

获取第几页的数据。

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

请求ID。

PageRecordCount Integer 10

每页记录数。

TotalRecordCount Integer 30

满足条件的总的记录数。

Items Array of MigrateTask

备份数据上云任务信息列表。

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

备份数据上云任务结束时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

Status String Success

备份数据上云任务的状态,取值:

  • NoStart:未开始
  • Running:运行中
  • Success:成功
  • Failed:失败
  • Waiting:等待(等待增量备份文件导入)
Description String Api description

备份数据上云任务的描述信息。

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

备份数据上云任务创建时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

DBName String testDB

数据库名称。

BackupMode String FULL

备份数据上云任务类型,取值:

  • FULL:表示通过全量备份文件去执行还原操作。
  • UPDF:表示通过增量文件或者日志文件去还原增量部分的数据。
MigrateTaskId String 564522545

备份数据上云任务的ID。

IsDBReplaced String True

是否是覆盖性导入。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeMigrateTasks
&DBInstanceId=rm-uf6wjk5xxxxxxx
&StartTime=2017-10-20T01:00Z
&EndTime=2017-10-25T01:00Z
&<公共请求参数>

正常返回示例

XML格式

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

<?xml version="1.0" encoding="UTF-8" ?>
<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格式

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

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidStartTimeAndEndTime.Malformed The end time must be greater than the start time 结束时间必须大于开始时间。
403 InvalidInstanceState The DB instance state does not support this operation. 操作失败,当前实例不可用。

访问错误中心查看更多错误码。