tencentcloud-sdk-mqtt 3.0.1014 → 3.0.1015

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: 104e6defb365619cd19dcf58738991ffce17da29
4
- data.tar.gz: 31e22d73a3a5d7d1c1d9ba65a732949ff1833082
3
+ metadata.gz: 9f2b66726638d03730c699d7b4f416bcb1490c6d
4
+ data.tar.gz: 52c0e3ed8dd51db1cc052bdf73cc75352b72bbec
5
5
  SHA512:
6
- metadata.gz: ce64f20a95fff4a3674d4fae67f062fcafa095d44fcbc87855bc600797e6557ab0b9ff0b0cf66735f0a376451196da41be6e9cae0d8517cf6a98cf543ee17835
7
- data.tar.gz: 5121ad2bc15a71603286124e90c4759e07ea95887e9827981b463b00206d5644693cc46f3ed7a36cf690663bdd1df3b940186a6d16be26a830552e0ac74c7938
6
+ metadata.gz: bc4fa4a3683d4c91aca5f3da668153d3006a28b9040d14d98bf4424834736ada5246430f4af60932b5b0f1f1af2431e5674b5d6fa2ae42615ff350f9a5bf78b1
7
+ data.tar.gz: fce1e5cae2a2aeaf8be0fb37d56c72cb49ef6458b49c6f65e630386bec942afd51ad8ac96605df54ff52a9999bb11303532b8781fb084a559b4f3229584c481a
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1014
1
+ 3.0.1015
@@ -605,6 +605,30 @@ module TencentCloud
605
605
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
606
606
  end
607
607
 
608
+ # 查询 MQTT 客户端详情
609
+
610
+ # @param request: Request instance for DescribeClientList.
611
+ # @type request: :class:`Tencentcloud::mqtt::V20240516::DescribeClientListRequest`
612
+ # @rtype: :class:`Tencentcloud::mqtt::V20240516::DescribeClientListResponse`
613
+ def DescribeClientList(request)
614
+ body = send_request('DescribeClientList', request.serialize)
615
+ response = JSON.parse(body)
616
+ if response['Response'].key?('Error') == false
617
+ model = DescribeClientListResponse.new
618
+ model.deserialize(response['Response'])
619
+ model
620
+ else
621
+ code = response['Response']['Error']['Code']
622
+ message = response['Response']['Error']['Message']
623
+ reqid = response['Response']['RequestId']
624
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
625
+ end
626
+ rescue TencentCloud::Common::TencentCloudSDKException => e
627
+ raise e
628
+ rescue StandardError => e
629
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
630
+ end
631
+
608
632
  # 查询设备证书详情接口
609
633
 
610
634
  # @param request: Request instance for DescribeDeviceCertificate.
@@ -754,6 +778,30 @@ module TencentCloud
754
778
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
755
779
  end
756
780
 
781
+ # 查询消息列表,如查询死信,请设置ConsumerGroup参数
782
+
783
+ # @param request: Request instance for DescribeMessageList.
784
+ # @type request: :class:`Tencentcloud::mqtt::V20240516::DescribeMessageListRequest`
785
+ # @rtype: :class:`Tencentcloud::mqtt::V20240516::DescribeMessageListResponse`
786
+ def DescribeMessageList(request)
787
+ body = send_request('DescribeMessageList', request.serialize)
788
+ response = JSON.parse(body)
789
+ if response['Response'].key?('Error') == false
790
+ model = DescribeMessageListResponse.new
791
+ model.deserialize(response['Response'])
792
+ model
793
+ else
794
+ code = response['Response']['Error']['Code']
795
+ message = response['Response']['Error']['Message']
796
+ reqid = response['Response']['RequestId']
797
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
798
+ end
799
+ rescue TencentCloud::Common::TencentCloudSDKException => e
800
+ raise e
801
+ rescue StandardError => e
802
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
803
+ end
804
+
757
805
  # 获取产品售卖规格
758
806
 
759
807
  # @param request: Request instance for DescribeProductSKUList.
@@ -778,6 +826,30 @@ module TencentCloud
778
826
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
779
827
  end
780
828
 
829
+ # 查询共享订阅消息堆积量
830
+
831
+ # @param request: Request instance for DescribeSharedSubscriptionLag.
832
+ # @type request: :class:`Tencentcloud::mqtt::V20240516::DescribeSharedSubscriptionLagRequest`
833
+ # @rtype: :class:`Tencentcloud::mqtt::V20240516::DescribeSharedSubscriptionLagResponse`
834
+ def DescribeSharedSubscriptionLag(request)
835
+ body = send_request('DescribeSharedSubscriptionLag', request.serialize)
836
+ response = JSON.parse(body)
837
+ if response['Response'].key?('Error') == false
838
+ model = DescribeSharedSubscriptionLagResponse.new
839
+ model.deserialize(response['Response'])
840
+ model
841
+ else
842
+ code = response['Response']['Error']['Code']
843
+ message = response['Response']['Error']['Message']
844
+ reqid = response['Response']['RequestId']
845
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
846
+ end
847
+ rescue TencentCloud::Common::TencentCloudSDKException => e
848
+ raise e
849
+ rescue StandardError => e
850
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
851
+ end
852
+
781
853
  # 查询mqtt主题详情
782
854
 
783
855
  # @param request: Request instance for DescribeTopic.
@@ -1322,6 +1322,57 @@ module TencentCloud
1322
1322
  end
1323
1323
  end
1324
1324
 
1325
+ # DescribeClientList请求参数结构体
1326
+ class DescribeClientListRequest < TencentCloud::Common::AbstractModel
1327
+ # @param InstanceId: 实例ID
1328
+ # @type InstanceId: String
1329
+ # @param ClientId: 客户端名
1330
+ # @type ClientId: String
1331
+ # @param Number: 客户端数量限制,最大1024,默认1024
1332
+ # @type Number: String
1333
+
1334
+ attr_accessor :InstanceId, :ClientId, :Number
1335
+
1336
+ def initialize(instanceid=nil, clientid=nil, number=nil)
1337
+ @InstanceId = instanceid
1338
+ @ClientId = clientid
1339
+ @Number = number
1340
+ end
1341
+
1342
+ def deserialize(params)
1343
+ @InstanceId = params['InstanceId']
1344
+ @ClientId = params['ClientId']
1345
+ @Number = params['Number']
1346
+ end
1347
+ end
1348
+
1349
+ # DescribeClientList返回参数结构体
1350
+ class DescribeClientListResponse < TencentCloud::Common::AbstractModel
1351
+ # @param Clients: 客户端列表
1352
+ # @type Clients: Array
1353
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1354
+ # @type RequestId: String
1355
+
1356
+ attr_accessor :Clients, :RequestId
1357
+
1358
+ def initialize(clients=nil, requestid=nil)
1359
+ @Clients = clients
1360
+ @RequestId = requestid
1361
+ end
1362
+
1363
+ def deserialize(params)
1364
+ unless params['Clients'].nil?
1365
+ @Clients = []
1366
+ params['Clients'].each do |i|
1367
+ mqttclientinfo_tmp = MQTTClientInfo.new
1368
+ mqttclientinfo_tmp.deserialize(i)
1369
+ @Clients << mqttclientinfo_tmp
1370
+ end
1371
+ end
1372
+ @RequestId = params['RequestId']
1373
+ end
1374
+ end
1375
+
1325
1376
  # DescribeDeviceCertificate请求参数结构体
1326
1377
  class DescribeDeviceCertificateRequest < TencentCloud::Common::AbstractModel
1327
1378
  # @param DeviceCertificateSn: 设备证书sn
@@ -1808,6 +1859,83 @@ module TencentCloud
1808
1859
  end
1809
1860
  end
1810
1861
 
1862
+ # DescribeMessageList请求参数结构体
1863
+ class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
1864
+ # @param InstanceId: 实例ID
1865
+ # @type InstanceId: String
1866
+ # @param Topic: 主题
1867
+ # @type Topic: String
1868
+ # @param StartTime: 开始时间
1869
+ # @type StartTime: Integer
1870
+ # @param EndTime: 结束时间
1871
+ # @type EndTime: Integer
1872
+ # @param TaskRequestId: 请求任务id
1873
+ # @type TaskRequestId: String
1874
+ # @param Offset: 查询起始位置
1875
+ # @type Offset: Integer
1876
+ # @param Limit: 查询结果限制数量
1877
+ # @type Limit: Integer
1878
+
1879
+ attr_accessor :InstanceId, :Topic, :StartTime, :EndTime, :TaskRequestId, :Offset, :Limit
1880
+
1881
+ def initialize(instanceid=nil, topic=nil, starttime=nil, endtime=nil, taskrequestid=nil, offset=nil, limit=nil)
1882
+ @InstanceId = instanceid
1883
+ @Topic = topic
1884
+ @StartTime = starttime
1885
+ @EndTime = endtime
1886
+ @TaskRequestId = taskrequestid
1887
+ @Offset = offset
1888
+ @Limit = limit
1889
+ end
1890
+
1891
+ def deserialize(params)
1892
+ @InstanceId = params['InstanceId']
1893
+ @Topic = params['Topic']
1894
+ @StartTime = params['StartTime']
1895
+ @EndTime = params['EndTime']
1896
+ @TaskRequestId = params['TaskRequestId']
1897
+ @Offset = params['Offset']
1898
+ @Limit = params['Limit']
1899
+ end
1900
+ end
1901
+
1902
+ # DescribeMessageList返回参数结构体
1903
+ class DescribeMessageListResponse < TencentCloud::Common::AbstractModel
1904
+ # @param TotalCount: 查询总数
1905
+ # 注意:此字段可能返回 null,表示取不到有效值。
1906
+ # @type TotalCount: Integer
1907
+ # @param Data: 消息记录列表
1908
+ # 注意:此字段可能返回 null,表示取不到有效值。
1909
+ # @type Data: Array
1910
+ # @param TaskRequestId: 请求任务id
1911
+ # @type TaskRequestId: String
1912
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1913
+ # @type RequestId: String
1914
+
1915
+ attr_accessor :TotalCount, :Data, :TaskRequestId, :RequestId
1916
+
1917
+ def initialize(totalcount=nil, data=nil, taskrequestid=nil, requestid=nil)
1918
+ @TotalCount = totalcount
1919
+ @Data = data
1920
+ @TaskRequestId = taskrequestid
1921
+ @RequestId = requestid
1922
+ end
1923
+
1924
+ def deserialize(params)
1925
+ @TotalCount = params['TotalCount']
1926
+ unless params['Data'].nil?
1927
+ @Data = []
1928
+ params['Data'].each do |i|
1929
+ mqttmessageitem_tmp = MQTTMessageItem.new
1930
+ mqttmessageitem_tmp.deserialize(i)
1931
+ @Data << mqttmessageitem_tmp
1932
+ end
1933
+ end
1934
+ @TaskRequestId = params['TaskRequestId']
1935
+ @RequestId = params['RequestId']
1936
+ end
1937
+ end
1938
+
1811
1939
  # DescribeProductSKUList请求参数结构体
1812
1940
  class DescribeProductSKUListRequest < TencentCloud::Common::AbstractModel
1813
1941
 
@@ -1852,6 +1980,46 @@ module TencentCloud
1852
1980
  end
1853
1981
  end
1854
1982
 
1983
+ # DescribeSharedSubscriptionLag请求参数结构体
1984
+ class DescribeSharedSubscriptionLagRequest < TencentCloud::Common::AbstractModel
1985
+ # @param InstanceId: 集群id
1986
+ # @type InstanceId: String
1987
+ # @param SharedSubscription: 共享订阅表达式
1988
+ # @type SharedSubscription: String
1989
+
1990
+ attr_accessor :InstanceId, :SharedSubscription
1991
+
1992
+ def initialize(instanceid=nil, sharedsubscription=nil)
1993
+ @InstanceId = instanceid
1994
+ @SharedSubscription = sharedsubscription
1995
+ end
1996
+
1997
+ def deserialize(params)
1998
+ @InstanceId = params['InstanceId']
1999
+ @SharedSubscription = params['SharedSubscription']
2000
+ end
2001
+ end
2002
+
2003
+ # DescribeSharedSubscriptionLag返回参数结构体
2004
+ class DescribeSharedSubscriptionLagResponse < TencentCloud::Common::AbstractModel
2005
+ # @param Lag: 堆积值
2006
+ # @type Lag: Integer
2007
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2008
+ # @type RequestId: String
2009
+
2010
+ attr_accessor :Lag, :RequestId
2011
+
2012
+ def initialize(lag=nil, requestid=nil)
2013
+ @Lag = lag
2014
+ @RequestId = requestid
2015
+ end
2016
+
2017
+ def deserialize(params)
2018
+ @Lag = params['Lag']
2019
+ @RequestId = params['RequestId']
2020
+ end
2021
+ end
2022
+
1855
2023
  # DescribeTopicList请求参数结构体
1856
2024
  class DescribeTopicListRequest < TencentCloud::Common::AbstractModel
1857
2025
  # @param InstanceId: 实例ID
@@ -2203,6 +2371,98 @@ module TencentCloud
2203
2371
  end
2204
2372
  end
2205
2373
 
2374
+ # MQTT客户端信息
2375
+ class MQTTClientInfo < TencentCloud::Common::AbstractModel
2376
+ # @param ClientId: 客户端唯一标识
2377
+ # 注意:此字段可能返回 null,表示取不到有效值。
2378
+ # @type ClientId: String
2379
+ # @param ClientAddress: 客户端网络地址
2380
+ # 注意:此字段可能返回 null,表示取不到有效值。
2381
+ # @type ClientAddress: String
2382
+ # @param ProtocolVersion: MQTT 协议版本,4 表示 MQTT 3.1.1
2383
+ # 注意:此字段可能返回 null,表示取不到有效值。
2384
+ # @type ProtocolVersion: Integer
2385
+ # @param Keepalive: 保持连接时间,单位:秒
2386
+ # 注意:此字段可能返回 null,表示取不到有效值。
2387
+ # @type Keepalive: Integer
2388
+ # @param ConnectionStatus: 连接状态,CONNECTED 已连接,DISCONNECTED 未连接
2389
+ # 注意:此字段可能返回 null,表示取不到有效值。
2390
+ # @type ConnectionStatus: String
2391
+ # @param CreateTime: 客户端创建时间
2392
+ # 注意:此字段可能返回 null,表示取不到有效值。
2393
+ # @type CreateTime: Integer
2394
+ # @param ConnectTime: 上次建立连接时间
2395
+ # 注意:此字段可能返回 null,表示取不到有效值。
2396
+ # @type ConnectTime: Integer
2397
+ # @param DisconnectTime: 上次断开连接时间,仅对持久会话(cleanSession=false)并且客户端当前未连接时有意义
2398
+ # 注意:此字段可能返回 null,表示取不到有效值。
2399
+ # @type DisconnectTime: Integer
2400
+ # @param MQTTClientSubscriptions: 客户端的订阅列表
2401
+ # 注意:此字段可能返回 null,表示取不到有效值。
2402
+ # @type MQTTClientSubscriptions: Array
2403
+
2404
+ attr_accessor :ClientId, :ClientAddress, :ProtocolVersion, :Keepalive, :ConnectionStatus, :CreateTime, :ConnectTime, :DisconnectTime, :MQTTClientSubscriptions
2405
+
2406
+ def initialize(clientid=nil, clientaddress=nil, protocolversion=nil, keepalive=nil, connectionstatus=nil, createtime=nil, connecttime=nil, disconnecttime=nil, mqttclientsubscriptions=nil)
2407
+ @ClientId = clientid
2408
+ @ClientAddress = clientaddress
2409
+ @ProtocolVersion = protocolversion
2410
+ @Keepalive = keepalive
2411
+ @ConnectionStatus = connectionstatus
2412
+ @CreateTime = createtime
2413
+ @ConnectTime = connecttime
2414
+ @DisconnectTime = disconnecttime
2415
+ @MQTTClientSubscriptions = mqttclientsubscriptions
2416
+ end
2417
+
2418
+ def deserialize(params)
2419
+ @ClientId = params['ClientId']
2420
+ @ClientAddress = params['ClientAddress']
2421
+ @ProtocolVersion = params['ProtocolVersion']
2422
+ @Keepalive = params['Keepalive']
2423
+ @ConnectionStatus = params['ConnectionStatus']
2424
+ @CreateTime = params['CreateTime']
2425
+ @ConnectTime = params['ConnectTime']
2426
+ @DisconnectTime = params['DisconnectTime']
2427
+ unless params['MQTTClientSubscriptions'].nil?
2428
+ @MQTTClientSubscriptions = []
2429
+ params['MQTTClientSubscriptions'].each do |i|
2430
+ mqttclientsubscription_tmp = MQTTClientSubscription.new
2431
+ mqttclientsubscription_tmp.deserialize(i)
2432
+ @MQTTClientSubscriptions << mqttclientsubscription_tmp
2433
+ end
2434
+ end
2435
+ end
2436
+ end
2437
+
2438
+ # MQTT 订阅关系
2439
+ class MQTTClientSubscription < TencentCloud::Common::AbstractModel
2440
+ # @param TopicFilter: topic 订阅
2441
+ # @type TopicFilter: String
2442
+ # @param Qos: 服务质量等级
2443
+ # @type Qos: Integer
2444
+ # @param Lag: 堆积数量
2445
+ # @type Lag: Integer
2446
+ # @param Inflight: 投递未确认数量
2447
+ # @type Inflight: Integer
2448
+
2449
+ attr_accessor :TopicFilter, :Qos, :Lag, :Inflight
2450
+
2451
+ def initialize(topicfilter=nil, qos=nil, lag=nil, inflight=nil)
2452
+ @TopicFilter = topicfilter
2453
+ @Qos = qos
2454
+ @Lag = lag
2455
+ @Inflight = inflight
2456
+ end
2457
+
2458
+ def deserialize(params)
2459
+ @TopicFilter = params['TopicFilter']
2460
+ @Qos = params['Qos']
2461
+ @Lag = params['Lag']
2462
+ @Inflight = params['Inflight']
2463
+ end
2464
+ end
2465
+
2206
2466
  # MQTTEndpoint
2207
2467
  class MQTTEndpointItem < TencentCloud::Common::AbstractModel
2208
2468
  # @param Type: 类型
@@ -2368,6 +2628,63 @@ module TencentCloud
2368
2628
  end
2369
2629
  end
2370
2630
 
2631
+ # 消息记录
2632
+ class MQTTMessageItem < TencentCloud::Common::AbstractModel
2633
+ # @param MsgId: 消息ID
2634
+ # 注意:此字段可能返回 null,表示取不到有效值。
2635
+ # @type MsgId: String
2636
+ # @param Tags: 消息tag
2637
+ # 注意:此字段可能返回 null,表示取不到有效值。
2638
+ # @type Tags: String
2639
+ # @param Keys: 消息key
2640
+ # 注意:此字段可能返回 null,表示取不到有效值。
2641
+ # @type Keys: String
2642
+ # @param ProducerAddr: 客户端地址
2643
+ # 注意:此字段可能返回 null,表示取不到有效值。
2644
+ # @type ProducerAddr: String
2645
+ # @param ProduceTime: 消息发送时间
2646
+ # 注意:此字段可能返回 null,表示取不到有效值。
2647
+ # @type ProduceTime: String
2648
+ # @param DeadLetterResendTimes: 死信重发次数
2649
+ # 注意:此字段可能返回 null,表示取不到有效值。
2650
+ # @type DeadLetterResendTimes: Integer
2651
+ # @param DeadLetterResendSuccessTimes: 死信重发成功次数
2652
+ # 注意:此字段可能返回 null,表示取不到有效值。
2653
+ # @type DeadLetterResendSuccessTimes: Integer
2654
+ # @param SubTopic: 子topic
2655
+ # 注意:此字段可能返回 null,表示取不到有效值。
2656
+ # @type SubTopic: String
2657
+ # @param Qos: 消息质量等级
2658
+ # 注意:此字段可能返回 null,表示取不到有效值。
2659
+ # @type Qos: String
2660
+
2661
+ attr_accessor :MsgId, :Tags, :Keys, :ProducerAddr, :ProduceTime, :DeadLetterResendTimes, :DeadLetterResendSuccessTimes, :SubTopic, :Qos
2662
+
2663
+ def initialize(msgid=nil, tags=nil, keys=nil, produceraddr=nil, producetime=nil, deadletterresendtimes=nil, deadletterresendsuccesstimes=nil, subtopic=nil, qos=nil)
2664
+ @MsgId = msgid
2665
+ @Tags = tags
2666
+ @Keys = keys
2667
+ @ProducerAddr = produceraddr
2668
+ @ProduceTime = producetime
2669
+ @DeadLetterResendTimes = deadletterresendtimes
2670
+ @DeadLetterResendSuccessTimes = deadletterresendsuccesstimes
2671
+ @SubTopic = subtopic
2672
+ @Qos = qos
2673
+ end
2674
+
2675
+ def deserialize(params)
2676
+ @MsgId = params['MsgId']
2677
+ @Tags = params['Tags']
2678
+ @Keys = params['Keys']
2679
+ @ProducerAddr = params['ProducerAddr']
2680
+ @ProduceTime = params['ProduceTime']
2681
+ @DeadLetterResendTimes = params['DeadLetterResendTimes']
2682
+ @DeadLetterResendSuccessTimes = params['DeadLetterResendSuccessTimes']
2683
+ @SubTopic = params['SubTopic']
2684
+ @Qos = params['Qos']
2685
+ end
2686
+ end
2687
+
2371
2688
  # MQTT 主题详情
2372
2689
  class MQTTTopicItem < TencentCloud::Common::AbstractModel
2373
2690
  # @param InstanceId: 实例 ID
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-mqtt
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1014
4
+ version: 3.0.1015
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud