API標準及多語言預置SDK
本產品（Ons/2019-02-14）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
服務
|
API |
標題 |
API概述 |
| OpenOnsService | 開通服務 | 呼叫 OpenOnsService 開通雲端訊息佇列 RocketMQ 版服務。 |
訊息
|
API |
標題 |
API概述 |
| OnsMessageTrace | 查看訊息消費結果 | 調用OnsMessageTrace根據Message ID來判斷目標訊息是否曾被消費過。 |
| OnsMessageGetByMsgId | 通過MsgId查詢訊息 | 通過傳入 Message ID 查詢指定訊息的資訊以及判斷該指定的訊息是否曾被消費過。 |
| OnsMessageGetByKey | 根據Message Key查詢訊息 | 根據 Topic 和 Message Key 模糊查詢訊息資訊列表。 |
| OnsMessagePageQueryByTopic | 查詢Topic內所有訊息 | 分頁查詢指定時間段內指定Topic記憶體在的所有訊息。 |
| OnsMessageDetail | 查詢訊息詳細資料 | 調用OnsMessageDetail查詢某條訊息的具體資訊。 |
地域
|
API |
標題 |
API概述 |
| OnsRegionList | 擷取地區資訊列表 | 調用OnsRegionList擷取雲訊息佇列 RocketMQ 版目前開放服務的地區（Region）資訊列表。 |
執行個體
|
API |
標題 |
API概述 |
| OnsInstanceCreate | 建立執行個體 | 調用OnsInstanceCreate介面建立執行個體。 |
| OnsInstanceBaseInfo | 查詢執行個體基本資料和收發訊息的存取點 | 調用OnsInstanceBaseInfo介面查詢執行個體基本資料和收發訊息的存取點。 |
| OnsInstanceUpdate | 更新執行個體名稱和描述 | 調用OnsInstanceUpdate介面更新執行個體名稱和描述。 |
| OnsInstanceInServiceList | 查詢指定地區下執行個體列表 | 查詢當前帳號在指定地區（Region）下所有的雲訊息佇列 RocketMQ 版4.x執行個體資訊。 |
| OnsInstanceDelete | 刪除執行個體 | 調用OnsInstanceDelete介面刪除雲訊息佇列 RocketMQ 版執行個體。 |
Topic
|
API |
標題 |
API概述 |
| OnsTopicCreate | 建立Topic | 調用OnsTopicCreate介面建立Topic。 |
| OnsTopicStatus | 查詢Topic狀態 | 查詢當前Topic下的訊息總量以及Topic的狀態。 |
| OnsTopicList | 擷取Topic列表資訊 | 查詢帳號下所有Topic的資訊列表。 |
| OnsTopicSubDetail | 查看Topic的訂閱資訊 | 查看有哪些線上訂閱組訂閱了這個Topic。 |
| OnsTopicDelete | 刪除Topic | 調用OnsTopicDelete介面刪除指定的Topic。 |
Group
|
API |
標題 |
API概述 |
| OnsGroupCreate | 建立用戶端Group ID | 調用OnsGroupCreate建立用戶端Group ID。 |
| OnsGroupConsumerUpdate | 配置消費叢集的訊息讀取許可權 | 配置指定Group ID對應的消費叢集的訊息讀取許可權。本介面一般用于禁止特定Group ID讀取訊息的情境。 |
| OnsGroupList | 擷取Group ID列表資訊 | 查詢指定執行個體下所有的Group ID資訊。 |
| OnsGroupSubDetail | 查看Group ID的訂閱資訊 | 查看Group訂閱了哪些Topic，如果Group ID對應的消費者執行個體不線上則查不到資料。 |
| OnsGroupDelete | 刪除Group | 調用OnsGroupDelete刪除Group。 |
標籤
|
API |
標題 |
API概述 |
| OnsConsumerStatus | 查詢Group ID消費狀態 | 查詢指定Group ID詳細狀態資料：訂閱關係檢查、消費TPS統計、負載平衡狀態、消費端串連。 |
| OnsConsumerAccumulate | 查詢訊息消費堆積情況 | 查詢指定Group ID的訊息消費堆積情況，包括當前訊息堆積數量和消費延遲時間等。 |
| OnsConsumerGetConnection | 查詢Group ID用戶端串連情況 | 查詢指定 Group ID 下當前用戶端的串連情況。 |
| OnsConsumerResetOffset | 重設Group ID消費位點 | 重設指定的Group ID的消費位點到指定時間戳記。 |
| OnsConsumerTimeSpan | 查詢Topic可重設時間範圍 | 查詢Topic可重設的時間範圍，即該Topic中儲存的最早的和最晚的訊息的生產時間。 |
| OnsMessagePush | 向指定的消費者推送訊息 | 調用OnsMessagePush向指定的消費者推送訊息。 |
消費
|
API |
標題 |
API概述 |
| OnsTrendTopicInputTps | 統計訊息生產資料 | 查詢一段時間內指定的Topic的訊息寫入報表資料。 |
| OnsTrendGroupOutputTps | 統計訊息消費資料 | 查詢指定的Group ID在一段時間內消費訊息的統計資訊。 |
訊息收發資料統計
|
API |
標題 |
API概述 |
| OnsTraceQueryByMsgId | 根據MsgId建立軌跡查詢任務 | 通過傳入Topic名稱和Message ID建立軌跡查詢任務，得到該查詢任務的ID。您需要再調用OnsTraceGetResult介面，傳入返回的查詢任務ID，擷取訊息軌跡的詳細結果。 |
| OnsTraceQueryByMsgKey | 根據Message Key建立軌跡查詢任務 | 通過傳入Topic名稱和Message Key建立軌跡查詢任務，得到該查詢任務的ID。您需要再調用OnsTraceGetResult介面，傳入返回的查詢任務ID，擷取訊息軌跡的詳細結果。 |
| OnsTraceGetResult | 擷取軌跡查詢結果 | 通過傳入軌跡查詢任務的ID擷取之前的軌跡查詢結果。 |
軌跡
|
API |
標題 |
API概述 |
| OnsDLQMessagePageQueryByGroupId | 查詢Group ID內所有死信訊息 | 通過傳入Group ID和時間段，分頁查詢指定時間段內該Group ID記憶體在的所有死信訊息。 |
| OnsDLQMessageGetById | 根據Message ID查詢死信訊息 | 通過傳入Message ID查詢指定的死信訊息。包括儲存時間、訊息體、Key和Tag。 |
| OnsDLQMessageResendById | 重髮指定的死信訊息 | 重髮指定Message ID的死信訊息，使該訊息能夠被Consumer再次消費。 |
死信
|
API |
標題 |
API概述 |
其他
|
API |
標題 |
API概述 |
| ListTagResources | 查詢資源綁定的標籤列表 | 調用ListTagResources查詢資源綁定的標籤列表。 |
| TagResources | 為資源綁定標籤 | 調用TagResources為資源綁定標籤。 |
| UntagResources | 為資源解除綁定並刪除標籤 | 調用UntagResources為資源解除綁定並刪除標籤。 |