tencentcloud-sdk-mqtt 3.0.1027 → 3.0.1029

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 68cbc27a06f4acad1872015b0db4a6cabc0cc9aa
4
- data.tar.gz: 6770022dc9bd2c39111ba70413bff57115e0610b
3
+ metadata.gz: b88a9df5318e3c8ed9757dca626103d00a7a95da
4
+ data.tar.gz: 91b4d3c1f17dc51209cba4b278ee4c5e5d7bddcc
5
5
  SHA512:
6
- metadata.gz: 4c7799a44b53e82cbf001d018e9555cd30ea0406a1dab993b3cb2bd3fa06795409f3d819f451e8cc05c135f3aff2f87eb923ce35bbfed9c22b1fe378639416ad
7
- data.tar.gz: 25882e8b5aa38fb42ba0035c1b4374da23b09144263c45798948f9750a9047c95ee0b8c6161905a73f096c162565baa77c62c7d038e64dda6f458c750e457966
6
+ metadata.gz: f70270e9d524920bbad50ada08c4364b12fdcbbdc42181952c9ad42faf813c90796b7257920f62a272a4c4effec3c1170c3f27233b943caa3d15c2feb03bc264
7
+ data.tar.gz: 10745c6f35ca94e37252fa5239b118e2ee80c438ddd52087bed98c3b73626c274b4bbe1cf2171877e4bef9a10657a8f0ebbe5e60ef1e645031e12274f22fdfec
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1027
1
+ 3.0.1029
@@ -802,7 +802,7 @@ module TencentCloud
802
802
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
803
803
  end
804
804
 
805
- # 查询消息列表,如查询死信,请设置ConsumerGroup参数
805
+ # 根据一级Topic查询消息列表
806
806
 
807
807
  # @param request: Request instance for DescribeMessageList.
808
808
  # @type request: :class:`Tencentcloud::mqtt::V20240516::DescribeMessageListRequest`
@@ -1023,7 +1023,7 @@ module TencentCloud
1023
1023
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1024
1024
  end
1025
1025
 
1026
- # 修改实例属性
1026
+ # 修改实例属性,只有运行中的集群可以调用该接口进行变更配置。
1027
1027
 
1028
1028
  # @param request: Request instance for ModifyInstance.
1029
1029
  # @type request: :class:`Tencentcloud::mqtt::V20240516::ModifyInstanceRequest`
@@ -1192,7 +1192,7 @@ module TencentCloud
1192
1192
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1193
1193
  end
1194
1194
 
1195
- # 注册ca证书
1195
+ # 注册CA证书(仅一机一证场景支持),可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)
1196
1196
 
1197
1197
  # @param request: Request instance for RegisterCaCertificate.
1198
1198
  # @type request: :class:`Tencentcloud::mqtt::V20240516::RegisterCaCertificateRequest`
@@ -1216,7 +1216,7 @@ module TencentCloud
1216
1216
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1217
1217
  end
1218
1218
 
1219
- # 注册设备证书
1219
+ # 注册设备证书(仅一机一证场景生效),可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817#6cb39d46-efad-4220-8f11-2e7fab207bc8)
1220
1220
 
1221
1221
  # @param request: Request instance for RegisterDeviceCertificate.
1222
1222
  # @type request: :class:`Tencentcloud::mqtt::V20240516::RegisterDeviceCertificateRequest`
@@ -19,9 +19,9 @@ module TencentCloud
19
19
  module V20240516
20
20
  # ActivateCaCertificate请求参数结构体
21
21
  class ActivateCaCertificateRequest < TencentCloud::Common::AbstractModel
22
- # @param InstanceId: 集群id
22
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
23
23
  # @type InstanceId: String
24
- # @param CaSn: 证书序列号
24
+ # @param CaSn: CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
25
25
  # @type CaSn: String
26
26
 
27
27
  attr_accessor :InstanceId, :CaSn
@@ -325,31 +325,42 @@ module TencentCloud
325
325
 
326
326
  # CreateAuthorizationPolicy请求参数结构体
327
327
  class CreateAuthorizationPolicyRequest < TencentCloud::Common::AbstractModel
328
- # @param InstanceId: 实例ID
328
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
329
329
  # @type InstanceId: String
330
- # @param PolicyName: 策略名称
330
+ # @param PolicyName: 策略名称,不能为空,3-64个字符,支持中文、字母、数字、“-”及“_”。
331
331
  # @type PolicyName: String
332
- # @param PolicyVersion: 策略版本
332
+ # @param PolicyVersion: 策略版本,默认为1,当前仅支持1
333
333
  # @type PolicyVersion: Integer
334
- # @param Priority: 策略优先级,越小越优先
334
+ # @param Priority: 策略优先级,越小越优先,不能重复
335
335
  # @type Priority: Integer
336
- # @param Effect: allow、deny
336
+ # @param Effect: 决策:
337
+ # allow 允许
338
+ # deny 拒绝
337
339
  # @type Effect: String
338
- # @param Actions: connect、pub、sub
340
+ # @param Actions: 操作
341
+ # connect:连接
342
+ # pub:发布
343
+ # sub:订阅
339
344
  # @type Actions: String
340
- # @param Retain: 1,匹配保留消息;2,匹配非保留消息,3.匹配所有消息
345
+ # @param Retain: 条件-保留消息
346
+ # 1,匹配保留消息;
347
+ # 2,匹配非保留消息,
348
+ # 3.匹配保留和非保留消息
341
349
  # @type Retain: Integer
342
- # @param Qos: 0、1、2
350
+ # @param Qos: 条件:服务质量
351
+ # 0:最多一次
352
+ # 1:最少一次
353
+ # 2:精确一次
343
354
  # @type Qos: String
344
- # @param Resources: 资源
355
+ # @param Resources: 资源,需要匹配的订阅
345
356
  # @type Resources: String
346
- # @param Username: 用户名
357
+ # @param Username: 条件-用户名
347
358
  # @type Username: String
348
- # @param ClientId: 客户端
359
+ # @param ClientId: 条件:客户端ID,支持正则
349
360
  # @type ClientId: String
350
- # @param Ip: IP地址
361
+ # @param Ip: 条件:客户端IP地址,支持IP或者CIDR
351
362
  # @type Ip: String
352
- # @param Remark: 备注信息
363
+ # @param Remark: 备注信息,最长 128 字符
353
364
  # @type Remark: String
354
365
 
355
366
  attr_accessor :InstanceId, :PolicyName, :PolicyVersion, :Priority, :Effect, :Actions, :Retain, :Qos, :Resources, :Username, :ClientId, :Ip, :Remark
@@ -389,16 +400,24 @@ module TencentCloud
389
400
 
390
401
  # CreateAuthorizationPolicy返回参数结构体
391
402
  class CreateAuthorizationPolicyResponse < TencentCloud::Common::AbstractModel
403
+ # @param InstanceId: 集群Id
404
+ # @type InstanceId: String
405
+ # @param Id: 策略id
406
+ # @type Id: Integer
392
407
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
393
408
  # @type RequestId: String
394
409
 
395
- attr_accessor :RequestId
410
+ attr_accessor :InstanceId, :Id, :RequestId
396
411
 
397
- def initialize(requestid=nil)
412
+ def initialize(instanceid=nil, id=nil, requestid=nil)
413
+ @InstanceId = instanceid
414
+ @Id = id
398
415
  @RequestId = requestid
399
416
  end
400
417
 
401
418
  def deserialize(params)
419
+ @InstanceId = params['InstanceId']
420
+ @Id = params['Id']
402
421
  @RequestId = params['RequestId']
403
422
  end
404
423
  end
@@ -803,7 +822,7 @@ module TencentCloud
803
822
  # @type InstanceId: String
804
823
  # @param Username: 用户名,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 32 个字符
805
824
  # @type Username: String
806
- # @param Password: 密码,该字段为空时候则后端会默认生成
825
+ # @param Password: 密码,该字段为空时候则后端会默认生成。用户自定义密码时,不能为空,只支持数字 大小写字母 分隔符("_","-"),不能超过 64 个字符。
807
826
  # @type Password: String
808
827
  # @param Remark: 备注,长度不超过128个字符。
809
828
  # @type Remark: String
@@ -992,7 +1011,7 @@ module TencentCloud
992
1011
  class DeleteCaCertificateRequest < TencentCloud::Common::AbstractModel
993
1012
  # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
994
1013
  # @type InstanceId: String
995
- # @param CaSn: 证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
1014
+ # @param CaSn: CA证书序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
996
1015
  # @type CaSn: String
997
1016
 
998
1017
  attr_accessor :InstanceId, :CaSn
@@ -1094,7 +1113,7 @@ module TencentCloud
1094
1113
 
1095
1114
  # DeleteInstance请求参数结构体
1096
1115
  class DeleteInstanceRequest < TencentCloud::Common::AbstractModel
1097
- # @param InstanceId: 实例ID
1116
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1098
1117
  # @type InstanceId: String
1099
1118
 
1100
1119
  attr_accessor :InstanceId
@@ -1291,9 +1310,9 @@ module TencentCloud
1291
1310
 
1292
1311
  # DescribeCaCertificate请求参数结构体
1293
1312
  class DescribeCaCertificateRequest < TencentCloud::Common::AbstractModel
1294
- # @param CaSn: ca证书sn
1313
+ # @param CaSn: CA证书的SN序列号,可以从 [DescribeCaCertificates](https://cloud.tencent.com/document/api/1778/116206)接口、控制台、证书文件中获得。
1295
1314
  # @type CaSn: String
1296
- # @param InstanceId: 集群id
1315
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1297
1316
  # @type InstanceId: String
1298
1317
 
1299
1318
  attr_accessor :CaSn, :InstanceId
@@ -1311,29 +1330,31 @@ module TencentCloud
1311
1330
 
1312
1331
  # DescribeCaCertificate返回参数结构体
1313
1332
  class DescribeCaCertificateResponse < TencentCloud::Common::AbstractModel
1314
- # @param CreatedTime: 创建时间
1333
+ # @param CreatedTime: 创建时间,毫秒级时间戳 。
1315
1334
  # @type CreatedTime: Integer
1316
- # @param UpdateTime: 上次更新时间
1335
+ # @param UpdateTime: 上次更新时间,毫秒级时间戳 。
1317
1336
  # @type UpdateTime: Integer
1318
- # @param NotAfterTime: 失效日期
1337
+ # @param NotAfterTime: 失效日期,毫秒级时间戳 。
1319
1338
  # @type NotAfterTime: Integer
1320
- # @param LastActivationTime: 上次激活时间
1339
+ # @param LastActivationTime: 上次激活时间,毫秒级时间戳 。
1321
1340
  # @type LastActivationTime: Integer
1322
- # @param LastInactivationTime: 上次吊销时间
1341
+ # @param LastInactivationTime: 上次吊销时间,毫秒级时间戳 。
1323
1342
  # @type LastInactivationTime: Integer
1324
- # @param Status: 证书状态
1343
+ # @param Status: CA证书状态
1344
+ # ACTIVE:激活
1345
+ # INACTIVE:未激活
1325
1346
  # @type Status: String
1326
1347
  # @param CaSn: 证书序列号
1327
1348
  # @type CaSn: String
1328
- # @param CaCn: common name
1349
+ # @param CaCn: 证书的CN(Common Name),证书中用于标识主体的名称,通常是域名或组织名称
1329
1350
  # @type CaCn: String
1330
1351
  # @param CaCertificate: 证书内容
1331
1352
  # @type CaCertificate: String
1332
- # @param Format: 证书格式
1353
+ # @param Format: 证书格式,当仅支持PEM格式
1333
1354
  # @type Format: String
1334
1355
  # @param CaIssuerCn: Ca证书颁发者CN
1335
1356
  # @type CaIssuerCn: String
1336
- # @param NotBeforeTime: 生效开始时间
1357
+ # @param NotBeforeTime: 生效开始时间,毫秒级时间戳 。
1337
1358
  # @type NotBeforeTime: Integer
1338
1359
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1339
1360
  # @type RequestId: String
@@ -1420,7 +1441,7 @@ module TencentCloud
1420
1441
  class DescribeClientListRequest < TencentCloud::Common::AbstractModel
1421
1442
  # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1422
1443
  # @type InstanceId: String
1423
- # @param ClientId: 客户端名
1444
+ # @param ClientId: 客户端ID
1424
1445
  # @type ClientId: String
1425
1446
  # @param Number: 客户端数量限制,最大1024,默认1024
1426
1447
  # @type Number: String
@@ -1571,23 +1592,24 @@ module TencentCloud
1571
1592
 
1572
1593
  # DescribeDeviceCertificates请求参数结构体
1573
1594
  class DescribeDeviceCertificatesRequest < TencentCloud::Common::AbstractModel
1574
- # @param InstanceId: 实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1595
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1575
1596
  # @type InstanceId: String
1576
1597
  # @param Filters: 支持搜索参数
1577
- # ClientId:客户端id
1578
- # CaSn:所属的CA证书SN
1579
- # DeviceCertificateSn:设备证书SN
1580
- # DeviceCertificateCn:设备证书CN
1598
+ # ClientId:客户端id,根据实际业务使用获取
1599
+ # CaSn:所属的CA证书SN序列号 可以从 [查询集群CA证书列表](https://cloud.tencent.com/document/api/1778/116206) 或者实际业务使用获取
1600
+ # DeviceCertificateSn:设备证书SN序列号 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
1601
+ # DeviceCertificateCn:设备证书CN 可从[查询设备证书详情](https://cloud.tencent.com/document/api/1778/113748) 获取
1581
1602
  # OrganizationalUnit:证书OU
1582
1603
  # NotAfterEnd:过期时间小于等于指定时间的证书
1583
1604
  # NotAfterStart:过期时间大于等于指定时间的证书
1584
- # Status:证书状态
1605
+ # Status:设备证书状态 ACTIVE(激活); INACTIVE(未激活)REVOKED(吊销);PENDING_ACTIVATION(注册待激活)
1585
1606
  # @type Filters: Array
1586
- # @param Limit: 分页limit
1607
+ # @param Limit: 分页limit,默认20,最大100
1587
1608
  # @type Limit: Integer
1588
- # @param Offset: 分页偏移量
1609
+ # @param Offset: 分页偏移量,默认0
1589
1610
  # @type Offset: Integer
1590
- # @param OrderBy: CREATE_TIME_DESC, 创建时间降序
1611
+ # @param OrderBy: 排序规则
1612
+ # CREATE_TIME_DESC, 创建时间降序
1591
1613
  # CREATE_TIME_ASC,创建时间升序
1592
1614
  # UPDATE_TIME_DESC,更新时间降序
1593
1615
  # UPDATE_TIME_ASC,更新时间升序
@@ -1623,7 +1645,7 @@ module TencentCloud
1623
1645
  class DescribeDeviceCertificatesResponse < TencentCloud::Common::AbstractModel
1624
1646
  # @param TotalCount: 总数
1625
1647
  # @type TotalCount: Integer
1626
- # @param Data: 设备证书
1648
+ # @param Data: 设备证书列表
1627
1649
  # @type Data: Array
1628
1650
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1629
1651
  # @type RequestId: String
@@ -1842,7 +1864,7 @@ module TencentCloud
1842
1864
 
1843
1865
  # DescribeInstance请求参数结构体
1844
1866
  class DescribeInstanceRequest < TencentCloud::Common::AbstractModel
1845
- # @param InstanceId: 实例ID
1867
+ # @param InstanceId: 实例ID [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)
1846
1868
  # @type InstanceId: String
1847
1869
 
1848
1870
  attr_accessor :InstanceId
@@ -1861,6 +1883,7 @@ module TencentCloud
1861
1883
  # @param InstanceType: 实例类型
1862
1884
  # BASIC 基础版
1863
1885
  # PRO 专业版
1886
+ # PLATINUM 铂金版
1864
1887
  # @type InstanceType: String
1865
1888
  # @param InstanceId: 实例ID
1866
1889
  # @type InstanceId: String
@@ -1876,7 +1899,7 @@ module TencentCloud
1876
1899
  # @type CreatedTime: Integer
1877
1900
  # @param Remark: 备注信息
1878
1901
  # @type Remark: String
1879
- # @param InstanceStatus: 实例状态
1902
+ # @param InstanceStatus: 实例状态, RUNNING, 运行中 MAINTAINING,维护中 ABNORMAL,异常 OVERDUE,欠费 DESTROYED,已删除 CREATING,创建中 MODIFYING,变配中 CREATE_FAILURE,创建失败 MODIFY_FAILURE,变配失败 DELETING,删除中
1880
1903
  # @type InstanceStatus: String
1881
1904
  # @param SkuCode: 实例规格
1882
1905
  # @type SkuCode: String
@@ -1892,13 +1915,13 @@ module TencentCloud
1892
1915
  # @type DeviceCertificateProvisionType: String
1893
1916
  # @param AutomaticActivation: 自动注册设备证书时是否自动激活
1894
1917
  # @type AutomaticActivation: Boolean
1895
- # @param RenewFlag: 是否自动续费
1918
+ # @param RenewFlag: 是否自动续费。仅包年包月集群生效。 1:自动续费 0:非自动续费
1896
1919
  # @type RenewFlag: Integer
1897
1920
  # @param PayMode: 计费模式, POSTPAID,按量计费 PREPAID,包年包月
1898
1921
  # @type PayMode: String
1899
- # @param ExpiryTime: 到期时间,秒为单位
1922
+ # @param ExpiryTime: 到期时间,毫秒级时间戳
1900
1923
  # @type ExpiryTime: Integer
1901
- # @param DestroyTime: 预销毁时间
1924
+ # @param DestroyTime: 预销毁时间,毫秒级时间戳
1902
1925
  # @type DestroyTime: Integer
1903
1926
  # @param X509Mode: TLS,单向认证 mTLS,双向认证 BYOC;一机一证
1904
1927
  # @type X509Mode: String
@@ -1908,12 +1931,14 @@ module TencentCloud
1908
1931
  # @type RegistrationCode: String
1909
1932
  # @param MaxSubscription: 集群最大订阅数
1910
1933
  # @type MaxSubscription: Integer
1934
+ # @param AuthorizationPolicy: 授权策略开关
1935
+ # @type AuthorizationPolicy: Boolean
1911
1936
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1912
1937
  # @type RequestId: String
1913
1938
 
1914
- attr_accessor :InstanceType, :InstanceId, :InstanceName, :TopicNum, :TopicNumLimit, :TpsLimit, :CreatedTime, :Remark, :InstanceStatus, :SkuCode, :MaxSubscriptionPerClient, :AuthorizationPolicyLimit, :ClientNumLimit, :DeviceCertificateProvisionType, :AutomaticActivation, :RenewFlag, :PayMode, :ExpiryTime, :DestroyTime, :X509Mode, :MaxCaNum, :RegistrationCode, :MaxSubscription, :RequestId
1939
+ attr_accessor :InstanceType, :InstanceId, :InstanceName, :TopicNum, :TopicNumLimit, :TpsLimit, :CreatedTime, :Remark, :InstanceStatus, :SkuCode, :MaxSubscriptionPerClient, :AuthorizationPolicyLimit, :ClientNumLimit, :DeviceCertificateProvisionType, :AutomaticActivation, :RenewFlag, :PayMode, :ExpiryTime, :DestroyTime, :X509Mode, :MaxCaNum, :RegistrationCode, :MaxSubscription, :AuthorizationPolicy, :RequestId
1915
1940
 
1916
- def initialize(instancetype=nil, instanceid=nil, instancename=nil, topicnum=nil, topicnumlimit=nil, tpslimit=nil, createdtime=nil, remark=nil, instancestatus=nil, skucode=nil, maxsubscriptionperclient=nil, authorizationpolicylimit=nil, clientnumlimit=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, renewflag=nil, paymode=nil, expirytime=nil, destroytime=nil, x509mode=nil, maxcanum=nil, registrationcode=nil, maxsubscription=nil, requestid=nil)
1941
+ def initialize(instancetype=nil, instanceid=nil, instancename=nil, topicnum=nil, topicnumlimit=nil, tpslimit=nil, createdtime=nil, remark=nil, instancestatus=nil, skucode=nil, maxsubscriptionperclient=nil, authorizationpolicylimit=nil, clientnumlimit=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, renewflag=nil, paymode=nil, expirytime=nil, destroytime=nil, x509mode=nil, maxcanum=nil, registrationcode=nil, maxsubscription=nil, authorizationpolicy=nil, requestid=nil)
1917
1942
  @InstanceType = instancetype
1918
1943
  @InstanceId = instanceid
1919
1944
  @InstanceName = instancename
@@ -1937,6 +1962,7 @@ module TencentCloud
1937
1962
  @MaxCaNum = maxcanum
1938
1963
  @RegistrationCode = registrationcode
1939
1964
  @MaxSubscription = maxsubscription
1965
+ @AuthorizationPolicy = authorizationpolicy
1940
1966
  @RequestId = requestid
1941
1967
  end
1942
1968
 
@@ -1964,25 +1990,26 @@ module TencentCloud
1964
1990
  @MaxCaNum = params['MaxCaNum']
1965
1991
  @RegistrationCode = params['RegistrationCode']
1966
1992
  @MaxSubscription = params['MaxSubscription']
1993
+ @AuthorizationPolicy = params['AuthorizationPolicy']
1967
1994
  @RequestId = params['RequestId']
1968
1995
  end
1969
1996
  end
1970
1997
 
1971
1998
  # DescribeMessageList请求参数结构体
1972
1999
  class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
1973
- # @param InstanceId: 实例ID
2000
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
1974
2001
  # @type InstanceId: String
1975
- # @param Topic: 主题
2002
+ # @param Topic: 要查询的一级Topic,可从 [查询MQTT主题列表](https://cloud.tencent.com/document/product/1778/111082) 获取。
1976
2003
  # @type Topic: String
1977
- # @param StartTime: 开始时间
2004
+ # @param StartTime: 开始时间,毫秒级时间戳 。
1978
2005
  # @type StartTime: Integer
1979
- # @param EndTime: 结束时间
2006
+ # @param EndTime: 结束时间,毫秒级时间戳 。
1980
2007
  # @type EndTime: Integer
1981
- # @param TaskRequestId: 请求任务id
2008
+ # @param TaskRequestId: 请求任务id,用于相同查询参数下查询加速,第一次查询时无需传递,第一次查询会根据本次查询参数生成查询任务ID,保留查询条件,查询下一页消息时可传递第一次查询返回的任务ID。
1982
2009
  # @type TaskRequestId: String
1983
- # @param Offset: 查询起始位置
2010
+ # @param Offset: 查询起始位置,默认0
1984
2011
  # @type Offset: Integer
1985
- # @param Limit: 查询结果限制数量
2012
+ # @param Limit: 查询结果限制数量,默认20,最大50
1986
2013
  # @type Limit: Integer
1987
2014
 
1988
2015
  attr_accessor :InstanceId, :Topic, :StartTime, :EndTime, :TaskRequestId, :Offset, :Limit
@@ -2134,7 +2161,7 @@ module TencentCloud
2134
2161
  # @type Filters: Array
2135
2162
  # @param Offset: 查询起始位置,默认0。
2136
2163
  # @type Offset: Integer
2137
- # @param Limit: 查询结果限制数量,默认0,最大20
2164
+ # @param Limit: 查询结果限制数量,默认20,最大20
2138
2165
  # @type Limit: Integer
2139
2166
 
2140
2167
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -2317,37 +2344,37 @@ module TencentCloud
2317
2344
  # @type ClientId: String
2318
2345
  # @param DeviceCertificate: 设备证书
2319
2346
  # @type DeviceCertificate: String
2320
- # @param DeviceCertificateSn: 设备证书Sn
2347
+ # @param DeviceCertificateSn: 设备证书SN序列号,用于唯一标识一个设备证书
2321
2348
  # @type DeviceCertificateSn: String
2322
2349
  # @param DeviceCertificateCn: 设备证书Cn
2323
2350
  # @type DeviceCertificateCn: String
2324
- # @param CaSn: 签发ca的序列号
2351
+ # @param CaSn: 签发该证书的CA证书的序列号
2325
2352
  # @type CaSn: String
2326
- # @param Format: 证书格式
2353
+ # @param Format: 证书格式,当前仅支持PEM
2327
2354
  # @type Format: String
2328
- # @param Status: 证书状态
2329
- # ACTIVE,//激活
2330
- # INACTIVE,//未激活
2331
- # REVOKED,//吊销
2332
- # PENDING_ACTIVATION,//注册待激活
2355
+ # @param Status: 设备证书状态
2356
+ # ACTIVE:激活
2357
+ # INACTIVE:未激活
2358
+ # REVOKED:吊销
2359
+ # PENDING_ACTIVATION:注册待激活
2333
2360
  # @type Status: String
2334
2361
  # @param OrganizationalUnit: 组织单位
2335
2362
  # @type OrganizationalUnit: String
2336
- # @param LastActivationTime: 上次激活时间
2363
+ # @param LastActivationTime: 上次激活时间,毫秒级时间戳 。
2337
2364
  # @type LastActivationTime: Integer
2338
- # @param LastInactivationTime: 上次取消激活时间
2365
+ # @param LastInactivationTime: 上次取消激活时间,毫秒级时间戳 。
2339
2366
  # @type LastInactivationTime: Integer
2340
- # @param CreatedTime: 创建时间
2367
+ # @param CreatedTime: 创建时间,毫秒级时间戳 。
2341
2368
  # @type CreatedTime: Integer
2342
- # @param UpdateTime: 预销毁时间
2369
+ # @param UpdateTime: 更新时间,毫秒级时间戳 。
2343
2370
  # @type UpdateTime: Integer
2344
2371
  # @param CertificateSource: 证书来源:
2345
2372
  # API, 手动注册
2346
2373
  # JITP 自动注册
2347
2374
  # @type CertificateSource: String
2348
- # @param NotAfterTime: 证书失效日期
2375
+ # @param NotAfterTime: 证书失效日期,毫秒级时间戳 。
2349
2376
  # @type NotAfterTime: Integer
2350
- # @param NotBeforeTime: 证书生效开始日期
2377
+ # @param NotBeforeTime: 证书生效开始日期,毫秒级时间戳 。
2351
2378
  # @type NotBeforeTime: Integer
2352
2379
 
2353
2380
  attr_accessor :ClientId, :DeviceCertificate, :DeviceCertificateSn, :DeviceCertificateCn, :CaSn, :Format, :Status, :OrganizationalUnit, :LastActivationTime, :LastInactivationTime, :CreatedTime, :UpdateTime, :CertificateSource, :NotAfterTime, :NotBeforeTime
@@ -2460,16 +2487,35 @@ module TencentCloud
2460
2487
  # JWKS:JWKS认证器
2461
2488
  # HTTP:HTTP认证器
2462
2489
  # @type Type: String
2463
- # @param Config: HTTP认证器
2490
+ # @param Config: JWT认证器字段说明
2491
+ # from(认证字段)
2492
+ # password:从password字段获取认证字段
2493
+ # username:从username字段获取认证字段
2494
+ # secret(签名方式)
2495
+ # hmac-based:hmac-based签名方式
2496
+ # public-key:public-key签名方式
2497
+ # secret(密钥),hmac-based需要配置密钥
2498
+ # public-key(公钥),public-key签名方式需要配置
2499
+ # 样例:{"from":"password","secret":"secret282698","algorithm":"hmac-based"}
2500
+
2501
+ # JWKS认证器字段说明
2502
+ # endpoint(接入点):公钥获取服务器接入地址
2503
+ # refreshInterval(认证内容):公钥集合刷新周期
2504
+ # from(认证字段)
2505
+ # password:从password字段获取认证字段
2506
+ # username:从username字段获取认证字段
2507
+ # text:公钥集合
2508
+ # 样例:{"endpoint":"127.0.0.1","refreshInterval":60,"from":"password"}
2509
+
2510
+ # HTTP认证器
2464
2511
  # headers(请求头):标准请求头和自定义请求头
2465
2512
  # endpoint(接入点):认证服务器接入点
2466
2513
  # method(http请求方法):POST/GET
2467
2514
  # readTimeout(读超时时间):读取认证服务器数据超时时间,单位秒
2468
2515
  # connectTimeout(连接超时时间):连接认证服务器超时时间,单位秒
2469
2516
  # body(请求体):http请求体
2470
- # concurrency(并发数):最大并发请求数
2517
+ # concurrency(并发数):最大并发请求数量
2471
2518
  # 样例:{"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
2519
  # 参考 [认证管理概述](https://cloud.tencent.com/document/product/1778/114813)
2474
2520
  # @type Config: String
2475
2521
  # @param Status: 认证器状态
@@ -2509,7 +2555,7 @@ module TencentCloud
2509
2555
  # @param ProtocolVersion: MQTT 协议版本
2510
2556
  # 3:表示MQTT 3.1版本
2511
2557
  # 4:表示 MQTT 3.1.1
2512
- # 5: 标识MQTT 5.0协议
2558
+ # 5:表示MQTT 5.0协议
2513
2559
  # @type ProtocolVersion: Integer
2514
2560
  # @param Keepalive: 保持连接时间,单位:秒
2515
2561
  # @type Keepalive: Integer
@@ -2670,7 +2716,7 @@ module TencentCloud
2670
2716
  # @type MaxSubscriptionPerClient: Integer
2671
2717
  # @param ClientNumLimit: 客户端连接数上线
2672
2718
  # @type ClientNumLimit: Integer
2673
- # @param RenewFlag: 是否自动续费。仅包年包月就去那生效。
2719
+ # @param RenewFlag: 是否自动续费。仅包年包月集群生效。
2674
2720
  # 1:自动续费
2675
2721
  # 0:非自动续费
2676
2722
  # @type RenewFlag: Integer
@@ -2746,7 +2792,7 @@ module TencentCloud
2746
2792
  # @type Keys: String
2747
2793
  # @param ProducerAddr: 客户端地址
2748
2794
  # @type ProducerAddr: String
2749
- # @param ProduceTime: 消息发送时间
2795
+ # @param ProduceTime: 消息发送时间,格式 日期时间:YYYY-MM-DD hh:mm:ss
2750
2796
  # @type ProduceTime: String
2751
2797
  # @param DeadLetterResendTimes: 死信重发次数
2752
2798
  # @type DeadLetterResendTimes: Integer
@@ -2755,6 +2801,9 @@ module TencentCloud
2755
2801
  # @param SubTopic: 子topic
2756
2802
  # @type SubTopic: String
2757
2803
  # @param Qos: 消息质量等级
2804
+ # 0:至多一次
2805
+ # 1:至少一次
2806
+ # 2:精确一次
2758
2807
  # @type Qos: String
2759
2808
 
2760
2809
  attr_accessor :MsgId, :Tags, :Keys, :ProducerAddr, :ProduceTime, :DeadLetterResendTimes, :DeadLetterResendSuccessTimes, :SubTopic, :Qos
@@ -3112,13 +3161,14 @@ module TencentCloud
3112
3161
 
3113
3162
  # ModifyInstance请求参数结构体
3114
3163
  class ModifyInstanceRequest < TencentCloud::Common::AbstractModel
3115
- # @param InstanceId: 实例ID
3164
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3116
3165
  # @type InstanceId: String
3117
- # @param Name: 要修改实例名称
3166
+ # @param Name: 要修改实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
3118
3167
  # @type Name: String
3119
- # @param Remark: 要修改的备注信息
3168
+ # @param Remark: 要修改的备注信息,最多64个字符。
3120
3169
  # @type Remark: String
3121
- # @param SkuCode: 要变更的配置规格
3170
+ # @param SkuCode: 需要变更的配置规格
3171
+ # 基础版和增强版集群不能升配到铂金版规格,铂金版集群不能降配至基础版和增强版规格。
3122
3172
  # @type SkuCode: String
3123
3173
  # @param DeviceCertificateProvisionType: 客户端证书注册方式:
3124
3174
  # JITP:自动注册
@@ -3126,16 +3176,19 @@ module TencentCloud
3126
3176
  # @type DeviceCertificateProvisionType: String
3127
3177
  # @param AutomaticActivation: 自动注册证书是否自动激活
3128
3178
  # @type AutomaticActivation: Boolean
3179
+ # @param AuthorizationPolicy: 授权策略开关
3180
+ # @type AuthorizationPolicy: Boolean
3129
3181
 
3130
- attr_accessor :InstanceId, :Name, :Remark, :SkuCode, :DeviceCertificateProvisionType, :AutomaticActivation
3182
+ attr_accessor :InstanceId, :Name, :Remark, :SkuCode, :DeviceCertificateProvisionType, :AutomaticActivation, :AuthorizationPolicy
3131
3183
 
3132
- def initialize(instanceid=nil, name=nil, remark=nil, skucode=nil, devicecertificateprovisiontype=nil, automaticactivation=nil)
3184
+ def initialize(instanceid=nil, name=nil, remark=nil, skucode=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, authorizationpolicy=nil)
3133
3185
  @InstanceId = instanceid
3134
3186
  @Name = name
3135
3187
  @Remark = remark
3136
3188
  @SkuCode = skucode
3137
3189
  @DeviceCertificateProvisionType = devicecertificateprovisiontype
3138
3190
  @AutomaticActivation = automaticactivation
3191
+ @AuthorizationPolicy = authorizationpolicy
3139
3192
  end
3140
3193
 
3141
3194
  def deserialize(params)
@@ -3145,6 +3198,7 @@ module TencentCloud
3145
3198
  @SkuCode = params['SkuCode']
3146
3199
  @DeviceCertificateProvisionType = params['DeviceCertificateProvisionType']
3147
3200
  @AutomaticActivation = params['AutomaticActivation']
3201
+ @AuthorizationPolicy = params['AuthorizationPolicy']
3148
3202
  end
3149
3203
  end
3150
3204
 
@@ -3528,19 +3582,17 @@ module TencentCloud
3528
3582
 
3529
3583
  # RegisterCaCertificate请求参数结构体
3530
3584
  class RegisterCaCertificateRequest < TencentCloud::Common::AbstractModel
3531
- # @param InstanceId: 集群id
3585
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3532
3586
  # @type InstanceId: String
3533
- # @param CaCertificate: CA证书
3587
+ # @param CaCertificate: CA证书内容,自签CA可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 签发自签CA
3534
3588
  # @type CaCertificate: String
3535
- # @param VerificationCertificate: 验证证书
3589
+ # @param VerificationCertificate: 验证证书内容,可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) 手动注册CA证书章节
3536
3590
  # @type VerificationCertificate: String
3537
- # @param Format: 证书格式,不传默认PEM格式
3591
+ # @param Format: 证书格式,不传默认PEM格式,当前仅支持PEM格式
3538
3592
  # @type Format: String
3539
3593
  # @param Status: 证书状态,不传默认ACTIVE状态
3540
- # ACTIVE,//激活
3541
- # INACTIVE,//未激活
3542
- # REVOKED,//吊销
3543
- # PENDING_ACTIVATION,//注册待激活
3594
+ # ACTIVE:激活
3595
+ # INACTIVE:未激活
3544
3596
  # @type Status: String
3545
3597
 
3546
3598
  attr_accessor :InstanceId, :CaCertificate, :VerificationCertificate, :Format, :Status
@@ -3580,17 +3632,21 @@ module TencentCloud
3580
3632
 
3581
3633
  # RegisterDeviceCertificate请求参数结构体
3582
3634
  class RegisterDeviceCertificateRequest < TencentCloud::Common::AbstractModel
3583
- # @param InstanceId: 集群id
3635
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3584
3636
  # @type InstanceId: String
3585
- # @param DeviceCertificate: 设备证书
3637
+ # @param DeviceCertificate: 设备证书内容,可参考 [使用 CA 证书生成服务端/客户端证书](https://cloud.tencent.com/document/product/1778/114817#aab79cc8-a148-412e-beb8-9c9e158eb944) 生成
3586
3638
  # @type DeviceCertificate: String
3587
3639
  # @param CaSn: 关联的CA证书SN
3588
3640
  # @type CaSn: String
3589
- # @param ClientId: 客户端ID
3641
+ # @param ClientId: 客户端ID,需要关联该证书的客户端ID。根据实际业务使用填写
3590
3642
  # @type ClientId: String
3591
- # @param Format: 证书格式
3643
+ # @param Format: 证书格式,默认为PEM,当前仅支持PEM格式
3592
3644
  # @type Format: String
3593
- # @param Status: ACTIVE,//激活 INACTIVE,//未激活 REVOKED,//吊销 PENDING_ACTIVATION,//注册待激活
3645
+ # @param Status: 客户端证书状态,默认激活状态(ACTIVE
3646
+ # ACTIVE:激活
3647
+ # INACTIVE:未激活
3648
+ # REVOKED:吊销
3649
+ # PENDING_ACTIVATION:注册待激活
3594
3650
  # @type Status: String
3595
3651
 
3596
3652
  attr_accessor :InstanceId, :DeviceCertificate, :CaSn, :ClientId, :Format, :Status
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.1027
4
+ version: 3.0.1029
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-25 00:00:00.000000000 Z
11
+ date: 2025-03-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common