本產(chǎn)品（
消息隊(duì)列 RabbitMQ 版/2019-12-12）的OpenAPI采用RPC簽名風(fēng)格，簽名細(xì)節(jié)參見簽名機(jī)制說明。我們已經(jīng)為開發(fā)者封裝了常見編程語言的SDK，開發(fā)者可通過下載SDK直接調(diào)用本產(chǎn)品OpenAPI而無需關(guān)心技術(shù)細(xì)節(jié)。如果現(xiàn)有SDK不能滿足使用需求，可通過簽名機(jī)制進(jìn)行自簽名對(duì)接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費(fèi) 5個(gè)工作日左右。因此建議加入我們的服務(wù)釘釘群（11370001915），在專家指導(dǎo)下進(jìn)行簽名對(duì)接。在使用API前，您需要準(zhǔn)備好身份賬號(hào)及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請(qǐng)參見獲取AccessKey。
實(shí)例
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateInstance | 創(chuàng)建實(shí)例 | 創(chuàng)建云消息隊(duì)列RabbitMQ的實(shí)例。 |
| UpdateInstanceName | 更新實(shí)例名稱 | 云消息隊(duì)列 RabbitMQ 版實(shí)例后，實(shí)例名稱默認(rèn)為實(shí)例ID，您可以自定義修改實(shí)例名稱，方便區(qū)分實(shí)例。 |
| GetMetadataAmount | 獲取實(shí)例的元數(shù)據(jù) | 查看指定云消息隊(duì)列 RabbitMQ 版實(shí)例下可創(chuàng)建的Vhost、Exchange、Queue的最大數(shù)量以及當(dāng)前已創(chuàng)建的數(shù)量。 |
| ListInstances | 查詢實(shí)例列表 | 查詢指定地域下的云消息隊(duì)列 RabbitMQ 版實(shí)例列表以及各實(shí)例的基本信息，包括實(shí)例接入點(diǎn)、實(shí)例規(guī)格上限等信息。 |
Vhost
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateVirtualHost | 創(chuàng)建Vhost | Vhost是指虛擬主機(jī)，用作邏輯隔離，分別管理各自的Exchange、Queue和Binding，使得應(yīng)用安全地運(yùn)行在不同的Vhost上，相互之間不會(huì)干擾。Producer和Consumer連接云消息隊(duì)列 RabbitMQ 版需要指定一個(gè)Vhost。 |
| DeleteVirtualHost | 刪除Vhost | 調(diào)用DeleteVirtualHost刪除Vhost。 |
| ListVirtualHosts | 查詢 Vhost | 查詢指定云消息隊(duì)列 RabbitMQ 版實(shí)例下所有的Vhost。 |
Queue
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateQueue | 創(chuàng)建Queue | Queue是指消息隊(duì)列，云消息隊(duì)列 RabbitMQ 版的消息都會(huì)被發(fā)送至指定的Exchange，再由Exchange路由至綁定的Queue中。 |
| DeleteQueue | 刪除 Queue | 刪除Queue。 |
| ListQueueConsumers | 查詢Queue的消費(fèi)者 | 查詢指定Queue的在線Consumer客戶端。 |
| ListQueues | 查詢Queue | 查詢指定云消息隊(duì)列 RabbitMQ 版實(shí)例下某一Vhost內(nèi)的所有Queue信息。 |
| ListQueueUpStreamBindings | 查詢Queue被綁定 | 查詢指定Queue被哪些Exchange綁定。 |
Exchange
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateExchange | 創(chuàng)建Exchange | Producer將消息發(fā)送到Exchange，由Exchange將消息路由到一個(gè)或多個(gè)Queue中（或者丟棄）。Exchange根據(jù)Routing Key和Binding Key將消息路由到Queue。 |
| DeleteExchange | 刪除Exchange | 調(diào)用DeleteExchange刪除Exchange。 |
| ListDownStreamBindings | 查詢Exchange綁定 | 查詢指定Exchange綁定了哪些Exchange或Queue。 |
| ListExchanges | 查詢Exchange | 查詢指定實(shí)例下某一Vhost內(nèi)創(chuàng)建的所有Exchange。 |
| ListExchangeUpStreamBindings | 查詢Exchange被綁定 | 查詢指定Exchange被哪些Queue或者其他Exchange綁定。 |
Binding
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateBinding | 創(chuàng)建綁定 | Producer將消息發(fā)送到Exchange，Exchange根據(jù)創(chuàng)建的綁定關(guān)系以及路由規(guī)則選擇將消息路由到指定的Queue或其他Exchange中。 |
| ListBindings | 查詢綁定 | 查詢指定云消息隊(duì)列 RabbitMQ 版實(shí)例下某一Vhost內(nèi)所有創(chuàng)建的綁定關(guān)系。 |
靜態(tài)用戶名密碼
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateAccount | 創(chuàng)建用戶名密碼 | 開源客戶端訪問云消息隊(duì)列 RabbitMQ 版服務(wù)端時(shí)，需要傳入用戶名和密碼進(jìn)行權(quán)限認(rèn)證，認(rèn)證通過才允許訪問服務(wù)端。云消息隊(duì)列 RabbitMQ 版支持通過阿里云訪問控制（RAM）的AccessKey和AccessKey Secret生成用戶名和密碼。 |
| DeleteAccount | 刪除用戶名密碼 | 刪除用戶名密碼。 |
| ListAccounts | 查看用戶名密碼 | 查看指定云消息隊(duì)列 RabbitMQ 版實(shí)例的用戶名密碼。 |