tccli-intl-en 3.0.1237.1__py2.py3-none-any.whl → 3.0.1282.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.
Files changed (214) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +17 -1
  3. tccli/services/advisor/advisor_client.py +8 -2
  4. tccli/services/aiart/aiart_client.py +4 -1
  5. tccli/services/ams/ams_client.py +16 -4
  6. tccli/services/antiddos/antiddos_client.py +280 -70
  7. tccli/services/apigateway/apigateway_client.py +372 -93
  8. tccli/services/apm/apm_client.py +52 -13
  9. tccli/services/asr/asr_client.py +8 -2
  10. tccli/services/autoscaling/autoscaling_client.py +232 -58
  11. tccli/services/autoscaling/v20180419/api.json +1 -1
  12. tccli/services/batch/batch_client.py +112 -28
  13. tccli/services/bi/bi_client.py +1242 -4
  14. tccli/services/bi/v20220105/api.json +5340 -107
  15. tccli/services/bi/v20220105/examples.json +196 -1
  16. tccli/services/billing/billing_client.py +168 -42
  17. tccli/services/cam/cam_client.py +324 -81
  18. tccli/services/captcha/captcha_client.py +4 -1
  19. tccli/services/car/car_client.py +132 -33
  20. tccli/services/cbs/cbs_client.py +152 -38
  21. tccli/services/ccc/ccc_client.py +732 -98
  22. tccli/services/ccc/v20200210/api.json +1727 -196
  23. tccli/services/ccc/v20200210/examples.json +64 -0
  24. tccli/services/cdb/cdb_client.py +532 -133
  25. tccli/services/cdc/cdc_client.py +80 -20
  26. tccli/services/cdc/v20201214/api.json +2 -2
  27. tccli/services/cdc/v20201214/examples.json +4 -4
  28. tccli/services/cdn/cdn_client.py +176 -44
  29. tccli/services/cdwdoris/cdwdoris_client.py +308 -77
  30. tccli/services/cdwpg/cdwpg_client.py +96 -24
  31. tccli/services/cdz/__init__.py +4 -0
  32. tccli/services/cdz/cdz_client.py +210 -0
  33. tccli/services/cdz/v20221123/api.json +233 -0
  34. tccli/services/cdz/v20221123/examples.json +12 -0
  35. tccli/services/cfg/cfg_client.py +64 -16
  36. tccli/services/cfs/cfs_client.py +156 -39
  37. tccli/services/cfw/cfw_client.py +264 -66
  38. tccli/services/chdfs/chdfs_client.py +116 -29
  39. tccli/services/ciam/ciam_client.py +64 -16
  40. tccli/services/ckafka/ckafka_client.py +575 -77
  41. tccli/services/ckafka/v20190819/api.json +2749 -1470
  42. tccli/services/ckafka/v20190819/examples.json +209 -155
  43. tccli/services/clb/clb_client.py +332 -83
  44. tccli/services/clb/v20180317/api.json +29 -14
  45. tccli/services/cloudaudit/cloudaudit_client.py +72 -18
  46. tccli/services/cls/cls_client.py +348 -87
  47. tccli/services/cmq/cmq_client.py +12 -801
  48. tccli/services/cmq/v20190304/api.json +173 -1367
  49. tccli/services/cmq/v20190304/examples.json +0 -120
  50. tccli/services/config/config_client.py +24 -6
  51. tccli/services/controlcenter/controlcenter_client.py +4 -1
  52. tccli/services/csip/csip_client.py +136 -34
  53. tccli/services/ctsdb/ctsdb_client.py +8 -2
  54. tccli/services/cvm/cvm_client.py +627 -110
  55. tccli/services/cvm/v20170312/api.json +750 -340
  56. tccli/services/cvm/v20170312/examples.json +105 -59
  57. tccli/services/cwp/cwp_client.py +1860 -465
  58. tccli/services/cynosdb/cynosdb_client.py +1749 -439
  59. tccli/services/cynosdb/v20190107/api.json +11763 -7697
  60. tccli/services/cynosdb/v20190107/examples.json +132 -4
  61. tccli/services/dataintegration/dataintegration_client.py +4 -1
  62. tccli/services/dayu/dayu_client.py +412 -103
  63. tccli/services/dbbrain/dbbrain_client.py +168 -42
  64. tccli/services/dc/dc_client.py +72 -18
  65. tccli/services/dcdb/dcdb_client.py +248 -62
  66. tccli/services/dlc/dlc_client.py +756 -111
  67. tccli/services/dlc/v20210125/api.json +637 -13
  68. tccli/services/dlc/v20210125/examples.json +48 -0
  69. tccli/services/dms/dms_client.py +8 -2
  70. tccli/services/dnspod/dnspod_client.py +353 -74
  71. tccli/services/dnspod/v20210323/api.json +196 -0
  72. tccli/services/dnspod/v20210323/examples.json +24 -0
  73. tccli/services/domain/domain_client.py +96 -24
  74. tccli/services/dts/dts_client.py +332 -83
  75. tccli/services/eb/eb_client.py +104 -26
  76. tccli/services/ecdn/ecdn_client.py +60 -15
  77. tccli/services/ecm/ecm_client.py +496 -124
  78. tccli/services/eiam/eiam_client.py +160 -40
  79. tccli/services/emr/emr_client.py +2784 -115
  80. tccli/services/emr/v20190103/api.json +14647 -4756
  81. tccli/services/emr/v20190103/examples.json +408 -40
  82. tccli/services/es/es_client.py +84 -21
  83. tccli/services/facefusion/facefusion_client.py +12 -3
  84. tccli/services/faceid/faceid_client.py +76 -19
  85. tccli/services/faceid/v20180301/api.json +79 -14
  86. tccli/services/faceid/v20180301/examples.json +3 -3
  87. tccli/services/gaap/gaap_client.py +352 -88
  88. tccli/services/gme/gme_client.py +40 -10
  89. tccli/services/gpm/gpm_client.py +72 -18
  90. tccli/services/gse/gse_client.py +88 -22
  91. tccli/services/gwlb/gwlb_client.py +72 -18
  92. tccli/services/iai/iai_client.py +116 -29
  93. tccli/services/iap/iap_client.py +24 -6
  94. tccli/services/ims/ims_client.py +4 -1
  95. tccli/services/intlpartnersmgt/intlpartnersmgt_client.py +168 -42
  96. tccli/services/intlpartnersmgt/v20220928/api.json +11 -11
  97. tccli/services/iotcloud/iotcloud_client.py +80 -20
  98. tccli/services/ip/ip_client.py +24 -6
  99. tccli/services/kms/kms_client.py +272 -68
  100. tccli/services/lcic/lcic_client.py +212 -53
  101. tccli/services/lighthouse/lighthouse_client.py +296 -74
  102. tccli/services/lighthouse/v20200324/api.json +14 -14
  103. tccli/services/lighthouse/v20200324/examples.json +5 -5
  104. tccli/services/live/live_client.py +480 -120
  105. tccli/services/lke/lke_client.py +360 -90
  106. tccli/services/lke/v20231130/api.json +182 -39
  107. tccli/services/lkeap/__init__.py +4 -0
  108. tccli/services/lkeap/lkeap_client.py +546 -0
  109. tccli/services/lkeap/v20240522/api.json +855 -0
  110. tccli/services/lkeap/v20240522/examples.json +72 -0
  111. tccli/services/mariadb/mariadb_client.py +200 -50
  112. tccli/services/mdc/mdc_client.py +72 -18
  113. tccli/services/mdl/mdl_client.py +132 -33
  114. tccli/services/mdl/v20200326/api.json +186 -12
  115. tccli/services/mdl/v20200326/examples.json +16 -16
  116. tccli/services/mdp/mdp_client.py +680 -70
  117. tccli/services/mdp/v20200527/api.json +748 -23
  118. tccli/services/mdp/v20200527/examples.json +143 -79
  119. tccli/services/message/__init__.py +4 -0
  120. tccli/services/message/message_client.py +210 -0
  121. tccli/services/message/v20181225/api.json +72 -0
  122. tccli/services/message/v20181225/examples.json +13 -0
  123. tccli/services/mongodb/mongodb_client.py +340 -29
  124. tccli/services/mongodb/v20190725/api.json +811 -226
  125. tccli/services/mongodb/v20190725/examples.json +54 -22
  126. tccli/services/monitor/monitor_client.py +864 -152
  127. tccli/services/monitor/v20180724/api.json +657 -8
  128. tccli/services/monitor/v20180724/examples.json +152 -4
  129. tccli/services/mps/mps_client.py +592 -92
  130. tccli/services/mps/v20190612/api.json +2931 -399
  131. tccli/services/mps/v20190612/examples.json +64 -14
  132. tccli/services/msp/msp_client.py +28 -7
  133. tccli/services/ocr/ocr_client.py +212 -45
  134. tccli/services/ocr/v20181119/api.json +872 -112
  135. tccli/services/ocr/v20181119/examples.json +12 -4
  136. tccli/services/omics/omics_client.py +80 -20
  137. tccli/services/organization/organization_client.py +464 -116
  138. tccli/services/postgres/postgres_client.py +364 -91
  139. tccli/services/postgres/v20170312/api.json +134 -109
  140. tccli/services/postgres/v20170312/examples.json +14 -14
  141. tccli/services/privatedns/privatedns_client.py +124 -31
  142. tccli/services/pts/pts_client.py +192 -48
  143. tccli/services/quota/__init__.py +4 -0
  144. tccli/services/quota/quota_client.py +434 -0
  145. tccli/services/quota/v20241204/api.json +548 -0
  146. tccli/services/quota/v20241204/examples.json +51 -0
  147. tccli/services/rce/rce_client.py +4 -1
  148. tccli/services/redis/redis_client.py +592 -106
  149. tccli/services/redis/v20180412/api.json +636 -240
  150. tccli/services/redis/v20180412/examples.json +98 -56
  151. tccli/services/region/region_client.py +12 -3
  152. tccli/services/rum/rum_client.py +240 -60
  153. tccli/services/scf/scf_client.py +168 -42
  154. tccli/services/ses/ses_client.py +116 -29
  155. tccli/services/sms/sms_client.py +72 -18
  156. tccli/services/sqlserver/sqlserver_client.py +3772 -387
  157. tccli/services/sqlserver/v20180328/api.json +9760 -3380
  158. tccli/services/sqlserver/v20180328/examples.json +478 -18
  159. tccli/services/ssl/ssl_client.py +152 -38
  160. tccli/services/ssm/ssm_client.py +96 -24
  161. tccli/services/sts/sts_client.py +20 -5
  162. tccli/services/tag/tag_client.py +120 -30
  163. tccli/services/tat/tat_client.py +76 -19
  164. tccli/services/tbaas/tbaas_client.py +16 -4
  165. tccli/services/tcaplusdb/tcaplusdb_client.py +208 -52
  166. tccli/services/tcaplusdb/v20190823/api.json +836 -760
  167. tccli/services/tcaplusdb/v20190823/examples.json +3 -3
  168. tccli/services/tchd/tchd_client.py +4 -1
  169. tccli/services/tcmpp/tcmpp_client.py +416 -104
  170. tccli/services/tcr/tcr_client.py +304 -76
  171. tccli/services/tcsas/tcsas_client.py +236 -59
  172. tccli/services/tcsas/v20250106/api.json +155 -79
  173. tccli/services/tcsas/v20250106/examples.json +3 -3
  174. tccli/services/tcss/tcss_client.py +1320 -330
  175. tccli/services/tdid/tdid_client.py +192 -48
  176. tccli/services/tdmq/tdmq_client.py +376 -94
  177. tccli/services/tem/tem_client.py +224 -56
  178. tccli/services/teo/teo_client.py +1127 -245
  179. tccli/services/teo/v20220901/api.json +382 -58
  180. tccli/services/teo/v20220901/examples.json +24 -0
  181. tccli/services/tione/__init__.py +4 -0
  182. tccli/services/tione/tione_client.py +210 -0
  183. tccli/services/tione/v20211111/api.json +3074 -0
  184. tccli/services/tione/v20211111/examples.json +12 -0
  185. tccli/services/tiw/tiw_client.py +204 -51
  186. tccli/services/tke/tke_client.py +552 -138
  187. tccli/services/tms/tms_client.py +4 -1
  188. tccli/services/tmt/tmt_client.py +4 -1
  189. tccli/services/trabbit/trabbit_client.py +116 -29
  190. tccli/services/trro/trro_client.py +76 -19
  191. tccli/services/trtc/trtc_client.py +420 -55
  192. tccli/services/trtc/v20190722/api.json +685 -23
  193. tccli/services/trtc/v20190722/examples.json +39 -7
  194. tccli/services/tts/tts_client.py +4 -1
  195. tccli/services/vclm/vclm_client.py +8 -2
  196. tccli/services/vm/vm_client.py +16 -4
  197. tccli/services/vod/v20180717/examples.json +1 -1
  198. tccli/services/vod/vod_client.py +716 -179
  199. tccli/services/vpc/v20170312/api.json +970 -75
  200. tccli/services/vpc/v20170312/examples.json +106 -10
  201. tccli/services/vpc/vpc_client.py +1876 -361
  202. tccli/services/waf/v20180125/api.json +1372 -194
  203. tccli/services/waf/v20180125/examples.json +89 -1
  204. tccli/services/waf/waf_client.py +1051 -147
  205. tccli/services/wedata/v20250806/api.json +13644 -0
  206. tccli/services/wedata/v20250806/examples.json +621 -0
  207. tccli/services/wedata/wedata_client.py +5830 -1026
  208. tccli/services/yunjing/yunjing_client.py +284 -71
  209. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/METADATA +4 -7
  210. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/RECORD +214 -192
  211. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/WHEEL +1 -1
  212. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/entry_points.txt +0 -1
  213. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/LICENSE +0 -0
  214. {tccli_intl_en-3.0.1237.1.dist-info → tccli_intl_en-3.0.1282.1.dist-info}/top_level.txt +0 -0
@@ -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",
@@ -77,6 +77,13 @@
77
77
  "output": "DescribeDBInstanceNamespaceResponse",
78
78
  "status": "online"
79
79
  },
80
+ "DescribeDBInstanceNodeProperty": {
81
+ "document": "This API is used to query node attributes, such as the AZ, node name, address, role, status, delay between primary and secondary nodes, priority, voting right, and tags.",
82
+ "input": "DescribeDBInstanceNodePropertyRequest",
83
+ "name": "Queries node attributes",
84
+ "output": "DescribeDBInstanceNodePropertyResponse",
85
+ "status": "online"
86
+ },
80
87
  "DescribeDBInstances": {
81
88
  "document": "This API is used to query the list of TencentDB for MongoDB instances. It supports filtering primary instances, disaster recovery instances, and read-only instances by project ID, instance ID, instance status, and other conditions.",
82
89
  "input": "DescribeDBInstancesRequest",
@@ -84,6 +91,13 @@
84
91
  "output": "DescribeDBInstancesResponse",
85
92
  "status": "online"
86
93
  },
94
+ "DescribeDetailedSlowLogs": {
95
+ "document": "This API is used to query slow log details of the instance.",
96
+ "input": "DescribeDetailedSlowLogsRequest",
97
+ "name": "Query instance slow log details",
98
+ "output": "DescribeDetailedSlowLogsResponse",
99
+ "status": "online"
100
+ },
87
101
  "DescribeInstanceParams": {
88
102
  "document": "This API is used to query the list of parameters that can be modified for the current instance.",
89
103
  "input": "DescribeInstanceParamsRequest",
@@ -113,7 +127,7 @@
113
127
  "status": "online"
114
128
  },
115
129
  "DescribeSpecInfo": {
116
- "document": "This API is used to query the purchasable instance specifications.",
130
+ "document": "This API is used to query the sales specification of an instance.",
117
131
  "input": "DescribeSpecInfoRequest",
118
132
  "name": "Queries the specifications of purchasable TencentDB instances",
119
133
  "output": "DescribeSpecInfoResponse",
@@ -148,7 +162,7 @@
148
162
  "status": "online"
149
163
  },
150
164
  "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.",
165
+ "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
166
  "input": "IsolateDBInstanceRequest",
153
167
  "name": "Isolates a TencentDB Instance",
154
168
  "output": "IsolateDBInstanceResponse",
@@ -169,7 +183,7 @@
169
183
  "status": "online"
170
184
  },
171
185
  "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.",
186
+ "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
187
  "input": "ModifyDBInstanceSpecRequest",
174
188
  "name": "Adjusts the configurations of a TencentDB instance",
175
189
  "output": "ModifyDBInstanceSpecResponse",
@@ -197,11 +211,25 @@
197
211
  "status": "online"
198
212
  },
199
213
  "ResetDBInstancePassword": {
200
- "document": "This API is used to modify instance password.",
214
+ "document": "This API is used to reset the instance access password.",
201
215
  "input": "ResetDBInstancePasswordRequest",
202
216
  "name": "Modifies instance password",
203
217
  "output": "ResetDBInstancePasswordResponse",
204
218
  "status": "online"
219
+ },
220
+ "SetDBInstanceDeletionProtection": {
221
+ "document": "This API is used to set instance termination protection.",
222
+ "input": "SetDBInstanceDeletionProtectionRequest",
223
+ "name": "Sets instance termination protection",
224
+ "output": "SetDBInstanceDeletionProtectionResponse",
225
+ "status": "online"
226
+ },
227
+ "TerminateDBInstances": {
228
+ "document": "This API is used to terminate monthly subscription billing instances.",
229
+ "input": "TerminateDBInstancesRequest",
230
+ "name": "Monthly subscription return and refund",
231
+ "output": "TerminateDBInstancesResponse",
232
+ "status": "online"
205
233
  }
206
234
  },
207
235
  "metadata": {
@@ -211,7 +239,7 @@
211
239
  },
212
240
  "objects": {
213
241
  "AddNodeList": {
214
- "document": "Node details of an instance to be modified.",
242
+ "document": "Node details of the instance to be modified.",
215
243
  "members": [
216
244
  {
217
245
  "disabled": false,
@@ -224,7 +252,7 @@
224
252
  },
225
253
  {
226
254
  "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.",
255
+ "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
256
  "example": "ap-guangzhou-2",
229
257
  "member": "string",
230
258
  "name": "Zone",
@@ -248,8 +276,8 @@
248
276
  },
249
277
  {
250
278
  "disabled": false,
251
- "document": "Unique ID of an existing project (instead of a new project).",
252
- "example": "1118****",
279
+ "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.",
280
+ "example": "12",
253
281
  "member": "uint64",
254
282
  "name": "ProjectId",
255
283
  "required": true,
@@ -263,8 +291,8 @@
263
291
  "members": [
264
292
  {
265
293
  "disabled": false,
266
- "document": "List of the returned async task IDs",
267
- "example": "[1081****]",
294
+ "document": "Lists async task ids returned.",
295
+ "example": "[1081,1082]",
268
296
  "member": "uint64",
269
297
  "name": "FlowIds",
270
298
  "output_required": true,
@@ -285,7 +313,7 @@
285
313
  "members": [
286
314
  {
287
315
  "disabled": false,
288
- "document": "Task creation time",
316
+ "document": "Task creation time.",
289
317
  "example": "2021-01-02 15:04:05",
290
318
  "member": "string",
291
319
  "name": "CreateTime",
@@ -295,7 +323,7 @@
295
323
  },
296
324
  {
297
325
  "disabled": false,
298
- "document": "Backup name",
326
+ "document": "Backup file name.",
299
327
  "example": "cmgo-74sj****_2021-03-24 15:40",
300
328
  "member": "string",
301
329
  "name": "BackupName",
@@ -305,7 +333,7 @@
305
333
  },
306
334
  {
307
335
  "disabled": false,
308
- "document": "Shard name",
336
+ "document": "Shard name.",
309
337
  "example": "cmgo-74sj****_0",
310
338
  "member": "string",
311
339
  "name": "ReplicaSetId",
@@ -315,7 +343,7 @@
315
343
  },
316
344
  {
317
345
  "disabled": false,
318
- "document": "Backup size in bytes",
346
+ "document": "Backup data size, in bytes.",
319
347
  "example": "102400",
320
348
  "member": "int64",
321
349
  "name": "BackupSize",
@@ -325,7 +353,7 @@
325
353
  },
326
354
  {
327
355
  "disabled": false,
328
- "document": "Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)",
356
+ "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
357
  "example": "0",
330
358
  "member": "int64",
331
359
  "name": "Status",
@@ -335,7 +363,7 @@
335
363
  },
336
364
  {
337
365
  "disabled": false,
338
- "document": "Task progress in percentage",
366
+ "document": "Task progress percentage.",
339
367
  "example": "20",
340
368
  "member": "int64",
341
369
  "name": "Percent",
@@ -345,7 +373,7 @@
345
373
  },
346
374
  {
347
375
  "disabled": false,
348
- "document": "Task duration in seconds",
376
+ "document": "Duration, in seconds.",
349
377
  "example": "60",
350
378
  "member": "int64",
351
379
  "name": "TimeSpend",
@@ -355,7 +383,7 @@
355
383
  },
356
384
  {
357
385
  "disabled": false,
358
- "document": "Backup download address",
386
+ "document": "Download link for backup data.",
359
387
  "example": "http://cmgo-****.b.c/d.tar?e",
360
388
  "member": "string",
361
389
  "name": "Url",
@@ -365,7 +393,7 @@
365
393
  },
366
394
  {
367
395
  "disabled": false,
368
- "document": "Backup type of the backup file. Valid values: `0` (logical backup), `1` (physical backup)",
396
+ "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
397
  "example": "1",
370
398
  "member": "int64",
371
399
  "name": "BackupMethod",
@@ -375,7 +403,7 @@
375
403
  },
376
404
  {
377
405
  "disabled": false,
378
- "document": "Specifies the remarks for backup.",
406
+ "document": "Specified remarks for initiating backup tasks.",
379
407
  "example": "我的备份",
380
408
  "member": "string",
381
409
  "name": "BackupDesc",
@@ -407,25 +435,25 @@
407
435
  "usage": "out"
408
436
  },
409
437
  "BackupDownloadTaskStatus": {
410
- "document": "The result of the created backup download task",
438
+ "document": "Result of creating a backup download task.",
411
439
  "members": [
412
440
  {
413
441
  "disabled": false,
414
- "document": "Shard name",
442
+ "document": "Shard name.",
415
443
  "example": "cmgo-74sjf5mt_0",
416
444
  "member": "string",
417
445
  "name": "ReplicaSetId",
418
- "required": true,
446
+ "output_required": true,
419
447
  "type": "string",
420
448
  "value_allowed_null": false
421
449
  },
422
450
  {
423
451
  "disabled": false,
424
- "document": "Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)",
452
+ "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
453
  "example": "0",
426
454
  "member": "int64",
427
455
  "name": "Status",
428
- "required": true,
456
+ "output_required": true,
429
457
  "type": "int",
430
458
  "value_allowed_null": false
431
459
  }
@@ -433,7 +461,7 @@
433
461
  "usage": "out"
434
462
  },
435
463
  "BackupInfo": {
436
- "document": "Backup information",
464
+ "document": "Backup information.",
437
465
  "members": [
438
466
  {
439
467
  "disabled": false,
@@ -447,7 +475,7 @@
447
475
  },
448
476
  {
449
477
  "disabled": false,
450
- "document": "Backup mode. 0: automatic backup; 1: manual backup",
478
+ "document": "Backup method.\n- 0: automatic backup.\n- 1: manual backup.",
451
479
  "example": "0",
452
480
  "member": "uint64",
453
481
  "name": "BackupType",
@@ -457,7 +485,7 @@
457
485
  },
458
486
  {
459
487
  "disabled": false,
460
- "document": "Backup name",
488
+ "document": "Backup file name.",
461
489
  "example": "cmgo-ca2n****_2021-12-13 02:02",
462
490
  "member": "string",
463
491
  "name": "BackupName",
@@ -467,7 +495,7 @@
467
495
  },
468
496
  {
469
497
  "disabled": false,
470
- "document": "Backup remarks.",
498
+ "document": "Backup task remarks.",
471
499
  "example": "系统后台每日定时自动备份",
472
500
  "member": "string",
473
501
  "name": "BackupDesc",
@@ -477,7 +505,7 @@
477
505
  },
478
506
  {
479
507
  "disabled": false,
480
- "document": "Backup file size. Unit: KB.",
508
+ "document": "Backup file size, in KB.",
481
509
  "example": "326594030",
482
510
  "member": "uint64",
483
511
  "name": "BackupSize",
@@ -507,7 +535,7 @@
507
535
  },
508
536
  {
509
537
  "disabled": false,
510
- "document": "Backup status. 1: backing up; 2: backed up successful",
538
+ "document": "Backup status.\n- 1: backing up.\n- 2: backup successful.",
511
539
  "example": "2",
512
540
  "member": "uint64",
513
541
  "name": "Status",
@@ -517,7 +545,7 @@
517
545
  },
518
546
  {
519
547
  "disabled": false,
520
- "document": "Backup method. 0: logical backup; 1: physical backup",
548
+ "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
549
  "example": "0",
522
550
  "member": "uint64",
523
551
  "name": "BackupMethod",
@@ -547,13 +575,23 @@
547
575
  },
548
576
  {
549
577
  "disabled": false,
550
- "document": "Region for cross-region backup.",
578
+ "document": "Cross-region backup region.",
551
579
  "example": "ap-guangzhou",
552
580
  "member": "string",
553
581
  "name": "BackupRegion",
554
582
  "output_required": false,
555
583
  "type": "string",
556
584
  "value_allowed_null": false
585
+ },
586
+ {
587
+ "disabled": false,
588
+ "document": "Rollback time supported by the backup.",
589
+ "example": "2021-12-13 03:02:51",
590
+ "member": "string",
591
+ "name": "RestoreTime",
592
+ "output_required": false,
593
+ "type": "string",
594
+ "value_allowed_null": false
557
595
  }
558
596
  ],
559
597
  "usage": "out"
@@ -563,31 +601,31 @@
563
601
  "members": [
564
602
  {
565
603
  "disabled": false,
566
- "document": "Client IP of a connection",
604
+ "document": "IP address of the connected client.",
567
605
  "example": "192.168.1.1",
568
606
  "member": "string",
569
607
  "name": "IP",
570
- "required": true,
608
+ "output_required": true,
571
609
  "type": "string",
572
610
  "value_allowed_null": false
573
611
  },
574
612
  {
575
613
  "disabled": false,
576
- "document": "Number of connections corresponding to a client IP",
614
+ "document": "Number of connections corresponding to the client IP address.",
577
615
  "example": "9",
578
616
  "member": "uint64",
579
617
  "name": "Count",
580
- "required": true,
618
+ "output_required": true,
581
619
  "type": "int",
582
620
  "value_allowed_null": false
583
621
  },
584
622
  {
585
623
  "disabled": false,
586
- "document": "Whether it is the Tencent Cloud IP for automated testing",
624
+ "document": "Whether it is an internal IP address.",
587
625
  "example": "true",
588
626
  "member": "bool",
589
627
  "name": "InternalService",
590
- "required": true,
628
+ "output_required": true,
591
629
  "type": "bool",
592
630
  "value_allowed_null": false
593
631
  }
@@ -608,7 +646,7 @@
608
646
  },
609
647
  {
610
648
  "disabled": false,
611
- "document": "Sets the backup method.\n - 0: logical backup.\n - 1: physical backup.",
649
+ "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
650
  "example": "0",
613
651
  "member": "int64",
614
652
  "name": "BackupMethod",
@@ -636,6 +674,7 @@
636
674
  "example": "4773",
637
675
  "member": "string",
638
676
  "name": "AsyncRequestId",
677
+ "output_required": true,
639
678
  "type": "string",
640
679
  "value_allowed_null": false
641
680
  },
@@ -653,7 +692,7 @@
653
692
  "members": [
654
693
  {
655
694
  "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.",
695
+ "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
696
  "example": "cmgo-f555zzzz",
658
697
  "member": "string",
659
698
  "name": "InstanceId",
@@ -662,7 +701,7 @@
662
701
  },
663
702
  {
664
703
  "disabled": false,
665
- "document": "The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.",
704
+ "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
705
  "example": "cmgo-74sjf5mt_2021-03-24 15:40",
667
706
  "member": "string",
668
707
  "name": "BackupName",
@@ -671,7 +710,7 @@
671
710
  },
672
711
  {
673
712
  "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.",
713
+ "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
714
  "example": "无",
676
715
  "member": "ReplicaSetInfo",
677
716
  "name": "BackupSets",
@@ -686,11 +725,11 @@
686
725
  "members": [
687
726
  {
688
727
  "disabled": false,
689
- "document": "Download task status",
728
+ "document": "Status of the download task.",
690
729
  "example": "无",
691
730
  "member": "BackupDownloadTaskStatus",
692
731
  "name": "Tasks",
693
- "required": true,
732
+ "output_required": true,
694
733
  "type": "list",
695
734
  "value_allowed_null": false
696
735
  },
@@ -744,7 +783,7 @@
744
783
  },
745
784
  {
746
785
  "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.",
786
+ "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
787
  "example": "MONGO_44_WT",
749
788
  "member": "string",
750
789
  "name": "MongoVersion",
@@ -762,7 +801,7 @@
762
801
  },
763
802
  {
764
803
  "disabled": false,
765
- "document": "Number of instances. Value range: 1-10.",
804
+ "document": "Number of instances. The minimum value is 1, and the maximum value is 30.",
766
805
  "example": "1",
767
806
  "member": "uint64",
768
807
  "name": "GoodsNum",
@@ -789,7 +828,7 @@
789
828
  },
790
829
  {
791
830
  "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.",
831
+ "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
832
  "example": "vpc-k515****",
794
833
  "member": "string",
795
834
  "name": "VpcId",
@@ -798,7 +837,7 @@
798
837
  },
799
838
  {
800
839
  "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.",
840
+ "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
841
  "example": "subnet-60dr****",
803
842
  "member": "string",
804
843
  "name": "SubnetId",
@@ -834,7 +873,7 @@
834
873
  },
835
874
  {
836
875
  "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.",
876
+ "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
877
  "example": "1",
839
878
  "member": "int64",
840
879
  "name": "Clone",
@@ -843,7 +882,7 @@
843
882
  },
844
883
  {
845
884
  "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",
885
+ "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
886
  "example": "cmgo-nh1o****",
848
887
  "member": "string",
849
888
  "name": "Father",
@@ -852,8 +891,8 @@
852
891
  },
853
892
  {
854
893
  "disabled": false,
855
- "document": "Security group ID.",
856
- "example": "sg-abc****",
894
+ "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.",
895
+ "example": "[\"sg-1s3c****\"]",
857
896
  "member": "string",
858
897
  "name": "SecurityGroup",
859
898
  "required": false,
@@ -870,8 +909,8 @@
870
909
  },
871
910
  {
872
911
  "disabled": false,
873
- "document": "Instance name, which can contain up to 60 letters, digits, and symbols (_-).",
874
- "example": "testInstance",
912
+ "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.",
913
+ "example": "testInstance_{R:3}",
875
914
  "member": "string",
876
915
  "name": "InstanceName",
877
916
  "required": false,
@@ -879,7 +918,7 @@
879
918
  },
880
919
  {
881
920
  "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",
921
+ "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
922
  "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]",
884
923
  "member": "string",
885
924
  "name": "AvailabilityZoneList",
@@ -888,7 +927,7 @@
888
927
  },
889
928
  {
890
929
  "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",
930
+ "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
931
  "example": "1",
893
932
  "member": "uint64",
894
933
  "name": "MongosCpu",
@@ -897,7 +936,7 @@
897
936
  },
898
937
  {
899
938
  "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",
939
+ "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
940
  "example": "2",
902
941
  "member": "uint64",
903
942
  "name": "MongosMemory",
@@ -942,7 +981,7 @@
942
981
  },
943
982
  {
944
983
  "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.",
984
+ "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
985
  "example": "tpl-0vswu****",
947
986
  "member": "string",
948
987
  "name": "ParamTemplateId",
@@ -1016,7 +1055,7 @@
1016
1055
  },
1017
1056
  {
1018
1057
  "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.",
1058
+ "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
1059
  "example": "MONGO_44_WT",
1021
1060
  "member": "string",
1022
1061
  "name": "MongoVersion",
@@ -1025,7 +1064,7 @@
1025
1064
  },
1026
1065
  {
1027
1066
  "disabled": false,
1028
- "document": "Number of instances. Minimum value: 1. Maximum value: 10.",
1067
+ "document": "Number of instances. The minimum value is 1, and the maximum value is 30.",
1029
1068
  "example": "1",
1030
1069
  "member": "uint64",
1031
1070
  "name": "GoodsNum",
@@ -1043,7 +1082,7 @@
1043
1082
  },
1044
1083
  {
1045
1084
  "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",
1085
+ "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
1086
  "example": "1",
1048
1087
  "member": "uint64",
1049
1088
  "name": "Period",
@@ -1088,7 +1127,7 @@
1088
1127
  },
1089
1128
  {
1090
1129
  "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.",
1130
+ "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
1131
  "example": "vpc-0akb****",
1093
1132
  "member": "string",
1094
1133
  "name": "VpcId",
@@ -1097,7 +1136,7 @@
1097
1136
  },
1098
1137
  {
1099
1138
  "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.",
1139
+ "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
1140
  "example": "subnet-fyrt****",
1102
1141
  "member": "string",
1103
1142
  "name": "SubnetId",
@@ -1142,7 +1181,7 @@
1142
1181
  },
1143
1182
  {
1144
1183
  "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.",
1184
+ "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
1185
  "example": "1",
1147
1186
  "member": "int64",
1148
1187
  "name": "Clone",
@@ -1151,7 +1190,7 @@
1151
1190
  },
1152
1191
  {
1153
1192
  "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.",
1193
+ "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
1194
  "example": "cmgo-nh1o****",
1156
1195
  "member": "string",
1157
1196
  "name": "Father",
@@ -1160,8 +1199,8 @@
1160
1199
  },
1161
1200
  {
1162
1201
  "disabled": false,
1163
- "document": "Security group ID. ",
1164
- "example": "sg-di48****",
1202
+ "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.",
1203
+ "example": "[\"sg-di48****\"]",
1165
1204
  "member": "string",
1166
1205
  "name": "SecurityGroup",
1167
1206
  "required": false,
@@ -1178,8 +1217,8 @@
1178
1217
  },
1179
1218
  {
1180
1219
  "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",
1220
+ "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.",
1221
+ "example": "myInstance_{R:3}",
1183
1222
  "member": "string",
1184
1223
  "name": "InstanceName",
1185
1224
  "required": false,
@@ -1250,7 +1289,7 @@
1250
1289
  },
1251
1290
  {
1252
1291
  "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.",
1292
+ "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
1293
  "example": "tpl-0vswu****",
1255
1294
  "member": "string",
1256
1295
  "name": "ParamTemplateId",
@@ -1323,7 +1362,7 @@
1323
1362
  "members": [
1324
1363
  {
1325
1364
  "disabled": false,
1326
- "document": "Unit price.",
1365
+ "document": "Unit price of the instance, in USD.",
1327
1366
  "example": "0.17",
1328
1367
  "member": "float",
1329
1368
  "name": "UnitPrice",
@@ -1334,7 +1373,7 @@
1334
1373
  },
1335
1374
  {
1336
1375
  "disabled": false,
1337
- "document": "Original price.",
1376
+ "document": "Original price of the instance, in USD.",
1338
1377
  "example": "210",
1339
1378
  "member": "float",
1340
1379
  "name": "OriginalPrice",
@@ -1345,7 +1384,7 @@
1345
1384
  },
1346
1385
  {
1347
1386
  "disabled": false,
1348
- "document": "Discount price.",
1387
+ "document": "Discount price of the instance, in USD.",
1349
1388
  "example": "198",
1350
1389
  "member": "float",
1351
1390
  "name": "DiscountPrice",
@@ -1362,7 +1401,7 @@
1362
1401
  "members": [
1363
1402
  {
1364
1403
  "disabled": false,
1365
- "document": "Async task ID, which is returned by APIs related to async tasks, such as `CreateBackupDBInstance`.",
1404
+ "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
1405
  "example": "4762",
1367
1406
  "member": "string",
1368
1407
  "name": "AsyncRequestId",
@@ -1385,6 +1424,26 @@
1385
1424
  "type": "string",
1386
1425
  "value_allowed_null": false
1387
1426
  },
1427
+ {
1428
+ "disabled": false,
1429
+ "document": "Task execution start time.",
1430
+ "example": "2022-05-30 15:00:00",
1431
+ "member": "string",
1432
+ "name": "StartTime",
1433
+ "output_required": false,
1434
+ "type": "string",
1435
+ "value_allowed_null": false
1436
+ },
1437
+ {
1438
+ "disabled": false,
1439
+ "document": "Task execution end time.",
1440
+ "example": "2022-05-30 15:01:00",
1441
+ "member": "string",
1442
+ "name": "EndTime",
1443
+ "output_required": false,
1444
+ "type": "string",
1445
+ "value_allowed_null": false
1446
+ },
1388
1447
  {
1389
1448
  "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
1449
  "member": "string",
@@ -1399,7 +1458,7 @@
1399
1458
  "members": [
1400
1459
  {
1401
1460
  "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",
1461
+ "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
1462
  "example": "cmgo-74sjf5mt",
1404
1463
  "member": "string",
1405
1464
  "name": "InstanceId",
@@ -1408,7 +1467,7 @@
1408
1467
  },
1409
1468
  {
1410
1469
  "disabled": false,
1411
- "document": "The name of a backup file with download tasks to be queried",
1470
+ "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
1471
  "example": "cmgo-74sjf5mt_2021-03-24 15:40",
1413
1472
  "member": "string",
1414
1473
  "name": "BackupName",
@@ -1417,7 +1476,7 @@
1417
1476
  },
1418
1477
  {
1419
1478
  "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.",
1479
+ "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
1480
  "example": "2021-01-02 15:04:05",
1422
1481
  "member": "string",
1423
1482
  "name": "StartTime",
@@ -1426,7 +1485,7 @@
1426
1485
  },
1427
1486
  {
1428
1487
  "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.",
1488
+ "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
1489
  "example": "2021-01-02 15:04:05",
1431
1490
  "member": "string",
1432
1491
  "name": "EndTime",
@@ -1435,7 +1494,7 @@
1435
1494
  },
1436
1495
  {
1437
1496
  "disabled": false,
1438
- "document": "The maximum number of results returned per page. Value range: 1-100. Default value: `20`.",
1497
+ "document": "Number of entries returned for this query. Value range: 1100. The default value is 20.",
1439
1498
  "example": "10",
1440
1499
  "member": "int64",
1441
1500
  "name": "Limit",
@@ -1444,7 +1503,7 @@
1444
1503
  },
1445
1504
  {
1446
1505
  "disabled": false,
1447
- "document": "Offset for pagination. Default value: `0`.",
1506
+ "document": "Specifies the number of pages returned for this query. The default value is 0.",
1448
1507
  "example": "0",
1449
1508
  "member": "int64",
1450
1509
  "name": "Offset",
@@ -1453,7 +1512,7 @@
1453
1512
  },
1454
1513
  {
1455
1514
  "disabled": false,
1456
- "document": "The field used to sort the results. Valid values: `createTime` (default), `finishTime`.",
1515
+ "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
1516
  "example": "finishTime",
1458
1517
  "member": "string",
1459
1518
  "name": "OrderBy",
@@ -1462,7 +1521,7 @@
1462
1521
  },
1463
1522
  {
1464
1523
  "disabled": false,
1465
- "document": "Sort order. Valid values: `asc`, `desc` (default).",
1524
+ "document": "Sorting method.\n- asc: ascending order.\n- desc: descending order. The default value is desc.",
1466
1525
  "example": "desc",
1467
1526
  "member": "string",
1468
1527
  "name": "OrderByType",
@@ -1471,7 +1530,7 @@
1471
1530
  },
1472
1531
  {
1473
1532
  "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.",
1533
+ "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
1534
  "example": "[2]",
1476
1535
  "member": "int64",
1477
1536
  "name": "Status",
@@ -1486,21 +1545,21 @@
1486
1545
  "members": [
1487
1546
  {
1488
1547
  "disabled": false,
1489
- "document": "Total number of results",
1548
+ "document": "All entries that meet the query conditions.",
1490
1549
  "example": "12",
1491
1550
  "member": "int64",
1492
1551
  "name": "TotalCount",
1493
- "required": true,
1552
+ "output_required": true,
1494
1553
  "type": "int",
1495
1554
  "value_allowed_null": false
1496
1555
  },
1497
1556
  {
1498
1557
  "disabled": false,
1499
- "document": "The list of download tasks",
1558
+ "document": "Download task list.",
1500
1559
  "example": "无",
1501
1560
  "member": "BackupDownloadTask",
1502
1561
  "name": "Tasks",
1503
- "required": true,
1562
+ "output_required": true,
1504
1563
  "type": "list",
1505
1564
  "value_allowed_null": false
1506
1565
  },
@@ -1581,7 +1640,7 @@
1581
1640
  "members": [
1582
1641
  {
1583
1642
  "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",
1643
+ "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
1644
  "example": "cmgo-f555zzzz",
1586
1645
  "member": "string",
1587
1646
  "name": "InstanceId",
@@ -1590,7 +1649,7 @@
1590
1649
  },
1591
1650
  {
1592
1651
  "disabled": false,
1593
- "document": "Backup mode. Valid values: `0` (logical backup), `1` (physical backup), `2` (both modes). Default value: `0`.",
1652
+ "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
1653
  "example": "1",
1595
1654
  "member": "int64",
1596
1655
  "name": "BackupMethod",
@@ -1623,7 +1682,7 @@
1623
1682
  "members": [
1624
1683
  {
1625
1684
  "disabled": false,
1626
- "document": "Backup list",
1685
+ "document": "Backup list.",
1627
1686
  "example": "无",
1628
1687
  "member": "BackupInfo",
1629
1688
  "name": "BackupList",
@@ -1633,7 +1692,7 @@
1633
1692
  },
1634
1693
  {
1635
1694
  "disabled": false,
1636
- "document": "Total number of backups",
1695
+ "document": "Number of backups.",
1637
1696
  "example": "0",
1638
1697
  "member": "uint64",
1639
1698
  "name": "TotalCount",
@@ -1655,7 +1714,7 @@
1655
1714
  "members": [
1656
1715
  {
1657
1716
  "disabled": false,
1658
- "document": "Order ID. It is returned by the `CreateDBInstance` and other APIs.",
1717
+ "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
1718
  "example": "20200420111635",
1660
1719
  "member": "string",
1661
1720
  "name": "DealId",
@@ -1670,7 +1729,7 @@
1670
1729
  "members": [
1671
1730
  {
1672
1731
  "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).",
1732
+ "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
1733
  "example": "4",
1675
1734
  "member": "int64",
1676
1735
  "name": "Status",
@@ -1680,7 +1739,7 @@
1680
1739
  },
1681
1740
  {
1682
1741
  "disabled": false,
1683
- "document": "Original price of the order.",
1742
+ "document": "Original price of the order, in USD.",
1684
1743
  "example": "1116.67",
1685
1744
  "member": "float",
1686
1745
  "name": "OriginalPrice",
@@ -1690,7 +1749,7 @@
1690
1749
  },
1691
1750
  {
1692
1751
  "disabled": false,
1693
- "document": "Discounted price of the order.",
1752
+ "document": "Discount price of the order, in USD.",
1694
1753
  "example": "759.33",
1695
1754
  "member": "float",
1696
1755
  "name": "DiscountPrice",
@@ -1700,7 +1759,7 @@
1700
1759
  },
1701
1760
  {
1702
1761
  "disabled": false,
1703
- "document": "Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.",
1762
+ "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
1763
  "example": "purchase",
1705
1764
  "member": "string",
1706
1765
  "name": "Action",
@@ -1710,7 +1769,7 @@
1710
1769
  },
1711
1770
  {
1712
1771
  "disabled": false,
1713
- "document": "Resource ID of the current order.",
1772
+ "document": "Instance ID of the current order.",
1714
1773
  "example": "cmgo-******",
1715
1774
  "member": "string",
1716
1775
  "name": "InstanceId",
@@ -1757,7 +1816,7 @@
1757
1816
  {
1758
1817
  "disabled": false,
1759
1818
  "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']",
1819
+ "example": "[\"db-a\",\"b-b\"]",
1761
1820
  "member": "string",
1762
1821
  "name": "Databases",
1763
1822
  "output_required": false,
@@ -1767,7 +1826,7 @@
1767
1826
  {
1768
1827
  "disabled": false,
1769
1828
  "document": "Queried collection information. If DbName is specified, a list of collections of only this database is returned.",
1770
- "example": "['col-1','col-2',]",
1829
+ "example": "[\"col-1\",\"col-2\"]",
1771
1830
  "member": "string",
1772
1831
  "name": "Collections",
1773
1832
  "output_required": false,
@@ -1783,13 +1842,114 @@
1783
1842
  ],
1784
1843
  "type": "object"
1785
1844
  },
1845
+ "DescribeDBInstanceNodePropertyRequest": {
1846
+ "document": "DescribeDBInstanceNodeProperty request structure.",
1847
+ "members": [
1848
+ {
1849
+ "disabled": false,
1850
+ "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.",
1851
+ "example": "cmgo-p8vnipr5",
1852
+ "member": "string",
1853
+ "name": "InstanceId",
1854
+ "required": true,
1855
+ "type": "string"
1856
+ },
1857
+ {
1858
+ "disabled": false,
1859
+ "document": "Node ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), go to Node Management, and copy the node ID.",
1860
+ "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]",
1861
+ "member": "string",
1862
+ "name": "NodeIds",
1863
+ "required": false,
1864
+ "type": "list"
1865
+ },
1866
+ {
1867
+ "disabled": false,
1868
+ "document": "Node role. Valid values:\n- PRIMARY: primary node.\n- SECONDARY: secondary node.\n- READONLY: read-only node.\n- ARBITER: arbitration node.",
1869
+ "example": "[\"PRIMARY\"]",
1870
+ "member": "string",
1871
+ "name": "Roles",
1872
+ "required": false,
1873
+ "type": "list"
1874
+ },
1875
+ {
1876
+ "disabled": false,
1877
+ "document": "Whether the node is a hidden node. Default value: false.",
1878
+ "example": "false",
1879
+ "member": "bool",
1880
+ "name": "OnlyHidden",
1881
+ "required": false,
1882
+ "type": "bool"
1883
+ },
1884
+ {
1885
+ "disabled": false,
1886
+ "document": "Priority of the node for electing it as the new primary node. Value range: [0, 100]. A larger value indicates a higher priority.",
1887
+ "example": "10",
1888
+ "member": "int64",
1889
+ "name": "Priority",
1890
+ "required": false,
1891
+ "type": "int"
1892
+ },
1893
+ {
1894
+ "disabled": false,
1895
+ "document": "Node voting right.- 1: The node has the right to vote.\n- 0: The node does not have the right to vote.",
1896
+ "example": "1",
1897
+ "member": "int64",
1898
+ "name": "Votes",
1899
+ "required": false,
1900
+ "type": "int"
1901
+ },
1902
+ {
1903
+ "disabled": false,
1904
+ "document": "Node tag.",
1905
+ "example": "无",
1906
+ "member": "NodeTag",
1907
+ "name": "Tags",
1908
+ "required": false,
1909
+ "type": "list"
1910
+ }
1911
+ ],
1912
+ "type": "object"
1913
+ },
1914
+ "DescribeDBInstanceNodePropertyResponse": {
1915
+ "document": "DescribeDBInstanceNodeProperty response structure.",
1916
+ "members": [
1917
+ {
1918
+ "disabled": false,
1919
+ "document": "Mongos node attributes.",
1920
+ "example": "无",
1921
+ "member": "NodeProperty",
1922
+ "name": "Mongos",
1923
+ "output_required": false,
1924
+ "type": "list",
1925
+ "value_allowed_null": false
1926
+ },
1927
+ {
1928
+ "disabled": false,
1929
+ "document": "Replica set node information.",
1930
+ "example": "无",
1931
+ "member": "ReplicateSetInfo",
1932
+ "name": "ReplicateSets",
1933
+ "output_required": true,
1934
+ "type": "list",
1935
+ "value_allowed_null": false
1936
+ },
1937
+ {
1938
+ "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.",
1939
+ "member": "string",
1940
+ "name": "RequestId",
1941
+ "type": "string"
1942
+ }
1943
+ ],
1944
+ "type": "object"
1945
+ },
1786
1946
  "DescribeDBInstancesRequest": {
1787
1947
  "document": "DescribeDBInstances request structure.",
1788
1948
  "members": [
1789
1949
  {
1790
1950
  "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",
1951
+ "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.",
1952
+ "example": "[\"cmgo-hcscymcl\"]",
1793
1953
  "member": "string",
1794
1954
  "name": "InstanceIds",
1795
1955
  "required": false,
@@ -1797,7 +1957,7 @@
1797
1957
  },
1798
1958
  {
1799
1959
  "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>",
1960
+ "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
1961
  "example": "0",
1802
1962
  "member": "int64",
1803
1963
  "name": "InstanceType",
@@ -1806,7 +1966,7 @@
1806
1966
  },
1807
1967
  {
1808
1968
  "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>",
1969
+ "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
1970
  "example": "0",
1811
1971
  "member": "int64",
1812
1972
  "name": "ClusterType",
@@ -1815,8 +1975,8 @@
1815
1975
  },
1816
1976
  {
1817
1977
  "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",
1978
+ "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).",
1979
+ "example": "[2]",
1820
1980
  "member": "int64",
1821
1981
  "name": "Status",
1822
1982
  "required": false,
@@ -1851,7 +2011,7 @@
1851
2011
  },
1852
2012
  {
1853
2013
  "disabled": false,
1854
- "document": "Number of results returned per request. Default value: `20`. Value range: [1,100].",
2014
+ "document": "Number of entries returned per request. The default value is 20, and the value range is (1, 100].",
1855
2015
  "example": "10",
1856
2016
  "member": "uint64",
1857
2017
  "name": "Limit",
@@ -1947,6 +2107,152 @@
1947
2107
  ],
1948
2108
  "type": "object"
1949
2109
  },
2110
+ "DescribeDetailedSlowLogsRequest": {
2111
+ "document": "DescribeDetailedSlowLogs request structure.",
2112
+ "members": [
2113
+ {
2114
+ "disabled": false,
2115
+ "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.",
2116
+ "example": "cmgo-r3p8****",
2117
+ "member": "string",
2118
+ "name": "InstanceId",
2119
+ "required": true,
2120
+ "type": "string"
2121
+ },
2122
+ {
2123
+ "disabled": false,
2124
+ "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.",
2125
+ "example": "2025-01-02 13:14:15",
2126
+ "member": "string",
2127
+ "name": "StartTime",
2128
+ "required": true,
2129
+ "type": "string"
2130
+ },
2131
+ {
2132
+ "disabled": false,
2133
+ "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.",
2134
+ "example": "2025-01-02 13:14:15",
2135
+ "member": "string",
2136
+ "name": "EndTime",
2137
+ "required": true,
2138
+ "type": "string"
2139
+ },
2140
+ {
2141
+ "disabled": false,
2142
+ "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.",
2143
+ "example": "100",
2144
+ "member": "int64",
2145
+ "name": "ExecTime",
2146
+ "required": false,
2147
+ "type": "int"
2148
+ },
2149
+ {
2150
+ "disabled": false,
2151
+ "document": "Specifies the command type for querying slow logs.",
2152
+ "example": "[\"find\"]",
2153
+ "member": "string",
2154
+ "name": "Commands",
2155
+ "required": false,
2156
+ "type": "list"
2157
+ },
2158
+ {
2159
+ "disabled": false,
2160
+ "document": "Full-text search keyword. The logical operator among multiple keywords is OR.",
2161
+ "example": "[\"command\",\"primary\"]",
2162
+ "member": "string",
2163
+ "name": "Texts",
2164
+ "required": false,
2165
+ "type": "list"
2166
+ },
2167
+ {
2168
+ "disabled": false,
2169
+ "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.",
2170
+ "example": "[\"cmgo-r3p8****_0-node-primary\"]",
2171
+ "member": "string",
2172
+ "name": "NodeNames",
2173
+ "required": false,
2174
+ "type": "list"
2175
+ },
2176
+ {
2177
+ "disabled": false,
2178
+ "document": "Specifies the queryHash value to be queried.",
2179
+ "example": "[\"admin..****Continue\"]",
2180
+ "member": "string",
2181
+ "name": "QueryHash",
2182
+ "required": false,
2183
+ "type": "list"
2184
+ },
2185
+ {
2186
+ "disabled": false,
2187
+ "document": "Pagination offset. The default value is 0, and the value range is [0, 100].\n",
2188
+ "example": "1",
2189
+ "member": "int64",
2190
+ "name": "Offset",
2191
+ "required": false,
2192
+ "type": "int"
2193
+ },
2194
+ {
2195
+ "disabled": false,
2196
+ "document": "Number of returned entries. The default value is 20, and the value range is [0, 10000].",
2197
+ "example": "10",
2198
+ "member": "int64",
2199
+ "name": "Limit",
2200
+ "required": false,
2201
+ "type": "int"
2202
+ },
2203
+ {
2204
+ "disabled": false,
2205
+ "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.",
2206
+ "example": "ExecTime",
2207
+ "member": "string",
2208
+ "name": "OrderBy",
2209
+ "required": false,
2210
+ "type": "string"
2211
+ },
2212
+ {
2213
+ "disabled": false,
2214
+ "document": "Specifies the sorting method.\n- desc: descending order.\n- asc: ascending order.",
2215
+ "example": "desc",
2216
+ "member": "string",
2217
+ "name": "OrderByType",
2218
+ "required": false,
2219
+ "type": "string"
2220
+ }
2221
+ ],
2222
+ "type": "object"
2223
+ },
2224
+ "DescribeDetailedSlowLogsResponse": {
2225
+ "document": "DescribeDetailedSlowLogs response structure.",
2226
+ "members": [
2227
+ {
2228
+ "disabled": false,
2229
+ "document": "Number of slow logs that meet the conditions.",
2230
+ "example": "100",
2231
+ "member": "int64",
2232
+ "name": "TotalCount",
2233
+ "output_required": false,
2234
+ "type": "int",
2235
+ "value_allowed_null": false
2236
+ },
2237
+ {
2238
+ "disabled": false,
2239
+ "document": "Slow log details.",
2240
+ "example": "无",
2241
+ "member": "SlowLogItem",
2242
+ "name": "DetailedSlowLogs",
2243
+ "output_required": false,
2244
+ "type": "list",
2245
+ "value_allowed_null": false
2246
+ },
2247
+ {
2248
+ "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.",
2249
+ "member": "string",
2250
+ "name": "RequestId",
2251
+ "type": "string"
2252
+ }
2253
+ ],
2254
+ "type": "object"
2255
+ },
1950
2256
  "DescribeInstanceParamsRequest": {
1951
2257
  "document": "DescribeInstanceParams request structure.",
1952
2258
  "members": [
@@ -2029,8 +2335,8 @@
2029
2335
  "members": [
2030
2336
  {
2031
2337
  "disabled": false,
2032
- "document": "Instance ID. For example, cmgo-p8vn****.",
2033
- "example": "cmgo-p8vnipr5",
2338
+ "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.",
2339
+ "example": "cmgo-p8vn****",
2034
2340
  "member": "string",
2035
2341
  "name": "InstanceId",
2036
2342
  "required": true,
@@ -2066,7 +2372,7 @@
2066
2372
  "members": [
2067
2373
  {
2068
2374
  "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",
2375
+ "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
2376
  "example": "cmgo-a3bm93hf",
2071
2377
  "member": "string",
2072
2378
  "name": "InstanceId",
@@ -2075,7 +2381,7 @@
2075
2381
  },
2076
2382
  {
2077
2383
  "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.",
2384
+ "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
2385
  "example": "2020-04-20 00:00:00",
2080
2386
  "member": "datetime",
2081
2387
  "name": "StartTime",
@@ -2084,7 +2390,7 @@
2084
2390
  },
2085
2391
  {
2086
2392
  "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.",
2393
+ "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
2394
  "example": "2020-04-20 22:00:00",
2089
2395
  "member": "datetime",
2090
2396
  "name": "EndTime",
@@ -2139,7 +2445,7 @@
2139
2445
  "example": "2",
2140
2446
  "member": "uint64",
2141
2447
  "name": "Count",
2142
- "required": true,
2448
+ "output_required": true,
2143
2449
  "type": "int",
2144
2450
  "value_allowed_null": false
2145
2451
  },
@@ -2149,7 +2455,7 @@
2149
2455
  "example": "无",
2150
2456
  "member": "SlowLogPattern",
2151
2457
  "name": "SlowLogPatterns",
2152
- "required": true,
2458
+ "output_required": true,
2153
2459
  "type": "list",
2154
2460
  "value_allowed_null": false
2155
2461
  },
@@ -2167,7 +2473,7 @@
2167
2473
  "members": [
2168
2474
  {
2169
2475
  "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",
2476
+ "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
2477
  "example": "cmgo-a3bm93hf",
2172
2478
  "member": "string",
2173
2479
  "name": "InstanceId",
@@ -2176,7 +2482,7 @@
2176
2482
  },
2177
2483
  {
2178
2484
  "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.",
2485
+ "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
2486
  "example": "2020-04-20 00:00:00",
2181
2487
  "member": "datetime",
2182
2488
  "name": "StartTime",
@@ -2185,7 +2491,7 @@
2185
2491
  },
2186
2492
  {
2187
2493
  "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.",
2494
+ "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
2495
  "example": "2020-04-20 22:00:00",
2190
2496
  "member": "datetime",
2191
2497
  "name": "EndTime",
@@ -2236,7 +2542,7 @@
2236
2542
  "members": [
2237
2543
  {
2238
2544
  "disabled": false,
2239
- "document": "Total number of slow logs",
2545
+ "document": "Total number of slow logs.",
2240
2546
  "example": "20",
2241
2547
  "member": "uint64",
2242
2548
  "name": "Count",
@@ -2247,7 +2553,7 @@
2247
2553
  {
2248
2554
  "disabled": false,
2249
2555
  "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\"]",
2556
+ "example": "[\"Mon Apr 20 13:55:21.623 I COMMAND ********************\"]",
2251
2557
  "member": "string",
2252
2558
  "name": "SlowLogs",
2253
2559
  "output_required": true,
@@ -2268,7 +2574,7 @@
2268
2574
  "members": [
2269
2575
  {
2270
2576
  "disabled": false,
2271
- "document": "AZ to be queried",
2577
+ "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
2578
  "example": "ap-guangzhou-3",
2273
2579
  "member": "string",
2274
2580
  "name": "Zone",
@@ -2283,7 +2589,7 @@
2283
2589
  "members": [
2284
2590
  {
2285
2591
  "disabled": false,
2286
- "document": "List of purchasable instance specifications",
2592
+ "document": "List of sales specification information on the instance.",
2287
2593
  "example": "无",
2288
2594
  "member": "SpecificationInfo",
2289
2595
  "name": "SpecInfoList",
@@ -2332,7 +2638,7 @@
2332
2638
  "members": [
2333
2639
  {
2334
2640
  "disabled": false,
2335
- "document": "Instance region name in the format of ap-guangzhou-2.",
2641
+ "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
2642
  "example": "ap-guangzhou-4",
2337
2643
  "member": "string",
2338
2644
  "name": "Zone",
@@ -2341,7 +2647,7 @@
2341
2647
  },
2342
2648
  {
2343
2649
  "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.",
2650
+ "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
2651
  "example": "3",
2346
2652
  "member": "int64",
2347
2653
  "name": "NodeNum",
@@ -2368,8 +2674,8 @@
2368
2674
  },
2369
2675
  {
2370
2676
  "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",
2677
+ "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.",
2678
+ "example": "MONGO_50_WT",
2373
2679
  "member": "string",
2374
2680
  "name": "MongoVersion",
2375
2681
  "required": true,
@@ -2513,7 +2819,7 @@
2513
2819
  "members": [
2514
2820
  {
2515
2821
  "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.",
2822
+ "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
2823
  "example": "cmgo-8oij5631",
2518
2824
  "member": "string",
2519
2825
  "name": "InstanceId",
@@ -2522,7 +2828,7 @@
2522
2828
  },
2523
2829
  {
2524
2830
  "disabled": false,
2525
- "document": "Instance memory size in GB after specification adjustment.",
2831
+ "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
2832
  "example": "8",
2527
2833
  "member": "int64",
2528
2834
  "name": "Memory",
@@ -2531,7 +2837,7 @@
2531
2837
  },
2532
2838
  {
2533
2839
  "disabled": false,
2534
- "document": "Instance disk size in GB after specification adjustment.",
2840
+ "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
2841
  "example": "200",
2536
2842
  "member": "int64",
2537
2843
  "name": "Volume",
@@ -2540,7 +2846,7 @@
2540
2846
  },
2541
2847
  {
2542
2848
  "disabled": false,
2543
- "document": "Number of instance nodes. The number of nodes is left unchanged by default and cannot be changed currently.",
2849
+ "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
2850
  "example": "3",
2545
2851
  "member": "int64",
2546
2852
  "name": "NodeNum",
@@ -2549,7 +2855,7 @@
2549
2855
  },
2550
2856
  {
2551
2857
  "disabled": false,
2552
- "document": "Number of instance shards. The number of shards is left unchanged by default and cannot be changed currently.",
2858
+ "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
2859
  "example": "2",
2554
2860
  "member": "int64",
2555
2861
  "name": "ReplicateSetNum",
@@ -2568,6 +2874,7 @@
2568
2874
  "example": "无",
2569
2875
  "member": "DBInstancePrice",
2570
2876
  "name": "Price",
2877
+ "output_required": true,
2571
2878
  "type": "object",
2572
2879
  "value_allowed_null": false
2573
2880
  },
@@ -2651,11 +2958,11 @@
2651
2958
  "usage": "in"
2652
2959
  },
2653
2960
  "InstanceDetail": {
2654
- "document": "Instance details",
2961
+ "document": "Instance details.",
2655
2962
  "members": [
2656
2963
  {
2657
2964
  "disabled": false,
2658
- "document": "Instance ID",
2965
+ "document": "Instance ID.",
2659
2966
  "example": "cmgo-7pje****",
2660
2967
  "member": "string",
2661
2968
  "name": "InstanceId",
@@ -2685,7 +2992,7 @@
2685
2992
  },
2686
2993
  {
2687
2994
  "disabled": false,
2688
- "document": "Project ID",
2995
+ "document": "Project ID.",
2689
2996
  "example": "1",
2690
2997
  "member": "uint64",
2691
2998
  "name": "ProjectId",
@@ -2695,7 +3002,7 @@
2695
3002
  },
2696
3003
  {
2697
3004
  "disabled": false,
2698
- "document": "Cluster type. Valid values: `0` (replica set instance), `1` (sharded instance).",
3005
+ "document": "Cluster type.\n- 0: replica set instance.\n- 1: sharded cluster instance.",
2699
3006
  "example": "1",
2700
3007
  "member": "uint64",
2701
3008
  "name": "ClusterType",
@@ -2725,7 +3032,7 @@
2725
3032
  },
2726
3033
  {
2727
3034
  "disabled": false,
2728
- "document": "Network type. Valid values: 0 (basic network), 1 (VPC)",
3035
+ "document": "Network type.\n- 0: basic network.\n- 1: VPC.",
2729
3036
  "example": "1",
2730
3037
  "member": "uint64",
2731
3038
  "name": "NetType",
@@ -2755,7 +3062,7 @@
2755
3062
  },
2756
3063
  {
2757
3064
  "disabled": false,
2758
- "document": "Instance status. Valid values: 0: creating; 1: processing; 2: running; -2: expired.",
3065
+ "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
3066
  "example": "2",
2760
3067
  "member": "int64",
2761
3068
  "name": "Status",
@@ -2805,7 +3112,7 @@
2805
3112
  },
2806
3113
  {
2807
3114
  "disabled": false,
2808
- "document": "Instance version information",
3115
+ "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
3116
  "example": "MONGO_42_WT",
2810
3117
  "member": "string",
2811
3118
  "name": "MongoVersion",
@@ -2815,7 +3122,7 @@
2815
3122
  },
2816
3123
  {
2817
3124
  "disabled": false,
2818
- "document": "Instance memory size in MB",
3125
+ "document": "Instance memory specification, in MB.",
2819
3126
  "example": "4",
2820
3127
  "member": "uint64",
2821
3128
  "name": "Memory",
@@ -2825,7 +3132,7 @@
2825
3132
  },
2826
3133
  {
2827
3134
  "disabled": false,
2828
- "document": "Instance disk size in MB",
3135
+ "document": "Instance disk specification, in MB.",
2829
3136
  "example": "120",
2830
3137
  "member": "uint64",
2831
3138
  "name": "Volume",
@@ -2835,7 +3142,7 @@
2835
3142
  },
2836
3143
  {
2837
3144
  "disabled": false,
2838
- "document": "Number of CPU cores of an instance",
3145
+ "document": "Number of the instance CPU cores.",
2839
3146
  "example": "2",
2840
3147
  "member": "uint64",
2841
3148
  "name": "CpuNum",
@@ -2845,7 +3152,7 @@
2845
3152
  },
2846
3153
  {
2847
3154
  "disabled": false,
2848
- "document": "Instance machine type",
3155
+ "document": "Instance machine type.\n- HIO10G: general HIO 10GE type.\n- HCD: Cloud Disk Edition type.",
2849
3156
  "example": "HIO10G",
2850
3157
  "member": "string",
2851
3158
  "name": "MachineType",
@@ -2875,7 +3182,7 @@
2875
3182
  },
2876
3183
  {
2877
3184
  "disabled": false,
2878
- "document": "Instance auto-renewal flag. Valid values: `0` (manual renewal), `1` (auto-renewal), `2` (no renewal upon expiration)",
3185
+ "document": "Automatic renewal flag for the instance.\n- 0: manual renewal.\n- 1: automatic renewal.\n- 2: no renewal after confirmation.",
2879
3186
  "example": "0",
2880
3187
  "member": "int64",
2881
3188
  "name": "AutoRenewFlag",
@@ -2885,7 +3192,7 @@
2885
3192
  },
2886
3193
  {
2887
3194
  "disabled": false,
2888
- "document": "Used capacity in MB",
3195
+ "document": "Used capacity, in MB.",
2889
3196
  "example": "100",
2890
3197
  "member": "uint64",
2891
3198
  "name": "UsedVolume",
@@ -2995,7 +3302,7 @@
2995
3302
  },
2996
3303
  {
2997
3304
  "disabled": false,
2998
- "document": "Protocol information. Valid values: `1` (mongodb), `2` (dynamodb).",
3305
+ "document": "Protocol information: mongodb.",
2999
3306
  "example": "0",
3000
3307
  "member": "uint64",
3001
3308
  "name": "Protocol",
@@ -3005,7 +3312,7 @@
3005
3312
  },
3006
3313
  {
3007
3314
  "disabled": false,
3008
- "document": "Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)",
3315
+ "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
3316
  "example": "1",
3010
3317
  "member": "uint64",
3011
3318
  "name": "InstanceType",
@@ -3015,7 +3322,7 @@
3015
3322
  },
3016
3323
  {
3017
3324
  "disabled": false,
3018
- "document": "Instance status description",
3325
+ "document": "Instance status description.",
3019
3326
  "example": "运行中",
3020
3327
  "member": "string",
3021
3328
  "name": "InstanceStatusDesc",
@@ -3025,7 +3332,7 @@
3025
3332
  },
3026
3333
  {
3027
3334
  "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",
3335
+ "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
3336
  "example": "cmgo-8go1o9xl",
3030
3337
  "member": "string",
3031
3338
  "name": "RealInstanceId",
@@ -3045,7 +3352,7 @@
3045
3352
  },
3046
3353
  {
3047
3354
  "disabled": false,
3048
- "document": "Mongos node memory.",
3355
+ "document": "Mongos node memory, in MB.",
3049
3356
  "example": "2",
3050
3357
  "member": "uint64",
3051
3358
  "name": "MongosMemory",
@@ -3075,7 +3382,7 @@
3075
3382
  },
3076
3383
  {
3077
3384
  "disabled": false,
3078
- "document": "ConfigServer node memory.",
3385
+ "document": "Config Server node memory, in MB.",
3079
3386
  "example": "2",
3080
3387
  "member": "uint64",
3081
3388
  "name": "ConfigServerMemory",
@@ -3085,7 +3392,7 @@
3085
3392
  },
3086
3393
  {
3087
3394
  "disabled": false,
3088
- "document": "ConfigServer node disk size.",
3395
+ "document": "Config Server node disk size, in MB.",
3089
3396
  "example": "20",
3090
3397
  "member": "uint64",
3091
3398
  "name": "ConfigServerVolume",
@@ -3485,7 +3792,7 @@
3485
3792
  "members": [
3486
3793
  {
3487
3794
  "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",
3795
+ "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
3796
  "example": "cmgo-f555zzzz",
3490
3797
  "member": "string",
3491
3798
  "name": "InstanceId",
@@ -3504,7 +3811,7 @@
3504
3811
  "example": "28920",
3505
3812
  "member": "string",
3506
3813
  "name": "AsyncRequestId",
3507
- "required": true,
3814
+ "output_required": true,
3508
3815
  "type": "string",
3509
3816
  "value_allowed_null": false
3510
3817
  },
@@ -3540,7 +3847,7 @@
3540
3847
  },
3541
3848
  {
3542
3849
  "disabled": false,
3543
- "document": "VPC ID after the switch. If the instance is using a basic network, this field is not required.",
3850
+ "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
3851
  "example": "vpc-****",
3545
3852
  "member": "string",
3546
3853
  "name": "NewUniqVpcId",
@@ -3549,7 +3856,7 @@
3549
3856
  },
3550
3857
  {
3551
3858
  "disabled": false,
3552
- "document": "VPC subnet ID after the switch. If the instance is using a basic network, this field is not required.",
3859
+ "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
3860
  "example": "subnet-****",
3554
3861
  "member": "string",
3555
3862
  "name": "NewUniqSubnetId",
@@ -3595,7 +3902,7 @@
3595
3902
  "members": [
3596
3903
  {
3597
3904
  "disabled": false,
3598
- "document": "Instance ID. For example, cmgo-7pje****.",
3905
+ "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
3906
  "example": "cmgo-7pjedvz7",
3600
3907
  "member": "string",
3601
3908
  "name": "InstanceId",
@@ -3604,7 +3911,7 @@
3604
3911
  },
3605
3912
  {
3606
3913
  "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.",
3914
+ "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
3915
  "example": "[\"sg-a\", \"sg-b\"]",
3609
3916
  "member": "string",
3610
3917
  "name": "SecurityGroupIds",
@@ -3631,8 +3938,8 @@
3631
3938
  "members": [
3632
3939
  {
3633
3940
  "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",
3941
+ "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.",
3942
+ "example": "cmgo-p8vn****",
3636
3943
  "member": "string",
3637
3944
  "name": "InstanceId",
3638
3945
  "required": true,
@@ -3640,7 +3947,7 @@
3640
3947
  },
3641
3948
  {
3642
3949
  "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.",
3950
+ "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
3951
  "example": "4",
3645
3952
  "member": "uint64",
3646
3953
  "name": "Memory",
@@ -3649,7 +3956,7 @@
3649
3956
  },
3650
3957
  {
3651
3958
  "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.",
3959
+ "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
3960
  "example": "250",
3654
3961
  "member": "uint64",
3655
3962
  "name": "Volume",
@@ -3667,7 +3974,7 @@
3667
3974
  },
3668
3975
  {
3669
3976
  "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.",
3977
+ "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
3978
  "example": "3",
3672
3979
  "member": "uint64",
3673
3980
  "name": "NodeNum",
@@ -3676,7 +3983,7 @@
3676
3983
  },
3677
3984
  {
3678
3985
  "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.",
3986
+ "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
3987
  "example": "3",
3681
3988
  "member": "uint64",
3682
3989
  "name": "ReplicateSetNum",
@@ -3694,7 +4001,7 @@
3694
4001
  },
3695
4002
  {
3696
4003
  "disabled": false,
3697
- "document": "Mongos node memory size after the sharded cluster instance configuration is modified. Unit: GB.",
4004
+ "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
4005
  "example": "2",
3699
4006
  "member": "string",
3700
4007
  "name": "MongosMemory",
@@ -3712,7 +4019,7 @@
3712
4019
  },
3713
4020
  {
3714
4021
  "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.",
4022
+ "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
4023
  "example": "无",
3717
4024
  "member": "RemoveNodeList",
3718
4025
  "name": "RemoveNodeList",
@@ -3768,12 +4075,166 @@
3768
4075
  ],
3769
4076
  "usage": "in"
3770
4077
  },
4078
+ "NodeProperty": {
4079
+ "document": "Node attributes.",
4080
+ "members": [
4081
+ {
4082
+ "disabled": false,
4083
+ "document": "Node AZ.",
4084
+ "example": "ap-guangzhou-1",
4085
+ "member": "string",
4086
+ "name": "Zone",
4087
+ "output_required": false,
4088
+ "type": "string",
4089
+ "value_allowed_null": false
4090
+ },
4091
+ {
4092
+ "disabled": false,
4093
+ "document": "Node name.",
4094
+ "example": "cmgo-ocdv****_0-node-primary",
4095
+ "member": "string",
4096
+ "name": "NodeName",
4097
+ "output_required": false,
4098
+ "type": "string",
4099
+ "value_allowed_null": false
4100
+ },
4101
+ {
4102
+ "disabled": false,
4103
+ "document": "Node access address.",
4104
+ "example": "10.4.0.7:30000",
4105
+ "member": "string",
4106
+ "name": "Address",
4107
+ "output_required": false,
4108
+ "type": "string",
4109
+ "value_allowed_null": false
4110
+ },
4111
+ {
4112
+ "disabled": false,
4113
+ "document": "Public network access address (IP address or domain name) of the node. The example value is an IP address.",
4114
+ "example": "113.0.**.**:27017",
4115
+ "member": "string",
4116
+ "name": "WanServiceAddress",
4117
+ "output_required": false,
4118
+ "type": "string",
4119
+ "value_allowed_null": false
4120
+ },
4121
+ {
4122
+ "disabled": false,
4123
+ "document": "Node role.\n- PRIMARY: primary node.\n- SECONDARY: secondary node.\n- READONLY: read-only node.\n- ARBITER: arbitration node.",
4124
+ "example": "PRIMARY",
4125
+ "member": "string",
4126
+ "name": "Role",
4127
+ "output_required": false,
4128
+ "type": "string",
4129
+ "value_allowed_null": false
4130
+ },
4131
+ {
4132
+ "disabled": false,
4133
+ "document": "Whether the node is a hidden node.\n- true: a hidden node.\n- false: not a hidden node.",
4134
+ "example": "false",
4135
+ "member": "bool",
4136
+ "name": "Hidden",
4137
+ "output_required": false,
4138
+ "type": "bool",
4139
+ "value_allowed_null": false
4140
+ },
4141
+ {
4142
+ "disabled": false,
4143
+ "document": "Node status.\n- NORMAL: running normally.\n- STARTUP: starting.\n- STARTUP2: starting and processing the intermediate data.\n- RECOVERING: recovering and not available.\n- DOWN: offline.\n- UNKNOWN: unknown status.\n- ROLLBACK: rolling back.\n- REMOVED: removed.",
4144
+ "example": "NORMAL",
4145
+ "member": "string",
4146
+ "name": "Status",
4147
+ "output_required": false,
4148
+ "type": "string",
4149
+ "value_allowed_null": false
4150
+ },
4151
+ {
4152
+ "disabled": false,
4153
+ "document": "Delay time of primary-secondary synchronization, in seconds.",
4154
+ "example": "1",
4155
+ "member": "int64",
4156
+ "name": "SlaveDelay",
4157
+ "output_required": false,
4158
+ "type": "int",
4159
+ "value_allowed_null": false
4160
+ },
4161
+ {
4162
+ "disabled": false,
4163
+ "document": "Node priority. Value range: [0, 100]. A larger value indicates a higher priority.",
4164
+ "example": "10",
4165
+ "member": "int64",
4166
+ "name": "Priority",
4167
+ "output_required": false,
4168
+ "type": "int",
4169
+ "value_allowed_null": false
4170
+ },
4171
+ {
4172
+ "disabled": false,
4173
+ "document": "Node voting right.\n- 1: The node has the right to vote.\n- 0: The node does not have the right to vote.",
4174
+ "example": "1",
4175
+ "member": "int64",
4176
+ "name": "Votes",
4177
+ "output_required": false,
4178
+ "type": "int",
4179
+ "value_allowed_null": false
4180
+ },
4181
+ {
4182
+ "disabled": false,
4183
+ "document": "Node tag.\nNote: This field may return null, indicating that no valid values can be obtained.",
4184
+ "example": "[{\"TagKey\":\"role-cmgo\",\"TagValue\":\"primary-secondary-group\"}]",
4185
+ "member": "NodeTag",
4186
+ "name": "Tags",
4187
+ "output_required": false,
4188
+ "type": "list",
4189
+ "value_allowed_null": true
4190
+ },
4191
+ {
4192
+ "disabled": false,
4193
+ "document": "Replica set ID.",
4194
+ "example": "cmgo-ocdv****_0",
4195
+ "member": "string",
4196
+ "name": "ReplicateSetId",
4197
+ "output_required": false,
4198
+ "type": "string",
4199
+ "value_allowed_null": false
4200
+ }
4201
+ ],
4202
+ "usage": "out"
4203
+ },
4204
+ "NodeTag": {
4205
+ "document": "Node tag.",
4206
+ "members": [
4207
+ {
4208
+ "disabled": false,
4209
+ "document": "Node tag key.",
4210
+ "example": "testKey",
4211
+ "member": "string",
4212
+ "name": "TagKey",
4213
+ "output_required": false,
4214
+ "required": false,
4215
+ "type": "string",
4216
+ "value_allowed_null": false
4217
+ },
4218
+ {
4219
+ "disabled": false,
4220
+ "document": "Node tag value.",
4221
+ "example": "testValue",
4222
+ "member": "string",
4223
+ "name": "TagValue",
4224
+ "output_required": false,
4225
+ "required": false,
4226
+ "type": "string",
4227
+ "value_allowed_null": false
4228
+ }
4229
+ ],
4230
+ "usage": "both"
4231
+ },
3771
4232
  "OfflineIsolatedDBInstanceRequest": {
3772
4233
  "document": "OfflineIsolatedDBInstance request structure.",
3773
4234
  "members": [
3774
4235
  {
3775
4236
  "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",
4237
+ "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
4238
  "example": "cmgo-f555zzzz",
3778
4239
  "member": "string",
3779
4240
  "name": "InstanceId",
@@ -3789,10 +4250,10 @@
3789
4250
  {
3790
4251
  "disabled": false,
3791
4252
  "document": "Async task request ID, which can be used to query the execution result of an async task.",
3792
- "example": "28920",
4253
+ "example": "\"28920\"",
3793
4254
  "member": "string",
3794
4255
  "name": "AsyncRequestId",
3795
- "required": true,
4256
+ "output_required": true,
3796
4257
  "type": "string",
3797
4258
  "value_allowed_null": false
3798
4259
  },
@@ -3806,7 +4267,7 @@
3806
4267
  "type": "object"
3807
4268
  },
3808
4269
  "RemoveNodeList": {
3809
- "document": "Node details of an instance to be modified.",
4270
+ "document": "Node details of the instance to be modified.",
3810
4271
  "members": [
3811
4272
  {
3812
4273
  "disabled": false,
@@ -3819,7 +4280,7 @@
3819
4280
  },
3820
4281
  {
3821
4282
  "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.",
4283
+ "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
4284
  "example": "cmgo-3iecwbfx_0-node-readonly0",
3824
4285
  "member": "string",
3825
4286
  "name": "NodeName",
@@ -3828,7 +4289,7 @@
3828
4289
  },
3829
4290
  {
3830
4291
  "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.",
4292
+ "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
4293
  "example": "ap-guangzhou-2",
3833
4294
  "member": "string",
3834
4295
  "name": "Zone",
@@ -3879,7 +4340,7 @@
3879
4340
  "members": [
3880
4341
  {
3881
4342
  "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.",
4343
+ "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
4344
  "example": "[\"cmgo-gzo0****\"]",
3884
4345
  "member": "string",
3885
4346
  "name": "InstanceIds",
@@ -3911,27 +4372,42 @@
3911
4372
  "type": "object"
3912
4373
  },
3913
4374
  "ReplicaSetInfo": {
3914
- "document": "Shard information",
4375
+ "document": "Shard information.",
3915
4376
  "members": [
3916
4377
  {
3917
4378
  "disabled": false,
3918
- "document": "Replica set ID",
4379
+ "document": "Replica set ID.",
3919
4380
  "example": "cmgo_ih8uido9_0",
3920
4381
  "member": "string",
3921
4382
  "name": "ReplicaSetId",
3922
4383
  "required": true,
3923
- "type": "string",
3924
- "value_allowed_null": false
4384
+ "type": "string"
3925
4385
  }
3926
4386
  ],
3927
4387
  "usage": "in"
3928
4388
  },
4389
+ "ReplicateSetInfo": {
4390
+ "document": "Replica set information.",
4391
+ "members": [
4392
+ {
4393
+ "disabled": false,
4394
+ "document": "Node attributes.",
4395
+ "example": "无",
4396
+ "member": "NodeProperty",
4397
+ "name": "Nodes",
4398
+ "output_required": false,
4399
+ "type": "list",
4400
+ "value_allowed_null": false
4401
+ }
4402
+ ],
4403
+ "usage": "out"
4404
+ },
3929
4405
  "ResetDBInstancePasswordRequest": {
3930
4406
  "document": "ResetDBInstancePassword request structure.",
3931
4407
  "members": [
3932
4408
  {
3933
4409
  "disabled": false,
3934
- "document": "Instance ID",
4410
+ "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
4411
  "example": "cmgo-7pjedvz7",
3936
4412
  "member": "string",
3937
4413
  "name": "InstanceId",
@@ -3940,7 +4416,7 @@
3940
4416
  },
3941
4417
  {
3942
4418
  "disabled": false,
3943
- "document": "Instance account name",
4419
+ "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
4420
  "example": "rwuser",
3945
4421
  "member": "string",
3946
4422
  "name": "UserName",
@@ -3949,8 +4425,8 @@
3949
4425
  },
3950
4426
  {
3951
4427
  "disabled": false,
3952
- "document": "New password, which must contain at least eight characters",
3953
- "example": "111111",
4428
+ "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 (!@#%^\\*()\\_).",
4429
+ "example": "test_123***",
3954
4430
  "member": "string",
3955
4431
  "name": "Password",
3956
4432
  "required": true,
@@ -3964,11 +4440,11 @@
3964
4440
  "members": [
3965
4441
  {
3966
4442
  "disabled": false,
3967
- "document": "Async request ID, which is used to query the running status of the process.",
4443
+ "document": "Task request ID.",
3968
4444
  "example": "4769",
3969
4445
  "member": "string",
3970
4446
  "name": "AsyncRequestId",
3971
- "required": true,
4447
+ "output_required": true,
3972
4448
  "type": "string",
3973
4449
  "value_allowed_null": false
3974
4450
  },
@@ -3986,71 +4462,71 @@
3986
4462
  "members": [
3987
4463
  {
3988
4464
  "disabled": false,
3989
- "document": "Project ID",
4465
+ "document": "Associated project ID.",
3990
4466
  "example": "0",
3991
4467
  "member": "int64",
3992
4468
  "name": "ProjectId",
3993
- "required": true,
4469
+ "output_required": true,
3994
4470
  "type": "int",
3995
4471
  "value_allowed_null": false
3996
4472
  },
3997
4473
  {
3998
4474
  "disabled": false,
3999
- "document": "Creation time",
4475
+ "document": "Security group creation time.",
4000
4476
  "example": "2021-01-02 15:04:05",
4001
4477
  "member": "string",
4002
4478
  "name": "CreateTime",
4003
- "required": true,
4479
+ "output_required": true,
4004
4480
  "type": "string",
4005
4481
  "value_allowed_null": false
4006
4482
  },
4007
4483
  {
4008
4484
  "disabled": false,
4009
- "document": "Inbound rule",
4485
+ "document": "Security group inbound rule.",
4010
4486
  "example": "无",
4011
4487
  "member": "SecurityGroupBound",
4012
4488
  "name": "Inbound",
4013
- "required": true,
4489
+ "output_required": true,
4014
4490
  "type": "list",
4015
4491
  "value_allowed_null": false
4016
4492
  },
4017
4493
  {
4018
4494
  "disabled": false,
4019
- "document": "Outbound rule",
4495
+ "document": "Security group outbound rule.",
4020
4496
  "example": "无",
4021
4497
  "member": "SecurityGroupBound",
4022
4498
  "name": "Outbound",
4023
- "required": true,
4499
+ "output_required": true,
4024
4500
  "type": "list",
4025
4501
  "value_allowed_null": false
4026
4502
  },
4027
4503
  {
4028
4504
  "disabled": false,
4029
- "document": "Security group ID",
4030
- "example": "sg-lxdvbitn",
4505
+ "document": "Security group ID.",
4506
+ "example": "sg-lxdv****",
4031
4507
  "member": "string",
4032
4508
  "name": "SecurityGroupId",
4033
- "required": true,
4509
+ "output_required": true,
4034
4510
  "type": "string",
4035
4511
  "value_allowed_null": false
4036
4512
  },
4037
4513
  {
4038
4514
  "disabled": false,
4039
- "document": "Security group name",
4040
- "example": "全放通",
4515
+ "document": "Security group name.",
4516
+ "example": "Security Test",
4041
4517
  "member": "string",
4042
4518
  "name": "SecurityGroupName",
4043
- "required": true,
4519
+ "output_required": true,
4044
4520
  "type": "string",
4045
4521
  "value_allowed_null": false
4046
4522
  },
4047
4523
  {
4048
4524
  "disabled": false,
4049
- "document": "Security group remarks",
4525
+ "document": "Security group remarks.",
4050
4526
  "example": "暴露全部端口到公网和内网,有一定安全风险",
4051
4527
  "member": "string",
4052
4528
  "name": "SecurityGroupRemark",
4053
- "required": true,
4529
+ "output_required": true,
4054
4530
  "type": "string",
4055
4531
  "value_allowed_null": false
4056
4532
  }
@@ -4062,7 +4538,7 @@
4062
4538
  "members": [
4063
4539
  {
4064
4540
  "disabled": false,
4065
- "document": "Execution rule. Valid values: `ACCEPT`, `DROP`",
4541
+ "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
4542
  "example": "ACCEPT",
4067
4543
  "member": "string",
4068
4544
  "name": "Action",
@@ -4072,7 +4548,7 @@
4072
4548
  },
4073
4549
  {
4074
4550
  "disabled": false,
4075
- "document": "IP range",
4551
+ "document": "Inbound IP address or IP range for database access.",
4076
4552
  "example": "0.0.0.0/0",
4077
4553
  "member": "string",
4078
4554
  "name": "CidrIp",
@@ -4082,7 +4558,7 @@
4082
4558
  },
4083
4559
  {
4084
4560
  "disabled": false,
4085
- "document": "Port range",
4561
+ "document": "Port for database access.",
4086
4562
  "example": "80,443",
4087
4563
  "member": "string",
4088
4564
  "name": "PortRange",
@@ -4092,7 +4568,7 @@
4092
4568
  },
4093
4569
  {
4094
4570
  "disabled": false,
4095
- "document": "Transport layer protocol. Valid values: `tcp`, `udp`, `ALL`",
4571
+ "document": "Transport layer protocol: TCP.",
4096
4572
  "example": "tcp",
4097
4573
  "member": "string",
4098
4574
  "name": "IpProtocol",
@@ -4102,8 +4578,8 @@
4102
4578
  },
4103
4579
  {
4104
4580
  "disabled": false,
4105
- "document": "All the addresses that the security group ID represents",
4106
- "example": "sg-",
4581
+ "document": "Security group ID.",
4582
+ "example": "sg-kayh****",
4107
4583
  "member": "string",
4108
4584
  "name": "Id",
4109
4585
  "output_required": true,
@@ -4112,8 +4588,8 @@
4112
4588
  },
4113
4589
  {
4114
4590
  "disabled": false,
4115
- "document": "All the addresses that the address group ID represents",
4116
- "example": "地址集合",
4591
+ "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.",
4592
+ "example": "ipm-0h4k****",
4117
4593
  "member": "string",
4118
4594
  "name": "AddressModule",
4119
4595
  "output_required": true,
@@ -4122,8 +4598,8 @@
4122
4598
  },
4123
4599
  {
4124
4600
  "disabled": false,
4125
- "document": "All the protocols and ports that the service group ID represents",
4126
- "example": "协议和端口集合",
4601
+ "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.",
4602
+ "example": "ppm-ay7b****",
4127
4603
  "member": "string",
4128
4604
  "name": "ServiceModule",
4129
4605
  "output_required": true,
@@ -4132,7 +4608,7 @@
4132
4608
  },
4133
4609
  {
4134
4610
  "disabled": false,
4135
- "document": "Description",
4611
+ "document": "Security group description information.",
4136
4612
  "example": "my-SecurityGroupBound",
4137
4613
  "member": "string",
4138
4614
  "name": "Desc",
@@ -4143,6 +4619,42 @@
4143
4619
  ],
4144
4620
  "usage": "out"
4145
4621
  },
4622
+ "SetDBInstanceDeletionProtectionRequest": {
4623
+ "document": "SetDBInstanceDeletionProtection request structure.",
4624
+ "members": [
4625
+ {
4626
+ "disabled": false,
4627
+ "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.",
4628
+ "example": "[\"cmgo-8oij****\"]",
4629
+ "member": "string",
4630
+ "name": "InstanceIds",
4631
+ "required": true,
4632
+ "type": "list"
4633
+ },
4634
+ {
4635
+ "disabled": false,
4636
+ "document": "Instance termination protection switch. Valid values: 0 - disabled; 1 - enabled.",
4637
+ "example": "1",
4638
+ "member": "uint64",
4639
+ "name": "EnableDeletionProtection",
4640
+ "required": true,
4641
+ "type": "int"
4642
+ }
4643
+ ],
4644
+ "type": "object"
4645
+ },
4646
+ "SetDBInstanceDeletionProtectionResponse": {
4647
+ "document": "SetDBInstanceDeletionProtection response structure.",
4648
+ "members": [
4649
+ {
4650
+ "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.",
4651
+ "member": "string",
4652
+ "name": "RequestId",
4653
+ "type": "string"
4654
+ }
4655
+ ],
4656
+ "type": "object"
4657
+ },
4146
4658
  "ShardInfo": {
4147
4659
  "document": "Details of an instance shard",
4148
4660
  "members": [
@@ -4229,13 +4741,49 @@
4229
4741
  ],
4230
4742
  "usage": "out"
4231
4743
  },
4744
+ "SlowLogItem": {
4745
+ "document": "Slow log details.",
4746
+ "members": [
4747
+ {
4748
+ "disabled": false,
4749
+ "document": "Slow log details.",
4750
+ "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), **********\"",
4751
+ "member": "string",
4752
+ "name": "Log",
4753
+ "output_required": false,
4754
+ "type": "string",
4755
+ "value_allowed_null": false
4756
+ },
4757
+ {
4758
+ "disabled": false,
4759
+ "document": "Node name.",
4760
+ "example": "\"cmgo-r3p8hslf_0-node-primary\"",
4761
+ "member": "string",
4762
+ "name": "NodeName",
4763
+ "output_required": false,
4764
+ "type": "string",
4765
+ "value_allowed_null": false
4766
+ },
4767
+ {
4768
+ "disabled": false,
4769
+ "document": "Queries the hash value.",
4770
+ "example": "\"admin..*****Continue\"",
4771
+ "member": "string",
4772
+ "name": "QueryHash",
4773
+ "output_required": false,
4774
+ "type": "string",
4775
+ "value_allowed_null": false
4776
+ }
4777
+ ],
4778
+ "usage": "out"
4779
+ },
4232
4780
  "SlowLogPattern": {
4233
4781
  "document": "Slow log statistics of MongoDB database",
4234
4782
  "members": [
4235
4783
  {
4236
4784
  "disabled": false,
4237
- "document": "Slow log pattern",
4238
- "example": "2024-12-08T18:09:23.364+0800",
4785
+ "document": "Slow log output format: database name.table name.command.",
4786
+ "example": "admin.$cmd.command",
4239
4787
  "member": "string",
4240
4788
  "name": "Pattern",
4241
4789
  "output_required": true,
@@ -4244,7 +4792,17 @@
4244
4792
  },
4245
4793
  {
4246
4794
  "disabled": false,
4247
- "document": "Maximum execution time",
4795
+ "document": "queryHash value carried during slow log recording. It can be used to identify a query type.",
4796
+ "example": "83BAE67C",
4797
+ "member": "string",
4798
+ "name": "QueryHash",
4799
+ "output_required": false,
4800
+ "type": "string",
4801
+ "value_allowed_null": false
4802
+ },
4803
+ {
4804
+ "disabled": false,
4805
+ "document": "Maximum execution time, in milliseconds.",
4248
4806
  "example": "578",
4249
4807
  "member": "uint64",
4250
4808
  "name": "MaxTime",
@@ -4254,7 +4812,7 @@
4254
4812
  },
4255
4813
  {
4256
4814
  "disabled": false,
4257
- "document": "Average execution time",
4815
+ "document": "Average execution time, in milliseconds.",
4258
4816
  "example": "546",
4259
4817
  "member": "uint64",
4260
4818
  "name": "AverageTime",
@@ -4264,8 +4822,8 @@
4264
4822
  },
4265
4823
  {
4266
4824
  "disabled": false,
4267
- "document": "Number of slow logs in this pattern",
4268
- "example": "1",
4825
+ "document": "Number of slow logs.",
4826
+ "example": "8",
4269
4827
  "member": "uint64",
4270
4828
  "name": "Total",
4271
4829
  "output_required": true,
@@ -4276,11 +4834,11 @@
4276
4834
  "usage": "out"
4277
4835
  },
4278
4836
  "SpecItem": {
4279
- "document": "Specifications of purchasable MongoDB instances",
4837
+ "document": "TencentDB for MongoDB instance sales specification.",
4280
4838
  "members": [
4281
4839
  {
4282
4840
  "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.",
4841
+ "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
4842
  "example": "mongo.HIO10G.128g",
4285
4843
  "member": "string",
4286
4844
  "name": "SpecCode",
@@ -4370,8 +4928,8 @@
4370
4928
  },
4371
4929
  {
4372
4930
  "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",
4931
+ "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.",
4932
+ "example": "MONGO_50_WT",
4375
4933
  "member": "string",
4376
4934
  "name": "MongoVersionCode",
4377
4935
  "output_required": true,
@@ -4390,7 +4948,7 @@
4390
4948
  },
4391
4949
  {
4392
4950
  "disabled": false,
4393
- "document": "Instance version information. Valid values: 3.6, 4.2, 4.4, 5.0, and 6.0.\n",
4951
+ "document": "Instance version information. Valid values: 4.2, 4.4, 5.0, 6.0, and 7.0.",
4394
4952
  "example": "3.6",
4395
4953
  "member": "string",
4396
4954
  "name": "Version",
@@ -4492,11 +5050,11 @@
4492
5050
  "usage": "out"
4493
5051
  },
4494
5052
  "SpecificationInfo": {
4495
- "document": "Instance specification information",
5053
+ "document": "Instance specification information.",
4496
5054
  "members": [
4497
5055
  {
4498
5056
  "disabled": false,
4499
- "document": "Region information",
5057
+ "document": "Region information.",
4500
5058
  "example": "ap-guangzhou",
4501
5059
  "member": "string",
4502
5060
  "name": "Region",
@@ -4506,7 +5064,7 @@
4506
5064
  },
4507
5065
  {
4508
5066
  "disabled": false,
4509
- "document": "AZ information",
5067
+ "document": "AZ information.",
4510
5068
  "example": "ap-guangzhou-1",
4511
5069
  "member": "string",
4512
5070
  "name": "Zone",
@@ -4516,7 +5074,7 @@
4516
5074
  },
4517
5075
  {
4518
5076
  "disabled": false,
4519
- "document": "Purchasable specification information",
5077
+ "document": "Sales specification information.",
4520
5078
  "example": "无",
4521
5079
  "member": "SpecItem",
4522
5080
  "name": "SpecItems",
@@ -4526,7 +5084,7 @@
4526
5084
  },
4527
5085
  {
4528
5086
  "disabled": false,
4529
- "document": "Whether cross-AZ deployment is supported. Valid values: `1` (yes), `0` (no).",
5087
+ "document": "Whether cross-AZ deployment is supported.\n- 1: supported.\n- 0: not supported.",
4530
5088
  "example": "1",
4531
5089
  "member": "int64",
4532
5090
  "name": "SupportMultiAZ",
@@ -4564,6 +5122,33 @@
4564
5122
  }
4565
5123
  ],
4566
5124
  "usage": "both"
5125
+ },
5126
+ "TerminateDBInstancesRequest": {
5127
+ "document": "TerminateDBInstances request structure.",
5128
+ "members": [
5129
+ {
5130
+ "disabled": false,
5131
+ "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.",
5132
+ "example": "cmgo-7pje****",
5133
+ "member": "string",
5134
+ "name": "InstanceId",
5135
+ "required": true,
5136
+ "type": "string"
5137
+ }
5138
+ ],
5139
+ "type": "object"
5140
+ },
5141
+ "TerminateDBInstancesResponse": {
5142
+ "document": "TerminateDBInstances response structure.",
5143
+ "members": [
5144
+ {
5145
+ "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.",
5146
+ "member": "string",
5147
+ "name": "RequestId",
5148
+ "type": "string"
5149
+ }
5150
+ ],
5151
+ "type": "object"
4567
5152
  }
4568
5153
  },
4569
5154
  "version": "1.0"