kb-cloud-client-typescript 2.4.0-alpha.64 → 2.4.0-alpha.66

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 (129) 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/cluster-jar-api.d.ts +702 -0
  6. package/dist/adminapi/apis/cluster-jar-api.d.ts.map +1 -0
  7. package/dist/adminapi/apis/cluster-jar-api.js +758 -0
  8. package/dist/adminapi/apis/cluster-jar-api.js.map +1 -0
  9. package/dist/adminapi/apis/environment-api.d.ts +95 -0
  10. package/dist/adminapi/apis/environment-api.d.ts.map +1 -1
  11. package/dist/adminapi/apis/environment-api.js +93 -0
  12. package/dist/adminapi/apis/environment-api.js.map +1 -1
  13. package/dist/adminapi/apis/parameter-template-api.d.ts +18 -10
  14. package/dist/adminapi/apis/parameter-template-api.d.ts.map +1 -1
  15. package/dist/adminapi/apis/parameter-template-api.js +16 -11
  16. package/dist/adminapi/apis/parameter-template-api.js.map +1 -1
  17. package/dist/adminapi/apis/shared-api.d.ts +654 -0
  18. package/dist/adminapi/apis/shared-api.d.ts.map +1 -1
  19. package/dist/adminapi/apis/shared-api.js +694 -0
  20. package/dist/adminapi/apis/shared-api.js.map +1 -1
  21. package/dist/adminapi/models/cluster-jar-config.d.ts +61 -0
  22. package/dist/adminapi/models/cluster-jar-config.d.ts.map +1 -0
  23. package/dist/adminapi/models/cluster-jar-config.js +16 -0
  24. package/dist/adminapi/models/cluster-jar-config.js.map +1 -0
  25. package/dist/adminapi/models/cluster-jar-kind.d.ts +22 -0
  26. package/dist/adminapi/models/cluster-jar-kind.d.ts.map +1 -0
  27. package/dist/adminapi/models/cluster-jar-kind.js +26 -0
  28. package/dist/adminapi/models/cluster-jar-kind.js.map +1 -0
  29. package/dist/adminapi/models/cluster-jar-list.d.ts +32 -0
  30. package/dist/adminapi/models/cluster-jar-list.d.ts.map +1 -0
  31. package/dist/adminapi/models/cluster-jar-list.js +16 -0
  32. package/dist/adminapi/models/cluster-jar-list.js.map +1 -0
  33. package/dist/adminapi/models/cluster-jar-package.d.ts +111 -0
  34. package/dist/adminapi/models/cluster-jar-package.d.ts.map +1 -0
  35. package/dist/adminapi/models/cluster-jar-package.js +16 -0
  36. package/dist/adminapi/models/cluster-jar-package.js.map +1 -0
  37. package/dist/adminapi/models/cluster-jar-publish.d.ts +25 -0
  38. package/dist/adminapi/models/cluster-jar-publish.d.ts.map +1 -0
  39. package/dist/adminapi/models/cluster-jar-publish.js +16 -0
  40. package/dist/adminapi/models/cluster-jar-publish.js.map +1 -0
  41. package/dist/adminapi/models/cluster-jar-replica.d.ts +61 -0
  42. package/dist/adminapi/models/cluster-jar-replica.d.ts.map +1 -0
  43. package/dist/adminapi/models/cluster-jar-replica.js +16 -0
  44. package/dist/adminapi/models/cluster-jar-replica.js.map +1 -0
  45. package/dist/adminapi/models/cluster-jar-task.d.ts +25 -0
  46. package/dist/adminapi/models/cluster-jar-task.d.ts.map +1 -0
  47. package/dist/adminapi/models/cluster-jar-task.js +16 -0
  48. package/dist/adminapi/models/cluster-jar-task.js.map +1 -0
  49. package/dist/adminapi/models/engine-option-history.d.ts +5 -4
  50. package/dist/adminapi/models/engine-option-history.d.ts.map +1 -1
  51. package/dist/adminapi/models/index.d.ts +7 -0
  52. package/dist/adminapi/models/index.d.ts.map +1 -1
  53. package/dist/adminapi/models/index.js +7 -0
  54. package/dist/adminapi/models/index.js.map +1 -1
  55. package/dist/openapi/api.d.ts +1 -0
  56. package/dist/openapi/api.d.ts.map +1 -1
  57. package/dist/openapi/api.js +1 -0
  58. package/dist/openapi/api.js.map +1 -1
  59. package/dist/openapi/apis/cluster-jar-api.d.ts +702 -0
  60. package/dist/openapi/apis/cluster-jar-api.d.ts.map +1 -0
  61. package/dist/openapi/apis/cluster-jar-api.js +758 -0
  62. package/dist/openapi/apis/cluster-jar-api.js.map +1 -0
  63. package/dist/openapi/apis/shared-api.d.ts +654 -0
  64. package/dist/openapi/apis/shared-api.d.ts.map +1 -1
  65. package/dist/openapi/apis/shared-api.js +694 -0
  66. package/dist/openapi/apis/shared-api.js.map +1 -1
  67. package/dist/openapi/models/cluster-jar-config.d.ts +61 -0
  68. package/dist/openapi/models/cluster-jar-config.d.ts.map +1 -0
  69. package/dist/openapi/models/cluster-jar-config.js +16 -0
  70. package/dist/openapi/models/cluster-jar-config.js.map +1 -0
  71. package/dist/openapi/models/cluster-jar-kind.d.ts +22 -0
  72. package/dist/openapi/models/cluster-jar-kind.d.ts.map +1 -0
  73. package/dist/openapi/models/cluster-jar-kind.js +26 -0
  74. package/dist/openapi/models/cluster-jar-kind.js.map +1 -0
  75. package/dist/openapi/models/cluster-jar-list.d.ts +32 -0
  76. package/dist/openapi/models/cluster-jar-list.d.ts.map +1 -0
  77. package/dist/openapi/models/cluster-jar-list.js +16 -0
  78. package/dist/openapi/models/cluster-jar-list.js.map +1 -0
  79. package/dist/openapi/models/cluster-jar-package.d.ts +111 -0
  80. package/dist/openapi/models/cluster-jar-package.d.ts.map +1 -0
  81. package/dist/openapi/models/cluster-jar-package.js +16 -0
  82. package/dist/openapi/models/cluster-jar-package.js.map +1 -0
  83. package/dist/openapi/models/cluster-jar-publish.d.ts +25 -0
  84. package/dist/openapi/models/cluster-jar-publish.d.ts.map +1 -0
  85. package/dist/openapi/models/cluster-jar-publish.js +16 -0
  86. package/dist/openapi/models/cluster-jar-publish.js.map +1 -0
  87. package/dist/openapi/models/cluster-jar-replica.d.ts +61 -0
  88. package/dist/openapi/models/cluster-jar-replica.d.ts.map +1 -0
  89. package/dist/openapi/models/cluster-jar-replica.js +16 -0
  90. package/dist/openapi/models/cluster-jar-replica.js.map +1 -0
  91. package/dist/openapi/models/cluster-jar-task.d.ts +25 -0
  92. package/dist/openapi/models/cluster-jar-task.d.ts.map +1 -0
  93. package/dist/openapi/models/cluster-jar-task.js +16 -0
  94. package/dist/openapi/models/cluster-jar-task.js.map +1 -0
  95. package/dist/openapi/models/index.d.ts +7 -0
  96. package/dist/openapi/models/index.d.ts.map +1 -1
  97. package/dist/openapi/models/index.js +7 -0
  98. package/dist/openapi/models/index.js.map +1 -1
  99. package/package.json +1 -1
  100. package/src/adminapi/.openapi-generator/FILES +8 -0
  101. package/src/adminapi/api.ts +1 -0
  102. package/src/adminapi/apis/cluster-jar-api.ts +1211 -0
  103. package/src/adminapi/apis/environment-api.ts +155 -0
  104. package/src/adminapi/apis/parameter-template-api.ts +26 -13
  105. package/src/adminapi/apis/shared-api.ts +1141 -0
  106. package/src/adminapi/models/cluster-jar-config.ts +66 -0
  107. package/src/adminapi/models/cluster-jar-kind.ts +31 -0
  108. package/src/adminapi/models/cluster-jar-list.ts +39 -0
  109. package/src/adminapi/models/cluster-jar-package.ts +122 -0
  110. package/src/adminapi/models/cluster-jar-publish.ts +30 -0
  111. package/src/adminapi/models/cluster-jar-replica.ts +66 -0
  112. package/src/adminapi/models/cluster-jar-task.ts +30 -0
  113. package/src/adminapi/models/engine-option-history.ts +3 -6
  114. package/src/adminapi/models/index.ts +7 -0
  115. package/src/adminapi.yaml +682 -72
  116. package/src/internalapi.yaml +2 -4
  117. package/src/openapi/.openapi-generator/FILES +8 -0
  118. package/src/openapi/api.ts +1 -0
  119. package/src/openapi/apis/cluster-jar-api.ts +1211 -0
  120. package/src/openapi/apis/shared-api.ts +1165 -24
  121. package/src/openapi/models/cluster-jar-config.ts +66 -0
  122. package/src/openapi/models/cluster-jar-kind.ts +31 -0
  123. package/src/openapi/models/cluster-jar-list.ts +39 -0
  124. package/src/openapi/models/cluster-jar-package.ts +122 -0
  125. package/src/openapi/models/cluster-jar-publish.ts +30 -0
  126. package/src/openapi/models/cluster-jar-replica.ts +66 -0
  127. package/src/openapi/models/cluster-jar-task.ts +30 -0
  128. package/src/openapi/models/index.ts +7 -0
  129. package/src/openapi.yaml +606 -65
package/src/adminapi.yaml CHANGED
@@ -76,6 +76,402 @@ tags:
76
76
  - name: disasterRecovery
77
77
  description: Cluster Disaster Recovery APIs
78
78
  paths:
79
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/config:
80
+ get:
81
+ operationId: getClusterJarConfig
82
+ summary: Get external JAR capability and configuration
83
+ tags:
84
+ - clusterJar
85
+ - shared
86
+ parameters:
87
+ - name: engineName
88
+ in: path
89
+ required: true
90
+ description: Doris or SelectDB engine of the target cluster.
91
+ schema:
92
+ type: string
93
+ - name: orgName
94
+ in: path
95
+ required: true
96
+ schema:
97
+ type: string
98
+ - name: clusterName
99
+ in: path
100
+ required: true
101
+ schema:
102
+ type: string
103
+ responses:
104
+ '200':
105
+ description: Success
106
+ content:
107
+ application/json:
108
+ schema:
109
+ $ref: '#/components/schemas/clusterJarConfig'
110
+ '400':
111
+ $ref: '#/components/responses/400'
112
+ '401':
113
+ $ref: '#/components/responses/401'
114
+ '403':
115
+ $ref: '#/components/responses/403'
116
+ '404':
117
+ $ref: '#/components/responses/404'
118
+ '409':
119
+ $ref: '#/components/responses/409'
120
+ '500':
121
+ $ref: '#/components/responses/500'
122
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars:
123
+ get:
124
+ operationId: listClusterJars
125
+ summary: List external JAR versions with metadata and per-instance synchronization state
126
+ tags:
127
+ - clusterJar
128
+ - shared
129
+ parameters:
130
+ - name: engineName
131
+ in: path
132
+ required: true
133
+ description: Doris or SelectDB engine of the target cluster.
134
+ schema:
135
+ type: string
136
+ - name: orgName
137
+ in: path
138
+ required: true
139
+ schema:
140
+ type: string
141
+ - name: clusterName
142
+ in: path
143
+ required: true
144
+ schema:
145
+ type: string
146
+ responses:
147
+ '200':
148
+ description: Success
149
+ content:
150
+ application/json:
151
+ schema:
152
+ $ref: '#/components/schemas/clusterJarList'
153
+ '400':
154
+ $ref: '#/components/responses/400'
155
+ '401':
156
+ $ref: '#/components/responses/401'
157
+ '403':
158
+ $ref: '#/components/responses/403'
159
+ '404':
160
+ $ref: '#/components/responses/404'
161
+ '409':
162
+ $ref: '#/components/responses/409'
163
+ '500':
164
+ $ref: '#/components/responses/500'
165
+ post:
166
+ operationId: uploadClusterJar
167
+ summary: Upload an immutable JAR version
168
+ tags:
169
+ - clusterJar
170
+ - shared
171
+ parameters:
172
+ - name: engineName
173
+ in: path
174
+ required: true
175
+ description: Doris or SelectDB engine of the target cluster.
176
+ schema:
177
+ type: string
178
+ - name: orgName
179
+ in: path
180
+ required: true
181
+ schema:
182
+ type: string
183
+ - name: clusterName
184
+ in: path
185
+ required: true
186
+ schema:
187
+ type: string
188
+ - name: Idempotency-Key
189
+ in: header
190
+ required: true
191
+ schema:
192
+ type: string
193
+ minLength: 1
194
+ maxLength: 128
195
+ responses:
196
+ '201':
197
+ description: Success
198
+ content:
199
+ application/json:
200
+ schema:
201
+ $ref: '#/components/schemas/clusterJarPackage'
202
+ '400':
203
+ $ref: '#/components/responses/400'
204
+ '401':
205
+ $ref: '#/components/responses/401'
206
+ '403':
207
+ $ref: '#/components/responses/403'
208
+ '404':
209
+ $ref: '#/components/responses/404'
210
+ '409':
211
+ $ref: '#/components/responses/409'
212
+ '413':
213
+ $ref: '#/components/responses/413'
214
+ '500':
215
+ $ref: '#/components/responses/500'
216
+ requestBody:
217
+ required: true
218
+ content:
219
+ multipart/form-data:
220
+ schema:
221
+ type: object
222
+ properties:
223
+ name:
224
+ type: string
225
+ minLength: 1
226
+ maxLength: 128
227
+ kind:
228
+ $ref: '#/components/schemas/clusterJarKind'
229
+ file:
230
+ type: string
231
+ format: binary
232
+ required:
233
+ - name
234
+ - kind
235
+ - file
236
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}:
237
+ delete:
238
+ operationId: deleteClusterJar
239
+ summary: Delete an unpublished JAR version
240
+ tags:
241
+ - clusterJar
242
+ - shared
243
+ parameters:
244
+ - name: engineName
245
+ in: path
246
+ required: true
247
+ description: Doris or SelectDB engine of the target cluster.
248
+ schema:
249
+ type: string
250
+ - name: orgName
251
+ in: path
252
+ required: true
253
+ schema:
254
+ type: string
255
+ - name: clusterName
256
+ in: path
257
+ required: true
258
+ schema:
259
+ type: string
260
+ - name: jarId
261
+ in: path
262
+ required: true
263
+ schema:
264
+ type: string
265
+ responses:
266
+ '204':
267
+ description: Success
268
+ '400':
269
+ $ref: '#/components/responses/400'
270
+ '401':
271
+ $ref: '#/components/responses/401'
272
+ '403':
273
+ $ref: '#/components/responses/403'
274
+ '404':
275
+ $ref: '#/components/responses/404'
276
+ '409':
277
+ $ref: '#/components/responses/409'
278
+ '500':
279
+ $ref: '#/components/responses/500'
280
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/download:
281
+ get:
282
+ operationId: downloadClusterJar
283
+ summary: Download the original JAR
284
+ tags:
285
+ - clusterJar
286
+ - shared
287
+ parameters:
288
+ - name: engineName
289
+ in: path
290
+ required: true
291
+ description: Doris or SelectDB engine of the target cluster.
292
+ schema:
293
+ type: string
294
+ - name: orgName
295
+ in: path
296
+ required: true
297
+ schema:
298
+ type: string
299
+ - name: clusterName
300
+ in: path
301
+ required: true
302
+ schema:
303
+ type: string
304
+ - name: jarId
305
+ in: path
306
+ required: true
307
+ schema:
308
+ type: string
309
+ responses:
310
+ '200':
311
+ description: Success
312
+ content:
313
+ application/java-archive:
314
+ schema:
315
+ type: string
316
+ format: binary
317
+ '400':
318
+ $ref: '#/components/responses/400'
319
+ '401':
320
+ $ref: '#/components/responses/401'
321
+ '403':
322
+ $ref: '#/components/responses/403'
323
+ '404':
324
+ $ref: '#/components/responses/404'
325
+ '409':
326
+ $ref: '#/components/responses/409'
327
+ '500':
328
+ $ref: '#/components/responses/500'
329
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/distribute:
330
+ post:
331
+ operationId: distributeClusterJar
332
+ summary: Publish a JAR with optimistic manifest version checking
333
+ tags:
334
+ - clusterJar
335
+ - shared
336
+ parameters:
337
+ - name: engineName
338
+ in: path
339
+ required: true
340
+ description: Doris or SelectDB engine of the target cluster.
341
+ schema:
342
+ type: string
343
+ - name: orgName
344
+ in: path
345
+ required: true
346
+ schema:
347
+ type: string
348
+ - name: clusterName
349
+ in: path
350
+ required: true
351
+ schema:
352
+ type: string
353
+ - name: jarId
354
+ in: path
355
+ required: true
356
+ schema:
357
+ type: string
358
+ responses:
359
+ '202':
360
+ description: Success
361
+ content:
362
+ application/json:
363
+ schema:
364
+ $ref: '#/components/schemas/clusterJarTask'
365
+ '400':
366
+ $ref: '#/components/responses/400'
367
+ '401':
368
+ $ref: '#/components/responses/401'
369
+ '403':
370
+ $ref: '#/components/responses/403'
371
+ '404':
372
+ $ref: '#/components/responses/404'
373
+ '409':
374
+ $ref: '#/components/responses/409'
375
+ '500':
376
+ $ref: '#/components/responses/500'
377
+ requestBody:
378
+ required: true
379
+ content:
380
+ application/json:
381
+ schema:
382
+ $ref: '#/components/schemas/clusterJarPublish'
383
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/retry:
384
+ post:
385
+ operationId: retryClusterJar
386
+ summary: Retry synchronization of published JARs
387
+ tags:
388
+ - clusterJar
389
+ - shared
390
+ parameters:
391
+ - name: engineName
392
+ in: path
393
+ required: true
394
+ description: Doris or SelectDB engine of the target cluster.
395
+ schema:
396
+ type: string
397
+ - name: orgName
398
+ in: path
399
+ required: true
400
+ schema:
401
+ type: string
402
+ - name: clusterName
403
+ in: path
404
+ required: true
405
+ schema:
406
+ type: string
407
+ - name: jarId
408
+ in: path
409
+ required: true
410
+ schema:
411
+ type: string
412
+ responses:
413
+ '202':
414
+ description: Success
415
+ content:
416
+ application/json:
417
+ schema:
418
+ $ref: '#/components/schemas/clusterJarTask'
419
+ '400':
420
+ $ref: '#/components/responses/400'
421
+ '401':
422
+ $ref: '#/components/responses/401'
423
+ '403':
424
+ $ref: '#/components/responses/403'
425
+ '404':
426
+ $ref: '#/components/responses/404'
427
+ '409':
428
+ $ref: '#/components/responses/409'
429
+ '500':
430
+ $ref: '#/components/responses/500'
431
+ /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/archive:
432
+ post:
433
+ operationId: archiveClusterJar
434
+ summary: Archive a JAR while retaining published files and startup synchronization
435
+ tags:
436
+ - clusterJar
437
+ - shared
438
+ parameters:
439
+ - name: engineName
440
+ in: path
441
+ required: true
442
+ description: Doris or SelectDB engine of the target cluster.
443
+ schema:
444
+ type: string
445
+ - name: orgName
446
+ in: path
447
+ required: true
448
+ schema:
449
+ type: string
450
+ - name: clusterName
451
+ in: path
452
+ required: true
453
+ schema:
454
+ type: string
455
+ - name: jarId
456
+ in: path
457
+ required: true
458
+ schema:
459
+ type: string
460
+ responses:
461
+ '204':
462
+ description: Success
463
+ '400':
464
+ $ref: '#/components/responses/400'
465
+ '401':
466
+ $ref: '#/components/responses/401'
467
+ '403':
468
+ $ref: '#/components/responses/403'
469
+ '404':
470
+ $ref: '#/components/responses/404'
471
+ '409':
472
+ $ref: '#/components/responses/409'
473
+ '500':
474
+ $ref: '#/components/responses/500'
79
475
  /admin/v1/user:
80
476
  get:
81
477
  description: Get authenticated login user info
@@ -4226,13 +4622,20 @@ paths:
4226
4622
  post:
4227
4623
  operationId: createParameterTemplate
4228
4624
  summary: Create parameter template
4625
+ description: Create a parameter template in the target organization from an existing template. To copy a custom template from another organization, specify oriOrgName and provide a new name. Cross-organization creation only supports non-private custom source templates. The created template is always non-private; any isPrivate value in the request body is ignored.
4229
4626
  parameters:
4230
- - description: name of the Org
4627
+ - description: Name of the target organization
4231
4628
  in: query
4232
4629
  name: orgName
4233
4630
  required: true
4234
4631
  schema:
4235
4632
  type: string
4633
+ - description: 'Name of the source organization. When omitted, empty, or equal to orgName, existing creation behavior is preserved: custom templates are read from the target organization and default templates from the system organization. A different source organization requires oriPartition to be custom and name to differ from oriName. Both organizations must be active. The source may be the system organization, but the target must not be the system organization. A non-empty value containing only whitespace is invalid.'
4634
+ in: query
4635
+ name: oriOrgName
4636
+ required: false
4637
+ schema:
4638
+ type: string
4236
4639
  requestBody:
4237
4640
  content:
4238
4641
  application/json:
@@ -4246,12 +4649,16 @@ paths:
4246
4649
  schema:
4247
4650
  $ref: '#/components/schemas/paramTplListItem'
4248
4651
  description: create parameter template successfully
4652
+ '400':
4653
+ $ref: '#/components/responses/400'
4249
4654
  '401':
4250
4655
  $ref: '#/components/responses/401'
4251
4656
  '403':
4252
4657
  $ref: '#/components/responses/403'
4253
4658
  '404':
4254
4659
  $ref: '#/components/responses/404'
4660
+ '409':
4661
+ $ref: '#/components/responses/409'
4255
4662
  tags:
4256
4663
  - parameterTemplate
4257
4664
  x-codegen-request-body-name: body
@@ -9678,6 +10085,58 @@ paths:
9678
10085
  $ref: '#/components/responses/403'
9679
10086
  '404':
9680
10087
  $ref: '#/components/responses/404'
10088
+ /admin/v1/environments/{environmentName}/resources/{resourceName}:
10089
+ get:
10090
+ operationId: getEnvironmentResource
10091
+ summary: Get a live Kubernetes resource
10092
+ description: Returns one named Kubernetes object, excluding metadata.managedFields. The code allowlist currently permits only apiVersion v1 with kind PersistentVolumeClaim; other valid resource types return 403 before Kubernetes access. Requires Admin environment read permission. Does not support lists, subresources or writes.
10093
+ tags:
10094
+ - environment
10095
+ parameters:
10096
+ - in: path
10097
+ name: environmentName
10098
+ required: true
10099
+ schema:
10100
+ type: string
10101
+ - in: path
10102
+ name: resourceName
10103
+ required: true
10104
+ schema:
10105
+ type: string
10106
+ - in: query
10107
+ name: apiVersion
10108
+ description: Kubernetes API version. Currently only v1 with kind PersistentVolumeClaim is allowed.
10109
+ required: true
10110
+ schema:
10111
+ type: string
10112
+ - in: query
10113
+ name: kind
10114
+ description: Kubernetes kind. Currently only PersistentVolumeClaim with apiVersion v1 is allowed.
10115
+ required: true
10116
+ schema:
10117
+ type: string
10118
+ - in: query
10119
+ name: namespace
10120
+ description: Required for namespaced kinds; must be omitted for cluster-scoped kinds.
10121
+ schema:
10122
+ type: string
10123
+ responses:
10124
+ '200':
10125
+ description: The live Kubernetes resource, including metadata, spec and status when present.
10126
+ content:
10127
+ application/json:
10128
+ schema:
10129
+ $ref: '#/components/schemas/jsonBody'
10130
+ '400':
10131
+ $ref: '#/components/responses/400'
10132
+ '401':
10133
+ $ref: '#/components/responses/401'
10134
+ '403':
10135
+ $ref: '#/components/responses/403'
10136
+ '404':
10137
+ $ref: '#/components/responses/404'
10138
+ '500':
10139
+ $ref: '#/components/responses/500'
9681
10140
  /admin/v1/environments:
9682
10141
  get:
9683
10142
  operationId: listEnvironment
@@ -16161,7 +16620,7 @@ paths:
16161
16620
  description: Inspection tasks created and accepted for asynchronous execution.
16162
16621
  content: {}
16163
16622
  '400':
16164
- description: Invalid request, invalid cluster selection, or no eligible clusters.
16623
+ $ref: '#/components/responses/400'
16165
16624
  '401':
16166
16625
  $ref: '#/components/responses/401'
16167
16626
  '403':
@@ -22258,7 +22717,7 @@ paths:
22258
22717
  $ref: '#/components/schemas/accountList'
22259
22718
  description: Success
22260
22719
  '400':
22261
- description: Invalid request
22720
+ $ref: '#/components/responses/400'
22262
22721
  '401':
22263
22722
  $ref: '#/components/responses/401'
22264
22723
  '403':
@@ -22266,9 +22725,9 @@ paths:
22266
22725
  '404':
22267
22726
  $ref: '#/components/responses/404'
22268
22727
  '409':
22269
- description: Resource conflict or policy in use
22728
+ $ref: '#/components/responses/409'
22270
22729
  '503':
22271
- description: IAM unavailable; mutation outcome may be unknown
22730
+ $ref: '#/components/responses/503'
22272
22731
  tags:
22273
22732
  - account
22274
22733
  - seaweedfs
@@ -22305,7 +22764,7 @@ paths:
22305
22764
  schema:
22306
22765
  $ref: '#/components/schemas/account'
22307
22766
  '400':
22308
- description: Invalid request
22767
+ $ref: '#/components/responses/400'
22309
22768
  '401':
22310
22769
  $ref: '#/components/responses/401'
22311
22770
  '403':
@@ -22313,9 +22772,9 @@ paths:
22313
22772
  '404':
22314
22773
  $ref: '#/components/responses/404'
22315
22774
  '409':
22316
- description: Resource conflict or policy in use
22775
+ $ref: '#/components/responses/409'
22317
22776
  '503':
22318
- description: IAM unavailable; mutation outcome may be unknown
22777
+ $ref: '#/components/responses/503'
22319
22778
  tags:
22320
22779
  - account
22321
22780
  - seaweedfs
@@ -22350,7 +22809,7 @@ paths:
22350
22809
  content: {}
22351
22810
  description: Identity deleted
22352
22811
  '400':
22353
- description: Invalid request
22812
+ $ref: '#/components/responses/400'
22354
22813
  '401':
22355
22814
  $ref: '#/components/responses/401'
22356
22815
  '403':
@@ -22358,9 +22817,9 @@ paths:
22358
22817
  '404':
22359
22818
  $ref: '#/components/responses/404'
22360
22819
  '409':
22361
- description: Resource conflict or policy in use
22820
+ $ref: '#/components/responses/409'
22362
22821
  '503':
22363
- description: IAM unavailable; mutation outcome may be unknown
22822
+ $ref: '#/components/responses/503'
22364
22823
  tags:
22365
22824
  - account
22366
22825
  - seaweedfs
@@ -22402,7 +22861,7 @@ paths:
22402
22861
  schema:
22403
22862
  $ref: '#/components/schemas/account'
22404
22863
  '400':
22405
- description: Invalid request
22864
+ $ref: '#/components/responses/400'
22406
22865
  '401':
22407
22866
  $ref: '#/components/responses/401'
22408
22867
  '403':
@@ -22410,9 +22869,9 @@ paths:
22410
22869
  '404':
22411
22870
  $ref: '#/components/responses/404'
22412
22871
  '409':
22413
- description: Resource conflict or policy in use
22872
+ $ref: '#/components/responses/409'
22414
22873
  '503':
22415
- description: IAM unavailable; mutation outcome may be unknown
22874
+ $ref: '#/components/responses/503'
22416
22875
  tags:
22417
22876
  - account
22418
22877
  - seaweedfs
@@ -22501,7 +22960,7 @@ paths:
22501
22960
  required: true
22502
22961
  responses:
22503
22962
  '400':
22504
- description: SeaweedFS uses the named policy binding API
22963
+ $ref: '#/components/responses/400'
22505
22964
  tags:
22506
22965
  - account
22507
22966
  - seaweedfs
@@ -22550,17 +23009,17 @@ paths:
22550
23009
  type: object
22551
23010
  additionalProperties: true
22552
23011
  '400':
22553
- description: Invalid request
23012
+ $ref: '#/components/responses/400'
22554
23013
  '401':
22555
- description: Unauthenticated
23014
+ $ref: '#/components/responses/401'
22556
23015
  '403':
22557
- description: Permission denied or protected identity
23016
+ $ref: '#/components/responses/403'
22558
23017
  '404':
22559
- description: Resource not found
23018
+ $ref: '#/components/responses/404'
22560
23019
  '409':
22561
- description: Resource conflict or policy in use
23020
+ $ref: '#/components/responses/409'
22562
23021
  '503':
22563
- description: IAM unavailable; mutation outcome may be unknown
23022
+ $ref: '#/components/responses/503'
22564
23023
  /admin/v1/data/seaweedfs/organizations/{orgName}/clusters/{clusterName}/policies/{policyName}:
22565
23024
  put:
22566
23025
  summary: putSeaweedFSPolicy
@@ -22589,17 +23048,17 @@ paths:
22589
23048
  '204':
22590
23049
  description: Successful response
22591
23050
  '400':
22592
- description: Invalid request
23051
+ $ref: '#/components/responses/400'
22593
23052
  '401':
22594
- description: Unauthenticated
23053
+ $ref: '#/components/responses/401'
22595
23054
  '403':
22596
- description: Permission denied or protected identity
23055
+ $ref: '#/components/responses/403'
22597
23056
  '404':
22598
- description: Resource not found
23057
+ $ref: '#/components/responses/404'
22599
23058
  '409':
22600
- description: Resource conflict or policy in use
23059
+ $ref: '#/components/responses/409'
22601
23060
  '503':
22602
- description: IAM unavailable; mutation outcome may be unknown
23061
+ $ref: '#/components/responses/503'
22603
23062
  requestBody:
22604
23063
  required: true
22605
23064
  content:
@@ -22635,17 +23094,17 @@ paths:
22635
23094
  '204':
22636
23095
  description: Successful response
22637
23096
  '400':
22638
- description: Invalid request
23097
+ $ref: '#/components/responses/400'
22639
23098
  '401':
22640
- description: Unauthenticated
23099
+ $ref: '#/components/responses/401'
22641
23100
  '403':
22642
- description: Permission denied or protected identity
23101
+ $ref: '#/components/responses/403'
22643
23102
  '404':
22644
- description: Resource not found
23103
+ $ref: '#/components/responses/404'
22645
23104
  '409':
22646
- description: Resource conflict or policy in use
23105
+ $ref: '#/components/responses/409'
22647
23106
  '503':
22648
- description: IAM unavailable; mutation outcome may be unknown
23107
+ $ref: '#/components/responses/503'
22649
23108
  description: Deletes an unused named policy. Attached policies are rejected; no identities or groups are implicitly changed.
22650
23109
  /admin/v1/data/seaweedfs/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/policies:
22651
23110
  put:
@@ -22675,17 +23134,17 @@ paths:
22675
23134
  '204':
22676
23135
  description: Successful response
22677
23136
  '400':
22678
- description: Invalid request
23137
+ $ref: '#/components/responses/400'
22679
23138
  '401':
22680
- description: Unauthenticated
23139
+ $ref: '#/components/responses/401'
22681
23140
  '403':
22682
- description: Permission denied or protected identity
23141
+ $ref: '#/components/responses/403'
22683
23142
  '404':
22684
- description: Resource not found
23143
+ $ref: '#/components/responses/404'
22685
23144
  '409':
22686
- description: Resource conflict or policy in use
23145
+ $ref: '#/components/responses/409'
22687
23146
  '503':
22688
- description: IAM unavailable; mutation outcome may be unknown
23147
+ $ref: '#/components/responses/503'
22689
23148
  requestBody:
22690
23149
  required: true
22691
23150
  content:
@@ -22732,17 +23191,17 @@ paths:
22732
23191
  schema:
22733
23192
  $ref: '#/components/schemas/account'
22734
23193
  '400':
22735
- description: Invalid request
23194
+ $ref: '#/components/responses/400'
22736
23195
  '401':
22737
- description: Unauthenticated
23196
+ $ref: '#/components/responses/401'
22738
23197
  '403':
22739
- description: Permission denied or protected identity
23198
+ $ref: '#/components/responses/403'
22740
23199
  '404':
22741
- description: Resource not found
23200
+ $ref: '#/components/responses/404'
22742
23201
  '409':
22743
- description: Resource conflict or policy in use
23202
+ $ref: '#/components/responses/409'
22744
23203
  '503':
22745
- description: IAM unavailable; mutation outcome may be unknown
23204
+ $ref: '#/components/responses/503'
22746
23205
  requestBody:
22747
23206
  required: true
22748
23207
  content:
@@ -22783,17 +23242,17 @@ paths:
22783
23242
  '204':
22784
23243
  description: Successful response
22785
23244
  '400':
22786
- description: Invalid request
23245
+ $ref: '#/components/responses/400'
22787
23246
  '401':
22788
- description: Unauthenticated
23247
+ $ref: '#/components/responses/401'
22789
23248
  '403':
22790
- description: Permission denied or protected identity
23249
+ $ref: '#/components/responses/403'
22791
23250
  '404':
22792
- description: Resource not found
23251
+ $ref: '#/components/responses/404'
22793
23252
  '409':
22794
- description: Resource conflict or policy in use
23253
+ $ref: '#/components/responses/409'
22795
23254
  '503':
22796
- description: IAM unavailable; mutation outcome may be unknown
23255
+ $ref: '#/components/responses/503'
22797
23256
  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts:
22798
23257
  get:
22799
23258
  description: list accounts in cluster
@@ -28080,6 +28539,160 @@ components:
28080
28539
  curl --digest -u "accessKey:secretKey" https://api.example.com/admin/v1/user
28081
28540
  ```
28082
28541
  schemas:
28542
+ clusterJarConfig:
28543
+ type: object
28544
+ properties:
28545
+ supported:
28546
+ type: boolean
28547
+ reason:
28548
+ type: string
28549
+ generation:
28550
+ type: integer
28551
+ format: int64
28552
+ maxFileBytes:
28553
+ type: integer
28554
+ format: int64
28555
+ maxTotalBytes:
28556
+ type: integer
28557
+ format: int64
28558
+ usedBytes:
28559
+ type: integer
28560
+ format: int64
28561
+ taskId:
28562
+ type: string
28563
+ required:
28564
+ - supported
28565
+ - generation
28566
+ - maxFileBytes
28567
+ - maxTotalBytes
28568
+ - usedBytes
28569
+ APIErrorResponse:
28570
+ description: API error response.
28571
+ properties:
28572
+ code:
28573
+ description: The HTTP status code.
28574
+ type: integer
28575
+ reason:
28576
+ description: The reason for the error.
28577
+ type: string
28578
+ message:
28579
+ description: The message for the error.
28580
+ type: string
28581
+ required:
28582
+ - code
28583
+ type: object
28584
+ clusterJarKind:
28585
+ type: string
28586
+ enum:
28587
+ - udf
28588
+ - jdbc
28589
+ clusterJarReplica:
28590
+ type: object
28591
+ properties:
28592
+ component:
28593
+ type: string
28594
+ podName:
28595
+ type: string
28596
+ podUID:
28597
+ type: string
28598
+ status:
28599
+ type: string
28600
+ error:
28601
+ type: string
28602
+ generation:
28603
+ type: integer
28604
+ format: int64
28605
+ updatedAt:
28606
+ type: string
28607
+ format: date-time
28608
+ required:
28609
+ - component
28610
+ - podName
28611
+ - podUID
28612
+ - status
28613
+ - generation
28614
+ clusterJarPackage:
28615
+ type: object
28616
+ properties:
28617
+ id:
28618
+ type: string
28619
+ name:
28620
+ type: string
28621
+ kind:
28622
+ $ref: '#/components/schemas/clusterJarKind'
28623
+ filename:
28624
+ type: string
28625
+ sha256:
28626
+ type: string
28627
+ size:
28628
+ type: integer
28629
+ format: int64
28630
+ uri:
28631
+ type: string
28632
+ published:
28633
+ type: boolean
28634
+ archived:
28635
+ type: boolean
28636
+ status:
28637
+ type: string
28638
+ synced:
28639
+ type: integer
28640
+ format: int64
28641
+ total:
28642
+ type: integer
28643
+ format: int64
28644
+ createdBy:
28645
+ type: string
28646
+ createdAt:
28647
+ type: string
28648
+ format: date-time
28649
+ instances:
28650
+ type: array
28651
+ items:
28652
+ $ref: '#/components/schemas/clusterJarReplica'
28653
+ required:
28654
+ - id
28655
+ - name
28656
+ - kind
28657
+ - filename
28658
+ - sha256
28659
+ - size
28660
+ - uri
28661
+ - published
28662
+ - archived
28663
+ - status
28664
+ - synced
28665
+ - total
28666
+ - createdBy
28667
+ - createdAt
28668
+ - instances
28669
+ clusterJarList:
28670
+ type: object
28671
+ properties:
28672
+ items:
28673
+ type: array
28674
+ items:
28675
+ $ref: '#/components/schemas/clusterJarPackage'
28676
+ generation:
28677
+ type: integer
28678
+ format: int64
28679
+ required:
28680
+ - items
28681
+ - generation
28682
+ clusterJarPublish:
28683
+ type: object
28684
+ properties:
28685
+ generation:
28686
+ type: integer
28687
+ format: int64
28688
+ minimum: 0
28689
+ required:
28690
+ - generation
28691
+ clusterJarTask:
28692
+ type: object
28693
+ properties:
28694
+ taskId:
28695
+ type: string
28083
28696
  phoneNumber:
28084
28697
  description: The phonenumber for the user.
28085
28698
  example: '+8618912345678'
@@ -28120,21 +28733,6 @@ components:
28120
28733
  - userName
28121
28734
  - createdAt
28122
28735
  - updatedAt
28123
- APIErrorResponse:
28124
- description: API error response.
28125
- properties:
28126
- code:
28127
- description: The HTTP status code.
28128
- type: integer
28129
- reason:
28130
- description: The reason for the error.
28131
- type: string
28132
- message:
28133
- description: The message for the error.
28134
- type: string
28135
- required:
28136
- - code
28137
- type: object
28138
28736
  userUpdate:
28139
28737
  description: User update
28140
28738
  properties:
@@ -35332,6 +35930,11 @@ components:
35332
35930
  required:
35333
35931
  - serviceName
35334
35932
  - serviceNamespace
35933
+ jsonBody:
35934
+ description: Represents a JSON body.
35935
+ properties: {}
35936
+ additionalProperties: true
35937
+ type: object
35335
35938
  logBackendType:
35336
35939
  type: string
35337
35940
  description: Log query backend configured for this environment.
@@ -36367,11 +36970,6 @@ components:
36367
36970
  - items
36368
36971
  - updatedAt
36369
36972
  type: object
36370
- jsonBody:
36371
- description: Represents a JSON body.
36372
- properties: {}
36373
- additionalProperties: true
36374
- type: object
36375
36973
  instanceResourceStatsType:
36376
36974
  description: Type of the instance, choose cluster, system, or other
36377
36975
  enum:
@@ -40951,7 +41549,13 @@ components:
40951
41549
  modifierEmail:
40952
41550
  type: string
40953
41551
  option:
40954
- $ref: '#/components/schemas/engineOption'
41552
+ description: |
41553
+ Engine option document stored when this history row was written.
41554
+ This is a point-in-time snapshot, not the current engineOption
41555
+ create/update contract. Nested fields such as endpoints.protocol
41556
+ may be absent on older rows.
41557
+ type: object
41558
+ additionalProperties: true
40955
41559
  createdAt:
40956
41560
  type: string
40957
41561
  format: date-time
@@ -49818,6 +50422,12 @@ components:
49818
50422
  schema:
49819
50423
  $ref: '#/components/schemas/APIErrorResponse'
49820
50424
  description: Conflict
50425
+ '413':
50426
+ content:
50427
+ application/json:
50428
+ schema:
50429
+ $ref: '#/components/schemas/APIErrorResponse'
50430
+ description: Payload Too Large
49821
50431
  '429':
49822
50432
  content:
49823
50433
  application/json: