ListBindings - 查询绑定

更新时间:

查询指定云消息队列 RabbitMQ 版实例下某一Vhost内所有创建的绑定关系。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
amqp:GetInstancelist
*全部资源
*
  • amqp:ListQueue
  • amqp:ListExchange

请求参数

名称类型必填描述示例值
InstanceIdstring

云消息队列 RabbitMQ 版实例的 ID。

1880770869023***
VirtualHoststring

Vhost 名称。

Test
NextTokenstring

用来标记当前查询结束的位置,以便下一次调用时作为参数传入,继续翻页。首次调用和当返回最后一页时,取值为空字符串。

caeba0bbb2be03f84eb48b699f0a****
MaxResultsinteger

本次读取的最大数据记录数量。取值:

1~100

1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

E0A71208-3E87-4732-81CC-B18E0B4B1***
Dataobject

返回数据。

MaxResultsinteger

本次请求所返回的最大记录条数。

1
NextTokenstring

表示当前调用返回读取到的位置,空代表数据已经读取完毕。

caebacccb2be03f84eb48b699f0a****
Bindingsarray<object>

绑定关系列表。

BindingDOobject
SourceExchangestring

源 Exchange 名称。

test
Argumentstring

x-match 属性。取值:

  • all:默认值,所有消息头的键值对必须匹配。

  • any:至少一对消息头的键值对必须匹配。

该参数仅适用于 Headers 类型的 Exchange。

all
BindingKeystring

绑定键。

  • 绑定源 Exchange 为非 Topic 类型:

    • 只能包含字母、数字、短划线(-)、下划线(_)、半角句号(.)、正斜线(/)、at 符号(@)。

    • 长度限制 1~255 字符。

  • 绑定源 Exchange 为 Topic 类型:

    • 可以包含字母、数字、短划线(-)、下划线(_)、星号(*)、半角句号(.)、井号(#)、正斜线(/)、at 符号(@)。

    • 不能以半角句号(.)开头或结尾。对于井号(#)或星号(*),如果以其开头,则其后需有半角句号(.),如果以其结尾,则其前需有半角句号(.),如果既不是开头也不是结尾,则其前后均需有半角句号(.)。

    • 长度限制 1~255 字符。

amq.test
BindingTypestring

绑定目标对象的类型。取值:

  • QUEUE

  • EXCHANGE

QUEUE
DestinationNamestring

绑定目标名称。

QueueTest

示例

正常返回示例

JSON格式

{
  "RequestId": "E0A71208-3E87-4732-81CC-B18E0B4B1***",
  "Data": {
    "MaxResults": 1,
    "NextToken": "caebacccb2be03f84eb48b699f0a****",
    "Bindings": [
      {
        "SourceExchange": "test",
        "Argument": "all",
        "BindingKey": "amq.test",
        "BindingType": "QUEUE",
        "DestinationName": "QueueTest"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-08-26OpenAPI 描述信息更新查看变更详情