文档首页/分布式消息服务RocketMQ版/API参考 (巴黎区域)/API V2（推荐）/元数据迁移/查询实例下所有迁移任务或查询指定迁移任务信息
更新时间：2023-08-16 GMT+08:00
查看PDF
分享

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

功能介绍

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

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

实例ID。

表2 Query参数

参数

是否必选

参数类型

描述

id

否

String

任务ID

type

否

String

查询类型

offset

否

String

当前页，从1开始

limit

否

String

当前页大小

name

否

String

  • 查询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

元数据迁移任务状态。

type

String

元数据迁移类型。

请求示例

查询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

返回状态码

错误码

请参见错误码。

父主题：元数据迁移