tccli 3.0.1391.1__py2.py3-none-any.whl → 3.0.1414.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.

Potentially problematic release.


This version of tccli might be problematic. Click here for more details.

Files changed (226) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +2 -1
  3. tccli/services/ai3d/v20250513/api.json +22 -4
  4. tccli/services/aiart/aiart_client.py +173 -67
  5. tccli/services/aiart/v20221229/api.json +193 -0
  6. tccli/services/aiart/v20221229/examples.json +16 -0
  7. tccli/services/apm/apm_client.py +53 -0
  8. tccli/services/apm/v20210622/api.json +354 -0
  9. tccli/services/apm/v20210622/examples.json +8 -0
  10. tccli/services/asr/v20190614/api.json +3 -3
  11. tccli/services/autoscaling/v20180419/api.json +24 -2
  12. tccli/services/batch/v20170312/api.json +1 -1
  13. tccli/services/bda/bda_client.py +15 -704
  14. tccli/services/bda/v20200324/api.json +107 -1819
  15. tccli/services/bda/v20200324/examples.json +0 -176
  16. tccli/services/billing/billing_client.py +326 -8
  17. tccli/services/billing/v20180709/api.json +2200 -255
  18. tccli/services/billing/v20180709/examples.json +48 -0
  19. tccli/services/cam/v20190116/api.json +4 -4
  20. tccli/services/captcha/v20190722/api.json +3 -3
  21. tccli/services/cat/v20180409/api.json +7 -7
  22. tccli/services/ccc/ccc_client.py +235 -76
  23. tccli/services/ccc/v20200210/api.json +502 -18
  24. tccli/services/ccc/v20200210/examples.json +24 -0
  25. tccli/services/cdb/cdb_client.py +106 -0
  26. tccli/services/cdb/v20170320/api.json +257 -44
  27. tccli/services/cdb/v20170320/examples.json +22 -6
  28. tccli/services/cdn/cdn_client.py +4 -163
  29. tccli/services/cdn/v20180606/api.json +61 -310
  30. tccli/services/cdn/v20180606/examples.json +1 -25
  31. tccli/services/cdwdoris/v20211228/api.json +51 -12
  32. tccli/services/cdwpg/v20201230/api.json +11 -1
  33. tccli/services/cdwpg/v20201230/examples.json +1 -1
  34. tccli/services/cfg/v20210820/api.json +11 -1
  35. tccli/services/cfs/cfs_client.py +41 -94
  36. tccli/services/cfs/v20190719/api.json +171 -55
  37. tccli/services/cfs/v20190719/examples.json +1 -9
  38. tccli/services/cfw/v20190904/api.json +122 -10
  39. tccli/services/ckafka/ckafka_client.py +188 -29
  40. tccli/services/ckafka/v20190819/api.json +277 -4
  41. tccli/services/ckafka/v20190819/examples.json +25 -1
  42. tccli/services/clb/clb_client.py +0 -265
  43. tccli/services/clb/v20180317/api.json +130 -296
  44. tccli/services/clb/v20180317/examples.json +12 -40
  45. tccli/services/cloudapp/v20220530/api.json +55 -0
  46. tccli/services/cloudaudit/v20190319/api.json +11 -0
  47. tccli/services/cloudhsm/v20191112/api.json +10 -10
  48. tccli/services/cls/v20201016/api.json +63 -45
  49. tccli/services/cls/v20201016/examples.json +10 -4
  50. tccli/services/csip/v20221121/api.json +53 -3
  51. tccli/services/ctem/v20231128/api.json +320 -0
  52. tccli/services/ctem/v20231128/examples.json +3 -3
  53. tccli/services/cvm/cvm_client.py +0 -212
  54. tccli/services/cvm/v20170312/api.json +91 -843
  55. tccli/services/cvm/v20170312/examples.json +32 -58
  56. tccli/services/cynosdb/cynosdb_client.py +167 -8
  57. tccli/services/cynosdb/v20190107/api.json +1126 -148
  58. tccli/services/cynosdb/v20190107/examples.json +31 -7
  59. tccli/services/dbbrain/dbbrain_client.py +246 -87
  60. tccli/services/dbbrain/v20191016/api.json +74 -62
  61. tccli/services/dbbrain/v20191016/examples.json +1 -1
  62. tccli/services/dbbrain/v20210527/api.json +601 -177
  63. tccli/services/dbbrain/v20210527/examples.json +28 -4
  64. tccli/services/dc/v20180410/api.json +101 -3
  65. tccli/services/dcdb/v20180411/api.json +1 -1
  66. tccli/services/dlc/dlc_client.py +53 -0
  67. tccli/services/dlc/v20210125/api.json +237 -24
  68. tccli/services/dlc/v20210125/examples.json +12 -4
  69. tccli/services/dnspod/dnspod_client.py +106 -0
  70. tccli/services/dnspod/v20210323/api.json +126 -20
  71. tccli/services/dnspod/v20210323/examples.json +17 -7
  72. tccli/services/dsgc/v20190723/api.json +73 -15
  73. tccli/services/dts/v20180330/api.json +4 -4
  74. tccli/services/dts/v20211206/api.json +408 -127
  75. tccli/services/dts/v20211206/examples.json +15 -9
  76. tccli/services/eb/v20210416/api.json +41 -1
  77. tccli/services/eb/v20210416/examples.json +1 -1
  78. tccli/services/emr/v20190103/api.json +56 -9
  79. tccli/services/emr/v20190103/examples.json +5 -5
  80. tccli/services/es/es_client.py +273 -8
  81. tccli/services/es/v20180416/api.json +845 -33
  82. tccli/services/es/v20180416/examples.json +33 -1
  83. tccli/services/es/v20250101/api.json +135 -2
  84. tccli/services/es/v20250101/examples.json +8 -0
  85. tccli/services/ess/ess_client.py +509 -32
  86. tccli/services/ess/v20201111/api.json +1366 -113
  87. tccli/services/ess/v20201111/examples.json +94 -10
  88. tccli/services/essbasic/v20210526/api.json +265 -27
  89. tccli/services/essbasic/v20210526/examples.json +12 -12
  90. tccli/services/facefusion/v20220927/api.json +1 -1
  91. tccli/services/gaap/v20180529/api.json +18 -8
  92. tccli/services/gme/gme_client.py +53 -0
  93. tccli/services/gme/v20180711/api.json +241 -1
  94. tccli/services/gme/v20180711/examples.json +8 -0
  95. tccli/services/gs/gs_client.py +216 -4
  96. tccli/services/gs/v20191118/api.json +202 -1
  97. tccli/services/gs/v20191118/examples.json +32 -0
  98. tccli/services/gwlb/gwlb_client.py +53 -0
  99. tccli/services/gwlb/v20240906/api.json +150 -0
  100. tccli/services/gwlb/v20240906/examples.json +8 -0
  101. tccli/services/hai/v20230812/api.json +5 -5
  102. tccli/services/hunyuan/v20230901/api.json +3 -3
  103. tccli/services/hunyuan/v20230901/examples.json +1 -1
  104. tccli/services/iai/v20180301/api.json +227 -207
  105. tccli/services/iai/v20180301/examples.json +26 -26
  106. tccli/services/iai/v20200303/api.json +4 -4
  107. tccli/services/iai/v20200303/examples.json +1 -1
  108. tccli/services/ioa/ioa_client.py +265 -0
  109. tccli/services/ioa/v20220601/api.json +781 -85
  110. tccli/services/ioa/v20220601/examples.json +46 -0
  111. tccli/services/iotexplorer/iotexplorer_client.py +387 -16
  112. tccli/services/iotexplorer/v20190423/api.json +1183 -63
  113. tccli/services/iotexplorer/v20190423/examples.json +92 -0
  114. tccli/services/keewidb/v20220308/api.json +69 -17
  115. tccli/services/keewidb/v20220308/examples.json +5 -5
  116. tccli/services/lcic/v20220817/api.json +61 -15
  117. tccli/services/lighthouse/v20200324/api.json +193 -24
  118. tccli/services/lighthouse/v20200324/examples.json +9 -3
  119. tccli/services/live/v20180801/api.json +6 -6
  120. tccli/services/live/v20180801/examples.json +7 -1
  121. tccli/services/lke/lke_client.py +40 -93
  122. tccli/services/lke/v20231130/api.json +943 -390
  123. tccli/services/lke/v20231130/examples.json +38 -46
  124. tccli/services/lkeap/v20240522/api.json +39 -12
  125. tccli/services/lkeap/v20240522/examples.json +12 -0
  126. tccli/services/mariadb/v20170312/api.json +1 -1
  127. tccli/services/mna/v20210119/api.json +11 -2
  128. tccli/services/mna/v20210119/examples.json +1 -1
  129. tccli/services/mongodb/mongodb_client.py +334 -16
  130. tccli/services/mongodb/v20190725/api.json +1092 -383
  131. tccli/services/mongodb/v20190725/examples.json +69 -21
  132. tccli/services/monitor/monitor_client.py +106 -0
  133. tccli/services/monitor/v20180724/api.json +383 -12
  134. tccli/services/monitor/v20180724/examples.json +24 -2
  135. tccli/services/mps/mps_client.py +220 -8
  136. tccli/services/mps/v20190612/api.json +1999 -179
  137. tccli/services/mps/v20190612/examples.json +56 -6
  138. tccli/services/mqtt/v20240516/api.json +10 -0
  139. tccli/services/mqtt/v20240516/examples.json +3 -9
  140. tccli/services/nlp/v20190408/api.json +6 -6
  141. tccli/services/oceanus/oceanus_client.py +318 -0
  142. tccli/services/oceanus/v20190422/api.json +461 -26
  143. tccli/services/oceanus/v20190422/examples.json +50 -2
  144. tccli/services/ocr/ocr_client.py +41 -253
  145. tccli/services/ocr/v20181119/api.json +153 -659
  146. tccli/services/ocr/v20181119/examples.json +8 -40
  147. tccli/services/omics/v20221128/api.json +90 -7
  148. tccli/services/organization/v20210331/api.json +46 -7
  149. tccli/services/postgres/v20170312/api.json +333 -77
  150. tccli/services/postgres/v20170312/examples.json +37 -31
  151. tccli/services/privatedns/privatedns_client.py +641 -58
  152. tccli/services/privatedns/v20201028/api.json +930 -19
  153. tccli/services/privatedns/v20201028/examples.json +91 -3
  154. tccli/services/pts/v20210728/api.json +2 -2
  155. tccli/services/redis/v20180412/api.json +303 -109
  156. tccli/services/redis/v20180412/examples.json +12 -12
  157. tccli/services/region/v20220627/api.json +1 -1
  158. tccli/services/rum/v20210622/api.json +22 -4
  159. tccli/services/rum/v20210622/examples.json +2 -2
  160. tccli/services/sms/v20190711/api.json +12 -12
  161. tccli/services/sms/v20190711/examples.json +9 -3
  162. tccli/services/sms/v20210111/api.json +13 -13
  163. tccli/services/sms/v20210111/examples.json +8 -2
  164. tccli/services/sqlserver/v20180328/api.json +46 -7
  165. tccli/services/sqlserver/v20180328/examples.json +2 -2
  166. tccli/services/ssl/v20191205/api.json +28 -0
  167. tccli/services/svp/v20240125/api.json +14 -4
  168. tccli/services/tag/v20180813/api.json +3 -3
  169. tccli/services/tat/v20201028/api.json +22 -3
  170. tccli/services/tcb/v20180608/api.json +1 -1
  171. tccli/services/tcss/tcss_client.py +228 -69
  172. tccli/services/tcss/v20201101/api.json +273 -25
  173. tccli/services/tcss/v20201101/examples.json +26 -2
  174. tccli/services/teo/teo_client.py +317 -52
  175. tccli/services/teo/v20220901/api.json +1824 -242
  176. tccli/services/teo/v20220901/examples.json +109 -21
  177. tccli/services/thpc/thpc_client.py +57 -4
  178. tccli/services/thpc/v20230321/api.json +163 -21
  179. tccli/services/thpc/v20230321/examples.json +13 -5
  180. tccli/services/tione/tione_client.py +163 -4
  181. tccli/services/tione/v20211111/api.json +285 -21
  182. tccli/services/tione/v20211111/examples.json +27 -3
  183. tccli/services/tke/tke_client.py +8 -8
  184. tccli/services/tke/v20180525/api.json +168 -130
  185. tccli/services/tke/v20180525/examples.json +20 -20
  186. tccli/services/tke/v20220501/api.json +215 -3
  187. tccli/services/tke/v20220501/examples.json +8 -0
  188. tccli/services/tms/tms_client.py +106 -0
  189. tccli/services/tms/v20201229/api.json +249 -3
  190. tccli/services/tms/v20201229/examples.json +16 -0
  191. tccli/services/tmt/v20180321/api.json +78 -1
  192. tccli/services/trabbit/v20230418/api.json +271 -4
  193. tccli/services/trabbit/v20230418/examples.json +9 -3
  194. tccli/services/trocket/v20230308/api.json +4 -4
  195. tccli/services/trro/trro_client.py +106 -0
  196. tccli/services/trro/v20220325/api.json +456 -0
  197. tccli/services/trro/v20220325/examples.json +16 -0
  198. tccli/services/trtc/v20190722/api.json +197 -49
  199. tccli/services/trtc/v20190722/examples.json +4 -4
  200. tccli/services/tse/v20201207/api.json +69 -2
  201. tccli/services/tse/v20201207/examples.json +3 -3
  202. tccli/services/tsf/v20180326/api.json +70 -7
  203. tccli/services/tsf/v20180326/examples.json +2 -2
  204. tccli/services/vclm/v20240523/api.json +145 -0
  205. tccli/services/vclm/v20240523/examples.json +16 -0
  206. tccli/services/vclm/vclm_client.py +106 -0
  207. tccli/services/vcube/v20220410/api.json +1 -1
  208. tccli/services/vod/v20180717/api.json +7 -7
  209. tccli/services/vpc/v20170312/api.json +1216 -70
  210. tccli/services/vpc/v20170312/examples.json +139 -3
  211. tccli/services/vpc/vpc_client.py +1023 -122
  212. tccli/services/vrs/v20200824/api.json +11 -11
  213. tccli/services/vrs/v20200824/examples.json +1 -1
  214. tccli/services/vtc/v20240223/api.json +14 -14
  215. tccli/services/waf/v20180125/api.json +812 -143
  216. tccli/services/waf/v20180125/examples.json +2 -2
  217. tccli/services/wedata/v20210820/api.json +1281 -601
  218. tccli/services/wedata/v20210820/examples.json +127 -157
  219. tccli/services/wedata/v20250806/api.json +19335 -0
  220. tccli/services/wedata/v20250806/examples.json +999 -0
  221. tccli/services/wedata/wedata_client.py +7072 -1131
  222. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/METADATA +9 -7
  223. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/RECORD +226 -224
  224. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/WHEEL +1 -1
  225. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/entry_points.txt +0 -0
  226. {tccli-3.0.1391.1.dist-info/license_files → tccli-3.0.1414.1.dist-info/licenses}/LICENSE +0 -0
@@ -29,7 +29,7 @@
29
29
  "status": "online"
30
30
  },
31
31
  "CreateDBInstance": {
32
- "document": "本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。",
32
+ "document": "本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可通过接口查询 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。",
33
33
  "input": "CreateDBInstanceRequest",
34
34
  "name": "创建云数据库实例(包年包月)",
35
35
  "output": "CreateDBInstanceResponse",
@@ -49,6 +49,13 @@
49
49
  "output": "CreateDBInstanceParamTplResponse",
50
50
  "status": "online"
51
51
  },
52
+ "CreateLogDownloadTask": {
53
+ "document": "创建日志下载任务",
54
+ "input": "CreateLogDownloadTaskRequest",
55
+ "name": "创建日志下载任务",
56
+ "output": "CreateLogDownloadTaskResponse",
57
+ "status": "online"
58
+ },
52
59
  "DeleteAccountUser": {
53
60
  "document": "本接口(DeleteAccountUser)用于删除实例的自定义账号。",
54
61
  "input": "DeleteAccountUserRequest",
@@ -56,6 +63,13 @@
56
63
  "output": "DeleteAccountUserResponse",
57
64
  "status": "online"
58
65
  },
66
+ "DeleteLogDownloadTask": {
67
+ "document": "删除日志下载任务",
68
+ "input": "DeleteLogDownloadTaskRequest",
69
+ "name": "删除日志下载任务",
70
+ "output": "DeleteLogDownloadTaskResponse",
71
+ "status": "online"
72
+ },
59
73
  "DescribeAccountUsers": {
60
74
  "document": "本接口(DescribeAccountUsers)用于获取当前实例的全部账号。",
61
75
  "input": "DescribeAccountUsersRequest",
@@ -71,7 +85,7 @@
71
85
  "status": "online"
72
86
  },
73
87
  "DescribeBackupDownloadTask": {
74
- "document": "查询备份下载任务信息",
88
+ "document": "本接口(DescribeBackupDownloadTask)用于查询备份下载任务信息。",
75
89
  "input": "DescribeBackupDownloadTaskRequest",
76
90
  "name": "查询备份下载任务信息",
77
91
  "output": "DescribeBackupDownloadTaskResponse",
@@ -115,7 +129,7 @@
115
129
  "DescribeDBInstanceNamespace": {
116
130
  "document": "本接口(DescribeDBInstanceNamespace)用于查询数据库的表信息。",
117
131
  "input": "DescribeDBInstanceNamespaceRequest",
118
- "name": "查询实例的库表。",
132
+ "name": "查询实例的库表",
119
133
  "output": "DescribeDBInstanceNamespaceResponse",
120
134
  "status": "online"
121
135
  },
@@ -143,7 +157,7 @@
143
157
  "DescribeDBInstanceURL": {
144
158
  "document": "本接口(DescribeDBInstanceURL)用于获取指定实例的 URI 形式的连接串访问地址示例。",
145
159
  "input": "DescribeDBInstanceURLRequest",
146
- "name": "获取实例连接的URI",
160
+ "name": "获取实例连接的URI",
147
161
  "output": "DescribeDBInstanceURLResponse",
148
162
  "status": "online"
149
163
  },
@@ -155,7 +169,7 @@
155
169
  "status": "online"
156
170
  },
157
171
  "DescribeDetailedSlowLogs": {
158
- "document": "查询实例慢日志详情",
172
+ "document": "本接口(DescribeDetailedSlowLogs)用于查询实例慢日志详情。",
159
173
  "input": "DescribeDetailedSlowLogsRequest",
160
174
  "name": "查询实例慢日志详情",
161
175
  "output": "DescribeDetailedSlowLogsResponse",
@@ -168,6 +182,20 @@
168
182
  "output": "DescribeInstanceParamsResponse",
169
183
  "status": "online"
170
184
  },
185
+ "DescribeLogDownloadTasks": {
186
+ "document": "日志下载任务查询",
187
+ "input": "DescribeLogDownloadTasksRequest",
188
+ "name": "日志下载任务查询",
189
+ "output": "DescribeLogDownloadTasksResponse",
190
+ "status": "online"
191
+ },
192
+ "DescribeMongodbLogs": {
193
+ "document": "该接口(DescribeMongodbLogs)用于查询运行日志。",
194
+ "input": "DescribeMongodbLogsRequest",
195
+ "name": "日志查询接口",
196
+ "output": "DescribeMongodbLogsResponse",
197
+ "status": "online"
198
+ },
171
199
  "DescribeSecurityGroup": {
172
200
  "document": "本接口(DescribeSecurityGroup)用于查询实例绑定的安全组。",
173
201
  "input": "DescribeSecurityGroupRequest",
@@ -190,7 +218,7 @@
190
218
  "status": "online"
191
219
  },
192
220
  "DescribeSpecInfo": {
193
- "document": "本接口(DescribeSpecInfo)用于查询实例的售卖规格。",
221
+ "document": "本接口(DescribeSpecInfo)用于查询实例的售卖规格。",
194
222
  "input": "DescribeSpecInfoRequest",
195
223
  "name": "查询云数据库的售卖规格",
196
224
  "output": "DescribeSpecInfoResponse",
@@ -253,14 +281,14 @@
253
281
  "status": "online"
254
282
  },
255
283
  "IsolateDBInstance": {
256
- "document": "本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复,请谨慎操作。",
284
+ "document": "本接口(IsolateDBInstance)用于隔离 MongoDB 云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。已删除的按量计费实例无法恢复,请谨慎操作。",
257
285
  "input": "IsolateDBInstanceRequest",
258
286
  "name": "隔离云数据库实例",
259
287
  "output": "IsolateDBInstanceResponse",
260
288
  "status": "online"
261
289
  },
262
290
  "KillOps": {
263
- "document": "本接口(KillOps)用于终止MongoDB云数据库实例上执行的特定操作。",
291
+ "document": "本接口(KillOps)用于终止 MongoDB 云数据库实例上执行的特定操作。",
264
292
  "input": "KillOpsRequest",
265
293
  "name": "终止数据库实例特定操作",
266
294
  "output": "KillOpsResponse",
@@ -288,7 +316,7 @@
288
316
  "status": "online"
289
317
  },
290
318
  "ModifyDBInstanceSpec": {
291
- "document": "本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。",
319
+ "document": "本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格([DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567))获取。",
292
320
  "input": "ModifyDBInstanceSpecRequest",
293
321
  "name": "调整云数据库实例配置",
294
322
  "output": "ModifyDBInstanceSpecResponse",
@@ -323,14 +351,14 @@
323
351
  "status": "online"
324
352
  },
325
353
  "ResetDBInstancePassword": {
326
- "document": "修改实例用户的密码",
354
+ "document": "本接口(ResetDBInstancePassword)用于重置实例访问密码。",
327
355
  "input": "ResetDBInstancePasswordRequest",
328
356
  "name": "修改实例用户的密码",
329
357
  "output": "ResetDBInstancePasswordResponse",
330
358
  "status": "online"
331
359
  },
332
360
  "RestartNodes": {
333
- "document": "本接口用于重启数据库节点。",
361
+ "document": "本接口(RestartNodes)用于批量重启数据库节点。",
334
362
  "input": "RestartNodesRequest",
335
363
  "name": "重启数据库节点",
336
364
  "output": "RestartNodesResponse",
@@ -370,6 +398,20 @@
370
398
  "name": "包年包月退货退费",
371
399
  "output": "TerminateDBInstancesResponse",
372
400
  "status": "online"
401
+ },
402
+ "UpgradeDBInstanceKernelVersion": {
403
+ "document": "本接口(UpgradeDBInstanceKernelVersion)用于升级数据库实例内核版本。",
404
+ "input": "UpgradeDBInstanceKernelVersionRequest",
405
+ "name": "升级实例内核小版本号",
406
+ "output": "UpgradeDBInstanceKernelVersionResponse",
407
+ "status": "online"
408
+ },
409
+ "UpgradeDbInstanceVersion": {
410
+ "document": "本接口用于跨版本升级数据库内核。当前仅支持3.6版本升级为4.0版本、4.0版本升级为4.2版本、4.2版本升级为4.4版本及4.4版本升级为5.0版本。",
411
+ "input": "UpgradeDbInstanceVersionRequest",
412
+ "name": "升级数据库版本",
413
+ "output": "UpgradeDbInstanceVersionResponse",
414
+ "status": "online"
373
415
  }
374
416
  },
375
417
  "metadata": {
@@ -380,7 +422,7 @@
380
422
  },
381
423
  "objects": {
382
424
  "AddNodeList": {
383
- "document": "修改实例节点详情",
425
+ "document": "修改实例节点详情。",
384
426
  "members": [
385
427
  {
386
428
  "disabled": false,
@@ -393,7 +435,7 @@
393
435
  },
394
436
  {
395
437
  "disabled": false,
396
- "document": "节点所对应的可用区。\n- 单可用区,所有节点在同一可用区。\n- 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。",
438
+ "document": "节点所对应的可用区。当前支持的可用区,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。\n- 单可用区,所有节点在同一可用区。\n- 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。",
397
439
  "example": "ap-guangzhou-2",
398
440
  "member": "string",
399
441
  "name": "Zone",
@@ -417,7 +459,7 @@
417
459
  },
418
460
  {
419
461
  "disabled": false,
420
- "document": "项目ID,用户已创建项目的唯一ID。请在控制台账号中心的项目管理中复制项目 ID。",
462
+ "document": "项目ID,用户已创建项目的唯一ID。请在控制台账号中心的[项目管理](https://console.cloud.tencent.com/project)中复制项目 ID。",
421
463
  "example": "12",
422
464
  "member": "uint64",
423
465
  "name": "ProjectId",
@@ -454,7 +496,7 @@
454
496
  "members": [
455
497
  {
456
498
  "disabled": false,
457
- "document": "当前账号具有的权限信息。<ul><li>0:无权限。</li><li>1:只读。</li><li>2:只写。</li><li>3:读写。</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
499
+ "document": "当前账号具有的权限信息。\n- 0:无权限。\n- 1:只读。\n- 3:读写。\n注意:此字段可能返回 null,表示取不到有效值。",
458
500
  "example": "1",
459
501
  "member": "int64",
460
502
  "name": "Mask",
@@ -465,7 +507,7 @@
465
507
  },
466
508
  {
467
509
  "disabled": false,
468
- "document": "指具有当前账号权限的数据库名。\n<ul><li>* :表示所有数据库。</li><li>db.name:表示特定name的数据库。</li></ul>\n注意:此字段可能返回 null,表示取不到有效值。",
510
+ "document": "指具有当前账号权限的数据库名。\n- \\* :表示所有数据库。\n- db.name:表示特定 name 的数据库。\n注意:此字段可能返回 null,表示取不到有效值。",
469
511
  "example": "\"db_test\"",
470
512
  "member": "string",
471
513
  "name": "NameSpace",
@@ -482,7 +524,7 @@
482
524
  "members": [
483
525
  {
484
526
  "disabled": false,
485
- "document": "任务创建时间",
527
+ "document": "任务创建时间。",
486
528
  "example": "2021-01-02 15:04:05",
487
529
  "member": "string",
488
530
  "name": "CreateTime",
@@ -492,7 +534,7 @@
492
534
  },
493
535
  {
494
536
  "disabled": false,
495
- "document": "备份文件名",
537
+ "document": "备份文件名。",
496
538
  "example": "cmgo-74sj****_2021-03-24 15:40",
497
539
  "member": "string",
498
540
  "name": "BackupName",
@@ -502,7 +544,7 @@
502
544
  },
503
545
  {
504
546
  "disabled": false,
505
- "document": "分片名称",
547
+ "document": "分片名称。",
506
548
  "example": "cmgo-74sj****_0",
507
549
  "member": "string",
508
550
  "name": "ReplicaSetId",
@@ -512,7 +554,7 @@
512
554
  },
513
555
  {
514
556
  "disabled": false,
515
- "document": "备份数据大小,单位为字节",
557
+ "document": "备份数据大小,单位:字节。",
516
558
  "example": "102400",
517
559
  "member": "int64",
518
560
  "name": "BackupSize",
@@ -522,7 +564,7 @@
522
564
  },
523
565
  {
524
566
  "disabled": false,
525
- "document": "任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试",
567
+ "document": "任务状态。\n- 0:等待执行。\n- 1:正在下载。\n- 2:下载完成。\n- 3:下载失败。\n- 4:等待重试。",
526
568
  "example": "0",
527
569
  "member": "int64",
528
570
  "name": "Status",
@@ -532,7 +574,7 @@
532
574
  },
533
575
  {
534
576
  "disabled": false,
535
- "document": "任务进度百分比",
577
+ "document": "任务进度百分比。",
536
578
  "example": "20",
537
579
  "member": "int64",
538
580
  "name": "Percent",
@@ -542,7 +584,7 @@
542
584
  },
543
585
  {
544
586
  "disabled": false,
545
- "document": "耗时,单位为秒",
587
+ "document": "耗时,单位为秒。",
546
588
  "example": "60",
547
589
  "member": "int64",
548
590
  "name": "TimeSpend",
@@ -552,7 +594,7 @@
552
594
  },
553
595
  {
554
596
  "disabled": false,
555
- "document": "备份数据下载链接",
597
+ "document": "备份数据下载链接。",
556
598
  "example": "http://cmgo-****.b.c/d.tar?e",
557
599
  "member": "string",
558
600
  "name": "Url",
@@ -562,7 +604,7 @@
562
604
  },
563
605
  {
564
606
  "disabled": false,
565
- "document": "备份文件备份类型,0-逻辑备份,1-物理备份",
607
+ "document": "备份方式。\n- 0:逻辑备份。\n- 1:物理备份。\n- 3:快照备份。\n**说明**:\n1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。\n2. 实例开通存储加密,则备份方式不能为物理备份。",
566
608
  "example": "1",
567
609
  "member": "int64",
568
610
  "name": "BackupMethod",
@@ -572,7 +614,7 @@
572
614
  },
573
615
  {
574
616
  "disabled": false,
575
- "document": "发起备份时指定的备注信息",
617
+ "document": "发起备份时指定的备注信息。",
576
618
  "example": "我的备份",
577
619
  "member": "string",
578
620
  "name": "BackupDesc",
@@ -604,25 +646,25 @@
604
646
  "usage": "out"
605
647
  },
606
648
  "BackupDownloadTaskStatus": {
607
- "document": "创建备份下载任务结果",
649
+ "document": "创建备份下载任务结果。",
608
650
  "members": [
609
651
  {
610
652
  "disabled": false,
611
- "document": "分片名",
653
+ "document": "分片名。",
612
654
  "example": "cmgo-74sjf5mt_0",
613
655
  "member": "string",
614
656
  "name": "ReplicaSetId",
615
- "required": true,
657
+ "output_required": true,
616
658
  "type": "string",
617
659
  "value_allowed_null": false
618
660
  },
619
661
  {
620
662
  "disabled": false,
621
- "document": "任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试",
663
+ "document": "任务当前状态。\n- 0:等待执行。\n- 1:正在下载。\n- 2:下载完成。\n- 3:下载失败。\n- 4:等待重试。",
622
664
  "example": "0",
623
665
  "member": "int64",
624
666
  "name": "Status",
625
- "required": true,
667
+ "output_required": true,
626
668
  "type": "int",
627
669
  "value_allowed_null": false
628
670
  }
@@ -630,7 +672,7 @@
630
672
  "usage": "out"
631
673
  },
632
674
  "BackupInfo": {
633
- "document": "备份信息",
675
+ "document": "备份信息。",
634
676
  "members": [
635
677
  {
636
678
  "disabled": false,
@@ -644,7 +686,7 @@
644
686
  },
645
687
  {
646
688
  "disabled": false,
647
- "document": "备份方式,0-自动备份,1-手动备份",
689
+ "document": "备份方式。\n- 0:自动备份。\n- 1:手动备份。",
648
690
  "example": "0",
649
691
  "member": "uint64",
650
692
  "name": "BackupType",
@@ -654,7 +696,7 @@
654
696
  },
655
697
  {
656
698
  "disabled": false,
657
- "document": "备份名称",
699
+ "document": "备份文件名称。",
658
700
  "example": "cmgo-ca2n****_2021-12-13 02:02",
659
701
  "member": "string",
660
702
  "name": "BackupName",
@@ -664,7 +706,7 @@
664
706
  },
665
707
  {
666
708
  "disabled": false,
667
- "document": "备份备注",
709
+ "document": "备份任务备注信息。",
668
710
  "example": "系统后台每日定时自动备份",
669
711
  "member": "string",
670
712
  "name": "BackupDesc",
@@ -674,7 +716,7 @@
674
716
  },
675
717
  {
676
718
  "disabled": false,
677
- "document": "备份文件大小,单位KB",
719
+ "document": "备份文件大小,单位:KB",
678
720
  "example": "326594030",
679
721
  "member": "uint64",
680
722
  "name": "BackupSize",
@@ -684,7 +726,7 @@
684
726
  },
685
727
  {
686
728
  "disabled": false,
687
- "document": "备份开始时间",
729
+ "document": "备份开始时间。",
688
730
  "example": "2021-12-13 02:02:51",
689
731
  "member": "string",
690
732
  "name": "StartTime",
@@ -694,7 +736,7 @@
694
736
  },
695
737
  {
696
738
  "disabled": false,
697
- "document": "备份结束时间",
739
+ "document": "备份结束时间。",
698
740
  "example": "2021-12-13 03:02:51",
699
741
  "member": "string",
700
742
  "name": "EndTime",
@@ -704,7 +746,7 @@
704
746
  },
705
747
  {
706
748
  "disabled": false,
707
- "document": "备份状态,1-备份中,2-备份成功",
749
+ "document": "备份状态。\n- 1:备份中。\n- 2:备份成功。",
708
750
  "example": "2",
709
751
  "member": "uint64",
710
752
  "name": "Status",
@@ -714,7 +756,7 @@
714
756
  },
715
757
  {
716
758
  "disabled": false,
717
- "document": "备份方法,0-逻辑备份,1-物理备份",
759
+ "document": "备份方式。\n- 0:逻辑备份。\n- 1:物理备份。\n- 3:快照备份。\n**说明:**\n- 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。\n- 实例开通存储加密,则备份方式不能为物理备份。",
718
760
  "example": "0",
719
761
  "member": "uint64",
720
762
  "name": "BackupMethod",
@@ -724,7 +766,7 @@
724
766
  },
725
767
  {
726
768
  "disabled": false,
727
- "document": "备份记录id",
769
+ "document": "备份记录 ID。",
728
770
  "example": "6997433",
729
771
  "member": "int64",
730
772
  "name": "BackId",
@@ -734,7 +776,7 @@
734
776
  },
735
777
  {
736
778
  "disabled": false,
737
- "document": "备份删除时间",
779
+ "document": "备份删除时间。",
738
780
  "example": "2099-01-01 00:00:00",
739
781
  "member": "string",
740
782
  "name": "DeleteTime",
@@ -744,13 +786,23 @@
744
786
  },
745
787
  {
746
788
  "disabled": false,
747
- "document": "异地备份地域",
789
+ "document": "异地备份地域。",
748
790
  "example": "ap-guangzhou",
749
791
  "member": "string",
750
792
  "name": "BackupRegion",
751
793
  "output_required": false,
752
794
  "type": "string",
753
795
  "value_allowed_null": false
796
+ },
797
+ {
798
+ "disabled": false,
799
+ "document": "备份支持的回档时间。",
800
+ "example": "2021-12-13 03:02:51",
801
+ "member": "string",
802
+ "name": "RestoreTime",
803
+ "output_required": false,
804
+ "type": "string",
805
+ "value_allowed_null": false
754
806
  }
755
807
  ],
756
808
  "usage": "out"
@@ -760,31 +812,31 @@
760
812
  "members": [
761
813
  {
762
814
  "disabled": false,
763
- "document": "连接的客户端IP",
815
+ "document": "连接的客户端 IP",
764
816
  "example": "192.168.1.1",
765
817
  "member": "string",
766
818
  "name": "IP",
767
- "required": true,
819
+ "output_required": true,
768
820
  "type": "string",
769
821
  "value_allowed_null": false
770
822
  },
771
823
  {
772
824
  "disabled": false,
773
- "document": "对应客户端IP的连接数",
825
+ "document": "对应客户端 IP 的连接数。",
774
826
  "example": "9",
775
827
  "member": "uint64",
776
828
  "name": "Count",
777
- "required": true,
829
+ "output_required": true,
778
830
  "type": "int",
779
831
  "value_allowed_null": false
780
832
  },
781
833
  {
782
834
  "disabled": false,
783
- "document": "是否为内部ip",
835
+ "document": "是否为内部 IP。",
784
836
  "example": "true",
785
837
  "member": "bool",
786
838
  "name": "InternalService",
787
- "required": true,
839
+ "output_required": true,
788
840
  "type": "bool",
789
841
  "value_allowed_null": false
790
842
  }
@@ -805,7 +857,7 @@
805
857
  },
806
858
  {
807
859
  "disabled": false,
808
- "document": "新账号名称。其格式要求如下:<ul><li>字符范围[1,32]。</li><li>可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。</li></ul>",
860
+ "document": "新账号名称。其格式要求如下:\n- 字符范围[1,64]。\n- 可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“\\_”与短划线“-”。",
809
861
  "example": "mong_test",
810
862
  "member": "string",
811
863
  "name": "UserName",
@@ -814,8 +866,8 @@
814
866
  },
815
867
  {
816
868
  "disabled": false,
817
- "document": "新账号密码。密码复杂度要求如下:<ul><li>字符长度范围[8,32]。</li><li>至少包含字母、数字和特殊字符(叹号“!”、at\"@\"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。</li></ul>",
818
- "example": "abc123!@",
869
+ "document": "新账号密码。密码复杂度要求如下:\n- 字符长度范围[8,32]。\n- 至少包含字母、数字和特殊字符(叹号“!”、at\"@\"、井号“#”、百分号“%”、插入符“^”、星号“\\*”、小括号“()”、下划线“\\_”)中的两种。",
870
+ "example": "password",
819
871
  "member": "string",
820
872
  "name": "Password",
821
873
  "required": true,
@@ -824,10 +876,10 @@
824
876
  {
825
877
  "disabled": false,
826
878
  "document": "mongouser 账号对应的密码。mongouser 为系统默认账号,即为创建实例时,设置的密码。",
827
- "example": "Abc123...",
879
+ "example": "password...",
828
880
  "member": "string",
829
881
  "name": "MongoUserPassword",
830
- "required": true,
882
+ "required": false,
831
883
  "type": "string"
832
884
  },
833
885
  {
@@ -887,7 +939,7 @@
887
939
  },
888
940
  {
889
941
  "disabled": false,
890
- "document": "设置备份方式。\n- 0:逻辑备份。\n- 1:物理备份。",
942
+ "document": "设置备份方式。\n- 0:逻辑备份。\n- 1:物理备份。\n- 3:快照备份。\n**说明**:\n1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。\n2. 实例开通存储加密,则备份方式不能为物理备份。",
891
943
  "example": "0",
892
944
  "member": "int64",
893
945
  "name": "BackupMethod",
@@ -933,7 +985,7 @@
933
985
  "members": [
934
986
  {
935
987
  "disabled": false,
936
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。",
988
+ "document": "实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
937
989
  "example": "cmgo-f555zzzz",
938
990
  "member": "string",
939
991
  "name": "InstanceId",
@@ -942,7 +994,7 @@
942
994
  },
943
995
  {
944
996
  "disabled": false,
945
- "document": "要下载的备份文件名,可通过DescribeDBBackups接口获取。",
997
+ "document": "要下载的备份文件名。请通过 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 接口获取。",
946
998
  "example": "cmgo-74sjf5mt_2021-03-24 15:40",
947
999
  "member": "string",
948
1000
  "name": "BackupName",
@@ -951,7 +1003,7 @@
951
1003
  },
952
1004
  {
953
1005
  "disabled": false,
954
- "document": "指定要下载的副本集的节点名称 分片集群的分片名称列表。\n如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。\n如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。",
1006
+ "document": "指定要下载的副本集节点 ID 或分片集群的分片节点 ID 列表。\n- 如副本集实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。\n- 如分片集群实例 ID 为 cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据。分片集群如需全量下载,请按示例方式传入全部分片名称。",
955
1007
  "example": "无",
956
1008
  "member": "ReplicaSetInfo",
957
1009
  "name": "BackupSets",
@@ -966,7 +1018,7 @@
966
1018
  "members": [
967
1019
  {
968
1020
  "disabled": false,
969
- "document": "下载任务状态",
1021
+ "document": "下载任务状态。",
970
1022
  "example": "无",
971
1023
  "member": "BackupDownloadTaskStatus",
972
1024
  "name": "Tasks",
@@ -1024,7 +1076,7 @@
1024
1076
  },
1025
1077
  {
1026
1078
  "disabled": false,
1027
- "document": "指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。",
1079
+ "document": "指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
1028
1080
  "example": "MONGO_44_WT",
1029
1081
  "member": "string",
1030
1082
  "name": "MongoVersion",
@@ -1042,7 +1094,7 @@
1042
1094
  },
1043
1095
  {
1044
1096
  "disabled": false,
1045
- "document": "实例数量,最小值1,最大值为10。",
1097
+ "document": "实例数量,最小值1,最大值为30。",
1046
1098
  "example": "1",
1047
1099
  "member": "uint64",
1048
1100
  "name": "GoodsNum",
@@ -1069,7 +1121,7 @@
1069
1121
  },
1070
1122
  {
1071
1123
  "disabled": false,
1072
- "document": "私有网络ID。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询确认正确的ID。 示例值:vpc-pxyzim13",
1124
+ "document": "私有网络ID。\n- 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。\n- 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。",
1073
1125
  "example": "vpc-k515****",
1074
1126
  "member": "string",
1075
1127
  "name": "VpcId",
@@ -1078,7 +1130,7 @@
1078
1130
  },
1079
1131
  {
1080
1132
  "disabled": false,
1081
- "document": "私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID 示例值:subnet-7jbabche",
1133
+ "document": "私有网络 VPC 的子网 ID。\n- 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。\n- 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。",
1082
1134
  "example": "subnet-60dr****",
1083
1135
  "member": "string",
1084
1136
  "name": "SubnetId",
@@ -1114,7 +1166,7 @@
1114
1166
  },
1115
1167
  {
1116
1168
  "disabled": false,
1117
- "document": "实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:克隆实例,注意:克隆实例RestoreTime为必填项。",
1169
+ "document": "实例类型。\n- 1:正式实例。\n- 3:只读实例。\n- 4:灾备实例。\n- 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。",
1118
1170
  "example": "1",
1119
1171
  "member": "int64",
1120
1172
  "name": "Clone",
@@ -1123,7 +1175,7 @@
1123
1175
  },
1124
1176
  {
1125
1177
  "disabled": false,
1126
- "document": "父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。",
1178
+ "document": "父实例 ID。\n- 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。\n- 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。",
1127
1179
  "example": "cmgo-nh1o****",
1128
1180
  "member": "string",
1129
1181
  "name": "Father",
@@ -1132,8 +1184,8 @@
1132
1184
  },
1133
1185
  {
1134
1186
  "disabled": false,
1135
- "document": "安全组 ID。",
1136
- "example": "sg-abc****",
1187
+ "document": "安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。",
1188
+ "example": "[\"sg-1s3c****\"]",
1137
1189
  "member": "string",
1138
1190
  "name": "SecurityGroup",
1139
1191
  "required": false,
@@ -1150,8 +1202,8 @@
1150
1202
  },
1151
1203
  {
1152
1204
  "disabled": false,
1153
- "document": "实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- ",
1154
- "example": "testInstance",
1205
+ "document": "实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\\_、分隔符\\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。\n- 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。\n- 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。\n- 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\\_node{R:12}\\_db,设置批量购买数量为5,则实例名称为 cmgo10\\_node12\\_db, cmgo11\\_node13\\_db, cmgo12\\_node14\\_db, cmgo13\\_node15\\_db, cluster14\\_node16\\_db. ",
1206
+ "example": "testInstance_{R:3}",
1155
1207
  "member": "string",
1156
1208
  "name": "InstanceName",
1157
1209
  "required": false,
@@ -1159,7 +1211,7 @@
1159
1211
  },
1160
1212
  {
1161
1213
  "disabled": false,
1162
- "document": "若多可用区部署云数据库实例,指定多可用区列表。\n- 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。\n- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。\n- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。\n",
1214
+ "document": "若多可用区部署云数据库实例,指定多可用区列表。\n- 多可用区部署实例,参数 **Zone** 指定实例主可用区信息;**AvailabilityZoneList** 指定所有可用区信息,包含主可用区。输入格式如:[ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]。\n- 通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 可获取云数据库不同地域规划的可用区信息,以便指定有效的可用区。\n- 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。",
1163
1215
  "example": "[\"ap-guangzhou-2\",\"ap-guangzhou-3\",\"ap-guangzhou-4\"]",
1164
1216
  "member": "string",
1165
1217
  "name": "AvailabilityZoneList",
@@ -1168,7 +1220,7 @@
1168
1220
  },
1169
1221
  {
1170
1222
  "disabled": false,
1171
- "document": "Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。\n",
1223
+ "document": "Mongos CPU 核数,支持1、2、4、8、16。购买分片集群时,必须填写。",
1172
1224
  "example": "1",
1173
1225
  "member": "uint64",
1174
1226
  "name": "MongosCpu",
@@ -1177,7 +1229,7 @@
1177
1229
  },
1178
1230
  {
1179
1231
  "disabled": false,
1180
- "document": "Mongos 内存大小。\n- 购买分片集群时,必须填写。\n- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB。\n\n",
1232
+ "document": "Mongos 内存大小。\n- 购买分片集群时,必须填写。\n- 单位:GB,支持1核2GB、2核4GB、4核8GB、8核16GB、16核32GB",
1181
1233
  "example": "2",
1182
1234
  "member": "uint64",
1183
1235
  "name": "MongosMemory",
@@ -1222,7 +1274,7 @@
1222
1274
  },
1223
1275
  {
1224
1276
  "disabled": false,
1225
- "document": "参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本。",
1277
+ "document": "参数模板 ID。\n- 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。\n- 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。",
1226
1278
  "example": "tpl-0vswu****",
1227
1279
  "member": "string",
1228
1280
  "name": "ParamTemplateId",
@@ -1278,7 +1330,7 @@
1278
1330
  },
1279
1331
  {
1280
1332
  "disabled": false,
1281
- "document": "版本号,该参数模板支持的售卖版本请参照查询云数据库的售卖规格(DescribeSpecInfo)返回结果。参数与版本对应关系是:MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。当MirrorTplId为空时,该字段必填。",
1333
+ "document": "参数模板版本号。当**MirrorTplId**为空时,该字段必填。参数模板支持的售卖版本,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/35767) 获取。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
1282
1334
  "example": "MONGO_42_WT",
1283
1335
  "member": "string",
1284
1336
  "name": "MongoVersion",
@@ -1287,7 +1339,7 @@
1287
1339
  },
1288
1340
  {
1289
1341
  "disabled": false,
1290
- "document": "实例类型,REPLSET-副本集,SHARD-分片集群,STANDALONE-单节点\n当MirrorTplId为空时,该字段必填。",
1342
+ "document": "实例类型。当 MirrorTplId 为空值时,该参数必填。\n- REPLSET:副本集实例。\n- SHARD:分片实例。\n- STANDALONE:单节点实例。",
1291
1343
  "example": "SHARD",
1292
1344
  "member": "string",
1293
1345
  "name": "ClusterType",
@@ -1305,7 +1357,7 @@
1305
1357
  },
1306
1358
  {
1307
1359
  "disabled": false,
1308
- "document": "模板参数,若为空,则以系统默认模板作为新版本参数。",
1360
+ "document": "模板参数,若不配置该参数,则以系统默认模板作为新版本参数。",
1309
1361
  "example": "无",
1310
1362
  "member": "ParamType",
1311
1363
  "name": "Params",
@@ -1314,8 +1366,8 @@
1314
1366
  },
1315
1367
  {
1316
1368
  "disabled": false,
1317
- "document": "镜像模板ID,若该字段不为空,则以该模板为镜像,克隆出一个新的模板。注意:MirrorTplId不为空时,MongoVersion及ClusterType将以MirrorTpl模板的版本及实例类型为准。",
1318
- "example": "tpl-sdah144hg",
1369
+ "document": "镜像模板 ID。若指定镜像模板,则以该模板为镜像,克隆出一个新的模板。\n**注意**:MirrorTplId 不为空值时,MongoVersion ClusterType 将以 MirrorTpl 模板的版本及实例类型为准。",
1370
+ "example": "tpl-sdah1****",
1319
1371
  "member": "string",
1320
1372
  "name": "MirrorTplId",
1321
1373
  "required": false,
@@ -1378,7 +1430,7 @@
1378
1430
  },
1379
1431
  {
1380
1432
  "disabled": false,
1381
- "document": "指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。",
1433
+ "document": "指版本信息。具体支持的版本信息 ,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
1382
1434
  "example": "MONGO_44_WT",
1383
1435
  "member": "string",
1384
1436
  "name": "MongoVersion",
@@ -1387,7 +1439,7 @@
1387
1439
  },
1388
1440
  {
1389
1441
  "disabled": false,
1390
- "document": "实例数量, 最小值1,最大值为10。",
1442
+ "document": "实例数量, 最小值1,最大值为30。",
1391
1443
  "example": "1",
1392
1444
  "member": "uint64",
1393
1445
  "name": "GoodsNum",
@@ -1405,7 +1457,7 @@
1405
1457
  },
1406
1458
  {
1407
1459
  "disabled": false,
1408
- "document": "指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。\n",
1460
+ "document": "指定购买实例的购买时长。取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。",
1409
1461
  "example": "1",
1410
1462
  "member": "uint64",
1411
1463
  "name": "Period",
@@ -1450,7 +1502,7 @@
1450
1502
  },
1451
1503
  {
1452
1504
  "disabled": false,
1453
- "document": "私有网络ID。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)查询确认正确的ID。 示例值:vpc-pxyzim13",
1505
+ "document": "私有网络 ID。\n- 仅支持配置私有网络,必须选择一个与实例同一地域的私有网络。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的私有网络 ID。\n- 实例创建成功之后,支持更换私有网络。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。",
1454
1506
  "example": "vpc-0akb****",
1455
1507
  "member": "string",
1456
1508
  "name": "VpcId",
@@ -1459,7 +1511,7 @@
1459
1511
  },
1460
1512
  {
1461
1513
  "disabled": false,
1462
- "document": "私有网络VPC的子网。请登录 [私有网络控制台](https://console.cloud.tencent.com/vpc) 查询子网列表确认正确的 ID 示例值:subnet-7jbabche",
1514
+ "document": "私有网络 VPC 的子网 ID。\n- 必须在已选的私有网络内指定一个子网。请登录[私有网络控制台](https://console.cloud.tencent.com/vpc)获取可使用的子网 ID。\n- 实例创建成功之后,支持更换私有网络及子网。具体操作,请参见[更换网络](https://cloud.tencent.com/document/product/239/30910)。",
1463
1515
  "example": "subnet-fyrt****",
1464
1516
  "member": "string",
1465
1517
  "name": "SubnetId",
@@ -1504,7 +1556,7 @@
1504
1556
  },
1505
1557
  {
1506
1558
  "disabled": false,
1507
- "document": "实例类型。- 1:正式实例。- 3:只读实例。- 4:灾备实例。-5:整实例克隆,注意:克隆实例时,RestoreTime为必填项。",
1559
+ "document": "实例类型。\n- 1:正式实例。\n- 3:只读实例。\n- 4:灾备实例。\n- 5:克隆实例。注意:克隆实例 RestoreTime 为必填项。",
1508
1560
  "example": "1",
1509
1561
  "member": "int64",
1510
1562
  "name": "Clone",
@@ -1513,7 +1565,7 @@
1513
1565
  },
1514
1566
  {
1515
1567
  "disabled": false,
1516
- "document": "父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。",
1568
+ "document": "父实例 ID。\n- 当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。\n- 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制父实例 ID。",
1517
1569
  "example": "cmgo-nh1o****",
1518
1570
  "member": "string",
1519
1571
  "name": "Father",
@@ -1522,8 +1574,8 @@
1522
1574
  },
1523
1575
  {
1524
1576
  "disabled": false,
1525
- "document": "安全组 ID。 ",
1526
- "example": "sg-di48****",
1577
+ "document": "安全组 ID。 请登录[安全组控制台](https://console.cloud.tencent.com/vpc/security-group)页面获取与数据库实例同地域的安全组 ID。",
1578
+ "example": "[\"sg-di48****\"]",
1527
1579
  "member": "string",
1528
1580
  "name": "SecurityGroup",
1529
1581
  "required": false,
@@ -1540,8 +1592,8 @@
1540
1592
  },
1541
1593
  {
1542
1594
  "disabled": false,
1543
- "document": "实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- ",
1544
- "example": "myInstance",
1595
+ "document": "实例名称。仅支持长度为128个字符的中文、英文、数字、下划线\\_、分隔符\\-。批量购买数据库实例时,支持通过自定义命名模式串与数字后缀自动升序功能,高效设置实例名称。\n- 基础模式:前缀+自动升序编号(默认从1开始),**lnstanceName**仅需自定义实例名称前缀,例如设置为:cmgo,设置购买数量为5,则购买后,实例名称依次分别为cmgo1、cmgo2、cmgo3、cmgo4、cmgo5。\n- 自定义起始序号模式:前缀+{R:x}(x为自定义起始序号)。**InstanceName**需填写“前缀{R:x}”,例如:cmgo{R:3},设置购买数量为5,则实例名称为cmgo3、cmgo4、cmgo5、cmgo6、cmgo7。\n- 复合模式串:前缀1{R:x}+前缀2{R:y}+ ⋯+固定后缀,x与y分别为每一段前缀的起始序号。**instanceName**需填写复合模式串,例如:cmgo{R:10}\\_node{R:12}\\_db,设置批量购买数量为5,则实例名称为 cmgo10\\_node12\\_db, cmgo11\\_node13\\_db, cmgo12\\_node14\\_db, cmgo13\\_node15\\_db, cluster14\\_node16\\_db. ",
1596
+ "example": "myInstance_{R:3}",
1545
1597
  "member": "string",
1546
1598
  "name": "InstanceName",
1547
1599
  "required": false,
@@ -1612,7 +1664,7 @@
1612
1664
  },
1613
1665
  {
1614
1666
  "disabled": false,
1615
- "document": "参数模板 ID。参数模板是一组 MongoDB 的参数并为预设置了参数值的集合,将一组有相同诉求的参数及值 存为模板,在创建实例时,可直接引用参数值到新实例。合理使用参数模板,可以提高MongoDB数据库的效率。模板列表从 DescribeDBInstanceParamTpl 接口获取,注意模板支持的版本及实例类型。",
1667
+ "document": "参数模板 ID。\n- 参数模板是预置了特定参数值的集合,可用于快速配置新的 MongoDB 实例。合理使用参数模板,能有效提升数据库的部署效率与运行性能。\n- 参数模板 ID 可通过 [DescribeDBInstanceParamTpl ](https://cloud.tencent.com/document/product/240/109155)接口获取。请选择与实例版本与架构所对应的参数模板 ID。",
1616
1668
  "example": "tpl-0vswu****",
1617
1669
  "member": "string",
1618
1670
  "name": "ParamTemplateId",
@@ -1654,13 +1706,122 @@
1654
1706
  ],
1655
1707
  "type": "object"
1656
1708
  },
1709
+ "CreateLogDownloadTaskRequest": {
1710
+ "document": "CreateLogDownloadTask请求参数结构体",
1711
+ "members": [
1712
+ {
1713
+ "disabled": false,
1714
+ "document": "实例ID",
1715
+ "example": "cmgo-b6nit818p",
1716
+ "member": "string",
1717
+ "name": "InstanceId",
1718
+ "required": true,
1719
+ "type": "string"
1720
+ },
1721
+ {
1722
+ "disabled": false,
1723
+ "document": "开始时间",
1724
+ "example": "2023-03-02 10:51:21",
1725
+ "member": "string",
1726
+ "name": "StartTime",
1727
+ "required": true,
1728
+ "type": "string"
1729
+ },
1730
+ {
1731
+ "disabled": false,
1732
+ "document": "结束时间",
1733
+ "example": "2023-03-0310:51:21",
1734
+ "member": "string",
1735
+ "name": "EndTime",
1736
+ "required": true,
1737
+ "type": "string"
1738
+ },
1739
+ {
1740
+ "disabled": false,
1741
+ "document": "节点名称",
1742
+ "example": "[\"cmgo-xxx_0-node-primary\"]",
1743
+ "member": "string",
1744
+ "name": "NodeNames",
1745
+ "required": false,
1746
+ "type": "list"
1747
+ },
1748
+ {
1749
+ "disabled": false,
1750
+ "document": "日志类别",
1751
+ "example": "[\"COMMAND\"]",
1752
+ "member": "string",
1753
+ "name": "LogComponents",
1754
+ "required": false,
1755
+ "type": "list"
1756
+ },
1757
+ {
1758
+ "disabled": false,
1759
+ "document": "日志等级",
1760
+ "example": "[\"WARNING\"]",
1761
+ "member": "string",
1762
+ "name": "LogLevels",
1763
+ "required": false,
1764
+ "type": "list"
1765
+ },
1766
+ {
1767
+ "disabled": false,
1768
+ "document": "日志ID",
1769
+ "example": "[\"5626700\"]",
1770
+ "member": "string",
1771
+ "name": "LogIds",
1772
+ "required": false,
1773
+ "type": "list"
1774
+ },
1775
+ {
1776
+ "disabled": false,
1777
+ "document": "日志连接信息",
1778
+ "example": "[\"conn268164\"]",
1779
+ "member": "string",
1780
+ "name": "LogConnections",
1781
+ "required": false,
1782
+ "type": "list"
1783
+ },
1784
+ {
1785
+ "disabled": false,
1786
+ "document": "日志详情过滤字段",
1787
+ "example": "[\"*\"]",
1788
+ "member": "string",
1789
+ "name": "LogDetailParams",
1790
+ "required": false,
1791
+ "type": "list"
1792
+ }
1793
+ ],
1794
+ "type": "object"
1795
+ },
1796
+ "CreateLogDownloadTaskResponse": {
1797
+ "document": "CreateLogDownloadTask返回参数结构体",
1798
+ "members": [
1799
+ {
1800
+ "disabled": false,
1801
+ "document": "任务状态",
1802
+ "example": "0",
1803
+ "member": "int64",
1804
+ "name": "Status",
1805
+ "output_required": false,
1806
+ "type": "int",
1807
+ "value_allowed_null": false
1808
+ },
1809
+ {
1810
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1811
+ "member": "string",
1812
+ "name": "RequestId",
1813
+ "type": "string"
1814
+ }
1815
+ ],
1816
+ "type": "object"
1817
+ },
1657
1818
  "CurrentOp": {
1658
1819
  "document": "云数据库实例当前操作",
1659
1820
  "members": [
1660
1821
  {
1661
1822
  "disabled": false,
1662
1823
  "document": "操作序号。",
1663
- "example": "-130987****",
1824
+ "example": "1804858933",
1664
1825
  "member": "int64",
1665
1826
  "name": "OpId",
1666
1827
  "output_required": true,
@@ -1689,7 +1850,7 @@
1689
1850
  },
1690
1851
  {
1691
1852
  "disabled": false,
1692
- "document": "操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command",
1853
+ "document": "操作类型。\n- none:特殊状态,空闲连接或内部任务等。\n- update:更新数据。\n- insert:插入操作。\n- query:查询操作。\n- command:命令操作。\n- getmore:获取更多数据。\n- remove:删除操作。\n- killcursors:释放查询游标的操作。",
1693
1854
  "example": "update",
1694
1855
  "member": "string",
1695
1856
  "name": "Op",
@@ -1729,7 +1890,7 @@
1729
1890
  },
1730
1891
  {
1731
1892
  "disabled": false,
1732
- "document": "筛选条件,节点状态,可能的取值为:Primary、Secondary。",
1893
+ "document": "节点角色。\n- primary:主节点。\n- secondary:从节点。",
1733
1894
  "example": "Secondary",
1734
1895
  "member": "string",
1735
1896
  "name": "State",
@@ -1740,7 +1901,7 @@
1740
1901
  {
1741
1902
  "disabled": false,
1742
1903
  "document": "操作已执行时间(ms)。",
1743
- "example": "MicrosecsRunning",
1904
+ "example": "30353723",
1744
1905
  "member": "uint64",
1745
1906
  "name": "MicrosecsRunning",
1746
1907
  "output_required": true,
@@ -1791,7 +1952,7 @@
1791
1952
  "members": [
1792
1953
  {
1793
1954
  "disabled": false,
1794
- "document": "单价",
1955
+ "document": "实例单价。单位:元。",
1795
1956
  "example": "0.17",
1796
1957
  "member": "float",
1797
1958
  "name": "UnitPrice",
@@ -1802,7 +1963,7 @@
1802
1963
  },
1803
1964
  {
1804
1965
  "disabled": false,
1805
- "document": "原价",
1966
+ "document": "实例原价。单位:元。",
1806
1967
  "example": "210",
1807
1968
  "member": "float",
1808
1969
  "name": "OriginalPrice",
@@ -1813,7 +1974,7 @@
1813
1974
  },
1814
1975
  {
1815
1976
  "disabled": false,
1816
- "document": "折扣价",
1977
+ "document": "实例折扣价。单位:元。",
1817
1978
  "example": "198",
1818
1979
  "member": "float",
1819
1980
  "name": "DiscountPrice",
@@ -1906,6 +2067,52 @@
1906
2067
  ],
1907
2068
  "type": "object"
1908
2069
  },
2070
+ "DeleteLogDownloadTaskRequest": {
2071
+ "document": "DeleteLogDownloadTask请求参数结构体",
2072
+ "members": [
2073
+ {
2074
+ "disabled": false,
2075
+ "document": "实例 ID",
2076
+ "example": "cmgo-b6nit818p",
2077
+ "member": "string",
2078
+ "name": "InstanceId",
2079
+ "required": true,
2080
+ "type": "string"
2081
+ },
2082
+ {
2083
+ "disabled": false,
2084
+ "document": "任务ID",
2085
+ "example": "1373039ed2ee07bcd6ae1d5e",
2086
+ "member": "string",
2087
+ "name": "TaskId",
2088
+ "required": true,
2089
+ "type": "string"
2090
+ }
2091
+ ],
2092
+ "type": "object"
2093
+ },
2094
+ "DeleteLogDownloadTaskResponse": {
2095
+ "document": "DeleteLogDownloadTask返回参数结构体",
2096
+ "members": [
2097
+ {
2098
+ "disabled": false,
2099
+ "document": "任务状态,0:成功",
2100
+ "example": "0",
2101
+ "member": "int64",
2102
+ "name": "Status",
2103
+ "output_required": true,
2104
+ "type": "int",
2105
+ "value_allowed_null": false
2106
+ },
2107
+ {
2108
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
2109
+ "member": "string",
2110
+ "name": "RequestId",
2111
+ "type": "string"
2112
+ }
2113
+ ],
2114
+ "type": "object"
2115
+ },
1909
2116
  "DescribeAccountUsersRequest": {
1910
2117
  "document": "DescribeAccountUsers请求参数结构体",
1911
2118
  "members": [
@@ -1947,7 +2154,7 @@
1947
2154
  "members": [
1948
2155
  {
1949
2156
  "disabled": false,
1950
- "document": "异步请求Id,涉及到异步流程的接口返回,如CreateBackupDBInstance",
2157
+ "document": "指定需查询的异步请求 ID。当接口操作涉及异步流程时(如 [CreateBackupDBInstance](https://cloud.tencent.com/document/product/240/46599)),其返回值中的 AsyncRequestId 即为本参数所需填入的 ID。",
1951
2158
  "example": "4762",
1952
2159
  "member": "string",
1953
2160
  "name": "AsyncRequestId",
@@ -1970,6 +2177,26 @@
1970
2177
  "type": "string",
1971
2178
  "value_allowed_null": false
1972
2179
  },
2180
+ {
2181
+ "disabled": false,
2182
+ "document": "任务执行开始时间。",
2183
+ "example": "2022-05-30 15:00:00",
2184
+ "member": "string",
2185
+ "name": "StartTime",
2186
+ "output_required": false,
2187
+ "type": "string",
2188
+ "value_allowed_null": false
2189
+ },
2190
+ {
2191
+ "disabled": false,
2192
+ "document": "任务执行结束时间。",
2193
+ "example": "2022-05-30 15:01:00",
2194
+ "member": "string",
2195
+ "name": "EndTime",
2196
+ "output_required": false,
2197
+ "type": "string",
2198
+ "value_allowed_null": false
2199
+ },
1973
2200
  {
1974
2201
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
1975
2202
  "member": "string",
@@ -1984,7 +2211,7 @@
1984
2211
  "members": [
1985
2212
  {
1986
2213
  "disabled": false,
1987
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
2214
+ "document": "实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
1988
2215
  "example": "cmgo-74sjf5mt",
1989
2216
  "member": "string",
1990
2217
  "name": "InstanceId",
@@ -1993,7 +2220,7 @@
1993
2220
  },
1994
2221
  {
1995
2222
  "disabled": false,
1996
- "document": "备份文件名,用来过滤指定文件的下载任务",
2223
+ "document": "指定备份文件名,用于过滤指定文件的下载任务。请通过接口 [DescribeDBBackups](https://cloud.tencent.com/document/product/240/38574) 获取备份文件名。",
1997
2224
  "example": "cmgo-74sjf5mt_2021-03-24 15:40",
1998
2225
  "member": "string",
1999
2226
  "name": "BackupName",
@@ -2002,7 +2229,7 @@
2002
2229
  },
2003
2230
  {
2004
2231
  "disabled": false,
2005
- "document": "指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间",
2232
+ "document": "指定查询时间范围内的任务,StartTime 指定开始时间。若不指定开始时间,则默认不限制开始时间。",
2006
2233
  "example": "2021-01-02 15:04:05",
2007
2234
  "member": "string",
2008
2235
  "name": "StartTime",
@@ -2011,7 +2238,7 @@
2011
2238
  },
2012
2239
  {
2013
2240
  "disabled": false,
2014
- "document": "指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间",
2241
+ "document": "指定查询时间范围内的任务,EndTime 指定截止时间。若不指定截止时间,则默认不限制截止时间。",
2015
2242
  "example": "2021-01-02 15:04:05",
2016
2243
  "member": "string",
2017
2244
  "name": "EndTime",
@@ -2020,7 +2247,7 @@
2020
2247
  },
2021
2248
  {
2022
2249
  "disabled": false,
2023
- "document": "此次查询返回的条数,取值范围为1-100,默认为20",
2250
+ "document": "此次查询返回的条数,取值范围为1-100,默认为20",
2024
2251
  "example": "10",
2025
2252
  "member": "int64",
2026
2253
  "name": "Limit",
@@ -2029,7 +2256,7 @@
2029
2256
  },
2030
2257
  {
2031
2258
  "disabled": false,
2032
- "document": "指定此次查询返回的页数,默认为0",
2259
+ "document": "指定此次查询返回的页数,默认为0",
2033
2260
  "example": "0",
2034
2261
  "member": "int64",
2035
2262
  "name": "Offset",
@@ -2038,7 +2265,7 @@
2038
2265
  },
2039
2266
  {
2040
2267
  "disabled": false,
2041
- "document": "排序字段,取值为createTimefinishTime两种,默认为createTime",
2268
+ "document": "排序字段。\n- createTime:按照备份下载任务的创建时间排序。默认为 createTime。\n- finishTime:按照备份下载任务的完成时间排序。",
2042
2269
  "example": "finishTime",
2043
2270
  "member": "string",
2044
2271
  "name": "OrderBy",
@@ -2047,7 +2274,7 @@
2047
2274
  },
2048
2275
  {
2049
2276
  "disabled": false,
2050
- "document": "排序方式,取值为ascdesc两种,默认desc",
2277
+ "document": "排序方式。\n- asc:升序排列。\n- desc:降序排列。默认为 desc",
2051
2278
  "example": "desc",
2052
2279
  "member": "string",
2053
2280
  "name": "OrderByType",
@@ -2056,7 +2283,7 @@
2056
2283
  },
2057
2284
  {
2058
2285
  "disabled": false,
2059
- "document": "根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型",
2286
+ "document": "指定任务状态,用于过滤下载任务。若不配置该参数,则返回所有状态类型的任务。\n- 0:等待执行。\n- 1:正在下载。\n- 2:下载完成。\n- 3:下载失败。\n- 4:等待重试。",
2060
2287
  "example": "[2]",
2061
2288
  "member": "int64",
2062
2289
  "name": "Status",
@@ -2071,21 +2298,21 @@
2071
2298
  "members": [
2072
2299
  {
2073
2300
  "disabled": false,
2074
- "document": "满足查询条件的所有条数",
2301
+ "document": "满足查询条件的所有条数。",
2075
2302
  "example": "12",
2076
2303
  "member": "int64",
2077
2304
  "name": "TotalCount",
2078
- "required": true,
2305
+ "output_required": true,
2079
2306
  "type": "int",
2080
2307
  "value_allowed_null": false
2081
2308
  },
2082
2309
  {
2083
2310
  "disabled": false,
2084
- "document": "下载任务列表",
2311
+ "document": "下载任务列表。",
2085
2312
  "example": "无",
2086
2313
  "member": "BackupDownloadTask",
2087
2314
  "name": "Tasks",
2088
- "required": true,
2315
+ "output_required": true,
2089
2316
  "type": "list",
2090
2317
  "value_allowed_null": false
2091
2318
  },
@@ -2223,7 +2450,7 @@
2223
2450
  "members": [
2224
2451
  {
2225
2452
  "disabled": false,
2226
- "document": "指定要查询的实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
2453
+ "document": "指定要查询的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
2227
2454
  "example": "cmgo-p8vn****",
2228
2455
  "member": "string",
2229
2456
  "name": "InstanceId",
@@ -2250,7 +2477,7 @@
2250
2477
  },
2251
2478
  {
2252
2479
  "disabled": false,
2253
- "document": "设置查询筛选条件为操作任务类型。取值包括:noneupdateinsertquerycommandgetmoreremove killcursors",
2480
+ "document": "设置查询筛选条件为操作任务类型。取值包括:\n- none:特殊状态,空闲连接或内部任务等。\n- update:更新数据。\n- insert:插入操作。\n- query:查询操作。\n- command:命令操作。\n- getmore:获取更多数据。\n- remove:删除操作。\n- killcursors:释放查询游标的操作。",
2254
2481
  "example": "update",
2255
2482
  "member": "string",
2256
2483
  "name": "Op",
@@ -2277,7 +2504,7 @@
2277
2504
  },
2278
2505
  {
2279
2506
  "disabled": false,
2280
- "document": "单次请求返回的数量,默认值为100,取值范围为[0,100]",
2507
+ "document": "单次请求返回的数量,默认值为100,取值范围为[0,100]",
2281
2508
  "example": "10",
2282
2509
  "member": "uint64",
2283
2510
  "name": "Limit",
@@ -2286,7 +2513,7 @@
2286
2513
  },
2287
2514
  {
2288
2515
  "disabled": false,
2289
- "document": "偏移量,默认值为0,取值范围为[0,10000]",
2516
+ "document": "偏移量,默认值为0,取值范围为[0,10000]",
2290
2517
  "example": "1",
2291
2518
  "member": "uint64",
2292
2519
  "name": "Offset",
@@ -2295,7 +2522,7 @@
2295
2522
  },
2296
2523
  {
2297
2524
  "disabled": false,
2298
- "document": "返回结果集排序的字段,目前支持:\"MicrosecsRunning\"/\"microsecsrunning\",默认为升序排序",
2525
+ "document": "返回结果集排序的字段,目前支持按照 MicrosecsRunning(操作任务已执行的时间)排序。",
2299
2526
  "example": "MicrosecsRunning",
2300
2527
  "member": "string",
2301
2528
  "name": "OrderBy",
@@ -2304,7 +2531,7 @@
2304
2531
  },
2305
2532
  {
2306
2533
  "disabled": false,
2307
- "document": "返回结果集排序方式,可能的取值:\"ASC\"/\"asc\"或\"DESC\"/\"desc\"",
2534
+ "document": "返回结果集排序方式。\n- ASC:升序。默认为 ASC,按照升序排序。\n- DESC:降序。",
2308
2535
  "example": "ASC",
2309
2536
  "member": "string",
2310
2537
  "name": "OrderByType",
@@ -2351,7 +2578,7 @@
2351
2578
  "members": [
2352
2579
  {
2353
2580
  "disabled": false,
2354
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
2581
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
2355
2582
  "example": "cmgo-f555zzzz",
2356
2583
  "member": "string",
2357
2584
  "name": "InstanceId",
@@ -2360,7 +2587,7 @@
2360
2587
  },
2361
2588
  {
2362
2589
  "disabled": false,
2363
- "document": "备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。",
2590
+ "document": "备份方式。\n- 0:逻辑备份。\n- 1:物理备份。\n- 3:快照备份。\n**说明**:\n1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。\n2. 实例开通存储加密,则备份方式不能为物理备份。",
2364
2591
  "example": "1",
2365
2592
  "member": "int64",
2366
2593
  "name": "BackupMethod",
@@ -2393,7 +2620,7 @@
2393
2620
  "members": [
2394
2621
  {
2395
2622
  "disabled": false,
2396
- "document": "备份列表",
2623
+ "document": "备份列表。",
2397
2624
  "example": "无",
2398
2625
  "member": "BackupInfo",
2399
2626
  "name": "BackupList",
@@ -2403,7 +2630,7 @@
2403
2630
  },
2404
2631
  {
2405
2632
  "disabled": false,
2406
- "document": "备份总数",
2633
+ "document": "备份总数。",
2407
2634
  "example": "0",
2408
2635
  "member": "uint64",
2409
2636
  "name": "TotalCount",
@@ -2425,7 +2652,7 @@
2425
2652
  "members": [
2426
2653
  {
2427
2654
  "disabled": false,
2428
- "document": "订单ID,通过CreateDBInstance等接口返回",
2655
+ "document": "订单 ID。\n- 按量计费实例,请通过 [CreateDBInstanceHour](https://cloud.tencent.com/document/product/240/38570) 接口输出的参数**DealId**获取。。\n- 包年包月计费实例,请通过 [CreateDBInstance](https://cloud.tencent.com/document/product/240/38571) 接口输出的参数**DealId**获取。",
2429
2656
  "example": "20200420111635",
2430
2657
  "member": "string",
2431
2658
  "name": "DealId",
@@ -2440,7 +2667,7 @@
2440
2667
  "members": [
2441
2668
  {
2442
2669
  "disabled": false,
2443
- "document": "订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。",
2670
+ "document": "订单状态。\n- 1:未支付。\n- 2:已支付。\n- 3:发货中。\n- 4:发货成功。\n- 5:发货失败。\n- 6:退款。\n- 7:订单关闭。\n- 8:超时未支付关闭。",
2444
2671
  "example": "4",
2445
2672
  "member": "int64",
2446
2673
  "name": "Status",
@@ -2450,7 +2677,7 @@
2450
2677
  },
2451
2678
  {
2452
2679
  "disabled": false,
2453
- "document": "订单原价。",
2680
+ "document": "订单原价。单位:元。",
2454
2681
  "example": "1116.67",
2455
2682
  "member": "float",
2456
2683
  "name": "OriginalPrice",
@@ -2460,7 +2687,7 @@
2460
2687
  },
2461
2688
  {
2462
2689
  "disabled": false,
2463
- "document": "订单折扣价格。",
2690
+ "document": "订单折扣价格。单位:元。",
2464
2691
  "example": "759.33",
2465
2692
  "member": "float",
2466
2693
  "name": "DiscountPrice",
@@ -2470,7 +2697,7 @@
2470
2697
  },
2471
2698
  {
2472
2699
  "disabled": false,
2473
- "document": "订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。",
2700
+ "document": "订单操作行为。\n- purchase:新购。\n- renew:续费。\n- upgrade:升配.\n- downgrade:降配.\n- refund:退货退款。",
2474
2701
  "example": "purchase",
2475
2702
  "member": "string",
2476
2703
  "name": "Action",
@@ -2480,7 +2707,7 @@
2480
2707
  },
2481
2708
  {
2482
2709
  "disabled": false,
2483
- "document": "当前订单的资源Id。",
2710
+ "document": "当前订单的实例 ID。",
2484
2711
  "example": "cmgo-******",
2485
2712
  "member": "string",
2486
2713
  "name": "InstanceId",
@@ -2527,7 +2754,7 @@
2527
2754
  {
2528
2755
  "disabled": false,
2529
2756
  "document": "查询实例的数据库列表。若未使用 DbName 指定具体查询的数据库,则仅返回查询实例所有的数据库列表,而不返回 Collections 集合信息。",
2530
- "example": "['db-a','db-b']",
2757
+ "example": "[\"db-a\",\"b-b\"]",
2531
2758
  "member": "string",
2532
2759
  "name": "Databases",
2533
2760
  "output_required": false,
@@ -2537,7 +2764,7 @@
2537
2764
  {
2538
2765
  "disabled": false,
2539
2766
  "document": "查询的集合信息。指定 DbName 时,则仅返回该数据库下的集合列表。",
2540
- "example": "['col-1','col-2',]",
2767
+ "example": "[\"col-1\",\"col-2\"]",
2541
2768
  "member": "string",
2542
2769
  "name": "Collections",
2543
2770
  "output_required": false,
@@ -2558,7 +2785,7 @@
2558
2785
  "members": [
2559
2786
  {
2560
2787
  "disabled": false,
2561
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。",
2788
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
2562
2789
  "example": "cmgo-p8vnipr5",
2563
2790
  "member": "string",
2564
2791
  "name": "InstanceId",
@@ -2567,7 +2794,7 @@
2567
2794
  },
2568
2795
  {
2569
2796
  "disabled": false,
2570
- "document": "节点ID。",
2797
+ "document": "节点 ID。请登录 [MongoDB 控制台的节点管理](https://console.cloud.tencent.com/mongodb)复制节点 ID。",
2571
2798
  "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]",
2572
2799
  "member": "string",
2573
2800
  "name": "NodeIds",
@@ -2576,8 +2803,8 @@
2576
2803
  },
2577
2804
  {
2578
2805
  "disabled": false,
2579
- "document": "节点角色。可选值包括:\n<ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>",
2580
- "example": "PRIMARY",
2806
+ "document": "节点角色。可选值包括:\n- PRIMARY:主节点。\n- SECONDARY:从节点。\n- READONLY:只读节点。\n- ARBITER:仲裁节点。",
2807
+ "example": "[\"PRIMARY\"]",
2581
2808
  "member": "string",
2582
2809
  "name": "Roles",
2583
2810
  "required": false,
@@ -2585,7 +2812,7 @@
2585
2812
  },
2586
2813
  {
2587
2814
  "disabled": false,
2588
- "document": "该参数指定节点是否为Hidden节点,默认为false。",
2815
+ "document": "该参数指定节点是否为 Hidden 节点,默认为 false。",
2589
2816
  "example": "false",
2590
2817
  "member": "bool",
2591
2818
  "name": "OnlyHidden",
@@ -2603,7 +2830,7 @@
2603
2830
  },
2604
2831
  {
2605
2832
  "disabled": false,
2606
- "document": "该参数指定节点投票权。\n<ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>",
2833
+ "document": "该参数指定节点投票权。\n- 1:具有投票权。\n- 0:无投票权。",
2607
2834
  "example": "1",
2608
2835
  "member": "int64",
2609
2836
  "name": "Votes",
@@ -2659,7 +2886,7 @@
2659
2886
  "members": [
2660
2887
  {
2661
2888
  "disabled": false,
2662
- "document": "参数模板 ID。",
2889
+ "document": "参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。",
2663
2890
  "example": "tpl-sdvj2jh4k",
2664
2891
  "member": "string",
2665
2892
  "name": "TplId",
@@ -2724,7 +2951,7 @@
2724
2951
  {
2725
2952
  "disabled": false,
2726
2953
  "document": "参数总个数。",
2727
- "example": "0",
2954
+ "example": "1",
2728
2955
  "member": "int64",
2729
2956
  "name": "TotalCount",
2730
2957
  "output_required": false,
@@ -2733,7 +2960,7 @@
2733
2960
  },
2734
2961
  {
2735
2962
  "disabled": false,
2736
- "document": "模板适配实例版本。",
2963
+ "document": "模板适配的实例版本。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
2737
2964
  "example": "MONGO_50_WT",
2738
2965
  "member": "string",
2739
2966
  "name": "MongoVersion",
@@ -2743,7 +2970,7 @@
2743
2970
  },
2744
2971
  {
2745
2972
  "disabled": false,
2746
- "document": "模板适配集群类型,副本集或分片。。",
2973
+ "document": "模板适配集群类型。\n- REPLSET:副本集实例。\n- SHARD:分片实例。\n- STANDALONE:单节点实例。",
2747
2974
  "example": "SHARD",
2748
2975
  "member": "string",
2749
2976
  "name": "ClusterType",
@@ -2775,8 +3002,8 @@
2775
3002
  "members": [
2776
3003
  {
2777
3004
  "disabled": false,
2778
- "document": "参数模板 ID 查询条件。",
2779
- "example": "[\"tpl-sdjf143qu\"]",
3005
+ "document": "参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。",
3006
+ "example": "[\"tpl-sdjf1****\"]",
2780
3007
  "member": "string",
2781
3008
  "name": "TplIds",
2782
3009
  "required": false,
@@ -2784,8 +3011,8 @@
2784
3011
  },
2785
3012
  {
2786
3013
  "disabled": false,
2787
- "document": "模板名称,查询条件。",
2788
- "example": "[\"test\"]",
3014
+ "document": "指定查询的模板名称。",
3015
+ "example": "[\"tpl-test\"]",
2789
3016
  "member": "string",
2790
3017
  "name": "TplNames",
2791
3018
  "required": false,
@@ -2793,7 +3020,7 @@
2793
3020
  },
2794
3021
  {
2795
3022
  "disabled": false,
2796
- "document": "根据版本号查询参数模板,具体支持的售卖版本,请参见[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询云数据库的售卖规格的返回结果。参数与版本对应关系如下所示:\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。",
3023
+ "document": "指定所需查询的参数模板的数据库版本号。具体支持的版本信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
2797
3024
  "example": "[\"MONGO_42_WT\"]",
2798
3025
  "member": "string",
2799
3026
  "name": "MongoVersion",
@@ -2802,7 +3029,7 @@
2802
3029
  },
2803
3030
  {
2804
3031
  "disabled": false,
2805
- "document": "根据模板类型查询参数模板,支持DEFAULT(默认模板)和CUSTOMIZE(自定义模板)两种。",
3032
+ "document": "指定查询的模板类型。\n- DEFAULT:系统默认模板。\n- CUSTOMIZE:自定义模板。",
2806
3033
  "example": "CUSTOMIZE",
2807
3034
  "member": "string",
2808
3035
  "name": "TplType",
@@ -2886,8 +3113,8 @@
2886
3113
  "members": [
2887
3114
  {
2888
3115
  "disabled": false,
2889
- "document": "实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
2890
- "example": "cmgo-hcscymcl",
3116
+ "document": "实例 ID 列表。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
3117
+ "example": "[\"cmgo-hcscymcl\"]",
2891
3118
  "member": "string",
2892
3119
  "name": "InstanceIds",
2893
3120
  "required": false,
@@ -2895,7 +3122,7 @@
2895
3122
  },
2896
3123
  {
2897
3124
  "disabled": false,
2898
- "document": "指定查询的实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>3:只读实例。</li><li>4:灾备实例。</li></ul>",
3125
+ "document": "指定查询的实例类型。取值范围如下:\n- 0:所有实例。\n- 1:正式实例。\n- 2:临时实例\n- 3:只读实例。\n- -1:查询同时包括正式实例、只读实例与灾备实例。",
2899
3126
  "example": "0",
2900
3127
  "member": "int64",
2901
3128
  "name": "InstanceType",
@@ -2904,7 +3131,7 @@
2904
3131
  },
2905
3132
  {
2906
3133
  "disabled": false,
2907
- "document": "指定所查询实例的集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:副本集与分片实例。</li></ul>",
3134
+ "document": "指定所查询实例的集群类型,取值范围如下:\n- 0:副本集实例。\n- 1:分片实例。\n- -1:副本集与分片实例。",
2908
3135
  "example": "0",
2909
3136
  "member": "int64",
2910
3137
  "name": "ClusterType",
@@ -2913,8 +3140,8 @@
2913
3140
  },
2914
3141
  {
2915
3142
  "disabled": false,
2916
- "document": "指定所查询实例的当前状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程处理中,例如:变更规格、参数修改等。</li><li>2:实例正常运行中。</li><li>-2:实例已过期。</li></ul>",
2917
- "example": "2",
3143
+ "document": "指定所查询实例的当前状态,取值范围如下所示:\n- 0:待初始化。\n- 1:流程处理中,例如:变更规格、参数修改等。\n- 2:实例正常运行中。\n- -2:已隔离(包年包月)。\n- -3:已隔离(按量计费)。",
3144
+ "example": "[2]",
2918
3145
  "member": "int64",
2919
3146
  "name": "Status",
2920
3147
  "required": false,
@@ -2940,7 +3167,7 @@
2940
3167
  },
2941
3168
  {
2942
3169
  "disabled": false,
2943
- "document": "指定所查询实例的付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>",
3170
+ "document": "指定所查询实例的付费类型。\n- 0:查询按量计费实例。\n- 1:查询包年包月实例。\n- -1:查询按量计费与包年包月实例。",
2944
3171
  "example": "1",
2945
3172
  "member": "int64",
2946
3173
  "name": "PayMode",
@@ -2949,7 +3176,7 @@
2949
3176
  },
2950
3177
  {
2951
3178
  "disabled": false,
2952
- "document": "单次请求返回的数量。默认值为20,取值范围为[1,100]。",
3179
+ "document": "单次请求返回的数量。默认值为20,取值范围为(1,100]。",
2953
3180
  "example": "10",
2954
3181
  "member": "uint64",
2955
3182
  "name": "Limit",
@@ -3050,8 +3277,8 @@
3050
3277
  "members": [
3051
3278
  {
3052
3279
  "disabled": false,
3053
- "document": "实例id",
3054
- "example": "cmgo-xxxx",
3280
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
3281
+ "example": "cmgo-r3p8****",
3055
3282
  "member": "string",
3056
3283
  "name": "InstanceId",
3057
3284
  "required": true,
@@ -3059,7 +3286,7 @@
3059
3286
  },
3060
3287
  {
3061
3288
  "disabled": false,
3062
- "document": "待查询慢日志的开始时间",
3289
+ "document": "指定查询慢日志的开始时间。- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3063
3290
  "example": "2025-01-02 13:14:15",
3064
3291
  "member": "string",
3065
3292
  "name": "StartTime",
@@ -3068,7 +3295,7 @@
3068
3295
  },
3069
3296
  {
3070
3297
  "disabled": false,
3071
- "document": "待慢日志的结束时间",
3298
+ "document": "指定查询慢日志的结束时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。\n- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3072
3299
  "example": "2025-01-02 13:14:15",
3073
3300
  "member": "string",
3074
3301
  "name": "EndTime",
@@ -3077,7 +3304,7 @@
3077
3304
  },
3078
3305
  {
3079
3306
  "disabled": false,
3080
- "document": "过滤执行时间大于此值的慢日志,单位ms,默认值100",
3307
+ "document": "指定慢日志查询阈值,即查询执行时间大于此值的慢日志。单位:ms,默认值:100",
3081
3308
  "example": "100",
3082
3309
  "member": "int64",
3083
3310
  "name": "ExecTime",
@@ -3086,8 +3313,8 @@
3086
3313
  },
3087
3314
  {
3088
3315
  "disabled": false,
3089
- "document": "过滤慢日志的命令类型",
3090
- "example": "find",
3316
+ "document": "指定查询慢日志的命令类型。",
3317
+ "example": "[\"find\"]",
3091
3318
  "member": "string",
3092
3319
  "name": "Commands",
3093
3320
  "required": false,
@@ -3095,8 +3322,8 @@
3095
3322
  },
3096
3323
  {
3097
3324
  "disabled": false,
3098
- "document": "全文搜索关键字,多个关键字间为或关系",
3099
- "example": "[\"aaa\",\"bbb\"]",
3325
+ "document": "全文搜索关键字,多个关键字间为或关系。",
3326
+ "example": "[\"command\",\"primary\"]",
3100
3327
  "member": "string",
3101
3328
  "name": "Texts",
3102
3329
  "required": false,
@@ -3104,8 +3331,8 @@
3104
3331
  },
3105
3332
  {
3106
3333
  "disabled": false,
3107
- "document": "根据节点名过滤",
3108
- "example": "[\"cmgo-xxxx-node-primary\"]",
3334
+ "document": "指定查询慢日志的节点名称。请通过接口 [DescribeDBInstanceNodeProperty](https://cloud.tencent.com/document/product/240/82022) 查询节点名称。",
3335
+ "example": "[\"cmgo-r3p8****_0-node-primary\"]",
3109
3336
  "member": "string",
3110
3337
  "name": "NodeNames",
3111
3338
  "required": false,
@@ -3113,8 +3340,8 @@
3113
3340
  },
3114
3341
  {
3115
3342
  "disabled": false,
3116
- "document": "根据queryHash过滤",
3117
- "example": "[\"abcdef\"]",
3343
+ "document": "指定查询 queryHash 值。",
3344
+ "example": "[\"admin..****Continue\"]",
3118
3345
  "member": "string",
3119
3346
  "name": "QueryHash",
3120
3347
  "required": false,
@@ -3122,7 +3349,7 @@
3122
3349
  },
3123
3350
  {
3124
3351
  "disabled": false,
3125
- "document": "分页偏移量",
3352
+ "document": "分页偏移量。默认值:0。取值范围:[0,100]。\n",
3126
3353
  "example": "1",
3127
3354
  "member": "int64",
3128
3355
  "name": "Offset",
@@ -3131,7 +3358,7 @@
3131
3358
  },
3132
3359
  {
3133
3360
  "disabled": false,
3134
- "document": "返回条数",
3361
+ "document": "返回条数。默认值:20。取值范围:[0,10000]",
3135
3362
  "example": "10",
3136
3363
  "member": "int64",
3137
3364
  "name": "Limit",
@@ -3140,7 +3367,7 @@
3140
3367
  },
3141
3368
  {
3142
3369
  "disabled": false,
3143
- "document": "排序条件,只支持StartTime(按慢日志生成时间)和ExecTime(慢日志执行时间)",
3370
+ "document": "指定慢日志排序条件。\n- StartTime:按照慢日志生成时间排序。\n- ExecTime:按照慢日志执行时间排序。",
3144
3371
  "example": "ExecTime",
3145
3372
  "member": "string",
3146
3373
  "name": "OrderBy",
@@ -3149,7 +3376,7 @@
3149
3376
  },
3150
3377
  {
3151
3378
  "disabled": false,
3152
- "document": "排序。desc倒排,asc正排",
3379
+ "document": "指定排序方式。\n- desc:倒序。\n- asc:顺序。",
3153
3380
  "example": "desc",
3154
3381
  "member": "string",
3155
3382
  "name": "OrderByType",
@@ -3164,7 +3391,7 @@
3164
3391
  "members": [
3165
3392
  {
3166
3393
  "disabled": false,
3167
- "document": "满足条件的慢日志数量",
3394
+ "document": "满足条件的慢日志数量。",
3168
3395
  "example": "100",
3169
3396
  "member": "int64",
3170
3397
  "name": "TotalCount",
@@ -3174,7 +3401,7 @@
3174
3401
  },
3175
3402
  {
3176
3403
  "disabled": false,
3177
- "document": "慢日志详情",
3404
+ "document": "慢日志详情。",
3178
3405
  "example": "无",
3179
3406
  "member": "SlowLogItem",
3180
3407
  "name": "DetailedSlowLogs",
@@ -3268,34 +3495,80 @@
3268
3495
  ],
3269
3496
  "type": "object"
3270
3497
  },
3271
- "DescribeSecurityGroupRequest": {
3272
- "document": "DescribeSecurityGroup请求参数结构体",
3498
+ "DescribeLogDownloadTasksRequest": {
3499
+ "document": "DescribeLogDownloadTasks请求参数结构体",
3273
3500
  "members": [
3274
3501
  {
3275
3502
  "disabled": false,
3276
- "document": "实例 ID。例如:cmgo-p8vn****。",
3277
- "example": "cmgo-p8vnipr5",
3503
+ "document": "实例 ID",
3504
+ "example": "cmgo-b6nit818p",
3278
3505
  "member": "string",
3279
3506
  "name": "InstanceId",
3280
3507
  "required": true,
3281
3508
  "type": "string"
3509
+ },
3510
+ {
3511
+ "disabled": false,
3512
+ "document": "查询条数",
3513
+ "example": "20",
3514
+ "member": "int64",
3515
+ "name": "Limit",
3516
+ "required": false,
3517
+ "type": "int"
3518
+ },
3519
+ {
3520
+ "disabled": false,
3521
+ "document": "页码",
3522
+ "example": "0",
3523
+ "member": "int64",
3524
+ "name": "Offset",
3525
+ "required": false,
3526
+ "type": "int"
3527
+ },
3528
+ {
3529
+ "disabled": false,
3530
+ "document": "下载任务的开始时间",
3531
+ "example": "2024-03-07 9:22:15",
3532
+ "member": "string",
3533
+ "name": "StartTime",
3534
+ "required": false,
3535
+ "type": "string"
3536
+ },
3537
+ {
3538
+ "disabled": false,
3539
+ "document": "下载任务的结束时间",
3540
+ "example": "2024-03-07 11:22:15",
3541
+ "member": "string",
3542
+ "name": "EndTime",
3543
+ "required": false,
3544
+ "type": "string"
3282
3545
  }
3283
3546
  ],
3284
3547
  "type": "object"
3285
3548
  },
3286
- "DescribeSecurityGroupResponse": {
3287
- "document": "DescribeSecurityGroup返回参数结构体",
3549
+ "DescribeLogDownloadTasksResponse": {
3550
+ "document": "DescribeLogDownloadTasks返回参数结构体",
3288
3551
  "members": [
3289
3552
  {
3290
3553
  "disabled": false,
3291
- "document": "实例绑定的安全组信息。",
3292
- "example": "",
3293
- "member": "SecurityGroup",
3294
- "name": "Groups",
3554
+ "document": "数量",
3555
+ "example": "10",
3556
+ "member": "int64",
3557
+ "name": "TotalCount",
3295
3558
  "output_required": true,
3296
- "type": "list",
3559
+ "type": "int",
3297
3560
  "value_allowed_null": false
3298
3561
  },
3562
+ {
3563
+ "disabled": false,
3564
+ "document": "任务列表\n注意:此字段可能返回 null,表示取不到有效值。",
3565
+ "example": "无",
3566
+ "member": "Task",
3567
+ "name": "Tasks",
3568
+ "output_required": false,
3569
+ "type": "list",
3570
+ "value_allowed_null": true
3571
+ },
3299
3572
  {
3300
3573
  "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3301
3574
  "member": "string",
@@ -3305,13 +3578,13 @@
3305
3578
  ],
3306
3579
  "type": "object"
3307
3580
  },
3308
- "DescribeSlowLogPatternsRequest": {
3309
- "document": "DescribeSlowLogPatterns请求参数结构体",
3581
+ "DescribeMongodbLogsRequest": {
3582
+ "document": "DescribeMongodbLogs请求参数结构体",
3310
3583
  "members": [
3311
3584
  {
3312
3585
  "disabled": false,
3313
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
3314
- "example": "cmgo-a3bm93hf",
3586
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb#/)在实例列表复制实例 ID",
3587
+ "example": "cmgo-k2p5su09",
3315
3588
  "member": "string",
3316
3589
  "name": "InstanceId",
3317
3590
  "required": true,
@@ -3319,31 +3592,205 @@
3319
3592
  },
3320
3593
  {
3321
3594
  "disabled": false,
3322
- "document": "慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3595
+ "document": "查询日志的开启时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。\n- 查询时间范围:仅支持查询最近 7 天内的日志数据。",
3323
3596
  "example": "2020-04-20 00:00:00",
3324
- "member": "datetime",
3597
+ "member": "string",
3325
3598
  "name": "StartTime",
3326
3599
  "required": true,
3327
3600
  "type": "string"
3328
3601
  },
3329
3602
  {
3330
3603
  "disabled": false,
3331
- "document": "慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3332
- "example": "2020-04-20 22:00:00",
3333
- "member": "datetime",
3604
+ "document": "查询日志的结束时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。\n- 查询时间范围:仅支持查询最近 7 天内的日志数据。",
3605
+ "example": "2020-04-20 00:00:00",
3606
+ "member": "string",
3334
3607
  "name": "EndTime",
3335
3608
  "required": true,
3336
3609
  "type": "string"
3337
3610
  },
3338
3611
  {
3339
3612
  "disabled": false,
3340
- "document": "慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。",
3341
- "example": "100",
3342
- "member": "uint64",
3343
- "name": "SlowMS",
3344
- "required": true,
3345
- "type": "int"
3346
- },
3613
+ "document": "节点 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)的**节点管理**页面获取查询的节点 ID。",
3614
+ "example": "[\"cmgo-xxx_0-node-primary\"]",
3615
+ "member": "string",
3616
+ "name": "NodeNames",
3617
+ "required": false,
3618
+ "type": "list"
3619
+ },
3620
+ {
3621
+ "disabled": false,
3622
+ "document": "日志类别。\n- 日志类别包括但不限于 COMMAND、ACCESS、CONTROL、FTDC、INDEX、NETWORK、QUERY、REPL、SHARDING、STORAGE、RECOVERY、JOURNAL 和 WRITE 等。具体支持的类别可能会因 MongoDB 的版本而存在差异。具体信息,请参见[日志消息](https://www.mongodb.com/zh-cn/docs/v5.0/reference/log-messages/#log-message-examples)。\n- 登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在**日志管理**页面的**错误日志**页签,也可查看**日志类别**。",
3623
+ "example": "[\"COMMAND\"]",
3624
+ "member": "string",
3625
+ "name": "LogComponents",
3626
+ "required": false,
3627
+ "type": "list"
3628
+ },
3629
+ {
3630
+ "disabled": false,
3631
+ "document": "日志级别。\n- 日志级别按严重性从高到低依次为:FATAL、ERROR、WARNING。\n- 登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在**日志管理**页面的**错误日志**页签,可查看**日志级别**。",
3632
+ "example": "[\"WARNING\"]",
3633
+ "member": "string",
3634
+ "name": "LogLevels",
3635
+ "required": false,
3636
+ "type": "list"
3637
+ },
3638
+ {
3639
+ "disabled": false,
3640
+ "document": "日志 ID。登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在**日志管理**页面的**错误日志**页签,可查看**日志 ID**。",
3641
+ "example": "[\"1245\"]",
3642
+ "member": "string",
3643
+ "name": "LogIds",
3644
+ "required": false,
3645
+ "type": "list"
3646
+ },
3647
+ {
3648
+ "disabled": false,
3649
+ "document": "日志连接信息。登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在**日志管理**页面的**错误日志**页签,可查看**日志连接信息**。",
3650
+ "example": "[\"conn268164\"]",
3651
+ "member": "string",
3652
+ "name": "LogConnections",
3653
+ "required": false,
3654
+ "type": "list"
3655
+ },
3656
+ {
3657
+ "disabled": false,
3658
+ "document": "指定日志筛选的字段。",
3659
+ "example": "[\"*\"]",
3660
+ "member": "string",
3661
+ "name": "LogDetailParams",
3662
+ "required": false,
3663
+ "type": "list"
3664
+ },
3665
+ {
3666
+ "disabled": false,
3667
+ "document": "偏移量,最小值为0,最大值为10000,默认值为0。",
3668
+ "example": "0",
3669
+ "member": "int64",
3670
+ "name": "Offset",
3671
+ "required": false,
3672
+ "type": "int"
3673
+ },
3674
+ {
3675
+ "disabled": false,
3676
+ "document": "分页大小,最小值为1,最大值为100,默认值为20。",
3677
+ "example": "100",
3678
+ "member": "int64",
3679
+ "name": "Limit",
3680
+ "required": false,
3681
+ "type": "int"
3682
+ }
3683
+ ],
3684
+ "type": "object"
3685
+ },
3686
+ "DescribeMongodbLogsResponse": {
3687
+ "document": "DescribeMongodbLogs返回参数结构体",
3688
+ "members": [
3689
+ {
3690
+ "disabled": false,
3691
+ "document": "日志总数。",
3692
+ "example": "1000",
3693
+ "member": "int64",
3694
+ "name": "TotalCount",
3695
+ "output_required": false,
3696
+ "type": "int",
3697
+ "value_allowed_null": false
3698
+ },
3699
+ {
3700
+ "disabled": false,
3701
+ "document": "日志详情列表。\n注意:此字段可能返回 null,表示取不到有效值。",
3702
+ "example": "无",
3703
+ "member": "LogInfo",
3704
+ "name": "LogList",
3705
+ "output_required": false,
3706
+ "type": "list",
3707
+ "value_allowed_null": true
3708
+ },
3709
+ {
3710
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3711
+ "member": "string",
3712
+ "name": "RequestId",
3713
+ "type": "string"
3714
+ }
3715
+ ],
3716
+ "type": "object"
3717
+ },
3718
+ "DescribeSecurityGroupRequest": {
3719
+ "document": "DescribeSecurityGroup请求参数结构体",
3720
+ "members": [
3721
+ {
3722
+ "disabled": false,
3723
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
3724
+ "example": "cmgo-p8vn****",
3725
+ "member": "string",
3726
+ "name": "InstanceId",
3727
+ "required": true,
3728
+ "type": "string"
3729
+ }
3730
+ ],
3731
+ "type": "object"
3732
+ },
3733
+ "DescribeSecurityGroupResponse": {
3734
+ "document": "DescribeSecurityGroup返回参数结构体",
3735
+ "members": [
3736
+ {
3737
+ "disabled": false,
3738
+ "document": "实例绑定的安全组信息。",
3739
+ "example": "无",
3740
+ "member": "SecurityGroup",
3741
+ "name": "Groups",
3742
+ "output_required": true,
3743
+ "type": "list",
3744
+ "value_allowed_null": false
3745
+ },
3746
+ {
3747
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
3748
+ "member": "string",
3749
+ "name": "RequestId",
3750
+ "type": "string"
3751
+ }
3752
+ ],
3753
+ "type": "object"
3754
+ },
3755
+ "DescribeSlowLogPatternsRequest": {
3756
+ "document": "DescribeSlowLogPatterns请求参数结构体",
3757
+ "members": [
3758
+ {
3759
+ "disabled": false,
3760
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
3761
+ "example": "cmgo-a3bm93hf",
3762
+ "member": "string",
3763
+ "name": "InstanceId",
3764
+ "required": true,
3765
+ "type": "string"
3766
+ },
3767
+ {
3768
+ "disabled": false,
3769
+ "document": "慢日志起始时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。\n- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3770
+ "example": "2020-04-20 00:00:00",
3771
+ "member": "datetime",
3772
+ "name": "StartTime",
3773
+ "required": true,
3774
+ "type": "string"
3775
+ },
3776
+ {
3777
+ "disabled": false,
3778
+ "document": "慢日志终止时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。\n- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3779
+ "example": "2020-04-20 22:00:00",
3780
+ "member": "datetime",
3781
+ "name": "EndTime",
3782
+ "required": true,
3783
+ "type": "string"
3784
+ },
3785
+ {
3786
+ "disabled": false,
3787
+ "document": "慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。",
3788
+ "example": "100",
3789
+ "member": "uint64",
3790
+ "name": "SlowMS",
3791
+ "required": true,
3792
+ "type": "int"
3793
+ },
3347
3794
  {
3348
3795
  "disabled": false,
3349
3796
  "document": "偏移量,最小值为0,最大值为10000,默认值为0。",
@@ -3383,7 +3830,7 @@
3383
3830
  "example": "2",
3384
3831
  "member": "uint64",
3385
3832
  "name": "Count",
3386
- "required": true,
3833
+ "output_required": true,
3387
3834
  "type": "int",
3388
3835
  "value_allowed_null": false
3389
3836
  },
@@ -3393,7 +3840,7 @@
3393
3840
  "example": "无",
3394
3841
  "member": "SlowLogPattern",
3395
3842
  "name": "SlowLogPatterns",
3396
- "required": true,
3843
+ "output_required": true,
3397
3844
  "type": "list",
3398
3845
  "value_allowed_null": false
3399
3846
  },
@@ -3411,7 +3858,7 @@
3411
3858
  "members": [
3412
3859
  {
3413
3860
  "disabled": false,
3414
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
3861
+ "document": "实例ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
3415
3862
  "example": "cmgo-a3bm93hf",
3416
3863
  "member": "string",
3417
3864
  "name": "InstanceId",
@@ -3420,7 +3867,7 @@
3420
3867
  },
3421
3868
  {
3422
3869
  "disabled": false,
3423
- "document": "慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3870
+ "document": "慢日志起始时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。\n- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3424
3871
  "example": "2020-04-20 00:00:00",
3425
3872
  "member": "datetime",
3426
3873
  "name": "StartTime",
@@ -3429,7 +3876,7 @@
3429
3876
  },
3430
3877
  {
3431
3878
  "disabled": false,
3432
- "document": "慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3879
+ "document": "慢日志终止时间。\n- 格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。\n- 查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。",
3433
3880
  "example": "2020-04-20 22:00:00",
3434
3881
  "member": "datetime",
3435
3882
  "name": "EndTime",
@@ -3480,7 +3927,7 @@
3480
3927
  "members": [
3481
3928
  {
3482
3929
  "disabled": false,
3483
- "document": "慢日志总数",
3930
+ "document": "慢日志总数。",
3484
3931
  "example": "20",
3485
3932
  "member": "uint64",
3486
3933
  "name": "Count",
@@ -3490,8 +3937,8 @@
3490
3937
  },
3491
3938
  {
3492
3939
  "disabled": false,
3493
- "document": "慢日志详情",
3494
- "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\"]",
3940
+ "document": "慢日志详情。",
3941
+ "example": "[\"Mon Apr 20 13:55:21.623 I COMMAND ********************\"]",
3495
3942
  "member": "string",
3496
3943
  "name": "SlowLogs",
3497
3944
  "output_required": true,
@@ -3512,7 +3959,7 @@
3512
3959
  "members": [
3513
3960
  {
3514
3961
  "disabled": false,
3515
- "document": "待查询可用区",
3962
+ "document": "待查询可用区。当前支持的可用区,请参见[地域与可用区](https://cloud.tencent.com/document/product/240/3637)。",
3516
3963
  "example": "ap-guangzhou-3",
3517
3964
  "member": "string",
3518
3965
  "name": "Zone",
@@ -3527,7 +3974,7 @@
3527
3974
  "members": [
3528
3975
  {
3529
3976
  "disabled": false,
3530
- "document": "实例售卖规格信息列表",
3977
+ "document": "实例售卖规格信息列表。",
3531
3978
  "example": "无",
3532
3979
  "member": "SpecificationInfo",
3533
3980
  "name": "SpecInfoList",
@@ -3549,7 +3996,7 @@
3549
3996
  "members": [
3550
3997
  {
3551
3998
  "disabled": false,
3552
- "document": "指定实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
3999
+ "document": "指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
3553
4000
  "example": "\"cmgo-jyjcw8yv\"",
3554
4001
  "member": "string",
3555
4002
  "name": "InstanceId",
@@ -3565,7 +4012,7 @@
3565
4012
  {
3566
4013
  "disabled": false,
3567
4014
  "document": "表示是否开启了透明加密。 \n- close:未开启。\n- open:已开启。",
3568
- "example": "open或close。",
4015
+ "example": "open",
3569
4016
  "member": "string",
3570
4017
  "name": "TransparentDataEncryptionStatus",
3571
4018
  "output_required": false,
@@ -3596,8 +4043,8 @@
3596
4043
  "members": [
3597
4044
  {
3598
4045
  "disabled": false,
3599
- "document": "参数模板 ID。",
3600
- "example": "tpl-djtuhy1d",
4046
+ "document": "参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。",
4047
+ "example": "tpl-djtu****",
3601
4048
  "member": "string",
3602
4049
  "name": "TplId",
3603
4050
  "required": true,
@@ -3674,11 +4121,11 @@
3674
4121
  "type": "object"
3675
4122
  },
3676
4123
  "FBKeyValue": {
3677
- "document": "按key回档,用于筛选数据的键值对",
4124
+ "document": "按 Key 闪回键值对",
3678
4125
  "members": [
3679
4126
  {
3680
4127
  "disabled": false,
3681
- "document": "用于按key回档过滤的key",
4128
+ "document": "指定按 Key 闪回的目标 Key (键) 。",
3682
4129
  "example": "fbKey",
3683
4130
  "member": "string",
3684
4131
  "name": "Key",
@@ -3687,7 +4134,7 @@
3687
4134
  },
3688
4135
  {
3689
4136
  "disabled": false,
3690
- "document": "用于按key回档过滤的value",
4137
+ "document": "指定按 Key 闪回的目标 Key 所对应的 Value(值)。",
3691
4138
  "example": "fbValue",
3692
4139
  "member": "string",
3693
4140
  "name": "Value",
@@ -3702,7 +4149,7 @@
3702
4149
  "members": [
3703
4150
  {
3704
4151
  "disabled": false,
3705
- "document": "开启按 Key 回档的实例 ID。",
4152
+ "document": "开启按 Key 回档的实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需开启按 Key 回档的实例 ID。",
3706
4153
  "example": "cmgo-iga0****",
3707
4154
  "member": "string",
3708
4155
  "name": "InstanceId",
@@ -3711,7 +4158,7 @@
3711
4158
  },
3712
4159
  {
3713
4160
  "disabled": false,
3714
- "document": "源数据想恢复到的时间。",
4161
+ "document": "指定数据回档的具体时间点,即将数据恢复到指定时间点的状态。",
3715
4162
  "example": "2023-08-04 14:00:00",
3716
4163
  "member": "string",
3717
4164
  "name": "TargetFlashbackTime",
@@ -3720,8 +4167,8 @@
3720
4167
  },
3721
4168
  {
3722
4169
  "disabled": false,
3723
- "document": "源数据所在的库表信息。",
3724
- "example": "[{\"DBName\":\"mydb\",\"Collections\":[{\"CollectionName\":\"my_collection\",\"KeyValues\":[{\"Key\":\"_id\",\"Value\":\"\\\"******\\\"\"}],",
4170
+ "document": "指定回档数据的目标库表。",
4171
+ "example": "",
3725
4172
  "member": "FlashbackDatabase",
3726
4173
  "name": "TargetDatabases",
3727
4174
  "required": true,
@@ -3729,7 +4176,7 @@
3729
4176
  },
3730
4177
  {
3731
4178
  "disabled": false,
3732
- "document": "数据最终写入的实例 ID。",
4179
+ "document": "数据回档的目标实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制目标实例 ID。",
3733
4180
  "example": "cmgo-iga0****",
3734
4181
  "member": "string",
3735
4182
  "name": "TargetInstanceId",
@@ -3745,7 +4192,7 @@
3745
4192
  {
3746
4193
  "disabled": false,
3747
4194
  "document": "回档数据异步任务 ID。",
3748
- "example": "16033****",
4195
+ "example": "1234567",
3749
4196
  "member": "int64",
3750
4197
  "name": "FlowId",
3751
4198
  "output_required": false,
@@ -3762,11 +4209,11 @@
3762
4209
  "type": "object"
3763
4210
  },
3764
4211
  "FlashbackCollection": {
3765
- "document": "按key回档,源数据所在的表",
4212
+ "document": "按 Key 闪回数据表",
3766
4213
  "members": [
3767
4214
  {
3768
4215
  "disabled": false,
3769
- "document": "按key回档指定的集合名",
4216
+ "document": "指定按 Key 闪回源数据库集合名。",
3770
4217
  "example": "my_collection",
3771
4218
  "member": "string",
3772
4219
  "name": "CollectionName",
@@ -3775,7 +4222,7 @@
3775
4222
  },
3776
4223
  {
3777
4224
  "disabled": false,
3778
- "document": "按key回档到的目标集合名",
4225
+ "document": "指定按 Key 闪回目标数据库集合名。",
3779
4226
  "example": "my_collection_re",
3780
4227
  "member": "string",
3781
4228
  "name": "TargetResultCollectionName",
@@ -3784,7 +4231,7 @@
3784
4231
  },
3785
4232
  {
3786
4233
  "disabled": false,
3787
- "document": "上传到cos的文件的value所对应的key值",
4234
+ "document": "指定用于过滤按 Key 闪回的 Key(键)。",
3788
4235
  "example": "fKey",
3789
4236
  "member": "string",
3790
4237
  "name": "FilterKey",
@@ -3793,7 +4240,7 @@
3793
4240
  },
3794
4241
  {
3795
4242
  "disabled": false,
3796
- "document": "用于按key回档过滤的键值对",
4243
+ "document": "指定用于按 Key 闪回的键值对。数组元素最大限制为 50000。",
3797
4244
  "example": "fValue",
3798
4245
  "member": "FBKeyValue",
3799
4246
  "name": "KeyValues",
@@ -3804,11 +4251,11 @@
3804
4251
  "usage": "in"
3805
4252
  },
3806
4253
  "FlashbackDatabase": {
3807
- "document": "按key回档,源数据所在的库表",
4254
+ "document": "按 Key 闪回的数据库及集合信息",
3808
4255
  "members": [
3809
4256
  {
3810
4257
  "disabled": false,
3811
- "document": "按key回档源数据所在库",
4258
+ "document": "按 Key 闪回目标数据所在库。",
3812
4259
  "example": "my-db",
3813
4260
  "member": "string",
3814
4261
  "name": "DBName",
@@ -3817,7 +4264,7 @@
3817
4264
  },
3818
4265
  {
3819
4266
  "disabled": false,
3820
- "document": "按key回档的集群数组",
4267
+ "document": "按 Key 闪回的数据库集合。",
3821
4268
  "example": "my-collection",
3822
4269
  "member": "FlashbackCollection",
3823
4270
  "name": "Collections",
@@ -3859,7 +4306,7 @@
3859
4306
  "members": [
3860
4307
  {
3861
4308
  "disabled": false,
3862
- "document": "实例所属区域及可用区信息。格式:ap-guangzhou-2。",
4309
+ "document": "实例所属区域及可用区信息。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。",
3863
4310
  "example": "ap-guangzhou-4",
3864
4311
  "member": "string",
3865
4312
  "name": "Zone",
@@ -3895,8 +4342,8 @@
3895
4342
  },
3896
4343
  {
3897
4344
  "disabled": false,
3898
- "document": "实例版本信息。具体支持的版本,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。",
3899
- "example": "MONGO_36_WT",
4345
+ "document": "实例版本信息。具体支持的版本,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
4346
+ "example": "MONGO_50_WT",
3900
4347
  "member": "string",
3901
4348
  "name": "MongoVersion",
3902
4349
  "required": true,
@@ -4040,7 +4487,7 @@
4040
4487
  "members": [
4041
4488
  {
4042
4489
  "disabled": false,
4043
- "document": "实例 ID,格式如:cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。",
4490
+ "document": "实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
4044
4491
  "example": "cmgo-8oij5631",
4045
4492
  "member": "string",
4046
4493
  "name": "InstanceId",
@@ -4049,7 +4496,7 @@
4049
4496
  },
4050
4497
  {
4051
4498
  "disabled": false,
4052
- "document": "变更配置后实例内存大小,单位:GB",
4499
+ "document": "变更配置后实例内存大小,单位:GB。具体售卖的内存规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
4053
4500
  "example": "8",
4054
4501
  "member": "int64",
4055
4502
  "name": "Memory",
@@ -4058,7 +4505,7 @@
4058
4505
  },
4059
4506
  {
4060
4507
  "disabled": false,
4061
- "document": "变更配置后实例磁盘大小,单位:GB",
4508
+ "document": "变更配置后实例磁盘大小,单位:GB。每一个 CPU 规格对应的最大磁盘与最小磁盘范围,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。",
4062
4509
  "example": "200",
4063
4510
  "member": "int64",
4064
4511
  "name": "Volume",
@@ -4067,7 +4514,7 @@
4067
4514
  },
4068
4515
  {
4069
4516
  "disabled": false,
4070
- "document": "实例节点数。默认为不变更节点数,暂不支持变更。",
4517
+ "document": "实例节点数量。请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。\n- 副本集实例,指变更配置后实例的主从节点数量。\n- 分片集群实例,指变更配置后实例每一个分片的主从节点数。\n**说明**:切勿同时发起调整节点数、调整分片数、调整节点规格的任务。",
4071
4518
  "example": "3",
4072
4519
  "member": "int64",
4073
4520
  "name": "NodeNum",
@@ -4076,7 +4523,7 @@
4076
4523
  },
4077
4524
  {
4078
4525
  "disabled": false,
4079
- "document": "实例分片数。默认为不变更分片数,暂不支持变更。",
4526
+ "document": "分片集群实例,指变更配置后实例的分片数量。取值范围:[2,36] 。\n**说明**:变更后的分片数量不能小于当前现有的数量。切勿同时发起调整节点数、调整分片数与调整节点规格的任务。",
4080
4527
  "example": "2",
4081
4528
  "member": "int64",
4082
4529
  "name": "ReplicateSetNum",
@@ -4095,6 +4542,7 @@
4095
4542
  "example": "无",
4096
4543
  "member": "DBInstancePrice",
4097
4544
  "name": "Price",
4545
+ "output_required": true,
4098
4546
  "type": "object",
4099
4547
  "value_allowed_null": false
4100
4548
  },
@@ -4178,11 +4626,11 @@
4178
4626
  "usage": "in"
4179
4627
  },
4180
4628
  "InstanceDetail": {
4181
- "document": "实例详情",
4629
+ "document": "实例详情。",
4182
4630
  "members": [
4183
4631
  {
4184
4632
  "disabled": false,
4185
- "document": "实例ID。",
4633
+ "document": "实例 ID。",
4186
4634
  "example": "cmgo-7pje****",
4187
4635
  "member": "string",
4188
4636
  "name": "InstanceId",
@@ -4202,7 +4650,7 @@
4202
4650
  },
4203
4651
  {
4204
4652
  "disabled": false,
4205
- "document": "付费类型,可能的返回值:1-包年包月;0-按量计费",
4653
+ "document": "付费类型。\n- 1:包年包月。\n- 0:按量计费。",
4206
4654
  "example": "1",
4207
4655
  "member": "uint64",
4208
4656
  "name": "PayMode",
@@ -4212,7 +4660,7 @@
4212
4660
  },
4213
4661
  {
4214
4662
  "disabled": false,
4215
- "document": "项目ID。",
4663
+ "document": "项目 ID。",
4216
4664
  "example": "1",
4217
4665
  "member": "uint64",
4218
4666
  "name": "ProjectId",
@@ -4222,7 +4670,7 @@
4222
4670
  },
4223
4671
  {
4224
4672
  "disabled": false,
4225
- "document": "集群类型,可能的返回值:0-副本集实例,1-分片实例。",
4673
+ "document": "集群类型。\n- 0:副本集实例。\n- 1:分片实例。",
4226
4674
  "example": "1",
4227
4675
  "member": "uint64",
4228
4676
  "name": "ClusterType",
@@ -4252,7 +4700,7 @@
4252
4700
  },
4253
4701
  {
4254
4702
  "disabled": false,
4255
- "document": "网络类型,可能的返回值:0-基础网络,1-私有网络",
4703
+ "document": "网络类型。\n- 0:基础网络。\n- 1:私有网络。",
4256
4704
  "example": "1",
4257
4705
  "member": "uint64",
4258
4706
  "name": "NetType",
@@ -4282,7 +4730,7 @@
4282
4730
  },
4283
4731
  {
4284
4732
  "disabled": false,
4285
- "document": "实例状态,可能的返回值:0-创建中,1-流程处理中,2-运行中,-2-实例已过期。",
4733
+ "document": "实例状态。\n- 0:待初始化。\n- 1:流程处理中,例如:变更规格、参数修改等。\n- 2:实例正常运行中。\n- -2:已隔离(包年包月)。\n- -3:已隔离(按量计费)。",
4286
4734
  "example": "2",
4287
4735
  "member": "int64",
4288
4736
  "name": "Status",
@@ -4332,7 +4780,7 @@
4332
4780
  },
4333
4781
  {
4334
4782
  "disabled": false,
4335
- "document": "实例版本信息。",
4783
+ "document": "实例存储引擎版本信息。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
4336
4784
  "example": "MONGO_42_WT",
4337
4785
  "member": "string",
4338
4786
  "name": "MongoVersion",
@@ -4342,7 +4790,7 @@
4342
4790
  },
4343
4791
  {
4344
4792
  "disabled": false,
4345
- "document": "实例内存规格,单位为MB。",
4793
+ "document": "实例内存规格,单位:MB。",
4346
4794
  "example": "4",
4347
4795
  "member": "uint64",
4348
4796
  "name": "Memory",
@@ -4352,7 +4800,7 @@
4352
4800
  },
4353
4801
  {
4354
4802
  "disabled": false,
4355
- "document": "实例磁盘规格,单位为MB。",
4803
+ "document": "实例磁盘规格,单位:MB。",
4356
4804
  "example": "120",
4357
4805
  "member": "uint64",
4358
4806
  "name": "Volume",
@@ -4362,7 +4810,7 @@
4362
4810
  },
4363
4811
  {
4364
4812
  "disabled": false,
4365
- "document": "实例CPU核心数。",
4813
+ "document": "实例 CPU 核心数。",
4366
4814
  "example": "2",
4367
4815
  "member": "uint64",
4368
4816
  "name": "CpuNum",
@@ -4372,7 +4820,7 @@
4372
4820
  },
4373
4821
  {
4374
4822
  "disabled": false,
4375
- "document": "实例机器类型。",
4823
+ "document": "实例机器类型。\n- HIO10G:通用高 HIO 万兆型。\n- HCD:云盘版类型。",
4376
4824
  "example": "HIO10G",
4377
4825
  "member": "string",
4378
4826
  "name": "MachineType",
@@ -4402,7 +4850,7 @@
4402
4850
  },
4403
4851
  {
4404
4852
  "disabled": false,
4405
- "document": "实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费。",
4853
+ "document": "实例自动续费标志。\n- 0:手动续费。\n- 1:自动续费。\n- 2:确认不续费。",
4406
4854
  "example": "0",
4407
4855
  "member": "int64",
4408
4856
  "name": "AutoRenewFlag",
@@ -4412,7 +4860,7 @@
4412
4860
  },
4413
4861
  {
4414
4862
  "disabled": false,
4415
- "document": "已用容量,单位MB。",
4863
+ "document": "已用容量,单位:MB。",
4416
4864
  "example": "100",
4417
4865
  "member": "uint64",
4418
4866
  "name": "UsedVolume",
@@ -4522,7 +4970,7 @@
4522
4970
  },
4523
4971
  {
4524
4972
  "disabled": false,
4525
- "document": "协议信息,可能的返回值:1-mongodb,2-dynamodb。",
4973
+ "document": "协议信息:mongodb。",
4526
4974
  "example": "0",
4527
4975
  "member": "uint64",
4528
4976
  "name": "Protocol",
@@ -4532,7 +4980,7 @@
4532
4980
  },
4533
4981
  {
4534
4982
  "disabled": false,
4535
- "document": "实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例",
4983
+ "document": "实例类型。\n- 0:所有实例。\n- 1:正式实例。\n- 2:临时实例\n- 3:只读实例。\n- -1:同时包括正式实例、只读实例与灾备实例。",
4536
4984
  "example": "1",
4537
4985
  "member": "uint64",
4538
4986
  "name": "InstanceType",
@@ -4542,7 +4990,7 @@
4542
4990
  },
4543
4991
  {
4544
4992
  "disabled": false,
4545
- "document": "实例状态描述",
4993
+ "document": "实例状态描述。",
4546
4994
  "example": "运行中",
4547
4995
  "member": "string",
4548
4996
  "name": "InstanceStatusDesc",
@@ -4552,7 +5000,7 @@
4552
5000
  },
4553
5001
  {
4554
5002
  "disabled": false,
4555
- "document": "实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取",
5003
+ "document": "实例对应的物理实例 ID。回档并替换过的实例有不同的 InstanceId RealInstanceId,从 barad 获取监控数据等场景下需要用物理 ID 获取。",
4556
5004
  "example": "cmgo-8go1o9xl",
4557
5005
  "member": "string",
4558
5006
  "name": "RealInstanceId",
@@ -4572,7 +5020,7 @@
4572
5020
  },
4573
5021
  {
4574
5022
  "disabled": false,
4575
- "document": "mongos节点个数。",
5023
+ "document": "mongos 节点个数。",
4576
5024
  "example": "3",
4577
5025
  "member": "uint64",
4578
5026
  "name": "MongosNodeNum",
@@ -4582,7 +5030,7 @@
4582
5030
  },
4583
5031
  {
4584
5032
  "disabled": false,
4585
- "document": "mongos节点内存。",
5033
+ "document": "mongos 节点内存。单位:MB。",
4586
5034
  "example": "2",
4587
5035
  "member": "uint64",
4588
5036
  "name": "MongosMemory",
@@ -4592,7 +5040,7 @@
4592
5040
  },
4593
5041
  {
4594
5042
  "disabled": false,
4595
- "document": "mongos节点CPU核数。",
5043
+ "document": "mongos 节点 CPU 核数。",
4596
5044
  "example": "1",
4597
5045
  "member": "uint64",
4598
5046
  "name": "MongosCpuNum",
@@ -4612,7 +5060,7 @@
4612
5060
  },
4613
5061
  {
4614
5062
  "disabled": false,
4615
- "document": "Config Server节点内存。",
5063
+ "document": "Config Server节点内存。单位:MB。",
4616
5064
  "example": "2",
4617
5065
  "member": "uint64",
4618
5066
  "name": "ConfigServerMemory",
@@ -4622,7 +5070,7 @@
4622
5070
  },
4623
5071
  {
4624
5072
  "disabled": false,
4625
- "document": "Config Server节点磁盘大小。",
5073
+ "document": "Config Server节点磁盘大小。单位:MB。",
4626
5074
  "example": "20",
4627
5075
  "member": "uint64",
4628
5076
  "name": "ConfigServerVolume",
@@ -4632,7 +5080,7 @@
4632
5080
  },
4633
5081
  {
4634
5082
  "disabled": false,
4635
- "document": "Config Server节点CPU核数。",
5083
+ "document": "Config Server 节点 CPU 核数。",
4636
5084
  "example": "1",
4637
5085
  "member": "uint64",
4638
5086
  "name": "ConfigServerCpuNum",
@@ -5022,7 +5470,7 @@
5022
5470
  "members": [
5023
5471
  {
5024
5472
  "disabled": false,
5025
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
5473
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制需隔离的实例 ID",
5026
5474
  "example": "cmgo-f555zzzz",
5027
5475
  "member": "string",
5028
5476
  "name": "InstanceId",
@@ -5092,7 +5540,7 @@
5092
5540
  },
5093
5541
  {
5094
5542
  "disabled": false,
5095
- "document": "密钥状态。",
5543
+ "document": "密钥状态。\n- Enabled:开启。\n- Disabled:不开启。",
5096
5544
  "example": "Enabled",
5097
5545
  "member": "string",
5098
5546
  "name": "Status",
@@ -5142,7 +5590,7 @@
5142
5590
  "members": [
5143
5591
  {
5144
5592
  "disabled": false,
5145
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
5593
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
5146
5594
  "example": "cmgo-p8vnipr5",
5147
5595
  "member": "string",
5148
5596
  "name": "InstanceId",
@@ -5151,7 +5599,7 @@
5151
5599
  },
5152
5600
  {
5153
5601
  "disabled": false,
5154
- "document": "待终止的操作",
5602
+ "document": "待终止的操作。",
5155
5603
  "example": "无",
5156
5604
  "member": "Operation",
5157
5605
  "name": "Operations",
@@ -5173,6 +5621,72 @@
5173
5621
  ],
5174
5622
  "type": "object"
5175
5623
  },
5624
+ "LogInfo": {
5625
+ "document": "日志详情",
5626
+ "members": [
5627
+ {
5628
+ "disabled": false,
5629
+ "document": "日志类别\n注意:此字段可能返回 null,表示取不到有效值。",
5630
+ "example": "无",
5631
+ "member": "string",
5632
+ "name": "LogComponent",
5633
+ "output_required": false,
5634
+ "type": "string",
5635
+ "value_allowed_null": true
5636
+ },
5637
+ {
5638
+ "disabled": false,
5639
+ "document": "日志级别\n注意:此字段可能返回 null,表示取不到有效值。",
5640
+ "example": "无",
5641
+ "member": "string",
5642
+ "name": "LogLevel",
5643
+ "output_required": false,
5644
+ "type": "string",
5645
+ "value_allowed_null": true
5646
+ },
5647
+ {
5648
+ "disabled": false,
5649
+ "document": "日志产生时间\n注意:此字段可能返回 null,表示取不到有效值。",
5650
+ "example": "无",
5651
+ "member": "string",
5652
+ "name": "LogTime",
5653
+ "output_required": false,
5654
+ "type": "string",
5655
+ "value_allowed_null": true
5656
+ },
5657
+ {
5658
+ "disabled": false,
5659
+ "document": "日志详情\n注意:此字段可能返回 null,表示取不到有效值。",
5660
+ "example": "无",
5661
+ "member": "string",
5662
+ "name": "LogDetail",
5663
+ "output_required": false,
5664
+ "type": "string",
5665
+ "value_allowed_null": true
5666
+ },
5667
+ {
5668
+ "disabled": false,
5669
+ "document": "日志连接信息\n注意:此字段可能返回 null,表示取不到有效值。",
5670
+ "example": "无",
5671
+ "member": "string",
5672
+ "name": "LogConnection",
5673
+ "output_required": false,
5674
+ "type": "string",
5675
+ "value_allowed_null": true
5676
+ },
5677
+ {
5678
+ "disabled": false,
5679
+ "document": "日志id\n注意:此字段可能返回 null,表示取不到有效值。",
5680
+ "example": "无",
5681
+ "member": "string",
5682
+ "name": "LogId",
5683
+ "output_required": false,
5684
+ "type": "string",
5685
+ "value_allowed_null": true
5686
+ }
5687
+ ],
5688
+ "usage": "out"
5689
+ },
5176
5690
  "ModifyDBInstanceNetworkAddressRequest": {
5177
5691
  "document": "ModifyDBInstanceNetworkAddress请求参数结构体",
5178
5692
  "members": [
@@ -5196,7 +5710,7 @@
5196
5710
  },
5197
5711
  {
5198
5712
  "disabled": false,
5199
- "document": "切换后的私有网络 ID,若实例当前为基础网络,该字段无需配置。",
5713
+ "document": "切换后的私有网络 ID,若实例当前为基础网络,该字段无需配置。请通过接口 [DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568) 获取私有网络 ID。",
5200
5714
  "example": "vpc-****",
5201
5715
  "member": "string",
5202
5716
  "name": "NewUniqVpcId",
@@ -5205,7 +5719,7 @@
5205
5719
  },
5206
5720
  {
5207
5721
  "disabled": false,
5208
- "document": "切换私有网络的子网 ID。若实例当前为基础网络,该字段无需配置。",
5722
+ "document": "切换后私有网络的子网 ID。若实例当前为基础网络,该字段无需配置。请通过接口 [DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568) 获取私有网络的子网 ID。",
5209
5723
  "example": "subnet-****",
5210
5724
  "member": "string",
5211
5725
  "name": "NewUniqSubnetId",
@@ -5251,7 +5765,7 @@
5251
5765
  "members": [
5252
5766
  {
5253
5767
  "disabled": false,
5254
- "document": "待修改的参数模板 ID,示例:tpl-jglr91vew。",
5768
+ "document": "待修改的参数模板 ID。请通过接口 [DescribeDBInstanceParamTpl](https://cloud.tencent.com/document/product/240/109155) 获取模板 ID。",
5255
5769
  "example": "tpl-sdh134udi",
5256
5770
  "member": "string",
5257
5771
  "name": "TplId",
@@ -5305,7 +5819,7 @@
5305
5819
  "members": [
5306
5820
  {
5307
5821
  "disabled": false,
5308
- "document": "实例 ID。例如:cmgo-7pje****。",
5822
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
5309
5823
  "example": "cmgo-7pjedvz7",
5310
5824
  "member": "string",
5311
5825
  "name": "InstanceId",
@@ -5314,7 +5828,7 @@
5314
5828
  },
5315
5829
  {
5316
5830
  "disabled": false,
5317
- "document": "目标安全组 ID。请通过接口[DescribeSecurityGroup](https://cloud.tencent.com/document/product/240/55675)查看具体的安全组 ID。\n**注意**:该入参会全量替换存量已有集合,非增量更新。修改需传入预期的全量集合。",
5831
+ "document": "目标安全组 ID。请登录[安全组控制台页面](https://console.cloud.tencent.com/vpc/security-group)复制目标安全组 ID。\n**注意**:该入参会全量替换存量已有集合,非增量更新。修改需传入预期的全量集合。",
5318
5832
  "example": "[\"sg-a\", \"sg-b\"]",
5319
5833
  "member": "string",
5320
5834
  "name": "SecurityGroupIds",
@@ -5341,8 +5855,8 @@
5341
5855
  "members": [
5342
5856
  {
5343
5857
  "disabled": false,
5344
- "document": "实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。\n",
5345
- "example": "cmgo-p8vnipr5",
5858
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
5859
+ "example": "cmgo-p8vn****",
5346
5860
  "member": "string",
5347
5861
  "name": "InstanceId",
5348
5862
  "required": true,
@@ -5350,7 +5864,7 @@
5350
5864
  },
5351
5865
  {
5352
5866
  "disabled": false,
5353
- "document": "实例配置变更后的内存大小。- 单位:GB。为空时,默认取实例当前的内存大小。<br> 注意:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。",
5867
+ "document": "实例配置变更后的内存大小。单位:GB。该参数为空值时,默认取实例当前的内存大小。当前所支持的内存规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。\n**注意**:内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。",
5354
5868
  "example": "4",
5355
5869
  "member": "uint64",
5356
5870
  "name": "Memory",
@@ -5359,7 +5873,7 @@
5359
5873
  },
5360
5874
  {
5361
5875
  "disabled": false,
5362
- "document": "实例配置变更后的硬盘大小,单位:GB。为空时,默认取当前实例的磁盘大小。\n- 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。\n- 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。",
5876
+ "document": "实例配置变更后的硬盘大小,单位:GB。该参数为空值时,默认取当前实例的磁盘大小。当前所支持的磁盘容量,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。\n- 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。\n- 降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。",
5363
5877
  "example": "250",
5364
5878
  "member": "uint64",
5365
5879
  "name": "Volume",
@@ -5377,7 +5891,7 @@
5377
5891
  },
5378
5892
  {
5379
5893
  "disabled": false,
5380
- "document": "实例变更后mongod的节点数(不包含readonly节点数)。\n- 变更mongod CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。\n- 变更 mongos CPU与内存规格时,该参数可以不配置或者输入当前 mongod(不包含readonly) 节点数量。\n- 节点变更时(全部类型),该参数可不配置或输入变更后的 mongod(不包含readonly) 节点数量。\n- 副本集节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。\n- 分片集群每个分片节点数:请确认节点数量取值范围,通过云数据库的售卖规格 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38565)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。",
5894
+ "document": "实例变更后 mongod 的节点数(不包含 readonly 只读节点数)。\n- 副本集节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取节点数量取值范围。\n- 分片集群每个分片节点数:请通过 [DescribeSpecInfo ](https://cloud.tencent.com/document/product/240/38567)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取节点数量取值范围。\n**说明**:变更 mongod 或 mongos 的 CPU 与内存规格时,该参数可以不配置或者输入当前 mongod 或 mongos(不包含readonly)节点数量。",
5381
5895
  "example": "3",
5382
5896
  "member": "uint64",
5383
5897
  "name": "NodeNum",
@@ -5386,7 +5900,7 @@
5386
5900
  },
5387
5901
  {
5388
5902
  "disabled": false,
5389
- "document": "实例变更后的分片数。\n- 取值范围请通过云数据库的售卖规格[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取。- 该参数只能增加不能减少。",
5903
+ "document": "实例变更后的分片数。\n- 请通过 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 接口返回的参数**MinReplicateSetNum**与**MaxReplicateSetNum**获取实例分片数取值范围。\n- 实例分片数量只允许增加不允许减少。",
5390
5904
  "example": "3",
5391
5905
  "member": "uint64",
5392
5906
  "name": "ReplicateSetNum",
@@ -5404,7 +5918,7 @@
5404
5918
  },
5405
5919
  {
5406
5920
  "disabled": false,
5407
- "document": "分片实例配置变更后的mongos内存大小。单位:GB。",
5921
+ "document": "分片实例配置变更后的 mongos 内存大小。单位:GB。实例支持的规格,请参见[产品规格](https://cloud.tencent.com/document/product/240/64125)。",
5408
5922
  "example": "2",
5409
5923
  "member": "string",
5410
5924
  "name": "MongosMemory",
@@ -5422,7 +5936,7 @@
5422
5936
  },
5423
5937
  {
5424
5938
  "disabled": false,
5425
- "document": "删除节点列表,注意:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。",
5939
+ "document": "删除节点列表。\n**注意**:基于分片实例各片节点的一致性原则,删除分片实例节点时,只需指定0分片对应的节点即可,如:cmgo-9nl1czif_0-node-readonly0 将删除每个分片的第1个只读节点。",
5426
5940
  "example": "无",
5427
5941
  "member": "RemoveNodeList",
5428
5942
  "name": "RemoveNodeList",
@@ -5612,7 +6126,7 @@
5612
6126
  },
5613
6127
  {
5614
6128
  "disabled": false,
5615
- "document": "角色。",
6129
+ "document": "节点角色。\n- PRIMARY:主节点。\n- SECONDARY:从节点。\n- READONLY:只读节点。\n- ARBITER:仲裁节点。",
5616
6130
  "example": "PRIMARY",
5617
6131
  "member": "string",
5618
6132
  "name": "Role",
@@ -5622,7 +6136,7 @@
5622
6136
  },
5623
6137
  {
5624
6138
  "disabled": false,
5625
- "document": "是否为Hidden节点",
6139
+ "document": "节点是否为 Hidden 节点。\n- true:Hidden 节点。\n- false:非 Hidden 节点。",
5626
6140
  "example": "false",
5627
6141
  "member": "bool",
5628
6142
  "name": "Hidden",
@@ -5632,7 +6146,7 @@
5632
6146
  },
5633
6147
  {
5634
6148
  "disabled": false,
5635
- "document": "节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。",
6149
+ "document": "节点状态。\n- NORMAL:正常运行中。\n- STARTUP:正在启动。\n- STARTUP2:正在启动,处理中间数据。\n- RECOVERING:恢复中,暂不可用。\n- DOWN:已掉线。\n- UNKNOWN:未知状态。\n- ROLLBACK:回滚中。\n- REMOVED:已移除。",
5636
6150
  "example": "NORMAL",
5637
6151
  "member": "string",
5638
6152
  "name": "Status",
@@ -5642,7 +6156,7 @@
5642
6156
  },
5643
6157
  {
5644
6158
  "disabled": false,
5645
- "document": "主从延迟,单位秒。",
6159
+ "document": "主从同步延迟时间,单位:秒。",
5646
6160
  "example": "1",
5647
6161
  "member": "int64",
5648
6162
  "name": "SlaveDelay",
@@ -5652,7 +6166,7 @@
5652
6166
  },
5653
6167
  {
5654
6168
  "disabled": false,
5655
- "document": "节点优先级。",
6169
+ "document": "节点优先级。其取值范围为[0,100],数值越高,优先级越高。",
5656
6170
  "example": "10",
5657
6171
  "member": "int64",
5658
6172
  "name": "Priority",
@@ -5662,7 +6176,7 @@
5662
6176
  },
5663
6177
  {
5664
6178
  "disabled": false,
5665
- "document": "节点投票权。",
6179
+ "document": "节点投票权。\n- 1:具有投票权。\n- 0:无投票权。",
5666
6180
  "example": "1",
5667
6181
  "member": "int64",
5668
6182
  "name": "Votes",
@@ -5672,17 +6186,17 @@
5672
6186
  },
5673
6187
  {
5674
6188
  "disabled": false,
5675
- "document": "节点标签。",
6189
+ "document": "节点标签。\n注意:此字段可能返回 null,表示取不到有效值。",
5676
6190
  "example": "[{\"TagKey\":\"role-cmgo\",\"TagValue\":\"primary-secondary-group\"}]",
5677
6191
  "member": "NodeTag",
5678
6192
  "name": "Tags",
5679
6193
  "output_required": false,
5680
6194
  "type": "list",
5681
- "value_allowed_null": false
6195
+ "value_allowed_null": true
5682
6196
  },
5683
6197
  {
5684
6198
  "disabled": false,
5685
- "document": "副本集Id。",
6199
+ "document": "副本集 ID。",
5686
6200
  "example": "cmgo-ocdv****_0",
5687
6201
  "member": "string",
5688
6202
  "name": "ReplicateSetId",
@@ -5726,7 +6240,7 @@
5726
6240
  "members": [
5727
6241
  {
5728
6242
  "disabled": false,
5729
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
6243
+ "document": "实例ID。请登录 [MongoDB 控制台回收站](https://console.cloud.tencent.com/mongodb/recycle)在实例列表复制需下线的实例 ID",
5730
6244
  "example": "cmgo-f555zzzz",
5731
6245
  "member": "string",
5732
6246
  "name": "InstanceId",
@@ -5742,10 +6256,10 @@
5742
6256
  {
5743
6257
  "disabled": false,
5744
6258
  "document": "异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。",
5745
- "example": "28920",
6259
+ "example": "\"28920\"",
5746
6260
  "member": "string",
5747
6261
  "name": "AsyncRequestId",
5748
- "required": true,
6262
+ "output_required": true,
5749
6263
  "type": "string",
5750
6264
  "value_allowed_null": false
5751
6265
  },
@@ -5759,11 +6273,11 @@
5759
6273
  "type": "object"
5760
6274
  },
5761
6275
  "Operation": {
5762
- "document": "需要终止的操作",
6276
+ "document": "需要终止的操作。",
5763
6277
  "members": [
5764
6278
  {
5765
6279
  "disabled": false,
5766
- "document": "操作所在的分片名",
6280
+ "document": "操作所在的分片名称。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询分片名称。",
5767
6281
  "example": "cmgo-bbzl****_0",
5768
6282
  "member": "string",
5769
6283
  "name": "ReplicaSetName",
@@ -5772,7 +6286,7 @@
5772
6286
  },
5773
6287
  {
5774
6288
  "disabled": false,
5775
- "document": "操作所在的节点名",
6289
+ "document": "操作所在的节点名。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询节点名称。",
5776
6290
  "example": "30.99.***.*:7005:244****",
5777
6291
  "member": "string",
5778
6292
  "name": "NodeName",
@@ -5781,7 +6295,7 @@
5781
6295
  },
5782
6296
  {
5783
6297
  "disabled": false,
5784
- "document": "操作序号",
6298
+ "document": "操作序号。请通过接口 [DescribeCurrentOp](https://cloud.tencent.com/document/product/240/48120) 查询操作序号。",
5785
6299
  "example": "918759117",
5786
6300
  "member": "int64",
5787
6301
  "name": "OpId",
@@ -5796,61 +6310,61 @@
5796
6310
  "members": [
5797
6311
  {
5798
6312
  "disabled": false,
5799
- "document": "参数模板名称",
6313
+ "document": "参数模板名称。",
5800
6314
  "example": "压测参数模板",
5801
6315
  "member": "string",
5802
6316
  "name": "TplName",
5803
- "required": true,
6317
+ "output_required": true,
5804
6318
  "type": "string",
5805
6319
  "value_allowed_null": false
5806
6320
  },
5807
6321
  {
5808
6322
  "disabled": false,
5809
- "document": "参数模板ID",
6323
+ "document": "参数模板 ID",
5810
6324
  "example": "tpl-adh42hg1y",
5811
6325
  "member": "string",
5812
6326
  "name": "TplId",
5813
- "required": true,
6327
+ "output_required": true,
5814
6328
  "type": "string",
5815
6329
  "value_allowed_null": false
5816
6330
  },
5817
6331
  {
5818
6332
  "disabled": false,
5819
- "document": "适用数据库版本",
6333
+ "document": "参数模板适用的数据库版本。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本,\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本,\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
5820
6334
  "example": "MONGO_42_WT",
5821
6335
  "member": "string",
5822
6336
  "name": "MongoVersion",
5823
- "required": true,
6337
+ "output_required": true,
5824
6338
  "type": "string",
5825
6339
  "value_allowed_null": false
5826
6340
  },
5827
6341
  {
5828
6342
  "disabled": false,
5829
- "document": "适用数据库类型",
6343
+ "document": "参数模板适用的数据库类型。\n- REPLSET:副本集实例。\n- SHARD:分片实例。\n- STANDALONE:单节点实例。",
5830
6344
  "example": "SHARD",
5831
6345
  "member": "string",
5832
6346
  "name": "ClusterType",
5833
- "required": true,
6347
+ "output_required": true,
5834
6348
  "type": "string",
5835
6349
  "value_allowed_null": false
5836
6350
  },
5837
6351
  {
5838
6352
  "disabled": false,
5839
- "document": "参数模板描述",
6353
+ "document": "参数模板描述。",
5840
6354
  "example": "用于压测",
5841
6355
  "member": "string",
5842
6356
  "name": "TplDesc",
5843
- "required": true,
6357
+ "output_required": true,
5844
6358
  "type": "string",
5845
6359
  "value_allowed_null": false
5846
6360
  },
5847
6361
  {
5848
6362
  "disabled": false,
5849
- "document": "模板类型,包括DEFAULT(默认模板)及CUSTOMIZE(定制模板)两种类型",
6363
+ "document": "模板类型。\n- DEFAULT:系统默认模板。\n- CUSTOMIZE:自定义模板。",
5850
6364
  "example": "DEFAULT",
5851
6365
  "member": "string",
5852
6366
  "name": "TplType",
5853
- "required": true,
6367
+ "output_required": true,
5854
6368
  "type": "string",
5855
6369
  "value_allowed_null": false
5856
6370
  }
@@ -5884,7 +6398,7 @@
5884
6398
  "usage": "both"
5885
6399
  },
5886
6400
  "RemoveNodeList": {
5887
- "document": "修改实例节点详情",
6401
+ "document": "修改实例节点详情。",
5888
6402
  "members": [
5889
6403
  {
5890
6404
  "disabled": false,
@@ -5897,7 +6411,7 @@
5897
6411
  },
5898
6412
  {
5899
6413
  "disabled": false,
5900
- "document": "要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对改组对齐。\n\n- 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/),在**节点管理**页签,可获取**节点 ID**。\n- 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk****_0-node-primary。",
6414
+ "document": "要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对该组对齐。\n- 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/mongodb),在**节点管理**页签,可获取**节点 ID**。\n- 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk\\*\\*\\*\\*\\_0-node-primary。",
5901
6415
  "example": "cmgo-3iecwbfx_0-node-readonly0",
5902
6416
  "member": "string",
5903
6417
  "name": "NodeName",
@@ -5906,7 +6420,7 @@
5906
6420
  },
5907
6421
  {
5908
6422
  "disabled": false,
5909
- "document": "节点所对应的可用区。\n- 单可用区,所有节点在同一可用区。\n- 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。",
6423
+ "document": "节点所对应的可用区。当前支持可用区信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/240/3637)。\n- 单可用区,所有节点在同一可用区。\n- 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。",
5910
6424
  "example": "ap-guangzhou-2",
5911
6425
  "member": "string",
5912
6426
  "name": "Zone",
@@ -5957,7 +6471,7 @@
5957
6471
  "members": [
5958
6472
  {
5959
6473
  "disabled": false,
5960
- "document": "指定续费的一个或多个待操作的实例ID。\n- 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceIds**获取。\n- 每次续费请求的实例数量上限为100。",
6474
+ "document": "指定续费的一个或多个待操作的实例ID。\n- 可通过[DescribeDBInstances](https://cloud.tencent.com/document/product/240/38568)接口返回值中的**InstanceId**获取。\n- 每次续费请求的实例数量上限为100。",
5961
6475
  "example": "[\"cmgo-gzo0****\"]",
5962
6476
  "member": "string",
5963
6477
  "name": "InstanceIds",
@@ -5989,17 +6503,16 @@
5989
6503
  "type": "object"
5990
6504
  },
5991
6505
  "ReplicaSetInfo": {
5992
- "document": "分片信息",
6506
+ "document": "分片信息。",
5993
6507
  "members": [
5994
6508
  {
5995
6509
  "disabled": false,
5996
- "document": "副本集ID",
6510
+ "document": "副本集 ID",
5997
6511
  "example": "cmgo_ih8uido9_0",
5998
6512
  "member": "string",
5999
6513
  "name": "ReplicaSetId",
6000
6514
  "required": true,
6001
- "type": "string",
6002
- "value_allowed_null": false
6515
+ "type": "string"
6003
6516
  }
6004
6517
  ],
6005
6518
  "usage": "in"
@@ -6025,7 +6538,7 @@
6025
6538
  "members": [
6026
6539
  {
6027
6540
  "disabled": false,
6028
- "document": "实例Id",
6541
+ "document": "指定实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
6029
6542
  "example": "cmgo-7pjedvz7",
6030
6543
  "member": "string",
6031
6544
  "name": "InstanceId",
@@ -6034,7 +6547,7 @@
6034
6547
  },
6035
6548
  {
6036
6549
  "disabled": false,
6037
- "document": "实例账号名",
6550
+ "document": "指定需修改密码的账号名称。可通过接口 [DescribeAccountUsers](https://cloud.tencent.com/document/product/240/80800) 获取账号列表,复制需修改密码的账号。",
6038
6551
  "example": "rwuser",
6039
6552
  "member": "string",
6040
6553
  "name": "UserName",
@@ -6043,8 +6556,8 @@
6043
6556
  },
6044
6557
  {
6045
6558
  "disabled": false,
6046
- "document": "新密码,新密码长度不能少于8",
6047
- "example": "111111",
6559
+ "document": "指定账户的新密码。密码复杂度要求:\n- 8-32个字符长度。\n- 至少包含字母、数字和字符(!@#%^\\*()\\_)中的两种。",
6560
+ "example": "test_123***",
6048
6561
  "member": "string",
6049
6562
  "name": "Password",
6050
6563
  "required": true,
@@ -6058,11 +6571,11 @@
6058
6571
  "members": [
6059
6572
  {
6060
6573
  "disabled": false,
6061
- "document": "异步请求Id,用户查询该流程的运行状态",
6574
+ "document": "任务请求 ID。",
6062
6575
  "example": "4769",
6063
6576
  "member": "string",
6064
6577
  "name": "AsyncRequestId",
6065
- "required": true,
6578
+ "output_required": true,
6066
6579
  "type": "string",
6067
6580
  "value_allowed_null": false
6068
6581
  },
@@ -6080,8 +6593,8 @@
6080
6593
  "members": [
6081
6594
  {
6082
6595
  "disabled": false,
6083
- "document": "实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。",
6084
- "example": "cmgo-p8vnipr5",
6596
+ "document": "实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID",
6597
+ "example": "cmgo-p8vn****",
6085
6598
  "member": "string",
6086
6599
  "name": "InstanceId",
6087
6600
  "required": true,
@@ -6089,7 +6602,7 @@
6089
6602
  },
6090
6603
  {
6091
6604
  "disabled": false,
6092
- "document": "节点Id。",
6605
+ "document": "需要重启的节点 ID 列表。\n- 支持重启的节点类型包含:mongod节点、只读节点、mongos节点。\n- 节点 ID,请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在**节点管理**页面复制,或者通过 [DescribeDBInstanceNodeProperty ](https://cloud.tencent.com/document/product/240/82022)接口获取。",
6093
6606
  "example": "[\"cmgo-6heje4jp_0-node-slave0\",\"cmgo-6heje4jp_1-node-slave0\"]",
6094
6607
  "member": "string",
6095
6608
  "name": "NodeIds",
@@ -6104,11 +6617,11 @@
6104
6617
  "members": [
6105
6618
  {
6106
6619
  "disabled": false,
6107
- "document": "流程Id。",
6620
+ "document": "流程 ID。",
6108
6621
  "example": "2313431",
6109
6622
  "member": "int64",
6110
6623
  "name": "FlowId",
6111
- "required": true,
6624
+ "output_required": true,
6112
6625
  "type": "int",
6113
6626
  "value_allowed_null": false
6114
6627
  },
@@ -6126,71 +6639,71 @@
6126
6639
  "members": [
6127
6640
  {
6128
6641
  "disabled": false,
6129
- "document": "所属项目id",
6642
+ "document": "所属项目 ID。",
6130
6643
  "example": "0",
6131
6644
  "member": "int64",
6132
6645
  "name": "ProjectId",
6133
- "required": true,
6646
+ "output_required": true,
6134
6647
  "type": "int",
6135
6648
  "value_allowed_null": false
6136
6649
  },
6137
6650
  {
6138
6651
  "disabled": false,
6139
- "document": "创建时间",
6652
+ "document": "安全组创建时间。",
6140
6653
  "example": "2021-01-02 15:04:05",
6141
6654
  "member": "string",
6142
6655
  "name": "CreateTime",
6143
- "required": true,
6656
+ "output_required": true,
6144
6657
  "type": "string",
6145
6658
  "value_allowed_null": false
6146
6659
  },
6147
6660
  {
6148
6661
  "disabled": false,
6149
- "document": "入站规则",
6662
+ "document": "安全组入站规则。",
6150
6663
  "example": "无",
6151
6664
  "member": "SecurityGroupBound",
6152
6665
  "name": "Inbound",
6153
- "required": true,
6666
+ "output_required": true,
6154
6667
  "type": "list",
6155
6668
  "value_allowed_null": false
6156
6669
  },
6157
6670
  {
6158
6671
  "disabled": false,
6159
- "document": "出站规则",
6672
+ "document": "安全组出站规则。",
6160
6673
  "example": "无",
6161
6674
  "member": "SecurityGroupBound",
6162
6675
  "name": "Outbound",
6163
- "required": true,
6676
+ "output_required": true,
6164
6677
  "type": "list",
6165
6678
  "value_allowed_null": false
6166
6679
  },
6167
6680
  {
6168
6681
  "disabled": false,
6169
- "document": "安全组id",
6170
- "example": "sg-lxdvbitn",
6682
+ "document": "安全组 ID。",
6683
+ "example": "sg-lxdv****",
6171
6684
  "member": "string",
6172
6685
  "name": "SecurityGroupId",
6173
- "required": true,
6686
+ "output_required": true,
6174
6687
  "type": "string",
6175
6688
  "value_allowed_null": false
6176
6689
  },
6177
6690
  {
6178
6691
  "disabled": false,
6179
- "document": "安全组名称",
6180
- "example": "全放通",
6692
+ "document": "安全组名称。",
6693
+ "example": "Security Test",
6181
6694
  "member": "string",
6182
6695
  "name": "SecurityGroupName",
6183
- "required": true,
6696
+ "output_required": true,
6184
6697
  "type": "string",
6185
6698
  "value_allowed_null": false
6186
6699
  },
6187
6700
  {
6188
6701
  "disabled": false,
6189
- "document": "安全组备注",
6702
+ "document": "安全组备注信息。",
6190
6703
  "example": "暴露全部端口到公网和内网,有一定安全风险",
6191
6704
  "member": "string",
6192
6705
  "name": "SecurityGroupRemark",
6193
- "required": true,
6706
+ "output_required": true,
6194
6707
  "type": "string",
6195
6708
  "value_allowed_null": false
6196
6709
  }
@@ -6202,7 +6715,7 @@
6202
6715
  "members": [
6203
6716
  {
6204
6717
  "disabled": false,
6205
- "document": "执行规则。ACCEPTDROP",
6718
+ "document": "执行策略。\n- ACCEPT:允许,放行该端口相应的访问请求。\n- DROP:拒绝,直接丢弃数据包,不返回任何回应信息。",
6206
6719
  "example": "ACCEPT",
6207
6720
  "member": "string",
6208
6721
  "name": "Action",
@@ -6212,7 +6725,7 @@
6212
6725
  },
6213
6726
  {
6214
6727
  "disabled": false,
6215
- "document": "ip段。",
6728
+ "document": "访问数据库的入站 IP 或 IP 段。",
6216
6729
  "example": "0.0.0.0/0",
6217
6730
  "member": "string",
6218
6731
  "name": "CidrIp",
@@ -6222,7 +6735,7 @@
6222
6735
  },
6223
6736
  {
6224
6737
  "disabled": false,
6225
- "document": "端口范围",
6738
+ "document": "访问数据库的端口。",
6226
6739
  "example": "80,443",
6227
6740
  "member": "string",
6228
6741
  "name": "PortRange",
@@ -6232,7 +6745,7 @@
6232
6745
  },
6233
6746
  {
6234
6747
  "disabled": false,
6235
- "document": "传输层协议。tcp,udp或ALL",
6748
+ "document": "传输层协议:tcp",
6236
6749
  "example": "tcp",
6237
6750
  "member": "string",
6238
6751
  "name": "IpProtocol",
@@ -6242,8 +6755,8 @@
6242
6755
  },
6243
6756
  {
6244
6757
  "disabled": false,
6245
- "document": "安全组id代表的地址集合",
6246
- "example": "sg-",
6758
+ "document": "安全组 ID。",
6759
+ "example": "sg-kayh****",
6247
6760
  "member": "string",
6248
6761
  "name": "Id",
6249
6762
  "output_required": true,
@@ -6252,8 +6765,8 @@
6252
6765
  },
6253
6766
  {
6254
6767
  "disabled": false,
6255
- "document": "地址组id代表的地址集合",
6256
- "example": "地址集合",
6768
+ "document": "IP 地址或 IP 地址组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/ip)获取参数模板 IP 地址详情。",
6769
+ "example": "ipm-0h4k****",
6257
6770
  "member": "string",
6258
6771
  "name": "AddressModule",
6259
6772
  "output_required": true,
@@ -6262,8 +6775,8 @@
6262
6775
  },
6263
6776
  {
6264
6777
  "disabled": false,
6265
- "document": "服务组id代表的协议和端口集合",
6266
- "example": "协议和端口集合",
6778
+ "document": "协议端口或协议端口组参数模板 ID。请登录[参数模板控制台](https://console.cloud.tencent.com/vpc/template/protoport)获取参数模板协议端口详情。",
6779
+ "example": "ppm-ay7b****",
6267
6780
  "member": "string",
6268
6781
  "name": "ServiceModule",
6269
6782
  "output_required": true,
@@ -6272,7 +6785,7 @@
6272
6785
  },
6273
6786
  {
6274
6787
  "disabled": false,
6275
- "document": "描述",
6788
+ "document": "安全组描述信息。",
6276
6789
  "example": "my-SecurityGroupBound",
6277
6790
  "member": "string",
6278
6791
  "name": "Desc",
@@ -6297,8 +6810,8 @@
6297
6810
  },
6298
6811
  {
6299
6812
  "disabled": false,
6300
- "document": "设置账号名称。",
6301
- "example": "bob",
6813
+ "document": "设置访问实例的账号名称。设置要求为:字母开头的1-64个字符,只可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。",
6814
+ "example": "test_123",
6302
6815
  "member": "string",
6303
6816
  "name": "UserName",
6304
6817
  "required": true,
@@ -6307,7 +6820,7 @@
6307
6820
  {
6308
6821
  "disabled": false,
6309
6822
  "document": "设置权限信息。",
6310
- "example": "11",
6823
+ "example": "",
6311
6824
  "member": "Auth",
6312
6825
  "name": "AuthRole",
6313
6826
  "required": true,
@@ -6325,6 +6838,7 @@
6325
6838
  "example": "100000",
6326
6839
  "member": "uint64",
6327
6840
  "name": "FlowId",
6841
+ "output_required": true,
6328
6842
  "type": "int",
6329
6843
  "value_allowed_null": false
6330
6844
  },
@@ -6343,7 +6857,7 @@
6343
6857
  {
6344
6858
  "disabled": false,
6345
6859
  "document": "实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。",
6346
- "example": "cmgo-p8vnipr5",
6860
+ "example": "cmgo-p8vn****",
6347
6861
  "member": "string",
6348
6862
  "name": "InstanceId",
6349
6863
  "required": true,
@@ -6351,7 +6865,7 @@
6351
6865
  },
6352
6866
  {
6353
6867
  "disabled": false,
6354
- "document": "设置自动备份方式。- 0:逻辑备份。- 1:物理备份。-3:快照备份(仅云盘版支持)。",
6868
+ "document": "备份方式。\n- 0:逻辑备份。\n- 1:物理备份。\n- 3:快照备份。\n**说明**:\n1. 通用版实例支持逻辑备份与物理备份。云盘版实例支持物理备份与快照备份,暂不支持逻辑备份。\n2. 实例开通存储加密,则备份方式不能为物理备份。",
6355
6869
  "example": "1",
6356
6870
  "member": "uint64",
6357
6871
  "name": "BackupMethod",
@@ -6572,8 +7086,8 @@
6572
7086
  "members": [
6573
7087
  {
6574
7088
  "disabled": false,
6575
- "document": "慢日志",
6576
- "example": "",
7089
+ "document": "慢日志详情。",
7090
+ "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), **********\"",
6577
7091
  "member": "string",
6578
7092
  "name": "Log",
6579
7093
  "output_required": false,
@@ -6582,8 +7096,8 @@
6582
7096
  },
6583
7097
  {
6584
7098
  "disabled": false,
6585
- "document": "节点名称",
6586
- "example": "",
7099
+ "document": "节点名称。",
7100
+ "example": "\"cmgo-r3p8hslf_0-node-primary\"",
6587
7101
  "member": "string",
6588
7102
  "name": "NodeName",
6589
7103
  "output_required": false,
@@ -6592,8 +7106,8 @@
6592
7106
  },
6593
7107
  {
6594
7108
  "disabled": false,
6595
- "document": "queryHash",
6596
- "example": "",
7109
+ "document": "查询哈希值。",
7110
+ "example": "\"admin..*****Continue\"",
6597
7111
  "member": "string",
6598
7112
  "name": "QueryHash",
6599
7113
  "output_required": false,
@@ -6608,8 +7122,8 @@
6608
7122
  "members": [
6609
7123
  {
6610
7124
  "disabled": false,
6611
- "document": "慢日志模式",
6612
- "example": "2024-12-08T18:09:23.364+0800",
7125
+ "document": "慢日志输出格式:库名.表名.命令。",
7126
+ "example": "admin.$cmd.command",
6613
7127
  "member": "string",
6614
7128
  "name": "Pattern",
6615
7129
  "output_required": true,
@@ -6618,8 +7132,8 @@
6618
7132
  },
6619
7133
  {
6620
7134
  "disabled": false,
6621
- "document": "queryHash",
6622
- "example": "abcdefg",
7135
+ "document": "记录慢日志时所带的queryHash 值,标识一类查询。",
7136
+ "example": "83BAE67C",
6623
7137
  "member": "string",
6624
7138
  "name": "QueryHash",
6625
7139
  "output_required": false,
@@ -6628,7 +7142,7 @@
6628
7142
  },
6629
7143
  {
6630
7144
  "disabled": false,
6631
- "document": "最大执行时间",
7145
+ "document": "最大执行时间。单位:毫秒。",
6632
7146
  "example": "578",
6633
7147
  "member": "uint64",
6634
7148
  "name": "MaxTime",
@@ -6638,7 +7152,7 @@
6638
7152
  },
6639
7153
  {
6640
7154
  "disabled": false,
6641
- "document": "平均执行时间",
7155
+ "document": "平均执行时间。单位:毫秒。",
6642
7156
  "example": "546",
6643
7157
  "member": "uint64",
6644
7158
  "name": "AverageTime",
@@ -6648,8 +7162,8 @@
6648
7162
  },
6649
7163
  {
6650
7164
  "disabled": false,
6651
- "document": "该模式慢日志条数",
6652
- "example": "1",
7165
+ "document": "慢日志条数。",
7166
+ "example": "8",
6653
7167
  "member": "uint64",
6654
7168
  "name": "Total",
6655
7169
  "output_required": true,
@@ -6660,11 +7174,11 @@
6660
7174
  "usage": "out"
6661
7175
  },
6662
7176
  "SpecItem": {
6663
- "document": "mongodb售卖规格",
7177
+ "document": "mongodb售卖规格。",
6664
7178
  "members": [
6665
7179
  {
6666
7180
  "disabled": false,
6667
- "document": "规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。\n- 节点类型,如下所示。\n - mongo:Mongod 节点。\n - mongos:Mongos 节点。\n - cfgstr:Configserver 节点。\n- 规格类型,如下所示。\n - HIO10G:通用高HIO万兆型。\n - HCD:云盘版类型。\n- 内存规格,如下所示:\n - 支持4、8、16、32、64、128、240、512。\n - 单位g:表示GB。128g则表示128GB。",
7181
+ "document": "规格信息标识。格式如:mongo.HIO10G.128g。由节点类型、规格类型、内存规格三部分组成。\n- 节点类型:**mongo**,指 Mongod 节点;**mongos**,指 Mongos 节点;**cfgstr**,指 Configserver 节点。\n- 规格类型:**HIO10G**,指通用高HIO万兆型;**HCD**:指云盘版类型。\n- 内存规格:支持4、8、16、32、64、128、240、512。单位g:表示GB。128g 则表示128GB。",
6668
7182
  "example": "mongo.HIO10G.128g",
6669
7183
  "member": "string",
6670
7184
  "name": "SpecCode",
@@ -6754,8 +7268,8 @@
6754
7268
  },
6755
7269
  {
6756
7270
  "disabled": false,
6757
- "document": "实例存储引擎版本信息。\n- MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。",
6758
- "example": "MONGO_36_WT",
7271
+ "document": "实例存储引擎版本信息。\n- MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。\n- MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。\n- MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。\n- MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。\n- MONGO_60_WT:MongoDB 6.0 WiredTiger存储引擎版本。\n- MONGO_70_WT:MongoDB 7.0 WiredTiger存储引擎版本。",
7272
+ "example": "MONGO_50_WT",
6759
7273
  "member": "string",
6760
7274
  "name": "MongoVersionCode",
6761
7275
  "output_required": true,
@@ -6774,7 +7288,7 @@
6774
7288
  },
6775
7289
  {
6776
7290
  "disabled": false,
6777
- "document": "实例版本信息。支持:3.6、4.2、4.4、5.0、6.0。\n",
7291
+ "document": "实例版本信息。支持:4.2、4.4、5.0、6.0、7.0。",
6778
7292
  "example": "3.6",
6779
7293
  "member": "string",
6780
7294
  "name": "Version",
@@ -6876,11 +7390,11 @@
6876
7390
  "usage": "out"
6877
7391
  },
6878
7392
  "SpecificationInfo": {
6879
- "document": "实例规格信息",
7393
+ "document": "实例规格信息。",
6880
7394
  "members": [
6881
7395
  {
6882
7396
  "disabled": false,
6883
- "document": "地域信息",
7397
+ "document": "地域信息。",
6884
7398
  "example": "ap-guangzhou",
6885
7399
  "member": "string",
6886
7400
  "name": "Region",
@@ -6890,7 +7404,7 @@
6890
7404
  },
6891
7405
  {
6892
7406
  "disabled": false,
6893
- "document": "可用区信息",
7407
+ "document": "可用区信息。",
6894
7408
  "example": "ap-guangzhou-1",
6895
7409
  "member": "string",
6896
7410
  "name": "Zone",
@@ -6900,7 +7414,7 @@
6900
7414
  },
6901
7415
  {
6902
7416
  "disabled": false,
6903
- "document": "售卖规格信息",
7417
+ "document": "售卖规格信息。",
6904
7418
  "example": "无",
6905
7419
  "member": "SpecItem",
6906
7420
  "name": "SpecItems",
@@ -6910,7 +7424,7 @@
6910
7424
  },
6911
7425
  {
6912
7426
  "disabled": false,
6913
- "document": "是否支持跨可用区部署 1-支持,0-不支持",
7427
+ "document": "是否支持跨可用区部署。\n- 1:支持。\n- 0:不支持。",
6914
7428
  "example": "1",
6915
7429
  "member": "int64",
6916
7430
  "name": "SupportMultiAZ",
@@ -6949,12 +7463,106 @@
6949
7463
  ],
6950
7464
  "usage": "both"
6951
7465
  },
7466
+ "Task": {
7467
+ "document": "日志下载任务描述",
7468
+ "members": [
7469
+ {
7470
+ "disabled": false,
7471
+ "document": "下载任务类型,0:慢日志,1:错误日志",
7472
+ "example": "1",
7473
+ "member": "int64",
7474
+ "name": "TaskType",
7475
+ "output_required": false,
7476
+ "required": false,
7477
+ "type": "int",
7478
+ "value_allowed_null": false
7479
+ },
7480
+ {
7481
+ "disabled": false,
7482
+ "document": "任务ID",
7483
+ "example": "无",
7484
+ "member": "string",
7485
+ "name": "TaskId",
7486
+ "output_required": true,
7487
+ "required": false,
7488
+ "type": "string",
7489
+ "value_allowed_null": false
7490
+ },
7491
+ {
7492
+ "disabled": false,
7493
+ "document": "创建时间\n注意:此字段可能返回 null,表示取不到有效值。",
7494
+ "example": "无",
7495
+ "member": "string",
7496
+ "name": "CreateTime",
7497
+ "output_required": false,
7498
+ "required": false,
7499
+ "type": "string",
7500
+ "value_allowed_null": true
7501
+ },
7502
+ {
7503
+ "disabled": false,
7504
+ "document": "更新时间\n注意:此字段可能返回 null,表示取不到有效值。",
7505
+ "example": "无",
7506
+ "member": "string",
7507
+ "name": "UpdateTime",
7508
+ "output_required": false,
7509
+ "required": false,
7510
+ "type": "string",
7511
+ "value_allowed_null": true
7512
+ },
7513
+ {
7514
+ "disabled": false,
7515
+ "document": "文件大小\n注意:此字段可能返回 null,表示取不到有效值。",
7516
+ "example": "无",
7517
+ "member": "int64",
7518
+ "name": "FileSize",
7519
+ "output_required": false,
7520
+ "required": false,
7521
+ "type": "int",
7522
+ "value_allowed_null": true
7523
+ },
7524
+ {
7525
+ "disabled": false,
7526
+ "document": "任务状态,0:初始化,1:运行中,2:成功,3:失败\n注意:此字段可能返回 null,表示取不到有效值。",
7527
+ "example": "0",
7528
+ "member": "int64",
7529
+ "name": "Status",
7530
+ "output_required": false,
7531
+ "required": false,
7532
+ "type": "int",
7533
+ "value_allowed_null": true
7534
+ },
7535
+ {
7536
+ "disabled": false,
7537
+ "document": "百分比\n注意:此字段可能返回 null,表示取不到有效值。",
7538
+ "example": "100",
7539
+ "member": "int64",
7540
+ "name": "Percent",
7541
+ "output_required": false,
7542
+ "required": false,
7543
+ "type": "int",
7544
+ "value_allowed_null": true
7545
+ },
7546
+ {
7547
+ "disabled": false,
7548
+ "document": "下载链接\n注意:此字段可能返回 null,表示取不到有效值。",
7549
+ "example": "无",
7550
+ "member": "string",
7551
+ "name": "Url",
7552
+ "output_required": false,
7553
+ "required": false,
7554
+ "type": "string",
7555
+ "value_allowed_null": true
7556
+ }
7557
+ ],
7558
+ "usage": "both"
7559
+ },
6952
7560
  "TerminateDBInstancesRequest": {
6953
7561
  "document": "TerminateDBInstances请求参数结构体",
6954
7562
  "members": [
6955
7563
  {
6956
7564
  "disabled": false,
6957
- "document": "指定预隔离实例ID。格式如:cmgo-p8vnipr5。",
7565
+ "document": "指定预隔离实例 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制预隔离实例 ID。",
6958
7566
  "example": "cmgo-7pje****",
6959
7567
  "member": "string",
6960
7568
  "name": "InstanceId",
@@ -6976,6 +7584,107 @@
6976
7584
  ],
6977
7585
  "type": "object"
6978
7586
  },
7587
+ "UpgradeDBInstanceKernelVersionRequest": {
7588
+ "document": "UpgradeDBInstanceKernelVersion请求参数结构体",
7589
+ "members": [
7590
+ {
7591
+ "disabled": false,
7592
+ "document": "实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同",
7593
+ "example": "cmgo-p8vnipr5",
7594
+ "member": "string",
7595
+ "name": "InstanceId",
7596
+ "required": true,
7597
+ "type": "string"
7598
+ },
7599
+ {
7600
+ "disabled": false,
7601
+ "document": "是否维护时间内升级。0-否,1-是",
7602
+ "example": "无",
7603
+ "member": "int64",
7604
+ "name": "InMaintenance",
7605
+ "required": false,
7606
+ "type": "int"
7607
+ }
7608
+ ],
7609
+ "type": "object"
7610
+ },
7611
+ "UpgradeDBInstanceKernelVersionResponse": {
7612
+ "document": "UpgradeDBInstanceKernelVersion返回参数结构体",
7613
+ "members": [
7614
+ {
7615
+ "disabled": false,
7616
+ "document": "异步流程任务ID",
7617
+ "example": "1367",
7618
+ "member": "uint64",
7619
+ "name": "FlowId",
7620
+ "output_required": true,
7621
+ "type": "int",
7622
+ "value_allowed_null": false
7623
+ },
7624
+ {
7625
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
7626
+ "member": "string",
7627
+ "name": "RequestId",
7628
+ "type": "string"
7629
+ }
7630
+ ],
7631
+ "type": "object"
7632
+ },
7633
+ "UpgradeDbInstanceVersionRequest": {
7634
+ "document": "UpgradeDbInstanceVersion请求参数结构体",
7635
+ "members": [
7636
+ {
7637
+ "disabled": false,
7638
+ "document": "实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。",
7639
+ "example": "cmgo-p8vnipr5",
7640
+ "member": "string",
7641
+ "name": "InstanceId",
7642
+ "required": true,
7643
+ "type": "string"
7644
+ },
7645
+ {
7646
+ "disabled": false,
7647
+ "document": "新升级的数据库版本,当前仅支持MONGO_40_WT(MongoDB 4.0 WiredTiger存储引擎版本)及MONGO_42_WT(MongoDB 4.0 WiredTiger存储引擎版本)。",
7648
+ "example": "MONGO_42_WT",
7649
+ "member": "string",
7650
+ "name": "MongoVersion",
7651
+ "required": true,
7652
+ "type": "string"
7653
+ },
7654
+ {
7655
+ "disabled": false,
7656
+ "document": "是否在维护时间内升级。0-立即升级 1-维护时间内升级",
7657
+ "example": "无",
7658
+ "member": "int64",
7659
+ "name": "InMaintenance",
7660
+ "required": false,
7661
+ "type": "int"
7662
+ }
7663
+ ],
7664
+ "type": "object"
7665
+ },
7666
+ "UpgradeDbInstanceVersionResponse": {
7667
+ "document": "UpgradeDbInstanceVersion返回参数结构体",
7668
+ "members": [
7669
+ {
7670
+ "disabled": false,
7671
+ "document": "异步流程任务ID",
7672
+ "example": "1367",
7673
+ "member": "uint64",
7674
+ "name": "FlowId",
7675
+ "output_required": true,
7676
+ "type": "int",
7677
+ "value_allowed_null": false
7678
+ },
7679
+ {
7680
+ "document": "唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。",
7681
+ "member": "string",
7682
+ "name": "RequestId",
7683
+ "type": "string"
7684
+ }
7685
+ ],
7686
+ "type": "object"
7687
+ },
6979
7688
  "UserInfo": {
6980
7689
  "document": "账户基本信息",
6981
7690
  "members": [