本產品（
消息隊列 RabbitMQ 版/2019-12-12）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
實例
| API | 標題 | API概述 |
|---|---|---|
| CreateInstance | 創建實例 | 創建云消息隊列RabbitMQ的實例。 |
| GetInstance | 查詢實例信息 | 獲取云消息隊列RabbitMQ的實例。 |
| UpdateInstance | 更新實例 | 更新云消息隊列RabbitMQ的實例，升降配規格。 |
| UpdateInstanceName | 更新實例名稱 | 云消息隊列 RabbitMQ 版實例后，實例名稱默認為實例ID，您可以自定義修改實例名稱，方便區分實例。 |
| GetMetadataAmount | 獲取實例的元數據 | 查看指定云消息隊列 RabbitMQ 版實例下可創建的Vhost、Exchange、Queue的最大數量以及當前已創建的數量。 |
| ListInstances | 查詢實例列表 | 查詢指定地域下的云消息隊列 RabbitMQ 版實例列表以及各實例的基本信息，包括實例接入點、實例規格上限等信息。 |
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 版實例的用戶名密碼。 |