tencentcloud-sdk-ckafka 3.0.1135 → 3.0.1138

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7a3451299368de581dd0c11221aaf51a19527f4
-  data.tar.gz: 15baefc78aef5aeecdb95e3542e325f1ec2319e9
+  metadata.gz: eb2716b9ef37d3aecdaa00ff851fee5fdacd130d
+  data.tar.gz: 44d2fcbf6afa106312ec22267f90d6c20b5bee6d
 SHA512:
-  metadata.gz: d9188737dff9de8e4ab45cb386586c3e298236ca81f812711be9cb81e2a4d7aa514483effc8313410a08219fa7332fe411bf9d787eb67d8acdeaeb19b1e14669
-  data.tar.gz: 4578414422cdc43509b143d60ec902f9412c174d564ef2e6c78a867e3f4ba7c17202762b9262d3859929b5398473963ab082f3548b57cc4d5027b1df629afc1a
+  metadata.gz: 92b6368eec7829623f25d2b2342e09316394cb5fb16dcdbaf6986512bd02e782f3fc69c68b385c7c039ad4206d0d6b9dbc79f6301c52eeb7ae94481a2e68d564
+  data.tar.gz: 687846707d3ce765ec1b7194b653abe94697253d94b2d8829fb4fac9111df92662aa8d36af8e16ebebcfa183ebf2dadcc44e2a7f9785230dbd59afd050797909

data/lib/VERSION

@@ -1 +1 @@
-3.0.1135
+3.0.1138

data/lib/v20190819/models.rb

@@ -1046,7 +1046,7 @@ module TencentCloud
 
       # 高级配置对象
       class Config < TencentCloud::Common::AbstractModel
-        # @param Retention: 消息保留时间
+        # @param Retention: 消息保留时间，单位ms。
         # @type Retention: Integer
         # @param MinInsyncReplicas: 最小同步复制数
         # 注意：此字段可能返回 null，表示取不到有效值。
@@ -1055,22 +1055,22 @@ module TencentCloud
         # delete：日志按保存时间删除；compact：日志按 key 压缩；compact, delete：日志按 key 压缩且会保存时间删除。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type CleanUpPolicy: String
-        # @param SegmentMs: Segment 分片滚动的时长
+        # @param SegmentMs: Segment 分片滚动的时长，单位ms。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SegmentMs: Integer
         # @param UncleanLeaderElectionEnable: 0表示 false。 1表示 true。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type UncleanLeaderElectionEnable: Integer
-        # @param SegmentBytes: Segment 分片滚动的字节数
+        # @param SegmentBytes: Segment 分片滚动的字节数，单位bytes
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type SegmentBytes: Integer
-        # @param MaxMessageBytes: 最大消息字节数
+        # @param MaxMessageBytes: 最大消息字节数，单位bytes
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type MaxMessageBytes: Integer
-        # @param RetentionBytes: 消息保留文件大小
+        # @param RetentionBytes: 消息保留文件大小，单位Bytes
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type RetentionBytes: Integer
-        # @param LogMsgTimestampType: 消息保存的时间类型
+        # @param LogMsgTimestampType: 消息保存的时间类型，CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type LogMsgTimestampType: String
 
@@ -2043,7 +2043,7 @@ module TencentCloud
         # @type InstanceName: String
         # @param ZoneId: 可用区。当购买多可用区实例时，当前参数为主可用区。  [查看可用区](https://cloud.tencent.com/document/product/597/55246)
         # @type ZoneId: Integer
-        # @param Period: 预付费购买时长，例如 "1m",就是一个月
+        # @param Period: 预付费购买时长，例如 "1m",就是一个月,取值范围 1m~36m
         # @type Period: String
         # @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。
         # @type InstanceType: Integer
@@ -2428,7 +2428,10 @@ module TencentCloud
         # @type VpcId: String
         # @param SubnetId: vpc子网id,当vipType为3时必填
         # @type SubnetId: String
-        # @param AccessType: 访问类型：0-plaintext；1-sasl_plaintext；2-ssl；3-sasl_ssl,默认为0
+        # @param AccessType: 访问类型：0-plaintext；1-sasl_plaintext；3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512  默认为0
+        # vipType=3,支持 0,1,3,4,5
+        # vipType=7,支持0,1,3
+        # vipType=1,支持1,3
         # @type AccessType: Integer
         # @param AuthFlag: 是否需要权限管理,该字段已废弃
         # @type AuthFlag: Integer
@@ -2578,7 +2581,7 @@ module TencentCloud
 
       # CreateTopic请求参数结构体
       class CreateTopicRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例Id
+        # @param InstanceId: 实例Id，可通过DescribeInstances接口获取。
         # @type InstanceId: String
         # @param TopicName: 只能包含字母、数字、下划线、“-”、“.”
         # @type TopicName: String
@@ -2592,23 +2595,23 @@ module TencentCloud
         # @type IpWhiteList: Array
         # @param CleanUpPolicy: 清理日志策略，日志清理模式，默认为"delete"。"delete"：日志按保存时间删除，"compact"：日志按 key 压缩，"compact, delete"：日志按 key 压缩且会按保存时间删除。
         # @type CleanUpPolicy: String
-        # @param Note: 主题备注，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-)
+        # @param Note: 主题备注，是一个不超过 64 个字符的字符串，可以用字母和数字为首字符，剩余部分可以包含字母、数字和横划线(-)
         # @type Note: String
-        # @param MinInsyncReplicas: 默认为1
+        # @param MinInsyncReplicas: 最小同步副本数，默认为1
         # @type MinInsyncReplicas: Integer
-        # @param UncleanLeaderElectionEnable: 是否允许未同步的副本选为leader，false:不允许，true:允许，默认不允许
+        # @param UncleanLeaderElectionEnable: 是否允许未同步的副本选为leader，0:不允许，1:允许，默认不允许
         # @type UncleanLeaderElectionEnable: Integer
-        # @param RetentionMs: 可选参数。消息保留时间，单位ms，当前最小值为60000ms
+        # @param RetentionMs: 可选参数。消息保留时间，单位ms，当前最小值为60000。默认值为7200000ms（2小时），最大值为7776000000 ms（90天）。
         # @type RetentionMs: Integer
-        # @param SegmentMs: Segment分片滚动的时长，单位ms，当前最小为3600000ms
+        # @param SegmentMs: Segment分片滚动的时长，单位ms，最小值为86400000ms（1天）。
         # @type SegmentMs: Integer
-        # @param MaxMessageBytes: 主题消息最大值，单位为 Byte，最小值1024Byte(即1KB)，最大值为12582912Byte（即12MB）
+        # @param MaxMessageBytes: 主题消息最大值，单位为 Byte，最小值1024Bytes(即1KB)，最大值为12582912Bytes（即12MB）
         # @type MaxMessageBytes: Integer
         # @param EnableAclRule: 预设ACL规则, 1:打开  0:关闭，默认不打开
         # @type EnableAclRule: Integer
         # @param AclRuleName: 预设ACL规则的名称
         # @type AclRuleName: String
-        # @param RetentionBytes: 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
+        # @param RetentionBytes: 可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。
         # @type RetentionBytes: Integer
         # @param Tags: 标签列表
         # @type Tags: Array
@@ -4329,7 +4332,7 @@ module TencentCloud
 
       # DescribeConnectResource返回参数结构体
       class DescribeConnectResourceResponse < TencentCloud::Common::AbstractModel
-        # @param Result: 连接源的Id
+        # @param Result: 连接源数据信息
         # @type Result: :class:`Tencentcloud::Ckafka.v20190819.models.DescribeConnectResourceResp`
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -4354,11 +4357,11 @@ module TencentCloud
       class DescribeConnectResourcesRequest < TencentCloud::Common::AbstractModel
         # @param Type: 连接源类型
         # @type Type: String
-        # @param SearchWord: 连接源名称的关键字查询
+        # @param SearchWord: 连接源名称的关键字查询,支持模糊匹配
         # @type SearchWord: String
         # @param Offset: 分页偏移量，默认为0
         # @type Offset: Integer
-        # @param Limit: 返回数量，默认为20，最大值为100
+        # @param Limit: 返回数量，默认为20，最大值为1000 (超过1000,则限制为1000)
         # @type Limit: Integer
         # @param ResourceRegion: 连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源)
         # @type ResourceRegion: String
@@ -4434,15 +4437,15 @@ module TencentCloud
 
       # DescribeConsumerGroup请求参数结构体
       class DescribeConsumerGroupRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id,通过DescribeInstances接口获取
         # @type InstanceId: String
-        # @param GroupName: 可选，用户需要查询的group名称。
+        # @param GroupName: 用户需要查询的group名称。
         # @type GroupName: String
-        # @param TopicName: 可选，用户需要查询的group中的对应的topic名称，如果指定了该参数，而group又未指定则忽略该参数。
+        # @param TopicName: 用户需要查询的group中的对应的topic名称，如果指定了该参数，而group又未指定则忽略该参数。
         # @type TopicName: String
-        # @param Limit: 本次返回个数限制，最大支持50
+        # @param Limit: 返回消费组的限制数量，最大支持50
         # @type Limit: Integer
-        # @param Offset: 偏移位置
+        # @param Offset: 消费组列表的起始偏移量
         # @type Offset: Integer
 
         attr_accessor :InstanceId, :GroupName, :TopicName, :Limit, :Offset
@@ -4730,7 +4733,7 @@ module TencentCloud
 
       # DescribeDatahubTasks请求参数结构体
       class DescribeDatahubTasksRequest < TencentCloud::Common::AbstractModel
-        # @param Limit: 返回数量，默认为20，最大值为100
+        # @param Limit: 返回数量，默认为20，最大值为100 (超过100限制为100)
         # @type Limit: Integer
         # @param Offset: 分页偏移量，默认为0
         # @type Offset: Integer
@@ -5017,9 +5020,9 @@ module TencentCloud
 
       # DescribeGroupInfo请求参数结构体
       class DescribeGroupInfoRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
         # @type InstanceId: String
-        # @param GroupList: Kafka 消费分组列表
+        # @param GroupList: Kafka 消费分组列表,可通过DescribeConsumerGroup接口获取
         # @type GroupList: Array
 
         attr_accessor :InstanceId, :GroupList
@@ -5185,7 +5188,7 @@ module TencentCloud
 
       # DescribeInstanceAttributes请求参数结构体
       class DescribeInstanceAttributesRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
         # @type InstanceId: String
 
         attr_accessor :InstanceId
@@ -5627,9 +5630,9 @@ module TencentCloud
 
       # DescribeTopicAttributes请求参数结构体
       class DescribeTopicAttributesRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id，可通过DescribeInstances接口获取。
         # @type InstanceId: String
-        # @param TopicName: 主题名称
+        # @param TopicName: 主题名称，可通过DescribeTopic接口获取。
         # @type TopicName: String
 
         attr_accessor :InstanceId, :TopicName
@@ -5670,19 +5673,19 @@ module TencentCloud
 
       # DescribeTopicDetail请求参数结构体
       class DescribeTopicDetailRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id，可通过DescribeInstances接口获取。
         # @type InstanceId: String
         # @param SearchWord: （过滤条件）按照topicName过滤，支持模糊查询
         # @type SearchWord: String
         # @param Offset: 偏移量，不填默认为0
         # @type Offset: Integer
-        # @param Limit: 返回数量，不填则默认 10，最大值20，取值要大于0
+        # @param Limit: 返回数量，不填则默认 20，取值要大于0
         # @type Limit: Integer
         # @param AclRuleName: Acl预设策略名称
         # @type AclRuleName: String
-        # @param OrderBy: 根据特定的属性排序(目前支持PartitionNum/CreateTime)
+        # @param OrderBy: 根据特定的属性排序(目前支持PartitionNum/CreateTime)，默认值为CreateTime。
         # @type OrderBy: String
-        # @param OrderType: 0-顺序、1-倒序
+        # @param OrderType: 0-顺序、1-倒序，默认值为0。
         # @type OrderType: Integer
         # @param Filters: 目前支持 ReplicaNum （副本数）筛选
         # @type Filters: Array
@@ -5744,7 +5747,7 @@ module TencentCloud
 
       # DescribeTopicFlowRanking请求参数结构体
       class DescribeTopicFlowRankingRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id，可通过DescribeInstances接口获取。
         # @type InstanceId: String
         # @param RankingType: 排行类别，PRO：Topic生产流量；CON：Topic消费流量
         # @type RankingType: String
@@ -5799,9 +5802,9 @@ module TencentCloud
 
       # DescribeTopicProduceConnection请求参数结构体
       class DescribeTopicProduceConnectionRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id，可通过DescribeInstances接口获取。
         # @type InstanceId: String
-        # @param TopicName: 主题名
+        # @param TopicName: 主题名，可通过DescribeTopic接口获取。
         # @type TopicName: String
 
         attr_accessor :InstanceId, :TopicName
@@ -5958,7 +5961,7 @@ module TencentCloud
         # @type TopicName: String
         # @param Offset: 偏移量，不填默认为0
         # @type Offset: Integer
-        # @param Limit: 返回数量，不填则默认10，最大值20。
+        # @param Limit: 返回数量，默认值为20，必须大于0。
         # @type Limit: Integer
         # @param OutOfSyncReplicaOnly: 仅筛选未同步副本
         # @type OutOfSyncReplicaOnly: Boolean
@@ -8985,17 +8988,17 @@ module TencentCloud
 
       # ModifyGroupOffsets请求参数结构体
       class ModifyGroupOffsetsRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: ckafka集群实例Id
+        # @param InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
         # @type InstanceId: String
-        # @param Group: 消费分组名称
+        # @param Group: 消费分组名称,可通过DescribeConsumerGroup接口获取
         # @type Group: String
-        # @param Strategy: 重置offset的策略，入参含义 0. 对齐shift-by参数，代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset)，代表把offset移动到指定的offset位置
+        # @param Strategy: 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
         # @type Strategy: Integer
-        # @param Topics: 需要重置的主题名列表， 不填表示全部
+        # @param Topics: 需要重置的主题名列表
         # @type Topics: Array
         # @param Shift: 当strategy为0时，必须包含该字段，可以大于零代表会把offset向后移动shift条，小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift)，需要注意的是如果新的offset小于partition的earliest则会设置为earliest，如果大于partition 的latest则会设置为latest
         # @type Shift: Integer
-        # @param ShiftTimestamp: 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的时，如果指定的时间不存在消息，则获取最末尾的offset。
+        # @param ShiftTimestamp: 单位ms。当strategy为1时，必须包含该字段，其中-2表示重置offset到最开始的位置，-1表示重置到最新的位置(相当于清空)，其它值则代表指定的时间，会获取topic中指定时间的offset然后进行重置，需要注意的是，如果指定的时间不存在消息，则获取最末尾的offset。
         # @type ShiftTimestamp: Integer
         # @param Offset: 需要重新设置的offset位置。当strategy为2，必须包含该字段。
         # @type Offset: Integer
@@ -9367,7 +9370,7 @@ module TencentCloud
         # @type RetentionMs: Integer
         # @param MaxMessageBytes: 主题消息最大值，单位为 Byte，最大值为12582912Byte（即12MB）。
         # @type MaxMessageBytes: Integer
-        # @param SegmentMs: Segment 分片滚动的时长，单位：ms，当前最小为300000ms。
+        # @param SegmentMs: Segment 分片滚动的时长，单位：ms，当前最小值86400000ms。
         # @type SegmentMs: Integer
         # @param CleanUpPolicy: 消息删除策略，可以选择delete 或者compact
         # @type CleanUpPolicy: String
@@ -11218,7 +11221,7 @@ module TencentCloud
       class TopicAttributesResponse < TencentCloud::Common::AbstractModel
         # @param TopicId: 主题 ID
         # @type TopicId: String
-        # @param CreateTime: 创建时间
+        # @param CreateTime: 创建时间的秒级时间戳
         # @type CreateTime: Integer
         # @param Note: 主题备注
         # @type Note: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ckafka
 version: !ruby/object:Gem::Version
-  version: 3.0.1135
+  version: 3.0.1138
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-09-02 00:00:00.000000000 Z
+date: 2025-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common