消息队列 MQTT 版 公网接入

接口请求域名: mqtt.tencentcloudapi.com 。为MQTT实例创建公网接入点,未开启公网的集群可调用。

相关产品
消息队列 MQTT 版 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。你可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateInsPublicEndpoint。
Version 是 String 公共参数,本接口取值:2024-05-16。
Region 是 String 公共参数,详见产品支持的 地域列表。
InstanceId 是 String 腾讯云MQTT实例ID,从 DescribeInstanceList接口或控制台获得。示例值:mqtt-xxxx
Bandwidth 是 Integer 带宽,单位Mbps示例值:2
Rules.N 否 Array of PublicAccessRule 公网访问规则

三、3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、示例1 示例

示例

五、输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateInsPublicEndpoint
<公共请求参数>
{
"InstanceId": "mqtt-rvb5xxrn",
"Bandwidth": 2,
"Rules": [
{
"IpRule": "1.1.1.1",
"Allow": true,
"Remark": "remark"
}
]
}

六、输出示例

{
"Error": null,
"RequestId": null,
"Response": {
"RequestId": "416510a6-f614-487d-bbca-e7fdbf72fc29"
}
}

七、腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便你从同一入口查询及使用腾讯云提供的所有 API 服务。

八、API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

九、SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

·Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十、命令行工具

·Tencent Cloud CLI 3.0

十一、6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。

赞 (0)
上一篇 4天前
下一篇 4天前