tencentcloud-sdk-mqtt 3.0.1026 → 3.0.1027

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20240516/models.rb +146 -94
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b26c802ba1e6a0e62efd8ca02e31c37f4f13430b
4
- data.tar.gz: cb181237d1951f20d614b6c1b2e961dd775ca67c
3
+ metadata.gz: 68cbc27a06f4acad1872015b0db4a6cabc0cc9aa
4
+ data.tar.gz: 6770022dc9bd2c39111ba70413bff57115e0610b
5
5
  SHA512:
6
- metadata.gz: aa63604ff9c0e70cf545c90eb1bfb51525f832784aa5c0411646064a36b5aa6ab74e0e30f2b428b09b3a385f342f49aa33116e3c1545296f488f3a5dda74e70c
7
- data.tar.gz: f3da49ba74e1d9102d6062a9ff78001f04a160928c583eb86655e2485db46a1c5f20d28e7a1010c554504db58ad7e8d9aa7defedad17b6bbfb35e92e4ea0ac92
6
+ metadata.gz: 4c7799a44b53e82cbf001d018e9555cd30ea0406a1dab993b3cb2bd3fa06795409f3d819f451e8cc05c135f3aff2f87eb923ce35bbfed9c22b1fe378639416ad
7
+ data.tar.gz: 25882e8b5aa38fb42ba0035c1b4374da23b09144263c45798948f9750a9047c95ee0b8c6161905a73f096c162565baa77c62c7d038e64dda6f458c750e457966
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1026
1
+ 3.0.1027
@@ -55,9 +55,9 @@ module TencentCloud
55
55
 
56
56
  # ActivateDeviceCertificate请求参数结构体
57
57
  class ActivateDeviceCertificateRequest < TencentCloud::Common::AbstractModel
58
- # @param InstanceId: 集群id
58
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
59
59
  # @type InstanceId: String
60
- # @param DeviceCertificateSn: 设备证书序列号
60
+ # @param DeviceCertificateSn: 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
61
61
  # @type DeviceCertificateSn: String
62
62
 
63
63
  attr_accessor :InstanceId, :DeviceCertificateSn
@@ -91,7 +91,7 @@ module TencentCloud
91
91
 
92
92
  # ApplyRegistrationCode请求参数结构体
93
93
  class ApplyRegistrationCodeRequest < TencentCloud::Common::AbstractModel
94
- # @param InstanceId: 集群id
94
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
95
95
  # @type InstanceId: String
96
96
 
97
97
  attr_accessor :InstanceId
@@ -131,39 +131,47 @@ module TencentCloud
131
131
 
132
132
  # AuthorizationPolicyItem
133
133
  class AuthorizationPolicyItem < TencentCloud::Common::AbstractModel
134
- # @param Id: 规则ID
134
+ # @param Id: 策略规则ID
135
135
  # @type Id: Integer
136
- # @param InstanceId: 集群ID
136
+ # @param InstanceId: MQTT集群ID
137
137
  # @type InstanceId: String
138
- # @param PolicyName: 规则名
138
+ # @param PolicyName: 策略规则名
139
139
  # @type PolicyName: String
140
- # @param Version: 规则语法版本
140
+ # @param Version: 规则语法版本,当前仅支持1,默认为1
141
141
  # @type Version: Integer
142
- # @param Priority: 越小越优先
142
+ # @param Priority: 策略优先级,优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
143
143
  # @type Priority: Integer
144
- # @param Effect: allow/deny
144
+ # @param Effect: 决策
145
+ # allow:允许符合该策略的设备的访问请求。
146
+ # deny:拒绝覆盖该策略的设备的访问请求。
147
+ # 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
145
148
  # @type Effect: String
146
- # @param Actions: connect、pub、sub
149
+ # @param Actions: 操作
150
+ # connect:连接
151
+ # pub:发布mqtt消息
152
+ # sub:订阅mqtt消息
153
+ # 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
147
154
  # @type Actions: String
148
- # @param Resources: 资源
155
+ # @param Resources: 资源,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
149
156
  # @type Resources: String
150
- # @param ClientId: client
157
+ # @param ClientId: 条件-连接设备ID,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
151
158
  # @type ClientId: String
152
- # @param Username: 用户
159
+ # @param Username: 条件-用户名,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
153
160
  # @type Username: String
154
- # @param Ip: IP地址
161
+ # @param Ip: 条件-客户端IP地址,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
155
162
  # @type Ip: String
156
- # @param Qos: 0,1,2
163
+ # @param Qos: 条件-服务质量,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
157
164
  # @type Qos: String
158
- # @param Retain: 1:表示匹配retain消息
165
+ # @param Retain: 条件-保留消息,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
166
+ # 1:表示匹配retain消息
159
167
  # 2:表示匹配非retain消息
160
168
  # 3:表示匹配retain和非retain消息
161
169
  # @type Retain: Integer
162
- # @param Remark: 描述
170
+ # @param Remark: 备注,长度不超过128个字符。
163
171
  # @type Remark: String
164
- # @param CreatedTime: 1713164969433
172
+ # @param CreatedTime: 创建时间。毫秒级时间戳 。
165
173
  # @type CreatedTime: Integer
166
- # @param UpdateTime: 1713164969433
174
+ # @param UpdateTime: 更新时间。毫秒级时间戳 。
167
175
  # @type UpdateTime: Integer
168
176
 
169
177
  attr_accessor :Id, :InstanceId, :PolicyName, :Version, :Priority, :Effect, :Actions, :Resources, :ClientId, :Username, :Ip, :Qos, :Retain, :Remark, :CreatedTime, :UpdateTime
@@ -209,7 +217,7 @@ module TencentCloud
209
217
 
210
218
  # 策略规则优先级
211
219
  class AuthorizationPolicyPriority < TencentCloud::Common::AbstractModel
212
- # @param Id: 策略id
220
+ # @param Id: 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
213
221
  # @type Id: Integer
214
222
  # @param Priority: 优先级
215
223
  # @type Priority: Integer
@@ -249,31 +257,35 @@ module TencentCloud
249
257
 
250
258
  # CA证书信息
251
259
  class CaCertificateItem < TencentCloud::Common::AbstractModel
252
- # @param CaCn: common name
260
+ # @param CaCn: 证书的公用名(Common Name)
253
261
  # @type CaCn: String
254
262
  # @param CaCertificate: 证书内容
255
263
  # @type CaCertificate: String
256
264
  # @param CaSn: 证书序列号
257
265
  # @type CaSn: String
258
- # @param Format: 证书格式
266
+ # @param Format: 证书格式,当前仅支持 PEM 格式
259
267
  # @type Format: String
260
268
  # @param VerificationCertificate: 验证证书内容
261
269
  # @type VerificationCertificate: String
262
- # @param Status: ca状态
270
+ # @param Status: CA证书的状态
271
+ # ACTIVE:激活
272
+ # INACTIVE:未激活
273
+ # REVOKED:吊销
274
+ # PENDING_ACTIVATION:注册待激活
263
275
  # @type Status: String
264
- # @param LastActivationTime: 上次激活时间
276
+ # @param LastActivationTime: 上次激活时间,毫秒级时间戳 。
265
277
  # @type LastActivationTime: Integer
266
- # @param CreatedTime: 创建时间
278
+ # @param CreatedTime: 创建时间,毫秒级时间戳 。
267
279
  # @type CreatedTime: Integer
268
- # @param UpdateTime: 预销毁时间
280
+ # @param UpdateTime: 更新时间,毫秒级时间戳 。
269
281
  # @type UpdateTime: Integer
270
- # @param LastInactivationTime: 上次去激活时间
282
+ # @param LastInactivationTime: 上次去激活时间,毫秒级时间戳 。
271
283
  # @type LastInactivationTime: Integer
272
284
  # @param CaIssuerCn: Ca证书颁发者CN
273
285
  # @type CaIssuerCn: String
274
- # @param NotBeforeTime: 生效时间
286
+ # @param NotBeforeTime: 生效时间,毫秒级时间戳 。
275
287
  # @type NotBeforeTime: Integer
276
- # @param NotAfterTime: 失效时间
288
+ # @param NotAfterTime: 失效时间,毫秒级时间戳 。
277
289
  # @type NotAfterTime: Integer
278
290
 
279
291
  attr_accessor :CaCn, :CaCertificate, :CaSn, :Format, :VerificationCertificate, :Status, :LastActivationTime, :CreatedTime, :UpdateTime, :LastInactivationTime, :CaIssuerCn, :NotBeforeTime, :NotAfterTime
@@ -739,11 +751,11 @@ module TencentCloud
739
751
 
740
752
  # CreateTopic请求参数结构体
741
753
  class CreateTopicRequest < TencentCloud::Common::AbstractModel
742
- # @param InstanceId: 实例ID
754
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
743
755
  # @type InstanceId: String
744
- # @param Topic: 主题
756
+ # @param Topic: 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
745
757
  # @type Topic: String
746
- # @param Remark: 备注
758
+ # @param Remark: 备注,最长 128 字符
747
759
  # @type Remark: String
748
760
 
749
761
  attr_accessor :InstanceId, :Topic, :Remark
@@ -787,13 +799,13 @@ module TencentCloud
787
799
 
788
800
  # CreateUser请求参数结构体
789
801
  class CreateUserRequest < TencentCloud::Common::AbstractModel
790
- # @param InstanceId: 实例ID
802
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
791
803
  # @type InstanceId: String
792
- # @param Username: 用户名
804
+ # @param Username: 用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
793
805
  # @type Username: String
794
806
  # @param Password: 密码,该字段为空时候则后端会默认生成
795
807
  # @type Password: String
796
- # @param Remark: 备注
808
+ # @param Remark: 备注,长度不超过128个字符。
797
809
  # @type Remark: String
798
810
 
799
811
  attr_accessor :InstanceId, :Username, :Password, :Remark
@@ -831,9 +843,9 @@ module TencentCloud
831
843
 
832
844
  # DeactivateCaCertificate请求参数结构体
833
845
  class DeactivateCaCertificateRequest < TencentCloud::Common::AbstractModel
834
- # @param InstanceId: 集群id
846
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
835
847
  # @type InstanceId: String
836
- # @param CaSn: 证书序列号
848
+ # @param CaSn: 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
837
849
  # @type CaSn: String
838
850
 
839
851
  attr_accessor :InstanceId, :CaSn
@@ -867,9 +879,9 @@ module TencentCloud
867
879
 
868
880
  # DeactivateDeviceCertificate请求参数结构体
869
881
  class DeactivateDeviceCertificateRequest < TencentCloud::Common::AbstractModel
870
- # @param InstanceId: 集群id
882
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
871
883
  # @type InstanceId: String
872
- # @param DeviceCertificateSn: 设备证书序列号
884
+ # @param DeviceCertificateSn: 设备证书的SN序列号,可以从 [DescribeDeviceCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、设备证书文件中获得。
873
885
  # @type DeviceCertificateSn: String
874
886
 
875
887
  attr_accessor :InstanceId, :DeviceCertificateSn
@@ -903,12 +915,12 @@ module TencentCloud
903
915
 
904
916
  # DeleteAuthenticator请求参数结构体
905
917
  class DeleteAuthenticatorRequest < TencentCloud::Common::AbstractModel
906
- # @param InstanceId: 实例ID
918
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
907
919
  # @type InstanceId: String
908
920
  # @param Type: 认证器类型:
909
921
  # JWT:JWT认证器
910
922
  # JWKS:JWKS认证器
911
- # BYOC:一端一证认证器
923
+ # HTTP:HTTP认证器
912
924
  # @type Type: String
913
925
 
914
926
  attr_accessor :InstanceId, :Type
@@ -942,9 +954,9 @@ module TencentCloud
942
954
 
943
955
  # DeleteAuthorizationPolicy请求参数结构体
944
956
  class DeleteAuthorizationPolicyRequest < TencentCloud::Common::AbstractModel
945
- # @param InstanceId: 实例ID
957
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
946
958
  # @type InstanceId: String
947
- # @param Id: 策略规则id
959
+ # @param Id: 授权策略规则id,可以从 [DescribeAuthorizationPolicies](https://cloud.tencent.com/document/api/1778/111074)接口获得。
948
960
  # @type Id: Integer
949
961
 
950
962
  attr_accessor :InstanceId, :Id
@@ -978,9 +990,9 @@ module TencentCloud
978
990
 
979
991
  # DeleteCaCertificate请求参数结构体
980
992
  class DeleteCaCertificateRequest < TencentCloud::Common::AbstractModel
981
- # @param InstanceId: 集群id
993
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
982
994
  # @type InstanceId: String
983
- # @param CaSn: 证书序列号
995
+ # @param CaSn: 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
984
996
  # @type CaSn: String
985
997
 
986
998
  attr_accessor :InstanceId, :CaSn
@@ -1050,7 +1062,7 @@ module TencentCloud
1050
1062
 
1051
1063
  # DeleteInsPublicEndpoint请求参数结构体
1052
1064
  class DeleteInsPublicEndpointRequest < TencentCloud::Common::AbstractModel
1053
- # @param InstanceId: 实例ID
1065
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1054
1066
  # @type InstanceId: String
1055
1067
 
1056
1068
  attr_accessor :InstanceId
@@ -1186,9 +1198,12 @@ module TencentCloud
1186
1198
 
1187
1199
  # DescribeAuthenticator请求参数结构体
1188
1200
  class DescribeAuthenticatorRequest < TencentCloud::Common::AbstractModel
1189
- # @param InstanceId: 实例ID
1201
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1190
1202
  # @type InstanceId: String
1191
- # @param Type: 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 HTTP:HTTP认证器
1203
+ # @param Type: 认证器类型:
1204
+ # JWT:JWT认证器
1205
+ # JWKS:JWKS认证器
1206
+ # HTTP:HTTP认证器
1192
1207
  # @type Type: String
1193
1208
 
1194
1209
  attr_accessor :InstanceId, :Type
@@ -1233,7 +1248,7 @@ module TencentCloud
1233
1248
 
1234
1249
  # DescribeAuthorizationPolicies请求参数结构体
1235
1250
  class DescribeAuthorizationPoliciesRequest < TencentCloud::Common::AbstractModel
1236
- # @param InstanceId: 集群ID
1251
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1237
1252
  # @type InstanceId: String
1238
1253
 
1239
1254
  attr_accessor :InstanceId
@@ -1360,7 +1375,7 @@ module TencentCloud
1360
1375
 
1361
1376
  # DescribeCaCertificates请求参数结构体
1362
1377
  class DescribeCaCertificatesRequest < TencentCloud::Common::AbstractModel
1363
- # @param InstanceId: 集群ID
1378
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1364
1379
  # @type InstanceId: String
1365
1380
 
1366
1381
  attr_accessor :InstanceId
@@ -1403,7 +1418,7 @@ module TencentCloud
1403
1418
 
1404
1419
  # DescribeClientList请求参数结构体
1405
1420
  class DescribeClientListRequest < TencentCloud::Common::AbstractModel
1406
- # @param InstanceId: 实例ID
1421
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1407
1422
  # @type InstanceId: String
1408
1423
  # @param ClientId: 客户端名
1409
1424
  # @type ClientId: String
@@ -1454,9 +1469,9 @@ module TencentCloud
1454
1469
 
1455
1470
  # DescribeDeviceCertificate请求参数结构体
1456
1471
  class DescribeDeviceCertificateRequest < TencentCloud::Common::AbstractModel
1457
- # @param DeviceCertificateSn: 设备证书sn
1472
+ # @param DeviceCertificateSn: 设备证书的SN序列号,用于唯一标识一个设备证书。
1458
1473
  # @type DeviceCertificateSn: String
1459
- # @param InstanceId: 集群id
1474
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1460
1475
  # @type InstanceId: String
1461
1476
 
1462
1477
  attr_accessor :DeviceCertificateSn, :InstanceId
@@ -1474,17 +1489,21 @@ module TencentCloud
1474
1489
 
1475
1490
  # DescribeDeviceCertificate返回参数结构体
1476
1491
  class DescribeDeviceCertificateResponse < TencentCloud::Common::AbstractModel
1477
- # @param CreatedTime: 创建时间
1492
+ # @param CreatedTime: 创建时间,毫秒级时间戳 。
1478
1493
  # @type CreatedTime: Integer
1479
- # @param UpdateTime: 上次更新时间
1494
+ # @param UpdateTime: 上次更新时间,毫秒级时间戳 。
1480
1495
  # @type UpdateTime: Integer
1481
- # @param NotAfterTime: 证书失效日期
1496
+ # @param NotAfterTime: 证书失效日期,毫秒级时间戳 。
1482
1497
  # @type NotAfterTime: Integer
1483
- # @param LastActivationTime: 上次激活时间
1498
+ # @param LastActivationTime: 上次激活时间,毫秒级时间戳 。
1484
1499
  # @type LastActivationTime: Integer
1485
- # @param LastInactivationTime: 上次取消激活时间
1500
+ # @param LastInactivationTime: 上次取消激活时间,毫秒级时间戳 。
1486
1501
  # @type LastInactivationTime: Integer
1487
- # @param Status: 证书状态
1502
+ # @param Status: 设备证书的状态
1503
+ # ACTIVE:激活
1504
+ # INACTIVE:未激活
1505
+ # REVOKED:吊销
1506
+ # PENDING_ACTIVATION:注册待激活
1488
1507
  # @type Status: String
1489
1508
  # @param CaSn: Ca证书序列号
1490
1509
  # @type CaSn: String
@@ -1494,14 +1513,15 @@ module TencentCloud
1494
1513
  # @type DeviceCertificate: String
1495
1514
  # @param DeviceCertificateCn: 设备证书common name
1496
1515
  # @type DeviceCertificateCn: String
1497
- # @param Format: 证书格式
1516
+ # @param Format: 证书格式,当前仅支持PEM格式
1498
1517
  # @type Format: String
1499
1518
  # @param ClientId: 客户端id
1500
1519
  # @type ClientId: String
1501
- # @param CertificateSource: API, 手动注册
1502
- # JITP 自动注册
1520
+ # @param CertificateSource: 证书来源
1521
+ # API:手动注册
1522
+ # JITP:自动注册
1503
1523
  # @type CertificateSource: String
1504
- # @param NotBeforeTime: 证书生效开始时间
1524
+ # @param NotBeforeTime: 证书生效开始时间,毫秒级时间戳 。
1505
1525
  # @type NotBeforeTime: Integer
1506
1526
  # @param OrganizationalUnit: 组织单位
1507
1527
  # @type OrganizationalUnit: String
@@ -1551,9 +1571,17 @@ module TencentCloud
1551
1571
 
1552
1572
  # DescribeDeviceCertificates请求参数结构体
1553
1573
  class DescribeDeviceCertificatesRequest < TencentCloud::Common::AbstractModel
1554
- # @param InstanceId: 集群ID
1574
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1555
1575
  # @type InstanceId: String
1556
- # @param Filters: 过滤器支持ClientId、CaSn、DeviceCertificateSn、Status搜索
1576
+ # @param Filters: 支持搜索参数
1577
+ # ClientId:客户端id
1578
+ # CaSn:所属的CA证书SN
1579
+ # DeviceCertificateSn:设备证书SN
1580
+ # DeviceCertificateCn:设备证书CN
1581
+ # OrganizationalUnit:证书OU
1582
+ # NotAfterEnd:过期时间小于等于指定时间的证书
1583
+ # NotAfterStart:过期时间大于等于指定时间的证书
1584
+ # Status:证书状态
1557
1585
  # @type Filters: Array
1558
1586
  # @param Limit: 分页limit
1559
1587
  # @type Limit: Integer
@@ -1624,7 +1652,7 @@ module TencentCloud
1624
1652
 
1625
1653
  # DescribeInsPublicEndpoints请求参数结构体
1626
1654
  class DescribeInsPublicEndpointsRequest < TencentCloud::Common::AbstractModel
1627
- # @param InstanceId: 实例ID
1655
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1628
1656
  # @type InstanceId: String
1629
1657
 
1630
1658
  attr_accessor :InstanceId
@@ -1644,7 +1672,7 @@ module TencentCloud
1644
1672
  # @type Endpoints: Array
1645
1673
  # @param InstanceId: 实例id
1646
1674
  # @type InstanceId: String
1647
- # @param Bandwidth: 带宽
1675
+ # @param Bandwidth: 带宽,单位Mbps
1648
1676
  # @type Bandwidth: Integer
1649
1677
  # @param Rules: 公网访问规则
1650
1678
  # @type Rules: Array
@@ -1695,7 +1723,7 @@ module TencentCloud
1695
1723
 
1696
1724
  # DescribeInsVPCEndpoints请求参数结构体
1697
1725
  class DescribeInsVPCEndpointsRequest < TencentCloud::Common::AbstractModel
1698
- # @param InstanceId: 实例ID
1726
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1699
1727
  # @type InstanceId: String
1700
1728
 
1701
1729
  attr_accessor :InstanceId
@@ -2099,14 +2127,14 @@ module TencentCloud
2099
2127
 
2100
2128
  # DescribeTopicList请求参数结构体
2101
2129
  class DescribeTopicListRequest < TencentCloud::Common::AbstractModel
2102
- # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2130
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2103
2131
  # @type InstanceId: String
2104
2132
  # @param Filters: 查询条件列表:
2105
2133
  # 支持TopicName模糊查询
2106
2134
  # @type Filters: Array
2107
- # @param Offset: 查询起始位置
2135
+ # @param Offset: 查询起始位置,默认0。
2108
2136
  # @type Offset: Integer
2109
- # @param Limit: 查询结果限制数量
2137
+ # @param Limit: 查询结果限制数量,默认0,最大20
2110
2138
  # @type Limit: Integer
2111
2139
 
2112
2140
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -2218,14 +2246,14 @@ module TencentCloud
2218
2246
 
2219
2247
  # DescribeUserList请求参数结构体
2220
2248
  class DescribeUserListRequest < TencentCloud::Common::AbstractModel
2221
- # @param InstanceId: 实例ID
2249
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2222
2250
  # @type InstanceId: String
2223
2251
  # @param Filters: 查询条件列表支持字段
2224
- # Username:Username模糊查询
2252
+ # Username:按照【用户名】进行过滤,支持模糊过滤,类型:String
2225
2253
  # @type Filters: Array
2226
- # @param Offset: 查询起始位置
2254
+ # @param Offset: 查询起始位置,默认值0
2227
2255
  # @type Offset: Integer
2228
- # @param Limit: 查询结果限制数量
2256
+ # @param Limit: 查询结果限制数量,默认值20,最大值100
2229
2257
  # @type Limit: Integer
2230
2258
 
2231
2259
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -2427,15 +2455,30 @@ module TencentCloud
2427
2455
 
2428
2456
  # MQTT认证器信息
2429
2457
  class MQTTAuthenticatorItem < TencentCloud::Common::AbstractModel
2430
- # @param Type: 认证器类型: JWT:JWT认证器 JWKS:JWKS认证器 BYOC:一端一证认证器
2458
+ # @param Type: 认证器类型
2459
+ # JWT:JWT认证器
2460
+ # JWKS:JWKS认证器
2461
+ # HTTP:HTTP认证器
2431
2462
  # @type Type: String
2432
- # @param Config: 认证器配置
2463
+ # @param Config: HTTP认证器
2464
+ # headers(请求头):标准请求头和自定义请求头
2465
+ # endpoint(接入点):认证服务器接入点
2466
+ # method(http请求方法):POST/GET
2467
+ # readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
2468
+ # connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
2469
+ # body(请求体):http请求体
2470
+ # concurrency(并发数):最大并发请求数
2471
+ # 样例:{"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}
2472
+
2473
+ # 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
2433
2474
  # @type Config: String
2434
2475
  # @param Status: 认证器状态
2476
+ # open:认证器打开
2477
+ # close:认证器关闭
2435
2478
  # @type Status: String
2436
- # @param CreateTime: 创建时间
2479
+ # @param CreateTime: 创建时间,毫秒级时间戳 。
2437
2480
  # @type CreateTime: Integer
2438
- # @param Remark: 说明
2481
+ # @param Remark: 说明,最长 128 字符。
2439
2482
  # @type Remark: String
2440
2483
 
2441
2484
  attr_accessor :Type, :Config, :Status, :CreateTime, :Remark
@@ -2459,21 +2502,24 @@ module TencentCloud
2459
2502
 
2460
2503
  # MQTT客户端信息
2461
2504
  class MQTTClientInfo < TencentCloud::Common::AbstractModel
2462
- # @param ClientId: 客户端唯一标识
2505
+ # @param ClientId: 客户端ID
2463
2506
  # @type ClientId: String
2464
2507
  # @param ClientAddress: 客户端网络地址
2465
2508
  # @type ClientAddress: String
2466
- # @param ProtocolVersion: MQTT 协议版本,4 表示 MQTT 3.1.1
2509
+ # @param ProtocolVersion: MQTT 协议版本
2510
+ # 3:表示MQTT 3.1版本
2511
+ # 4:表示 MQTT 3.1.1
2512
+ # 5: 标识MQTT 5.0协议
2467
2513
  # @type ProtocolVersion: Integer
2468
2514
  # @param Keepalive: 保持连接时间,单位:秒
2469
2515
  # @type Keepalive: Integer
2470
2516
  # @param ConnectionStatus: 连接状态,CONNECTED 已连接,DISCONNECTED 未连接
2471
2517
  # @type ConnectionStatus: String
2472
- # @param CreateTime: 客户端创建时间
2518
+ # @param CreateTime: 客户端创建时间,毫秒级时间戳 。
2473
2519
  # @type CreateTime: Integer
2474
- # @param ConnectTime: 上次建立连接时间
2520
+ # @param ConnectTime: 上次建立连接时间,毫秒级时间戳 。
2475
2521
  # @type ConnectTime: Integer
2476
- # @param DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
2522
+ # @param DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义,毫秒级时间戳 。
2477
2523
  # @type DisconnectTime: Integer
2478
2524
  # @param MQTTClientSubscriptions: 客户端的订阅列表
2479
2525
  # @type MQTTClientSubscriptions: Array
@@ -2517,6 +2563,9 @@ module TencentCloud
2517
2563
  # @param TopicFilter: topic 订阅
2518
2564
  # @type TopicFilter: String
2519
2565
  # @param Qos: 服务质量等级
2566
+ # 0: 至多一次
2567
+ # 1: 至少一次
2568
+ # 2: 恰好一次
2520
2569
  # @type Qos: Integer
2521
2570
  # @param Lag: 堆积数量
2522
2571
  # @type Lag: Integer
@@ -2767,9 +2816,9 @@ module TencentCloud
2767
2816
  # @type Password: String
2768
2817
  # @param Remark: 备注信息
2769
2818
  # @type Remark: String
2770
- # @param CreatedTime: 创建时间,秒为单位
2819
+ # @param CreatedTime: 创建时间,毫秒级时间戳 。
2771
2820
  # @type CreatedTime: Integer
2772
- # @param ModifiedTime: 修改时间,秒为单位
2821
+ # @param ModifiedTime: 修改时间,毫秒级时间戳 。
2773
2822
  # @type ModifiedTime: Integer
2774
2823
 
2775
2824
  attr_accessor :Username, :Password, :Remark, :CreatedTime, :ModifiedTime
@@ -3231,11 +3280,11 @@ module TencentCloud
3231
3280
 
3232
3281
  # ModifyTopic请求参数结构体
3233
3282
  class ModifyTopicRequest < TencentCloud::Common::AbstractModel
3234
- # @param InstanceId: 实例ID
3283
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3235
3284
  # @type InstanceId: String
3236
- # @param Topic: 主题
3285
+ # @param Topic: 主题,不能为空,只能包含字母、数字、“-”及“_”,3-100 字符。
3237
3286
  # @type Topic: String
3238
- # @param Remark: 备注信息
3287
+ # @param Remark: 备注信息,最长 128 字符
3239
3288
  # @type Remark: String
3240
3289
 
3241
3290
  attr_accessor :InstanceId, :Topic, :Remark
@@ -3271,11 +3320,11 @@ module TencentCloud
3271
3320
 
3272
3321
  # ModifyUser请求参数结构体
3273
3322
  class ModifyUserRequest < TencentCloud::Common::AbstractModel
3274
- # @param InstanceId: 实例ID
3323
+ # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3275
3324
  # @type InstanceId: String
3276
3325
  # @param Username: 用户名
3277
3326
  # @type Username: String
3278
- # @param Remark: 备注
3327
+ # @param Remark: 备注,长度不超过128个字符。
3279
3328
  # @type Remark: String
3280
3329
 
3281
3330
  attr_accessor :InstanceId, :Username, :Remark
@@ -3420,9 +3469,9 @@ module TencentCloud
3420
3469
 
3421
3470
  # PublishMessage请求参数结构体
3422
3471
  class PublishMessageRequest < TencentCloud::Common::AbstractModel
3423
- # @param InstanceId: 实例ID
3472
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3424
3473
  # @type InstanceId: String
3425
- # @param Payload: 消息 payload,需要按 encoding 指定的编码方式进行编码
3474
+ # @param Payload: 消息负载 Payload,是消息的实际内容,需要按 encoding 指定的编码方式进行编码
3426
3475
  # @type Payload: String
3427
3476
  # @param TargetTopic: 消息目的主题,该参数与 TargetClientId 二选一
3428
3477
  # @type TargetTopic: String
@@ -3431,6 +3480,9 @@ module TencentCloud
3431
3480
  # @param Encoding: 消息 payload 编码,可选 plain 或 base64,默认为 plain(即不编码)
3432
3481
  # @type Encoding: String
3433
3482
  # @param Qos: 消息的服务质量等级,默认为 1
3483
+ # QoS 0(至多一次)消息发送后,不保证接收方一定收到,也不要求接收方确认。
3484
+ # QoS 1(至少一次)消息至少被接收方成功接收一次,但可能重复。
3485
+ # QoS 2(恰好一次)消息确保被接收方接收且仅接收一次,无重复。
3434
3486
  # @type Qos: Integer
3435
3487
  # @param Retain: 是否为保留消息,默认为 false,且仅支持发布到主题的消息设置为 true
3436
3488
  # @type Retain: Boolean
@@ -3656,7 +3708,7 @@ module TencentCloud
3656
3708
 
3657
3709
  # UpdateAuthorizationPolicyPriority请求参数结构体
3658
3710
  class UpdateAuthorizationPolicyPriorityRequest < TencentCloud::Common::AbstractModel
3659
- # @param InstanceId: 实例ID
3711
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3660
3712
  # @type InstanceId: String
3661
3713
  # @param Priorities: 策略ID和优先级
3662
3714
  # @type Priorities: Array
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-mqtt
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1026
4
+ version: 3.0.1027
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-03-24 00:00:00.000000000 Z
11
+ date: 2025-03-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common