tencentcloud-sdk-trocket 3.0.1180 → 3.0.1188

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: bcdd846bc70e2e7db15c61900d95888f910fc964
4
- data.tar.gz: 6bbb413457e41a66e69ddaac418d50bdbaf1a702
3
+ metadata.gz: ebb0409799b7cf7a4cf40c4582eab38cb4ff325c
4
+ data.tar.gz: d9dc5ce3ee7f3c34b6e826e59a3769c27bb73ba4
5
5
  SHA512:
6
- metadata.gz: 0f66ebb3077591fe7d00c419af480a04faa62b5072f947f20fd8e6604d79964474be2c5bc8c0e18357ed0fb50ba24a9a44772ba29f0bd47444aae622c98b33af
7
- data.tar.gz: 84944c6d27d5c91d3a6c6332438105e9f5c9beea6b1ef755a470fd857eb89d42a1637829af0383aa1231cbeeea8196220f86855c3bde71a4ed07f9b77f31dfa0
6
+ metadata.gz: b50ea862eecf154052d7d4c556061870c88480b2e60f54be6d2ebffbebab372a3e4d108948cf5693f480a24bc33e2056ca05ffb3cae892d1471833b8575880fe
7
+ data.tar.gz: 2268b8e1111797380696bdf0bf60d5e15581f6381536806a25d89c161c24d05f1ca432207395bfb39ce4f33fde8871fbcd6297f301d89353fcf68caff067ec29
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1180
1
+ 3.0.1188
@@ -53,7 +53,8 @@ module TencentCloud
53
53
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
54
54
  end
55
55
 
56
- # 创建消费组
56
+ # 创建消费组。
57
+ # 当前 API 适用集群:5.x 集群。4.x 集群的创建消费组接口文档见 [CreateRocketMQGroup](https://cloud.tencent.com/document/api/1179/63428)。
57
58
 
58
59
  # @param request: Request instance for CreateConsumerGroup.
59
60
  # @type request: :class:`Tencentcloud::trocket::V20230308::CreateConsumerGroupRequest`
@@ -77,7 +78,8 @@ module TencentCloud
77
78
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
78
79
  end
79
80
 
80
- # 创建 RocketMQ 5.x 集群
81
+ # 创建 RocketMQ 5.x 集群。
82
+ # 当前 API 适用集群:5.x 集群。创建 4.x 专享/通用集群的接口文档见 [CreateRocketMQVipInstance](https://cloud.tencent.com/document/product/1179/95721)。
81
83
 
82
84
  # @param request: Request instance for CreateInstance.
83
85
  # @type request: :class:`Tencentcloud::trocket::V20230308::CreateInstanceRequest`
@@ -205,7 +207,8 @@ module TencentCloud
205
207
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
206
208
  end
207
209
 
208
- # 添加角色
210
+ # 添加角色。
211
+ # 当前 API 适用集群:5.x 集群。4.x 集群的创建角色接口文档见 [CreateRocketMQRole](https://cloud.tencent.com/document/product/1179/107538),给角色授权接口文档见 [CreateRocketMQEnvironmentRole](https://cloud.tencent.com/document/product/1179/107539)。
209
212
 
210
213
  # @param request: Request instance for CreateRole.
211
214
  # @type request: :class:`Tencentcloud::trocket::V20230308::CreateRoleRequest`
@@ -229,7 +232,8 @@ module TencentCloud
229
232
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
230
233
  end
231
234
 
232
- # 创建主题
235
+ # 创建 RocketMQ 主题。
236
+ # 当前 API 适用集群:5.x 集群。4.x 集群的创建主题接口文档见 [CreateRocketMQTopic](https://cloud.tencent.com/document/api/1179/63426)
233
237
 
234
238
  # @param request: Request instance for CreateTopic.
235
239
  # @type request: :class:`Tencentcloud::trocket::V20230308::CreateTopicRequest`
@@ -254,6 +258,7 @@ module TencentCloud
254
258
  end
255
259
 
256
260
  # 删除消费组。消费者组删除后,消费者组的所有配置和相关数据都会被清空,且无法找回。删除后,在线的消费者客户端会出现报错,建议您提前下线客户端。
261
+ # 当前 API 适用集群:5.x 集群。4.x 集群的删除消费组接口文档见 [DeleteRocketMQGroup](https://cloud.tencent.com/document/api/1179/63424)。
257
262
 
258
263
  # @param request: Request instance for DeleteConsumerGroup.
259
264
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteConsumerGroupRequest`
@@ -278,6 +283,7 @@ module TencentCloud
278
283
  end
279
284
 
280
285
  # 删除 RocketMQ 5.x 集群,删除前请先删除正在使用的主题、消费组和角色信息。
286
+ # 当前 API 适用集群:5.x 集群。删除 4.x 集群接口文档见 [DeleteRocketMQVipInstance](https://cloud.tencent.com/document/product/1179/95802)。
281
287
 
282
288
  # @param request: Request instance for DeleteInstance.
283
289
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteInstanceRequest`
@@ -406,6 +412,7 @@ module TencentCloud
406
412
  end
407
413
 
408
414
  # 删除角色。请确保该角色相关信息不在当前代码中被使用。删除角色后,原先使用该角色进行生产或消费消息的密钥(AccessKey 和 SecretKey)将立即失效。
415
+ # 当前 API 适用集群:5.x 集群。4.x 集群的删除角色接口文档见 [DeleteRocketMQRoles](https://cloud.tencent.com/document/product/1179/107536),删除角色授权接口文档见 [DeleteRocketMQEnvironmentRoles](https://cloud.tencent.com/document/product/1179/107537)。
409
416
 
410
417
  # @param request: Request instance for DeleteRole.
411
418
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteRoleRequest`
@@ -454,6 +461,7 @@ module TencentCloud
454
461
  end
455
462
 
456
463
  # 删除主题。主题删除后,主题的所有配置和相关数据都会被清空,且无法找回。
464
+ # 当前 API 适用集群:5.x 集群。4.x 集群的删除主题接口文档见 [DeleteRocketMQTopic](https://cloud.tencent.com/document/api/1179/63423)。
457
465
 
458
466
  # @param request: Request instance for DeleteTopic.
459
467
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteTopicRequest`
@@ -477,7 +485,8 @@ module TencentCloud
477
485
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
478
486
  end
479
487
 
480
- # 查询消费者客户端详情
488
+ # 查询消费者客户端详情。
489
+ # 当前 API 适用集群:5.x 集群。4.x 集群的查询消费者客户端详情接口文档见 [DescribeRocketMQConsumerConnectionDetail](https://cloud.tencent.com/document/product/1179/102490)。
481
490
 
482
491
  # @param request: Request instance for DescribeConsumerClient.
483
492
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerClientRequest`
@@ -502,6 +511,7 @@ module TencentCloud
502
511
  end
503
512
 
504
513
  # 查询消费组下的客户端连接列表。
514
+ # 当前 API 适用集群:5.x 集群。4.x 集群的查询消费组下的客户端列表接口文档见 [DescribeRocketMQConsumerConnections](https://cloud.tencent.com/document/product/1179/100460)。
505
515
 
506
516
  # @param request: Request instance for DescribeConsumerClientList.
507
517
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerClientListRequest`
@@ -525,7 +535,8 @@ module TencentCloud
525
535
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
526
536
  end
527
537
 
528
- # 查询消费组详情
538
+ # 查询消费组详情。
539
+ # 当前 API 适用集群:5.x 集群。4.x 集群的查询消费组详情接口文档见 [DescribeRocketMQConsumerConnections](https://cloud.tencent.com/document/product/1179/100460)。
529
540
 
530
541
  # @param request: Request instance for DescribeConsumerGroup.
531
542
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerGroupRequest`
@@ -558,6 +569,7 @@ module TencentCloud
558
569
 
559
570
  # Filters示例:
560
571
  # [{ "Name": "ConsumeMessageOrderly", "Values": ["true"] }]
572
+ # 当前 API 适用集群:5.x 集群。4.x 集群的获取消费组列表接口文档见 [DescribeRocketMQGroups](https://cloud.tencent.com/document/api/1179/63420)。
561
573
 
562
574
  # @param request: Request instance for DescribeConsumerGroupList.
563
575
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerGroupListRequest`
@@ -582,6 +594,7 @@ module TencentCloud
582
594
  end
583
595
 
584
596
  # 查询指定消费组堆积数。
597
+ # 当前 API 适用集群:4.x 集群和 5.x 集群。
585
598
 
586
599
  # @param request: Request instance for DescribeConsumerLag.
587
600
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerLagRequest`
@@ -640,6 +653,7 @@ module TencentCloud
640
653
  end
641
654
 
642
655
  # 查询 RocketMQ 5.x 集群信息。
656
+ # 当前 API 适用集群:5.x 集群。查询 4.x 专享/通用集群信息的接口文档见 [DescribeRocketMQVipInstanceDetail](https://cloud.tencent.com/document/product/1179/86725)。
643
657
 
644
658
  # @param request: Request instance for DescribeInstance.
645
659
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeInstanceRequest`
@@ -1047,6 +1061,7 @@ module TencentCloud
1047
1061
  end
1048
1062
 
1049
1063
  # 查询消息列表。如果查询死信消息,请设置ConsumerGroup参数。
1064
+ # 当前 API 适用集群:5.x 集群。4.x 集群的查询消息列表接口文档见 [DescribeRocketMQTopicMsgs](https://cloud.tencent.com/document/product/1179/97761)。
1050
1065
 
1051
1066
  # @param request: Request instance for DescribeMessageList.
1052
1067
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeMessageListRequest`
@@ -1071,6 +1086,7 @@ module TencentCloud
1071
1086
  end
1072
1087
 
1073
1088
  # 根据消息 ID 查询消息轨迹。
1089
+ # 当前 API 适用集群:5.x 集群。4.x 集群查询消息轨迹接口文档见 [DescribeRocketMQMsgTrace](https://cloud.tencent.com/document/product/1179/97760)。
1074
1090
 
1075
1091
  # @param request: Request instance for DescribeMessageTrace.
1076
1092
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeMessageTraceRequest`
@@ -1263,6 +1279,7 @@ module TencentCloud
1263
1279
 
1264
1280
  # Filters示例:
1265
1281
  # [{ "Name": "RoleName", "Values": ["test_role"] }]
1282
+ # 当前 API 适用集群:5.x 集群。4.x 集群的查询角色列表接口文档见 [DescribeRocketMQRoles](https://cloud.tencent.com/document/product/1179/107534),查询角色授权列表接口文档见 [DescribeRocketMQEnvironmentRoles](https://cloud.tencent.com/document/product/1179/107535)。
1266
1283
 
1267
1284
  # @param request: Request instance for DescribeRoleList.
1268
1285
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeRoleListRequest`
@@ -1394,6 +1411,7 @@ module TencentCloud
1394
1411
 
1395
1412
  # Filters示例:
1396
1413
  # [{ "Name": "TopicName", "Values": ["test_topic"] }]
1414
+ # 当前 API 适用集群:5.x 集群。4.x 集群的获取主题列表接口文档见 [DescribeRocketMQTopics](https://cloud.tencent.com/document/api/1179/63418)。
1397
1415
 
1398
1416
  # @param request: Request instance for DescribeTopicList.
1399
1417
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeTopicListRequest`
@@ -1417,12 +1435,13 @@ module TencentCloud
1417
1435
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1418
1436
  end
1419
1437
 
1420
- # 根据消费组获取主题列表,Filter参数使用说明如下:
1438
+ # 查询消费组订阅的主题列表,Filter参数使用说明如下:
1421
1439
 
1422
1440
  # - TopicName 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
1423
1441
 
1424
1442
  # Filters示例:
1425
1443
  # [{ "Name": "TopicName", "Values": ["test_topic"] }]
1444
+ # 当前 API 适用集群:5.x 集群。4.x 集群的查询消费组订阅的主题列表接口文档见 [DescribeRocketMQTopicsByGroup](https://cloud.tencent.com/document/product/1179/108863)。
1426
1445
 
1427
1446
  # @param request: Request instance for DescribeTopicListByGroup.
1428
1447
  # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeTopicListByGroupRequest`
@@ -1518,7 +1537,8 @@ module TencentCloud
1518
1537
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1519
1538
  end
1520
1539
 
1521
- # 修改消费组属性
1540
+ # 修改消费组属性。
1541
+ # 当前 API 适用集群:5.x 集群。4.x 集群的修改消费组属性接口文档见 [ModifyRocketMQGroup](https://cloud.tencent.com/document/api/1179/63416)。
1522
1542
 
1523
1543
  # @param request: Request instance for ModifyConsumerGroup.
1524
1544
  # @type request: :class:`Tencentcloud::trocket::V20230308::ModifyConsumerGroupRequest`
@@ -1543,6 +1563,7 @@ module TencentCloud
1543
1563
  end
1544
1564
 
1545
1565
  # 修改 RocketMQ 5.x 集群属性,仅支持修改运行中的集群。
1566
+ # 当前 API 适用集群:5.x 集群。修改 4.x 集群属性的接口文档见 [ModifyRocketMQInstance](https://cloud.tencent.com/document/product/1179/108862)。
1546
1567
 
1547
1568
  # @param request: Request instance for ModifyInstance.
1548
1569
  # @type request: :class:`Tencentcloud::trocket::V20230308::ModifyInstanceRequest`
@@ -1721,7 +1742,8 @@ module TencentCloud
1721
1742
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1722
1743
  end
1723
1744
 
1724
- # 修改角色
1745
+ # 修改角色。
1746
+ # 当前 API 适用集群:5.x 集群。4.x 集群的修改角色接口文档见 [ModifyRocketMQRole](https://cloud.tencent.com/document/product/1179/107532),修改角色的授权接口文档见 [ModifyRocketMQEnvironmentRole](https://cloud.tencent.com/document/product/1179/107533)。
1725
1747
 
1726
1748
  # @param request: Request instance for ModifyRole.
1727
1749
  # @type request: :class:`Tencentcloud::trocket::V20230308::ModifyRoleRequest`
@@ -1745,7 +1767,8 @@ module TencentCloud
1745
1767
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1746
1768
  end
1747
1769
 
1748
- # 修改主题属性
1770
+ # 修改主题属性。
1771
+ # 当前 API 适用集群:5.x 集群。4.x 集群的修改主题属性接口文档见 [ModifyRocketMQTopic](https://cloud.tencent.com/document/api/1179/63414)。
1749
1772
 
1750
1773
  # @param request: Request instance for ModifyTopic.
1751
1774
  # @type request: :class:`Tencentcloud::trocket::V20230308::ModifyTopicRequest`
@@ -1818,7 +1841,8 @@ module TencentCloud
1818
1841
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1819
1842
  end
1820
1843
 
1821
- # 重置消费位点
1844
+ # 重置消费位点。
1845
+ # 当前 API 适用集群:5.x 集群。4.x 集群的重置消费位点接口文档见 [ResetRocketMQConsumerOffSet](https://cloud.tencent.com/document/api/1179/71662)。
1822
1846
 
1823
1847
  # @param request: Request instance for ResetConsumerGroupOffset.
1824
1848
  # @type request: :class:`Tencentcloud::trocket::V20230308::ResetConsumerGroupOffsetRequest`
@@ -4794,14 +4794,20 @@ module TencentCloud
4794
4794
  # @param ExceptionDesc: 异常信息
4795
4795
  # 注意:此字段可能返回 null,表示取不到有效值。
4796
4796
  # @type ExceptionDesc: String
4797
+ # @param ConsumeStatusSource: 消费状态来源,枚举值如下:
4797
4798
 
4798
- attr_accessor :ConsumerGroup, :ConsumeStatus, :TrackType, :ExceptionDesc
4799
+ # - DIFF_OFFSET:通过服务端offset计算
4800
+ # - TRACE_REPORT:通过上报的轨迹判断
4801
+ # @type ConsumeStatusSource: String
4799
4802
 
4800
- def initialize(consumergroup=nil, consumestatus=nil, tracktype=nil, exceptiondesc=nil)
4803
+ attr_accessor :ConsumerGroup, :ConsumeStatus, :TrackType, :ExceptionDesc, :ConsumeStatusSource
4804
+
4805
+ def initialize(consumergroup=nil, consumestatus=nil, tracktype=nil, exceptiondesc=nil, consumestatussource=nil)
4801
4806
  @ConsumerGroup = consumergroup
4802
4807
  @ConsumeStatus = consumestatus
4803
4808
  @TrackType = tracktype
4804
4809
  @ExceptionDesc = exceptiondesc
4810
+ @ConsumeStatusSource = consumestatussource
4805
4811
  end
4806
4812
 
4807
4813
  def deserialize(params)
@@ -4809,6 +4815,7 @@ module TencentCloud
4809
4815
  @ConsumeStatus = params['ConsumeStatus']
4810
4816
  @TrackType = params['TrackType']
4811
4817
  @ExceptionDesc = params['ExceptionDesc']
4818
+ @ConsumeStatusSource = params['ConsumeStatusSource']
4812
4819
  end
4813
4820
  end
4814
4821
 
@@ -4913,34 +4920,34 @@ module TencentCloud
4913
4920
  class ModifyConsumerGroupRequest < TencentCloud::Common::AbstractModel
4914
4921
  # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
4915
4922
  # @type InstanceId: String
4916
- # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
4917
- # @type ConsumerGroup: String
4918
4923
  # @param ConsumeEnable: 是否开启消费
4919
4924
  # @type ConsumeEnable: Boolean
4920
4925
  # @param ConsumeMessageOrderly: 顺序投递:true
4921
4926
  # 并发投递:false
4922
4927
  # @type ConsumeMessageOrderly: Boolean
4928
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
4929
+ # @type ConsumerGroup: String
4923
4930
  # @param MaxRetryTimes: 最大重试次数,取值范围0~1000
4924
4931
  # @type MaxRetryTimes: Integer
4925
4932
  # @param Remark: 备注信息,最多 128 个字符
4926
4933
  # @type Remark: String
4927
4934
 
4928
- attr_accessor :InstanceId, :ConsumerGroup, :ConsumeEnable, :ConsumeMessageOrderly, :MaxRetryTimes, :Remark
4935
+ attr_accessor :InstanceId, :ConsumeEnable, :ConsumeMessageOrderly, :ConsumerGroup, :MaxRetryTimes, :Remark
4929
4936
 
4930
- def initialize(instanceid=nil, consumergroup=nil, consumeenable=nil, consumemessageorderly=nil, maxretrytimes=nil, remark=nil)
4937
+ def initialize(instanceid=nil, consumeenable=nil, consumemessageorderly=nil, consumergroup=nil, maxretrytimes=nil, remark=nil)
4931
4938
  @InstanceId = instanceid
4932
- @ConsumerGroup = consumergroup
4933
4939
  @ConsumeEnable = consumeenable
4934
4940
  @ConsumeMessageOrderly = consumemessageorderly
4941
+ @ConsumerGroup = consumergroup
4935
4942
  @MaxRetryTimes = maxretrytimes
4936
4943
  @Remark = remark
4937
4944
  end
4938
4945
 
4939
4946
  def deserialize(params)
4940
4947
  @InstanceId = params['InstanceId']
4941
- @ConsumerGroup = params['ConsumerGroup']
4942
4948
  @ConsumeEnable = params['ConsumeEnable']
4943
4949
  @ConsumeMessageOrderly = params['ConsumeMessageOrderly']
4950
+ @ConsumerGroup = params['ConsumerGroup']
4944
4951
  @MaxRetryTimes = params['MaxRetryTimes']
4945
4952
  @Remark = params['Remark']
4946
4953
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-trocket
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1180
4
+ version: 3.0.1188
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-12-09 00:00:00.000000000 Z
11
+ date: 2025-12-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,9 +33,9 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/v20230308/models.rb
37
- - lib/v20230308/client.rb
38
36
  - lib/tencentcloud-sdk-trocket.rb
37
+ - lib/v20230308/client.rb
38
+ - lib/v20230308/models.rb
39
39
  - lib/VERSION
40
40
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
41
41
  licenses: