tencentcloud-sdk-nodejs 4.1.124 → 4.1.125
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.
- package/es/common/sdk_version.js +1 -1
- package/es/services/cdb/v20170320/cdb_client.js +3 -0
- package/es/services/dbbrain/v20210527/dbbrain_client.js +7 -4
- package/es/services/teo/v20220901/teo_client.js +9 -0
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +12 -0
- package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +5 -1
- package/tencentcloud/services/cdb/v20170320/cdb_client.js +6 -0
- package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +89 -59
- package/tencentcloud/services/cdwpg/v20201230/cdwpg_models.d.ts +4 -0
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +3 -3
- package/tencentcloud/services/dbbrain/v20191016/dbbrain_models.d.ts +66 -41
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +9 -5
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +12 -6
- package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +281 -153
- package/tencentcloud/services/dts/v20180330/dts_client.d.ts +1 -2
- package/tencentcloud/services/dts/v20180330/dts_client.js +1 -2
- package/tencentcloud/services/dts/v20180330/dts_models.d.ts +4 -2
- package/tencentcloud/services/dts/v20211206/dts_client.d.ts +6 -6
- package/tencentcloud/services/dts/v20211206/dts_client.js +6 -6
- package/tencentcloud/services/dts/v20211206/dts_models.d.ts +68 -47
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +56 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +1 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +99 -48
- package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +4 -0
- package/tencentcloud/services/lke/v20231130/lke_models.d.ts +80 -24
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +8 -8
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +8 -8
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +513 -281
- package/tencentcloud/services/redis/v20180412/redis_models.d.ts +12 -8
- package/tencentcloud/services/rum/v20210622/rum_models.d.ts +1 -1
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +13 -1
- package/tencentcloud/services/teo/v20220901/teo_client.js +18 -0
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +465 -296
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +13 -4
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +8 -0
@@ -3,7 +3,7 @@
|
|
3
3
|
*/
|
4
4
|
export interface DescribeSpecInfoRequest {
|
5
5
|
/**
|
6
|
-
*
|
6
|
+
* 待查询可用区。当前支持的可用区,请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。
|
7
7
|
*/
|
8
8
|
Zone?: string;
|
9
9
|
}
|
@@ -26,16 +26,16 @@ export interface CreateDBInstanceRequest {
|
|
26
26
|
Volume: number;
|
27
27
|
/**
|
28
28
|
* 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
29
|
-
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
30
29
|
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
31
30
|
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
32
31
|
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
33
32
|
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
34
33
|
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
34
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
35
35
|
*/
|
36
36
|
MongoVersion: string;
|
37
37
|
/**
|
38
|
-
* 实例数量, 最小值1,最大值为
|
38
|
+
* 实例数量, 最小值1,最大值为30。
|
39
39
|
*/
|
40
40
|
GoodsNum: number;
|
41
41
|
/**
|
@@ -46,7 +46,6 @@ export interface CreateDBInstanceRequest {
|
|
46
46
|
Zone: string;
|
47
47
|
/**
|
48
48
|
* 指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。
|
49
|
-
|
50
49
|
*/
|
51
50
|
Period: number;
|
52
51
|
/**
|
@@ -73,11 +72,15 @@ export interface CreateDBInstanceRequest {
|
|
73
72
|
*/
|
74
73
|
ProjectId?: number;
|
75
74
|
/**
|
76
|
-
* 私有网络ID
|
75
|
+
* 私有网络 ID。
|
76
|
+
- 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
|
77
|
+
- 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
77
78
|
*/
|
78
79
|
VpcId?: string;
|
79
80
|
/**
|
80
|
-
* 私有网络VPC
|
81
|
+
* 私有网络 VPC 的子网 ID。
|
82
|
+
- 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
|
83
|
+
- 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
81
84
|
*/
|
82
85
|
SubnetId?: string;
|
83
86
|
/**
|
@@ -105,15 +108,21 @@ export interface CreateDBInstanceRequest {
|
|
105
108
|
*/
|
106
109
|
AutoVoucher?: number;
|
107
110
|
/**
|
108
|
-
*
|
111
|
+
* 实例类型。
|
112
|
+
- 1:正式实例。
|
113
|
+
- 3:只读实例。
|
114
|
+
- 4:灾备实例。
|
115
|
+
- 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
|
109
116
|
*/
|
110
117
|
Clone?: number;
|
111
118
|
/**
|
112
|
-
* 父实例 ID
|
119
|
+
* 父实例 ID。
|
120
|
+
- 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
|
121
|
+
- 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
|
113
122
|
*/
|
114
123
|
Father?: string;
|
115
124
|
/**
|
116
|
-
* 安全组 ID。
|
125
|
+
* 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
|
117
126
|
*/
|
118
127
|
SecurityGroup?: Array<string>;
|
119
128
|
/**
|
@@ -121,7 +130,10 @@ export interface CreateDBInstanceRequest {
|
|
121
130
|
*/
|
122
131
|
RestoreTime?: string;
|
123
132
|
/**
|
124
|
-
* 实例名称。仅支持长度为
|
133
|
+
* 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
|
134
|
+
- 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
|
135
|
+
- 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
|
136
|
+
- 复合模式串:前缀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.
|
125
137
|
*/
|
126
138
|
InstanceName?: string;
|
127
139
|
/**
|
@@ -160,7 +172,9 @@ export interface CreateDBInstanceRequest {
|
|
160
172
|
*/
|
161
173
|
HiddenZone?: string;
|
162
174
|
/**
|
163
|
-
* 参数模板 ID
|
175
|
+
* 参数模板 ID。
|
176
|
+
- 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
|
177
|
+
- 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
|
164
178
|
*/
|
165
179
|
ParamTemplateId?: string;
|
166
180
|
}
|
@@ -191,22 +205,28 @@ export interface DescribeAccountUsersRequest {
|
|
191
205
|
*/
|
192
206
|
export interface DescribeDBInstanceParamTplRequest {
|
193
207
|
/**
|
194
|
-
* 参数模板 ID
|
208
|
+
* 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
195
209
|
*/
|
196
210
|
TplIds?: Array<string>;
|
197
211
|
/**
|
198
|
-
*
|
212
|
+
* 指定查询的模板名称。
|
199
213
|
*/
|
200
214
|
TplNames?: Array<string>;
|
201
215
|
/**
|
202
|
-
*
|
203
|
-
- MONGO_36_WT:MongoDB 3.6 WiredTiger
|
204
|
-
- MONGO_40_WT:MongoDB 4.0 WiredTiger
|
216
|
+
* 指定所需查询的参数模板的数据库版本号。具体支持的版本信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
217
|
+
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
|
218
|
+
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
|
205
219
|
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
220
|
+
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
221
|
+
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
222
|
+
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
223
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
206
224
|
*/
|
207
225
|
MongoVersion?: Array<string>;
|
208
226
|
/**
|
209
|
-
*
|
227
|
+
* 指定查询的模板类型。
|
228
|
+
- DEFAULT:系统默认模板。
|
229
|
+
- CUSTOMIZE:自定义模板。
|
210
230
|
*/
|
211
231
|
TplType?: string;
|
212
232
|
}
|
@@ -245,11 +265,11 @@ export interface DBInstancePrice {
|
|
245
265
|
*/
|
246
266
|
export interface KillOpsRequest {
|
247
267
|
/**
|
248
|
-
* 实例ID
|
268
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
249
269
|
*/
|
250
270
|
InstanceId: string;
|
251
271
|
/**
|
252
|
-
*
|
272
|
+
* 待终止的操作。
|
253
273
|
*/
|
254
274
|
Operations: Array<Operation>;
|
255
275
|
}
|
@@ -275,15 +295,19 @@ export interface DescribeDBInstanceNamespaceResponse {
|
|
275
295
|
*/
|
276
296
|
export interface DescribeSlowLogsRequest {
|
277
297
|
/**
|
278
|
-
* 实例ID
|
298
|
+
* 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
279
299
|
*/
|
280
300
|
InstanceId: string;
|
281
301
|
/**
|
282
|
-
*
|
302
|
+
* 慢日志起始时间。
|
303
|
+
- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
|
304
|
+
- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
283
305
|
*/
|
284
306
|
StartTime: string;
|
285
307
|
/**
|
286
|
-
*
|
308
|
+
* 慢日志终止时间。
|
309
|
+
- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
|
310
|
+
- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
287
311
|
*/
|
288
312
|
EndTime: string;
|
289
313
|
/**
|
@@ -453,23 +477,23 @@ export interface DescribeDBInstanceNamespaceRequest {
|
|
453
477
|
*/
|
454
478
|
export interface SlowLogPattern {
|
455
479
|
/**
|
456
|
-
*
|
480
|
+
* 慢日志输出格式:库名.表名.命令。
|
457
481
|
*/
|
458
482
|
Pattern?: string;
|
459
483
|
/**
|
460
|
-
* queryHash
|
484
|
+
* 记录慢日志时所带的queryHash 值,标识一类查询。
|
461
485
|
*/
|
462
486
|
QueryHash?: string;
|
463
487
|
/**
|
464
|
-
*
|
488
|
+
* 最大执行时间。单位:毫秒。
|
465
489
|
*/
|
466
490
|
MaxTime?: number;
|
467
491
|
/**
|
468
|
-
*
|
492
|
+
* 平均执行时间。单位:毫秒。
|
469
493
|
*/
|
470
494
|
AverageTime?: number;
|
471
495
|
/**
|
472
|
-
*
|
496
|
+
* 慢日志条数。
|
473
497
|
*/
|
474
498
|
Total?: number;
|
475
499
|
}
|
@@ -491,23 +515,36 @@ export interface AssignProjectResponse {
|
|
491
515
|
*/
|
492
516
|
export interface DescribeDBInstanceDealResponse {
|
493
517
|
/**
|
494
|
-
*
|
518
|
+
* 订单状态。
|
519
|
+
- 1:未支付。
|
520
|
+
- 2:已支付。
|
521
|
+
- 3:发货中。
|
522
|
+
- 4:发货成功。
|
523
|
+
- 5:发货失败。
|
524
|
+
- 6:退款。
|
525
|
+
- 7:订单关闭。
|
526
|
+
- 8:超时未支付关闭。
|
495
527
|
*/
|
496
528
|
Status?: number;
|
497
529
|
/**
|
498
|
-
*
|
530
|
+
* 订单原价。单位:元。
|
499
531
|
*/
|
500
532
|
OriginalPrice?: number;
|
501
533
|
/**
|
502
|
-
*
|
534
|
+
* 订单折扣价格。单位:元。
|
503
535
|
*/
|
504
536
|
DiscountPrice?: number;
|
505
537
|
/**
|
506
|
-
*
|
538
|
+
* 订单操作行为。
|
539
|
+
- purchase:新购。
|
540
|
+
- renew:续费。
|
541
|
+
- upgrade:升配.
|
542
|
+
- downgrade:降配.
|
543
|
+
- refund:退货退款。
|
507
544
|
*/
|
508
545
|
Action?: string;
|
509
546
|
/**
|
510
|
-
*
|
547
|
+
* 当前订单的实例 ID。
|
511
548
|
*/
|
512
549
|
InstanceId?: string;
|
513
550
|
/**
|
@@ -535,7 +572,7 @@ export interface OfflineIsolatedDBInstanceResponse {
|
|
535
572
|
/**
|
536
573
|
* 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
|
537
574
|
*/
|
538
|
-
AsyncRequestId
|
575
|
+
AsyncRequestId?: string;
|
539
576
|
/**
|
540
577
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
541
578
|
*/
|
@@ -563,12 +600,21 @@ export interface CreateDBInstanceParamTplRequest {
|
|
563
600
|
*/
|
564
601
|
TplName: string;
|
565
602
|
/**
|
566
|
-
*
|
603
|
+
* 参数模板版本号。当**MirrorTplId**为空时,该字段必填。参数模板支持的售卖版本,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
|
604
|
+
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
|
605
|
+
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
|
606
|
+
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
607
|
+
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
608
|
+
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
609
|
+
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
610
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
567
611
|
*/
|
568
612
|
MongoVersion?: string;
|
569
613
|
/**
|
570
|
-
*
|
571
|
-
|
614
|
+
* 实例类型。当 MirrorTplId 为空值时,该参数必填。
|
615
|
+
- REPLSET:副本集实例。
|
616
|
+
- SHARD:分片实例。
|
617
|
+
- STANDALONE:单节点实例。
|
572
618
|
*/
|
573
619
|
ClusterType?: string;
|
574
620
|
/**
|
@@ -576,11 +622,12 @@ export interface CreateDBInstanceParamTplRequest {
|
|
576
622
|
*/
|
577
623
|
TplDesc?: string;
|
578
624
|
/**
|
579
|
-
*
|
625
|
+
* 模板参数,若不配置该参数,则以系统默认模板作为新版本参数。
|
580
626
|
*/
|
581
627
|
Params?: Array<ParamType>;
|
582
628
|
/**
|
583
|
-
* 镜像模板ID
|
629
|
+
* 镜像模板 ID。若指定镜像模板,则以该模板为镜像,克隆出一个新的模板。
|
630
|
+
**注意**:MirrorTplId 不为空值时,MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。
|
584
631
|
*/
|
585
632
|
MirrorTplId?: string;
|
586
633
|
}
|
@@ -589,7 +636,7 @@ export interface CreateDBInstanceParamTplRequest {
|
|
589
636
|
*/
|
590
637
|
export interface DescribeSecurityGroupRequest {
|
591
638
|
/**
|
592
|
-
* 实例 ID
|
639
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
593
640
|
*/
|
594
641
|
InstanceId: string;
|
595
642
|
}
|
@@ -620,20 +667,20 @@ export interface DescribeBackupRulesRequest {
|
|
620
667
|
*/
|
621
668
|
export interface DescribeBackupDownloadTaskResponse {
|
622
669
|
/**
|
623
|
-
*
|
670
|
+
* 满足查询条件的所有条数。
|
624
671
|
*/
|
625
|
-
TotalCount
|
672
|
+
TotalCount?: number;
|
626
673
|
/**
|
627
|
-
*
|
674
|
+
* 下载任务列表。
|
628
675
|
*/
|
629
|
-
Tasks
|
676
|
+
Tasks?: Array<BackupDownloadTask>;
|
630
677
|
/**
|
631
678
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
632
679
|
*/
|
633
680
|
RequestId?: string;
|
634
681
|
}
|
635
682
|
/**
|
636
|
-
*
|
683
|
+
* 修改实例节点详情。
|
637
684
|
*/
|
638
685
|
export interface AddNodeList {
|
639
686
|
/**
|
@@ -644,7 +691,7 @@ export interface AddNodeList {
|
|
644
691
|
*/
|
645
692
|
Role: string;
|
646
693
|
/**
|
647
|
-
*
|
694
|
+
* 节点所对应的可用区。当前支持的可用区,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
|
648
695
|
- 单可用区,所有节点在同一可用区。
|
649
696
|
- 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。
|
650
697
|
*/
|
@@ -699,15 +746,15 @@ export interface SetAccountUserPrivilegeResponse {
|
|
699
746
|
RequestId?: string;
|
700
747
|
}
|
701
748
|
/**
|
702
|
-
* 按
|
749
|
+
* 按 Key 闪回的数据库及集合信息
|
703
750
|
*/
|
704
751
|
export interface FlashbackDatabase {
|
705
752
|
/**
|
706
|
-
* 按
|
753
|
+
* 按 Key 闪回目标数据所在库。
|
707
754
|
*/
|
708
755
|
DBName: string;
|
709
756
|
/**
|
710
|
-
* 按
|
757
|
+
* 按 Key 闪回的数据库集合。
|
711
758
|
*/
|
712
759
|
Collections: Array<FlashbackCollection>;
|
713
760
|
}
|
@@ -802,21 +849,14 @@ export interface DeleteAccountUserRequest {
|
|
802
849
|
MongoUserPassword: string;
|
803
850
|
}
|
804
851
|
/**
|
805
|
-
* mongodb
|
852
|
+
* mongodb售卖规格。
|
806
853
|
*/
|
807
854
|
export interface SpecItem {
|
808
855
|
/**
|
809
856
|
* 规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。
|
810
|
-
-
|
811
|
-
|
812
|
-
|
813
|
-
- cfgstr:Configserver 节点。
|
814
|
-
- 规格类型,如下所示。
|
815
|
-
- HIO10G:通用高HIO万兆型。
|
816
|
-
- HCD:云盘版类型。
|
817
|
-
- 内存规格,如下所示:
|
818
|
-
- 支持4、8、16、32、64、128、240、512。
|
819
|
-
- 单位g:表示GB。128g则表示128GB。
|
857
|
+
- 节点类型:**mongo**,指 Mongod 节点;**mongos**,指 Mongos 节点;**cfgstr**,指 Configserver 节点。
|
858
|
+
- 规格类型:**HIO10G**,指通用高HIO万兆型;**HCD**:指云盘版类型。
|
859
|
+
- 内存规格:支持4、8、16、32、64、128、240、512。单位g:表示GB。128g 则表示128GB。
|
820
860
|
*/
|
821
861
|
SpecCode?: string;
|
822
862
|
/**
|
@@ -855,12 +895,12 @@ export interface SpecItem {
|
|
855
895
|
Conns?: number;
|
856
896
|
/**
|
857
897
|
* 实例存储引擎版本信息。
|
858
|
-
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
859
898
|
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
860
899
|
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
861
900
|
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
862
901
|
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
863
902
|
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
903
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
864
904
|
*/
|
865
905
|
MongoVersionCode?: string;
|
866
906
|
/**
|
@@ -868,8 +908,7 @@ export interface SpecItem {
|
|
868
908
|
*/
|
869
909
|
MongoVersionValue?: number;
|
870
910
|
/**
|
871
|
-
* 实例版本信息。支持:
|
872
|
-
|
911
|
+
* 实例版本信息。支持:4.2、4.4、5.0、6.0、7.0。
|
873
912
|
*/
|
874
913
|
Version?: string;
|
875
914
|
/**
|
@@ -918,51 +957,58 @@ export interface SpecItem {
|
|
918
957
|
*/
|
919
958
|
export interface DescribeDetailedSlowLogsRequest {
|
920
959
|
/**
|
921
|
-
* 实例
|
960
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
922
961
|
*/
|
923
962
|
InstanceId: string;
|
924
963
|
/**
|
925
|
-
*
|
964
|
+
* 指定查询慢日志的开始时间。- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
926
965
|
*/
|
927
966
|
StartTime: string;
|
928
967
|
/**
|
929
|
-
*
|
968
|
+
* 指定查询慢日志的结束时间。
|
969
|
+
- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
|
970
|
+
- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
930
971
|
*/
|
931
972
|
EndTime: string;
|
932
973
|
/**
|
933
|
-
*
|
974
|
+
* 指定慢日志查询阈值,即查询执行时间大于此值的慢日志。单位:ms,默认值:100。
|
934
975
|
*/
|
935
976
|
ExecTime?: number;
|
936
977
|
/**
|
937
|
-
*
|
978
|
+
* 指定查询慢日志的命令类型。
|
938
979
|
*/
|
939
980
|
Commands?: Array<string>;
|
940
981
|
/**
|
941
|
-
*
|
982
|
+
* 全文搜索关键字,多个关键字间为或关系。
|
942
983
|
*/
|
943
984
|
Texts?: Array<string>;
|
944
985
|
/**
|
945
|
-
*
|
986
|
+
* 指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。
|
946
987
|
*/
|
947
988
|
NodeNames?: Array<string>;
|
948
989
|
/**
|
949
|
-
*
|
990
|
+
* 指定查询 queryHash 值。
|
950
991
|
*/
|
951
992
|
QueryHash?: Array<string>;
|
952
993
|
/**
|
953
|
-
*
|
994
|
+
* 分页偏移量。默认值:0。取值范围:[0,100]。
|
995
|
+
|
954
996
|
*/
|
955
997
|
Offset?: number;
|
956
998
|
/**
|
957
|
-
*
|
999
|
+
* 返回条数。默认值:20。取值范围:[0,10000]
|
958
1000
|
*/
|
959
1001
|
Limit?: number;
|
960
1002
|
/**
|
961
|
-
*
|
1003
|
+
* 指定慢日志排序条件。
|
1004
|
+
- StartTime:按照慢日志生成时间排序。
|
1005
|
+
- ExecTime:按照慢日志执行时间排序。
|
962
1006
|
*/
|
963
1007
|
OrderBy?: string;
|
964
1008
|
/**
|
965
|
-
*
|
1009
|
+
* 指定排序方式。
|
1010
|
+
- desc:倒序。
|
1011
|
+
- asc:顺序。
|
966
1012
|
*/
|
967
1013
|
OrderByType?: string;
|
968
1014
|
}
|
@@ -984,7 +1030,7 @@ export interface ModifyDBInstanceNetworkAddressResponse {
|
|
984
1030
|
*/
|
985
1031
|
export interface DropDBInstanceParamTplRequest {
|
986
1032
|
/**
|
987
|
-
* 参数模板 ID。
|
1033
|
+
* 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
988
1034
|
*/
|
989
1035
|
TplId: string;
|
990
1036
|
}
|
@@ -1008,39 +1054,44 @@ export interface DescribeSlowLogPatternsResponse {
|
|
1008
1054
|
/**
|
1009
1055
|
* 慢日志统计信息总数
|
1010
1056
|
*/
|
1011
|
-
Count
|
1057
|
+
Count?: number;
|
1012
1058
|
/**
|
1013
1059
|
* 慢日志统计信息
|
1014
1060
|
*/
|
1015
|
-
SlowLogPatterns
|
1061
|
+
SlowLogPatterns?: Array<SlowLogPattern>;
|
1016
1062
|
/**
|
1017
1063
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
1018
1064
|
*/
|
1019
1065
|
RequestId?: string;
|
1020
1066
|
}
|
1021
1067
|
/**
|
1022
|
-
*
|
1068
|
+
* 创建备份下载任务结果。
|
1023
1069
|
*/
|
1024
1070
|
export interface BackupDownloadTaskStatus {
|
1025
1071
|
/**
|
1026
|
-
*
|
1072
|
+
* 分片名。
|
1027
1073
|
*/
|
1028
|
-
ReplicaSetId
|
1074
|
+
ReplicaSetId?: string;
|
1029
1075
|
/**
|
1030
|
-
* 任务当前状态。
|
1076
|
+
* 任务当前状态。
|
1077
|
+
- 0:等待执行。
|
1078
|
+
- 1:正在下载。
|
1079
|
+
- 2:下载完成。
|
1080
|
+
- 3:下载失败。
|
1081
|
+
- 4:等待重试。
|
1031
1082
|
*/
|
1032
|
-
Status
|
1083
|
+
Status?: number;
|
1033
1084
|
}
|
1034
1085
|
/**
|
1035
1086
|
* DescribeSlowLogs返回参数结构体
|
1036
1087
|
*/
|
1037
1088
|
export interface DescribeSlowLogsResponse {
|
1038
1089
|
/**
|
1039
|
-
*
|
1090
|
+
* 慢日志总数。
|
1040
1091
|
*/
|
1041
1092
|
Count?: number;
|
1042
1093
|
/**
|
1043
|
-
*
|
1094
|
+
* 慢日志详情。
|
1044
1095
|
*/
|
1045
1096
|
SlowLogs?: Array<string>;
|
1046
1097
|
/**
|
@@ -1078,7 +1129,7 @@ export interface InquirePriceModifyDBInstanceSpecRequest {
|
|
1078
1129
|
ReplicateSetNum?: number;
|
1079
1130
|
}
|
1080
1131
|
/**
|
1081
|
-
*
|
1132
|
+
* 备份信息。
|
1082
1133
|
*/
|
1083
1134
|
export interface BackupInfo {
|
1084
1135
|
/**
|
@@ -1086,68 +1137,95 @@ export interface BackupInfo {
|
|
1086
1137
|
*/
|
1087
1138
|
InstanceId?: string;
|
1088
1139
|
/**
|
1089
|
-
*
|
1140
|
+
* 备份方式。
|
1141
|
+
- 0:自动备份。
|
1142
|
+
- 1:手动备份。
|
1090
1143
|
*/
|
1091
1144
|
BackupType?: number;
|
1092
1145
|
/**
|
1093
|
-
*
|
1146
|
+
* 备份文件名称。
|
1094
1147
|
*/
|
1095
1148
|
BackupName?: string;
|
1096
1149
|
/**
|
1097
|
-
*
|
1150
|
+
* 备份任务备注信息。
|
1098
1151
|
*/
|
1099
1152
|
BackupDesc?: string;
|
1100
1153
|
/**
|
1101
|
-
*
|
1154
|
+
* 备份文件大小,单位:KB。
|
1102
1155
|
*/
|
1103
1156
|
BackupSize?: number;
|
1104
1157
|
/**
|
1105
|
-
*
|
1158
|
+
* 备份开始时间。
|
1106
1159
|
*/
|
1107
1160
|
StartTime?: string;
|
1108
1161
|
/**
|
1109
|
-
*
|
1162
|
+
* 备份结束时间。
|
1110
1163
|
*/
|
1111
1164
|
EndTime?: string;
|
1112
1165
|
/**
|
1113
|
-
*
|
1166
|
+
* 备份状态。
|
1167
|
+
- 1:备份中。
|
1168
|
+
- 2:备份成功。
|
1114
1169
|
*/
|
1115
1170
|
Status?: number;
|
1116
1171
|
/**
|
1117
|
-
*
|
1172
|
+
* 备份方式。
|
1173
|
+
- 0:逻辑备份。
|
1174
|
+
- 1:物理备份。
|
1175
|
+
- 3:快照备份。
|
1176
|
+
**说明:**
|
1177
|
+
- 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
1178
|
+
- 实例开通存储加密,则备份方式不能为物理备份。
|
1118
1179
|
*/
|
1119
1180
|
BackupMethod?: number;
|
1120
1181
|
/**
|
1121
|
-
* 备份记录
|
1182
|
+
* 备份记录 ID。
|
1122
1183
|
*/
|
1123
1184
|
BackId?: number;
|
1124
1185
|
/**
|
1125
|
-
*
|
1186
|
+
* 备份删除时间。
|
1126
1187
|
*/
|
1127
1188
|
DeleteTime?: string;
|
1128
1189
|
/**
|
1129
|
-
*
|
1190
|
+
* 异地备份地域。
|
1130
1191
|
*/
|
1131
1192
|
BackupRegion?: string;
|
1193
|
+
/**
|
1194
|
+
* 备份支持的回档时间。
|
1195
|
+
*/
|
1196
|
+
RestoreTime?: string;
|
1132
1197
|
}
|
1133
1198
|
/**
|
1134
1199
|
* DescribeDBInstances请求参数结构体
|
1135
1200
|
*/
|
1136
1201
|
export interface DescribeDBInstancesRequest {
|
1137
1202
|
/**
|
1138
|
-
* 实例 ID
|
1203
|
+
* 实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1139
1204
|
*/
|
1140
1205
|
InstanceIds?: Array<string>;
|
1141
1206
|
/**
|
1142
|
-
*
|
1207
|
+
* 指定查询的实例类型。取值范围如下:
|
1208
|
+
- 0:所有实例。
|
1209
|
+
- 1:正式实例。
|
1210
|
+
- 2:临时实例
|
1211
|
+
- 3:只读实例。
|
1212
|
+
- -1:查询同时包括正式实例、只读实例与灾备实例。
|
1143
1213
|
*/
|
1144
1214
|
InstanceType?: number;
|
1145
1215
|
/**
|
1146
|
-
*
|
1216
|
+
* 指定所查询实例的集群类型,取值范围如下:
|
1217
|
+
- 0:副本集实例。
|
1218
|
+
- 1:分片实例。
|
1219
|
+
- -1:副本集与分片实例。
|
1147
1220
|
*/
|
1148
1221
|
ClusterType?: number;
|
1149
1222
|
/**
|
1150
|
-
*
|
1223
|
+
* 指定所查询实例的当前状态,取值范围如下所示:
|
1224
|
+
- 0:待初始化。
|
1225
|
+
- 1:流程处理中,例如:变更规格、参数修改等。
|
1226
|
+
- 2:实例正常运行中。
|
1227
|
+
- -2:已隔离(包年包月)。
|
1228
|
+
- -3:已隔离(按量计费)。
|
1151
1229
|
*/
|
1152
1230
|
Status?: Array<number | bigint>;
|
1153
1231
|
/**
|
@@ -1163,11 +1241,14 @@ export interface DescribeDBInstancesRequest {
|
|
1163
1241
|
*/
|
1164
1242
|
SubnetId?: string;
|
1165
1243
|
/**
|
1166
|
-
*
|
1244
|
+
* 指定所查询实例的付费类型。
|
1245
|
+
- 0:查询按量计费实例。
|
1246
|
+
- 1:查询包年包月实例。
|
1247
|
+
- -1:查询按量计费与包年包月实例。
|
1167
1248
|
*/
|
1168
1249
|
PayMode?: number;
|
1169
1250
|
/**
|
1170
|
-
* 单次请求返回的数量。默认值为20,取值范围为
|
1251
|
+
* 单次请求返回的数量。默认值为20,取值范围为(1,100]。
|
1171
1252
|
*/
|
1172
1253
|
Limit?: number;
|
1173
1254
|
/**
|
@@ -1214,7 +1295,15 @@ export interface CurrentOp {
|
|
1214
1295
|
*/
|
1215
1296
|
Query?: string;
|
1216
1297
|
/**
|
1217
|
-
*
|
1298
|
+
* 操作类型。
|
1299
|
+
- none:特殊状态,空闲连接或内部任务等。
|
1300
|
+
- update:更新数据。
|
1301
|
+
- insert:插入操作。
|
1302
|
+
- query:查询操作。
|
1303
|
+
- command:命令操作。
|
1304
|
+
- getmore:获取更多数据。
|
1305
|
+
- remove:删除操作。
|
1306
|
+
- killcursors:释放查询游标的操作。
|
1218
1307
|
*/
|
1219
1308
|
Op?: string;
|
1220
1309
|
/**
|
@@ -1230,7 +1319,9 @@ export interface CurrentOp {
|
|
1230
1319
|
*/
|
1231
1320
|
Operation?: string;
|
1232
1321
|
/**
|
1233
|
-
*
|
1322
|
+
* 节点角色。
|
1323
|
+
- primary:主节点。
|
1324
|
+
- secondary:从节点。
|
1234
1325
|
*/
|
1235
1326
|
State?: string;
|
1236
1327
|
/**
|
@@ -1247,16 +1338,16 @@ export interface CurrentOp {
|
|
1247
1338
|
*/
|
1248
1339
|
export interface ModifyDBInstanceSpecRequest {
|
1249
1340
|
/**
|
1250
|
-
* 实例 ID
|
1251
|
-
|
1341
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1252
1342
|
*/
|
1253
1343
|
InstanceId: string;
|
1254
1344
|
/**
|
1255
|
-
*
|
1345
|
+
* 实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
|
1346
|
+
**注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
|
1256
1347
|
*/
|
1257
1348
|
Memory?: number;
|
1258
1349
|
/**
|
1259
|
-
* 实例配置变更后的硬盘大小,单位:GB
|
1350
|
+
* 实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
|
1260
1351
|
- 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
|
1261
1352
|
- 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。
|
1262
1353
|
*/
|
@@ -1271,17 +1362,16 @@ export interface ModifyDBInstanceSpecRequest {
|
|
1271
1362
|
*/
|
1272
1363
|
OplogSize?: number;
|
1273
1364
|
/**
|
1274
|
-
* 实例变更后mongod的节点数(不包含readonly
|
1275
|
-
-
|
1276
|
-
-
|
1277
|
-
|
1278
|
-
- 副本集节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。
|
1279
|
-
- 分片集群每个分片节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。
|
1365
|
+
* 实例变更后 mongod 的节点数(不包含 readonly 只读节点数)。
|
1366
|
+
- 副本集节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。
|
1367
|
+
- 分片集群每个分片节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。
|
1368
|
+
**说明**:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。
|
1280
1369
|
*/
|
1281
1370
|
NodeNum?: number;
|
1282
1371
|
/**
|
1283
1372
|
* 实例变更后的分片数。
|
1284
|
-
-
|
1373
|
+
- 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。
|
1374
|
+
- 实例分片数量只允许增加不允许减少。
|
1285
1375
|
*/
|
1286
1376
|
ReplicateSetNum?: number;
|
1287
1377
|
/**
|
@@ -1292,7 +1382,7 @@ export interface ModifyDBInstanceSpecRequest {
|
|
1292
1382
|
*/
|
1293
1383
|
InMaintenance?: number;
|
1294
1384
|
/**
|
1295
|
-
* 分片实例配置变更后的mongos内存大小。单位:GB。
|
1385
|
+
* 分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
|
1296
1386
|
*/
|
1297
1387
|
MongosMemory?: string;
|
1298
1388
|
/**
|
@@ -1300,7 +1390,8 @@ export interface ModifyDBInstanceSpecRequest {
|
|
1300
1390
|
*/
|
1301
1391
|
AddNodeList?: Array<AddNodeList>;
|
1302
1392
|
/**
|
1303
|
-
*
|
1393
|
+
* 删除节点列表。
|
1394
|
+
**注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
|
1304
1395
|
*/
|
1305
1396
|
RemoveNodeList?: Array<RemoveNodeList>;
|
1306
1397
|
}
|
@@ -1582,56 +1673,65 @@ export interface InquirePriceRenewDBInstancesRequest {
|
|
1582
1673
|
*/
|
1583
1674
|
export interface DescribeBackupDownloadTaskRequest {
|
1584
1675
|
/**
|
1585
|
-
* 实例ID
|
1676
|
+
* 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1586
1677
|
*/
|
1587
1678
|
InstanceId: string;
|
1588
1679
|
/**
|
1589
|
-
*
|
1680
|
+
* 指定备份文件名,用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
|
1590
1681
|
*/
|
1591
1682
|
BackupName?: string;
|
1592
1683
|
/**
|
1593
|
-
* 指定查询时间范围内的任务,StartTime
|
1684
|
+
* 指定查询时间范围内的任务,StartTime 指定开始时间。若不指定开始时间,则默认不限制开始时间。
|
1594
1685
|
*/
|
1595
1686
|
StartTime?: string;
|
1596
1687
|
/**
|
1597
|
-
* 指定查询时间范围内的任务,EndTime
|
1688
|
+
* 指定查询时间范围内的任务,EndTime 指定截止时间。若不指定截止时间,则默认不限制截止时间。
|
1598
1689
|
*/
|
1599
1690
|
EndTime?: string;
|
1600
1691
|
/**
|
1601
|
-
* 此次查询返回的条数,取值范围为1-100,默认为20
|
1692
|
+
* 此次查询返回的条数,取值范围为1-100,默认为20。
|
1602
1693
|
*/
|
1603
1694
|
Limit?: number;
|
1604
1695
|
/**
|
1605
|
-
* 指定此次查询返回的页数,默认为0
|
1696
|
+
* 指定此次查询返回的页数,默认为0。
|
1606
1697
|
*/
|
1607
1698
|
Offset?: number;
|
1608
1699
|
/**
|
1609
|
-
*
|
1700
|
+
* 排序字段。
|
1701
|
+
- createTime:按照备份下载任务的创建时间排序。默认为 createTime。
|
1702
|
+
- finishTime:按照备份下载任务的完成时间排序。
|
1610
1703
|
*/
|
1611
1704
|
OrderBy?: string;
|
1612
1705
|
/**
|
1613
|
-
*
|
1706
|
+
* 排序方式。
|
1707
|
+
- asc:升序排列。
|
1708
|
+
- desc:降序排列。默认为 desc。
|
1614
1709
|
*/
|
1615
1710
|
OrderByType?: string;
|
1616
1711
|
/**
|
1617
|
-
*
|
1712
|
+
* 指定任务状态,用于过滤下载任务。若不配置该参数,则返回所有状态类型的任务。
|
1713
|
+
- 0:等待执行。
|
1714
|
+
- 1:正在下载。
|
1715
|
+
- 2:下载完成。
|
1716
|
+
- 3:下载失败。
|
1717
|
+
- 4:等待重试。
|
1618
1718
|
*/
|
1619
1719
|
Status?: Array<number | bigint>;
|
1620
1720
|
}
|
1621
1721
|
/**
|
1622
|
-
*
|
1722
|
+
* 需要终止的操作。
|
1623
1723
|
*/
|
1624
1724
|
export interface Operation {
|
1625
1725
|
/**
|
1626
|
-
*
|
1726
|
+
* 操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。
|
1627
1727
|
*/
|
1628
1728
|
ReplicaSetName: string;
|
1629
1729
|
/**
|
1630
|
-
*
|
1730
|
+
* 操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。
|
1631
1731
|
*/
|
1632
1732
|
NodeName: string;
|
1633
1733
|
/**
|
1634
|
-
*
|
1734
|
+
* 操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。
|
1635
1735
|
*/
|
1636
1736
|
OpId: number;
|
1637
1737
|
}
|
@@ -1675,11 +1775,11 @@ export interface TerminateDBInstancesRequest {
|
|
1675
1775
|
*/
|
1676
1776
|
export interface DescribeDBBackupsResponse {
|
1677
1777
|
/**
|
1678
|
-
*
|
1778
|
+
* 备份列表。
|
1679
1779
|
*/
|
1680
1780
|
BackupList?: Array<BackupInfo>;
|
1681
1781
|
/**
|
1682
|
-
*
|
1782
|
+
* 备份总数。
|
1683
1783
|
*/
|
1684
1784
|
TotalCount?: number;
|
1685
1785
|
/**
|
@@ -1778,7 +1878,7 @@ export interface DescribeSecurityGroupResponse {
|
|
1778
1878
|
*/
|
1779
1879
|
export interface DescribeTransparentDataEncryptionStatusRequest {
|
1780
1880
|
/**
|
1781
|
-
* 指定实例 ID
|
1881
|
+
* 指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1782
1882
|
*/
|
1783
1883
|
InstanceId: string;
|
1784
1884
|
}
|
@@ -1787,40 +1887,40 @@ export interface DescribeTransparentDataEncryptionStatusRequest {
|
|
1787
1887
|
*/
|
1788
1888
|
export interface SecurityGroup {
|
1789
1889
|
/**
|
1790
|
-
* 所属项目
|
1890
|
+
* 所属项目 ID。
|
1791
1891
|
*/
|
1792
|
-
ProjectId
|
1892
|
+
ProjectId?: number;
|
1793
1893
|
/**
|
1794
|
-
*
|
1894
|
+
* 安全组创建时间。
|
1795
1895
|
*/
|
1796
|
-
CreateTime
|
1896
|
+
CreateTime?: string;
|
1797
1897
|
/**
|
1798
|
-
*
|
1898
|
+
* 安全组入站规则。
|
1799
1899
|
*/
|
1800
|
-
Inbound
|
1900
|
+
Inbound?: Array<SecurityGroupBound>;
|
1801
1901
|
/**
|
1802
|
-
*
|
1902
|
+
* 安全组出站规则。
|
1803
1903
|
*/
|
1804
|
-
Outbound
|
1904
|
+
Outbound?: Array<SecurityGroupBound>;
|
1805
1905
|
/**
|
1806
|
-
* 安全组
|
1906
|
+
* 安全组 ID。
|
1807
1907
|
*/
|
1808
|
-
SecurityGroupId
|
1908
|
+
SecurityGroupId?: string;
|
1809
1909
|
/**
|
1810
|
-
*
|
1910
|
+
* 安全组名称。
|
1811
1911
|
*/
|
1812
|
-
SecurityGroupName
|
1912
|
+
SecurityGroupName?: string;
|
1813
1913
|
/**
|
1814
|
-
*
|
1914
|
+
* 安全组备注信息。
|
1815
1915
|
*/
|
1816
|
-
SecurityGroupRemark
|
1916
|
+
SecurityGroupRemark?: string;
|
1817
1917
|
}
|
1818
1918
|
/**
|
1819
|
-
*
|
1919
|
+
* 分片信息。
|
1820
1920
|
*/
|
1821
1921
|
export interface ReplicaSetInfo {
|
1822
1922
|
/**
|
1823
|
-
* 副本集ID
|
1923
|
+
* 副本集 ID。
|
1824
1924
|
*/
|
1825
1925
|
ReplicaSetId: string;
|
1826
1926
|
}
|
@@ -1868,7 +1968,9 @@ export interface ReplicateSetInfo {
|
|
1868
1968
|
*/
|
1869
1969
|
export interface DescribeDBInstanceDealRequest {
|
1870
1970
|
/**
|
1871
|
-
* 订单ID
|
1971
|
+
* 订单 ID。
|
1972
|
+
- 按量计费实例,请通过 [CreateDBInstanceHour](https://cloud.tencent.com/document/product/240/38570) 接口输出的参数**DealId**获取。。
|
1973
|
+
- 包年包月计费实例,请通过 [CreateDBInstance](https://cloud.tencent.com/document/product/240/38571) 接口输出的参数**DealId**获取。
|
1872
1974
|
*/
|
1873
1975
|
DealId: string;
|
1874
1976
|
}
|
@@ -1882,15 +1984,15 @@ export interface DescribeAsyncRequestInfoRequest {
|
|
1882
1984
|
AsyncRequestId: string;
|
1883
1985
|
}
|
1884
1986
|
/**
|
1885
|
-
* 按
|
1987
|
+
* 按 Key 闪回键值对
|
1886
1988
|
*/
|
1887
1989
|
export interface FBKeyValue {
|
1888
1990
|
/**
|
1889
|
-
*
|
1991
|
+
* 指定按 Key 闪回的目标 Key (键) 。
|
1890
1992
|
*/
|
1891
1993
|
Key?: string;
|
1892
1994
|
/**
|
1893
|
-
*
|
1995
|
+
* 指定按 Key 闪回的目标 Key 所对应的 Value(值)。
|
1894
1996
|
*/
|
1895
1997
|
Value?: string;
|
1896
1998
|
}
|
@@ -1899,17 +2001,17 @@ export interface FBKeyValue {
|
|
1899
2001
|
*/
|
1900
2002
|
export interface CreateBackupDownloadTaskRequest {
|
1901
2003
|
/**
|
1902
|
-
* 实例ID
|
2004
|
+
* 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
1903
2005
|
*/
|
1904
2006
|
InstanceId: string;
|
1905
2007
|
/**
|
1906
|
-
*
|
2008
|
+
* 要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。
|
1907
2009
|
*/
|
1908
2010
|
BackupName: string;
|
1909
2011
|
/**
|
1910
|
-
*
|
1911
|
-
|
1912
|
-
|
2012
|
+
* 指定要下载的副本集节点 ID 或分片集群的分片节点 ID 列表。
|
2013
|
+
- 如副本集实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
|
2014
|
+
- 如分片集群实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据。分片集群如需全量下载,请按示例方式传入全部分片名称。
|
1913
2015
|
*/
|
1914
2016
|
BackupSets: Array<ReplicaSetInfo>;
|
1915
2017
|
}
|
@@ -1918,29 +2020,41 @@ export interface CreateBackupDownloadTaskRequest {
|
|
1918
2020
|
*/
|
1919
2021
|
export interface ParamTpl {
|
1920
2022
|
/**
|
1921
|
-
*
|
2023
|
+
* 参数模板名称。
|
1922
2024
|
*/
|
1923
|
-
TplName
|
2025
|
+
TplName?: string;
|
1924
2026
|
/**
|
1925
|
-
* 参数模板ID
|
2027
|
+
* 参数模板 ID。
|
1926
2028
|
*/
|
1927
|
-
TplId
|
2029
|
+
TplId?: string;
|
1928
2030
|
/**
|
1929
|
-
*
|
2031
|
+
* 参数模板适用的数据库版本。
|
2032
|
+
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
|
2033
|
+
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
|
2034
|
+
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
2035
|
+
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
2036
|
+
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
2037
|
+
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
2038
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
1930
2039
|
*/
|
1931
|
-
MongoVersion
|
2040
|
+
MongoVersion?: string;
|
1932
2041
|
/**
|
1933
|
-
*
|
2042
|
+
* 参数模板适用的数据库类型。
|
2043
|
+
- REPLSET:副本集实例。
|
2044
|
+
- SHARD:分片实例。
|
2045
|
+
- STANDALONE:单节点实例。
|
1934
2046
|
*/
|
1935
|
-
ClusterType
|
2047
|
+
ClusterType?: string;
|
1936
2048
|
/**
|
1937
|
-
*
|
2049
|
+
* 参数模板描述。
|
1938
2050
|
*/
|
1939
|
-
TplDesc
|
2051
|
+
TplDesc?: string;
|
1940
2052
|
/**
|
1941
|
-
*
|
2053
|
+
* 模板类型。
|
2054
|
+
- DEFAULT:系统默认模板。
|
2055
|
+
- CUSTOMIZE:自定义模板。
|
1942
2056
|
*/
|
1943
|
-
TplType
|
2057
|
+
TplType?: string;
|
1944
2058
|
}
|
1945
2059
|
/**
|
1946
2060
|
* InquirePriceModifyDBInstanceSpec返回参数结构体
|
@@ -1960,35 +2074,37 @@ export interface InquirePriceModifyDBInstanceSpecResponse {
|
|
1960
2074
|
*/
|
1961
2075
|
export interface SecurityGroupBound {
|
1962
2076
|
/**
|
1963
|
-
*
|
2077
|
+
* 执行策略。
|
2078
|
+
- ACCEPT:允许,放行该端口相应的访问请求。
|
2079
|
+
- DROP:拒绝,直接丢弃数据包,不返回任何回应信息。
|
1964
2080
|
*/
|
1965
2081
|
Action?: string;
|
1966
2082
|
/**
|
1967
|
-
*
|
2083
|
+
* 访问数据库的入站 IP 或 IP 段。
|
1968
2084
|
*/
|
1969
2085
|
CidrIp?: string;
|
1970
2086
|
/**
|
1971
|
-
*
|
2087
|
+
* 访问数据库的端口。
|
1972
2088
|
*/
|
1973
2089
|
PortRange?: string;
|
1974
2090
|
/**
|
1975
|
-
*
|
2091
|
+
* 传输层协议:tcp。
|
1976
2092
|
*/
|
1977
2093
|
IpProtocol?: string;
|
1978
2094
|
/**
|
1979
|
-
* 安全组
|
2095
|
+
* 安全组 ID。
|
1980
2096
|
*/
|
1981
2097
|
Id?: string;
|
1982
2098
|
/**
|
1983
|
-
*
|
2099
|
+
* IP 地址或 IP 地址组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/ip)获取参数模板 IP 地址详情。
|
1984
2100
|
*/
|
1985
2101
|
AddressModule?: string;
|
1986
2102
|
/**
|
1987
|
-
*
|
2103
|
+
* 协议端口或协议端口组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/protoport)获取参数模板协议端口详情。
|
1988
2104
|
*/
|
1989
2105
|
ServiceModule?: string;
|
1990
2106
|
/**
|
1991
|
-
*
|
2107
|
+
* 安全组描述信息。
|
1992
2108
|
*/
|
1993
2109
|
Desc?: string;
|
1994
2110
|
}
|
@@ -2034,11 +2150,21 @@ export interface DescribeDBInstanceParamTplDetailResponse {
|
|
2034
2150
|
*/
|
2035
2151
|
TotalCount?: number;
|
2036
2152
|
/**
|
2037
|
-
*
|
2153
|
+
* 模板适配的实例版本。
|
2154
|
+
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
|
2155
|
+
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
|
2156
|
+
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
2157
|
+
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
2158
|
+
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
2159
|
+
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
2160
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
2038
2161
|
*/
|
2039
2162
|
MongoVersion?: string;
|
2040
2163
|
/**
|
2041
|
-
*
|
2164
|
+
* 模板适配集群类型。
|
2165
|
+
- REPLSET:副本集实例。
|
2166
|
+
- SHARD:分片实例。
|
2167
|
+
- STANDALONE:单节点实例。
|
2042
2168
|
*/
|
2043
2169
|
ClusterType?: string;
|
2044
2170
|
/**
|
@@ -2055,7 +2181,7 @@ export interface DescribeDBInstanceParamTplDetailResponse {
|
|
2055
2181
|
*/
|
2056
2182
|
export interface ModifyDBInstanceParamTplRequest {
|
2057
2183
|
/**
|
2058
|
-
* 待修改的参数模板 ID
|
2184
|
+
* 待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
2059
2185
|
*/
|
2060
2186
|
TplId: string;
|
2061
2187
|
/**
|
@@ -2076,7 +2202,7 @@ export interface ModifyDBInstanceParamTplRequest {
|
|
2076
2202
|
*/
|
2077
2203
|
export interface DescribeCurrentOpRequest {
|
2078
2204
|
/**
|
2079
|
-
* 指定要查询的实例 ID
|
2205
|
+
* 指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2080
2206
|
*/
|
2081
2207
|
InstanceId: string;
|
2082
2208
|
/**
|
@@ -2090,7 +2216,15 @@ export interface DescribeCurrentOpRequest {
|
|
2090
2216
|
*/
|
2091
2217
|
MillisecondRunning?: number;
|
2092
2218
|
/**
|
2093
|
-
* 设置查询筛选条件为操作任务类型。取值包括:
|
2219
|
+
* 设置查询筛选条件为操作任务类型。取值包括:
|
2220
|
+
- none:特殊状态,空闲连接或内部任务等。
|
2221
|
+
- update:更新数据。
|
2222
|
+
- insert:插入操作。
|
2223
|
+
- query:查询操作。
|
2224
|
+
- command:命令操作。
|
2225
|
+
- getmore:获取更多数据。
|
2226
|
+
- remove:删除操作。
|
2227
|
+
- killcursors:释放查询游标的操作。
|
2094
2228
|
*/
|
2095
2229
|
Op?: string;
|
2096
2230
|
/**
|
@@ -2104,19 +2238,21 @@ export interface DescribeCurrentOpRequest {
|
|
2104
2238
|
*/
|
2105
2239
|
State?: string;
|
2106
2240
|
/**
|
2107
|
-
* 单次请求返回的数量,默认值为100,取值范围为[0,100]
|
2241
|
+
* 单次请求返回的数量,默认值为100,取值范围为[0,100]。
|
2108
2242
|
*/
|
2109
2243
|
Limit?: number;
|
2110
2244
|
/**
|
2111
|
-
* 偏移量,默认值为0,取值范围为[0,10000]
|
2245
|
+
* 偏移量,默认值为0,取值范围为[0,10000]。
|
2112
2246
|
*/
|
2113
2247
|
Offset?: number;
|
2114
2248
|
/**
|
2115
|
-
*
|
2249
|
+
* 返回结果集排序的字段,目前支持按照 MicrosecsRunning(操作任务已执行的时间)排序。
|
2116
2250
|
*/
|
2117
2251
|
OrderBy?: string;
|
2118
2252
|
/**
|
2119
|
-
*
|
2253
|
+
* 返回结果集排序方式。
|
2254
|
+
- ASC:升序。默认为 ASC,按照升序排序。
|
2255
|
+
- DESC:降序。
|
2120
2256
|
*/
|
2121
2257
|
OrderByType?: string;
|
2122
2258
|
}
|
@@ -2125,43 +2261,54 @@ export interface DescribeCurrentOpRequest {
|
|
2125
2261
|
*/
|
2126
2262
|
export interface BackupDownloadTask {
|
2127
2263
|
/**
|
2128
|
-
*
|
2264
|
+
* 任务创建时间。
|
2129
2265
|
*/
|
2130
2266
|
CreateTime?: string;
|
2131
2267
|
/**
|
2132
|
-
*
|
2268
|
+
* 备份文件名。
|
2133
2269
|
*/
|
2134
2270
|
BackupName?: string;
|
2135
2271
|
/**
|
2136
|
-
*
|
2272
|
+
* 分片名称。
|
2137
2273
|
*/
|
2138
2274
|
ReplicaSetId?: string;
|
2139
2275
|
/**
|
2140
|
-
*
|
2276
|
+
* 备份数据大小,单位:字节。
|
2141
2277
|
*/
|
2142
2278
|
BackupSize?: number;
|
2143
2279
|
/**
|
2144
|
-
* 任务状态。
|
2280
|
+
* 任务状态。
|
2281
|
+
- 0:等待执行。
|
2282
|
+
- 1:正在下载。
|
2283
|
+
- 2:下载完成。
|
2284
|
+
- 3:下载失败。
|
2285
|
+
- 4:等待重试。
|
2145
2286
|
*/
|
2146
2287
|
Status?: number;
|
2147
2288
|
/**
|
2148
|
-
*
|
2289
|
+
* 任务进度百分比。
|
2149
2290
|
*/
|
2150
2291
|
Percent?: number;
|
2151
2292
|
/**
|
2152
|
-
*
|
2293
|
+
* 耗时,单位为秒。
|
2153
2294
|
*/
|
2154
2295
|
TimeSpend?: number;
|
2155
2296
|
/**
|
2156
|
-
*
|
2297
|
+
* 备份数据下载链接。
|
2157
2298
|
*/
|
2158
2299
|
Url?: string;
|
2159
2300
|
/**
|
2160
|
-
*
|
2301
|
+
* 备份方式。
|
2302
|
+
- 0:逻辑备份。
|
2303
|
+
- 1:物理备份。
|
2304
|
+
- 3:快照备份。
|
2305
|
+
**说明**:
|
2306
|
+
1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
2307
|
+
2. 实例开通存储加密,则备份方式不能为物理备份。
|
2161
2308
|
*/
|
2162
2309
|
BackupMethod?: number;
|
2163
2310
|
/**
|
2164
|
-
*
|
2311
|
+
* 发起备份时指定的备注信息。
|
2165
2312
|
*/
|
2166
2313
|
BackupDesc?: string;
|
2167
2314
|
/**
|
@@ -2178,11 +2325,17 @@ export interface BackupDownloadTask {
|
|
2178
2325
|
*/
|
2179
2326
|
export interface DescribeDBBackupsRequest {
|
2180
2327
|
/**
|
2181
|
-
* 实例ID
|
2328
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2182
2329
|
*/
|
2183
2330
|
InstanceId: string;
|
2184
2331
|
/**
|
2185
|
-
*
|
2332
|
+
* 备份方式。
|
2333
|
+
- 0:逻辑备份。
|
2334
|
+
- 1:物理备份。
|
2335
|
+
- 3:快照备份。
|
2336
|
+
**说明**:
|
2337
|
+
1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
2338
|
+
2. 实例开通存储加密,则备份方式不能为物理备份。
|
2186
2339
|
*/
|
2187
2340
|
BackupMethod?: number;
|
2188
2341
|
/**
|
@@ -2226,11 +2379,11 @@ export interface SetDBInstanceDeletionProtectionResponse {
|
|
2226
2379
|
*/
|
2227
2380
|
export interface DescribeDetailedSlowLogsResponse {
|
2228
2381
|
/**
|
2229
|
-
*
|
2382
|
+
* 满足条件的慢日志数量。
|
2230
2383
|
*/
|
2231
2384
|
TotalCount?: number;
|
2232
2385
|
/**
|
2233
|
-
*
|
2386
|
+
* 慢日志详情。
|
2234
2387
|
*/
|
2235
2388
|
DetailedSlowLogs?: Array<SlowLogItem>;
|
2236
2389
|
/**
|
@@ -2289,20 +2442,23 @@ export interface SetBackupRulesResponse {
|
|
2289
2442
|
*/
|
2290
2443
|
export interface DescribeDBInstanceNodePropertyRequest {
|
2291
2444
|
/**
|
2292
|
-
* 实例ID
|
2445
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2293
2446
|
*/
|
2294
2447
|
InstanceId: string;
|
2295
2448
|
/**
|
2296
|
-
* 节点ID。
|
2449
|
+
* 节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID。
|
2297
2450
|
*/
|
2298
2451
|
NodeIds?: Array<string>;
|
2299
2452
|
/**
|
2300
2453
|
* 节点角色。可选值包括:
|
2301
|
-
|
2454
|
+
- PRIMARY:主节点。
|
2455
|
+
- SECONDARY:从节点。
|
2456
|
+
- READONLY:只读节点。
|
2457
|
+
- ARBITER:仲裁节点。
|
2302
2458
|
*/
|
2303
2459
|
Roles?: Array<string>;
|
2304
2460
|
/**
|
2305
|
-
* 该参数指定节点是否为Hidden节点,默认为false。
|
2461
|
+
* 该参数指定节点是否为 Hidden 节点,默认为 false。
|
2306
2462
|
*/
|
2307
2463
|
OnlyHidden?: boolean;
|
2308
2464
|
/**
|
@@ -2311,7 +2467,8 @@ export interface DescribeDBInstanceNodePropertyRequest {
|
|
2311
2467
|
Priority?: number;
|
2312
2468
|
/**
|
2313
2469
|
* 该参数指定节点投票权。
|
2314
|
-
|
2470
|
+
- 1:具有投票权。
|
2471
|
+
- 0:无投票权。
|
2315
2472
|
*/
|
2316
2473
|
Votes?: number;
|
2317
2474
|
/**
|
@@ -2423,6 +2580,10 @@ export interface CreateBackupDBInstanceRequest {
|
|
2423
2580
|
* 设置备份方式。
|
2424
2581
|
- 0:逻辑备份。
|
2425
2582
|
- 1:物理备份。
|
2583
|
+
- 3:快照备份。
|
2584
|
+
**说明**:
|
2585
|
+
1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
2586
|
+
2. 实例开通存储加密,则备份方式不能为物理备份。
|
2426
2587
|
*/
|
2427
2588
|
BackupMethod: number;
|
2428
2589
|
/**
|
@@ -2468,35 +2629,52 @@ export interface NodeProperty {
|
|
2468
2629
|
*/
|
2469
2630
|
WanServiceAddress?: string;
|
2470
2631
|
/**
|
2471
|
-
*
|
2632
|
+
* 节点角色。
|
2633
|
+
- PRIMARY:主节点。
|
2634
|
+
- SECONDARY:从节点。
|
2635
|
+
- READONLY:只读节点。
|
2636
|
+
- ARBITER:仲裁节点。
|
2472
2637
|
*/
|
2473
2638
|
Role?: string;
|
2474
2639
|
/**
|
2475
|
-
*
|
2640
|
+
* 节点是否为 Hidden 节点。
|
2641
|
+
- true:Hidden 节点。
|
2642
|
+
- false:非 Hidden 节点。
|
2476
2643
|
*/
|
2477
2644
|
Hidden?: boolean;
|
2478
2645
|
/**
|
2479
|
-
*
|
2646
|
+
* 节点状态。
|
2647
|
+
- NORMAL:正常运行中。
|
2648
|
+
- STARTUP:正在启动。
|
2649
|
+
- STARTUP2:正在启动,处理中间数据。
|
2650
|
+
- RECOVERING:恢复中,暂不可用。
|
2651
|
+
- DOWN:已掉线。
|
2652
|
+
- UNKNOWN:未知状态。
|
2653
|
+
- ROLLBACK:回滚中。
|
2654
|
+
- REMOVED:已移除。
|
2480
2655
|
*/
|
2481
2656
|
Status?: string;
|
2482
2657
|
/**
|
2483
|
-
*
|
2658
|
+
* 主从同步延迟时间,单位:秒。
|
2484
2659
|
*/
|
2485
2660
|
SlaveDelay?: number;
|
2486
2661
|
/**
|
2487
|
-
*
|
2662
|
+
* 节点优先级。其取值范围为[0,100],数值越高,优先级越高。
|
2488
2663
|
*/
|
2489
2664
|
Priority?: number;
|
2490
2665
|
/**
|
2491
2666
|
* 节点投票权。
|
2667
|
+
- 1:具有投票权。
|
2668
|
+
- 0:无投票权。
|
2492
2669
|
*/
|
2493
2670
|
Votes?: number;
|
2494
2671
|
/**
|
2495
2672
|
* 节点标签。
|
2673
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
2496
2674
|
*/
|
2497
2675
|
Tags?: Array<NodeTag>;
|
2498
2676
|
/**
|
2499
|
-
* 副本集
|
2677
|
+
* 副本集 ID。
|
2500
2678
|
*/
|
2501
2679
|
ReplicateSetId?: string;
|
2502
2680
|
}
|
@@ -2514,7 +2692,7 @@ export interface KillOpsResponse {
|
|
2514
2692
|
*/
|
2515
2693
|
export interface IsolateDBInstanceRequest {
|
2516
2694
|
/**
|
2517
|
-
* 实例ID
|
2695
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID。
|
2518
2696
|
*/
|
2519
2697
|
InstanceId: string;
|
2520
2698
|
}
|
@@ -2542,12 +2720,12 @@ export interface CreateDBInstanceHourRequest {
|
|
2542
2720
|
NodeNum: number;
|
2543
2721
|
/**
|
2544
2722
|
* 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
|
2545
|
-
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
2546
2723
|
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
2547
2724
|
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
2548
2725
|
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
2549
2726
|
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
2550
2727
|
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
2728
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
2551
2729
|
*/
|
2552
2730
|
MongoVersion: string;
|
2553
2731
|
/**
|
@@ -2557,7 +2735,7 @@ export interface CreateDBInstanceHourRequest {
|
|
2557
2735
|
*/
|
2558
2736
|
MachineCode: string;
|
2559
2737
|
/**
|
2560
|
-
* 实例数量,最小值1,最大值为
|
2738
|
+
* 实例数量,最小值1,最大值为30。
|
2561
2739
|
*/
|
2562
2740
|
GoodsNum: number;
|
2563
2741
|
/**
|
@@ -2573,11 +2751,15 @@ export interface CreateDBInstanceHourRequest {
|
|
2573
2751
|
*/
|
2574
2752
|
ClusterType: string;
|
2575
2753
|
/**
|
2576
|
-
* 私有网络ID
|
2754
|
+
* 私有网络ID。
|
2755
|
+
- 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
|
2756
|
+
- 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
2577
2757
|
*/
|
2578
2758
|
VpcId?: string;
|
2579
2759
|
/**
|
2580
|
-
* 私有网络VPC
|
2760
|
+
* 私有网络 VPC 的子网 ID。
|
2761
|
+
- 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
|
2762
|
+
- 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
|
2581
2763
|
*/
|
2582
2764
|
SubnetId?: string;
|
2583
2765
|
/**
|
@@ -2599,15 +2781,21 @@ export interface CreateDBInstanceHourRequest {
|
|
2599
2781
|
*/
|
2600
2782
|
Tags?: Array<TagInfo>;
|
2601
2783
|
/**
|
2602
|
-
*
|
2784
|
+
* 实例类型。
|
2785
|
+
- 1:正式实例。
|
2786
|
+
- 3:只读实例。
|
2787
|
+
- 4:灾备实例。
|
2788
|
+
- 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
|
2603
2789
|
*/
|
2604
2790
|
Clone?: number;
|
2605
2791
|
/**
|
2606
|
-
* 父实例 ID
|
2792
|
+
* 父实例 ID。
|
2793
|
+
- 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
|
2794
|
+
- 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
|
2607
2795
|
*/
|
2608
2796
|
Father?: string;
|
2609
2797
|
/**
|
2610
|
-
* 安全组 ID。
|
2798
|
+
* 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
|
2611
2799
|
*/
|
2612
2800
|
SecurityGroup?: Array<string>;
|
2613
2801
|
/**
|
@@ -2617,7 +2805,10 @@ export interface CreateDBInstanceHourRequest {
|
|
2617
2805
|
*/
|
2618
2806
|
RestoreTime?: string;
|
2619
2807
|
/**
|
2620
|
-
* 实例名称。仅支持长度为
|
2808
|
+
* 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
|
2809
|
+
- 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
|
2810
|
+
- 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
|
2811
|
+
- 复合模式串:前缀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.
|
2621
2812
|
*/
|
2622
2813
|
InstanceName?: string;
|
2623
2814
|
/**
|
@@ -2625,20 +2816,16 @@ export interface CreateDBInstanceHourRequest {
|
|
2625
2816
|
- 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
|
2626
2817
|
- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
|
2627
2818
|
- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
|
2628
|
-
|
2629
2819
|
*/
|
2630
2820
|
AvailabilityZoneList?: Array<string>;
|
2631
2821
|
/**
|
2632
2822
|
* Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。
|
2633
|
-
|
2634
2823
|
*/
|
2635
2824
|
MongosCpu?: number;
|
2636
2825
|
/**
|
2637
2826
|
* Mongos 内存大小。
|
2638
2827
|
- 购买分片集群时,必须填写。
|
2639
2828
|
- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
|
2640
|
-
|
2641
|
-
|
2642
2829
|
*/
|
2643
2830
|
MongosMemory?: number;
|
2644
2831
|
/**
|
@@ -2660,7 +2847,9 @@ export interface CreateDBInstanceHourRequest {
|
|
2660
2847
|
*/
|
2661
2848
|
HiddenZone?: string;
|
2662
2849
|
/**
|
2663
|
-
* 参数模板 ID
|
2850
|
+
* 参数模板 ID。
|
2851
|
+
- 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
|
2852
|
+
- 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
|
2664
2853
|
*/
|
2665
2854
|
ParamTemplateId?: string;
|
2666
2855
|
}
|
@@ -2686,7 +2875,13 @@ export interface SetBackupRulesRequest {
|
|
2686
2875
|
*/
|
2687
2876
|
InstanceId: string;
|
2688
2877
|
/**
|
2689
|
-
*
|
2878
|
+
* 备份方式。
|
2879
|
+
- 0:逻辑备份。
|
2880
|
+
- 1:物理备份。
|
2881
|
+
- 3:快照备份。
|
2882
|
+
**说明**:
|
2883
|
+
1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
|
2884
|
+
2. 实例开通存储加密,则备份方式不能为物理备份。
|
2690
2885
|
*/
|
2691
2886
|
BackupMethod: number;
|
2692
2887
|
/**
|
@@ -2742,7 +2937,7 @@ export interface ModifyInstanceParamsRequest {
|
|
2742
2937
|
*/
|
2743
2938
|
export interface CreateBackupDownloadTaskResponse {
|
2744
2939
|
/**
|
2745
|
-
*
|
2940
|
+
* 下载任务状态。
|
2746
2941
|
*/
|
2747
2942
|
Tasks?: Array<BackupDownloadTaskStatus>;
|
2748
2943
|
/**
|
@@ -2778,36 +2973,38 @@ export interface DbURL {
|
|
2778
2973
|
*/
|
2779
2974
|
export interface SlowLogItem {
|
2780
2975
|
/**
|
2781
|
-
*
|
2976
|
+
* 慢日志详情。
|
2782
2977
|
*/
|
2783
2978
|
Log?: string;
|
2784
2979
|
/**
|
2785
|
-
*
|
2980
|
+
* 节点名称。
|
2786
2981
|
*/
|
2787
2982
|
NodeName?: string;
|
2788
2983
|
/**
|
2789
|
-
*
|
2984
|
+
* 查询哈希值。
|
2790
2985
|
*/
|
2791
2986
|
QueryHash?: string;
|
2792
2987
|
}
|
2793
2988
|
/**
|
2794
|
-
*
|
2989
|
+
* 实例规格信息。
|
2795
2990
|
*/
|
2796
2991
|
export interface SpecificationInfo {
|
2797
2992
|
/**
|
2798
|
-
*
|
2993
|
+
* 地域信息。
|
2799
2994
|
*/
|
2800
2995
|
Region?: string;
|
2801
2996
|
/**
|
2802
|
-
*
|
2997
|
+
* 可用区信息。
|
2803
2998
|
*/
|
2804
2999
|
Zone?: string;
|
2805
3000
|
/**
|
2806
|
-
*
|
3001
|
+
* 售卖规格信息。
|
2807
3002
|
*/
|
2808
3003
|
SpecItems?: Array<SpecItem>;
|
2809
3004
|
/**
|
2810
|
-
*
|
3005
|
+
* 是否支持跨可用区部署。
|
3006
|
+
- 1:支持。
|
3007
|
+
- 0:不支持。
|
2811
3008
|
*/
|
2812
3009
|
SupportMultiAZ?: number;
|
2813
3010
|
}
|
@@ -2816,15 +3013,19 @@ export interface SpecificationInfo {
|
|
2816
3013
|
*/
|
2817
3014
|
export interface DescribeSlowLogPatternsRequest {
|
2818
3015
|
/**
|
2819
|
-
* 实例ID
|
3016
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
2820
3017
|
*/
|
2821
3018
|
InstanceId: string;
|
2822
3019
|
/**
|
2823
|
-
*
|
3020
|
+
* 慢日志起始时间。
|
3021
|
+
- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
|
3022
|
+
- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
2824
3023
|
*/
|
2825
3024
|
StartTime: string;
|
2826
3025
|
/**
|
2827
|
-
*
|
3026
|
+
* 慢日志终止时间。
|
3027
|
+
- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
|
3028
|
+
- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
|
2828
3029
|
*/
|
2829
3030
|
EndTime: string;
|
2830
3031
|
/**
|
@@ -2845,23 +3046,23 @@ export interface DescribeSlowLogPatternsRequest {
|
|
2845
3046
|
Format?: string;
|
2846
3047
|
}
|
2847
3048
|
/**
|
2848
|
-
* 按
|
3049
|
+
* 按 Key 闪回数据表
|
2849
3050
|
*/
|
2850
3051
|
export interface FlashbackCollection {
|
2851
3052
|
/**
|
2852
|
-
*
|
3053
|
+
* 指定按 Key 闪回源数据库集合名。
|
2853
3054
|
*/
|
2854
3055
|
CollectionName: string;
|
2855
3056
|
/**
|
2856
|
-
*
|
3057
|
+
* 指定按 Key 闪回目标数据库集合名。
|
2857
3058
|
*/
|
2858
3059
|
TargetResultCollectionName: string;
|
2859
3060
|
/**
|
2860
|
-
*
|
3061
|
+
* 指定用于过滤按 Key 闪回的 Key(键)。
|
2861
3062
|
*/
|
2862
3063
|
FilterKey: string;
|
2863
3064
|
/**
|
2864
|
-
*
|
3065
|
+
* 指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。
|
2865
3066
|
*/
|
2866
3067
|
KeyValues?: Array<FBKeyValue>;
|
2867
3068
|
}
|
@@ -2870,7 +3071,7 @@ export interface FlashbackCollection {
|
|
2870
3071
|
*/
|
2871
3072
|
export interface DescribeSpecInfoResponse {
|
2872
3073
|
/**
|
2873
|
-
*
|
3074
|
+
* 实例售卖规格信息列表。
|
2874
3075
|
*/
|
2875
3076
|
SpecInfoList?: Array<SpecificationInfo>;
|
2876
3077
|
/**
|
@@ -2939,7 +3140,7 @@ export interface DescribeDBInstancesResponse {
|
|
2939
3140
|
*/
|
2940
3141
|
export interface OfflineIsolatedDBInstanceRequest {
|
2941
3142
|
/**
|
2942
|
-
* 实例ID
|
3143
|
+
* 实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID。
|
2943
3144
|
*/
|
2944
3145
|
InstanceId: string;
|
2945
3146
|
}
|
@@ -2961,6 +3162,8 @@ export interface KMSInfoDetail {
|
|
2961
3162
|
CreateTime?: string;
|
2962
3163
|
/**
|
2963
3164
|
* 密钥状态。
|
3165
|
+
- Enabled:开启。
|
3166
|
+
- Disabled:不开启。
|
2964
3167
|
*/
|
2965
3168
|
Status?: string;
|
2966
3169
|
/**
|
@@ -3128,7 +3331,7 @@ export interface DescribeDBInstanceURLResponse {
|
|
3128
3331
|
RequestId?: string;
|
3129
3332
|
}
|
3130
3333
|
/**
|
3131
|
-
*
|
3334
|
+
* 修改实例节点详情。
|
3132
3335
|
*/
|
3133
3336
|
export interface RemoveNodeList {
|
3134
3337
|
/**
|
@@ -3139,14 +3342,13 @@ export interface RemoveNodeList {
|
|
3139
3342
|
*/
|
3140
3343
|
Role: string;
|
3141
3344
|
/**
|
3142
|
-
* 要删除的节点 ID
|
3143
|
-
|
3144
|
-
-
|
3145
|
-
- 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk****_0-node-primary。
|
3345
|
+
* 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对该组对齐。
|
3346
|
+
- 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/mongodb),在**节点管理**页签,可获取**节点 ID**。
|
3347
|
+
- 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk\*\*\*\*\_0-node-primary。
|
3146
3348
|
*/
|
3147
3349
|
NodeName: string;
|
3148
3350
|
/**
|
3149
|
-
*
|
3351
|
+
* 节点所对应的可用区。当前支持可用区信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
|
3150
3352
|
- 单可用区,所有节点在同一可用区。
|
3151
3353
|
- 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。
|
3152
3354
|
*/
|
@@ -3157,11 +3359,13 @@ export interface RemoveNodeList {
|
|
3157
3359
|
*/
|
3158
3360
|
export interface RestartNodesRequest {
|
3159
3361
|
/**
|
3160
|
-
* 实例ID
|
3362
|
+
* 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
|
3161
3363
|
*/
|
3162
3364
|
InstanceId: string;
|
3163
3365
|
/**
|
3164
|
-
*
|
3366
|
+
* 需要重启的节点 ID 列表。
|
3367
|
+
- 支持重启的节点类型包含:mongod节点、只读节点、mongos节点。
|
3368
|
+
- 节点 ID,请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在**节点管理**页面复制,或者通过 [DescribeDBInstanceNodeProperty ](https://cloud.tencent.com/document/product/240/82022)接口获取。
|
3165
3369
|
*/
|
3166
3370
|
NodeIds: Array<string>;
|
3167
3371
|
}
|
@@ -3190,9 +3394,9 @@ export interface SetInstanceMaintenanceRequest {
|
|
3190
3394
|
*/
|
3191
3395
|
export interface RestartNodesResponse {
|
3192
3396
|
/**
|
3193
|
-
* 流程
|
3397
|
+
* 流程 ID。
|
3194
3398
|
*/
|
3195
|
-
FlowId
|
3399
|
+
FlowId?: number;
|
3196
3400
|
/**
|
3197
3401
|
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
3198
3402
|
*/
|
@@ -3212,7 +3416,7 @@ export interface DescribeDBInstanceURLRequest {
|
|
3212
3416
|
*/
|
3213
3417
|
export interface DescribeDBInstanceParamTplDetailRequest {
|
3214
3418
|
/**
|
3215
|
-
* 参数模板 ID。
|
3419
|
+
* 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
|
3216
3420
|
*/
|
3217
3421
|
TplId: string;
|
3218
3422
|
/**
|
@@ -3221,11 +3425,11 @@ export interface DescribeDBInstanceParamTplDetailRequest {
|
|
3221
3425
|
ParamName?: string;
|
3222
3426
|
}
|
3223
3427
|
/**
|
3224
|
-
*
|
3428
|
+
* 实例详情。
|
3225
3429
|
*/
|
3226
3430
|
export interface InstanceDetail {
|
3227
3431
|
/**
|
3228
|
-
* 实例ID。
|
3432
|
+
* 实例 ID。
|
3229
3433
|
*/
|
3230
3434
|
InstanceId?: string;
|
3231
3435
|
/**
|
@@ -3233,15 +3437,19 @@ export interface InstanceDetail {
|
|
3233
3437
|
*/
|
3234
3438
|
InstanceName?: string;
|
3235
3439
|
/**
|
3236
|
-
*
|
3440
|
+
* 付费类型。
|
3441
|
+
- 1:包年包月。
|
3442
|
+
- 0:按量计费。
|
3237
3443
|
*/
|
3238
3444
|
PayMode?: number;
|
3239
3445
|
/**
|
3240
|
-
* 项目ID。
|
3446
|
+
* 项目 ID。
|
3241
3447
|
*/
|
3242
3448
|
ProjectId?: number;
|
3243
3449
|
/**
|
3244
|
-
*
|
3450
|
+
* 集群类型。
|
3451
|
+
- 0:副本集实例。
|
3452
|
+
- 1:分片实例。
|
3245
3453
|
*/
|
3246
3454
|
ClusterType?: number;
|
3247
3455
|
/**
|
@@ -3253,7 +3461,9 @@ export interface InstanceDetail {
|
|
3253
3461
|
*/
|
3254
3462
|
Zone?: string;
|
3255
3463
|
/**
|
3256
|
-
*
|
3464
|
+
* 网络类型。
|
3465
|
+
- 0:基础网络。
|
3466
|
+
- 1:私有网络。
|
3257
3467
|
*/
|
3258
3468
|
NetType?: number;
|
3259
3469
|
/**
|
@@ -3265,7 +3475,12 @@ export interface InstanceDetail {
|
|
3265
3475
|
*/
|
3266
3476
|
SubnetId?: string;
|
3267
3477
|
/**
|
3268
|
-
*
|
3478
|
+
* 实例状态。
|
3479
|
+
- 0:待初始化。
|
3480
|
+
- 1:流程处理中,例如:变更规格、参数修改等。
|
3481
|
+
- 2:实例正常运行中。
|
3482
|
+
- -2:已隔离(包年包月)。
|
3483
|
+
- -3:已隔离(按量计费)。
|
3269
3484
|
*/
|
3270
3485
|
Status?: number;
|
3271
3486
|
/**
|
@@ -3285,23 +3500,32 @@ export interface InstanceDetail {
|
|
3285
3500
|
*/
|
3286
3501
|
DeadLine?: string;
|
3287
3502
|
/**
|
3288
|
-
*
|
3503
|
+
* 实例存储引擎版本信息。
|
3504
|
+
- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
|
3505
|
+
- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
|
3506
|
+
- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
|
3507
|
+
- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
|
3508
|
+
- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
|
3509
|
+
- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
|
3510
|
+
- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
|
3289
3511
|
*/
|
3290
3512
|
MongoVersion?: string;
|
3291
3513
|
/**
|
3292
|
-
*
|
3514
|
+
* 实例内存规格,单位:MB。
|
3293
3515
|
*/
|
3294
3516
|
Memory?: number;
|
3295
3517
|
/**
|
3296
|
-
*
|
3518
|
+
* 实例磁盘规格,单位:MB。
|
3297
3519
|
*/
|
3298
3520
|
Volume?: number;
|
3299
3521
|
/**
|
3300
|
-
* 实例CPU核心数。
|
3522
|
+
* 实例 CPU 核心数。
|
3301
3523
|
*/
|
3302
3524
|
CpuNum?: number;
|
3303
3525
|
/**
|
3304
3526
|
* 实例机器类型。
|
3527
|
+
- HIO10G:通用高 HIO 万兆型。
|
3528
|
+
- HCD:云盘版类型。
|
3305
3529
|
*/
|
3306
3530
|
MachineType?: string;
|
3307
3531
|
/**
|
@@ -3313,11 +3537,14 @@ export interface InstanceDetail {
|
|
3313
3537
|
*/
|
3314
3538
|
ReplicationSetNum?: number;
|
3315
3539
|
/**
|
3316
|
-
*
|
3540
|
+
* 实例自动续费标志。
|
3541
|
+
- 0:手动续费。
|
3542
|
+
- 1:自动续费。
|
3543
|
+
- 2:确认不续费。
|
3317
3544
|
*/
|
3318
3545
|
AutoRenewFlag?: number;
|
3319
3546
|
/**
|
3320
|
-
*
|
3547
|
+
* 已用容量,单位:MB。
|
3321
3548
|
*/
|
3322
3549
|
UsedVolume?: number;
|
3323
3550
|
/**
|
@@ -3361,19 +3588,24 @@ export interface InstanceDetail {
|
|
3361
3588
|
*/
|
3362
3589
|
ClusterVer?: number;
|
3363
3590
|
/**
|
3364
|
-
*
|
3591
|
+
* 协议信息:mongodb。
|
3365
3592
|
*/
|
3366
3593
|
Protocol?: number;
|
3367
3594
|
/**
|
3368
|
-
*
|
3595
|
+
* 实例类型。
|
3596
|
+
- 0:所有实例。
|
3597
|
+
- 1:正式实例。
|
3598
|
+
- 2:临时实例
|
3599
|
+
- 3:只读实例。
|
3600
|
+
- -1:同时包括正式实例、只读实例与灾备实例。
|
3369
3601
|
*/
|
3370
3602
|
InstanceType?: number;
|
3371
3603
|
/**
|
3372
|
-
*
|
3604
|
+
* 实例状态描述。
|
3373
3605
|
*/
|
3374
3606
|
InstanceStatusDesc?: string;
|
3375
3607
|
/**
|
3376
|
-
* 实例对应的物理实例
|
3608
|
+
* 实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId 和 RealInstanceId,从 barad 获取监控数据等场景下需要用物理 ID 获取。
|
3377
3609
|
*/
|
3378
3610
|
RealInstanceId?: string;
|
3379
3611
|
/**
|
@@ -3381,15 +3613,15 @@ export interface InstanceDetail {
|
|
3381
3613
|
*/
|
3382
3614
|
ZoneList?: Array<string>;
|
3383
3615
|
/**
|
3384
|
-
* mongos节点个数。
|
3616
|
+
* mongos 节点个数。
|
3385
3617
|
*/
|
3386
3618
|
MongosNodeNum?: number;
|
3387
3619
|
/**
|
3388
|
-
* mongos
|
3620
|
+
* mongos 节点内存。单位:MB。
|
3389
3621
|
*/
|
3390
3622
|
MongosMemory?: number;
|
3391
3623
|
/**
|
3392
|
-
* mongos节点CPU核数。
|
3624
|
+
* mongos 节点 CPU 核数。
|
3393
3625
|
*/
|
3394
3626
|
MongosCpuNum?: number;
|
3395
3627
|
/**
|
@@ -3397,15 +3629,15 @@ export interface InstanceDetail {
|
|
3397
3629
|
*/
|
3398
3630
|
ConfigServerNodeNum?: number;
|
3399
3631
|
/**
|
3400
|
-
* Config Server
|
3632
|
+
* Config Server节点内存。单位:MB。
|
3401
3633
|
*/
|
3402
3634
|
ConfigServerMemory?: number;
|
3403
3635
|
/**
|
3404
|
-
* Config Server
|
3636
|
+
* Config Server节点磁盘大小。单位:MB。
|
3405
3637
|
*/
|
3406
3638
|
ConfigServerVolume?: number;
|
3407
3639
|
/**
|
3408
|
-
* Config Server节点CPU核数。
|
3640
|
+
* Config Server 节点 CPU 核数。
|
3409
3641
|
*/
|
3410
3642
|
ConfigServerCpuNum?: number;
|
3411
3643
|
/**
|
@@ -3448,7 +3680,7 @@ export interface InstanceChargePrepaid {
|
|
3448
3680
|
export interface RenewDBInstancesRequest {
|
3449
3681
|
/**
|
3450
3682
|
* 指定续费的一个或多个待操作的实例ID。
|
3451
|
-
- 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**
|
3683
|
+
- 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。
|
3452
3684
|
- 每次续费请求的实例数量上限为100。
|
3453
3685
|
*/
|
3454
3686
|
InstanceIds: Array<string>;
|