tencentcloud-sdk-nodejs 4.1.84 → 4.1.86

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/es/common/sdk_version.js +1 -1
  2. package/es/services/index.js +1 -0
  3. package/es/services/ocr/v20181119/ocr_client.js +3 -0
  4. package/es/services/wedata/v20210820/wedata_client.js +28 -4
  5. package/es/services/wsa/index.js +4 -0
  6. package/es/services/wsa/v20250508/index.js +6 -0
  7. package/es/services/wsa/v20250508/wsa_client.js +9 -0
  8. package/es/services/wsa/v20250508/wsa_models.js +0 -0
  9. package/package.json +1 -1
  10. package/tencentcloud/common/sdk_version.d.ts +1 -1
  11. package/tencentcloud/common/sdk_version.js +1 -1
  12. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +4 -0
  13. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +6 -6
  14. package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -6
  15. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +90 -78
  16. package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +12 -4
  17. package/tencentcloud/services/cdn/v20180606/cdn_client.js +12 -4
  18. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +1 -1
  19. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +14 -0
  20. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
  21. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +1 -1
  22. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +17 -6
  23. package/tencentcloud/services/gs/v20191118/gs_models.d.ts +15 -2
  24. package/tencentcloud/services/index.d.ts +1 -0
  25. package/tencentcloud/services/index.js +2 -0
  26. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +3 -0
  27. package/tencentcloud/services/lcic/v20220817/lcic_client.js +3 -0
  28. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +5 -5
  29. package/tencentcloud/services/live/v20180801/live_models.d.ts +21 -1
  30. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +9 -1
  31. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +5 -5
  32. package/tencentcloud/services/mps/v20190612/mps_client.js +5 -5
  33. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +251 -76
  34. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +11 -1
  35. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +7 -1
  36. package/tencentcloud/services/ocr/v20181119/ocr_client.js +8 -0
  37. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +106 -64
  38. package/tencentcloud/services/postgres/v20170312/postgres_client.d.ts +9 -9
  39. package/tencentcloud/services/postgres/v20170312/postgres_client.js +9 -9
  40. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +195 -181
  41. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +13 -1
  42. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +94 -1
  43. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +38 -6
  44. package/tencentcloud/services/wedata/v20210820/wedata_client.js +55 -7
  45. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +639 -222
  46. package/tencentcloud/services/wsa/index.d.ts +6 -0
  47. package/tencentcloud/services/wsa/index.js +7 -0
  48. package/tencentcloud/services/wsa/v20250508/index.d.ts +6 -0
  49. package/tencentcloud/services/wsa/v20250508/index.js +10 -0
  50. package/tencentcloud/services/wsa/v20250508/wsa_client.d.ts +14 -0
  51. package/tencentcloud/services/wsa/v20250508/wsa_client.js +37 -0
  52. package/tencentcloud/services/wsa/v20250508/wsa_models.d.ts +46 -0
  53. package/tencentcloud/services/wsa/v20250508/wsa_models.js +18 -0
@@ -40,7 +40,7 @@ export interface TaskDetail {
40
40
  */
41
41
  export interface SetAutoRenewFlagRequest {
42
42
  /**
43
- * 实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
43
+ * 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)的实例。支持同时操作多个实例。
44
44
  */
45
45
  DBInstanceIdSet: Array<string>;
46
46
  /**
@@ -121,7 +121,7 @@ export interface DescribeDBXlogsRequest {
121
121
  */
122
122
  export interface DescribeMaintainTimeWindowRequest {
123
123
  /**
124
- * 实例ID
124
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
125
125
  */
126
126
  DBInstanceId: string;
127
127
  }
@@ -168,11 +168,12 @@ export interface DeleteReadOnlyGroupResponse {
168
168
  */
169
169
  export interface OpenDBExtranetAccessRequest {
170
170
  /**
171
- * 实例ID,形如postgres-hez4fh0v
171
+ * 实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。
172
172
  */
173
173
  DBInstanceId: string;
174
174
  /**
175
175
  * 是否开通Ipv6外网,1:是,0:否
176
+ 默认值:0
176
177
  */
177
178
  IsIpv6?: number;
178
179
  }
@@ -190,7 +191,7 @@ export interface CreateInstancesRequest {
190
191
  */
191
192
  SpecCode: string;
192
193
  /**
193
- * 实例容量大小,单位:GB。
194
+ * 实例磁盘容量大小,单位:GB。该参数的设置步长为10
194
195
  */
195
196
  Storage: number;
196
197
  /**
@@ -280,7 +281,7 @@ export interface CreateInstancesRequest {
280
281
  */
281
282
  VoucherIds?: Array<string>;
282
283
  /**
283
- * 项目ID
284
+ * 项目ID。默认取之为0,表示归属默认项目。
284
285
  */
285
286
  ProjectId?: number;
286
287
  /**
@@ -474,7 +475,7 @@ export interface DescribeAvailableRecoveryTimeResponse {
474
475
  */
475
476
  export interface CreateBaseBackupRequest {
476
477
  /**
477
- * 实例ID
478
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
478
479
  */
479
480
  DBInstanceId: string;
480
481
  }
@@ -559,7 +560,7 @@ export interface BackupPlan {
559
560
  */
560
561
  BackupPeriod?: string;
561
562
  /**
562
- * 数据备份保留时长
563
+ * 数据备份保留时长。单位:天
563
564
  */
564
565
  BaseBackupRetentionPeriod?: number;
565
566
  /**
@@ -579,7 +580,7 @@ export interface BackupPlan {
579
580
  */
580
581
  PlanName?: string;
581
582
  /**
582
- * 日志备份保留时长。
583
+ * 日志备份保留时长。单位:天
583
584
  */
584
585
  LogBackupRetentionPeriod?: number;
585
586
  /**
@@ -630,20 +631,20 @@ export interface SlowlogDetail {
630
631
  */
631
632
  export interface SwitchDBInstancePrimaryRequest {
632
633
  /**
633
- * 实例ID
634
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
634
635
  */
635
636
  DBInstanceId: string;
636
637
  /**
637
638
  * 是否强制切换。强制切换时只要备节点可访问,无论主备延迟多大都会发起切换。只有SwitchTag为0时,才可使用立即切换。
638
- <li>默认:false
639
+ <li>默认:false</li>
639
640
  */
640
641
  Force?: boolean;
641
642
  /**
642
643
  * 指定实例配置完成变更后的切换时间。
643
- <li>0:立即切换
644
- <li>1:指定时间切换
645
- <li>2:维护时间窗口内切换
646
- <li>默认值:0
644
+ <li>0:立即切换 </li>
645
+ <li>1:指定时间切换</li>
646
+ <li>2:维护时间窗口内切换</li>
647
+ 默认值:0
647
648
  */
648
649
  SwitchTag?: number;
649
650
  /**
@@ -682,11 +683,11 @@ export interface DeleteLogBackupResponse {
682
683
  */
683
684
  export interface ModifyReadOnlyGroupConfigRequest {
684
685
  /**
685
- * 只读组ID
686
+ * 只读组ID
686
687
  */
687
688
  ReadOnlyGroupId: string;
688
689
  /**
689
- * 只读组名称
690
+ * 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"
690
691
  */
691
692
  ReadOnlyGroupName?: string;
692
693
  /**
@@ -698,11 +699,11 @@ export interface ModifyReadOnlyGroupConfigRequest {
698
699
  */
699
700
  ReplayLatencyEliminate?: number;
700
701
  /**
701
- * 延迟日志大小阈值,单位MB
702
+ * 延迟日志大小阈值,单位MB。当开启延迟日志大小配置,应输入正整数
702
703
  */
703
704
  MaxReplayLatency?: number;
704
705
  /**
705
- * 延迟时间大小阈值,单位ms
706
+ * 延迟时间大小阈值,单位s。当开启延迟时间配置时,应输入正整数。
706
707
  */
707
708
  MaxReplayLag?: number;
708
709
  /**
@@ -710,7 +711,7 @@ export interface ModifyReadOnlyGroupConfigRequest {
710
711
  */
711
712
  Rebalance?: number;
712
713
  /**
713
- * 延迟剔除最小保留实例数
714
+ * 延迟剔除最小保留实例数。取值范围[0,100]
714
715
  */
715
716
  MinDelayEliminateReserve?: number;
716
717
  }
@@ -760,11 +761,11 @@ export interface BackupSummary {
760
761
  */
761
762
  export interface AddDBInstanceToReadOnlyGroupRequest {
762
763
  /**
763
- * 实例ID
764
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
764
765
  */
765
766
  DBInstanceId: string;
766
767
  /**
767
- * 只读组ID
768
+ * 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
768
769
  */
769
770
  ReadOnlyGroupId: string;
770
771
  }
@@ -789,11 +790,11 @@ export interface DescribeProductConfigRequest {
789
790
  */
790
791
  export interface RemoveDBInstanceFromReadOnlyGroupRequest {
791
792
  /**
792
- * 实例ID
793
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
793
794
  */
794
795
  DBInstanceId: string;
795
796
  /**
796
- * 只读组ID
797
+ * 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
797
798
  */
798
799
  ReadOnlyGroupId: string;
799
800
  }
@@ -869,7 +870,7 @@ export interface DescribeMaintainTimeWindowResponse {
869
870
  */
870
871
  export interface DescribeDefaultParametersRequest {
871
872
  /**
872
- * 数据库版本,大版本号,例如11,12,13
873
+ * 数据库版本,大版本号,例如11,12,13。可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
873
874
  */
874
875
  DBMajorVersion: string;
875
876
  /**
@@ -895,13 +896,12 @@ export interface DescribeDedicatedClustersResponse {
895
896
  */
896
897
  export interface RenewInstanceRequest {
897
898
  /**
898
- * 实例ID,形如postgres-6fego161
899
+ * 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)实例。
899
900
  */
900
901
  DBInstanceId: string;
901
902
  /**
902
903
  * 购买时长,单位:月。
903
904
  <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
904
- <li>后付费:只支持1</li>
905
905
  */
906
906
  Period: number;
907
907
  /**
@@ -960,7 +960,7 @@ export interface UpgradeDBInstanceMajorVersionResponse {
960
960
  */
961
961
  export interface ModifyBackupDownloadRestrictionRequest {
962
962
  /**
963
- * 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
963
+ * 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE时,Vpc限制和Ip限制需要至少填写一项。
964
964
  */
965
965
  RestrictionType: string;
966
966
  /**
@@ -1024,7 +1024,7 @@ export interface DBInstanceNetInfo {
1024
1024
  */
1025
1025
  export interface BackupDownloadRestriction {
1026
1026
  /**
1027
- * 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
1027
+ * 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE 时,vpc或ip信息至少填写一项
1028
1028
  */
1029
1029
  RestrictionType?: string;
1030
1030
  /**
@@ -1049,7 +1049,7 @@ export interface BackupDownloadRestriction {
1049
1049
  */
1050
1050
  export interface ModifyDBInstanceDeploymentRequest {
1051
1051
  /**
1052
- * 实例ID
1052
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1053
1053
  */
1054
1054
  DBInstanceId: string;
1055
1055
  /**
@@ -1062,7 +1062,7 @@ export interface ModifyDBInstanceDeploymentRequest {
1062
1062
  <li>0:立即切换 </li>
1063
1063
  <li>1:指定时间切换</li>
1064
1064
  <li>2:维护时间窗口内切换</li>
1065
- 默认值:0
1065
+
1066
1066
  */
1067
1067
  SwitchTag: number;
1068
1068
  /**
@@ -1138,19 +1138,22 @@ export interface ZoneInfo {
1138
1138
  */
1139
1139
  export interface CreateDatabaseRequest {
1140
1140
  /**
1141
- * 实例ID,形如postgres-6fego161
1141
+ * 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1142
1142
  */
1143
1143
  DBInstanceId: string;
1144
1144
  /**
1145
- * 创建的数据库名
1145
+ * 创建的数据库名。
1146
+ 名称规范:由字母(a-z, A-Z)、数字(0-9)、下划线(_)组成,以字母或(_)开头,最多63个字符。不能使用系统保留关键字,不能为postgres。
1146
1147
  */
1147
1148
  DatabaseName: string;
1148
1149
  /**
1149
- * 数据库的所有者
1150
+ * 数据库的所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
1150
1151
  */
1151
1152
  DatabaseOwner: string;
1152
1153
  /**
1153
- * 数据库的字符编码
1154
+ * 数据库的字符编码。
1155
+ 支持的常用字符集包括:UTF8、LATIN1、LATIN2、WIN1250、WIN1251、WIN1252、KOI8R、EUC_JP、EUC_KR
1156
+ 默认值:UTF8
1154
1157
  */
1155
1158
  Encoding?: string;
1156
1159
  /**
@@ -1338,7 +1341,7 @@ export interface CloneDBInstanceResponse {
1338
1341
  */
1339
1342
  export interface ModifyDBInstanceReadOnlyGroupRequest {
1340
1343
  /**
1341
- * 实例ID
1344
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1342
1345
  */
1343
1346
  DBInstanceId: string;
1344
1347
  /**
@@ -1413,15 +1416,15 @@ export interface BaseBackup {
1413
1416
  */
1414
1417
  Name?: string;
1415
1418
  /**
1416
- * 备份方式:物理备份、逻辑备份。
1419
+ * 备份方式:physical - 物理备份、logical - 逻辑备份。
1417
1420
  */
1418
1421
  BackupMethod?: string;
1419
1422
  /**
1420
- * 备份模式:自动备份、手动备份。
1423
+ * 备份模式:automatic - 自动备份、manual - 手动备份。
1421
1424
  */
1422
1425
  BackupMode?: string;
1423
1426
  /**
1424
- * 备份任务状态。
1427
+ * 备份任务状态。枚举值:init、running、finished、failed、canceled
1425
1428
  */
1426
1429
  State?: string;
1427
1430
  /**
@@ -1467,7 +1470,7 @@ export interface CreateReadOnlyDBInstanceResponse {
1467
1470
  */
1468
1471
  export interface DescribeAvailableRecoveryTimeRequest {
1469
1472
  /**
1470
- * 实例ID
1473
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1471
1474
  */
1472
1475
  DBInstanceId: string;
1473
1476
  }
@@ -1513,7 +1516,7 @@ export interface DescribeTasksRequest {
1513
1516
  */
1514
1517
  export interface DescribeDBInstanceParametersRequest {
1515
1518
  /**
1516
- * 实例ID
1519
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1517
1520
  */
1518
1521
  DBInstanceId: string;
1519
1522
  /**
@@ -1625,7 +1628,7 @@ export interface Version {
1625
1628
  */
1626
1629
  export interface CreateDBInstanceNetworkAccessRequest {
1627
1630
  /**
1628
- * 实例ID,形如:postgres-6bwgamo3
1631
+ * 实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1629
1632
  */
1630
1633
  DBInstanceId: string;
1631
1634
  /**
@@ -1641,7 +1644,7 @@ export interface CreateDBInstanceNetworkAccessRequest {
1641
1644
  */
1642
1645
  IsAssignVip: boolean;
1643
1646
  /**
1644
- * 目标VIP地址。
1647
+ * 目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
1645
1648
  */
1646
1649
  Vip?: string;
1647
1650
  }
@@ -1696,15 +1699,15 @@ export interface TaskSet {
1696
1699
  */
1697
1700
  export interface InquiryPriceCreateDBInstancesRequest {
1698
1701
  /**
1699
- * 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
1702
+ * 可用区名称。该参数可以通过调用[ DescribeZones](https://cloud.tencent.com/document/product/409/16769) 接口的返回值中的Zone字段来获取。
1700
1703
  */
1701
1704
  Zone: string;
1702
1705
  /**
1703
- * 规格ID。该参数可以通过调用DescribeClasses接口的返回值中的SpecCode字段来获取。
1706
+ * 规格ID。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/product/409/89019)接口的返回值中的SpecCode字段来获取。
1704
1707
  */
1705
1708
  SpecCode: string;
1706
1709
  /**
1707
- * 存储容量大小,单位:GB。
1710
+ * 存储容量大小,单位:GB。该参数的设置步长为10
1708
1711
  */
1709
1712
  Storage: number;
1710
1713
  /**
@@ -1720,7 +1723,8 @@ export interface InquiryPriceCreateDBInstancesRequest {
1720
1723
  */
1721
1724
  Pid?: number;
1722
1725
  /**
1723
- * 实例计费类型。目前只支持:PREPAID(预付费,即包年包月)。
1726
+ * 实例计费类型。目前支持:PREPAID(预付费,即包年包月)和 POSTPAID(按量计费)。
1727
+ 默认值:PREPAID
1724
1728
  */
1725
1729
  InstanceChargeType?: string;
1726
1730
  /**
@@ -1908,7 +1912,7 @@ export interface ReadOnlyGroup {
1908
1912
  */
1909
1913
  export interface ModifyDBInstanceSpecRequest {
1910
1914
  /**
1911
- * 实例ID,形如:postgres-6bwgamo3
1915
+ * 实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1912
1916
  */
1913
1917
  DBInstanceId: string;
1914
1918
  /**
@@ -1916,7 +1920,7 @@ export interface ModifyDBInstanceSpecRequest {
1916
1920
  */
1917
1921
  Memory: number;
1918
1922
  /**
1919
- * 修改后的实例磁盘大小,单位GiB。
1923
+ * 修改后的实例磁盘大小,单位GiB。该参数的设置步长为10
1920
1924
  */
1921
1925
  Storage: number;
1922
1926
  /**
@@ -1951,7 +1955,7 @@ export interface ModifyDBInstanceSpecRequest {
1951
1955
  */
1952
1956
  SwitchEndTime?: string;
1953
1957
  /**
1954
- * 修改后的实例CPU大小,单位Core。
1958
+ * 修改后的实例CPU大小,单位Core。不填写该参数时,默认根据Memory确定Cpu大小。如Memory为2,支持的规格有1核2GiB,则不传入Cpu时,Cpu默认为1
1955
1959
  */
1956
1960
  Cpu?: number;
1957
1961
  }
@@ -1994,7 +1998,7 @@ export interface SpecInfo {
1994
1998
  */
1995
1999
  export interface ModifyMaintainTimeWindowRequest {
1996
2000
  /**
1997
- * 实例ID
2001
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1998
2002
  */
1999
2003
  DBInstanceId: string;
2000
2004
  /**
@@ -2002,7 +2006,7 @@ export interface ModifyMaintainTimeWindowRequest {
2002
2006
  */
2003
2007
  MaintainStartTime?: string;
2004
2008
  /**
2005
- * 维护持续时间。单位:小时
2009
+ * 维护持续时间。单位:小时。取值范围:[1,4]
2006
2010
  */
2007
2011
  MaintainDuration?: number;
2008
2012
  /**
@@ -2068,9 +2072,9 @@ export interface DescribeLogBackupsRequest {
2068
2072
  /**
2069
2073
  * 按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:
2070
2074
  db-instance-id:按照实例ID过滤,类型为string。
2071
- db-instance-name:按照实例名过滤,类型为string。
2075
+ db-instance-name:按照实例名过滤,支持模糊匹配,类型为string。
2072
2076
  db-instance-ip:按照实例私有网络IP地址过滤,类型为string。
2073
- db-instance-status:按实例状态过滤,类型为string。取值参考DBInstance结构的DBInstanceStatus字段。
2077
+ db-instance-status:按实例状态过滤,类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。
2074
2078
  */
2075
2079
  Filters?: Array<Filter>;
2076
2080
  /**
@@ -2082,11 +2086,11 @@ export interface DescribeLogBackupsRequest {
2082
2086
  */
2083
2087
  Offset?: number;
2084
2088
  /**
2085
- * 排序字段,支持StartTime,FinishTime,Size
2089
+ * 排序字段,支持StartTime,FinishTime,Size。默认值:StartTime
2086
2090
  */
2087
2091
  OrderBy?: string;
2088
2092
  /**
2089
- * 排序方式,包括升序:asc,降序:desc。
2093
+ * 排序方式,包括升序:asc,降序:desc。默认值:desc
2090
2094
  */
2091
2095
  OrderByType?: string;
2092
2096
  }
@@ -2097,7 +2101,7 @@ export interface SetAutoRenewFlagResponse {
2097
2101
  /**
2098
2102
  * 设置成功的实例个数
2099
2103
  */
2100
- Count: number;
2104
+ Count?: number;
2101
2105
  /**
2102
2106
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2103
2107
  */
@@ -2162,7 +2166,7 @@ export interface NetworkAccess {
2162
2166
  */
2163
2167
  export interface CreateBackupPlanRequest {
2164
2168
  /**
2165
- * 实例ID
2169
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2166
2170
  */
2167
2171
  DBInstanceId: string;
2168
2172
  /**
@@ -2186,7 +2190,8 @@ export interface CreateBackupPlanRequest {
2186
2190
  */
2187
2191
  MaxBackupStartTime?: string;
2188
2192
  /**
2189
- * 数据备份保留时长,week默认是7,month为30。
2193
+ * 数据备份保留时长,单位:天。取值范围为:[0,30000)
2194
+ BackupPeriodType为week时默认是7,为month时默认为31。
2190
2195
  */
2191
2196
  BaseBackupRetentionPeriod?: number;
2192
2197
  }
@@ -2246,7 +2251,7 @@ export interface RawSlowQuery {
2246
2251
  */
2247
2252
  export interface DescribeDatabaseObjectsRequest {
2248
2253
  /**
2249
- * 实例ID。
2254
+ * 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2250
2255
  */
2251
2256
  DBInstanceId: string;
2252
2257
  /**
@@ -2355,7 +2360,7 @@ export interface DatabaseObject {
2355
2360
  */
2356
2361
  export interface UpgradeDBInstanceKernelVersionRequest {
2357
2362
  /**
2358
- * 实例ID
2363
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2359
2364
  */
2360
2365
  DBInstanceId: string;
2361
2366
  /**
@@ -2365,9 +2370,9 @@ export interface UpgradeDBInstanceKernelVersionRequest {
2365
2370
  TargetDBKernelVersion: string;
2366
2371
  /**
2367
2372
  * 指定实例升级内核版本号完成后的切换时间。可选值:
2368
- <li>0:立即切换
2369
- <li>1:指定时间切换
2370
- <li>2:维护时间窗口内切换
2373
+ <li>0:立即切换</li>
2374
+ <li>1:指定时间切换</li>
2375
+ <li>2:维护时间窗口内切换</li>
2371
2376
  默认值:0
2372
2377
  */
2373
2378
  SwitchTag?: number;
@@ -2381,8 +2386,8 @@ export interface UpgradeDBInstanceKernelVersionRequest {
2381
2386
  SwitchEndTime?: string;
2382
2387
  /**
2383
2388
  * 是否对本次升级实例内核版本号操作执行预检查。
2384
- <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
2385
- <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。
2389
+ <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。</li>
2390
+ <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。</li>
2386
2391
  默认值:false
2387
2392
  */
2388
2393
  DryRun?: boolean;
@@ -2410,26 +2415,26 @@ export interface ModifyReadOnlyDBInstanceWeightResponse {
2410
2415
  */
2411
2416
  export interface ModifyDBInstanceHAConfigRequest {
2412
2417
  /**
2413
- * 实例ID
2418
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2414
2419
  */
2415
2420
  DBInstanceId: string;
2416
2421
  /**
2417
2422
  * 主从同步方式:
2418
- <li>Semi-sync:半同步
2419
- <li>Async:异步
2423
+ <li>Semi-sync:半同步</li>
2424
+ <li>Async:异步</li>
2420
2425
 
2421
2426
  */
2422
2427
  SyncMode: string;
2423
2428
  /**
2424
2429
  * 高可用备机最大延迟数据量。备节点延迟数据量小于等于该值,且备节点延迟时间小于等于MaxStandbyLag时,可以切换为主节点。
2425
- <li>单位:byte
2426
- <li>参数范围:[1073741824, 322122547200]
2430
+ <li>单位:byte</li>
2431
+ <li>参数范围:[1073741824, 322122547200]</li>
2427
2432
  */
2428
2433
  MaxStandbyLatency: number;
2429
2434
  /**
2430
2435
  * 高可用备机最大延迟时间。备节点延迟时间小于等于该值,且备节点延迟数据量小于等于MaxStandbyLatency时,可以切换为主节点。
2431
- <li>单位:s
2432
- <li>参数范围:[5, 10]
2436
+ <li>单位:s</li>
2437
+ <li>参数范围:[5, 10]</li>
2433
2438
  */
2434
2439
  MaxStandbyLag: number;
2435
2440
  /**
@@ -2511,7 +2516,7 @@ export interface DescribeBackupSummariesResponse {
2511
2516
  */
2512
2517
  export interface DescribeDBErrlogsRequest {
2513
2518
  /**
2514
- * 实例ID。
2519
+ * 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2515
2520
  */
2516
2521
  DBInstanceId: string;
2517
2522
  /**
@@ -2614,11 +2619,11 @@ export interface ServerlessDBAccount {
2614
2619
  */
2615
2620
  export interface DeleteBackupPlanRequest {
2616
2621
  /**
2617
- * 实例ID
2622
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2618
2623
  */
2619
2624
  DBInstanceId: string;
2620
2625
  /**
2621
- * 备份计划的ID
2626
+ * 备份计划的ID。可通过[DescribeBackupPlans](https://cloud.tencent.com/document/api/409/68069)接口获取
2622
2627
  */
2623
2628
  PlanId: string;
2624
2629
  }
@@ -2733,7 +2738,7 @@ export interface CloneDBInstanceRequest {
2733
2738
  */
2734
2739
  export interface DeleteParameterTemplateRequest {
2735
2740
  /**
2736
- * 参数模板ID,用于唯一确认待操作的参数模板
2741
+ * 参数模板ID,用于唯一确认待操作的参数模板。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
2737
2742
  */
2738
2743
  TemplateId: string;
2739
2744
  }
@@ -2742,7 +2747,7 @@ export interface DeleteParameterTemplateRequest {
2742
2747
  */
2743
2748
  export interface DescribeClassesRequest {
2744
2749
  /**
2745
- * 可用区ID。可以通过接口DescribeZones获取。
2750
+ * 可用区名称。可以通过接口[DescribeZones](https://cloud.tencent.com/document/product/409/16769)获取。
2746
2751
  */
2747
2752
  Zone: string;
2748
2753
  /**
@@ -2752,7 +2757,7 @@ export interface DescribeClassesRequest {
2752
2757
  */
2753
2758
  DBEngine: string;
2754
2759
  /**
2755
- * 数据库主版本号。例如12,13,可以通过接口DescribeDBVersions获取。
2760
+ * 数据库主版本号。例如12,13,可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取。
2756
2761
  */
2757
2762
  DBMajorVersion: string;
2758
2763
  }
@@ -2761,7 +2766,7 @@ export interface DescribeClassesRequest {
2761
2766
  */
2762
2767
  export interface DescribeParamsEventRequest {
2763
2768
  /**
2764
- * 实例DB ID
2769
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2765
2770
  */
2766
2771
  DBInstanceId: string;
2767
2772
  }
@@ -2790,7 +2795,7 @@ export interface EventInfo {
2790
2795
  */
2791
2796
  EffectiveTime?: string;
2792
2797
  /**
2793
- * 修改状态
2798
+ * 修改状态。枚举值:in progress、success、paused
2794
2799
  */
2795
2800
  State?: string;
2796
2801
  /**
@@ -2830,55 +2835,55 @@ export interface AnalysisItems {
2830
2835
  /**
2831
2836
  * 慢SQL查询的数据库名
2832
2837
  */
2833
- DatabaseName: string;
2838
+ DatabaseName?: string;
2834
2839
  /**
2835
2840
  * 慢SQL执行的用户名
2836
2841
  */
2837
- UserName: string;
2842
+ UserName?: string;
2838
2843
  /**
2839
2844
  * 抽象参数之后的慢SQL
2840
2845
  */
2841
- NormalQuery: string;
2846
+ NormalQuery?: string;
2842
2847
  /**
2843
2848
  * 慢SQL执行的客户端地址
2844
2849
  */
2845
- ClientAddr: string;
2850
+ ClientAddr?: string;
2846
2851
  /**
2847
2852
  * 在选定时间范围内慢SQL语句执行的次数
2848
2853
  */
2849
- CallNum: number;
2854
+ CallNum?: number;
2850
2855
  /**
2851
- * 在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的比例(小数返回)
2856
+ * 在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的百分比。
2852
2857
  */
2853
- CallPercent: number;
2858
+ CallPercent?: number;
2854
2859
  /**
2855
2860
  * 在选定时间范围内,慢SQL执行的总时间
2856
2861
  */
2857
- CostTime: number;
2862
+ CostTime?: number;
2858
2863
  /**
2859
2864
  * 在选定时间范围内,慢SQL语句执行的总时间占所有慢SQL的比例(小数返回)
2860
2865
  */
2861
- CostPercent: number;
2866
+ CostPercent?: number;
2862
2867
  /**
2863
2868
  * 在选定时间范围内,慢SQL语句执行的耗时最短的时间(单位:ms)
2864
2869
  */
2865
- MinCostTime: number;
2870
+ MinCostTime?: number;
2866
2871
  /**
2867
2872
  * 在选定时间范围内,慢SQL语句执行的耗时最长的时间(单位:ms)
2868
2873
  */
2869
- MaxCostTime: number;
2874
+ MaxCostTime?: number;
2870
2875
  /**
2871
2876
  * 在选定时间范围内,慢SQL语句执行的耗时平均时间(单位:ms)
2872
2877
  */
2873
- AvgCostTime: number;
2878
+ AvgCostTime?: number;
2874
2879
  /**
2875
- * 在选定时间范围内,慢SQL第一条开始执行的时间戳
2880
+ * 在选定时间范围内,慢SQL第一条开始执行的时间
2876
2881
  */
2877
- FirstTime: string;
2882
+ FirstTime?: string;
2878
2883
  /**
2879
- * 在选定时间范围内,慢SQL最后一条开始执行的时间戳
2884
+ * 在选定时间范围内,慢SQL最后一条开始执行的时间
2880
2885
  */
2881
- LastTime: string;
2886
+ LastTime?: string;
2882
2887
  }
2883
2888
  /**
2884
2889
  * 数据库Xlog信息
@@ -3060,43 +3065,43 @@ export interface ServerlessDBInstance {
3060
3065
  */
3061
3066
  export interface CreateReadOnlyGroupRequest {
3062
3067
  /**
3063
- * 主实例ID
3068
+ * 主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3064
3069
  */
3065
3070
  MasterDBInstanceId: string;
3066
3071
  /**
3067
- * 只读组名称
3072
+ * 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"。
3068
3073
  */
3069
3074
  Name: string;
3070
3075
  /**
3071
- * 项目ID
3076
+ * 项目ID。默认值为0,表示归属于默认项目。
3072
3077
  */
3073
3078
  ProjectId?: number;
3074
3079
  /**
3075
- * 私有网络ID
3080
+ * 私有网络ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
3076
3081
  */
3077
3082
  VpcId?: string;
3078
3083
  /**
3079
- * 子网ID
3084
+ * 子网ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
3080
3085
  */
3081
3086
  SubnetId?: string;
3082
3087
  /**
3083
- * 延迟时间大小开关:0关、1
3088
+ * 延迟时间大小开关:0关、1开。该参数必填。
3084
3089
  */
3085
3090
  ReplayLagEliminate?: number;
3086
3091
  /**
3087
- * 延迟空间大小开关: 0关、1
3092
+ * 延迟空间大小开关: 0关、1开。该参数的填写需要与ReplayLagEliminate一致。
3088
3093
  */
3089
3094
  ReplayLatencyEliminate?: number;
3090
3095
  /**
3091
- * 延迟时间大小阈值,单位ms
3096
+ * 延迟时间大小阈值,取值为正整数,单位s。当ReplayLagEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数需填0。
3092
3097
  */
3093
3098
  MaxReplayLag?: number;
3094
3099
  /**
3095
- * 延迟空间大小阈值,单位MB
3100
+ * 延迟空间大小阈值,取值为正整数,单位MB。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLatencyEliminate为0时,该参数需填0。
3096
3101
  */
3097
3102
  MaxReplayLatency?: number;
3098
3103
  /**
3099
- * 延迟剔除最小保留实例数
3104
+ * 延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数无效。
3100
3105
  */
3101
3106
  MinDelayEliminateReserve?: number;
3102
3107
  /**
@@ -3168,7 +3173,7 @@ export interface DescribeDedicatedClustersRequest {
3168
3173
  */
3169
3174
  export interface CreateReadOnlyGroupNetworkAccessRequest {
3170
3175
  /**
3171
- * RO组ID,形如:pgro-4t9c6g7k
3176
+ * RO组ID,形如:pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
3172
3177
  */
3173
3178
  ReadOnlyGroupId: string;
3174
3179
  /**
@@ -3184,7 +3189,7 @@ export interface CreateReadOnlyGroupNetworkAccessRequest {
3184
3189
  */
3185
3190
  IsAssignVip: boolean;
3186
3191
  /**
3187
- * 目标VIP地址。
3192
+ * 目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
3188
3193
  */
3189
3194
  Vip?: string;
3190
3195
  }
@@ -3210,7 +3215,7 @@ export interface EventItem {
3210
3215
  */
3211
3216
  export interface RestartDBInstanceRequest {
3212
3217
  /**
3213
- * 实例ID,形如postgres-6r233v55
3218
+ * 实例ID,形如postgres-6r233v55。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3214
3219
  */
3215
3220
  DBInstanceId: string;
3216
3221
  }
@@ -3429,7 +3434,7 @@ export interface InquiryPriceUpgradeDBInstanceRequest {
3429
3434
  */
3430
3435
  Memory: number;
3431
3436
  /**
3432
- * 实例ID,形如postgres-hez4fh0v
3437
+ * 实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3433
3438
  */
3434
3439
  DBInstanceId: string;
3435
3440
  /**
@@ -3438,7 +3443,8 @@ export interface InquiryPriceUpgradeDBInstanceRequest {
3438
3443
  */
3439
3444
  InstanceChargeType?: string;
3440
3445
  /**
3441
- * 实例的Cpu大小,单位Core
3446
+ * 实例的Cpu大小,单位Core
3447
+ 不传入此参数时,默认根据Memory确定的售卖规格所对应的Cpu进行设置。如Memory为2,支持的售卖规格有1核2GiB,则不传入Cpu时,Cpu默认为1。
3442
3448
  */
3443
3449
  Cpu?: number;
3444
3450
  }
@@ -3508,7 +3514,7 @@ export interface DescribeDatabaseObjectsResponse {
3508
3514
  */
3509
3515
  export interface IsolateDBInstancesRequest {
3510
3516
  /**
3511
- * 实例ID集合。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
3517
+ * 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
3512
3518
  */
3513
3519
  DBInstanceIdSet: Array<string>;
3514
3520
  }
@@ -3517,11 +3523,11 @@ export interface IsolateDBInstancesRequest {
3517
3523
  */
3518
3524
  export interface ModifyDBInstanceNameRequest {
3519
3525
  /**
3520
- * 数据库实例ID,形如postgres-6fego161
3526
+ * 数据库实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3521
3527
  */
3522
3528
  DBInstanceId: string;
3523
3529
  /**
3524
- * 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"
3530
+ * 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-"。
3525
3531
 
3526
3532
  */
3527
3533
  InstanceName: string;
@@ -3552,11 +3558,11 @@ export interface DescribeDBInstanceSSLConfigResponse {
3552
3558
  */
3553
3559
  export interface DeleteAccountRequest {
3554
3560
  /**
3555
- * 实例ID。
3561
+ * 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3556
3562
  */
3557
3563
  DBInstanceId: string;
3558
3564
  /**
3559
- * 删除的账号名称。
3565
+ * 删除的账号名称。 可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
3560
3566
  */
3561
3567
  UserName: string;
3562
3568
  }
@@ -3595,7 +3601,7 @@ export interface InquiryPriceRenewDBInstanceResponse {
3595
3601
  */
3596
3602
  export interface DescribeSlowQueryAnalysisRequest {
3597
3603
  /**
3598
- * 实例ID
3604
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3599
3605
  */
3600
3606
  DBInstanceId: string;
3601
3607
  /**
@@ -3715,7 +3721,7 @@ export interface DescribeBackupOverviewResponse {
3715
3721
  */
3716
3722
  export interface DescribeParameterTemplatesRequest {
3717
3723
  /**
3718
- * 过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine
3724
+ * 过滤条件,目前支持的过滤条件有:TemplateName, TemplateId,DBMajorVersion,DBEngine。TemplateName不支持模糊匹配。
3719
3725
  */
3720
3726
  Filters?: Array<Filter>;
3721
3727
  /**
@@ -3727,11 +3733,11 @@ export interface DescribeParameterTemplatesRequest {
3727
3733
  */
3728
3734
  Offset?: number;
3729
3735
  /**
3730
- * 排序指标,枚举值,支持:CreateTime,TemplateName,DBMajorVersion
3736
+ * 排序指标,枚举值,支持:CreateTime,TemplateName,DBMajorVersion。如果不指定该参数,默认将按照参数模板的编号倒序排列,也就是说最新添加的参数模板会排在最前面。
3731
3737
  */
3732
3738
  OrderBy?: string;
3733
3739
  /**
3734
- * 排序方式,枚举值,支持:asc(升序) ,desc(降序)
3740
+ * 排序方式,枚举值,支持:asc(升序) ,desc(降序)。默认值为asc。当未指定OrderBy时,该参数失效,此时排序方式为OrderBy参数描述中给出的默认排序方式。
3735
3741
  */
3736
3742
  OrderByType?: string;
3737
3743
  }
@@ -3996,11 +4002,11 @@ export interface DeleteParameterTemplateResponse {
3996
4002
  */
3997
4003
  export interface ModifyReadOnlyDBInstanceWeightRequest {
3998
4004
  /**
3999
- * 实例ID
4005
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4000
4006
  */
4001
4007
  DBInstanceId: string;
4002
4008
  /**
4003
- * 只读组ID
4009
+ * 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
4004
4010
  */
4005
4011
  ReadOnlyGroupId: string;
4006
4012
  /**
@@ -4169,7 +4175,7 @@ export interface DescribeBaseBackupsResponse {
4169
4175
  */
4170
4176
  export interface ModifyParameterTemplateRequest {
4171
4177
  /**
4172
- * 参数模板ID,用于唯一确认参数模板,不可修改
4178
+ * 参数模板ID,用于唯一确认参数模板,不可修改。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
4173
4179
  */
4174
4180
  TemplateId: string;
4175
4181
  /**
@@ -4207,11 +4213,11 @@ export interface DescribeDBVersionsResponse {
4207
4213
  */
4208
4214
  export interface ModifyDBInstanceSSLConfigRequest {
4209
4215
  /**
4210
- * 实例 ID
4216
+ * 实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4211
4217
  */
4212
4218
  DBInstanceId: string;
4213
4219
  /**
4214
- * 开启或关闭SSL
4220
+ * 开启或关闭SSL。true - 开启 ;false - 关闭。
4215
4221
  */
4216
4222
  SSLEnabled: boolean;
4217
4223
  /**
@@ -4285,11 +4291,11 @@ export interface ModifyDBInstanceNameResponse {
4285
4291
  */
4286
4292
  export interface UpgradeDBInstanceMajorVersionRequest {
4287
4293
  /**
4288
- * 实例ID
4294
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4289
4295
  */
4290
4296
  DBInstanceId: string;
4291
4297
  /**
4292
- * 目标内核版本号,可以通过API DescribeDBVersions获取可以升级的目标内核版本号。
4298
+ * 目标内核版本号,可以通过API [DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取可以升级的目标内核版本号。
4293
4299
  */
4294
4300
  TargetDBKernelVersion: string;
4295
4301
  /**
@@ -4387,7 +4393,7 @@ export interface CreateReadOnlyDBInstanceRequest {
4387
4393
  */
4388
4394
  Zone: string;
4389
4395
  /**
4390
- * 只读实例的主实例ID
4396
+ * 只读实例的主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4391
4397
  */
4392
4398
  MasterDBInstanceId: string;
4393
4399
  /**
@@ -4395,7 +4401,7 @@ export interface CreateReadOnlyDBInstanceRequest {
4395
4401
  */
4396
4402
  SpecCode: string;
4397
4403
  /**
4398
- * 实例容量大小,单位:GB。
4404
+ * 实例硬盘容量大小,单位:GB。该参数的设置步长为10
4399
4405
  */
4400
4406
  Storage: number;
4401
4407
  /**
@@ -4442,7 +4448,7 @@ export interface CreateReadOnlyDBInstanceRequest {
4442
4448
  */
4443
4449
  AutoRenewFlag?: number;
4444
4450
  /**
4445
- * 项目ID
4451
+ * 项目ID。默认值为0,表示归属默认项目。
4446
4452
  */
4447
4453
  ProjectId?: number;
4448
4454
  /**
@@ -4470,7 +4476,7 @@ export interface CreateReadOnlyDBInstanceRequest {
4470
4476
  */
4471
4477
  NeedSupportIpv6?: number;
4472
4478
  /**
4473
- * 实例名(后续支持)
4479
+ * 实例名。仅支持长度小于60的中文/英文/数字/"_"/"-"
4474
4480
  */
4475
4481
  Name?: string;
4476
4482
  /**
@@ -4600,7 +4606,7 @@ export interface ModifyParameterTemplateResponse {
4600
4606
  */
4601
4607
  export interface DescribeEncryptionKeysRequest {
4602
4608
  /**
4603
- * 实例ID
4609
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4604
4610
  */
4605
4611
  DBInstanceId: string;
4606
4612
  }
@@ -4621,15 +4627,15 @@ export interface LogBackup {
4621
4627
  */
4622
4628
  Name?: string;
4623
4629
  /**
4624
- * 备份方式:物理备份、逻辑备份。
4630
+ * 备份方式。枚举值,physical - 物理备份;logical - 逻辑备份。
4625
4631
  */
4626
4632
  BackupMethod?: string;
4627
4633
  /**
4628
- * 备份模式:自动备份、手动备份。
4634
+ * 备份模式。枚举值,manual - 手动备份;automatic - 自动备份 。
4629
4635
  */
4630
4636
  BackupMode?: string;
4631
4637
  /**
4632
- * 备份任务状态。
4638
+ * 备份任务状态。枚举值:init、running、finished、failed、canceled
4633
4639
  */
4634
4640
  State?: string;
4635
4641
  /**
@@ -4654,7 +4660,7 @@ export interface LogBackup {
4654
4660
  */
4655
4661
  export interface RebalanceReadOnlyGroupRequest {
4656
4662
  /**
4657
- * 只读组ID
4663
+ * 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
4658
4664
  */
4659
4665
  ReadOnlyGroupId: string;
4660
4666
  }
@@ -4846,7 +4852,7 @@ export interface ModifyAccountRemarkRequest {
4846
4852
  */
4847
4853
  export interface DescribeParameterTemplateAttributesRequest {
4848
4854
  /**
4849
- * 参数模板ID
4855
+ * 参数模板ID。可通过[DescribeParameterTemplates](https://tapd.woa.com/tapd_fe/20400322/story/detail/1020400322125673714)接口获取
4850
4856
  */
4851
4857
  TemplateId: string;
4852
4858
  }
@@ -4872,7 +4878,7 @@ export interface DescribeDBErrlogsResponse {
4872
4878
  */
4873
4879
  export interface ModifyBackupPlanRequest {
4874
4880
  /**
4875
- * 实例ID
4881
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4876
4882
  */
4877
4883
  DBInstanceId: string;
4878
4884
  /**
@@ -4888,7 +4894,7 @@ export interface ModifyBackupPlanRequest {
4888
4894
  */
4889
4895
  BaseBackupRetentionPeriod?: number;
4890
4896
  /**
4891
- * 实例备份周期,若是星期维度,格式为小写星期英文单词;若是按月维度,格式为数字字符,如["1","2"]。
4897
+ * 实例备份周期,若是星期维度,格式为小写星期英文单词,且至少设置两天备份;若是按月维度,格式为数字字符,如["1","2"]。
4892
4898
  */
4893
4899
  BackupPeriod?: Array<string>;
4894
4900
  /**
@@ -4909,11 +4915,11 @@ export interface ModifyBackupPlanRequest {
4909
4915
  */
4910
4916
  export interface DeleteBaseBackupRequest {
4911
4917
  /**
4912
- * 实例ID
4918
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4913
4919
  */
4914
4920
  DBInstanceId: string;
4915
4921
  /**
4916
- * 数据备份ID
4922
+ * 数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。7天内自动备份集不允许删除。
4917
4923
  */
4918
4924
  BaseBackupId: string;
4919
4925
  }
@@ -4969,7 +4975,7 @@ export interface CreateParameterTemplateRequest {
4969
4975
  */
4970
4976
  TemplateName: string;
4971
4977
  /**
4972
- * 数据库大版本号,例如:11,12,13
4978
+ * 数据库大版本号,例如:11,12,13。可通过[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
4973
4979
  */
4974
4980
  DBMajorVersion: string;
4975
4981
  /**
@@ -4986,7 +4992,7 @@ export interface CreateParameterTemplateRequest {
4986
4992
  */
4987
4993
  export interface DescribeDBInstanceSSLConfigRequest {
4988
4994
  /**
4989
- * 实例ID,形如postgres-6bwgamo3
4995
+ * 实例ID,形如postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4990
4996
  */
4991
4997
  DBInstanceId: string;
4992
4998
  }
@@ -5004,7 +5010,7 @@ export interface ModifyDatabaseOwnerResponse {
5004
5010
  */
5005
5011
  export interface ModifySwitchTimePeriodRequest {
5006
5012
  /**
5007
- * 处于等待切换状态中的实例ID
5013
+ * 处于等待切换状态中的实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5008
5014
  */
5009
5015
  DBInstanceId: string;
5010
5016
  /**
@@ -5026,7 +5032,7 @@ export interface CreateAccountResponse {
5026
5032
  */
5027
5033
  export interface DescribeSlowQueryListRequest {
5028
5034
  /**
5029
- * 实例ID
5035
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5030
5036
  */
5031
5037
  DBInstanceId: string;
5032
5038
  /**
@@ -5063,11 +5069,11 @@ export interface DescribeSlowQueryListRequest {
5063
5069
  */
5064
5070
  export interface DescribeCloneDBInstanceSpecRequest {
5065
5071
  /**
5066
- * 实例ID
5072
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5067
5073
  */
5068
5074
  DBInstanceId: string;
5069
5075
  /**
5070
- * 基础备份集ID,此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
5076
+ * 基础备份集ID,可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取。此入参和RecoveryTargetTime必须选择一个传入。如与RecoveryTargetTime参数同时设置,则以此参数为准。
5071
5077
  */
5072
5078
  BackupSetId?: string;
5073
5079
  /**
@@ -5105,15 +5111,15 @@ export interface RegionInfo {
5105
5111
  */
5106
5112
  export interface ModifyDatabaseOwnerRequest {
5107
5113
  /**
5108
- * 实例ID
5114
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5109
5115
  */
5110
5116
  DBInstanceId: string;
5111
5117
  /**
5112
- * 数据库名称
5118
+ * 数据库名称。可通过[DescribeDatabases](https://cloud.tencent.com/document/api/409/43353)接口获取
5113
5119
  */
5114
5120
  DatabaseName: string;
5115
5121
  /**
5116
- * 数据库新所有者
5122
+ * 数据库新所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
5117
5123
  */
5118
5124
  DatabaseOwner: string;
5119
5125
  }
@@ -5122,13 +5128,13 @@ export interface ModifyDatabaseOwnerRequest {
5122
5128
  */
5123
5129
  export interface DisIsolateDBInstancesRequest {
5124
5130
  /**
5125
- * 实例ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
5131
+ * 实例ID列表。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时解隔离多个实例。
5126
5132
  */
5127
5133
  DBInstanceIdSet: Array<string>;
5128
5134
  /**
5129
5135
  * 购买时长,单位:月。
5130
5136
  <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
5131
- <li>后付费:只支持1</li>
5137
+ <li>后付费:该参数不生效</li>
5132
5138
  */
5133
5139
  Period?: number;
5134
5140
  /**
@@ -5191,11 +5197,11 @@ export interface DescribeDBInstancesResponse {
5191
5197
  */
5192
5198
  export interface DescribeDBInstanceSecurityGroupsRequest {
5193
5199
  /**
5194
- * 实例IDDBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
5200
+ * 实例ID,可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
5195
5201
  */
5196
5202
  DBInstanceId?: string;
5197
5203
  /**
5198
- * 只读组IDDBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
5204
+ * 只读组ID,可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
5199
5205
  */
5200
5206
  ReadOnlyGroupId?: string;
5201
5207
  }
@@ -5204,7 +5210,7 @@ export interface DescribeDBInstanceSecurityGroupsRequest {
5204
5210
  */
5205
5211
  export interface DescribeBackupPlansRequest {
5206
5212
  /**
5207
- * 实例ID
5213
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5208
5214
  */
5209
5215
  DBInstanceId: string;
5210
5216
  }
@@ -5213,11 +5219,11 @@ export interface DescribeBackupPlansRequest {
5213
5219
  */
5214
5220
  export interface ModifyBaseBackupExpireTimeRequest {
5215
5221
  /**
5216
- * 实例ID
5222
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5217
5223
  */
5218
5224
  DBInstanceId: string;
5219
5225
  /**
5220
- * 数据备份ID
5226
+ * 数据备份ID。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取
5221
5227
  */
5222
5228
  BaseBackupId: string;
5223
5229
  /**
@@ -5257,15 +5263,23 @@ export interface RebalanceReadOnlyGroupResponse {
5257
5263
  */
5258
5264
  export interface ResetAccountPasswordRequest {
5259
5265
  /**
5260
- * 实例ID,形如postgres-4wdeb0zv
5266
+ * 实例ID,形如postgres-4wdeb0zv。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5261
5267
  */
5262
5268
  DBInstanceId: string;
5263
5269
  /**
5264
- * 实例账户名
5270
+ * 实例账户名。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
5265
5271
  */
5266
5272
  UserName: string;
5267
5273
  /**
5268
- * UserName账户对应的新密码
5274
+ * UserName账户对应的新密码。
5275
+ 密码设置规则如下:
5276
+ - 长度8~ 32位,推荐使用12位以上的密码
5277
+ - 不能以" / "开头
5278
+ - 必须包含以下四项:
5279
+ 1. 小写字母a ~ z
5280
+ 2. 大写字母 A ~ Z
5281
+ 3. 数字 0 ~ 9
5282
+ 4. 特殊字符 ()`~!@#$%^&*-+=_|{}[]:<>,.?/
5269
5283
  */
5270
5284
  Password: string;
5271
5285
  }
@@ -5291,7 +5305,7 @@ export interface DescribeSlowQueryAnalysisResponse {
5291
5305
  */
5292
5306
  export interface ModifyDBInstanceParametersRequest {
5293
5307
  /**
5294
- * 实例ID
5308
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5295
5309
  */
5296
5310
  DBInstanceId: string;
5297
5311
  /**
@@ -5324,7 +5338,7 @@ export interface DedicatedCluster {
5324
5338
  */
5325
5339
  InstanceCount?: number;
5326
5340
  /**
5327
- * Cpu总量
5341
+ * Cpu总数量
5328
5342
  */
5329
5343
  CpuTotal?: number;
5330
5344
  /**
@@ -5332,19 +5346,19 @@ export interface DedicatedCluster {
5332
5346
  */
5333
5347
  CpuAvailable?: number;
5334
5348
  /**
5335
- * 内存总量
5349
+ * 内存总量,单位GB
5336
5350
  */
5337
5351
  MemTotal?: number;
5338
5352
  /**
5339
- * 内存可用量
5353
+ * 内存可用量,单位GB
5340
5354
  */
5341
5355
  MemAvailable?: number;
5342
5356
  /**
5343
- * 磁盘总量
5357
+ * 磁盘总量,单位GB
5344
5358
  */
5345
5359
  DiskTotal?: number;
5346
5360
  /**
5347
- * 磁盘可用量
5361
+ * 磁盘可用量,单位GB
5348
5362
  */
5349
5363
  DiskAvailable?: number;
5350
5364
  }
@@ -5383,11 +5397,11 @@ export interface DescribeDBSlowlogsResponse {
5383
5397
  */
5384
5398
  export interface DescribeAccountPrivilegesRequest {
5385
5399
  /**
5386
- * 实例ID。
5400
+ * 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5387
5401
  */
5388
5402
  DBInstanceId: string;
5389
5403
  /**
5390
- * 查询此账号对某数据库对象所拥有的权限信息。
5404
+ * 查询此账号对某数据库对象所拥有的权限信息。账号名可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
5391
5405
  */
5392
5406
  UserName: string;
5393
5407
  /**
@@ -5413,7 +5427,7 @@ export interface DescribeReadOnlyGroupsResponse {
5413
5427
  */
5414
5428
  export interface RestoreDBInstanceObjectsRequest {
5415
5429
  /**
5416
- * 实例ID
5430
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5417
5431
  */
5418
5432
  DBInstanceId: string;
5419
5433
  /**
@@ -5421,7 +5435,7 @@ export interface RestoreDBInstanceObjectsRequest {
5421
5435
  */
5422
5436
  RestoreObjects: Array<string>;
5423
5437
  /**
5424
- * 恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。
5438
+ * 恢复所用备份集。BackupSetId与RestoreTargetTime有且只能传一个。可通过[DescribeBaseBackups](https://cloud.tencent.com/document/api/409/89022)接口获取
5425
5439
  */
5426
5440
  BackupSetId?: string;
5427
5441
  /**
@@ -5451,7 +5465,7 @@ export interface DescribeAccountsResponse {
5451
5465
  */
5452
5466
  export interface ModifyDBInstanceChargeTypeRequest {
5453
5467
  /**
5454
- * 实例ID,形如postgres-6fego161
5468
+ * 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5455
5469
  */
5456
5470
  DBInstanceId: string;
5457
5471
  /**
@@ -5529,11 +5543,11 @@ export declare type DescribeDBVersionsRequest = null;
5529
5543
  */
5530
5544
  export interface ModifyDBInstancesProjectRequest {
5531
5545
  /**
5532
- * 实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
5546
+ * 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时操作多个实例。
5533
5547
  */
5534
5548
  DBInstanceIdSet: Array<string>;
5535
5549
  /**
5536
- * 所属新项目的ID
5550
+ * 所属新项目的ID。可通过[DescribeProjects](https://cloud.tencent.com/document/api/651/78725)获取
5537
5551
  */
5538
5552
  ProjectId: string;
5539
5553
  }
@@ -5601,11 +5615,11 @@ export interface DescribeDBInstanceAttributeResponse {
5601
5615
  */
5602
5616
  export interface DeleteLogBackupRequest {
5603
5617
  /**
5604
- * 实例ID
5618
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5605
5619
  */
5606
5620
  DBInstanceId: string;
5607
5621
  /**
5608
- * 日志备份ID
5622
+ * 日志备份ID。可通过[DescribeLogBackups](https://cloud.tencent.com/document/api/409/89021)接口获取。注:7天内自动备份集不允许删除。
5609
5623
  */
5610
5624
  LogBackupId: string;
5611
5625
  }
@@ -5665,7 +5679,7 @@ export interface ModifyDBInstanceSpecResponse {
5665
5679
  */
5666
5680
  export interface DescribeBackupDownloadURLRequest {
5667
5681
  /**
5668
- * 实例ID
5682
+ * 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5669
5683
  */
5670
5684
  DBInstanceId: string;
5671
5685
  /**
@@ -5677,7 +5691,7 @@ export interface DescribeBackupDownloadURLRequest {
5677
5691
  */
5678
5692
  BackupId: string;
5679
5693
  /**
5680
- * 链接的有效时间,默认为12小时。
5694
+ * 链接的有效时间,取值为[0,36],默认为12小时。
5681
5695
  */
5682
5696
  URLExpireTime?: number;
5683
5697
  /**
@@ -5730,10 +5744,10 @@ export interface DescribeBaseBackupsRequest {
5730
5744
  /**
5731
5745
  * 按照一个或者多个过滤条件进行查询,目前支持的过滤条件有:
5732
5746
  db-instance-id:按照实例ID过滤,类型为string。
5733
- db-instance-name:按照实例名过滤,类型为string。
5747
+ db-instance-name:按照实例名过滤,支持模糊匹配,类型为string。
5734
5748
  db-instance-ip:按照实例私有网络IP地址过滤,类型为string。
5735
5749
  base-backup-id:按照备份集ID过滤,类型为string。
5736
- db-instance-status:按实例状态过滤,类型为string。取值参考DBInstance结构的DBInstanceStatus字段。
5750
+ db-instance-status:按实例状态过滤,类型为string。取值参考[DBInstance](https://cloud.tencent.com/document/api/409/16778#DBInstance)结构的DBInstanceStatus字段。
5737
5751
  */
5738
5752
  Filters?: Array<Filter>;
5739
5753
  /**
@@ -5745,11 +5759,11 @@ export interface DescribeBaseBackupsRequest {
5745
5759
  */
5746
5760
  Offset?: number;
5747
5761
  /**
5748
- * 排序字段,支持StartTime,FinishTime,Size。
5762
+ * 排序字段,支持StartTime,FinishTime,Size。默认值:StartTime
5749
5763
  */
5750
5764
  OrderBy?: string;
5751
5765
  /**
5752
- * 排序方式,包括升序:asc,降序:desc。
5766
+ * 排序方式,包括升序:asc,降序:desc。默认值:desc
5753
5767
  */
5754
5768
  OrderByType?: string;
5755
5769
  }