tencentcloud-sdk-nodejs-mongodb 4.0.299 → 4.0.303

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.
@@ -15,21 +15,6 @@
15
15
  * under the License.
16
16
  */
17
17
 
18
- /**
19
- * ResetDBInstancePassword返回参数结构体
20
- */
21
- export interface ResetDBInstancePasswordResponse {
22
- /**
23
- * 异步请求Id,用户查询该流程的运行状态
24
- */
25
- AsyncRequestId: string
26
-
27
- /**
28
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
29
- */
30
- RequestId?: string
31
- }
32
-
33
18
  /**
34
19
  * DescribeSpecInfo请求参数结构体
35
20
  */
@@ -40,36 +25,6 @@ export interface DescribeSpecInfoRequest {
40
25
  Zone?: string
41
26
  }
42
27
 
43
- /**
44
- * SetAccountUserPrivilege返回参数结构体
45
- */
46
- export interface SetAccountUserPrivilegeResponse {
47
- /**
48
- * 设置任务ID,用于查询是否设置完成
49
- */
50
- FlowId: number
51
-
52
- /**
53
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
54
- */
55
- RequestId?: string
56
- }
57
-
58
- /**
59
- * KillOps请求参数结构体
60
- */
61
- export interface KillOpsRequest {
62
- /**
63
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
64
- */
65
- InstanceId: string
66
-
67
- /**
68
- * 待终止的操作
69
- */
70
- Operations: Array<Operation>
71
- }
72
-
73
28
  /**
74
29
  * CreateDBInstance请求参数结构体
75
30
  */
@@ -205,21 +160,6 @@ export interface CreateDBInstanceRequest {
205
160
  MongosNodeNum?: number
206
161
  }
207
162
 
208
- /**
209
- * DescribeSecurityGroup返回参数结构体
210
- */
211
- export interface DescribeSecurityGroupResponse {
212
- /**
213
- * 实例绑定的安全组
214
- */
215
- Groups: Array<SecurityGroup>
216
-
217
- /**
218
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
219
- */
220
- RequestId?: string
221
- }
222
-
223
163
  /**
224
164
  * DescribeCurrentOp返回参数结构体
225
165
  */
@@ -241,11 +181,11 @@ export interface DescribeCurrentOpResponse {
241
181
  }
242
182
 
243
183
  /**
244
- * IsolateDBInstance返回参数结构体
184
+ * CreateBackupDBInstance返回参数结构体
245
185
  */
246
- export interface IsolateDBInstanceResponse {
186
+ export interface CreateBackupDBInstanceResponse {
247
187
  /**
248
- * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
188
+ * 查询备份流程的状态
249
189
  */
250
190
  AsyncRequestId: string
251
191
 
@@ -256,194 +196,194 @@ export interface IsolateDBInstanceResponse {
256
196
  }
257
197
 
258
198
  /**
259
- * 创建备份下载任务结果
199
+ * 数据库实例价格
260
200
  */
261
- export interface BackupDownloadTaskStatus {
201
+ export interface DBInstancePrice {
262
202
  /**
263
- * 分片名
203
+ * 单价
204
+ 注意:此字段可能返回 null,表示取不到有效值。
205
+ */
206
+ UnitPrice: number
207
+
208
+ /**
209
+ * 原价
264
210
  */
265
- ReplicaSetId: string
211
+ OriginalPrice: number
266
212
 
267
213
  /**
268
- * 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
214
+ * 折扣加
269
215
  */
270
- Status: number
216
+ DiscountPrice: number
271
217
  }
272
218
 
273
219
  /**
274
- * CreateBackupDBInstance返回参数结构体
220
+ * KillOps请求参数结构体
275
221
  */
276
- export interface CreateBackupDBInstanceResponse {
222
+ export interface KillOpsRequest {
277
223
  /**
278
- * 查询备份流程的状态
224
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
279
225
  */
280
- AsyncRequestId: string
226
+ InstanceId: string
281
227
 
282
228
  /**
283
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
229
+ * 待终止的操作
284
230
  */
285
- RequestId?: string
231
+ Operations: Array<Operation>
286
232
  }
287
233
 
288
234
  /**
289
- * 实例分片详情
235
+ * InquirePriceRenewDBInstances请求参数结构体
290
236
  */
291
- export interface ShardInfo {
292
- /**
293
- * 分片已使用容量
294
- */
295
- UsedVolume: number
296
-
237
+ export interface InquirePriceRenewDBInstancesRequest {
297
238
  /**
298
- * 分片ID
239
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同,接口单次最多只支持5个实例进行操作。
299
240
  */
300
- ReplicaSetId: string
241
+ InstanceIds: Array<string>
301
242
 
302
243
  /**
303
- * 分片名
244
+ * 预付费模式(即包年包月)相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
304
245
  */
305
- ReplicaSetName: string
246
+ InstanceChargePrepaid: InstanceChargePrepaid
247
+ }
306
248
 
249
+ /**
250
+ * DescribeSlowLogs请求参数结构体
251
+ */
252
+ export interface DescribeSlowLogsRequest {
307
253
  /**
308
- * 分片内存规格,单位为MB
254
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
309
255
  */
310
- Memory: number
256
+ InstanceId: string
311
257
 
312
258
  /**
313
- * 分片磁盘规格,单位为MB
259
+ * 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
314
260
  */
315
- Volume: number
261
+ StartTime: string
316
262
 
317
263
  /**
318
- * 分片Oplog大小,单位为MB
264
+ * 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
319
265
  */
320
- OplogSize: number
266
+ EndTime: string
321
267
 
322
268
  /**
323
- * 分片从节点数
269
+ * 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
324
270
  */
325
- SecondaryNum: number
271
+ SlowMS: number
326
272
 
327
273
  /**
328
- * 分片物理id
274
+ * 偏移量,最小值为0,最大值为10000,默认值为0。
329
275
  */
330
- RealReplicaSetId: string
331
- }
332
-
333
- /**
334
- * 数据库实例价格
335
- */
336
- export interface DBInstancePrice {
337
- /**
338
- * 单价
339
- 注意:此字段可能返回 null,表示取不到有效值。
340
- */
341
- UnitPrice: number
276
+ Offset?: number
342
277
 
343
278
  /**
344
- * 原价
279
+ * 分页大小,最小值为1,最大值为100,默认值为20。
345
280
  */
346
- OriginalPrice: number
281
+ Limit?: number
347
282
 
348
283
  /**
349
- * 折扣加
284
+ * 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
350
285
  */
351
- DiscountPrice: number
286
+ Format?: string
352
287
  }
353
288
 
354
289
  /**
355
- * 备份文件存储信息
290
+ * FlushInstanceRouterConfig返回参数结构体
356
291
  */
357
- export interface BackupFile {
292
+ export interface FlushInstanceRouterConfigResponse {
358
293
  /**
359
- * 备份文件所属的副本集/分片ID
294
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
360
295
  */
361
- ReplicateSetId: string
296
+ RequestId?: string
297
+ }
362
298
 
299
+ /**
300
+ * DescribeSecurityGroup请求参数结构体
301
+ */
302
+ export interface DescribeSecurityGroupRequest {
363
303
  /**
364
- * 备份文件保存路径
304
+ * 实例ID,格式如:cmgo-p8vnipr5。
365
305
  */
366
- File: string
306
+ InstanceId: string
367
307
  }
368
308
 
369
309
  /**
370
- * InquirePriceCreateDBInstances请求参数结构体
310
+ * 用于描述MongoDB数据库慢日志统计信息
371
311
  */
372
- export interface InquirePriceCreateDBInstancesRequest {
312
+ export interface SlowLogPattern {
373
313
  /**
374
- * 实例所属区域名称,格式如:ap-guangzhou-2
314
+ * 慢日志模式
375
315
  */
376
- Zone: string
316
+ Pattern: string
377
317
 
378
318
  /**
379
- * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
319
+ * 最大执行时间
380
320
  */
381
- NodeNum: number
321
+ MaxTime: number
382
322
 
383
323
  /**
384
- * 实例内存大小,单位:GB
324
+ * 平均执行时间
385
325
  */
386
- Memory: number
326
+ AverageTime: number
387
327
 
388
328
  /**
389
- * 实例硬盘大小,单位:GB
329
+ * 该模式慢日志条数
390
330
  */
391
- Volume: number
331
+ Total: number
332
+ }
392
333
 
334
+ /**
335
+ * AssignProject返回参数结构体
336
+ */
337
+ export interface AssignProjectResponse {
393
338
  /**
394
- * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(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存储引擎版本
339
+ * 返回的异步任务ID列表
395
340
  */
396
- MongoVersion: string
341
+ FlowIds: Array<number>
397
342
 
398
343
  /**
399
- * 机器类型,HIO:高IO型;HIO10G:高IO万兆型;
344
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
400
345
  */
401
- MachineCode: string
346
+ RequestId?: string
347
+ }
402
348
 
349
+ /**
350
+ * DescribeDBInstanceDeal返回参数结构体
351
+ */
352
+ export interface DescribeDBInstanceDealResponse {
403
353
  /**
404
- * 实例数量, 最小值1,最大值为10
354
+ * 订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
405
355
  */
406
- GoodsNum: number
356
+ Status: number
407
357
 
408
358
  /**
409
- * 实例时长,单位:月,可选值包括[1,2,3,4,5,6,7,8,9,10,11,12,24,36]
359
+ * 订单原价。
410
360
  */
411
- Period: number
361
+ OriginalPrice: number
412
362
 
413
363
  /**
414
- * 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
364
+ * 订单折扣价格。
415
365
  */
416
- ClusterType: string
366
+ DiscountPrice: number
417
367
 
418
368
  /**
419
- * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0
369
+ * 订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
420
370
  */
421
- ReplicateSetNum: number
422
- }
371
+ Action: string
423
372
 
424
- /**
425
- * IsolateDBInstance请求参数结构体
426
- */
427
- export interface IsolateDBInstanceRequest {
428
373
  /**
429
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
374
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
430
375
  */
431
- InstanceId: string
376
+ RequestId?: string
432
377
  }
433
378
 
434
379
  /**
435
- * DescribeSlowLogPatterns返回参数结构体
380
+ * OfflineIsolatedDBInstance返回参数结构体
436
381
  */
437
- export interface DescribeSlowLogPatternsResponse {
438
- /**
439
- * 慢日志统计信息总数
440
- */
441
- Count: number
442
-
382
+ export interface OfflineIsolatedDBInstanceResponse {
443
383
  /**
444
- * 慢日志统计信息
384
+ * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
445
385
  */
446
- SlowLogPatterns: Array<SlowLogPattern>
386
+ AsyncRequestId: string
447
387
 
448
388
  /**
449
389
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -452,276 +392,377 @@ export interface DescribeSlowLogPatternsResponse {
452
392
  }
453
393
 
454
394
  /**
455
- * 分片信息
395
+ * IsolateDBInstance返回参数结构体
456
396
  */
457
- export interface ReplicaSetInfo {
397
+ export interface IsolateDBInstanceResponse {
458
398
  /**
459
- * 分片名称
399
+ * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
460
400
  */
461
- ReplicaSetId: string
462
- }
401
+ AsyncRequestId: string
463
402
 
464
- /**
465
- * CreateDBInstanceHour请求参数结构体
466
- */
467
- export interface CreateDBInstanceHourRequest {
468
403
  /**
469
- * 实例内存大小,单位:GB
404
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
470
405
  */
471
- Memory: number
406
+ RequestId?: string
407
+ }
472
408
 
409
+ /**
410
+ * 实例可修改参数Multi类型集合。
411
+ */
412
+ export interface InstanceMultiParam {
473
413
  /**
474
- * 实例硬盘大小,单位:GB
414
+ * 当前值
475
415
  */
476
- Volume: number
416
+ CurrentValue: string
477
417
 
478
418
  /**
479
- * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数
419
+ * 默认值
480
420
  */
481
- ReplicateSetNum: number
421
+ DefaultValue: string
482
422
 
483
423
  /**
484
- * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
424
+ * 指导值范围
485
425
  */
486
- NodeNum: number
426
+ EnumValue: Array<string>
487
427
 
488
428
  /**
489
- * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(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存储引擎版本
429
+ * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
490
430
  */
491
- MongoVersion: string
431
+ NeedRestart: string
492
432
 
493
433
  /**
494
- * 机器类型,HIO:高IO型;HIO10G:高IO万兆
434
+ * 参数名称
495
435
  */
496
- MachineCode: string
436
+ ParamName: string
497
437
 
498
438
  /**
499
- * 实例数量,最小值1,最大值为10
439
+ * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
500
440
  */
501
- GoodsNum: number
441
+ Status: number
502
442
 
503
443
  /**
504
- * 可用区信息,格式如:ap-guangzhou-2。注:此参数填写的是主可用区,如果选择多可用区部署,Zone必须是AvailabilityZoneList中的一个
444
+ * 参数说明
505
445
  */
506
- Zone: string
446
+ Tips: Array<string>
507
447
 
508
448
  /**
509
- * 实例类型,REPLSET-副本集,SHARD-分片集群
449
+ * 当前值的类型描述,默认为multi
510
450
  */
511
- ClusterType: string
451
+ ValueType: string
452
+ }
512
453
 
454
+ /**
455
+ * DescribeBackupDownloadTask返回参数结构体
456
+ */
457
+ export interface DescribeBackupDownloadTaskResponse {
513
458
  /**
514
- * 私有网络ID,如果不设置该参数则默认选择基础网络
459
+ * 满足查询条件的所有条数
515
460
  */
516
- VpcId?: string
461
+ TotalCount: number
517
462
 
518
463
  /**
519
- * 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
464
+ * 下载任务列表
520
465
  */
521
- SubnetId?: string
466
+ Tasks: Array<BackupDownloadTask>
522
467
 
523
468
  /**
524
- * 实例密码,不设置该参数则默认密码规则为 实例ID+"@"+主账户uin。举例实例id为cmgo-higv73ed,uin为100000001,则默认密码为"cmgo-higv73ed@100000001"。密码必须是8-16位字符,且至少包含字母、数字和字符 !@#%^*() 中的两种
469
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
525
470
  */
526
- Password?: string
471
+ RequestId?: string
472
+ }
527
473
 
474
+ /**
475
+ * FlushInstanceRouterConfig请求参数结构体
476
+ */
477
+ export interface FlushInstanceRouterConfigRequest {
528
478
  /**
529
- * 项目ID,不设置为默认项目
479
+ * 实例ID
530
480
  */
531
- ProjectId?: number
481
+ InstanceId: string
482
+ }
532
483
 
484
+ /**
485
+ * 实例信息
486
+ */
487
+ export interface DBInstanceInfo {
533
488
  /**
534
- * 实例标签信息
489
+ * 实例ID
535
490
  */
536
- Tags?: Array<TagInfo>
491
+ InstanceId: string
537
492
 
538
493
  /**
539
- * 1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例
494
+ * 地域信息
540
495
  */
541
- Clone?: number
496
+ Region: string
497
+ }
542
498
 
499
+ /**
500
+ * SetAccountUserPrivilege返回参数结构体
501
+ */
502
+ export interface SetAccountUserPrivilegeResponse {
543
503
  /**
544
- * 父实例Id,当Clone为3或者4时,这个必须填
504
+ * 设置任务ID,用于查询是否设置完成
545
505
  */
546
- Father?: string
506
+ FlowId: number
547
507
 
548
508
  /**
549
- * 安全组
509
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
550
510
  */
551
- SecurityGroup?: Array<string>
511
+ RequestId?: string
512
+ }
552
513
 
514
+ /**
515
+ * CreateDBInstanceHour返回参数结构体
516
+ */
517
+ export interface CreateDBInstanceHourResponse {
553
518
  /**
554
- * 克隆实例回档时间。若是克隆实例,则必须填写,示例:2021-08-13 16:30:00。注:只能回档7天内的时间点
519
+ * 订单ID
555
520
  */
556
- RestoreTime?: string
521
+ DealId: string
557
522
 
558
523
  /**
559
- * 实例名称。注:名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
524
+ * 创建的实例ID列表
560
525
  */
561
- InstanceName?: string
526
+ InstanceIds: Array<string>
562
527
 
563
528
  /**
564
- * 多可用区部署的节点列表,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:1、多可用区部署节点只能部署在3个不同可用区;2、为了保障跨可用区切换,不支持将集群的大多数节点部署在同一个可用区(如3节点集群不支持2个节点部署在同一个区);3、不支持4.2及以上版本;4、不支持只读灾备实例;5、不能选择基础网络
529
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
565
530
  */
566
- AvailabilityZoneList?: Array<string>
531
+ RequestId?: string
532
+ }
567
533
 
534
+ /**
535
+ * 需要终止的操作
536
+ */
537
+ export interface Operation {
568
538
  /**
569
- * mongos cpu数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
539
+ * 操作所在的分片名
570
540
  */
571
- MongosCpu?: number
541
+ ReplicaSetName: string
572
542
 
573
543
  /**
574
- * mongos 内存大小,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
544
+ * 操作所在的节点名
575
545
  */
576
- MongosMemory?: number
546
+ NodeName: string
577
547
 
578
548
  /**
579
- * mongos 数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:为了保障高可用,最低需要购买3个mongos,上限为32个
549
+ * 操作序号
580
550
  */
581
- MongosNodeNum?: number
551
+ OpId: number
582
552
  }
583
553
 
584
554
  /**
585
- * AssignProject请求参数结构体
555
+ * mongodb售卖规格
586
556
  */
587
- export interface AssignProjectRequest {
557
+ export interface SpecItem {
588
558
  /**
589
- * 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
559
+ * 规格信息标识
590
560
  */
591
- InstanceIds: Array<string>
561
+ SpecCode: string
592
562
 
593
563
  /**
594
- * 项目ID,用户已创建项目的唯一ID,非自定义
564
+ * 规格有效标志,取值:0-停止售卖,1-开放售卖
595
565
  */
596
- ProjectId: number
597
- }
566
+ Status: number
598
567
 
599
- /**
600
- * 安全组规则
601
- */
602
- export interface SecurityGroupBound {
603
568
  /**
604
- * 执行规则。ACCEPT或DROP
569
+ * 计算资源规格,单位为CPU核心数
605
570
  */
606
- Action: string
571
+ Cpu: number
607
572
 
608
573
  /**
609
- * ip段。
574
+ * 内存规格,单位为MB
610
575
  */
611
- CidrIp: string
576
+ Memory: number
612
577
 
613
578
  /**
614
- * 端口范围
579
+ * 默认磁盘规格,单位MB
615
580
  */
616
- PortRange: string
581
+ DefaultStorage: number
617
582
 
618
583
  /**
619
- * 传输层协议。tcp,udp或ALL
584
+ * 最大磁盘规格,单位MB
620
585
  */
621
- IpProtocol: string
586
+ MaxStorage: number
622
587
 
623
588
  /**
624
- * 安全组id代表的地址集合
589
+ * 最小磁盘规格,单位MB
625
590
  */
626
- Id: string
591
+ MinStorage: number
627
592
 
628
593
  /**
629
- * 地址组id代表的地址集合
594
+ * 可承载qps信息
630
595
  */
631
- AddressModule: string
596
+ Qps: number
632
597
 
633
598
  /**
634
- * 服务组id代表的协议和端口集合
599
+ * 连接数限制
635
600
  */
636
- ServiceModule: string
601
+ Conns: number
637
602
 
638
603
  /**
639
- * 描述
604
+ * 实例mongodb版本信息
640
605
  */
641
- Desc: string
642
- }
606
+ MongoVersionCode: string
643
607
 
644
- /**
645
- * CreateBackupDownloadTask返回参数结构体
646
- */
647
- export interface CreateBackupDownloadTaskResponse {
648
608
  /**
649
- * 下载任务状态
609
+ * 实例mongodb版本号
650
610
  */
651
- Tasks: Array<BackupDownloadTaskStatus>
611
+ MongoVersionValue: number
652
612
 
653
613
  /**
654
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
614
+ * 实例mongodb版本号(短)
655
615
  */
656
- RequestId?: string
657
- }
616
+ Version: string
658
617
 
659
- /**
660
- * 客户端连接信息,包括客户端IP和连接数
661
- */
662
- export interface ClientConnection {
663
618
  /**
664
- * 连接的客户端IP
619
+ * 存储引擎
665
620
  */
666
- IP: string
621
+ EngineName: string
667
622
 
668
623
  /**
669
- * 对应客户端IP的连接数
624
+ * 集群类型,取值:1-分片集群,0-副本集集群
670
625
  */
671
- Count: number
626
+ ClusterType: number
672
627
 
673
628
  /**
674
- * 是否为内部ip
629
+ * 最小副本集从节点数
675
630
  */
676
- InternalService: boolean
677
- }
631
+ MinNodeNum: number
678
632
 
679
- /**
680
- * InquirePriceModifyDBInstanceSpec请求参数结构体
681
- */
682
- export interface InquirePriceModifyDBInstanceSpecRequest {
683
633
  /**
684
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
634
+ * 最大副本集从节点数
685
635
  */
686
- InstanceId: string
636
+ MaxNodeNum: number
687
637
 
688
638
  /**
689
- * 变更配置后实例内存大小,单位:GB。
639
+ * 最小分片数
690
640
  */
691
- Memory: number
641
+ MinReplicateSetNum: number
692
642
 
693
643
  /**
694
- * 变更配置后实例磁盘大小,单位:GB。
644
+ * 最大分片数
695
645
  */
696
- Volume: number
646
+ MaxReplicateSetNum: number
697
647
 
698
648
  /**
699
- * 实例变更后的节点数,取值范围具体参照查询云数据库的售卖规格返回参数。默认为不变更节点数
649
+ * 最小分片从节点数
700
650
  */
701
- NodeNum?: number
651
+ MinReplicateSetNodeNum: number
702
652
 
703
653
  /**
704
- * 实例变更后的分片数,取值范围具体参照查询云数据库的售卖规格返回参数。只能增加不能减少,默认为不变更分片数
654
+ * 最大分片从节点数
705
655
  */
706
- ReplicateSetNum?: number
656
+ MaxReplicateSetNodeNum: number
657
+
658
+ /**
659
+ * 机器类型,取值:0-HIO,4-HIO10G
660
+ */
661
+ MachineType: string
707
662
  }
708
663
 
709
664
  /**
710
- * 备份信息
665
+ * DescribeSlowLogPatterns返回参数结构体
711
666
  */
712
- export interface BackupInfo {
667
+ export interface DescribeSlowLogPatternsResponse {
713
668
  /**
714
- * 实例ID
669
+ * 慢日志统计信息总数
715
670
  */
716
- InstanceId: string
671
+ Count: number
717
672
 
718
673
  /**
719
- * 备份方式,0-自动备份,1-手动备份
674
+ * 慢日志统计信息
720
675
  */
721
- BackupType: number
676
+ SlowLogPatterns: Array<SlowLogPattern>
722
677
 
723
678
  /**
724
- * 备份名称
679
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
680
+ */
681
+ RequestId?: string
682
+ }
683
+
684
+ /**
685
+ * 创建备份下载任务结果
686
+ */
687
+ export interface BackupDownloadTaskStatus {
688
+ /**
689
+ * 分片名
690
+ */
691
+ ReplicaSetId: string
692
+
693
+ /**
694
+ * 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
695
+ */
696
+ Status: number
697
+ }
698
+
699
+ /**
700
+ * DescribeSlowLogs返回参数结构体
701
+ */
702
+ export interface DescribeSlowLogsResponse {
703
+ /**
704
+ * 慢日志总数
705
+ */
706
+ Count: number
707
+
708
+ /**
709
+ * 慢日志详情
710
+ 注意:此字段可能返回 null,表示取不到有效值。
711
+ */
712
+ SlowLogs: Array<string>
713
+
714
+ /**
715
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
716
+ */
717
+ RequestId?: string
718
+ }
719
+
720
+ /**
721
+ * InquirePriceModifyDBInstanceSpec请求参数结构体
722
+ */
723
+ export interface InquirePriceModifyDBInstanceSpecRequest {
724
+ /**
725
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
726
+ */
727
+ InstanceId: string
728
+
729
+ /**
730
+ * 变更配置后实例内存大小,单位:GB。
731
+ */
732
+ Memory: number
733
+
734
+ /**
735
+ * 变更配置后实例磁盘大小,单位:GB。
736
+ */
737
+ Volume: number
738
+
739
+ /**
740
+ * 实例变更后的节点数,取值范围具体参照查询云数据库的售卖规格返回参数。默认为不变更节点数
741
+ */
742
+ NodeNum?: number
743
+
744
+ /**
745
+ * 实例变更后的分片数,取值范围具体参照查询云数据库的售卖规格返回参数。只能增加不能减少,默认为不变更分片数
746
+ */
747
+ ReplicateSetNum?: number
748
+ }
749
+
750
+ /**
751
+ * 备份信息
752
+ */
753
+ export interface BackupInfo {
754
+ /**
755
+ * 实例ID
756
+ */
757
+ InstanceId: string
758
+
759
+ /**
760
+ * 备份方式,0-自动备份,1-手动备份
761
+ */
762
+ BackupType: number
763
+
764
+ /**
765
+ * 备份名称
725
766
  */
726
767
  BackupName: string
727
768
 
@@ -761,630 +802,660 @@ export interface BackupInfo {
761
802
  }
762
803
 
763
804
  /**
764
- * 安全组信息
805
+ * DescribeDBInstances请求参数结构体
765
806
  */
766
- export interface SecurityGroup {
807
+ export interface DescribeDBInstancesRequest {
767
808
  /**
768
- * 所属项目id
809
+ * 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
769
810
  */
770
- ProjectId: number
811
+ InstanceIds?: Array<string>
771
812
 
772
813
  /**
773
- * 创建时间
814
+ * 实例类型,取值范围:0-所有实例,1-正式实例,2-临时实例, 3-只读实例,-1-正式实例+只读+灾备实例
774
815
  */
775
- CreateTime: string
816
+ InstanceType?: number
776
817
 
777
818
  /**
778
- * 入站规则
819
+ * 集群类型,取值范围:0-副本集实例,1-分片实例,-1-所有实例
779
820
  */
780
- Inbound: Array<SecurityGroupBound>
821
+ ClusterType?: number
781
822
 
782
823
  /**
783
- * 出站规则
824
+ * 实例状态,取值范围:0-待初始化,1-流程执行中,2-实例有效,-2-已隔离(包年包月实例),-3-已隔离(按量计费实例)
784
825
  */
785
- Outbound: Array<SecurityGroupBound>
826
+ Status?: Array<number>
786
827
 
787
828
  /**
788
- * 安全组id
829
+ * 私有网络的ID,基础网络则不传该参数
789
830
  */
790
- SecurityGroupId: string
831
+ VpcId?: string
791
832
 
792
833
  /**
793
- * 安全组名称
834
+ * 私有网络的子网ID,基础网络则不传该参数。入参设置该参数的同时,必须设置相应的VpcId
794
835
  */
795
- SecurityGroupName: string
836
+ SubnetId?: string
796
837
 
797
838
  /**
798
- * 安全组备注
839
+ * 付费类型,取值范围:0-按量计费,1-包年包月,-1-按量计费+包年包月
799
840
  */
800
- SecurityGroupRemark: string
801
- }
841
+ PayMode?: number
802
842
 
803
- /**
804
- * InquirePriceRenewDBInstances请求参数结构体
805
- */
806
- export interface InquirePriceRenewDBInstancesRequest {
807
843
  /**
808
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同,接口单次最多只支持5个实例进行操作。
844
+ * 单次请求返回的数量,最小值为1,最大值为100,默认值为20
809
845
  */
810
- InstanceIds: Array<string>
846
+ Limit?: number
811
847
 
812
848
  /**
813
- * 预付费模式(即包年包月)相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
849
+ * 偏移量,默认值为0
814
850
  */
815
- InstanceChargePrepaid: InstanceChargePrepaid
816
- }
851
+ Offset?: number
817
852
 
818
- /**
819
- * DescribeAsyncRequestInfo请求参数结构体
820
- */
821
- export interface DescribeAsyncRequestInfoRequest {
822
853
  /**
823
- * 异步请求Id,涉及到异步流程的接口返回,如CreateBackupDBInstance
854
+ * 返回结果集排序的字段,目前支持:"ProjectId", "InstanceName", "CreateTime",默认为升序排序
824
855
  */
825
- AsyncRequestId: string
826
- }
856
+ OrderBy?: string
827
857
 
828
- /**
829
- * KillOps返回参数结构体
830
- */
831
- export interface KillOpsResponse {
832
858
  /**
833
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
859
+ * 返回结果集排序方式,目前支持:"ASC"或者"DESC"
834
860
  */
835
- RequestId?: string
836
- }
861
+ OrderByType?: string
837
862
 
838
- /**
839
- * 实例规格信息
840
- */
841
- export interface SpecificationInfo {
842
863
  /**
843
- * 地域信息
864
+ * 项目 ID
844
865
  */
845
- Region: string
866
+ ProjectIds?: Array<number>
846
867
 
847
868
  /**
848
- * 可用区信息
869
+ * 搜索关键词,支持实例ID、实例名称、完整IP
849
870
  */
850
- Zone: string
871
+ SearchKey?: string
851
872
 
852
873
  /**
853
- * 售卖规格信息
874
+ * Tag信息
854
875
  */
855
- SpecItems: Array<SpecItem>
876
+ Tags?: TagInfo
856
877
  }
857
878
 
858
879
  /**
859
- * CreateBackupDownloadTask请求参数结构体
880
+ * 云数据库实例当前操作
860
881
  */
861
- export interface CreateBackupDownloadTaskRequest {
882
+ export interface CurrentOp {
862
883
  /**
863
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
864
- */
865
- InstanceId: string
884
+ * 操作序号
885
+ 注意:此字段可能返回 null,表示取不到有效值。
886
+ */
887
+ OpId: number
866
888
 
867
889
  /**
868
- * 要下载的备份文件名,可通过DescribeDBBackups接口获取
890
+ * 操作所在的命名空间,形式如db.collection
891
+ 注意:此字段可能返回 null,表示取不到有效值。
892
+ */
893
+ Ns: string
894
+
895
+ /**
896
+ * 操作执行语句
897
+ 注意:此字段可能返回 null,表示取不到有效值。
898
+ */
899
+ Query: string
900
+
901
+ /**
902
+ * 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
903
+ 注意:此字段可能返回 null,表示取不到有效值。
904
+ */
905
+ Op: string
906
+
907
+ /**
908
+ * 操作所在的分片名称
869
909
  */
870
- BackupName: string
910
+ ReplicaSetName: string
871
911
 
872
912
  /**
873
- * 下载备份的分片列表
913
+ * 筛选条件,节点状态,可能的取值为:Primary、Secondary
914
+ 注意:此字段可能返回 null,表示取不到有效值。
915
+ */
916
+ State: string
917
+
918
+ /**
919
+ * 操作详细信息
920
+ 注意:此字段可能返回 null,表示取不到有效值。
921
+ */
922
+ Operation: string
923
+
924
+ /**
925
+ * 操作所在的节点名称
874
926
  */
875
- BackupSets: Array<ReplicaSetInfo>
927
+ NodeName: string
928
+
929
+ /**
930
+ * 操作已执行时间(ms)
931
+ 注意:此字段可能返回 null,表示取不到有效值。
932
+ */
933
+ MicrosecsRunning: number
876
934
  }
877
935
 
878
936
  /**
879
- * DescribeSlowLogPatterns请求参数结构体
937
+ * ModifyDBInstanceSpec请求参数结构体
880
938
  */
881
- export interface DescribeSlowLogPatternsRequest {
939
+ export interface ModifyDBInstanceSpecRequest {
882
940
  /**
883
941
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
884
942
  */
885
943
  InstanceId: string
886
944
 
887
945
  /**
888
- * 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
946
+ * 实例配置变更后的内存大小,单位:GB。内存和磁盘必须同时升配或同时降配
889
947
  */
890
- StartTime: string
948
+ Memory: number
891
949
 
892
950
  /**
893
- * 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
951
+ * 实例配置变更后的硬盘大小,单位:GB。内存和磁盘必须同时升配或同时降配。降配时,新的磁盘参数必须大于已用磁盘容量的1.2倍
894
952
  */
895
- EndTime: string
953
+ Volume: number
896
954
 
897
955
  /**
898
- * 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
956
+ * 实例配置变更后oplog的大小,单位:GB,默认为磁盘空间的10%,允许设置的最小值为磁盘的10%,最大值为磁盘的90%
899
957
  */
900
- SlowMS: number
958
+ OplogSize?: number
901
959
 
902
960
  /**
903
- * 偏移量,最小值为0,最大值为10000,默认值为0。
961
+ * 实例变更后的节点数,取值范围具体参照查询云数据库的售卖规格返回参数。默认为不变更节点数
904
962
  */
905
- Offset?: number
963
+ NodeNum?: number
906
964
 
907
965
  /**
908
- * 分页大小,最小值为1,最大值为100,默认值为20。
966
+ * 实例变更后的分片数,取值范围具体参照查询云数据库的售卖规格返回参数。只能增加不能减少,默认为不变更分片数
909
967
  */
910
- Limit?: number
968
+ ReplicateSetNum?: number
911
969
 
912
970
  /**
913
- * 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
971
+ * 实例配置变更的切换时间,参数为:0(默认)、1。0-调整完成时,1-维护时间内。注:调整节点数和分片数不支持在【维护时间内】变更。
914
972
  */
915
- Format?: string
973
+ InMaintenance?: number
916
974
  }
917
975
 
918
976
  /**
919
- * DescribeSlowLogs返回参数结构体
977
+ * 用户权限
920
978
  */
921
- export interface DescribeSlowLogsResponse {
979
+ export interface Auth {
922
980
  /**
923
- * 慢日志总数
981
+ * *表示所有数据库,db.name表示特定的name数据库。
924
982
  */
925
- Count: number
926
-
927
- /**
928
- * 慢日志详情
929
- 注意:此字段可能返回 null,表示取不到有效值。
930
- */
931
- SlowLogs: Array<string>
983
+ NameSpace: string
932
984
 
933
985
  /**
934
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
986
+ * 用于控制权限,0无权限,1只读,2只写,3读写。
935
987
  */
936
- RequestId?: string
988
+ Mask: number
937
989
  }
938
990
 
939
991
  /**
940
- * FlushInstanceRouterConfig返回参数结构体
992
+ * ResetDBInstancePassword请求参数结构体
941
993
  */
942
- export interface FlushInstanceRouterConfigResponse {
994
+ export interface ResetDBInstancePasswordRequest {
943
995
  /**
944
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
996
+ * 实例Id
945
997
  */
946
- RequestId?: string
947
- }
998
+ InstanceId: string
948
999
 
949
- /**
950
- * InquirePriceModifyDBInstanceSpec返回参数结构体
951
- */
952
- export interface InquirePriceModifyDBInstanceSpecResponse {
953
1000
  /**
954
- * 价格。
1001
+ * 实例账号名
955
1002
  */
956
- Price: DBInstancePrice
1003
+ UserName: string
957
1004
 
958
1005
  /**
959
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1006
+ * 新密码,新密码长度不能少于8位
960
1007
  */
961
- RequestId?: string
1008
+ Password: string
962
1009
  }
963
1010
 
964
1011
  /**
965
- * mongodb售卖规格
1012
+ * 实例可修改参数integer类型集合。
966
1013
  */
967
- export interface SpecItem {
968
- /**
969
- * 规格信息标识
970
- */
971
- SpecCode: string
972
-
973
- /**
974
- * 规格有效标志,取值:0-停止售卖,1-开放售卖
975
- */
976
- Status: number
977
-
1014
+ export interface InstanceIntegerParam {
978
1015
  /**
979
- * 计算资源规格,单位为CPU核心数
1016
+ * 当前值
980
1017
  */
981
- Cpu: number
1018
+ CurrentValue: string
982
1019
 
983
1020
  /**
984
- * 内存规格,单位为MB
1021
+ * 默认值
985
1022
  */
986
- Memory: number
1023
+ DefaultValue: string
987
1024
 
988
1025
  /**
989
- * 默认磁盘规格,单位MB
1026
+ * 最大值
990
1027
  */
991
- DefaultStorage: number
1028
+ Max: string
992
1029
 
993
1030
  /**
994
- * 最大磁盘规格,单位MB
1031
+ * 最小值
995
1032
  */
996
- MaxStorage: number
1033
+ Min: string
997
1034
 
998
1035
  /**
999
- * 最小磁盘规格,单位MB
1036
+ * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
1000
1037
  */
1001
- MinStorage: number
1038
+ NeedRestart: string
1002
1039
 
1003
1040
  /**
1004
- * 可承载qps信息
1041
+ * 参数名称
1005
1042
  */
1006
- Qps: number
1043
+ ParamName: string
1007
1044
 
1008
1045
  /**
1009
- * 连接数限制
1046
+ * 参数说明
1010
1047
  */
1011
- Conns: number
1048
+ Tips: Array<string>
1012
1049
 
1013
1050
  /**
1014
- * 实例mongodb版本信息
1051
+ * 参数类型
1015
1052
  */
1016
- MongoVersionCode: string
1053
+ ValueType: string
1017
1054
 
1018
1055
  /**
1019
- * 实例mongodb版本号
1056
+ * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1020
1057
  */
1021
- MongoVersionValue: number
1058
+ Status: number
1022
1059
 
1023
1060
  /**
1024
- * 实例mongodb版本号(短)
1061
+ * 冗余字段,可忽略
1025
1062
  */
1026
- Version: string
1063
+ Unit: string
1064
+ }
1027
1065
 
1066
+ /**
1067
+ * DescribeAsyncRequestInfo返回参数结构体
1068
+ */
1069
+ export interface DescribeAsyncRequestInfoResponse {
1028
1070
  /**
1029
- * 存储引擎
1071
+ * 状态。返回参数有:initial-初始化、running-运行中、paused-任务执行失败,已暂停、undoed-任务执行失败,已回滚、failed-任务执行失败, 已终止、success-成功
1030
1072
  */
1031
- EngineName: string
1073
+ Status: string
1032
1074
 
1033
1075
  /**
1034
- * 集群类型,取值:1-分片集群,0-副本集集群
1076
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1035
1077
  */
1036
- ClusterType: number
1078
+ RequestId?: string
1079
+ }
1037
1080
 
1081
+ /**
1082
+ * CreateDBInstance返回参数结构体
1083
+ */
1084
+ export interface CreateDBInstanceResponse {
1038
1085
  /**
1039
- * 最小副本集从节点数
1086
+ * 订单ID
1040
1087
  */
1041
- MinNodeNum: number
1088
+ DealId: string
1042
1089
 
1043
1090
  /**
1044
- * 最大副本集从节点数
1091
+ * 创建的实例ID列表
1045
1092
  */
1046
- MaxNodeNum: number
1093
+ InstanceIds: Array<string>
1047
1094
 
1048
1095
  /**
1049
- * 最小分片数
1096
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1050
1097
  */
1051
- MinReplicateSetNum: number
1098
+ RequestId?: string
1099
+ }
1052
1100
 
1101
+ /**
1102
+ * 实例可修改参数text类型集合。
1103
+ */
1104
+ export interface InstanceTextParam {
1053
1105
  /**
1054
- * 最大分片数
1106
+ * 当前值
1055
1107
  */
1056
- MaxReplicateSetNum: number
1108
+ CurrentValue: string
1057
1109
 
1058
1110
  /**
1059
- * 最小分片从节点数
1111
+ * 默认值
1060
1112
  */
1061
- MinReplicateSetNodeNum: number
1113
+ DefaultValue: string
1062
1114
 
1063
1115
  /**
1064
- * 最大分片从节点数
1116
+ * 是否需要重启
1065
1117
  */
1066
- MaxReplicateSetNodeNum: number
1118
+ NeedRestart: string
1067
1119
 
1068
1120
  /**
1069
- * 机器类型,取值:0-HIO,4-HIO10G
1121
+ * 参数名称
1070
1122
  */
1071
- MachineType: string
1072
- }
1123
+ ParamName: string
1073
1124
 
1074
- /**
1075
- * 用户权限
1076
- */
1077
- export interface Auth {
1078
1125
  /**
1079
- * *表示所有数据库,db.name表示特定的name数据库。
1126
+ * text类型值
1080
1127
  */
1081
- NameSpace: string
1128
+ TextValue: string
1082
1129
 
1083
1130
  /**
1084
- * 用于控制权限,0无权限,1只读,2只写,3读写。
1131
+ * 参数说明
1085
1132
  */
1086
- Mask: number
1087
- }
1133
+ Tips: Array<string>
1088
1134
 
1089
- /**
1090
- * DescribeSpecInfo返回参数结构体
1091
- */
1092
- export interface DescribeSpecInfoResponse {
1093
1135
  /**
1094
- * 实例售卖规格信息列表
1136
+ * 值类型说明
1095
1137
  */
1096
- SpecInfoList?: Array<SpecificationInfo>
1138
+ ValueType: string
1097
1139
 
1098
1140
  /**
1099
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1141
+ * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1100
1142
  */
1101
- RequestId?: string
1143
+ Status: string
1102
1144
  }
1103
1145
 
1104
1146
  /**
1105
- * InquirePriceRenewDBInstances返回参数结构体
1147
+ * ModifyDBInstanceSecurityGroup请求参数结构体
1106
1148
  */
1107
- export interface InquirePriceRenewDBInstancesResponse {
1149
+ export interface ModifyDBInstanceSecurityGroupRequest {
1108
1150
  /**
1109
- * 价格
1151
+ * 实例ID
1110
1152
  */
1111
- Price: DBInstancePrice
1153
+ InstanceId: string
1112
1154
 
1113
1155
  /**
1114
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1156
+ * 目标安全组id
1115
1157
  */
1116
- RequestId?: string
1158
+ SecurityGroupIds: Array<string>
1117
1159
  }
1118
1160
 
1119
1161
  /**
1120
- * ResetDBInstancePassword请求参数结构体
1162
+ * DescribeBackupDownloadTask请求参数结构体
1121
1163
  */
1122
- export interface ResetDBInstancePasswordRequest {
1164
+ export interface DescribeBackupDownloadTaskRequest {
1123
1165
  /**
1124
- * 实例Id
1166
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1125
1167
  */
1126
1168
  InstanceId: string
1127
1169
 
1128
1170
  /**
1129
- * 实例账号名
1171
+ * 备份文件名,用来过滤指定文件的下载任务
1130
1172
  */
1131
- UserName: string
1173
+ BackupName?: string
1132
1174
 
1133
1175
  /**
1134
- * 新密码,新密码长度不能少于8位
1176
+ * 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
1135
1177
  */
1136
- Password: string
1137
- }
1178
+ StartTime?: string
1138
1179
 
1139
- /**
1140
- * 实例标签信息
1141
- */
1142
- export interface TagInfo {
1143
1180
  /**
1144
- * 标签键
1181
+ * 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
1145
1182
  */
1146
- TagKey: string
1183
+ EndTime?: string
1147
1184
 
1148
1185
  /**
1149
- * 标签值
1186
+ * 此次查询返回的条数,取值范围为1-100,默认为20
1150
1187
  */
1151
- TagValue: string
1152
- }
1188
+ Limit?: number
1153
1189
 
1154
- /**
1155
- * DescribeDBInstances返回参数结构体
1156
- */
1157
- export interface DescribeDBInstancesResponse {
1158
1190
  /**
1159
- * 符合查询条件的实例总数
1191
+ * 指定此次查询返回的页数,默认为0
1160
1192
  */
1161
- TotalCount: number
1193
+ Offset?: number
1162
1194
 
1163
1195
  /**
1164
- * 实例详细信息列表
1196
+ * 排序字段,取值为createTime,finishTime两种,默认为createTime
1165
1197
  */
1166
- InstanceDetails: Array<InstanceDetail>
1198
+ OrderBy?: string
1167
1199
 
1168
1200
  /**
1169
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1201
+ * 排序方式,取值为asc,desc两种,默认desc
1170
1202
  */
1171
- RequestId?: string
1172
- }
1173
-
1174
- /**
1175
- * OfflineIsolatedDBInstance请求参数结构体
1176
- */
1177
- export interface OfflineIsolatedDBInstanceRequest {
1203
+ OrderByType?: string
1204
+
1178
1205
  /**
1179
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1206
+ * 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
1180
1207
  */
1181
- InstanceId: string
1208
+ Status?: Array<number>
1182
1209
  }
1183
1210
 
1184
1211
  /**
1185
- * 实例可修改参数integer类型集合。
1212
+ * DescribeClientConnections返回参数结构体
1186
1213
  */
1187
- export interface InstanceIntegerParam {
1214
+ export interface DescribeClientConnectionsResponse {
1188
1215
  /**
1189
- * 当前值
1216
+ * 客户端连接信息,包括客户端IP和对应IP的连接数量。
1190
1217
  */
1191
- CurrentValue: string
1218
+ Clients: Array<ClientConnection>
1192
1219
 
1193
1220
  /**
1194
- * 默认值
1221
+ * 满足条件的记录总条数,可用于分页查询。
1195
1222
  */
1196
- DefaultValue: string
1223
+ TotalCount: number
1197
1224
 
1198
1225
  /**
1199
- * 最大值
1226
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1200
1227
  */
1201
- Max: string
1228
+ RequestId?: string
1229
+ }
1202
1230
 
1231
+ /**
1232
+ * DescribeDBBackups返回参数结构体
1233
+ */
1234
+ export interface DescribeDBBackupsResponse {
1203
1235
  /**
1204
- * 最小值
1236
+ * 备份列表
1205
1237
  */
1206
- Min: string
1238
+ BackupList: Array<BackupInfo>
1207
1239
 
1208
1240
  /**
1209
- * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
1241
+ * 备份总数
1210
1242
  */
1211
- NeedRestart: string
1243
+ TotalCount: number
1212
1244
 
1213
1245
  /**
1214
- * 参数名称
1246
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1215
1247
  */
1216
- ParamName: string
1248
+ RequestId?: string
1249
+ }
1217
1250
 
1251
+ /**
1252
+ * ModifyDBInstanceSecurityGroup返回参数结构体
1253
+ */
1254
+ export interface ModifyDBInstanceSecurityGroupResponse {
1218
1255
  /**
1219
- * 参数说明
1256
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1220
1257
  */
1221
- Tips: Array<string>
1258
+ RequestId?: string
1259
+ }
1222
1260
 
1261
+ /**
1262
+ * DescribeInstanceParams请求参数结构体
1263
+ */
1264
+ export interface DescribeInstanceParamsRequest {
1223
1265
  /**
1224
- * 参数类型
1266
+ * 实例ID
1225
1267
  */
1226
- ValueType: string
1268
+ InstanceId: string
1269
+ }
1227
1270
 
1271
+ /**
1272
+ * InquirePriceCreateDBInstances返回参数结构体
1273
+ */
1274
+ export interface InquirePriceCreateDBInstancesResponse {
1228
1275
  /**
1229
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1276
+ * 价格
1230
1277
  */
1231
- Status: number
1278
+ Price: DBInstancePrice
1232
1279
 
1233
1280
  /**
1234
- * 冗余字段,可忽略
1281
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1235
1282
  */
1236
- Unit: string
1283
+ RequestId?: string
1237
1284
  }
1238
1285
 
1239
1286
  /**
1240
- * DescribeCurrentOp请求参数结构体
1287
+ * DescribeSecurityGroup返回参数结构体
1241
1288
  */
1242
- export interface DescribeCurrentOpRequest {
1289
+ export interface DescribeSecurityGroupResponse {
1243
1290
  /**
1244
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1291
+ * 实例绑定的安全组
1245
1292
  */
1246
- InstanceId: string
1293
+ Groups: Array<SecurityGroup>
1247
1294
 
1248
1295
  /**
1249
- * 筛选条件,操作所属的命名空间namespace,格式为db.collection
1296
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1250
1297
  */
1251
- Ns?: string
1298
+ RequestId?: string
1299
+ }
1252
1300
 
1301
+ /**
1302
+ * 安全组信息
1303
+ */
1304
+ export interface SecurityGroup {
1253
1305
  /**
1254
- * 筛选条件,操作已经执行的时间(单位:毫秒),结果将返回超过设置时间的操作,默认值为0,取值范围为[0, 3600000]
1306
+ * 所属项目id
1255
1307
  */
1256
- MillisecondRunning?: number
1308
+ ProjectId: number
1257
1309
 
1258
1310
  /**
1259
- * 筛选条件,操作类型,可能的取值:none,update,insert,query,command,getmore,remove和killcursors
1311
+ * 创建时间
1260
1312
  */
1261
- Op?: string
1313
+ CreateTime: string
1262
1314
 
1263
1315
  /**
1264
- * 筛选条件,分片名称
1316
+ * 入站规则
1265
1317
  */
1266
- ReplicaSetName?: string
1267
-
1268
- /**
1269
- * 筛选条件,节点状态,可能的取值为:primary
1270
- secondary
1271
- */
1272
- State?: string
1318
+ Inbound: Array<SecurityGroupBound>
1273
1319
 
1274
1320
  /**
1275
- * 单次请求返回的数量,默认值为100,取值范围为[0,100]
1321
+ * 出站规则
1276
1322
  */
1277
- Limit?: number
1323
+ Outbound: Array<SecurityGroupBound>
1278
1324
 
1279
1325
  /**
1280
- * 偏移量,默认值为0,取值范围为[0,10000]
1326
+ * 安全组id
1281
1327
  */
1282
- Offset?: number
1328
+ SecurityGroupId: string
1283
1329
 
1284
1330
  /**
1285
- * 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
1331
+ * 安全组名称
1286
1332
  */
1287
- OrderBy?: string
1333
+ SecurityGroupName: string
1288
1334
 
1289
1335
  /**
1290
- * 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
1336
+ * 安全组备注
1291
1337
  */
1292
- OrderByType?: string
1338
+ SecurityGroupRemark: string
1293
1339
  }
1294
1340
 
1295
1341
  /**
1296
- * DescribeDBInstanceDeal请求参数结构体
1342
+ * DescribeBackupAccess返回参数结构体
1297
1343
  */
1298
- export interface DescribeDBInstanceDealRequest {
1344
+ export interface DescribeBackupAccessResponse {
1299
1345
  /**
1300
- * 订单ID,通过CreateDBInstance等接口返回
1346
+ * 实例所属地域
1301
1347
  */
1302
- DealId: string
1303
- }
1348
+ Region?: string
1304
1349
 
1305
- /**
1306
- * DescribeDBInstances请求参数结构体
1307
- */
1308
- export interface DescribeDBInstancesRequest {
1309
1350
  /**
1310
- * 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1351
+ * 备份文件所在存储桶
1311
1352
  */
1312
- InstanceIds?: Array<string>
1353
+ Bucket?: string
1313
1354
 
1314
1355
  /**
1315
- * 实例类型,取值范围:0-所有实例,1-正式实例,2-临时实例, 3-只读实例,-1-正式实例+只读+灾备实例
1356
+ * 备份文件的存储信息
1316
1357
  */
1317
- InstanceType?: number
1358
+ Files?: Array<BackupFile>
1318
1359
 
1319
1360
  /**
1320
- * 集群类型,取值范围:0-副本集实例,1-分片实例,-1-所有实例
1361
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1321
1362
  */
1322
- ClusterType?: number
1363
+ RequestId?: string
1364
+ }
1323
1365
 
1366
+ /**
1367
+ * 分片信息
1368
+ */
1369
+ export interface ReplicaSetInfo {
1324
1370
  /**
1325
- * 实例状态,取值范围:0-待初始化,1-流程执行中,2-实例有效,-2-已隔离(包年包月实例),-3-已隔离(按量计费实例)
1371
+ * 分片名称
1326
1372
  */
1327
- Status?: Array<number>
1373
+ ReplicaSetId: string
1374
+ }
1328
1375
 
1376
+ /**
1377
+ * ResetDBInstancePassword返回参数结构体
1378
+ */
1379
+ export interface ResetDBInstancePasswordResponse {
1329
1380
  /**
1330
- * 私有网络的ID,基础网络则不传该参数
1381
+ * 异步请求Id,用户查询该流程的运行状态
1331
1382
  */
1332
- VpcId?: string
1383
+ AsyncRequestId: string
1333
1384
 
1334
1385
  /**
1335
- * 私有网络的子网ID,基础网络则不传该参数。入参设置该参数的同时,必须设置相应的VpcId
1386
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1336
1387
  */
1337
- SubnetId?: string
1388
+ RequestId?: string
1389
+ }
1338
1390
 
1391
+ /**
1392
+ * 客户端连接信息,包括客户端IP和连接数
1393
+ */
1394
+ export interface ClientConnection {
1339
1395
  /**
1340
- * 付费类型,取值范围:0-按量计费,1-包年包月,-1-按量计费+包年包月
1396
+ * 连接的客户端IP
1341
1397
  */
1342
- PayMode?: number
1398
+ IP: string
1343
1399
 
1344
1400
  /**
1345
- * 单次请求返回的数量,最小值为1,最大值为100,默认值为20
1401
+ * 对应客户端IP的连接数
1346
1402
  */
1347
- Limit?: number
1403
+ Count: number
1348
1404
 
1349
1405
  /**
1350
- * 偏移量,默认值为0
1406
+ * 是否为内部ip
1351
1407
  */
1352
- Offset?: number
1408
+ InternalService: boolean
1409
+ }
1353
1410
 
1411
+ /**
1412
+ * DescribeDBInstanceDeal请求参数结构体
1413
+ */
1414
+ export interface DescribeDBInstanceDealRequest {
1354
1415
  /**
1355
- * 返回结果集排序的字段,目前支持:"ProjectId", "InstanceName", "CreateTime",默认为升序排序
1416
+ * 订单ID,通过CreateDBInstance等接口返回
1356
1417
  */
1357
- OrderBy?: string
1418
+ DealId: string
1419
+ }
1358
1420
 
1421
+ /**
1422
+ * DescribeAsyncRequestInfo请求参数结构体
1423
+ */
1424
+ export interface DescribeAsyncRequestInfoRequest {
1359
1425
  /**
1360
- * 返回结果集排序方式,目前支持:"ASC"或者"DESC"
1426
+ * 异步请求Id,涉及到异步流程的接口返回,如CreateBackupDBInstance
1361
1427
  */
1362
- OrderByType?: string
1428
+ AsyncRequestId: string
1429
+ }
1363
1430
 
1431
+ /**
1432
+ * CreateBackupDownloadTask请求参数结构体
1433
+ */
1434
+ export interface CreateBackupDownloadTaskRequest {
1364
1435
  /**
1365
- * 项目 ID
1436
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1366
1437
  */
1367
- ProjectIds?: Array<number>
1438
+ InstanceId: string
1368
1439
 
1369
1440
  /**
1370
- * 搜索关键词,支持实例ID、实例名称、完整IP
1441
+ * 要下载的备份文件名,可通过DescribeDBBackups接口获取
1371
1442
  */
1372
- SearchKey?: string
1443
+ BackupName: string
1373
1444
 
1374
1445
  /**
1375
- * Tag信息
1446
+ * 下载备份的分片列表
1376
1447
  */
1377
- Tags?: TagInfo
1448
+ BackupSets: Array<ReplicaSetInfo>
1378
1449
  }
1379
1450
 
1380
1451
  /**
1381
- * DescribeAsyncRequestInfo返回参数结构体
1452
+ * InquirePriceModifyDBInstanceSpec返回参数结构体
1382
1453
  */
1383
- export interface DescribeAsyncRequestInfoResponse {
1454
+ export interface InquirePriceModifyDBInstanceSpecResponse {
1384
1455
  /**
1385
- * 状态。返回参数有:initial-初始化、running-运行中、paused-任务执行失败,已暂停、undoed-任务执行失败,已回滚、failed-任务执行失败, 已终止、success-成功
1456
+ * 价格。
1386
1457
  */
1387
- Status: string
1458
+ Price: DBInstancePrice
1388
1459
 
1389
1460
  /**
1390
1461
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1393,113 +1464,104 @@ export interface DescribeAsyncRequestInfoResponse {
1393
1464
  }
1394
1465
 
1395
1466
  /**
1396
- * CreateDBInstance返回参数结构体
1467
+ * 安全组规则
1397
1468
  */
1398
- export interface CreateDBInstanceResponse {
1399
- /**
1400
- * 订单ID
1401
- */
1402
- DealId: string
1403
-
1469
+ export interface SecurityGroupBound {
1404
1470
  /**
1405
- * 创建的实例ID列表
1471
+ * 执行规则。ACCEPT或DROP
1406
1472
  */
1407
- InstanceIds: Array<string>
1473
+ Action: string
1408
1474
 
1409
1475
  /**
1410
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1476
+ * ip段。
1411
1477
  */
1412
- RequestId?: string
1413
- }
1478
+ CidrIp: string
1414
1479
 
1415
- /**
1416
- * DescribeInstanceParams返回参数结构体
1417
- */
1418
- export interface DescribeInstanceParamsResponse {
1419
1480
  /**
1420
- * 值为枚举类型参数集合
1481
+ * 端口范围
1421
1482
  */
1422
- InstanceEnumParam: Array<InstanceEnumParam>
1483
+ PortRange: string
1423
1484
 
1424
1485
  /**
1425
- * 值为integer类型参数集合
1486
+ * 传输层协议。tcp,udp或ALL
1426
1487
  */
1427
- InstanceIntegerParam: Array<InstanceIntegerParam>
1488
+ IpProtocol: string
1428
1489
 
1429
1490
  /**
1430
- * 值为text类型的参数集合
1491
+ * 安全组id代表的地址集合
1431
1492
  */
1432
- InstanceTextParam: Array<InstanceTextParam>
1493
+ Id: string
1433
1494
 
1434
1495
  /**
1435
- * 值为混合类型的参数集合
1496
+ * 地址组id代表的地址集合
1436
1497
  */
1437
- InstanceMultiParam: Array<InstanceMultiParam>
1498
+ AddressModule: string
1438
1499
 
1439
1500
  /**
1440
- * 当前实例支持修改的参数个数统计 如0
1501
+ * 服务组id代表的协议和端口集合
1441
1502
  */
1442
- TotalCount: number
1503
+ ServiceModule: string
1443
1504
 
1444
1505
  /**
1445
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1506
+ * 描述
1446
1507
  */
1447
- RequestId?: string
1508
+ Desc: string
1448
1509
  }
1449
1510
 
1450
1511
  /**
1451
- * DescribeSlowLogs请求参数结构体
1512
+ * DescribeCurrentOp请求参数结构体
1452
1513
  */
1453
- export interface DescribeSlowLogsRequest {
1514
+ export interface DescribeCurrentOpRequest {
1454
1515
  /**
1455
1516
  * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1456
1517
  */
1457
1518
  InstanceId: string
1458
1519
 
1459
1520
  /**
1460
- * 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
1521
+ * 筛选条件,操作所属的命名空间namespace,格式为db.collection
1461
1522
  */
1462
- StartTime: string
1523
+ Ns?: string
1463
1524
 
1464
1525
  /**
1465
- * 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
1526
+ * 筛选条件,操作已经执行的时间(单位:毫秒),结果将返回超过设置时间的操作,默认值为0,取值范围为[0, 3600000]
1466
1527
  */
1467
- EndTime: string
1528
+ MillisecondRunning?: number
1468
1529
 
1469
1530
  /**
1470
- * 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
1531
+ * 筛选条件,操作类型,可能的取值:none,update,insert,query,command,getmore,remove和killcursors
1471
1532
  */
1472
- SlowMS: number
1533
+ Op?: string
1473
1534
 
1474
1535
  /**
1475
- * 偏移量,最小值为0,最大值为10000,默认值为0。
1536
+ * 筛选条件,分片名称
1476
1537
  */
1477
- Offset?: number
1538
+ ReplicaSetName?: string
1478
1539
 
1479
1540
  /**
1480
- * 分页大小,最小值为1,最大值为100,默认值为20。
1541
+ * 筛选条件,节点状态,可能的取值为:primary
1542
+ secondary
1543
+ */
1544
+ State?: string
1545
+
1546
+ /**
1547
+ * 单次请求返回的数量,默认值为100,取值范围为[0,100]
1481
1548
  */
1482
1549
  Limit?: number
1483
1550
 
1484
1551
  /**
1485
- * 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
1552
+ * 偏移量,默认值为0,取值范围为[0,10000]
1486
1553
  */
1487
- Format?: string
1488
- }
1554
+ Offset?: number
1489
1555
 
1490
- /**
1491
- * AssignProject返回参数结构体
1492
- */
1493
- export interface AssignProjectResponse {
1494
1556
  /**
1495
- * 返回的异步任务ID列表
1557
+ * 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
1496
1558
  */
1497
- FlowIds: Array<number>
1559
+ OrderBy?: string
1498
1560
 
1499
1561
  /**
1500
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1562
+ * 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
1501
1563
  */
1502
- RequestId?: string
1564
+ OrderByType?: string
1503
1565
  }
1504
1566
 
1505
1567
  /**
@@ -1584,11 +1646,116 @@ export interface DescribeDBBackupsRequest {
1584
1646
  }
1585
1647
 
1586
1648
  /**
1587
- * 实例可修改参数Multi类型集合。
1649
+ * DescribeClientConnections请求参数结构体
1588
1650
  */
1589
- export interface InstanceMultiParam {
1651
+ export interface DescribeClientConnectionsRequest {
1590
1652
  /**
1591
- * 当前值
1653
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1654
+ */
1655
+ InstanceId: string
1656
+
1657
+ /**
1658
+ * 单次请求返回的数量,最小值为1,最大值为1000,默认值为1000。
1659
+ */
1660
+ Limit?: number
1661
+
1662
+ /**
1663
+ * 偏移量,默认值为0。
1664
+ */
1665
+ Offset?: number
1666
+ }
1667
+
1668
+ /**
1669
+ * 实例分片详情
1670
+ */
1671
+ export interface ShardInfo {
1672
+ /**
1673
+ * 分片已使用容量
1674
+ */
1675
+ UsedVolume: number
1676
+
1677
+ /**
1678
+ * 分片ID
1679
+ */
1680
+ ReplicaSetId: string
1681
+
1682
+ /**
1683
+ * 分片名
1684
+ */
1685
+ ReplicaSetName: string
1686
+
1687
+ /**
1688
+ * 分片内存规格,单位为MB
1689
+ */
1690
+ Memory: number
1691
+
1692
+ /**
1693
+ * 分片磁盘规格,单位为MB
1694
+ */
1695
+ Volume: number
1696
+
1697
+ /**
1698
+ * 分片Oplog大小,单位为MB
1699
+ */
1700
+ OplogSize: number
1701
+
1702
+ /**
1703
+ * 分片从节点数
1704
+ */
1705
+ SecondaryNum: number
1706
+
1707
+ /**
1708
+ * 分片物理id
1709
+ */
1710
+ RealReplicaSetId: string
1711
+ }
1712
+
1713
+ /**
1714
+ * DescribeBackupAccess请求参数结构体
1715
+ */
1716
+ export interface DescribeBackupAccessRequest {
1717
+ /**
1718
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1719
+ */
1720
+ InstanceId: string
1721
+
1722
+ /**
1723
+ * 需要获取下载授权的备份文件名
1724
+ */
1725
+ BackupName: string
1726
+ }
1727
+
1728
+ /**
1729
+ * RenameInstance请求参数结构体
1730
+ */
1731
+ export interface RenameInstanceRequest {
1732
+ /**
1733
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1734
+ */
1735
+ InstanceId: string
1736
+
1737
+ /**
1738
+ * 自定义实例名称,名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符 -
1739
+ */
1740
+ NewName: string
1741
+ }
1742
+
1743
+ /**
1744
+ * RenewDBInstances返回参数结构体
1745
+ */
1746
+ export interface RenewDBInstancesResponse {
1747
+ /**
1748
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1749
+ */
1750
+ RequestId?: string
1751
+ }
1752
+
1753
+ /**
1754
+ * 实例可修改参数枚举类型集合。
1755
+ */
1756
+ export interface InstanceEnumParam {
1757
+ /**
1758
+ * 参数当前值
1592
1759
  */
1593
1760
  CurrentValue: string
1594
1761
 
@@ -1598,7 +1765,7 @@ export interface InstanceMultiParam {
1598
1765
  DefaultValue: string
1599
1766
 
1600
1767
  /**
1601
- * 指导值范围
1768
+ * 枚举值,所有支持的值
1602
1769
  */
1603
1770
  EnumValue: Array<string>
1604
1771
 
@@ -1613,240 +1780,250 @@ export interface InstanceMultiParam {
1613
1780
  ParamName: string
1614
1781
 
1615
1782
  /**
1616
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1783
+ * 中英文说明
1617
1784
  */
1618
- Status: number
1785
+ Tips: Array<string>
1619
1786
 
1620
1787
  /**
1621
- * 参数说明
1788
+ * 参数值类型说明
1622
1789
  */
1623
- Tips: Array<string>
1790
+ ValueType: string
1624
1791
 
1625
1792
  /**
1626
- * 当前值的类型描述,默认为multi
1793
+ * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1627
1794
  */
1628
- ValueType: string
1795
+ Status: number
1629
1796
  }
1630
1797
 
1631
1798
  /**
1632
- * DescribeClientConnections请求参数结构体
1799
+ * RenameInstance返回参数结构体
1633
1800
  */
1634
- export interface DescribeClientConnectionsRequest {
1801
+ export interface RenameInstanceResponse {
1635
1802
  /**
1636
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1803
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1804
+ */
1805
+ RequestId?: string
1806
+ }
1807
+
1808
+ /**
1809
+ * CreateBackupDBInstance请求参数结构体
1810
+ */
1811
+ export interface CreateBackupDBInstanceRequest {
1812
+ /**
1813
+ * 实例id
1637
1814
  */
1638
1815
  InstanceId: string
1639
1816
 
1640
1817
  /**
1641
- * 单次请求返回的数量,最小值为1,最大值为1000,默认值为1000。
1818
+ * 0-逻辑备份,1-物理备份
1642
1819
  */
1643
- Limit?: number
1820
+ BackupMethod: number
1644
1821
 
1645
1822
  /**
1646
- * 偏移量,默认值为0。
1823
+ * 备份备注
1647
1824
  */
1648
- Offset?: number
1825
+ BackupRemark?: string
1649
1826
  }
1650
1827
 
1651
1828
  /**
1652
- * DescribeDBInstanceDeal返回参数结构体
1829
+ * SetAccountUserPrivilege请求参数结构体
1653
1830
  */
1654
- export interface DescribeDBInstanceDealResponse {
1831
+ export interface SetAccountUserPrivilegeRequest {
1655
1832
  /**
1656
- * 订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
1833
+ * 实例ID
1657
1834
  */
1658
- Status: number
1835
+ InstanceId: string
1659
1836
 
1660
1837
  /**
1661
- * 订单原价。
1838
+ * 账号名称
1662
1839
  */
1663
- OriginalPrice: number
1840
+ UserName: string
1664
1841
 
1665
1842
  /**
1666
- * 订单折扣价格。
1843
+ * 权限信息
1667
1844
  */
1668
- DiscountPrice: number
1845
+ AuthRole: Array<Auth>
1846
+ }
1669
1847
 
1848
+ /**
1849
+ * KillOps返回参数结构体
1850
+ */
1851
+ export interface KillOpsResponse {
1670
1852
  /**
1671
- * 订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
1853
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1672
1854
  */
1673
- Action: string
1855
+ RequestId?: string
1856
+ }
1674
1857
 
1858
+ /**
1859
+ * IsolateDBInstance请求参数结构体
1860
+ */
1861
+ export interface IsolateDBInstanceRequest {
1675
1862
  /**
1676
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1863
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1677
1864
  */
1678
- RequestId?: string
1865
+ InstanceId: string
1679
1866
  }
1680
1867
 
1681
- /**
1682
- * ModifyDBInstanceSpec返回参数结构体
1683
- */
1684
- export interface ModifyDBInstanceSpecResponse {
1868
+ /**
1869
+ * CreateDBInstanceHour请求参数结构体
1870
+ */
1871
+ export interface CreateDBInstanceHourRequest {
1872
+ /**
1873
+ * 实例内存大小,单位:GB
1874
+ */
1875
+ Memory: number
1876
+
1877
+ /**
1878
+ * 实例硬盘大小,单位:GB
1879
+ */
1880
+ Volume: number
1881
+
1685
1882
  /**
1686
- * 订单ID
1883
+ * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数
1687
1884
  */
1688
- DealId: string
1885
+ ReplicateSetNum: number
1689
1886
 
1690
1887
  /**
1691
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1888
+ * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
1692
1889
  */
1693
- RequestId?: string
1694
- }
1890
+ NodeNum: number
1695
1891
 
1696
- /**
1697
- * 实例可修改参数text类型集合。
1698
- */
1699
- export interface InstanceTextParam {
1700
1892
  /**
1701
- * 当前值
1893
+ * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(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存储引擎版本
1702
1894
  */
1703
- CurrentValue: string
1895
+ MongoVersion: string
1704
1896
 
1705
1897
  /**
1706
- * 默认值
1898
+ * 机器类型,HIO:高IO型;HIO10G:高IO万兆
1707
1899
  */
1708
- DefaultValue: string
1900
+ MachineCode: string
1709
1901
 
1710
1902
  /**
1711
- * 是否需要重启
1903
+ * 实例数量,最小值1,最大值为10
1712
1904
  */
1713
- NeedRestart: string
1905
+ GoodsNum: number
1714
1906
 
1715
1907
  /**
1716
- * 参数名称
1908
+ * 可用区信息,格式如:ap-guangzhou-2。注:此参数填写的是主可用区,如果选择多可用区部署,Zone必须是AvailabilityZoneList中的一个
1717
1909
  */
1718
- ParamName: string
1910
+ Zone: string
1719
1911
 
1720
1912
  /**
1721
- * text类型值
1913
+ * 实例类型,REPLSET-副本集,SHARD-分片集群
1722
1914
  */
1723
- TextValue: string
1915
+ ClusterType: string
1724
1916
 
1725
1917
  /**
1726
- * 参数说明
1918
+ * 私有网络ID,如果不设置该参数则默认选择基础网络
1727
1919
  */
1728
- Tips: Array<string>
1920
+ VpcId?: string
1729
1921
 
1730
1922
  /**
1731
- * 值类型说明
1923
+ * 私有网络下的子网ID,如果设置了 VpcId,则 SubnetId必填
1732
1924
  */
1733
- ValueType: string
1925
+ SubnetId?: string
1734
1926
 
1735
1927
  /**
1736
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
1928
+ * 实例密码,不设置该参数则默认密码规则为 实例ID+"@"+主账户uin。举例实例id为cmgo-higv73ed,uin为100000001,则默认密码为"cmgo-higv73ed@100000001"。密码必须是8-16位字符,且至少包含字母、数字和字符 !@#%^*() 中的两种
1737
1929
  */
1738
- Status: string
1739
- }
1930
+ Password?: string
1740
1931
 
1741
- /**
1742
- * OfflineIsolatedDBInstance返回参数结构体
1743
- */
1744
- export interface OfflineIsolatedDBInstanceResponse {
1745
1932
  /**
1746
- * 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
1933
+ * 项目ID,不设置为默认项目
1747
1934
  */
1748
- AsyncRequestId: string
1935
+ ProjectId?: number
1749
1936
 
1750
1937
  /**
1751
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1938
+ * 实例标签信息
1752
1939
  */
1753
- RequestId?: string
1754
- }
1940
+ Tags?: Array<TagInfo>
1755
1941
 
1756
- /**
1757
- * DescribeBackupDownloadTask请求参数结构体
1758
- */
1759
- export interface DescribeBackupDownloadTaskRequest {
1760
1942
  /**
1761
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1943
+ * 1:正式实例,2:临时实例,3:只读实例,4:灾备实例,5:克隆实例
1762
1944
  */
1763
- InstanceId: string
1945
+ Clone?: number
1764
1946
 
1765
1947
  /**
1766
- * 备份文件名,用来过滤指定文件的下载任务
1948
+ * 父实例Id,当Clone为3或者4时,这个必须填
1767
1949
  */
1768
- BackupName?: string
1950
+ Father?: string
1769
1951
 
1770
1952
  /**
1771
- * 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
1953
+ * 安全组
1772
1954
  */
1773
- StartTime?: string
1955
+ SecurityGroup?: Array<string>
1774
1956
 
1775
1957
  /**
1776
- * 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
1958
+ * 克隆实例回档时间。若是克隆实例,则必须填写,示例:2021-08-13 16:30:00。注:只能回档7天内的时间点
1777
1959
  */
1778
- EndTime?: string
1960
+ RestoreTime?: string
1779
1961
 
1780
1962
  /**
1781
- * 此次查询返回的条数,取值范围为1-100,默认为20
1963
+ * 实例名称。注:名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-
1782
1964
  */
1783
- Limit?: number
1965
+ InstanceName?: string
1784
1966
 
1785
1967
  /**
1786
- * 指定此次查询返回的页数,默认为0
1968
+ * 多可用区部署的节点列表,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:1、多可用区部署节点只能部署在3个不同可用区;2、为了保障跨可用区切换,不支持将集群的大多数节点部署在同一个可用区(如3节点集群不支持2个节点部署在同一个区);3、不支持4.2及以上版本;4、不支持只读灾备实例;5、不能选择基础网络
1787
1969
  */
1788
- Offset?: number
1970
+ AvailabilityZoneList?: Array<string>
1789
1971
 
1790
1972
  /**
1791
- * 排序字段,取值为createTime,finishTime两种,默认为createTime
1973
+ * mongos cpu数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
1792
1974
  */
1793
- OrderBy?: string
1975
+ MongosCpu?: number
1794
1976
 
1795
1977
  /**
1796
- * 排序方式,取值为asc,desc两种,默认desc
1978
+ * mongos 内存大小,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果
1797
1979
  */
1798
- OrderByType?: string
1980
+ MongosMemory?: number
1799
1981
 
1800
1982
  /**
1801
- * 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
1983
+ * mongos 数量,购买MongoDB 4.2 WiredTiger存储引擎版本的分片集群时必须填写,具体支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。注:为了保障高可用,最低需要购买3个mongos,上限为32个
1802
1984
  */
1803
- Status?: Array<number>
1985
+ MongosNodeNum?: number
1804
1986
  }
1805
1987
 
1806
1988
  /**
1807
- * DescribeBackupAccess请求参数结构体
1989
+ * 备份文件存储信息
1808
1990
  */
1809
- export interface DescribeBackupAccessRequest {
1991
+ export interface BackupFile {
1810
1992
  /**
1811
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1993
+ * 备份文件所属的副本集/分片ID
1812
1994
  */
1813
- InstanceId: string
1995
+ ReplicateSetId: string
1814
1996
 
1815
1997
  /**
1816
- * 需要获取下载授权的备份文件名
1998
+ * 备份文件保存路径
1817
1999
  */
1818
- BackupName: string
2000
+ File: string
1819
2001
  }
1820
2002
 
1821
2003
  /**
1822
- * RenameInstance请求参数结构体
2004
+ * AssignProject请求参数结构体
1823
2005
  */
1824
- export interface RenameInstanceRequest {
2006
+ export interface AssignProjectRequest {
1825
2007
  /**
1826
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2008
+ * 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1827
2009
  */
1828
- InstanceId: string
2010
+ InstanceIds: Array<string>
1829
2011
 
1830
2012
  /**
1831
- * 自定义实例名称,名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符 -
2013
+ * 项目ID,用户已创建项目的唯一ID,非自定义
1832
2014
  */
1833
- NewName: string
2015
+ ProjectId: number
1834
2016
  }
1835
2017
 
1836
2018
  /**
1837
- * DescribeSecurityGroup请求参数结构体
2019
+ * CreateBackupDownloadTask返回参数结构体
1838
2020
  */
1839
- export interface DescribeSecurityGroupRequest {
2021
+ export interface CreateBackupDownloadTaskResponse {
1840
2022
  /**
1841
- * 实例ID,格式如:cmgo-p8vnipr5。
2023
+ * 下载任务状态
1842
2024
  */
1843
- InstanceId: string
1844
- }
2025
+ Tasks: Array<BackupDownloadTaskStatus>
1845
2026
 
1846
- /**
1847
- * RenewDBInstances返回参数结构体
1848
- */
1849
- export interface RenewDBInstancesResponse {
1850
2027
  /**
1851
2028
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1852
2029
  */
@@ -1854,63 +2031,73 @@ export interface RenewDBInstancesResponse {
1854
2031
  }
1855
2032
 
1856
2033
  /**
1857
- * 实例可修改参数枚举类型集合。
2034
+ * 实例规格信息
1858
2035
  */
1859
- export interface InstanceEnumParam {
2036
+ export interface SpecificationInfo {
1860
2037
  /**
1861
- * 参数当前值
2038
+ * 地域信息
1862
2039
  */
1863
- CurrentValue: string
2040
+ Region: string
1864
2041
 
1865
2042
  /**
1866
- * 默认值
2043
+ * 可用区信息
1867
2044
  */
1868
- DefaultValue: string
2045
+ Zone: string
1869
2046
 
1870
2047
  /**
1871
- * 枚举值,所有支持的值
2048
+ * 售卖规格信息
1872
2049
  */
1873
- EnumValue: Array<string>
2050
+ SpecItems: Array<SpecItem>
2051
+ }
1874
2052
 
2053
+ /**
2054
+ * DescribeSlowLogPatterns请求参数结构体
2055
+ */
2056
+ export interface DescribeSlowLogPatternsRequest {
1875
2057
  /**
1876
- * 是否需要重启生效 1:需要重启后生效;0:无需重启,设置成功即可生效;
2058
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1877
2059
  */
1878
- NeedRestart: string
2060
+ InstanceId: string
1879
2061
 
1880
2062
  /**
1881
- * 参数名称
2063
+ * 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
1882
2064
  */
1883
- ParamName: string
2065
+ StartTime: string
1884
2066
 
1885
2067
  /**
1886
- * 中英文说明
2068
+ * 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
1887
2069
  */
1888
- Tips: Array<string>
2070
+ EndTime: string
1889
2071
 
1890
2072
  /**
1891
- * 参数值类型说明
2073
+ * 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
1892
2074
  */
1893
- ValueType: string
2075
+ SlowMS: number
1894
2076
 
1895
2077
  /**
1896
- * 是否为运行中参数值 1:运行中参数值;0:非运行中参数值;
2078
+ * 偏移量,最小值为0,最大值为10000,默认值为0。
1897
2079
  */
1898
- Status: number
1899
- }
2080
+ Offset?: number
1900
2081
 
1901
- /**
1902
- * DescribeBackupDownloadTask返回参数结构体
1903
- */
1904
- export interface DescribeBackupDownloadTaskResponse {
1905
2082
  /**
1906
- * 满足查询条件的所有条数
2083
+ * 分页大小,最小值为1,最大值为100,默认值为20。
1907
2084
  */
1908
- TotalCount: number
2085
+ Limit?: number
1909
2086
 
1910
2087
  /**
1911
- * 下载任务列表
2088
+ * 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
1912
2089
  */
1913
- Tasks: Array<BackupDownloadTask>
2090
+ Format?: string
2091
+ }
2092
+
2093
+ /**
2094
+ * DescribeSpecInfo返回参数结构体
2095
+ */
2096
+ export interface DescribeSpecInfoResponse {
2097
+ /**
2098
+ * 实例售卖规格信息列表
2099
+ */
2100
+ SpecInfoList?: Array<SpecificationInfo>
1914
2101
 
1915
2102
  /**
1916
2103
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1919,9 +2106,14 @@ export interface DescribeBackupDownloadTaskResponse {
1919
2106
  }
1920
2107
 
1921
2108
  /**
1922
- * RenameInstance返回参数结构体
2109
+ * InquirePriceRenewDBInstances返回参数结构体
1923
2110
  */
1924
- export interface RenameInstanceResponse {
2111
+ export interface InquirePriceRenewDBInstancesResponse {
2112
+ /**
2113
+ * 价格
2114
+ */
2115
+ Price: DBInstancePrice
2116
+
1925
2117
  /**
1926
2118
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1927
2119
  */
@@ -1929,19 +2121,34 @@ export interface RenameInstanceResponse {
1929
2121
  }
1930
2122
 
1931
2123
  /**
1932
- * DescribeClientConnections返回参数结构体
2124
+ * 实例标签信息
1933
2125
  */
1934
- export interface DescribeClientConnectionsResponse {
2126
+ export interface TagInfo {
1935
2127
  /**
1936
- * 客户端连接信息,包括客户端IP和对应IP的连接数量。
2128
+ * 标签键
1937
2129
  */
1938
- Clients: Array<ClientConnection>
2130
+ TagKey: string
1939
2131
 
1940
2132
  /**
1941
- * 满足条件的记录总条数,可用于分页查询。
2133
+ * 标签值
2134
+ */
2135
+ TagValue: string
2136
+ }
2137
+
2138
+ /**
2139
+ * DescribeDBInstances返回参数结构体
2140
+ */
2141
+ export interface DescribeDBInstancesResponse {
2142
+ /**
2143
+ * 符合查询条件的实例总数
1942
2144
  */
1943
2145
  TotalCount: number
1944
2146
 
2147
+ /**
2148
+ * 实例详细信息列表
2149
+ */
2150
+ InstanceDetails: Array<InstanceDetail>
2151
+
1945
2152
  /**
1946
2153
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1947
2154
  */
@@ -1949,123 +2156,96 @@ export interface DescribeClientConnectionsResponse {
1949
2156
  }
1950
2157
 
1951
2158
  /**
1952
- * FlushInstanceRouterConfig请求参数结构体
2159
+ * OfflineIsolatedDBInstance请求参数结构体
1953
2160
  */
1954
- export interface FlushInstanceRouterConfigRequest {
2161
+ export interface OfflineIsolatedDBInstanceRequest {
1955
2162
  /**
1956
- * 实例ID
2163
+ * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
1957
2164
  */
1958
2165
  InstanceId: string
1959
2166
  }
1960
2167
 
1961
2168
  /**
1962
- * 实例信息
2169
+ * InquirePriceCreateDBInstances请求参数结构体
1963
2170
  */
1964
- export interface DBInstanceInfo {
1965
- /**
1966
- * 实例ID
1967
- */
1968
- InstanceId: string
1969
-
2171
+ export interface InquirePriceCreateDBInstancesRequest {
1970
2172
  /**
1971
- * 地域信息
2173
+ * 实例所属区域名称,格式如:ap-guangzhou-2
1972
2174
  */
1973
- Region: string
1974
- }
2175
+ Zone: string
1975
2176
 
1976
- /**
1977
- * 云数据库实例当前操作
1978
- */
1979
- export interface CurrentOp {
1980
2177
  /**
1981
- * 操作序号
1982
- 注意:此字段可能返回 null,表示取不到有效值。
1983
- */
1984
- OpId: number
2178
+ * 每个副本集内节点个数,具体参照查询云数据库的售卖规格返回参数
2179
+ */
2180
+ NodeNum: number
1985
2181
 
1986
2182
  /**
1987
- * 操作所在的命名空间,形式如db.collection
1988
- 注意:此字段可能返回 null,表示取不到有效值。
1989
- */
1990
- Ns: string
2183
+ * 实例内存大小,单位:GB
2184
+ */
2185
+ Memory: number
1991
2186
 
1992
2187
  /**
1993
- * 操作执行语句
1994
- 注意:此字段可能返回 null,表示取不到有效值。
1995
- */
1996
- Query: string
2188
+ * 实例硬盘大小,单位:GB
2189
+ */
2190
+ Volume: number
1997
2191
 
1998
2192
  /**
1999
- * 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
2000
- 注意:此字段可能返回 null,表示取不到有效值。
2001
- */
2002
- Op: string
2193
+ * 版本号,具体支持的售卖版本请参照查询云数据库的售卖规格(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存储引擎版本
2194
+ */
2195
+ MongoVersion: string
2003
2196
 
2004
2197
  /**
2005
- * 操作所在的分片名称
2198
+ * 机器类型,HIO:高IO型;HIO10G:高IO万兆型;
2006
2199
  */
2007
- ReplicaSetName: string
2200
+ MachineCode: string
2008
2201
 
2009
2202
  /**
2010
- * 筛选条件,节点状态,可能的取值为:Primary、Secondary
2011
- 注意:此字段可能返回 null,表示取不到有效值。
2012
- */
2013
- State: string
2203
+ * 实例数量, 最小值1,最大值为10
2204
+ */
2205
+ GoodsNum: number
2014
2206
 
2015
2207
  /**
2016
- * 操作详细信息
2017
- 注意:此字段可能返回 null,表示取不到有效值。
2018
- */
2019
- Operation: string
2208
+ * 实例时长,单位:月,可选值包括[1,2,3,4,5,6,7,8,9,10,11,12,24,36]
2209
+ */
2210
+ Period: number
2020
2211
 
2021
2212
  /**
2022
- * 操作所在的节点名称
2213
+ * 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
2023
2214
  */
2024
- NodeName: string
2215
+ ClusterType: string
2025
2216
 
2026
2217
  /**
2027
- * 操作已执行时间(ms)
2028
- 注意:此字段可能返回 null,表示取不到有效值。
2029
- */
2030
- MicrosecsRunning: number
2218
+ * 副本集个数,创建副本集实例时,该参数必须设置为1;创建分片实例时,具体参照查询云数据库的售卖规格返回参数;若为单节点实例,该参数设置为0
2219
+ */
2220
+ ReplicateSetNum: number
2031
2221
  }
2032
2222
 
2033
2223
  /**
2034
- * DescribeBackupAccess返回参数结构体
2224
+ * DescribeInstanceParams返回参数结构体
2035
2225
  */
2036
- export interface DescribeBackupAccessResponse {
2037
- /**
2038
- * 实例所属地域
2039
- */
2040
- Region?: string
2041
-
2226
+ export interface DescribeInstanceParamsResponse {
2042
2227
  /**
2043
- * 备份文件所在存储桶
2228
+ * 值为枚举类型参数集合
2044
2229
  */
2045
- Bucket?: string
2230
+ InstanceEnumParam: Array<InstanceEnumParam>
2046
2231
 
2047
2232
  /**
2048
- * 备份文件的存储信息
2233
+ * 值为integer类型参数集合
2049
2234
  */
2050
- Files?: Array<BackupFile>
2235
+ InstanceIntegerParam: Array<InstanceIntegerParam>
2051
2236
 
2052
2237
  /**
2053
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2238
+ * 值为text类型的参数集合
2054
2239
  */
2055
- RequestId?: string
2056
- }
2240
+ InstanceTextParam: Array<InstanceTextParam>
2057
2241
 
2058
- /**
2059
- * DescribeDBBackups返回参数结构体
2060
- */
2061
- export interface DescribeDBBackupsResponse {
2062
2242
  /**
2063
- * 备份列表
2243
+ * 值为混合类型的参数集合
2064
2244
  */
2065
- BackupList: Array<BackupInfo>
2245
+ InstanceMultiParam: Array<InstanceMultiParam>
2066
2246
 
2067
2247
  /**
2068
- * 备份总数
2248
+ * 当前实例支持修改的参数个数统计 如0
2069
2249
  */
2070
2250
  TotalCount: number
2071
2251
 
@@ -2271,120 +2451,20 @@ export interface InstanceDetail {
2271
2451
  }
2272
2452
 
2273
2453
  /**
2274
- * ModifyDBInstanceSpec请求参数结构体
2275
- */
2276
- export interface ModifyDBInstanceSpecRequest {
2277
- /**
2278
- * 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
2279
- */
2280
- InstanceId: string
2281
-
2282
- /**
2283
- * 实例配置变更后的内存大小,单位:GB。内存和磁盘必须同时升配或同时降配
2284
- */
2285
- Memory: number
2286
-
2287
- /**
2288
- * 实例配置变更后的硬盘大小,单位:GB。内存和磁盘必须同时升配或同时降配。降配时,新的磁盘参数必须大于已用磁盘容量的1.2倍
2289
- */
2290
- Volume: number
2291
-
2292
- /**
2293
- * 实例配置变更后oplog的大小,单位:GB,默认为磁盘空间的10%,允许设置的最小值为磁盘的10%,最大值为磁盘的90%
2294
- */
2295
- OplogSize?: number
2296
-
2297
- /**
2298
- * 实例变更后的节点数,取值范围具体参照查询云数据库的售卖规格返回参数。默认为不变更节点数
2299
- */
2300
- NodeNum?: number
2301
-
2302
- /**
2303
- * 实例变更后的分片数,取值范围具体参照查询云数据库的售卖规格返回参数。只能增加不能减少,默认为不变更分片数
2304
- */
2305
- ReplicateSetNum?: number
2306
-
2307
- /**
2308
- * 实例配置变更的切换时间,参数为:0(默认)、1。0-调整完成时,1-维护时间内。注:调整节点数和分片数不支持在【维护时间内】变更。
2309
- */
2310
- InMaintenance?: number
2311
- }
2312
-
2313
- /**
2314
- * 用于描述MongoDB数据库慢日志统计信息
2315
- */
2316
- export interface SlowLogPattern {
2317
- /**
2318
- * 慢日志模式
2319
- */
2320
- Pattern: string
2321
-
2322
- /**
2323
- * 最大执行时间
2324
- */
2325
- MaxTime: number
2326
-
2327
- /**
2328
- * 平均执行时间
2329
- */
2330
- AverageTime: number
2331
-
2332
- /**
2333
- * 该模式慢日志条数
2334
- */
2335
- Total: number
2336
- }
2337
-
2338
- /**
2339
- * CreateDBInstanceHour返回参数结构体
2454
+ * ModifyDBInstanceSpec返回参数结构体
2340
2455
  */
2341
- export interface CreateDBInstanceHourResponse {
2456
+ export interface ModifyDBInstanceSpecResponse {
2342
2457
  /**
2343
2458
  * 订单ID
2344
2459
  */
2345
2460
  DealId: string
2346
2461
 
2347
- /**
2348
- * 创建的实例ID列表
2349
- */
2350
- InstanceIds: Array<string>
2351
-
2352
2462
  /**
2353
2463
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2354
2464
  */
2355
2465
  RequestId?: string
2356
2466
  }
2357
2467
 
2358
- /**
2359
- * CreateBackupDBInstance请求参数结构体
2360
- */
2361
- export interface CreateBackupDBInstanceRequest {
2362
- /**
2363
- * 实例id
2364
- */
2365
- InstanceId: string
2366
-
2367
- /**
2368
- * 0-逻辑备份,1-物理备份
2369
- */
2370
- BackupMethod: number
2371
-
2372
- /**
2373
- * 备份备注
2374
- */
2375
- BackupRemark?: string
2376
- }
2377
-
2378
- /**
2379
- * DescribeInstanceParams请求参数结构体
2380
- */
2381
- export interface DescribeInstanceParamsRequest {
2382
- /**
2383
- * 实例ID
2384
- */
2385
- InstanceId: string
2386
- }
2387
-
2388
2468
  /**
2389
2469
  * 描述了实例的计费模式
2390
2470
  */
@@ -2407,21 +2487,6 @@ DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费
2407
2487
  RenewFlag?: string
2408
2488
  }
2409
2489
 
2410
- /**
2411
- * InquirePriceCreateDBInstances返回参数结构体
2412
- */
2413
- export interface InquirePriceCreateDBInstancesResponse {
2414
- /**
2415
- * 价格
2416
- */
2417
- Price: DBInstancePrice
2418
-
2419
- /**
2420
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2421
- */
2422
- RequestId?: string
2423
- }
2424
-
2425
2490
  /**
2426
2491
  * RenewDBInstances请求参数结构体
2427
2492
  */
@@ -2436,43 +2501,3 @@ export interface RenewDBInstancesRequest {
2436
2501
  */
2437
2502
  InstanceChargePrepaid: InstanceChargePrepaid
2438
2503
  }
2439
-
2440
- /**
2441
- * SetAccountUserPrivilege请求参数结构体
2442
- */
2443
- export interface SetAccountUserPrivilegeRequest {
2444
- /**
2445
- * 实例ID
2446
- */
2447
- InstanceId: string
2448
-
2449
- /**
2450
- * 账号名称
2451
- */
2452
- UserName: string
2453
-
2454
- /**
2455
- * 权限信息
2456
- */
2457
- AuthRole: Array<Auth>
2458
- }
2459
-
2460
- /**
2461
- * 需要终止的操作
2462
- */
2463
- export interface Operation {
2464
- /**
2465
- * 操作所在的分片名
2466
- */
2467
- ReplicaSetName: string
2468
-
2469
- /**
2470
- * 操作所在的节点名
2471
- */
2472
- NodeName: string
2473
-
2474
- /**
2475
- * 操作序号
2476
- */
2477
- OpId: number
2478
- }