kb-cloud-client-typescript 2.4.0-alpha.123 → 2.4.0-alpha.124

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 (225) hide show
  1. package/dist/adminapi/apis/diagnostics-api.d.ts +423 -0
  2. package/dist/adminapi/apis/diagnostics-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/diagnostics-api.js +435 -0
  4. package/dist/adminapi/apis/diagnostics-api.js.map +1 -1
  5. package/dist/adminapi/models/clickhouse-cluster-health-summary.d.ts +91 -0
  6. package/dist/adminapi/models/clickhouse-cluster-health-summary.d.ts.map +1 -0
  7. package/dist/adminapi/models/clickhouse-cluster-health-summary.js +16 -0
  8. package/dist/adminapi/models/clickhouse-cluster-health-summary.js.map +1 -0
  9. package/dist/adminapi/models/clickhouse-cluster-health.d.ts +71 -0
  10. package/dist/adminapi/models/clickhouse-cluster-health.d.ts.map +1 -0
  11. package/dist/adminapi/models/clickhouse-cluster-health.js +16 -0
  12. package/dist/adminapi/models/clickhouse-cluster-health.js.map +1 -0
  13. package/dist/adminapi/models/clickhouse-cluster-node.d.ts +109 -0
  14. package/dist/adminapi/models/clickhouse-cluster-node.d.ts.map +1 -0
  15. package/dist/adminapi/models/clickhouse-cluster-node.js +16 -0
  16. package/dist/adminapi/models/clickhouse-cluster-node.js.map +1 -0
  17. package/dist/adminapi/models/clickhouse-disk-usage.d.ts +61 -0
  18. package/dist/adminapi/models/clickhouse-disk-usage.d.ts.map +1 -0
  19. package/dist/adminapi/models/clickhouse-disk-usage.js +16 -0
  20. package/dist/adminapi/models/clickhouse-disk-usage.js.map +1 -0
  21. package/dist/adminapi/models/clickhouse-failed-query.d.ts +85 -0
  22. package/dist/adminapi/models/clickhouse-failed-query.d.ts.map +1 -0
  23. package/dist/adminapi/models/clickhouse-failed-query.js +16 -0
  24. package/dist/adminapi/models/clickhouse-failed-query.js.map +1 -0
  25. package/dist/adminapi/models/clickhouse-merge.d.ts +97 -0
  26. package/dist/adminapi/models/clickhouse-merge.d.ts.map +1 -0
  27. package/dist/adminapi/models/clickhouse-merge.js +16 -0
  28. package/dist/adminapi/models/clickhouse-merge.js.map +1 -0
  29. package/dist/adminapi/models/clickhouse-mutation.d.ts +79 -0
  30. package/dist/adminapi/models/clickhouse-mutation.d.ts.map +1 -0
  31. package/dist/adminapi/models/clickhouse-mutation.js +16 -0
  32. package/dist/adminapi/models/clickhouse-mutation.js.map +1 -0
  33. package/dist/adminapi/models/clickhouse-partition-space.d.ts +91 -0
  34. package/dist/adminapi/models/clickhouse-partition-space.d.ts.map +1 -0
  35. package/dist/adminapi/models/clickhouse-partition-space.js +16 -0
  36. package/dist/adminapi/models/clickhouse-partition-space.js.map +1 -0
  37. package/dist/adminapi/models/clickhouse-query-pattern.d.ts +91 -0
  38. package/dist/adminapi/models/clickhouse-query-pattern.d.ts.map +1 -0
  39. package/dist/adminapi/models/clickhouse-query-pattern.js +16 -0
  40. package/dist/adminapi/models/clickhouse-query-pattern.js.map +1 -0
  41. package/dist/adminapi/models/clickhouse-replica-health.d.ts +157 -0
  42. package/dist/adminapi/models/clickhouse-replica-health.d.ts.map +1 -0
  43. package/dist/adminapi/models/clickhouse-replica-health.js +16 -0
  44. package/dist/adminapi/models/clickhouse-replica-health.js.map +1 -0
  45. package/dist/adminapi/models/clickhouse-session-list.d.ts +45 -0
  46. package/dist/adminapi/models/clickhouse-session-list.d.ts.map +1 -0
  47. package/dist/adminapi/models/clickhouse-session-list.js +16 -0
  48. package/dist/adminapi/models/clickhouse-session-list.js.map +1 -0
  49. package/dist/adminapi/models/clickhouse-session.d.ts +139 -0
  50. package/dist/adminapi/models/clickhouse-session.d.ts.map +1 -0
  51. package/dist/adminapi/models/clickhouse-session.js +16 -0
  52. package/dist/adminapi/models/clickhouse-session.js.map +1 -0
  53. package/dist/adminapi/models/clickhouse-slow-query.d.ts +139 -0
  54. package/dist/adminapi/models/clickhouse-slow-query.d.ts.map +1 -0
  55. package/dist/adminapi/models/clickhouse-slow-query.js +16 -0
  56. package/dist/adminapi/models/clickhouse-slow-query.js.map +1 -0
  57. package/dist/adminapi/models/clickhouse-source.d.ts +43 -0
  58. package/dist/adminapi/models/clickhouse-source.d.ts.map +1 -0
  59. package/dist/adminapi/models/clickhouse-source.js +16 -0
  60. package/dist/adminapi/models/clickhouse-source.js.map +1 -0
  61. package/dist/adminapi/models/clickhouse-space-analysis.d.ts +79 -0
  62. package/dist/adminapi/models/clickhouse-space-analysis.d.ts.map +1 -0
  63. package/dist/adminapi/models/clickhouse-space-analysis.js +16 -0
  64. package/dist/adminapi/models/clickhouse-space-analysis.js.map +1 -0
  65. package/dist/adminapi/models/clickhouse-space-summary.d.ts +97 -0
  66. package/dist/adminapi/models/clickhouse-space-summary.d.ts.map +1 -0
  67. package/dist/adminapi/models/clickhouse-space-summary.js +16 -0
  68. package/dist/adminapi/models/clickhouse-space-summary.js.map +1 -0
  69. package/dist/adminapi/models/clickhouse-sqlanalysis-range.d.ts +43 -0
  70. package/dist/adminapi/models/clickhouse-sqlanalysis-range.d.ts.map +1 -0
  71. package/dist/adminapi/models/clickhouse-sqlanalysis-range.js +16 -0
  72. package/dist/adminapi/models/clickhouse-sqlanalysis-range.js.map +1 -0
  73. package/dist/adminapi/models/clickhouse-sqlanalysis.d.ts +85 -0
  74. package/dist/adminapi/models/clickhouse-sqlanalysis.d.ts.map +1 -0
  75. package/dist/adminapi/models/clickhouse-sqlanalysis.js +16 -0
  76. package/dist/adminapi/models/clickhouse-sqlanalysis.js.map +1 -0
  77. package/dist/adminapi/models/clickhouse-sqlsummary.d.ts +43 -0
  78. package/dist/adminapi/models/clickhouse-sqlsummary.d.ts.map +1 -0
  79. package/dist/adminapi/models/clickhouse-sqlsummary.js +16 -0
  80. package/dist/adminapi/models/clickhouse-sqlsummary.js.map +1 -0
  81. package/dist/adminapi/models/clickhouse-table-space.d.ts +104 -0
  82. package/dist/adminapi/models/clickhouse-table-space.d.ts.map +1 -0
  83. package/dist/adminapi/models/clickhouse-table-space.js +16 -0
  84. package/dist/adminapi/models/clickhouse-table-space.js.map +1 -0
  85. package/dist/adminapi/models/index.d.ts +20 -0
  86. package/dist/adminapi/models/index.d.ts.map +1 -1
  87. package/dist/adminapi/models/index.js +20 -0
  88. package/dist/adminapi/models/index.js.map +1 -1
  89. package/dist/openapi/apis/diagnostics-api.d.ts +423 -0
  90. package/dist/openapi/apis/diagnostics-api.d.ts.map +1 -1
  91. package/dist/openapi/apis/diagnostics-api.js +435 -0
  92. package/dist/openapi/apis/diagnostics-api.js.map +1 -1
  93. package/dist/openapi/models/clickhouse-cluster-health-summary.d.ts +91 -0
  94. package/dist/openapi/models/clickhouse-cluster-health-summary.d.ts.map +1 -0
  95. package/dist/openapi/models/clickhouse-cluster-health-summary.js +16 -0
  96. package/dist/openapi/models/clickhouse-cluster-health-summary.js.map +1 -0
  97. package/dist/openapi/models/clickhouse-cluster-health.d.ts +71 -0
  98. package/dist/openapi/models/clickhouse-cluster-health.d.ts.map +1 -0
  99. package/dist/openapi/models/clickhouse-cluster-health.js +16 -0
  100. package/dist/openapi/models/clickhouse-cluster-health.js.map +1 -0
  101. package/dist/openapi/models/clickhouse-cluster-node.d.ts +109 -0
  102. package/dist/openapi/models/clickhouse-cluster-node.d.ts.map +1 -0
  103. package/dist/openapi/models/clickhouse-cluster-node.js +16 -0
  104. package/dist/openapi/models/clickhouse-cluster-node.js.map +1 -0
  105. package/dist/openapi/models/clickhouse-disk-usage.d.ts +61 -0
  106. package/dist/openapi/models/clickhouse-disk-usage.d.ts.map +1 -0
  107. package/dist/openapi/models/clickhouse-disk-usage.js +16 -0
  108. package/dist/openapi/models/clickhouse-disk-usage.js.map +1 -0
  109. package/dist/openapi/models/clickhouse-failed-query.d.ts +85 -0
  110. package/dist/openapi/models/clickhouse-failed-query.d.ts.map +1 -0
  111. package/dist/openapi/models/clickhouse-failed-query.js +16 -0
  112. package/dist/openapi/models/clickhouse-failed-query.js.map +1 -0
  113. package/dist/openapi/models/clickhouse-merge.d.ts +97 -0
  114. package/dist/openapi/models/clickhouse-merge.d.ts.map +1 -0
  115. package/dist/openapi/models/clickhouse-merge.js +16 -0
  116. package/dist/openapi/models/clickhouse-merge.js.map +1 -0
  117. package/dist/openapi/models/clickhouse-mutation.d.ts +79 -0
  118. package/dist/openapi/models/clickhouse-mutation.d.ts.map +1 -0
  119. package/dist/openapi/models/clickhouse-mutation.js +16 -0
  120. package/dist/openapi/models/clickhouse-mutation.js.map +1 -0
  121. package/dist/openapi/models/clickhouse-partition-space.d.ts +91 -0
  122. package/dist/openapi/models/clickhouse-partition-space.d.ts.map +1 -0
  123. package/dist/openapi/models/clickhouse-partition-space.js +16 -0
  124. package/dist/openapi/models/clickhouse-partition-space.js.map +1 -0
  125. package/dist/openapi/models/clickhouse-query-pattern.d.ts +91 -0
  126. package/dist/openapi/models/clickhouse-query-pattern.d.ts.map +1 -0
  127. package/dist/openapi/models/clickhouse-query-pattern.js +16 -0
  128. package/dist/openapi/models/clickhouse-query-pattern.js.map +1 -0
  129. package/dist/openapi/models/clickhouse-replica-health.d.ts +157 -0
  130. package/dist/openapi/models/clickhouse-replica-health.d.ts.map +1 -0
  131. package/dist/openapi/models/clickhouse-replica-health.js +16 -0
  132. package/dist/openapi/models/clickhouse-replica-health.js.map +1 -0
  133. package/dist/openapi/models/clickhouse-session-list.d.ts +45 -0
  134. package/dist/openapi/models/clickhouse-session-list.d.ts.map +1 -0
  135. package/dist/openapi/models/clickhouse-session-list.js +16 -0
  136. package/dist/openapi/models/clickhouse-session-list.js.map +1 -0
  137. package/dist/openapi/models/clickhouse-session.d.ts +139 -0
  138. package/dist/openapi/models/clickhouse-session.d.ts.map +1 -0
  139. package/dist/openapi/models/clickhouse-session.js +16 -0
  140. package/dist/openapi/models/clickhouse-session.js.map +1 -0
  141. package/dist/openapi/models/clickhouse-slow-query.d.ts +139 -0
  142. package/dist/openapi/models/clickhouse-slow-query.d.ts.map +1 -0
  143. package/dist/openapi/models/clickhouse-slow-query.js +16 -0
  144. package/dist/openapi/models/clickhouse-slow-query.js.map +1 -0
  145. package/dist/openapi/models/clickhouse-source.d.ts +43 -0
  146. package/dist/openapi/models/clickhouse-source.d.ts.map +1 -0
  147. package/dist/openapi/models/clickhouse-source.js +16 -0
  148. package/dist/openapi/models/clickhouse-source.js.map +1 -0
  149. package/dist/openapi/models/clickhouse-space-analysis.d.ts +79 -0
  150. package/dist/openapi/models/clickhouse-space-analysis.d.ts.map +1 -0
  151. package/dist/openapi/models/clickhouse-space-analysis.js +16 -0
  152. package/dist/openapi/models/clickhouse-space-analysis.js.map +1 -0
  153. package/dist/openapi/models/clickhouse-space-summary.d.ts +97 -0
  154. package/dist/openapi/models/clickhouse-space-summary.d.ts.map +1 -0
  155. package/dist/openapi/models/clickhouse-space-summary.js +16 -0
  156. package/dist/openapi/models/clickhouse-space-summary.js.map +1 -0
  157. package/dist/openapi/models/clickhouse-sqlanalysis-range.d.ts +43 -0
  158. package/dist/openapi/models/clickhouse-sqlanalysis-range.d.ts.map +1 -0
  159. package/dist/openapi/models/clickhouse-sqlanalysis-range.js +16 -0
  160. package/dist/openapi/models/clickhouse-sqlanalysis-range.js.map +1 -0
  161. package/dist/openapi/models/clickhouse-sqlanalysis.d.ts +85 -0
  162. package/dist/openapi/models/clickhouse-sqlanalysis.d.ts.map +1 -0
  163. package/dist/openapi/models/clickhouse-sqlanalysis.js +16 -0
  164. package/dist/openapi/models/clickhouse-sqlanalysis.js.map +1 -0
  165. package/dist/openapi/models/clickhouse-sqlsummary.d.ts +43 -0
  166. package/dist/openapi/models/clickhouse-sqlsummary.d.ts.map +1 -0
  167. package/dist/openapi/models/clickhouse-sqlsummary.js +16 -0
  168. package/dist/openapi/models/clickhouse-sqlsummary.js.map +1 -0
  169. package/dist/openapi/models/clickhouse-table-space.d.ts +104 -0
  170. package/dist/openapi/models/clickhouse-table-space.d.ts.map +1 -0
  171. package/dist/openapi/models/clickhouse-table-space.js +16 -0
  172. package/dist/openapi/models/clickhouse-table-space.js.map +1 -0
  173. package/dist/openapi/models/index.d.ts +20 -0
  174. package/dist/openapi/models/index.d.ts.map +1 -1
  175. package/dist/openapi/models/index.js +20 -0
  176. package/dist/openapi/models/index.js.map +1 -1
  177. package/package.json +1 -1
  178. package/src/adminapi/.openapi-generator/FILES +20 -0
  179. package/src/adminapi/apis/diagnostics-api.ts +746 -10
  180. package/src/adminapi/models/clickhouse-cluster-health-summary.ts +96 -0
  181. package/src/adminapi/models/clickhouse-cluster-health.ts +84 -0
  182. package/src/adminapi/models/clickhouse-cluster-node.ts +114 -0
  183. package/src/adminapi/models/clickhouse-disk-usage.ts +66 -0
  184. package/src/adminapi/models/clickhouse-failed-query.ts +90 -0
  185. package/src/adminapi/models/clickhouse-merge.ts +102 -0
  186. package/src/adminapi/models/clickhouse-mutation.ts +84 -0
  187. package/src/adminapi/models/clickhouse-partition-space.ts +96 -0
  188. package/src/adminapi/models/clickhouse-query-pattern.ts +96 -0
  189. package/src/adminapi/models/clickhouse-replica-health.ts +162 -0
  190. package/src/adminapi/models/clickhouse-session-list.ts +54 -0
  191. package/src/adminapi/models/clickhouse-session.ts +144 -0
  192. package/src/adminapi/models/clickhouse-slow-query.ts +144 -0
  193. package/src/adminapi/models/clickhouse-source.ts +48 -0
  194. package/src/adminapi/models/clickhouse-space-analysis.ts +96 -0
  195. package/src/adminapi/models/clickhouse-space-summary.ts +102 -0
  196. package/src/adminapi/models/clickhouse-sqlanalysis-range.ts +48 -0
  197. package/src/adminapi/models/clickhouse-sqlanalysis.ts +102 -0
  198. package/src/adminapi/models/clickhouse-sqlsummary.ts +48 -0
  199. package/src/adminapi/models/clickhouse-table-space.ts +111 -0
  200. package/src/adminapi/models/index.ts +20 -0
  201. package/src/adminapi.yaml +1158 -0
  202. package/src/openapi/.openapi-generator/FILES +20 -0
  203. package/src/openapi/apis/diagnostics-api.ts +746 -10
  204. package/src/openapi/models/clickhouse-cluster-health-summary.ts +96 -0
  205. package/src/openapi/models/clickhouse-cluster-health.ts +84 -0
  206. package/src/openapi/models/clickhouse-cluster-node.ts +114 -0
  207. package/src/openapi/models/clickhouse-disk-usage.ts +66 -0
  208. package/src/openapi/models/clickhouse-failed-query.ts +90 -0
  209. package/src/openapi/models/clickhouse-merge.ts +102 -0
  210. package/src/openapi/models/clickhouse-mutation.ts +84 -0
  211. package/src/openapi/models/clickhouse-partition-space.ts +96 -0
  212. package/src/openapi/models/clickhouse-query-pattern.ts +96 -0
  213. package/src/openapi/models/clickhouse-replica-health.ts +162 -0
  214. package/src/openapi/models/clickhouse-session-list.ts +54 -0
  215. package/src/openapi/models/clickhouse-session.ts +144 -0
  216. package/src/openapi/models/clickhouse-slow-query.ts +144 -0
  217. package/src/openapi/models/clickhouse-source.ts +48 -0
  218. package/src/openapi/models/clickhouse-space-analysis.ts +96 -0
  219. package/src/openapi/models/clickhouse-space-summary.ts +102 -0
  220. package/src/openapi/models/clickhouse-sqlanalysis-range.ts +48 -0
  221. package/src/openapi/models/clickhouse-sqlanalysis.ts +102 -0
  222. package/src/openapi/models/clickhouse-sqlsummary.ts +48 -0
  223. package/src/openapi/models/clickhouse-table-space.ts +111 -0
  224. package/src/openapi/models/index.ts +20 -0
  225. package/src/openapi.yaml +1158 -0
package/src/adminapi.yaml CHANGED
@@ -27692,6 +27692,270 @@ paths:
27692
27692
  $ref: '#/components/responses/404'
27693
27693
  '500':
27694
27694
  $ref: '#/components/responses/500'
27695
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sessions:
27696
+ get:
27697
+ tags:
27698
+ - diagnostics
27699
+ summary: List active ClickHouse queries
27700
+ description: List active queries from system.processes across every shard and replica via clusterAllReplicas. Returns elapsed time, current and peak memory usage, read/write progress and the server host for each query so long-running or memory-heavy queries can be located quickly. The diagnostics query itself is excluded from the result.
27701
+ operationId: listDiagnosticsClickhouseSessions
27702
+ parameters:
27703
+ - name: orgName
27704
+ in: path
27705
+ description: Organization name
27706
+ required: true
27707
+ schema:
27708
+ type: string
27709
+ - name: clusterName
27710
+ in: path
27711
+ description: Cluster name
27712
+ required: true
27713
+ schema:
27714
+ type: string
27715
+ - name: limit
27716
+ in: query
27717
+ description: Maximum number of queries to return. Defaults to 100 and is capped at 1000.
27718
+ required: false
27719
+ schema:
27720
+ type: integer
27721
+ format: int64
27722
+ - name: orderBy
27723
+ in: query
27724
+ description: 'Sort metric. Defaults to elapsed. Allowed values: elapsed, memoryUsage, memoryUsageRatio, peakMemoryUsage, readRows, readBytes.'
27725
+ required: false
27726
+ schema:
27727
+ type: string
27728
+ - name: database
27729
+ in: query
27730
+ description: Filter by current database. Omit or empty = all databases.
27731
+ required: false
27732
+ schema:
27733
+ type: string
27734
+ responses:
27735
+ '200':
27736
+ description: OK
27737
+ content:
27738
+ application/json:
27739
+ schema:
27740
+ $ref: '#/components/schemas/clickhouseSessionList'
27741
+ '400':
27742
+ $ref: '#/components/responses/400'
27743
+ '401':
27744
+ $ref: '#/components/responses/401'
27745
+ '403':
27746
+ $ref: '#/components/responses/403'
27747
+ '404':
27748
+ $ref: '#/components/responses/404'
27749
+ '500':
27750
+ $ref: '#/components/responses/500'
27751
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sessions/{queryId}:
27752
+ delete:
27753
+ tags:
27754
+ - diagnostics
27755
+ summary: Kill a ClickHouse query
27756
+ description: Terminate a running query by query_id. In cluster mode KILL QUERY ON CLUSTER is used so the initial query and its remote sub-queries are terminated together; otherwise KILL QUERY runs on the connected node.
27757
+ operationId: killDiagnosticsClickhouseQuery
27758
+ parameters:
27759
+ - name: orgName
27760
+ in: path
27761
+ description: Organization name
27762
+ required: true
27763
+ schema:
27764
+ type: string
27765
+ - name: clusterName
27766
+ in: path
27767
+ description: Cluster name
27768
+ required: true
27769
+ schema:
27770
+ type: string
27771
+ - name: queryId
27772
+ in: path
27773
+ description: ClickHouse query_id to terminate.
27774
+ required: true
27775
+ schema:
27776
+ type: string
27777
+ responses:
27778
+ '204':
27779
+ description: Query killed successfully.
27780
+ '400':
27781
+ $ref: '#/components/responses/400'
27782
+ '401':
27783
+ $ref: '#/components/responses/401'
27784
+ '403':
27785
+ $ref: '#/components/responses/403'
27786
+ '404':
27787
+ $ref: '#/components/responses/404'
27788
+ '500':
27789
+ $ref: '#/components/responses/500'
27790
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/sqlAnalysis:
27791
+ get:
27792
+ tags:
27793
+ - diagnostics
27794
+ summary: Get ClickHouse SQL analysis
27795
+ description: Analyze system.query_log for the selected range. Only initial queries (is_initial_query = 1) are counted so distributed child queries are not double counted. Returns the slowest queries by query_duration_ms, query patterns grouped by normalized_query_hash, and failed queries (ExceptionWhileProcessing) with exception_code. When log_queries is disabled or system.query_log is missing, the endpoint returns status=unavailable together with guidance instead of failing.
27796
+ operationId: getDiagnosticsClickhouseSQLAnalysis
27797
+ parameters:
27798
+ - name: orgName
27799
+ in: path
27800
+ description: Organization name
27801
+ required: true
27802
+ schema:
27803
+ type: string
27804
+ - name: clusterName
27805
+ in: path
27806
+ description: Cluster name
27807
+ required: true
27808
+ schema:
27809
+ type: string
27810
+ - name: range
27811
+ in: query
27812
+ description: 'Time range based on query_log event_time. Defaults to 24h. Allowed values: 1h, 6h, 24h, 7d.'
27813
+ required: false
27814
+ schema:
27815
+ type: string
27816
+ - name: limit
27817
+ in: query
27818
+ description: Maximum number of entries per list. Defaults to 20 and is capped at 200.
27819
+ required: false
27820
+ schema:
27821
+ type: integer
27822
+ format: int64
27823
+ - name: orderBy
27824
+ in: query
27825
+ description: 'Pattern ordering metric. Defaults to totalDuration. Allowed values: totalDuration, meanDuration, maxDuration, calls, memory, readRows, failures.'
27826
+ required: false
27827
+ schema:
27828
+ type: string
27829
+ - name: database
27830
+ in: query
27831
+ description: Filter by current_database. Omit or empty = all databases.
27832
+ required: false
27833
+ schema:
27834
+ type: string
27835
+ - name: user
27836
+ in: query
27837
+ description: Filter by ClickHouse user. Omit or empty = all users.
27838
+ required: false
27839
+ schema:
27840
+ type: string
27841
+ responses:
27842
+ '200':
27843
+ description: OK
27844
+ content:
27845
+ application/json:
27846
+ schema:
27847
+ $ref: '#/components/schemas/clickhouseSQLAnalysis'
27848
+ '400':
27849
+ $ref: '#/components/responses/400'
27850
+ '401':
27851
+ $ref: '#/components/responses/401'
27852
+ '403':
27853
+ $ref: '#/components/responses/403'
27854
+ '404':
27855
+ $ref: '#/components/responses/404'
27856
+ '500':
27857
+ $ref: '#/components/responses/500'
27858
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/spaceAnalysis:
27859
+ get:
27860
+ tags:
27861
+ - diagnostics
27862
+ summary: Get ClickHouse space analysis
27863
+ description: Analyze system.parts, system.merges and system.mutations across the cluster. Returns table and partition level disk usage, compression efficiency, per-disk and per-host distribution, part explosion risk (parts_to_delay_insert / parts_to_throw_insert), running merges and unfinished mutations.
27864
+ operationId: getDiagnosticsClickhouseSpaceAnalysis
27865
+ parameters:
27866
+ - name: orgName
27867
+ in: path
27868
+ description: Organization name
27869
+ required: true
27870
+ schema:
27871
+ type: string
27872
+ - name: clusterName
27873
+ in: path
27874
+ description: Cluster name
27875
+ required: true
27876
+ schema:
27877
+ type: string
27878
+ - name: database
27879
+ in: query
27880
+ description: Filter by database. Omit or empty = all databases.
27881
+ required: false
27882
+ schema:
27883
+ type: string
27884
+ - name: tableLimit
27885
+ in: query
27886
+ description: Maximum number of top tables. Defaults to 20 and is capped at 200.
27887
+ required: false
27888
+ schema:
27889
+ type: integer
27890
+ format: int64
27891
+ - name: partitionLimit
27892
+ in: query
27893
+ description: Maximum number of top partitions. Defaults to 20 and is capped at 200.
27894
+ required: false
27895
+ schema:
27896
+ type: integer
27897
+ format: int64
27898
+ - name: mergeLimit
27899
+ in: query
27900
+ description: Maximum number of merges and unfinished mutations. Defaults to 20 and is capped at 200.
27901
+ required: false
27902
+ schema:
27903
+ type: integer
27904
+ format: int64
27905
+ responses:
27906
+ '200':
27907
+ description: OK
27908
+ content:
27909
+ application/json:
27910
+ schema:
27911
+ $ref: '#/components/schemas/clickhouseSpaceAnalysis'
27912
+ '400':
27913
+ $ref: '#/components/responses/400'
27914
+ '401':
27915
+ $ref: '#/components/responses/401'
27916
+ '403':
27917
+ $ref: '#/components/responses/403'
27918
+ '404':
27919
+ $ref: '#/components/responses/404'
27920
+ '500':
27921
+ $ref: '#/components/responses/500'
27922
+ /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/clickhouse/clusterHealth:
27923
+ get:
27924
+ tags:
27925
+ - diagnostics
27926
+ summary: Get ClickHouse replica and cluster health
27927
+ description: Analyze system.replicas and system.clusters. Returns replication delay, Keeper queue backlog, readonly/session-expired replicas and shard/replica topology with per-node connection errors. Replica rows are collected through clusterAllReplicas, while the topology is read from the connected node's system.clusters view.
27928
+ operationId: getDiagnosticsClickhouseClusterHealth
27929
+ parameters:
27930
+ - name: orgName
27931
+ in: path
27932
+ description: Organization name
27933
+ required: true
27934
+ schema:
27935
+ type: string
27936
+ - name: clusterName
27937
+ in: path
27938
+ description: Cluster name
27939
+ required: true
27940
+ schema:
27941
+ type: string
27942
+ responses:
27943
+ '200':
27944
+ description: OK
27945
+ content:
27946
+ application/json:
27947
+ schema:
27948
+ $ref: '#/components/schemas/clickhouseClusterHealth'
27949
+ '400':
27950
+ $ref: '#/components/responses/400'
27951
+ '401':
27952
+ $ref: '#/components/responses/401'
27953
+ '403':
27954
+ $ref: '#/components/responses/403'
27955
+ '404':
27956
+ $ref: '#/components/responses/404'
27957
+ '500':
27958
+ $ref: '#/components/responses/500'
27695
27959
  /admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/accounts:
27696
27960
  get:
27697
27961
  description: list accounts in mongodb
@@ -52583,6 +52847,900 @@ components:
52583
52847
  type: string
52584
52848
  collectedAt:
52585
52849
  type: string
52850
+ clickhouseSession:
52851
+ type: object
52852
+ required:
52853
+ - queryId
52854
+ properties:
52855
+ queryId:
52856
+ type: string
52857
+ description: ClickHouse query_id. Use it with the KILL QUERY endpoint.
52858
+ initialQueryId:
52859
+ type: string
52860
+ description: query_id of the initial (distributed) query when this row is a remote sub-query.
52861
+ user:
52862
+ type: string
52863
+ description: User that started the query.
52864
+ address:
52865
+ type: string
52866
+ description: Client address.
52867
+ port:
52868
+ type: integer
52869
+ format: int64
52870
+ description: Client port.
52871
+ database:
52872
+ type: string
52873
+ description: Current database of the query.
52874
+ hostName:
52875
+ type: string
52876
+ description: ClickHouse server host that reported the query.
52877
+ elapsedSeconds:
52878
+ type: number
52879
+ format: double
52880
+ description: Seconds elapsed since the query started.
52881
+ readRows:
52882
+ type: integer
52883
+ format: int64
52884
+ description: Rows read so far.
52885
+ readBytes:
52886
+ type: integer
52887
+ format: int64
52888
+ description: Bytes read so far.
52889
+ writtenRows:
52890
+ type: integer
52891
+ format: int64
52892
+ description: Rows written so far.
52893
+ writtenBytes:
52894
+ type: integer
52895
+ format: int64
52896
+ description: Bytes written so far.
52897
+ memoryUsageBytes:
52898
+ type: integer
52899
+ format: int64
52900
+ description: Current memory usage in bytes.
52901
+ memoryLimitBytes:
52902
+ type: integer
52903
+ format: int64
52904
+ description: max_memory_usage from the query Settings map (only explicitly modified settings). Zero means the query did not set a limit, so the server default applies.
52905
+ memoryUsageRatio:
52906
+ type: number
52907
+ format: double
52908
+ description: memory_usage / memoryLimitBytes (0-1). Zero when the query did not explicitly set max_memory_usage. Values close to 1 indicate the query is about to hit its memory limit.
52909
+ peakMemoryUsageBytes:
52910
+ type: integer
52911
+ format: int64
52912
+ description: Peak memory usage in bytes. Zero when the server version does not expose peak_memory_usage.
52913
+ isInitialQuery:
52914
+ type: boolean
52915
+ description: Whether this row is the initial query rather than a remote sub-query.
52916
+ queryStartTime:
52917
+ type: string
52918
+ description: Estimated query start time in RFC3339 UTC, computed from elapsed because system.processes has no start timestamp.
52919
+ query:
52920
+ type: string
52921
+ description: Query text with string and numeric literals and comments masked as ? before returning.
52922
+ querySummary:
52923
+ type: string
52924
+ description: Single-line masked query summary suitable for list rendering.
52925
+ clickhouseSource:
52926
+ type: object
52927
+ properties:
52928
+ name:
52929
+ type: string
52930
+ description: Source expression, for example clusterAllReplicas('ck', system.processes).
52931
+ kind:
52932
+ type: string
52933
+ description: Logical source kind (system table or collection step).
52934
+ status:
52935
+ type: string
52936
+ description: Collection status (success, partial, failed).
52937
+ message:
52938
+ type: string
52939
+ description: Short human-readable status detail.
52940
+ clickhouseSessionList:
52941
+ type: object
52942
+ required:
52943
+ - collectedAt
52944
+ - items
52945
+ - sources
52946
+ properties:
52947
+ collectedAt:
52948
+ type: string
52949
+ description: Collection time in RFC3339 UTC.
52950
+ clusterMode:
52951
+ type: string
52952
+ description: Detected deployment mode (standalone or cluster). When clusterAllReplicas fails and the local node is used instead, this is reported as standalone.
52953
+ items:
52954
+ type: array
52955
+ description: Active queries collected from system.processes, ordered by the requested metric.
52956
+ items:
52957
+ $ref: '#/components/schemas/clickhouseSession'
52958
+ sources:
52959
+ type: array
52960
+ description: Per-source collection status. In cluster mode one entry is returned per clusterAllReplicas expression.
52961
+ items:
52962
+ $ref: '#/components/schemas/clickhouseSource'
52963
+ clickhouseSQLAnalysisRange:
52964
+ type: object
52965
+ properties:
52966
+ label:
52967
+ type: string
52968
+ description: Requested range label (1h, 6h, 24h, 7d).
52969
+ start:
52970
+ type: string
52971
+ description: Range start in RFC3339 UTC.
52972
+ end:
52973
+ type: string
52974
+ description: Range end in RFC3339 UTC.
52975
+ durationSeconds:
52976
+ type: integer
52977
+ format: int64
52978
+ description: Range duration in seconds.
52979
+ clickhouseSQLSummary:
52980
+ type: object
52981
+ properties:
52982
+ queryCount:
52983
+ type: integer
52984
+ format: int64
52985
+ description: Finished and failed queries in the selected range.
52986
+ failedCount:
52987
+ type: integer
52988
+ format: int64
52989
+ description: Queries that ended with ExceptionWhileProcessing.
52990
+ slowQueryCount:
52991
+ type: integer
52992
+ format: int64
52993
+ description: Queries whose duration is at least 1000 ms.
52994
+ totalDurationMs:
52995
+ type: number
52996
+ format: double
52997
+ description: Sum of query_duration_ms for all finished and failed queries.
52998
+ clickhouseSlowQuery:
52999
+ type: object
53000
+ properties:
53001
+ queryId:
53002
+ type: string
53003
+ description: ClickHouse query_id.
53004
+ initialQueryId:
53005
+ type: string
53006
+ description: Initial query_id for a distributed query.
53007
+ type:
53008
+ type: string
53009
+ description: query_log type (QueryFinish or ExceptionWhileProcessing).
53010
+ user:
53011
+ type: string
53012
+ description: User that ran the query.
53013
+ database:
53014
+ type: string
53015
+ description: Current database at execution time.
53016
+ queryKind:
53017
+ type: string
53018
+ description: Query kind reported by ClickHouse.
53019
+ query:
53020
+ type: string
53021
+ description: Query text with string and numeric literals and comments masked as ?.
53022
+ normalizedQueryHash:
53023
+ type: string
53024
+ description: normalized_query_hash as a string to avoid precision loss in clients.
53025
+ durationMs:
53026
+ type: number
53027
+ format: double
53028
+ description: query_duration_ms.
53029
+ readRows:
53030
+ type: integer
53031
+ format: int64
53032
+ description: Rows read by the query.
53033
+ readBytes:
53034
+ type: integer
53035
+ format: int64
53036
+ description: Bytes read by the query.
53037
+ memoryUsageBytes:
53038
+ type: integer
53039
+ format: int64
53040
+ description: Memory usage in bytes.
53041
+ resultRows:
53042
+ type: integer
53043
+ format: int64
53044
+ description: Rows returned by the query.
53045
+ resultBytes:
53046
+ type: integer
53047
+ format: int64
53048
+ description: Bytes returned by the query.
53049
+ exceptionCode:
53050
+ type: integer
53051
+ format: int64
53052
+ description: ClickHouse exception code, zero for successful queries.
53053
+ exception:
53054
+ type: string
53055
+ description: Exception text for failed queries.
53056
+ eventTime:
53057
+ type: string
53058
+ description: query_log event time in RFC3339 UTC.
53059
+ hostName:
53060
+ type: string
53061
+ description: ClickHouse server host that ran the query.
53062
+ clientName:
53063
+ type: string
53064
+ description: Client name reported by ClickHouse.
53065
+ isInitialQuery:
53066
+ type: boolean
53067
+ description: Whether this is the initial query rather than a remote sub-query.
53068
+ clickhouseQueryPattern:
53069
+ type: object
53070
+ properties:
53071
+ normalizedQueryHash:
53072
+ type: string
53073
+ description: normalized_query_hash as a string.
53074
+ sampleQuery:
53075
+ type: string
53076
+ description: One representative query text for the pattern, with string and numeric literals and comments masked as ?.
53077
+ calls:
53078
+ type: integer
53079
+ format: int64
53080
+ description: Number of executions of the pattern.
53081
+ totalDurationMs:
53082
+ type: number
53083
+ format: double
53084
+ description: Sum of query_duration_ms across all executions.
53085
+ meanDurationMs:
53086
+ type: number
53087
+ format: double
53088
+ description: Average query_duration_ms.
53089
+ maxDurationMs:
53090
+ type: number
53091
+ format: double
53092
+ description: Maximum query_duration_ms.
53093
+ readRows:
53094
+ type: integer
53095
+ format: int64
53096
+ description: Sum of read_rows.
53097
+ memoryUsageBytes:
53098
+ type: integer
53099
+ format: int64
53100
+ description: Sum of memory_usage in bytes.
53101
+ failureCount:
53102
+ type: integer
53103
+ format: int64
53104
+ description: Executions that ended with ExceptionWhileProcessing.
53105
+ slowCallCount:
53106
+ type: integer
53107
+ format: int64
53108
+ description: Executions whose duration is at least 1000 ms.
53109
+ firstSeen:
53110
+ type: string
53111
+ description: First event_time in RFC3339 UTC.
53112
+ lastSeen:
53113
+ type: string
53114
+ description: Last event_time in RFC3339 UTC.
53115
+ clickhouseFailedQuery:
53116
+ type: object
53117
+ properties:
53118
+ eventTime:
53119
+ type: string
53120
+ description: query_log event time in RFC3339 UTC.
53121
+ queryId:
53122
+ type: string
53123
+ description: ClickHouse query_id.
53124
+ user:
53125
+ type: string
53126
+ description: User that ran the query.
53127
+ database:
53128
+ type: string
53129
+ description: Current database at execution time.
53130
+ query:
53131
+ type: string
53132
+ description: Query text with string and numeric literals and comments masked as ?.
53133
+ exceptionCode:
53134
+ type: integer
53135
+ format: int64
53136
+ description: ClickHouse exception code.
53137
+ exceptionCategory:
53138
+ type: string
53139
+ description: Best-effort category such as memory_limit_exceeded, timeout, too_many_parts, readonly, unknown_table or syntax_error.
53140
+ exception:
53141
+ type: string
53142
+ description: Full exception text.
53143
+ durationMs:
53144
+ type: number
53145
+ format: double
53146
+ description: query_duration_ms before the failure.
53147
+ memoryUsageBytes:
53148
+ type: integer
53149
+ format: int64
53150
+ description: Memory usage in bytes.
53151
+ hostName:
53152
+ type: string
53153
+ description: ClickHouse server host that ran the query.
53154
+ clickhouseSQLAnalysis:
53155
+ type: object
53156
+ required:
53157
+ - collectedAt
53158
+ - status
53159
+ - slowestQueries
53160
+ - patterns
53161
+ - failures
53162
+ - sources
53163
+ properties:
53164
+ collectedAt:
53165
+ type: string
53166
+ description: Collection time in RFC3339 UTC.
53167
+ status:
53168
+ type: string
53169
+ description: available when system.query_log was collected, unavailable when query logging is disabled or the table is missing.
53170
+ unavailableReason:
53171
+ type: string
53172
+ description: Stable reason code when status is unavailable, for example query_log_unavailable.
53173
+ message:
53174
+ type: string
53175
+ description: Human-readable guidance when the analysis is unavailable.
53176
+ range:
53177
+ $ref: '#/components/schemas/clickhouseSQLAnalysisRange'
53178
+ summary:
53179
+ $ref: '#/components/schemas/clickhouseSQLSummary'
53180
+ slowestQueries:
53181
+ type: array
53182
+ description: Top initial queries ordered by query_duration_ms descending. Distributed child queries are excluded via is_initial_query = 1.
53183
+ items:
53184
+ $ref: '#/components/schemas/clickhouseSlowQuery'
53185
+ patterns:
53186
+ type: array
53187
+ description: Query patterns grouped by normalized_query_hash and ordered by the requested metric.
53188
+ items:
53189
+ $ref: '#/components/schemas/clickhouseQueryPattern'
53190
+ failures:
53191
+ type: array
53192
+ description: Failed queries (type = ExceptionWhileProcessing) ordered by event_time descending.
53193
+ items:
53194
+ $ref: '#/components/schemas/clickhouseFailedQuery'
53195
+ sources:
53196
+ type: array
53197
+ description: Per-source collection status.
53198
+ items:
53199
+ $ref: '#/components/schemas/clickhouseSource'
53200
+ clickhouseSpaceSummary:
53201
+ type: object
53202
+ properties:
53203
+ databaseCount:
53204
+ type: integer
53205
+ format: int64
53206
+ description: Number of databases with active parts.
53207
+ tableCount:
53208
+ type: integer
53209
+ format: int64
53210
+ description: Number of tables with active parts.
53211
+ totalBytes:
53212
+ type: integer
53213
+ format: int64
53214
+ description: Physical bytes_on_disk across all hosts.
53215
+ dataCompressedBytes:
53216
+ type: integer
53217
+ format: int64
53218
+ description: Sum of data_compressed_bytes.
53219
+ dataUncompressedBytes:
53220
+ type: integer
53221
+ format: int64
53222
+ description: Sum of data_uncompressed_bytes.
53223
+ compressionRatio:
53224
+ type: number
53225
+ format: double
53226
+ description: data_compressed_bytes / data_uncompressed_bytes. Lower is better; zero when uncompressed size is unknown.
53227
+ totalRows:
53228
+ type: integer
53229
+ format: int64
53230
+ description: Sum of active part rows across all hosts.
53231
+ activeParts:
53232
+ type: integer
53233
+ format: int64
53234
+ description: Number of active parts across all hosts.
53235
+ partitionCount:
53236
+ type: integer
53237
+ format: int64
53238
+ description: Sum of per-table partition counts. Replicated partitions can be counted more than once.
53239
+ warningTables:
53240
+ type: integer
53241
+ format: int64
53242
+ description: Tables whose active part count reached parts_to_delay_insert.
53243
+ criticalTables:
53244
+ type: integer
53245
+ format: int64
53246
+ description: Tables whose active part count reached parts_to_throw_insert.
53247
+ partsToDelayInsert:
53248
+ type: integer
53249
+ format: int64
53250
+ description: Effective parts_to_delay_insert from system.merge_tree_settings (default 150).
53251
+ partsToThrowInsert:
53252
+ type: integer
53253
+ format: int64
53254
+ description: Effective parts_to_throw_insert from system.merge_tree_settings (default 300).
53255
+ clickhouseDiskUsage:
53256
+ type: object
53257
+ properties:
53258
+ diskName:
53259
+ type: string
53260
+ description: ClickHouse disk name.
53261
+ hostName:
53262
+ type: string
53263
+ description: ClickHouse server host.
53264
+ bytesOnDisk:
53265
+ type: integer
53266
+ format: int64
53267
+ description: bytes_on_disk for this disk and host.
53268
+ dataCompressedBytes:
53269
+ type: integer
53270
+ format: int64
53271
+ description: data_compressed_bytes for this disk and host.
53272
+ dataUncompressedBytes:
53273
+ type: integer
53274
+ format: int64
53275
+ description: data_uncompressed_bytes for this disk and host.
53276
+ rows:
53277
+ type: integer
53278
+ format: int64
53279
+ description: Rows on this disk and host.
53280
+ activeParts:
53281
+ type: integer
53282
+ format: int64
53283
+ description: Active parts on this disk and host.
53284
+ clickhouseTableSpace:
53285
+ type: object
53286
+ properties:
53287
+ database:
53288
+ type: string
53289
+ description: Database name.
53290
+ table:
53291
+ type: string
53292
+ description: Table name.
53293
+ engine:
53294
+ type: string
53295
+ description: Table engine.
53296
+ bytesOnDisk:
53297
+ type: integer
53298
+ format: int64
53299
+ description: Physical bytes_on_disk across all hosts and disks.
53300
+ dataCompressedBytes:
53301
+ type: integer
53302
+ format: int64
53303
+ description: Sum of data_compressed_bytes.
53304
+ dataUncompressedBytes:
53305
+ type: integer
53306
+ format: int64
53307
+ description: Sum of data_uncompressed_bytes.
53308
+ compressionRatio:
53309
+ type: number
53310
+ format: double
53311
+ description: data_compressed_bytes / data_uncompressed_bytes.
53312
+ rows:
53313
+ type: integer
53314
+ format: int64
53315
+ description: Sum of active part rows.
53316
+ activeParts:
53317
+ type: integer
53318
+ format: int64
53319
+ description: Active part count used for the Too many parts risk check.
53320
+ partitionCount:
53321
+ type: integer
53322
+ format: int64
53323
+ description: Distinct partitions across disks and hosts.
53324
+ hosts:
53325
+ type: integer
53326
+ format: int64
53327
+ description: Number of hosts that own active parts for this table.
53328
+ lastModifiedAt:
53329
+ type: string
53330
+ description: Latest part modification time in RFC3339 UTC.
53331
+ risk:
53332
+ type: string
53333
+ description: normal, warning (parts >= parts_to_delay_insert) or critical (parts >= parts_to_throw_insert).
53334
+ disks:
53335
+ type: array
53336
+ description: Per-disk and per-host breakdown.
53337
+ items:
53338
+ $ref: '#/components/schemas/clickhouseDiskUsage'
53339
+ clickhousePartitionSpace:
53340
+ type: object
53341
+ properties:
53342
+ database:
53343
+ type: string
53344
+ description: Database name.
53345
+ table:
53346
+ type: string
53347
+ description: Table name.
53348
+ partitionId:
53349
+ type: string
53350
+ description: partition_id from system.parts.
53351
+ partition:
53352
+ type: string
53353
+ description: Human-readable partition expression.
53354
+ rows:
53355
+ type: integer
53356
+ format: int64
53357
+ description: Sum of rows across hosts.
53358
+ bytesOnDisk:
53359
+ type: integer
53360
+ format: int64
53361
+ description: Physical bytes_on_disk across hosts.
53362
+ dataCompressedBytes:
53363
+ type: integer
53364
+ format: int64
53365
+ description: Sum of data_compressed_bytes.
53366
+ dataUncompressedBytes:
53367
+ type: integer
53368
+ format: int64
53369
+ description: Sum of data_uncompressed_bytes.
53370
+ activeParts:
53371
+ type: integer
53372
+ format: int64
53373
+ description: Active part count across hosts.
53374
+ hosts:
53375
+ type: integer
53376
+ format: int64
53377
+ description: Number of hosts that own this partition.
53378
+ minDate:
53379
+ type: string
53380
+ description: Minimum min_date in the partition.
53381
+ maxDate:
53382
+ type: string
53383
+ description: Maximum max_date in the partition.
53384
+ clickhouseMerge:
53385
+ type: object
53386
+ properties:
53387
+ database:
53388
+ type: string
53389
+ description: Database name.
53390
+ table:
53391
+ type: string
53392
+ description: Table name.
53393
+ hostName:
53394
+ type: string
53395
+ description: ClickHouse server host running the merge.
53396
+ elapsedSeconds:
53397
+ type: number
53398
+ format: double
53399
+ description: Seconds elapsed since the merge started.
53400
+ progress:
53401
+ type: number
53402
+ format: double
53403
+ description: Merge progress (0-1).
53404
+ numParts:
53405
+ type: integer
53406
+ format: int64
53407
+ description: Number of source parts.
53408
+ resultPartName:
53409
+ type: string
53410
+ description: Resulting part name.
53411
+ partitionId:
53412
+ type: string
53413
+ description: Partition being merged.
53414
+ isMutation:
53415
+ type: boolean
53416
+ description: Whether this merge also applies a mutation.
53417
+ memoryUsageBytes:
53418
+ type: integer
53419
+ format: int64
53420
+ description: Memory usage in bytes.
53421
+ rowsRead:
53422
+ type: integer
53423
+ format: int64
53424
+ description: Rows read by the merge.
53425
+ rowsWritten:
53426
+ type: integer
53427
+ format: int64
53428
+ description: Rows written by the merge.
53429
+ totalSizeBytesCompressed:
53430
+ type: integer
53431
+ format: int64
53432
+ description: Compressed size of the source parts.
53433
+ clickhouseMutation:
53434
+ type: object
53435
+ properties:
53436
+ database:
53437
+ type: string
53438
+ description: Database name.
53439
+ table:
53440
+ type: string
53441
+ description: Table name.
53442
+ hostName:
53443
+ type: string
53444
+ description: ClickHouse server host running the mutation.
53445
+ mutationId:
53446
+ type: string
53447
+ description: Mutation identifier.
53448
+ command:
53449
+ type: string
53450
+ description: Mutation command (ALTER/UPDATE/DELETE) with string and numeric literals and comments masked as ?.
53451
+ createTime:
53452
+ type: string
53453
+ description: Mutation creation time in RFC3339 UTC.
53454
+ partsToDo:
53455
+ type: integer
53456
+ format: int64
53457
+ description: Parts still waiting to be mutated.
53458
+ latestFailedPart:
53459
+ type: string
53460
+ description: Most recent part that failed mutation.
53461
+ latestFailTime:
53462
+ type: string
53463
+ description: Most recent mutation failure time in RFC3339 UTC.
53464
+ latestFailReason:
53465
+ type: string
53466
+ description: Most recent mutation failure reason.
53467
+ clickhouseSpaceAnalysis:
53468
+ type: object
53469
+ required:
53470
+ - collectedAt
53471
+ - status
53472
+ - tables
53473
+ - partitions
53474
+ - merges
53475
+ - mutations
53476
+ - sources
53477
+ properties:
53478
+ collectedAt:
53479
+ type: string
53480
+ description: Collection time in RFC3339 UTC.
53481
+ status:
53482
+ type: string
53483
+ description: success when all sources were collected, partial when at least one best-effort source failed.
53484
+ database:
53485
+ type: string
53486
+ description: Database filter applied to the collection, empty when all databases are included.
53487
+ summary:
53488
+ $ref: '#/components/schemas/clickhouseSpaceSummary'
53489
+ tables:
53490
+ type: array
53491
+ description: Top tables ordered by physical bytes_on_disk. Totals are physical usage across all hosts, not deduplicated logical usage.
53492
+ items:
53493
+ $ref: '#/components/schemas/clickhouseTableSpace'
53494
+ partitions:
53495
+ type: array
53496
+ description: Top partitions ordered by physical bytes_on_disk.
53497
+ items:
53498
+ $ref: '#/components/schemas/clickhousePartitionSpace'
53499
+ merges:
53500
+ type: array
53501
+ description: In-progress background merges from system.merges ordered by elapsed time.
53502
+ items:
53503
+ $ref: '#/components/schemas/clickhouseMerge'
53504
+ mutations:
53505
+ type: array
53506
+ description: Unfinished mutations from system.mutations ordered by creation time.
53507
+ items:
53508
+ $ref: '#/components/schemas/clickhouseMutation'
53509
+ sources:
53510
+ type: array
53511
+ description: Per-source collection status.
53512
+ items:
53513
+ $ref: '#/components/schemas/clickhouseSource'
53514
+ clickhouseClusterHealthSummary:
53515
+ type: object
53516
+ properties:
53517
+ replicaCount:
53518
+ type: integer
53519
+ format: int64
53520
+ description: Number of replicated table replicas collected.
53521
+ nodeCount:
53522
+ type: integer
53523
+ format: int64
53524
+ description: Number of nodes in system.clusters.
53525
+ clusterCount:
53526
+ type: integer
53527
+ format: int64
53528
+ description: Number of distinct cluster names.
53529
+ totalReplicas:
53530
+ type: integer
53531
+ format: int64
53532
+ description: Sum of total_replicas across replicated tables.
53533
+ activeReplicas:
53534
+ type: integer
53535
+ format: int64
53536
+ description: Sum of active_replicas across replicated tables.
53537
+ readonlyReplicas:
53538
+ type: integer
53539
+ format: int64
53540
+ description: Replicas currently in readonly mode.
53541
+ sessionExpiredReplicas:
53542
+ type: integer
53543
+ format: int64
53544
+ description: Replicas whose Keeper session expired.
53545
+ maxAbsoluteDelaySeconds:
53546
+ type: number
53547
+ format: double
53548
+ description: Maximum absolute_delay in seconds.
53549
+ totalQueueSize:
53550
+ type: integer
53551
+ format: int64
53552
+ description: Sum of replication queue sizes.
53553
+ warningReplicas:
53554
+ type: integer
53555
+ format: int64
53556
+ description: Replicas classified as warning.
53557
+ criticalReplicas:
53558
+ type: integer
53559
+ format: int64
53560
+ description: Replicas classified as critical.
53561
+ unhealthyNodes:
53562
+ type: integer
53563
+ format: int64
53564
+ description: Nodes with connection errors, slowdowns or a non-zero estimated recovery time.
53565
+ clickhouseReplicaHealth:
53566
+ type: object
53567
+ properties:
53568
+ database:
53569
+ type: string
53570
+ description: Database name.
53571
+ table:
53572
+ type: string
53573
+ description: Table name.
53574
+ hostName:
53575
+ type: string
53576
+ description: ClickHouse server host that reported this replica.
53577
+ isReadonly:
53578
+ type: boolean
53579
+ description: Replica is in readonly mode. Usually indicates Keeper or network problems.
53580
+ isSessionExpired:
53581
+ type: boolean
53582
+ description: Keeper session expired.
53583
+ absoluteDelaySeconds:
53584
+ type: number
53585
+ format: double
53586
+ description: absolute_delay from system.replicas.
53587
+ queueSize:
53588
+ type: integer
53589
+ format: int64
53590
+ description: replication queue size.
53591
+ insertsInQueue:
53592
+ type: integer
53593
+ format: int64
53594
+ description: Number of inserts waiting in the replication queue.
53595
+ mergesInQueue:
53596
+ type: integer
53597
+ format: int64
53598
+ description: Number of merges waiting in the replication queue.
53599
+ futureParts:
53600
+ type: integer
53601
+ format: int64
53602
+ description: Number of future parts.
53603
+ partsToCheck:
53604
+ type: integer
53605
+ format: int64
53606
+ description: Number of parts to check.
53607
+ totalReplicas:
53608
+ type: integer
53609
+ format: int64
53610
+ description: total_replicas for the table.
53611
+ activeReplicas:
53612
+ type: integer
53613
+ format: int64
53614
+ description: active_replicas for the table.
53615
+ logMaxIndex:
53616
+ type: integer
53617
+ format: int64
53618
+ description: Maximum log index in Keeper.
53619
+ logPointer:
53620
+ type: integer
53621
+ format: int64
53622
+ description: Last applied log index.
53623
+ lastQueueUpdate:
53624
+ type: string
53625
+ description: Last replication queue update time in RFC3339 UTC.
53626
+ zookeeperPath:
53627
+ type: string
53628
+ description: Keeper path of the table.
53629
+ replicaName:
53630
+ type: string
53631
+ description: Replica name.
53632
+ replicaPath:
53633
+ type: string
53634
+ description: Replica path in Keeper.
53635
+ zookeeperException:
53636
+ type: string
53637
+ description: Last Keeper exception, empty when healthy.
53638
+ lastQueueUpdateException:
53639
+ type: string
53640
+ description: Last replication queue update exception, empty when healthy.
53641
+ risk:
53642
+ type: string
53643
+ description: normal, warning or critical.
53644
+ issues:
53645
+ type: array
53646
+ description: Detected issue codes such as readonly, session_expired, replication_delay, queue_backlog, missing_replicas, keeper_error or queue_update_error.
53647
+ items:
53648
+ type: string
53649
+ clickhouseClusterNode:
53650
+ type: object
53651
+ properties:
53652
+ cluster:
53653
+ type: string
53654
+ description: Cluster name.
53655
+ shardNum:
53656
+ type: integer
53657
+ format: int64
53658
+ description: Shard number.
53659
+ shardWeight:
53660
+ type: integer
53661
+ format: int64
53662
+ description: Shard weight.
53663
+ replicaNum:
53664
+ type: integer
53665
+ format: int64
53666
+ description: Replica number inside the shard.
53667
+ hostName:
53668
+ type: string
53669
+ description: Configured host name.
53670
+ hostAddress:
53671
+ type: string
53672
+ description: Configured host address.
53673
+ port:
53674
+ type: integer
53675
+ format: int64
53676
+ description: Configured TCP port.
53677
+ isLocal:
53678
+ type: boolean
53679
+ description: Whether this node is the connected node.
53680
+ user:
53681
+ type: string
53682
+ description: Configured user.
53683
+ defaultDatabase:
53684
+ type: string
53685
+ description: Configured default database.
53686
+ errorsCount:
53687
+ type: integer
53688
+ format: int64
53689
+ description: Connection errors observed for this node.
53690
+ slowdownsCount:
53691
+ type: integer
53692
+ format: int64
53693
+ description: Slowdown events observed for this node.
53694
+ estimatedRecoveryTime:
53695
+ type: integer
53696
+ format: int64
53697
+ description: Estimated recovery time in seconds, zero when the node is healthy.
53698
+ risk:
53699
+ type: string
53700
+ description: normal or warning.
53701
+ issues:
53702
+ type: array
53703
+ description: Detected issue codes such as connection_errors, slowdowns or estimated_recovery_time.
53704
+ items:
53705
+ type: string
53706
+ clickhouseClusterHealth:
53707
+ type: object
53708
+ required:
53709
+ - collectedAt
53710
+ - status
53711
+ - replicas
53712
+ - nodes
53713
+ - sources
53714
+ properties:
53715
+ collectedAt:
53716
+ type: string
53717
+ description: Collection time in RFC3339 UTC.
53718
+ status:
53719
+ type: string
53720
+ description: Collection status. success when every source was collected, partial when topology or replicas could only be partially read.
53721
+ overallStatus:
53722
+ type: string
53723
+ description: Derived health status. normal, warning or critical.
53724
+ clusterMode:
53725
+ type: string
53726
+ description: Detected deployment mode (standalone or cluster).
53727
+ summary:
53728
+ $ref: '#/components/schemas/clickhouseClusterHealthSummary'
53729
+ replicas:
53730
+ type: array
53731
+ description: Replicated tables ordered by risk, absolute delay and queue size.
53732
+ items:
53733
+ $ref: '#/components/schemas/clickhouseReplicaHealth'
53734
+ nodes:
53735
+ type: array
53736
+ description: Shard and replica topology from system.clusters on the connected node.
53737
+ items:
53738
+ $ref: '#/components/schemas/clickhouseClusterNode'
53739
+ sources:
53740
+ type: array
53741
+ description: Per-source collection status.
53742
+ items:
53743
+ $ref: '#/components/schemas/clickhouseSource'
52586
53744
  MilvusRoleGrant:
52587
53745
  type: object
52588
53746
  description: Native Milvus role privilege grant.