API標準及多語言預置SDK
本產品（RocketMQ/2022-08-01）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
實例
|
API |
標題 |
API概述 |
| CreateInstance | 建立執行個體 | 建立雲訊息佇列 RocketMQ 版5.x系列執行個體。 |
| ListInstances | 查詢執行個體列表 | 查詢指定地區下，所有的雲訊息佇列 RocketMQ 版執行個體的列表資訊。 |
| GetInstance | 擷取指定執行個體的詳情 | 擷取某個指定執行個體的詳細資料。 |
| ListInstances | 查詢執行個體列表 | 查詢指定地區下，所有的雲訊息佇列 RocketMQ 版執行個體的列表資訊。 |
| GetInstance | 擷取指定執行個體的詳情 | 擷取某個指定執行個體的詳細資料。 |
主題
|
API |
標題 |
API概述 |
| CreateTopic | 建立主題 | 建立雲訊息佇列 RocketMQ 版的主題（Topic）。主題是雲訊息佇列 RocketMQ 版中訊息傳輸和儲存的頂層容器，用於標識同一類商務邏輯的訊息。在訊息收發模型中，生產者將訊息發送至主題，消費者通過訂閱指定的主題來消費其中的訊息。 |
| UpdateTopic | 更新主題 | 更新主題的備忘資訊。 |
| ListTopics | 查詢主題列表 | 查詢指定執行個體下的主題列表資訊。 |
| GetTopic | 擷取指定主題的詳情 | 擷取某個指定主題的詳細資料。 |
| GetTopic | 擷取指定主題的詳情 | 擷取某個指定主題的詳細資料。 |
消費者分組
|
API |
標題 |
API概述 |
| CreateConsumerGroup | 建立消費者分組 | 建立雲訊息佇列 RocketMQ 版的消費者分組（ConsumerGroup）。消費者分組是雲訊息佇列 RocketMQ 版系統中承載多個消費行為一致的消費者的負載平衡分組。消費者需要通過指定消費者分組訂閱相關的主題來實現訊息訂閱。 |
| UpdateConsumerGroup | 更新消費者分組 | 更新消費者分組的基礎資訊和消費重試策略。 |
| ListConsumerGroups | 查詢消費者分組列表 | 查詢指定執行個體下消費者分組的列表資訊。 |
| GetConsumerGroup | 擷取指定消費者分組詳情 | 擷取某個指定消費者分組的詳細資料。 |
| GetConsumerGroup | 擷取指定消費者分組詳情 | 擷取某個指定消費者分組的詳細資料。 |
訂閱關係
|
API |
標題 |
API概述 |
| ListConsumerGroupSubscriptions | 查詢消費者組訂閱關係列表 | 查詢消費組訂閱關係列表。 |
| ListConsumerGroupSubscriptions | 查詢消費者組訂閱關係列表 | 查詢消費組訂閱關係列表。 |
| GetConsumerGroupSubscription | 擷取消費者組訂閱關係詳情 | 擷取消費組訂閱關係詳情，包括用戶端分布等資訊。 |
| DeleteConsumerGroupSubscription | 刪除消費者組訂閱關係 | 刪除消費者組訂閱關係。 |
消費
|
API |
標題 |
API概述 |
| ListConsumerConnections | 擷取消費者用戶端串連資訊 | 擷取指定消費者用戶端的串連資訊。 |
| GetConsumerGroupLag | 查詢消費者組堆積資訊 | 查詢消費者組堆積資訊。 |
| GetConsumerStack | 擷取消費者堆棧資訊 | 擷取消費者堆棧資訊。 |
| ResetConsumeOffset | 重設消費位點 | 重設指定消費者分組的消費位點。重設消費位點是指改變訂閱者當前的消費位置。當消費者出現故障或者消費錯誤資料時，您可通過重設消費位點將消費位置復原到之前的某個位點重新開始消費，您也可以將消費位置移動至最新位點，暫時不處理堆積的訊息。 |
消息
|
API |
標題 |
API概述 |
| ListMessages | 查詢訊息列表 | 查詢訊息列表。 |
| GetMessageDetail | 擷取訊息詳情 | 擷取指定訊息的詳情。 |
| VerifySendMessage | 訊息發送驗證 | 驗證指定執行個體下指定主題的訊息發送功能。 |
| VerifyConsumeMessage | 訊息消費驗證 | 驗證指定執行個體下指定主題的訊息消費狀態。 |
軌跡
|
API |
標題 |
API概述 |
| ListTraces | 查詢軌跡訊息列表 | 查詢指定主題下的軌跡訊息列表。 |
| GetTrace | 擷取訊息軌跡 | 擷取指定主題下的指定訊息軌跡。 |
ACL
|
API |
標題 |
API概述 |
| CreateInstanceAcl | 建立存取權限 | 在指定執行個體下建立訪問的許可權資訊。 |
| UpdateInstanceAcl | 更新存取權限 | 更新指定執行個體下，指定使用者和資源的存取權限。 |
| DeleteInstanceAccount | 刪除訪問帳號 | 刪除指定執行個體下的訪問帳號資訊。 |
| ListInstanceAccount | 查詢訪問帳號列表 | 查詢指定執行個體下訪問帳號的列表。 |
| GetInstanceAccount | 擷取執行個體帳號 | 擷取指定執行個體的帳號。 |
| CreateInstanceAcl | 建立存取權限 | 在指定執行個體下建立訪問的許可權資訊。 |
| UpdateInstanceAcl | 更新存取權限 | 更新指定執行個體下，指定使用者和資源的存取權限。 |
| DeleteInstanceAcl | 刪除存取權限 | 刪除指定執行個體下，指定帳號和資源的許可權。 |
| ListInstanceAcl | 查詢存取權限列表 | 查詢指定執行個體下的存取權限列表。 |
| GetInstanceAcl | 查詢存取權限詳情 | 查詢存取權限資訊詳情。 |
| CreateInstanceIpWhitelist | 建立IP白名單 | 建立存取控制IP白名單。 |
| DeleteInstanceIpWhitelist | 刪除IP白名單 | 刪除指定執行個體下的指定全域IP白名單。 |
| ListInstanceIpWhitelist | 查詢IP白名單列表 | 查詢存取控制IP白名單列表。 |
| GetInstanceIpWhitelist | GetInstanceIpWhitelist | Queries the information about the IP address whitelist of an instance. |
遷移上雲
|
API |
標題 |
API概述 |
| ListMigrations | 查詢遷移工作清單 | 查詢遷移工作清單。 |
| ListMigrationOperations | 查詢遷移巨集指令清單 | 查詢遷移巨集指令清單。 |
| ExecuteMigrationOperation | 執行遷移操作 | 指定的遷移任務執行指定的操作。 |
| FinishMigrationStage | 完成當前遷移階段 | 指定的遷移任務完成當前遷移階段。 |
Global Replicator
|
API |
標題 |
API概述 |
| CreateDisasterRecoveryPlan | 建立備份計劃 | 建立備份計劃。 |
| UpdateDisasterRecoveryPlan | 修改備份計劃 | 修改備份計劃。 |
| ListDisasterRecoveryPlans | 查詢備份計劃列表 | 查詢備份計劃列表。 |
| GetDisasterRecoveryPlan | 查詢備份計劃詳情 | 查詢備份計劃詳情。 |
| ListDisasterRecoveryItems | 查詢備份映射列表 | 查詢備份映射工作清單。 |
| AddDisasterRecoveryItem | 添加備份映射任務 | 添加備份映射任務 |
| UpdateDisasterRecoveryItem | 更新備份映射任務 | 更新備份映射任務。 |
| DeleteDisasterRecoveryItem | 刪除備份映射任務 | 刪除備份映射任務。 |
| StartDisasterRecoveryItem | 啟用備份映射任務 | 啟用備份映射任務。 |
| StopDisasterRecoveryItem | 停用備份映射任務 | 停用備份映射任務。 |
| ListDisasterRecoveryItems | 查詢備份映射列表 | 查詢備份映射工作清單。 |
| GetDisasterRecoveryItem | 查詢備份映射詳情 | 查詢備份計劃映射詳情。 |
| ListDisasterRecoveryCheckpoints | 查詢消費進度同步列表 | 查詢消費進度同步列表。 |
| SyncDisasterRecoveryCheckpoint | 同步消費進度資訊 | 同步消費進度資訊到目標執行個體。 |
標籤
|
API |
標題 |
API概述 |
| GetConsumeTimespan | 查詢Topic可重設時間範圍 | 查詢topic可重設時間範圍 |
| TagResources | 建立標籤資源關係 | 使用者建立標籤資源關係。 |
| UntagResources | 刪除標籤資源關係 | 使用者刪除標籤資源關係。 |
資源組
|
API |
標題 |
API概述 |
| AddDisasterRecoveryItem | 添加備份映射任務 | 添加備份映射任務 |
其他
|
API |
標題 |
API概述 |
| GetConsumeTimespan | 查詢Topic可重設時間範圍 | 查詢topic可重設時間範圍 |
| ListRegions | 查詢地區列表 | 查詢地區列表。 |
| ListAvailableZones | 查詢支援的可用性區域 | 查詢支援的可用性區域。 |
| ListMetricMeta | 查詢監控項列表 | 查詢監控項列表。 |