文档

DescribeTaskInfo - 查询相关管控任务流进度

更新时间:

调用DescribeTaskInfo接口查看相关管控任务流进度。

调试

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

授权信息

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

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

请求参数

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

地域 ID。

说明 您可以调用 DescribeRegions 接口查看 AnalyticDB MySQL 版支持的地域和可用区信息,包括地域 ID。
cn-hongkong
DBClusterIdstring

AnalyticDB MySQL 数仓版(3.0)集群 ID。

说明 您可以调用 DescribeDBClusters 接口查询目标地域中所有 AnalyticDB MySQL 数仓版(3.0)集群的集群 ID。
am-bp1xxxxxxxx47
TaskIdinteger

任务 ID。

225685759

返回参数

名称类型描述示例值
object
TaskInfoobject

任务信息。

Statusstring

状态:

  • Waiting:等待中
  • Running:执行中
  • Finished:已结束
  • Failed:失败
  • Closed:已关闭
  • Cancel:已取消
  • Retry:重试
  • Pause:暂停
  • Stop:中断
Finished
FinishTimestring

结束时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2020-01-07T08:08:50Z
Progressstring

进度,单位:百分比(%)。

100
BeginTimestring

开始时间,格式:yyyy-MM-ddTHH:mm:ssZ。

2020-01-07T07:39:56Z
TaskIdinteger

任务 ID。

225685759
RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF

示例

正常返回示例

JSON格式

{
  "TaskInfo": {
    "Status": "Finished",
    "FinishTime": "2020-01-07T08:08:50Z",
    "Progress": "100",
    "BeginTime": "2020-01-07T07:39:56Z",
    "TaskId": 225685759
  },
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

错误码

HTTP status code错误码错误信息描述
404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.您指定的 DBClusterId 不存在,请确认 DBClusterId 值是否正确。

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

变更历史

变更时间变更内容概要操作
2023-08-03OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:RegionId
  • 本页导读 (1)
文档反馈