全部产品
Search
文档中心

云数据库 RDS:DescribeTasks - 查询迁移结果

更新时间:Dec 05, 2024

调用DescribeTasks接口查询RDS实例正在进行中的任务。

接口说明

该接口已下线,请勿使用。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

rm-uf6wjk5xxxxxxxxxx
StartTimestring

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

2020-11-20T01:00Z
EndTimestring

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

2020-11-20T02:00Z
PageSizeinteger

每页可展示的记录数,取值: 30~100,默认值为 30

30
PageNumberinteger

页码,大于 0 且不超过 Integer 数据类型的最大值,默认值为 1

1
Statusstring

任务状态。参数无效。

2
TaskActionstring

任务所使用的的 API 接口。

CreateInstance

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

A103039D-B1B2-4C57-B989-7D7C0DA95426
PageNumberinteger

页码。

1
PageRecordCountinteger

本页记录个数。

30
TotalRecordCountinteger

总记录数。

40
Itemsarray<object>

任务执行信息列表。

TaskProgressInfoobject
Statusstring

任务状态。

2
FinishTimestring

任务结束时间。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2020-11-20T02:00Z
Progressstring

任务进度百分比。

100
StepsInfostring

任务子步骤详情。

null
BeginTimestring

任务开始时间。格式为yyyy-MM-ddTHH:mmZ(UTC 时间)。

2020-11-20T01:00Z
ExpectedFinishTimestring

预计结束时间。

说明 若无特殊情况,该参数为空。
null
TaskErrorCodestring

任务出错时的错误码。

说明 仅在任务出错时返回。
null
CurrentStepNamestring

当前的子步骤名称。

create_instance
ProgressInfostring

任务进度的描述信息。

说明 若目标任务无进度描述信息,该参数为空。
null
StepProgressInfostring

任务的子步骤进度。例如1/4表示该任务共包含 4 个子步骤,当前正在执行第一步。

1/4
TaskErrorMessagestring

任务出错时的错误信息。

说明 仅在任务出错时返回。
null
TaskActionstring

任务使用的 API 接口,例如 CreateDBInstance

CreateDBInstance
Remaininteger

任务预计剩余时间。单位:秒。

说明 如果任务不处于执行中则不返回本参数或返回的值为 0
60
DBNamestring

当任务涉及库时,显示库名。

DBtest
TaskIdstring

任务 ID。

3472xxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "A103039D-B1B2-4C57-B989-7D7C0DA95426",
  "PageNumber": 1,
  "PageRecordCount": 30,
  "TotalRecordCount": 40,
  "Items": {
    "TaskProgressInfo": [
      {
        "Status": "2",
        "FinishTime": "2020-11-20T02:00Z",
        "Progress": "100",
        "StepsInfo": "null",
        "BeginTime": "2020-11-20T01:00Z",
        "ExpectedFinishTime": "null",
        "TaskErrorCode": "null",
        "CurrentStepName": "create_instance",
        "ProgressInfo": "null",
        "StepProgressInfo": "1/4",
        "TaskErrorMessage": "null",
        "TaskAction": "CreateDBInstance",
        "Remain": 60,
        "DBName": "DBtest",
        "TaskId": "3472xxxxx"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400IO.ExceptionIO exception, retry later.io异常。
400InvokeServiceFailedInvoke service failed, retry later.调用服务失败,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-11-18OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情