tencentcloud-sdk-python-intl-en 3.0.1233__py2.py3-none-any.whl → 3.0.1235__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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/billing/v20180709/models.py +4 -0
- tencentcloud/emr/v20190103/emr_client.py +138 -0
- tencentcloud/emr/v20190103/errorcodes.py +12 -0
- tencentcloud/emr/v20190103/models.py +6945 -5478
- tencentcloud/mongodb/v20190725/errorcodes.py +8 -2
- tencentcloud/mongodb/v20190725/models.py +1162 -506
- tencentcloud/mongodb/v20190725/mongodb_client.py +34 -11
- {tencentcloud_sdk_python_intl_en-3.0.1233.dist-info → tencentcloud_sdk_python_intl_en-3.0.1235.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python_intl_en-3.0.1233.dist-info → tencentcloud_sdk_python_intl_en-3.0.1235.dist-info}/RECORD +12 -12
- {tencentcloud_sdk_python_intl_en-3.0.1233.dist-info → tencentcloud_sdk_python_intl_en-3.0.1235.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_intl_en-3.0.1233.dist-info → tencentcloud_sdk_python_intl_en-3.0.1235.dist-info}/top_level.txt +0 -0
|
@@ -18,6 +18,67 @@ import warnings
|
|
|
18
18
|
from tencentcloud.common.abstract_model import AbstractModel
|
|
19
19
|
|
|
20
20
|
|
|
21
|
+
class AddNodeList(AbstractModel):
|
|
22
|
+
"""Node details of an instance to be modified.
|
|
23
|
+
|
|
24
|
+
"""
|
|
25
|
+
|
|
26
|
+
def __init__(self):
|
|
27
|
+
r"""
|
|
28
|
+
:param _Role: Roles of nodes to be added.
|
|
29
|
+
- SECONDARY: Mongod node.
|
|
30
|
+
- READONLY: read-only node.
|
|
31
|
+
- MONGOS: Mongos node.
|
|
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.
|
|
36
|
+
:type Zone: str
|
|
37
|
+
"""
|
|
38
|
+
self._Role = None
|
|
39
|
+
self._Zone = None
|
|
40
|
+
|
|
41
|
+
@property
|
|
42
|
+
def Role(self):
|
|
43
|
+
"""Roles of nodes to be added.
|
|
44
|
+
- SECONDARY: Mongod node.
|
|
45
|
+
- READONLY: read-only node.
|
|
46
|
+
- MONGOS: Mongos node.
|
|
47
|
+
:rtype: str
|
|
48
|
+
"""
|
|
49
|
+
return self._Role
|
|
50
|
+
|
|
51
|
+
@Role.setter
|
|
52
|
+
def Role(self, Role):
|
|
53
|
+
self._Role = Role
|
|
54
|
+
|
|
55
|
+
@property
|
|
56
|
+
def Zone(self):
|
|
57
|
+
"""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.
|
|
60
|
+
:rtype: str
|
|
61
|
+
"""
|
|
62
|
+
return self._Zone
|
|
63
|
+
|
|
64
|
+
@Zone.setter
|
|
65
|
+
def Zone(self, Zone):
|
|
66
|
+
self._Zone = Zone
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def _deserialize(self, params):
|
|
70
|
+
self._Role = params.get("Role")
|
|
71
|
+
self._Zone = params.get("Zone")
|
|
72
|
+
memeber_set = set(params.keys())
|
|
73
|
+
for name, value in vars(self).items():
|
|
74
|
+
property_name = name[1:]
|
|
75
|
+
if property_name in memeber_set:
|
|
76
|
+
memeber_set.remove(property_name)
|
|
77
|
+
if len(memeber_set) > 0:
|
|
78
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
21
82
|
class AssignProjectRequest(AbstractModel):
|
|
22
83
|
"""AssignProject request structure.
|
|
23
84
|
|
|
@@ -25,7 +86,7 @@ class AssignProjectRequest(AbstractModel):
|
|
|
25
86
|
|
|
26
87
|
def __init__(self):
|
|
27
88
|
r"""
|
|
28
|
-
:param _InstanceIds:
|
|
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.
|
|
29
90
|
:type InstanceIds: list of str
|
|
30
91
|
:param _ProjectId: Unique ID of an existing project (instead of a new project).
|
|
31
92
|
:type ProjectId: int
|
|
@@ -35,7 +96,7 @@ class AssignProjectRequest(AbstractModel):
|
|
|
35
96
|
|
|
36
97
|
@property
|
|
37
98
|
def InstanceIds(self):
|
|
38
|
-
"""
|
|
99
|
+
"""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.
|
|
39
100
|
:rtype: list of str
|
|
40
101
|
"""
|
|
41
102
|
return self._InstanceIds
|
|
@@ -78,7 +139,7 @@ class AssignProjectResponse(AbstractModel):
|
|
|
78
139
|
r"""
|
|
79
140
|
:param _FlowIds: List of the returned async task IDs
|
|
80
141
|
:type FlowIds: list of int non-negative
|
|
81
|
-
:param _RequestId: The unique request ID,
|
|
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.
|
|
82
143
|
:type RequestId: str
|
|
83
144
|
"""
|
|
84
145
|
self._FlowIds = None
|
|
@@ -97,7 +158,7 @@ class AssignProjectResponse(AbstractModel):
|
|
|
97
158
|
|
|
98
159
|
@property
|
|
99
160
|
def RequestId(self):
|
|
100
|
-
"""The unique request ID,
|
|
161
|
+
"""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.
|
|
101
162
|
:rtype: str
|
|
102
163
|
"""
|
|
103
164
|
return self._RequestId
|
|
@@ -137,9 +198,12 @@ class BackupDownloadTask(AbstractModel):
|
|
|
137
198
|
:type Url: str
|
|
138
199
|
:param _BackupMethod: Backup type of the backup file. Valid values: `0` (logical backup), `1` (physical backup)
|
|
139
200
|
:type BackupMethod: int
|
|
140
|
-
:param _BackupDesc:
|
|
141
|
-
Note: This field may return `null`, indicating that no valid values can be obtained.
|
|
201
|
+
:param _BackupDesc: Specifies the remarks for backup.
|
|
142
202
|
:type BackupDesc: str
|
|
203
|
+
:param _Region: Region information.
|
|
204
|
+
:type Region: str
|
|
205
|
+
:param _Bucket: Bucket information.
|
|
206
|
+
:type Bucket: str
|
|
143
207
|
"""
|
|
144
208
|
self._CreateTime = None
|
|
145
209
|
self._BackupName = None
|
|
@@ -151,6 +215,8 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
151
215
|
self._Url = None
|
|
152
216
|
self._BackupMethod = None
|
|
153
217
|
self._BackupDesc = None
|
|
218
|
+
self._Region = None
|
|
219
|
+
self._Bucket = None
|
|
154
220
|
|
|
155
221
|
@property
|
|
156
222
|
def CreateTime(self):
|
|
@@ -253,8 +319,7 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
253
319
|
|
|
254
320
|
@property
|
|
255
321
|
def BackupDesc(self):
|
|
256
|
-
"""
|
|
257
|
-
Note: This field may return `null`, indicating that no valid values can be obtained.
|
|
322
|
+
"""Specifies the remarks for backup.
|
|
258
323
|
:rtype: str
|
|
259
324
|
"""
|
|
260
325
|
return self._BackupDesc
|
|
@@ -263,6 +328,28 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
263
328
|
def BackupDesc(self, BackupDesc):
|
|
264
329
|
self._BackupDesc = BackupDesc
|
|
265
330
|
|
|
331
|
+
@property
|
|
332
|
+
def Region(self):
|
|
333
|
+
"""Region information.
|
|
334
|
+
:rtype: str
|
|
335
|
+
"""
|
|
336
|
+
return self._Region
|
|
337
|
+
|
|
338
|
+
@Region.setter
|
|
339
|
+
def Region(self, Region):
|
|
340
|
+
self._Region = Region
|
|
341
|
+
|
|
342
|
+
@property
|
|
343
|
+
def Bucket(self):
|
|
344
|
+
"""Bucket information.
|
|
345
|
+
:rtype: str
|
|
346
|
+
"""
|
|
347
|
+
return self._Bucket
|
|
348
|
+
|
|
349
|
+
@Bucket.setter
|
|
350
|
+
def Bucket(self, Bucket):
|
|
351
|
+
self._Bucket = Bucket
|
|
352
|
+
|
|
266
353
|
|
|
267
354
|
def _deserialize(self, params):
|
|
268
355
|
self._CreateTime = params.get("CreateTime")
|
|
@@ -275,6 +362,8 @@ Note: This field may return `null`, indicating that no valid values can be obtai
|
|
|
275
362
|
self._Url = params.get("Url")
|
|
276
363
|
self._BackupMethod = params.get("BackupMethod")
|
|
277
364
|
self._BackupDesc = params.get("BackupDesc")
|
|
365
|
+
self._Region = params.get("Region")
|
|
366
|
+
self._Bucket = params.get("Bucket")
|
|
278
367
|
memeber_set = set(params.keys())
|
|
279
368
|
for name, value in vars(self).items():
|
|
280
369
|
property_name = name[1:]
|
|
@@ -343,28 +432,30 @@ class BackupInfo(AbstractModel):
|
|
|
343
432
|
|
|
344
433
|
def __init__(self):
|
|
345
434
|
r"""
|
|
346
|
-
:param _InstanceId: Instance ID
|
|
435
|
+
:param _InstanceId: Instance ID.
|
|
347
436
|
:type InstanceId: str
|
|
348
437
|
:param _BackupType: Backup mode. 0: automatic backup; 1: manual backup
|
|
349
438
|
:type BackupType: int
|
|
350
439
|
:param _BackupName: Backup name
|
|
351
440
|
:type BackupName: str
|
|
352
|
-
:param _BackupDesc: Backup remarks
|
|
353
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
441
|
+
:param _BackupDesc: Backup remarks.
|
|
354
442
|
:type BackupDesc: str
|
|
355
|
-
:param _BackupSize: Backup file size
|
|
356
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
443
|
+
:param _BackupSize: Backup file size. Unit: KB.
|
|
357
444
|
:type BackupSize: int
|
|
358
|
-
:param _StartTime: Backup start time
|
|
359
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
445
|
+
:param _StartTime: Backup start time.
|
|
360
446
|
:type StartTime: str
|
|
361
|
-
:param _EndTime: Backup end time
|
|
362
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
447
|
+
:param _EndTime: Backup end time.
|
|
363
448
|
:type EndTime: str
|
|
364
449
|
:param _Status: Backup status. 1: backing up; 2: backed up successful
|
|
365
450
|
:type Status: int
|
|
366
451
|
:param _BackupMethod: Backup method. 0: logical backup; 1: physical backup
|
|
367
452
|
:type BackupMethod: int
|
|
453
|
+
:param _BackId: Backup record ID.
|
|
454
|
+
:type BackId: int
|
|
455
|
+
:param _DeleteTime: Backup deletion time.
|
|
456
|
+
:type DeleteTime: str
|
|
457
|
+
:param _BackupRegion: Region for cross-region backup.
|
|
458
|
+
:type BackupRegion: str
|
|
368
459
|
"""
|
|
369
460
|
self._InstanceId = None
|
|
370
461
|
self._BackupType = None
|
|
@@ -375,10 +466,13 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
375
466
|
self._EndTime = None
|
|
376
467
|
self._Status = None
|
|
377
468
|
self._BackupMethod = None
|
|
469
|
+
self._BackId = None
|
|
470
|
+
self._DeleteTime = None
|
|
471
|
+
self._BackupRegion = None
|
|
378
472
|
|
|
379
473
|
@property
|
|
380
474
|
def InstanceId(self):
|
|
381
|
-
"""Instance ID
|
|
475
|
+
"""Instance ID.
|
|
382
476
|
:rtype: str
|
|
383
477
|
"""
|
|
384
478
|
return self._InstanceId
|
|
@@ -411,8 +505,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
411
505
|
|
|
412
506
|
@property
|
|
413
507
|
def BackupDesc(self):
|
|
414
|
-
"""Backup remarks
|
|
415
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
508
|
+
"""Backup remarks.
|
|
416
509
|
:rtype: str
|
|
417
510
|
"""
|
|
418
511
|
return self._BackupDesc
|
|
@@ -423,8 +516,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
423
516
|
|
|
424
517
|
@property
|
|
425
518
|
def BackupSize(self):
|
|
426
|
-
"""Backup file size
|
|
427
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
519
|
+
"""Backup file size. Unit: KB.
|
|
428
520
|
:rtype: int
|
|
429
521
|
"""
|
|
430
522
|
return self._BackupSize
|
|
@@ -435,8 +527,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
435
527
|
|
|
436
528
|
@property
|
|
437
529
|
def StartTime(self):
|
|
438
|
-
"""Backup start time
|
|
439
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
530
|
+
"""Backup start time.
|
|
440
531
|
:rtype: str
|
|
441
532
|
"""
|
|
442
533
|
return self._StartTime
|
|
@@ -447,8 +538,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
447
538
|
|
|
448
539
|
@property
|
|
449
540
|
def EndTime(self):
|
|
450
|
-
"""Backup end time
|
|
451
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
541
|
+
"""Backup end time.
|
|
452
542
|
:rtype: str
|
|
453
543
|
"""
|
|
454
544
|
return self._EndTime
|
|
@@ -479,6 +569,39 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
479
569
|
def BackupMethod(self, BackupMethod):
|
|
480
570
|
self._BackupMethod = BackupMethod
|
|
481
571
|
|
|
572
|
+
@property
|
|
573
|
+
def BackId(self):
|
|
574
|
+
"""Backup record ID.
|
|
575
|
+
:rtype: int
|
|
576
|
+
"""
|
|
577
|
+
return self._BackId
|
|
578
|
+
|
|
579
|
+
@BackId.setter
|
|
580
|
+
def BackId(self, BackId):
|
|
581
|
+
self._BackId = BackId
|
|
582
|
+
|
|
583
|
+
@property
|
|
584
|
+
def DeleteTime(self):
|
|
585
|
+
"""Backup deletion time.
|
|
586
|
+
:rtype: str
|
|
587
|
+
"""
|
|
588
|
+
return self._DeleteTime
|
|
589
|
+
|
|
590
|
+
@DeleteTime.setter
|
|
591
|
+
def DeleteTime(self, DeleteTime):
|
|
592
|
+
self._DeleteTime = DeleteTime
|
|
593
|
+
|
|
594
|
+
@property
|
|
595
|
+
def BackupRegion(self):
|
|
596
|
+
"""Region for cross-region backup.
|
|
597
|
+
:rtype: str
|
|
598
|
+
"""
|
|
599
|
+
return self._BackupRegion
|
|
600
|
+
|
|
601
|
+
@BackupRegion.setter
|
|
602
|
+
def BackupRegion(self, BackupRegion):
|
|
603
|
+
self._BackupRegion = BackupRegion
|
|
604
|
+
|
|
482
605
|
|
|
483
606
|
def _deserialize(self, params):
|
|
484
607
|
self._InstanceId = params.get("InstanceId")
|
|
@@ -490,6 +613,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
490
613
|
self._EndTime = params.get("EndTime")
|
|
491
614
|
self._Status = params.get("Status")
|
|
492
615
|
self._BackupMethod = params.get("BackupMethod")
|
|
616
|
+
self._BackId = params.get("BackId")
|
|
617
|
+
self._DeleteTime = params.get("DeleteTime")
|
|
618
|
+
self._BackupRegion = params.get("BackupRegion")
|
|
493
619
|
memeber_set = set(params.keys())
|
|
494
620
|
for name, value in vars(self).items():
|
|
495
621
|
property_name = name[1:]
|
|
@@ -573,11 +699,13 @@ class CreateBackupDBInstanceRequest(AbstractModel):
|
|
|
573
699
|
|
|
574
700
|
def __init__(self):
|
|
575
701
|
r"""
|
|
576
|
-
:param _InstanceId: Instance ID
|
|
702
|
+
: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.
|
|
577
703
|
:type InstanceId: str
|
|
578
|
-
:param _BackupMethod:
|
|
704
|
+
:param _BackupMethod: Sets the backup method.
|
|
705
|
+
- 0: logical backup.
|
|
706
|
+
- 1: physical backup.
|
|
579
707
|
:type BackupMethod: int
|
|
580
|
-
:param _BackupRemark: Backup remarks
|
|
708
|
+
:param _BackupRemark: Backup remarks information.
|
|
581
709
|
:type BackupRemark: str
|
|
582
710
|
"""
|
|
583
711
|
self._InstanceId = None
|
|
@@ -586,7 +714,7 @@ class CreateBackupDBInstanceRequest(AbstractModel):
|
|
|
586
714
|
|
|
587
715
|
@property
|
|
588
716
|
def InstanceId(self):
|
|
589
|
-
"""Instance ID
|
|
717
|
+
"""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.
|
|
590
718
|
:rtype: str
|
|
591
719
|
"""
|
|
592
720
|
return self._InstanceId
|
|
@@ -597,7 +725,9 @@ class CreateBackupDBInstanceRequest(AbstractModel):
|
|
|
597
725
|
|
|
598
726
|
@property
|
|
599
727
|
def BackupMethod(self):
|
|
600
|
-
"""
|
|
728
|
+
"""Sets the backup method.
|
|
729
|
+
- 0: logical backup.
|
|
730
|
+
- 1: physical backup.
|
|
601
731
|
:rtype: int
|
|
602
732
|
"""
|
|
603
733
|
return self._BackupMethod
|
|
@@ -608,7 +738,7 @@ class CreateBackupDBInstanceRequest(AbstractModel):
|
|
|
608
738
|
|
|
609
739
|
@property
|
|
610
740
|
def BackupRemark(self):
|
|
611
|
-
"""Backup remarks
|
|
741
|
+
"""Backup remarks information.
|
|
612
742
|
:rtype: str
|
|
613
743
|
"""
|
|
614
744
|
return self._BackupRemark
|
|
@@ -639,7 +769,7 @@ class CreateBackupDBInstanceResponse(AbstractModel):
|
|
|
639
769
|
|
|
640
770
|
def __init__(self):
|
|
641
771
|
r"""
|
|
642
|
-
:param _AsyncRequestId:
|
|
772
|
+
:param _AsyncRequestId: Request ID.
|
|
643
773
|
:type AsyncRequestId: str
|
|
644
774
|
: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.
|
|
645
775
|
:type RequestId: str
|
|
@@ -649,7 +779,7 @@ class CreateBackupDBInstanceResponse(AbstractModel):
|
|
|
649
779
|
|
|
650
780
|
@property
|
|
651
781
|
def AsyncRequestId(self):
|
|
652
|
-
"""
|
|
782
|
+
"""Request ID.
|
|
653
783
|
:rtype: str
|
|
654
784
|
"""
|
|
655
785
|
return self._AsyncRequestId
|
|
@@ -759,7 +889,7 @@ class CreateBackupDownloadTaskResponse(AbstractModel):
|
|
|
759
889
|
r"""
|
|
760
890
|
:param _Tasks: Download task status
|
|
761
891
|
:type Tasks: list of BackupDownloadTaskStatus
|
|
762
|
-
:param _RequestId: The unique request ID,
|
|
892
|
+
: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.
|
|
763
893
|
:type RequestId: str
|
|
764
894
|
"""
|
|
765
895
|
self._Tasks = None
|
|
@@ -778,7 +908,7 @@ class CreateBackupDownloadTaskResponse(AbstractModel):
|
|
|
778
908
|
|
|
779
909
|
@property
|
|
780
910
|
def RequestId(self):
|
|
781
|
-
"""The unique request ID,
|
|
911
|
+
"""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.
|
|
782
912
|
:rtype: str
|
|
783
913
|
"""
|
|
784
914
|
return self._RequestId
|
|
@@ -805,25 +935,27 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
805
935
|
|
|
806
936
|
def __init__(self):
|
|
807
937
|
r"""
|
|
808
|
-
:param _Memory: Instance memory size
|
|
938
|
+
:param _Memory: Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications.
|
|
809
939
|
:type Memory: int
|
|
810
|
-
:param _Volume: Instance disk size
|
|
940
|
+
: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.
|
|
811
941
|
:type Volume: int
|
|
812
|
-
:param _ReplicateSetNum:
|
|
813
|
-
-
|
|
814
|
-
- Number of sharded cluster instances to be created. You can get the specific purchasable specifications through the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API.
|
|
942
|
+
:param _ReplicateSetNum: - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1.
|
|
943
|
+
- Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively.
|
|
815
944
|
:type ReplicateSetNum: int
|
|
816
|
-
:param _NodeNum:
|
|
945
|
+
: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
|
+
- 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.
|
|
817
947
|
:type NodeNum: int
|
|
818
|
-
:param _MongoVersion:
|
|
819
|
-
- MONGO_36_WT
|
|
820
|
-
- MONGO_40_WT
|
|
821
|
-
- MONGO_42_WT
|
|
822
|
-
- MONGO_44_WT
|
|
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.
|
|
823
955
|
:type MongoVersion: str
|
|
824
|
-
:param _MachineCode:
|
|
825
|
-
-
|
|
826
|
-
-
|
|
956
|
+
:param _MachineCode: Product specification type.
|
|
957
|
+
- HIO10G: general high-I/O 10GE type.
|
|
958
|
+
- HCD: cloud disk type.
|
|
827
959
|
:type MachineCode: str
|
|
828
960
|
:param _GoodsNum: Number of instances. Value range: 1-10.
|
|
829
961
|
:type GoodsNum: int
|
|
@@ -835,26 +967,26 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
835
967
|
- REPLSET: Replica set
|
|
836
968
|
- SHARD: Sharded cluster
|
|
837
969
|
:type ClusterType: str
|
|
838
|
-
:param _VpcId: VPC ID
|
|
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.
|
|
839
971
|
:type VpcId: str
|
|
840
|
-
:param _SubnetId: VPC subnet
|
|
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.
|
|
841
973
|
:type SubnetId: str
|
|
842
|
-
:param _Password: Instance password
|
|
843
|
-
-
|
|
844
|
-
|
|
974
|
+
:param _Password: Instance password. The requirements are as follows:
|
|
975
|
+
- The number of characters should be in the range of [8, 32].
|
|
976
|
+
- Characters within the ranges [A,Z], [a,z], and [0,9] are allowed.
|
|
977
|
+
- Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_).
|
|
978
|
+
- It cannot contain only the same letters or digits.
|
|
845
979
|
:type Password: str
|
|
846
|
-
:param _ProjectId: Project ID.
|
|
980
|
+
:param _ProjectId: Project ID. - The default project is used if this parameter is not specified.
|
|
981
|
+
- The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project).
|
|
847
982
|
:type ProjectId: int
|
|
848
983
|
:param _Tags: Instance tag information
|
|
849
984
|
:type Tags: list of TagInfo
|
|
850
|
-
:param _Clone: Instance type.
|
|
851
|
-
- `1`: Primary instance
|
|
852
|
-
- `3`: Read-only instance
|
|
853
|
-
- `4`: Disaster recovery instance
|
|
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.
|
|
854
986
|
:type Clone: int
|
|
855
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
|
|
856
988
|
:type Father: str
|
|
857
|
-
:param _SecurityGroup: Security group
|
|
989
|
+
:param _SecurityGroup: Security group ID.
|
|
858
990
|
:type SecurityGroup: list of str
|
|
859
991
|
:param _RestoreTime: Rollback time of the cloned instance
|
|
860
992
|
- This parameter is required for a cloned instance in the format of 2021-08-13 16:30:00.
|
|
@@ -862,30 +994,33 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
862
994
|
:type RestoreTime: str
|
|
863
995
|
:param _InstanceName: Instance name, which can contain up to 60 letters, digits, and symbols (_-).
|
|
864
996
|
:type InstanceName: str
|
|
865
|
-
:param _AvailabilityZoneList:
|
|
866
|
-
-
|
|
867
|
-
-
|
|
868
|
-
-
|
|
869
|
-
|
|
997
|
+
: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
|
+
|
|
870
1002
|
:type AvailabilityZoneList: list of str
|
|
871
|
-
:param _MongosCpu: Number of Mongos CPU cores
|
|
872
|
-
|
|
873
|
-
- If this parameter is not configured, the mongos specification will be configured based on the mongod specification, and the default specification is free of charge.
|
|
1003
|
+
: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
|
+
|
|
874
1005
|
:type MongosCpu: int
|
|
875
|
-
:param _MongosMemory: Mongos memory size
|
|
876
|
-
- This parameter is
|
|
877
|
-
-
|
|
1006
|
+
: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
|
+
|
|
878
1011
|
:type MongosMemory: int
|
|
879
|
-
:param _MongosNodeNum: Number of
|
|
880
|
-
-
|
|
881
|
-
-
|
|
1012
|
+
:param _MongosNodeNum: Number of Mongos nodes. This parameter is required during sharded cluster instance purchase.
|
|
1013
|
+
- For instances in single-AZ deployment mode, the value range is [3,32].
|
|
1014
|
+
- For instances in multi-AZ deployment mode, the value range is [6,32].
|
|
882
1015
|
:type MongosNodeNum: int
|
|
883
|
-
:param _ReadonlyNodeNum: Number of read-only nodes. Value
|
|
1016
|
+
:param _ReadonlyNodeNum: Number of read-only nodes. Value ranges: [0,5].
|
|
884
1017
|
:type ReadonlyNodeNum: int
|
|
885
|
-
:param _ReadonlyNodeAvailabilityZoneList:
|
|
1018
|
+
:param _ReadonlyNodeAvailabilityZoneList: Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**.
|
|
886
1019
|
:type ReadonlyNodeAvailabilityZoneList: list of str
|
|
887
1020
|
:param _HiddenZone: AZ where the hidden node resides, which is required in cross-AZ instance deployment.
|
|
888
1021
|
: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.
|
|
1023
|
+
:type ParamTemplateId: str
|
|
889
1024
|
"""
|
|
890
1025
|
self._Memory = None
|
|
891
1026
|
self._Volume = None
|
|
@@ -913,10 +1048,11 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
913
1048
|
self._ReadonlyNodeNum = None
|
|
914
1049
|
self._ReadonlyNodeAvailabilityZoneList = None
|
|
915
1050
|
self._HiddenZone = None
|
|
1051
|
+
self._ParamTemplateId = None
|
|
916
1052
|
|
|
917
1053
|
@property
|
|
918
1054
|
def Memory(self):
|
|
919
|
-
"""Instance memory size
|
|
1055
|
+
"""Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications.
|
|
920
1056
|
:rtype: int
|
|
921
1057
|
"""
|
|
922
1058
|
return self._Memory
|
|
@@ -927,7 +1063,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
927
1063
|
|
|
928
1064
|
@property
|
|
929
1065
|
def Volume(self):
|
|
930
|
-
"""Instance disk size
|
|
1066
|
+
"""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.
|
|
931
1067
|
:rtype: int
|
|
932
1068
|
"""
|
|
933
1069
|
return self._Volume
|
|
@@ -938,9 +1074,8 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
938
1074
|
|
|
939
1075
|
@property
|
|
940
1076
|
def ReplicateSetNum(self):
|
|
941
|
-
"""
|
|
942
|
-
-
|
|
943
|
-
- Number of sharded cluster instances to be created. You can get the specific purchasable specifications through the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API.
|
|
1077
|
+
""" - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1.
|
|
1078
|
+
- Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively.
|
|
944
1079
|
:rtype: int
|
|
945
1080
|
"""
|
|
946
1081
|
return self._ReplicateSetNum
|
|
@@ -951,7 +1086,8 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
951
1086
|
|
|
952
1087
|
@property
|
|
953
1088
|
def NodeNum(self):
|
|
954
|
-
"""
|
|
1089
|
+
""" - 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.
|
|
1090
|
+
- 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.
|
|
955
1091
|
:rtype: int
|
|
956
1092
|
"""
|
|
957
1093
|
return self._NodeNum
|
|
@@ -962,11 +1098,13 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
962
1098
|
|
|
963
1099
|
@property
|
|
964
1100
|
def MongoVersion(self):
|
|
965
|
-
"""
|
|
966
|
-
- MONGO_36_WT
|
|
967
|
-
- MONGO_40_WT
|
|
968
|
-
- MONGO_42_WT
|
|
969
|
-
- MONGO_44_WT
|
|
1101
|
+
"""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.
|
|
970
1108
|
:rtype: str
|
|
971
1109
|
"""
|
|
972
1110
|
return self._MongoVersion
|
|
@@ -977,9 +1115,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
977
1115
|
|
|
978
1116
|
@property
|
|
979
1117
|
def MachineCode(self):
|
|
980
|
-
"""
|
|
981
|
-
-
|
|
982
|
-
-
|
|
1118
|
+
"""Product specification type.
|
|
1119
|
+
- HIO10G: general high-I/O 10GE type.
|
|
1120
|
+
- HCD: cloud disk type.
|
|
983
1121
|
:rtype: str
|
|
984
1122
|
"""
|
|
985
1123
|
return self._MachineCode
|
|
@@ -1027,7 +1165,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1027
1165
|
|
|
1028
1166
|
@property
|
|
1029
1167
|
def VpcId(self):
|
|
1030
|
-
"""VPC ID
|
|
1168
|
+
"""VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.
|
|
1031
1169
|
:rtype: str
|
|
1032
1170
|
"""
|
|
1033
1171
|
return self._VpcId
|
|
@@ -1038,7 +1176,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1038
1176
|
|
|
1039
1177
|
@property
|
|
1040
1178
|
def SubnetId(self):
|
|
1041
|
-
"""VPC subnet
|
|
1179
|
+
"""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.
|
|
1042
1180
|
:rtype: str
|
|
1043
1181
|
"""
|
|
1044
1182
|
return self._SubnetId
|
|
@@ -1049,9 +1187,11 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1049
1187
|
|
|
1050
1188
|
@property
|
|
1051
1189
|
def Password(self):
|
|
1052
|
-
"""Instance password
|
|
1053
|
-
-
|
|
1054
|
-
|
|
1190
|
+
"""Instance password. The requirements are as follows:
|
|
1191
|
+
- The number of characters should be in the range of [8, 32].
|
|
1192
|
+
- Characters within the ranges [A,Z], [a,z], and [0,9] are allowed.
|
|
1193
|
+
- Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_).
|
|
1194
|
+
- It cannot contain only the same letters or digits.
|
|
1055
1195
|
:rtype: str
|
|
1056
1196
|
"""
|
|
1057
1197
|
return self._Password
|
|
@@ -1062,7 +1202,8 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1062
1202
|
|
|
1063
1203
|
@property
|
|
1064
1204
|
def ProjectId(self):
|
|
1065
|
-
"""Project ID.
|
|
1205
|
+
"""Project ID. - The default project is used if this parameter is not specified.
|
|
1206
|
+
- The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project).
|
|
1066
1207
|
:rtype: int
|
|
1067
1208
|
"""
|
|
1068
1209
|
return self._ProjectId
|
|
@@ -1084,10 +1225,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1084
1225
|
|
|
1085
1226
|
@property
|
|
1086
1227
|
def Clone(self):
|
|
1087
|
-
"""Instance type.
|
|
1088
|
-
- `1`: Primary instance
|
|
1089
|
-
- `3`: Read-only instance
|
|
1090
|
-
- `4`: Disaster recovery instance
|
|
1228
|
+
"""Instance type. 1: formal instance; 3: read-only instance; 4: disaster recovery instance; 5: cloned instance. Note: For a cloned instance, RestoreTime is required.
|
|
1091
1229
|
:rtype: int
|
|
1092
1230
|
"""
|
|
1093
1231
|
return self._Clone
|
|
@@ -1109,7 +1247,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1109
1247
|
|
|
1110
1248
|
@property
|
|
1111
1249
|
def SecurityGroup(self):
|
|
1112
|
-
"""Security group
|
|
1250
|
+
"""Security group ID.
|
|
1113
1251
|
:rtype: list of str
|
|
1114
1252
|
"""
|
|
1115
1253
|
return self._SecurityGroup
|
|
@@ -1144,11 +1282,11 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1144
1282
|
|
|
1145
1283
|
@property
|
|
1146
1284
|
def AvailabilityZoneList(self):
|
|
1147
|
-
"""
|
|
1148
|
-
-
|
|
1149
|
-
-
|
|
1150
|
-
-
|
|
1151
|
-
|
|
1285
|
+
"""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
|
+
|
|
1152
1290
|
:rtype: list of str
|
|
1153
1291
|
"""
|
|
1154
1292
|
return self._AvailabilityZoneList
|
|
@@ -1159,9 +1297,8 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1159
1297
|
|
|
1160
1298
|
@property
|
|
1161
1299
|
def MongosCpu(self):
|
|
1162
|
-
"""Number of Mongos CPU cores
|
|
1163
|
-
|
|
1164
|
-
- If this parameter is not configured, the mongos specification will be configured based on the mongod specification, and the default specification is free of charge.
|
|
1300
|
+
"""Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase.
|
|
1301
|
+
|
|
1165
1302
|
:rtype: int
|
|
1166
1303
|
"""
|
|
1167
1304
|
return self._MongosCpu
|
|
@@ -1172,9 +1309,11 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1172
1309
|
|
|
1173
1310
|
@property
|
|
1174
1311
|
def MongosMemory(self):
|
|
1175
|
-
"""Mongos memory size
|
|
1176
|
-
- This parameter is
|
|
1177
|
-
-
|
|
1312
|
+
"""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
|
+
|
|
1178
1317
|
:rtype: int
|
|
1179
1318
|
"""
|
|
1180
1319
|
return self._MongosMemory
|
|
@@ -1185,9 +1324,9 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1185
1324
|
|
|
1186
1325
|
@property
|
|
1187
1326
|
def MongosNodeNum(self):
|
|
1188
|
-
"""Number of
|
|
1189
|
-
-
|
|
1190
|
-
-
|
|
1327
|
+
"""Number of Mongos nodes. This parameter is required during sharded cluster instance purchase.
|
|
1328
|
+
- For instances in single-AZ deployment mode, the value range is [3,32].
|
|
1329
|
+
- For instances in multi-AZ deployment mode, the value range is [6,32].
|
|
1191
1330
|
:rtype: int
|
|
1192
1331
|
"""
|
|
1193
1332
|
return self._MongosNodeNum
|
|
@@ -1198,7 +1337,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1198
1337
|
|
|
1199
1338
|
@property
|
|
1200
1339
|
def ReadonlyNodeNum(self):
|
|
1201
|
-
"""Number of read-only nodes. Value
|
|
1340
|
+
"""Number of read-only nodes. Value ranges: [0,5].
|
|
1202
1341
|
:rtype: int
|
|
1203
1342
|
"""
|
|
1204
1343
|
return self._ReadonlyNodeNum
|
|
@@ -1209,7 +1348,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1209
1348
|
|
|
1210
1349
|
@property
|
|
1211
1350
|
def ReadonlyNodeAvailabilityZoneList(self):
|
|
1212
|
-
"""
|
|
1351
|
+
"""Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**.
|
|
1213
1352
|
:rtype: list of str
|
|
1214
1353
|
"""
|
|
1215
1354
|
return self._ReadonlyNodeAvailabilityZoneList
|
|
@@ -1229,6 +1368,17 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1229
1368
|
def HiddenZone(self, HiddenZone):
|
|
1230
1369
|
self._HiddenZone = HiddenZone
|
|
1231
1370
|
|
|
1371
|
+
@property
|
|
1372
|
+
def ParamTemplateId(self):
|
|
1373
|
+
"""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.
|
|
1374
|
+
:rtype: str
|
|
1375
|
+
"""
|
|
1376
|
+
return self._ParamTemplateId
|
|
1377
|
+
|
|
1378
|
+
@ParamTemplateId.setter
|
|
1379
|
+
def ParamTemplateId(self, ParamTemplateId):
|
|
1380
|
+
self._ParamTemplateId = ParamTemplateId
|
|
1381
|
+
|
|
1232
1382
|
|
|
1233
1383
|
def _deserialize(self, params):
|
|
1234
1384
|
self._Memory = params.get("Memory")
|
|
@@ -1262,6 +1412,7 @@ class CreateDBInstanceHourRequest(AbstractModel):
|
|
|
1262
1412
|
self._ReadonlyNodeNum = params.get("ReadonlyNodeNum")
|
|
1263
1413
|
self._ReadonlyNodeAvailabilityZoneList = params.get("ReadonlyNodeAvailabilityZoneList")
|
|
1264
1414
|
self._HiddenZone = params.get("HiddenZone")
|
|
1415
|
+
self._ParamTemplateId = params.get("ParamTemplateId")
|
|
1265
1416
|
memeber_set = set(params.keys())
|
|
1266
1417
|
for name, value in vars(self).items():
|
|
1267
1418
|
property_name = name[1:]
|
|
@@ -1283,7 +1434,7 @@ class CreateDBInstanceHourResponse(AbstractModel):
|
|
|
1283
1434
|
:type DealId: str
|
|
1284
1435
|
:param _InstanceIds: List of IDs of the created instances
|
|
1285
1436
|
:type InstanceIds: list of str
|
|
1286
|
-
:param _RequestId: The unique request ID,
|
|
1437
|
+
: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.
|
|
1287
1438
|
:type RequestId: str
|
|
1288
1439
|
"""
|
|
1289
1440
|
self._DealId = None
|
|
@@ -1314,7 +1465,7 @@ class CreateDBInstanceHourResponse(AbstractModel):
|
|
|
1314
1465
|
|
|
1315
1466
|
@property
|
|
1316
1467
|
def RequestId(self):
|
|
1317
|
-
"""The unique request ID,
|
|
1468
|
+
"""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.
|
|
1318
1469
|
:rtype: str
|
|
1319
1470
|
"""
|
|
1320
1471
|
return self._RequestId
|
|
@@ -1337,64 +1488,97 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1337
1488
|
|
|
1338
1489
|
def __init__(self):
|
|
1339
1490
|
r"""
|
|
1340
|
-
:param _NodeNum:
|
|
1491
|
+
: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.
|
|
1492
|
+
- 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.
|
|
1341
1493
|
:type NodeNum: int
|
|
1342
|
-
:param _Memory: Instance memory size
|
|
1494
|
+
:param _Memory: Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications.
|
|
1343
1495
|
:type Memory: int
|
|
1344
|
-
:param _Volume: Instance disk size
|
|
1496
|
+
: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.
|
|
1345
1497
|
:type Volume: int
|
|
1346
|
-
:param _MongoVersion:
|
|
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.
|
|
1347
1505
|
:type MongoVersion: str
|
|
1348
1506
|
:param _GoodsNum: Number of instances. Minimum value: 1. Maximum value: 10.
|
|
1349
1507
|
:type GoodsNum: int
|
|
1350
|
-
:param _Zone: AZ
|
|
1508
|
+
:param _Zone: AZ information. Format: ap-guangzhou-2.
|
|
1509
|
+
- Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the specific information.
|
|
1510
|
+
- This parameter indicates the primary AZ. If multi-AZ deployment is adopted, the value of Zone should be one of the values of AvailabilityZoneList.
|
|
1351
1511
|
:type Zone: str
|
|
1352
|
-
:param _Period:
|
|
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
|
+
|
|
1353
1514
|
:type Period: int
|
|
1354
|
-
:param _MachineCode:
|
|
1515
|
+
:param _MachineCode: Product specification type.
|
|
1516
|
+
- HIO10G: general high-I/O 10GE type.
|
|
1517
|
+
- HCD: cloud disk type.
|
|
1355
1518
|
:type MachineCode: str
|
|
1356
|
-
:param _ClusterType: Instance type.
|
|
1519
|
+
:param _ClusterType: Instance architecture type.
|
|
1520
|
+
- REPLSET: replica set.
|
|
1521
|
+
- SHARD: sharded cluster.
|
|
1357
1522
|
:type ClusterType: str
|
|
1358
|
-
:param _ReplicateSetNum:
|
|
1523
|
+
:param _ReplicateSetNum: - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1.
|
|
1524
|
+
- Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively.
|
|
1359
1525
|
:type ReplicateSetNum: int
|
|
1360
|
-
:param _ProjectId: Project ID.
|
|
1526
|
+
:param _ProjectId: Project ID. - The default project is used if this parameter is not specified.
|
|
1527
|
+
- The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project).
|
|
1361
1528
|
:type ProjectId: int
|
|
1362
|
-
:param _VpcId: VPC ID.
|
|
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.
|
|
1363
1530
|
:type VpcId: str
|
|
1364
|
-
:param _SubnetId: VPC subnet
|
|
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.
|
|
1365
1532
|
:type SubnetId: str
|
|
1366
|
-
:param _Password: Instance password.
|
|
1533
|
+
:param _Password: Instance password. The requirements are as follows:
|
|
1534
|
+
- The number of characters should be in the range of [8, 32].
|
|
1535
|
+
- Characters within the ranges [A,Z], [a,z], and [0,9] are allowed.
|
|
1536
|
+
- Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_).
|
|
1537
|
+
- It cannot contain only the same letters or digits.
|
|
1367
1538
|
:type Password: str
|
|
1368
1539
|
:param _Tags: Instance tag information.
|
|
1369
1540
|
:type Tags: list of TagInfo
|
|
1370
|
-
:param _AutoRenewFlag:
|
|
1541
|
+
:param _AutoRenewFlag: Automatic renewal flag.
|
|
1542
|
+
- 0: no automatic renewal.
|
|
1543
|
+
- 1: automatic renewal.
|
|
1371
1544
|
:type AutoRenewFlag: int
|
|
1372
|
-
:param _AutoVoucher: Whether to automatically
|
|
1545
|
+
:param _AutoVoucher: Whether to automatically select a voucher.
|
|
1546
|
+
- 1: yes.
|
|
1547
|
+
- 0: no. Default value: 0.
|
|
1373
1548
|
:type AutoVoucher: int
|
|
1374
|
-
:param _Clone: Instance type.
|
|
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.
|
|
1375
1550
|
:type Clone: int
|
|
1376
|
-
:param _Father:
|
|
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.
|
|
1377
1552
|
:type Father: str
|
|
1378
|
-
:param _SecurityGroup: Security group.
|
|
1553
|
+
:param _SecurityGroup: Security group ID.
|
|
1379
1554
|
:type SecurityGroup: list of str
|
|
1380
|
-
:param _RestoreTime:
|
|
1555
|
+
: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.
|
|
1381
1556
|
:type RestoreTime: str
|
|
1382
|
-
:param _InstanceName: Instance name
|
|
1557
|
+
:param _InstanceName: Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.
|
|
1383
1558
|
:type InstanceName: str
|
|
1384
|
-
:param _AvailabilityZoneList:
|
|
1559
|
+
:param _AvailabilityZoneList: Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.
|
|
1560
|
+
- 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].
|
|
1561
|
+
- 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.
|
|
1562
|
+
- 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.
|
|
1385
1563
|
:type AvailabilityZoneList: list of str
|
|
1386
|
-
:param _MongosCpu:
|
|
1564
|
+
: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.
|
|
1387
1565
|
:type MongosCpu: int
|
|
1388
|
-
:param _MongosMemory:
|
|
1566
|
+
:param _MongosMemory: Mongos node memory size.
|
|
1567
|
+
- This parameter is required during sharded cluster instance purchase.
|
|
1568
|
+
- Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported.
|
|
1389
1569
|
:type MongosMemory: int
|
|
1390
|
-
:param _MongosNodeNum:
|
|
1570
|
+
:param _MongosNodeNum: Number of Mongos nodes. This parameter is required during sharded cluster instance purchase.
|
|
1571
|
+
- For instances in single-AZ deployment mode, the value range is [3,32].
|
|
1572
|
+
- For instances in multi-AZ deployment mode, the value range is [6,32].
|
|
1391
1573
|
:type MongosNodeNum: int
|
|
1392
|
-
:param _ReadonlyNodeNum: Number of read-only nodes. Value
|
|
1574
|
+
:param _ReadonlyNodeNum: Number of read-only nodes. Value ranges: [0,5].
|
|
1393
1575
|
:type ReadonlyNodeNum: int
|
|
1394
|
-
:param _ReadonlyNodeAvailabilityZoneList:
|
|
1576
|
+
:param _ReadonlyNodeAvailabilityZoneList: Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**.
|
|
1395
1577
|
:type ReadonlyNodeAvailabilityZoneList: list of str
|
|
1396
|
-
:param _HiddenZone:
|
|
1578
|
+
:param _HiddenZone: AZ of the hidden node. This parameter is required for instances in multi-AZ deployment mode.
|
|
1397
1579
|
: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.
|
|
1581
|
+
:type ParamTemplateId: str
|
|
1398
1582
|
"""
|
|
1399
1583
|
self._NodeNum = None
|
|
1400
1584
|
self._Memory = None
|
|
@@ -1425,10 +1609,12 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1425
1609
|
self._ReadonlyNodeNum = None
|
|
1426
1610
|
self._ReadonlyNodeAvailabilityZoneList = None
|
|
1427
1611
|
self._HiddenZone = None
|
|
1612
|
+
self._ParamTemplateId = None
|
|
1428
1613
|
|
|
1429
1614
|
@property
|
|
1430
1615
|
def NodeNum(self):
|
|
1431
|
-
"""
|
|
1616
|
+
""" - 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.
|
|
1617
|
+
- 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.
|
|
1432
1618
|
:rtype: int
|
|
1433
1619
|
"""
|
|
1434
1620
|
return self._NodeNum
|
|
@@ -1439,7 +1625,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1439
1625
|
|
|
1440
1626
|
@property
|
|
1441
1627
|
def Memory(self):
|
|
1442
|
-
"""Instance memory size
|
|
1628
|
+
"""Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications.
|
|
1443
1629
|
:rtype: int
|
|
1444
1630
|
"""
|
|
1445
1631
|
return self._Memory
|
|
@@ -1450,7 +1636,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1450
1636
|
|
|
1451
1637
|
@property
|
|
1452
1638
|
def Volume(self):
|
|
1453
|
-
"""Instance disk size
|
|
1639
|
+
"""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.
|
|
1454
1640
|
:rtype: int
|
|
1455
1641
|
"""
|
|
1456
1642
|
return self._Volume
|
|
@@ -1461,7 +1647,13 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1461
1647
|
|
|
1462
1648
|
@property
|
|
1463
1649
|
def MongoVersion(self):
|
|
1464
|
-
"""
|
|
1650
|
+
"""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.
|
|
1465
1657
|
:rtype: str
|
|
1466
1658
|
"""
|
|
1467
1659
|
return self._MongoVersion
|
|
@@ -1483,7 +1675,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1483
1675
|
|
|
1484
1676
|
@property
|
|
1485
1677
|
def Zone(self):
|
|
1486
|
-
"""AZ
|
|
1678
|
+
"""AZ information. Format: ap-guangzhou-2.
|
|
1679
|
+
- Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the specific information.
|
|
1680
|
+
- This parameter indicates the primary AZ. If multi-AZ deployment is adopted, the value of Zone should be one of the values of AvailabilityZoneList.
|
|
1487
1681
|
:rtype: str
|
|
1488
1682
|
"""
|
|
1489
1683
|
return self._Zone
|
|
@@ -1494,7 +1688,8 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1494
1688
|
|
|
1495
1689
|
@property
|
|
1496
1690
|
def Period(self):
|
|
1497
|
-
"""
|
|
1691
|
+
"""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
|
+
|
|
1498
1693
|
:rtype: int
|
|
1499
1694
|
"""
|
|
1500
1695
|
return self._Period
|
|
@@ -1505,7 +1700,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1505
1700
|
|
|
1506
1701
|
@property
|
|
1507
1702
|
def MachineCode(self):
|
|
1508
|
-
"""
|
|
1703
|
+
"""Product specification type.
|
|
1704
|
+
- HIO10G: general high-I/O 10GE type.
|
|
1705
|
+
- HCD: cloud disk type.
|
|
1509
1706
|
:rtype: str
|
|
1510
1707
|
"""
|
|
1511
1708
|
return self._MachineCode
|
|
@@ -1516,7 +1713,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1516
1713
|
|
|
1517
1714
|
@property
|
|
1518
1715
|
def ClusterType(self):
|
|
1519
|
-
"""Instance type.
|
|
1716
|
+
"""Instance architecture type.
|
|
1717
|
+
- REPLSET: replica set.
|
|
1718
|
+
- SHARD: sharded cluster.
|
|
1520
1719
|
:rtype: str
|
|
1521
1720
|
"""
|
|
1522
1721
|
return self._ClusterType
|
|
@@ -1527,7 +1726,8 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1527
1726
|
|
|
1528
1727
|
@property
|
|
1529
1728
|
def ReplicateSetNum(self):
|
|
1530
|
-
"""
|
|
1729
|
+
""" - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1.
|
|
1730
|
+
- Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively.
|
|
1531
1731
|
:rtype: int
|
|
1532
1732
|
"""
|
|
1533
1733
|
return self._ReplicateSetNum
|
|
@@ -1538,7 +1738,8 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1538
1738
|
|
|
1539
1739
|
@property
|
|
1540
1740
|
def ProjectId(self):
|
|
1541
|
-
"""Project ID.
|
|
1741
|
+
"""Project ID. - The default project is used if this parameter is not specified.
|
|
1742
|
+
- The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project).
|
|
1542
1743
|
:rtype: int
|
|
1543
1744
|
"""
|
|
1544
1745
|
return self._ProjectId
|
|
@@ -1549,7 +1750,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1549
1750
|
|
|
1550
1751
|
@property
|
|
1551
1752
|
def VpcId(self):
|
|
1552
|
-
"""VPC ID.
|
|
1753
|
+
"""VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.
|
|
1553
1754
|
:rtype: str
|
|
1554
1755
|
"""
|
|
1555
1756
|
return self._VpcId
|
|
@@ -1560,7 +1761,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1560
1761
|
|
|
1561
1762
|
@property
|
|
1562
1763
|
def SubnetId(self):
|
|
1563
|
-
"""VPC subnet
|
|
1764
|
+
"""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.
|
|
1564
1765
|
:rtype: str
|
|
1565
1766
|
"""
|
|
1566
1767
|
return self._SubnetId
|
|
@@ -1571,7 +1772,11 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1571
1772
|
|
|
1572
1773
|
@property
|
|
1573
1774
|
def Password(self):
|
|
1574
|
-
"""Instance password.
|
|
1775
|
+
"""Instance password. The requirements are as follows:
|
|
1776
|
+
- The number of characters should be in the range of [8, 32].
|
|
1777
|
+
- Characters within the ranges [A,Z], [a,z], and [0,9] are allowed.
|
|
1778
|
+
- Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_).
|
|
1779
|
+
- It cannot contain only the same letters or digits.
|
|
1575
1780
|
:rtype: str
|
|
1576
1781
|
"""
|
|
1577
1782
|
return self._Password
|
|
@@ -1593,7 +1798,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1593
1798
|
|
|
1594
1799
|
@property
|
|
1595
1800
|
def AutoRenewFlag(self):
|
|
1596
|
-
"""
|
|
1801
|
+
"""Automatic renewal flag.
|
|
1802
|
+
- 0: no automatic renewal.
|
|
1803
|
+
- 1: automatic renewal.
|
|
1597
1804
|
:rtype: int
|
|
1598
1805
|
"""
|
|
1599
1806
|
return self._AutoRenewFlag
|
|
@@ -1604,7 +1811,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1604
1811
|
|
|
1605
1812
|
@property
|
|
1606
1813
|
def AutoVoucher(self):
|
|
1607
|
-
"""Whether to automatically
|
|
1814
|
+
"""Whether to automatically select a voucher.
|
|
1815
|
+
- 1: yes.
|
|
1816
|
+
- 0: no. Default value: 0.
|
|
1608
1817
|
:rtype: int
|
|
1609
1818
|
"""
|
|
1610
1819
|
return self._AutoVoucher
|
|
@@ -1615,7 +1824,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1615
1824
|
|
|
1616
1825
|
@property
|
|
1617
1826
|
def Clone(self):
|
|
1618
|
-
"""Instance type.
|
|
1827
|
+
"""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.
|
|
1619
1828
|
:rtype: int
|
|
1620
1829
|
"""
|
|
1621
1830
|
return self._Clone
|
|
@@ -1626,7 +1835,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1626
1835
|
|
|
1627
1836
|
@property
|
|
1628
1837
|
def Father(self):
|
|
1629
|
-
"""
|
|
1838
|
+
"""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.
|
|
1630
1839
|
:rtype: str
|
|
1631
1840
|
"""
|
|
1632
1841
|
return self._Father
|
|
@@ -1637,7 +1846,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1637
1846
|
|
|
1638
1847
|
@property
|
|
1639
1848
|
def SecurityGroup(self):
|
|
1640
|
-
"""Security group.
|
|
1849
|
+
"""Security group ID.
|
|
1641
1850
|
:rtype: list of str
|
|
1642
1851
|
"""
|
|
1643
1852
|
return self._SecurityGroup
|
|
@@ -1648,7 +1857,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1648
1857
|
|
|
1649
1858
|
@property
|
|
1650
1859
|
def RestoreTime(self):
|
|
1651
|
-
"""
|
|
1860
|
+
"""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.
|
|
1652
1861
|
:rtype: str
|
|
1653
1862
|
"""
|
|
1654
1863
|
return self._RestoreTime
|
|
@@ -1659,7 +1868,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1659
1868
|
|
|
1660
1869
|
@property
|
|
1661
1870
|
def InstanceName(self):
|
|
1662
|
-
"""Instance name
|
|
1871
|
+
"""Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.
|
|
1663
1872
|
:rtype: str
|
|
1664
1873
|
"""
|
|
1665
1874
|
return self._InstanceName
|
|
@@ -1670,7 +1879,10 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1670
1879
|
|
|
1671
1880
|
@property
|
|
1672
1881
|
def AvailabilityZoneList(self):
|
|
1673
|
-
"""
|
|
1882
|
+
"""Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.
|
|
1883
|
+
- 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].
|
|
1884
|
+
- 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.
|
|
1885
|
+
- 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.
|
|
1674
1886
|
:rtype: list of str
|
|
1675
1887
|
"""
|
|
1676
1888
|
return self._AvailabilityZoneList
|
|
@@ -1681,7 +1893,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1681
1893
|
|
|
1682
1894
|
@property
|
|
1683
1895
|
def MongosCpu(self):
|
|
1684
|
-
"""
|
|
1896
|
+
"""Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase.
|
|
1685
1897
|
:rtype: int
|
|
1686
1898
|
"""
|
|
1687
1899
|
return self._MongosCpu
|
|
@@ -1692,7 +1904,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1692
1904
|
|
|
1693
1905
|
@property
|
|
1694
1906
|
def MongosMemory(self):
|
|
1695
|
-
"""
|
|
1907
|
+
"""Mongos node memory size.
|
|
1908
|
+
- This parameter is required during sharded cluster instance purchase.
|
|
1909
|
+
- Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported.
|
|
1696
1910
|
:rtype: int
|
|
1697
1911
|
"""
|
|
1698
1912
|
return self._MongosMemory
|
|
@@ -1703,7 +1917,9 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1703
1917
|
|
|
1704
1918
|
@property
|
|
1705
1919
|
def MongosNodeNum(self):
|
|
1706
|
-
"""
|
|
1920
|
+
"""Number of Mongos nodes. This parameter is required during sharded cluster instance purchase.
|
|
1921
|
+
- For instances in single-AZ deployment mode, the value range is [3,32].
|
|
1922
|
+
- For instances in multi-AZ deployment mode, the value range is [6,32].
|
|
1707
1923
|
:rtype: int
|
|
1708
1924
|
"""
|
|
1709
1925
|
return self._MongosNodeNum
|
|
@@ -1714,7 +1930,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1714
1930
|
|
|
1715
1931
|
@property
|
|
1716
1932
|
def ReadonlyNodeNum(self):
|
|
1717
|
-
"""Number of read-only nodes. Value
|
|
1933
|
+
"""Number of read-only nodes. Value ranges: [0,5].
|
|
1718
1934
|
:rtype: int
|
|
1719
1935
|
"""
|
|
1720
1936
|
return self._ReadonlyNodeNum
|
|
@@ -1725,7 +1941,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1725
1941
|
|
|
1726
1942
|
@property
|
|
1727
1943
|
def ReadonlyNodeAvailabilityZoneList(self):
|
|
1728
|
-
"""
|
|
1944
|
+
"""Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**.
|
|
1729
1945
|
:rtype: list of str
|
|
1730
1946
|
"""
|
|
1731
1947
|
return self._ReadonlyNodeAvailabilityZoneList
|
|
@@ -1736,7 +1952,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1736
1952
|
|
|
1737
1953
|
@property
|
|
1738
1954
|
def HiddenZone(self):
|
|
1739
|
-
"""
|
|
1955
|
+
"""AZ of the hidden node. This parameter is required for instances in multi-AZ deployment mode.
|
|
1740
1956
|
:rtype: str
|
|
1741
1957
|
"""
|
|
1742
1958
|
return self._HiddenZone
|
|
@@ -1745,6 +1961,17 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1745
1961
|
def HiddenZone(self, HiddenZone):
|
|
1746
1962
|
self._HiddenZone = HiddenZone
|
|
1747
1963
|
|
|
1964
|
+
@property
|
|
1965
|
+
def ParamTemplateId(self):
|
|
1966
|
+
"""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.
|
|
1967
|
+
:rtype: str
|
|
1968
|
+
"""
|
|
1969
|
+
return self._ParamTemplateId
|
|
1970
|
+
|
|
1971
|
+
@ParamTemplateId.setter
|
|
1972
|
+
def ParamTemplateId(self, ParamTemplateId):
|
|
1973
|
+
self._ParamTemplateId = ParamTemplateId
|
|
1974
|
+
|
|
1748
1975
|
|
|
1749
1976
|
def _deserialize(self, params):
|
|
1750
1977
|
self._NodeNum = params.get("NodeNum")
|
|
@@ -1781,6 +2008,7 @@ class CreateDBInstanceRequest(AbstractModel):
|
|
|
1781
2008
|
self._ReadonlyNodeNum = params.get("ReadonlyNodeNum")
|
|
1782
2009
|
self._ReadonlyNodeAvailabilityZoneList = params.get("ReadonlyNodeAvailabilityZoneList")
|
|
1783
2010
|
self._HiddenZone = params.get("HiddenZone")
|
|
2011
|
+
self._ParamTemplateId = params.get("ParamTemplateId")
|
|
1784
2012
|
memeber_set = set(params.keys())
|
|
1785
2013
|
for name, value in vars(self).items():
|
|
1786
2014
|
property_name = name[1:]
|
|
@@ -1802,7 +2030,7 @@ class CreateDBInstanceResponse(AbstractModel):
|
|
|
1802
2030
|
:type DealId: str
|
|
1803
2031
|
:param _InstanceIds: List of IDs of created instances.
|
|
1804
2032
|
:type InstanceIds: list of str
|
|
1805
|
-
:param _RequestId: The unique request ID,
|
|
2033
|
+
: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.
|
|
1806
2034
|
:type RequestId: str
|
|
1807
2035
|
"""
|
|
1808
2036
|
self._DealId = None
|
|
@@ -1833,7 +2061,7 @@ class CreateDBInstanceResponse(AbstractModel):
|
|
|
1833
2061
|
|
|
1834
2062
|
@property
|
|
1835
2063
|
def RequestId(self):
|
|
1836
|
-
"""The unique request ID,
|
|
2064
|
+
"""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.
|
|
1837
2065
|
:rtype: str
|
|
1838
2066
|
"""
|
|
1839
2067
|
return self._RequestId
|
|
@@ -1908,11 +2136,10 @@ class DBInstancePrice(AbstractModel):
|
|
|
1908
2136
|
def __init__(self):
|
|
1909
2137
|
r"""
|
|
1910
2138
|
:param _UnitPrice: Unit price.
|
|
1911
|
-
Note: this field may return null, indicating that no valid values can be obtained.
|
|
1912
2139
|
:type UnitPrice: float
|
|
1913
2140
|
:param _OriginalPrice: Original price.
|
|
1914
2141
|
:type OriginalPrice: float
|
|
1915
|
-
:param _DiscountPrice:
|
|
2142
|
+
:param _DiscountPrice: Discount price.
|
|
1916
2143
|
:type DiscountPrice: float
|
|
1917
2144
|
"""
|
|
1918
2145
|
self._UnitPrice = None
|
|
@@ -1922,7 +2149,6 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1922
2149
|
@property
|
|
1923
2150
|
def UnitPrice(self):
|
|
1924
2151
|
"""Unit price.
|
|
1925
|
-
Note: this field may return null, indicating that no valid values can be obtained.
|
|
1926
2152
|
:rtype: float
|
|
1927
2153
|
"""
|
|
1928
2154
|
return self._UnitPrice
|
|
@@ -1944,7 +2170,7 @@ Note: this field may return null, indicating that no valid values can be obtaine
|
|
|
1944
2170
|
|
|
1945
2171
|
@property
|
|
1946
2172
|
def DiscountPrice(self):
|
|
1947
|
-
"""
|
|
2173
|
+
"""Discount price.
|
|
1948
2174
|
:rtype: float
|
|
1949
2175
|
"""
|
|
1950
2176
|
return self._DiscountPrice
|
|
@@ -2013,7 +2239,7 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
|
|
|
2013
2239
|
r"""
|
|
2014
2240
|
: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`
|
|
2015
2241
|
:type Status: str
|
|
2016
|
-
:param _RequestId: The unique request ID,
|
|
2242
|
+
: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.
|
|
2017
2243
|
:type RequestId: str
|
|
2018
2244
|
"""
|
|
2019
2245
|
self._Status = None
|
|
@@ -2032,7 +2258,7 @@ class DescribeAsyncRequestInfoResponse(AbstractModel):
|
|
|
2032
2258
|
|
|
2033
2259
|
@property
|
|
2034
2260
|
def RequestId(self):
|
|
2035
|
-
"""The unique request ID,
|
|
2261
|
+
"""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.
|
|
2036
2262
|
:rtype: str
|
|
2037
2263
|
"""
|
|
2038
2264
|
return self._RequestId
|
|
@@ -2214,7 +2440,7 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
|
|
|
2214
2440
|
:type TotalCount: int
|
|
2215
2441
|
:param _Tasks: The list of download tasks
|
|
2216
2442
|
:type Tasks: list of BackupDownloadTask
|
|
2217
|
-
:param _RequestId: The unique request ID,
|
|
2443
|
+
: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.
|
|
2218
2444
|
:type RequestId: str
|
|
2219
2445
|
"""
|
|
2220
2446
|
self._TotalCount = None
|
|
@@ -2245,7 +2471,7 @@ class DescribeBackupDownloadTaskResponse(AbstractModel):
|
|
|
2245
2471
|
|
|
2246
2472
|
@property
|
|
2247
2473
|
def RequestId(self):
|
|
2248
|
-
"""The unique request ID,
|
|
2474
|
+
"""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.
|
|
2249
2475
|
:rtype: str
|
|
2250
2476
|
"""
|
|
2251
2477
|
return self._RequestId
|
|
@@ -2273,11 +2499,12 @@ class DescribeClientConnectionsRequest(AbstractModel):
|
|
|
2273
2499
|
|
|
2274
2500
|
def __init__(self):
|
|
2275
2501
|
r"""
|
|
2276
|
-
:param _InstanceId:
|
|
2502
|
+
:param _InstanceId: Specifies the ID of the instance to be queried. 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.
|
|
2503
|
+
|
|
2277
2504
|
:type InstanceId: str
|
|
2278
|
-
:param _Limit: Number of
|
|
2505
|
+
:param _Limit: Number of entries returned per request. Minimum value: 1. Maximum value: 1000. Default value: 1000.
|
|
2279
2506
|
:type Limit: int
|
|
2280
|
-
:param _Offset: Offset. Default value: 0.
|
|
2507
|
+
:param _Offset: Offset. Default value: 0. Offset = Limit x (page number - 1).
|
|
2281
2508
|
:type Offset: int
|
|
2282
2509
|
"""
|
|
2283
2510
|
self._InstanceId = None
|
|
@@ -2286,7 +2513,8 @@ class DescribeClientConnectionsRequest(AbstractModel):
|
|
|
2286
2513
|
|
|
2287
2514
|
@property
|
|
2288
2515
|
def InstanceId(self):
|
|
2289
|
-
"""
|
|
2516
|
+
"""Specifies the ID of the instance to be queried. 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.
|
|
2517
|
+
|
|
2290
2518
|
:rtype: str
|
|
2291
2519
|
"""
|
|
2292
2520
|
return self._InstanceId
|
|
@@ -2297,7 +2525,7 @@ class DescribeClientConnectionsRequest(AbstractModel):
|
|
|
2297
2525
|
|
|
2298
2526
|
@property
|
|
2299
2527
|
def Limit(self):
|
|
2300
|
-
"""Number of
|
|
2528
|
+
"""Number of entries returned per request. Minimum value: 1. Maximum value: 1000. Default value: 1000.
|
|
2301
2529
|
:rtype: int
|
|
2302
2530
|
"""
|
|
2303
2531
|
return self._Limit
|
|
@@ -2308,7 +2536,7 @@ class DescribeClientConnectionsRequest(AbstractModel):
|
|
|
2308
2536
|
|
|
2309
2537
|
@property
|
|
2310
2538
|
def Offset(self):
|
|
2311
|
-
"""Offset. Default value: 0.
|
|
2539
|
+
"""Offset. Default value: 0. Offset = Limit x (page number - 1).
|
|
2312
2540
|
:rtype: int
|
|
2313
2541
|
"""
|
|
2314
2542
|
return self._Offset
|
|
@@ -2339,11 +2567,11 @@ class DescribeClientConnectionsResponse(AbstractModel):
|
|
|
2339
2567
|
|
|
2340
2568
|
def __init__(self):
|
|
2341
2569
|
r"""
|
|
2342
|
-
:param _Clients: Client connection information, including client IP and
|
|
2570
|
+
:param _Clients: Client connection information, including the numbers of connections of the client IP address and the database access IP address.
|
|
2343
2571
|
:type Clients: list of ClientConnection
|
|
2344
2572
|
:param _TotalCount: The total number of records that meet the query condition, which can be used for paginated queries.
|
|
2345
2573
|
:type TotalCount: int
|
|
2346
|
-
:param _RequestId: The unique request ID,
|
|
2574
|
+
: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.
|
|
2347
2575
|
:type RequestId: str
|
|
2348
2576
|
"""
|
|
2349
2577
|
self._Clients = None
|
|
@@ -2352,7 +2580,7 @@ class DescribeClientConnectionsResponse(AbstractModel):
|
|
|
2352
2580
|
|
|
2353
2581
|
@property
|
|
2354
2582
|
def Clients(self):
|
|
2355
|
-
"""Client connection information, including client IP and
|
|
2583
|
+
"""Client connection information, including the numbers of connections of the client IP address and the database access IP address.
|
|
2356
2584
|
:rtype: list of ClientConnection
|
|
2357
2585
|
"""
|
|
2358
2586
|
return self._Clients
|
|
@@ -2374,7 +2602,7 @@ class DescribeClientConnectionsResponse(AbstractModel):
|
|
|
2374
2602
|
|
|
2375
2603
|
@property
|
|
2376
2604
|
def RequestId(self):
|
|
2377
|
-
"""The unique request ID,
|
|
2605
|
+
"""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.
|
|
2378
2606
|
:rtype: str
|
|
2379
2607
|
"""
|
|
2380
2608
|
return self._RequestId
|
|
@@ -2487,7 +2715,7 @@ class DescribeDBBackupsResponse(AbstractModel):
|
|
|
2487
2715
|
:type BackupList: list of BackupInfo
|
|
2488
2716
|
:param _TotalCount: Total number of backups
|
|
2489
2717
|
:type TotalCount: int
|
|
2490
|
-
:param _RequestId: The unique request ID,
|
|
2718
|
+
: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.
|
|
2491
2719
|
:type RequestId: str
|
|
2492
2720
|
"""
|
|
2493
2721
|
self._BackupList = None
|
|
@@ -2518,7 +2746,7 @@ class DescribeDBBackupsResponse(AbstractModel):
|
|
|
2518
2746
|
|
|
2519
2747
|
@property
|
|
2520
2748
|
def RequestId(self):
|
|
2521
|
-
"""The unique request ID,
|
|
2749
|
+
"""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.
|
|
2522
2750
|
:rtype: str
|
|
2523
2751
|
"""
|
|
2524
2752
|
return self._RequestId
|
|
@@ -2590,13 +2818,16 @@ class DescribeDBInstanceDealResponse(AbstractModel):
|
|
|
2590
2818
|
:type DiscountPrice: float
|
|
2591
2819
|
:param _Action: Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.
|
|
2592
2820
|
:type Action: str
|
|
2593
|
-
:param
|
|
2821
|
+
:param _InstanceId: Resource ID of the current order.
|
|
2822
|
+
:type InstanceId: str
|
|
2823
|
+
: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.
|
|
2594
2824
|
:type RequestId: str
|
|
2595
2825
|
"""
|
|
2596
2826
|
self._Status = None
|
|
2597
2827
|
self._OriginalPrice = None
|
|
2598
2828
|
self._DiscountPrice = None
|
|
2599
2829
|
self._Action = None
|
|
2830
|
+
self._InstanceId = None
|
|
2600
2831
|
self._RequestId = None
|
|
2601
2832
|
|
|
2602
2833
|
@property
|
|
@@ -2643,9 +2874,20 @@ class DescribeDBInstanceDealResponse(AbstractModel):
|
|
|
2643
2874
|
def Action(self, Action):
|
|
2644
2875
|
self._Action = Action
|
|
2645
2876
|
|
|
2877
|
+
@property
|
|
2878
|
+
def InstanceId(self):
|
|
2879
|
+
"""Resource ID of the current order.
|
|
2880
|
+
:rtype: str
|
|
2881
|
+
"""
|
|
2882
|
+
return self._InstanceId
|
|
2883
|
+
|
|
2884
|
+
@InstanceId.setter
|
|
2885
|
+
def InstanceId(self, InstanceId):
|
|
2886
|
+
self._InstanceId = InstanceId
|
|
2887
|
+
|
|
2646
2888
|
@property
|
|
2647
2889
|
def RequestId(self):
|
|
2648
|
-
"""The unique request ID,
|
|
2890
|
+
"""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.
|
|
2649
2891
|
:rtype: str
|
|
2650
2892
|
"""
|
|
2651
2893
|
return self._RequestId
|
|
@@ -2660,6 +2902,116 @@ class DescribeDBInstanceDealResponse(AbstractModel):
|
|
|
2660
2902
|
self._OriginalPrice = params.get("OriginalPrice")
|
|
2661
2903
|
self._DiscountPrice = params.get("DiscountPrice")
|
|
2662
2904
|
self._Action = params.get("Action")
|
|
2905
|
+
self._InstanceId = params.get("InstanceId")
|
|
2906
|
+
self._RequestId = params.get("RequestId")
|
|
2907
|
+
|
|
2908
|
+
|
|
2909
|
+
class DescribeDBInstanceNamespaceRequest(AbstractModel):
|
|
2910
|
+
"""DescribeDBInstanceNamespace request structure.
|
|
2911
|
+
|
|
2912
|
+
"""
|
|
2913
|
+
|
|
2914
|
+
def __init__(self):
|
|
2915
|
+
r"""
|
|
2916
|
+
:param _InstanceId: Specifies the instance ID for querying the database. Batch querying is supported. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
|
|
2917
|
+
:type InstanceId: str
|
|
2918
|
+
:param _DbName: Specifies the database name for querying. If this parameter is left blank, a list of all databases of the current instance is returned.
|
|
2919
|
+
:type DbName: str
|
|
2920
|
+
"""
|
|
2921
|
+
self._InstanceId = None
|
|
2922
|
+
self._DbName = None
|
|
2923
|
+
|
|
2924
|
+
@property
|
|
2925
|
+
def InstanceId(self):
|
|
2926
|
+
"""Specifies the instance ID for querying the database. Batch querying is supported. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list.
|
|
2927
|
+
:rtype: str
|
|
2928
|
+
"""
|
|
2929
|
+
return self._InstanceId
|
|
2930
|
+
|
|
2931
|
+
@InstanceId.setter
|
|
2932
|
+
def InstanceId(self, InstanceId):
|
|
2933
|
+
self._InstanceId = InstanceId
|
|
2934
|
+
|
|
2935
|
+
@property
|
|
2936
|
+
def DbName(self):
|
|
2937
|
+
"""Specifies the database name for querying. If this parameter is left blank, a list of all databases of the current instance is returned.
|
|
2938
|
+
:rtype: str
|
|
2939
|
+
"""
|
|
2940
|
+
return self._DbName
|
|
2941
|
+
|
|
2942
|
+
@DbName.setter
|
|
2943
|
+
def DbName(self, DbName):
|
|
2944
|
+
self._DbName = DbName
|
|
2945
|
+
|
|
2946
|
+
|
|
2947
|
+
def _deserialize(self, params):
|
|
2948
|
+
self._InstanceId = params.get("InstanceId")
|
|
2949
|
+
self._DbName = params.get("DbName")
|
|
2950
|
+
memeber_set = set(params.keys())
|
|
2951
|
+
for name, value in vars(self).items():
|
|
2952
|
+
property_name = name[1:]
|
|
2953
|
+
if property_name in memeber_set:
|
|
2954
|
+
memeber_set.remove(property_name)
|
|
2955
|
+
if len(memeber_set) > 0:
|
|
2956
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
2957
|
+
|
|
2958
|
+
|
|
2959
|
+
|
|
2960
|
+
class DescribeDBInstanceNamespaceResponse(AbstractModel):
|
|
2961
|
+
"""DescribeDBInstanceNamespace response structure.
|
|
2962
|
+
|
|
2963
|
+
"""
|
|
2964
|
+
|
|
2965
|
+
def __init__(self):
|
|
2966
|
+
r"""
|
|
2967
|
+
:param _Databases: List of databases of the queried instance. If no database is specified for querying with DbName, a list of databases of only the queried instance is returned instead of the information indicated by Collections.
|
|
2968
|
+
:type Databases: list of str
|
|
2969
|
+
:param _Collections: Queried collection information. If DbName is specified, a list of collections of only this database is returned.
|
|
2970
|
+
:type Collections: list of str
|
|
2971
|
+
: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.
|
|
2972
|
+
:type RequestId: str
|
|
2973
|
+
"""
|
|
2974
|
+
self._Databases = None
|
|
2975
|
+
self._Collections = None
|
|
2976
|
+
self._RequestId = None
|
|
2977
|
+
|
|
2978
|
+
@property
|
|
2979
|
+
def Databases(self):
|
|
2980
|
+
"""List of databases of the queried instance. If no database is specified for querying with DbName, a list of databases of only the queried instance is returned instead of the information indicated by Collections.
|
|
2981
|
+
:rtype: list of str
|
|
2982
|
+
"""
|
|
2983
|
+
return self._Databases
|
|
2984
|
+
|
|
2985
|
+
@Databases.setter
|
|
2986
|
+
def Databases(self, Databases):
|
|
2987
|
+
self._Databases = Databases
|
|
2988
|
+
|
|
2989
|
+
@property
|
|
2990
|
+
def Collections(self):
|
|
2991
|
+
"""Queried collection information. If DbName is specified, a list of collections of only this database is returned.
|
|
2992
|
+
:rtype: list of str
|
|
2993
|
+
"""
|
|
2994
|
+
return self._Collections
|
|
2995
|
+
|
|
2996
|
+
@Collections.setter
|
|
2997
|
+
def Collections(self, Collections):
|
|
2998
|
+
self._Collections = Collections
|
|
2999
|
+
|
|
3000
|
+
@property
|
|
3001
|
+
def RequestId(self):
|
|
3002
|
+
"""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.
|
|
3003
|
+
:rtype: str
|
|
3004
|
+
"""
|
|
3005
|
+
return self._RequestId
|
|
3006
|
+
|
|
3007
|
+
@RequestId.setter
|
|
3008
|
+
def RequestId(self, RequestId):
|
|
3009
|
+
self._RequestId = RequestId
|
|
3010
|
+
|
|
3011
|
+
|
|
3012
|
+
def _deserialize(self, params):
|
|
3013
|
+
self._Databases = params.get("Databases")
|
|
3014
|
+
self._Collections = params.get("Collections")
|
|
2663
3015
|
self._RequestId = params.get("RequestId")
|
|
2664
3016
|
|
|
2665
3017
|
|
|
@@ -2670,17 +3022,21 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2670
3022
|
|
|
2671
3023
|
def __init__(self):
|
|
2672
3024
|
r"""
|
|
2673
|
-
:param _InstanceIds:
|
|
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.
|
|
2674
3026
|
:type InstanceIds: list of str
|
|
2675
|
-
:param _InstanceType:
|
|
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>
|
|
2676
3028
|
:type InstanceType: int
|
|
2677
|
-
:param _ClusterType:
|
|
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>
|
|
2678
3030
|
:type ClusterType: int
|
|
2679
|
-
:param _Status:
|
|
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>
|
|
2680
3032
|
:type Status: list of int
|
|
2681
|
-
:param _VpcId: VPC ID.
|
|
3033
|
+
:param _VpcId: VPC ID.
|
|
3034
|
+
- You do not need to specify this parameter for basic networks.
|
|
3035
|
+
- Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page.
|
|
2682
3036
|
:type VpcId: str
|
|
2683
|
-
:param _SubnetId:
|
|
3037
|
+
:param _SubnetId: VPC subnet ID.
|
|
3038
|
+
- You do not need to specify this parameter for basic networks.
|
|
3039
|
+
- Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page.
|
|
2684
3040
|
:type SubnetId: str
|
|
2685
3041
|
:param _PayMode: Billing type. Valid value: 0 (pay-as-you-go)
|
|
2686
3042
|
:type PayMode: int
|
|
@@ -2688,15 +3044,17 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2688
3044
|
:type Limit: int
|
|
2689
3045
|
:param _Offset: Offset. Default value: `0`.
|
|
2690
3046
|
:type Offset: int
|
|
2691
|
-
:param _OrderBy:
|
|
3047
|
+
:param _OrderBy: Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.
|
|
2692
3048
|
:type OrderBy: str
|
|
2693
|
-
:param _OrderByType:
|
|
3049
|
+
:param _OrderByType: Configures the method for sorting returned results.
|
|
3050
|
+
- ASC: ascending order.
|
|
3051
|
+
- DESC: descending order.
|
|
2694
3052
|
:type OrderByType: str
|
|
2695
|
-
:param _ProjectIds: Project ID
|
|
3053
|
+
:param _ProjectIds: Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects.
|
|
2696
3054
|
:type ProjectIds: list of int non-negative
|
|
2697
|
-
:param _SearchKey:
|
|
3055
|
+
:param _SearchKey: Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.
|
|
2698
3056
|
:type SearchKey: str
|
|
2699
|
-
:param _Tags: Tag information
|
|
3057
|
+
:param _Tags: Tag information, including the tag key and tag value.
|
|
2700
3058
|
:type Tags: list of TagInfo
|
|
2701
3059
|
"""
|
|
2702
3060
|
self._InstanceIds = None
|
|
@@ -2716,7 +3074,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2716
3074
|
|
|
2717
3075
|
@property
|
|
2718
3076
|
def InstanceIds(self):
|
|
2719
|
-
"""
|
|
3077
|
+
"""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.
|
|
2720
3078
|
:rtype: list of str
|
|
2721
3079
|
"""
|
|
2722
3080
|
return self._InstanceIds
|
|
@@ -2727,7 +3085,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2727
3085
|
|
|
2728
3086
|
@property
|
|
2729
3087
|
def InstanceType(self):
|
|
2730
|
-
"""
|
|
3088
|
+
"""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>
|
|
2731
3089
|
:rtype: int
|
|
2732
3090
|
"""
|
|
2733
3091
|
return self._InstanceType
|
|
@@ -2738,7 +3096,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2738
3096
|
|
|
2739
3097
|
@property
|
|
2740
3098
|
def ClusterType(self):
|
|
2741
|
-
"""
|
|
3099
|
+
"""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>
|
|
2742
3100
|
:rtype: int
|
|
2743
3101
|
"""
|
|
2744
3102
|
return self._ClusterType
|
|
@@ -2749,7 +3107,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2749
3107
|
|
|
2750
3108
|
@property
|
|
2751
3109
|
def Status(self):
|
|
2752
|
-
"""
|
|
3110
|
+
"""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>
|
|
2753
3111
|
:rtype: list of int
|
|
2754
3112
|
"""
|
|
2755
3113
|
return self._Status
|
|
@@ -2760,7 +3118,9 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2760
3118
|
|
|
2761
3119
|
@property
|
|
2762
3120
|
def VpcId(self):
|
|
2763
|
-
"""VPC ID.
|
|
3121
|
+
"""VPC ID.
|
|
3122
|
+
- You do not need to specify this parameter for basic networks.
|
|
3123
|
+
- Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page.
|
|
2764
3124
|
:rtype: str
|
|
2765
3125
|
"""
|
|
2766
3126
|
return self._VpcId
|
|
@@ -2771,7 +3131,9 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2771
3131
|
|
|
2772
3132
|
@property
|
|
2773
3133
|
def SubnetId(self):
|
|
2774
|
-
"""
|
|
3134
|
+
"""VPC subnet ID.
|
|
3135
|
+
- You do not need to specify this parameter for basic networks.
|
|
3136
|
+
- Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page.
|
|
2775
3137
|
:rtype: str
|
|
2776
3138
|
"""
|
|
2777
3139
|
return self._SubnetId
|
|
@@ -2815,7 +3177,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2815
3177
|
|
|
2816
3178
|
@property
|
|
2817
3179
|
def OrderBy(self):
|
|
2818
|
-
"""
|
|
3180
|
+
"""Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting.
|
|
2819
3181
|
:rtype: str
|
|
2820
3182
|
"""
|
|
2821
3183
|
return self._OrderBy
|
|
@@ -2826,7 +3188,9 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2826
3188
|
|
|
2827
3189
|
@property
|
|
2828
3190
|
def OrderByType(self):
|
|
2829
|
-
"""
|
|
3191
|
+
"""Configures the method for sorting returned results.
|
|
3192
|
+
- ASC: ascending order.
|
|
3193
|
+
- DESC: descending order.
|
|
2830
3194
|
:rtype: str
|
|
2831
3195
|
"""
|
|
2832
3196
|
return self._OrderByType
|
|
@@ -2837,7 +3201,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2837
3201
|
|
|
2838
3202
|
@property
|
|
2839
3203
|
def ProjectIds(self):
|
|
2840
|
-
"""Project ID
|
|
3204
|
+
"""Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects.
|
|
2841
3205
|
:rtype: list of int non-negative
|
|
2842
3206
|
"""
|
|
2843
3207
|
return self._ProjectIds
|
|
@@ -2848,7 +3212,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2848
3212
|
|
|
2849
3213
|
@property
|
|
2850
3214
|
def SearchKey(self):
|
|
2851
|
-
"""
|
|
3215
|
+
"""Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported.
|
|
2852
3216
|
:rtype: str
|
|
2853
3217
|
"""
|
|
2854
3218
|
return self._SearchKey
|
|
@@ -2859,7 +3223,7 @@ class DescribeDBInstancesRequest(AbstractModel):
|
|
|
2859
3223
|
|
|
2860
3224
|
@property
|
|
2861
3225
|
def Tags(self):
|
|
2862
|
-
"""Tag information
|
|
3226
|
+
"""Tag information, including the tag key and tag value.
|
|
2863
3227
|
:rtype: list of TagInfo
|
|
2864
3228
|
"""
|
|
2865
3229
|
return self._Tags
|
|
@@ -2910,7 +3274,7 @@ class DescribeDBInstancesResponse(AbstractModel):
|
|
|
2910
3274
|
:type TotalCount: int
|
|
2911
3275
|
:param _InstanceDetails: List of instance details
|
|
2912
3276
|
:type InstanceDetails: list of InstanceDetail
|
|
2913
|
-
:param _RequestId: The unique request ID,
|
|
3277
|
+
: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.
|
|
2914
3278
|
:type RequestId: str
|
|
2915
3279
|
"""
|
|
2916
3280
|
self._TotalCount = None
|
|
@@ -2941,7 +3305,7 @@ class DescribeDBInstancesResponse(AbstractModel):
|
|
|
2941
3305
|
|
|
2942
3306
|
@property
|
|
2943
3307
|
def RequestId(self):
|
|
2944
|
-
"""The unique request ID,
|
|
3308
|
+
"""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.
|
|
2945
3309
|
:rtype: str
|
|
2946
3310
|
"""
|
|
2947
3311
|
return self._RequestId
|
|
@@ -2969,14 +3333,14 @@ class DescribeInstanceParamsRequest(AbstractModel):
|
|
|
2969
3333
|
|
|
2970
3334
|
def __init__(self):
|
|
2971
3335
|
r"""
|
|
2972
|
-
:param _InstanceId:
|
|
3336
|
+
:param _InstanceId: Specifies the instance ID for querying the parameter 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.
|
|
2973
3337
|
:type InstanceId: str
|
|
2974
3338
|
"""
|
|
2975
3339
|
self._InstanceId = None
|
|
2976
3340
|
|
|
2977
3341
|
@property
|
|
2978
3342
|
def InstanceId(self):
|
|
2979
|
-
"""
|
|
3343
|
+
"""Specifies the instance ID for querying the parameter 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.
|
|
2980
3344
|
:rtype: str
|
|
2981
3345
|
"""
|
|
2982
3346
|
return self._InstanceId
|
|
@@ -3005,17 +3369,17 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3005
3369
|
|
|
3006
3370
|
def __init__(self):
|
|
3007
3371
|
r"""
|
|
3008
|
-
:param _InstanceEnumParam:
|
|
3372
|
+
:param _InstanceEnumParam: Collection of parameters whose values are of the Enum type.
|
|
3009
3373
|
:type InstanceEnumParam: list of InstanceEnumParam
|
|
3010
|
-
:param _InstanceIntegerParam:
|
|
3374
|
+
:param _InstanceIntegerParam: Collection of parameters whose values are of the Integer type.
|
|
3011
3375
|
:type InstanceIntegerParam: list of InstanceIntegerParam
|
|
3012
|
-
:param _InstanceTextParam:
|
|
3376
|
+
:param _InstanceTextParam: Collection of parameters whose values are of the Text type.
|
|
3013
3377
|
:type InstanceTextParam: list of InstanceTextParam
|
|
3014
|
-
:param _InstanceMultiParam:
|
|
3378
|
+
:param _InstanceMultiParam: Collection of parameters whose values are of different types.
|
|
3015
3379
|
:type InstanceMultiParam: list of InstanceMultiParam
|
|
3016
|
-
:param _TotalCount:
|
|
3380
|
+
:param _TotalCount: Number of modifiable parameters supported by the current instance.
|
|
3017
3381
|
:type TotalCount: int
|
|
3018
|
-
:param _RequestId: The unique request ID,
|
|
3382
|
+
: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.
|
|
3019
3383
|
:type RequestId: str
|
|
3020
3384
|
"""
|
|
3021
3385
|
self._InstanceEnumParam = None
|
|
@@ -3027,7 +3391,7 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3027
3391
|
|
|
3028
3392
|
@property
|
|
3029
3393
|
def InstanceEnumParam(self):
|
|
3030
|
-
"""
|
|
3394
|
+
"""Collection of parameters whose values are of the Enum type.
|
|
3031
3395
|
:rtype: list of InstanceEnumParam
|
|
3032
3396
|
"""
|
|
3033
3397
|
return self._InstanceEnumParam
|
|
@@ -3038,7 +3402,7 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3038
3402
|
|
|
3039
3403
|
@property
|
|
3040
3404
|
def InstanceIntegerParam(self):
|
|
3041
|
-
"""
|
|
3405
|
+
"""Collection of parameters whose values are of the Integer type.
|
|
3042
3406
|
:rtype: list of InstanceIntegerParam
|
|
3043
3407
|
"""
|
|
3044
3408
|
return self._InstanceIntegerParam
|
|
@@ -3049,7 +3413,7 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3049
3413
|
|
|
3050
3414
|
@property
|
|
3051
3415
|
def InstanceTextParam(self):
|
|
3052
|
-
"""
|
|
3416
|
+
"""Collection of parameters whose values are of the Text type.
|
|
3053
3417
|
:rtype: list of InstanceTextParam
|
|
3054
3418
|
"""
|
|
3055
3419
|
return self._InstanceTextParam
|
|
@@ -3060,7 +3424,7 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3060
3424
|
|
|
3061
3425
|
@property
|
|
3062
3426
|
def InstanceMultiParam(self):
|
|
3063
|
-
"""
|
|
3427
|
+
"""Collection of parameters whose values are of different types.
|
|
3064
3428
|
:rtype: list of InstanceMultiParam
|
|
3065
3429
|
"""
|
|
3066
3430
|
return self._InstanceMultiParam
|
|
@@ -3071,7 +3435,7 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3071
3435
|
|
|
3072
3436
|
@property
|
|
3073
3437
|
def TotalCount(self):
|
|
3074
|
-
"""
|
|
3438
|
+
"""Number of modifiable parameters supported by the current instance.
|
|
3075
3439
|
:rtype: int
|
|
3076
3440
|
"""
|
|
3077
3441
|
return self._TotalCount
|
|
@@ -3082,7 +3446,7 @@ class DescribeInstanceParamsResponse(AbstractModel):
|
|
|
3082
3446
|
|
|
3083
3447
|
@property
|
|
3084
3448
|
def RequestId(self):
|
|
3085
|
-
"""The unique request ID,
|
|
3449
|
+
"""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.
|
|
3086
3450
|
:rtype: str
|
|
3087
3451
|
"""
|
|
3088
3452
|
return self._RequestId
|
|
@@ -3128,14 +3492,14 @@ class DescribeSecurityGroupRequest(AbstractModel):
|
|
|
3128
3492
|
|
|
3129
3493
|
def __init__(self):
|
|
3130
3494
|
r"""
|
|
3131
|
-
:param _InstanceId: Instance ID
|
|
3495
|
+
:param _InstanceId: Instance ID. For example, cmgo-p8vn****.
|
|
3132
3496
|
:type InstanceId: str
|
|
3133
3497
|
"""
|
|
3134
3498
|
self._InstanceId = None
|
|
3135
3499
|
|
|
3136
3500
|
@property
|
|
3137
3501
|
def InstanceId(self):
|
|
3138
|
-
"""Instance ID
|
|
3502
|
+
"""Instance ID. For example, cmgo-p8vn****.
|
|
3139
3503
|
:rtype: str
|
|
3140
3504
|
"""
|
|
3141
3505
|
return self._InstanceId
|
|
@@ -3164,9 +3528,9 @@ class DescribeSecurityGroupResponse(AbstractModel):
|
|
|
3164
3528
|
|
|
3165
3529
|
def __init__(self):
|
|
3166
3530
|
r"""
|
|
3167
|
-
:param _Groups:
|
|
3531
|
+
:param _Groups: Information on security groups bound to the instance.
|
|
3168
3532
|
:type Groups: list of SecurityGroup
|
|
3169
|
-
:param _RequestId: The unique request ID,
|
|
3533
|
+
: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.
|
|
3170
3534
|
:type RequestId: str
|
|
3171
3535
|
"""
|
|
3172
3536
|
self._Groups = None
|
|
@@ -3174,7 +3538,7 @@ class DescribeSecurityGroupResponse(AbstractModel):
|
|
|
3174
3538
|
|
|
3175
3539
|
@property
|
|
3176
3540
|
def Groups(self):
|
|
3177
|
-
"""
|
|
3541
|
+
"""Information on security groups bound to the instance.
|
|
3178
3542
|
:rtype: list of SecurityGroup
|
|
3179
3543
|
"""
|
|
3180
3544
|
return self._Groups
|
|
@@ -3185,7 +3549,7 @@ class DescribeSecurityGroupResponse(AbstractModel):
|
|
|
3185
3549
|
|
|
3186
3550
|
@property
|
|
3187
3551
|
def RequestId(self):
|
|
3188
|
-
"""The unique request ID,
|
|
3552
|
+
"""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.
|
|
3189
3553
|
:rtype: str
|
|
3190
3554
|
"""
|
|
3191
3555
|
return self._RequestId
|
|
@@ -3342,7 +3706,7 @@ class DescribeSlowLogPatternsResponse(AbstractModel):
|
|
|
3342
3706
|
:type Count: int
|
|
3343
3707
|
:param _SlowLogPatterns: Slow log statistics
|
|
3344
3708
|
:type SlowLogPatterns: list of SlowLogPattern
|
|
3345
|
-
:param _RequestId: The unique request ID,
|
|
3709
|
+
: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.
|
|
3346
3710
|
:type RequestId: str
|
|
3347
3711
|
"""
|
|
3348
3712
|
self._Count = None
|
|
@@ -3373,7 +3737,7 @@ class DescribeSlowLogPatternsResponse(AbstractModel):
|
|
|
3373
3737
|
|
|
3374
3738
|
@property
|
|
3375
3739
|
def RequestId(self):
|
|
3376
|
-
"""The unique request ID,
|
|
3740
|
+
"""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.
|
|
3377
3741
|
:rtype: str
|
|
3378
3742
|
"""
|
|
3379
3743
|
return self._RequestId
|
|
@@ -3529,9 +3893,9 @@ class DescribeSlowLogsResponse(AbstractModel):
|
|
|
3529
3893
|
r"""
|
|
3530
3894
|
:param _Count: Total number of slow logs
|
|
3531
3895
|
:type Count: int
|
|
3532
|
-
:param _SlowLogs: Slow log details
|
|
3896
|
+
:param _SlowLogs: Slow log details.
|
|
3533
3897
|
:type SlowLogs: list of str
|
|
3534
|
-
:param _RequestId: The unique request ID,
|
|
3898
|
+
: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.
|
|
3535
3899
|
:type RequestId: str
|
|
3536
3900
|
"""
|
|
3537
3901
|
self._Count = None
|
|
@@ -3551,7 +3915,7 @@ class DescribeSlowLogsResponse(AbstractModel):
|
|
|
3551
3915
|
|
|
3552
3916
|
@property
|
|
3553
3917
|
def SlowLogs(self):
|
|
3554
|
-
"""Slow log details
|
|
3918
|
+
"""Slow log details.
|
|
3555
3919
|
:rtype: list of str
|
|
3556
3920
|
"""
|
|
3557
3921
|
return self._SlowLogs
|
|
@@ -3562,7 +3926,7 @@ class DescribeSlowLogsResponse(AbstractModel):
|
|
|
3562
3926
|
|
|
3563
3927
|
@property
|
|
3564
3928
|
def RequestId(self):
|
|
3565
|
-
"""The unique request ID,
|
|
3929
|
+
"""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.
|
|
3566
3930
|
:rtype: str
|
|
3567
3931
|
"""
|
|
3568
3932
|
return self._RequestId
|
|
@@ -3623,7 +3987,7 @@ class DescribeSpecInfoResponse(AbstractModel):
|
|
|
3623
3987
|
r"""
|
|
3624
3988
|
:param _SpecInfoList: List of purchasable instance specifications
|
|
3625
3989
|
:type SpecInfoList: list of SpecificationInfo
|
|
3626
|
-
:param _RequestId: The unique request ID,
|
|
3990
|
+
: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.
|
|
3627
3991
|
:type RequestId: str
|
|
3628
3992
|
"""
|
|
3629
3993
|
self._SpecInfoList = None
|
|
@@ -3642,7 +4006,7 @@ class DescribeSpecInfoResponse(AbstractModel):
|
|
|
3642
4006
|
|
|
3643
4007
|
@property
|
|
3644
4008
|
def RequestId(self):
|
|
3645
|
-
"""The unique request ID,
|
|
4009
|
+
"""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.
|
|
3646
4010
|
:rtype: str
|
|
3647
4011
|
"""
|
|
3648
4012
|
return self._RequestId
|
|
@@ -3705,14 +4069,14 @@ class FlushInstanceRouterConfigResponse(AbstractModel):
|
|
|
3705
4069
|
|
|
3706
4070
|
def __init__(self):
|
|
3707
4071
|
r"""
|
|
3708
|
-
:param _RequestId: The unique request ID,
|
|
4072
|
+
: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.
|
|
3709
4073
|
:type RequestId: str
|
|
3710
4074
|
"""
|
|
3711
4075
|
self._RequestId = None
|
|
3712
4076
|
|
|
3713
4077
|
@property
|
|
3714
4078
|
def RequestId(self):
|
|
3715
|
-
"""The unique request ID,
|
|
4079
|
+
"""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.
|
|
3716
4080
|
:rtype: str
|
|
3717
4081
|
"""
|
|
3718
4082
|
return self._RequestId
|
|
@@ -3735,37 +4099,58 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3735
4099
|
r"""
|
|
3736
4100
|
:param _Zone: Instance region name in the format of ap-guangzhou-2.
|
|
3737
4101
|
:type Zone: str
|
|
3738
|
-
:param _NodeNum:
|
|
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.
|
|
3739
4104
|
:type NodeNum: int
|
|
3740
|
-
:param _Memory: Instance memory size
|
|
4105
|
+
:param _Memory: Instance memory size.
|
|
4106
|
+
|
|
4107
|
+
- Unit: GB.
|
|
4108
|
+
- For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The CPU and Memory parameters in the returned data structure SpecItems correspond to the number of CPU cores and the memory specification, respectively.
|
|
3741
4109
|
:type Memory: int
|
|
3742
|
-
:param _Volume:
|
|
4110
|
+
:param _Volume: Instance disk size.
|
|
4111
|
+
- Unit: GB.
|
|
4112
|
+
- 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.
|
|
3743
4113
|
:type Volume: int
|
|
3744
|
-
:param _MongoVersion: Instance version information.
|
|
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.
|
|
3745
4121
|
:type MongoVersion: str
|
|
3746
|
-
:param _MachineCode:
|
|
4122
|
+
:param _MachineCode: Product specification type.
|
|
4123
|
+
- HIO10G: general high-I/O 10GE type.
|
|
4124
|
+
- HCD: cloud disk.
|
|
3747
4125
|
:type MachineCode: str
|
|
3748
4126
|
:param _GoodsNum: Number of instances. Minimum value: 1. Maximum value: 10.
|
|
3749
4127
|
:type GoodsNum: int
|
|
3750
|
-
:param _ClusterType: Instance type.
|
|
4128
|
+
:param _ClusterType: Instance type.
|
|
4129
|
+
|
|
4130
|
+
- REPLSET: replica set.
|
|
4131
|
+
- SHARD: sharded cluster.
|
|
3751
4132
|
:type ClusterType: str
|
|
3752
|
-
:param _ReplicateSetNum:
|
|
4133
|
+
:param _ReplicateSetNum: - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1.
|
|
4134
|
+
- Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively.
|
|
3753
4135
|
:type ReplicateSetNum: int
|
|
3754
|
-
:param _Period:
|
|
4136
|
+
:param _Period: - When the monthly subscription mode is selected, that is, when <b>InstanceChargeType</b> is set to <b>PREPAID</b>, this parameter is required for specifying the purchase duration of instances. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Unit: months.
|
|
4137
|
+
- When pay-as-you-go is selected, that is, when <b>InstanceChargeType</b> is set to **POSTPAID_BY_HOUR**, this parameter only can be set to 1.
|
|
3755
4138
|
:type Period: int
|
|
3756
|
-
:param _InstanceChargeType:
|
|
4139
|
+
:param _InstanceChargeType: Instance payment method.
|
|
4140
|
+
- PREPAID: monthly subscription.
|
|
4141
|
+
- POSTPAID_BY_HOUR: pay-as-you-go.
|
|
3757
4142
|
:type InstanceChargeType: str
|
|
3758
|
-
:param _MongosCpu:
|
|
4143
|
+
: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. If this parameter is left blank, the default value 2 is used.
|
|
3759
4144
|
:type MongosCpu: int
|
|
3760
|
-
:param _MongosMemory:
|
|
4145
|
+
:param _MongosMemory: Mongos node memory size. - This parameter is required during sharded cluster instance purchase. - Unit: GB. Valid values: 2 (for 1 core), 4 (for 2 cores), 8 (for 4 cores), 16 (for 8 cores), and 32 (for 16 cores). If this parameter is left blank, the default value 4 is used.
|
|
3761
4146
|
:type MongosMemory: int
|
|
3762
|
-
:param _MongosNum:
|
|
4147
|
+
:param _MongosNum: Specifies the number of Mongos nodes. Value range: [3,32]. For querying the price of sharded cluster instances, this parameter is required. If it is left blank, the default value 3 is used.
|
|
3763
4148
|
:type MongosNum: int
|
|
3764
|
-
:param _ConfigServerCpu:
|
|
4149
|
+
:param _ConfigServerCpu: Specifies the number of ConfigServer CPU cores. The value is fixed as 1.
|
|
3765
4150
|
:type ConfigServerCpu: int
|
|
3766
|
-
:param _ConfigServerMemory:
|
|
4151
|
+
:param _ConfigServerMemory: Specifies the ConfigServer memory size. The value is fixed as 2. Unit: GB. This parameter can be left blank.
|
|
3767
4152
|
:type ConfigServerMemory: int
|
|
3768
|
-
:param _ConfigServerVolume:
|
|
4153
|
+
:param _ConfigServerVolume: Specifies the ConfigServer disk size. The value is fixed as 20. Unit: GB. This parameter can be left blank.
|
|
3769
4154
|
:type ConfigServerVolume: int
|
|
3770
4155
|
"""
|
|
3771
4156
|
self._Zone = None
|
|
@@ -3799,7 +4184,8 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3799
4184
|
|
|
3800
4185
|
@property
|
|
3801
4186
|
def NodeNum(self):
|
|
3802
|
-
"""
|
|
4187
|
+
""" - 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.
|
|
3803
4189
|
:rtype: int
|
|
3804
4190
|
"""
|
|
3805
4191
|
return self._NodeNum
|
|
@@ -3810,7 +4196,10 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3810
4196
|
|
|
3811
4197
|
@property
|
|
3812
4198
|
def Memory(self):
|
|
3813
|
-
"""Instance memory size
|
|
4199
|
+
"""Instance memory size.
|
|
4200
|
+
|
|
4201
|
+
- Unit: GB.
|
|
4202
|
+
- For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The CPU and Memory parameters in the returned data structure SpecItems correspond to the number of CPU cores and the memory specification, respectively.
|
|
3814
4203
|
:rtype: int
|
|
3815
4204
|
"""
|
|
3816
4205
|
return self._Memory
|
|
@@ -3821,7 +4210,9 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3821
4210
|
|
|
3822
4211
|
@property
|
|
3823
4212
|
def Volume(self):
|
|
3824
|
-
"""
|
|
4213
|
+
"""Instance disk size.
|
|
4214
|
+
- Unit: GB.
|
|
4215
|
+
- 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.
|
|
3825
4216
|
:rtype: int
|
|
3826
4217
|
"""
|
|
3827
4218
|
return self._Volume
|
|
@@ -3832,7 +4223,13 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3832
4223
|
|
|
3833
4224
|
@property
|
|
3834
4225
|
def MongoVersion(self):
|
|
3835
|
-
"""Instance version information.
|
|
4226
|
+
"""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.
|
|
3836
4233
|
:rtype: str
|
|
3837
4234
|
"""
|
|
3838
4235
|
return self._MongoVersion
|
|
@@ -3843,7 +4240,9 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3843
4240
|
|
|
3844
4241
|
@property
|
|
3845
4242
|
def MachineCode(self):
|
|
3846
|
-
"""
|
|
4243
|
+
"""Product specification type.
|
|
4244
|
+
- HIO10G: general high-I/O 10GE type.
|
|
4245
|
+
- HCD: cloud disk.
|
|
3847
4246
|
:rtype: str
|
|
3848
4247
|
"""
|
|
3849
4248
|
return self._MachineCode
|
|
@@ -3865,7 +4264,10 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3865
4264
|
|
|
3866
4265
|
@property
|
|
3867
4266
|
def ClusterType(self):
|
|
3868
|
-
"""Instance type.
|
|
4267
|
+
"""Instance type.
|
|
4268
|
+
|
|
4269
|
+
- REPLSET: replica set.
|
|
4270
|
+
- SHARD: sharded cluster.
|
|
3869
4271
|
:rtype: str
|
|
3870
4272
|
"""
|
|
3871
4273
|
return self._ClusterType
|
|
@@ -3876,7 +4278,8 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3876
4278
|
|
|
3877
4279
|
@property
|
|
3878
4280
|
def ReplicateSetNum(self):
|
|
3879
|
-
"""
|
|
4281
|
+
""" - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1.
|
|
4282
|
+
- Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively.
|
|
3880
4283
|
:rtype: int
|
|
3881
4284
|
"""
|
|
3882
4285
|
return self._ReplicateSetNum
|
|
@@ -3887,7 +4290,8 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3887
4290
|
|
|
3888
4291
|
@property
|
|
3889
4292
|
def Period(self):
|
|
3890
|
-
"""
|
|
4293
|
+
""" - When the monthly subscription mode is selected, that is, when <b>InstanceChargeType</b> is set to <b>PREPAID</b>, this parameter is required for specifying the purchase duration of instances. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Unit: months.
|
|
4294
|
+
- When pay-as-you-go is selected, that is, when <b>InstanceChargeType</b> is set to **POSTPAID_BY_HOUR**, this parameter only can be set to 1.
|
|
3891
4295
|
:rtype: int
|
|
3892
4296
|
"""
|
|
3893
4297
|
return self._Period
|
|
@@ -3898,7 +4302,9 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3898
4302
|
|
|
3899
4303
|
@property
|
|
3900
4304
|
def InstanceChargeType(self):
|
|
3901
|
-
"""
|
|
4305
|
+
"""Instance payment method.
|
|
4306
|
+
- PREPAID: monthly subscription.
|
|
4307
|
+
- POSTPAID_BY_HOUR: pay-as-you-go.
|
|
3902
4308
|
:rtype: str
|
|
3903
4309
|
"""
|
|
3904
4310
|
return self._InstanceChargeType
|
|
@@ -3909,7 +4315,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3909
4315
|
|
|
3910
4316
|
@property
|
|
3911
4317
|
def MongosCpu(self):
|
|
3912
|
-
"""
|
|
4318
|
+
"""Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. If this parameter is left blank, the default value 2 is used.
|
|
3913
4319
|
:rtype: int
|
|
3914
4320
|
"""
|
|
3915
4321
|
return self._MongosCpu
|
|
@@ -3920,7 +4326,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3920
4326
|
|
|
3921
4327
|
@property
|
|
3922
4328
|
def MongosMemory(self):
|
|
3923
|
-
"""
|
|
4329
|
+
"""Mongos node memory size. - This parameter is required during sharded cluster instance purchase. - Unit: GB. Valid values: 2 (for 1 core), 4 (for 2 cores), 8 (for 4 cores), 16 (for 8 cores), and 32 (for 16 cores). If this parameter is left blank, the default value 4 is used.
|
|
3924
4330
|
:rtype: int
|
|
3925
4331
|
"""
|
|
3926
4332
|
return self._MongosMemory
|
|
@@ -3931,7 +4337,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3931
4337
|
|
|
3932
4338
|
@property
|
|
3933
4339
|
def MongosNum(self):
|
|
3934
|
-
"""
|
|
4340
|
+
"""Specifies the number of Mongos nodes. Value range: [3,32]. For querying the price of sharded cluster instances, this parameter is required. If it is left blank, the default value 3 is used.
|
|
3935
4341
|
:rtype: int
|
|
3936
4342
|
"""
|
|
3937
4343
|
return self._MongosNum
|
|
@@ -3942,7 +4348,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3942
4348
|
|
|
3943
4349
|
@property
|
|
3944
4350
|
def ConfigServerCpu(self):
|
|
3945
|
-
"""
|
|
4351
|
+
"""Specifies the number of ConfigServer CPU cores. The value is fixed as 1.
|
|
3946
4352
|
:rtype: int
|
|
3947
4353
|
"""
|
|
3948
4354
|
return self._ConfigServerCpu
|
|
@@ -3953,7 +4359,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3953
4359
|
|
|
3954
4360
|
@property
|
|
3955
4361
|
def ConfigServerMemory(self):
|
|
3956
|
-
"""
|
|
4362
|
+
"""Specifies the ConfigServer memory size. The value is fixed as 2. Unit: GB. This parameter can be left blank.
|
|
3957
4363
|
:rtype: int
|
|
3958
4364
|
"""
|
|
3959
4365
|
return self._ConfigServerMemory
|
|
@@ -3964,7 +4370,7 @@ class InquirePriceCreateDBInstancesRequest(AbstractModel):
|
|
|
3964
4370
|
|
|
3965
4371
|
@property
|
|
3966
4372
|
def ConfigServerVolume(self):
|
|
3967
|
-
"""
|
|
4373
|
+
"""Specifies the ConfigServer disk size. The value is fixed as 20. Unit: GB. This parameter can be left blank.
|
|
3968
4374
|
:rtype: int
|
|
3969
4375
|
"""
|
|
3970
4376
|
return self._ConfigServerVolume
|
|
@@ -4011,7 +4417,7 @@ class InquirePriceCreateDBInstancesResponse(AbstractModel):
|
|
|
4011
4417
|
r"""
|
|
4012
4418
|
:param _Price: Price.
|
|
4013
4419
|
:type Price: :class:`tencentcloud.mongodb.v20190725.models.DBInstancePrice`
|
|
4014
|
-
:param _RequestId: The unique request ID,
|
|
4420
|
+
: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.
|
|
4015
4421
|
:type RequestId: str
|
|
4016
4422
|
"""
|
|
4017
4423
|
self._Price = None
|
|
@@ -4030,7 +4436,7 @@ class InquirePriceCreateDBInstancesResponse(AbstractModel):
|
|
|
4030
4436
|
|
|
4031
4437
|
@property
|
|
4032
4438
|
def RequestId(self):
|
|
4033
|
-
"""The unique request ID,
|
|
4439
|
+
"""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.
|
|
4034
4440
|
:rtype: str
|
|
4035
4441
|
"""
|
|
4036
4442
|
return self._RequestId
|
|
@@ -4152,7 +4558,7 @@ class InquirePriceModifyDBInstanceSpecResponse(AbstractModel):
|
|
|
4152
4558
|
r"""
|
|
4153
4559
|
:param _Price: Price.
|
|
4154
4560
|
:type Price: :class:`tencentcloud.mongodb.v20190725.models.DBInstancePrice`
|
|
4155
|
-
:param _RequestId: The unique request ID,
|
|
4561
|
+
: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.
|
|
4156
4562
|
:type RequestId: str
|
|
4157
4563
|
"""
|
|
4158
4564
|
self._Price = None
|
|
@@ -4171,7 +4577,7 @@ class InquirePriceModifyDBInstanceSpecResponse(AbstractModel):
|
|
|
4171
4577
|
|
|
4172
4578
|
@property
|
|
4173
4579
|
def RequestId(self):
|
|
4174
|
-
"""The unique request ID,
|
|
4580
|
+
"""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.
|
|
4175
4581
|
:rtype: str
|
|
4176
4582
|
"""
|
|
4177
4583
|
return self._RequestId
|
|
@@ -4195,7 +4601,7 @@ class InquirePriceRenewDBInstancesRequest(AbstractModel):
|
|
|
4195
4601
|
|
|
4196
4602
|
def __init__(self):
|
|
4197
4603
|
r"""
|
|
4198
|
-
:param _InstanceIds: Instance ID in the
|
|
4604
|
+
:param _InstanceIds: 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. Up to 5 instances can be queried at a time.
|
|
4199
4605
|
:type InstanceIds: list of str
|
|
4200
4606
|
: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.
|
|
4201
4607
|
:type InstanceChargePrepaid: :class:`tencentcloud.mongodb.v20190725.models.InstanceChargePrepaid`
|
|
@@ -4205,7 +4611,7 @@ class InquirePriceRenewDBInstancesRequest(AbstractModel):
|
|
|
4205
4611
|
|
|
4206
4612
|
@property
|
|
4207
4613
|
def InstanceIds(self):
|
|
4208
|
-
"""Instance ID in the
|
|
4614
|
+
"""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. Up to 5 instances can be queried at a time.
|
|
4209
4615
|
:rtype: list of str
|
|
4210
4616
|
"""
|
|
4211
4617
|
return self._InstanceIds
|
|
@@ -4250,7 +4656,7 @@ class InquirePriceRenewDBInstancesResponse(AbstractModel):
|
|
|
4250
4656
|
r"""
|
|
4251
4657
|
:param _Price: Price.
|
|
4252
4658
|
:type Price: :class:`tencentcloud.mongodb.v20190725.models.DBInstancePrice`
|
|
4253
|
-
:param _RequestId: The unique request ID,
|
|
4659
|
+
: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.
|
|
4254
4660
|
:type RequestId: str
|
|
4255
4661
|
"""
|
|
4256
4662
|
self._Price = None
|
|
@@ -4269,7 +4675,7 @@ class InquirePriceRenewDBInstancesResponse(AbstractModel):
|
|
|
4269
4675
|
|
|
4270
4676
|
@property
|
|
4271
4677
|
def RequestId(self):
|
|
4272
|
-
"""The unique request ID,
|
|
4678
|
+
"""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.
|
|
4273
4679
|
:rtype: str
|
|
4274
4680
|
"""
|
|
4275
4681
|
return self._RequestId
|
|
@@ -4293,16 +4699,12 @@ class InstanceChargePrepaid(AbstractModel):
|
|
|
4293
4699
|
|
|
4294
4700
|
def __init__(self):
|
|
4295
4701
|
r"""
|
|
4296
|
-
:param _Period:
|
|
4297
|
-
(This parameter is required in `InquirePriceRenewDBInstances` and `RenewDBInstances` APIs.)
|
|
4702
|
+
:param _Period: Instance purchase duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Default value: 1.
|
|
4298
4703
|
:type Period: int
|
|
4299
|
-
:param _RenewFlag:
|
|
4300
|
-
|
|
4301
|
-
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis when the account balance is sufficient.
|
|
4305
|
-
(This parameter is required in `InquirePriceRenewDBInstances` and `RenewDBInstances` APIs.)
|
|
4704
|
+
:param _RenewFlag: Automatic renewal flag. Valid values:
|
|
4705
|
+
- NOTIFY_AND_AUTO_RENEW: A notification is sent upon expiration, and the instance is renewed automatically. If the account balance is sufficient, the instance will be renewed automatically on a monthly basis after expiration.
|
|
4706
|
+
- NOTIFY_AND_MANUAL_RENEW: A notification is sent upon expiration, but the instance is not renewed automatically. Default value: NOTIFY_AND_MANUAL_RENEW.
|
|
4707
|
+
- DISABLE_NOTIFY_AND_MANUAL_RENEW: No notification is sent upon expiration, and the instance is not renewed automatically.
|
|
4306
4708
|
:type RenewFlag: str
|
|
4307
4709
|
"""
|
|
4308
4710
|
self._Period = None
|
|
@@ -4310,8 +4712,7 @@ Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOT
|
|
|
4310
4712
|
|
|
4311
4713
|
@property
|
|
4312
4714
|
def Period(self):
|
|
4313
|
-
"""
|
|
4314
|
-
(This parameter is required in `InquirePriceRenewDBInstances` and `RenewDBInstances` APIs.)
|
|
4715
|
+
"""Instance purchase duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Default value: 1.
|
|
4315
4716
|
:rtype: int
|
|
4316
4717
|
"""
|
|
4317
4718
|
return self._Period
|
|
@@ -4322,13 +4723,10 @@ Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOT
|
|
|
4322
4723
|
|
|
4323
4724
|
@property
|
|
4324
4725
|
def RenewFlag(self):
|
|
4325
|
-
"""
|
|
4326
|
-
|
|
4327
|
-
|
|
4328
|
-
|
|
4329
|
-
|
|
4330
|
-
Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis when the account balance is sufficient.
|
|
4331
|
-
(This parameter is required in `InquirePriceRenewDBInstances` and `RenewDBInstances` APIs.)
|
|
4726
|
+
"""Automatic renewal flag. Valid values:
|
|
4727
|
+
- NOTIFY_AND_AUTO_RENEW: A notification is sent upon expiration, and the instance is renewed automatically. If the account balance is sufficient, the instance will be renewed automatically on a monthly basis after expiration.
|
|
4728
|
+
- NOTIFY_AND_MANUAL_RENEW: A notification is sent upon expiration, but the instance is not renewed automatically. Default value: NOTIFY_AND_MANUAL_RENEW.
|
|
4729
|
+
- DISABLE_NOTIFY_AND_MANUAL_RENEW: No notification is sent upon expiration, and the instance is not renewed automatically.
|
|
4332
4730
|
:rtype: str
|
|
4333
4731
|
"""
|
|
4334
4732
|
return self._RenewFlag
|
|
@@ -4378,7 +4776,7 @@ class InstanceDetail(AbstractModel):
|
|
|
4378
4776
|
:type VpcId: str
|
|
4379
4777
|
:param _SubnetId: Subnet ID of VPC
|
|
4380
4778
|
:type SubnetId: str
|
|
4381
|
-
:param _Status: Instance status. Valid values:
|
|
4779
|
+
:param _Status: Instance status. Valid values: 0: creating; 1: processing; 2: running; -2: expired.
|
|
4382
4780
|
:type Status: int
|
|
4383
4781
|
:param _Vip: Instance IP
|
|
4384
4782
|
:type Vip: str
|
|
@@ -4434,29 +4832,21 @@ class InstanceDetail(AbstractModel):
|
|
|
4434
4832
|
:type InstanceStatusDesc: str
|
|
4435
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
|
|
4436
4834
|
:type RealInstanceId: str
|
|
4437
|
-
:param _MongosNodeNum: Number of
|
|
4438
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4835
|
+
:param _MongosNodeNum: Number of Mongos nodes.
|
|
4439
4836
|
:type MongosNodeNum: int
|
|
4440
|
-
:param _MongosMemory:
|
|
4441
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4837
|
+
:param _MongosMemory: Mongos node memory.
|
|
4442
4838
|
:type MongosMemory: int
|
|
4443
|
-
:param _MongosCpuNum: Number of
|
|
4444
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4839
|
+
:param _MongosCpuNum: Number of Mongos node CPU cores.
|
|
4445
4840
|
:type MongosCpuNum: int
|
|
4446
|
-
:param _ConfigServerNodeNum: Number of ConfigServer nodes
|
|
4447
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4841
|
+
:param _ConfigServerNodeNum: Number of ConfigServer nodes.
|
|
4448
4842
|
:type ConfigServerNodeNum: int
|
|
4449
|
-
:param _ConfigServerMemory:
|
|
4450
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4843
|
+
:param _ConfigServerMemory: ConfigServer node memory.
|
|
4451
4844
|
:type ConfigServerMemory: int
|
|
4452
|
-
:param _ConfigServerVolume:
|
|
4453
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4845
|
+
:param _ConfigServerVolume: ConfigServer node disk size.
|
|
4454
4846
|
:type ConfigServerVolume: int
|
|
4455
|
-
:param _ConfigServerCpuNum:
|
|
4456
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4847
|
+
:param _ConfigServerCpuNum: Number of ConfigServer node CPU cores.
|
|
4457
4848
|
:type ConfigServerCpuNum: int
|
|
4458
|
-
:param _ReadonlyNodeNum: Number of read-only nodes
|
|
4459
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
4849
|
+
:param _ReadonlyNodeNum: Number of read-only nodes.
|
|
4460
4850
|
:type ReadonlyNodeNum: int
|
|
4461
4851
|
"""
|
|
4462
4852
|
self._InstanceId = None
|
|
@@ -4618,7 +5008,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4618
5008
|
|
|
4619
5009
|
@property
|
|
4620
5010
|
def Status(self):
|
|
4621
|
-
"""Instance status. Valid values:
|
|
5011
|
+
"""Instance status. Valid values: 0: creating; 1: processing; 2: running; -2: expired.
|
|
4622
5012
|
:rtype: int
|
|
4623
5013
|
"""
|
|
4624
5014
|
return self._Status
|
|
@@ -4926,8 +5316,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4926
5316
|
|
|
4927
5317
|
@property
|
|
4928
5318
|
def MongosNodeNum(self):
|
|
4929
|
-
"""Number of
|
|
4930
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5319
|
+
"""Number of Mongos nodes.
|
|
4931
5320
|
:rtype: int
|
|
4932
5321
|
"""
|
|
4933
5322
|
return self._MongosNodeNum
|
|
@@ -4938,8 +5327,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4938
5327
|
|
|
4939
5328
|
@property
|
|
4940
5329
|
def MongosMemory(self):
|
|
4941
|
-
"""
|
|
4942
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5330
|
+
"""Mongos node memory.
|
|
4943
5331
|
:rtype: int
|
|
4944
5332
|
"""
|
|
4945
5333
|
return self._MongosMemory
|
|
@@ -4950,8 +5338,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4950
5338
|
|
|
4951
5339
|
@property
|
|
4952
5340
|
def MongosCpuNum(self):
|
|
4953
|
-
"""Number of
|
|
4954
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5341
|
+
"""Number of Mongos node CPU cores.
|
|
4955
5342
|
:rtype: int
|
|
4956
5343
|
"""
|
|
4957
5344
|
return self._MongosCpuNum
|
|
@@ -4962,8 +5349,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4962
5349
|
|
|
4963
5350
|
@property
|
|
4964
5351
|
def ConfigServerNodeNum(self):
|
|
4965
|
-
"""Number of ConfigServer nodes
|
|
4966
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5352
|
+
"""Number of ConfigServer nodes.
|
|
4967
5353
|
:rtype: int
|
|
4968
5354
|
"""
|
|
4969
5355
|
return self._ConfigServerNodeNum
|
|
@@ -4974,8 +5360,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4974
5360
|
|
|
4975
5361
|
@property
|
|
4976
5362
|
def ConfigServerMemory(self):
|
|
4977
|
-
"""
|
|
4978
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5363
|
+
"""ConfigServer node memory.
|
|
4979
5364
|
:rtype: int
|
|
4980
5365
|
"""
|
|
4981
5366
|
return self._ConfigServerMemory
|
|
@@ -4986,8 +5371,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4986
5371
|
|
|
4987
5372
|
@property
|
|
4988
5373
|
def ConfigServerVolume(self):
|
|
4989
|
-
"""
|
|
4990
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5374
|
+
"""ConfigServer node disk size.
|
|
4991
5375
|
:rtype: int
|
|
4992
5376
|
"""
|
|
4993
5377
|
return self._ConfigServerVolume
|
|
@@ -4998,8 +5382,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
4998
5382
|
|
|
4999
5383
|
@property
|
|
5000
5384
|
def ConfigServerCpuNum(self):
|
|
5001
|
-
"""
|
|
5002
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5385
|
+
"""Number of ConfigServer node CPU cores.
|
|
5003
5386
|
:rtype: int
|
|
5004
5387
|
"""
|
|
5005
5388
|
return self._ConfigServerCpuNum
|
|
@@ -5010,8 +5393,7 @@ Note: This field may return null, indicating that no valid values can be obtaine
|
|
|
5010
5393
|
|
|
5011
5394
|
@property
|
|
5012
5395
|
def ReadonlyNodeNum(self):
|
|
5013
|
-
"""Number of read-only nodes
|
|
5014
|
-
Note: This field may return null, indicating that no valid values can be obtained.
|
|
5396
|
+
"""Number of read-only nodes.
|
|
5015
5397
|
:rtype: int
|
|
5016
5398
|
"""
|
|
5017
5399
|
return self._ReadonlyNodeNum
|
|
@@ -5112,21 +5494,25 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5112
5494
|
|
|
5113
5495
|
def __init__(self):
|
|
5114
5496
|
r"""
|
|
5115
|
-
:param _CurrentValue: Current value
|
|
5497
|
+
:param _CurrentValue: Current parameter value.
|
|
5116
5498
|
:type CurrentValue: str
|
|
5117
|
-
:param _DefaultValue: Default value
|
|
5499
|
+
:param _DefaultValue: Default parameter value.
|
|
5118
5500
|
:type DefaultValue: str
|
|
5119
|
-
:param _EnumValue:
|
|
5501
|
+
:param _EnumValue: Enumerated values, which indicate all supported values.
|
|
5120
5502
|
:type EnumValue: list of str
|
|
5121
|
-
:param _NeedRestart: Whether
|
|
5503
|
+
:param _NeedRestart: Whether a restart is required for the parameters to take effect after modification.
|
|
5504
|
+
- 1: Restart is required for the parameters to take effect.
|
|
5505
|
+
- 0: Restart is not required. Once set, the parameters take effect immediately.
|
|
5122
5506
|
:type NeedRestart: str
|
|
5123
|
-
:param _ParamName: Parameter name
|
|
5507
|
+
:param _ParamName: Parameter name.
|
|
5124
5508
|
:type ParamName: str
|
|
5125
|
-
:param _Tips: Parameter description
|
|
5509
|
+
:param _Tips: Parameter description.
|
|
5126
5510
|
:type Tips: list of str
|
|
5127
|
-
:param _ValueType:
|
|
5511
|
+
:param _ValueType: Parameter type description.
|
|
5128
5512
|
:type ValueType: str
|
|
5129
|
-
:param _Status: Whether
|
|
5513
|
+
:param _Status: Whether the parameter values are used during running.
|
|
5514
|
+
- 1. parameter values used during running.
|
|
5515
|
+
- 0: parameter values not used during running.
|
|
5130
5516
|
:type Status: int
|
|
5131
5517
|
"""
|
|
5132
5518
|
self._CurrentValue = None
|
|
@@ -5140,7 +5526,7 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5140
5526
|
|
|
5141
5527
|
@property
|
|
5142
5528
|
def CurrentValue(self):
|
|
5143
|
-
"""Current value
|
|
5529
|
+
"""Current parameter value.
|
|
5144
5530
|
:rtype: str
|
|
5145
5531
|
"""
|
|
5146
5532
|
return self._CurrentValue
|
|
@@ -5151,7 +5537,7 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5151
5537
|
|
|
5152
5538
|
@property
|
|
5153
5539
|
def DefaultValue(self):
|
|
5154
|
-
"""Default value
|
|
5540
|
+
"""Default parameter value.
|
|
5155
5541
|
:rtype: str
|
|
5156
5542
|
"""
|
|
5157
5543
|
return self._DefaultValue
|
|
@@ -5162,7 +5548,7 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5162
5548
|
|
|
5163
5549
|
@property
|
|
5164
5550
|
def EnumValue(self):
|
|
5165
|
-
"""
|
|
5551
|
+
"""Enumerated values, which indicate all supported values.
|
|
5166
5552
|
:rtype: list of str
|
|
5167
5553
|
"""
|
|
5168
5554
|
return self._EnumValue
|
|
@@ -5173,7 +5559,9 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5173
5559
|
|
|
5174
5560
|
@property
|
|
5175
5561
|
def NeedRestart(self):
|
|
5176
|
-
"""Whether
|
|
5562
|
+
"""Whether a restart is required for the parameters to take effect after modification.
|
|
5563
|
+
- 1: Restart is required for the parameters to take effect.
|
|
5564
|
+
- 0: Restart is not required. Once set, the parameters take effect immediately.
|
|
5177
5565
|
:rtype: str
|
|
5178
5566
|
"""
|
|
5179
5567
|
return self._NeedRestart
|
|
@@ -5184,7 +5572,7 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5184
5572
|
|
|
5185
5573
|
@property
|
|
5186
5574
|
def ParamName(self):
|
|
5187
|
-
"""Parameter name
|
|
5575
|
+
"""Parameter name.
|
|
5188
5576
|
:rtype: str
|
|
5189
5577
|
"""
|
|
5190
5578
|
return self._ParamName
|
|
@@ -5195,7 +5583,7 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5195
5583
|
|
|
5196
5584
|
@property
|
|
5197
5585
|
def Tips(self):
|
|
5198
|
-
"""Parameter description
|
|
5586
|
+
"""Parameter description.
|
|
5199
5587
|
:rtype: list of str
|
|
5200
5588
|
"""
|
|
5201
5589
|
return self._Tips
|
|
@@ -5206,7 +5594,7 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5206
5594
|
|
|
5207
5595
|
@property
|
|
5208
5596
|
def ValueType(self):
|
|
5209
|
-
"""
|
|
5597
|
+
"""Parameter type description.
|
|
5210
5598
|
:rtype: str
|
|
5211
5599
|
"""
|
|
5212
5600
|
return self._ValueType
|
|
@@ -5217,7 +5605,9 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5217
5605
|
|
|
5218
5606
|
@property
|
|
5219
5607
|
def Status(self):
|
|
5220
|
-
"""Whether
|
|
5608
|
+
"""Whether the parameter values are used during running.
|
|
5609
|
+
- 1. parameter values used during running.
|
|
5610
|
+
- 0: parameter values not used during running.
|
|
5221
5611
|
:rtype: int
|
|
5222
5612
|
"""
|
|
5223
5613
|
return self._Status
|
|
@@ -5247,31 +5637,35 @@ class InstanceEnumParam(AbstractModel):
|
|
|
5247
5637
|
|
|
5248
5638
|
|
|
5249
5639
|
class InstanceIntegerParam(AbstractModel):
|
|
5250
|
-
"""
|
|
5640
|
+
"""Collection of modifiable instance parameters of the Integer type.
|
|
5251
5641
|
|
|
5252
5642
|
"""
|
|
5253
5643
|
|
|
5254
5644
|
def __init__(self):
|
|
5255
5645
|
r"""
|
|
5256
|
-
:param _CurrentValue: Current value
|
|
5646
|
+
:param _CurrentValue: Current parameter value.
|
|
5257
5647
|
:type CurrentValue: str
|
|
5258
|
-
:param _DefaultValue: Default value
|
|
5648
|
+
:param _DefaultValue: Default parameter value.
|
|
5259
5649
|
:type DefaultValue: str
|
|
5260
|
-
:param _Max: Maximum value
|
|
5650
|
+
:param _Max: Maximum parameter value.
|
|
5261
5651
|
:type Max: str
|
|
5262
|
-
:param _Min: Minimum value
|
|
5652
|
+
:param _Min: Minimum value.
|
|
5263
5653
|
:type Min: str
|
|
5264
|
-
:param _NeedRestart: Whether
|
|
5654
|
+
:param _NeedRestart: Whether a restart is required for the parameters to take effect after modification.
|
|
5655
|
+
- 1: Restart is required for the parameters to take effect.
|
|
5656
|
+
- 0: Restart is not required. Once set, the parameters take effect immediately.
|
|
5265
5657
|
:type NeedRestart: str
|
|
5266
|
-
:param _ParamName: Parameter name
|
|
5658
|
+
:param _ParamName: Parameter name.
|
|
5267
5659
|
:type ParamName: str
|
|
5268
|
-
:param _Tips: Parameter description
|
|
5660
|
+
:param _Tips: Parameter description.
|
|
5269
5661
|
:type Tips: list of str
|
|
5270
|
-
:param _ValueType:
|
|
5662
|
+
:param _ValueType: Parameter type.
|
|
5271
5663
|
:type ValueType: str
|
|
5272
|
-
:param _Status: Whether
|
|
5664
|
+
:param _Status: Whether the parameter values are used during running.
|
|
5665
|
+
- 1. parameter values used during running.
|
|
5666
|
+
- 0: parameter values not used during running.
|
|
5273
5667
|
:type Status: int
|
|
5274
|
-
:param _Unit: Redundant field
|
|
5668
|
+
:param _Unit: Redundant field. It can be ignored.
|
|
5275
5669
|
:type Unit: str
|
|
5276
5670
|
"""
|
|
5277
5671
|
self._CurrentValue = None
|
|
@@ -5287,7 +5681,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5287
5681
|
|
|
5288
5682
|
@property
|
|
5289
5683
|
def CurrentValue(self):
|
|
5290
|
-
"""Current value
|
|
5684
|
+
"""Current parameter value.
|
|
5291
5685
|
:rtype: str
|
|
5292
5686
|
"""
|
|
5293
5687
|
return self._CurrentValue
|
|
@@ -5298,7 +5692,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5298
5692
|
|
|
5299
5693
|
@property
|
|
5300
5694
|
def DefaultValue(self):
|
|
5301
|
-
"""Default value
|
|
5695
|
+
"""Default parameter value.
|
|
5302
5696
|
:rtype: str
|
|
5303
5697
|
"""
|
|
5304
5698
|
return self._DefaultValue
|
|
@@ -5309,7 +5703,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5309
5703
|
|
|
5310
5704
|
@property
|
|
5311
5705
|
def Max(self):
|
|
5312
|
-
"""Maximum value
|
|
5706
|
+
"""Maximum parameter value.
|
|
5313
5707
|
:rtype: str
|
|
5314
5708
|
"""
|
|
5315
5709
|
return self._Max
|
|
@@ -5320,7 +5714,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5320
5714
|
|
|
5321
5715
|
@property
|
|
5322
5716
|
def Min(self):
|
|
5323
|
-
"""Minimum value
|
|
5717
|
+
"""Minimum value.
|
|
5324
5718
|
:rtype: str
|
|
5325
5719
|
"""
|
|
5326
5720
|
return self._Min
|
|
@@ -5331,7 +5725,9 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5331
5725
|
|
|
5332
5726
|
@property
|
|
5333
5727
|
def NeedRestart(self):
|
|
5334
|
-
"""Whether
|
|
5728
|
+
"""Whether a restart is required for the parameters to take effect after modification.
|
|
5729
|
+
- 1: Restart is required for the parameters to take effect.
|
|
5730
|
+
- 0: Restart is not required. Once set, the parameters take effect immediately.
|
|
5335
5731
|
:rtype: str
|
|
5336
5732
|
"""
|
|
5337
5733
|
return self._NeedRestart
|
|
@@ -5342,7 +5738,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5342
5738
|
|
|
5343
5739
|
@property
|
|
5344
5740
|
def ParamName(self):
|
|
5345
|
-
"""Parameter name
|
|
5741
|
+
"""Parameter name.
|
|
5346
5742
|
:rtype: str
|
|
5347
5743
|
"""
|
|
5348
5744
|
return self._ParamName
|
|
@@ -5353,7 +5749,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5353
5749
|
|
|
5354
5750
|
@property
|
|
5355
5751
|
def Tips(self):
|
|
5356
|
-
"""Parameter description
|
|
5752
|
+
"""Parameter description.
|
|
5357
5753
|
:rtype: list of str
|
|
5358
5754
|
"""
|
|
5359
5755
|
return self._Tips
|
|
@@ -5364,7 +5760,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5364
5760
|
|
|
5365
5761
|
@property
|
|
5366
5762
|
def ValueType(self):
|
|
5367
|
-
"""
|
|
5763
|
+
"""Parameter type.
|
|
5368
5764
|
:rtype: str
|
|
5369
5765
|
"""
|
|
5370
5766
|
return self._ValueType
|
|
@@ -5375,7 +5771,9 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5375
5771
|
|
|
5376
5772
|
@property
|
|
5377
5773
|
def Status(self):
|
|
5378
|
-
"""Whether
|
|
5774
|
+
"""Whether the parameter values are used during running.
|
|
5775
|
+
- 1. parameter values used during running.
|
|
5776
|
+
- 0: parameter values not used during running.
|
|
5379
5777
|
:rtype: int
|
|
5380
5778
|
"""
|
|
5381
5779
|
return self._Status
|
|
@@ -5386,7 +5784,7 @@ class InstanceIntegerParam(AbstractModel):
|
|
|
5386
5784
|
|
|
5387
5785
|
@property
|
|
5388
5786
|
def Unit(self):
|
|
5389
|
-
"""Redundant field
|
|
5787
|
+
"""Redundant field. It can be ignored.
|
|
5390
5788
|
:rtype: str
|
|
5391
5789
|
"""
|
|
5392
5790
|
return self._Unit
|
|
@@ -5424,21 +5822,25 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5424
5822
|
|
|
5425
5823
|
def __init__(self):
|
|
5426
5824
|
r"""
|
|
5427
|
-
:param _CurrentValue: Current value
|
|
5825
|
+
:param _CurrentValue: Current parameter value.
|
|
5428
5826
|
:type CurrentValue: str
|
|
5429
|
-
:param _DefaultValue: Default value
|
|
5827
|
+
:param _DefaultValue: Default parameter value.
|
|
5430
5828
|
:type DefaultValue: str
|
|
5431
|
-
:param _EnumValue:
|
|
5829
|
+
:param _EnumValue: Reference value range.
|
|
5432
5830
|
:type EnumValue: list of str
|
|
5433
|
-
:param _NeedRestart: Whether
|
|
5831
|
+
:param _NeedRestart: Whether a restart is required for the parameters to take effect after modification.
|
|
5832
|
+
- 1: Restart is required for the parameters to take effect.
|
|
5833
|
+
- 0: Restart is not required. Once set, the parameters take effect immediately.
|
|
5434
5834
|
:type NeedRestart: str
|
|
5435
|
-
:param _ParamName: Parameter name
|
|
5835
|
+
:param _ParamName: Parameter name.
|
|
5436
5836
|
:type ParamName: str
|
|
5437
|
-
:param _Status: Whether
|
|
5837
|
+
:param _Status: Whether the parameter values are used during running.
|
|
5838
|
+
- 1. parameter values used during running.
|
|
5839
|
+
- 0: parameter values not used during running.
|
|
5438
5840
|
:type Status: int
|
|
5439
|
-
:param _Tips: Parameter description
|
|
5841
|
+
:param _Tips: Parameter description.
|
|
5440
5842
|
:type Tips: list of str
|
|
5441
|
-
:param _ValueType:
|
|
5843
|
+
:param _ValueType: Describes the type of the current values. Default value: multi.
|
|
5442
5844
|
:type ValueType: str
|
|
5443
5845
|
"""
|
|
5444
5846
|
self._CurrentValue = None
|
|
@@ -5452,7 +5854,7 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5452
5854
|
|
|
5453
5855
|
@property
|
|
5454
5856
|
def CurrentValue(self):
|
|
5455
|
-
"""Current value
|
|
5857
|
+
"""Current parameter value.
|
|
5456
5858
|
:rtype: str
|
|
5457
5859
|
"""
|
|
5458
5860
|
return self._CurrentValue
|
|
@@ -5463,7 +5865,7 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5463
5865
|
|
|
5464
5866
|
@property
|
|
5465
5867
|
def DefaultValue(self):
|
|
5466
|
-
"""Default value
|
|
5868
|
+
"""Default parameter value.
|
|
5467
5869
|
:rtype: str
|
|
5468
5870
|
"""
|
|
5469
5871
|
return self._DefaultValue
|
|
@@ -5474,7 +5876,7 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5474
5876
|
|
|
5475
5877
|
@property
|
|
5476
5878
|
def EnumValue(self):
|
|
5477
|
-
"""
|
|
5879
|
+
"""Reference value range.
|
|
5478
5880
|
:rtype: list of str
|
|
5479
5881
|
"""
|
|
5480
5882
|
return self._EnumValue
|
|
@@ -5485,7 +5887,9 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5485
5887
|
|
|
5486
5888
|
@property
|
|
5487
5889
|
def NeedRestart(self):
|
|
5488
|
-
"""Whether
|
|
5890
|
+
"""Whether a restart is required for the parameters to take effect after modification.
|
|
5891
|
+
- 1: Restart is required for the parameters to take effect.
|
|
5892
|
+
- 0: Restart is not required. Once set, the parameters take effect immediately.
|
|
5489
5893
|
:rtype: str
|
|
5490
5894
|
"""
|
|
5491
5895
|
return self._NeedRestart
|
|
@@ -5496,7 +5900,7 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5496
5900
|
|
|
5497
5901
|
@property
|
|
5498
5902
|
def ParamName(self):
|
|
5499
|
-
"""Parameter name
|
|
5903
|
+
"""Parameter name.
|
|
5500
5904
|
:rtype: str
|
|
5501
5905
|
"""
|
|
5502
5906
|
return self._ParamName
|
|
@@ -5507,7 +5911,9 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5507
5911
|
|
|
5508
5912
|
@property
|
|
5509
5913
|
def Status(self):
|
|
5510
|
-
"""Whether
|
|
5914
|
+
"""Whether the parameter values are used during running.
|
|
5915
|
+
- 1. parameter values used during running.
|
|
5916
|
+
- 0: parameter values not used during running.
|
|
5511
5917
|
:rtype: int
|
|
5512
5918
|
"""
|
|
5513
5919
|
return self._Status
|
|
@@ -5518,7 +5924,7 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5518
5924
|
|
|
5519
5925
|
@property
|
|
5520
5926
|
def Tips(self):
|
|
5521
|
-
"""Parameter description
|
|
5927
|
+
"""Parameter description.
|
|
5522
5928
|
:rtype: list of str
|
|
5523
5929
|
"""
|
|
5524
5930
|
return self._Tips
|
|
@@ -5529,7 +5935,7 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5529
5935
|
|
|
5530
5936
|
@property
|
|
5531
5937
|
def ValueType(self):
|
|
5532
|
-
"""
|
|
5938
|
+
"""Describes the type of the current values. Default value: multi.
|
|
5533
5939
|
:rtype: str
|
|
5534
5940
|
"""
|
|
5535
5941
|
return self._ValueType
|
|
@@ -5559,27 +5965,29 @@ class InstanceMultiParam(AbstractModel):
|
|
|
5559
5965
|
|
|
5560
5966
|
|
|
5561
5967
|
class InstanceTextParam(AbstractModel):
|
|
5562
|
-
"""
|
|
5968
|
+
"""Collection of modifiable instance parameters whose values are of the Text type.
|
|
5563
5969
|
|
|
5564
5970
|
"""
|
|
5565
5971
|
|
|
5566
5972
|
def __init__(self):
|
|
5567
5973
|
r"""
|
|
5568
|
-
:param _CurrentValue: Current value
|
|
5974
|
+
:param _CurrentValue: Current parameter value.
|
|
5569
5975
|
:type CurrentValue: str
|
|
5570
|
-
:param _DefaultValue: Default value
|
|
5976
|
+
:param _DefaultValue: Default parameter value.
|
|
5571
5977
|
:type DefaultValue: str
|
|
5572
|
-
:param _NeedRestart: Whether
|
|
5978
|
+
:param _NeedRestart: Whether a restart is required after the parameter values are modified.
|
|
5573
5979
|
:type NeedRestart: str
|
|
5574
|
-
:param _ParamName: Parameter name
|
|
5980
|
+
:param _ParamName: Parameter name.
|
|
5575
5981
|
:type ParamName: str
|
|
5576
|
-
:param _TextValue:
|
|
5982
|
+
:param _TextValue: Corresponding values of the Text-type parameters.
|
|
5577
5983
|
:type TextValue: str
|
|
5578
|
-
:param _Tips: Parameter description
|
|
5984
|
+
:param _Tips: Parameter description.
|
|
5579
5985
|
:type Tips: list of str
|
|
5580
|
-
:param _ValueType:
|
|
5986
|
+
:param _ValueType: Parameter type description.
|
|
5581
5987
|
:type ValueType: str
|
|
5582
|
-
:param _Status: Whether
|
|
5988
|
+
:param _Status: Whether the parameter values are used during running.
|
|
5989
|
+
- 1. parameter values used during running.
|
|
5990
|
+
- 0: parameter values not used during running.
|
|
5583
5991
|
:type Status: str
|
|
5584
5992
|
"""
|
|
5585
5993
|
self._CurrentValue = None
|
|
@@ -5593,7 +6001,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5593
6001
|
|
|
5594
6002
|
@property
|
|
5595
6003
|
def CurrentValue(self):
|
|
5596
|
-
"""Current value
|
|
6004
|
+
"""Current parameter value.
|
|
5597
6005
|
:rtype: str
|
|
5598
6006
|
"""
|
|
5599
6007
|
return self._CurrentValue
|
|
@@ -5604,7 +6012,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5604
6012
|
|
|
5605
6013
|
@property
|
|
5606
6014
|
def DefaultValue(self):
|
|
5607
|
-
"""Default value
|
|
6015
|
+
"""Default parameter value.
|
|
5608
6016
|
:rtype: str
|
|
5609
6017
|
"""
|
|
5610
6018
|
return self._DefaultValue
|
|
@@ -5615,7 +6023,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5615
6023
|
|
|
5616
6024
|
@property
|
|
5617
6025
|
def NeedRestart(self):
|
|
5618
|
-
"""Whether
|
|
6026
|
+
"""Whether a restart is required after the parameter values are modified.
|
|
5619
6027
|
:rtype: str
|
|
5620
6028
|
"""
|
|
5621
6029
|
return self._NeedRestart
|
|
@@ -5626,7 +6034,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5626
6034
|
|
|
5627
6035
|
@property
|
|
5628
6036
|
def ParamName(self):
|
|
5629
|
-
"""Parameter name
|
|
6037
|
+
"""Parameter name.
|
|
5630
6038
|
:rtype: str
|
|
5631
6039
|
"""
|
|
5632
6040
|
return self._ParamName
|
|
@@ -5637,7 +6045,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5637
6045
|
|
|
5638
6046
|
@property
|
|
5639
6047
|
def TextValue(self):
|
|
5640
|
-
"""
|
|
6048
|
+
"""Corresponding values of the Text-type parameters.
|
|
5641
6049
|
:rtype: str
|
|
5642
6050
|
"""
|
|
5643
6051
|
return self._TextValue
|
|
@@ -5648,7 +6056,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5648
6056
|
|
|
5649
6057
|
@property
|
|
5650
6058
|
def Tips(self):
|
|
5651
|
-
"""Parameter description
|
|
6059
|
+
"""Parameter description.
|
|
5652
6060
|
:rtype: list of str
|
|
5653
6061
|
"""
|
|
5654
6062
|
return self._Tips
|
|
@@ -5659,7 +6067,7 @@ class InstanceTextParam(AbstractModel):
|
|
|
5659
6067
|
|
|
5660
6068
|
@property
|
|
5661
6069
|
def ValueType(self):
|
|
5662
|
-
"""
|
|
6070
|
+
"""Parameter type description.
|
|
5663
6071
|
:rtype: str
|
|
5664
6072
|
"""
|
|
5665
6073
|
return self._ValueType
|
|
@@ -5670,7 +6078,9 @@ class InstanceTextParam(AbstractModel):
|
|
|
5670
6078
|
|
|
5671
6079
|
@property
|
|
5672
6080
|
def Status(self):
|
|
5673
|
-
"""Whether
|
|
6081
|
+
"""Whether the parameter values are used during running.
|
|
6082
|
+
- 1. parameter values used during running.
|
|
6083
|
+
- 0: parameter values not used during running.
|
|
5674
6084
|
:rtype: str
|
|
5675
6085
|
"""
|
|
5676
6086
|
return self._Status
|
|
@@ -5744,7 +6154,7 @@ class IsolateDBInstanceResponse(AbstractModel):
|
|
|
5744
6154
|
r"""
|
|
5745
6155
|
:param _AsyncRequestId: Async task request ID, which can be used to query the execution result of an async task.
|
|
5746
6156
|
:type AsyncRequestId: str
|
|
5747
|
-
:param _RequestId: The unique request ID,
|
|
6157
|
+
: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.
|
|
5748
6158
|
:type RequestId: str
|
|
5749
6159
|
"""
|
|
5750
6160
|
self._AsyncRequestId = None
|
|
@@ -5763,7 +6173,7 @@ class IsolateDBInstanceResponse(AbstractModel):
|
|
|
5763
6173
|
|
|
5764
6174
|
@property
|
|
5765
6175
|
def RequestId(self):
|
|
5766
|
-
"""The unique request ID,
|
|
6176
|
+
"""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.
|
|
5767
6177
|
:rtype: str
|
|
5768
6178
|
"""
|
|
5769
6179
|
return self._RequestId
|
|
@@ -5785,15 +6195,19 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
|
|
|
5785
6195
|
|
|
5786
6196
|
def __init__(self):
|
|
5787
6197
|
r"""
|
|
5788
|
-
:param _InstanceId:
|
|
6198
|
+
:param _InstanceId: Specifies the ID of the instance for modifying the network. 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.
|
|
6199
|
+
|
|
5789
6200
|
:type InstanceId: str
|
|
5790
|
-
:param _OldIpExpiredTime:
|
|
6201
|
+
:param _OldIpExpiredTime: Retention period of the original IP address.
|
|
6202
|
+
- Unit: minutes. 0 means that the IP address is immediately repossessed.
|
|
6203
|
+
- The original IP address will be released after a scheduled period. Both the original and new IP addresses are accessible before release.
|
|
6204
|
+
|
|
5791
6205
|
:type OldIpExpiredTime: int
|
|
5792
|
-
:param _NewUniqVpcId:
|
|
6206
|
+
:param _NewUniqVpcId: VPC ID after the switch. If the instance is using a basic network, this field is not required.
|
|
5793
6207
|
:type NewUniqVpcId: str
|
|
5794
|
-
:param _NewUniqSubnetId:
|
|
6208
|
+
:param _NewUniqSubnetId: VPC subnet ID after the switch. If the instance is using a basic network, this field is not required.
|
|
5795
6209
|
:type NewUniqSubnetId: str
|
|
5796
|
-
:param _NetworkAddresses: IP information
|
|
6210
|
+
:param _NetworkAddresses: IP address information, including the new IP address and the original IP address.
|
|
5797
6211
|
:type NetworkAddresses: list of ModifyNetworkAddress
|
|
5798
6212
|
"""
|
|
5799
6213
|
self._InstanceId = None
|
|
@@ -5804,7 +6218,8 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
|
|
|
5804
6218
|
|
|
5805
6219
|
@property
|
|
5806
6220
|
def InstanceId(self):
|
|
5807
|
-
"""
|
|
6221
|
+
"""Specifies the ID of the instance for modifying the network. 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.
|
|
6222
|
+
|
|
5808
6223
|
:rtype: str
|
|
5809
6224
|
"""
|
|
5810
6225
|
return self._InstanceId
|
|
@@ -5815,7 +6230,10 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
|
|
|
5815
6230
|
|
|
5816
6231
|
@property
|
|
5817
6232
|
def OldIpExpiredTime(self):
|
|
5818
|
-
"""
|
|
6233
|
+
"""Retention period of the original IP address.
|
|
6234
|
+
- Unit: minutes. 0 means that the IP address is immediately repossessed.
|
|
6235
|
+
- The original IP address will be released after a scheduled period. Both the original and new IP addresses are accessible before release.
|
|
6236
|
+
|
|
5819
6237
|
:rtype: int
|
|
5820
6238
|
"""
|
|
5821
6239
|
return self._OldIpExpiredTime
|
|
@@ -5826,7 +6244,7 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
|
|
|
5826
6244
|
|
|
5827
6245
|
@property
|
|
5828
6246
|
def NewUniqVpcId(self):
|
|
5829
|
-
"""
|
|
6247
|
+
"""VPC ID after the switch. If the instance is using a basic network, this field is not required.
|
|
5830
6248
|
:rtype: str
|
|
5831
6249
|
"""
|
|
5832
6250
|
return self._NewUniqVpcId
|
|
@@ -5837,7 +6255,7 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
|
|
|
5837
6255
|
|
|
5838
6256
|
@property
|
|
5839
6257
|
def NewUniqSubnetId(self):
|
|
5840
|
-
"""
|
|
6258
|
+
"""VPC subnet ID after the switch. If the instance is using a basic network, this field is not required.
|
|
5841
6259
|
:rtype: str
|
|
5842
6260
|
"""
|
|
5843
6261
|
return self._NewUniqSubnetId
|
|
@@ -5848,7 +6266,7 @@ class ModifyDBInstanceNetworkAddressRequest(AbstractModel):
|
|
|
5848
6266
|
|
|
5849
6267
|
@property
|
|
5850
6268
|
def NetworkAddresses(self):
|
|
5851
|
-
"""IP information
|
|
6269
|
+
"""IP address information, including the new IP address and the original IP address.
|
|
5852
6270
|
:rtype: list of ModifyNetworkAddress
|
|
5853
6271
|
"""
|
|
5854
6272
|
return self._NetworkAddresses
|
|
@@ -5886,14 +6304,28 @@ class ModifyDBInstanceNetworkAddressResponse(AbstractModel):
|
|
|
5886
6304
|
|
|
5887
6305
|
def __init__(self):
|
|
5888
6306
|
r"""
|
|
5889
|
-
:param
|
|
6307
|
+
:param _FlowId: ID of the asynchronous process task for modifying the network information.
|
|
6308
|
+
:type FlowId: int
|
|
6309
|
+
: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.
|
|
5890
6310
|
:type RequestId: str
|
|
5891
6311
|
"""
|
|
6312
|
+
self._FlowId = None
|
|
5892
6313
|
self._RequestId = None
|
|
5893
6314
|
|
|
6315
|
+
@property
|
|
6316
|
+
def FlowId(self):
|
|
6317
|
+
"""ID of the asynchronous process task for modifying the network information.
|
|
6318
|
+
:rtype: int
|
|
6319
|
+
"""
|
|
6320
|
+
return self._FlowId
|
|
6321
|
+
|
|
6322
|
+
@FlowId.setter
|
|
6323
|
+
def FlowId(self, FlowId):
|
|
6324
|
+
self._FlowId = FlowId
|
|
6325
|
+
|
|
5894
6326
|
@property
|
|
5895
6327
|
def RequestId(self):
|
|
5896
|
-
"""The unique request ID,
|
|
6328
|
+
"""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.
|
|
5897
6329
|
:rtype: str
|
|
5898
6330
|
"""
|
|
5899
6331
|
return self._RequestId
|
|
@@ -5904,6 +6336,7 @@ class ModifyDBInstanceNetworkAddressResponse(AbstractModel):
|
|
|
5904
6336
|
|
|
5905
6337
|
|
|
5906
6338
|
def _deserialize(self, params):
|
|
6339
|
+
self._FlowId = params.get("FlowId")
|
|
5907
6340
|
self._RequestId = params.get("RequestId")
|
|
5908
6341
|
|
|
5909
6342
|
|
|
@@ -5914,9 +6347,9 @@ class ModifyDBInstanceSecurityGroupRequest(AbstractModel):
|
|
|
5914
6347
|
|
|
5915
6348
|
def __init__(self):
|
|
5916
6349
|
r"""
|
|
5917
|
-
:param _InstanceId: Instance ID
|
|
6350
|
+
:param _InstanceId: Instance ID. For example, cmgo-7pje****.
|
|
5918
6351
|
:type InstanceId: str
|
|
5919
|
-
:param _SecurityGroupIds:
|
|
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.
|
|
5920
6353
|
:type SecurityGroupIds: list of str
|
|
5921
6354
|
"""
|
|
5922
6355
|
self._InstanceId = None
|
|
@@ -5924,7 +6357,7 @@ class ModifyDBInstanceSecurityGroupRequest(AbstractModel):
|
|
|
5924
6357
|
|
|
5925
6358
|
@property
|
|
5926
6359
|
def InstanceId(self):
|
|
5927
|
-
"""Instance ID
|
|
6360
|
+
"""Instance ID. For example, cmgo-7pje****.
|
|
5928
6361
|
:rtype: str
|
|
5929
6362
|
"""
|
|
5930
6363
|
return self._InstanceId
|
|
@@ -5935,7 +6368,7 @@ class ModifyDBInstanceSecurityGroupRequest(AbstractModel):
|
|
|
5935
6368
|
|
|
5936
6369
|
@property
|
|
5937
6370
|
def SecurityGroupIds(self):
|
|
5938
|
-
"""
|
|
6371
|
+
"""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.
|
|
5939
6372
|
:rtype: list of str
|
|
5940
6373
|
"""
|
|
5941
6374
|
return self._SecurityGroupIds
|
|
@@ -5965,14 +6398,14 @@ class ModifyDBInstanceSecurityGroupResponse(AbstractModel):
|
|
|
5965
6398
|
|
|
5966
6399
|
def __init__(self):
|
|
5967
6400
|
r"""
|
|
5968
|
-
:param _RequestId: The unique request ID,
|
|
6401
|
+
: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.
|
|
5969
6402
|
:type RequestId: str
|
|
5970
6403
|
"""
|
|
5971
6404
|
self._RequestId = None
|
|
5972
6405
|
|
|
5973
6406
|
@property
|
|
5974
6407
|
def RequestId(self):
|
|
5975
|
-
"""The unique request ID,
|
|
6408
|
+
"""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.
|
|
5976
6409
|
:rtype: str
|
|
5977
6410
|
"""
|
|
5978
6411
|
return self._RequestId
|
|
@@ -5993,20 +6426,42 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
5993
6426
|
|
|
5994
6427
|
def __init__(self):
|
|
5995
6428
|
r"""
|
|
5996
|
-
:param _InstanceId: Instance ID
|
|
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
|
+
|
|
5997
6431
|
:type InstanceId: str
|
|
5998
|
-
:param _Memory: Memory size after instance configuration
|
|
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.
|
|
5999
6433
|
:type Memory: int
|
|
6000
|
-
:param _Volume: Disk
|
|
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.
|
|
6001
6437
|
:type Volume: int
|
|
6002
|
-
:param _OplogSize:
|
|
6438
|
+
:param _OplogSize: (Deprecated) Use the independent API ResizeOplog.
|
|
6439
|
+
|
|
6440
|
+
Oplog size after instance configuration modification.
|
|
6441
|
+
- Unit: GB.
|
|
6442
|
+
- 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.
|
|
6003
6443
|
:type OplogSize: int
|
|
6004
|
-
:param _NodeNum:
|
|
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.
|
|
6005
6450
|
:type NodeNum: int
|
|
6006
|
-
:param _ReplicateSetNum:
|
|
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.
|
|
6007
6453
|
:type ReplicateSetNum: int
|
|
6008
|
-
:param _InMaintenance: Switch time
|
|
6454
|
+
:param _InMaintenance: Switch time for instance configuration modification.
|
|
6455
|
+
- 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0.
|
|
6456
|
+
- 1: Execute the configuration modification task within the maintenance window.
|
|
6457
|
+
**Note**: Adjusting the number of nodes and shards is unsupported <b>within the maintenance window</b>.
|
|
6009
6458
|
:type InMaintenance: int
|
|
6459
|
+
:param _MongosMemory: Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.
|
|
6460
|
+
:type MongosMemory: str
|
|
6461
|
+
:param _AddNodeList: List of nodes to be added, containing the node type and AZ information.
|
|
6462
|
+
: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.
|
|
6464
|
+
:type RemoveNodeList: list of RemoveNodeList
|
|
6010
6465
|
"""
|
|
6011
6466
|
self._InstanceId = None
|
|
6012
6467
|
self._Memory = None
|
|
@@ -6015,10 +6470,14 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6015
6470
|
self._NodeNum = None
|
|
6016
6471
|
self._ReplicateSetNum = None
|
|
6017
6472
|
self._InMaintenance = None
|
|
6473
|
+
self._MongosMemory = None
|
|
6474
|
+
self._AddNodeList = None
|
|
6475
|
+
self._RemoveNodeList = None
|
|
6018
6476
|
|
|
6019
6477
|
@property
|
|
6020
6478
|
def InstanceId(self):
|
|
6021
|
-
"""Instance ID
|
|
6479
|
+
"""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
|
+
|
|
6022
6481
|
:rtype: str
|
|
6023
6482
|
"""
|
|
6024
6483
|
return self._InstanceId
|
|
@@ -6029,7 +6488,7 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6029
6488
|
|
|
6030
6489
|
@property
|
|
6031
6490
|
def Memory(self):
|
|
6032
|
-
"""Memory size after instance configuration
|
|
6491
|
+
"""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.
|
|
6033
6492
|
:rtype: int
|
|
6034
6493
|
"""
|
|
6035
6494
|
return self._Memory
|
|
@@ -6040,7 +6499,9 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6040
6499
|
|
|
6041
6500
|
@property
|
|
6042
6501
|
def Volume(self):
|
|
6043
|
-
"""Disk
|
|
6502
|
+
"""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.
|
|
6044
6505
|
:rtype: int
|
|
6045
6506
|
"""
|
|
6046
6507
|
return self._Volume
|
|
@@ -6051,18 +6512,31 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6051
6512
|
|
|
6052
6513
|
@property
|
|
6053
6514
|
def OplogSize(self):
|
|
6054
|
-
"
|
|
6515
|
+
warnings.warn("parameter `OplogSize` is deprecated", DeprecationWarning)
|
|
6516
|
+
|
|
6517
|
+
"""(Deprecated) Use the independent API ResizeOplog.
|
|
6518
|
+
|
|
6519
|
+
Oplog size after instance configuration modification.
|
|
6520
|
+
- Unit: GB.
|
|
6521
|
+
- 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.
|
|
6055
6522
|
:rtype: int
|
|
6056
6523
|
"""
|
|
6057
6524
|
return self._OplogSize
|
|
6058
6525
|
|
|
6059
6526
|
@OplogSize.setter
|
|
6060
6527
|
def OplogSize(self, OplogSize):
|
|
6528
|
+
warnings.warn("parameter `OplogSize` is deprecated", DeprecationWarning)
|
|
6529
|
+
|
|
6061
6530
|
self._OplogSize = OplogSize
|
|
6062
6531
|
|
|
6063
6532
|
@property
|
|
6064
6533
|
def NodeNum(self):
|
|
6065
|
-
"""
|
|
6534
|
+
"""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.
|
|
6066
6540
|
:rtype: int
|
|
6067
6541
|
"""
|
|
6068
6542
|
return self._NodeNum
|
|
@@ -6073,7 +6547,8 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6073
6547
|
|
|
6074
6548
|
@property
|
|
6075
6549
|
def ReplicateSetNum(self):
|
|
6076
|
-
"""
|
|
6550
|
+
"""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.
|
|
6077
6552
|
:rtype: int
|
|
6078
6553
|
"""
|
|
6079
6554
|
return self._ReplicateSetNum
|
|
@@ -6084,7 +6559,10 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6084
6559
|
|
|
6085
6560
|
@property
|
|
6086
6561
|
def InMaintenance(self):
|
|
6087
|
-
"""Switch time
|
|
6562
|
+
"""Switch time for instance configuration modification.
|
|
6563
|
+
- 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0.
|
|
6564
|
+
- 1: Execute the configuration modification task within the maintenance window.
|
|
6565
|
+
**Note**: Adjusting the number of nodes and shards is unsupported <b>within the maintenance window</b>.
|
|
6088
6566
|
:rtype: int
|
|
6089
6567
|
"""
|
|
6090
6568
|
return self._InMaintenance
|
|
@@ -6093,6 +6571,39 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6093
6571
|
def InMaintenance(self, InMaintenance):
|
|
6094
6572
|
self._InMaintenance = InMaintenance
|
|
6095
6573
|
|
|
6574
|
+
@property
|
|
6575
|
+
def MongosMemory(self):
|
|
6576
|
+
"""Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.
|
|
6577
|
+
:rtype: str
|
|
6578
|
+
"""
|
|
6579
|
+
return self._MongosMemory
|
|
6580
|
+
|
|
6581
|
+
@MongosMemory.setter
|
|
6582
|
+
def MongosMemory(self, MongosMemory):
|
|
6583
|
+
self._MongosMemory = MongosMemory
|
|
6584
|
+
|
|
6585
|
+
@property
|
|
6586
|
+
def AddNodeList(self):
|
|
6587
|
+
"""List of nodes to be added, containing the node type and AZ information.
|
|
6588
|
+
:rtype: list of AddNodeList
|
|
6589
|
+
"""
|
|
6590
|
+
return self._AddNodeList
|
|
6591
|
+
|
|
6592
|
+
@AddNodeList.setter
|
|
6593
|
+
def AddNodeList(self, AddNodeList):
|
|
6594
|
+
self._AddNodeList = AddNodeList
|
|
6595
|
+
|
|
6596
|
+
@property
|
|
6597
|
+
def RemoveNodeList(self):
|
|
6598
|
+
"""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.
|
|
6599
|
+
:rtype: list of RemoveNodeList
|
|
6600
|
+
"""
|
|
6601
|
+
return self._RemoveNodeList
|
|
6602
|
+
|
|
6603
|
+
@RemoveNodeList.setter
|
|
6604
|
+
def RemoveNodeList(self, RemoveNodeList):
|
|
6605
|
+
self._RemoveNodeList = RemoveNodeList
|
|
6606
|
+
|
|
6096
6607
|
|
|
6097
6608
|
def _deserialize(self, params):
|
|
6098
6609
|
self._InstanceId = params.get("InstanceId")
|
|
@@ -6102,6 +6613,19 @@ class ModifyDBInstanceSpecRequest(AbstractModel):
|
|
|
6102
6613
|
self._NodeNum = params.get("NodeNum")
|
|
6103
6614
|
self._ReplicateSetNum = params.get("ReplicateSetNum")
|
|
6104
6615
|
self._InMaintenance = params.get("InMaintenance")
|
|
6616
|
+
self._MongosMemory = params.get("MongosMemory")
|
|
6617
|
+
if params.get("AddNodeList") is not None:
|
|
6618
|
+
self._AddNodeList = []
|
|
6619
|
+
for item in params.get("AddNodeList"):
|
|
6620
|
+
obj = AddNodeList()
|
|
6621
|
+
obj._deserialize(item)
|
|
6622
|
+
self._AddNodeList.append(obj)
|
|
6623
|
+
if params.get("RemoveNodeList") is not None:
|
|
6624
|
+
self._RemoveNodeList = []
|
|
6625
|
+
for item in params.get("RemoveNodeList"):
|
|
6626
|
+
obj = RemoveNodeList()
|
|
6627
|
+
obj._deserialize(item)
|
|
6628
|
+
self._RemoveNodeList.append(obj)
|
|
6105
6629
|
memeber_set = set(params.keys())
|
|
6106
6630
|
for name, value in vars(self).items():
|
|
6107
6631
|
property_name = name[1:]
|
|
@@ -6119,9 +6643,9 @@ class ModifyDBInstanceSpecResponse(AbstractModel):
|
|
|
6119
6643
|
|
|
6120
6644
|
def __init__(self):
|
|
6121
6645
|
r"""
|
|
6122
|
-
:param _DealId: Order ID
|
|
6646
|
+
:param _DealId: Order ID.
|
|
6123
6647
|
:type DealId: str
|
|
6124
|
-
:param _RequestId: The unique request ID,
|
|
6648
|
+
: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.
|
|
6125
6649
|
:type RequestId: str
|
|
6126
6650
|
"""
|
|
6127
6651
|
self._DealId = None
|
|
@@ -6129,7 +6653,7 @@ class ModifyDBInstanceSpecResponse(AbstractModel):
|
|
|
6129
6653
|
|
|
6130
6654
|
@property
|
|
6131
6655
|
def DealId(self):
|
|
6132
|
-
"""Order ID
|
|
6656
|
+
"""Order ID.
|
|
6133
6657
|
:rtype: str
|
|
6134
6658
|
"""
|
|
6135
6659
|
return self._DealId
|
|
@@ -6140,7 +6664,7 @@ class ModifyDBInstanceSpecResponse(AbstractModel):
|
|
|
6140
6664
|
|
|
6141
6665
|
@property
|
|
6142
6666
|
def RequestId(self):
|
|
6143
|
-
"""The unique request ID,
|
|
6667
|
+
"""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.
|
|
6144
6668
|
:rtype: str
|
|
6145
6669
|
"""
|
|
6146
6670
|
return self._RequestId
|
|
@@ -6251,7 +6775,7 @@ class OfflineIsolatedDBInstanceResponse(AbstractModel):
|
|
|
6251
6775
|
r"""
|
|
6252
6776
|
:param _AsyncRequestId: Async task request ID, which can be used to query the execution result of an async task.
|
|
6253
6777
|
:type AsyncRequestId: str
|
|
6254
|
-
:param _RequestId: The unique request ID,
|
|
6778
|
+
: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.
|
|
6255
6779
|
:type RequestId: str
|
|
6256
6780
|
"""
|
|
6257
6781
|
self._AsyncRequestId = None
|
|
@@ -6270,7 +6794,7 @@ class OfflineIsolatedDBInstanceResponse(AbstractModel):
|
|
|
6270
6794
|
|
|
6271
6795
|
@property
|
|
6272
6796
|
def RequestId(self):
|
|
6273
|
-
"""The unique request ID,
|
|
6797
|
+
"""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.
|
|
6274
6798
|
:rtype: str
|
|
6275
6799
|
"""
|
|
6276
6800
|
return self._RequestId
|
|
@@ -6285,6 +6809,88 @@ class OfflineIsolatedDBInstanceResponse(AbstractModel):
|
|
|
6285
6809
|
self._RequestId = params.get("RequestId")
|
|
6286
6810
|
|
|
6287
6811
|
|
|
6812
|
+
class RemoveNodeList(AbstractModel):
|
|
6813
|
+
"""Node details of an instance to be modified.
|
|
6814
|
+
|
|
6815
|
+
"""
|
|
6816
|
+
|
|
6817
|
+
def __init__(self):
|
|
6818
|
+
r"""
|
|
6819
|
+
:param _Role: Roles of nodes to be deleted.
|
|
6820
|
+
- SECONDARY: Mongod secondary node.
|
|
6821
|
+
- READONLY: read-only node.
|
|
6822
|
+
- MONGOS: Mongos node.
|
|
6823
|
+
: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.
|
|
6828
|
+
: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.
|
|
6832
|
+
:type Zone: str
|
|
6833
|
+
"""
|
|
6834
|
+
self._Role = None
|
|
6835
|
+
self._NodeName = None
|
|
6836
|
+
self._Zone = None
|
|
6837
|
+
|
|
6838
|
+
@property
|
|
6839
|
+
def Role(self):
|
|
6840
|
+
"""Roles of nodes to be deleted.
|
|
6841
|
+
- SECONDARY: Mongod secondary node.
|
|
6842
|
+
- READONLY: read-only node.
|
|
6843
|
+
- MONGOS: Mongos node.
|
|
6844
|
+
:rtype: str
|
|
6845
|
+
"""
|
|
6846
|
+
return self._Role
|
|
6847
|
+
|
|
6848
|
+
@Role.setter
|
|
6849
|
+
def Role(self, Role):
|
|
6850
|
+
self._Role = Role
|
|
6851
|
+
|
|
6852
|
+
@property
|
|
6853
|
+
def NodeName(self):
|
|
6854
|
+
"""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.
|
|
6858
|
+
:rtype: str
|
|
6859
|
+
"""
|
|
6860
|
+
return self._NodeName
|
|
6861
|
+
|
|
6862
|
+
@NodeName.setter
|
|
6863
|
+
def NodeName(self, NodeName):
|
|
6864
|
+
self._NodeName = NodeName
|
|
6865
|
+
|
|
6866
|
+
@property
|
|
6867
|
+
def Zone(self):
|
|
6868
|
+
"""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.
|
|
6871
|
+
:rtype: str
|
|
6872
|
+
"""
|
|
6873
|
+
return self._Zone
|
|
6874
|
+
|
|
6875
|
+
@Zone.setter
|
|
6876
|
+
def Zone(self, Zone):
|
|
6877
|
+
self._Zone = Zone
|
|
6878
|
+
|
|
6879
|
+
|
|
6880
|
+
def _deserialize(self, params):
|
|
6881
|
+
self._Role = params.get("Role")
|
|
6882
|
+
self._NodeName = params.get("NodeName")
|
|
6883
|
+
self._Zone = params.get("Zone")
|
|
6884
|
+
memeber_set = set(params.keys())
|
|
6885
|
+
for name, value in vars(self).items():
|
|
6886
|
+
property_name = name[1:]
|
|
6887
|
+
if property_name in memeber_set:
|
|
6888
|
+
memeber_set.remove(property_name)
|
|
6889
|
+
if len(memeber_set) > 0:
|
|
6890
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
6891
|
+
|
|
6892
|
+
|
|
6893
|
+
|
|
6288
6894
|
class RenameInstanceRequest(AbstractModel):
|
|
6289
6895
|
"""RenameInstance request structure.
|
|
6290
6896
|
|
|
@@ -6292,9 +6898,9 @@ class RenameInstanceRequest(AbstractModel):
|
|
|
6292
6898
|
|
|
6293
6899
|
def __init__(self):
|
|
6294
6900
|
r"""
|
|
6295
|
-
:param _InstanceId: Instance ID
|
|
6901
|
+
:param _InstanceId: Instance ID. Format: cmgo-p8vnipr5. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB#/) and copy the instance ID from the instance list.
|
|
6296
6902
|
:type InstanceId: str
|
|
6297
|
-
:param _NewName: Custom name
|
|
6903
|
+
:param _NewName: Custom instance name. It can contain any character, with a length from 1 to 128 characters.
|
|
6298
6904
|
:type NewName: str
|
|
6299
6905
|
"""
|
|
6300
6906
|
self._InstanceId = None
|
|
@@ -6302,7 +6908,7 @@ class RenameInstanceRequest(AbstractModel):
|
|
|
6302
6908
|
|
|
6303
6909
|
@property
|
|
6304
6910
|
def InstanceId(self):
|
|
6305
|
-
"""Instance ID
|
|
6911
|
+
"""Instance ID. Format: cmgo-p8vnipr5. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB#/) and copy the instance ID from the instance list.
|
|
6306
6912
|
:rtype: str
|
|
6307
6913
|
"""
|
|
6308
6914
|
return self._InstanceId
|
|
@@ -6313,7 +6919,7 @@ class RenameInstanceRequest(AbstractModel):
|
|
|
6313
6919
|
|
|
6314
6920
|
@property
|
|
6315
6921
|
def NewName(self):
|
|
6316
|
-
"""Custom name
|
|
6922
|
+
"""Custom instance name. It can contain any character, with a length from 1 to 128 characters.
|
|
6317
6923
|
:rtype: str
|
|
6318
6924
|
"""
|
|
6319
6925
|
return self._NewName
|
|
@@ -6343,14 +6949,14 @@ class RenameInstanceResponse(AbstractModel):
|
|
|
6343
6949
|
|
|
6344
6950
|
def __init__(self):
|
|
6345
6951
|
r"""
|
|
6346
|
-
:param _RequestId: The unique request ID,
|
|
6952
|
+
: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.
|
|
6347
6953
|
:type RequestId: str
|
|
6348
6954
|
"""
|
|
6349
6955
|
self._RequestId = None
|
|
6350
6956
|
|
|
6351
6957
|
@property
|
|
6352
6958
|
def RequestId(self):
|
|
6353
|
-
"""The unique request ID,
|
|
6959
|
+
"""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.
|
|
6354
6960
|
:rtype: str
|
|
6355
6961
|
"""
|
|
6356
6962
|
return self._RequestId
|
|
@@ -6371,7 +6977,9 @@ class RenewDBInstancesRequest(AbstractModel):
|
|
|
6371
6977
|
|
|
6372
6978
|
def __init__(self):
|
|
6373
6979
|
r"""
|
|
6374
|
-
:param _InstanceIds: IDs of one or
|
|
6980
|
+
: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.
|
|
6375
6983
|
:type InstanceIds: list of str
|
|
6376
6984
|
: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.
|
|
6377
6985
|
:type InstanceChargePrepaid: :class:`tencentcloud.mongodb.v20190725.models.InstanceChargePrepaid`
|
|
@@ -6381,7 +6989,9 @@ class RenewDBInstancesRequest(AbstractModel):
|
|
|
6381
6989
|
|
|
6382
6990
|
@property
|
|
6383
6991
|
def InstanceIds(self):
|
|
6384
|
-
"""IDs of one or
|
|
6992
|
+
"""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.
|
|
6385
6995
|
:rtype: list of str
|
|
6386
6996
|
"""
|
|
6387
6997
|
return self._InstanceIds
|
|
@@ -6424,14 +7034,14 @@ class RenewDBInstancesResponse(AbstractModel):
|
|
|
6424
7034
|
|
|
6425
7035
|
def __init__(self):
|
|
6426
7036
|
r"""
|
|
6427
|
-
:param _RequestId: The unique request ID,
|
|
7037
|
+
: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.
|
|
6428
7038
|
:type RequestId: str
|
|
6429
7039
|
"""
|
|
6430
7040
|
self._RequestId = None
|
|
6431
7041
|
|
|
6432
7042
|
@property
|
|
6433
7043
|
def RequestId(self):
|
|
6434
|
-
"""The unique request ID,
|
|
7044
|
+
"""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.
|
|
6435
7045
|
:rtype: str
|
|
6436
7046
|
"""
|
|
6437
7047
|
return self._RequestId
|
|
@@ -6556,7 +7166,7 @@ class ResetDBInstancePasswordResponse(AbstractModel):
|
|
|
6556
7166
|
r"""
|
|
6557
7167
|
:param _AsyncRequestId: Async request ID, which is used to query the running status of the process.
|
|
6558
7168
|
:type AsyncRequestId: str
|
|
6559
|
-
:param _RequestId: The unique request ID,
|
|
7169
|
+
: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.
|
|
6560
7170
|
:type RequestId: str
|
|
6561
7171
|
"""
|
|
6562
7172
|
self._AsyncRequestId = None
|
|
@@ -6575,7 +7185,7 @@ class ResetDBInstancePasswordResponse(AbstractModel):
|
|
|
6575
7185
|
|
|
6576
7186
|
@property
|
|
6577
7187
|
def RequestId(self):
|
|
6578
|
-
"""The unique request ID,
|
|
7188
|
+
"""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.
|
|
6579
7189
|
:rtype: str
|
|
6580
7190
|
"""
|
|
6581
7191
|
return self._RequestId
|
|
@@ -7096,47 +7706,70 @@ class SpecItem(AbstractModel):
|
|
|
7096
7706
|
|
|
7097
7707
|
def __init__(self):
|
|
7098
7708
|
r"""
|
|
7099
|
-
:param _SpecCode: Specification information identifier
|
|
7709
|
+
: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.
|
|
7100
7720
|
:type SpecCode: str
|
|
7101
|
-
:param _Status:
|
|
7721
|
+
:param _Status: Saleable specification status flag. Valid values are as follows:
|
|
7722
|
+
- 0: selling stopped.
|
|
7723
|
+
- 1: available for sale.
|
|
7102
7724
|
:type Status: int
|
|
7103
|
-
:param _Cpu: Computing resource specification
|
|
7725
|
+
:param _Cpu: Computing resource specification, indicating the number of CPU cores.
|
|
7104
7726
|
:type Cpu: int
|
|
7105
|
-
:param _Memory: Memory
|
|
7727
|
+
:param _Memory: Memory specification. Unit: MB.
|
|
7106
7728
|
:type Memory: int
|
|
7107
|
-
:param _DefaultStorage: Default disk
|
|
7729
|
+
:param _DefaultStorage: Default disk specification. Unit: MB.
|
|
7108
7730
|
:type DefaultStorage: int
|
|
7109
|
-
:param _MaxStorage: Maximum disk
|
|
7731
|
+
:param _MaxStorage: Maximum disk specification. Unit: MB.
|
|
7110
7732
|
:type MaxStorage: int
|
|
7111
|
-
:param _MinStorage: Minimum disk
|
|
7733
|
+
:param _MinStorage: Minimum disk specification. Unit: MB.
|
|
7112
7734
|
:type MinStorage: int
|
|
7113
|
-
:param _Qps: Maximum
|
|
7735
|
+
:param _Qps: Maximum number of requests per second. Unit: requests/second.
|
|
7114
7736
|
:type Qps: int
|
|
7115
|
-
:param _Conns: Maximum number of connections
|
|
7737
|
+
:param _Conns: Maximum number of connections supported for the specification.
|
|
7116
7738
|
:type Conns: int
|
|
7117
|
-
:param _MongoVersionCode:
|
|
7739
|
+
: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.
|
|
7118
7746
|
:type MongoVersionCode: str
|
|
7119
|
-
:param _MongoVersionValue:
|
|
7747
|
+
:param _MongoVersionValue: Digital version corresponding to the instance version.
|
|
7120
7748
|
:type MongoVersionValue: int
|
|
7121
|
-
:param _Version:
|
|
7749
|
+
:param _Version: Instance version information. Valid values: 3.6, 4.2, 4.4, 5.0, and 6.0.
|
|
7750
|
+
|
|
7122
7751
|
:type Version: str
|
|
7123
|
-
:param _EngineName: Storage engine
|
|
7752
|
+
:param _EngineName: Storage engine.
|
|
7124
7753
|
:type EngineName: str
|
|
7125
|
-
:param _ClusterType: Cluster type. Valid values
|
|
7754
|
+
:param _ClusterType: Cluster type. Valid values are as follows:
|
|
7755
|
+
- 1: sharded cluster.
|
|
7756
|
+
- 0: replica set cluster.
|
|
7126
7757
|
:type ClusterType: int
|
|
7127
|
-
:param _MinNodeNum: Minimum number of
|
|
7758
|
+
:param _MinNodeNum: Minimum number of nodes for each replica set.
|
|
7128
7759
|
:type MinNodeNum: int
|
|
7129
|
-
:param _MaxNodeNum: Maximum number of
|
|
7760
|
+
:param _MaxNodeNum: Maximum number of nodes for each replica set.
|
|
7130
7761
|
:type MaxNodeNum: int
|
|
7131
|
-
:param _MinReplicateSetNum: Minimum number of shards
|
|
7762
|
+
:param _MinReplicateSetNum: Minimum number of shards.
|
|
7132
7763
|
:type MinReplicateSetNum: int
|
|
7133
|
-
:param _MaxReplicateSetNum: Maximum number of shards
|
|
7764
|
+
:param _MaxReplicateSetNum: Maximum number of shards.
|
|
7134
7765
|
:type MaxReplicateSetNum: int
|
|
7135
|
-
:param _MinReplicateSetNodeNum: Minimum number of
|
|
7766
|
+
:param _MinReplicateSetNodeNum: Minimum number of nodes for each shard.
|
|
7136
7767
|
:type MinReplicateSetNodeNum: int
|
|
7137
|
-
:param _MaxReplicateSetNodeNum: Maximum number of
|
|
7768
|
+
:param _MaxReplicateSetNodeNum: Maximum number of nodes for each shard.
|
|
7138
7769
|
:type MaxReplicateSetNodeNum: int
|
|
7139
|
-
:param _MachineType:
|
|
7770
|
+
:param _MachineType: Cluster specification type. Valid values are as follows:
|
|
7771
|
+
- HIO10G: general high-I/O 10GE type.
|
|
7772
|
+
- HCD: cloud disk type.
|
|
7140
7773
|
:type MachineType: str
|
|
7141
7774
|
"""
|
|
7142
7775
|
self._SpecCode = None
|
|
@@ -7163,7 +7796,17 @@ class SpecItem(AbstractModel):
|
|
|
7163
7796
|
|
|
7164
7797
|
@property
|
|
7165
7798
|
def SpecCode(self):
|
|
7166
|
-
"""Specification information identifier
|
|
7799
|
+
"""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.
|
|
7167
7810
|
:rtype: str
|
|
7168
7811
|
"""
|
|
7169
7812
|
return self._SpecCode
|
|
@@ -7174,7 +7817,9 @@ class SpecItem(AbstractModel):
|
|
|
7174
7817
|
|
|
7175
7818
|
@property
|
|
7176
7819
|
def Status(self):
|
|
7177
|
-
"""
|
|
7820
|
+
"""Saleable specification status flag. Valid values are as follows:
|
|
7821
|
+
- 0: selling stopped.
|
|
7822
|
+
- 1: available for sale.
|
|
7178
7823
|
:rtype: int
|
|
7179
7824
|
"""
|
|
7180
7825
|
return self._Status
|
|
@@ -7185,7 +7830,7 @@ class SpecItem(AbstractModel):
|
|
|
7185
7830
|
|
|
7186
7831
|
@property
|
|
7187
7832
|
def Cpu(self):
|
|
7188
|
-
"""Computing resource specification
|
|
7833
|
+
"""Computing resource specification, indicating the number of CPU cores.
|
|
7189
7834
|
:rtype: int
|
|
7190
7835
|
"""
|
|
7191
7836
|
return self._Cpu
|
|
@@ -7196,7 +7841,7 @@ class SpecItem(AbstractModel):
|
|
|
7196
7841
|
|
|
7197
7842
|
@property
|
|
7198
7843
|
def Memory(self):
|
|
7199
|
-
"""Memory
|
|
7844
|
+
"""Memory specification. Unit: MB.
|
|
7200
7845
|
:rtype: int
|
|
7201
7846
|
"""
|
|
7202
7847
|
return self._Memory
|
|
@@ -7207,7 +7852,7 @@ class SpecItem(AbstractModel):
|
|
|
7207
7852
|
|
|
7208
7853
|
@property
|
|
7209
7854
|
def DefaultStorage(self):
|
|
7210
|
-
"""Default disk
|
|
7855
|
+
"""Default disk specification. Unit: MB.
|
|
7211
7856
|
:rtype: int
|
|
7212
7857
|
"""
|
|
7213
7858
|
return self._DefaultStorage
|
|
@@ -7218,7 +7863,7 @@ class SpecItem(AbstractModel):
|
|
|
7218
7863
|
|
|
7219
7864
|
@property
|
|
7220
7865
|
def MaxStorage(self):
|
|
7221
|
-
"""Maximum disk
|
|
7866
|
+
"""Maximum disk specification. Unit: MB.
|
|
7222
7867
|
:rtype: int
|
|
7223
7868
|
"""
|
|
7224
7869
|
return self._MaxStorage
|
|
@@ -7229,7 +7874,7 @@ class SpecItem(AbstractModel):
|
|
|
7229
7874
|
|
|
7230
7875
|
@property
|
|
7231
7876
|
def MinStorage(self):
|
|
7232
|
-
"""Minimum disk
|
|
7877
|
+
"""Minimum disk specification. Unit: MB.
|
|
7233
7878
|
:rtype: int
|
|
7234
7879
|
"""
|
|
7235
7880
|
return self._MinStorage
|
|
@@ -7240,7 +7885,7 @@ class SpecItem(AbstractModel):
|
|
|
7240
7885
|
|
|
7241
7886
|
@property
|
|
7242
7887
|
def Qps(self):
|
|
7243
|
-
"""Maximum
|
|
7888
|
+
"""Maximum number of requests per second. Unit: requests/second.
|
|
7244
7889
|
:rtype: int
|
|
7245
7890
|
"""
|
|
7246
7891
|
return self._Qps
|
|
@@ -7251,7 +7896,7 @@ class SpecItem(AbstractModel):
|
|
|
7251
7896
|
|
|
7252
7897
|
@property
|
|
7253
7898
|
def Conns(self):
|
|
7254
|
-
"""Maximum number of connections
|
|
7899
|
+
"""Maximum number of connections supported for the specification.
|
|
7255
7900
|
:rtype: int
|
|
7256
7901
|
"""
|
|
7257
7902
|
return self._Conns
|
|
@@ -7262,7 +7907,13 @@ class SpecItem(AbstractModel):
|
|
|
7262
7907
|
|
|
7263
7908
|
@property
|
|
7264
7909
|
def MongoVersionCode(self):
|
|
7265
|
-
"""
|
|
7910
|
+
"""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.
|
|
7266
7917
|
:rtype: str
|
|
7267
7918
|
"""
|
|
7268
7919
|
return self._MongoVersionCode
|
|
@@ -7273,7 +7924,7 @@ class SpecItem(AbstractModel):
|
|
|
7273
7924
|
|
|
7274
7925
|
@property
|
|
7275
7926
|
def MongoVersionValue(self):
|
|
7276
|
-
"""
|
|
7927
|
+
"""Digital version corresponding to the instance version.
|
|
7277
7928
|
:rtype: int
|
|
7278
7929
|
"""
|
|
7279
7930
|
return self._MongoVersionValue
|
|
@@ -7284,7 +7935,8 @@ class SpecItem(AbstractModel):
|
|
|
7284
7935
|
|
|
7285
7936
|
@property
|
|
7286
7937
|
def Version(self):
|
|
7287
|
-
"""
|
|
7938
|
+
"""Instance version information. Valid values: 3.6, 4.2, 4.4, 5.0, and 6.0.
|
|
7939
|
+
|
|
7288
7940
|
:rtype: str
|
|
7289
7941
|
"""
|
|
7290
7942
|
return self._Version
|
|
@@ -7295,7 +7947,7 @@ class SpecItem(AbstractModel):
|
|
|
7295
7947
|
|
|
7296
7948
|
@property
|
|
7297
7949
|
def EngineName(self):
|
|
7298
|
-
"""Storage engine
|
|
7950
|
+
"""Storage engine.
|
|
7299
7951
|
:rtype: str
|
|
7300
7952
|
"""
|
|
7301
7953
|
return self._EngineName
|
|
@@ -7306,7 +7958,9 @@ class SpecItem(AbstractModel):
|
|
|
7306
7958
|
|
|
7307
7959
|
@property
|
|
7308
7960
|
def ClusterType(self):
|
|
7309
|
-
"""Cluster type. Valid values
|
|
7961
|
+
"""Cluster type. Valid values are as follows:
|
|
7962
|
+
- 1: sharded cluster.
|
|
7963
|
+
- 0: replica set cluster.
|
|
7310
7964
|
:rtype: int
|
|
7311
7965
|
"""
|
|
7312
7966
|
return self._ClusterType
|
|
@@ -7317,7 +7971,7 @@ class SpecItem(AbstractModel):
|
|
|
7317
7971
|
|
|
7318
7972
|
@property
|
|
7319
7973
|
def MinNodeNum(self):
|
|
7320
|
-
"""Minimum number of
|
|
7974
|
+
"""Minimum number of nodes for each replica set.
|
|
7321
7975
|
:rtype: int
|
|
7322
7976
|
"""
|
|
7323
7977
|
return self._MinNodeNum
|
|
@@ -7328,7 +7982,7 @@ class SpecItem(AbstractModel):
|
|
|
7328
7982
|
|
|
7329
7983
|
@property
|
|
7330
7984
|
def MaxNodeNum(self):
|
|
7331
|
-
"""Maximum number of
|
|
7985
|
+
"""Maximum number of nodes for each replica set.
|
|
7332
7986
|
:rtype: int
|
|
7333
7987
|
"""
|
|
7334
7988
|
return self._MaxNodeNum
|
|
@@ -7339,7 +7993,7 @@ class SpecItem(AbstractModel):
|
|
|
7339
7993
|
|
|
7340
7994
|
@property
|
|
7341
7995
|
def MinReplicateSetNum(self):
|
|
7342
|
-
"""Minimum number of shards
|
|
7996
|
+
"""Minimum number of shards.
|
|
7343
7997
|
:rtype: int
|
|
7344
7998
|
"""
|
|
7345
7999
|
return self._MinReplicateSetNum
|
|
@@ -7350,7 +8004,7 @@ class SpecItem(AbstractModel):
|
|
|
7350
8004
|
|
|
7351
8005
|
@property
|
|
7352
8006
|
def MaxReplicateSetNum(self):
|
|
7353
|
-
"""Maximum number of shards
|
|
8007
|
+
"""Maximum number of shards.
|
|
7354
8008
|
:rtype: int
|
|
7355
8009
|
"""
|
|
7356
8010
|
return self._MaxReplicateSetNum
|
|
@@ -7361,7 +8015,7 @@ class SpecItem(AbstractModel):
|
|
|
7361
8015
|
|
|
7362
8016
|
@property
|
|
7363
8017
|
def MinReplicateSetNodeNum(self):
|
|
7364
|
-
"""Minimum number of
|
|
8018
|
+
"""Minimum number of nodes for each shard.
|
|
7365
8019
|
:rtype: int
|
|
7366
8020
|
"""
|
|
7367
8021
|
return self._MinReplicateSetNodeNum
|
|
@@ -7372,7 +8026,7 @@ class SpecItem(AbstractModel):
|
|
|
7372
8026
|
|
|
7373
8027
|
@property
|
|
7374
8028
|
def MaxReplicateSetNodeNum(self):
|
|
7375
|
-
"""Maximum number of
|
|
8029
|
+
"""Maximum number of nodes for each shard.
|
|
7376
8030
|
:rtype: int
|
|
7377
8031
|
"""
|
|
7378
8032
|
return self._MaxReplicateSetNodeNum
|
|
@@ -7383,7 +8037,9 @@ class SpecItem(AbstractModel):
|
|
|
7383
8037
|
|
|
7384
8038
|
@property
|
|
7385
8039
|
def MachineType(self):
|
|
7386
|
-
"""
|
|
8040
|
+
"""Cluster specification type. Valid values are as follows:
|
|
8041
|
+
- HIO10G: general high-I/O 10GE type.
|
|
8042
|
+
- HCD: cloud disk type.
|
|
7387
8043
|
:rtype: str
|
|
7388
8044
|
"""
|
|
7389
8045
|
return self._MachineType
|