文档首页/ 数据仓库服务 DWS/ 更多文档/ API参考（吉隆坡区域）/ API说明/ 任务管理/ 查询集群任务详情
更新时间：2025-09-18 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询集群任务详情

功能介绍

查询集群任务详情。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/clusters/{cluster_id}/actions/{action_name}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID。获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

cluster_id

是

String

参数解释：

集群ID。获取方法请参见获取集群ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

action_name

是

String

参数解释：

任务名称。当前仅部分任务在操作中阶段支持查看任务详情。

约束限制：

不涉及。

取值范围：

GROWING、RESIZE_FAILURE、RESTORING、RESTORING_FAILED、SNAPSHOTTING、SNAPSHOTTING_FAILED、FINE_GRAINED_RESTORING、FINE_GRAINED_RESTORING_FAILED

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

id

String

参数解释：

任务详情响应体。

取值范围：

随机生成的UUID。

action_name

String

参数解释：

任务名称，同入参字段。

取值范围：

不涉及。

status

String

参数解释：

任务状态。

取值范围：

不涉及。

cluster_name

String

参数解释：

集群名称。

取值范围：

不涉及。

submit_time

String

参数解释：

任务提交时间。

取值范围：

不涉及。

items

Array of ActionItemVo objects

参数解释：

任务详情子项。

取值范围：

不涉及。
表3 ActionItemVo

参数

参数类型

描述

item_name

String

参数解释：

任务详情子项，一级菜单。

取值范围：

不涉及。

sub_items

Array of ActionSubItemVo objects

参数解释：

任务详情子项，一级菜单详情。

取值范围：

不涉及。
表4 ActionSubItemVo

参数

参数类型

描述

status

String

参数解释：

状态。

取值范围：

不涉及。

detail

String

参数解释：

扩展信息。

取值范围：

不涉及。

sub_item_name

String

参数解释：

子项名称，根据请求header中的x-language字段返回对应的中/英文名称。

取值范围：

不涉及。

begin_time

String

参数解释：

开始时间。

取值范围：

时间格式，或null值。

end_time

String

参数解释：

结束时间。

取值范围：

时间格式，或null值。

estimated_time

Integer

参数解释：

预估时间。

取值范围：

整数。

请求示例

查询快照失败的任务详情。

get https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/9f76c502-fc9c-4a52-8656-65d0da6e3d57/actions/SNAPSHOTTING_FAILED

响应示例

状态码：200

查询成功。

{
  "id" : "abb30649-4ab5-448f-a199-f764d2a4271d",
  "status" : "FAILED",
  "items" : [ {
    "item_name" : "创建快照",
    "sub_items" : [ {
      "status" : "FAILED",
      "detail" : "{\"progressInfo\":\"{\\\"actionEndTime\\\":\\\"2025-05-19 09:07:42\\\",\\\"failedStep\\\":\\\"INIT\\\",\\\"partialPassKeys\\\":\\\"N/A\\\",\\\"errorCode\\\":\\\"\\\",\\\"updateTime\\\":\\\"2025-05-19 09:07:43\\\",\\\"errorMsg\\\":\\\"host-172-16-13-211    SUCCESS          host-172-16-47-24     SUCCESS          host-172-16-19-132    SUCCESS          \\\",\\\"backupSize\\\":157661926,\\\"backupRate\\\":{\\\"compressRate\\\":\\\"0MB/s\\\",\\\"consumerRate\\\":\\\"0MB/s\\\",\\\"producerRate\\\":\\\"0MB/s\\\"},\\\"currentStep\\\":\\\"FINISH\\\",\\\"actionType\\\":\\\"Backup\\\",\\\"unrestoreKeys\\\":\\\"N/A\\\",\\\"progress\\\":\\\"100.00%\\\",\\\"actionStartTime\\\":\\\"2025-05-19 09:07:28\\\",\\\"priorKey\\\":\\\"N/A\\\",\\\"key\\\":\\\"20250519_090729\\\"}\"}",
      "sub_item_name" : "执行备份",
      "begin_time" : "2025-05-19 09:06:18.0",
      "end_time" : null,
      "estimated_time" : -1
    } ]
  } ],
  "action_name" : "SNAPSHOTTING_FAILED",
  "cluster_name" : "cluster_779",
  "submit_time" : "2025-05-19 09:05:10.0"
}

状态码

状态码

描述

200

查询成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

500

服务内部错误。

503

服务不可用。
父主题： 任务管理