kb-cloud-client-typescript 2.4.0-alpha.41 → 2.4.0-alpha.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (283) hide show
  1. package/dist/adminapi/apis/diagnostics-api.d.ts +564 -0
  2. package/dist/adminapi/apis/diagnostics-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/diagnostics-api.js +566 -0
  4. package/dist/adminapi/apis/diagnostics-api.js.map +1 -1
  5. package/dist/adminapi/models/dms-execution-plan-planning-mode.d.ts +22 -0
  6. package/dist/adminapi/models/dms-execution-plan-planning-mode.d.ts.map +1 -0
  7. package/dist/adminapi/models/dms-execution-plan-planning-mode.js +26 -0
  8. package/dist/adminapi/models/dms-execution-plan-planning-mode.js.map +1 -0
  9. package/dist/adminapi/models/dms-execution-plan-result.d.ts +19 -0
  10. package/dist/adminapi/models/dms-execution-plan-result.d.ts.map +1 -1
  11. package/dist/adminapi/models/elasticsearch-allocation-decider.d.ts +37 -0
  12. package/dist/adminapi/models/elasticsearch-allocation-decider.d.ts.map +1 -0
  13. package/dist/adminapi/models/elasticsearch-allocation-decider.js +16 -0
  14. package/dist/adminapi/models/elasticsearch-allocation-decider.js.map +1 -0
  15. package/dist/adminapi/models/elasticsearch-allocation-explanation.d.ts +113 -0
  16. package/dist/adminapi/models/elasticsearch-allocation-explanation.d.ts.map +1 -0
  17. package/dist/adminapi/models/elasticsearch-allocation-explanation.js +16 -0
  18. package/dist/adminapi/models/elasticsearch-allocation-explanation.js.map +1 -0
  19. package/dist/adminapi/models/elasticsearch-disk-watermarks.d.ts +37 -0
  20. package/dist/adminapi/models/elasticsearch-disk-watermarks.d.ts.map +1 -0
  21. package/dist/adminapi/models/elasticsearch-disk-watermarks.js +16 -0
  22. package/dist/adminapi/models/elasticsearch-disk-watermarks.js.map +1 -0
  23. package/dist/adminapi/models/elasticsearch-hot-threads-type.d.ts +23 -0
  24. package/dist/adminapi/models/elasticsearch-hot-threads-type.d.ts.map +1 -0
  25. package/dist/adminapi/models/elasticsearch-hot-threads-type.js +27 -0
  26. package/dist/adminapi/models/elasticsearch-hot-threads-type.js.map +1 -0
  27. package/dist/adminapi/models/elasticsearch-hot-threads.d.ts +43 -0
  28. package/dist/adminapi/models/elasticsearch-hot-threads.d.ts.map +1 -0
  29. package/dist/adminapi/models/elasticsearch-hot-threads.js +16 -0
  30. package/dist/adminapi/models/elasticsearch-hot-threads.js.map +1 -0
  31. package/dist/adminapi/models/elasticsearch-index-sort-by.d.ts +24 -0
  32. package/dist/adminapi/models/elasticsearch-index-sort-by.d.ts.map +1 -0
  33. package/dist/adminapi/models/elasticsearch-index-sort-by.js +28 -0
  34. package/dist/adminapi/models/elasticsearch-index-sort-by.js.map +1 -0
  35. package/dist/adminapi/models/elasticsearch-index-storage.d.ts +85 -0
  36. package/dist/adminapi/models/elasticsearch-index-storage.d.ts.map +1 -0
  37. package/dist/adminapi/models/elasticsearch-index-storage.js +16 -0
  38. package/dist/adminapi/models/elasticsearch-index-storage.js.map +1 -0
  39. package/dist/adminapi/models/elasticsearch-node-allocation-decision.d.ts +44 -0
  40. package/dist/adminapi/models/elasticsearch-node-allocation-decision.d.ts.map +1 -0
  41. package/dist/adminapi/models/elasticsearch-node-allocation-decision.js +16 -0
  42. package/dist/adminapi/models/elasticsearch-node-allocation-decision.js.map +1 -0
  43. package/dist/adminapi/models/elasticsearch-node-allocation.d.ts +73 -0
  44. package/dist/adminapi/models/elasticsearch-node-allocation.d.ts.map +1 -0
  45. package/dist/adminapi/models/elasticsearch-node-allocation.js +16 -0
  46. package/dist/adminapi/models/elasticsearch-node-allocation.js.map +1 -0
  47. package/dist/adminapi/models/elasticsearch-recovery-list.d.ts +32 -0
  48. package/dist/adminapi/models/elasticsearch-recovery-list.d.ts.map +1 -0
  49. package/dist/adminapi/models/elasticsearch-recovery-list.js +16 -0
  50. package/dist/adminapi/models/elasticsearch-recovery-list.js.map +1 -0
  51. package/dist/adminapi/models/elasticsearch-recovery-size.d.ts +43 -0
  52. package/dist/adminapi/models/elasticsearch-recovery-size.d.ts.map +1 -0
  53. package/dist/adminapi/models/elasticsearch-recovery-size.js +16 -0
  54. package/dist/adminapi/models/elasticsearch-recovery-size.js.map +1 -0
  55. package/dist/adminapi/models/elasticsearch-recovery-translog.d.ts +37 -0
  56. package/dist/adminapi/models/elasticsearch-recovery-translog.d.ts.map +1 -0
  57. package/dist/adminapi/models/elasticsearch-recovery-translog.js +16 -0
  58. package/dist/adminapi/models/elasticsearch-recovery-translog.js.map +1 -0
  59. package/dist/adminapi/models/elasticsearch-shard-list.d.ts +32 -0
  60. package/dist/adminapi/models/elasticsearch-shard-list.d.ts.map +1 -0
  61. package/dist/adminapi/models/elasticsearch-shard-list.js +16 -0
  62. package/dist/adminapi/models/elasticsearch-shard-list.js.map +1 -0
  63. package/dist/adminapi/models/elasticsearch-shard-node.d.ts +31 -0
  64. package/dist/adminapi/models/elasticsearch-shard-node.d.ts.map +1 -0
  65. package/dist/adminapi/models/elasticsearch-shard-node.js +16 -0
  66. package/dist/adminapi/models/elasticsearch-shard-node.js.map +1 -0
  67. package/dist/adminapi/models/elasticsearch-shard-recovery.d.ts +88 -0
  68. package/dist/adminapi/models/elasticsearch-shard-recovery.d.ts.map +1 -0
  69. package/dist/adminapi/models/elasticsearch-shard-recovery.js +16 -0
  70. package/dist/adminapi/models/elasticsearch-shard-recovery.js.map +1 -0
  71. package/dist/adminapi/models/elasticsearch-shard-state.d.ts +24 -0
  72. package/dist/adminapi/models/elasticsearch-shard-state.d.ts.map +1 -0
  73. package/dist/adminapi/models/elasticsearch-shard-state.js +28 -0
  74. package/dist/adminapi/models/elasticsearch-shard-state.js.map +1 -0
  75. package/dist/adminapi/models/elasticsearch-shard.d.ts +73 -0
  76. package/dist/adminapi/models/elasticsearch-shard.d.ts.map +1 -0
  77. package/dist/adminapi/models/elasticsearch-shard.js +16 -0
  78. package/dist/adminapi/models/elasticsearch-shard.js.map +1 -0
  79. package/dist/adminapi/models/elasticsearch-sort-order.d.ts +22 -0
  80. package/dist/adminapi/models/elasticsearch-sort-order.d.ts.map +1 -0
  81. package/dist/adminapi/models/elasticsearch-sort-order.js +26 -0
  82. package/dist/adminapi/models/elasticsearch-sort-order.js.map +1 -0
  83. package/dist/adminapi/models/elasticsearch-storage-analysis.d.ts +59 -0
  84. package/dist/adminapi/models/elasticsearch-storage-analysis.d.ts.map +1 -0
  85. package/dist/adminapi/models/elasticsearch-storage-analysis.js +16 -0
  86. package/dist/adminapi/models/elasticsearch-storage-analysis.js.map +1 -0
  87. package/dist/adminapi/models/elasticsearch-task-analysis.d.ts +52 -0
  88. package/dist/adminapi/models/elasticsearch-task-analysis.d.ts.map +1 -0
  89. package/dist/adminapi/models/elasticsearch-task-analysis.js +16 -0
  90. package/dist/adminapi/models/elasticsearch-task-analysis.js.map +1 -0
  91. package/dist/adminapi/models/elasticsearch-task.d.ts +79 -0
  92. package/dist/adminapi/models/elasticsearch-task.d.ts.map +1 -0
  93. package/dist/adminapi/models/elasticsearch-task.js +16 -0
  94. package/dist/adminapi/models/elasticsearch-task.js.map +1 -0
  95. package/dist/adminapi/models/elasticsearch-unassigned-info.d.ts +43 -0
  96. package/dist/adminapi/models/elasticsearch-unassigned-info.d.ts.map +1 -0
  97. package/dist/adminapi/models/elasticsearch-unassigned-info.js +16 -0
  98. package/dist/adminapi/models/elasticsearch-unassigned-info.js.map +1 -0
  99. package/dist/adminapi/models/environment-update.d.ts +6 -0
  100. package/dist/adminapi/models/environment-update.d.ts.map +1 -1
  101. package/dist/adminapi/models/index.d.ts +24 -0
  102. package/dist/adminapi/models/index.d.ts.map +1 -1
  103. package/dist/adminapi/models/index.js +24 -0
  104. package/dist/adminapi/models/index.js.map +1 -1
  105. package/dist/adminapi/models/postgresql-sqlfingerprint-explain-response.d.ts +87 -0
  106. package/dist/adminapi/models/postgresql-sqlfingerprint-explain-response.d.ts.map +1 -0
  107. package/dist/adminapi/models/postgresql-sqlfingerprint-explain-response.js +16 -0
  108. package/dist/adminapi/models/postgresql-sqlfingerprint-explain-response.js.map +1 -0
  109. package/dist/adminapi/models/postgresql-sqlfingerprint.d.ts +6 -0
  110. package/dist/adminapi/models/postgresql-sqlfingerprint.d.ts.map +1 -1
  111. package/dist/adminapi/models/scheduling-config.d.ts +6 -0
  112. package/dist/adminapi/models/scheduling-config.d.ts.map +1 -1
  113. package/dist/openapi/apis/diagnostics-api.d.ts +564 -0
  114. package/dist/openapi/apis/diagnostics-api.d.ts.map +1 -1
  115. package/dist/openapi/apis/diagnostics-api.js +566 -0
  116. package/dist/openapi/apis/diagnostics-api.js.map +1 -1
  117. package/dist/openapi/models/dms-execution-plan-planning-mode.d.ts +22 -0
  118. package/dist/openapi/models/dms-execution-plan-planning-mode.d.ts.map +1 -0
  119. package/dist/openapi/models/dms-execution-plan-planning-mode.js +26 -0
  120. package/dist/openapi/models/dms-execution-plan-planning-mode.js.map +1 -0
  121. package/dist/openapi/models/dms-execution-plan-result.d.ts +19 -0
  122. package/dist/openapi/models/dms-execution-plan-result.d.ts.map +1 -1
  123. package/dist/openapi/models/elasticsearch-allocation-decider.d.ts +37 -0
  124. package/dist/openapi/models/elasticsearch-allocation-decider.d.ts.map +1 -0
  125. package/dist/openapi/models/elasticsearch-allocation-decider.js +16 -0
  126. package/dist/openapi/models/elasticsearch-allocation-decider.js.map +1 -0
  127. package/dist/openapi/models/elasticsearch-allocation-explanation.d.ts +113 -0
  128. package/dist/openapi/models/elasticsearch-allocation-explanation.d.ts.map +1 -0
  129. package/dist/openapi/models/elasticsearch-allocation-explanation.js +16 -0
  130. package/dist/openapi/models/elasticsearch-allocation-explanation.js.map +1 -0
  131. package/dist/openapi/models/elasticsearch-disk-watermarks.d.ts +37 -0
  132. package/dist/openapi/models/elasticsearch-disk-watermarks.d.ts.map +1 -0
  133. package/dist/openapi/models/elasticsearch-disk-watermarks.js +16 -0
  134. package/dist/openapi/models/elasticsearch-disk-watermarks.js.map +1 -0
  135. package/dist/openapi/models/elasticsearch-hot-threads-type.d.ts +23 -0
  136. package/dist/openapi/models/elasticsearch-hot-threads-type.d.ts.map +1 -0
  137. package/dist/openapi/models/elasticsearch-hot-threads-type.js +27 -0
  138. package/dist/openapi/models/elasticsearch-hot-threads-type.js.map +1 -0
  139. package/dist/openapi/models/elasticsearch-hot-threads.d.ts +43 -0
  140. package/dist/openapi/models/elasticsearch-hot-threads.d.ts.map +1 -0
  141. package/dist/openapi/models/elasticsearch-hot-threads.js +16 -0
  142. package/dist/openapi/models/elasticsearch-hot-threads.js.map +1 -0
  143. package/dist/openapi/models/elasticsearch-index-sort-by.d.ts +24 -0
  144. package/dist/openapi/models/elasticsearch-index-sort-by.d.ts.map +1 -0
  145. package/dist/openapi/models/elasticsearch-index-sort-by.js +28 -0
  146. package/dist/openapi/models/elasticsearch-index-sort-by.js.map +1 -0
  147. package/dist/openapi/models/elasticsearch-index-storage.d.ts +85 -0
  148. package/dist/openapi/models/elasticsearch-index-storage.d.ts.map +1 -0
  149. package/dist/openapi/models/elasticsearch-index-storage.js +16 -0
  150. package/dist/openapi/models/elasticsearch-index-storage.js.map +1 -0
  151. package/dist/openapi/models/elasticsearch-node-allocation-decision.d.ts +44 -0
  152. package/dist/openapi/models/elasticsearch-node-allocation-decision.d.ts.map +1 -0
  153. package/dist/openapi/models/elasticsearch-node-allocation-decision.js +16 -0
  154. package/dist/openapi/models/elasticsearch-node-allocation-decision.js.map +1 -0
  155. package/dist/openapi/models/elasticsearch-node-allocation.d.ts +73 -0
  156. package/dist/openapi/models/elasticsearch-node-allocation.d.ts.map +1 -0
  157. package/dist/openapi/models/elasticsearch-node-allocation.js +16 -0
  158. package/dist/openapi/models/elasticsearch-node-allocation.js.map +1 -0
  159. package/dist/openapi/models/elasticsearch-recovery-list.d.ts +32 -0
  160. package/dist/openapi/models/elasticsearch-recovery-list.d.ts.map +1 -0
  161. package/dist/openapi/models/elasticsearch-recovery-list.js +16 -0
  162. package/dist/openapi/models/elasticsearch-recovery-list.js.map +1 -0
  163. package/dist/openapi/models/elasticsearch-recovery-size.d.ts +43 -0
  164. package/dist/openapi/models/elasticsearch-recovery-size.d.ts.map +1 -0
  165. package/dist/openapi/models/elasticsearch-recovery-size.js +16 -0
  166. package/dist/openapi/models/elasticsearch-recovery-size.js.map +1 -0
  167. package/dist/openapi/models/elasticsearch-recovery-translog.d.ts +37 -0
  168. package/dist/openapi/models/elasticsearch-recovery-translog.d.ts.map +1 -0
  169. package/dist/openapi/models/elasticsearch-recovery-translog.js +16 -0
  170. package/dist/openapi/models/elasticsearch-recovery-translog.js.map +1 -0
  171. package/dist/openapi/models/elasticsearch-shard-list.d.ts +32 -0
  172. package/dist/openapi/models/elasticsearch-shard-list.d.ts.map +1 -0
  173. package/dist/openapi/models/elasticsearch-shard-list.js +16 -0
  174. package/dist/openapi/models/elasticsearch-shard-list.js.map +1 -0
  175. package/dist/openapi/models/elasticsearch-shard-node.d.ts +31 -0
  176. package/dist/openapi/models/elasticsearch-shard-node.d.ts.map +1 -0
  177. package/dist/openapi/models/elasticsearch-shard-node.js +16 -0
  178. package/dist/openapi/models/elasticsearch-shard-node.js.map +1 -0
  179. package/dist/openapi/models/elasticsearch-shard-recovery.d.ts +88 -0
  180. package/dist/openapi/models/elasticsearch-shard-recovery.d.ts.map +1 -0
  181. package/dist/openapi/models/elasticsearch-shard-recovery.js +16 -0
  182. package/dist/openapi/models/elasticsearch-shard-recovery.js.map +1 -0
  183. package/dist/openapi/models/elasticsearch-shard-state.d.ts +24 -0
  184. package/dist/openapi/models/elasticsearch-shard-state.d.ts.map +1 -0
  185. package/dist/openapi/models/elasticsearch-shard-state.js +28 -0
  186. package/dist/openapi/models/elasticsearch-shard-state.js.map +1 -0
  187. package/dist/openapi/models/elasticsearch-shard.d.ts +73 -0
  188. package/dist/openapi/models/elasticsearch-shard.d.ts.map +1 -0
  189. package/dist/openapi/models/elasticsearch-shard.js +16 -0
  190. package/dist/openapi/models/elasticsearch-shard.js.map +1 -0
  191. package/dist/openapi/models/elasticsearch-sort-order.d.ts +22 -0
  192. package/dist/openapi/models/elasticsearch-sort-order.d.ts.map +1 -0
  193. package/dist/openapi/models/elasticsearch-sort-order.js +26 -0
  194. package/dist/openapi/models/elasticsearch-sort-order.js.map +1 -0
  195. package/dist/openapi/models/elasticsearch-storage-analysis.d.ts +59 -0
  196. package/dist/openapi/models/elasticsearch-storage-analysis.d.ts.map +1 -0
  197. package/dist/openapi/models/elasticsearch-storage-analysis.js +16 -0
  198. package/dist/openapi/models/elasticsearch-storage-analysis.js.map +1 -0
  199. package/dist/openapi/models/elasticsearch-task-analysis.d.ts +52 -0
  200. package/dist/openapi/models/elasticsearch-task-analysis.d.ts.map +1 -0
  201. package/dist/openapi/models/elasticsearch-task-analysis.js +16 -0
  202. package/dist/openapi/models/elasticsearch-task-analysis.js.map +1 -0
  203. package/dist/openapi/models/elasticsearch-task.d.ts +79 -0
  204. package/dist/openapi/models/elasticsearch-task.d.ts.map +1 -0
  205. package/dist/openapi/models/elasticsearch-task.js +16 -0
  206. package/dist/openapi/models/elasticsearch-task.js.map +1 -0
  207. package/dist/openapi/models/elasticsearch-unassigned-info.d.ts +43 -0
  208. package/dist/openapi/models/elasticsearch-unassigned-info.d.ts.map +1 -0
  209. package/dist/openapi/models/elasticsearch-unassigned-info.js +16 -0
  210. package/dist/openapi/models/elasticsearch-unassigned-info.js.map +1 -0
  211. package/dist/openapi/models/index.d.ts +24 -0
  212. package/dist/openapi/models/index.d.ts.map +1 -1
  213. package/dist/openapi/models/index.js +24 -0
  214. package/dist/openapi/models/index.js.map +1 -1
  215. package/dist/openapi/models/postgresql-sqlfingerprint-explain-response.d.ts +87 -0
  216. package/dist/openapi/models/postgresql-sqlfingerprint-explain-response.d.ts.map +1 -0
  217. package/dist/openapi/models/postgresql-sqlfingerprint-explain-response.js +16 -0
  218. package/dist/openapi/models/postgresql-sqlfingerprint-explain-response.js.map +1 -0
  219. package/dist/openapi/models/postgresql-sqlfingerprint.d.ts +6 -0
  220. package/dist/openapi/models/postgresql-sqlfingerprint.d.ts.map +1 -1
  221. package/package.json +1 -1
  222. package/src/adminapi/.openapi-generator/FILES +24 -0
  223. package/src/adminapi/apis/diagnostics-api.ts +1029 -40
  224. package/src/adminapi/models/dms-execution-plan-planning-mode.ts +31 -0
  225. package/src/adminapi/models/dms-execution-plan-result.ts +21 -0
  226. package/src/adminapi/models/elasticsearch-allocation-decider.ts +42 -0
  227. package/src/adminapi/models/elasticsearch-allocation-explanation.ts +126 -0
  228. package/src/adminapi/models/elasticsearch-disk-watermarks.ts +42 -0
  229. package/src/adminapi/models/elasticsearch-hot-threads-type.ts +32 -0
  230. package/src/adminapi/models/elasticsearch-hot-threads.ts +48 -0
  231. package/src/adminapi/models/elasticsearch-index-sort-by.ts +33 -0
  232. package/src/adminapi/models/elasticsearch-index-storage.ts +90 -0
  233. package/src/adminapi/models/elasticsearch-node-allocation-decision.ts +51 -0
  234. package/src/adminapi/models/elasticsearch-node-allocation.ts +78 -0
  235. package/src/adminapi/models/elasticsearch-recovery-list.ts +39 -0
  236. package/src/adminapi/models/elasticsearch-recovery-size.ts +48 -0
  237. package/src/adminapi/models/elasticsearch-recovery-translog.ts +42 -0
  238. package/src/adminapi/models/elasticsearch-shard-list.ts +39 -0
  239. package/src/adminapi/models/elasticsearch-shard-node.ts +36 -0
  240. package/src/adminapi/models/elasticsearch-shard-recovery.ts +99 -0
  241. package/src/adminapi/models/elasticsearch-shard-state.ts +33 -0
  242. package/src/adminapi/models/elasticsearch-shard.ts +78 -0
  243. package/src/adminapi/models/elasticsearch-sort-order.ts +31 -0
  244. package/src/adminapi/models/elasticsearch-storage-analysis.ts +72 -0
  245. package/src/adminapi/models/elasticsearch-task-analysis.ts +63 -0
  246. package/src/adminapi/models/elasticsearch-task.ts +84 -0
  247. package/src/adminapi/models/elasticsearch-unassigned-info.ts +48 -0
  248. package/src/adminapi/models/environment-update.ts +6 -0
  249. package/src/adminapi/models/index.ts +24 -0
  250. package/src/adminapi/models/postgresql-sqlfingerprint-explain-response.ts +98 -0
  251. package/src/adminapi/models/postgresql-sqlfingerprint.ts +6 -0
  252. package/src/adminapi/models/scheduling-config.ts +6 -0
  253. package/src/adminapi.yaml +1056 -117
  254. package/src/openapi/.openapi-generator/FILES +24 -0
  255. package/src/openapi/apis/diagnostics-api.ts +1029 -40
  256. package/src/openapi/models/dms-execution-plan-planning-mode.ts +31 -0
  257. package/src/openapi/models/dms-execution-plan-result.ts +21 -0
  258. package/src/openapi/models/elasticsearch-allocation-decider.ts +42 -0
  259. package/src/openapi/models/elasticsearch-allocation-explanation.ts +126 -0
  260. package/src/openapi/models/elasticsearch-disk-watermarks.ts +42 -0
  261. package/src/openapi/models/elasticsearch-hot-threads-type.ts +32 -0
  262. package/src/openapi/models/elasticsearch-hot-threads.ts +48 -0
  263. package/src/openapi/models/elasticsearch-index-sort-by.ts +33 -0
  264. package/src/openapi/models/elasticsearch-index-storage.ts +90 -0
  265. package/src/openapi/models/elasticsearch-node-allocation-decision.ts +51 -0
  266. package/src/openapi/models/elasticsearch-node-allocation.ts +78 -0
  267. package/src/openapi/models/elasticsearch-recovery-list.ts +39 -0
  268. package/src/openapi/models/elasticsearch-recovery-size.ts +48 -0
  269. package/src/openapi/models/elasticsearch-recovery-translog.ts +42 -0
  270. package/src/openapi/models/elasticsearch-shard-list.ts +39 -0
  271. package/src/openapi/models/elasticsearch-shard-node.ts +36 -0
  272. package/src/openapi/models/elasticsearch-shard-recovery.ts +99 -0
  273. package/src/openapi/models/elasticsearch-shard-state.ts +33 -0
  274. package/src/openapi/models/elasticsearch-shard.ts +78 -0
  275. package/src/openapi/models/elasticsearch-sort-order.ts +31 -0
  276. package/src/openapi/models/elasticsearch-storage-analysis.ts +72 -0
  277. package/src/openapi/models/elasticsearch-task-analysis.ts +63 -0
  278. package/src/openapi/models/elasticsearch-task.ts +84 -0
  279. package/src/openapi/models/elasticsearch-unassigned-info.ts +48 -0
  280. package/src/openapi/models/index.ts +24 -0
  281. package/src/openapi/models/postgresql-sqlfingerprint-explain-response.ts +98 -0
  282. package/src/openapi/models/postgresql-sqlfingerprint.ts +6 -0
  283. package/src/openapi.yaml +1829 -903
package/src/openapi.yaml CHANGED
@@ -5276,6 +5276,83 @@ paths:
5276
5276
  $ref: '#/components/responses/404'
5277
5277
  '500':
5278
5278
  $ref: '#/components/responses/500'
5279
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sqlAnalysis/queries/{queryID}/explain:
5280
+ post:
5281
+ tags:
5282
+ - diagnostics
5283
+ summary: Explain PostgreSQL SQL fingerprint
5284
+ description: Explicitly trigger a safe PostgreSQL EXPLAIN for one SQL fingerprint. The request does not accept raw SQL. DMS resolves the exact server-side parameterized SELECT statement identity independently of the ranking window, produces an estimated standard or generic plan without parameter sample values, rejects multiple statements, and never runs EXPLAIN ANALYZE or the original SQL. The plan uses current catalog statistics and the DMS connection context; it does not reconstruct the original role, search_path, session settings, parameter values, or historical actual plan.
5285
+ operationId: explainDiagnosticsPostgresqlSQLFingerprint
5286
+ parameters:
5287
+ - name: orgName
5288
+ in: path
5289
+ description: Organization name
5290
+ required: true
5291
+ schema:
5292
+ type: string
5293
+ - name: clusterName
5294
+ in: path
5295
+ description: Cluster name
5296
+ required: true
5297
+ schema:
5298
+ type: string
5299
+ - name: queryID
5300
+ in: path
5301
+ description: PostgreSQL pg_stat_statements queryid represented as a string.
5302
+ required: true
5303
+ schema:
5304
+ type: string
5305
+ - name: database
5306
+ in: query
5307
+ description: Database name from the ranking row. The key is required to disambiguate the queryID. An unresolved empty name returns 422 no_explainable_sql_statement.
5308
+ required: true
5309
+ allowEmptyValue: true
5310
+ schema:
5311
+ type: string
5312
+ - name: user
5313
+ in: query
5314
+ description: Database user from the ranking row. The key is required to disambiguate the queryID. An unresolved empty name returns 422 no_explainable_sql_statement.
5315
+ required: true
5316
+ allowEmptyValue: true
5317
+ schema:
5318
+ type: string
5319
+ - name: topLevel
5320
+ in: query
5321
+ description: Top-level identity from the ranking row. Required to disambiguate the queryID on PostgreSQL versions that expose pg_stat_statements.toplevel.
5322
+ required: true
5323
+ schema:
5324
+ type: boolean
5325
+ - name: fingerprint
5326
+ in: query
5327
+ description: Optional fingerprint consistency guard. Currently aligned with PostgreSQL pg_stat_statements queryid.
5328
+ required: false
5329
+ schema:
5330
+ type: string
5331
+ responses:
5332
+ '200':
5333
+ description: OK
5334
+ content:
5335
+ application/json:
5336
+ schema:
5337
+ $ref: '#/components/schemas/postgresqlSQLFingerprintExplainResponse'
5338
+ '400':
5339
+ $ref: '#/components/responses/400'
5340
+ '401':
5341
+ $ref: '#/components/responses/401'
5342
+ '403':
5343
+ $ref: '#/components/responses/403'
5344
+ '404':
5345
+ $ref: '#/components/responses/404'
5346
+ '422':
5347
+ description: Unprocessable Entity
5348
+ content:
5349
+ application/json:
5350
+ schema:
5351
+ $ref: '#/components/schemas/APIErrorResponse'
5352
+ '500':
5353
+ $ref: '#/components/responses/500'
5354
+ '503':
5355
+ $ref: '#/components/responses/503'
5279
5356
  /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/sqlAnalysis:
5280
5357
  get:
5281
5358
  tags:
@@ -5420,150 +5497,157 @@ paths:
5420
5497
  $ref: '#/components/responses/403'
5421
5498
  '500':
5422
5499
  $ref: '#/components/responses/500'
5423
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
5500
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/elasticsearch/taskAnalysis:
5424
5501
  get:
5425
5502
  tags:
5426
5503
  - diagnostics
5427
- summary: Get PostgreSQL session lock analysis
5428
- description: Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
5429
- operationId: getDiagnosticsPostgresqlSessionLockAnalysis
5504
+ summary: Get Elasticsearch task and hot-thread analysis
5505
+ operationId: getDiagnosticsElasticsearchTaskAnalysis
5430
5506
  parameters:
5431
5507
  - name: orgName
5432
5508
  in: path
5433
- description: Organization name
5434
5509
  required: true
5435
5510
  schema:
5436
5511
  type: string
5437
5512
  - name: clusterName
5438
5513
  in: path
5439
- description: Cluster name
5440
5514
  required: true
5441
5515
  schema:
5442
5516
  type: string
5443
- - name: pid
5444
- in: path
5445
- description: PostgreSQL backend process id.
5446
- required: true
5517
+ - name: type
5518
+ in: query
5519
+ required: false
5520
+ schema:
5521
+ $ref: '#/components/schemas/elasticsearchHotThreadsType'
5522
+ - name: node
5523
+ in: query
5524
+ required: false
5525
+ schema:
5526
+ type: string
5527
+ - name: taskLimit
5528
+ in: query
5529
+ required: false
5447
5530
  schema:
5448
5531
  type: integer
5449
- format: int64
5450
5532
  minimum: 1
5533
+ maximum: 100
5534
+ default: 20
5535
+ - name: threads
5536
+ in: query
5537
+ required: false
5538
+ schema:
5539
+ type: integer
5540
+ minimum: 1
5541
+ maximum: 10
5542
+ default: 3
5451
5543
  responses:
5452
5544
  '200':
5453
5545
  description: OK
5454
5546
  content:
5455
5547
  application/json:
5456
5548
  schema:
5457
- $ref: '#/components/schemas/postgresqlLockAnalysis'
5549
+ $ref: '#/components/schemas/elasticsearchTaskAnalysis'
5550
+ '400':
5551
+ $ref: '#/components/responses/400'
5458
5552
  '401':
5459
5553
  $ref: '#/components/responses/401'
5460
5554
  '403':
5461
5555
  $ref: '#/components/responses/403'
5462
- '404':
5463
- $ref: '#/components/responses/404'
5464
5556
  '500':
5465
5557
  $ref: '#/components/responses/500'
5466
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}:
5558
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/elasticsearch/storageAnalysis:
5467
5559
  get:
5468
5560
  tags:
5469
5561
  - diagnostics
5470
- summary: Get PostgreSQL session basic diagnostics
5471
- description: Get one PostgreSQL session basic diagnostics record by backend pid.
5472
- operationId: getDiagnosticsPostgresqlSession
5562
+ summary: Get Elasticsearch storage and index analysis
5563
+ operationId: getDiagnosticsElasticsearchStorageAnalysis
5473
5564
  parameters:
5474
5565
  - name: orgName
5475
5566
  in: path
5476
- description: Organization name
5477
5567
  required: true
5478
5568
  schema:
5479
5569
  type: string
5480
5570
  - name: clusterName
5481
5571
  in: path
5482
- description: Cluster name
5483
5572
  required: true
5484
5573
  schema:
5485
5574
  type: string
5486
- - name: pid
5487
- in: path
5488
- description: PostgreSQL backend process id.
5489
- required: true
5575
+ - name: node
5576
+ in: query
5577
+ required: false
5490
5578
  schema:
5491
- type: integer
5492
- format: int64
5493
- minimum: 1
5579
+ type: string
5580
+ - name: index
5581
+ in: query
5582
+ required: false
5583
+ schema:
5584
+ type: string
5585
+ - name: sortBy
5586
+ in: query
5587
+ required: false
5588
+ schema:
5589
+ $ref: '#/components/schemas/elasticsearchIndexSortBy'
5590
+ - name: sortOrder
5591
+ in: query
5592
+ required: false
5593
+ schema:
5594
+ $ref: '#/components/schemas/elasticsearchSortOrder'
5494
5595
  responses:
5495
5596
  '200':
5496
5597
  description: OK
5497
5598
  content:
5498
5599
  application/json:
5499
5600
  schema:
5500
- $ref: '#/components/schemas/postgresqlSession'
5601
+ $ref: '#/components/schemas/elasticsearchStorageAnalysis'
5602
+ '400':
5603
+ $ref: '#/components/responses/400'
5501
5604
  '401':
5502
5605
  $ref: '#/components/responses/401'
5503
5606
  '403':
5504
5607
  $ref: '#/components/responses/403'
5505
- '404':
5506
- $ref: '#/components/responses/404'
5507
5608
  '500':
5508
5609
  $ref: '#/components/responses/500'
5509
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/spaceAnalysis:
5610
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/elasticsearch/shards:
5510
5611
  get:
5511
5612
  tags:
5512
5613
  - diagnostics
5513
- summary: Get Dameng space analysis
5514
- description: Get a read-only Dameng space snapshot including tablespace usage, schema sizes, top tables, and top indexes. Queries dba_free_space, dba_data_files, DBA_SEGMENTS, DBA_TABLES, DBA_INDEXES, and DBA_IND_COLUMNS.
5515
- operationId: getDiagnosticsDamengSpaceAnalysis
5614
+ summary: List Elasticsearch shards
5615
+ operationId: listDiagnosticsElasticsearchShards
5516
5616
  parameters:
5517
5617
  - name: orgName
5518
5618
  in: path
5519
- description: Organization name
5520
5619
  required: true
5521
5620
  schema:
5522
5621
  type: string
5523
5622
  - name: clusterName
5524
5623
  in: path
5525
- description: Cluster name
5526
5624
  required: true
5527
5625
  schema:
5528
5626
  type: string
5529
- - name: tableLimit
5530
- in: query
5531
- description: Maximum number of top tables to return (0 or omitted = not collected)
5532
- required: false
5533
- schema:
5534
- type: integer
5535
- format: int64
5536
- minimum: 0
5537
- default: 0
5538
- - name: indexLimit
5627
+ - name: index
5539
5628
  in: query
5540
- description: Maximum number of top indexes to return (0 or omitted = not collected)
5541
5629
  required: false
5630
+ description: Index name or pattern
5542
5631
  schema:
5543
- type: integer
5544
- format: int64
5545
- minimum: 0
5546
- default: 0
5547
- - name: schema
5632
+ type: string
5633
+ - name: node
5548
5634
  in: query
5549
- description: Filter tables and indexes by schema (owner). Omit or empty = all schemas.
5550
5635
  required: false
5636
+ description: Exact node ID or name
5551
5637
  schema:
5552
5638
  type: string
5553
- - name: skipBasic
5639
+ - name: state
5554
5640
  in: query
5555
- description: Set to true to skip tablespace and schema queries, returning only tables and indexes.
5556
5641
  required: false
5557
5642
  schema:
5558
- type: boolean
5559
- default: false
5643
+ $ref: '#/components/schemas/elasticsearchShardState'
5560
5644
  responses:
5561
5645
  '200':
5562
5646
  description: OK
5563
5647
  content:
5564
5648
  application/json:
5565
5649
  schema:
5566
- $ref: '#/components/schemas/damengSpaceAnalysis'
5650
+ $ref: '#/components/schemas/elasticsearchShardList'
5567
5651
  '400':
5568
5652
  $ref: '#/components/responses/400'
5569
5653
  '401':
@@ -5574,40 +5658,42 @@ paths:
5574
5658
  $ref: '#/components/responses/404'
5575
5659
  '500':
5576
5660
  $ref: '#/components/responses/500'
5577
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sqlAnalysis:
5661
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/elasticsearch/recoveries:
5578
5662
  get:
5579
5663
  tags:
5580
5664
  - diagnostics
5581
- summary: Get Dameng SQL analysis
5582
- description: Get a read-only Dameng SQL analysis snapshot from V$SYSTEM_LONG_EXEC_SQLS (long-running SQL) and V$SYSTEM_LARGE_MEM_SQLS (high-memory SQL). The response does not expose execution plans or remediation actions.
5583
- operationId: getDiagnosticsDamengSQLAnalysis
5665
+ summary: List active Elasticsearch shard recoveries
5666
+ operationId: listDiagnosticsElasticsearchRecoveries
5584
5667
  parameters:
5585
5668
  - name: orgName
5586
5669
  in: path
5587
- description: Organization name
5588
5670
  required: true
5589
5671
  schema:
5590
5672
  type: string
5591
5673
  - name: clusterName
5592
5674
  in: path
5593
- description: Cluster name
5594
5675
  required: true
5595
5676
  schema:
5596
5677
  type: string
5597
- - name: limit
5678
+ - name: index
5598
5679
  in: query
5599
- description: Maximum number of SQL entries per category. Defaults to 20.
5600
5680
  required: false
5681
+ description: Index name or pattern
5601
5682
  schema:
5602
- type: integer
5603
- format: int64
5683
+ type: string
5684
+ - name: node
5685
+ in: query
5686
+ required: false
5687
+ description: Exact target node ID or name
5688
+ schema:
5689
+ type: string
5604
5690
  responses:
5605
5691
  '200':
5606
5692
  description: OK
5607
5693
  content:
5608
5694
  application/json:
5609
5695
  schema:
5610
- $ref: '#/components/schemas/damengSQLAnalysis'
5696
+ $ref: '#/components/schemas/elasticsearchRecoveryList'
5611
5697
  '400':
5612
5698
  $ref: '#/components/responses/400'
5613
5699
  '401':
@@ -5618,40 +5704,53 @@ paths:
5618
5704
  $ref: '#/components/responses/404'
5619
5705
  '500':
5620
5706
  $ref: '#/components/responses/500'
5621
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sessions/{sessionId}/lockAnalysis:
5707
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/elasticsearch/allocationExplain:
5622
5708
  get:
5623
5709
  tags:
5624
5710
  - diagnostics
5625
- summary: Get Dameng session lock analysis
5626
- description: Get lock and blocking analysis for a Dameng session. Queries V$LOCK and V$SESSIONS to identify blocking/blocked relationships and lock details.
5627
- operationId: getDiagnosticsDamengSessionLockAnalysis
5711
+ summary: Explain Elasticsearch shard allocation
5712
+ operationId: explainDiagnosticsElasticsearchAllocation
5628
5713
  parameters:
5629
5714
  - name: orgName
5630
5715
  in: path
5631
- description: Organization name
5632
5716
  required: true
5633
5717
  schema:
5634
5718
  type: string
5635
5719
  - name: clusterName
5636
5720
  in: path
5637
- description: Cluster name
5638
5721
  required: true
5639
5722
  schema:
5640
5723
  type: string
5641
- - name: sessionId
5642
- in: path
5643
- description: Dameng session ID (SESS_ID)
5724
+ - name: index
5725
+ in: query
5726
+ required: true
5727
+ schema:
5728
+ type: string
5729
+ minLength: 1
5730
+ - name: shard
5731
+ in: query
5644
5732
  required: true
5645
5733
  schema:
5646
5734
  type: integer
5647
5735
  format: int64
5736
+ minimum: 0
5737
+ - name: primary
5738
+ in: query
5739
+ required: true
5740
+ schema:
5741
+ type: boolean
5742
+ - name: currentNode
5743
+ in: query
5744
+ required: false
5745
+ schema:
5746
+ type: string
5648
5747
  responses:
5649
5748
  '200':
5650
5749
  description: OK
5651
5750
  content:
5652
5751
  application/json:
5653
5752
  schema:
5654
- $ref: '#/components/schemas/damengLockAnalysis'
5753
+ $ref: '#/components/schemas/elasticsearchAllocationExplanation'
5655
5754
  '400':
5656
5755
  $ref: '#/components/responses/400'
5657
5756
  '401':
@@ -5662,13 +5761,13 @@ paths:
5662
5761
  $ref: '#/components/responses/404'
5663
5762
  '500':
5664
5763
  $ref: '#/components/responses/500'
5665
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sessions/{sessionId}:
5764
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
5666
5765
  get:
5667
5766
  tags:
5668
5767
  - diagnostics
5669
- summary: Get Dameng session detail
5670
- description: Get a single Dameng session detail by session ID from V$SESSIONS, including SQL text, transaction info, and client details.
5671
- operationId: getDiagnosticsDamengSession
5768
+ summary: Get PostgreSQL session lock analysis
5769
+ description: Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
5770
+ operationId: getDiagnosticsPostgresqlSessionLockAnalysis
5672
5771
  parameters:
5673
5772
  - name: orgName
5674
5773
  in: path
@@ -5682,22 +5781,21 @@ paths:
5682
5781
  required: true
5683
5782
  schema:
5684
5783
  type: string
5685
- - name: sessionId
5784
+ - name: pid
5686
5785
  in: path
5687
- description: Dameng session ID (SESS_ID)
5786
+ description: PostgreSQL backend process id.
5688
5787
  required: true
5689
5788
  schema:
5690
5789
  type: integer
5691
5790
  format: int64
5791
+ minimum: 1
5692
5792
  responses:
5693
5793
  '200':
5694
5794
  description: OK
5695
5795
  content:
5696
5796
  application/json:
5697
5797
  schema:
5698
- $ref: '#/components/schemas/damengSessionDetail'
5699
- '400':
5700
- $ref: '#/components/responses/400'
5798
+ $ref: '#/components/schemas/postgresqlLockAnalysis'
5701
5799
  '401':
5702
5800
  $ref: '#/components/responses/401'
5703
5801
  '403':
@@ -5706,13 +5804,13 @@ paths:
5706
5804
  $ref: '#/components/responses/404'
5707
5805
  '500':
5708
5806
  $ref: '#/components/responses/500'
5709
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sessions:
5807
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}:
5710
5808
  get:
5711
5809
  tags:
5712
5810
  - diagnostics
5713
- summary: List Dameng sessions
5714
- description: List Dameng sessions from V$SESSIONS with lock status from V$LOCK. Returns session ID, user, state, client IP, transaction ID, lock status, SQL text, schema, duration, and more.
5715
- operationId: listDiagnosticsDamengSessions
5811
+ summary: Get PostgreSQL session basic diagnostics
5812
+ description: Get one PostgreSQL session basic diagnostics record by backend pid.
5813
+ operationId: getDiagnosticsPostgresqlSession
5716
5814
  parameters:
5717
5815
  - name: orgName
5718
5816
  in: path
@@ -5726,30 +5824,21 @@ paths:
5726
5824
  required: true
5727
5825
  schema:
5728
5826
  type: string
5729
- - name: limit
5730
- in: query
5731
- description: Maximum number of sessions to return. Defaults to 200.
5732
- required: false
5827
+ - name: pid
5828
+ in: path
5829
+ description: PostgreSQL backend process id.
5830
+ required: true
5733
5831
  schema:
5734
5832
  type: integer
5735
5833
  format: int64
5736
- - name: state
5737
- in: query
5738
- description: Filter sessions by state (e.g. ACTIVE, IDLE). Matches against V$SESSIONS.STATE.
5739
- required: false
5740
- schema:
5741
- type: string
5834
+ minimum: 1
5742
5835
  responses:
5743
5836
  '200':
5744
5837
  description: OK
5745
5838
  content:
5746
5839
  application/json:
5747
5840
  schema:
5748
- type: array
5749
- items:
5750
- $ref: '#/components/schemas/damengSessionListItem'
5751
- '400':
5752
- $ref: '#/components/responses/400'
5841
+ $ref: '#/components/schemas/postgresqlSession'
5753
5842
  '401':
5754
5843
  $ref: '#/components/responses/401'
5755
5844
  '403':
@@ -5758,35 +5847,287 @@ paths:
5758
5847
  $ref: '#/components/responses/404'
5759
5848
  '500':
5760
5849
  $ref: '#/components/responses/500'
5761
- /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/kingbase/sessions:
5850
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/spaceAnalysis:
5762
5851
  get:
5763
5852
  tags:
5764
5853
  - diagnostics
5765
- summary: List Kingbase session diagnostics
5766
- operationId: listDiagnosticsKingbaseSessions
5854
+ summary: Get Dameng space analysis
5855
+ description: Get a read-only Dameng space snapshot including tablespace usage, schema sizes, top tables, and top indexes. Queries dba_free_space, dba_data_files, DBA_SEGMENTS, DBA_TABLES, DBA_INDEXES, and DBA_IND_COLUMNS.
5856
+ operationId: getDiagnosticsDamengSpaceAnalysis
5767
5857
  parameters:
5768
5858
  - name: orgName
5769
5859
  in: path
5860
+ description: Organization name
5770
5861
  required: true
5771
5862
  schema:
5772
5863
  type: string
5773
5864
  - name: clusterName
5774
5865
  in: path
5866
+ description: Cluster name
5775
5867
  required: true
5776
5868
  schema:
5777
5869
  type: string
5778
- - name: limit
5870
+ - name: tableLimit
5779
5871
  in: query
5780
- description: Maximum number of sessions to return. Defaults to 200.
5872
+ description: Maximum number of top tables to return (0 or omitted = not collected)
5781
5873
  required: false
5782
5874
  schema:
5783
5875
  type: integer
5784
5876
  format: int64
5785
- minimum: 1
5786
- maximum: 200
5787
- responses:
5788
- '200':
5789
- description: OK
5877
+ minimum: 0
5878
+ default: 0
5879
+ - name: indexLimit
5880
+ in: query
5881
+ description: Maximum number of top indexes to return (0 or omitted = not collected)
5882
+ required: false
5883
+ schema:
5884
+ type: integer
5885
+ format: int64
5886
+ minimum: 0
5887
+ default: 0
5888
+ - name: schema
5889
+ in: query
5890
+ description: Filter tables and indexes by schema (owner). Omit or empty = all schemas.
5891
+ required: false
5892
+ schema:
5893
+ type: string
5894
+ - name: skipBasic
5895
+ in: query
5896
+ description: Set to true to skip tablespace and schema queries, returning only tables and indexes.
5897
+ required: false
5898
+ schema:
5899
+ type: boolean
5900
+ default: false
5901
+ responses:
5902
+ '200':
5903
+ description: OK
5904
+ content:
5905
+ application/json:
5906
+ schema:
5907
+ $ref: '#/components/schemas/damengSpaceAnalysis'
5908
+ '400':
5909
+ $ref: '#/components/responses/400'
5910
+ '401':
5911
+ $ref: '#/components/responses/401'
5912
+ '403':
5913
+ $ref: '#/components/responses/403'
5914
+ '404':
5915
+ $ref: '#/components/responses/404'
5916
+ '500':
5917
+ $ref: '#/components/responses/500'
5918
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sqlAnalysis:
5919
+ get:
5920
+ tags:
5921
+ - diagnostics
5922
+ summary: Get Dameng SQL analysis
5923
+ description: Get a read-only Dameng SQL analysis snapshot from V$SYSTEM_LONG_EXEC_SQLS (long-running SQL) and V$SYSTEM_LARGE_MEM_SQLS (high-memory SQL). The response does not expose execution plans or remediation actions.
5924
+ operationId: getDiagnosticsDamengSQLAnalysis
5925
+ parameters:
5926
+ - name: orgName
5927
+ in: path
5928
+ description: Organization name
5929
+ required: true
5930
+ schema:
5931
+ type: string
5932
+ - name: clusterName
5933
+ in: path
5934
+ description: Cluster name
5935
+ required: true
5936
+ schema:
5937
+ type: string
5938
+ - name: limit
5939
+ in: query
5940
+ description: Maximum number of SQL entries per category. Defaults to 20.
5941
+ required: false
5942
+ schema:
5943
+ type: integer
5944
+ format: int64
5945
+ responses:
5946
+ '200':
5947
+ description: OK
5948
+ content:
5949
+ application/json:
5950
+ schema:
5951
+ $ref: '#/components/schemas/damengSQLAnalysis'
5952
+ '400':
5953
+ $ref: '#/components/responses/400'
5954
+ '401':
5955
+ $ref: '#/components/responses/401'
5956
+ '403':
5957
+ $ref: '#/components/responses/403'
5958
+ '404':
5959
+ $ref: '#/components/responses/404'
5960
+ '500':
5961
+ $ref: '#/components/responses/500'
5962
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sessions/{sessionId}/lockAnalysis:
5963
+ get:
5964
+ tags:
5965
+ - diagnostics
5966
+ summary: Get Dameng session lock analysis
5967
+ description: Get lock and blocking analysis for a Dameng session. Queries V$LOCK and V$SESSIONS to identify blocking/blocked relationships and lock details.
5968
+ operationId: getDiagnosticsDamengSessionLockAnalysis
5969
+ parameters:
5970
+ - name: orgName
5971
+ in: path
5972
+ description: Organization name
5973
+ required: true
5974
+ schema:
5975
+ type: string
5976
+ - name: clusterName
5977
+ in: path
5978
+ description: Cluster name
5979
+ required: true
5980
+ schema:
5981
+ type: string
5982
+ - name: sessionId
5983
+ in: path
5984
+ description: Dameng session ID (SESS_ID)
5985
+ required: true
5986
+ schema:
5987
+ type: integer
5988
+ format: int64
5989
+ responses:
5990
+ '200':
5991
+ description: OK
5992
+ content:
5993
+ application/json:
5994
+ schema:
5995
+ $ref: '#/components/schemas/damengLockAnalysis'
5996
+ '400':
5997
+ $ref: '#/components/responses/400'
5998
+ '401':
5999
+ $ref: '#/components/responses/401'
6000
+ '403':
6001
+ $ref: '#/components/responses/403'
6002
+ '404':
6003
+ $ref: '#/components/responses/404'
6004
+ '500':
6005
+ $ref: '#/components/responses/500'
6006
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sessions/{sessionId}:
6007
+ get:
6008
+ tags:
6009
+ - diagnostics
6010
+ summary: Get Dameng session detail
6011
+ description: Get a single Dameng session detail by session ID from V$SESSIONS, including SQL text, transaction info, and client details.
6012
+ operationId: getDiagnosticsDamengSession
6013
+ parameters:
6014
+ - name: orgName
6015
+ in: path
6016
+ description: Organization name
6017
+ required: true
6018
+ schema:
6019
+ type: string
6020
+ - name: clusterName
6021
+ in: path
6022
+ description: Cluster name
6023
+ required: true
6024
+ schema:
6025
+ type: string
6026
+ - name: sessionId
6027
+ in: path
6028
+ description: Dameng session ID (SESS_ID)
6029
+ required: true
6030
+ schema:
6031
+ type: integer
6032
+ format: int64
6033
+ responses:
6034
+ '200':
6035
+ description: OK
6036
+ content:
6037
+ application/json:
6038
+ schema:
6039
+ $ref: '#/components/schemas/damengSessionDetail'
6040
+ '400':
6041
+ $ref: '#/components/responses/400'
6042
+ '401':
6043
+ $ref: '#/components/responses/401'
6044
+ '403':
6045
+ $ref: '#/components/responses/403'
6046
+ '404':
6047
+ $ref: '#/components/responses/404'
6048
+ '500':
6049
+ $ref: '#/components/responses/500'
6050
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/dameng/sessions:
6051
+ get:
6052
+ tags:
6053
+ - diagnostics
6054
+ summary: List Dameng sessions
6055
+ description: List Dameng sessions from V$SESSIONS with lock status from V$LOCK. Returns session ID, user, state, client IP, transaction ID, lock status, SQL text, schema, duration, and more.
6056
+ operationId: listDiagnosticsDamengSessions
6057
+ parameters:
6058
+ - name: orgName
6059
+ in: path
6060
+ description: Organization name
6061
+ required: true
6062
+ schema:
6063
+ type: string
6064
+ - name: clusterName
6065
+ in: path
6066
+ description: Cluster name
6067
+ required: true
6068
+ schema:
6069
+ type: string
6070
+ - name: limit
6071
+ in: query
6072
+ description: Maximum number of sessions to return. Defaults to 200.
6073
+ required: false
6074
+ schema:
6075
+ type: integer
6076
+ format: int64
6077
+ - name: state
6078
+ in: query
6079
+ description: Filter sessions by state (e.g. ACTIVE, IDLE). Matches against V$SESSIONS.STATE.
6080
+ required: false
6081
+ schema:
6082
+ type: string
6083
+ responses:
6084
+ '200':
6085
+ description: OK
6086
+ content:
6087
+ application/json:
6088
+ schema:
6089
+ type: array
6090
+ items:
6091
+ $ref: '#/components/schemas/damengSessionListItem'
6092
+ '400':
6093
+ $ref: '#/components/responses/400'
6094
+ '401':
6095
+ $ref: '#/components/responses/401'
6096
+ '403':
6097
+ $ref: '#/components/responses/403'
6098
+ '404':
6099
+ $ref: '#/components/responses/404'
6100
+ '500':
6101
+ $ref: '#/components/responses/500'
6102
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/kingbase/sessions:
6103
+ get:
6104
+ tags:
6105
+ - diagnostics
6106
+ summary: List Kingbase session diagnostics
6107
+ operationId: listDiagnosticsKingbaseSessions
6108
+ parameters:
6109
+ - name: orgName
6110
+ in: path
6111
+ required: true
6112
+ schema:
6113
+ type: string
6114
+ - name: clusterName
6115
+ in: path
6116
+ required: true
6117
+ schema:
6118
+ type: string
6119
+ - name: limit
6120
+ in: query
6121
+ description: Maximum number of sessions to return. Defaults to 200.
6122
+ required: false
6123
+ schema:
6124
+ type: integer
6125
+ format: int64
6126
+ minimum: 1
6127
+ maximum: 200
6128
+ responses:
6129
+ '200':
6130
+ description: OK
5790
6131
  content:
5791
6132
  application/json:
5792
6133
  schema:
@@ -26017,6 +26358,7 @@ components:
26017
26358
  - rows
26018
26359
  - database
26019
26360
  - user
26361
+ - topLevel
26020
26362
  properties:
26021
26363
  queryID:
26022
26364
  type: string
@@ -26053,6 +26395,9 @@ components:
26053
26395
  user:
26054
26396
  type: string
26055
26397
  description: Database user name resolved from pg_stat_statements.userid when visible.
26398
+ topLevel:
26399
+ type: boolean
26400
+ description: Whether pg_stat_statements recorded the statement as top-level. Legacy PostgreSQL versions without the toplevel column report true.
26056
26401
  postgresqlSQLAnalysis:
26057
26402
  type: object
26058
26403
  required:
@@ -26100,347 +26445,1252 @@ components:
26100
26445
  description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
26101
26446
  items:
26102
26447
  $ref: '#/components/schemas/postgresqlSQLFingerprint'
26103
- mysqlSQLFingerprint:
26448
+ DmsExecutionPlanPlanningMode:
26449
+ type: string
26450
+ enum:
26451
+ - standard
26452
+ - generic
26453
+ DmsExecutionPlanMode:
26454
+ type: string
26455
+ enum:
26456
+ - estimate
26457
+ - analyze
26458
+ - actual
26459
+ - autotrace
26460
+ DmsExecutionPlanRawFormat:
26461
+ type: string
26462
+ enum:
26463
+ - json
26464
+ - xml
26465
+ - text
26466
+ - table
26467
+ DmsExecutionPlanNodeCategory:
26468
+ type: string
26469
+ enum:
26470
+ - result
26471
+ - sort
26472
+ - join
26473
+ - table_scan
26474
+ - index_scan
26475
+ - lookup
26476
+ - materialize
26477
+ - aggregate
26478
+ - exchange
26479
+ - modify
26480
+ - other
26481
+ DmsExecutionPlanNodeCost:
26482
+ type: object
26483
+ properties:
26484
+ startup:
26485
+ type: number
26486
+ format: double
26487
+ nullable: true
26488
+ x-omitempty: true
26489
+ total:
26490
+ type: number
26491
+ format: double
26492
+ nullable: true
26493
+ x-omitempty: true
26494
+ self:
26495
+ type: number
26496
+ format: double
26497
+ nullable: true
26498
+ x-omitempty: true
26499
+ percent:
26500
+ type: number
26501
+ format: double
26502
+ nullable: true
26503
+ x-omitempty: true
26504
+ DmsExecutionPlanNodeRows:
26505
+ type: object
26506
+ properties:
26507
+ estimated:
26508
+ type: number
26509
+ format: double
26510
+ nullable: true
26511
+ x-omitempty: true
26512
+ actual:
26513
+ type: number
26514
+ format: double
26515
+ nullable: true
26516
+ x-omitempty: true
26517
+ actualPerLoop:
26518
+ type: number
26519
+ format: double
26520
+ nullable: true
26521
+ x-omitempty: true
26522
+ removedByFilter:
26523
+ type: number
26524
+ format: double
26525
+ nullable: true
26526
+ x-omitempty: true
26527
+ mismatchRatio:
26528
+ type: number
26529
+ format: double
26530
+ nullable: true
26531
+ x-omitempty: true
26532
+ DmsExecutionPlanNodeTiming:
26533
+ type: object
26534
+ properties:
26535
+ startupMs:
26536
+ type: number
26537
+ format: double
26538
+ nullable: true
26539
+ x-omitempty: true
26540
+ totalMs:
26541
+ type: number
26542
+ format: double
26543
+ nullable: true
26544
+ x-omitempty: true
26545
+ selfMs:
26546
+ type: number
26547
+ format: double
26548
+ nullable: true
26549
+ x-omitempty: true
26550
+ loops:
26551
+ type: number
26552
+ format: double
26553
+ nullable: true
26554
+ x-omitempty: true
26555
+ DmsExecutionPlanNodeConditions:
26556
+ type: object
26557
+ properties:
26558
+ filter:
26559
+ type: string
26560
+ nullable: true
26561
+ x-omitempty: true
26562
+ indexCond:
26563
+ type: string
26564
+ nullable: true
26565
+ x-omitempty: true
26566
+ joinCond:
26567
+ type: string
26568
+ nullable: true
26569
+ x-omitempty: true
26570
+ hashCond:
26571
+ type: string
26572
+ nullable: true
26573
+ x-omitempty: true
26574
+ sortKey:
26575
+ type: array
26576
+ items:
26577
+ type: string
26578
+ DmsExecutionPlanNode:
26579
+ type: object
26580
+ properties:
26581
+ id:
26582
+ type: string
26583
+ parentIds:
26584
+ type: array
26585
+ items:
26586
+ type: string
26587
+ childIds:
26588
+ type: array
26589
+ items:
26590
+ type: string
26591
+ order:
26592
+ type: integer
26593
+ format: int64
26594
+ nullable: true
26595
+ x-omitempty: true
26596
+ category:
26597
+ $ref: '#/components/schemas/DmsExecutionPlanNodeCategory'
26598
+ nodeType:
26599
+ type: string
26600
+ label:
26601
+ type: string
26602
+ relationName:
26603
+ type: string
26604
+ nullable: true
26605
+ x-omitempty: true
26606
+ schemaName:
26607
+ type: string
26608
+ nullable: true
26609
+ x-omitempty: true
26610
+ alias:
26611
+ type: string
26612
+ nullable: true
26613
+ x-omitempty: true
26614
+ indexName:
26615
+ type: string
26616
+ nullable: true
26617
+ x-omitempty: true
26618
+ cost:
26619
+ $ref: '#/components/schemas/DmsExecutionPlanNodeCost'
26620
+ nullable: true
26621
+ x-omitempty: true
26622
+ rows:
26623
+ $ref: '#/components/schemas/DmsExecutionPlanNodeRows'
26624
+ nullable: true
26625
+ x-omitempty: true
26626
+ timing:
26627
+ $ref: '#/components/schemas/DmsExecutionPlanNodeTiming'
26628
+ nullable: true
26629
+ x-omitempty: true
26630
+ conditions:
26631
+ $ref: '#/components/schemas/DmsExecutionPlanNodeConditions'
26632
+ nullable: true
26633
+ x-omitempty: true
26634
+ details:
26635
+ type: object
26636
+ additionalProperties: true
26637
+ x-omitempty: true
26638
+ DmsExecutionPlanEdgeRows:
26639
+ type: object
26640
+ properties:
26641
+ estimated:
26642
+ type: number
26643
+ format: double
26644
+ nullable: true
26645
+ x-omitempty: true
26646
+ actual:
26647
+ type: number
26648
+ format: double
26649
+ nullable: true
26650
+ x-omitempty: true
26651
+ DmsExecutionPlanEdge:
26652
+ type: object
26653
+ properties:
26654
+ id:
26655
+ type: string
26656
+ source:
26657
+ type: string
26658
+ target:
26659
+ type: string
26660
+ rows:
26661
+ $ref: '#/components/schemas/DmsExecutionPlanEdgeRows'
26662
+ nullable: true
26663
+ x-omitempty: true
26664
+ widthWeight:
26665
+ type: number
26666
+ format: double
26667
+ nullable: true
26668
+ x-omitempty: true
26669
+ label:
26670
+ type: string
26671
+ nullable: true
26672
+ x-omitempty: true
26673
+ DmsExecutionPlanSummary:
26674
+ type: object
26675
+ properties:
26676
+ totalCost:
26677
+ type: number
26678
+ format: double
26679
+ nullable: true
26680
+ x-omitempty: true
26681
+ totalActualTimeMs:
26682
+ type: number
26683
+ format: double
26684
+ nullable: true
26685
+ x-omitempty: true
26686
+ planRows:
26687
+ type: number
26688
+ format: double
26689
+ nullable: true
26690
+ x-omitempty: true
26691
+ actualRows:
26692
+ type: number
26693
+ format: double
26694
+ nullable: true
26695
+ x-omitempty: true
26696
+ nodeCount:
26697
+ type: integer
26698
+ format: int64
26699
+ maxCostNodeId:
26700
+ type: string
26701
+ nullable: true
26702
+ x-omitempty: true
26703
+ maxRowsNodeId:
26704
+ type: string
26705
+ nullable: true
26706
+ x-omitempty: true
26707
+ maxTimeNodeId:
26708
+ type: string
26709
+ nullable: true
26710
+ x-omitempty: true
26711
+ DmsExecutionPlanWarningSeverity:
26712
+ type: string
26713
+ enum:
26714
+ - info
26715
+ - warning
26716
+ - critical
26717
+ DmsExecutionPlanWarning:
26718
+ type: object
26719
+ properties:
26720
+ code:
26721
+ type: string
26722
+ severity:
26723
+ $ref: '#/components/schemas/DmsExecutionPlanWarningSeverity'
26724
+ nodeId:
26725
+ type: string
26726
+ nullable: true
26727
+ x-omitempty: true
26728
+ message:
26729
+ type: string
26730
+ DmsExecutionPlanResult:
26731
+ type: object
26732
+ properties:
26733
+ originSQL:
26734
+ type: string
26735
+ explainSQL:
26736
+ type: string
26737
+ nullable: true
26738
+ x-omitempty: true
26739
+ engineType:
26740
+ type: string
26741
+ mode:
26742
+ $ref: '#/components/schemas/DmsExecutionPlanMode'
26743
+ planMode:
26744
+ $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
26745
+ parameterized:
26746
+ type: boolean
26747
+ x-omitempty: false
26748
+ parameterCount:
26749
+ type: integer
26750
+ format: int64
26751
+ nullable: true
26752
+ x-omitempty: true
26753
+ hasActualStats:
26754
+ type: boolean
26755
+ x-omitempty: false
26756
+ rawFormat:
26757
+ $ref: '#/components/schemas/DmsExecutionPlanRawFormat'
26758
+ rawPlan:
26759
+ type: object
26760
+ description: Engine-native raw plan payload exposed for fallback display. SDKs model it as a free-form JSON object.
26761
+ additionalProperties: true
26762
+ x-omitempty: true
26763
+ rootNodeIds:
26764
+ type: array
26765
+ items:
26766
+ type: string
26767
+ nodes:
26768
+ type: array
26769
+ items:
26770
+ $ref: '#/components/schemas/DmsExecutionPlanNode'
26771
+ edges:
26772
+ type: array
26773
+ items:
26774
+ $ref: '#/components/schemas/DmsExecutionPlanEdge'
26775
+ summary:
26776
+ $ref: '#/components/schemas/DmsExecutionPlanSummary'
26777
+ nullable: true
26778
+ x-omitempty: true
26779
+ warnings:
26780
+ type: array
26781
+ items:
26782
+ $ref: '#/components/schemas/DmsExecutionPlanWarning'
26783
+ fallbackTable:
26784
+ $ref: '#/components/schemas/DmsQueryResponse'
26785
+ nullable: true
26786
+ x-omitempty: true
26787
+ postgresqlSQLFingerprintExplainResponse:
26788
+ type: object
26789
+ required:
26790
+ - queryID
26791
+ - fingerprint
26792
+ - database
26793
+ - user
26794
+ - topLevel
26795
+ - planMode
26796
+ - parameterized
26797
+ - explainResult
26798
+ properties:
26799
+ queryID:
26800
+ type: string
26801
+ description: PostgreSQL pg_stat_statements queryid represented as a string.
26802
+ fingerprint:
26803
+ type: string
26804
+ description: Stable SQL fingerprint identifier for UI grouping. Currently aligned with PostgreSQL pg_stat_statements queryid.
26805
+ database:
26806
+ type: string
26807
+ description: Database name from the requested SQL fingerprint identity.
26808
+ user:
26809
+ type: string
26810
+ description: Database user from the requested SQL fingerprint identity.
26811
+ topLevel:
26812
+ type: boolean
26813
+ description: Top-level flag from the requested SQL fingerprint identity.
26814
+ statementSource:
26815
+ type: string
26816
+ description: Server-side source used to resolve the parameterized SQL statement. Raw SQL is not returned.
26817
+ statementResolvedAt:
26818
+ type: string
26819
+ description: Timestamp when the parameterized SQL statement was resolved.
26820
+ planMode:
26821
+ $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
26822
+ description: Whether DMS produced a standard estimated plan or a generic parameterized estimated plan.
26823
+ parameterized:
26824
+ type: boolean
26825
+ description: Whether generic parameterized planning was used (planMode is generic). False means standard planning, not that historical parameter values were used. This endpoint never retrieves historical parameter values.
26826
+ x-omitempty: false
26827
+ parameterCount:
26828
+ type: integer
26829
+ format: int64
26830
+ nullable: true
26831
+ x-omitempty: true
26832
+ description: Number of parameters when DMS can determine it. It may be omitted for PostgreSQL generic-plan paths that do not expose the count.
26833
+ explainResult:
26834
+ $ref: '#/components/schemas/DmsExecutionPlanResult'
26835
+ description: Normalized DMS estimated visual plan. The resolved statement and generated EXPLAIN SQL are intentionally removed.
26836
+ mysqlSQLFingerprint:
26837
+ type: object
26838
+ required:
26839
+ - queryID
26840
+ - fingerprint
26841
+ - querySummary
26842
+ - calls
26843
+ - totalTimeMs
26844
+ - meanTimeMs
26845
+ - maxTimeMs
26846
+ - rows
26847
+ - rowsSent
26848
+ - rowsAffected
26849
+ - rowsExamined
26850
+ - lockTimeMs
26851
+ - errors
26852
+ - warnings
26853
+ - tmpTables
26854
+ - tmpDiskTables
26855
+ - noIndexUsed
26856
+ - noGoodIndexUsed
26857
+ - database
26858
+ properties:
26859
+ queryID:
26860
+ type: string
26861
+ description: MySQL Performance Schema DIGEST value.
26862
+ fingerprint:
26863
+ type: string
26864
+ description: Stable SQL fingerprint identifier. M1 uses DIGEST.
26865
+ querySummary:
26866
+ type: string
26867
+ description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
26868
+ calls:
26869
+ type: integer
26870
+ format: int64
26871
+ description: Number of executions accumulated in the current digest row.
26872
+ totalTimeMs:
26873
+ type: number
26874
+ format: double
26875
+ description: Total statement wait time in milliseconds.
26876
+ meanTimeMs:
26877
+ type: number
26878
+ format: double
26879
+ description: Mean statement wait time in milliseconds.
26880
+ maxTimeMs:
26881
+ type: number
26882
+ format: double
26883
+ description: Maximum statement wait time in milliseconds.
26884
+ rows:
26885
+ type: integer
26886
+ format: int64
26887
+ description: Sum of rows sent and rows affected.
26888
+ rowsSent:
26889
+ type: integer
26890
+ format: int64
26891
+ description: Total rows sent to clients.
26892
+ rowsAffected:
26893
+ type: integer
26894
+ format: int64
26895
+ description: Total rows affected by statements.
26896
+ rowsExamined:
26897
+ type: integer
26898
+ format: int64
26899
+ description: Total rows examined by statements.
26900
+ lockTimeMs:
26901
+ type: number
26902
+ format: double
26903
+ description: Total statement lock time in milliseconds.
26904
+ errors:
26905
+ type: integer
26906
+ format: int64
26907
+ description: Total statement errors.
26908
+ warnings:
26909
+ type: integer
26910
+ format: int64
26911
+ description: Total statement warnings.
26912
+ tmpTables:
26913
+ type: integer
26914
+ format: int64
26915
+ description: Total internal temporary tables created.
26916
+ tmpDiskTables:
26917
+ type: integer
26918
+ format: int64
26919
+ description: Total internal on-disk temporary tables created.
26920
+ noIndexUsed:
26921
+ type: integer
26922
+ format: int64
26923
+ description: Executions that used no index.
26924
+ noGoodIndexUsed:
26925
+ type: integer
26926
+ format: int64
26927
+ description: Executions for which no good index was found.
26928
+ database:
26929
+ type: string
26930
+ description: Default schema name associated with the digest row.
26931
+ firstSeen:
26932
+ type: string
26933
+ description: UTC timestamp when the digest was first observed.
26934
+ lastSeen:
26935
+ type: string
26936
+ description: UTC timestamp when the digest was most recently observed.
26937
+ mysqlSQLAnalysis:
26938
+ type: object
26939
+ required:
26940
+ - source
26941
+ - status
26942
+ - collectedAt
26943
+ - limit
26944
+ - orderBy
26945
+ - items
26946
+ properties:
26947
+ source:
26948
+ type: string
26949
+ description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
26950
+ status:
26951
+ type: string
26952
+ description: Source status. Expected values are available or unavailable.
26953
+ unavailableReason:
26954
+ type: string
26955
+ description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
26956
+ message:
26957
+ type: string
26958
+ description: User-facing recovery guidance when SQL analysis is unavailable.
26959
+ collectedAt:
26960
+ type: string
26961
+ description: Backend collection timestamp in UTC. It is not a sampling-window end time.
26962
+ firstSeen:
26963
+ type: string
26964
+ description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
26965
+ lastSeen:
26966
+ type: string
26967
+ description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
26968
+ limit:
26969
+ type: integer
26970
+ format: int64
26971
+ description: Effective row limit after backend normalization.
26972
+ orderBy:
26973
+ type: string
26974
+ description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
26975
+ totalTimeMsAll:
26976
+ type: number
26977
+ format: double
26978
+ x-nullable: true
26979
+ description: Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
26980
+ callsAll:
26981
+ type: integer
26982
+ format: int64
26983
+ x-nullable: true
26984
+ description: Total execution count across all visible digest rows, not limited to the returned top-N items.
26985
+ digestLost:
26986
+ type: integer
26987
+ format: int64
26988
+ x-nullable: true
26989
+ description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
26990
+ items:
26991
+ type: array
26992
+ description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
26993
+ items:
26994
+ $ref: '#/components/schemas/mysqlSQLFingerprint'
26995
+ performanceTrendRange:
26996
+ type: object
26997
+ required:
26998
+ - label
26999
+ - start
27000
+ - end
27001
+ - durationSeconds
27002
+ properties:
27003
+ label:
27004
+ type: string
27005
+ description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
27006
+ start:
27007
+ type: string
27008
+ end:
27009
+ type: string
27010
+ durationSeconds:
27011
+ type: integer
27012
+ format: int64
27013
+ performanceTrendSummary:
27014
+ type: object
27015
+ required:
27016
+ - metric
27017
+ - displayName
27018
+ - category
27019
+ - unit
27020
+ - min
27021
+ - max
27022
+ - avg
27023
+ - latest
27024
+ properties:
27025
+ metric:
27026
+ type: string
27027
+ displayName:
27028
+ $ref: '#/components/schemas/localizedDescription'
27029
+ category:
27030
+ type: string
27031
+ description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
27032
+ dimension:
27033
+ type: string
27034
+ description: Optional series dimension. Values include cluster, instance, pvc, and database.
27035
+ labels:
27036
+ type: object
27037
+ additionalProperties:
27038
+ type: string
27039
+ description: Optional dimension labels, for example instance, pvc, role, or datname.
27040
+ unit:
27041
+ type: string
27042
+ warnThreshold:
27043
+ type: number
27044
+ format: double
27045
+ description: Optional warning threshold in the same unit as this metric.
27046
+ critThreshold:
27047
+ type: number
27048
+ format: double
27049
+ description: Optional critical threshold in the same unit as this metric.
27050
+ thresholdDirection:
27051
+ type: string
27052
+ description: Optional threshold direction. Values are above, below, or boolean.
27053
+ min:
27054
+ type: number
27055
+ format: double
27056
+ max:
27057
+ type: number
27058
+ format: double
27059
+ avg:
27060
+ type: number
27061
+ format: double
27062
+ latest:
27063
+ type: number
27064
+ format: double
27065
+ changeDirection:
27066
+ type: string
27067
+ description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
27068
+ performanceTrendPoint:
27069
+ type: object
27070
+ required:
27071
+ - timestamp
27072
+ - value
27073
+ properties:
27074
+ timestamp:
27075
+ type: string
27076
+ value:
27077
+ type: number
27078
+ format: double
27079
+ performanceTrendSeries:
27080
+ type: object
27081
+ required:
27082
+ - metric
27083
+ - displayName
27084
+ - category
27085
+ - unit
27086
+ - points
27087
+ properties:
27088
+ metric:
27089
+ type: string
27090
+ displayName:
27091
+ $ref: '#/components/schemas/localizedDescription'
27092
+ category:
27093
+ type: string
27094
+ description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
27095
+ dimension:
27096
+ type: string
27097
+ description: Optional series dimension. Values include cluster, instance, pvc, and database.
27098
+ labels:
27099
+ type: object
27100
+ additionalProperties:
27101
+ type: string
27102
+ description: Optional dimension labels, for example instance, pvc, role, or datname.
27103
+ unit:
27104
+ type: string
27105
+ warnThreshold:
27106
+ type: number
27107
+ format: double
27108
+ description: Optional warning threshold in the same unit as this metric.
27109
+ critThreshold:
27110
+ type: number
27111
+ format: double
27112
+ description: Optional critical threshold in the same unit as this metric.
27113
+ thresholdDirection:
27114
+ type: string
27115
+ description: Optional threshold direction. Values are above, below, or boolean.
27116
+ points:
27117
+ type: array
27118
+ items:
27119
+ $ref: '#/components/schemas/performanceTrendPoint'
27120
+ performanceTrendSource:
27121
+ type: object
27122
+ required:
27123
+ - name
27124
+ - kind
27125
+ - status
27126
+ - collectedAt
27127
+ properties:
27128
+ name:
27129
+ type: string
27130
+ kind:
27131
+ type: string
27132
+ status:
27133
+ type: string
27134
+ description: Coarse source status. Values are success, partial, failed, skipped, or noData.
27135
+ collectedAt:
27136
+ type: string
27137
+ message:
27138
+ type: string
27139
+ performanceTrends:
26104
27140
  type: object
26105
27141
  required:
26106
- - queryID
26107
- - fingerprint
26108
- - querySummary
26109
- - calls
26110
- - totalTimeMs
26111
- - meanTimeMs
26112
- - maxTimeMs
26113
- - rows
26114
- - rowsSent
26115
- - rowsAffected
26116
- - rowsExamined
26117
- - lockTimeMs
26118
- - errors
27142
+ - range
27143
+ - granularity
27144
+ - summary
27145
+ - series
27146
+ - sources
26119
27147
  - warnings
26120
- - tmpTables
26121
- - tmpDiskTables
26122
- - noIndexUsed
26123
- - noGoodIndexUsed
26124
- - database
27148
+ - collectedAt
26125
27149
  properties:
26126
- queryID:
27150
+ range:
27151
+ $ref: '#/components/schemas/performanceTrendRange'
27152
+ granularity:
26127
27153
  type: string
26128
- description: MySQL Performance Schema DIGEST value.
26129
- fingerprint:
27154
+ description: Controlled backend query step.
27155
+ summary:
27156
+ type: array
27157
+ description: Per-series numeric summary. changeDirection is present only when at least two points exist.
27158
+ items:
27159
+ $ref: '#/components/schemas/performanceTrendSummary'
27160
+ series:
27161
+ type: array
27162
+ description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
27163
+ items:
27164
+ $ref: '#/components/schemas/performanceTrendSeries'
27165
+ sources:
27166
+ type: array
27167
+ description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
27168
+ items:
27169
+ $ref: '#/components/schemas/performanceTrendSource'
27170
+ warnings:
27171
+ type: array
27172
+ items:
27173
+ type: string
27174
+ collectedAt:
26130
27175
  type: string
26131
- description: Stable SQL fingerprint identifier. M1 uses DIGEST.
26132
- querySummary:
27176
+ description: Backend collection timestamp in UTC.
27177
+ elasticsearchHotThreadsType:
27178
+ type: string
27179
+ enum:
27180
+ - cpu
27181
+ - wait
27182
+ - block
27183
+ default: cpu
27184
+ elasticsearchTask:
27185
+ type: object
27186
+ required:
27187
+ - taskId
27188
+ - nodeId
27189
+ - nodeName
27190
+ - action
27191
+ - runningTimeMillis
27192
+ - cancellable
27193
+ properties:
27194
+ taskId:
26133
27195
  type: string
26134
- description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
26135
- calls:
27196
+ nodeId:
27197
+ type: string
27198
+ nodeName:
27199
+ type: string
27200
+ action:
27201
+ type: string
27202
+ description:
27203
+ type: string
27204
+ type:
27205
+ type: string
27206
+ startTime:
27207
+ type: string
27208
+ runningTimeMillis:
26136
27209
  type: integer
26137
27210
  format: int64
26138
- description: Number of executions accumulated in the current digest row.
26139
- totalTimeMs:
26140
- type: number
26141
- format: double
26142
- description: Total statement wait time in milliseconds.
26143
- meanTimeMs:
26144
- type: number
26145
- format: double
26146
- description: Mean statement wait time in milliseconds.
26147
- maxTimeMs:
26148
- type: number
26149
- format: double
26150
- description: Maximum statement wait time in milliseconds.
26151
- rows:
27211
+ cancellable:
27212
+ type: boolean
27213
+ cancelled:
27214
+ type: boolean
27215
+ elasticsearchHotThreads:
27216
+ type: object
27217
+ required:
27218
+ - type
27219
+ - content
27220
+ - truncated
27221
+ properties:
27222
+ nodeName:
27223
+ type: string
27224
+ type:
27225
+ type: string
27226
+ content:
27227
+ type: string
27228
+ truncated:
27229
+ type: boolean
27230
+ elasticsearchTaskAnalysis:
27231
+ type: object
27232
+ required:
27233
+ - tasks
27234
+ - hotThreads
27235
+ - sources
27236
+ - warnings
27237
+ - collectedAt
27238
+ properties:
27239
+ tasks:
27240
+ type: array
27241
+ description: List of currently running tasks, sorted by running time in descending order
27242
+ items:
27243
+ $ref: '#/components/schemas/elasticsearchTask'
27244
+ hotThreads:
27245
+ type: array
27246
+ items:
27247
+ $ref: '#/components/schemas/elasticsearchHotThreads'
27248
+ sources:
27249
+ type: array
27250
+ items:
27251
+ $ref: '#/components/schemas/performanceTrendSource'
27252
+ warnings:
27253
+ type: array
27254
+ items:
27255
+ type: string
27256
+ collectedAt:
27257
+ type: string
27258
+ elasticsearchIndexSortBy:
27259
+ type: string
27260
+ enum:
27261
+ - name
27262
+ - documents
27263
+ - totalStoreBytes
27264
+ - segments
27265
+ default: totalStoreBytes
27266
+ elasticsearchSortOrder:
27267
+ type: string
27268
+ enum:
27269
+ - asc
27270
+ - desc
27271
+ default: desc
27272
+ elasticsearchIndexStorage:
27273
+ type: object
27274
+ required:
27275
+ - name
27276
+ - health
27277
+ - status
27278
+ - primaryShards
27279
+ - replicaShards
27280
+ - documents
27281
+ - deletedDocuments
27282
+ - primaryStoreBytes
27283
+ - totalStoreBytes
27284
+ - segments
27285
+ properties:
27286
+ name:
27287
+ type: string
27288
+ uuid:
27289
+ type: string
27290
+ health:
27291
+ type: string
27292
+ status:
27293
+ type: string
27294
+ primaryShards:
26152
27295
  type: integer
26153
27296
  format: int64
26154
- description: Sum of rows sent and rows affected.
26155
- rowsSent:
27297
+ nullable: true
27298
+ replicaShards:
26156
27299
  type: integer
26157
27300
  format: int64
26158
- description: Total rows sent to clients.
26159
- rowsAffected:
27301
+ nullable: true
27302
+ documents:
26160
27303
  type: integer
26161
27304
  format: int64
26162
- description: Total rows affected by statements.
26163
- rowsExamined:
27305
+ nullable: true
27306
+ deletedDocuments:
26164
27307
  type: integer
26165
27308
  format: int64
26166
- description: Total rows examined by statements.
26167
- lockTimeMs:
26168
- type: number
26169
- format: double
26170
- description: Total statement lock time in milliseconds.
26171
- errors:
27309
+ nullable: true
27310
+ primaryStoreBytes:
26172
27311
  type: integer
26173
27312
  format: int64
26174
- description: Total statement errors.
26175
- warnings:
27313
+ nullable: true
27314
+ totalStoreBytes:
26176
27315
  type: integer
26177
27316
  format: int64
26178
- description: Total statement warnings.
26179
- tmpTables:
27317
+ nullable: true
27318
+ segments:
26180
27319
  type: integer
26181
27320
  format: int64
26182
- description: Total internal temporary tables created.
26183
- tmpDiskTables:
27321
+ nullable: true
27322
+ elasticsearchNodeAllocation:
27323
+ type: object
27324
+ required:
27325
+ - nodeName
27326
+ - shards
27327
+ - diskIndicesBytes
27328
+ - diskUsedBytes
27329
+ - diskAvailableBytes
27330
+ - diskTotalBytes
27331
+ - diskPercent
27332
+ properties:
27333
+ nodeName:
27334
+ type: string
27335
+ host:
27336
+ type: string
27337
+ ip:
27338
+ type: string
27339
+ shards:
26184
27340
  type: integer
26185
27341
  format: int64
26186
- description: Total internal on-disk temporary tables created.
26187
- noIndexUsed:
27342
+ nullable: true
27343
+ diskIndicesBytes:
27344
+ type: integer
27345
+ format: int64
27346
+ nullable: true
27347
+ diskUsedBytes:
27348
+ type: integer
27349
+ format: int64
27350
+ nullable: true
27351
+ diskAvailableBytes:
27352
+ type: integer
27353
+ format: int64
27354
+ nullable: true
27355
+ diskTotalBytes:
27356
+ type: integer
27357
+ format: int64
27358
+ nullable: true
27359
+ diskPercent:
27360
+ type: number
27361
+ format: double
27362
+ nullable: true
27363
+ elasticsearchDiskWatermarks:
27364
+ type: object
27365
+ required:
27366
+ - low
27367
+ - high
27368
+ - floodStage
27369
+ properties:
27370
+ low:
27371
+ type: string
27372
+ high:
27373
+ type: string
27374
+ floodStage:
27375
+ type: string
27376
+ elasticsearchStorageAnalysis:
27377
+ type: object
27378
+ required:
27379
+ - indices
27380
+ - allocations
27381
+ - watermarks
27382
+ - sources
27383
+ - warnings
27384
+ - collectedAt
27385
+ properties:
27386
+ indices:
27387
+ type: array
27388
+ items:
27389
+ $ref: '#/components/schemas/elasticsearchIndexStorage'
27390
+ allocations:
27391
+ type: array
27392
+ items:
27393
+ $ref: '#/components/schemas/elasticsearchNodeAllocation'
27394
+ watermarks:
27395
+ $ref: '#/components/schemas/elasticsearchDiskWatermarks'
27396
+ sources:
27397
+ type: array
27398
+ items:
27399
+ $ref: '#/components/schemas/performanceTrendSource'
27400
+ warnings:
27401
+ type: array
27402
+ items:
27403
+ type: string
27404
+ collectedAt:
27405
+ type: string
27406
+ elasticsearchShardState:
27407
+ type: string
27408
+ enum:
27409
+ - STARTED
27410
+ - INITIALIZING
27411
+ - RELOCATING
27412
+ - UNASSIGNED
27413
+ elasticsearchShard:
27414
+ type: object
27415
+ properties:
27416
+ index:
27417
+ type: string
27418
+ x-go-name: Index
27419
+ nullable: true
27420
+ shard:
27421
+ type: integer
27422
+ x-go-name: Shard
27423
+ nullable: true
27424
+ format: int64
27425
+ primary:
27426
+ type: boolean
27427
+ x-go-name: Primary
27428
+ nullable: true
27429
+ state:
27430
+ type: string
27431
+ x-go-name: State
27432
+ nullable: true
27433
+ documents:
26188
27434
  type: integer
27435
+ x-go-name: Documents
27436
+ nullable: true
26189
27437
  format: int64
26190
- description: Executions that used no index.
26191
- noGoodIndexUsed:
27438
+ storeBytes:
26192
27439
  type: integer
27440
+ x-go-name: StoreBytes
27441
+ nullable: true
26193
27442
  format: int64
26194
- description: Executions for which no good index was found.
26195
- database:
27443
+ nodeId:
26196
27444
  type: string
26197
- description: Default schema name associated with the digest row.
26198
- firstSeen:
27445
+ x-go-name: NodeID
27446
+ nullable: true
27447
+ nodeName:
26199
27448
  type: string
26200
- description: UTC timestamp when the digest was first observed.
26201
- lastSeen:
27449
+ x-go-name: NodeName
27450
+ nullable: true
27451
+ unassignedReason:
26202
27452
  type: string
26203
- description: UTC timestamp when the digest was most recently observed.
26204
- mysqlSQLAnalysis:
27453
+ x-go-name: UnassignedReason
27454
+ nullable: true
27455
+ elasticsearchShardList:
26205
27456
  type: object
26206
27457
  required:
26207
- - source
26208
- - status
27458
+ - shards
26209
27459
  - collectedAt
26210
- - limit
26211
- - orderBy
26212
- - items
26213
27460
  properties:
26214
- source:
26215
- type: string
26216
- description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
26217
- status:
26218
- type: string
26219
- description: Source status. Expected values are available or unavailable.
26220
- unavailableReason:
26221
- type: string
26222
- description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
26223
- message:
26224
- type: string
26225
- description: User-facing recovery guidance when SQL analysis is unavailable.
27461
+ shards:
27462
+ type: array
27463
+ items:
27464
+ $ref: '#/components/schemas/elasticsearchShard'
26226
27465
  collectedAt:
26227
27466
  type: string
26228
- description: Backend collection timestamp in UTC. It is not a sampling-window end time.
26229
- firstSeen:
27467
+ elasticsearchShardNode:
27468
+ type: object
27469
+ properties:
27470
+ id:
26230
27471
  type: string
26231
- description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
26232
- lastSeen:
27472
+ x-go-name: ID
27473
+ nullable: true
27474
+ name:
26233
27475
  type: string
26234
- description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
26235
- limit:
27476
+ x-go-name: Name
27477
+ nullable: true
27478
+ elasticsearchRecoveryTranslog:
27479
+ type: object
27480
+ properties:
27481
+ recovered:
26236
27482
  type: integer
27483
+ x-go-name: Recovered
27484
+ nullable: true
26237
27485
  format: int64
26238
- description: Effective row limit after backend normalization.
26239
- orderBy:
27486
+ total:
27487
+ type: integer
27488
+ x-go-name: Total
27489
+ nullable: true
27490
+ format: int64
27491
+ percent:
26240
27492
  type: string
26241
- description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
26242
- totalTimeMsAll:
26243
- type: number
26244
- format: double
26245
- x-nullable: true
26246
- description: Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
26247
- callsAll:
27493
+ x-go-name: Percent
27494
+ nullable: true
27495
+ elasticsearchRecoverySize:
27496
+ type: object
27497
+ properties:
27498
+ totalBytes:
26248
27499
  type: integer
27500
+ x-go-name: TotalBytes
27501
+ nullable: true
26249
27502
  format: int64
26250
- x-nullable: true
26251
- description: Total execution count across all visible digest rows, not limited to the returned top-N items.
26252
- digestLost:
27503
+ reusedBytes:
26253
27504
  type: integer
27505
+ x-go-name: ReusedBytes
27506
+ nullable: true
26254
27507
  format: int64
26255
- x-nullable: true
26256
- description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
26257
- items:
26258
- type: array
26259
- description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
26260
- items:
26261
- $ref: '#/components/schemas/mysqlSQLFingerprint'
26262
- performanceTrendRange:
26263
- type: object
26264
- required:
26265
- - label
26266
- - start
26267
- - end
26268
- - durationSeconds
26269
- properties:
26270
- label:
26271
- type: string
26272
- description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
26273
- start:
26274
- type: string
26275
- end:
26276
- type: string
26277
- durationSeconds:
27508
+ recoveredBytes:
26278
27509
  type: integer
27510
+ x-go-name: RecoveredBytes
27511
+ nullable: true
26279
27512
  format: int64
26280
- performanceTrendSummary:
27513
+ percent:
27514
+ type: string
27515
+ x-go-name: Percent
27516
+ nullable: true
27517
+ elasticsearchShardRecovery:
26281
27518
  type: object
26282
- required:
26283
- - metric
26284
- - displayName
26285
- - category
26286
- - unit
26287
- - min
26288
- - max
26289
- - avg
26290
- - latest
26291
27519
  properties:
26292
- metric:
26293
- type: string
26294
- displayName:
26295
- $ref: '#/components/schemas/localizedDescription'
26296
- category:
26297
- type: string
26298
- description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
26299
- dimension:
26300
- type: string
26301
- description: Optional series dimension. Values include cluster, instance, pvc, and database.
26302
- labels:
26303
- type: object
26304
- additionalProperties:
26305
- type: string
26306
- description: Optional dimension labels, for example instance, pvc, role, or datname.
26307
- unit:
27520
+ index:
26308
27521
  type: string
26309
- warnThreshold:
26310
- type: number
26311
- format: double
26312
- description: Optional warning threshold in the same unit as this metric.
26313
- critThreshold:
26314
- type: number
26315
- format: double
26316
- description: Optional critical threshold in the same unit as this metric.
26317
- thresholdDirection:
27522
+ x-go-name: Index
27523
+ nullable: true
27524
+ shard:
27525
+ type: integer
27526
+ x-go-name: Shard
27527
+ nullable: true
27528
+ format: int64
27529
+ type:
26318
27530
  type: string
26319
- description: Optional threshold direction. Values are above, below, or boolean.
26320
- min:
26321
- type: number
26322
- format: double
26323
- max:
26324
- type: number
26325
- format: double
26326
- avg:
26327
- type: number
26328
- format: double
26329
- latest:
26330
- type: number
26331
- format: double
26332
- changeDirection:
27531
+ x-go-name: Type
27532
+ nullable: true
27533
+ stage:
26333
27534
  type: string
26334
- description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
26335
- performanceTrendPoint:
27535
+ x-go-name: Stage
27536
+ nullable: true
27537
+ primary:
27538
+ type: boolean
27539
+ x-go-name: Primary
27540
+ nullable: true
27541
+ startTimeMillis:
27542
+ type: integer
27543
+ x-go-name: StartTimeMillis
27544
+ nullable: true
27545
+ format: int64
27546
+ totalTimeMillis:
27547
+ type: integer
27548
+ x-go-name: TotalTimeMillis
27549
+ nullable: true
27550
+ format: int64
27551
+ source:
27552
+ $ref: '#/components/schemas/elasticsearchShardNode'
27553
+ x-go-name: Source
27554
+ target:
27555
+ $ref: '#/components/schemas/elasticsearchShardNode'
27556
+ x-go-name: Target
27557
+ translog:
27558
+ $ref: '#/components/schemas/elasticsearchRecoveryTranslog'
27559
+ x-go-name: Translog
27560
+ size:
27561
+ $ref: '#/components/schemas/elasticsearchRecoverySize'
27562
+ x-go-name: Size
27563
+ elasticsearchRecoveryList:
26336
27564
  type: object
26337
27565
  required:
26338
- - timestamp
26339
- - value
27566
+ - recoveries
27567
+ - collectedAt
26340
27568
  properties:
26341
- timestamp:
27569
+ recoveries:
27570
+ type: array
27571
+ items:
27572
+ $ref: '#/components/schemas/elasticsearchShardRecovery'
27573
+ collectedAt:
26342
27574
  type: string
26343
- value:
26344
- type: number
26345
- format: double
26346
- performanceTrendSeries:
27575
+ elasticsearchUnassignedInfo:
26347
27576
  type: object
26348
- required:
26349
- - metric
26350
- - displayName
26351
- - category
26352
- - unit
26353
- - points
26354
27577
  properties:
26355
- metric:
26356
- type: string
26357
- displayName:
26358
- $ref: '#/components/schemas/localizedDescription'
26359
- category:
27578
+ reason:
26360
27579
  type: string
26361
- description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
26362
- dimension:
27580
+ x-go-name: Reason
27581
+ nullable: true
27582
+ at:
26363
27583
  type: string
26364
- description: Optional series dimension. Values include cluster, instance, pvc, and database.
26365
- labels:
26366
- type: object
26367
- additionalProperties:
26368
- type: string
26369
- description: Optional dimension labels, for example instance, pvc, role, or datname.
26370
- unit:
27584
+ x-go-name: At
27585
+ nullable: true
27586
+ details:
26371
27587
  type: string
26372
- warnThreshold:
26373
- type: number
26374
- format: double
26375
- description: Optional warning threshold in the same unit as this metric.
26376
- critThreshold:
26377
- type: number
26378
- format: double
26379
- description: Optional critical threshold in the same unit as this metric.
26380
- thresholdDirection:
27588
+ x-go-name: Details
27589
+ nullable: true
27590
+ lastAllocationStatus:
26381
27591
  type: string
26382
- description: Optional threshold direction. Values are above, below, or boolean.
26383
- points:
26384
- type: array
26385
- items:
26386
- $ref: '#/components/schemas/performanceTrendPoint'
26387
- performanceTrendSource:
27592
+ x-go-name: LastAllocationStatus
27593
+ nullable: true
27594
+ elasticsearchAllocationDecider:
26388
27595
  type: object
26389
- required:
26390
- - name
26391
- - kind
26392
- - status
26393
- - collectedAt
26394
27596
  properties:
26395
- name:
26396
- type: string
26397
- kind:
27597
+ decider:
26398
27598
  type: string
26399
- status:
26400
- type: string
26401
- description: Coarse source status. Values are success, partial, failed, skipped, or noData.
26402
- collectedAt:
27599
+ x-go-name: Decider
27600
+ nullable: true
27601
+ decision:
26403
27602
  type: string
26404
- message:
27603
+ x-go-name: Decision
27604
+ nullable: true
27605
+ explanation:
26405
27606
  type: string
26406
- performanceTrends:
27607
+ x-go-name: Explanation
27608
+ nullable: true
27609
+ elasticsearchNodeAllocationDecision:
26407
27610
  type: object
26408
- required:
26409
- - range
26410
- - granularity
26411
- - summary
26412
- - series
26413
- - sources
26414
- - warnings
26415
- - collectedAt
26416
27611
  properties:
26417
- range:
26418
- $ref: '#/components/schemas/performanceTrendRange'
26419
- granularity:
27612
+ nodeId:
27613
+ type: string
27614
+ x-go-name: NodeID
27615
+ nullable: true
27616
+ nodeName:
26420
27617
  type: string
26421
- description: Controlled backend query step.
26422
- summary:
27618
+ x-go-name: NodeName
27619
+ nullable: true
27620
+ nodeDecision:
27621
+ type: string
27622
+ x-go-name: NodeDecision
27623
+ nullable: true
27624
+ deciders:
26423
27625
  type: array
26424
- description: Per-series numeric summary. changeDirection is present only when at least two points exist.
26425
27626
  items:
26426
- $ref: '#/components/schemas/performanceTrendSummary'
26427
- series:
27627
+ $ref: '#/components/schemas/elasticsearchAllocationDecider'
27628
+ x-go-name: Deciders
27629
+ elasticsearchAllocationExplanation:
27630
+ type: object
27631
+ properties:
27632
+ index:
27633
+ type: string
27634
+ x-go-name: Index
27635
+ nullable: true
27636
+ shard:
27637
+ type: integer
27638
+ x-go-name: Shard
27639
+ nullable: true
27640
+ format: int64
27641
+ primary:
27642
+ type: boolean
27643
+ x-go-name: Primary
27644
+ nullable: true
27645
+ currentState:
27646
+ type: string
27647
+ x-go-name: CurrentState
27648
+ nullable: true
27649
+ currentNode:
27650
+ $ref: '#/components/schemas/elasticsearchShardNode'
27651
+ x-go-name: CurrentNode
27652
+ unassignedInfo:
27653
+ $ref: '#/components/schemas/elasticsearchUnassignedInfo'
27654
+ x-go-name: UnassignedInfo
27655
+ canAllocate:
27656
+ type: string
27657
+ x-go-name: CanAllocate
27658
+ nullable: true
27659
+ allocateExplanation:
27660
+ type: string
27661
+ x-go-name: AllocateExplanation
27662
+ nullable: true
27663
+ canRemainOnCurrentNode:
27664
+ type: string
27665
+ x-go-name: CanRemainOnCurrentNode
27666
+ nullable: true
27667
+ canRemainDecisions:
26428
27668
  type: array
26429
- description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
26430
27669
  items:
26431
- $ref: '#/components/schemas/performanceTrendSeries'
26432
- sources:
27670
+ $ref: '#/components/schemas/elasticsearchAllocationDecider'
27671
+ x-go-name: CanRemainDecisions
27672
+ canRebalanceCluster:
27673
+ type: string
27674
+ x-go-name: CanRebalanceCluster
27675
+ nullable: true
27676
+ canRebalanceClusterDecisions:
26433
27677
  type: array
26434
- description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
26435
27678
  items:
26436
- $ref: '#/components/schemas/performanceTrendSource'
26437
- warnings:
27679
+ $ref: '#/components/schemas/elasticsearchAllocationDecider'
27680
+ x-go-name: CanRebalanceClusterDecisions
27681
+ canRebalanceToOtherNode:
27682
+ type: string
27683
+ x-go-name: CanRebalanceToOtherNode
27684
+ nullable: true
27685
+ rebalanceExplanation:
27686
+ type: string
27687
+ x-go-name: RebalanceExplanation
27688
+ nullable: true
27689
+ nodeAllocationDecisions:
26438
27690
  type: array
26439
27691
  items:
26440
- type: string
26441
- collectedAt:
26442
- type: string
26443
- description: Backend collection timestamp in UTC.
27692
+ $ref: '#/components/schemas/elasticsearchNodeAllocationDecision'
27693
+ x-go-name: NodeAllocationDecisions
26444
27694
  postgresqlLockRow:
26445
27695
  type: object
26446
27696
  required:
@@ -31708,581 +32958,257 @@ components:
31708
32958
  description: Timeout duration for the task in seconds
31709
32959
  operator:
31710
32960
  type: string
31711
- description: The user created the task
31712
- x-nullable: true
31713
- resourceType:
31714
- type: string
31715
- description: Resource type of the task, e.g. "cluster", "environment", etc.
31716
- resourceId:
31717
- type: string
31718
- description: Resource ID of the task
31719
- resourceName:
31720
- type: string
31721
- description: Resource name of the task
31722
- orgName:
31723
- type: string
31724
- description: Organization name of the task
31725
- scheduled:
31726
- $ref: '#/components/schemas/taskSchedule'
31727
- description: Scheduled execution configuration
31728
- x-nullable: true
31729
- datasource:
31730
- required:
31731
- - type
31732
- type: object
31733
- properties:
31734
- id:
31735
- type: string
31736
- description: the id of datasource
31737
- name:
31738
- type: string
31739
- description: the name of datasource
31740
- type:
31741
- type: string
31742
- description: the database type
31743
- options:
31744
- additionalProperties:
31745
- type: object
31746
- type: object
31747
- datasourceList:
31748
- items:
31749
- $ref: '#/components/schemas/datasource'
31750
- type: array
31751
- testConnectResponse:
31752
- type: object
31753
- properties:
31754
- ok:
31755
- type: boolean
31756
- description: whether the datasource connection test passed
31757
- message:
31758
- type: string
31759
- description: diagnostic message returned by DMS
31760
- extraInfo:
31761
- type: object
31762
- description: additional diagnostics returned by DMS
31763
- additionalProperties: true
31764
- DmsQueryBaseRequest:
31765
- type: object
31766
- properties:
31767
- database:
31768
- type: string
31769
- description: the database of the table or view
31770
- default: ''
31771
- query:
31772
- type: string
31773
- description: the sql string
31774
- limit:
31775
- type: integer
31776
- description: return limited number of data
31777
- default: 200
31778
- DmsQueryRequest:
31779
- type: object
31780
- allOf:
31781
- - $ref: '#/components/schemas/DmsQueryBaseRequest'
31782
- - type: object
31783
- properties:
31784
- noRecord:
31785
- type: boolean
31786
- description: if noRecord is true, the query(s) will not be added to query history
31787
- nullable: true
31788
- DmsExportRequest:
31789
- type: object
31790
- allOf:
31791
- - $ref: '#/components/schemas/DmsQueryBaseRequest'
31792
- - type: object
31793
- properties:
31794
- format:
31795
- type: string
31796
- description: the file format for export data
31797
- DmsImportRequest:
31798
- description: the data of the import task
31799
- type: object
31800
- required:
31801
- - fileType
31802
- - tableName
31803
- - database
31804
- properties:
31805
- firstLineColumn:
31806
- type: boolean
31807
- description: whether the first line of the file is column name
31808
- default: true
31809
- fieldsTerminalBy:
31810
- type: string
31811
- description: the delimiter of fields
31812
- default: ','
31813
- fieldNames:
31814
- type: array
31815
- description: the field names
31816
- items:
31817
- type: string
31818
- nullable: true
31819
- ignoreForeignKey:
31820
- type: boolean
31821
- description: whether ignore foreign key when import data or not
31822
- default: false
31823
- fileType:
31824
- type: string
31825
- file:
31826
- type: string
31827
- format: binary
31828
- description: the data file, csv or other format
31829
- tableName:
31830
- type: string
31831
- description: the target table name
31832
- database:
31833
- type: string
31834
- description: the database of the specific table, required for the engine which don't need to specify database when create database, such as mysql
31835
- skipNull:
31836
- type: boolean
31837
- description: whether skip the row which has null value when import data
31838
- default: true
31839
- DmsImportFormData:
31840
- description: the data of the import task
31841
- type: object
31842
- required:
31843
- - file
31844
- properties:
31845
- file:
31846
- type: string
31847
- format: binary
31848
- description: the data file, csv or other format
31849
- DmsTaskInfo:
31850
- type: object
31851
- properties:
31852
- id:
31853
- type: string
31854
- description: task id
31855
- datasource:
31856
- type: string
31857
- description: datasource id
31858
- message:
31859
- type: string
31860
- description: if task failed, this will show why
31861
- nullable: true
31862
- status:
31863
- type: string
31864
- description: task status
31865
- type:
31866
- type: string
31867
- description: task type
31868
- updatedAt:
31869
- type: string
31870
- format: date-time
31871
- createdAt:
31872
- type: string
31873
- format: date-time
31874
- DmsTaskList:
31875
- type: object
31876
- properties:
31877
- tasks:
31878
- type: array
31879
- items:
31880
- $ref: '#/components/schemas/DmsTaskInfo'
31881
- DmsSchemaList:
31882
- type: array
31883
- items:
31884
- type: string
31885
- DmsObject:
31886
- type: object
31887
- x-nullable: true
31888
- properties:
31889
- type:
31890
- type: string
31891
- description: Type is the type of db object, like 'Table', 'Views', 'Functions'
31892
- count:
31893
- type: integer
31894
- format: int64
31895
- description: Count is the number of each object
31896
- DmsObjectList:
31897
- type: array
31898
- items:
31899
- $ref: '#/components/schemas/DmsObject'
31900
- DmsObjectNameList:
31901
- type: array
31902
- items:
31903
- type: string
31904
- DmsObjectResponse:
31905
- type: object
31906
- properties:
31907
- data:
31908
- type: object
31909
- description: The data of the Object
31910
- additionalProperties: true
31911
- type:
31912
- type: string
31913
- description: The type of the Object
31914
- DmsQueryHistory:
31915
- type: object
31916
- properties:
31917
- engine:
31918
- title: Engine
31919
- type: string
31920
- x-nullable: true
31921
- description: datasource engine
31922
- sql:
31923
- title: SQL
31924
- type: string
32961
+ description: The user created the task
31925
32962
  x-nullable: true
31926
- description: user input text
31927
- errMassage:
31928
- title: errMassage
32963
+ resourceType:
31929
32964
  type: string
31930
- x-nullable: true
31931
- description: execution message
31932
- createdAt:
31933
- title: time
32965
+ description: Resource type of the task, e.g. "cluster", "environment", etc.
32966
+ resourceId:
31934
32967
  type: string
31935
- format: date-time
31936
- x-go-type: time.Time
31937
- description: executed time
31938
- duration:
31939
- title: duration
31940
- type: integer
31941
- format: int64
32968
+ description: Resource ID of the task
32969
+ resourceName:
32970
+ type: string
32971
+ description: Resource name of the task
32972
+ orgName:
32973
+ type: string
32974
+ description: Organization name of the task
32975
+ scheduled:
32976
+ $ref: '#/components/schemas/taskSchedule'
32977
+ description: Scheduled execution configuration
31942
32978
  x-nullable: true
31943
- description: execution duration
31944
- DmsQueryHistoryList:
31945
- type: array
31946
- items:
31947
- $ref: '#/components/schemas/DmsQueryHistory'
31948
- DmsVisualExplainRequest:
32979
+ datasource:
32980
+ required:
32981
+ - type
31949
32982
  type: object
31950
32983
  properties:
31951
- query:
32984
+ id:
31952
32985
  type: string
31953
- description: the sql string
31954
- database:
32986
+ description: the id of datasource
32987
+ name:
31955
32988
  type: string
31956
- description: the database for explaining the SQL
31957
- default: ''
31958
- analyze:
31959
- type: boolean
31960
- description: whether to run an actual/analyze plan when the engine supports it
31961
- default: false
31962
- DmsExecutionPlanMode:
31963
- type: string
31964
- enum:
31965
- - estimate
31966
- - analyze
31967
- - actual
31968
- - autotrace
31969
- DmsExecutionPlanRawFormat:
31970
- type: string
31971
- enum:
31972
- - json
31973
- - xml
31974
- - text
31975
- - table
31976
- DmsExecutionPlanNodeCategory:
31977
- type: string
31978
- enum:
31979
- - result
31980
- - sort
31981
- - join
31982
- - table_scan
31983
- - index_scan
31984
- - lookup
31985
- - materialize
31986
- - aggregate
31987
- - exchange
31988
- - modify
31989
- - other
31990
- DmsExecutionPlanNodeCost:
31991
- type: object
31992
- properties:
31993
- startup:
31994
- type: number
31995
- format: double
31996
- nullable: true
31997
- x-omitempty: true
31998
- total:
31999
- type: number
32000
- format: double
32001
- nullable: true
32002
- x-omitempty: true
32003
- self:
32004
- type: number
32005
- format: double
32006
- nullable: true
32007
- x-omitempty: true
32008
- percent:
32009
- type: number
32010
- format: double
32011
- nullable: true
32012
- x-omitempty: true
32013
- DmsExecutionPlanNodeRows:
32014
- type: object
32015
- properties:
32016
- estimated:
32017
- type: number
32018
- format: double
32019
- nullable: true
32020
- x-omitempty: true
32021
- actual:
32022
- type: number
32023
- format: double
32024
- nullable: true
32025
- x-omitempty: true
32026
- actualPerLoop:
32027
- type: number
32028
- format: double
32029
- nullable: true
32030
- x-omitempty: true
32031
- removedByFilter:
32032
- type: number
32033
- format: double
32034
- nullable: true
32035
- x-omitempty: true
32036
- mismatchRatio:
32037
- type: number
32038
- format: double
32039
- nullable: true
32040
- x-omitempty: true
32041
- DmsExecutionPlanNodeTiming:
32989
+ description: the name of datasource
32990
+ type:
32991
+ type: string
32992
+ description: the database type
32993
+ options:
32994
+ additionalProperties:
32995
+ type: object
32996
+ type: object
32997
+ datasourceList:
32998
+ items:
32999
+ $ref: '#/components/schemas/datasource'
33000
+ type: array
33001
+ testConnectResponse:
32042
33002
  type: object
32043
33003
  properties:
32044
- startupMs:
32045
- type: number
32046
- format: double
32047
- nullable: true
32048
- x-omitempty: true
32049
- totalMs:
32050
- type: number
32051
- format: double
32052
- nullable: true
32053
- x-omitempty: true
32054
- selfMs:
32055
- type: number
32056
- format: double
32057
- nullable: true
32058
- x-omitempty: true
32059
- loops:
32060
- type: number
32061
- format: double
32062
- nullable: true
32063
- x-omitempty: true
32064
- DmsExecutionPlanNodeConditions:
33004
+ ok:
33005
+ type: boolean
33006
+ description: whether the datasource connection test passed
33007
+ message:
33008
+ type: string
33009
+ description: diagnostic message returned by DMS
33010
+ extraInfo:
33011
+ type: object
33012
+ description: additional diagnostics returned by DMS
33013
+ additionalProperties: true
33014
+ DmsQueryBaseRequest:
32065
33015
  type: object
32066
33016
  properties:
32067
- filter:
32068
- type: string
32069
- nullable: true
32070
- x-omitempty: true
32071
- indexCond:
32072
- type: string
32073
- nullable: true
32074
- x-omitempty: true
32075
- joinCond:
33017
+ database:
32076
33018
  type: string
32077
- nullable: true
32078
- x-omitempty: true
32079
- hashCond:
33019
+ description: the database of the table or view
33020
+ default: ''
33021
+ query:
32080
33022
  type: string
32081
- nullable: true
32082
- x-omitempty: true
32083
- sortKey:
32084
- type: array
32085
- items:
32086
- type: string
32087
- DmsExecutionPlanNode:
33023
+ description: the sql string
33024
+ limit:
33025
+ type: integer
33026
+ description: return limited number of data
33027
+ default: 200
33028
+ DmsQueryRequest:
33029
+ type: object
33030
+ allOf:
33031
+ - $ref: '#/components/schemas/DmsQueryBaseRequest'
33032
+ - type: object
33033
+ properties:
33034
+ noRecord:
33035
+ type: boolean
33036
+ description: if noRecord is true, the query(s) will not be added to query history
33037
+ nullable: true
33038
+ DmsExportRequest:
33039
+ type: object
33040
+ allOf:
33041
+ - $ref: '#/components/schemas/DmsQueryBaseRequest'
33042
+ - type: object
33043
+ properties:
33044
+ format:
33045
+ type: string
33046
+ description: the file format for export data
33047
+ DmsImportRequest:
33048
+ description: the data of the import task
32088
33049
  type: object
33050
+ required:
33051
+ - fileType
33052
+ - tableName
33053
+ - database
32089
33054
  properties:
32090
- id:
33055
+ firstLineColumn:
33056
+ type: boolean
33057
+ description: whether the first line of the file is column name
33058
+ default: true
33059
+ fieldsTerminalBy:
32091
33060
  type: string
32092
- parentIds:
32093
- type: array
32094
- items:
32095
- type: string
32096
- childIds:
33061
+ description: the delimiter of fields
33062
+ default: ','
33063
+ fieldNames:
32097
33064
  type: array
33065
+ description: the field names
32098
33066
  items:
32099
33067
  type: string
32100
- order:
32101
- type: integer
32102
- format: int64
32103
33068
  nullable: true
32104
- x-omitempty: true
32105
- category:
32106
- $ref: '#/components/schemas/DmsExecutionPlanNodeCategory'
32107
- nodeType:
32108
- type: string
32109
- label:
32110
- type: string
32111
- relationName:
33069
+ ignoreForeignKey:
33070
+ type: boolean
33071
+ description: whether ignore foreign key when import data or not
33072
+ default: false
33073
+ fileType:
32112
33074
  type: string
32113
- nullable: true
32114
- x-omitempty: true
32115
- schemaName:
33075
+ file:
32116
33076
  type: string
32117
- nullable: true
32118
- x-omitempty: true
32119
- alias:
33077
+ format: binary
33078
+ description: the data file, csv or other format
33079
+ tableName:
32120
33080
  type: string
32121
- nullable: true
32122
- x-omitempty: true
32123
- indexName:
33081
+ description: the target table name
33082
+ database:
32124
33083
  type: string
32125
- nullable: true
32126
- x-omitempty: true
32127
- cost:
32128
- $ref: '#/components/schemas/DmsExecutionPlanNodeCost'
32129
- nullable: true
32130
- x-omitempty: true
32131
- rows:
32132
- $ref: '#/components/schemas/DmsExecutionPlanNodeRows'
32133
- nullable: true
32134
- x-omitempty: true
32135
- timing:
32136
- $ref: '#/components/schemas/DmsExecutionPlanNodeTiming'
32137
- nullable: true
32138
- x-omitempty: true
32139
- conditions:
32140
- $ref: '#/components/schemas/DmsExecutionPlanNodeConditions'
32141
- nullable: true
32142
- x-omitempty: true
32143
- details:
32144
- type: object
32145
- additionalProperties: true
32146
- x-omitempty: true
32147
- DmsExecutionPlanEdgeRows:
33084
+ description: the database of the specific table, required for the engine which don't need to specify database when create database, such as mysql
33085
+ skipNull:
33086
+ type: boolean
33087
+ description: whether skip the row which has null value when import data
33088
+ default: true
33089
+ DmsImportFormData:
33090
+ description: the data of the import task
32148
33091
  type: object
33092
+ required:
33093
+ - file
32149
33094
  properties:
32150
- estimated:
32151
- type: number
32152
- format: double
32153
- nullable: true
32154
- x-omitempty: true
32155
- actual:
32156
- type: number
32157
- format: double
32158
- nullable: true
32159
- x-omitempty: true
32160
- DmsExecutionPlanEdge:
33095
+ file:
33096
+ type: string
33097
+ format: binary
33098
+ description: the data file, csv or other format
33099
+ DmsTaskInfo:
32161
33100
  type: object
32162
33101
  properties:
32163
33102
  id:
32164
33103
  type: string
32165
- source:
33104
+ description: task id
33105
+ datasource:
32166
33106
  type: string
32167
- target:
33107
+ description: datasource id
33108
+ message:
32168
33109
  type: string
32169
- rows:
32170
- $ref: '#/components/schemas/DmsExecutionPlanEdgeRows'
32171
- nullable: true
32172
- x-omitempty: true
32173
- widthWeight:
32174
- type: number
32175
- format: double
33110
+ description: if task failed, this will show why
32176
33111
  nullable: true
32177
- x-omitempty: true
32178
- label:
33112
+ status:
32179
33113
  type: string
32180
- nullable: true
32181
- x-omitempty: true
32182
- DmsExecutionPlanSummary:
33114
+ description: task status
33115
+ type:
33116
+ type: string
33117
+ description: task type
33118
+ updatedAt:
33119
+ type: string
33120
+ format: date-time
33121
+ createdAt:
33122
+ type: string
33123
+ format: date-time
33124
+ DmsTaskList:
32183
33125
  type: object
32184
33126
  properties:
32185
- totalCost:
32186
- type: number
32187
- format: double
32188
- nullable: true
32189
- x-omitempty: true
32190
- totalActualTimeMs:
32191
- type: number
32192
- format: double
32193
- nullable: true
32194
- x-omitempty: true
32195
- planRows:
32196
- type: number
32197
- format: double
32198
- nullable: true
32199
- x-omitempty: true
32200
- actualRows:
32201
- type: number
32202
- format: double
32203
- nullable: true
32204
- x-omitempty: true
32205
- nodeCount:
33127
+ tasks:
33128
+ type: array
33129
+ items:
33130
+ $ref: '#/components/schemas/DmsTaskInfo'
33131
+ DmsSchemaList:
33132
+ type: array
33133
+ items:
33134
+ type: string
33135
+ DmsObject:
33136
+ type: object
33137
+ x-nullable: true
33138
+ properties:
33139
+ type:
33140
+ type: string
33141
+ description: Type is the type of db object, like 'Table', 'Views', 'Functions'
33142
+ count:
32206
33143
  type: integer
32207
33144
  format: int64
32208
- maxCostNodeId:
32209
- type: string
32210
- nullable: true
32211
- x-omitempty: true
32212
- maxRowsNodeId:
32213
- type: string
32214
- nullable: true
32215
- x-omitempty: true
32216
- maxTimeNodeId:
33145
+ description: Count is the number of each object
33146
+ DmsObjectList:
33147
+ type: array
33148
+ items:
33149
+ $ref: '#/components/schemas/DmsObject'
33150
+ DmsObjectNameList:
33151
+ type: array
33152
+ items:
33153
+ type: string
33154
+ DmsObjectResponse:
33155
+ type: object
33156
+ properties:
33157
+ data:
33158
+ type: object
33159
+ description: The data of the Object
33160
+ additionalProperties: true
33161
+ type:
32217
33162
  type: string
32218
- nullable: true
32219
- x-omitempty: true
32220
- DmsExecutionPlanWarningSeverity:
32221
- type: string
32222
- enum:
32223
- - info
32224
- - warning
32225
- - critical
32226
- DmsExecutionPlanWarning:
33163
+ description: The type of the Object
33164
+ DmsQueryHistory:
32227
33165
  type: object
32228
33166
  properties:
32229
- code:
33167
+ engine:
33168
+ title: Engine
32230
33169
  type: string
32231
- severity:
32232
- $ref: '#/components/schemas/DmsExecutionPlanWarningSeverity'
32233
- nodeId:
33170
+ x-nullable: true
33171
+ description: datasource engine
33172
+ sql:
33173
+ title: SQL
32234
33174
  type: string
32235
- nullable: true
32236
- x-omitempty: true
32237
- message:
33175
+ x-nullable: true
33176
+ description: user input text
33177
+ errMassage:
33178
+ title: errMassage
32238
33179
  type: string
32239
- DmsExecutionPlanResult:
33180
+ x-nullable: true
33181
+ description: execution message
33182
+ createdAt:
33183
+ title: time
33184
+ type: string
33185
+ format: date-time
33186
+ x-go-type: time.Time
33187
+ description: executed time
33188
+ duration:
33189
+ title: duration
33190
+ type: integer
33191
+ format: int64
33192
+ x-nullable: true
33193
+ description: execution duration
33194
+ DmsQueryHistoryList:
33195
+ type: array
33196
+ items:
33197
+ $ref: '#/components/schemas/DmsQueryHistory'
33198
+ DmsVisualExplainRequest:
32240
33199
  type: object
32241
33200
  properties:
32242
- originSQL:
32243
- type: string
32244
- explainSQL:
33201
+ query:
32245
33202
  type: string
32246
- nullable: true
32247
- x-omitempty: true
32248
- engineType:
33203
+ description: the sql string
33204
+ database:
32249
33205
  type: string
32250
- mode:
32251
- $ref: '#/components/schemas/DmsExecutionPlanMode'
32252
- hasActualStats:
33206
+ description: the database for explaining the SQL
33207
+ default: ''
33208
+ analyze:
32253
33209
  type: boolean
32254
- x-omitempty: false
32255
- rawFormat:
32256
- $ref: '#/components/schemas/DmsExecutionPlanRawFormat'
32257
- rawPlan:
32258
- type: object
32259
- description: Engine-native raw plan payload exposed for fallback display. SDKs model it as a free-form JSON object.
32260
- additionalProperties: true
32261
- x-omitempty: true
32262
- rootNodeIds:
32263
- type: array
32264
- items:
32265
- type: string
32266
- nodes:
32267
- type: array
32268
- items:
32269
- $ref: '#/components/schemas/DmsExecutionPlanNode'
32270
- edges:
32271
- type: array
32272
- items:
32273
- $ref: '#/components/schemas/DmsExecutionPlanEdge'
32274
- summary:
32275
- $ref: '#/components/schemas/DmsExecutionPlanSummary'
32276
- nullable: true
32277
- x-omitempty: true
32278
- warnings:
32279
- type: array
32280
- items:
32281
- $ref: '#/components/schemas/DmsExecutionPlanWarning'
32282
- fallbackTable:
32283
- $ref: '#/components/schemas/DmsQueryResponse'
32284
- nullable: true
32285
- x-omitempty: true
33210
+ description: whether to run an actual/analyze plan when the engine supports it
33211
+ default: false
32286
33212
  DmsGenerateDdlOperationType:
32287
33213
  type: string
32288
33214
  description: operation type