tencentcloud-sdk-mongodb 3.0.1146 → 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.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20190725/client.rb +8 -8
- data/lib/v20190725/models.rb +493 -256
- metadata +2 -2
data/lib/v20190725/models.rb
CHANGED
@@ -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
|
@@ -111,25 +111,36 @@ module TencentCloud
|
|
111
111
|
|
112
112
|
# 备份下载任务
|
113
113
|
class BackupDownloadTask < TencentCloud::Common::AbstractModel
|
114
|
-
# @param CreateTime:
|
114
|
+
# @param CreateTime: 任务创建时间。
|
115
115
|
# @type CreateTime: String
|
116
|
-
# @param BackupName:
|
116
|
+
# @param BackupName: 备份文件名。
|
117
117
|
# @type BackupName: String
|
118
|
-
# @param ReplicaSetId:
|
118
|
+
# @param ReplicaSetId: 分片名称。
|
119
119
|
# @type ReplicaSetId: String
|
120
|
-
# @param BackupSize:
|
120
|
+
# @param BackupSize: 备份数据大小,单位:字节。
|
121
121
|
# @type BackupSize: Integer
|
122
|
-
# @param Status: 任务状态。
|
122
|
+
# @param Status: 任务状态。
|
123
|
+
# - 0:等待执行。
|
124
|
+
# - 1:正在下载。
|
125
|
+
# - 2:下载完成。
|
126
|
+
# - 3:下载失败。
|
127
|
+
# - 4:等待重试。
|
123
128
|
# @type Status: Integer
|
124
|
-
# @param Percent:
|
129
|
+
# @param Percent: 任务进度百分比。
|
125
130
|
# @type Percent: Integer
|
126
|
-
# @param TimeSpend:
|
131
|
+
# @param TimeSpend: 耗时,单位为秒。
|
127
132
|
# @type TimeSpend: Integer
|
128
|
-
# @param Url:
|
133
|
+
# @param Url: 备份数据下载链接。
|
129
134
|
# @type Url: String
|
130
|
-
# @param BackupMethod:
|
135
|
+
# @param BackupMethod: 备份方式。
|
136
|
+
# - 0:逻辑备份。
|
137
|
+
# - 1:物理备份。
|
138
|
+
# - 3:快照备份。
|
139
|
+
# **说明**:
|
140
|
+
# 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
141
|
+
# 2. 实例开通存储加密,则备份方式不能为物理备份。
|
131
142
|
# @type BackupMethod: Integer
|
132
|
-
# @param BackupDesc:
|
143
|
+
# @param BackupDesc: 发起备份时指定的备注信息。
|
133
144
|
# @type BackupDesc: String
|
134
145
|
# @param Region: 地区信息。
|
135
146
|
# @type Region: String
|
@@ -169,11 +180,16 @@ module TencentCloud
|
|
169
180
|
end
|
170
181
|
end
|
171
182
|
|
172
|
-
#
|
183
|
+
# 创建备份下载任务结果。
|
173
184
|
class BackupDownloadTaskStatus < TencentCloud::Common::AbstractModel
|
174
|
-
# @param ReplicaSetId:
|
185
|
+
# @param ReplicaSetId: 分片名。
|
175
186
|
# @type ReplicaSetId: String
|
176
|
-
# @param Status: 任务当前状态。
|
187
|
+
# @param Status: 任务当前状态。
|
188
|
+
# - 0:等待执行。
|
189
|
+
# - 1:正在下载。
|
190
|
+
# - 2:下载完成。
|
191
|
+
# - 3:下载失败。
|
192
|
+
# - 4:等待重试。
|
177
193
|
# @type Status: Integer
|
178
194
|
|
179
195
|
attr_accessor :ReplicaSetId, :Status
|
@@ -189,36 +205,48 @@ module TencentCloud
|
|
189
205
|
end
|
190
206
|
end
|
191
207
|
|
192
|
-
#
|
208
|
+
# 备份信息。
|
193
209
|
class BackupInfo < TencentCloud::Common::AbstractModel
|
194
210
|
# @param InstanceId: 实例ID。
|
195
211
|
# @type InstanceId: String
|
196
|
-
# @param BackupType:
|
212
|
+
# @param BackupType: 备份方式。
|
213
|
+
# - 0:自动备份。
|
214
|
+
# - 1:手动备份。
|
197
215
|
# @type BackupType: Integer
|
198
|
-
# @param BackupName:
|
216
|
+
# @param BackupName: 备份文件名称。
|
199
217
|
# @type BackupName: String
|
200
|
-
# @param BackupDesc:
|
218
|
+
# @param BackupDesc: 备份任务备注信息。
|
201
219
|
# @type BackupDesc: String
|
202
|
-
# @param BackupSize:
|
220
|
+
# @param BackupSize: 备份文件大小,单位:KB。
|
203
221
|
# @type BackupSize: Integer
|
204
|
-
# @param StartTime:
|
222
|
+
# @param StartTime: 备份开始时间。
|
205
223
|
# @type StartTime: String
|
206
|
-
# @param EndTime:
|
224
|
+
# @param EndTime: 备份结束时间。
|
207
225
|
# @type EndTime: String
|
208
|
-
# @param Status:
|
226
|
+
# @param Status: 备份状态。
|
227
|
+
# - 1:备份中。
|
228
|
+
# - 2:备份成功。
|
209
229
|
# @type Status: Integer
|
210
|
-
# @param BackupMethod:
|
230
|
+
# @param BackupMethod: 备份方式。
|
231
|
+
# - 0:逻辑备份。
|
232
|
+
# - 1:物理备份。
|
233
|
+
# - 3:快照备份。
|
234
|
+
# **说明:**
|
235
|
+
# - 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
236
|
+
# - 实例开通存储加密,则备份方式不能为物理备份。
|
211
237
|
# @type BackupMethod: Integer
|
212
|
-
# @param BackId: 备份记录
|
238
|
+
# @param BackId: 备份记录 ID。
|
213
239
|
# @type BackId: Integer
|
214
|
-
# @param DeleteTime:
|
240
|
+
# @param DeleteTime: 备份删除时间。
|
215
241
|
# @type DeleteTime: String
|
216
|
-
# @param BackupRegion:
|
242
|
+
# @param BackupRegion: 异地备份地域。
|
217
243
|
# @type BackupRegion: String
|
244
|
+
# @param RestoreTime: 备份支持的回档时间。
|
245
|
+
# @type RestoreTime: String
|
218
246
|
|
219
|
-
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
|
220
248
|
|
221
|
-
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)
|
222
250
|
@InstanceId = instanceid
|
223
251
|
@BackupType = backuptype
|
224
252
|
@BackupName = backupname
|
@@ -231,6 +259,7 @@ module TencentCloud
|
|
231
259
|
@BackId = backid
|
232
260
|
@DeleteTime = deletetime
|
233
261
|
@BackupRegion = backupregion
|
262
|
+
@RestoreTime = restoretime
|
234
263
|
end
|
235
264
|
|
236
265
|
def deserialize(params)
|
@@ -246,6 +275,7 @@ module TencentCloud
|
|
246
275
|
@BackId = params['BackId']
|
247
276
|
@DeleteTime = params['DeleteTime']
|
248
277
|
@BackupRegion = params['BackupRegion']
|
278
|
+
@RestoreTime = params['RestoreTime']
|
249
279
|
end
|
250
280
|
end
|
251
281
|
|
@@ -347,6 +377,10 @@ module TencentCloud
|
|
347
377
|
# @param BackupMethod: 设置备份方式。
|
348
378
|
# - 0:逻辑备份。
|
349
379
|
# - 1:物理备份。
|
380
|
+
# - 3:快照备份。
|
381
|
+
# **说明**:
|
382
|
+
# 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
383
|
+
# 2. 实例开通存储加密,则备份方式不能为物理备份。
|
350
384
|
# @type BackupMethod: Integer
|
351
385
|
# @param BackupRemark: 备份备注信息。
|
352
386
|
# @type BackupRemark: String
|
@@ -388,13 +422,13 @@ module TencentCloud
|
|
388
422
|
|
389
423
|
# CreateBackupDownloadTask请求参数结构体
|
390
424
|
class CreateBackupDownloadTaskRequest < TencentCloud::Common::AbstractModel
|
391
|
-
# @param InstanceId: 实例ID
|
425
|
+
# @param InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
392
426
|
# @type InstanceId: String
|
393
|
-
# @param BackupName:
|
427
|
+
# @param BackupName: 要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。
|
394
428
|
# @type BackupName: String
|
395
|
-
# @param BackupSets:
|
396
|
-
#
|
397
|
-
#
|
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的数据。分片集群如需全量下载,请按示例方式传入全部分片名称。
|
398
432
|
# @type BackupSets: Array
|
399
433
|
|
400
434
|
attr_accessor :InstanceId, :BackupName, :BackupSets
|
@@ -421,7 +455,7 @@ module TencentCloud
|
|
421
455
|
|
422
456
|
# CreateBackupDownloadTask返回参数结构体
|
423
457
|
class CreateBackupDownloadTaskResponse < TencentCloud::Common::AbstractModel
|
424
|
-
# @param Tasks:
|
458
|
+
# @param Tasks: 下载任务状态。
|
425
459
|
# @type Tasks: Array
|
426
460
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
427
461
|
# @type RequestId: String
|
@@ -459,18 +493,18 @@ module TencentCloud
|
|
459
493
|
# - 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
460
494
|
# @type NodeNum: Integer
|
461
495
|
# @param MongoVersion: 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
462
|
-
# - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
463
496
|
# - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
464
497
|
# - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
465
498
|
# - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
466
499
|
# - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
467
500
|
# - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
501
|
+
# - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
468
502
|
# @type MongoVersion: String
|
469
503
|
# @param MachineCode: 产品规格类型。
|
470
504
|
# - HIO10G:通用高HIO万兆型。
|
471
505
|
# - HCD:云盘版类型。
|
472
506
|
# @type MachineCode: String
|
473
|
-
# @param GoodsNum: 实例数量,最小值1,最大值为
|
507
|
+
# @param GoodsNum: 实例数量,最小值1,最大值为30。
|
474
508
|
# @type GoodsNum: Integer
|
475
509
|
# @param Zone: 可用区信息,输入格式如:ap-guangzhou-2。
|
476
510
|
# - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
@@ -480,9 +514,13 @@ module TencentCloud
|
|
480
514
|
# - REPLSET:副本集。
|
481
515
|
# - SHARD:分片集群。
|
482
516
|
# @type ClusterType: String
|
483
|
-
# @param VpcId: 私有网络ID
|
517
|
+
# @param VpcId: 私有网络ID。
|
518
|
+
# - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
|
519
|
+
# - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
484
520
|
# @type VpcId: String
|
485
|
-
# @param SubnetId: 私有网络VPC
|
521
|
+
# @param SubnetId: 私有网络 VPC 的子网 ID。
|
522
|
+
# - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
|
523
|
+
# - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
486
524
|
# @type SubnetId: String
|
487
525
|
# @param Password: 实例密码。设置要求如下:
|
488
526
|
# - 字符个数为[8,32]。
|
@@ -496,17 +534,26 @@ module TencentCloud
|
|
496
534
|
# @type ProjectId: Integer
|
497
535
|
# @param Tags: 实例标签信息。
|
498
536
|
# @type Tags: Array
|
499
|
-
# @param Clone:
|
537
|
+
# @param Clone: 实例类型。
|
538
|
+
# - 1:正式实例。
|
539
|
+
# - 3:只读实例。
|
540
|
+
# - 4:灾备实例。
|
541
|
+
# - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
|
500
542
|
# @type Clone: Integer
|
501
|
-
# @param Father: 父实例 ID
|
543
|
+
# @param Father: 父实例 ID。
|
544
|
+
# - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
|
545
|
+
# - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
|
502
546
|
# @type Father: String
|
503
|
-
# @param SecurityGroup: 安全组 ID。
|
547
|
+
# @param SecurityGroup: 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
|
504
548
|
# @type SecurityGroup: Array
|
505
549
|
# @param RestoreTime: 克隆实例回档时间。
|
506
550
|
# - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
|
507
551
|
# - 回档时间范围:仅能回档7天内时间点的数据。
|
508
552
|
# @type RestoreTime: String
|
509
|
-
# @param InstanceName: 实例名称。仅支持长度为
|
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.
|
510
557
|
# @type InstanceName: String
|
511
558
|
# @param AvailabilityZoneList: 若多可用区部署云数据库实例,指定多可用区列表。
|
512
559
|
# - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
|
@@ -518,7 +565,6 @@ module TencentCloud
|
|
518
565
|
# @param MongosMemory: Mongos 内存大小。
|
519
566
|
# - 购买分片集群时,必须填写。
|
520
567
|
# - 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
|
521
|
-
|
522
568
|
# @type MongosMemory: Integer
|
523
569
|
# @param MongosNodeNum: Mongos 数量。购买分片集群时,必须填写。
|
524
570
|
# - 单可用区部署实例,其数量范围为[3,32]。
|
@@ -530,7 +576,9 @@ module TencentCloud
|
|
530
576
|
# @type ReadonlyNodeAvailabilityZoneList: Array
|
531
577
|
# @param HiddenZone: Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
|
532
578
|
# @type HiddenZone: String
|
533
|
-
# @param ParamTemplateId: 参数模板 ID
|
579
|
+
# @param ParamTemplateId: 参数模板 ID。
|
580
|
+
# - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
|
581
|
+
# - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
|
534
582
|
# @type ParamTemplateId: String
|
535
583
|
|
536
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
|
@@ -631,16 +679,26 @@ module TencentCloud
|
|
631
679
|
class CreateDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
|
632
680
|
# @param TplName: 参数模板名称。
|
633
681
|
# @type TplName: String
|
634
|
-
# @param MongoVersion:
|
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存储引擎版本。
|
635
690
|
# @type MongoVersion: String
|
636
|
-
# @param ClusterType:
|
637
|
-
#
|
691
|
+
# @param ClusterType: 实例类型。当 MirrorTplId 为空值时,该参数必填。
|
692
|
+
# - REPLSET:副本集实例。
|
693
|
+
# - SHARD:分片实例。
|
694
|
+
# - STANDALONE:单节点实例。
|
638
695
|
# @type ClusterType: String
|
639
696
|
# @param TplDesc: 模板描述信息。
|
640
697
|
# @type TplDesc: String
|
641
|
-
# @param Params:
|
698
|
+
# @param Params: 模板参数,若不配置该参数,则以系统默认模板作为新版本参数。
|
642
699
|
# @type Params: Array
|
643
|
-
# @param MirrorTplId: 镜像模板ID
|
700
|
+
# @param MirrorTplId: 镜像模板 ID。若指定镜像模板,则以该模板为镜像,克隆出一个新的模板。
|
701
|
+
# **注意**:MirrorTplId 不为空值时,MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。
|
644
702
|
# @type MirrorTplId: String
|
645
703
|
|
646
704
|
attr_accessor :TplName, :MongoVersion, :ClusterType, :TplDesc, :Params, :MirrorTplId
|
@@ -701,14 +759,14 @@ module TencentCloud
|
|
701
759
|
# @param Volume: 实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
702
760
|
# @type Volume: Integer
|
703
761
|
# @param MongoVersion: 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
704
|
-
# - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
705
762
|
# - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
706
763
|
# - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
707
764
|
# - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
708
765
|
# - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
709
766
|
# - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
767
|
+
# - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
710
768
|
# @type MongoVersion: String
|
711
|
-
# @param GoodsNum: 实例数量, 最小值1,最大值为
|
769
|
+
# @param GoodsNum: 实例数量, 最小值1,最大值为30。
|
712
770
|
# @type GoodsNum: Integer
|
713
771
|
# @param Zone: 可用区信息,输入格式如:ap-guangzhou-2。
|
714
772
|
# - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
@@ -731,9 +789,13 @@ module TencentCloud
|
|
731
789
|
# - 若不设置该参数,则为默认项目。
|
732
790
|
# - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面,可获取项目ID。
|
733
791
|
# @type ProjectId: Integer
|
734
|
-
# @param VpcId: 私有网络ID
|
792
|
+
# @param VpcId: 私有网络 ID。
|
793
|
+
# - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
|
794
|
+
# - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
735
795
|
# @type VpcId: String
|
736
|
-
# @param SubnetId: 私有网络VPC
|
796
|
+
# @param SubnetId: 私有网络 VPC 的子网 ID。
|
797
|
+
# - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
|
798
|
+
# - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
737
799
|
# @type SubnetId: String
|
738
800
|
# @param Password: 实例密码。设置要求如下:
|
739
801
|
# - 字符个数为[8,32]。
|
@@ -751,15 +813,24 @@ module TencentCloud
|
|
751
813
|
# - 1:是。
|
752
814
|
# - 0:否。默认为0。
|
753
815
|
# @type AutoVoucher: Integer
|
754
|
-
# @param Clone:
|
816
|
+
# @param Clone: 实例类型。
|
817
|
+
# - 1:正式实例。
|
818
|
+
# - 3:只读实例。
|
819
|
+
# - 4:灾备实例。
|
820
|
+
# - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
|
755
821
|
# @type Clone: Integer
|
756
|
-
# @param Father: 父实例 ID
|
822
|
+
# @param Father: 父实例 ID。
|
823
|
+
# - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
|
824
|
+
# - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
|
757
825
|
# @type Father: String
|
758
|
-
# @param SecurityGroup: 安全组 ID。
|
826
|
+
# @param SecurityGroup: 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
|
759
827
|
# @type SecurityGroup: Array
|
760
828
|
# @param RestoreTime: 克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。
|
761
829
|
# @type RestoreTime: String
|
762
|
-
# @param InstanceName: 实例名称。仅支持长度为
|
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.
|
763
834
|
# @type InstanceName: String
|
764
835
|
# @param AvailabilityZoneList: 若多可用区部署云数据库实例,指定多可用区列表。
|
765
836
|
# - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
|
@@ -782,7 +853,9 @@ module TencentCloud
|
|
782
853
|
# @type ReadonlyNodeAvailabilityZoneList: Array
|
783
854
|
# @param HiddenZone: Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
|
784
855
|
# @type HiddenZone: String
|
785
|
-
# @param ParamTemplateId: 参数模板 ID
|
856
|
+
# @param ParamTemplateId: 参数模板 ID。
|
857
|
+
# - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
|
858
|
+
# - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
|
786
859
|
# @type ParamTemplateId: String
|
787
860
|
|
788
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
|
@@ -893,7 +966,15 @@ module TencentCloud
|
|
893
966
|
# @type Ns: String
|
894
967
|
# @param Query: 操作执行语句。
|
895
968
|
# @type Query: String
|
896
|
-
# @param Op:
|
969
|
+
# @param Op: 操作类型。
|
970
|
+
# - none:特殊状态,空闲连接或内部任务等。
|
971
|
+
# - update:更新数据。
|
972
|
+
# - insert:插入操作。
|
973
|
+
# - query:查询操作。
|
974
|
+
# - command:命令操作。
|
975
|
+
# - getmore:获取更多数据。
|
976
|
+
# - remove:删除操作。
|
977
|
+
# - killcursors:释放查询游标的操作。
|
897
978
|
# @type Op: String
|
898
979
|
# @param ReplicaSetName: 操作所在的分片名称。
|
899
980
|
# @type ReplicaSetName: String
|
@@ -901,7 +982,9 @@ module TencentCloud
|
|
901
982
|
# @type NodeName: String
|
902
983
|
# @param Operation: 操作详细信息。
|
903
984
|
# @type Operation: String
|
904
|
-
# @param State:
|
985
|
+
# @param State: 节点角色。
|
986
|
+
# - primary:主节点。
|
987
|
+
# - secondary:从节点。
|
905
988
|
# @type State: String
|
906
989
|
# @param MicrosecsRunning: 操作已执行时间(ms)。
|
907
990
|
# @type MicrosecsRunning: Integer
|
@@ -1136,23 +1219,32 @@ module TencentCloud
|
|
1136
1219
|
|
1137
1220
|
# DescribeBackupDownloadTask请求参数结构体
|
1138
1221
|
class DescribeBackupDownloadTaskRequest < TencentCloud::Common::AbstractModel
|
1139
|
-
# @param InstanceId: 实例ID
|
1222
|
+
# @param InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1140
1223
|
# @type InstanceId: String
|
1141
|
-
# @param BackupName:
|
1224
|
+
# @param BackupName: 指定备份文件名,用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
|
1142
1225
|
# @type BackupName: String
|
1143
|
-
# @param StartTime: 指定查询时间范围内的任务,StartTime
|
1226
|
+
# @param StartTime: 指定查询时间范围内的任务,StartTime 指定开始时间。若不指定开始时间,则默认不限制开始时间。
|
1144
1227
|
# @type StartTime: String
|
1145
|
-
# @param EndTime: 指定查询时间范围内的任务,EndTime
|
1228
|
+
# @param EndTime: 指定查询时间范围内的任务,EndTime 指定截止时间。若不指定截止时间,则默认不限制截止时间。
|
1146
1229
|
# @type EndTime: String
|
1147
|
-
# @param Limit: 此次查询返回的条数,取值范围为1-100,默认为20
|
1230
|
+
# @param Limit: 此次查询返回的条数,取值范围为1-100,默认为20。
|
1148
1231
|
# @type Limit: Integer
|
1149
|
-
# @param Offset: 指定此次查询返回的页数,默认为0
|
1232
|
+
# @param Offset: 指定此次查询返回的页数,默认为0。
|
1150
1233
|
# @type Offset: Integer
|
1151
|
-
# @param OrderBy:
|
1234
|
+
# @param OrderBy: 排序字段。
|
1235
|
+
# - createTime:按照备份下载任务的创建时间排序。默认为 createTime。
|
1236
|
+
# - finishTime:按照备份下载任务的完成时间排序。
|
1152
1237
|
# @type OrderBy: String
|
1153
|
-
# @param OrderByType:
|
1238
|
+
# @param OrderByType: 排序方式。
|
1239
|
+
# - asc:升序排列。
|
1240
|
+
# - desc:降序排列。默认为 desc。
|
1154
1241
|
# @type OrderByType: String
|
1155
|
-
# @param Status:
|
1242
|
+
# @param Status: 指定任务状态,用于过滤下载任务。若不配置该参数,则返回所有状态类型的任务。
|
1243
|
+
# - 0:等待执行。
|
1244
|
+
# - 1:正在下载。
|
1245
|
+
# - 2:下载完成。
|
1246
|
+
# - 3:下载失败。
|
1247
|
+
# - 4:等待重试。
|
1156
1248
|
# @type Status: Array
|
1157
1249
|
|
1158
1250
|
attr_accessor :InstanceId, :BackupName, :StartTime, :EndTime, :Limit, :Offset, :OrderBy, :OrderByType, :Status
|
@@ -1184,9 +1276,9 @@ module TencentCloud
|
|
1184
1276
|
|
1185
1277
|
# DescribeBackupDownloadTask返回参数结构体
|
1186
1278
|
class DescribeBackupDownloadTaskResponse < TencentCloud::Common::AbstractModel
|
1187
|
-
# @param TotalCount:
|
1279
|
+
# @param TotalCount: 满足查询条件的所有条数。
|
1188
1280
|
# @type TotalCount: Integer
|
1189
|
-
# @param Tasks:
|
1281
|
+
# @param Tasks: 下载任务列表。
|
1190
1282
|
# @type Tasks: Array
|
1191
1283
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
1192
1284
|
# @type RequestId: String
|
@@ -1316,7 +1408,7 @@ module TencentCloud
|
|
1316
1408
|
|
1317
1409
|
# DescribeCurrentOp请求参数结构体
|
1318
1410
|
class DescribeCurrentOpRequest < TencentCloud::Common::AbstractModel
|
1319
|
-
# @param InstanceId: 指定要查询的实例 ID
|
1411
|
+
# @param InstanceId: 指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1320
1412
|
# @type InstanceId: String
|
1321
1413
|
# @param Ns: 操作所属的命名空间 namespace,格式为 db.collection。
|
1322
1414
|
# @type Ns: String
|
@@ -1324,7 +1416,15 @@ module TencentCloud
|
|
1324
1416
|
# - 默认值为0,取值范围为[0, 3600000],单位:毫秒。
|
1325
1417
|
# - 结果将返回超过设置时间的操作。
|
1326
1418
|
# @type MillisecondRunning: Integer
|
1327
|
-
# @param Op: 设置查询筛选条件为操作任务类型。取值包括:
|
1419
|
+
# @param Op: 设置查询筛选条件为操作任务类型。取值包括:
|
1420
|
+
# - none:特殊状态,空闲连接或内部任务等。
|
1421
|
+
# - update:更新数据。
|
1422
|
+
# - insert:插入操作。
|
1423
|
+
# - query:查询操作。
|
1424
|
+
# - command:命令操作。
|
1425
|
+
# - getmore:获取更多数据。
|
1426
|
+
# - remove:删除操作。
|
1427
|
+
# - killcursors:释放查询游标的操作。
|
1328
1428
|
# @type Op: String
|
1329
1429
|
# @param ReplicaSetName: 筛选条件,分片名称。
|
1330
1430
|
# @type ReplicaSetName: String
|
@@ -1332,13 +1432,15 @@ module TencentCloud
|
|
1332
1432
|
# - primary:主节点。
|
1333
1433
|
# - secondary:从节点。
|
1334
1434
|
# @type State: String
|
1335
|
-
# @param Limit: 单次请求返回的数量,默认值为100,取值范围为[0,100]
|
1435
|
+
# @param Limit: 单次请求返回的数量,默认值为100,取值范围为[0,100]。
|
1336
1436
|
# @type Limit: Integer
|
1337
|
-
# @param Offset: 偏移量,默认值为0,取值范围为[0,10000]
|
1437
|
+
# @param Offset: 偏移量,默认值为0,取值范围为[0,10000]。
|
1338
1438
|
# @type Offset: Integer
|
1339
|
-
# @param OrderBy:
|
1439
|
+
# @param OrderBy: 返回结果集排序的字段,目前支持按照 MicrosecsRunning(操作任务已执行的时间)排序。
|
1340
1440
|
# @type OrderBy: String
|
1341
|
-
# @param OrderByType:
|
1441
|
+
# @param OrderByType: 返回结果集排序方式。
|
1442
|
+
# - ASC:升序。默认为 ASC,按照升序排序。
|
1443
|
+
# - DESC:降序。
|
1342
1444
|
# @type OrderByType: String
|
1343
1445
|
|
1344
1446
|
attr_accessor :InstanceId, :Ns, :MillisecondRunning, :Op, :ReplicaSetName, :State, :Limit, :Offset, :OrderBy, :OrderByType
|
@@ -1403,9 +1505,15 @@ module TencentCloud
|
|
1403
1505
|
|
1404
1506
|
# DescribeDBBackups请求参数结构体
|
1405
1507
|
class DescribeDBBackupsRequest < TencentCloud::Common::AbstractModel
|
1406
|
-
# @param InstanceId: 实例ID
|
1508
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1407
1509
|
# @type InstanceId: String
|
1408
|
-
# @param BackupMethod:
|
1510
|
+
# @param BackupMethod: 备份方式。
|
1511
|
+
# - 0:逻辑备份。
|
1512
|
+
# - 1:物理备份。
|
1513
|
+
# - 3:快照备份。
|
1514
|
+
# **说明**:
|
1515
|
+
# 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
1516
|
+
# 2. 实例开通存储加密,则备份方式不能为物理备份。
|
1409
1517
|
# @type BackupMethod: Integer
|
1410
1518
|
# @param Limit: 分页大小,最大值为100,不设置默认查询所有。
|
1411
1519
|
# @type Limit: Integer
|
@@ -1431,9 +1539,9 @@ module TencentCloud
|
|
1431
1539
|
|
1432
1540
|
# DescribeDBBackups返回参数结构体
|
1433
1541
|
class DescribeDBBackupsResponse < TencentCloud::Common::AbstractModel
|
1434
|
-
# @param BackupList:
|
1542
|
+
# @param BackupList: 备份列表。
|
1435
1543
|
# @type BackupList: Array
|
1436
|
-
# @param TotalCount:
|
1544
|
+
# @param TotalCount: 备份总数。
|
1437
1545
|
# @type TotalCount: Integer
|
1438
1546
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
1439
1547
|
# @type RequestId: String
|
@@ -1462,7 +1570,9 @@ module TencentCloud
|
|
1462
1570
|
|
1463
1571
|
# DescribeDBInstanceDeal请求参数结构体
|
1464
1572
|
class DescribeDBInstanceDealRequest < TencentCloud::Common::AbstractModel
|
1465
|
-
# @param DealId: 订单ID
|
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**获取。
|
1466
1576
|
# @type DealId: String
|
1467
1577
|
|
1468
1578
|
attr_accessor :DealId
|
@@ -1478,15 +1588,28 @@ module TencentCloud
|
|
1478
1588
|
|
1479
1589
|
# DescribeDBInstanceDeal返回参数结构体
|
1480
1590
|
class DescribeDBInstanceDealResponse < TencentCloud::Common::AbstractModel
|
1481
|
-
# @param Status:
|
1591
|
+
# @param Status: 订单状态。
|
1592
|
+
# - 1:未支付。
|
1593
|
+
# - 2:已支付。
|
1594
|
+
# - 3:发货中。
|
1595
|
+
# - 4:发货成功。
|
1596
|
+
# - 5:发货失败。
|
1597
|
+
# - 6:退款。
|
1598
|
+
# - 7:订单关闭。
|
1599
|
+
# - 8:超时未支付关闭。
|
1482
1600
|
# @type Status: Integer
|
1483
|
-
# @param OriginalPrice:
|
1601
|
+
# @param OriginalPrice: 订单原价。单位:元。
|
1484
1602
|
# @type OriginalPrice: Float
|
1485
|
-
# @param DiscountPrice:
|
1603
|
+
# @param DiscountPrice: 订单折扣价格。单位:元。
|
1486
1604
|
# @type DiscountPrice: Float
|
1487
|
-
# @param Action:
|
1605
|
+
# @param Action: 订单操作行为。
|
1606
|
+
# - purchase:新购。
|
1607
|
+
# - renew:续费。
|
1608
|
+
# - upgrade:升配.
|
1609
|
+
# - downgrade:降配.
|
1610
|
+
# - refund:退货退款。
|
1488
1611
|
# @type Action: String
|
1489
|
-
# @param InstanceId:
|
1612
|
+
# @param InstanceId: 当前订单的实例 ID。
|
1490
1613
|
# @type InstanceId: String
|
1491
1614
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
1492
1615
|
# @type RequestId: String
|
@@ -1558,19 +1681,23 @@ module TencentCloud
|
|
1558
1681
|
|
1559
1682
|
# DescribeDBInstanceNodeProperty请求参数结构体
|
1560
1683
|
class DescribeDBInstanceNodePropertyRequest < TencentCloud::Common::AbstractModel
|
1561
|
-
# @param InstanceId: 实例ID
|
1684
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1562
1685
|
# @type InstanceId: String
|
1563
|
-
# @param NodeIds: 节点ID。
|
1686
|
+
# @param NodeIds: 节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID。
|
1564
1687
|
# @type NodeIds: Array
|
1565
1688
|
# @param Roles: 节点角色。可选值包括:
|
1566
|
-
#
|
1689
|
+
# - PRIMARY:主节点。
|
1690
|
+
# - SECONDARY:从节点。
|
1691
|
+
# - READONLY:只读节点。
|
1692
|
+
# - ARBITER:仲裁节点。
|
1567
1693
|
# @type Roles: Array
|
1568
|
-
# @param OnlyHidden: 该参数指定节点是否为Hidden节点,默认为false。
|
1694
|
+
# @param OnlyHidden: 该参数指定节点是否为 Hidden 节点,默认为 false。
|
1569
1695
|
# @type OnlyHidden: Boolean
|
1570
1696
|
# @param Priority: 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
|
1571
1697
|
# @type Priority: Integer
|
1572
1698
|
# @param Votes: 该参数指定节点投票权。
|
1573
|
-
#
|
1699
|
+
# - 1:具有投票权。
|
1700
|
+
# - 0:无投票权。
|
1574
1701
|
# @type Votes: Integer
|
1575
1702
|
# @param Tags: 节点标签。
|
1576
1703
|
# @type Tags: Array
|
@@ -1645,7 +1772,7 @@ module TencentCloud
|
|
1645
1772
|
|
1646
1773
|
# DescribeDBInstanceParamTplDetail请求参数结构体
|
1647
1774
|
class DescribeDBInstanceParamTplDetailRequest < TencentCloud::Common::AbstractModel
|
1648
|
-
# @param TplId: 参数模板 ID。
|
1775
|
+
# @param TplId: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
1649
1776
|
# @type TplId: String
|
1650
1777
|
# @param ParamName: 参数名称,传入该值,则只会获取该字段的参数详情。为空时,返回全部参数。
|
1651
1778
|
# @type ParamName: String
|
@@ -1675,9 +1802,19 @@ module TencentCloud
|
|
1675
1802
|
# @type InstanceMultiParams: Array
|
1676
1803
|
# @param TotalCount: 参数总个数。
|
1677
1804
|
# @type TotalCount: Integer
|
1678
|
-
# @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存储引擎版本。
|
1679
1813
|
# @type MongoVersion: String
|
1680
|
-
# @param ClusterType:
|
1814
|
+
# @param ClusterType: 模板适配集群类型。
|
1815
|
+
# - REPLSET:副本集实例。
|
1816
|
+
# - SHARD:分片实例。
|
1817
|
+
# - STANDALONE:单节点实例。
|
1681
1818
|
# @type ClusterType: String
|
1682
1819
|
# @param TplName: 参数模板名称。
|
1683
1820
|
# @type TplName: String
|
@@ -1741,16 +1878,22 @@ module TencentCloud
|
|
1741
1878
|
|
1742
1879
|
# DescribeDBInstanceParamTpl请求参数结构体
|
1743
1880
|
class DescribeDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
|
1744
|
-
# @param TplIds: 参数模板 ID
|
1881
|
+
# @param TplIds: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
1745
1882
|
# @type TplIds: Array
|
1746
|
-
# @param TplNames:
|
1883
|
+
# @param TplNames: 指定查询的模板名称。
|
1747
1884
|
# @type TplNames: Array
|
1748
|
-
# @param MongoVersion:
|
1749
|
-
# - MONGO_36_WT:MongoDB 3.6 WiredTiger
|
1750
|
-
# - 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存储引擎版本,
|
1751
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存储引擎版本。
|
1752
1893
|
# @type MongoVersion: Array
|
1753
|
-
# @param TplType:
|
1894
|
+
# @param TplType: 指定查询的模板类型。
|
1895
|
+
# - DEFAULT:系统默认模板。
|
1896
|
+
# - CUSTOMIZE:自定义模板。
|
1754
1897
|
# @type TplType: String
|
1755
1898
|
|
1756
1899
|
attr_accessor :TplIds, :TplNames, :MongoVersion, :TplType
|
@@ -1846,13 +1989,26 @@ module TencentCloud
|
|
1846
1989
|
|
1847
1990
|
# DescribeDBInstances请求参数结构体
|
1848
1991
|
class DescribeDBInstancesRequest < TencentCloud::Common::AbstractModel
|
1849
|
-
# @param InstanceIds: 实例 ID
|
1992
|
+
# @param InstanceIds: 实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1850
1993
|
# @type InstanceIds: Array
|
1851
|
-
# @param InstanceType:
|
1994
|
+
# @param InstanceType: 指定查询的实例类型。取值范围如下:
|
1995
|
+
# - 0:所有实例。
|
1996
|
+
# - 1:正式实例。
|
1997
|
+
# - 2:临时实例
|
1998
|
+
# - 3:只读实例。
|
1999
|
+
# - -1:查询同时包括正式实例、只读实例与灾备实例。
|
1852
2000
|
# @type InstanceType: Integer
|
1853
|
-
# @param ClusterType:
|
2001
|
+
# @param ClusterType: 指定所查询实例的集群类型,取值范围如下:
|
2002
|
+
# - 0:副本集实例。
|
2003
|
+
# - 1:分片实例。
|
2004
|
+
# - -1:副本集与分片实例。
|
1854
2005
|
# @type ClusterType: Integer
|
1855
|
-
# @param Status:
|
2006
|
+
# @param Status: 指定所查询实例的当前状态,取值范围如下所示:
|
2007
|
+
# - 0:待初始化。
|
2008
|
+
# - 1:流程处理中,例如:变更规格、参数修改等。
|
2009
|
+
# - 2:实例正常运行中。
|
2010
|
+
# - -2:已隔离(包年包月)。
|
2011
|
+
# - -3:已隔离(按量计费)。
|
1856
2012
|
# @type Status: Array
|
1857
2013
|
# @param VpcId: 私有网络的 ID。
|
1858
2014
|
# - 基础网络则无需配置该参数。
|
@@ -1862,9 +2018,12 @@ module TencentCloud
|
|
1862
2018
|
# - 基础网络则无需配置该参数。
|
1863
2019
|
# - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其子网 ID。
|
1864
2020
|
# @type SubnetId: String
|
1865
|
-
# @param PayMode:
|
2021
|
+
# @param PayMode: 指定所查询实例的付费类型。
|
2022
|
+
# - 0:查询按量计费实例。
|
2023
|
+
# - 1:查询包年包月实例。
|
2024
|
+
# - -1:查询按量计费与包年包月实例。
|
1866
2025
|
# @type PayMode: Integer
|
1867
|
-
# @param Limit: 单次请求返回的数量。默认值为20,取值范围为
|
2026
|
+
# @param Limit: 单次请求返回的数量。默认值为20,取值范围为(1,100]。
|
1868
2027
|
# @type Limit: Integer
|
1869
2028
|
# @param Offset: 偏移量,默认值为0。
|
1870
2029
|
# @type Offset: Integer
|
@@ -1958,29 +2117,35 @@ module TencentCloud
|
|
1958
2117
|
|
1959
2118
|
# DescribeDetailedSlowLogs请求参数结构体
|
1960
2119
|
class DescribeDetailedSlowLogsRequest < TencentCloud::Common::AbstractModel
|
1961
|
-
# @param InstanceId: 实例
|
2120
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1962
2121
|
# @type InstanceId: String
|
1963
|
-
# @param StartTime:
|
2122
|
+
# @param StartTime: 指定查询慢日志的开始时间。- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
1964
2123
|
# @type StartTime: String
|
1965
|
-
# @param EndTime:
|
2124
|
+
# @param EndTime: 指定查询慢日志的结束时间。
|
2125
|
+
# - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
|
2126
|
+
# - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
1966
2127
|
# @type EndTime: String
|
1967
|
-
# @param ExecTime:
|
2128
|
+
# @param ExecTime: 指定慢日志查询阈值,即查询执行时间大于此值的慢日志。单位:ms,默认值:100。
|
1968
2129
|
# @type ExecTime: Integer
|
1969
|
-
# @param Commands:
|
2130
|
+
# @param Commands: 指定查询慢日志的命令类型。
|
1970
2131
|
# @type Commands: Array
|
1971
|
-
# @param Texts:
|
2132
|
+
# @param Texts: 全文搜索关键字,多个关键字间为或关系。
|
1972
2133
|
# @type Texts: Array
|
1973
|
-
# @param NodeNames:
|
2134
|
+
# @param NodeNames: 指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。
|
1974
2135
|
# @type NodeNames: Array
|
1975
|
-
# @param QueryHash:
|
2136
|
+
# @param QueryHash: 指定查询 queryHash 值。
|
1976
2137
|
# @type QueryHash: Array
|
1977
|
-
# @param Offset:
|
2138
|
+
# @param Offset: 分页偏移量。默认值:0。取值范围:[0,100]。
|
1978
2139
|
# @type Offset: Integer
|
1979
|
-
# @param Limit:
|
2140
|
+
# @param Limit: 返回条数。默认值:20。取值范围:[0,10000]
|
1980
2141
|
# @type Limit: Integer
|
1981
|
-
# @param OrderBy:
|
2142
|
+
# @param OrderBy: 指定慢日志排序条件。
|
2143
|
+
# - StartTime:按照慢日志生成时间排序。
|
2144
|
+
# - ExecTime:按照慢日志执行时间排序。
|
1982
2145
|
# @type OrderBy: String
|
1983
|
-
# @param OrderByType:
|
2146
|
+
# @param OrderByType: 指定排序方式。
|
2147
|
+
# - desc:倒序。
|
2148
|
+
# - asc:顺序。
|
1984
2149
|
# @type OrderByType: String
|
1985
2150
|
|
1986
2151
|
attr_accessor :InstanceId, :StartTime, :EndTime, :ExecTime, :Commands, :Texts, :NodeNames, :QueryHash, :Offset, :Limit, :OrderBy, :OrderByType
|
@@ -2018,9 +2183,9 @@ module TencentCloud
|
|
2018
2183
|
|
2019
2184
|
# DescribeDetailedSlowLogs返回参数结构体
|
2020
2185
|
class DescribeDetailedSlowLogsResponse < TencentCloud::Common::AbstractModel
|
2021
|
-
# @param TotalCount:
|
2186
|
+
# @param TotalCount: 满足条件的慢日志数量。
|
2022
2187
|
# @type TotalCount: Integer
|
2023
|
-
# @param DetailedSlowLogs:
|
2188
|
+
# @param DetailedSlowLogs: 慢日志详情。
|
2024
2189
|
# @type DetailedSlowLogs: Array
|
2025
2190
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
2026
2191
|
# @type RequestId: String
|
@@ -2129,7 +2294,7 @@ module TencentCloud
|
|
2129
2294
|
|
2130
2295
|
# DescribeSecurityGroup请求参数结构体
|
2131
2296
|
class DescribeSecurityGroupRequest < TencentCloud::Common::AbstractModel
|
2132
|
-
# @param InstanceId: 实例 ID
|
2297
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2133
2298
|
# @type InstanceId: String
|
2134
2299
|
|
2135
2300
|
attr_accessor :InstanceId
|
@@ -2172,11 +2337,15 @@ module TencentCloud
|
|
2172
2337
|
|
2173
2338
|
# DescribeSlowLogPatterns请求参数结构体
|
2174
2339
|
class DescribeSlowLogPatternsRequest < TencentCloud::Common::AbstractModel
|
2175
|
-
# @param InstanceId: 实例ID
|
2340
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2176
2341
|
# @type InstanceId: String
|
2177
|
-
# @param StartTime:
|
2342
|
+
# @param StartTime: 慢日志起始时间。
|
2343
|
+
# - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
|
2344
|
+
# - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
2178
2345
|
# @type StartTime: String
|
2179
|
-
# @param EndTime:
|
2346
|
+
# @param EndTime: 慢日志终止时间。
|
2347
|
+
# - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
|
2348
|
+
# - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
2180
2349
|
# @type EndTime: String
|
2181
2350
|
# @param SlowMS: 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
|
2182
2351
|
# @type SlowMS: Integer
|
@@ -2243,11 +2412,15 @@ module TencentCloud
|
|
2243
2412
|
|
2244
2413
|
# DescribeSlowLogs请求参数结构体
|
2245
2414
|
class DescribeSlowLogsRequest < TencentCloud::Common::AbstractModel
|
2246
|
-
# @param InstanceId: 实例ID
|
2415
|
+
# @param InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2247
2416
|
# @type InstanceId: String
|
2248
|
-
# @param StartTime:
|
2417
|
+
# @param StartTime: 慢日志起始时间。
|
2418
|
+
# - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
|
2419
|
+
# - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
2249
2420
|
# @type StartTime: String
|
2250
|
-
# @param EndTime:
|
2421
|
+
# @param EndTime: 慢日志终止时间。
|
2422
|
+
# - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
|
2423
|
+
# - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
2251
2424
|
# @type EndTime: String
|
2252
2425
|
# @param SlowMS: 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
|
2253
2426
|
# @type SlowMS: Integer
|
@@ -2283,9 +2456,9 @@ module TencentCloud
|
|
2283
2456
|
|
2284
2457
|
# DescribeSlowLogs返回参数结构体
|
2285
2458
|
class DescribeSlowLogsResponse < TencentCloud::Common::AbstractModel
|
2286
|
-
# @param Count:
|
2459
|
+
# @param Count: 慢日志总数。
|
2287
2460
|
# @type Count: Integer
|
2288
|
-
# @param SlowLogs:
|
2461
|
+
# @param SlowLogs: 慢日志详情。
|
2289
2462
|
# @type SlowLogs: Array
|
2290
2463
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
2291
2464
|
# @type RequestId: String
|
@@ -2307,7 +2480,7 @@ module TencentCloud
|
|
2307
2480
|
|
2308
2481
|
# DescribeSpecInfo请求参数结构体
|
2309
2482
|
class DescribeSpecInfoRequest < TencentCloud::Common::AbstractModel
|
2310
|
-
# @param Zone:
|
2483
|
+
# @param Zone: 待查询可用区。当前支持的可用区,请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。
|
2311
2484
|
# @type Zone: String
|
2312
2485
|
|
2313
2486
|
attr_accessor :Zone
|
@@ -2323,7 +2496,7 @@ module TencentCloud
|
|
2323
2496
|
|
2324
2497
|
# DescribeSpecInfo返回参数结构体
|
2325
2498
|
class DescribeSpecInfoResponse < TencentCloud::Common::AbstractModel
|
2326
|
-
# @param SpecInfoList:
|
2499
|
+
# @param SpecInfoList: 实例售卖规格信息列表。
|
2327
2500
|
# @type SpecInfoList: Array
|
2328
2501
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
2329
2502
|
# @type RequestId: String
|
@@ -2350,7 +2523,7 @@ module TencentCloud
|
|
2350
2523
|
|
2351
2524
|
# DescribeTransparentDataEncryptionStatus请求参数结构体
|
2352
2525
|
class DescribeTransparentDataEncryptionStatusRequest < TencentCloud::Common::AbstractModel
|
2353
|
-
# @param InstanceId: 指定实例 ID
|
2526
|
+
# @param InstanceId: 指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2354
2527
|
# @type InstanceId: String
|
2355
2528
|
|
2356
2529
|
attr_accessor :InstanceId
|
@@ -2400,7 +2573,7 @@ module TencentCloud
|
|
2400
2573
|
|
2401
2574
|
# DropDBInstanceParamTpl请求参数结构体
|
2402
2575
|
class DropDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
|
2403
|
-
# @param TplId: 参数模板 ID。
|
2576
|
+
# @param TplId: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
2404
2577
|
# @type TplId: String
|
2405
2578
|
|
2406
2579
|
attr_accessor :TplId
|
@@ -2474,11 +2647,11 @@ module TencentCloud
|
|
2474
2647
|
end
|
2475
2648
|
end
|
2476
2649
|
|
2477
|
-
# 按
|
2650
|
+
# 按 Key 闪回键值对
|
2478
2651
|
class FBKeyValue < TencentCloud::Common::AbstractModel
|
2479
|
-
# @param Key:
|
2652
|
+
# @param Key: 指定按 Key 闪回的目标 Key (键) 。
|
2480
2653
|
# @type Key: String
|
2481
|
-
# @param Value:
|
2654
|
+
# @param Value: 指定按 Key 闪回的目标 Key 所对应的 Value(值)。
|
2482
2655
|
# @type Value: String
|
2483
2656
|
|
2484
2657
|
attr_accessor :Key, :Value
|
@@ -2549,15 +2722,15 @@ module TencentCloud
|
|
2549
2722
|
end
|
2550
2723
|
end
|
2551
2724
|
|
2552
|
-
# 按
|
2725
|
+
# 按 Key 闪回数据表
|
2553
2726
|
class FlashbackCollection < TencentCloud::Common::AbstractModel
|
2554
|
-
# @param CollectionName:
|
2727
|
+
# @param CollectionName: 指定按 Key 闪回源数据库集合名。
|
2555
2728
|
# @type CollectionName: String
|
2556
|
-
# @param TargetResultCollectionName:
|
2729
|
+
# @param TargetResultCollectionName: 指定按 Key 闪回目标数据库集合名。
|
2557
2730
|
# @type TargetResultCollectionName: String
|
2558
|
-
# @param FilterKey:
|
2731
|
+
# @param FilterKey: 指定用于过滤按 Key 闪回的 Key(键)。
|
2559
2732
|
# @type FilterKey: String
|
2560
|
-
# @param KeyValues:
|
2733
|
+
# @param KeyValues: 指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。
|
2561
2734
|
# @type KeyValues: Array
|
2562
2735
|
|
2563
2736
|
attr_accessor :CollectionName, :TargetResultCollectionName, :FilterKey, :KeyValues
|
@@ -2584,11 +2757,11 @@ module TencentCloud
|
|
2584
2757
|
end
|
2585
2758
|
end
|
2586
2759
|
|
2587
|
-
# 按
|
2760
|
+
# 按 Key 闪回的数据库及集合信息
|
2588
2761
|
class FlashbackDatabase < TencentCloud::Common::AbstractModel
|
2589
|
-
# @param DBName: 按
|
2762
|
+
# @param DBName: 按 Key 闪回目标数据所在库。
|
2590
2763
|
# @type DBName: String
|
2591
|
-
# @param Collections: 按
|
2764
|
+
# @param Collections: 按 Key 闪回的数据库集合。
|
2592
2765
|
# @type Collections: Array
|
2593
2766
|
|
2594
2767
|
attr_accessor :DBName, :Collections
|
@@ -2893,29 +3066,40 @@ module TencentCloud
|
|
2893
3066
|
end
|
2894
3067
|
end
|
2895
3068
|
|
2896
|
-
#
|
3069
|
+
# 实例详情。
|
2897
3070
|
class InstanceDetail < TencentCloud::Common::AbstractModel
|
2898
|
-
# @param InstanceId: 实例ID。
|
3071
|
+
# @param InstanceId: 实例 ID。
|
2899
3072
|
# @type InstanceId: String
|
2900
3073
|
# @param InstanceName: 实例名称。
|
2901
3074
|
# @type InstanceName: String
|
2902
|
-
# @param PayMode:
|
3075
|
+
# @param PayMode: 付费类型。
|
3076
|
+
# - 1:包年包月。
|
3077
|
+
# - 0:按量计费。
|
2903
3078
|
# @type PayMode: Integer
|
2904
|
-
# @param ProjectId: 项目ID。
|
3079
|
+
# @param ProjectId: 项目 ID。
|
2905
3080
|
# @type ProjectId: Integer
|
2906
|
-
# @param ClusterType:
|
3081
|
+
# @param ClusterType: 集群类型。
|
3082
|
+
# - 0:副本集实例。
|
3083
|
+
# - 1:分片实例。
|
2907
3084
|
# @type ClusterType: Integer
|
2908
3085
|
# @param Region: 地域信息。
|
2909
3086
|
# @type Region: String
|
2910
3087
|
# @param Zone: 可用区信息。
|
2911
3088
|
# @type Zone: String
|
2912
|
-
# @param NetType:
|
3089
|
+
# @param NetType: 网络类型。
|
3090
|
+
# - 0:基础网络。
|
3091
|
+
# - 1:私有网络。
|
2913
3092
|
# @type NetType: Integer
|
2914
3093
|
# @param VpcId: 私有网络的ID。
|
2915
3094
|
# @type VpcId: String
|
2916
3095
|
# @param SubnetId: 私有网络的子网ID。
|
2917
3096
|
# @type SubnetId: String
|
2918
|
-
# @param Status:
|
3097
|
+
# @param Status: 实例状态。
|
3098
|
+
# - 0:待初始化。
|
3099
|
+
# - 1:流程处理中,例如:变更规格、参数修改等。
|
3100
|
+
# - 2:实例正常运行中。
|
3101
|
+
# - -2:已隔离(包年包月)。
|
3102
|
+
# - -3:已隔离(按量计费)。
|
2919
3103
|
# @type Status: Integer
|
2920
3104
|
# @param Vip: 实例IP。
|
2921
3105
|
# @type Vip: String
|
@@ -2925,23 +3109,35 @@ module TencentCloud
|
|
2925
3109
|
# @type CreateTime: String
|
2926
3110
|
# @param DeadLine: 实例到期时间。
|
2927
3111
|
# @type DeadLine: String
|
2928
|
-
# @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存储引擎版本。
|
2929
3120
|
# @type MongoVersion: String
|
2930
|
-
# @param Memory:
|
3121
|
+
# @param Memory: 实例内存规格,单位:MB。
|
2931
3122
|
# @type Memory: Integer
|
2932
|
-
# @param Volume:
|
3123
|
+
# @param Volume: 实例磁盘规格,单位:MB。
|
2933
3124
|
# @type Volume: Integer
|
2934
|
-
# @param CpuNum: 实例CPU核心数。
|
3125
|
+
# @param CpuNum: 实例 CPU 核心数。
|
2935
3126
|
# @type CpuNum: Integer
|
2936
3127
|
# @param MachineType: 实例机器类型。
|
3128
|
+
# - HIO10G:通用高 HIO 万兆型。
|
3129
|
+
# - HCD:云盘版类型。
|
2937
3130
|
# @type MachineType: String
|
2938
3131
|
# @param SecondaryNum: 实例从节点数。
|
2939
3132
|
# @type SecondaryNum: Integer
|
2940
3133
|
# @param ReplicationSetNum: 实例分片数。
|
2941
3134
|
# @type ReplicationSetNum: Integer
|
2942
|
-
# @param AutoRenewFlag:
|
3135
|
+
# @param AutoRenewFlag: 实例自动续费标志。
|
3136
|
+
# - 0:手动续费。
|
3137
|
+
# - 1:自动续费。
|
3138
|
+
# - 2:确认不续费。
|
2943
3139
|
# @type AutoRenewFlag: Integer
|
2944
|
-
# @param UsedVolume:
|
3140
|
+
# @param UsedVolume: 已用容量,单位:MB。
|
2945
3141
|
# @type UsedVolume: Integer
|
2946
3142
|
# @param MaintenanceStart: 维护窗口起始时间。
|
2947
3143
|
# @type MaintenanceStart: String
|
@@ -2963,29 +3159,34 @@ module TencentCloud
|
|
2963
3159
|
# @type InstanceVer: Integer
|
2964
3160
|
# @param ClusterVer: 实例版本标记。
|
2965
3161
|
# @type ClusterVer: Integer
|
2966
|
-
# @param Protocol:
|
3162
|
+
# @param Protocol: 协议信息:mongodb。
|
2967
3163
|
# @type Protocol: Integer
|
2968
|
-
# @param InstanceType:
|
3164
|
+
# @param InstanceType: 实例类型。
|
3165
|
+
# - 0:所有实例。
|
3166
|
+
# - 1:正式实例。
|
3167
|
+
# - 2:临时实例
|
3168
|
+
# - 3:只读实例。
|
3169
|
+
# - -1:同时包括正式实例、只读实例与灾备实例。
|
2969
3170
|
# @type InstanceType: Integer
|
2970
|
-
# @param InstanceStatusDesc:
|
3171
|
+
# @param InstanceStatusDesc: 实例状态描述。
|
2971
3172
|
# @type InstanceStatusDesc: String
|
2972
|
-
# @param RealInstanceId: 实例对应的物理实例
|
3173
|
+
# @param RealInstanceId: 实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId 和 RealInstanceId,从 barad 获取监控数据等场景下需要用物理 ID 获取。
|
2973
3174
|
# @type RealInstanceId: String
|
2974
3175
|
# @param ZoneList: 实例当前可用区信息。
|
2975
3176
|
# @type ZoneList: Array
|
2976
|
-
# @param MongosNodeNum: mongos节点个数。
|
3177
|
+
# @param MongosNodeNum: mongos 节点个数。
|
2977
3178
|
# @type MongosNodeNum: Integer
|
2978
|
-
# @param MongosMemory: mongos
|
3179
|
+
# @param MongosMemory: mongos 节点内存。单位:MB。
|
2979
3180
|
# @type MongosMemory: Integer
|
2980
|
-
# @param MongosCpuNum: mongos节点CPU核数。
|
3181
|
+
# @param MongosCpuNum: mongos 节点 CPU 核数。
|
2981
3182
|
# @type MongosCpuNum: Integer
|
2982
3183
|
# @param ConfigServerNodeNum: Config Server节点个数。
|
2983
3184
|
# @type ConfigServerNodeNum: Integer
|
2984
|
-
# @param ConfigServerMemory: Config Server
|
3185
|
+
# @param ConfigServerMemory: Config Server节点内存。单位:MB。
|
2985
3186
|
# @type ConfigServerMemory: Integer
|
2986
|
-
# @param ConfigServerVolume: Config Server
|
3187
|
+
# @param ConfigServerVolume: Config Server节点磁盘大小。单位:MB。
|
2987
3188
|
# @type ConfigServerVolume: Integer
|
2988
|
-
# @param ConfigServerCpuNum: Config Server节点CPU核数。
|
3189
|
+
# @param ConfigServerCpuNum: Config Server 节点 CPU 核数。
|
2989
3190
|
# @type ConfigServerCpuNum: Integer
|
2990
3191
|
# @param ReadonlyNodeNum: readonly节点个数。
|
2991
3192
|
# @type ReadonlyNodeNum: Integer
|
@@ -3331,7 +3532,7 @@ module TencentCloud
|
|
3331
3532
|
|
3332
3533
|
# IsolateDBInstance请求参数结构体
|
3333
3534
|
class IsolateDBInstanceRequest < TencentCloud::Common::AbstractModel
|
3334
|
-
# @param InstanceId: 实例ID
|
3535
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID。
|
3335
3536
|
# @type InstanceId: String
|
3336
3537
|
|
3337
3538
|
attr_accessor :InstanceId
|
@@ -3374,6 +3575,8 @@ module TencentCloud
|
|
3374
3575
|
# @param CreateTime: 实例与密钥绑定时间。
|
3375
3576
|
# @type CreateTime: String
|
3376
3577
|
# @param Status: 密钥状态。
|
3578
|
+
# - Enabled:开启。
|
3579
|
+
# - Disabled:不开启。
|
3377
3580
|
# @type Status: String
|
3378
3581
|
# @param KeyUsage: 密钥用途。
|
3379
3582
|
# @type KeyUsage: String
|
@@ -3407,9 +3610,9 @@ module TencentCloud
|
|
3407
3610
|
|
3408
3611
|
# KillOps请求参数结构体
|
3409
3612
|
class KillOpsRequest < TencentCloud::Common::AbstractModel
|
3410
|
-
# @param InstanceId: 实例ID
|
3613
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
3411
3614
|
# @type InstanceId: String
|
3412
|
-
# @param Operations:
|
3615
|
+
# @param Operations: 待终止的操作。
|
3413
3616
|
# @type Operations: Array
|
3414
3617
|
|
3415
3618
|
attr_accessor :InstanceId, :Operations
|
@@ -3511,7 +3714,7 @@ module TencentCloud
|
|
3511
3714
|
|
3512
3715
|
# ModifyDBInstanceParamTpl请求参数结构体
|
3513
3716
|
class ModifyDBInstanceParamTplRequest < TencentCloud::Common::AbstractModel
|
3514
|
-
# @param TplId: 待修改的参数模板 ID
|
3717
|
+
# @param TplId: 待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
3515
3718
|
# @type TplId: String
|
3516
3719
|
# @param TplName: 待修改参数模板名称,为空时,保持原有名称。
|
3517
3720
|
# @type TplName: String
|
@@ -3599,11 +3802,12 @@ module TencentCloud
|
|
3599
3802
|
|
3600
3803
|
# ModifyDBInstanceSpec请求参数结构体
|
3601
3804
|
class ModifyDBInstanceSpecRequest < TencentCloud::Common::AbstractModel
|
3602
|
-
# @param InstanceId: 实例 ID
|
3805
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
3603
3806
|
# @type InstanceId: String
|
3604
|
-
# @param Memory:
|
3807
|
+
# @param Memory: 实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
|
3808
|
+
# **注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
|
3605
3809
|
# @type Memory: Integer
|
3606
|
-
# @param Volume: 实例配置变更后的硬盘大小,单位:GB
|
3810
|
+
# @param Volume: 实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
|
3607
3811
|
# - 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
|
3608
3812
|
# - 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。
|
3609
3813
|
# @type Volume: Integer
|
@@ -3613,26 +3817,26 @@ module TencentCloud
|
|
3613
3817
|
# - 单位:GB。
|
3614
3818
|
# - 默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。
|
3615
3819
|
# @type OplogSize: Integer
|
3616
|
-
# @param NodeNum: 实例变更后mongod的节点数(不包含readonly
|
3617
|
-
# -
|
3618
|
-
# -
|
3619
|
-
#
|
3620
|
-
# - 副本集节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。
|
3621
|
-
# - 分片集群每个分片节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [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)节点数量。
|
3622
3824
|
# @type NodeNum: Integer
|
3623
3825
|
# @param ReplicateSetNum: 实例变更后的分片数。
|
3624
|
-
# -
|
3826
|
+
# - 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。
|
3827
|
+
# - 实例分片数量只允许增加不允许减少。
|
3625
3828
|
# @type ReplicateSetNum: Integer
|
3626
3829
|
# @param InMaintenance: 实例配置变更的切换时间。
|
3627
3830
|
# - 0:调整完成时,立即执行变配任务。默认为0。
|
3628
3831
|
# - 1:在维护时间窗内,执行变配任务。
|
3629
3832
|
# **说明**:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。
|
3630
3833
|
# @type InMaintenance: Integer
|
3631
|
-
# @param MongosMemory: 分片实例配置变更后的mongos内存大小。单位:GB。
|
3834
|
+
# @param MongosMemory: 分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
|
3632
3835
|
# @type MongosMemory: String
|
3633
3836
|
# @param AddNodeList: 新增节点列表,节点类型及可用区信息。
|
3634
3837
|
# @type AddNodeList: Array
|
3635
|
-
# @param RemoveNodeList:
|
3838
|
+
# @param RemoveNodeList: 删除节点列表。
|
3839
|
+
# **注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
|
3636
3840
|
# @type RemoveNodeList: Array
|
3637
3841
|
|
3638
3842
|
attr_accessor :InstanceId, :Memory, :Volume, :OplogSize, :NodeNum, :ReplicateSetNum, :InMaintenance, :MongosMemory, :AddNodeList, :RemoveNodeList
|
@@ -3810,21 +4014,38 @@ module TencentCloud
|
|
3810
4014
|
# @type Address: String
|
3811
4015
|
# @param WanServiceAddress: 节点公网访问外网地址(IP或域名,示例为IP方式)。
|
3812
4016
|
# @type WanServiceAddress: String
|
3813
|
-
# @param Role:
|
4017
|
+
# @param Role: 节点角色。
|
4018
|
+
# - PRIMARY:主节点。
|
4019
|
+
# - SECONDARY:从节点。
|
4020
|
+
# - READONLY:只读节点。
|
4021
|
+
# - ARBITER:仲裁节点。
|
3814
4022
|
# @type Role: String
|
3815
|
-
# @param Hidden:
|
4023
|
+
# @param Hidden: 节点是否为 Hidden 节点。
|
4024
|
+
# - true:Hidden 节点。
|
4025
|
+
# - false:非 Hidden 节点。
|
3816
4026
|
# @type Hidden: Boolean
|
3817
|
-
# @param Status:
|
4027
|
+
# @param Status: 节点状态。
|
4028
|
+
# - NORMAL:正常运行中。
|
4029
|
+
# - STARTUP:正在启动。
|
4030
|
+
# - STARTUP2:正在启动,处理中间数据。
|
4031
|
+
# - RECOVERING:恢复中,暂不可用。
|
4032
|
+
# - DOWN:已掉线。
|
4033
|
+
# - UNKNOWN:未知状态。
|
4034
|
+
# - ROLLBACK:回滚中。
|
4035
|
+
# - REMOVED:已移除。
|
3818
4036
|
# @type Status: String
|
3819
|
-
# @param SlaveDelay:
|
4037
|
+
# @param SlaveDelay: 主从同步延迟时间,单位:秒。
|
3820
4038
|
# @type SlaveDelay: Integer
|
3821
|
-
# @param Priority:
|
4039
|
+
# @param Priority: 节点优先级。其取值范围为[0,100],数值越高,优先级越高。
|
3822
4040
|
# @type Priority: Integer
|
3823
4041
|
# @param Votes: 节点投票权。
|
4042
|
+
# - 1:具有投票权。
|
4043
|
+
# - 0:无投票权。
|
3824
4044
|
# @type Votes: Integer
|
3825
4045
|
# @param Tags: 节点标签。
|
4046
|
+
# 注意:此字段可能返回 null,表示取不到有效值。
|
3826
4047
|
# @type Tags: Array
|
3827
|
-
# @param ReplicateSetId: 副本集
|
4048
|
+
# @param ReplicateSetId: 副本集 ID。
|
3828
4049
|
# @type ReplicateSetId: String
|
3829
4050
|
|
3830
4051
|
attr_accessor :Zone, :NodeName, :Address, :WanServiceAddress, :Role, :Hidden, :Status, :SlaveDelay, :Priority, :Votes, :Tags, :ReplicateSetId
|
@@ -3889,7 +4110,7 @@ module TencentCloud
|
|
3889
4110
|
|
3890
4111
|
# OfflineIsolatedDBInstance请求参数结构体
|
3891
4112
|
class OfflineIsolatedDBInstanceRequest < TencentCloud::Common::AbstractModel
|
3892
|
-
# @param InstanceId: 实例ID
|
4113
|
+
# @param InstanceId: 实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID。
|
3893
4114
|
# @type InstanceId: String
|
3894
4115
|
|
3895
4116
|
attr_accessor :InstanceId
|
@@ -3923,13 +4144,13 @@ module TencentCloud
|
|
3923
4144
|
end
|
3924
4145
|
end
|
3925
4146
|
|
3926
|
-
#
|
4147
|
+
# 需要终止的操作。
|
3927
4148
|
class Operation < TencentCloud::Common::AbstractModel
|
3928
|
-
# @param ReplicaSetName:
|
4149
|
+
# @param ReplicaSetName: 操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。
|
3929
4150
|
# @type ReplicaSetName: String
|
3930
|
-
# @param NodeName:
|
4151
|
+
# @param NodeName: 操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。
|
3931
4152
|
# @type NodeName: String
|
3932
|
-
# @param OpId:
|
4153
|
+
# @param OpId: 操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。
|
3933
4154
|
# @type OpId: Integer
|
3934
4155
|
|
3935
4156
|
attr_accessor :ReplicaSetName, :NodeName, :OpId
|
@@ -3949,17 +4170,29 @@ module TencentCloud
|
|
3949
4170
|
|
3950
4171
|
# 数据库参数模板
|
3951
4172
|
class ParamTpl < TencentCloud::Common::AbstractModel
|
3952
|
-
# @param TplName:
|
4173
|
+
# @param TplName: 参数模板名称。
|
3953
4174
|
# @type TplName: String
|
3954
|
-
# @param TplId: 参数模板ID
|
4175
|
+
# @param TplId: 参数模板 ID。
|
3955
4176
|
# @type TplId: String
|
3956
|
-
# @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存储引擎版本。
|
3957
4185
|
# @type MongoVersion: String
|
3958
|
-
# @param ClusterType:
|
4186
|
+
# @param ClusterType: 参数模板适用的数据库类型。
|
4187
|
+
# - REPLSET:副本集实例。
|
4188
|
+
# - SHARD:分片实例。
|
4189
|
+
# - STANDALONE:单节点实例。
|
3959
4190
|
# @type ClusterType: String
|
3960
|
-
# @param TplDesc:
|
4191
|
+
# @param TplDesc: 参数模板描述。
|
3961
4192
|
# @type TplDesc: String
|
3962
|
-
# @param TplType:
|
4193
|
+
# @param TplType: 模板类型。
|
4194
|
+
# - DEFAULT:系统默认模板。
|
4195
|
+
# - CUSTOMIZE:自定义模板。
|
3963
4196
|
# @type TplType: String
|
3964
4197
|
|
3965
4198
|
attr_accessor :TplName, :TplId, :MongoVersion, :ClusterType, :TplDesc, :TplType
|
@@ -4003,19 +4236,18 @@ module TencentCloud
|
|
4003
4236
|
end
|
4004
4237
|
end
|
4005
4238
|
|
4006
|
-
#
|
4239
|
+
# 修改实例节点详情。
|
4007
4240
|
class RemoveNodeList < TencentCloud::Common::AbstractModel
|
4008
4241
|
# @param Role: 需要删除的节点角色。
|
4009
4242
|
# - SECONDARY:Mongod 从节点。
|
4010
4243
|
# - READONLY:只读节点。
|
4011
4244
|
# - MONGOS:Mongos 节点。
|
4012
4245
|
# @type Role: String
|
4013
|
-
# @param NodeName: 要删除的节点 ID
|
4014
|
-
|
4015
|
-
# -
|
4016
|
-
# - 特别说明:分片集群同一节点上的分片,仅需指定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。
|
4017
4249
|
# @type NodeName: String
|
4018
|
-
# @param Zone:
|
4250
|
+
# @param Zone: 节点所对应的可用区。当前支持可用区信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
|
4019
4251
|
# - 单可用区,所有节点在同一可用区。
|
4020
4252
|
# - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。
|
4021
4253
|
# @type Zone: String
|
@@ -4074,7 +4306,7 @@ module TencentCloud
|
|
4074
4306
|
# RenewDBInstances请求参数结构体
|
4075
4307
|
class RenewDBInstancesRequest < TencentCloud::Common::AbstractModel
|
4076
4308
|
# @param InstanceIds: 指定续费的一个或多个待操作的实例ID。
|
4077
|
-
# - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**
|
4309
|
+
# - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。
|
4078
4310
|
# - 每次续费请求的实例数量上限为100。
|
4079
4311
|
# @type InstanceIds: Array
|
4080
4312
|
# @param InstanceChargePrepaid: 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。
|
@@ -4112,9 +4344,9 @@ module TencentCloud
|
|
4112
4344
|
end
|
4113
4345
|
end
|
4114
4346
|
|
4115
|
-
#
|
4347
|
+
# 分片信息。
|
4116
4348
|
class ReplicaSetInfo < TencentCloud::Common::AbstractModel
|
4117
|
-
# @param ReplicaSetId: 副本集ID
|
4349
|
+
# @param ReplicaSetId: 副本集 ID。
|
4118
4350
|
# @type ReplicaSetId: String
|
4119
4351
|
|
4120
4352
|
attr_accessor :ReplicaSetId
|
@@ -4199,9 +4431,11 @@ module TencentCloud
|
|
4199
4431
|
|
4200
4432
|
# RestartNodes请求参数结构体
|
4201
4433
|
class RestartNodesRequest < TencentCloud::Common::AbstractModel
|
4202
|
-
# @param InstanceId: 实例ID
|
4434
|
+
# @param InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
4203
4435
|
# @type InstanceId: String
|
4204
|
-
# @param NodeIds:
|
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)接口获取。
|
4205
4439
|
# @type NodeIds: Array
|
4206
4440
|
|
4207
4441
|
attr_accessor :InstanceId, :NodeIds
|
@@ -4219,7 +4453,7 @@ module TencentCloud
|
|
4219
4453
|
|
4220
4454
|
# RestartNodes返回参数结构体
|
4221
4455
|
class RestartNodesResponse < TencentCloud::Common::AbstractModel
|
4222
|
-
# @param FlowId: 流程
|
4456
|
+
# @param FlowId: 流程 ID。
|
4223
4457
|
# @type FlowId: Integer
|
4224
4458
|
# @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
4225
4459
|
# @type RequestId: String
|
@@ -4239,19 +4473,19 @@ module TencentCloud
|
|
4239
4473
|
|
4240
4474
|
# 安全组信息
|
4241
4475
|
class SecurityGroup < TencentCloud::Common::AbstractModel
|
4242
|
-
# @param ProjectId: 所属项目
|
4476
|
+
# @param ProjectId: 所属项目 ID。
|
4243
4477
|
# @type ProjectId: Integer
|
4244
|
-
# @param CreateTime:
|
4478
|
+
# @param CreateTime: 安全组创建时间。
|
4245
4479
|
# @type CreateTime: String
|
4246
|
-
# @param Inbound:
|
4480
|
+
# @param Inbound: 安全组入站规则。
|
4247
4481
|
# @type Inbound: Array
|
4248
|
-
# @param Outbound:
|
4482
|
+
# @param Outbound: 安全组出站规则。
|
4249
4483
|
# @type Outbound: Array
|
4250
|
-
# @param SecurityGroupId: 安全组
|
4484
|
+
# @param SecurityGroupId: 安全组 ID。
|
4251
4485
|
# @type SecurityGroupId: String
|
4252
|
-
# @param SecurityGroupName:
|
4486
|
+
# @param SecurityGroupName: 安全组名称。
|
4253
4487
|
# @type SecurityGroupName: String
|
4254
|
-
# @param SecurityGroupRemark:
|
4488
|
+
# @param SecurityGroupRemark: 安全组备注信息。
|
4255
4489
|
# @type SecurityGroupRemark: String
|
4256
4490
|
|
4257
4491
|
attr_accessor :ProjectId, :CreateTime, :Inbound, :Outbound, :SecurityGroupId, :SecurityGroupName, :SecurityGroupRemark
|
@@ -4293,21 +4527,23 @@ module TencentCloud
|
|
4293
4527
|
|
4294
4528
|
# 安全组规则
|
4295
4529
|
class SecurityGroupBound < TencentCloud::Common::AbstractModel
|
4296
|
-
# @param Action:
|
4530
|
+
# @param Action: 执行策略。
|
4531
|
+
# - ACCEPT:允许,放行该端口相应的访问请求。
|
4532
|
+
# - DROP:拒绝,直接丢弃数据包,不返回任何回应信息。
|
4297
4533
|
# @type Action: String
|
4298
|
-
# @param CidrIp:
|
4534
|
+
# @param CidrIp: 访问数据库的入站 IP 或 IP 段。
|
4299
4535
|
# @type CidrIp: String
|
4300
|
-
# @param PortRange:
|
4536
|
+
# @param PortRange: 访问数据库的端口。
|
4301
4537
|
# @type PortRange: String
|
4302
|
-
# @param IpProtocol:
|
4538
|
+
# @param IpProtocol: 传输层协议:tcp。
|
4303
4539
|
# @type IpProtocol: String
|
4304
|
-
# @param Id: 安全组
|
4540
|
+
# @param Id: 安全组 ID。
|
4305
4541
|
# @type Id: String
|
4306
|
-
# @param AddressModule:
|
4542
|
+
# @param AddressModule: IP 地址或 IP 地址组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/ip)获取参数模板 IP 地址详情。
|
4307
4543
|
# @type AddressModule: String
|
4308
|
-
# @param ServiceModule:
|
4544
|
+
# @param ServiceModule: 协议端口或协议端口组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/protoport)获取参数模板协议端口详情。
|
4309
4545
|
# @type ServiceModule: String
|
4310
|
-
# @param Desc:
|
4546
|
+
# @param Desc: 安全组描述信息。
|
4311
4547
|
# @type Desc: String
|
4312
4548
|
|
4313
4549
|
attr_accessor :Action, :CidrIp, :PortRange, :IpProtocol, :Id, :AddressModule, :ServiceModule, :Desc
|
@@ -4390,7 +4626,13 @@ module TencentCloud
|
|
4390
4626
|
class SetBackupRulesRequest < TencentCloud::Common::AbstractModel
|
4391
4627
|
# @param InstanceId: 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
4392
4628
|
# @type InstanceId: String
|
4393
|
-
# @param BackupMethod:
|
4629
|
+
# @param BackupMethod: 备份方式。
|
4630
|
+
# - 0:逻辑备份。
|
4631
|
+
# - 1:物理备份。
|
4632
|
+
# - 3:快照备份。
|
4633
|
+
# **说明**:
|
4634
|
+
# 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
4635
|
+
# 2. 实例开通存储加密,则备份方式不能为物理备份。
|
4394
4636
|
# @type BackupMethod: Integer
|
4395
4637
|
# @param BackupTime: 设置自动备份开始时间。取值范围为:[0,23],例如:该参数设置为2,表示02:00开始备份。
|
4396
4638
|
# @type BackupTime: Integer
|
@@ -4560,11 +4802,11 @@ module TencentCloud
|
|
4560
4802
|
|
4561
4803
|
# 慢日志详情
|
4562
4804
|
class SlowLogItem < TencentCloud::Common::AbstractModel
|
4563
|
-
# @param Log:
|
4805
|
+
# @param Log: 慢日志详情。
|
4564
4806
|
# @type Log: String
|
4565
|
-
# @param NodeName:
|
4807
|
+
# @param NodeName: 节点名称。
|
4566
4808
|
# @type NodeName: String
|
4567
|
-
# @param QueryHash:
|
4809
|
+
# @param QueryHash: 查询哈希值。
|
4568
4810
|
# @type QueryHash: String
|
4569
4811
|
|
4570
4812
|
attr_accessor :Log, :NodeName, :QueryHash
|
@@ -4584,15 +4826,15 @@ module TencentCloud
|
|
4584
4826
|
|
4585
4827
|
# 用于描述MongoDB数据库慢日志统计信息
|
4586
4828
|
class SlowLogPattern < TencentCloud::Common::AbstractModel
|
4587
|
-
# @param Pattern:
|
4829
|
+
# @param Pattern: 慢日志输出格式:库名.表名.命令。
|
4588
4830
|
# @type Pattern: String
|
4589
|
-
# @param QueryHash: queryHash
|
4831
|
+
# @param QueryHash: 记录慢日志时所带的queryHash 值,标识一类查询。
|
4590
4832
|
# @type QueryHash: String
|
4591
|
-
# @param MaxTime:
|
4833
|
+
# @param MaxTime: 最大执行时间。单位:毫秒。
|
4592
4834
|
# @type MaxTime: Integer
|
4593
|
-
# @param AverageTime:
|
4835
|
+
# @param AverageTime: 平均执行时间。单位:毫秒。
|
4594
4836
|
# @type AverageTime: Integer
|
4595
|
-
# @param Total:
|
4837
|
+
# @param Total: 慢日志条数。
|
4596
4838
|
# @type Total: Integer
|
4597
4839
|
|
4598
4840
|
attr_accessor :Pattern, :QueryHash, :MaxTime, :AverageTime, :Total
|
@@ -4614,19 +4856,12 @@ module TencentCloud
|
|
4614
4856
|
end
|
4615
4857
|
end
|
4616
4858
|
|
4617
|
-
# mongodb
|
4859
|
+
# mongodb售卖规格。
|
4618
4860
|
class SpecItem < TencentCloud::Common::AbstractModel
|
4619
4861
|
# @param SpecCode: 规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。
|
4620
|
-
# -
|
4621
|
-
#
|
4622
|
-
#
|
4623
|
-
# - cfgstr:Configserver 节点。
|
4624
|
-
# - 规格类型,如下所示。
|
4625
|
-
# - HIO10G:通用高HIO万兆型。
|
4626
|
-
# - HCD:云盘版类型。
|
4627
|
-
# - 内存规格,如下所示:
|
4628
|
-
# - 支持4、8、16、32、64、128、240、512。
|
4629
|
-
# - 单位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。
|
4630
4865
|
# @type SpecCode: String
|
4631
4866
|
# @param Status: 售卖规格有效标志,取值范围如下:
|
4632
4867
|
# - 0:停止售卖,
|
@@ -4647,16 +4882,16 @@ module TencentCloud
|
|
4647
4882
|
# @param Conns: 规格所支持的最大连接数限制。
|
4648
4883
|
# @type Conns: Integer
|
4649
4884
|
# @param MongoVersionCode: 实例存储引擎版本信息。
|
4650
|
-
# - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
4651
4885
|
# - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
4652
4886
|
# - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
4653
4887
|
# - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
4654
4888
|
# - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
4655
4889
|
# - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
4890
|
+
# - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
4656
4891
|
# @type MongoVersionCode: String
|
4657
4892
|
# @param MongoVersionValue: 实例版本对应的数字版本。
|
4658
4893
|
# @type MongoVersionValue: Integer
|
4659
|
-
# @param Version: 实例版本信息。支持:
|
4894
|
+
# @param Version: 实例版本信息。支持:4.2、4.4、5.0、6.0、7.0。
|
4660
4895
|
# @type Version: String
|
4661
4896
|
# @param EngineName: 存储引擎。
|
4662
4897
|
# @type EngineName: String
|
@@ -4732,15 +4967,17 @@ module TencentCloud
|
|
4732
4967
|
end
|
4733
4968
|
end
|
4734
4969
|
|
4735
|
-
#
|
4970
|
+
# 实例规格信息。
|
4736
4971
|
class SpecificationInfo < TencentCloud::Common::AbstractModel
|
4737
|
-
# @param Region:
|
4972
|
+
# @param Region: 地域信息。
|
4738
4973
|
# @type Region: String
|
4739
|
-
# @param Zone:
|
4974
|
+
# @param Zone: 可用区信息。
|
4740
4975
|
# @type Zone: String
|
4741
|
-
# @param SpecItems:
|
4976
|
+
# @param SpecItems: 售卖规格信息。
|
4742
4977
|
# @type SpecItems: Array
|
4743
|
-
# @param SupportMultiAZ:
|
4978
|
+
# @param SupportMultiAZ: 是否支持跨可用区部署。
|
4979
|
+
# - 1:支持。
|
4980
|
+
# - 0:不支持。
|
4744
4981
|
# @type SupportMultiAZ: Integer
|
4745
4982
|
|
4746
4983
|
attr_accessor :Region, :Zone, :SpecItems, :SupportMultiAZ
|