tencentcloud-sdk-python 3.0.1451__py2.py3-none-any.whl → 3.0.1452__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.
@@ -410,11 +410,11 @@ class AclRuleInfo(AbstractModel):
410
410
  r"""
411
411
  :param _Operation: Acl操作方式,枚举值(所有操作: All, 读:Read,写:Write)
412
412
  :type Operation: str
413
- :param _PermissionType: 权限类型,(DenyAllow)
413
+ :param _PermissionType: 权限类型,Deny:拒绝,Allow:允许。
414
414
  :type PermissionType: str
415
- :param _Host: 默认为\*,表示任何host都可以访问,当前ckafka不支持host为\* 和 ip网段
415
+ :param _Host: 表示任何host都可以访问
416
416
  :type Host: str
417
- :param _Principal: 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。
417
+ :param _Principal: 用户,User:*表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。
418
418
  :type Principal: str
419
419
  """
420
420
  self._Operation = None
@@ -435,7 +435,7 @@ class AclRuleInfo(AbstractModel):
435
435
 
436
436
  @property
437
437
  def PermissionType(self):
438
- """权限类型,(DenyAllow)
438
+ """权限类型,Deny:拒绝,Allow:允许。
439
439
  :rtype: str
440
440
  """
441
441
  return self._PermissionType
@@ -446,7 +446,7 @@ class AclRuleInfo(AbstractModel):
446
446
 
447
447
  @property
448
448
  def Host(self):
449
- """默认为\*,表示任何host都可以访问,当前ckafka不支持host为\* 和 ip网段
449
+ """表示任何host都可以访问
450
450
  :rtype: str
451
451
  """
452
452
  return self._Host
@@ -457,7 +457,7 @@ class AclRuleInfo(AbstractModel):
457
457
 
458
458
  @property
459
459
  def Principal(self):
460
- """用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。
460
+ """用户,User:*表示任何user都可以访问,当前用户只能是用户列表中包含的用户。传入格式需要带【User:】前缀。例如用户A,传入为User:A。
461
461
  :rtype: str
462
462
  """
463
463
  return self._Principal
@@ -733,7 +733,7 @@ class AuthorizeTokenRequest(AbstractModel):
733
733
 
734
734
  def __init__(self):
735
735
  r"""
736
- :param _InstanceId: ckafka集群实例Id
736
+ :param _InstanceId: ckafka集群实例Id, 可通过DescribeInstances接口获取
737
737
  :type InstanceId: str
738
738
  :param _User: 用户
739
739
  :type User: str
@@ -746,7 +746,7 @@ class AuthorizeTokenRequest(AbstractModel):
746
746
 
747
747
  @property
748
748
  def InstanceId(self):
749
- """ckafka集群实例Id
749
+ """ckafka集群实例Id, 可通过DescribeInstances接口获取
750
750
  :rtype: str
751
751
  """
752
752
  return self._InstanceId
@@ -929,13 +929,13 @@ class BatchCreateAclRequest(AbstractModel):
929
929
 
930
930
  def __init__(self):
931
931
  r"""
932
- :param _InstanceId: ckafka集群实例Id
932
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
933
933
  :type InstanceId: str
934
934
  :param _ResourceType: Acl资源类型,(2:TOPIC)
935
935
  :type ResourceType: int
936
- :param _ResourceNames: 资源列表数组
936
+ :param _ResourceNames: 资源列表数组,可通过DescribeTopic接口获取。
937
937
  :type ResourceNames: list of str
938
- :param _RuleList: 设置的ACL规则列表
938
+ :param _RuleList: 设置的ACL规则列表,可通过DescribeAclRule接口获取。
939
939
  :type RuleList: list of AclRuleInfo
940
940
  """
941
941
  self._InstanceId = None
@@ -945,7 +945,7 @@ class BatchCreateAclRequest(AbstractModel):
945
945
 
946
946
  @property
947
947
  def InstanceId(self):
948
- """ckafka集群实例Id
948
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
949
949
  :rtype: str
950
950
  """
951
951
  return self._InstanceId
@@ -967,7 +967,7 @@ class BatchCreateAclRequest(AbstractModel):
967
967
 
968
968
  @property
969
969
  def ResourceNames(self):
970
- """资源列表数组
970
+ """资源列表数组,可通过DescribeTopic接口获取。
971
971
  :rtype: list of str
972
972
  """
973
973
  return self._ResourceNames
@@ -978,7 +978,7 @@ class BatchCreateAclRequest(AbstractModel):
978
978
 
979
979
  @property
980
980
  def RuleList(self):
981
- """设置的ACL规则列表
981
+ """设置的ACL规则列表,可通过DescribeAclRule接口获取。
982
982
  :rtype: list of AclRuleInfo
983
983
  """
984
984
  return self._RuleList
@@ -1579,7 +1579,7 @@ class BrokerTopicData(AbstractModel):
1579
1579
  :type TopicName: str
1580
1580
  :param _TopicId: 主题Id
1581
1581
  :type TopicId: str
1582
- :param _DataSize: 主题占用Broker 容量大小
1582
+ :param _DataSize: 主题占用Broker 容量大小,单位为Bytes。
1583
1583
  :type DataSize: int
1584
1584
  """
1585
1585
  self._TopicName = None
@@ -1610,7 +1610,7 @@ class BrokerTopicData(AbstractModel):
1610
1610
 
1611
1611
  @property
1612
1612
  def DataSize(self):
1613
- """主题占用Broker 容量大小
1613
+ """主题占用Broker 容量大小,单位为Bytes。
1614
1614
  :rtype: int
1615
1615
  """
1616
1616
  return self._DataSize
@@ -1707,7 +1707,7 @@ class CancelAuthorizationTokenRequest(AbstractModel):
1707
1707
 
1708
1708
  def __init__(self):
1709
1709
  r"""
1710
- :param _InstanceId: ckafka集群实例Id
1710
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
1711
1711
  :type InstanceId: str
1712
1712
  :param _User: 用户
1713
1713
  :type User: str
@@ -1720,7 +1720,7 @@ class CancelAuthorizationTokenRequest(AbstractModel):
1720
1720
 
1721
1721
  @property
1722
1722
  def InstanceId(self):
1723
- """ckafka集群实例Id
1723
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
1724
1724
  :rtype: str
1725
1725
  """
1726
1726
  return self._InstanceId
@@ -3712,7 +3712,7 @@ class CreateAclRequest(AbstractModel):
3712
3712
 
3713
3713
  def __init__(self):
3714
3714
  r"""
3715
- :param _InstanceId: ckafka集群实例Id
3715
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3716
3716
  :type InstanceId: str
3717
3717
  :param _ResourceType: Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
3718
3718
  :type ResourceType: int
@@ -3740,7 +3740,7 @@ class CreateAclRequest(AbstractModel):
3740
3740
 
3741
3741
  @property
3742
3742
  def InstanceId(self):
3743
- """ckafka集群实例Id
3743
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
3744
3744
  :rtype: str
3745
3745
  """
3746
3746
  return self._InstanceId
@@ -3898,7 +3898,7 @@ class CreateAclRuleRequest(AbstractModel):
3898
3898
 
3899
3899
  def __init__(self):
3900
3900
  r"""
3901
- :param _InstanceId: ckafka集群实例Id
3901
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
3902
3902
  :type InstanceId: str
3903
3903
  :param _ResourceType: Acl资源类型,目前只支持Topic,枚举值列表:Topic
3904
3904
  :type ResourceType: str
@@ -3908,9 +3908,9 @@ class CreateAclRuleRequest(AbstractModel):
3908
3908
  :type RuleName: str
3909
3909
  :param _RuleList: 设置的ACL规则列表
3910
3910
  :type RuleList: list of AclRuleInfo
3911
- :param _Pattern: 表示前缀匹配的前缀的值
3911
+ :param _Pattern: 表示前缀匹配的前缀的值 (当PatternType取值为PREFIXED时,此参数必填)
3912
3912
  :type Pattern: str
3913
- :param _IsApplied: 预设ACL规则是否应用到新增的topic
3913
+ :param _IsApplied: 预设ACL规则是否应用到新增的topic中。默认为0,表示否。取值为1时表示是。
3914
3914
  :type IsApplied: int
3915
3915
  :param _Comment: ACL规则的备注
3916
3916
  :type Comment: str
@@ -3926,7 +3926,7 @@ class CreateAclRuleRequest(AbstractModel):
3926
3926
 
3927
3927
  @property
3928
3928
  def InstanceId(self):
3929
- """ckafka集群实例Id
3929
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
3930
3930
  :rtype: str
3931
3931
  """
3932
3932
  return self._InstanceId
@@ -3981,7 +3981,7 @@ class CreateAclRuleRequest(AbstractModel):
3981
3981
 
3982
3982
  @property
3983
3983
  def Pattern(self):
3984
- """表示前缀匹配的前缀的值
3984
+ """表示前缀匹配的前缀的值 (当PatternType取值为PREFIXED时,此参数必填)
3985
3985
  :rtype: str
3986
3986
  """
3987
3987
  return self._Pattern
@@ -3992,7 +3992,7 @@ class CreateAclRuleRequest(AbstractModel):
3992
3992
 
3993
3993
  @property
3994
3994
  def IsApplied(self):
3995
- """预设ACL规则是否应用到新增的topic
3995
+ """预设ACL规则是否应用到新增的topic中。默认为0,表示否。取值为1时表示是。
3996
3996
  :rtype: int
3997
3997
  """
3998
3998
  return self._IsApplied
@@ -4571,7 +4571,7 @@ class CreateConsumerRequest(AbstractModel):
4571
4571
 
4572
4572
  def __init__(self):
4573
4573
  r"""
4574
- :param _InstanceId: ckafka集群实例Id
4574
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
4575
4575
  :type InstanceId: str
4576
4576
  :param _GroupName: 消费分组名称
4577
4577
  :type GroupName: str
@@ -4587,7 +4587,7 @@ class CreateConsumerRequest(AbstractModel):
4587
4587
 
4588
4588
  @property
4589
4589
  def InstanceId(self):
4590
- """ckafka集群实例Id
4590
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
4591
4591
  :rtype: str
4592
4592
  """
4593
4593
  return self._InstanceId
@@ -4697,7 +4697,7 @@ class CreateDatahubTaskRequest(AbstractModel):
4697
4697
 
4698
4698
  def __init__(self):
4699
4699
  r"""
4700
- :param _TaskName: 任务名称
4700
+ :param _TaskName: 任务名称,只能以字母起始,允许包含字母、数字、- 、. 、 下划线且长度不超过64 (、为分割符号规则不包含)
4701
4701
  :type TaskName: str
4702
4702
  :param _TaskType: 任务类型,SOURCE数据接入,SINK数据流出
4703
4703
  :type TaskType: str
@@ -4734,7 +4734,7 @@ class CreateDatahubTaskRequest(AbstractModel):
4734
4734
 
4735
4735
  @property
4736
4736
  def TaskName(self):
4737
- """任务名称
4737
+ """任务名称,只能以字母起始,允许包含字母、数字、- 、. 、 下划线且长度不超过64 (、为分割符号规则不包含)
4738
4738
  :rtype: str
4739
4739
  """
4740
4740
  return self._TaskName
@@ -5384,7 +5384,7 @@ class CreateInstancePreRequest(AbstractModel):
5384
5384
 
5385
5385
  def __init__(self):
5386
5386
  r"""
5387
- :param _InstanceName: ckafka集群实例Name,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
5387
+ :param _InstanceName: ckafka集群实例Name,是一个不超过 128 个字符的任意字符串。
5388
5388
  :type InstanceName: str
5389
5389
  :param _ZoneId: 可用区。当购买多可用区实例时,当前参数为主可用区。 [查看可用区](https://cloud.tencent.com/document/product/597/55246)
5390
5390
  :type ZoneId: int
@@ -5396,21 +5396,21 @@ class CreateInstancePreRequest(AbstractModel):
5396
5396
  :type VpcId: str
5397
5397
  :param _SubnetId: 子网id
5398
5398
  :type SubnetId: str
5399
- :param _MsgRetentionTime: 可选。实例日志的最长保留时间,单位分钟,默认为100807天),最大30天,不填默认0,代表不开启日志保留时间回收策略
5399
+ :param _MsgRetentionTime: 可选。实例日志的最长保留时间,单位分钟,不填默认为14401天),可设置范围为1分钟到90天。
5400
5400
  :type MsgRetentionTime: int
5401
5401
  :param _ClusterId: 创建实例时可以选择集群Id, 该入参表示集群Id
5402
5402
  :type ClusterId: int
5403
5403
  :param _RenewFlag: 预付费自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置)
5404
5404
  :type RenewFlag: int
5405
- :param _KafkaVersion: CKafka版本号[0.10.2、1.1.1、2.4.12.4.22.8.13.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
5405
+ :param _KafkaVersion: CKafka版本号[2.4.1, 2.4.2, 2.8.1, 3.2.3], 默认取值是2.4.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
5406
5406
  :type KafkaVersion: str
5407
5407
  :param _SpecificationsType: 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"
5408
5408
  :type SpecificationsType: str
5409
- :param _DiskSize: 磁盘大小,如果跟控制台规格配比不相符,则无法创建成功
5409
+ :param _DiskSize: 磁盘大小,如果跟控制台规格配比不相符,则无法创建成功。默认取值为500,步长设置为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122562
5410
5410
  :type DiskSize: int
5411
- :param _BandWidth: 实例带宽,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s
5411
+ :param _BandWidth: 实例带宽,默认值为40,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/11745
5412
5412
  :type BandWidth: int
5413
- :param _Partition: 分区大小,如果跟控制台规格配比不相符,则无法创建成功
5413
+ :param _Partition: 分区大小,如果跟控制台规格配比不相符,则无法创建成功。默认值为800,步长为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122563
5414
5414
  :type Partition: int
5415
5415
  :param _Tags: 标签
5416
5416
  :type Tags: list of Tag
@@ -5454,7 +5454,7 @@ class CreateInstancePreRequest(AbstractModel):
5454
5454
 
5455
5455
  @property
5456
5456
  def InstanceName(self):
5457
- """ckafka集群实例Name,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
5457
+ """ckafka集群实例Name,是一个不超过 128 个字符的任意字符串。
5458
5458
  :rtype: str
5459
5459
  """
5460
5460
  return self._InstanceName
@@ -5520,7 +5520,7 @@ class CreateInstancePreRequest(AbstractModel):
5520
5520
 
5521
5521
  @property
5522
5522
  def MsgRetentionTime(self):
5523
- """可选。实例日志的最长保留时间,单位分钟,默认为100807天),最大30天,不填默认0,代表不开启日志保留时间回收策略
5523
+ """可选。实例日志的最长保留时间,单位分钟,不填默认为14401天),可设置范围为1分钟到90天。
5524
5524
  :rtype: int
5525
5525
  """
5526
5526
  return self._MsgRetentionTime
@@ -5553,7 +5553,7 @@ class CreateInstancePreRequest(AbstractModel):
5553
5553
 
5554
5554
  @property
5555
5555
  def KafkaVersion(self):
5556
- """CKafka版本号[0.10.2、1.1.1、2.4.12.4.22.8.13.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
5556
+ """CKafka版本号[2.4.1, 2.4.2, 2.8.1, 3.2.3], 默认取值是2.4.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
5557
5557
  :rtype: str
5558
5558
  """
5559
5559
  return self._KafkaVersion
@@ -5575,7 +5575,7 @@ class CreateInstancePreRequest(AbstractModel):
5575
5575
 
5576
5576
  @property
5577
5577
  def DiskSize(self):
5578
- """磁盘大小,如果跟控制台规格配比不相符,则无法创建成功
5578
+ """磁盘大小,如果跟控制台规格配比不相符,则无法创建成功。默认取值为500,步长设置为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122562
5579
5579
  :rtype: int
5580
5580
  """
5581
5581
  return self._DiskSize
@@ -5586,7 +5586,7 @@ class CreateInstancePreRequest(AbstractModel):
5586
5586
 
5587
5587
  @property
5588
5588
  def BandWidth(self):
5589
- """实例带宽,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s
5589
+ """实例带宽,默认值为40,单位MB/s; 最小值:20MB/s, 高级版最大值:360MB/s,专业版最大值:100000MB/s 标准版固定带宽规格: 40MB/s, 100MB/s, 150MB/s。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/11745
5590
5590
  :rtype: int
5591
5591
  """
5592
5592
  return self._BandWidth
@@ -5597,7 +5597,7 @@ class CreateInstancePreRequest(AbstractModel):
5597
5597
 
5598
5598
  @property
5599
5599
  def Partition(self):
5600
- """分区大小,如果跟控制台规格配比不相符,则无法创建成功
5600
+ """分区大小,如果跟控制台规格配比不相符,则无法创建成功。默认值为800,步长为100。可以通过以下链接查看计费规格:https://cloud.tencent.com/document/product/597/122563
5601
5601
  :rtype: int
5602
5602
  """
5603
5603
  return self._Partition
@@ -5874,11 +5874,11 @@ class CreatePartitionRequest(AbstractModel):
5874
5874
 
5875
5875
  def __init__(self):
5876
5876
  r"""
5877
- :param _InstanceId: ckafka集群实例Id
5877
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
5878
5878
  :type InstanceId: str
5879
- :param _TopicName: 主题名称
5879
+ :param _TopicName: 主题名称,可通过DescribeTopic接口获取。
5880
5880
  :type TopicName: str
5881
- :param _PartitionNum: 主题分区个数
5881
+ :param _PartitionNum: 主题分区个数,传入参数为修改后的分区数,而不是增加的分区数,因此传入参数需要大于当前主题分区个数。
5882
5882
  :type PartitionNum: int
5883
5883
  """
5884
5884
  self._InstanceId = None
@@ -5887,7 +5887,7 @@ class CreatePartitionRequest(AbstractModel):
5887
5887
 
5888
5888
  @property
5889
5889
  def InstanceId(self):
5890
- """ckafka集群实例Id
5890
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
5891
5891
  :rtype: str
5892
5892
  """
5893
5893
  return self._InstanceId
@@ -5898,7 +5898,7 @@ class CreatePartitionRequest(AbstractModel):
5898
5898
 
5899
5899
  @property
5900
5900
  def TopicName(self):
5901
- """主题名称
5901
+ """主题名称,可通过DescribeTopic接口获取。
5902
5902
  :rtype: str
5903
5903
  """
5904
5904
  return self._TopicName
@@ -5909,7 +5909,7 @@ class CreatePartitionRequest(AbstractModel):
5909
5909
 
5910
5910
  @property
5911
5911
  def PartitionNum(self):
5912
- """主题分区个数
5912
+ """主题分区个数,传入参数为修改后的分区数,而不是增加的分区数,因此传入参数需要大于当前主题分区个数。
5913
5913
  :rtype: int
5914
5914
  """
5915
5915
  return self._PartitionNum
@@ -6356,7 +6356,7 @@ class CreatePrometheusRequest(AbstractModel):
6356
6356
 
6357
6357
  def __init__(self):
6358
6358
  r"""
6359
- :param _InstanceId: ckafka集群实例Id
6359
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
6360
6360
  :type InstanceId: str
6361
6361
  :param _VpcId: 私有网络Id
6362
6362
  :type VpcId: str
@@ -6369,7 +6369,7 @@ class CreatePrometheusRequest(AbstractModel):
6369
6369
 
6370
6370
  @property
6371
6371
  def InstanceId(self):
6372
- """ckafka集群实例Id
6372
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
6373
6373
  :rtype: str
6374
6374
  """
6375
6375
  return self._InstanceId
@@ -6467,21 +6467,21 @@ class CreateRouteRequest(AbstractModel):
6467
6467
 
6468
6468
  def __init__(self):
6469
6469
  r"""
6470
- :param _InstanceId: 实例唯一id
6470
+ :param _InstanceId: ckafka集群实例id,可通过DescribeInstances接口获取
6471
6471
  :type InstanceId: str
6472
- :param _VipType: 路由网络类型(3:vpc路由;7:内部支撑路由)
6472
+ :param _VipType: 路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)
6473
6473
  :type VipType: int
6474
- :param _VpcId: vpc网络Id
6474
+ :param _VpcId: vpc网络Id,当vipType为3时必填
6475
6475
  :type VpcId: str
6476
- :param _SubnetId: vpc子网id
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
6478
+ :param _AccessType: 访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0
6479
6479
  :type AccessType: int
6480
- :param _AuthFlag: 是否需要权限管理
6480
+ :param _AuthFlag: 是否需要权限管理,该字段已废弃
6481
6481
  :type AuthFlag: int
6482
6482
  :param _CallerAppid: 调用方appId
6483
6483
  :type CallerAppid: int
6484
- :param _PublicNetwork: 公网带宽
6484
+ :param _PublicNetwork: 公网带宽,公网路由必传,且必选时3的倍数,无默认值
6485
6485
  :type PublicNetwork: int
6486
6486
  :param _Ip: vip地址
6487
6487
  :type Ip: str
@@ -6498,7 +6498,7 @@ class CreateRouteRequest(AbstractModel):
6498
6498
 
6499
6499
  @property
6500
6500
  def InstanceId(self):
6501
- """实例唯一id
6501
+ """ckafka集群实例id,可通过DescribeInstances接口获取
6502
6502
  :rtype: str
6503
6503
  """
6504
6504
  return self._InstanceId
@@ -6509,7 +6509,7 @@ class CreateRouteRequest(AbstractModel):
6509
6509
 
6510
6510
  @property
6511
6511
  def VipType(self):
6512
- """路由网络类型(3:vpc路由;7:内部支撑路由)
6512
+ """路由网络类型(3:vpc路由;7:内部支撑路由;1:公网路由)
6513
6513
  :rtype: int
6514
6514
  """
6515
6515
  return self._VipType
@@ -6520,7 +6520,7 @@ class CreateRouteRequest(AbstractModel):
6520
6520
 
6521
6521
  @property
6522
6522
  def VpcId(self):
6523
- """vpc网络Id
6523
+ """vpc网络Id,当vipType为3时必填
6524
6524
  :rtype: str
6525
6525
  """
6526
6526
  return self._VpcId
@@ -6531,7 +6531,7 @@ class CreateRouteRequest(AbstractModel):
6531
6531
 
6532
6532
  @property
6533
6533
  def SubnetId(self):
6534
- """vpc子网id
6534
+ """vpc子网id,当vipType为3时必填
6535
6535
  :rtype: str
6536
6536
  """
6537
6537
  return self._SubnetId
@@ -6542,7 +6542,7 @@ class CreateRouteRequest(AbstractModel):
6542
6542
 
6543
6543
  @property
6544
6544
  def AccessType(self):
6545
- """访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl
6545
+ """访问类型:0-plaintext;1-sasl_plaintext;2-ssl;3-sasl_ssl,默认为0
6546
6546
  :rtype: int
6547
6547
  """
6548
6548
  return self._AccessType
@@ -6553,7 +6553,7 @@ class CreateRouteRequest(AbstractModel):
6553
6553
 
6554
6554
  @property
6555
6555
  def AuthFlag(self):
6556
- """是否需要权限管理
6556
+ """是否需要权限管理,该字段已废弃
6557
6557
  :rtype: int
6558
6558
  """
6559
6559
  return self._AuthFlag
@@ -6575,7 +6575,7 @@ class CreateRouteRequest(AbstractModel):
6575
6575
 
6576
6576
  @property
6577
6577
  def PublicNetwork(self):
6578
- """公网带宽
6578
+ """公网带宽,公网路由必传,且必选时3的倍数,无默认值
6579
6579
  :rtype: int
6580
6580
  """
6581
6581
  return self._PublicNetwork
@@ -6668,7 +6668,7 @@ class CreateTokenRequest(AbstractModel):
6668
6668
 
6669
6669
  def __init__(self):
6670
6670
  r"""
6671
- :param _InstanceId: ckafka集群实例Id
6671
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
6672
6672
  :type InstanceId: str
6673
6673
  :param _User: 用户名
6674
6674
  :type User: str
@@ -6678,7 +6678,7 @@ class CreateTokenRequest(AbstractModel):
6678
6678
 
6679
6679
  @property
6680
6680
  def InstanceId(self):
6681
- """ckafka集群实例Id
6681
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
6682
6682
  :rtype: str
6683
6683
  """
6684
6684
  return self._InstanceId
@@ -6762,11 +6762,11 @@ class CreateTopicIpWhiteListRequest(AbstractModel):
6762
6762
 
6763
6763
  def __init__(self):
6764
6764
  r"""
6765
- :param _InstanceId: ckafka集群实例Id
6765
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
6766
6766
  :type InstanceId: str
6767
- :param _TopicName: 主题名称
6767
+ :param _TopicName: 主题名称,可通过DescribeTopic接口获取
6768
6768
  :type TopicName: str
6769
- :param _IpWhiteList: ip白名单列表
6769
+ :param _IpWhiteList: ip白名单列表,最大值为512,即最大允许传入512个ip。
6770
6770
  :type IpWhiteList: list of str
6771
6771
  """
6772
6772
  self._InstanceId = None
@@ -6775,7 +6775,7 @@ class CreateTopicIpWhiteListRequest(AbstractModel):
6775
6775
 
6776
6776
  @property
6777
6777
  def InstanceId(self):
6778
- """ckafka集群实例Id
6778
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
6779
6779
  :rtype: str
6780
6780
  """
6781
6781
  return self._InstanceId
@@ -6786,7 +6786,7 @@ class CreateTopicIpWhiteListRequest(AbstractModel):
6786
6786
 
6787
6787
  @property
6788
6788
  def TopicName(self):
6789
- """主题名称
6789
+ """主题名称,可通过DescribeTopic接口获取
6790
6790
  :rtype: str
6791
6791
  """
6792
6792
  return self._TopicName
@@ -6797,7 +6797,7 @@ class CreateTopicIpWhiteListRequest(AbstractModel):
6797
6797
 
6798
6798
  @property
6799
6799
  def IpWhiteList(self):
6800
- """ip白名单列表
6800
+ """ip白名单列表,最大值为512,即最大允许传入512个ip。
6801
6801
  :rtype: list of str
6802
6802
  """
6803
6803
  return self._IpWhiteList
@@ -7235,7 +7235,7 @@ class CreateUserRequest(AbstractModel):
7235
7235
 
7236
7236
  def __init__(self):
7237
7237
  r"""
7238
- :param _InstanceId: ckafka集群实例Id
7238
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
7239
7239
  :type InstanceId: str
7240
7240
  :param _Name: 用户名称
7241
7241
  :type Name: str
@@ -7248,7 +7248,7 @@ class CreateUserRequest(AbstractModel):
7248
7248
 
7249
7249
  @property
7250
7250
  def InstanceId(self):
7251
- """ckafka集群实例Id
7251
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
7252
7252
  :rtype: str
7253
7253
  """
7254
7254
  return self._InstanceId
@@ -7621,7 +7621,7 @@ class CvmAndIpInfo(AbstractModel):
7621
7621
  r"""
7622
7622
  :param _CkafkaInstanceId: ckafka集群实例Id
7623
7623
  :type CkafkaInstanceId: str
7624
- :param _InstanceId: CVM实例ID
7624
+ :param _InstanceId: CVM实例ID(ins-test )或POD IP(10.0.0.30)
7625
7625
  :type InstanceId: str
7626
7626
  :param _Ip: IP地址
7627
7627
  :type Ip: str
@@ -7643,7 +7643,7 @@ class CvmAndIpInfo(AbstractModel):
7643
7643
 
7644
7644
  @property
7645
7645
  def InstanceId(self):
7646
- """CVM实例ID
7646
+ """CVM实例ID(ins-test )或POD IP(10.0.0.30)
7647
7647
  :rtype: str
7648
7648
  """
7649
7649
  return self._InstanceId
@@ -7685,7 +7685,36 @@ class DatahubResource(AbstractModel):
7685
7685
 
7686
7686
  def __init__(self):
7687
7687
  r"""
7688
- :param _Type: 资源类型
7688
+ :param _Type: 资源类型 type类型如下:
7689
+ KAFKA,
7690
+ EB_ES,
7691
+ EB_COS,
7692
+ EB_CLS,
7693
+ EB_,
7694
+ MONGODB,
7695
+ HTTP,
7696
+ TDW,
7697
+ ES,
7698
+ CLICKHOUSE,
7699
+ DTS,
7700
+ CLS,
7701
+ COS,
7702
+ TOPIC,
7703
+ MYSQL,
7704
+ MQTT,
7705
+ MYSQL_DATA,
7706
+ DORIS,
7707
+ POSTGRESQL,
7708
+ TDSQL_C_POSTGRESQL,
7709
+ TDSQL_POSTGRESQL,
7710
+ WAREHOUSE_POSTGRESQL,
7711
+ TDSQL_C_MYSQL,
7712
+ MARIADB,
7713
+ SQLSERVER,
7714
+ CTSDB,
7715
+ SCF
7716
+
7717
+
7689
7718
  :type Type: str
7690
7719
  :param _KafkaParam: ckafka配置,Type为KAFKA时必填
7691
7720
  注意:此字段可能返回 null,表示取不到有效值。
@@ -7760,7 +7789,36 @@ class DatahubResource(AbstractModel):
7760
7789
 
7761
7790
  @property
7762
7791
  def Type(self):
7763
- """资源类型
7792
+ """资源类型 type类型如下:
7793
+ KAFKA,
7794
+ EB_ES,
7795
+ EB_COS,
7796
+ EB_CLS,
7797
+ EB_,
7798
+ MONGODB,
7799
+ HTTP,
7800
+ TDW,
7801
+ ES,
7802
+ CLICKHOUSE,
7803
+ DTS,
7804
+ CLS,
7805
+ COS,
7806
+ TOPIC,
7807
+ MYSQL,
7808
+ MQTT,
7809
+ MYSQL_DATA,
7810
+ DORIS,
7811
+ POSTGRESQL,
7812
+ TDSQL_C_POSTGRESQL,
7813
+ TDSQL_POSTGRESQL,
7814
+ WAREHOUSE_POSTGRESQL,
7815
+ TDSQL_C_MYSQL,
7816
+ MARIADB,
7817
+ SQLSERVER,
7818
+ CTSDB,
7819
+ SCF
7820
+
7821
+
7764
7822
  :rtype: str
7765
7823
  """
7766
7824
  return self._Type
@@ -8594,7 +8652,7 @@ class DeleteAclRequest(AbstractModel):
8594
8652
 
8595
8653
  def __init__(self):
8596
8654
  r"""
8597
- :param _InstanceId: ckafka集群实例Id
8655
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
8598
8656
  :type InstanceId: str
8599
8657
  :param _ResourceType: Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
8600
8658
  :type ResourceType: int
@@ -8606,7 +8664,7 @@ class DeleteAclRequest(AbstractModel):
8606
8664
  :type PermissionType: int
8607
8665
  :param _Host: 默认为\*,表示任何host都可以访问,当前ckafka不支持host为\*,但是后面开源kafka的产品化会直接支持
8608
8666
  :type Host: str
8609
- :param _Principal: 用户列表,默认为*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
8667
+ :param _Principal: 用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
8610
8668
  :type Principal: str
8611
8669
  """
8612
8670
  self._InstanceId = None
@@ -8619,7 +8677,7 @@ class DeleteAclRequest(AbstractModel):
8619
8677
 
8620
8678
  @property
8621
8679
  def InstanceId(self):
8622
- """ckafka集群实例Id
8680
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
8623
8681
  :rtype: str
8624
8682
  """
8625
8683
  return self._InstanceId
@@ -8685,7 +8743,7 @@ class DeleteAclRequest(AbstractModel):
8685
8743
 
8686
8744
  @property
8687
8745
  def Principal(self):
8688
- """用户列表,默认为*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
8746
+ """用户列表,默认为User:*,表示任何user都可以访问,当前用户只能是用户列表中包含的用户
8689
8747
  :rtype: str
8690
8748
  """
8691
8749
  return self._Principal
@@ -8765,9 +8823,9 @@ class DeleteAclRuleRequest(AbstractModel):
8765
8823
 
8766
8824
  def __init__(self):
8767
8825
  r"""
8768
- :param _InstanceId: 实例id信息
8826
+ :param _InstanceId: 实例id信息,可通过DescribeInstances接口获取。
8769
8827
  :type InstanceId: str
8770
- :param _RuleName: acl规则名称
8828
+ :param _RuleName: acl规则名称,可通过DescribeAclRule接口获取。
8771
8829
  :type RuleName: str
8772
8830
  """
8773
8831
  self._InstanceId = None
@@ -8775,7 +8833,7 @@ class DeleteAclRuleRequest(AbstractModel):
8775
8833
 
8776
8834
  @property
8777
8835
  def InstanceId(self):
8778
- """实例id信息
8836
+ """实例id信息,可通过DescribeInstances接口获取。
8779
8837
  :rtype: str
8780
8838
  """
8781
8839
  return self._InstanceId
@@ -8786,7 +8844,7 @@ class DeleteAclRuleRequest(AbstractModel):
8786
8844
 
8787
8845
  @property
8788
8846
  def RuleName(self):
8789
- """acl规则名称
8847
+ """acl规则名称,可通过DescribeAclRule接口获取。
8790
8848
  :rtype: str
8791
8849
  """
8792
8850
  return self._RuleName
@@ -9102,9 +9160,9 @@ class DeleteGroupRequest(AbstractModel):
9102
9160
 
9103
9161
  def __init__(self):
9104
9162
  r"""
9105
- :param _InstanceId: ckafka集群实例Id
9163
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
9106
9164
  :type InstanceId: str
9107
- :param _Group: 消费分组
9165
+ :param _Group: 消费组名称,可通过DescribeConsumerGroup接口获取。
9108
9166
  :type Group: str
9109
9167
  """
9110
9168
  self._InstanceId = None
@@ -9112,7 +9170,7 @@ class DeleteGroupRequest(AbstractModel):
9112
9170
 
9113
9171
  @property
9114
9172
  def InstanceId(self):
9115
- """ckafka集群实例Id
9173
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
9116
9174
  :rtype: str
9117
9175
  """
9118
9176
  return self._InstanceId
@@ -9123,7 +9181,7 @@ class DeleteGroupRequest(AbstractModel):
9123
9181
 
9124
9182
  @property
9125
9183
  def Group(self):
9126
- """消费分组
9184
+ """消费组名称,可通过DescribeConsumerGroup接口获取。
9127
9185
  :rtype: str
9128
9186
  """
9129
9187
  return self._Group
@@ -9198,14 +9256,14 @@ class DeleteInstancePostRequest(AbstractModel):
9198
9256
 
9199
9257
  def __init__(self):
9200
9258
  r"""
9201
- :param _InstanceId: ckafka集群实例Id
9259
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
9202
9260
  :type InstanceId: str
9203
9261
  """
9204
9262
  self._InstanceId = None
9205
9263
 
9206
9264
  @property
9207
9265
  def InstanceId(self):
9208
- """ckafka集群实例Id
9266
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
9209
9267
  :rtype: str
9210
9268
  """
9211
9269
  return self._InstanceId
@@ -9279,14 +9337,14 @@ class DeleteInstancePreRequest(AbstractModel):
9279
9337
 
9280
9338
  def __init__(self):
9281
9339
  r"""
9282
- :param _InstanceId: ckafka集群实例Id
9340
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
9283
9341
  :type InstanceId: str
9284
9342
  """
9285
9343
  self._InstanceId = None
9286
9344
 
9287
9345
  @property
9288
9346
  def InstanceId(self):
9289
- """ckafka集群实例Id
9347
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
9290
9348
  :rtype: str
9291
9349
  """
9292
9350
  return self._InstanceId
@@ -9360,13 +9418,13 @@ class DeleteRouteRequest(AbstractModel):
9360
9418
 
9361
9419
  def __init__(self):
9362
9420
  r"""
9363
- :param _InstanceId: ckafka集群实例Id
9421
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
9364
9422
  :type InstanceId: str
9365
- :param _RouteId: 路由id
9423
+ :param _RouteId: 路由id,可通过DescribeRoute接口获取
9366
9424
  :type RouteId: int
9367
9425
  :param _CallerAppid: 调用方appId
9368
9426
  :type CallerAppid: int
9369
- :param _DeleteRouteTime: 设置定时删除路由时间,若DeleteRouteTime < now ,设置时间小于当前接口提交时间则立即执行;DeleteRouteTime > now,设置时间大于当前接口提交时间,则按照设置的时间,定时执行删除; 该参数设置提交后,无法撤销!!!
9427
+ :param _DeleteRouteTime: 设置定时删除路由时间,仅类型为公网路由支持定时删除,可选择未来的24小时的任意时间
9370
9428
  :type DeleteRouteTime: str
9371
9429
  """
9372
9430
  self._InstanceId = None
@@ -9376,7 +9434,7 @@ class DeleteRouteRequest(AbstractModel):
9376
9434
 
9377
9435
  @property
9378
9436
  def InstanceId(self):
9379
- """ckafka集群实例Id
9437
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
9380
9438
  :rtype: str
9381
9439
  """
9382
9440
  return self._InstanceId
@@ -9387,7 +9445,7 @@ class DeleteRouteRequest(AbstractModel):
9387
9445
 
9388
9446
  @property
9389
9447
  def RouteId(self):
9390
- """路由id
9448
+ """路由id,可通过DescribeRoute接口获取
9391
9449
  :rtype: int
9392
9450
  """
9393
9451
  return self._RouteId
@@ -9409,7 +9467,7 @@ class DeleteRouteRequest(AbstractModel):
9409
9467
 
9410
9468
  @property
9411
9469
  def DeleteRouteTime(self):
9412
- """设置定时删除路由时间,若DeleteRouteTime < now ,设置时间小于当前接口提交时间则立即执行;DeleteRouteTime > now,设置时间大于当前接口提交时间,则按照设置的时间,定时执行删除; 该参数设置提交后,无法撤销!!!
9470
+ """设置定时删除路由时间,仅类型为公网路由支持定时删除,可选择未来的24小时的任意时间
9413
9471
  :rtype: str
9414
9472
  """
9415
9473
  return self._DeleteRouteTime
@@ -9486,7 +9544,7 @@ class DeleteRouteTriggerTimeRequest(AbstractModel):
9486
9544
 
9487
9545
  def __init__(self):
9488
9546
  r"""
9489
- :param _InstanceId: ckafka集群实例Id
9547
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
9490
9548
  :type InstanceId: str
9491
9549
  :param _DelayTime: 修改删除路由的定时时间
9492
9550
  :type DelayTime: str
@@ -9496,7 +9554,7 @@ class DeleteRouteTriggerTimeRequest(AbstractModel):
9496
9554
 
9497
9555
  @property
9498
9556
  def InstanceId(self):
9499
- """ckafka集群实例Id
9557
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
9500
9558
  :rtype: str
9501
9559
  """
9502
9560
  return self._InstanceId
@@ -9565,9 +9623,9 @@ class DeleteTopicIpWhiteListRequest(AbstractModel):
9565
9623
 
9566
9624
  def __init__(self):
9567
9625
  r"""
9568
- :param _InstanceId: ckafka集群实例Id
9626
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
9569
9627
  :type InstanceId: str
9570
- :param _TopicName: 主题名
9628
+ :param _TopicName: 主题名,可通过DescribeTopic接口获取。
9571
9629
  :type TopicName: str
9572
9630
  :param _IpWhiteList: ip白名单列表
9573
9631
  :type IpWhiteList: list of str
@@ -9578,7 +9636,7 @@ class DeleteTopicIpWhiteListRequest(AbstractModel):
9578
9636
 
9579
9637
  @property
9580
9638
  def InstanceId(self):
9581
- """ckafka集群实例Id
9639
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
9582
9640
  :rtype: str
9583
9641
  """
9584
9642
  return self._InstanceId
@@ -9589,7 +9647,7 @@ class DeleteTopicIpWhiteListRequest(AbstractModel):
9589
9647
 
9590
9648
  @property
9591
9649
  def TopicName(self):
9592
- """主题名
9650
+ """主题名,可通过DescribeTopic接口获取。
9593
9651
  :rtype: str
9594
9652
  """
9595
9653
  return self._TopicName
@@ -9772,9 +9830,9 @@ class DeleteUserRequest(AbstractModel):
9772
9830
 
9773
9831
  def __init__(self):
9774
9832
  r"""
9775
- :param _InstanceId: ckafka集群实例Id
9833
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
9776
9834
  :type InstanceId: str
9777
- :param _Name: 用户名称
9835
+ :param _Name: 用户名称,可通过DescribeUser接口获取。
9778
9836
  :type Name: str
9779
9837
  """
9780
9838
  self._InstanceId = None
@@ -9782,7 +9840,7 @@ class DeleteUserRequest(AbstractModel):
9782
9840
 
9783
9841
  @property
9784
9842
  def InstanceId(self):
9785
- """ckafka集群实例Id
9843
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
9786
9844
  :rtype: str
9787
9845
  """
9788
9846
  return self._InstanceId
@@ -9793,7 +9851,7 @@ class DeleteUserRequest(AbstractModel):
9793
9851
 
9794
9852
  @property
9795
9853
  def Name(self):
9796
- """用户名称
9854
+ """用户名称,可通过DescribeUser接口获取。
9797
9855
  :rtype: str
9798
9856
  """
9799
9857
  return self._Name
@@ -9868,7 +9926,7 @@ class DescribeACLRequest(AbstractModel):
9868
9926
 
9869
9927
  def __init__(self):
9870
9928
  r"""
9871
- :param _InstanceId: ckafka集群实例Id
9929
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
9872
9930
  :type InstanceId: str
9873
9931
  :param _ResourceType: Acl资源类型,(2:TOPIC,3:GROUP,4:CLUSTER)
9874
9932
  :type ResourceType: int
@@ -9876,7 +9934,7 @@ class DescribeACLRequest(AbstractModel):
9876
9934
  :type ResourceName: str
9877
9935
  :param _Offset: 偏移位置
9878
9936
  :type Offset: int
9879
- :param _Limit: 个数限制
9937
+ :param _Limit: 个数限制,默认值为50,最大值为50。
9880
9938
  :type Limit: int
9881
9939
  :param _SearchWord: 关键字匹配
9882
9940
  :type SearchWord: str
@@ -9890,7 +9948,7 @@ class DescribeACLRequest(AbstractModel):
9890
9948
 
9891
9949
  @property
9892
9950
  def InstanceId(self):
9893
- """ckafka集群实例Id
9951
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
9894
9952
  :rtype: str
9895
9953
  """
9896
9954
  return self._InstanceId
@@ -9934,7 +9992,7 @@ class DescribeACLRequest(AbstractModel):
9934
9992
 
9935
9993
  @property
9936
9994
  def Limit(self):
9937
- """个数限制
9995
+ """个数限制,默认值为50,最大值为50。
9938
9996
  :rtype: int
9939
9997
  """
9940
9998
  return self._Limit
@@ -10024,13 +10082,13 @@ class DescribeAclRuleRequest(AbstractModel):
10024
10082
 
10025
10083
  def __init__(self):
10026
10084
  r"""
10027
- :param _InstanceId: ckafka集群实例Id
10085
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
10028
10086
  :type InstanceId: str
10029
10087
  :param _RuleName: ACL规则名
10030
10088
  :type RuleName: str
10031
- :param _PatternType: ACL规则匹配类型
10089
+ :param _PatternType: ACL规则匹配类型 (PREFIXED:前缀匹配,PRESET:预设策略)
10032
10090
  :type PatternType: str
10033
- :param _IsSimplified: 是否读取简略的ACL规则
10091
+ :param _IsSimplified: 是否读取简略的ACL规则,默认值为false,表示不读取简略的ACL规则。
10034
10092
  :type IsSimplified: bool
10035
10093
  """
10036
10094
  self._InstanceId = None
@@ -10040,7 +10098,7 @@ class DescribeAclRuleRequest(AbstractModel):
10040
10098
 
10041
10099
  @property
10042
10100
  def InstanceId(self):
10043
- """ckafka集群实例Id
10101
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
10044
10102
  :rtype: str
10045
10103
  """
10046
10104
  return self._InstanceId
@@ -10062,7 +10120,7 @@ class DescribeAclRuleRequest(AbstractModel):
10062
10120
 
10063
10121
  @property
10064
10122
  def PatternType(self):
10065
- """ACL规则匹配类型
10123
+ """ACL规则匹配类型 (PREFIXED:前缀匹配,PRESET:预设策略)
10066
10124
  :rtype: str
10067
10125
  """
10068
10126
  return self._PatternType
@@ -10073,7 +10131,7 @@ class DescribeAclRuleRequest(AbstractModel):
10073
10131
 
10074
10132
  @property
10075
10133
  def IsSimplified(self):
10076
- """是否读取简略的ACL规则
10134
+ """是否读取简略的ACL规则,默认值为false,表示不读取简略的ACL规则。
10077
10135
  :rtype: bool
10078
10136
  """
10079
10137
  return self._IsSimplified
@@ -10855,7 +10913,7 @@ class DescribeConnectResourceResp(AbstractModel):
10855
10913
  :type Description: str
10856
10914
  :param _Type: 连接源类型
10857
10915
  :type Type: str
10858
- :param _Status: 连接源的状态
10916
+ :param _Status: 连接源的状态 枚举值: -1 (创建失败) 、0 (创建中) 、 1 (运行中)、 2 (删除中) 、 4 (删除失败) 、 5 (配置更改中) 、 6 (配置更改失败) 、 7 (异常)
10859
10917
  :type Status: int
10860
10918
  :param _CreateTime: 连接源的创建时间
10861
10919
  :type CreateTime: str
@@ -10971,7 +11029,7 @@ class DescribeConnectResourceResp(AbstractModel):
10971
11029
 
10972
11030
  @property
10973
11031
  def Status(self):
10974
- """连接源的状态
11032
+ """连接源的状态 枚举值: -1 (创建失败) 、0 (创建中) 、 1 (运行中)、 2 (删除中) 、 4 (删除失败) 、 5 (配置更改中) 、 6 (配置更改失败) 、 7 (异常)
10975
11033
  :rtype: int
10976
11034
  """
10977
11035
  return self._Status
@@ -11616,14 +11674,14 @@ class DescribeCvmInfoRequest(AbstractModel):
11616
11674
 
11617
11675
  def __init__(self):
11618
11676
  r"""
11619
- :param _InstanceId: ckafka集群实例Id
11677
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
11620
11678
  :type InstanceId: str
11621
11679
  """
11622
11680
  self._InstanceId = None
11623
11681
 
11624
11682
  @property
11625
11683
  def InstanceId(self):
11626
- """ckafka集群实例Id
11684
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
11627
11685
  :rtype: str
11628
11686
  """
11629
11687
  return self._InstanceId
@@ -13846,14 +13904,14 @@ class DescribePrometheusRequest(AbstractModel):
13846
13904
 
13847
13905
  def __init__(self):
13848
13906
  r"""
13849
- :param _InstanceId: ckafka集群实例Id
13907
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
13850
13908
  :type InstanceId: str
13851
13909
  """
13852
13910
  self._InstanceId = None
13853
13911
 
13854
13912
  @property
13855
13913
  def InstanceId(self):
13856
- """ckafka集群实例Id
13914
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
13857
13915
  :rtype: str
13858
13916
  """
13859
13917
  return self._InstanceId
@@ -17471,7 +17529,7 @@ class FetchDatahubMessageByOffsetRequest(AbstractModel):
17471
17529
 
17472
17530
  def __init__(self):
17473
17531
  r"""
17474
- :param _Name: 弹性topic名称
17532
+ :param _Name: 弹性topic名称,可通过DescribeDatahubTopics接口获取。
17475
17533
  :type Name: str
17476
17534
  :param _Partition: 分区id
17477
17535
  :type Partition: int
@@ -17484,7 +17542,7 @@ class FetchDatahubMessageByOffsetRequest(AbstractModel):
17484
17542
 
17485
17543
  @property
17486
17544
  def Name(self):
17487
- """弹性topic名称
17545
+ """弹性topic名称,可通过DescribeDatahubTopics接口获取。
17488
17546
  :rtype: str
17489
17547
  """
17490
17548
  return self._Name
@@ -17711,9 +17769,9 @@ class FetchMessageByOffsetRequest(AbstractModel):
17711
17769
 
17712
17770
  def __init__(self):
17713
17771
  r"""
17714
- :param _InstanceId: ckafka集群实例Id
17772
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取。
17715
17773
  :type InstanceId: str
17716
- :param _Topic: 主题名
17774
+ :param _Topic: 主题名,可通过DescribeTopic接口获取。
17717
17775
  :type Topic: str
17718
17776
  :param _Partition: 分区id
17719
17777
  :type Partition: int
@@ -17727,7 +17785,7 @@ class FetchMessageByOffsetRequest(AbstractModel):
17727
17785
 
17728
17786
  @property
17729
17787
  def InstanceId(self):
17730
- """ckafka集群实例Id
17788
+ """ckafka集群实例Id,可通过DescribeInstances接口获取。
17731
17789
  :rtype: str
17732
17790
  """
17733
17791
  return self._InstanceId
@@ -17738,7 +17796,7 @@ class FetchMessageByOffsetRequest(AbstractModel):
17738
17796
 
17739
17797
  @property
17740
17798
  def Topic(self):
17741
- """主题名
17799
+ """主题名,可通过DescribeTopic接口获取。
17742
17800
  :rtype: str
17743
17801
  """
17744
17802
  return self._Topic
@@ -19020,12 +19078,16 @@ class InquireCkafkaPriceRequest(AbstractModel):
19020
19078
  :param _Bandwidth: 实例内网带宽大小, 单位MB/s (购买时必填,专业版/高级版询价时带宽信息必填)
19021
19079
  :type Bandwidth: int
19022
19080
  :param _InquiryDiskParam: 实例的硬盘购买类型以及大小 (购买时必填,专业版/高级版询价时磁盘信息必填)
19081
+
19023
19082
  :type InquiryDiskParam: :class:`tencentcloud.ckafka.v20190819.models.InquiryDiskParam`
19024
19083
  :param _MessageRetention: 实例消息保留时间大小, 单位小时 (购买时必填)
19025
19084
  :type MessageRetention: int
19026
19085
  :param _Topic: 购买实例topic数, 单位个 (购买时必填)
19027
19086
  :type Topic: int
19028
19087
  :param _Partition: 购买实例分区数, 单位个 (购买时必填,专业版/高级版询价时带宽信息必填)
19088
+ 分区上限 最大值: 40000,步长: 100
19089
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
19090
+
19029
19091
  :type Partition: int
19030
19092
  :param _ZoneIds: 购买地域, 可通过查看DescribeCkafkaZone这个接口获取ZoneId
19031
19093
  :type ZoneIds: list of int
@@ -19033,7 +19095,7 @@ class InquireCkafkaPriceRequest(AbstractModel):
19033
19095
  :type CategoryAction: str
19034
19096
  :param _BillType: 国内站购买的版本, sv_ckafka_instance_s2_1(入门型), sv_ckafka_instance_s2_2(标准版), sv_ckafka_instance_s2_3(进阶型), 如果instanceType为standards2, 但该参数为空, 则默认值为sv_ckafka_instance_s2_1
19035
19097
  :type BillType: str
19036
- :param _PublicNetworkParam: 公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填)
19098
+ :param _PublicNetworkParam: 公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填),取值为3的倍数
19037
19099
  :type PublicNetworkParam: :class:`tencentcloud.ckafka.v20190819.models.InquiryPublicNetworkParam`
19038
19100
  :param _InstanceId: 续费时的实例id, 续费时填写
19039
19101
  :type InstanceId: str
@@ -19099,6 +19161,7 @@ class InquireCkafkaPriceRequest(AbstractModel):
19099
19161
  @property
19100
19162
  def InquiryDiskParam(self):
19101
19163
  """实例的硬盘购买类型以及大小 (购买时必填,专业版/高级版询价时磁盘信息必填)
19164
+
19102
19165
  :rtype: :class:`tencentcloud.ckafka.v20190819.models.InquiryDiskParam`
19103
19166
  """
19104
19167
  return self._InquiryDiskParam
@@ -19132,6 +19195,9 @@ class InquireCkafkaPriceRequest(AbstractModel):
19132
19195
  @property
19133
19196
  def Partition(self):
19134
19197
  """购买实例分区数, 单位个 (购买时必填,专业版/高级版询价时带宽信息必填)
19198
+ 分区上限 最大值: 40000,步长: 100
19199
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
19200
+
19135
19201
  :rtype: int
19136
19202
  """
19137
19203
  return self._Partition
@@ -19175,7 +19241,7 @@ class InquireCkafkaPriceRequest(AbstractModel):
19175
19241
 
19176
19242
  @property
19177
19243
  def PublicNetworkParam(self):
19178
- """公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填)
19244
+ """公网带宽计费模式, 目前只有专业版支持公网带宽 (购买公网带宽时必填),取值为3的倍数
19179
19245
  :rtype: :class:`tencentcloud.ckafka.v20190819.models.InquiryPublicNetworkParam`
19180
19246
  """
19181
19247
  return self._PublicNetworkParam
@@ -21586,16 +21652,22 @@ class InstanceScalingDownRequest(AbstractModel):
21586
21652
 
21587
21653
  def __init__(self):
21588
21654
  r"""
21589
- :param _InstanceId: ckafka集群实例Id
21655
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
21590
21656
  :type InstanceId: str
21591
21657
  :param _UpgradeStrategy: 缩容模式 1:稳定变配
21592
21658
  2.高速变配
21593
21659
  :type UpgradeStrategy: int
21594
- :param _DiskSize: 磁盘大小 单位 GB
21660
+ :param _DiskSize: 磁盘大小 单位 GB 最大值为500000,步长100
21661
+ 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
21662
+
21663
+
21595
21664
  :type DiskSize: int
21596
21665
  :param _BandWidth: 峰值带宽 单位 MB/s
21666
+ 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
21597
21667
  :type BandWidth: int
21598
- :param _Partition: 分区上限
21668
+ :param _Partition: 分区上限 最大值: 40000, 步长: 100
21669
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
21670
+
21599
21671
  :type Partition: int
21600
21672
  """
21601
21673
  self._InstanceId = None
@@ -21606,7 +21678,7 @@ class InstanceScalingDownRequest(AbstractModel):
21606
21678
 
21607
21679
  @property
21608
21680
  def InstanceId(self):
21609
- """ckafka集群实例Id
21681
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
21610
21682
  :rtype: str
21611
21683
  """
21612
21684
  return self._InstanceId
@@ -21629,7 +21701,10 @@ class InstanceScalingDownRequest(AbstractModel):
21629
21701
 
21630
21702
  @property
21631
21703
  def DiskSize(self):
21632
- """磁盘大小 单位 GB
21704
+ """磁盘大小 单位 GB 最大值为500000,步长100
21705
+ 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
21706
+
21707
+
21633
21708
  :rtype: int
21634
21709
  """
21635
21710
  return self._DiskSize
@@ -21641,6 +21716,7 @@ class InstanceScalingDownRequest(AbstractModel):
21641
21716
  @property
21642
21717
  def BandWidth(self):
21643
21718
  """峰值带宽 单位 MB/s
21719
+ 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
21644
21720
  :rtype: int
21645
21721
  """
21646
21722
  return self._BandWidth
@@ -21651,7 +21727,9 @@ class InstanceScalingDownRequest(AbstractModel):
21651
21727
 
21652
21728
  @property
21653
21729
  def Partition(self):
21654
- """分区上限
21730
+ """分区上限 最大值: 40000, 步长: 100
21731
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
21732
+
21655
21733
  :rtype: int
21656
21734
  """
21657
21735
  return self._Partition
@@ -23761,9 +23839,9 @@ class ModifyInstanceAttributesConfig(AbstractModel):
23761
23839
  r"""
23762
23840
  :param _AutoCreateTopicEnable: 自动创建 true 表示开启,false 表示不开启
23763
23841
  :type AutoCreateTopicEnable: bool
23764
- :param _DefaultNumPartitions: 可选,如果auto.create.topic.enable设置为true没有设置该值时,默认设置为3
23842
+ :param _DefaultNumPartitions: 新创建主题的默认分区数,如果AutoCreateTopicEnable设置为true没有设置该值时,默认设置为3
23765
23843
  :type DefaultNumPartitions: int
23766
- :param _DefaultReplicationFactor: 如果auto.create.topic.enable设置为true没有指定该值时默认设置为2
23844
+ :param _DefaultReplicationFactor: 新创建主题的默认副本数,如果AutoCreateTopicEnable设置为true没有指定该值时默认设置为2
23767
23845
  :type DefaultReplicationFactor: int
23768
23846
  """
23769
23847
  self._AutoCreateTopicEnable = None
@@ -23783,7 +23861,7 @@ class ModifyInstanceAttributesConfig(AbstractModel):
23783
23861
 
23784
23862
  @property
23785
23863
  def DefaultNumPartitions(self):
23786
- """可选,如果auto.create.topic.enable设置为true没有设置该值时,默认设置为3
23864
+ """新创建主题的默认分区数,如果AutoCreateTopicEnable设置为true没有设置该值时,默认设置为3
23787
23865
  :rtype: int
23788
23866
  """
23789
23867
  return self._DefaultNumPartitions
@@ -23794,7 +23872,7 @@ class ModifyInstanceAttributesConfig(AbstractModel):
23794
23872
 
23795
23873
  @property
23796
23874
  def DefaultReplicationFactor(self):
23797
- """如果auto.create.topic.enable设置为true没有指定该值时默认设置为2
23875
+ """新创建主题的默认副本数,如果AutoCreateTopicEnable设置为true没有指定该值时默认设置为2
23798
23876
  :rtype: int
23799
23877
  """
23800
23878
  return self._DefaultReplicationFactor
@@ -23825,9 +23903,9 @@ class ModifyInstanceAttributesRequest(AbstractModel):
23825
23903
 
23826
23904
  def __init__(self):
23827
23905
  r"""
23828
- :param _InstanceId: ckafka集群实例Id
23906
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
23829
23907
  :type InstanceId: str
23830
- :param _MsgRetentionTime: 实例日志的最长保留时间,单位分钟,最大90天,0代表不开启日志保留时间回收策略
23908
+ :param _MsgRetentionTime: 实例日志的最长保留时间,单位分钟,最大90天,最小为1min
23831
23909
  :type MsgRetentionTime: int
23832
23910
  :param _InstanceName: ckafka集群实例Name
23833
23911
  :type InstanceName: str
@@ -23843,7 +23921,7 @@ class ModifyInstanceAttributesRequest(AbstractModel):
23843
23921
  :type DynamicDiskConfig: :class:`tencentcloud.ckafka.v20190819.models.DynamicDiskConfig`
23844
23922
  :param _MaxMessageByte: 实例级别单条消息大小(单位byte) 最大 12582912(不包含) 最小1024(不包含)
23845
23923
  :type MaxMessageByte: int
23846
- :param _UncleanLeaderElectionEnable: 集群topic默认 unclean.leader.election.enable配置: 1 开启 0 关闭
23924
+ :param _UncleanLeaderElectionEnable: 是否允许未同步的副本选为 leader: 1 开启 0 关闭
23847
23925
  :type UncleanLeaderElectionEnable: int
23848
23926
  :param _DeleteProtectionEnable: 实例删除保护开关: 1 开启 0 关闭
23849
23927
  :type DeleteProtectionEnable: int
@@ -23862,7 +23940,7 @@ class ModifyInstanceAttributesRequest(AbstractModel):
23862
23940
 
23863
23941
  @property
23864
23942
  def InstanceId(self):
23865
- """ckafka集群实例Id
23943
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
23866
23944
  :rtype: str
23867
23945
  """
23868
23946
  return self._InstanceId
@@ -23873,7 +23951,7 @@ class ModifyInstanceAttributesRequest(AbstractModel):
23873
23951
 
23874
23952
  @property
23875
23953
  def MsgRetentionTime(self):
23876
- """实例日志的最长保留时间,单位分钟,最大90天,0代表不开启日志保留时间回收策略
23954
+ """实例日志的最长保留时间,单位分钟,最大90天,最小为1min
23877
23955
  :rtype: int
23878
23956
  """
23879
23957
  return self._MsgRetentionTime
@@ -23965,7 +24043,7 @@ class ModifyInstanceAttributesRequest(AbstractModel):
23965
24043
 
23966
24044
  @property
23967
24045
  def UncleanLeaderElectionEnable(self):
23968
- """集群topic默认 unclean.leader.election.enable配置: 1 开启 0 关闭
24046
+ """是否允许未同步的副本选为 leader: 1 开启 0 关闭
23969
24047
  :rtype: int
23970
24048
  """
23971
24049
  return self._UncleanLeaderElectionEnable
@@ -24066,13 +24144,18 @@ class ModifyInstancePreRequest(AbstractModel):
24066
24144
 
24067
24145
  def __init__(self):
24068
24146
  r"""
24069
- :param _InstanceId: ckafka集群实例Id
24147
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
24070
24148
  :type InstanceId: str
24071
- :param _DiskSize: 预计磁盘,根据磁盘步长,规格向上调整。
24149
+ :param _DiskSize: 磁盘大小 单位 GB 最大值为500000,步长100
24150
+ 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
24151
+
24072
24152
  :type DiskSize: int
24073
- :param _BandWidth: 预计带宽,根据带宽步长,规格向上调整。
24153
+ :param _BandWidth: 峰值带宽 单位 MB/s
24154
+ 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
24155
+
24074
24156
  :type BandWidth: int
24075
- :param _Partition: 预计分区,根据带宽步长,规格向上调整。
24157
+ :param _Partition: 分区上限 最大值: 40000, 步长: 100
24158
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
24076
24159
  :type Partition: int
24077
24160
  """
24078
24161
  self._InstanceId = None
@@ -24082,7 +24165,7 @@ class ModifyInstancePreRequest(AbstractModel):
24082
24165
 
24083
24166
  @property
24084
24167
  def InstanceId(self):
24085
- """ckafka集群实例Id
24168
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
24086
24169
  :rtype: str
24087
24170
  """
24088
24171
  return self._InstanceId
@@ -24093,7 +24176,9 @@ class ModifyInstancePreRequest(AbstractModel):
24093
24176
 
24094
24177
  @property
24095
24178
  def DiskSize(self):
24096
- """预计磁盘,根据磁盘步长,规格向上调整。
24179
+ """磁盘大小 单位 GB 最大值为500000,步长100
24180
+ 可以通过以下链接查看规格限制:https://cloud.tencent.com/document/product/597/122562
24181
+
24097
24182
  :rtype: int
24098
24183
  """
24099
24184
  return self._DiskSize
@@ -24104,7 +24189,9 @@ class ModifyInstancePreRequest(AbstractModel):
24104
24189
 
24105
24190
  @property
24106
24191
  def BandWidth(self):
24107
- """预计带宽,根据带宽步长,规格向上调整。
24192
+ """峰值带宽 单位 MB/s
24193
+ 可以通过以下链接查看规格限制及对应步长: https://cloud.tencent.com/document/product/597/11745
24194
+
24108
24195
  :rtype: int
24109
24196
  """
24110
24197
  return self._BandWidth
@@ -24115,7 +24202,8 @@ class ModifyInstancePreRequest(AbstractModel):
24115
24202
 
24116
24203
  @property
24117
24204
  def Partition(self):
24118
- """预计分区,根据带宽步长,规格向上调整。
24205
+ """分区上限 最大值: 40000, 步长: 100
24206
+ 可以通过以下链接查看规格限制: https://cloud.tencent.com/document/product/597/122563
24119
24207
  :rtype: int
24120
24208
  """
24121
24209
  return self._Partition
@@ -24192,9 +24280,9 @@ class ModifyPasswordRequest(AbstractModel):
24192
24280
 
24193
24281
  def __init__(self):
24194
24282
  r"""
24195
- :param _InstanceId: 实例Id
24283
+ :param _InstanceId: 实例Id,可通过DescribeInstances接口获取。
24196
24284
  :type InstanceId: str
24197
- :param _Name: 用户名称
24285
+ :param _Name: 用户名称,可通过DescribeUser接口获取。
24198
24286
  :type Name: str
24199
24287
  :param _Password: 用户当前密码
24200
24288
  :type Password: str
@@ -24208,7 +24296,7 @@ class ModifyPasswordRequest(AbstractModel):
24208
24296
 
24209
24297
  @property
24210
24298
  def InstanceId(self):
24211
- """实例Id
24299
+ """实例Id,可通过DescribeInstances接口获取。
24212
24300
  :rtype: str
24213
24301
  """
24214
24302
  return self._InstanceId
@@ -24219,7 +24307,7 @@ class ModifyPasswordRequest(AbstractModel):
24219
24307
 
24220
24308
  @property
24221
24309
  def Name(self):
24222
- """用户名称
24310
+ """用户名称,可通过DescribeUser接口获取。
24223
24311
  :rtype: str
24224
24312
  """
24225
24313
  return self._Name
@@ -24318,9 +24406,9 @@ class ModifyRoutineMaintenanceTaskRequest(AbstractModel):
24318
24406
 
24319
24407
  def __init__(self):
24320
24408
  r"""
24321
- :param _InstanceId: 实例id
24409
+ :param _InstanceId: ckafka集群实例id,可通过DescribeInstances接口获取
24322
24410
  :type InstanceId: str
24323
- :param _MaintenanceType: 自动化运维类别
24411
+ :param _MaintenanceType: 自动化运维类别, 类别如下: QUOTA、ANALYSIS、RE_BALANCE、ELASTIC_BANDWIDTH
24324
24412
  :type MaintenanceType: str
24325
24413
  :param _MaintenanceSubtype: INSTANCE_STORAGE_CAPACITY(磁盘自动扩容)/MESSAGE_RETENTION_PERIOD(磁盘动态消息保留策略)
24326
24414
  :type MaintenanceSubtype: str
@@ -24336,7 +24424,7 @@ class ModifyRoutineMaintenanceTaskRequest(AbstractModel):
24336
24424
  :type PlannedTime: int
24337
24425
  :param _ExtraConfig: 任务额外信息
24338
24426
  :type ExtraConfig: str
24339
- :param _Status: 任务状态
24427
+ :param _Status: 任务状态,0 开启,1 关闭
24340
24428
  :type Status: int
24341
24429
  :param _Week: 执行week day
24342
24430
  :type Week: str
@@ -24355,7 +24443,7 @@ class ModifyRoutineMaintenanceTaskRequest(AbstractModel):
24355
24443
 
24356
24444
  @property
24357
24445
  def InstanceId(self):
24358
- """实例id
24446
+ """ckafka集群实例id,可通过DescribeInstances接口获取
24359
24447
  :rtype: str
24360
24448
  """
24361
24449
  return self._InstanceId
@@ -24366,7 +24454,7 @@ class ModifyRoutineMaintenanceTaskRequest(AbstractModel):
24366
24454
 
24367
24455
  @property
24368
24456
  def MaintenanceType(self):
24369
- """自动化运维类别
24457
+ """自动化运维类别, 类别如下: QUOTA、ANALYSIS、RE_BALANCE、ELASTIC_BANDWIDTH
24370
24458
  :rtype: str
24371
24459
  """
24372
24460
  return self._MaintenanceType
@@ -24454,7 +24542,7 @@ class ModifyRoutineMaintenanceTaskRequest(AbstractModel):
24454
24542
 
24455
24543
  @property
24456
24544
  def Status(self):
24457
- """任务状态
24545
+ """任务状态,0 开启,1 关闭
24458
24546
  :rtype: int
24459
24547
  """
24460
24548
  return self._Status
@@ -27833,7 +27921,7 @@ class RenewCkafkaInstanceRequest(AbstractModel):
27833
27921
 
27834
27922
  def __init__(self):
27835
27923
  r"""
27836
- :param _InstanceId: ckafka集群实例Id
27924
+ :param _InstanceId: ckafka集群实例Id,可通过DescribeInstances接口获取
27837
27925
  :type InstanceId: str
27838
27926
  :param _TimeSpan: 续费时长, 默认为1, 单位是月
27839
27927
  :type TimeSpan: int
@@ -27843,7 +27931,7 @@ class RenewCkafkaInstanceRequest(AbstractModel):
27843
27931
 
27844
27932
  @property
27845
27933
  def InstanceId(self):
27846
- """ckafka集群实例Id
27934
+ """ckafka集群实例Id,可通过DescribeInstances接口获取
27847
27935
  :rtype: str
27848
27936
  """
27849
27937
  return self._InstanceId
@@ -30911,9 +30999,9 @@ class TopicMessageHeapRanking(AbstractModel):
30911
30999
  :type PartitionNum: int
30912
31000
  :param _ReplicaNum: 副本数
30913
31001
  :type ReplicaNum: int
30914
- :param _TopicTraffic: Topic 流量
31002
+ :param _TopicTraffic: Topic 流量,单位为MB。
30915
31003
  :type TopicTraffic: str
30916
- :param _MessageHeap: topic消息堆积/占用磁盘
31004
+ :param _MessageHeap: topic消息堆积/占用磁盘,单位为Bytes。
30917
31005
  :type MessageHeap: int
30918
31006
  """
30919
31007
  self._TopicId = None
@@ -30969,7 +31057,7 @@ class TopicMessageHeapRanking(AbstractModel):
30969
31057
 
30970
31058
  @property
30971
31059
  def TopicTraffic(self):
30972
- """Topic 流量
31060
+ """Topic 流量,单位为MB。
30973
31061
  :rtype: str
30974
31062
  """
30975
31063
  return self._TopicTraffic
@@ -30980,7 +31068,7 @@ class TopicMessageHeapRanking(AbstractModel):
30980
31068
 
30981
31069
  @property
30982
31070
  def MessageHeap(self):
30983
- """topic消息堆积/占用磁盘
31071
+ """topic消息堆积/占用磁盘,单位为Bytes。
30984
31072
  :rtype: int
30985
31073
  """
30986
31074
  return self._MessageHeap
@@ -31146,7 +31234,7 @@ class TopicPartitionDO(AbstractModel):
31146
31234
  r"""
31147
31235
  :param _Partition: Partition 分区ID
31148
31236
  :type Partition: int
31149
- :param _LeaderStatus: Leader 运行状态
31237
+ :param _LeaderStatus: Leader 运行状态,0表示正常运行
31150
31238
  :type LeaderStatus: int
31151
31239
  :param _IsrNum: ISR 个数
31152
31240
  :type IsrNum: int
@@ -31171,7 +31259,7 @@ class TopicPartitionDO(AbstractModel):
31171
31259
 
31172
31260
  @property
31173
31261
  def LeaderStatus(self):
31174
- """Leader 运行状态
31262
+ """Leader 运行状态,0表示正常运行
31175
31263
  :rtype: int
31176
31264
  """
31177
31265
  return self._LeaderStatus
@@ -32281,7 +32369,7 @@ class ZoneInfo(AbstractModel):
32281
32369
  :type Flag: bool
32282
32370
  :param _ZoneName: 可用区名称
32283
32371
  :type ZoneName: str
32284
- :param _ZoneStatus: 可用区状态
32372
+ :param _ZoneStatus: 可用区状态 枚举示例: 3: 开启,4: 关闭; 可用区状态以SoldOut为准
32285
32373
  :type ZoneStatus: int
32286
32374
  :param _Exflag: 额外标识
32287
32375
  :type Exflag: str
@@ -32360,7 +32448,7 @@ class ZoneInfo(AbstractModel):
32360
32448
 
32361
32449
  @property
32362
32450
  def ZoneStatus(self):
32363
- """可用区状态
32451
+ """可用区状态 枚举示例: 3: 开启,4: 关闭; 可用区状态以SoldOut为准
32364
32452
  :rtype: int
32365
32453
  """
32366
32454
  return self._ZoneStatus