tencentcloud-sdk-trocket 3.0.1089 → 3.0.1092
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 +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20230308/client.rb +48 -20
- data/lib/v20230308/models.rb +126 -108
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 34a3d964cb5caacb2ba4bc1c0c687786afc6a294
|
|
4
|
+
data.tar.gz: 72c455473bdf7aa978dbee5c3dcb9b5f413f84d5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 497d34ec8936c14fb1dd2b293abade4966b336b64253bbe043b37a2d7c14dc083e0a6e94a3b20b86a9eeb3ad8b4c3021a7797027290a123a856b04185a1d5153
|
|
7
|
+
data.tar.gz: bcb46d03de2e0ea4ab78b0769348e38d4ef7808c1580623fba98e54dfeba5414ad5a9c84d3fbf141137d1193556556c2d32e5c9404c03b9da2d9728435eb74c7
|
data/lib/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
3.0.
|
|
1
|
+
3.0.1092
|
data/lib/v20230308/client.rb
CHANGED
|
@@ -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`
|
|
@@ -389,7 +389,7 @@ module TencentCloud
|
|
|
389
389
|
raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
|
|
390
390
|
end
|
|
391
391
|
|
|
392
|
-
#
|
|
392
|
+
# 删除角色。请确保该角色相关信息不在当前代码中被使用。删除角色后，原先使用该角色进行生产或消费消息的密钥（AccessKey 和 SecretKey）将立即失效。
|
|
393
393
|
|
|
394
394
|
# @param request: Request instance for DeleteRole.
|
|
395
395
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DeleteRoleRequest`
|
|
@@ -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`
|
|
@@ -535,8 +535,13 @@ module TencentCloud
|
|
|
535
535
|
|
|
536
536
|
# 获取消费组列表，Filter参数使用说明如下：
|
|
537
537
|
|
|
538
|
-
#
|
|
539
|
-
#
|
|
538
|
+
# - ConsumerGroupName 消费组名称，支持模糊查询，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
539
|
+
# - ConsumeMessageOrderly，投递顺序性，枚举值如下：
|
|
540
|
+
# - true 顺序投递
|
|
541
|
+
# - false 并发投递
|
|
542
|
+
|
|
543
|
+
# Filters示例：
|
|
544
|
+
# [{ "Name": "ConsumeMessageOrderly", "Values": ["true"] }]
|
|
540
545
|
|
|
541
546
|
# @param request: Request instance for DescribeConsumerGroupList.
|
|
542
547
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeConsumerGroupListRequest`
|
|
@@ -585,10 +590,16 @@ module TencentCloud
|
|
|
585
590
|
end
|
|
586
591
|
|
|
587
592
|
# 查询集群列表，支持 4.x 和 5.x 集群，其中 Filters 参数使用说明如下：
|
|
588
|
-
|
|
589
|
-
#
|
|
590
|
-
#
|
|
591
|
-
#
|
|
593
|
+
|
|
594
|
+
# - InstanceName 集群名称，支持模糊查询，从本接口返回值或控制台获得
|
|
595
|
+
# - InstanceId 集群ID，精确查询，从当前接口或控制台获得
|
|
596
|
+
# - InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
|
|
597
|
+
# - Version 集群版本，枚举值如下：
|
|
598
|
+
# - 4 RocketMQ 4.x 集群
|
|
599
|
+
# - 5 RocketMQ 5.x 集群
|
|
600
|
+
|
|
601
|
+
# Filters示例：
|
|
602
|
+
# [{ "Name": "InstanceId", "Values": ["rmq-72mo3a9o"] }]
|
|
592
603
|
|
|
593
604
|
# @param request: Request instance for DescribeFusionInstanceList.
|
|
594
605
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeFusionInstanceListRequest`
|
|
@@ -637,12 +648,17 @@ module TencentCloud
|
|
|
637
648
|
end
|
|
638
649
|
|
|
639
650
|
# 查询集群列表，仅支持 5.x 集群。Filters参数使用说明如下：
|
|
640
|
-
# 1. InstanceName, 名称模糊查询
|
|
641
|
-
# 2. InstanceId，集群ID查询
|
|
642
|
-
# 3. InstanceType, 集群类型查询，支持多选
|
|
643
|
-
# 3. InstanceStatus，集群状态查询，支持多选
|
|
644
651
|
|
|
645
|
-
#
|
|
652
|
+
# - InstanceName 集群名称，支持模糊搜索
|
|
653
|
+
# - InstanceId 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得
|
|
654
|
+
# - InstanceType 集群类型，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
|
|
655
|
+
# - InstanceStatus 集群状态，可参考 [InstanceItem](https://cloud.tencent.com/document/api/1493/96031#InstanceItem) 数据结构，支持多选
|
|
656
|
+
|
|
657
|
+
# Filters示例：
|
|
658
|
+
# [{
|
|
659
|
+
# "Name": "InstanceId",
|
|
660
|
+
# "Values": ["rmq-72mo3a9o"]
|
|
661
|
+
# }]
|
|
646
662
|
|
|
647
663
|
# @param request: Request instance for DescribeInstanceList.
|
|
648
664
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeInstanceListRequest`
|
|
@@ -1174,8 +1190,11 @@ module TencentCloud
|
|
|
1174
1190
|
|
|
1175
1191
|
# 查询角色列表，Filter参数使用说明如下：
|
|
1176
1192
|
|
|
1177
|
-
#
|
|
1178
|
-
#
|
|
1193
|
+
# - RoleName 角色名称，支持模糊搜索，从本接口返回值或控制台获得
|
|
1194
|
+
# - AccessKey AccessKey，支持模糊搜索，从本接口返回值或控制台获得
|
|
1195
|
+
|
|
1196
|
+
# Filters示例：
|
|
1197
|
+
# [{ "Name": "RoleName", "Values": ["test_role"] }]
|
|
1179
1198
|
|
|
1180
1199
|
# @param request: Request instance for DescribeRoleList.
|
|
1181
1200
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeRoleListRequest`
|
|
@@ -1273,7 +1292,10 @@ module TencentCloud
|
|
|
1273
1292
|
|
|
1274
1293
|
# 查询主题详情，Offset和Limit参数是指订阅该主题的消费组查询分页参数，Filter参数使用说明如下：
|
|
1275
1294
|
|
|
1276
|
-
# ConsumerGroup
|
|
1295
|
+
# - ConsumerGroup 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
1296
|
+
|
|
1297
|
+
# Filters示例：
|
|
1298
|
+
# [{ "Name": "ConsumerGroup", "Values": ["test_group"] }]
|
|
1277
1299
|
|
|
1278
1300
|
# @param request: Request instance for DescribeTopic.
|
|
1279
1301
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeTopicRequest`
|
|
@@ -1299,8 +1321,11 @@ module TencentCloud
|
|
|
1299
1321
|
|
|
1300
1322
|
# 获取主题列表，Filter参数使用说明如下：
|
|
1301
1323
|
|
|
1302
|
-
#
|
|
1303
|
-
#
|
|
1324
|
+
# - TopicName 主题名称，支持模糊搜索，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得
|
|
1325
|
+
# - TopicType 主题类型查询，支持多选，参考 [DescribeTopic](https://cloud.tencent.com/document/api/1493/97945) 接口 TopicType 字段
|
|
1326
|
+
|
|
1327
|
+
# Filters示例：
|
|
1328
|
+
# [{ "Name": "TopicName", "Values": ["test_topic"] }]
|
|
1304
1329
|
|
|
1305
1330
|
# @param request: Request instance for DescribeTopicList.
|
|
1306
1331
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeTopicListRequest`
|
|
@@ -1326,7 +1351,10 @@ module TencentCloud
|
|
|
1326
1351
|
|
|
1327
1352
|
# 根据消费组获取主题列表，Filter参数使用说明如下：
|
|
1328
1353
|
|
|
1329
|
-
# TopicName
|
|
1354
|
+
# - TopicName 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
1355
|
+
|
|
1356
|
+
# Filters示例：
|
|
1357
|
+
# [{ "Name": "TopicName", "Values": ["test_topic"] }]
|
|
1330
1358
|
|
|
1331
1359
|
# @param request: Request instance for DescribeTopicListByGroup.
|
|
1332
1360
|
# @type request: :class:`Tencentcloud::trocket::V20230308::DescribeTopicListByGroupRequest`
|
data/lib/v20230308/models.rb
CHANGED
|
@@ -201,18 +201,18 @@ module TencentCloud
|
|
|
201
201
|
|
|
202
202
|
# CreateConsumerGroup请求参数结构体
|
|
203
203
|
class CreateConsumerGroupRequest < TencentCloud::Common::AbstractModel
|
|
204
|
-
# @param InstanceId:
|
|
204
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
205
205
|
# @type InstanceId: String
|
|
206
|
-
# @param MaxRetryTimes:
|
|
206
|
+
# @param MaxRetryTimes: 最大重试次数，取值范围0～1000
|
|
207
207
|
# @type MaxRetryTimes: Integer
|
|
208
208
|
# @param ConsumeEnable: 是否开启消费
|
|
209
209
|
# @type ConsumeEnable: Boolean
|
|
210
210
|
# @param ConsumeMessageOrderly: 顺序投递：true
|
|
211
211
|
# 并发投递：false
|
|
212
212
|
# @type ConsumeMessageOrderly: Boolean
|
|
213
|
-
# @param ConsumerGroup:
|
|
213
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
214
214
|
# @type ConsumerGroup: String
|
|
215
|
-
# @param Remark:
|
|
215
|
+
# @param Remark: 备注信息，最多 128 个字符
|
|
216
216
|
# @type Remark: String
|
|
217
217
|
# @param TagList: 标签列表
|
|
218
218
|
# @type TagList: Array
|
|
@@ -285,7 +285,7 @@ module TencentCloud
|
|
|
285
285
|
# @type InstanceType: String
|
|
286
286
|
# @param Name: 集群名称，不能为空， 3-64个字符，只能包含数字、字母、“-”和“_”
|
|
287
287
|
# @type Name: String
|
|
288
|
-
# @param SkuCode: 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/
|
|
288
|
+
# @param SkuCode: 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参获得。
|
|
289
289
|
# @type SkuCode: String
|
|
290
290
|
# @param Remark: 备注信息
|
|
291
291
|
# @type Remark: String
|
|
@@ -301,7 +301,7 @@ module TencentCloud
|
|
|
301
301
|
# @type Bandwidth: Integer
|
|
302
302
|
# @param IpRules: 公网访问白名单，不填表示拒绝所有 IP 访问
|
|
303
303
|
# @type IpRules: Array
|
|
304
|
-
# @param MessageRetention: 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/
|
|
304
|
+
# @param MessageRetention: 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参：
|
|
305
305
|
|
|
306
306
|
# - 默认值：DefaultRetention 参数
|
|
307
307
|
# - 最小值：RetentionLowerLimit 参数
|
|
@@ -313,12 +313,12 @@ module TencentCloud
|
|
|
313
313
|
# @type RenewFlag: Integer
|
|
314
314
|
# @param TimeSpan: 预付费集群的购买时长（单位：月），取值范围为1～60，默认值为1
|
|
315
315
|
# @type TimeSpan: Integer
|
|
316
|
-
# @param MaxTopicNum: 最大可创建主题数，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/
|
|
316
|
+
# @param MaxTopicNum: 最大可创建主题数，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参：
|
|
317
317
|
|
|
318
318
|
# - 默认值和最小值：TopicNumLimit 参数
|
|
319
319
|
# - 最大值：TopicNumUpperLimit 参数
|
|
320
320
|
# @type MaxTopicNum: Integer
|
|
321
|
-
# @param ZoneIds: 部署可用区列表，从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929)
|
|
321
|
+
# @param ZoneIds: 部署可用区列表，从 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口返回中的 [ZoneInfo](https://cloud.tencent.com/document/api/1596/77932#ZoneInfo) 数据结构中获得。
|
|
322
322
|
# @type ZoneIds: Array
|
|
323
323
|
|
|
324
324
|
attr_accessor :InstanceType, :Name, :SkuCode, :Remark, :TagList, :VpcList, :EnablePublic, :BillingFlow, :Bandwidth, :IpRules, :MessageRetention, :PayMode, :RenewFlag, :TimeSpan, :MaxTopicNum, :ZoneIds
|
|
@@ -654,9 +654,9 @@ module TencentCloud
|
|
|
654
654
|
|
|
655
655
|
# CreateRole请求参数结构体
|
|
656
656
|
class CreateRoleRequest < TencentCloud::Common::AbstractModel
|
|
657
|
-
# @param InstanceId:
|
|
657
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
658
658
|
# @type InstanceId: String
|
|
659
|
-
# @param Role:
|
|
659
|
+
# @param Role: 角色名称，不能为空，只支持数字 大小写字母 分隔符("_","-")，不能超过 32 个字符
|
|
660
660
|
# @type Role: String
|
|
661
661
|
# @param PermWrite: 是否开启生产权限
|
|
662
662
|
# @type PermWrite: Boolean
|
|
@@ -666,7 +666,7 @@ module TencentCloud
|
|
|
666
666
|
# @type Remark: String
|
|
667
667
|
# @param PermType: 权限类型，默认按集群授权（Cluster：集群级别；TopicAndGroup：主题&消费组级别）
|
|
668
668
|
# @type PermType: String
|
|
669
|
-
# @param DetailedPerms: Topic&Group
|
|
669
|
+
# @param DetailedPerms: Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
|
|
670
670
|
# @type DetailedPerms: Array
|
|
671
671
|
|
|
672
672
|
attr_accessor :InstanceId, :Role, :PermWrite, :PermRead, :Remark, :PermType, :DetailedPerms
|
|
@@ -721,22 +721,22 @@ module TencentCloud
|
|
|
721
721
|
|
|
722
722
|
# CreateTopic请求参数结构体
|
|
723
723
|
class CreateTopicRequest < TencentCloud::Common::AbstractModel
|
|
724
|
-
# @param InstanceId:
|
|
724
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
725
725
|
# @type InstanceId: String
|
|
726
|
-
# @param Topic:
|
|
726
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
727
727
|
# @type Topic: String
|
|
728
|
-
# @param TopicType:
|
|
729
|
-
|
|
730
|
-
# NORMAL
|
|
731
|
-
# FIFO
|
|
732
|
-
# DELAY
|
|
733
|
-
# TRANSACTION
|
|
728
|
+
# @param TopicType: 主题类型，枚举值如下：
|
|
729
|
+
|
|
730
|
+
# - NORMAL: 普通消息
|
|
731
|
+
# - FIFO: 顺序消息
|
|
732
|
+
# - DELAY: 延时消息
|
|
733
|
+
# - TRANSACTION: 事务消息
|
|
734
734
|
# @type TopicType: String
|
|
735
|
-
# @param QueueNum:
|
|
735
|
+
# @param QueueNum: 队列数量，取值范围3～16
|
|
736
736
|
# @type QueueNum: Integer
|
|
737
|
-
# @param Remark:
|
|
737
|
+
# @param Remark: 备注信息，最多 128 个字符
|
|
738
738
|
# @type Remark: String
|
|
739
|
-
# @param MsgTTL:
|
|
739
|
+
# @param MsgTTL: 消息保留时长（单位：小时）
|
|
740
740
|
# @type MsgTTL: Integer
|
|
741
741
|
# @param TagList: 标签列表
|
|
742
742
|
# @type TagList: Array
|
|
@@ -819,9 +819,9 @@ module TencentCloud
|
|
|
819
819
|
|
|
820
820
|
# DeleteConsumerGroup请求参数结构体
|
|
821
821
|
class DeleteConsumerGroupRequest < TencentCloud::Common::AbstractModel
|
|
822
|
-
# @param InstanceId:
|
|
822
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
823
823
|
# @type InstanceId: String
|
|
824
|
-
# @param ConsumerGroup:
|
|
824
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
825
825
|
# @type ConsumerGroup: String
|
|
826
826
|
|
|
827
827
|
attr_accessor :InstanceId, :ConsumerGroup
|
|
@@ -855,7 +855,7 @@ module TencentCloud
|
|
|
855
855
|
|
|
856
856
|
# DeleteInstance请求参数结构体
|
|
857
857
|
class DeleteInstanceRequest < TencentCloud::Common::AbstractModel
|
|
858
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
858
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
859
859
|
# @type InstanceId: String
|
|
860
860
|
|
|
861
861
|
attr_accessor :InstanceId
|
|
@@ -1023,9 +1023,9 @@ module TencentCloud
|
|
|
1023
1023
|
|
|
1024
1024
|
# DeleteRole请求参数结构体
|
|
1025
1025
|
class DeleteRoleRequest < TencentCloud::Common::AbstractModel
|
|
1026
|
-
# @param InstanceId:
|
|
1026
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1027
1027
|
# @type InstanceId: String
|
|
1028
|
-
# @param Role:
|
|
1028
|
+
# @param Role: 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口响应中的 [RoleItem](https://cloud.tencent.com/document/api/1493/96031#RoleItem) 或控制台获得。
|
|
1029
1029
|
# @type Role: String
|
|
1030
1030
|
|
|
1031
1031
|
attr_accessor :InstanceId, :Role
|
|
@@ -1091,9 +1091,9 @@ module TencentCloud
|
|
|
1091
1091
|
|
|
1092
1092
|
# DeleteTopic请求参数结构体
|
|
1093
1093
|
class DeleteTopicRequest < TencentCloud::Common::AbstractModel
|
|
1094
|
-
# @param InstanceId:
|
|
1094
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1095
1095
|
# @type InstanceId: String
|
|
1096
|
-
# @param Topic:
|
|
1096
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
1097
1097
|
# @type Topic: String
|
|
1098
1098
|
|
|
1099
1099
|
attr_accessor :InstanceId, :Topic
|
|
@@ -1127,15 +1127,15 @@ module TencentCloud
|
|
|
1127
1127
|
|
|
1128
1128
|
# DescribeConsumerClientList请求参数结构体
|
|
1129
1129
|
class DescribeConsumerClientListRequest < TencentCloud::Common::AbstractModel
|
|
1130
|
-
# @param InstanceId:
|
|
1130
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1131
1131
|
# @type InstanceId: String
|
|
1132
|
-
# @param ConsumerGroup:
|
|
1132
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
1133
1133
|
# @type ConsumerGroup: String
|
|
1134
|
-
# @param Filters:
|
|
1134
|
+
# @param Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
|
|
1135
1135
|
# @type Filters: Array
|
|
1136
|
-
# @param Offset:
|
|
1136
|
+
# @param Offset: 查询起始位置，默认为0。
|
|
1137
1137
|
# @type Offset: Integer
|
|
1138
|
-
# @param Limit:
|
|
1138
|
+
# @param Limit: 查询结果限制数量，默认20。
|
|
1139
1139
|
# @type Limit: Integer
|
|
1140
1140
|
|
|
1141
1141
|
attr_accessor :InstanceId, :ConsumerGroup, :Filters, :Offset, :Limit
|
|
@@ -1197,17 +1197,17 @@ module TencentCloud
|
|
|
1197
1197
|
|
|
1198
1198
|
# DescribeConsumerClient请求参数结构体
|
|
1199
1199
|
class DescribeConsumerClientRequest < TencentCloud::Common::AbstractModel
|
|
1200
|
-
# @param InstanceId:
|
|
1200
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1201
1201
|
# @type InstanceId: String
|
|
1202
|
-
# @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) 出参中获得。
|
|
1203
1203
|
# @type ClientId: String
|
|
1204
|
-
# @param Filters:
|
|
1204
|
+
# @param Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
|
|
1205
1205
|
# @type Filters: Array
|
|
1206
|
-
# @param Offset:
|
|
1206
|
+
# @param Offset: 查询起始位置，默认为0。
|
|
1207
1207
|
# @type Offset: Integer
|
|
1208
|
-
# @param Limit:
|
|
1208
|
+
# @param Limit: 查询结果限制数量，默认20。
|
|
1209
1209
|
# @type Limit: Integer
|
|
1210
|
-
# @param ConsumerGroup:
|
|
1210
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
1211
1211
|
# @type ConsumerGroup: String
|
|
1212
1212
|
|
|
1213
1213
|
attr_accessor :InstanceId, :ClientId, :Filters, :Offset, :Limit, :ConsumerGroup
|
|
@@ -1276,7 +1276,7 @@ module TencentCloud
|
|
|
1276
1276
|
|
|
1277
1277
|
# DescribeConsumerGroupList请求参数结构体
|
|
1278
1278
|
class DescribeConsumerGroupListRequest < TencentCloud::Common::AbstractModel
|
|
1279
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
1279
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1280
1280
|
# @type InstanceId: String
|
|
1281
1281
|
# @param Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
|
|
1282
1282
|
# @type Filters: Array
|
|
@@ -1346,9 +1346,9 @@ module TencentCloud
|
|
|
1346
1346
|
|
|
1347
1347
|
# DescribeConsumerGroup请求参数结构体
|
|
1348
1348
|
class DescribeConsumerGroupRequest < TencentCloud::Common::AbstractModel
|
|
1349
|
-
# @param InstanceId:
|
|
1349
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1350
1350
|
# @type InstanceId: String
|
|
1351
|
-
# @param ConsumerGroup:
|
|
1351
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
1352
1352
|
# @type ConsumerGroup: String
|
|
1353
1353
|
|
|
1354
1354
|
attr_accessor :InstanceId, :ConsumerGroup
|
|
@@ -1372,9 +1372,13 @@ module TencentCloud
|
|
|
1372
1372
|
# @type Tps: Integer
|
|
1373
1373
|
# @param ConsumerLag: 消息堆积数量
|
|
1374
1374
|
# @type ConsumerLag: Integer
|
|
1375
|
-
# @param ConsumeType:
|
|
1375
|
+
# @param ConsumeType: 消费类型，枚举值如下：
|
|
1376
|
+
|
|
1377
|
+
# - PULL：PULL 消费类型
|
|
1378
|
+
# - PUSH：PUSH 消费类型
|
|
1379
|
+
# - POP：POP 消费类型
|
|
1376
1380
|
# @type ConsumeType: String
|
|
1377
|
-
# @param CreatedTime:
|
|
1381
|
+
# @param CreatedTime: 创建时间，**Unix时间戳（毫秒）**
|
|
1378
1382
|
# @type CreatedTime: Integer
|
|
1379
1383
|
# @param ConsumeMessageOrderly: 顺序投递：true
|
|
1380
1384
|
# 并发投递：false
|
|
@@ -1425,13 +1429,13 @@ module TencentCloud
|
|
|
1425
1429
|
|
|
1426
1430
|
# DescribeConsumerLag请求参数结构体
|
|
1427
1431
|
class DescribeConsumerLagRequest < TencentCloud::Common::AbstractModel
|
|
1428
|
-
# @param InstanceId:
|
|
1432
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1429
1433
|
# @type InstanceId: String
|
|
1430
|
-
# @param ConsumerGroup:
|
|
1434
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
1431
1435
|
# @type ConsumerGroup: String
|
|
1432
|
-
# @param Namespace: 命名空间，4.x
|
|
1436
|
+
# @param Namespace: 命名空间，4.x集群必填，从 [DescribeRocketMQNamespaces](https://cloud.tencent.com/document/api/1179/63419) 接口返回的 [RocketMQNamespace](https://cloud.tencent.com/document/api/1179/46089#RocketMQNamespace) 或控制台获得。
|
|
1433
1437
|
# @type Namespace: String
|
|
1434
|
-
# @param SubscribeTopic:
|
|
1438
|
+
# @param SubscribeTopic: 订阅主题，不为空则查询订阅了该主题的消费组的堆积，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
1435
1439
|
# @type SubscribeTopic: String
|
|
1436
1440
|
|
|
1437
1441
|
attr_accessor :InstanceId, :ConsumerGroup, :Namespace, :SubscribeTopic
|
|
@@ -1619,7 +1623,7 @@ module TencentCloud
|
|
|
1619
1623
|
|
|
1620
1624
|
# DescribeInstance请求参数结构体
|
|
1621
1625
|
class DescribeInstanceRequest < TencentCloud::Common::AbstractModel
|
|
1622
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
1626
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
1623
1627
|
# @type InstanceId: String
|
|
1624
1628
|
|
|
1625
1629
|
attr_accessor :InstanceId
|
|
@@ -1720,7 +1724,7 @@ module TencentCloud
|
|
|
1720
1724
|
# @param TopicNumUpperLimit: 最大可设置的topic个数
|
|
1721
1725
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
1722
1726
|
# @type TopicNumUpperLimit: Integer
|
|
1723
|
-
# @param ZoneIds: 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929)
|
|
1727
|
+
# @param ZoneIds: 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口返回中的 [ZoneInfo](https://cloud.tencent.com/document/api/1596/77932#ZoneInfo) 数据结构。
|
|
1724
1728
|
# @type ZoneIds: Array
|
|
1725
1729
|
# @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
|
|
1726
1730
|
# @type RequestId: String
|
|
@@ -2602,9 +2606,9 @@ module TencentCloud
|
|
|
2602
2606
|
|
|
2603
2607
|
# DescribeMessageList请求参数结构体
|
|
2604
2608
|
class DescribeMessageListRequest < TencentCloud::Common::AbstractModel
|
|
2605
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
2609
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
2606
2610
|
# @type InstanceId: String
|
|
2607
|
-
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)
|
|
2611
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
2608
2612
|
# @type Topic: String
|
|
2609
2613
|
# @param StartTime: 要查询消息的开始时间，**Unix时间戳（毫秒）**
|
|
2610
2614
|
# @type StartTime: Integer
|
|
@@ -2616,17 +2620,17 @@ module TencentCloud
|
|
|
2616
2620
|
# @type Offset: Integer
|
|
2617
2621
|
# @param Limit: 查询结果限制数量，默认20。
|
|
2618
2622
|
# @type Limit: Integer
|
|
2619
|
-
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535)
|
|
2623
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
2620
2624
|
# @type ConsumerGroup: String
|
|
2621
|
-
# @param MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)
|
|
2625
|
+
# @param MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
|
|
2622
2626
|
# @type MsgId: String
|
|
2623
|
-
# @param MsgKey: 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)
|
|
2627
|
+
# @param MsgKey: 消息 Key，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
|
|
2624
2628
|
# @type MsgKey: String
|
|
2625
2629
|
# @param RecentMessageNum: 查询最近N条消息 最大不超过1024，默认-1为其他查询条件
|
|
2626
2630
|
# @type RecentMessageNum: Integer
|
|
2627
2631
|
# @param QueryDeadLetterMessage: 是否查询死信消息，默认为false
|
|
2628
2632
|
# @type QueryDeadLetterMessage: Boolean
|
|
2629
|
-
# @param Tag: 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)
|
|
2633
|
+
# @param Tag: 消息 Tag，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
|
|
2630
2634
|
# @type Tag: String
|
|
2631
2635
|
|
|
2632
2636
|
attr_accessor :InstanceId, :Topic, :StartTime, :EndTime, :TaskRequestId, :Offset, :Limit, :ConsumerGroup, :MsgId, :MsgKey, :RecentMessageNum, :QueryDeadLetterMessage, :Tag
|
|
@@ -2703,9 +2707,9 @@ module TencentCloud
|
|
|
2703
2707
|
|
|
2704
2708
|
# DescribeMessage请求参数结构体
|
|
2705
2709
|
class DescribeMessageRequest < TencentCloud::Common::AbstractModel
|
|
2706
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
2710
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
2707
2711
|
# @type InstanceId: String
|
|
2708
|
-
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)
|
|
2712
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
2709
2713
|
# @type Topic: String
|
|
2710
2714
|
# @param MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口或业务日志中获得。
|
|
2711
2715
|
# @type MsgId: String
|
|
@@ -2801,11 +2805,11 @@ module TencentCloud
|
|
|
2801
2805
|
|
|
2802
2806
|
# DescribeMessageTrace请求参数结构体
|
|
2803
2807
|
class DescribeMessageTraceRequest < TencentCloud::Common::AbstractModel
|
|
2804
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
2808
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
2805
2809
|
# @type InstanceId: String
|
|
2806
|
-
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)
|
|
2810
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
2807
2811
|
# @type Topic: String
|
|
2808
|
-
# @param MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593)
|
|
2812
|
+
# @param MsgId: 消息 ID，从 [DescribeMessageList](https://cloud.tencent.com/document/api/1493/114593) 接口返回的 [MessageItem](https://cloud.tencent.com/document/api/1493/96031#MessageItem) 或业务日志中获得。
|
|
2809
2813
|
# @type MsgId: String
|
|
2810
2814
|
# @param QueryDeadLetterMessage: 是否是死信消息，默认为false
|
|
2811
2815
|
# @type QueryDeadLetterMessage: Boolean
|
|
@@ -3159,7 +3163,7 @@ module TencentCloud
|
|
|
3159
3163
|
|
|
3160
3164
|
# DescribeRoleList请求参数结构体
|
|
3161
3165
|
class DescribeRoleListRequest < TencentCloud::Common::AbstractModel
|
|
3162
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
3166
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
3163
3167
|
# @type InstanceId: String
|
|
3164
3168
|
# @param Offset: 查询起始位置，默认为0。
|
|
3165
3169
|
# @type Offset: Integer
|
|
@@ -3354,15 +3358,15 @@ module TencentCloud
|
|
|
3354
3358
|
|
|
3355
3359
|
# DescribeTopicListByGroup请求参数结构体
|
|
3356
3360
|
class DescribeTopicListByGroupRequest < TencentCloud::Common::AbstractModel
|
|
3357
|
-
# @param InstanceId:
|
|
3361
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
3358
3362
|
# @type InstanceId: String
|
|
3359
|
-
# @param Offset:
|
|
3363
|
+
# @param Offset: 查询起始位置，默认为0。
|
|
3360
3364
|
# @type Offset: Integer
|
|
3361
|
-
# @param Limit:
|
|
3365
|
+
# @param Limit: 查询结果限制数量，默认20。
|
|
3362
3366
|
# @type Limit: Integer
|
|
3363
|
-
# @param ConsumerGroup:
|
|
3367
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
3364
3368
|
# @type ConsumerGroup: String
|
|
3365
|
-
# @param Filters:
|
|
3369
|
+
# @param Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
|
|
3366
3370
|
# @type Filters: Array
|
|
3367
3371
|
|
|
3368
3372
|
attr_accessor :InstanceId, :Offset, :Limit, :ConsumerGroup, :Filters
|
|
@@ -3424,7 +3428,7 @@ module TencentCloud
|
|
|
3424
3428
|
|
|
3425
3429
|
# DescribeTopicList请求参数结构体
|
|
3426
3430
|
class DescribeTopicListRequest < TencentCloud::Common::AbstractModel
|
|
3427
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
3431
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
3428
3432
|
# @type InstanceId: String
|
|
3429
3433
|
# @param Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
|
|
3430
3434
|
# @type Filters: Array
|
|
@@ -3490,15 +3494,15 @@ module TencentCloud
|
|
|
3490
3494
|
|
|
3491
3495
|
# DescribeTopic请求参数结构体
|
|
3492
3496
|
class DescribeTopicRequest < TencentCloud::Common::AbstractModel
|
|
3493
|
-
# @param InstanceId:
|
|
3497
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
3494
3498
|
# @type InstanceId: String
|
|
3495
|
-
# @param Topic:
|
|
3499
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
3496
3500
|
# @type Topic: String
|
|
3497
|
-
# @param Filters:
|
|
3501
|
+
# @param Filters: 过滤查询条件列表，请在引用此参数的API说明中了解使用方法。
|
|
3498
3502
|
# @type Filters: Array
|
|
3499
|
-
# @param Offset:
|
|
3503
|
+
# @param Offset: 查询起始位置，默认为0。
|
|
3500
3504
|
# @type Offset: Integer
|
|
3501
|
-
# @param Limit:
|
|
3505
|
+
# @param Limit: 查询结果限制数量，默认20。
|
|
3502
3506
|
# @type Limit: Integer
|
|
3503
3507
|
|
|
3504
3508
|
attr_accessor :InstanceId, :Topic, :Filters, :Offset, :Limit
|
|
@@ -3542,15 +3546,15 @@ module TencentCloud
|
|
|
3542
3546
|
# @type TopicType: String
|
|
3543
3547
|
# @param Remark: 备注
|
|
3544
3548
|
# @type Remark: String
|
|
3545
|
-
# @param CreatedTime:
|
|
3549
|
+
# @param CreatedTime: 创建时间，**Unix时间戳（毫秒）**
|
|
3546
3550
|
# @type CreatedTime: Integer
|
|
3547
|
-
# @param LastUpdateTime:
|
|
3551
|
+
# @param LastUpdateTime: 最后写入时间，**Unix时间戳（毫秒）**
|
|
3548
3552
|
# @type LastUpdateTime: Integer
|
|
3549
3553
|
# @param SubscriptionCount: 订阅数量
|
|
3550
3554
|
# @type SubscriptionCount: Integer
|
|
3551
3555
|
# @param SubscriptionData: 订阅关系列表
|
|
3552
3556
|
# @type SubscriptionData: Array
|
|
3553
|
-
# @param MsgTTL:
|
|
3557
|
+
# @param MsgTTL: 消息保留时长，单位：小时
|
|
3554
3558
|
# @type MsgTTL: Integer
|
|
3555
3559
|
# @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
|
|
3556
3560
|
# @type RequestId: String
|
|
@@ -3594,6 +3598,8 @@ module TencentCloud
|
|
|
3594
3598
|
# Topic&Group维度的权限配置
|
|
3595
3599
|
class DetailedRolePerm < TencentCloud::Common::AbstractModel
|
|
3596
3600
|
# @param Resource: 权限对应的资源
|
|
3601
|
+
# 可以是主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
3602
|
+
# 可以是消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
3597
3603
|
# @type Resource: String
|
|
3598
3604
|
# @param PermWrite: 是否开启生产权限
|
|
3599
3605
|
# @type PermWrite: Boolean
|
|
@@ -3857,7 +3863,7 @@ module TencentCloud
|
|
|
3857
3863
|
# @param DestroyTime: 预销毁时间，**Unix时间戳（毫秒）**
|
|
3858
3864
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
3859
3865
|
# @type DestroyTime: Integer
|
|
3860
|
-
# @param ZoneIds: 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929)
|
|
3866
|
+
# @param ZoneIds: 所属可用区列表，参考 [DescribeZones](https://cloud.tencent.com/document/product/1596/77929) 接口返回中的 [ZoneInfo](https://cloud.tencent.com/document/api/1596/77932#ZoneInfo) 数据结构。
|
|
3861
3867
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
3862
3868
|
# @type ZoneIds: Array
|
|
3863
3869
|
# @param EnableDeletionProtection: 是否开启删除保护
|
|
@@ -4750,18 +4756,18 @@ module TencentCloud
|
|
|
4750
4756
|
|
|
4751
4757
|
# ModifyConsumerGroup请求参数结构体
|
|
4752
4758
|
class ModifyConsumerGroupRequest < TencentCloud::Common::AbstractModel
|
|
4753
|
-
# @param InstanceId:
|
|
4759
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
4754
4760
|
# @type InstanceId: String
|
|
4755
|
-
# @param ConsumerGroup:
|
|
4761
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
4756
4762
|
# @type ConsumerGroup: String
|
|
4757
4763
|
# @param ConsumeEnable: 是否开启消费
|
|
4758
4764
|
# @type ConsumeEnable: Boolean
|
|
4759
4765
|
# @param ConsumeMessageOrderly: 顺序投递：true
|
|
4760
4766
|
# 并发投递：false
|
|
4761
4767
|
# @type ConsumeMessageOrderly: Boolean
|
|
4762
|
-
# @param MaxRetryTimes:
|
|
4768
|
+
# @param MaxRetryTimes: 最大重试次数，取值范围0～1000
|
|
4763
4769
|
# @type MaxRetryTimes: Integer
|
|
4764
|
-
# @param Remark:
|
|
4770
|
+
# @param Remark: 备注信息，最多 128 个字符
|
|
4765
4771
|
# @type Remark: String
|
|
4766
4772
|
|
|
4767
4773
|
attr_accessor :InstanceId, :ConsumerGroup, :ConsumeEnable, :ConsumeMessageOrderly, :MaxRetryTimes, :Remark
|
|
@@ -4803,7 +4809,7 @@ module TencentCloud
|
|
|
4803
4809
|
|
|
4804
4810
|
# ModifyInstanceEndpoint请求参数结构体
|
|
4805
4811
|
class ModifyInstanceEndpointRequest < TencentCloud::Common::AbstractModel
|
|
4806
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
4812
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
4807
4813
|
# @type InstanceId: String
|
|
4808
4814
|
# @param Type: 接入点类型，
|
|
4809
4815
|
# PUBLIC 公网
|
|
@@ -4859,7 +4865,7 @@ module TencentCloud
|
|
|
4859
4865
|
|
|
4860
4866
|
# ModifyInstance请求参数结构体
|
|
4861
4867
|
class ModifyInstanceRequest < TencentCloud::Common::AbstractModel
|
|
4862
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
4868
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
4863
4869
|
# @type InstanceId: String
|
|
4864
4870
|
# @param Name: 实例名称，不能为空, 3-64个字符，只能包含数字、字母、“-”和“_”
|
|
4865
4871
|
# @type Name: String
|
|
@@ -4869,7 +4875,7 @@ module TencentCloud
|
|
|
4869
4875
|
# @type SendReceiveRatio: Float
|
|
4870
4876
|
# @param SkuCode: 商品规格，从 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/107676) 出参获得。
|
|
4871
4877
|
# @type SkuCode: String
|
|
4872
|
-
# @param MessageRetention: 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/
|
|
4878
|
+
# @param MessageRetention: 消息保留时长（单位：小时），取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参：
|
|
4873
4879
|
|
|
4874
4880
|
# - 默认值：DefaultRetention 参数
|
|
4875
4881
|
# - 最小值：RetentionLowerLimit 参数
|
|
@@ -4879,12 +4885,12 @@ module TencentCloud
|
|
|
4879
4885
|
# @type ScaledTpsEnabled: Boolean
|
|
4880
4886
|
# @param AclEnabled: 是否开启ACL
|
|
4881
4887
|
# @type AclEnabled: Boolean
|
|
4882
|
-
# @param MaxTopicNum: 最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/
|
|
4888
|
+
# @param MaxTopicNum: 最大可创建主题数，取值范围参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参：
|
|
4883
4889
|
|
|
4884
4890
|
# - 最小值和默认值：TopicNumLimit 参数
|
|
4885
4891
|
# - 最大值：TopicNumUpperLimit 参数
|
|
4886
4892
|
# @type MaxTopicNum: Integer
|
|
4887
|
-
# @param ExtraTopicNum: 免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/
|
|
4893
|
+
# @param ExtraTopicNum: 免费额度之外的主题个数，免费额度参考 [DescribeProductSKUs](https://cloud.tencent.com/document/api/1493/107676) 接口中的 [ProductSKU](https://cloud.tencent.com/document/api/1493/96031#ProductSKU) 出参中的 TopicNumLimit 参数。
|
|
4888
4894
|
# @type ExtraTopicNum: String
|
|
4889
4895
|
# @param EnableDeletionProtection: 是否开启删除保护
|
|
4890
4896
|
# @type EnableDeletionProtection: Boolean
|
|
@@ -5153,9 +5159,9 @@ module TencentCloud
|
|
|
5153
5159
|
|
|
5154
5160
|
# ModifyRole请求参数结构体
|
|
5155
5161
|
class ModifyRoleRequest < TencentCloud::Common::AbstractModel
|
|
5156
|
-
# @param InstanceId:
|
|
5162
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
5157
5163
|
# @type InstanceId: String
|
|
5158
|
-
# @param Role:
|
|
5164
|
+
# @param Role: 角色名称，从 [DescribeRoleList](https://cloud.tencent.com/document/api/1493/98862) 接口中返回的 [RoleItem](https://cloud.tencent.com/document/api/1493/96031#RoleItem) 或控制台获得。
|
|
5159
5165
|
# @type Role: String
|
|
5160
5166
|
# @param PermRead: 是否开启消费
|
|
5161
5167
|
# @type PermRead: Boolean
|
|
@@ -5165,7 +5171,7 @@ module TencentCloud
|
|
|
5165
5171
|
# @type PermType: String
|
|
5166
5172
|
# @param Remark: 备注
|
|
5167
5173
|
# @type Remark: String
|
|
5168
|
-
# @param DetailedPerms: Topic&Group
|
|
5174
|
+
# @param DetailedPerms: Topic&Group维度权限配置，权限类型为 TopicAndGroup 时必填
|
|
5169
5175
|
# @type DetailedPerms: Array
|
|
5170
5176
|
|
|
5171
5177
|
attr_accessor :InstanceId, :Role, :PermRead, :PermWrite, :PermType, :Remark, :DetailedPerms
|
|
@@ -5216,15 +5222,15 @@ module TencentCloud
|
|
|
5216
5222
|
|
|
5217
5223
|
# ModifyTopic请求参数结构体
|
|
5218
5224
|
class ModifyTopicRequest < TencentCloud::Common::AbstractModel
|
|
5219
|
-
# @param InstanceId:
|
|
5225
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
5220
5226
|
# @type InstanceId: String
|
|
5221
|
-
# @param Topic:
|
|
5227
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
5222
5228
|
# @type Topic: String
|
|
5223
|
-
# @param QueueNum:
|
|
5229
|
+
# @param QueueNum: 队列数量，取值范围3～16
|
|
5224
5230
|
# @type QueueNum: Integer
|
|
5225
|
-
# @param Remark:
|
|
5231
|
+
# @param Remark: 备注信息，最多 128 个字符
|
|
5226
5232
|
# @type Remark: String
|
|
5227
|
-
# @param MsgTTL:
|
|
5233
|
+
# @param MsgTTL: 消息保留时长（单位：小时）
|
|
5228
5234
|
# @type MsgTTL: Integer
|
|
5229
5235
|
|
|
5230
5236
|
attr_accessor :InstanceId, :Topic, :QueueNum, :Remark, :MsgTTL
|
|
@@ -5454,11 +5460,11 @@ module TencentCloud
|
|
|
5454
5460
|
|
|
5455
5461
|
# ResendDeadLetterMessage请求参数结构体
|
|
5456
5462
|
class ResendDeadLetterMessageRequest < TencentCloud::Common::AbstractModel
|
|
5457
|
-
# @param InstanceId:
|
|
5463
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
5458
5464
|
# @type InstanceId: String
|
|
5459
5465
|
# @param MessageIds: 死信消息ID列表
|
|
5460
5466
|
# @type MessageIds: Array
|
|
5461
|
-
# @param ConsumerGroup:
|
|
5467
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
5462
5468
|
# @type ConsumerGroup: String
|
|
5463
5469
|
|
|
5464
5470
|
attr_accessor :InstanceId, :MessageIds, :ConsumerGroup
|
|
@@ -5499,13 +5505,13 @@ module TencentCloud
|
|
|
5499
5505
|
|
|
5500
5506
|
# ResetConsumerGroupOffset请求参数结构体
|
|
5501
5507
|
class ResetConsumerGroupOffsetRequest < TencentCloud::Common::AbstractModel
|
|
5502
|
-
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [
|
|
5508
|
+
# @param InstanceId: 腾讯云 RocketMQ 实例 ID，从 [DescribeFusionInstanceList](https://cloud.tencent.com/document/api/1493/106745) 接口或控制台获得。
|
|
5503
5509
|
# @type InstanceId: String
|
|
5504
|
-
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030)
|
|
5510
|
+
# @param Topic: 主题名称，从 [DescribeTopicList](https://cloud.tencent.com/document/api/1493/96030) 接口返回的 [TopicItem](https://cloud.tencent.com/document/api/1493/96031#TopicItem) 或控制台获得。
|
|
5505
5511
|
# @type Topic: String
|
|
5506
5512
|
# @param ResetTimestamp: 重置位点的时间戳（单位：毫秒），指定为 -1 时表示重置到最新位点
|
|
5507
5513
|
# @type ResetTimestamp: Integer
|
|
5508
|
-
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535)
|
|
5514
|
+
# @param ConsumerGroup: 消费组名称，从 [DescribeConsumerGroupList](https://cloud.tencent.com/document/api/1493/101535) 接口返回的 [ConsumeGroupItem](https://cloud.tencent.com/document/api/1493/96031#ConsumeGroupItem) 或控制台获得。
|
|
5509
5515
|
# @type ConsumerGroup: String
|
|
5510
5516
|
|
|
5511
5517
|
attr_accessor :InstanceId, :Topic, :ResetTimestamp, :ConsumerGroup
|
|
@@ -5887,7 +5893,11 @@ module TencentCloud
|
|
|
5887
5893
|
# @param IsOnline: 是否在线
|
|
5888
5894
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5889
5895
|
# @type IsOnline: Boolean
|
|
5890
|
-
# @param ConsumeType:
|
|
5896
|
+
# @param ConsumeType: 消费类型，枚举值如下：
|
|
5897
|
+
|
|
5898
|
+
# - PULL：PULL 消费类型
|
|
5899
|
+
# - PUSH：PUSH 消费类型
|
|
5900
|
+
# - POP：POP 消费类型
|
|
5891
5901
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5892
5902
|
# @type ConsumeType: String
|
|
5893
5903
|
# @param SubString: 订阅规则
|
|
@@ -5896,13 +5906,16 @@ module TencentCloud
|
|
|
5896
5906
|
# @param ExpressionType: 过滤类型
|
|
5897
5907
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5898
5908
|
# @type ExpressionType: String
|
|
5899
|
-
# @param Consistency:
|
|
5909
|
+
# @param Consistency: 订阅一致性，枚举如下：
|
|
5910
|
+
|
|
5911
|
+
# - 0: 订阅一致
|
|
5912
|
+
# - 1: 订阅不一致
|
|
5900
5913
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5901
5914
|
# @type Consistency: Integer
|
|
5902
5915
|
# @param ConsumerLag: 消费堆积
|
|
5903
5916
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5904
5917
|
# @type ConsumerLag: Integer
|
|
5905
|
-
# @param LastUpdateTime:
|
|
5918
|
+
# @param LastUpdateTime: 最后消费进度更新时间，**Unix时间戳（毫秒）**
|
|
5906
5919
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
5907
5920
|
# @type LastUpdateTime: Integer
|
|
5908
5921
|
# @param MaxRetryTimes: 最大重试次数
|
|
@@ -6014,15 +6027,21 @@ module TencentCloud
|
|
|
6014
6027
|
class TopicConsumeStats < TencentCloud::Common::AbstractModel
|
|
6015
6028
|
# @param Topic: 主题名称
|
|
6016
6029
|
# @type Topic: String
|
|
6017
|
-
# @param TopicType:
|
|
6030
|
+
# @param TopicType: 主题类型，枚举值如下：
|
|
6031
|
+
|
|
6032
|
+
# - UNSPECIFIED：未指定
|
|
6033
|
+
# - NORMAL：普通消息
|
|
6034
|
+
# - FIFO：顺序消息
|
|
6035
|
+
# - DELAY：延时消息
|
|
6036
|
+
# - TRANSACTION：事务消息
|
|
6018
6037
|
# @type TopicType: String
|
|
6019
6038
|
# @param QueueNum: 单节点主题队列数量
|
|
6020
6039
|
# @type QueueNum: Integer
|
|
6021
6040
|
# @param ConsumerLag: 消费堆积
|
|
6022
6041
|
# @type ConsumerLag: Integer
|
|
6023
|
-
# @param SubString:
|
|
6042
|
+
# @param SubString: 订阅规则，`*`表示订阅全部TAG
|
|
6024
6043
|
# @type SubString: String
|
|
6025
|
-
# @param LastUpdateTime:
|
|
6044
|
+
# @param LastUpdateTime: 最后消费进度更新时间，**Unix时间戳（毫秒）**
|
|
6026
6045
|
# @type LastUpdateTime: Integer
|
|
6027
6046
|
|
|
6028
6047
|
attr_accessor :Topic, :TopicType, :QueueNum, :ConsumerLag, :SubString, :LastUpdateTime
|
|
@@ -6060,7 +6079,7 @@ module TencentCloud
|
|
|
6060
6079
|
# @type TopicType: String
|
|
6061
6080
|
# @param QueueNum: 队列数量
|
|
6062
6081
|
# @type QueueNum: Integer
|
|
6063
|
-
# @param Remark:
|
|
6082
|
+
# @param Remark: 备注信息
|
|
6064
6083
|
# @type Remark: String
|
|
6065
6084
|
# @param ClusterIdV4: 4.x的集群id
|
|
6066
6085
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
@@ -6075,7 +6094,6 @@ module TencentCloud
|
|
|
6075
6094
|
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
6076
6095
|
# @type FullNamespaceV4: String
|
|
6077
6096
|
# @param MsgTTL: 消息保留时长
|
|
6078
|
-
# 注意：此字段可能返回 null，表示取不到有效值。
|
|
6079
6097
|
# @type MsgTTL: Integer
|
|
6080
6098
|
|
|
6081
6099
|
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.
|
|
4
|
+
version: 3.0.1092
|
|
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-
|
|
11
|
+
date: 2025-07-03 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: tencentcloud-sdk-common
|