AuthorizationPolicyItem
AuthorizationPolicyItem
被如下接口引用：DescribeAuthorizationPolicies。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 规则ID 示例值：1 |
| InstanceId | String | 集群ID 示例值：mqtt-12345 |
| PolicyName | String | 规则名 注意：此字段可能返回 null，表示取不到有效值。 示例值：规则1 |
| Version | Integer | 规则语法版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Priority | Integer | 越小越优先 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Effect | String | allow/deny 注意：此字段可能返回 null，表示取不到有效值。 示例值：allow |
| Actions | String | connect、pub、sub 注意：此字段可能返回 null，表示取不到有效值。 示例值：connect |
| Resources | String | 资源 注意：此字段可能返回 null，表示取不到有效值。 示例值：topic1 |
| ClientId | String | client 注意：此字段可能返回 null，表示取不到有效值。 示例值：client1 |
| Username | String | 用户 注意：此字段可能返回 null，表示取不到有效值。 示例值：user1 |
| Ip | String | IP地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
| Qos | String | 0，1，2 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Retain | Integer | 1：表示匹配retain消息 2：表示匹配非retain消息 3：表示匹配retain和非retain消息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Remark | String | 描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark |
| CreatedTime | Integer | 1713164969433 示例值：创建时间 |
| UpdateTime | Integer | 1713164969433 示例值：更新时间 |
AuthorizationPolicyPriority
策略规则优先级
被如下接口引用：UpdateAuthorizationPolicyPriority。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | Integer | 是 | 策略id 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| Priority | Integer | 是 | 优先级 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
CaCertificateItem
CA证书信息
被如下接口引用：DescribeCaCertificates。
| 名称 | 类型 | 描述 |
|---|---|---|
| CaCn | String | common name 示例值：12 |
| CaCertificate | String | 证书内容 示例值：-----BEGIN CERTIFICATE-----\nMIIEvDCCA6SgAwIBAgIUGx4783AhEBJYh6OnIafmbwVSJRMwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE----- |
| CaSn | String | 证书序列号 示例值：123 |
| Format | String | 证书格式 示例值：PEM |
| VerificationCertificate | String | 验证证书内容 示例值：-----BEGIN CERTIFICATE-----\nMIID7TCCAtWgAwIBAgIUDu9opYK5QlQpblTOdU+U1welmRIwDQYJKoZIhvcNAQEL\n-----END CERTIFICATE----- |
| Status | String | ca状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：ACTIVE |
| LastActivationTime | Integer | 上次激活时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| CreatedTime | Integer | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| UpdateTime | Integer | 预销毁时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| LastInactivationTime | Integer | 上次去激活时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| CaIssuerCn | String | Ca证书颁发者CN 注意：此字段可能返回 null，表示取不到有效值。 示例值：AA |
| NotBeforeTime | Integer | 生效时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| NotAfterTime | Integer | 失效时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
DeviceCertificateItem
设备证书信息
被如下接口引用：DescribeDeviceCertificates。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClientId | String | 客户端id 注意：此字段可能返回 null，表示取不到有效值。 示例值：device1 |
| DeviceCertificate | String | 设备证书 示例值：-----BEGIN CERTIFICATE-----\r\nMIIDtzCCAp+gAwIBAgIUDAmlFLEYRYrhNkFH+uRaU/0TZCswDQYJKoZIhvcNAQEL\r\n\n-----END CERTIFICATE-----\r\n |
| DeviceCertificateSn | String | 设备证书Sn 示例值：sn |
| DeviceCertificateCn | String | 设备证书Cn 示例值：common name |
| CaSn | String | 签发ca的序列号 示例值：casn |
| Format | String | 证书格式 示例值：PEM |
| Status | String | 证书状态 ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活 示例值：ACTIVE |
| LastActivationTime | Integer | 上次激活时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| LastInactivationTime | Integer | 上次取消激活时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| CreatedTime | Integer | 创建时间 示例值：1713164969433 |
| UpdateTime | Integer | 预销毁时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| CertificateSource | String | 证书来源： API, 手动注册 JITP 自动注册 注意：此字段可能返回 null，表示取不到有效值。 示例值：JITP |
| NotAfterTime | Integer | 证书失效日期 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| NotBeforeTime | Integer | 证书生效开始日期 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
Filter
查询过滤器
被如下接口引用：DescribeDeviceCertificates, DescribeInstanceList, DescribeTopicList, DescribeUserList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Name | String | 是 | 过滤条件名 示例值：key |
| Values | Array of String | 是 | 过滤条件的值 示例值：value |
IpRule
IP规则
被如下接口引用：CreateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | IP地址 示例值：0.0.0.0 |
| Allow | Boolean | 是 | 是否允许放行 示例值：true |
| Remark | String | 是 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark1 |
MQTTAuthenticatorItem
MQTT认证器信息
被如下接口引用：DescribeAuthenticator。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 认证器类型: JWT：JWT认证器 JWKS：JWKS认证器 BYOC：一端一证认证器 注意：此字段可能返回 null，表示取不到有效值。 示例值：JWKS |
| Config | String | 认证器配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"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 | 认证器状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：open |
| CreateTime | Integer | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1711700678 |
| Remark | String | 说明 注意：此字段可能返回 null，表示取不到有效值。 示例值：说明 |
MQTTEndpointItem
MQTTEndpoint
被如下接口引用：DescribeInsPublicEndpoints。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqtt-tcp |
| Url | String | 否 | 接入点 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqtt-12345-cd.mqtt.public.tencenttdmq.com:1883 |
| VpcId | String | 否 | vpc信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-23dada |
| SubnetId | String | 否 | 子网信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-dadaf |
| Host | String | 否 | 主机 注意：此字段可能返回 null，表示取不到有效值。 示例值：mqtt-12345-cd.mqtt.public.tencenttdmq.com |
| Port | Integer | 否 | 端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：1883 |
| Ip | String | 否 | 接入点ip 注意：此字段可能返回 null，表示取不到有效值。 示例值：127.0.0.1 |
MQTTInstanceItem
MQTT 实例信息
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例ID 示例值：mqtt-xxxx |
| InstanceName | String | 实例名称 示例值：instance-poc |
| Version | String | 实例版本 示例值：5.0 |
| InstanceType | String | 实例类型， EXPERIMENT，体验版 BASIC，基础版 PRO，专业版 PLATINUM，铂金版 示例值：EXPERIMENT |
| InstanceStatus | String | 实例状态， RUNNING, 运行中 MAINTAINING，维护中 ABNORMAL，异常 OVERDUE，欠费 DESTROYED，已删除 CREATING，创建中 MODIFYING，变配中 CREATE_FAILURE，创建失败 MODIFY_FAILURE，变配失败 DELETING，删除中 示例值：RUNNING |
| TopicNumLimit | Integer | 实例主题数上限 示例值：100 |
| Remark | String | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is remark |
| TopicNum | Integer | 主题数量 示例值：2 |
| SkuCode | String | 商品规格 示例值：basic_1k |
| TpsLimit | Integer | 弹性TPS限流值 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| CreateTime | Integer | 创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| MaxSubscriptionPerClient | Integer | 单客户端最大订阅数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
| ClientNumLimit | Integer | 客户端连接数上线 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| RenewFlag | Integer | 是否自动续费 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| PayMode | String | 计费模式， POSTPAID，按量计费 PREPAID，包年包月 注意：此字段可能返回 null，表示取不到有效值。 示例值：POSTPAID |
| ExpiryTime | Integer | 到期时间，秒为单位 注意：此字段可能返回 null，表示取不到有效值。 示例值：100000 |
| DestroyTime | Integer | 预销毁时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1713164969433 |
| AuthorizationPolicyLimit | Integer | 授权规则条数限制 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| MaxCaNum | Integer | 最大ca配额 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| MaxSubscription | Integer | 最大订阅数 注意：此字段可能返回 null，表示取不到有效值。 示例值：12000 |
MQTTTopicItem
MQTT 主题详情
被如下接口引用：DescribeTopicList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceId | String | 实例 ID 示例值：mqtt-xxx |
| Topic | String | 主题名称 示例值：mytopic |
| Remark | String | 主题描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark1 |
MQTTUserItem
MQTT集群用户信息
被如下接口引用：DescribeUserList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Username | String | 用户名 示例值：user1 |
| Password | String | 密码 示例值：pd |
| Remark | String | 备注信息 示例值：remark1 |
| CreatedTime | Integer | 创建时间，秒为单位 示例值：1712739629775 |
| ModifiedTime | Integer | 修改时间，秒为单位 示例值：1712739629775 |
PriceTag
价格标签信息
被如下接口引用：DescribeProductSKUList。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 计价名称 |
| Category | String | 计价类别 |
| Code | String | 计费项标签 |
| Step | Integer | 步长 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
ProductSkuItem
MQTT ProductSkuItem
被如下接口引用：DescribeProductSKUList。
| 名称 | 类型 | 描述 |
|---|---|---|
| InstanceType | String | 规格类型 BASIC：基础版 PRO ：专业版 注意：此字段可能返回 null，表示取不到有效值。 示例值：BASIC |
| SkuCode | String | 规格代码 注意：此字段可能返回 null，表示取不到有效值。 示例值：basic_1000 |
| OnSale | Boolean | 是否售卖 注意：此字段可能返回 null，表示取不到有效值。 示例值：1 |
| TopicNumLimit | Integer | topic num限制 注意：此字段可能返回 null，表示取不到有效值。 示例值：100 |
| TpsLimit | Integer | tps 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| ClientNumLimit | Integer | 客户端连接数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1000 |
| MaxSubscriptionPerClient | Integer | 单客户端最大订阅数 注意：此字段可能返回 null，表示取不到有效值。 示例值：30 |
| AuthorizationPolicyLimit | Integer | 授权规则条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10 |
| PriceTags | Array of PriceTag | 计费项信息 注意：此字段可能返回 null，表示取不到有效值。 |
PublicAccessRule
公网访问安全规则
被如下接口引用：CreateInsPublicEndpoint, DescribeInsPublicEndpoints, ModifyInsPublicEndpoint。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| IpRule | String | 是 | ip网段信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.0.0.0/0 |
| Allow | Boolean | 是 | 允许或者拒绝 注意：此字段可能返回 null，表示取不到有效值。 示例值：true |
| Remark | String | 否 | 备注信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：test |
Tag
标签数据
被如下接口引用：CreateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 是 | 标签名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：123 |
| TagValue | String | 是 | 标签值 注意：此字段可能返回 null，表示取不到有效值。 示例值：abc |
TagFilter
标签过滤器
被如下接口引用：DescribeInstanceList。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TagKey | String | 否 | 标签键名称 示例值：key1 |
| TagValues | Array of String | 否 | 标签键名称 示例值：value1 |
VpcInfo
VPC信息
被如下接口引用：CreateInstance。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VpcId | String | 是 | VPC ID 示例值：vpc-xxxx |
| SubnetId | String | 是 | 子网ID 示例值：subnet-xxxx |
