tencentcloud-sdk-mqtt 3.0.1071 → 3.0.1072

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: 1ff2860713e57bc24a24197762825781d50bc108
4
- data.tar.gz: cbed74673b8f31c115a34e7ef2a3208ee3af0061
3
+ metadata.gz: 913b12768f397e27114bfebce40b4eda373a03f5
4
+ data.tar.gz: ab21e975d8ae226860da20d8f188024893ca7a40
5
5
  SHA512:
6
- metadata.gz: 9415b4b77b7efb8327780b58a5c03f4f0e6b500744fdc143bcf0e47cc91924abe8cb8568c36d22cf3303436a09361309ea7d86e4e670103eb02f5f050d3b5f44
7
- data.tar.gz: 4bb624a25fc7248b058083ecc317133bac49d07972c9dc7df0a01afa0e88337a5132b0bddfdb55e46e306da2c3f31485b509e064650e3f78e9e1efa3e6977e0e
6
+ metadata.gz: 5afa480cd7050cef80ac40e28e3b45fcedac6564481ea6a87bd469fd32135bfbb37ba0bb24396cd4b1a18e2aa14e4db7ee3c44e2cbc4980d9b10ac92c19b55f8
7
+ data.tar.gz: fcb7bd584e0cbb93f179be65d4fceea4b1ecb2a1d07804323a6384b2f8080fd5d66fa9ade90c57a7072fd77406cde98a63b745b111cf30e32168bd02546fb141
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1071
1
+ 3.0.1072
@@ -149,7 +149,7 @@ module TencentCloud
149
149
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
150
150
  end
151
151
 
152
- # 为MQTT实例创建公网接入点
152
+ # 为MQTT实例创建公网接入点,未开启公网的集群可调用。
153
153
 
154
154
  # @param request: Request instance for CreateInsPublicEndpoint.
155
155
  # @type request: :class:`Tencentcloud::mqtt::V20240516::CreateInsPublicEndpointRequest`
@@ -802,6 +802,30 @@ module TencentCloud
802
802
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
803
803
  end
804
804
 
805
+ # 根据订阅查询消息
806
+
807
+ # @param request: Request instance for DescribeMessageByTopic.
808
+ # @type request: :class:`Tencentcloud::mqtt::V20240516::DescribeMessageByTopicRequest`
809
+ # @rtype: :class:`Tencentcloud::mqtt::V20240516::DescribeMessageByTopicResponse`
810
+ def DescribeMessageByTopic(request)
811
+ body = send_request('DescribeMessageByTopic', request.serialize)
812
+ response = JSON.parse(body)
813
+ if response['Response'].key?('Error') == false
814
+ model = DescribeMessageByTopicResponse.new
815
+ model.deserialize(response['Response'])
816
+ model
817
+ else
818
+ code = response['Response']['Error']['Code']
819
+ message = response['Response']['Error']['Message']
820
+ reqid = response['Response']['RequestId']
821
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
822
+ end
823
+ rescue TencentCloud::Common::TencentCloudSDKException => e
824
+ raise e
825
+ rescue StandardError => e
826
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
827
+ end
828
+
805
829
  # 根据一级Topic查询消息列表
806
830
 
807
831
  # @param request: Request instance for DescribeMessageList.
@@ -951,7 +975,7 @@ module TencentCloud
951
975
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
952
976
  end
953
977
 
954
- # 修改策略规则
978
+ # 修改策略规则,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)
955
979
 
956
980
  # @param request: Request instance for ModifyAuthorizationPolicy.
957
981
  # @type request: :class:`Tencentcloud::mqtt::V20240516::ModifyAuthorizationPolicyRequest`
@@ -1072,7 +1096,7 @@ module TencentCloud
1072
1096
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1073
1097
  end
1074
1098
 
1075
- # 修改MQTT JWKS 认证器
1099
+ # 修改MQTT JWKS 认证器,全量配置修改,需要提交完整的修改后配置。
1076
1100
 
1077
1101
  # @param request: Request instance for ModifyJWKSAuthenticator.
1078
1102
  # @type request: :class:`Tencentcloud::mqtt::V20240516::ModifyJWKSAuthenticatorRequest`
@@ -331,18 +331,19 @@ module TencentCloud
331
331
  # @type PolicyName: String
332
332
  # @param PolicyVersion: 策略版本,默认为1,当前仅支持1
333
333
  # @type PolicyVersion: Integer
334
- # @param Priority: 策略优先级,越小越优先,不能重复
334
+ # @param Priority: 策略优先级,越小越优先,不能重复,优先级ID越小表示策略越优先检查生效。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
335
335
  # @type Priority: Integer
336
336
  # @param Effect: 决策:
337
- # allow 允许
338
- # deny 拒绝
337
+ # allow:允许符合该策略的设备的访问请求。
338
+ # deny:拒绝覆盖该策略的设备的访问请求。
339
+ # 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
339
340
  # @type Effect: String
340
- # @param Actions: 操作
341
+ # @param Actions: 操作,支持多选,多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
341
342
  # connect:连接
342
343
  # pub:发布
343
344
  # sub:订阅
344
345
  # @type Actions: String
345
- # @param Retain: 条件-保留消息
346
+ # @param Retain: 条件-保留消息,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
346
347
  # 1,匹配保留消息;
347
348
  # 2,匹配非保留消息,
348
349
  # 3.匹配保留和非保留消息
@@ -351,14 +352,15 @@ module TencentCloud
351
352
  # 0:最多一次
352
353
  # 1:最少一次
353
354
  # 2:精确一次
355
+ # 可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
354
356
  # @type Qos: String
355
- # @param Resources: 资源,需要匹配的订阅
357
+ # @param Resources: 资源,需要匹配的订阅,支持配置多条匹配规则,多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
356
358
  # @type Resources: String
357
359
  # @param Username: 条件-用户名
358
360
  # @type Username: String
359
361
  # @param ClientId: 条件:客户端ID,支持正则
360
362
  # @type ClientId: String
361
- # @param Ip: 条件:客户端IP地址,支持IP或者CIDR
363
+ # @param Ip: 条件:客户端IP地址,支持IP或者CIDR,可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
362
364
  # @type Ip: String
363
365
  # @param Remark: 备注信息,最长 128 字符
364
366
  # @type Remark: String
@@ -424,17 +426,17 @@ module TencentCloud
424
426
 
425
427
  # CreateHttpAuthenticator请求参数结构体
426
428
  class CreateHttpAuthenticatorRequest < TencentCloud::Common::AbstractModel
427
- # @param InstanceId: 实例ID
429
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
428
430
  # @type InstanceId: String
429
- # @param Endpoint: jwks端点
431
+ # @param Endpoint: jwks服务地址
430
432
  # @type Endpoint: String
431
- # @param Concurrency: 最大并发连接数,默认8,范围:1-20
433
+ # @param Concurrency: 最大并发连接数,默认8,范围:1-10
432
434
  # @type Concurrency: Integer
433
- # @param Method: 网络请求方法 GetPost,默认post
435
+ # @param Method: 网络请求方法 GETPOST,默认POST
434
436
  # @type Method: String
435
- # @param Status: 认证器是否开启:open-启用;close-关闭
437
+ # @param Status: 认证器是否开启:open-启用;close-关闭,默认open-启用
436
438
  # @type Status: String
437
- # @param Remark: 说明
439
+ # @param Remark: 说明,最多支持128个字符。
438
440
  # @type Remark: String
439
441
  # @param ConnectTimeout: 连接超时时间,单位:秒,范围:1-30
440
442
  # @type ConnectTimeout: Integer
@@ -506,7 +508,7 @@ module TencentCloud
506
508
 
507
509
  # CreateInsPublicEndpoint请求参数结构体
508
510
  class CreateInsPublicEndpointRequest < TencentCloud::Common::AbstractModel
509
- # @param InstanceId: 实例ID
511
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
510
512
  # @type InstanceId: String
511
513
  # @param Bandwidth: 带宽,单位Mbps
512
514
  # @type Bandwidth: Integer
@@ -553,31 +555,32 @@ module TencentCloud
553
555
 
554
556
  # CreateInstance请求参数结构体
555
557
  class CreateInstanceRequest < TencentCloud::Common::AbstractModel
556
- # @param InstanceType: 实例类型,
558
+ # @param InstanceType: 实例类型,需要和SkuCode保持对应关系,可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。
557
559
  # BASIC 基础版
558
560
  # PRO 专业版
561
+ # PLATINUM 铂金版
559
562
  # @type InstanceType: String
560
- # @param Name: 实例名称
563
+ # @param Name: 集群名称不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
561
564
  # @type Name: String
562
- # @param SkuCode: 商品规格,可用规格可通过接口DescribeProductSKUList查询
565
+ # @param SkuCode: 商品规格,需要和InstanceType保持对应关系,可参考 [获取MQTT产品售卖规格](https://cloud.tencent.com/document/api/1778/116232) 接口获取。
563
566
  # @type SkuCode: String
564
- # @param Remark: 备注信息
567
+ # @param Remark: 备注信息,最长 128 字符
565
568
  # @type Remark: String
566
569
  # @param TagList: 标签列表
567
570
  # @type TagList: Array
568
- # @param VpcList: 实例绑定的VPC信息
571
+ # @param VpcList: 实例绑定的VPC信息,需要传当前用户下可用的VPC和SUBNET
569
572
  # @type VpcList: Array
570
- # @param EnablePublic: 是否开启公网
573
+ # @param EnablePublic: 是否开启公网,默认false(关闭)
571
574
  # @type EnablePublic: Boolean
572
- # @param Bandwidth: 公网带宽(单位:兆)
575
+ # @param Bandwidth: 公网带宽(单位:Mbps),EnablePublic 为True时,该字段必须填写且大于0.
573
576
  # @type Bandwidth: Integer
574
- # @param IpRules: 公网访问白名单
577
+ # @param IpRules: 公网访问白名单,不传表示拒绝所有IP网络访问。
575
578
  # @type IpRules: Array
576
- # @param RenewFlag: 是否自动续费(0: 不自动续费;1: 自动续费)
579
+ # @param RenewFlag: 是否自动续费(0: 不自动续费;1: 自动续费),仅购买预付费集群时生效。默认1:自动续费
577
580
  # @type RenewFlag: Integer
578
- # @param TimeSpan: 购买时长(单位:月)
581
+ # @param TimeSpan: 购买时长(单位:月),购买预付费集群时生效,默认1m(月)。可选范围:1~12、24、36、48、60;
579
582
  # @type TimeSpan: Integer
580
- # @param PayMode: 付费模式(0: 后付费;1: 预付费)
583
+ # @param PayMode: 付费模式(0: 后付费;1: 预付费),默认0(后付费)。
581
584
  # @type PayMode: Integer
582
585
 
583
586
  attr_accessor :InstanceType, :Name, :SkuCode, :Remark, :TagList, :VpcList, :EnablePublic, :Bandwidth, :IpRules, :RenewFlag, :TimeSpan, :PayMode
@@ -656,21 +659,23 @@ module TencentCloud
656
659
 
657
660
  # CreateJWKSAuthenticator请求参数结构体
658
661
  class CreateJWKSAuthenticatorRequest < TencentCloud::Common::AbstractModel
659
- # @param InstanceId: 实例ID
662
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
660
663
  # @type InstanceId: String
661
- # @param Endpoint: jwks端点
664
+ # @param Endpoint: JWKS服务地址,(Text字段和Endpoint字段必须选择一个填写)
662
665
  # @type Endpoint: String
663
- # @param RefreshInterval: jwks刷新间隔,单位:秒
666
+ # @param RefreshInterval: 认证文本刷新间隔时间,单位:秒,最小值60,默认值60,最大值1000。填写认证服务器地址(Endpoint)时生效。
664
667
  # @type RefreshInterval: Integer
665
- # @param Text: jwks文本
668
+ # @param Text: jwks文本,(Text字段和Endpoint字段必须选择一个填写)
666
669
  # @type Text: String
667
- # @param Status: 认证器是否开启:open-启用;close-关闭
670
+ # @param Status: 认证器是否开启:open-启用;close-关闭,默认open-启用
668
671
  # @type Status: String
669
- # @param Remark: 说明
672
+ # @param Remark: 说明,不能超过 128 个字符
670
673
  # @type Remark: String
671
- # @param From: 设备连接时传递jwt的key;
672
- # username-使用用户名字段传递;
673
- # password-使用密码字段传递
674
+ # @param From: 认证字段;
675
+ # username-对应 MQTT CONNECT Packet 中 username 字段,
676
+ # password-对应 MQTT CONNECT Packet 中 password 字段。
677
+
678
+ # 默认username
674
679
  # @type From: String
675
680
 
676
681
  attr_accessor :InstanceId, :Endpoint, :RefreshInterval, :Text, :Status, :Remark, :From
@@ -714,19 +719,22 @@ module TencentCloud
714
719
 
715
720
  # CreateJWTAuthenticator请求参数结构体
716
721
  class CreateJWTAuthenticatorRequest < TencentCloud::Common::AbstractModel
717
- # @param InstanceId: 实例ID
722
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
718
723
  # @type InstanceId: String
719
- # @param Algorithm: 算法:hmac-based,public-key
724
+ # @param Algorithm: 签名方式:hmac-based,public-key
720
725
  # @type Algorithm: String
721
- # @param From: 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
726
+ # @param From: 认证字段
727
+ # password:对应 MQTT CONNECT Packet 中 password 字段,
728
+ # username:对应 MQTT CONNECT Packet 中 username 字段
729
+ # 默认username
722
730
  # @type From: String
723
- # @param Secret: 密码
731
+ # @param Secret: 密钥,Algorithm为hmac-based需要传递该字段。
724
732
  # @type Secret: String
725
- # @param PublicKey: 公钥
733
+ # @param PublicKey: 公钥,Algorithm为public-key时需要传递该字段。
726
734
  # @type PublicKey: String
727
- # @param Status: 认证器是否开启:open-启用;close-关闭
735
+ # @param Status: 认证器是否开启:open-启用;close-关闭,默认:open-启用
728
736
  # @type Status: String
729
- # @param Remark: 说明
737
+ # @param Remark: 说明,不能超过 128 个字符。
730
738
  # @type Remark: String
731
739
 
732
740
  attr_accessor :InstanceId, :Algorithm, :From, :Secret, :PublicKey, :Status, :Remark
@@ -1792,6 +1800,7 @@ module TencentCloud
1792
1800
  # InstanceName:集群名模糊搜索
1793
1801
  # InstanceId:集群id精确搜索
1794
1802
  # InstanceStatus:集群状态搜索(RUNNING-运行中,CREATING-创建中,MODIFYING-变配中,DELETING-删除中)
1803
+ # 注意:配置TagFilters时该查询条件不生效。
1795
1804
  # @type Filters: Array
1796
1805
  # @param Offset: 查询起始位置,默认0
1797
1806
  # @type Offset: Integer
@@ -1995,6 +2004,61 @@ module TencentCloud
1995
2004
  end
1996
2005
  end
1997
2006
 
2007
+ # DescribeMessageByTopic请求参数结构体
2008
+ class DescribeMessageByTopicRequest < TencentCloud::Common::AbstractModel
2009
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2010
+ # @type InstanceId: String
2011
+ # @param Topic: home/room
2012
+ # @type Topic: String
2013
+ # @param StartTime: 开始时间,毫秒级时间戳 。
2014
+ # @type StartTime: Integer
2015
+ # @param MaxNumber: 查询消息条数,最大1024,默认100.
2016
+ # @type MaxNumber: Integer
2017
+
2018
+ attr_accessor :InstanceId, :Topic, :StartTime, :MaxNumber
2019
+
2020
+ def initialize(instanceid=nil, topic=nil, starttime=nil, maxnumber=nil)
2021
+ @InstanceId = instanceid
2022
+ @Topic = topic
2023
+ @StartTime = starttime
2024
+ @MaxNumber = maxnumber
2025
+ end
2026
+
2027
+ def deserialize(params)
2028
+ @InstanceId = params['InstanceId']
2029
+ @Topic = params['Topic']
2030
+ @StartTime = params['StartTime']
2031
+ @MaxNumber = params['MaxNumber']
2032
+ end
2033
+ end
2034
+
2035
+ # DescribeMessageByTopic返回参数结构体
2036
+ class DescribeMessageByTopicResponse < TencentCloud::Common::AbstractModel
2037
+ # @param Data: 消息列表
2038
+ # @type Data: Array
2039
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2040
+ # @type RequestId: String
2041
+
2042
+ attr_accessor :Data, :RequestId
2043
+
2044
+ def initialize(data=nil, requestid=nil)
2045
+ @Data = data
2046
+ @RequestId = requestid
2047
+ end
2048
+
2049
+ def deserialize(params)
2050
+ unless params['Data'].nil?
2051
+ @Data = []
2052
+ params['Data'].each do |i|
2053
+ mqttmessage_tmp = MQTTMessage.new
2054
+ mqttmessage_tmp.deserialize(i)
2055
+ @Data << mqttmessage_tmp
2056
+ end
2057
+ end
2058
+ @RequestId = params['RequestId']
2059
+ end
2060
+ end
2061
+
1998
2062
  # DescribeMessageList请求参数结构体
1999
2063
  class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
2000
2064
  # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
@@ -2460,7 +2524,7 @@ module TencentCloud
2460
2524
  class IpRule < TencentCloud::Common::AbstractModel
2461
2525
  # @param Ip: IP地址
2462
2526
  # @type Ip: String
2463
- # @param Allow: 是否允许放行
2527
+ # @param Allow: 当前仅支持允许,默认允许。
2464
2528
  # @type Allow: Boolean
2465
2529
  # @param Remark: 备注信息
2466
2530
  # @type Remark: String
@@ -2693,7 +2757,6 @@ module TencentCloud
2693
2757
  # MAINTAINING,维护中
2694
2758
  # ABNORMAL,异常
2695
2759
  # OVERDUE,欠费
2696
- # DESTROYED,已删除
2697
2760
  # CREATING,创建中
2698
2761
  # MODIFYING,变配中
2699
2762
  # CREATE_FAILURE,创建失败
@@ -2782,6 +2845,38 @@ module TencentCloud
2782
2845
  end
2783
2846
  end
2784
2847
 
2848
+ # MQTT消息
2849
+ class MQTTMessage < TencentCloud::Common::AbstractModel
2850
+ # @param MessageId: 消息id
2851
+ # @type MessageId: String
2852
+ # @param ClientId: 消息发送的客户端Id
2853
+ # @type ClientId: String
2854
+ # @param Qos: 消息服务质量等级
2855
+ # @type Qos: String
2856
+ # @param StoreTimestamp: 消息在服务端的存储时间,毫秒级时间戳
2857
+ # @type StoreTimestamp: Integer
2858
+ # @param OriginTopic: 源topic
2859
+ # @type OriginTopic: String
2860
+
2861
+ attr_accessor :MessageId, :ClientId, :Qos, :StoreTimestamp, :OriginTopic
2862
+
2863
+ def initialize(messageid=nil, clientid=nil, qos=nil, storetimestamp=nil, origintopic=nil)
2864
+ @MessageId = messageid
2865
+ @ClientId = clientid
2866
+ @Qos = qos
2867
+ @StoreTimestamp = storetimestamp
2868
+ @OriginTopic = origintopic
2869
+ end
2870
+
2871
+ def deserialize(params)
2872
+ @MessageId = params['MessageId']
2873
+ @ClientId = params['ClientId']
2874
+ @Qos = params['Qos']
2875
+ @StoreTimestamp = params['StoreTimestamp']
2876
+ @OriginTopic = params['OriginTopic']
2877
+ end
2878
+ end
2879
+
2785
2880
  # 消息记录
2786
2881
  class MQTTMessageItem < TencentCloud::Common::AbstractModel
2787
2882
  # @param MsgId: 消息ID
@@ -2807,6 +2902,13 @@ module TencentCloud
2807
2902
  # @type Qos: String
2808
2903
 
2809
2904
  attr_accessor :MsgId, :Tags, :Keys, :ProducerAddr, :ProduceTime, :DeadLetterResendTimes, :DeadLetterResendSuccessTimes, :SubTopic, :Qos
2905
+ extend Gem::Deprecate
2906
+ deprecate :DeadLetterResendTimes, :none, 2025, 5
2907
+ deprecate :DeadLetterResendTimes=, :none, 2025, 5
2908
+ deprecate :DeadLetterResendSuccessTimes, :none, 2025, 5
2909
+ deprecate :DeadLetterResendSuccessTimes=, :none, 2025, 5
2910
+ deprecate :SubTopic, :none, 2025, 5
2911
+ deprecate :SubTopic=, :none, 2025, 5
2810
2912
 
2811
2913
  def initialize(msgid=nil, tags=nil, keys=nil, produceraddr=nil, producetime=nil, deadletterresendtimes=nil, deadletterresendsuccesstimes=nil, subtopic=nil, qos=nil)
2812
2914
  @MsgId = msgid
@@ -2891,33 +2993,44 @@ module TencentCloud
2891
2993
 
2892
2994
  # ModifyAuthorizationPolicy请求参数结构体
2893
2995
  class ModifyAuthorizationPolicyRequest < TencentCloud::Common::AbstractModel
2894
- # @param Id: 策略
2996
+ # @param Id: 授权策略ID,从 [查询授权策略](https://cloud.tencent.com/document/product/1778/111074) 接口获取
2895
2997
  # @type Id: Integer
2896
- # @param InstanceId: 实例ID
2998
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2897
2999
  # @type InstanceId: String
2898
- # @param PolicyName: 策略名称
3000
+ # @param PolicyName: 策略名称,不能为空,3-64个字符,支持中文、字母、数字、“-”及“_”。
2899
3001
  # @type PolicyName: String
2900
- # @param PolicyVersion: 策略版本
3002
+ # @param PolicyVersion: 策略版本,默认为1,当前仅支持1
2901
3003
  # @type PolicyVersion: Integer
2902
- # @param Priority: 策略优先级,越小越优先
3004
+ # @param Priority: 策略优先级,越小越优先,不能重复
2903
3005
  # @type Priority: Integer
2904
- # @param Effect: allow、deny
3006
+ # @param Effect: 决策:
3007
+ # allow 允许
3008
+ # deny 拒绝
2905
3009
  # @type Effect: String
2906
- # @param Actions: connect、pub、sub
3010
+ # @param Actions: 操作,支持多选,多个操作用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
3011
+ # connect:连接
3012
+ # pub:发布
3013
+ # sub:订阅
2907
3014
  # @type Actions: String
2908
- # @param Resources: 资源
3015
+ # @param Resources: 资源,需要匹配的订阅,支持配置多条匹配规则,多个用英文逗号隔开。可参考 [数据面授权策略说明](https://cloud.tencent.com/document/product/1778/109715)。
2909
3016
  # @type Resources: String
2910
- # @param Username: 用户名
3017
+ # @param Username: 条件-用户名
2911
3018
  # @type Username: String
2912
- # @param Retain: 1.匹配保留消息;2.匹配非保留消息;3.匹配所有消息
3019
+ # @param Retain: 条件-保留消息
3020
+ # 1,匹配保留消息;
3021
+ # 2,匹配非保留消息,
3022
+ # 3.匹配保留和非保留消息
2913
3023
  # @type Retain: Integer
2914
- # @param ClientId: 客户端
3024
+ # @param ClientId: 条件:客户端ID,支持正则
2915
3025
  # @type ClientId: String
2916
- # @param Ip: IP
3026
+ # @param Ip: 条件:客户端IP地址,支持IP或者CIDR
2917
3027
  # @type Ip: String
2918
- # @param Qos: 0、1、2
3028
+ # @param Qos: 条件:服务质量
3029
+ # 0:最多一次
3030
+ # 1:最少一次
3031
+ # 2:精确一次
2919
3032
  # @type Qos: String
2920
- # @param Remark: 备注信息
3033
+ # @param Remark: 备注信息,最长 128 字符
2921
3034
  # @type Remark: String
2922
3035
 
2923
3036
  attr_accessor :Id, :InstanceId, :PolicyName, :PolicyVersion, :Priority, :Effect, :Actions, :Resources, :Username, :Retain, :ClientId, :Ip, :Qos, :Remark
@@ -2975,19 +3088,19 @@ module TencentCloud
2975
3088
 
2976
3089
  # ModifyHttpAuthenticator请求参数结构体
2977
3090
  class ModifyHttpAuthenticatorRequest < TencentCloud::Common::AbstractModel
2978
- # @param InstanceId: 实例ID
3091
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
2979
3092
  # @type InstanceId: String
2980
- # @param Endpoint: 端点
3093
+ # @param Endpoint: 服务地址
2981
3094
  # @type Endpoint: String
2982
3095
  # @param Status: 认证器状态:open-启用;close-关闭
2983
3096
  # @type Status: String
2984
- # @param Concurrency: 最大并发连接数,默认8,范围:1-20
3097
+ # @param Concurrency: 最大并发连接数,默认8,范围:1-10
2985
3098
  # @type Concurrency: Integer
2986
3099
  # @param ConnectTimeout: 连接超时时间,单位:秒,范围:1-30
2987
3100
  # @type ConnectTimeout: Integer
2988
3101
  # @param ReadTimeout: 请求超时时间,单位:秒,范围:1-30
2989
3102
  # @type ReadTimeout: Integer
2990
- # @param Remark: 说明
3103
+ # @param Remark: 说明,最多支持128个字符。
2991
3104
  # @type Remark: String
2992
3105
  # @param Method: 请求方法,GET 或者 POST
2993
3106
  # @type Method: String
@@ -3057,7 +3170,7 @@ module TencentCloud
3057
3170
 
3058
3171
  # ModifyInsPublicEndpoint请求参数结构体
3059
3172
  class ModifyInsPublicEndpointRequest < TencentCloud::Common::AbstractModel
3060
- # @param InstanceId: 实例ID
3173
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3061
3174
  # @type InstanceId: String
3062
3175
  # @param Bandwidth: 带宽,单位:Mbps
3063
3176
  # @type Bandwidth: Integer
@@ -3104,40 +3217,41 @@ module TencentCloud
3104
3217
 
3105
3218
  # ModifyInstanceCertBinding请求参数结构体
3106
3219
  class ModifyInstanceCertBindingRequest < TencentCloud::Common::AbstractModel
3107
- # @param InstanceId: 实例ID
3220
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3108
3221
  # @type InstanceId: String
3109
- # @param SSLServerCertId: 服务端证书id
3110
- # @type SSLServerCertId: String
3111
- # @param SSLCaCertId: CA证书id
3112
- # @type SSLCaCertId: String
3113
3222
  # @param X509Mode: 加密通信方式
3114
3223
  # TLS:单向证书认证
3115
3224
  # mTLS:双向证书认证
3116
3225
  # BYOC:一设备一证书认证
3117
3226
  # @type X509Mode: String
3227
+ # @param SSLServerCertId: 服务端证书id,从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS或BYOC时为必填。
3228
+ # @type SSLServerCertId: String
3229
+ # @param SSLCaCertId: CA证书id,从 [获取证书列表](https://cloud.tencent.com/document/api/400/41671) 或者腾讯云证书服务控制台获取。X509Mode为mTLS时为必填
3230
+ # @type SSLCaCertId: String
3118
3231
  # @param DeviceCertificateProvisionType: 设备证书注册类型:
3119
- # JITP,自动注册;
3120
- # MANUAL 手动注册
3232
+ # JITP:自动注册;
3233
+ # API:手动注册
3234
+ # 默认值:API
3121
3235
  # @type DeviceCertificateProvisionType: String
3122
3236
  # @param AutomaticActivation: 是否自动激活,默认为false
3123
3237
  # @type AutomaticActivation: Boolean
3124
3238
 
3125
- attr_accessor :InstanceId, :SSLServerCertId, :SSLCaCertId, :X509Mode, :DeviceCertificateProvisionType, :AutomaticActivation
3239
+ attr_accessor :InstanceId, :X509Mode, :SSLServerCertId, :SSLCaCertId, :DeviceCertificateProvisionType, :AutomaticActivation
3126
3240
 
3127
- def initialize(instanceid=nil, sslservercertid=nil, sslcacertid=nil, x509mode=nil, devicecertificateprovisiontype=nil, automaticactivation=nil)
3241
+ def initialize(instanceid=nil, x509mode=nil, sslservercertid=nil, sslcacertid=nil, devicecertificateprovisiontype=nil, automaticactivation=nil)
3128
3242
  @InstanceId = instanceid
3243
+ @X509Mode = x509mode
3129
3244
  @SSLServerCertId = sslservercertid
3130
3245
  @SSLCaCertId = sslcacertid
3131
- @X509Mode = x509mode
3132
3246
  @DeviceCertificateProvisionType = devicecertificateprovisiontype
3133
3247
  @AutomaticActivation = automaticactivation
3134
3248
  end
3135
3249
 
3136
3250
  def deserialize(params)
3137
3251
  @InstanceId = params['InstanceId']
3252
+ @X509Mode = params['X509Mode']
3138
3253
  @SSLServerCertId = params['SSLServerCertId']
3139
3254
  @SSLCaCertId = params['SSLCaCertId']
3140
- @X509Mode = params['X509Mode']
3141
3255
  @DeviceCertificateProvisionType = params['DeviceCertificateProvisionType']
3142
3256
  @AutomaticActivation = params['AutomaticActivation']
3143
3257
  end
@@ -3165,7 +3279,7 @@ module TencentCloud
3165
3279
  # @type InstanceId: String
3166
3280
  # @param Name: 要修改实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”。
3167
3281
  # @type Name: String
3168
- # @param Remark: 要修改的备注信息,最多64个字符。
3282
+ # @param Remark: 要修改的备注信息,最多128个字符。
3169
3283
  # @type Remark: String
3170
3284
  # @param SkuCode: 需要变更的配置规格
3171
3285
  # 基础版和专业版集群不能升配到铂金版规格,铂金版集群不能降配至基础版和增强版规格。
@@ -3180,6 +3294,11 @@ module TencentCloud
3180
3294
  # @type AuthorizationPolicy: Boolean
3181
3295
 
3182
3296
  attr_accessor :InstanceId, :Name, :Remark, :SkuCode, :DeviceCertificateProvisionType, :AutomaticActivation, :AuthorizationPolicy
3297
+ extend Gem::Deprecate
3298
+ deprecate :DeviceCertificateProvisionType, :none, 2025, 5
3299
+ deprecate :DeviceCertificateProvisionType=, :none, 2025, 5
3300
+ deprecate :AutomaticActivation, :none, 2025, 5
3301
+ deprecate :AutomaticActivation=, :none, 2025, 5
3183
3302
 
3184
3303
  def initialize(instanceid=nil, name=nil, remark=nil, skucode=nil, devicecertificateprovisiontype=nil, automaticactivation=nil, authorizationpolicy=nil)
3185
3304
  @InstanceId = instanceid
@@ -3220,19 +3339,21 @@ module TencentCloud
3220
3339
 
3221
3340
  # ModifyJWKSAuthenticator请求参数结构体
3222
3341
  class ModifyJWKSAuthenticatorRequest < TencentCloud::Common::AbstractModel
3223
- # @param InstanceId: 实例ID
3342
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3224
3343
  # @type InstanceId: String
3225
- # @param Endpoint: 端点
3344
+ # @param Endpoint: JWKS服务器地址,(Text字段和Endpoint字段必须选择一个填写)
3226
3345
  # @type Endpoint: String
3227
- # @param Status: 认证器状态:open-启用;close-关闭
3346
+ # @param Status: 认证器状态:open-启用(默认);close-关闭
3228
3347
  # @type Status: String
3229
- # @param RefreshInterval: 刷新时间
3348
+ # @param RefreshInterval: 认证文本刷新间隔时间,单位:秒,最小值60,默认值60,最大值1000。填写认证服务器地址时生效。
3230
3349
  # @type RefreshInterval: Integer
3231
- # @param Text: JSKS文本
3350
+ # @param Text: JWKS文本,认证服务器地址为空时生效。(Text字段和Endpoint字段必须选择一个填写)
3232
3351
  # @type Text: String
3233
- # @param From: 设备连接时传递jwt的key;username-使用用户名字段传递;password-使用密码字段传递
3352
+ # @param From: 认证字段;
3353
+ # username-对应 MQTT CONNECT Packet 中 username 字段,
3354
+ # password-对应 MQTT CONNECT Packet 中 password 字段。默认username
3234
3355
  # @type From: String
3235
- # @param Remark: 说明
3356
+ # @param Remark: 说明,不能超过 128 个字符
3236
3357
  # @type Remark: String
3237
3358
 
3238
3359
  attr_accessor :InstanceId, :Endpoint, :Status, :RefreshInterval, :Text, :From, :Remark
@@ -3276,33 +3397,39 @@ module TencentCloud
3276
3397
 
3277
3398
  # ModifyJWTAuthenticator请求参数结构体
3278
3399
  class ModifyJWTAuthenticatorRequest < TencentCloud::Common::AbstractModel
3279
- # @param InstanceId: 实例ID
3400
+ # @param InstanceId: 腾讯云MQTT实例ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
3280
3401
  # @type InstanceId: String
3281
- # @param Algorithm: 算法:hmac-based,public-key
3402
+ # @param Algorithm: 签名方式:hmac-based,public-key
3282
3403
  # @type Algorithm: String
3283
- # @param From: 设备连接时传递jwt的key;
3284
- # username-使用用户名字段传递;
3285
- # password-使用密码字段传递
3404
+ # @param From: 认证字段
3405
+ # password:对应 MQTT CONNECT Packet 中 password 字段,
3406
+ # username:对应 MQTT CONNECT Packet 中 username 字段
3286
3407
  # @type From: String
3287
- # @param Secret: 密码
3408
+ # @param Secret: 密钥,Algorithm为hmac-based需要传递该字段。
3288
3409
  # @type Secret: String
3289
- # @param PublicKey: 公钥
3410
+ # @param PublicKey: 公钥,Algorithm为public-key时需要传递该字段。
3290
3411
  # @type PublicKey: String
3412
+ # @param Status: 认证器是否开启:open-启用;close-关闭
3413
+ # @type Status: String
3414
+ # @param Remark: 说明,不能超过 128 个字符
3415
+ # @type Remark: String
3291
3416
  # @param Text: JSKS文本
3292
3417
  # @type Text: String
3293
- # @param Remark: 说明
3294
- # @type Remark: String
3295
3418
 
3296
- attr_accessor :InstanceId, :Algorithm, :From, :Secret, :PublicKey, :Text, :Remark
3419
+ attr_accessor :InstanceId, :Algorithm, :From, :Secret, :PublicKey, :Status, :Remark, :Text
3420
+ extend Gem::Deprecate
3421
+ deprecate :Text, :none, 2025, 5
3422
+ deprecate :Text=, :none, 2025, 5
3297
3423
 
3298
- def initialize(instanceid=nil, algorithm=nil, from=nil, secret=nil, publickey=nil, text=nil, remark=nil)
3424
+ def initialize(instanceid=nil, algorithm=nil, from=nil, secret=nil, publickey=nil, status=nil, remark=nil, text=nil)
3299
3425
  @InstanceId = instanceid
3300
3426
  @Algorithm = algorithm
3301
3427
  @From = from
3302
3428
  @Secret = secret
3303
3429
  @PublicKey = publickey
3304
- @Text = text
3430
+ @Status = status
3305
3431
  @Remark = remark
3432
+ @Text = text
3306
3433
  end
3307
3434
 
3308
3435
  def deserialize(params)
@@ -3311,8 +3438,9 @@ module TencentCloud
3311
3438
  @From = params['From']
3312
3439
  @Secret = params['Secret']
3313
3440
  @PublicKey = params['PublicKey']
3314
- @Text = params['Text']
3441
+ @Status = params['Status']
3315
3442
  @Remark = params['Remark']
3443
+ @Text = params['Text']
3316
3444
  end
3317
3445
  end
3318
3446
 
@@ -3505,9 +3633,9 @@ module TencentCloud
3505
3633
  class PublicAccessRule < TencentCloud::Common::AbstractModel
3506
3634
  # @param IpRule: ip网段信息
3507
3635
  # @type IpRule: String
3508
- # @param Allow: 允许或者拒绝
3636
+ # @param Allow: 当前仅支持允许,默认允许(allow)
3509
3637
  # @type Allow: Boolean
3510
- # @param Remark: 备注信息
3638
+ # @param Remark: 备注信息,最多64个字符。
3511
3639
  # @type Remark: String
3512
3640
 
3513
3641
  attr_accessor :IpRule, :Allow, :Remark
@@ -3657,8 +3785,6 @@ module TencentCloud
3657
3785
  # @param Status: 客户端证书状态,默认激活状态(ACTIVE)
3658
3786
  # ACTIVE:激活
3659
3787
  # INACTIVE:未激活
3660
- # REVOKED:吊销
3661
- # PENDING_ACTIVATION:注册待激活
3662
3788
  # @type Status: String
3663
3789
 
3664
3790
  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.1071
4
+ version: 3.0.1072
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-05-29 00:00:00.000000000 Z
11
+ date: 2025-06-01 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common