tencentcloud-sdk-mongodb 3.0.1140 → 3.0.1149

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.
@@ -17,14 +17,14 @@
17
17
  module TencentCloud
18
18
  module Mongodb
19
19
  module V20190725
20
- # 修改实例节点详情
20
+ # 修改实例节点详情。
21
21
  class AddNodeList < TencentCloud::Common::AbstractModel
22
22
  # @param Role: 需要新增的节点角色。
23
23
  # - SECONDARY:Mongod 节点。
24
24
  # - READONLY:只读节点。
25
25
  # - MONGOS:Mongos 节点。
26
26
  # @type Role: String
27
- # @param Zone: 节点所对应的可用区。
27
+ # @param Zone: 节点所对应的可用区。当前支持的可用区,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
28
28
  # - 单可用区,所有节点在同一可用区。
29
29
  # - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。
30
30
  # @type Zone: String
@@ -46,7 +46,7 @@ module TencentCloud
46
46
  class AssignProjectRequest < TencentCloud::Common::AbstractModel
47
47
  # @param InstanceIds: 实例 ID 列表,请登录[MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
48
48
  # @type InstanceIds: Array
49
- # @param ProjectId: 项目ID,用户已创建项目的唯一ID。请在控制台账号中心的项目管理中复制项目 ID。
49
+ # @param ProjectId: 项目ID,用户已创建项目的唯一ID。请在控制台账号中心的[项目管理](https://console.cloud.tencent.com/project)中复制项目 ID。
50
50
  # @type ProjectId: Integer
51
51
 
52
52
  attr_accessor :InstanceIds, :ProjectId
@@ -84,11 +84,15 @@ module TencentCloud
84
84
 
85
85
  # 用户权限
86
86
  class Auth < TencentCloud::Common::AbstractModel
87
- # @param Mask: 当前账号具有的权限信息。<ul><li>0:无权限。</li><li>1:只读。</li><li>2:只写。</li><li>3:读写。</li></ul>
87
+ # @param Mask: 当前账号具有的权限信息。
88
+ # - 0:无权限。
89
+ # - 1:只读。
90
+ # - 3:读写。
88
91
  # 注意:此字段可能返回 null,表示取不到有效值。
89
92
  # @type Mask: Integer
90
93
  # @param NameSpace: 指具有当前账号权限的数据库名。
91
- # <ul><li>* :表示所有数据库。</li><li>db.name:表示特定name的数据库。</li></ul>
94
+ # - \* :表示所有数据库。
95
+ # - db.name:表示特定 name 的数据库。
92
96
  # 注意:此字段可能返回 null,表示取不到有效值。
93
97
  # @type NameSpace: String
94
98
 
@@ -107,25 +111,36 @@ module TencentCloud
107
111
 
108
112
  # 备份下载任务
109
113
  class BackupDownloadTask < TencentCloud::Common::AbstractModel
110
- # @param CreateTime: 任务创建时间
114
+ # @param CreateTime: 任务创建时间。
111
115
  # @type CreateTime: String
112
- # @param BackupName: 备份文件名
116
+ # @param BackupName: 备份文件名。
113
117
  # @type BackupName: String
114
- # @param ReplicaSetId: 分片名称
118
+ # @param ReplicaSetId: 分片名称。
115
119
  # @type ReplicaSetId: String
116
- # @param BackupSize: 备份数据大小,单位为字节
120
+ # @param BackupSize: 备份数据大小,单位:字节。
117
121
  # @type BackupSize: Integer
118
- # @param Status: 任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
122
+ # @param Status: 任务状态。
123
+ # - 0:等待执行。
124
+ # - 1:正在下载。
125
+ # - 2:下载完成。
126
+ # - 3:下载失败。
127
+ # - 4:等待重试。
119
128
  # @type Status: Integer
120
- # @param Percent: 任务进度百分比
129
+ # @param Percent: 任务进度百分比。
121
130
  # @type Percent: Integer
122
- # @param TimeSpend: 耗时,单位为秒
131
+ # @param TimeSpend: 耗时,单位为秒。
123
132
  # @type TimeSpend: Integer
124
- # @param Url: 备份数据下载链接
133
+ # @param Url: 备份数据下载链接。
125
134
  # @type Url: String
126
- # @param BackupMethod: 备份文件备份类型,0-逻辑备份,1-物理备份
135
+ # @param BackupMethod: 备份方式。
136
+ # - 0:逻辑备份。
137
+ # - 1:物理备份。
138
+ # - 3:快照备份。
139
+ # **说明**:
140
+ # 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
141
+ # 2. 实例开通存储加密,则备份方式不能为物理备份。
127
142
  # @type BackupMethod: Integer
128
- # @param BackupDesc: 发起备份时指定的备注信息
143
+ # @param BackupDesc: 发起备份时指定的备注信息。
129
144
  # @type BackupDesc: String
130
145
  # @param Region: 地区信息。
131
146
  # @type Region: String
@@ -165,11 +180,16 @@ module TencentCloud
165
180
  end
166
181
  end
167
182
 
168
- # 创建备份下载任务结果
183
+ # 创建备份下载任务结果。
169
184
  class BackupDownloadTaskStatus < TencentCloud::Common::AbstractModel
170
- # @param ReplicaSetId: 分片名
185
+ # @param ReplicaSetId: 分片名。
171
186
  # @type ReplicaSetId: String
172
- # @param Status: 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
187
+ # @param Status: 任务当前状态。
188
+ # - 0:等待执行。
189
+ # - 1:正在下载。
190
+ # - 2:下载完成。
191
+ # - 3:下载失败。
192
+ # - 4:等待重试。
173
193
  # @type Status: Integer
174
194
 
175
195
  attr_accessor :ReplicaSetId, :Status
@@ -185,36 +205,48 @@ module TencentCloud
185
205
  end
186
206
  end
187
207
 
188
- # 备份信息
208
+ # 备份信息。
189
209
  class BackupInfo < TencentCloud::Common::AbstractModel
190
210
  # @param InstanceId: 实例ID。
191
211
  # @type InstanceId: String
192
- # @param BackupType: 备份方式,0-自动备份,1-手动备份
212
+ # @param BackupType: 备份方式。
213
+ # - 0:自动备份。
214
+ # - 1:手动备份。
193
215
  # @type BackupType: Integer
194
- # @param BackupName: 备份名称
216
+ # @param BackupName: 备份文件名称。
195
217
  # @type BackupName: String
196
- # @param BackupDesc: 备份备注
218
+ # @param BackupDesc: 备份任务备注信息。
197
219
  # @type BackupDesc: String
198
- # @param BackupSize: 备份文件大小,单位KB
220
+ # @param BackupSize: 备份文件大小,单位:KB
199
221
  # @type BackupSize: Integer
200
- # @param StartTime: 备份开始时间
222
+ # @param StartTime: 备份开始时间。
201
223
  # @type StartTime: String
202
- # @param EndTime: 备份结束时间
224
+ # @param EndTime: 备份结束时间。
203
225
  # @type EndTime: String
204
- # @param Status: 备份状态,1-备份中,2-备份成功
226
+ # @param Status: 备份状态。
227
+ # - 1:备份中。
228
+ # - 2:备份成功。
205
229
  # @type Status: Integer
206
- # @param BackupMethod: 备份方法,0-逻辑备份,1-物理备份
230
+ # @param BackupMethod: 备份方式。
231
+ # - 0:逻辑备份。
232
+ # - 1:物理备份。
233
+ # - 3:快照备份。
234
+ # **说明:**
235
+ # - 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
236
+ # - 实例开通存储加密,则备份方式不能为物理备份。
207
237
  # @type BackupMethod: Integer
208
- # @param BackId: 备份记录id
238
+ # @param BackId: 备份记录 ID。
209
239
  # @type BackId: Integer
210
- # @param DeleteTime: 备份删除时间
240
+ # @param DeleteTime: 备份删除时间。
211
241
  # @type DeleteTime: String
212
- # @param BackupRegion: 异地备份地域
242
+ # @param BackupRegion: 异地备份地域。
213
243
  # @type BackupRegion: String
244
+ # @param RestoreTime: 备份支持的回档时间。
245
+ # @type RestoreTime: String
214
246
 
215
- attr_accessor :InstanceId, :BackupType, :BackupName, :BackupDesc, :BackupSize, :StartTime, :EndTime, :Status, :BackupMethod, :BackId, :DeleteTime, :BackupRegion
247
+ attr_accessor :InstanceId, :BackupType, :BackupName, :BackupDesc, :BackupSize, :StartTime, :EndTime, :Status, :BackupMethod, :BackId, :DeleteTime, :BackupRegion, :RestoreTime
216
248
 
217
- def initialize(instanceid=nil, backuptype=nil, backupname=nil, backupdesc=nil, backupsize=nil, starttime=nil, endtime=nil, status=nil, backupmethod=nil, backid=nil, deletetime=nil, backupregion=nil)
249
+ def initialize(instanceid=nil, backuptype=nil, backupname=nil, backupdesc=nil, backupsize=nil, starttime=nil, endtime=nil, status=nil, backupmethod=nil, backid=nil, deletetime=nil, backupregion=nil, restoretime=nil)
218
250
  @InstanceId = instanceid
219
251
  @BackupType = backuptype
220
252
  @BackupName = backupname
@@ -227,6 +259,7 @@ module TencentCloud
227
259
  @BackId = backid
228
260
  @DeleteTime = deletetime
229
261
  @BackupRegion = backupregion
262
+ @RestoreTime = restoretime
230
263
  end
231
264
 
232
265
  def deserialize(params)
@@ -242,16 +275,17 @@ module TencentCloud
242
275
  @BackId = params['BackId']
243
276
  @DeleteTime = params['DeleteTime']
244
277
  @BackupRegion = params['BackupRegion']
278
+ @RestoreTime = params['RestoreTime']
245
279
  end
246
280
  end
247
281
 
248
282
  # 客户端连接信息,包括客户端IP和连接数
249
283
  class ClientConnection < TencentCloud::Common::AbstractModel
250
- # @param IP: 连接的客户端IP
284
+ # @param IP: 连接的客户端 IP
251
285
  # @type IP: String
252
- # @param Count: 对应客户端IP的连接数
286
+ # @param Count: 对应客户端 IP 的连接数。
253
287
  # @type Count: Integer
254
- # @param InternalService: 是否为内部ip
288
+ # @param InternalService: 是否为内部 IP。
255
289
  # @type InternalService: Boolean
256
290
 
257
291
  attr_accessor :IP, :Count, :InternalService
@@ -273,9 +307,13 @@ module TencentCloud
273
307
  class CreateAccountUserRequest < TencentCloud::Common::AbstractModel
274
308
  # @param InstanceId: 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
275
309
  # @type InstanceId: String
276
- # @param UserName: 新账号名称。其格式要求如下:<ul><li>字符范围[1,32]。</li><li>可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。</li></ul>
310
+ # @param UserName: 新账号名称。其格式要求如下:
311
+ # - 字符范围[1,64]。
312
+ # - 可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“\_”与短划线“-”。
277
313
  # @type UserName: String
278
- # @param Password: 新账号密码。密码复杂度要求如下:<ul><li>字符长度范围[8,32]。</li><li>至少包含字母、数字和特殊字符(叹号“!”、at"@"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。</li></ul>
314
+ # @param Password: 新账号密码。密码复杂度要求如下:
315
+ # - 字符长度范围[8,32]。
316
+ # - 至少包含字母、数字和特殊字符(叹号“!”、at"@"、井号“#”、百分号“%”、插入符“^”、星号“\*”、小括号“()”、下划线“\_”)中的两种。
279
317
  # @type Password: String
280
318
  # @param MongoUserPassword: mongouser 账号对应的密码。mongouser 为系统默认账号,即为创建实例时,设置的密码。
281
319
  # @type MongoUserPassword: String
@@ -339,6 +377,10 @@ module TencentCloud
339
377
  # @param BackupMethod: 设置备份方式。
340
378
  # - 0:逻辑备份。
341
379
  # - 1:物理备份。
380
+ # - 3:快照备份。
381
+ # **说明**:
382
+ # 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
383
+ # 2. 实例开通存储加密,则备份方式不能为物理备份。
342
384
  # @type BackupMethod: Integer
343
385
  # @param BackupRemark: 备份备注信息。
344
386
  # @type BackupRemark: String
@@ -380,13 +422,13 @@ module TencentCloud
380
422
 
381
423
  # CreateBackupDownloadTask请求参数结构体
382
424
  class CreateBackupDownloadTaskRequest < TencentCloud::Common::AbstractModel
383
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
425
+ # @param InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
384
426
  # @type InstanceId: String
385
- # @param BackupName: 要下载的备份文件名,可通过DescribeDBBackups接口获取。
427
+ # @param BackupName: 要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。
386
428
  # @type BackupName: String
387
- # @param BackupSets: 指定要下载的副本集的节点名称 分片集群的分片名称列表。
388
- # 如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
389
- # 如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。
429
+ # @param BackupSets: 指定要下载的副本集节点 ID 或分片集群的分片节点 ID 列表。
430
+ # - 如副本集实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
431
+ # - 如分片集群实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据。分片集群如需全量下载,请按示例方式传入全部分片名称。
390
432
  # @type BackupSets: Array
391
433
 
392
434
  attr_accessor :InstanceId, :BackupName, :BackupSets
@@ -413,7 +455,7 @@ module TencentCloud
413
455
 
414
456
  # CreateBackupDownloadTask返回参数结构体
415
457
  class CreateBackupDownloadTaskResponse < TencentCloud::Common::AbstractModel
416
- # @param Tasks: 下载任务状态
458
+ # @param Tasks: 下载任务状态。
417
459
  # @type Tasks: Array
418
460
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
419
461
  # @type RequestId: String
@@ -451,18 +493,18 @@ module TencentCloud
451
493
  # - 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
452
494
  # @type NodeNum: Integer
453
495
  # @param MongoVersion: 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
454
- # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
455
496
  # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
456
497
  # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
457
498
  # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
458
499
  # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
459
500
  # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
501
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
460
502
  # @type MongoVersion: String
461
503
  # @param MachineCode: 产品规格类型。
462
504
  # - HIO10G:通用高HIO万兆型。
463
505
  # - HCD:云盘版类型。
464
506
  # @type MachineCode: String
465
- # @param GoodsNum: 实例数量,最小值1,最大值为10
507
+ # @param GoodsNum: 实例数量,最小值1,最大值为30
466
508
  # @type GoodsNum: Integer
467
509
  # @param Zone: 可用区信息,输入格式如:ap-guangzhou-2。
468
510
  # - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
@@ -472,9 +514,13 @@ module TencentCloud
472
514
  # - REPLSET:副本集。
473
515
  # - SHARD:分片集群。
474
516
  # @type ClusterType: String
475
- # @param VpcId: 私有网络ID。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询确认正确的ID 示例值:vpc-pxyzim13
517
+ # @param VpcId: 私有网络ID。
518
+ # - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
519
+ # - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
476
520
  # @type VpcId: String
477
- # @param SubnetId: 私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值:subnet-7jbabche
521
+ # @param SubnetId: 私有网络 VPC 的子网 ID。
522
+ # - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
523
+ # - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
478
524
  # @type SubnetId: String
479
525
  # @param Password: 实例密码。设置要求如下:
480
526
  # - 字符个数为[8,32]。
@@ -488,17 +534,26 @@ module TencentCloud
488
534
  # @type ProjectId: Integer
489
535
  # @param Tags: 实例标签信息。
490
536
  # @type Tags: Array
491
- # @param Clone: 实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:克隆实例,注意:克隆实例RestoreTime为必填项。
537
+ # @param Clone: 实例类型。
538
+ # - 1:正式实例。
539
+ # - 3:只读实例。
540
+ # - 4:灾备实例。
541
+ # - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
492
542
  # @type Clone: Integer
493
- # @param Father: 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
543
+ # @param Father: 父实例 ID
544
+ # - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
545
+ # - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
494
546
  # @type Father: String
495
- # @param SecurityGroup: 安全组 ID。
547
+ # @param SecurityGroup: 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
496
548
  # @type SecurityGroup: Array
497
549
  # @param RestoreTime: 克隆实例回档时间。
498
550
  # - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
499
551
  # - 回档时间范围:仅能回档7天内时间点的数据。
500
552
  # @type RestoreTime: String
501
- # @param InstanceName: 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
553
+ # @param InstanceName: 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
554
+ # - 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
555
+ # - 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
556
+ # - 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
502
557
  # @type InstanceName: String
503
558
  # @param AvailabilityZoneList: 若多可用区部署云数据库实例,指定多可用区列表。
504
559
  # - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
@@ -510,7 +565,6 @@ module TencentCloud
510
565
  # @param MongosMemory: Mongos 内存大小。
511
566
  # - 购买分片集群时,必须填写。
512
567
  # - 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
513
-
514
568
  # @type MongosMemory: Integer
515
569
  # @param MongosNodeNum: Mongos 数量。购买分片集群时,必须填写。
516
570
  # - 单可用区部署实例,其数量范围为[3,32]。
@@ -522,7 +576,9 @@ module TencentCloud
522
576
  # @type ReadonlyNodeAvailabilityZoneList: Array
523
577
  # @param HiddenZone: Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
524
578
  # @type HiddenZone: String
525
- # @param ParamTemplateId: 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本。
579
+ # @param ParamTemplateId: 参数模板 ID
580
+ # - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
581
+ # - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
526
582
  # @type ParamTemplateId: String
527
583
 
528
584
  attr_accessor :Memory, :Volume, :ReplicateSetNum, :NodeNum, :MongoVersion, :MachineCode, :GoodsNum, :Zone, :ClusterType, :VpcId, :SubnetId, :Password, :ProjectId, :Tags, :Clone, :Father, :SecurityGroup, :RestoreTime, :InstanceName, :AvailabilityZoneList, :MongosCpu, :MongosMemory, :MongosNodeNum, :ReadonlyNodeNum, :ReadonlyNodeAvailabilityZoneList, :HiddenZone, :ParamTemplateId
@@ -623,16 +679,26 @@ module TencentCloud
623
679
  class CreateDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
624
680
  # @param TplName: 参数模板名称。
625
681
  # @type TplName: String
626
- # @param MongoVersion: 版本号,该参数模板支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是:MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。当MirrorTplId为空时,该字段必填。
682
+ # @param MongoVersion: 参数模板版本号。当**MirrorTplId**为空时,该字段必填。参数模板支持的售卖版本,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
683
+ # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
684
+ # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
685
+ # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
686
+ # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
687
+ # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
688
+ # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
689
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
627
690
  # @type MongoVersion: String
628
- # @param ClusterType: 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
629
- # 当MirrorTplId为空时,该字段必填。
691
+ # @param ClusterType: 实例类型。当 MirrorTplId 为空值时,该参数必填。
692
+ # - REPLSET:副本集实例。
693
+ # - SHARD:分片实例。
694
+ # - STANDALONE:单节点实例。
630
695
  # @type ClusterType: String
631
696
  # @param TplDesc: 模板描述信息。
632
697
  # @type TplDesc: String
633
- # @param Params: 模板参数,若为空,则以系统默认模板作为新版本参数。
698
+ # @param Params: 模板参数,若不配置该参数,则以系统默认模板作为新版本参数。
634
699
  # @type Params: Array
635
- # @param MirrorTplId: 镜像模板ID,若该字段不为空,则以该模板为镜像,克隆出一个新的模板。注意:MirrorTplId不为空时,MongoVersion及ClusterType将以MirrorTpl模板的版本及实例类型为准。
700
+ # @param MirrorTplId: 镜像模板 ID。若指定镜像模板,则以该模板为镜像,克隆出一个新的模板。
701
+ # **注意**:MirrorTplId 不为空值时,MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。
636
702
  # @type MirrorTplId: String
637
703
 
638
704
  attr_accessor :TplName, :MongoVersion, :ClusterType, :TplDesc, :Params, :MirrorTplId
@@ -693,14 +759,14 @@ module TencentCloud
693
759
  # @param Volume: 实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
694
760
  # @type Volume: Integer
695
761
  # @param MongoVersion: 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
696
- # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
697
762
  # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
698
763
  # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
699
764
  # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
700
765
  # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
701
766
  # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
767
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
702
768
  # @type MongoVersion: String
703
- # @param GoodsNum: 实例数量, 最小值1,最大值为10
769
+ # @param GoodsNum: 实例数量, 最小值1,最大值为30
704
770
  # @type GoodsNum: Integer
705
771
  # @param Zone: 可用区信息,输入格式如:ap-guangzhou-2。
706
772
  # - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
@@ -723,9 +789,13 @@ module TencentCloud
723
789
  # - 若不设置该参数,则为默认项目。
724
790
  # - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面,可获取项目ID。
725
791
  # @type ProjectId: Integer
726
- # @param VpcId: 私有网络ID。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)查询确认正确的ID 示例值:vpc-pxyzim13
792
+ # @param VpcId: 私有网络 ID。
793
+ # - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
794
+ # - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
727
795
  # @type VpcId: String
728
- # @param SubnetId: 私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值:subnet-7jbabche
796
+ # @param SubnetId: 私有网络 VPC 的子网 ID。
797
+ # - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
798
+ # - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
729
799
  # @type SubnetId: String
730
800
  # @param Password: 实例密码。设置要求如下:
731
801
  # - 字符个数为[8,32]。
@@ -743,15 +813,24 @@ module TencentCloud
743
813
  # - 1:是。
744
814
  # - 0:否。默认为0。
745
815
  # @type AutoVoucher: Integer
746
- # @param Clone: 实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:整实例克隆,注意:克隆实例时,RestoreTime为必填项。
816
+ # @param Clone: 实例类型。
817
+ # - 1:正式实例。
818
+ # - 3:只读实例。
819
+ # - 4:灾备实例。
820
+ # - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
747
821
  # @type Clone: Integer
748
- # @param Father: 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
822
+ # @param Father: 父实例 ID
823
+ # - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
824
+ # - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
749
825
  # @type Father: String
750
- # @param SecurityGroup: 安全组 ID。
826
+ # @param SecurityGroup: 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
751
827
  # @type SecurityGroup: Array
752
828
  # @param RestoreTime: 克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。
753
829
  # @type RestoreTime: String
754
- # @param InstanceName: 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
830
+ # @param InstanceName: 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
831
+ # - 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
832
+ # - 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
833
+ # - 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
755
834
  # @type InstanceName: String
756
835
  # @param AvailabilityZoneList: 若多可用区部署云数据库实例,指定多可用区列表。
757
836
  # - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
@@ -774,7 +853,9 @@ module TencentCloud
774
853
  # @type ReadonlyNodeAvailabilityZoneList: Array
775
854
  # @param HiddenZone: Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
776
855
  # @type HiddenZone: String
777
- # @param ParamTemplateId: 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本及实例类型。
856
+ # @param ParamTemplateId: 参数模板 ID
857
+ # - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
858
+ # - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
778
859
  # @type ParamTemplateId: String
779
860
 
780
861
  attr_accessor :NodeNum, :Memory, :Volume, :MongoVersion, :GoodsNum, :Zone, :Period, :MachineCode, :ClusterType, :ReplicateSetNum, :ProjectId, :VpcId, :SubnetId, :Password, :Tags, :AutoRenewFlag, :AutoVoucher, :Clone, :Father, :SecurityGroup, :RestoreTime, :InstanceName, :AvailabilityZoneList, :MongosCpu, :MongosMemory, :MongosNodeNum, :ReadonlyNodeNum, :ReadonlyNodeAvailabilityZoneList, :HiddenZone, :ParamTemplateId
@@ -885,7 +966,15 @@ module TencentCloud
885
966
  # @type Ns: String
886
967
  # @param Query: 操作执行语句。
887
968
  # @type Query: String
888
- # @param Op: 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command。
969
+ # @param Op: 操作类型。
970
+ # - none:特殊状态,空闲连接或内部任务等。
971
+ # - update:更新数据。
972
+ # - insert:插入操作。
973
+ # - query:查询操作。
974
+ # - command:命令操作。
975
+ # - getmore:获取更多数据。
976
+ # - remove:删除操作。
977
+ # - killcursors:释放查询游标的操作。
889
978
  # @type Op: String
890
979
  # @param ReplicaSetName: 操作所在的分片名称。
891
980
  # @type ReplicaSetName: String
@@ -893,7 +982,9 @@ module TencentCloud
893
982
  # @type NodeName: String
894
983
  # @param Operation: 操作详细信息。
895
984
  # @type Operation: String
896
- # @param State: 筛选条件,节点状态,可能的取值为:Primary、Secondary。
985
+ # @param State: 节点角色。
986
+ # - primary:主节点。
987
+ # - secondary:从节点。
897
988
  # @type State: String
898
989
  # @param MicrosecsRunning: 操作已执行时间(ms)。
899
990
  # @type MicrosecsRunning: Integer
@@ -951,11 +1042,11 @@ module TencentCloud
951
1042
 
952
1043
  # 数据库实例价格
953
1044
  class DBInstancePrice < TencentCloud::Common::AbstractModel
954
- # @param UnitPrice: 单价
1045
+ # @param UnitPrice: 实例单价。单位:元。
955
1046
  # @type UnitPrice: Float
956
- # @param OriginalPrice: 原价
1047
+ # @param OriginalPrice: 实例原价。单位:元。
957
1048
  # @type OriginalPrice: Float
958
- # @param DiscountPrice: 折扣价
1049
+ # @param DiscountPrice: 实例折扣价。单位:元。
959
1050
  # @type DiscountPrice: Float
960
1051
 
961
1052
  attr_accessor :UnitPrice, :OriginalPrice, :DiscountPrice
@@ -1128,23 +1219,32 @@ module TencentCloud
1128
1219
 
1129
1220
  # DescribeBackupDownloadTask请求参数结构体
1130
1221
  class DescribeBackupDownloadTaskRequest < TencentCloud::Common::AbstractModel
1131
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1222
+ # @param InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1132
1223
  # @type InstanceId: String
1133
- # @param BackupName: 备份文件名,用来过滤指定文件的下载任务
1224
+ # @param BackupName: 指定备份文件名,用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
1134
1225
  # @type BackupName: String
1135
- # @param StartTime: 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
1226
+ # @param StartTime: 指定查询时间范围内的任务,StartTime 指定开始时间。若不指定开始时间,则默认不限制开始时间。
1136
1227
  # @type StartTime: String
1137
- # @param EndTime: 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
1228
+ # @param EndTime: 指定查询时间范围内的任务,EndTime 指定截止时间。若不指定截止时间,则默认不限制截止时间。
1138
1229
  # @type EndTime: String
1139
- # @param Limit: 此次查询返回的条数,取值范围为1-100,默认为20
1230
+ # @param Limit: 此次查询返回的条数,取值范围为1-100,默认为20
1140
1231
  # @type Limit: Integer
1141
- # @param Offset: 指定此次查询返回的页数,默认为0
1232
+ # @param Offset: 指定此次查询返回的页数,默认为0
1142
1233
  # @type Offset: Integer
1143
- # @param OrderBy: 排序字段,取值为createTime,finishTime两种,默认为createTime
1234
+ # @param OrderBy: 排序字段。
1235
+ # - createTime:按照备份下载任务的创建时间排序。默认为 createTime。
1236
+ # - finishTime:按照备份下载任务的完成时间排序。
1144
1237
  # @type OrderBy: String
1145
- # @param OrderByType: 排序方式,取值为asc,desc两种,默认desc
1238
+ # @param OrderByType: 排序方式。
1239
+ # - asc:升序排列。
1240
+ # - desc:降序排列。默认为 desc。
1146
1241
  # @type OrderByType: String
1147
- # @param Status: 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
1242
+ # @param Status: 指定任务状态,用于过滤下载任务。若不配置该参数,则返回所有状态类型的任务。
1243
+ # - 0:等待执行。
1244
+ # - 1:正在下载。
1245
+ # - 2:下载完成。
1246
+ # - 3:下载失败。
1247
+ # - 4:等待重试。
1148
1248
  # @type Status: Array
1149
1249
 
1150
1250
  attr_accessor :InstanceId, :BackupName, :StartTime, :EndTime, :Limit, :Offset, :OrderBy, :OrderByType, :Status
@@ -1176,9 +1276,9 @@ module TencentCloud
1176
1276
 
1177
1277
  # DescribeBackupDownloadTask返回参数结构体
1178
1278
  class DescribeBackupDownloadTaskResponse < TencentCloud::Common::AbstractModel
1179
- # @param TotalCount: 满足查询条件的所有条数
1279
+ # @param TotalCount: 满足查询条件的所有条数。
1180
1280
  # @type TotalCount: Integer
1181
- # @param Tasks: 下载任务列表
1281
+ # @param Tasks: 下载任务列表。
1182
1282
  # @type Tasks: Array
1183
1283
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1184
1284
  # @type RequestId: String
@@ -1308,7 +1408,7 @@ module TencentCloud
1308
1408
 
1309
1409
  # DescribeCurrentOp请求参数结构体
1310
1410
  class DescribeCurrentOpRequest < TencentCloud::Common::AbstractModel
1311
- # @param InstanceId: 指定要查询的实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1411
+ # @param InstanceId: 指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1312
1412
  # @type InstanceId: String
1313
1413
  # @param Ns: 操作所属的命名空间 namespace,格式为 db.collection。
1314
1414
  # @type Ns: String
@@ -1316,7 +1416,15 @@ module TencentCloud
1316
1416
  # - 默认值为0,取值范围为[0, 3600000],单位:毫秒。
1317
1417
  # - 结果将返回超过设置时间的操作。
1318
1418
  # @type MillisecondRunning: Integer
1319
- # @param Op: 设置查询筛选条件为操作任务类型。取值包括:none、update、insert,query、command、getmore、remove 和 killcursors。
1419
+ # @param Op: 设置查询筛选条件为操作任务类型。取值包括:
1420
+ # - none:特殊状态,空闲连接或内部任务等。
1421
+ # - update:更新数据。
1422
+ # - insert:插入操作。
1423
+ # - query:查询操作。
1424
+ # - command:命令操作。
1425
+ # - getmore:获取更多数据。
1426
+ # - remove:删除操作。
1427
+ # - killcursors:释放查询游标的操作。
1320
1428
  # @type Op: String
1321
1429
  # @param ReplicaSetName: 筛选条件,分片名称。
1322
1430
  # @type ReplicaSetName: String
@@ -1324,13 +1432,15 @@ module TencentCloud
1324
1432
  # - primary:主节点。
1325
1433
  # - secondary:从节点。
1326
1434
  # @type State: String
1327
- # @param Limit: 单次请求返回的数量,默认值为100,取值范围为[0,100]
1435
+ # @param Limit: 单次请求返回的数量,默认值为100,取值范围为[0,100]
1328
1436
  # @type Limit: Integer
1329
- # @param Offset: 偏移量,默认值为0,取值范围为[0,10000]
1437
+ # @param Offset: 偏移量,默认值为0,取值范围为[0,10000]
1330
1438
  # @type Offset: Integer
1331
- # @param OrderBy: 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
1439
+ # @param OrderBy: 返回结果集排序的字段,目前支持按照 MicrosecsRunning(操作任务已执行的时间)排序。
1332
1440
  # @type OrderBy: String
1333
- # @param OrderByType: 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
1441
+ # @param OrderByType: 返回结果集排序方式。
1442
+ # - ASC:升序。默认为 ASC,按照升序排序。
1443
+ # - DESC:降序。
1334
1444
  # @type OrderByType: String
1335
1445
 
1336
1446
  attr_accessor :InstanceId, :Ns, :MillisecondRunning, :Op, :ReplicaSetName, :State, :Limit, :Offset, :OrderBy, :OrderByType
@@ -1395,9 +1505,15 @@ module TencentCloud
1395
1505
 
1396
1506
  # DescribeDBBackups请求参数结构体
1397
1507
  class DescribeDBBackupsRequest < TencentCloud::Common::AbstractModel
1398
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1508
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1399
1509
  # @type InstanceId: String
1400
- # @param BackupMethod: 备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。
1510
+ # @param BackupMethod: 备份方式。
1511
+ # - 0:逻辑备份。
1512
+ # - 1:物理备份。
1513
+ # - 3:快照备份。
1514
+ # **说明**:
1515
+ # 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
1516
+ # 2. 实例开通存储加密,则备份方式不能为物理备份。
1401
1517
  # @type BackupMethod: Integer
1402
1518
  # @param Limit: 分页大小,最大值为100,不设置默认查询所有。
1403
1519
  # @type Limit: Integer
@@ -1423,9 +1539,9 @@ module TencentCloud
1423
1539
 
1424
1540
  # DescribeDBBackups返回参数结构体
1425
1541
  class DescribeDBBackupsResponse < TencentCloud::Common::AbstractModel
1426
- # @param BackupList: 备份列表
1542
+ # @param BackupList: 备份列表。
1427
1543
  # @type BackupList: Array
1428
- # @param TotalCount: 备份总数
1544
+ # @param TotalCount: 备份总数。
1429
1545
  # @type TotalCount: Integer
1430
1546
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1431
1547
  # @type RequestId: String
@@ -1454,7 +1570,9 @@ module TencentCloud
1454
1570
 
1455
1571
  # DescribeDBInstanceDeal请求参数结构体
1456
1572
  class DescribeDBInstanceDealRequest < TencentCloud::Common::AbstractModel
1457
- # @param DealId: 订单ID,通过CreateDBInstance等接口返回
1573
+ # @param DealId: 订单 ID
1574
+ # - 按量计费实例,请通过 [CreateDBInstanceHour](https://cloud.tencent.com/document/product/240/38570) 接口输出的参数**DealId**获取。。
1575
+ # - 包年包月计费实例,请通过 [CreateDBInstance](https://cloud.tencent.com/document/product/240/38571) 接口输出的参数**DealId**获取。
1458
1576
  # @type DealId: String
1459
1577
 
1460
1578
  attr_accessor :DealId
@@ -1470,15 +1588,28 @@ module TencentCloud
1470
1588
 
1471
1589
  # DescribeDBInstanceDeal返回参数结构体
1472
1590
  class DescribeDBInstanceDealResponse < TencentCloud::Common::AbstractModel
1473
- # @param Status: 订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
1591
+ # @param Status: 订单状态。
1592
+ # - 1:未支付。
1593
+ # - 2:已支付。
1594
+ # - 3:发货中。
1595
+ # - 4:发货成功。
1596
+ # - 5:发货失败。
1597
+ # - 6:退款。
1598
+ # - 7:订单关闭。
1599
+ # - 8:超时未支付关闭。
1474
1600
  # @type Status: Integer
1475
- # @param OriginalPrice: 订单原价。
1601
+ # @param OriginalPrice: 订单原价。单位:元。
1476
1602
  # @type OriginalPrice: Float
1477
- # @param DiscountPrice: 订单折扣价格。
1603
+ # @param DiscountPrice: 订单折扣价格。单位:元。
1478
1604
  # @type DiscountPrice: Float
1479
- # @param Action: 订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
1605
+ # @param Action: 订单操作行为。
1606
+ # - purchase:新购。
1607
+ # - renew:续费。
1608
+ # - upgrade:升配.
1609
+ # - downgrade:降配.
1610
+ # - refund:退货退款。
1480
1611
  # @type Action: String
1481
- # @param InstanceId: 当前订单的资源Id
1612
+ # @param InstanceId: 当前订单的实例 ID
1482
1613
  # @type InstanceId: String
1483
1614
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1484
1615
  # @type RequestId: String
@@ -1550,19 +1681,23 @@ module TencentCloud
1550
1681
 
1551
1682
  # DescribeDBInstanceNodeProperty请求参数结构体
1552
1683
  class DescribeDBInstanceNodePropertyRequest < TencentCloud::Common::AbstractModel
1553
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
1684
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1554
1685
  # @type InstanceId: String
1555
- # @param NodeIds: 节点ID。
1686
+ # @param NodeIds: 节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID
1556
1687
  # @type NodeIds: Array
1557
1688
  # @param Roles: 节点角色。可选值包括:
1558
- # <ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>
1689
+ # - PRIMARY:主节点。
1690
+ # - SECONDARY:从节点。
1691
+ # - READONLY:只读节点。
1692
+ # - ARBITER:仲裁节点。
1559
1693
  # @type Roles: Array
1560
- # @param OnlyHidden: 该参数指定节点是否为Hidden节点,默认为false。
1694
+ # @param OnlyHidden: 该参数指定节点是否为 Hidden 节点,默认为 false。
1561
1695
  # @type OnlyHidden: Boolean
1562
1696
  # @param Priority: 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
1563
1697
  # @type Priority: Integer
1564
1698
  # @param Votes: 该参数指定节点投票权。
1565
- # <ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>
1699
+ # - 1:具有投票权。
1700
+ # - 0:无投票权。
1566
1701
  # @type Votes: Integer
1567
1702
  # @param Tags: 节点标签。
1568
1703
  # @type Tags: Array
@@ -1637,7 +1772,7 @@ module TencentCloud
1637
1772
 
1638
1773
  # DescribeDBInstanceParamTplDetail请求参数结构体
1639
1774
  class DescribeDBInstanceParamTplDetailRequest < TencentCloud::Common::AbstractModel
1640
- # @param TplId: 参数模板 ID。
1775
+ # @param TplId: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
1641
1776
  # @type TplId: String
1642
1777
  # @param ParamName: 参数名称,传入该值,则只会获取该字段的参数详情。为空时,返回全部参数。
1643
1778
  # @type ParamName: String
@@ -1667,9 +1802,19 @@ module TencentCloud
1667
1802
  # @type InstanceMultiParams: Array
1668
1803
  # @param TotalCount: 参数总个数。
1669
1804
  # @type TotalCount: Integer
1670
- # @param MongoVersion: 模板适配实例版本。
1805
+ # @param MongoVersion: 模板适配的实例版本。
1806
+ # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
1807
+ # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
1808
+ # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1809
+ # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1810
+ # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1811
+ # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
1812
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1671
1813
  # @type MongoVersion: String
1672
- # @param ClusterType: 模板适配集群类型,副本集或分片。。
1814
+ # @param ClusterType: 模板适配集群类型。
1815
+ # - REPLSET:副本集实例。
1816
+ # - SHARD:分片实例。
1817
+ # - STANDALONE:单节点实例。
1673
1818
  # @type ClusterType: String
1674
1819
  # @param TplName: 参数模板名称。
1675
1820
  # @type TplName: String
@@ -1733,16 +1878,22 @@ module TencentCloud
1733
1878
 
1734
1879
  # DescribeDBInstanceParamTpl请求参数结构体
1735
1880
  class DescribeDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
1736
- # @param TplIds: 参数模板 ID 查询条件。
1881
+ # @param TplIds: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
1737
1882
  # @type TplIds: Array
1738
- # @param TplNames: 模板名称,查询条件。
1883
+ # @param TplNames: 指定查询的模板名称。
1739
1884
  # @type TplNames: Array
1740
- # @param MongoVersion: 根据版本号查询参数模板,具体支持的售卖版本,请参见[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询云数据库的售卖规格的返回结果。参数与版本对应关系如下所示:
1741
- # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
1742
- # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
1885
+ # @param MongoVersion: 指定所需查询的参数模板的数据库版本号。具体支持的版本信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1886
+ # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
1887
+ # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
1743
1888
  # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1889
+ # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1890
+ # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1891
+ # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
1892
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1744
1893
  # @type MongoVersion: Array
1745
- # @param TplType: 根据模板类型查询参数模板,支持DEFAULT(默认模板)和CUSTOMIZE(自定义模板)两种。
1894
+ # @param TplType: 指定查询的模板类型。
1895
+ # - DEFAULT:系统默认模板。
1896
+ # - CUSTOMIZE:自定义模板。
1746
1897
  # @type TplType: String
1747
1898
 
1748
1899
  attr_accessor :TplIds, :TplNames, :MongoVersion, :TplType
@@ -1838,13 +1989,26 @@ module TencentCloud
1838
1989
 
1839
1990
  # DescribeDBInstances请求参数结构体
1840
1991
  class DescribeDBInstancesRequest < TencentCloud::Common::AbstractModel
1841
- # @param InstanceIds: 实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1992
+ # @param InstanceIds: 实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1842
1993
  # @type InstanceIds: Array
1843
- # @param InstanceType: 指定查询的实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>3:只读实例。</li><li>4:灾备实例。</li></ul>
1994
+ # @param InstanceType: 指定查询的实例类型。取值范围如下:
1995
+ # - 0:所有实例。
1996
+ # - 1:正式实例。
1997
+ # - 2:临时实例
1998
+ # - 3:只读实例。
1999
+ # - -1:查询同时包括正式实例、只读实例与灾备实例。
1844
2000
  # @type InstanceType: Integer
1845
- # @param ClusterType: 指定所查询实例的集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:副本集与分片实例。</li></ul>
2001
+ # @param ClusterType: 指定所查询实例的集群类型,取值范围如下:
2002
+ # - 0:副本集实例。
2003
+ # - 1:分片实例。
2004
+ # - -1:副本集与分片实例。
1846
2005
  # @type ClusterType: Integer
1847
- # @param Status: 指定所查询实例的当前状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程处理中,例如:变更规格、参数修改等。</li><li>2:实例正常运行中。</li><li>-2:实例已过期。</li></ul>
2006
+ # @param Status: 指定所查询实例的当前状态,取值范围如下所示:
2007
+ # - 0:待初始化。
2008
+ # - 1:流程处理中,例如:变更规格、参数修改等。
2009
+ # - 2:实例正常运行中。
2010
+ # - -2:已隔离(包年包月)。
2011
+ # - -3:已隔离(按量计费)。
1848
2012
  # @type Status: Array
1849
2013
  # @param VpcId: 私有网络的 ID。
1850
2014
  # - 基础网络则无需配置该参数。
@@ -1854,9 +2018,12 @@ module TencentCloud
1854
2018
  # - 基础网络则无需配置该参数。
1855
2019
  # - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其子网 ID。
1856
2020
  # @type SubnetId: String
1857
- # @param PayMode: 指定所查询实例的付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>
2021
+ # @param PayMode: 指定所查询实例的付费类型。
2022
+ # - 0:查询按量计费实例。
2023
+ # - 1:查询包年包月实例。
2024
+ # - -1:查询按量计费与包年包月实例。
1858
2025
  # @type PayMode: Integer
1859
- # @param Limit: 单次请求返回的数量。默认值为20,取值范围为[1,100]。
2026
+ # @param Limit: 单次请求返回的数量。默认值为20,取值范围为(1,100]。
1860
2027
  # @type Limit: Integer
1861
2028
  # @param Offset: 偏移量,默认值为0。
1862
2029
  # @type Offset: Integer
@@ -1950,29 +2117,35 @@ module TencentCloud
1950
2117
 
1951
2118
  # DescribeDetailedSlowLogs请求参数结构体
1952
2119
  class DescribeDetailedSlowLogsRequest < TencentCloud::Common::AbstractModel
1953
- # @param InstanceId: 实例id
2120
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1954
2121
  # @type InstanceId: String
1955
- # @param StartTime: 待查询慢日志的开始时间
2122
+ # @param StartTime: 指定查询慢日志的开始时间。- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
1956
2123
  # @type StartTime: String
1957
- # @param EndTime: 待慢日志的结束时间
2124
+ # @param EndTime: 指定查询慢日志的结束时间。
2125
+ # - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
2126
+ # - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
1958
2127
  # @type EndTime: String
1959
- # @param ExecTime: 过滤执行时间大于此值的慢日志,单位ms,默认值100
2128
+ # @param ExecTime: 指定慢日志查询阈值,即查询执行时间大于此值的慢日志。单位:ms,默认值:100
1960
2129
  # @type ExecTime: Integer
1961
- # @param Commands: 过滤慢日志的命令类型
2130
+ # @param Commands: 指定查询慢日志的命令类型。
1962
2131
  # @type Commands: Array
1963
- # @param Texts: 全文搜索关键字,多个关键字间为或关系
2132
+ # @param Texts: 全文搜索关键字,多个关键字间为或关系。
1964
2133
  # @type Texts: Array
1965
- # @param NodeNames: 根据节点名过滤
2134
+ # @param NodeNames: 指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。
1966
2135
  # @type NodeNames: Array
1967
- # @param QueryHash: 根据queryHash过滤
2136
+ # @param QueryHash: 指定查询 queryHash 值。
1968
2137
  # @type QueryHash: Array
1969
- # @param Offset: 分页偏移量
2138
+ # @param Offset: 分页偏移量。默认值:0。取值范围:[0,100]。
1970
2139
  # @type Offset: Integer
1971
- # @param Limit: 返回条数
2140
+ # @param Limit: 返回条数。默认值:20。取值范围:[0,10000]
1972
2141
  # @type Limit: Integer
1973
- # @param OrderBy: 排序条件,只支持StartTime(按慢日志生成时间)和ExecTime(慢日志执行时间)
2142
+ # @param OrderBy: 指定慢日志排序条件。
2143
+ # - StartTime:按照慢日志生成时间排序。
2144
+ # - ExecTime:按照慢日志执行时间排序。
1974
2145
  # @type OrderBy: String
1975
- # @param OrderByType: 排序。desc倒排,asc正排
2146
+ # @param OrderByType: 指定排序方式。
2147
+ # - desc:倒序。
2148
+ # - asc:顺序。
1976
2149
  # @type OrderByType: String
1977
2150
 
1978
2151
  attr_accessor :InstanceId, :StartTime, :EndTime, :ExecTime, :Commands, :Texts, :NodeNames, :QueryHash, :Offset, :Limit, :OrderBy, :OrderByType
@@ -2010,9 +2183,9 @@ module TencentCloud
2010
2183
 
2011
2184
  # DescribeDetailedSlowLogs返回参数结构体
2012
2185
  class DescribeDetailedSlowLogsResponse < TencentCloud::Common::AbstractModel
2013
- # @param TotalCount: 满足条件的慢日志数量
2186
+ # @param TotalCount: 满足条件的慢日志数量。
2014
2187
  # @type TotalCount: Integer
2015
- # @param DetailedSlowLogs: 慢日志详情
2188
+ # @param DetailedSlowLogs: 慢日志详情。
2016
2189
  # @type DetailedSlowLogs: Array
2017
2190
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2018
2191
  # @type RequestId: String
@@ -2121,7 +2294,7 @@ module TencentCloud
2121
2294
 
2122
2295
  # DescribeSecurityGroup请求参数结构体
2123
2296
  class DescribeSecurityGroupRequest < TencentCloud::Common::AbstractModel
2124
- # @param InstanceId: 实例 ID。例如:cmgo-p8vn****。
2297
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
2125
2298
  # @type InstanceId: String
2126
2299
 
2127
2300
  attr_accessor :InstanceId
@@ -2164,11 +2337,15 @@ module TencentCloud
2164
2337
 
2165
2338
  # DescribeSlowLogPatterns请求参数结构体
2166
2339
  class DescribeSlowLogPatternsRequest < TencentCloud::Common::AbstractModel
2167
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2340
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
2168
2341
  # @type InstanceId: String
2169
- # @param StartTime: 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2342
+ # @param StartTime: 慢日志起始时间。
2343
+ # - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
2344
+ # - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2170
2345
  # @type StartTime: String
2171
- # @param EndTime: 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2346
+ # @param EndTime: 慢日志终止时间。
2347
+ # - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
2348
+ # - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2172
2349
  # @type EndTime: String
2173
2350
  # @param SlowMS: 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
2174
2351
  # @type SlowMS: Integer
@@ -2235,11 +2412,15 @@ module TencentCloud
2235
2412
 
2236
2413
  # DescribeSlowLogs请求参数结构体
2237
2414
  class DescribeSlowLogsRequest < TencentCloud::Common::AbstractModel
2238
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2415
+ # @param InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
2239
2416
  # @type InstanceId: String
2240
- # @param StartTime: 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2417
+ # @param StartTime: 慢日志起始时间。
2418
+ # - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
2419
+ # - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2241
2420
  # @type StartTime: String
2242
- # @param EndTime: 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2421
+ # @param EndTime: 慢日志终止时间。
2422
+ # - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
2423
+ # - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2243
2424
  # @type EndTime: String
2244
2425
  # @param SlowMS: 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
2245
2426
  # @type SlowMS: Integer
@@ -2275,9 +2456,9 @@ module TencentCloud
2275
2456
 
2276
2457
  # DescribeSlowLogs返回参数结构体
2277
2458
  class DescribeSlowLogsResponse < TencentCloud::Common::AbstractModel
2278
- # @param Count: 慢日志总数
2459
+ # @param Count: 慢日志总数。
2279
2460
  # @type Count: Integer
2280
- # @param SlowLogs: 慢日志详情
2461
+ # @param SlowLogs: 慢日志详情。
2281
2462
  # @type SlowLogs: Array
2282
2463
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2283
2464
  # @type RequestId: String
@@ -2299,7 +2480,7 @@ module TencentCloud
2299
2480
 
2300
2481
  # DescribeSpecInfo请求参数结构体
2301
2482
  class DescribeSpecInfoRequest < TencentCloud::Common::AbstractModel
2302
- # @param Zone: 待查询可用区
2483
+ # @param Zone: 待查询可用区。当前支持的可用区,请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。
2303
2484
  # @type Zone: String
2304
2485
 
2305
2486
  attr_accessor :Zone
@@ -2315,7 +2496,7 @@ module TencentCloud
2315
2496
 
2316
2497
  # DescribeSpecInfo返回参数结构体
2317
2498
  class DescribeSpecInfoResponse < TencentCloud::Common::AbstractModel
2318
- # @param SpecInfoList: 实例售卖规格信息列表
2499
+ # @param SpecInfoList: 实例售卖规格信息列表。
2319
2500
  # @type SpecInfoList: Array
2320
2501
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2321
2502
  # @type RequestId: String
@@ -2342,7 +2523,7 @@ module TencentCloud
2342
2523
 
2343
2524
  # DescribeTransparentDataEncryptionStatus请求参数结构体
2344
2525
  class DescribeTransparentDataEncryptionStatusRequest < TencentCloud::Common::AbstractModel
2345
- # @param InstanceId: 指定实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
2526
+ # @param InstanceId: 指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
2346
2527
  # @type InstanceId: String
2347
2528
 
2348
2529
  attr_accessor :InstanceId
@@ -2392,7 +2573,7 @@ module TencentCloud
2392
2573
 
2393
2574
  # DropDBInstanceParamTpl请求参数结构体
2394
2575
  class DropDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
2395
- # @param TplId: 参数模板 ID。
2576
+ # @param TplId: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
2396
2577
  # @type TplId: String
2397
2578
 
2398
2579
  attr_accessor :TplId
@@ -2466,11 +2647,11 @@ module TencentCloud
2466
2647
  end
2467
2648
  end
2468
2649
 
2469
- # 按key回档,用于筛选数据的键值对
2650
+ # 按 Key 闪回键值对
2470
2651
  class FBKeyValue < TencentCloud::Common::AbstractModel
2471
- # @param Key: 用于按key回档过滤的key
2652
+ # @param Key: 指定按 Key 闪回的目标 Key (键) 。
2472
2653
  # @type Key: String
2473
- # @param Value: 用于按key回档过滤的value
2654
+ # @param Value: 指定按 Key 闪回的目标 Key 所对应的 Value(值)。
2474
2655
  # @type Value: String
2475
2656
 
2476
2657
  attr_accessor :Key, :Value
@@ -2541,15 +2722,15 @@ module TencentCloud
2541
2722
  end
2542
2723
  end
2543
2724
 
2544
- # 按key回档,源数据所在的表
2725
+ # 按 Key 闪回数据表
2545
2726
  class FlashbackCollection < TencentCloud::Common::AbstractModel
2546
- # @param CollectionName: 按key回档指定的集合名
2727
+ # @param CollectionName: 指定按 Key 闪回源数据库集合名。
2547
2728
  # @type CollectionName: String
2548
- # @param TargetResultCollectionName: 按key回档到的目标集合名
2729
+ # @param TargetResultCollectionName: 指定按 Key 闪回目标数据库集合名。
2549
2730
  # @type TargetResultCollectionName: String
2550
- # @param FilterKey: 上传到cos的文件的value所对应的key值
2731
+ # @param FilterKey: 指定用于过滤按 Key 闪回的 Key(键)。
2551
2732
  # @type FilterKey: String
2552
- # @param KeyValues: 用于按key回档过滤的键值对
2733
+ # @param KeyValues: 指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。
2553
2734
  # @type KeyValues: Array
2554
2735
 
2555
2736
  attr_accessor :CollectionName, :TargetResultCollectionName, :FilterKey, :KeyValues
@@ -2576,11 +2757,11 @@ module TencentCloud
2576
2757
  end
2577
2758
  end
2578
2759
 
2579
- # 按key回档,源数据所在的库表
2760
+ # 按 Key 闪回的数据库及集合信息
2580
2761
  class FlashbackDatabase < TencentCloud::Common::AbstractModel
2581
- # @param DBName: 按key回档源数据所在库
2762
+ # @param DBName: 按 Key 闪回目标数据所在库。
2582
2763
  # @type DBName: String
2583
- # @param Collections: 按key回档的集群数组
2764
+ # @param Collections: 按 Key 闪回的数据库集合。
2584
2765
  # @type Collections: Array
2585
2766
 
2586
2767
  attr_accessor :DBName, :Collections
@@ -2637,7 +2818,7 @@ module TencentCloud
2637
2818
 
2638
2819
  # InquirePriceCreateDBInstances请求参数结构体
2639
2820
  class InquirePriceCreateDBInstancesRequest < TencentCloud::Common::AbstractModel
2640
- # @param Zone: 实例所属区域及可用区信息。格式:ap-guangzhou-2
2821
+ # @param Zone: 实例所属区域及可用区信息。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)
2641
2822
  # @type Zone: String
2642
2823
  # @param NodeNum: - 创建副本集实例,指每个副本集内主从节点数量。每个副本集所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2643
2824
  # - 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
@@ -2651,12 +2832,12 @@ module TencentCloud
2651
2832
  # - 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。
2652
2833
  # @type Volume: Integer
2653
2834
  # @param MongoVersion: 实例版本信息。具体支持的版本,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:
2654
- # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
2655
2835
  # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
2656
2836
  # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
2657
2837
  # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
2658
2838
  # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
2659
2839
  # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
2840
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
2660
2841
  # @type MongoVersion: String
2661
2842
  # @param MachineCode: 产品规格类型。
2662
2843
  # - HIO10G:通用高HIO万兆型。
@@ -2759,15 +2940,19 @@ module TencentCloud
2759
2940
 
2760
2941
  # InquirePriceModifyDBInstanceSpec请求参数结构体
2761
2942
  class InquirePriceModifyDBInstanceSpecRequest < TencentCloud::Common::AbstractModel
2762
- # @param InstanceId: 实例 ID,格式如:cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。
2943
+ # @param InstanceId: 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
2763
2944
  # @type InstanceId: String
2764
- # @param Memory: 变更配置后实例内存大小,单位:GB
2945
+ # @param Memory: 变更配置后实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2765
2946
  # @type Memory: Integer
2766
- # @param Volume: 变更配置后实例磁盘大小,单位:GB
2947
+ # @param Volume: 变更配置后实例磁盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2767
2948
  # @type Volume: Integer
2768
- # @param NodeNum: 实例节点数。默认为不变更节点数,暂不支持变更。
2949
+ # @param NodeNum: 实例节点数量。请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2950
+ # - 副本集实例,指变更配置后实例的主从节点数量。
2951
+ # - 分片集群实例,指变更配置后实例每一个分片的主从节点数。
2952
+ # **说明**:切勿同时发起调整节点数、调整分片数、调整节点规格的任务。
2769
2953
  # @type NodeNum: Integer
2770
- # @param ReplicateSetNum: 实例分片数。默认为不变更分片数,暂不支持变更。
2954
+ # @param ReplicateSetNum: 分片集群实例,指变更配置后实例的分片数量。取值范围:[2,36] 。
2955
+ # **说明**:变更后的分片数量不能小于当前现有的数量。切勿同时发起调整节点数、调整分片数与调整节点规格的任务。
2771
2956
  # @type ReplicateSetNum: Integer
2772
2957
 
2773
2958
  attr_accessor :InstanceId, :Memory, :Volume, :NodeNum, :ReplicateSetNum
@@ -2881,29 +3066,40 @@ module TencentCloud
2881
3066
  end
2882
3067
  end
2883
3068
 
2884
- # 实例详情
3069
+ # 实例详情。
2885
3070
  class InstanceDetail < TencentCloud::Common::AbstractModel
2886
- # @param InstanceId: 实例ID。
3071
+ # @param InstanceId: 实例 ID。
2887
3072
  # @type InstanceId: String
2888
3073
  # @param InstanceName: 实例名称。
2889
3074
  # @type InstanceName: String
2890
- # @param PayMode: 付费类型,可能的返回值:1-包年包月;0-按量计费
3075
+ # @param PayMode: 付费类型。
3076
+ # - 1:包年包月。
3077
+ # - 0:按量计费。
2891
3078
  # @type PayMode: Integer
2892
- # @param ProjectId: 项目ID。
3079
+ # @param ProjectId: 项目 ID。
2893
3080
  # @type ProjectId: Integer
2894
- # @param ClusterType: 集群类型,可能的返回值:0-副本集实例,1-分片实例。
3081
+ # @param ClusterType: 集群类型。
3082
+ # - 0:副本集实例。
3083
+ # - 1:分片实例。
2895
3084
  # @type ClusterType: Integer
2896
3085
  # @param Region: 地域信息。
2897
3086
  # @type Region: String
2898
3087
  # @param Zone: 可用区信息。
2899
3088
  # @type Zone: String
2900
- # @param NetType: 网络类型,可能的返回值:0-基础网络,1-私有网络
3089
+ # @param NetType: 网络类型。
3090
+ # - 0:基础网络。
3091
+ # - 1:私有网络。
2901
3092
  # @type NetType: Integer
2902
3093
  # @param VpcId: 私有网络的ID。
2903
3094
  # @type VpcId: String
2904
3095
  # @param SubnetId: 私有网络的子网ID。
2905
3096
  # @type SubnetId: String
2906
- # @param Status: 实例状态,可能的返回值:0-创建中,1-流程处理中,2-运行中,-2-实例已过期。
3097
+ # @param Status: 实例状态。
3098
+ # - 0:待初始化。
3099
+ # - 1:流程处理中,例如:变更规格、参数修改等。
3100
+ # - 2:实例正常运行中。
3101
+ # - -2:已隔离(包年包月)。
3102
+ # - -3:已隔离(按量计费)。
2907
3103
  # @type Status: Integer
2908
3104
  # @param Vip: 实例IP。
2909
3105
  # @type Vip: String
@@ -2913,23 +3109,35 @@ module TencentCloud
2913
3109
  # @type CreateTime: String
2914
3110
  # @param DeadLine: 实例到期时间。
2915
3111
  # @type DeadLine: String
2916
- # @param MongoVersion: 实例版本信息。
3112
+ # @param MongoVersion: 实例存储引擎版本信息。
3113
+ # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
3114
+ # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
3115
+ # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
3116
+ # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
3117
+ # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
3118
+ # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
3119
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
2917
3120
  # @type MongoVersion: String
2918
- # @param Memory: 实例内存规格,单位为MB。
3121
+ # @param Memory: 实例内存规格,单位:MB。
2919
3122
  # @type Memory: Integer
2920
- # @param Volume: 实例磁盘规格,单位为MB。
3123
+ # @param Volume: 实例磁盘规格,单位:MB。
2921
3124
  # @type Volume: Integer
2922
- # @param CpuNum: 实例CPU核心数。
3125
+ # @param CpuNum: 实例 CPU 核心数。
2923
3126
  # @type CpuNum: Integer
2924
3127
  # @param MachineType: 实例机器类型。
3128
+ # - HIO10G:通用高 HIO 万兆型。
3129
+ # - HCD:云盘版类型。
2925
3130
  # @type MachineType: String
2926
3131
  # @param SecondaryNum: 实例从节点数。
2927
3132
  # @type SecondaryNum: Integer
2928
3133
  # @param ReplicationSetNum: 实例分片数。
2929
3134
  # @type ReplicationSetNum: Integer
2930
- # @param AutoRenewFlag: 实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费。
3135
+ # @param AutoRenewFlag: 实例自动续费标志。
3136
+ # - 0:手动续费。
3137
+ # - 1:自动续费。
3138
+ # - 2:确认不续费。
2931
3139
  # @type AutoRenewFlag: Integer
2932
- # @param UsedVolume: 已用容量,单位MB。
3140
+ # @param UsedVolume: 已用容量,单位:MB。
2933
3141
  # @type UsedVolume: Integer
2934
3142
  # @param MaintenanceStart: 维护窗口起始时间。
2935
3143
  # @type MaintenanceStart: String
@@ -2951,29 +3159,34 @@ module TencentCloud
2951
3159
  # @type InstanceVer: Integer
2952
3160
  # @param ClusterVer: 实例版本标记。
2953
3161
  # @type ClusterVer: Integer
2954
- # @param Protocol: 协议信息,可能的返回值:1-mongodb,2-dynamodb
3162
+ # @param Protocol: 协议信息:mongodb。
2955
3163
  # @type Protocol: Integer
2956
- # @param InstanceType: 实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例
3164
+ # @param InstanceType: 实例类型。
3165
+ # - 0:所有实例。
3166
+ # - 1:正式实例。
3167
+ # - 2:临时实例
3168
+ # - 3:只读实例。
3169
+ # - -1:同时包括正式实例、只读实例与灾备实例。
2957
3170
  # @type InstanceType: Integer
2958
- # @param InstanceStatusDesc: 实例状态描述
3171
+ # @param InstanceStatusDesc: 实例状态描述。
2959
3172
  # @type InstanceStatusDesc: String
2960
- # @param RealInstanceId: 实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取
3173
+ # @param RealInstanceId: 实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId RealInstanceId,从 barad 获取监控数据等场景下需要用物理 ID 获取。
2961
3174
  # @type RealInstanceId: String
2962
3175
  # @param ZoneList: 实例当前可用区信息。
2963
3176
  # @type ZoneList: Array
2964
- # @param MongosNodeNum: mongos节点个数。
3177
+ # @param MongosNodeNum: mongos 节点个数。
2965
3178
  # @type MongosNodeNum: Integer
2966
- # @param MongosMemory: mongos节点内存。
3179
+ # @param MongosMemory: mongos 节点内存。单位:MB。
2967
3180
  # @type MongosMemory: Integer
2968
- # @param MongosCpuNum: mongos节点CPU核数。
3181
+ # @param MongosCpuNum: mongos 节点 CPU 核数。
2969
3182
  # @type MongosCpuNum: Integer
2970
3183
  # @param ConfigServerNodeNum: Config Server节点个数。
2971
3184
  # @type ConfigServerNodeNum: Integer
2972
- # @param ConfigServerMemory: Config Server节点内存。
3185
+ # @param ConfigServerMemory: Config Server节点内存。单位:MB。
2973
3186
  # @type ConfigServerMemory: Integer
2974
- # @param ConfigServerVolume: Config Server节点磁盘大小。
3187
+ # @param ConfigServerVolume: Config Server节点磁盘大小。单位:MB。
2975
3188
  # @type ConfigServerVolume: Integer
2976
- # @param ConfigServerCpuNum: Config Server节点CPU核数。
3189
+ # @param ConfigServerCpuNum: Config Server 节点 CPU 核数。
2977
3190
  # @type ConfigServerCpuNum: Integer
2978
3191
  # @param ReadonlyNodeNum: readonly节点个数。
2979
3192
  # @type ReadonlyNodeNum: Integer
@@ -3319,7 +3532,7 @@ module TencentCloud
3319
3532
 
3320
3533
  # IsolateDBInstance请求参数结构体
3321
3534
  class IsolateDBInstanceRequest < TencentCloud::Common::AbstractModel
3322
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
3535
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID
3323
3536
  # @type InstanceId: String
3324
3537
 
3325
3538
  attr_accessor :InstanceId
@@ -3362,6 +3575,8 @@ module TencentCloud
3362
3575
  # @param CreateTime: 实例与密钥绑定时间。
3363
3576
  # @type CreateTime: String
3364
3577
  # @param Status: 密钥状态。
3578
+ # - Enabled:开启。
3579
+ # - Disabled:不开启。
3365
3580
  # @type Status: String
3366
3581
  # @param KeyUsage: 密钥用途。
3367
3582
  # @type KeyUsage: String
@@ -3395,9 +3610,9 @@ module TencentCloud
3395
3610
 
3396
3611
  # KillOps请求参数结构体
3397
3612
  class KillOpsRequest < TencentCloud::Common::AbstractModel
3398
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
3613
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
3399
3614
  # @type InstanceId: String
3400
- # @param Operations: 待终止的操作
3615
+ # @param Operations: 待终止的操作。
3401
3616
  # @type Operations: Array
3402
3617
 
3403
3618
  attr_accessor :InstanceId, :Operations
@@ -3499,7 +3714,7 @@ module TencentCloud
3499
3714
 
3500
3715
  # ModifyDBInstanceParamTpl请求参数结构体
3501
3716
  class ModifyDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
3502
- # @param TplId: 待修改的参数模板 ID,示例:tpl-jglr91vew
3717
+ # @param TplId: 待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
3503
3718
  # @type TplId: String
3504
3719
  # @param TplName: 待修改参数模板名称,为空时,保持原有名称。
3505
3720
  # @type TplName: String
@@ -3587,11 +3802,12 @@ module TencentCloud
3587
3802
 
3588
3803
  # ModifyDBInstanceSpec请求参数结构体
3589
3804
  class ModifyDBInstanceSpecRequest < TencentCloud::Common::AbstractModel
3590
- # @param InstanceId: 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
3805
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
3591
3806
  # @type InstanceId: String
3592
- # @param Memory: 实例配置变更后的内存大小。- 单位:GB。为空时,默认取实例当前的内存大小。<br> 注意:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
3807
+ # @param Memory: 实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
3808
+ # **注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
3593
3809
  # @type Memory: Integer
3594
- # @param Volume: 实例配置变更后的硬盘大小,单位:GB。为空时,默认取当前实例的磁盘大小。
3810
+ # @param Volume: 实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
3595
3811
  # - 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
3596
3812
  # - 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。
3597
3813
  # @type Volume: Integer
@@ -3601,26 +3817,26 @@ module TencentCloud
3601
3817
  # - 单位:GB。
3602
3818
  # - 默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。
3603
3819
  # @type OplogSize: Integer
3604
- # @param NodeNum: 实例变更后mongod的节点数(不包含readonly节点数)。
3605
- # - 变更mongod CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。
3606
- # - 变更 mongos CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。
3607
- # - 节点变更时(全部类型),该参数可不配置或输入变更后的 mongod(不包含readonly) 节点数量。
3608
- # - 副本集节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。
3609
- # - 分片集群每个分片节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。
3820
+ # @param NodeNum: 实例变更后 mongod 的节点数(不包含 readonly 只读节点数)。
3821
+ # - 副本集节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。
3822
+ # - 分片集群每个分片节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。
3823
+ # **说明**:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。
3610
3824
  # @type NodeNum: Integer
3611
3825
  # @param ReplicateSetNum: 实例变更后的分片数。
3612
- # - 取值范围请通过云数据库的售卖规格[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取。- 该参数只能增加不能减少。
3826
+ # - 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。
3827
+ # - 实例分片数量只允许增加不允许减少。
3613
3828
  # @type ReplicateSetNum: Integer
3614
3829
  # @param InMaintenance: 实例配置变更的切换时间。
3615
3830
  # - 0:调整完成时,立即执行变配任务。默认为0。
3616
3831
  # - 1:在维护时间窗内,执行变配任务。
3617
3832
  # **说明**:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。
3618
3833
  # @type InMaintenance: Integer
3619
- # @param MongosMemory: 分片实例配置变更后的mongos内存大小。单位:GB。
3834
+ # @param MongosMemory: 分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)
3620
3835
  # @type MongosMemory: String
3621
3836
  # @param AddNodeList: 新增节点列表,节点类型及可用区信息。
3622
3837
  # @type AddNodeList: Array
3623
- # @param RemoveNodeList: 删除节点列表,注意:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
3838
+ # @param RemoveNodeList: 删除节点列表。
3839
+ # **注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
3624
3840
  # @type RemoveNodeList: Array
3625
3841
 
3626
3842
  attr_accessor :InstanceId, :Memory, :Volume, :OplogSize, :NodeNum, :ReplicateSetNum, :InMaintenance, :MongosMemory, :AddNodeList, :RemoveNodeList
@@ -3798,21 +4014,38 @@ module TencentCloud
3798
4014
  # @type Address: String
3799
4015
  # @param WanServiceAddress: 节点公网访问外网地址(IP或域名,示例为IP方式)。
3800
4016
  # @type WanServiceAddress: String
3801
- # @param Role: 角色。
4017
+ # @param Role: 节点角色。
4018
+ # - PRIMARY:主节点。
4019
+ # - SECONDARY:从节点。
4020
+ # - READONLY:只读节点。
4021
+ # - ARBITER:仲裁节点。
3802
4022
  # @type Role: String
3803
- # @param Hidden: 是否为Hidden节点
4023
+ # @param Hidden: 节点是否为 Hidden 节点。
4024
+ # - true:Hidden 节点。
4025
+ # - false:非 Hidden 节点。
3804
4026
  # @type Hidden: Boolean
3805
- # @param Status: 节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
4027
+ # @param Status: 节点状态。
4028
+ # - NORMAL:正常运行中。
4029
+ # - STARTUP:正在启动。
4030
+ # - STARTUP2:正在启动,处理中间数据。
4031
+ # - RECOVERING:恢复中,暂不可用。
4032
+ # - DOWN:已掉线。
4033
+ # - UNKNOWN:未知状态。
4034
+ # - ROLLBACK:回滚中。
4035
+ # - REMOVED:已移除。
3806
4036
  # @type Status: String
3807
- # @param SlaveDelay: 主从延迟,单位秒。
4037
+ # @param SlaveDelay: 主从同步延迟时间,单位:秒。
3808
4038
  # @type SlaveDelay: Integer
3809
- # @param Priority: 节点优先级。
4039
+ # @param Priority: 节点优先级。其取值范围为[0,100],数值越高,优先级越高。
3810
4040
  # @type Priority: Integer
3811
4041
  # @param Votes: 节点投票权。
4042
+ # - 1:具有投票权。
4043
+ # - 0:无投票权。
3812
4044
  # @type Votes: Integer
3813
4045
  # @param Tags: 节点标签。
4046
+ # 注意:此字段可能返回 null,表示取不到有效值。
3814
4047
  # @type Tags: Array
3815
- # @param ReplicateSetId: 副本集Id
4048
+ # @param ReplicateSetId: 副本集 ID
3816
4049
  # @type ReplicateSetId: String
3817
4050
 
3818
4051
  attr_accessor :Zone, :NodeName, :Address, :WanServiceAddress, :Role, :Hidden, :Status, :SlaveDelay, :Priority, :Votes, :Tags, :ReplicateSetId
@@ -3877,7 +4110,7 @@ module TencentCloud
3877
4110
 
3878
4111
  # OfflineIsolatedDBInstance请求参数结构体
3879
4112
  class OfflineIsolatedDBInstanceRequest < TencentCloud::Common::AbstractModel
3880
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
4113
+ # @param InstanceId: 实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID
3881
4114
  # @type InstanceId: String
3882
4115
 
3883
4116
  attr_accessor :InstanceId
@@ -3911,13 +4144,13 @@ module TencentCloud
3911
4144
  end
3912
4145
  end
3913
4146
 
3914
- # 需要终止的操作
4147
+ # 需要终止的操作。
3915
4148
  class Operation < TencentCloud::Common::AbstractModel
3916
- # @param ReplicaSetName: 操作所在的分片名
4149
+ # @param ReplicaSetName: 操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。
3917
4150
  # @type ReplicaSetName: String
3918
- # @param NodeName: 操作所在的节点名
4151
+ # @param NodeName: 操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。
3919
4152
  # @type NodeName: String
3920
- # @param OpId: 操作序号
4153
+ # @param OpId: 操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。
3921
4154
  # @type OpId: Integer
3922
4155
 
3923
4156
  attr_accessor :ReplicaSetName, :NodeName, :OpId
@@ -3937,17 +4170,29 @@ module TencentCloud
3937
4170
 
3938
4171
  # 数据库参数模板
3939
4172
  class ParamTpl < TencentCloud::Common::AbstractModel
3940
- # @param TplName: 参数模板名称
4173
+ # @param TplName: 参数模板名称。
3941
4174
  # @type TplName: String
3942
- # @param TplId: 参数模板ID
4175
+ # @param TplId: 参数模板 ID
3943
4176
  # @type TplId: String
3944
- # @param MongoVersion: 适用数据库版本
4177
+ # @param MongoVersion: 参数模板适用的数据库版本。
4178
+ # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
4179
+ # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
4180
+ # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
4181
+ # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
4182
+ # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
4183
+ # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
4184
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
3945
4185
  # @type MongoVersion: String
3946
- # @param ClusterType: 适用数据库类型
4186
+ # @param ClusterType: 参数模板适用的数据库类型。
4187
+ # - REPLSET:副本集实例。
4188
+ # - SHARD:分片实例。
4189
+ # - STANDALONE:单节点实例。
3947
4190
  # @type ClusterType: String
3948
- # @param TplDesc: 参数模板描述
4191
+ # @param TplDesc: 参数模板描述。
3949
4192
  # @type TplDesc: String
3950
- # @param TplType: 模板类型,包括DEFAULT(默认模板)及CUSTOMIZE(定制模板)两种类型
4193
+ # @param TplType: 模板类型。
4194
+ # - DEFAULT:系统默认模板。
4195
+ # - CUSTOMIZE:自定义模板。
3951
4196
  # @type TplType: String
3952
4197
 
3953
4198
  attr_accessor :TplName, :TplId, :MongoVersion, :ClusterType, :TplDesc, :TplType
@@ -3991,19 +4236,18 @@ module TencentCloud
3991
4236
  end
3992
4237
  end
3993
4238
 
3994
- # 修改实例节点详情
4239
+ # 修改实例节点详情。
3995
4240
  class RemoveNodeList < TencentCloud::Common::AbstractModel
3996
4241
  # @param Role: 需要删除的节点角色。
3997
4242
  # - SECONDARY:Mongod 从节点。
3998
4243
  # - READONLY:只读节点。
3999
4244
  # - MONGOS:Mongos 节点。
4000
4245
  # @type Role: String
4001
- # @param NodeName: 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对改组对齐。
4002
-
4003
- # - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/),在**节点管理**页签,可获取**节点 ID**。
4004
- # - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk****_0-node-primary。
4246
+ # @param NodeName: 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对该组对齐。
4247
+ # - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/mongodb),在**节点管理**页签,可获取**节点 ID**。
4248
+ # - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk\*\*\*\*\_0-node-primary。
4005
4249
  # @type NodeName: String
4006
- # @param Zone: 节点所对应的可用区。
4250
+ # @param Zone: 节点所对应的可用区。当前支持可用区信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
4007
4251
  # - 单可用区,所有节点在同一可用区。
4008
4252
  # - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。
4009
4253
  # @type Zone: String
@@ -4062,7 +4306,7 @@ module TencentCloud
4062
4306
  # RenewDBInstances请求参数结构体
4063
4307
  class RenewDBInstancesRequest < TencentCloud::Common::AbstractModel
4064
4308
  # @param InstanceIds: 指定续费的一个或多个待操作的实例ID。
4065
- # - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceIds**获取。
4309
+ # - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。
4066
4310
  # - 每次续费请求的实例数量上限为100。
4067
4311
  # @type InstanceIds: Array
4068
4312
  # @param InstanceChargePrepaid: 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。
@@ -4100,9 +4344,9 @@ module TencentCloud
4100
4344
  end
4101
4345
  end
4102
4346
 
4103
- # 分片信息
4347
+ # 分片信息。
4104
4348
  class ReplicaSetInfo < TencentCloud::Common::AbstractModel
4105
- # @param ReplicaSetId: 副本集ID
4349
+ # @param ReplicaSetId: 副本集 ID
4106
4350
  # @type ReplicaSetId: String
4107
4351
 
4108
4352
  attr_accessor :ReplicaSetId
@@ -4141,11 +4385,13 @@ module TencentCloud
4141
4385
 
4142
4386
  # ResetDBInstancePassword请求参数结构体
4143
4387
  class ResetDBInstancePasswordRequest < TencentCloud::Common::AbstractModel
4144
- # @param InstanceId: 实例Id
4388
+ # @param InstanceId: 指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
4145
4389
  # @type InstanceId: String
4146
- # @param UserName: 实例账号名
4390
+ # @param UserName: 指定需修改密码的账号名称。可通过接口 [DescribeAccountUsers](https://cloud.tencent.com/document/product/240/80800) 获取账号列表,复制需修改密码的账号。
4147
4391
  # @type UserName: String
4148
- # @param Password: 新密码,新密码长度不能少于8位
4392
+ # @param Password: 指定账户的新密码。密码复杂度要求:
4393
+ # - 8-32个字符长度。
4394
+ # - 至少包含字母、数字和字符(!@#%^\*()\_)中的两种。
4149
4395
  # @type Password: String
4150
4396
 
4151
4397
  attr_accessor :InstanceId, :UserName, :Password
@@ -4165,7 +4411,7 @@ module TencentCloud
4165
4411
 
4166
4412
  # ResetDBInstancePassword返回参数结构体
4167
4413
  class ResetDBInstancePasswordResponse < TencentCloud::Common::AbstractModel
4168
- # @param AsyncRequestId: 异步请求Id,用户查询该流程的运行状态
4414
+ # @param AsyncRequestId: 任务请求 ID。
4169
4415
  # @type AsyncRequestId: String
4170
4416
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4171
4417
  # @type RequestId: String
@@ -4185,9 +4431,11 @@ module TencentCloud
4185
4431
 
4186
4432
  # RestartNodes请求参数结构体
4187
4433
  class RestartNodesRequest < TencentCloud::Common::AbstractModel
4188
- # @param InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
4434
+ # @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
4189
4435
  # @type InstanceId: String
4190
- # @param NodeIds: 节点Id。
4436
+ # @param NodeIds: 需要重启的节点 ID 列表。
4437
+ # - 支持重启的节点类型包含:mongod节点、只读节点、mongos节点。
4438
+ # - 节点 ID,请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在**节点管理**页面复制,或者通过 [DescribeDBInstanceNodeProperty ](https://cloud.tencent.com/document/product/240/82022)接口获取。
4191
4439
  # @type NodeIds: Array
4192
4440
 
4193
4441
  attr_accessor :InstanceId, :NodeIds
@@ -4205,7 +4453,7 @@ module TencentCloud
4205
4453
 
4206
4454
  # RestartNodes返回参数结构体
4207
4455
  class RestartNodesResponse < TencentCloud::Common::AbstractModel
4208
- # @param FlowId: 流程Id
4456
+ # @param FlowId: 流程 ID
4209
4457
  # @type FlowId: Integer
4210
4458
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4211
4459
  # @type RequestId: String
@@ -4225,19 +4473,19 @@ module TencentCloud
4225
4473
 
4226
4474
  # 安全组信息
4227
4475
  class SecurityGroup < TencentCloud::Common::AbstractModel
4228
- # @param ProjectId: 所属项目id
4476
+ # @param ProjectId: 所属项目 ID。
4229
4477
  # @type ProjectId: Integer
4230
- # @param CreateTime: 创建时间
4478
+ # @param CreateTime: 安全组创建时间。
4231
4479
  # @type CreateTime: String
4232
- # @param Inbound: 入站规则
4480
+ # @param Inbound: 安全组入站规则。
4233
4481
  # @type Inbound: Array
4234
- # @param Outbound: 出站规则
4482
+ # @param Outbound: 安全组出站规则。
4235
4483
  # @type Outbound: Array
4236
- # @param SecurityGroupId: 安全组id
4484
+ # @param SecurityGroupId: 安全组 ID。
4237
4485
  # @type SecurityGroupId: String
4238
- # @param SecurityGroupName: 安全组名称
4486
+ # @param SecurityGroupName: 安全组名称。
4239
4487
  # @type SecurityGroupName: String
4240
- # @param SecurityGroupRemark: 安全组备注
4488
+ # @param SecurityGroupRemark: 安全组备注信息。
4241
4489
  # @type SecurityGroupRemark: String
4242
4490
 
4243
4491
  attr_accessor :ProjectId, :CreateTime, :Inbound, :Outbound, :SecurityGroupId, :SecurityGroupName, :SecurityGroupRemark
@@ -4279,21 +4527,23 @@ module TencentCloud
4279
4527
 
4280
4528
  # 安全组规则
4281
4529
  class SecurityGroupBound < TencentCloud::Common::AbstractModel
4282
- # @param Action: 执行规则。ACCEPT或DROP
4530
+ # @param Action: 执行策略。
4531
+ # - ACCEPT:允许,放行该端口相应的访问请求。
4532
+ # - DROP:拒绝,直接丢弃数据包,不返回任何回应信息。
4283
4533
  # @type Action: String
4284
- # @param CidrIp: ip段。
4534
+ # @param CidrIp: 访问数据库的入站 IP 或 IP 段。
4285
4535
  # @type CidrIp: String
4286
- # @param PortRange: 端口范围
4536
+ # @param PortRange: 访问数据库的端口。
4287
4537
  # @type PortRange: String
4288
- # @param IpProtocol: 传输层协议。tcp,udp或ALL
4538
+ # @param IpProtocol: 传输层协议:tcp
4289
4539
  # @type IpProtocol: String
4290
- # @param Id: 安全组id代表的地址集合
4540
+ # @param Id: 安全组 ID。
4291
4541
  # @type Id: String
4292
- # @param AddressModule: 地址组id代表的地址集合
4542
+ # @param AddressModule: IP 地址或 IP 地址组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/ip)获取参数模板 IP 地址详情。
4293
4543
  # @type AddressModule: String
4294
- # @param ServiceModule: 服务组id代表的协议和端口集合
4544
+ # @param ServiceModule: 协议端口或协议端口组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/protoport)获取参数模板协议端口详情。
4295
4545
  # @type ServiceModule: String
4296
- # @param Desc: 描述
4546
+ # @param Desc: 安全组描述信息。
4297
4547
  # @type Desc: String
4298
4548
 
4299
4549
  attr_accessor :Action, :CidrIp, :PortRange, :IpProtocol, :Id, :AddressModule, :ServiceModule, :Desc
@@ -4325,7 +4575,7 @@ module TencentCloud
4325
4575
  class SetAccountUserPrivilegeRequest < TencentCloud::Common::AbstractModel
4326
4576
  # @param InstanceId: 指定待设置账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
4327
4577
  # @type InstanceId: String
4328
- # @param UserName: 设置账号名称。
4578
+ # @param UserName: 设置访问实例的账号名称。设置要求为:字母开头的1-64个字符,只可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。
4329
4579
  # @type UserName: String
4330
4580
  # @param AuthRole: 设置权限信息。
4331
4581
  # @type AuthRole: Array
@@ -4376,7 +4626,13 @@ module TencentCloud
4376
4626
  class SetBackupRulesRequest < TencentCloud::Common::AbstractModel
4377
4627
  # @param InstanceId: 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
4378
4628
  # @type InstanceId: String
4379
- # @param BackupMethod: 设置自动备份方式。- 0:逻辑备份。- 1:物理备份。-3:快照备份(仅云盘版支持)。
4629
+ # @param BackupMethod: 备份方式。
4630
+ # - 0:逻辑备份。
4631
+ # - 1:物理备份。
4632
+ # - 3:快照备份。
4633
+ # **说明**:
4634
+ # 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
4635
+ # 2. 实例开通存储加密,则备份方式不能为物理备份。
4380
4636
  # @type BackupMethod: Integer
4381
4637
  # @param BackupTime: 设置自动备份开始时间。取值范围为:[0,23],例如:该参数设置为2,表示02:00开始备份。
4382
4638
  # @type BackupTime: Integer
@@ -4546,11 +4802,11 @@ module TencentCloud
4546
4802
 
4547
4803
  # 慢日志详情
4548
4804
  class SlowLogItem < TencentCloud::Common::AbstractModel
4549
- # @param Log: 慢日志
4805
+ # @param Log: 慢日志详情。
4550
4806
  # @type Log: String
4551
- # @param NodeName: 节点名称
4807
+ # @param NodeName: 节点名称。
4552
4808
  # @type NodeName: String
4553
- # @param QueryHash: queryHash
4809
+ # @param QueryHash: 查询哈希值。
4554
4810
  # @type QueryHash: String
4555
4811
 
4556
4812
  attr_accessor :Log, :NodeName, :QueryHash
@@ -4570,15 +4826,15 @@ module TencentCloud
4570
4826
 
4571
4827
  # 用于描述MongoDB数据库慢日志统计信息
4572
4828
  class SlowLogPattern < TencentCloud::Common::AbstractModel
4573
- # @param Pattern: 慢日志模式
4829
+ # @param Pattern: 慢日志输出格式:库名.表名.命令。
4574
4830
  # @type Pattern: String
4575
- # @param QueryHash: queryHash
4831
+ # @param QueryHash: 记录慢日志时所带的queryHash 值,标识一类查询。
4576
4832
  # @type QueryHash: String
4577
- # @param MaxTime: 最大执行时间
4833
+ # @param MaxTime: 最大执行时间。单位:毫秒。
4578
4834
  # @type MaxTime: Integer
4579
- # @param AverageTime: 平均执行时间
4835
+ # @param AverageTime: 平均执行时间。单位:毫秒。
4580
4836
  # @type AverageTime: Integer
4581
- # @param Total: 该模式慢日志条数
4837
+ # @param Total: 慢日志条数。
4582
4838
  # @type Total: Integer
4583
4839
 
4584
4840
  attr_accessor :Pattern, :QueryHash, :MaxTime, :AverageTime, :Total
@@ -4600,19 +4856,12 @@ module TencentCloud
4600
4856
  end
4601
4857
  end
4602
4858
 
4603
- # mongodb售卖规格
4859
+ # mongodb售卖规格。
4604
4860
  class SpecItem < TencentCloud::Common::AbstractModel
4605
4861
  # @param SpecCode: 规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。
4606
- # - 节点类型,如下所示。
4607
- # - mongo:Mongod 节点。
4608
- # - mongos:Mongos 节点。
4609
- # - cfgstr:Configserver 节点。
4610
- # - 规格类型,如下所示。
4611
- # - HIO10G:通用高HIO万兆型。
4612
- # - HCD:云盘版类型。
4613
- # - 内存规格,如下所示:
4614
- # - 支持4、8、16、32、64、128、240、512。
4615
- # - 单位g:表示GB。128g则表示128GB。
4862
+ # - 节点类型:**mongo**,指 Mongod 节点;**mongos**,指 Mongos 节点;**cfgstr**,指 Configserver 节点。
4863
+ # - 规格类型:**HIO10G**,指通用高HIO万兆型;**HCD**:指云盘版类型。
4864
+ # - 内存规格:支持4、8、16、32、64、128、240、512。单位g:表示GB。128g 则表示128GB。
4616
4865
  # @type SpecCode: String
4617
4866
  # @param Status: 售卖规格有效标志,取值范围如下:
4618
4867
  # - 0:停止售卖,
@@ -4633,16 +4882,16 @@ module TencentCloud
4633
4882
  # @param Conns: 规格所支持的最大连接数限制。
4634
4883
  # @type Conns: Integer
4635
4884
  # @param MongoVersionCode: 实例存储引擎版本信息。
4636
- # - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
4637
4885
  # - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
4638
4886
  # - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
4639
4887
  # - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
4640
4888
  # - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
4641
4889
  # - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
4890
+ # - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
4642
4891
  # @type MongoVersionCode: String
4643
4892
  # @param MongoVersionValue: 实例版本对应的数字版本。
4644
4893
  # @type MongoVersionValue: Integer
4645
- # @param Version: 实例版本信息。支持:3.6、4.2、4.4、5.0、6.0。
4894
+ # @param Version: 实例版本信息。支持:4.2、4.4、5.0、6.0、7.0
4646
4895
  # @type Version: String
4647
4896
  # @param EngineName: 存储引擎。
4648
4897
  # @type EngineName: String
@@ -4718,15 +4967,17 @@ module TencentCloud
4718
4967
  end
4719
4968
  end
4720
4969
 
4721
- # 实例规格信息
4970
+ # 实例规格信息。
4722
4971
  class SpecificationInfo < TencentCloud::Common::AbstractModel
4723
- # @param Region: 地域信息
4972
+ # @param Region: 地域信息。
4724
4973
  # @type Region: String
4725
- # @param Zone: 可用区信息
4974
+ # @param Zone: 可用区信息。
4726
4975
  # @type Zone: String
4727
- # @param SpecItems: 售卖规格信息
4976
+ # @param SpecItems: 售卖规格信息。
4728
4977
  # @type SpecItems: Array
4729
- # @param SupportMultiAZ: 是否支持跨可用区部署 1-支持,0-不支持
4978
+ # @param SupportMultiAZ: 是否支持跨可用区部署。
4979
+ # - 1:支持。
4980
+ # - 0:不支持。
4730
4981
  # @type SupportMultiAZ: Integer
4731
4982
 
4732
4983
  attr_accessor :Region, :Zone, :SpecItems, :SupportMultiAZ
@@ -4775,7 +5026,7 @@ module TencentCloud
4775
5026
 
4776
5027
  # TerminateDBInstances请求参数结构体
4777
5028
  class TerminateDBInstancesRequest < TencentCloud::Common::AbstractModel
4778
- # @param InstanceId: 指定预隔离实例ID。格式如:cmgo-p8vnipr5
5029
+ # @param InstanceId: 指定预隔离实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制预隔离实例 ID
4779
5030
  # @type InstanceId: String
4780
5031
 
4781
5032
  attr_accessor :InstanceId