文档

调用方式

更新时间:
一键部署

云消息队列 MQTT 版产品接口支持HTTP调用、SDK调用和OpenAPI开发者门户调用。

HTTP调用

云消息队列 MQTT 版的API是RPC风格,您可以通过发送HTTP GET请求调用云消息队列 MQTT 版的API。

其请求结构如下:

http://Endpoint/?Action=xx&Parameters

其中:

  • Endpoint云消息队列 MQTT 版的API的服务接入地址为onsmqtt.[regionId].aliyuncs.com[regionId]的详细信息,请参见服务地址

  • Action:要执行的操作,如调用ApplyToken来申请Token。

  • Version:要使用的API版本,云消息队列 MQTT 版的API版本是2020-04-20

  • Parameters:请求参数,每个参数之间用 “&” 分隔。

    请求参数由公共请求参数和API自定义参数组成。公共参数中包含API版本号、身份验证等信息,详细信息,请参见公共参数

SDK调用

阿里云云消息队列 MQTT 版提供多语言的SDK。阿里云SDK免去您手动签名的过程,方便使用。SDK详细信息,请参见获取OpenAPI的SDK

OpenAPI开发者门户调用

使用OpenAPI开发者门户的API调试功能,您可以通过网页或者命令行调用各云产品以及API市场上开放的API,查看每次的API请求和返回结果,并生成相应SDK调用示例。

您可以直接访问OpenAPI开发者门户调用API,也可以通过API文档中的调试功能进行调用。

服务地址

云消息队列 MQTT 版的API接入地址为onsmqtt.[regionId].aliyuncs.com。其中,[regionId]云消息队列 MQTT 版实例所在地域的ID。

云消息队列 MQTT 版支持的OpenAPI地域,以及对应的regionIddomain如下表所示。

地域名称

regionId

domain

公网

mq-internet-access

onsmqtt.mq-internet-access.aliyuncs.com

西南1(成都)

cn-chengdu

onsmqtt.cn-chengdu.aliyuncs.com

华东1(杭州)

cn-hangzhou

onsmqtt.cn-hangzhou.aliyuncs.com

华东2(上海)

cn-shanghai

onsmqtt.cn-shanghai.aliyuncs.com

华北1(青岛)

cn-qingdao

onsmqtt.cn-qingdao.aliyuncs.com

华北2(北京)

cn-beijing

onsmqtt.cn-beijing.aliyuncs.com

华北3(张家口)

cn-zhangjiakou

onsmqtt.cn-zhangjiakou.aliyuncs.com

华北5(呼和浩特)

cn-huhehaote

onsmqtt.cn-huhehaote.aliyuncs.com

华南1(深圳)

cn-shenzhen

onsmqtt.cn-shenzhen.aliyuncs.com

中国香港

cn-hongkong

onsmqtt.cn-hongkong.aliyuncs.com

印度(孟买)关停中

ap-south-1

onsmqtt.ap-south-1.aliyuncs.com

新加坡

ap-southeast-1

onsmqtt.ap-southeast-1.aliyuncs.com

澳大利亚(悉尼)

ap-southeast-2

onsmqtt.ap-southeast-2.aliyuncs.com

马来西亚(吉隆坡)

ap-southeast-3

onsmqtt.ap-southeast-3.aliyuncs.com

印度尼西亚(雅加达)

ap-southeast-5

onsmqtt.ap-southeast-5.aliyuncs.com

日本(东京)

ap-northeast-1

onsmqtt.ap-northeast-1.aliyuncs.com

德国(法兰克福)

eu-central-1

onsmqtt.eu-central-1.aliyuncs.com

美国(硅谷)

us-west-1

onsmqtt.us-west-1.aliyuncs.com

美国(弗吉尼亚)

us-east-1

onsmqtt.us-east-1.aliyuncs.com

华东1 金融云

cn-hangzhou-finance

onsmqtt.cn-hangzhou-finance.aliyuncs.com

华南1 金融云

cn-shenzhen-finance-1

onsmqtt.cn-shenzhen-finance-1.aliyuncs.com

华东2 金融云

cn-shanghai-finance-1

onsmqtt.cn-shanghai-finance-1.aliyuncs.com

华北2 阿里政务云1

cn-north-2-gov-1

onsmqtt.cn-north-2-gov-1.aliyuncs.com