全部产品
Search

搜索本产品

    云数据库 RDS：DescribeMigrateTasks - 查询备份数据上云任务列表

    文档中心

    云数据库 RDS：DescribeMigrateTasks - 查询备份数据上云任务列表

    更新时间：Sep 26, 2023

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

    接口说明

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

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

    调试

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

    调试

    授权信息

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

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

    请求参数

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

    实例ID。

    		rm-uf6wjk5xxxxxxx
    StartTimestring是

    查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。

    		2017-10-20T01:00Z
    EndTimestring是

    查询结束时间，必须大于开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。

    		2017-10-25T01:00Z
    PageSizeinteger否

    每页记录数，取值：30~100。默认值：30。

    		30
    PageNumberinteger否

    页码，取值：大于0且不超过Integer的最大值。

    默认值：1。

    		1
    ResourceGroupIdstring否

    资源组ID。

    		rg-acfmy*****

    返回参数

    名称类型描述示例值
    object
    DBInstanceIdstring

    实例ID。

    		rm-uf6wjk5xxxxxxx
    PageNumberinteger

    获取第几页的数据。

    		1
    RequestIdstring

    请求ID。

    		4E356DDF-6B83-45DB-99D5-4B1E8A0D286B
    PageRecordCountinteger

    每页记录数。

    		10
    TotalRecordCountinteger

    满足条件的总的记录数。

    		30
    Itemsobject []

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

    EndTimestring

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

    		2017-05-30T13:11:04Z
    Statusstring

    备份数据上云任务的状态，取值：

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

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

    		Api description
    CreateTimestring

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

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

    数据库名称。

    		testDB
    BackupModestring

    备份数据上云任务类型，取值：

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

    备份数据上云任务的ID。

    		564522545
    IsDBReplacedstring

    是否是覆盖性导入。

    		True

    示例

    正常返回示例

    JSON格式

    {
  "DBInstanceId": "rm-uf6wjk5xxxxxxx",
  "PageNumber": 1,
  "RequestId": "4E356DDF-6B83-45DB-99D5-4B1E8A0D286B",
  "PageRecordCount": 10,
  "TotalRecordCount": 30,
  "Items": {
    "MigrateTask": [
      {
        "EndTime": "2017-05-30T13:11:04Z",
        "Status": "Success",
        "Description": "Api description",
        "CreateTime": "2017-05-30T12:11:04Z",
        "DBName": "testDB",
        "BackupMode": "FULL",
        "MigrateTaskId": "564522545",
        "IsDBReplaced": "True"
      }
    ]
  }
}

    错误码

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

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

    变更历史

    变更时间变更内容概要操作
    2022-08-04OpenAPI 错误码发生变更，OpenAPI 入参发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码：400
      删除错误码：403
    入参OpenAPI 入参发生变更
      新增入参：ResourceGroupId