文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>消息队列 MQTT 版>API 文档>共享订阅相关接口>查询共享订阅组列表

查询共享订阅组列表

最近更新时间：2026-04-21 02:32:00

我的收藏

本页目录：

1. 接口描述

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

查询集群下共享订阅组列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeSharedSubscriptionGroups。
Version 是 String 公共参数，本接口取值：2024-05-16。
Region 是 String 公共参数，详见产品支持的 地域列表。
InstanceId 是 String 腾讯云MQTT实例ID，从 DescribeInstanceList接口或控制台获得。
示例值：mqtt-xxxx

3. 输出参数

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

4. 示例

示例1 查询共享订阅组列表

查询共享订阅组列表

输入示例

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

{
    "InstanceId": "mqtt-zj944d74"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "Data": [
            {
                "CreateTime": 1749468454000,
                "ExpiryInterval": 10,
                "InstanceId": "mqtt-zj944d74",
                "LbStrategy": 1,
                "Remark": "helklo2",
                "SharedName": "test-aa",
                "UpdateTime": 1749798776000
            },
            {
                "CreateTime": 1749398400000,
                "ExpiryInterval": 10,
                "InstanceId": "mqtt-zj944d74",
                "LbStrategy": 1,
                "Remark": null,
                "SharedName": "test-bb",
                "UpdateTime": 1749398400000
            },
            {
                "CreateTime": 1749475014000,
                "ExpiryInterval": 10,
                "InstanceId": "mqtt-zj944d74",
                "LbStrategy": 1,
                "Remark": null,
                "SharedName": "test-cc",
                "UpdateTime": 1749475016000
            },
            {
                "CreateTime": 1749475039000,
                "ExpiryInterval": 15,
                "InstanceId": "mqtt-zj944d74",
                "LbStrategy": 1,
                "Remark": null,
                "SharedName": "test-dd",
                "UpdateTime": 1749475041000
            },
            {
                "CreateTime": 1749798707000,
                "ExpiryInterval": 10,
                "InstanceId": "mqtt-zj944d74",
                "LbStrategy": 1,
                "Remark": "hello",
                "SharedName": "test-ee",
                "UpdateTime": 1749798707000
            }
        ],
        "RequestId": "f320bebc-c033-4cc5-ab39-72c477e98b24",
        "TotalCount": 5
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InstanceNotReady FailedOperation.InstanceNotReady
ResourceNotFound 资源不存在。
ResourceNotFound.Instance ResourceNotFound.Instance
中国站