全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网 钉钉智能硬件
消息队列 MQ

接入指南

更新时间:2017-12-15 20:40:18

本文档介绍 MQ Open API 的接入步骤以及注意事项,包含 SDK 的获取,以及初始化参数的设置。

1. SDK 获取

直接填写以下 POM 的配置,依赖 Open API 的 SDK 即可。

<dependencies>
          <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-core</artifactId>
            <optional>true</optional>
            <version>3.2.8</version>
          </dependency>
        <dependency>
            <groupId>com.aliyun</groupId>
            <artifactId>aliyun-java-sdk-ons</artifactId>
            <version>2.0.0</version>
        </dependency>
</dependencies>

2. 公共参数设置

Open API 使用时需要启动 Open API 的客户端,而客户端启动时需要设置接入点和 AccessKey,SecretKey 等参数信息,具体示例如下:

    /**
    *Open API 的接入点,设置为目标 Region
    */
    String regionId = "XXXXX";
    /**
    *鉴权使用的 AccessKey,由阿里云官网控制台获取
    */
    String accessKey = "XXXXXXXXXXXXXXXXX";
    /**
    *鉴权使用的 SecretKey,由阿里云官网控制台获取
    */
    String secretKey = "XXXXXXXXXXXXXXXXX";
    /*
    *通过 Open API 访问的云产品名称,此处设置为 Ons 即可
    */
    String productName ="Ons";
    /**
    *对应 endPoint 接入点的接入点域名
    */
    String domain ="ons.XXXXX.aliyuncs.com";
    try {
        DefaultProfile.addEndpoint(regionId,regionId,productName,domain);
    } catch (ClientException e) {
        e.printStackTrace();
    }
    IClientProfile profile= DefaultProfile.getProfile(regionId,accessKey,secretKey);
    IAcsClient iAcsClient= new DefaultAcsClient(profile);

参数说明

  • regionId:指的是 API 的网关所在区域,目前支持的有 cn-beijing,cn-hangzhou,cn-qingdao,cn-shenzhen 等。
  • accessKey:指的是用户在阿里云服务器管理控制台上获取的 AK。
  • secretKey:指的是用户在阿里云服务器管理控制台上获得的 SK。
  • endPointName:接入点名称,同 RegionId 一致即可。
  • productName:Open API 的产品名称,直接写 Ons 即可。
  • domain:Open API 的接入点 Domain,规则是 ons.${RegionId}.aliyuncs.com,目前 MQ 支持 Open API 的 Region 请参考下表。
区域名称 RegionId Domain 备注
公共云华北2 cn-beijing ons.cn-beijing.aliyuncs.com 使用公共云华北2 Region 的用户建议此接入点
公网 cn-qingdao ons.cn-qingdao.aliyuncs.com 使用公网 Region 的用户建议此接入点
公共云华东1 cn-hangzhou ons.cn-hangzhou.aliyuncs.com 使用公共云华东1 Region 的用户建议此接入点
公共云华东2 cn-shanghai ons.cn-shanghai.aliyuncs.com 使用公共云华东2 Region 的用户建议此接入点
公共云华南1 cn-shenzhen ons.cn-shenzhen.aliyuncs.com 使用公共云华南1 Region 的用户建议此接入点
公共云新加坡 ap-southeast-1 ons.ap-southeast-1.aliyuncs.com 使用新加坡 Region 的用户建议此接入点
金融云华东1 cn-hangzhou-finance ons.cn-hangzhou-finance.aliyuncs.com 使用金融云华东1 Region 的用户建议此接入点
金融云华南1 cn-shenzhen-finance ons.cn-shenzhen-finance.aliyuncs.com 使用金融云华南1 Region 的用户建议此接入点
金融云华东2 cn-shanghai-finance ons.cn-shanghai-finance.aliyuncs.com 使用金融云华东2 Region 的用户建议此接入点
本文导读目录