文档首页/ 分布式消息服务RocketMQ版/ API参考(联盟区域)/ API V2(推荐)/ 元数据迁移/ 查询实例下所有迁移任务或查询指定迁移任务信息
更新时间:2026-04-03 GMT+08:00

查询实例下所有迁移任务或查询指定迁移任务信息

功能介绍

  1. 查询实例下所有迁移任务

  2. 查询指定迁移任务信息

URI

GET /v2/{project_id}/instances/{instance_id}/metadata

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目ID,获取方式请参见获取项目ID

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

instance_id

String

参数解释

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

id

String

参数解释

任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

type

String

参数解释

查询类型。

约束限制

不涉及。

取值范围

  • vhost:虚拟主机。

  • exchange:交换机。

  • queue:队列。

  • all:所有。

默认取值

不涉及。

offset

Integer

参数解释

当前页,从1开始。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

limit

Integer

参数解释

当前页大小。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

vhost名称

约束限制

  • 查询vhost列表时,该字段可为空。

  • 查询exchange列表时,该字段为exchange所属vhost名称。

  • 查询queue列表时,该字段为queue所属vhost-所属exchange,例vhost1-exchange1。

取值范围

不涉及。

默认取值

不涉及。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释

元数据迁移任务总数。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

task

Array of MetadataTask objects

参数解释

元数据迁移任务列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表4 MetadataTask

参数

参数类型

描述

id

String

参数解释

元数据迁移任务ID。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

元数据迁移任务名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

start_date

String

参数解释

元数据迁移任务开始时间。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

status

String

参数解释

元数据迁移任务状态。

约束限制

不涉及。

取值范围

  • creating:创建中。

  • starting:迁移中。

  • failed:迁移失败。

  • finished:迁移完成。

默认取值

不涉及。

type

String

参数解释

元数据迁移类型。

约束限制

不涉及。

取值范围

  • rocketmq:从rocketmq迁移到rocketmq。

  • rabbitToRocket:从rabbitmq迁移到rocketmq。

默认取值

不涉及。

请求示例

查询RocketMQ实例下所有迁移任务。

GET https://{endpoint}/v2/{project_id}/instances/{instance_id}/metadata

响应示例

状态码:200

返回状态码。

{
  "total" : 1,
  "task" : [ {
    "id" : "6cf4dcd3-8471-4139-8b5b-8a3a71f704c7",
    "name" : "task-932331847",
    "start_date" : "2023-03-13 19:43:32.12",
    "status" : "finished",
    "type" : "rabbitToRocket"
  } ]
}

状态码

状态码

描述

200

返回状态码。

错误码

请参见错误码