API 概覽

API標準及多語言預置SDK

本產品（alikafka/2019-09-16）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。

在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。

自訂簽名情境

若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。

帳號與安全準備

阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。

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概述
UpdateConsumerOffset	重置消費者組的消費位點	透過 UpdateConsumerOffset 重置消費者組的消費位點。
GetConsumerList	擷取Consumer Group資訊	調用GetConsumerList擷取Group資訊。
GetConsumerProgress	查詢消費組消費狀態	查詢Consumer Group的消費狀態。
ListRebalanceInfo	擷取 Rebalance 詳情	擷取Rebalance詳情

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。
DescribeAclResourceName	查詢ACL資源名	查詢acl資源名。

其他

API	標題	API概述
ChangeResourceGroup	更改實例所在的資源組	進行資源轉組。
ConvertPostPayOrder	將後付費執行個體轉為預付費執行個體	將後付費執行個體轉為預付費執行個體。
CreateConsumerGroup	創建消費組	調用CreateConsumerGroup創建Group。
CreatePostPayInstance	建立後付費執行個體	建立後付費執行個體並返回執行個體ID和訂單ID。
CreatePostPayOrder	建立後付費執行個體	後付費執行個體根據所購資源規格的實際使用量計費，先使用，後計費。主要適用於測試或者流量峰值不確定的短期情境。本文介紹如何調用CreatePostPayOrder建立後付費執行個體。
CreatePrePayInstance	建立預付費執行個體	建立預付費執行個體並返回執行個體ID和訂單ID。
CreatePrePayOrder	建立預付費執行個體	預付費執行個體需要先付費才能使用資源，主要適用於長期穩定的業務運行場景。本文介紹呼叫CreatePrePayOrder建立預付費執行個體。
CreateScheduledScalingRule	建立彈性定時策略	Serverless 系列例項部署後，允許透過該介面建立例項彈性定時策略配置。
DeleteConsumerGroup	刪除消費組	調用DeleteConsumerGroup刪除Group。
DeleteInstance	刪除實例	當預付費實例或後付費實例被釋放後可刪除實例，本文介紹如何調用DeleteInstance刪除實例。
DeleteScheduledScalingRule	刪除彈性定時策略	Serverless 系列執行個體部署後，允許透過該介面刪除執行個體彈性定時策略配置。
EnableAutoGroupCreation	開啟自由使用 Group	本文介紹如何調用EnableAutoGroupCreation開啟和關閉自由使用Group。
EnableAutoTopicCreation	開啟自動建立 Topic	本文介紹如何呼叫 EnableAutoTopicCreation 開啟和關閉自動建立Topic，以及修改自動建立 Topic 預設分區數。
GetAllInstanceIdList	查詢所有地區的執行個體ID	查詢目前使用者下所有執行個體ID集合。
GetAllowedIpList	獲取IP白名單	獲取IP白名單。
GetAutoScalingConfiguration	查詢彈性定時策略配置	Serverless 系列例項部署後，允許透過該介面查詢例項彈性定時策略配置。
GetInstanceList	查詢指定地區的執行個體資訊	查詢指定地區的執行個體資訊。
GetKafkaClientIp	查詢 Kafka 客戶端IP	獲取kafka客戶端ip。
GetRiskList	查詢執行個體風險	查詢執行個體風險列表。
ListTagResources	查詢資源繫結的標籤列表	呼叫ListTagResources查詢資源繫結的標籤列表。
ModifyInstanceName	修改實例的名稱	實例部署完成後，雲消息隊列 Kafka 版支援修改實例的名稱。本文介紹如何呼叫ModifyInstanceName修改實例的名稱。
ModifyScheduledScalingRule	修改彈性定時策略	Serverless 系列實例部署後，允許通過該接口修改實例彈性定時策略。
ReleaseInstance	釋放後付費執行個體	釋放後付費執行個體。
ReopenInstance	啟用實例	啟用實例。
StartInstance	部署執行個體	如需使用雲訊息佇列 Kafka 版收發訊息，需要購買並部署才可使用，本文介紹如何調用StartInstance部署執行個體。
StopInstance	停機實例	調用StopInstance以停機實例。
TagResources	為資源綁定標籤	調用TagResources為資源綁定標籤。
UntagResources	為資源解除繫結標籤	呼叫 UntagResources 為資源解除繫結標籤。
UpdateAllowedIp	變更IP白名單	您可以編輯訪問雲消息隊列 Kafka 版的白名單，配置在白名單中的IP位址與埠才允許訪問雲消息隊列 Kafka 版實例，本文介紹如何調用UpdateAllowedIp變更IP白名單。
UpdateInstanceConfig	修改例項的配置	例項部署後，允許修改例項是否開啟ACL、SSL、訊息保留時長及最大訊息大小，本文介紹如何呼叫UpdateInstanceConfig修改例項配置。
UpgradeInstanceVersion	升級執行個體版本	升級執行個體版本。
UpgradePostPayOrder	升配後付費執行個體	升配後付費執行個體。
UpgradePrePayOrder	升配預付費執行個體	升配預付費執行個體。