tencentcloud-sdk-python 3.0.1430__py2.py3-none-any.whl → 3.0.1432__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.

Potentially problematic release.


This version of tencentcloud-sdk-python might be problematic. Click here for more details.

Files changed (36) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/cbs/v20170312/models.py +15 -0
  3. tencentcloud/cdb/v20170320/cdb_client.py +6 -6
  4. tencentcloud/cdb/v20170320/models.py +132 -108
  5. tencentcloud/cdn/v20180606/cdn_client.py +12 -4
  6. tencentcloud/dsgc/v20190723/models.py +2 -2
  7. tencentcloud/ess/v20201111/models.py +42 -0
  8. tencentcloud/essbasic/v20210526/essbasic_client.py +1 -1
  9. tencentcloud/essbasic/v20210526/models.py +58 -22
  10. tencentcloud/gs/v20191118/models.py +57 -4
  11. tencentcloud/lcic/v20220817/lcic_client.py +3 -0
  12. tencentcloud/lcic/v20220817/models.py +10 -10
  13. tencentcloud/live/v20180801/models.py +70 -2
  14. tencentcloud/lke/v20231130/models.py +32 -2
  15. tencentcloud/mps/v20190612/models.py +731 -57
  16. tencentcloud/mps/v20190612/mps_client.py +5 -5
  17. tencentcloud/oceanus/v20190422/models.py +36 -2
  18. tencentcloud/ocr/v20181119/models.py +147 -0
  19. tencentcloud/ocr/v20181119/ocr_client.py +25 -0
  20. tencentcloud/postgres/v20170312/models.py +362 -334
  21. tencentcloud/postgres/v20170312/postgres_client.py +9 -9
  22. tencentcloud/ssl/v20191205/models.py +47 -2
  23. tencentcloud/tsf/v20180326/errorcodes.py +2 -2
  24. tencentcloud/vod/v20180717/models.py +372 -2
  25. tencentcloud/wedata/v20210820/models.py +1524 -2
  26. tencentcloud/wedata/v20210820/wedata_client.py +184 -0
  27. tencentcloud/wsa/__init__.py +0 -0
  28. tencentcloud/wsa/v20250508/__init__.py +0 -0
  29. tencentcloud/wsa/v20250508/errorcodes.py +27 -0
  30. tencentcloud/wsa/v20250508/models.py +187 -0
  31. tencentcloud/wsa/v20250508/wsa_client.py +49 -0
  32. {tencentcloud_sdk_python-3.0.1430.dist-info → tencentcloud_sdk_python-3.0.1432.dist-info}/METADATA +1 -1
  33. {tencentcloud_sdk_python-3.0.1430.dist-info → tencentcloud_sdk_python-3.0.1432.dist-info}/RECORD +36 -31
  34. {tencentcloud_sdk_python-3.0.1430.dist-info → tencentcloud_sdk_python-3.0.1432.dist-info}/LICENSE +0 -0
  35. {tencentcloud_sdk_python-3.0.1430.dist-info → tencentcloud_sdk_python-3.0.1432.dist-info}/WHEEL +0 -0
  36. {tencentcloud_sdk_python-3.0.1430.dist-info → tencentcloud_sdk_python-3.0.1432.dist-info}/top_level.txt +0 -0
@@ -151,9 +151,9 @@ class AddDBInstanceToReadOnlyGroupRequest(AbstractModel):
151
151
 
152
152
  def __init__(self):
153
153
  r"""
154
- :param _DBInstanceId: 实例ID
154
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
155
155
  :type DBInstanceId: str
156
- :param _ReadOnlyGroupId: 只读组ID
156
+ :param _ReadOnlyGroupId: 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
157
157
  :type ReadOnlyGroupId: str
158
158
  """
159
159
  self._DBInstanceId = None
@@ -161,7 +161,7 @@ class AddDBInstanceToReadOnlyGroupRequest(AbstractModel):
161
161
 
162
162
  @property
163
163
  def DBInstanceId(self):
164
- """实例ID
164
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
165
165
  :rtype: str
166
166
  """
167
167
  return self._DBInstanceId
@@ -172,7 +172,7 @@ class AddDBInstanceToReadOnlyGroupRequest(AbstractModel):
172
172
 
173
173
  @property
174
174
  def ReadOnlyGroupId(self):
175
- """只读组ID
175
+ """只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
176
176
  :rtype: str
177
177
  """
178
178
  return self._ReadOnlyGroupId
@@ -255,7 +255,7 @@ class AnalysisItems(AbstractModel):
255
255
  :type ClientAddr: str
256
256
  :param _CallNum: 在选定时间范围内慢SQL语句执行的次数
257
257
  :type CallNum: int
258
- :param _CallPercent: 在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的比例(小数返回)
258
+ :param _CallPercent: 在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的百分比。
259
259
  :type CallPercent: float
260
260
  :param _CostTime: 在选定时间范围内,慢SQL执行的总时间
261
261
  :type CostTime: float
@@ -267,9 +267,9 @@ class AnalysisItems(AbstractModel):
267
267
  :type MaxCostTime: float
268
268
  :param _AvgCostTime: 在选定时间范围内,慢SQL语句执行的耗时平均时间(单位:ms)
269
269
  :type AvgCostTime: float
270
- :param _FirstTime: 在选定时间范围内,慢SQL第一条开始执行的时间戳
270
+ :param _FirstTime: 在选定时间范围内,慢SQL第一条开始执行的时间
271
271
  :type FirstTime: str
272
- :param _LastTime: 在选定时间范围内,慢SQL最后一条开始执行的时间戳
272
+ :param _LastTime: 在选定时间范围内,慢SQL最后一条开始执行的时间
273
273
  :type LastTime: str
274
274
  """
275
275
  self._DatabaseName = None
@@ -343,7 +343,7 @@ class AnalysisItems(AbstractModel):
343
343
 
344
344
  @property
345
345
  def CallPercent(self):
346
- """在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的比例(小数返回)
346
+ """在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的百分比。
347
347
  :rtype: float
348
348
  """
349
349
  return self._CallPercent
@@ -409,7 +409,7 @@ class AnalysisItems(AbstractModel):
409
409
 
410
410
  @property
411
411
  def FirstTime(self):
412
- """在选定时间范围内,慢SQL第一条开始执行的时间戳
412
+ """在选定时间范围内,慢SQL第一条开始执行的时间
413
413
  :rtype: str
414
414
  """
415
415
  return self._FirstTime
@@ -420,7 +420,7 @@ class AnalysisItems(AbstractModel):
420
420
 
421
421
  @property
422
422
  def LastTime(self):
423
- """在选定时间范围内,慢SQL最后一条开始执行的时间戳
423
+ """在选定时间范围内,慢SQL最后一条开始执行的时间
424
424
  :rtype: str
425
425
  """
426
426
  return self._LastTime
@@ -461,7 +461,7 @@ class BackupDownloadRestriction(AbstractModel):
461
461
 
462
462
  def __init__(self):
463
463
  r"""
464
- :param _RestrictionType: 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
464
+ :param _RestrictionType: 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE 时,vpc或ip信息至少填写一项
465
465
  :type RestrictionType: str
466
466
  :param _VpcRestrictionEffect: vpc限制效力,ALLOW 允许;DENY 拒绝。
467
467
  :type VpcRestrictionEffect: str
@@ -480,7 +480,7 @@ class BackupDownloadRestriction(AbstractModel):
480
480
 
481
481
  @property
482
482
  def RestrictionType(self):
483
- """备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
483
+ """备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE 时,vpc或ip信息至少填写一项
484
484
  :rtype: str
485
485
  """
486
486
  return self._RestrictionType
@@ -559,7 +559,7 @@ class BackupPlan(AbstractModel):
559
559
  r"""
560
560
  :param _BackupPeriod: 备份周期
561
561
  :type BackupPeriod: str
562
- :param _BaseBackupRetentionPeriod: 数据备份保留时长
562
+ :param _BaseBackupRetentionPeriod: 数据备份保留时长。单位:天
563
563
  :type BaseBackupRetentionPeriod: int
564
564
  :param _MinBackupStartTime: 开始备份的最早时间
565
565
  :type MinBackupStartTime: str
@@ -569,7 +569,7 @@ class BackupPlan(AbstractModel):
569
569
  :type PlanId: str
570
570
  :param _PlanName: 备份计划自定义名称。
571
571
  :type PlanName: str
572
- :param _LogBackupRetentionPeriod: 日志备份保留时长。
572
+ :param _LogBackupRetentionPeriod: 日志备份保留时长。单位:天
573
573
  :type LogBackupRetentionPeriod: int
574
574
  :param _CreatedTime: 创建时间。
575
575
  :type CreatedTime: str
@@ -605,7 +605,7 @@ class BackupPlan(AbstractModel):
605
605
 
606
606
  @property
607
607
  def BaseBackupRetentionPeriod(self):
608
- """数据备份保留时长
608
+ """数据备份保留时长。单位:天
609
609
  :rtype: int
610
610
  """
611
611
  return self._BaseBackupRetentionPeriod
@@ -660,7 +660,7 @@ class BackupPlan(AbstractModel):
660
660
 
661
661
  @property
662
662
  def LogBackupRetentionPeriod(self):
663
- """日志备份保留时长。
663
+ """日志备份保留时长。单位:天
664
664
  :rtype: int
665
665
  """
666
666
  return self._LogBackupRetentionPeriod
@@ -905,11 +905,11 @@ class BaseBackup(AbstractModel):
905
905
  :type Id: str
906
906
  :param _Name: 备份文件名称。
907
907
  :type Name: str
908
- :param _BackupMethod: 备份方式:物理备份、逻辑备份。
908
+ :param _BackupMethod: 备份方式:physical - 物理备份、logical - 逻辑备份。
909
909
  :type BackupMethod: str
910
- :param _BackupMode: 备份模式:自动备份、手动备份。
910
+ :param _BackupMode: 备份模式:automatic - 自动备份、manual - 手动备份。
911
911
  :type BackupMode: str
912
- :param _State: 备份任务状态。
912
+ :param _State: 备份任务状态。枚举值:init、running、finished、failed、canceled
913
913
  :type State: str
914
914
  :param _Size: 备份集大小,单位bytes。
915
915
  :type Size: int
@@ -966,7 +966,7 @@ class BaseBackup(AbstractModel):
966
966
 
967
967
  @property
968
968
  def BackupMethod(self):
969
- """备份方式:物理备份、逻辑备份。
969
+ """备份方式:physical - 物理备份、logical - 逻辑备份。
970
970
  :rtype: str
971
971
  """
972
972
  return self._BackupMethod
@@ -977,7 +977,7 @@ class BaseBackup(AbstractModel):
977
977
 
978
978
  @property
979
979
  def BackupMode(self):
980
- """备份模式:自动备份、手动备份。
980
+ """备份模式:automatic - 自动备份、manual - 手动备份。
981
981
  :rtype: str
982
982
  """
983
983
  return self._BackupMode
@@ -988,7 +988,7 @@ class BaseBackup(AbstractModel):
988
988
 
989
989
  @property
990
990
  def State(self):
991
- """备份任务状态。
991
+ """备份任务状态。枚举值:init、running、finished、failed、canceled
992
992
  :rtype: str
993
993
  """
994
994
  return self._State
@@ -1838,7 +1838,7 @@ class CreateBackupPlanRequest(AbstractModel):
1838
1838
 
1839
1839
  def __init__(self):
1840
1840
  r"""
1841
- :param _DBInstanceId: 实例ID
1841
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1842
1842
  :type DBInstanceId: str
1843
1843
  :param _PlanName: 备份计划名称。
1844
1844
  :type PlanName: str
@@ -1850,7 +1850,8 @@ class CreateBackupPlanRequest(AbstractModel):
1850
1850
  :type MinBackupStartTime: str
1851
1851
  :param _MaxBackupStartTime: 备份结束时间,不传跟随默认计划。
1852
1852
  :type MaxBackupStartTime: str
1853
- :param _BaseBackupRetentionPeriod: 数据备份保留时长,week默认是7,month为30。
1853
+ :param _BaseBackupRetentionPeriod: 数据备份保留时长,单位:天。取值范围为:[0,30000)
1854
+ BackupPeriodType为week时默认是7,为month时默认为31。
1854
1855
  :type BaseBackupRetentionPeriod: int
1855
1856
  """
1856
1857
  self._DBInstanceId = None
@@ -1863,7 +1864,7 @@ class CreateBackupPlanRequest(AbstractModel):
1863
1864
 
1864
1865
  @property
1865
1866
  def DBInstanceId(self):
1866
- """实例ID
1867
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1867
1868
  :rtype: str
1868
1869
  """
1869
1870
  return self._DBInstanceId
@@ -1929,7 +1930,8 @@ class CreateBackupPlanRequest(AbstractModel):
1929
1930
 
1930
1931
  @property
1931
1932
  def BaseBackupRetentionPeriod(self):
1932
- """数据备份保留时长,week默认是7,month为30。
1933
+ """数据备份保留时长,单位:天。取值范围为:[0,30000)
1934
+ BackupPeriodType为week时默认是7,为month时默认为31。
1933
1935
  :rtype: int
1934
1936
  """
1935
1937
  return self._BaseBackupRetentionPeriod
@@ -2007,14 +2009,14 @@ class CreateBaseBackupRequest(AbstractModel):
2007
2009
 
2008
2010
  def __init__(self):
2009
2011
  r"""
2010
- :param _DBInstanceId: 实例ID
2012
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2011
2013
  :type DBInstanceId: str
2012
2014
  """
2013
2015
  self._DBInstanceId = None
2014
2016
 
2015
2017
  @property
2016
2018
  def DBInstanceId(self):
2017
- """实例ID
2019
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2018
2020
  :rtype: str
2019
2021
  """
2020
2022
  return self._DBInstanceId
@@ -2086,7 +2088,7 @@ class CreateDBInstanceNetworkAccessRequest(AbstractModel):
2086
2088
 
2087
2089
  def __init__(self):
2088
2090
  r"""
2089
- :param _DBInstanceId: 实例ID,形如:postgres-6bwgamo3
2091
+ :param _DBInstanceId: 实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2090
2092
  :type DBInstanceId: str
2091
2093
  :param _VpcId: 私有网络统一 ID。
2092
2094
  :type VpcId: str
@@ -2094,7 +2096,7 @@ class CreateDBInstanceNetworkAccessRequest(AbstractModel):
2094
2096
  :type SubnetId: str
2095
2097
  :param _IsAssignVip: 是否指定分配vip true-指定分配 false-自动分配。
2096
2098
  :type IsAssignVip: bool
2097
- :param _Vip: 目标VIP地址。
2099
+ :param _Vip: 目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
2098
2100
  :type Vip: str
2099
2101
  """
2100
2102
  self._DBInstanceId = None
@@ -2105,7 +2107,7 @@ class CreateDBInstanceNetworkAccessRequest(AbstractModel):
2105
2107
 
2106
2108
  @property
2107
2109
  def DBInstanceId(self):
2108
- """实例ID,形如:postgres-6bwgamo3
2110
+ """实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2109
2111
  :rtype: str
2110
2112
  """
2111
2113
  return self._DBInstanceId
@@ -2149,7 +2151,7 @@ class CreateDBInstanceNetworkAccessRequest(AbstractModel):
2149
2151
 
2150
2152
  @property
2151
2153
  def Vip(self):
2152
- """目标VIP地址。
2154
+ """目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
2153
2155
  :rtype: str
2154
2156
  """
2155
2157
  return self._Vip
@@ -2225,13 +2227,16 @@ class CreateDatabaseRequest(AbstractModel):
2225
2227
 
2226
2228
  def __init__(self):
2227
2229
  r"""
2228
- :param _DBInstanceId: 实例ID,形如postgres-6fego161
2230
+ :param _DBInstanceId: 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2229
2231
  :type DBInstanceId: str
2230
- :param _DatabaseName: 创建的数据库名
2232
+ :param _DatabaseName: 创建的数据库名。
2233
+ 名称规范:由字母(a-z, A-Z)、数字(0-9)、下划线(_)组成,以字母或(_)开头,最多63个字符。不能使用系统保留关键字,不能为postgres。
2231
2234
  :type DatabaseName: str
2232
- :param _DatabaseOwner: 数据库的所有者
2235
+ :param _DatabaseOwner: 数据库的所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
2233
2236
  :type DatabaseOwner: str
2234
- :param _Encoding: 数据库的字符编码
2237
+ :param _Encoding: 数据库的字符编码。
2238
+ 支持的常用字符集包括:UTF8、LATIN1、LATIN2、WIN1250、WIN1251、WIN1252、KOI8R、EUC_JP、EUC_KR
2239
+ 默认值:UTF8
2235
2240
  :type Encoding: str
2236
2241
  :param _Collate: 数据库的排序规则
2237
2242
  :type Collate: str
@@ -2247,7 +2252,7 @@ class CreateDatabaseRequest(AbstractModel):
2247
2252
 
2248
2253
  @property
2249
2254
  def DBInstanceId(self):
2250
- """实例ID,形如postgres-6fego161
2255
+ """实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2251
2256
  :rtype: str
2252
2257
  """
2253
2258
  return self._DBInstanceId
@@ -2258,7 +2263,8 @@ class CreateDatabaseRequest(AbstractModel):
2258
2263
 
2259
2264
  @property
2260
2265
  def DatabaseName(self):
2261
- """创建的数据库名
2266
+ """创建的数据库名。
2267
+ 名称规范:由字母(a-z, A-Z)、数字(0-9)、下划线(_)组成,以字母或(_)开头,最多63个字符。不能使用系统保留关键字,不能为postgres。
2262
2268
  :rtype: str
2263
2269
  """
2264
2270
  return self._DatabaseName
@@ -2269,7 +2275,7 @@ class CreateDatabaseRequest(AbstractModel):
2269
2275
 
2270
2276
  @property
2271
2277
  def DatabaseOwner(self):
2272
- """数据库的所有者
2278
+ """数据库的所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
2273
2279
  :rtype: str
2274
2280
  """
2275
2281
  return self._DatabaseOwner
@@ -2280,7 +2286,9 @@ class CreateDatabaseRequest(AbstractModel):
2280
2286
 
2281
2287
  @property
2282
2288
  def Encoding(self):
2283
- """数据库的字符编码
2289
+ """数据库的字符编码。
2290
+ 支持的常用字符集包括:UTF8、LATIN1、LATIN2、WIN1250、WIN1251、WIN1252、KOI8R、EUC_JP、EUC_KR
2291
+ 默认值:UTF8
2284
2292
  :rtype: str
2285
2293
  """
2286
2294
  return self._Encoding
@@ -2369,7 +2377,7 @@ class CreateInstancesRequest(AbstractModel):
2369
2377
  :type Zone: str
2370
2378
  :param _SpecCode: 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
2371
2379
  :type SpecCode: str
2372
- :param _Storage: 实例容量大小,单位:GB。
2380
+ :param _Storage: 实例磁盘容量大小,单位:GB。该参数的设置步长为10
2373
2381
  :type Storage: int
2374
2382
  :param _InstanceCount: 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。
2375
2383
  :type InstanceCount: int
@@ -2427,7 +2435,7 @@ class CreateInstancesRequest(AbstractModel):
2427
2435
  :type AutoVoucher: int
2428
2436
  :param _VoucherIds: 代金券ID列表,目前仅支持指定一张代金券。
2429
2437
  :type VoucherIds: list of str
2430
- :param _ProjectId: 项目ID
2438
+ :param _ProjectId: 项目ID。默认取之为0,表示归属默认项目。
2431
2439
  :type ProjectId: int
2432
2440
  :param _ActivityId: 活动ID。
2433
2441
  :type ActivityId: int
@@ -2536,7 +2544,7 @@ mssql_compatible引擎:
2536
2544
 
2537
2545
  @property
2538
2546
  def Storage(self):
2539
- """实例容量大小,单位:GB。
2547
+ """实例磁盘容量大小,单位:GB。该参数的设置步长为10
2540
2548
  :rtype: int
2541
2549
  """
2542
2550
  return self._Storage
@@ -2738,7 +2746,7 @@ mssql_compatible引擎:
2738
2746
 
2739
2747
  @property
2740
2748
  def ProjectId(self):
2741
- """项目ID
2749
+ """项目ID。默认取之为0,表示归属默认项目。
2742
2750
  :rtype: int
2743
2751
  """
2744
2752
  return self._ProjectId
@@ -3039,7 +3047,7 @@ class CreateParameterTemplateRequest(AbstractModel):
3039
3047
  r"""
3040
3048
  :param _TemplateName: 模板名称,长度为1~60个字符,仅支持数字,英文大小写字母、中文以及特殊字符_-./()()[]+=::@
3041
3049
  :type TemplateName: str
3042
- :param _DBMajorVersion: 数据库大版本号,例如:11,12,13
3050
+ :param _DBMajorVersion: 数据库大版本号,例如:11,12,13。可通过[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
3043
3051
  :type DBMajorVersion: str
3044
3052
  :param _DBEngine: 数据库引擎,例如:postgresql,mssql_compatible
3045
3053
  :type DBEngine: str
@@ -3064,7 +3072,7 @@ class CreateParameterTemplateRequest(AbstractModel):
3064
3072
 
3065
3073
  @property
3066
3074
  def DBMajorVersion(self):
3067
- """数据库大版本号,例如:11,12,13
3075
+ """数据库大版本号,例如:11,12,13。可通过[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
3068
3076
  :rtype: str
3069
3077
  """
3070
3078
  return self._DBMajorVersion
@@ -3164,11 +3172,11 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3164
3172
  :param _Zone: 实例所属主可用区, 如:ap-guangzhou-3;
3165
3173
  可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
3166
3174
  :type Zone: str
3167
- :param _MasterDBInstanceId: 只读实例的主实例ID
3175
+ :param _MasterDBInstanceId: 只读实例的主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3168
3176
  :type MasterDBInstanceId: str
3169
3177
  :param _SpecCode: 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
3170
3178
  :type SpecCode: str
3171
- :param _Storage: 实例容量大小,单位:GB。
3179
+ :param _Storage: 实例硬盘容量大小,单位:GB。该参数的设置步长为10
3172
3180
  :type Storage: int
3173
3181
  :param _InstanceCount: 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。
3174
3182
  :type InstanceCount: int
@@ -3197,7 +3205,7 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3197
3205
  <li>1:自动续费</li>
3198
3206
  默认值:0
3199
3207
  :type AutoRenewFlag: int
3200
- :param _ProjectId: 项目ID
3208
+ :param _ProjectId: 项目ID。默认值为0,表示归属默认项目。
3201
3209
  :type ProjectId: int
3202
3210
  :param _ActivityId: 优惠活动ID
3203
3211
  :type ActivityId: int
@@ -3213,7 +3221,7 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3213
3221
  <li>1:是</li>
3214
3222
  默认值:0
3215
3223
  :type NeedSupportIpv6: int
3216
- :param _Name: 实例名(后续支持)
3224
+ :param _Name: 实例名。仅支持长度小于60的中文/英文/数字/"_"/"-"
3217
3225
  :type Name: str
3218
3226
  :param _DBVersion: 不再需要指定,内核版本号与主实例保持一致
3219
3227
  :type DBVersion: str
@@ -3256,7 +3264,7 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3256
3264
 
3257
3265
  @property
3258
3266
  def MasterDBInstanceId(self):
3259
- """只读实例的主实例ID
3267
+ """只读实例的主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3260
3268
  :rtype: str
3261
3269
  """
3262
3270
  return self._MasterDBInstanceId
@@ -3278,7 +3286,7 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3278
3286
 
3279
3287
  @property
3280
3288
  def Storage(self):
3281
- """实例容量大小,单位:GB。
3289
+ """实例硬盘容量大小,单位:GB。该参数的设置步长为10
3282
3290
  :rtype: int
3283
3291
  """
3284
3292
  return self._Storage
@@ -3388,7 +3396,7 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3388
3396
 
3389
3397
  @property
3390
3398
  def ProjectId(self):
3391
- """项目ID
3399
+ """项目ID。默认值为0,表示归属默认项目。
3392
3400
  :rtype: int
3393
3401
  """
3394
3402
  return self._ProjectId
@@ -3458,7 +3466,7 @@ class CreateReadOnlyDBInstanceRequest(AbstractModel):
3458
3466
 
3459
3467
  @property
3460
3468
  def Name(self):
3461
- """实例名(后续支持)
3469
+ """实例名。仅支持长度小于60的中文/英文/数字/"_"/"-"
3462
3470
  :rtype: str
3463
3471
  """
3464
3472
  return self._Name
@@ -3608,7 +3616,7 @@ class CreateReadOnlyGroupNetworkAccessRequest(AbstractModel):
3608
3616
 
3609
3617
  def __init__(self):
3610
3618
  r"""
3611
- :param _ReadOnlyGroupId: RO组ID,形如:pgro-4t9c6g7k
3619
+ :param _ReadOnlyGroupId: RO组ID,形如:pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
3612
3620
  :type ReadOnlyGroupId: str
3613
3621
  :param _VpcId: 私有网络统一 ID。
3614
3622
  :type VpcId: str
@@ -3616,7 +3624,7 @@ class CreateReadOnlyGroupNetworkAccessRequest(AbstractModel):
3616
3624
  :type SubnetId: str
3617
3625
  :param _IsAssignVip: 是否指定分配vip true-指定分配 false-自动分配。
3618
3626
  :type IsAssignVip: bool
3619
- :param _Vip: 目标VIP地址。
3627
+ :param _Vip: 目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
3620
3628
  :type Vip: str
3621
3629
  """
3622
3630
  self._ReadOnlyGroupId = None
@@ -3627,7 +3635,7 @@ class CreateReadOnlyGroupNetworkAccessRequest(AbstractModel):
3627
3635
 
3628
3636
  @property
3629
3637
  def ReadOnlyGroupId(self):
3630
- """RO组ID,形如:pgro-4t9c6g7k
3638
+ """RO组ID,形如:pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
3631
3639
  :rtype: str
3632
3640
  """
3633
3641
  return self._ReadOnlyGroupId
@@ -3671,7 +3679,7 @@ class CreateReadOnlyGroupNetworkAccessRequest(AbstractModel):
3671
3679
 
3672
3680
  @property
3673
3681
  def Vip(self):
3674
- """目标VIP地址。
3682
+ """目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
3675
3683
  :rtype: str
3676
3684
  """
3677
3685
  return self._Vip
@@ -3747,25 +3755,25 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3747
3755
 
3748
3756
  def __init__(self):
3749
3757
  r"""
3750
- :param _MasterDBInstanceId: 主实例ID
3758
+ :param _MasterDBInstanceId: 主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3751
3759
  :type MasterDBInstanceId: str
3752
- :param _Name: 只读组名称
3760
+ :param _Name: 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"。
3753
3761
  :type Name: str
3754
- :param _ProjectId: 项目ID
3762
+ :param _ProjectId: 项目ID。默认值为0,表示归属于默认项目。
3755
3763
  :type ProjectId: int
3756
- :param _VpcId: 私有网络ID
3764
+ :param _VpcId: 私有网络ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
3757
3765
  :type VpcId: str
3758
- :param _SubnetId: 子网ID
3766
+ :param _SubnetId: 子网ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
3759
3767
  :type SubnetId: str
3760
- :param _ReplayLagEliminate: 延迟时间大小开关:0关、1
3768
+ :param _ReplayLagEliminate: 延迟时间大小开关:0关、1开。该参数必填。
3761
3769
  :type ReplayLagEliminate: int
3762
- :param _ReplayLatencyEliminate: 延迟空间大小开关: 0关、1
3770
+ :param _ReplayLatencyEliminate: 延迟空间大小开关: 0关、1开。该参数的填写需要与ReplayLagEliminate一致。
3763
3771
  :type ReplayLatencyEliminate: int
3764
- :param _MaxReplayLag: 延迟时间大小阈值,单位ms
3772
+ :param _MaxReplayLag: 延迟时间大小阈值,取值为正整数,单位s。当ReplayLagEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数需填0。
3765
3773
  :type MaxReplayLag: int
3766
- :param _MaxReplayLatency: 延迟空间大小阈值,单位MB
3774
+ :param _MaxReplayLatency: 延迟空间大小阈值,取值为正整数,单位MB。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLatencyEliminate为0时,该参数需填0。
3767
3775
  :type MaxReplayLatency: int
3768
- :param _MinDelayEliminateReserve: 延迟剔除最小保留实例数
3776
+ :param _MinDelayEliminateReserve: 延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数无效。
3769
3777
  :type MinDelayEliminateReserve: int
3770
3778
  :param _SecurityGroupIds: 安全组id
3771
3779
  :type SecurityGroupIds: list of str
@@ -3784,7 +3792,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3784
3792
 
3785
3793
  @property
3786
3794
  def MasterDBInstanceId(self):
3787
- """主实例ID
3795
+ """主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3788
3796
  :rtype: str
3789
3797
  """
3790
3798
  return self._MasterDBInstanceId
@@ -3795,7 +3803,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3795
3803
 
3796
3804
  @property
3797
3805
  def Name(self):
3798
- """只读组名称
3806
+ """只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"。
3799
3807
  :rtype: str
3800
3808
  """
3801
3809
  return self._Name
@@ -3806,7 +3814,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3806
3814
 
3807
3815
  @property
3808
3816
  def ProjectId(self):
3809
- """项目ID
3817
+ """项目ID。默认值为0,表示归属于默认项目。
3810
3818
  :rtype: int
3811
3819
  """
3812
3820
  return self._ProjectId
@@ -3817,7 +3825,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3817
3825
 
3818
3826
  @property
3819
3827
  def VpcId(self):
3820
- """私有网络ID
3828
+ """私有网络ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
3821
3829
  :rtype: str
3822
3830
  """
3823
3831
  return self._VpcId
@@ -3828,7 +3836,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3828
3836
 
3829
3837
  @property
3830
3838
  def SubnetId(self):
3831
- """子网ID
3839
+ """子网ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
3832
3840
  :rtype: str
3833
3841
  """
3834
3842
  return self._SubnetId
@@ -3839,7 +3847,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3839
3847
 
3840
3848
  @property
3841
3849
  def ReplayLagEliminate(self):
3842
- """延迟时间大小开关:0关、1
3850
+ """延迟时间大小开关:0关、1开。该参数必填。
3843
3851
  :rtype: int
3844
3852
  """
3845
3853
  return self._ReplayLagEliminate
@@ -3850,7 +3858,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3850
3858
 
3851
3859
  @property
3852
3860
  def ReplayLatencyEliminate(self):
3853
- """延迟空间大小开关: 0关、1
3861
+ """延迟空间大小开关: 0关、1开。该参数的填写需要与ReplayLagEliminate一致。
3854
3862
  :rtype: int
3855
3863
  """
3856
3864
  return self._ReplayLatencyEliminate
@@ -3861,7 +3869,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3861
3869
 
3862
3870
  @property
3863
3871
  def MaxReplayLag(self):
3864
- """延迟时间大小阈值,单位ms
3872
+ """延迟时间大小阈值,取值为正整数,单位s。当ReplayLagEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数需填0。
3865
3873
  :rtype: int
3866
3874
  """
3867
3875
  return self._MaxReplayLag
@@ -3872,7 +3880,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3872
3880
 
3873
3881
  @property
3874
3882
  def MaxReplayLatency(self):
3875
- """延迟空间大小阈值,单位MB
3883
+ """延迟空间大小阈值,取值为正整数,单位MB。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLatencyEliminate为0时,该参数需填0。
3876
3884
  :rtype: int
3877
3885
  """
3878
3886
  return self._MaxReplayLatency
@@ -3883,7 +3891,7 @@ class CreateReadOnlyGroupRequest(AbstractModel):
3883
3891
 
3884
3892
  @property
3885
3893
  def MinDelayEliminateReserve(self):
3886
- """延迟剔除最小保留实例数
3894
+ """延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数无效。
3887
3895
  :rtype: int
3888
3896
  """
3889
3897
  return self._MinDelayEliminateReserve
@@ -5582,17 +5590,17 @@ class DedicatedCluster(AbstractModel):
5582
5590
  :type StandbyDedicatedClusterSet: list of str
5583
5591
  :param _InstanceCount: 实例数量
5584
5592
  :type InstanceCount: int
5585
- :param _CpuTotal: Cpu总量
5593
+ :param _CpuTotal: Cpu总数量
5586
5594
  :type CpuTotal: int
5587
5595
  :param _CpuAvailable: Cpu可用数量
5588
5596
  :type CpuAvailable: int
5589
- :param _MemTotal: 内存总量
5597
+ :param _MemTotal: 内存总量,单位GB
5590
5598
  :type MemTotal: int
5591
- :param _MemAvailable: 内存可用量
5599
+ :param _MemAvailable: 内存可用量,单位GB
5592
5600
  :type MemAvailable: int
5593
- :param _DiskTotal: 磁盘总量
5601
+ :param _DiskTotal: 磁盘总量,单位GB
5594
5602
  :type DiskTotal: int
5595
- :param _DiskAvailable: 磁盘可用量
5603
+ :param _DiskAvailable: 磁盘可用量,单位GB
5596
5604
  :type DiskAvailable: int
5597
5605
  """
5598
5606
  self._DedicatedClusterId = None
@@ -5664,7 +5672,7 @@ class DedicatedCluster(AbstractModel):
5664
5672
 
5665
5673
  @property
5666
5674
  def CpuTotal(self):
5667
- """Cpu总量
5675
+ """Cpu总数量
5668
5676
  :rtype: int
5669
5677
  """
5670
5678
  return self._CpuTotal
@@ -5686,7 +5694,7 @@ class DedicatedCluster(AbstractModel):
5686
5694
 
5687
5695
  @property
5688
5696
  def MemTotal(self):
5689
- """内存总量
5697
+ """内存总量,单位GB
5690
5698
  :rtype: int
5691
5699
  """
5692
5700
  return self._MemTotal
@@ -5697,7 +5705,7 @@ class DedicatedCluster(AbstractModel):
5697
5705
 
5698
5706
  @property
5699
5707
  def MemAvailable(self):
5700
- """内存可用量
5708
+ """内存可用量,单位GB
5701
5709
  :rtype: int
5702
5710
  """
5703
5711
  return self._MemAvailable
@@ -5708,7 +5716,7 @@ class DedicatedCluster(AbstractModel):
5708
5716
 
5709
5717
  @property
5710
5718
  def DiskTotal(self):
5711
- """磁盘总量
5719
+ """磁盘总量,单位GB
5712
5720
  :rtype: int
5713
5721
  """
5714
5722
  return self._DiskTotal
@@ -5719,7 +5727,7 @@ class DedicatedCluster(AbstractModel):
5719
5727
 
5720
5728
  @property
5721
5729
  def DiskAvailable(self):
5722
- """磁盘可用量
5730
+ """磁盘可用量,单位GB
5723
5731
  :rtype: int
5724
5732
  """
5725
5733
  return self._DiskAvailable
@@ -5758,9 +5766,9 @@ class DeleteAccountRequest(AbstractModel):
5758
5766
 
5759
5767
  def __init__(self):
5760
5768
  r"""
5761
- :param _DBInstanceId: 实例ID。
5769
+ :param _DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5762
5770
  :type DBInstanceId: str
5763
- :param _UserName: 删除的账号名称。
5771
+ :param _UserName: 删除的账号名称。 可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
5764
5772
  :type UserName: str
5765
5773
  """
5766
5774
  self._DBInstanceId = None
@@ -5768,7 +5776,7 @@ class DeleteAccountRequest(AbstractModel):
5768
5776
 
5769
5777
  @property
5770
5778
  def DBInstanceId(self):
5771
- """实例ID。
5779
+ """实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5772
5780
  :rtype: str
5773
5781
  """
5774
5782
  return self._DBInstanceId
@@ -5779,7 +5787,7 @@ class DeleteAccountRequest(AbstractModel):
5779
5787
 
5780
5788
  @property
5781
5789
  def UserName(self):
5782
- """删除的账号名称。
5790
+ """删除的账号名称。 可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
5783
5791
  :rtype: str
5784
5792
  """
5785
5793
  return self._UserName
@@ -5837,9 +5845,9 @@ class DeleteBackupPlanRequest(AbstractModel):
5837
5845
 
5838
5846
  def __init__(self):
5839
5847
  r"""
5840
- :param _DBInstanceId: 实例ID
5848
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5841
5849
  :type DBInstanceId: str
5842
- :param _PlanId: 备份计划的ID
5850
+ :param _PlanId: 备份计划的ID。可通过[DescribeBackupPlans](https://cloud.tencent.com/document/api/409/68069)接口获取
5843
5851
  :type PlanId: str
5844
5852
  """
5845
5853
  self._DBInstanceId = None
@@ -5847,7 +5855,7 @@ class DeleteBackupPlanRequest(AbstractModel):
5847
5855
 
5848
5856
  @property
5849
5857
  def DBInstanceId(self):
5850
- """实例ID
5858
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5851
5859
  :rtype: str
5852
5860
  """
5853
5861
  return self._DBInstanceId
@@ -5858,7 +5866,7 @@ class DeleteBackupPlanRequest(AbstractModel):
5858
5866
 
5859
5867
  @property
5860
5868
  def PlanId(self):
5861
- """备份计划的ID
5869
+ """备份计划的ID。可通过[DescribeBackupPlans](https://cloud.tencent.com/document/api/409/68069)接口获取
5862
5870
  :rtype: str
5863
5871
  """
5864
5872
  return self._PlanId
@@ -5916,9 +5924,9 @@ class DeleteBaseBackupRequest(AbstractModel):
5916
5924
 
5917
5925
  def __init__(self):
5918
5926
  r"""
5919
- :param _DBInstanceId: 实例ID
5927
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5920
5928
  :type DBInstanceId: str
5921
- :param _BaseBackupId: 数据备份ID
5929
+ :param _BaseBackupId: 数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。7天内自动备份集不允许删除。
5922
5930
  :type BaseBackupId: str
5923
5931
  """
5924
5932
  self._DBInstanceId = None
@@ -5926,7 +5934,7 @@ class DeleteBaseBackupRequest(AbstractModel):
5926
5934
 
5927
5935
  @property
5928
5936
  def DBInstanceId(self):
5929
- """实例ID
5937
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5930
5938
  :rtype: str
5931
5939
  """
5932
5940
  return self._DBInstanceId
@@ -5937,7 +5945,7 @@ class DeleteBaseBackupRequest(AbstractModel):
5937
5945
 
5938
5946
  @property
5939
5947
  def BaseBackupId(self):
5940
- """数据备份ID
5948
+ """数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。7天内自动备份集不允许删除。
5941
5949
  :rtype: str
5942
5950
  """
5943
5951
  return self._BaseBackupId
@@ -6119,9 +6127,9 @@ class DeleteLogBackupRequest(AbstractModel):
6119
6127
 
6120
6128
  def __init__(self):
6121
6129
  r"""
6122
- :param _DBInstanceId: 实例ID
6130
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6123
6131
  :type DBInstanceId: str
6124
- :param _LogBackupId: 日志备份ID
6132
+ :param _LogBackupId: 日志备份ID。可通过[DescribeLogBackups](https://cloud.tencent.com/document/api/409/89021)接口获取。注:7天内自动备份集不允许删除。
6125
6133
  :type LogBackupId: str
6126
6134
  """
6127
6135
  self._DBInstanceId = None
@@ -6129,7 +6137,7 @@ class DeleteLogBackupRequest(AbstractModel):
6129
6137
 
6130
6138
  @property
6131
6139
  def DBInstanceId(self):
6132
- """实例ID
6140
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6133
6141
  :rtype: str
6134
6142
  """
6135
6143
  return self._DBInstanceId
@@ -6140,7 +6148,7 @@ class DeleteLogBackupRequest(AbstractModel):
6140
6148
 
6141
6149
  @property
6142
6150
  def LogBackupId(self):
6143
- """日志备份ID
6151
+ """日志备份ID。可通过[DescribeLogBackups](https://cloud.tencent.com/document/api/409/89021)接口获取。注:7天内自动备份集不允许删除。
6144
6152
  :rtype: str
6145
6153
  """
6146
6154
  return self._LogBackupId
@@ -6198,14 +6206,14 @@ class DeleteParameterTemplateRequest(AbstractModel):
6198
6206
 
6199
6207
  def __init__(self):
6200
6208
  r"""
6201
- :param _TemplateId: 参数模板ID,用于唯一确认待操作的参数模板
6209
+ :param _TemplateId: 参数模板ID,用于唯一确认待操作的参数模板。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
6202
6210
  :type TemplateId: str
6203
6211
  """
6204
6212
  self._TemplateId = None
6205
6213
 
6206
6214
  @property
6207
6215
  def TemplateId(self):
6208
- """参数模板ID,用于唯一确认待操作的参数模板
6216
+ """参数模板ID,用于唯一确认待操作的参数模板。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
6209
6217
  :rtype: str
6210
6218
  """
6211
6219
  return self._TemplateId
@@ -6465,9 +6473,9 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
6465
6473
 
6466
6474
  def __init__(self):
6467
6475
  r"""
6468
- :param _DBInstanceId: 实例ID。
6476
+ :param _DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6469
6477
  :type DBInstanceId: str
6470
- :param _UserName: 查询此账号对某数据库对象所拥有的权限信息。
6478
+ :param _UserName: 查询此账号对某数据库对象所拥有的权限信息。账号名可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
6471
6479
  :type UserName: str
6472
6480
  :param _DatabaseObjectSet: 要查询的数据库对象信息
6473
6481
  :type DatabaseObjectSet: list of DatabaseObject
@@ -6478,7 +6486,7 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
6478
6486
 
6479
6487
  @property
6480
6488
  def DBInstanceId(self):
6481
- """实例ID。
6489
+ """实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6482
6490
  :rtype: str
6483
6491
  """
6484
6492
  return self._DBInstanceId
@@ -6489,7 +6497,7 @@ class DescribeAccountPrivilegesRequest(AbstractModel):
6489
6497
 
6490
6498
  @property
6491
6499
  def UserName(self):
6492
- """查询此账号对某数据库对象所拥有的权限信息。
6500
+ """查询此账号对某数据库对象所拥有的权限信息。账号名可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
6493
6501
  :rtype: str
6494
6502
  """
6495
6503
  return self._UserName
@@ -6743,14 +6751,14 @@ class DescribeAvailableRecoveryTimeRequest(AbstractModel):
6743
6751
 
6744
6752
  def __init__(self):
6745
6753
  r"""
6746
- :param _DBInstanceId: 实例ID
6754
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6747
6755
  :type DBInstanceId: str
6748
6756
  """
6749
6757
  self._DBInstanceId = None
6750
6758
 
6751
6759
  @property
6752
6760
  def DBInstanceId(self):
6753
- """实例ID
6761
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6754
6762
  :rtype: str
6755
6763
  """
6756
6764
  return self._DBInstanceId
@@ -6946,13 +6954,13 @@ class DescribeBackupDownloadURLRequest(AbstractModel):
6946
6954
 
6947
6955
  def __init__(self):
6948
6956
  r"""
6949
- :param _DBInstanceId: 实例ID
6957
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6950
6958
  :type DBInstanceId: str
6951
6959
  :param _BackupType: 备份类型,目前支持:LogBackup,BaseBackup。
6952
6960
  :type BackupType: str
6953
6961
  :param _BackupId: 备份的唯一ID。
6954
6962
  :type BackupId: str
6955
- :param _URLExpireTime: 链接的有效时间,默认为12小时。
6963
+ :param _URLExpireTime: 链接的有效时间,取值为[0,36],默认为12小时。
6956
6964
  :type URLExpireTime: int
6957
6965
  :param _BackupDownloadRestriction: 备份下载限制
6958
6966
  :type BackupDownloadRestriction: :class:`tencentcloud.postgres.v20170312.models.BackupDownloadRestriction`
@@ -6965,7 +6973,7 @@ class DescribeBackupDownloadURLRequest(AbstractModel):
6965
6973
 
6966
6974
  @property
6967
6975
  def DBInstanceId(self):
6968
- """实例ID
6976
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6969
6977
  :rtype: str
6970
6978
  """
6971
6979
  return self._DBInstanceId
@@ -6998,7 +7006,7 @@ class DescribeBackupDownloadURLRequest(AbstractModel):
6998
7006
 
6999
7007
  @property
7000
7008
  def URLExpireTime(self):
7001
- """链接的有效时间,默认为12小时。
7009
+ """链接的有效时间,取值为[0,36],默认为12小时。
7002
7010
  :rtype: int
7003
7011
  """
7004
7012
  return self._URLExpireTime
@@ -7256,14 +7264,14 @@ class DescribeBackupPlansRequest(AbstractModel):
7256
7264
 
7257
7265
  def __init__(self):
7258
7266
  r"""
7259
- :param _DBInstanceId: 实例ID
7267
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7260
7268
  :type DBInstanceId: str
7261
7269
  """
7262
7270
  self._DBInstanceId = None
7263
7271
 
7264
7272
  @property
7265
7273
  def DBInstanceId(self):
7266
- """实例ID
7274
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7267
7275
  :rtype: str
7268
7276
  """
7269
7277
  return self._DBInstanceId
@@ -7516,18 +7524,18 @@ class DescribeBaseBackupsRequest(AbstractModel):
7516
7524
  :type MaxFinishTime: str
7517
7525
  :param _Filters: 按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:
7518
7526
  db-instance-id:按照实例ID过滤,类型为string。
7519
- db-instance-name:按照实例名过滤,类型为string。
7527
+ db-instance-name:按照实例名过滤,支持模糊匹配,类型为string。
7520
7528
  db-instance-ip:按照实例私有网络IP地址过滤,类型为string。
7521
7529
  base-backup-id:按照备份集ID过滤,类型为string。
7522
- db-instance-status:按实例状态过滤,类型为string。取值参考DBInstance结构的DBInstanceStatus字段。
7530
+ db-instance-status:按实例状态过滤,类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。
7523
7531
  :type Filters: list of Filter
7524
7532
  :param _Limit: 每页显示数量,取值范围为1-100,默认为返回10条。
7525
7533
  :type Limit: int
7526
7534
  :param _Offset: 数据偏移量,从0开始。
7527
7535
  :type Offset: int
7528
- :param _OrderBy: 排序字段,支持StartTime,FinishTime,Size。
7536
+ :param _OrderBy: 排序字段,支持StartTime,FinishTime,Size。默认值:StartTime
7529
7537
  :type OrderBy: str
7530
- :param _OrderByType: 排序方式,包括升序:asc,降序:desc。
7538
+ :param _OrderByType: 排序方式,包括升序:asc,降序:desc。默认值:desc
7531
7539
  :type OrderByType: str
7532
7540
  """
7533
7541
  self._MinFinishTime = None
@@ -7564,10 +7572,10 @@ db-instance-status:按实例状态过滤,类型为string。取值参考DBIns
7564
7572
  def Filters(self):
7565
7573
  """按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:
7566
7574
  db-instance-id:按照实例ID过滤,类型为string。
7567
- db-instance-name:按照实例名过滤,类型为string。
7575
+ db-instance-name:按照实例名过滤,支持模糊匹配,类型为string。
7568
7576
  db-instance-ip:按照实例私有网络IP地址过滤,类型为string。
7569
7577
  base-backup-id:按照备份集ID过滤,类型为string。
7570
- db-instance-status:按实例状态过滤,类型为string。取值参考DBInstance结构的DBInstanceStatus字段。
7578
+ db-instance-status:按实例状态过滤,类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。
7571
7579
  :rtype: list of Filter
7572
7580
  """
7573
7581
  return self._Filters
@@ -7600,7 +7608,7 @@ db-instance-status:按实例状态过滤,类型为string。取值参考DBIns
7600
7608
 
7601
7609
  @property
7602
7610
  def OrderBy(self):
7603
- """排序字段,支持StartTime,FinishTime,Size。
7611
+ """排序字段,支持StartTime,FinishTime,Size。默认值:StartTime
7604
7612
  :rtype: str
7605
7613
  """
7606
7614
  return self._OrderBy
@@ -7611,7 +7619,7 @@ db-instance-status:按实例状态过滤,类型为string。取值参考DBIns
7611
7619
 
7612
7620
  @property
7613
7621
  def OrderByType(self):
7614
- """排序方式,包括升序:asc,降序:desc。
7622
+ """排序方式,包括升序:asc,降序:desc。默认值:desc
7615
7623
  :rtype: str
7616
7624
  """
7617
7625
  return self._OrderByType
@@ -7714,13 +7722,13 @@ class DescribeClassesRequest(AbstractModel):
7714
7722
 
7715
7723
  def __init__(self):
7716
7724
  r"""
7717
- :param _Zone: 可用区ID。可以通过接口DescribeZones获取。
7725
+ :param _Zone: 可用区名称。可以通过接口[DescribeZones](https://cloud.tencent.com/document/product/409/16769)获取。
7718
7726
  :type Zone: str
7719
7727
  :param _DBEngine: 数据库引擎,支持:
7720
7728
  1、postgresql(云数据库PostgreSQL);
7721
7729
  2、mssql_compatible(MSSQL兼容-云数据库PostgreSQL);
7722
7730
  :type DBEngine: str
7723
- :param _DBMajorVersion: 数据库主版本号。例如12,13,可以通过接口DescribeDBVersions获取。
7731
+ :param _DBMajorVersion: 数据库主版本号。例如12,13,可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取。
7724
7732
  :type DBMajorVersion: str
7725
7733
  """
7726
7734
  self._Zone = None
@@ -7729,7 +7737,7 @@ class DescribeClassesRequest(AbstractModel):
7729
7737
 
7730
7738
  @property
7731
7739
  def Zone(self):
7732
- """可用区ID。可以通过接口DescribeZones获取。
7740
+ """可用区名称。可以通过接口[DescribeZones](https://cloud.tencent.com/document/product/409/16769)获取。
7733
7741
  :rtype: str
7734
7742
  """
7735
7743
  return self._Zone
@@ -7753,7 +7761,7 @@ class DescribeClassesRequest(AbstractModel):
7753
7761
 
7754
7762
  @property
7755
7763
  def DBMajorVersion(self):
7756
- """数据库主版本号。例如12,13,可以通过接口DescribeDBVersions获取。
7764
+ """数据库主版本号。例如12,13,可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取。
7757
7765
  :rtype: str
7758
7766
  """
7759
7767
  return self._DBMajorVersion
@@ -7832,9 +7840,9 @@ class DescribeCloneDBInstanceSpecRequest(AbstractModel):
7832
7840
 
7833
7841
  def __init__(self):
7834
7842
  r"""
7835
- :param _DBInstanceId: 实例ID
7843
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7836
7844
  :type DBInstanceId: str
7837
- :param _BackupSetId: 基础备份集ID,此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
7845
+ :param _BackupSetId: 基础备份集ID,可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
7838
7846
  :type BackupSetId: str
7839
7847
  :param _RecoveryTargetTime: 恢复目标时间,此入参和BackupSetId必须选择一个传入。时区以东八区(UTC+8)为准。
7840
7848
  :type RecoveryTargetTime: str
@@ -7845,7 +7853,7 @@ class DescribeCloneDBInstanceSpecRequest(AbstractModel):
7845
7853
 
7846
7854
  @property
7847
7855
  def DBInstanceId(self):
7848
- """实例ID
7856
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7849
7857
  :rtype: str
7850
7858
  """
7851
7859
  return self._DBInstanceId
@@ -7856,7 +7864,7 @@ class DescribeCloneDBInstanceSpecRequest(AbstractModel):
7856
7864
 
7857
7865
  @property
7858
7866
  def BackupSetId(self):
7859
- """基础备份集ID,此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
7867
+ """基础备份集ID,可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
7860
7868
  :rtype: str
7861
7869
  """
7862
7870
  return self._BackupSetId
@@ -8130,7 +8138,7 @@ class DescribeDBErrlogsRequest(AbstractModel):
8130
8138
 
8131
8139
  def __init__(self):
8132
8140
  r"""
8133
- :param _DBInstanceId: 实例ID。
8141
+ :param _DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
8134
8142
  :type DBInstanceId: str
8135
8143
  :param _StartTime: 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
8136
8144
  :type StartTime: str
@@ -8155,7 +8163,7 @@ class DescribeDBErrlogsRequest(AbstractModel):
8155
8163
 
8156
8164
  @property
8157
8165
  def DBInstanceId(self):
8158
- """实例ID。
8166
+ """实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
8159
8167
  :rtype: str
8160
8168
  """
8161
8169
  return self._DBInstanceId
@@ -8567,7 +8575,7 @@ class DescribeDBInstanceParametersRequest(AbstractModel):
8567
8575
 
8568
8576
  def __init__(self):
8569
8577
  r"""
8570
- :param _DBInstanceId: 实例ID
8578
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
8571
8579
  :type DBInstanceId: str
8572
8580
  :param _ParamName: 查询指定参数详情。ParamName为空或不传,默认返回全部参数列表
8573
8581
  :type ParamName: str
@@ -8577,7 +8585,7 @@ class DescribeDBInstanceParametersRequest(AbstractModel):
8577
8585
 
8578
8586
  @property
8579
8587
  def DBInstanceId(self):
8580
- """实例ID
8588
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
8581
8589
  :rtype: str
8582
8590
  """
8583
8591
  return self._DBInstanceId
@@ -8681,14 +8689,14 @@ class DescribeDBInstanceSSLConfigRequest(AbstractModel):
8681
8689
 
8682
8690
  def __init__(self):
8683
8691
  r"""
8684
- :param _DBInstanceId: 实例ID,形如postgres-6bwgamo3
8692
+ :param _DBInstanceId: 实例ID,形如postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
8685
8693
  :type DBInstanceId: str
8686
8694
  """
8687
8695
  self._DBInstanceId = None
8688
8696
 
8689
8697
  @property
8690
8698
  def DBInstanceId(self):
8691
- """实例ID,形如postgres-6bwgamo3
8699
+ """实例ID,形如postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
8692
8700
  :rtype: str
8693
8701
  """
8694
8702
  return self._DBInstanceId
@@ -8790,9 +8798,9 @@ class DescribeDBInstanceSecurityGroupsRequest(AbstractModel):
8790
8798
 
8791
8799
  def __init__(self):
8792
8800
  r"""
8793
- :param _DBInstanceId: 实例IDDBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
8801
+ :param _DBInstanceId: 实例ID,可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
8794
8802
  :type DBInstanceId: str
8795
- :param _ReadOnlyGroupId: 只读组IDDBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
8803
+ :param _ReadOnlyGroupId: 只读组ID,可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
8796
8804
  :type ReadOnlyGroupId: str
8797
8805
  """
8798
8806
  self._DBInstanceId = None
@@ -8800,7 +8808,7 @@ class DescribeDBInstanceSecurityGroupsRequest(AbstractModel):
8800
8808
 
8801
8809
  @property
8802
8810
  def DBInstanceId(self):
8803
- """实例IDDBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
8811
+ """实例ID,可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
8804
8812
  :rtype: str
8805
8813
  """
8806
8814
  return self._DBInstanceId
@@ -8811,7 +8819,7 @@ class DescribeDBInstanceSecurityGroupsRequest(AbstractModel):
8811
8819
 
8812
8820
  @property
8813
8821
  def ReadOnlyGroupId(self):
8814
- """只读组IDDBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
8822
+ """只读组ID,可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
8815
8823
  :rtype: str
8816
8824
  """
8817
8825
  return self._ReadOnlyGroupId
@@ -9483,7 +9491,7 @@ class DescribeDatabaseObjectsRequest(AbstractModel):
9483
9491
 
9484
9492
  def __init__(self):
9485
9493
  r"""
9486
- :param _DBInstanceId: 实例ID。
9494
+ :param _DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
9487
9495
  :type DBInstanceId: str
9488
9496
  :param _ObjectType: 查询的对象类型。支持查询的数据对象有:database,schema,sequence,procedure,type,function,table,view,matview,column。
9489
9497
  :type ObjectType: str
@@ -9508,7 +9516,7 @@ class DescribeDatabaseObjectsRequest(AbstractModel):
9508
9516
 
9509
9517
  @property
9510
9518
  def DBInstanceId(self):
9511
- """实例ID。
9519
+ """实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
9512
9520
  :rtype: str
9513
9521
  """
9514
9522
  return self._DBInstanceId
@@ -9924,7 +9932,7 @@ class DescribeDefaultParametersRequest(AbstractModel):
9924
9932
 
9925
9933
  def __init__(self):
9926
9934
  r"""
9927
- :param _DBMajorVersion: 数据库版本,大版本号,例如11,12,13
9935
+ :param _DBMajorVersion: 数据库版本,大版本号,例如11,12,13。可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
9928
9936
  :type DBMajorVersion: str
9929
9937
  :param _DBEngine: 数据库引擎,例如:postgresql,mssql_compatible
9930
9938
  :type DBEngine: str
@@ -9934,7 +9942,7 @@ class DescribeDefaultParametersRequest(AbstractModel):
9934
9942
 
9935
9943
  @property
9936
9944
  def DBMajorVersion(self):
9937
- """数据库版本,大版本号,例如11,12,13
9945
+ """数据库版本,大版本号,例如11,12,13。可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
9938
9946
  :rtype: str
9939
9947
  """
9940
9948
  return self._DBMajorVersion
@@ -10040,14 +10048,14 @@ class DescribeEncryptionKeysRequest(AbstractModel):
10040
10048
 
10041
10049
  def __init__(self):
10042
10050
  r"""
10043
- :param _DBInstanceId: 实例ID
10051
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
10044
10052
  :type DBInstanceId: str
10045
10053
  """
10046
10054
  self._DBInstanceId = None
10047
10055
 
10048
10056
  @property
10049
10057
  def DBInstanceId(self):
10050
- """实例ID
10058
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
10051
10059
  :rtype: str
10052
10060
  """
10053
10061
  return self._DBInstanceId
@@ -10130,17 +10138,17 @@ class DescribeLogBackupsRequest(AbstractModel):
10130
10138
  :type MaxFinishTime: str
10131
10139
  :param _Filters: 按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:
10132
10140
  db-instance-id:按照实例ID过滤,类型为string。
10133
- db-instance-name:按照实例名过滤,类型为string。
10141
+ db-instance-name:按照实例名过滤,支持模糊匹配,类型为string。
10134
10142
  db-instance-ip:按照实例私有网络IP地址过滤,类型为string。
10135
- db-instance-status:按实例状态过滤,类型为string。取值参考DBInstance结构的DBInstanceStatus字段。
10143
+ db-instance-status:按实例状态过滤,类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。
10136
10144
  :type Filters: list of Filter
10137
10145
  :param _Limit: 每页显示数量,取值范围为1-100,默认为返回10条。
10138
10146
  :type Limit: int
10139
10147
  :param _Offset: 数据偏移量,从0开始。
10140
10148
  :type Offset: int
10141
- :param _OrderBy: 排序字段,支持StartTime,FinishTime,Size
10149
+ :param _OrderBy: 排序字段,支持StartTime,FinishTime,Size。默认值:StartTime
10142
10150
  :type OrderBy: str
10143
- :param _OrderByType: 排序方式,包括升序:asc,降序:desc。
10151
+ :param _OrderByType: 排序方式,包括升序:asc,降序:desc。默认值:desc
10144
10152
  :type OrderByType: str
10145
10153
  """
10146
10154
  self._MinFinishTime = None
@@ -10177,9 +10185,9 @@ db-instance-status:按实例状态过滤,类型为string。取值参考DBIns
10177
10185
  def Filters(self):
10178
10186
  """按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:
10179
10187
  db-instance-id:按照实例ID过滤,类型为string。
10180
- db-instance-name:按照实例名过滤,类型为string。
10188
+ db-instance-name:按照实例名过滤,支持模糊匹配,类型为string。
10181
10189
  db-instance-ip:按照实例私有网络IP地址过滤,类型为string。
10182
- db-instance-status:按实例状态过滤,类型为string。取值参考DBInstance结构的DBInstanceStatus字段。
10190
+ db-instance-status:按实例状态过滤,类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。
10183
10191
  :rtype: list of Filter
10184
10192
  """
10185
10193
  return self._Filters
@@ -10212,7 +10220,7 @@ db-instance-status:按实例状态过滤,类型为string。取值参考DBIns
10212
10220
 
10213
10221
  @property
10214
10222
  def OrderBy(self):
10215
- """排序字段,支持StartTime,FinishTime,Size
10223
+ """排序字段,支持StartTime,FinishTime,Size。默认值:StartTime
10216
10224
  :rtype: str
10217
10225
  """
10218
10226
  return self._OrderBy
@@ -10223,7 +10231,7 @@ db-instance-status:按实例状态过滤,类型为string。取值参考DBIns
10223
10231
 
10224
10232
  @property
10225
10233
  def OrderByType(self):
10226
- """排序方式,包括升序:asc,降序:desc。
10234
+ """排序方式,包括升序:asc,降序:desc。默认值:desc
10227
10235
  :rtype: str
10228
10236
  """
10229
10237
  return self._OrderByType
@@ -10326,14 +10334,14 @@ class DescribeMaintainTimeWindowRequest(AbstractModel):
10326
10334
 
10327
10335
  def __init__(self):
10328
10336
  r"""
10329
- :param _DBInstanceId: 实例ID
10337
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
10330
10338
  :type DBInstanceId: str
10331
10339
  """
10332
10340
  self._DBInstanceId = None
10333
10341
 
10334
10342
  @property
10335
10343
  def DBInstanceId(self):
10336
- """实例ID
10344
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
10337
10345
  :rtype: str
10338
10346
  """
10339
10347
  return self._DBInstanceId
@@ -10549,14 +10557,14 @@ class DescribeParameterTemplateAttributesRequest(AbstractModel):
10549
10557
 
10550
10558
  def __init__(self):
10551
10559
  r"""
10552
- :param _TemplateId: 参数模板ID
10560
+ :param _TemplateId: 参数模板ID。可通过[DescribeParameterTemplates](https://tapd.woa.com/tapd_fe/20400322/story/detail/1020400322125673714)接口获取
10553
10561
  :type TemplateId: str
10554
10562
  """
10555
10563
  self._TemplateId = None
10556
10564
 
10557
10565
  @property
10558
10566
  def TemplateId(self):
10559
- """参数模板ID
10567
+ """参数模板ID。可通过[DescribeParameterTemplates](https://tapd.woa.com/tapd_fe/20400322/story/detail/1020400322125673714)接口获取
10560
10568
  :rtype: str
10561
10569
  """
10562
10570
  return self._TemplateId
@@ -10725,15 +10733,15 @@ class DescribeParameterTemplatesRequest(AbstractModel):
10725
10733
 
10726
10734
  def __init__(self):
10727
10735
  r"""
10728
- :param _Filters: 过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine
10736
+ :param _Filters: 过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine。TemplateName不支持模糊匹配。
10729
10737
  :type Filters: list of Filter
10730
10738
  :param _Limit: 每页显示数量,[0,100],默认 20
10731
10739
  :type Limit: int
10732
10740
  :param _Offset: 数据偏移量
10733
10741
  :type Offset: int
10734
- :param _OrderBy: 排序指标,枚举值,支持:CreateTime,TemplateName,DBMajorVersion
10742
+ :param _OrderBy: 排序指标,枚举值,支持:CreateTime,TemplateName,DBMajorVersion。如果不指定该参数,默认将按照参数模板的编号倒序排列,也就是说最新添加的参数模板会排在最前面。
10735
10743
  :type OrderBy: str
10736
- :param _OrderByType: 排序方式,枚举值,支持:asc(升序) ,desc(降序)
10744
+ :param _OrderByType: 排序方式,枚举值,支持:asc(升序) ,desc(降序)。默认值为asc。当未指定OrderBy时,该参数失效,此时排序方式为OrderBy参数描述中给出的默认排序方式。
10737
10745
  :type OrderByType: str
10738
10746
  """
10739
10747
  self._Filters = None
@@ -10744,7 +10752,7 @@ class DescribeParameterTemplatesRequest(AbstractModel):
10744
10752
 
10745
10753
  @property
10746
10754
  def Filters(self):
10747
- """过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine
10755
+ """过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine。TemplateName不支持模糊匹配。
10748
10756
  :rtype: list of Filter
10749
10757
  """
10750
10758
  return self._Filters
@@ -10777,7 +10785,7 @@ class DescribeParameterTemplatesRequest(AbstractModel):
10777
10785
 
10778
10786
  @property
10779
10787
  def OrderBy(self):
10780
- """排序指标,枚举值,支持:CreateTime,TemplateName,DBMajorVersion
10788
+ """排序指标,枚举值,支持:CreateTime,TemplateName,DBMajorVersion。如果不指定该参数,默认将按照参数模板的编号倒序排列,也就是说最新添加的参数模板会排在最前面。
10781
10789
  :rtype: str
10782
10790
  """
10783
10791
  return self._OrderBy
@@ -10788,7 +10796,7 @@ class DescribeParameterTemplatesRequest(AbstractModel):
10788
10796
 
10789
10797
  @property
10790
10798
  def OrderByType(self):
10791
- """排序方式,枚举值,支持:asc(升序) ,desc(降序)
10799
+ """排序方式,枚举值,支持:asc(升序) ,desc(降序)。默认值为asc。当未指定OrderBy时,该参数失效,此时排序方式为OrderBy参数描述中给出的默认排序方式。
10792
10800
  :rtype: str
10793
10801
  """
10794
10802
  return self._OrderByType
@@ -10889,14 +10897,14 @@ class DescribeParamsEventRequest(AbstractModel):
10889
10897
 
10890
10898
  def __init__(self):
10891
10899
  r"""
10892
- :param _DBInstanceId: 实例DB ID
10900
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
10893
10901
  :type DBInstanceId: str
10894
10902
  """
10895
10903
  self._DBInstanceId = None
10896
10904
 
10897
10905
  @property
10898
10906
  def DBInstanceId(self):
10899
- """实例DB ID
10907
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
10900
10908
  :rtype: str
10901
10909
  """
10902
10910
  return self._DBInstanceId
@@ -11491,7 +11499,7 @@ class DescribeSlowQueryAnalysisRequest(AbstractModel):
11491
11499
 
11492
11500
  def __init__(self):
11493
11501
  r"""
11494
- :param _DBInstanceId: 实例ID
11502
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
11495
11503
  :type DBInstanceId: str
11496
11504
  :param _StartTime: 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
11497
11505
  :type StartTime: str
@@ -11519,7 +11527,7 @@ class DescribeSlowQueryAnalysisRequest(AbstractModel):
11519
11527
 
11520
11528
  @property
11521
11529
  def DBInstanceId(self):
11522
- """实例ID
11530
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
11523
11531
  :rtype: str
11524
11532
  """
11525
11533
  return self._DBInstanceId
@@ -11692,7 +11700,7 @@ class DescribeSlowQueryListRequest(AbstractModel):
11692
11700
 
11693
11701
  def __init__(self):
11694
11702
  r"""
11695
- :param _DBInstanceId: 实例ID
11703
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
11696
11704
  :type DBInstanceId: str
11697
11705
  :param _StartTime: 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
11698
11706
  :type StartTime: str
@@ -11720,7 +11728,7 @@ class DescribeSlowQueryListRequest(AbstractModel):
11720
11728
 
11721
11729
  @property
11722
11730
  def DBInstanceId(self):
11723
- """实例ID
11731
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
11724
11732
  :rtype: str
11725
11733
  """
11726
11734
  return self._DBInstanceId
@@ -12324,11 +12332,11 @@ class DisIsolateDBInstancesRequest(AbstractModel):
12324
12332
 
12325
12333
  def __init__(self):
12326
12334
  r"""
12327
- :param _DBInstanceIdSet: 实例ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
12335
+ :param _DBInstanceIdSet: 实例ID列表。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时解隔离多个实例。
12328
12336
  :type DBInstanceIdSet: list of str
12329
12337
  :param _Period: 购买时长,单位:月。
12330
12338
  <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
12331
- <li>后付费:只支持1</li>
12339
+ <li>后付费:该参数不生效</li>
12332
12340
  :type Period: int
12333
12341
  :param _AutoVoucher: 是否使用代金券:
12334
12342
  <li>true:使用</li>
@@ -12345,7 +12353,7 @@ class DisIsolateDBInstancesRequest(AbstractModel):
12345
12353
 
12346
12354
  @property
12347
12355
  def DBInstanceIdSet(self):
12348
- """实例ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
12356
+ """实例ID列表。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时解隔离多个实例。
12349
12357
  :rtype: list of str
12350
12358
  """
12351
12359
  return self._DBInstanceIdSet
@@ -12358,7 +12366,7 @@ class DisIsolateDBInstancesRequest(AbstractModel):
12358
12366
  def Period(self):
12359
12367
  """购买时长,单位:月。
12360
12368
  <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
12361
- <li>后付费:只支持1</li>
12369
+ <li>后付费:该参数不生效</li>
12362
12370
  :rtype: int
12363
12371
  """
12364
12372
  return self._Period
@@ -12711,7 +12719,7 @@ class EventInfo(AbstractModel):
12711
12719
  :type ModifyTime: str
12712
12720
  :param _EffectiveTime: 后台参数生效开始时间
12713
12721
  :type EffectiveTime: str
12714
- :param _State: 修改状态
12722
+ :param _State: 修改状态。枚举值:in progress、success、paused
12715
12723
  :type State: str
12716
12724
  :param _Operator: 操作者(一般为用户sub UIN)
12717
12725
  :type Operator: str
@@ -12784,7 +12792,7 @@ class EventInfo(AbstractModel):
12784
12792
 
12785
12793
  @property
12786
12794
  def State(self):
12787
- """修改状态
12795
+ """修改状态。枚举值:in progress、success、paused
12788
12796
  :rtype: str
12789
12797
  """
12790
12798
  return self._State
@@ -12966,11 +12974,11 @@ class InquiryPriceCreateDBInstancesRequest(AbstractModel):
12966
12974
 
12967
12975
  def __init__(self):
12968
12976
  r"""
12969
- :param _Zone: 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
12977
+ :param _Zone: 可用区名称。该参数可以通过调用[ DescribeZones](https://cloud.tencent.com/document/product/409/16769) 接口的返回值中的Zone字段来获取。
12970
12978
  :type Zone: str
12971
- :param _SpecCode: 规格ID。该参数可以通过调用DescribeClasses接口的返回值中的SpecCode字段来获取。
12979
+ :param _SpecCode: 规格ID。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/product/409/89019)接口的返回值中的SpecCode字段来获取。
12972
12980
  :type SpecCode: str
12973
- :param _Storage: 存储容量大小,单位:GB。
12981
+ :param _Storage: 存储容量大小,单位:GB。该参数的设置步长为10
12974
12982
  :type Storage: int
12975
12983
  :param _InstanceCount: 实例数量。目前最大数量不超过100,如需一次性创建更多实例,请联系客服支持。
12976
12984
  :type InstanceCount: int
@@ -12978,7 +12986,8 @@ class InquiryPriceCreateDBInstancesRequest(AbstractModel):
12978
12986
  :type Period: int
12979
12987
  :param _Pid: 【弃字段,不再生效】,计费ID。该参数可以通过调用DescribeProductConfig接口的返回值中的Pid字段来获取。
12980
12988
  :type Pid: int
12981
- :param _InstanceChargeType: 实例计费类型。目前只支持:PREPAID(预付费,即包年包月)。
12989
+ :param _InstanceChargeType: 实例计费类型。目前支持:PREPAID(预付费,即包年包月)和 POSTPAID(按量计费)。
12990
+ 默认值:PREPAID
12982
12991
  :type InstanceChargeType: str
12983
12992
  :param _InstanceType: 实例类型,默认primary,支持如下:
12984
12993
  primary(双机高可用(一主一从))
@@ -13001,7 +13010,7 @@ mssql_compatible(MSSQL兼容-云数据库PostgreSQL)
13001
13010
 
13002
13011
  @property
13003
13012
  def Zone(self):
13004
- """可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
13013
+ """可用区名称。该参数可以通过调用[ DescribeZones](https://cloud.tencent.com/document/product/409/16769) 接口的返回值中的Zone字段来获取。
13005
13014
  :rtype: str
13006
13015
  """
13007
13016
  return self._Zone
@@ -13012,7 +13021,7 @@ mssql_compatible(MSSQL兼容-云数据库PostgreSQL)
13012
13021
 
13013
13022
  @property
13014
13023
  def SpecCode(self):
13015
- """规格ID。该参数可以通过调用DescribeClasses接口的返回值中的SpecCode字段来获取。
13024
+ """规格ID。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/product/409/89019)接口的返回值中的SpecCode字段来获取。
13016
13025
  :rtype: str
13017
13026
  """
13018
13027
  return self._SpecCode
@@ -13023,7 +13032,7 @@ mssql_compatible(MSSQL兼容-云数据库PostgreSQL)
13023
13032
 
13024
13033
  @property
13025
13034
  def Storage(self):
13026
- """存储容量大小,单位:GB。
13035
+ """存储容量大小,单位:GB。该参数的设置步长为10
13027
13036
  :rtype: int
13028
13037
  """
13029
13038
  return self._Storage
@@ -13067,7 +13076,8 @@ mssql_compatible(MSSQL兼容-云数据库PostgreSQL)
13067
13076
 
13068
13077
  @property
13069
13078
  def InstanceChargeType(self):
13070
- """实例计费类型。目前只支持:PREPAID(预付费,即包年包月)。
13079
+ """实例计费类型。目前支持:PREPAID(预付费,即包年包月)和 POSTPAID(按量计费)。
13080
+ 默认值:PREPAID
13071
13081
  :rtype: str
13072
13082
  """
13073
13083
  return self._InstanceChargeType
@@ -13331,11 +13341,12 @@ class InquiryPriceUpgradeDBInstanceRequest(AbstractModel):
13331
13341
  :type Storage: int
13332
13342
  :param _Memory: 实例的内存大小,单位GB
13333
13343
  :type Memory: int
13334
- :param _DBInstanceId: 实例ID,形如postgres-hez4fh0v
13344
+ :param _DBInstanceId: 实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
13335
13345
  :type DBInstanceId: str
13336
13346
  :param _InstanceChargeType: 实例计费类型。
13337
13347
  :type InstanceChargeType: str
13338
- :param _Cpu: 实例的Cpu大小,单位Core
13348
+ :param _Cpu: 实例的Cpu大小,单位Core
13349
+ 不传入此参数时,默认根据Memory确定的售卖规格所对应的Cpu进行设置。如Memory为2,支持的售卖规格有1核2GiB,则不传入Cpu时,Cpu默认为1。
13339
13350
  :type Cpu: int
13340
13351
  """
13341
13352
  self._Storage = None
@@ -13368,7 +13379,7 @@ class InquiryPriceUpgradeDBInstanceRequest(AbstractModel):
13368
13379
 
13369
13380
  @property
13370
13381
  def DBInstanceId(self):
13371
- """实例ID,形如postgres-hez4fh0v
13382
+ """实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
13372
13383
  :rtype: str
13373
13384
  """
13374
13385
  return self._DBInstanceId
@@ -13394,7 +13405,8 @@ class InquiryPriceUpgradeDBInstanceRequest(AbstractModel):
13394
13405
 
13395
13406
  @property
13396
13407
  def Cpu(self):
13397
- """实例的Cpu大小,单位Core
13408
+ """实例的Cpu大小,单位Core
13409
+ 不传入此参数时,默认根据Memory确定的售卖规格所对应的Cpu进行设置。如Memory为2,支持的售卖规格有1核2GiB,则不传入Cpu时,Cpu默认为1。
13398
13410
  :rtype: int
13399
13411
  """
13400
13412
  return self._Cpu
@@ -13500,14 +13512,14 @@ class IsolateDBInstancesRequest(AbstractModel):
13500
13512
 
13501
13513
  def __init__(self):
13502
13514
  r"""
13503
- :param _DBInstanceIdSet: 实例ID集合。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
13515
+ :param _DBInstanceIdSet: 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
13504
13516
  :type DBInstanceIdSet: list of str
13505
13517
  """
13506
13518
  self._DBInstanceIdSet = None
13507
13519
 
13508
13520
  @property
13509
13521
  def DBInstanceIdSet(self):
13510
- """实例ID集合。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
13522
+ """实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
13511
13523
  :rtype: list of str
13512
13524
  """
13513
13525
  return self._DBInstanceIdSet
@@ -13649,11 +13661,11 @@ class LogBackup(AbstractModel):
13649
13661
  :type Id: str
13650
13662
  :param _Name: 备份文件名称。
13651
13663
  :type Name: str
13652
- :param _BackupMethod: 备份方式:物理备份、逻辑备份。
13664
+ :param _BackupMethod: 备份方式。枚举值,physical - 物理备份;logical - 逻辑备份。
13653
13665
  :type BackupMethod: str
13654
- :param _BackupMode: 备份模式:自动备份、手动备份。
13666
+ :param _BackupMode: 备份模式。枚举值,manual - 手动备份;automatic - 自动备份 。
13655
13667
  :type BackupMode: str
13656
- :param _State: 备份任务状态。
13668
+ :param _State: 备份任务状态。枚举值:init、running、finished、failed、canceled
13657
13669
  :type State: str
13658
13670
  :param _Size: 备份集大小,单位bytes。
13659
13671
  :type Size: int
@@ -13710,7 +13722,7 @@ class LogBackup(AbstractModel):
13710
13722
 
13711
13723
  @property
13712
13724
  def BackupMethod(self):
13713
- """备份方式:物理备份、逻辑备份。
13725
+ """备份方式。枚举值,physical - 物理备份;logical - 逻辑备份。
13714
13726
  :rtype: str
13715
13727
  """
13716
13728
  return self._BackupMethod
@@ -13721,7 +13733,7 @@ class LogBackup(AbstractModel):
13721
13733
 
13722
13734
  @property
13723
13735
  def BackupMode(self):
13724
- """备份模式:自动备份、手动备份。
13736
+ """备份模式。枚举值,manual - 手动备份;automatic - 自动备份 。
13725
13737
  :rtype: str
13726
13738
  """
13727
13739
  return self._BackupMode
@@ -13732,7 +13744,7 @@ class LogBackup(AbstractModel):
13732
13744
 
13733
13745
  @property
13734
13746
  def State(self):
13735
- """备份任务状态。
13747
+ """备份任务状态。枚举值:init、running、finished、failed、canceled
13736
13748
  :rtype: str
13737
13749
  """
13738
13750
  return self._State
@@ -14007,7 +14019,7 @@ class ModifyBackupDownloadRestrictionRequest(AbstractModel):
14007
14019
 
14008
14020
  def __init__(self):
14009
14021
  r"""
14010
- :param _RestrictionType: 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
14022
+ :param _RestrictionType: 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE时,Vpc限制和Ip限制需要至少填写一项。
14011
14023
  :type RestrictionType: str
14012
14024
  :param _VpcRestrictionEffect: vpc限制效力,ALLOW 允许;DENY 拒绝。
14013
14025
  :type VpcRestrictionEffect: str
@@ -14028,7 +14040,7 @@ class ModifyBackupDownloadRestrictionRequest(AbstractModel):
14028
14040
 
14029
14041
  @property
14030
14042
  def RestrictionType(self):
14031
- """备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
14043
+ """备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE时,Vpc限制和Ip限制需要至少填写一项。
14032
14044
  :rtype: str
14033
14045
  """
14034
14046
  return self._RestrictionType
@@ -14135,7 +14147,7 @@ class ModifyBackupPlanRequest(AbstractModel):
14135
14147
 
14136
14148
  def __init__(self):
14137
14149
  r"""
14138
- :param _DBInstanceId: 实例ID
14150
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14139
14151
  :type DBInstanceId: str
14140
14152
  :param _MinBackupStartTime: 实例最早开始备份时间
14141
14153
  :type MinBackupStartTime: str
@@ -14143,7 +14155,7 @@ class ModifyBackupPlanRequest(AbstractModel):
14143
14155
  :type MaxBackupStartTime: str
14144
14156
  :param _BaseBackupRetentionPeriod: 实例备份保留时长,取值范围为7-1830,单位是天
14145
14157
  :type BaseBackupRetentionPeriod: int
14146
- :param _BackupPeriod: 实例备份周期,若是星期维度,格式为小写星期英文单词;若是按月维度,格式为数字字符,如["1","2"]。
14158
+ :param _BackupPeriod: 实例备份周期,若是星期维度,格式为小写星期英文单词,且至少设置两天备份;若是按月维度,格式为数字字符,如["1","2"]。
14147
14159
  :type BackupPeriod: list of str
14148
14160
  :param _LogBackupRetentionPeriod: 实例日志备份保留时长,取值范围为7-1830,单位是天
14149
14161
  :type LogBackupRetentionPeriod: int
@@ -14163,7 +14175,7 @@ class ModifyBackupPlanRequest(AbstractModel):
14163
14175
 
14164
14176
  @property
14165
14177
  def DBInstanceId(self):
14166
- """实例ID
14178
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14167
14179
  :rtype: str
14168
14180
  """
14169
14181
  return self._DBInstanceId
@@ -14207,7 +14219,7 @@ class ModifyBackupPlanRequest(AbstractModel):
14207
14219
 
14208
14220
  @property
14209
14221
  def BackupPeriod(self):
14210
- """实例备份周期,若是星期维度,格式为小写星期英文单词;若是按月维度,格式为数字字符,如["1","2"]。
14222
+ """实例备份周期,若是星期维度,格式为小写星期英文单词,且至少设置两天备份;若是按月维度,格式为数字字符,如["1","2"]。
14211
14223
  :rtype: list of str
14212
14224
  """
14213
14225
  return self._BackupPeriod
@@ -14304,9 +14316,9 @@ class ModifyBaseBackupExpireTimeRequest(AbstractModel):
14304
14316
 
14305
14317
  def __init__(self):
14306
14318
  r"""
14307
- :param _DBInstanceId: 实例ID
14319
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14308
14320
  :type DBInstanceId: str
14309
- :param _BaseBackupId: 数据备份ID
14321
+ :param _BaseBackupId: 数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取
14310
14322
  :type BaseBackupId: str
14311
14323
  :param _NewExpireTime: 新过期时间。
14312
14324
  :type NewExpireTime: str
@@ -14317,7 +14329,7 @@ class ModifyBaseBackupExpireTimeRequest(AbstractModel):
14317
14329
 
14318
14330
  @property
14319
14331
  def DBInstanceId(self):
14320
- """实例ID
14332
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14321
14333
  :rtype: str
14322
14334
  """
14323
14335
  return self._DBInstanceId
@@ -14328,7 +14340,7 @@ class ModifyBaseBackupExpireTimeRequest(AbstractModel):
14328
14340
 
14329
14341
  @property
14330
14342
  def BaseBackupId(self):
14331
- """数据备份ID
14343
+ """数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取
14332
14344
  :rtype: str
14333
14345
  """
14334
14346
  return self._BaseBackupId
@@ -14398,7 +14410,7 @@ class ModifyDBInstanceChargeTypeRequest(AbstractModel):
14398
14410
 
14399
14411
  def __init__(self):
14400
14412
  r"""
14401
- :param _DBInstanceId: 实例ID,形如postgres-6fego161
14413
+ :param _DBInstanceId: 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14402
14414
  :type DBInstanceId: str
14403
14415
  :param _InstanceChargeType: 实例计费类型,目前支持:
14404
14416
  <li>PREPAID:预付费,即包年包月</li>
@@ -14428,7 +14440,7 @@ class ModifyDBInstanceChargeTypeRequest(AbstractModel):
14428
14440
 
14429
14441
  @property
14430
14442
  def DBInstanceId(self):
14431
- """实例ID,形如postgres-6fego161
14443
+ """实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14432
14444
  :rtype: str
14433
14445
  """
14434
14446
  return self._DBInstanceId
@@ -14559,7 +14571,7 @@ class ModifyDBInstanceDeploymentRequest(AbstractModel):
14559
14571
 
14560
14572
  def __init__(self):
14561
14573
  r"""
14562
- :param _DBInstanceId: 实例ID
14574
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14563
14575
  :type DBInstanceId: str
14564
14576
  :param _DBNodeSet: 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
14565
14577
  可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
@@ -14568,7 +14580,7 @@ class ModifyDBInstanceDeploymentRequest(AbstractModel):
14568
14580
  <li>0:立即切换 </li>
14569
14581
  <li>1:指定时间切换</li>
14570
14582
  <li>2:维护时间窗口内切换</li>
14571
- 默认值:0
14583
+
14572
14584
  :type SwitchTag: int
14573
14585
  :param _SwitchStartTime: 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。当SwitchTag为0或2时,该参数失效。
14574
14586
  :type SwitchStartTime: str
@@ -14583,7 +14595,7 @@ class ModifyDBInstanceDeploymentRequest(AbstractModel):
14583
14595
 
14584
14596
  @property
14585
14597
  def DBInstanceId(self):
14586
- """实例ID
14598
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14587
14599
  :rtype: str
14588
14600
  """
14589
14601
  return self._DBInstanceId
@@ -14610,7 +14622,7 @@ class ModifyDBInstanceDeploymentRequest(AbstractModel):
14610
14622
  <li>0:立即切换 </li>
14611
14623
  <li>1:指定时间切换</li>
14612
14624
  <li>2:维护时间窗口内切换</li>
14613
- 默认值:0
14625
+
14614
14626
  :rtype: int
14615
14627
  """
14616
14628
  return self._SwitchTag
@@ -14698,20 +14710,20 @@ class ModifyDBInstanceHAConfigRequest(AbstractModel):
14698
14710
 
14699
14711
  def __init__(self):
14700
14712
  r"""
14701
- :param _DBInstanceId: 实例ID
14713
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14702
14714
  :type DBInstanceId: str
14703
14715
  :param _SyncMode: 主从同步方式:
14704
- <li>Semi-sync:半同步
14705
- <li>Async:异步
14716
+ <li>Semi-sync:半同步</li>
14717
+ <li>Async:异步</li>
14706
14718
 
14707
14719
  :type SyncMode: str
14708
14720
  :param _MaxStandbyLatency: 高可用备机最大延迟数据量。备节点延迟数据量小于等于该值,且备节点延迟时间小于等于MaxStandbyLag时,可以切换为主节点。
14709
- <li>单位:byte
14710
- <li>参数范围:[1073741824, 322122547200]
14721
+ <li>单位:byte</li>
14722
+ <li>参数范围:[1073741824, 322122547200]</li>
14711
14723
  :type MaxStandbyLatency: int
14712
14724
  :param _MaxStandbyLag: 高可用备机最大延迟时间。备节点延迟时间小于等于该值,且备节点延迟数据量小于等于MaxStandbyLatency时,可以切换为主节点。
14713
- <li>单位:s
14714
- <li>参数范围:[5, 10]
14725
+ <li>单位:s</li>
14726
+ <li>参数范围:[5, 10]</li>
14715
14727
  :type MaxStandbyLag: int
14716
14728
  :param _MaxSyncStandbyLatency: 同步备机最大延迟数据量。备机延迟数据量小于等于该值,且该备机延迟时间小于等于MaxSyncStandbyLag时,则该备机采用同步复制;否则,采用异步复制。
14717
14729
  该参数值针对SyncMode设置为Semi-sync的实例有效。
@@ -14733,7 +14745,7 @@ class ModifyDBInstanceHAConfigRequest(AbstractModel):
14733
14745
 
14734
14746
  @property
14735
14747
  def DBInstanceId(self):
14736
- """实例ID
14748
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14737
14749
  :rtype: str
14738
14750
  """
14739
14751
  return self._DBInstanceId
@@ -14745,8 +14757,8 @@ class ModifyDBInstanceHAConfigRequest(AbstractModel):
14745
14757
  @property
14746
14758
  def SyncMode(self):
14747
14759
  """主从同步方式:
14748
- <li>Semi-sync:半同步
14749
- <li>Async:异步
14760
+ <li>Semi-sync:半同步</li>
14761
+ <li>Async:异步</li>
14750
14762
 
14751
14763
  :rtype: str
14752
14764
  """
@@ -14759,8 +14771,8 @@ class ModifyDBInstanceHAConfigRequest(AbstractModel):
14759
14771
  @property
14760
14772
  def MaxStandbyLatency(self):
14761
14773
  """高可用备机最大延迟数据量。备节点延迟数据量小于等于该值,且备节点延迟时间小于等于MaxStandbyLag时,可以切换为主节点。
14762
- <li>单位:byte
14763
- <li>参数范围:[1073741824, 322122547200]
14774
+ <li>单位:byte</li>
14775
+ <li>参数范围:[1073741824, 322122547200]</li>
14764
14776
  :rtype: int
14765
14777
  """
14766
14778
  return self._MaxStandbyLatency
@@ -14772,8 +14784,8 @@ class ModifyDBInstanceHAConfigRequest(AbstractModel):
14772
14784
  @property
14773
14785
  def MaxStandbyLag(self):
14774
14786
  """高可用备机最大延迟时间。备节点延迟时间小于等于该值,且备节点延迟数据量小于等于MaxStandbyLatency时,可以切换为主节点。
14775
- <li>单位:s
14776
- <li>参数范围:[5, 10]
14787
+ <li>单位:s</li>
14788
+ <li>参数范围:[5, 10]</li>
14777
14789
  :rtype: int
14778
14790
  """
14779
14791
  return self._MaxStandbyLag
@@ -14863,9 +14875,9 @@ class ModifyDBInstanceNameRequest(AbstractModel):
14863
14875
 
14864
14876
  def __init__(self):
14865
14877
  r"""
14866
- :param _DBInstanceId: 数据库实例ID,形如postgres-6fego161
14878
+ :param _DBInstanceId: 数据库实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14867
14879
  :type DBInstanceId: str
14868
- :param _InstanceName: 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"
14880
+ :param _InstanceName: 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-"。
14869
14881
 
14870
14882
  :type InstanceName: str
14871
14883
  """
@@ -14874,7 +14886,7 @@ class ModifyDBInstanceNameRequest(AbstractModel):
14874
14886
 
14875
14887
  @property
14876
14888
  def DBInstanceId(self):
14877
- """数据库实例ID,形如postgres-6fego161
14889
+ """数据库实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14878
14890
  :rtype: str
14879
14891
  """
14880
14892
  return self._DBInstanceId
@@ -14885,7 +14897,7 @@ class ModifyDBInstanceNameRequest(AbstractModel):
14885
14897
 
14886
14898
  @property
14887
14899
  def InstanceName(self):
14888
- """实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"
14900
+ """实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-"。
14889
14901
 
14890
14902
  :rtype: str
14891
14903
  """
@@ -14944,7 +14956,7 @@ class ModifyDBInstanceParametersRequest(AbstractModel):
14944
14956
 
14945
14957
  def __init__(self):
14946
14958
  r"""
14947
- :param _DBInstanceId: 实例ID
14959
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14948
14960
  :type DBInstanceId: str
14949
14961
  :param _ParamList: 待修改参数及期望值。
14950
14962
  :type ParamList: list of ParamEntry
@@ -14954,7 +14966,7 @@ class ModifyDBInstanceParametersRequest(AbstractModel):
14954
14966
 
14955
14967
  @property
14956
14968
  def DBInstanceId(self):
14957
- """实例ID
14969
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
14958
14970
  :rtype: str
14959
14971
  """
14960
14972
  return self._DBInstanceId
@@ -15028,7 +15040,7 @@ class ModifyDBInstanceReadOnlyGroupRequest(AbstractModel):
15028
15040
 
15029
15041
  def __init__(self):
15030
15042
  r"""
15031
- :param _DBInstanceId: 实例ID
15043
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15032
15044
  :type DBInstanceId: str
15033
15045
  :param _ReadOnlyGroupId: 当前实例所在只读组ID
15034
15046
  :type ReadOnlyGroupId: str
@@ -15041,7 +15053,7 @@ class ModifyDBInstanceReadOnlyGroupRequest(AbstractModel):
15041
15053
 
15042
15054
  @property
15043
15055
  def DBInstanceId(self):
15044
- """实例ID
15056
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15045
15057
  :rtype: str
15046
15058
  """
15047
15059
  return self._DBInstanceId
@@ -15137,9 +15149,9 @@ class ModifyDBInstanceSSLConfigRequest(AbstractModel):
15137
15149
 
15138
15150
  def __init__(self):
15139
15151
  r"""
15140
- :param _DBInstanceId: 实例 ID
15152
+ :param _DBInstanceId: 实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15141
15153
  :type DBInstanceId: str
15142
- :param _SSLEnabled: 开启或关闭SSL
15154
+ :param _SSLEnabled: 开启或关闭SSL。true - 开启 ;false - 关闭。
15143
15155
  :type SSLEnabled: bool
15144
15156
  :param _ConnectAddress: SSL证书保护的唯一连接地址,若为主实例,可设置为内外网IP地址;若为只读实例,可设置为实例IP或只读组IP。在开启SSL或修改SSL保护的连接地址时,该参数为必传项;在关闭SSL时,该参数将被忽略。
15145
15157
  :type ConnectAddress: str
@@ -15150,7 +15162,7 @@ class ModifyDBInstanceSSLConfigRequest(AbstractModel):
15150
15162
 
15151
15163
  @property
15152
15164
  def DBInstanceId(self):
15153
- """实例 ID
15165
+ """实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15154
15166
  :rtype: str
15155
15167
  """
15156
15168
  return self._DBInstanceId
@@ -15161,7 +15173,7 @@ class ModifyDBInstanceSSLConfigRequest(AbstractModel):
15161
15173
 
15162
15174
  @property
15163
15175
  def SSLEnabled(self):
15164
- """开启或关闭SSL
15176
+ """开启或关闭SSL。true - 开启 ;false - 关闭。
15165
15177
  :rtype: bool
15166
15178
  """
15167
15179
  return self._SSLEnabled
@@ -15344,11 +15356,11 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
15344
15356
 
15345
15357
  def __init__(self):
15346
15358
  r"""
15347
- :param _DBInstanceId: 实例ID,形如:postgres-6bwgamo3
15359
+ :param _DBInstanceId: 实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15348
15360
  :type DBInstanceId: str
15349
15361
  :param _Memory: 修改后的实例内存大小,单位GiB。
15350
15362
  :type Memory: int
15351
- :param _Storage: 修改后的实例磁盘大小,单位GiB。
15363
+ :param _Storage: 修改后的实例磁盘大小,单位GiB。该参数的设置步长为10
15352
15364
  :type Storage: int
15353
15365
  :param _AutoVoucher: 是否自动使用代金券:
15354
15366
  <li>0:否</li>
@@ -15369,7 +15381,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
15369
15381
  :type SwitchStartTime: str
15370
15382
  :param _SwitchEndTime: 切换截止时间,时间格式:HH:MM:SS,例如:01:30:00。当SwitchTag为0或2时,该参数失效。
15371
15383
  :type SwitchEndTime: str
15372
- :param _Cpu: 修改后的实例CPU大小,单位Core。
15384
+ :param _Cpu: 修改后的实例CPU大小,单位Core。不填写该参数时,默认根据Memory确定Cpu大小。如Memory为2,支持的规格有1核2GiB,则不传入Cpu时,Cpu默认为1
15373
15385
  :type Cpu: int
15374
15386
  """
15375
15387
  self._DBInstanceId = None
@@ -15385,7 +15397,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
15385
15397
 
15386
15398
  @property
15387
15399
  def DBInstanceId(self):
15388
- """实例ID,形如:postgres-6bwgamo3
15400
+ """实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15389
15401
  :rtype: str
15390
15402
  """
15391
15403
  return self._DBInstanceId
@@ -15407,7 +15419,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
15407
15419
 
15408
15420
  @property
15409
15421
  def Storage(self):
15410
- """修改后的实例磁盘大小,单位GiB。
15422
+ """修改后的实例磁盘大小,单位GiB。该参数的设置步长为10
15411
15423
  :rtype: int
15412
15424
  """
15413
15425
  return self._Storage
@@ -15491,7 +15503,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
15491
15503
 
15492
15504
  @property
15493
15505
  def Cpu(self):
15494
- """修改后的实例CPU大小,单位Core。
15506
+ """修改后的实例CPU大小,单位Core。不填写该参数时,默认根据Memory确定Cpu大小。如Memory为2,支持的规格有1核2GiB,则不传入Cpu时,Cpu默认为1
15495
15507
  :rtype: int
15496
15508
  """
15497
15509
  return self._Cpu
@@ -15587,9 +15599,9 @@ class ModifyDBInstancesProjectRequest(AbstractModel):
15587
15599
 
15588
15600
  def __init__(self):
15589
15601
  r"""
15590
- :param _DBInstanceIdSet: 实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
15602
+ :param _DBInstanceIdSet: 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时操作多个实例。
15591
15603
  :type DBInstanceIdSet: list of str
15592
- :param _ProjectId: 所属新项目的ID
15604
+ :param _ProjectId: 所属新项目的ID。可通过[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)获取
15593
15605
  :type ProjectId: str
15594
15606
  """
15595
15607
  self._DBInstanceIdSet = None
@@ -15597,7 +15609,7 @@ class ModifyDBInstancesProjectRequest(AbstractModel):
15597
15609
 
15598
15610
  @property
15599
15611
  def DBInstanceIdSet(self):
15600
- """实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
15612
+ """实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时操作多个实例。
15601
15613
  :rtype: list of str
15602
15614
  """
15603
15615
  return self._DBInstanceIdSet
@@ -15608,7 +15620,7 @@ class ModifyDBInstancesProjectRequest(AbstractModel):
15608
15620
 
15609
15621
  @property
15610
15622
  def ProjectId(self):
15611
- """所属新项目的ID
15623
+ """所属新项目的ID。可通过[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)获取
15612
15624
  :rtype: str
15613
15625
  """
15614
15626
  return self._ProjectId
@@ -15681,11 +15693,11 @@ class ModifyDatabaseOwnerRequest(AbstractModel):
15681
15693
 
15682
15694
  def __init__(self):
15683
15695
  r"""
15684
- :param _DBInstanceId: 实例ID
15696
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15685
15697
  :type DBInstanceId: str
15686
- :param _DatabaseName: 数据库名称
15698
+ :param _DatabaseName: 数据库名称。可通过[DescribeDatabases](https://cloud.tencent.com/document/api/409/43353)接口获取
15687
15699
  :type DatabaseName: str
15688
- :param _DatabaseOwner: 数据库新所有者
15700
+ :param _DatabaseOwner: 数据库新所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
15689
15701
  :type DatabaseOwner: str
15690
15702
  """
15691
15703
  self._DBInstanceId = None
@@ -15694,7 +15706,7 @@ class ModifyDatabaseOwnerRequest(AbstractModel):
15694
15706
 
15695
15707
  @property
15696
15708
  def DBInstanceId(self):
15697
- """实例ID
15709
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15698
15710
  :rtype: str
15699
15711
  """
15700
15712
  return self._DBInstanceId
@@ -15705,7 +15717,7 @@ class ModifyDatabaseOwnerRequest(AbstractModel):
15705
15717
 
15706
15718
  @property
15707
15719
  def DatabaseName(self):
15708
- """数据库名称
15720
+ """数据库名称。可通过[DescribeDatabases](https://cloud.tencent.com/document/api/409/43353)接口获取
15709
15721
  :rtype: str
15710
15722
  """
15711
15723
  return self._DatabaseName
@@ -15716,7 +15728,7 @@ class ModifyDatabaseOwnerRequest(AbstractModel):
15716
15728
 
15717
15729
  @property
15718
15730
  def DatabaseOwner(self):
15719
- """数据库新所有者
15731
+ """数据库新所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
15720
15732
  :rtype: str
15721
15733
  """
15722
15734
  return self._DatabaseOwner
@@ -15775,11 +15787,11 @@ class ModifyMaintainTimeWindowRequest(AbstractModel):
15775
15787
 
15776
15788
  def __init__(self):
15777
15789
  r"""
15778
- :param _DBInstanceId: 实例ID
15790
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15779
15791
  :type DBInstanceId: str
15780
15792
  :param _MaintainStartTime: 维护开始时间。时区为东八区(UTC+8)
15781
15793
  :type MaintainStartTime: str
15782
- :param _MaintainDuration: 维护持续时间。单位:小时
15794
+ :param _MaintainDuration: 维护持续时间。单位:小时。取值范围:[1,4]
15783
15795
  :type MaintainDuration: int
15784
15796
  :param _MaintainWeekDays: 维护周期
15785
15797
  :type MaintainWeekDays: list of str
@@ -15791,7 +15803,7 @@ class ModifyMaintainTimeWindowRequest(AbstractModel):
15791
15803
 
15792
15804
  @property
15793
15805
  def DBInstanceId(self):
15794
- """实例ID
15806
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
15795
15807
  :rtype: str
15796
15808
  """
15797
15809
  return self._DBInstanceId
@@ -15813,7 +15825,7 @@ class ModifyMaintainTimeWindowRequest(AbstractModel):
15813
15825
 
15814
15826
  @property
15815
15827
  def MaintainDuration(self):
15816
- """维护持续时间。单位:小时
15828
+ """维护持续时间。单位:小时。取值范围:[1,4]
15817
15829
  :rtype: int
15818
15830
  """
15819
15831
  return self._MaintainDuration
@@ -15884,7 +15896,7 @@ class ModifyParameterTemplateRequest(AbstractModel):
15884
15896
 
15885
15897
  def __init__(self):
15886
15898
  r"""
15887
- :param _TemplateId: 参数模板ID,用于唯一确认参数模板,不可修改
15899
+ :param _TemplateId: 参数模板ID,用于唯一确认参数模板,不可修改。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
15888
15900
  :type TemplateId: str
15889
15901
  :param _TemplateName: 参数模板名称,长度为1~60个字符,仅支持数字,英文大小写字母、中文以及特殊字符_-./()()[]+=::@ 注:若该字段为空 ,则保持原参数模板名称
15890
15902
  :type TemplateName: str
@@ -15903,7 +15915,7 @@ class ModifyParameterTemplateRequest(AbstractModel):
15903
15915
 
15904
15916
  @property
15905
15917
  def TemplateId(self):
15906
- """参数模板ID,用于唯一确认参数模板,不可修改
15918
+ """参数模板ID,用于唯一确认参数模板,不可修改。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
15907
15919
  :rtype: str
15908
15920
  """
15909
15921
  return self._TemplateId
@@ -16081,9 +16093,9 @@ class ModifyReadOnlyDBInstanceWeightRequest(AbstractModel):
16081
16093
 
16082
16094
  def __init__(self):
16083
16095
  r"""
16084
- :param _DBInstanceId: 实例ID
16096
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
16085
16097
  :type DBInstanceId: str
16086
- :param _ReadOnlyGroupId: 只读组ID
16098
+ :param _ReadOnlyGroupId: 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
16087
16099
  :type ReadOnlyGroupId: str
16088
16100
  :param _Weight: 只读实例在只读组中的流量权重(1-50)
16089
16101
  :type Weight: int
@@ -16094,7 +16106,7 @@ class ModifyReadOnlyDBInstanceWeightRequest(AbstractModel):
16094
16106
 
16095
16107
  @property
16096
16108
  def DBInstanceId(self):
16097
- """实例ID
16109
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
16098
16110
  :rtype: str
16099
16111
  """
16100
16112
  return self._DBInstanceId
@@ -16105,7 +16117,7 @@ class ModifyReadOnlyDBInstanceWeightRequest(AbstractModel):
16105
16117
 
16106
16118
  @property
16107
16119
  def ReadOnlyGroupId(self):
16108
- """只读组ID
16120
+ """只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
16109
16121
  :rtype: str
16110
16122
  """
16111
16123
  return self._ReadOnlyGroupId
@@ -16175,21 +16187,21 @@ class ModifyReadOnlyGroupConfigRequest(AbstractModel):
16175
16187
 
16176
16188
  def __init__(self):
16177
16189
  r"""
16178
- :param _ReadOnlyGroupId: 只读组ID
16190
+ :param _ReadOnlyGroupId: 只读组ID
16179
16191
  :type ReadOnlyGroupId: str
16180
- :param _ReadOnlyGroupName: 只读组名称
16192
+ :param _ReadOnlyGroupName: 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"
16181
16193
  :type ReadOnlyGroupName: str
16182
16194
  :param _ReplayLagEliminate: 延迟时间配置开关:0关、1开
16183
16195
  :type ReplayLagEliminate: int
16184
16196
  :param _ReplayLatencyEliminate: 延迟日志大小配置开关:0关、1开
16185
16197
  :type ReplayLatencyEliminate: int
16186
- :param _MaxReplayLatency: 延迟日志大小阈值,单位MB
16198
+ :param _MaxReplayLatency: 延迟日志大小阈值,单位MB。当开启延迟日志大小配置,应输入正整数
16187
16199
  :type MaxReplayLatency: int
16188
- :param _MaxReplayLag: 延迟时间大小阈值,单位ms
16200
+ :param _MaxReplayLag: 延迟时间大小阈值,单位s。当开启延迟时间配置时,应输入正整数。
16189
16201
  :type MaxReplayLag: int
16190
16202
  :param _Rebalance: 自动负载均衡开关:0关、1开
16191
16203
  :type Rebalance: int
16192
- :param _MinDelayEliminateReserve: 延迟剔除最小保留实例数
16204
+ :param _MinDelayEliminateReserve: 延迟剔除最小保留实例数。取值范围[0,100]
16193
16205
  :type MinDelayEliminateReserve: int
16194
16206
  """
16195
16207
  self._ReadOnlyGroupId = None
@@ -16203,7 +16215,7 @@ class ModifyReadOnlyGroupConfigRequest(AbstractModel):
16203
16215
 
16204
16216
  @property
16205
16217
  def ReadOnlyGroupId(self):
16206
- """只读组ID
16218
+ """只读组ID
16207
16219
  :rtype: str
16208
16220
  """
16209
16221
  return self._ReadOnlyGroupId
@@ -16214,7 +16226,7 @@ class ModifyReadOnlyGroupConfigRequest(AbstractModel):
16214
16226
 
16215
16227
  @property
16216
16228
  def ReadOnlyGroupName(self):
16217
- """只读组名称
16229
+ """只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"
16218
16230
  :rtype: str
16219
16231
  """
16220
16232
  return self._ReadOnlyGroupName
@@ -16247,7 +16259,7 @@ class ModifyReadOnlyGroupConfigRequest(AbstractModel):
16247
16259
 
16248
16260
  @property
16249
16261
  def MaxReplayLatency(self):
16250
- """延迟日志大小阈值,单位MB
16262
+ """延迟日志大小阈值,单位MB。当开启延迟日志大小配置,应输入正整数
16251
16263
  :rtype: int
16252
16264
  """
16253
16265
  return self._MaxReplayLatency
@@ -16258,7 +16270,7 @@ class ModifyReadOnlyGroupConfigRequest(AbstractModel):
16258
16270
 
16259
16271
  @property
16260
16272
  def MaxReplayLag(self):
16261
- """延迟时间大小阈值,单位ms
16273
+ """延迟时间大小阈值,单位s。当开启延迟时间配置时,应输入正整数。
16262
16274
  :rtype: int
16263
16275
  """
16264
16276
  return self._MaxReplayLag
@@ -16280,7 +16292,7 @@ class ModifyReadOnlyGroupConfigRequest(AbstractModel):
16280
16292
 
16281
16293
  @property
16282
16294
  def MinDelayEliminateReserve(self):
16283
- """延迟剔除最小保留实例数
16295
+ """延迟剔除最小保留实例数。取值范围[0,100]
16284
16296
  :rtype: int
16285
16297
  """
16286
16298
  return self._MinDelayEliminateReserve
@@ -16344,7 +16356,7 @@ class ModifySwitchTimePeriodRequest(AbstractModel):
16344
16356
 
16345
16357
  def __init__(self):
16346
16358
  r"""
16347
- :param _DBInstanceId: 处于等待切换状态中的实例ID
16359
+ :param _DBInstanceId: 处于等待切换状态中的实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
16348
16360
  :type DBInstanceId: str
16349
16361
  :param _SwitchTag: 入参取值为 0 ,代表立即切换。
16350
16362
  :type SwitchTag: int
@@ -16354,7 +16366,7 @@ class ModifySwitchTimePeriodRequest(AbstractModel):
16354
16366
 
16355
16367
  @property
16356
16368
  def DBInstanceId(self):
16357
- """处于等待切换状态中的实例ID
16369
+ """处于等待切换状态中的实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
16358
16370
  :rtype: str
16359
16371
  """
16360
16372
  return self._DBInstanceId
@@ -16810,9 +16822,10 @@ class OpenDBExtranetAccessRequest(AbstractModel):
16810
16822
 
16811
16823
  def __init__(self):
16812
16824
  r"""
16813
- :param _DBInstanceId: 实例ID,形如postgres-hez4fh0v
16825
+ :param _DBInstanceId: 实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。
16814
16826
  :type DBInstanceId: str
16815
16827
  :param _IsIpv6: 是否开通Ipv6外网,1:是,0:否
16828
+ 默认值:0
16816
16829
  :type IsIpv6: int
16817
16830
  """
16818
16831
  self._DBInstanceId = None
@@ -16820,7 +16833,7 @@ class OpenDBExtranetAccessRequest(AbstractModel):
16820
16833
 
16821
16834
  @property
16822
16835
  def DBInstanceId(self):
16823
- """实例ID,形如postgres-hez4fh0v
16836
+ """实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。
16824
16837
  :rtype: str
16825
16838
  """
16826
16839
  return self._DBInstanceId
@@ -16832,6 +16845,7 @@ class OpenDBExtranetAccessRequest(AbstractModel):
16832
16845
  @property
16833
16846
  def IsIpv6(self):
16834
16847
  """是否开通Ipv6外网,1:是,0:否
16848
+ 默认值:0
16835
16849
  :rtype: int
16836
16850
  """
16837
16851
  return self._IsIpv6
@@ -18276,14 +18290,14 @@ class RebalanceReadOnlyGroupRequest(AbstractModel):
18276
18290
 
18277
18291
  def __init__(self):
18278
18292
  r"""
18279
- :param _ReadOnlyGroupId: 只读组ID
18293
+ :param _ReadOnlyGroupId: 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
18280
18294
  :type ReadOnlyGroupId: str
18281
18295
  """
18282
18296
  self._ReadOnlyGroupId = None
18283
18297
 
18284
18298
  @property
18285
18299
  def ReadOnlyGroupId(self):
18286
- """只读组ID
18300
+ """只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
18287
18301
  :rtype: str
18288
18302
  """
18289
18303
  return self._ReadOnlyGroupId
@@ -18436,9 +18450,9 @@ class RemoveDBInstanceFromReadOnlyGroupRequest(AbstractModel):
18436
18450
 
18437
18451
  def __init__(self):
18438
18452
  r"""
18439
- :param _DBInstanceId: 实例ID
18453
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18440
18454
  :type DBInstanceId: str
18441
- :param _ReadOnlyGroupId: 只读组ID
18455
+ :param _ReadOnlyGroupId: 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
18442
18456
  :type ReadOnlyGroupId: str
18443
18457
  """
18444
18458
  self._DBInstanceId = None
@@ -18446,7 +18460,7 @@ class RemoveDBInstanceFromReadOnlyGroupRequest(AbstractModel):
18446
18460
 
18447
18461
  @property
18448
18462
  def DBInstanceId(self):
18449
- """实例ID
18463
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18450
18464
  :rtype: str
18451
18465
  """
18452
18466
  return self._DBInstanceId
@@ -18457,7 +18471,7 @@ class RemoveDBInstanceFromReadOnlyGroupRequest(AbstractModel):
18457
18471
 
18458
18472
  @property
18459
18473
  def ReadOnlyGroupId(self):
18460
- """只读组ID
18474
+ """只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
18461
18475
  :rtype: str
18462
18476
  """
18463
18477
  return self._ReadOnlyGroupId
@@ -18530,11 +18544,10 @@ class RenewInstanceRequest(AbstractModel):
18530
18544
 
18531
18545
  def __init__(self):
18532
18546
  r"""
18533
- :param _DBInstanceId: 实例ID,形如postgres-6fego161
18547
+ :param _DBInstanceId: 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)实例。
18534
18548
  :type DBInstanceId: str
18535
18549
  :param _Period: 购买时长,单位:月。
18536
18550
  <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
18537
- <li>后付费:只支持1</li>
18538
18551
  :type Period: int
18539
18552
  :param _AutoVoucher: 是否自动使用代金券:
18540
18553
  <li>0:否</li>
@@ -18551,7 +18564,7 @@ class RenewInstanceRequest(AbstractModel):
18551
18564
 
18552
18565
  @property
18553
18566
  def DBInstanceId(self):
18554
- """实例ID,形如postgres-6fego161
18567
+ """实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)实例。
18555
18568
  :rtype: str
18556
18569
  """
18557
18570
  return self._DBInstanceId
@@ -18564,7 +18577,6 @@ class RenewInstanceRequest(AbstractModel):
18564
18577
  def Period(self):
18565
18578
  """购买时长,单位:月。
18566
18579
  <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
18567
- <li>后付费:只支持1</li>
18568
18580
  :rtype: int
18569
18581
  """
18570
18582
  return self._Period
@@ -18664,11 +18676,19 @@ class ResetAccountPasswordRequest(AbstractModel):
18664
18676
 
18665
18677
  def __init__(self):
18666
18678
  r"""
18667
- :param _DBInstanceId: 实例ID,形如postgres-4wdeb0zv
18679
+ :param _DBInstanceId: 实例ID,形如postgres-4wdeb0zv。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18668
18680
  :type DBInstanceId: str
18669
- :param _UserName: 实例账户名
18681
+ :param _UserName: 实例账户名。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
18670
18682
  :type UserName: str
18671
- :param _Password: UserName账户对应的新密码
18683
+ :param _Password: UserName账户对应的新密码。
18684
+ 密码设置规则如下:
18685
+ - 长度8~ 32位,推荐使用12位以上的密码
18686
+ - 不能以" / "开头
18687
+ - 必须包含以下四项:
18688
+ 1. 小写字母a ~ z
18689
+ 2. 大写字母 A ~ Z
18690
+ 3. 数字 0 ~ 9
18691
+ 4. 特殊字符 ()`~!@#$%^&*-+=_|{}[]:<>,.?/
18672
18692
  :type Password: str
18673
18693
  """
18674
18694
  self._DBInstanceId = None
@@ -18677,7 +18697,7 @@ class ResetAccountPasswordRequest(AbstractModel):
18677
18697
 
18678
18698
  @property
18679
18699
  def DBInstanceId(self):
18680
- """实例ID,形如postgres-4wdeb0zv
18700
+ """实例ID,形如postgres-4wdeb0zv。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18681
18701
  :rtype: str
18682
18702
  """
18683
18703
  return self._DBInstanceId
@@ -18688,7 +18708,7 @@ class ResetAccountPasswordRequest(AbstractModel):
18688
18708
 
18689
18709
  @property
18690
18710
  def UserName(self):
18691
- """实例账户名
18711
+ """实例账户名。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
18692
18712
  :rtype: str
18693
18713
  """
18694
18714
  return self._UserName
@@ -18699,7 +18719,15 @@ class ResetAccountPasswordRequest(AbstractModel):
18699
18719
 
18700
18720
  @property
18701
18721
  def Password(self):
18702
- """UserName账户对应的新密码
18722
+ """UserName账户对应的新密码。
18723
+ 密码设置规则如下:
18724
+ - 长度8~ 32位,推荐使用12位以上的密码
18725
+ - 不能以" / "开头
18726
+ - 必须包含以下四项:
18727
+ 1. 小写字母a ~ z
18728
+ 2. 大写字母 A ~ Z
18729
+ 3. 数字 0 ~ 9
18730
+ 4. 特殊字符 ()`~!@#$%^&*-+=_|{}[]:<>,.?/
18703
18731
  :rtype: str
18704
18732
  """
18705
18733
  return self._Password
@@ -18758,14 +18786,14 @@ class RestartDBInstanceRequest(AbstractModel):
18758
18786
 
18759
18787
  def __init__(self):
18760
18788
  r"""
18761
- :param _DBInstanceId: 实例ID,形如postgres-6r233v55
18789
+ :param _DBInstanceId: 实例ID,形如postgres-6r233v55。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18762
18790
  :type DBInstanceId: str
18763
18791
  """
18764
18792
  self._DBInstanceId = None
18765
18793
 
18766
18794
  @property
18767
18795
  def DBInstanceId(self):
18768
- """实例ID,形如postgres-6r233v55
18796
+ """实例ID,形如postgres-6r233v55。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18769
18797
  :rtype: str
18770
18798
  """
18771
18799
  return self._DBInstanceId
@@ -18837,11 +18865,11 @@ class RestoreDBInstanceObjectsRequest(AbstractModel):
18837
18865
 
18838
18866
  def __init__(self):
18839
18867
  r"""
18840
- :param _DBInstanceId: 实例ID
18868
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18841
18869
  :type DBInstanceId: str
18842
18870
  :param _RestoreObjects: 需要恢复的对象列表。假设需要恢复的对象名为user,则恢复后的名称为user_bak_${LinuxTime}。${LinuxTime}无法指定,由系统根据任务发起的linux时间设定。
18843
18871
  :type RestoreObjects: list of str
18844
- :param _BackupSetId: 恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。
18872
+ :param _BackupSetId: 恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取
18845
18873
  :type BackupSetId: str
18846
18874
  :param _RestoreTargetTime: 恢复目标时间,北京时间。BackupSetId与RestoreTargetTime有且只能传一个。
18847
18875
  :type RestoreTargetTime: str
@@ -18853,7 +18881,7 @@ class RestoreDBInstanceObjectsRequest(AbstractModel):
18853
18881
 
18854
18882
  @property
18855
18883
  def DBInstanceId(self):
18856
- """实例ID
18884
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
18857
18885
  :rtype: str
18858
18886
  """
18859
18887
  return self._DBInstanceId
@@ -18875,7 +18903,7 @@ class RestoreDBInstanceObjectsRequest(AbstractModel):
18875
18903
 
18876
18904
  @property
18877
18905
  def BackupSetId(self):
18878
- """恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。
18906
+ """恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取
18879
18907
  :rtype: str
18880
18908
  """
18881
18909
  return self._BackupSetId
@@ -19535,7 +19563,7 @@ class SetAutoRenewFlagRequest(AbstractModel):
19535
19563
 
19536
19564
  def __init__(self):
19537
19565
  r"""
19538
- :param _DBInstanceIdSet: 实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
19566
+ :param _DBInstanceIdSet: 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)的实例。支持同时操作多个实例。
19539
19567
  :type DBInstanceIdSet: list of str
19540
19568
  :param _AutoRenewFlag: 续费标记。0-正常续费;1-自动续费;2-到期不续费
19541
19569
  :type AutoRenewFlag: int
@@ -19545,7 +19573,7 @@ class SetAutoRenewFlagRequest(AbstractModel):
19545
19573
 
19546
19574
  @property
19547
19575
  def DBInstanceIdSet(self):
19548
- """实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
19576
+ """实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)的实例。支持同时操作多个实例。
19549
19577
  :rtype: list of str
19550
19578
  """
19551
19579
  return self._DBInstanceIdSet
@@ -20002,16 +20030,16 @@ class SwitchDBInstancePrimaryRequest(AbstractModel):
20002
20030
 
20003
20031
  def __init__(self):
20004
20032
  r"""
20005
- :param _DBInstanceId: 实例ID
20033
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
20006
20034
  :type DBInstanceId: str
20007
20035
  :param _Force: 是否强制切换。强制切换时只要备节点可访问,无论主备延迟多大都会发起切换。只有SwitchTag为0时,才可使用立即切换。
20008
- <li>默认:false
20036
+ <li>默认:false</li>
20009
20037
  :type Force: bool
20010
20038
  :param _SwitchTag: 指定实例配置完成变更后的切换时间。
20011
- <li>0:立即切换
20012
- <li>1:指定时间切换
20013
- <li>2:维护时间窗口内切换
20014
- <li>默认值:0
20039
+ <li>0:立即切换 </li>
20040
+ <li>1:指定时间切换</li>
20041
+ <li>2:维护时间窗口内切换</li>
20042
+ 默认值:0
20015
20043
  :type SwitchTag: int
20016
20044
  :param _SwitchStartTime: 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。当SwitchTag为0或2时,该参数失效。
20017
20045
  :type SwitchStartTime: str
@@ -20026,7 +20054,7 @@ class SwitchDBInstancePrimaryRequest(AbstractModel):
20026
20054
 
20027
20055
  @property
20028
20056
  def DBInstanceId(self):
20029
- """实例ID
20057
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
20030
20058
  :rtype: str
20031
20059
  """
20032
20060
  return self._DBInstanceId
@@ -20038,7 +20066,7 @@ class SwitchDBInstancePrimaryRequest(AbstractModel):
20038
20066
  @property
20039
20067
  def Force(self):
20040
20068
  """是否强制切换。强制切换时只要备节点可访问,无论主备延迟多大都会发起切换。只有SwitchTag为0时,才可使用立即切换。
20041
- <li>默认:false
20069
+ <li>默认:false</li>
20042
20070
  :rtype: bool
20043
20071
  """
20044
20072
  return self._Force
@@ -20050,10 +20078,10 @@ class SwitchDBInstancePrimaryRequest(AbstractModel):
20050
20078
  @property
20051
20079
  def SwitchTag(self):
20052
20080
  """指定实例配置完成变更后的切换时间。
20053
- <li>0:立即切换
20054
- <li>1:指定时间切换
20055
- <li>2:维护时间窗口内切换
20056
- <li>默认值:0
20081
+ <li>0:立即切换 </li>
20082
+ <li>1:指定时间切换</li>
20083
+ <li>2:维护时间窗口内切换</li>
20084
+ 默认值:0
20057
20085
  :rtype: int
20058
20086
  """
20059
20087
  return self._SwitchTag
@@ -20543,15 +20571,15 @@ class UpgradeDBInstanceKernelVersionRequest(AbstractModel):
20543
20571
 
20544
20572
  def __init__(self):
20545
20573
  r"""
20546
- :param _DBInstanceId: 实例ID
20574
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
20547
20575
  :type DBInstanceId: str
20548
20576
  :param _TargetDBKernelVersion: 升级的目标内核版本号。可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)的返回字段AvailableUpgradeTarget获取。
20549
20577
 
20550
20578
  :type TargetDBKernelVersion: str
20551
20579
  :param _SwitchTag: 指定实例升级内核版本号完成后的切换时间。可选值:
20552
- <li>0:立即切换
20553
- <li>1:指定时间切换
20554
- <li>2:维护时间窗口内切换
20580
+ <li>0:立即切换</li>
20581
+ <li>1:指定时间切换</li>
20582
+ <li>2:维护时间窗口内切换</li>
20555
20583
  默认值:0
20556
20584
  :type SwitchTag: int
20557
20585
  :param _SwitchStartTime: 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。当SwitchTag为0或2时,该参数失效。
@@ -20559,8 +20587,8 @@ class UpgradeDBInstanceKernelVersionRequest(AbstractModel):
20559
20587
  :param _SwitchEndTime: 切换截止时间,时间格式:HH:MM:SS,例如:01:30:00。当SwitchTag为0或2时,该参数失效。SwitchStartTime和SwitchEndTime时间窗口不能小于30分钟。
20560
20588
  :type SwitchEndTime: str
20561
20589
  :param _DryRun: 是否对本次升级实例内核版本号操作执行预检查。
20562
- <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
20563
- <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。
20590
+ <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。</li>
20591
+ <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。</li>
20564
20592
  默认值:false
20565
20593
  :type DryRun: bool
20566
20594
  """
@@ -20573,7 +20601,7 @@ class UpgradeDBInstanceKernelVersionRequest(AbstractModel):
20573
20601
 
20574
20602
  @property
20575
20603
  def DBInstanceId(self):
20576
- """实例ID
20604
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
20577
20605
  :rtype: str
20578
20606
  """
20579
20607
  return self._DBInstanceId
@@ -20597,9 +20625,9 @@ class UpgradeDBInstanceKernelVersionRequest(AbstractModel):
20597
20625
  @property
20598
20626
  def SwitchTag(self):
20599
20627
  """指定实例升级内核版本号完成后的切换时间。可选值:
20600
- <li>0:立即切换
20601
- <li>1:指定时间切换
20602
- <li>2:维护时间窗口内切换
20628
+ <li>0:立即切换</li>
20629
+ <li>1:指定时间切换</li>
20630
+ <li>2:维护时间窗口内切换</li>
20603
20631
  默认值:0
20604
20632
  :rtype: int
20605
20633
  """
@@ -20634,8 +20662,8 @@ class UpgradeDBInstanceKernelVersionRequest(AbstractModel):
20634
20662
  @property
20635
20663
  def DryRun(self):
20636
20664
  """是否对本次升级实例内核版本号操作执行预检查。
20637
- <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
20638
- <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。
20665
+ <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。</li>
20666
+ <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。</li>
20639
20667
  默认值:false
20640
20668
  :rtype: bool
20641
20669
  """
@@ -20698,9 +20726,9 @@ class UpgradeDBInstanceMajorVersionRequest(AbstractModel):
20698
20726
 
20699
20727
  def __init__(self):
20700
20728
  r"""
20701
- :param _DBInstanceId: 实例ID
20729
+ :param _DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
20702
20730
  :type DBInstanceId: str
20703
- :param _TargetDBKernelVersion: 目标内核版本号,可以通过API DescribeDBVersions获取可以升级的目标内核版本号。
20731
+ :param _TargetDBKernelVersion: 目标内核版本号,可以通过API [DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取可以升级的目标内核版本号。
20704
20732
  :type TargetDBKernelVersion: str
20705
20733
  :param _UpgradeCheck: 是否为校验模式,若UpgradeCheck为True,表示仅进行内核版本兼容性检查,不会进行实质性的升级操作,对原实例无影响。检查结果可以通过升级日志查看。
20706
20734
  :type UpgradeCheck: bool
@@ -20743,7 +20771,7 @@ UpgradeCheck为True时,此参数无效。
20743
20771
 
20744
20772
  @property
20745
20773
  def DBInstanceId(self):
20746
- """实例ID
20774
+ """实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
20747
20775
  :rtype: str
20748
20776
  """
20749
20777
  return self._DBInstanceId
@@ -20754,7 +20782,7 @@ UpgradeCheck为True时,此参数无效。
20754
20782
 
20755
20783
  @property
20756
20784
  def TargetDBKernelVersion(self):
20757
- """目标内核版本号,可以通过API DescribeDBVersions获取可以升级的目标内核版本号。
20785
+ """目标内核版本号,可以通过API [DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取可以升级的目标内核版本号。
20758
20786
  :rtype: str
20759
20787
  """
20760
20788
  return self._TargetDBKernelVersion