文档首页/分布式消息服务RocketMQ版/API参考/API V2（推荐）/后台任务管理/查询实例变更记录的进度 - ShowBackgroundTaskProgress
更新时间：2026-02-06 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询实例变更记录的进度 - ShowBackgroundTaskProgress

功能介绍

查询后台任务管理中的指定实例变更记录的进度。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目ID，获取方式请参见获取项目ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

instance_id

是

String

参数解释：

实例ID。获取方法如下：调用“查询所有实例列表”接口，从响应体中获取实例ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

task_id

是

String

参数解释：

任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

progress_percentage

Integer

参数解释：

后台任务处理进度。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

remain_time

Integer

参数解释：

剩余时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

step_list

Array of StepDetail objects

参数解释：

步骤列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表3 StepDetail

参数

参数类型

描述

name

String

参数解释：

任务名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

statue

String

参数解释：

任务状态。

约束限制：

不涉及。

取值范围：

  • COMPLETED：任务已完成。

  • IN_PROGRESS：任务正在进行。

  • FAILED：任务失败。

  • WAITING：等待开始。

默认取值：

不涉及。

start_time

String

参数解释：

开始时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_time

String

参数解释：

结束时间。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求示例

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/tasks/{task_id}/progress

响应示例

状态码：200

修改定时任务成功

{
  "progress_percentage" : 40,
  "remain_time" : 1124,
  "step_list" : [ {
    "name" : "pre_check",
    "statue" : "COMPLETED",
    "start_time" : 1765307538503,
    "end_time" : 1765307543133
  }, {
    "name" : "rolling_scaling",
    "statue" : "IN_PROGRESS",
    "start_time" : 1765307543286,
    "end_time" : null
  }, {
    "name" : "resume_operation",
    "statue" : "WAITING",
    "start_time" : null,
    "end_time" : null
  } ]
}

状态码

状态码

描述

200

修改定时任务成功

错误码

请参见错误码。

父主题： 后台任务管理