本產(chǎn)品（
云消息隊列 RocketMQ 5.0 版/2022-08-01）的OpenAPI采用ROA簽名風(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)行自簽名對接。由于自簽名細(xì)節(jié)非常復(fù)雜，需花費 5個工作日左右。因此建議加入我們的服務(wù)釘釘群（78410016550），在專家指導(dǎo)下進(jìn)行簽名對接。在使用API前，您需要準(zhǔn)備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細(xì)節(jié)請參見獲取AccessKey。
實例
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateInstance | 創(chuàng)建實例 | 創(chuàng)建云消息隊列 RocketMQ 版5.x系列實例。 |
| UpdateInstance | 更新實例 | 更新云消息隊列 RocketMQ 版實例的基本信息和規(guī)格配置。 |
| DeleteInstance | 刪除實例 | 釋放實例 |
| ListInstances | 查詢實例列表 | 查詢指定地域下，所有的云消息隊列 RocketMQ 版實例的列表信息。 |
| GetInstance | 獲取指定實例的詳情 | 獲取某個指定實例的詳細(xì)信息。 |
主題
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateTopic | 創(chuàng)建主題 | 創(chuàng)建云消息隊列 RocketMQ 版的主題（Topic）。主題是云消息隊列 RocketMQ 版中消息傳輸和存儲的頂層容器，用于標(biāo)識同一類業(yè)務(wù)邏輯的消息。在消息收發(fā)模型中，生產(chǎn)者將消息發(fā)送至主題，消費者通過訂閱指定的主題來消費其中的消息。 |
| UpdateTopic | 更新主題 | 更新主題的備注信息。 |
| DeleteTopic | 刪除主題 | 刪除指定主題。 |
| ListTopics | 查詢主題列表 | 查詢指定實例下的主題列表信息。 |
| GetTopic | 獲取指定主題的詳情 | 獲取某個指定主題的詳細(xì)信息。 |
消費者分組
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateConsumerGroup | 創(chuàng)建消費者分組 | 創(chuàng)建云消息隊列 RocketMQ 版的消費者分組（ConsumerGroup）。消費者分組是云消息隊列 RocketMQ 版系統(tǒng)中承載多個消費行為一致的消費者的負(fù)載均衡分組。消費者需要通過指定消費者分組訂閱相關(guān)的主題來實現(xiàn)消息訂閱。 |
| UpdateConsumerGroup | 更新消費者分組 | 更新消費者分組的基礎(chǔ)信息和消費重試策略。 |
| DeleteConsumerGroup | 刪除消費者分組 | 刪除指定的消費者分組。 |
| ListConsumerGroups | 查詢消費者分組列表 | 查詢指定實例下消費者分組的列表信息。 |
| GetConsumerGroup | 獲取指定消費者分組詳情 | 獲取某個指定消費者分組的詳細(xì)信息。 |
訂閱關(guān)系
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTopicSubscriptions | 查詢主題訂閱關(guān)系列表 | 查詢主題訂閱關(guān)系列表。 |
| DeleteConsumerGroupSubscription | 刪除消費者組訂閱關(guān)系 | 刪除消費者組訂閱關(guān)系。 |
| ListConsumerGroupSubscriptions | 查詢消費者組訂閱關(guān)系列表 | 查詢消費組訂閱關(guān)系列表。 |
| GetConsumerGroupSubscription | 獲取消費者組訂閱關(guān)系詳情 | 獲取消費組訂閱關(guān)系詳情，包括客戶端分布等信息。 |
消費
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ResetConsumeOffset | 重置消費位點 | 重置指定消費者分組的消費位點。重置消費位點是指改變訂閱者當(dāng)前的消費位置。當(dāng)消費者出現(xiàn)故障或者消費錯誤數(shù)據(jù)時，您可通過重置消費位點將消費位置回滾到之前的某個位點重新開始消費，您也可以將消費位置移動至最新位點，暫時不處理堆積的消息。 |
| GetConsumerGroupLag | 查詢消費者組堆積信息 | 查詢消費者組堆積信息。 |
| GetConsumerStack | 獲取消費者堆棧信息 | 獲取消費者堆棧信息。 |
| ListConsumerConnections | 獲取消費者客戶端連接信息 | 獲取指定消費者客戶端的連接信息。 |
消息
| API | 標(biāo)題 | API概述 |
|---|---|---|
| VerifySendMessage | 消息發(fā)送驗證 | 驗證指定實例下指定主題的消息發(fā)送功能。 |
| VerifyConsumeMessage | 消息消費驗證 | 驗證指定實例下指定主題的消息消費狀態(tài)。 |
| ListMessages | 查詢消息列表 | 查詢消息列表。 |
| GetMessageDetail | 獲取消息詳情 | 獲取指定消息的詳情。 |
軌跡
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTraces | 查詢軌跡消息列表 | 查詢指定主題下的軌跡消息列表。 |
| GetTrace | 獲取消息軌跡 | 獲取指定主題下的指定消息軌跡。 |
ACL
| API | 標(biāo)題 | API概述 |
|---|---|---|
| CreateInstanceAccount | 創(chuàng)建訪問賬號 | 創(chuàng)建實例的訪問賬號。 |
| CreateInstanceAcl | 創(chuàng)建訪問權(quán)限 | 在指定實例下創(chuàng)建訪問的權(quán)限信息。 |
| DeleteInstanceAccount | 刪除訪問賬號 | 刪除指定實例下的訪問賬號信息。 |
| CreateInstanceIpWhitelist | 創(chuàng)建IP白名單 | 創(chuàng)建訪問控制IP白名單。 |
| DeleteInstanceAcl | 刪除訪問權(quán)限 | 刪除指定實例下，指定賬號和資源的權(quán)限。 |
| DeleteInstanceIpWhitelist | 刪除IP白名單 | 刪除指定實例下的指定全局IP白名單。 |
| UpdateInstanceAcl | 更新訪問權(quán)限 | 更新指定實例下，指定用戶和資源的訪問權(quán)限。 |
| UpdateInstanceAccount | 更新訪問賬號 | 更新指定實例下指定賬號的信息。 |
| ListInstanceIpWhitelist | 查詢IP白名單列表 | 查詢訪問控制IP白名單列表。 |
| ListInstanceAcl | 查詢訪問權(quán)限列表 | 查詢指定實例下的訪問權(quán)限列表。 |
| ListInstanceAccount | 查詢訪問賬號列表 | 查詢指定實例下訪問賬號的列表。 |
| GetInstanceAccount | 獲取實例賬號 | 獲取指定實例的賬號。 |
標(biāo)簽
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListTagResources | 查詢資源標(biāo)簽關(guān)系 | 查詢可見的資源標(biāo)簽關(guān)系。 |
| UntagResources | 刪除標(biāo)簽資源關(guān)系 | 用戶刪除標(biāo)簽資源關(guān)系。 |
| TagResources | 創(chuàng)建標(biāo)簽資源關(guān)系 | 用戶創(chuàng)建標(biāo)簽資源關(guān)系。 |
資源組
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ChangeResourceGroup | 修改資源組 | 修改實例所屬的資源組。 |
其他
| API | 標(biāo)題 | API概述 |
|---|---|---|
| ListRegions | 查詢地域列表 | 查詢地域列表。 |
| ListAvailableZones | 查詢支持的可用區(qū) | 查詢支持的可用區(qū)。 |