tencentcloud-sdk-python 3.0.1468__py2.py3-none-any.whl → 3.0.1470__py2.py3-none-any.whl

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.
Files changed (45) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ai3d/v20250513/models.py +40 -2
  3. tencentcloud/apm/v20210622/models.py +2 -2
  4. tencentcloud/ccc/v20200210/models.py +45 -0
  5. tencentcloud/cdb/v20170320/cdb_client.py +23 -0
  6. tencentcloud/cdb/v20170320/errorcodes.py +3 -0
  7. tencentcloud/cdb/v20170320/models.py +128 -19
  8. tencentcloud/cdwdoris/v20211228/models.py +52 -12
  9. tencentcloud/cdwpg/v20201230/models.py +15 -0
  10. tencentcloud/ckafka/v20190819/models.py +90 -0
  11. tencentcloud/cls/v20201016/models.py +6 -6
  12. tencentcloud/dbbrain/v20191016/models.py +116 -66
  13. tencentcloud/dbbrain/v20210527/dbbrain_client.py +23 -0
  14. tencentcloud/dbbrain/v20210527/models.py +619 -230
  15. tencentcloud/dts/v20180330/dts_client.py +1 -1
  16. tencentcloud/dts/v20180330/models.py +8 -4
  17. tencentcloud/dts/v20211206/dts_client.py +6 -5
  18. tencentcloud/dts/v20211206/models.py +136 -94
  19. tencentcloud/ess/v20201111/models.py +213 -2
  20. tencentcloud/essbasic/v20210526/models.py +203 -0
  21. tencentcloud/hai/v20230812/errorcodes.py +3 -0
  22. tencentcloud/ioa/v20220601/models.py +15 -0
  23. tencentcloud/lcic/v20220817/models.py +2 -2
  24. tencentcloud/lke/v20231130/lke_client.py +1 -1
  25. tencentcloud/lke/v20231130/models.py +379 -101
  26. tencentcloud/lkeap/v20240522/models.py +2 -2
  27. tencentcloud/mongodb/v20190725/models.py +979 -508
  28. tencentcloud/mongodb/v20190725/mongodb_client.py +8 -8
  29. tencentcloud/monitor/v20180724/errorcodes.py +6 -0
  30. tencentcloud/mps/v20190612/models.py +63 -4
  31. tencentcloud/ocr/v20181119/errorcodes.py +3 -0
  32. tencentcloud/postgres/v20170312/models.py +33 -16
  33. tencentcloud/redis/v20180412/models.py +24 -16
  34. tencentcloud/rum/v20210622/models.py +2 -2
  35. tencentcloud/teo/v20220901/models.py +637 -0
  36. tencentcloud/teo/v20220901/teo_client.py +69 -0
  37. tencentcloud/tke/v20180525/errorcodes.py +3 -0
  38. tencentcloud/tke/v20180525/models.py +26 -8
  39. tencentcloud/tsf/v20180326/errorcodes.py +3 -3
  40. tencentcloud/waf/v20180125/models.py +30 -0
  41. {tencentcloud_sdk_python-3.0.1468.dist-info → tencentcloud_sdk_python-3.0.1470.dist-info}/METADATA +1 -1
  42. {tencentcloud_sdk_python-3.0.1468.dist-info → tencentcloud_sdk_python-3.0.1470.dist-info}/RECORD +45 -45
  43. {tencentcloud_sdk_python-3.0.1468.dist-info → tencentcloud_sdk_python-3.0.1470.dist-info}/LICENSE +0 -0
  44. {tencentcloud_sdk_python-3.0.1468.dist-info → tencentcloud_sdk_python-3.0.1470.dist-info}/WHEEL +0 -0
  45. {tencentcloud_sdk_python-3.0.1468.dist-info → tencentcloud_sdk_python-3.0.1470.dist-info}/top_level.txt +0 -0
@@ -19,7 +19,7 @@ from tencentcloud.common.abstract_model import AbstractModel
19
19
 
20
20
 
21
21
  class AddNodeList(AbstractModel):
22
- r"""修改实例节点详情
22
+ r"""修改实例节点详情。
23
23
 
24
24
  """
25
25
 
@@ -30,7 +30,7 @@ class AddNodeList(AbstractModel):
30
30
  - READONLY:只读节点。
31
31
  - MONGOS:Mongos 节点。
32
32
  :type Role: str
33
- :param _Zone: 节点所对应的可用区。
33
+ :param _Zone: 节点所对应的可用区。当前支持的可用区,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
34
34
  - 单可用区,所有节点在同一可用区。
35
35
  - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。
36
36
  :type Zone: str
@@ -54,7 +54,7 @@ class AddNodeList(AbstractModel):
54
54
 
55
55
  @property
56
56
  def Zone(self):
57
- r"""节点所对应的可用区。
57
+ r"""节点所对应的可用区。当前支持的可用区,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
58
58
  - 单可用区,所有节点在同一可用区。
59
59
  - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。
60
60
  :rtype: str
@@ -245,25 +245,36 @@ class BackupDownloadTask(AbstractModel):
245
245
 
246
246
  def __init__(self):
247
247
  r"""
248
- :param _CreateTime: 任务创建时间
248
+ :param _CreateTime: 任务创建时间。
249
249
  :type CreateTime: str
250
- :param _BackupName: 备份文件名
250
+ :param _BackupName: 备份文件名。
251
251
  :type BackupName: str
252
- :param _ReplicaSetId: 分片名称
252
+ :param _ReplicaSetId: 分片名称。
253
253
  :type ReplicaSetId: str
254
- :param _BackupSize: 备份数据大小,单位为字节
254
+ :param _BackupSize: 备份数据大小,单位:字节。
255
255
  :type BackupSize: int
256
- :param _Status: 任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
256
+ :param _Status: 任务状态。
257
+ - 0:等待执行。
258
+ - 1:正在下载。
259
+ - 2:下载完成。
260
+ - 3:下载失败。
261
+ - 4:等待重试。
257
262
  :type Status: int
258
- :param _Percent: 任务进度百分比
263
+ :param _Percent: 任务进度百分比。
259
264
  :type Percent: int
260
- :param _TimeSpend: 耗时,单位为秒
265
+ :param _TimeSpend: 耗时,单位为秒。
261
266
  :type TimeSpend: int
262
- :param _Url: 备份数据下载链接
267
+ :param _Url: 备份数据下载链接。
263
268
  :type Url: str
264
- :param _BackupMethod: 备份文件备份类型,0-逻辑备份,1-物理备份
269
+ :param _BackupMethod: 备份方式。
270
+ - 0:逻辑备份。
271
+ - 1:物理备份。
272
+ - 3:快照备份。
273
+ **说明**:
274
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
275
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
265
276
  :type BackupMethod: int
266
- :param _BackupDesc: 发起备份时指定的备注信息
277
+ :param _BackupDesc: 发起备份时指定的备注信息。
267
278
  :type BackupDesc: str
268
279
  :param _Region: 地区信息。
269
280
  :type Region: str
@@ -285,7 +296,7 @@ class BackupDownloadTask(AbstractModel):
285
296
 
286
297
  @property
287
298
  def CreateTime(self):
288
- r"""任务创建时间
299
+ r"""任务创建时间。
289
300
  :rtype: str
290
301
  """
291
302
  return self._CreateTime
@@ -296,7 +307,7 @@ class BackupDownloadTask(AbstractModel):
296
307
 
297
308
  @property
298
309
  def BackupName(self):
299
- r"""备份文件名
310
+ r"""备份文件名。
300
311
  :rtype: str
301
312
  """
302
313
  return self._BackupName
@@ -307,7 +318,7 @@ class BackupDownloadTask(AbstractModel):
307
318
 
308
319
  @property
309
320
  def ReplicaSetId(self):
310
- r"""分片名称
321
+ r"""分片名称。
311
322
  :rtype: str
312
323
  """
313
324
  return self._ReplicaSetId
@@ -318,7 +329,7 @@ class BackupDownloadTask(AbstractModel):
318
329
 
319
330
  @property
320
331
  def BackupSize(self):
321
- r"""备份数据大小,单位为字节
332
+ r"""备份数据大小,单位:字节。
322
333
  :rtype: int
323
334
  """
324
335
  return self._BackupSize
@@ -329,7 +340,12 @@ class BackupDownloadTask(AbstractModel):
329
340
 
330
341
  @property
331
342
  def Status(self):
332
- r"""任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
343
+ r"""任务状态。
344
+ - 0:等待执行。
345
+ - 1:正在下载。
346
+ - 2:下载完成。
347
+ - 3:下载失败。
348
+ - 4:等待重试。
333
349
  :rtype: int
334
350
  """
335
351
  return self._Status
@@ -340,7 +356,7 @@ class BackupDownloadTask(AbstractModel):
340
356
 
341
357
  @property
342
358
  def Percent(self):
343
- r"""任务进度百分比
359
+ r"""任务进度百分比。
344
360
  :rtype: int
345
361
  """
346
362
  return self._Percent
@@ -351,7 +367,7 @@ class BackupDownloadTask(AbstractModel):
351
367
 
352
368
  @property
353
369
  def TimeSpend(self):
354
- r"""耗时,单位为秒
370
+ r"""耗时,单位为秒。
355
371
  :rtype: int
356
372
  """
357
373
  return self._TimeSpend
@@ -362,7 +378,7 @@ class BackupDownloadTask(AbstractModel):
362
378
 
363
379
  @property
364
380
  def Url(self):
365
- r"""备份数据下载链接
381
+ r"""备份数据下载链接。
366
382
  :rtype: str
367
383
  """
368
384
  return self._Url
@@ -373,7 +389,13 @@ class BackupDownloadTask(AbstractModel):
373
389
 
374
390
  @property
375
391
  def BackupMethod(self):
376
- r"""备份文件备份类型,0-逻辑备份,1-物理备份
392
+ r"""备份方式。
393
+ - 0:逻辑备份。
394
+ - 1:物理备份。
395
+ - 3:快照备份。
396
+ **说明**:
397
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
398
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
377
399
  :rtype: int
378
400
  """
379
401
  return self._BackupMethod
@@ -384,7 +406,7 @@ class BackupDownloadTask(AbstractModel):
384
406
 
385
407
  @property
386
408
  def BackupDesc(self):
387
- r"""发起备份时指定的备注信息
409
+ r"""发起备份时指定的备注信息。
388
410
  :rtype: str
389
411
  """
390
412
  return self._BackupDesc
@@ -440,15 +462,20 @@ class BackupDownloadTask(AbstractModel):
440
462
 
441
463
 
442
464
  class BackupDownloadTaskStatus(AbstractModel):
443
- r"""创建备份下载任务结果
465
+ r"""创建备份下载任务结果。
444
466
 
445
467
  """
446
468
 
447
469
  def __init__(self):
448
470
  r"""
449
- :param _ReplicaSetId: 分片名
471
+ :param _ReplicaSetId: 分片名。
450
472
  :type ReplicaSetId: str
451
- :param _Status: 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
473
+ :param _Status: 任务当前状态。
474
+ - 0:等待执行。
475
+ - 1:正在下载。
476
+ - 2:下载完成。
477
+ - 3:下载失败。
478
+ - 4:等待重试。
452
479
  :type Status: int
453
480
  """
454
481
  self._ReplicaSetId = None
@@ -456,7 +483,7 @@ class BackupDownloadTaskStatus(AbstractModel):
456
483
 
457
484
  @property
458
485
  def ReplicaSetId(self):
459
- r"""分片名
486
+ r"""分片名。
460
487
  :rtype: str
461
488
  """
462
489
  return self._ReplicaSetId
@@ -467,7 +494,12 @@ class BackupDownloadTaskStatus(AbstractModel):
467
494
 
468
495
  @property
469
496
  def Status(self):
470
- r"""任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
497
+ r"""任务当前状态。
498
+ - 0:等待执行。
499
+ - 1:正在下载。
500
+ - 2:下载完成。
501
+ - 3:下载失败。
502
+ - 4:等待重试。
471
503
  :rtype: int
472
504
  """
473
505
  return self._Status
@@ -491,7 +523,7 @@ class BackupDownloadTaskStatus(AbstractModel):
491
523
 
492
524
 
493
525
  class BackupInfo(AbstractModel):
494
- r"""备份信息
526
+ r"""备份信息。
495
527
 
496
528
  """
497
529
 
@@ -499,28 +531,40 @@ class BackupInfo(AbstractModel):
499
531
  r"""
500
532
  :param _InstanceId: 实例ID。
501
533
  :type InstanceId: str
502
- :param _BackupType: 备份方式,0-自动备份,1-手动备份
534
+ :param _BackupType: 备份方式。
535
+ - 0:自动备份。
536
+ - 1:手动备份。
503
537
  :type BackupType: int
504
- :param _BackupName: 备份名称
538
+ :param _BackupName: 备份文件名称。
505
539
  :type BackupName: str
506
- :param _BackupDesc: 备份备注
540
+ :param _BackupDesc: 备份任务备注信息。
507
541
  :type BackupDesc: str
508
- :param _BackupSize: 备份文件大小,单位KB
542
+ :param _BackupSize: 备份文件大小,单位:KB
509
543
  :type BackupSize: int
510
- :param _StartTime: 备份开始时间
544
+ :param _StartTime: 备份开始时间。
511
545
  :type StartTime: str
512
- :param _EndTime: 备份结束时间
546
+ :param _EndTime: 备份结束时间。
513
547
  :type EndTime: str
514
- :param _Status: 备份状态,1-备份中,2-备份成功
548
+ :param _Status: 备份状态。
549
+ - 1:备份中。
550
+ - 2:备份成功。
515
551
  :type Status: int
516
- :param _BackupMethod: 备份方法,0-逻辑备份,1-物理备份
552
+ :param _BackupMethod: 备份方式。
553
+ - 0:逻辑备份。
554
+ - 1:物理备份。
555
+ - 3:快照备份。
556
+ **说明:**
557
+ - 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
558
+ - 实例开通存储加密,则备份方式不能为物理备份。
517
559
  :type BackupMethod: int
518
- :param _BackId: 备份记录id
560
+ :param _BackId: 备份记录 ID。
519
561
  :type BackId: int
520
- :param _DeleteTime: 备份删除时间
562
+ :param _DeleteTime: 备份删除时间。
521
563
  :type DeleteTime: str
522
- :param _BackupRegion: 异地备份地域
564
+ :param _BackupRegion: 异地备份地域。
523
565
  :type BackupRegion: str
566
+ :param _RestoreTime: 备份支持的回档时间。
567
+ :type RestoreTime: str
524
568
  """
525
569
  self._InstanceId = None
526
570
  self._BackupType = None
@@ -534,6 +578,7 @@ class BackupInfo(AbstractModel):
534
578
  self._BackId = None
535
579
  self._DeleteTime = None
536
580
  self._BackupRegion = None
581
+ self._RestoreTime = None
537
582
 
538
583
  @property
539
584
  def InstanceId(self):
@@ -548,7 +593,9 @@ class BackupInfo(AbstractModel):
548
593
 
549
594
  @property
550
595
  def BackupType(self):
551
- r"""备份方式,0-自动备份,1-手动备份
596
+ r"""备份方式。
597
+ - 0:自动备份。
598
+ - 1:手动备份。
552
599
  :rtype: int
553
600
  """
554
601
  return self._BackupType
@@ -559,7 +606,7 @@ class BackupInfo(AbstractModel):
559
606
 
560
607
  @property
561
608
  def BackupName(self):
562
- r"""备份名称
609
+ r"""备份文件名称。
563
610
  :rtype: str
564
611
  """
565
612
  return self._BackupName
@@ -570,7 +617,7 @@ class BackupInfo(AbstractModel):
570
617
 
571
618
  @property
572
619
  def BackupDesc(self):
573
- r"""备份备注
620
+ r"""备份任务备注信息。
574
621
  :rtype: str
575
622
  """
576
623
  return self._BackupDesc
@@ -581,7 +628,7 @@ class BackupInfo(AbstractModel):
581
628
 
582
629
  @property
583
630
  def BackupSize(self):
584
- r"""备份文件大小,单位KB
631
+ r"""备份文件大小,单位:KB
585
632
  :rtype: int
586
633
  """
587
634
  return self._BackupSize
@@ -592,7 +639,7 @@ class BackupInfo(AbstractModel):
592
639
 
593
640
  @property
594
641
  def StartTime(self):
595
- r"""备份开始时间
642
+ r"""备份开始时间。
596
643
  :rtype: str
597
644
  """
598
645
  return self._StartTime
@@ -603,7 +650,7 @@ class BackupInfo(AbstractModel):
603
650
 
604
651
  @property
605
652
  def EndTime(self):
606
- r"""备份结束时间
653
+ r"""备份结束时间。
607
654
  :rtype: str
608
655
  """
609
656
  return self._EndTime
@@ -614,7 +661,9 @@ class BackupInfo(AbstractModel):
614
661
 
615
662
  @property
616
663
  def Status(self):
617
- r"""备份状态,1-备份中,2-备份成功
664
+ r"""备份状态。
665
+ - 1:备份中。
666
+ - 2:备份成功。
618
667
  :rtype: int
619
668
  """
620
669
  return self._Status
@@ -625,7 +674,13 @@ class BackupInfo(AbstractModel):
625
674
 
626
675
  @property
627
676
  def BackupMethod(self):
628
- r"""备份方法,0-逻辑备份,1-物理备份
677
+ r"""备份方式。
678
+ - 0:逻辑备份。
679
+ - 1:物理备份。
680
+ - 3:快照备份。
681
+ **说明:**
682
+ - 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
683
+ - 实例开通存储加密,则备份方式不能为物理备份。
629
684
  :rtype: int
630
685
  """
631
686
  return self._BackupMethod
@@ -636,7 +691,7 @@ class BackupInfo(AbstractModel):
636
691
 
637
692
  @property
638
693
  def BackId(self):
639
- r"""备份记录id
694
+ r"""备份记录 ID。
640
695
  :rtype: int
641
696
  """
642
697
  return self._BackId
@@ -647,7 +702,7 @@ class BackupInfo(AbstractModel):
647
702
 
648
703
  @property
649
704
  def DeleteTime(self):
650
- r"""备份删除时间
705
+ r"""备份删除时间。
651
706
  :rtype: str
652
707
  """
653
708
  return self._DeleteTime
@@ -658,7 +713,7 @@ class BackupInfo(AbstractModel):
658
713
 
659
714
  @property
660
715
  def BackupRegion(self):
661
- r"""异地备份地域
716
+ r"""异地备份地域。
662
717
  :rtype: str
663
718
  """
664
719
  return self._BackupRegion
@@ -667,6 +722,17 @@ class BackupInfo(AbstractModel):
667
722
  def BackupRegion(self, BackupRegion):
668
723
  self._BackupRegion = BackupRegion
669
724
 
725
+ @property
726
+ def RestoreTime(self):
727
+ r"""备份支持的回档时间。
728
+ :rtype: str
729
+ """
730
+ return self._RestoreTime
731
+
732
+ @RestoreTime.setter
733
+ def RestoreTime(self, RestoreTime):
734
+ self._RestoreTime = RestoreTime
735
+
670
736
 
671
737
  def _deserialize(self, params):
672
738
  self._InstanceId = params.get("InstanceId")
@@ -681,6 +747,7 @@ class BackupInfo(AbstractModel):
681
747
  self._BackId = params.get("BackId")
682
748
  self._DeleteTime = params.get("DeleteTime")
683
749
  self._BackupRegion = params.get("BackupRegion")
750
+ self._RestoreTime = params.get("RestoreTime")
684
751
  memeber_set = set(params.keys())
685
752
  for name, value in vars(self).items():
686
753
  property_name = name[1:]
@@ -936,6 +1003,10 @@ class CreateBackupDBInstanceRequest(AbstractModel):
936
1003
  :param _BackupMethod: 设置备份方式。
937
1004
  - 0:逻辑备份。
938
1005
  - 1:物理备份。
1006
+ - 3:快照备份。
1007
+ **说明**:
1008
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
1009
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
939
1010
  :type BackupMethod: int
940
1011
  :param _BackupRemark: 备份备注信息。
941
1012
  :type BackupRemark: str
@@ -960,6 +1031,10 @@ class CreateBackupDBInstanceRequest(AbstractModel):
960
1031
  r"""设置备份方式。
961
1032
  - 0:逻辑备份。
962
1033
  - 1:物理备份。
1034
+ - 3:快照备份。
1035
+ **说明**:
1036
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
1037
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
963
1038
  :rtype: int
964
1039
  """
965
1040
  return self._BackupMethod
@@ -1044,13 +1119,13 @@ class CreateBackupDownloadTaskRequest(AbstractModel):
1044
1119
 
1045
1120
  def __init__(self):
1046
1121
  r"""
1047
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
1122
+ :param _InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1048
1123
  :type InstanceId: str
1049
- :param _BackupName: 要下载的备份文件名,可通过DescribeDBBackups接口获取。
1124
+ :param _BackupName: 要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。
1050
1125
  :type BackupName: str
1051
- :param _BackupSets: 指定要下载的副本集的节点名称 分片集群的分片名称列表。
1052
- 如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
1053
- 如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。
1126
+ :param _BackupSets: 指定要下载的副本集节点 ID 或分片集群的分片节点 ID 列表。
1127
+ - 如副本集实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
1128
+ - 如分片集群实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据。分片集群如需全量下载,请按示例方式传入全部分片名称。
1054
1129
  :type BackupSets: list of ReplicaSetInfo
1055
1130
  """
1056
1131
  self._InstanceId = None
@@ -1059,7 +1134,7 @@ class CreateBackupDownloadTaskRequest(AbstractModel):
1059
1134
 
1060
1135
  @property
1061
1136
  def InstanceId(self):
1062
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
1137
+ r"""实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
1063
1138
  :rtype: str
1064
1139
  """
1065
1140
  return self._InstanceId
@@ -1070,7 +1145,7 @@ class CreateBackupDownloadTaskRequest(AbstractModel):
1070
1145
 
1071
1146
  @property
1072
1147
  def BackupName(self):
1073
- r"""要下载的备份文件名,可通过DescribeDBBackups接口获取。
1148
+ r"""要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。
1074
1149
  :rtype: str
1075
1150
  """
1076
1151
  return self._BackupName
@@ -1081,9 +1156,9 @@ class CreateBackupDownloadTaskRequest(AbstractModel):
1081
1156
 
1082
1157
  @property
1083
1158
  def BackupSets(self):
1084
- r"""指定要下载的副本集的节点名称 分片集群的分片名称列表。
1085
- 如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
1086
- 如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。
1159
+ r"""指定要下载的副本集节点 ID 或分片集群的分片节点 ID 列表。
1160
+ - 如副本集实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
1161
+ - 如分片集群实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据。分片集群如需全量下载,请按示例方式传入全部分片名称。
1087
1162
  :rtype: list of ReplicaSetInfo
1088
1163
  """
1089
1164
  return self._BackupSets
@@ -1119,7 +1194,7 @@ class CreateBackupDownloadTaskResponse(AbstractModel):
1119
1194
 
1120
1195
  def __init__(self):
1121
1196
  r"""
1122
- :param _Tasks: 下载任务状态
1197
+ :param _Tasks: 下载任务状态。
1123
1198
  :type Tasks: list of BackupDownloadTaskStatus
1124
1199
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1125
1200
  :type RequestId: str
@@ -1129,7 +1204,7 @@ class CreateBackupDownloadTaskResponse(AbstractModel):
1129
1204
 
1130
1205
  @property
1131
1206
  def Tasks(self):
1132
- r"""下载任务状态
1207
+ r"""下载任务状态。
1133
1208
  :rtype: list of BackupDownloadTaskStatus
1134
1209
  """
1135
1210
  return self._Tasks
@@ -1178,18 +1253,18 @@ class CreateDBInstanceHourRequest(AbstractModel):
1178
1253
  - 创建分片集群实例,指每个分片的主从节点数量。每个分片所支持的最大节点数与最小节点数,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1179
1254
  :type NodeNum: int
1180
1255
  :param _MongoVersion: 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1181
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
1182
1256
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
1183
1257
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1184
1258
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1185
1259
  - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1186
1260
  - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
1261
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1187
1262
  :type MongoVersion: str
1188
1263
  :param _MachineCode: 产品规格类型。
1189
1264
  - HIO10G:通用高HIO万兆型。
1190
1265
  - HCD:云盘版类型。
1191
1266
  :type MachineCode: str
1192
- :param _GoodsNum: 实例数量,最小值1,最大值为10
1267
+ :param _GoodsNum: 实例数量,最小值1,最大值为30
1193
1268
  :type GoodsNum: int
1194
1269
  :param _Zone: 可用区信息,输入格式如:ap-guangzhou-2。
1195
1270
  - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
@@ -1199,9 +1274,13 @@ class CreateDBInstanceHourRequest(AbstractModel):
1199
1274
  - REPLSET:副本集。
1200
1275
  - SHARD:分片集群。
1201
1276
  :type ClusterType: str
1202
- :param _VpcId: 私有网络ID。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询确认正确的ID 示例值:vpc-pxyzim13
1277
+ :param _VpcId: 私有网络ID。
1278
+ - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
1279
+ - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
1203
1280
  :type VpcId: str
1204
- :param _SubnetId: 私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值:subnet-7jbabche
1281
+ :param _SubnetId: 私有网络 VPC 的子网 ID。
1282
+ - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
1283
+ - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
1205
1284
  :type SubnetId: str
1206
1285
  :param _Password: 实例密码。设置要求如下:
1207
1286
  - 字符个数为[8,32]。
@@ -1215,32 +1294,37 @@ class CreateDBInstanceHourRequest(AbstractModel):
1215
1294
  :type ProjectId: int
1216
1295
  :param _Tags: 实例标签信息。
1217
1296
  :type Tags: list of TagInfo
1218
- :param _Clone: 实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:克隆实例,注意:克隆实例RestoreTime为必填项。
1297
+ :param _Clone: 实例类型。
1298
+ - 1:正式实例。
1299
+ - 3:只读实例。
1300
+ - 4:灾备实例。
1301
+ - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
1219
1302
  :type Clone: int
1220
- :param _Father: 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
1303
+ :param _Father: 父实例 ID
1304
+ - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
1305
+ - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
1221
1306
  :type Father: str
1222
- :param _SecurityGroup: 安全组 ID。
1307
+ :param _SecurityGroup: 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
1223
1308
  :type SecurityGroup: list of str
1224
1309
  :param _RestoreTime: 克隆实例回档时间。
1225
1310
  - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
1226
1311
  - 回档时间范围:仅能回档7天内时间点的数据。
1227
1312
  :type RestoreTime: str
1228
- :param _InstanceName: 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
1313
+ :param _InstanceName: 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
1314
+ - 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
1315
+ - 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
1316
+ - 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
1229
1317
  :type InstanceName: str
1230
1318
  :param _AvailabilityZoneList: 若多可用区部署云数据库实例,指定多可用区列表。
1231
1319
  - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
1232
1320
  - 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
1233
1321
  - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
1234
-
1235
1322
  :type AvailabilityZoneList: list of str
1236
1323
  :param _MongosCpu: Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。
1237
-
1238
1324
  :type MongosCpu: int
1239
1325
  :param _MongosMemory: Mongos 内存大小。
1240
1326
  - 购买分片集群时,必须填写。
1241
1327
  - 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
1242
-
1243
-
1244
1328
  :type MongosMemory: int
1245
1329
  :param _MongosNodeNum: Mongos 数量。购买分片集群时,必须填写。
1246
1330
  - 单可用区部署实例,其数量范围为[3,32]。
@@ -1252,7 +1336,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1252
1336
  :type ReadonlyNodeAvailabilityZoneList: list of str
1253
1337
  :param _HiddenZone: Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
1254
1338
  :type HiddenZone: str
1255
- :param _ParamTemplateId: 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本。
1339
+ :param _ParamTemplateId: 参数模板 ID
1340
+ - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
1341
+ - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
1256
1342
  :type ParamTemplateId: str
1257
1343
  """
1258
1344
  self._Memory = None
@@ -1332,12 +1418,12 @@ class CreateDBInstanceHourRequest(AbstractModel):
1332
1418
  @property
1333
1419
  def MongoVersion(self):
1334
1420
  r"""指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1335
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
1336
1421
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
1337
1422
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1338
1423
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1339
1424
  - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1340
1425
  - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
1426
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1341
1427
  :rtype: str
1342
1428
  """
1343
1429
  return self._MongoVersion
@@ -1361,7 +1447,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
1361
1447
 
1362
1448
  @property
1363
1449
  def GoodsNum(self):
1364
- r"""实例数量,最小值1,最大值为10
1450
+ r"""实例数量,最小值1,最大值为30
1365
1451
  :rtype: int
1366
1452
  """
1367
1453
  return self._GoodsNum
@@ -1398,7 +1484,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1398
1484
 
1399
1485
  @property
1400
1486
  def VpcId(self):
1401
- r"""私有网络ID。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询确认正确的ID 示例值:vpc-pxyzim13
1487
+ r"""私有网络ID。
1488
+ - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
1489
+ - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
1402
1490
  :rtype: str
1403
1491
  """
1404
1492
  return self._VpcId
@@ -1409,7 +1497,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1409
1497
 
1410
1498
  @property
1411
1499
  def SubnetId(self):
1412
- r"""私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值:subnet-7jbabche
1500
+ r"""私有网络 VPC 的子网 ID。
1501
+ - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
1502
+ - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
1413
1503
  :rtype: str
1414
1504
  """
1415
1505
  return self._SubnetId
@@ -1459,7 +1549,11 @@ class CreateDBInstanceHourRequest(AbstractModel):
1459
1549
 
1460
1550
  @property
1461
1551
  def Clone(self):
1462
- r"""实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:克隆实例,注意:克隆实例RestoreTime为必填项。
1552
+ r"""实例类型。
1553
+ - 1:正式实例。
1554
+ - 3:只读实例。
1555
+ - 4:灾备实例。
1556
+ - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
1463
1557
  :rtype: int
1464
1558
  """
1465
1559
  return self._Clone
@@ -1470,7 +1564,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1470
1564
 
1471
1565
  @property
1472
1566
  def Father(self):
1473
- r"""父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
1567
+ r"""父实例 ID
1568
+ - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
1569
+ - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
1474
1570
  :rtype: str
1475
1571
  """
1476
1572
  return self._Father
@@ -1481,7 +1577,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
1481
1577
 
1482
1578
  @property
1483
1579
  def SecurityGroup(self):
1484
- r"""安全组 ID。
1580
+ r"""安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
1485
1581
  :rtype: list of str
1486
1582
  """
1487
1583
  return self._SecurityGroup
@@ -1505,7 +1601,10 @@ class CreateDBInstanceHourRequest(AbstractModel):
1505
1601
 
1506
1602
  @property
1507
1603
  def InstanceName(self):
1508
- r"""实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
1604
+ r"""实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
1605
+ - 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
1606
+ - 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
1607
+ - 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
1509
1608
  :rtype: str
1510
1609
  """
1511
1610
  return self._InstanceName
@@ -1520,7 +1619,6 @@ class CreateDBInstanceHourRequest(AbstractModel):
1520
1619
  - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
1521
1620
  - 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。
1522
1621
  - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
1523
-
1524
1622
  :rtype: list of str
1525
1623
  """
1526
1624
  return self._AvailabilityZoneList
@@ -1532,7 +1630,6 @@ class CreateDBInstanceHourRequest(AbstractModel):
1532
1630
  @property
1533
1631
  def MongosCpu(self):
1534
1632
  r"""Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。
1535
-
1536
1633
  :rtype: int
1537
1634
  """
1538
1635
  return self._MongosCpu
@@ -1546,8 +1643,6 @@ class CreateDBInstanceHourRequest(AbstractModel):
1546
1643
  r"""Mongos 内存大小。
1547
1644
  - 购买分片集群时,必须填写。
1548
1645
  - 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。
1549
-
1550
-
1551
1646
  :rtype: int
1552
1647
  """
1553
1648
  return self._MongosMemory
@@ -1604,7 +1699,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1604
1699
 
1605
1700
  @property
1606
1701
  def ParamTemplateId(self):
1607
- r"""参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本。
1702
+ r"""参数模板 ID
1703
+ - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
1704
+ - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
1608
1705
  :rtype: str
1609
1706
  """
1610
1707
  return self._ParamTemplateId
@@ -1724,16 +1821,26 @@ class CreateDBInstanceParamTplRequest(AbstractModel):
1724
1821
  r"""
1725
1822
  :param _TplName: 参数模板名称。
1726
1823
  :type TplName: str
1727
- :param _MongoVersion: 版本号,该参数模板支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是:MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。当MirrorTplId为空时,该字段必填。
1824
+ :param _MongoVersion: 参数模板版本号。当**MirrorTplId**为空时,该字段必填。参数模板支持的售卖版本,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
1825
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
1826
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
1827
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1828
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1829
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1830
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
1831
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1728
1832
  :type MongoVersion: str
1729
- :param _ClusterType: 实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
1730
- 当MirrorTplId为空时,该字段必填。
1833
+ :param _ClusterType: 实例类型。当 MirrorTplId 为空值时,该参数必填。
1834
+ - REPLSET:副本集实例。
1835
+ - SHARD:分片实例。
1836
+ - STANDALONE:单节点实例。
1731
1837
  :type ClusterType: str
1732
1838
  :param _TplDesc: 模板描述信息。
1733
1839
  :type TplDesc: str
1734
- :param _Params: 模板参数,若为空,则以系统默认模板作为新版本参数。
1840
+ :param _Params: 模板参数,若不配置该参数,则以系统默认模板作为新版本参数。
1735
1841
  :type Params: list of ParamType
1736
- :param _MirrorTplId: 镜像模板ID,若该字段不为空,则以该模板为镜像,克隆出一个新的模板。注意:MirrorTplId不为空时,MongoVersion及ClusterType将以MirrorTpl模板的版本及实例类型为准。
1842
+ :param _MirrorTplId: 镜像模板 ID。若指定镜像模板,则以该模板为镜像,克隆出一个新的模板。
1843
+ **注意**:MirrorTplId 不为空值时,MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。
1737
1844
  :type MirrorTplId: str
1738
1845
  """
1739
1846
  self._TplName = None
@@ -1756,7 +1863,14 @@ class CreateDBInstanceParamTplRequest(AbstractModel):
1756
1863
 
1757
1864
  @property
1758
1865
  def MongoVersion(self):
1759
- r"""版本号,该参数模板支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是:MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。当MirrorTplId为空时,该字段必填。
1866
+ r"""参数模板版本号。当**MirrorTplId**为空时,该字段必填。参数模板支持的售卖版本,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。
1867
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
1868
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
1869
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1870
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1871
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1872
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
1873
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1760
1874
  :rtype: str
1761
1875
  """
1762
1876
  return self._MongoVersion
@@ -1767,8 +1881,10 @@ class CreateDBInstanceParamTplRequest(AbstractModel):
1767
1881
 
1768
1882
  @property
1769
1883
  def ClusterType(self):
1770
- r"""实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点
1771
- 当MirrorTplId为空时,该字段必填。
1884
+ r"""实例类型。当 MirrorTplId 为空值时,该参数必填。
1885
+ - REPLSET:副本集实例。
1886
+ - SHARD:分片实例。
1887
+ - STANDALONE:单节点实例。
1772
1888
  :rtype: str
1773
1889
  """
1774
1890
  return self._ClusterType
@@ -1790,7 +1906,7 @@ class CreateDBInstanceParamTplRequest(AbstractModel):
1790
1906
 
1791
1907
  @property
1792
1908
  def Params(self):
1793
- r"""模板参数,若为空,则以系统默认模板作为新版本参数。
1909
+ r"""模板参数,若不配置该参数,则以系统默认模板作为新版本参数。
1794
1910
  :rtype: list of ParamType
1795
1911
  """
1796
1912
  return self._Params
@@ -1801,7 +1917,8 @@ class CreateDBInstanceParamTplRequest(AbstractModel):
1801
1917
 
1802
1918
  @property
1803
1919
  def MirrorTplId(self):
1804
- r"""镜像模板ID,若该字段不为空,则以该模板为镜像,克隆出一个新的模板。注意:MirrorTplId不为空时,MongoVersion及ClusterType将以MirrorTpl模板的版本及实例类型为准。
1920
+ r"""镜像模板 ID。若指定镜像模板,则以该模板为镜像,克隆出一个新的模板。
1921
+ **注意**:MirrorTplId 不为空值时,MongoVersion 及 ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。
1805
1922
  :rtype: str
1806
1923
  """
1807
1924
  return self._MirrorTplId
@@ -1891,21 +2008,20 @@ class CreateDBInstanceRequest(AbstractModel):
1891
2008
  :param _Volume: 实例硬盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1892
2009
  :type Volume: int
1893
2010
  :param _MongoVersion: 指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1894
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
1895
2011
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
1896
2012
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
1897
2013
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
1898
2014
  - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
1899
2015
  - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
2016
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
1900
2017
  :type MongoVersion: str
1901
- :param _GoodsNum: 实例数量, 最小值1,最大值为10
2018
+ :param _GoodsNum: 实例数量, 最小值1,最大值为30
1902
2019
  :type GoodsNum: int
1903
2020
  :param _Zone: 可用区信息,输入格式如:ap-guangzhou-2。
1904
2021
  - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
1905
2022
  - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
1906
2023
  :type Zone: str
1907
2024
  :param _Period: 指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。
1908
-
1909
2025
  :type Period: int
1910
2026
  :param _MachineCode: 产品规格类型。
1911
2027
  - HIO10G:通用高HIO万兆型。
@@ -1922,9 +2038,13 @@ class CreateDBInstanceRequest(AbstractModel):
1922
2038
  - 若不设置该参数,则为默认项目。
1923
2039
  - 在 [MongoDB 控制台项目管理](https://console.cloud.tencent.com/project)页面,可获取项目ID。
1924
2040
  :type ProjectId: int
1925
- :param _VpcId: 私有网络ID。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)查询确认正确的ID 示例值:vpc-pxyzim13
2041
+ :param _VpcId: 私有网络 ID。
2042
+ - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
2043
+ - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
1926
2044
  :type VpcId: str
1927
- :param _SubnetId: 私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值:subnet-7jbabche
2045
+ :param _SubnetId: 私有网络 VPC 的子网 ID。
2046
+ - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
2047
+ - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
1928
2048
  :type SubnetId: str
1929
2049
  :param _Password: 实例密码。设置要求如下:
1930
2050
  - 字符个数为[8,32]。
@@ -1942,15 +2062,24 @@ class CreateDBInstanceRequest(AbstractModel):
1942
2062
  - 1:是。
1943
2063
  - 0:否。默认为0。
1944
2064
  :type AutoVoucher: int
1945
- :param _Clone: 实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:整实例克隆,注意:克隆实例时,RestoreTime为必填项。
2065
+ :param _Clone: 实例类型。
2066
+ - 1:正式实例。
2067
+ - 3:只读实例。
2068
+ - 4:灾备实例。
2069
+ - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
1946
2070
  :type Clone: int
1947
- :param _Father: 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
2071
+ :param _Father: 父实例 ID
2072
+ - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
2073
+ - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
1948
2074
  :type Father: str
1949
- :param _SecurityGroup: 安全组 ID。
2075
+ :param _SecurityGroup: 安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
1950
2076
  :type SecurityGroup: list of str
1951
2077
  :param _RestoreTime: 克隆实例回档时间,当Clone取值为5或6时为必填。- 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。- 回档时间范围:仅能回档7天内时间点的数据。
1952
2078
  :type RestoreTime: str
1953
- :param _InstanceName: 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
2079
+ :param _InstanceName: 实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
2080
+ - 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
2081
+ - 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
2082
+ - 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
1954
2083
  :type InstanceName: str
1955
2084
  :param _AvailabilityZoneList: 若多可用区部署云数据库实例,指定多可用区列表。
1956
2085
  - 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。
@@ -1973,7 +2102,9 @@ class CreateDBInstanceRequest(AbstractModel):
1973
2102
  :type ReadonlyNodeAvailabilityZoneList: list of str
1974
2103
  :param _HiddenZone: Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
1975
2104
  :type HiddenZone: str
1976
- :param _ParamTemplateId: 参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本及实例类型。
2105
+ :param _ParamTemplateId: 参数模板 ID
2106
+ - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
2107
+ - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
1977
2108
  :type ParamTemplateId: str
1978
2109
  """
1979
2110
  self._NodeNum = None
@@ -2044,12 +2175,12 @@ class CreateDBInstanceRequest(AbstractModel):
2044
2175
  @property
2045
2176
  def MongoVersion(self):
2046
2177
  r"""指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
2047
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
2048
2178
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
2049
2179
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
2050
2180
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
2051
2181
  - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
2052
2182
  - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
2183
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
2053
2184
  :rtype: str
2054
2185
  """
2055
2186
  return self._MongoVersion
@@ -2060,7 +2191,7 @@ class CreateDBInstanceRequest(AbstractModel):
2060
2191
 
2061
2192
  @property
2062
2193
  def GoodsNum(self):
2063
- r"""实例数量, 最小值1,最大值为10
2194
+ r"""实例数量, 最小值1,最大值为30
2064
2195
  :rtype: int
2065
2196
  """
2066
2197
  return self._GoodsNum
@@ -2085,7 +2216,6 @@ class CreateDBInstanceRequest(AbstractModel):
2085
2216
  @property
2086
2217
  def Period(self):
2087
2218
  r"""指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。
2088
-
2089
2219
  :rtype: int
2090
2220
  """
2091
2221
  return self._Period
@@ -2147,7 +2277,9 @@ class CreateDBInstanceRequest(AbstractModel):
2147
2277
 
2148
2278
  @property
2149
2279
  def VpcId(self):
2150
- r"""私有网络ID。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)查询确认正确的ID 示例值:vpc-pxyzim13
2280
+ r"""私有网络 ID。
2281
+ - 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。
2282
+ - 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
2151
2283
  :rtype: str
2152
2284
  """
2153
2285
  return self._VpcId
@@ -2158,7 +2290,9 @@ class CreateDBInstanceRequest(AbstractModel):
2158
2290
 
2159
2291
  @property
2160
2292
  def SubnetId(self):
2161
- r"""私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID。 示例值:subnet-7jbabche
2293
+ r"""私有网络 VPC 的子网 ID。
2294
+ - 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。
2295
+ - 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。
2162
2296
  :rtype: str
2163
2297
  """
2164
2298
  return self._SubnetId
@@ -2221,7 +2355,11 @@ class CreateDBInstanceRequest(AbstractModel):
2221
2355
 
2222
2356
  @property
2223
2357
  def Clone(self):
2224
- r"""实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:整实例克隆,注意:克隆实例时,RestoreTime为必填项。
2358
+ r"""实例类型。
2359
+ - 1:正式实例。
2360
+ - 3:只读实例。
2361
+ - 4:灾备实例。
2362
+ - 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。
2225
2363
  :rtype: int
2226
2364
  """
2227
2365
  return self._Clone
@@ -2232,7 +2370,9 @@ class CreateDBInstanceRequest(AbstractModel):
2232
2370
 
2233
2371
  @property
2234
2372
  def Father(self):
2235
- r"""父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
2373
+ r"""父实例 ID
2374
+ - 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
2375
+ - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。
2236
2376
  :rtype: str
2237
2377
  """
2238
2378
  return self._Father
@@ -2243,7 +2383,7 @@ class CreateDBInstanceRequest(AbstractModel):
2243
2383
 
2244
2384
  @property
2245
2385
  def SecurityGroup(self):
2246
- r"""安全组 ID。
2386
+ r"""安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。
2247
2387
  :rtype: list of str
2248
2388
  """
2249
2389
  return self._SecurityGroup
@@ -2265,7 +2405,10 @@ class CreateDBInstanceRequest(AbstractModel):
2265
2405
 
2266
2406
  @property
2267
2407
  def InstanceName(self):
2268
- r"""实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
2408
+ r"""实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\_、分隔符\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。
2409
+ - 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。
2410
+ - 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。
2411
+ - 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\_node{R:12}\_db,设置批量购买数量为5,则实例名称为 cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, cluster14\_node16\_db.
2269
2412
  :rtype: str
2270
2413
  """
2271
2414
  return self._InstanceName
@@ -2360,7 +2503,9 @@ class CreateDBInstanceRequest(AbstractModel):
2360
2503
 
2361
2504
  @property
2362
2505
  def ParamTemplateId(self):
2363
- r"""参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本及实例类型。
2506
+ r"""参数模板 ID
2507
+ - 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。
2508
+ - 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。
2364
2509
  :rtype: str
2365
2510
  """
2366
2511
  return self._ParamTemplateId
@@ -2487,7 +2632,15 @@ class CurrentOp(AbstractModel):
2487
2632
  :type Ns: str
2488
2633
  :param _Query: 操作执行语句。
2489
2634
  :type Query: str
2490
- :param _Op: 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command。
2635
+ :param _Op: 操作类型。
2636
+ - none:特殊状态,空闲连接或内部任务等。
2637
+ - update:更新数据。
2638
+ - insert:插入操作。
2639
+ - query:查询操作。
2640
+ - command:命令操作。
2641
+ - getmore:获取更多数据。
2642
+ - remove:删除操作。
2643
+ - killcursors:释放查询游标的操作。
2491
2644
  :type Op: str
2492
2645
  :param _ReplicaSetName: 操作所在的分片名称。
2493
2646
  :type ReplicaSetName: str
@@ -2495,7 +2648,9 @@ class CurrentOp(AbstractModel):
2495
2648
  :type NodeName: str
2496
2649
  :param _Operation: 操作详细信息。
2497
2650
  :type Operation: str
2498
- :param _State: 筛选条件,节点状态,可能的取值为:Primary、Secondary。
2651
+ :param _State: 节点角色。
2652
+ - primary:主节点。
2653
+ - secondary:从节点。
2499
2654
  :type State: str
2500
2655
  :param _MicrosecsRunning: 操作已执行时间(ms)。
2501
2656
  :type MicrosecsRunning: int
@@ -2548,7 +2703,15 @@ class CurrentOp(AbstractModel):
2548
2703
 
2549
2704
  @property
2550
2705
  def Op(self):
2551
- r"""操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command。
2706
+ r"""操作类型。
2707
+ - none:特殊状态,空闲连接或内部任务等。
2708
+ - update:更新数据。
2709
+ - insert:插入操作。
2710
+ - query:查询操作。
2711
+ - command:命令操作。
2712
+ - getmore:获取更多数据。
2713
+ - remove:删除操作。
2714
+ - killcursors:释放查询游标的操作。
2552
2715
  :rtype: str
2553
2716
  """
2554
2717
  return self._Op
@@ -2592,7 +2755,9 @@ class CurrentOp(AbstractModel):
2592
2755
 
2593
2756
  @property
2594
2757
  def State(self):
2595
- r"""筛选条件,节点状态,可能的取值为:Primary、Secondary。
2758
+ r"""节点角色。
2759
+ - primary:主节点。
2760
+ - secondary:从节点。
2596
2761
  :rtype: str
2597
2762
  """
2598
2763
  return self._State
@@ -3114,23 +3279,32 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3114
3279
 
3115
3280
  def __init__(self):
3116
3281
  r"""
3117
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
3282
+ :param _InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
3118
3283
  :type InstanceId: str
3119
- :param _BackupName: 备份文件名,用来过滤指定文件的下载任务
3284
+ :param _BackupName: 指定备份文件名,用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
3120
3285
  :type BackupName: str
3121
- :param _StartTime: 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
3286
+ :param _StartTime: 指定查询时间范围内的任务,StartTime 指定开始时间。若不指定开始时间,则默认不限制开始时间。
3122
3287
  :type StartTime: str
3123
- :param _EndTime: 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
3288
+ :param _EndTime: 指定查询时间范围内的任务,EndTime 指定截止时间。若不指定截止时间,则默认不限制截止时间。
3124
3289
  :type EndTime: str
3125
- :param _Limit: 此次查询返回的条数,取值范围为1-100,默认为20
3290
+ :param _Limit: 此次查询返回的条数,取值范围为1-100,默认为20
3126
3291
  :type Limit: int
3127
- :param _Offset: 指定此次查询返回的页数,默认为0
3292
+ :param _Offset: 指定此次查询返回的页数,默认为0
3128
3293
  :type Offset: int
3129
- :param _OrderBy: 排序字段,取值为createTime,finishTime两种,默认为createTime
3294
+ :param _OrderBy: 排序字段。
3295
+ - createTime:按照备份下载任务的创建时间排序。默认为 createTime。
3296
+ - finishTime:按照备份下载任务的完成时间排序。
3130
3297
  :type OrderBy: str
3131
- :param _OrderByType: 排序方式,取值为asc,desc两种,默认desc
3298
+ :param _OrderByType: 排序方式。
3299
+ - asc:升序排列。
3300
+ - desc:降序排列。默认为 desc。
3132
3301
  :type OrderByType: str
3133
- :param _Status: 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
3302
+ :param _Status: 指定任务状态,用于过滤下载任务。若不配置该参数,则返回所有状态类型的任务。
3303
+ - 0:等待执行。
3304
+ - 1:正在下载。
3305
+ - 2:下载完成。
3306
+ - 3:下载失败。
3307
+ - 4:等待重试。
3134
3308
  :type Status: list of int
3135
3309
  """
3136
3310
  self._InstanceId = None
@@ -3145,7 +3319,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3145
3319
 
3146
3320
  @property
3147
3321
  def InstanceId(self):
3148
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
3322
+ r"""实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
3149
3323
  :rtype: str
3150
3324
  """
3151
3325
  return self._InstanceId
@@ -3156,7 +3330,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3156
3330
 
3157
3331
  @property
3158
3332
  def BackupName(self):
3159
- r"""备份文件名,用来过滤指定文件的下载任务
3333
+ r"""指定备份文件名,用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。
3160
3334
  :rtype: str
3161
3335
  """
3162
3336
  return self._BackupName
@@ -3167,7 +3341,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3167
3341
 
3168
3342
  @property
3169
3343
  def StartTime(self):
3170
- r"""指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
3344
+ r"""指定查询时间范围内的任务,StartTime 指定开始时间。若不指定开始时间,则默认不限制开始时间。
3171
3345
  :rtype: str
3172
3346
  """
3173
3347
  return self._StartTime
@@ -3178,7 +3352,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3178
3352
 
3179
3353
  @property
3180
3354
  def EndTime(self):
3181
- r"""指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
3355
+ r"""指定查询时间范围内的任务,EndTime 指定截止时间。若不指定截止时间,则默认不限制截止时间。
3182
3356
  :rtype: str
3183
3357
  """
3184
3358
  return self._EndTime
@@ -3189,7 +3363,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3189
3363
 
3190
3364
  @property
3191
3365
  def Limit(self):
3192
- r"""此次查询返回的条数,取值范围为1-100,默认为20
3366
+ r"""此次查询返回的条数,取值范围为1-100,默认为20
3193
3367
  :rtype: int
3194
3368
  """
3195
3369
  return self._Limit
@@ -3200,7 +3374,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3200
3374
 
3201
3375
  @property
3202
3376
  def Offset(self):
3203
- r"""指定此次查询返回的页数,默认为0
3377
+ r"""指定此次查询返回的页数,默认为0
3204
3378
  :rtype: int
3205
3379
  """
3206
3380
  return self._Offset
@@ -3211,7 +3385,9 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3211
3385
 
3212
3386
  @property
3213
3387
  def OrderBy(self):
3214
- r"""排序字段,取值为createTime,finishTime两种,默认为createTime
3388
+ r"""排序字段。
3389
+ - createTime:按照备份下载任务的创建时间排序。默认为 createTime。
3390
+ - finishTime:按照备份下载任务的完成时间排序。
3215
3391
  :rtype: str
3216
3392
  """
3217
3393
  return self._OrderBy
@@ -3222,7 +3398,9 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3222
3398
 
3223
3399
  @property
3224
3400
  def OrderByType(self):
3225
- r"""排序方式,取值为asc,desc两种,默认desc
3401
+ r"""排序方式。
3402
+ - asc:升序排列。
3403
+ - desc:降序排列。默认为 desc。
3226
3404
  :rtype: str
3227
3405
  """
3228
3406
  return self._OrderByType
@@ -3233,7 +3411,12 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
3233
3411
 
3234
3412
  @property
3235
3413
  def Status(self):
3236
- r"""根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
3414
+ r"""指定任务状态,用于过滤下载任务。若不配置该参数,则返回所有状态类型的任务。
3415
+ - 0:等待执行。
3416
+ - 1:正在下载。
3417
+ - 2:下载完成。
3418
+ - 3:下载失败。
3419
+ - 4:等待重试。
3237
3420
  :rtype: list of int
3238
3421
  """
3239
3422
  return self._Status
@@ -3270,9 +3453,9 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
3270
3453
 
3271
3454
  def __init__(self):
3272
3455
  r"""
3273
- :param _TotalCount: 满足查询条件的所有条数
3456
+ :param _TotalCount: 满足查询条件的所有条数。
3274
3457
  :type TotalCount: int
3275
- :param _Tasks: 下载任务列表
3458
+ :param _Tasks: 下载任务列表。
3276
3459
  :type Tasks: list of BackupDownloadTask
3277
3460
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3278
3461
  :type RequestId: str
@@ -3283,7 +3466,7 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
3283
3466
 
3284
3467
  @property
3285
3468
  def TotalCount(self):
3286
- r"""满足查询条件的所有条数
3469
+ r"""满足查询条件的所有条数。
3287
3470
  :rtype: int
3288
3471
  """
3289
3472
  return self._TotalCount
@@ -3294,7 +3477,7 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
3294
3477
 
3295
3478
  @property
3296
3479
  def Tasks(self):
3297
- r"""下载任务列表
3480
+ r"""下载任务列表。
3298
3481
  :rtype: list of BackupDownloadTask
3299
3482
  """
3300
3483
  return self._Tasks
@@ -3577,7 +3760,7 @@ class DescribeCurrentOpRequest(AbstractModel):
3577
3760
 
3578
3761
  def __init__(self):
3579
3762
  r"""
3580
- :param _InstanceId: 指定要查询的实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
3763
+ :param _InstanceId: 指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
3581
3764
  :type InstanceId: str
3582
3765
  :param _Ns: 操作所属的命名空间 namespace,格式为 db.collection。
3583
3766
  :type Ns: str
@@ -3585,7 +3768,15 @@ class DescribeCurrentOpRequest(AbstractModel):
3585
3768
  - 默认值为0,取值范围为[0, 3600000],单位:毫秒。
3586
3769
  - 结果将返回超过设置时间的操作。
3587
3770
  :type MillisecondRunning: int
3588
- :param _Op: 设置查询筛选条件为操作任务类型。取值包括:none、update、insert,query、command、getmore、remove 和 killcursors。
3771
+ :param _Op: 设置查询筛选条件为操作任务类型。取值包括:
3772
+ - none:特殊状态,空闲连接或内部任务等。
3773
+ - update:更新数据。
3774
+ - insert:插入操作。
3775
+ - query:查询操作。
3776
+ - command:命令操作。
3777
+ - getmore:获取更多数据。
3778
+ - remove:删除操作。
3779
+ - killcursors:释放查询游标的操作。
3589
3780
  :type Op: str
3590
3781
  :param _ReplicaSetName: 筛选条件,分片名称。
3591
3782
  :type ReplicaSetName: str
@@ -3593,13 +3784,15 @@ class DescribeCurrentOpRequest(AbstractModel):
3593
3784
  - primary:主节点。
3594
3785
  - secondary:从节点。
3595
3786
  :type State: str
3596
- :param _Limit: 单次请求返回的数量,默认值为100,取值范围为[0,100]
3787
+ :param _Limit: 单次请求返回的数量,默认值为100,取值范围为[0,100]
3597
3788
  :type Limit: int
3598
- :param _Offset: 偏移量,默认值为0,取值范围为[0,10000]
3789
+ :param _Offset: 偏移量,默认值为0,取值范围为[0,10000]
3599
3790
  :type Offset: int
3600
- :param _OrderBy: 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
3791
+ :param _OrderBy: 返回结果集排序的字段,目前支持按照 MicrosecsRunning(操作任务已执行的时间)排序。
3601
3792
  :type OrderBy: str
3602
- :param _OrderByType: 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
3793
+ :param _OrderByType: 返回结果集排序方式。
3794
+ - ASC:升序。默认为 ASC,按照升序排序。
3795
+ - DESC:降序。
3603
3796
  :type OrderByType: str
3604
3797
  """
3605
3798
  self._InstanceId = None
@@ -3615,7 +3808,7 @@ class DescribeCurrentOpRequest(AbstractModel):
3615
3808
 
3616
3809
  @property
3617
3810
  def InstanceId(self):
3618
- r"""指定要查询的实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
3811
+ r"""指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
3619
3812
  :rtype: str
3620
3813
  """
3621
3814
  return self._InstanceId
@@ -3650,7 +3843,15 @@ class DescribeCurrentOpRequest(AbstractModel):
3650
3843
 
3651
3844
  @property
3652
3845
  def Op(self):
3653
- r"""设置查询筛选条件为操作任务类型。取值包括:none、update、insert,query、command、getmore、remove 和 killcursors。
3846
+ r"""设置查询筛选条件为操作任务类型。取值包括:
3847
+ - none:特殊状态,空闲连接或内部任务等。
3848
+ - update:更新数据。
3849
+ - insert:插入操作。
3850
+ - query:查询操作。
3851
+ - command:命令操作。
3852
+ - getmore:获取更多数据。
3853
+ - remove:删除操作。
3854
+ - killcursors:释放查询游标的操作。
3654
3855
  :rtype: str
3655
3856
  """
3656
3857
  return self._Op
@@ -3685,7 +3886,7 @@ class DescribeCurrentOpRequest(AbstractModel):
3685
3886
 
3686
3887
  @property
3687
3888
  def Limit(self):
3688
- r"""单次请求返回的数量,默认值为100,取值范围为[0,100]
3889
+ r"""单次请求返回的数量,默认值为100,取值范围为[0,100]
3689
3890
  :rtype: int
3690
3891
  """
3691
3892
  return self._Limit
@@ -3696,7 +3897,7 @@ class DescribeCurrentOpRequest(AbstractModel):
3696
3897
 
3697
3898
  @property
3698
3899
  def Offset(self):
3699
- r"""偏移量,默认值为0,取值范围为[0,10000]
3900
+ r"""偏移量,默认值为0,取值范围为[0,10000]
3700
3901
  :rtype: int
3701
3902
  """
3702
3903
  return self._Offset
@@ -3707,7 +3908,7 @@ class DescribeCurrentOpRequest(AbstractModel):
3707
3908
 
3708
3909
  @property
3709
3910
  def OrderBy(self):
3710
- r"""返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
3911
+ r"""返回结果集排序的字段,目前支持按照 MicrosecsRunning(操作任务已执行的时间)排序。
3711
3912
  :rtype: str
3712
3913
  """
3713
3914
  return self._OrderBy
@@ -3718,7 +3919,9 @@ class DescribeCurrentOpRequest(AbstractModel):
3718
3919
 
3719
3920
  @property
3720
3921
  def OrderByType(self):
3721
- r"""返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
3922
+ r"""返回结果集排序方式。
3923
+ - ASC:升序。默认为 ASC,按照升序排序。
3924
+ - DESC:降序。
3722
3925
  :rtype: str
3723
3926
  """
3724
3927
  return self._OrderByType
@@ -3819,9 +4022,15 @@ class DescribeDBBackupsRequest(AbstractModel):
3819
4022
 
3820
4023
  def __init__(self):
3821
4024
  r"""
3822
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
4025
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
3823
4026
  :type InstanceId: str
3824
- :param _BackupMethod: 备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。
4027
+ :param _BackupMethod: 备份方式。
4028
+ - 0:逻辑备份。
4029
+ - 1:物理备份。
4030
+ - 3:快照备份。
4031
+ **说明**:
4032
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
4033
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
3825
4034
  :type BackupMethod: int
3826
4035
  :param _Limit: 分页大小,最大值为100,不设置默认查询所有。
3827
4036
  :type Limit: int
@@ -3835,7 +4044,7 @@ class DescribeDBBackupsRequest(AbstractModel):
3835
4044
 
3836
4045
  @property
3837
4046
  def InstanceId(self):
3838
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
4047
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
3839
4048
  :rtype: str
3840
4049
  """
3841
4050
  return self._InstanceId
@@ -3846,7 +4055,13 @@ class DescribeDBBackupsRequest(AbstractModel):
3846
4055
 
3847
4056
  @property
3848
4057
  def BackupMethod(self):
3849
- r"""备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。
4058
+ r"""备份方式。
4059
+ - 0:逻辑备份。
4060
+ - 1:物理备份。
4061
+ - 3:快照备份。
4062
+ **说明**:
4063
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
4064
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
3850
4065
  :rtype: int
3851
4066
  """
3852
4067
  return self._BackupMethod
@@ -3900,9 +4115,9 @@ class DescribeDBBackupsResponse(AbstractModel):
3900
4115
 
3901
4116
  def __init__(self):
3902
4117
  r"""
3903
- :param _BackupList: 备份列表
4118
+ :param _BackupList: 备份列表。
3904
4119
  :type BackupList: list of BackupInfo
3905
- :param _TotalCount: 备份总数
4120
+ :param _TotalCount: 备份总数。
3906
4121
  :type TotalCount: int
3907
4122
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3908
4123
  :type RequestId: str
@@ -3913,7 +4128,7 @@ class DescribeDBBackupsResponse(AbstractModel):
3913
4128
 
3914
4129
  @property
3915
4130
  def BackupList(self):
3916
- r"""备份列表
4131
+ r"""备份列表。
3917
4132
  :rtype: list of BackupInfo
3918
4133
  """
3919
4134
  return self._BackupList
@@ -3924,7 +4139,7 @@ class DescribeDBBackupsResponse(AbstractModel):
3924
4139
 
3925
4140
  @property
3926
4141
  def TotalCount(self):
3927
- r"""备份总数
4142
+ r"""备份总数。
3928
4143
  :rtype: int
3929
4144
  """
3930
4145
  return self._TotalCount
@@ -3963,14 +4178,18 @@ class DescribeDBInstanceDealRequest(AbstractModel):
3963
4178
 
3964
4179
  def __init__(self):
3965
4180
  r"""
3966
- :param _DealId: 订单ID,通过CreateDBInstance等接口返回
4181
+ :param _DealId: 订单 ID
4182
+ - 按量计费实例,请通过 [CreateDBInstanceHour](https://cloud.tencent.com/document/product/240/38570) 接口输出的参数**DealId**获取。。
4183
+ - 包年包月计费实例,请通过 [CreateDBInstance](https://cloud.tencent.com/document/product/240/38571) 接口输出的参数**DealId**获取。
3967
4184
  :type DealId: str
3968
4185
  """
3969
4186
  self._DealId = None
3970
4187
 
3971
4188
  @property
3972
4189
  def DealId(self):
3973
- r"""订单ID,通过CreateDBInstance等接口返回
4190
+ r"""订单 ID
4191
+ - 按量计费实例,请通过 [CreateDBInstanceHour](https://cloud.tencent.com/document/product/240/38570) 接口输出的参数**DealId**获取。。
4192
+ - 包年包月计费实例,请通过 [CreateDBInstance](https://cloud.tencent.com/document/product/240/38571) 接口输出的参数**DealId**获取。
3974
4193
  :rtype: str
3975
4194
  """
3976
4195
  return self._DealId
@@ -3999,15 +4218,28 @@ class DescribeDBInstanceDealResponse(AbstractModel):
3999
4218
 
4000
4219
  def __init__(self):
4001
4220
  r"""
4002
- :param _Status: 订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
4221
+ :param _Status: 订单状态。
4222
+ - 1:未支付。
4223
+ - 2:已支付。
4224
+ - 3:发货中。
4225
+ - 4:发货成功。
4226
+ - 5:发货失败。
4227
+ - 6:退款。
4228
+ - 7:订单关闭。
4229
+ - 8:超时未支付关闭。
4003
4230
  :type Status: int
4004
- :param _OriginalPrice: 订单原价。
4231
+ :param _OriginalPrice: 订单原价。单位:元。
4005
4232
  :type OriginalPrice: float
4006
- :param _DiscountPrice: 订单折扣价格。
4233
+ :param _DiscountPrice: 订单折扣价格。单位:元。
4007
4234
  :type DiscountPrice: float
4008
- :param _Action: 订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
4235
+ :param _Action: 订单操作行为。
4236
+ - purchase:新购。
4237
+ - renew:续费。
4238
+ - upgrade:升配.
4239
+ - downgrade:降配.
4240
+ - refund:退货退款。
4009
4241
  :type Action: str
4010
- :param _InstanceId: 当前订单的资源Id
4242
+ :param _InstanceId: 当前订单的实例 ID
4011
4243
  :type InstanceId: str
4012
4244
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4013
4245
  :type RequestId: str
@@ -4021,7 +4253,15 @@ class DescribeDBInstanceDealResponse(AbstractModel):
4021
4253
 
4022
4254
  @property
4023
4255
  def Status(self):
4024
- r"""订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
4256
+ r"""订单状态。
4257
+ - 1:未支付。
4258
+ - 2:已支付。
4259
+ - 3:发货中。
4260
+ - 4:发货成功。
4261
+ - 5:发货失败。
4262
+ - 6:退款。
4263
+ - 7:订单关闭。
4264
+ - 8:超时未支付关闭。
4025
4265
  :rtype: int
4026
4266
  """
4027
4267
  return self._Status
@@ -4032,7 +4272,7 @@ class DescribeDBInstanceDealResponse(AbstractModel):
4032
4272
 
4033
4273
  @property
4034
4274
  def OriginalPrice(self):
4035
- r"""订单原价。
4275
+ r"""订单原价。单位:元。
4036
4276
  :rtype: float
4037
4277
  """
4038
4278
  return self._OriginalPrice
@@ -4043,7 +4283,7 @@ class DescribeDBInstanceDealResponse(AbstractModel):
4043
4283
 
4044
4284
  @property
4045
4285
  def DiscountPrice(self):
4046
- r"""订单折扣价格。
4286
+ r"""订单折扣价格。单位:元。
4047
4287
  :rtype: float
4048
4288
  """
4049
4289
  return self._DiscountPrice
@@ -4054,7 +4294,12 @@ class DescribeDBInstanceDealResponse(AbstractModel):
4054
4294
 
4055
4295
  @property
4056
4296
  def Action(self):
4057
- r"""订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
4297
+ r"""订单操作行为。
4298
+ - purchase:新购。
4299
+ - renew:续费。
4300
+ - upgrade:升配.
4301
+ - downgrade:降配.
4302
+ - refund:退货退款。
4058
4303
  :rtype: str
4059
4304
  """
4060
4305
  return self._Action
@@ -4065,7 +4310,7 @@ class DescribeDBInstanceDealResponse(AbstractModel):
4065
4310
 
4066
4311
  @property
4067
4312
  def InstanceId(self):
4068
- r"""当前订单的资源Id
4313
+ r"""当前订单的实例 ID
4069
4314
  :rtype: str
4070
4315
  """
4071
4316
  return self._InstanceId
@@ -4211,19 +4456,23 @@ class DescribeDBInstanceNodePropertyRequest(AbstractModel):
4211
4456
 
4212
4457
  def __init__(self):
4213
4458
  r"""
4214
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
4459
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
4215
4460
  :type InstanceId: str
4216
- :param _NodeIds: 节点ID。
4461
+ :param _NodeIds: 节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID
4217
4462
  :type NodeIds: list of str
4218
4463
  :param _Roles: 节点角色。可选值包括:
4219
- <ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>
4464
+ - PRIMARY:主节点。
4465
+ - SECONDARY:从节点。
4466
+ - READONLY:只读节点。
4467
+ - ARBITER:仲裁节点。
4220
4468
  :type Roles: list of str
4221
- :param _OnlyHidden: 该参数指定节点是否为Hidden节点,默认为false。
4469
+ :param _OnlyHidden: 该参数指定节点是否为 Hidden 节点,默认为 false。
4222
4470
  :type OnlyHidden: bool
4223
4471
  :param _Priority: 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
4224
4472
  :type Priority: int
4225
4473
  :param _Votes: 该参数指定节点投票权。
4226
- <ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>
4474
+ - 1:具有投票权。
4475
+ - 0:无投票权。
4227
4476
  :type Votes: int
4228
4477
  :param _Tags: 节点标签。
4229
4478
  :type Tags: list of NodeTag
@@ -4238,7 +4487,7 @@ class DescribeDBInstanceNodePropertyRequest(AbstractModel):
4238
4487
 
4239
4488
  @property
4240
4489
  def InstanceId(self):
4241
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
4490
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
4242
4491
  :rtype: str
4243
4492
  """
4244
4493
  return self._InstanceId
@@ -4249,7 +4498,7 @@ class DescribeDBInstanceNodePropertyRequest(AbstractModel):
4249
4498
 
4250
4499
  @property
4251
4500
  def NodeIds(self):
4252
- r"""节点ID。
4501
+ r"""节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID
4253
4502
  :rtype: list of str
4254
4503
  """
4255
4504
  return self._NodeIds
@@ -4261,7 +4510,10 @@ class DescribeDBInstanceNodePropertyRequest(AbstractModel):
4261
4510
  @property
4262
4511
  def Roles(self):
4263
4512
  r"""节点角色。可选值包括:
4264
- <ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>
4513
+ - PRIMARY:主节点。
4514
+ - SECONDARY:从节点。
4515
+ - READONLY:只读节点。
4516
+ - ARBITER:仲裁节点。
4265
4517
  :rtype: list of str
4266
4518
  """
4267
4519
  return self._Roles
@@ -4272,7 +4524,7 @@ class DescribeDBInstanceNodePropertyRequest(AbstractModel):
4272
4524
 
4273
4525
  @property
4274
4526
  def OnlyHidden(self):
4275
- r"""该参数指定节点是否为Hidden节点,默认为false。
4527
+ r"""该参数指定节点是否为 Hidden 节点,默认为 false。
4276
4528
  :rtype: bool
4277
4529
  """
4278
4530
  return self._OnlyHidden
@@ -4295,7 +4547,8 @@ class DescribeDBInstanceNodePropertyRequest(AbstractModel):
4295
4547
  @property
4296
4548
  def Votes(self):
4297
4549
  r"""该参数指定节点投票权。
4298
- <ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>
4550
+ - 1:具有投票权。
4551
+ - 0:无投票权。
4299
4552
  :rtype: int
4300
4553
  """
4301
4554
  return self._Votes
@@ -4414,7 +4667,7 @@ class DescribeDBInstanceParamTplDetailRequest(AbstractModel):
4414
4667
 
4415
4668
  def __init__(self):
4416
4669
  r"""
4417
- :param _TplId: 参数模板 ID。
4670
+ :param _TplId: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
4418
4671
  :type TplId: str
4419
4672
  :param _ParamName: 参数名称,传入该值,则只会获取该字段的参数详情。为空时,返回全部参数。
4420
4673
  :type ParamName: str
@@ -4424,7 +4677,7 @@ class DescribeDBInstanceParamTplDetailRequest(AbstractModel):
4424
4677
 
4425
4678
  @property
4426
4679
  def TplId(self):
4427
- r"""参数模板 ID。
4680
+ r"""参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
4428
4681
  :rtype: str
4429
4682
  """
4430
4683
  return self._TplId
@@ -4475,9 +4728,19 @@ class DescribeDBInstanceParamTplDetailResponse(AbstractModel):
4475
4728
  :type InstanceMultiParams: list of InstanceMultiParam
4476
4729
  :param _TotalCount: 参数总个数。
4477
4730
  :type TotalCount: int
4478
- :param _MongoVersion: 模板适配实例版本。
4731
+ :param _MongoVersion: 模板适配的实例版本。
4732
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
4733
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
4734
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
4735
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
4736
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
4737
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
4738
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
4479
4739
  :type MongoVersion: str
4480
- :param _ClusterType: 模板适配集群类型,副本集或分片。。
4740
+ :param _ClusterType: 模板适配集群类型。
4741
+ - REPLSET:副本集实例。
4742
+ - SHARD:分片实例。
4743
+ - STANDALONE:单节点实例。
4481
4744
  :type ClusterType: str
4482
4745
  :param _TplName: 参数模板名称。
4483
4746
  :type TplName: str
@@ -4551,7 +4814,14 @@ class DescribeDBInstanceParamTplDetailResponse(AbstractModel):
4551
4814
 
4552
4815
  @property
4553
4816
  def MongoVersion(self):
4554
- r"""模板适配实例版本。
4817
+ r"""模板适配的实例版本。
4818
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
4819
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
4820
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
4821
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
4822
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
4823
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
4824
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
4555
4825
  :rtype: str
4556
4826
  """
4557
4827
  return self._MongoVersion
@@ -4562,7 +4832,10 @@ class DescribeDBInstanceParamTplDetailResponse(AbstractModel):
4562
4832
 
4563
4833
  @property
4564
4834
  def ClusterType(self):
4565
- r"""模板适配集群类型,副本集或分片。。
4835
+ r"""模板适配集群类型。
4836
+ - REPLSET:副本集实例。
4837
+ - SHARD:分片实例。
4838
+ - STANDALONE:单节点实例。
4566
4839
  :rtype: str
4567
4840
  """
4568
4841
  return self._ClusterType
@@ -4633,16 +4906,22 @@ class DescribeDBInstanceParamTplRequest(AbstractModel):
4633
4906
 
4634
4907
  def __init__(self):
4635
4908
  r"""
4636
- :param _TplIds: 参数模板 ID 查询条件。
4909
+ :param _TplIds: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
4637
4910
  :type TplIds: list of str
4638
- :param _TplNames: 模板名称,查询条件。
4911
+ :param _TplNames: 指定查询的模板名称。
4639
4912
  :type TplNames: list of str
4640
- :param _MongoVersion: 根据版本号查询参数模板,具体支持的售卖版本,请参见[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询云数据库的售卖规格的返回结果。参数与版本对应关系如下所示:
4641
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
4642
- - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
4913
+ :param _MongoVersion: 指定所需查询的参数模板的数据库版本号。具体支持的版本信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
4914
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
4915
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
4643
4916
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
4917
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
4918
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
4919
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
4920
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
4644
4921
  :type MongoVersion: list of str
4645
- :param _TplType: 根据模板类型查询参数模板,支持DEFAULT(默认模板)和CUSTOMIZE(自定义模板)两种。
4922
+ :param _TplType: 指定查询的模板类型。
4923
+ - DEFAULT:系统默认模板。
4924
+ - CUSTOMIZE:自定义模板。
4646
4925
  :type TplType: str
4647
4926
  """
4648
4927
  self._TplIds = None
@@ -4652,7 +4931,7 @@ class DescribeDBInstanceParamTplRequest(AbstractModel):
4652
4931
 
4653
4932
  @property
4654
4933
  def TplIds(self):
4655
- r"""参数模板 ID 查询条件。
4934
+ r"""参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。
4656
4935
  :rtype: list of str
4657
4936
  """
4658
4937
  return self._TplIds
@@ -4663,7 +4942,7 @@ class DescribeDBInstanceParamTplRequest(AbstractModel):
4663
4942
 
4664
4943
  @property
4665
4944
  def TplNames(self):
4666
- r"""模板名称,查询条件。
4945
+ r"""指定查询的模板名称。
4667
4946
  :rtype: list of str
4668
4947
  """
4669
4948
  return self._TplNames
@@ -4674,10 +4953,14 @@ class DescribeDBInstanceParamTplRequest(AbstractModel):
4674
4953
 
4675
4954
  @property
4676
4955
  def MongoVersion(self):
4677
- r"""根据版本号查询参数模板,具体支持的售卖版本,请参见[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询云数据库的售卖规格的返回结果。参数与版本对应关系如下所示:
4678
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
4679
- - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
4956
+ r"""指定所需查询的参数模板的数据库版本号。具体支持的版本信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
4957
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
4958
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
4680
4959
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
4960
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
4961
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
4962
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
4963
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
4681
4964
  :rtype: list of str
4682
4965
  """
4683
4966
  return self._MongoVersion
@@ -4688,7 +4971,9 @@ class DescribeDBInstanceParamTplRequest(AbstractModel):
4688
4971
 
4689
4972
  @property
4690
4973
  def TplType(self):
4691
- r"""根据模板类型查询参数模板,支持DEFAULT(默认模板)和CUSTOMIZE(自定义模板)两种。
4974
+ r"""指定查询的模板类型。
4975
+ - DEFAULT:系统默认模板。
4976
+ - CUSTOMIZE:自定义模板。
4692
4977
  :rtype: str
4693
4978
  """
4694
4979
  return self._TplType
@@ -4867,13 +5152,26 @@ class DescribeDBInstancesRequest(AbstractModel):
4867
5152
 
4868
5153
  def __init__(self):
4869
5154
  r"""
4870
- :param _InstanceIds: 实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
5155
+ :param _InstanceIds: 实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
4871
5156
  :type InstanceIds: list of str
4872
- :param _InstanceType: 指定查询的实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>3:只读实例。</li><li>4:灾备实例。</li></ul>
5157
+ :param _InstanceType: 指定查询的实例类型。取值范围如下:
5158
+ - 0:所有实例。
5159
+ - 1:正式实例。
5160
+ - 2:临时实例
5161
+ - 3:只读实例。
5162
+ - -1:查询同时包括正式实例、只读实例与灾备实例。
4873
5163
  :type InstanceType: int
4874
- :param _ClusterType: 指定所查询实例的集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:副本集与分片实例。</li></ul>
5164
+ :param _ClusterType: 指定所查询实例的集群类型,取值范围如下:
5165
+ - 0:副本集实例。
5166
+ - 1:分片实例。
5167
+ - -1:副本集与分片实例。
4875
5168
  :type ClusterType: int
4876
- :param _Status: 指定所查询实例的当前状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程处理中,例如:变更规格、参数修改等。</li><li>2:实例正常运行中。</li><li>-2:实例已过期。</li></ul>
5169
+ :param _Status: 指定所查询实例的当前状态,取值范围如下所示:
5170
+ - 0:待初始化。
5171
+ - 1:流程处理中,例如:变更规格、参数修改等。
5172
+ - 2:实例正常运行中。
5173
+ - -2:已隔离(包年包月)。
5174
+ - -3:已隔离(按量计费)。
4877
5175
  :type Status: list of int
4878
5176
  :param _VpcId: 私有网络的 ID。
4879
5177
  - 基础网络则无需配置该参数。
@@ -4883,9 +5181,12 @@ class DescribeDBInstancesRequest(AbstractModel):
4883
5181
  - 基础网络则无需配置该参数。
4884
5182
  - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其子网 ID。
4885
5183
  :type SubnetId: str
4886
- :param _PayMode: 指定所查询实例的付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>
5184
+ :param _PayMode: 指定所查询实例的付费类型。
5185
+ - 0:查询按量计费实例。
5186
+ - 1:查询包年包月实例。
5187
+ - -1:查询按量计费与包年包月实例。
4887
5188
  :type PayMode: int
4888
- :param _Limit: 单次请求返回的数量。默认值为20,取值范围为[1,100]。
5189
+ :param _Limit: 单次请求返回的数量。默认值为20,取值范围为(1,100]。
4889
5190
  :type Limit: int
4890
5191
  :param _Offset: 偏移量,默认值为0。
4891
5192
  :type Offset: int
@@ -4919,7 +5220,7 @@ class DescribeDBInstancesRequest(AbstractModel):
4919
5220
 
4920
5221
  @property
4921
5222
  def InstanceIds(self):
4922
- r"""实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
5223
+ r"""实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
4923
5224
  :rtype: list of str
4924
5225
  """
4925
5226
  return self._InstanceIds
@@ -4930,7 +5231,12 @@ class DescribeDBInstancesRequest(AbstractModel):
4930
5231
 
4931
5232
  @property
4932
5233
  def InstanceType(self):
4933
- r"""指定查询的实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>3:只读实例。</li><li>4:灾备实例。</li></ul>
5234
+ r"""指定查询的实例类型。取值范围如下:
5235
+ - 0:所有实例。
5236
+ - 1:正式实例。
5237
+ - 2:临时实例
5238
+ - 3:只读实例。
5239
+ - -1:查询同时包括正式实例、只读实例与灾备实例。
4934
5240
  :rtype: int
4935
5241
  """
4936
5242
  return self._InstanceType
@@ -4941,7 +5247,10 @@ class DescribeDBInstancesRequest(AbstractModel):
4941
5247
 
4942
5248
  @property
4943
5249
  def ClusterType(self):
4944
- r"""指定所查询实例的集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:副本集与分片实例。</li></ul>
5250
+ r"""指定所查询实例的集群类型,取值范围如下:
5251
+ - 0:副本集实例。
5252
+ - 1:分片实例。
5253
+ - -1:副本集与分片实例。
4945
5254
  :rtype: int
4946
5255
  """
4947
5256
  return self._ClusterType
@@ -4952,7 +5261,12 @@ class DescribeDBInstancesRequest(AbstractModel):
4952
5261
 
4953
5262
  @property
4954
5263
  def Status(self):
4955
- r"""指定所查询实例的当前状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程处理中,例如:变更规格、参数修改等。</li><li>2:实例正常运行中。</li><li>-2:实例已过期。</li></ul>
5264
+ r"""指定所查询实例的当前状态,取值范围如下所示:
5265
+ - 0:待初始化。
5266
+ - 1:流程处理中,例如:变更规格、参数修改等。
5267
+ - 2:实例正常运行中。
5268
+ - -2:已隔离(包年包月)。
5269
+ - -3:已隔离(按量计费)。
4956
5270
  :rtype: list of int
4957
5271
  """
4958
5272
  return self._Status
@@ -4989,7 +5303,10 @@ class DescribeDBInstancesRequest(AbstractModel):
4989
5303
 
4990
5304
  @property
4991
5305
  def PayMode(self):
4992
- r"""指定所查询实例的付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>
5306
+ r"""指定所查询实例的付费类型。
5307
+ - 0:查询按量计费实例。
5308
+ - 1:查询包年包月实例。
5309
+ - -1:查询按量计费与包年包月实例。
4993
5310
  :rtype: int
4994
5311
  """
4995
5312
  return self._PayMode
@@ -5000,7 +5317,7 @@ class DescribeDBInstancesRequest(AbstractModel):
5000
5317
 
5001
5318
  @property
5002
5319
  def Limit(self):
5003
- r"""单次请求返回的数量。默认值为20,取值范围为[1,100]。
5320
+ r"""单次请求返回的数量。默认值为20,取值范围为(1,100]。
5004
5321
  :rtype: int
5005
5322
  """
5006
5323
  return self._Limit
@@ -5178,29 +5495,36 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5178
5495
 
5179
5496
  def __init__(self):
5180
5497
  r"""
5181
- :param _InstanceId: 实例id
5498
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
5182
5499
  :type InstanceId: str
5183
- :param _StartTime: 待查询慢日志的开始时间
5500
+ :param _StartTime: 指定查询慢日志的开始时间。- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5184
5501
  :type StartTime: str
5185
- :param _EndTime: 待慢日志的结束时间
5502
+ :param _EndTime: 指定查询慢日志的结束时间。
5503
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
5504
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5186
5505
  :type EndTime: str
5187
- :param _ExecTime: 过滤执行时间大于此值的慢日志,单位ms,默认值100
5506
+ :param _ExecTime: 指定慢日志查询阈值,即查询执行时间大于此值的慢日志。单位:ms,默认值:100
5188
5507
  :type ExecTime: int
5189
- :param _Commands: 过滤慢日志的命令类型
5508
+ :param _Commands: 指定查询慢日志的命令类型。
5190
5509
  :type Commands: list of str
5191
- :param _Texts: 全文搜索关键字,多个关键字间为或关系
5510
+ :param _Texts: 全文搜索关键字,多个关键字间为或关系。
5192
5511
  :type Texts: list of str
5193
- :param _NodeNames: 根据节点名过滤
5512
+ :param _NodeNames: 指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。
5194
5513
  :type NodeNames: list of str
5195
- :param _QueryHash: 根据queryHash过滤
5514
+ :param _QueryHash: 指定查询 queryHash 值。
5196
5515
  :type QueryHash: list of str
5197
- :param _Offset: 分页偏移量
5516
+ :param _Offset: 分页偏移量。默认值:0。取值范围:[0,100]。
5517
+
5198
5518
  :type Offset: int
5199
- :param _Limit: 返回条数
5519
+ :param _Limit: 返回条数。默认值:20。取值范围:[0,10000]
5200
5520
  :type Limit: int
5201
- :param _OrderBy: 排序条件,只支持StartTime(按慢日志生成时间)和ExecTime(慢日志执行时间)
5521
+ :param _OrderBy: 指定慢日志排序条件。
5522
+ - StartTime:按照慢日志生成时间排序。
5523
+ - ExecTime:按照慢日志执行时间排序。
5202
5524
  :type OrderBy: str
5203
- :param _OrderByType: 排序。desc倒排,asc正排
5525
+ :param _OrderByType: 指定排序方式。
5526
+ - desc:倒序。
5527
+ - asc:顺序。
5204
5528
  :type OrderByType: str
5205
5529
  """
5206
5530
  self._InstanceId = None
@@ -5218,7 +5542,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5218
5542
 
5219
5543
  @property
5220
5544
  def InstanceId(self):
5221
- r"""实例id
5545
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
5222
5546
  :rtype: str
5223
5547
  """
5224
5548
  return self._InstanceId
@@ -5229,7 +5553,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5229
5553
 
5230
5554
  @property
5231
5555
  def StartTime(self):
5232
- r"""待查询慢日志的开始时间
5556
+ r"""指定查询慢日志的开始时间。- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5233
5557
  :rtype: str
5234
5558
  """
5235
5559
  return self._StartTime
@@ -5240,7 +5564,9 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5240
5564
 
5241
5565
  @property
5242
5566
  def EndTime(self):
5243
- r"""待慢日志的结束时间
5567
+ r"""指定查询慢日志的结束时间。
5568
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
5569
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5244
5570
  :rtype: str
5245
5571
  """
5246
5572
  return self._EndTime
@@ -5251,7 +5577,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5251
5577
 
5252
5578
  @property
5253
5579
  def ExecTime(self):
5254
- r"""过滤执行时间大于此值的慢日志,单位ms,默认值100
5580
+ r"""指定慢日志查询阈值,即查询执行时间大于此值的慢日志。单位:ms,默认值:100
5255
5581
  :rtype: int
5256
5582
  """
5257
5583
  return self._ExecTime
@@ -5262,7 +5588,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5262
5588
 
5263
5589
  @property
5264
5590
  def Commands(self):
5265
- r"""过滤慢日志的命令类型
5591
+ r"""指定查询慢日志的命令类型。
5266
5592
  :rtype: list of str
5267
5593
  """
5268
5594
  return self._Commands
@@ -5273,7 +5599,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5273
5599
 
5274
5600
  @property
5275
5601
  def Texts(self):
5276
- r"""全文搜索关键字,多个关键字间为或关系
5602
+ r"""全文搜索关键字,多个关键字间为或关系。
5277
5603
  :rtype: list of str
5278
5604
  """
5279
5605
  return self._Texts
@@ -5284,7 +5610,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5284
5610
 
5285
5611
  @property
5286
5612
  def NodeNames(self):
5287
- r"""根据节点名过滤
5613
+ r"""指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。
5288
5614
  :rtype: list of str
5289
5615
  """
5290
5616
  return self._NodeNames
@@ -5295,7 +5621,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5295
5621
 
5296
5622
  @property
5297
5623
  def QueryHash(self):
5298
- r"""根据queryHash过滤
5624
+ r"""指定查询 queryHash 值。
5299
5625
  :rtype: list of str
5300
5626
  """
5301
5627
  return self._QueryHash
@@ -5306,7 +5632,8 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5306
5632
 
5307
5633
  @property
5308
5634
  def Offset(self):
5309
- r"""分页偏移量
5635
+ r"""分页偏移量。默认值:0。取值范围:[0,100]。
5636
+
5310
5637
  :rtype: int
5311
5638
  """
5312
5639
  return self._Offset
@@ -5317,7 +5644,7 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5317
5644
 
5318
5645
  @property
5319
5646
  def Limit(self):
5320
- r"""返回条数
5647
+ r"""返回条数。默认值:20。取值范围:[0,10000]
5321
5648
  :rtype: int
5322
5649
  """
5323
5650
  return self._Limit
@@ -5328,7 +5655,9 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5328
5655
 
5329
5656
  @property
5330
5657
  def OrderBy(self):
5331
- r"""排序条件,只支持StartTime(按慢日志生成时间)和ExecTime(慢日志执行时间)
5658
+ r"""指定慢日志排序条件。
5659
+ - StartTime:按照慢日志生成时间排序。
5660
+ - ExecTime:按照慢日志执行时间排序。
5332
5661
  :rtype: str
5333
5662
  """
5334
5663
  return self._OrderBy
@@ -5339,7 +5668,9 @@ class DescribeDetailedSlowLogsRequest(AbstractModel):
5339
5668
 
5340
5669
  @property
5341
5670
  def OrderByType(self):
5342
- r"""排序。desc倒排,asc正排
5671
+ r"""指定排序方式。
5672
+ - desc:倒序。
5673
+ - asc:顺序。
5343
5674
  :rtype: str
5344
5675
  """
5345
5676
  return self._OrderByType
@@ -5379,9 +5710,9 @@ class DescribeDetailedSlowLogsResponse(AbstractModel):
5379
5710
 
5380
5711
  def __init__(self):
5381
5712
  r"""
5382
- :param _TotalCount: 满足条件的慢日志数量
5713
+ :param _TotalCount: 满足条件的慢日志数量。
5383
5714
  :type TotalCount: int
5384
- :param _DetailedSlowLogs: 慢日志详情
5715
+ :param _DetailedSlowLogs: 慢日志详情。
5385
5716
  :type DetailedSlowLogs: list of SlowLogItem
5386
5717
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5387
5718
  :type RequestId: str
@@ -5392,7 +5723,7 @@ class DescribeDetailedSlowLogsResponse(AbstractModel):
5392
5723
 
5393
5724
  @property
5394
5725
  def TotalCount(self):
5395
- r"""满足条件的慢日志数量
5726
+ r"""满足条件的慢日志数量。
5396
5727
  :rtype: int
5397
5728
  """
5398
5729
  return self._TotalCount
@@ -5403,7 +5734,7 @@ class DescribeDetailedSlowLogsResponse(AbstractModel):
5403
5734
 
5404
5735
  @property
5405
5736
  def DetailedSlowLogs(self):
5406
- r"""慢日志详情
5737
+ r"""慢日志详情。
5407
5738
  :rtype: list of SlowLogItem
5408
5739
  """
5409
5740
  return self._DetailedSlowLogs
@@ -5601,14 +5932,14 @@ class DescribeSecurityGroupRequest(AbstractModel):
5601
5932
 
5602
5933
  def __init__(self):
5603
5934
  r"""
5604
- :param _InstanceId: 实例 ID。例如:cmgo-p8vn****。
5935
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
5605
5936
  :type InstanceId: str
5606
5937
  """
5607
5938
  self._InstanceId = None
5608
5939
 
5609
5940
  @property
5610
5941
  def InstanceId(self):
5611
- r"""实例 ID。例如:cmgo-p8vn****。
5942
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
5612
5943
  :rtype: str
5613
5944
  """
5614
5945
  return self._InstanceId
@@ -5685,11 +6016,15 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
5685
6016
 
5686
6017
  def __init__(self):
5687
6018
  r"""
5688
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
6019
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
5689
6020
  :type InstanceId: str
5690
- :param _StartTime: 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6021
+ :param _StartTime: 慢日志起始时间。
6022
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
6023
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5691
6024
  :type StartTime: str
5692
- :param _EndTime: 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6025
+ :param _EndTime: 慢日志终止时间。
6026
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
6027
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5693
6028
  :type EndTime: str
5694
6029
  :param _SlowMS: 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
5695
6030
  :type SlowMS: int
@@ -5710,7 +6045,7 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
5710
6045
 
5711
6046
  @property
5712
6047
  def InstanceId(self):
5713
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
6048
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
5714
6049
  :rtype: str
5715
6050
  """
5716
6051
  return self._InstanceId
@@ -5721,7 +6056,9 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
5721
6056
 
5722
6057
  @property
5723
6058
  def StartTime(self):
5724
- r"""慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6059
+ r"""慢日志起始时间。
6060
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
6061
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5725
6062
  :rtype: str
5726
6063
  """
5727
6064
  return self._StartTime
@@ -5732,7 +6069,9 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
5732
6069
 
5733
6070
  @property
5734
6071
  def EndTime(self):
5735
- r"""慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6072
+ r"""慢日志终止时间。
6073
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
6074
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5736
6075
  :rtype: str
5737
6076
  """
5738
6077
  return self._EndTime
@@ -5874,11 +6213,15 @@ class DescribeSlowLogsRequest(AbstractModel):
5874
6213
 
5875
6214
  def __init__(self):
5876
6215
  r"""
5877
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
6216
+ :param _InstanceId: 实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
5878
6217
  :type InstanceId: str
5879
- :param _StartTime: 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6218
+ :param _StartTime: 慢日志起始时间。
6219
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
6220
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5880
6221
  :type StartTime: str
5881
- :param _EndTime: 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6222
+ :param _EndTime: 慢日志终止时间。
6223
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
6224
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5882
6225
  :type EndTime: str
5883
6226
  :param _SlowMS: 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
5884
6227
  :type SlowMS: int
@@ -5899,7 +6242,7 @@ class DescribeSlowLogsRequest(AbstractModel):
5899
6242
 
5900
6243
  @property
5901
6244
  def InstanceId(self):
5902
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
6245
+ r"""实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
5903
6246
  :rtype: str
5904
6247
  """
5905
6248
  return self._InstanceId
@@ -5910,7 +6253,9 @@ class DescribeSlowLogsRequest(AbstractModel):
5910
6253
 
5911
6254
  @property
5912
6255
  def StartTime(self):
5913
- r"""慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6256
+ r"""慢日志起始时间。
6257
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。
6258
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5914
6259
  :rtype: str
5915
6260
  """
5916
6261
  return self._StartTime
@@ -5921,7 +6266,9 @@ class DescribeSlowLogsRequest(AbstractModel):
5921
6266
 
5922
6267
  @property
5923
6268
  def EndTime(self):
5924
- r"""慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
6269
+ r"""慢日志终止时间。
6270
+ - 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。
6271
+ - 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
5925
6272
  :rtype: str
5926
6273
  """
5927
6274
  return self._EndTime
@@ -6000,9 +6347,9 @@ class DescribeSlowLogsResponse(AbstractModel):
6000
6347
 
6001
6348
  def __init__(self):
6002
6349
  r"""
6003
- :param _Count: 慢日志总数
6350
+ :param _Count: 慢日志总数。
6004
6351
  :type Count: int
6005
- :param _SlowLogs: 慢日志详情
6352
+ :param _SlowLogs: 慢日志详情。
6006
6353
  :type SlowLogs: list of str
6007
6354
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6008
6355
  :type RequestId: str
@@ -6013,7 +6360,7 @@ class DescribeSlowLogsResponse(AbstractModel):
6013
6360
 
6014
6361
  @property
6015
6362
  def Count(self):
6016
- r"""慢日志总数
6363
+ r"""慢日志总数。
6017
6364
  :rtype: int
6018
6365
  """
6019
6366
  return self._Count
@@ -6024,7 +6371,7 @@ class DescribeSlowLogsResponse(AbstractModel):
6024
6371
 
6025
6372
  @property
6026
6373
  def SlowLogs(self):
6027
- r"""慢日志详情
6374
+ r"""慢日志详情。
6028
6375
  :rtype: list of str
6029
6376
  """
6030
6377
  return self._SlowLogs
@@ -6058,14 +6405,14 @@ class DescribeSpecInfoRequest(AbstractModel):
6058
6405
 
6059
6406
  def __init__(self):
6060
6407
  r"""
6061
- :param _Zone: 待查询可用区
6408
+ :param _Zone: 待查询可用区。当前支持的可用区,请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。
6062
6409
  :type Zone: str
6063
6410
  """
6064
6411
  self._Zone = None
6065
6412
 
6066
6413
  @property
6067
6414
  def Zone(self):
6068
- r"""待查询可用区
6415
+ r"""待查询可用区。当前支持的可用区,请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。
6069
6416
  :rtype: str
6070
6417
  """
6071
6418
  return self._Zone
@@ -6094,7 +6441,7 @@ class DescribeSpecInfoResponse(AbstractModel):
6094
6441
 
6095
6442
  def __init__(self):
6096
6443
  r"""
6097
- :param _SpecInfoList: 实例售卖规格信息列表
6444
+ :param _SpecInfoList: 实例售卖规格信息列表。
6098
6445
  :type SpecInfoList: list of SpecificationInfo
6099
6446
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
6100
6447
  :type RequestId: str
@@ -6104,7 +6451,7 @@ class DescribeSpecInfoResponse(AbstractModel):
6104
6451
 
6105
6452
  @property
6106
6453
  def SpecInfoList(self):
6107
- r"""实例售卖规格信息列表
6454
+ r"""实例售卖规格信息列表。
6108
6455
  :rtype: list of SpecificationInfo
6109
6456
  """
6110
6457
  return self._SpecInfoList
@@ -6142,14 +6489,14 @@ class DescribeTransparentDataEncryptionStatusRequest(AbstractModel):
6142
6489
 
6143
6490
  def __init__(self):
6144
6491
  r"""
6145
- :param _InstanceId: 指定实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
6492
+ :param _InstanceId: 指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
6146
6493
  :type InstanceId: str
6147
6494
  """
6148
6495
  self._InstanceId = None
6149
6496
 
6150
6497
  @property
6151
6498
  def InstanceId(self):
6152
- r"""指定实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
6499
+ r"""指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
6153
6500
  :rtype: str
6154
6501
  """
6155
6502
  return self._InstanceId
@@ -6247,14 +6594,14 @@ class DropDBInstanceParamTplRequest(AbstractModel):
6247
6594
 
6248
6595
  def __init__(self):
6249
6596
  r"""
6250
- :param _TplId: 参数模板 ID。
6597
+ :param _TplId: 参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
6251
6598
  :type TplId: str
6252
6599
  """
6253
6600
  self._TplId = None
6254
6601
 
6255
6602
  @property
6256
6603
  def TplId(self):
6257
- r"""参数模板 ID。
6604
+ r"""参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
6258
6605
  :rtype: str
6259
6606
  """
6260
6607
  return self._TplId
@@ -6414,15 +6761,15 @@ class EnableTransparentDataEncryptionResponse(AbstractModel):
6414
6761
 
6415
6762
 
6416
6763
  class FBKeyValue(AbstractModel):
6417
- r"""按key回档,用于筛选数据的键值对
6764
+ r"""按 Key 闪回键值对
6418
6765
 
6419
6766
  """
6420
6767
 
6421
6768
  def __init__(self):
6422
6769
  r"""
6423
- :param _Key: 用于按key回档过滤的key
6770
+ :param _Key: 指定按 Key 闪回的目标 Key (键) 。
6424
6771
  :type Key: str
6425
- :param _Value: 用于按key回档过滤的value
6772
+ :param _Value: 指定按 Key 闪回的目标 Key 所对应的 Value(值)。
6426
6773
  :type Value: str
6427
6774
  """
6428
6775
  self._Key = None
@@ -6430,7 +6777,7 @@ class FBKeyValue(AbstractModel):
6430
6777
 
6431
6778
  @property
6432
6779
  def Key(self):
6433
- r"""用于按key回档过滤的key
6780
+ r"""指定按 Key 闪回的目标 Key (键) 。
6434
6781
  :rtype: str
6435
6782
  """
6436
6783
  return self._Key
@@ -6441,7 +6788,7 @@ class FBKeyValue(AbstractModel):
6441
6788
 
6442
6789
  @property
6443
6790
  def Value(self):
6444
- r"""用于按key回档过滤的value
6791
+ r"""指定按 Key 闪回的目标 Key 所对应的 Value(值)。
6445
6792
  :rtype: str
6446
6793
  """
6447
6794
  return self._Value
@@ -6594,19 +6941,19 @@ class FlashBackDBInstanceResponse(AbstractModel):
6594
6941
 
6595
6942
 
6596
6943
  class FlashbackCollection(AbstractModel):
6597
- r"""按key回档,源数据所在的表
6944
+ r"""按 Key 闪回数据表
6598
6945
 
6599
6946
  """
6600
6947
 
6601
6948
  def __init__(self):
6602
6949
  r"""
6603
- :param _CollectionName: 按key回档指定的集合名
6950
+ :param _CollectionName: 指定按 Key 闪回源数据库集合名。
6604
6951
  :type CollectionName: str
6605
- :param _TargetResultCollectionName: 按key回档到的目标集合名
6952
+ :param _TargetResultCollectionName: 指定按 Key 闪回目标数据库集合名。
6606
6953
  :type TargetResultCollectionName: str
6607
- :param _FilterKey: 上传到cos的文件的value所对应的key值
6954
+ :param _FilterKey: 指定用于过滤按 Key 闪回的 Key(键)。
6608
6955
  :type FilterKey: str
6609
- :param _KeyValues: 用于按key回档过滤的键值对
6956
+ :param _KeyValues: 指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。
6610
6957
  :type KeyValues: list of FBKeyValue
6611
6958
  """
6612
6959
  self._CollectionName = None
@@ -6616,7 +6963,7 @@ class FlashbackCollection(AbstractModel):
6616
6963
 
6617
6964
  @property
6618
6965
  def CollectionName(self):
6619
- r"""按key回档指定的集合名
6966
+ r"""指定按 Key 闪回源数据库集合名。
6620
6967
  :rtype: str
6621
6968
  """
6622
6969
  return self._CollectionName
@@ -6627,7 +6974,7 @@ class FlashbackCollection(AbstractModel):
6627
6974
 
6628
6975
  @property
6629
6976
  def TargetResultCollectionName(self):
6630
- r"""按key回档到的目标集合名
6977
+ r"""指定按 Key 闪回目标数据库集合名。
6631
6978
  :rtype: str
6632
6979
  """
6633
6980
  return self._TargetResultCollectionName
@@ -6638,7 +6985,7 @@ class FlashbackCollection(AbstractModel):
6638
6985
 
6639
6986
  @property
6640
6987
  def FilterKey(self):
6641
- r"""上传到cos的文件的value所对应的key值
6988
+ r"""指定用于过滤按 Key 闪回的 Key(键)。
6642
6989
  :rtype: str
6643
6990
  """
6644
6991
  return self._FilterKey
@@ -6649,7 +6996,7 @@ class FlashbackCollection(AbstractModel):
6649
6996
 
6650
6997
  @property
6651
6998
  def KeyValues(self):
6652
- r"""用于按key回档过滤的键值对
6999
+ r"""指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。
6653
7000
  :rtype: list of FBKeyValue
6654
7001
  """
6655
7002
  return self._KeyValues
@@ -6680,15 +7027,15 @@ class FlashbackCollection(AbstractModel):
6680
7027
 
6681
7028
 
6682
7029
  class FlashbackDatabase(AbstractModel):
6683
- r"""按key回档,源数据所在的库表
7030
+ r"""按 Key 闪回的数据库及集合信息
6684
7031
 
6685
7032
  """
6686
7033
 
6687
7034
  def __init__(self):
6688
7035
  r"""
6689
- :param _DBName: 按key回档源数据所在库
7036
+ :param _DBName: 按 Key 闪回目标数据所在库。
6690
7037
  :type DBName: str
6691
- :param _Collections: 按key回档的集群数组
7038
+ :param _Collections: 按 Key 闪回的数据库集合。
6692
7039
  :type Collections: list of FlashbackCollection
6693
7040
  """
6694
7041
  self._DBName = None
@@ -6696,7 +7043,7 @@ class FlashbackDatabase(AbstractModel):
6696
7043
 
6697
7044
  @property
6698
7045
  def DBName(self):
6699
- r"""按key回档源数据所在库
7046
+ r"""按 Key 闪回目标数据所在库。
6700
7047
  :rtype: str
6701
7048
  """
6702
7049
  return self._DBName
@@ -6707,7 +7054,7 @@ class FlashbackDatabase(AbstractModel):
6707
7054
 
6708
7055
  @property
6709
7056
  def Collections(self):
6710
- r"""按key回档的集群数组
7057
+ r"""按 Key 闪回的数据库集合。
6711
7058
  :rtype: list of FlashbackCollection
6712
7059
  """
6713
7060
  return self._Collections
@@ -7463,33 +7810,44 @@ class InstanceChargePrepaid(AbstractModel):
7463
7810
 
7464
7811
 
7465
7812
  class InstanceDetail(AbstractModel):
7466
- r"""实例详情
7813
+ r"""实例详情。
7467
7814
 
7468
7815
  """
7469
7816
 
7470
7817
  def __init__(self):
7471
7818
  r"""
7472
- :param _InstanceId: 实例ID。
7819
+ :param _InstanceId: 实例 ID。
7473
7820
  :type InstanceId: str
7474
7821
  :param _InstanceName: 实例名称。
7475
7822
  :type InstanceName: str
7476
- :param _PayMode: 付费类型,可能的返回值:1-包年包月;0-按量计费
7823
+ :param _PayMode: 付费类型。
7824
+ - 1:包年包月。
7825
+ - 0:按量计费。
7477
7826
  :type PayMode: int
7478
- :param _ProjectId: 项目ID。
7827
+ :param _ProjectId: 项目 ID。
7479
7828
  :type ProjectId: int
7480
- :param _ClusterType: 集群类型,可能的返回值:0-副本集实例,1-分片实例。
7829
+ :param _ClusterType: 集群类型。
7830
+ - 0:副本集实例。
7831
+ - 1:分片实例。
7481
7832
  :type ClusterType: int
7482
7833
  :param _Region: 地域信息。
7483
7834
  :type Region: str
7484
7835
  :param _Zone: 可用区信息。
7485
7836
  :type Zone: str
7486
- :param _NetType: 网络类型,可能的返回值:0-基础网络,1-私有网络
7837
+ :param _NetType: 网络类型。
7838
+ - 0:基础网络。
7839
+ - 1:私有网络。
7487
7840
  :type NetType: int
7488
7841
  :param _VpcId: 私有网络的ID。
7489
7842
  :type VpcId: str
7490
7843
  :param _SubnetId: 私有网络的子网ID。
7491
7844
  :type SubnetId: str
7492
- :param _Status: 实例状态,可能的返回值:0-创建中,1-流程处理中,2-运行中,-2-实例已过期。
7845
+ :param _Status: 实例状态。
7846
+ - 0:待初始化。
7847
+ - 1:流程处理中,例如:变更规格、参数修改等。
7848
+ - 2:实例正常运行中。
7849
+ - -2:已隔离(包年包月)。
7850
+ - -3:已隔离(按量计费)。
7493
7851
  :type Status: int
7494
7852
  :param _Vip: 实例IP。
7495
7853
  :type Vip: str
@@ -7499,23 +7857,35 @@ class InstanceDetail(AbstractModel):
7499
7857
  :type CreateTime: str
7500
7858
  :param _DeadLine: 实例到期时间。
7501
7859
  :type DeadLine: str
7502
- :param _MongoVersion: 实例版本信息。
7860
+ :param _MongoVersion: 实例存储引擎版本信息。
7861
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
7862
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
7863
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
7864
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
7865
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
7866
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
7867
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
7503
7868
  :type MongoVersion: str
7504
- :param _Memory: 实例内存规格,单位为MB。
7869
+ :param _Memory: 实例内存规格,单位:MB。
7505
7870
  :type Memory: int
7506
- :param _Volume: 实例磁盘规格,单位为MB。
7871
+ :param _Volume: 实例磁盘规格,单位:MB。
7507
7872
  :type Volume: int
7508
- :param _CpuNum: 实例CPU核心数。
7873
+ :param _CpuNum: 实例 CPU 核心数。
7509
7874
  :type CpuNum: int
7510
7875
  :param _MachineType: 实例机器类型。
7876
+ - HIO10G:通用高 HIO 万兆型。
7877
+ - HCD:云盘版类型。
7511
7878
  :type MachineType: str
7512
7879
  :param _SecondaryNum: 实例从节点数。
7513
7880
  :type SecondaryNum: int
7514
7881
  :param _ReplicationSetNum: 实例分片数。
7515
7882
  :type ReplicationSetNum: int
7516
- :param _AutoRenewFlag: 实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费。
7883
+ :param _AutoRenewFlag: 实例自动续费标志。
7884
+ - 0:手动续费。
7885
+ - 1:自动续费。
7886
+ - 2:确认不续费。
7517
7887
  :type AutoRenewFlag: int
7518
- :param _UsedVolume: 已用容量,单位MB。
7888
+ :param _UsedVolume: 已用容量,单位:MB。
7519
7889
  :type UsedVolume: int
7520
7890
  :param _MaintenanceStart: 维护窗口起始时间。
7521
7891
  :type MaintenanceStart: str
@@ -7537,29 +7907,34 @@ class InstanceDetail(AbstractModel):
7537
7907
  :type InstanceVer: int
7538
7908
  :param _ClusterVer: 实例版本标记。
7539
7909
  :type ClusterVer: int
7540
- :param _Protocol: 协议信息,可能的返回值:1-mongodb,2-dynamodb
7910
+ :param _Protocol: 协议信息:mongodb。
7541
7911
  :type Protocol: int
7542
- :param _InstanceType: 实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例
7912
+ :param _InstanceType: 实例类型。
7913
+ - 0:所有实例。
7914
+ - 1:正式实例。
7915
+ - 2:临时实例
7916
+ - 3:只读实例。
7917
+ - -1:同时包括正式实例、只读实例与灾备实例。
7543
7918
  :type InstanceType: int
7544
- :param _InstanceStatusDesc: 实例状态描述
7919
+ :param _InstanceStatusDesc: 实例状态描述。
7545
7920
  :type InstanceStatusDesc: str
7546
- :param _RealInstanceId: 实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取
7921
+ :param _RealInstanceId: 实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId RealInstanceId,从 barad 获取监控数据等场景下需要用物理 ID 获取。
7547
7922
  :type RealInstanceId: str
7548
7923
  :param _ZoneList: 实例当前可用区信息。
7549
7924
  :type ZoneList: list of str
7550
- :param _MongosNodeNum: mongos节点个数。
7925
+ :param _MongosNodeNum: mongos 节点个数。
7551
7926
  :type MongosNodeNum: int
7552
- :param _MongosMemory: mongos节点内存。
7927
+ :param _MongosMemory: mongos 节点内存。单位:MB。
7553
7928
  :type MongosMemory: int
7554
- :param _MongosCpuNum: mongos节点CPU核数。
7929
+ :param _MongosCpuNum: mongos 节点 CPU 核数。
7555
7930
  :type MongosCpuNum: int
7556
7931
  :param _ConfigServerNodeNum: Config Server节点个数。
7557
7932
  :type ConfigServerNodeNum: int
7558
- :param _ConfigServerMemory: Config Server节点内存。
7933
+ :param _ConfigServerMemory: Config Server节点内存。单位:MB。
7559
7934
  :type ConfigServerMemory: int
7560
- :param _ConfigServerVolume: Config Server节点磁盘大小。
7935
+ :param _ConfigServerVolume: Config Server节点磁盘大小。单位:MB。
7561
7936
  :type ConfigServerVolume: int
7562
- :param _ConfigServerCpuNum: Config Server节点CPU核数。
7937
+ :param _ConfigServerCpuNum: Config Server 节点 CPU 核数。
7563
7938
  :type ConfigServerCpuNum: int
7564
7939
  :param _ReadonlyNodeNum: readonly节点个数。
7565
7940
  :type ReadonlyNodeNum: int
@@ -7614,7 +7989,7 @@ class InstanceDetail(AbstractModel):
7614
7989
 
7615
7990
  @property
7616
7991
  def InstanceId(self):
7617
- r"""实例ID。
7992
+ r"""实例 ID。
7618
7993
  :rtype: str
7619
7994
  """
7620
7995
  return self._InstanceId
@@ -7636,7 +8011,9 @@ class InstanceDetail(AbstractModel):
7636
8011
 
7637
8012
  @property
7638
8013
  def PayMode(self):
7639
- r"""付费类型,可能的返回值:1-包年包月;0-按量计费
8014
+ r"""付费类型。
8015
+ - 1:包年包月。
8016
+ - 0:按量计费。
7640
8017
  :rtype: int
7641
8018
  """
7642
8019
  return self._PayMode
@@ -7647,7 +8024,7 @@ class InstanceDetail(AbstractModel):
7647
8024
 
7648
8025
  @property
7649
8026
  def ProjectId(self):
7650
- r"""项目ID。
8027
+ r"""项目 ID。
7651
8028
  :rtype: int
7652
8029
  """
7653
8030
  return self._ProjectId
@@ -7658,7 +8035,9 @@ class InstanceDetail(AbstractModel):
7658
8035
 
7659
8036
  @property
7660
8037
  def ClusterType(self):
7661
- r"""集群类型,可能的返回值:0-副本集实例,1-分片实例。
8038
+ r"""集群类型。
8039
+ - 0:副本集实例。
8040
+ - 1:分片实例。
7662
8041
  :rtype: int
7663
8042
  """
7664
8043
  return self._ClusterType
@@ -7691,7 +8070,9 @@ class InstanceDetail(AbstractModel):
7691
8070
 
7692
8071
  @property
7693
8072
  def NetType(self):
7694
- r"""网络类型,可能的返回值:0-基础网络,1-私有网络
8073
+ r"""网络类型。
8074
+ - 0:基础网络。
8075
+ - 1:私有网络。
7695
8076
  :rtype: int
7696
8077
  """
7697
8078
  return self._NetType
@@ -7724,7 +8105,12 @@ class InstanceDetail(AbstractModel):
7724
8105
 
7725
8106
  @property
7726
8107
  def Status(self):
7727
- r"""实例状态,可能的返回值:0-创建中,1-流程处理中,2-运行中,-2-实例已过期。
8108
+ r"""实例状态。
8109
+ - 0:待初始化。
8110
+ - 1:流程处理中,例如:变更规格、参数修改等。
8111
+ - 2:实例正常运行中。
8112
+ - -2:已隔离(包年包月)。
8113
+ - -3:已隔离(按量计费)。
7728
8114
  :rtype: int
7729
8115
  """
7730
8116
  return self._Status
@@ -7779,7 +8165,14 @@ class InstanceDetail(AbstractModel):
7779
8165
 
7780
8166
  @property
7781
8167
  def MongoVersion(self):
7782
- r"""实例版本信息。
8168
+ r"""实例存储引擎版本信息。
8169
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
8170
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
8171
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
8172
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
8173
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
8174
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
8175
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
7783
8176
  :rtype: str
7784
8177
  """
7785
8178
  return self._MongoVersion
@@ -7790,7 +8183,7 @@ class InstanceDetail(AbstractModel):
7790
8183
 
7791
8184
  @property
7792
8185
  def Memory(self):
7793
- r"""实例内存规格,单位为MB。
8186
+ r"""实例内存规格,单位:MB。
7794
8187
  :rtype: int
7795
8188
  """
7796
8189
  return self._Memory
@@ -7801,7 +8194,7 @@ class InstanceDetail(AbstractModel):
7801
8194
 
7802
8195
  @property
7803
8196
  def Volume(self):
7804
- r"""实例磁盘规格,单位为MB。
8197
+ r"""实例磁盘规格,单位:MB。
7805
8198
  :rtype: int
7806
8199
  """
7807
8200
  return self._Volume
@@ -7812,7 +8205,7 @@ class InstanceDetail(AbstractModel):
7812
8205
 
7813
8206
  @property
7814
8207
  def CpuNum(self):
7815
- r"""实例CPU核心数。
8208
+ r"""实例 CPU 核心数。
7816
8209
  :rtype: int
7817
8210
  """
7818
8211
  return self._CpuNum
@@ -7824,6 +8217,8 @@ class InstanceDetail(AbstractModel):
7824
8217
  @property
7825
8218
  def MachineType(self):
7826
8219
  r"""实例机器类型。
8220
+ - HIO10G:通用高 HIO 万兆型。
8221
+ - HCD:云盘版类型。
7827
8222
  :rtype: str
7828
8223
  """
7829
8224
  return self._MachineType
@@ -7856,7 +8251,10 @@ class InstanceDetail(AbstractModel):
7856
8251
 
7857
8252
  @property
7858
8253
  def AutoRenewFlag(self):
7859
- r"""实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费。
8254
+ r"""实例自动续费标志。
8255
+ - 0:手动续费。
8256
+ - 1:自动续费。
8257
+ - 2:确认不续费。
7860
8258
  :rtype: int
7861
8259
  """
7862
8260
  return self._AutoRenewFlag
@@ -7867,7 +8265,7 @@ class InstanceDetail(AbstractModel):
7867
8265
 
7868
8266
  @property
7869
8267
  def UsedVolume(self):
7870
- r"""已用容量,单位MB。
8268
+ r"""已用容量,单位:MB。
7871
8269
  :rtype: int
7872
8270
  """
7873
8271
  return self._UsedVolume
@@ -7988,7 +8386,7 @@ class InstanceDetail(AbstractModel):
7988
8386
 
7989
8387
  @property
7990
8388
  def Protocol(self):
7991
- r"""协议信息,可能的返回值:1-mongodb,2-dynamodb
8389
+ r"""协议信息:mongodb。
7992
8390
  :rtype: int
7993
8391
  """
7994
8392
  return self._Protocol
@@ -7999,7 +8397,12 @@ class InstanceDetail(AbstractModel):
7999
8397
 
8000
8398
  @property
8001
8399
  def InstanceType(self):
8002
- r"""实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例
8400
+ r"""实例类型。
8401
+ - 0:所有实例。
8402
+ - 1:正式实例。
8403
+ - 2:临时实例
8404
+ - 3:只读实例。
8405
+ - -1:同时包括正式实例、只读实例与灾备实例。
8003
8406
  :rtype: int
8004
8407
  """
8005
8408
  return self._InstanceType
@@ -8010,7 +8413,7 @@ class InstanceDetail(AbstractModel):
8010
8413
 
8011
8414
  @property
8012
8415
  def InstanceStatusDesc(self):
8013
- r"""实例状态描述
8416
+ r"""实例状态描述。
8014
8417
  :rtype: str
8015
8418
  """
8016
8419
  return self._InstanceStatusDesc
@@ -8021,7 +8424,7 @@ class InstanceDetail(AbstractModel):
8021
8424
 
8022
8425
  @property
8023
8426
  def RealInstanceId(self):
8024
- r"""实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取
8427
+ r"""实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId RealInstanceId,从 barad 获取监控数据等场景下需要用物理 ID 获取。
8025
8428
  :rtype: str
8026
8429
  """
8027
8430
  return self._RealInstanceId
@@ -8043,7 +8446,7 @@ class InstanceDetail(AbstractModel):
8043
8446
 
8044
8447
  @property
8045
8448
  def MongosNodeNum(self):
8046
- r"""mongos节点个数。
8449
+ r"""mongos 节点个数。
8047
8450
  :rtype: int
8048
8451
  """
8049
8452
  return self._MongosNodeNum
@@ -8054,7 +8457,7 @@ class InstanceDetail(AbstractModel):
8054
8457
 
8055
8458
  @property
8056
8459
  def MongosMemory(self):
8057
- r"""mongos节点内存。
8460
+ r"""mongos 节点内存。单位:MB。
8058
8461
  :rtype: int
8059
8462
  """
8060
8463
  return self._MongosMemory
@@ -8065,7 +8468,7 @@ class InstanceDetail(AbstractModel):
8065
8468
 
8066
8469
  @property
8067
8470
  def MongosCpuNum(self):
8068
- r"""mongos节点CPU核数。
8471
+ r"""mongos 节点 CPU 核数。
8069
8472
  :rtype: int
8070
8473
  """
8071
8474
  return self._MongosCpuNum
@@ -8087,7 +8490,7 @@ class InstanceDetail(AbstractModel):
8087
8490
 
8088
8491
  @property
8089
8492
  def ConfigServerMemory(self):
8090
- r"""Config Server节点内存。
8493
+ r"""Config Server节点内存。单位:MB。
8091
8494
  :rtype: int
8092
8495
  """
8093
8496
  return self._ConfigServerMemory
@@ -8098,7 +8501,7 @@ class InstanceDetail(AbstractModel):
8098
8501
 
8099
8502
  @property
8100
8503
  def ConfigServerVolume(self):
8101
- r"""Config Server节点磁盘大小。
8504
+ r"""Config Server节点磁盘大小。单位:MB。
8102
8505
  :rtype: int
8103
8506
  """
8104
8507
  return self._ConfigServerVolume
@@ -8109,7 +8512,7 @@ class InstanceDetail(AbstractModel):
8109
8512
 
8110
8513
  @property
8111
8514
  def ConfigServerCpuNum(self):
8112
- r"""Config Server节点CPU核数。
8515
+ r"""Config Server 节点 CPU 核数。
8113
8516
  :rtype: int
8114
8517
  """
8115
8518
  return self._ConfigServerCpuNum
@@ -8844,14 +9247,14 @@ class IsolateDBInstanceRequest(AbstractModel):
8844
9247
 
8845
9248
  def __init__(self):
8846
9249
  r"""
8847
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
9250
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID
8848
9251
  :type InstanceId: str
8849
9252
  """
8850
9253
  self._InstanceId = None
8851
9254
 
8852
9255
  @property
8853
9256
  def InstanceId(self):
8854
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
9257
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID
8855
9258
  :rtype: str
8856
9259
  """
8857
9260
  return self._InstanceId
@@ -8930,6 +9333,8 @@ class KMSInfoDetail(AbstractModel):
8930
9333
  :param _CreateTime: 实例与密钥绑定时间。
8931
9334
  :type CreateTime: str
8932
9335
  :param _Status: 密钥状态。
9336
+ - Enabled:开启。
9337
+ - Disabled:不开启。
8933
9338
  :type Status: str
8934
9339
  :param _KeyUsage: 密钥用途。
8935
9340
  :type KeyUsage: str
@@ -8982,6 +9387,8 @@ class KMSInfoDetail(AbstractModel):
8982
9387
  @property
8983
9388
  def Status(self):
8984
9389
  r"""密钥状态。
9390
+ - Enabled:开启。
9391
+ - Disabled:不开启。
8985
9392
  :rtype: str
8986
9393
  """
8987
9394
  return self._Status
@@ -9049,9 +9456,9 @@ class KillOpsRequest(AbstractModel):
9049
9456
 
9050
9457
  def __init__(self):
9051
9458
  r"""
9052
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
9459
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
9053
9460
  :type InstanceId: str
9054
- :param _Operations: 待终止的操作
9461
+ :param _Operations: 待终止的操作。
9055
9462
  :type Operations: list of Operation
9056
9463
  """
9057
9464
  self._InstanceId = None
@@ -9059,7 +9466,7 @@ class KillOpsRequest(AbstractModel):
9059
9466
 
9060
9467
  @property
9061
9468
  def InstanceId(self):
9062
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
9469
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
9063
9470
  :rtype: str
9064
9471
  """
9065
9472
  return self._InstanceId
@@ -9070,7 +9477,7 @@ class KillOpsRequest(AbstractModel):
9070
9477
 
9071
9478
  @property
9072
9479
  def Operations(self):
9073
- r"""待终止的操作
9480
+ r"""待终止的操作。
9074
9481
  :rtype: list of Operation
9075
9482
  """
9076
9483
  return self._Operations
@@ -9285,7 +9692,7 @@ class ModifyDBInstanceParamTplRequest(AbstractModel):
9285
9692
 
9286
9693
  def __init__(self):
9287
9694
  r"""
9288
- :param _TplId: 待修改的参数模板 ID,示例:tpl-jglr91vew
9695
+ :param _TplId: 待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
9289
9696
  :type TplId: str
9290
9697
  :param _TplName: 待修改参数模板名称,为空时,保持原有名称。
9291
9698
  :type TplName: str
@@ -9301,7 +9708,7 @@ class ModifyDBInstanceParamTplRequest(AbstractModel):
9301
9708
 
9302
9709
  @property
9303
9710
  def TplId(self):
9304
- r"""待修改的参数模板 ID,示例:tpl-jglr91vew
9711
+ r"""待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID
9305
9712
  :rtype: str
9306
9713
  """
9307
9714
  return self._TplId
@@ -9480,12 +9887,12 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9480
9887
 
9481
9888
  def __init__(self):
9482
9889
  r"""
9483
- :param _InstanceId: 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
9484
-
9890
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
9485
9891
  :type InstanceId: str
9486
- :param _Memory: 实例配置变更后的内存大小。- 单位:GB。为空时,默认取实例当前的内存大小。<br> 注意:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
9892
+ :param _Memory: 实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
9893
+ **注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
9487
9894
  :type Memory: int
9488
- :param _Volume: 实例配置变更后的硬盘大小,单位:GB。为空时,默认取当前实例的磁盘大小。
9895
+ :param _Volume: 实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
9489
9896
  - 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
9490
9897
  - 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。
9491
9898
  :type Volume: int
@@ -9495,26 +9902,26 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9495
9902
  - 单位:GB。
9496
9903
  - 默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。
9497
9904
  :type OplogSize: int
9498
- :param _NodeNum: 实例变更后mongod的节点数(不包含readonly节点数)。
9499
- - 变更mongod CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。
9500
- - 变更 mongos CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。
9501
- - 节点变更时(全部类型),该参数可不配置或输入变更后的 mongod(不包含readonly) 节点数量。
9502
- - 副本集节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。
9503
- - 分片集群每个分片节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。
9905
+ :param _NodeNum: 实例变更后 mongod 的节点数(不包含 readonly 只读节点数)。
9906
+ - 副本集节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。
9907
+ - 分片集群每个分片节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。
9908
+ **说明**:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。
9504
9909
  :type NodeNum: int
9505
9910
  :param _ReplicateSetNum: 实例变更后的分片数。
9506
- - 取值范围请通过云数据库的售卖规格[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取。- 该参数只能增加不能减少。
9911
+ - 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。
9912
+ - 实例分片数量只允许增加不允许减少。
9507
9913
  :type ReplicateSetNum: int
9508
9914
  :param _InMaintenance: 实例配置变更的切换时间。
9509
9915
  - 0:调整完成时,立即执行变配任务。默认为0。
9510
9916
  - 1:在维护时间窗内,执行变配任务。
9511
9917
  **说明**:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。
9512
9918
  :type InMaintenance: int
9513
- :param _MongosMemory: 分片实例配置变更后的mongos内存大小。单位:GB。
9919
+ :param _MongosMemory: 分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)
9514
9920
  :type MongosMemory: str
9515
9921
  :param _AddNodeList: 新增节点列表,节点类型及可用区信息。
9516
9922
  :type AddNodeList: list of AddNodeList
9517
- :param _RemoveNodeList: 删除节点列表,注意:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
9923
+ :param _RemoveNodeList: 删除节点列表。
9924
+ **注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
9518
9925
  :type RemoveNodeList: list of RemoveNodeList
9519
9926
  """
9520
9927
  self._InstanceId = None
@@ -9530,8 +9937,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9530
9937
 
9531
9938
  @property
9532
9939
  def InstanceId(self):
9533
- r"""实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
9534
-
9940
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
9535
9941
  :rtype: str
9536
9942
  """
9537
9943
  return self._InstanceId
@@ -9542,7 +9948,8 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9542
9948
 
9543
9949
  @property
9544
9950
  def Memory(self):
9545
- r"""实例配置变更后的内存大小。- 单位:GB。为空时,默认取实例当前的内存大小。<br> 注意:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
9951
+ r"""实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
9952
+ **注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
9546
9953
  :rtype: int
9547
9954
  """
9548
9955
  return self._Memory
@@ -9553,7 +9960,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9553
9960
 
9554
9961
  @property
9555
9962
  def Volume(self):
9556
- r"""实例配置变更后的硬盘大小,单位:GB。为空时,默认取当前实例的磁盘大小。
9963
+ r"""实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。
9557
9964
  - 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
9558
9965
  - 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。
9559
9966
  :rtype: int
@@ -9585,12 +9992,10 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9585
9992
 
9586
9993
  @property
9587
9994
  def NodeNum(self):
9588
- r"""实例变更后mongod的节点数(不包含readonly节点数)。
9589
- - 变更mongod CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。
9590
- - 变更 mongos CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。
9591
- - 节点变更时(全部类型),该参数可不配置或输入变更后的 mongod(不包含readonly) 节点数量。
9592
- - 副本集节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。
9593
- - 分片集群每个分片节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。
9995
+ r"""实例变更后 mongod 的节点数(不包含 readonly 只读节点数)。
9996
+ - 副本集节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。
9997
+ - 分片集群每个分片节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。
9998
+ **说明**:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。
9594
9999
  :rtype: int
9595
10000
  """
9596
10001
  return self._NodeNum
@@ -9602,7 +10007,8 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9602
10007
  @property
9603
10008
  def ReplicateSetNum(self):
9604
10009
  r"""实例变更后的分片数。
9605
- - 取值范围请通过云数据库的售卖规格[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取。- 该参数只能增加不能减少。
10010
+ - 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。
10011
+ - 实例分片数量只允许增加不允许减少。
9606
10012
  :rtype: int
9607
10013
  """
9608
10014
  return self._ReplicateSetNum
@@ -9627,7 +10033,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9627
10033
 
9628
10034
  @property
9629
10035
  def MongosMemory(self):
9630
- r"""分片实例配置变更后的mongos内存大小。单位:GB。
10036
+ r"""分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)
9631
10037
  :rtype: str
9632
10038
  """
9633
10039
  return self._MongosMemory
@@ -9649,7 +10055,8 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
9649
10055
 
9650
10056
  @property
9651
10057
  def RemoveNodeList(self):
9652
- r"""删除节点列表,注意:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
10058
+ r"""删除节点列表。
10059
+ **注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。
9653
10060
  :rtype: list of RemoveNodeList
9654
10061
  """
9655
10062
  return self._RemoveNodeList
@@ -9991,21 +10398,38 @@ class NodeProperty(AbstractModel):
9991
10398
  :type Address: str
9992
10399
  :param _WanServiceAddress: 节点公网访问外网地址(IP或域名,示例为IP方式)。
9993
10400
  :type WanServiceAddress: str
9994
- :param _Role: 角色。
10401
+ :param _Role: 节点角色。
10402
+ - PRIMARY:主节点。
10403
+ - SECONDARY:从节点。
10404
+ - READONLY:只读节点。
10405
+ - ARBITER:仲裁节点。
9995
10406
  :type Role: str
9996
- :param _Hidden: 是否为Hidden节点
10407
+ :param _Hidden: 节点是否为 Hidden 节点。
10408
+ - true:Hidden 节点。
10409
+ - false:非 Hidden 节点。
9997
10410
  :type Hidden: bool
9998
- :param _Status: 节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
10411
+ :param _Status: 节点状态。
10412
+ - NORMAL:正常运行中。
10413
+ - STARTUP:正在启动。
10414
+ - STARTUP2:正在启动,处理中间数据。
10415
+ - RECOVERING:恢复中,暂不可用。
10416
+ - DOWN:已掉线。
10417
+ - UNKNOWN:未知状态。
10418
+ - ROLLBACK:回滚中。
10419
+ - REMOVED:已移除。
9999
10420
  :type Status: str
10000
- :param _SlaveDelay: 主从延迟,单位秒。
10421
+ :param _SlaveDelay: 主从同步延迟时间,单位:秒。
10001
10422
  :type SlaveDelay: int
10002
- :param _Priority: 节点优先级。
10423
+ :param _Priority: 节点优先级。其取值范围为[0,100],数值越高,优先级越高。
10003
10424
  :type Priority: int
10004
10425
  :param _Votes: 节点投票权。
10426
+ - 1:具有投票权。
10427
+ - 0:无投票权。
10005
10428
  :type Votes: int
10006
10429
  :param _Tags: 节点标签。
10430
+ 注意:此字段可能返回 null,表示取不到有效值。
10007
10431
  :type Tags: list of NodeTag
10008
- :param _ReplicateSetId: 副本集Id
10432
+ :param _ReplicateSetId: 副本集 ID
10009
10433
  :type ReplicateSetId: str
10010
10434
  """
10011
10435
  self._Zone = None
@@ -10067,7 +10491,11 @@ class NodeProperty(AbstractModel):
10067
10491
 
10068
10492
  @property
10069
10493
  def Role(self):
10070
- r"""角色。
10494
+ r"""节点角色。
10495
+ - PRIMARY:主节点。
10496
+ - SECONDARY:从节点。
10497
+ - READONLY:只读节点。
10498
+ - ARBITER:仲裁节点。
10071
10499
  :rtype: str
10072
10500
  """
10073
10501
  return self._Role
@@ -10078,7 +10506,9 @@ class NodeProperty(AbstractModel):
10078
10506
 
10079
10507
  @property
10080
10508
  def Hidden(self):
10081
- r"""是否为Hidden节点
10509
+ r"""节点是否为 Hidden 节点。
10510
+ - true:Hidden 节点。
10511
+ - false:非 Hidden 节点。
10082
10512
  :rtype: bool
10083
10513
  """
10084
10514
  return self._Hidden
@@ -10089,7 +10519,15 @@ class NodeProperty(AbstractModel):
10089
10519
 
10090
10520
  @property
10091
10521
  def Status(self):
10092
- r"""节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
10522
+ r"""节点状态。
10523
+ - NORMAL:正常运行中。
10524
+ - STARTUP:正在启动。
10525
+ - STARTUP2:正在启动,处理中间数据。
10526
+ - RECOVERING:恢复中,暂不可用。
10527
+ - DOWN:已掉线。
10528
+ - UNKNOWN:未知状态。
10529
+ - ROLLBACK:回滚中。
10530
+ - REMOVED:已移除。
10093
10531
  :rtype: str
10094
10532
  """
10095
10533
  return self._Status
@@ -10100,7 +10538,7 @@ class NodeProperty(AbstractModel):
10100
10538
 
10101
10539
  @property
10102
10540
  def SlaveDelay(self):
10103
- r"""主从延迟,单位秒。
10541
+ r"""主从同步延迟时间,单位:秒。
10104
10542
  :rtype: int
10105
10543
  """
10106
10544
  return self._SlaveDelay
@@ -10111,7 +10549,7 @@ class NodeProperty(AbstractModel):
10111
10549
 
10112
10550
  @property
10113
10551
  def Priority(self):
10114
- r"""节点优先级。
10552
+ r"""节点优先级。其取值范围为[0,100],数值越高,优先级越高。
10115
10553
  :rtype: int
10116
10554
  """
10117
10555
  return self._Priority
@@ -10123,6 +10561,8 @@ class NodeProperty(AbstractModel):
10123
10561
  @property
10124
10562
  def Votes(self):
10125
10563
  r"""节点投票权。
10564
+ - 1:具有投票权。
10565
+ - 0:无投票权。
10126
10566
  :rtype: int
10127
10567
  """
10128
10568
  return self._Votes
@@ -10134,6 +10574,7 @@ class NodeProperty(AbstractModel):
10134
10574
  @property
10135
10575
  def Tags(self):
10136
10576
  r"""节点标签。
10577
+ 注意:此字段可能返回 null,表示取不到有效值。
10137
10578
  :rtype: list of NodeTag
10138
10579
  """
10139
10580
  return self._Tags
@@ -10144,7 +10585,7 @@ class NodeProperty(AbstractModel):
10144
10585
 
10145
10586
  @property
10146
10587
  def ReplicateSetId(self):
10147
- r"""副本集Id
10588
+ r"""副本集 ID
10148
10589
  :rtype: str
10149
10590
  """
10150
10591
  return self._ReplicateSetId
@@ -10240,14 +10681,14 @@ class OfflineIsolatedDBInstanceRequest(AbstractModel):
10240
10681
 
10241
10682
  def __init__(self):
10242
10683
  r"""
10243
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
10684
+ :param _InstanceId: 实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID
10244
10685
  :type InstanceId: str
10245
10686
  """
10246
10687
  self._InstanceId = None
10247
10688
 
10248
10689
  @property
10249
10690
  def InstanceId(self):
10250
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
10691
+ r"""实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID
10251
10692
  :rtype: str
10252
10693
  """
10253
10694
  return self._InstanceId
@@ -10313,17 +10754,17 @@ class OfflineIsolatedDBInstanceResponse(AbstractModel):
10313
10754
 
10314
10755
 
10315
10756
  class Operation(AbstractModel):
10316
- r"""需要终止的操作
10757
+ r"""需要终止的操作。
10317
10758
 
10318
10759
  """
10319
10760
 
10320
10761
  def __init__(self):
10321
10762
  r"""
10322
- :param _ReplicaSetName: 操作所在的分片名
10763
+ :param _ReplicaSetName: 操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。
10323
10764
  :type ReplicaSetName: str
10324
- :param _NodeName: 操作所在的节点名
10765
+ :param _NodeName: 操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。
10325
10766
  :type NodeName: str
10326
- :param _OpId: 操作序号
10767
+ :param _OpId: 操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。
10327
10768
  :type OpId: int
10328
10769
  """
10329
10770
  self._ReplicaSetName = None
@@ -10332,7 +10773,7 @@ class Operation(AbstractModel):
10332
10773
 
10333
10774
  @property
10334
10775
  def ReplicaSetName(self):
10335
- r"""操作所在的分片名
10776
+ r"""操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。
10336
10777
  :rtype: str
10337
10778
  """
10338
10779
  return self._ReplicaSetName
@@ -10343,7 +10784,7 @@ class Operation(AbstractModel):
10343
10784
 
10344
10785
  @property
10345
10786
  def NodeName(self):
10346
- r"""操作所在的节点名
10787
+ r"""操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。
10347
10788
  :rtype: str
10348
10789
  """
10349
10790
  return self._NodeName
@@ -10354,7 +10795,7 @@ class Operation(AbstractModel):
10354
10795
 
10355
10796
  @property
10356
10797
  def OpId(self):
10357
- r"""操作序号
10798
+ r"""操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。
10358
10799
  :rtype: int
10359
10800
  """
10360
10801
  return self._OpId
@@ -10385,17 +10826,29 @@ class ParamTpl(AbstractModel):
10385
10826
 
10386
10827
  def __init__(self):
10387
10828
  r"""
10388
- :param _TplName: 参数模板名称
10829
+ :param _TplName: 参数模板名称。
10389
10830
  :type TplName: str
10390
- :param _TplId: 参数模板ID
10831
+ :param _TplId: 参数模板 ID
10391
10832
  :type TplId: str
10392
- :param _MongoVersion: 适用数据库版本
10833
+ :param _MongoVersion: 参数模板适用的数据库版本。
10834
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
10835
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
10836
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
10837
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
10838
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
10839
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
10840
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
10393
10841
  :type MongoVersion: str
10394
- :param _ClusterType: 适用数据库类型
10842
+ :param _ClusterType: 参数模板适用的数据库类型。
10843
+ - REPLSET:副本集实例。
10844
+ - SHARD:分片实例。
10845
+ - STANDALONE:单节点实例。
10395
10846
  :type ClusterType: str
10396
- :param _TplDesc: 参数模板描述
10847
+ :param _TplDesc: 参数模板描述。
10397
10848
  :type TplDesc: str
10398
- :param _TplType: 模板类型,包括DEFAULT(默认模板)及CUSTOMIZE(定制模板)两种类型
10849
+ :param _TplType: 模板类型。
10850
+ - DEFAULT:系统默认模板。
10851
+ - CUSTOMIZE:自定义模板。
10399
10852
  :type TplType: str
10400
10853
  """
10401
10854
  self._TplName = None
@@ -10407,7 +10860,7 @@ class ParamTpl(AbstractModel):
10407
10860
 
10408
10861
  @property
10409
10862
  def TplName(self):
10410
- r"""参数模板名称
10863
+ r"""参数模板名称。
10411
10864
  :rtype: str
10412
10865
  """
10413
10866
  return self._TplName
@@ -10418,7 +10871,7 @@ class ParamTpl(AbstractModel):
10418
10871
 
10419
10872
  @property
10420
10873
  def TplId(self):
10421
- r"""参数模板ID
10874
+ r"""参数模板 ID
10422
10875
  :rtype: str
10423
10876
  """
10424
10877
  return self._TplId
@@ -10429,7 +10882,14 @@ class ParamTpl(AbstractModel):
10429
10882
 
10430
10883
  @property
10431
10884
  def MongoVersion(self):
10432
- r"""适用数据库版本
10885
+ r"""参数模板适用的数据库版本。
10886
+ - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,
10887
+ - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,
10888
+ - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
10889
+ - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
10890
+ - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
10891
+ - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
10892
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
10433
10893
  :rtype: str
10434
10894
  """
10435
10895
  return self._MongoVersion
@@ -10440,7 +10900,10 @@ class ParamTpl(AbstractModel):
10440
10900
 
10441
10901
  @property
10442
10902
  def ClusterType(self):
10443
- r"""适用数据库类型
10903
+ r"""参数模板适用的数据库类型。
10904
+ - REPLSET:副本集实例。
10905
+ - SHARD:分片实例。
10906
+ - STANDALONE:单节点实例。
10444
10907
  :rtype: str
10445
10908
  """
10446
10909
  return self._ClusterType
@@ -10451,7 +10914,7 @@ class ParamTpl(AbstractModel):
10451
10914
 
10452
10915
  @property
10453
10916
  def TplDesc(self):
10454
- r"""参数模板描述
10917
+ r"""参数模板描述。
10455
10918
  :rtype: str
10456
10919
  """
10457
10920
  return self._TplDesc
@@ -10462,7 +10925,9 @@ class ParamTpl(AbstractModel):
10462
10925
 
10463
10926
  @property
10464
10927
  def TplType(self):
10465
- r"""模板类型,包括DEFAULT(默认模板)及CUSTOMIZE(定制模板)两种类型
10928
+ r"""模板类型。
10929
+ - DEFAULT:系统默认模板。
10930
+ - CUSTOMIZE:自定义模板。
10466
10931
  :rtype: str
10467
10932
  """
10468
10933
  return self._TplType
@@ -10541,7 +11006,7 @@ class ParamType(AbstractModel):
10541
11006
 
10542
11007
 
10543
11008
  class RemoveNodeList(AbstractModel):
10544
- r"""修改实例节点详情
11009
+ r"""修改实例节点详情。
10545
11010
 
10546
11011
  """
10547
11012
 
@@ -10552,12 +11017,11 @@ class RemoveNodeList(AbstractModel):
10552
11017
  - READONLY:只读节点。
10553
11018
  - MONGOS:Mongos 节点。
10554
11019
  :type Role: str
10555
- :param _NodeName: 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对改组对齐。
10556
-
10557
- - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/),在**节点管理**页签,可获取**节点 ID**。
10558
- - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk****_0-node-primary。
11020
+ :param _NodeName: 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对该组对齐。
11021
+ - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/mongodb),在**节点管理**页签,可获取**节点 ID**。
11022
+ - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk\*\*\*\*\_0-node-primary。
10559
11023
  :type NodeName: str
10560
- :param _Zone: 节点所对应的可用区。
11024
+ :param _Zone: 节点所对应的可用区。当前支持可用区信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
10561
11025
  - 单可用区,所有节点在同一可用区。
10562
11026
  - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。
10563
11027
  :type Zone: str
@@ -10582,10 +11046,9 @@ class RemoveNodeList(AbstractModel):
10582
11046
 
10583
11047
  @property
10584
11048
  def NodeName(self):
10585
- r"""要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对改组对齐。
10586
-
10587
- - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/),在**节点管理**页签,可获取**节点 ID**。
10588
- - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk****_0-node-primary。
11049
+ r"""要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对该组对齐。
11050
+ - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/mongodb),在**节点管理**页签,可获取**节点 ID**。
11051
+ - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk\*\*\*\*\_0-node-primary。
10589
11052
  :rtype: str
10590
11053
  """
10591
11054
  return self._NodeName
@@ -10596,7 +11059,7 @@ class RemoveNodeList(AbstractModel):
10596
11059
 
10597
11060
  @property
10598
11061
  def Zone(self):
10599
- r"""节点所对应的可用区。
11062
+ r"""节点所对应的可用区。当前支持可用区信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。
10600
11063
  - 单可用区,所有节点在同一可用区。
10601
11064
  - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。
10602
11065
  :rtype: str
@@ -10709,7 +11172,7 @@ class RenewDBInstancesRequest(AbstractModel):
10709
11172
  def __init__(self):
10710
11173
  r"""
10711
11174
  :param _InstanceIds: 指定续费的一个或多个待操作的实例ID。
10712
- - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceIds**获取。
11175
+ - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。
10713
11176
  - 每次续费请求的实例数量上限为100。
10714
11177
  :type InstanceIds: list of str
10715
11178
  :param _InstanceChargePrepaid: 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。
@@ -10721,7 +11184,7 @@ class RenewDBInstancesRequest(AbstractModel):
10721
11184
  @property
10722
11185
  def InstanceIds(self):
10723
11186
  r"""指定续费的一个或多个待操作的实例ID。
10724
- - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceIds**获取。
11187
+ - 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。
10725
11188
  - 每次续费请求的实例数量上限为100。
10726
11189
  :rtype: list of str
10727
11190
  """
@@ -10787,20 +11250,20 @@ class RenewDBInstancesResponse(AbstractModel):
10787
11250
 
10788
11251
 
10789
11252
  class ReplicaSetInfo(AbstractModel):
10790
- r"""分片信息
11253
+ r"""分片信息。
10791
11254
 
10792
11255
  """
10793
11256
 
10794
11257
  def __init__(self):
10795
11258
  r"""
10796
- :param _ReplicaSetId: 副本集ID
11259
+ :param _ReplicaSetId: 副本集 ID
10797
11260
  :type ReplicaSetId: str
10798
11261
  """
10799
11262
  self._ReplicaSetId = None
10800
11263
 
10801
11264
  @property
10802
11265
  def ReplicaSetId(self):
10803
- r"""副本集ID
11266
+ r"""副本集 ID
10804
11267
  :rtype: str
10805
11268
  """
10806
11269
  return self._ReplicaSetId
@@ -10983,9 +11446,11 @@ class RestartNodesRequest(AbstractModel):
10983
11446
 
10984
11447
  def __init__(self):
10985
11448
  r"""
10986
- :param _InstanceId: 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
11449
+ :param _InstanceId: 实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
10987
11450
  :type InstanceId: str
10988
- :param _NodeIds: 节点Id。
11451
+ :param _NodeIds: 需要重启的节点 ID 列表。
11452
+ - 支持重启的节点类型包含:mongod节点、只读节点、mongos节点。
11453
+ - 节点 ID,请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在**节点管理**页面复制,或者通过 [DescribeDBInstanceNodeProperty ](https://cloud.tencent.com/document/product/240/82022)接口获取。
10989
11454
  :type NodeIds: list of str
10990
11455
  """
10991
11456
  self._InstanceId = None
@@ -10993,7 +11458,7 @@ class RestartNodesRequest(AbstractModel):
10993
11458
 
10994
11459
  @property
10995
11460
  def InstanceId(self):
10996
- r"""实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
11461
+ r"""实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID
10997
11462
  :rtype: str
10998
11463
  """
10999
11464
  return self._InstanceId
@@ -11004,7 +11469,9 @@ class RestartNodesRequest(AbstractModel):
11004
11469
 
11005
11470
  @property
11006
11471
  def NodeIds(self):
11007
- r"""节点Id。
11472
+ r"""需要重启的节点 ID 列表。
11473
+ - 支持重启的节点类型包含:mongod节点、只读节点、mongos节点。
11474
+ - 节点 ID,请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在**节点管理**页面复制,或者通过 [DescribeDBInstanceNodeProperty ](https://cloud.tencent.com/document/product/240/82022)接口获取。
11008
11475
  :rtype: list of str
11009
11476
  """
11010
11477
  return self._NodeIds
@@ -11034,7 +11501,7 @@ class RestartNodesResponse(AbstractModel):
11034
11501
 
11035
11502
  def __init__(self):
11036
11503
  r"""
11037
- :param _FlowId: 流程Id
11504
+ :param _FlowId: 流程 ID
11038
11505
  :type FlowId: int
11039
11506
  :param _RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
11040
11507
  :type RequestId: str
@@ -11044,7 +11511,7 @@ class RestartNodesResponse(AbstractModel):
11044
11511
 
11045
11512
  @property
11046
11513
  def FlowId(self):
11047
- r"""流程Id
11514
+ r"""流程 ID
11048
11515
  :rtype: int
11049
11516
  """
11050
11517
  return self._FlowId
@@ -11077,19 +11544,19 @@ class SecurityGroup(AbstractModel):
11077
11544
 
11078
11545
  def __init__(self):
11079
11546
  r"""
11080
- :param _ProjectId: 所属项目id
11547
+ :param _ProjectId: 所属项目 ID。
11081
11548
  :type ProjectId: int
11082
- :param _CreateTime: 创建时间
11549
+ :param _CreateTime: 安全组创建时间。
11083
11550
  :type CreateTime: str
11084
- :param _Inbound: 入站规则
11551
+ :param _Inbound: 安全组入站规则。
11085
11552
  :type Inbound: list of SecurityGroupBound
11086
- :param _Outbound: 出站规则
11553
+ :param _Outbound: 安全组出站规则。
11087
11554
  :type Outbound: list of SecurityGroupBound
11088
- :param _SecurityGroupId: 安全组id
11555
+ :param _SecurityGroupId: 安全组 ID。
11089
11556
  :type SecurityGroupId: str
11090
- :param _SecurityGroupName: 安全组名称
11557
+ :param _SecurityGroupName: 安全组名称。
11091
11558
  :type SecurityGroupName: str
11092
- :param _SecurityGroupRemark: 安全组备注
11559
+ :param _SecurityGroupRemark: 安全组备注信息。
11093
11560
  :type SecurityGroupRemark: str
11094
11561
  """
11095
11562
  self._ProjectId = None
@@ -11102,7 +11569,7 @@ class SecurityGroup(AbstractModel):
11102
11569
 
11103
11570
  @property
11104
11571
  def ProjectId(self):
11105
- r"""所属项目id
11572
+ r"""所属项目 ID。
11106
11573
  :rtype: int
11107
11574
  """
11108
11575
  return self._ProjectId
@@ -11113,7 +11580,7 @@ class SecurityGroup(AbstractModel):
11113
11580
 
11114
11581
  @property
11115
11582
  def CreateTime(self):
11116
- r"""创建时间
11583
+ r"""安全组创建时间。
11117
11584
  :rtype: str
11118
11585
  """
11119
11586
  return self._CreateTime
@@ -11124,7 +11591,7 @@ class SecurityGroup(AbstractModel):
11124
11591
 
11125
11592
  @property
11126
11593
  def Inbound(self):
11127
- r"""入站规则
11594
+ r"""安全组入站规则。
11128
11595
  :rtype: list of SecurityGroupBound
11129
11596
  """
11130
11597
  return self._Inbound
@@ -11135,7 +11602,7 @@ class SecurityGroup(AbstractModel):
11135
11602
 
11136
11603
  @property
11137
11604
  def Outbound(self):
11138
- r"""出站规则
11605
+ r"""安全组出站规则。
11139
11606
  :rtype: list of SecurityGroupBound
11140
11607
  """
11141
11608
  return self._Outbound
@@ -11146,7 +11613,7 @@ class SecurityGroup(AbstractModel):
11146
11613
 
11147
11614
  @property
11148
11615
  def SecurityGroupId(self):
11149
- r"""安全组id
11616
+ r"""安全组 ID。
11150
11617
  :rtype: str
11151
11618
  """
11152
11619
  return self._SecurityGroupId
@@ -11157,7 +11624,7 @@ class SecurityGroup(AbstractModel):
11157
11624
 
11158
11625
  @property
11159
11626
  def SecurityGroupName(self):
11160
- r"""安全组名称
11627
+ r"""安全组名称。
11161
11628
  :rtype: str
11162
11629
  """
11163
11630
  return self._SecurityGroupName
@@ -11168,7 +11635,7 @@ class SecurityGroup(AbstractModel):
11168
11635
 
11169
11636
  @property
11170
11637
  def SecurityGroupRemark(self):
11171
- r"""安全组备注
11638
+ r"""安全组备注信息。
11172
11639
  :rtype: str
11173
11640
  """
11174
11641
  return self._SecurityGroupRemark
@@ -11213,21 +11680,23 @@ class SecurityGroupBound(AbstractModel):
11213
11680
 
11214
11681
  def __init__(self):
11215
11682
  r"""
11216
- :param _Action: 执行规则。ACCEPT或DROP
11683
+ :param _Action: 执行策略。
11684
+ - ACCEPT:允许,放行该端口相应的访问请求。
11685
+ - DROP:拒绝,直接丢弃数据包,不返回任何回应信息。
11217
11686
  :type Action: str
11218
- :param _CidrIp: ip段。
11687
+ :param _CidrIp: 访问数据库的入站 IP 或 IP 段。
11219
11688
  :type CidrIp: str
11220
- :param _PortRange: 端口范围
11689
+ :param _PortRange: 访问数据库的端口。
11221
11690
  :type PortRange: str
11222
- :param _IpProtocol: 传输层协议。tcp,udp或ALL
11691
+ :param _IpProtocol: 传输层协议:tcp
11223
11692
  :type IpProtocol: str
11224
- :param _Id: 安全组id代表的地址集合
11693
+ :param _Id: 安全组 ID。
11225
11694
  :type Id: str
11226
- :param _AddressModule: 地址组id代表的地址集合
11695
+ :param _AddressModule: IP 地址或 IP 地址组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/ip)获取参数模板 IP 地址详情。
11227
11696
  :type AddressModule: str
11228
- :param _ServiceModule: 服务组id代表的协议和端口集合
11697
+ :param _ServiceModule: 协议端口或协议端口组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/protoport)获取参数模板协议端口详情。
11229
11698
  :type ServiceModule: str
11230
- :param _Desc: 描述
11699
+ :param _Desc: 安全组描述信息。
11231
11700
  :type Desc: str
11232
11701
  """
11233
11702
  self._Action = None
@@ -11241,7 +11710,9 @@ class SecurityGroupBound(AbstractModel):
11241
11710
 
11242
11711
  @property
11243
11712
  def Action(self):
11244
- r"""执行规则。ACCEPT或DROP
11713
+ r"""执行策略。
11714
+ - ACCEPT:允许,放行该端口相应的访问请求。
11715
+ - DROP:拒绝,直接丢弃数据包,不返回任何回应信息。
11245
11716
  :rtype: str
11246
11717
  """
11247
11718
  return self._Action
@@ -11252,7 +11723,7 @@ class SecurityGroupBound(AbstractModel):
11252
11723
 
11253
11724
  @property
11254
11725
  def CidrIp(self):
11255
- r"""ip段。
11726
+ r"""访问数据库的入站 IP 或 IP 段。
11256
11727
  :rtype: str
11257
11728
  """
11258
11729
  return self._CidrIp
@@ -11263,7 +11734,7 @@ class SecurityGroupBound(AbstractModel):
11263
11734
 
11264
11735
  @property
11265
11736
  def PortRange(self):
11266
- r"""端口范围
11737
+ r"""访问数据库的端口。
11267
11738
  :rtype: str
11268
11739
  """
11269
11740
  return self._PortRange
@@ -11274,7 +11745,7 @@ class SecurityGroupBound(AbstractModel):
11274
11745
 
11275
11746
  @property
11276
11747
  def IpProtocol(self):
11277
- r"""传输层协议。tcp,udp或ALL
11748
+ r"""传输层协议:tcp
11278
11749
  :rtype: str
11279
11750
  """
11280
11751
  return self._IpProtocol
@@ -11285,7 +11756,7 @@ class SecurityGroupBound(AbstractModel):
11285
11756
 
11286
11757
  @property
11287
11758
  def Id(self):
11288
- r"""安全组id代表的地址集合
11759
+ r"""安全组 ID。
11289
11760
  :rtype: str
11290
11761
  """
11291
11762
  return self._Id
@@ -11296,7 +11767,7 @@ class SecurityGroupBound(AbstractModel):
11296
11767
 
11297
11768
  @property
11298
11769
  def AddressModule(self):
11299
- r"""地址组id代表的地址集合
11770
+ r"""IP 地址或 IP 地址组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/ip)获取参数模板 IP 地址详情。
11300
11771
  :rtype: str
11301
11772
  """
11302
11773
  return self._AddressModule
@@ -11307,7 +11778,7 @@ class SecurityGroupBound(AbstractModel):
11307
11778
 
11308
11779
  @property
11309
11780
  def ServiceModule(self):
11310
- r"""服务组id代表的协议和端口集合
11781
+ r"""协议端口或协议端口组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/protoport)获取参数模板协议端口详情。
11311
11782
  :rtype: str
11312
11783
  """
11313
11784
  return self._ServiceModule
@@ -11318,7 +11789,7 @@ class SecurityGroupBound(AbstractModel):
11318
11789
 
11319
11790
  @property
11320
11791
  def Desc(self):
11321
- r"""描述
11792
+ r"""安全组描述信息。
11322
11793
  :rtype: str
11323
11794
  """
11324
11795
  return self._Desc
@@ -11470,7 +11941,13 @@ class SetBackupRulesRequest(AbstractModel):
11470
11941
  r"""
11471
11942
  :param _InstanceId: 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
11472
11943
  :type InstanceId: str
11473
- :param _BackupMethod: 设置自动备份方式。- 0:逻辑备份。- 1:物理备份。-3:快照备份(仅云盘版支持)。
11944
+ :param _BackupMethod: 备份方式。
11945
+ - 0:逻辑备份。
11946
+ - 1:物理备份。
11947
+ - 3:快照备份。
11948
+ **说明**:
11949
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
11950
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
11474
11951
  :type BackupMethod: int
11475
11952
  :param _BackupTime: 设置自动备份开始时间。取值范围为:[0,23],例如:该参数设置为2,表示02:00开始备份。
11476
11953
  :type BackupTime: int
@@ -11500,7 +11977,13 @@ class SetBackupRulesRequest(AbstractModel):
11500
11977
 
11501
11978
  @property
11502
11979
  def BackupMethod(self):
11503
- r"""设置自动备份方式。- 0:逻辑备份。- 1:物理备份。-3:快照备份(仅云盘版支持)。
11980
+ r"""备份方式。
11981
+ - 0:逻辑备份。
11982
+ - 1:物理备份。
11983
+ - 3:快照备份。
11984
+ **说明**:
11985
+ 1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。
11986
+ 2. 实例开通存储加密,则备份方式不能为物理备份。
11504
11987
  :rtype: int
11505
11988
  """
11506
11989
  return self._BackupMethod
@@ -11916,11 +12399,11 @@ class SlowLogItem(AbstractModel):
11916
12399
 
11917
12400
  def __init__(self):
11918
12401
  r"""
11919
- :param _Log: 慢日志
12402
+ :param _Log: 慢日志详情。
11920
12403
  :type Log: str
11921
- :param _NodeName: 节点名称
12404
+ :param _NodeName: 节点名称。
11922
12405
  :type NodeName: str
11923
- :param _QueryHash: queryHash
12406
+ :param _QueryHash: 查询哈希值。
11924
12407
  :type QueryHash: str
11925
12408
  """
11926
12409
  self._Log = None
@@ -11929,7 +12412,7 @@ class SlowLogItem(AbstractModel):
11929
12412
 
11930
12413
  @property
11931
12414
  def Log(self):
11932
- r"""慢日志
12415
+ r"""慢日志详情。
11933
12416
  :rtype: str
11934
12417
  """
11935
12418
  return self._Log
@@ -11940,7 +12423,7 @@ class SlowLogItem(AbstractModel):
11940
12423
 
11941
12424
  @property
11942
12425
  def NodeName(self):
11943
- r"""节点名称
12426
+ r"""节点名称。
11944
12427
  :rtype: str
11945
12428
  """
11946
12429
  return self._NodeName
@@ -11951,7 +12434,7 @@ class SlowLogItem(AbstractModel):
11951
12434
 
11952
12435
  @property
11953
12436
  def QueryHash(self):
11954
- r"""queryHash
12437
+ r"""查询哈希值。
11955
12438
  :rtype: str
11956
12439
  """
11957
12440
  return self._QueryHash
@@ -11982,15 +12465,15 @@ class SlowLogPattern(AbstractModel):
11982
12465
 
11983
12466
  def __init__(self):
11984
12467
  r"""
11985
- :param _Pattern: 慢日志模式
12468
+ :param _Pattern: 慢日志输出格式:库名.表名.命令。
11986
12469
  :type Pattern: str
11987
- :param _QueryHash: queryHash
12470
+ :param _QueryHash: 记录慢日志时所带的queryHash 值,标识一类查询。
11988
12471
  :type QueryHash: str
11989
- :param _MaxTime: 最大执行时间
12472
+ :param _MaxTime: 最大执行时间。单位:毫秒。
11990
12473
  :type MaxTime: int
11991
- :param _AverageTime: 平均执行时间
12474
+ :param _AverageTime: 平均执行时间。单位:毫秒。
11992
12475
  :type AverageTime: int
11993
- :param _Total: 该模式慢日志条数
12476
+ :param _Total: 慢日志条数。
11994
12477
  :type Total: int
11995
12478
  """
11996
12479
  self._Pattern = None
@@ -12001,7 +12484,7 @@ class SlowLogPattern(AbstractModel):
12001
12484
 
12002
12485
  @property
12003
12486
  def Pattern(self):
12004
- r"""慢日志模式
12487
+ r"""慢日志输出格式:库名.表名.命令。
12005
12488
  :rtype: str
12006
12489
  """
12007
12490
  return self._Pattern
@@ -12012,7 +12495,7 @@ class SlowLogPattern(AbstractModel):
12012
12495
 
12013
12496
  @property
12014
12497
  def QueryHash(self):
12015
- r"""queryHash
12498
+ r"""记录慢日志时所带的queryHash 值,标识一类查询。
12016
12499
  :rtype: str
12017
12500
  """
12018
12501
  return self._QueryHash
@@ -12023,7 +12506,7 @@ class SlowLogPattern(AbstractModel):
12023
12506
 
12024
12507
  @property
12025
12508
  def MaxTime(self):
12026
- r"""最大执行时间
12509
+ r"""最大执行时间。单位:毫秒。
12027
12510
  :rtype: int
12028
12511
  """
12029
12512
  return self._MaxTime
@@ -12034,7 +12517,7 @@ class SlowLogPattern(AbstractModel):
12034
12517
 
12035
12518
  @property
12036
12519
  def AverageTime(self):
12037
- r"""平均执行时间
12520
+ r"""平均执行时间。单位:毫秒。
12038
12521
  :rtype: int
12039
12522
  """
12040
12523
  return self._AverageTime
@@ -12045,7 +12528,7 @@ class SlowLogPattern(AbstractModel):
12045
12528
 
12046
12529
  @property
12047
12530
  def Total(self):
12048
- r"""该模式慢日志条数
12531
+ r"""慢日志条数。
12049
12532
  :rtype: int
12050
12533
  """
12051
12534
  return self._Total
@@ -12072,23 +12555,16 @@ class SlowLogPattern(AbstractModel):
12072
12555
 
12073
12556
 
12074
12557
  class SpecItem(AbstractModel):
12075
- r"""mongodb售卖规格
12558
+ r"""mongodb售卖规格。
12076
12559
 
12077
12560
  """
12078
12561
 
12079
12562
  def __init__(self):
12080
12563
  r"""
12081
12564
  :param _SpecCode: 规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。
12082
- - 节点类型,如下所示。
12083
- - mongo:Mongod 节点。
12084
- - mongos:Mongos 节点。
12085
- - cfgstr:Configserver 节点。
12086
- - 规格类型,如下所示。
12087
- - HIO10G:通用高HIO万兆型。
12088
- - HCD:云盘版类型。
12089
- - 内存规格,如下所示:
12090
- - 支持4、8、16、32、64、128、240、512。
12091
- - 单位g:表示GB。128g则表示128GB。
12565
+ - 节点类型:**mongo**,指 Mongod 节点;**mongos**,指 Mongos 节点;**cfgstr**,指 Configserver 节点。
12566
+ - 规格类型:**HIO10G**,指通用高HIO万兆型;**HCD**:指云盘版类型。
12567
+ - 内存规格:支持4、8、16、32、64、128、240、512。单位g:表示GB。128g 则表示128GB。
12092
12568
  :type SpecCode: str
12093
12569
  :param _Status: 售卖规格有效标志,取值范围如下:
12094
12570
  - 0:停止售卖,
@@ -12109,17 +12585,16 @@ class SpecItem(AbstractModel):
12109
12585
  :param _Conns: 规格所支持的最大连接数限制。
12110
12586
  :type Conns: int
12111
12587
  :param _MongoVersionCode: 实例存储引擎版本信息。
12112
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
12113
12588
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
12114
12589
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
12115
12590
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
12116
12591
  - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
12117
12592
  - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
12593
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
12118
12594
  :type MongoVersionCode: str
12119
12595
  :param _MongoVersionValue: 实例版本对应的数字版本。
12120
12596
  :type MongoVersionValue: int
12121
- :param _Version: 实例版本信息。支持:3.6、4.2、4.4、5.0、6.0。
12122
-
12597
+ :param _Version: 实例版本信息。支持:4.2、4.4、5.0、6.0、7.0
12123
12598
  :type Version: str
12124
12599
  :param _EngineName: 存储引擎。
12125
12600
  :type EngineName: str
@@ -12169,16 +12644,9 @@ class SpecItem(AbstractModel):
12169
12644
  @property
12170
12645
  def SpecCode(self):
12171
12646
  r"""规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。
12172
- - 节点类型,如下所示。
12173
- - mongo:Mongod 节点。
12174
- - mongos:Mongos 节点。
12175
- - cfgstr:Configserver 节点。
12176
- - 规格类型,如下所示。
12177
- - HIO10G:通用高HIO万兆型。
12178
- - HCD:云盘版类型。
12179
- - 内存规格,如下所示:
12180
- - 支持4、8、16、32、64、128、240、512。
12181
- - 单位g:表示GB。128g则表示128GB。
12647
+ - 节点类型:**mongo**,指 Mongod 节点;**mongos**,指 Mongos 节点;**cfgstr**,指 Configserver 节点。
12648
+ - 规格类型:**HIO10G**,指通用高HIO万兆型;**HCD**:指云盘版类型。
12649
+ - 内存规格:支持4、8、16、32、64、128、240、512。单位g:表示GB。128g 则表示128GB。
12182
12650
  :rtype: str
12183
12651
  """
12184
12652
  return self._SpecCode
@@ -12280,12 +12748,12 @@ class SpecItem(AbstractModel):
12280
12748
  @property
12281
12749
  def MongoVersionCode(self):
12282
12750
  r"""实例存储引擎版本信息。
12283
- - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
12284
12751
  - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
12285
12752
  - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
12286
12753
  - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
12287
12754
  - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
12288
12755
  - MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。
12756
+ - MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。
12289
12757
  :rtype: str
12290
12758
  """
12291
12759
  return self._MongoVersionCode
@@ -12307,8 +12775,7 @@ class SpecItem(AbstractModel):
12307
12775
 
12308
12776
  @property
12309
12777
  def Version(self):
12310
- r"""实例版本信息。支持:3.6、4.2、4.4、5.0、6.0。
12311
-
12778
+ r"""实例版本信息。支持:4.2、4.4、5.0、6.0、7.0
12312
12779
  :rtype: str
12313
12780
  """
12314
12781
  return self._Version
@@ -12454,19 +12921,21 @@ class SpecItem(AbstractModel):
12454
12921
 
12455
12922
 
12456
12923
  class SpecificationInfo(AbstractModel):
12457
- r"""实例规格信息
12924
+ r"""实例规格信息。
12458
12925
 
12459
12926
  """
12460
12927
 
12461
12928
  def __init__(self):
12462
12929
  r"""
12463
- :param _Region: 地域信息
12930
+ :param _Region: 地域信息。
12464
12931
  :type Region: str
12465
- :param _Zone: 可用区信息
12932
+ :param _Zone: 可用区信息。
12466
12933
  :type Zone: str
12467
- :param _SpecItems: 售卖规格信息
12934
+ :param _SpecItems: 售卖规格信息。
12468
12935
  :type SpecItems: list of SpecItem
12469
- :param _SupportMultiAZ: 是否支持跨可用区部署 1-支持,0-不支持
12936
+ :param _SupportMultiAZ: 是否支持跨可用区部署。
12937
+ - 1:支持。
12938
+ - 0:不支持。
12470
12939
  :type SupportMultiAZ: int
12471
12940
  """
12472
12941
  self._Region = None
@@ -12476,7 +12945,7 @@ class SpecificationInfo(AbstractModel):
12476
12945
 
12477
12946
  @property
12478
12947
  def Region(self):
12479
- r"""地域信息
12948
+ r"""地域信息。
12480
12949
  :rtype: str
12481
12950
  """
12482
12951
  return self._Region
@@ -12487,7 +12956,7 @@ class SpecificationInfo(AbstractModel):
12487
12956
 
12488
12957
  @property
12489
12958
  def Zone(self):
12490
- r"""可用区信息
12959
+ r"""可用区信息。
12491
12960
  :rtype: str
12492
12961
  """
12493
12962
  return self._Zone
@@ -12498,7 +12967,7 @@ class SpecificationInfo(AbstractModel):
12498
12967
 
12499
12968
  @property
12500
12969
  def SpecItems(self):
12501
- r"""售卖规格信息
12970
+ r"""售卖规格信息。
12502
12971
  :rtype: list of SpecItem
12503
12972
  """
12504
12973
  return self._SpecItems
@@ -12509,7 +12978,9 @@ class SpecificationInfo(AbstractModel):
12509
12978
 
12510
12979
  @property
12511
12980
  def SupportMultiAZ(self):
12512
- r"""是否支持跨可用区部署 1-支持,0-不支持
12981
+ r"""是否支持跨可用区部署。
12982
+ - 1:支持。
12983
+ - 0:不支持。
12513
12984
  :rtype: int
12514
12985
  """
12515
12986
  return self._SupportMultiAZ