tencentcloud-sdk-trocket 3.0.1088 → 3.0.1089

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: 55a1aa4a99eb02b1c2782bfd24d857a4b2da8a2e
4
- data.tar.gz: fbcc56a535fd2c350a6bf754f155ce67d3375aa0
3
+ metadata.gz: 85c82f5c50368c2a1774e977b96f02cd7ffe0210
4
+ data.tar.gz: d67caaa2266ef58a93619ba553c7821306e9d1fb
5
5
  SHA512:
6
- metadata.gz: e4614966eaf378578e9c52575f8af955fc826d2f5881ee2a21366b5f578151618de7fc0e98b3b380f800506b8679b691579a6eef28bffc09d8a672fb7d3b41db
7
- data.tar.gz: 97b60c62afa095afa3119143e5c4aaafe57623d4494e17381da65ac12d94d68a22b6714fd136199f2e722c66d63871721c9a866d01c76600ac1478812bfa0134
6
+ metadata.gz: d6c51c681ab883d6e58af2871812dac222d99ec8801efb50ac4619debbacf0494f14d2c31222c9570b560051e3201e4cd12916fd39b5ac7ea2d917659352d4a8
7
+ data.tar.gz: d53c2760cac8fe3f8cc965f6d74f5d291d08256c7f8b2abf6bdad43958e6e5fa7825d95a9e813b768ba4ca82f39b67a6c123b06cbb9cbadc7b125f6d88a53021
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1088
1
+ 3.0.1089
@@ -269,7 +269,7 @@ module TencentCloud
269
269
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
270
270
  end
271
271
 
272
- # 删除 RocketMQ 5.x 集群。
272
+ # 删除 RocketMQ 5.x 集群,删除前请先删除正在使用的主题、消费组和角色信息。
273
273
 
274
274
  # @param request: Request instance for DeleteInstance.
275
275
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteInstanceRequest`
@@ -485,6 +485,30 @@ module TencentCloud
485
485
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
486
486
  end
487
487
 
488
+ # 查询消费组下的客户端连接列表。
489
+
490
+ # @param request: Request instance for DescribeConsumerClientList.
491
+ # @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerClientListRequest`
492
+ # @rtype: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerClientListResponse`
493
+ def DescribeConsumerClientList(request)
494
+ body = send_request('DescribeConsumerClientList', request.serialize)
495
+ response = JSON.parse(body)
496
+ if response['Response'].key?('Error') == false
497
+ model = DescribeConsumerClientListResponse.new
498
+ model.deserialize(response['Response'])
499
+ model
500
+ else
501
+ code = response['Response']['Error']['Code']
502
+ message = response['Response']['Error']['Message']
503
+ reqid = response['Response']['RequestId']
504
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
505
+ end
506
+ rescue TencentCloud::Common::TencentCloudSDKException => e
507
+ raise e
508
+ rescue StandardError => e
509
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
510
+ end
511
+
488
512
  # 查询消费组详情
489
513
 
490
514
  # @param request: Request instance for DescribeConsumerGroup.
@@ -1422,7 +1446,7 @@ module TencentCloud
1422
1446
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1423
1447
  end
1424
1448
 
1425
- # 修改 RocketMQ 5.x 集群属性。
1449
+ # 修改 RocketMQ 5.x 集群属性,仅支持修改运行中的集群。
1426
1450
 
1427
1451
  # @param request: Request instance for ModifyInstance.
1428
1452
  # @type request: :class:`Tencentcloud::trocket::V20230308::ModifyInstanceRequest`
@@ -1446,7 +1470,7 @@ module TencentCloud
1446
1470
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1447
1471
  end
1448
1472
 
1449
- # 修改 RocketMQ 5.x 集群接入点。
1473
+ # 修改 RocketMQ 5.x 集群接入点,操作前请先确认接入点已存在。
1450
1474
 
1451
1475
  # @param request: Request instance for ModifyInstanceEndpoint.
1452
1476
  # @type request: :class:`Tencentcloud::trocket::V20230308::ModifyInstanceEndpointRequest`
@@ -170,7 +170,12 @@ module TencentCloud
170
170
  # @param ConsumerLag: 客户端消费堆积
171
171
  # 注意:此字段可能返回 null,表示取不到有效值。
172
172
  # @type ConsumerLag: Integer
173
- # @param ChannelProtocol: 消费者客户端类型(grpc;remoting;http)
173
+ # @param ChannelProtocol: 消费者客户端类型,枚举值如下:
174
+
175
+ # - grpc:GRPC协议
176
+ # - remoting:Remoting协议
177
+ # - http:HTTP协议
178
+ # 注意:此字段可能返回 null,表示取不到有效值。
174
179
  # @type ChannelProtocol: String
175
180
 
176
181
  attr_accessor :ClientId, :ClientAddr, :Language, :Version, :ConsumerLag, :ChannelProtocol
@@ -268,15 +273,19 @@ module TencentCloud
268
273
 
269
274
  # CreateInstance请求参数结构体
270
275
  class CreateInstanceRequest < TencentCloud::Common::AbstractModel
271
- # @param InstanceType: 实例类型,
272
- # EXPERIMENT 体验版
273
- # BASIC 基础版
274
- # PRO 专业版
275
- # PLATINUM 铂金版
276
+ # @param InstanceType: 实例类型,枚举值如下:
277
+
278
+ # - EXPERIMENT:体验版
279
+
280
+ # - BASIC:基础版
281
+
282
+ # - PRO:专业版
283
+
284
+ # - PLATINUM:铂金版
276
285
  # @type InstanceType: String
277
- # @param Name: 集群名称
286
+ # @param Name: 集群名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
278
287
  # @type Name: String
279
- # @param SkuCode: 商品规格,可用规格如下:experiment_500, basic_1k, basic_2k, basic_3k, basic_4k, basic_5k, basic_6k, basic_7k, basic_8k, basic_9k, basic_10k, pro_4k, pro_6k, pro_8k, pro_1w, pro_15k, pro_2w, pro_25k, pro_3w, pro_35k, pro_4w, pro_45k, pro_5w, pro_55k, pro_60k, pro_65k, pro_70k, pro_75k, pro_80k, pro_85k, pro_90k, pro_95k, pro_100k, platinum_1w, platinum_2w, platinum_3w, platinum_4w, platinum_5w, platinum_6w, platinum_7w, platinum_8w, platinum_9w, platinum_10w, platinum_12w, platinum_14w, platinum_16w, platinum_18w, platinum_20w, platinum_25w, platinum_30w, platinum_35w, platinum_40w, platinum_45w, platinum_50w, platinum_60w, platinum_70w, platinum_80w, platinum_90w, platinum_100w
288
+ # @param SkuCode: 商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
280
289
  # @type SkuCode: String
281
290
  # @param Remark: 备注信息
282
291
  # @type Remark: String
@@ -290,19 +299,26 @@ module TencentCloud
290
299
  # @type BillingFlow: Boolean
291
300
  # @param Bandwidth: 公网带宽(单位:兆),默认值为0。如果开启公网,该字段必须为大于0的正整数
292
301
  # @type Bandwidth: Integer
293
- # @param IpRules: 公网访问白名单
302
+ # @param IpRules: 公网访问白名单,不填表示拒绝所有 IP 访问
294
303
  # @type IpRules: Array
295
- # @param MessageRetention: 消息保留时长(单位:小时)
304
+ # @param MessageRetention: 消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
305
+
306
+ # - 默认值:DefaultRetention 参数
307
+ # - 最小值:RetentionLowerLimit 参数
308
+ # - 最大值:RetentionUpperLimit 参数
296
309
  # @type MessageRetention: Integer
297
310
  # @param PayMode: 付费模式(0: 后付费;1: 预付费),默认值为0
298
311
  # @type PayMode: Integer
299
- # @param RenewFlag: 是否自动续费(0: 不自动续费;1: 自动续费),默认值为0
312
+ # @param RenewFlag: 预付费集群是否自动续费(0: 不自动续费;1: 自动续费),默认值为0
300
313
  # @type RenewFlag: Integer
301
- # @param TimeSpan: 购买时长(单位:月),默认值为1
314
+ # @param TimeSpan: 预付费集群的购买时长(单位:月),取值范围为1~60,默认值为1
302
315
  # @type TimeSpan: Integer
303
- # @param MaxTopicNum: 最大可创建主题数
316
+ # @param MaxTopicNum: 最大可创建主题数,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
317
+
318
+ # - 默认值和最小值:TopicNumLimit 参数
319
+ # - 最大值:TopicNumUpperLimit 参数
304
320
  # @type MaxTopicNum: Integer
305
- # @param ZoneIds: 部署可用区列表
321
+ # @param ZoneIds: 部署可用区列表,从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口获得。
306
322
  # @type ZoneIds: Array
307
323
 
308
324
  attr_accessor :InstanceType, :Name, :SkuCode, :Remark, :TagList, :VpcList, :EnablePublic, :BillingFlow, :Bandwidth, :IpRules, :MessageRetention, :PayMode, :RenewFlag, :TimeSpan, :MaxTopicNum, :ZoneIds
@@ -839,7 +855,7 @@ module TencentCloud
839
855
 
840
856
  # DeleteInstance请求参数结构体
841
857
  class DeleteInstanceRequest < TencentCloud::Common::AbstractModel
842
- # @param InstanceId: 集群ID
858
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
843
859
  # @type InstanceId: String
844
860
 
845
861
  attr_accessor :InstanceId
@@ -1109,6 +1125,76 @@ module TencentCloud
1109
1125
  end
1110
1126
  end
1111
1127
 
1128
+ # DescribeConsumerClientList请求参数结构体
1129
+ class DescribeConsumerClientListRequest < TencentCloud::Common::AbstractModel
1130
+ # @param InstanceId: 集群ID
1131
+ # @type InstanceId: String
1132
+ # @param ConsumerGroup: 消费组名称
1133
+ # @type ConsumerGroup: String
1134
+ # @param Filters: 查询条件列表
1135
+ # @type Filters: Array
1136
+ # @param Offset: 查询起始位置
1137
+ # @type Offset: Integer
1138
+ # @param Limit: 查询结果限制数量
1139
+ # @type Limit: Integer
1140
+
1141
+ attr_accessor :InstanceId, :ConsumerGroup, :Filters, :Offset, :Limit
1142
+
1143
+ def initialize(instanceid=nil, consumergroup=nil, filters=nil, offset=nil, limit=nil)
1144
+ @InstanceId = instanceid
1145
+ @ConsumerGroup = consumergroup
1146
+ @Filters = filters
1147
+ @Offset = offset
1148
+ @Limit = limit
1149
+ end
1150
+
1151
+ def deserialize(params)
1152
+ @InstanceId = params['InstanceId']
1153
+ @ConsumerGroup = params['ConsumerGroup']
1154
+ unless params['Filters'].nil?
1155
+ @Filters = []
1156
+ params['Filters'].each do |i|
1157
+ filter_tmp = Filter.new
1158
+ filter_tmp.deserialize(i)
1159
+ @Filters << filter_tmp
1160
+ end
1161
+ end
1162
+ @Offset = params['Offset']
1163
+ @Limit = params['Limit']
1164
+ end
1165
+ end
1166
+
1167
+ # DescribeConsumerClientList返回参数结构体
1168
+ class DescribeConsumerClientListResponse < TencentCloud::Common::AbstractModel
1169
+ # @param TotalCount: 查询总数
1170
+ # @type TotalCount: Integer
1171
+ # @param Data: 消费客户端
1172
+ # @type Data: Array
1173
+ # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1174
+ # @type RequestId: String
1175
+
1176
+ attr_accessor :TotalCount, :Data, :RequestId
1177
+
1178
+ def initialize(totalcount=nil, data=nil, requestid=nil)
1179
+ @TotalCount = totalcount
1180
+ @Data = data
1181
+ @RequestId = requestid
1182
+ end
1183
+
1184
+ def deserialize(params)
1185
+ @TotalCount = params['TotalCount']
1186
+ unless params['Data'].nil?
1187
+ @Data = []
1188
+ params['Data'].each do |i|
1189
+ consumerclient_tmp = ConsumerClient.new
1190
+ consumerclient_tmp.deserialize(i)
1191
+ @Data << consumerclient_tmp
1192
+ end
1193
+ end
1194
+ @RequestId = params['RequestId']
1195
+ end
1196
+ end
1197
+
1112
1198
  # DescribeConsumerClient请求参数结构体
1113
1199
  class DescribeConsumerClientRequest < TencentCloud::Common::AbstractModel
1114
1200
  # @param InstanceId: 集群ID
@@ -1190,13 +1276,13 @@ module TencentCloud
1190
1276
 
1191
1277
  # DescribeConsumerGroupList请求参数结构体
1192
1278
  class DescribeConsumerGroupListRequest < TencentCloud::Common::AbstractModel
1193
- # @param InstanceId: 集群ID
1279
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1194
1280
  # @type InstanceId: String
1195
- # @param Filters: 查询条件列表
1281
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1196
1282
  # @type Filters: Array
1197
- # @param Offset: 查询起始位置
1283
+ # @param Offset: 查询起始位置,默认为0。
1198
1284
  # @type Offset: Integer
1199
- # @param Limit: 查询结果限制数量
1285
+ # @param Limit: 查询结果限制数量,默认20。
1200
1286
  # @type Limit: Integer
1201
1287
  # @param FromTopic: 查询指定主题下的消费组
1202
1288
  # @type FromTopic: String
@@ -1387,11 +1473,11 @@ module TencentCloud
1387
1473
 
1388
1474
  # DescribeFusionInstanceList请求参数结构体
1389
1475
  class DescribeFusionInstanceListRequest < TencentCloud::Common::AbstractModel
1390
- # @param Offset: 查询起始位置
1476
+ # @param Offset: 查询起始位置,默认为0。
1391
1477
  # @type Offset: Integer
1392
- # @param Limit: 查询结果限制数量
1478
+ # @param Limit: 查询结果限制数量,默认20。
1393
1479
  # @type Limit: Integer
1394
- # @param Filters: 查询条件列表
1480
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1395
1481
  # @type Filters: Array
1396
1482
  # @param TagFilters: 标签过滤器
1397
1483
  # @type TagFilters: Array
@@ -1460,13 +1546,13 @@ module TencentCloud
1460
1546
 
1461
1547
  # DescribeInstanceList请求参数结构体
1462
1548
  class DescribeInstanceListRequest < TencentCloud::Common::AbstractModel
1463
- # @param Filters: 查询条件列表
1549
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1464
1550
  # @type Filters: Array
1465
1551
  # @param TagFilters: 标签过滤器
1466
1552
  # @type TagFilters: Array
1467
- # @param Offset: 查询起始位置
1553
+ # @param Offset: 查询起始位置,默认为0。
1468
1554
  # @type Offset: Integer
1469
- # @param Limit: 查询结果限制数量
1555
+ # @param Limit: 查询结果限制数量,默认20。
1470
1556
  # @type Limit: Integer
1471
1557
 
1472
1558
  attr_accessor :Filters, :TagFilters, :Offset, :Limit
@@ -1533,7 +1619,7 @@ module TencentCloud
1533
1619
 
1534
1620
  # DescribeInstance请求参数结构体
1535
1621
  class DescribeInstanceRequest < TencentCloud::Common::AbstractModel
1536
- # @param InstanceId: 集群ID
1622
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1537
1623
  # @type InstanceId: String
1538
1624
 
1539
1625
  attr_accessor :InstanceId
@@ -1579,7 +1665,7 @@ module TencentCloud
1579
1665
  # @type ScaledTpsLimit: Integer
1580
1666
  # @param MaxMessageDelay: 延迟消息最长时间,小时为单位
1581
1667
  # @type MaxMessageDelay: Integer
1582
- # @param CreatedTime: 创建时间,秒为单位
1668
+ # @param CreatedTime: 创建时间,**Unix时间戳(毫秒)**
1583
1669
  # @type CreatedTime: Integer
1584
1670
  # @param SendReceiveRatio: 消息发送接收比例
1585
1671
  # @type SendReceiveRatio: Float
@@ -1595,17 +1681,33 @@ module TencentCloud
1595
1681
  # @type TopicQueueNumLowerLimit: Integer
1596
1682
  # @param Remark: 备注信息
1597
1683
  # @type Remark: String
1598
- # @param InstanceStatus: 实例状态
1684
+ # @param InstanceStatus: 实例状态,枚举值如下:
1685
+
1686
+ # - RUNNING:运行中
1687
+ # - ABNORMAL:异常
1688
+ # - OVERDUE:隔离中
1689
+ # - DESTROYED:已销毁
1690
+ # - CREATING:创建中
1691
+ # - MODIFYING:变配中
1692
+ # - CREATE_FAILURE:创建失败
1693
+ # - MODIFY_FAILURE:变配失败
1694
+ # - DELETING:删除中
1599
1695
  # @type InstanceStatus: String
1600
1696
  # @param SkuCode: 实例规格
1601
1697
  # @type SkuCode: String
1602
- # @param PayMode: 计费模式
1698
+ # @param PayMode: 计费模式,枚举值如下:
1699
+
1700
+ # - POSTPAID:后付费按量计费
1701
+ # - PREPAID:预付费包年包月
1603
1702
  # @type PayMode: String
1604
1703
  # @param ScaledTpsEnabled: 是否开启弹性TPS
1605
1704
  # @type ScaledTpsEnabled: Boolean
1606
- # @param RenewFlag: 是否自动续费
1705
+ # @param RenewFlag: 预付费集群是否自动续费,枚举值如下:
1706
+
1707
+ # - 0: 不自动续费
1708
+ # - 1: 自动续费
1607
1709
  # @type RenewFlag: Integer
1608
- # @param ExpiryTime: 到期时间
1710
+ # @param ExpiryTime: 到期时间,**Unix时间戳(毫秒)**
1609
1711
  # @type ExpiryTime: Integer
1610
1712
  # @param RoleNumLimit: 角色数量限制
1611
1713
  # @type RoleNumLimit: Integer
@@ -1618,7 +1720,7 @@ module TencentCloud
1618
1720
  # @param TopicNumUpperLimit: 最大可设置的topic个数
1619
1721
  # 注意:此字段可能返回 null,表示取不到有效值。
1620
1722
  # @type TopicNumUpperLimit: Integer
1621
- # @param ZoneIds: 可用区列表
1723
+ # @param ZoneIds: 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
1622
1724
  # @type ZoneIds: Array
1623
1725
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1624
1726
  # @type RequestId: String
@@ -2500,31 +2602,31 @@ module TencentCloud
2500
2602
 
2501
2603
  # DescribeMessageList请求参数结构体
2502
2604
  class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
2503
- # @param InstanceId: 集群ID
2605
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2504
2606
  # @type InstanceId: String
2505
- # @param Topic: 主题名称
2607
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2506
2608
  # @type Topic: String
2507
- # @param StartTime: 开始时间
2609
+ # @param StartTime: 要查询消息的开始时间,**Unix时间戳(毫秒)**
2508
2610
  # @type StartTime: Integer
2509
- # @param EndTime: 结束时间
2611
+ # @param EndTime: 要查询消息的结束时间,**Unix时间戳(毫秒)**
2510
2612
  # @type EndTime: Integer
2511
- # @param TaskRequestId: 一次查询标识
2613
+ # @param TaskRequestId: 一次查询标识。第一次查询可传空字符串,当查询结果涉及分页,请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
2512
2614
  # @type TaskRequestId: String
2513
- # @param Offset: 查询起始位置
2615
+ # @param Offset: 查询起始位置,默认为0。
2514
2616
  # @type Offset: Integer
2515
- # @param Limit: 查询结果限制数量
2617
+ # @param Limit: 查询结果限制数量,默认20。
2516
2618
  # @type Limit: Integer
2517
- # @param ConsumerGroup: 消费组名称
2619
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2518
2620
  # @type ConsumerGroup: String
2519
- # @param MsgId: 消息 ID
2621
+ # @param MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2520
2622
  # @type MsgId: String
2521
- # @param MsgKey: 消息 Key
2623
+ # @param MsgKey: 消息 Key,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2522
2624
  # @type MsgKey: String
2523
2625
  # @param RecentMessageNum: 查询最近N条消息 最大不超过1024,默认-1为其他查询条件
2524
2626
  # @type RecentMessageNum: Integer
2525
- # @param QueryDeadLetterMessage: 是否查询死信消息
2627
+ # @param QueryDeadLetterMessage: 是否查询死信消息,默认为false
2526
2628
  # @type QueryDeadLetterMessage: Boolean
2527
- # @param Tag: 消息 Tag
2629
+ # @param Tag: 消息 Tag,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2528
2630
  # @type Tag: String
2529
2631
 
2530
2632
  attr_accessor :InstanceId, :Topic, :StartTime, :EndTime, :TaskRequestId, :Offset, :Limit, :ConsumerGroup, :MsgId, :MsgKey, :RecentMessageNum, :QueryDeadLetterMessage, :Tag
@@ -2601,19 +2703,19 @@ module TencentCloud
2601
2703
 
2602
2704
  # DescribeMessage请求参数结构体
2603
2705
  class DescribeMessageRequest < TencentCloud::Common::AbstractModel
2604
- # @param InstanceId: 集群ID
2706
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2605
2707
  # @type InstanceId: String
2606
- # @param Topic: 主题名称
2708
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2607
2709
  # @type Topic: String
2608
- # @param MsgId: 消息ID
2710
+ # @param MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2609
2711
  # @type MsgId: String
2610
- # @param Offset: 查询起始位置
2712
+ # @param Offset: 查询起始位置,默认为0。
2611
2713
  # @type Offset: Integer
2612
- # @param Limit: 查询结果限制数量
2714
+ # @param Limit: 查询结果限制数量,默认20。
2613
2715
  # @type Limit: Integer
2614
- # @param QueryDeadLetterMessage: 是否是死信消息
2716
+ # @param QueryDeadLetterMessage: 是否是死信消息,默认为false
2615
2717
  # @type QueryDeadLetterMessage: Boolean
2616
- # @param QueryDelayMessage: 是否是延时消息
2718
+ # @param QueryDelayMessage: 是否是延时消息,默认为false
2617
2719
  # @type QueryDelayMessage: Boolean
2618
2720
 
2619
2721
  attr_accessor :InstanceId, :Topic, :MsgId, :Offset, :Limit, :QueryDeadLetterMessage, :QueryDelayMessage
@@ -2655,7 +2757,7 @@ module TencentCloud
2655
2757
  # @param MessageTracks: 消息消费情况列表
2656
2758
  # 注意:此字段可能返回 null,表示取不到有效值。
2657
2759
  # @type MessageTracks: Array
2658
- # @param ShowTopicName: Topic
2760
+ # @param ShowTopicName: 主题名称
2659
2761
  # @type ShowTopicName: String
2660
2762
  # @param MessageTracksCount: 消息消费情况列表总条数
2661
2763
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -2699,15 +2801,15 @@ module TencentCloud
2699
2801
 
2700
2802
  # DescribeMessageTrace请求参数结构体
2701
2803
  class DescribeMessageTraceRequest < TencentCloud::Common::AbstractModel
2702
- # @param InstanceId: 集群ID
2804
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2703
2805
  # @type InstanceId: String
2704
- # @param Topic: 主题名称
2806
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2705
2807
  # @type Topic: String
2706
- # @param MsgId: 消息ID
2808
+ # @param MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2707
2809
  # @type MsgId: String
2708
- # @param QueryDeadLetterMessage: 是否是死信消息
2810
+ # @param QueryDeadLetterMessage: 是否是死信消息,默认为false
2709
2811
  # @type QueryDeadLetterMessage: Boolean
2710
- # @param QueryDelayMessage: 是否是延时消息
2812
+ # @param QueryDelayMessage: 是否是延时消息,默认为false
2711
2813
  # @type QueryDelayMessage: Boolean
2712
2814
 
2713
2815
  attr_accessor :InstanceId, :Topic, :MsgId, :QueryDeadLetterMessage, :QueryDelayMessage
@@ -2731,7 +2833,7 @@ module TencentCloud
2731
2833
 
2732
2834
  # DescribeMessageTrace返回参数结构体
2733
2835
  class DescribeMessageTraceResponse < TencentCloud::Common::AbstractModel
2734
- # @param ShowTopicName: 展示Topic名
2836
+ # @param ShowTopicName: 主题名称
2735
2837
  # @type ShowTopicName: String
2736
2838
  # @param Data: 轨迹详情
2737
2839
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -3057,13 +3159,13 @@ module TencentCloud
3057
3159
 
3058
3160
  # DescribeRoleList请求参数结构体
3059
3161
  class DescribeRoleListRequest < TencentCloud::Common::AbstractModel
3060
- # @param InstanceId: 集群ID
3162
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3061
3163
  # @type InstanceId: String
3062
- # @param Offset: 查询起始位置
3164
+ # @param Offset: 查询起始位置,默认为0。
3063
3165
  # @type Offset: Integer
3064
- # @param Limit: 查询结果限制数量
3166
+ # @param Limit: 查询结果限制数量,默认20。
3065
3167
  # @type Limit: Integer
3066
- # @param Filters: 查询条件列表
3168
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3067
3169
  # @type Filters: Array
3068
3170
 
3069
3171
  attr_accessor :InstanceId, :Offset, :Limit, :Filters
@@ -3322,13 +3424,13 @@ module TencentCloud
3322
3424
 
3323
3425
  # DescribeTopicList请求参数结构体
3324
3426
  class DescribeTopicListRequest < TencentCloud::Common::AbstractModel
3325
- # @param InstanceId: 集群ID
3427
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3326
3428
  # @type InstanceId: String
3327
- # @param Filters: 查询条件列表
3429
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3328
3430
  # @type Filters: Array
3329
- # @param Offset: 查询起始位置
3431
+ # @param Offset: 查询起始位置,默认为0。
3330
3432
  # @type Offset: Integer
3331
- # @param Limit: 查询结果限制数量
3433
+ # @param Limit: 查询结果限制数量,默认20。
3332
3434
  # @type Limit: Integer
3333
3435
 
3334
3436
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -3593,10 +3695,13 @@ module TencentCloud
3593
3695
 
3594
3696
  # 接入点信息
3595
3697
  class Endpoint < TencentCloud::Common::AbstractModel
3596
- # @param Type: 接入点类型,枚举值如下
3597
- # VPC: VPC;
3598
- # PUBLIC: 公网;
3599
- # INTERNAL: 支撑网;
3698
+ # @param Type: 接入点类型,枚举值如下:
3699
+
3700
+ # - VPC:VPC 网络
3701
+
3702
+ # - PUBLIC:公网
3703
+
3704
+ # - INTERNAL:支撑网
3600
3705
  # @type Type: String
3601
3706
  # @param Status: 状态,
3602
3707
  # OPEN 开启,
@@ -3711,11 +3816,13 @@ module TencentCloud
3711
3816
  # @type TopicNumLimit: Integer
3712
3817
  # @param GroupNumLimit: 实例消费组数量上限
3713
3818
  # @type GroupNumLimit: Integer
3714
- # @param PayMode: 计费模式,
3715
- # POSTPAID,按量计费
3716
- # PREPAID,包年包月
3819
+ # @param PayMode: 计费模式,枚举值如下:
3820
+
3821
+ # - POSTPAID:按量计费
3822
+
3823
+ # - PREPAID:包年包月
3717
3824
  # @type PayMode: String
3718
- # @param ExpiryTime: 到期时间,秒为单位
3825
+ # @param ExpiryTime: 到期时间,**Unix时间戳(毫秒)**
3719
3826
  # 注意:此字段可能返回 null,表示取不到有效值。
3720
3827
  # @type ExpiryTime: Integer
3721
3828
  # @param Remark: 备注信息
@@ -3734,24 +3841,23 @@ module TencentCloud
3734
3841
  # 注意:此字段可能返回 null,表示取不到有效值。
3735
3842
  # @type TpsLimit: Integer
3736
3843
  # @param ScaledTpsLimit: 弹性TPS限流值
3737
- # 注意:此字段可能返回 null,表示取不到有效值。
3738
3844
  # @type ScaledTpsLimit: Integer
3739
3845
  # @param MessageRetention: 消息保留时间,小时为单位
3740
- # 注意:此字段可能返回 null,表示取不到有效值。
3741
3846
  # @type MessageRetention: Integer
3742
3847
  # @param MaxMessageDelay: 延迟消息最大时长,小时为单位
3743
- # 注意:此字段可能返回 null,表示取不到有效值。
3744
3848
  # @type MaxMessageDelay: Integer
3745
- # @param RenewFlag: 是否自动续费
3746
- # 注意:此字段可能返回 null,表示取不到有效值。
3849
+ # @param RenewFlag: 预付费集群是否自动续费,枚举值如下:
3850
+
3851
+ # - 0: 不自动续费
3852
+ # - 1: 自动续费
3747
3853
  # @type RenewFlag: Integer
3748
3854
  # @param InstanceItemExtraInfo: 4.x独有数据
3749
3855
  # 注意:此字段可能返回 null,表示取不到有效值。
3750
3856
  # @type InstanceItemExtraInfo: :class:`Tencentcloud::Trocket.v20230308.models.InstanceItemExtraInfo`
3751
- # @param DestroyTime: 预销毁时间
3857
+ # @param DestroyTime: 预销毁时间,**Unix时间戳(毫秒)**
3752
3858
  # 注意:此字段可能返回 null,表示取不到有效值。
3753
3859
  # @type DestroyTime: Integer
3754
- # @param ZoneIds: 所属可用区列表
3860
+ # @param ZoneIds: 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
3755
3861
  # 注意:此字段可能返回 null,表示取不到有效值。
3756
3862
  # @type ZoneIds: Array
3757
3863
  # @param EnableDeletionProtection: 是否开启删除保护
@@ -3938,11 +4044,13 @@ module TencentCloud
3938
4044
  # @type TopicNumLimit: Integer
3939
4045
  # @param GroupNumLimit: 实例消费组数量上限
3940
4046
  # @type GroupNumLimit: Integer
3941
- # @param PayMode: 计费模式,
3942
- # POSTPAID,按量计费
3943
- # PREPAID,包年包月
4047
+ # @param PayMode: 计费模式,枚举值如下:
4048
+
4049
+ # - POSTPAID:按量计费
4050
+
4051
+ # - PREPAID:包年包月
3944
4052
  # @type PayMode: String
3945
- # @param ExpiryTime: 到期时间,秒为单位
4053
+ # @param ExpiryTime: 到期时间戳,**Unix时间戳(毫秒)**
3946
4054
  # 注意:此字段可能返回 null,表示取不到有效值。
3947
4055
  # @type ExpiryTime: Integer
3948
4056
  # @param Remark: 备注信息
@@ -3958,19 +4066,14 @@ module TencentCloud
3958
4066
  # @param SkuCode: 商品规格
3959
4067
  # @type SkuCode: String
3960
4068
  # @param TpsLimit: TPS限流值
3961
- # 注意:此字段可能返回 null,表示取不到有效值。
3962
4069
  # @type TpsLimit: Integer
3963
4070
  # @param ScaledTpsLimit: 弹性TPS限流值
3964
- # 注意:此字段可能返回 null,表示取不到有效值。
3965
4071
  # @type ScaledTpsLimit: Integer
3966
4072
  # @param MessageRetention: 消息保留时间,小时为单位
3967
- # 注意:此字段可能返回 null,表示取不到有效值。
3968
4073
  # @type MessageRetention: Integer
3969
4074
  # @param MaxMessageDelay: 延迟消息最大时长,小时为单位
3970
- # 注意:此字段可能返回 null,表示取不到有效值。
3971
4075
  # @type MaxMessageDelay: Integer
3972
- # @param RenewFlag: 是否自动续费
3973
- # 注意:此字段可能返回 null,表示取不到有效值。
4076
+ # @param RenewFlag: 是否自动续费,仅针对预付费集群(0: 不自动续费;1:自动续费)
3974
4077
  # @type RenewFlag: Integer
3975
4078
 
3976
4079
  attr_accessor :InstanceId, :InstanceName, :Version, :InstanceType, :InstanceStatus, :TopicNumLimit, :GroupNumLimit, :PayMode, :ExpiryTime, :Remark, :TopicNum, :GroupNum, :TagList, :SkuCode, :TpsLimit, :ScaledTpsLimit, :MessageRetention, :MaxMessageDelay, :RenewFlag
@@ -4092,10 +4195,9 @@ module TencentCloud
4092
4195
  class IpRule < TencentCloud::Common::AbstractModel
4093
4196
  # @param Ip: IP地址
4094
4197
  # @type Ip: String
4095
- # @param Allow: 是否允许放行
4198
+ # @param Allow: 是否允许放行,默认为false表示拒绝
4096
4199
  # @type Allow: Boolean
4097
4200
  # @param Remark: 备注信息
4098
- # 注意:此字段可能返回 null,表示取不到有效值。
4099
4201
  # @type Remark: String
4100
4202
 
4101
4203
  attr_accessor :Ip, :Allow, :Remark
@@ -4494,7 +4596,13 @@ module TencentCloud
4494
4596
 
4495
4597
  # 消息轨迹
4496
4598
  class MessageTraceItem < TencentCloud::Common::AbstractModel
4497
- # @param Stage: 步骤
4599
+ # @param Stage: 消息处理阶段,枚举值如下:
4600
+
4601
+ # - produce:消息生产
4602
+
4603
+ # - persist:消息存储
4604
+
4605
+ # - consume:消息消费
4498
4606
  # 注意:此字段可能返回 null,表示取不到有效值。
4499
4607
  # @type Stage: String
4500
4608
  # @param Data: 轨迹详情
@@ -4695,7 +4803,7 @@ module TencentCloud
4695
4803
 
4696
4804
  # ModifyInstanceEndpoint请求参数结构体
4697
4805
  class ModifyInstanceEndpointRequest < TencentCloud::Common::AbstractModel
4698
- # @param InstanceId: 集群ID
4806
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4699
4807
  # @type InstanceId: String
4700
4808
  # @param Type: 接入点类型,
4701
4809
  # PUBLIC 公网
@@ -4751,25 +4859,32 @@ module TencentCloud
4751
4859
 
4752
4860
  # ModifyInstance请求参数结构体
4753
4861
  class ModifyInstanceRequest < TencentCloud::Common::AbstractModel
4754
- # @param InstanceId: 集群ID
4862
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4755
4863
  # @type InstanceId: String
4756
- # @param Name: 实例名称
4864
+ # @param Name: 实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
4757
4865
  # @type Name: String
4758
- # @param Remark: 备注信息
4866
+ # @param Remark: 备注信息,最多 128 个字符
4759
4867
  # @type Remark: String
4760
4868
  # @param SendReceiveRatio: 消息发送和接收的比例
4761
4869
  # @type SendReceiveRatio: Float
4762
- # @param SkuCode: 调整实例规格的商品代号
4870
+ # @param SkuCode: 商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
4763
4871
  # @type SkuCode: String
4764
- # @param MessageRetention: 消息保留时长,小时为单位
4872
+ # @param MessageRetention: 消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
4873
+
4874
+ # - 默认值:DefaultRetention 参数
4875
+ # - 最小值:RetentionLowerLimit 参数
4876
+ # - 最大值:RetentionUpperLimit 参数
4765
4877
  # @type MessageRetention: Integer
4766
4878
  # @param ScaledTpsEnabled: 是否开启弹性TPS
4767
4879
  # @type ScaledTpsEnabled: Boolean
4768
4880
  # @param AclEnabled: 是否开启ACL
4769
4881
  # @type AclEnabled: Boolean
4770
- # @param MaxTopicNum: 最大可创建主题数
4882
+ # @param MaxTopicNum: 最大可创建主题数,取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
4883
+
4884
+ # - 最小值和默认值:TopicNumLimit 参数
4885
+ # - 最大值:TopicNumUpperLimit 参数
4771
4886
  # @type MaxTopicNum: Integer
4772
- # @param ExtraTopicNum: 免费额度之外的主题个数
4887
+ # @param ExtraTopicNum: 免费额度之外的主题个数,免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
4773
4888
  # @type ExtraTopicNum: String
4774
4889
  # @param EnableDeletionProtection: 是否开启删除保护
4775
4890
  # @type EnableDeletionProtection: Boolean
@@ -5206,35 +5321,26 @@ module TencentCloud
5206
5321
  # @param SkuCode: 规格代码
5207
5322
  # @type SkuCode: String
5208
5323
  # @param TpsLimit: TPS上限
5209
- # 注意:此字段可能返回 null,表示取不到有效值。
5210
5324
  # @type TpsLimit: Integer
5211
5325
  # @param ScaledTpsLimit: 弹性TPS上限
5212
- # 注意:此字段可能返回 null,表示取不到有效值。
5213
5326
  # @type ScaledTpsLimit: Integer
5214
5327
  # @param TopicNumLimit: 主题数量上限默认值
5215
- # 注意:此字段可能返回 null,表示取不到有效值。
5216
5328
  # @type TopicNumLimit: Integer
5217
5329
  # @param GroupNumLimit: 消费组数量上限
5218
- # 注意:此字段可能返回 null,表示取不到有效值。
5219
5330
  # @type GroupNumLimit: Integer
5220
5331
  # @param DefaultRetention: 默认消息保留时间,小时为单位
5221
- # 注意:此字段可能返回 null,表示取不到有效值。
5222
5332
  # @type DefaultRetention: Integer
5223
5333
  # @param RetentionUpperLimit: 可调整消息保留时间上限,小时为单位
5224
- # 注意:此字段可能返回 null,表示取不到有效值。
5225
5334
  # @type RetentionUpperLimit: Integer
5226
5335
  # @param RetentionLowerLimit: 可调整消息保留时间下限,小时为单位
5227
- # 注意:此字段可能返回 null,表示取不到有效值。
5228
5336
  # @type RetentionLowerLimit: Integer
5229
5337
  # @param MaxMessageDelay: 延时消息最大时长,小时为单位
5230
- # 注意:此字段可能返回 null,表示取不到有效值。
5231
5338
  # @type MaxMessageDelay: Integer
5232
5339
  # @param OnSale: 是否可购买
5233
5340
  # @type OnSale: Boolean
5234
5341
  # @param PriceTags: 计费项信息
5235
5342
  # @type PriceTags: Array
5236
5343
  # @param TopicNumUpperLimit: 主题数量上限默认最大值
5237
- # 注意:此字段可能返回 null,表示取不到有效值。
5238
5344
  # @type TopicNumUpperLimit: Integer
5239
5345
 
5240
5346
  attr_accessor :InstanceType, :SkuCode, :TpsLimit, :ScaledTpsLimit, :TopicNumLimit, :GroupNumLimit, :DefaultRetention, :RetentionUpperLimit, :RetentionLowerLimit, :MaxMessageDelay, :OnSale, :PriceTags, :TopicNumUpperLimit
@@ -5393,13 +5499,13 @@ module TencentCloud
5393
5499
 
5394
5500
  # ResetConsumerGroupOffset请求参数结构体
5395
5501
  class ResetConsumerGroupOffsetRequest < TencentCloud::Common::AbstractModel
5396
- # @param InstanceId: 集群ID
5502
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
5397
5503
  # @type InstanceId: String
5398
- # @param Topic: 主题名称
5504
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
5399
5505
  # @type Topic: String
5400
- # @param ResetTimestamp: 重置位点时间(单位:毫秒)-1表示重置到最新位点
5506
+ # @param ResetTimestamp: 重置位点的时间戳(单位:毫秒),指定为 -1 时表示重置到最新位点
5401
5507
  # @type ResetTimestamp: Integer
5402
- # @param ConsumerGroup: 消费组名称
5508
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
5403
5509
  # @type ConsumerGroup: String
5404
5510
 
5405
5511
  attr_accessor :InstanceId, :Topic, :ResetTimestamp, :ConsumerGroup
@@ -5449,9 +5555,9 @@ module TencentCloud
5449
5555
  # @type SecretKey: String
5450
5556
  # @param Remark: 备注信息
5451
5557
  # @type Remark: String
5452
- # @param CreatedTime: 创建时间,秒为单位
5558
+ # @param CreatedTime: 角色的创建时间,**Unix时间戳(毫秒)**
5453
5559
  # @type CreatedTime: Integer
5454
- # @param ModifiedTime: 修改时间,秒为单位
5560
+ # @param ModifiedTime: 角色的更新时间,**Unix时间戳(毫秒)**
5455
5561
  # @type ModifiedTime: Integer
5456
5562
  # @param PermType: 权限类型,默认按集群授权(Cluster:集群级别;TopicAndGroup:主题&消费组级别)
5457
5563
  # @type PermType: String
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.1088
4
+ version: 3.0.1089
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-06-24 00:00:00.000000000 Z
11
+ date: 2025-06-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common