@ucloud-sdks/ucloud-sdk-js 0.2.6 → 0.2.7

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.
@@ -0,0 +1,1904 @@
1
+ import Client from '../../core/client';
2
+ import { ConfigOptions } from '../../core/config';
3
+ import { CredentialOptions } from '../../core/credential';
4
+ /**
5
+ * This client is used to call actions of **umongodb** service
6
+ */
7
+ export default class UMongoDBClient extends Client {
8
+ constructor({ config, credential, }: {
9
+ config: ConfigOptions;
10
+ credential: CredentialOptions;
11
+ });
12
+ /**
13
+ * BackupUMongoDBCluster - 备份集群数据库
14
+ *
15
+ * See also: https://docs.ucloud.cn/api/umongodb-api/backup_umon_go_db_cluster
16
+ */
17
+ backupUMongoDBCluster(request?: BackupUMongoDBClusterRequest): Promise<BackupUMongoDBClusterResponse>;
18
+ /**
19
+ * BackupUMongoDBLog - 日志打包
20
+ *
21
+ * See also: https://docs.ucloud.cn/api/umongodb-api/backup_umon_go_db_log
22
+ */
23
+ backupUMongoDBLog(request?: BackupUMongoDBLogRequest): Promise<BackupUMongoDBLogResponse>;
24
+ /**
25
+ * CreateUMongoDBConfigTemplate - 创建配置模板
26
+ *
27
+ * See also: https://docs.ucloud.cn/api/umongodb-api/create_umon_go_db_config_template
28
+ */
29
+ createUMongoDBConfigTemplate(request?: CreateUMongoDBConfigTemplateRequest): Promise<CreateUMongoDBConfigTemplateResponse>;
30
+ /**
31
+ * CreateUMongoDBReplSet - 创建一个Mongodb副本集群
32
+ *
33
+ * See also: https://docs.ucloud.cn/api/umongodb-api/create_umon_go_db_repl_set
34
+ */
35
+ createUMongoDBReplSet(request?: CreateUMongoDBReplSetRequest): Promise<CreateUMongoDBReplSetResponse>;
36
+ /**
37
+ * CreateUMongoDBShardedCluster - 创建一个Mongodb分片集群
38
+ *
39
+ * See also: https://docs.ucloud.cn/api/umongodb-api/create_umon_go_db_sharded_cluster
40
+ */
41
+ createUMongoDBShardedCluster(request?: CreateUMongoDBShardedClusterRequest): Promise<CreateUMongoDBShardedClusterResponse>;
42
+ /**
43
+ * DescribeUMongoDBBackupURL - 获取实例备份下载链接
44
+ *
45
+ * See also: https://docs.ucloud.cn/api/umongodb-api/describe_umon_go_db_backup_url
46
+ */
47
+ describeUMongoDBBackupURL(request?: DescribeUMongoDBBackupURLRequest): Promise<DescribeUMongoDBBackupURLResponse>;
48
+ /**
49
+ * DescribeUMongoDBInstance - 描述MongoDB实例
50
+ *
51
+ * See also: https://docs.ucloud.cn/api/umongodb-api/describe_umon_go_db_instance
52
+ */
53
+ describeUMongoDBInstance(request?: DescribeUMongoDBInstanceRequest): Promise<DescribeUMongoDBInstanceResponse>;
54
+ /**
55
+ * GetUMongoDBBackupParam - 获取实例备份策略
56
+ *
57
+ * See also: https://docs.ucloud.cn/api/umongodb-api/get_umon_go_db_backup_param
58
+ */
59
+ getUMongoDBBackupParam(request?: GetUMongoDBBackupParamRequest): Promise<GetUMongoDBBackupParamResponse>;
60
+ /**
61
+ * GetUMongoDBCfgTempItem - 获取配置模板内容
62
+ *
63
+ * See also: https://docs.ucloud.cn/api/umongodb-api/get_umon_go_db_cfg_temp_item
64
+ */
65
+ getUMongoDBCfgTempItem(request?: GetUMongoDBCfgTempItemRequest): Promise<GetUMongoDBCfgTempItemResponse>;
66
+ /**
67
+ * GetUMongoDBLog - 查询某一段时间内集群节点的错误日志或慢查询日志
68
+ *
69
+ * See also: https://docs.ucloud.cn/api/umongodb-api/get_umon_go_db_log
70
+ */
71
+ getUMongoDBLog(request?: GetUMongoDBLogRequest): Promise<GetUMongoDBLogResponse>;
72
+ /**
73
+ * GetUMongoDBRecoverTimeRange - 获取UMongoDB可回档时间范围
74
+ *
75
+ * See also: https://docs.ucloud.cn/api/umongodb-api/get_umon_go_db_recover_time_range
76
+ */
77
+ getUMongoDBRecoverTimeRange(request?: GetUMongoDBRecoverTimeRangeRequest): Promise<GetUMongoDBRecoverTimeRangeResponse>;
78
+ /**
79
+ * ListUMongoDBBackup - 拉取实例备份列表
80
+ *
81
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_backup
82
+ */
83
+ listUMongoDBBackup(request?: ListUMongoDBBackupRequest): Promise<ListUMongoDBBackupResponse>;
84
+ /**
85
+ * ListUMongoDBConfigTemplate - 拉取配置模板
86
+ *
87
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_config_template
88
+ */
89
+ listUMongoDBConfigTemplate(request?: ListUMongoDBConfigTemplateRequest): Promise<ListUMongoDBConfigTemplateResponse>;
90
+ /**
91
+ * ListUMongoDBInstances - 获取副本集/分片集群列表
92
+ *
93
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_instances
94
+ */
95
+ listUMongoDBInstances(request?: ListUMongoDBInstancesRequest): Promise<ListUMongoDBInstancesResponse>;
96
+ /**
97
+ * ListUMongoDBLogPackage - 日志打包列表
98
+ *
99
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_log_package
100
+ */
101
+ listUMongoDBLogPackage(request?: ListUMongoDBLogPackageRequest): Promise<ListUMongoDBLogPackageResponse>;
102
+ /**
103
+ * ListUMongoDBMachineSpec - 获取UMongoDB支持机器类型列表
104
+ *
105
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_machine_spec
106
+ */
107
+ listUMongoDBMachineSpec(request?: ListUMongoDBMachineSpecRequest): Promise<ListUMongoDBMachineSpecResponse>;
108
+ /**
109
+ * ListUMongoDBMachineType - 获取UmongDB支持机器类型列表
110
+ *
111
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_machine_type
112
+ */
113
+ listUMongoDBMachineType(request?: ListUMongoDBMachineTypeRequest): Promise<ListUMongoDBMachineTypeResponse>;
114
+ /**
115
+ * ListUMongoDBVersion - 获取UMongoDB支持版本列表
116
+ *
117
+ * See also: https://docs.ucloud.cn/api/umongodb-api/list_umon_go_db_version
118
+ */
119
+ listUMongoDBVersion(request?: ListUMongoDBVersionRequest): Promise<ListUMongoDBVersionResponse>;
120
+ /**
121
+ * ModifyUMongoDBAdminPassword - 修改MongoDB集群root密码
122
+ *
123
+ * See also: https://docs.ucloud.cn/api/umongodb-api/modify_umon_go_db_admin_password
124
+ */
125
+ modifyUMongoDBAdminPassword(request?: ModifyUMongoDBAdminPasswordRequest): Promise<ModifyUMongoDBAdminPasswordResponse>;
126
+ /**
127
+ * ModifyUMongoDBAttribute - 修改MongoDB集群名称
128
+ *
129
+ * See also: https://docs.ucloud.cn/api/umongodb-api/modify_umon_go_db_attribute
130
+ */
131
+ modifyUMongoDBAttribute(request?: ModifyUMongoDBAttributeRequest): Promise<ModifyUMongoDBAttributeResponse>;
132
+ /**
133
+ * ModifyUMongoDBBackupParam - 修改实例备份策略
134
+ *
135
+ * See also: https://docs.ucloud.cn/api/umongodb-api/modify_umon_go_db_backup_param
136
+ */
137
+ modifyUMongoDBBackupParam(request?: ModifyUMongoDBBackupParamRequest): Promise<ModifyUMongoDBBackupParamResponse>;
138
+ /**
139
+ * ResizeUMongoDBInstance - 集群配置升降级
140
+ *
141
+ * See also: https://docs.ucloud.cn/api/umongodb-api/resize_umon_go_db_instance
142
+ */
143
+ resizeUMongoDBInstance(request?: ResizeUMongoDBInstanceRequest): Promise<ResizeUMongoDBInstanceResponse>;
144
+ /**
145
+ * RestartUMongoDBCluster - 重启集群
146
+ *
147
+ * See also: https://docs.ucloud.cn/api/umongodb-api/restart_umon_go_db_cluster
148
+ */
149
+ restartUMongoDBCluster(request?: RestartUMongoDBClusterRequest): Promise<RestartUMongoDBClusterResponse>;
150
+ /**
151
+ * StartUMongoDBCluster - 启动集群
152
+ *
153
+ * See also: https://docs.ucloud.cn/api/umongodb-api/start_umon_go_db_cluster
154
+ */
155
+ startUMongoDBCluster(request?: StartUMongoDBClusterRequest): Promise<StartUMongoDBClusterResponse>;
156
+ /**
157
+ * StopUMongoDBCluster - 停止集群
158
+ *
159
+ * See also: https://docs.ucloud.cn/api/umongodb-api/stop_umon_go_db_cluster
160
+ */
161
+ stopUMongoDBCluster(request?: StopUMongoDBClusterRequest): Promise<StopUMongoDBClusterResponse>;
162
+ }
163
+ /**
164
+ * BackupUMongoDBCluster - 备份集群数据库
165
+ */
166
+ export interface BackupUMongoDBClusterRequest {
167
+ /**
168
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
169
+ */
170
+ Zone: string;
171
+ /**
172
+ * 实例ID
173
+ */
174
+ ClusterId: string;
175
+ /**
176
+ * 备份名称
177
+ */
178
+ BackupName: string;
179
+ }
180
+ /**
181
+ * BackupUMongoDBCluster - 备份集群数据库
182
+ */
183
+ export interface BackupUMongoDBClusterResponse {
184
+ /**
185
+ * 备份ID
186
+ */
187
+ BackupId: string;
188
+ /**
189
+ * 实例ID
190
+ */
191
+ ClusterId: string;
192
+ }
193
+ /**
194
+ * BackupUMongoDBLog - 日志打包
195
+ */
196
+ export interface BackupUMongoDBLogRequest {
197
+ /**
198
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
199
+ */
200
+ Zone: string;
201
+ /**
202
+ * 日志包名称
203
+ */
204
+ Name: string;
205
+ /**
206
+ * 集群id
207
+ */
208
+ ClusterId: string;
209
+ /**
210
+ * 节点id, 慢日志 mongos 节点不可选
211
+ */
212
+ NodeId: string;
213
+ /**
214
+ * 日志开始时间,最早为7x24小时前
215
+ */
216
+ Begin: number;
217
+ /**
218
+ * 日志结束时间,时间区间不能超过24小时
219
+ */
220
+ End: number;
221
+ /**
222
+ * 日志类型:SlowLog,ErrorLog
223
+ */
224
+ LogType: string;
225
+ }
226
+ /**
227
+ * BackupUMongoDBLog - 日志打包
228
+ */
229
+ export interface BackupUMongoDBLogResponse {
230
+ }
231
+ /**
232
+ * CreateUMongoDBConfigTemplate - 创建配置模板
233
+ */
234
+ export interface CreateUMongoDBConfigTemplateRequest {
235
+ /**
236
+ * 模板名称
237
+ */
238
+ TemplateName: string;
239
+ /**
240
+ * 集群类型
241
+ */
242
+ ClusterType: string;
243
+ /**
244
+ * mongo版本
245
+ */
246
+ MongodbVersion: string;
247
+ /**
248
+ * 基础模板
249
+ */
250
+ BaseTemplateId: string;
251
+ /**
252
+ * 模板描述
253
+ */
254
+ Description?: string;
255
+ }
256
+ /**
257
+ * CreateUMongoDBConfigTemplate - 创建配置模板
258
+ */
259
+ export interface CreateUMongoDBConfigTemplateResponse {
260
+ /**
261
+ * 模板Id
262
+ */
263
+ TemplateId: string;
264
+ }
265
+ /**
266
+ * CreateUMongoDBReplSet - 创建一个Mongodb副本集群
267
+ */
268
+ export interface CreateUMongoDBReplSetRequest {
269
+ /**
270
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
271
+ */
272
+ Zone: string;
273
+ /**
274
+ * 副本集实例名称,至少6位
275
+ */
276
+ Name: string;
277
+ /**
278
+ * 副本集的Mongodb的版本,例如MongoDB 3.6, MongoDB 4.2
279
+ */
280
+ DBVersion: string;
281
+ /**
282
+ * 管理员密码
283
+ */
284
+ AdminPassword: string;
285
+ /**
286
+ * 磁盘空间 (GB):取值范围 20~32000,仅支持 10 的整数倍
287
+ */
288
+ DiskSpace: number;
289
+ /**
290
+ * 机型配置,如 o.mongo2m.medium
291
+ */
292
+ MachineTypeId: string;
293
+ /**
294
+ * 副本集节点数量:仅支持 3、5、7 奇数节点
295
+ */
296
+ NodeCount: number;
297
+ /**
298
+ * mongo服务端口
299
+ */
300
+ ListenPort?: number;
301
+ /**
302
+ * 子网ID
303
+ */
304
+ SubnetId?: string;
305
+ /**
306
+ * VPC的ID
307
+ */
308
+ VPCId?: string;
309
+ /**
310
+ * 实例所在的业务组名称
311
+ */
312
+ Tag?: string;
313
+ /**
314
+ * 付费方式:Year, Month, Dynamic,Trial,默认: Month
315
+ */
316
+ ChargeType?: string;
317
+ /**
318
+ * 购买时长,默认值1
319
+ */
320
+ Quantity?: number;
321
+ /**
322
+ * 跨可用区列表
323
+ */
324
+ CrossZones?: string[];
325
+ /**
326
+ *
327
+ */
328
+ Labels?: {
329
+ /**
330
+ * 用户资源标签的键值
331
+ */
332
+ Key?: string;
333
+ /**
334
+ * 用户资源标签值
335
+ */
336
+ Value?: string;
337
+ }[];
338
+ /**
339
+ *
340
+ */
341
+ SecGroupId?: {
342
+ /**
343
+ * 安全组 ID。至多可以同时绑定5个安全组。
344
+ */
345
+ Id?: string;
346
+ /**
347
+ * 安全组优先级。取值范围[1, 5]
348
+ */
349
+ Priority?: number;
350
+ }[];
351
+ }
352
+ /**
353
+ * CreateUMongoDBReplSet - 创建一个Mongodb副本集群
354
+ */
355
+ export interface CreateUMongoDBReplSetResponse {
356
+ }
357
+ /**
358
+ * CreateUMongoDBShardedCluster - 创建一个Mongodb分片集群
359
+ */
360
+ export interface CreateUMongoDBShardedClusterRequest {
361
+ /**
362
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
363
+ */
364
+ Zone: string;
365
+ /**
366
+ * 副本集实例名称,至少6位
367
+ */
368
+ Name: string;
369
+ /**
370
+ * 副本集的Mongodb的版本,例如MongoDB 3.6, MongoDB 4.2
371
+ */
372
+ DBVersion: string;
373
+ /**
374
+ * 管理员密码
375
+ */
376
+ AdminPassword: string;
377
+ /**
378
+ * Mongos节点数量
379
+ */
380
+ MongosNodeCount: number;
381
+ /**
382
+ * 分片数量
383
+ */
384
+ ShardCount: number;
385
+ /**
386
+ * 每个分片中节点数量
387
+ */
388
+ NodeCount: number;
389
+ /**
390
+ * 数据节点磁盘空间(GB):取值范围 20~32000,仅支持 10 的整数倍
391
+ */
392
+ DiskSpace: number;
393
+ /**
394
+ * 数据节点机型配置,如 o.mongo2m.medium
395
+ */
396
+ MachineTypeId: string;
397
+ /**
398
+ * 子网ID
399
+ */
400
+ SubnetId?: string;
401
+ /**
402
+ * VPC的ID
403
+ */
404
+ VPCId?: string;
405
+ /**
406
+ * 实例所在的业务组名称
407
+ */
408
+ Tag?: string;
409
+ /**
410
+ * 付费方式:Year, Month, Dynamic,Trial,默认: Month
411
+ */
412
+ ChargeType?: string;
413
+ /**
414
+ * 购买时长,默认值1
415
+ */
416
+ Quantity?: number;
417
+ /**
418
+ * mongo服务端口
419
+ */
420
+ ListenPort?: number;
421
+ /**
422
+ * 参数配置模版id
423
+ */
424
+ TemplateId?: string;
425
+ /**
426
+ * Mongos节点机型配置
427
+ */
428
+ MongosMachineTypeId?: string;
429
+ /**
430
+ *
431
+ */
432
+ Labels?: {
433
+ /**
434
+ * 用户资源标签的键值
435
+ */
436
+ Key?: string;
437
+ /**
438
+ * 用户资源标签值
439
+ */
440
+ Value?: string;
441
+ }[];
442
+ /**
443
+ *
444
+ */
445
+ SecGroupId?: {
446
+ /**
447
+ * 安全组 ID。至多可以同时绑定5个安全组。
448
+ */
449
+ Id?: string;
450
+ /**
451
+ * 安全组优先级。取值范围[1, 5]
452
+ */
453
+ Priority?: number;
454
+ }[];
455
+ }
456
+ /**
457
+ * CreateUMongoDBShardedCluster - 创建一个Mongodb分片集群
458
+ */
459
+ export interface CreateUMongoDBShardedClusterResponse {
460
+ }
461
+ /**
462
+ * DescribeUMongoDBBackupURL - 获取实例备份下载链接
463
+ */
464
+ export interface DescribeUMongoDBBackupURLRequest {
465
+ /**
466
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
467
+ */
468
+ Zone?: string;
469
+ /**
470
+ * 集群ID
471
+ */
472
+ ClusterId: string;
473
+ /**
474
+ * 文件备份ID
475
+ */
476
+ BackupId?: string;
477
+ /**
478
+ * 打包ID
479
+ */
480
+ PackageId?: number;
481
+ /**
482
+ * 备份链接过期时间(单位秒)
483
+ */
484
+ ValidTime?: number;
485
+ /**
486
+ * 类型:如 oplog
487
+ */
488
+ Category?: string;
489
+ }
490
+ /**
491
+ * DescribeUMongoDBBackupURL - 获取实例备份下载链接
492
+ */
493
+ export interface DescribeUMongoDBBackupURLResponse {
494
+ /**
495
+ * 备份文件公网地址
496
+ */
497
+ InternetAddress: string;
498
+ /**
499
+ * 备份文件内网地址
500
+ */
501
+ IntranetAddress: string;
502
+ }
503
+ /**
504
+ * DescribeUMongoDBInstance - 描述MongoDB实例
505
+ */
506
+ export interface DescribeUMongoDBInstanceRequest {
507
+ /**
508
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
509
+ */
510
+ Zone?: string;
511
+ /**
512
+ * 实例资源ID
513
+ */
514
+ ClusterId: string;
515
+ /**
516
+ * 集群类型,ReplicaSet:副本集,SharedCluster:分片集群
517
+ */
518
+ ClusterType?: string;
519
+ }
520
+ /**
521
+ * DescribeUMongoDBInstance - 描述MongoDB实例
522
+ */
523
+ export interface DescribeUMongoDBInstanceResponse {
524
+ /**
525
+ * 副本集信息
526
+ */
527
+ ClusterInfo?: {
528
+ /**
529
+ * 可用区
530
+ */
531
+ Zone?: string;
532
+ /**
533
+ *
534
+ */
535
+ ZoneId?: number;
536
+ /**
537
+ * 集群类型,ReplicaSet :副本集,SharedCluster:分片集
538
+ */
539
+ ClusterType?: string;
540
+ /**
541
+ * 集群ID
542
+ */
543
+ ClusterId?: string;
544
+ /**
545
+ * 实例名称
546
+ */
547
+ InstanceName?: string;
548
+ /**
549
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败,Upgrading: 升降级中,UpgradeFailed: 升降级失败,Switching:主备切换中,UpdatingSSL:修改SSL中,UpdateSSLFail:修改SSL失败
550
+ */
551
+ State?: string;
552
+ /**
553
+ * 副本集的Mongodb的版本
554
+ */
555
+ DBVersion?: string;
556
+ /**
557
+ * 磁盘空间(GB), 默认根据配置机型
558
+ */
559
+ DiskSpace?: number;
560
+ /**
561
+ * 计算规格
562
+ */
563
+ MachineTypeId?: string;
564
+ /**
565
+ * DB实例创建时间
566
+ */
567
+ CreateTime?: number;
568
+ /**
569
+ * ConfigSrv信息
570
+ */
571
+ ConfigReplicaInfo?: {
572
+ /**
573
+ * 副本集ID
574
+ */
575
+ ReplicaId?: string;
576
+ /**
577
+ * 集群ID
578
+ */
579
+ ClusterId?: string;
580
+ /**
581
+ * 副本类型,ConfigRepl或者DataRepl
582
+ */
583
+ ReplicaType?: string;
584
+ /**
585
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。
586
+ */
587
+ State?: string;
588
+ /**
589
+ * 机器类型
590
+ */
591
+ MachineType?: string;
592
+ /**
593
+ * 机器类型Id
594
+ */
595
+ MachineTypeId?: string;
596
+ /**
597
+ * 隔离组ID
598
+ */
599
+ IsolationGroupId?: string;
600
+ /**
601
+ * 副本集下的节点信息
602
+ */
603
+ NodeInfos?: {
604
+ /**
605
+ * 可用区
606
+ */
607
+ Zone?: string;
608
+ /**
609
+ * 可用区ID
610
+ */
611
+ ZoneId?: number;
612
+ /**
613
+ * 节点ID
614
+ */
615
+ NodeId?: string;
616
+ /**
617
+ * 节点角色,Primary/Secondary/Arbiter/Startup等等
618
+ */
619
+ NodeRole?: string;
620
+ /**
621
+ * 节点类型
622
+ */
623
+ NodeType?: string;
624
+ /**
625
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。
626
+ */
627
+ State?: string;
628
+ /**
629
+ * 副本集的Mongodb的版本
630
+ */
631
+ DBVersion?: string;
632
+ /**
633
+ * 节点所属副本集ID
634
+ */
635
+ ClusterId?: string;
636
+ /**
637
+ * 虚拟节点ID
638
+ */
639
+ VirtualClusterId?: string;
640
+ /**
641
+ * 机型信息
642
+ */
643
+ MachineType?: string;
644
+ /**
645
+ * 机型信息ID
646
+ */
647
+ MachineTypeId?: string;
648
+ /**
649
+ * DB实例创建时间
650
+ */
651
+ CreateTime?: number;
652
+ /**
653
+ * 数据盘信息
654
+ */
655
+ DataDisk?: {
656
+ /**
657
+ * 磁盘id
658
+ */
659
+ DiskId?: string;
660
+ /**
661
+ * 磁盘容量单位GB
662
+ */
663
+ DiskSize?: number;
664
+ };
665
+ /**
666
+ * 系统盘信息
667
+ */
668
+ SysDisk?: {
669
+ /**
670
+ * 磁盘id
671
+ */
672
+ DiskId?: string;
673
+ /**
674
+ * 磁盘容量单位GB
675
+ */
676
+ DiskSize?: number;
677
+ };
678
+ }[];
679
+ /**
680
+ * 副本集下的节点数量
681
+ */
682
+ NodeCount?: number;
683
+ /**
684
+ * 副本集创建时间
685
+ */
686
+ CreateTime?: number;
687
+ /**
688
+ * 副本集删除时间
689
+ */
690
+ DeleteTime?: number;
691
+ /**
692
+ * 副本集修改时间
693
+ */
694
+ ModifyTime?: number;
695
+ };
696
+ /**
697
+ * 数据副本信息
698
+ */
699
+ DataReplicaInfos?: {
700
+ /**
701
+ * 副本集ID
702
+ */
703
+ ReplicaId?: string;
704
+ /**
705
+ * 集群ID
706
+ */
707
+ ClusterId?: string;
708
+ /**
709
+ * 副本类型,ConfigRepl或者DataRepl
710
+ */
711
+ ReplicaType?: string;
712
+ /**
713
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。
714
+ */
715
+ State?: string;
716
+ /**
717
+ * 机器类型
718
+ */
719
+ MachineType?: string;
720
+ /**
721
+ * 机器类型Id
722
+ */
723
+ MachineTypeId?: string;
724
+ /**
725
+ * 隔离组ID
726
+ */
727
+ IsolationGroupId?: string;
728
+ /**
729
+ * 副本集下的节点信息
730
+ */
731
+ NodeInfos?: {
732
+ /**
733
+ * 可用区
734
+ */
735
+ Zone?: string;
736
+ /**
737
+ * 可用区ID
738
+ */
739
+ ZoneId?: number;
740
+ /**
741
+ * 节点ID
742
+ */
743
+ NodeId?: string;
744
+ /**
745
+ * 节点角色,Primary/Secondary/Arbiter/Startup等等
746
+ */
747
+ NodeRole?: string;
748
+ /**
749
+ * 节点类型
750
+ */
751
+ NodeType?: string;
752
+ /**
753
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。
754
+ */
755
+ State?: string;
756
+ /**
757
+ * 副本集的Mongodb的版本
758
+ */
759
+ DBVersion?: string;
760
+ /**
761
+ * 节点所属副本集ID
762
+ */
763
+ ClusterId?: string;
764
+ /**
765
+ * 虚拟节点ID
766
+ */
767
+ VirtualClusterId?: string;
768
+ /**
769
+ * 机型信息
770
+ */
771
+ MachineType?: string;
772
+ /**
773
+ * 机型信息ID
774
+ */
775
+ MachineTypeId?: string;
776
+ /**
777
+ * DB实例创建时间
778
+ */
779
+ CreateTime?: number;
780
+ /**
781
+ * 数据盘信息
782
+ */
783
+ DataDisk?: {
784
+ /**
785
+ * 磁盘id
786
+ */
787
+ DiskId?: string;
788
+ /**
789
+ * 磁盘容量单位GB
790
+ */
791
+ DiskSize?: number;
792
+ };
793
+ /**
794
+ * 系统盘信息
795
+ */
796
+ SysDisk?: {
797
+ /**
798
+ * 磁盘id
799
+ */
800
+ DiskId?: string;
801
+ /**
802
+ * 磁盘容量单位GB
803
+ */
804
+ DiskSize?: number;
805
+ };
806
+ }[];
807
+ /**
808
+ * 副本集下的节点数量
809
+ */
810
+ NodeCount?: number;
811
+ /**
812
+ * 副本集创建时间
813
+ */
814
+ CreateTime?: number;
815
+ /**
816
+ * 副本集删除时间
817
+ */
818
+ DeleteTime?: number;
819
+ /**
820
+ * 副本集修改时间
821
+ */
822
+ ModifyTime?: number;
823
+ }[];
824
+ /**
825
+ * Mongos节点信息
826
+ */
827
+ MongosInfo?: {
828
+ /**
829
+ * 可用区
830
+ */
831
+ Zone?: string;
832
+ /**
833
+ * 可用区ID
834
+ */
835
+ ZoneId?: number;
836
+ /**
837
+ * 节点ID
838
+ */
839
+ NodeId?: string;
840
+ /**
841
+ * 节点角色,Primary/Secondary/Arbiter/Startup等等
842
+ */
843
+ NodeRole?: string;
844
+ /**
845
+ * 节点类型
846
+ */
847
+ NodeType?: string;
848
+ /**
849
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败。
850
+ */
851
+ State?: string;
852
+ /**
853
+ * 副本集的Mongodb的版本
854
+ */
855
+ DBVersion?: string;
856
+ /**
857
+ * 节点所属副本集ID
858
+ */
859
+ ClusterId?: string;
860
+ /**
861
+ * 虚拟节点ID
862
+ */
863
+ VirtualClusterId?: string;
864
+ /**
865
+ * 机型信息
866
+ */
867
+ MachineType?: string;
868
+ /**
869
+ * 机型信息ID
870
+ */
871
+ MachineTypeId?: string;
872
+ /**
873
+ * DB实例创建时间
874
+ */
875
+ CreateTime?: number;
876
+ /**
877
+ * 数据盘信息
878
+ */
879
+ DataDisk?: {
880
+ /**
881
+ * 磁盘id
882
+ */
883
+ DiskId?: string;
884
+ /**
885
+ * 磁盘容量单位GB
886
+ */
887
+ DiskSize?: number;
888
+ };
889
+ /**
890
+ * 系统盘信息
891
+ */
892
+ SysDisk?: {
893
+ /**
894
+ * 磁盘id
895
+ */
896
+ DiskId?: string;
897
+ /**
898
+ * 磁盘容量单位GB
899
+ */
900
+ DiskSize?: number;
901
+ };
902
+ }[];
903
+ /**
904
+ * 副本集的访问地址
905
+ */
906
+ ConnectURL?: string;
907
+ /**
908
+ * DB实例删除时间
909
+ */
910
+ DeleteTime?: number;
911
+ /**
912
+ * 子网ID
913
+ */
914
+ SubnetId?: string;
915
+ /**
916
+ * VPC的ID
917
+ */
918
+ VPCId?: string;
919
+ /**
920
+ * 分片数量,分片集有效
921
+ */
922
+ ShardCount?: number;
923
+ /**
924
+ * 每分片节点数量,分片集有效
925
+ */
926
+ ShardNodeCount?: number;
927
+ /**
928
+ * Mongos节点数量,分片集有效
929
+ */
930
+ MongosCount?: number;
931
+ /**
932
+ * Config配置集群节点数量,分片集有效
933
+ */
934
+ ConfigNodeCount?: number;
935
+ /**
936
+ * Config配置集群节点配置,分片集有效
937
+ */
938
+ ConfigMachineType?: string;
939
+ /**
940
+ * 实例业务组
941
+ */
942
+ Tag?: string;
943
+ /**
944
+ * 数据节点计算规格
945
+ */
946
+ DataComputeType?: {
947
+ /**
948
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
949
+ */
950
+ MachineTypeId: string;
951
+ /**
952
+ * 配置简称 2C4G
953
+ */
954
+ Description: string;
955
+ /**
956
+ * cpu核数
957
+ */
958
+ Cpu: number;
959
+ /**
960
+ * 内存用量(GB)
961
+ */
962
+ Memory: number;
963
+ /**
964
+ * 机器类型,N/O
965
+ */
966
+ UHhostMachineType?: string;
967
+ /**
968
+ * 配置分组,2m , 4m
969
+ */
970
+ Group?: string;
971
+ };
972
+ /**
973
+ * 配置节点计算规格
974
+ */
975
+ ConfigComputeType?: {
976
+ /**
977
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
978
+ */
979
+ MachineTypeId: string;
980
+ /**
981
+ * 配置简称 2C4G
982
+ */
983
+ Description: string;
984
+ /**
985
+ * cpu核数
986
+ */
987
+ Cpu: number;
988
+ /**
989
+ * 内存用量(GB)
990
+ */
991
+ Memory: number;
992
+ /**
993
+ * 机器类型,N/O
994
+ */
995
+ UHhostMachineType?: string;
996
+ /**
997
+ * 配置分组,2m , 4m
998
+ */
999
+ Group?: string;
1000
+ };
1001
+ /**
1002
+ * 路由节点计算规格
1003
+ */
1004
+ MongosComputeType?: {
1005
+ /**
1006
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
1007
+ */
1008
+ MachineTypeId: string;
1009
+ /**
1010
+ * 配置简称 2C4G
1011
+ */
1012
+ Description: string;
1013
+ /**
1014
+ * cpu核数
1015
+ */
1016
+ Cpu: number;
1017
+ /**
1018
+ * 内存用量(GB)
1019
+ */
1020
+ Memory: number;
1021
+ /**
1022
+ * 机器类型,N/O
1023
+ */
1024
+ UHhostMachineType?: string;
1025
+ /**
1026
+ * 配置分组,2m , 4m
1027
+ */
1028
+ Group?: string;
1029
+ };
1030
+ /**
1031
+ * 跨用区列表
1032
+ */
1033
+ CrossZones?: string[];
1034
+ /**
1035
+ * 是否开启了SSL;1->未开启 2->开启
1036
+ */
1037
+ EnableSSL?: number;
1038
+ /**
1039
+ * SSL到期时间
1040
+ */
1041
+ SSLExpirationTime?: number;
1042
+ };
1043
+ }
1044
+ /**
1045
+ * GetUMongoDBBackupParam - 获取实例备份策略
1046
+ */
1047
+ export interface GetUMongoDBBackupParamRequest {
1048
+ /**
1049
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1050
+ */
1051
+ Zone: string;
1052
+ /**
1053
+ * 实例ID
1054
+ */
1055
+ ClusterId: string;
1056
+ }
1057
+ /**
1058
+ * GetUMongoDBBackupParam - 获取实例备份策略
1059
+ */
1060
+ export interface GetUMongoDBBackupParamResponse {
1061
+ /**
1062
+ * 备份策略信息
1063
+ */
1064
+ DataSet: {
1065
+ /**
1066
+ * 实例ID
1067
+ */
1068
+ ClusterId: string;
1069
+ /**
1070
+ * 自动备份预期周几 (1-7 表示 周一到周末,多个数据用','分割,eg: 3,7)
1071
+ */
1072
+ AutoBackupToggleWeek?: string;
1073
+ /**
1074
+ * 自动备份预期时间范围 (24小时制,精确到分钟,00:00~23:59)
1075
+ */
1076
+ AutoBackupToggleTime?: string;
1077
+ /**
1078
+ * 自动备份保存份数
1079
+ */
1080
+ AutoBackupCopies?: number;
1081
+ /**
1082
+ * 手动备份保存份数
1083
+ */
1084
+ ManualBackupCopies?: number;
1085
+ /**
1086
+ * 是否禁用(false:未禁用;true:禁用)
1087
+ */
1088
+ Disabled?: boolean;
1089
+ };
1090
+ }
1091
+ /**
1092
+ * GetUMongoDBCfgTempItem - 获取配置模板内容
1093
+ */
1094
+ export interface GetUMongoDBCfgTempItemRequest {
1095
+ /**
1096
+ * 配置模板Id
1097
+ */
1098
+ TemplateId: string;
1099
+ }
1100
+ /**
1101
+ * GetUMongoDBCfgTempItem - 获取配置模板内容
1102
+ */
1103
+ export interface GetUMongoDBCfgTempItemResponse {
1104
+ /**
1105
+ * 配置模板项
1106
+ */
1107
+ DataSet: {
1108
+ /**
1109
+ * itemId
1110
+ */
1111
+ ItemId?: string;
1112
+ /**
1113
+ * 模板ID
1114
+ */
1115
+ TemplateId?: string;
1116
+ /**
1117
+ * 配置名称
1118
+ */
1119
+ ConfigName?: string;
1120
+ /**
1121
+ * 配置值
1122
+ */
1123
+ ConfigValue?: string;
1124
+ /**
1125
+ * 创建时间
1126
+ */
1127
+ CreateTime?: number;
1128
+ /**
1129
+ * 修改时间
1130
+ */
1131
+ ModifyTime?: number;
1132
+ /**
1133
+ * 配置选项
1134
+ */
1135
+ ConfigOption?: {
1136
+ /**
1137
+ * mongo版本
1138
+ */
1139
+ MongodbVersion?: string;
1140
+ /**
1141
+ * 配置选项名
1142
+ */
1143
+ OptionName?: string;
1144
+ /**
1145
+ * 配置选项类型 string,int,bool
1146
+ */
1147
+ OptionValueType?: string;
1148
+ /**
1149
+ * 配置选项值范围
1150
+ */
1151
+ OptionValues?: string;
1152
+ /**
1153
+ * 默认值
1154
+ */
1155
+ OptionDefaultValue?: string;
1156
+ /**
1157
+ * 是否为默认选项
1158
+ */
1159
+ IsDefaultOption?: boolean;
1160
+ /**
1161
+ * 是否可修改
1162
+ */
1163
+ EnableModify?: boolean;
1164
+ /**
1165
+ * 是否前端展示
1166
+ */
1167
+ EnableDisplay?: boolean;
1168
+ /**
1169
+ * 是否需重启
1170
+ */
1171
+ ForceRestart?: boolean;
1172
+ /**
1173
+ * 选项值格式
1174
+ */
1175
+ OptionFormatType?: string;
1176
+ /**
1177
+ * 允许应用类型
1178
+ */
1179
+ AllowedApplyType?: string;
1180
+ /**
1181
+ * 描述
1182
+ */
1183
+ Description?: string;
1184
+ };
1185
+ /**
1186
+ * 节点类型: DataNode:数据节点 | ConfigSrvNode:配置节点 | MongosNode:路由节点
1187
+ */
1188
+ NodeType?: string;
1189
+ }[];
1190
+ }
1191
+ /**
1192
+ * GetUMongoDBLog - 查询某一段时间内集群节点的错误日志或慢查询日志
1193
+ */
1194
+ export interface GetUMongoDBLogRequest {
1195
+ /**
1196
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1197
+ */
1198
+ Zone?: string;
1199
+ /**
1200
+ * 集群id
1201
+ */
1202
+ ClusterId: string;
1203
+ /**
1204
+ * 节点id, 慢日志 mongos 节点不可选
1205
+ */
1206
+ NodeId: string;
1207
+ /**
1208
+ * 查询的日志开始的时间戳(Unix Timestamp)。对于实时查询,这个参数应该是上次轮询请求时的时间戳,后台会返回从该值到当前时间的日志内容
1209
+ */
1210
+ Begin: number;
1211
+ /**
1212
+ * 日志类型:SlowLog,ErrorLog
1213
+ */
1214
+ LogType: string;
1215
+ /**
1216
+ * 查询日志的结束时间戳(Unix Timestamp),对于实时查询不传该值,与BeginTime的差值不超过24小时:(EndTime-BeginTime) < 24*60*60
1217
+ */
1218
+ End?: number;
1219
+ }
1220
+ /**
1221
+ * GetUMongoDBLog - 查询某一段时间内集群节点的错误日志或慢查询日志
1222
+ */
1223
+ export interface GetUMongoDBLogResponse {
1224
+ /**
1225
+ * 查询到的日志内容,一段纯文本
1226
+ */
1227
+ Log: string;
1228
+ /**
1229
+ * 支持的最大行数
1230
+ */
1231
+ MaxLine?: number;
1232
+ /**
1233
+ * 是否已被截断
1234
+ */
1235
+ IsTruncate?: boolean;
1236
+ }
1237
+ /**
1238
+ * GetUMongoDBRecoverTimeRange - 获取UMongoDB可回档时间范围
1239
+ */
1240
+ export interface GetUMongoDBRecoverTimeRangeRequest {
1241
+ /**
1242
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1243
+ */
1244
+ Zone: string;
1245
+ /**
1246
+ * 集群id
1247
+ */
1248
+ ClusterId: string;
1249
+ }
1250
+ /**
1251
+ * GetUMongoDBRecoverTimeRange - 获取UMongoDB可回档时间范围
1252
+ */
1253
+ export interface GetUMongoDBRecoverTimeRangeResponse {
1254
+ /**
1255
+ * 最早可回档时间点
1256
+ */
1257
+ EarliestTime: number;
1258
+ /**
1259
+ * 最晚可回档时间点
1260
+ */
1261
+ LatestTime: number;
1262
+ }
1263
+ /**
1264
+ * ListUMongoDBBackup - 拉取实例备份列表
1265
+ */
1266
+ export interface ListUMongoDBBackupRequest {
1267
+ /**
1268
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1269
+ */
1270
+ Zone: string;
1271
+ /**
1272
+ * 实例ID
1273
+ */
1274
+ ClusterId: string;
1275
+ }
1276
+ /**
1277
+ * ListUMongoDBBackup - 拉取实例备份列表
1278
+ */
1279
+ export interface ListUMongoDBBackupResponse {
1280
+ /**
1281
+ * 备份列表
1282
+ */
1283
+ DataSet: {
1284
+ /**
1285
+ * 可用区
1286
+ */
1287
+ Zone?: string;
1288
+ /**
1289
+ * 备份ID
1290
+ */
1291
+ BackupId: string;
1292
+ /**
1293
+ * 备份名称
1294
+ */
1295
+ BackupName?: string;
1296
+ /**
1297
+ * 实例ID
1298
+ */
1299
+ ClusterId?: string;
1300
+ /**
1301
+ * 备份状态
1302
+ */
1303
+ State?: string;
1304
+ /**
1305
+ * 备份数据大小
1306
+ */
1307
+ BackupSize?: number;
1308
+ /**
1309
+ * 备份类型
1310
+ */
1311
+ BackupType?: string;
1312
+ /**
1313
+ * 备份开始时间
1314
+ */
1315
+ StartTime?: number;
1316
+ /**
1317
+ * 备份结束时间
1318
+ */
1319
+ EndTime?: number;
1320
+ /**
1321
+ * 虚拟节点id
1322
+ */
1323
+ VirtualClusterId?: string;
1324
+ /**
1325
+ * 副本类型,ConfigRepl或者DataRepl
1326
+ */
1327
+ ReplicaType?: string;
1328
+ /**
1329
+ * 批次id
1330
+ */
1331
+ BatchId?: string;
1332
+ /**
1333
+ * 磁盘大小
1334
+ */
1335
+ DiskSize?: number;
1336
+ }[];
1337
+ }
1338
+ /**
1339
+ * ListUMongoDBConfigTemplate - 拉取配置模板
1340
+ */
1341
+ export interface ListUMongoDBConfigTemplateRequest {
1342
+ }
1343
+ /**
1344
+ * ListUMongoDBConfigTemplate - 拉取配置模板
1345
+ */
1346
+ export interface ListUMongoDBConfigTemplateResponse {
1347
+ /**
1348
+ * 配置模板列表
1349
+ */
1350
+ DataSet: {
1351
+ /**
1352
+ * 模板ID
1353
+ */
1354
+ TemplateId?: string;
1355
+ /**
1356
+ * 模板名称
1357
+ */
1358
+ TemplateName?: string;
1359
+ /**
1360
+ * mongo版本
1361
+ */
1362
+ MongodbVersion?: string;
1363
+ /**
1364
+ * 集群类型
1365
+ */
1366
+ ClusterType?: string;
1367
+ /**
1368
+ * 模板类型 UsersTemplate DefaultTemplate
1369
+ */
1370
+ TemplateType?: string;
1371
+ /**
1372
+ * 创建时间
1373
+ */
1374
+ CreateTime?: number;
1375
+ /**
1376
+ * 修改时间
1377
+ */
1378
+ ModifyTime?: number;
1379
+ /**
1380
+ * 删除时间
1381
+ */
1382
+ DeleteTime?: number;
1383
+ /**
1384
+ * 模板描述
1385
+ */
1386
+ Description?: string;
1387
+ }[];
1388
+ }
1389
+ /**
1390
+ * ListUMongoDBInstances - 获取副本集/分片集群列表
1391
+ */
1392
+ export interface ListUMongoDBInstancesRequest {
1393
+ /**
1394
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1395
+ */
1396
+ Zone?: string;
1397
+ /**
1398
+ * 集群ID
1399
+ */
1400
+ ClusterId?: string;
1401
+ }
1402
+ /**
1403
+ * ListUMongoDBInstances - 获取副本集/分片集群列表
1404
+ */
1405
+ export interface ListUMongoDBInstancesResponse {
1406
+ /**
1407
+ * 副本集ID
1408
+ */
1409
+ DataSet?: {
1410
+ /**
1411
+ * 可用区
1412
+ */
1413
+ Zone: string;
1414
+ /**
1415
+ * 副本集/分片集群ID
1416
+ */
1417
+ ClusterId: string;
1418
+ /**
1419
+ * 副本集/分片集群实例名称
1420
+ */
1421
+ Name: string;
1422
+ /**
1423
+ * 副本集/分片集群的Mongodb的版本,包括MongoDB-3.6, MongoDB-4.2
1424
+ */
1425
+ DBVersion: string;
1426
+ /**
1427
+ * 副本集/分片集群的访问地址
1428
+ */
1429
+ ConnectURL: string;
1430
+ /**
1431
+ * 副本集/分片集群的创建时间
1432
+ */
1433
+ CreateTime: number;
1434
+ /**
1435
+ * 集群类型,ReplicaSet :副本集,SharedCluster:分片集
1436
+ */
1437
+ ClusterType: string;
1438
+ /**
1439
+ * 副本集/分片集群状态标记 Initing:初始化中,InitFailed:安装失败,Starting:启动中,StartFailed:启动失败,Running:运行,Stopping:关闭中,Stopped:已关闭, StopFailed:关闭失败,Deleting:删除中,Deleted:已删除,DeleteFailed:删除失败,Restarting:重启中,RestartFailed:重启失败,Upgrading: 升降级中,UpgradeFailed: 升降级失败,Switching:主备切换中
1440
+ */
1441
+ State: string;
1442
+ /**
1443
+ * 副本集/分片集IPv6访问地址
1444
+ */
1445
+ IPv6ConnectURL?: string;
1446
+ /**
1447
+ * DB实例过期时间,采用UTC计时时间戳
1448
+ */
1449
+ ExpiredTime?: number;
1450
+ /**
1451
+ * 数据节点计算规格
1452
+ */
1453
+ DataComputeType?: {
1454
+ /**
1455
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
1456
+ */
1457
+ MachineTypeId: string;
1458
+ /**
1459
+ * 配置简称 2C4G
1460
+ */
1461
+ Description: string;
1462
+ /**
1463
+ * cpu核数
1464
+ */
1465
+ Cpu: number;
1466
+ /**
1467
+ * 内存用量(GB)
1468
+ */
1469
+ Memory: number;
1470
+ /**
1471
+ * 机器类型,N/O
1472
+ */
1473
+ UHhostMachineType?: string;
1474
+ /**
1475
+ * 配置分组,2m , 4m
1476
+ */
1477
+ Group?: string;
1478
+ };
1479
+ /**
1480
+ * VPC的ID
1481
+ */
1482
+ VPCId?: string;
1483
+ /**
1484
+ * 子网ID
1485
+ */
1486
+ SubnetId?: string;
1487
+ /**
1488
+ * 数据节点磁盘空间(GB)
1489
+ */
1490
+ DiskSpace?: number;
1491
+ /**
1492
+ * 业务组
1493
+ */
1494
+ Tag?: string;
1495
+ /**
1496
+ * 跨可用区列表
1497
+ */
1498
+ CrossZones?: string[];
1499
+ }[];
1500
+ }
1501
+ /**
1502
+ * ListUMongoDBLogPackage - 日志打包列表
1503
+ */
1504
+ export interface ListUMongoDBLogPackageRequest {
1505
+ /**
1506
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1507
+ */
1508
+ Zone: string;
1509
+ /**
1510
+ * 集群id
1511
+ */
1512
+ ClusterId: string;
1513
+ /**
1514
+ * 节点id
1515
+ */
1516
+ NodeId?: string;
1517
+ }
1518
+ /**
1519
+ * ListUMongoDBLogPackage - 日志打包列表
1520
+ */
1521
+ export interface ListUMongoDBLogPackageResponse {
1522
+ /**
1523
+ * 列表
1524
+ */
1525
+ DataSet: {
1526
+ /**
1527
+ * id
1528
+ */
1529
+ Id?: number;
1530
+ /**
1531
+ * 名称
1532
+ */
1533
+ Name?: string;
1534
+ /**
1535
+ * Package_Running,Package_Success,Package_Failed,Package_Deleting,Package_Deleted,Package_DeleteFailed
1536
+ */
1537
+ State?: string;
1538
+ /**
1539
+ * 大小,单位字节
1540
+ */
1541
+ Size?: number;
1542
+ /**
1543
+ * SlowLog,ErrorLog
1544
+ */
1545
+ PackageType?: string;
1546
+ /**
1547
+ * 集群id
1548
+ */
1549
+ ClusterId?: string;
1550
+ /**
1551
+ * 节点id
1552
+ */
1553
+ NodeId?: string;
1554
+ /**
1555
+ * 角色
1556
+ */
1557
+ Role?: string;
1558
+ /**
1559
+ * 开始时间
1560
+ */
1561
+ Begin?: number;
1562
+ /**
1563
+ * 结束时间
1564
+ */
1565
+ End?: number;
1566
+ /**
1567
+ * 创建时间
1568
+ */
1569
+ CreateTime?: number;
1570
+ /**
1571
+ * 完成时间
1572
+ */
1573
+ FinishTime?: number;
1574
+ }[];
1575
+ }
1576
+ /**
1577
+ * ListUMongoDBMachineSpec - 获取UMongoDB支持机器类型列表
1578
+ */
1579
+ export interface ListUMongoDBMachineSpecRequest {
1580
+ /**
1581
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1582
+ */
1583
+ Zone: string;
1584
+ /**
1585
+ * 机型,如O
1586
+ */
1587
+ ClassType?: string;
1588
+ /**
1589
+ * 磁盘类型,如CLOUD_RSSD
1590
+ */
1591
+ DiskType?: string;
1592
+ }
1593
+ /**
1594
+ * ListUMongoDBMachineSpec - 获取UMongoDB支持机器类型列表
1595
+ */
1596
+ export interface ListUMongoDBMachineSpecResponse {
1597
+ /**
1598
+ * 规格列表
1599
+ */
1600
+ DataSet: {
1601
+ /**
1602
+ * 规格类型;O | N
1603
+ */
1604
+ ClassType?: string;
1605
+ /**
1606
+ * 磁盘类型;CLOUD_RSSD | CLOUD_SSD | LOCAL_SSD
1607
+ */
1608
+ DiskType?: string[];
1609
+ /**
1610
+ * 计算规格列表
1611
+ */
1612
+ ComputeType?: {
1613
+ /**
1614
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
1615
+ */
1616
+ MachineTypeId: string;
1617
+ /**
1618
+ * 配置简称 2C4G
1619
+ */
1620
+ Description: string;
1621
+ /**
1622
+ * cpu核数
1623
+ */
1624
+ Cpu: number;
1625
+ /**
1626
+ * 内存用量(GB)
1627
+ */
1628
+ Memory: number;
1629
+ /**
1630
+ * 机器类型,N/O
1631
+ */
1632
+ UHhostMachineType?: string;
1633
+ /**
1634
+ * 配置分组,2m , 4m
1635
+ */
1636
+ Group?: string;
1637
+ }[];
1638
+ /**
1639
+ * 默认规格
1640
+ */
1641
+ DefaultMachineType?: {
1642
+ /**
1643
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
1644
+ */
1645
+ MachineTypeId: string;
1646
+ /**
1647
+ * 配置简称 2C4G
1648
+ */
1649
+ Description: string;
1650
+ /**
1651
+ * cpu核数
1652
+ */
1653
+ Cpu: number;
1654
+ /**
1655
+ * 内存用量(GB)
1656
+ */
1657
+ Memory: number;
1658
+ /**
1659
+ * 机器类型,N/O
1660
+ */
1661
+ UHhostMachineType?: string;
1662
+ /**
1663
+ * 配置分组,2m , 4m
1664
+ */
1665
+ Group?: string;
1666
+ };
1667
+ }[];
1668
+ }
1669
+ /**
1670
+ * ListUMongoDBMachineType - 获取UmongDB支持机器类型列表
1671
+ */
1672
+ export interface ListUMongoDBMachineTypeRequest {
1673
+ /**
1674
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1675
+ */
1676
+ Zone: string;
1677
+ }
1678
+ /**
1679
+ * ListUMongoDBMachineType - 获取UmongDB支持机器类型列表
1680
+ */
1681
+ export interface ListUMongoDBMachineTypeResponse {
1682
+ /**
1683
+ *
1684
+ */
1685
+ DataSet: {
1686
+ /**
1687
+ * 机器类型ID o.mongo2m.medium,o.mongo2m.xlarge
1688
+ */
1689
+ MachineTypeId: string;
1690
+ /**
1691
+ * 配置简称 2C4G
1692
+ */
1693
+ Description: string;
1694
+ /**
1695
+ * cpu核数
1696
+ */
1697
+ Cpu: number;
1698
+ /**
1699
+ * 内存用量(GB)
1700
+ */
1701
+ Memory: number;
1702
+ /**
1703
+ * 机器类型,N/O
1704
+ */
1705
+ UHhostMachineType?: string;
1706
+ /**
1707
+ * 配置分组,2m , 4m
1708
+ */
1709
+ Group?: string;
1710
+ }[];
1711
+ }
1712
+ /**
1713
+ * ListUMongoDBVersion - 获取UMongoDB支持版本列表
1714
+ */
1715
+ export interface ListUMongoDBVersionRequest {
1716
+ /**
1717
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1718
+ */
1719
+ Zone: string;
1720
+ }
1721
+ /**
1722
+ * ListUMongoDBVersion - 获取UMongoDB支持版本列表
1723
+ */
1724
+ export interface ListUMongoDBVersionResponse {
1725
+ /**
1726
+ *
1727
+ */
1728
+ DataSet: {
1729
+ /**
1730
+ * MongoDB版本
1731
+ */
1732
+ DBVersion?: string;
1733
+ }[];
1734
+ }
1735
+ /**
1736
+ * ModifyUMongoDBAdminPassword - 修改MongoDB集群root密码
1737
+ */
1738
+ export interface ModifyUMongoDBAdminPasswordRequest {
1739
+ /**
1740
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1741
+ */
1742
+ Zone: string;
1743
+ /**
1744
+ * 集群ID
1745
+ */
1746
+ ClusterId: string;
1747
+ /**
1748
+ * 集群新密码(密码格式使用BASE64编码)
1749
+ */
1750
+ Password: string;
1751
+ }
1752
+ /**
1753
+ * ModifyUMongoDBAdminPassword - 修改MongoDB集群root密码
1754
+ */
1755
+ export interface ModifyUMongoDBAdminPasswordResponse {
1756
+ }
1757
+ /**
1758
+ * ModifyUMongoDBAttribute - 修改MongoDB集群名称
1759
+ */
1760
+ export interface ModifyUMongoDBAttributeRequest {
1761
+ /**
1762
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1763
+ */
1764
+ Zone: string;
1765
+ /**
1766
+ * 集群id
1767
+ */
1768
+ ClusterId: string;
1769
+ /**
1770
+ * 集群新名称(输入长度为6~63位名称)
1771
+ */
1772
+ Name?: string;
1773
+ /**
1774
+ * 集群备注(Name和RemarkName必传其一)
1775
+ */
1776
+ RemarkName?: string;
1777
+ }
1778
+ /**
1779
+ * ModifyUMongoDBAttribute - 修改MongoDB集群名称
1780
+ */
1781
+ export interface ModifyUMongoDBAttributeResponse {
1782
+ }
1783
+ /**
1784
+ * ModifyUMongoDBBackupParam - 修改实例备份策略
1785
+ */
1786
+ export interface ModifyUMongoDBBackupParamRequest {
1787
+ /**
1788
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1789
+ */
1790
+ Zone: string;
1791
+ /**
1792
+ * 实例ID
1793
+ */
1794
+ ClusterId: string;
1795
+ /**
1796
+ * 自动备份预期星期几(1~7),默认 3,7 (周三,周日)
1797
+ */
1798
+ AutoBackupToggleWeek?: string;
1799
+ /**
1800
+ * 自动备份预期开始时间范围(00:00~23:59),默认 5:00~6:00
1801
+ */
1802
+ AutoBackupToggleTime?: string;
1803
+ /**
1804
+ * 是否禁用,true:禁用;false:开启
1805
+ */
1806
+ Disabled?: boolean;
1807
+ }
1808
+ /**
1809
+ * ModifyUMongoDBBackupParam - 修改实例备份策略
1810
+ */
1811
+ export interface ModifyUMongoDBBackupParamResponse {
1812
+ }
1813
+ /**
1814
+ * ResizeUMongoDBInstance - 集群配置升降级
1815
+ */
1816
+ export interface ResizeUMongoDBInstanceRequest {
1817
+ /**
1818
+ * 集群资源ID
1819
+ */
1820
+ ClusterId: string;
1821
+ /**
1822
+ * 集群数据节点磁盘配置
1823
+ */
1824
+ DiskSpace?: number;
1825
+ /**
1826
+ * 集群数据节点机型配置
1827
+ */
1828
+ MachineTypeId?: string;
1829
+ /**
1830
+ * 集群Mongos节点机型配置
1831
+ */
1832
+ MongosMachineTypeId?: string;
1833
+ }
1834
+ /**
1835
+ * ResizeUMongoDBInstance - 集群配置升降级
1836
+ */
1837
+ export interface ResizeUMongoDBInstanceResponse {
1838
+ }
1839
+ /**
1840
+ * RestartUMongoDBCluster - 重启集群
1841
+ */
1842
+ export interface RestartUMongoDBClusterRequest {
1843
+ /**
1844
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1845
+ */
1846
+ Zone: string;
1847
+ /**
1848
+ * 集群ID
1849
+ */
1850
+ ClusterId: string;
1851
+ }
1852
+ /**
1853
+ * RestartUMongoDBCluster - 重启集群
1854
+ */
1855
+ export interface RestartUMongoDBClusterResponse {
1856
+ /**
1857
+ * 集群ID
1858
+ */
1859
+ ClusterId: string;
1860
+ }
1861
+ /**
1862
+ * StartUMongoDBCluster - 启动集群
1863
+ */
1864
+ export interface StartUMongoDBClusterRequest {
1865
+ /**
1866
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1867
+ */
1868
+ Zone: string;
1869
+ /**
1870
+ * 集群ID
1871
+ */
1872
+ ClusterId: string;
1873
+ }
1874
+ /**
1875
+ * StartUMongoDBCluster - 启动集群
1876
+ */
1877
+ export interface StartUMongoDBClusterResponse {
1878
+ /**
1879
+ * 集群ID
1880
+ */
1881
+ ClusterId: string;
1882
+ }
1883
+ /**
1884
+ * StopUMongoDBCluster - 停止集群
1885
+ */
1886
+ export interface StopUMongoDBClusterRequest {
1887
+ /**
1888
+ * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
1889
+ */
1890
+ Zone: string;
1891
+ /**
1892
+ * 集群ID
1893
+ */
1894
+ ClusterId: string;
1895
+ }
1896
+ /**
1897
+ * StopUMongoDBCluster - 停止集群
1898
+ */
1899
+ export interface StopUMongoDBClusterResponse {
1900
+ /**
1901
+ * 集群ID
1902
+ */
1903
+ ClusterId: string;
1904
+ }