tencentcloud-sdk-cdb 3.0.1087 → 3.0.1090

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: 1f877cc5753a42e7c420a11caa6636d22eb6bb14
4
- data.tar.gz: b6e7d51e0757eb561bdc8c6d0ce2579c58e0b8e4
3
+ metadata.gz: e11347dfb7283d4408721ae3149a6400f06f0ae4
4
+ data.tar.gz: 6c6c797992f3840dcf96fab2746c23b916599fe5
5
5
  SHA512:
6
- metadata.gz: ab2e22fbdc10ba841156ec22caa053e47506cd8f522c3d61b3459d8debe27342b517d01ca4eae1c94429bf3e9508302a4b700226c036aa862794395baef1d6f1
7
- data.tar.gz: 9f2b3a0d6e66a1bacdc16d2df56a3abb1e34a2c0fb480d05ecc0ef1b3354453c766b8f1c1f6d4360c665562d0d2126ca40247253d31a12aab6fbd25b4c410eb1
6
+ metadata.gz: cb15acab7f42583369f602ac64a68dfc480252b4775a5b29b611c34cb0201b1589a2adca8aa365e3c193d11c09fe6764df238841848db08c67682a410367a8f4
7
+ data.tar.gz: 0336abd6df31a16f04f4847a59995b15543a0426b2f924f937e6e08f40259c160190f9dc40e4e548d4430ee3389e77adc4598aa142322d4ce4c542a941b02eac
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.1087
1
+ 3.0.1090
@@ -53,7 +53,7 @@ module TencentCloud
53
53
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
54
54
  end
55
55
 
56
- # 调整数据库代理配置
56
+ # 本接口(AdjustCdbProxy)用于调整数据库代理配置。
57
57
 
58
58
  # @param request: Request instance for AdjustCdbProxy.
59
59
  # @type request: :class:`Tencentcloud::cdb::V20170320::AdjustCdbProxyRequest`
@@ -245,7 +245,7 @@ module TencentCloud
245
245
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
246
246
  end
247
247
 
248
- # 请求关闭数据库代理地址
248
+ # 本接口(CloseCdbProxyAddress)用于请求关闭数据库代理地址。
249
249
 
250
250
  # @param request: Request instance for CloseCdbProxyAddress.
251
251
  # @type request: :class:`Tencentcloud::cdb::V20170320::CloseCdbProxyAddressRequest`
@@ -269,7 +269,7 @@ module TencentCloud
269
269
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
270
270
  end
271
271
 
272
- # 关闭SSL连接功能。
272
+ # 本接口(CloseSSL)用于关闭 SSL 连接功能。
273
273
 
274
274
  # @param request: Request instance for CloseSSL.
275
275
  # @type request: :class:`Tencentcloud::cdb::V20170320::CloseSSLRequest`
@@ -317,7 +317,7 @@ module TencentCloud
317
317
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
318
318
  end
319
319
 
320
- # 本接口(CreateAccounts)用于创建云数据库的账户,需要指定新的账户名和域名,以及所对应的密码,同时可以设置账号的备注信息以及最大可用连接数。
320
+ # 本接口(CreateAccounts)用于创建云数据库的账户,需要指定新的账户名和域名,以及所对应的密码,同时可以设置账号的备注信息以及最大可用连接数。
321
321
 
322
322
  # @param request: Request instance for CreateAccounts.
323
323
  # @type request: :class:`Tencentcloud::cdb::V20170320::CreateAccountsRequest`
@@ -671,7 +671,8 @@ module TencentCloud
671
671
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
672
672
  end
673
673
 
674
- # 该接口(CreateParamTemplate)用于创建参数模板,全地域公共参数 Region 均为 ap-guangzhou。
674
+ # 该接口(CreateParamTemplate)用于创建参数模板。
675
+ # 说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
675
676
 
676
677
  # @param request: Request instance for CreateParamTemplate.
677
678
  # @type request: :class:`Tencentcloud::cdb::V20170320::CreateParamTemplateRequest`
@@ -937,7 +938,8 @@ module TencentCloud
937
938
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
938
939
  end
939
940
 
940
- # 该接口(DeleteParamTemplate)用于删除参数模板,全地域公共参数 Region 均为 ap-guangzhou。
941
+ # 该接口(DeleteParamTemplate)用于删除参数模板。
942
+ # 说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
941
943
 
942
944
  # @param request: Request instance for DeleteParamTemplate.
943
945
  # @type request: :class:`Tencentcloud::cdb::V20170320::DeleteParamTemplateRequest`
@@ -1009,7 +1011,7 @@ module TencentCloud
1009
1011
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1010
1012
  end
1011
1013
 
1012
- # 本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。
1014
+ # 本接口(DescribeAccountPrivileges)用于查询云数据库账户支持的权限信息。
1013
1015
 
1014
1016
  # @param request: Request instance for DescribeAccountPrivileges.
1015
1017
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeAccountPrivilegesRequest`
@@ -2238,7 +2240,8 @@ module TencentCloud
2238
2240
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2239
2241
  end
2240
2242
 
2241
- # 该接口(DescribeParamTemplates)查询参数模板列表,全地域公共参数Region均为ap-guangzhou。
2243
+ # 该接口(DescribeParamTemplates)查询参数模板列表。
2244
+ # 说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
2242
2245
 
2243
2246
  # @param request: Request instance for DescribeParamTemplates.
2244
2247
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeParamTemplatesRequest`
@@ -2310,7 +2313,7 @@ module TencentCloud
2310
2313
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2311
2314
  end
2312
2315
 
2313
- # 查询实例支持代理版本和参数
2316
+ # 本接口(DescribeProxySupportParam)用于查询实例支持代理版本和参数。
2314
2317
 
2315
2318
  # @param request: Request instance for DescribeProxySupportParam.
2316
2319
  # @type request: :class:`Tencentcloud::cdb::V20170320::DescribeProxySupportParamRequest`
@@ -2815,7 +2818,7 @@ module TencentCloud
2815
2818
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
2816
2819
  end
2817
2820
 
2818
- # 本接口(ModifyAccountMaxUserConnections)用于修改云数据库账户最大可用连接数。
2821
+ # 本接口(ModifyAccountMaxUserConnections)用于修改云数据库账户最大可用连接数。
2819
2822
 
2820
2823
  # @param request: Request instance for ModifyAccountMaxUserConnections.
2821
2824
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyAccountMaxUserConnectionsRequest`
@@ -3084,7 +3087,7 @@ module TencentCloud
3084
3087
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3085
3088
  end
3086
3089
 
3087
- # 修改代理地址描述信息
3090
+ # 本接口(ModifyCdbProxyAddressDesc)用于修改代理地址描述信息。
3088
3091
 
3089
3092
  # @param request: Request instance for ModifyCdbProxyAddressDesc.
3090
3093
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyCdbProxyAddressDescRequest`
@@ -3108,7 +3111,7 @@ module TencentCloud
3108
3111
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3109
3112
  end
3110
3113
 
3111
- # 修改数据库代理地址VPC信息
3114
+ # 本接口(ModifyCdbProxyAddressVipAndVPort)用于修改数据库代理地址VPC信息。
3112
3115
 
3113
3116
  # @param request: Request instance for ModifyCdbProxyAddressVipAndVPort.
3114
3117
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyCdbProxyAddressVipAndVPortRequest`
@@ -3132,7 +3135,7 @@ module TencentCloud
3132
3135
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3133
3136
  end
3134
3137
 
3135
- # 配置数据库代理参数
3138
+ # 本接口(ModifyCdbProxyParam)用于配置数据库代理参数。
3136
3139
 
3137
3140
  # @param request: Request instance for ModifyCdbProxyParam.
3138
3141
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyCdbProxyParamRequest`
@@ -3420,7 +3423,8 @@ module TencentCloud
3420
3423
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3421
3424
  end
3422
3425
 
3423
- # 该接口(ModifyParamTemplate)用于修改参数模板,全地域公共参数Region均为ap-guangzhou。
3426
+ # 该接口(ModifyParamTemplate)用于修改参数模板。
3427
+ # 说明:参数模板为公共组件,配置完成后全地域生效。接口调用配置地域可选择广州、新加坡。
3424
3428
 
3425
3429
  # @param request: Request instance for ModifyParamTemplate.
3426
3430
  # @type request: :class:`Tencentcloud::cdb::V20170320::ModifyParamTemplateRequest`
@@ -3569,7 +3573,7 @@ module TencentCloud
3569
3573
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3570
3574
  end
3571
3575
 
3572
- # CDB实例开通审计服务
3576
+ # 本接口(OpenAuditService)用 CDB 实例开通审计服务。
3573
3577
 
3574
3578
  # @param request: Request instance for OpenAuditService.
3575
3579
  # @type request: :class:`Tencentcloud::cdb::V20170320::OpenAuditServiceRequest`
@@ -3602,8 +3606,9 @@ module TencentCloud
3602
3606
  # 2、开启 [KMS服务](https://console.cloud.tencent.com/kms2);
3603
3607
 
3604
3608
  # 3、对云数据库(MySQL)[授予访问KMS密钥的权限](https://console.cloud.tencent.com/cam/role),角色名为MySQL_QCSRole,预设策略名为QcloudAccessForMySQLRole;
3609
+ # 4、开启加密后不允许关闭。
3605
3610
 
3606
- # 该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用DescribeDBInstanceInfo 确认后端加密是否开通成功。
3611
+ # 该 API 耗时可能到10s,客户端可能超时,如果调用 API 返回 InternalError ,请您调用 [DescribeDBInstanceInfo](https://cloud.tencent.com/document/product/236/44160) 确认后端加密是否开通成功,调用后参数 Encryption 为 YES 表示已开通成功。
3607
3612
 
3608
3613
  # @param request: Request instance for OpenDBInstanceEncryption.
3609
3614
  # @type request: :class:`Tencentcloud::cdb::V20170320::OpenDBInstanceEncryptionRequest`
@@ -3651,7 +3656,7 @@ module TencentCloud
3651
3656
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3652
3657
  end
3653
3658
 
3654
- # 开启SSL连接功能。
3659
+ # 本接口(OpenSSL)用于开启 SSL 连接功能。
3655
3660
 
3656
3661
  # @param request: Request instance for OpenSSL.
3657
3662
  # @type request: :class:`Tencentcloud::cdb::V20170320::OpenSSLRequest`
@@ -3945,7 +3950,8 @@ module TencentCloud
3945
3950
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
3946
3951
  end
3947
3952
 
3948
- # 本接口(StopDBImportJob)用于终止数据导入任务。
3953
+ # 本接口(StopDBImportJob)用于终止数据导入任务。
3954
+ # 说明:只有未完成的导入任务支持被终止,且终止后已执行的 SQL 部分会被保留。
3949
3955
 
3950
3956
  # @param request: Request instance for StopDBImportJob.
3951
3957
  # @type request: :class:`Tencentcloud::cdb::V20170320::StopDBImportJobRequest`
@@ -4041,7 +4047,7 @@ module TencentCloud
4041
4047
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
4042
4048
  end
4043
4049
 
4044
- # 数据库代理配置变更或则升级版本后手动发起立即切换
4050
+ # 本接口(SwitchCDBProxy)用于数据库代理配置变更或者升级版本后手动发起立即切换。
4045
4051
 
4046
4052
  # @param request: Request instance for SwitchCDBProxy.
4047
4053
  # @type request: :class:`Tencentcloud::cdb::V20170320::SwitchCDBProxyRequest`
@@ -4137,7 +4143,7 @@ module TencentCloud
4137
4143
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
4138
4144
  end
4139
4145
 
4140
- # 升级数据库代理版本
4146
+ # 本接口(UpgradeCDBProxyVersion)用于升级数据库代理版本。
4141
4147
 
4142
4148
  # @param request: Request instance for UpgradeCDBProxyVersion.
4143
4149
  # @type request: :class:`Tencentcloud::cdb::V20170320::UpgradeCDBProxyVersionRequest`
@@ -4161,7 +4167,7 @@ module TencentCloud
4161
4167
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
4162
4168
  end
4163
4169
 
4164
- # 本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务,请一定填写实例规格(CPU、内存),不然系统会默认以最小允许规格传参。
4170
+ # 本接口(UpgradeDBInstance)用于升级或降级云数据库实例的配置,实例类型支持主实例、灾备实例和只读实例。如果进行迁移业务,请一定填写实例规格(CPU、内存),不然系统会默认以最小允许规格传参。
4165
4171
 
4166
4172
  # @param request: Request instance for UpgradeDBInstance.
4167
4173
  # @type request: :class:`Tencentcloud::cdb::V20170320::UpgradeDBInstanceRequest`
@@ -19,9 +19,12 @@ module TencentCloud
19
19
  module V20170320
20
20
  # 数据库账号信息
21
21
  class Account < TencentCloud::Common::AbstractModel
22
- # @param User: 新账户的名称
22
+ # @param User: 账号名,可输入1 - 32个字符。
23
23
  # @type User: String
24
- # @param Host: 新账户的域名
24
+ # @param Host: 账号的主机。
25
+ # 说明:
26
+ # 1. IP 形式,支持填入%。
27
+ # 2. 多个主机以分隔符分隔,分隔符支持;,|换行符和空格。
25
28
  # @type Host: String
26
29
 
27
30
  attr_accessor :User, :Host
@@ -190,16 +193,17 @@ module TencentCloud
190
193
 
191
194
  # AdjustCdbProxyAddress请求参数结构体
192
195
  class AdjustCdbProxyAddressRequest < TencentCloud::Common::AbstractModel
193
- # @param ProxyGroupId: 代理组ID
196
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
194
197
  # @type ProxyGroupId: String
195
198
  # @param WeightMode: 权重分配模式,
196
199
  # 系统自动分配:"system", 自定义:"custom"
197
200
  # @type WeightMode: String
198
201
  # @param IsKickOut: 是否开启延迟剔除,取值:"true" | "false"
199
202
  # @type IsKickOut: Boolean
200
- # @param MinCount: 最小保留数量,最小取值:0
203
+ # @param MinCount: 最小保留数量,最小取值:0
204
+ # 说明:当 IsKickOut 为 true 时才有效。
201
205
  # @type MinCount: Integer
202
- # @param MaxDelay: 延迟剔除阈值,最小取值:0
206
+ # @param MaxDelay: 延迟剔除阈值,最小取值:1,取值范围:[1,10000],整数。
203
207
  # @type MaxDelay: Integer
204
208
  # @param FailOver: 是否开启故障转移,取值:"true" | "false"
205
209
  # @type FailOver: Boolean
@@ -207,18 +211,18 @@ module TencentCloud
207
211
  # @type AutoAddRo: Boolean
208
212
  # @param ReadOnly: 是否是只读,取值:"true" | "false"
209
213
  # @type ReadOnly: Boolean
210
- # @param ProxyAddressId: 代理组地址ID
214
+ # @param ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
211
215
  # @type ProxyAddressId: String
212
- # @param TransSplit: 是否开启事务分离,取值:"true" | "false"
216
+ # @param TransSplit: 是否开启事务分离,取值:"true" | "false",默认值 false。
213
217
  # @type TransSplit: Boolean
214
- # @param ConnectionPool: 是否开启连接池
218
+ # @param ConnectionPool: 是否开启连接池。默认关闭。
215
219
  # 注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
216
220
  # @type ConnectionPool: Boolean
217
221
  # @param ProxyAllocation: 读写权重分配。如果 WeightMode 传的是 system ,则传入的权重不生效,由系统分配默认权重。
218
222
  # @type ProxyAllocation: Array
219
- # @param AutoLoadBalance: 是否开启自适应负载均衡
223
+ # @param AutoLoadBalance: 是否开启自适应负载均衡。默认关闭。
220
224
  # @type AutoLoadBalance: Boolean
221
- # @param AccessMode: 访问模式:就近访问,均衡分配
225
+ # @param AccessMode: 访问模式:nearby - 就近访问,balance - 均衡分配,默认就近访问。
222
226
  # @type AccessMode: String
223
227
 
224
228
  attr_accessor :ProxyGroupId, :WeightMode, :IsKickOut, :MinCount, :MaxDelay, :FailOver, :AutoAddRo, :ReadOnly, :ProxyAddressId, :TransSplit, :ConnectionPool, :ProxyAllocation, :AutoLoadBalance, :AccessMode
@@ -287,9 +291,9 @@ module TencentCloud
287
291
 
288
292
  # AdjustCdbProxy请求参数结构体
289
293
  class AdjustCdbProxyRequest < TencentCloud::Common::AbstractModel
290
- # @param InstanceId: 实例ID
294
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
291
295
  # @type InstanceId: String
292
- # @param ProxyGroupId: 代理组ID
296
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
293
297
  # @type ProxyGroupId: String
294
298
  # @param ProxyNodeCustom: 节点规格配置
295
299
  # 备注:数据库代理支持的节点规格为:2C4000MB、4C8000MB、8C16000MB。
@@ -421,7 +425,7 @@ module TencentCloud
421
425
 
422
426
  # AnalyzeAuditLogs请求参数结构体
423
427
  class AnalyzeAuditLogsRequest < TencentCloud::Common::AbstractModel
424
- # @param InstanceId: 实例ID
428
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
425
429
  # @type InstanceId: String
426
430
  # @param StartTime: 要分析的日志开始时间,格式为:"2023-02-16 00:00:20"。
427
431
  # @type StartTime: String
@@ -1899,7 +1903,7 @@ module TencentCloud
1899
1903
 
1900
1904
  # CloseAuditService请求参数结构体
1901
1905
  class CloseAuditServiceRequest < TencentCloud::Common::AbstractModel
1902
- # @param InstanceId: 实例ID
1906
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
1903
1907
  # @type InstanceId: String
1904
1908
 
1905
1909
  attr_accessor :InstanceId
@@ -1931,9 +1935,9 @@ module TencentCloud
1931
1935
 
1932
1936
  # CloseCDBProxy请求参数结构体
1933
1937
  class CloseCDBProxyRequest < TencentCloud::Common::AbstractModel
1934
- # @param InstanceId: 实例ID
1938
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
1935
1939
  # @type InstanceId: String
1936
- # @param ProxyGroupId: 代理组ID
1940
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
1937
1941
  # @type ProxyGroupId: String
1938
1942
  # @param OnlyCloseRW: 是否只关闭读写分离,取值:"true" | "false",默认为"false"
1939
1943
  # @type OnlyCloseRW: Boolean
@@ -1971,9 +1975,9 @@ module TencentCloud
1971
1975
 
1972
1976
  # CloseCdbProxyAddress请求参数结构体
1973
1977
  class CloseCdbProxyAddressRequest < TencentCloud::Common::AbstractModel
1974
- # @param ProxyGroupId: 代理组ID
1978
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
1975
1979
  # @type ProxyGroupId: String
1976
- # @param ProxyAddressId: 代理组地址ID
1980
+ # @param ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
1977
1981
  # @type ProxyAddressId: String
1978
1982
 
1979
1983
  attr_accessor :ProxyGroupId, :ProxyAddressId
@@ -2007,9 +2011,9 @@ module TencentCloud
2007
2011
 
2008
2012
  # CloseSSL请求参数结构体
2009
2013
  class CloseSSLRequest < TencentCloud::Common::AbstractModel
2010
- # @param InstanceId: 实例 ID 。只读组 ID为空时必填。
2014
+ # @param InstanceId: 实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
2011
2015
  # @type InstanceId: String
2012
- # @param RoGroupId: 只读组 ID。实例 ID为空时必填。
2016
+ # @param RoGroupId: 只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
2013
2017
  # @type RoGroupId: String
2014
2018
 
2015
2019
  attr_accessor :InstanceId, :RoGroupId
@@ -2258,8 +2262,12 @@ module TencentCloud
2258
2262
  # @param Accounts: 云数据库账号。
2259
2263
  # @type Accounts: Array
2260
2264
  # @param Password: 新账户的密码。
2265
+ # 说明:
2266
+ # 1. 在8 ~ 64位字符数以内(推荐12位以上)。
2267
+ # 2. 至少包含其中两项:小写字母 a ~ z 或 大写字母 A ~ Z。数字0 ~ 9。_+-,&=!@#$%^*().|。
2268
+ # 3. 不能包含非法字符。
2261
2269
  # @type Password: String
2262
- # @param Description: 备注信息。
2270
+ # @param Description: 备注信息。最多支持输入255个字符。
2263
2271
  # @type Description: String
2264
2272
  # @param MaxUserConnections: 新账户最大可用连接数,默认值为10240,最大可设置值为10240。
2265
2273
  # @type MaxUserConnections: Integer
@@ -2502,15 +2510,15 @@ module TencentCloud
2502
2510
 
2503
2511
  # CreateAuditRuleTemplate请求参数结构体
2504
2512
  class CreateAuditRuleTemplateRequest < TencentCloud::Common::AbstractModel
2505
- # @param RuleFilters: 审计规则
2513
+ # @param RuleFilters: 审计规则。
2506
2514
  # @type RuleFilters: Array
2507
- # @param RuleTemplateName: 规则模板名称
2515
+ # @param RuleTemplateName: 规则模板名称。最多支持输入30个字符。
2508
2516
  # @type RuleTemplateName: String
2509
- # @param Description: 规则模板描述
2517
+ # @param Description: 规则模板描述。最多支持输入200个字符。
2510
2518
  # @type Description: String
2511
- # @param AlarmLevel: 告警等级。1-低风险,2-中风险,3-高风险
2519
+ # @param AlarmLevel: 告警等级。1 - 低风险,2 - 中风险,3 - 高风险。默认值为1。
2512
2520
  # @type AlarmLevel: Integer
2513
- # @param AlarmPolicy: 告警策略。0-不告警,1-告警
2521
+ # @param AlarmPolicy: 告警策略。0 - 不告警,1 - 告警。默认值为0。
2514
2522
  # @type AlarmPolicy: Integer
2515
2523
 
2516
2524
  attr_accessor :RuleFilters, :RuleTemplateName, :Description, :AlarmLevel, :AlarmPolicy
@@ -2621,7 +2629,7 @@ module TencentCloud
2621
2629
 
2622
2630
  # CreateCdbProxyAddress请求参数结构体
2623
2631
  class CreateCdbProxyAddressRequest < TencentCloud::Common::AbstractModel
2624
- # @param ProxyGroupId: 代理组ID
2632
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
2625
2633
  # @type ProxyGroupId: String
2626
2634
  # @param WeightMode: 权重分配模式,
2627
2635
  # 系统自动分配:"system", 自定义:"custom"
@@ -2630,7 +2638,7 @@ module TencentCloud
2630
2638
  # @type IsKickOut: Boolean
2631
2639
  # @param MinCount: 最小保留数量,最小取值:0
2632
2640
  # @type MinCount: Integer
2633
- # @param MaxDelay: 延迟剔除阈值,最小取值:0
2641
+ # @param MaxDelay: 延迟剔除阈值,最小取值:1,范围:1 - 10000,整数。
2634
2642
  # @type MaxDelay: Integer
2635
2643
  # @param FailOver: 是否开启故障转移,取值:"true" | "false"
2636
2644
  # @type FailOver: Boolean
@@ -2642,26 +2650,26 @@ module TencentCloud
2642
2650
  # @type TransSplit: Boolean
2643
2651
  # @param ProxyAllocation: 读写权重分配
2644
2652
  # @type ProxyAllocation: Array
2645
- # @param UniqVpcId: 私有网络ID
2653
+ # @param UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
2646
2654
  # @type UniqVpcId: String
2647
- # @param UniqSubnetId: 私有子网ID
2655
+ # @param UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
2648
2656
  # @type UniqSubnetId: String
2649
- # @param ConnectionPool: 是否开启连接池
2657
+ # @param ConnectionPool: 是否开启连接池。默认关闭。
2650
2658
  # 注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
2651
2659
  # @type ConnectionPool: Boolean
2652
2660
  # @param Desc: 描述
2653
2661
  # @type Desc: String
2654
- # @param Vip: IP地址
2662
+ # @param Vip: IP 地址。不填则默认为所选 VPC 下支持的随机一个 IP。
2655
2663
  # @type Vip: String
2656
- # @param VPort: 端口
2664
+ # @param VPort: 端口。默认值3306。
2657
2665
  # @type VPort: Integer
2658
2666
  # @param SecurityGroup: 安全组
2659
2667
  # @type SecurityGroup: Array
2660
- # @param ConnectionPoolType: 连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool为true时生效。
2668
+ # @param ConnectionPoolType: 连接池类型。可选值 transaction(事务级别连接池),connection(会话级别连接池),ConnectionPool true 时生效。默认值:connection。
2661
2669
  # @type ConnectionPoolType: String
2662
- # @param AutoLoadBalance: 是否自适应负载均衡
2670
+ # @param AutoLoadBalance: 是否开启自适应负载均衡。默认关闭。
2663
2671
  # @type AutoLoadBalance: Boolean
2664
- # @param AccessMode: 接入模式
2672
+ # @param AccessMode: 接入模式。nearBy - 就近访问,balance - 均衡分配,默认值:nearBy。
2665
2673
  # @type AccessMode: String
2666
2674
 
2667
2675
  attr_accessor :ProxyGroupId, :WeightMode, :IsKickOut, :MinCount, :MaxDelay, :FailOver, :AutoAddRo, :ReadOnly, :TransSplit, :ProxyAllocation, :UniqVpcId, :UniqSubnetId, :ConnectionPool, :Desc, :Vip, :VPort, :SecurityGroup, :ConnectionPoolType, :AutoLoadBalance, :AccessMode
@@ -2742,11 +2750,11 @@ module TencentCloud
2742
2750
 
2743
2751
  # CreateCdbProxy请求参数结构体
2744
2752
  class CreateCdbProxyRequest < TencentCloud::Common::AbstractModel
2745
- # @param InstanceId: 实例ID
2753
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
2746
2754
  # @type InstanceId: String
2747
- # @param UniqVpcId: 私有网络ID
2755
+ # @param UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
2748
2756
  # @type UniqVpcId: String
2749
- # @param UniqSubnetId: 私有子网ID
2757
+ # @param UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
2750
2758
  # @type UniqSubnetId: String
2751
2759
  # @param ProxyNodeCustom: 节点规格配置。
2752
2760
  # 示例中参数说明:
@@ -3887,9 +3895,9 @@ module TencentCloud
3887
3895
 
3888
3896
  # DeleteAuditLogFile请求参数结构体
3889
3897
  class DeleteAuditLogFileRequest < TencentCloud::Common::AbstractModel
3890
- # @param FileName: 审计日志文件名称。
3898
+ # @param FileName: 审计日志文件名称。可通过 [DescribeAuditLogFiles](https://cloud.tencent.com/document/api/236/45454) 接口获取。
3891
3899
  # @type FileName: String
3892
- # @param InstanceId: 实例 ID
3900
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
3893
3901
  # @type InstanceId: String
3894
3902
 
3895
3903
  attr_accessor :FileName, :InstanceId
@@ -4285,9 +4293,9 @@ module TencentCloud
4285
4293
  class DescribeAccountPrivilegesRequest < TencentCloud::Common::AbstractModel
4286
4294
  # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
4287
4295
  # @type InstanceId: String
4288
- # @param User: 数据库的账号名称。
4296
+ # @param User: 数据库的账号名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
4289
4297
  # @type User: String
4290
- # @param Host: 数据库的账号域名。
4298
+ # @param Host: 数据库的账号域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
4291
4299
  # @type Host: String
4292
4300
 
4293
4301
  attr_accessor :InstanceId, :User, :Host
@@ -4584,7 +4592,7 @@ module TencentCloud
4584
4592
  class DescribeAuditLogFilesRequest < TencentCloud::Common::AbstractModel
4585
4593
  # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
4586
4594
  # @type InstanceId: String
4587
- # @param Limit: 分页大小参数。默认值为 20,最小值为 1,最大值为 100
4595
+ # @param Limit: 分页大小参数。默认值为20,最小值为1,最大值为300
4588
4596
  # @type Limit: Integer
4589
4597
  # @param Offset: 分页偏移量。
4590
4598
  # @type Offset: Integer
@@ -4870,7 +4878,7 @@ module TencentCloud
4870
4878
  # @type RuleTemplateIds: Array
4871
4879
  # @param RuleTemplateNames: 规则模板名称。
4872
4880
  # @type RuleTemplateNames: Array
4873
- # @param Limit: 单次请求返回的数量。默认值20。
4881
+ # @param Limit: 单次请求返回的数量。默认值20,最大值为1000
4874
4882
  # @type Limit: Integer
4875
4883
  # @param Offset: 偏移量,默认值为 0。
4876
4884
  # @type Offset: Integer
@@ -5552,7 +5560,7 @@ module TencentCloud
5552
5560
 
5553
5561
  # DescribeCPUExpandStrategyInfo请求参数结构体
5554
5562
  class DescribeCPUExpandStrategyInfoRequest < TencentCloud::Common::AbstractModel
5555
- # @param InstanceId: 实例 ID
5563
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5556
5564
  # @type InstanceId: String
5557
5565
 
5558
5566
  attr_accessor :InstanceId
@@ -5568,18 +5576,19 @@ module TencentCloud
5568
5576
 
5569
5577
  # DescribeCPUExpandStrategyInfo返回参数结构体
5570
5578
  class DescribeCPUExpandStrategyInfoResponse < TencentCloud::Common::AbstractModel
5571
- # @param Type: 策略类型。输出值 auto、manual。如果返回为 NULL 说明尚未开通弹性扩容策略。
5579
+ # @param Type: 策略类型。输出值:auto、manual、timeInterval、period。
5580
+ # 说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。5. 如果返回为 NULL 说明尚未开通弹性扩容策略。
5572
5581
  # 注意:此字段可能返回 null,表示取不到有效值。
5573
5582
  # @type Type: String
5574
- # @param ExpandCpu: 手动扩容的 CPU 。Type 为 manual 时有效。
5583
+ # @param ExpandCpu: 自定义扩容,且扩容时间为立即生效时的 CPU。Type 为 manual 时有效。
5575
5584
  # 注意:此字段可能返回 null,表示取不到有效值。
5576
5585
  # @type ExpandCpu: Integer
5577
5586
  # @param AutoStrategy: 自动扩容策略。Type 为 auto 时有效。
5578
5587
  # 注意:此字段可能返回 null,表示取不到有效值。
5579
5588
  # @type AutoStrategy: :class:`Tencentcloud::Cdb.v20170320.models.AutoStrategy`
5580
- # @param PeriodStrategy: 按周期扩容策略。
5589
+ # @param PeriodStrategy: 按周期扩容策略。当 Type 为 period 时有效。
5581
5590
  # @type PeriodStrategy: :class:`Tencentcloud::Cdb.v20170320.models.PeriodStrategy`
5582
- # @param TimeIntervalStrategy: 按时间段扩容策略。
5591
+ # @param TimeIntervalStrategy: 按时间段扩容策略。当 Type 为 timeInterval 时有效。
5583
5592
  # @type TimeIntervalStrategy: :class:`Tencentcloud::Cdb.v20170320.models.TimeIntervalStrategy`
5584
5593
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5585
5594
  # @type RequestId: String
@@ -5756,7 +5765,8 @@ module TencentCloud
5756
5765
 
5757
5766
  # DescribeClusterInfo请求参数结构体
5758
5767
  class DescribeClusterInfoRequest < TencentCloud::Common::AbstractModel
5759
- # @param InstanceId: 实例 ID
5768
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
5769
+ # 说明:仅能输入实例架构为云盘版的实例 ID,对应控制台实例配置显示为“云盘版(云盘)”的实例。
5760
5770
  # @type InstanceId: String
5761
5771
 
5762
5772
  attr_accessor :InstanceId
@@ -7296,9 +7306,10 @@ module TencentCloud
7296
7306
 
7297
7307
  # DescribeInstanceUpgradeCheckJob请求参数结构体
7298
7308
  class DescribeInstanceUpgradeCheckJobRequest < TencentCloud::Common::AbstractModel
7299
- # @param InstanceId: 实例ID
7309
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7300
7310
  # @type InstanceId: String
7301
- # @param DstMysqlVersion: 目标数据库版本
7311
+ # @param DstMysqlVersion: 目标数据库版本。
7312
+ # 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
7302
7313
  # @type DstMysqlVersion: String
7303
7314
 
7304
7315
  attr_accessor :InstanceId, :DstMysqlVersion
@@ -7610,7 +7621,7 @@ module TencentCloud
7610
7621
 
7611
7622
  # DescribeProjectSecurityGroups请求参数结构体
7612
7623
  class DescribeProjectSecurityGroupsRequest < TencentCloud::Common::AbstractModel
7613
- # @param ProjectId: 项目ID
7624
+ # @param ProjectId: 项目 ID。可通过 [DescribeProjects](https://cloud.tencent.com/document/api/651/78725) 接口获取。
7614
7625
  # @type ProjectId: Integer
7615
7626
 
7616
7627
  attr_accessor :ProjectId
@@ -7715,7 +7726,7 @@ module TencentCloud
7715
7726
 
7716
7727
  # DescribeProxySupportParam请求参数结构体
7717
7728
  class DescribeProxySupportParamRequest < TencentCloud::Common::AbstractModel
7718
- # @param InstanceId: 实例ID
7729
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
7719
7730
  # @type InstanceId: String
7720
7731
 
7721
7732
  attr_accessor :InstanceId
@@ -9905,11 +9916,11 @@ module TencentCloud
9905
9916
  class ModifyAccountHostRequest < TencentCloud::Common::AbstractModel
9906
9917
  # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
9907
9918
  # @type InstanceId: String
9908
- # @param User: 账户的名称
9919
+ # @param User: 账户的名称。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
9909
9920
  # @type User: String
9910
- # @param Host: 账户的旧主机
9921
+ # @param Host: 账户的旧主机。格式:IP 形式,支持单个 IP 地址或者%。
9911
9922
  # @type Host: String
9912
- # @param NewHost: 账户的新主机
9923
+ # @param NewHost: 账户的新主机。格式:IP 形式,支持单个 IP 地址或者%。
9913
9924
  # @type NewHost: String
9914
9925
 
9915
9926
  attr_accessor :InstanceId, :User, :Host, :NewHost
@@ -9951,7 +9962,7 @@ module TencentCloud
9951
9962
 
9952
9963
  # ModifyAccountMaxUserConnections请求参数结构体
9953
9964
  class ModifyAccountMaxUserConnectionsRequest < TencentCloud::Common::AbstractModel
9954
- # @param Accounts: 云数据库账号。
9965
+ # @param Accounts: 云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
9955
9966
  # @type Accounts: Array
9956
9967
  # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
9957
9968
  # @type InstanceId: String
@@ -10006,7 +10017,7 @@ module TencentCloud
10006
10017
  # @type InstanceId: String
10007
10018
  # @param NewPassword: 数据库账号的新密码。密码应至少包含字母、数字和字符(_+-&=!@#$%^*())中的两种,长度为8-64个字符。
10008
10019
  # @type NewPassword: String
10009
- # @param Accounts: 云数据库账号。
10020
+ # @param Accounts: 云数据库账号。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
10010
10021
  # @type Accounts: Array
10011
10022
 
10012
10023
  attr_accessor :InstanceId, :NewPassword, :Accounts
@@ -10055,7 +10066,7 @@ module TencentCloud
10055
10066
  class ModifyAccountPrivilegesRequest < TencentCloud::Common::AbstractModel
10056
10067
  # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同。
10057
10068
  # @type InstanceId: String
10058
- # @param Accounts: 数据库的账号,包括用户名和域名。
10069
+ # @param Accounts: 数据库的账号,包括用户名和域名。可通过 [DescribeAccounts](https://cloud.tencent.com/document/api/236/17499) 接口获取。
10059
10070
  # @type Accounts: Array
10060
10071
  # @param GlobalPrivileges: 全局权限。其中,GlobalPrivileges 中权限的可选值为:"SELECT","INSERT","UPDATE","DELETE","CREATE", "PROCESS", "DROP","REFERENCES","INDEX","ALTER","SHOW DATABASES","CREATE TEMPORARY TABLES","LOCK TABLES","EXECUTE","CREATE VIEW","SHOW VIEW","CREATE ROUTINE","ALTER ROUTINE","EVENT","TRIGGER","CREATE USER","RELOAD","REPLICATION CLIENT","REPLICATION SLAVE"。
10061
10072
  # 注意,ModifyAction为空时,不传该参数表示清除该权限。
@@ -10145,7 +10156,7 @@ module TencentCloud
10145
10156
 
10146
10157
  # ModifyAuditConfig请求参数结构体
10147
10158
  class ModifyAuditConfigRequest < TencentCloud::Common::AbstractModel
10148
- # @param InstanceId: 实例 ID
10159
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10149
10160
  # @type InstanceId: String
10150
10161
  # @param LogExpireDay: 审计日志保存时长。支持值包括:
10151
10162
  # 7 - 一周
@@ -10156,8 +10167,10 @@ module TencentCloud
10156
10167
  # 1825 - 五年;
10157
10168
  # @type LogExpireDay: Integer
10158
10169
  # @param CloseAudit: 是否关闭审计服务。可选值:true - 关闭审计服务;false - 不关闭审计服务。默认值为 false。
10159
- # 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
10160
- # CloseAudit、LogExpireDay必须至少提供一个,如果两个都提供则按照CloseAudit优先的逻辑处理。
10170
+ # 说明:
10171
+ # 1. 当关闭审计服务时,会删除用户的审计日志和文件,并删除该实例的所有审计策略。
10172
+ # 2. CloseAudit、LogExpireDay 必须至少提供一个,如果两个都提供则按照 CloseAudit 优先的逻辑处理。
10173
+ # 3. 可通过设置此参数来关闭审计服务,已关闭后不能通过此接口来开启审计服务。
10161
10174
  # @type CloseAudit: Boolean
10162
10175
  # @param HighLogExpireDay: 高频审计日志保存时长。支持值包括:
10163
10176
  # 7 - 一周
@@ -10258,7 +10271,7 @@ module TencentCloud
10258
10271
 
10259
10272
  # ModifyAuditRuleTemplates请求参数结构体
10260
10273
  class ModifyAuditRuleTemplatesRequest < TencentCloud::Common::AbstractModel
10261
- # @param RuleTemplateIds: 审计规则模板ID
10274
+ # @param RuleTemplateIds: 审计规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
10262
10275
  # @type RuleTemplateIds: Array
10263
10276
  # @param RuleFilters: 修改后的审计规则。
10264
10277
  # @type RuleFilters: Array
@@ -10317,17 +10330,32 @@ module TencentCloud
10317
10330
 
10318
10331
  # ModifyAuditService请求参数结构体
10319
10332
  class ModifyAuditServiceRequest < TencentCloud::Common::AbstractModel
10320
- # @param InstanceId: 实例ID
10333
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10321
10334
  # @type InstanceId: String
10322
- # @param LogExpireDay: 日志保留时长。
10335
+ # @param LogExpireDay: 日志保留时长。支持值包括:
10336
+ # 7 - 一周;
10337
+ # 30 - 一个月;
10338
+ # 90 - 三个月;
10339
+ # 180 - 六个月;
10340
+ # 365 - 一年;
10341
+ # 1095 - 三年;
10342
+ # 1825 - 五年。
10323
10343
  # @type LogExpireDay: Integer
10324
- # @param HighLogExpireDay: 高频日志保留时长。
10344
+ # @param HighLogExpireDay: 高频日志保留时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
10345
+ # 3 - 3天;
10346
+ # 7 - 一周;
10347
+ # 30 - 一个月;
10348
+ # 90 - 三个月;
10349
+ # 180 - 六个月;
10350
+ # 365 - 一年;
10351
+ # 1095 - 三年;
10352
+ # 1825 - 五年。
10325
10353
  # @type HighLogExpireDay: Integer
10326
10354
  # @param AuditAll: 修改实例审计规则为全审计。
10327
10355
  # @type AuditAll: Boolean
10328
10356
  # @param AuditRuleFilters: 废弃。
10329
10357
  # @type AuditRuleFilters: Array
10330
- # @param RuleTemplateIds: 规则模板ID
10358
+ # @param RuleTemplateIds: 规则模板 ID。可通过 [DescribeAuditRuleTemplates](https://cloud.tencent.com/document/api/236/101811) 接口获取。
10331
10359
  # @type RuleTemplateIds: Array
10332
10360
 
10333
10361
  attr_accessor :InstanceId, :LogExpireDay, :HighLogExpireDay, :AuditAll, :AuditRuleFilters, :RuleTemplateIds
@@ -10622,9 +10650,9 @@ module TencentCloud
10622
10650
 
10623
10651
  # ModifyCdbProxyAddressDesc请求参数结构体
10624
10652
  class ModifyCdbProxyAddressDescRequest < TencentCloud::Common::AbstractModel
10625
- # @param ProxyGroupId: 代理组ID
10653
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
10626
10654
  # @type ProxyGroupId: String
10627
- # @param ProxyAddressId: 代理组地址ID
10655
+ # @param ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
10628
10656
  # @type ProxyAddressId: String
10629
10657
  # @param Desc: 描述
10630
10658
  # @type Desc: String
@@ -10662,19 +10690,19 @@ module TencentCloud
10662
10690
 
10663
10691
  # ModifyCdbProxyAddressVipAndVPort请求参数结构体
10664
10692
  class ModifyCdbProxyAddressVipAndVPortRequest < TencentCloud::Common::AbstractModel
10665
- # @param ProxyGroupId: 代理组ID
10693
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
10666
10694
  # @type ProxyGroupId: String
10667
- # @param ProxyAddressId: 代理组地址ID
10695
+ # @param ProxyAddressId: 代理组地址 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
10668
10696
  # @type ProxyAddressId: String
10669
- # @param UniqVpcId: 私有网络ID
10697
+ # @param UniqVpcId: 私有网络 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10670
10698
  # @type UniqVpcId: String
10671
- # @param UniqSubnetId: 私有子网ID
10699
+ # @param UniqSubnetId: 私有子网 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10672
10700
  # @type UniqSubnetId: String
10673
- # @param Vip: IP地址
10701
+ # @param Vip: IP 地址。若不填写则自动分配子网下的可用 IP。
10674
10702
  # @type Vip: String
10675
- # @param VPort: 端口
10703
+ # @param VPort: 端口。默认值3306,取值范围:1024 - 65535。
10676
10704
  # @type VPort: Integer
10677
- # @param ReleaseDuration: 旧IP地址回收时间
10705
+ # @param ReleaseDuration: 旧 IP 地址回收时间。单位:小时,默认值:24,取值范围:0 - 168。
10678
10706
  # @type ReleaseDuration: Integer
10679
10707
 
10680
10708
  attr_accessor :ProxyGroupId, :ProxyAddressId, :UniqVpcId, :UniqSubnetId, :Vip, :VPort, :ReleaseDuration
@@ -10718,11 +10746,11 @@ module TencentCloud
10718
10746
 
10719
10747
  # ModifyCdbProxyParam请求参数结构体
10720
10748
  class ModifyCdbProxyParamRequest < TencentCloud::Common::AbstractModel
10721
- # @param InstanceId: 实例ID
10749
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
10722
10750
  # @type InstanceId: String
10723
- # @param ProxyGroupId: 代理组ID
10751
+ # @param ProxyGroupId: 代理组 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
10724
10752
  # @type ProxyGroupId: String
10725
- # @param ConnectionPoolLimit: 连接池阈值
10753
+ # @param ConnectionPoolLimit: 连接池阈值。取值范围:大于0,小于等于300。
10726
10754
  # 注意:如需使用数据库代理连接池能力,MySQL 8.0 主实例的内核小版本要大于等于 MySQL 8.0 20230630。
10727
10755
  # @type ConnectionPoolLimit: Integer
10728
10756
 
@@ -11442,11 +11470,11 @@ module TencentCloud
11442
11470
 
11443
11471
  # ModifyRoGroupInfo请求参数结构体
11444
11472
  class ModifyRoGroupInfoRequest < TencentCloud::Common::AbstractModel
11445
- # @param RoGroupId: RO 组的 ID
11473
+ # @param RoGroupId: RO 组的 ID。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
11446
11474
  # @type RoGroupId: String
11447
11475
  # @param RoGroupInfo: RO 组的详细信息。
11448
11476
  # @type RoGroupInfo: :class:`Tencentcloud::Cdb.v20170320.models.RoGroupAttr`
11449
- # @param RoWeightValues: RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。
11477
+ # @param RoWeightValues: RO 组内实例的权重。若修改 RO 组的权重模式为用户自定义模式(custom),则必须设置该参数,且需要设置每个 RO 实例的权重值。RO 实例 ID 可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
11450
11478
  # @type RoWeightValues: Array
11451
11479
  # @param IsBalanceRoLoad: 是否重新均衡 RO 组内的 RO 实例的负载。支持值包括:1 - 重新均衡负载;0 - 不重新均衡负载。默认值为 0。注意,设置为重新均衡负载时,RO 组内 RO 实例会有一次数据库连接瞬断,请确保应用程序能重连数据库。
11452
11480
  # @type IsBalanceRoLoad: Integer
@@ -11617,26 +11645,32 @@ module TencentCloud
11617
11645
 
11618
11646
  # OpenAuditService请求参数结构体
11619
11647
  class OpenAuditServiceRequest < TencentCloud::Common::AbstractModel
11620
- # @param InstanceId: CDB实例ID
11648
+ # @param InstanceId: CDB 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
11621
11649
  # @type InstanceId: String
11622
11650
  # @param LogExpireDay: 审计日志保存时长。支持值包括:
11623
- # 7 - 一周
11651
+ # 7 - 一周;
11624
11652
  # 30 - 一个月;
11625
11653
  # 90 - 三个月;
11626
11654
  # 180 - 六个月;
11627
11655
  # 365 - 一年;
11628
11656
  # 1095 - 三年;
11629
- # 1825 - 五年;
11657
+ # 1825 - 五年。
11630
11658
  # @type LogExpireDay: Integer
11631
- # @param HighLogExpireDay: 高频审计日志保存时长。支持值包括:
11632
- # 7 - 一周
11659
+ # @param HighLogExpireDay: 高频审计日志保存时长。默认值为7,此项取值需小于等于 LogExpireDay,支持值包括:
11660
+ # 3 - 3天;
11661
+ # 7 - 一周;
11633
11662
  # 30 - 一个月;
11663
+ # 90 - 三个月;
11664
+ # 180 - 六个月;
11665
+ # 365 - 一年;
11666
+ # 1095 - 三年;
11667
+ # 1825 - 五年。
11634
11668
  # @type HighLogExpireDay: Integer
11635
11669
  # @param AuditRuleFilters: 审计规则(该参数已废弃,不再生效)。
11636
11670
  # @type AuditRuleFilters: Array
11637
- # @param RuleTemplateIds: 规则模板ID。同AuditRuleFilters都不填是全审计。
11671
+ # @param RuleTemplateIds: 规则模板 ID
11638
11672
  # @type RuleTemplateIds: Array
11639
- # @param AuditAll: 审计类型。true-全审计;默认false-规则审计。
11673
+ # @param AuditAll: 审计类型。true - 全审计;默认 false - 规则审计。
11640
11674
  # @type AuditAll: Boolean
11641
11675
 
11642
11676
  attr_accessor :InstanceId, :LogExpireDay, :HighLogExpireDay, :AuditRuleFilters, :RuleTemplateIds, :AuditAll
@@ -11688,7 +11722,7 @@ module TencentCloud
11688
11722
 
11689
11723
  # OpenDBInstanceEncryption请求参数结构体
11690
11724
  class OpenDBInstanceEncryptionRequest < TencentCloud::Common::AbstractModel
11691
- # @param InstanceId: 云数据库实例 ID
11725
+ # @param InstanceId: 云数据库实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
11692
11726
  # @type InstanceId: String
11693
11727
  # @param KeyId: 用户自定义密钥 ID,CMK 唯一标识符。该值为空时,将使用腾讯云自动生成的密钥 KMS-CDB。
11694
11728
  # @type KeyId: String
@@ -11764,9 +11798,9 @@ module TencentCloud
11764
11798
 
11765
11799
  # OpenSSL请求参数结构体
11766
11800
  class OpenSSLRequest < TencentCloud::Common::AbstractModel
11767
- # @param InstanceId: 实例 ID
11801
+ # @param InstanceId: 实例 ID。只读组 ID 为空时必填。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
11768
11802
  # @type InstanceId: String
11769
- # @param RoGroupId: 只读组 ID
11803
+ # @param RoGroupId: 只读组 ID。实例 ID 为空时必填。可通过 [DescribeRoGroups](https://cloud.tencent.com/document/api/236/40939) 接口获取。
11770
11804
  # @type RoGroupId: String
11771
11805
 
11772
11806
  attr_accessor :InstanceId, :RoGroupId
@@ -11804,7 +11838,7 @@ module TencentCloud
11804
11838
 
11805
11839
  # OpenWanService请求参数结构体
11806
11840
  class OpenWanServiceRequest < TencentCloud::Common::AbstractModel
11807
- # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
11841
+ # @param InstanceId: 实例 ID,格式如:cdb-c1nl9rpv,与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。可以传入只读组 ID。
11808
11842
  # @type InstanceId: String
11809
11843
  # @param OpResourceId: 变更集群版实例只读组时,InstanceId传实例id,需要额外指定该参数表示操作只读组。 如果操作读写节点则不需指定该参数。
11810
11844
  # @type OpResourceId: String
@@ -12828,15 +12862,17 @@ module TencentCloud
12828
12862
  class RoGroupAttr < TencentCloud::Common::AbstractModel
12829
12863
  # @param RoGroupName: RO 组名称。
12830
12864
  # @type RoGroupName: String
12831
- # @param RoMaxDelayTime: RO 实例最大延迟阈值。单位为秒,最小值为 1。注意,RO 组必须设置了开启实例延迟剔除策略,该值才有效。
12865
+ # @param RoMaxDelayTime: RO 实例最大延迟阈值。单位为秒,最小值为 1。范围:[1,10000],整数。
12866
+ # 注意:RO 组必须设置了开启实例延迟剔除策略,该值才有效。
12832
12867
  # @type RoMaxDelayTime: Integer
12833
12868
  # @param RoOfflineDelay: 是否开启实例延迟剔除。支持的值包括:1 - 开启;0 - 不开启。注意,若设置开启实例延迟剔除,则必须设置延迟阈值(RoMaxDelayTime)参数。
12834
12869
  # @type RoOfflineDelay: Integer
12835
- # @param MinRoInGroup: 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。注意,若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
12870
+ # @param MinRoInGroup: 最少保留实例数。可设置为小于或等于该 RO 组下 RO 实例个数的任意值。默认值为1。
12871
+ # 注意:若设置值大于 RO 实例数量将不做剔除;若设置为 0,所有实例延迟超限都会被剔除。
12836
12872
  # @type MinRoInGroup: Integer
12837
12873
  # @param WeightMode: 权重模式。支持值包括:"system" - 系统自动分配; "custom" - 用户自定义设置。注意,若设置 "custom" 模式,则必须设置 RO 实例权重配置(RoWeightValues)参数。
12838
12874
  # @type WeightMode: String
12839
- # @param ReplicationDelayTime: 延迟复制时间。
12875
+ # @param ReplicationDelayTime: 延迟复制时间。单位:秒,范围:1 - 259200秒,不传此参数表示不开启实例延迟复制。
12840
12876
  # @type ReplicationDelayTime: Integer
12841
12877
 
12842
12878
  attr_accessor :RoGroupName, :RoMaxDelayTime, :RoOfflineDelay, :MinRoInGroup, :WeightMode, :ReplicationDelayTime
@@ -13629,7 +13665,7 @@ module TencentCloud
13629
13665
 
13630
13666
  # StartCpuExpand请求参数结构体
13631
13667
  class StartCpuExpandRequest < TencentCloud::Common::AbstractModel
13632
- # @param InstanceId: 实例 ID
13668
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
13633
13669
  # @type InstanceId: String
13634
13670
  # @param Type: 扩容类型,支持自动扩容和自定义扩容。
13635
13671
  # 说明:1. auto 表示自动扩容。2. manual 表示自定义扩容,扩容时间为立即生效。3. timeInterval 表示自定义扩容,扩容时间为按时间段。4. period 表示自定义扩容,扩容时间为按周期。
@@ -13640,8 +13676,10 @@ module TencentCloud
13640
13676
  # @param AutoStrategy: 自动扩容策略。Type 为 auto 时必传。
13641
13677
  # @type AutoStrategy: :class:`Tencentcloud::Cdb.v20170320.models.AutoStrategy`
13642
13678
  # @param TimeIntervalStrategy: 按时间段扩容策略。
13679
+ # 说明:当 Type 为 timeInterval 时,TimeIntervalStrategy 必填。
13643
13680
  # @type TimeIntervalStrategy: :class:`Tencentcloud::Cdb.v20170320.models.TimeIntervalStrategy`
13644
13681
  # @param PeriodStrategy: 按周期扩容策略。
13682
+ # 说明:当 Type 为 period 时,PeriodStrategy 必填。
13645
13683
  # @type PeriodStrategy: :class:`Tencentcloud::Cdb.v20170320.models.PeriodStrategy`
13646
13684
 
13647
13685
  attr_accessor :InstanceId, :Type, :ExpandCpu, :AutoStrategy, :TimeIntervalStrategy, :PeriodStrategy
@@ -13676,7 +13714,7 @@ module TencentCloud
13676
13714
 
13677
13715
  # StartCpuExpand返回参数结构体
13678
13716
  class StartCpuExpandResponse < TencentCloud::Common::AbstractModel
13679
- # @param AsyncRequestId: 异步任务 ID 。可以调用DescribeAsyncRequest 传入该 ID ,进行任务执行进度的查询
13717
+ # @param AsyncRequestId: 异步任务 ID 。可以调用 DescribeAsyncRequest 传入该 ID,进行任务执行进度的查询。
13680
13718
  # @type AsyncRequestId: String
13681
13719
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
13682
13720
  # @type RequestId: String
@@ -13872,9 +13910,10 @@ module TencentCloud
13872
13910
 
13873
13911
  # SubmitInstanceUpgradeCheckJob请求参数结构体
13874
13912
  class SubmitInstanceUpgradeCheckJobRequest < TencentCloud::Common::AbstractModel
13875
- # @param InstanceId: 实例 ID
13913
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
13876
13914
  # @type InstanceId: String
13877
13915
  # @param DstMysqlVersion: 目标数据库版本。
13916
+ # 说明:可选值5.6、5.7、8.0,不支持跨版本升级,升级后不支持版本降级。
13878
13917
  # @type DstMysqlVersion: String
13879
13918
 
13880
13919
  attr_accessor :InstanceId, :DstMysqlVersion
@@ -13912,9 +13951,9 @@ module TencentCloud
13912
13951
 
13913
13952
  # SwitchCDBProxy请求参数结构体
13914
13953
  class SwitchCDBProxyRequest < TencentCloud::Common::AbstractModel
13915
- # @param InstanceId: 实例ID
13954
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
13916
13955
  # @type InstanceId: String
13917
- # @param ProxyGroupId: 数据库代理ID
13956
+ # @param ProxyGroupId: 数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
13918
13957
  # @type ProxyGroupId: String
13919
13958
 
13920
13959
  attr_accessor :InstanceId, :ProxyGroupId
@@ -14394,9 +14433,9 @@ module TencentCloud
14394
14433
 
14395
14434
  # UpgradeCDBProxyVersion请求参数结构体
14396
14435
  class UpgradeCDBProxyVersionRequest < TencentCloud::Common::AbstractModel
14397
- # @param InstanceId: 实例ID
14436
+ # @param InstanceId: 实例 ID。可通过 [DescribeDBInstances](https://cloud.tencent.com/document/product/236/15872) 接口获取。
14398
14437
  # @type InstanceId: String
14399
- # @param ProxyGroupId: 数据库代理ID
14438
+ # @param ProxyGroupId: 数据库代理 ID。可通过 [DescribeCdbProxyInfo](https://cloud.tencent.com/document/api/236/90585) 接口获取。
14400
14439
  # @type ProxyGroupId: String
14401
14440
  # @param SrcProxyVersion: 数据库代理当前版本
14402
14441
  # @type SrcProxyVersion: String
@@ -14526,11 +14565,12 @@ module TencentCloud
14526
14565
  # @type DeployMode: Integer
14527
14566
  # @param SlaveZone: 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
14528
14567
  # @type SlaveZone: String
14529
- # @param EngineVersion: 主实例数据库引擎版本,支持值包括:5.5、5.65.7。
14568
+ # @param EngineVersion: 主实例数据库引擎版本,支持值包括:5.5、5.65.7、8.0
14569
+ # 说明:升级数据库版本请使用 [UpgradeDBInstanceEngineVersion](https://cloud.tencent.com/document/api/236/15870) 接口。
14530
14570
  # @type EngineVersion: String
14531
14571
  # @param WaitSwitch: 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
14532
14572
  # @type WaitSwitch: Integer
14533
- # @param BackupZone: 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
14573
+ # @param BackupZone: 备库2的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
14534
14574
  # 备注:如您要将三节点降级至双节点,将该参数设置为空值即可实现。
14535
14575
  # @type BackupZone: String
14536
14576
  # @param InstanceRole: 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
@@ -14618,7 +14658,7 @@ module TencentCloud
14618
14658
  class UpgradeDBInstanceResponse < TencentCloud::Common::AbstractModel
14619
14659
  # @param DealIds: 订单 ID。
14620
14660
  # @type DealIds: Array
14621
- # @param AsyncRequestId: 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
14661
+ # @param AsyncRequestId: 异步任务的请求 ID,可使用此 ID [查询异步任务的执行结果](https://cloud.tencent.com/document/product/236/20410)。
14622
14662
  # @type AsyncRequestId: String
14623
14663
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
14624
14664
  # @type RequestId: String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-cdb
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.1087
4
+ version: 3.0.1090
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-06-23 00:00:00.000000000 Z
11
+ date: 2025-06-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common