tencentcloud-sdk-ckafka 3.0.1135 → 3.0.1139

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: b7a3451299368de581dd0c11221aaf51a19527f4
4
- data.tar.gz: 15baefc78aef5aeecdb95e3542e325f1ec2319e9
3
+ metadata.gz: 6368a3c8a964173f51ff855f0efbc9f7f1014013
4
+ data.tar.gz: 617fe5b19207d7ee312a49643bf9156ec8716d47
5
5
  SHA512:
6
- metadata.gz: d9188737dff9de8e4ab45cb386586c3e298236ca81f812711be9cb81e2a4d7aa514483effc8313410a08219fa7332fe411bf9d787eb67d8acdeaeb19b1e14669
7
- data.tar.gz: 4578414422cdc43509b143d60ec902f9412c174d564ef2e6c78a867e3f4ba7c17202762b9262d3859929b5398473963ab082f3548b57cc4d5027b1df629afc1a
6
+ metadata.gz: 2fe0303b91eb4306b78a95c29d4f1c3fe84f290211d4c21427e076708884bb511bc42a5f0a2c6a1d44e7aa52d70d51ea859fa1ce52be2caf2d40e4c762ec139f
7
+ data.tar.gz: 66ba019aeb0799a8eef1f677273f54e0df67f59adeb8a7b6536c61f4f9230a7f4336c4223260ea9280b421e6afb3d0e162dcffba2d8a4e9abf70862c476c691b
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1135
1
+ 3.0.1139
@@ -1277,7 +1277,7 @@ module TencentCloud
1277
1277
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1278
1278
  end
1279
1279
 
1280
- # 本接口(DescribeInstance)用于在用户账户下获取消息队列 CKafka 实例列表
1280
+ # 本接口(DescribeInstances)用于在用户账户下获取消息队列 CKafka 实例列表
1281
1281
 
1282
1282
  # @param request: Request instance for DescribeInstances.
1283
1283
  # @type request: :class:`Tencentcloud::ckafka::V20190819::DescribeInstancesRequest`
@@ -276,7 +276,7 @@ module TencentCloud
276
276
 
277
277
  # AuthorizeToken请求参数结构体
278
278
  class AuthorizeTokenRequest < TencentCloud::Common::AbstractModel
279
- # @param InstanceId: ckafka集群实例Id, 可通过DescribeInstances接口获取
279
+ # @param InstanceId: ckafka集群实例Id, 可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
280
280
  # @type InstanceId: String
281
281
  # @param User: 用户
282
282
  # @type User: String
@@ -356,13 +356,13 @@ module TencentCloud
356
356
 
357
357
  # BatchCreateAcl请求参数结构体
358
358
  class BatchCreateAclRequest < TencentCloud::Common::AbstractModel
359
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
359
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
360
360
  # @type InstanceId: String
361
361
  # @param ResourceType: Acl资源类型,(2:TOPIC)
362
362
  # @type ResourceType: Integer
363
- # @param ResourceNames: 资源列表数组,可通过DescribeTopic接口获取。
363
+ # @param ResourceNames: 资源列表数组,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。
364
364
  # @type ResourceNames: Array
365
- # @param RuleList: 设置的ACL规则列表,可通过DescribeAclRule接口获取。
365
+ # @param RuleList: 设置的ACL规则列表,可通过[DescribeAclRule](https://cloud.tencent.com/document/product/597/89217)接口获取。
366
366
  # @type RuleList: Array
367
367
 
368
368
  attr_accessor :InstanceId, :ResourceType, :ResourceNames, :RuleList
@@ -469,9 +469,9 @@ module TencentCloud
469
469
 
470
470
  # BatchModifyTopicAttributes请求参数结构体
471
471
  class BatchModifyTopicAttributesRequest < TencentCloud::Common::AbstractModel
472
- # @param InstanceId: ckafka集群实例Id
472
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
473
473
  # @type InstanceId: String
474
- # @param Topic: 主题属性列表 (同一个批次最多支持10个)
474
+ # @param Topic: 主题属性列表 (同一个批次最多支持10个),可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取
475
475
  # @type Topic: Array
476
476
 
477
477
  attr_accessor :InstanceId, :Topic
@@ -539,9 +539,9 @@ module TencentCloud
539
539
  # @type UncleanLeaderElectionEnable: Boolean
540
540
  # @param RetentionMs: topic维度的消息保留时间(毫秒)范围1 分钟到90 天
541
541
  # @type RetentionMs: Integer
542
- # @param RetentionBytes: topic维度的消息保留大小,范围1 MB到1024 GB
542
+ # @param RetentionBytes: topic维度的消息保留大小,单位为Byte,范围1 GB到1024 GB
543
543
  # @type RetentionBytes: Integer
544
- # @param SegmentMs: Segment分片滚动的时长(毫秒),范围1 90 天
544
+ # @param SegmentMs: Segment分片滚动的时长(毫秒),范围1 天到90 天
545
545
  # @type SegmentMs: Integer
546
546
  # @param MaxMessageBytes: 批次的消息大小,范围1 KB到12 MB
547
547
  # @type MaxMessageBytes: Integer
@@ -659,7 +659,7 @@ module TencentCloud
659
659
 
660
660
  # CancelAuthorizationToken请求参数结构体
661
661
  class CancelAuthorizationTokenRequest < TencentCloud::Common::AbstractModel
662
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
662
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
663
663
  # @type InstanceId: String
664
664
  # @param User: 用户
665
665
  # @type User: String
@@ -1046,7 +1046,7 @@ module TencentCloud
1046
1046
 
1047
1047
  # 高级配置对象
1048
1048
  class Config < TencentCloud::Common::AbstractModel
1049
- # @param Retention: 消息保留时间
1049
+ # @param Retention: 消息保留时间,单位ms。
1050
1050
  # @type Retention: Integer
1051
1051
  # @param MinInsyncReplicas: 最小同步复制数
1052
1052
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -1055,22 +1055,22 @@ module TencentCloud
1055
1055
  # delete:日志按保存时间删除;compact:日志按 key 压缩;compact, delete:日志按 key 压缩且会保存时间删除。
1056
1056
  # 注意:此字段可能返回 null,表示取不到有效值。
1057
1057
  # @type CleanUpPolicy: String
1058
- # @param SegmentMs: Segment 分片滚动的时长
1058
+ # @param SegmentMs: Segment 分片滚动的时长,单位ms。
1059
1059
  # 注意:此字段可能返回 null,表示取不到有效值。
1060
1060
  # @type SegmentMs: Integer
1061
1061
  # @param UncleanLeaderElectionEnable: 0表示 false。 1表示 true。
1062
1062
  # 注意:此字段可能返回 null,表示取不到有效值。
1063
1063
  # @type UncleanLeaderElectionEnable: Integer
1064
- # @param SegmentBytes: Segment 分片滚动的字节数
1064
+ # @param SegmentBytes: Segment 分片滚动的字节数,单位bytes
1065
1065
  # 注意:此字段可能返回 null,表示取不到有效值。
1066
1066
  # @type SegmentBytes: Integer
1067
- # @param MaxMessageBytes: 最大消息字节数
1067
+ # @param MaxMessageBytes: 最大消息字节数,单位bytes
1068
1068
  # 注意:此字段可能返回 null,表示取不到有效值。
1069
1069
  # @type MaxMessageBytes: Integer
1070
- # @param RetentionBytes: 消息保留文件大小
1070
+ # @param RetentionBytes: 消息保留文件大小,单位Bytes
1071
1071
  # 注意:此字段可能返回 null,表示取不到有效值。
1072
1072
  # @type RetentionBytes: Integer
1073
- # @param LogMsgTimestampType: 消息保存的时间类型
1073
+ # @param LogMsgTimestampType: 消息保存的时间类型,CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。
1074
1074
  # 注意:此字段可能返回 null,表示取不到有效值。
1075
1075
  # @type LogMsgTimestampType: String
1076
1076
 
@@ -1376,7 +1376,7 @@ module TencentCloud
1376
1376
 
1377
1377
  # CreateAcl请求参数结构体
1378
1378
  class CreateAclRequest < TencentCloud::Common::AbstractModel
1379
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
1379
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
1380
1380
  # @type InstanceId: String
1381
1381
  # @param ResourceType: Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
1382
1382
  # @type ResourceType: Integer
@@ -1443,7 +1443,7 @@ module TencentCloud
1443
1443
 
1444
1444
  # CreateAclRule请求参数结构体
1445
1445
  class CreateAclRuleRequest < TencentCloud::Common::AbstractModel
1446
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
1446
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
1447
1447
  # @type InstanceId: String
1448
1448
  # @param ResourceType: Acl资源类型,目前只支持Topic,枚举值列表:Topic
1449
1449
  # @type ResourceType: String
@@ -1705,7 +1705,7 @@ module TencentCloud
1705
1705
 
1706
1706
  # CreateConsumer请求参数结构体
1707
1707
  class CreateConsumerRequest < TencentCloud::Common::AbstractModel
1708
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
1708
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
1709
1709
  # @type InstanceId: String
1710
1710
  # @param GroupName: 消费分组名称
1711
1711
  # @type GroupName: String
@@ -2043,7 +2043,7 @@ module TencentCloud
2043
2043
  # @type InstanceName: String
2044
2044
  # @param ZoneId: 可用区。当购买多可用区实例时,当前参数为主可用区。 [查看可用区](https://cloud.tencent.com/document/product/597/55246)
2045
2045
  # @type ZoneId: Integer
2046
- # @param Period: 预付费购买时长,例如 "1m",就是一个月
2046
+ # @param Period: 预付费购买时长,例如 "1m",就是一个月,取值范围 1m~36m
2047
2047
  # @type Period: String
2048
2048
  # @param InstanceType: 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格,国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例:入门型(general)]填写1;[标准型(standard)]填写2;[进阶型(advanced)]填写3;[容量型(capacity)]填写4;[高阶型1(specialized-1)]填写5;[高阶型2(specialized-2)]填写6;[高阶型3(specialized-3)]填写7;[高阶型4(specialized-4)]填写8。
2049
2049
  # @type InstanceType: Integer
@@ -2204,9 +2204,9 @@ module TencentCloud
2204
2204
 
2205
2205
  # CreatePartition请求参数结构体
2206
2206
  class CreatePartitionRequest < TencentCloud::Common::AbstractModel
2207
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
2207
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
2208
2208
  # @type InstanceId: String
2209
- # @param TopicName: 主题名称,可通过DescribeTopic接口获取。
2209
+ # @param TopicName: 主题名称,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取
2210
2210
  # @type TopicName: String
2211
2211
  # @param PartitionNum: 主题分区个数,传入参数为修改后的分区数,而不是增加的分区数,因此传入参数需要大于当前主题分区个数。
2212
2212
  # @type PartitionNum: Integer
@@ -2251,37 +2251,37 @@ module TencentCloud
2251
2251
 
2252
2252
  # CreatePostPaidInstance请求参数结构体
2253
2253
  class CreatePostPaidInstanceRequest < TencentCloud::Common::AbstractModel
2254
- # @param VpcId: 私有网络Id 创建的实例默认接入点所在的 vpc 对应 vpcId
2254
+ # @param VpcId: 私有网络Id,可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取
2255
2255
  # @type VpcId: String
2256
- # @param InstanceName: ckafka集群实例名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
2257
- # @type InstanceName: String
2258
- # @param SubnetId: 子网id。创建实例默认接入点所在的子网对应的子网 id
2256
+ # @param SubnetId: 子网Id,可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取
2259
2257
  # @type SubnetId: String
2258
+ # @param InstanceName: ckafka集群实例名称,是一个长度不超过128的任意字符。
2259
+ # @type InstanceName: String
2260
2260
  # @param InstanceType: 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格,国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例:入门型(general)]填写1;[标准型(standard)]填写2;[进阶型(advanced)]填写3;[容量型(capacity)]填写4;[高阶型1(specialized-1)]填写5;[高阶型2(specialized-2)]填写6;[高阶型3(specialized-3)]填写7;[高阶型4(specialized-4)]填写8。
2261
2261
  # @type InstanceType: Integer
2262
2262
  # @param MsgRetentionTime: 实例日志的默认最长保留时间,单位分钟。不传入该参数时默认为 1440 分钟(1天),最大30天。当 topic 显式设置消息保留时间时,以 topic 保留时间为准
2263
2263
  # @type MsgRetentionTime: Integer
2264
2264
  # @param ClusterId: 创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数
2265
2265
  # @type ClusterId: Integer
2266
- # @param KafkaVersion: 实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本,传任意一个均可。
2266
+ # @param KafkaVersion: 实例版本。目前支持当前支持"2.4.1", "2.4.2","2.8.1", "3.2.3",默认取值"2.4.1"。"2.4.1" 与 "2.4.2" 属于同一个版本,传任意一个均可。
2267
2267
  # @type KafkaVersion: String
2268
2268
  # @param SpecificationsType: 实例类型。"standard":标准版,"profession":专业版。 (标准版仅国际站支持,国内站目前支持专业版)
2269
2269
  # @type SpecificationsType: String
2270
2270
  # @param DiskType: 专业版实例磁盘类型,标准版实例不需要填写。"CLOUD_SSD":SSD云硬盘;"CLOUD_BASIC":高性能云硬盘。不传默认值为 "CLOUD_BASIC"
2271
2271
  # @type DiskType: String
2272
- # @param BandWidth: 实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例,峰值带宽,分区数等参数配置需要满足专业版的计费规格。
2272
+ # @param BandWidth: 实例内网峰值带宽,默认值为40。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例,峰值带宽,分区数等参数配置需要满足专业版的计费规格,可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/11745
2273
2273
  # @type BandWidth: Integer
2274
- # @param DiskSize: 实例硬盘大小,需要满足当前实例的计费规格
2274
+ # @param DiskSize: 实例硬盘大小,默认取值为500,步长设置为100。需要满足当前实例的计费规格,可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122562
2275
2275
  # @type DiskSize: Integer
2276
- # @param Partition: 实例最大分区数量,需要满足当前实例的计费规格
2276
+ # @param Partition: 实例最大分区数量,需要满足当前实例的计费规格。默认值为800,步长为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122563
2277
2277
  # @type Partition: Integer
2278
- # @param TopicNum: 实例最大 topic 数量,需要满足当前实例的计费规格
2278
+ # @param TopicNum: 实例最大 topic 数量,需要满足当前实例的计费规格。默认值为800,步长设置为100。
2279
2279
  # @type TopicNum: Integer
2280
- # @param ZoneId: 实例所在的可用区。当创建多可用区实例时,该参数为创建的默认接入点所在子网的可用区 id
2280
+ # @param ZoneId: 实例所在的可用区。当创建多可用区实例时,该参数为创建的默认接入点所在子网的可用区 id。ZoneId、ZoneIds不能同时为空,可通过[DescribeCkafkaZone](https://cloud.tencent.com/document/product/597/55246)接口获取。
2281
2281
  # @type ZoneId: Integer
2282
2282
  # @param MultiZoneFlag: 当前实例是否为多可用区实例。
2283
2283
  # @type MultiZoneFlag: Boolean
2284
- # @param ZoneIds: 当实例为多可用区实例时,多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中
2284
+ # @param ZoneIds: 当实例为多可用区实例时,多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中。ZoneId、ZoneIds不能同时为空,可通过[DescribeCkafkaZone](https://cloud.tencent.com/document/product/597/55246)接口获取。
2285
2285
  # @type ZoneIds: Array
2286
2286
  # @param InstanceNum: 购买实例数量。非必填,默认值为 1。当传入该参数时,会创建多个 instanceName 加后缀区分的实例
2287
2287
  # @type InstanceNum: Integer
@@ -2292,12 +2292,12 @@ module TencentCloud
2292
2292
  # @param ElasticBandwidthSwitch: 弹性带宽开关 0不开启 1开启(0默认)
2293
2293
  # @type ElasticBandwidthSwitch: Integer
2294
2294
 
2295
- attr_accessor :VpcId, :InstanceName, :SubnetId, :InstanceType, :MsgRetentionTime, :ClusterId, :KafkaVersion, :SpecificationsType, :DiskType, :BandWidth, :DiskSize, :Partition, :TopicNum, :ZoneId, :MultiZoneFlag, :ZoneIds, :InstanceNum, :PublicNetworkMonthly, :Tags, :ElasticBandwidthSwitch
2295
+ attr_accessor :VpcId, :SubnetId, :InstanceName, :InstanceType, :MsgRetentionTime, :ClusterId, :KafkaVersion, :SpecificationsType, :DiskType, :BandWidth, :DiskSize, :Partition, :TopicNum, :ZoneId, :MultiZoneFlag, :ZoneIds, :InstanceNum, :PublicNetworkMonthly, :Tags, :ElasticBandwidthSwitch
2296
2296
 
2297
- def initialize(vpcid=nil, instancename=nil, subnetid=nil, instancetype=nil, msgretentiontime=nil, clusterid=nil, kafkaversion=nil, specificationstype=nil, disktype=nil, bandwidth=nil, disksize=nil, partition=nil, topicnum=nil, zoneid=nil, multizoneflag=nil, zoneids=nil, instancenum=nil, publicnetworkmonthly=nil, tags=nil, elasticbandwidthswitch=nil)
2297
+ def initialize(vpcid=nil, subnetid=nil, instancename=nil, instancetype=nil, msgretentiontime=nil, clusterid=nil, kafkaversion=nil, specificationstype=nil, disktype=nil, bandwidth=nil, disksize=nil, partition=nil, topicnum=nil, zoneid=nil, multizoneflag=nil, zoneids=nil, instancenum=nil, publicnetworkmonthly=nil, tags=nil, elasticbandwidthswitch=nil)
2298
2298
  @VpcId = vpcid
2299
- @InstanceName = instancename
2300
2299
  @SubnetId = subnetid
2300
+ @InstanceName = instancename
2301
2301
  @InstanceType = instancetype
2302
2302
  @MsgRetentionTime = msgretentiontime
2303
2303
  @ClusterId = clusterid
@@ -2319,8 +2319,8 @@ module TencentCloud
2319
2319
 
2320
2320
  def deserialize(params)
2321
2321
  @VpcId = params['VpcId']
2322
- @InstanceName = params['InstanceName']
2323
2322
  @SubnetId = params['SubnetId']
2323
+ @InstanceName = params['InstanceName']
2324
2324
  @InstanceType = params['InstanceType']
2325
2325
  @MsgRetentionTime = params['MsgRetentionTime']
2326
2326
  @ClusterId = params['ClusterId']
@@ -2373,11 +2373,11 @@ module TencentCloud
2373
2373
 
2374
2374
  # CreatePrometheus请求参数结构体
2375
2375
  class CreatePrometheusRequest < TencentCloud::Common::AbstractModel
2376
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
2376
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
2377
2377
  # @type InstanceId: String
2378
- # @param VpcId: 私有网络Id
2378
+ # @param VpcId: 私有网络Id,可通过[DescribeVpcs](https://cloud.tencent.com/document/product/215/15778)接口获取
2379
2379
  # @type VpcId: String
2380
- # @param SubnetId: 子网Id
2380
+ # @param SubnetId: 子网Id,可通过[DescribeSubnets](https://cloud.tencent.com/document/product/215/15784)接口获取
2381
2381
  # @type SubnetId: String
2382
2382
 
2383
2383
  attr_accessor :InstanceId, :VpcId, :SubnetId
@@ -2420,7 +2420,7 @@ module TencentCloud
2420
2420
 
2421
2421
  # CreateRoute请求参数结构体
2422
2422
  class CreateRouteRequest < TencentCloud::Common::AbstractModel
2423
- # @param InstanceId: ckafka集群实例id,可通过DescribeInstances接口获取
2423
+ # @param InstanceId: ckafka集群实例id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
2424
2424
  # @type InstanceId: String
2425
2425
  # @param VipType: 路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)
2426
2426
  # @type VipType: Integer
@@ -2428,20 +2428,25 @@ module TencentCloud
2428
2428
  # @type VpcId: String
2429
2429
  # @param SubnetId: vpc子网id,当vipType为3时必填
2430
2430
  # @type SubnetId: String
2431
- # @param AccessType: 访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0
2431
+ # @param AccessType: 访问类型:0-plaintext;1-sasl_plaintext;3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512 默认为0
2432
+ # vipType=3,支持 0,1,3,4,5
2433
+ # vipType=7,支持0,1,3
2434
+ # vipType=1,支持1,3
2432
2435
  # @type AccessType: Integer
2433
2436
  # @param AuthFlag: 是否需要权限管理,该字段已废弃
2434
2437
  # @type AuthFlag: Integer
2435
2438
  # @param CallerAppid: 调用方appId
2436
2439
  # @type CallerAppid: Integer
2437
- # @param PublicNetwork: 公网带宽,公网路由必传,且必选时3的倍数,无默认值
2440
+ # @param PublicNetwork: 公网带宽,公网路由必传,且是3的倍数,无默认值
2438
2441
  # @type PublicNetwork: Integer
2439
2442
  # @param Ip: vip地址
2440
2443
  # @type Ip: String
2444
+ # @param Note: 备注信息
2445
+ # @type Note: String
2441
2446
 
2442
- attr_accessor :InstanceId, :VipType, :VpcId, :SubnetId, :AccessType, :AuthFlag, :CallerAppid, :PublicNetwork, :Ip
2447
+ attr_accessor :InstanceId, :VipType, :VpcId, :SubnetId, :AccessType, :AuthFlag, :CallerAppid, :PublicNetwork, :Ip, :Note
2443
2448
 
2444
- def initialize(instanceid=nil, viptype=nil, vpcid=nil, subnetid=nil, accesstype=nil, authflag=nil, callerappid=nil, publicnetwork=nil, ip=nil)
2449
+ def initialize(instanceid=nil, viptype=nil, vpcid=nil, subnetid=nil, accesstype=nil, authflag=nil, callerappid=nil, publicnetwork=nil, ip=nil, note=nil)
2445
2450
  @InstanceId = instanceid
2446
2451
  @VipType = viptype
2447
2452
  @VpcId = vpcid
@@ -2451,6 +2456,7 @@ module TencentCloud
2451
2456
  @CallerAppid = callerappid
2452
2457
  @PublicNetwork = publicnetwork
2453
2458
  @Ip = ip
2459
+ @Note = note
2454
2460
  end
2455
2461
 
2456
2462
  def deserialize(params)
@@ -2463,6 +2469,7 @@ module TencentCloud
2463
2469
  @CallerAppid = params['CallerAppid']
2464
2470
  @PublicNetwork = params['PublicNetwork']
2465
2471
  @Ip = params['Ip']
2472
+ @Note = params['Note']
2466
2473
  end
2467
2474
  end
2468
2475
 
@@ -2491,7 +2498,7 @@ module TencentCloud
2491
2498
 
2492
2499
  # CreateToken请求参数结构体
2493
2500
  class CreateTokenRequest < TencentCloud::Common::AbstractModel
2494
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
2501
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
2495
2502
  # @type InstanceId: String
2496
2503
  # @param User: 用户名
2497
2504
  # @type User: String
@@ -2531,9 +2538,9 @@ module TencentCloud
2531
2538
 
2532
2539
  # CreateTopicIpWhiteList请求参数结构体
2533
2540
  class CreateTopicIpWhiteListRequest < TencentCloud::Common::AbstractModel
2534
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
2541
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
2535
2542
  # @type InstanceId: String
2536
- # @param TopicName: 主题名称,可通过DescribeTopic接口获取
2543
+ # @param TopicName: 主题名称,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取
2537
2544
  # @type TopicName: String
2538
2545
  # @param IpWhiteList: ip白名单列表,最大值为512,即最大允许传入512个ip。
2539
2546
  # @type IpWhiteList: Array
@@ -2578,7 +2585,7 @@ module TencentCloud
2578
2585
 
2579
2586
  # CreateTopic请求参数结构体
2580
2587
  class CreateTopicRequest < TencentCloud::Common::AbstractModel
2581
- # @param InstanceId: 实例Id
2588
+ # @param InstanceId: 实例Id,可通过DescribeInstances接口获取。
2582
2589
  # @type InstanceId: String
2583
2590
  # @param TopicName: 只能包含字母、数字、下划线、“-”、“.”
2584
2591
  # @type TopicName: String
@@ -2592,23 +2599,23 @@ module TencentCloud
2592
2599
  # @type IpWhiteList: Array
2593
2600
  # @param CleanUpPolicy: 清理日志策略,日志清理模式,默认为"delete"。"delete":日志按保存时间删除,"compact":日志按 key 压缩,"compact, delete":日志按 key 压缩且会按保存时间删除。
2594
2601
  # @type CleanUpPolicy: String
2595
- # @param Note: 主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
2602
+ # @param Note: 主题备注,是一个不超过 64 个字符的字符串,可以用字母和数字为首字符,剩余部分可以包含字母、数字和横划线(-)
2596
2603
  # @type Note: String
2597
- # @param MinInsyncReplicas: 默认为1
2604
+ # @param MinInsyncReplicas: 最小同步副本数,默认为1
2598
2605
  # @type MinInsyncReplicas: Integer
2599
- # @param UncleanLeaderElectionEnable: 是否允许未同步的副本选为leader,false:不允许,true:允许,默认不允许
2606
+ # @param UncleanLeaderElectionEnable: 是否允许未同步的副本选为leader,0:不允许,1:允许,默认不允许
2600
2607
  # @type UncleanLeaderElectionEnable: Integer
2601
- # @param RetentionMs: 可选参数。消息保留时间,单位ms,当前最小值为60000ms
2608
+ # @param RetentionMs: 可选参数。消息保留时间,单位ms,当前最小值为60000。默认值为7200000ms(2小时),最大值为7776000000 ms(90天)。
2602
2609
  # @type RetentionMs: Integer
2603
- # @param SegmentMs: Segment分片滚动的时长,单位ms,当前最小为3600000ms
2610
+ # @param SegmentMs: Segment分片滚动的时长,单位ms,最小值为86400000ms(1天)。
2604
2611
  # @type SegmentMs: Integer
2605
- # @param MaxMessageBytes: 主题消息最大值,单位为 Byte,最小值1024Byte(即1KB),最大值为12582912Byte(即12MB)
2612
+ # @param MaxMessageBytes: 主题消息最大值,单位为 Byte,最小值1024Bytes(即1KB),最大值为12582912Bytes(即12MB)
2606
2613
  # @type MaxMessageBytes: Integer
2607
2614
  # @param EnableAclRule: 预设ACL规则, 1:打开 0:关闭,默认不打开
2608
2615
  # @type EnableAclRule: Integer
2609
2616
  # @param AclRuleName: 预设ACL规则的名称
2610
2617
  # @type AclRuleName: String
2611
- # @param RetentionBytes: 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
2618
+ # @param RetentionBytes: 可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。
2612
2619
  # @type RetentionBytes: Integer
2613
2620
  # @param Tags: 标签列表
2614
2621
  # @type Tags: Array
@@ -2704,7 +2711,7 @@ module TencentCloud
2704
2711
 
2705
2712
  # CreateUser请求参数结构体
2706
2713
  class CreateUserRequest < TencentCloud::Common::AbstractModel
2707
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
2714
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
2708
2715
  # @type InstanceId: String
2709
2716
  # @param Name: 用户名称
2710
2717
  # @type Name: String
@@ -3141,7 +3148,7 @@ module TencentCloud
3141
3148
  # @type TopicId: String
3142
3149
  # @param PartitionNum: 分区数
3143
3150
  # @type PartitionNum: Integer
3144
- # @param RetentionMs: 过期时间
3151
+ # @param RetentionMs: 过期时间,单位ms
3145
3152
  # @type RetentionMs: Integer
3146
3153
  # @param Note: 备注
3147
3154
  # @type Note: String
@@ -3237,7 +3244,7 @@ module TencentCloud
3237
3244
 
3238
3245
  # DeleteAcl请求参数结构体
3239
3246
  class DeleteAclRequest < TencentCloud::Common::AbstractModel
3240
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3247
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3241
3248
  # @type InstanceId: String
3242
3249
  # @param ResourceType: Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
3243
3250
  # @type ResourceType: Integer
@@ -3300,7 +3307,7 @@ module TencentCloud
3300
3307
 
3301
3308
  # DeleteAclRule请求参数结构体
3302
3309
  class DeleteAclRuleRequest < TencentCloud::Common::AbstractModel
3303
- # @param InstanceId: 实例id信息,可通过DescribeInstances接口获取。
3310
+ # @param InstanceId: 实例id信息,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3304
3311
  # @type InstanceId: String
3305
3312
  # @param RuleName: acl规则名称,可通过DescribeAclRule接口获取。
3306
3313
  # @type RuleName: String
@@ -3457,7 +3464,7 @@ module TencentCloud
3457
3464
 
3458
3465
  # DeleteGroup请求参数结构体
3459
3466
  class DeleteGroupRequest < TencentCloud::Common::AbstractModel
3460
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3467
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取。
3461
3468
  # @type InstanceId: String
3462
3469
  # @param Group: 消费组名称,可通过DescribeConsumerGroup接口获取。
3463
3470
  # @type Group: String
@@ -3500,7 +3507,7 @@ module TencentCloud
3500
3507
 
3501
3508
  # DeleteInstancePost请求参数结构体
3502
3509
  class DeleteInstancePostRequest < TencentCloud::Common::AbstractModel
3503
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3510
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3504
3511
  # @type InstanceId: String
3505
3512
 
3506
3513
  attr_accessor :InstanceId
@@ -3539,7 +3546,7 @@ module TencentCloud
3539
3546
 
3540
3547
  # DeleteInstancePre请求参数结构体
3541
3548
  class DeleteInstancePreRequest < TencentCloud::Common::AbstractModel
3542
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3549
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3543
3550
  # @type InstanceId: String
3544
3551
 
3545
3552
  attr_accessor :InstanceId
@@ -3578,7 +3585,7 @@ module TencentCloud
3578
3585
 
3579
3586
  # DeleteRoute请求参数结构体
3580
3587
  class DeleteRouteRequest < TencentCloud::Common::AbstractModel
3581
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
3588
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3582
3589
  # @type InstanceId: String
3583
3590
  # @param RouteId: 路由id,可通过DescribeRoute接口获取
3584
3591
  # @type RouteId: Integer
@@ -3629,7 +3636,7 @@ module TencentCloud
3629
3636
 
3630
3637
  # DeleteRouteTriggerTime请求参数结构体
3631
3638
  class DeleteRouteTriggerTimeRequest < TencentCloud::Common::AbstractModel
3632
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
3639
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3633
3640
  # @type InstanceId: String
3634
3641
  # @param DelayTime: 修改删除路由的定时时间
3635
3642
  # @type DelayTime: String
@@ -3665,9 +3672,9 @@ module TencentCloud
3665
3672
 
3666
3673
  # DeleteTopicIpWhiteList请求参数结构体
3667
3674
  class DeleteTopicIpWhiteListRequest < TencentCloud::Common::AbstractModel
3668
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3675
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3669
3676
  # @type InstanceId: String
3670
- # @param TopicName: 主题名,可通过DescribeTopic接口获取。
3677
+ # @param TopicName: 主题名,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。
3671
3678
  # @type TopicName: String
3672
3679
  # @param IpWhiteList: ip白名单列表
3673
3680
  # @type IpWhiteList: Array
@@ -3755,9 +3762,9 @@ module TencentCloud
3755
3762
 
3756
3763
  # DeleteUser请求参数结构体
3757
3764
  class DeleteUserRequest < TencentCloud::Common::AbstractModel
3758
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3765
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取。
3759
3766
  # @type InstanceId: String
3760
- # @param Name: 用户名称,可通过DescribeUser接口获取。
3767
+ # @param Name: 用户名称,可通过[DescribeUser](https://cloud.tencent.com/document/product/597/40855)接口获取。
3761
3768
  # @type Name: String
3762
3769
 
3763
3770
  attr_accessor :InstanceId, :Name
@@ -3798,7 +3805,7 @@ module TencentCloud
3798
3805
 
3799
3806
  # DescribeACL请求参数结构体
3800
3807
  class DescribeACLRequest < TencentCloud::Common::AbstractModel
3801
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3808
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3802
3809
  # @type InstanceId: String
3803
3810
  # @param ResourceType: Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
3804
3811
  # @type ResourceType: Integer
@@ -3857,7 +3864,7 @@ module TencentCloud
3857
3864
 
3858
3865
  # DescribeAclRule请求参数结构体
3859
3866
  class DescribeAclRuleRequest < TencentCloud::Common::AbstractModel
3860
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3867
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
3861
3868
  # @type InstanceId: String
3862
3869
  # @param RuleName: ACL规则名
3863
3870
  # @type RuleName: String
@@ -4329,7 +4336,7 @@ module TencentCloud
4329
4336
 
4330
4337
  # DescribeConnectResource返回参数结构体
4331
4338
  class DescribeConnectResourceResponse < TencentCloud::Common::AbstractModel
4332
- # @param Result: 连接源的Id
4339
+ # @param Result: 连接源数据信息
4333
4340
  # @type Result: :class:`Tencentcloud::Ckafka.v20190819.models.DescribeConnectResourceResp`
4334
4341
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4335
4342
  # @type RequestId: String
@@ -4354,11 +4361,11 @@ module TencentCloud
4354
4361
  class DescribeConnectResourcesRequest < TencentCloud::Common::AbstractModel
4355
4362
  # @param Type: 连接源类型
4356
4363
  # @type Type: String
4357
- # @param SearchWord: 连接源名称的关键字查询
4364
+ # @param SearchWord: 连接源名称的关键字查询,支持模糊匹配
4358
4365
  # @type SearchWord: String
4359
4366
  # @param Offset: 分页偏移量,默认为0
4360
4367
  # @type Offset: Integer
4361
- # @param Limit: 返回数量,默认为20,最大值为100
4368
+ # @param Limit: 返回数量,默认为20,最大值为1000 (超过1000,则限制为1000)
4362
4369
  # @type Limit: Integer
4363
4370
  # @param ResourceRegion: 连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源)
4364
4371
  # @type ResourceRegion: String
@@ -4434,15 +4441,15 @@ module TencentCloud
4434
4441
 
4435
4442
  # DescribeConsumerGroup请求参数结构体
4436
4443
  class DescribeConsumerGroupRequest < TencentCloud::Common::AbstractModel
4437
- # @param InstanceId: ckafka集群实例Id
4444
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
4438
4445
  # @type InstanceId: String
4439
- # @param GroupName: 可选,用户需要查询的group名称。
4446
+ # @param GroupName: 用户需要查询的group名称。
4440
4447
  # @type GroupName: String
4441
- # @param TopicName: 可选,用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
4448
+ # @param TopicName: 用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
4442
4449
  # @type TopicName: String
4443
- # @param Limit: 本次返回个数限制,最大支持50
4450
+ # @param Limit: 返回消费组的限制数量,最大支持50
4444
4451
  # @type Limit: Integer
4445
- # @param Offset: 偏移位置
4452
+ # @param Offset: 消费组列表的起始偏移量
4446
4453
  # @type Offset: Integer
4447
4454
 
4448
4455
  attr_accessor :InstanceId, :GroupName, :TopicName, :Limit, :Offset
@@ -4489,7 +4496,7 @@ module TencentCloud
4489
4496
 
4490
4497
  # DescribeCvmInfo请求参数结构体
4491
4498
  class DescribeCvmInfoRequest < TencentCloud::Common::AbstractModel
4492
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
4499
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
4493
4500
  # @type InstanceId: String
4494
4501
 
4495
4502
  attr_accessor :InstanceId
@@ -4730,7 +4737,7 @@ module TencentCloud
4730
4737
 
4731
4738
  # DescribeDatahubTasks请求参数结构体
4732
4739
  class DescribeDatahubTasksRequest < TencentCloud::Common::AbstractModel
4733
- # @param Limit: 返回数量,默认为20,最大值为100
4740
+ # @param Limit: 返回数量,默认为20,最大值为100 (超过100限制为100)
4734
4741
  # @type Limit: Integer
4735
4742
  # @param Offset: 分页偏移量,默认为0
4736
4743
  # @type Offset: Integer
@@ -4844,7 +4851,7 @@ module TencentCloud
4844
4851
  # @type TopicId: String
4845
4852
  # @param PartitionNum: 分区数
4846
4853
  # @type PartitionNum: Integer
4847
- # @param RetentionMs: 过期时间
4854
+ # @param RetentionMs: 过期时间,单位ms
4848
4855
  # @type RetentionMs: Integer
4849
4856
  # @param Note: 备注
4850
4857
  # @type Note: String
@@ -5017,9 +5024,9 @@ module TencentCloud
5017
5024
 
5018
5025
  # DescribeGroupInfo请求参数结构体
5019
5026
  class DescribeGroupInfoRequest < TencentCloud::Common::AbstractModel
5020
- # @param InstanceId: ckafka集群实例Id
5027
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5021
5028
  # @type InstanceId: String
5022
- # @param GroupList: Kafka 消费分组列表
5029
+ # @param GroupList: Kafka 消费分组列表,可通过[DescribeConsumerGroup](https://cloud.tencent.com/document/product/597/40841)接口获取
5023
5030
  # @type GroupList: Array
5024
5031
 
5025
5032
  attr_accessor :InstanceId, :GroupList
@@ -5185,7 +5192,7 @@ module TencentCloud
5185
5192
 
5186
5193
  # DescribeInstanceAttributes请求参数结构体
5187
5194
  class DescribeInstanceAttributesRequest < TencentCloud::Common::AbstractModel
5188
- # @param InstanceId: ckafka集群实例Id
5195
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5189
5196
  # @type InstanceId: String
5190
5197
 
5191
5198
  attr_accessor :InstanceId
@@ -5382,7 +5389,7 @@ module TencentCloud
5382
5389
 
5383
5390
  # DescribePrometheus请求参数结构体
5384
5391
  class DescribePrometheusRequest < TencentCloud::Common::AbstractModel
5385
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
5392
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5386
5393
  # @type InstanceId: String
5387
5394
 
5388
5395
  attr_accessor :InstanceId
@@ -5627,9 +5634,9 @@ module TencentCloud
5627
5634
 
5628
5635
  # DescribeTopicAttributes请求参数结构体
5629
5636
  class DescribeTopicAttributesRequest < TencentCloud::Common::AbstractModel
5630
- # @param InstanceId: ckafka集群实例Id
5637
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5631
5638
  # @type InstanceId: String
5632
- # @param TopicName: 主题名称
5639
+ # @param TopicName: 主题名称,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取
5633
5640
  # @type TopicName: String
5634
5641
 
5635
5642
  attr_accessor :InstanceId, :TopicName
@@ -5670,19 +5677,19 @@ module TencentCloud
5670
5677
 
5671
5678
  # DescribeTopicDetail请求参数结构体
5672
5679
  class DescribeTopicDetailRequest < TencentCloud::Common::AbstractModel
5673
- # @param InstanceId: ckafka集群实例Id
5680
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5674
5681
  # @type InstanceId: String
5675
5682
  # @param SearchWord: (过滤条件)按照topicName过滤,支持模糊查询
5676
5683
  # @type SearchWord: String
5677
5684
  # @param Offset: 偏移量,不填默认为0
5678
5685
  # @type Offset: Integer
5679
- # @param Limit: 返回数量,不填则默认 10,最大值20,取值要大于0
5686
+ # @param Limit: 返回数量,不填则默认 20,取值要大于0
5680
5687
  # @type Limit: Integer
5681
5688
  # @param AclRuleName: Acl预设策略名称
5682
5689
  # @type AclRuleName: String
5683
- # @param OrderBy: 根据特定的属性排序(目前支持PartitionNum/CreateTime)
5690
+ # @param OrderBy: 根据特定的属性排序(目前支持PartitionNum/CreateTime),默认值为CreateTime。
5684
5691
  # @type OrderBy: String
5685
- # @param OrderType: 0-顺序、1-倒序
5692
+ # @param OrderType: 0-顺序、1-倒序,默认值为0。
5686
5693
  # @type OrderType: Integer
5687
5694
  # @param Filters: 目前支持 ReplicaNum (副本数)筛选
5688
5695
  # @type Filters: Array
@@ -5744,7 +5751,7 @@ module TencentCloud
5744
5751
 
5745
5752
  # DescribeTopicFlowRanking请求参数结构体
5746
5753
  class DescribeTopicFlowRankingRequest < TencentCloud::Common::AbstractModel
5747
- # @param InstanceId: ckafka集群实例Id
5754
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5748
5755
  # @type InstanceId: String
5749
5756
  # @param RankingType: 排行类别,PRO:Topic生产流量;CON:Topic消费流量
5750
5757
  # @type RankingType: String
@@ -5799,9 +5806,9 @@ module TencentCloud
5799
5806
 
5800
5807
  # DescribeTopicProduceConnection请求参数结构体
5801
5808
  class DescribeTopicProduceConnectionRequest < TencentCloud::Common::AbstractModel
5802
- # @param InstanceId: ckafka集群实例Id
5809
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
5803
5810
  # @type InstanceId: String
5804
- # @param TopicName: 主题名
5811
+ # @param TopicName: 主题名,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取。
5805
5812
  # @type TopicName: String
5806
5813
 
5807
5814
  attr_accessor :InstanceId, :TopicName
@@ -5958,7 +5965,7 @@ module TencentCloud
5958
5965
  # @type TopicName: String
5959
5966
  # @param Offset: 偏移量,不填默认为0
5960
5967
  # @type Offset: Integer
5961
- # @param Limit: 返回数量,不填则默认10,最大值20。
5968
+ # @param Limit: 返回数量,默认值为20,必须大于0
5962
5969
  # @type Limit: Integer
5963
5970
  # @param OutOfSyncReplicaOnly: 仅筛选未同步副本
5964
5971
  # @type OutOfSyncReplicaOnly: Boolean
@@ -6725,7 +6732,7 @@ module TencentCloud
6725
6732
 
6726
6733
  # FetchDatahubMessageByOffset请求参数结构体
6727
6734
  class FetchDatahubMessageByOffsetRequest < TencentCloud::Common::AbstractModel
6728
- # @param Name: 弹性topic名称,可通过DescribeDatahubTopics接口获取。
6735
+ # @param Name: 弹性topic名称,可通过[DescribeDatahubTopics](https://cloud.tencent.com/document/product/597/86863)接口获取
6729
6736
  # @type Name: String
6730
6737
  # @param Partition: 分区id
6731
6738
  # @type Partition: Integer
@@ -6827,9 +6834,9 @@ module TencentCloud
6827
6834
 
6828
6835
  # FetchMessageByOffset请求参数结构体
6829
6836
  class FetchMessageByOffsetRequest < TencentCloud::Common::AbstractModel
6830
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
6837
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
6831
6838
  # @type InstanceId: String
6832
- # @param Topic: 主题名,可通过DescribeTopic接口获取。
6839
+ # @param Topic: 主题名,可通过[DescribeTopic](https://cloud.tencent.com/document/product/597/40847)接口获取
6833
6840
  # @type Topic: String
6834
6841
  # @param Partition: 分区id
6835
6842
  # @type Partition: Integer
@@ -8239,7 +8246,7 @@ module TencentCloud
8239
8246
 
8240
8247
  # InstanceScalingDown请求参数结构体
8241
8248
  class InstanceScalingDownRequest < TencentCloud::Common::AbstractModel
8242
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
8249
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
8243
8250
  # @type InstanceId: String
8244
8251
  # @param UpgradeStrategy: 缩容模式 1:稳定变配
8245
8252
  # 2.高速变配
@@ -8985,17 +8992,17 @@ module TencentCloud
8985
8992
 
8986
8993
  # ModifyGroupOffsets请求参数结构体
8987
8994
  class ModifyGroupOffsetsRequest < TencentCloud::Common::AbstractModel
8988
- # @param InstanceId: ckafka集群实例Id
8995
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
8989
8996
  # @type InstanceId: String
8990
- # @param Group: 消费分组名称
8997
+ # @param Group: 消费分组名称,可通过[DescribeConsumerGroup](https://cloud.tencent.com/document/product/597/40841)接口获取
8991
8998
  # @type Group: String
8992
- # @param Strategy: 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
8999
+ # @param Strategy: 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
8993
9000
  # @type Strategy: Integer
8994
- # @param Topics: 需要重置的主题名列表, 不填表示全部
9001
+ # @param Topics: 需要重置的主题名列表
8995
9002
  # @type Topics: Array
8996
9003
  # @param Shift: 当strategy为0时,必须包含该字段,可以大于零代表会把offset向后移动shift条,小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift),需要注意的是如果新的offset小于partition的earliest则会设置为earliest,如果大于partition 的latest则会设置为latest
8997
9004
  # @type Shift: Integer
8998
- # @param ShiftTimestamp: 单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的时,如果指定的时间不存在消息,则获取最末尾的offset。
9005
+ # @param ShiftTimestamp: 单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的是,如果指定的时间不存在消息,则获取最末尾的offset。
8999
9006
  # @type ShiftTimestamp: Integer
9000
9007
  # @param Offset: 需要重新设置的offset位置。当strategy为2,必须包含该字段。
9001
9008
  # @type Offset: Integer
@@ -9076,7 +9083,7 @@ module TencentCloud
9076
9083
 
9077
9084
  # ModifyInstanceAttributes请求参数结构体
9078
9085
  class ModifyInstanceAttributesRequest < TencentCloud::Common::AbstractModel
9079
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
9086
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
9080
9087
  # @type InstanceId: String
9081
9088
  # @param MsgRetentionTime: 实例日志的最长保留时间,单位分钟,最大90天,最小为1min
9082
9089
  # @type MsgRetentionTime: Integer
@@ -9167,7 +9174,7 @@ module TencentCloud
9167
9174
 
9168
9175
  # ModifyInstancePre请求参数结构体
9169
9176
  class ModifyInstancePreRequest < TencentCloud::Common::AbstractModel
9170
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
9177
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
9171
9178
  # @type InstanceId: String
9172
9179
  # @param DiskSize: 磁盘大小 单位 GB 最大值为500000,步长100
9173
9180
  # 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
@@ -9221,9 +9228,9 @@ module TencentCloud
9221
9228
 
9222
9229
  # ModifyPassword请求参数结构体
9223
9230
  class ModifyPasswordRequest < TencentCloud::Common::AbstractModel
9224
- # @param InstanceId: 实例Id,可通过DescribeInstances接口获取。
9231
+ # @param InstanceId: 实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
9225
9232
  # @type InstanceId: String
9226
- # @param Name: 用户名称,可通过DescribeUser接口获取。
9233
+ # @param Name: 用户名称,可通过[DescribeUser](https://cloud.tencent.com/document/product/597/40855)接口获取。
9227
9234
  # @type Name: String
9228
9235
  # @param Password: 用户当前密码
9229
9236
  # @type Password: String
@@ -9272,7 +9279,7 @@ module TencentCloud
9272
9279
 
9273
9280
  # ModifyRoutineMaintenanceTask请求参数结构体
9274
9281
  class ModifyRoutineMaintenanceTaskRequest < TencentCloud::Common::AbstractModel
9275
- # @param InstanceId: ckafka集群实例id,可通过DescribeInstances接口获取
9282
+ # @param InstanceId: ckafka集群实例id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
9276
9283
  # @type InstanceId: String
9277
9284
  # @param MaintenanceType: 自动化运维类别, 类别如下: QUOTA、ANALYSIS、RE_BALANCE、ELASTIC_BANDWIDTH
9278
9285
  # @type MaintenanceType: String
@@ -9367,7 +9374,7 @@ module TencentCloud
9367
9374
  # @type RetentionMs: Integer
9368
9375
  # @param MaxMessageBytes: 主题消息最大值,单位为 Byte,最大值为12582912Byte(即12MB)。
9369
9376
  # @type MaxMessageBytes: Integer
9370
- # @param SegmentMs: Segment 分片滚动的时长,单位:ms,当前最小为300000ms
9377
+ # @param SegmentMs: Segment 分片滚动的时长,单位:ms,当前最小值86400000ms
9371
9378
  # @type SegmentMs: Integer
9372
9379
  # @param CleanUpPolicy: 消息删除策略,可以选择delete 或者compact
9373
9380
  # @type CleanUpPolicy: String
@@ -10231,7 +10238,7 @@ module TencentCloud
10231
10238
 
10232
10239
  # 普罗米修斯打通的vipVport
10233
10240
  class PrometheusDTO < TencentCloud::Common::AbstractModel
10234
- # @param Type: export类型(jmx_export\node_export
10241
+ # @param Type: export类型(JmxExport\NodeExport
10235
10242
  # @type Type: String
10236
10243
  # @param SourceIp: vip
10237
10244
  # @type SourceIp: String
@@ -10414,7 +10421,7 @@ module TencentCloud
10414
10421
 
10415
10422
  # RenewCkafkaInstance请求参数结构体
10416
10423
  class RenewCkafkaInstanceRequest < TencentCloud::Common::AbstractModel
10417
- # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
10424
+ # @param InstanceId: ckafka集群实例Id,可通过[DescribeInstances](https://cloud.tencent.com/document/product/597/40835)接口获取
10418
10425
  # @type InstanceId: String
10419
10426
  # @param TimeSpan: 续费时长, 默认为1, 单位是月
10420
10427
  # @type TimeSpan: Integer
@@ -10525,10 +10532,13 @@ module TencentCloud
10525
10532
  # @param VpcId: 私有网络Id
10526
10533
  # 注意:此字段可能返回 null,表示取不到有效值。
10527
10534
  # @type VpcId: String
10535
+ # @param Note: 备注信息
10536
+ # 注意:此字段可能返回 null,表示取不到有效值。
10537
+ # @type Note: String
10528
10538
 
10529
- attr_accessor :AccessType, :RouteId, :VipType, :VipList, :Domain, :DomainPort, :DeleteTimestamp, :Subnet, :BrokerVipList, :VpcId
10539
+ attr_accessor :AccessType, :RouteId, :VipType, :VipList, :Domain, :DomainPort, :DeleteTimestamp, :Subnet, :BrokerVipList, :VpcId, :Note
10530
10540
 
10531
- def initialize(accesstype=nil, routeid=nil, viptype=nil, viplist=nil, domain=nil, domainport=nil, deletetimestamp=nil, subnet=nil, brokerviplist=nil, vpcid=nil)
10541
+ def initialize(accesstype=nil, routeid=nil, viptype=nil, viplist=nil, domain=nil, domainport=nil, deletetimestamp=nil, subnet=nil, brokerviplist=nil, vpcid=nil, note=nil)
10532
10542
  @AccessType = accesstype
10533
10543
  @RouteId = routeid
10534
10544
  @VipType = viptype
@@ -10539,6 +10549,7 @@ module TencentCloud
10539
10549
  @Subnet = subnet
10540
10550
  @BrokerVipList = brokerviplist
10541
10551
  @VpcId = vpcid
10552
+ @Note = note
10542
10553
  end
10543
10554
 
10544
10555
  def deserialize(params)
@@ -10566,6 +10577,7 @@ module TencentCloud
10566
10577
  end
10567
10578
  end
10568
10579
  @VpcId = params['VpcId']
10580
+ @Note = params['Note']
10569
10581
  end
10570
10582
  end
10571
10583
 
@@ -11218,7 +11230,7 @@ module TencentCloud
11218
11230
  class TopicAttributesResponse < TencentCloud::Common::AbstractModel
11219
11231
  # @param TopicId: 主题 ID
11220
11232
  # @type TopicId: String
11221
- # @param CreateTime: 创建时间
11233
+ # @param CreateTime: 创建时间的秒级时间戳
11222
11234
  # @type CreateTime: Integer
11223
11235
  # @param Note: 主题备注
11224
11236
  # @type Note: String
@@ -12200,14 +12212,12 @@ module TencentCloud
12200
12212
  # @type Profession: String
12201
12213
  # @param Physical: 购买物理独占版配置
12202
12214
  # @type Physical: String
12203
- # @param PublicNetwork: 公网带宽 最小3Mbps 最大999Mbps 仅专业版支持填写
12215
+ # @param PublicNetwork: 公网带宽 最小3Mbps 最大999Mbps 仅专业版支持填写 已废弃,无实际意义
12204
12216
  # @type PublicNetwork: String
12205
12217
  # @param PublicNetworkLimit: 公网带宽配置
12206
12218
  # @type PublicNetworkLimit: String
12207
12219
  # @param RequestId: 请求Id
12208
12220
  # @type RequestId: String
12209
- # @param Version: 版本
12210
- # @type Version: String
12211
12221
  # @param Offset: 分页offset
12212
12222
  # @type Offset: Integer
12213
12223
  # @param Limit: 分页limit
@@ -12215,9 +12225,9 @@ module TencentCloud
12215
12225
  # @param ForceCheckTag: 是否必须录入tag
12216
12226
  # @type ForceCheckTag: Boolean
12217
12227
 
12218
- attr_accessor :ZoneList, :MaxBuyInstanceNum, :MaxBandwidth, :UnitPrice, :MessagePrice, :ClusterInfo, :Standard, :StandardS2, :Profession, :Physical, :PublicNetwork, :PublicNetworkLimit, :RequestId, :Version, :Offset, :Limit, :ForceCheckTag
12228
+ attr_accessor :ZoneList, :MaxBuyInstanceNum, :MaxBandwidth, :UnitPrice, :MessagePrice, :ClusterInfo, :Standard, :StandardS2, :Profession, :Physical, :PublicNetwork, :PublicNetworkLimit, :RequestId, :Offset, :Limit, :ForceCheckTag
12219
12229
 
12220
- def initialize(zonelist=nil, maxbuyinstancenum=nil, maxbandwidth=nil, unitprice=nil, messageprice=nil, clusterinfo=nil, standard=nil, standards2=nil, profession=nil, physical=nil, publicnetwork=nil, publicnetworklimit=nil, requestid=nil, version=nil, offset=nil, limit=nil, forcechecktag=nil)
12230
+ def initialize(zonelist=nil, maxbuyinstancenum=nil, maxbandwidth=nil, unitprice=nil, messageprice=nil, clusterinfo=nil, standard=nil, standards2=nil, profession=nil, physical=nil, publicnetwork=nil, publicnetworklimit=nil, requestid=nil, offset=nil, limit=nil, forcechecktag=nil)
12221
12231
  @ZoneList = zonelist
12222
12232
  @MaxBuyInstanceNum = maxbuyinstancenum
12223
12233
  @MaxBandwidth = maxbandwidth
@@ -12231,7 +12241,6 @@ module TencentCloud
12231
12241
  @PublicNetwork = publicnetwork
12232
12242
  @PublicNetworkLimit = publicnetworklimit
12233
12243
  @RequestId = requestid
12234
- @Version = version
12235
12244
  @Offset = offset
12236
12245
  @Limit = limit
12237
12246
  @ForceCheckTag = forcechecktag
@@ -12271,7 +12280,6 @@ module TencentCloud
12271
12280
  @PublicNetwork = params['PublicNetwork']
12272
12281
  @PublicNetworkLimit = params['PublicNetworkLimit']
12273
12282
  @RequestId = params['RequestId']
12274
- @Version = params['Version']
12275
12283
  @Offset = params['Offset']
12276
12284
  @Limit = params['Limit']
12277
12285
  @ForceCheckTag = params['ForceCheckTag']
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ckafka
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1135
4
+ version: 3.0.1139
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-09-02 00:00:00.000000000 Z
11
+ date: 2025-09-10 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,9 +33,9 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/v20190819/client.rb
37
- - lib/v20190819/models.rb
38
36
  - lib/tencentcloud-sdk-ckafka.rb
37
+ - lib/v20190819/models.rb
38
+ - lib/v20190819/client.rb
39
39
  - lib/VERSION
40
40
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
41
41
  licenses: