API概览
更新时间：
复制 MD 格式
API标准及多语言预置SDK
本产品（amqp-open/2019-12-12）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
实例
|
API |
标题 |
API概述 |
| CreateInstance | 创建实例 | 创建云消息队列RabbitMQ的实例。 |
| GetInstance | 查询实例信息 | 获取云消息队列RabbitMQ的实例。 |
| UpdateInstance | 更新实例 | 更新云消息队列RabbitMQ的实例，升降配规格。 |
| UpdateInstanceName | 更新实例名称 | 云消息队列 RabbitMQ 版实例后，实例名称默认为实例ID，您可以自定义修改实例名称，方便区分实例。 |
| GetMetadataAmount | 获取实例的元数据 | 查看指定云消息队列 RabbitMQ 版实例下可创建的Vhost、Exchange、Queue的最大数量以及当前已创建的数量。 |
| ListInstances | 查询实例列表 | 查询指定地域下的云消息队列 RabbitMQ 版实例列表以及各实例的基本信息，包括实例接入点、实例规格上限等信息。 |
| AddInstanceWhiteList | 增加实例IP/VPCID白名单 | 增加实例白名单 |
| ListInstanceWhiteList | 查询实例IP/VPCID值 | 查询实例ip/vpc白名单 |
| RemoveInstanceWhiteList | 删除IP/VPCID白名单 | 删除实例ip/vpc白名单。 |
Vhost
|
API |
标题 |
API概述 |
| CreateVirtualHost | 创建Vhost | Vhost是指虚拟主机，用作逻辑隔离，分别管理各自的Exchange、Queue和Binding，使得应用安全地运行在不同的Vhost上，相互之间不会干扰。Producer和Consumer连接云消息队列 RabbitMQ 版需要指定一个Vhost。 |
| DeleteVirtualHost | 删除Vhost | 调用DeleteVirtualHost删除Vhost。 |
| ListVirtualHosts | 查询 Vhost | 查询指定云消息队列 RabbitMQ 版实例下所有的Vhost。 |
Queue
|
API |
标题 |
API概述 |
| CreateQueue | 创建Queue | Queue是指消息队列，云消息队列 RabbitMQ 版的消息都会被发送至指定的Exchange，再由Exchange路由至绑定的Queue中。 |
| DeleteQueue | 删除 Queue | 删除Queue。 |
| ListQueueConsumers | 查询Queue的消费者 | 查询指定Queue的在线Consumer客户端。 |
| ListQueues | 查询Queue | 查询指定云消息队列 RabbitMQ 版实例下某一Vhost内的所有Queue信息。 |
| ListQueueUpStreamBindings | 查询Queue被绑定 | 查询指定Queue被哪些Exchange绑定。 |
Exchange
|
API |
标题 |
API概述 |
| CreateExchange | 创建Exchange | Producer将消息发送到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中。 |
| DeleteBinding | 删除绑定 | 调用DeleteBinding解除源Exchange与目标Queue或者其他Exchange的绑定关系。 |
| ListBindings | 查询绑定 | 查询指定云消息队列 RabbitMQ 版实例下某一Vhost内所有创建的绑定关系。 |
静态用户名密码
|
API |
标题 |
API概述 |
| CreateAccount | 创建用户名密码 | 开源客户端访问云消息队列 RabbitMQ 版服务端时，需要传入用户名和密码进行权限认证，认证通过才允许访问服务端。云消息队列 RabbitMQ 版支持通过阿里云访问控制（RAM）的AccessKey和AccessKey Secret生成用户名和密码。 |
| DeleteAccount | 删除用户名密码 | 删除用户名密码。 |
| ListAccounts | 查看用户名密码 | 查看指定云消息队列 RabbitMQ 版实例的用户名密码。 |
其他
|
API |
标题 |
API概述 |
| CreateOpenSourceAccount | 创建开源用户名密码 | 创建开源用户名密码 |
| CreateOpenSourcePermission | 创建开源权限 | 创建开源权限 |
| DeleteOpenSourceAccount | 删除开源用户名密码 | 删除开源用户名密码 |
| DeleteOpenSourcePermission | 删除开源权限 | 删除开源权限 |
| ListOpenSourceAccounts | 枚举开源用户名密码 | 枚举开源用户名密码 |
| ListOpenSourcePermissions | 开源权限列表 | 罗列开源权限 |
| UpdateInstanceServerlessSwitch | 修改Serverless实例弹性开关 | 更新serverless开关 |
| UpdateOpenSourceAccount | 更新开源用户名密码 | 更新开源用户名密码 |
| UpdateOpenSourcePermission | 更新开源权限 | 更新开源权限 |
该文章对您有帮助吗？