本產品（
云消息隊列 Kafka 版/2019-09-16）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
實例
| API | 標題 | API概述 |
|---|---|---|
| CreatePostPayOrder | 創建后付費實例 | 后付費實例根據所購資源規格的實際使用量計費，先使用，后計費。主要適用于測試或者流量峰值不確定的短期場景。本文介紹如何調用CreatePostPayOrder創建后付費實例。 |
| CreatePrePayOrder | 創建預付費實例 | 預付費實例需要先付費才能使用資源，主要適用于長期穩定的業務運行場景。本文介紹調用CreatePrePayOrder創建預付費實例。 |
| DeleteInstance | 刪除實例 | 當預付費實例或后付費實例被釋放后可刪除實例，本文介紹如何調用DeleteInstance刪除實例。 |
| StartInstance | 部署實例 | 如需使用云消息隊列 Kafka 版收發消息，需要購買并部署才可使用，本文介紹如何調用StartInstance部署實例。 |
| ModifyInstanceName | 修改實例的名稱 | 實例部署完成后，云消息隊列 Kafka 版支持修改實例的名稱。本文介紹如何調用ModifyInstanceName修改實例的名稱。 |
| EnableAutoGroupCreation | 開啟自由使用 Group | 本文介紹如何調用EnableAutoGroupCreation開啟和關閉自由使用Group。 |
| EnableAutoTopicCreation | 開啟自動創建 Topic | 本文介紹如何調用 EnableAutoTopicCreation 開啟和關閉自動創建Topic，以及修改自動創建 Topic 默認分區數。 |
| UpdateAllowedIp | 變更IP白名單 | 您可以編輯訪問云消息隊列 Kafka 版的白名單，配置在白名單中的IP地址與端口才允許訪問云消息隊列 Kafka 版實例，本文介紹如何調用UpdateAllowedIp變更IP白名單。 |
| UpdateInstanceConfig | 修改實例的配置 | 實例部署后，允許修改實例是否開啟ACL、SSL、消息保留時長及最大消息大小，本文介紹如何調用UpdateInstanceConfig修改實例配置。 |
| ChangeResourceGroup | 更改實例所在的資源組 | 進行資源轉組。 |
| GetInstanceList | 查詢指定地域的實例信息 | 查詢指定地域的實例信息。 |
| GetAllowedIpList | 獲取IP白名單 | 獲取IP白名單。 |
| GetAllInstanceIdList | 查詢所有地域的實例ID | 查詢當前用戶下所有實例ID集合。 |
| UpgradePostPayOrder | 升配后付費實例 | 升配后付費實例。 |
| UpgradePrePayOrder | 升配預付費實例 | 升配預付費實例。 |
| ConvertPostPayOrder | 將后付費實例轉為預付費實例 | 將后付費實例轉為預付費實例。 |
| UpgradeInstanceVersion | 升級實例版本 | 升級實例版本。 |
| ReleaseInstance | 釋放后付費實例 | 釋放后付費實例。 |
| StopInstance | 停機實例 | 調用StopInstance以停機實例。 |
| ReopenInstance | 啟用實例 | 啟用實例。 |
| CreateScheduledScalingRule | 創建彈性定時策略 | Serverless 系列實例部署后，允許通過該接口創建實例彈性定時策略配置。 |
| DeleteScheduledScalingRule | 刪除彈性定時策略 | Serverless 系列實例部署后，允許通過該接口刪除實例彈性定時策略配置。 |
| ModifyScheduledScalingRule | 修改彈性定時策略 | Serverless 系列實例部署后，允許通過該接口修改實例彈性定時策略。 |
| GetAutoScalingConfiguration | 查詢彈性定時策略配置 | Serverless 系列實例部署后，允許通過該接口查詢實例彈性定時策略配置。 |
| GetKafkaClientIp | 查詢 Kafka 客戶端IP | 獲取kafka客戶端ip |
Topic
| API | 標題 | API概述 |
|---|---|---|
| GetTopicSubscribeStatus | 獲取訂閱 Topic 的 Group 信息 | 獲取訂閱 Topic 的 Group 信息。 |
| CreateTopic | 創建Topic | 創建Topic。 |
| DeleteTopic | 刪除Topic | 刪除Topic。 |
| ModifyPartitionNum | 修改Topic的分區數 | 修改Topic的分區數。 |
| ModifyTopicRemark | 修改Topic的備注 | 修改Topic的備注。 |
| UpdateTopicConfig | 修改Topic配置 | Topic創建后，允許修改Topic的消息保留時長以及最大消息大小，本文介紹如何調用接口來修改Topic的配置。 |
| GetTopicList | 獲取Topic信息 | 獲取Topic信息。 |
| GetTopicStatus | 獲取消息收發狀態 | 獲取Topic的消息收發狀態。 |
| GetQuotaTip | 獲取Topic和分區的使用配額 | 獲取Topic和分區的使用配額。 |
| QueryMessage | 查詢 Topic 消息 | 查詢 Topic 中存儲的消息，可通過消息創建時間或者位點來進行查詢。 |
消費組
| API | 標題 | API概述 |
|---|---|---|
| CreateConsumerGroup | 創建消費組 | 調用CreateConsumerGroup創建Group。 |
| DeleteConsumerGroup | 刪除消費組 | 調用DeleteConsumerGroup刪除Group。 |
| UpdateConsumerOffset | 重置消費者組的消費位點 | 通過 UpdateConsumerOffset 重置消費者組的消費位點。 |
| GetConsumerList | 獲取Consumer Group信息 | 調用GetConsumerList獲取Group信息。 |
| GetConsumerProgress | 查詢消費組消費狀態 | 查詢Consumer Group的消費狀態。 |
標簽
| API | 標題 | API概述 |
|---|---|---|
| ListTagResources | 查詢資源綁定的標簽列表 | 調用ListTagResources查詢資源綁定的標簽列表。 |
| UntagResources | 為資源解綁標簽 | 調用UntagResources為資源解綁標簽。 |
| TagResources | 為資源綁定標簽 | 調用TagResources為資源綁定標簽。 |
SASL用戶
| API | 標題 | API概述 |
|---|---|---|
| CreateSaslUser | 創建SASL用戶 | 調用CreateSaslUser創建SASL用戶。 |
| DeleteSaslUser | 刪除SASL用戶 | 調用DeleteSaslUser刪除SASL用戶。 |
| DescribeSaslUsers | 查詢SASL用戶 | 調用DescribeSaslUsers查詢SASL用戶。 |
訪問控制
| API | 標題 | API概述 |
|---|---|---|
| CreateAcl | 創建ACL | 調用CreateAcl創建ACL。 |
| DeleteAcl | 刪除ACL | 調用DeleteAcl刪除ACL。 |
| DescribeAcls | 查詢ACL | 調用DescribeAcls查詢ACL。 |