消息队列 Kafka 的管控 API 提供获取实例、Topic 和 Consumer Group 信息的接口。

本文介绍消息队列 Kafka SDK 的获取、初始参数的设置、使用方法概述等。

获取 SDK

以 Java 应用为例,在配置文件中添加依赖的 SDK 信息:

        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-alikafka</artifactId>
            <version>1.0.5</version>
        </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-core</artifactId>
            <version>4.3.9</version>
        </dependency>
			

设置公共参数

构建并启动客户端时需要设置一系列参数信息,具体示例如下:

public static void main(String[] args) {
    //构建 Client
    IAcsClient iAcsClient = buildAcsClient();
 }
 private static IAcsClient buildAcsClient() {
        //鉴权使用的 AccessKeyId,由阿里云官网控制台获取
        String accessKey = "XXXXXX";
        //鉴权使用的 AccessKeySecret,由阿里云官网控制台获取
        String secretKey = "XXXXXX";

        //产品 Code,消息队列 Kafka 产品常量值为 “alikafka”
        String productName = "alikafka";

        //API 的网关所在地域,目前支持的有 cn-beijing 和 cn-hangzhou 等
        String regionId = "cn-beijing";
        //接入点名称同 regionId 一致
        String endPointName = "cn-beijing";
        //对应 endPoint 的域名
        String domain = "alikafka.cn-beijing.aliyuncs.com";

        try {
            DefaultProfile.addEndpoint(endPointName, regionId, productName, domain);
        } catch (ClientException e) {
            //log error
        }
        //构造 Client
        IClientProfile profile = DefaultProfile.getProfile(regionId, accessKey, secretKey);
        return new DefaultAcsClient(profile);
}

			

接入点列表

地域名称 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

接口概览

以下是消息队列 Kafka 目前支持的管控 API 的概览说明。

使用限制

单用户单接口的请求频率的限制为 3 QPS。更新和创建类接口的使用限制,请参见相应接口文档中的使用限制内容。