tencentcloud-sdk-python 3.0.1409__py2.py3-none-any.whl → 3.0.1411__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 (60) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ams/v20201229/models.py +16 -189
  3. tencentcloud/apm/v20210622/models.py +15 -0
  4. tencentcloud/bh/v20230418/bh_client.py +138 -0
  5. tencentcloud/bh/v20230418/errorcodes.py +3 -0
  6. tencentcloud/bh/v20230418/models.py +991 -67
  7. tencentcloud/ccc/v20200210/models.py +2 -2
  8. tencentcloud/cdb/v20170320/cdb_client.py +27 -21
  9. tencentcloud/cdb/v20170320/errorcodes.py +0 -3
  10. tencentcloud/cdb/v20170320/models.py +294 -214
  11. tencentcloud/ctem/__init__.py +0 -0
  12. tencentcloud/ctem/v20231128/__init__.py +0 -0
  13. tencentcloud/ctem/v20231128/ctem_client.py +601 -0
  14. tencentcloud/ctem/v20231128/errorcodes.py +75 -0
  15. tencentcloud/ctem/v20231128/models.py +10459 -0
  16. tencentcloud/cwp/v20180228/models.py +165 -0
  17. tencentcloud/cynosdb/v20190107/errorcodes.py +3 -0
  18. tencentcloud/cynosdb/v20190107/models.py +45 -0
  19. tencentcloud/dlc/v20210125/dlc_client.py +3 -1
  20. tencentcloud/dlc/v20210125/models.py +24 -7
  21. tencentcloud/dnspod/v20210323/errorcodes.py +1 -1
  22. tencentcloud/dsgc/v20190723/dsgc_client.py +1 -3
  23. tencentcloud/dsgc/v20190723/models.py +342 -15
  24. tencentcloud/emr/v20190103/models.py +155 -0
  25. tencentcloud/es/v20180416/errorcodes.py +42 -0
  26. tencentcloud/ess/v20201111/models.py +33 -4
  27. tencentcloud/hunyuan/v20230901/models.py +17 -2
  28. tencentcloud/ims/v20201229/models.py +2 -30
  29. tencentcloud/iotexplorer/v20190423/models.py +4 -4
  30. tencentcloud/iotvideo/v20201215/models.py +2 -2
  31. tencentcloud/iotvideo/v20211125/models.py +2 -2
  32. tencentcloud/kms/v20190118/errorcodes.py +36 -0
  33. tencentcloud/kms/v20190118/kms_client.py +345 -0
  34. tencentcloud/kms/v20190118/models.py +3437 -1534
  35. tencentcloud/lighthouse/v20200324/errorcodes.py +9 -0
  36. tencentcloud/lke/v20231130/lke_client.py +92 -0
  37. tencentcloud/lke/v20231130/models.py +2782 -622
  38. tencentcloud/mongodb/v20190725/models.py +15 -0
  39. tencentcloud/mps/v20190612/models.py +217 -18
  40. tencentcloud/mqtt/v20240516/errorcodes.py +3 -0
  41. tencentcloud/mqtt/v20240516/models.py +255 -0
  42. tencentcloud/mqtt/v20240516/mqtt_client.py +23 -0
  43. tencentcloud/redis/v20180412/models.py +6 -6
  44. tencentcloud/ses/v20201002/models.py +0 -8
  45. tencentcloud/tcss/v20201101/models.py +15 -0
  46. tencentcloud/thpc/v20230321/models.py +47 -2
  47. tencentcloud/tione/v20211111/models.py +15 -0
  48. tencentcloud/tke/v20180525/models.py +19 -0
  49. tencentcloud/trocket/v20230308/models.py +624 -354
  50. tencentcloud/trocket/v20230308/trocket_client.py +28 -5
  51. tencentcloud/vm/v20210922/models.py +45 -172
  52. tencentcloud/vpc/v20170312/models.py +15 -0
  53. tencentcloud/waf/v20180125/models.py +110 -18
  54. tencentcloud/wedata/v20210820/models.py +1003 -4
  55. tencentcloud/wedata/v20210820/wedata_client.py +71 -2
  56. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/METADATA +1 -1
  57. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/RECORD +60 -55
  58. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/LICENSE +0 -0
  59. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.dist-info}/WHEEL +0 -0
  60. {tencentcloud_sdk_python-3.0.1409.dist-info → tencentcloud_sdk_python-3.0.1411.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
@@ -6326,8 +6334,12 @@ class CreateAccountsRequest(AbstractModel):
6326
6334
  :param _Accounts: 云数据库账号。
6327
6335
  :type Accounts: list of Account
6328
6336
  :param _Password: 新账户的密码。
6337
+ 说明:
6338
+ 1. 在8 ~ 64位字符数以内(推荐12位以上)。
6339
+ 2. 至少包含其中两项:小写字母 a ~ z 或 大写字母 A ~ Z。数字0 ~ 9。_+-,&=!@#$%^*().|。
6340
+ 3. 不能包含非法字符。
6329
6341
  :type Password: str
6330
- :param _Description: 备注信息。
6342
+ :param _Description: 备注信息。最多支持输入255个字符。
6331
6343
  :type Description: str
6332
6344
  :param _MaxUserConnections: 新账户最大可用连接数,默认值为10240,最大可设置值为10240。
6333
6345
  :type MaxUserConnections: int
@@ -6363,6 +6375,10 @@ class CreateAccountsRequest(AbstractModel):
6363
6375
  @property
6364
6376
  def Password(self):
6365
6377
  """新账户的密码。
6378
+ 说明:
6379
+ 1. 在8 ~ 64位字符数以内(推荐12位以上)。
6380
+ 2. 至少包含其中两项:小写字母 a ~ z 或 大写字母 A ~ Z。数字0 ~ 9。_+-,&=!@#$%^*().|。
6381
+ 3. 不能包含非法字符。
6366
6382
  :rtype: str
6367
6383
  """
6368
6384
  return self._Password
@@ -6373,7 +6389,7 @@ class CreateAccountsRequest(AbstractModel):
6373
6389
 
6374
6390
  @property
6375
6391
  def Description(self):
6376
- """备注信息。
6392
+ """备注信息。最多支持输入255个字符。
6377
6393
  :rtype: str
6378
6394
  """
6379
6395
  return self._Description
@@ -6933,15 +6949,15 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6933
6949
 
6934
6950
  def __init__(self):
6935
6951
  r"""
6936
- :param _RuleFilters: 审计规则
6952
+ :param _RuleFilters: 审计规则。
6937
6953
  :type RuleFilters: list of RuleFilters
6938
- :param _RuleTemplateName: 规则模板名称
6954
+ :param _RuleTemplateName: 规则模板名称。最多支持输入30个字符。
6939
6955
  :type RuleTemplateName: str
6940
- :param _Description: 规则模板描述
6956
+ :param _Description: 规则模板描述。最多支持输入200个字符。
6941
6957
  :type Description: str
6942
- :param _AlarmLevel: 告警等级。1-低风险,2-中风险,3-高风险
6958
+ :param _AlarmLevel: 告警等级。1 - 低风险,2 - 中风险,3 - 高风险。默认值为1。
6943
6959
  :type AlarmLevel: int
6944
- :param _AlarmPolicy: 告警策略。0-不告警,1-告警
6960
+ :param _AlarmPolicy: 告警策略。0 - 不告警,1 - 告警。默认值为0。
6945
6961
  :type AlarmPolicy: int
6946
6962
  """
6947
6963
  self._RuleFilters = None
@@ -6952,7 +6968,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6952
6968
 
6953
6969
  @property
6954
6970
  def RuleFilters(self):
6955
- """审计规则
6971
+ """审计规则。
6956
6972
  :rtype: list of RuleFilters
6957
6973
  """
6958
6974
  return self._RuleFilters
@@ -6963,7 +6979,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6963
6979
 
6964
6980
  @property
6965
6981
  def RuleTemplateName(self):
6966
- """规则模板名称
6982
+ """规则模板名称。最多支持输入30个字符。
6967
6983
  :rtype: str
6968
6984
  """
6969
6985
  return self._RuleTemplateName
@@ -6974,7 +6990,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6974
6990
 
6975
6991
  @property
6976
6992
  def Description(self):
6977
- """规则模板描述
6993
+ """规则模板描述。最多支持输入200个字符。
6978
6994
  :rtype: str
6979
6995
  """
6980
6996
  return self._Description
@@ -6985,7 +7001,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6985
7001
 
6986
7002
  @property
6987
7003
  def AlarmLevel(self):
6988
- """告警等级。1-低风险,2-中风险,3-高风险
7004
+ """告警等级。1 - 低风险,2 - 中风险,3 - 高风险。默认值为1。
6989
7005
  :rtype: int
6990
7006
  """
6991
7007
  return self._AlarmLevel
@@ -6996,7 +7012,7 @@ class CreateAuditRuleTemplateRequest(AbstractModel):
6996
7012
 
6997
7013
  @property
6998
7014
  def AlarmPolicy(self):
6999
- """告警策略。0-不告警,1-告警
7015
+ """告警策略。0 - 不告警,1 - 告警。默认值为0。
7000
7016
  :rtype: int
7001
7017
  """
7002
7018
  return self._AlarmPolicy
@@ -7223,7 +7239,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7223
7239
 
7224
7240
  def __init__(self):
7225
7241
  r"""
7226
- :param _ProxyGroupId: 代理组ID
7242
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
7227
7243
  :type ProxyGroupId: str
7228
7244
  :param _WeightMode: 权重分配模式,
7229
7245
  系统自动分配:"system", 自定义:"custom"
@@ -7232,7 +7248,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7232
7248
  :type IsKickOut: bool
7233
7249
  :param _MinCount: 最小保留数量,最小取值:0
7234
7250
  :type MinCount: int
7235
- :param _MaxDelay: 延迟剔除阈值,最小取值:0
7251
+ :param _MaxDelay: 延迟剔除阈值,最小取值:1,范围:1 - 10000,整数。
7236
7252
  :type MaxDelay: int
7237
7253
  :param _FailOver: 是否开启故障转移,取值:"true" | "false"
7238
7254
  :type FailOver: bool
@@ -7244,26 +7260,26 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7244
7260
  :type TransSplit: bool
7245
7261
  :param _ProxyAllocation: 读写权重分配
7246
7262
  :type ProxyAllocation: list of ProxyAllocation
7247
- :param _UniqVpcId: 私有网络ID
7263
+ :param _UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7248
7264
  :type UniqVpcId: str
7249
- :param _UniqSubnetId: 私有子网ID
7265
+ :param _UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7250
7266
  :type UniqSubnetId: str
7251
- :param _ConnectionPool: 是否开启连接池
7267
+ :param _ConnectionPool: 是否开启连接池。默认关闭。
7252
7268
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
7253
7269
  :type ConnectionPool: bool
7254
7270
  :param _Desc: 描述
7255
7271
  :type Desc: str
7256
- :param _Vip: IP地址
7272
+ :param _Vip: IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。
7257
7273
  :type Vip: str
7258
- :param _VPort: 端口
7274
+ :param _VPort: 端口。默认值3306。
7259
7275
  :type VPort: int
7260
7276
  :param _SecurityGroup: 安全组
7261
7277
  :type SecurityGroup: list of str
7262
- :param _ConnectionPoolType: 连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool为true时生效。
7278
+ :param _ConnectionPoolType: 连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool true 时生效。默认值:connection。
7263
7279
  :type ConnectionPoolType: str
7264
- :param _AutoLoadBalance: 是否自适应负载均衡
7280
+ :param _AutoLoadBalance: 是否开启自适应负载均衡。默认关闭。
7265
7281
  :type AutoLoadBalance: bool
7266
- :param _AccessMode: 接入模式
7282
+ :param _AccessMode: 接入模式。nearBy - 就近访问,balance - 均衡分配,默认值:nearBy。
7267
7283
  :type AccessMode: str
7268
7284
  """
7269
7285
  self._ProxyGroupId = None
@@ -7289,7 +7305,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7289
7305
 
7290
7306
  @property
7291
7307
  def ProxyGroupId(self):
7292
- """代理组ID
7308
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
7293
7309
  :rtype: str
7294
7310
  """
7295
7311
  return self._ProxyGroupId
@@ -7334,7 +7350,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7334
7350
 
7335
7351
  @property
7336
7352
  def MaxDelay(self):
7337
- """延迟剔除阈值,最小取值:0
7353
+ """延迟剔除阈值,最小取值:1,范围:1 - 10000,整数。
7338
7354
  :rtype: int
7339
7355
  """
7340
7356
  return self._MaxDelay
@@ -7400,7 +7416,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7400
7416
 
7401
7417
  @property
7402
7418
  def UniqVpcId(self):
7403
- """私有网络ID
7419
+ """私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7404
7420
  :rtype: str
7405
7421
  """
7406
7422
  return self._UniqVpcId
@@ -7411,7 +7427,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7411
7427
 
7412
7428
  @property
7413
7429
  def UniqSubnetId(self):
7414
- """私有子网ID
7430
+ """私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7415
7431
  :rtype: str
7416
7432
  """
7417
7433
  return self._UniqSubnetId
@@ -7422,7 +7438,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7422
7438
 
7423
7439
  @property
7424
7440
  def ConnectionPool(self):
7425
- """是否开启连接池
7441
+ """是否开启连接池。默认关闭。
7426
7442
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
7427
7443
  :rtype: bool
7428
7444
  """
@@ -7445,7 +7461,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7445
7461
 
7446
7462
  @property
7447
7463
  def Vip(self):
7448
- """IP地址
7464
+ """IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。
7449
7465
  :rtype: str
7450
7466
  """
7451
7467
  return self._Vip
@@ -7456,7 +7472,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7456
7472
 
7457
7473
  @property
7458
7474
  def VPort(self):
7459
- """端口
7475
+ """端口。默认值3306。
7460
7476
  :rtype: int
7461
7477
  """
7462
7478
  return self._VPort
@@ -7478,7 +7494,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7478
7494
 
7479
7495
  @property
7480
7496
  def ConnectionPoolType(self):
7481
- """连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool为true时生效。
7497
+ """连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool true 时生效。默认值:connection。
7482
7498
  :rtype: str
7483
7499
  """
7484
7500
  return self._ConnectionPoolType
@@ -7489,7 +7505,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7489
7505
 
7490
7506
  @property
7491
7507
  def AutoLoadBalance(self):
7492
- """是否自适应负载均衡
7508
+ """是否开启自适应负载均衡。默认关闭。
7493
7509
  :rtype: bool
7494
7510
  """
7495
7511
  return self._AutoLoadBalance
@@ -7500,7 +7516,7 @@ class CreateCdbProxyAddressRequest(AbstractModel):
7500
7516
 
7501
7517
  @property
7502
7518
  def AccessMode(self):
7503
- """接入模式
7519
+ """接入模式。nearBy - 就近访问,balance - 均衡分配,默认值:nearBy。
7504
7520
  :rtype: str
7505
7521
  """
7506
7522
  return self._AccessMode
@@ -7596,11 +7612,11 @@ class CreateCdbProxyRequest(AbstractModel):
7596
7612
 
7597
7613
  def __init__(self):
7598
7614
  r"""
7599
- :param _InstanceId: 实例ID
7615
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7600
7616
  :type InstanceId: str
7601
- :param _UniqVpcId: 私有网络ID
7617
+ :param _UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7602
7618
  :type UniqVpcId: str
7603
- :param _UniqSubnetId: 私有子网ID
7619
+ :param _UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7604
7620
  :type UniqSubnetId: str
7605
7621
  :param _ProxyNodeCustom: 节点规格配置。
7606
7622
  示例中参数说明:
@@ -7634,7 +7650,7 @@ Mem:单个代理节点内存数(单位:MB)。
7634
7650
 
7635
7651
  @property
7636
7652
  def InstanceId(self):
7637
- """实例ID
7653
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7638
7654
  :rtype: str
7639
7655
  """
7640
7656
  return self._InstanceId
@@ -7645,7 +7661,7 @@ Mem:单个代理节点内存数(单位:MB)。
7645
7661
 
7646
7662
  @property
7647
7663
  def UniqVpcId(self):
7648
- """私有网络ID
7664
+ """私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7649
7665
  :rtype: str
7650
7666
  """
7651
7667
  return self._UniqVpcId
@@ -7656,7 +7672,7 @@ Mem:单个代理节点内存数(单位:MB)。
7656
7672
 
7657
7673
  @property
7658
7674
  def UniqSubnetId(self):
7659
- """私有子网ID
7675
+ """私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7660
7676
  :rtype: str
7661
7677
  """
7662
7678
  return self._UniqSubnetId
@@ -10879,9 +10895,9 @@ class DeleteAuditLogFileRequest(AbstractModel):
10879
10895
 
10880
10896
  def __init__(self):
10881
10897
  r"""
10882
- :param _FileName: 审计日志文件名称。
10898
+ :param _FileName: 审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。
10883
10899
  :type FileName: str
10884
- :param _InstanceId: 实例 ID
10900
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10885
10901
  :type InstanceId: str
10886
10902
  """
10887
10903
  self._FileName = None
@@ -10889,7 +10905,7 @@ class DeleteAuditLogFileRequest(AbstractModel):
10889
10905
 
10890
10906
  @property
10891
10907
  def FileName(self):
10892
- """审计日志文件名称。
10908
+ """审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。
10893
10909
  :rtype: str
10894
10910
  """
10895
10911
  return self._FileName
@@ -10900,7 +10916,7 @@ class DeleteAuditLogFileRequest(AbstractModel):
10900
10916
 
10901
10917
  @property
10902
10918
  def InstanceId(self):
10903
- """实例 ID
10919
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10904
10920
  :rtype: str
10905
10921
  """
10906
10922
  return self._InstanceId
@@ -11782,9 +11798,9 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
11782
11798
  r"""
11783
11799
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
11784
11800
  :type InstanceId: str
11785
- :param _User: 数据库的账号名称。
11801
+ :param _User: 数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11786
11802
  :type User: str
11787
- :param _Host: 数据库的账号域名。
11803
+ :param _Host: 数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11788
11804
  :type Host: str
11789
11805
  """
11790
11806
  self._InstanceId = None
@@ -11804,7 +11820,7 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
11804
11820
 
11805
11821
  @property
11806
11822
  def User(self):
11807
- """数据库的账号名称。
11823
+ """数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11808
11824
  :rtype: str
11809
11825
  """
11810
11826
  return self._User
@@ -11815,7 +11831,7 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
11815
11831
 
11816
11832
  @property
11817
11833
  def Host(self):
11818
- """数据库的账号域名。
11834
+ """数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
11819
11835
  :rtype: str
11820
11836
  """
11821
11837
  return self._Host
@@ -12494,7 +12510,7 @@ class DescribeAuditLogFilesRequest(AbstractModel):
12494
12510
  r"""
12495
12511
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
12496
12512
  :type InstanceId: str
12497
- :param _Limit: 分页大小参数。默认值为 20,最小值为 1,最大值为 100
12513
+ :param _Limit: 分页大小参数。默认值为20,最小值为1,最大值为300
12498
12514
  :type Limit: int
12499
12515
  :param _Offset: 分页偏移量。
12500
12516
  :type Offset: int
@@ -12519,7 +12535,7 @@ class DescribeAuditLogFilesRequest(AbstractModel):
12519
12535
 
12520
12536
  @property
12521
12537
  def Limit(self):
12522
- """分页大小参数。默认值为 20,最小值为 1,最大值为 100
12538
+ """分页大小参数。默认值为20,最小值为1,最大值为300
12523
12539
  :rtype: int
12524
12540
  """
12525
12541
  return self._Limit
@@ -13222,7 +13238,7 @@ class DescribeAuditRuleTemplatesRequest(AbstractModel):
13222
13238
  :type RuleTemplateIds: list of str
13223
13239
  :param _RuleTemplateNames: 规则模板名称。
13224
13240
  :type RuleTemplateNames: list of str
13225
- :param _Limit: 单次请求返回的数量。默认值20。
13241
+ :param _Limit: 单次请求返回的数量。默认值20,最大值为1000
13226
13242
  :type Limit: int
13227
13243
  :param _Offset: 偏移量,默认值为 0。
13228
13244
  :type Offset: int
@@ -13262,7 +13278,7 @@ class DescribeAuditRuleTemplatesRequest(AbstractModel):
13262
13278
 
13263
13279
  @property
13264
13280
  def Limit(self):
13265
- """单次请求返回的数量。默认值20。
13281
+ """单次请求返回的数量。默认值20,最大值为1000
13266
13282
  :rtype: int
13267
13283
  """
13268
13284
  return self._Limit
@@ -15014,14 +15030,14 @@ class DescribeCPUExpandStrategyInfoRequest(AbstractModel):
15014
15030
 
15015
15031
  def __init__(self):
15016
15032
  r"""
15017
- :param _InstanceId: 实例 ID
15033
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15018
15034
  :type InstanceId: str
15019
15035
  """
15020
15036
  self._InstanceId = None
15021
15037
 
15022
15038
  @property
15023
15039
  def InstanceId(self):
15024
- """实例 ID
15040
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15025
15041
  :rtype: str
15026
15042
  """
15027
15043
  return self._InstanceId
@@ -15050,18 +15066,19 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15050
15066
 
15051
15067
  def __init__(self):
15052
15068
  r"""
15053
- :param _Type: 策略类型。输出值 auto、manual。如果返回为 NULL 说明尚未开通弹性扩容策略。
15069
+ :param _Type: 策略类型。输出值:auto、manual、timeInterval、period。
15070
+ 说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。5. 如果返回为 NULL 说明尚未开通弹性扩容策略。
15054
15071
  注意:此字段可能返回 null,表示取不到有效值。
15055
15072
  :type Type: str
15056
- :param _ExpandCpu: 手动扩容的 CPU 。Type 为 manual 时有效。
15073
+ :param _ExpandCpu: 自定义扩容,且扩容时间为立即生效时的 CPU。Type 为 manual 时有效。
15057
15074
  注意:此字段可能返回 null,表示取不到有效值。
15058
15075
  :type ExpandCpu: int
15059
15076
  :param _AutoStrategy: 自动扩容策略。Type 为 auto 时有效。
15060
15077
  注意:此字段可能返回 null,表示取不到有效值。
15061
15078
  :type AutoStrategy: :class:`tencentcloud.cdb.v20170320.models.AutoStrategy`
15062
- :param _PeriodStrategy: 按周期扩容策略。
15079
+ :param _PeriodStrategy: 按周期扩容策略。当 Type 为 period 时有效。
15063
15080
  :type PeriodStrategy: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
15064
- :param _TimeIntervalStrategy: 按时间段扩容策略。
15081
+ :param _TimeIntervalStrategy: 按时间段扩容策略。当 Type 为 timeInterval 时有效。
15065
15082
  :type TimeIntervalStrategy: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
15066
15083
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
15067
15084
  :type RequestId: str
@@ -15075,7 +15092,8 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15075
15092
 
15076
15093
  @property
15077
15094
  def Type(self):
15078
- """策略类型。输出值 auto、manual。如果返回为 NULL 说明尚未开通弹性扩容策略。
15095
+ """策略类型。输出值:auto、manual、timeInterval、period。
15096
+ 说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。5. 如果返回为 NULL 说明尚未开通弹性扩容策略。
15079
15097
  注意:此字段可能返回 null,表示取不到有效值。
15080
15098
  :rtype: str
15081
15099
  """
@@ -15087,7 +15105,7 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15087
15105
 
15088
15106
  @property
15089
15107
  def ExpandCpu(self):
15090
- """手动扩容的 CPU 。Type 为 manual 时有效。
15108
+ """自定义扩容,且扩容时间为立即生效时的 CPU。Type 为 manual 时有效。
15091
15109
  注意:此字段可能返回 null,表示取不到有效值。
15092
15110
  :rtype: int
15093
15111
  """
@@ -15111,7 +15129,7 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15111
15129
 
15112
15130
  @property
15113
15131
  def PeriodStrategy(self):
15114
- """按周期扩容策略。
15132
+ """按周期扩容策略。当 Type 为 period 时有效。
15115
15133
  :rtype: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
15116
15134
  """
15117
15135
  return self._PeriodStrategy
@@ -15122,7 +15140,7 @@ class DescribeCPUExpandStrategyInfoResponse(AbstractModel):
15122
15140
 
15123
15141
  @property
15124
15142
  def TimeIntervalStrategy(self):
15125
- """按时间段扩容策略。
15143
+ """按时间段扩容策略。当 Type 为 timeInterval 时有效。
15126
15144
  :rtype: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
15127
15145
  """
15128
15146
  return self._TimeIntervalStrategy
@@ -15459,14 +15477,16 @@ class DescribeClusterInfoRequest(AbstractModel):
15459
15477
 
15460
15478
  def __init__(self):
15461
15479
  r"""
15462
- :param _InstanceId: 实例 ID
15480
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15481
+ 说明:仅能输入实例架构为云盘版的实例 ID,对应控制台实例配置显示为“云盘版(云盘)”的实例。
15463
15482
  :type InstanceId: str
15464
15483
  """
15465
15484
  self._InstanceId = None
15466
15485
 
15467
15486
  @property
15468
15487
  def InstanceId(self):
15469
- """实例 ID
15488
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
15489
+ 说明:仅能输入实例架构为云盘版的实例 ID,对应控制台实例配置显示为“云盘版(云盘)”的实例。
15470
15490
  :rtype: str
15471
15491
  """
15472
15492
  return self._InstanceId
@@ -19507,9 +19527,10 @@ class DescribeInstanceUpgradeCheckJobRequest(AbstractModel):
19507
19527
 
19508
19528
  def __init__(self):
19509
19529
  r"""
19510
- :param _InstanceId: 实例ID
19530
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
19511
19531
  :type InstanceId: str
19512
- :param _DstMysqlVersion: 目标数据库版本
19532
+ :param _DstMysqlVersion: 目标数据库版本。
19533
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
19513
19534
  :type DstMysqlVersion: str
19514
19535
  """
19515
19536
  self._InstanceId = None
@@ -19517,7 +19538,7 @@ class DescribeInstanceUpgradeCheckJobRequest(AbstractModel):
19517
19538
 
19518
19539
  @property
19519
19540
  def InstanceId(self):
19520
- """实例ID
19541
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
19521
19542
  :rtype: str
19522
19543
  """
19523
19544
  return self._InstanceId
@@ -19528,7 +19549,8 @@ class DescribeInstanceUpgradeCheckJobRequest(AbstractModel):
19528
19549
 
19529
19550
  @property
19530
19551
  def DstMysqlVersion(self):
19531
- """目标数据库版本
19552
+ """目标数据库版本。
19553
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
19532
19554
  :rtype: str
19533
19555
  """
19534
19556
  return self._DstMysqlVersion
@@ -20325,14 +20347,14 @@ class DescribeProjectSecurityGroupsRequest(AbstractModel):
20325
20347
 
20326
20348
  def __init__(self):
20327
20349
  r"""
20328
- :param _ProjectId: 项目ID
20350
+ :param _ProjectId: 项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。
20329
20351
  :type ProjectId: int
20330
20352
  """
20331
20353
  self._ProjectId = None
20332
20354
 
20333
20355
  @property
20334
20356
  def ProjectId(self):
20335
- """项目ID
20357
+ """项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。
20336
20358
  :rtype: int
20337
20359
  """
20338
20360
  return self._ProjectId
@@ -20567,14 +20589,14 @@ class DescribeProxySupportParamRequest(AbstractModel):
20567
20589
 
20568
20590
  def __init__(self):
20569
20591
  r"""
20570
- :param _InstanceId: 实例ID
20592
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
20571
20593
  :type InstanceId: str
20572
20594
  """
20573
20595
  self._InstanceId = None
20574
20596
 
20575
20597
  @property
20576
20598
  def InstanceId(self):
20577
- """实例ID
20599
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
20578
20600
  :rtype: str
20579
20601
  """
20580
20602
  return self._InstanceId
@@ -26635,11 +26657,11 @@ class ModifyAccountHostRequest(AbstractModel):
26635
26657
  r"""
26636
26658
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
26637
26659
  :type InstanceId: str
26638
- :param _User: 账户的名称
26660
+ :param _User: 账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26639
26661
  :type User: str
26640
- :param _Host: 账户的旧主机
26662
+ :param _Host: 账户的旧主机。格式:IP 形式,支持单个 IP 地址或者%。
26641
26663
  :type Host: str
26642
- :param _NewHost: 账户的新主机
26664
+ :param _NewHost: 账户的新主机。格式:IP 形式,支持单个 IP 地址或者%。
26643
26665
  :type NewHost: str
26644
26666
  """
26645
26667
  self._InstanceId = None
@@ -26660,7 +26682,7 @@ class ModifyAccountHostRequest(AbstractModel):
26660
26682
 
26661
26683
  @property
26662
26684
  def User(self):
26663
- """账户的名称
26685
+ """账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26664
26686
  :rtype: str
26665
26687
  """
26666
26688
  return self._User
@@ -26671,7 +26693,7 @@ class ModifyAccountHostRequest(AbstractModel):
26671
26693
 
26672
26694
  @property
26673
26695
  def Host(self):
26674
- """账户的旧主机
26696
+ """账户的旧主机。格式:IP 形式,支持单个 IP 地址或者%。
26675
26697
  :rtype: str
26676
26698
  """
26677
26699
  return self._Host
@@ -26682,7 +26704,7 @@ class ModifyAccountHostRequest(AbstractModel):
26682
26704
 
26683
26705
  @property
26684
26706
  def NewHost(self):
26685
- """账户的新主机
26707
+ """账户的新主机。格式:IP 形式,支持单个 IP 地址或者%。
26686
26708
  :rtype: str
26687
26709
  """
26688
26710
  return self._NewHost
@@ -26757,7 +26779,7 @@ class ModifyAccountMaxUserConnectionsRequest(AbstractModel):
26757
26779
 
26758
26780
  def __init__(self):
26759
26781
  r"""
26760
- :param _Accounts: 云数据库账号。
26782
+ :param _Accounts: 云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26761
26783
  :type Accounts: list of Account
26762
26784
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
26763
26785
  :type InstanceId: str
@@ -26770,7 +26792,7 @@ class ModifyAccountMaxUserConnectionsRequest(AbstractModel):
26770
26792
 
26771
26793
  @property
26772
26794
  def Accounts(self):
26773
- """云数据库账号。
26795
+ """云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26774
26796
  :rtype: list of Account
26775
26797
  """
26776
26798
  return self._Accounts
@@ -26875,7 +26897,7 @@ class ModifyAccountPasswordRequest(AbstractModel):
26875
26897
  :type InstanceId: str
26876
26898
  :param _NewPassword: 数据库账号的新密码。密码应至少包含字母、数字和字符(_+-&=!@#$%^*())中的两种,长度为8-64个字符。
26877
26899
  :type NewPassword: str
26878
- :param _Accounts: 云数据库账号。
26900
+ :param _Accounts: 云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26879
26901
  :type Accounts: list of Account
26880
26902
  """
26881
26903
  self._InstanceId = None
@@ -26906,7 +26928,7 @@ class ModifyAccountPasswordRequest(AbstractModel):
26906
26928
 
26907
26929
  @property
26908
26930
  def Accounts(self):
26909
- """云数据库账号。
26931
+ """云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26910
26932
  :rtype: list of Account
26911
26933
  """
26912
26934
  return self._Accounts
@@ -26987,7 +27009,7 @@ class ModifyAccountPrivilegesRequest(AbstractModel):
26987
27009
  r"""
26988
27010
  :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
26989
27011
  :type InstanceId: str
26990
- :param _Accounts: 数据库的账号,包括用户名和域名。
27012
+ :param _Accounts: 数据库的账号,包括用户名和域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
26991
27013
  :type Accounts: list of Account
26992
27014
  :param _GlobalPrivileges: 全局权限。其中,GlobalPrivileges 中权限的可选值为:"SELECT","INSERT","UPDATE","DELETE","CREATE", "PROCESS", "DROP","REFERENCES","INDEX","ALTER","SHOW DATABASES","CREATE TEMPORARY TABLES","LOCK TABLES","EXECUTE","CREATE VIEW","SHOW VIEW","CREATE ROUTINE","ALTER ROUTINE","EVENT","TRIGGER","CREATE USER","RELOAD","REPLICATION CLIENT","REPLICATION SLAVE"。
26993
27015
  注意,ModifyAction为空时,不传该参数表示清除该权限。
@@ -27025,7 +27047,7 @@ class ModifyAccountPrivilegesRequest(AbstractModel):
27025
27047
 
27026
27048
  @property
27027
27049
  def Accounts(self):
27028
- """数据库的账号,包括用户名和域名。
27050
+ """数据库的账号,包括用户名和域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
27029
27051
  :rtype: list of Account
27030
27052
  """
27031
27053
  return self._Accounts
@@ -27182,7 +27204,7 @@ class ModifyAuditConfigRequest(AbstractModel):
27182
27204
 
27183
27205
  def __init__(self):
27184
27206
  r"""
27185
- :param _InstanceId: 实例 ID
27207
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27186
27208
  :type InstanceId: str
27187
27209
  :param _LogExpireDay: 审计日志保存时长。支持值包括:
27188
27210
  7 - 一周
@@ -27193,8 +27215,10 @@ class ModifyAuditConfigRequest(AbstractModel):
27193
27215
  1825 - 五年;
27194
27216
  :type LogExpireDay: int
27195
27217
  :param _CloseAudit: 是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。
27196
- 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27197
- CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按照CloseAudit优先的逻辑处理。
27218
+ 说明:
27219
+ 1. 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27220
+ 2. CloseAudit、LogExpireDay 必须至少提供一个,如果两个都提供则按照 CloseAudit 优先的逻辑处理。
27221
+ 3. 可通过设置此参数来关闭审计服务,已关闭后不能通过此接口来开启审计服务。
27198
27222
  :type CloseAudit: bool
27199
27223
  :param _HighLogExpireDay: 高频审计日志保存时长。支持值包括:
27200
27224
  7 - 一周
@@ -27212,7 +27236,7 @@ CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按
27212
27236
 
27213
27237
  @property
27214
27238
  def InstanceId(self):
27215
- """实例 ID
27239
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27216
27240
  :rtype: str
27217
27241
  """
27218
27242
  return self._InstanceId
@@ -27241,8 +27265,10 @@ CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按
27241
27265
  @property
27242
27266
  def CloseAudit(self):
27243
27267
  """是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。
27244
- 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27245
- CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按照CloseAudit优先的逻辑处理。
27268
+ 说明:
27269
+ 1. 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
27270
+ 2. CloseAudit、LogExpireDay 必须至少提供一个,如果两个都提供则按照 CloseAudit 优先的逻辑处理。
27271
+ 3. 可通过设置此参数来关闭审计服务,已关闭后不能通过此接口来开启审计服务。
27246
27272
  :rtype: bool
27247
27273
  """
27248
27274
  return self._CloseAudit
@@ -27448,7 +27474,7 @@ class ModifyAuditRuleTemplatesRequest(AbstractModel):
27448
27474
 
27449
27475
  def __init__(self):
27450
27476
  r"""
27451
- :param _RuleTemplateIds: 审计规则模板ID
27477
+ :param _RuleTemplateIds: 审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27452
27478
  :type RuleTemplateIds: list of str
27453
27479
  :param _RuleFilters: 修改后的审计规则。
27454
27480
  :type RuleFilters: list of RuleFilters
@@ -27470,7 +27496,7 @@ class ModifyAuditRuleTemplatesRequest(AbstractModel):
27470
27496
 
27471
27497
  @property
27472
27498
  def RuleTemplateIds(self):
27473
- """审计规则模板ID
27499
+ """审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27474
27500
  :rtype: list of str
27475
27501
  """
27476
27502
  return self._RuleTemplateIds
@@ -27592,17 +27618,32 @@ class ModifyAuditServiceRequest(AbstractModel):
27592
27618
 
27593
27619
  def __init__(self):
27594
27620
  r"""
27595
- :param _InstanceId: 实例ID
27621
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27596
27622
  :type InstanceId: str
27597
- :param _LogExpireDay: 日志保留时长。
27623
+ :param _LogExpireDay: 日志保留时长。支持值包括:
27624
+ 7 - 一周;
27625
+ 30 - 一个月;
27626
+ 90 - 三个月;
27627
+ 180 - 六个月;
27628
+ 365 - 一年;
27629
+ 1095 - 三年;
27630
+ 1825 - 五年。
27598
27631
  :type LogExpireDay: int
27599
- :param _HighLogExpireDay: 高频日志保留时长。
27632
+ :param _HighLogExpireDay: 高频日志保留时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
27633
+ 3 - 3天;
27634
+ 7 - 一周;
27635
+ 30 - 一个月;
27636
+ 90 - 三个月;
27637
+ 180 - 六个月;
27638
+ 365 - 一年;
27639
+ 1095 - 三年;
27640
+ 1825 - 五年。
27600
27641
  :type HighLogExpireDay: int
27601
27642
  :param _AuditAll: 修改实例审计规则为全审计。
27602
27643
  :type AuditAll: bool
27603
27644
  :param _AuditRuleFilters: 废弃。
27604
27645
  :type AuditRuleFilters: list of AuditRuleFilters
27605
- :param _RuleTemplateIds: 规则模板ID
27646
+ :param _RuleTemplateIds: 规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27606
27647
  :type RuleTemplateIds: list of str
27607
27648
  """
27608
27649
  self._InstanceId = None
@@ -27614,7 +27655,7 @@ class ModifyAuditServiceRequest(AbstractModel):
27614
27655
 
27615
27656
  @property
27616
27657
  def InstanceId(self):
27617
- """实例ID
27658
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
27618
27659
  :rtype: str
27619
27660
  """
27620
27661
  return self._InstanceId
@@ -27625,7 +27666,14 @@ class ModifyAuditServiceRequest(AbstractModel):
27625
27666
 
27626
27667
  @property
27627
27668
  def LogExpireDay(self):
27628
- """日志保留时长。
27669
+ """日志保留时长。支持值包括:
27670
+ 7 - 一周;
27671
+ 30 - 一个月;
27672
+ 90 - 三个月;
27673
+ 180 - 六个月;
27674
+ 365 - 一年;
27675
+ 1095 - 三年;
27676
+ 1825 - 五年。
27629
27677
  :rtype: int
27630
27678
  """
27631
27679
  return self._LogExpireDay
@@ -27636,7 +27684,15 @@ class ModifyAuditServiceRequest(AbstractModel):
27636
27684
 
27637
27685
  @property
27638
27686
  def HighLogExpireDay(self):
27639
- """高频日志保留时长。
27687
+ """高频日志保留时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
27688
+ 3 - 3天;
27689
+ 7 - 一周;
27690
+ 30 - 一个月;
27691
+ 90 - 三个月;
27692
+ 180 - 六个月;
27693
+ 365 - 一年;
27694
+ 1095 - 三年;
27695
+ 1825 - 五年。
27640
27696
  :rtype: int
27641
27697
  """
27642
27698
  return self._HighLogExpireDay
@@ -27673,7 +27729,7 @@ class ModifyAuditServiceRequest(AbstractModel):
27673
27729
 
27674
27730
  @property
27675
27731
  def RuleTemplateIds(self):
27676
- """规则模板ID
27732
+ """规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
27677
27733
  :rtype: list of str
27678
27734
  """
27679
27735
  return self._RuleTemplateIds
@@ -28388,9 +28444,9 @@ class ModifyCdbProxyAddressDescRequest(AbstractModel):
28388
28444
 
28389
28445
  def __init__(self):
28390
28446
  r"""
28391
- :param _ProxyGroupId: 代理组ID
28447
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28392
28448
  :type ProxyGroupId: str
28393
- :param _ProxyAddressId: 代理组地址ID
28449
+ :param _ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28394
28450
  :type ProxyAddressId: str
28395
28451
  :param _Desc: 描述
28396
28452
  :type Desc: str
@@ -28401,7 +28457,7 @@ class ModifyCdbProxyAddressDescRequest(AbstractModel):
28401
28457
 
28402
28458
  @property
28403
28459
  def ProxyGroupId(self):
28404
- """代理组ID
28460
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28405
28461
  :rtype: str
28406
28462
  """
28407
28463
  return self._ProxyGroupId
@@ -28412,7 +28468,7 @@ class ModifyCdbProxyAddressDescRequest(AbstractModel):
28412
28468
 
28413
28469
  @property
28414
28470
  def ProxyAddressId(self):
28415
- """代理组地址ID
28471
+ """代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28416
28472
  :rtype: str
28417
28473
  """
28418
28474
  return self._ProxyAddressId
@@ -28482,19 +28538,19 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28482
28538
 
28483
28539
  def __init__(self):
28484
28540
  r"""
28485
- :param _ProxyGroupId: 代理组ID
28541
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28486
28542
  :type ProxyGroupId: str
28487
- :param _ProxyAddressId: 代理组地址ID
28543
+ :param _ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28488
28544
  :type ProxyAddressId: str
28489
- :param _UniqVpcId: 私有网络ID
28545
+ :param _UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28490
28546
  :type UniqVpcId: str
28491
- :param _UniqSubnetId: 私有子网ID
28547
+ :param _UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28492
28548
  :type UniqSubnetId: str
28493
- :param _Vip: IP地址
28549
+ :param _Vip: IP 地址。若不填写则自动分配子网下的可用 IP。
28494
28550
  :type Vip: str
28495
- :param _VPort: 端口
28551
+ :param _VPort: 端口。默认值3306,取值范围:1024 - 65535。
28496
28552
  :type VPort: int
28497
- :param _ReleaseDuration: 旧IP地址回收时间
28553
+ :param _ReleaseDuration: 旧 IP 地址回收时间。单位:小时,默认值:24,取值范围:0 - 168。
28498
28554
  :type ReleaseDuration: int
28499
28555
  """
28500
28556
  self._ProxyGroupId = None
@@ -28507,7 +28563,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28507
28563
 
28508
28564
  @property
28509
28565
  def ProxyGroupId(self):
28510
- """代理组ID
28566
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28511
28567
  :rtype: str
28512
28568
  """
28513
28569
  return self._ProxyGroupId
@@ -28518,7 +28574,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28518
28574
 
28519
28575
  @property
28520
28576
  def ProxyAddressId(self):
28521
- """代理组地址ID
28577
+ """代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28522
28578
  :rtype: str
28523
28579
  """
28524
28580
  return self._ProxyAddressId
@@ -28529,7 +28585,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28529
28585
 
28530
28586
  @property
28531
28587
  def UniqVpcId(self):
28532
- """私有网络ID
28588
+ """私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28533
28589
  :rtype: str
28534
28590
  """
28535
28591
  return self._UniqVpcId
@@ -28540,7 +28596,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28540
28596
 
28541
28597
  @property
28542
28598
  def UniqSubnetId(self):
28543
- """私有子网ID
28599
+ """私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28544
28600
  :rtype: str
28545
28601
  """
28546
28602
  return self._UniqSubnetId
@@ -28551,7 +28607,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28551
28607
 
28552
28608
  @property
28553
28609
  def Vip(self):
28554
- """IP地址
28610
+ """IP 地址。若不填写则自动分配子网下的可用 IP。
28555
28611
  :rtype: str
28556
28612
  """
28557
28613
  return self._Vip
@@ -28562,7 +28618,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28562
28618
 
28563
28619
  @property
28564
28620
  def VPort(self):
28565
- """端口
28621
+ """端口。默认值3306,取值范围:1024 - 65535。
28566
28622
  :rtype: int
28567
28623
  """
28568
28624
  return self._VPort
@@ -28573,7 +28629,7 @@ class ModifyCdbProxyAddressVipAndVPortRequest(AbstractModel):
28573
28629
 
28574
28630
  @property
28575
28631
  def ReleaseDuration(self):
28576
- """旧IP地址回收时间
28632
+ """旧 IP 地址回收时间。单位:小时,默认值:24,取值范围:0 - 168。
28577
28633
  :rtype: int
28578
28634
  """
28579
28635
  return self._ReleaseDuration
@@ -28636,11 +28692,11 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28636
28692
 
28637
28693
  def __init__(self):
28638
28694
  r"""
28639
- :param _InstanceId: 实例ID
28695
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28640
28696
  :type InstanceId: str
28641
- :param _ProxyGroupId: 代理组ID
28697
+ :param _ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28642
28698
  :type ProxyGroupId: str
28643
- :param _ConnectionPoolLimit: 连接池阈值
28699
+ :param _ConnectionPoolLimit: 连接池阈值。取值范围:大于0,小于等于300。
28644
28700
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
28645
28701
  :type ConnectionPoolLimit: int
28646
28702
  """
@@ -28650,7 +28706,7 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28650
28706
 
28651
28707
  @property
28652
28708
  def InstanceId(self):
28653
- """实例ID
28709
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
28654
28710
  :rtype: str
28655
28711
  """
28656
28712
  return self._InstanceId
@@ -28661,7 +28717,7 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28661
28717
 
28662
28718
  @property
28663
28719
  def ProxyGroupId(self):
28664
- """代理组ID
28720
+ """代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
28665
28721
  :rtype: str
28666
28722
  """
28667
28723
  return self._ProxyGroupId
@@ -28672,7 +28728,7 @@ class ModifyCdbProxyParamRequest(AbstractModel):
28672
28728
 
28673
28729
  @property
28674
28730
  def ConnectionPoolLimit(self):
28675
- """连接池阈值
28731
+ """连接池阈值。取值范围:大于0,小于等于300。
28676
28732
  注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
28677
28733
  :rtype: int
28678
28734
  """
@@ -30359,11 +30415,11 @@ class ModifyRoGroupInfoRequest(AbstractModel):
30359
30415
 
30360
30416
  def __init__(self):
30361
30417
  r"""
30362
- :param _RoGroupId: RO 组的 ID
30418
+ :param _RoGroupId: RO 组的 ID。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
30363
30419
  :type RoGroupId: str
30364
30420
  :param _RoGroupInfo: RO 组的详细信息。
30365
30421
  :type RoGroupInfo: :class:`tencentcloud.cdb.v20170320.models.RoGroupAttr`
30366
- :param _RoWeightValues: RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。
30422
+ :param _RoWeightValues: RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。RO 实例 ID 可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
30367
30423
  :type RoWeightValues: list of RoWeightValue
30368
30424
  :param _IsBalanceRoLoad: 是否重新均衡 RO 组内的 RO 实例的负载。支持值包括:1 - 重新均衡负载;0 - 不重新均衡负载。默认值为 0。注意,设置为重新均衡负载时,RO 组内 RO 实例会有一次数据库连接瞬断,请确保应用程序能重连数据库。
30369
30425
  :type IsBalanceRoLoad: int
@@ -30378,7 +30434,7 @@ class ModifyRoGroupInfoRequest(AbstractModel):
30378
30434
 
30379
30435
  @property
30380
30436
  def RoGroupId(self):
30381
- """RO 组的 ID
30437
+ """RO 组的 ID。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
30382
30438
  :rtype: str
30383
30439
  """
30384
30440
  return self._RoGroupId
@@ -30400,7 +30456,7 @@ class ModifyRoGroupInfoRequest(AbstractModel):
30400
30456
 
30401
30457
  @property
30402
30458
  def RoWeightValues(self):
30403
- """RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。
30459
+ """RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。RO 实例 ID 可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
30404
30460
  :rtype: list of RoWeightValue
30405
30461
  """
30406
30462
  return self._RoWeightValues
@@ -30768,26 +30824,32 @@ class OpenAuditServiceRequest(AbstractModel):
30768
30824
 
30769
30825
  def __init__(self):
30770
30826
  r"""
30771
- :param _InstanceId: CDB实例ID
30827
+ :param _InstanceId: CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30772
30828
  :type InstanceId: str
30773
30829
  :param _LogExpireDay: 审计日志保存时长。支持值包括:
30774
- 7 - 一周
30830
+ 7 - 一周;
30775
30831
  30 - 一个月;
30776
30832
  90 - 三个月;
30777
30833
  180 - 六个月;
30778
30834
  365 - 一年;
30779
30835
  1095 - 三年;
30780
- 1825 - 五年;
30836
+ 1825 - 五年。
30781
30837
  :type LogExpireDay: int
30782
- :param _HighLogExpireDay: 高频审计日志保存时长。支持值包括:
30783
- 7 - 一周
30838
+ :param _HighLogExpireDay: 高频审计日志保存时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
30839
+ 3 - 3天;
30840
+ 7 - 一周;
30784
30841
  30 - 一个月;
30842
+ 90 - 三个月;
30843
+ 180 - 六个月;
30844
+ 365 - 一年;
30845
+ 1095 - 三年;
30846
+ 1825 - 五年。
30785
30847
  :type HighLogExpireDay: int
30786
30848
  :param _AuditRuleFilters: 审计规则(该参数已废弃,不再生效)。
30787
30849
  :type AuditRuleFilters: list of AuditRuleFilters
30788
- :param _RuleTemplateIds: 规则模板ID。同AuditRuleFilters都不填是全审计。
30850
+ :param _RuleTemplateIds: 规则模板 ID
30789
30851
  :type RuleTemplateIds: list of str
30790
- :param _AuditAll: 审计类型。true-全审计;默认false-规则审计。
30852
+ :param _AuditAll: 审计类型。true - 全审计;默认 false - 规则审计。
30791
30853
  :type AuditAll: bool
30792
30854
  """
30793
30855
  self._InstanceId = None
@@ -30799,7 +30861,7 @@ class OpenAuditServiceRequest(AbstractModel):
30799
30861
 
30800
30862
  @property
30801
30863
  def InstanceId(self):
30802
- """CDB实例ID
30864
+ """CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30803
30865
  :rtype: str
30804
30866
  """
30805
30867
  return self._InstanceId
@@ -30811,13 +30873,13 @@ class OpenAuditServiceRequest(AbstractModel):
30811
30873
  @property
30812
30874
  def LogExpireDay(self):
30813
30875
  """审计日志保存时长。支持值包括:
30814
- 7 - 一周
30876
+ 7 - 一周;
30815
30877
  30 - 一个月;
30816
30878
  90 - 三个月;
30817
30879
  180 - 六个月;
30818
30880
  365 - 一年;
30819
30881
  1095 - 三年;
30820
- 1825 - 五年;
30882
+ 1825 - 五年。
30821
30883
  :rtype: int
30822
30884
  """
30823
30885
  return self._LogExpireDay
@@ -30828,9 +30890,15 @@ class OpenAuditServiceRequest(AbstractModel):
30828
30890
 
30829
30891
  @property
30830
30892
  def HighLogExpireDay(self):
30831
- """高频审计日志保存时长。支持值包括:
30832
- 7 - 一周
30893
+ """高频审计日志保存时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
30894
+ 3 - 3天;
30895
+ 7 - 一周;
30833
30896
  30 - 一个月;
30897
+ 90 - 三个月;
30898
+ 180 - 六个月;
30899
+ 365 - 一年;
30900
+ 1095 - 三年;
30901
+ 1825 - 五年。
30834
30902
  :rtype: int
30835
30903
  """
30836
30904
  return self._HighLogExpireDay
@@ -30856,7 +30924,7 @@ class OpenAuditServiceRequest(AbstractModel):
30856
30924
 
30857
30925
  @property
30858
30926
  def RuleTemplateIds(self):
30859
- """规则模板ID。同AuditRuleFilters都不填是全审计。
30927
+ """规则模板 ID
30860
30928
  :rtype: list of str
30861
30929
  """
30862
30930
  return self._RuleTemplateIds
@@ -30867,7 +30935,7 @@ class OpenAuditServiceRequest(AbstractModel):
30867
30935
 
30868
30936
  @property
30869
30937
  def AuditAll(self):
30870
- """审计类型。true-全审计;默认false-规则审计。
30938
+ """审计类型。true - 全审计;默认 false - 规则审计。
30871
30939
  :rtype: bool
30872
30940
  """
30873
30941
  return self._AuditAll
@@ -30934,7 +31002,7 @@ class OpenDBInstanceEncryptionRequest(AbstractModel):
30934
31002
 
30935
31003
  def __init__(self):
30936
31004
  r"""
30937
- :param _InstanceId: 云数据库实例 ID
31005
+ :param _InstanceId: 云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30938
31006
  :type InstanceId: str
30939
31007
  :param _KeyId: 用户自定义密钥 ID,CMK 唯一标识符。该值为空时,将使用腾讯云自动生成的密钥 KMS-CDB。
30940
31008
  :type KeyId: str
@@ -30947,7 +31015,7 @@ class OpenDBInstanceEncryptionRequest(AbstractModel):
30947
31015
 
30948
31016
  @property
30949
31017
  def InstanceId(self):
30950
- """云数据库实例 ID
31018
+ """云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
30951
31019
  :rtype: str
30952
31020
  """
30953
31021
  return self._InstanceId
@@ -31107,9 +31175,9 @@ class OpenSSLRequest(AbstractModel):
31107
31175
 
31108
31176
  def __init__(self):
31109
31177
  r"""
31110
- :param _InstanceId: 实例 ID
31178
+ :param _InstanceId: 实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
31111
31179
  :type InstanceId: str
31112
- :param _RoGroupId: 只读组 ID
31180
+ :param _RoGroupId: 只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
31113
31181
  :type RoGroupId: str
31114
31182
  """
31115
31183
  self._InstanceId = None
@@ -31117,7 +31185,7 @@ class OpenSSLRequest(AbstractModel):
31117
31185
 
31118
31186
  @property
31119
31187
  def InstanceId(self):
31120
- """实例 ID
31188
+ """实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
31121
31189
  :rtype: str
31122
31190
  """
31123
31191
  return self._InstanceId
@@ -31128,7 +31196,7 @@ class OpenSSLRequest(AbstractModel):
31128
31196
 
31129
31197
  @property
31130
31198
  def RoGroupId(self):
31131
- """只读组 ID
31199
+ """只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
31132
31200
  :rtype: str
31133
31201
  """
31134
31202
  return self._RoGroupId
@@ -31201,7 +31269,7 @@ class OpenWanServiceRequest(AbstractModel):
31201
31269
 
31202
31270
  def __init__(self):
31203
31271
  r"""
31204
- :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
31272
+ :param _InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。
31205
31273
  :type InstanceId: str
31206
31274
  :param _OpResourceId: 变更集群版实例只读组时,InstanceId传实例id,需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。
31207
31275
  :type OpResourceId: str
@@ -31211,7 +31279,7 @@ class OpenWanServiceRequest(AbstractModel):
31211
31279
 
31212
31280
  @property
31213
31281
  def InstanceId(self):
31214
- """实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
31282
+ """实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。
31215
31283
  :rtype: str
31216
31284
  """
31217
31285
  return self._InstanceId
@@ -34046,15 +34114,17 @@ class RoGroupAttr(AbstractModel):
34046
34114
  r"""
34047
34115
  :param _RoGroupName: RO 组名称。
34048
34116
  :type RoGroupName: str
34049
- :param _RoMaxDelayTime: RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34117
+ :param _RoMaxDelayTime: RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。
34118
+ 注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34050
34119
  :type RoMaxDelayTime: int
34051
34120
  :param _RoOfflineDelay: 是否开启实例延迟剔除。支持的值包括:1 - 开启;0 - 不开启。注意,若设置开启实例延迟剔除,则必须设置延迟阈值(RoMaxDelayTime)参数。
34052
34121
  :type RoOfflineDelay: int
34053
- :param _MinRoInGroup: 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34122
+ :param _MinRoInGroup: 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。
34123
+ 注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34054
34124
  :type MinRoInGroup: int
34055
34125
  :param _WeightMode: 权重模式。支持值包括:"system" - 系统自动分配; "custom" - 用户自定义设置。注意,若设置 "custom" 模式,则必须设置 RO 实例权重配置(RoWeightValues)参数。
34056
34126
  :type WeightMode: str
34057
- :param _ReplicationDelayTime: 延迟复制时间。
34127
+ :param _ReplicationDelayTime: 延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。
34058
34128
  :type ReplicationDelayTime: int
34059
34129
  """
34060
34130
  self._RoGroupName = None
@@ -34077,7 +34147,8 @@ class RoGroupAttr(AbstractModel):
34077
34147
 
34078
34148
  @property
34079
34149
  def RoMaxDelayTime(self):
34080
- """RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34150
+ """RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。
34151
+ 注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。
34081
34152
  :rtype: int
34082
34153
  """
34083
34154
  return self._RoMaxDelayTime
@@ -34099,7 +34170,8 @@ class RoGroupAttr(AbstractModel):
34099
34170
 
34100
34171
  @property
34101
34172
  def MinRoInGroup(self):
34102
- """最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34173
+ """最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。
34174
+ 注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
34103
34175
  :rtype: int
34104
34176
  """
34105
34177
  return self._MinRoInGroup
@@ -34121,7 +34193,7 @@ class RoGroupAttr(AbstractModel):
34121
34193
 
34122
34194
  @property
34123
34195
  def ReplicationDelayTime(self):
34124
- """延迟复制时间。
34196
+ """延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。
34125
34197
  :rtype: int
34126
34198
  """
34127
34199
  return self._ReplicationDelayTime
@@ -36279,7 +36351,7 @@ class StartCpuExpandRequest(AbstractModel):
36279
36351
 
36280
36352
  def __init__(self):
36281
36353
  r"""
36282
- :param _InstanceId: 实例 ID
36354
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36283
36355
  :type InstanceId: str
36284
36356
  :param _Type: 扩容类型,支持自动扩容和自定义扩容。
36285
36357
  说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。
@@ -36290,8 +36362,10 @@ class StartCpuExpandRequest(AbstractModel):
36290
36362
  :param _AutoStrategy: 自动扩容策略。Type 为 auto 时必传。
36291
36363
  :type AutoStrategy: :class:`tencentcloud.cdb.v20170320.models.AutoStrategy`
36292
36364
  :param _TimeIntervalStrategy: 按时间段扩容策略。
36365
+ 说明:当 Type 为 timeInterval 时,TimeIntervalStrategy 必填。
36293
36366
  :type TimeIntervalStrategy: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
36294
36367
  :param _PeriodStrategy: 按周期扩容策略。
36368
+ 说明:当 Type 为 period 时,PeriodStrategy 必填。
36295
36369
  :type PeriodStrategy: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
36296
36370
  """
36297
36371
  self._InstanceId = None
@@ -36303,7 +36377,7 @@ class StartCpuExpandRequest(AbstractModel):
36303
36377
 
36304
36378
  @property
36305
36379
  def InstanceId(self):
36306
- """实例 ID
36380
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36307
36381
  :rtype: str
36308
36382
  """
36309
36383
  return self._InstanceId
@@ -36350,6 +36424,7 @@ class StartCpuExpandRequest(AbstractModel):
36350
36424
  @property
36351
36425
  def TimeIntervalStrategy(self):
36352
36426
  """按时间段扩容策略。
36427
+ 说明:当 Type 为 timeInterval 时,TimeIntervalStrategy 必填。
36353
36428
  :rtype: :class:`tencentcloud.cdb.v20170320.models.TimeIntervalStrategy`
36354
36429
  """
36355
36430
  return self._TimeIntervalStrategy
@@ -36361,6 +36436,7 @@ class StartCpuExpandRequest(AbstractModel):
36361
36436
  @property
36362
36437
  def PeriodStrategy(self):
36363
36438
  """按周期扩容策略。
36439
+ 说明:当 Type 为 period 时,PeriodStrategy 必填。
36364
36440
  :rtype: :class:`tencentcloud.cdb.v20170320.models.PeriodStrategy`
36365
36441
  """
36366
36442
  return self._PeriodStrategy
@@ -36400,7 +36476,7 @@ class StartCpuExpandResponse(AbstractModel):
36400
36476
 
36401
36477
  def __init__(self):
36402
36478
  r"""
36403
- :param _AsyncRequestId: 异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询
36479
+ :param _AsyncRequestId: 异步任务 ID 。可以调用 DescribeAsyncRequest 传入该 ID,进行任务执行进度的查询。
36404
36480
  :type AsyncRequestId: str
36405
36481
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
36406
36482
  :type RequestId: str
@@ -36410,7 +36486,7 @@ class StartCpuExpandResponse(AbstractModel):
36410
36486
 
36411
36487
  @property
36412
36488
  def AsyncRequestId(self):
36413
- """异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询
36489
+ """异步任务 ID 。可以调用 DescribeAsyncRequest 传入该 ID,进行任务执行进度的查询。
36414
36490
  :rtype: str
36415
36491
  """
36416
36492
  return self._AsyncRequestId
@@ -36823,9 +36899,10 @@ class SubmitInstanceUpgradeCheckJobRequest(AbstractModel):
36823
36899
 
36824
36900
  def __init__(self):
36825
36901
  r"""
36826
- :param _InstanceId: 实例 ID
36902
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36827
36903
  :type InstanceId: str
36828
36904
  :param _DstMysqlVersion: 目标数据库版本。
36905
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
36829
36906
  :type DstMysqlVersion: str
36830
36907
  """
36831
36908
  self._InstanceId = None
@@ -36833,7 +36910,7 @@ class SubmitInstanceUpgradeCheckJobRequest(AbstractModel):
36833
36910
 
36834
36911
  @property
36835
36912
  def InstanceId(self):
36836
- """实例 ID
36913
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36837
36914
  :rtype: str
36838
36915
  """
36839
36916
  return self._InstanceId
@@ -36845,6 +36922,7 @@ class SubmitInstanceUpgradeCheckJobRequest(AbstractModel):
36845
36922
  @property
36846
36923
  def DstMysqlVersion(self):
36847
36924
  """目标数据库版本。
36925
+ 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
36848
36926
  :rtype: str
36849
36927
  """
36850
36928
  return self._DstMysqlVersion
@@ -36917,9 +36995,9 @@ class SwitchCDBProxyRequest(AbstractModel):
36917
36995
 
36918
36996
  def __init__(self):
36919
36997
  r"""
36920
- :param _InstanceId: 实例ID
36998
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36921
36999
  :type InstanceId: str
36922
- :param _ProxyGroupId: 数据库代理ID
37000
+ :param _ProxyGroupId: 数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
36923
37001
  :type ProxyGroupId: str
36924
37002
  """
36925
37003
  self._InstanceId = None
@@ -36927,7 +37005,7 @@ class SwitchCDBProxyRequest(AbstractModel):
36927
37005
 
36928
37006
  @property
36929
37007
  def InstanceId(self):
36930
- """实例ID
37008
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
36931
37009
  :rtype: str
36932
37010
  """
36933
37011
  return self._InstanceId
@@ -36938,7 +37016,7 @@ class SwitchCDBProxyRequest(AbstractModel):
36938
37016
 
36939
37017
  @property
36940
37018
  def ProxyGroupId(self):
36941
- """数据库代理ID
37019
+ """数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
36942
37020
  :rtype: str
36943
37021
  """
36944
37022
  return self._ProxyGroupId
@@ -38138,9 +38216,9 @@ class UpgradeCDBProxyVersionRequest(AbstractModel):
38138
38216
 
38139
38217
  def __init__(self):
38140
38218
  r"""
38141
- :param _InstanceId: 实例ID
38219
+ :param _InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
38142
38220
  :type InstanceId: str
38143
- :param _ProxyGroupId: 数据库代理ID
38221
+ :param _ProxyGroupId: 数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
38144
38222
  :type ProxyGroupId: str
38145
38223
  :param _SrcProxyVersion: 数据库代理当前版本
38146
38224
  :type SrcProxyVersion: str
@@ -38157,7 +38235,7 @@ class UpgradeCDBProxyVersionRequest(AbstractModel):
38157
38235
 
38158
38236
  @property
38159
38237
  def InstanceId(self):
38160
- """实例ID
38238
+ """实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
38161
38239
  :rtype: str
38162
38240
  """
38163
38241
  return self._InstanceId
@@ -38168,7 +38246,7 @@ class UpgradeCDBProxyVersionRequest(AbstractModel):
38168
38246
 
38169
38247
  @property
38170
38248
  def ProxyGroupId(self):
38171
- """数据库代理ID
38249
+ """数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
38172
38250
  :rtype: str
38173
38251
  """
38174
38252
  return self._ProxyGroupId
@@ -38464,11 +38542,12 @@ class UpgradeDBInstanceRequest(AbstractModel):
38464
38542
  :type DeployMode: int
38465
38543
  :param _SlaveZone: 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
38466
38544
  :type SlaveZone: str
38467
- :param _EngineVersion: 主实例数据库引擎版本,支持值包括:5.5、5.65.7。
38545
+ :param _EngineVersion: 主实例数据库引擎版本,支持值包括:5.5、5.65.7、8.0
38546
+ 说明:升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。
38468
38547
  :type EngineVersion: str
38469
38548
  :param _WaitSwitch: 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
38470
38549
  :type WaitSwitch: int
38471
- :param _BackupZone: 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
38550
+ :param _BackupZone: 备库2的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
38472
38551
  备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。
38473
38552
  :type BackupZone: str
38474
38553
  :param _InstanceRole: 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
@@ -38591,7 +38670,8 @@ class UpgradeDBInstanceRequest(AbstractModel):
38591
38670
 
38592
38671
  @property
38593
38672
  def EngineVersion(self):
38594
- """主实例数据库引擎版本,支持值包括:5.5、5.65.7。
38673
+ """主实例数据库引擎版本,支持值包括:5.5、5.65.7、8.0
38674
+ 说明:升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。
38595
38675
  :rtype: str
38596
38676
  """
38597
38677
  return self._EngineVersion
@@ -38613,7 +38693,7 @@ class UpgradeDBInstanceRequest(AbstractModel):
38613
38693
 
38614
38694
  @property
38615
38695
  def BackupZone(self):
38616
- """备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
38696
+ """备库2的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
38617
38697
  备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。
38618
38698
  :rtype: str
38619
38699
  """
@@ -38794,7 +38874,7 @@ class UpgradeDBInstanceResponse(AbstractModel):
38794
38874
  r"""
38795
38875
  :param _DealIds: 订单 ID。
38796
38876
  :type DealIds: list of str
38797
- :param _AsyncRequestId: 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
38877
+ :param _AsyncRequestId: 异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/236/20410)。
38798
38878
  :type AsyncRequestId: str
38799
38879
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
38800
38880
  :type RequestId: str
@@ -38816,7 +38896,7 @@ class UpgradeDBInstanceResponse(AbstractModel):
38816
38896
 
38817
38897
  @property
38818
38898
  def AsyncRequestId(self):
38819
- """异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
38899
+ """异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/236/20410)。
38820
38900
  :rtype: str
38821
38901
  """
38822
38902
  return self._AsyncRequestId