消息队列 MQTT 版获取MQTT实例列表

1. 接口描述

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

获取实例列表，Filters参数使用说明如下：

InstanceName, 名称模糊查询
InstanceId，实例ID查询
InstanceStatus，实例状态查询，支持多选

当使用TagFilters查询时，Filters参数失效。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceList。
Version	是	String	公共参数，本接口取值：2024-05-16。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	查询条件列表,支持以下字段 InstanceName：集群名模糊搜索 InstanceId：集群id精确搜索 InstanceStatus：集群状态搜索（RUNNING-运行中，CREATING-创建中，MODIFYING-变配中，DELETING-删除中）注意：配置TagFilters时该查询条件不生效。示例值：[{"Name":"InstanceName","Values":["instance1"]}]
Offset	否	Integer	查询起始位置，默认0 示例值：0
Limit	否	Integer	查询结果限制数量，默认20，最大100 示例值：10
TagFilters.N	否	Array of TagFilter	标签过滤器示例值：[{"TagKey":"tag1-key","TagValue":["tag1-value"]}]

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	查询总数示例值：10
Data	Array of MQTTInstanceItem	实例列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

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

{
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "RequestId": null,
    "Response": {
        "RequestId": "33a9cba9-f885-47aa-8235-8bdcbd9c90bf",
        "TotalCount": 2,
        "Data": [
            {
                "InstanceId": "mqtt-zxjwkr98",
                "InstanceName": "mqtt-instance",
                "Version": "1",
                "InstanceType": "PRO",
                "InstanceStatus": "RUNNING",
                "PayMode": "POSTPAID",
                "ExpiryTime": 0,
                "Remark": "",
                "TopicNum": 1,
                "SkuCode": "pro_6k_1",
                "TpsLimit": 6000,
                "CreateTime": 1741832627,
                "MaxSubscriptionPerClient": 30,
                "MaxSubscription": 180000,
                "AuthorizationPolicyLimit": 20,
                "ClientNumLimit": 6000,
                "MaxCaNum": 20,
                "RenewFlag": 1,
                "DestroyTime": 0,
                "TopicNumLimit": 300
            },
            {
                "InstanceId": "mqtt-w45zn79z",
                "InstanceName": "mqtt-1226",
                "Version": "1",
                "InstanceType": "PRO",
                "InstanceStatus": "RUNNING",
                "PayMode": "PREPAID",
                "ExpiryTime": 1742972038844,
                "Remark": "",
                "TopicNum": 2,
                "SkuCode": "pro_10k_1",
                "TpsLimit": 10000,
                "CreateTime": 1735196039,
                "MaxSubscriptionPerClient": 30,
                "MaxSubscription": 300000,
                "AuthorizationPolicyLimit": 20,
                "ClientNumLimit": 10000,
                "MaxCaNum": 20,
                "RenewFlag": 1,
                "DestroyTime": 0,
                "TopicNumLimit": 300
            }
        ]
    },
    "Error": null
}

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. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。

获取MQTT实例列表

本页目录：