热门活动
全部活动
AuthorizationPolicyItem
AuthorizationPolicyItem
被如下接口引用：DescribeAuthorizationPolicies。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 策略规则ID 示例值：1 |
| InstanceId | String | MQTT集群ID 示例值：mqtt-xxxx |
| PolicyName | String | 策略规则名 示例值：allow-connect |
| Version | Integer | 规则语法版本，当前仅支持1，默认为1 示例值：1 |
| Priority | Integer | 策略优先级，优先级ID越小表示策略越优先检查生效。可参考 数据面授权策略说明。 示例值：1 |
| Effect | String | 决策 allow：允许符合该策略的设备的访问请求。 deny：拒绝覆盖该策略的设备的访问请求。 可参考 数据面授权策略说明。 示例值：allow |
| Actions | String | 操作 connect：连接 pub：发布mqtt消息 sub：订阅mqtt消息 可参考 数据面授权策略说明。 示例值：connect |
| Resources | String | 资源，可参考 数据面授权策略说明。 示例值：topic1 |
| ClientId | String | 条件-连接设备ID，可参考 数据面授权策略说明。 示例值：client1 |
| Username | String | 条件-用户名，可参考 数据面授权策略说明。 示例值：user1 |
| Ip | String | 条件-客户端IP地址，可参考 数据面授权策略说明。 示例值：127.0.0.1 |
| Qos | String | 条件-服务质量，可参考 数据面授权策略说明。 示例值：0 |
| Retain | Integer | 条件-保留消息，可参考 数据面授权策略说明。 1：表示匹配retain消息 2：表示匹配非retain消息 3：表示匹配retain和非retain消息 示例值：1 |
| Remark | String | 备注，长度不超过128个字符。 示例值：remark |
| CreatedTime | Integer | 创建时间。毫秒级时间戳 。 示例值：1713164969433 |
| UpdateTime | Integer | 更新时间。毫秒级时间戳 。 示例值：1713164969433 |
AuthorizationPolicyPriority
策略规则优先级
被如下接口引用：UpdateAuthorizationPolicyPriority。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 是 | 授权策略规则id，可以从 DescribeAuthorizationPolicies接口获得。 示例值：1 |
| Priority | Integer | 是 | 优先级 示例值：1 |
BodyItem
HTTP 认证器body
被如下接口引用：CreateHttpAuthenticator, ModifyHttpAuthenticator。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | body key 示例值：username |
| Value | String | 是 | body key 示例值：${username} |
CaCertificateItem
CA证书信息
被如下接口引用：DescribeCaCertificates。
| 名称 | 类型 | 描述 |
|---|---|---|
| CaCn | String | 证书的公用名(Common Name) 示例值：ca.cloud.tencent.com |
| CaCertificate | String | 证书内容 示例值：-----BEGIN CERTIFICATE-----\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE----- |
| CaSn | String | 证书序列号 示例值：40597e878dc36d4dd13a25da70271f7b4ba6fe63 |
| Format | String | 证书格式，当前仅支持 PEM 格式 示例值：PEM |
| VerificationCertificate | String | 验证证书内容 示例值：-----BEGIN CERTIFICATE-----\nMIID7TCCAtWgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmRIwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE----- |
| Status | String | CA证书的状态 ACTIVE：激活 INACTIVE：未激活 REVOKED：吊销 PENDING_ACTIVATION：注册待激活 示例值：ACTIVE |
| LastActivationTime | Integer | 上次激活时间，毫秒级时间戳 。 示例值：1713164969433 |
| CreatedTime | Integer | 创建时间，毫秒级时间戳 。 示例值：1713164969433 |
| UpdateTime | Integer | 更新时间，毫秒级时间戳 。 示例值：1713164969433 |
| LastInactivationTime | Integer | 上次去激活时间，毫秒级时间戳 。 示例值：1713164969433 |
| CaIssuerCn | String | Ca证书颁发者CN 示例值：issuer |
| NotBeforeTime | Integer | 生效时间，毫秒级时间戳 。 示例值：1713164969433 |
| NotAfterTime | Integer | 失效时间，毫秒级时间戳 。 示例值：1713164969433 |
DeviceCertificateItem
设备证书信息
被如下接口引用：DescribeDeviceCertificates。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 客户端id 示例值：device1 |
| DeviceCertificate | String | 设备证书 示例值：-----BEGIN CERTIFICATE-----END CERTIFICATE-----\r\n |
| DeviceCertificateSn | String | 设备证书SN序列号，用于唯一标识一个设备证书 示例值：181cf3245523979e |
| DeviceCertificateCn | String | 设备证书Cn 示例值：***.cloud.tencent.com |
| CaSn | String | 签发该证书的CA证书的序列号 示例值：40597e878dc36d4dd13a25da70271f7b4ba6fe63 |
| Format | String | 证书格式，当前仅支持PEM 示例值：PEM |
| Status | String | 设备证书状态 ACTIVE：激活 INACTIVE：未激活 REVOKED：吊销 PENDING_ACTIVATION：注册待激活 示例值：ACTIVE |
| OrganizationalUnit | String | 组织单位 示例值：Development-Department |
| LastActivationTime | Integer | 上次激活时间，毫秒级时间戳 。 示例值：1713164969433 |
| LastInactivationTime | Integer | 上次取消激活时间，毫秒级时间戳 。 示例值：1713164969433 |
| CreatedTime | Integer | 创建时间，毫秒级时间戳 。 示例值：1713164969433 |
| UpdateTime | Integer | 更新时间，毫秒级时间戳 。 示例值：1713164969433 |
| CertificateSource | String | 证书来源： API, 手动注册 JITP 自动注册 示例值：JITP |
| NotAfterTime | Integer | 证书失效日期，毫秒级时间戳 。 示例值：1713164969433 |
| NotBeforeTime | Integer | 证书生效开始日期，毫秒级时间戳 。 示例值：1713164969433 |
Filter
查询过滤器
被如下接口引用：DescribeDeviceCertificates, DescribeInstanceList, DescribeTopicList, DescribeUserList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件名 示例值：key |
| Values | Array of String | 是 | 过滤条件的值 示例值：value |
HeaderItem
HTTP 认证器header
被如下接口引用：CreateHttpAuthenticator, ModifyHttpAuthenticator。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 是 | header key 示例值：Content-Type |
| Value | String | 是 | header value 示例值：application/json |
IpRule
IP规则
被如下接口引用：CreateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | IP地址 示例值：0.0.0.0 |
| Allow | Boolean | 是 | 当前仅支持允许，默认允许。 示例值：true |
| Remark | String | 是 | 备注信息 示例值：remark1 |
MQTTAuthenticatorItem
MQTT认证器信息
被如下接口引用：DescribeAuthenticator。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 认证器类型 JWT：JWT认证器 JWKS：JWKS认证器 HTTP：HTTP认证器 示例值：JWKS |
| Config | String | JWT认证器字段说明 from（认证字段） password：从password字段获取认证字段 username：从username字段获取认证字段 secret（签名方式） hmac-based：hmac-based签名方式 public-key：public-key签名方式 secret（密钥），hmac-based需要配置密钥 public-key（公钥），public-key签名方式需要配置 样例：{"from":"password","secret":"secret282698","algorithm":"hmac-based"} JWKS认证器字段说明 endpoint（接入点）：公钥获取服务器接入地址 refreshInterval（认证内容）：公钥集合刷新周期 from（认证字段） password：从password字段获取认证字段 username：从username字段获取认证字段 text：公钥集合 样例：{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"} HTTP认证器 headers（请求头）：标准请求头和自定义请求头 endpoint（接入点）：认证服务器接入点 method（http请求方法）：POST/GET readTimeout（读超时时间）：读取认证服务器数据超时时间，单位秒 connectTimeout（连接超时时间）：连接认证服务器超时时间，单位秒 body（请求体）：http请求体 concurrency（并发数）：最大并发请求数量 样例：{"headers":[{"key":"Content-type","value":"application/json"},{"key":"username","value":"${Username}"}],"endpoint":"https://127.0.0.1:443","method":"POST","readTimeout":10,"connectTimeout":10,"body":[{"key":"client-id","value":"${ClientId}"}],"concurrency":8} 参考 认证管理概述 示例值：{"headers":[{"key":"user","value":"${username}"}],"endpoint":"127.0.0.1","method":"Post","readTimeout":1,"connectTimeout":1,"body":[{"key":"user","value":"${username}"}],"concurrency":1} |
| Status | String | 认证器状态 open：认证器打开 close：认证器关闭 示例值：open |
| CreateTime | Integer | 创建时间，毫秒级时间戳 。 示例值：1711700678 |
| Remark | String | 说明，最长 128 字符。 示例值：说明 |
MQTTClientInfo
MQTT客户端信息
被如下接口引用：DescribeClientList。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 客户端ID 示例值：ClientId |
| ClientAddress | String | 客户端网络地址 示例值：127.0.0.1:10001 |
| ProtocolVersion | Integer | MQTT 协议版本 3：表示MQTT 3.1版本 4：表示 MQTT 3.1.1 5：表示MQTT 5.0协议 示例值：4 |
| Keepalive | Integer | 保持连接时间，单位：秒 示例值：60 |
| ConnectionStatus | String | 连接状态，CONNECTED 已连接，DISCONNECTED 未连接 示例值：CONNECTED |
| CreateTime | Integer | 客户端创建时间，毫秒级时间戳 。 示例值：1701396000000 |
| ConnectTime | Integer | 上次建立连接时间，毫秒级时间戳 。 示例值：1701396000000 |
| DisconnectTime | Integer | 上次断开连接时间，仅对持久会话（cleanSession=false）并且客户端当前未连接时有意义，毫秒级时间戳 。 示例值：1701403200000 |
| MQTTClientSubscriptions | Array of MQTTClientSubscription | 客户端的订阅列表 |
MQTTClientSubscription
MQTT 订阅关系
被如下接口引用：DescribeClientList。
| 名称 | 类型 | 描述 |
|---|---|---|
| TopicFilter | String | topic 订阅 示例值：mytopic/a/+ |
| Qos | Integer | 服务质量等级 0: 至多一次 1: 至少一次 2: 恰好一次 示例值：1 |
| Lag | Integer | 堆积数量 示例值：0 |
| Inflight | Integer | 投递未确认数量 示例值：0 |
MQTTEndpointItem
MQTTEndpoint
被如下接口引用：DescribeInsPublicEndpoints, DescribeInsVPCEndpoints。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 类型 示例值：mqtt-tcp |
| Url | String | 否 | 接入点 示例值：mqtt-12345-cd.mqtt.public.tencenttdmq.com:1883 |
| VpcId | String | 否 | vpc信息 示例值：vpc-23dada |
| SubnetId | String | 否 | 子网信息 示例值：subnet-1acd3 |
| Host | String | 否 | 主机 示例值：mqtt-12345-cd.mqtt.public.tencenttdmq.com |
| Port | Integer | 否 | 端口 示例值：1883 |
| Ip | String | 否 | 接入点ip 示例值：127.0.0.1 |
MQTTInstanceItem
MQTT 实例信息
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：mqtt-xxxx |
| InstanceName | String | 实例名称 示例值：instance-poc |
| Version | String | 实例版本 示例值：5.0 |
| InstanceType | String | 实例类型 BASIC，基础版 PRO，专业版 PLATINUM，铂金版 示例值：PRO |
| InstanceStatus | String | 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中 示例值：RUNNING |
| TopicNumLimit | Integer | 实例主题数上限 示例值：100 |
| Remark | String | 备注信息 示例值：this is remark |
| TopicNum | Integer | 主题数量 示例值：2 |
| SkuCode | String | 商品规格 示例值：pro_10k_1 |
| TpsLimit | Integer | 弹性TPS限流值 示例值：100 |
| CreateTime | Integer | 创建时间，毫秒级时间戳 示例值：1713164969433 |
| MaxSubscriptionPerClient | Integer | 单客户端最大订阅数量 示例值：30 |
| ClientNumLimit | Integer | 客户端连接数上线 示例值：1000 |
| RenewFlag | Integer | 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费 示例值：1 |
| PayMode | String | 计费模式， POSTPAID，按量计费 PREPAID，包年包月 示例值：POSTPAID |
| ExpiryTime | Integer | 到期时间，毫秒级时间戳 示例值：1742455643000 |
| DestroyTime | Integer | 预销毁时间，毫秒级时间戳 示例值：1713164969433 |
| AuthorizationPolicyLimit | Integer | 授权规则条数限制 示例值：10 |
| MaxCaNum | Integer | 最大ca配额 示例值：1 |
| MaxSubscription | Integer | 最大订阅数 示例值：12000 |
MQTTMessage
MQTT消息
被如下接口引用：DescribeMessageByTopic。
| 名称 | 类型 | 描述 |
|---|---|---|
| MessageId | String | 消息id 示例值：15397032005D639FEE4879C38A130016 |
| ClientId | String | 消息发送的客户端Id 示例值：client-1 |
| Qos | String | 消息服务质量等级 示例值：1 |
| StoreTimestamp | Integer | 消息在服务端的存储时间，毫秒级时间戳 示例值：1745828681259 |
| OriginTopic | String | 源topic 示例值：home/room |
MQTTMessageItem
消息记录
被如下接口引用：DescribeMessageList。
| 名称 | 类型 | 描述 |
|---|---|---|
| MsgId | String | 消息ID 示例值：1539706D00525B6F741264F22D560025 |
| Tags | String | 消息tag 示例值：tag1 |
| Keys | String | 消息key 示例值：value1 |
| ProducerAddr | String | 客户端地址 示例值：127.0.0.1:34679 |
| ProduceTime | String | 消息发送时间，格式 日期时间：YYYY-MM-DD hh:mm:ss 示例值：2025-03-27 15:23:35 |
| Qos | String | 消息质量等级 0：至多一次 1：至少一次 2：精确一次 示例值：1 |
MQTTTopicItem
MQTT 主题详情
被如下接口引用：DescribeTopicList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例 ID 示例值：mqtt-xxx |
| Topic | String | 主题名称 示例值：mytopic |
| Remark | String | 主题描述 示例值：remark1 |
MQTTUserItem
MQTT集群用户信息
被如下接口引用：DescribeUserList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Username | String | 用户名 示例值：user1 |
| Password | String | 密码 示例值：pd |
| Remark | String | 备注信息 示例值：remark1 |
| CreatedTime | Integer | 创建时间，毫秒级时间戳 。 示例值：1712739629775 |
| ModifiedTime | Integer | 修改时间，毫秒级时间戳 。 示例值：1712739629775 |
PriceTag
价格标签信息
被如下接口引用：DescribeProductSKUList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 计价名称，表示规格的计费项项目分类，具体规格的计价名称可参考 获取MQTT产品售卖规格 接口的返回结果。 示例值：tps |
| Category | String | 计价类别，计价名称子类，具体规格的计价类别可参考 获取MQTT产品售卖规格 的返回结果。 示例值：v_tdmq_instance_specification |
| Code | String | 计费项标签，为计价名称（Name）下计价类别（Category）的子项目，表示一个具体的收费项。规格的计费项标签可参考 获取MQTT产品售卖规格 接口的返回结果。 示例值：sv_tdmq_instance_specification_test_500 |
| Step | Integer | 计费步长，表示该规格在 计价名称（Name）下的计价类别（Category）的计费项标签（Code）计费数量。具体规格该字段取值参考 获取MQTT产品售卖规格 示例值：1 |
ProductSkuItem
MQTT ProductSkuItem
被如下接口引用：DescribeProductSKUList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceType | String | 规格类型 BASIC：基础版 PRO ：专业版 PLATINUM： 铂金版 示例值：BASIC |
| SkuCode | String | 规格代码 示例值：pro_10k_1 |
| OnSale | Boolean | 是否售卖 1: 可售卖 0: 不可售卖 示例值：1 |
| TopicNumLimit | Integer | topic num限制 示例值：100 |
| TpsLimit | Integer | MQTT 集群下每秒钟生产消息量和消费消息量之和。详细计算方式参考 计费概述 示例值：1000 |
| ClientNumLimit | Integer | 客户端连接数 示例值：1000 |
| MaxSubscriptionPerClient | Integer | 单客户端最大订阅数 示例值：30 |
| AuthorizationPolicyLimit | Integer | 授权规则条数 示例值：10 |
| PriceTags | Array of PriceTag | 计费项信息 |
PublicAccessRule
公网访问安全规则
被如下接口引用：CreateInsPublicEndpoint, DescribeInsPublicEndpoints, ModifyInsPublicEndpoint。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IpRule | String | 否 | ip网段信息 示例值：0.0.0.0/0 |
| Allow | Boolean | 否 | 当前仅支持允许，默认允许（allow） 示例值：true |
| Remark | String | 否 | 备注信息，最多64个字符。 示例值：this is remark |
Tag
标签数据
被如下接口引用：CreateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签名称 示例值：tag-key |
| TagValue | String | 是 | 标签值 示例值：tag-value |
TagFilter
标签过滤器
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签键名称 示例值：key1 |
| TagValues | Array of String | 否 | 标签键名称 示例值：value1 |
VpcInfo
VPC信息
被如下接口引用：CreateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 否 | VPC ID 示例值：vpc-xxxx |
| SubnetId | String | 否 | 子网ID 示例值：subnet-xxxx |
