API概览

本产品(云消息队列 Kafka 版/2019-09-16)的OpenAPI采用V3版本请求体&签名机制签名风格,签名细节参见V3版本请求体&签名机制。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见创建AccessKey

实例

API

标题

API概述

CreatePrePayOrder

创建预付费实例

预付费实例需要先付费才能使用资源,主要适用于长期稳定的业务运行场景。

StartInstance

部署实例

如需使用云消息队列 Kafka 版收发消息,需要购买并部署才可使用。

ModifyInstanceName

修改实例的名称

实例部署完成后,云消息队列 Kafka 版支持修改实例的名称。

GetInstanceList

查询指定地域的实例信息

查询指定地域的实例信息。

GetAllInstanceIdList

查询所有地域的实例ID

查询当前用户下所有实例ID集合。

UpgradePrePayOrder

升配预付费实例

升配预付费实例。

标签

API

标题

API概述

ListTagResources

查询资源绑定的标签列表

调用ListTagResources查询资源绑定的标签列表。

UntagResources

为资源解绑标签

调用UntagResources为资源解绑标签。

TagResources

为资源绑定标签

调用TagResources为资源绑定标签。

SASL用户

API

标题

API概述

CreateSaslUser

创建SASL用户

调用CreateSaslUser创建SASL用户。

DeleteSaslUser

删除SASL用户

调用DeleteSaslUser删除SASL用户。

DescribeSaslUsers

查询SASL用户

调用DescribeSaslUsers查询SASL用户。