DescribeMigrateTaskById - 获取迁移任务

更新时间: 2023-09-20 11:41:33

调用DescribeMigrateTaskById查询SQL Server的某个OSS备份上云任务的信息。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeMigrateTaskByIdRead
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

RDS SQL Server实例ID。

rm-bp11e1tzgxxxx4ox
MigrateTaskIdstring

备份上云任务的ID,可以通过DescribeMigrateTasks接口查询。

235943
ResourceGroupIdstring

资源组ID。

rg-acfmy*****

返回参数

名称类型描述示例值
object
Statusstring

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

  • NoStart:未开始
  • Running:运行中
  • Success:成功
  • Failed:失败
  • Waiting:等待增量备份文件导入
Success
EndTimestring

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

2021-05-30T15:15:05Z
DBInstanceNamestring

实例ID。

rm-uf6wjk5xxxxxxxxxx
RequestIdstring

请求ID。

6ED3635A-01F9-47BD-B9C8-CB3FD70A336E
Descriptionstring

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

Success to DBCC checkdb asynchronously
CreateTimestring

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

2020-05-30T12:11:04Z
DBNamestring

数据库名称。

mytestdb
BackupModestring

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

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

OSS备份上云任务的ID。

235943
IsDBReplacedstring

是否是覆盖性导入。取值:

  • False:否
  • True:是
False

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code错误码错误信息描述
400InvalidStartTimeAndEndTime.MalformedThe end time must be greater than the start time.操作失败,开始时间需早于结束时间。正确格式:开始时间为2011-05-30 T12:11:20Z,结束时间为2011-06-08 T12:09:20Z。
400InvalidMigrateTaskThe specified MigrateTaskId 237360 does not exist. Please check again.指定的迁移器237360不存在,请检查。
403InvalidInstanceStateThe DB instance state does not support this operation.操作失败,当前实例不可用。

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

变更历史

变更时间变更内容概要操作
2022-08-04OpenAPI 错误码发生变更,OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
阿里云首页 云数据库 RDS 相关技术圈