tccli-intl-en 3.0.1271.1__py2.py3-none-any.whl → 3.0.1272.1__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.
@@ -22,7 +22,7 @@
22
22
  "status": "online"
23
23
  },
24
24
  "CreateDBInstance": {
25
- "document": "This API is used to create a monthly subscription TencentDB for MongoDB instance. The purchasable specifications supported by this API can be obtained through the `DescribeSpecInfo` API.",
25
+ "document": "This API is used to create a yearly/monthly subscription TencentDB for MongoDB instance. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/35767?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.",
26
26
  "input": "CreateDBInstanceRequest",
27
27
  "name": "Creates a monthly subscription TencentDB instance",
28
28
  "output": "CreateDBInstanceResponse",
@@ -43,7 +43,7 @@
43
43
  "status": "online"
44
44
  },
45
45
  "DescribeBackupDownloadTask": {
46
- "document": "This API is used to query backup download task information.",
46
+ "document": "This API is used to query information about the backup download task.",
47
47
  "input": "DescribeBackupDownloadTaskRequest",
48
48
  "name": "Queries backup download task information",
49
49
  "output": "DescribeBackupDownloadTaskResponse",
@@ -84,6 +84,13 @@
84
84
  "output": "DescribeDBInstancesResponse",
85
85
  "status": "online"
86
86
  },
87
+ "DescribeDetailedSlowLogs": {
88
+ "document": "This API is used to query slow log details of the instance.",
89
+ "input": "DescribeDetailedSlowLogsRequest",
90
+ "name": "Query instance slow log details",
91
+ "output": "DescribeDetailedSlowLogsResponse",
92
+ "status": "online"
93
+ },
87
94
  "DescribeInstanceParams": {
88
95
  "document": "This API is used to query the list of parameters that can be modified for the current instance.",
89
96
  "input": "DescribeInstanceParamsRequest",
@@ -113,7 +120,7 @@
113
120
  "status": "online"
114
121
  },
115
122
  "DescribeSpecInfo": {
116
- "document": "This API is used to query the purchasable instance specifications.",
123
+ "document": "This API is used to query the sales specification of an instance.",
117
124
  "input": "DescribeSpecInfoRequest",
118
125
  "name": "Queries the specifications of purchasable TencentDB instances",
119
126
  "output": "DescribeSpecInfoResponse",
@@ -148,7 +155,7 @@
148
155
  "status": "online"
149
156
  },
150
157
  "IsolateDBInstance": {
151
- "document": "This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. An isolated instance is retained in the recycle bin and data can no longer be written to it. After it is isolated for a certain period of time, it will be completely deleted. For the retention period in the recycle bin, please see the terms of service for pay-as-you-go billing. Isolated pay-as-you-go instances cannot be recovered, so please proceed with caution.",
158
+ "document": "This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. After isolation, the instance is retained in the recycle bin, and data cannot be written into it. After a certain period of isolation, the instance is deleted permanently. For the retention time in the recycle bin, see the pay-as-you-go service terms. The deleted pay-as-you-go instance cannot be recovered. Proceed with caution.",
152
159
  "input": "IsolateDBInstanceRequest",
153
160
  "name": "Isolates a TencentDB Instance",
154
161
  "output": "IsolateDBInstanceResponse",
@@ -169,7 +176,7 @@
169
176
  "status": "online"
170
177
  },
171
178
  "ModifyDBInstanceSpec": {
172
- "document": "This API is used to adjust the configuration of a TencentDB for MongoDB instance. Saleable specifications supported for this API can be obtained from the DescribeSpecInfo API for querying saleable TencentDB for MongoDB specifications.",
179
+ "document": "This API is used to adjust the TencentDB for MongoDB instance configuration. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.",
173
180
  "input": "ModifyDBInstanceSpecRequest",
174
181
  "name": "Adjusts the configurations of a TencentDB instance",
175
182
  "output": "ModifyDBInstanceSpecResponse",
@@ -197,11 +204,25 @@
197
204
  "status": "online"
198
205
  },
199
206
  "ResetDBInstancePassword": {
200
- "document": "This API is used to modify instance password.",
207
+ "document": "This API is used to reset the instance access password.",
201
208
  "input": "ResetDBInstancePasswordRequest",
202
209
  "name": "Modifies instance password",
203
210
  "output": "ResetDBInstancePasswordResponse",
204
211
  "status": "online"
212
+ },
213
+ "SetDBInstanceDeletionProtection": {
214
+ "document": "This API is used to set instance termination protection.",
215
+ "input": "SetDBInstanceDeletionProtectionRequest",
216
+ "name": "Sets instance termination protection",
217
+ "output": "SetDBInstanceDeletionProtectionResponse",
218
+ "status": "online"
219
+ },
220
+ "TerminateDBInstances": {
221
+ "document": "This API is used to terminate monthly subscription billing instances.",
222
+ "input": "TerminateDBInstancesRequest",
223
+ "name": "Monthly subscription return and refund",
224
+ "output": "TerminateDBInstancesResponse",
225
+ "status": "online"
205
226
  }
206
227
  },
207
228
  "metadata": {
@@ -211,7 +232,7 @@
211
232
  },
212
233
  "objects": {
213
234
  "AddNodeList": {
214
- "document": "Node details of an instance to be modified.",
235
+ "document": "Node details of the instance to be modified.",
215
236
  "members": [
216
237
  {
217
238
  "disabled": false,
@@ -224,7 +245,7 @@
224
245
  },
225
246
  {
226
247
  "disabled": false,
227
- "document": "AZs corresponding to the nodes.\n - Single AZ: All nodes are in the same AZ.\n - 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.",
248
+ "document": "AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).\n- Single AZ: All nodes are in the same AZ.\n- Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any 2 AZs should be greater than that in the third AZ.",
228
249
  "example": "ap-guangzhou-2",
229
250
  "member": "string",
230
251
  "name": "Zone",
@@ -248,8 +269,8 @@
248
269
  },
249
270
  {
250
271
  "disabled": false,
251
- "document": "Unique ID of an existing project (instead of a new project).",
252
- "example": "1118****",
272
+ "document": "Project ID, the unique ID of the project created by the user. Go to the [project management](https://console.cloud.tencent.com/project) area of the account center in the console to copy the project ID.",
273
+ "example": "12",
253
274
  "member": "uint64",
254
275
  "name": "ProjectId",
255
276
  "required": true,
@@ -263,8 +284,8 @@
263
284
  "members": [
264
285
  {
265
286
  "disabled": false,
266
- "document": "List of the returned async task IDs",
267
- "example": "[1081****]",
287
+ "document": "Lists async task ids returned.",
288
+ "example": "[1081,1082]",
268
289
  "member": "uint64",
269
290
  "name": "FlowIds",
270
291
  "output_required": true,
@@ -285,7 +306,7 @@
285
306
  "members": [
286
307
  {
287
308
  "disabled": false,
288
- "document": "Task creation time",
309
+ "document": "Task creation time.",
289
310
  "example": "2021-01-02 15:04:05",
290
311
  "member": "string",
291
312
  "name": "CreateTime",
@@ -295,7 +316,7 @@
295
316
  },
296
317
  {
297
318
  "disabled": false,
298
- "document": "Backup name",
319
+ "document": "Backup file name.",
299
320
  "example": "cmgo-74sj****_2021-03-24 15:40",
300
321
  "member": "string",
301
322
  "name": "BackupName",
@@ -305,7 +326,7 @@
305
326
  },
306
327
  {
307
328
  "disabled": false,
308
- "document": "Shard name",
329
+ "document": "Shard name.",
309
330
  "example": "cmgo-74sj****_0",
310
331
  "member": "string",
311
332
  "name": "ReplicaSetId",
@@ -315,7 +336,7 @@
315
336
  },
316
337
  {
317
338
  "disabled": false,
318
- "document": "Backup size in bytes",
339
+ "document": "Backup data size, in bytes.",
319
340
  "example": "102400",
320
341
  "member": "int64",
321
342
  "name": "BackupSize",
@@ -325,7 +346,7 @@
325
346
  },
326
347
  {
327
348
  "disabled": false,
328
- "document": "Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)",
349
+ "document": "Task status.\n- 0: wait for execution.\n- 1: downloading.\n- 2: download completed.\n- 3: download failed.\n- 4: wait for retry.",
329
350
  "example": "0",
330
351
  "member": "int64",
331
352
  "name": "Status",
@@ -335,7 +356,7 @@
335
356
  },
336
357
  {
337
358
  "disabled": false,
338
- "document": "Task progress in percentage",
359
+ "document": "Task progress percentage.",
339
360
  "example": "20",
340
361
  "member": "int64",
341
362
  "name": "Percent",
@@ -345,7 +366,7 @@
345
366
  },
346
367
  {
347
368
  "disabled": false,
348
- "document": "Task duration in seconds",
369
+ "document": "Duration, in seconds.",
349
370
  "example": "60",
350
371
  "member": "int64",
351
372
  "name": "TimeSpend",
@@ -355,7 +376,7 @@
355
376
  },
356
377
  {
357
378
  "disabled": false,
358
- "document": "Backup download address",
379
+ "document": "Download link for backup data.",
359
380
  "example": "http://cmgo-****.b.c/d.tar?e",
360
381
  "member": "string",
361
382
  "name": "Url",
@@ -365,7 +386,7 @@
365
386
  },
366
387
  {
367
388
  "disabled": false,
368
- "document": "Backup type of the backup file. Valid values: `0` (logical backup), `1` (physical backup)",
389
+ "document": "Backup method.\n- 0: logical backup.\n- 1: physical backup.\n- 3: snapshot backup.\n**Note**:\n1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.\n2. Physical backup is not supported when storage encryption is enabled for the instance.",
369
390
  "example": "1",
370
391
  "member": "int64",
371
392
  "name": "BackupMethod",
@@ -375,7 +396,7 @@
375
396
  },
376
397
  {
377
398
  "disabled": false,
378
- "document": "Specifies the remarks for backup.",
399
+ "document": "Specified remarks for initiating backup tasks.",
379
400
  "example": "我的备份",
380
401
  "member": "string",
381
402
  "name": "BackupDesc",
@@ -407,25 +428,25 @@
407
428
  "usage": "out"
408
429
  },
409
430
  "BackupDownloadTaskStatus": {
410
- "document": "The result of the created backup download task",
431
+ "document": "Result of creating a backup download task.",
411
432
  "members": [
412
433
  {
413
434
  "disabled": false,
414
- "document": "Shard name",
435
+ "document": "Shard name.",
415
436
  "example": "cmgo-74sjf5mt_0",
416
437
  "member": "string",
417
438
  "name": "ReplicaSetId",
418
- "required": true,
439
+ "output_required": true,
419
440
  "type": "string",
420
441
  "value_allowed_null": false
421
442
  },
422
443
  {
423
444
  "disabled": false,
424
- "document": "Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)",
445
+ "document": "Current status of the task.\n- 0: wait for execution.\n- 1: downloading.\n- 2: download completed.\n- 3: download failed.\n- 4: wait for retry.",
425
446
  "example": "0",
426
447
  "member": "int64",
427
448
  "name": "Status",
428
- "required": true,
449
+ "output_required": true,
429
450
  "type": "int",
430
451
  "value_allowed_null": false
431
452
  }
@@ -433,7 +454,7 @@
433
454
  "usage": "out"
434
455
  },
435
456
  "BackupInfo": {
436
- "document": "Backup information",
457
+ "document": "Backup information.",
437
458
  "members": [
438
459
  {
439
460
  "disabled": false,
@@ -447,7 +468,7 @@
447
468
  },
448
469
  {
449
470
  "disabled": false,
450
- "document": "Backup mode. 0: automatic backup; 1: manual backup",
471
+ "document": "Backup method.\n- 0: automatic backup.\n- 1: manual backup.",
451
472
  "example": "0",
452
473
  "member": "uint64",
453
474
  "name": "BackupType",
@@ -457,7 +478,7 @@
457
478
  },
458
479
  {
459
480
  "disabled": false,
460
- "document": "Backup name",
481
+ "document": "Backup file name.",
461
482
  "example": "cmgo-ca2n****_2021-12-13 02:02",
462
483
  "member": "string",
463
484
  "name": "BackupName",
@@ -467,7 +488,7 @@
467
488
  },
468
489
  {
469
490
  "disabled": false,
470
- "document": "Backup remarks.",
491
+ "document": "Backup task remarks.",
471
492
  "example": "系统后台每日定时自动备份",
472
493
  "member": "string",
473
494
  "name": "BackupDesc",
@@ -477,7 +498,7 @@
477
498
  },
478
499
  {
479
500
  "disabled": false,
480
- "document": "Backup file size. Unit: KB.",
501
+ "document": "Backup file size, in KB.",
481
502
  "example": "326594030",
482
503
  "member": "uint64",
483
504
  "name": "BackupSize",
@@ -507,7 +528,7 @@
507
528
  },
508
529
  {
509
530
  "disabled": false,
510
- "document": "Backup status. 1: backing up; 2: backed up successful",
531
+ "document": "Backup status.\n- 1: backing up.\n- 2: backup successful.",
511
532
  "example": "2",
512
533
  "member": "uint64",
513
534
  "name": "Status",
@@ -517,7 +538,7 @@
517
538
  },
518
539
  {
519
540
  "disabled": false,
520
- "document": "Backup method. 0: logical backup; 1: physical backup",
541
+ "document": "Backup method.\n- 0: logical backup.\n- 1: physical backup.\n- 3: snapshot backup.\n**Note:**\n- The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.\n- Physical backup is not supported when storage encryption is enabled for the instance.",
521
542
  "example": "0",
522
543
  "member": "uint64",
523
544
  "name": "BackupMethod",
@@ -547,13 +568,23 @@
547
568
  },
548
569
  {
549
570
  "disabled": false,
550
- "document": "Region for cross-region backup.",
571
+ "document": "Cross-region backup region.",
551
572
  "example": "ap-guangzhou",
552
573
  "member": "string",
553
574
  "name": "BackupRegion",
554
575
  "output_required": false,
555
576
  "type": "string",
556
577
  "value_allowed_null": false
578
+ },
579
+ {
580
+ "disabled": false,
581
+ "document": "Rollback time supported by the backup.",
582
+ "example": "2021-12-13 03:02:51",
583
+ "member": "string",
584
+ "name": "RestoreTime",
585
+ "output_required": false,
586
+ "type": "string",
587
+ "value_allowed_null": false
557
588
  }
558
589
  ],
559
590
  "usage": "out"
@@ -563,31 +594,31 @@
563
594
  "members": [
564
595
  {
565
596
  "disabled": false,
566
- "document": "Client IP of a connection",
597
+ "document": "IP address of the connected client.",
567
598
  "example": "192.168.1.1",
568
599
  "member": "string",
569
600
  "name": "IP",
570
- "required": true,
601
+ "output_required": true,
571
602
  "type": "string",
572
603
  "value_allowed_null": false
573
604
  },
574
605
  {
575
606
  "disabled": false,
576
- "document": "Number of connections corresponding to a client IP",
607
+ "document": "Number of connections corresponding to the client IP address.",
577
608
  "example": "9",
578
609
  "member": "uint64",
579
610
  "name": "Count",
580
- "required": true,
611
+ "output_required": true,
581
612
  "type": "int",
582
613
  "value_allowed_null": false
583
614
  },
584
615
  {
585
616
  "disabled": false,
586
- "document": "Whether it is the Tencent Cloud IP for automated testing",
617
+ "document": "Whether it is an internal IP address.",
587
618
  "example": "true",
588
619
  "member": "bool",
589
620
  "name": "InternalService",
590
- "required": true,
621
+ "output_required": true,
591
622
  "type": "bool",
592
623
  "value_allowed_null": false
593
624
  }
@@ -608,7 +639,7 @@
608
639
  },
609
640
  {
610
641
  "disabled": false,
611
- "document": "Sets the backup method.\n - 0: logical backup.\n - 1: physical backup.",
642
+ "document": "Sets the backup method.\n- 0: logical backup.\n- 1: physical backup.\n- 3: snapshot backup.\n**Note**:\n1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.\n2. Physical backup is not supported when storage encryption is enabled for the instance.",
612
643
  "example": "0",
613
644
  "member": "int64",
614
645
  "name": "BackupMethod",
@@ -636,6 +667,7 @@
636
667
  "example": "4773",
637
668
  "member": "string",
638
669
  "name": "AsyncRequestId",
670
+ "output_required": true,
639
671
  "type": "string",
640
672
  "value_allowed_null": false
641
673
  },
@@ -653,7 +685,7 @@
653
685
  "members": [
654
686
  {
655
687
  "disabled": false,
656
- "document": "Instance ID in the format of \"cmgo-p8vnipr5\", which is the same as the instance ID displayed in the TencentDB console.",
688
+ "document": "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.",
657
689
  "example": "cmgo-f555zzzz",
658
690
  "member": "string",
659
691
  "name": "InstanceId",
@@ -662,7 +694,7 @@
662
694
  },
663
695
  {
664
696
  "disabled": false,
665
- "document": "The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.",
697
+ "document": "Name of the backup file to be downloaded. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain it.",
666
698
  "example": "cmgo-74sjf5mt_2021-03-24 15:40",
667
699
  "member": "string",
668
700
  "name": "BackupName",
@@ -671,7 +703,7 @@
671
703
  },
672
704
  {
673
705
  "disabled": false,
674
- "document": "Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded.\nSuppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of \"instance ID_0\".\nSuppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.",
706
+ "document": "Specifies the node ID of the replica set to be downloaded or the shard node ID list of the sharded cluster.\n- If the replica set instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0, full data can be downloaded.\n- If the sharded cluster instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1, download the data of Shard 0 and Shard 1. If a full download is needed for the sharded cluster, import all shard names as shown in the example.",
675
707
  "example": "无",
676
708
  "member": "ReplicaSetInfo",
677
709
  "name": "BackupSets",
@@ -686,11 +718,11 @@
686
718
  "members": [
687
719
  {
688
720
  "disabled": false,
689
- "document": "Download task status",
721
+ "document": "Status of the download task.",
690
722
  "example": "无",
691
723
  "member": "BackupDownloadTaskStatus",
692
724
  "name": "Tasks",
693
- "required": true,
725
+ "output_required": true,
694
726
  "type": "list",
695
727
  "value_allowed_null": false
696
728
  },
@@ -744,7 +776,7 @@
744
776
  },
745
777
  {
746
778
  "disabled": false,
747
- "document": "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.\n - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.\n - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.",
779
+ "document": "Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions.\n- MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n- MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n- MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n- MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n- MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.\n- MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.",
748
780
  "example": "MONGO_44_WT",
749
781
  "member": "string",
750
782
  "name": "MongoVersion",
@@ -762,7 +794,7 @@
762
794
  },
763
795
  {
764
796
  "disabled": false,
765
- "document": "Number of instances. Value range: 1-10.",
797
+ "document": "Number of instances. The minimum value is 1, and the maximum value is 30.",
766
798
  "example": "1",
767
799
  "member": "uint64",
768
800
  "name": "GoodsNum",
@@ -789,7 +821,7 @@
789
821
  },
790
822
  {
791
823
  "disabled": false,
792
- "document": "VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.",
824
+ "document": "VPC ID.\n- Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID.\n- After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).",
793
825
  "example": "vpc-k515****",
794
826
  "member": "string",
795
827
  "name": "VpcId",
@@ -798,7 +830,7 @@
798
830
  },
799
831
  {
800
832
  "disabled": false,
801
- "document": "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.",
833
+ "document": "Subnet ID of the VPC.\n- A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID.\n- After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).",
802
834
  "example": "subnet-60dr****",
803
835
  "member": "string",
804
836
  "name": "SubnetId",
@@ -834,7 +866,7 @@
834
866
  },
835
867
  {
836
868
  "disabled": false,
837
- "document": "Instance type. 1: formal instance; 3: read-only instance; 4: disaster recovery instance; 5: cloned instance. Note: For a cloned instance, RestoreTime is required.",
869
+ "document": "Instance type.\n- 1: formal instance.\n- 3: read-only instance.\n- 4: disaster recovery instance.\n- 5. cloned instance. Note: For a cloned instance, RestoreTime is required.",
838
870
  "example": "1",
839
871
  "member": "int64",
840
872
  "name": "Clone",
@@ -843,7 +875,7 @@
843
875
  },
844
876
  {
845
877
  "disabled": false,
846
- "document": "Parent instance ID. It is required if the `Clone` is `3` or `4`, that is, read-only instance or disaster recovery instance",
878
+ "document": "Parent instance ID.\n- This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.\n- Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list.",
847
879
  "example": "cmgo-nh1o****",
848
880
  "member": "string",
849
881
  "name": "Father",
@@ -852,8 +884,8 @@
852
884
  },
853
885
  {
854
886
  "disabled": false,
855
- "document": "Security group ID.",
856
- "example": "sg-abc****",
887
+ "document": "Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance.",
888
+ "example": "[\"sg-1s3c****\"]",
857
889
  "member": "string",
858
890
  "name": "SecurityGroup",
859
891
  "required": false,
@@ -870,8 +902,8 @@
870
902
  },
871
903
  {
872
904
  "disabled": false,
873
- "document": "Instance name, which can contain up to 60 letters, digits, and symbols (_-).",
874
- "example": "testInstance",
905
+ "document": "Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently.\n- Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively.\n- Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7.\n- Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\\_node{R:12}\\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\\_node12\\_db, cmgo11\\_node13\\_db, cmgo12\\_node14\\_db, cmgo13\\_node15\\_db, and cmgo14\\_node16\\_db.",
906
+ "example": "testInstance_{R:3}",
875
907
  "member": "string",
876
908
  "name": "InstanceName",
877
909
  "required": false,
@@ -879,7 +911,7 @@
879
911
  },
880
912
  {
881
913
  "disabled": false,
882
- "document": "Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.\n - 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].\n - 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.\n - 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.\n",
914
+ "document": "Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances.\n- 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].\n- The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs.\n- 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.",
883
915
  "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]",
884
916
  "member": "string",
885
917
  "name": "AvailabilityZoneList",
@@ -888,7 +920,7 @@
888
920
  },
889
921
  {
890
922
  "disabled": false,
891
- "document": "Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase.\n",
923
+ "document": "Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase.",
892
924
  "example": "1",
893
925
  "member": "uint64",
894
926
  "name": "MongosCpu",
@@ -897,7 +929,7 @@
897
929
  },
898
930
  {
899
931
  "disabled": false,
900
- "document": "Mongos node memory size.\n - This parameter is required during sharded cluster instance purchase.\n - Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported.\n\n",
932
+ "document": "Mongos node memory size.\n- This parameter is required during sharded cluster instance purchase.\n- Unit: GB. 1-core 2 GB, 2-core 4 GB, 4-core 8 GB, 8-core 16 GB, and 16-core 32 GB are supported.",
901
933
  "example": "2",
902
934
  "member": "uint64",
903
935
  "name": "MongosMemory",
@@ -942,7 +974,7 @@
942
974
  },
943
975
  {
944
976
  "disabled": false,
945
- "document": "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.",
977
+ "document": "Parameter template ID.\n- A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database.\n- The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture.",
946
978
  "example": "tpl-0vswu****",
947
979
  "member": "string",
948
980
  "name": "ParamTemplateId",
@@ -1016,7 +1048,7 @@
1016
1048
  },
1017
1049
  {
1018
1050
  "disabled": false,
1019
- "document": "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.\n - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.\n - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.",
1051
+ "document": "Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions.\n- MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n- MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n- MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n- MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n- MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.\n- MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.",
1020
1052
  "example": "MONGO_44_WT",
1021
1053
  "member": "string",
1022
1054
  "name": "MongoVersion",
@@ -1025,7 +1057,7 @@
1025
1057
  },
1026
1058
  {
1027
1059
  "disabled": false,
1028
- "document": "Number of instances. Minimum value: 1. Maximum value: 10.",
1060
+ "document": "Number of instances. The minimum value is 1, and the maximum value is 30.",
1029
1061
  "example": "1",
1030
1062
  "member": "uint64",
1031
1063
  "name": "GoodsNum",
@@ -1043,7 +1075,7 @@
1043
1075
  },
1044
1076
  {
1045
1077
  "disabled": false,
1046
- "document": "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.\n",
1078
+ "document": "Specifies the purchase duration during the instance purchase, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.",
1047
1079
  "example": "1",
1048
1080
  "member": "uint64",
1049
1081
  "name": "Period",
@@ -1088,7 +1120,7 @@
1088
1120
  },
1089
1121
  {
1090
1122
  "disabled": false,
1091
- "document": "VPC ID. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to query the correct ID. Example value: vpc-pxyzim13.",
1123
+ "document": "VPC ID.\n- Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID.\n- After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).",
1092
1124
  "example": "vpc-0akb****",
1093
1125
  "member": "string",
1094
1126
  "name": "VpcId",
@@ -1097,7 +1129,7 @@
1097
1129
  },
1098
1130
  {
1099
1131
  "disabled": false,
1100
- "document": "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.",
1132
+ "document": "Subnet ID of the VPC.\n- A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID.\n- After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1).",
1101
1133
  "example": "subnet-fyrt****",
1102
1134
  "member": "string",
1103
1135
  "name": "SubnetId",
@@ -1142,7 +1174,7 @@
1142
1174
  },
1143
1175
  {
1144
1176
  "disabled": false,
1145
- "document": "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.",
1177
+ "document": "Instance type.\n- 1: formal instance.\n- 3: read-only instance.\n- 4: disaster recovery instance.\n- 5: cloned instance. Note: For a cloned instance, RestoreTime is required.",
1146
1178
  "example": "1",
1147
1179
  "member": "int64",
1148
1180
  "name": "Clone",
@@ -1151,7 +1183,7 @@
1151
1183
  },
1152
1184
  {
1153
1185
  "disabled": false,
1154
- "document": "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.",
1186
+ "document": "Parent instance ID.\n- This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance.\n- Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list.",
1155
1187
  "example": "cmgo-nh1o****",
1156
1188
  "member": "string",
1157
1189
  "name": "Father",
@@ -1160,8 +1192,8 @@
1160
1192
  },
1161
1193
  {
1162
1194
  "disabled": false,
1163
- "document": "Security group ID. ",
1164
- "example": "sg-di48****",
1195
+ "document": "Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance.",
1196
+ "example": "[\"sg-di48****\"]",
1165
1197
  "member": "string",
1166
1198
  "name": "SecurityGroup",
1167
1199
  "required": false,
@@ -1178,8 +1210,8 @@
1178
1210
  },
1179
1211
  {
1180
1212
  "disabled": false,
1181
- "document": "Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported. The length can be up to 60 characters.",
1182
- "example": "myInstance",
1213
+ "document": "Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently.\n- Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively.\n- Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7.\n- Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\\_node{R:12}\\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\\_node12\\_db, cmgo11\\_node13\\_db, cmgo12\\_node14\\_db, cmgo13\\_node15\\_db, and cmgo14\\_node16\\_db.",
1214
+ "example": "myInstance_{R:3}",
1183
1215
  "member": "string",
1184
1216
  "name": "InstanceName",
1185
1217
  "required": false,
@@ -1250,7 +1282,7 @@
1250
1282
  },
1251
1283
  {
1252
1284
  "disabled": false,
1253
- "document": "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.",
1285
+ "document": "Parameter template ID.\n- A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database.\n- The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture.",
1254
1286
  "example": "tpl-0vswu****",
1255
1287
  "member": "string",
1256
1288
  "name": "ParamTemplateId",
@@ -1323,7 +1355,7 @@
1323
1355
  "members": [
1324
1356
  {
1325
1357
  "disabled": false,
1326
- "document": "Unit price.",
1358
+ "document": "Unit price of the instance, in USD.",
1327
1359
  "example": "0.17",
1328
1360
  "member": "float",
1329
1361
  "name": "UnitPrice",
@@ -1334,7 +1366,7 @@
1334
1366
  },
1335
1367
  {
1336
1368
  "disabled": false,
1337
- "document": "Original price.",
1369
+ "document": "Original price of the instance, in USD.",
1338
1370
  "example": "210",
1339
1371
  "member": "float",
1340
1372
  "name": "OriginalPrice",
@@ -1345,7 +1377,7 @@
1345
1377
  },
1346
1378
  {
1347
1379
  "disabled": false,
1348
- "document": "Discount price.",
1380
+ "document": "Discount price of the instance, in USD.",
1349
1381
  "example": "198",
1350
1382
  "member": "float",
1351
1383
  "name": "DiscountPrice",
@@ -1362,7 +1394,7 @@
1362
1394
  "members": [
1363
1395
  {
1364
1396
  "disabled": false,
1365
- "document": "Async task ID, which is returned by APIs related to async tasks, such as `CreateBackupDBInstance`.",
1397
+ "document": "Specifies the ID of the asynchronous request to be queried. When an asynchronous process is involved in the API operation (such as [CreateBackupDBInstance](https://www.tencentcloud.comom/document/product/240/46599?from_cn_redirect=1)), the response value of AsyncRequestId is the ID to be filled in for this parameter.",
1366
1398
  "example": "4762",
1367
1399
  "member": "string",
1368
1400
  "name": "AsyncRequestId",
@@ -1385,6 +1417,26 @@
1385
1417
  "type": "string",
1386
1418
  "value_allowed_null": false
1387
1419
  },
1420
+ {
1421
+ "disabled": false,
1422
+ "document": "Task execution start time.",
1423
+ "example": "2022-05-30 15:00:00",
1424
+ "member": "string",
1425
+ "name": "StartTime",
1426
+ "output_required": false,
1427
+ "type": "string",
1428
+ "value_allowed_null": false
1429
+ },
1430
+ {
1431
+ "disabled": false,
1432
+ "document": "Task execution end time.",
1433
+ "example": "2022-05-30 15:01:00",
1434
+ "member": "string",
1435
+ "name": "EndTime",
1436
+ "output_required": false,
1437
+ "type": "string",
1438
+ "value_allowed_null": false
1439
+ },
1388
1440
  {
1389
1441
  "document": "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.",
1390
1442
  "member": "string",
@@ -1399,7 +1451,7 @@
1399
1451
  "members": [
1400
1452
  {
1401
1453
  "disabled": false,
1402
- "document": "Instance ID in the format of \"cmgo-p8vnipr5\", which is the same as the instance ID displayed in the TencentDB console",
1454
+ "document": "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.",
1403
1455
  "example": "cmgo-74sjf5mt",
1404
1456
  "member": "string",
1405
1457
  "name": "InstanceId",
@@ -1408,7 +1460,7 @@
1408
1460
  },
1409
1461
  {
1410
1462
  "disabled": false,
1411
- "document": "The name of a backup file with download tasks to be queried",
1463
+ "document": "Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name.",
1412
1464
  "example": "cmgo-74sjf5mt_2021-03-24 15:40",
1413
1465
  "member": "string",
1414
1466
  "name": "BackupName",
@@ -1417,7 +1469,7 @@
1417
1469
  },
1418
1470
  {
1419
1471
  "disabled": false,
1420
- "document": "The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.",
1472
+ "document": "Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default.",
1421
1473
  "example": "2021-01-02 15:04:05",
1422
1474
  "member": "string",
1423
1475
  "name": "StartTime",
@@ -1426,7 +1478,7 @@
1426
1478
  },
1427
1479
  {
1428
1480
  "disabled": false,
1429
- "document": "The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.",
1481
+ "document": "Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default.",
1430
1482
  "example": "2021-01-02 15:04:05",
1431
1483
  "member": "string",
1432
1484
  "name": "EndTime",
@@ -1435,7 +1487,7 @@
1435
1487
  },
1436
1488
  {
1437
1489
  "disabled": false,
1438
- "document": "The maximum number of results returned per page. Value range: 1-100. Default value: `20`.",
1490
+ "document": "Number of entries returned for this query. Value range: 1100. The default value is 20.",
1439
1491
  "example": "10",
1440
1492
  "member": "int64",
1441
1493
  "name": "Limit",
@@ -1444,7 +1496,7 @@
1444
1496
  },
1445
1497
  {
1446
1498
  "disabled": false,
1447
- "document": "Offset for pagination. Default value: `0`.",
1499
+ "document": "Specifies the number of pages returned for this query. The default value is 0.",
1448
1500
  "example": "0",
1449
1501
  "member": "int64",
1450
1502
  "name": "Offset",
@@ -1453,7 +1505,7 @@
1453
1505
  },
1454
1506
  {
1455
1507
  "disabled": false,
1456
- "document": "The field used to sort the results. Valid values: `createTime` (default), `finishTime`.",
1508
+ "document": "Sorting field.\n- createTime: sort by the creation time of the backup download task. The default value is createTime.\n- finishTime: sort by the completion time of the backup download task.",
1457
1509
  "example": "finishTime",
1458
1510
  "member": "string",
1459
1511
  "name": "OrderBy",
@@ -1462,7 +1514,7 @@
1462
1514
  },
1463
1515
  {
1464
1516
  "disabled": false,
1465
- "document": "Sort order. Valid values: `asc`, `desc` (default).",
1517
+ "document": "Sorting method.\n- asc: ascending order.\n- desc: descending order. The default value is desc.",
1466
1518
  "example": "desc",
1467
1519
  "member": "string",
1468
1520
  "name": "OrderByType",
@@ -1471,7 +1523,7 @@
1471
1523
  },
1472
1524
  {
1473
1525
  "disabled": false,
1474
- "document": "The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.",
1526
+ "document": "Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned.\n- 0: wait for execution.\n- 1: downloading.\n- 2: download completed.\n- 3: download failed.\n- 4: wait for retry.",
1475
1527
  "example": "[2]",
1476
1528
  "member": "int64",
1477
1529
  "name": "Status",
@@ -1486,21 +1538,21 @@
1486
1538
  "members": [
1487
1539
  {
1488
1540
  "disabled": false,
1489
- "document": "Total number of results",
1541
+ "document": "All entries that meet the query conditions.",
1490
1542
  "example": "12",
1491
1543
  "member": "int64",
1492
1544
  "name": "TotalCount",
1493
- "required": true,
1545
+ "output_required": true,
1494
1546
  "type": "int",
1495
1547
  "value_allowed_null": false
1496
1548
  },
1497
1549
  {
1498
1550
  "disabled": false,
1499
- "document": "The list of download tasks",
1551
+ "document": "Download task list.",
1500
1552
  "example": "无",
1501
1553
  "member": "BackupDownloadTask",
1502
1554
  "name": "Tasks",
1503
- "required": true,
1555
+ "output_required": true,
1504
1556
  "type": "list",
1505
1557
  "value_allowed_null": false
1506
1558
  },
@@ -1581,7 +1633,7 @@
1581
1633
  "members": [
1582
1634
  {
1583
1635
  "disabled": false,
1584
- "document": "Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page",
1636
+ "document": "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.",
1585
1637
  "example": "cmgo-f555zzzz",
1586
1638
  "member": "string",
1587
1639
  "name": "InstanceId",
@@ -1590,7 +1642,7 @@
1590
1642
  },
1591
1643
  {
1592
1644
  "disabled": false,
1593
- "document": "Backup mode. Valid values: `0` (logical backup), `1` (physical backup), `2` (both modes). Default value: `0`.",
1645
+ "document": "Backup method.\n- 0: logical backup.\n- 1: physical backup.\n- 3: snapshot backup.\n**Note**:\n1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently.\n2. Physical backup is not supported when storage encryption is enabled for the instance.",
1594
1646
  "example": "1",
1595
1647
  "member": "int64",
1596
1648
  "name": "BackupMethod",
@@ -1623,7 +1675,7 @@
1623
1675
  "members": [
1624
1676
  {
1625
1677
  "disabled": false,
1626
- "document": "Backup list",
1678
+ "document": "Backup list.",
1627
1679
  "example": "无",
1628
1680
  "member": "BackupInfo",
1629
1681
  "name": "BackupList",
@@ -1633,7 +1685,7 @@
1633
1685
  },
1634
1686
  {
1635
1687
  "disabled": false,
1636
- "document": "Total number of backups",
1688
+ "document": "Number of backups.",
1637
1689
  "example": "0",
1638
1690
  "member": "uint64",
1639
1691
  "name": "TotalCount",
@@ -1655,7 +1707,7 @@
1655
1707
  "members": [
1656
1708
  {
1657
1709
  "disabled": false,
1658
- "document": "Order ID. It is returned by the `CreateDBInstance` and other APIs.",
1710
+ "document": "Order ID.\n- Pay-as-you-go instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstanceHour](https://www.tencentcloud.comom/document/product/240/38570?from_cn_redirect=1) API.\n- Yearly/monthly subscription instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstance](https://www.tencentcloud.comom/document/product/240/38571?from_cn_redirect=1) API.",
1659
1711
  "example": "20200420111635",
1660
1712
  "member": "string",
1661
1713
  "name": "DealId",
@@ -1670,7 +1722,7 @@
1670
1722
  "members": [
1671
1723
  {
1672
1724
  "disabled": false,
1673
- "document": "Order status. Valid values: 1 (unpaid), 2 (paid), 3 (delivering), 4 (delivered), 5 (delivery failed), 6 (refunded), 7 (order closed), 8 (order closed because it failed to be paid within timeout period).",
1725
+ "document": "Order status.\n- 1: unpaid.\n- 2: paid.\n- 3: delivering.\n- 4: delivered successfully.\n- 5: delivery failed.\n- 6: refund.\n- 7: order closed.\n- 8: closed due to unpaid timeout.",
1674
1726
  "example": "4",
1675
1727
  "member": "int64",
1676
1728
  "name": "Status",
@@ -1680,7 +1732,7 @@
1680
1732
  },
1681
1733
  {
1682
1734
  "disabled": false,
1683
- "document": "Original price of the order.",
1735
+ "document": "Original price of the order, in USD.",
1684
1736
  "example": "1116.67",
1685
1737
  "member": "float",
1686
1738
  "name": "OriginalPrice",
@@ -1690,7 +1742,7 @@
1690
1742
  },
1691
1743
  {
1692
1744
  "disabled": false,
1693
- "document": "Discounted price of the order.",
1745
+ "document": "Discount price of the order, in USD.",
1694
1746
  "example": "759.33",
1695
1747
  "member": "float",
1696
1748
  "name": "DiscountPrice",
@@ -1700,7 +1752,7 @@
1700
1752
  },
1701
1753
  {
1702
1754
  "disabled": false,
1703
- "document": "Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.",
1755
+ "document": "Order operation behavior.\n- purchase: newly purchased.\n- renew: renewed.\n- upgrade: configuration upgraded.\n- downgrade: configuration downgraded.\n- refund: return and refund.",
1704
1756
  "example": "purchase",
1705
1757
  "member": "string",
1706
1758
  "name": "Action",
@@ -1710,7 +1762,7 @@
1710
1762
  },
1711
1763
  {
1712
1764
  "disabled": false,
1713
- "document": "Resource ID of the current order.",
1765
+ "document": "Instance ID of the current order.",
1714
1766
  "example": "cmgo-******",
1715
1767
  "member": "string",
1716
1768
  "name": "InstanceId",
@@ -1757,7 +1809,7 @@
1757
1809
  {
1758
1810
  "disabled": false,
1759
1811
  "document": "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.",
1760
- "example": "['db-a','db-b']",
1812
+ "example": "[\"db-a\",\"b-b\"]",
1761
1813
  "member": "string",
1762
1814
  "name": "Databases",
1763
1815
  "output_required": false,
@@ -1767,7 +1819,7 @@
1767
1819
  {
1768
1820
  "disabled": false,
1769
1821
  "document": "Queried collection information. If DbName is specified, a list of collections of only this database is returned.",
1770
- "example": "['col-1','col-2',]",
1822
+ "example": "[\"col-1\",\"col-2\"]",
1771
1823
  "member": "string",
1772
1824
  "name": "Collections",
1773
1825
  "output_required": false,
@@ -1788,8 +1840,8 @@
1788
1840
  "members": [
1789
1841
  {
1790
1842
  "disabled": false,
1791
- "document": "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.",
1792
- "example": "cmgo-hcscymcl",
1843
+ "document": "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.",
1844
+ "example": "[\"cmgo-hcscymcl\"]",
1793
1845
  "member": "string",
1794
1846
  "name": "InstanceIds",
1795
1847
  "required": false,
@@ -1797,7 +1849,7 @@
1797
1849
  },
1798
1850
  {
1799
1851
  "disabled": false,
1800
- "document": "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>",
1852
+ "document": "Specifies the instance type for querying. Valid values:\n- 0: all instances.\n- 1: formal instance.\n- 2: temporary instance.\n- 3: read-only instance.\n- -1: the query range includes the formal, read-only, and disaster recovery instances simultaneously.",
1801
1853
  "example": "0",
1802
1854
  "member": "int64",
1803
1855
  "name": "InstanceType",
@@ -1806,7 +1858,7 @@
1806
1858
  },
1807
1859
  {
1808
1860
  "disabled": false,
1809
- "document": "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>",
1861
+ "document": "Specifies the cluster type of the instance to be queried. Valid values:\n- 0: replica set instance.\n- 1: sharded cluster instance.\n- -1: replica set and sharded cluster instance.",
1810
1862
  "example": "0",
1811
1863
  "member": "int64",
1812
1864
  "name": "ClusterType",
@@ -1815,8 +1867,8 @@
1815
1867
  },
1816
1868
  {
1817
1869
  "disabled": false,
1818
- "document": "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>",
1819
- "example": "2",
1870
+ "document": "Specifies the current status of the instance to be queried. Valid values:\n- 0: to be initialized.\n- 1: processing, such as specification changes and parameter modifications.\n- 2: running normally.\n- -2: isolated (yearly/monthly subscription).\n- -3: isolated (pay-as-you-go).",
1871
+ "example": "[2]",
1820
1872
  "member": "int64",
1821
1873
  "name": "Status",
1822
1874
  "required": false,
@@ -1851,7 +1903,7 @@
1851
1903
  },
1852
1904
  {
1853
1905
  "disabled": false,
1854
- "document": "Number of results returned per request. Default value: `20`. Value range: [1,100].",
1906
+ "document": "Number of entries returned per request. The default value is 20, and the value range is (1, 100].",
1855
1907
  "example": "10",
1856
1908
  "member": "uint64",
1857
1909
  "name": "Limit",
@@ -1947,6 +1999,152 @@
1947
1999
  ],
1948
2000
  "type": "object"
1949
2001
  },
2002
+ "DescribeDetailedSlowLogsRequest": {
2003
+ "document": "DescribeDetailedSlowLogs request structure.",
2004
+ "members": [
2005
+ {
2006
+ "disabled": false,
2007
+ "document": "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.",
2008
+ "example": "cmgo-r3p8****",
2009
+ "member": "string",
2010
+ "name": "InstanceId",
2011
+ "required": true,
2012
+ "type": "string"
2013
+ },
2014
+ {
2015
+ "disabled": false,
2016
+ "document": "Specifies the start time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.",
2017
+ "example": "2025-01-02 13:14:15",
2018
+ "member": "string",
2019
+ "name": "StartTime",
2020
+ "required": true,
2021
+ "type": "string"
2022
+ },
2023
+ {
2024
+ "disabled": false,
2025
+ "document": "Specifies the end time for querying slow logs.\n- Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.\n- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.",
2026
+ "example": "2025-01-02 13:14:15",
2027
+ "member": "string",
2028
+ "name": "EndTime",
2029
+ "required": true,
2030
+ "type": "string"
2031
+ },
2032
+ {
2033
+ "disabled": false,
2034
+ "document": "Specifies the threshold for querying slow logs, in milliseconds. It indicates that the execution time of the slow log query exceeds this value. The default value is 100.",
2035
+ "example": "100",
2036
+ "member": "int64",
2037
+ "name": "ExecTime",
2038
+ "required": false,
2039
+ "type": "int"
2040
+ },
2041
+ {
2042
+ "disabled": false,
2043
+ "document": "Specifies the command type for querying slow logs.",
2044
+ "example": "[\"find\"]",
2045
+ "member": "string",
2046
+ "name": "Commands",
2047
+ "required": false,
2048
+ "type": "list"
2049
+ },
2050
+ {
2051
+ "disabled": false,
2052
+ "document": "Full-text search keyword. The logical operator among multiple keywords is OR.",
2053
+ "example": "[\"command\",\"primary\"]",
2054
+ "member": "string",
2055
+ "name": "Texts",
2056
+ "required": false,
2057
+ "type": "list"
2058
+ },
2059
+ {
2060
+ "disabled": false,
2061
+ "document": "Specifies the node name for querying slow logs. The [DescribeDBInstanceNodeProperty](https://www.tencentcloud.comom/document/product/240/82022?from_cn_redirect=1) API can be called to query the node name.",
2062
+ "example": "[\"cmgo-r3p8****_0-node-primary\"]",
2063
+ "member": "string",
2064
+ "name": "NodeNames",
2065
+ "required": false,
2066
+ "type": "list"
2067
+ },
2068
+ {
2069
+ "disabled": false,
2070
+ "document": "Specifies the queryHash value to be queried.",
2071
+ "example": "[\"admin..****Continue\"]",
2072
+ "member": "string",
2073
+ "name": "QueryHash",
2074
+ "required": false,
2075
+ "type": "list"
2076
+ },
2077
+ {
2078
+ "disabled": false,
2079
+ "document": "Pagination offset. The default value is 0, and the value range is [0, 100].\n",
2080
+ "example": "1",
2081
+ "member": "int64",
2082
+ "name": "Offset",
2083
+ "required": false,
2084
+ "type": "int"
2085
+ },
2086
+ {
2087
+ "disabled": false,
2088
+ "document": "Number of returned entries. The default value is 20, and the value range is [0, 10000].",
2089
+ "example": "10",
2090
+ "member": "int64",
2091
+ "name": "Limit",
2092
+ "required": false,
2093
+ "type": "int"
2094
+ },
2095
+ {
2096
+ "disabled": false,
2097
+ "document": "Specifies the sorting condition for slow logs.\n- StartTime: sort by the generation time of slow logs.\n- ExecTime: sort by the execution time of slow logs.",
2098
+ "example": "ExecTime",
2099
+ "member": "string",
2100
+ "name": "OrderBy",
2101
+ "required": false,
2102
+ "type": "string"
2103
+ },
2104
+ {
2105
+ "disabled": false,
2106
+ "document": "Specifies the sorting method.\n- desc: descending order.\n- asc: ascending order.",
2107
+ "example": "desc",
2108
+ "member": "string",
2109
+ "name": "OrderByType",
2110
+ "required": false,
2111
+ "type": "string"
2112
+ }
2113
+ ],
2114
+ "type": "object"
2115
+ },
2116
+ "DescribeDetailedSlowLogsResponse": {
2117
+ "document": "DescribeDetailedSlowLogs response structure.",
2118
+ "members": [
2119
+ {
2120
+ "disabled": false,
2121
+ "document": "Number of slow logs that meet the conditions.",
2122
+ "example": "100",
2123
+ "member": "int64",
2124
+ "name": "TotalCount",
2125
+ "output_required": false,
2126
+ "type": "int",
2127
+ "value_allowed_null": false
2128
+ },
2129
+ {
2130
+ "disabled": false,
2131
+ "document": "Slow log details.",
2132
+ "example": "无",
2133
+ "member": "SlowLogItem",
2134
+ "name": "DetailedSlowLogs",
2135
+ "output_required": false,
2136
+ "type": "list",
2137
+ "value_allowed_null": false
2138
+ },
2139
+ {
2140
+ "document": "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.",
2141
+ "member": "string",
2142
+ "name": "RequestId",
2143
+ "type": "string"
2144
+ }
2145
+ ],
2146
+ "type": "object"
2147
+ },
1950
2148
  "DescribeInstanceParamsRequest": {
1951
2149
  "document": "DescribeInstanceParams request structure.",
1952
2150
  "members": [
@@ -2029,8 +2227,8 @@
2029
2227
  "members": [
2030
2228
  {
2031
2229
  "disabled": false,
2032
- "document": "Instance ID. For example, cmgo-p8vn****.",
2033
- "example": "cmgo-p8vnipr5",
2230
+ "document": "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.",
2231
+ "example": "cmgo-p8vn****",
2034
2232
  "member": "string",
2035
2233
  "name": "InstanceId",
2036
2234
  "required": true,
@@ -2066,7 +2264,7 @@
2066
2264
  "members": [
2067
2265
  {
2068
2266
  "disabled": false,
2069
- "document": "Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page",
2267
+ "document": "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.",
2070
2268
  "example": "cmgo-a3bm93hf",
2071
2269
  "member": "string",
2072
2270
  "name": "InstanceId",
@@ -2075,7 +2273,7 @@
2075
2273
  },
2076
2274
  {
2077
2275
  "disabled": false,
2078
- "document": "Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.",
2276
+ "document": "Slow log start time.\n- Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00.\n- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.",
2079
2277
  "example": "2020-04-20 00:00:00",
2080
2278
  "member": "datetime",
2081
2279
  "name": "StartTime",
@@ -2084,7 +2282,7 @@
2084
2282
  },
2085
2283
  {
2086
2284
  "disabled": false,
2087
- "document": "End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.",
2285
+ "document": "Slow log end time.\n- Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.\n- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.",
2088
2286
  "example": "2020-04-20 22:00:00",
2089
2287
  "member": "datetime",
2090
2288
  "name": "EndTime",
@@ -2139,7 +2337,7 @@
2139
2337
  "example": "2",
2140
2338
  "member": "uint64",
2141
2339
  "name": "Count",
2142
- "required": true,
2340
+ "output_required": true,
2143
2341
  "type": "int",
2144
2342
  "value_allowed_null": false
2145
2343
  },
@@ -2149,7 +2347,7 @@
2149
2347
  "example": "无",
2150
2348
  "member": "SlowLogPattern",
2151
2349
  "name": "SlowLogPatterns",
2152
- "required": true,
2350
+ "output_required": true,
2153
2351
  "type": "list",
2154
2352
  "value_allowed_null": false
2155
2353
  },
@@ -2167,7 +2365,7 @@
2167
2365
  "members": [
2168
2366
  {
2169
2367
  "disabled": false,
2170
- "document": "Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page",
2368
+ "document": "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.",
2171
2369
  "example": "cmgo-a3bm93hf",
2172
2370
  "member": "string",
2173
2371
  "name": "InstanceId",
@@ -2176,7 +2374,7 @@
2176
2374
  },
2177
2375
  {
2178
2376
  "disabled": false,
2179
- "document": "Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.",
2377
+ "document": "Slow log start time.\n- Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00.\n- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.",
2180
2378
  "example": "2020-04-20 00:00:00",
2181
2379
  "member": "datetime",
2182
2380
  "name": "StartTime",
@@ -2185,7 +2383,7 @@
2185
2383
  },
2186
2384
  {
2187
2385
  "disabled": false,
2188
- "document": "End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.",
2386
+ "document": "Slow log end time.\n- Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried.",
2189
2387
  "example": "2020-04-20 22:00:00",
2190
2388
  "member": "datetime",
2191
2389
  "name": "EndTime",
@@ -2236,7 +2434,7 @@
2236
2434
  "members": [
2237
2435
  {
2238
2436
  "disabled": false,
2239
- "document": "Total number of slow logs",
2437
+ "document": "Total number of slow logs.",
2240
2438
  "example": "20",
2241
2439
  "member": "uint64",
2242
2440
  "name": "Count",
@@ -2247,7 +2445,7 @@
2247
2445
  {
2248
2446
  "disabled": false,
2249
2447
  "document": "Slow log details.",
2250
- "example": "[\"Mon Apr 20 13:55:21.623 I COMMAND [conn16903] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587362114, 1), signature: { hash: BinData(0, 259955995BDC7E0CA35C4276EB23341C03910A48), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587362108, 1), t: 1 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 5335ms\",\"Mon Apr 20 14:01:00.309 I COMMAND [conn1313] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587362457, 1), signature: { hash: BinData(0, DC2B16681C70845D7B6C8C6C97400D4DFB394CA0), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587362455, 1), t: 1 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 1264ms\",\"Mon Apr 20 14:20:15.283 I COMMAND [conn586] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587363613, 1), signature: { hash: BinData(0, 72D24884320C8A9A26AF8C4DD1127874085DFAE5), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587363603, 1), t: 1 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 426ms\",\"Mon Apr 20 10:25:45.487 I COMMAND [conn48] command local.system.replset command: replSetReconfig { replSetReconfig: { _id: \\\"cmgo-a3bm93hf_1\\\", version: 3, protocolVersion: 1, members: [ { _id: 1, host: \\\"100.93.44.85:7005\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 2, host: \\\"10.112.91.43:7009\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 3, host: \\\"10.53.61.24:7004\\\" } ], settings: { chainingAllowed: true, heartbeatIntervalMillis: 2000, heartbeatTimeoutSecs: 10, electionTimeoutMillis: 10000, catchUpTimeoutMillis: -1, catchUpTakeoverDelayMillis: 30000, getLastErrorDefaults: { wtimeout: 0, w: 1 }, replicaSetId: ObjectId('5e9d08160c269352426f9575') } }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 3, w: 2, W: 1 } }, Database: { acquireCount: { w: 1, W: 1 } }, oplog: { acquireCount: { w: 1 } } } protocol:op_query 423ms\",\"Mon Apr 20 10:25:34.934 I COMMAND [conn28] command local.system.replset command: replSetReconfig { replSetReconfig: { _id: \\\"cmgo-a3bm93hf_1\\\", version: 2, protocolVersion: 1, members: [ { _id: 1, host: \\\"100.93.44.85:7005\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 2, host: \\\"10.112.91.43:7009\\\" } ], settings: { chainingAllowed: true, heartbeatIntervalMillis: 2000, heartbeatTimeoutSecs: 10, electionTimeoutMillis: 10000, catchUpTimeoutMillis: -1, catchUpTakeoverDelayMillis: 30000, getLastErrorDefaults: { w: 1, wtimeout: 0 }, replicaSetId: ObjectId('5e9d08160c269352426f9575') } }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 3, w: 2, W: 1 } }, Database: { acquireCount: { w: 1, W: 1 } }, oplog: { acquireCount: { w: 1 } } } protocol:op_query 414ms\",\"Mon Apr 20 10:24:52.278 I COMMAND [conn30] command local.system.replset command: replSetReconfig { replSetReconfig: { _id: \\\"cmgo-a3bm93hf_0\\\", version: 2, protocolVersion: 1, members: [ { _id: 1, host: \\\"10.53.80.6:7011\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 2, host: \\\"100.93.44.26:7012\\\" } ], settings: { chainingAllowed: true, heartbeatIntervalMillis: 2000, heartbeatTimeoutSecs: 10, electionTimeoutMillis: 10000, catchUpTimeoutMillis: -1, catchUpTakeoverDelayMillis: 30000, getLastErrorDefaults: { w: 1, wtimeout: 0 }, replicaSetId: ObjectId('5e9d07ebf3f99b58c95a33fb') } }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 3, w: 2, W: 1 } }, Database: { acquireCount: { w: 1, W: 1 } }, oplog: { acquireCount: { w: 1 } } } protocol:op_query 406ms\",\"Mon Apr 20 10:25:02.675 I COMMAND [conn50] command local.system.replset command: replSetReconfig { replSetReconfig: { _id: \\\"cmgo-a3bm93hf_0\\\", version: 3, protocolVersion: 1, members: [ { _id: 1, host: \\\"10.53.80.6:7011\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 2, host: \\\"100.93.44.26:7012\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 3, host: \\\"9.34.46.139:7003\\\" } ], settings: { chainingAllowed: true, heartbeatIntervalMillis: 2000, heartbeatTimeoutSecs: 10, electionTimeoutMillis: 10000, catchUpTimeoutMillis: -1, catchUpTakeoverDelayMillis: 30000, getLastErrorDefaults: { w: 1, wtimeout: 0 }, replicaSetId: ObjectId('5e9d07ebf3f99b58c95a33fb') } }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 3, w: 2, W: 1 } }, Database: { acquireCount: { w: 1, W: 1 } }, oplog: { acquireCount: { w: 1 } } } protocol:op_query 373ms\",\"Mon Apr 20 18:35:15.103 I COMMAND [conn586] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587378913, 1), signature: { hash: BinData(0, A3C176F81B64A7473F88F3F40B84C59EC9E1E1AE), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587378912, 1), t: 2 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 248ms\",\"Mon Apr 20 10:27:38.171 I COMMAND [conn281] command admin.$cmd command: setFeatureCompatibilityVersion { setFeatureCompatibilityVersion: \\\"4.0\\\", $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 5, w: 4, R: 1 } }, Database: { acquireCount: { w: 2, W: 2 } }, Collection: { acquireCount: { w: 2 } }, Mutex: { acquireCount: { W: 1 } }, oplog: { acquireCount: { w: 2 } } } protocol:op_msg 212ms\",\"Mon Apr 20 10:26:27.924 I COMMAND [conn111] command local.system.replset command: replSetReconfig { replSetReconfig: { _id: \\\"cmgo-a3bm93hf_2\\\", version: 3, protocolVersion: 1, members: [ { _id: 1, host: \\\"10.112.90.165:7002\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 2, host: \\\"10.53.80.6:7012\\\", arbiterOnly: false, buildIndexes: true, hidden: false, priority: 1.0, slaveDelay: 0, votes: 1 }, { _id: 3, host: \\\"100.93.44.26:7013\\\" } ], settings: { chainingAllowed: true, heartbeatIntervalMillis: 2000, heartbeatTimeoutSecs: 10, electionTimeoutMillis: 10000, catchUpTimeoutMillis: -1, catchUpTakeoverDelayMillis: 30000, getLastErrorDefaults: { w: 1, wtimeout: 0 }, replicaSetId: ObjectId('5e9d0841f0f688fc992fd087') } }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 3, w: 2, W: 1 } }, Database: { acquireCount: { w: 1, W: 1 } }, oplog: { acquireCount: { w: 1 } } } protocol:op_query 212ms\",\"Mon Apr 20 13:55:15.051 I COMMAND [conn586] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587362114, 1), signature: { hash: BinData(0, 259955995BDC7E0CA35C4276EB23341C03910A48), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587362085, 6), t: 1 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 192ms\",\"Mon Apr 20 10:27:39.400 I COMMAND [conn213] command admin.$cmd command: setFeatureCompatibilityVersion { setFeatureCompatibilityVersion: \\\"4.0\\\", $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 5, w: 4, R: 1 } }, Database: { acquireCount: { w: 2, W: 2 } }, Collection: { acquireCount: { w: 2 } }, Mutex: { acquireCount: { W: 1 } }, oplog: { acquireCount: { w: 2 } } } protocol:op_msg 183ms\",\"Mon Apr 20 10:26:09.357 I COMMAND [conn36] command local.system.replset command: replSetInitiate { replSetInitiate: { _id: \\\"cmgo-a3bm93hf_2\\\", version: 1, members: [ { _id: 1, host: \\\"10.112.90.165:7002\\\" } ] }, $readPreference: { mode: \\\"secondaryPreferred\\\" }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 23, w: 7, W: 2 }, acquireWaitCount: { W: 1 }, timeAcquiringMicros: { W: 59 } }, Database: { acquireCount: { r: 7, w: 4, W: 3 } }, Collection: { acquireCount: { r: 3, w: 2 } }, oplog: { acquireCount: { r: 2, w: 3 } } } protocol:op_query 134ms\",\"Mon Apr 20 13:00:16.363 I COMMAND [conn16903] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587358814, 1), signature: { hash: BinData(0, 90BD7BB9B481B9825527D89A3579B52E6C0C3915), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587358809, 2), t: 1 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 123ms\",\"Mon Apr 20 13:35:14.983 I COMMAND [conn586] command admin.$cmd command: _flushRoutingTableCacheUpdates { forceRoutingTableRefresh: \\\"config.system.sessions\\\", maxTimeMS: 30000, $clusterTime: { clusterTime: Timestamp(1587360912, 1), signature: { hash: BinData(0, 06A84575A66B9316D1ECBFB9FB1C7B2F605AB3A8), keyId: 6817613949303783443 } }, $configServerState: { opTime: { ts: Timestamp(1587360909, 5), t: 1 } }, $db: \\\"admin\\\" } numYields:0 reslen:288 locks:{ Global: { acquireCount: { r: 4 } }, Database: { acquireCount: { r: 2 } }, Collection: { acquireCount: { r: 2 } } } protocol:op_msg 122ms\",\"Mon Apr 20 10:24:43.760 I COMMAND [conn16] command local.system.replset command: replSetInitiate { replSetInitiate: { _id: \\\"cmgo-a3bm93hf_0\\\", version: 1, members: [ { _id: 1, host: \\\"10.53.80.6:7011\\\" } ] }, $readPreference: { mode: \\\"secondaryPreferred\\\" }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 23, w: 7, W: 2 }, acquireWaitCount: { W: 1 }, timeAcquiringMicros: { W: 39 } }, Database: { acquireCount: { r: 7, w: 4, W: 3 } }, Collection: { acquireCount: { r: 3, w: 2 } }, oplog: { acquireCount: { r: 2, w: 3 } } } protocol:op_query 112ms\",\"Mon Apr 20 10:25:26.300 I COMMAND [conn15] command local.system.replset command: replSetInitiate { replSetInitiate: { _id: \\\"cmgo-a3bm93hf_1\\\", version: 1, members: [ { _id: 1, host: \\\"100.93.44.85:7005\\\" } ] }, $readPreference: { mode: \\\"secondaryPreferred\\\" }, $db: \\\"admin\\\" } numYields:0 reslen:60 locks:{ Global: { acquireCount: { r: 23, w: 7, W: 2 }, acquireWaitCount: { W: 1 }, timeAcquiringMicros: { W: 24 } }, Database: { acquireCount: { r: 7, w: 4, W: 3 }, acquireWaitCount: { W: 1 }, timeAcquiringMicros: { W: 7 } }, Collection: { acquireCount: { r: 3, w: 2 } }, oplog: { acquireCount: { r: 2, w: 3 } } } protocol:op_query 110ms\",\"Mon Apr 20 10:27:39.400 I COMMAND [conn213] command admin.$cmd command: update { update: \\\"system.version\\\", writeConcern: { w: \\\"majority\\\" }, $db: \\\"admin\\\" } numYields:0 reslen:370 locks:{ Global: { acquireCount: { r: 5, w: 4, R: 1 } }, Database: { acquireCount: { w: 2, W: 2 } }, Collection: { acquireCount: { w: 2 } }, Mutex: { acquireCount: { W: 1 } }, oplog: { acquireCount: { w: 2 } } } protocol:op_msg 107ms\",\"Mon Apr 20 10:27:38.065 I COMMAND [conn281] command admin.$cmd command: update { update: \\\"system.version\\\", writeConcern: { w: \\\"majority\\\" }, $db: \\\"admin\\\" } numYields:0 reslen:370 locks:{ Global: { acquireCount: { r: 2, w: 2 } }, Database: { acquireCount: { w: 1, W: 1 } }, Collection: { acquireCount: { w: 1 } }, Mutex: { acquireCount: { W: 1 } }, oplog: { acquireCount: { w: 1 } } } protocol:op_msg 107ms\",\"Mon Apr 20 10:27:38.170 I COMMAND [conn281] command admin.$cmd command: update { update: \\\"system.version\\\", writeConcern: { w: \\\"majority\\\" }, $db: \\\"admin\\\" } numYields:0 reslen:370 locks:{ Global: { acquireCount: { r: 5, w: 4, R: 1 } }, Database: { acquireCount: { w: 2, W: 2 } }, Collection: { acquireCount: { w: 2 } }, Mutex: { acquireCount: { W: 1 } }, oplog: { acquireCount: { w: 2 } } } protocol:op_msg 105ms\"]",
2448
+ "example": "[\"Mon Apr 20 13:55:21.623 I COMMAND ********************\"]",
2251
2449
  "member": "string",
2252
2450
  "name": "SlowLogs",
2253
2451
  "output_required": true,
@@ -2268,7 +2466,7 @@
2268
2466
  "members": [
2269
2467
  {
2270
2468
  "disabled": false,
2271
- "document": "AZ to be queried",
2469
+ "document": "AZ to be queried. For currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).",
2272
2470
  "example": "ap-guangzhou-3",
2273
2471
  "member": "string",
2274
2472
  "name": "Zone",
@@ -2283,7 +2481,7 @@
2283
2481
  "members": [
2284
2482
  {
2285
2483
  "disabled": false,
2286
- "document": "List of purchasable instance specifications",
2484
+ "document": "List of sales specification information on the instance.",
2287
2485
  "example": "无",
2288
2486
  "member": "SpecificationInfo",
2289
2487
  "name": "SpecInfoList",
@@ -2332,7 +2530,7 @@
2332
2530
  "members": [
2333
2531
  {
2334
2532
  "disabled": false,
2335
- "document": "Instance region name in the format of ap-guangzhou-2.",
2533
+ "document": "Region and AZ information of the instance. For details, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).",
2336
2534
  "example": "ap-guangzhou-4",
2337
2535
  "member": "string",
2338
2536
  "name": "Zone",
@@ -2341,7 +2539,7 @@
2341
2539
  },
2342
2540
  {
2343
2541
  "disabled": false,
2344
- "document": " - 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.\n - 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.",
2542
+ "document": "-Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set.\n- Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard.",
2345
2543
  "example": "3",
2346
2544
  "member": "int64",
2347
2545
  "name": "NodeNum",
@@ -2368,8 +2566,8 @@
2368
2566
  },
2369
2567
  {
2370
2568
  "disabled": false,
2371
- "document": "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:\n - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.\n - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.",
2372
- "example": "MONGO_36_WT",
2569
+ "document": "Instance version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain specific supported versions. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported by instances. The corresponding relationship between version information and version number is as follows:\n- MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n- MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n- MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n- MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n- MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.\n- MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.",
2570
+ "example": "MONGO_50_WT",
2373
2571
  "member": "string",
2374
2572
  "name": "MongoVersion",
2375
2573
  "required": true,
@@ -2513,7 +2711,7 @@
2513
2711
  "members": [
2514
2712
  {
2515
2713
  "disabled": false,
2516
- "document": "Instance ID in the format of cmgo-p8vn****. It is the same as the instance ID displayed in the TencentDB console.",
2714
+ "document": "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.",
2517
2715
  "example": "cmgo-8oij5631",
2518
2716
  "member": "string",
2519
2717
  "name": "InstanceId",
@@ -2522,7 +2720,7 @@
2522
2720
  },
2523
2721
  {
2524
2722
  "disabled": false,
2525
- "document": "Instance memory size in GB after specification adjustment.",
2723
+ "document": "Instance memory size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the specific sales specifications for memory.",
2526
2724
  "example": "8",
2527
2725
  "member": "int64",
2528
2726
  "name": "Memory",
@@ -2531,7 +2729,7 @@
2531
2729
  },
2532
2730
  {
2533
2731
  "disabled": false,
2534
- "document": "Instance disk size in GB after specification adjustment.",
2732
+ "document": "Instance disk size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the maximum and minimum disk sizes corresponding to each CPU specification.",
2535
2733
  "example": "200",
2536
2734
  "member": "int64",
2537
2735
  "name": "Volume",
@@ -2540,7 +2738,7 @@
2540
2738
  },
2541
2739
  {
2542
2740
  "disabled": false,
2543
- "document": "Number of instance nodes. The number of nodes is left unchanged by default and cannot be changed currently.",
2741
+ "document": "Number of instance nodes. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the number of instance nodes.\n- Replica set instance, which refers to the number of primary and secondary nodes for the instance after configuration changes.\n- Sharded cluster instance, which refers to the number of primary and secondary nodes per shard for the instance after configuration changes.\n**Note**: Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously.",
2544
2742
  "example": "3",
2545
2743
  "member": "int64",
2546
2744
  "name": "NodeNum",
@@ -2549,7 +2747,7 @@
2549
2747
  },
2550
2748
  {
2551
2749
  "disabled": false,
2552
- "document": "Number of instance shards. The number of shards is left unchanged by default and cannot be changed currently.",
2750
+ "document": "Sharded cluster instance, which refers to the number of shards for the instance after configuration changes. Value range: [2, 36].\n**Note**: The number of shards after changes cannot be less than the current number. Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously.",
2553
2751
  "example": "2",
2554
2752
  "member": "int64",
2555
2753
  "name": "ReplicateSetNum",
@@ -2568,6 +2766,7 @@
2568
2766
  "example": "无",
2569
2767
  "member": "DBInstancePrice",
2570
2768
  "name": "Price",
2769
+ "output_required": true,
2571
2770
  "type": "object",
2572
2771
  "value_allowed_null": false
2573
2772
  },
@@ -2651,11 +2850,11 @@
2651
2850
  "usage": "in"
2652
2851
  },
2653
2852
  "InstanceDetail": {
2654
- "document": "Instance details",
2853
+ "document": "Instance details.",
2655
2854
  "members": [
2656
2855
  {
2657
2856
  "disabled": false,
2658
- "document": "Instance ID",
2857
+ "document": "Instance ID.",
2659
2858
  "example": "cmgo-7pje****",
2660
2859
  "member": "string",
2661
2860
  "name": "InstanceId",
@@ -2685,7 +2884,7 @@
2685
2884
  },
2686
2885
  {
2687
2886
  "disabled": false,
2688
- "document": "Project ID",
2887
+ "document": "Project ID.",
2689
2888
  "example": "1",
2690
2889
  "member": "uint64",
2691
2890
  "name": "ProjectId",
@@ -2695,7 +2894,7 @@
2695
2894
  },
2696
2895
  {
2697
2896
  "disabled": false,
2698
- "document": "Cluster type. Valid values: `0` (replica set instance), `1` (sharded instance).",
2897
+ "document": "Cluster type.\n- 0: replica set instance.\n- 1: sharded cluster instance.",
2699
2898
  "example": "1",
2700
2899
  "member": "uint64",
2701
2900
  "name": "ClusterType",
@@ -2725,7 +2924,7 @@
2725
2924
  },
2726
2925
  {
2727
2926
  "disabled": false,
2728
- "document": "Network type. Valid values: 0 (basic network), 1 (VPC)",
2927
+ "document": "Network type.\n- 0: basic network.\n- 1: VPC.",
2729
2928
  "example": "1",
2730
2929
  "member": "uint64",
2731
2930
  "name": "NetType",
@@ -2755,7 +2954,7 @@
2755
2954
  },
2756
2955
  {
2757
2956
  "disabled": false,
2758
- "document": "Instance status. Valid values: 0: creating; 1: processing; 2: running; -2: expired.",
2957
+ "document": "Instance status.\n- 0: to be initialized.\n- 1: processing, such as specification changes and parameter modifications.\n- 2: running normally.\n- -2: isolated (yearly/monthly subscription).\n- -3: isolated (pay-as-you-go).",
2759
2958
  "example": "2",
2760
2959
  "member": "int64",
2761
2960
  "name": "Status",
@@ -2805,7 +3004,7 @@
2805
3004
  },
2806
3005
  {
2807
3006
  "disabled": false,
2808
- "document": "Instance version information",
3007
+ "document": "Storage engine version information on instances.\n- MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.\n- MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n- MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n- MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n- MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n- MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.\n- MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.",
2809
3008
  "example": "MONGO_42_WT",
2810
3009
  "member": "string",
2811
3010
  "name": "MongoVersion",
@@ -2815,7 +3014,7 @@
2815
3014
  },
2816
3015
  {
2817
3016
  "disabled": false,
2818
- "document": "Instance memory size in MB",
3017
+ "document": "Instance memory specification, in MB.",
2819
3018
  "example": "4",
2820
3019
  "member": "uint64",
2821
3020
  "name": "Memory",
@@ -2825,7 +3024,7 @@
2825
3024
  },
2826
3025
  {
2827
3026
  "disabled": false,
2828
- "document": "Instance disk size in MB",
3027
+ "document": "Instance disk specification, in MB.",
2829
3028
  "example": "120",
2830
3029
  "member": "uint64",
2831
3030
  "name": "Volume",
@@ -2835,7 +3034,7 @@
2835
3034
  },
2836
3035
  {
2837
3036
  "disabled": false,
2838
- "document": "Number of CPU cores of an instance",
3037
+ "document": "Number of the instance CPU cores.",
2839
3038
  "example": "2",
2840
3039
  "member": "uint64",
2841
3040
  "name": "CpuNum",
@@ -2845,7 +3044,7 @@
2845
3044
  },
2846
3045
  {
2847
3046
  "disabled": false,
2848
- "document": "Instance machine type",
3047
+ "document": "Instance machine type.\n- HIO10G: general HIO 10GE type.\n- HCD: Cloud Disk Edition type.",
2849
3048
  "example": "HIO10G",
2850
3049
  "member": "string",
2851
3050
  "name": "MachineType",
@@ -2875,7 +3074,7 @@
2875
3074
  },
2876
3075
  {
2877
3076
  "disabled": false,
2878
- "document": "Instance auto-renewal flag. Valid values: `0` (manual renewal), `1` (auto-renewal), `2` (no renewal upon expiration)",
3077
+ "document": "Automatic renewal flag for the instance.\n- 0: manual renewal.\n- 1: automatic renewal.\n- 2: no renewal after confirmation.",
2879
3078
  "example": "0",
2880
3079
  "member": "int64",
2881
3080
  "name": "AutoRenewFlag",
@@ -2885,7 +3084,7 @@
2885
3084
  },
2886
3085
  {
2887
3086
  "disabled": false,
2888
- "document": "Used capacity in MB",
3087
+ "document": "Used capacity, in MB.",
2889
3088
  "example": "100",
2890
3089
  "member": "uint64",
2891
3090
  "name": "UsedVolume",
@@ -2995,7 +3194,7 @@
2995
3194
  },
2996
3195
  {
2997
3196
  "disabled": false,
2998
- "document": "Protocol information. Valid values: `1` (mongodb), `2` (dynamodb).",
3197
+ "document": "Protocol information: mongodb.",
2999
3198
  "example": "0",
3000
3199
  "member": "uint64",
3001
3200
  "name": "Protocol",
@@ -3005,7 +3204,7 @@
3005
3204
  },
3006
3205
  {
3007
3206
  "disabled": false,
3008
- "document": "Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)",
3207
+ "document": "Instance type.\n- 0: all instances.\n- 1: formal instance.\n- 2: temporary instance.\n- 3: read-only instance.\n- -1: include the formal, read-only, and disaster recovery instance simultaneously.",
3009
3208
  "example": "1",
3010
3209
  "member": "uint64",
3011
3210
  "name": "InstanceType",
@@ -3015,7 +3214,7 @@
3015
3214
  },
3016
3215
  {
3017
3216
  "disabled": false,
3018
- "document": "Instance status description",
3217
+ "document": "Instance status description.",
3019
3218
  "example": "运行中",
3020
3219
  "member": "string",
3021
3220
  "name": "InstanceStatusDesc",
@@ -3025,7 +3224,7 @@
3025
3224
  },
3026
3225
  {
3027
3226
  "disabled": false,
3028
- "document": "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",
3227
+ "document": "Physical instance ID corresponding to the instance. The instances that have been rolled back and replaced have different InstanceIds and RealInstanceIds, which need to be obtained through the physical ID in scenarios such as obtaining monitoring data from Barad.",
3029
3228
  "example": "cmgo-8go1o9xl",
3030
3229
  "member": "string",
3031
3230
  "name": "RealInstanceId",
@@ -3045,7 +3244,7 @@
3045
3244
  },
3046
3245
  {
3047
3246
  "disabled": false,
3048
- "document": "Mongos node memory.",
3247
+ "document": "Mongos node memory, in MB.",
3049
3248
  "example": "2",
3050
3249
  "member": "uint64",
3051
3250
  "name": "MongosMemory",
@@ -3075,7 +3274,7 @@
3075
3274
  },
3076
3275
  {
3077
3276
  "disabled": false,
3078
- "document": "ConfigServer node memory.",
3277
+ "document": "Config Server node memory, in MB.",
3079
3278
  "example": "2",
3080
3279
  "member": "uint64",
3081
3280
  "name": "ConfigServerMemory",
@@ -3085,7 +3284,7 @@
3085
3284
  },
3086
3285
  {
3087
3286
  "disabled": false,
3088
- "document": "ConfigServer node disk size.",
3287
+ "document": "Config Server node disk size, in MB.",
3089
3288
  "example": "20",
3090
3289
  "member": "uint64",
3091
3290
  "name": "ConfigServerVolume",
@@ -3485,7 +3684,7 @@
3485
3684
  "members": [
3486
3685
  {
3487
3686
  "disabled": false,
3488
- "document": "Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page",
3687
+ "document": "Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the ID of the instance to be isolated from the instance list.",
3489
3688
  "example": "cmgo-f555zzzz",
3490
3689
  "member": "string",
3491
3690
  "name": "InstanceId",
@@ -3504,7 +3703,7 @@
3504
3703
  "example": "28920",
3505
3704
  "member": "string",
3506
3705
  "name": "AsyncRequestId",
3507
- "required": true,
3706
+ "output_required": true,
3508
3707
  "type": "string",
3509
3708
  "value_allowed_null": false
3510
3709
  },
@@ -3540,7 +3739,7 @@
3540
3739
  },
3541
3740
  {
3542
3741
  "disabled": false,
3543
- "document": "VPC ID after the switch. If the instance is using a basic network, this field is not required.",
3742
+ "document": "VPC ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the VPC ID.",
3544
3743
  "example": "vpc-****",
3545
3744
  "member": "string",
3546
3745
  "name": "NewUniqVpcId",
@@ -3549,7 +3748,7 @@
3549
3748
  },
3550
3749
  {
3551
3750
  "disabled": false,
3552
- "document": "VPC subnet ID after the switch. If the instance is using a basic network, this field is not required.",
3751
+ "document": "VPC subnet ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the subnet ID of the VPC.",
3553
3752
  "example": "subnet-****",
3554
3753
  "member": "string",
3555
3754
  "name": "NewUniqSubnetId",
@@ -3595,7 +3794,7 @@
3595
3794
  "members": [
3596
3795
  {
3597
3796
  "disabled": false,
3598
- "document": "Instance ID. For example, cmgo-7pje****.",
3797
+ "document": "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.",
3599
3798
  "example": "cmgo-7pjedvz7",
3600
3799
  "member": "string",
3601
3800
  "name": "InstanceId",
@@ -3604,7 +3803,7 @@
3604
3803
  },
3605
3804
  {
3606
3805
  "disabled": false,
3607
- "document": "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.",
3806
+ "document": "Target security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) page to copy the target security group ID.\n**Note**: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections.",
3608
3807
  "example": "[\"sg-a\", \"sg-b\"]",
3609
3808
  "member": "string",
3610
3809
  "name": "SecurityGroupIds",
@@ -3631,8 +3830,8 @@
3631
3830
  "members": [
3632
3831
  {
3633
3832
  "disabled": false,
3634
- "document": "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.\n",
3635
- "example": "cmgo-p8vnipr5",
3833
+ "document": "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.",
3834
+ "example": "cmgo-p8vn****",
3636
3835
  "member": "string",
3637
3836
  "name": "InstanceId",
3638
3837
  "required": true,
@@ -3640,7 +3839,7 @@
3640
3839
  },
3641
3840
  {
3642
3841
  "disabled": false,
3643
- "document": "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.",
3842
+ "document": "Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).\n**Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time.",
3644
3843
  "example": "4",
3645
3844
  "member": "uint64",
3646
3845
  "name": "Memory",
@@ -3649,7 +3848,7 @@
3649
3848
  },
3650
3849
  {
3651
3850
  "disabled": false,
3652
- "document": "Disk capacity after instance configuration modification. Unit: GB. The current instance disk capacity is used by default if this parameter is left blank.\n - 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.\n - During configuration downgrading, the disk capacity after modification should be greater than 1.2 times the used disk capacity.",
3851
+ "document": "Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).\n- 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.\n- During configuration downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity.",
3653
3852
  "example": "250",
3654
3853
  "member": "uint64",
3655
3854
  "name": "Volume",
@@ -3667,7 +3866,7 @@
3667
3866
  },
3668
3867
  {
3669
3868
  "disabled": false,
3670
- "document": "Number of Mongod nodes after instance modification (excluding read-only nodes).\n - 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).\n - 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).\n - 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.\n - 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.\n - 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.",
3869
+ "document": "Number of Mongod nodes after instance changes (excluding read-only nodes).\n- Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.\n- Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.\n**Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes).",
3671
3870
  "example": "3",
3672
3871
  "member": "uint64",
3673
3872
  "name": "NodeNum",
@@ -3676,7 +3875,7 @@
3676
3875
  },
3677
3876
  {
3678
3877
  "disabled": false,
3679
- "document": "Number of shards after instance modification.\n - 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.",
3878
+ "document": "Number of shards after instance changes.\n- The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API.\n- The number of instance shards can only be increased and cannot be decreased.",
3680
3879
  "example": "3",
3681
3880
  "member": "uint64",
3682
3881
  "name": "ReplicateSetNum",
@@ -3694,7 +3893,7 @@
3694
3893
  },
3695
3894
  {
3696
3895
  "disabled": false,
3697
- "document": "Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.",
3896
+ "document": "Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1).",
3698
3897
  "example": "2",
3699
3898
  "member": "string",
3700
3899
  "name": "MongosMemory",
@@ -3712,7 +3911,7 @@
3712
3911
  },
3713
3912
  {
3714
3913
  "disabled": false,
3715
- "document": "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.",
3914
+ "document": "Deletes the node list.\n**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.",
3716
3915
  "example": "无",
3717
3916
  "member": "RemoveNodeList",
3718
3917
  "name": "RemoveNodeList",
@@ -3773,7 +3972,7 @@
3773
3972
  "members": [
3774
3973
  {
3775
3974
  "disabled": false,
3776
- "document": "Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page",
3975
+ "document": "Instance ID. Log in to the [TencentDB for MongoDB console recycle bin](https://console.cloud.tencent.com/mongodb/recycle), and copy the ID of the instance to be eliminated from the instance list.",
3777
3976
  "example": "cmgo-f555zzzz",
3778
3977
  "member": "string",
3779
3978
  "name": "InstanceId",
@@ -3789,10 +3988,10 @@
3789
3988
  {
3790
3989
  "disabled": false,
3791
3990
  "document": "Async task request ID, which can be used to query the execution result of an async task.",
3792
- "example": "28920",
3991
+ "example": "\"28920\"",
3793
3992
  "member": "string",
3794
3993
  "name": "AsyncRequestId",
3795
- "required": true,
3994
+ "output_required": true,
3796
3995
  "type": "string",
3797
3996
  "value_allowed_null": false
3798
3997
  },
@@ -3806,7 +4005,7 @@
3806
4005
  "type": "object"
3807
4006
  },
3808
4007
  "RemoveNodeList": {
3809
- "document": "Node details of an instance to be modified.",
4008
+ "document": "Node details of the instance to be modified.",
3810
4009
  "members": [
3811
4010
  {
3812
4011
  "disabled": false,
@@ -3819,7 +4018,7 @@
3819
4018
  },
3820
4019
  {
3821
4020
  "disabled": false,
3822
- "document": "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.\n\n - 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**.\n - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk****_0-node-primary.",
4021
+ "document": "IDs of nodes to be deleted. For a sharded cluster instance, specify the names of nodes to be deleted on one shard. Nodes with the same names on other shards will also be deleted.\n- Obtaining method: Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), go to the **Node Management** tab, and obtain the **node ID**.\n- Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk\\*\\*\\*\\*\\_0-node-primary.",
3823
4022
  "example": "cmgo-3iecwbfx_0-node-readonly0",
3824
4023
  "member": "string",
3825
4024
  "name": "NodeName",
@@ -3828,7 +4027,7 @@
3828
4027
  },
3829
4028
  {
3830
4029
  "disabled": false,
3831
- "document": "AZs corresponding to the nodes.\n - Single AZ: All nodes are in the same AZ.\n - 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.",
4030
+ "document": "AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1).\n- Single AZ: all nodes are in the same AZ.\n- Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any 2 AZs should be larger than that in the third AZ.",
3832
4031
  "example": "ap-guangzhou-2",
3833
4032
  "member": "string",
3834
4033
  "name": "Zone",
@@ -3879,7 +4078,7 @@
3879
4078
  "members": [
3880
4079
  {
3881
4080
  "disabled": false,
3882
- "document": "Specifies the ID or IDs of one or multiple instances to be renewed.\n - 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.\n - The maximum number of instances for each renewal request is 100.",
4081
+ "document": "Specifies the ID or IDs of one or multiple instances to be renewed.\n- It can be obtained through the response parameter **InstanceId** of the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API.\n- The maximum number of instances for each renewal request is 100.",
3883
4082
  "example": "[\"cmgo-gzo0****\"]",
3884
4083
  "member": "string",
3885
4084
  "name": "InstanceIds",
@@ -3911,17 +4110,16 @@
3911
4110
  "type": "object"
3912
4111
  },
3913
4112
  "ReplicaSetInfo": {
3914
- "document": "Shard information",
4113
+ "document": "Shard information.",
3915
4114
  "members": [
3916
4115
  {
3917
4116
  "disabled": false,
3918
- "document": "Replica set ID",
4117
+ "document": "Replica set ID.",
3919
4118
  "example": "cmgo_ih8uido9_0",
3920
4119
  "member": "string",
3921
4120
  "name": "ReplicaSetId",
3922
4121
  "required": true,
3923
- "type": "string",
3924
- "value_allowed_null": false
4122
+ "type": "string"
3925
4123
  }
3926
4124
  ],
3927
4125
  "usage": "in"
@@ -3931,7 +4129,7 @@
3931
4129
  "members": [
3932
4130
  {
3933
4131
  "disabled": false,
3934
- "document": "Instance ID",
4132
+ "document": "Specifies the instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.",
3935
4133
  "example": "cmgo-7pjedvz7",
3936
4134
  "member": "string",
3937
4135
  "name": "InstanceId",
@@ -3940,7 +4138,7 @@
3940
4138
  },
3941
4139
  {
3942
4140
  "disabled": false,
3943
- "document": "Instance account name",
4141
+ "document": "Specifies the account name for which the password needs to be changed. The [DescribeAccountUsers](https://www.tencentcloud.comom/document/product/240/80800?from_cn_redirect=1) API can be called to obtain the account list and copy the account name for which the password needs to be changed.",
3944
4142
  "example": "rwuser",
3945
4143
  "member": "string",
3946
4144
  "name": "UserName",
@@ -3949,8 +4147,8 @@
3949
4147
  },
3950
4148
  {
3951
4149
  "disabled": false,
3952
- "document": "New password, which must contain at least eight characters",
3953
- "example": "111111",
4150
+ "document": "Specifies a new password for the account. Password complexity requirements:\n- It should contain 8–32 characters.\n- It should contain at least two types of the following: letters, digits, and special characters (!@#%^\\*()\\_).",
4151
+ "example": "test_123***",
3954
4152
  "member": "string",
3955
4153
  "name": "Password",
3956
4154
  "required": true,
@@ -3964,11 +4162,11 @@
3964
4162
  "members": [
3965
4163
  {
3966
4164
  "disabled": false,
3967
- "document": "Async request ID, which is used to query the running status of the process.",
4165
+ "document": "Task request ID.",
3968
4166
  "example": "4769",
3969
4167
  "member": "string",
3970
4168
  "name": "AsyncRequestId",
3971
- "required": true,
4169
+ "output_required": true,
3972
4170
  "type": "string",
3973
4171
  "value_allowed_null": false
3974
4172
  },
@@ -3986,71 +4184,71 @@
3986
4184
  "members": [
3987
4185
  {
3988
4186
  "disabled": false,
3989
- "document": "Project ID",
4187
+ "document": "Associated project ID.",
3990
4188
  "example": "0",
3991
4189
  "member": "int64",
3992
4190
  "name": "ProjectId",
3993
- "required": true,
4191
+ "output_required": true,
3994
4192
  "type": "int",
3995
4193
  "value_allowed_null": false
3996
4194
  },
3997
4195
  {
3998
4196
  "disabled": false,
3999
- "document": "Creation time",
4197
+ "document": "Security group creation time.",
4000
4198
  "example": "2021-01-02 15:04:05",
4001
4199
  "member": "string",
4002
4200
  "name": "CreateTime",
4003
- "required": true,
4201
+ "output_required": true,
4004
4202
  "type": "string",
4005
4203
  "value_allowed_null": false
4006
4204
  },
4007
4205
  {
4008
4206
  "disabled": false,
4009
- "document": "Inbound rule",
4207
+ "document": "Security group inbound rule.",
4010
4208
  "example": "无",
4011
4209
  "member": "SecurityGroupBound",
4012
4210
  "name": "Inbound",
4013
- "required": true,
4211
+ "output_required": true,
4014
4212
  "type": "list",
4015
4213
  "value_allowed_null": false
4016
4214
  },
4017
4215
  {
4018
4216
  "disabled": false,
4019
- "document": "Outbound rule",
4217
+ "document": "Security group outbound rule.",
4020
4218
  "example": "无",
4021
4219
  "member": "SecurityGroupBound",
4022
4220
  "name": "Outbound",
4023
- "required": true,
4221
+ "output_required": true,
4024
4222
  "type": "list",
4025
4223
  "value_allowed_null": false
4026
4224
  },
4027
4225
  {
4028
4226
  "disabled": false,
4029
- "document": "Security group ID",
4030
- "example": "sg-lxdvbitn",
4227
+ "document": "Security group ID.",
4228
+ "example": "sg-lxdv****",
4031
4229
  "member": "string",
4032
4230
  "name": "SecurityGroupId",
4033
- "required": true,
4231
+ "output_required": true,
4034
4232
  "type": "string",
4035
4233
  "value_allowed_null": false
4036
4234
  },
4037
4235
  {
4038
4236
  "disabled": false,
4039
- "document": "Security group name",
4040
- "example": "全放通",
4237
+ "document": "Security group name.",
4238
+ "example": "Security Test",
4041
4239
  "member": "string",
4042
4240
  "name": "SecurityGroupName",
4043
- "required": true,
4241
+ "output_required": true,
4044
4242
  "type": "string",
4045
4243
  "value_allowed_null": false
4046
4244
  },
4047
4245
  {
4048
4246
  "disabled": false,
4049
- "document": "Security group remarks",
4247
+ "document": "Security group remarks.",
4050
4248
  "example": "暴露全部端口到公网和内网,有一定安全风险",
4051
4249
  "member": "string",
4052
4250
  "name": "SecurityGroupRemark",
4053
- "required": true,
4251
+ "output_required": true,
4054
4252
  "type": "string",
4055
4253
  "value_allowed_null": false
4056
4254
  }
@@ -4062,7 +4260,7 @@
4062
4260
  "members": [
4063
4261
  {
4064
4262
  "disabled": false,
4065
- "document": "Execution rule. Valid values: `ACCEPT`, `DROP`",
4263
+ "document": "Execution policy.\n- ACCEPT: allow. Access requests for the port can be released.\n- DROP: reject. Data packets are discarded without any response.",
4066
4264
  "example": "ACCEPT",
4067
4265
  "member": "string",
4068
4266
  "name": "Action",
@@ -4072,7 +4270,7 @@
4072
4270
  },
4073
4271
  {
4074
4272
  "disabled": false,
4075
- "document": "IP range",
4273
+ "document": "Inbound IP address or IP range for database access.",
4076
4274
  "example": "0.0.0.0/0",
4077
4275
  "member": "string",
4078
4276
  "name": "CidrIp",
@@ -4082,7 +4280,7 @@
4082
4280
  },
4083
4281
  {
4084
4282
  "disabled": false,
4085
- "document": "Port range",
4283
+ "document": "Port for database access.",
4086
4284
  "example": "80,443",
4087
4285
  "member": "string",
4088
4286
  "name": "PortRange",
@@ -4092,7 +4290,7 @@
4092
4290
  },
4093
4291
  {
4094
4292
  "disabled": false,
4095
- "document": "Transport layer protocol. Valid values: `tcp`, `udp`, `ALL`",
4293
+ "document": "Transport layer protocol: TCP.",
4096
4294
  "example": "tcp",
4097
4295
  "member": "string",
4098
4296
  "name": "IpProtocol",
@@ -4102,8 +4300,8 @@
4102
4300
  },
4103
4301
  {
4104
4302
  "disabled": false,
4105
- "document": "All the addresses that the security group ID represents",
4106
- "example": "sg-",
4303
+ "document": "Security group ID.",
4304
+ "example": "sg-kayh****",
4107
4305
  "member": "string",
4108
4306
  "name": "Id",
4109
4307
  "output_required": true,
@@ -4112,8 +4310,8 @@
4112
4310
  },
4113
4311
  {
4114
4312
  "disabled": false,
4115
- "document": "All the addresses that the address group ID represents",
4116
- "example": "地址集合",
4313
+ "document": "Parameter template ID for the IP address or IP address group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/ip) to obtain the parameter template IP address details.",
4314
+ "example": "ipm-0h4k****",
4117
4315
  "member": "string",
4118
4316
  "name": "AddressModule",
4119
4317
  "output_required": true,
@@ -4122,8 +4320,8 @@
4122
4320
  },
4123
4321
  {
4124
4322
  "disabled": false,
4125
- "document": "All the protocols and ports that the service group ID represents",
4126
- "example": "协议和端口集合",
4323
+ "document": "Parameter template ID for the protocol port or protocol port group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/protoport) to obtain the parameter template protocol port details.",
4324
+ "example": "ppm-ay7b****",
4127
4325
  "member": "string",
4128
4326
  "name": "ServiceModule",
4129
4327
  "output_required": true,
@@ -4132,7 +4330,7 @@
4132
4330
  },
4133
4331
  {
4134
4332
  "disabled": false,
4135
- "document": "Description",
4333
+ "document": "Security group description information.",
4136
4334
  "example": "my-SecurityGroupBound",
4137
4335
  "member": "string",
4138
4336
  "name": "Desc",
@@ -4143,6 +4341,42 @@
4143
4341
  ],
4144
4342
  "usage": "out"
4145
4343
  },
4344
+ "SetDBInstanceDeletionProtectionRequest": {
4345
+ "document": "SetDBInstanceDeletionProtection request structure.",
4346
+ "members": [
4347
+ {
4348
+ "disabled": false,
4349
+ "document": "Instance ID list, in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page.",
4350
+ "example": "[\"cmgo-8oij****\"]",
4351
+ "member": "string",
4352
+ "name": "InstanceIds",
4353
+ "required": true,
4354
+ "type": "list"
4355
+ },
4356
+ {
4357
+ "disabled": false,
4358
+ "document": "Instance termination protection switch. Valid values: 0 - disabled; 1 - enabled.",
4359
+ "example": "1",
4360
+ "member": "uint64",
4361
+ "name": "EnableDeletionProtection",
4362
+ "required": true,
4363
+ "type": "int"
4364
+ }
4365
+ ],
4366
+ "type": "object"
4367
+ },
4368
+ "SetDBInstanceDeletionProtectionResponse": {
4369
+ "document": "SetDBInstanceDeletionProtection response structure.",
4370
+ "members": [
4371
+ {
4372
+ "document": "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.",
4373
+ "member": "string",
4374
+ "name": "RequestId",
4375
+ "type": "string"
4376
+ }
4377
+ ],
4378
+ "type": "object"
4379
+ },
4146
4380
  "ShardInfo": {
4147
4381
  "document": "Details of an instance shard",
4148
4382
  "members": [
@@ -4229,13 +4463,49 @@
4229
4463
  ],
4230
4464
  "usage": "out"
4231
4465
  },
4466
+ "SlowLogItem": {
4467
+ "document": "Slow log details.",
4468
+ "members": [
4469
+ {
4470
+ "disabled": false,
4471
+ "document": "Slow log details.",
4472
+ "example": "\"Mon Sep 22 20:30:19.980 I COMMAND [****] command admin.$cmd command: saslContinue { : 1, conversationId: 1, payload: BinData(0, ), $clusterTime: { clusterTime: Timestamp(1758544211, 1), **********\"",
4473
+ "member": "string",
4474
+ "name": "Log",
4475
+ "output_required": false,
4476
+ "type": "string",
4477
+ "value_allowed_null": false
4478
+ },
4479
+ {
4480
+ "disabled": false,
4481
+ "document": "Node name.",
4482
+ "example": "\"cmgo-r3p8hslf_0-node-primary\"",
4483
+ "member": "string",
4484
+ "name": "NodeName",
4485
+ "output_required": false,
4486
+ "type": "string",
4487
+ "value_allowed_null": false
4488
+ },
4489
+ {
4490
+ "disabled": false,
4491
+ "document": "Queries the hash value.",
4492
+ "example": "\"admin..*****Continue\"",
4493
+ "member": "string",
4494
+ "name": "QueryHash",
4495
+ "output_required": false,
4496
+ "type": "string",
4497
+ "value_allowed_null": false
4498
+ }
4499
+ ],
4500
+ "usage": "out"
4501
+ },
4232
4502
  "SlowLogPattern": {
4233
4503
  "document": "Slow log statistics of MongoDB database",
4234
4504
  "members": [
4235
4505
  {
4236
4506
  "disabled": false,
4237
- "document": "Slow log pattern",
4238
- "example": "2024-12-08T18:09:23.364+0800",
4507
+ "document": "Slow log output format: database name.table name.command.",
4508
+ "example": "admin.$cmd.command",
4239
4509
  "member": "string",
4240
4510
  "name": "Pattern",
4241
4511
  "output_required": true,
@@ -4244,7 +4514,17 @@
4244
4514
  },
4245
4515
  {
4246
4516
  "disabled": false,
4247
- "document": "Maximum execution time",
4517
+ "document": "queryHash value carried during slow log recording. It can be used to identify a query type.",
4518
+ "example": "83BAE67C",
4519
+ "member": "string",
4520
+ "name": "QueryHash",
4521
+ "output_required": false,
4522
+ "type": "string",
4523
+ "value_allowed_null": false
4524
+ },
4525
+ {
4526
+ "disabled": false,
4527
+ "document": "Maximum execution time, in milliseconds.",
4248
4528
  "example": "578",
4249
4529
  "member": "uint64",
4250
4530
  "name": "MaxTime",
@@ -4254,7 +4534,7 @@
4254
4534
  },
4255
4535
  {
4256
4536
  "disabled": false,
4257
- "document": "Average execution time",
4537
+ "document": "Average execution time, in milliseconds.",
4258
4538
  "example": "546",
4259
4539
  "member": "uint64",
4260
4540
  "name": "AverageTime",
@@ -4264,8 +4544,8 @@
4264
4544
  },
4265
4545
  {
4266
4546
  "disabled": false,
4267
- "document": "Number of slow logs in this pattern",
4268
- "example": "1",
4547
+ "document": "Number of slow logs.",
4548
+ "example": "8",
4269
4549
  "member": "uint64",
4270
4550
  "name": "Total",
4271
4551
  "output_required": true,
@@ -4276,11 +4556,11 @@
4276
4556
  "usage": "out"
4277
4557
  },
4278
4558
  "SpecItem": {
4279
- "document": "Specifications of purchasable MongoDB instances",
4559
+ "document": "TencentDB for MongoDB instance sales specification.",
4280
4560
  "members": [
4281
4561
  {
4282
4562
  "disabled": false,
4283
- "document": "Specification information identifier. Format: mongo.HIO10G.128G. It consists of three parts: node type, specification type, and memory specification.\n - Node types are as follows:\n - mongo: Mongod node.\n - mongos: Mongos node.\n - cfgstr: ConfigServer node.\n - Specification types are as follows:\n - HIO10G: general high-I/O 10GE type.\n - HCD: cloud disk type.\n - Memory specifications are as follows:\n - Valid values: 4, 8, 16, 32, 64, 128, 240, and 512.\n - Unit: g, indicating GB. 128g means 128 GB.",
4563
+ "document": "Specification information identifier. Format: mongo.HIO10G.128G. It consists of three parts: node type, specification type, and memory specification.\n- Node type: **mongo** indicates a Mongod node; **mongos** indicates a Mongos node; **cfgstr** indicates a ConfigServer node.\n- Specification type: **HIO10G** indicates the general HIO 10GE type; **HCD** indicates the Cloud Disk Edition type.\n- Memory specification, in GB. Valid values: 4, 8, 16, 32, 64, 128, 240, and 512. 128g indicates 128 GB.",
4284
4564
  "example": "mongo.HIO10G.128g",
4285
4565
  "member": "string",
4286
4566
  "name": "SpecCode",
@@ -4370,8 +4650,8 @@
4370
4650
  },
4371
4651
  {
4372
4652
  "disabled": false,
4373
- "document": "Storage engine version information on instances.\n - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine.\n - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.",
4374
- "example": "MONGO_36_WT",
4653
+ "document": "Storage engine version information on instances.\n- MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine.\n- MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine.\n- MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine.\n- MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine.\n- MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine.\n- MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine.",
4654
+ "example": "MONGO_50_WT",
4375
4655
  "member": "string",
4376
4656
  "name": "MongoVersionCode",
4377
4657
  "output_required": true,
@@ -4390,7 +4670,7 @@
4390
4670
  },
4391
4671
  {
4392
4672
  "disabled": false,
4393
- "document": "Instance version information. Valid values: 3.6, 4.2, 4.4, 5.0, and 6.0.\n",
4673
+ "document": "Instance version information. Valid values: 4.2, 4.4, 5.0, 6.0, and 7.0.",
4394
4674
  "example": "3.6",
4395
4675
  "member": "string",
4396
4676
  "name": "Version",
@@ -4492,11 +4772,11 @@
4492
4772
  "usage": "out"
4493
4773
  },
4494
4774
  "SpecificationInfo": {
4495
- "document": "Instance specification information",
4775
+ "document": "Instance specification information.",
4496
4776
  "members": [
4497
4777
  {
4498
4778
  "disabled": false,
4499
- "document": "Region information",
4779
+ "document": "Region information.",
4500
4780
  "example": "ap-guangzhou",
4501
4781
  "member": "string",
4502
4782
  "name": "Region",
@@ -4506,7 +4786,7 @@
4506
4786
  },
4507
4787
  {
4508
4788
  "disabled": false,
4509
- "document": "AZ information",
4789
+ "document": "AZ information.",
4510
4790
  "example": "ap-guangzhou-1",
4511
4791
  "member": "string",
4512
4792
  "name": "Zone",
@@ -4516,7 +4796,7 @@
4516
4796
  },
4517
4797
  {
4518
4798
  "disabled": false,
4519
- "document": "Purchasable specification information",
4799
+ "document": "Sales specification information.",
4520
4800
  "example": "无",
4521
4801
  "member": "SpecItem",
4522
4802
  "name": "SpecItems",
@@ -4526,7 +4806,7 @@
4526
4806
  },
4527
4807
  {
4528
4808
  "disabled": false,
4529
- "document": "Whether cross-AZ deployment is supported. Valid values: `1` (yes), `0` (no).",
4809
+ "document": "Whether cross-AZ deployment is supported.\n- 1: supported.\n- 0: not supported.",
4530
4810
  "example": "1",
4531
4811
  "member": "int64",
4532
4812
  "name": "SupportMultiAZ",
@@ -4564,6 +4844,33 @@
4564
4844
  }
4565
4845
  ],
4566
4846
  "usage": "both"
4847
+ },
4848
+ "TerminateDBInstancesRequest": {
4849
+ "document": "TerminateDBInstances request structure.",
4850
+ "members": [
4851
+ {
4852
+ "disabled": false,
4853
+ "document": "Specifies the ID of the pre-isolated instance. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list.",
4854
+ "example": "cmgo-7pje****",
4855
+ "member": "string",
4856
+ "name": "InstanceId",
4857
+ "required": true,
4858
+ "type": "string"
4859
+ }
4860
+ ],
4861
+ "type": "object"
4862
+ },
4863
+ "TerminateDBInstancesResponse": {
4864
+ "document": "TerminateDBInstances response structure.",
4865
+ "members": [
4866
+ {
4867
+ "document": "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.",
4868
+ "member": "string",
4869
+ "name": "RequestId",
4870
+ "type": "string"
4871
+ }
4872
+ ],
4873
+ "type": "object"
4567
4874
  }
4568
4875
  },
4569
4876
  "version": "1.0"