tencentcloud-sdk-python 3.0.1456__py2.py3-none-any.whl → 3.0.1458__py2.py3-none-any.whl

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.
Files changed (40) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/apm/v20210622/models.py +15 -0
  3. tencentcloud/asr/v20190614/models.py +4 -2
  4. tencentcloud/bh/v20230418/models.py +15 -0
  5. tencentcloud/ccc/v20200210/ccc_client.py +46 -0
  6. tencentcloud/ccc/v20200210/models.py +927 -53
  7. tencentcloud/cdwpg/v20201230/models.py +30 -0
  8. tencentcloud/ckafka/v20190819/models.py +98 -90
  9. tencentcloud/cls/v20201016/models.py +20 -12
  10. tencentcloud/csip/v20221121/models.py +79 -4
  11. tencentcloud/dlc/v20210125/models.py +619 -0
  12. tencentcloud/dnspod/v20210323/models.py +15 -0
  13. tencentcloud/es/v20180416/errorcodes.py +6 -0
  14. tencentcloud/faceid/v20180301/models.py +19 -0
  15. tencentcloud/gs/v20191118/gs_client.py +23 -0
  16. tencentcloud/gs/v20191118/models.py +64 -0
  17. tencentcloud/ioa/v20220601/ioa_client.py +92 -0
  18. tencentcloud/ioa/v20220601/models.py +1723 -169
  19. tencentcloud/iotexplorer/v20190423/models.py +240 -0
  20. tencentcloud/lke/v20231130/models.py +66 -4
  21. tencentcloud/mongodb/v20190725/errorcodes.py +3 -0
  22. tencentcloud/mongodb/v20190725/models.py +79 -0
  23. tencentcloud/mongodb/v20190725/mongodb_client.py +23 -0
  24. tencentcloud/ocr/v20181119/models.py +4 -4
  25. tencentcloud/ocr/v20181119/ocr_client.py +33 -16
  26. tencentcloud/omics/v20221128/errorcodes.py +9 -0
  27. tencentcloud/omics/v20221128/models.py +300 -11
  28. tencentcloud/redis/v20180412/models.py +193 -50
  29. tencentcloud/redis/v20180412/redis_client.py +1 -1
  30. tencentcloud/tcaplusdb/v20190823/models.py +30 -0
  31. tencentcloud/tione/v20211111/models.py +85 -0
  32. tencentcloud/trtc/v20190722/models.py +157 -0
  33. tencentcloud/vdb/v20230616/models.py +2 -0
  34. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  35. tencentcloud/vpc/v20170312/models.py +45 -0
  36. {tencentcloud_sdk_python-3.0.1456.dist-info → tencentcloud_sdk_python-3.0.1458.dist-info}/METADATA +1 -1
  37. {tencentcloud_sdk_python-3.0.1456.dist-info → tencentcloud_sdk_python-3.0.1458.dist-info}/RECORD +40 -40
  38. {tencentcloud_sdk_python-3.0.1456.dist-info → tencentcloud_sdk_python-3.0.1458.dist-info}/LICENSE +0 -0
  39. {tencentcloud_sdk_python-3.0.1456.dist-info → tencentcloud_sdk_python-3.0.1458.dist-info}/WHEEL +0 -0
  40. {tencentcloud_sdk_python-3.0.1456.dist-info → tencentcloud_sdk_python-3.0.1458.dist-info}/top_level.txt +0 -0
@@ -2839,7 +2839,7 @@ class Config(AbstractModel):
2839
2839
 
2840
2840
  def __init__(self):
2841
2841
  r"""
2842
- :param _Retention: 消息保留时间
2842
+ :param _Retention: 消息保留时间,单位ms。
2843
2843
  :type Retention: int
2844
2844
  :param _MinInsyncReplicas: 最小同步复制数
2845
2845
  注意:此字段可能返回 null,表示取不到有效值。
@@ -2848,22 +2848,22 @@ class Config(AbstractModel):
2848
2848
  delete:日志按保存时间删除;compact:日志按 key 压缩;compact, delete:日志按 key 压缩且会保存时间删除。
2849
2849
  注意:此字段可能返回 null,表示取不到有效值。
2850
2850
  :type CleanUpPolicy: str
2851
- :param _SegmentMs: Segment 分片滚动的时长
2851
+ :param _SegmentMs: Segment 分片滚动的时长,单位ms。
2852
2852
  注意:此字段可能返回 null,表示取不到有效值。
2853
2853
  :type SegmentMs: int
2854
2854
  :param _UncleanLeaderElectionEnable: 0表示 false。 1表示 true。
2855
2855
  注意:此字段可能返回 null,表示取不到有效值。
2856
2856
  :type UncleanLeaderElectionEnable: int
2857
- :param _SegmentBytes: Segment 分片滚动的字节数
2857
+ :param _SegmentBytes: Segment 分片滚动的字节数,单位bytes
2858
2858
  注意:此字段可能返回 null,表示取不到有效值。
2859
2859
  :type SegmentBytes: int
2860
- :param _MaxMessageBytes: 最大消息字节数
2860
+ :param _MaxMessageBytes: 最大消息字节数,单位bytes
2861
2861
  注意:此字段可能返回 null,表示取不到有效值。
2862
2862
  :type MaxMessageBytes: int
2863
- :param _RetentionBytes: 消息保留文件大小
2863
+ :param _RetentionBytes: 消息保留文件大小,单位Bytes
2864
2864
  注意:此字段可能返回 null,表示取不到有效值。
2865
2865
  :type RetentionBytes: int
2866
- :param _LogMsgTimestampType: 消息保存的时间类型
2866
+ :param _LogMsgTimestampType: 消息保存的时间类型,CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。
2867
2867
  注意:此字段可能返回 null,表示取不到有效值。
2868
2868
  :type LogMsgTimestampType: str
2869
2869
  """
@@ -2879,7 +2879,7 @@ delete:日志按保存时间删除;compact:日志按 key 压缩;compact,
2879
2879
 
2880
2880
  @property
2881
2881
  def Retention(self):
2882
- """消息保留时间
2882
+ """消息保留时间,单位ms。
2883
2883
  :rtype: int
2884
2884
  """
2885
2885
  return self._Retention
@@ -2915,7 +2915,7 @@ delete:日志按保存时间删除;compact:日志按 key 压缩;compact,
2915
2915
 
2916
2916
  @property
2917
2917
  def SegmentMs(self):
2918
- """Segment 分片滚动的时长
2918
+ """Segment 分片滚动的时长,单位ms。
2919
2919
  注意:此字段可能返回 null,表示取不到有效值。
2920
2920
  :rtype: int
2921
2921
  """
@@ -2939,7 +2939,7 @@ delete:日志按保存时间删除;compact:日志按 key 压缩;compact,
2939
2939
 
2940
2940
  @property
2941
2941
  def SegmentBytes(self):
2942
- """Segment 分片滚动的字节数
2942
+ """Segment 分片滚动的字节数,单位bytes
2943
2943
  注意:此字段可能返回 null,表示取不到有效值。
2944
2944
  :rtype: int
2945
2945
  """
@@ -2951,7 +2951,7 @@ delete:日志按保存时间删除;compact:日志按 key 压缩;compact,
2951
2951
 
2952
2952
  @property
2953
2953
  def MaxMessageBytes(self):
2954
- """最大消息字节数
2954
+ """最大消息字节数,单位bytes
2955
2955
  注意:此字段可能返回 null,表示取不到有效值。
2956
2956
  :rtype: int
2957
2957
  """
@@ -2963,7 +2963,7 @@ delete:日志按保存时间删除;compact:日志按 key 压缩;compact,
2963
2963
 
2964
2964
  @property
2965
2965
  def RetentionBytes(self):
2966
- """消息保留文件大小
2966
+ """消息保留文件大小,单位Bytes
2967
2967
  注意:此字段可能返回 null,表示取不到有效值。
2968
2968
  :rtype: int
2969
2969
  """
@@ -2975,7 +2975,7 @@ delete:日志按保存时间删除;compact:日志按 key 压缩;compact,
2975
2975
 
2976
2976
  @property
2977
2977
  def LogMsgTimestampType(self):
2978
- """消息保存的时间类型
2978
+ """消息保存的时间类型,CreateTime表示生产者创建这条消息的时间;LogAppendTime表示broker接收到消息的时间。
2979
2979
  注意:此字段可能返回 null,表示取不到有效值。
2980
2980
  :rtype: str
2981
2981
  """
@@ -5388,7 +5388,7 @@ class CreateInstancePreRequest(AbstractModel):
5388
5388
  :type InstanceName: str
5389
5389
  :param _ZoneId: 可用区。当购买多可用区实例时,当前参数为主可用区。 [查看可用区](https://cloud.tencent.com/document/product/597/55246)
5390
5390
  :type ZoneId: int
5391
- :param _Period: 预付费购买时长,例如 "1m",就是一个月
5391
+ :param _Period: 预付费购买时长,例如 "1m",就是一个月,取值范围 1m~36m
5392
5392
  :type Period: str
5393
5393
  :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。
5394
5394
  :type InstanceType: int
@@ -5476,7 +5476,7 @@ class CreateInstancePreRequest(AbstractModel):
5476
5476
 
5477
5477
  @property
5478
5478
  def Period(self):
5479
- """预付费购买时长,例如 "1m",就是一个月
5479
+ """预付费购买时长,例如 "1m",就是一个月,取值范围 1m~36m
5480
5480
  :rtype: str
5481
5481
  """
5482
5482
  return self._Period
@@ -6475,7 +6475,11 @@ class CreateRouteRequest(AbstractModel):
6475
6475
  :type VpcId: str
6476
6476
  :param _SubnetId: vpc子网id,当vipType为3时必填
6477
6477
  :type SubnetId: str
6478
- :param _AccessType: 访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0
6478
+ :param _AccessType: 访问类型:0-plaintext;1-sasl_plaintext;3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512 默认为0
6479
+ vipType=3,支持 0,1,3,4,5
6480
+ vipType=7,支持0,1,3
6481
+ vipType=1,支持1,3
6482
+
6479
6483
  :type AccessType: int
6480
6484
  :param _AuthFlag: 是否需要权限管理,该字段已废弃
6481
6485
  :type AuthFlag: int
@@ -6542,7 +6546,11 @@ class CreateRouteRequest(AbstractModel):
6542
6546
 
6543
6547
  @property
6544
6548
  def AccessType(self):
6545
- """访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0
6549
+ """访问类型:0-plaintext;1-sasl_plaintext;3-sasl_ssl; 4-sasl_scram_sha_256; 5-sasl_scram_sha_512 默认为0
6550
+ vipType=3,支持 0,1,3,4,5
6551
+ vipType=7,支持0,1,3
6552
+ vipType=1,支持1,3
6553
+
6546
6554
  :rtype: int
6547
6555
  """
6548
6556
  return self._AccessType
@@ -6873,7 +6881,7 @@ class CreateTopicRequest(AbstractModel):
6873
6881
 
6874
6882
  def __init__(self):
6875
6883
  r"""
6876
- :param _InstanceId: 实例Id
6884
+ :param _InstanceId: 实例Id,可通过DescribeInstances接口获取。
6877
6885
  :type InstanceId: str
6878
6886
  :param _TopicName: 只能包含字母、数字、下划线、“-”、“.”
6879
6887
  :type TopicName: str
@@ -6887,23 +6895,23 @@ class CreateTopicRequest(AbstractModel):
6887
6895
  :type IpWhiteList: list of str
6888
6896
  :param _CleanUpPolicy: 清理日志策略,日志清理模式,默认为"delete"。"delete":日志按保存时间删除,"compact":日志按 key 压缩,"compact, delete":日志按 key 压缩且会按保存时间删除。
6889
6897
  :type CleanUpPolicy: str
6890
- :param _Note: 主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
6898
+ :param _Note: 主题备注,是一个不超过 64 个字符的字符串,可以用字母和数字为首字符,剩余部分可以包含字母、数字和横划线(-)
6891
6899
  :type Note: str
6892
- :param _MinInsyncReplicas: 默认为1
6900
+ :param _MinInsyncReplicas: 最小同步副本数,默认为1
6893
6901
  :type MinInsyncReplicas: int
6894
- :param _UncleanLeaderElectionEnable: 是否允许未同步的副本选为leader,false:不允许,true:允许,默认不允许
6902
+ :param _UncleanLeaderElectionEnable: 是否允许未同步的副本选为leader,0:不允许,1:允许,默认不允许
6895
6903
  :type UncleanLeaderElectionEnable: int
6896
- :param _RetentionMs: 可选参数。消息保留时间,单位ms,当前最小值为60000ms
6904
+ :param _RetentionMs: 可选参数。消息保留时间,单位ms,当前最小值为60000。默认值为7200000ms(2小时),最大值为7776000000 ms(90天)。
6897
6905
  :type RetentionMs: int
6898
- :param _SegmentMs: Segment分片滚动的时长,单位ms,当前最小为3600000ms
6906
+ :param _SegmentMs: Segment分片滚动的时长,单位ms,最小值为86400000ms(1天)。
6899
6907
  :type SegmentMs: int
6900
- :param _MaxMessageBytes: 主题消息最大值,单位为 Byte,最小值1024Byte(即1KB),最大值为12582912Byte(即12MB)
6908
+ :param _MaxMessageBytes: 主题消息最大值,单位为 Byte,最小值1024Bytes(即1KB),最大值为12582912Bytes(即12MB)
6901
6909
  :type MaxMessageBytes: int
6902
6910
  :param _EnableAclRule: 预设ACL规则, 1:打开 0:关闭,默认不打开
6903
6911
  :type EnableAclRule: int
6904
6912
  :param _AclRuleName: 预设ACL规则的名称
6905
6913
  :type AclRuleName: str
6906
- :param _RetentionBytes: 可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
6914
+ :param _RetentionBytes: 可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。
6907
6915
  :type RetentionBytes: int
6908
6916
  :param _Tags: 标签列表
6909
6917
  :type Tags: list of Tag
@@ -6928,7 +6936,7 @@ class CreateTopicRequest(AbstractModel):
6928
6936
 
6929
6937
  @property
6930
6938
  def InstanceId(self):
6931
- """实例Id
6939
+ """实例Id,可通过DescribeInstances接口获取。
6932
6940
  :rtype: str
6933
6941
  """
6934
6942
  return self._InstanceId
@@ -7005,7 +7013,7 @@ class CreateTopicRequest(AbstractModel):
7005
7013
 
7006
7014
  @property
7007
7015
  def Note(self):
7008
- """主题备注,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
7016
+ """主题备注,是一个不超过 64 个字符的字符串,可以用字母和数字为首字符,剩余部分可以包含字母、数字和横划线(-)
7009
7017
  :rtype: str
7010
7018
  """
7011
7019
  return self._Note
@@ -7016,7 +7024,7 @@ class CreateTopicRequest(AbstractModel):
7016
7024
 
7017
7025
  @property
7018
7026
  def MinInsyncReplicas(self):
7019
- """默认为1
7027
+ """最小同步副本数,默认为1
7020
7028
  :rtype: int
7021
7029
  """
7022
7030
  return self._MinInsyncReplicas
@@ -7027,7 +7035,7 @@ class CreateTopicRequest(AbstractModel):
7027
7035
 
7028
7036
  @property
7029
7037
  def UncleanLeaderElectionEnable(self):
7030
- """是否允许未同步的副本选为leader,false:不允许,true:允许,默认不允许
7038
+ """是否允许未同步的副本选为leader,0:不允许,1:允许,默认不允许
7031
7039
  :rtype: int
7032
7040
  """
7033
7041
  return self._UncleanLeaderElectionEnable
@@ -7038,7 +7046,7 @@ class CreateTopicRequest(AbstractModel):
7038
7046
 
7039
7047
  @property
7040
7048
  def RetentionMs(self):
7041
- """可选参数。消息保留时间,单位ms,当前最小值为60000ms
7049
+ """可选参数。消息保留时间,单位ms,当前最小值为60000。默认值为7200000ms(2小时),最大值为7776000000 ms(90天)。
7042
7050
  :rtype: int
7043
7051
  """
7044
7052
  return self._RetentionMs
@@ -7049,7 +7057,7 @@ class CreateTopicRequest(AbstractModel):
7049
7057
 
7050
7058
  @property
7051
7059
  def SegmentMs(self):
7052
- """Segment分片滚动的时长,单位ms,当前最小为3600000ms
7060
+ """Segment分片滚动的时长,单位ms,最小值为86400000ms(1天)。
7053
7061
  :rtype: int
7054
7062
  """
7055
7063
  return self._SegmentMs
@@ -7060,7 +7068,7 @@ class CreateTopicRequest(AbstractModel):
7060
7068
 
7061
7069
  @property
7062
7070
  def MaxMessageBytes(self):
7063
- """主题消息最大值,单位为 Byte,最小值1024Byte(即1KB),最大值为12582912Byte(即12MB)
7071
+ """主题消息最大值,单位为 Byte,最小值1024Bytes(即1KB),最大值为12582912Bytes(即12MB)
7064
7072
  :rtype: int
7065
7073
  """
7066
7074
  return self._MaxMessageBytes
@@ -7093,7 +7101,7 @@ class CreateTopicRequest(AbstractModel):
7093
7101
 
7094
7102
  @property
7095
7103
  def RetentionBytes(self):
7096
- """可选, 保留文件大小. 默认为-1,单位bytes, 当前最小值为1048576B
7104
+ """可选, 保留文件大小. 默认为-1,单位Byte, 当前最小值为1073741824。
7097
7105
  :rtype: int
7098
7106
  """
7099
7107
  return self._RetentionBytes
@@ -11291,7 +11299,7 @@ class DescribeConnectResourceResponse(AbstractModel):
11291
11299
 
11292
11300
  def __init__(self):
11293
11301
  r"""
11294
- :param _Result: 连接源的Id
11302
+ :param _Result: 连接源数据信息
11295
11303
  :type Result: :class:`tencentcloud.ckafka.v20190819.models.DescribeConnectResourceResp`
11296
11304
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11297
11305
  :type RequestId: str
@@ -11301,7 +11309,7 @@ class DescribeConnectResourceResponse(AbstractModel):
11301
11309
 
11302
11310
  @property
11303
11311
  def Result(self):
11304
- """连接源的Id
11312
+ """连接源数据信息
11305
11313
  :rtype: :class:`tencentcloud.ckafka.v20190819.models.DescribeConnectResourceResp`
11306
11314
  """
11307
11315
  return self._Result
@@ -11338,11 +11346,11 @@ class DescribeConnectResourcesRequest(AbstractModel):
11338
11346
  r"""
11339
11347
  :param _Type: 连接源类型
11340
11348
  :type Type: str
11341
- :param _SearchWord: 连接源名称的关键字查询
11349
+ :param _SearchWord: 连接源名称的关键字查询,支持模糊匹配
11342
11350
  :type SearchWord: str
11343
11351
  :param _Offset: 分页偏移量,默认为0
11344
11352
  :type Offset: int
11345
- :param _Limit: 返回数量,默认为20,最大值为100
11353
+ :param _Limit: 返回数量,默认为20,最大值为1000 (超过1000,则限制为1000)
11346
11354
  :type Limit: int
11347
11355
  :param _ResourceRegion: 连接源的关键字查询, 根据地域查询本地域内连接管理列表中的连接(仅支持包含region输入的连接源)
11348
11356
  :type ResourceRegion: str
@@ -11366,7 +11374,7 @@ class DescribeConnectResourcesRequest(AbstractModel):
11366
11374
 
11367
11375
  @property
11368
11376
  def SearchWord(self):
11369
- """连接源名称的关键字查询
11377
+ """连接源名称的关键字查询,支持模糊匹配
11370
11378
  :rtype: str
11371
11379
  """
11372
11380
  return self._SearchWord
@@ -11388,7 +11396,7 @@ class DescribeConnectResourcesRequest(AbstractModel):
11388
11396
 
11389
11397
  @property
11390
11398
  def Limit(self):
11391
- """返回数量,默认为20,最大值为100
11399
+ """返回数量,默认为20,最大值为1000 (超过1000,则限制为1000)
11392
11400
  :rtype: int
11393
11401
  """
11394
11402
  return self._Limit
@@ -11533,15 +11541,15 @@ class DescribeConsumerGroupRequest(AbstractModel):
11533
11541
 
11534
11542
  def __init__(self):
11535
11543
  r"""
11536
- :param _InstanceId: ckafka集群实例Id
11544
+ :param _InstanceId: ckafka集群实例Id,通过DescribeInstances接口获取
11537
11545
  :type InstanceId: str
11538
- :param _GroupName: 可选,用户需要查询的group名称。
11546
+ :param _GroupName: 用户需要查询的group名称。
11539
11547
  :type GroupName: str
11540
- :param _TopicName: 可选,用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
11548
+ :param _TopicName: 用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
11541
11549
  :type TopicName: str
11542
- :param _Limit: 本次返回个数限制,最大支持50
11550
+ :param _Limit: 返回消费组的限制数量,最大支持50
11543
11551
  :type Limit: int
11544
- :param _Offset: 偏移位置
11552
+ :param _Offset: 消费组列表的起始偏移量
11545
11553
  :type Offset: int
11546
11554
  """
11547
11555
  self._InstanceId = None
@@ -11552,7 +11560,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
11552
11560
 
11553
11561
  @property
11554
11562
  def InstanceId(self):
11555
- """ckafka集群实例Id
11563
+ """ckafka集群实例Id,通过DescribeInstances接口获取
11556
11564
  :rtype: str
11557
11565
  """
11558
11566
  return self._InstanceId
@@ -11563,7 +11571,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
11563
11571
 
11564
11572
  @property
11565
11573
  def GroupName(self):
11566
- """可选,用户需要查询的group名称。
11574
+ """用户需要查询的group名称。
11567
11575
  :rtype: str
11568
11576
  """
11569
11577
  return self._GroupName
@@ -11574,7 +11582,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
11574
11582
 
11575
11583
  @property
11576
11584
  def TopicName(self):
11577
- """可选,用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
11585
+ """用户需要查询的group中的对应的topic名称,如果指定了该参数,而group又未指定则忽略该参数。
11578
11586
  :rtype: str
11579
11587
  """
11580
11588
  return self._TopicName
@@ -11585,7 +11593,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
11585
11593
 
11586
11594
  @property
11587
11595
  def Limit(self):
11588
- """本次返回个数限制,最大支持50
11596
+ """返回消费组的限制数量,最大支持50
11589
11597
  :rtype: int
11590
11598
  """
11591
11599
  return self._Limit
@@ -11596,7 +11604,7 @@ class DescribeConsumerGroupRequest(AbstractModel):
11596
11604
 
11597
11605
  @property
11598
11606
  def Offset(self):
11599
- """偏移位置
11607
+ """消费组列表的起始偏移量
11600
11608
  :rtype: int
11601
11609
  """
11602
11610
  return self._Offset
@@ -12275,7 +12283,7 @@ class DescribeDatahubTasksRequest(AbstractModel):
12275
12283
 
12276
12284
  def __init__(self):
12277
12285
  r"""
12278
- :param _Limit: 返回数量,默认为20,最大值为100
12286
+ :param _Limit: 返回数量,默认为20,最大值为100 (超过100限制为100)
12279
12287
  :type Limit: int
12280
12288
  :param _Offset: 分页偏移量,默认为0
12281
12289
  :type Offset: int
@@ -12300,7 +12308,7 @@ class DescribeDatahubTasksRequest(AbstractModel):
12300
12308
 
12301
12309
  @property
12302
12310
  def Limit(self):
12303
- """返回数量,默认为20,最大值为100
12311
+ """返回数量,默认为20,最大值为100 (超过100限制为100)
12304
12312
  :rtype: int
12305
12313
  """
12306
12314
  return self._Limit
@@ -13017,9 +13025,9 @@ class DescribeGroupInfoRequest(AbstractModel):
13017
13025
 
13018
13026
  def __init__(self):
13019
13027
  r"""
13020
- :param _InstanceId: ckafka集群实例Id
13028
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
13021
13029
  :type InstanceId: str
13022
- :param _GroupList: Kafka 消费分组列表
13030
+ :param _GroupList: Kafka 消费分组列表,可通过DescribeConsumerGroup接口获取
13023
13031
  :type GroupList: list of str
13024
13032
  """
13025
13033
  self._InstanceId = None
@@ -13027,7 +13035,7 @@ class DescribeGroupInfoRequest(AbstractModel):
13027
13035
 
13028
13036
  @property
13029
13037
  def InstanceId(self):
13030
- """ckafka集群实例Id
13038
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
13031
13039
  :rtype: str
13032
13040
  """
13033
13041
  return self._InstanceId
@@ -13038,7 +13046,7 @@ class DescribeGroupInfoRequest(AbstractModel):
13038
13046
 
13039
13047
  @property
13040
13048
  def GroupList(self):
13041
- """Kafka 消费分组列表
13049
+ """Kafka 消费分组列表,可通过DescribeConsumerGroup接口获取
13042
13050
  :rtype: list of str
13043
13051
  """
13044
13052
  return self._GroupList
@@ -13418,14 +13426,14 @@ class DescribeInstanceAttributesRequest(AbstractModel):
13418
13426
 
13419
13427
  def __init__(self):
13420
13428
  r"""
13421
- :param _InstanceId: ckafka集群实例Id
13429
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
13422
13430
  :type InstanceId: str
13423
13431
  """
13424
13432
  self._InstanceId = None
13425
13433
 
13426
13434
  @property
13427
13435
  def InstanceId(self):
13428
- """ckafka集群实例Id
13436
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
13429
13437
  :rtype: str
13430
13438
  """
13431
13439
  return self._InstanceId
@@ -14442,9 +14450,9 @@ class DescribeTopicAttributesRequest(AbstractModel):
14442
14450
 
14443
14451
  def __init__(self):
14444
14452
  r"""
14445
- :param _InstanceId: ckafka集群实例Id
14453
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
14446
14454
  :type InstanceId: str
14447
- :param _TopicName: 主题名称
14455
+ :param _TopicName: 主题名称,可通过DescribeTopic接口获取。
14448
14456
  :type TopicName: str
14449
14457
  """
14450
14458
  self._InstanceId = None
@@ -14452,7 +14460,7 @@ class DescribeTopicAttributesRequest(AbstractModel):
14452
14460
 
14453
14461
  @property
14454
14462
  def InstanceId(self):
14455
- """ckafka集群实例Id
14463
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
14456
14464
  :rtype: str
14457
14465
  """
14458
14466
  return self._InstanceId
@@ -14463,7 +14471,7 @@ class DescribeTopicAttributesRequest(AbstractModel):
14463
14471
 
14464
14472
  @property
14465
14473
  def TopicName(self):
14466
- """主题名称
14474
+ """主题名称,可通过DescribeTopic接口获取。
14467
14475
  :rtype: str
14468
14476
  """
14469
14477
  return self._TopicName
@@ -14538,19 +14546,19 @@ class DescribeTopicDetailRequest(AbstractModel):
14538
14546
 
14539
14547
  def __init__(self):
14540
14548
  r"""
14541
- :param _InstanceId: ckafka集群实例Id
14549
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
14542
14550
  :type InstanceId: str
14543
14551
  :param _SearchWord: (过滤条件)按照topicName过滤,支持模糊查询
14544
14552
  :type SearchWord: str
14545
14553
  :param _Offset: 偏移量,不填默认为0
14546
14554
  :type Offset: int
14547
- :param _Limit: 返回数量,不填则默认 10,最大值20,取值要大于0
14555
+ :param _Limit: 返回数量,不填则默认 20,取值要大于0
14548
14556
  :type Limit: int
14549
14557
  :param _AclRuleName: Acl预设策略名称
14550
14558
  :type AclRuleName: str
14551
- :param _OrderBy: 根据特定的属性排序(目前支持PartitionNum/CreateTime)
14559
+ :param _OrderBy: 根据特定的属性排序(目前支持PartitionNum/CreateTime),默认值为CreateTime。
14552
14560
  :type OrderBy: str
14553
- :param _OrderType: 0-顺序、1-倒序
14561
+ :param _OrderType: 0-顺序、1-倒序,默认值为0。
14554
14562
  :type OrderType: int
14555
14563
  :param _Filters: 目前支持 ReplicaNum (副本数)筛选
14556
14564
  :type Filters: list of Filter
@@ -14566,7 +14574,7 @@ class DescribeTopicDetailRequest(AbstractModel):
14566
14574
 
14567
14575
  @property
14568
14576
  def InstanceId(self):
14569
- """ckafka集群实例Id
14577
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
14570
14578
  :rtype: str
14571
14579
  """
14572
14580
  return self._InstanceId
@@ -14599,7 +14607,7 @@ class DescribeTopicDetailRequest(AbstractModel):
14599
14607
 
14600
14608
  @property
14601
14609
  def Limit(self):
14602
- """返回数量,不填则默认 10,最大值20,取值要大于0
14610
+ """返回数量,不填则默认 20,取值要大于0
14603
14611
  :rtype: int
14604
14612
  """
14605
14613
  return self._Limit
@@ -14621,7 +14629,7 @@ class DescribeTopicDetailRequest(AbstractModel):
14621
14629
 
14622
14630
  @property
14623
14631
  def OrderBy(self):
14624
- """根据特定的属性排序(目前支持PartitionNum/CreateTime)
14632
+ """根据特定的属性排序(目前支持PartitionNum/CreateTime),默认值为CreateTime。
14625
14633
  :rtype: str
14626
14634
  """
14627
14635
  return self._OrderBy
@@ -14632,7 +14640,7 @@ class DescribeTopicDetailRequest(AbstractModel):
14632
14640
 
14633
14641
  @property
14634
14642
  def OrderType(self):
14635
- """0-顺序、1-倒序
14643
+ """0-顺序、1-倒序,默认值为0。
14636
14644
  :rtype: int
14637
14645
  """
14638
14646
  return self._OrderType
@@ -14729,7 +14737,7 @@ class DescribeTopicFlowRankingRequest(AbstractModel):
14729
14737
 
14730
14738
  def __init__(self):
14731
14739
  r"""
14732
- :param _InstanceId: ckafka集群实例Id
14740
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
14733
14741
  :type InstanceId: str
14734
14742
  :param _RankingType: 排行类别,PRO:Topic生产流量;CON:Topic消费流量
14735
14743
  :type RankingType: str
@@ -14748,7 +14756,7 @@ class DescribeTopicFlowRankingRequest(AbstractModel):
14748
14756
 
14749
14757
  @property
14750
14758
  def InstanceId(self):
14751
- """ckafka集群实例Id
14759
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
14752
14760
  :rtype: str
14753
14761
  """
14754
14762
  return self._InstanceId
@@ -14870,9 +14878,9 @@ class DescribeTopicProduceConnectionRequest(AbstractModel):
14870
14878
 
14871
14879
  def __init__(self):
14872
14880
  r"""
14873
- :param _InstanceId: ckafka集群实例Id
14881
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
14874
14882
  :type InstanceId: str
14875
- :param _TopicName: 主题名
14883
+ :param _TopicName: 主题名,可通过DescribeTopic接口获取。
14876
14884
  :type TopicName: str
14877
14885
  """
14878
14886
  self._InstanceId = None
@@ -14880,7 +14888,7 @@ class DescribeTopicProduceConnectionRequest(AbstractModel):
14880
14888
 
14881
14889
  @property
14882
14890
  def InstanceId(self):
14883
- """ckafka集群实例Id
14891
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
14884
14892
  :rtype: str
14885
14893
  """
14886
14894
  return self._InstanceId
@@ -14891,7 +14899,7 @@ class DescribeTopicProduceConnectionRequest(AbstractModel):
14891
14899
 
14892
14900
  @property
14893
14901
  def TopicName(self):
14894
- """主题名
14902
+ """主题名,可通过DescribeTopic接口获取。
14895
14903
  :rtype: str
14896
14904
  """
14897
14905
  return self._TopicName
@@ -15242,7 +15250,7 @@ class DescribeTopicSyncReplicaRequest(AbstractModel):
15242
15250
  :type TopicName: str
15243
15251
  :param _Offset: 偏移量,不填默认为0
15244
15252
  :type Offset: int
15245
- :param _Limit: 返回数量,不填则默认10,最大值20。
15253
+ :param _Limit: 返回数量,默认值为20,必须大于0
15246
15254
  :type Limit: int
15247
15255
  :param _OutOfSyncReplicaOnly: 仅筛选未同步副本
15248
15256
  :type OutOfSyncReplicaOnly: bool
@@ -15288,7 +15296,7 @@ class DescribeTopicSyncReplicaRequest(AbstractModel):
15288
15296
 
15289
15297
  @property
15290
15298
  def Limit(self):
15291
- """返回数量,不填则默认10,最大值20。
15299
+ """返回数量,默认值为20,必须大于0
15292
15300
  :rtype: int
15293
15301
  """
15294
15302
  return self._Limit
@@ -23651,17 +23659,17 @@ class ModifyGroupOffsetsRequest(AbstractModel):
23651
23659
 
23652
23660
  def __init__(self):
23653
23661
  r"""
23654
- :param _InstanceId: ckafka集群实例Id
23662
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
23655
23663
  :type InstanceId: str
23656
- :param _Group: 消费分组名称
23664
+ :param _Group: 消费分组名称,可通过DescribeConsumerGroup接口获取
23657
23665
  :type Group: str
23658
- :param _Strategy: 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
23666
+ :param _Strategy: 重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
23659
23667
  :type Strategy: int
23660
- :param _Topics: 需要重置的主题名列表, 不填表示全部
23668
+ :param _Topics: 需要重置的主题名列表
23661
23669
  :type Topics: list of str
23662
23670
  :param _Shift: 当strategy为0时,必须包含该字段,可以大于零代表会把offset向后移动shift条,小于零则将offset向前回溯shift条数。正确重置后新的offset应该是(old_offset + shift),需要注意的是如果新的offset小于partition的earliest则会设置为earliest,如果大于partition 的latest则会设置为latest
23663
23671
  :type Shift: int
23664
- :param _ShiftTimestamp: 单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的时,如果指定的时间不存在消息,则获取最末尾的offset。
23672
+ :param _ShiftTimestamp: 单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的是,如果指定的时间不存在消息,则获取最末尾的offset。
23665
23673
  :type ShiftTimestamp: int
23666
23674
  :param _Offset: 需要重新设置的offset位置。当strategy为2,必须包含该字段。
23667
23675
  :type Offset: int
@@ -23679,7 +23687,7 @@ class ModifyGroupOffsetsRequest(AbstractModel):
23679
23687
 
23680
23688
  @property
23681
23689
  def InstanceId(self):
23682
- """ckafka集群实例Id
23690
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
23683
23691
  :rtype: str
23684
23692
  """
23685
23693
  return self._InstanceId
@@ -23690,7 +23698,7 @@ class ModifyGroupOffsetsRequest(AbstractModel):
23690
23698
 
23691
23699
  @property
23692
23700
  def Group(self):
23693
- """消费分组名称
23701
+ """消费分组名称,可通过DescribeConsumerGroup接口获取
23694
23702
  :rtype: str
23695
23703
  """
23696
23704
  return self._Group
@@ -23701,7 +23709,7 @@ class ModifyGroupOffsetsRequest(AbstractModel):
23701
23709
 
23702
23710
  @property
23703
23711
  def Strategy(self):
23704
- """重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
23712
+ """重置offset的策略,入参含义 0. 对齐shift-by参数,代表把offset向前或向后移动shift条 1. 对齐参考(by-duration,to-datetime,to-earliest,to-latest),代表把offset移动到指定timestamp的位置 2. 对齐参考(to-offset),代表把offset移动到指定的offset位置
23705
23713
  :rtype: int
23706
23714
  """
23707
23715
  return self._Strategy
@@ -23712,7 +23720,7 @@ class ModifyGroupOffsetsRequest(AbstractModel):
23712
23720
 
23713
23721
  @property
23714
23722
  def Topics(self):
23715
- """需要重置的主题名列表, 不填表示全部
23723
+ """需要重置的主题名列表
23716
23724
  :rtype: list of str
23717
23725
  """
23718
23726
  return self._Topics
@@ -23734,7 +23742,7 @@ class ModifyGroupOffsetsRequest(AbstractModel):
23734
23742
 
23735
23743
  @property
23736
23744
  def ShiftTimestamp(self):
23737
- """单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的时,如果指定的时间不存在消息,则获取最末尾的offset。
23745
+ """单位ms。当strategy为1时,必须包含该字段,其中-2表示重置offset到最开始的位置,-1表示重置到最新的位置(相当于清空),其它值则代表指定的时间,会获取topic中指定时间的offset然后进行重置,需要注意的是,如果指定的时间不存在消息,则获取最末尾的offset。
23738
23746
  :rtype: int
23739
23747
  """
23740
23748
  return self._ShiftTimestamp
@@ -24653,7 +24661,7 @@ class ModifyTopicAttributesRequest(AbstractModel):
24653
24661
  :type RetentionMs: int
24654
24662
  :param _MaxMessageBytes: 主题消息最大值,单位为 Byte,最大值为12582912Byte(即12MB)。
24655
24663
  :type MaxMessageBytes: int
24656
- :param _SegmentMs: Segment 分片滚动的时长,单位:ms,当前最小为300000ms
24664
+ :param _SegmentMs: Segment 分片滚动的时长,单位:ms,当前最小值86400000ms
24657
24665
  :type SegmentMs: int
24658
24666
  :param _CleanUpPolicy: 消息删除策略,可以选择delete 或者compact
24659
24667
  :type CleanUpPolicy: str
@@ -24783,7 +24791,7 @@ class ModifyTopicAttributesRequest(AbstractModel):
24783
24791
 
24784
24792
  @property
24785
24793
  def SegmentMs(self):
24786
- """Segment 分片滚动的时长,单位:ms,当前最小为300000ms
24794
+ """Segment 分片滚动的时长,单位:ms,当前最小值86400000ms
24787
24795
  :rtype: int
24788
24796
  """
24789
24797
  return self._SegmentMs
@@ -30021,7 +30029,7 @@ class TopicAttributesResponse(AbstractModel):
30021
30029
  r"""
30022
30030
  :param _TopicId: 主题 ID
30023
30031
  :type TopicId: str
30024
- :param _CreateTime: 创建时间
30032
+ :param _CreateTime: 创建时间的秒级时间戳
30025
30033
  :type CreateTime: int
30026
30034
  :param _Note: 主题备注
30027
30035
  :type Note: str
@@ -30070,7 +30078,7 @@ class TopicAttributesResponse(AbstractModel):
30070
30078
 
30071
30079
  @property
30072
30080
  def CreateTime(self):
30073
- """创建时间
30081
+ """创建时间的秒级时间戳
30074
30082
  :rtype: int
30075
30083
  """
30076
30084
  return self._CreateTime