全部产品
云市场

管控 API 示例代码和接入点列表

更新时间:2019-08-23 10:51:37

本文介绍消息队列 RocketMQ 的 API 的接入步骤以及注意事项,包含 SDK 的获取、初始化参数的设置以及接入点的设置。

管控 API 示例代码

1. SDK 获取

直接填写以下 pom.xml 的配置,依赖 API 的 SDK 即可。

  1. <dependencies>
  2. <dependency>
  3. <groupId>com.aliyun</groupId>
  4. <artifactId>aliyun-java-sdk-core</artifactId>
  5. <optional>true</optional>
  6. <version>4.3.3</version>
  7. </dependency>
  8. <dependency>
  9. <groupId>com.aliyun</groupId>
  10. <artifactId>aliyun-java-sdk-ons</artifactId>
  11. <version>3.1.0</version> <!-- 设置为最新版本号 -->
  12. </dependency>
  13. </dependencies>

说明:API 的 SDK 历史版本,请参见管控 API 版本说明

2. API 调用示例

使用 API 前需启动 API 的客户端,而启动客户端需设置 regionId、accessKey、secretKey 等参数,具体示例如下:

  1. /**
  2. *Open API 的接入点,设置为目标 Region
  3. */
  4. String regionId = "XXXXX";
  5. /**
  6. *鉴权使用的 AccessKeyId,由阿里云管理控制台获取
  7. */
  8. String accessKey = "XXXXXXXXXXXXXXXXX";
  9. /**
  10. *鉴权使用的 AccessKeySecret,由阿里云管理控制台获取
  11. */
  12. String secretKey = "XXXXXXXXXXXXXXXXX";
  13. IClientProfile profile= DefaultProfile.getProfile(regionIdaccessKeysecretKey);
  14. IAcsClient iAcsClient= new DefaultAcsClient(profile);
  15. //构造 Request 对象:这里以 TopicList 接口为例子,不同的 API 接口构造不同的 Request 对象
  16. OnsTopicListRequest request = new OnsTopicListRequest();
  17. request.setPreventCache(System.currentTimeMillis()); //当前时间戳
  18. OnsTopicListResponse response = iAcsClient.getAcsResponse(request);
  19. System.out.println(JSON.toJSONString(response));

参数说明

参数名称 描述
regionId API 的网关所在地域(Region)
accessKey 您在阿里云服务器管理控制台上获取的 AccessKeyId
secretKey 您在阿里云服务器管理控制台上获得的 AccessKeySecret
productName API 的产品名称,直接填写 Ons 即可
domain API 的接入点 domain,规则是 ons.${RegionId}.aliyuncs.com,该 domain 对应的地域必须和 regionId 对应的地域一致

地域和接入点列表

消息队列 RocketMQ 支持 API 的地域,以及对应的 regionId 和 domain 如下表所示:

地域名称 regionId domain
公网 mq-internet-access ons.mq-internet-access.aliyuncs.com
华东1(杭州) cn-hangzhou ons.cn-hangzhou.aliyuncs.com
华东2(上海) cn-shanghai ons.cn-shanghai.aliyuncs.com
华北1(青岛) cn-qingdao ons.cn-qingdao.aliyuncs.com
华北2(北京) cn-beijing ons.cn-beijing.aliyuncs.com
华北3(张家口) cn-zhangjiakou ons.cn-zhangjiakou.aliyuncs.com
华北5(呼和浩特) cn-huhehaote ons.cn-huhehaote.aliyuncs.com
华南1(深圳) cn-shenzhen ons.cn-shenzhen.aliyuncs.com
西南1(成都) cn-chengdu ons.cn-chengdu.aliyuncs.com
中国(香港) cn-hongkong ons.cn-hongkong.aliyuncs.com
新加坡(新加坡) ap-southeast-1 ons.ap-southeast-1.aliyuncs.com
澳大利亚(悉尼) ap-southeast-2 ons.ap-southeast-2.aliyuncs.com
马来西亚(吉隆坡) ap-southeast-3 ons.ap-southeast-3.aliyuncs.com
日本(东京) ap-northeast-1 ons.ap-northeast-1.aliyuncs.com
德国(法兰克福) eu-central-1 ons.eu-central-1.aliyuncs.com
英国(伦敦) eu-west-1 ons.eu-west-1.aliyuncs.com
美国(弗吉尼亚) us-east-1 ons.us-east-1.aliyuncs.com
美国(硅谷) us-west-1 ons.us-west-1.aliyuncs.com
印度(孟买) ap-south-1 ons.ap-south-1.aliyuncs.com
阿联酋(迪拜) me-east-1 ons.me-east-1.aliyuncs.com
华东1 金融云 cn-hangzhou-finance ons.cn-hangzhou-finance.aliyuncs.com
华南1 金融云 cn-shenzhen-finance-1 ons.cn-shenzhen-finance-1.aliyuncs.com
华东2 金融云 cn-shanghai-finance-1 ons.cn-shanghai-finance-1.aliyuncs.com
华北2 阿里政务云1 cn-north-2-gov-1 ons.cn-north-2-gov-1.aliyuncs.com