查询MQTT实例详情信息

最近更新时间:2025-06-25 01:33:38

我的收藏

1. 接口描述

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

查询实例信息

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

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

2. 输入参数

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

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

3. 输出参数

参数名称 类型 描述
InstanceType String 实例类型
BASIC 基础版
PRO 专业版
PLATINUM 铂金版
示例值:PRO
InstanceId String 实例ID
示例值:mqtt-mwmdg9dm
InstanceName String 实例名称
示例值:name
TopicNum Integer 主题数量
示例值:2
TopicNumLimit Integer 实例最大主题数量
示例值:1000
TpsLimit Integer TPS限流值
示例值:1000
CreatedTime Integer 创建时间,秒为单位
示例值:1711955420
Remark String 备注信息
示例值:remark
InstanceStatus String 实例状态, RUNNING, 运行中 MAINTAINING,维护中 ABNORMAL,异常 OVERDUE,欠费 DESTROYED,已删除 CREATING,创建中 MODIFYING,变配中 CREATE_FAILURE,创建失败 MODIFY_FAILURE,变配失败 DELETING,删除中
示例值:RUNNING
SkuCode String 实例规格
示例值:pro_10k_1
MaxSubscriptionPerClient Integer 单客户端最大订阅数
示例值:30
AuthorizationPolicyLimit Integer 授权规则条数
示例值:10
ClientNumLimit Integer 客户端数量上限
示例值:1000
DeviceCertificateProvisionType String 客户端证书注册方式:
JITP:自动注册
API:通过API手动注册
示例值:API
AutomaticActivation Boolean 自动注册设备证书时是否自动激活
示例值:false
RenewFlag Integer 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
示例值:1
PayMode String 计费模式, POSTPAID,按量计费 PREPAID,包年包月
示例值:POSTPAID
ExpiryTime Integer 到期时间,毫秒级时间戳
示例值:1713164969433
DestroyTime Integer 预销毁时间,毫秒级时间戳
示例值:1713164969433
X509Mode String TLS,单向认证 mTLS,双向认证 BYOC;一机一证
示例值:TLS
MaxCaNum Integer 最大Ca配额
示例值:1
RegistrationCode String 证书注册码
示例值:2140c1c2-e26d-47f6-9048-0573f91b219b
MaxSubscription Integer 集群最大订阅数
示例值:120000
AuthorizationPolicy Boolean 授权策略开关
示例值:false
SharedSubscriptionGroupLimit Integer 共享订阅组数最大限制
示例值:20
MaxTopicFilterPerSharedSubscriptionGroup Integer 单个共享订阅组TopicFilter数限制
示例值:10
AutoSubscriptionPolicyLimit Integer 自动订阅规则条数限制
示例值:10
MaxTopicFilterPerAutoSubscriptionPolicy Integer 单条自动订阅规则TopicFilter数限制
示例值:5
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

示例

输入示例

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

{
    "InstanceId": "mqtt-bg8k8v8o"
}

输出示例

{
    "RequestId": null,
    "Response": {
        "RequestId": "5a2634e3-effd-4380-a9ff-3658ec6c1fdc",
        "InstanceType": "PRO",
        "InstanceStatus": "RUNNING",
        "PayMode": "POSTPAID",
        "RenewFlag": 1,
        "DestroyTime": 0,
        "CreatedTime": 1741832627,
        "TpsLimit": 6000,
        "Remark": "",
        "SkuCode": "pro_10k_1",
        "MaxSubscriptionPerClient": 30,
        "MaxSubscription": 180000,
        "AuthorizationPolicyLimit": 20,
        "ClientNumLimit": 6000,
        "MaxCaNum": 20,
        "DeviceCertificateProvisionType": "JITP",
        "RegistrationCode": "66a00d75-8272-421f-be2a-166e2c2e7813",
        "AutomaticActivation": true,
        "X509Mode": "BYOC",
        "ExpiryTime": 0,
        "TopicNumLimit": 300,
        "InstanceId": "mqtt-zxjwkr98",
        "TopicNum": 1,
        "InstanceName": "mqtt-instance1"
    },
    "Error": null
}

示例2 查询MQTT实例详情信息

查询MQTT实例详情信息

输入示例

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

{
    "InstanceId": "mqtt-zj944d74"
}

输出示例

{
    "Error": null,
    "RequestId": null,
    "Response": {
        "AuthorizationPolicy": true,
        "AuthorizationPolicyLimit": 20,
        "AutoSubscriptionPolicyLimit": 10,
        "AutomaticActivation": false,
        "ClientNumLimit": 6000,
        "CreatedTime": 1736236715,
        "DestroyTime": 0,
        "DeviceCertificateProvisionType": "JITP",
        "ExpiryTime": 0,
        "InstanceId": "mqtt-zj944d74",
        "InstanceName": "seiroli-byoc-test-0107",
        "InstanceStatus": "RUNNING",
        "InstanceType": "PRO",
        "MaxCaNum": 20,
        "MaxSubscription": 180000,
        "MaxSubscriptionPerClient": 30,
        "MaxTopicFilterPerAutoSubscriptionPolicy": 5,
        "MaxTopicFilterPerSharedSubscriptionGroup": 10,
        "PayMode": "POSTPAID",
        "RegistrationCode": "bf2ead84-e9e2-478e-a153-3b6baa9b78b1",
        "Remark": "",
        "RenewFlag": 1,
        "RequestId": "a71557b4-34ca-46b0-ab51-2420bf4555c2",
        "SharedSubscriptionGroupLimit": 20,
        "SkuCode": "pro_6k_1",
        "TopicNum": 2,
        "TopicNumLimit": 300,
        "TpsLimit": 6000,
        "X509Mode": "BYOC"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound.Instance ResourceNotFound.Instance