消息队列 for Apache Kafka 的 API 支持基于 URL 发起 HTTP/HTTPS POST 请求。请求参数需要包含在 URL 中。本文列举了 POST 请求中的结构解释,并提供了消息队列 for Apache Kafka 的服务接入地址(Endpoint)。

结构示例

以下为 GetInstanceList 一条未编码的 URL 请求示例:

http://alikafka.cn-hangzhou.aliyuncs.com/?Action=GetInstanceList
&RegionId=cn-hangzhou
&<公共请求参数>
			
  • http 指定了请求通信协议。

  • alikafka.cn-hangzhou.aliyuncs.com 指定了消息队列 for Apache Kafka 的服务接入地址(Endpoint)。

  • Action=GetInstanceList 指定了要调用的 API。

  • <公共请求参数>是系统规定的公共参数。

通信协议

支持 HTTP 或 HTTPS协议请求通信。为了获得更高的安全性,推荐您使用 HTTPS 协议发送请求。

接入地址

地域名称 RegionId Domain
华东1(杭州) cn-hangzhou alikafka.cn-hangzhou.aliyuncs.com
华东2(上海) cn-shanghai alikafka.cn-shanghai.aliyuncs.com
华北1(青岛) cn-qingdao alikafka.cn-qingdao.aliyuncs.com
华北2(北京) cn-beijing alikafka.cn-beijing.aliyuncs.com
华北3(张家口) cn-zhangjiakou alikafka.cn-zhangjiakou.aliyuncs.com
华北5(呼和浩特) cn-huhehaote alikafka.cn-huhehaote.aliyuncs.com
华南1(深圳) cn-shenzhen alikafka.cn-shenzhen.aliyuncs.com
中国(香港) cn-hongkong alikafka.cn-hongkong.aliyuncs.com
新加坡 ap-southeast-1 alikafka.ap-southeast-1.aliyuncs.com

请求参数

您需要通过 Action 参数指定目标操作,例如 Action=GetInstanceList,还需要指定接口的其他参数以及公共参数Action 参数的可取值如下:

  • GetInstanceList:获取实例信息;
  • GetConsumerList:获取消费组列表;
  • GetTopicList:获取 Topic 列表;
  • GetTopicStatus:获取 Topic 状态;
  • GetConsumerProgress:获取消费状态;
  • CreateTopic:创建 Topic;
  • CreateConsumerGroup:创建消费组。

字符编码

请求及返回结果都使用 UTF-8 字符集编码。