tencentcloud-sdk-python 3.0.1408__py2.py3-none-any.whl → 3.0.1410__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 (50) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/bh/v20230418/bh_client.py +138 -0
  3. tencentcloud/bh/v20230418/errorcodes.py +3 -0
  4. tencentcloud/bh/v20230418/models.py +1006 -67
  5. tencentcloud/ccc/v20200210/models.py +2 -2
  6. tencentcloud/cdb/v20170320/cdb_client.py +25 -19
  7. tencentcloud/cdb/v20170320/errorcodes.py +0 -3
  8. tencentcloud/cdb/v20170320/models.py +274 -202
  9. tencentcloud/common/credential.py +2 -3
  10. tencentcloud/csip/v20221121/models.py +45 -4
  11. tencentcloud/cvm/v20170312/models.py +15 -0
  12. tencentcloud/cwp/v20180228/models.py +165 -0
  13. tencentcloud/cynosdb/v20190107/models.py +45 -0
  14. tencentcloud/dsgc/v20190723/dsgc_client.py +1 -3
  15. tencentcloud/dsgc/v20190723/models.py +342 -15
  16. tencentcloud/emr/v20190103/emr_client.py +23 -0
  17. tencentcloud/emr/v20190103/models.py +500 -0
  18. tencentcloud/es/v20180416/errorcodes.py +42 -0
  19. tencentcloud/ess/v20201111/errorcodes.py +24 -0
  20. tencentcloud/ess/v20201111/ess_client.py +1 -0
  21. tencentcloud/ess/v20201111/models.py +33 -4
  22. tencentcloud/essbasic/v20210526/errorcodes.py +24 -0
  23. tencentcloud/essbasic/v20210526/essbasic_client.py +1 -0
  24. tencentcloud/gs/v20191118/models.py +15 -0
  25. tencentcloud/kms/v20190118/errorcodes.py +36 -0
  26. tencentcloud/kms/v20190118/kms_client.py +345 -0
  27. tencentcloud/kms/v20190118/models.py +3437 -1534
  28. tencentcloud/lighthouse/v20200324/errorcodes.py +21 -0
  29. tencentcloud/live/v20180801/models.py +15 -0
  30. tencentcloud/lke/v20231130/lke_client.py +92 -0
  31. tencentcloud/lke/v20231130/models.py +2702 -572
  32. tencentcloud/mqtt/v20240516/models.py +120 -0
  33. tencentcloud/organization/v20210331/models.py +15 -0
  34. tencentcloud/partners/v20180321/models.py +4 -4
  35. tencentcloud/postgres/v20170312/models.py +4 -0
  36. tencentcloud/ses/v20201002/models.py +0 -8
  37. tencentcloud/tcss/v20201101/models.py +15 -0
  38. tencentcloud/thpc/v20230321/models.py +47 -2
  39. tencentcloud/tione/v20211111/models.py +15 -0
  40. tencentcloud/trocket/v20230308/models.py +476 -238
  41. tencentcloud/trocket/v20230308/trocket_client.py +58 -17
  42. tencentcloud/vpc/v20170312/models.py +15 -0
  43. tencentcloud/waf/v20180125/models.py +110 -18
  44. tencentcloud/wedata/v20210820/models.py +764 -4
  45. tencentcloud/wedata/v20210820/wedata_client.py +48 -2
  46. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/METADATA +1 -1
  47. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/RECORD +50 -50
  48. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/LICENSE +0 -0
  49. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/WHEEL +0 -0
  50. {tencentcloud_sdk_python-3.0.1408.dist-info → tencentcloud_sdk_python-3.0.1410.dist-info}/top_level.txt +0 -0
@@ -25,9 +25,12 @@ class Account(AbstractModel):
25
25
 
26
26
  def __init__(self):
27
27
  r"""
28
- :param _User: 新账户的名称
28
+ :param _User: 账号名,可输入1 - 32个字符。
29
29
  :type User: str
30
- :param _Host: 新账户的域名
30
+ :param _Host: 账号的主机。
31
+ 说明:
32
+ 1. IP 形式,支持填入%。
33
+ 2. 多个主机以分隔符分隔,分隔符支持;,|换行符和空格。
31
34
  :type Host: str
32
35
  """
33
36
  self._User = None
@@ -35,7 +38,7 @@ class Account(AbstractModel):
35
38
 
36
39
  @property
37
40
  def User(self):
38
- """新账户的名称
41
+ """账号名,可输入1 - 32个字符。
39
42
  :rtype: str
40
43
  """
41
44
  return self._User
@@ -46,7 +49,10 @@ class Account(AbstractModel):
46
49
 
47
50
  @property
48
51
  def Host(self):
49
- """新账户的域名
52
+ """账号的主机。
53
+ 说明:
54
+ 1. IP 形式,支持填入%。
55
+ 2. 多个主机以分隔符分隔,分隔符支持;,|换行符和空格。
50
56
  :rtype: str
51
57
  """
52
58
  return self._Host
@@ -531,16 +537,17 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
531
537
 
532
538
  def __init__(self):
533
539
  r"""
534
- :param _ProxyGroupId: 代理组ID
540
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
535
541
  :type ProxyGroupId: str
536
542
  :param _WeightMode: 权重分配模式,
537
543
  系统自动分配:"system", 自定义:"custom"
538
544
  :type WeightMode: str
539
545
  :param _IsKickOut: 是否开启延迟剔除,取值:"true" | "false"
540
546
  :type IsKickOut: bool
541
- :param _MinCount: 最小保留数量,最小取值:0
547
+ :param _MinCount: 最小保留数量,最小取值:0
548
+ 说明:当 IsKickOut 为 true 时才有效。
542
549
  :type MinCount: int
543
- :param _MaxDelay: 延迟剔除阈值,最小取值:0
550
+ :param _MaxDelay: 延迟剔除阈值,最小取值:1,取值范围:[1,10000],整数。
544
551
  :type MaxDelay: int
545
552
  :param _FailOver: 是否开启故障转移,取值:"true" | "false"
546
553
  :type FailOver: bool
@@ -548,18 +555,18 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
548
555
  :type AutoAddRo: bool
549
556
  :param _ReadOnly: 是否是只读,取值:"true" | "false"
550
557
  :type ReadOnly: bool
551
- :param _ProxyAddressId: 代理组地址ID
558
+ :param _ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
552
559
  :type ProxyAddressId: str
553
- :param _TransSplit: 是否开启事务分离,取值:"true" | "false"
560
+ :param _TransSplit: 是否开启事务分离,取值:"true" | "false",默认值 false。
554
561
  :type TransSplit: bool
555
- :param _ConnectionPool: 是否开启连接池
562
+ :param _ConnectionPool: 是否开启连接池。默认关闭。
556
563
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
557
564
  :type ConnectionPool: bool
558
565
  :param _ProxyAllocation: 读写权重分配。如果 WeightMode 传的是 system ,则传入的权重不生效,由系统分配默认权重。
559
566
  :type ProxyAllocation: list of ProxyAllocation
560
- :param _AutoLoadBalance: 是否开启自适应负载均衡
567
+ :param _AutoLoadBalance: 是否开启自适应负载均衡。默认关闭。
561
568
  :type AutoLoadBalance: bool
562
- :param _AccessMode: 访问模式:就近访问,均衡分配
569
+ :param _AccessMode: 访问模式:nearby - 就近访问,balance - 均衡分配,默认就近访问。
563
570
  :type AccessMode: str
564
571
  """
565
572
  self._ProxyGroupId = None
@@ -579,7 +586,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
579
586
 
580
587
  @property
581
588
  def ProxyGroupId(self):
582
- """代理组ID
589
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
583
590
  :rtype: str
584
591
  """
585
592
  return self._ProxyGroupId
@@ -613,7 +620,8 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
613
620
 
614
621
  @property
615
622
  def MinCount(self):
616
- """最小保留数量,最小取值:0
623
+ """最小保留数量,最小取值:0
624
+ 说明:当 IsKickOut 为 true 时才有效。
617
625
  :rtype: int
618
626
  """
619
627
  return self._MinCount
@@ -624,7 +632,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
624
632
 
625
633
  @property
626
634
  def MaxDelay(self):
627
- """延迟剔除阈值,最小取值:0
635
+ """延迟剔除阈值,最小取值:1,取值范围:[1,10000],整数。
628
636
  :rtype: int
629
637
  """
630
638
  return self._MaxDelay
@@ -668,7 +676,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
668
676
 
669
677
  @property
670
678
  def ProxyAddressId(self):
671
- """代理组地址ID
679
+ """代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
672
680
  :rtype: str
673
681
  """
674
682
  return self._ProxyAddressId
@@ -679,7 +687,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
679
687
 
680
688
  @property
681
689
  def TransSplit(self):
682
- """是否开启事务分离,取值:"true" | "false"
690
+ """是否开启事务分离,取值:"true" | "false",默认值 false。
683
691
  :rtype: bool
684
692
  """
685
693
  return self._TransSplit
@@ -690,7 +698,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
690
698
 
691
699
  @property
692
700
  def ConnectionPool(self):
693
- """是否开启连接池
701
+ """是否开启连接池。默认关闭。
694
702
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
695
703
  :rtype: bool
696
704
  """
@@ -713,7 +721,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
713
721
 
714
722
  @property
715
723
  def AutoLoadBalance(self):
716
- """是否开启自适应负载均衡
724
+ """是否开启自适应负载均衡。默认关闭。
717
725
  :rtype: bool
718
726
  """
719
727
  return self._AutoLoadBalance
@@ -724,7 +732,7 @@ class AdjustCdbProxyAddressRequest(AbstractModel):
724
732
 
725
733
  @property
726
734
  def AccessMode(self):
727
- """访问模式:就近访问,均衡分配
735
+ """访问模式:nearby - 就近访问,balance - 均衡分配,默认就近访问。
728
736
  :rtype: str
729
737
  """
730
738
  return self._AccessMode
@@ -814,9 +822,9 @@ class AdjustCdbProxyRequest(AbstractModel):
814
822
 
815
823
  def __init__(self):
816
824
  r"""
817
- :param _InstanceId: 实例ID
825
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
818
826
  :type InstanceId: str
819
- :param _ProxyGroupId: 代理组ID
827
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
820
828
  :type ProxyGroupId: str
821
829
  :param _ProxyNodeCustom: 节点规格配置
822
830
  备注:数据库代理支持的节点规格为:2C4000MB、4C8000MB、8C16000MB。
@@ -840,7 +848,7 @@ Mem:单个代理节点内存数(单位:MB)
840
848
 
841
849
  @property
842
850
  def InstanceId(self):
843
- """实例ID
851
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
844
852
  :rtype: str
845
853
  """
846
854
  return self._InstanceId
@@ -851,7 +859,7 @@ Mem:单个代理节点内存数(单位:MB)
851
859
 
852
860
  @property
853
861
  def ProxyGroupId(self):
854
- """代理组ID
862
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
855
863
  :rtype: str
856
864
  """
857
865
  return self._ProxyGroupId
@@ -1179,7 +1187,7 @@ class AnalyzeAuditLogsRequest(AbstractModel):
1179
1187
 
1180
1188
  def __init__(self):
1181
1189
  r"""
1182
- :param _InstanceId: 实例ID
1190
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
1183
1191
  :type InstanceId: str
1184
1192
  :param _StartTime: 要分析的日志开始时间,格式为:"2023-02-16 00:00:20"。
1185
1193
  :type StartTime: str
@@ -1201,7 +1209,7 @@ class AnalyzeAuditLogsRequest(AbstractModel):
1201
1209
 
1202
1210
  @property
1203
1211
  def InstanceId(self):
1204
- """实例ID
1212
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
1205
1213
  :rtype: str
1206
1214
  """
1207
1215
  return self._InstanceId
@@ -5424,14 +5432,14 @@ class CloseAuditServiceRequest(AbstractModel):
5424
5432
 
5425
5433
  def __init__(self):
5426
5434
  r"""
5427
- :param _InstanceId: 实例ID
5435
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5428
5436
  :type InstanceId: str
5429
5437
  """
5430
5438
  self._InstanceId = None
5431
5439
 
5432
5440
  @property
5433
5441
  def InstanceId(self):
5434
- """实例ID
5442
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5435
5443
  :rtype: str
5436
5444
  """
5437
5445
  return self._InstanceId
@@ -5488,9 +5496,9 @@ class CloseCDBProxyRequest(AbstractModel):
5488
5496
 
5489
5497
  def __init__(self):
5490
5498
  r"""
5491
- :param _InstanceId: 实例ID
5499
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5492
5500
  :type InstanceId: str
5493
- :param _ProxyGroupId: 代理组ID
5501
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
5494
5502
  :type ProxyGroupId: str
5495
5503
  :param _OnlyCloseRW: 是否只关闭读写分离,取值:"true" | "false",默认为"false"
5496
5504
  :type OnlyCloseRW: bool
@@ -5501,7 +5509,7 @@ class CloseCDBProxyRequest(AbstractModel):
5501
5509
 
5502
5510
  @property
5503
5511
  def InstanceId(self):
5504
- """实例ID
5512
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5505
5513
  :rtype: str
5506
5514
  """
5507
5515
  return self._InstanceId
@@ -5512,7 +5520,7 @@ class CloseCDBProxyRequest(AbstractModel):
5512
5520
 
5513
5521
  @property
5514
5522
  def ProxyGroupId(self):
5515
- """代理组ID
5523
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
5516
5524
  :rtype: str
5517
5525
  """
5518
5526
  return self._ProxyGroupId
@@ -5582,9 +5590,9 @@ class CloseCdbProxyAddressRequest(AbstractModel):
5582
5590
 
5583
5591
  def __init__(self):
5584
5592
  r"""
5585
- :param _ProxyGroupId: 代理组ID
5593
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
5586
5594
  :type ProxyGroupId: str
5587
- :param _ProxyAddressId: 代理组地址ID
5595
+ :param _ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
5588
5596
  :type ProxyAddressId: str
5589
5597
  """
5590
5598
  self._ProxyGroupId = None
@@ -5592,7 +5600,7 @@ class CloseCdbProxyAddressRequest(AbstractModel):
5592
5600
 
5593
5601
  @property
5594
5602
  def ProxyGroupId(self):
5595
- """代理组ID
5603
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
5596
5604
  :rtype: str
5597
5605
  """
5598
5606
  return self._ProxyGroupId
@@ -5603,7 +5611,7 @@ class CloseCdbProxyAddressRequest(AbstractModel):
5603
5611
 
5604
5612
  @property
5605
5613
  def ProxyAddressId(self):
5606
- """代理组地址ID
5614
+ """代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
5607
5615
  :rtype: str
5608
5616
  """
5609
5617
  return self._ProxyAddressId
@@ -5661,9 +5669,9 @@ class CloseSSLRequest(AbstractModel):
5661
5669
 
5662
5670
  def __init__(self):
5663
5671
  r"""
5664
- :param _InstanceId: 实例 ID 。只读组 ID为空时必填。
5672
+ :param _InstanceId: 实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5665
5673
  :type InstanceId: str
5666
- :param _RoGroupId: 只读组 ID。实例 ID为空时必填。
5674
+ :param _RoGroupId: 只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
5667
5675
  :type RoGroupId: str
5668
5676
  """
5669
5677
  self._InstanceId = None
@@ -5671,7 +5679,7 @@ class CloseSSLRequest(AbstractModel):
5671
5679
 
5672
5680
  @property
5673
5681
  def InstanceId(self):
5674
- """实例 ID 。只读组 ID为空时必填。
5682
+ """实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5675
5683
  :rtype: str
5676
5684
  """
5677
5685
  return self._InstanceId
@@ -5682,7 +5690,7 @@ class CloseSSLRequest(AbstractModel):
5682
5690
 
5683
5691
  @property
5684
5692
  def RoGroupId(self):
5685
- """只读组 ID。实例 ID为空时必填。
5693
+ """只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
5686
5694
  :rtype: str
5687
5695
  """
5688
5696
  return self._RoGroupId
@@ -6933,15 +6941,15 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6933
6941
 
6934
6942
  def __init__(self):
6935
6943
  r"""
6936
- :param _RuleFilters: 审计规则
6944
+ :param _RuleFilters: 审计规则。
6937
6945
  :type RuleFilters: list of RuleFilters
6938
- :param _RuleTemplateName: 规则模板名称
6946
+ :param _RuleTemplateName: 规则模板名称。最多支持输入30个字符。
6939
6947
  :type RuleTemplateName: str
6940
- :param _Description: 规则模板描述
6948
+ :param _Description: 规则模板描述。最多支持输入200个字符。
6941
6949
  :type Description: str
6942
- :param _AlarmLevel: 告警等级。1-低风险,2-中风险,3-高风险
6950
+ :param _AlarmLevel: 告警等级。1 - 低风险,2 - 中风险,3 - 高风险。默认值为1。
6943
6951
  :type AlarmLevel: int
6944
- :param _AlarmPolicy: 告警策略。0-不告警,1-告警
6952
+ :param _AlarmPolicy: 告警策略。0 - 不告警,1 - 告警。默认值为0。
6945
6953
  :type AlarmPolicy: int
6946
6954
  """
6947
6955
  self._RuleFilters = None
@@ -6952,7 +6960,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6952
6960
 
6953
6961
  @property
6954
6962
  def RuleFilters(self):
6955
- """审计规则
6963
+ """审计规则。
6956
6964
  :rtype: list of RuleFilters
6957
6965
  """
6958
6966
  return self._RuleFilters
@@ -6963,7 +6971,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6963
6971
 
6964
6972
  @property
6965
6973
  def RuleTemplateName(self):
6966
- """规则模板名称
6974
+ """规则模板名称。最多支持输入30个字符。
6967
6975
  :rtype: str
6968
6976
  """
6969
6977
  return self._RuleTemplateName
@@ -6974,7 +6982,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6974
6982
 
6975
6983
  @property
6976
6984
  def Description(self):
6977
- """规则模板描述
6985
+ """规则模板描述。最多支持输入200个字符。
6978
6986
  :rtype: str
6979
6987
  """
6980
6988
  return self._Description
@@ -6985,7 +6993,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6985
6993
 
6986
6994
  @property
6987
6995
  def AlarmLevel(self):
6988
- """告警等级。1-低风险,2-中风险,3-高风险
6996
+ """告警等级。1 - 低风险,2 - 中风险,3 - 高风险。默认值为1。
6989
6997
  :rtype: int
6990
6998
  """
6991
6999
  return self._AlarmLevel
@@ -6996,7 +7004,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6996
7004
 
6997
7005
  @property
6998
7006
  def AlarmPolicy(self):
6999
- """告警策略。0-不告警,1-告警
7007
+ """告警策略。0 - 不告警,1 - 告警。默认值为0。
7000
7008
  :rtype: int
7001
7009
  """
7002
7010
  return self._AlarmPolicy
@@ -7223,7 +7231,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7223
7231
 
7224
7232
  def __init__(self):
7225
7233
  r"""
7226
- :param _ProxyGroupId: 代理组ID
7234
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
7227
7235
  :type ProxyGroupId: str
7228
7236
  :param _WeightMode: 权重分配模式,
7229
7237
  系统自动分配:"system", 自定义:"custom"
@@ -7232,7 +7240,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7232
7240
  :type IsKickOut: bool
7233
7241
  :param _MinCount: 最小保留数量,最小取值:0
7234
7242
  :type MinCount: int
7235
- :param _MaxDelay: 延迟剔除阈值,最小取值:0
7243
+ :param _MaxDelay: 延迟剔除阈值,最小取值:1,范围:1 - 10000,整数。
7236
7244
  :type MaxDelay: int
7237
7245
  :param _FailOver: 是否开启故障转移,取值:"true" | "false"
7238
7246
  :type FailOver: bool
@@ -7244,26 +7252,26 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7244
7252
  :type TransSplit: bool
7245
7253
  :param _ProxyAllocation: 读写权重分配
7246
7254
  :type ProxyAllocation: list of ProxyAllocation
7247
- :param _UniqVpcId: 私有网络ID
7255
+ :param _UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7248
7256
  :type UniqVpcId: str
7249
- :param _UniqSubnetId: 私有子网ID
7257
+ :param _UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7250
7258
  :type UniqSubnetId: str
7251
- :param _ConnectionPool: 是否开启连接池
7259
+ :param _ConnectionPool: 是否开启连接池。默认关闭。
7252
7260
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
7253
7261
  :type ConnectionPool: bool
7254
7262
  :param _Desc: 描述
7255
7263
  :type Desc: str
7256
- :param _Vip: IP地址
7264
+ :param _Vip: IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。
7257
7265
  :type Vip: str
7258
- :param _VPort: 端口
7266
+ :param _VPort: 端口。默认值3306。
7259
7267
  :type VPort: int
7260
7268
  :param _SecurityGroup: 安全组
7261
7269
  :type SecurityGroup: list of str
7262
- :param _ConnectionPoolType: 连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool为true时生效。
7270
+ :param _ConnectionPoolType: 连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool true 时生效。默认值:connection。
7263
7271
  :type ConnectionPoolType: str
7264
- :param _AutoLoadBalance: 是否自适应负载均衡
7272
+ :param _AutoLoadBalance: 是否开启自适应负载均衡。默认关闭。
7265
7273
  :type AutoLoadBalance: bool
7266
- :param _AccessMode: 接入模式
7274
+ :param _AccessMode: 接入模式。nearBy - 就近访问,balance - 均衡分配,默认值:nearBy。
7267
7275
  :type AccessMode: str
7268
7276
  """
7269
7277
  self._ProxyGroupId = None
@@ -7289,7 +7297,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7289
7297
 
7290
7298
  @property
7291
7299
  def ProxyGroupId(self):
7292
- """代理组ID
7300
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
7293
7301
  :rtype: str
7294
7302
  """
7295
7303
  return self._ProxyGroupId
@@ -7334,7 +7342,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7334
7342
 
7335
7343
  @property
7336
7344
  def MaxDelay(self):
7337
- """延迟剔除阈值,最小取值:0
7345
+ """延迟剔除阈值,最小取值:1,范围:1 - 10000,整数。
7338
7346
  :rtype: int
7339
7347
  """
7340
7348
  return self._MaxDelay
@@ -7400,7 +7408,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7400
7408
 
7401
7409
  @property
7402
7410
  def UniqVpcId(self):
7403
- """私有网络ID
7411
+ """私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7404
7412
  :rtype: str
7405
7413
  """
7406
7414
  return self._UniqVpcId
@@ -7411,7 +7419,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7411
7419
 
7412
7420
  @property
7413
7421
  def UniqSubnetId(self):
7414
- """私有子网ID
7422
+ """私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7415
7423
  :rtype: str
7416
7424
  """
7417
7425
  return self._UniqSubnetId
@@ -7422,7 +7430,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7422
7430
 
7423
7431
  @property
7424
7432
  def ConnectionPool(self):
7425
- """是否开启连接池
7433
+ """是否开启连接池。默认关闭。
7426
7434
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
7427
7435
  :rtype: bool
7428
7436
  """
@@ -7445,7 +7453,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7445
7453
 
7446
7454
  @property
7447
7455
  def Vip(self):
7448
- """IP地址
7456
+ """IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。
7449
7457
  :rtype: str
7450
7458
  """
7451
7459
  return self._Vip
@@ -7456,7 +7464,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7456
7464
 
7457
7465
  @property
7458
7466
  def VPort(self):
7459
- """端口
7467
+ """端口。默认值3306。
7460
7468
  :rtype: int
7461
7469
  """
7462
7470
  return self._VPort
@@ -7478,7 +7486,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7478
7486
 
7479
7487
  @property
7480
7488
  def ConnectionPoolType(self):
7481
- """连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool为true时生效。
7489
+ """连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool true 时生效。默认值:connection。
7482
7490
  :rtype: str
7483
7491
  """
7484
7492
  return self._ConnectionPoolType
@@ -7489,7 +7497,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7489
7497
 
7490
7498
  @property
7491
7499
  def AutoLoadBalance(self):
7492
- """是否自适应负载均衡
7500
+ """是否开启自适应负载均衡。默认关闭。
7493
7501
  :rtype: bool
7494
7502
  """
7495
7503
  return self._AutoLoadBalance
@@ -7500,7 +7508,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7500
7508
 
7501
7509
  @property
7502
7510
  def AccessMode(self):
7503
- """接入模式
7511
+ """接入模式。nearBy - 就近访问,balance - 均衡分配,默认值:nearBy。
7504
7512
  :rtype: str
7505
7513
  """
7506
7514
  return self._AccessMode
@@ -7596,11 +7604,11 @@ class CreateCdbProxyRequest(AbstractModel):
7596
7604
 
7597
7605
  def __init__(self):
7598
7606
  r"""
7599
- :param _InstanceId: 实例ID
7607
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7600
7608
  :type InstanceId: str
7601
- :param _UniqVpcId: 私有网络ID
7609
+ :param _UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7602
7610
  :type UniqVpcId: str
7603
- :param _UniqSubnetId: 私有子网ID
7611
+ :param _UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7604
7612
  :type UniqSubnetId: str
7605
7613
  :param _ProxyNodeCustom: 节点规格配置。
7606
7614
  示例中参数说明:
@@ -7634,7 +7642,7 @@ Mem:单个代理节点内存数(单位:MB)。
7634
7642
 
7635
7643
  @property
7636
7644
  def InstanceId(self):
7637
- """实例ID
7645
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7638
7646
  :rtype: str
7639
7647
  """
7640
7648
  return self._InstanceId
@@ -7645,7 +7653,7 @@ Mem:单个代理节点内存数(单位:MB)。
7645
7653
 
7646
7654
  @property
7647
7655
  def UniqVpcId(self):
7648
- """私有网络ID
7656
+ """私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7649
7657
  :rtype: str
7650
7658
  """
7651
7659
  return self._UniqVpcId
@@ -7656,7 +7664,7 @@ Mem:单个代理节点内存数(单位:MB)。
7656
7664
 
7657
7665
  @property
7658
7666
  def UniqSubnetId(self):
7659
- """私有子网ID
7667
+ """私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7660
7668
  :rtype: str
7661
7669
  """
7662
7670
  return self._UniqSubnetId
@@ -10879,9 +10887,9 @@ class DeleteAuditLogFileRequest(AbstractModel):
10879
10887
 
10880
10888
  def __init__(self):
10881
10889
  r"""
10882
- :param _FileName: 审计日志文件名称。
10890
+ :param _FileName: 审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。
10883
10891
  :type FileName: str
10884
- :param _InstanceId: 实例 ID
10892
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10885
10893
  :type InstanceId: str
10886
10894
  """
10887
10895
  self._FileName = None
@@ -10889,7 +10897,7 @@ class DeleteAuditLogFileRequest(AbstractModel):
10889
10897
 
10890
10898
  @property
10891
10899
  def FileName(self):
10892
- """审计日志文件名称。
10900
+ """审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。
10893
10901
  :rtype: str
10894
10902
  """
10895
10903
  return self._FileName
@@ -10900,7 +10908,7 @@ class DeleteAuditLogFileRequest(AbstractModel):
10900
10908
 
10901
10909
  @property
10902
10910
  def InstanceId(self):
10903
- """实例 ID
10911
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10904
10912
  :rtype: str
10905
10913
  """
10906
10914
  return self._InstanceId
@@ -11782,9 +11790,9 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
11782
11790
  r"""
11783
11791
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
11784
11792
  :type InstanceId: str
11785
- :param _User: 数据库的账号名称。
11793
+ :param _User: 数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11786
11794
  :type User: str
11787
- :param _Host: 数据库的账号域名。
11795
+ :param _Host: 数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11788
11796
  :type Host: str
11789
11797
  """
11790
11798
  self._InstanceId = None
@@ -11804,7 +11812,7 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
11804
11812
 
11805
11813
  @property
11806
11814
  def User(self):
11807
- """数据库的账号名称。
11815
+ """数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11808
11816
  :rtype: str
11809
11817
  """
11810
11818
  return self._User
@@ -11815,7 +11823,7 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
11815
11823
 
11816
11824
  @property
11817
11825
  def Host(self):
11818
- """数据库的账号域名。
11826
+ """数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11819
11827
  :rtype: str
11820
11828
  """
11821
11829
  return self._Host
@@ -12494,7 +12502,7 @@ class DescribeAuditLogFilesRequest(AbstractModel):
12494
12502
  r"""
12495
12503
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
12496
12504
  :type InstanceId: str
12497
- :param _Limit: 分页大小参数。默认值为 20,最小值为 1,最大值为 100
12505
+ :param _Limit: 分页大小参数。默认值为20,最小值为1,最大值为300
12498
12506
  :type Limit: int
12499
12507
  :param _Offset: 分页偏移量。
12500
12508
  :type Offset: int
@@ -12519,7 +12527,7 @@ class DescribeAuditLogFilesRequest(AbstractModel):
12519
12527
 
12520
12528
  @property
12521
12529
  def Limit(self):
12522
- """分页大小参数。默认值为 20,最小值为 1,最大值为 100
12530
+ """分页大小参数。默认值为20,最小值为1,最大值为300
12523
12531
  :rtype: int
12524
12532
  """
12525
12533
  return self._Limit
@@ -13222,7 +13230,7 @@ class DescribeAuditRuleTemplatesRequest(AbstractModel):
13222
13230
  :type RuleTemplateIds: list of str
13223
13231
  :param _RuleTemplateNames: 规则模板名称。
13224
13232
  :type RuleTemplateNames: list of str
13225
- :param _Limit: 单次请求返回的数量。默认值20。
13233
+ :param _Limit: 单次请求返回的数量。默认值20,最大值为1000
13226
13234
  :type Limit: int
13227
13235
  :param _Offset: 偏移量,默认值为 0。
13228
13236
  :type Offset: int
@@ -13262,7 +13270,7 @@ class DescribeAuditRuleTemplatesRequest(AbstractModel):
13262
13270
 
13263
13271
  @property
13264
13272
  def Limit(self):
13265
- """单次请求返回的数量。默认值20。
13273
+ """单次请求返回的数量。默认值20,最大值为1000
13266
13274
  :rtype: int
13267
13275
  """
13268
13276
  return self._Limit
@@ -15014,14 +15022,14 @@ class DescribeCPUExpandStrategyInfoRequest(AbstractModel):
15014
15022
 
15015
15023
  def __init__(self):
15016
15024
  r"""
15017
- :param _InstanceId: 实例 ID
15025
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15018
15026
  :type InstanceId: str
15019
15027
  """
15020
15028
  self._InstanceId = None
15021
15029
 
15022
15030
  @property
15023
15031
  def InstanceId(self):
15024
- """实例 ID
15032
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15025
15033
  :rtype: str
15026
15034
  """
15027
15035
  return self._InstanceId
@@ -15050,18 +15058,19 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15050
15058
 
15051
15059
  def __init__(self):
15052
15060
  r"""
15053
- :param _Type: 策略类型。输出值 auto、manual。如果返回为 NULL 说明尚未开通弹性扩容策略。
15061
+ :param _Type: 策略类型。输出值:auto、manual、timeInterval、period。
15062
+ 说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。5. 如果返回为 NULL 说明尚未开通弹性扩容策略。
15054
15063
  注意:此字段可能返回 null,表示取不到有效值。
15055
15064
  :type Type: str
15056
- :param _ExpandCpu: 手动扩容的 CPU 。Type 为 manual 时有效。
15065
+ :param _ExpandCpu: 自定义扩容,且扩容时间为立即生效时的 CPU。Type 为 manual 时有效。
15057
15066
  注意:此字段可能返回 null,表示取不到有效值。
15058
15067
  :type ExpandCpu: int
15059
15068
  :param _AutoStrategy: 自动扩容策略。Type 为 auto 时有效。
15060
15069
  注意:此字段可能返回 null,表示取不到有效值。
15061
15070
  :type AutoStrategy: :class:`tencentcloud.cdb.v20170320.models.AutoStrategy`
15062
- :param _PeriodStrategy: 按周期扩容策略。
15071
+ :param _PeriodStrategy: 按周期扩容策略。当 Type 为 period 时有效。
15063
15072
  :type PeriodStrategy: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
15064
- :param _TimeIntervalStrategy: 按时间段扩容策略。
15073
+ :param _TimeIntervalStrategy: 按时间段扩容策略。当 Type 为 timeInterval 时有效。
15065
15074
  :type TimeIntervalStrategy: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
15066
15075
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
15067
15076
  :type RequestId: str
@@ -15075,7 +15084,8 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15075
15084
 
15076
15085
  @property
15077
15086
  def Type(self):
15078
- """策略类型。输出值 auto、manual。如果返回为 NULL 说明尚未开通弹性扩容策略。
15087
+ """策略类型。输出值:auto、manual、timeInterval、period。
15088
+ 说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。5. 如果返回为 NULL 说明尚未开通弹性扩容策略。
15079
15089
  注意:此字段可能返回 null,表示取不到有效值。
15080
15090
  :rtype: str
15081
15091
  """
@@ -15087,7 +15097,7 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15087
15097
 
15088
15098
  @property
15089
15099
  def ExpandCpu(self):
15090
- """手动扩容的 CPU 。Type 为 manual 时有效。
15100
+ """自定义扩容,且扩容时间为立即生效时的 CPU。Type 为 manual 时有效。
15091
15101
  注意:此字段可能返回 null,表示取不到有效值。
15092
15102
  :rtype: int
15093
15103
  """
@@ -15111,7 +15121,7 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15111
15121
 
15112
15122
  @property
15113
15123
  def PeriodStrategy(self):
15114
- """按周期扩容策略。
15124
+ """按周期扩容策略。当 Type 为 period 时有效。
15115
15125
  :rtype: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
15116
15126
  """
15117
15127
  return self._PeriodStrategy
@@ -15122,7 +15132,7 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15122
15132
 
15123
15133
  @property
15124
15134
  def TimeIntervalStrategy(self):
15125
- """按时间段扩容策略。
15135
+ """按时间段扩容策略。当 Type 为 timeInterval 时有效。
15126
15136
  :rtype: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
15127
15137
  """
15128
15138
  return self._TimeIntervalStrategy
@@ -15459,14 +15469,16 @@ class DescribeClusterInfoRequest(AbstractModel):
15459
15469
 
15460
15470
  def __init__(self):
15461
15471
  r"""
15462
- :param _InstanceId: 实例 ID
15472
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15473
+ 说明:仅能输入实例架构为云盘版的实例 ID,对应控制台实例配置显示为“云盘版(云盘)”的实例。
15463
15474
  :type InstanceId: str
15464
15475
  """
15465
15476
  self._InstanceId = None
15466
15477
 
15467
15478
  @property
15468
15479
  def InstanceId(self):
15469
- """实例 ID
15480
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15481
+ 说明:仅能输入实例架构为云盘版的实例 ID,对应控制台实例配置显示为“云盘版(云盘)”的实例。
15470
15482
  :rtype: str
15471
15483
  """
15472
15484
  return self._InstanceId
@@ -19507,9 +19519,10 @@ class DescribeInstanceUpgradeCheckJobRequest(AbstractModel):
19507
19519
 
19508
19520
  def __init__(self):
19509
19521
  r"""
19510
- :param _InstanceId: 实例ID
19522
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
19511
19523
  :type InstanceId: str
19512
- :param _DstMysqlVersion: 目标数据库版本
19524
+ :param _DstMysqlVersion: 目标数据库版本。
19525
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
19513
19526
  :type DstMysqlVersion: str
19514
19527
  """
19515
19528
  self._InstanceId = None
@@ -19517,7 +19530,7 @@ class DescribeInstanceUpgradeCheckJobRequest(AbstractModel):
19517
19530
 
19518
19531
  @property
19519
19532
  def InstanceId(self):
19520
- """实例ID
19533
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
19521
19534
  :rtype: str
19522
19535
  """
19523
19536
  return self._InstanceId
@@ -19528,7 +19541,8 @@ class DescribeInstanceUpgradeCheckJobRequest(AbstractModel):
19528
19541
 
19529
19542
  @property
19530
19543
  def DstMysqlVersion(self):
19531
- """目标数据库版本
19544
+ """目标数据库版本。
19545
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
19532
19546
  :rtype: str
19533
19547
  """
19534
19548
  return self._DstMysqlVersion
@@ -20325,14 +20339,14 @@ class DescribeProjectSecurityGroupsRequest(AbstractModel):
20325
20339
 
20326
20340
  def __init__(self):
20327
20341
  r"""
20328
- :param _ProjectId: 项目ID
20342
+ :param _ProjectId: 项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。
20329
20343
  :type ProjectId: int
20330
20344
  """
20331
20345
  self._ProjectId = None
20332
20346
 
20333
20347
  @property
20334
20348
  def ProjectId(self):
20335
- """项目ID
20349
+ """项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。
20336
20350
  :rtype: int
20337
20351
  """
20338
20352
  return self._ProjectId
@@ -20567,14 +20581,14 @@ class DescribeProxySupportParamRequest(AbstractModel):
20567
20581
 
20568
20582
  def __init__(self):
20569
20583
  r"""
20570
- :param _InstanceId: 实例ID
20584
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
20571
20585
  :type InstanceId: str
20572
20586
  """
20573
20587
  self._InstanceId = None
20574
20588
 
20575
20589
  @property
20576
20590
  def InstanceId(self):
20577
- """实例ID
20591
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
20578
20592
  :rtype: str
20579
20593
  """
20580
20594
  return self._InstanceId
@@ -26635,11 +26649,11 @@ class ModifyAccountHostRequest(AbstractModel):
26635
26649
  r"""
26636
26650
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
26637
26651
  :type InstanceId: str
26638
- :param _User: 账户的名称
26652
+ :param _User: 账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26639
26653
  :type User: str
26640
- :param _Host: 账户的旧主机
26654
+ :param _Host: 账户的旧主机。格式:IP 形式,支持单个 IP 地址或者%。
26641
26655
  :type Host: str
26642
- :param _NewHost: 账户的新主机
26656
+ :param _NewHost: 账户的新主机。格式:IP 形式,支持单个 IP 地址或者%。
26643
26657
  :type NewHost: str
26644
26658
  """
26645
26659
  self._InstanceId = None
@@ -26660,7 +26674,7 @@ class ModifyAccountHostRequest(AbstractModel):
26660
26674
 
26661
26675
  @property
26662
26676
  def User(self):
26663
- """账户的名称
26677
+ """账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26664
26678
  :rtype: str
26665
26679
  """
26666
26680
  return self._User
@@ -26671,7 +26685,7 @@ class ModifyAccountHostRequest(AbstractModel):
26671
26685
 
26672
26686
  @property
26673
26687
  def Host(self):
26674
- """账户的旧主机
26688
+ """账户的旧主机。格式:IP 形式,支持单个 IP 地址或者%。
26675
26689
  :rtype: str
26676
26690
  """
26677
26691
  return self._Host
@@ -26682,7 +26696,7 @@ class ModifyAccountHostRequest(AbstractModel):
26682
26696
 
26683
26697
  @property
26684
26698
  def NewHost(self):
26685
- """账户的新主机
26699
+ """账户的新主机。格式:IP 形式,支持单个 IP 地址或者%。
26686
26700
  :rtype: str
26687
26701
  """
26688
26702
  return self._NewHost
@@ -27182,7 +27196,7 @@ class ModifyAuditConfigRequest(AbstractModel):
27182
27196
 
27183
27197
  def __init__(self):
27184
27198
  r"""
27185
- :param _InstanceId: 实例 ID
27199
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27186
27200
  :type InstanceId: str
27187
27201
  :param _LogExpireDay: 审计日志保存时长。支持值包括:
27188
27202
  7 - 一周
@@ -27193,8 +27207,10 @@ class ModifyAuditConfigRequest(AbstractModel):
27193
27207
  1825 - 五年;
27194
27208
  :type LogExpireDay: int
27195
27209
  :param _CloseAudit: 是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。
27196
- 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27197
- CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按照CloseAudit优先的逻辑处理。
27210
+ 说明:
27211
+ 1. 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27212
+ 2. CloseAudit、LogExpireDay 必须至少提供一个,如果两个都提供则按照 CloseAudit 优先的逻辑处理。
27213
+ 3. 可通过设置此参数来关闭审计服务,已关闭后不能通过此接口来开启审计服务。
27198
27214
  :type CloseAudit: bool
27199
27215
  :param _HighLogExpireDay: 高频审计日志保存时长。支持值包括:
27200
27216
  7 - 一周
@@ -27212,7 +27228,7 @@ CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按
27212
27228
 
27213
27229
  @property
27214
27230
  def InstanceId(self):
27215
- """实例 ID
27231
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27216
27232
  :rtype: str
27217
27233
  """
27218
27234
  return self._InstanceId
@@ -27241,8 +27257,10 @@ CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按
27241
27257
  @property
27242
27258
  def CloseAudit(self):
27243
27259
  """是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。
27244
- 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27245
- CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按照CloseAudit优先的逻辑处理。
27260
+ 说明:
27261
+ 1. 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27262
+ 2. CloseAudit、LogExpireDay 必须至少提供一个,如果两个都提供则按照 CloseAudit 优先的逻辑处理。
27263
+ 3. 可通过设置此参数来关闭审计服务,已关闭后不能通过此接口来开启审计服务。
27246
27264
  :rtype: bool
27247
27265
  """
27248
27266
  return self._CloseAudit
@@ -27448,7 +27466,7 @@ class ModifyAuditRuleTemplatesRequest(AbstractModel):
27448
27466
 
27449
27467
  def __init__(self):
27450
27468
  r"""
27451
- :param _RuleTemplateIds: 审计规则模板ID
27469
+ :param _RuleTemplateIds: 审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27452
27470
  :type RuleTemplateIds: list of str
27453
27471
  :param _RuleFilters: 修改后的审计规则。
27454
27472
  :type RuleFilters: list of RuleFilters
@@ -27470,7 +27488,7 @@ class ModifyAuditRuleTemplatesRequest(AbstractModel):
27470
27488
 
27471
27489
  @property
27472
27490
  def RuleTemplateIds(self):
27473
- """审计规则模板ID
27491
+ """审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27474
27492
  :rtype: list of str
27475
27493
  """
27476
27494
  return self._RuleTemplateIds
@@ -27592,17 +27610,32 @@ class ModifyAuditServiceRequest(AbstractModel):
27592
27610
 
27593
27611
  def __init__(self):
27594
27612
  r"""
27595
- :param _InstanceId: 实例ID
27613
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27596
27614
  :type InstanceId: str
27597
- :param _LogExpireDay: 日志保留时长。
27615
+ :param _LogExpireDay: 日志保留时长。支持值包括:
27616
+ 7 - 一周;
27617
+ 30 - 一个月;
27618
+ 90 - 三个月;
27619
+ 180 - 六个月;
27620
+ 365 - 一年;
27621
+ 1095 - 三年;
27622
+ 1825 - 五年。
27598
27623
  :type LogExpireDay: int
27599
- :param _HighLogExpireDay: 高频日志保留时长。
27624
+ :param _HighLogExpireDay: 高频日志保留时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
27625
+ 3 - 3天;
27626
+ 7 - 一周;
27627
+ 30 - 一个月;
27628
+ 90 - 三个月;
27629
+ 180 - 六个月;
27630
+ 365 - 一年;
27631
+ 1095 - 三年;
27632
+ 1825 - 五年。
27600
27633
  :type HighLogExpireDay: int
27601
27634
  :param _AuditAll: 修改实例审计规则为全审计。
27602
27635
  :type AuditAll: bool
27603
27636
  :param _AuditRuleFilters: 废弃。
27604
27637
  :type AuditRuleFilters: list of AuditRuleFilters
27605
- :param _RuleTemplateIds: 规则模板ID
27638
+ :param _RuleTemplateIds: 规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27606
27639
  :type RuleTemplateIds: list of str
27607
27640
  """
27608
27641
  self._InstanceId = None
@@ -27614,7 +27647,7 @@ class ModifyAuditServiceRequest(AbstractModel):
27614
27647
 
27615
27648
  @property
27616
27649
  def InstanceId(self):
27617
- """实例ID
27650
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27618
27651
  :rtype: str
27619
27652
  """
27620
27653
  return self._InstanceId
@@ -27625,7 +27658,14 @@ class ModifyAuditServiceRequest(AbstractModel):
27625
27658
 
27626
27659
  @property
27627
27660
  def LogExpireDay(self):
27628
- """日志保留时长。
27661
+ """日志保留时长。支持值包括:
27662
+ 7 - 一周;
27663
+ 30 - 一个月;
27664
+ 90 - 三个月;
27665
+ 180 - 六个月;
27666
+ 365 - 一年;
27667
+ 1095 - 三年;
27668
+ 1825 - 五年。
27629
27669
  :rtype: int
27630
27670
  """
27631
27671
  return self._LogExpireDay
@@ -27636,7 +27676,15 @@ class ModifyAuditServiceRequest(AbstractModel):
27636
27676
 
27637
27677
  @property
27638
27678
  def HighLogExpireDay(self):
27639
- """高频日志保留时长。
27679
+ """高频日志保留时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
27680
+ 3 - 3天;
27681
+ 7 - 一周;
27682
+ 30 - 一个月;
27683
+ 90 - 三个月;
27684
+ 180 - 六个月;
27685
+ 365 - 一年;
27686
+ 1095 - 三年;
27687
+ 1825 - 五年。
27640
27688
  :rtype: int
27641
27689
  """
27642
27690
  return self._HighLogExpireDay
@@ -27673,7 +27721,7 @@ class ModifyAuditServiceRequest(AbstractModel):
27673
27721
 
27674
27722
  @property
27675
27723
  def RuleTemplateIds(self):
27676
- """规则模板ID
27724
+ """规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27677
27725
  :rtype: list of str
27678
27726
  """
27679
27727
  return self._RuleTemplateIds
@@ -28388,9 +28436,9 @@ class ModifyCdbProxyAddressDescRequest(AbstractModel):
28388
28436
 
28389
28437
  def __init__(self):
28390
28438
  r"""
28391
- :param _ProxyGroupId: 代理组ID
28439
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28392
28440
  :type ProxyGroupId: str
28393
- :param _ProxyAddressId: 代理组地址ID
28441
+ :param _ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28394
28442
  :type ProxyAddressId: str
28395
28443
  :param _Desc: 描述
28396
28444
  :type Desc: str
@@ -28401,7 +28449,7 @@ class ModifyCdbProxyAddressDescRequest(AbstractModel):
28401
28449
 
28402
28450
  @property
28403
28451
  def ProxyGroupId(self):
28404
- """代理组ID
28452
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28405
28453
  :rtype: str
28406
28454
  """
28407
28455
  return self._ProxyGroupId
@@ -28412,7 +28460,7 @@ class ModifyCdbProxyAddressDescRequest(AbstractModel):
28412
28460
 
28413
28461
  @property
28414
28462
  def ProxyAddressId(self):
28415
- """代理组地址ID
28463
+ """代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28416
28464
  :rtype: str
28417
28465
  """
28418
28466
  return self._ProxyAddressId
@@ -28482,19 +28530,19 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28482
28530
 
28483
28531
  def __init__(self):
28484
28532
  r"""
28485
- :param _ProxyGroupId: 代理组ID
28533
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28486
28534
  :type ProxyGroupId: str
28487
- :param _ProxyAddressId: 代理组地址ID
28535
+ :param _ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28488
28536
  :type ProxyAddressId: str
28489
- :param _UniqVpcId: 私有网络ID
28537
+ :param _UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28490
28538
  :type UniqVpcId: str
28491
- :param _UniqSubnetId: 私有子网ID
28539
+ :param _UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28492
28540
  :type UniqSubnetId: str
28493
- :param _Vip: IP地址
28541
+ :param _Vip: IP 地址。若不填写则自动分配子网下的可用 IP。
28494
28542
  :type Vip: str
28495
- :param _VPort: 端口
28543
+ :param _VPort: 端口。默认值3306,取值范围:1024 - 65535。
28496
28544
  :type VPort: int
28497
- :param _ReleaseDuration: 旧IP地址回收时间
28545
+ :param _ReleaseDuration: 旧 IP 地址回收时间。单位:小时,默认值:24,取值范围:0 - 168。
28498
28546
  :type ReleaseDuration: int
28499
28547
  """
28500
28548
  self._ProxyGroupId = None
@@ -28507,7 +28555,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28507
28555
 
28508
28556
  @property
28509
28557
  def ProxyGroupId(self):
28510
- """代理组ID
28558
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28511
28559
  :rtype: str
28512
28560
  """
28513
28561
  return self._ProxyGroupId
@@ -28518,7 +28566,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28518
28566
 
28519
28567
  @property
28520
28568
  def ProxyAddressId(self):
28521
- """代理组地址ID
28569
+ """代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28522
28570
  :rtype: str
28523
28571
  """
28524
28572
  return self._ProxyAddressId
@@ -28529,7 +28577,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28529
28577
 
28530
28578
  @property
28531
28579
  def UniqVpcId(self):
28532
- """私有网络ID
28580
+ """私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28533
28581
  :rtype: str
28534
28582
  """
28535
28583
  return self._UniqVpcId
@@ -28540,7 +28588,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28540
28588
 
28541
28589
  @property
28542
28590
  def UniqSubnetId(self):
28543
- """私有子网ID
28591
+ """私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28544
28592
  :rtype: str
28545
28593
  """
28546
28594
  return self._UniqSubnetId
@@ -28551,7 +28599,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28551
28599
 
28552
28600
  @property
28553
28601
  def Vip(self):
28554
- """IP地址
28602
+ """IP 地址。若不填写则自动分配子网下的可用 IP。
28555
28603
  :rtype: str
28556
28604
  """
28557
28605
  return self._Vip
@@ -28562,7 +28610,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28562
28610
 
28563
28611
  @property
28564
28612
  def VPort(self):
28565
- """端口
28613
+ """端口。默认值3306,取值范围:1024 - 65535。
28566
28614
  :rtype: int
28567
28615
  """
28568
28616
  return self._VPort
@@ -28573,7 +28621,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28573
28621
 
28574
28622
  @property
28575
28623
  def ReleaseDuration(self):
28576
- """旧IP地址回收时间
28624
+ """旧 IP 地址回收时间。单位:小时,默认值:24,取值范围:0 - 168。
28577
28625
  :rtype: int
28578
28626
  """
28579
28627
  return self._ReleaseDuration
@@ -28636,11 +28684,11 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28636
28684
 
28637
28685
  def __init__(self):
28638
28686
  r"""
28639
- :param _InstanceId: 实例ID
28687
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28640
28688
  :type InstanceId: str
28641
- :param _ProxyGroupId: 代理组ID
28689
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28642
28690
  :type ProxyGroupId: str
28643
- :param _ConnectionPoolLimit: 连接池阈值
28691
+ :param _ConnectionPoolLimit: 连接池阈值。取值范围:大于0,小于等于300。
28644
28692
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
28645
28693
  :type ConnectionPoolLimit: int
28646
28694
  """
@@ -28650,7 +28698,7 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28650
28698
 
28651
28699
  @property
28652
28700
  def InstanceId(self):
28653
- """实例ID
28701
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28654
28702
  :rtype: str
28655
28703
  """
28656
28704
  return self._InstanceId
@@ -28661,7 +28709,7 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28661
28709
 
28662
28710
  @property
28663
28711
  def ProxyGroupId(self):
28664
- """代理组ID
28712
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28665
28713
  :rtype: str
28666
28714
  """
28667
28715
  return self._ProxyGroupId
@@ -28672,7 +28720,7 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28672
28720
 
28673
28721
  @property
28674
28722
  def ConnectionPoolLimit(self):
28675
- """连接池阈值
28723
+ """连接池阈值。取值范围:大于0,小于等于300。
28676
28724
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
28677
28725
  :rtype: int
28678
28726
  """
@@ -30768,26 +30816,32 @@ class OpenAuditServiceRequest(AbstractModel):
30768
30816
 
30769
30817
  def __init__(self):
30770
30818
  r"""
30771
- :param _InstanceId: CDB实例ID
30819
+ :param _InstanceId: CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30772
30820
  :type InstanceId: str
30773
30821
  :param _LogExpireDay: 审计日志保存时长。支持值包括:
30774
- 7 - 一周
30822
+ 7 - 一周;
30775
30823
  30 - 一个月;
30776
30824
  90 - 三个月;
30777
30825
  180 - 六个月;
30778
30826
  365 - 一年;
30779
30827
  1095 - 三年;
30780
- 1825 - 五年;
30828
+ 1825 - 五年。
30781
30829
  :type LogExpireDay: int
30782
- :param _HighLogExpireDay: 高频审计日志保存时长。支持值包括:
30783
- 7 - 一周
30830
+ :param _HighLogExpireDay: 高频审计日志保存时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
30831
+ 3 - 3天;
30832
+ 7 - 一周;
30784
30833
  30 - 一个月;
30834
+ 90 - 三个月;
30835
+ 180 - 六个月;
30836
+ 365 - 一年;
30837
+ 1095 - 三年;
30838
+ 1825 - 五年。
30785
30839
  :type HighLogExpireDay: int
30786
30840
  :param _AuditRuleFilters: 审计规则(该参数已废弃,不再生效)。
30787
30841
  :type AuditRuleFilters: list of AuditRuleFilters
30788
- :param _RuleTemplateIds: 规则模板ID。同AuditRuleFilters都不填是全审计。
30842
+ :param _RuleTemplateIds: 规则模板 ID
30789
30843
  :type RuleTemplateIds: list of str
30790
- :param _AuditAll: 审计类型。true-全审计;默认false-规则审计。
30844
+ :param _AuditAll: 审计类型。true - 全审计;默认 false - 规则审计。
30791
30845
  :type AuditAll: bool
30792
30846
  """
30793
30847
  self._InstanceId = None
@@ -30799,7 +30853,7 @@ class OpenAuditServiceRequest(AbstractModel):
30799
30853
 
30800
30854
  @property
30801
30855
  def InstanceId(self):
30802
- """CDB实例ID
30856
+ """CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30803
30857
  :rtype: str
30804
30858
  """
30805
30859
  return self._InstanceId
@@ -30811,13 +30865,13 @@ class OpenAuditServiceRequest(AbstractModel):
30811
30865
  @property
30812
30866
  def LogExpireDay(self):
30813
30867
  """审计日志保存时长。支持值包括:
30814
- 7 - 一周
30868
+ 7 - 一周;
30815
30869
  30 - 一个月;
30816
30870
  90 - 三个月;
30817
30871
  180 - 六个月;
30818
30872
  365 - 一年;
30819
30873
  1095 - 三年;
30820
- 1825 - 五年;
30874
+ 1825 - 五年。
30821
30875
  :rtype: int
30822
30876
  """
30823
30877
  return self._LogExpireDay
@@ -30828,9 +30882,15 @@ class OpenAuditServiceRequest(AbstractModel):
30828
30882
 
30829
30883
  @property
30830
30884
  def HighLogExpireDay(self):
30831
- """高频审计日志保存时长。支持值包括:
30832
- 7 - 一周
30885
+ """高频审计日志保存时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
30886
+ 3 - 3天;
30887
+ 7 - 一周;
30833
30888
  30 - 一个月;
30889
+ 90 - 三个月;
30890
+ 180 - 六个月;
30891
+ 365 - 一年;
30892
+ 1095 - 三年;
30893
+ 1825 - 五年。
30834
30894
  :rtype: int
30835
30895
  """
30836
30896
  return self._HighLogExpireDay
@@ -30856,7 +30916,7 @@ class OpenAuditServiceRequest(AbstractModel):
30856
30916
 
30857
30917
  @property
30858
30918
  def RuleTemplateIds(self):
30859
- """规则模板ID。同AuditRuleFilters都不填是全审计。
30919
+ """规则模板 ID
30860
30920
  :rtype: list of str
30861
30921
  """
30862
30922
  return self._RuleTemplateIds
@@ -30867,7 +30927,7 @@ class OpenAuditServiceRequest(AbstractModel):
30867
30927
 
30868
30928
  @property
30869
30929
  def AuditAll(self):
30870
- """审计类型。true-全审计;默认false-规则审计。
30930
+ """审计类型。true - 全审计;默认 false - 规则审计。
30871
30931
  :rtype: bool
30872
30932
  """
30873
30933
  return self._AuditAll
@@ -30934,7 +30994,7 @@ class OpenDBInstanceEncryptionRequest(AbstractModel):
30934
30994
 
30935
30995
  def __init__(self):
30936
30996
  r"""
30937
- :param _InstanceId: 云数据库实例 ID
30997
+ :param _InstanceId: 云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30938
30998
  :type InstanceId: str
30939
30999
  :param _KeyId: 用户自定义密钥 ID,CMK 唯一标识符。该值为空时,将使用腾讯云自动生成的密钥 KMS-CDB。
30940
31000
  :type KeyId: str
@@ -30947,7 +31007,7 @@ class OpenDBInstanceEncryptionRequest(AbstractModel):
30947
31007
 
30948
31008
  @property
30949
31009
  def InstanceId(self):
30950
- """云数据库实例 ID
31010
+ """云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30951
31011
  :rtype: str
30952
31012
  """
30953
31013
  return self._InstanceId
@@ -31107,9 +31167,9 @@ class OpenSSLRequest(AbstractModel):
31107
31167
 
31108
31168
  def __init__(self):
31109
31169
  r"""
31110
- :param _InstanceId: 实例 ID
31170
+ :param _InstanceId: 实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
31111
31171
  :type InstanceId: str
31112
- :param _RoGroupId: 只读组 ID
31172
+ :param _RoGroupId: 只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
31113
31173
  :type RoGroupId: str
31114
31174
  """
31115
31175
  self._InstanceId = None
@@ -31117,7 +31177,7 @@ class OpenSSLRequest(AbstractModel):
31117
31177
 
31118
31178
  @property
31119
31179
  def InstanceId(self):
31120
- """实例 ID
31180
+ """实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
31121
31181
  :rtype: str
31122
31182
  """
31123
31183
  return self._InstanceId
@@ -31128,7 +31188,7 @@ class OpenSSLRequest(AbstractModel):
31128
31188
 
31129
31189
  @property
31130
31190
  def RoGroupId(self):
31131
- """只读组 ID
31191
+ """只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
31132
31192
  :rtype: str
31133
31193
  """
31134
31194
  return self._RoGroupId
@@ -31201,7 +31261,7 @@ class OpenWanServiceRequest(AbstractModel):
31201
31261
 
31202
31262
  def __init__(self):
31203
31263
  r"""
31204
- :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
31264
+ :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。
31205
31265
  :type InstanceId: str
31206
31266
  :param _OpResourceId: 变更集群版实例只读组时,InstanceId传实例id,需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。
31207
31267
  :type OpResourceId: str
@@ -31211,7 +31271,7 @@ class OpenWanServiceRequest(AbstractModel):
31211
31271
 
31212
31272
  @property
31213
31273
  def InstanceId(self):
31214
- """实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
31274
+ """实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。
31215
31275
  :rtype: str
31216
31276
  """
31217
31277
  return self._InstanceId
@@ -34046,15 +34106,17 @@ class RoGroupAttr(AbstractModel):
34046
34106
  r"""
34047
34107
  :param _RoGroupName: RO 组名称。
34048
34108
  :type RoGroupName: str
34049
- :param _RoMaxDelayTime: RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34109
+ :param _RoMaxDelayTime: RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。
34110
+ 注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34050
34111
  :type RoMaxDelayTime: int
34051
34112
  :param _RoOfflineDelay: 是否开启实例延迟剔除。支持的值包括:1 - 开启;0 - 不开启。注意,若设置开启实例延迟剔除,则必须设置延迟阈值(RoMaxDelayTime)参数。
34052
34113
  :type RoOfflineDelay: int
34053
- :param _MinRoInGroup: 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34114
+ :param _MinRoInGroup: 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。
34115
+ 注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34054
34116
  :type MinRoInGroup: int
34055
34117
  :param _WeightMode: 权重模式。支持值包括:"system" - 系统自动分配; "custom" - 用户自定义设置。注意,若设置 "custom" 模式,则必须设置 RO 实例权重配置(RoWeightValues)参数。
34056
34118
  :type WeightMode: str
34057
- :param _ReplicationDelayTime: 延迟复制时间。
34119
+ :param _ReplicationDelayTime: 延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。
34058
34120
  :type ReplicationDelayTime: int
34059
34121
  """
34060
34122
  self._RoGroupName = None
@@ -34077,7 +34139,8 @@ class RoGroupAttr(AbstractModel):
34077
34139
 
34078
34140
  @property
34079
34141
  def RoMaxDelayTime(self):
34080
- """RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34142
+ """RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。
34143
+ 注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34081
34144
  :rtype: int
34082
34145
  """
34083
34146
  return self._RoMaxDelayTime
@@ -34099,7 +34162,8 @@ class RoGroupAttr(AbstractModel):
34099
34162
 
34100
34163
  @property
34101
34164
  def MinRoInGroup(self):
34102
- """最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34165
+ """最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。
34166
+ 注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34103
34167
  :rtype: int
34104
34168
  """
34105
34169
  return self._MinRoInGroup
@@ -34121,7 +34185,7 @@ class RoGroupAttr(AbstractModel):
34121
34185
 
34122
34186
  @property
34123
34187
  def ReplicationDelayTime(self):
34124
- """延迟复制时间。
34188
+ """延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。
34125
34189
  :rtype: int
34126
34190
  """
34127
34191
  return self._ReplicationDelayTime
@@ -36279,7 +36343,7 @@ class StartCpuExpandRequest(AbstractModel):
36279
36343
 
36280
36344
  def __init__(self):
36281
36345
  r"""
36282
- :param _InstanceId: 实例 ID
36346
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36283
36347
  :type InstanceId: str
36284
36348
  :param _Type: 扩容类型,支持自动扩容和自定义扩容。
36285
36349
  说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。
@@ -36290,8 +36354,10 @@ class StartCpuExpandRequest(AbstractModel):
36290
36354
  :param _AutoStrategy: 自动扩容策略。Type 为 auto 时必传。
36291
36355
  :type AutoStrategy: :class:`tencentcloud.cdb.v20170320.models.AutoStrategy`
36292
36356
  :param _TimeIntervalStrategy: 按时间段扩容策略。
36357
+ 说明:当 Type 为 timeInterval 时,TimeIntervalStrategy 必填。
36293
36358
  :type TimeIntervalStrategy: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
36294
36359
  :param _PeriodStrategy: 按周期扩容策略。
36360
+ 说明:当 Type 为 period 时,PeriodStrategy 必填。
36295
36361
  :type PeriodStrategy: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
36296
36362
  """
36297
36363
  self._InstanceId = None
@@ -36303,7 +36369,7 @@ class StartCpuExpandRequest(AbstractModel):
36303
36369
 
36304
36370
  @property
36305
36371
  def InstanceId(self):
36306
- """实例 ID
36372
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36307
36373
  :rtype: str
36308
36374
  """
36309
36375
  return self._InstanceId
@@ -36350,6 +36416,7 @@ class StartCpuExpandRequest(AbstractModel):
36350
36416
  @property
36351
36417
  def TimeIntervalStrategy(self):
36352
36418
  """按时间段扩容策略。
36419
+ 说明:当 Type 为 timeInterval 时,TimeIntervalStrategy 必填。
36353
36420
  :rtype: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
36354
36421
  """
36355
36422
  return self._TimeIntervalStrategy
@@ -36361,6 +36428,7 @@ class StartCpuExpandRequest(AbstractModel):
36361
36428
  @property
36362
36429
  def PeriodStrategy(self):
36363
36430
  """按周期扩容策略。
36431
+ 说明:当 Type 为 period 时,PeriodStrategy 必填。
36364
36432
  :rtype: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
36365
36433
  """
36366
36434
  return self._PeriodStrategy
@@ -36400,7 +36468,7 @@ class StartCpuExpandResponse(AbstractModel):
36400
36468
 
36401
36469
  def __init__(self):
36402
36470
  r"""
36403
- :param _AsyncRequestId: 异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询
36471
+ :param _AsyncRequestId: 异步任务 ID 。可以调用 DescribeAsyncRequest 传入该 ID,进行任务执行进度的查询。
36404
36472
  :type AsyncRequestId: str
36405
36473
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
36406
36474
  :type RequestId: str
@@ -36410,7 +36478,7 @@ class StartCpuExpandResponse(AbstractModel):
36410
36478
 
36411
36479
  @property
36412
36480
  def AsyncRequestId(self):
36413
- """异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询
36481
+ """异步任务 ID 。可以调用 DescribeAsyncRequest 传入该 ID,进行任务执行进度的查询。
36414
36482
  :rtype: str
36415
36483
  """
36416
36484
  return self._AsyncRequestId
@@ -36823,9 +36891,10 @@ class SubmitInstanceUpgradeCheckJobRequest(AbstractModel):
36823
36891
 
36824
36892
  def __init__(self):
36825
36893
  r"""
36826
- :param _InstanceId: 实例 ID
36894
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36827
36895
  :type InstanceId: str
36828
36896
  :param _DstMysqlVersion: 目标数据库版本。
36897
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
36829
36898
  :type DstMysqlVersion: str
36830
36899
  """
36831
36900
  self._InstanceId = None
@@ -36833,7 +36902,7 @@ class SubmitInstanceUpgradeCheckJobRequest(AbstractModel):
36833
36902
 
36834
36903
  @property
36835
36904
  def InstanceId(self):
36836
- """实例 ID
36905
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36837
36906
  :rtype: str
36838
36907
  """
36839
36908
  return self._InstanceId
@@ -36845,6 +36914,7 @@ class SubmitInstanceUpgradeCheckJobRequest(AbstractModel):
36845
36914
  @property
36846
36915
  def DstMysqlVersion(self):
36847
36916
  """目标数据库版本。
36917
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
36848
36918
  :rtype: str
36849
36919
  """
36850
36920
  return self._DstMysqlVersion
@@ -36917,9 +36987,9 @@ class SwitchCDBProxyRequest(AbstractModel):
36917
36987
 
36918
36988
  def __init__(self):
36919
36989
  r"""
36920
- :param _InstanceId: 实例ID
36990
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36921
36991
  :type InstanceId: str
36922
- :param _ProxyGroupId: 数据库代理ID
36992
+ :param _ProxyGroupId: 数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
36923
36993
  :type ProxyGroupId: str
36924
36994
  """
36925
36995
  self._InstanceId = None
@@ -36927,7 +36997,7 @@ class SwitchCDBProxyRequest(AbstractModel):
36927
36997
 
36928
36998
  @property
36929
36999
  def InstanceId(self):
36930
- """实例ID
37000
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36931
37001
  :rtype: str
36932
37002
  """
36933
37003
  return self._InstanceId
@@ -36938,7 +37008,7 @@ class SwitchCDBProxyRequest(AbstractModel):
36938
37008
 
36939
37009
  @property
36940
37010
  def ProxyGroupId(self):
36941
- """数据库代理ID
37011
+ """数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
36942
37012
  :rtype: str
36943
37013
  """
36944
37014
  return self._ProxyGroupId
@@ -38138,9 +38208,9 @@ class UpgradeCDBProxyVersionRequest(AbstractModel):
38138
38208
 
38139
38209
  def __init__(self):
38140
38210
  r"""
38141
- :param _InstanceId: 实例ID
38211
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
38142
38212
  :type InstanceId: str
38143
- :param _ProxyGroupId: 数据库代理ID
38213
+ :param _ProxyGroupId: 数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
38144
38214
  :type ProxyGroupId: str
38145
38215
  :param _SrcProxyVersion: 数据库代理当前版本
38146
38216
  :type SrcProxyVersion: str
@@ -38157,7 +38227,7 @@ class UpgradeCDBProxyVersionRequest(AbstractModel):
38157
38227
 
38158
38228
  @property
38159
38229
  def InstanceId(self):
38160
- """实例ID
38230
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
38161
38231
  :rtype: str
38162
38232
  """
38163
38233
  return self._InstanceId
@@ -38168,7 +38238,7 @@ class UpgradeCDBProxyVersionRequest(AbstractModel):
38168
38238
 
38169
38239
  @property
38170
38240
  def ProxyGroupId(self):
38171
- """数据库代理ID
38241
+ """数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
38172
38242
  :rtype: str
38173
38243
  """
38174
38244
  return self._ProxyGroupId
@@ -38464,11 +38534,12 @@ class UpgradeDBInstanceRequest(AbstractModel):
38464
38534
  :type DeployMode: int
38465
38535
  :param _SlaveZone: 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
38466
38536
  :type SlaveZone: str
38467
- :param _EngineVersion: 主实例数据库引擎版本,支持值包括:5.5、5.65.7。
38537
+ :param _EngineVersion: 主实例数据库引擎版本,支持值包括:5.5、5.65.7、8.0
38538
+ 说明:升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。
38468
38539
  :type EngineVersion: str
38469
38540
  :param _WaitSwitch: 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
38470
38541
  :type WaitSwitch: int
38471
- :param _BackupZone: 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
38542
+ :param _BackupZone: 备库2的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
38472
38543
  备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。
38473
38544
  :type BackupZone: str
38474
38545
  :param _InstanceRole: 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
@@ -38591,7 +38662,8 @@ class UpgradeDBInstanceRequest(AbstractModel):
38591
38662
 
38592
38663
  @property
38593
38664
  def EngineVersion(self):
38594
- """主实例数据库引擎版本,支持值包括:5.5、5.65.7。
38665
+ """主实例数据库引擎版本,支持值包括:5.5、5.65.7、8.0
38666
+ 说明:升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。
38595
38667
  :rtype: str
38596
38668
  """
38597
38669
  return self._EngineVersion
@@ -38613,7 +38685,7 @@ class UpgradeDBInstanceRequest(AbstractModel):
38613
38685
 
38614
38686
  @property
38615
38687
  def BackupZone(self):
38616
- """备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
38688
+ """备库2的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
38617
38689
  备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。
38618
38690
  :rtype: str
38619
38691
  """
@@ -38794,7 +38866,7 @@ class UpgradeDBInstanceResponse(AbstractModel):
38794
38866
  r"""
38795
38867
  :param _DealIds: 订单 ID。
38796
38868
  :type DealIds: list of str
38797
- :param _AsyncRequestId: 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
38869
+ :param _AsyncRequestId: 异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/236/20410)。
38798
38870
  :type AsyncRequestId: str
38799
38871
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
38800
38872
  :type RequestId: str
@@ -38816,7 +38888,7 @@ class UpgradeDBInstanceResponse(AbstractModel):
38816
38888
 
38817
38889
  @property
38818
38890
  def AsyncRequestId(self):
38819
- """异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
38891
+ """异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/236/20410)。
38820
38892
  :rtype: str
38821
38893
  """
38822
38894
  return self._AsyncRequestId