消息队列 MQTT 版查询MQTT实例公网接入点

1. 接口描述

接口请求域名： mqtt.tencentcloudapi.com 。

查询MQTT实例公网接入点

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInsPublicEndpoints。
Version	是	String	公共参数，本接口取值：2024-05-16。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	实例ID 示例值：mqtt-xxxx

3. 输出参数

参数名称	类型	描述
Endpoints	Array of MQTTEndpointItem	接入点示例值：[ { "Type": "mqtt-tcp", "Url": "mqtt-abc1234-gz.mqtt.public.tencenttdmq.com:1883", "VpcId": null, "SubnetId": null, "Host": "mqtt-abc1234-gz.mqtt.public.tencenttdmq.com", "Port": 1883 }, { "Type": "mqtt-ws", "Url": "mqtt-abc1234-gz.mqtt.public.tencenttdmq.com:8888", "VpcId": null, "SubnetId": null, "Host": "mqtt-abc1234-gz.mqtt.public.tencenttdmq.com", "Port": 8888 } ]
InstanceId	String	实例id 示例值：mqtt-xxxx
Bandwidth	Integer	带宽示例值：2
Rules	Array of PublicAccessRule	公网访问规则示例值：[ { "IpRule": "127.0.0.1", "Allow": true, "Remark": null } ]
Status	String	公网状态： NORMAL-正常 CLOSING-关闭中 MODIFYING-修改中 CREATING-开启中 CLOSE-关闭示例值：NORMAL
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

POST / HTTP/1.1
Host: mqtt.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMQTTInsPublicEndpoints
<公共请求参数>

{
    "InstanceId": "mqtt-gn8qoq3z"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Bandwidth": 2,
        "Endpoints": [
            {
                "Host": "mqtt-gn8qoq3z-cd.mqtt.public.tencenttdmq.com",
                "Port": 8888,
                "SubnetId": null,
                "Type": "mqtt-ws",
                "Url": "mqtt-gn8qoq3z-cd.mqtt.public.tencenttdmq.com:8888",
                "VpcId": null
            },
            {
                "Host": "mqtt-gn8qoq3z-cd.mqtt.public.tencenttdmq.com",
                "Port": 1883,
                "SubnetId": null,
                "Type": "mqtt-tcp",
                "Url": "mqtt-gn8qoq3z-cd.mqtt.public.tencenttdmq.com:1883",
                "VpcId": null
            },
            {
                "Host": "mqtt-gn8qoq3z-cd.mqtt.public.tencenttdmq.com",
                "Port": 8883,
                "SubnetId": null,
                "Type": "mqtt-tls",
                "Url": "mqtt-gn8qoq3z-cd.mqtt.public.tencenttdmq.com:8883",
                "VpcId": null
            }
        ],
        "InstanceId": "mqtt-gn8qoq3z",
        "RequestId": "3891d712-94f7-4d03-9420-fae4fa3a61ea",
        "Rules": [
            {
                "Allow": true,
                "IpRule": "0.0.0.0/0",
                "Remark": ""
            }
        ],
        "Status": "NORMAL"
    }
}

5. 开发者资源

腾讯云 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: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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