更新时间:2025-12-23 GMT+08:00

查询Exchange列表

功能介绍

查询Exchange列表。

URI

GET /v2/rabbitmq/{project_id}/instances/{instance_id}/vhosts/{vhost}/exchanges

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

instance_id

String

实例ID

vhost

String

vhost名称,名称中包含/时,需要将/替换为__F_SLASH__,否则会调用失败。例如:Vhost名称为/test,入参值为__F_SLASH__test。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页查询偏移量,表示从此偏移量开始查询,offset大于等于0,默认从0开始查询。

limit

Integer

分页查询单页数量,取值范围0~50,默认查询10条。

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

size

Integer

当前显示数量

total

Integer

查询结果总数

items

Array of ExchangeDetails objects

Exchange信息列表

表4 ExchangeDetails

参数

参数类型

描述

durable

Boolean

是否持久化

default

Boolean

是否是默认Exchange

internal

Boolean

是否是内部Exchange

arguments

Object

参数列表

name

String

Exchange名称

auto_delete

Boolean

是否自动删除

type

String

参数解释

Exchange类型。

取值范围

  • direct:该类型Exchange会将消息路由到Routing Key完全匹配的Queue中。

  • fanout:该类型Exchange会将消息路由到所有与其绑定的Queue中。

  • topic:该类型Exchange将Routing Key进行通配符匹配,然后将消息路由到匹配成功的Queue中。

  • headers:该类型Exchange与Routing Key无关,而与消息中的Headers属性信息相关。Exchange根据消息中的Headers属性键值对和绑定的属性键值对进行匹配,根据匹配情况路由消息。

vhost

String

所属Vhost

请求示例

查询Exchange列表

GET /v2/rabbitmq/{project_id}/instances/{instance_id}/exchanges?offset=0&limit=10

响应示例

状态码:200

获取Exchange列表成功

{
  "total" : 1,
  "size" : 1,
  "items" : [ {
    "durable" : true,
    "vhost" : "default",
    "default" : false,
    "internal" : false,
    "name" : "Exchange-name",
    "auto_delete" : false,
    "type" : "x-delayed-message",
    "arguments" : {
      "x-delayed-type" : "header"
    }
  } ]
}

状态码

状态码

描述

200

获取Exchange列表成功

错误码

请参见错误码