文档

API概览

更新时间:
一键部署
本产品(消息队列 RabbitMQ 版/2019-12-12)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题API概述
CreateInstance创建实例创建云消息队列RabbitMQ的实例。
UpdateInstanceName更新实例名称云消息队列 RabbitMQ 版实例后,实例名称默认为实例ID,您可以自定义修改实例名称,方便区分实例。
GetMetadataAmount获取实例的元数据查看指定云消息队列 RabbitMQ 版实例下可创建的Vhost、Exchange、Queue的最大数量以及当前已创建的数量。
ListInstances查询实例列表查询指定地域下的云消息队列 RabbitMQ 版实例列表以及各实例的基本信息,包括实例接入点、实例规格上限等信息。

Vhost

API标题API概述
CreateVirtualHost创建VhostVhost是指虚拟主机,用作逻辑隔离,分别管理各自的Exchange、Queue和Binding,使得应用安全地运行在不同的Vhost上,相互之间不会干扰。Producer和Consumer连接云消息队列 RabbitMQ 版需要指定一个Vhost。
DeleteVirtualHost删除Vhost调用DeleteVirtualHost删除Vhost。
ListVirtualHosts查询 Vhost查询指定云消息队列 RabbitMQ 版实例下所有的Vhost。

Queue

API标题API概述
CreateQueue创建QueueQueue是指消息队列,云消息队列 RabbitMQ 版的消息都会被发送至指定的Exchange,再由Exchange路由至绑定的Queue中。
DeleteQueue删除 Queue删除Queue。
ListQueueConsumers查询Queue的消费者查询指定Queue的在线Consumer客户端。
ListQueues查询Queue查询指定云消息队列 RabbitMQ 版实例下某一Vhost内的所有Queue信息。
ListQueueUpStreamBindings查询Queue被绑定查询指定Queue被哪些Exchange绑定。

Exchange

API标题API概述
CreateExchange创建ExchangeProducer将消息发送到Exchange,由Exchange将消息路由到一个或多个Queue中(或者丢弃)。Exchange根据Routing Key和Binding Key将消息路由到Queue。
DeleteExchange删除Exchange调用DeleteExchange删除Exchange。
ListDownStreamBindings查询Exchange绑定查询指定Exchange绑定了哪些Exchange或Queue。
ListExchanges查询Exchange查询指定实例下某一Vhost内创建的所有Exchange。
ListExchangeUpStreamBindings查询Exchange被绑定查询指定Exchange被哪些Queue或者其他Exchange绑定。

Binding

API标题API概述
CreateBinding创建绑定Producer将消息发送到Exchange,Exchange根据创建的绑定关系以及路由规则选择将消息路由到指定的Queue或其他Exchange中。
ListBindings查询绑定查询指定云消息队列 RabbitMQ 版实例下某一Vhost内所有创建的绑定关系。

静态用户名密码

API标题API概述
CreateAccount创建用户名密码开源客户端访问云消息队列 RabbitMQ 版服务端时,需要传入用户名和密码进行权限认证,认证通过才允许访问服务端。云消息队列 RabbitMQ 版支持通过阿里云访问控制(RAM)的AccessKey和AccessKey Secret生成用户名和密码。
DeleteAccount删除用户名密码删除用户名密码。
ListAccounts查看用户名密码查看指定云消息队列 RabbitMQ 版实例的用户名密码。