tencentcloud-sdk-trocket 3.0.1088 → 3.0.1090

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: a1655042298da14efa441c74ef976ef0d08f7872
4
+ data.tar.gz: 1b528f94998d74bb655d8d348eee6df1d60751ff
5
5
  SHA512:
6
- metadata.gz: e4614966eaf378578e9c52575f8af955fc826d2f5881ee2a21366b5f578151618de7fc0e98b3b380f800506b8679b691579a6eef28bffc09d8a672fb7d3b41db
7
- data.tar.gz: 97b60c62afa095afa3119143e5c4aaafe57623d4494e17381da65ac12d94d68a22b6714fd136199f2e722c66d63871721c9a866d01c76600ac1478812bfa0134
6
+ metadata.gz: ffcbe50c8ceb02f761cace8b463dfe1527ade391b7e4a1c5d89067e6ecb816d4573645b4d6dad98a847cc2f3a2f9ed5e73d5fe9427c69abe3998985c9be77f02
7
+ data.tar.gz: 429b6ca65b290896ccec47fb2fd39c4a3ac585baf7ce9b7abf5845a672e8775bcd3896cb5b83d89d9657f6a73ca5ad8092f5698e6a10752ed59e5660a45a6e55
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1088
1
+ 3.0.1090
@@ -245,7 +245,7 @@ module TencentCloud
245
245
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
246
246
  end
247
247
 
248
- # 删除消费组
248
+ # 删除消费组。消费者组删除后,消费者组的所有配置和相关数据都会被清空,且无法找回。删除后,在线的消费者客户端会出现报错,建议您提前下线客户端。
249
249
 
250
250
  # @param request: Request instance for DeleteConsumerGroup.
251
251
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteConsumerGroupRequest`
@@ -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`
@@ -437,7 +437,7 @@ module TencentCloud
437
437
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
438
438
  end
439
439
 
440
- # 删除主题
440
+ # 删除主题。主题删除后,主题的所有配置和相关数据都会被清空,且无法找回。
441
441
 
442
442
  # @param request: Request instance for DeleteTopic.
443
443
  # @type request: :class:`Tencentcloud::trocket::V20230308::DeleteTopicRequest`
@@ -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
@@ -196,18 +201,18 @@ module TencentCloud
196
201
 
197
202
  # CreateConsumerGroup请求参数结构体
198
203
  class CreateConsumerGroupRequest < TencentCloud::Common::AbstractModel
199
- # @param InstanceId: 集群ID
204
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
200
205
  # @type InstanceId: String
201
- # @param MaxRetryTimes: 最大重试次数
206
+ # @param MaxRetryTimes: 最大重试次数,取值范围0~1000
202
207
  # @type MaxRetryTimes: Integer
203
208
  # @param ConsumeEnable: 是否开启消费
204
209
  # @type ConsumeEnable: Boolean
205
210
  # @param ConsumeMessageOrderly: 顺序投递:true
206
211
  # 并发投递:false
207
212
  # @type ConsumeMessageOrderly: Boolean
208
- # @param ConsumerGroup: 消费组名称
213
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
209
214
  # @type ConsumerGroup: String
210
- # @param Remark: 备注
215
+ # @param Remark: 备注信息,最多 128 个字符
211
216
  # @type Remark: String
212
217
  # @param TagList: 标签列表
213
218
  # @type TagList: Array
@@ -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
@@ -638,7 +654,7 @@ module TencentCloud
638
654
 
639
655
  # CreateRole请求参数结构体
640
656
  class CreateRoleRequest < TencentCloud::Common::AbstractModel
641
- # @param InstanceId: 集群ID
657
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
642
658
  # @type InstanceId: String
643
659
  # @param Role: 角色名称
644
660
  # @type Role: String
@@ -650,7 +666,7 @@ module TencentCloud
650
666
  # @type Remark: String
651
667
  # @param PermType: 权限类型,默认按集群授权(Cluster:集群级别;TopicAndGroup:主题&消费组级别)
652
668
  # @type PermType: String
653
- # @param DetailedPerms: Topic&Group维度权限配置
669
+ # @param DetailedPerms: Topic&Group维度权限配置,权限类型为 TopicAndGroup 时必填
654
670
  # @type DetailedPerms: Array
655
671
 
656
672
  attr_accessor :InstanceId, :Role, :PermWrite, :PermRead, :Remark, :PermType, :DetailedPerms
@@ -705,9 +721,9 @@ module TencentCloud
705
721
 
706
722
  # CreateTopic请求参数结构体
707
723
  class CreateTopicRequest < TencentCloud::Common::AbstractModel
708
- # @param InstanceId: 集群ID
724
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
709
725
  # @type InstanceId: String
710
- # @param Topic: 主题名称
726
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
711
727
  # @type Topic: String
712
728
  # @param TopicType: 主题类型
713
729
  # UNSPECIFIED:未指定,
@@ -716,11 +732,11 @@ module TencentCloud
716
732
  # DELAY:延时消息,
717
733
  # TRANSACTION:事务消息
718
734
  # @type TopicType: String
719
- # @param QueueNum: 队列数量
735
+ # @param QueueNum: 队列数量,取值范围3~16
720
736
  # @type QueueNum: Integer
721
- # @param Remark: 备注
737
+ # @param Remark: 备注,最多 128 字符
722
738
  # @type Remark: String
723
- # @param MsgTTL: 消息保留时长
739
+ # @param MsgTTL: 消息保留时长(单位:小时)
724
740
  # @type MsgTTL: Integer
725
741
  # @param TagList: 标签列表
726
742
  # @type TagList: Array
@@ -803,9 +819,9 @@ module TencentCloud
803
819
 
804
820
  # DeleteConsumerGroup请求参数结构体
805
821
  class DeleteConsumerGroupRequest < TencentCloud::Common::AbstractModel
806
- # @param InstanceId: 集群ID
822
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
807
823
  # @type InstanceId: String
808
- # @param ConsumerGroup: 消费组名称
824
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
809
825
  # @type ConsumerGroup: String
810
826
 
811
827
  attr_accessor :InstanceId, :ConsumerGroup
@@ -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
@@ -1007,9 +1023,9 @@ module TencentCloud
1007
1023
 
1008
1024
  # DeleteRole请求参数结构体
1009
1025
  class DeleteRoleRequest < TencentCloud::Common::AbstractModel
1010
- # @param InstanceId: 集群ID
1026
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1011
1027
  # @type InstanceId: String
1012
- # @param Role: 角色名称
1028
+ # @param Role: 角色名称,从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
1013
1029
  # @type Role: String
1014
1030
 
1015
1031
  attr_accessor :InstanceId, :Role
@@ -1075,9 +1091,9 @@ module TencentCloud
1075
1091
 
1076
1092
  # DeleteTopic请求参数结构体
1077
1093
  class DeleteTopicRequest < TencentCloud::Common::AbstractModel
1078
- # @param InstanceId: 集群ID
1094
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1079
1095
  # @type InstanceId: String
1080
- # @param Topic: 主题名称
1096
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
1081
1097
  # @type Topic: String
1082
1098
 
1083
1099
  attr_accessor :InstanceId, :Topic
@@ -1109,19 +1125,89 @@ module TencentCloud
1109
1125
  end
1110
1126
  end
1111
1127
 
1128
+ # DescribeConsumerClientList请求参数结构体
1129
+ class DescribeConsumerClientListRequest < TencentCloud::Common::AbstractModel
1130
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1131
+ # @type InstanceId: String
1132
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
1133
+ # @type ConsumerGroup: String
1134
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1135
+ # @type Filters: Array
1136
+ # @param Offset: 查询起始位置,默认为0。
1137
+ # @type Offset: Integer
1138
+ # @param Limit: 查询结果限制数量,默认20。
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
- # @param InstanceId: 集群ID
1200
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1115
1201
  # @type InstanceId: String
1116
- # @param ClientId: 客户端ID
1202
+ # @param ClientId: 客户端ID,从 [DescribeConsumerClientList](https://cloud.tencent.com/document/api/1493/120140) 接口中的 [ConsumerClient](https://cloud.tencent.com/document/api/1493/96031#ConsumerClient) 出参中获得。
1117
1203
  # @type ClientId: String
1118
- # @param Filters: 查询条件列表
1204
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1119
1205
  # @type Filters: Array
1120
- # @param Offset: 查询起始位置
1206
+ # @param Offset: 查询起始位置,默认为0。
1121
1207
  # @type Offset: Integer
1122
- # @param Limit: 查询结果限制数量
1208
+ # @param Limit: 查询结果限制数量,默认20。
1123
1209
  # @type Limit: Integer
1124
- # @param ConsumerGroup: 消费组名称
1210
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
1125
1211
  # @type ConsumerGroup: String
1126
1212
 
1127
1213
  attr_accessor :InstanceId, :ClientId, :Filters, :Offset, :Limit, :ConsumerGroup
@@ -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
@@ -1260,9 +1346,9 @@ module TencentCloud
1260
1346
 
1261
1347
  # DescribeConsumerGroup请求参数结构体
1262
1348
  class DescribeConsumerGroupRequest < TencentCloud::Common::AbstractModel
1263
- # @param InstanceId: 集群ID
1349
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1264
1350
  # @type InstanceId: String
1265
- # @param ConsumerGroup: 消费组名称
1351
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
1266
1352
  # @type ConsumerGroup: String
1267
1353
 
1268
1354
  attr_accessor :InstanceId, :ConsumerGroup
@@ -1286,9 +1372,13 @@ module TencentCloud
1286
1372
  # @type Tps: Integer
1287
1373
  # @param ConsumerLag: 消息堆积数量
1288
1374
  # @type ConsumerLag: Integer
1289
- # @param ConsumeType: 消费者类型
1375
+ # @param ConsumeType: 消费类型,枚举值如下:
1376
+
1377
+ # - PULL:PULL 消费类型
1378
+ # - PUSH:PUSH 消费类型
1379
+ # - POP:POP 消费类型
1290
1380
  # @type ConsumeType: String
1291
- # @param CreatedTime: 创建时间,秒为单位
1381
+ # @param CreatedTime: 创建时间,**Unix时间戳(毫秒)**
1292
1382
  # @type CreatedTime: Integer
1293
1383
  # @param ConsumeMessageOrderly: 顺序投递:true
1294
1384
  # 并发投递:false
@@ -1339,13 +1429,13 @@ module TencentCloud
1339
1429
 
1340
1430
  # DescribeConsumerLag请求参数结构体
1341
1431
  class DescribeConsumerLagRequest < TencentCloud::Common::AbstractModel
1342
- # @param InstanceId: 集群ID
1432
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1343
1433
  # @type InstanceId: String
1344
- # @param ConsumerGroup: 消费组名称
1434
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
1345
1435
  # @type ConsumerGroup: String
1346
- # @param Namespace: 命名空间,4.x集群必填
1436
+ # @param Namespace: 命名空间,4.x集群必填,从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口或控制台获得。
1347
1437
  # @type Namespace: String
1348
- # @param SubscribeTopic: 订阅主题,不为空则查询订阅了该主题的消费组的堆积
1438
+ # @param SubscribeTopic: 订阅主题,不为空则查询订阅了该主题的消费组的堆积,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
1349
1439
  # @type SubscribeTopic: String
1350
1440
 
1351
1441
  attr_accessor :InstanceId, :ConsumerGroup, :Namespace, :SubscribeTopic
@@ -1387,11 +1477,11 @@ module TencentCloud
1387
1477
 
1388
1478
  # DescribeFusionInstanceList请求参数结构体
1389
1479
  class DescribeFusionInstanceListRequest < TencentCloud::Common::AbstractModel
1390
- # @param Offset: 查询起始位置
1480
+ # @param Offset: 查询起始位置,默认为0。
1391
1481
  # @type Offset: Integer
1392
- # @param Limit: 查询结果限制数量
1482
+ # @param Limit: 查询结果限制数量,默认20。
1393
1483
  # @type Limit: Integer
1394
- # @param Filters: 查询条件列表
1484
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1395
1485
  # @type Filters: Array
1396
1486
  # @param TagFilters: 标签过滤器
1397
1487
  # @type TagFilters: Array
@@ -1460,13 +1550,13 @@ module TencentCloud
1460
1550
 
1461
1551
  # DescribeInstanceList请求参数结构体
1462
1552
  class DescribeInstanceListRequest < TencentCloud::Common::AbstractModel
1463
- # @param Filters: 查询条件列表
1553
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
1464
1554
  # @type Filters: Array
1465
1555
  # @param TagFilters: 标签过滤器
1466
1556
  # @type TagFilters: Array
1467
- # @param Offset: 查询起始位置
1557
+ # @param Offset: 查询起始位置,默认为0。
1468
1558
  # @type Offset: Integer
1469
- # @param Limit: 查询结果限制数量
1559
+ # @param Limit: 查询结果限制数量,默认20。
1470
1560
  # @type Limit: Integer
1471
1561
 
1472
1562
  attr_accessor :Filters, :TagFilters, :Offset, :Limit
@@ -1533,7 +1623,7 @@ module TencentCloud
1533
1623
 
1534
1624
  # DescribeInstance请求参数结构体
1535
1625
  class DescribeInstanceRequest < TencentCloud::Common::AbstractModel
1536
- # @param InstanceId: 集群ID
1626
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
1537
1627
  # @type InstanceId: String
1538
1628
 
1539
1629
  attr_accessor :InstanceId
@@ -1579,7 +1669,7 @@ module TencentCloud
1579
1669
  # @type ScaledTpsLimit: Integer
1580
1670
  # @param MaxMessageDelay: 延迟消息最长时间,小时为单位
1581
1671
  # @type MaxMessageDelay: Integer
1582
- # @param CreatedTime: 创建时间,秒为单位
1672
+ # @param CreatedTime: 创建时间,**Unix时间戳(毫秒)**
1583
1673
  # @type CreatedTime: Integer
1584
1674
  # @param SendReceiveRatio: 消息发送接收比例
1585
1675
  # @type SendReceiveRatio: Float
@@ -1595,17 +1685,33 @@ module TencentCloud
1595
1685
  # @type TopicQueueNumLowerLimit: Integer
1596
1686
  # @param Remark: 备注信息
1597
1687
  # @type Remark: String
1598
- # @param InstanceStatus: 实例状态
1688
+ # @param InstanceStatus: 实例状态,枚举值如下:
1689
+
1690
+ # - RUNNING:运行中
1691
+ # - ABNORMAL:异常
1692
+ # - OVERDUE:隔离中
1693
+ # - DESTROYED:已销毁
1694
+ # - CREATING:创建中
1695
+ # - MODIFYING:变配中
1696
+ # - CREATE_FAILURE:创建失败
1697
+ # - MODIFY_FAILURE:变配失败
1698
+ # - DELETING:删除中
1599
1699
  # @type InstanceStatus: String
1600
1700
  # @param SkuCode: 实例规格
1601
1701
  # @type SkuCode: String
1602
- # @param PayMode: 计费模式
1702
+ # @param PayMode: 计费模式,枚举值如下:
1703
+
1704
+ # - POSTPAID:后付费按量计费
1705
+ # - PREPAID:预付费包年包月
1603
1706
  # @type PayMode: String
1604
1707
  # @param ScaledTpsEnabled: 是否开启弹性TPS
1605
1708
  # @type ScaledTpsEnabled: Boolean
1606
- # @param RenewFlag: 是否自动续费
1709
+ # @param RenewFlag: 预付费集群是否自动续费,枚举值如下:
1710
+
1711
+ # - 0: 不自动续费
1712
+ # - 1: 自动续费
1607
1713
  # @type RenewFlag: Integer
1608
- # @param ExpiryTime: 到期时间
1714
+ # @param ExpiryTime: 到期时间,**Unix时间戳(毫秒)**
1609
1715
  # @type ExpiryTime: Integer
1610
1716
  # @param RoleNumLimit: 角色数量限制
1611
1717
  # @type RoleNumLimit: Integer
@@ -1618,7 +1724,7 @@ module TencentCloud
1618
1724
  # @param TopicNumUpperLimit: 最大可设置的topic个数
1619
1725
  # 注意:此字段可能返回 null,表示取不到有效值。
1620
1726
  # @type TopicNumUpperLimit: Integer
1621
- # @param ZoneIds: 可用区列表
1727
+ # @param ZoneIds: 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
1622
1728
  # @type ZoneIds: Array
1623
1729
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1624
1730
  # @type RequestId: String
@@ -2500,31 +2606,31 @@ module TencentCloud
2500
2606
 
2501
2607
  # DescribeMessageList请求参数结构体
2502
2608
  class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
2503
- # @param InstanceId: 集群ID
2609
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2504
2610
  # @type InstanceId: String
2505
- # @param Topic: 主题名称
2611
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2506
2612
  # @type Topic: String
2507
- # @param StartTime: 开始时间
2613
+ # @param StartTime: 要查询消息的开始时间,**Unix时间戳(毫秒)**
2508
2614
  # @type StartTime: Integer
2509
- # @param EndTime: 结束时间
2615
+ # @param EndTime: 要查询消息的结束时间,**Unix时间戳(毫秒)**
2510
2616
  # @type EndTime: Integer
2511
- # @param TaskRequestId: 一次查询标识
2617
+ # @param TaskRequestId: 一次查询标识。第一次查询可传空字符串,当查询结果涉及分页,请求下一页数据时该入参的值取上一次请求响应中的出参TaskRequestId 值即可。
2512
2618
  # @type TaskRequestId: String
2513
- # @param Offset: 查询起始位置
2619
+ # @param Offset: 查询起始位置,默认为0。
2514
2620
  # @type Offset: Integer
2515
- # @param Limit: 查询结果限制数量
2621
+ # @param Limit: 查询结果限制数量,默认20。
2516
2622
  # @type Limit: Integer
2517
- # @param ConsumerGroup: 消费组名称
2623
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
2518
2624
  # @type ConsumerGroup: String
2519
- # @param MsgId: 消息 ID
2625
+ # @param MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2520
2626
  # @type MsgId: String
2521
- # @param MsgKey: 消息 Key
2627
+ # @param MsgKey: 消息 Key,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2522
2628
  # @type MsgKey: String
2523
2629
  # @param RecentMessageNum: 查询最近N条消息 最大不超过1024,默认-1为其他查询条件
2524
2630
  # @type RecentMessageNum: Integer
2525
- # @param QueryDeadLetterMessage: 是否查询死信消息
2631
+ # @param QueryDeadLetterMessage: 是否查询死信消息,默认为false
2526
2632
  # @type QueryDeadLetterMessage: Boolean
2527
- # @param Tag: 消息 Tag
2633
+ # @param Tag: 消息 Tag,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2528
2634
  # @type Tag: String
2529
2635
 
2530
2636
  attr_accessor :InstanceId, :Topic, :StartTime, :EndTime, :TaskRequestId, :Offset, :Limit, :ConsumerGroup, :MsgId, :MsgKey, :RecentMessageNum, :QueryDeadLetterMessage, :Tag
@@ -2601,19 +2707,19 @@ module TencentCloud
2601
2707
 
2602
2708
  # DescribeMessage请求参数结构体
2603
2709
  class DescribeMessageRequest < TencentCloud::Common::AbstractModel
2604
- # @param InstanceId: 集群ID
2710
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2605
2711
  # @type InstanceId: String
2606
- # @param Topic: 主题名称
2712
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2607
2713
  # @type Topic: String
2608
- # @param MsgId: 消息ID
2714
+ # @param MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2609
2715
  # @type MsgId: String
2610
- # @param Offset: 查询起始位置
2716
+ # @param Offset: 查询起始位置,默认为0。
2611
2717
  # @type Offset: Integer
2612
- # @param Limit: 查询结果限制数量
2718
+ # @param Limit: 查询结果限制数量,默认20。
2613
2719
  # @type Limit: Integer
2614
- # @param QueryDeadLetterMessage: 是否是死信消息
2720
+ # @param QueryDeadLetterMessage: 是否是死信消息,默认为false
2615
2721
  # @type QueryDeadLetterMessage: Boolean
2616
- # @param QueryDelayMessage: 是否是延时消息
2722
+ # @param QueryDelayMessage: 是否是延时消息,默认为false
2617
2723
  # @type QueryDelayMessage: Boolean
2618
2724
 
2619
2725
  attr_accessor :InstanceId, :Topic, :MsgId, :Offset, :Limit, :QueryDeadLetterMessage, :QueryDelayMessage
@@ -2655,7 +2761,7 @@ module TencentCloud
2655
2761
  # @param MessageTracks: 消息消费情况列表
2656
2762
  # 注意:此字段可能返回 null,表示取不到有效值。
2657
2763
  # @type MessageTracks: Array
2658
- # @param ShowTopicName: Topic
2764
+ # @param ShowTopicName: 主题名称
2659
2765
  # @type ShowTopicName: String
2660
2766
  # @param MessageTracksCount: 消息消费情况列表总条数
2661
2767
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -2699,15 +2805,15 @@ module TencentCloud
2699
2805
 
2700
2806
  # DescribeMessageTrace请求参数结构体
2701
2807
  class DescribeMessageTraceRequest < TencentCloud::Common::AbstractModel
2702
- # @param InstanceId: 集群ID
2808
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
2703
2809
  # @type InstanceId: String
2704
- # @param Topic: 主题名称
2810
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
2705
2811
  # @type Topic: String
2706
- # @param MsgId: 消息ID
2812
+ # @param MsgId: 消息 ID,从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
2707
2813
  # @type MsgId: String
2708
- # @param QueryDeadLetterMessage: 是否是死信消息
2814
+ # @param QueryDeadLetterMessage: 是否是死信消息,默认为false
2709
2815
  # @type QueryDeadLetterMessage: Boolean
2710
- # @param QueryDelayMessage: 是否是延时消息
2816
+ # @param QueryDelayMessage: 是否是延时消息,默认为false
2711
2817
  # @type QueryDelayMessage: Boolean
2712
2818
 
2713
2819
  attr_accessor :InstanceId, :Topic, :MsgId, :QueryDeadLetterMessage, :QueryDelayMessage
@@ -2731,7 +2837,7 @@ module TencentCloud
2731
2837
 
2732
2838
  # DescribeMessageTrace返回参数结构体
2733
2839
  class DescribeMessageTraceResponse < TencentCloud::Common::AbstractModel
2734
- # @param ShowTopicName: 展示Topic名
2840
+ # @param ShowTopicName: 主题名称
2735
2841
  # @type ShowTopicName: String
2736
2842
  # @param Data: 轨迹详情
2737
2843
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -3057,13 +3163,13 @@ module TencentCloud
3057
3163
 
3058
3164
  # DescribeRoleList请求参数结构体
3059
3165
  class DescribeRoleListRequest < TencentCloud::Common::AbstractModel
3060
- # @param InstanceId: 集群ID
3166
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3061
3167
  # @type InstanceId: String
3062
- # @param Offset: 查询起始位置
3168
+ # @param Offset: 查询起始位置,默认为0。
3063
3169
  # @type Offset: Integer
3064
- # @param Limit: 查询结果限制数量
3170
+ # @param Limit: 查询结果限制数量,默认20。
3065
3171
  # @type Limit: Integer
3066
- # @param Filters: 查询条件列表
3172
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3067
3173
  # @type Filters: Array
3068
3174
 
3069
3175
  attr_accessor :InstanceId, :Offset, :Limit, :Filters
@@ -3252,15 +3358,15 @@ module TencentCloud
3252
3358
 
3253
3359
  # DescribeTopicListByGroup请求参数结构体
3254
3360
  class DescribeTopicListByGroupRequest < TencentCloud::Common::AbstractModel
3255
- # @param InstanceId: 集群ID
3361
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3256
3362
  # @type InstanceId: String
3257
- # @param Offset: 查询起始位置
3363
+ # @param Offset: 查询起始位置,默认为0。
3258
3364
  # @type Offset: Integer
3259
- # @param Limit: 查询结果限制数量
3365
+ # @param Limit: 查询结果限制数量,默认20。
3260
3366
  # @type Limit: Integer
3261
- # @param ConsumerGroup: 消费组名称
3367
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
3262
3368
  # @type ConsumerGroup: String
3263
- # @param Filters: 查询条件列表
3369
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3264
3370
  # @type Filters: Array
3265
3371
 
3266
3372
  attr_accessor :InstanceId, :Offset, :Limit, :ConsumerGroup, :Filters
@@ -3322,13 +3428,13 @@ module TencentCloud
3322
3428
 
3323
3429
  # DescribeTopicList请求参数结构体
3324
3430
  class DescribeTopicListRequest < TencentCloud::Common::AbstractModel
3325
- # @param InstanceId: 集群ID
3431
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3326
3432
  # @type InstanceId: String
3327
- # @param Filters: 查询条件列表
3433
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3328
3434
  # @type Filters: Array
3329
- # @param Offset: 查询起始位置
3435
+ # @param Offset: 查询起始位置,默认为0。
3330
3436
  # @type Offset: Integer
3331
- # @param Limit: 查询结果限制数量
3437
+ # @param Limit: 查询结果限制数量,默认20。
3332
3438
  # @type Limit: Integer
3333
3439
 
3334
3440
  attr_accessor :InstanceId, :Filters, :Offset, :Limit
@@ -3388,15 +3494,15 @@ module TencentCloud
3388
3494
 
3389
3495
  # DescribeTopic请求参数结构体
3390
3496
  class DescribeTopicRequest < TencentCloud::Common::AbstractModel
3391
- # @param InstanceId: 集群ID
3497
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
3392
3498
  # @type InstanceId: String
3393
- # @param Topic: 主题名称
3499
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
3394
3500
  # @type Topic: String
3395
- # @param Filters: 查询条件列表
3501
+ # @param Filters: 过滤查询条件列表,请在引用此参数的API说明中了解使用方法。
3396
3502
  # @type Filters: Array
3397
- # @param Offset: 查询起始位置
3503
+ # @param Offset: 查询起始位置,默认为0。
3398
3504
  # @type Offset: Integer
3399
- # @param Limit: 查询结果限制数量
3505
+ # @param Limit: 查询结果限制数量,默认20。
3400
3506
  # @type Limit: Integer
3401
3507
 
3402
3508
  attr_accessor :InstanceId, :Topic, :Filters, :Offset, :Limit
@@ -3492,6 +3598,8 @@ module TencentCloud
3492
3598
  # Topic&Group维度的权限配置
3493
3599
  class DetailedRolePerm < TencentCloud::Common::AbstractModel
3494
3600
  # @param Resource: 权限对应的资源
3601
+ # 可以是主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
3602
+ # 可以是消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
3495
3603
  # @type Resource: String
3496
3604
  # @param PermWrite: 是否开启生产权限
3497
3605
  # @type PermWrite: Boolean
@@ -3593,10 +3701,13 @@ module TencentCloud
3593
3701
 
3594
3702
  # 接入点信息
3595
3703
  class Endpoint < TencentCloud::Common::AbstractModel
3596
- # @param Type: 接入点类型,枚举值如下
3597
- # VPC: VPC;
3598
- # PUBLIC: 公网;
3599
- # INTERNAL: 支撑网;
3704
+ # @param Type: 接入点类型,枚举值如下:
3705
+
3706
+ # - VPC:VPC 网络
3707
+
3708
+ # - PUBLIC:公网
3709
+
3710
+ # - INTERNAL:支撑网
3600
3711
  # @type Type: String
3601
3712
  # @param Status: 状态,
3602
3713
  # OPEN 开启,
@@ -3711,11 +3822,13 @@ module TencentCloud
3711
3822
  # @type TopicNumLimit: Integer
3712
3823
  # @param GroupNumLimit: 实例消费组数量上限
3713
3824
  # @type GroupNumLimit: Integer
3714
- # @param PayMode: 计费模式,
3715
- # POSTPAID,按量计费
3716
- # PREPAID,包年包月
3825
+ # @param PayMode: 计费模式,枚举值如下:
3826
+
3827
+ # - POSTPAID:按量计费
3828
+
3829
+ # - PREPAID:包年包月
3717
3830
  # @type PayMode: String
3718
- # @param ExpiryTime: 到期时间,秒为单位
3831
+ # @param ExpiryTime: 到期时间,**Unix时间戳(毫秒)**
3719
3832
  # 注意:此字段可能返回 null,表示取不到有效值。
3720
3833
  # @type ExpiryTime: Integer
3721
3834
  # @param Remark: 备注信息
@@ -3734,24 +3847,23 @@ module TencentCloud
3734
3847
  # 注意:此字段可能返回 null,表示取不到有效值。
3735
3848
  # @type TpsLimit: Integer
3736
3849
  # @param ScaledTpsLimit: 弹性TPS限流值
3737
- # 注意:此字段可能返回 null,表示取不到有效值。
3738
3850
  # @type ScaledTpsLimit: Integer
3739
3851
  # @param MessageRetention: 消息保留时间,小时为单位
3740
- # 注意:此字段可能返回 null,表示取不到有效值。
3741
3852
  # @type MessageRetention: Integer
3742
3853
  # @param MaxMessageDelay: 延迟消息最大时长,小时为单位
3743
- # 注意:此字段可能返回 null,表示取不到有效值。
3744
3854
  # @type MaxMessageDelay: Integer
3745
- # @param RenewFlag: 是否自动续费
3746
- # 注意:此字段可能返回 null,表示取不到有效值。
3855
+ # @param RenewFlag: 预付费集群是否自动续费,枚举值如下:
3856
+
3857
+ # - 0: 不自动续费
3858
+ # - 1: 自动续费
3747
3859
  # @type RenewFlag: Integer
3748
3860
  # @param InstanceItemExtraInfo: 4.x独有数据
3749
3861
  # 注意:此字段可能返回 null,表示取不到有效值。
3750
3862
  # @type InstanceItemExtraInfo: :class:`Tencentcloud::Trocket.v20230308.models.InstanceItemExtraInfo`
3751
- # @param DestroyTime: 预销毁时间
3863
+ # @param DestroyTime: 预销毁时间,**Unix时间戳(毫秒)**
3752
3864
  # 注意:此字段可能返回 null,表示取不到有效值。
3753
3865
  # @type DestroyTime: Integer
3754
- # @param ZoneIds: 所属可用区列表
3866
+ # @param ZoneIds: 所属可用区列表,参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口。
3755
3867
  # 注意:此字段可能返回 null,表示取不到有效值。
3756
3868
  # @type ZoneIds: Array
3757
3869
  # @param EnableDeletionProtection: 是否开启删除保护
@@ -3938,11 +4050,13 @@ module TencentCloud
3938
4050
  # @type TopicNumLimit: Integer
3939
4051
  # @param GroupNumLimit: 实例消费组数量上限
3940
4052
  # @type GroupNumLimit: Integer
3941
- # @param PayMode: 计费模式,
3942
- # POSTPAID,按量计费
3943
- # PREPAID,包年包月
4053
+ # @param PayMode: 计费模式,枚举值如下:
4054
+
4055
+ # - POSTPAID:按量计费
4056
+
4057
+ # - PREPAID:包年包月
3944
4058
  # @type PayMode: String
3945
- # @param ExpiryTime: 到期时间,秒为单位
4059
+ # @param ExpiryTime: 到期时间戳,**Unix时间戳(毫秒)**
3946
4060
  # 注意:此字段可能返回 null,表示取不到有效值。
3947
4061
  # @type ExpiryTime: Integer
3948
4062
  # @param Remark: 备注信息
@@ -3958,19 +4072,14 @@ module TencentCloud
3958
4072
  # @param SkuCode: 商品规格
3959
4073
  # @type SkuCode: String
3960
4074
  # @param TpsLimit: TPS限流值
3961
- # 注意:此字段可能返回 null,表示取不到有效值。
3962
4075
  # @type TpsLimit: Integer
3963
4076
  # @param ScaledTpsLimit: 弹性TPS限流值
3964
- # 注意:此字段可能返回 null,表示取不到有效值。
3965
4077
  # @type ScaledTpsLimit: Integer
3966
4078
  # @param MessageRetention: 消息保留时间,小时为单位
3967
- # 注意:此字段可能返回 null,表示取不到有效值。
3968
4079
  # @type MessageRetention: Integer
3969
4080
  # @param MaxMessageDelay: 延迟消息最大时长,小时为单位
3970
- # 注意:此字段可能返回 null,表示取不到有效值。
3971
4081
  # @type MaxMessageDelay: Integer
3972
- # @param RenewFlag: 是否自动续费
3973
- # 注意:此字段可能返回 null,表示取不到有效值。
4082
+ # @param RenewFlag: 是否自动续费,仅针对预付费集群(0: 不自动续费;1:自动续费)
3974
4083
  # @type RenewFlag: Integer
3975
4084
 
3976
4085
  attr_accessor :InstanceId, :InstanceName, :Version, :InstanceType, :InstanceStatus, :TopicNumLimit, :GroupNumLimit, :PayMode, :ExpiryTime, :Remark, :TopicNum, :GroupNum, :TagList, :SkuCode, :TpsLimit, :ScaledTpsLimit, :MessageRetention, :MaxMessageDelay, :RenewFlag
@@ -4092,10 +4201,9 @@ module TencentCloud
4092
4201
  class IpRule < TencentCloud::Common::AbstractModel
4093
4202
  # @param Ip: IP地址
4094
4203
  # @type Ip: String
4095
- # @param Allow: 是否允许放行
4204
+ # @param Allow: 是否允许放行,默认为false表示拒绝
4096
4205
  # @type Allow: Boolean
4097
4206
  # @param Remark: 备注信息
4098
- # 注意:此字段可能返回 null,表示取不到有效值。
4099
4207
  # @type Remark: String
4100
4208
 
4101
4209
  attr_accessor :Ip, :Allow, :Remark
@@ -4494,7 +4602,13 @@ module TencentCloud
4494
4602
 
4495
4603
  # 消息轨迹
4496
4604
  class MessageTraceItem < TencentCloud::Common::AbstractModel
4497
- # @param Stage: 步骤
4605
+ # @param Stage: 消息处理阶段,枚举值如下:
4606
+
4607
+ # - produce:消息生产
4608
+
4609
+ # - persist:消息存储
4610
+
4611
+ # - consume:消息消费
4498
4612
  # 注意:此字段可能返回 null,表示取不到有效值。
4499
4613
  # @type Stage: String
4500
4614
  # @param Data: 轨迹详情
@@ -4642,18 +4756,18 @@ module TencentCloud
4642
4756
 
4643
4757
  # ModifyConsumerGroup请求参数结构体
4644
4758
  class ModifyConsumerGroupRequest < TencentCloud::Common::AbstractModel
4645
- # @param InstanceId: 集群ID
4759
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4646
4760
  # @type InstanceId: String
4647
- # @param ConsumerGroup: 消费组名称
4761
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
4648
4762
  # @type ConsumerGroup: String
4649
4763
  # @param ConsumeEnable: 是否开启消费
4650
4764
  # @type ConsumeEnable: Boolean
4651
4765
  # @param ConsumeMessageOrderly: 顺序投递:true
4652
4766
  # 并发投递:false
4653
4767
  # @type ConsumeMessageOrderly: Boolean
4654
- # @param MaxRetryTimes: 最大重试次数
4768
+ # @param MaxRetryTimes: 最大重试次数,取值范围0~1000
4655
4769
  # @type MaxRetryTimes: Integer
4656
- # @param Remark: 备注
4770
+ # @param Remark: 备注信息,最多 128 个字符
4657
4771
  # @type Remark: String
4658
4772
 
4659
4773
  attr_accessor :InstanceId, :ConsumerGroup, :ConsumeEnable, :ConsumeMessageOrderly, :MaxRetryTimes, :Remark
@@ -4695,7 +4809,7 @@ module TencentCloud
4695
4809
 
4696
4810
  # ModifyInstanceEndpoint请求参数结构体
4697
4811
  class ModifyInstanceEndpointRequest < TencentCloud::Common::AbstractModel
4698
- # @param InstanceId: 集群ID
4812
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4699
4813
  # @type InstanceId: String
4700
4814
  # @param Type: 接入点类型,
4701
4815
  # PUBLIC 公网
@@ -4751,25 +4865,32 @@ module TencentCloud
4751
4865
 
4752
4866
  # ModifyInstance请求参数结构体
4753
4867
  class ModifyInstanceRequest < TencentCloud::Common::AbstractModel
4754
- # @param InstanceId: 集群ID
4868
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
4755
4869
  # @type InstanceId: String
4756
- # @param Name: 实例名称
4870
+ # @param Name: 实例名称,不能为空, 3-64个字符,只能包含数字、字母、“-”和“_”
4757
4871
  # @type Name: String
4758
- # @param Remark: 备注信息
4872
+ # @param Remark: 备注信息,最多 128 个字符
4759
4873
  # @type Remark: String
4760
4874
  # @param SendReceiveRatio: 消息发送和接收的比例
4761
4875
  # @type SendReceiveRatio: Float
4762
- # @param SkuCode: 调整实例规格的商品代号
4876
+ # @param SkuCode: 商品规格,从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
4763
4877
  # @type SkuCode: String
4764
- # @param MessageRetention: 消息保留时长,小时为单位
4878
+ # @param MessageRetention: 消息保留时长(单位:小时),取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
4879
+
4880
+ # - 默认值:DefaultRetention 参数
4881
+ # - 最小值:RetentionLowerLimit 参数
4882
+ # - 最大值:RetentionUpperLimit 参数
4765
4883
  # @type MessageRetention: Integer
4766
4884
  # @param ScaledTpsEnabled: 是否开启弹性TPS
4767
4885
  # @type ScaledTpsEnabled: Boolean
4768
4886
  # @param AclEnabled: 是否开启ACL
4769
4887
  # @type AclEnabled: Boolean
4770
- # @param MaxTopicNum: 最大可创建主题数
4888
+ # @param MaxTopicNum: 最大可创建主题数,取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参:
4889
+
4890
+ # - 最小值和默认值:TopicNumLimit 参数
4891
+ # - 最大值:TopicNumUpperLimit 参数
4771
4892
  # @type MaxTopicNum: Integer
4772
- # @param ExtraTopicNum: 免费额度之外的主题个数
4893
+ # @param ExtraTopicNum: 免费额度之外的主题个数,免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参中的 TopicNumLimit 参数。
4773
4894
  # @type ExtraTopicNum: String
4774
4895
  # @param EnableDeletionProtection: 是否开启删除保护
4775
4896
  # @type EnableDeletionProtection: Boolean
@@ -5038,9 +5159,9 @@ module TencentCloud
5038
5159
 
5039
5160
  # ModifyRole请求参数结构体
5040
5161
  class ModifyRoleRequest < TencentCloud::Common::AbstractModel
5041
- # @param InstanceId: 集群ID
5162
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
5042
5163
  # @type InstanceId: String
5043
- # @param Role: 角色名称
5164
+ # @param Role: 角色名称,从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口或控制台获得。
5044
5165
  # @type Role: String
5045
5166
  # @param PermRead: 是否开启消费
5046
5167
  # @type PermRead: Boolean
@@ -5050,7 +5171,7 @@ module TencentCloud
5050
5171
  # @type PermType: String
5051
5172
  # @param Remark: 备注
5052
5173
  # @type Remark: String
5053
- # @param DetailedPerms: Topic&Group维度权限配置
5174
+ # @param DetailedPerms: Topic&Group维度权限配置,权限类型为 TopicAndGroup 时必填
5054
5175
  # @type DetailedPerms: Array
5055
5176
 
5056
5177
  attr_accessor :InstanceId, :Role, :PermRead, :PermWrite, :PermType, :Remark, :DetailedPerms
@@ -5101,15 +5222,15 @@ module TencentCloud
5101
5222
 
5102
5223
  # ModifyTopic请求参数结构体
5103
5224
  class ModifyTopicRequest < TencentCloud::Common::AbstractModel
5104
- # @param InstanceId: 集群ID
5225
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
5105
5226
  # @type InstanceId: String
5106
- # @param Topic: 主题名称
5227
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
5107
5228
  # @type Topic: String
5108
- # @param QueueNum: 队列数量
5229
+ # @param QueueNum: 队列数量,取值范围3~16
5109
5230
  # @type QueueNum: Integer
5110
- # @param Remark: 备注信息
5231
+ # @param Remark: 备注信息,最多 128 个字符
5111
5232
  # @type Remark: String
5112
- # @param MsgTTL: 消息保留时长
5233
+ # @param MsgTTL: 消息保留时长(单位:小时)
5113
5234
  # @type MsgTTL: Integer
5114
5235
 
5115
5236
  attr_accessor :InstanceId, :Topic, :QueueNum, :Remark, :MsgTTL
@@ -5206,35 +5327,26 @@ module TencentCloud
5206
5327
  # @param SkuCode: 规格代码
5207
5328
  # @type SkuCode: String
5208
5329
  # @param TpsLimit: TPS上限
5209
- # 注意:此字段可能返回 null,表示取不到有效值。
5210
5330
  # @type TpsLimit: Integer
5211
5331
  # @param ScaledTpsLimit: 弹性TPS上限
5212
- # 注意:此字段可能返回 null,表示取不到有效值。
5213
5332
  # @type ScaledTpsLimit: Integer
5214
5333
  # @param TopicNumLimit: 主题数量上限默认值
5215
- # 注意:此字段可能返回 null,表示取不到有效值。
5216
5334
  # @type TopicNumLimit: Integer
5217
5335
  # @param GroupNumLimit: 消费组数量上限
5218
- # 注意:此字段可能返回 null,表示取不到有效值。
5219
5336
  # @type GroupNumLimit: Integer
5220
5337
  # @param DefaultRetention: 默认消息保留时间,小时为单位
5221
- # 注意:此字段可能返回 null,表示取不到有效值。
5222
5338
  # @type DefaultRetention: Integer
5223
5339
  # @param RetentionUpperLimit: 可调整消息保留时间上限,小时为单位
5224
- # 注意:此字段可能返回 null,表示取不到有效值。
5225
5340
  # @type RetentionUpperLimit: Integer
5226
5341
  # @param RetentionLowerLimit: 可调整消息保留时间下限,小时为单位
5227
- # 注意:此字段可能返回 null,表示取不到有效值。
5228
5342
  # @type RetentionLowerLimit: Integer
5229
5343
  # @param MaxMessageDelay: 延时消息最大时长,小时为单位
5230
- # 注意:此字段可能返回 null,表示取不到有效值。
5231
5344
  # @type MaxMessageDelay: Integer
5232
5345
  # @param OnSale: 是否可购买
5233
5346
  # @type OnSale: Boolean
5234
5347
  # @param PriceTags: 计费项信息
5235
5348
  # @type PriceTags: Array
5236
5349
  # @param TopicNumUpperLimit: 主题数量上限默认最大值
5237
- # 注意:此字段可能返回 null,表示取不到有效值。
5238
5350
  # @type TopicNumUpperLimit: Integer
5239
5351
 
5240
5352
  attr_accessor :InstanceType, :SkuCode, :TpsLimit, :ScaledTpsLimit, :TopicNumLimit, :GroupNumLimit, :DefaultRetention, :RetentionUpperLimit, :RetentionLowerLimit, :MaxMessageDelay, :OnSale, :PriceTags, :TopicNumUpperLimit
@@ -5393,13 +5505,13 @@ module TencentCloud
5393
5505
 
5394
5506
  # ResetConsumerGroupOffset请求参数结构体
5395
5507
  class ResetConsumerGroupOffsetRequest < TencentCloud::Common::AbstractModel
5396
- # @param InstanceId: 集群ID
5508
+ # @param InstanceId: 腾讯云 RocketMQ 实例 ID,从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1493/96028) 接口或控制台获得。
5397
5509
  # @type InstanceId: String
5398
- # @param Topic: 主题名称
5510
+ # @param Topic: 主题名称,从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口或控制台获得。
5399
5511
  # @type Topic: String
5400
- # @param ResetTimestamp: 重置位点时间(单位:毫秒)-1表示重置到最新位点
5512
+ # @param ResetTimestamp: 重置位点的时间戳(单位:毫秒),指定为 -1 时表示重置到最新位点
5401
5513
  # @type ResetTimestamp: Integer
5402
- # @param ConsumerGroup: 消费组名称
5514
+ # @param ConsumerGroup: 消费组名称,从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口或控制台获得。
5403
5515
  # @type ConsumerGroup: String
5404
5516
 
5405
5517
  attr_accessor :InstanceId, :Topic, :ResetTimestamp, :ConsumerGroup
@@ -5449,9 +5561,9 @@ module TencentCloud
5449
5561
  # @type SecretKey: String
5450
5562
  # @param Remark: 备注信息
5451
5563
  # @type Remark: String
5452
- # @param CreatedTime: 创建时间,秒为单位
5564
+ # @param CreatedTime: 角色的创建时间,**Unix时间戳(毫秒)**
5453
5565
  # @type CreatedTime: Integer
5454
- # @param ModifiedTime: 修改时间,秒为单位
5566
+ # @param ModifiedTime: 角色的更新时间,**Unix时间戳(毫秒)**
5455
5567
  # @type ModifiedTime: Integer
5456
5568
  # @param PermType: 权限类型,默认按集群授权(Cluster:集群级别;TopicAndGroup:主题&消费组级别)
5457
5569
  # @type PermType: String
@@ -5781,7 +5893,11 @@ module TencentCloud
5781
5893
  # @param IsOnline: 是否在线
5782
5894
  # 注意:此字段可能返回 null,表示取不到有效值。
5783
5895
  # @type IsOnline: Boolean
5784
- # @param ConsumeType: 消费类型
5896
+ # @param ConsumeType: 消费类型,枚举值如下:
5897
+
5898
+ # - PULL:PULL 消费类型
5899
+ # - PUSH:PUSH 消费类型
5900
+ # - POP:POP 消费类型
5785
5901
  # 注意:此字段可能返回 null,表示取不到有效值。
5786
5902
  # @type ConsumeType: String
5787
5903
  # @param SubString: 订阅规则
@@ -5790,7 +5906,10 @@ module TencentCloud
5790
5906
  # @param ExpressionType: 过滤类型
5791
5907
  # 注意:此字段可能返回 null,表示取不到有效值。
5792
5908
  # @type ExpressionType: String
5793
- # @param Consistency: 订阅一致性
5909
+ # @param Consistency: 订阅一致性,枚举如下:
5910
+
5911
+ # - 0: 订阅一致
5912
+ # - 1: 订阅不一致
5794
5913
  # 注意:此字段可能返回 null,表示取不到有效值。
5795
5914
  # @type Consistency: Integer
5796
5915
  # @param ConsumerLag: 消费堆积
@@ -5908,15 +6027,20 @@ module TencentCloud
5908
6027
  class TopicConsumeStats < TencentCloud::Common::AbstractModel
5909
6028
  # @param Topic: 主题名称
5910
6029
  # @type Topic: String
5911
- # @param TopicType: 主题类型
6030
+ # @param TopicType: 主题类型,枚举值如下:
6031
+
6032
+ # - NORMAL:普通消息主题
6033
+ # - FIFO:顺序消息主题
6034
+ # - DELAY:延迟消息主题
6035
+ # - TRANSACTION:事务消息主题
5912
6036
  # @type TopicType: String
5913
6037
  # @param QueueNum: 单节点主题队列数量
5914
6038
  # @type QueueNum: Integer
5915
6039
  # @param ConsumerLag: 消费堆积
5916
6040
  # @type ConsumerLag: Integer
5917
- # @param SubString: 订阅规则
6041
+ # @param SubString: 订阅规则,`*`表示订阅全部TAG
5918
6042
  # @type SubString: String
5919
- # @param LastUpdateTime: 最后消费进度更新时间
6043
+ # @param LastUpdateTime: 最后消费进度更新时间,**Unix时间戳(毫秒)**
5920
6044
  # @type LastUpdateTime: Integer
5921
6045
 
5922
6046
  attr_accessor :Topic, :TopicType, :QueueNum, :ConsumerLag, :SubString, :LastUpdateTime
@@ -5954,7 +6078,7 @@ module TencentCloud
5954
6078
  # @type TopicType: String
5955
6079
  # @param QueueNum: 队列数量
5956
6080
  # @type QueueNum: Integer
5957
- # @param Remark: 描述
6081
+ # @param Remark: 备注信息
5958
6082
  # @type Remark: String
5959
6083
  # @param ClusterIdV4: 4.x的集群id
5960
6084
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -5969,7 +6093,6 @@ module TencentCloud
5969
6093
  # 注意:此字段可能返回 null,表示取不到有效值。
5970
6094
  # @type FullNamespaceV4: String
5971
6095
  # @param MsgTTL: 消息保留时长
5972
- # 注意:此字段可能返回 null,表示取不到有效值。
5973
6096
  # @type MsgTTL: Integer
5974
6097
 
5975
6098
  attr_accessor :InstanceId, :Topic, :TopicType, :QueueNum, :Remark, :ClusterIdV4, :NamespaceV4, :TopicV4, :FullNamespaceV4, :MsgTTL
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.1090
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-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common