DescribeTaskInfo - 查询任务详情

更新时间:
复制 MD 格式

您可以调用DescribeTaskInfo接口,查询集群任务的详细信息,例如任务类型、运行状态、运行阶段等。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cs:DescribeTaskInfo

get

*全部资源

*

无 无

请求语法

GET /tasks/{task_id} HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

task_id

string

是

任务 ID。

T-5faa48fb31b6b8078d00****

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称

类型

描述

示例值

object

返回体数据。

task_id

string

任务 ID。

T-5faa48fb31b6b8078d000006

cluster_id

string

集群 ID。

c78592bfe92244365b3c3ad47f1de****

task_type

string

任务类型,扩容任务的类型为cluster_scaleout。

cluster_scaleout

state

string

代表任务的运行状态。取值:

  • running:任务正在运行中。

  • fail:任务运行失败。

  • success:任务运行完成。

running

created

string

任务创建时间。

2020-11-10T16:02:04+08:00

updated

string

任务更新时间。

2020-11-10T16:03:06+08:00

target

object

任务执行对象。

id

string

任务执行对象 ID。

c78592bfe92244365b3c3ad47f1de****

type

string

任务执行对象类型。

cluster

parameters

object

任务参数。

stages

array<object>

任务阶段。

array<object>

任务阶段。

state

string

任务阶段状态。

running

start_time

string

任务阶段开始时间,格式为 YYYY-MM-DD HH:mm:ss。

2022-12-15 23:00:00

end_time

string

任务阶段结束时间,格式为 YYYY-MM-DD HH:mm:ss。

2022-12-15 23:00:00

message

string

任务阶段信息。

success to xxxxx

outputs

object

任务阶段输出。

current_stage

string

任务当前运行阶段。

DrainNodes

events

array<object>

任务产生的事件。

object

事件详情。

action

string

事件动作。

start

level

string

事件等级。

Normal

message

string

事件消息。

start to xxx

reason

string

事件原因。

NodePoolUpgradeStart

source

string

事件来源。

ACK

timestamp

string

事件生成时间,使用 Unix 时间戳,单位为毫秒。

1669706229286

task_result

array<object>

任务执行详情。

object

任务详情。

data

string

任务操作的资源,例如:扩容时操作资源是实例,那么此处就是实例 ID。

i-xxx

status

string

资源扩容的状态。取值:

  • success:扩容成功。

  • failed:扩容失败。

  • initial:初始化中。

success

error

object

任务错误信息。

code

string

错误码。

400

message

string

错误消息。

failed to xxx

outputs

object

任务输出。

示例

正常返回示例

JSON格式

{
  "task_id": "T-5faa48fb31b6b8078d000006",
  "cluster_id": "c78592bfe92244365b3c3ad47f1de****",
  "task_type": "cluster_scaleout",
  "state": "running",
  "created": "2020-11-10T16:02:04+08:00",
  "updated": "2020-11-10T16:03:06+08:00",
  "target": {
    "id": "c78592bfe92244365b3c3ad47f1de****\n",
    "type": "cluster"
  },
  "parameters": {
    "test": "test",
    "test2": 1
  },
  "stages": [
    {
      "state": "running",
      "start_time": "2022-12-15 23:00:00",
      "end_time": "2022-12-15 23:00:00",
      "message": "success to xxxxx",
      "outputs": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "current_stage": "DrainNodes",
  "events": [
    {
      "action": "start",
      "level": "Normal",
      "message": "start to xxx",
      "reason": "NodePoolUpgradeStart",
      "source": "ACK",
      "timestamp": "1669706229286"
    }
  ],
  "task_result": [
    {
      "data": "i-xxx",
      "status": "success"
    }
  ],
  "error": {
    "code": "400",
    "message": "failed to xxx"
  },
  "outputs": {
    "test": "test",
    "test2": 1
  }
}

错误码

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

变更历史

更多信息,参考变更详情。