文档首页/ 分布式消息服务Kafka版/ API参考/ API V2（推荐）/ 后台任务管理/ 查询后台任务中的指定实例的变更进度 - ShowBackgroundTaskProgress
更新时间：2025-11-24 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

参数解释：

任务名称。

取值范围：

不涉及。

status

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" : 100,
  "remain_time" : 0,
  "step_list" : [ {
    "name" : "pre_check",
    "statue" : "COMPLETED",
    "start_time" : 1763350067752,
    "end_time" : 1763350111208
  }, {
    "name" : "disk_expansion",
    "statue" : "COMPLETED",
    "start_time" : 1763350111326,
    "end_time" : 1763350189383
  } ]
}

状态码

状态码

描述

200

查询后台任务中的指定实例的变更进度成功。

错误码

请参见错误码。

父主题： 后台任务管理

相关文档