tencentcloud-sdk-postgres 3.0.1094 → 3.0.1109

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: bad7d6a94ba29c994f8a408ae9045001462faade
4
- data.tar.gz: fd85ca389082d3f2ae230ccd598034f522f20f2b
3
+ metadata.gz: de015d1813784cde14462ce23013b4d349bf5096
4
+ data.tar.gz: fc2e1e00a3063908e2b4683eb47a2bca6c5f5935
5
5
  SHA512:
6
- metadata.gz: 3f3da42274c0856578436ef1d44d29c728bc4d8a25aa1dbe2a37376da4b8c094dcfc3dd609ccd3ba535ab54e5be7a52604f6d08c348ccf40c89a7c6a89860b05
7
- data.tar.gz: dbf31ae1c7de0f350522dd0ee210179a88454e30076562ec5040b19b39a1cf6d4f54f9282dfb606e438b19a811a067511175e3aeeb53f4c3d970a2da0ccf5df1
6
+ metadata.gz: bab4d9f3db31dbb21ee8096add36a8a0140d712004d2b45e84964edda7fdde9912140c4705792a4e26494fc5be3d3e6719ab08c074e11713be83c573bcd545c7
7
+ data.tar.gz: 47b5d502f7007d8ccaf120c14d784415c29ceab11df5d4a69232c3e6fc7d4aa38ffe4123a53e5cdc12f8f08c6a1d7f101e4e65bb9bd65e7fdadd823ae88205d5
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1094
1
+ 3.0.1109
@@ -173,7 +173,7 @@ module TencentCloud
173
173
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
174
174
  end
175
175
 
176
- # 本接口(CreateDBInstanceNetworkAccess)用于创建实例网络。
176
+ # 本接口(CreateDBInstanceNetworkAccess)用于创建实例网络。单个实例允许创建的网络配置最多为2套,最少为1套。
177
177
 
178
178
  # @param request: Request instance for CreateDBInstanceNetworkAccess.
179
179
  # @type request: :class:`Tencentcloud::postgres::V20170312::CreateDBInstanceNetworkAccessRequest`
@@ -319,7 +319,7 @@ module TencentCloud
319
319
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
320
320
  end
321
321
 
322
- # 本接口(CreateReadOnlyGroupNetworkAccess)用于创建RO组的网络。
322
+ # 本接口(CreateReadOnlyGroupNetworkAccess)用于创建RO组的网络。创建网络的数量最多为2个。
323
323
 
324
324
  # @param request: Request instance for CreateReadOnlyGroupNetworkAccess.
325
325
  # @type request: :class:`Tencentcloud::postgres::V20170312::CreateReadOnlyGroupNetworkAccessRequest`
@@ -369,7 +369,7 @@ module TencentCloud
369
369
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
370
370
  end
371
371
 
372
- # 此接口用于删除数据库账号,需要同时输入Oid与UserName,避免误删。
372
+ # 此接口用于删除数据库账号,需要同时输入Oid与UserName,避免误删。注:该接口可重入,如果账号已经不存在,调用此接口进行删除时不会报错。
373
373
 
374
374
  # @param request: Request instance for DeleteAccount.
375
375
  # @type request: :class:`Tencentcloud::postgres::V20170312::DeleteAccountRequest`
@@ -1889,8 +1889,8 @@ module TencentCloud
1889
1889
  end
1890
1890
 
1891
1891
  # 本接口(ModifyDBInstanceHAConfig)用于修改实例HA配置信息。其中HA配置信息包括:
1892
- # <li>允许备节点切换为主节点的条件配置
1893
- # <li>半同步实例使用同步复制或异步复制的条件配置
1892
+ # <li>允许备节点切换为主节点的条件配置</li>
1893
+ # <li>半同步实例使用同步复制或异步复制的条件配置</li>
1894
1894
 
1895
1895
  # @param request: Request instance for ModifyDBInstanceHAConfig.
1896
1896
  # @type request: :class:`Tencentcloud::postgres::V20170312::ModifyDBInstanceHAConfigRequest`
@@ -2034,7 +2034,7 @@ module TencentCloud
2034
2034
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2035
2035
  end
2036
2036
 
2037
- # 本接口(ModifyDBInstanceSpec)用于修改实例规格,包括内存、磁盘。
2037
+ # 本接口(ModifyDBInstanceSpec)用于修改实例规格,包括内存、磁盘、Cpu。
2038
2038
 
2039
2039
  # @param request: Request instance for ModifyDBInstanceSpec.
2040
2040
  # @type request: :class:`Tencentcloud::postgres::V20170312::ModifyDBInstanceSpecRequest`
@@ -2419,9 +2419,9 @@ module TencentCloud
2419
2419
  end
2420
2420
 
2421
2421
  # 本接口(SwitchDBInstancePrimary)用于切换实例主备关系。
2422
- # <li>通过主动发起切换,可以验证业务能否正确处理实例主备切换的场景
2423
- # <li>通过使用强制切换,可以在备节点延迟不满足切换条件时,强制发起主从切换
2424
- # <li>只有主实例可以执行该操作
2422
+ # <li>通过主动发起切换,可以验证业务能否正确处理实例主备切换的场景</li>
2423
+ # <li>通过使用强制切换,可以在备节点延迟不满足切换条件时,强制发起主从切换</li>
2424
+ # <li>只有主实例可以执行该操作</li>
2425
2425
 
2426
2426
  # @param request: Request instance for SwitchDBInstancePrimary.
2427
2427
  # @type request: :class:`Tencentcloud::postgres::V20170312::SwitchDBInstancePrimaryRequest`
@@ -59,9 +59,9 @@ module TencentCloud
59
59
 
60
60
  # AddDBInstanceToReadOnlyGroup请求参数结构体
61
61
  class AddDBInstanceToReadOnlyGroupRequest < TencentCloud::Common::AbstractModel
62
- # @param DBInstanceId: 实例ID
62
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
63
63
  # @type DBInstanceId: String
64
- # @param ReadOnlyGroupId: 只读组ID
64
+ # @param ReadOnlyGroupId: 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
65
65
  # @type ReadOnlyGroupId: String
66
66
 
67
67
  attr_accessor :DBInstanceId, :ReadOnlyGroupId
@@ -109,7 +109,7 @@ module TencentCloud
109
109
  # @type ClientAddr: String
110
110
  # @param CallNum: 在选定时间范围内慢SQL语句执行的次数
111
111
  # @type CallNum: Integer
112
- # @param CallPercent: 在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的比例(小数返回)
112
+ # @param CallPercent: 在选定时间范围内,慢SQL语句执行的次数占所有慢SQL的百分比。
113
113
  # @type CallPercent: Float
114
114
  # @param CostTime: 在选定时间范围内,慢SQL执行的总时间
115
115
  # @type CostTime: Float
@@ -121,9 +121,9 @@ module TencentCloud
121
121
  # @type MaxCostTime: Float
122
122
  # @param AvgCostTime: 在选定时间范围内,慢SQL语句执行的耗时平均时间(单位:ms)
123
123
  # @type AvgCostTime: Float
124
- # @param FirstTime: 在选定时间范围内,慢SQL第一条开始执行的时间戳
124
+ # @param FirstTime: 在选定时间范围内,慢SQL第一条开始执行的时间
125
125
  # @type FirstTime: String
126
- # @param LastTime: 在选定时间范围内,慢SQL最后一条开始执行的时间戳
126
+ # @param LastTime: 在选定时间范围内,慢SQL最后一条开始执行的时间
127
127
  # @type LastTime: String
128
128
 
129
129
  attr_accessor :DatabaseName, :UserName, :NormalQuery, :ClientAddr, :CallNum, :CallPercent, :CostTime, :CostPercent, :MinCostTime, :MaxCostTime, :AvgCostTime, :FirstTime, :LastTime
@@ -163,7 +163,7 @@ module TencentCloud
163
163
 
164
164
  # 备份下载限制信息
165
165
  class BackupDownloadRestriction < TencentCloud::Common::AbstractModel
166
- # @param RestrictionType: 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip
166
+ # @param RestrictionType: 备份文件下载限制类型,NONE 无限制,内外网都可以下载;INTRANET 只允许内网下载;CUSTOMIZE 自定义限制下载的vpc或ip。当该参数取值为CUSTOMIZE 时,vpc或ip信息至少填写一项
167
167
  # @type RestrictionType: String
168
168
  # @param VpcRestrictionEffect: vpc限制效力,ALLOW 允许;DENY 拒绝。
169
169
  # @type VpcRestrictionEffect: String
@@ -197,7 +197,7 @@ module TencentCloud
197
197
  class BackupPlan < TencentCloud::Common::AbstractModel
198
198
  # @param BackupPeriod: 备份周期
199
199
  # @type BackupPeriod: String
200
- # @param BaseBackupRetentionPeriod: 数据备份保留时长
200
+ # @param BaseBackupRetentionPeriod: 数据备份保留时长。单位:天
201
201
  # @type BaseBackupRetentionPeriod: Integer
202
202
  # @param MinBackupStartTime: 开始备份的最早时间
203
203
  # @type MinBackupStartTime: String
@@ -207,7 +207,7 @@ module TencentCloud
207
207
  # @type PlanId: String
208
208
  # @param PlanName: 备份计划自定义名称。
209
209
  # @type PlanName: String
210
- # @param LogBackupRetentionPeriod: 日志备份保留时长。
210
+ # @param LogBackupRetentionPeriod: 日志备份保留时长。单位:天
211
211
  # @type LogBackupRetentionPeriod: Integer
212
212
  # @param CreatedTime: 创建时间。
213
213
  # @type CreatedTime: String
@@ -305,11 +305,11 @@ module TencentCloud
305
305
  # @type Id: String
306
306
  # @param Name: 备份文件名称。
307
307
  # @type Name: String
308
- # @param BackupMethod: 备份方式:物理备份、逻辑备份。
308
+ # @param BackupMethod: 备份方式:physical - 物理备份、logical - 逻辑备份。
309
309
  # @type BackupMethod: String
310
- # @param BackupMode: 备份模式:自动备份、手动备份。
310
+ # @param BackupMode: 备份模式:automatic - 自动备份、manual - 手动备份。
311
311
  # @type BackupMode: String
312
- # @param State: 备份任务状态。
312
+ # @param State: 备份任务状态。枚举值:init、running、finished、failed、canceled
313
313
  # @type State: String
314
314
  # @param Size: 备份集大小,单位bytes。
315
315
  # @type Size: Integer
@@ -724,7 +724,7 @@ module TencentCloud
724
724
 
725
725
  # CreateDBInstanceNetworkAccess请求参数结构体
726
726
  class CreateDBInstanceNetworkAccessRequest < TencentCloud::Common::AbstractModel
727
- # @param DBInstanceId: 实例ID,形如:postgres-6bwgamo3
727
+ # @param DBInstanceId: 实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
728
728
  # @type DBInstanceId: String
729
729
  # @param VpcId: 私有网络统一 ID。
730
730
  # @type VpcId: String
@@ -732,7 +732,7 @@ module TencentCloud
732
732
  # @type SubnetId: String
733
733
  # @param IsAssignVip: 是否指定分配vip true-指定分配 false-自动分配。
734
734
  # @type IsAssignVip: Boolean
735
- # @param Vip: 目标VIP地址。
735
+ # @param Vip: 目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
736
736
  # @type Vip: String
737
737
 
738
738
  attr_accessor :DBInstanceId, :VpcId, :SubnetId, :IsAssignVip, :Vip
@@ -776,13 +776,16 @@ module TencentCloud
776
776
 
777
777
  # CreateDatabase请求参数结构体
778
778
  class CreateDatabaseRequest < TencentCloud::Common::AbstractModel
779
- # @param DBInstanceId: 实例ID,形如postgres-6fego161
779
+ # @param DBInstanceId: 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
780
780
  # @type DBInstanceId: String
781
- # @param DatabaseName: 创建的数据库名
781
+ # @param DatabaseName: 创建的数据库名。
782
+ # 名称规范:由字母(a-z, A-Z)、数字(0-9)、下划线(_)组成,以字母或(_)开头,最多63个字符。不能使用系统保留关键字,不能为postgres。
782
783
  # @type DatabaseName: String
783
- # @param DatabaseOwner: 数据库的所有者
784
+ # @param DatabaseOwner: 数据库的所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
784
785
  # @type DatabaseOwner: String
785
- # @param Encoding: 数据库的字符编码
786
+ # @param Encoding: 数据库的字符编码。
787
+ # 支持的常用字符集包括:UTF8、LATIN1、LATIN2、WIN1250、WIN1251、WIN1252、KOI8R、EUC_JP、EUC_KR
788
+ # 默认值:UTF8
786
789
  # @type Encoding: String
787
790
  # @param Collate: 数据库的排序规则
788
791
  # @type Collate: String
@@ -833,7 +836,7 @@ module TencentCloud
833
836
  # @type Zone: String
834
837
  # @param SpecCode: 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
835
838
  # @type SpecCode: String
836
- # @param Storage: 实例容量大小,单位:GB。
839
+ # @param Storage: 实例磁盘容量大小,单位:GB。该参数的设置步长为10
837
840
  # @type Storage: Integer
838
841
  # @param InstanceCount: 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。
839
842
  # @type InstanceCount: Integer
@@ -891,7 +894,7 @@ module TencentCloud
891
894
  # @type AutoVoucher: Integer
892
895
  # @param VoucherIds: 代金券ID列表,目前仅支持指定一张代金券。
893
896
  # @type VoucherIds: Array
894
- # @param ProjectId: 项目ID
897
+ # @param ProjectId: 项目ID。默认取之为0,表示归属默认项目。
895
898
  # @type ProjectId: Integer
896
899
  # @param ActivityId: 活动ID。
897
900
  # @type ActivityId: Integer
@@ -1107,11 +1110,11 @@ module TencentCloud
1107
1110
  # @param Zone: 实例所属主可用区, 如:ap-guangzhou-3;
1108
1111
  # 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
1109
1112
  # @type Zone: String
1110
- # @param MasterDBInstanceId: 只读实例的主实例ID
1113
+ # @param MasterDBInstanceId: 只读实例的主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1111
1114
  # @type MasterDBInstanceId: String
1112
1115
  # @param SpecCode: 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
1113
1116
  # @type SpecCode: String
1114
- # @param Storage: 实例容量大小,单位:GB。
1117
+ # @param Storage: 实例硬盘容量大小,单位:GB。该参数的设置步长为10
1115
1118
  # @type Storage: Integer
1116
1119
  # @param InstanceCount: 购买实例数量,取值范围:[1-10]。一次性购买支持最大数量10个,若超过该数量,可进行多次调用进行购买。
1117
1120
  # @type InstanceCount: Integer
@@ -1140,7 +1143,7 @@ module TencentCloud
1140
1143
  # <li>1:自动续费</li>
1141
1144
  # 默认值:0
1142
1145
  # @type AutoRenewFlag: Integer
1143
- # @param ProjectId: 项目ID
1146
+ # @param ProjectId: 项目ID。默认值为0,表示归属默认项目。
1144
1147
  # @type ProjectId: Integer
1145
1148
  # @param ActivityId: 优惠活动ID
1146
1149
  # @type ActivityId: Integer
@@ -1155,7 +1158,7 @@ module TencentCloud
1155
1158
  # <li>1:是</li>
1156
1159
  # 默认值:0
1157
1160
  # @type NeedSupportIpv6: Integer
1158
- # @param Name: 实例名(后续支持)
1161
+ # @param Name: 实例名。仅支持长度小于60的中文/英文/数字/"_"/"-"
1159
1162
  # @type Name: String
1160
1163
  # @param DBVersion: 不再需要指定,内核版本号与主实例保持一致
1161
1164
  # @type DBVersion: String
@@ -1164,8 +1167,8 @@ module TencentCloud
1164
1167
 
1165
1168
  attr_accessor :Zone, :MasterDBInstanceId, :SpecCode, :Storage, :InstanceCount, :Period, :VpcId, :SubnetId, :InstanceChargeType, :AutoVoucher, :VoucherIds, :AutoRenewFlag, :ProjectId, :ActivityId, :ReadOnlyGroupId, :TagList, :SecurityGroupIds, :NeedSupportIpv6, :Name, :DBVersion, :DedicatedClusterId
1166
1169
  extend Gem::Deprecate
1167
- deprecate :DBVersion, :none, 2025, 6
1168
- deprecate :DBVersion=, :none, 2025, 6
1170
+ deprecate :DBVersion, :none, 2025, 7
1171
+ deprecate :DBVersion=, :none, 2025, 7
1169
1172
 
1170
1173
  def initialize(zone=nil, masterdbinstanceid=nil, speccode=nil, storage=nil, instancecount=nil, period=nil, vpcid=nil, subnetid=nil, instancechargetype=nil, autovoucher=nil, voucherids=nil, autorenewflag=nil, projectid=nil, activityid=nil, readonlygroupid=nil, taglist=nil, securitygroupids=nil, needsupportipv6=nil, name=nil, dbversion=nil, dedicatedclusterid=nil)
1171
1174
  @Zone = zone
@@ -1249,7 +1252,7 @@ module TencentCloud
1249
1252
 
1250
1253
  # CreateReadOnlyGroupNetworkAccess请求参数结构体
1251
1254
  class CreateReadOnlyGroupNetworkAccessRequest < TencentCloud::Common::AbstractModel
1252
- # @param ReadOnlyGroupId: RO组ID,形如:pgro-4t9c6g7k
1255
+ # @param ReadOnlyGroupId: RO组ID,形如:pgrogrp-4t9c6g7k。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
1253
1256
  # @type ReadOnlyGroupId: String
1254
1257
  # @param VpcId: 私有网络统一 ID。
1255
1258
  # @type VpcId: String
@@ -1257,7 +1260,7 @@ module TencentCloud
1257
1260
  # @type SubnetId: String
1258
1261
  # @param IsAssignVip: 是否指定分配vip true-指定分配 false-自动分配。
1259
1262
  # @type IsAssignVip: Boolean
1260
- # @param Vip: 目标VIP地址。
1263
+ # @param Vip: 目标VIP地址。当不指定该参数,且IsAssignVip为true时,默认自动分配Vip。
1261
1264
  # @type Vip: String
1262
1265
 
1263
1266
  attr_accessor :ReadOnlyGroupId, :VpcId, :SubnetId, :IsAssignVip, :Vip
@@ -1301,25 +1304,25 @@ module TencentCloud
1301
1304
 
1302
1305
  # CreateReadOnlyGroup请求参数结构体
1303
1306
  class CreateReadOnlyGroupRequest < TencentCloud::Common::AbstractModel
1304
- # @param MasterDBInstanceId: 主实例ID
1307
+ # @param MasterDBInstanceId: 主实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1305
1308
  # @type MasterDBInstanceId: String
1306
- # @param Name: 只读组名称
1309
+ # @param Name: 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"。
1307
1310
  # @type Name: String
1308
- # @param ProjectId: 项目ID
1311
+ # @param ProjectId: 项目ID。默认值为0,表示归属于默认项目。
1309
1312
  # @type ProjectId: Integer
1310
- # @param VpcId: 私有网络ID
1313
+ # @param VpcId: 私有网络ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
1311
1314
  # @type VpcId: String
1312
- # @param SubnetId: 子网ID
1315
+ # @param SubnetId: 子网ID。注:默认使用基础网络,当前不支持基础网络,故该参数必填。
1313
1316
  # @type SubnetId: String
1314
- # @param ReplayLagEliminate: 延迟时间大小开关:0关、1
1317
+ # @param ReplayLagEliminate: 延迟时间大小开关:0关、1开。该参数必填。
1315
1318
  # @type ReplayLagEliminate: Integer
1316
- # @param ReplayLatencyEliminate: 延迟空间大小开关: 0关、1
1319
+ # @param ReplayLatencyEliminate: 延迟空间大小开关: 0关、1开。该参数的填写需要与ReplayLagEliminate一致。
1317
1320
  # @type ReplayLatencyEliminate: Integer
1318
- # @param MaxReplayLag: 延迟时间大小阈值,单位ms
1321
+ # @param MaxReplayLag: 延迟时间大小阈值,取值为正整数,单位s。当ReplayLagEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数需填0。
1319
1322
  # @type MaxReplayLag: Integer
1320
- # @param MaxReplayLatency: 延迟空间大小阈值,单位MB
1323
+ # @param MaxReplayLatency: 延迟空间大小阈值,取值为正整数,单位MB。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLatencyEliminate为0时,该参数需填0。
1321
1324
  # @type MaxReplayLatency: Integer
1322
- # @param MinDelayEliminateReserve: 延迟剔除最小保留实例数
1325
+ # @param MinDelayEliminateReserve: 延迟剔除最小保留实例数。取值范围[0,100]。当ReplayLatencyEliminate为1时,该参数必填;当ReplayLagEliminate为0时,该参数无效。
1323
1326
  # @type MinDelayEliminateReserve: Integer
1324
1327
  # @param SecurityGroupIds: 安全组id
1325
1328
  # @type SecurityGroupIds: Array
@@ -1919,17 +1922,17 @@ module TencentCloud
1919
1922
  # @type StandbyDedicatedClusterSet: Array
1920
1923
  # @param InstanceCount: 实例数量
1921
1924
  # @type InstanceCount: Integer
1922
- # @param CpuTotal: Cpu总量
1925
+ # @param CpuTotal: Cpu总数量
1923
1926
  # @type CpuTotal: Integer
1924
1927
  # @param CpuAvailable: Cpu可用数量
1925
1928
  # @type CpuAvailable: Integer
1926
- # @param MemTotal: 内存总量
1929
+ # @param MemTotal: 内存总量,单位GB
1927
1930
  # @type MemTotal: Integer
1928
- # @param MemAvailable: 内存可用量
1931
+ # @param MemAvailable: 内存可用量,单位GB
1929
1932
  # @type MemAvailable: Integer
1930
- # @param DiskTotal: 磁盘总量
1933
+ # @param DiskTotal: 磁盘总量,单位GB
1931
1934
  # @type DiskTotal: Integer
1932
- # @param DiskAvailable: 磁盘可用量
1935
+ # @param DiskAvailable: 磁盘可用量,单位GB
1933
1936
  # @type DiskAvailable: Integer
1934
1937
 
1935
1938
  attr_accessor :DedicatedClusterId, :Name, :Zone, :StandbyDedicatedClusterSet, :InstanceCount, :CpuTotal, :CpuAvailable, :MemTotal, :MemAvailable, :DiskTotal, :DiskAvailable
@@ -1965,9 +1968,9 @@ module TencentCloud
1965
1968
 
1966
1969
  # DeleteAccount请求参数结构体
1967
1970
  class DeleteAccountRequest < TencentCloud::Common::AbstractModel
1968
- # @param DBInstanceId: 实例ID。
1971
+ # @param DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
1969
1972
  # @type DBInstanceId: String
1970
- # @param UserName: 删除的账号名称。
1973
+ # @param UserName: 删除的账号名称。 可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
1971
1974
  # @type UserName: String
1972
1975
 
1973
1976
  attr_accessor :DBInstanceId, :UserName
@@ -2157,7 +2160,7 @@ module TencentCloud
2157
2160
 
2158
2161
  # DeleteParameterTemplate请求参数结构体
2159
2162
  class DeleteParameterTemplateRequest < TencentCloud::Common::AbstractModel
2160
- # @param TemplateId: 参数模板ID,用于唯一确认待操作的参数模板
2163
+ # @param TemplateId: 参数模板ID,用于唯一确认待操作的参数模板。可通过[DescribeParameterTemplates](https://cloud.tencent.com/document/api/409/84067)接口获取
2161
2164
  # @type TemplateId: String
2162
2165
 
2163
2166
  attr_accessor :TemplateId
@@ -2273,9 +2276,9 @@ module TencentCloud
2273
2276
 
2274
2277
  # DescribeAccountPrivileges请求参数结构体
2275
2278
  class DescribeAccountPrivilegesRequest < TencentCloud::Common::AbstractModel
2276
- # @param DBInstanceId: 实例ID。
2279
+ # @param DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2277
2280
  # @type DBInstanceId: String
2278
- # @param UserName: 查询此账号对某数据库对象所拥有的权限信息。
2281
+ # @param UserName: 查询此账号对某数据库对象所拥有的权限信息。账号名可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
2279
2282
  # @type UserName: String
2280
2283
  # @param DatabaseObjectSet: 要查询的数据库对象信息
2281
2284
  # @type DatabaseObjectSet: Array
@@ -2394,7 +2397,7 @@ module TencentCloud
2394
2397
 
2395
2398
  # DescribeAvailableRecoveryTime请求参数结构体
2396
2399
  class DescribeAvailableRecoveryTimeRequest < TencentCloud::Common::AbstractModel
2397
- # @param DBInstanceId: 实例ID
2400
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2398
2401
  # @type DBInstanceId: String
2399
2402
 
2400
2403
  attr_accessor :DBInstanceId
@@ -2798,13 +2801,13 @@ module TencentCloud
2798
2801
 
2799
2802
  # DescribeClasses请求参数结构体
2800
2803
  class DescribeClassesRequest < TencentCloud::Common::AbstractModel
2801
- # @param Zone: 可用区ID。可以通过接口DescribeZones获取。
2804
+ # @param Zone: 可用区名称。可以通过接口[DescribeZones](https://cloud.tencent.com/document/product/409/16769)获取。
2802
2805
  # @type Zone: String
2803
2806
  # @param DBEngine: 数据库引擎,支持:
2804
2807
  # 1、postgresql(云数据库PostgreSQL);
2805
2808
  # 2、mssql_compatible(MSSQL兼容-云数据库PostgreSQL);
2806
2809
  # @type DBEngine: String
2807
- # @param DBMajorVersion: 数据库主版本号。例如12,13,可以通过接口DescribeDBVersions获取。
2810
+ # @param DBMajorVersion: 数据库主版本号。例如12,13,可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取。
2808
2811
  # @type DBMajorVersion: String
2809
2812
 
2810
2813
  attr_accessor :Zone, :DBEngine, :DBMajorVersion
@@ -2966,7 +2969,7 @@ module TencentCloud
2966
2969
 
2967
2970
  # DescribeDBErrlogs请求参数结构体
2968
2971
  class DescribeDBErrlogsRequest < TencentCloud::Common::AbstractModel
2969
- # @param DBInstanceId: 实例ID。
2972
+ # @param DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
2970
2973
  # @type DBInstanceId: String
2971
2974
  # @param StartTime: 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
2972
2975
  # @type StartTime: String
@@ -3142,7 +3145,7 @@ module TencentCloud
3142
3145
 
3143
3146
  # DescribeDBInstanceParameters请求参数结构体
3144
3147
  class DescribeDBInstanceParametersRequest < TencentCloud::Common::AbstractModel
3145
- # @param DBInstanceId: 实例ID
3148
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3146
3149
  # @type DBInstanceId: String
3147
3150
  # @param ParamName: 查询指定参数详情。ParamName为空或不传,默认返回全部参数列表
3148
3151
  # @type ParamName: String
@@ -3193,7 +3196,7 @@ module TencentCloud
3193
3196
 
3194
3197
  # DescribeDBInstanceSSLConfig请求参数结构体
3195
3198
  class DescribeDBInstanceSSLConfigRequest < TencentCloud::Common::AbstractModel
3196
- # @param DBInstanceId: 实例ID,形如postgres-6bwgamo3
3199
+ # @param DBInstanceId: 实例ID,形如postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3197
3200
  # @type DBInstanceId: String
3198
3201
 
3199
3202
  attr_accessor :DBInstanceId
@@ -3237,9 +3240,9 @@ module TencentCloud
3237
3240
 
3238
3241
  # DescribeDBInstanceSecurityGroups请求参数结构体
3239
3242
  class DescribeDBInstanceSecurityGroupsRequest < TencentCloud::Common::AbstractModel
3240
- # @param DBInstanceId: 实例IDDBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
3243
+ # @param DBInstanceId: 实例ID,可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果都传,忽略ReadOnlyGroupId
3241
3244
  # @type DBInstanceId: String
3242
- # @param ReadOnlyGroupId: 只读组IDDBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
3245
+ # @param ReadOnlyGroupId: 只读组ID,可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取。DBInstanceId和ReadOnlyGroupId至少传一个;如果要查询只读组关联的安全组,只传ReadOnlyGroupId
3243
3246
  # @type ReadOnlyGroupId: String
3244
3247
 
3245
3248
  attr_accessor :DBInstanceId, :ReadOnlyGroupId
@@ -3534,7 +3537,7 @@ module TencentCloud
3534
3537
 
3535
3538
  # DescribeDatabaseObjects请求参数结构体
3536
3539
  class DescribeDatabaseObjectsRequest < TencentCloud::Common::AbstractModel
3537
- # @param DBInstanceId: 实例ID。
3540
+ # @param DBInstanceId: 实例ID。 可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3538
3541
  # @type DBInstanceId: String
3539
3542
  # @param ObjectType: 查询的对象类型。支持查询的数据对象有:database,schema,sequence,procedure,type,function,table,view,matview,column。
3540
3543
  # @type ObjectType: String
@@ -3720,7 +3723,7 @@ module TencentCloud
3720
3723
 
3721
3724
  # DescribeDefaultParameters请求参数结构体
3722
3725
  class DescribeDefaultParametersRequest < TencentCloud::Common::AbstractModel
3723
- # @param DBMajorVersion: 数据库版本,大版本号,例如11,12,13
3726
+ # @param DBMajorVersion: 数据库版本,大版本号,例如11,12,13。可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)接口获取
3724
3727
  # @type DBMajorVersion: String
3725
3728
  # @param DBEngine: 数据库引擎,例如:postgresql,mssql_compatible
3726
3729
  # @type DBEngine: String
@@ -3772,7 +3775,7 @@ module TencentCloud
3772
3775
 
3773
3776
  # DescribeEncryptionKeys请求参数结构体
3774
3777
  class DescribeEncryptionKeysRequest < TencentCloud::Common::AbstractModel
3775
- # @param DBInstanceId: 实例ID
3778
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3776
3779
  # @type DBInstanceId: String
3777
3780
 
3778
3781
  attr_accessor :DBInstanceId
@@ -3897,7 +3900,7 @@ module TencentCloud
3897
3900
 
3898
3901
  # DescribeMaintainTimeWindow请求参数结构体
3899
3902
  class DescribeMaintainTimeWindowRequest < TencentCloud::Common::AbstractModel
3900
- # @param DBInstanceId: 实例ID
3903
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
3901
3904
  # @type DBInstanceId: String
3902
3905
 
3903
3906
  attr_accessor :DBInstanceId
@@ -4130,7 +4133,7 @@ module TencentCloud
4130
4133
 
4131
4134
  # DescribeParamsEvent请求参数结构体
4132
4135
  class DescribeParamsEventRequest < TencentCloud::Common::AbstractModel
4133
- # @param DBInstanceId: 实例DB ID
4136
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4134
4137
  # @type DBInstanceId: String
4135
4138
 
4136
4139
  attr_accessor :DBInstanceId
@@ -4413,7 +4416,7 @@ module TencentCloud
4413
4416
 
4414
4417
  # DescribeSlowQueryAnalysis请求参数结构体
4415
4418
  class DescribeSlowQueryAnalysisRequest < TencentCloud::Common::AbstractModel
4416
- # @param DBInstanceId: 实例ID
4419
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4417
4420
  # @type DBInstanceId: String
4418
4421
  # @param StartTime: 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
4419
4422
  # @type StartTime: String
@@ -4484,7 +4487,7 @@ module TencentCloud
4484
4487
 
4485
4488
  # DescribeSlowQueryList请求参数结构体
4486
4489
  class DescribeSlowQueryListRequest < TencentCloud::Common::AbstractModel
4487
- # @param DBInstanceId: 实例ID
4490
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
4488
4491
  # @type DBInstanceId: String
4489
4492
  # @param StartTime: 查询起始时间,形如2018-01-01 00:00:00。日志保留时间默认为7天,起始时间不能超出保留时间范围。
4490
4493
  # @type StartTime: String
@@ -4750,11 +4753,11 @@ module TencentCloud
4750
4753
 
4751
4754
  # DisIsolateDBInstances请求参数结构体
4752
4755
  class DisIsolateDBInstancesRequest < TencentCloud::Common::AbstractModel
4753
- # @param DBInstanceIdSet: 实例ID列表。注意:当前已不支持同时解隔离多个实例,这里只能传入单个实例ID。
4756
+ # @param DBInstanceIdSet: 实例ID列表。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时解隔离多个实例。
4754
4757
  # @type DBInstanceIdSet: Array
4755
4758
  # @param Period: 购买时长,单位:月。
4756
4759
  # <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
4757
- # <li>后付费:只支持1</li>
4760
+ # <li>后付费:该参数不生效</li>
4758
4761
  # @type Period: Integer
4759
4762
  # @param AutoVoucher: 是否使用代金券:
4760
4763
  # <li>true:使用</li>
@@ -4897,7 +4900,7 @@ module TencentCloud
4897
4900
  # @type ModifyTime: String
4898
4901
  # @param EffectiveTime: 后台参数生效开始时间
4899
4902
  # @type EffectiveTime: String
4900
- # @param State: 修改状态
4903
+ # @param State: 修改状态。枚举值:in progress、success、paused
4901
4904
  # @type State: String
4902
4905
  # @param Operator: 操作者(一般为用户sub UIN)
4903
4906
  # @type Operator: String
@@ -4984,11 +4987,11 @@ module TencentCloud
4984
4987
 
4985
4988
  # InquiryPriceCreateDBInstances请求参数结构体
4986
4989
  class InquiryPriceCreateDBInstancesRequest < TencentCloud::Common::AbstractModel
4987
- # @param Zone: 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。
4990
+ # @param Zone: 可用区名称。该参数可以通过调用[ DescribeZones](https://cloud.tencent.com/document/product/409/16769) 接口的返回值中的Zone字段来获取。
4988
4991
  # @type Zone: String
4989
- # @param SpecCode: 规格ID。该参数可以通过调用DescribeClasses接口的返回值中的SpecCode字段来获取。
4992
+ # @param SpecCode: 规格ID。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/product/409/89019)接口的返回值中的SpecCode字段来获取。
4990
4993
  # @type SpecCode: String
4991
- # @param Storage: 存储容量大小,单位:GB。
4994
+ # @param Storage: 存储容量大小,单位:GB。该参数的设置步长为10
4992
4995
  # @type Storage: Integer
4993
4996
  # @param InstanceCount: 实例数量。目前最大数量不超过100,如需一次性创建更多实例,请联系客服支持。
4994
4997
  # @type InstanceCount: Integer
@@ -4996,7 +4999,8 @@ module TencentCloud
4996
4999
  # @type Period: Integer
4997
5000
  # @param Pid: 【弃字段,不再生效】,计费ID。该参数可以通过调用DescribeProductConfig接口的返回值中的Pid字段来获取。
4998
5001
  # @type Pid: Integer
4999
- # @param InstanceChargeType: 实例计费类型。目前只支持:PREPAID(预付费,即包年包月)。
5002
+ # @param InstanceChargeType: 实例计费类型。目前支持:PREPAID(预付费,即包年包月)和 POSTPAID(按量计费)。
5003
+ # 默认值:PREPAID
5000
5004
  # @type InstanceChargeType: String
5001
5005
  # @param InstanceType: 实例类型,默认primary,支持如下:
5002
5006
  # primary(双机高可用(一主一从))
@@ -5116,17 +5120,18 @@ module TencentCloud
5116
5120
  # @type Storage: Integer
5117
5121
  # @param Memory: 实例的内存大小,单位GB
5118
5122
  # @type Memory: Integer
5119
- # @param DBInstanceId: 实例ID,形如postgres-hez4fh0v
5123
+ # @param DBInstanceId: 实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5120
5124
  # @type DBInstanceId: String
5121
5125
  # @param InstanceChargeType: 实例计费类型。
5122
5126
  # @type InstanceChargeType: String
5123
- # @param Cpu: 实例的Cpu大小,单位Core
5127
+ # @param Cpu: 实例的Cpu大小,单位Core
5128
+ # 不传入此参数时,默认根据Memory确定的售卖规格所对应的Cpu进行设置。如Memory为2,支持的售卖规格有1核2GiB,则不传入Cpu时,Cpu默认为1。
5124
5129
  # @type Cpu: Integer
5125
5130
 
5126
5131
  attr_accessor :Storage, :Memory, :DBInstanceId, :InstanceChargeType, :Cpu
5127
5132
  extend Gem::Deprecate
5128
- deprecate :InstanceChargeType, :none, 2025, 6
5129
- deprecate :InstanceChargeType=, :none, 2025, 6
5133
+ deprecate :InstanceChargeType, :none, 2025, 7
5134
+ deprecate :InstanceChargeType=, :none, 2025, 7
5130
5135
 
5131
5136
  def initialize(storage=nil, memory=nil, dbinstanceid=nil, instancechargetype=nil, cpu=nil)
5132
5137
  @Storage = storage
@@ -5175,7 +5180,7 @@ module TencentCloud
5175
5180
 
5176
5181
  # IsolateDBInstances请求参数结构体
5177
5182
  class IsolateDBInstancesRequest < TencentCloud::Common::AbstractModel
5178
- # @param DBInstanceIdSet: 实例ID集合。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
5183
+ # @param DBInstanceIdSet: 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。注意:当前已不支持同时隔离多个实例,这里只能传入单个实例ID。
5179
5184
  # @type DBInstanceIdSet: Array
5180
5185
 
5181
5186
  attr_accessor :DBInstanceIdSet
@@ -5249,11 +5254,11 @@ module TencentCloud
5249
5254
  # @type Id: String
5250
5255
  # @param Name: 备份文件名称。
5251
5256
  # @type Name: String
5252
- # @param BackupMethod: 备份方式:物理备份、逻辑备份。
5257
+ # @param BackupMethod: 备份方式。枚举值,physical - 物理备份;logical - 逻辑备份。
5253
5258
  # @type BackupMethod: String
5254
- # @param BackupMode: 备份模式:自动备份、手动备份。
5259
+ # @param BackupMode: 备份模式。枚举值,manual - 手动备份;automatic - 自动备份 。
5255
5260
  # @type BackupMode: String
5256
- # @param State: 备份任务状态。
5261
+ # @param State: 备份任务状态。枚举值:init、running、finished、failed、canceled
5257
5262
  # @type State: String
5258
5263
  # @param Size: 备份集大小,单位bytes。
5259
5264
  # @type Size: Integer
@@ -5532,7 +5537,7 @@ module TencentCloud
5532
5537
 
5533
5538
  # ModifyDBInstanceChargeType请求参数结构体
5534
5539
  class ModifyDBInstanceChargeTypeRequest < TencentCloud::Common::AbstractModel
5535
- # @param DBInstanceId: 实例ID,形如postgres-6fego161
5540
+ # @param DBInstanceId: 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5536
5541
  # @type DBInstanceId: String
5537
5542
  # @param InstanceChargeType: 实例计费类型,目前支持:
5538
5543
  # <li>PREPAID:预付费,即包年包月</li>
@@ -5595,7 +5600,7 @@ module TencentCloud
5595
5600
 
5596
5601
  # ModifyDBInstanceDeployment请求参数结构体
5597
5602
  class ModifyDBInstanceDeploymentRequest < TencentCloud::Common::AbstractModel
5598
- # @param DBInstanceId: 实例ID
5603
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5599
5604
  # @type DBInstanceId: String
5600
5605
  # @param DBNodeSet: 实例节点部署信息,支持多可用区部署时需要指定每个节点的部署可用区信息。
5601
5606
  # 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
@@ -5604,7 +5609,6 @@ module TencentCloud
5604
5609
  # <li>0:立即切换 </li>
5605
5610
  # <li>1:指定时间切换</li>
5606
5611
  # <li>2:维护时间窗口内切换</li>
5607
- # 默认值:0
5608
5612
  # @type SwitchTag: Integer
5609
5613
  # @param SwitchStartTime: 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。当SwitchTag为0或2时,该参数失效。
5610
5614
  # @type SwitchStartTime: String
@@ -5655,19 +5659,19 @@ module TencentCloud
5655
5659
 
5656
5660
  # ModifyDBInstanceHAConfig请求参数结构体
5657
5661
  class ModifyDBInstanceHAConfigRequest < TencentCloud::Common::AbstractModel
5658
- # @param DBInstanceId: 实例ID
5662
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5659
5663
  # @type DBInstanceId: String
5660
5664
  # @param SyncMode: 主从同步方式:
5661
- # <li>Semi-sync:半同步
5662
- # <li>Async:异步
5665
+ # <li>Semi-sync:半同步</li>
5666
+ # <li>Async:异步</li>
5663
5667
  # @type SyncMode: String
5664
5668
  # @param MaxStandbyLatency: 高可用备机最大延迟数据量。备节点延迟数据量小于等于该值,且备节点延迟时间小于等于MaxStandbyLag时,可以切换为主节点。
5665
- # <li>单位:byte
5666
- # <li>参数范围:[1073741824, 322122547200]
5669
+ # <li>单位:byte</li>
5670
+ # <li>参数范围:[1073741824, 322122547200]</li>
5667
5671
  # @type MaxStandbyLatency: Integer
5668
5672
  # @param MaxStandbyLag: 高可用备机最大延迟时间。备节点延迟时间小于等于该值,且备节点延迟数据量小于等于MaxStandbyLatency时,可以切换为主节点。
5669
- # <li>单位:s
5670
- # <li>参数范围:[5, 10]
5673
+ # <li>单位:s</li>
5674
+ # <li>参数范围:[5, 10]</li>
5671
5675
  # @type MaxStandbyLag: Integer
5672
5676
  # @param MaxSyncStandbyLatency: 同步备机最大延迟数据量。备机延迟数据量小于等于该值,且该备机延迟时间小于等于MaxSyncStandbyLag时,则该备机采用同步复制;否则,采用异步复制。
5673
5677
  # 该参数值针对SyncMode设置为Semi-sync的实例有效。
@@ -5719,9 +5723,9 @@ module TencentCloud
5719
5723
 
5720
5724
  # ModifyDBInstanceName请求参数结构体
5721
5725
  class ModifyDBInstanceNameRequest < TencentCloud::Common::AbstractModel
5722
- # @param DBInstanceId: 数据库实例ID,形如postgres-6fego161
5726
+ # @param DBInstanceId: 数据库实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5723
5727
  # @type DBInstanceId: String
5724
- # @param InstanceName: 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-",不指定实例名称则默认显示"未命名"
5728
+ # @param InstanceName: 实例名称,仅支持长度小于60的中文/英文/数字/"_"/"-"。
5725
5729
  # @type InstanceName: String
5726
5730
 
5727
5731
  attr_accessor :DBInstanceId, :InstanceName
@@ -5755,7 +5759,7 @@ module TencentCloud
5755
5759
 
5756
5760
  # ModifyDBInstanceParameters请求参数结构体
5757
5761
  class ModifyDBInstanceParametersRequest < TencentCloud::Common::AbstractModel
5758
- # @param DBInstanceId: 实例ID
5762
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5759
5763
  # @type DBInstanceId: String
5760
5764
  # @param ParamList: 待修改参数及期望值。
5761
5765
  # @type ParamList: Array
@@ -5798,7 +5802,7 @@ module TencentCloud
5798
5802
 
5799
5803
  # ModifyDBInstanceReadOnlyGroup请求参数结构体
5800
5804
  class ModifyDBInstanceReadOnlyGroupRequest < TencentCloud::Common::AbstractModel
5801
- # @param DBInstanceId: 实例ID
5805
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5802
5806
  # @type DBInstanceId: String
5803
5807
  # @param ReadOnlyGroupId: 当前实例所在只读组ID
5804
5808
  # @type ReadOnlyGroupId: String
@@ -5842,9 +5846,9 @@ module TencentCloud
5842
5846
 
5843
5847
  # ModifyDBInstanceSSLConfig请求参数结构体
5844
5848
  class ModifyDBInstanceSSLConfigRequest < TencentCloud::Common::AbstractModel
5845
- # @param DBInstanceId: 实例 ID
5849
+ # @param DBInstanceId: 实例 ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5846
5850
  # @type DBInstanceId: String
5847
- # @param SSLEnabled: 开启或关闭SSL
5851
+ # @param SSLEnabled: 开启或关闭SSL。true - 开启 ;false - 关闭。
5848
5852
  # @type SSLEnabled: Boolean
5849
5853
  # @param ConnectAddress: SSL证书保护的唯一连接地址,若为主实例,可设置为内外网IP地址;若为只读实例,可设置为实例IP或只读组IP。在开启SSL或修改SSL保护的连接地址时,该参数为必传项;在关闭SSL时,该参数将被忽略。
5850
5854
  # @type ConnectAddress: String
@@ -5928,11 +5932,11 @@ module TencentCloud
5928
5932
 
5929
5933
  # ModifyDBInstanceSpec请求参数结构体
5930
5934
  class ModifyDBInstanceSpecRequest < TencentCloud::Common::AbstractModel
5931
- # @param DBInstanceId: 实例ID,形如:postgres-6bwgamo3
5935
+ # @param DBInstanceId: 实例ID,形如:postgres-6bwgamo3。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
5932
5936
  # @type DBInstanceId: String
5933
5937
  # @param Memory: 修改后的实例内存大小,单位GiB。
5934
5938
  # @type Memory: Integer
5935
- # @param Storage: 修改后的实例磁盘大小,单位GiB。
5939
+ # @param Storage: 修改后的实例磁盘大小,单位GiB。该参数的设置步长为10
5936
5940
  # @type Storage: Integer
5937
5941
  # @param AutoVoucher: 是否自动使用代金券:
5938
5942
  # <li>0:否</li>
@@ -5953,7 +5957,7 @@ module TencentCloud
5953
5957
  # @type SwitchStartTime: String
5954
5958
  # @param SwitchEndTime: 切换截止时间,时间格式:HH:MM:SS,例如:01:30:00。当SwitchTag为0或2时,该参数失效。
5955
5959
  # @type SwitchEndTime: String
5956
- # @param Cpu: 修改后的实例CPU大小,单位Core。
5960
+ # @param Cpu: 修改后的实例CPU大小,单位Core。不填写该参数时,默认根据Memory确定Cpu大小。如Memory为2,支持的规格有1核2GiB,则不传入Cpu时,Cpu默认为1
5957
5961
  # @type Cpu: Integer
5958
5962
 
5959
5963
  attr_accessor :DBInstanceId, :Memory, :Storage, :AutoVoucher, :VoucherIds, :ActivityId, :SwitchTag, :SwitchStartTime, :SwitchEndTime, :Cpu
@@ -6011,9 +6015,9 @@ module TencentCloud
6011
6015
 
6012
6016
  # ModifyDBInstancesProject请求参数结构体
6013
6017
  class ModifyDBInstancesProjectRequest < TencentCloud::Common::AbstractModel
6014
- # @param DBInstanceIdSet: 实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
6018
+ # @param DBInstanceIdSet: 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。支持同时操作多个实例。
6015
6019
  # @type DBInstanceIdSet: Array
6016
- # @param ProjectId: 所属新项目的ID
6020
+ # @param ProjectId: 所属新项目的ID。可通过[DescribeProject](https://cloud.tencent.com/document/api/651/78725)获取
6017
6021
  # @type ProjectId: String
6018
6022
 
6019
6023
  attr_accessor :DBInstanceIdSet, :ProjectId
@@ -6051,11 +6055,11 @@ module TencentCloud
6051
6055
 
6052
6056
  # ModifyDatabaseOwner请求参数结构体
6053
6057
  class ModifyDatabaseOwnerRequest < TencentCloud::Common::AbstractModel
6054
- # @param DBInstanceId: 实例ID
6058
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6055
6059
  # @type DBInstanceId: String
6056
- # @param DatabaseName: 数据库名称
6060
+ # @param DatabaseName: 数据库名称。可通过[DescribeDatabases](https://cloud.tencent.com/document/api/409/43353)接口获取
6057
6061
  # @type DatabaseName: String
6058
- # @param DatabaseOwner: 数据库新所有者
6062
+ # @param DatabaseOwner: 数据库新所有者。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
6059
6063
  # @type DatabaseOwner: String
6060
6064
 
6061
6065
  attr_accessor :DBInstanceId, :DatabaseName, :DatabaseOwner
@@ -6091,11 +6095,11 @@ module TencentCloud
6091
6095
 
6092
6096
  # ModifyMaintainTimeWindow请求参数结构体
6093
6097
  class ModifyMaintainTimeWindowRequest < TencentCloud::Common::AbstractModel
6094
- # @param DBInstanceId: 实例ID
6098
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6095
6099
  # @type DBInstanceId: String
6096
6100
  # @param MaintainStartTime: 维护开始时间。时区为东八区(UTC+8)
6097
6101
  # @type MaintainStartTime: String
6098
- # @param MaintainDuration: 维护持续时间。单位:小时
6102
+ # @param MaintainDuration: 维护持续时间。单位:小时。取值范围:[1,4]
6099
6103
  # @type MaintainDuration: Integer
6100
6104
  # @param MaintainWeekDays: 维护周期
6101
6105
  # @type MaintainWeekDays: Array
@@ -6257,21 +6261,21 @@ module TencentCloud
6257
6261
 
6258
6262
  # ModifyReadOnlyGroupConfig请求参数结构体
6259
6263
  class ModifyReadOnlyGroupConfigRequest < TencentCloud::Common::AbstractModel
6260
- # @param ReadOnlyGroupId: 只读组ID
6264
+ # @param ReadOnlyGroupId: 只读组ID
6261
6265
  # @type ReadOnlyGroupId: String
6262
- # @param ReadOnlyGroupName: 只读组名称
6266
+ # @param ReadOnlyGroupName: 只读组名称。仅支持长度小于60的中文/英文/数字/"_"/"-"
6263
6267
  # @type ReadOnlyGroupName: String
6264
6268
  # @param ReplayLagEliminate: 延迟时间配置开关:0关、1开
6265
6269
  # @type ReplayLagEliminate: Integer
6266
6270
  # @param ReplayLatencyEliminate: 延迟日志大小配置开关:0关、1开
6267
6271
  # @type ReplayLatencyEliminate: Integer
6268
- # @param MaxReplayLatency: 延迟日志大小阈值,单位MB
6272
+ # @param MaxReplayLatency: 延迟日志大小阈值,单位MB。当开启延迟日志大小配置,应输入正整数
6269
6273
  # @type MaxReplayLatency: Integer
6270
- # @param MaxReplayLag: 延迟时间大小阈值,单位ms
6274
+ # @param MaxReplayLag: 延迟时间大小阈值,单位s。当开启延迟时间配置时,应输入正整数。
6271
6275
  # @type MaxReplayLag: Integer
6272
6276
  # @param Rebalance: 自动负载均衡开关:0关、1开
6273
6277
  # @type Rebalance: Integer
6274
- # @param MinDelayEliminateReserve: 延迟剔除最小保留实例数
6278
+ # @param MinDelayEliminateReserve: 延迟剔除最小保留实例数。取值范围[0,100]
6275
6279
  # @type MinDelayEliminateReserve: Integer
6276
6280
 
6277
6281
  attr_accessor :ReadOnlyGroupId, :ReadOnlyGroupName, :ReplayLagEliminate, :ReplayLatencyEliminate, :MaxReplayLatency, :MaxReplayLag, :Rebalance, :MinDelayEliminateReserve
@@ -6317,7 +6321,7 @@ module TencentCloud
6317
6321
 
6318
6322
  # ModifySwitchTimePeriod请求参数结构体
6319
6323
  class ModifySwitchTimePeriodRequest < TencentCloud::Common::AbstractModel
6320
- # @param DBInstanceId: 处于等待切换状态中的实例ID
6324
+ # @param DBInstanceId: 处于等待切换状态中的实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
6321
6325
  # @type DBInstanceId: String
6322
6326
  # @param SwitchTag: 入参取值为 0 ,代表立即切换。
6323
6327
  # @type SwitchTag: Integer
@@ -6469,9 +6473,10 @@ module TencentCloud
6469
6473
 
6470
6474
  # OpenDBExtranetAccess请求参数结构体
6471
6475
  class OpenDBExtranetAccessRequest < TencentCloud::Common::AbstractModel
6472
- # @param DBInstanceId: 实例ID,形如postgres-hez4fh0v
6476
+ # @param DBInstanceId: 实例ID,形如postgres-hez4fh0v。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。
6473
6477
  # @type DBInstanceId: String
6474
6478
  # @param IsIpv6: 是否开通Ipv6外网,1:是,0:否
6479
+ # 默认值:0
6475
6480
  # @type IsIpv6: Integer
6476
6481
 
6477
6482
  attr_accessor :DBInstanceId, :IsIpv6
@@ -7029,9 +7034,9 @@ module TencentCloud
7029
7034
 
7030
7035
  # RemoveDBInstanceFromReadOnlyGroup请求参数结构体
7031
7036
  class RemoveDBInstanceFromReadOnlyGroupRequest < TencentCloud::Common::AbstractModel
7032
- # @param DBInstanceId: 实例ID
7037
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7033
7038
  # @type DBInstanceId: String
7034
- # @param ReadOnlyGroupId: 只读组ID
7039
+ # @param ReadOnlyGroupId: 只读组ID。可通过[DescribeReadOnlyGroups](https://cloud.tencent.com/document/api/409/52599)接口获取
7035
7040
  # @type ReadOnlyGroupId: String
7036
7041
 
7037
7042
  attr_accessor :DBInstanceId, :ReadOnlyGroupId
@@ -7069,11 +7074,10 @@ module TencentCloud
7069
7074
 
7070
7075
  # RenewInstance请求参数结构体
7071
7076
  class RenewInstanceRequest < TencentCloud::Common::AbstractModel
7072
- # @param DBInstanceId: 实例ID,形如postgres-6fego161
7077
+ # @param DBInstanceId: 实例ID,形如postgres-6fego161。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)实例。
7073
7078
  # @type DBInstanceId: String
7074
7079
  # @param Period: 购买时长,单位:月。
7075
7080
  # <li>预付费:支持1,2,3,4,5,6,7,8,9,10,11,12,24,36</li>
7076
- # <li>后付费:只支持1</li>
7077
7081
  # @type Period: Integer
7078
7082
  # @param AutoVoucher: 是否自动使用代金券:
7079
7083
  # <li>0:否</li>
@@ -7122,11 +7126,19 @@ module TencentCloud
7122
7126
 
7123
7127
  # ResetAccountPassword请求参数结构体
7124
7128
  class ResetAccountPasswordRequest < TencentCloud::Common::AbstractModel
7125
- # @param DBInstanceId: 实例ID,形如postgres-4wdeb0zv
7129
+ # @param DBInstanceId: 实例ID,形如postgres-4wdeb0zv。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7126
7130
  # @type DBInstanceId: String
7127
- # @param UserName: 实例账户名
7131
+ # @param UserName: 实例账户名。可通过[DescribeAccounts](https://cloud.tencent.com/document/api/409/18109)接口获取
7128
7132
  # @type UserName: String
7129
- # @param Password: UserName账户对应的新密码
7133
+ # @param Password: UserName账户对应的新密码。
7134
+ # 密码设置规则如下:
7135
+ # - 长度8~ 32位,推荐使用12位以上的密码
7136
+ # - 不能以" / "开头
7137
+ # - 必须包含以下四项:
7138
+ # 1. 小写字母a ~ z
7139
+ # 2. 大写字母 A ~ Z
7140
+ # 3. 数字 0 ~ 9
7141
+ # 4. 特殊字符 ()`~!@#$%^&*-+=_|{}[]:<>,.?/
7130
7142
  # @type Password: String
7131
7143
 
7132
7144
  attr_accessor :DBInstanceId, :UserName, :Password
@@ -7162,7 +7174,7 @@ module TencentCloud
7162
7174
 
7163
7175
  # RestartDBInstance请求参数结构体
7164
7176
  class RestartDBInstanceRequest < TencentCloud::Common::AbstractModel
7165
- # @param DBInstanceId: 实例ID,形如postgres-6r233v55
7177
+ # @param DBInstanceId: 实例ID,形如postgres-6r233v55。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7166
7178
  # @type DBInstanceId: String
7167
7179
 
7168
7180
  attr_accessor :DBInstanceId
@@ -7453,7 +7465,7 @@ module TencentCloud
7453
7465
 
7454
7466
  # SetAutoRenewFlag请求参数结构体
7455
7467
  class SetAutoRenewFlagRequest < TencentCloud::Common::AbstractModel
7456
- # @param DBInstanceIdSet: 实例ID集合。注意:当前已不支持同时操作多个实例,这里只能传入单个实例ID。
7468
+ # @param DBInstanceIdSet: 实例ID集合。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取。仅支持预付费(包年包月)的实例。支持同时操作多个实例。
7457
7469
  # @type DBInstanceIdSet: Array
7458
7470
  # @param AutoRenewFlag: 续费标记。0-正常续费;1-自动续费;2-到期不续费
7459
7471
  # @type AutoRenewFlag: Integer
@@ -7623,16 +7635,16 @@ module TencentCloud
7623
7635
 
7624
7636
  # SwitchDBInstancePrimary请求参数结构体
7625
7637
  class SwitchDBInstancePrimaryRequest < TencentCloud::Common::AbstractModel
7626
- # @param DBInstanceId: 实例ID
7638
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7627
7639
  # @type DBInstanceId: String
7628
7640
  # @param Force: 是否强制切换。强制切换时只要备节点可访问,无论主备延迟多大都会发起切换。只有SwitchTag为0时,才可使用立即切换。
7629
- # <li>默认:false
7641
+ # <li>默认:false</li>
7630
7642
  # @type Force: Boolean
7631
7643
  # @param SwitchTag: 指定实例配置完成变更后的切换时间。
7632
- # <li>0:立即切换
7633
- # <li>1:指定时间切换
7634
- # <li>2:维护时间窗口内切换
7635
- # <li>默认值:0
7644
+ # <li>0:立即切换 </li>
7645
+ # <li>1:指定时间切换</li>
7646
+ # <li>2:维护时间窗口内切换</li>
7647
+ # 默认值:0
7636
7648
  # @type SwitchTag: Integer
7637
7649
  # @param SwitchStartTime: 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。当SwitchTag为0或2时,该参数失效。
7638
7650
  # @type SwitchStartTime: String
@@ -7823,14 +7835,14 @@ module TencentCloud
7823
7835
 
7824
7836
  # UpgradeDBInstanceKernelVersion请求参数结构体
7825
7837
  class UpgradeDBInstanceKernelVersionRequest < TencentCloud::Common::AbstractModel
7826
- # @param DBInstanceId: 实例ID
7838
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7827
7839
  # @type DBInstanceId: String
7828
7840
  # @param TargetDBKernelVersion: 升级的目标内核版本号。可以通过接口[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)的返回字段AvailableUpgradeTarget获取。
7829
7841
  # @type TargetDBKernelVersion: String
7830
7842
  # @param SwitchTag: 指定实例升级内核版本号完成后的切换时间。可选值:
7831
- # <li>0:立即切换
7832
- # <li>1:指定时间切换
7833
- # <li>2:维护时间窗口内切换
7843
+ # <li>0:立即切换</li>
7844
+ # <li>1:指定时间切换</li>
7845
+ # <li>2:维护时间窗口内切换</li>
7834
7846
  # 默认值:0
7835
7847
  # @type SwitchTag: Integer
7836
7848
  # @param SwitchStartTime: 切换开始时间,时间格式:HH:MM:SS,例如:01:00:00。当SwitchTag为0或2时,该参数失效。
@@ -7838,8 +7850,8 @@ module TencentCloud
7838
7850
  # @param SwitchEndTime: 切换截止时间,时间格式:HH:MM:SS,例如:01:30:00。当SwitchTag为0或2时,该参数失效。SwitchStartTime和SwitchEndTime时间窗口不能小于30分钟。
7839
7851
  # @type SwitchEndTime: String
7840
7852
  # @param DryRun: 是否对本次升级实例内核版本号操作执行预检查。
7841
- # <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。
7842
- # <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。
7853
+ # <li>true:执行预检查操作,不升级内核版本号。检查项目包含请求参数、内核版本号兼容性、实例参数等。</li>
7854
+ # <li>false:发送正常请求(默认值),通过检查后直接升级内核版本号。</li>
7843
7855
  # 默认值:false
7844
7856
  # @type DryRun: Boolean
7845
7857
 
@@ -7882,9 +7894,9 @@ module TencentCloud
7882
7894
 
7883
7895
  # UpgradeDBInstanceMajorVersion请求参数结构体
7884
7896
  class UpgradeDBInstanceMajorVersionRequest < TencentCloud::Common::AbstractModel
7885
- # @param DBInstanceId: 实例ID
7897
+ # @param DBInstanceId: 实例ID。可通过[DescribeDBInstances](https://cloud.tencent.com/document/api/409/16773)接口获取
7886
7898
  # @type DBInstanceId: String
7887
- # @param TargetDBKernelVersion: 目标内核版本号,可以通过API DescribeDBVersions获取可以升级的目标内核版本号。
7899
+ # @param TargetDBKernelVersion: 目标内核版本号,可以通过API [DescribeDBVersions](https://cloud.tencent.com/document/product/409/89018)获取可以升级的目标内核版本号。
7888
7900
  # @type TargetDBKernelVersion: String
7889
7901
  # @param UpgradeCheck: 是否为校验模式,若UpgradeCheck为True,表示仅进行内核版本兼容性检查,不会进行实质性的升级操作,对原实例无影响。检查结果可以通过升级日志查看。
7890
7902
  # @type UpgradeCheck: Boolean
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-postgres
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1094
4
+ version: 3.0.1109
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-07-05 00:00:00.000000000 Z
11
+ date: 2025-07-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common