tencentcloud-sdk-nodejs-mongodb 4.0.618 → 4.0.620

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.
@@ -33,142 +33,114 @@ export interface CreateDBInstanceRequest {
33
33
  * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
34
34
  */
35
35
  NodeNum: number
36
-
37
36
  /**
38
37
  * 实例内存大小,单位:GB
39
38
  */
40
39
  Memory: number
41
-
42
40
  /**
43
41
  * 实例硬盘大小,单位:GB
44
42
  */
45
43
  Volume: number
46
-
47
44
  /**
48
45
  * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本,MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本,MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本
49
46
  */
50
47
  MongoVersion: string
51
-
52
48
  /**
53
49
  * 实例数量, 最小值1,最大值为10
54
50
  */
55
51
  GoodsNum: number
56
-
57
52
  /**
58
53
  * 实例所属区域名称,格式如:ap-guangzhou-2。注:此参数填写的是主可用区,如果选择多可用区部署,Zone必须是AvailabilityZoneList中的一个
59
54
  */
60
55
  Zone: string
61
-
62
56
  /**
63
57
  * 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]
64
58
  */
65
59
  Period: number
66
-
67
60
  /**
68
61
  * 机器类型,HIO:高IO型;HIO10G:高IO万兆型;STDS5:标准型
69
62
  */
70
63
  MachineCode: string
71
-
72
64
  /**
73
65
  * 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
74
66
  */
75
67
  ClusterType: string
76
-
77
68
  /**
78
69
  * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0
79
70
  */
80
71
  ReplicateSetNum: number
81
-
82
72
  /**
83
73
  * 项目ID,不设置为默认项目
84
74
  */
85
75
  ProjectId?: number
86
-
87
76
  /**
88
77
  * 私有网络 ID,如果不传则默认选择基础网络,请使用 查询私有网络列表
89
78
  */
90
79
  VpcId?: string
91
-
92
80
  /**
93
81
  * 私有网络下的子网 ID,如果设置了 UniqVpcId,则 UniqSubnetId 必填,请使用 查询子网列表
94
82
  */
95
83
  SubnetId?: string
96
-
97
84
  /**
98
85
  * 实例密码,不设置该参数则默认密码规则为 实例ID+"@"+主账户uin。举例实例id为cmgo-higv73ed,uin为100000001,则默认密码为"cmgo-higv73ed@100000001"。 自定义密码格式为8-32个字符长度,至少包含字母、数字和字符(!@#%^*()_)中的两种
99
86
  */
100
87
  Password?: string
101
-
102
88
  /**
103
89
  * 实例标签信息
104
90
  */
105
91
  Tags?: Array<TagInfo>
106
-
107
92
  /**
108
93
  * 自动续费标记,可选值为:0 - 不自动续费;1 - 自动续费。默认为不自动续费
109
94
  */
110
95
  AutoRenewFlag?: number
111
-
112
96
  /**
113
97
  * 是否自动选择代金券,可选值为:1 - 是;0 - 否; 默认为0
114
98
  */
115
99
  AutoVoucher?: number
116
-
117
100
  /**
118
101
  * 1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例
119
102
  */
120
103
  Clone?: number
121
-
122
104
  /**
123
105
  * 若是只读,灾备实例或克隆实例,Father必须填写,即主实例ID
124
106
  */
125
107
  Father?: string
126
-
127
108
  /**
128
109
  * 安全组
129
110
  */
130
111
  SecurityGroup?: Array<string>
131
-
132
112
  /**
133
113
  * 克隆实例回档时间。若是克隆实例,则必须填写,格式:2021-08-13 16:30:00。注:只能回档7天内的时间点
134
114
  */
135
115
  RestoreTime?: string
136
-
137
116
  /**
138
117
  * 实例名称。注:名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
139
118
  */
140
119
  InstanceName?: string
141
-
142
120
  /**
143
121
  * 多可用区部署的节点列表,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:1、多可用区部署节点只能部署在3个不同可用区;2、为了保障跨可用区切换,不支持将集群的大多数节点部署在同一个可用区(如3节点集群不支持2个节点部署在同一个区);3、不支持4.2及以上版本;4、不支持只读灾备实例;5、不能选择基础网络
144
122
  */
145
123
  AvailabilityZoneList?: Array<string>
146
-
147
124
  /**
148
125
  * mongos cpu数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
149
126
  */
150
127
  MongosCpu?: number
151
-
152
128
  /**
153
129
  * mongos 内存大小,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
154
130
  */
155
131
  MongosMemory?: number
156
-
157
132
  /**
158
133
  * mongos 数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:为了保障高可用,最低需要购买3个mongos,上限为32个
159
134
  */
160
135
  MongosNodeNum?: number
161
-
162
136
  /**
163
137
  * 只读节点数量,最大不超过7个
164
138
  */
165
139
  ReadonlyNodeNum?: number
166
-
167
140
  /**
168
141
  * 只读节点部署可用区
169
142
  */
170
143
  ReadonlyNodeAvailabilityZoneList?: Array<string>
171
-
172
144
  /**
173
145
  * Hidden节点所在的可用区,跨可用区实例必传
174
146
  */
@@ -183,12 +155,10 @@ export interface DescribeCurrentOpResponse {
183
155
  * 符合查询条件的操作总数
184
156
  */
185
157
  TotalCount: number
186
-
187
158
  /**
188
159
  * 当前操作列表
189
160
  */
190
161
  CurrentOps: Array<CurrentOp>
191
-
192
162
  /**
193
163
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
194
164
  */
@@ -213,7 +183,6 @@ export interface CreateBackupDBInstanceResponse {
213
183
  * 查询备份流程的状态。
214
184
  */
215
185
  AsyncRequestId?: string
216
-
217
186
  /**
218
187
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
219
188
  */
@@ -225,16 +194,14 @@ export interface CreateBackupDBInstanceResponse {
225
194
  */
226
195
  export interface DBInstancePrice {
227
196
  /**
228
- * 单价
197
+ * 单价
229
198
  注意:此字段可能返回 null,表示取不到有效值。
230
- */
199
+ */
231
200
  UnitPrice: number
232
-
233
201
  /**
234
202
  * 原价
235
203
  */
236
204
  OriginalPrice: number
237
-
238
205
  /**
239
206
  * 折扣加
240
207
  */
@@ -249,7 +216,6 @@ export interface KillOpsRequest {
249
216
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
250
217
  */
251
218
  InstanceId: string
252
-
253
219
  /**
254
220
  * 待终止的操作
255
221
  */
@@ -264,7 +230,6 @@ export interface InquirePriceRenewDBInstancesRequest {
264
230
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同,接口单次最多只支持5个实例进行操作。
265
231
  */
266
232
  InstanceIds: Array<string>
267
-
268
233
  /**
269
234
  * 预付费模式(即包年包月)相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
270
235
  */
@@ -279,32 +244,26 @@ export interface DescribeSlowLogsRequest {
279
244
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
280
245
  */
281
246
  InstanceId: string
282
-
283
247
  /**
284
248
  * 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
285
249
  */
286
250
  StartTime: string
287
-
288
251
  /**
289
252
  * 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
290
253
  */
291
254
  EndTime: string
292
-
293
255
  /**
294
256
  * 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
295
257
  */
296
258
  SlowMS: number
297
-
298
259
  /**
299
260
  * 偏移量,最小值为0,最大值为10000,默认值为0。
300
261
  */
301
262
  Offset?: number
302
-
303
263
  /**
304
264
  * 分页大小,最小值为1,最大值为100,默认值为20。
305
265
  */
306
266
  Limit?: number
307
-
308
267
  /**
309
268
  * 慢日志返回格式。默认返回原生慢日志格式,4.4及以上版本可设置为json。
310
269
  */
@@ -329,41 +288,34 @@ export interface InstanceMultiParam {
329
288
  * 参数当前值。
330
289
  */
331
290
  CurrentValue: string
332
-
333
291
  /**
334
292
  * 参数默认值。
335
293
  */
336
294
  DefaultValue: string
337
-
338
295
  /**
339
296
  * 参考值范围。
340
297
  */
341
298
  EnumValue: Array<string>
342
-
343
299
  /**
344
- * 参数修改后是否需要重启才会生效。
300
+ * 参数修改后是否需要重启才会生效。
345
301
  - 1:需要重启后生效。
346
302
  - 0:无需重启,设置成功即可生效。
347
- */
303
+ */
348
304
  NeedRestart: string
349
-
350
305
  /**
351
306
  * 参数名称。
352
307
  */
353
308
  ParamName: string
354
-
355
309
  /**
356
- * 是否为运行中参数值。
310
+ * 是否为运行中参数值。
357
311
  - 1:运行中参数值。
358
312
  - 0:非运行中参数值。
359
- */
313
+ */
360
314
  Status: number
361
-
362
315
  /**
363
316
  * 参数说明。
364
317
  */
365
318
  Tips: Array<string>
366
-
367
319
  /**
368
320
  * 当前值的类型描述,默认为multi。
369
321
  */
@@ -378,17 +330,14 @@ export interface SlowLogPattern {
378
330
  * 慢日志模式
379
331
  */
380
332
  Pattern: string
381
-
382
333
  /**
383
334
  * 最大执行时间
384
335
  */
385
336
  MaxTime: number
386
-
387
337
  /**
388
338
  * 平均执行时间
389
339
  */
390
340
  AverageTime: number
391
-
392
341
  /**
393
342
  * 该模式慢日志条数
394
343
  */
@@ -403,7 +352,6 @@ export interface AssignProjectResponse {
403
352
  * 返回的异步任务ID列表
404
353
  */
405
354
  FlowIds: Array<number>
406
-
407
355
  /**
408
356
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
409
357
  */
@@ -418,22 +366,18 @@ export interface DescribeDBInstanceDealResponse {
418
366
  * 订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
419
367
  */
420
368
  Status: number
421
-
422
369
  /**
423
370
  * 订单原价。
424
371
  */
425
372
  OriginalPrice: number
426
-
427
373
  /**
428
374
  * 订单折扣价格。
429
375
  */
430
376
  DiscountPrice: number
431
-
432
377
  /**
433
378
  * 订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
434
379
  */
435
380
  Action: string
436
-
437
381
  /**
438
382
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
439
383
  */
@@ -448,7 +392,6 @@ export interface OfflineIsolatedDBInstanceResponse {
448
392
  * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
449
393
  */
450
394
  AsyncRequestId: string
451
-
452
395
  /**
453
396
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
454
397
  */
@@ -463,7 +406,6 @@ export interface IsolateDBInstanceResponse {
463
406
  * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
464
407
  */
465
408
  AsyncRequestId: string
466
-
467
409
  /**
468
410
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
469
411
  */
@@ -488,12 +430,10 @@ export interface DescribeBackupDownloadTaskResponse {
488
430
  * 满足查询条件的所有条数
489
431
  */
490
432
  TotalCount: number
491
-
492
433
  /**
493
434
  * 下载任务列表
494
435
  */
495
436
  Tasks: Array<BackupDownloadTask>
496
-
497
437
  /**
498
438
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
499
439
  */
@@ -518,7 +458,6 @@ export interface DBInstanceInfo {
518
458
  * 实例ID
519
459
  */
520
460
  InstanceId: string
521
-
522
461
  /**
523
462
  * 地域信息
524
463
  */
@@ -533,7 +472,6 @@ export interface SetAccountUserPrivilegeResponse {
533
472
  * 任务ID。
534
473
  */
535
474
  FlowId?: number
536
-
537
475
  /**
538
476
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
539
477
  */
@@ -548,22 +486,18 @@ export interface ModifyDBInstanceNetworkAddressRequest {
548
486
  * 实例ID
549
487
  */
550
488
  InstanceId: string
551
-
552
489
  /**
553
490
  * 原IP保留时长,单位为分钟;原IP会在约定时间后释放,在释放前原IP和新IP均可访问;0表示立即回收原IP
554
491
  */
555
492
  OldIpExpiredTime: number
556
-
557
493
  /**
558
494
  * 切换后IP地址的归属私有网络统一ID,若为基础网络,该字段为空
559
495
  */
560
496
  NewUniqVpcId: string
561
-
562
497
  /**
563
498
  * 切换后IP地址的归属子网统一ID,若为基础网络,该字段为空
564
499
  */
565
500
  NewUniqSubnetId: string
566
-
567
501
  /**
568
502
  * 待修改IP信息
569
503
  */
@@ -578,12 +512,10 @@ export interface CreateDBInstanceHourResponse {
578
512
  * 订单ID。
579
513
  */
580
514
  DealId?: string
581
-
582
515
  /**
583
516
  * 创建的实例ID列表。
584
517
  */
585
518
  InstanceIds?: Array<string>
586
-
587
519
  /**
588
520
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
589
521
  */
@@ -598,34 +530,28 @@ export interface DescribeDBInstanceNodePropertyRequest {
598
530
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
599
531
  */
600
532
  InstanceId: string
601
-
602
533
  /**
603
534
  * 节点ID。
604
535
  */
605
536
  NodeIds?: Array<string>
606
-
607
537
  /**
608
- * 节点角色。可选值包括:
538
+ * 节点角色。可选值包括:
609
539
  <ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>
610
- */
540
+ */
611
541
  Roles?: Array<string>
612
-
613
542
  /**
614
543
  * 该参数指定节点是否为Hidden节点,默认为false。
615
544
  */
616
545
  OnlyHidden?: boolean
617
-
618
546
  /**
619
547
  * 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
620
548
  */
621
549
  Priority?: number
622
-
623
550
  /**
624
- * 该参数指定节点投票权。
551
+ * 该参数指定节点投票权。
625
552
  <ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>
626
- */
553
+ */
627
554
  Votes?: number
628
-
629
555
  /**
630
556
  * 节点标签。
631
557
  */
@@ -637,16 +563,14 @@ export interface DescribeDBInstanceNodePropertyRequest {
637
563
  */
638
564
  export interface DeleteAccountUserRequest {
639
565
  /**
640
- * 指定待删除账号的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
566
+ * 指定待删除账号的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
641
567
 
642
- */
568
+ */
643
569
  InstanceId: string
644
-
645
570
  /**
646
571
  * 配置待删除的账号名。
647
572
  */
648
573
  UserName: string
649
-
650
574
  /**
651
575
  * 配置 mongouser 对应的密码。mongouser为系统默认账号,输入其对应的密码。
652
576
  */
@@ -661,102 +585,82 @@ export interface SpecItem {
661
585
  * 规格信息标识
662
586
  */
663
587
  SpecCode: string
664
-
665
588
  /**
666
589
  * 规格有效标志,取值:0-停止售卖,1-开放售卖
667
590
  */
668
591
  Status: number
669
-
670
592
  /**
671
593
  * 计算资源规格,单位为CPU核心数
672
594
  */
673
595
  Cpu: number
674
-
675
596
  /**
676
597
  * 内存规格,单位为MB
677
598
  */
678
599
  Memory: number
679
-
680
600
  /**
681
601
  * 默认磁盘规格,单位MB
682
602
  */
683
603
  DefaultStorage: number
684
-
685
604
  /**
686
605
  * 最大磁盘规格,单位MB
687
606
  */
688
607
  MaxStorage: number
689
-
690
608
  /**
691
609
  * 最小磁盘规格,单位MB
692
610
  */
693
611
  MinStorage: number
694
-
695
612
  /**
696
613
  * 可承载qps信息
697
614
  */
698
615
  Qps: number
699
-
700
616
  /**
701
617
  * 连接数限制
702
618
  */
703
619
  Conns: number
704
-
705
620
  /**
706
621
  * 实例mongodb版本信息
707
622
  */
708
623
  MongoVersionCode: string
709
-
710
624
  /**
711
625
  * 实例mongodb版本号
712
626
  */
713
627
  MongoVersionValue: number
714
-
715
628
  /**
716
629
  * 实例mongodb版本号(短)
717
630
  */
718
631
  Version: string
719
-
720
632
  /**
721
633
  * 存储引擎
722
634
  */
723
635
  EngineName: string
724
-
725
636
  /**
726
637
  * 集群类型,取值:1-分片集群,0-副本集集群
727
638
  */
728
639
  ClusterType: number
729
-
730
640
  /**
731
641
  * 最小副本集从节点数
732
642
  */
733
643
  MinNodeNum: number
734
-
735
644
  /**
736
645
  * 最大副本集从节点数
737
646
  */
738
647
  MaxNodeNum: number
739
-
740
648
  /**
741
649
  * 最小分片数
742
650
  */
743
651
  MinReplicateSetNum: number
744
-
745
652
  /**
746
653
  * 最大分片数
747
654
  */
748
655
  MaxReplicateSetNum: number
749
-
750
656
  /**
751
657
  * 最小分片从节点数
752
658
  */
753
659
  MinReplicateSetNodeNum: number
754
-
755
660
  /**
756
661
  * 最大分片从节点数
757
662
  */
758
663
  MaxReplicateSetNodeNum: number
759
-
760
664
  /**
761
665
  * 机器类型,取值:0-HIO,4-HIO10G
762
666
  */
@@ -781,7 +685,6 @@ export interface CreateAccountUserResponse {
781
685
  * 创建任务ID。
782
686
  */
783
687
  FlowId?: number
784
-
785
688
  /**
786
689
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
787
690
  */
@@ -796,12 +699,10 @@ export interface DescribeSlowLogPatternsResponse {
796
699
  * 慢日志统计信息总数
797
700
  */
798
701
  Count: number
799
-
800
702
  /**
801
703
  * 慢日志统计信息
802
704
  */
803
705
  SlowLogPatterns: Array<SlowLogPattern>
804
-
805
706
  /**
806
707
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
807
708
  */
@@ -816,7 +717,6 @@ export interface BackupDownloadTaskStatus {
816
717
  * 分片名
817
718
  */
818
719
  ReplicaSetId: string
819
-
820
720
  /**
821
721
  * 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
822
722
  */
@@ -831,13 +731,11 @@ export interface DescribeSlowLogsResponse {
831
731
  * 慢日志总数
832
732
  */
833
733
  Count?: number
834
-
835
734
  /**
836
- * 慢日志详情
735
+ * 慢日志详情
837
736
  注意:此字段可能返回 null,表示取不到有效值。
838
- */
737
+ */
839
738
  SlowLogs?: Array<string>
840
-
841
739
  /**
842
740
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
843
741
  */
@@ -852,22 +750,18 @@ export interface InquirePriceModifyDBInstanceSpecRequest {
852
750
  * 实例 ID,格式如:cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。
853
751
  */
854
752
  InstanceId: string
855
-
856
753
  /**
857
754
  * 变更配置后实例内存大小,单位:GB。
858
755
  */
859
756
  Memory: number
860
-
861
757
  /**
862
758
  * 变更配置后实例磁盘大小,单位:GB。
863
759
  */
864
760
  Volume: number
865
-
866
761
  /**
867
762
  * 实例节点数。默认为不变更节点数,暂不支持变更。
868
763
  */
869
764
  NodeNum?: number
870
-
871
765
  /**
872
766
  * 实例分片数。默认为不变更分片数,暂不支持变更。
873
767
  */
@@ -882,46 +776,38 @@ export interface BackupInfo {
882
776
  * 实例ID
883
777
  */
884
778
  InstanceId: string
885
-
886
779
  /**
887
780
  * 备份方式,0-自动备份,1-手动备份
888
781
  */
889
782
  BackupType: number
890
-
891
783
  /**
892
784
  * 备份名称
893
785
  */
894
786
  BackupName: string
895
-
896
787
  /**
897
- * 备份备注
788
+ * 备份备注
898
789
  注意:此字段可能返回 null,表示取不到有效值。
899
- */
790
+ */
900
791
  BackupDesc: string
901
-
902
792
  /**
903
- * 备份文件大小,单位KB
793
+ * 备份文件大小,单位KB
904
794
  注意:此字段可能返回 null,表示取不到有效值。
905
- */
795
+ */
906
796
  BackupSize: number
907
-
908
797
  /**
909
- * 备份开始时间
798
+ * 备份开始时间
910
799
  注意:此字段可能返回 null,表示取不到有效值。
911
- */
800
+ */
912
801
  StartTime: string
913
-
914
802
  /**
915
- * 备份结束时间
803
+ * 备份结束时间
916
804
  注意:此字段可能返回 null,表示取不到有效值。
917
- */
805
+ */
918
806
  EndTime: string
919
-
920
807
  /**
921
808
  * 备份状态,1-备份中,2-备份成功
922
809
  */
923
810
  Status: number
924
-
925
811
  /**
926
812
  * 备份方法,0-逻辑备份,1-物理备份
927
813
  */
@@ -936,73 +822,60 @@ export interface DescribeDBInstancesRequest {
936
822
  * 实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
937
823
  */
938
824
  InstanceIds?: Array<string>
939
-
940
825
  /**
941
826
  * 实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>2:临时实例。</li><li>3:只读实例。</li><li>-1:正式实例、只读、灾备实例。</li></ul>
942
827
  */
943
828
  InstanceType?: number
944
-
945
829
  /**
946
830
  * 集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:所有实例。</li></ul>
947
831
  */
948
832
  ClusterType?: number
949
-
950
833
  /**
951
834
  * 实例状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程执行中。</li><li>2:实例有效。</li><li>-2:已隔离(包年包月实例)。</li><li>-3:已隔离(按量计费实例)。</li></ul>
952
835
  */
953
836
  Status?: Array<number>
954
-
955
837
  /**
956
- * 私有网络的 ID。
838
+ * 私有网络的 ID。
957
839
  - 基础网络则无需配置该参数。
958
840
  - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其 ID。
959
- */
841
+ */
960
842
  VpcId?: string
961
-
962
843
  /**
963
- * 私有网络的子网ID。
844
+ * 私有网络的子网ID。
964
845
  - 基础网络则无需配置该参数。
965
846
  - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其子网 ID。
966
- */
847
+ */
967
848
  SubnetId?: string
968
-
969
849
  /**
970
850
  * 付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>
971
851
  */
972
852
  PayMode?: number
973
-
974
853
  /**
975
854
  * 单次请求返回的数量。默认值为20,取值范围为[1,100]。
976
855
  */
977
856
  Limit?: number
978
-
979
857
  /**
980
858
  * 偏移量,默认值为0。
981
859
  */
982
860
  Offset?: number
983
-
984
861
  /**
985
862
  * 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
986
863
  */
987
864
  OrderBy?: string
988
-
989
865
  /**
990
- * 配置返回结果的排序方式。
866
+ * 配置返回结果的排序方式。
991
867
  - ASC:升序。
992
868
  - DESC:降序。
993
- */
869
+ */
994
870
  OrderByType?: string
995
-
996
871
  /**
997
872
  * 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在右上角的账户信息下拉菜单中,选择项目管理查询项目。
998
873
  */
999
874
  ProjectIds?: Array<number>
1000
-
1001
875
  /**
1002
876
  * 配置查询搜索的关键词。支持配置为实例ID、实例名称或者内网 IP 地址。
1003
877
  */
1004
878
  SearchKey?: string
1005
-
1006
879
  /**
1007
880
  * 标签信息,包含标签键与标签值。
1008
881
  */
@@ -1014,55 +887,47 @@ export interface DescribeDBInstancesRequest {
1014
887
  */
1015
888
  export interface CurrentOp {
1016
889
  /**
1017
- * 操作序号
890
+ * 操作序号
1018
891
  注意:此字段可能返回 null,表示取不到有效值。
1019
- */
892
+ */
1020
893
  OpId: number
1021
-
1022
894
  /**
1023
- * 操作所在的命名空间,形式如db.collection
895
+ * 操作所在的命名空间,形式如db.collection
1024
896
  注意:此字段可能返回 null,表示取不到有效值。
1025
- */
897
+ */
1026
898
  Ns: string
1027
-
1028
899
  /**
1029
- * 操作执行语句
900
+ * 操作执行语句
1030
901
  注意:此字段可能返回 null,表示取不到有效值。
1031
- */
902
+ */
1032
903
  Query: string
1033
-
1034
904
  /**
1035
- * 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
905
+ * 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
1036
906
  注意:此字段可能返回 null,表示取不到有效值。
1037
- */
907
+ */
1038
908
  Op: string
1039
-
1040
909
  /**
1041
910
  * 操作所在的分片名称
1042
911
  */
1043
912
  ReplicaSetName: string
1044
-
1045
913
  /**
1046
- * 筛选条件,节点状态,可能的取值为:Primary、Secondary
914
+ * 筛选条件,节点状态,可能的取值为:Primary、Secondary
1047
915
  注意:此字段可能返回 null,表示取不到有效值。
1048
- */
916
+ */
1049
917
  State: string
1050
-
1051
918
  /**
1052
- * 操作详细信息
919
+ * 操作详细信息
1053
920
  注意:此字段可能返回 null,表示取不到有效值。
1054
- */
921
+ */
1055
922
  Operation: string
1056
-
1057
923
  /**
1058
924
  * 操作所在的节点名称
1059
925
  */
1060
926
  NodeName: string
1061
-
1062
927
  /**
1063
- * 操作已执行时间(ms)
928
+ * 操作已执行时间(ms)
1064
929
  注意:此字段可能返回 null,表示取不到有效值。
1065
- */
930
+ */
1066
931
  MicrosecsRunning: number
1067
932
  }
1068
933
 
@@ -1074,32 +939,26 @@ export interface ModifyDBInstanceSpecRequest {
1074
939
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1075
940
  */
1076
941
  InstanceId: string
1077
-
1078
942
  /**
1079
943
  * 实例配置变更后的内存大小,单位:GB。内存和磁盘必须同时升配或同时降配
1080
944
  */
1081
945
  Memory: number
1082
-
1083
946
  /**
1084
947
  * 实例配置变更后的硬盘大小,单位:GB。内存和磁盘必须同时升配或同时降配。降配时,新的磁盘参数必须大于已用磁盘容量的1.2倍
1085
948
  */
1086
949
  Volume: number
1087
-
1088
950
  /**
1089
951
  * 实例配置变更后oplog的大小,单位:GB,默认为磁盘空间的10%,允许设置的最小值为磁盘的10%,最大值为磁盘的90%
1090
952
  */
1091
953
  OplogSize?: number
1092
-
1093
954
  /**
1094
955
  * 实例变更后的节点数,取值范围具体参照查询云数据库的售卖规格返回参数。默认为不变更节点数
1095
956
  */
1096
957
  NodeNum?: number
1097
-
1098
958
  /**
1099
959
  * 实例变更后的分片数,取值范围具体参照查询云数据库的售卖规格返回参数。只能增加不能减少,默认为不变更分片数
1100
960
  */
1101
961
  ReplicateSetNum?: number
1102
-
1103
962
  /**
1104
963
  * 实例配置变更的切换时间,参数为:0(默认)、1。0-调整完成时,1-维护时间内。注:调整节点数和分片数不支持在【维护时间内】变更。
1105
964
  */
@@ -1114,11 +973,10 @@ export interface Auth {
1114
973
  * 当前账号具有的权限信息。<ul><li>0:无权限。</li><li>1:只读。</li><li>2:只写。</li><li>3:读写。</li></ul>
1115
974
  */
1116
975
  Mask: number
1117
-
1118
976
  /**
1119
- * 指具有当前账号权限的数据库名。
977
+ * 指具有当前账号权限的数据库名。
1120
978
  <ul><li>* :表示所有数据库。</li><li>db.name:表示特定name的数据库。</li></ul>
1121
- */
979
+ */
1122
980
  NameSpace: string
1123
981
  }
1124
982
 
@@ -1130,12 +988,10 @@ export interface ResetDBInstancePasswordRequest {
1130
988
  * 实例Id
1131
989
  */
1132
990
  InstanceId: string
1133
-
1134
991
  /**
1135
992
  * 实例账号名
1136
993
  */
1137
994
  UserName: string
1138
-
1139
995
  /**
1140
996
  * 新密码,新密码长度不能少于8位
1141
997
  */
@@ -1150,51 +1006,42 @@ export interface InstanceIntegerParam {
1150
1006
  * 参数当前值。
1151
1007
  */
1152
1008
  CurrentValue: string
1153
-
1154
1009
  /**
1155
1010
  * 参数默认值。
1156
1011
  */
1157
1012
  DefaultValue: string
1158
-
1159
1013
  /**
1160
1014
  * 参数最大值。
1161
1015
  */
1162
1016
  Max: string
1163
-
1164
1017
  /**
1165
1018
  * 最小值。
1166
1019
  */
1167
1020
  Min: string
1168
-
1169
1021
  /**
1170
- * 参数修改之后是否需要重启生效。
1022
+ * 参数修改之后是否需要重启生效。
1171
1023
  - 1:需要重启后生效。
1172
1024
  - 0:无需重启,设置成功即可生效。
1173
- */
1025
+ */
1174
1026
  NeedRestart: string
1175
-
1176
1027
  /**
1177
1028
  * 参数名称。
1178
1029
  */
1179
1030
  ParamName: string
1180
-
1181
1031
  /**
1182
1032
  * 参数说明。
1183
1033
  */
1184
1034
  Tips: Array<string>
1185
-
1186
1035
  /**
1187
1036
  * 参数类型。
1188
1037
  */
1189
1038
  ValueType: string
1190
-
1191
1039
  /**
1192
- * 是否为运行中参数值。
1040
+ * 是否为运行中参数值。
1193
1041
  - 1:运行中参数值。
1194
1042
  - 0:非运行中参数值。
1195
- */
1043
+ */
1196
1044
  Status: number
1197
-
1198
1045
  /**
1199
1046
  * 冗余字段,可忽略。
1200
1047
  */
@@ -1209,7 +1056,6 @@ export interface ModifyNetworkAddress {
1209
1056
  * 新IP地址。
1210
1057
  */
1211
1058
  NewIPAddress: string
1212
-
1213
1059
  /**
1214
1060
  * 原IP地址。
1215
1061
  */
@@ -1224,7 +1070,6 @@ export interface DescribeAsyncRequestInfoResponse {
1224
1070
  * 状态。返回参数有:initial-初始化、running-运行中、paused-任务执行失败,已暂停、undoed-任务执行失败,已回滚、failed-任务执行失败, 已终止、success-成功
1225
1071
  */
1226
1072
  Status: string
1227
-
1228
1073
  /**
1229
1074
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1230
1075
  */
@@ -1239,12 +1084,10 @@ export interface CreateDBInstanceResponse {
1239
1084
  * 订单ID
1240
1085
  */
1241
1086
  DealId: string
1242
-
1243
1087
  /**
1244
1088
  * 创建的实例ID列表
1245
1089
  */
1246
1090
  InstanceIds: Array<string>
1247
-
1248
1091
  /**
1249
1092
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1250
1093
  */
@@ -1259,27 +1102,22 @@ export interface CreateAccountUserRequest {
1259
1102
  * 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1260
1103
  */
1261
1104
  InstanceId: string
1262
-
1263
1105
  /**
1264
1106
  * 新账号名称。其格式要求如下:<ul><li>字符范围[1,32]。</li><li>可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。</li></ul>
1265
1107
  */
1266
1108
  UserName: string
1267
-
1268
1109
  /**
1269
1110
  * 新账号密码。密码复杂度要求如下:<ul><li>字符长度范围[8,32]。</li><li>至少包含字母、数字和特殊字符(叹号“!”、at"@"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。</li></ul>
1270
1111
  */
1271
1112
  Password: string
1272
-
1273
1113
  /**
1274
1114
  * mongouser 账号对应的密码。mongouser 为系统默认账号,即为创建实例时,设置的密码。
1275
1115
  */
1276
1116
  MongoUserPassword: string
1277
-
1278
1117
  /**
1279
1118
  * 账号备注信息。
1280
1119
  */
1281
1120
  UserDesc?: string
1282
-
1283
1121
  /**
1284
1122
  * 账号的读写权限信息。
1285
1123
  */
@@ -1294,42 +1132,35 @@ export interface InstanceTextParam {
1294
1132
  * 参数当前值。
1295
1133
  */
1296
1134
  CurrentValue: string
1297
-
1298
1135
  /**
1299
1136
  * 参数默认值。
1300
1137
  */
1301
1138
  DefaultValue: string
1302
-
1303
1139
  /**
1304
1140
  * 修改参数值之后是否需要重启。
1305
1141
  */
1306
1142
  NeedRestart: string
1307
-
1308
1143
  /**
1309
1144
  * 参数名称。
1310
1145
  */
1311
1146
  ParamName: string
1312
-
1313
1147
  /**
1314
1148
  * Text 类型参数对应的值。
1315
1149
  */
1316
1150
  TextValue: string
1317
-
1318
1151
  /**
1319
1152
  * 参数说明。
1320
1153
  */
1321
1154
  Tips: Array<string>
1322
-
1323
1155
  /**
1324
1156
  * 参数值类型说明。
1325
1157
  */
1326
1158
  ValueType: string
1327
-
1328
1159
  /**
1329
- * 是否为运行中的参数值。
1160
+ * 是否为运行中的参数值。
1330
1161
  - 1:运行中参数值。
1331
1162
  - 0:非运行中参数值。
1332
- */
1163
+ */
1333
1164
  Status: string
1334
1165
  }
1335
1166
 
@@ -1341,7 +1172,6 @@ export interface ModifyDBInstanceSecurityGroupRequest {
1341
1172
  * 实例 ID。例如:cmgo-7pje****。
1342
1173
  */
1343
1174
  InstanceId: string
1344
-
1345
1175
  /**
1346
1176
  * 目标安全组 ID。请通过接口[DescribeSecurityGroup](https://cloud.tencent.com/document/product/240/55675)查看具体的安全组 ID。
1347
1177
  */
@@ -1356,7 +1186,6 @@ export interface DescribeAccountUsersResponse {
1356
1186
  * 实例账号列表。
1357
1187
  */
1358
1188
  Users?: Array<UserInfo>
1359
-
1360
1189
  /**
1361
1190
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1362
1191
  */
@@ -1371,42 +1200,34 @@ export interface DescribeBackupDownloadTaskRequest {
1371
1200
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1372
1201
  */
1373
1202
  InstanceId: string
1374
-
1375
1203
  /**
1376
1204
  * 备份文件名,用来过滤指定文件的下载任务
1377
1205
  */
1378
1206
  BackupName?: string
1379
-
1380
1207
  /**
1381
1208
  * 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
1382
1209
  */
1383
1210
  StartTime?: string
1384
-
1385
1211
  /**
1386
1212
  * 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
1387
1213
  */
1388
1214
  EndTime?: string
1389
-
1390
1215
  /**
1391
1216
  * 此次查询返回的条数,取值范围为1-100,默认为20
1392
1217
  */
1393
1218
  Limit?: number
1394
-
1395
1219
  /**
1396
1220
  * 指定此次查询返回的页数,默认为0
1397
1221
  */
1398
1222
  Offset?: number
1399
-
1400
1223
  /**
1401
1224
  * 排序字段,取值为createTime,finishTime两种,默认为createTime
1402
1225
  */
1403
1226
  OrderBy?: string
1404
-
1405
1227
  /**
1406
1228
  * 排序方式,取值为asc,desc两种,默认desc
1407
1229
  */
1408
1230
  OrderByType?: string
1409
-
1410
1231
  /**
1411
1232
  * 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
1412
1233
  */
@@ -1421,12 +1242,10 @@ export interface Operation {
1421
1242
  * 操作所在的分片名
1422
1243
  */
1423
1244
  ReplicaSetName: string
1424
-
1425
1245
  /**
1426
1246
  * 操作所在的节点名
1427
1247
  */
1428
1248
  NodeName: string
1429
-
1430
1249
  /**
1431
1250
  * 操作序号
1432
1251
  */
@@ -1441,12 +1260,10 @@ export interface DescribeClientConnectionsResponse {
1441
1260
  * 客户端连接信息,包括客户端 IP 和对应 IP 的连接数量。
1442
1261
  */
1443
1262
  Clients?: Array<ClientConnection>
1444
-
1445
1263
  /**
1446
1264
  * 满足条件的记录总条数,可用于分页查询。
1447
1265
  */
1448
1266
  TotalCount?: number
1449
-
1450
1267
  /**
1451
1268
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1452
1269
  */
@@ -1471,12 +1288,10 @@ export interface DescribeDBBackupsResponse {
1471
1288
  * 备份列表
1472
1289
  */
1473
1290
  BackupList: Array<BackupInfo>
1474
-
1475
1291
  /**
1476
1292
  * 备份总数
1477
1293
  */
1478
1294
  TotalCount: number
1479
-
1480
1295
  /**
1481
1296
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1482
1297
  */
@@ -1501,22 +1316,18 @@ export interface UserInfo {
1501
1316
  * 账号名。
1502
1317
  */
1503
1318
  UserName: string
1504
-
1505
1319
  /**
1506
1320
  * 账号权限详情。
1507
1321
  */
1508
1322
  AuthRole: Array<Auth>
1509
-
1510
1323
  /**
1511
1324
  * 账号创建时间。
1512
1325
  */
1513
1326
  CreateTime: string
1514
-
1515
1327
  /**
1516
1328
  * 账号更新时间。
1517
1329
  */
1518
1330
  UpdateTime: string
1519
-
1520
1331
  /**
1521
1332
  * 备注信息。
1522
1333
  */
@@ -1538,15 +1349,14 @@ export interface DescribeInstanceParamsRequest {
1538
1349
  */
1539
1350
  export interface NodeTag {
1540
1351
  /**
1541
- * 节点Tag key
1352
+ * 节点Tag key
1542
1353
  注意:此字段可能返回 null,表示取不到有效值。
1543
- */
1354
+ */
1544
1355
  TagKey?: string
1545
-
1546
1356
  /**
1547
- * 节点Tag Value
1357
+ * 节点Tag Value
1548
1358
  注意:此字段可能返回 null,表示取不到有效值。
1549
- */
1359
+ */
1550
1360
  TagValue?: string
1551
1361
  }
1552
1362
 
@@ -1558,7 +1368,6 @@ export interface InquirePriceCreateDBInstancesResponse {
1558
1368
  * 价格
1559
1369
  */
1560
1370
  Price: DBInstancePrice
1561
-
1562
1371
  /**
1563
1372
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1564
1373
  */
@@ -1573,7 +1382,6 @@ export interface DescribeSecurityGroupResponse {
1573
1382
  * 实例绑定的安全组信息。
1574
1383
  */
1575
1384
  Groups?: Array<SecurityGroup>
1576
-
1577
1385
  /**
1578
1386
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1579
1387
  */
@@ -1588,32 +1396,26 @@ export interface SecurityGroup {
1588
1396
  * 所属项目id
1589
1397
  */
1590
1398
  ProjectId: number
1591
-
1592
1399
  /**
1593
1400
  * 创建时间
1594
1401
  */
1595
1402
  CreateTime: string
1596
-
1597
1403
  /**
1598
1404
  * 入站规则
1599
1405
  */
1600
1406
  Inbound: Array<SecurityGroupBound>
1601
-
1602
1407
  /**
1603
1408
  * 出站规则
1604
1409
  */
1605
1410
  Outbound: Array<SecurityGroupBound>
1606
-
1607
1411
  /**
1608
1412
  * 安全组id
1609
1413
  */
1610
1414
  SecurityGroupId: string
1611
-
1612
1415
  /**
1613
1416
  * 安全组名称
1614
1417
  */
1615
1418
  SecurityGroupName: string
1616
-
1617
1419
  /**
1618
1420
  * 安全组备注
1619
1421
  */
@@ -1638,7 +1440,6 @@ export interface ResetDBInstancePasswordResponse {
1638
1440
  * 异步请求Id,用户查询该流程的运行状态
1639
1441
  */
1640
1442
  AsyncRequestId: string
1641
-
1642
1443
  /**
1643
1444
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1644
1445
  */
@@ -1653,12 +1454,10 @@ export interface ClientConnection {
1653
1454
  * 连接的客户端IP
1654
1455
  */
1655
1456
  IP: string
1656
-
1657
1457
  /**
1658
1458
  * 对应客户端IP的连接数
1659
1459
  */
1660
1460
  Count: number
1661
-
1662
1461
  /**
1663
1462
  * 是否为内部ip
1664
1463
  */
@@ -1670,9 +1469,9 @@ export interface ClientConnection {
1670
1469
  */
1671
1470
  export interface ReplicateSetInfo {
1672
1471
  /**
1673
- * 节点属性
1472
+ * 节点属性
1674
1473
  注意:此字段可能返回 null,表示取不到有效值。
1675
- */
1474
+ */
1676
1475
  Nodes: Array<NodeProperty>
1677
1476
  }
1678
1477
 
@@ -1704,17 +1503,15 @@ export interface CreateBackupDownloadTaskRequest {
1704
1503
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
1705
1504
  */
1706
1505
  InstanceId: string
1707
-
1708
1506
  /**
1709
1507
  * 要下载的备份文件名,可通过DescribeDBBackups接口获取。
1710
1508
  */
1711
1509
  BackupName: string
1712
-
1713
1510
  /**
1714
- * 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
1511
+ * 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
1715
1512
  如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
1716
1513
  如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。
1717
- */
1514
+ */
1718
1515
  BackupSets: Array<ReplicaSetInfo>
1719
1516
  }
1720
1517
 
@@ -1726,7 +1523,6 @@ export interface InquirePriceModifyDBInstanceSpecResponse {
1726
1523
  * 价格。
1727
1524
  */
1728
1525
  Price?: DBInstancePrice
1729
-
1730
1526
  /**
1731
1527
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1732
1528
  */
@@ -1741,37 +1537,30 @@ export interface SecurityGroupBound {
1741
1537
  * 执行规则。ACCEPT或DROP
1742
1538
  */
1743
1539
  Action: string
1744
-
1745
1540
  /**
1746
1541
  * ip段。
1747
1542
  */
1748
1543
  CidrIp: string
1749
-
1750
1544
  /**
1751
1545
  * 端口范围
1752
1546
  */
1753
1547
  PortRange: string
1754
-
1755
1548
  /**
1756
1549
  * 传输层协议。tcp,udp或ALL
1757
1550
  */
1758
1551
  IpProtocol: string
1759
-
1760
1552
  /**
1761
1553
  * 安全组id代表的地址集合
1762
1554
  */
1763
1555
  Id: string
1764
-
1765
1556
  /**
1766
1557
  * 地址组id代表的地址集合
1767
1558
  */
1768
1559
  AddressModule: string
1769
-
1770
1560
  /**
1771
1561
  * 服务组id代表的协议和端口集合
1772
1562
  */
1773
1563
  ServiceModule: string
1774
-
1775
1564
  /**
1776
1565
  * 描述
1777
1566
  */
@@ -1783,16 +1572,14 @@ export interface SecurityGroupBound {
1783
1572
  */
1784
1573
  export interface DescribeDBInstanceNodePropertyResponse {
1785
1574
  /**
1786
- * Mongos节点属性。
1575
+ * Mongos节点属性。
1787
1576
  注意:此字段可能返回 null,表示取不到有效值。
1788
- */
1577
+ */
1789
1578
  Mongos: Array<NodeProperty>
1790
-
1791
1579
  /**
1792
1580
  * 副本集节点信息。
1793
1581
  */
1794
1582
  ReplicateSets: Array<ReplicateSetInfo>
1795
-
1796
1583
  /**
1797
1584
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1798
1585
  */
@@ -1807,48 +1594,39 @@ export interface DescribeCurrentOpRequest {
1807
1594
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1808
1595
  */
1809
1596
  InstanceId: string
1810
-
1811
1597
  /**
1812
1598
  * 筛选条件,操作所属的命名空间namespace,格式为db.collection
1813
1599
  */
1814
1600
  Ns?: string
1815
-
1816
1601
  /**
1817
1602
  * 筛选条件,操作已经执行的时间(单位:毫秒),结果将返回超过设置时间的操作,默认值为0,取值范围为[0, 3600000]
1818
1603
  */
1819
1604
  MillisecondRunning?: number
1820
-
1821
1605
  /**
1822
1606
  * 筛选条件,操作类型,可能的取值:none,update,insert,query,command,getmore,remove和killcursors
1823
1607
  */
1824
1608
  Op?: string
1825
-
1826
1609
  /**
1827
1610
  * 筛选条件,分片名称
1828
1611
  */
1829
1612
  ReplicaSetName?: string
1830
-
1831
1613
  /**
1832
- * 筛选条件,节点状态,可能的取值为:primary
1614
+ * 筛选条件,节点状态,可能的取值为:primary
1833
1615
  secondary
1834
- */
1616
+ */
1835
1617
  State?: string
1836
-
1837
1618
  /**
1838
1619
  * 单次请求返回的数量,默认值为100,取值范围为[0,100]
1839
1620
  */
1840
1621
  Limit?: number
1841
-
1842
1622
  /**
1843
1623
  * 偏移量,默认值为0,取值范围为[0,10000]
1844
1624
  */
1845
1625
  Offset?: number
1846
-
1847
1626
  /**
1848
1627
  * 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
1849
1628
  */
1850
1629
  OrderBy?: string
1851
-
1852
1630
  /**
1853
1631
  * 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
1854
1632
  */
@@ -1863,51 +1641,42 @@ export interface BackupDownloadTask {
1863
1641
  * 任务创建时间
1864
1642
  */
1865
1643
  CreateTime: string
1866
-
1867
1644
  /**
1868
1645
  * 备份文件名
1869
1646
  */
1870
1647
  BackupName: string
1871
-
1872
1648
  /**
1873
1649
  * 分片名称
1874
1650
  */
1875
1651
  ReplicaSetId: string
1876
-
1877
1652
  /**
1878
1653
  * 备份数据大小,单位为字节
1879
1654
  */
1880
1655
  BackupSize: number
1881
-
1882
1656
  /**
1883
1657
  * 任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
1884
1658
  */
1885
1659
  Status: number
1886
-
1887
1660
  /**
1888
1661
  * 任务进度百分比
1889
1662
  */
1890
1663
  Percent: number
1891
-
1892
1664
  /**
1893
1665
  * 耗时,单位为秒
1894
1666
  */
1895
1667
  TimeSpend: number
1896
-
1897
1668
  /**
1898
1669
  * 备份数据下载链接
1899
1670
  */
1900
1671
  Url: string
1901
-
1902
1672
  /**
1903
1673
  * 备份文件备份类型,0-逻辑备份,1-物理备份
1904
1674
  */
1905
1675
  BackupMethod: number
1906
-
1907
1676
  /**
1908
- * 发起备份时指定的备注信息
1677
+ * 发起备份时指定的备注信息
1909
1678
  注意:此字段可能返回 null,表示取不到有效值。
1910
- */
1679
+ */
1911
1680
  BackupDesc: string
1912
1681
  }
1913
1682
 
@@ -1919,17 +1688,14 @@ export interface DescribeDBBackupsRequest {
1919
1688
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1920
1689
  */
1921
1690
  InstanceId: string
1922
-
1923
1691
  /**
1924
1692
  * 备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。
1925
1693
  */
1926
1694
  BackupMethod?: number
1927
-
1928
1695
  /**
1929
1696
  * 分页大小,最大值为100,不设置默认查询所有。
1930
1697
  */
1931
1698
  Limit?: number
1932
-
1933
1699
  /**
1934
1700
  * 分页偏移量,最小值为0,默认值为0。
1935
1701
  */
@@ -1941,16 +1707,14 @@ export interface DescribeDBBackupsRequest {
1941
1707
  */
1942
1708
  export interface DescribeClientConnectionsRequest {
1943
1709
  /**
1944
- * 指定待查询的实例ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1710
+ * 指定待查询的实例ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
1945
1711
 
1946
- */
1712
+ */
1947
1713
  InstanceId: string
1948
-
1949
1714
  /**
1950
1715
  * 单次请求返回的数量。最小值为1,最大值为1000,默认值为1000。
1951
1716
  */
1952
1717
  Limit?: number
1953
-
1954
1718
  /**
1955
1719
  * 偏移量,默认值为0。Offset=Limit*(页码-1)。
1956
1720
  */
@@ -1965,37 +1729,30 @@ export interface ShardInfo {
1965
1729
  * 分片已使用容量
1966
1730
  */
1967
1731
  UsedVolume: number
1968
-
1969
1732
  /**
1970
1733
  * 分片ID
1971
1734
  */
1972
1735
  ReplicaSetId: string
1973
-
1974
1736
  /**
1975
1737
  * 分片名
1976
1738
  */
1977
1739
  ReplicaSetName: string
1978
-
1979
1740
  /**
1980
1741
  * 分片内存规格,单位为MB
1981
1742
  */
1982
1743
  Memory: number
1983
-
1984
1744
  /**
1985
1745
  * 分片磁盘规格,单位为MB
1986
1746
  */
1987
1747
  Volume: number
1988
-
1989
1748
  /**
1990
1749
  * 分片Oplog大小,单位为MB
1991
1750
  */
1992
1751
  OplogSize: number
1993
-
1994
1752
  /**
1995
1753
  * 分片从节点数
1996
1754
  */
1997
1755
  SecondaryNum: number
1998
-
1999
1756
  /**
2000
1757
  * 分片物理id
2001
1758
  */
@@ -2020,7 +1777,6 @@ export interface RenameInstanceRequest {
2020
1777
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2021
1778
  */
2022
1779
  InstanceId: string
2023
-
2024
1780
  /**
2025
1781
  * 自定义实例名称,名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符 -
2026
1782
  */
@@ -2045,44 +1801,37 @@ export interface InstanceEnumParam {
2045
1801
  * 参数当前值。
2046
1802
  */
2047
1803
  CurrentValue: string
2048
-
2049
1804
  /**
2050
1805
  * 参数默认值。
2051
1806
  */
2052
1807
  DefaultValue: string
2053
-
2054
1808
  /**
2055
1809
  * 枚举值,所有支持的值。
2056
1810
  */
2057
1811
  EnumValue: Array<string>
2058
-
2059
1812
  /**
2060
- * 参数修改之后是否需要重启生效。
1813
+ * 参数修改之后是否需要重启生效。
2061
1814
  - 1:需要重启后生效。
2062
1815
  - 0:无需重启,设置成功即可生效。
2063
- */
1816
+ */
2064
1817
  NeedRestart: string
2065
-
2066
1818
  /**
2067
1819
  * 参数名称。
2068
1820
  */
2069
1821
  ParamName: string
2070
-
2071
1822
  /**
2072
1823
  * 参数说明。
2073
1824
  */
2074
1825
  Tips: Array<string>
2075
-
2076
1826
  /**
2077
1827
  * 参数值类型说明。
2078
1828
  */
2079
1829
  ValueType: string
2080
-
2081
1830
  /**
2082
- * 是否为运行中参数值。
1831
+ * 是否为运行中参数值。
2083
1832
  - 1:运行中参数值。
2084
1833
  - 0:非运行中参数值。
2085
- */
1834
+ */
2086
1835
  Status: number
2087
1836
  }
2088
1837
 
@@ -2104,14 +1853,12 @@ export interface CreateBackupDBInstanceRequest {
2104
1853
  * 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
2105
1854
  */
2106
1855
  InstanceId: string
2107
-
2108
1856
  /**
2109
- * 设置备份方式。
1857
+ * 设置备份方式。
2110
1858
  - 0:逻辑备份。
2111
1859
  - 1:物理备份。
2112
- */
1860
+ */
2113
1861
  BackupMethod: number
2114
-
2115
1862
  /**
2116
1863
  * 备份备注信息。
2117
1864
  */
@@ -2126,12 +1873,10 @@ export interface SetAccountUserPrivilegeRequest {
2126
1873
  * 指定待设置账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
2127
1874
  */
2128
1875
  InstanceId: string
2129
-
2130
1876
  /**
2131
1877
  * 设置账号名称。
2132
1878
  */
2133
1879
  UserName: string
2134
-
2135
1880
  /**
2136
1881
  * 设置权限信息。
2137
1882
  */
@@ -2143,69 +1888,59 @@ export interface SetAccountUserPrivilegeRequest {
2143
1888
  */
2144
1889
  export interface NodeProperty {
2145
1890
  /**
2146
- * 节点所在的可用区。
1891
+ * 节点所在的可用区。
2147
1892
  注意:此字段可能返回 null,表示取不到有效值。
2148
- */
1893
+ */
2149
1894
  Zone: string
2150
-
2151
1895
  /**
2152
- * 节点名称。
1896
+ * 节点名称。
2153
1897
  注意:此字段可能返回 null,表示取不到有效值。
2154
- */
1898
+ */
2155
1899
  NodeName: string
2156
-
2157
1900
  /**
2158
- * 节点访问地址。
1901
+ * 节点访问地址。
2159
1902
  注意:此字段可能返回 null,表示取不到有效值。
2160
- */
1903
+ */
2161
1904
  Address: string
2162
-
2163
1905
  /**
2164
- * 角色。
1906
+ * 角色。
2165
1907
  注意:此字段可能返回 null,表示取不到有效值。
2166
- */
1908
+ */
2167
1909
  Role: string
2168
-
2169
1910
  /**
2170
- * 是否为Hidden节点
1911
+ * 是否为Hidden节点
2171
1912
  注意:此字段可能返回 null,表示取不到有效值。
2172
- */
1913
+ */
2173
1914
  Hidden: boolean
2174
-
2175
1915
  /**
2176
- * 节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
1916
+ * 节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
2177
1917
  注意:此字段可能返回 null,表示取不到有效值。
2178
- */
1918
+ */
2179
1919
  Status: string
2180
-
2181
1920
  /**
2182
- * 主从延迟,单位秒。
1921
+ * 主从延迟,单位秒。
2183
1922
  注意:此字段可能返回 null,表示取不到有效值。
2184
- */
1923
+ */
2185
1924
  SlaveDelay: number
2186
-
2187
1925
  /**
2188
- * 节点优先级。
1926
+ * 节点优先级。
2189
1927
  注意:此字段可能返回 null,表示取不到有效值。
2190
- */
1928
+ */
2191
1929
  Priority: number
2192
-
2193
1930
  /**
2194
- * 节点投票权。
1931
+ * 节点投票权。
2195
1932
  注意:此字段可能返回 null,表示取不到有效值。
2196
- */
1933
+ */
2197
1934
  Votes: number
2198
-
2199
1935
  /**
2200
- * 节点标签。
1936
+ * 节点标签。
2201
1937
  注意:此字段可能返回 null,表示取不到有效值。
2202
- */
1938
+ */
2203
1939
  Tags: Array<NodeTag>
2204
-
2205
1940
  /**
2206
- * 副本集Id。
1941
+ * 副本集Id。
2207
1942
  注意:此字段可能返回 null,表示取不到有效值。
2208
- */
1943
+ */
2209
1944
  ReplicateSetId: string
2210
1945
  }
2211
1946
 
@@ -2237,154 +1972,129 @@ export interface CreateDBInstanceHourRequest {
2237
1972
  * 实例内存大小,单位:GB。
2238
1973
  */
2239
1974
  Memory: number
2240
-
2241
1975
  /**
2242
1976
  * 实例硬盘大小,单位:GB。
2243
1977
  */
2244
1978
  Volume: number
2245
-
2246
1979
  /**
2247
- * 指副本集数量。
1980
+ * 指副本集数量。
2248
1981
  - 创建副本集实例,该参数只能为1。
2249
1982
  - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2250
- */
1983
+ */
2251
1984
  ReplicateSetNum: number
2252
-
2253
1985
  /**
2254
1986
  * 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2255
1987
  */
2256
1988
  NodeNum: number
2257
-
2258
1989
  /**
2259
- * 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1990
+ * 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2260
1991
  - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
2261
1992
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
2262
1993
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
2263
1994
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
2264
- */
1995
+ */
2265
1996
  MongoVersion: string
2266
-
2267
1997
  /**
2268
- * 机器类型。
1998
+ * 机器类型。
2269
1999
  - HIO:高IO型。
2270
2000
  - HIO10G:高IO万兆。
2271
- */
2001
+ */
2272
2002
  MachineCode: string
2273
-
2274
2003
  /**
2275
2004
  * 实例数量,最小值1,最大值为10。
2276
2005
  */
2277
2006
  GoodsNum: number
2278
-
2279
2007
  /**
2280
- * 可用区信息,输入格式如:ap-guangzhou-2。
2008
+ * 可用区信息,输入格式如:ap-guangzhou-2。
2281
2009
  - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2282
2010
  - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
2283
- */
2011
+ */
2284
2012
  Zone: string
2285
-
2286
2013
  /**
2287
- * 实例架构类型。
2014
+ * 实例架构类型。
2288
2015
  - REPLSET:副本集。
2289
2016
  - SHARD:分片集群。
2290
- */
2017
+ */
2291
2018
  ClusterType: string
2292
-
2293
2019
  /**
2294
2020
  * 私有网络ID。如果不设置该参数,则默认选择基础网络。
2295
2021
  */
2296
2022
  VpcId?: string
2297
-
2298
2023
  /**
2299
2024
  * 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
2300
2025
  */
2301
2026
  SubnetId?: string
2302
-
2303
2027
  /**
2304
2028
  * 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
2305
2029
  */
2306
2030
  Password?: string
2307
-
2308
2031
  /**
2309
2032
  * 项目ID。若不设置该参数,则为默认项目。
2310
2033
  */
2311
2034
  ProjectId?: number
2312
-
2313
2035
  /**
2314
2036
  * 实例标签信息。
2315
2037
  */
2316
2038
  Tags?: Array<TagInfo>
2317
-
2318
2039
  /**
2319
- * 实例类型。
2040
+ * 实例类型。
2320
2041
  - 1:正式实例。
2321
2042
  - 3:只读实例。
2322
2043
  - 4:灾备实例。
2323
- */
2044
+ */
2324
2045
  Clone?: number
2325
-
2326
2046
  /**
2327
2047
  * 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
2328
2048
  */
2329
2049
  Father?: string
2330
-
2331
2050
  /**
2332
2051
  * 安全组。
2333
2052
  */
2334
2053
  SecurityGroup?: Array<string>
2335
-
2336
2054
  /**
2337
- * 克隆实例回档时间。
2055
+ * 克隆实例回档时间。
2338
2056
  - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
2339
2057
  - 回档时间范围:仅能回档7天内时间点的数据。
2340
- */
2058
+ */
2341
2059
  RestoreTime?: string
2342
-
2343
2060
  /**
2344
2061
  * 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
2345
2062
  */
2346
2063
  InstanceName?: string
2347
-
2348
2064
  /**
2349
- * 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
2065
+ * 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
2350
2066
  - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
2351
2067
  - 不支持4.2及以上版本。
2352
2068
  - 不支持只读灾备实例。
2353
2069
  - 不能选择基础网络。
2354
- */
2070
+ */
2355
2071
  AvailabilityZoneList?: Array<string>
2356
-
2357
2072
  /**
2358
- * Mongos CPU 核数。
2073
+ * Mongos CPU 核数。
2359
2074
  - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
2360
2075
  - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2361
- */
2076
+ */
2362
2077
  MongosCpu?: number
2363
-
2364
2078
  /**
2365
- * Mongos 内存大小。
2079
+ * Mongos 内存大小。
2366
2080
  - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
2367
2081
  - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2368
- */
2082
+ */
2369
2083
  MongosMemory?: number
2370
-
2371
2084
  /**
2372
- * Mongos 数量。
2085
+ * Mongos 数量。
2373
2086
  - 购买MongoDB 3.6 WiredTiger存储引擎版本以上的分片集群时,可选择性配置该参数。
2374
2087
  - 若不配置该参数,则根据Mongod节点规格默认适配 Mongos 规格,默认规格免费。
2375
- */
2088
+ */
2376
2089
  MongosNodeNum?: number
2377
-
2378
2090
  /**
2379
2091
  * 只读节点数量,最大不超过7个。
2380
2092
  */
2381
2093
  ReadonlyNodeNum?: number
2382
-
2383
2094
  /**
2384
2095
  * 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
2385
2096
  */
2386
2097
  ReadonlyNodeAvailabilityZoneList?: Array<string>
2387
-
2388
2098
  /**
2389
2099
  * Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
2390
2100
  */
@@ -2399,7 +2109,6 @@ export interface AssignProjectRequest {
2399
2109
  * 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2400
2110
  */
2401
2111
  InstanceIds: Array<string>
2402
-
2403
2112
  /**
2404
2113
  * 项目ID,用户已创建项目的唯一ID,非自定义
2405
2114
  */
@@ -2414,7 +2123,6 @@ export interface CreateBackupDownloadTaskResponse {
2414
2123
  * 下载任务状态
2415
2124
  */
2416
2125
  Tasks: Array<BackupDownloadTaskStatus>
2417
-
2418
2126
  /**
2419
2127
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2420
2128
  */
@@ -2429,17 +2137,14 @@ export interface SpecificationInfo {
2429
2137
  * 地域信息
2430
2138
  */
2431
2139
  Region: string
2432
-
2433
2140
  /**
2434
2141
  * 可用区信息
2435
2142
  */
2436
2143
  Zone: string
2437
-
2438
2144
  /**
2439
2145
  * 售卖规格信息
2440
2146
  */
2441
2147
  SpecItems: Array<SpecItem>
2442
-
2443
2148
  /**
2444
2149
  * 是否支持跨可用区部署 1-支持,0-不支持
2445
2150
  */
@@ -2454,32 +2159,26 @@ export interface DescribeSlowLogPatternsRequest {
2454
2159
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2455
2160
  */
2456
2161
  InstanceId: string
2457
-
2458
2162
  /**
2459
2163
  * 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2460
2164
  */
2461
2165
  StartTime: string
2462
-
2463
2166
  /**
2464
2167
  * 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
2465
2168
  */
2466
2169
  EndTime: string
2467
-
2468
2170
  /**
2469
2171
  * 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
2470
2172
  */
2471
2173
  SlowMS: number
2472
-
2473
2174
  /**
2474
2175
  * 偏移量,最小值为0,最大值为10000,默认值为0。
2475
2176
  */
2476
2177
  Offset?: number
2477
-
2478
2178
  /**
2479
2179
  * 分页大小,最小值为1,最大值为100,默认值为20。
2480
2180
  */
2481
2181
  Limit?: number
2482
-
2483
2182
  /**
2484
2183
  * 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
2485
2184
  */
@@ -2494,7 +2193,6 @@ export interface DescribeSpecInfoResponse {
2494
2193
  * 实例售卖规格信息列表
2495
2194
  */
2496
2195
  SpecInfoList: Array<SpecificationInfo>
2497
-
2498
2196
  /**
2499
2197
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2500
2198
  */
@@ -2509,7 +2207,6 @@ export interface InquirePriceRenewDBInstancesResponse {
2509
2207
  * 价格
2510
2208
  */
2511
2209
  Price: DBInstancePrice
2512
-
2513
2210
  /**
2514
2211
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2515
2212
  */
@@ -2524,7 +2221,6 @@ export interface TagInfo {
2524
2221
  * 标签键
2525
2222
  */
2526
2223
  TagKey: string
2527
-
2528
2224
  /**
2529
2225
  * 标签值
2530
2226
  */
@@ -2539,7 +2235,6 @@ export interface DeleteAccountUserResponse {
2539
2235
  * 账户删除任务ID。
2540
2236
  */
2541
2237
  FlowId?: number
2542
-
2543
2238
  /**
2544
2239
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2545
2240
  */
@@ -2554,12 +2249,10 @@ export interface DescribeDBInstancesResponse {
2554
2249
  * 符合查询条件的实例总数。
2555
2250
  */
2556
2251
  TotalCount?: number
2557
-
2558
2252
  /**
2559
2253
  * 实例详细信息列表。
2560
2254
  */
2561
2255
  InstanceDetails?: Array<InstanceDetail>
2562
-
2563
2256
  /**
2564
2257
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2565
2258
  */
@@ -2584,82 +2277,66 @@ export interface InquirePriceCreateDBInstancesRequest {
2584
2277
  * 实例所属区域及可用区信息。格式:ap-guangzhou-2。
2585
2278
  */
2586
2279
  Zone: string
2587
-
2588
2280
  /**
2589
2281
  * 每个分片的主从节点数量。<br>取值范围:请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数MinNodeNum与MaxNodeNum分别对应其最小值与最大值。</li></ul>
2590
2282
  */
2591
2283
  NodeNum: number
2592
-
2593
2284
  /**
2594
2285
  * 实例内存大小。<ul><li>单位:GB。</li><li>取值范围:请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。</li></ul>
2595
2286
  */
2596
2287
  Memory: number
2597
-
2598
2288
  /**
2599
2289
  * 实例硬盘大小。<ul><li>单位:GB。</li><li>取值范围:请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。</br>
2600
2290
  */
2601
2291
  Volume: number
2602
-
2603
2292
  /**
2604
2293
  * 实例版本信息。<ul><li>具体支持的版本,请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。</li><li>版本信息与版本号对应关系如下:<ul><li>MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本。</li><li>MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本。</li><li>MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。</li><li>MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。</li><li>MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。</li><li>MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。</li></ul>
2605
2294
  */
2606
2295
  MongoVersion: string
2607
-
2608
2296
  /**
2609
2297
  * 机器类型。<ul><li>HIO:高IO型。</li><li>HIO10G:高IO万兆型。</li></ul>
2610
2298
  */
2611
2299
  MachineCode: string
2612
-
2613
2300
  /**
2614
2301
  * 实例数量,取值范围为[1,10]。
2615
2302
  */
2616
2303
  GoodsNum: number
2617
-
2618
2304
  /**
2619
2305
  * 实例类型。<ul><li>REPLSET:副本集。</li><li>SHARD:分片集群。</li><li>STANDALONE:单节点。</li></ul>
2620
2306
  */
2621
2307
  ClusterType: string
2622
-
2623
2308
  /**
2624
2309
  * 副本集个数。<ul><li>创建副本集实例时,该参数固定设置为1。</li><li>创建分片集群时,指分片数量,请通过接口<a href="https://cloud.tencent.com/document/product/240/38567">DescribeSpecInfo</a>查询,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。</li><li>若为单节点实例,该参数固定设置为0。</li></ul>
2625
2310
  */
2626
2311
  ReplicateSetNum: number
2627
-
2628
2312
  /**
2629
2313
  * 选择包年包月计费模式时,您需要设定购买实例的时长。即<b>InstanceChargeType</b>设定为<b>PREPAID</b>时,该参数必须配置。<ul><li>单位:月。</li><li>可选值包括[1,2,3,4,5,6,7,8,9,10,11,12,24,36]。</li></ul>
2630
2314
  */
2631
2315
  Period?: number
2632
-
2633
2316
  /**
2634
2317
  * 实例付费方式。<ul><li>PREPAID:包年包月计费。</li><li>POSTPAID_BY_HOUR:按量计费。</li></ul>
2635
2318
  */
2636
2319
  InstanceChargeType?: string
2637
-
2638
2320
  /**
2639
2321
  * 分片实例询价必填参数,指 Mongos CPU核数,取值范围为[1,16]。
2640
2322
  */
2641
2323
  MongosCpu?: number
2642
-
2643
2324
  /**
2644
2325
  * 分片实例询价必填参数,指 Mongos 内存,取值范围为[2,32],单位:GB。
2645
2326
  */
2646
2327
  MongosMemory?: number
2647
-
2648
2328
  /**
2649
2329
  * 分片实例询价必填参数,指 Mongos 个数,取值范围为[3,32]。
2650
2330
  */
2651
2331
  MongosNum?: number
2652
-
2653
2332
  /**
2654
2333
  * 分片实例询价必填参数,指 ConfigServer CPU核数,取值为1,单位:GB。
2655
2334
  */
2656
2335
  ConfigServerCpu?: number
2657
-
2658
2336
  /**
2659
2337
  * 分片实例询价必填参数,指 ConfigServer 内存大小,取值为2,单位:GB。
2660
2338
  */
2661
2339
  ConfigServerMemory?: number
2662
-
2663
2340
  /**
2664
2341
  * 分片实例询价必填参数,指 ConfigServer 磁盘大小,取值为 20,单位:GB。
2665
2342
  */
@@ -2674,27 +2351,22 @@ export interface DescribeInstanceParamsResponse {
2674
2351
  * 参数值为枚举类型参数集合。
2675
2352
  */
2676
2353
  InstanceEnumParam?: Array<InstanceEnumParam>
2677
-
2678
2354
  /**
2679
2355
  * 参数值为 Integer 类型参数集合。
2680
2356
  */
2681
2357
  InstanceIntegerParam?: Array<InstanceIntegerParam>
2682
-
2683
2358
  /**
2684
2359
  * 参数值为 Text 类型的参数集合。
2685
2360
  */
2686
2361
  InstanceTextParam?: Array<InstanceTextParam>
2687
-
2688
2362
  /**
2689
2363
  * 参数值为混合类型的参数集合。
2690
2364
  */
2691
2365
  InstanceMultiParam?: Array<InstanceMultiParam>
2692
-
2693
2366
  /**
2694
2367
  * 当前实例支持修改的参数个数统计 如0
2695
2368
  */
2696
2369
  TotalCount?: number
2697
-
2698
2370
  /**
2699
2371
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2700
2372
  */
@@ -2709,238 +2381,193 @@ export interface InstanceDetail {
2709
2381
  * 实例ID。
2710
2382
  */
2711
2383
  InstanceId: string
2712
-
2713
2384
  /**
2714
2385
  * 实例名称。
2715
2386
  */
2716
2387
  InstanceName: string
2717
-
2718
2388
  /**
2719
2389
  * 付费类型,可能的返回值:1-包年包月;0-按量计费
2720
2390
  */
2721
2391
  PayMode: number
2722
-
2723
2392
  /**
2724
2393
  * 项目ID。
2725
2394
  */
2726
2395
  ProjectId: number
2727
-
2728
2396
  /**
2729
2397
  * 集群类型,可能的返回值:0-副本集实例,1-分片实例。
2730
2398
  */
2731
2399
  ClusterType: number
2732
-
2733
2400
  /**
2734
2401
  * 地域信息。
2735
2402
  */
2736
2403
  Region: string
2737
-
2738
2404
  /**
2739
2405
  * 可用区信息。
2740
2406
  */
2741
2407
  Zone: string
2742
-
2743
2408
  /**
2744
2409
  * 网络类型,可能的返回值:0-基础网络,1-私有网络
2745
2410
  */
2746
2411
  NetType: number
2747
-
2748
2412
  /**
2749
2413
  * 私有网络的ID。
2750
2414
  */
2751
2415
  VpcId: string
2752
-
2753
2416
  /**
2754
2417
  * 私有网络的子网ID。
2755
2418
  */
2756
2419
  SubnetId: string
2757
-
2758
2420
  /**
2759
2421
  * 实例状态,可能的返回值:0-待初始化,1-流程处理中,2-运行中,-2-实例已过期。
2760
2422
  */
2761
2423
  Status: number
2762
-
2763
2424
  /**
2764
2425
  * 实例IP。
2765
2426
  */
2766
2427
  Vip: string
2767
-
2768
2428
  /**
2769
2429
  * 端口号。
2770
2430
  */
2771
2431
  Vport: number
2772
-
2773
2432
  /**
2774
2433
  * 实例创建时间。
2775
2434
  */
2776
2435
  CreateTime: string
2777
-
2778
2436
  /**
2779
2437
  * 实例到期时间。
2780
2438
  */
2781
2439
  DeadLine: string
2782
-
2783
2440
  /**
2784
2441
  * 实例版本信息。
2785
2442
  */
2786
2443
  MongoVersion: string
2787
-
2788
2444
  /**
2789
2445
  * 实例内存规格,单位为MB。
2790
2446
  */
2791
2447
  Memory: number
2792
-
2793
2448
  /**
2794
2449
  * 实例磁盘规格,单位为MB。
2795
2450
  */
2796
2451
  Volume: number
2797
-
2798
2452
  /**
2799
2453
  * 实例CPU核心数。
2800
2454
  */
2801
2455
  CpuNum: number
2802
-
2803
2456
  /**
2804
2457
  * 实例机器类型。
2805
2458
  */
2806
2459
  MachineType: string
2807
-
2808
2460
  /**
2809
2461
  * 实例从节点数。
2810
2462
  */
2811
2463
  SecondaryNum: number
2812
-
2813
2464
  /**
2814
2465
  * 实例分片数。
2815
2466
  */
2816
2467
  ReplicationSetNum: number
2817
-
2818
2468
  /**
2819
2469
  * 实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费。
2820
2470
  */
2821
2471
  AutoRenewFlag: number
2822
-
2823
2472
  /**
2824
2473
  * 已用容量,单位MB。
2825
2474
  */
2826
2475
  UsedVolume: number
2827
-
2828
2476
  /**
2829
2477
  * 维护窗口起始时间。
2830
2478
  */
2831
2479
  MaintenanceStart: string
2832
-
2833
2480
  /**
2834
2481
  * 维护窗口结束时间。
2835
2482
  */
2836
2483
  MaintenanceEnd: string
2837
-
2838
2484
  /**
2839
2485
  * 分片信息。
2840
2486
  */
2841
2487
  ReplicaSets: Array<ShardInfo>
2842
-
2843
2488
  /**
2844
2489
  * 只读实例信息。
2845
2490
  */
2846
2491
  ReadonlyInstances: Array<DBInstanceInfo>
2847
-
2848
2492
  /**
2849
2493
  * 灾备实例信息。
2850
2494
  */
2851
2495
  StandbyInstances: Array<DBInstanceInfo>
2852
-
2853
2496
  /**
2854
2497
  * 临时实例信息。
2855
2498
  */
2856
2499
  CloneInstances: Array<DBInstanceInfo>
2857
-
2858
2500
  /**
2859
2501
  * 关联实例信息,对于正式实例,该字段表示它的临时实例信息;对于临时实例,则表示它的正式实例信息;如果为只读/灾备实例,则表示他的主实例信息。
2860
2502
  */
2861
2503
  RelatedInstance: DBInstanceInfo
2862
-
2863
2504
  /**
2864
2505
  * 实例标签信息集合。
2865
2506
  */
2866
2507
  Tags: Array<TagInfo>
2867
-
2868
2508
  /**
2869
2509
  * 实例版本标记。
2870
2510
  */
2871
2511
  InstanceVer: number
2872
-
2873
2512
  /**
2874
2513
  * 实例版本标记。
2875
2514
  */
2876
2515
  ClusterVer: number
2877
-
2878
2516
  /**
2879
2517
  * 协议信息,可能的返回值:1-mongodb,2-dynamodb。
2880
2518
  */
2881
2519
  Protocol: number
2882
-
2883
2520
  /**
2884
2521
  * 实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例
2885
2522
  */
2886
2523
  InstanceType: number
2887
-
2888
2524
  /**
2889
2525
  * 实例状态描述
2890
2526
  */
2891
2527
  InstanceStatusDesc: string
2892
-
2893
2528
  /**
2894
2529
  * 实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取
2895
2530
  */
2896
2531
  RealInstanceId: string
2897
-
2898
2532
  /**
2899
- * mongos节点个数。
2533
+ * mongos节点个数。
2900
2534
  注意:此字段可能返回 null,表示取不到有效值。
2901
- */
2535
+ */
2902
2536
  MongosNodeNum: number
2903
-
2904
2537
  /**
2905
- * mongos节点内存。
2538
+ * mongos节点内存。
2906
2539
  注意:此字段可能返回 null,表示取不到有效值。
2907
- */
2540
+ */
2908
2541
  MongosMemory: number
2909
-
2910
2542
  /**
2911
- * mongos节点CPU核数。
2543
+ * mongos节点CPU核数。
2912
2544
  注意:此字段可能返回 null,表示取不到有效值。
2913
- */
2545
+ */
2914
2546
  MongosCpuNum: number
2915
-
2916
2547
  /**
2917
- * Config Server节点个数。
2548
+ * Config Server节点个数。
2918
2549
  注意:此字段可能返回 null,表示取不到有效值。
2919
- */
2550
+ */
2920
2551
  ConfigServerNodeNum: number
2921
-
2922
2552
  /**
2923
- * Config Server节点内存。
2553
+ * Config Server节点内存。
2924
2554
  注意:此字段可能返回 null,表示取不到有效值。
2925
- */
2555
+ */
2926
2556
  ConfigServerMemory: number
2927
-
2928
2557
  /**
2929
- * Config Server节点磁盘大小。
2558
+ * Config Server节点磁盘大小。
2930
2559
  注意:此字段可能返回 null,表示取不到有效值。
2931
- */
2560
+ */
2932
2561
  ConfigServerVolume: number
2933
-
2934
2562
  /**
2935
- * Config Server节点CPU核数。
2563
+ * Config Server节点CPU核数。
2936
2564
  注意:此字段可能返回 null,表示取不到有效值。
2937
- */
2565
+ */
2938
2566
  ConfigServerCpuNum: number
2939
-
2940
2567
  /**
2941
- * readonly节点个数。
2568
+ * readonly节点个数。
2942
2569
  注意:此字段可能返回 null,表示取不到有效值。
2943
- */
2570
+ */
2944
2571
  ReadonlyNodeNum: number
2945
2572
  }
2946
2573
 
@@ -2952,7 +2579,6 @@ export interface ModifyDBInstanceSpecResponse {
2952
2579
  * 订单ID
2953
2580
  */
2954
2581
  DealId: string
2955
-
2956
2582
  /**
2957
2583
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2958
2584
  */
@@ -2964,20 +2590,19 @@ export interface ModifyDBInstanceSpecResponse {
2964
2590
  */
2965
2591
  export interface InstanceChargePrepaid {
2966
2592
  /**
2967
- * 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。
2593
+ * 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。
2968
2594
  (InquirePriceRenewDBInstances,RenewDBInstances调用时必填)
2969
- */
2595
+ */
2970
2596
  Period?: number
2971
-
2972
2597
  /**
2973
- * 自动续费标识。取值范围:
2598
+ * 自动续费标识。取值范围:
2974
2599
  NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
2975
2600
  NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
2976
2601
  DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费
2977
2602
 
2978
2603
  默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
2979
2604
  (InquirePriceRenewDBInstances,RenewDBInstances调用时必填)
2980
- */
2605
+ */
2981
2606
  RenewFlag?: string
2982
2607
  }
2983
2608
 
@@ -2989,7 +2614,6 @@ export interface RenewDBInstancesRequest {
2989
2614
  * 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
2990
2615
  */
2991
2616
  InstanceIds: Array<string>
2992
-
2993
2617
  /**
2994
2618
  * 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。
2995
2619
  */