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