kb-cloud-client-typescript 2.3.0-beta.0 → 2.3.0-beta.10

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 (243) hide show
  1. package/dist/adminapi/api.d.ts +1 -0
  2. package/dist/adminapi/api.d.ts.map +1 -1
  3. package/dist/adminapi/api.js +1 -0
  4. package/dist/adminapi/api.js.map +1 -1
  5. package/dist/adminapi/apis/clickhouse-api.d.ts +995 -0
  6. package/dist/adminapi/apis/clickhouse-api.d.ts.map +1 -0
  7. package/dist/adminapi/apis/clickhouse-api.js +1107 -0
  8. package/dist/adminapi/apis/clickhouse-api.js.map +1 -0
  9. package/dist/adminapi/apis/cluster-api.d.ts +36 -4
  10. package/dist/adminapi/apis/cluster-api.d.ts.map +1 -1
  11. package/dist/adminapi/apis/cluster-api.js +30 -10
  12. package/dist/adminapi/apis/cluster-api.js.map +1 -1
  13. package/dist/adminapi/apis/load-balancer-api.d.ts +175 -0
  14. package/dist/adminapi/apis/load-balancer-api.d.ts.map +1 -1
  15. package/dist/adminapi/apis/load-balancer-api.js +213 -0
  16. package/dist/adminapi/apis/load-balancer-api.js.map +1 -1
  17. package/dist/adminapi/apis/shared-api.d.ts +989 -10
  18. package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
  19. package/dist/adminapi/apis/shared-api.js +1121 -58
  20. package/dist/adminapi/apis/shared-api.js.map +1 -1
  21. package/dist/adminapi/models/ck-account-type.d.ts +23 -0
  22. package/dist/adminapi/models/ck-account-type.d.ts.map +1 -0
  23. package/dist/adminapi/models/ck-account-type.js +27 -0
  24. package/dist/adminapi/models/ck-account-type.js.map +1 -0
  25. package/dist/adminapi/models/ck-account.d.ts +50 -0
  26. package/dist/adminapi/models/ck-account.d.ts.map +1 -0
  27. package/dist/adminapi/models/ck-account.js +16 -0
  28. package/dist/adminapi/models/ck-account.js.map +1 -0
  29. package/dist/adminapi/models/cluster-list-item.d.ts +20 -0
  30. package/dist/adminapi/models/cluster-list-item.d.ts.map +1 -1
  31. package/dist/adminapi/models/cluster-metrics.d.ts +4 -2
  32. package/dist/adminapi/models/cluster-metrics.d.ts.map +1 -1
  33. package/dist/adminapi/models/create-clickhouse-account-request.d.ts +37 -0
  34. package/dist/adminapi/models/create-clickhouse-account-request.d.ts.map +1 -0
  35. package/dist/adminapi/models/create-clickhouse-account-request.js +16 -0
  36. package/dist/adminapi/models/create-clickhouse-account-request.js.map +1 -0
  37. package/dist/adminapi/models/dms-ob-parameter.d.ts +4 -2
  38. package/dist/adminapi/models/dms-ob-parameter.d.ts.map +1 -1
  39. package/dist/adminapi/models/engine-mapping.d.ts +7 -0
  40. package/dist/adminapi/models/engine-mapping.d.ts.map +1 -1
  41. package/dist/adminapi/models/get-clickhouse-role-grants200-response-inner.d.ts +49 -0
  42. package/dist/adminapi/models/get-clickhouse-role-grants200-response-inner.d.ts.map +1 -0
  43. package/dist/adminapi/models/get-clickhouse-role-grants200-response-inner.js +16 -0
  44. package/dist/adminapi/models/get-clickhouse-role-grants200-response-inner.js.map +1 -0
  45. package/dist/adminapi/models/index.d.ts +15 -0
  46. package/dist/adminapi/models/index.d.ts.map +1 -1
  47. package/dist/adminapi/models/index.js +15 -0
  48. package/dist/adminapi/models/index.js.map +1 -1
  49. package/dist/adminapi/models/list-clickhouse-account-roles200-response-privileges-inner.d.ts +31 -0
  50. package/dist/adminapi/models/list-clickhouse-account-roles200-response-privileges-inner.d.ts.map +1 -0
  51. package/dist/adminapi/models/list-clickhouse-account-roles200-response-privileges-inner.js +16 -0
  52. package/dist/adminapi/models/list-clickhouse-account-roles200-response-privileges-inner.js.map +1 -0
  53. package/dist/adminapi/models/list-clickhouse-account-roles200-response.d.ts +32 -0
  54. package/dist/adminapi/models/list-clickhouse-account-roles200-response.d.ts.map +1 -0
  55. package/dist/adminapi/models/list-clickhouse-account-roles200-response.js +16 -0
  56. package/dist/adminapi/models/list-clickhouse-account-roles200-response.js.map +1 -0
  57. package/dist/adminapi/models/load-balancer-annotations.d.ts +35 -0
  58. package/dist/adminapi/models/load-balancer-annotations.d.ts.map +1 -0
  59. package/dist/adminapi/models/load-balancer-annotations.js +16 -0
  60. package/dist/adminapi/models/load-balancer-annotations.js.map +1 -0
  61. package/dist/adminapi/models/load-balancer-config-update.d.ts +26 -0
  62. package/dist/adminapi/models/load-balancer-config-update.d.ts.map +1 -0
  63. package/dist/adminapi/models/load-balancer-config-update.js +16 -0
  64. package/dist/adminapi/models/load-balancer-config-update.js.map +1 -0
  65. package/dist/adminapi/models/load-balancer-config.d.ts +32 -0
  66. package/dist/adminapi/models/load-balancer-config.d.ts.map +1 -0
  67. package/dist/adminapi/models/load-balancer-config.js +16 -0
  68. package/dist/adminapi/models/load-balancer-config.js.map +1 -0
  69. package/dist/adminapi/models/provision-config.d.ts +13 -0
  70. package/dist/adminapi/models/provision-config.d.ts.map +1 -1
  71. package/dist/adminapi/models/replication-check-option.d.ts +25 -0
  72. package/dist/adminapi/models/replication-check-option.d.ts.map +1 -0
  73. package/dist/adminapi/models/replication-check-option.js +16 -0
  74. package/dist/adminapi/models/replication-check-option.js.map +1 -0
  75. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.d.ts +31 -0
  76. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.d.ts.map +1 -0
  77. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.js +16 -0
  78. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.js.map +1 -0
  79. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request.d.ts +26 -0
  80. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request.d.ts.map +1 -0
  81. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request.js +16 -0
  82. package/dist/adminapi/models/revoke-clickhouse-role-privileges-request.js.map +1 -0
  83. package/dist/adminapi/models/scheduling-config.d.ts +14 -0
  84. package/dist/adminapi/models/scheduling-config.d.ts.map +1 -1
  85. package/dist/adminapi/models/system-component-scheduler-policy.d.ts +22 -0
  86. package/dist/adminapi/models/system-component-scheduler-policy.d.ts.map +1 -0
  87. package/dist/adminapi/models/system-component-scheduler-policy.js +26 -0
  88. package/dist/adminapi/models/system-component-scheduler-policy.js.map +1 -0
  89. package/dist/adminapi/models/update-clickhouse-account-password-request.d.ts +25 -0
  90. package/dist/adminapi/models/update-clickhouse-account-password-request.d.ts.map +1 -0
  91. package/dist/adminapi/models/update-clickhouse-account-password-request.js +16 -0
  92. package/dist/adminapi/models/update-clickhouse-account-password-request.js.map +1 -0
  93. package/dist/adminapi/models/update-clickhouse-account-roles-request.d.ts +25 -0
  94. package/dist/adminapi/models/update-clickhouse-account-roles-request.d.ts.map +1 -0
  95. package/dist/adminapi/models/update-clickhouse-account-roles-request.js +16 -0
  96. package/dist/adminapi/models/update-clickhouse-account-roles-request.js.map +1 -0
  97. package/dist/internalapi/apis/cluster-api.d.ts +18 -2
  98. package/dist/internalapi/apis/cluster-api.d.ts.map +1 -1
  99. package/dist/internalapi/apis/cluster-api.js +15 -5
  100. package/dist/internalapi/apis/cluster-api.js.map +1 -1
  101. package/dist/internalapi/models/cluster-list-item.d.ts +20 -0
  102. package/dist/internalapi/models/cluster-list-item.d.ts.map +1 -1
  103. package/dist/internalapi/models/index.d.ts +1 -0
  104. package/dist/internalapi/models/index.d.ts.map +1 -1
  105. package/dist/internalapi/models/index.js +1 -0
  106. package/dist/internalapi/models/index.js.map +1 -1
  107. package/dist/internalapi/models/tag.d.ts +37 -0
  108. package/dist/internalapi/models/tag.d.ts.map +1 -0
  109. package/dist/internalapi/models/tag.js +16 -0
  110. package/dist/internalapi/models/tag.js.map +1 -0
  111. package/dist/openapi/api.d.ts +1 -0
  112. package/dist/openapi/api.d.ts.map +1 -1
  113. package/dist/openapi/api.js +1 -0
  114. package/dist/openapi/api.js.map +1 -1
  115. package/dist/openapi/apis/clickhouse-api.d.ts +995 -0
  116. package/dist/openapi/apis/clickhouse-api.d.ts.map +1 -0
  117. package/dist/openapi/apis/clickhouse-api.js +1107 -0
  118. package/dist/openapi/apis/clickhouse-api.js.map +1 -0
  119. package/dist/openapi/apis/cluster-api.d.ts +18 -2
  120. package/dist/openapi/apis/cluster-api.d.ts.map +1 -1
  121. package/dist/openapi/apis/cluster-api.js +15 -5
  122. package/dist/openapi/apis/cluster-api.js.map +1 -1
  123. package/dist/openapi/apis/shared-api.d.ts +966 -3
  124. package/dist/openapi/apis/shared-api.d.ts.map +1 -1
  125. package/dist/openapi/apis/shared-api.js +1118 -65
  126. package/dist/openapi/apis/shared-api.js.map +1 -1
  127. package/dist/openapi/models/ck-account-type.d.ts +23 -0
  128. package/dist/openapi/models/ck-account-type.d.ts.map +1 -0
  129. package/dist/openapi/models/ck-account-type.js +27 -0
  130. package/dist/openapi/models/ck-account-type.js.map +1 -0
  131. package/dist/openapi/models/ck-account.d.ts +50 -0
  132. package/dist/openapi/models/ck-account.d.ts.map +1 -0
  133. package/dist/openapi/models/ck-account.js +16 -0
  134. package/dist/openapi/models/ck-account.js.map +1 -0
  135. package/dist/openapi/models/cluster-list-item.d.ts +20 -0
  136. package/dist/openapi/models/cluster-list-item.d.ts.map +1 -1
  137. package/dist/openapi/models/cluster-metrics.d.ts +4 -2
  138. package/dist/openapi/models/cluster-metrics.d.ts.map +1 -1
  139. package/dist/openapi/models/create-clickhouse-account-request.d.ts +37 -0
  140. package/dist/openapi/models/create-clickhouse-account-request.d.ts.map +1 -0
  141. package/dist/openapi/models/create-clickhouse-account-request.js +16 -0
  142. package/dist/openapi/models/create-clickhouse-account-request.js.map +1 -0
  143. package/dist/openapi/models/data-check-create.d.ts +6 -0
  144. package/dist/openapi/models/data-check-create.d.ts.map +1 -1
  145. package/dist/openapi/models/dms-ob-parameter.d.ts +4 -2
  146. package/dist/openapi/models/dms-ob-parameter.d.ts.map +1 -1
  147. package/dist/openapi/models/engine-mapping.d.ts +7 -0
  148. package/dist/openapi/models/engine-mapping.d.ts.map +1 -1
  149. package/dist/openapi/models/get-clickhouse-role-grants200-response-inner.d.ts +49 -0
  150. package/dist/openapi/models/get-clickhouse-role-grants200-response-inner.d.ts.map +1 -0
  151. package/dist/openapi/models/get-clickhouse-role-grants200-response-inner.js +16 -0
  152. package/dist/openapi/models/get-clickhouse-role-grants200-response-inner.js.map +1 -0
  153. package/dist/openapi/models/index.d.ts +11 -0
  154. package/dist/openapi/models/index.d.ts.map +1 -1
  155. package/dist/openapi/models/index.js +11 -0
  156. package/dist/openapi/models/index.js.map +1 -1
  157. package/dist/openapi/models/list-clickhouse-account-roles200-response-privileges-inner.d.ts +31 -0
  158. package/dist/openapi/models/list-clickhouse-account-roles200-response-privileges-inner.d.ts.map +1 -0
  159. package/dist/openapi/models/list-clickhouse-account-roles200-response-privileges-inner.js +16 -0
  160. package/dist/openapi/models/list-clickhouse-account-roles200-response-privileges-inner.js.map +1 -0
  161. package/dist/openapi/models/list-clickhouse-account-roles200-response.d.ts +32 -0
  162. package/dist/openapi/models/list-clickhouse-account-roles200-response.d.ts.map +1 -0
  163. package/dist/openapi/models/list-clickhouse-account-roles200-response.js +16 -0
  164. package/dist/openapi/models/list-clickhouse-account-roles200-response.js.map +1 -0
  165. package/dist/openapi/models/replication-check-option.d.ts +25 -0
  166. package/dist/openapi/models/replication-check-option.d.ts.map +1 -0
  167. package/dist/openapi/models/replication-check-option.js +16 -0
  168. package/dist/openapi/models/replication-check-option.js.map +1 -0
  169. package/dist/openapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.d.ts +31 -0
  170. package/dist/openapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.d.ts.map +1 -0
  171. package/dist/openapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.js +16 -0
  172. package/dist/openapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.js.map +1 -0
  173. package/dist/openapi/models/revoke-clickhouse-role-privileges-request.d.ts +26 -0
  174. package/dist/openapi/models/revoke-clickhouse-role-privileges-request.d.ts.map +1 -0
  175. package/dist/openapi/models/revoke-clickhouse-role-privileges-request.js +16 -0
  176. package/dist/openapi/models/revoke-clickhouse-role-privileges-request.js.map +1 -0
  177. package/dist/openapi/models/update-clickhouse-account-password-request.d.ts +25 -0
  178. package/dist/openapi/models/update-clickhouse-account-password-request.d.ts.map +1 -0
  179. package/dist/openapi/models/update-clickhouse-account-password-request.js +16 -0
  180. package/dist/openapi/models/update-clickhouse-account-password-request.js.map +1 -0
  181. package/dist/openapi/models/update-clickhouse-account-roles-request.d.ts +25 -0
  182. package/dist/openapi/models/update-clickhouse-account-roles-request.d.ts.map +1 -0
  183. package/dist/openapi/models/update-clickhouse-account-roles-request.js +16 -0
  184. package/dist/openapi/models/update-clickhouse-account-roles-request.js.map +1 -0
  185. package/package.json +1 -1
  186. package/src/adminapi/.openapi-generator/FILES +16 -0
  187. package/src/adminapi/api.ts +1 -0
  188. package/src/adminapi/apis/clickhouse-api.ts +1735 -0
  189. package/src/adminapi/apis/cluster-api.ts +62 -10
  190. package/src/adminapi/apis/load-balancer-api.ts +318 -0
  191. package/src/adminapi/apis/shared-api.ts +1971 -254
  192. package/src/adminapi/models/ck-account-type.ts +32 -0
  193. package/src/adminapi/models/ck-account.ts +59 -0
  194. package/src/adminapi/models/cluster-list-item.ts +24 -0
  195. package/src/adminapi/models/cluster-metrics.ts +2 -2
  196. package/src/adminapi/models/create-clickhouse-account-request.ts +42 -0
  197. package/src/adminapi/models/dms-ob-parameter.ts +2 -2
  198. package/src/adminapi/models/engine-mapping.ts +9 -0
  199. package/src/adminapi/models/get-clickhouse-role-grants200-response-inner.ts +54 -0
  200. package/src/adminapi/models/index.ts +15 -0
  201. package/src/adminapi/models/list-clickhouse-account-roles200-response-privileges-inner.ts +36 -0
  202. package/src/adminapi/models/list-clickhouse-account-roles200-response.ts +39 -0
  203. package/src/adminapi/models/load-balancer-annotations.ts +36 -0
  204. package/src/adminapi/models/load-balancer-config-update.ts +33 -0
  205. package/src/adminapi/models/load-balancer-config.ts +39 -0
  206. package/src/adminapi/models/provision-config.ts +15 -0
  207. package/src/adminapi/models/replication-check-option.ts +30 -0
  208. package/src/adminapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.ts +36 -0
  209. package/src/adminapi/models/revoke-clickhouse-role-privileges-request.ts +33 -0
  210. package/src/adminapi/models/scheduling-config.ts +18 -0
  211. package/src/adminapi/models/system-component-scheduler-policy.ts +31 -0
  212. package/src/adminapi/models/update-clickhouse-account-password-request.ts +30 -0
  213. package/src/adminapi/models/update-clickhouse-account-roles-request.ts +30 -0
  214. package/src/adminapi.yaml +1109 -244
  215. package/src/internalapi/.openapi-generator/FILES +1 -0
  216. package/src/internalapi/apis/cluster-api.ts +31 -5
  217. package/src/internalapi/models/cluster-list-item.ts +24 -0
  218. package/src/internalapi/models/index.ts +1 -0
  219. package/src/internalapi/models/tag.ts +42 -0
  220. package/src/internalapi.yaml +107 -66
  221. package/src/openapi/.openapi-generator/FILES +12 -0
  222. package/src/openapi/api.ts +1 -0
  223. package/src/openapi/apis/clickhouse-api.ts +1735 -0
  224. package/src/openapi/apis/cluster-api.ts +31 -5
  225. package/src/openapi/apis/shared-api.ts +2251 -560
  226. package/src/openapi/models/ck-account-type.ts +32 -0
  227. package/src/openapi/models/ck-account.ts +59 -0
  228. package/src/openapi/models/cluster-list-item.ts +24 -0
  229. package/src/openapi/models/cluster-metrics.ts +2 -2
  230. package/src/openapi/models/create-clickhouse-account-request.ts +42 -0
  231. package/src/openapi/models/data-check-create.ts +6 -0
  232. package/src/openapi/models/dms-ob-parameter.ts +2 -2
  233. package/src/openapi/models/engine-mapping.ts +9 -0
  234. package/src/openapi/models/get-clickhouse-role-grants200-response-inner.ts +54 -0
  235. package/src/openapi/models/index.ts +11 -0
  236. package/src/openapi/models/list-clickhouse-account-roles200-response-privileges-inner.ts +36 -0
  237. package/src/openapi/models/list-clickhouse-account-roles200-response.ts +39 -0
  238. package/src/openapi/models/replication-check-option.ts +30 -0
  239. package/src/openapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.ts +36 -0
  240. package/src/openapi/models/revoke-clickhouse-role-privileges-request.ts +33 -0
  241. package/src/openapi/models/update-clickhouse-account-password-request.ts +30 -0
  242. package/src/openapi/models/update-clickhouse-account-roles-request.ts +30 -0
  243. package/src/openapi.yaml +806 -84
package/src/adminapi.yaml CHANGED
@@ -2263,6 +2263,19 @@ paths:
2263
2263
  required: false
2264
2264
  schema:
2265
2265
  type: boolean
2266
+ - name: endpointHost
2267
+ in: query
2268
+ description: Case-insensitive substring to match against the host part of cached cluster endpoints
2269
+ required: false
2270
+ schema:
2271
+ type: string
2272
+ - name: includeEndpoints
2273
+ in: query
2274
+ description: Whether to include cached user-visible endpoints in each cluster item
2275
+ required: false
2276
+ schema:
2277
+ type: boolean
2278
+ default: false
2266
2279
  responses:
2267
2280
  '200':
2268
2281
  description: OK
@@ -2339,6 +2352,17 @@ paths:
2339
2352
  description: list clusters referenced by this cluster
2340
2353
  schema:
2341
2354
  type: string
2355
+ - name: endpointHost
2356
+ in: query
2357
+ description: Case-insensitive substring to match against the host part of cached cluster endpoints
2358
+ schema:
2359
+ type: string
2360
+ - name: includeEndpoints
2361
+ in: query
2362
+ description: Whether to include cached user-visible endpoints in each cluster item
2363
+ schema:
2364
+ type: boolean
2365
+ default: false
2342
2366
  responses:
2343
2367
  '200':
2344
2368
  description: A successful response.
@@ -10792,6 +10816,85 @@ paths:
10792
10816
  '404':
10793
10817
  $ref: '#/components/responses/404'
10794
10818
  x-codegen-request-body-name: body
10819
+ /admin/v1/environments/{environmentName}/loadbalancer/config:
10820
+ get:
10821
+ tags:
10822
+ - loadBalancer
10823
+ operationId: getLoadBalancerConfig
10824
+ summary: Get the effective load balancer configuration of an environment
10825
+ parameters:
10826
+ - name: environmentName
10827
+ in: path
10828
+ description: name of the environment
10829
+ required: true
10830
+ schema:
10831
+ type: string
10832
+ responses:
10833
+ '200':
10834
+ description: A successful response.
10835
+ content:
10836
+ application/json:
10837
+ schema:
10838
+ $ref: '#/components/schemas/loadBalancerConfig'
10839
+ '403':
10840
+ $ref: '#/components/responses/403'
10841
+ '404':
10842
+ $ref: '#/components/responses/404'
10843
+ put:
10844
+ tags:
10845
+ - loadBalancer
10846
+ operationId: updateLoadBalancerConfig
10847
+ summary: Save and immediately activate the load balancer configuration of an environment
10848
+ parameters:
10849
+ - name: environmentName
10850
+ in: path
10851
+ description: name of the environment
10852
+ required: true
10853
+ schema:
10854
+ type: string
10855
+ requestBody:
10856
+ required: true
10857
+ content:
10858
+ application/json:
10859
+ schema:
10860
+ $ref: '#/components/schemas/loadBalancerConfigUpdate'
10861
+ responses:
10862
+ '200':
10863
+ description: A successful response.
10864
+ content:
10865
+ application/json:
10866
+ schema:
10867
+ $ref: '#/components/schemas/loadBalancerConfig'
10868
+ '400':
10869
+ $ref: '#/components/responses/400'
10870
+ '403':
10871
+ $ref: '#/components/responses/403'
10872
+ '404':
10873
+ $ref: '#/components/responses/404'
10874
+ x-codegen-request-body-name: body
10875
+ delete:
10876
+ tags:
10877
+ - loadBalancer
10878
+ operationId: resetLoadBalancerConfig
10879
+ summary: Reset the environment load balancer configuration to the current provider defaults
10880
+ parameters:
10881
+ - name: environmentName
10882
+ in: path
10883
+ description: name of the environment
10884
+ required: true
10885
+ schema:
10886
+ type: string
10887
+ responses:
10888
+ '200':
10889
+ description: The effective provider defaults after reset.
10890
+ content:
10891
+ application/json:
10892
+ schema:
10893
+ $ref: '#/components/schemas/loadBalancerConfig'
10894
+ '403':
10895
+ $ref: '#/components/responses/403'
10896
+ '404':
10897
+ $ref: '#/components/responses/404'
10795
10898
  /admin/v1/environments/{environmentName}/loadbalancer/vipPool:
10796
10899
  get:
10797
10900
  operationId: listVIPPool
@@ -19496,11 +19599,792 @@ paths:
19496
19599
  content:
19497
19600
  application/json:
19498
19601
  schema:
19499
- $ref: '#/components/schemas/ESSecurityRoleDescriptor'
19602
+ $ref: '#/components/schemas/ESSecurityRoleDescriptor'
19603
+ responses:
19604
+ '204':
19605
+ content: {}
19606
+ description: Create or update Elasticsearch security role successfully.
19607
+ '400':
19608
+ $ref: '#/components/responses/400'
19609
+ '401':
19610
+ $ref: '#/components/responses/401'
19611
+ '403':
19612
+ $ref: '#/components/responses/403'
19613
+ '404':
19614
+ $ref: '#/components/responses/404'
19615
+ '500':
19616
+ $ref: '#/components/responses/500'
19617
+ x-codegen-request-body-name: body
19618
+ delete:
19619
+ tags:
19620
+ - elasticsearch
19621
+ - shared
19622
+ summary: Delete Elasticsearch security role
19623
+ operationId: deleteElasticsearchSecurityRole
19624
+ parameters:
19625
+ - name: orgName
19626
+ in: path
19627
+ required: true
19628
+ schema:
19629
+ type: string
19630
+ - name: clusterName
19631
+ in: path
19632
+ required: true
19633
+ schema:
19634
+ type: string
19635
+ - name: roleName
19636
+ in: path
19637
+ required: true
19638
+ schema:
19639
+ type: string
19640
+ responses:
19641
+ '204':
19642
+ content: {}
19643
+ description: Delete Elasticsearch security role successfully.
19644
+ '400':
19645
+ $ref: '#/components/responses/400'
19646
+ '401':
19647
+ $ref: '#/components/responses/401'
19648
+ '403':
19649
+ $ref: '#/components/responses/403'
19650
+ '404':
19651
+ $ref: '#/components/responses/404'
19652
+ '500':
19653
+ $ref: '#/components/responses/500'
19654
+ /admin/v1/data/elasticsearch/organizations/{orgName}/clusters/{clusterName}/accounts/role-mappings:
19655
+ get:
19656
+ tags:
19657
+ - elasticsearch
19658
+ - shared
19659
+ summary: List Elasticsearch security role mappings
19660
+ operationId: listElasticsearchSecurityRoleMappings
19661
+ parameters:
19662
+ - name: orgName
19663
+ in: path
19664
+ required: true
19665
+ schema:
19666
+ type: string
19667
+ - name: clusterName
19668
+ in: path
19669
+ required: true
19670
+ schema:
19671
+ type: string
19672
+ responses:
19673
+ '200':
19674
+ description: List Elasticsearch security role mappings successfully.
19675
+ content:
19676
+ application/json:
19677
+ schema:
19678
+ $ref: '#/components/schemas/ESSecurityRoleMappings'
19679
+ '400':
19680
+ $ref: '#/components/responses/400'
19681
+ '401':
19682
+ $ref: '#/components/responses/401'
19683
+ '403':
19684
+ $ref: '#/components/responses/403'
19685
+ '404':
19686
+ $ref: '#/components/responses/404'
19687
+ '500':
19688
+ $ref: '#/components/responses/500'
19689
+ /admin/v1/data/elasticsearch/organizations/{orgName}/clusters/{clusterName}/accounts/role-mappings/{mappingName}:
19690
+ get:
19691
+ tags:
19692
+ - elasticsearch
19693
+ - shared
19694
+ summary: Get Elasticsearch security role mapping
19695
+ operationId: getElasticsearchSecurityRoleMapping
19696
+ parameters:
19697
+ - name: orgName
19698
+ in: path
19699
+ required: true
19700
+ schema:
19701
+ type: string
19702
+ - name: clusterName
19703
+ in: path
19704
+ required: true
19705
+ schema:
19706
+ type: string
19707
+ - name: mappingName
19708
+ in: path
19709
+ required: true
19710
+ schema:
19711
+ type: string
19712
+ responses:
19713
+ '200':
19714
+ description: Get Elasticsearch security role mapping successfully.
19715
+ content:
19716
+ application/json:
19717
+ schema:
19718
+ $ref: '#/components/schemas/ESSecurityRoleMapping'
19719
+ '400':
19720
+ $ref: '#/components/responses/400'
19721
+ '401':
19722
+ $ref: '#/components/responses/401'
19723
+ '403':
19724
+ $ref: '#/components/responses/403'
19725
+ '404':
19726
+ $ref: '#/components/responses/404'
19727
+ '500':
19728
+ $ref: '#/components/responses/500'
19729
+ put:
19730
+ tags:
19731
+ - elasticsearch
19732
+ - shared
19733
+ summary: Create or update Elasticsearch security role mapping
19734
+ operationId: putElasticsearchSecurityRoleMapping
19735
+ parameters:
19736
+ - name: orgName
19737
+ in: path
19738
+ required: true
19739
+ schema:
19740
+ type: string
19741
+ - name: clusterName
19742
+ in: path
19743
+ required: true
19744
+ schema:
19745
+ type: string
19746
+ - name: mappingName
19747
+ in: path
19748
+ required: true
19749
+ schema:
19750
+ type: string
19751
+ requestBody:
19752
+ required: true
19753
+ content:
19754
+ application/json:
19755
+ schema:
19756
+ $ref: '#/components/schemas/ESSecurityRoleMapping'
19757
+ responses:
19758
+ '204':
19759
+ content: {}
19760
+ description: Create or update Elasticsearch security role mapping successfully.
19761
+ '400':
19762
+ $ref: '#/components/responses/400'
19763
+ '401':
19764
+ $ref: '#/components/responses/401'
19765
+ '403':
19766
+ $ref: '#/components/responses/403'
19767
+ '404':
19768
+ $ref: '#/components/responses/404'
19769
+ '500':
19770
+ $ref: '#/components/responses/500'
19771
+ x-codegen-request-body-name: body
19772
+ delete:
19773
+ tags:
19774
+ - elasticsearch
19775
+ - shared
19776
+ summary: Delete Elasticsearch security role mapping
19777
+ operationId: deleteElasticsearchSecurityRoleMapping
19778
+ parameters:
19779
+ - name: orgName
19780
+ in: path
19781
+ required: true
19782
+ schema:
19783
+ type: string
19784
+ - name: clusterName
19785
+ in: path
19786
+ required: true
19787
+ schema:
19788
+ type: string
19789
+ - name: mappingName
19790
+ in: path
19791
+ required: true
19792
+ schema:
19793
+ type: string
19794
+ responses:
19795
+ '204':
19796
+ content: {}
19797
+ description: Delete Elasticsearch security role mapping successfully.
19798
+ '400':
19799
+ $ref: '#/components/responses/400'
19800
+ '401':
19801
+ $ref: '#/components/responses/401'
19802
+ '403':
19803
+ $ref: '#/components/responses/403'
19804
+ '404':
19805
+ $ref: '#/components/responses/404'
19806
+ '500':
19807
+ $ref: '#/components/responses/500'
19808
+ /admin/v1/data/elasticsearch/organizations/{orgName}/clusters/{clusterName}/accounts/privileges/builtin:
19809
+ get:
19810
+ tags:
19811
+ - elasticsearch
19812
+ - shared
19813
+ summary: Get Elasticsearch builtin privileges
19814
+ operationId: getElasticsearchBuiltinPrivileges
19815
+ parameters:
19816
+ - name: orgName
19817
+ in: path
19818
+ required: true
19819
+ schema:
19820
+ type: string
19821
+ - name: clusterName
19822
+ in: path
19823
+ required: true
19824
+ schema:
19825
+ type: string
19826
+ responses:
19827
+ '200':
19828
+ description: Get Elasticsearch builtin privileges successfully.
19829
+ content:
19830
+ application/json:
19831
+ schema:
19832
+ $ref: '#/components/schemas/ESBuiltinPrivileges'
19833
+ '400':
19834
+ $ref: '#/components/responses/400'
19835
+ '401':
19836
+ $ref: '#/components/responses/401'
19837
+ '403':
19838
+ $ref: '#/components/responses/403'
19839
+ '404':
19840
+ $ref: '#/components/responses/404'
19841
+ '500':
19842
+ $ref: '#/components/responses/500'
19843
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts:
19844
+ get:
19845
+ tags:
19846
+ - clickhouse
19847
+ - shared
19848
+ summary: List ClickHouse accounts
19849
+ operationId: listClickhouseAccounts
19850
+ parameters:
19851
+ - name: orgName
19852
+ in: path
19853
+ required: true
19854
+ schema:
19855
+ type: string
19856
+ - name: clusterName
19857
+ in: path
19858
+ required: true
19859
+ schema:
19860
+ type: string
19861
+ responses:
19862
+ '200':
19863
+ description: List ClickHouse accounts successfully.
19864
+ content:
19865
+ application/json:
19866
+ schema:
19867
+ $ref: '#/components/schemas/CkAccount'
19868
+ '400':
19869
+ $ref: '#/components/responses/400'
19870
+ '401':
19871
+ $ref: '#/components/responses/401'
19872
+ '403':
19873
+ $ref: '#/components/responses/403'
19874
+ '404':
19875
+ $ref: '#/components/responses/404'
19876
+ '500':
19877
+ $ref: '#/components/responses/500'
19878
+ post:
19879
+ tags:
19880
+ - clickhouse
19881
+ - shared
19882
+ summary: Create a ClickHouse account with optional roles
19883
+ operationId: createClickhouseAccount
19884
+ parameters:
19885
+ - name: orgName
19886
+ in: path
19887
+ required: true
19888
+ schema:
19889
+ type: string
19890
+ - name: clusterName
19891
+ in: path
19892
+ required: true
19893
+ schema:
19894
+ type: string
19895
+ requestBody:
19896
+ required: true
19897
+ content:
19898
+ application/json:
19899
+ schema:
19900
+ type: object
19901
+ description: Create a ClickHouse account request.
19902
+ required:
19903
+ - name
19904
+ - password
19905
+ properties:
19906
+ name:
19907
+ type: string
19908
+ description: The account (user) name.
19909
+ password:
19910
+ type: string
19911
+ description: The account password.
19912
+ roles:
19913
+ type: array
19914
+ description: Roles to grant to the account on creation.
19915
+ items:
19916
+ type: string
19917
+ responses:
19918
+ '204':
19919
+ content: {}
19920
+ description: Create ClickHouse account successfully.
19921
+ '400':
19922
+ $ref: '#/components/responses/400'
19923
+ '401':
19924
+ $ref: '#/components/responses/401'
19925
+ '403':
19926
+ $ref: '#/components/responses/403'
19927
+ '404':
19928
+ $ref: '#/components/responses/404'
19929
+ '500':
19930
+ $ref: '#/components/responses/500'
19931
+ x-codegen-request-body-name: body
19932
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}:
19933
+ patch:
19934
+ tags:
19935
+ - clickhouse
19936
+ - shared
19937
+ summary: Update a ClickHouse account password
19938
+ operationId: updateClickhouseAccountPassword
19939
+ parameters:
19940
+ - name: orgName
19941
+ in: path
19942
+ required: true
19943
+ schema:
19944
+ type: string
19945
+ - name: clusterName
19946
+ in: path
19947
+ required: true
19948
+ schema:
19949
+ type: string
19950
+ - name: accountName
19951
+ in: path
19952
+ required: true
19953
+ schema:
19954
+ type: string
19955
+ requestBody:
19956
+ required: true
19957
+ content:
19958
+ application/json:
19959
+ schema:
19960
+ type: object
19961
+ description: Update a ClickHouse account password request.
19962
+ required:
19963
+ - password
19964
+ properties:
19965
+ password:
19966
+ type: string
19967
+ description: The new account password.
19968
+ responses:
19969
+ '204':
19970
+ content: {}
19971
+ description: Update ClickHouse account password successfully.
19972
+ '400':
19973
+ $ref: '#/components/responses/400'
19974
+ '401':
19975
+ $ref: '#/components/responses/401'
19976
+ '403':
19977
+ $ref: '#/components/responses/403'
19978
+ '404':
19979
+ $ref: '#/components/responses/404'
19980
+ '500':
19981
+ $ref: '#/components/responses/500'
19982
+ x-codegen-request-body-name: body
19983
+ delete:
19984
+ tags:
19985
+ - clickhouse
19986
+ - shared
19987
+ summary: Delete a ClickHouse account
19988
+ operationId: deleteClickhouseAccount
19989
+ parameters:
19990
+ - name: orgName
19991
+ in: path
19992
+ required: true
19993
+ schema:
19994
+ type: string
19995
+ - name: clusterName
19996
+ in: path
19997
+ required: true
19998
+ schema:
19999
+ type: string
20000
+ - name: accountName
20001
+ in: path
20002
+ required: true
20003
+ schema:
20004
+ type: string
20005
+ responses:
20006
+ '204':
20007
+ content: {}
20008
+ description: Delete ClickHouse account successfully.
20009
+ '400':
20010
+ $ref: '#/components/responses/400'
20011
+ '401':
20012
+ $ref: '#/components/responses/401'
20013
+ '403':
20014
+ $ref: '#/components/responses/403'
20015
+ '404':
20016
+ $ref: '#/components/responses/404'
20017
+ '500':
20018
+ $ref: '#/components/responses/500'
20019
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/roles:
20020
+ get:
20021
+ tags:
20022
+ - clickhouse
20023
+ - shared
20024
+ summary: List the roles granted to a ClickHouse account
20025
+ operationId: listClickhouseAccountRoles
20026
+ parameters:
20027
+ - name: orgName
20028
+ in: path
20029
+ required: true
20030
+ schema:
20031
+ type: string
20032
+ - name: clusterName
20033
+ in: path
20034
+ required: true
20035
+ schema:
20036
+ type: string
20037
+ - name: accountName
20038
+ in: path
20039
+ required: true
20040
+ schema:
20041
+ type: string
20042
+ responses:
20043
+ '200':
20044
+ description: List ClickHouse account roles successfully.
20045
+ content:
20046
+ application/json:
20047
+ schema:
20048
+ type: object
20049
+ description: A ClickHouse role.
20050
+ properties:
20051
+ name:
20052
+ type: string
20053
+ description: The role name.
20054
+ privileges:
20055
+ type: array
20056
+ description: Privileges granted to the role, grouped by scope.
20057
+ items:
20058
+ type: object
20059
+ description: A group of privileges granted on a scope.
20060
+ properties:
20061
+ scope:
20062
+ type: string
20063
+ description: The ON-clause operand of the grant, e.g. "db.*" or "*.*".
20064
+ privileges:
20065
+ type: array
20066
+ items:
20067
+ type: string
20068
+ '400':
20069
+ $ref: '#/components/responses/400'
20070
+ '401':
20071
+ $ref: '#/components/responses/401'
20072
+ '403':
20073
+ $ref: '#/components/responses/403'
20074
+ '404':
20075
+ $ref: '#/components/responses/404'
20076
+ '500':
20077
+ $ref: '#/components/responses/500'
20078
+ put:
20079
+ tags:
20080
+ - clickhouse
20081
+ - shared
20082
+ summary: Update the roles granted to a ClickHouse account
20083
+ operationId: updateClickhouseAccountRoles
20084
+ parameters:
20085
+ - name: orgName
20086
+ in: path
20087
+ required: true
20088
+ schema:
20089
+ type: string
20090
+ - name: clusterName
20091
+ in: path
20092
+ required: true
20093
+ schema:
20094
+ type: string
20095
+ - name: accountName
20096
+ in: path
20097
+ required: true
20098
+ schema:
20099
+ type: string
20100
+ requestBody:
20101
+ required: true
20102
+ content:
20103
+ application/json:
20104
+ schema:
20105
+ type: object
20106
+ description: Update the roles granted to a ClickHouse account request.
20107
+ required:
20108
+ - roles
20109
+ properties:
20110
+ roles:
20111
+ type: array
20112
+ description: The full set of roles to grant to the account. Existing roles are replaced.
20113
+ items:
20114
+ type: string
20115
+ responses:
20116
+ '204':
20117
+ content: {}
20118
+ description: Update ClickHouse account roles successfully.
20119
+ '400':
20120
+ $ref: '#/components/responses/400'
20121
+ '401':
20122
+ $ref: '#/components/responses/401'
20123
+ '403':
20124
+ $ref: '#/components/responses/403'
20125
+ '404':
20126
+ $ref: '#/components/responses/404'
20127
+ '500':
20128
+ $ref: '#/components/responses/500'
20129
+ x-codegen-request-body-name: body
20130
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts/roles:
20131
+ get:
20132
+ tags:
20133
+ - clickhouse
20134
+ - shared
20135
+ summary: List ClickHouse roles
20136
+ operationId: listClickhouseRoles
20137
+ parameters:
20138
+ - name: orgName
20139
+ in: path
20140
+ required: true
20141
+ schema:
20142
+ type: string
20143
+ - name: clusterName
20144
+ in: path
20145
+ required: true
20146
+ schema:
20147
+ type: string
20148
+ - name: forCreateUser
20149
+ in: query
20150
+ required: false
20151
+ description: Whether to include built-in privilege roles for creating an account.
20152
+ schema:
20153
+ type: boolean
20154
+ responses:
20155
+ '200':
20156
+ description: List ClickHouse roles successfully.
20157
+ content:
20158
+ application/json:
20159
+ schema:
20160
+ type: array
20161
+ description: List of ClickHouse roles.
20162
+ items:
20163
+ type: object
20164
+ description: A ClickHouse role.
20165
+ properties:
20166
+ name:
20167
+ type: string
20168
+ description: The role name.
20169
+ privileges:
20170
+ type: array
20171
+ description: Privileges granted to the role, grouped by scope.
20172
+ items:
20173
+ type: object
20174
+ description: A group of privileges granted on a scope.
20175
+ properties:
20176
+ scope:
20177
+ type: string
20178
+ description: The ON-clause operand of the grant, e.g. "db.*" or "*.*".
20179
+ privileges:
20180
+ type: array
20181
+ items:
20182
+ type: string
20183
+ '400':
20184
+ $ref: '#/components/responses/400'
20185
+ '401':
20186
+ $ref: '#/components/responses/401'
20187
+ '403':
20188
+ $ref: '#/components/responses/403'
20189
+ '404':
20190
+ $ref: '#/components/responses/404'
20191
+ '500':
20192
+ $ref: '#/components/responses/500'
20193
+ post:
20194
+ tags:
20195
+ - clickhouse
20196
+ - shared
20197
+ summary: Create a ClickHouse role with privileges
20198
+ operationId: createClickhouseRole
20199
+ parameters:
20200
+ - name: orgName
20201
+ in: path
20202
+ required: true
20203
+ schema:
20204
+ type: string
20205
+ - name: clusterName
20206
+ in: path
20207
+ required: true
20208
+ schema:
20209
+ type: string
20210
+ requestBody:
20211
+ required: true
20212
+ content:
20213
+ application/json:
20214
+ schema:
20215
+ type: object
20216
+ description: A ClickHouse role.
20217
+ properties:
20218
+ name:
20219
+ type: string
20220
+ description: The role name.
20221
+ privileges:
20222
+ type: array
20223
+ description: Privileges granted to the role, grouped by scope.
20224
+ items:
20225
+ type: object
20226
+ description: A group of privileges granted on a scope.
20227
+ properties:
20228
+ scope:
20229
+ type: string
20230
+ description: The ON-clause operand of the grant, e.g. "db.*" or "*.*".
20231
+ privileges:
20232
+ type: array
20233
+ items:
20234
+ type: string
20235
+ responses:
20236
+ '204':
20237
+ content: {}
20238
+ description: Create ClickHouse role successfully.
20239
+ '400':
20240
+ $ref: '#/components/responses/400'
20241
+ '401':
20242
+ $ref: '#/components/responses/401'
20243
+ '403':
20244
+ $ref: '#/components/responses/403'
20245
+ '404':
20246
+ $ref: '#/components/responses/404'
20247
+ '500':
20248
+ $ref: '#/components/responses/500'
20249
+ x-codegen-request-body-name: body
20250
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts/roles/{roleName}:
20251
+ get:
20252
+ tags:
20253
+ - clickhouse
20254
+ - shared
20255
+ summary: Get the grants (privileges) of a ClickHouse role
20256
+ operationId: getClickhouseRoleGrants
20257
+ parameters:
20258
+ - name: orgName
20259
+ in: path
20260
+ required: true
20261
+ schema:
20262
+ type: string
20263
+ - name: clusterName
20264
+ in: path
20265
+ required: true
20266
+ schema:
20267
+ type: string
20268
+ - name: roleName
20269
+ in: path
20270
+ required: true
20271
+ schema:
20272
+ type: string
20273
+ responses:
20274
+ '200':
20275
+ description: Get ClickHouse role grants successfully.
20276
+ content:
20277
+ application/json:
20278
+ schema:
20279
+ type: array
20280
+ description: Grants (privileges) of a ClickHouse role.
20281
+ items:
20282
+ type: object
20283
+ description: A single grant of a ClickHouse role.
20284
+ properties:
20285
+ accessType:
20286
+ type: string
20287
+ description: The access type of the grant.
20288
+ database:
20289
+ type: string
20290
+ description: The database of the grant scope.
20291
+ table:
20292
+ type: string
20293
+ description: The table of the grant scope.
20294
+ scope:
20295
+ type: string
20296
+ description: The full grant scope, e.g. "db.*".
20297
+ isPartialRevoke:
20298
+ type: boolean
20299
+ description: Whether the grant is a partial revoke.
20300
+ '400':
20301
+ $ref: '#/components/responses/400'
20302
+ '401':
20303
+ $ref: '#/components/responses/401'
20304
+ '403':
20305
+ $ref: '#/components/responses/403'
20306
+ '404':
20307
+ $ref: '#/components/responses/404'
20308
+ '500':
20309
+ $ref: '#/components/responses/500'
20310
+ delete:
20311
+ tags:
20312
+ - clickhouse
20313
+ - shared
20314
+ summary: Delete a ClickHouse role
20315
+ operationId: deleteClickhouseRole
20316
+ parameters:
20317
+ - name: orgName
20318
+ in: path
20319
+ required: true
20320
+ schema:
20321
+ type: string
20322
+ - name: clusterName
20323
+ in: path
20324
+ required: true
20325
+ schema:
20326
+ type: string
20327
+ - name: roleName
20328
+ in: path
20329
+ required: true
20330
+ schema:
20331
+ type: string
20332
+ responses:
20333
+ '204':
20334
+ content: {}
20335
+ description: Delete ClickHouse role successfully.
20336
+ '400':
20337
+ $ref: '#/components/responses/400'
20338
+ '401':
20339
+ $ref: '#/components/responses/401'
20340
+ '403':
20341
+ $ref: '#/components/responses/403'
20342
+ '404':
20343
+ $ref: '#/components/responses/404'
20344
+ '500':
20345
+ $ref: '#/components/responses/500'
20346
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts/roles/{roleName}/privileges:
20347
+ post:
20348
+ tags:
20349
+ - clickhouse
20350
+ - shared
20351
+ summary: Grant privileges to a ClickHouse role
20352
+ operationId: grantClickhouseRolePrivileges
20353
+ parameters:
20354
+ - name: orgName
20355
+ in: path
20356
+ required: true
20357
+ schema:
20358
+ type: string
20359
+ - name: clusterName
20360
+ in: path
20361
+ required: true
20362
+ schema:
20363
+ type: string
20364
+ - name: roleName
20365
+ in: path
20366
+ required: true
20367
+ schema:
20368
+ type: string
20369
+ requestBody:
20370
+ required: true
20371
+ content:
20372
+ application/json:
20373
+ schema:
20374
+ type: object
20375
+ description: A group of privileges granted on a scope.
20376
+ properties:
20377
+ scope:
20378
+ type: string
20379
+ description: The ON-clause operand of the grant, e.g. "db.*" or "*.*".
20380
+ privileges:
20381
+ type: array
20382
+ items:
20383
+ type: string
19500
20384
  responses:
19501
20385
  '204':
19502
20386
  content: {}
19503
- description: Create or update Elasticsearch security role successfully.
20387
+ description: Grant ClickHouse role privileges successfully.
19504
20388
  '400':
19505
20389
  $ref: '#/components/responses/400'
19506
20390
  '401':
@@ -19514,10 +20398,10 @@ paths:
19514
20398
  x-codegen-request-body-name: body
19515
20399
  delete:
19516
20400
  tags:
19517
- - elasticsearch
20401
+ - clickhouse
19518
20402
  - shared
19519
- summary: Delete Elasticsearch security role
19520
- operationId: deleteElasticsearchSecurityRole
20403
+ summary: Revoke privileges from a ClickHouse role
20404
+ operationId: revokeClickhouseRolePrivileges
19521
20405
  parameters:
19522
20406
  - name: orgName
19523
20407
  in: path
@@ -19534,127 +20418,31 @@ paths:
19534
20418
  required: true
19535
20419
  schema:
19536
20420
  type: string
19537
- responses:
19538
- '204':
19539
- content: {}
19540
- description: Delete Elasticsearch security role successfully.
19541
- '400':
19542
- $ref: '#/components/responses/400'
19543
- '401':
19544
- $ref: '#/components/responses/401'
19545
- '403':
19546
- $ref: '#/components/responses/403'
19547
- '404':
19548
- $ref: '#/components/responses/404'
19549
- '500':
19550
- $ref: '#/components/responses/500'
19551
- /admin/v1/data/elasticsearch/organizations/{orgName}/clusters/{clusterName}/accounts/role-mappings:
19552
- get:
19553
- tags:
19554
- - elasticsearch
19555
- - shared
19556
- summary: List Elasticsearch security role mappings
19557
- operationId: listElasticsearchSecurityRoleMappings
19558
- parameters:
19559
- - name: orgName
19560
- in: path
19561
- required: true
19562
- schema:
19563
- type: string
19564
- - name: clusterName
19565
- in: path
19566
- required: true
19567
- schema:
19568
- type: string
19569
- responses:
19570
- '200':
19571
- description: List Elasticsearch security role mappings successfully.
19572
- content:
19573
- application/json:
19574
- schema:
19575
- $ref: '#/components/schemas/ESSecurityRoleMappings'
19576
- '400':
19577
- $ref: '#/components/responses/400'
19578
- '401':
19579
- $ref: '#/components/responses/401'
19580
- '403':
19581
- $ref: '#/components/responses/403'
19582
- '404':
19583
- $ref: '#/components/responses/404'
19584
- '500':
19585
- $ref: '#/components/responses/500'
19586
- /admin/v1/data/elasticsearch/organizations/{orgName}/clusters/{clusterName}/accounts/role-mappings/{mappingName}:
19587
- get:
19588
- tags:
19589
- - elasticsearch
19590
- - shared
19591
- summary: Get Elasticsearch security role mapping
19592
- operationId: getElasticsearchSecurityRoleMapping
19593
- parameters:
19594
- - name: orgName
19595
- in: path
19596
- required: true
19597
- schema:
19598
- type: string
19599
- - name: clusterName
19600
- in: path
19601
- required: true
19602
- schema:
19603
- type: string
19604
- - name: mappingName
19605
- in: path
19606
- required: true
19607
- schema:
19608
- type: string
19609
- responses:
19610
- '200':
19611
- description: Get Elasticsearch security role mapping successfully.
19612
- content:
19613
- application/json:
19614
- schema:
19615
- $ref: '#/components/schemas/ESSecurityRoleMapping'
19616
- '400':
19617
- $ref: '#/components/responses/400'
19618
- '401':
19619
- $ref: '#/components/responses/401'
19620
- '403':
19621
- $ref: '#/components/responses/403'
19622
- '404':
19623
- $ref: '#/components/responses/404'
19624
- '500':
19625
- $ref: '#/components/responses/500'
19626
- put:
19627
- tags:
19628
- - elasticsearch
19629
- - shared
19630
- summary: Create or update Elasticsearch security role mapping
19631
- operationId: putElasticsearchSecurityRoleMapping
19632
- parameters:
19633
- - name: orgName
19634
- in: path
19635
- required: true
19636
- schema:
19637
- type: string
19638
- - name: clusterName
19639
- in: path
19640
- required: true
19641
- schema:
19642
- type: string
19643
- - name: mappingName
19644
- in: path
19645
- required: true
19646
- schema:
19647
- type: string
19648
20421
  requestBody:
19649
20422
  required: true
19650
20423
  content:
19651
20424
  application/json:
19652
20425
  schema:
19653
- $ref: '#/components/schemas/ESSecurityRoleMapping'
20426
+ type: object
20427
+ description: Revoke privileges from a role request.
20428
+ required:
20429
+ - privileges
20430
+ properties:
20431
+ privileges:
20432
+ type: array
20433
+ items:
20434
+ type: object
20435
+ description: A single privilege granted on a scope.
20436
+ properties:
20437
+ scope:
20438
+ type: string
20439
+ description: The ON-clause operand of the grant, e.g. "db.*" or "*.*".
20440
+ privilege:
20441
+ type: string
19654
20442
  responses:
19655
20443
  '204':
19656
20444
  content: {}
19657
- description: Create or update Elasticsearch security role mapping successfully.
20445
+ description: Revoke ClickHouse role privileges successfully.
19658
20446
  '400':
19659
20447
  $ref: '#/components/responses/400'
19660
20448
  '401':
@@ -19666,49 +20454,13 @@ paths:
19666
20454
  '500':
19667
20455
  $ref: '#/components/responses/500'
19668
20456
  x-codegen-request-body-name: body
19669
- delete:
19670
- tags:
19671
- - elasticsearch
19672
- - shared
19673
- summary: Delete Elasticsearch security role mapping
19674
- operationId: deleteElasticsearchSecurityRoleMapping
19675
- parameters:
19676
- - name: orgName
19677
- in: path
19678
- required: true
19679
- schema:
19680
- type: string
19681
- - name: clusterName
19682
- in: path
19683
- required: true
19684
- schema:
19685
- type: string
19686
- - name: mappingName
19687
- in: path
19688
- required: true
19689
- schema:
19690
- type: string
19691
- responses:
19692
- '204':
19693
- content: {}
19694
- description: Delete Elasticsearch security role mapping successfully.
19695
- '400':
19696
- $ref: '#/components/responses/400'
19697
- '401':
19698
- $ref: '#/components/responses/401'
19699
- '403':
19700
- $ref: '#/components/responses/403'
19701
- '404':
19702
- $ref: '#/components/responses/404'
19703
- '500':
19704
- $ref: '#/components/responses/500'
19705
- /admin/v1/data/elasticsearch/organizations/{orgName}/clusters/{clusterName}/accounts/privileges/builtin:
20457
+ /admin/v1/data/clickhouse/organizations/{orgName}/clusters/{clusterName}/accounts/privileges:
19706
20458
  get:
19707
20459
  tags:
19708
- - elasticsearch
20460
+ - clickhouse
19709
20461
  - shared
19710
- summary: Get Elasticsearch builtin privileges
19711
- operationId: getElasticsearchBuiltinPrivileges
20462
+ summary: List privileges supported by the ClickHouse server
20463
+ operationId: listClickhousePrivileges
19712
20464
  parameters:
19713
20465
  - name: orgName
19714
20466
  in: path
@@ -19722,11 +20474,14 @@ paths:
19722
20474
  type: string
19723
20475
  responses:
19724
20476
  '200':
19725
- description: Get Elasticsearch builtin privileges successfully.
20477
+ description: List ClickHouse privileges successfully.
19726
20478
  content:
19727
20479
  application/json:
19728
20480
  schema:
19729
- $ref: '#/components/schemas/ESBuiltinPrivileges'
20481
+ type: array
20482
+ description: All privileges supported by the ClickHouse server.
20483
+ items:
20484
+ type: string
19730
20485
  '400':
19731
20486
  $ref: '#/components/responses/400'
19732
20487
  '401':
@@ -25629,6 +26384,88 @@ components:
25629
26384
  - Normal
25630
26385
  - DisasterRecovery
25631
26386
  - BlueGreenDeployment
26387
+ tag:
26388
+ description: tag info
26389
+ properties:
26390
+ id:
26391
+ description: The id of the tag
26392
+ format: int64
26393
+ type: string
26394
+ key:
26395
+ description: the key of the tag
26396
+ type: string
26397
+ value:
26398
+ description: The value corresponding to the key
26399
+ type: string
26400
+ required:
26401
+ - id
26402
+ type: object
26403
+ endpointType:
26404
+ description: Type of endpoint
26405
+ type: string
26406
+ enum:
26407
+ - ClusterIP
26408
+ - NodePort
26409
+ - LoadBalancer
26410
+ - PodIP
26411
+ - HostNetwork
26412
+ - PodFQDN
26413
+ endpointNetworkType:
26414
+ description: Network type of endpoint
26415
+ type: string
26416
+ enum:
26417
+ - Internet
26418
+ - Intranet
26419
+ endpoint:
26420
+ description: Endpoint is the information of cluster endpoints
26421
+ properties:
26422
+ title:
26423
+ description: title of the endpoint
26424
+ type: string
26425
+ component:
26426
+ description: Component type name
26427
+ type: string
26428
+ hosts:
26429
+ description: Endpoint hosts
26430
+ type: array
26431
+ items:
26432
+ type: string
26433
+ port:
26434
+ description: Endpoint port
26435
+ type: integer
26436
+ format: int32
26437
+ type:
26438
+ $ref: '#/components/schemas/endpointType'
26439
+ networkType:
26440
+ $ref: '#/components/schemas/endpointNetworkType'
26441
+ serviceName:
26442
+ description: Service name of endpoint
26443
+ type: string
26444
+ podService:
26445
+ description: Pod service name of endpoint
26446
+ type: boolean
26447
+ portName:
26448
+ description: Port name of endpoint
26449
+ type: string
26450
+ instances:
26451
+ description: Endpoint backend instances
26452
+ type: array
26453
+ items:
26454
+ type: string
26455
+ mutable:
26456
+ description: Whether the endpoint is mutable
26457
+ type: boolean
26458
+ required:
26459
+ - title
26460
+ - component
26461
+ - hosts
26462
+ - port
26463
+ - type
26464
+ - networkType
26465
+ - serviceName
26466
+ - portName
26467
+ - mutable
26468
+ type: object
25632
26469
  clusterListItem:
25633
26470
  description: KubeBlocks cluster information
25634
26471
  properties:
@@ -25735,6 +26572,20 @@ components:
25735
26572
  orgName:
25736
26573
  description: Org Name
25737
26574
  type: string
26575
+ project:
26576
+ description: Name of project, it is the alias of environment namespace
26577
+ type: string
26578
+ tags:
26579
+ description: Tags bound to the cluster
26580
+ items:
26581
+ $ref: '#/components/schemas/tag'
26582
+ type: array
26583
+ endpoints:
26584
+ description: Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
26585
+ items:
26586
+ $ref: '#/components/schemas/endpoint'
26587
+ type: array
26588
+ x-omitempty: true
25738
26589
  required:
25739
26590
  - cloudProvider
25740
26591
  - createdAt
@@ -26716,72 +27567,6 @@ components:
26716
27567
  log:
26717
27568
  type: string
26718
27569
  description: log is the log of the specified container
26719
- endpointType:
26720
- description: Type of endpoint
26721
- type: string
26722
- enum:
26723
- - ClusterIP
26724
- - NodePort
26725
- - LoadBalancer
26726
- - PodIP
26727
- - HostNetwork
26728
- - PodFQDN
26729
- endpointNetworkType:
26730
- description: Network type of endpoint
26731
- type: string
26732
- enum:
26733
- - Internet
26734
- - Intranet
26735
- endpoint:
26736
- description: Endpoint is the information of cluster endpoints
26737
- properties:
26738
- title:
26739
- description: title of the endpoint
26740
- type: string
26741
- component:
26742
- description: Component type name
26743
- type: string
26744
- hosts:
26745
- description: Endpoint hosts
26746
- type: array
26747
- items:
26748
- type: string
26749
- port:
26750
- description: Endpoint port
26751
- type: integer
26752
- format: int32
26753
- type:
26754
- $ref: '#/components/schemas/endpointType'
26755
- networkType:
26756
- $ref: '#/components/schemas/endpointNetworkType'
26757
- serviceName:
26758
- description: Service name of endpoint
26759
- type: string
26760
- podService:
26761
- description: Pod service name of endpoint
26762
- type: boolean
26763
- portName:
26764
- description: Port name of endpoint
26765
- type: string
26766
- instances:
26767
- description: Endpoint backend instances
26768
- type: array
26769
- items:
26770
- type: string
26771
- mutable:
26772
- description: Whether the endpoint is mutable
26773
- type: boolean
26774
- required:
26775
- - title
26776
- - component
26777
- - hosts
26778
- - port
26779
- - type
26780
- - networkType
26781
- - serviceName
26782
- - portName
26783
- - mutable
26784
- type: object
26785
27570
  endpointList:
26786
27571
  required:
26787
27572
  - items
@@ -26868,22 +27653,6 @@ components:
26868
27653
  taskId:
26869
27654
  type: string
26870
27655
  description: Task ID if the operation is asynchronous (e.g. reconfigure)
26871
- tag:
26872
- description: tag info
26873
- properties:
26874
- id:
26875
- description: The id of the tag
26876
- format: int64
26877
- type: string
26878
- key:
26879
- description: the key of the tag
26880
- type: string
26881
- value:
26882
- description: The value corresponding to the key
26883
- type: string
26884
- required:
26885
- - id
26886
- type: object
26887
27656
  clusterTags:
26888
27657
  properties:
26889
27658
  clusterId:
@@ -27006,7 +27775,9 @@ components:
27006
27775
  type: array
27007
27776
  items:
27008
27777
  type: array
27009
- items: {}
27778
+ items:
27779
+ type: object
27780
+ additionalProperties: true
27010
27781
  nullable: true
27011
27782
  clusterStorageUsageHistoryPoint:
27012
27783
  type: object
@@ -31719,6 +32490,12 @@ components:
31719
32490
  type: array
31720
32491
  items:
31721
32492
  type: string
32493
+ systemComponentSchedulerPolicy:
32494
+ type: string
32495
+ enum:
32496
+ - default
32497
+ - koordinator
32498
+ default: default
31722
32499
  schedulingConfig:
31723
32500
  type: object
31724
32501
  title: SchedulingConfig
@@ -31728,6 +32505,13 @@ components:
31728
32505
  $ref: '#/components/schemas/clusterSchedulingPolicy'
31729
32506
  tolerateDefaultTaints:
31730
32507
  $ref: '#/components/schemas/tolerateDefaultTaints'
32508
+ systemComponentSchedulerPolicy:
32509
+ $ref: '#/components/schemas/systemComponentSchedulerPolicy'
32510
+ description: Scheduler policy used by internal system component clusters, including MinIO, VictoriaMetrics, and Victoria Logs. The persisted policy is resolved to the current scheduler name when a component is created.
32511
+ systemComponentReservationResourceClass:
32512
+ nullable: true
32513
+ $ref: '#/components/schemas/koordinatorReservationResourceClass'
32514
+ description: Optional Reservation resource class used by internal system component clusters when the Koordinator scheduler is selected. No Reservation label is added unless the user explicitly selects a resource class. The value is persisted on the environment.
31731
32515
  networkConfig:
31732
32516
  type: object
31733
32517
  title: NetworkConfig
@@ -32040,6 +32824,12 @@ components:
32040
32824
  $ref: '#/components/schemas/nodePool'
32041
32825
  storage:
32042
32826
  $ref: '#/components/schemas/storageConfig'
32827
+ victoriaMetrics:
32828
+ description: Optional vm-storage spec (replicas, disk, classCode) when adding an environment. vm-insert and vm-select keep installer defaults.
32829
+ $ref: '#/components/schemas/staticCluster'
32830
+ victoriaLogs:
32831
+ description: Optional vlstorage spec (replicas, disk, classCode) when adding an environment. vlinsert and vlselect keep installer defaults.
32832
+ $ref: '#/components/schemas/staticCluster'
32043
32833
  modules:
32044
32834
  type: array
32045
32835
  description: option modules of environment
@@ -32905,6 +33695,43 @@ components:
32905
33695
  required:
32906
33696
  - status
32907
33697
  type: object
33698
+ loadBalancerAnnotations:
33699
+ description: Provider-neutral annotations applied to load balancer Services by exposure type.
33700
+ type: object
33701
+ properties:
33702
+ vpc:
33703
+ description: Annotations used for load balancers exposed inside the VPC.
33704
+ type: object
33705
+ additionalProperties:
33706
+ type: string
33707
+ internet:
33708
+ description: Annotations used for load balancers exposed to the Internet.
33709
+ type: object
33710
+ additionalProperties:
33711
+ type: string
33712
+ required:
33713
+ - vpc
33714
+ - internet
33715
+ loadBalancerConfig:
33716
+ description: Effective load balancer annotations for an environment.
33717
+ type: object
33718
+ properties:
33719
+ provider:
33720
+ description: Current environment provider returned by the server.
33721
+ type: string
33722
+ annotations:
33723
+ $ref: '#/components/schemas/loadBalancerAnnotations'
33724
+ required:
33725
+ - provider
33726
+ - annotations
33727
+ loadBalancerConfigUpdate:
33728
+ description: Complete editable load balancer annotations for an environment.
33729
+ type: object
33730
+ properties:
33731
+ annotations:
33732
+ $ref: '#/components/schemas/loadBalancerAnnotations'
33733
+ required:
33734
+ - annotations
32908
33735
  vipPool:
32909
33736
  description: VIP Pool
32910
33737
  properties:
@@ -36603,6 +37430,11 @@ components:
36603
37430
  objectExcludeTips:
36604
37431
  $ref: '#/components/schemas/internationalDesc'
36605
37432
  nullable: true
37433
+ replicationCheckOption:
37434
+ type: object
37435
+ properties:
37436
+ enabled:
37437
+ type: boolean
36606
37438
  parameterValueType:
36607
37439
  enum:
36608
37440
  - string
@@ -36659,6 +37491,8 @@ components:
36659
37491
  type: array
36660
37492
  items:
36661
37493
  type: string
37494
+ dataCheckOption:
37495
+ $ref: '#/components/schemas/replicationCheckOption'
36662
37496
  parameterTemplate:
36663
37497
  description: the parameter template of the engine mapping, has a higher priority than the parameterTemplate in standardDefinition
36664
37498
  $ref: '#/components/schemas/dataChannelParameterOption'
@@ -38798,7 +39632,9 @@ components:
38798
39632
  description: The value options of the parameter
38799
39633
  type: array
38800
39634
  x-omitempty: false
38801
- items: {}
39635
+ items:
39636
+ type: object
39637
+ additionalProperties: true
38802
39638
  maximum:
38803
39639
  description: The maximum value of the parameter
38804
39640
  type: string
@@ -40679,6 +41515,35 @@ components:
40679
41515
  type: array
40680
41516
  items:
40681
41517
  type: string
41518
+ CkAccountType:
41519
+ type: string
41520
+ description: The account role type.
41521
+ enum:
41522
+ - SUPERUSER
41523
+ - BASICUSER
41524
+ - ROOT
41525
+ CkAccount:
41526
+ type: object
41527
+ description: A ClickHouse account.
41528
+ properties:
41529
+ name:
41530
+ type: string
41531
+ description: The account (user) name.
41532
+ hostIp:
41533
+ type: array
41534
+ description: Host IPs the account is allowed to log in from.
41535
+ items:
41536
+ type: string
41537
+ hostNames:
41538
+ type: array
41539
+ description: Host names the account is allowed to log in from.
41540
+ items:
41541
+ type: string
41542
+ roles:
41543
+ type: string
41544
+ description: Roles granted to the account, separated by commas.
41545
+ type:
41546
+ $ref: '#/components/schemas/CkAccountType'
40682
41547
  RbmqUser:
40683
41548
  type: object
40684
41549
  properties: