tencentcloud-sdk-python-intl-en 3.0.1288__py2.py3-none-any.whl → 3.0.1291__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.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

Files changed (29) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/ccc/v20200210/ccc_client.py +23 -0
  3. tencentcloud/ccc/v20200210/models.py +184 -0
  4. tencentcloud/clb/v20180317/clb_client.py +4 -4
  5. tencentcloud/clb/v20180317/errorcodes.py +9 -0
  6. tencentcloud/clb/v20180317/models.py +27 -2
  7. tencentcloud/cynosdb/v20190107/cynosdb_client.py +46 -0
  8. tencentcloud/cynosdb/v20190107/errorcodes.py +3 -0
  9. tencentcloud/cynosdb/v20190107/models.py +1286 -75
  10. tencentcloud/dlc/v20210125/dlc_client.py +69 -0
  11. tencentcloud/dlc/v20210125/models.py +504 -0
  12. tencentcloud/mdl/v20200326/models.py +191 -0
  13. tencentcloud/mongodb/v20190725/errorcodes.py +15 -0
  14. tencentcloud/mongodb/v20190725/models.py +1276 -463
  15. tencentcloud/mongodb/v20190725/mongodb_client.py +75 -6
  16. tencentcloud/monitor/v20180724/models.py +1351 -124
  17. tencentcloud/monitor/v20180724/monitor_client.py +118 -0
  18. tencentcloud/mps/v20190612/models.py +366 -62
  19. tencentcloud/quota/v20241204/models.py +17 -2
  20. tencentcloud/redis/v20180412/models.py +410 -168
  21. tencentcloud/redis/v20180412/redis_client.py +4 -4
  22. tencentcloud/wedata/v20250806/__init__.py +0 -0
  23. tencentcloud/wedata/v20250806/errorcodes.py +57 -0
  24. tencentcloud/wedata/v20250806/models.py +26375 -0
  25. tencentcloud/wedata/v20250806/wedata_client.py +1797 -0
  26. {tencentcloud_sdk_python_intl_en-3.0.1288.dist-info → tencentcloud_sdk_python_intl_en-3.0.1291.dist-info}/METADATA +1 -1
  27. {tencentcloud_sdk_python_intl_en-3.0.1288.dist-info → tencentcloud_sdk_python_intl_en-3.0.1291.dist-info}/RECORD +29 -25
  28. {tencentcloud_sdk_python_intl_en-3.0.1288.dist-info → tencentcloud_sdk_python_intl_en-3.0.1291.dist-info}/WHEEL +0 -0
  29. {tencentcloud_sdk_python_intl_en-3.0.1288.dist-info → tencentcloud_sdk_python_intl_en-3.0.1291.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"""Node details of an instance to be modified.
22
+ r"""Node details of the instance to be modified.
23
23
 
24
24
  """
25
25
 
@@ -30,9 +30,9 @@ class AddNodeList(AbstractModel):
30
30
  - READONLY: read-only node.
31
31
  - MONGOS: Mongos node.
32
32
  :type Role: str
33
- :param _Zone: AZs corresponding to the nodes.
34
- - Single AZ: All nodes are in the same AZ.
35
- - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any two AZs should be larger than that in the third AZ.
33
+ :param _Zone: AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
34
+ - Single AZ: All nodes are in the same AZ.
35
+ - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any 2 AZs should be greater than that in the third AZ.
36
36
  :type Zone: str
37
37
  """
38
38
  self._Role = None
@@ -54,9 +54,9 @@ class AddNodeList(AbstractModel):
54
54
 
55
55
  @property
56
56
  def Zone(self):
57
- r"""AZs corresponding to the nodes.
58
- - Single AZ: All nodes are in the same AZ.
59
- - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any two AZs should be larger than that in the third AZ.
57
+ r"""AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
58
+ - Single AZ: All nodes are in the same AZ.
59
+ - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any 2 AZs should be greater than that in the third AZ.
60
60
  :rtype: str
61
61
  """
62
62
  return self._Zone
@@ -88,7 +88,7 @@ class AssignProjectRequest(AbstractModel):
88
88
  r"""
89
89
  :param _InstanceIds: Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
90
90
  :type InstanceIds: list of str
91
- :param _ProjectId: Unique ID of an existing project (instead of a new project).
91
+ :param _ProjectId: Project ID, the unique ID of the project created by the user. Go to the [project management](https://console.cloud.tencent.com/project) area of the account center in the console to copy the project ID.
92
92
  :type ProjectId: int
93
93
  """
94
94
  self._InstanceIds = None
@@ -107,7 +107,7 @@ class AssignProjectRequest(AbstractModel):
107
107
 
108
108
  @property
109
109
  def ProjectId(self):
110
- r"""Unique ID of an existing project (instead of a new project).
110
+ r"""Project ID, the unique ID of the project created by the user. Go to the [project management](https://console.cloud.tencent.com/project) area of the account center in the console to copy the project ID.
111
111
  :rtype: int
112
112
  """
113
113
  return self._ProjectId
@@ -137,7 +137,7 @@ class AssignProjectResponse(AbstractModel):
137
137
 
138
138
  def __init__(self):
139
139
  r"""
140
- :param _FlowIds: List of the returned async task IDs
140
+ :param _FlowIds: Lists async task ids returned.
141
141
  :type FlowIds: list of int non-negative
142
142
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
143
143
  :type RequestId: str
@@ -147,7 +147,7 @@ class AssignProjectResponse(AbstractModel):
147
147
 
148
148
  @property
149
149
  def FlowIds(self):
150
- r"""List of the returned async task IDs
150
+ r"""Lists async task ids returned.
151
151
  :rtype: list of int non-negative
152
152
  """
153
153
  return self._FlowIds
@@ -180,25 +180,36 @@ class BackupDownloadTask(AbstractModel):
180
180
 
181
181
  def __init__(self):
182
182
  r"""
183
- :param _CreateTime: Task creation time
183
+ :param _CreateTime: Task creation time.
184
184
  :type CreateTime: str
185
- :param _BackupName: Backup name
185
+ :param _BackupName: Backup file name.
186
186
  :type BackupName: str
187
- :param _ReplicaSetId: Shard name
187
+ :param _ReplicaSetId: Shard name.
188
188
  :type ReplicaSetId: str
189
- :param _BackupSize: Backup size in bytes
189
+ :param _BackupSize: Backup data size, in bytes.
190
190
  :type BackupSize: int
191
- :param _Status: Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)
191
+ :param _Status: Task status.
192
+ - 0: wait for execution.
193
+ - 1: downloading.
194
+ - 2: download completed.
195
+ - 3: download failed.
196
+ - 4: wait for retry.
192
197
  :type Status: int
193
- :param _Percent: Task progress in percentage
198
+ :param _Percent: Task progress percentage.
194
199
  :type Percent: int
195
- :param _TimeSpend: Task duration in seconds
200
+ :param _TimeSpend: Duration, in seconds.
196
201
  :type TimeSpend: int
197
- :param _Url: Backup download address
202
+ :param _Url: Download link for backup data.
198
203
  :type Url: str
199
- :param _BackupMethod: Backup type of the backup file. Valid values: `0` (logical backup), `1` (physical backup)
204
+ :param _BackupMethod: Backup method.
205
+ - 0: logical backup.
206
+ - 1: physical backup.
207
+ - 3: snapshot backup.
208
+ **Note**:
209
+ 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
210
+ 2. Physical backup is not supported when storage encryption is enabled for the instance.
200
211
  :type BackupMethod: int
201
- :param _BackupDesc: Specifies the remarks for backup.
212
+ :param _BackupDesc: Specified remarks for initiating backup tasks.
202
213
  :type BackupDesc: str
203
214
  :param _Region: Region information.
204
215
  :type Region: str
@@ -220,7 +231,7 @@ class BackupDownloadTask(AbstractModel):
220
231
 
221
232
  @property
222
233
  def CreateTime(self):
223
- r"""Task creation time
234
+ r"""Task creation time.
224
235
  :rtype: str
225
236
  """
226
237
  return self._CreateTime
@@ -231,7 +242,7 @@ class BackupDownloadTask(AbstractModel):
231
242
 
232
243
  @property
233
244
  def BackupName(self):
234
- r"""Backup name
245
+ r"""Backup file name.
235
246
  :rtype: str
236
247
  """
237
248
  return self._BackupName
@@ -242,7 +253,7 @@ class BackupDownloadTask(AbstractModel):
242
253
 
243
254
  @property
244
255
  def ReplicaSetId(self):
245
- r"""Shard name
256
+ r"""Shard name.
246
257
  :rtype: str
247
258
  """
248
259
  return self._ReplicaSetId
@@ -253,7 +264,7 @@ class BackupDownloadTask(AbstractModel):
253
264
 
254
265
  @property
255
266
  def BackupSize(self):
256
- r"""Backup size in bytes
267
+ r"""Backup data size, in bytes.
257
268
  :rtype: int
258
269
  """
259
270
  return self._BackupSize
@@ -264,7 +275,12 @@ class BackupDownloadTask(AbstractModel):
264
275
 
265
276
  @property
266
277
  def Status(self):
267
- r"""Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)
278
+ r"""Task status.
279
+ - 0: wait for execution.
280
+ - 1: downloading.
281
+ - 2: download completed.
282
+ - 3: download failed.
283
+ - 4: wait for retry.
268
284
  :rtype: int
269
285
  """
270
286
  return self._Status
@@ -275,7 +291,7 @@ class BackupDownloadTask(AbstractModel):
275
291
 
276
292
  @property
277
293
  def Percent(self):
278
- r"""Task progress in percentage
294
+ r"""Task progress percentage.
279
295
  :rtype: int
280
296
  """
281
297
  return self._Percent
@@ -286,7 +302,7 @@ class BackupDownloadTask(AbstractModel):
286
302
 
287
303
  @property
288
304
  def TimeSpend(self):
289
- r"""Task duration in seconds
305
+ r"""Duration, in seconds.
290
306
  :rtype: int
291
307
  """
292
308
  return self._TimeSpend
@@ -297,7 +313,7 @@ class BackupDownloadTask(AbstractModel):
297
313
 
298
314
  @property
299
315
  def Url(self):
300
- r"""Backup download address
316
+ r"""Download link for backup data.
301
317
  :rtype: str
302
318
  """
303
319
  return self._Url
@@ -308,7 +324,13 @@ class BackupDownloadTask(AbstractModel):
308
324
 
309
325
  @property
310
326
  def BackupMethod(self):
311
- r"""Backup type of the backup file. Valid values: `0` (logical backup), `1` (physical backup)
327
+ r"""Backup method.
328
+ - 0: logical backup.
329
+ - 1: physical backup.
330
+ - 3: snapshot backup.
331
+ **Note**:
332
+ 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
333
+ 2. Physical backup is not supported when storage encryption is enabled for the instance.
312
334
  :rtype: int
313
335
  """
314
336
  return self._BackupMethod
@@ -319,7 +341,7 @@ class BackupDownloadTask(AbstractModel):
319
341
 
320
342
  @property
321
343
  def BackupDesc(self):
322
- r"""Specifies the remarks for backup.
344
+ r"""Specified remarks for initiating backup tasks.
323
345
  :rtype: str
324
346
  """
325
347
  return self._BackupDesc
@@ -375,15 +397,20 @@ class BackupDownloadTask(AbstractModel):
375
397
 
376
398
 
377
399
  class BackupDownloadTaskStatus(AbstractModel):
378
- r"""The result of the created backup download task
400
+ r"""Result of creating a backup download task.
379
401
 
380
402
  """
381
403
 
382
404
  def __init__(self):
383
405
  r"""
384
- :param _ReplicaSetId: Shard name
406
+ :param _ReplicaSetId: Shard name.
385
407
  :type ReplicaSetId: str
386
- :param _Status: Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)
408
+ :param _Status: Current status of the task.
409
+ - 0: wait for execution.
410
+ - 1: downloading.
411
+ - 2: download completed.
412
+ - 3: download failed.
413
+ - 4: wait for retry.
387
414
  :type Status: int
388
415
  """
389
416
  self._ReplicaSetId = None
@@ -391,7 +418,7 @@ class BackupDownloadTaskStatus(AbstractModel):
391
418
 
392
419
  @property
393
420
  def ReplicaSetId(self):
394
- r"""Shard name
421
+ r"""Shard name.
395
422
  :rtype: str
396
423
  """
397
424
  return self._ReplicaSetId
@@ -402,7 +429,12 @@ class BackupDownloadTaskStatus(AbstractModel):
402
429
 
403
430
  @property
404
431
  def Status(self):
405
- r"""Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)
432
+ r"""Current status of the task.
433
+ - 0: wait for execution.
434
+ - 1: downloading.
435
+ - 2: download completed.
436
+ - 3: download failed.
437
+ - 4: wait for retry.
406
438
  :rtype: int
407
439
  """
408
440
  return self._Status
@@ -426,7 +458,7 @@ class BackupDownloadTaskStatus(AbstractModel):
426
458
 
427
459
 
428
460
  class BackupInfo(AbstractModel):
429
- r"""Backup information
461
+ r"""Backup information.
430
462
 
431
463
  """
432
464
 
@@ -434,28 +466,40 @@ class BackupInfo(AbstractModel):
434
466
  r"""
435
467
  :param _InstanceId: Instance ID.
436
468
  :type InstanceId: str
437
- :param _BackupType: Backup mode. 0: automatic backup; 1: manual backup
469
+ :param _BackupType: Backup method.
470
+ - 0: automatic backup.
471
+ - 1: manual backup.
438
472
  :type BackupType: int
439
- :param _BackupName: Backup name
473
+ :param _BackupName: Backup file name.
440
474
  :type BackupName: str
441
- :param _BackupDesc: Backup remarks.
475
+ :param _BackupDesc: Backup task remarks.
442
476
  :type BackupDesc: str
443
- :param _BackupSize: Backup file size. Unit: KB.
477
+ :param _BackupSize: Backup file size, in KB.
444
478
  :type BackupSize: int
445
479
  :param _StartTime: Backup start time.
446
480
  :type StartTime: str
447
481
  :param _EndTime: Backup end time.
448
482
  :type EndTime: str
449
- :param _Status: Backup status. 1: backing up; 2: backed up successful
483
+ :param _Status: Backup status.
484
+ - 1: backing up.
485
+ - 2: backup successful.
450
486
  :type Status: int
451
- :param _BackupMethod: Backup method. 0: logical backup; 1: physical backup
487
+ :param _BackupMethod: Backup method.
488
+ - 0: logical backup.
489
+ - 1: physical backup.
490
+ - 3: snapshot backup.
491
+ **Note:**
492
+ - The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
493
+ - Physical backup is not supported when storage encryption is enabled for the instance.
452
494
  :type BackupMethod: int
453
495
  :param _BackId: Backup record ID.
454
496
  :type BackId: int
455
497
  :param _DeleteTime: Backup deletion time.
456
498
  :type DeleteTime: str
457
- :param _BackupRegion: Region for cross-region backup.
499
+ :param _BackupRegion: Cross-region backup region.
458
500
  :type BackupRegion: str
501
+ :param _RestoreTime: Rollback time supported by the backup.
502
+ :type RestoreTime: str
459
503
  """
460
504
  self._InstanceId = None
461
505
  self._BackupType = None
@@ -469,6 +513,7 @@ class BackupInfo(AbstractModel):
469
513
  self._BackId = None
470
514
  self._DeleteTime = None
471
515
  self._BackupRegion = None
516
+ self._RestoreTime = None
472
517
 
473
518
  @property
474
519
  def InstanceId(self):
@@ -483,7 +528,9 @@ class BackupInfo(AbstractModel):
483
528
 
484
529
  @property
485
530
  def BackupType(self):
486
- r"""Backup mode. 0: automatic backup; 1: manual backup
531
+ r"""Backup method.
532
+ - 0: automatic backup.
533
+ - 1: manual backup.
487
534
  :rtype: int
488
535
  """
489
536
  return self._BackupType
@@ -494,7 +541,7 @@ class BackupInfo(AbstractModel):
494
541
 
495
542
  @property
496
543
  def BackupName(self):
497
- r"""Backup name
544
+ r"""Backup file name.
498
545
  :rtype: str
499
546
  """
500
547
  return self._BackupName
@@ -505,7 +552,7 @@ class BackupInfo(AbstractModel):
505
552
 
506
553
  @property
507
554
  def BackupDesc(self):
508
- r"""Backup remarks.
555
+ r"""Backup task remarks.
509
556
  :rtype: str
510
557
  """
511
558
  return self._BackupDesc
@@ -516,7 +563,7 @@ class BackupInfo(AbstractModel):
516
563
 
517
564
  @property
518
565
  def BackupSize(self):
519
- r"""Backup file size. Unit: KB.
566
+ r"""Backup file size, in KB.
520
567
  :rtype: int
521
568
  """
522
569
  return self._BackupSize
@@ -549,7 +596,9 @@ class BackupInfo(AbstractModel):
549
596
 
550
597
  @property
551
598
  def Status(self):
552
- r"""Backup status. 1: backing up; 2: backed up successful
599
+ r"""Backup status.
600
+ - 1: backing up.
601
+ - 2: backup successful.
553
602
  :rtype: int
554
603
  """
555
604
  return self._Status
@@ -560,7 +609,13 @@ class BackupInfo(AbstractModel):
560
609
 
561
610
  @property
562
611
  def BackupMethod(self):
563
- r"""Backup method. 0: logical backup; 1: physical backup
612
+ r"""Backup method.
613
+ - 0: logical backup.
614
+ - 1: physical backup.
615
+ - 3: snapshot backup.
616
+ **Note:**
617
+ - The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
618
+ - Physical backup is not supported when storage encryption is enabled for the instance.
564
619
  :rtype: int
565
620
  """
566
621
  return self._BackupMethod
@@ -593,7 +648,7 @@ class BackupInfo(AbstractModel):
593
648
 
594
649
  @property
595
650
  def BackupRegion(self):
596
- r"""Region for cross-region backup.
651
+ r"""Cross-region backup region.
597
652
  :rtype: str
598
653
  """
599
654
  return self._BackupRegion
@@ -602,6 +657,17 @@ class BackupInfo(AbstractModel):
602
657
  def BackupRegion(self, BackupRegion):
603
658
  self._BackupRegion = BackupRegion
604
659
 
660
+ @property
661
+ def RestoreTime(self):
662
+ r"""Rollback time supported by the backup.
663
+ :rtype: str
664
+ """
665
+ return self._RestoreTime
666
+
667
+ @RestoreTime.setter
668
+ def RestoreTime(self, RestoreTime):
669
+ self._RestoreTime = RestoreTime
670
+
605
671
 
606
672
  def _deserialize(self, params):
607
673
  self._InstanceId = params.get("InstanceId")
@@ -616,6 +682,7 @@ class BackupInfo(AbstractModel):
616
682
  self._BackId = params.get("BackId")
617
683
  self._DeleteTime = params.get("DeleteTime")
618
684
  self._BackupRegion = params.get("BackupRegion")
685
+ self._RestoreTime = params.get("RestoreTime")
619
686
  memeber_set = set(params.keys())
620
687
  for name, value in vars(self).items():
621
688
  property_name = name[1:]
@@ -633,11 +700,11 @@ class ClientConnection(AbstractModel):
633
700
 
634
701
  def __init__(self):
635
702
  r"""
636
- :param _IP: Client IP of a connection
703
+ :param _IP: IP address of the connected client.
637
704
  :type IP: str
638
- :param _Count: Number of connections corresponding to a client IP
705
+ :param _Count: Number of connections corresponding to the client IP address.
639
706
  :type Count: int
640
- :param _InternalService: Whether it is the Tencent Cloud IP for automated testing
707
+ :param _InternalService: Whether it is an internal IP address.
641
708
  :type InternalService: bool
642
709
  """
643
710
  self._IP = None
@@ -646,7 +713,7 @@ class ClientConnection(AbstractModel):
646
713
 
647
714
  @property
648
715
  def IP(self):
649
- r"""Client IP of a connection
716
+ r"""IP address of the connected client.
650
717
  :rtype: str
651
718
  """
652
719
  return self._IP
@@ -657,7 +724,7 @@ class ClientConnection(AbstractModel):
657
724
 
658
725
  @property
659
726
  def Count(self):
660
- r"""Number of connections corresponding to a client IP
727
+ r"""Number of connections corresponding to the client IP address.
661
728
  :rtype: int
662
729
  """
663
730
  return self._Count
@@ -668,7 +735,7 @@ class ClientConnection(AbstractModel):
668
735
 
669
736
  @property
670
737
  def InternalService(self):
671
- r"""Whether it is the Tencent Cloud IP for automated testing
738
+ r"""Whether it is an internal IP address.
672
739
  :rtype: bool
673
740
  """
674
741
  return self._InternalService
@@ -702,8 +769,12 @@ class CreateBackupDBInstanceRequest(AbstractModel):
702
769
  :param _InstanceId: Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
703
770
  :type InstanceId: str
704
771
  :param _BackupMethod: Sets the backup method.
705
- - 0: logical backup.
706
- - 1: physical backup.
772
+ - 0: logical backup.
773
+ - 1: physical backup.
774
+ - 3: snapshot backup.
775
+ **Note**:
776
+ 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
777
+ 2. Physical backup is not supported when storage encryption is enabled for the instance.
707
778
  :type BackupMethod: int
708
779
  :param _BackupRemark: Backup remarks information.
709
780
  :type BackupRemark: str
@@ -726,8 +797,12 @@ class CreateBackupDBInstanceRequest(AbstractModel):
726
797
  @property
727
798
  def BackupMethod(self):
728
799
  r"""Sets the backup method.
729
- - 0: logical backup.
730
- - 1: physical backup.
800
+ - 0: logical backup.
801
+ - 1: physical backup.
802
+ - 3: snapshot backup.
803
+ **Note**:
804
+ 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
805
+ 2. Physical backup is not supported when storage encryption is enabled for the instance.
731
806
  :rtype: int
732
807
  """
733
808
  return self._BackupMethod
@@ -812,13 +887,13 @@ class CreateBackupDownloadTaskRequest(AbstractModel):
812
887
 
813
888
  def __init__(self):
814
889
  r"""
815
- :param _InstanceId: Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.
890
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
816
891
  :type InstanceId: str
817
- :param _BackupName: The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.
892
+ :param _BackupName: Name of the backup file to be downloaded. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain it.
818
893
  :type BackupName: str
819
- :param _BackupSets: Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded.
820
- Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0".
821
- Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.
894
+ :param _BackupSets: Specifies the node ID of the replica set to be downloaded or the shard node ID list of the sharded cluster.
895
+ - If the replica set instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0, full data can be downloaded.
896
+ - If the sharded cluster instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1, download the data of Shard 0 and Shard 1. If a full download is needed for the sharded cluster, import all shard names as shown in the example.
822
897
  :type BackupSets: list of ReplicaSetInfo
823
898
  """
824
899
  self._InstanceId = None
@@ -827,7 +902,7 @@ Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the
827
902
 
828
903
  @property
829
904
  def InstanceId(self):
830
- r"""Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.
905
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
831
906
  :rtype: str
832
907
  """
833
908
  return self._InstanceId
@@ -838,7 +913,7 @@ Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the
838
913
 
839
914
  @property
840
915
  def BackupName(self):
841
- r"""The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.
916
+ r"""Name of the backup file to be downloaded. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain it.
842
917
  :rtype: str
843
918
  """
844
919
  return self._BackupName
@@ -849,9 +924,9 @@ Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the
849
924
 
850
925
  @property
851
926
  def BackupSets(self):
852
- r"""Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded.
853
- Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0".
854
- Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.
927
+ r"""Specifies the node ID of the replica set to be downloaded or the shard node ID list of the sharded cluster.
928
+ - If the replica set instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0, full data can be downloaded.
929
+ - If the sharded cluster instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1, download the data of Shard 0 and Shard 1. If a full download is needed for the sharded cluster, import all shard names as shown in the example.
855
930
  :rtype: list of ReplicaSetInfo
856
931
  """
857
932
  return self._BackupSets
@@ -887,7 +962,7 @@ class CreateBackupDownloadTaskResponse(AbstractModel):
887
962
 
888
963
  def __init__(self):
889
964
  r"""
890
- :param _Tasks: Download task status
965
+ :param _Tasks: Status of the download task.
891
966
  :type Tasks: list of BackupDownloadTaskStatus
892
967
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
893
968
  :type RequestId: str
@@ -897,7 +972,7 @@ class CreateBackupDownloadTaskResponse(AbstractModel):
897
972
 
898
973
  @property
899
974
  def Tasks(self):
900
- r"""Download task status
975
+ r"""Status of the download task.
901
976
  :rtype: list of BackupDownloadTaskStatus
902
977
  """
903
978
  return self._Tasks
@@ -945,19 +1020,19 @@ class CreateDBInstanceHourRequest(AbstractModel):
945
1020
  :param _NodeNum: - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set.
946
1021
  - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard.
947
1022
  :type NodeNum: int
948
- :param _MongoVersion: Information on the specific supported versions. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain such versions.
949
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
950
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
951
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
952
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
953
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
954
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1023
+ :param _MongoVersion: Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions.
1024
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1025
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1026
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1027
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1028
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1029
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
955
1030
  :type MongoVersion: str
956
1031
  :param _MachineCode: Product specification type.
957
1032
  - HIO10G: general high-I/O 10GE type.
958
1033
  - HCD: cloud disk type.
959
1034
  :type MachineCode: str
960
- :param _GoodsNum: Number of instances. Value range: 1-10.
1035
+ :param _GoodsNum: Number of instances. The minimum value is 1, and the maximum value is 30.
961
1036
  :type GoodsNum: int
962
1037
  :param _Zone: AZ information in the format of ap-guangzhou-2
963
1038
  - For more information, query through the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API.
@@ -967,9 +1042,13 @@ class CreateDBInstanceHourRequest(AbstractModel):
967
1042
  - REPLSET: Replica set
968
1043
  - SHARD: Sharded cluster
969
1044
  :type ClusterType: str
970
- :param _VpcId: VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.
1045
+ :param _VpcId: VPC ID.
1046
+ - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID.
1047
+ - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
971
1048
  :type VpcId: str
972
- :param _SubnetId: VPC subnet. Log in to the [VPC console](https://console.cloud.tencent.com/VPC) to query the subnet list and confirm the correct ID. Example value: subnet-7jbabche.
1049
+ :param _SubnetId: Subnet ID of the VPC.
1050
+ - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID.
1051
+ - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
973
1052
  :type SubnetId: str
974
1053
  :param _Password: Instance password. The requirements are as follows:
975
1054
  - The number of characters should be in the range of [8, 32].
@@ -982,32 +1061,37 @@ class CreateDBInstanceHourRequest(AbstractModel):
982
1061
  :type ProjectId: int
983
1062
  :param _Tags: Instance tag information
984
1063
  :type Tags: list of TagInfo
985
- :param _Clone: Instance type. 1: formal instance; 3: read-only instance; 4: disaster recovery instance; 5: cloned instance. Note: For a cloned instance, RestoreTime is required.
1064
+ :param _Clone: Instance type.
1065
+ - 1: formal instance.
1066
+ - 3: read-only instance.
1067
+ - 4: disaster recovery instance.
1068
+ - 5. cloned instance. Note: For a cloned instance, RestoreTime is required.
986
1069
  :type Clone: int
987
- :param _Father: Parent instance ID. It is required if the `Clone` is `3` or `4`, that is, read-only instance or disaster recovery instance
1070
+ :param _Father: Parent instance ID.
1071
+ - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.
1072
+ - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list.
988
1073
  :type Father: str
989
- :param _SecurityGroup: Security group ID.
1074
+ :param _SecurityGroup: Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance.
990
1075
  :type SecurityGroup: list of str
991
1076
  :param _RestoreTime: Rollback time of the cloned instance
992
1077
  - This parameter is required for a cloned instance in the format of 2021-08-13 16:30:00.
993
1078
  - Time range for rollback: You can roll back data in the last 7 days.
994
1079
  :type RestoreTime: str
995
- :param _InstanceName: Instance name, which can contain up to 60 letters, digits, and symbols (_-).
1080
+ :param _InstanceName: Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently.
1081
+ - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively.
1082
+ - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7.
1083
+ - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db.
996
1084
  :type InstanceName: str
997
1085
  :param _AvailabilityZoneList: Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.
998
- - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4].
999
- - The [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs.
1000
- - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ.
1001
-
1086
+ - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4].
1087
+ - The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs.
1088
+ - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ.
1002
1089
  :type AvailabilityZoneList: list of str
1003
1090
  :param _MongosCpu: Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase.
1004
-
1005
1091
  :type MongosCpu: int
1006
1092
  :param _MongosMemory: Mongos node memory size.
1007
- - This parameter is required during sharded cluster instance purchase.
1008
- - Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported.
1009
-
1010
-
1093
+ - This parameter is required during sharded cluster instance purchase.
1094
+ - Unit: GB. 1-core 2 GB, 2-core 4 GB, 4-core 8 GB, 8-core 16 GB, and 16-core 32 GB are supported.
1011
1095
  :type MongosMemory: int
1012
1096
  :param _MongosNodeNum: Number of Mongos nodes. This parameter is required during sharded cluster instance purchase.
1013
1097
  - For instances in single-AZ deployment mode, the value range is [3,32].
@@ -1019,7 +1103,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1019
1103
  :type ReadonlyNodeAvailabilityZoneList: list of str
1020
1104
  :param _HiddenZone: AZ where the hidden node resides, which is required in cross-AZ instance deployment.
1021
1105
  :type HiddenZone: str
1022
- :param _ParamTemplateId: Parameter template ID. A parameter template is a collection of MongoDB parameters with preset values. You can save a group of parameters and values with the same requirements as a template. When you create an instance, you can directly reference these parameter values in the instance. Proper use of parameter templates can improve the efficiency of operations on TencentDB for MongoDB databases. The template list can be obtained by calling the DescribeDBInstanceParamTpl API. Pay attention to the database versions supported by templates.
1106
+ :param _ParamTemplateId: Parameter template ID.
1107
+ - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database.
1108
+ - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture.
1023
1109
  :type ParamTemplateId: str
1024
1110
  """
1025
1111
  self._Memory = None
@@ -1098,13 +1184,13 @@ class CreateDBInstanceHourRequest(AbstractModel):
1098
1184
 
1099
1185
  @property
1100
1186
  def MongoVersion(self):
1101
- r"""Information on the specific supported versions. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain such versions.
1102
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
1103
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1104
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1105
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1106
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1107
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1187
+ r"""Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions.
1188
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1189
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1190
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1191
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1192
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1193
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
1108
1194
  :rtype: str
1109
1195
  """
1110
1196
  return self._MongoVersion
@@ -1128,7 +1214,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
1128
1214
 
1129
1215
  @property
1130
1216
  def GoodsNum(self):
1131
- r"""Number of instances. Value range: 1-10.
1217
+ r"""Number of instances. The minimum value is 1, and the maximum value is 30.
1132
1218
  :rtype: int
1133
1219
  """
1134
1220
  return self._GoodsNum
@@ -1165,7 +1251,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1165
1251
 
1166
1252
  @property
1167
1253
  def VpcId(self):
1168
- r"""VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.
1254
+ r"""VPC ID.
1255
+ - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID.
1256
+ - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
1169
1257
  :rtype: str
1170
1258
  """
1171
1259
  return self._VpcId
@@ -1176,7 +1264,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1176
1264
 
1177
1265
  @property
1178
1266
  def SubnetId(self):
1179
- r"""VPC subnet. Log in to the [VPC console](https://console.cloud.tencent.com/VPC) to query the subnet list and confirm the correct ID. Example value: subnet-7jbabche.
1267
+ r"""Subnet ID of the VPC.
1268
+ - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID.
1269
+ - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
1180
1270
  :rtype: str
1181
1271
  """
1182
1272
  return self._SubnetId
@@ -1225,7 +1315,11 @@ class CreateDBInstanceHourRequest(AbstractModel):
1225
1315
 
1226
1316
  @property
1227
1317
  def Clone(self):
1228
- r"""Instance type. 1: formal instance; 3: read-only instance; 4: disaster recovery instance; 5: cloned instance. Note: For a cloned instance, RestoreTime is required.
1318
+ r"""Instance type.
1319
+ - 1: formal instance.
1320
+ - 3: read-only instance.
1321
+ - 4: disaster recovery instance.
1322
+ - 5. cloned instance. Note: For a cloned instance, RestoreTime is required.
1229
1323
  :rtype: int
1230
1324
  """
1231
1325
  return self._Clone
@@ -1236,7 +1330,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1236
1330
 
1237
1331
  @property
1238
1332
  def Father(self):
1239
- r"""Parent instance ID. It is required if the `Clone` is `3` or `4`, that is, read-only instance or disaster recovery instance
1333
+ r"""Parent instance ID.
1334
+ - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.
1335
+ - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list.
1240
1336
  :rtype: str
1241
1337
  """
1242
1338
  return self._Father
@@ -1247,7 +1343,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
1247
1343
 
1248
1344
  @property
1249
1345
  def SecurityGroup(self):
1250
- r"""Security group ID.
1346
+ r"""Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance.
1251
1347
  :rtype: list of str
1252
1348
  """
1253
1349
  return self._SecurityGroup
@@ -1271,7 +1367,10 @@ class CreateDBInstanceHourRequest(AbstractModel):
1271
1367
 
1272
1368
  @property
1273
1369
  def InstanceName(self):
1274
- r"""Instance name, which can contain up to 60 letters, digits, and symbols (_-).
1370
+ r"""Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently.
1371
+ - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively.
1372
+ - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7.
1373
+ - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db.
1275
1374
  :rtype: str
1276
1375
  """
1277
1376
  return self._InstanceName
@@ -1283,10 +1382,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1283
1382
  @property
1284
1383
  def AvailabilityZoneList(self):
1285
1384
  r"""Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.
1286
- - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4].
1287
- - The [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs.
1288
- - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ.
1289
-
1385
+ - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4].
1386
+ - The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs.
1387
+ - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ.
1290
1388
  :rtype: list of str
1291
1389
  """
1292
1390
  return self._AvailabilityZoneList
@@ -1298,7 +1396,6 @@ class CreateDBInstanceHourRequest(AbstractModel):
1298
1396
  @property
1299
1397
  def MongosCpu(self):
1300
1398
  r"""Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase.
1301
-
1302
1399
  :rtype: int
1303
1400
  """
1304
1401
  return self._MongosCpu
@@ -1310,10 +1407,8 @@ class CreateDBInstanceHourRequest(AbstractModel):
1310
1407
  @property
1311
1408
  def MongosMemory(self):
1312
1409
  r"""Mongos node memory size.
1313
- - This parameter is required during sharded cluster instance purchase.
1314
- - Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported.
1315
-
1316
-
1410
+ - This parameter is required during sharded cluster instance purchase.
1411
+ - Unit: GB. 1-core 2 GB, 2-core 4 GB, 4-core 8 GB, 8-core 16 GB, and 16-core 32 GB are supported.
1317
1412
  :rtype: int
1318
1413
  """
1319
1414
  return self._MongosMemory
@@ -1370,7 +1465,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
1370
1465
 
1371
1466
  @property
1372
1467
  def ParamTemplateId(self):
1373
- r"""Parameter template ID. A parameter template is a collection of MongoDB parameters with preset values. You can save a group of parameters and values with the same requirements as a template. When you create an instance, you can directly reference these parameter values in the instance. Proper use of parameter templates can improve the efficiency of operations on TencentDB for MongoDB databases. The template list can be obtained by calling the DescribeDBInstanceParamTpl API. Pay attention to the database versions supported by templates.
1468
+ r"""Parameter template ID.
1469
+ - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database.
1470
+ - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture.
1374
1471
  :rtype: str
1375
1472
  """
1376
1473
  return self._ParamTemplateId
@@ -1495,22 +1592,21 @@ class CreateDBInstanceRequest(AbstractModel):
1495
1592
  :type Memory: int
1496
1593
  :param _Volume: Instance disk size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum disk sizes corresponding to each CPU specification.
1497
1594
  :type Volume: int
1498
- :param _MongoVersion: Information on the specific supported versions. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain such versions.
1499
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
1500
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1501
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1502
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1503
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1504
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1595
+ :param _MongoVersion: Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions.
1596
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1597
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1598
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1599
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1600
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1601
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
1505
1602
  :type MongoVersion: str
1506
- :param _GoodsNum: Number of instances. Minimum value: 1. Maximum value: 10.
1603
+ :param _GoodsNum: Number of instances. The minimum value is 1, and the maximum value is 30.
1507
1604
  :type GoodsNum: int
1508
1605
  :param _Zone: AZ information. Format: ap-guangzhou-2.
1509
1606
  - Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the specific information.
1510
1607
  - This parameter indicates the primary AZ. If multi-AZ deployment is adopted, the value of Zone should be one of the values of AvailabilityZoneList.
1511
1608
  :type Zone: str
1512
- :param _Period: Specifies the purchase duration during instance purchase. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Unit: months.
1513
-
1609
+ :param _Period: Specifies the purchase duration during the instance purchase, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.
1514
1610
  :type Period: int
1515
1611
  :param _MachineCode: Product specification type.
1516
1612
  - HIO10G: general high-I/O 10GE type.
@@ -1526,9 +1622,13 @@ class CreateDBInstanceRequest(AbstractModel):
1526
1622
  :param _ProjectId: Project ID. - The default project is used if this parameter is not specified.
1527
1623
  - The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project).
1528
1624
  :type ProjectId: int
1529
- :param _VpcId: VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.
1625
+ :param _VpcId: VPC ID.
1626
+ - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID.
1627
+ - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
1530
1628
  :type VpcId: str
1531
- :param _SubnetId: VPC subnet. Log in to the [VPC console](https://console.cloud.tencent.com/VPC) to query the subnet list and confirm the correct ID. Example value: subnet-7jbabche.
1629
+ :param _SubnetId: Subnet ID of the VPC.
1630
+ - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID.
1631
+ - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
1532
1632
  :type SubnetId: str
1533
1633
  :param _Password: Instance password. The requirements are as follows:
1534
1634
  - The number of characters should be in the range of [8, 32].
@@ -1546,15 +1646,24 @@ class CreateDBInstanceRequest(AbstractModel):
1546
1646
  - 1: yes.
1547
1647
  - 0: no. Default value: 0.
1548
1648
  :type AutoVoucher: int
1549
- :param _Clone: Instance type. 1: formal instance; 3: read-only instance; 4: disaster recovery instance; 5: instance cloned from a complete instance. Note: For a cloned instance, RestoreTime is required.
1649
+ :param _Clone: Instance type.
1650
+ - 1: formal instance.
1651
+ - 3: read-only instance.
1652
+ - 4: disaster recovery instance.
1653
+ - 5: cloned instance. Note: For a cloned instance, RestoreTime is required.
1550
1654
  :type Clone: int
1551
- :param _Father: Parent instance ID. This parameter is required when the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.
1655
+ :param _Father: Parent instance ID.
1656
+ - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.
1657
+ - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list.
1552
1658
  :type Father: str
1553
- :param _SecurityGroup: Security group ID.
1659
+ :param _SecurityGroup: Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance.
1554
1660
  :type SecurityGroup: list of str
1555
1661
  :param _RestoreTime: Rollback time of the cloned instance. It is required when the Clone value is 5 or 6. - This parameter is required for cloned instances. Format: 2021-08-13 16:30:00. - Rollback time range: Only data within the last 7 days can be rolled back.
1556
1662
  :type RestoreTime: str
1557
- :param _InstanceName: Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.
1663
+ :param _InstanceName: Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently.
1664
+ - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively.
1665
+ - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7.
1666
+ - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db.
1558
1667
  :type InstanceName: str
1559
1668
  :param _AvailabilityZoneList: Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.
1560
1669
  - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4].
@@ -1577,7 +1686,9 @@ class CreateDBInstanceRequest(AbstractModel):
1577
1686
  :type ReadonlyNodeAvailabilityZoneList: list of str
1578
1687
  :param _HiddenZone: AZ of the hidden node. This parameter is required for instances in multi-AZ deployment mode.
1579
1688
  :type HiddenZone: str
1580
- :param _ParamTemplateId: Parameter template ID. A parameter template is a collection of MongoDB parameters with preset values. You can save a group of parameters and values with the same requirements as a template. When you create an instance, you can directly reference these parameter values in the instance. Proper use of parameter templates can improve the efficiency of operations on TencentDB for MongoDB databases. The template list can be obtained by calling the DescribeDBInstanceParamTpl API. Pay attention to the database versions and instance types supported by templates.
1689
+ :param _ParamTemplateId: Parameter template ID.
1690
+ - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database.
1691
+ - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture.
1581
1692
  :type ParamTemplateId: str
1582
1693
  """
1583
1694
  self._NodeNum = None
@@ -1647,13 +1758,13 @@ class CreateDBInstanceRequest(AbstractModel):
1647
1758
 
1648
1759
  @property
1649
1760
  def MongoVersion(self):
1650
- r"""Information on the specific supported versions. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain such versions.
1651
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
1652
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1653
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1654
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1655
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1656
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1761
+ r"""Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions.
1762
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
1763
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
1764
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
1765
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
1766
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
1767
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
1657
1768
  :rtype: str
1658
1769
  """
1659
1770
  return self._MongoVersion
@@ -1664,7 +1775,7 @@ class CreateDBInstanceRequest(AbstractModel):
1664
1775
 
1665
1776
  @property
1666
1777
  def GoodsNum(self):
1667
- r"""Number of instances. Minimum value: 1. Maximum value: 10.
1778
+ r"""Number of instances. The minimum value is 1, and the maximum value is 30.
1668
1779
  :rtype: int
1669
1780
  """
1670
1781
  return self._GoodsNum
@@ -1688,8 +1799,7 @@ class CreateDBInstanceRequest(AbstractModel):
1688
1799
 
1689
1800
  @property
1690
1801
  def Period(self):
1691
- r"""Specifies the purchase duration during instance purchase. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Unit: months.
1692
-
1802
+ r"""Specifies the purchase duration during the instance purchase, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.
1693
1803
  :rtype: int
1694
1804
  """
1695
1805
  return self._Period
@@ -1750,7 +1860,9 @@ class CreateDBInstanceRequest(AbstractModel):
1750
1860
 
1751
1861
  @property
1752
1862
  def VpcId(self):
1753
- r"""VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.
1863
+ r"""VPC ID.
1864
+ - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID.
1865
+ - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
1754
1866
  :rtype: str
1755
1867
  """
1756
1868
  return self._VpcId
@@ -1761,7 +1873,9 @@ class CreateDBInstanceRequest(AbstractModel):
1761
1873
 
1762
1874
  @property
1763
1875
  def SubnetId(self):
1764
- r"""VPC subnet. Log in to the [VPC console](https://console.cloud.tencent.com/VPC) to query the subnet list and confirm the correct ID. Example value: subnet-7jbabche.
1876
+ r"""Subnet ID of the VPC.
1877
+ - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID.
1878
+ - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).
1765
1879
  :rtype: str
1766
1880
  """
1767
1881
  return self._SubnetId
@@ -1824,7 +1938,11 @@ class CreateDBInstanceRequest(AbstractModel):
1824
1938
 
1825
1939
  @property
1826
1940
  def Clone(self):
1827
- r"""Instance type. 1: formal instance; 3: read-only instance; 4: disaster recovery instance; 5: instance cloned from a complete instance. Note: For a cloned instance, RestoreTime is required.
1941
+ r"""Instance type.
1942
+ - 1: formal instance.
1943
+ - 3: read-only instance.
1944
+ - 4: disaster recovery instance.
1945
+ - 5: cloned instance. Note: For a cloned instance, RestoreTime is required.
1828
1946
  :rtype: int
1829
1947
  """
1830
1948
  return self._Clone
@@ -1835,7 +1953,9 @@ class CreateDBInstanceRequest(AbstractModel):
1835
1953
 
1836
1954
  @property
1837
1955
  def Father(self):
1838
- r"""Parent instance ID. This parameter is required when the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.
1956
+ r"""Parent instance ID.
1957
+ - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.
1958
+ - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list.
1839
1959
  :rtype: str
1840
1960
  """
1841
1961
  return self._Father
@@ -1846,7 +1966,7 @@ class CreateDBInstanceRequest(AbstractModel):
1846
1966
 
1847
1967
  @property
1848
1968
  def SecurityGroup(self):
1849
- r"""Security group ID.
1969
+ r"""Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance.
1850
1970
  :rtype: list of str
1851
1971
  """
1852
1972
  return self._SecurityGroup
@@ -1868,7 +1988,10 @@ class CreateDBInstanceRequest(AbstractModel):
1868
1988
 
1869
1989
  @property
1870
1990
  def InstanceName(self):
1871
- r"""Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.
1991
+ r"""Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently.
1992
+ - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively.
1993
+ - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7.
1994
+ - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db.
1872
1995
  :rtype: str
1873
1996
  """
1874
1997
  return self._InstanceName
@@ -1963,7 +2086,9 @@ class CreateDBInstanceRequest(AbstractModel):
1963
2086
 
1964
2087
  @property
1965
2088
  def ParamTemplateId(self):
1966
- r"""Parameter template ID. A parameter template is a collection of MongoDB parameters with preset values. You can save a group of parameters and values with the same requirements as a template. When you create an instance, you can directly reference these parameter values in the instance. Proper use of parameter templates can improve the efficiency of operations on TencentDB for MongoDB databases. The template list can be obtained by calling the DescribeDBInstanceParamTpl API. Pay attention to the database versions and instance types supported by templates.
2089
+ r"""Parameter template ID.
2090
+ - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database.
2091
+ - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture.
1967
2092
  :rtype: str
1968
2093
  """
1969
2094
  return self._ParamTemplateId
@@ -2135,11 +2260,11 @@ class DBInstancePrice(AbstractModel):
2135
2260
 
2136
2261
  def __init__(self):
2137
2262
  r"""
2138
- :param _UnitPrice: Unit price.
2263
+ :param _UnitPrice: Unit price of the instance, in USD.
2139
2264
  :type UnitPrice: float
2140
- :param _OriginalPrice: Original price.
2265
+ :param _OriginalPrice: Original price of the instance, in USD.
2141
2266
  :type OriginalPrice: float
2142
- :param _DiscountPrice: Discount price.
2267
+ :param _DiscountPrice: Discount price of the instance, in USD.
2143
2268
  :type DiscountPrice: float
2144
2269
  """
2145
2270
  self._UnitPrice = None
@@ -2148,7 +2273,7 @@ class DBInstancePrice(AbstractModel):
2148
2273
 
2149
2274
  @property
2150
2275
  def UnitPrice(self):
2151
- r"""Unit price.
2276
+ r"""Unit price of the instance, in USD.
2152
2277
  :rtype: float
2153
2278
  """
2154
2279
  return self._UnitPrice
@@ -2159,7 +2284,7 @@ class DBInstancePrice(AbstractModel):
2159
2284
 
2160
2285
  @property
2161
2286
  def OriginalPrice(self):
2162
- r"""Original price.
2287
+ r"""Original price of the instance, in USD.
2163
2288
  :rtype: float
2164
2289
  """
2165
2290
  return self._OriginalPrice
@@ -2170,7 +2295,7 @@ class DBInstancePrice(AbstractModel):
2170
2295
 
2171
2296
  @property
2172
2297
  def DiscountPrice(self):
2173
- r"""Discount price.
2298
+ r"""Discount price of the instance, in USD.
2174
2299
  :rtype: float
2175
2300
  """
2176
2301
  return self._DiscountPrice
@@ -2201,14 +2326,14 @@ class DescribeAsyncRequestInfoRequest(AbstractModel):
2201
2326
 
2202
2327
  def __init__(self):
2203
2328
  r"""
2204
- :param _AsyncRequestId: Async task ID, which is returned by APIs related to async tasks, such as `CreateBackupDBInstance`.
2329
+ :param _AsyncRequestId: Specifies the ID of the asynchronous request to be queried. When an asynchronous process is involved in the API operation (such as [CreateBackupDBInstance](https://www.tencentcloud.comom/document/product/240/46599?from_cn_redirect=1)), the response value of AsyncRequestId is the ID to be filled in for this parameter.
2205
2330
  :type AsyncRequestId: str
2206
2331
  """
2207
2332
  self._AsyncRequestId = None
2208
2333
 
2209
2334
  @property
2210
2335
  def AsyncRequestId(self):
2211
- r"""Async task ID, which is returned by APIs related to async tasks, such as `CreateBackupDBInstance`.
2336
+ r"""Specifies the ID of the asynchronous request to be queried. When an asynchronous process is involved in the API operation (such as [CreateBackupDBInstance](https://www.tencentcloud.comom/document/product/240/46599?from_cn_redirect=1)), the response value of AsyncRequestId is the ID to be filled in for this parameter.
2212
2337
  :rtype: str
2213
2338
  """
2214
2339
  return self._AsyncRequestId
@@ -2239,10 +2364,16 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
2239
2364
  r"""
2240
2365
  :param _Status: Status. Valid values: `initial` (initializing), `running`, `paused` (paused due to failure), `undoed` (rolled back due to failure), `failed` (ended due to failure), `success`
2241
2366
  :type Status: str
2367
+ :param _StartTime: Task execution start time.
2368
+ :type StartTime: str
2369
+ :param _EndTime: Task execution end time.
2370
+ :type EndTime: str
2242
2371
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2243
2372
  :type RequestId: str
2244
2373
  """
2245
2374
  self._Status = None
2375
+ self._StartTime = None
2376
+ self._EndTime = None
2246
2377
  self._RequestId = None
2247
2378
 
2248
2379
  @property
@@ -2256,6 +2387,28 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
2256
2387
  def Status(self, Status):
2257
2388
  self._Status = Status
2258
2389
 
2390
+ @property
2391
+ def StartTime(self):
2392
+ r"""Task execution start time.
2393
+ :rtype: str
2394
+ """
2395
+ return self._StartTime
2396
+
2397
+ @StartTime.setter
2398
+ def StartTime(self, StartTime):
2399
+ self._StartTime = StartTime
2400
+
2401
+ @property
2402
+ def EndTime(self):
2403
+ r"""Task execution end time.
2404
+ :rtype: str
2405
+ """
2406
+ return self._EndTime
2407
+
2408
+ @EndTime.setter
2409
+ def EndTime(self, EndTime):
2410
+ self._EndTime = EndTime
2411
+
2259
2412
  @property
2260
2413
  def RequestId(self):
2261
2414
  r"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
@@ -2270,6 +2423,8 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
2270
2423
 
2271
2424
  def _deserialize(self, params):
2272
2425
  self._Status = params.get("Status")
2426
+ self._StartTime = params.get("StartTime")
2427
+ self._EndTime = params.get("EndTime")
2273
2428
  self._RequestId = params.get("RequestId")
2274
2429
 
2275
2430
 
@@ -2280,23 +2435,32 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2280
2435
 
2281
2436
  def __init__(self):
2282
2437
  r"""
2283
- :param _InstanceId: Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console
2438
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
2284
2439
  :type InstanceId: str
2285
- :param _BackupName: The name of a backup file with download tasks to be queried
2440
+ :param _BackupName: Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.
2286
2441
  :type BackupName: str
2287
- :param _StartTime: The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.
2442
+ :param _StartTime: Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.
2288
2443
  :type StartTime: str
2289
- :param _EndTime: The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.
2444
+ :param _EndTime: Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.
2290
2445
  :type EndTime: str
2291
- :param _Limit: The maximum number of results returned per page. Value range: 1-100. Default value: `20`.
2446
+ :param _Limit: Number of entries returned for this query. Value range: 1100. The default value is 20.
2292
2447
  :type Limit: int
2293
- :param _Offset: Offset for pagination. Default value: `0`.
2448
+ :param _Offset: Specifies the number of pages returned for this query. The default value is 0.
2294
2449
  :type Offset: int
2295
- :param _OrderBy: The field used to sort the results. Valid values: `createTime` (default), `finishTime`.
2450
+ :param _OrderBy: Sorting field.
2451
+ - createTime: sort by the creation time of the backup download task. The default value is createTime.
2452
+ - finishTime: sort by the completion time of the backup download task.
2296
2453
  :type OrderBy: str
2297
- :param _OrderByType: Sort order. Valid values: `asc`, `desc` (default).
2454
+ :param _OrderByType: Sorting method.
2455
+ - asc: ascending order.
2456
+ - desc: descending order. The default value is desc.
2298
2457
  :type OrderByType: str
2299
- :param _Status: The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.
2458
+ :param _Status: Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned.
2459
+ - 0: wait for execution.
2460
+ - 1: downloading.
2461
+ - 2: download completed.
2462
+ - 3: download failed.
2463
+ - 4: wait for retry.
2300
2464
  :type Status: list of int
2301
2465
  """
2302
2466
  self._InstanceId = None
@@ -2311,7 +2475,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2311
2475
 
2312
2476
  @property
2313
2477
  def InstanceId(self):
2314
- r"""Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console
2478
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
2315
2479
  :rtype: str
2316
2480
  """
2317
2481
  return self._InstanceId
@@ -2322,7 +2486,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2322
2486
 
2323
2487
  @property
2324
2488
  def BackupName(self):
2325
- r"""The name of a backup file with download tasks to be queried
2489
+ r"""Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.
2326
2490
  :rtype: str
2327
2491
  """
2328
2492
  return self._BackupName
@@ -2333,7 +2497,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2333
2497
 
2334
2498
  @property
2335
2499
  def StartTime(self):
2336
- r"""The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.
2500
+ r"""Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.
2337
2501
  :rtype: str
2338
2502
  """
2339
2503
  return self._StartTime
@@ -2344,7 +2508,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2344
2508
 
2345
2509
  @property
2346
2510
  def EndTime(self):
2347
- r"""The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.
2511
+ r"""Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.
2348
2512
  :rtype: str
2349
2513
  """
2350
2514
  return self._EndTime
@@ -2355,7 +2519,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2355
2519
 
2356
2520
  @property
2357
2521
  def Limit(self):
2358
- r"""The maximum number of results returned per page. Value range: 1-100. Default value: `20`.
2522
+ r"""Number of entries returned for this query. Value range: 1100. The default value is 20.
2359
2523
  :rtype: int
2360
2524
  """
2361
2525
  return self._Limit
@@ -2366,7 +2530,7 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2366
2530
 
2367
2531
  @property
2368
2532
  def Offset(self):
2369
- r"""Offset for pagination. Default value: `0`.
2533
+ r"""Specifies the number of pages returned for this query. The default value is 0.
2370
2534
  :rtype: int
2371
2535
  """
2372
2536
  return self._Offset
@@ -2377,7 +2541,9 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2377
2541
 
2378
2542
  @property
2379
2543
  def OrderBy(self):
2380
- r"""The field used to sort the results. Valid values: `createTime` (default), `finishTime`.
2544
+ r"""Sorting field.
2545
+ - createTime: sort by the creation time of the backup download task. The default value is createTime.
2546
+ - finishTime: sort by the completion time of the backup download task.
2381
2547
  :rtype: str
2382
2548
  """
2383
2549
  return self._OrderBy
@@ -2388,7 +2554,9 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2388
2554
 
2389
2555
  @property
2390
2556
  def OrderByType(self):
2391
- r"""Sort order. Valid values: `asc`, `desc` (default).
2557
+ r"""Sorting method.
2558
+ - asc: ascending order.
2559
+ - desc: descending order. The default value is desc.
2392
2560
  :rtype: str
2393
2561
  """
2394
2562
  return self._OrderByType
@@ -2399,7 +2567,12 @@ class DescribeBackupDownloadTaskRequest(AbstractModel):
2399
2567
 
2400
2568
  @property
2401
2569
  def Status(self):
2402
- r"""The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.
2570
+ r"""Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned.
2571
+ - 0: wait for execution.
2572
+ - 1: downloading.
2573
+ - 2: download completed.
2574
+ - 3: download failed.
2575
+ - 4: wait for retry.
2403
2576
  :rtype: list of int
2404
2577
  """
2405
2578
  return self._Status
@@ -2436,9 +2609,9 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
2436
2609
 
2437
2610
  def __init__(self):
2438
2611
  r"""
2439
- :param _TotalCount: Total number of results
2612
+ :param _TotalCount: All entries that meet the query conditions.
2440
2613
  :type TotalCount: int
2441
- :param _Tasks: The list of download tasks
2614
+ :param _Tasks: Download task list.
2442
2615
  :type Tasks: list of BackupDownloadTask
2443
2616
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2444
2617
  :type RequestId: str
@@ -2449,7 +2622,7 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
2449
2622
 
2450
2623
  @property
2451
2624
  def TotalCount(self):
2452
- r"""Total number of results
2625
+ r"""All entries that meet the query conditions.
2453
2626
  :rtype: int
2454
2627
  """
2455
2628
  return self._TotalCount
@@ -2460,7 +2633,7 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
2460
2633
 
2461
2634
  @property
2462
2635
  def Tasks(self):
2463
- r"""The list of download tasks
2636
+ r"""Download task list.
2464
2637
  :rtype: list of BackupDownloadTask
2465
2638
  """
2466
2639
  return self._Tasks
@@ -2630,9 +2803,15 @@ class DescribeDBBackupsRequest(AbstractModel):
2630
2803
 
2631
2804
  def __init__(self):
2632
2805
  r"""
2633
- :param _InstanceId: Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
2806
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
2634
2807
  :type InstanceId: str
2635
- :param _BackupMethod: Backup mode. Valid values: `0` (logical backup), `1` (physical backup), `2` (both modes). Default value: `0`.
2808
+ :param _BackupMethod: Backup method.
2809
+ - 0: logical backup.
2810
+ - 1: physical backup.
2811
+ - 3: snapshot backup.
2812
+ **Note**:
2813
+ 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
2814
+ 2. Physical backup is not supported when storage encryption is enabled for the instance.
2636
2815
  :type BackupMethod: int
2637
2816
  :param _Limit: Number of entries per page. Maximum value: `100`. If this parameter is left empty, all entries will be returned.
2638
2817
  :type Limit: int
@@ -2646,7 +2825,7 @@ class DescribeDBBackupsRequest(AbstractModel):
2646
2825
 
2647
2826
  @property
2648
2827
  def InstanceId(self):
2649
- r"""Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
2828
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
2650
2829
  :rtype: str
2651
2830
  """
2652
2831
  return self._InstanceId
@@ -2657,7 +2836,13 @@ class DescribeDBBackupsRequest(AbstractModel):
2657
2836
 
2658
2837
  @property
2659
2838
  def BackupMethod(self):
2660
- r"""Backup mode. Valid values: `0` (logical backup), `1` (physical backup), `2` (both modes). Default value: `0`.
2839
+ r"""Backup method.
2840
+ - 0: logical backup.
2841
+ - 1: physical backup.
2842
+ - 3: snapshot backup.
2843
+ **Note**:
2844
+ 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.
2845
+ 2. Physical backup is not supported when storage encryption is enabled for the instance.
2661
2846
  :rtype: int
2662
2847
  """
2663
2848
  return self._BackupMethod
@@ -2711,9 +2896,9 @@ class DescribeDBBackupsResponse(AbstractModel):
2711
2896
 
2712
2897
  def __init__(self):
2713
2898
  r"""
2714
- :param _BackupList: Backup list
2899
+ :param _BackupList: Backup list.
2715
2900
  :type BackupList: list of BackupInfo
2716
- :param _TotalCount: Total number of backups
2901
+ :param _TotalCount: Number of backups.
2717
2902
  :type TotalCount: int
2718
2903
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2719
2904
  :type RequestId: str
@@ -2724,7 +2909,7 @@ class DescribeDBBackupsResponse(AbstractModel):
2724
2909
 
2725
2910
  @property
2726
2911
  def BackupList(self):
2727
- r"""Backup list
2912
+ r"""Backup list.
2728
2913
  :rtype: list of BackupInfo
2729
2914
  """
2730
2915
  return self._BackupList
@@ -2735,7 +2920,7 @@ class DescribeDBBackupsResponse(AbstractModel):
2735
2920
 
2736
2921
  @property
2737
2922
  def TotalCount(self):
2738
- r"""Total number of backups
2923
+ r"""Number of backups.
2739
2924
  :rtype: int
2740
2925
  """
2741
2926
  return self._TotalCount
@@ -2774,14 +2959,18 @@ class DescribeDBInstanceDealRequest(AbstractModel):
2774
2959
 
2775
2960
  def __init__(self):
2776
2961
  r"""
2777
- :param _DealId: Order ID. It is returned by the `CreateDBInstance` and other APIs.
2962
+ :param _DealId: Order ID.
2963
+ - Pay-as-you-go instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstanceHour](https://www.tencentcloud.comom/document/product/240/38570?from_cn_redirect=1) API.
2964
+ - Yearly/monthly subscription instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstance](https://www.tencentcloud.comom/document/product/240/38571?from_cn_redirect=1) API.
2778
2965
  :type DealId: str
2779
2966
  """
2780
2967
  self._DealId = None
2781
2968
 
2782
2969
  @property
2783
2970
  def DealId(self):
2784
- r"""Order ID. It is returned by the `CreateDBInstance` and other APIs.
2971
+ r"""Order ID.
2972
+ - Pay-as-you-go instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstanceHour](https://www.tencentcloud.comom/document/product/240/38570?from_cn_redirect=1) API.
2973
+ - Yearly/monthly subscription instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstance](https://www.tencentcloud.comom/document/product/240/38571?from_cn_redirect=1) API.
2785
2974
  :rtype: str
2786
2975
  """
2787
2976
  return self._DealId
@@ -2810,15 +2999,28 @@ class DescribeDBInstanceDealResponse(AbstractModel):
2810
2999
 
2811
3000
  def __init__(self):
2812
3001
  r"""
2813
- :param _Status: Order status. Valid values: 1 (unpaid), 2 (paid), 3 (delivering), 4 (delivered), 5 (delivery failed), 6 (refunded), 7 (order closed), 8 (order closed because it failed to be paid within timeout period).
3002
+ :param _Status: Order status.
3003
+ - 1: unpaid.
3004
+ - 2: paid.
3005
+ - 3: delivering.
3006
+ - 4: delivered successfully.
3007
+ - 5: delivery failed.
3008
+ - 6: refund.
3009
+ - 7: order closed.
3010
+ - 8: closed due to unpaid timeout.
2814
3011
  :type Status: int
2815
- :param _OriginalPrice: Original price of the order.
3012
+ :param _OriginalPrice: Original price of the order, in USD.
2816
3013
  :type OriginalPrice: float
2817
- :param _DiscountPrice: Discounted price of the order.
3014
+ :param _DiscountPrice: Discount price of the order, in USD.
2818
3015
  :type DiscountPrice: float
2819
- :param _Action: Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.
3016
+ :param _Action: Order operation behavior.
3017
+ - purchase: newly purchased.
3018
+ - renew: renewed.
3019
+ - upgrade: configuration upgraded.
3020
+ - downgrade: configuration downgraded.
3021
+ - refund: return and refund.
2820
3022
  :type Action: str
2821
- :param _InstanceId: Resource ID of the current order.
3023
+ :param _InstanceId: Instance ID of the current order.
2822
3024
  :type InstanceId: str
2823
3025
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2824
3026
  :type RequestId: str
@@ -2832,7 +3034,15 @@ class DescribeDBInstanceDealResponse(AbstractModel):
2832
3034
 
2833
3035
  @property
2834
3036
  def Status(self):
2835
- r"""Order status. Valid values: 1 (unpaid), 2 (paid), 3 (delivering), 4 (delivered), 5 (delivery failed), 6 (refunded), 7 (order closed), 8 (order closed because it failed to be paid within timeout period).
3037
+ r"""Order status.
3038
+ - 1: unpaid.
3039
+ - 2: paid.
3040
+ - 3: delivering.
3041
+ - 4: delivered successfully.
3042
+ - 5: delivery failed.
3043
+ - 6: refund.
3044
+ - 7: order closed.
3045
+ - 8: closed due to unpaid timeout.
2836
3046
  :rtype: int
2837
3047
  """
2838
3048
  return self._Status
@@ -2843,7 +3053,7 @@ class DescribeDBInstanceDealResponse(AbstractModel):
2843
3053
 
2844
3054
  @property
2845
3055
  def OriginalPrice(self):
2846
- r"""Original price of the order.
3056
+ r"""Original price of the order, in USD.
2847
3057
  :rtype: float
2848
3058
  """
2849
3059
  return self._OriginalPrice
@@ -2854,7 +3064,7 @@ class DescribeDBInstanceDealResponse(AbstractModel):
2854
3064
 
2855
3065
  @property
2856
3066
  def DiscountPrice(self):
2857
- r"""Discounted price of the order.
3067
+ r"""Discount price of the order, in USD.
2858
3068
  :rtype: float
2859
3069
  """
2860
3070
  return self._DiscountPrice
@@ -2865,7 +3075,12 @@ class DescribeDBInstanceDealResponse(AbstractModel):
2865
3075
 
2866
3076
  @property
2867
3077
  def Action(self):
2868
- r"""Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.
3078
+ r"""Order operation behavior.
3079
+ - purchase: newly purchased.
3080
+ - renew: renewed.
3081
+ - upgrade: configuration upgraded.
3082
+ - downgrade: configuration downgraded.
3083
+ - refund: return and refund.
2869
3084
  :rtype: str
2870
3085
  """
2871
3086
  return self._Action
@@ -2876,7 +3091,7 @@ class DescribeDBInstanceDealResponse(AbstractModel):
2876
3091
 
2877
3092
  @property
2878
3093
  def InstanceId(self):
2879
- r"""Resource ID of the current order.
3094
+ r"""Instance ID of the current order.
2880
3095
  :rtype: str
2881
3096
  """
2882
3097
  return self._InstanceId
@@ -3022,13 +3237,26 @@ class DescribeDBInstancesRequest(AbstractModel):
3022
3237
 
3023
3238
  def __init__(self):
3024
3239
  r"""
3025
- :param _InstanceIds: Instance ID list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
3240
+ :param _InstanceIds: Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3026
3241
  :type InstanceIds: list of str
3027
- :param _InstanceType: Specifies the instance type for querying.<ul><li>0: all instances.</li><li>1: formal instance.</li><li>3: read-only instance.</li><li>4: disaster recovery instance.</li></ul>
3242
+ :param _InstanceType: Specifies the instance type for querying. Valid values:
3243
+ - 0: all instances.
3244
+ - 1: formal instance.
3245
+ - 2: temporary instance.
3246
+ - 3: read-only instance.
3247
+ - -1: the query range includes the formal, read-only, and disaster recovery instances simultaneously.
3028
3248
  :type InstanceType: int
3029
- :param _ClusterType: Specifies the cluster type of the queried instance.<ul><li>0: replica set instance.</li><li>1: sharded cluster instance.</li><li>-1: replica set and sharded cluster instance.</li></ul>
3249
+ :param _ClusterType: Specifies the cluster type of the instance to be queried. Valid values:
3250
+ - 0: replica set instance.
3251
+ - 1: sharded cluster instance.
3252
+ - -1: replica set and sharded cluster instance.
3030
3253
  :type ClusterType: int
3031
- :param _Status: Specify the current status of the queried instance.<ul><li>0: pending initialization.</li><li>1: processing, such as modifying specifications or modifying parameters.</li><li>2: instance running normally.</li><li>-2: instance expired.</li></ul>
3254
+ :param _Status: Specifies the current status of the instance to be queried. Valid values:
3255
+ - 0: to be initialized.
3256
+ - 1: processing, such as specification changes and parameter modifications.
3257
+ - 2: running normally.
3258
+ - -2: isolated (yearly/monthly subscription).
3259
+ - -3: isolated (pay-as-you-go).
3032
3260
  :type Status: list of int
3033
3261
  :param _VpcId: VPC ID.
3034
3262
  - You do not need to specify this parameter for basic networks.
@@ -3040,7 +3268,7 @@ class DescribeDBInstancesRequest(AbstractModel):
3040
3268
  :type SubnetId: str
3041
3269
  :param _PayMode: Billing type. Valid value: 0 (pay-as-you-go)
3042
3270
  :type PayMode: int
3043
- :param _Limit: Number of results returned per request. Default value: `20`. Value range: [1,100].
3271
+ :param _Limit: Number of entries returned per request. The default value is 20, and the value range is (1, 100].
3044
3272
  :type Limit: int
3045
3273
  :param _Offset: Offset. Default value: `0`.
3046
3274
  :type Offset: int
@@ -3074,7 +3302,7 @@ class DescribeDBInstancesRequest(AbstractModel):
3074
3302
 
3075
3303
  @property
3076
3304
  def InstanceIds(self):
3077
- r"""Instance ID list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
3305
+ r"""Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3078
3306
  :rtype: list of str
3079
3307
  """
3080
3308
  return self._InstanceIds
@@ -3085,7 +3313,12 @@ class DescribeDBInstancesRequest(AbstractModel):
3085
3313
 
3086
3314
  @property
3087
3315
  def InstanceType(self):
3088
- r"""Specifies the instance type for querying.<ul><li>0: all instances.</li><li>1: formal instance.</li><li>3: read-only instance.</li><li>4: disaster recovery instance.</li></ul>
3316
+ r"""Specifies the instance type for querying. Valid values:
3317
+ - 0: all instances.
3318
+ - 1: formal instance.
3319
+ - 2: temporary instance.
3320
+ - 3: read-only instance.
3321
+ - -1: the query range includes the formal, read-only, and disaster recovery instances simultaneously.
3089
3322
  :rtype: int
3090
3323
  """
3091
3324
  return self._InstanceType
@@ -3096,7 +3329,10 @@ class DescribeDBInstancesRequest(AbstractModel):
3096
3329
 
3097
3330
  @property
3098
3331
  def ClusterType(self):
3099
- r"""Specifies the cluster type of the queried instance.<ul><li>0: replica set instance.</li><li>1: sharded cluster instance.</li><li>-1: replica set and sharded cluster instance.</li></ul>
3332
+ r"""Specifies the cluster type of the instance to be queried. Valid values:
3333
+ - 0: replica set instance.
3334
+ - 1: sharded cluster instance.
3335
+ - -1: replica set and sharded cluster instance.
3100
3336
  :rtype: int
3101
3337
  """
3102
3338
  return self._ClusterType
@@ -3107,7 +3343,12 @@ class DescribeDBInstancesRequest(AbstractModel):
3107
3343
 
3108
3344
  @property
3109
3345
  def Status(self):
3110
- r"""Specify the current status of the queried instance.<ul><li>0: pending initialization.</li><li>1: processing, such as modifying specifications or modifying parameters.</li><li>2: instance running normally.</li><li>-2: instance expired.</li></ul>
3346
+ r"""Specifies the current status of the instance to be queried. Valid values:
3347
+ - 0: to be initialized.
3348
+ - 1: processing, such as specification changes and parameter modifications.
3349
+ - 2: running normally.
3350
+ - -2: isolated (yearly/monthly subscription).
3351
+ - -3: isolated (pay-as-you-go).
3111
3352
  :rtype: list of int
3112
3353
  """
3113
3354
  return self._Status
@@ -3155,7 +3396,7 @@ class DescribeDBInstancesRequest(AbstractModel):
3155
3396
 
3156
3397
  @property
3157
3398
  def Limit(self):
3158
- r"""Number of results returned per request. Default value: `20`. Value range: [1,100].
3399
+ r"""Number of entries returned per request. The default value is 20, and the value range is (1, 100].
3159
3400
  :rtype: int
3160
3401
  """
3161
3402
  return self._Limit
@@ -3326,6 +3567,284 @@ class DescribeDBInstancesResponse(AbstractModel):
3326
3567
  self._RequestId = params.get("RequestId")
3327
3568
 
3328
3569
 
3570
+ class DescribeDetailedSlowLogsRequest(AbstractModel):
3571
+ r"""DescribeDetailedSlowLogs request structure.
3572
+
3573
+ """
3574
+
3575
+ def __init__(self):
3576
+ r"""
3577
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3578
+ :type InstanceId: str
3579
+ :param _StartTime: Specifies the start time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3580
+ :type StartTime: str
3581
+ :param _EndTime: Specifies the end time for querying slow logs.
3582
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.
3583
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3584
+ :type EndTime: str
3585
+ :param _ExecTime: Specifies the threshold for querying slow logs, in milliseconds. It indicates that the execution time of the slow log query exceeds this value. The default value is 100.
3586
+ :type ExecTime: int
3587
+ :param _Commands: Specifies the command type for querying slow logs.
3588
+ :type Commands: list of str
3589
+ :param _Texts: Full-text search keyword. The logical operator among multiple keywords is OR.
3590
+ :type Texts: list of str
3591
+ :param _NodeNames: Specifies the node name for querying slow logs. The [DescribeDBInstanceNodeProperty](https://www.tencentcloud.comom/document/product/240/82022?from_cn_redirect=1) API can be called to query the node name.
3592
+ :type NodeNames: list of str
3593
+ :param _QueryHash: Specifies the queryHash value to be queried.
3594
+ :type QueryHash: list of str
3595
+ :param _Offset: Pagination offset. The default value is 0, and the value range is [0, 100].
3596
+
3597
+ :type Offset: int
3598
+ :param _Limit: Number of returned entries. The default value is 20, and the value range is [0, 10000].
3599
+ :type Limit: int
3600
+ :param _OrderBy: Specifies the sorting condition for slow logs.
3601
+ - StartTime: sort by the generation time of slow logs.
3602
+ - ExecTime: sort by the execution time of slow logs.
3603
+ :type OrderBy: str
3604
+ :param _OrderByType: Specifies the sorting method.
3605
+ - desc: descending order.
3606
+ - asc: ascending order.
3607
+ :type OrderByType: str
3608
+ """
3609
+ self._InstanceId = None
3610
+ self._StartTime = None
3611
+ self._EndTime = None
3612
+ self._ExecTime = None
3613
+ self._Commands = None
3614
+ self._Texts = None
3615
+ self._NodeNames = None
3616
+ self._QueryHash = None
3617
+ self._Offset = None
3618
+ self._Limit = None
3619
+ self._OrderBy = None
3620
+ self._OrderByType = None
3621
+
3622
+ @property
3623
+ def InstanceId(self):
3624
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3625
+ :rtype: str
3626
+ """
3627
+ return self._InstanceId
3628
+
3629
+ @InstanceId.setter
3630
+ def InstanceId(self, InstanceId):
3631
+ self._InstanceId = InstanceId
3632
+
3633
+ @property
3634
+ def StartTime(self):
3635
+ r"""Specifies the start time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3636
+ :rtype: str
3637
+ """
3638
+ return self._StartTime
3639
+
3640
+ @StartTime.setter
3641
+ def StartTime(self, StartTime):
3642
+ self._StartTime = StartTime
3643
+
3644
+ @property
3645
+ def EndTime(self):
3646
+ r"""Specifies the end time for querying slow logs.
3647
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.
3648
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3649
+ :rtype: str
3650
+ """
3651
+ return self._EndTime
3652
+
3653
+ @EndTime.setter
3654
+ def EndTime(self, EndTime):
3655
+ self._EndTime = EndTime
3656
+
3657
+ @property
3658
+ def ExecTime(self):
3659
+ r"""Specifies the threshold for querying slow logs, in milliseconds. It indicates that the execution time of the slow log query exceeds this value. The default value is 100.
3660
+ :rtype: int
3661
+ """
3662
+ return self._ExecTime
3663
+
3664
+ @ExecTime.setter
3665
+ def ExecTime(self, ExecTime):
3666
+ self._ExecTime = ExecTime
3667
+
3668
+ @property
3669
+ def Commands(self):
3670
+ r"""Specifies the command type for querying slow logs.
3671
+ :rtype: list of str
3672
+ """
3673
+ return self._Commands
3674
+
3675
+ @Commands.setter
3676
+ def Commands(self, Commands):
3677
+ self._Commands = Commands
3678
+
3679
+ @property
3680
+ def Texts(self):
3681
+ r"""Full-text search keyword. The logical operator among multiple keywords is OR.
3682
+ :rtype: list of str
3683
+ """
3684
+ return self._Texts
3685
+
3686
+ @Texts.setter
3687
+ def Texts(self, Texts):
3688
+ self._Texts = Texts
3689
+
3690
+ @property
3691
+ def NodeNames(self):
3692
+ r"""Specifies the node name for querying slow logs. The [DescribeDBInstanceNodeProperty](https://www.tencentcloud.comom/document/product/240/82022?from_cn_redirect=1) API can be called to query the node name.
3693
+ :rtype: list of str
3694
+ """
3695
+ return self._NodeNames
3696
+
3697
+ @NodeNames.setter
3698
+ def NodeNames(self, NodeNames):
3699
+ self._NodeNames = NodeNames
3700
+
3701
+ @property
3702
+ def QueryHash(self):
3703
+ r"""Specifies the queryHash value to be queried.
3704
+ :rtype: list of str
3705
+ """
3706
+ return self._QueryHash
3707
+
3708
+ @QueryHash.setter
3709
+ def QueryHash(self, QueryHash):
3710
+ self._QueryHash = QueryHash
3711
+
3712
+ @property
3713
+ def Offset(self):
3714
+ r"""Pagination offset. The default value is 0, and the value range is [0, 100].
3715
+
3716
+ :rtype: int
3717
+ """
3718
+ return self._Offset
3719
+
3720
+ @Offset.setter
3721
+ def Offset(self, Offset):
3722
+ self._Offset = Offset
3723
+
3724
+ @property
3725
+ def Limit(self):
3726
+ r"""Number of returned entries. The default value is 20, and the value range is [0, 10000].
3727
+ :rtype: int
3728
+ """
3729
+ return self._Limit
3730
+
3731
+ @Limit.setter
3732
+ def Limit(self, Limit):
3733
+ self._Limit = Limit
3734
+
3735
+ @property
3736
+ def OrderBy(self):
3737
+ r"""Specifies the sorting condition for slow logs.
3738
+ - StartTime: sort by the generation time of slow logs.
3739
+ - ExecTime: sort by the execution time of slow logs.
3740
+ :rtype: str
3741
+ """
3742
+ return self._OrderBy
3743
+
3744
+ @OrderBy.setter
3745
+ def OrderBy(self, OrderBy):
3746
+ self._OrderBy = OrderBy
3747
+
3748
+ @property
3749
+ def OrderByType(self):
3750
+ r"""Specifies the sorting method.
3751
+ - desc: descending order.
3752
+ - asc: ascending order.
3753
+ :rtype: str
3754
+ """
3755
+ return self._OrderByType
3756
+
3757
+ @OrderByType.setter
3758
+ def OrderByType(self, OrderByType):
3759
+ self._OrderByType = OrderByType
3760
+
3761
+
3762
+ def _deserialize(self, params):
3763
+ self._InstanceId = params.get("InstanceId")
3764
+ self._StartTime = params.get("StartTime")
3765
+ self._EndTime = params.get("EndTime")
3766
+ self._ExecTime = params.get("ExecTime")
3767
+ self._Commands = params.get("Commands")
3768
+ self._Texts = params.get("Texts")
3769
+ self._NodeNames = params.get("NodeNames")
3770
+ self._QueryHash = params.get("QueryHash")
3771
+ self._Offset = params.get("Offset")
3772
+ self._Limit = params.get("Limit")
3773
+ self._OrderBy = params.get("OrderBy")
3774
+ self._OrderByType = params.get("OrderByType")
3775
+ memeber_set = set(params.keys())
3776
+ for name, value in vars(self).items():
3777
+ property_name = name[1:]
3778
+ if property_name in memeber_set:
3779
+ memeber_set.remove(property_name)
3780
+ if len(memeber_set) > 0:
3781
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
3782
+
3783
+
3784
+
3785
+ class DescribeDetailedSlowLogsResponse(AbstractModel):
3786
+ r"""DescribeDetailedSlowLogs response structure.
3787
+
3788
+ """
3789
+
3790
+ def __init__(self):
3791
+ r"""
3792
+ :param _TotalCount: Number of slow logs that meet the conditions.
3793
+ :type TotalCount: int
3794
+ :param _DetailedSlowLogs: Slow log details.
3795
+ :type DetailedSlowLogs: list of SlowLogItem
3796
+ :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3797
+ :type RequestId: str
3798
+ """
3799
+ self._TotalCount = None
3800
+ self._DetailedSlowLogs = None
3801
+ self._RequestId = None
3802
+
3803
+ @property
3804
+ def TotalCount(self):
3805
+ r"""Number of slow logs that meet the conditions.
3806
+ :rtype: int
3807
+ """
3808
+ return self._TotalCount
3809
+
3810
+ @TotalCount.setter
3811
+ def TotalCount(self, TotalCount):
3812
+ self._TotalCount = TotalCount
3813
+
3814
+ @property
3815
+ def DetailedSlowLogs(self):
3816
+ r"""Slow log details.
3817
+ :rtype: list of SlowLogItem
3818
+ """
3819
+ return self._DetailedSlowLogs
3820
+
3821
+ @DetailedSlowLogs.setter
3822
+ def DetailedSlowLogs(self, DetailedSlowLogs):
3823
+ self._DetailedSlowLogs = DetailedSlowLogs
3824
+
3825
+ @property
3826
+ def RequestId(self):
3827
+ r"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3828
+ :rtype: str
3829
+ """
3830
+ return self._RequestId
3831
+
3832
+ @RequestId.setter
3833
+ def RequestId(self, RequestId):
3834
+ self._RequestId = RequestId
3835
+
3836
+
3837
+ def _deserialize(self, params):
3838
+ self._TotalCount = params.get("TotalCount")
3839
+ if params.get("DetailedSlowLogs") is not None:
3840
+ self._DetailedSlowLogs = []
3841
+ for item in params.get("DetailedSlowLogs"):
3842
+ obj = SlowLogItem()
3843
+ obj._deserialize(item)
3844
+ self._DetailedSlowLogs.append(obj)
3845
+ self._RequestId = params.get("RequestId")
3846
+
3847
+
3329
3848
  class DescribeInstanceParamsRequest(AbstractModel):
3330
3849
  r"""DescribeInstanceParams request structure.
3331
3850
 
@@ -3492,14 +4011,14 @@ class DescribeSecurityGroupRequest(AbstractModel):
3492
4011
 
3493
4012
  def __init__(self):
3494
4013
  r"""
3495
- :param _InstanceId: Instance ID. For example, cmgo-p8vn****.
4014
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3496
4015
  :type InstanceId: str
3497
4016
  """
3498
4017
  self._InstanceId = None
3499
4018
 
3500
4019
  @property
3501
4020
  def InstanceId(self):
3502
- r"""Instance ID. For example, cmgo-p8vn****.
4021
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3503
4022
  :rtype: str
3504
4023
  """
3505
4024
  return self._InstanceId
@@ -3576,11 +4095,15 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
3576
4095
 
3577
4096
  def __init__(self):
3578
4097
  r"""
3579
- :param _InstanceId: Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page
4098
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3580
4099
  :type InstanceId: str
3581
- :param _StartTime: Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4100
+ :param _StartTime: Slow log start time.
4101
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00.
4102
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3582
4103
  :type StartTime: str
3583
- :param _EndTime: End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4104
+ :param _EndTime: Slow log end time.
4105
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.
4106
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3584
4107
  :type EndTime: str
3585
4108
  :param _SlowMS: Threshold of slow log execution time in milliseconds. Minimum value: 100. Slow logs whose execution time exceeds the threshold will be returned.
3586
4109
  :type SlowMS: int
@@ -3601,7 +4124,7 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
3601
4124
 
3602
4125
  @property
3603
4126
  def InstanceId(self):
3604
- r"""Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page
4127
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3605
4128
  :rtype: str
3606
4129
  """
3607
4130
  return self._InstanceId
@@ -3612,7 +4135,9 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
3612
4135
 
3613
4136
  @property
3614
4137
  def StartTime(self):
3615
- r"""Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4138
+ r"""Slow log start time.
4139
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00.
4140
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3616
4141
  :rtype: str
3617
4142
  """
3618
4143
  return self._StartTime
@@ -3623,7 +4148,9 @@ class DescribeSlowLogPatternsRequest(AbstractModel):
3623
4148
 
3624
4149
  @property
3625
4150
  def EndTime(self):
3626
- r"""End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4151
+ r"""Slow log end time.
4152
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.
4153
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3627
4154
  :rtype: str
3628
4155
  """
3629
4156
  return self._EndTime
@@ -3765,11 +4292,14 @@ class DescribeSlowLogsRequest(AbstractModel):
3765
4292
 
3766
4293
  def __init__(self):
3767
4294
  r"""
3768
- :param _InstanceId: Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page
4295
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3769
4296
  :type InstanceId: str
3770
- :param _StartTime: Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4297
+ :param _StartTime: Slow log start time.
4298
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00.
4299
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3771
4300
  :type StartTime: str
3772
- :param _EndTime: End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4301
+ :param _EndTime: Slow log end time.
4302
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3773
4303
  :type EndTime: str
3774
4304
  :param _SlowMS: Threshold of slow log execution time in milliseconds. Minimum value: 100. Slow logs whose execution time exceeds the threshold will be returned.
3775
4305
  :type SlowMS: int
@@ -3790,7 +4320,7 @@ class DescribeSlowLogsRequest(AbstractModel):
3790
4320
 
3791
4321
  @property
3792
4322
  def InstanceId(self):
3793
- r"""Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page
4323
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
3794
4324
  :rtype: str
3795
4325
  """
3796
4326
  return self._InstanceId
@@ -3801,7 +4331,9 @@ class DescribeSlowLogsRequest(AbstractModel):
3801
4331
 
3802
4332
  @property
3803
4333
  def StartTime(self):
3804
- r"""Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4334
+ r"""Slow log start time.
4335
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00.
4336
+ - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3805
4337
  :rtype: str
3806
4338
  """
3807
4339
  return self._StartTime
@@ -3812,7 +4344,8 @@ class DescribeSlowLogsRequest(AbstractModel):
3812
4344
 
3813
4345
  @property
3814
4346
  def EndTime(self):
3815
- r"""End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
4347
+ r"""Slow log end time.
4348
+ - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.
3816
4349
  :rtype: str
3817
4350
  """
3818
4351
  return self._EndTime
@@ -3891,7 +4424,7 @@ class DescribeSlowLogsResponse(AbstractModel):
3891
4424
 
3892
4425
  def __init__(self):
3893
4426
  r"""
3894
- :param _Count: Total number of slow logs
4427
+ :param _Count: Total number of slow logs.
3895
4428
  :type Count: int
3896
4429
  :param _SlowLogs: Slow log details.
3897
4430
  :type SlowLogs: list of str
@@ -3904,7 +4437,7 @@ class DescribeSlowLogsResponse(AbstractModel):
3904
4437
 
3905
4438
  @property
3906
4439
  def Count(self):
3907
- r"""Total number of slow logs
4440
+ r"""Total number of slow logs.
3908
4441
  :rtype: int
3909
4442
  """
3910
4443
  return self._Count
@@ -3949,14 +4482,14 @@ class DescribeSpecInfoRequest(AbstractModel):
3949
4482
 
3950
4483
  def __init__(self):
3951
4484
  r"""
3952
- :param _Zone: AZ to be queried
4485
+ :param _Zone: AZ to be queried. For currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
3953
4486
  :type Zone: str
3954
4487
  """
3955
4488
  self._Zone = None
3956
4489
 
3957
4490
  @property
3958
4491
  def Zone(self):
3959
- r"""AZ to be queried
4492
+ r"""AZ to be queried. For currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
3960
4493
  :rtype: str
3961
4494
  """
3962
4495
  return self._Zone
@@ -3985,7 +4518,7 @@ class DescribeSpecInfoResponse(AbstractModel):
3985
4518
 
3986
4519
  def __init__(self):
3987
4520
  r"""
3988
- :param _SpecInfoList: List of purchasable instance specifications
4521
+ :param _SpecInfoList: List of sales specification information on the instance.
3989
4522
  :type SpecInfoList: list of SpecificationInfo
3990
4523
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3991
4524
  :type RequestId: str
@@ -3995,7 +4528,7 @@ class DescribeSpecInfoResponse(AbstractModel):
3995
4528
 
3996
4529
  @property
3997
4530
  def SpecInfoList(self):
3998
- r"""List of purchasable instance specifications
4531
+ r"""List of sales specification information on the instance.
3999
4532
  :rtype: list of SpecificationInfo
4000
4533
  """
4001
4534
  return self._SpecInfoList
@@ -4097,10 +4630,10 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
4097
4630
 
4098
4631
  def __init__(self):
4099
4632
  r"""
4100
- :param _Zone: Instance region name in the format of ap-guangzhou-2.
4633
+ :param _Zone: Region and AZ information of the instance. For details, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
4101
4634
  :type Zone: str
4102
- :param _NodeNum: - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set.
4103
- - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard.
4635
+ :param _NodeNum: -Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set.
4636
+ - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard.
4104
4637
  :type NodeNum: int
4105
4638
  :param _Memory: Instance memory size.
4106
4639
 
@@ -4111,13 +4644,13 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
4111
4644
  - Unit: GB.
4112
4645
  - For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The MinStorage and MaxStorage parameters in the returned data structure SpecItems correspond to the minimum and maximum disk specifications, respectively.
4113
4646
  :type Volume: int
4114
- :param _MongoVersion: Instance version information. For specific supported versions, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported for instances. The correspondence between version information and version number is as follows:
4115
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
4116
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
4117
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
4118
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
4119
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
4120
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
4647
+ :param _MongoVersion: Instance version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain specific supported versions. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported by instances. The corresponding relationship between version information and version number is as follows:
4648
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
4649
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
4650
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
4651
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
4652
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
4653
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
4121
4654
  :type MongoVersion: str
4122
4655
  :param _MachineCode: Product specification type.
4123
4656
  - HIO10G: general high-I/O 10GE type.
@@ -4173,7 +4706,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
4173
4706
 
4174
4707
  @property
4175
4708
  def Zone(self):
4176
- r"""Instance region name in the format of ap-guangzhou-2.
4709
+ r"""Region and AZ information of the instance. For details, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
4177
4710
  :rtype: str
4178
4711
  """
4179
4712
  return self._Zone
@@ -4184,8 +4717,8 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
4184
4717
 
4185
4718
  @property
4186
4719
  def NodeNum(self):
4187
- r""" - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set.
4188
- - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard.
4720
+ r"""-Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set.
4721
+ - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard.
4189
4722
  :rtype: int
4190
4723
  """
4191
4724
  return self._NodeNum
@@ -4223,13 +4756,13 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
4223
4756
 
4224
4757
  @property
4225
4758
  def MongoVersion(self):
4226
- r"""Instance version information. For specific supported versions, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported for instances. The correspondence between version information and version number is as follows:
4227
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
4228
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
4229
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
4230
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
4231
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
4232
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
4759
+ r"""Instance version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain specific supported versions. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported by instances. The corresponding relationship between version information and version number is as follows:
4760
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
4761
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
4762
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
4763
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
4764
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
4765
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
4233
4766
  :rtype: str
4234
4767
  """
4235
4768
  return self._MongoVersion
@@ -4460,15 +4993,19 @@ class InquirePriceModifyDBInstanceSpecRequest(AbstractModel):
4460
4993
 
4461
4994
  def __init__(self):
4462
4995
  r"""
4463
- :param _InstanceId: Instance ID in the format of cmgo-p8vn****. It is the same as the instance ID displayed in the TencentDB console.
4996
+ :param _InstanceId: Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
4464
4997
  :type InstanceId: str
4465
- :param _Memory: Instance memory size in GB after specification adjustment.
4998
+ :param _Memory: Instance memory size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the specific sales specifications for memory.
4466
4999
  :type Memory: int
4467
- :param _Volume: Instance disk size in GB after specification adjustment.
5000
+ :param _Volume: Instance disk size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the maximum and minimum disk sizes corresponding to each CPU specification.
4468
5001
  :type Volume: int
4469
- :param _NodeNum: Number of instance nodes. The number of nodes is left unchanged by default and cannot be changed currently.
5002
+ :param _NodeNum: Number of instance nodes. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the number of instance nodes.
5003
+ - Replica set instance, which refers to the number of primary and secondary nodes for the instance after configuration changes.
5004
+ - Sharded cluster instance, which refers to the number of primary and secondary nodes per shard for the instance after configuration changes.
5005
+ **Note**: Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously.
4470
5006
  :type NodeNum: int
4471
- :param _ReplicateSetNum: Number of instance shards. The number of shards is left unchanged by default and cannot be changed currently.
5007
+ :param _ReplicateSetNum: Sharded cluster instance, which refers to the number of shards for the instance after configuration changes. Value range: [2, 36].
5008
+ **Note**: The number of shards after changes cannot be less than the current number. Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously.
4472
5009
  :type ReplicateSetNum: int
4473
5010
  """
4474
5011
  self._InstanceId = None
@@ -4479,7 +5016,7 @@ class InquirePriceModifyDBInstanceSpecRequest(AbstractModel):
4479
5016
 
4480
5017
  @property
4481
5018
  def InstanceId(self):
4482
- r"""Instance ID in the format of cmgo-p8vn****. It is the same as the instance ID displayed in the TencentDB console.
5019
+ r"""Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
4483
5020
  :rtype: str
4484
5021
  """
4485
5022
  return self._InstanceId
@@ -4490,7 +5027,7 @@ class InquirePriceModifyDBInstanceSpecRequest(AbstractModel):
4490
5027
 
4491
5028
  @property
4492
5029
  def Memory(self):
4493
- r"""Instance memory size in GB after specification adjustment.
5030
+ r"""Instance memory size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the specific sales specifications for memory.
4494
5031
  :rtype: int
4495
5032
  """
4496
5033
  return self._Memory
@@ -4501,7 +5038,7 @@ class InquirePriceModifyDBInstanceSpecRequest(AbstractModel):
4501
5038
 
4502
5039
  @property
4503
5040
  def Volume(self):
4504
- r"""Instance disk size in GB after specification adjustment.
5041
+ r"""Instance disk size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the maximum and minimum disk sizes corresponding to each CPU specification.
4505
5042
  :rtype: int
4506
5043
  """
4507
5044
  return self._Volume
@@ -4512,7 +5049,10 @@ class InquirePriceModifyDBInstanceSpecRequest(AbstractModel):
4512
5049
 
4513
5050
  @property
4514
5051
  def NodeNum(self):
4515
- r"""Number of instance nodes. The number of nodes is left unchanged by default and cannot be changed currently.
5052
+ r"""Number of instance nodes. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the number of instance nodes.
5053
+ - Replica set instance, which refers to the number of primary and secondary nodes for the instance after configuration changes.
5054
+ - Sharded cluster instance, which refers to the number of primary and secondary nodes per shard for the instance after configuration changes.
5055
+ **Note**: Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously.
4516
5056
  :rtype: int
4517
5057
  """
4518
5058
  return self._NodeNum
@@ -4523,7 +5063,8 @@ class InquirePriceModifyDBInstanceSpecRequest(AbstractModel):
4523
5063
 
4524
5064
  @property
4525
5065
  def ReplicateSetNum(self):
4526
- r"""Number of instance shards. The number of shards is left unchanged by default and cannot be changed currently.
5066
+ r"""Sharded cluster instance, which refers to the number of shards for the instance after configuration changes. Value range: [2, 36].
5067
+ **Note**: The number of shards after changes cannot be less than the current number. Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously.
4527
5068
  :rtype: int
4528
5069
  """
4529
5070
  return self._ReplicateSetNum
@@ -4750,33 +5291,42 @@ class InstanceChargePrepaid(AbstractModel):
4750
5291
 
4751
5292
 
4752
5293
  class InstanceDetail(AbstractModel):
4753
- r"""Instance details
5294
+ r"""Instance details.
4754
5295
 
4755
5296
  """
4756
5297
 
4757
5298
  def __init__(self):
4758
5299
  r"""
4759
- :param _InstanceId: Instance ID
5300
+ :param _InstanceId: Instance ID.
4760
5301
  :type InstanceId: str
4761
5302
  :param _InstanceName: Instance name
4762
5303
  :type InstanceName: str
4763
5304
  :param _PayMode: Billing type. Valid value: 0 (pay-as-you-go)
4764
5305
  :type PayMode: int
4765
- :param _ProjectId: Project ID
5306
+ :param _ProjectId: Project ID.
4766
5307
  :type ProjectId: int
4767
- :param _ClusterType: Cluster type. Valid values: `0` (replica set instance), `1` (sharded instance).
5308
+ :param _ClusterType: Cluster type.
5309
+ - 0: replica set instance.
5310
+ - 1: sharded cluster instance.
4768
5311
  :type ClusterType: int
4769
5312
  :param _Region: Region information
4770
5313
  :type Region: str
4771
5314
  :param _Zone: AZ information
4772
5315
  :type Zone: str
4773
- :param _NetType: Network type. Valid values: 0 (basic network), 1 (VPC)
5316
+ :param _NetType: Network type.
5317
+ - 0: basic network.
5318
+ - 1: VPC.
4774
5319
  :type NetType: int
4775
5320
  :param _VpcId: VPC ID
4776
5321
  :type VpcId: str
4777
5322
  :param _SubnetId: Subnet ID of VPC
4778
5323
  :type SubnetId: str
4779
- :param _Status: Instance status. Valid values: 0: creating; 1: processing; 2: running; -2: expired.
5324
+ :param _Status: Instance status.
5325
+ - 0: to be initialized.
5326
+ - 1: processing, such as specification changes and parameter modifications.
5327
+ - 2: running normally.
5328
+ - -2: isolated (yearly/monthly subscription).
5329
+ - -3: isolated (pay-as-you-go).
4780
5330
  :type Status: int
4781
5331
  :param _Vip: Instance IP
4782
5332
  :type Vip: str
@@ -4786,23 +5336,35 @@ class InstanceDetail(AbstractModel):
4786
5336
  :type CreateTime: str
4787
5337
  :param _DeadLine: Instance expiration time
4788
5338
  :type DeadLine: str
4789
- :param _MongoVersion: Instance version information
5339
+ :param _MongoVersion: Storage engine version information on instances.
5340
+ - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
5341
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
5342
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
5343
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
5344
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
5345
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
5346
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
4790
5347
  :type MongoVersion: str
4791
- :param _Memory: Instance memory size in MB
5348
+ :param _Memory: Instance memory specification, in MB.
4792
5349
  :type Memory: int
4793
- :param _Volume: Instance disk size in MB
5350
+ :param _Volume: Instance disk specification, in MB.
4794
5351
  :type Volume: int
4795
- :param _CpuNum: Number of CPU cores of an instance
5352
+ :param _CpuNum: Number of the instance CPU cores.
4796
5353
  :type CpuNum: int
4797
- :param _MachineType: Instance machine type
5354
+ :param _MachineType: Instance machine type.
5355
+ - HIO10G: general HIO 10GE type.
5356
+ - HCD: Cloud Disk Edition type.
4798
5357
  :type MachineType: str
4799
5358
  :param _SecondaryNum: Number of secondary nodes of an instance
4800
5359
  :type SecondaryNum: int
4801
5360
  :param _ReplicationSetNum: Number of instance shards
4802
5361
  :type ReplicationSetNum: int
4803
- :param _AutoRenewFlag: Instance auto-renewal flag. Valid values: `0` (manual renewal), `1` (auto-renewal), `2` (no renewal upon expiration)
5362
+ :param _AutoRenewFlag: Automatic renewal flag for the instance.
5363
+ - 0: manual renewal.
5364
+ - 1: automatic renewal.
5365
+ - 2: no renewal after confirmation.
4804
5366
  :type AutoRenewFlag: int
4805
- :param _UsedVolume: Used capacity in MB
5367
+ :param _UsedVolume: Used capacity, in MB.
4806
5368
  :type UsedVolume: int
4807
5369
  :param _MaintenanceStart: Start time of the maintenance time
4808
5370
  :type MaintenanceStart: str
@@ -4824,25 +5386,30 @@ class InstanceDetail(AbstractModel):
4824
5386
  :type InstanceVer: int
4825
5387
  :param _ClusterVer: Instance version
4826
5388
  :type ClusterVer: int
4827
- :param _Protocol: Protocol information. Valid values: `1` (mongodb), `2` (dynamodb).
5389
+ :param _Protocol: Protocol information: mongodb.
4828
5390
  :type Protocol: int
4829
- :param _InstanceType: Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
5391
+ :param _InstanceType: Instance type.
5392
+ - 0: all instances.
5393
+ - 1: formal instance.
5394
+ - 2: temporary instance.
5395
+ - 3: read-only instance.
5396
+ - -1: include the formal, read-only, and disaster recovery instance simultaneously.
4830
5397
  :type InstanceType: int
4831
- :param _InstanceStatusDesc: Instance status description
5398
+ :param _InstanceStatusDesc: Instance status description.
4832
5399
  :type InstanceStatusDesc: str
4833
- :param _RealInstanceId: Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
5400
+ :param _RealInstanceId: Physical instance ID corresponding to the instance. The instances that have been rolled back and replaced have different InstanceIds and RealInstanceIds, which need to be obtained through the physical ID in scenarios such as obtaining monitoring data from Barad.
4834
5401
  :type RealInstanceId: str
4835
5402
  :param _MongosNodeNum: Number of Mongos nodes.
4836
5403
  :type MongosNodeNum: int
4837
- :param _MongosMemory: Mongos node memory.
5404
+ :param _MongosMemory: Mongos node memory, in MB.
4838
5405
  :type MongosMemory: int
4839
5406
  :param _MongosCpuNum: Number of Mongos node CPU cores.
4840
5407
  :type MongosCpuNum: int
4841
5408
  :param _ConfigServerNodeNum: Number of ConfigServer nodes.
4842
5409
  :type ConfigServerNodeNum: int
4843
- :param _ConfigServerMemory: ConfigServer node memory.
5410
+ :param _ConfigServerMemory: Config Server node memory, in MB.
4844
5411
  :type ConfigServerMemory: int
4845
- :param _ConfigServerVolume: ConfigServer node disk size.
5412
+ :param _ConfigServerVolume: Config Server node disk size, in MB.
4846
5413
  :type ConfigServerVolume: int
4847
5414
  :param _ConfigServerCpuNum: Number of ConfigServer node CPU cores.
4848
5415
  :type ConfigServerCpuNum: int
@@ -4898,7 +5465,7 @@ class InstanceDetail(AbstractModel):
4898
5465
 
4899
5466
  @property
4900
5467
  def InstanceId(self):
4901
- r"""Instance ID
5468
+ r"""Instance ID.
4902
5469
  :rtype: str
4903
5470
  """
4904
5471
  return self._InstanceId
@@ -4931,7 +5498,7 @@ class InstanceDetail(AbstractModel):
4931
5498
 
4932
5499
  @property
4933
5500
  def ProjectId(self):
4934
- r"""Project ID
5501
+ r"""Project ID.
4935
5502
  :rtype: int
4936
5503
  """
4937
5504
  return self._ProjectId
@@ -4942,7 +5509,9 @@ class InstanceDetail(AbstractModel):
4942
5509
 
4943
5510
  @property
4944
5511
  def ClusterType(self):
4945
- r"""Cluster type. Valid values: `0` (replica set instance), `1` (sharded instance).
5512
+ r"""Cluster type.
5513
+ - 0: replica set instance.
5514
+ - 1: sharded cluster instance.
4946
5515
  :rtype: int
4947
5516
  """
4948
5517
  return self._ClusterType
@@ -4975,7 +5544,9 @@ class InstanceDetail(AbstractModel):
4975
5544
 
4976
5545
  @property
4977
5546
  def NetType(self):
4978
- r"""Network type. Valid values: 0 (basic network), 1 (VPC)
5547
+ r"""Network type.
5548
+ - 0: basic network.
5549
+ - 1: VPC.
4979
5550
  :rtype: int
4980
5551
  """
4981
5552
  return self._NetType
@@ -5008,7 +5579,12 @@ class InstanceDetail(AbstractModel):
5008
5579
 
5009
5580
  @property
5010
5581
  def Status(self):
5011
- r"""Instance status. Valid values: 0: creating; 1: processing; 2: running; -2: expired.
5582
+ r"""Instance status.
5583
+ - 0: to be initialized.
5584
+ - 1: processing, such as specification changes and parameter modifications.
5585
+ - 2: running normally.
5586
+ - -2: isolated (yearly/monthly subscription).
5587
+ - -3: isolated (pay-as-you-go).
5012
5588
  :rtype: int
5013
5589
  """
5014
5590
  return self._Status
@@ -5063,7 +5639,14 @@ class InstanceDetail(AbstractModel):
5063
5639
 
5064
5640
  @property
5065
5641
  def MongoVersion(self):
5066
- r"""Instance version information
5642
+ r"""Storage engine version information on instances.
5643
+ - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
5644
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
5645
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
5646
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
5647
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
5648
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
5649
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
5067
5650
  :rtype: str
5068
5651
  """
5069
5652
  return self._MongoVersion
@@ -5074,7 +5657,7 @@ class InstanceDetail(AbstractModel):
5074
5657
 
5075
5658
  @property
5076
5659
  def Memory(self):
5077
- r"""Instance memory size in MB
5660
+ r"""Instance memory specification, in MB.
5078
5661
  :rtype: int
5079
5662
  """
5080
5663
  return self._Memory
@@ -5085,7 +5668,7 @@ class InstanceDetail(AbstractModel):
5085
5668
 
5086
5669
  @property
5087
5670
  def Volume(self):
5088
- r"""Instance disk size in MB
5671
+ r"""Instance disk specification, in MB.
5089
5672
  :rtype: int
5090
5673
  """
5091
5674
  return self._Volume
@@ -5096,7 +5679,7 @@ class InstanceDetail(AbstractModel):
5096
5679
 
5097
5680
  @property
5098
5681
  def CpuNum(self):
5099
- r"""Number of CPU cores of an instance
5682
+ r"""Number of the instance CPU cores.
5100
5683
  :rtype: int
5101
5684
  """
5102
5685
  return self._CpuNum
@@ -5107,7 +5690,9 @@ class InstanceDetail(AbstractModel):
5107
5690
 
5108
5691
  @property
5109
5692
  def MachineType(self):
5110
- r"""Instance machine type
5693
+ r"""Instance machine type.
5694
+ - HIO10G: general HIO 10GE type.
5695
+ - HCD: Cloud Disk Edition type.
5111
5696
  :rtype: str
5112
5697
  """
5113
5698
  return self._MachineType
@@ -5140,7 +5725,10 @@ class InstanceDetail(AbstractModel):
5140
5725
 
5141
5726
  @property
5142
5727
  def AutoRenewFlag(self):
5143
- r"""Instance auto-renewal flag. Valid values: `0` (manual renewal), `1` (auto-renewal), `2` (no renewal upon expiration)
5728
+ r"""Automatic renewal flag for the instance.
5729
+ - 0: manual renewal.
5730
+ - 1: automatic renewal.
5731
+ - 2: no renewal after confirmation.
5144
5732
  :rtype: int
5145
5733
  """
5146
5734
  return self._AutoRenewFlag
@@ -5151,7 +5739,7 @@ class InstanceDetail(AbstractModel):
5151
5739
 
5152
5740
  @property
5153
5741
  def UsedVolume(self):
5154
- r"""Used capacity in MB
5742
+ r"""Used capacity, in MB.
5155
5743
  :rtype: int
5156
5744
  """
5157
5745
  return self._UsedVolume
@@ -5272,7 +5860,7 @@ class InstanceDetail(AbstractModel):
5272
5860
 
5273
5861
  @property
5274
5862
  def Protocol(self):
5275
- r"""Protocol information. Valid values: `1` (mongodb), `2` (dynamodb).
5863
+ r"""Protocol information: mongodb.
5276
5864
  :rtype: int
5277
5865
  """
5278
5866
  return self._Protocol
@@ -5283,7 +5871,12 @@ class InstanceDetail(AbstractModel):
5283
5871
 
5284
5872
  @property
5285
5873
  def InstanceType(self):
5286
- r"""Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
5874
+ r"""Instance type.
5875
+ - 0: all instances.
5876
+ - 1: formal instance.
5877
+ - 2: temporary instance.
5878
+ - 3: read-only instance.
5879
+ - -1: include the formal, read-only, and disaster recovery instance simultaneously.
5287
5880
  :rtype: int
5288
5881
  """
5289
5882
  return self._InstanceType
@@ -5294,7 +5887,7 @@ class InstanceDetail(AbstractModel):
5294
5887
 
5295
5888
  @property
5296
5889
  def InstanceStatusDesc(self):
5297
- r"""Instance status description
5890
+ r"""Instance status description.
5298
5891
  :rtype: str
5299
5892
  """
5300
5893
  return self._InstanceStatusDesc
@@ -5305,7 +5898,7 @@ class InstanceDetail(AbstractModel):
5305
5898
 
5306
5899
  @property
5307
5900
  def RealInstanceId(self):
5308
- r"""Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
5901
+ r"""Physical instance ID corresponding to the instance. The instances that have been rolled back and replaced have different InstanceIds and RealInstanceIds, which need to be obtained through the physical ID in scenarios such as obtaining monitoring data from Barad.
5309
5902
  :rtype: str
5310
5903
  """
5311
5904
  return self._RealInstanceId
@@ -5327,7 +5920,7 @@ class InstanceDetail(AbstractModel):
5327
5920
 
5328
5921
  @property
5329
5922
  def MongosMemory(self):
5330
- r"""Mongos node memory.
5923
+ r"""Mongos node memory, in MB.
5331
5924
  :rtype: int
5332
5925
  """
5333
5926
  return self._MongosMemory
@@ -5360,7 +5953,7 @@ class InstanceDetail(AbstractModel):
5360
5953
 
5361
5954
  @property
5362
5955
  def ConfigServerMemory(self):
5363
- r"""ConfigServer node memory.
5956
+ r"""Config Server node memory, in MB.
5364
5957
  :rtype: int
5365
5958
  """
5366
5959
  return self._ConfigServerMemory
@@ -5371,7 +5964,7 @@ class InstanceDetail(AbstractModel):
5371
5964
 
5372
5965
  @property
5373
5966
  def ConfigServerVolume(self):
5374
- r"""ConfigServer node disk size.
5967
+ r"""Config Server node disk size, in MB.
5375
5968
  :rtype: int
5376
5969
  """
5377
5970
  return self._ConfigServerVolume
@@ -6116,14 +6709,14 @@ class IsolateDBInstanceRequest(AbstractModel):
6116
6709
 
6117
6710
  def __init__(self):
6118
6711
  r"""
6119
- :param _InstanceId: Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
6712
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the ID of the instance to be isolated from the instance list.
6120
6713
  :type InstanceId: str
6121
6714
  """
6122
6715
  self._InstanceId = None
6123
6716
 
6124
6717
  @property
6125
6718
  def InstanceId(self):
6126
- r"""Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
6719
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the ID of the instance to be isolated from the instance list.
6127
6720
  :rtype: str
6128
6721
  """
6129
6722
  return self._InstanceId
@@ -6203,9 +6796,9 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
6203
6796
  - The original IP address will be released after a scheduled period. Both the original and new IP addresses are accessible before release.
6204
6797
 
6205
6798
  :type OldIpExpiredTime: int
6206
- :param _NewUniqVpcId: VPC ID after the switch. If the instance is using a basic network, this field is not required.
6799
+ :param _NewUniqVpcId: VPC ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the VPC ID.
6207
6800
  :type NewUniqVpcId: str
6208
- :param _NewUniqSubnetId: VPC subnet ID after the switch. If the instance is using a basic network, this field is not required.
6801
+ :param _NewUniqSubnetId: VPC subnet ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the subnet ID of the VPC.
6209
6802
  :type NewUniqSubnetId: str
6210
6803
  :param _NetworkAddresses: IP address information, including the new IP address and the original IP address.
6211
6804
  :type NetworkAddresses: list of ModifyNetworkAddress
@@ -6244,7 +6837,7 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
6244
6837
 
6245
6838
  @property
6246
6839
  def NewUniqVpcId(self):
6247
- r"""VPC ID after the switch. If the instance is using a basic network, this field is not required.
6840
+ r"""VPC ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the VPC ID.
6248
6841
  :rtype: str
6249
6842
  """
6250
6843
  return self._NewUniqVpcId
@@ -6255,7 +6848,7 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
6255
6848
 
6256
6849
  @property
6257
6850
  def NewUniqSubnetId(self):
6258
- r"""VPC subnet ID after the switch. If the instance is using a basic network, this field is not required.
6851
+ r"""VPC subnet ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the subnet ID of the VPC.
6259
6852
  :rtype: str
6260
6853
  """
6261
6854
  return self._NewUniqSubnetId
@@ -6347,9 +6940,10 @@ class ModifyDBInstanceSecurityGroupRequest(AbstractModel):
6347
6940
 
6348
6941
  def __init__(self):
6349
6942
  r"""
6350
- :param _InstanceId: Instance ID. For example, cmgo-7pje****.
6943
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
6351
6944
  :type InstanceId: str
6352
- :param _SecurityGroupIds: IDs of target security groups. Call the [DescribeSecurityGroup](https://intl.cloud.tencent.com/document/product/240/55675?from_cn_redirect=1) API to view IDs of specific security groups.
6945
+ :param _SecurityGroupIds: Target security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) page to copy the target security group ID.
6946
+ **Note**: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.
6353
6947
  :type SecurityGroupIds: list of str
6354
6948
  """
6355
6949
  self._InstanceId = None
@@ -6357,7 +6951,7 @@ class ModifyDBInstanceSecurityGroupRequest(AbstractModel):
6357
6951
 
6358
6952
  @property
6359
6953
  def InstanceId(self):
6360
- r"""Instance ID. For example, cmgo-7pje****.
6954
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
6361
6955
  :rtype: str
6362
6956
  """
6363
6957
  return self._InstanceId
@@ -6368,7 +6962,8 @@ class ModifyDBInstanceSecurityGroupRequest(AbstractModel):
6368
6962
 
6369
6963
  @property
6370
6964
  def SecurityGroupIds(self):
6371
- r"""IDs of target security groups. Call the [DescribeSecurityGroup](https://intl.cloud.tencent.com/document/product/240/55675?from_cn_redirect=1) API to view IDs of specific security groups.
6965
+ r"""Target security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) page to copy the target security group ID.
6966
+ **Note**: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.
6372
6967
  :rtype: list of str
6373
6968
  """
6374
6969
  return self._SecurityGroupIds
@@ -6426,14 +7021,14 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
6426
7021
 
6427
7022
  def __init__(self):
6428
7023
  r"""
6429
- :param _InstanceId: Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
6430
-
7024
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
6431
7025
  :type InstanceId: str
6432
- :param _Memory: Memory size after instance configuration modification. - Unit: GB. The current instance memory size is used by default if this parameter is left blank.<br>Note: Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.
7026
+ :param _Memory: Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).
7027
+ **Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.
6433
7028
  :type Memory: int
6434
- :param _Volume: Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank.
6435
- - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.
6436
- - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.
7029
+ :param _Volume: Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).
7030
+ - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.
7031
+ - During configuration downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity.
6437
7032
  :type Volume: int
6438
7033
  :param _OplogSize: (Deprecated) Use the independent API ResizeOplog.
6439
7034
 
@@ -6441,26 +7036,26 @@ Oplog size after instance configuration modification.
6441
7036
  - Unit: GB.
6442
7037
  - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity.
6443
7038
  :type OplogSize: int
6444
- :param _NodeNum: Number of Mongod nodes after instance modification (excluding read-only nodes).
6445
- - When the CPU and memory specifications of Mongod nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes).
6446
- - When the CPU and memory specifications of Mongos nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes).
6447
- - During node modification (all types), this parameter can be left blank or set to the number of Mongod nodes (excluding read-only nodes) after modification.
6448
- - Number of replica set nodes: Confirm the range of the number of nodes based on the MinNodeNum and MaxNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.
6449
- - Number of nodes for each shard in a sharded cluster: Confirm the range of the number of nodes based on the MinReplicateSetNodeNum and MaxReplicateSetNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.
7039
+ :param _NodeNum: Number of Mongod nodes after instance changes (excluding read-only nodes).
7040
+ - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.
7041
+ - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.
7042
+ **Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).
6450
7043
  :type NodeNum: int
6451
- :param _ReplicateSetNum: Number of shards after instance modification.
6452
- - The value range can be obtained from the **MinReplicateSetNum** and **MaxReplicateSetNum** parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API for querying saleable TencentDB for MongoDB specifications. - The value of this parameter can only be increased but not decreased.
7044
+ :param _ReplicateSetNum: Number of shards after instance changes.
7045
+ - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.
7046
+ - The number of instance shards can only be increased and cannot be decreased.
6453
7047
  :type ReplicateSetNum: int
6454
7048
  :param _InMaintenance: Switch time for instance configuration modification.
6455
7049
  - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0.
6456
7050
  - 1: Execute the configuration modification task within the maintenance window.
6457
7051
  **Note**: Adjusting the number of nodes and shards is unsupported <b>within the maintenance window</b>.
6458
7052
  :type InMaintenance: int
6459
- :param _MongosMemory: Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.
7053
+ :param _MongosMemory: Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).
6460
7054
  :type MongosMemory: str
6461
7055
  :param _AddNodeList: List of nodes to be added, containing the node type and AZ information.
6462
7056
  :type AddNodeList: list of AddNodeList
6463
- :param _RemoveNodeList: List of nodes to be deleted. Note: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.
7057
+ :param _RemoveNodeList: Deletes the node list.
7058
+ **Note**: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.
6464
7059
  :type RemoveNodeList: list of RemoveNodeList
6465
7060
  """
6466
7061
  self._InstanceId = None
@@ -6476,8 +7071,7 @@ Oplog size after instance configuration modification.
6476
7071
 
6477
7072
  @property
6478
7073
  def InstanceId(self):
6479
- r"""Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
6480
-
7074
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
6481
7075
  :rtype: str
6482
7076
  """
6483
7077
  return self._InstanceId
@@ -6488,7 +7082,8 @@ Oplog size after instance configuration modification.
6488
7082
 
6489
7083
  @property
6490
7084
  def Memory(self):
6491
- r"""Memory size after instance configuration modification. - Unit: GB. The current instance memory size is used by default if this parameter is left blank.<br>Note: Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.
7085
+ r"""Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).
7086
+ **Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.
6492
7087
  :rtype: int
6493
7088
  """
6494
7089
  return self._Memory
@@ -6499,9 +7094,9 @@ Oplog size after instance configuration modification.
6499
7094
 
6500
7095
  @property
6501
7096
  def Volume(self):
6502
- r"""Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank.
6503
- - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.
6504
- - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.
7097
+ r"""Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).
7098
+ - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time.
7099
+ - During configuration downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity.
6505
7100
  :rtype: int
6506
7101
  """
6507
7102
  return self._Volume
@@ -6531,12 +7126,10 @@ Oplog size after instance configuration modification.
6531
7126
 
6532
7127
  @property
6533
7128
  def NodeNum(self):
6534
- r"""Number of Mongod nodes after instance modification (excluding read-only nodes).
6535
- - When the CPU and memory specifications of Mongod nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes).
6536
- - When the CPU and memory specifications of Mongos nodes are modified, this parameter can be left blank or set to the current number of Mongod nodes (excluding read-only nodes).
6537
- - During node modification (all types), this parameter can be left blank or set to the number of Mongod nodes (excluding read-only nodes) after modification.
6538
- - Number of replica set nodes: Confirm the range of the number of nodes based on the MinNodeNum and MaxNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.
6539
- - Number of nodes for each shard in a sharded cluster: Confirm the range of the number of nodes based on the MinReplicateSetNodeNum and MaxReplicateSetNodeNum parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38565?from_cn_redirect=1) API for querying saleable TencenDB for MongoDB specifications.
7129
+ r"""Number of Mongod nodes after instance changes (excluding read-only nodes).
7130
+ - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.
7131
+ - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.
7132
+ **Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).
6540
7133
  :rtype: int
6541
7134
  """
6542
7135
  return self._NodeNum
@@ -6547,8 +7140,9 @@ Oplog size after instance configuration modification.
6547
7140
 
6548
7141
  @property
6549
7142
  def ReplicateSetNum(self):
6550
- r"""Number of shards after instance modification.
6551
- - The value range can be obtained from the **MinReplicateSetNum** and **MaxReplicateSetNum** parameters returned by the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API for querying saleable TencentDB for MongoDB specifications. - The value of this parameter can only be increased but not decreased.
7143
+ r"""Number of shards after instance changes.
7144
+ - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.
7145
+ - The number of instance shards can only be increased and cannot be decreased.
6552
7146
  :rtype: int
6553
7147
  """
6554
7148
  return self._ReplicateSetNum
@@ -6573,7 +7167,7 @@ Oplog size after instance configuration modification.
6573
7167
 
6574
7168
  @property
6575
7169
  def MongosMemory(self):
6576
- r"""Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.
7170
+ r"""Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).
6577
7171
  :rtype: str
6578
7172
  """
6579
7173
  return self._MongosMemory
@@ -6595,7 +7189,8 @@ Oplog size after instance configuration modification.
6595
7189
 
6596
7190
  @property
6597
7191
  def RemoveNodeList(self):
6598
- r"""List of nodes to be deleted. Note: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.
7192
+ r"""Deletes the node list.
7193
+ **Note**: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard.
6599
7194
  :rtype: list of RemoveNodeList
6600
7195
  """
6601
7196
  return self._RemoveNodeList
@@ -6737,14 +7332,14 @@ class OfflineIsolatedDBInstanceRequest(AbstractModel):
6737
7332
 
6738
7333
  def __init__(self):
6739
7334
  r"""
6740
- :param _InstanceId: Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
7335
+ :param _InstanceId: Instance ID. Log in to the [TencentDB for MongoDB console recycle bin](https://console.cloud.tencent.com/mongodb/recycle), and copy the ID of the instance to be eliminated from the instance list.
6741
7336
  :type InstanceId: str
6742
7337
  """
6743
7338
  self._InstanceId = None
6744
7339
 
6745
7340
  @property
6746
7341
  def InstanceId(self):
6747
- r"""Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
7342
+ r"""Instance ID. Log in to the [TencentDB for MongoDB console recycle bin](https://console.cloud.tencent.com/mongodb/recycle), and copy the ID of the instance to be eliminated from the instance list.
6748
7343
  :rtype: str
6749
7344
  """
6750
7345
  return self._InstanceId
@@ -6810,7 +7405,7 @@ class OfflineIsolatedDBInstanceResponse(AbstractModel):
6810
7405
 
6811
7406
 
6812
7407
  class RemoveNodeList(AbstractModel):
6813
- r"""Node details of an instance to be modified.
7408
+ r"""Node details of the instance to be modified.
6814
7409
 
6815
7410
  """
6816
7411
 
@@ -6821,14 +7416,13 @@ class RemoveNodeList(AbstractModel):
6821
7416
  - READONLY: read-only node.
6822
7417
  - MONGOS: Mongos node.
6823
7418
  :type Role: str
6824
- :param _NodeName: IDs of nodes to be deleted. For a sharded cluster instance, specify the IDs of nodes to be deleted on one shard. Nodes with the same IDs on other shards will also be deleted.
6825
-
6826
- - Obtaining method: Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/), go to the **Node Management** tab, and obtain the **node IDs**.
6827
- - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk****_0-node-primary.
7419
+ :param _NodeName: IDs of nodes to be deleted. For a sharded cluster instance, specify the names of nodes to be deleted on one shard. Nodes with the same names on other shards will also be deleted.
7420
+ - Obtaining method: Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), go to the **Node Management** tab, and obtain the **node ID**.
7421
+ - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk\*\*\*\*\_0-node-primary.
6828
7422
  :type NodeName: str
6829
- :param _Zone: AZs corresponding to the nodes.
6830
- - Single AZ: All nodes are in the same AZ.
6831
- - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any two AZs should be larger than that in the third AZ.
7423
+ :param _Zone: AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
7424
+ - Single AZ: all nodes are in the same AZ.
7425
+ - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any 2 AZs should be larger than that in the third AZ.
6832
7426
  :type Zone: str
6833
7427
  """
6834
7428
  self._Role = None
@@ -6851,10 +7445,9 @@ class RemoveNodeList(AbstractModel):
6851
7445
 
6852
7446
  @property
6853
7447
  def NodeName(self):
6854
- r"""IDs of nodes to be deleted. For a sharded cluster instance, specify the IDs of nodes to be deleted on one shard. Nodes with the same IDs on other shards will also be deleted.
6855
-
6856
- - Obtaining method: Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/), go to the **Node Management** tab, and obtain the **node IDs**.
6857
- - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk****_0-node-primary.
7448
+ r"""IDs of nodes to be deleted. For a sharded cluster instance, specify the names of nodes to be deleted on one shard. Nodes with the same names on other shards will also be deleted.
7449
+ - Obtaining method: Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), go to the **Node Management** tab, and obtain the **node ID**.
7450
+ - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk\*\*\*\*\_0-node-primary.
6858
7451
  :rtype: str
6859
7452
  """
6860
7453
  return self._NodeName
@@ -6865,9 +7458,9 @@ class RemoveNodeList(AbstractModel):
6865
7458
 
6866
7459
  @property
6867
7460
  def Zone(self):
6868
- r"""AZs corresponding to the nodes.
6869
- - Single AZ: All nodes are in the same AZ.
6870
- - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any two AZs should be larger than that in the third AZ.
7461
+ r"""AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).
7462
+ - Single AZ: all nodes are in the same AZ.
7463
+ - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any 2 AZs should be larger than that in the third AZ.
6871
7464
  :rtype: str
6872
7465
  """
6873
7466
  return self._Zone
@@ -6978,8 +7571,8 @@ class RenewDBInstancesRequest(AbstractModel):
6978
7571
  def __init__(self):
6979
7572
  r"""
6980
7573
  :param _InstanceIds: Specifies the ID or IDs of one or multiple instances to be renewed.
6981
- - You can obtain the IDs from **InstanceIds** in the return values of the [DescribeDBInstances](https://intl.cloud.tencent.com/document/product/240/38568?from_cn_redirect=1) API.
6982
- - The maximum number of instances for each renewal request is 100.
7574
+ - It can be obtained through the response parameter **InstanceId** of the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API.
7575
+ - The maximum number of instances for each renewal request is 100.
6983
7576
  :type InstanceIds: list of str
6984
7577
  :param _InstanceChargePrepaid: The parameter setting for the prepaid mode (monthly subscription mode). This parameter can specify the renewal period, whether to set automatic renewal, and other attributes of the monthly subscription instance. This parameter is mandatory in monthly subscription.
6985
7578
  :type InstanceChargePrepaid: :class:`tencentcloud.mongodb.v20190725.models.InstanceChargePrepaid`
@@ -6990,8 +7583,8 @@ class RenewDBInstancesRequest(AbstractModel):
6990
7583
  @property
6991
7584
  def InstanceIds(self):
6992
7585
  r"""Specifies the ID or IDs of one or multiple instances to be renewed.
6993
- - You can obtain the IDs from **InstanceIds** in the return values of the [DescribeDBInstances](https://intl.cloud.tencent.com/document/product/240/38568?from_cn_redirect=1) API.
6994
- - The maximum number of instances for each renewal request is 100.
7586
+ - It can be obtained through the response parameter **InstanceId** of the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API.
7587
+ - The maximum number of instances for each renewal request is 100.
6995
7588
  :rtype: list of str
6996
7589
  """
6997
7590
  return self._InstanceIds
@@ -7056,20 +7649,20 @@ class RenewDBInstancesResponse(AbstractModel):
7056
7649
 
7057
7650
 
7058
7651
  class ReplicaSetInfo(AbstractModel):
7059
- r"""Shard information
7652
+ r"""Shard information.
7060
7653
 
7061
7654
  """
7062
7655
 
7063
7656
  def __init__(self):
7064
7657
  r"""
7065
- :param _ReplicaSetId: Replica set ID
7658
+ :param _ReplicaSetId: Replica set ID.
7066
7659
  :type ReplicaSetId: str
7067
7660
  """
7068
7661
  self._ReplicaSetId = None
7069
7662
 
7070
7663
  @property
7071
7664
  def ReplicaSetId(self):
7072
- r"""Replica set ID
7665
+ r"""Replica set ID.
7073
7666
  :rtype: str
7074
7667
  """
7075
7668
  return self._ReplicaSetId
@@ -7098,11 +7691,13 @@ class ResetDBInstancePasswordRequest(AbstractModel):
7098
7691
 
7099
7692
  def __init__(self):
7100
7693
  r"""
7101
- :param _InstanceId: Instance ID
7694
+ :param _InstanceId: Specifies the instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
7102
7695
  :type InstanceId: str
7103
- :param _UserName: Instance account name
7696
+ :param _UserName: Specifies the account name for which the password needs to be changed. The [DescribeAccountUsers](https://www.tencentcloud.comom/document/product/240/80800?from_cn_redirect=1) API can be called to obtain the account list and copy the account name for which the password needs to be changed.
7104
7697
  :type UserName: str
7105
- :param _Password: New password, which must contain at least eight characters
7698
+ :param _Password: Specifies a new password for the account. Password complexity requirements:
7699
+ - It should contain 8–32 characters.
7700
+ - It should contain at least two types of the following: letters, digits, and special characters (!@#%^\*()\_).
7106
7701
  :type Password: str
7107
7702
  """
7108
7703
  self._InstanceId = None
@@ -7111,7 +7706,7 @@ class ResetDBInstancePasswordRequest(AbstractModel):
7111
7706
 
7112
7707
  @property
7113
7708
  def InstanceId(self):
7114
- r"""Instance ID
7709
+ r"""Specifies the instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
7115
7710
  :rtype: str
7116
7711
  """
7117
7712
  return self._InstanceId
@@ -7122,7 +7717,7 @@ class ResetDBInstancePasswordRequest(AbstractModel):
7122
7717
 
7123
7718
  @property
7124
7719
  def UserName(self):
7125
- r"""Instance account name
7720
+ r"""Specifies the account name for which the password needs to be changed. The [DescribeAccountUsers](https://www.tencentcloud.comom/document/product/240/80800?from_cn_redirect=1) API can be called to obtain the account list and copy the account name for which the password needs to be changed.
7126
7721
  :rtype: str
7127
7722
  """
7128
7723
  return self._UserName
@@ -7133,7 +7728,9 @@ class ResetDBInstancePasswordRequest(AbstractModel):
7133
7728
 
7134
7729
  @property
7135
7730
  def Password(self):
7136
- r"""New password, which must contain at least eight characters
7731
+ r"""Specifies a new password for the account. Password complexity requirements:
7732
+ - It should contain 8–32 characters.
7733
+ - It should contain at least two types of the following: letters, digits, and special characters (!@#%^\*()\_).
7137
7734
  :rtype: str
7138
7735
  """
7139
7736
  return self._Password
@@ -7164,7 +7761,7 @@ class ResetDBInstancePasswordResponse(AbstractModel):
7164
7761
 
7165
7762
  def __init__(self):
7166
7763
  r"""
7167
- :param _AsyncRequestId: Async request ID, which is used to query the running status of the process.
7764
+ :param _AsyncRequestId: Task request ID.
7168
7765
  :type AsyncRequestId: str
7169
7766
  :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
7170
7767
  :type RequestId: str
@@ -7174,7 +7771,7 @@ class ResetDBInstancePasswordResponse(AbstractModel):
7174
7771
 
7175
7772
  @property
7176
7773
  def AsyncRequestId(self):
7177
- r"""Async request ID, which is used to query the running status of the process.
7774
+ r"""Task request ID.
7178
7775
  :rtype: str
7179
7776
  """
7180
7777
  return self._AsyncRequestId
@@ -7207,19 +7804,19 @@ class SecurityGroup(AbstractModel):
7207
7804
 
7208
7805
  def __init__(self):
7209
7806
  r"""
7210
- :param _ProjectId: Project ID
7807
+ :param _ProjectId: Associated project ID.
7211
7808
  :type ProjectId: int
7212
- :param _CreateTime: Creation time
7809
+ :param _CreateTime: Security group creation time.
7213
7810
  :type CreateTime: str
7214
- :param _Inbound: Inbound rule
7811
+ :param _Inbound: Security group inbound rule.
7215
7812
  :type Inbound: list of SecurityGroupBound
7216
- :param _Outbound: Outbound rule
7813
+ :param _Outbound: Security group outbound rule.
7217
7814
  :type Outbound: list of SecurityGroupBound
7218
- :param _SecurityGroupId: Security group ID
7815
+ :param _SecurityGroupId: Security group ID.
7219
7816
  :type SecurityGroupId: str
7220
- :param _SecurityGroupName: Security group name
7817
+ :param _SecurityGroupName: Security group name.
7221
7818
  :type SecurityGroupName: str
7222
- :param _SecurityGroupRemark: Security group remarks
7819
+ :param _SecurityGroupRemark: Security group remarks.
7223
7820
  :type SecurityGroupRemark: str
7224
7821
  """
7225
7822
  self._ProjectId = None
@@ -7232,7 +7829,7 @@ class SecurityGroup(AbstractModel):
7232
7829
 
7233
7830
  @property
7234
7831
  def ProjectId(self):
7235
- r"""Project ID
7832
+ r"""Associated project ID.
7236
7833
  :rtype: int
7237
7834
  """
7238
7835
  return self._ProjectId
@@ -7243,7 +7840,7 @@ class SecurityGroup(AbstractModel):
7243
7840
 
7244
7841
  @property
7245
7842
  def CreateTime(self):
7246
- r"""Creation time
7843
+ r"""Security group creation time.
7247
7844
  :rtype: str
7248
7845
  """
7249
7846
  return self._CreateTime
@@ -7254,7 +7851,7 @@ class SecurityGroup(AbstractModel):
7254
7851
 
7255
7852
  @property
7256
7853
  def Inbound(self):
7257
- r"""Inbound rule
7854
+ r"""Security group inbound rule.
7258
7855
  :rtype: list of SecurityGroupBound
7259
7856
  """
7260
7857
  return self._Inbound
@@ -7265,7 +7862,7 @@ class SecurityGroup(AbstractModel):
7265
7862
 
7266
7863
  @property
7267
7864
  def Outbound(self):
7268
- r"""Outbound rule
7865
+ r"""Security group outbound rule.
7269
7866
  :rtype: list of SecurityGroupBound
7270
7867
  """
7271
7868
  return self._Outbound
@@ -7276,7 +7873,7 @@ class SecurityGroup(AbstractModel):
7276
7873
 
7277
7874
  @property
7278
7875
  def SecurityGroupId(self):
7279
- r"""Security group ID
7876
+ r"""Security group ID.
7280
7877
  :rtype: str
7281
7878
  """
7282
7879
  return self._SecurityGroupId
@@ -7287,7 +7884,7 @@ class SecurityGroup(AbstractModel):
7287
7884
 
7288
7885
  @property
7289
7886
  def SecurityGroupName(self):
7290
- r"""Security group name
7887
+ r"""Security group name.
7291
7888
  :rtype: str
7292
7889
  """
7293
7890
  return self._SecurityGroupName
@@ -7298,7 +7895,7 @@ class SecurityGroup(AbstractModel):
7298
7895
 
7299
7896
  @property
7300
7897
  def SecurityGroupRemark(self):
7301
- r"""Security group remarks
7898
+ r"""Security group remarks.
7302
7899
  :rtype: str
7303
7900
  """
7304
7901
  return self._SecurityGroupRemark
@@ -7343,21 +7940,23 @@ class SecurityGroupBound(AbstractModel):
7343
7940
 
7344
7941
  def __init__(self):
7345
7942
  r"""
7346
- :param _Action: Execution rule. Valid values: `ACCEPT`, `DROP`
7943
+ :param _Action: Execution policy.
7944
+ - ACCEPT: allow. Access requests for the port can be released.
7945
+ - DROP: reject. Data packets are discarded without any response.
7347
7946
  :type Action: str
7348
- :param _CidrIp: IP range
7947
+ :param _CidrIp: Inbound IP address or IP range for database access.
7349
7948
  :type CidrIp: str
7350
- :param _PortRange: Port range
7949
+ :param _PortRange: Port for database access.
7351
7950
  :type PortRange: str
7352
- :param _IpProtocol: Transport layer protocol. Valid values: `tcp`, `udp`, `ALL`
7951
+ :param _IpProtocol: Transport layer protocol: TCP.
7353
7952
  :type IpProtocol: str
7354
- :param _Id: All the addresses that the security group ID represents
7953
+ :param _Id: Security group ID.
7355
7954
  :type Id: str
7356
- :param _AddressModule: All the addresses that the address group ID represents
7955
+ :param _AddressModule: Parameter template ID for the IP address or IP address group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/ip) to obtain the parameter template IP address details.
7357
7956
  :type AddressModule: str
7358
- :param _ServiceModule: All the protocols and ports that the service group ID represents
7957
+ :param _ServiceModule: Parameter template ID for the protocol port or protocol port group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/protoport) to obtain the parameter template protocol port details.
7359
7958
  :type ServiceModule: str
7360
- :param _Desc: Description
7959
+ :param _Desc: Security group description information.
7361
7960
  :type Desc: str
7362
7961
  """
7363
7962
  self._Action = None
@@ -7371,7 +7970,9 @@ class SecurityGroupBound(AbstractModel):
7371
7970
 
7372
7971
  @property
7373
7972
  def Action(self):
7374
- r"""Execution rule. Valid values: `ACCEPT`, `DROP`
7973
+ r"""Execution policy.
7974
+ - ACCEPT: allow. Access requests for the port can be released.
7975
+ - DROP: reject. Data packets are discarded without any response.
7375
7976
  :rtype: str
7376
7977
  """
7377
7978
  return self._Action
@@ -7382,7 +7983,7 @@ class SecurityGroupBound(AbstractModel):
7382
7983
 
7383
7984
  @property
7384
7985
  def CidrIp(self):
7385
- r"""IP range
7986
+ r"""Inbound IP address or IP range for database access.
7386
7987
  :rtype: str
7387
7988
  """
7388
7989
  return self._CidrIp
@@ -7393,7 +7994,7 @@ class SecurityGroupBound(AbstractModel):
7393
7994
 
7394
7995
  @property
7395
7996
  def PortRange(self):
7396
- r"""Port range
7997
+ r"""Port for database access.
7397
7998
  :rtype: str
7398
7999
  """
7399
8000
  return self._PortRange
@@ -7404,7 +8005,7 @@ class SecurityGroupBound(AbstractModel):
7404
8005
 
7405
8006
  @property
7406
8007
  def IpProtocol(self):
7407
- r"""Transport layer protocol. Valid values: `tcp`, `udp`, `ALL`
8008
+ r"""Transport layer protocol: TCP.
7408
8009
  :rtype: str
7409
8010
  """
7410
8011
  return self._IpProtocol
@@ -7415,7 +8016,7 @@ class SecurityGroupBound(AbstractModel):
7415
8016
 
7416
8017
  @property
7417
8018
  def Id(self):
7418
- r"""All the addresses that the security group ID represents
8019
+ r"""Security group ID.
7419
8020
  :rtype: str
7420
8021
  """
7421
8022
  return self._Id
@@ -7426,7 +8027,7 @@ class SecurityGroupBound(AbstractModel):
7426
8027
 
7427
8028
  @property
7428
8029
  def AddressModule(self):
7429
- r"""All the addresses that the address group ID represents
8030
+ r"""Parameter template ID for the IP address or IP address group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/ip) to obtain the parameter template IP address details.
7430
8031
  :rtype: str
7431
8032
  """
7432
8033
  return self._AddressModule
@@ -7437,7 +8038,7 @@ class SecurityGroupBound(AbstractModel):
7437
8038
 
7438
8039
  @property
7439
8040
  def ServiceModule(self):
7440
- r"""All the protocols and ports that the service group ID represents
8041
+ r"""Parameter template ID for the protocol port or protocol port group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/protoport) to obtain the parameter template protocol port details.
7441
8042
  :rtype: str
7442
8043
  """
7443
8044
  return self._ServiceModule
@@ -7448,7 +8049,7 @@ class SecurityGroupBound(AbstractModel):
7448
8049
 
7449
8050
  @property
7450
8051
  def Desc(self):
7451
- r"""Description
8052
+ r"""Security group description information.
7452
8053
  :rtype: str
7453
8054
  """
7454
8055
  return self._Desc
@@ -7477,6 +8078,85 @@ class SecurityGroupBound(AbstractModel):
7477
8078
 
7478
8079
 
7479
8080
 
8081
+ class SetDBInstanceDeletionProtectionRequest(AbstractModel):
8082
+ r"""SetDBInstanceDeletionProtection request structure.
8083
+
8084
+ """
8085
+
8086
+ def __init__(self):
8087
+ r"""
8088
+ :param _InstanceIds: Instance ID list, in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page.
8089
+ :type InstanceIds: list of str
8090
+ :param _EnableDeletionProtection: Instance termination protection switch. Valid values: 0 - disabled; 1 - enabled.
8091
+ :type EnableDeletionProtection: int
8092
+ """
8093
+ self._InstanceIds = None
8094
+ self._EnableDeletionProtection = None
8095
+
8096
+ @property
8097
+ def InstanceIds(self):
8098
+ r"""Instance ID list, in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page.
8099
+ :rtype: list of str
8100
+ """
8101
+ return self._InstanceIds
8102
+
8103
+ @InstanceIds.setter
8104
+ def InstanceIds(self, InstanceIds):
8105
+ self._InstanceIds = InstanceIds
8106
+
8107
+ @property
8108
+ def EnableDeletionProtection(self):
8109
+ r"""Instance termination protection switch. Valid values: 0 - disabled; 1 - enabled.
8110
+ :rtype: int
8111
+ """
8112
+ return self._EnableDeletionProtection
8113
+
8114
+ @EnableDeletionProtection.setter
8115
+ def EnableDeletionProtection(self, EnableDeletionProtection):
8116
+ self._EnableDeletionProtection = EnableDeletionProtection
8117
+
8118
+
8119
+ def _deserialize(self, params):
8120
+ self._InstanceIds = params.get("InstanceIds")
8121
+ self._EnableDeletionProtection = params.get("EnableDeletionProtection")
8122
+ memeber_set = set(params.keys())
8123
+ for name, value in vars(self).items():
8124
+ property_name = name[1:]
8125
+ if property_name in memeber_set:
8126
+ memeber_set.remove(property_name)
8127
+ if len(memeber_set) > 0:
8128
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
8129
+
8130
+
8131
+
8132
+ class SetDBInstanceDeletionProtectionResponse(AbstractModel):
8133
+ r"""SetDBInstanceDeletionProtection response structure.
8134
+
8135
+ """
8136
+
8137
+ def __init__(self):
8138
+ r"""
8139
+ :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
8140
+ :type RequestId: str
8141
+ """
8142
+ self._RequestId = None
8143
+
8144
+ @property
8145
+ def RequestId(self):
8146
+ r"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
8147
+ :rtype: str
8148
+ """
8149
+ return self._RequestId
8150
+
8151
+ @RequestId.setter
8152
+ def RequestId(self, RequestId):
8153
+ self._RequestId = RequestId
8154
+
8155
+
8156
+ def _deserialize(self, params):
8157
+ self._RequestId = params.get("RequestId")
8158
+
8159
+
7480
8160
  class ShardInfo(AbstractModel):
7481
8161
  r"""Details of an instance shard
7482
8162
 
@@ -7618,6 +8298,72 @@ class ShardInfo(AbstractModel):
7618
8298
 
7619
8299
 
7620
8300
 
8301
+ class SlowLogItem(AbstractModel):
8302
+ r"""Slow log details.
8303
+
8304
+ """
8305
+
8306
+ def __init__(self):
8307
+ r"""
8308
+ :param _Log: Slow log details.
8309
+ :type Log: str
8310
+ :param _NodeName: Node name.
8311
+ :type NodeName: str
8312
+ :param _QueryHash: Queries the hash value.
8313
+ :type QueryHash: str
8314
+ """
8315
+ self._Log = None
8316
+ self._NodeName = None
8317
+ self._QueryHash = None
8318
+
8319
+ @property
8320
+ def Log(self):
8321
+ r"""Slow log details.
8322
+ :rtype: str
8323
+ """
8324
+ return self._Log
8325
+
8326
+ @Log.setter
8327
+ def Log(self, Log):
8328
+ self._Log = Log
8329
+
8330
+ @property
8331
+ def NodeName(self):
8332
+ r"""Node name.
8333
+ :rtype: str
8334
+ """
8335
+ return self._NodeName
8336
+
8337
+ @NodeName.setter
8338
+ def NodeName(self, NodeName):
8339
+ self._NodeName = NodeName
8340
+
8341
+ @property
8342
+ def QueryHash(self):
8343
+ r"""Queries the hash value.
8344
+ :rtype: str
8345
+ """
8346
+ return self._QueryHash
8347
+
8348
+ @QueryHash.setter
8349
+ def QueryHash(self, QueryHash):
8350
+ self._QueryHash = QueryHash
8351
+
8352
+
8353
+ def _deserialize(self, params):
8354
+ self._Log = params.get("Log")
8355
+ self._NodeName = params.get("NodeName")
8356
+ self._QueryHash = params.get("QueryHash")
8357
+ memeber_set = set(params.keys())
8358
+ for name, value in vars(self).items():
8359
+ property_name = name[1:]
8360
+ if property_name in memeber_set:
8361
+ memeber_set.remove(property_name)
8362
+ if len(memeber_set) > 0:
8363
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
8364
+
8365
+
8366
+
7621
8367
  class SlowLogPattern(AbstractModel):
7622
8368
  r"""Slow log statistics of MongoDB database
7623
8369
 
@@ -7625,23 +8371,26 @@ class SlowLogPattern(AbstractModel):
7625
8371
 
7626
8372
  def __init__(self):
7627
8373
  r"""
7628
- :param _Pattern: Slow log pattern
8374
+ :param _Pattern: Slow log output format: database name.table name.command.
7629
8375
  :type Pattern: str
7630
- :param _MaxTime: Maximum execution time
8376
+ :param _QueryHash: queryHash value carried during slow log recording. It can be used to identify a query type.
8377
+ :type QueryHash: str
8378
+ :param _MaxTime: Maximum execution time, in milliseconds.
7631
8379
  :type MaxTime: int
7632
- :param _AverageTime: Average execution time
8380
+ :param _AverageTime: Average execution time, in milliseconds.
7633
8381
  :type AverageTime: int
7634
- :param _Total: Number of slow logs in this pattern
8382
+ :param _Total: Number of slow logs.
7635
8383
  :type Total: int
7636
8384
  """
7637
8385
  self._Pattern = None
8386
+ self._QueryHash = None
7638
8387
  self._MaxTime = None
7639
8388
  self._AverageTime = None
7640
8389
  self._Total = None
7641
8390
 
7642
8391
  @property
7643
8392
  def Pattern(self):
7644
- r"""Slow log pattern
8393
+ r"""Slow log output format: database name.table name.command.
7645
8394
  :rtype: str
7646
8395
  """
7647
8396
  return self._Pattern
@@ -7650,9 +8399,20 @@ class SlowLogPattern(AbstractModel):
7650
8399
  def Pattern(self, Pattern):
7651
8400
  self._Pattern = Pattern
7652
8401
 
8402
+ @property
8403
+ def QueryHash(self):
8404
+ r"""queryHash value carried during slow log recording. It can be used to identify a query type.
8405
+ :rtype: str
8406
+ """
8407
+ return self._QueryHash
8408
+
8409
+ @QueryHash.setter
8410
+ def QueryHash(self, QueryHash):
8411
+ self._QueryHash = QueryHash
8412
+
7653
8413
  @property
7654
8414
  def MaxTime(self):
7655
- r"""Maximum execution time
8415
+ r"""Maximum execution time, in milliseconds.
7656
8416
  :rtype: int
7657
8417
  """
7658
8418
  return self._MaxTime
@@ -7663,7 +8423,7 @@ class SlowLogPattern(AbstractModel):
7663
8423
 
7664
8424
  @property
7665
8425
  def AverageTime(self):
7666
- r"""Average execution time
8426
+ r"""Average execution time, in milliseconds.
7667
8427
  :rtype: int
7668
8428
  """
7669
8429
  return self._AverageTime
@@ -7674,7 +8434,7 @@ class SlowLogPattern(AbstractModel):
7674
8434
 
7675
8435
  @property
7676
8436
  def Total(self):
7677
- r"""Number of slow logs in this pattern
8437
+ r"""Number of slow logs.
7678
8438
  :rtype: int
7679
8439
  """
7680
8440
  return self._Total
@@ -7686,6 +8446,7 @@ class SlowLogPattern(AbstractModel):
7686
8446
 
7687
8447
  def _deserialize(self, params):
7688
8448
  self._Pattern = params.get("Pattern")
8449
+ self._QueryHash = params.get("QueryHash")
7689
8450
  self._MaxTime = params.get("MaxTime")
7690
8451
  self._AverageTime = params.get("AverageTime")
7691
8452
  self._Total = params.get("Total")
@@ -7700,23 +8461,16 @@ class SlowLogPattern(AbstractModel):
7700
8461
 
7701
8462
 
7702
8463
  class SpecItem(AbstractModel):
7703
- r"""Specifications of purchasable MongoDB instances
8464
+ r"""TencentDB for MongoDB instance sales specification.
7704
8465
 
7705
8466
  """
7706
8467
 
7707
8468
  def __init__(self):
7708
8469
  r"""
7709
8470
  :param _SpecCode: Specification information identifier. Format: mongo.HIO10G.128G. It consists of three parts: node type, specification type, and memory specification.
7710
- - Node types are as follows:
7711
- - mongo: Mongod node.
7712
- - mongos: Mongos node.
7713
- - cfgstr: ConfigServer node.
7714
- - Specification types are as follows:
7715
- - HIO10G: general high-I/O 10GE type.
7716
- - HCD: cloud disk type.
7717
- - Memory specifications are as follows:
7718
- - Valid values: 4, 8, 16, 32, 64, 128, 240, and 512.
7719
- - Unit: g, indicating GB. 128g means 128 GB.
8471
+ - Node type: **mongo** indicates a Mongod node; **mongos** indicates a Mongos node; **cfgstr** indicates a ConfigServer node.
8472
+ - Specification type: **HIO10G** indicates the general HIO 10GE type; **HCD** indicates the Cloud Disk Edition type.
8473
+ - Memory specification, in GB. Valid values: 4, 8, 16, 32, 64, 128, 240, and 512. 128g indicates 128 GB.
7720
8474
  :type SpecCode: str
7721
8475
  :param _Status: Saleable specification status flag. Valid values are as follows:
7722
8476
  - 0: selling stopped.
@@ -7737,17 +8491,16 @@ class SpecItem(AbstractModel):
7737
8491
  :param _Conns: Maximum number of connections supported for the specification.
7738
8492
  :type Conns: int
7739
8493
  :param _MongoVersionCode: Storage engine version information on instances.
7740
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
7741
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
7742
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
7743
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
7744
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
7745
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
8494
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
8495
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
8496
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
8497
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
8498
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
8499
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
7746
8500
  :type MongoVersionCode: str
7747
8501
  :param _MongoVersionValue: Digital version corresponding to the instance version.
7748
8502
  :type MongoVersionValue: int
7749
- :param _Version: Instance version information. Valid values: 3.6, 4.2, 4.4, 5.0, and 6.0.
7750
-
8503
+ :param _Version: Instance version information. Valid values: 4.2, 4.4, 5.0, 6.0, and 7.0.
7751
8504
  :type Version: str
7752
8505
  :param _EngineName: Storage engine.
7753
8506
  :type EngineName: str
@@ -7797,16 +8550,9 @@ class SpecItem(AbstractModel):
7797
8550
  @property
7798
8551
  def SpecCode(self):
7799
8552
  r"""Specification information identifier. Format: mongo.HIO10G.128G. It consists of three parts: node type, specification type, and memory specification.
7800
- - Node types are as follows:
7801
- - mongo: Mongod node.
7802
- - mongos: Mongos node.
7803
- - cfgstr: ConfigServer node.
7804
- - Specification types are as follows:
7805
- - HIO10G: general high-I/O 10GE type.
7806
- - HCD: cloud disk type.
7807
- - Memory specifications are as follows:
7808
- - Valid values: 4, 8, 16, 32, 64, 128, 240, and 512.
7809
- - Unit: g, indicating GB. 128g means 128 GB.
8553
+ - Node type: **mongo** indicates a Mongod node; **mongos** indicates a Mongos node; **cfgstr** indicates a ConfigServer node.
8554
+ - Specification type: **HIO10G** indicates the general HIO 10GE type; **HCD** indicates the Cloud Disk Edition type.
8555
+ - Memory specification, in GB. Valid values: 4, 8, 16, 32, 64, 128, 240, and 512. 128g indicates 128 GB.
7810
8556
  :rtype: str
7811
8557
  """
7812
8558
  return self._SpecCode
@@ -7908,12 +8654,12 @@ class SpecItem(AbstractModel):
7908
8654
  @property
7909
8655
  def MongoVersionCode(self):
7910
8656
  r"""Storage engine version information on instances.
7911
- - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.
7912
- - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
7913
- - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
7914
- - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
7915
- - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
7916
- - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
8657
+ - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.
8658
+ - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.
8659
+ - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.
8660
+ - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.
8661
+ - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.
8662
+ - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.
7917
8663
  :rtype: str
7918
8664
  """
7919
8665
  return self._MongoVersionCode
@@ -7935,8 +8681,7 @@ class SpecItem(AbstractModel):
7935
8681
 
7936
8682
  @property
7937
8683
  def Version(self):
7938
- r"""Instance version information. Valid values: 3.6, 4.2, 4.4, 5.0, and 6.0.
7939
-
8684
+ r"""Instance version information. Valid values: 4.2, 4.4, 5.0, 6.0, and 7.0.
7940
8685
  :rtype: str
7941
8686
  """
7942
8687
  return self._Version
@@ -8082,19 +8827,21 @@ class SpecItem(AbstractModel):
8082
8827
 
8083
8828
 
8084
8829
  class SpecificationInfo(AbstractModel):
8085
- r"""Instance specification information
8830
+ r"""Instance specification information.
8086
8831
 
8087
8832
  """
8088
8833
 
8089
8834
  def __init__(self):
8090
8835
  r"""
8091
- :param _Region: Region information
8836
+ :param _Region: Region information.
8092
8837
  :type Region: str
8093
- :param _Zone: AZ information
8838
+ :param _Zone: AZ information.
8094
8839
  :type Zone: str
8095
- :param _SpecItems: Purchasable specification information
8840
+ :param _SpecItems: Sales specification information.
8096
8841
  :type SpecItems: list of SpecItem
8097
- :param _SupportMultiAZ: Whether cross-AZ deployment is supported. Valid values: `1` (yes), `0` (no).
8842
+ :param _SupportMultiAZ: Whether cross-AZ deployment is supported.
8843
+ - 1: supported.
8844
+ - 0: not supported.
8098
8845
  :type SupportMultiAZ: int
8099
8846
  """
8100
8847
  self._Region = None
@@ -8104,7 +8851,7 @@ class SpecificationInfo(AbstractModel):
8104
8851
 
8105
8852
  @property
8106
8853
  def Region(self):
8107
- r"""Region information
8854
+ r"""Region information.
8108
8855
  :rtype: str
8109
8856
  """
8110
8857
  return self._Region
@@ -8115,7 +8862,7 @@ class SpecificationInfo(AbstractModel):
8115
8862
 
8116
8863
  @property
8117
8864
  def Zone(self):
8118
- r"""AZ information
8865
+ r"""AZ information.
8119
8866
  :rtype: str
8120
8867
  """
8121
8868
  return self._Zone
@@ -8126,7 +8873,7 @@ class SpecificationInfo(AbstractModel):
8126
8873
 
8127
8874
  @property
8128
8875
  def SpecItems(self):
8129
- r"""Purchasable specification information
8876
+ r"""Sales specification information.
8130
8877
  :rtype: list of SpecItem
8131
8878
  """
8132
8879
  return self._SpecItems
@@ -8137,7 +8884,9 @@ class SpecificationInfo(AbstractModel):
8137
8884
 
8138
8885
  @property
8139
8886
  def SupportMultiAZ(self):
8140
- r"""Whether cross-AZ deployment is supported. Valid values: `1` (yes), `0` (no).
8887
+ r"""Whether cross-AZ deployment is supported.
8888
+ - 1: supported.
8889
+ - 0: not supported.
8141
8890
  :rtype: int
8142
8891
  """
8143
8892
  return self._SupportMultiAZ
@@ -8215,4 +8964,68 @@ class TagInfo(AbstractModel):
8215
8964
  memeber_set.remove(property_name)
8216
8965
  if len(memeber_set) > 0:
8217
8966
  warnings.warn("%s fileds are useless." % ",".join(memeber_set))
8218
-
8967
+
8968
+
8969
+
8970
+ class TerminateDBInstancesRequest(AbstractModel):
8971
+ r"""TerminateDBInstances request structure.
8972
+
8973
+ """
8974
+
8975
+ def __init__(self):
8976
+ r"""
8977
+ :param _InstanceId: Specifies the ID of the pre-isolated instance. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
8978
+ :type InstanceId: str
8979
+ """
8980
+ self._InstanceId = None
8981
+
8982
+ @property
8983
+ def InstanceId(self):
8984
+ r"""Specifies the ID of the pre-isolated instance. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.
8985
+ :rtype: str
8986
+ """
8987
+ return self._InstanceId
8988
+
8989
+ @InstanceId.setter
8990
+ def InstanceId(self, InstanceId):
8991
+ self._InstanceId = InstanceId
8992
+
8993
+
8994
+ def _deserialize(self, params):
8995
+ self._InstanceId = params.get("InstanceId")
8996
+ memeber_set = set(params.keys())
8997
+ for name, value in vars(self).items():
8998
+ property_name = name[1:]
8999
+ if property_name in memeber_set:
9000
+ memeber_set.remove(property_name)
9001
+ if len(memeber_set) > 0:
9002
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
9003
+
9004
+
9005
+
9006
+ class TerminateDBInstancesResponse(AbstractModel):
9007
+ r"""TerminateDBInstances response structure.
9008
+
9009
+ """
9010
+
9011
+ def __init__(self):
9012
+ r"""
9013
+ :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
9014
+ :type RequestId: str
9015
+ """
9016
+ self._RequestId = None
9017
+
9018
+ @property
9019
+ def RequestId(self):
9020
+ r"""The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
9021
+ :rtype: str
9022
+ """
9023
+ return self._RequestId
9024
+
9025
+ @RequestId.setter
9026
+ def RequestId(self, RequestId):
9027
+ self._RequestId = RequestId
9028
+
9029
+
9030
+ def _deserialize(self, params):
9031
+ self._RequestId = params.get("RequestId")