kb-cloud-client-typescript 2.4.0-alpha.50 → 2.4.0-alpha.52

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 (204) 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/data-replication-api.d.ts +1356 -0
  6. package/dist/adminapi/apis/data-replication-api.d.ts.map +1 -0
  7. package/dist/adminapi/apis/data-replication-api.js +1495 -0
  8. package/dist/adminapi/apis/data-replication-api.js.map +1 -0
  9. package/dist/adminapi/models/auth-type.d.ts +21 -0
  10. package/dist/adminapi/models/auth-type.d.ts.map +1 -0
  11. package/dist/adminapi/models/auth-type.js +25 -0
  12. package/dist/adminapi/models/auth-type.js.map +1 -0
  13. package/dist/adminapi/models/basic-auth-model.d.ts +31 -0
  14. package/dist/adminapi/models/basic-auth-model.d.ts.map +1 -0
  15. package/dist/adminapi/models/basic-auth-model.js +16 -0
  16. package/dist/adminapi/models/basic-auth-model.js.map +1 -0
  17. package/dist/adminapi/models/channel-status.d.ts +28 -0
  18. package/dist/adminapi/models/channel-status.d.ts.map +1 -0
  19. package/dist/adminapi/models/channel-status.js +32 -0
  20. package/dist/adminapi/models/channel-status.js.map +1 -0
  21. package/dist/adminapi/models/cluster-mode-transition.d.ts +7 -0
  22. package/dist/adminapi/models/cluster-mode-transition.d.ts.map +1 -1
  23. package/dist/adminapi/models/custom-endpoint-create.d.ts +39 -0
  24. package/dist/adminapi/models/custom-endpoint-create.d.ts.map +1 -0
  25. package/dist/adminapi/models/custom-endpoint-create.js +16 -0
  26. package/dist/adminapi/models/custom-endpoint-create.js.map +1 -0
  27. package/dist/adminapi/models/custom-endpoint.d.ts +45 -0
  28. package/dist/adminapi/models/custom-endpoint.d.ts.map +1 -0
  29. package/dist/adminapi/models/custom-endpoint.js +16 -0
  30. package/dist/adminapi/models/custom-endpoint.js.map +1 -0
  31. package/dist/adminapi/models/data-channel-detail.d.ts +33 -0
  32. package/dist/adminapi/models/data-channel-detail.d.ts.map +1 -0
  33. package/dist/adminapi/models/data-channel-detail.js +16 -0
  34. package/dist/adminapi/models/data-channel-detail.js.map +1 -0
  35. package/dist/adminapi/models/data-channel-endpoint-create.d.ts +60 -0
  36. package/dist/adminapi/models/data-channel-endpoint-create.d.ts.map +1 -0
  37. package/dist/adminapi/models/data-channel-endpoint-create.js +16 -0
  38. package/dist/adminapi/models/data-channel-endpoint-create.js.map +1 -0
  39. package/dist/adminapi/models/data-channel-item.d.ts +119 -0
  40. package/dist/adminapi/models/data-channel-item.d.ts.map +1 -0
  41. package/dist/adminapi/models/data-channel-item.js +16 -0
  42. package/dist/adminapi/models/data-channel-item.js.map +1 -0
  43. package/dist/adminapi/models/data-channel-list-endpoint.d.ts +54 -0
  44. package/dist/adminapi/models/data-channel-list-endpoint.d.ts.map +1 -0
  45. package/dist/adminapi/models/data-channel-list-endpoint.js +16 -0
  46. package/dist/adminapi/models/data-channel-list-endpoint.js.map +1 -0
  47. package/dist/adminapi/models/data-channel-module-progress.d.ts +49 -0
  48. package/dist/adminapi/models/data-channel-module-progress.d.ts.map +1 -0
  49. package/dist/adminapi/models/data-channel-module-progress.js +16 -0
  50. package/dist/adminapi/models/data-channel-module-progress.js.map +1 -0
  51. package/dist/adminapi/models/data-channel-parameter-key-value.d.ts +31 -0
  52. package/dist/adminapi/models/data-channel-parameter-key-value.d.ts.map +1 -0
  53. package/dist/adminapi/models/data-channel-parameter-key-value.js +16 -0
  54. package/dist/adminapi/models/data-channel-parameter-key-value.js.map +1 -0
  55. package/dist/adminapi/models/data-channel-progress.d.ts +32 -0
  56. package/dist/adminapi/models/data-channel-progress.d.ts.map +1 -0
  57. package/dist/adminapi/models/data-channel-progress.js +16 -0
  58. package/dist/adminapi/models/data-channel-progress.js.map +1 -0
  59. package/dist/adminapi/models/data-channel-response.d.ts +43 -0
  60. package/dist/adminapi/models/data-channel-response.d.ts.map +1 -0
  61. package/dist/adminapi/models/data-channel-response.js +16 -0
  62. package/dist/adminapi/models/data-channel-response.js.map +1 -0
  63. package/dist/adminapi/models/data-check-detail-item.d.ts +94 -0
  64. package/dist/adminapi/models/data-check-detail-item.d.ts.map +1 -0
  65. package/dist/adminapi/models/data-check-detail-item.js +16 -0
  66. package/dist/adminapi/models/data-check-detail-item.js.map +1 -0
  67. package/dist/adminapi/models/data-check-detail-type.d.ts +22 -0
  68. package/dist/adminapi/models/data-check-detail-type.d.ts.map +1 -0
  69. package/dist/adminapi/models/data-check-detail-type.js +26 -0
  70. package/dist/adminapi/models/data-check-detail-type.js.map +1 -0
  71. package/dist/adminapi/models/data-check-details.d.ts +33 -0
  72. package/dist/adminapi/models/data-check-details.d.ts.map +1 -0
  73. package/dist/adminapi/models/data-check-details.js +16 -0
  74. package/dist/adminapi/models/data-check-details.js.map +1 -0
  75. package/dist/adminapi/models/data-check-diff-value.d.ts +43 -0
  76. package/dist/adminapi/models/data-check-diff-value.d.ts.map +1 -0
  77. package/dist/adminapi/models/data-check-diff-value.js +16 -0
  78. package/dist/adminapi/models/data-check-diff-value.js.map +1 -0
  79. package/dist/adminapi/models/data-check-item.d.ts +120 -0
  80. package/dist/adminapi/models/data-check-item.d.ts.map +1 -0
  81. package/dist/adminapi/models/data-check-item.js +16 -0
  82. package/dist/adminapi/models/data-check-item.js.map +1 -0
  83. package/dist/adminapi/models/data-check-list-item.d.ts +120 -0
  84. package/dist/adminapi/models/data-check-list-item.d.ts.map +1 -0
  85. package/dist/adminapi/models/data-check-list-item.js +16 -0
  86. package/dist/adminapi/models/data-check-list-item.js.map +1 -0
  87. package/dist/adminapi/models/data-check-list-summary.d.ts +49 -0
  88. package/dist/adminapi/models/data-check-list-summary.d.ts.map +1 -0
  89. package/dist/adminapi/models/data-check-list-summary.js +16 -0
  90. package/dist/adminapi/models/data-check-list-summary.js.map +1 -0
  91. package/dist/adminapi/models/data-check-status.d.ts +23 -0
  92. package/dist/adminapi/models/data-check-status.d.ts.map +1 -0
  93. package/dist/adminapi/models/data-check-status.js +27 -0
  94. package/dist/adminapi/models/data-check-status.js.map +1 -0
  95. package/dist/adminapi/models/data-check-summary.d.ts +56 -0
  96. package/dist/adminapi/models/data-check-summary.d.ts.map +1 -0
  97. package/dist/adminapi/models/data-check-summary.js +16 -0
  98. package/dist/adminapi/models/data-check-summary.js.map +1 -0
  99. package/dist/adminapi/models/data-check-table-summary.d.ts +67 -0
  100. package/dist/adminapi/models/data-check-table-summary.d.ts.map +1 -0
  101. package/dist/adminapi/models/data-check-table-summary.js +16 -0
  102. package/dist/adminapi/models/data-check-table-summary.js.map +1 -0
  103. package/dist/adminapi/models/data-check-type.d.ts +22 -0
  104. package/dist/adminapi/models/data-check-type.d.ts.map +1 -0
  105. package/dist/adminapi/models/data-check-type.js +26 -0
  106. package/dist/adminapi/models/data-check-type.js.map +1 -0
  107. package/dist/adminapi/models/data-replication-channel-container.d.ts +37 -0
  108. package/dist/adminapi/models/data-replication-channel-container.d.ts.map +1 -0
  109. package/dist/adminapi/models/data-replication-channel-container.js +16 -0
  110. package/dist/adminapi/models/data-replication-channel-container.js.map +1 -0
  111. package/dist/adminapi/models/data-replication-create.d.ts +85 -0
  112. package/dist/adminapi/models/data-replication-create.d.ts.map +1 -0
  113. package/dist/adminapi/models/data-replication-create.js +16 -0
  114. package/dist/adminapi/models/data-replication-create.js.map +1 -0
  115. package/dist/adminapi/models/data-replication-endpoint-type.d.ts +22 -0
  116. package/dist/adminapi/models/data-replication-endpoint-type.d.ts.map +1 -0
  117. package/dist/adminapi/models/data-replication-endpoint-type.js +26 -0
  118. package/dist/adminapi/models/data-replication-endpoint-type.js.map +1 -0
  119. package/dist/adminapi/models/data-replication-ops-type.d.ts +23 -0
  120. package/dist/adminapi/models/data-replication-ops-type.d.ts.map +1 -0
  121. package/dist/adminapi/models/data-replication-ops-type.js +27 -0
  122. package/dist/adminapi/models/data-replication-ops-type.js.map +1 -0
  123. package/dist/adminapi/models/data-replication-parameters-response-detail.d.ts +57 -0
  124. package/dist/adminapi/models/data-replication-parameters-response-detail.d.ts.map +1 -0
  125. package/dist/adminapi/models/data-replication-parameters-response-detail.js +16 -0
  126. package/dist/adminapi/models/data-replication-parameters-response-detail.js.map +1 -0
  127. package/dist/adminapi/models/data-replication-update.d.ts +32 -0
  128. package/dist/adminapi/models/data-replication-update.d.ts.map +1 -0
  129. package/dist/adminapi/models/data-replication-update.js +16 -0
  130. package/dist/adminapi/models/data-replication-update.js.map +1 -0
  131. package/dist/adminapi/models/event-item.d.ts +55 -0
  132. package/dist/adminapi/models/event-item.d.ts.map +1 -0
  133. package/dist/adminapi/models/event-item.js +16 -0
  134. package/dist/adminapi/models/event-item.js.map +1 -0
  135. package/dist/adminapi/models/index.d.ts +34 -0
  136. package/dist/adminapi/models/index.d.ts.map +1 -1
  137. package/dist/adminapi/models/index.js +34 -0
  138. package/dist/adminapi/models/index.js.map +1 -1
  139. package/dist/adminapi/models/kubeblocks-endpoint.d.ts +49 -0
  140. package/dist/adminapi/models/kubeblocks-endpoint.d.ts.map +1 -0
  141. package/dist/adminapi/models/kubeblocks-endpoint.js +16 -0
  142. package/dist/adminapi/models/kubeblocks-endpoint.js.map +1 -0
  143. package/dist/adminapi/models/pre-check-create.d.ts +51 -0
  144. package/dist/adminapi/models/pre-check-create.d.ts.map +1 -0
  145. package/dist/adminapi/models/pre-check-create.js +16 -0
  146. package/dist/adminapi/models/pre-check-create.js.map +1 -0
  147. package/dist/adminapi/models/replication-object-query.d.ts +56 -0
  148. package/dist/adminapi/models/replication-object-query.d.ts.map +1 -0
  149. package/dist/adminapi/models/replication-object-query.js +16 -0
  150. package/dist/adminapi/models/replication-object-query.js.map +1 -0
  151. package/dist/openapi/models/cluster-mode-transition.d.ts +7 -0
  152. package/dist/openapi/models/cluster-mode-transition.d.ts.map +1 -1
  153. package/dist/openapi/models/data-channel-item.d.ts +6 -0
  154. package/dist/openapi/models/data-channel-item.d.ts.map +1 -1
  155. package/dist/openapi/models/data-check-item.d.ts +6 -0
  156. package/dist/openapi/models/data-check-item.d.ts.map +1 -1
  157. package/dist/openapi/models/data-check-list-item.d.ts +6 -0
  158. package/dist/openapi/models/data-check-list-item.d.ts.map +1 -1
  159. package/package.json +1 -1
  160. package/src/adminapi/.openapi-generator/FILES +35 -0
  161. package/src/adminapi/api.ts +1 -0
  162. package/src/adminapi/apis/data-replication-api.ts +2370 -0
  163. package/src/adminapi/models/auth-type.ts +30 -0
  164. package/src/adminapi/models/basic-auth-model.ts +36 -0
  165. package/src/adminapi/models/channel-status.ts +37 -0
  166. package/src/adminapi/models/cluster-mode-transition.ts +11 -0
  167. package/src/adminapi/models/custom-endpoint-create.ts +50 -0
  168. package/src/adminapi/models/custom-endpoint.ts +56 -0
  169. package/src/adminapi/models/data-channel-detail.ts +42 -0
  170. package/src/adminapi/models/data-channel-endpoint-create.ts +71 -0
  171. package/src/adminapi/models/data-channel-item.ts +134 -0
  172. package/src/adminapi/models/data-channel-list-endpoint.ts +65 -0
  173. package/src/adminapi/models/data-channel-module-progress.ts +54 -0
  174. package/src/adminapi/models/data-channel-parameter-key-value.ts +36 -0
  175. package/src/adminapi/models/data-channel-progress.ts +39 -0
  176. package/src/adminapi/models/data-channel-response.ts +48 -0
  177. package/src/adminapi/models/data-check-detail-item.ts +93 -0
  178. package/src/adminapi/models/data-check-detail-type.ts +31 -0
  179. package/src/adminapi/models/data-check-details.ts +42 -0
  180. package/src/adminapi/models/data-check-diff-value.ts +48 -0
  181. package/src/adminapi/models/data-check-item.ts +137 -0
  182. package/src/adminapi/models/data-check-list-item.ts +137 -0
  183. package/src/adminapi/models/data-check-list-summary.ts +54 -0
  184. package/src/adminapi/models/data-check-status.ts +32 -0
  185. package/src/adminapi/models/data-check-summary.ts +63 -0
  186. package/src/adminapi/models/data-check-table-summary.ts +72 -0
  187. package/src/adminapi/models/data-check-type.ts +31 -0
  188. package/src/adminapi/models/data-replication-channel-container.ts +42 -0
  189. package/src/adminapi/models/data-replication-create.ts +96 -0
  190. package/src/adminapi/models/data-replication-endpoint-type.ts +31 -0
  191. package/src/adminapi/models/data-replication-ops-type.ts +32 -0
  192. package/src/adminapi/models/data-replication-parameters-response-detail.ts +68 -0
  193. package/src/adminapi/models/data-replication-update.ts +39 -0
  194. package/src/adminapi/models/event-item.ts +60 -0
  195. package/src/adminapi/models/index.ts +34 -0
  196. package/src/adminapi/models/kubeblocks-endpoint.ts +54 -0
  197. package/src/adminapi/models/pre-check-create.ts +60 -0
  198. package/src/adminapi/models/replication-object-query.ts +63 -0
  199. package/src/adminapi.yaml +2069 -797
  200. package/src/openapi/models/cluster-mode-transition.ts +11 -0
  201. package/src/openapi/models/data-channel-item.ts +6 -0
  202. package/src/openapi/models/data-check-item.ts +6 -0
  203. package/src/openapi/models/data-check-list-item.ts +6 -0
  204. package/src/openapi.yaml +9 -0
package/src/adminapi.yaml CHANGED
@@ -26219,6 +26219,695 @@ paths:
26219
26219
  $ref: '#/components/responses/403'
26220
26220
  '404':
26221
26221
  $ref: '#/components/responses/404'
26222
+ /admin/v1/replication/channel:
26223
+ get:
26224
+ operationId: listAdminDataChannels
26225
+ summary: List Data Channels
26226
+ description: Retrieve a list of data channels.
26227
+ parameters:
26228
+ - description: The Name of the organization
26229
+ in: query
26230
+ name: orgName
26231
+ required: false
26232
+ schema:
26233
+ type: string
26234
+ - description: The name of the data channel
26235
+ in: query
26236
+ name: name
26237
+ required: false
26238
+ schema:
26239
+ type: string
26240
+ - description: The status of the data channel
26241
+ in: query
26242
+ name: status
26243
+ required: false
26244
+ schema:
26245
+ type: array
26246
+ items:
26247
+ type: string
26248
+ responses:
26249
+ '200':
26250
+ content:
26251
+ application/json:
26252
+ schema:
26253
+ $ref: '#/components/schemas/dataChannelList'
26254
+ description: A list of data channels.
26255
+ '401':
26256
+ $ref: '#/components/responses/401'
26257
+ '403':
26258
+ $ref: '#/components/responses/403'
26259
+ '404':
26260
+ $ref: '#/components/responses/404'
26261
+ tags:
26262
+ - dataReplication
26263
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}:
26264
+ get:
26265
+ operationId: getDataChannel
26266
+ summary: Get Data Channel Details
26267
+ description: Retrieve a data channel detail.
26268
+ parameters:
26269
+ - description: The Name of the organization
26270
+ in: path
26271
+ name: orgName
26272
+ required: true
26273
+ schema:
26274
+ type: string
26275
+ - description: The ID of the data channel
26276
+ in: path
26277
+ name: channelID
26278
+ required: true
26279
+ schema:
26280
+ type: string
26281
+ responses:
26282
+ '200':
26283
+ content:
26284
+ application/json:
26285
+ schema:
26286
+ $ref: '#/components/schemas/dataChannelDetail'
26287
+ description: A detail of data channel.
26288
+ '401':
26289
+ $ref: '#/components/responses/401'
26290
+ '403':
26291
+ $ref: '#/components/responses/403'
26292
+ '404':
26293
+ $ref: '#/components/responses/404'
26294
+ tags:
26295
+ - dataReplication
26296
+ delete:
26297
+ operationId: deleteDataChannel
26298
+ summary: Delete a data channel
26299
+ description: Delete a data channel.
26300
+ parameters:
26301
+ - description: The Name of the organization
26302
+ in: path
26303
+ name: orgName
26304
+ required: true
26305
+ schema:
26306
+ type: string
26307
+ - description: The ID of the data channel
26308
+ in: path
26309
+ name: channelID
26310
+ required: true
26311
+ schema:
26312
+ type: string
26313
+ responses:
26314
+ '204':
26315
+ content: {}
26316
+ description: Returned when channel is deleted successfully.
26317
+ '401':
26318
+ $ref: '#/components/responses/401'
26319
+ '403':
26320
+ $ref: '#/components/responses/403'
26321
+ '404':
26322
+ $ref: '#/components/responses/404'
26323
+ tags:
26324
+ - dataReplication
26325
+ patch:
26326
+ operationId: updateDataChannel
26327
+ summary: Update a data channel
26328
+ description: Update a new data channel.
26329
+ parameters:
26330
+ - description: The Name of the organization
26331
+ in: path
26332
+ name: orgName
26333
+ required: true
26334
+ schema:
26335
+ type: string
26336
+ - description: The ID of the data channel
26337
+ in: path
26338
+ name: channelID
26339
+ required: true
26340
+ schema:
26341
+ type: string
26342
+ requestBody:
26343
+ content:
26344
+ application/json:
26345
+ schema:
26346
+ $ref: '#/components/schemas/dataReplicationUpdate'
26347
+ required: true
26348
+ responses:
26349
+ '200':
26350
+ content:
26351
+ application/json:
26352
+ schema:
26353
+ $ref: '#/components/schemas/dataChannelResponse'
26354
+ description: A successful response.
26355
+ '401':
26356
+ $ref: '#/components/responses/401'
26357
+ '403':
26358
+ $ref: '#/components/responses/403'
26359
+ '404':
26360
+ $ref: '#/components/responses/404'
26361
+ tags:
26362
+ - dataReplication
26363
+ x-codegen-request-body-name: body
26364
+ /admin/v1/checks:
26365
+ get:
26366
+ operationId: listAdminDataChecks
26367
+ summary: List Data Checks
26368
+ description: Retrieve a list of standalone data checks.
26369
+ parameters:
26370
+ - description: The Name of the organization
26371
+ in: query
26372
+ name: orgName
26373
+ required: false
26374
+ schema:
26375
+ type: string
26376
+ - description: The name of the check
26377
+ in: query
26378
+ name: name
26379
+ required: false
26380
+ schema:
26381
+ type: string
26382
+ - description: The status of the check
26383
+ in: query
26384
+ name: status
26385
+ required: false
26386
+ schema:
26387
+ type: array
26388
+ items:
26389
+ type: string
26390
+ responses:
26391
+ '200':
26392
+ content:
26393
+ application/json:
26394
+ schema:
26395
+ $ref: '#/components/schemas/dataCheckList'
26396
+ description: A list of checks.
26397
+ '401':
26398
+ $ref: '#/components/responses/401'
26399
+ '403':
26400
+ $ref: '#/components/responses/403'
26401
+ '404':
26402
+ $ref: '#/components/responses/404'
26403
+ tags:
26404
+ - dataReplication
26405
+ /admin/v1/organizations/{orgName}/checks/{checkID}:
26406
+ get:
26407
+ operationId: getDataCheck
26408
+ summary: Get Data Check
26409
+ description: Retrieve a standalone data check detail.
26410
+ parameters:
26411
+ - description: The Name of the organization
26412
+ in: path
26413
+ name: orgName
26414
+ required: true
26415
+ schema:
26416
+ type: string
26417
+ - description: The ID of the check
26418
+ in: path
26419
+ name: checkID
26420
+ required: true
26421
+ schema:
26422
+ type: string
26423
+ responses:
26424
+ '200':
26425
+ content:
26426
+ application/json:
26427
+ schema:
26428
+ $ref: '#/components/schemas/dataCheckItem'
26429
+ description: A check detail.
26430
+ '401':
26431
+ $ref: '#/components/responses/401'
26432
+ '403':
26433
+ $ref: '#/components/responses/403'
26434
+ '404':
26435
+ $ref: '#/components/responses/404'
26436
+ tags:
26437
+ - dataReplication
26438
+ delete:
26439
+ operationId: deleteDataCheck
26440
+ summary: Delete a data check
26441
+ description: Delete a standalone data check and its runtime resources.
26442
+ parameters:
26443
+ - description: The Name of the organization
26444
+ in: path
26445
+ name: orgName
26446
+ required: true
26447
+ schema:
26448
+ type: string
26449
+ - description: The ID of the check
26450
+ in: path
26451
+ name: checkID
26452
+ required: true
26453
+ schema:
26454
+ type: string
26455
+ responses:
26456
+ '204':
26457
+ content: {}
26458
+ description: Returned when check is deleted successfully.
26459
+ '401':
26460
+ $ref: '#/components/responses/401'
26461
+ '403':
26462
+ $ref: '#/components/responses/403'
26463
+ '404':
26464
+ $ref: '#/components/responses/404'
26465
+ tags:
26466
+ - dataReplication
26467
+ /admin/v1/organizations/{orgName}/checks/{checkID}/details:
26468
+ get:
26469
+ operationId: getDataCheckDetails
26470
+ summary: Get Data Check Difference Details
26471
+ description: Read typed check miss or diff details from the latest parsed check result.
26472
+ parameters:
26473
+ - description: The Name of the organization
26474
+ in: path
26475
+ name: orgName
26476
+ required: true
26477
+ schema:
26478
+ type: string
26479
+ - description: The ID of the check
26480
+ in: path
26481
+ name: checkID
26482
+ required: true
26483
+ schema:
26484
+ type: string
26485
+ - description: The detail type
26486
+ in: query
26487
+ name: type
26488
+ required: true
26489
+ schema:
26490
+ $ref: '#/components/schemas/dataCheckDetailType'
26491
+ - description: Source schema or database. Required for snapshot checks.
26492
+ in: query
26493
+ name: schema
26494
+ required: false
26495
+ schema:
26496
+ type: string
26497
+ - description: Source table. Required for snapshot checks.
26498
+ in: query
26499
+ name: table
26500
+ required: false
26501
+ schema:
26502
+ type: string
26503
+ - description: Struct object key. Optional for struct checks; omitted to page all struct details.
26504
+ in: query
26505
+ name: key
26506
+ required: false
26507
+ schema:
26508
+ type: string
26509
+ - description: Page number for pagination.
26510
+ in: query
26511
+ name: page
26512
+ required: false
26513
+ schema:
26514
+ type: integer
26515
+ minimum: 1
26516
+ default: 1
26517
+ - description: Number of items per page.
26518
+ in: query
26519
+ name: pageSize
26520
+ required: false
26521
+ schema:
26522
+ type: integer
26523
+ minimum: 1
26524
+ maximum: 1000
26525
+ default: 100
26526
+ responses:
26527
+ '200':
26528
+ content:
26529
+ application/json:
26530
+ schema:
26531
+ $ref: '#/components/schemas/dataCheckDetails'
26532
+ description: A successful response.
26533
+ '401':
26534
+ $ref: '#/components/responses/401'
26535
+ '403':
26536
+ $ref: '#/components/responses/403'
26537
+ '404':
26538
+ $ref: '#/components/responses/404'
26539
+ tags:
26540
+ - dataReplication
26541
+ /admin/v1/organizations/{orgName}/checks/{checkID}/sqlLogs:
26542
+ get:
26543
+ operationId: getDataCheckSQLLogs
26544
+ summary: Get Data Check SQL Logs
26545
+ description: Read raw SQL lines emitted by check sql_logger entries.
26546
+ parameters:
26547
+ - description: The Name of the organization
26548
+ in: path
26549
+ name: orgName
26550
+ required: true
26551
+ schema:
26552
+ type: string
26553
+ - description: The ID of the check
26554
+ in: path
26555
+ name: checkID
26556
+ required: true
26557
+ schema:
26558
+ type: string
26559
+ responses:
26560
+ '200':
26561
+ content:
26562
+ text/plain:
26563
+ schema:
26564
+ type: string
26565
+ description: Raw SQL lines.
26566
+ '401':
26567
+ $ref: '#/components/responses/401'
26568
+ '403':
26569
+ $ref: '#/components/responses/403'
26570
+ '404':
26571
+ $ref: '#/components/responses/404'
26572
+ tags:
26573
+ - dataReplication
26574
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/ops/{opsType}:
26575
+ post:
26576
+ operationId: createDataChannelOps
26577
+ summary: Create a new data channel ops
26578
+ description: Create a new data channel ops.
26579
+ parameters:
26580
+ - description: The Name of the organization
26581
+ in: path
26582
+ name: orgName
26583
+ required: true
26584
+ schema:
26585
+ type: string
26586
+ - description: The ID of the data channel
26587
+ in: path
26588
+ name: channelID
26589
+ required: true
26590
+ schema:
26591
+ type: string
26592
+ - description: The operation type
26593
+ in: path
26594
+ name: opsType
26595
+ required: true
26596
+ schema:
26597
+ $ref: '#/components/schemas/dataReplicationOpsType'
26598
+ responses:
26599
+ '204':
26600
+ content: {}
26601
+ description: Returned when operation is completed successfully.
26602
+ '401':
26603
+ $ref: '#/components/responses/401'
26604
+ '403':
26605
+ $ref: '#/components/responses/403'
26606
+ '404':
26607
+ $ref: '#/components/responses/404'
26608
+ tags:
26609
+ - dataReplication
26610
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/events:
26611
+ get:
26612
+ operationId: listDataChannelEvents
26613
+ summary: List Data Channel Events
26614
+ description: Retrieve a list of data channel events.
26615
+ parameters:
26616
+ - description: The Name of the organization
26617
+ in: path
26618
+ name: orgName
26619
+ required: true
26620
+ schema:
26621
+ type: string
26622
+ - description: The ID of the data channel
26623
+ in: path
26624
+ name: channelID
26625
+ required: true
26626
+ schema:
26627
+ type: string
26628
+ responses:
26629
+ '200':
26630
+ content:
26631
+ application/json:
26632
+ schema:
26633
+ $ref: '#/components/schemas/dataReplicationEventList'
26634
+ description: A list of data channel events.
26635
+ '401':
26636
+ $ref: '#/components/responses/401'
26637
+ '403':
26638
+ $ref: '#/components/responses/403'
26639
+ '404':
26640
+ $ref: '#/components/responses/404'
26641
+ tags:
26642
+ - dataReplication
26643
+ /admin/v1/organizations/{orgName}/replication/channel/objects:
26644
+ post:
26645
+ operationId: queryReplicationObject
26646
+ summary: query replication object
26647
+ description: query replication object.
26648
+ parameters:
26649
+ - description: The Name of the organization
26650
+ in: path
26651
+ name: orgName
26652
+ required: true
26653
+ schema:
26654
+ type: string
26655
+ requestBody:
26656
+ content:
26657
+ application/json:
26658
+ schema:
26659
+ $ref: '#/components/schemas/replicationObjectQuery'
26660
+ required: true
26661
+ responses:
26662
+ '200':
26663
+ content:
26664
+ application/json:
26665
+ schema:
26666
+ $ref: '#/components/schemas/replicationObjectTree'
26667
+ description: A successful response.
26668
+ '401':
26669
+ $ref: '#/components/responses/401'
26670
+ '403':
26671
+ $ref: '#/components/responses/403'
26672
+ '404':
26673
+ $ref: '#/components/responses/404'
26674
+ '501':
26675
+ $ref: '#/components/responses/501'
26676
+ tags:
26677
+ - dataReplication
26678
+ x-codegen-request-body-name: body
26679
+ /admin/v1/organizations/{orgName}/replication/channel/precheck:
26680
+ post:
26681
+ operationId: createPreCheck
26682
+ summary: create pre check
26683
+ description: create pre check.
26684
+ parameters:
26685
+ - description: The Name of the organization
26686
+ in: path
26687
+ name: orgName
26688
+ required: true
26689
+ schema:
26690
+ type: string
26691
+ requestBody:
26692
+ content:
26693
+ application/json:
26694
+ schema:
26695
+ $ref: '#/components/schemas/preCheckCreate'
26696
+ required: true
26697
+ responses:
26698
+ '200':
26699
+ content:
26700
+ application/json:
26701
+ schema:
26702
+ $ref: '#/components/schemas/preCheckTaskResponse'
26703
+ description: A successful response.
26704
+ '401':
26705
+ $ref: '#/components/responses/401'
26706
+ '403':
26707
+ $ref: '#/components/responses/403'
26708
+ '404':
26709
+ $ref: '#/components/responses/404'
26710
+ tags:
26711
+ - dataReplication
26712
+ x-codegen-request-body-name: body
26713
+ /admin/v1/organizations/{orgName}/replication/channel/precheck/{preCheckID}:
26714
+ get:
26715
+ operationId: getPreCheck
26716
+ summary: get preCheck
26717
+ description: get preCheck.
26718
+ parameters:
26719
+ - description: The ID of the preCheck task
26720
+ in: path
26721
+ name: preCheckID
26722
+ required: true
26723
+ schema:
26724
+ type: string
26725
+ - description: The Name of the organization
26726
+ in: path
26727
+ name: orgName
26728
+ required: true
26729
+ schema:
26730
+ type: string
26731
+ responses:
26732
+ '200':
26733
+ content:
26734
+ application/json:
26735
+ schema:
26736
+ $ref: '#/components/schemas/preCheckTaskDetail'
26737
+ description: A successful response.
26738
+ '401':
26739
+ $ref: '#/components/responses/401'
26740
+ '403':
26741
+ $ref: '#/components/responses/403'
26742
+ '404':
26743
+ $ref: '#/components/responses/404'
26744
+ tags:
26745
+ - dataReplication
26746
+ delete:
26747
+ deprecated: true
26748
+ operationId: deletePreCheck
26749
+ summary: delete preCheck
26750
+ description: delete preCheck.
26751
+ parameters:
26752
+ - description: The ID of the preCheck task
26753
+ in: path
26754
+ name: preCheckID
26755
+ required: true
26756
+ schema:
26757
+ type: string
26758
+ - description: The Name of the organization
26759
+ in: path
26760
+ name: orgName
26761
+ required: true
26762
+ schema:
26763
+ type: string
26764
+ responses:
26765
+ '204':
26766
+ content: {}
26767
+ description: Returned when preCheck is deleted successfully.
26768
+ '401':
26769
+ $ref: '#/components/responses/401'
26770
+ '403':
26771
+ $ref: '#/components/responses/403'
26772
+ '404':
26773
+ $ref: '#/components/responses/404'
26774
+ tags:
26775
+ - dataReplication
26776
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/logs:
26777
+ get:
26778
+ description: Query logs of a data channel
26779
+ summary: Query data channel logs
26780
+ operationId: queryDataChannelLogs
26781
+ parameters:
26782
+ - description: The Name of the organization
26783
+ in: path
26784
+ name: orgName
26785
+ required: true
26786
+ schema:
26787
+ type: string
26788
+ - in: path
26789
+ name: channelID
26790
+ required: true
26791
+ schema:
26792
+ type: string
26793
+ - in: query
26794
+ name: moduleName
26795
+ schema:
26796
+ type: string
26797
+ - in: query
26798
+ name: containerName
26799
+ schema:
26800
+ type: string
26801
+ required: false
26802
+ - in: query
26803
+ name: limit
26804
+ schema:
26805
+ type: string
26806
+ responses:
26807
+ '200':
26808
+ content:
26809
+ text/plain:
26810
+ schema:
26811
+ type: string
26812
+ description: channel logs output
26813
+ '401':
26814
+ $ref: '#/components/responses/401'
26815
+ '403':
26816
+ $ref: '#/components/responses/403'
26817
+ '404':
26818
+ $ref: '#/components/responses/404'
26819
+ tags:
26820
+ - dataReplication
26821
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/containers:
26822
+ get:
26823
+ description: Query containers of a data channel module pod
26824
+ summary: Query data channel module pod containers
26825
+ operationId: queryDataChannelContainers
26826
+ parameters:
26827
+ - description: The Name of the organization
26828
+ in: path
26829
+ name: orgName
26830
+ required: true
26831
+ schema:
26832
+ type: string
26833
+ - in: path
26834
+ name: channelID
26835
+ required: true
26836
+ schema:
26837
+ type: string
26838
+ - in: query
26839
+ name: moduleName
26840
+ schema:
26841
+ type: string
26842
+ responses:
26843
+ '200':
26844
+ content:
26845
+ application/json:
26846
+ schema:
26847
+ type: array
26848
+ items:
26849
+ $ref: '#/components/schemas/dataReplicationChannelContainer'
26850
+ description: A list of data channel module containers.
26851
+ '401':
26852
+ $ref: '#/components/responses/401'
26853
+ '403':
26854
+ $ref: '#/components/responses/403'
26855
+ '404':
26856
+ $ref: '#/components/responses/404'
26857
+ tags:
26858
+ - dataReplication
26859
+ /admin/v1/organizations/{orgName}/replication/channel/parameters:
26860
+ get:
26861
+ operationId: listDataChannelParameters
26862
+ summary: List Data Channel Parameters
26863
+ description: Retrieve a list of data channel parameters.
26864
+ parameters:
26865
+ - description: The Name of the organization
26866
+ in: path
26867
+ name: orgName
26868
+ required: true
26869
+ schema:
26870
+ type: string
26871
+ - description: The name of the standard definition
26872
+ in: query
26873
+ name: standardName
26874
+ schema:
26875
+ type: string
26876
+ - description: The ID of the data channel
26877
+ in: query
26878
+ name: channelID
26879
+ schema:
26880
+ type: string
26881
+ - description: The source EngineDeifnition name
26882
+ in: query
26883
+ name: source
26884
+ schema:
26885
+ type: string
26886
+ - description: The target EngineDeifnition name
26887
+ in: query
26888
+ name: target
26889
+ schema:
26890
+ type: string
26891
+ - description: The module name
26892
+ in: query
26893
+ name: moduleName
26894
+ schema:
26895
+ type: string
26896
+ responses:
26897
+ '200':
26898
+ content:
26899
+ application/json:
26900
+ schema:
26901
+ $ref: '#/components/schemas/dataReplicationParametersResponse'
26902
+ description: A list of data channel parameters.
26903
+ '401':
26904
+ $ref: '#/components/responses/401'
26905
+ '403':
26906
+ $ref: '#/components/responses/403'
26907
+ '404':
26908
+ $ref: '#/components/responses/404'
26909
+ tags:
26910
+ - dataReplication
26222
26911
  components:
26223
26912
  securitySchemes:
26224
26913
  BearerToken:
@@ -29179,6 +29868,9 @@ components:
29179
29868
  $ref: '#/components/schemas/taskSchedule'
29180
29869
  hScale:
29181
29870
  $ref: '#/components/schemas/opsHScale'
29871
+ networkMode:
29872
+ description: Specify the network mode the cluster transitions to. Defaults to the network mode of the cluster when omitted.
29873
+ $ref: '#/components/schemas/networkMode'
29182
29874
  opsRequestName:
29183
29875
  description: OpsRequestName is the name of a KubeBlocks OpsRequest response
29184
29876
  properties:
@@ -46075,1060 +46767,1640 @@ components:
46075
46767
  pageResult:
46076
46768
  $ref: '#/components/schemas/pageResult'
46077
46769
  required:
46078
- - items
46079
- type: object
46080
- dataChannelObject:
46770
+ - items
46771
+ type: object
46772
+ dataChannelObject:
46773
+ type: object
46774
+ properties:
46775
+ includeObjects:
46776
+ type: array
46777
+ items:
46778
+ type: string
46779
+ excludeObjects:
46780
+ type: array
46781
+ items:
46782
+ type: string
46783
+ nullable: true
46784
+ ImportPreflightRequest:
46785
+ description: Data source preflight request
46786
+ type: object
46787
+ required:
46788
+ - sourceType
46789
+ - connectionConfig
46790
+ properties:
46791
+ sourceType:
46792
+ type: string
46793
+ description: Data source type
46794
+ connectionConfig:
46795
+ type: object
46796
+ description: Connection configuration parameters that vary by data source type
46797
+ example:
46798
+ host: mysql-source.example.com
46799
+ port: 3306
46800
+ username: migration_user
46801
+ password: secret123
46802
+ sslMode: disable
46803
+ objectSelection:
46804
+ $ref: '#/components/schemas/dataChannelObject'
46805
+ preCheckTaskResponse:
46806
+ type: object
46807
+ properties:
46808
+ taskId:
46809
+ type: string
46810
+ preCheckStatus:
46811
+ enum:
46812
+ - Pending
46813
+ - Running
46814
+ - Succeed
46815
+ - Failed
46816
+ type: string
46817
+ preCheckTaskItem:
46818
+ type: object
46819
+ properties:
46820
+ checkerName:
46821
+ type: string
46822
+ checkerDesc:
46823
+ type: string
46824
+ message:
46825
+ type: string
46826
+ nullable: true
46827
+ status:
46828
+ $ref: '#/components/schemas/preCheckStatus'
46829
+ preCheckResult:
46830
+ type: object
46831
+ properties:
46832
+ name:
46833
+ type: string
46834
+ checkerName:
46835
+ type: string
46836
+ message:
46837
+ type: string
46838
+ nullable: true
46839
+ advice:
46840
+ type: string
46841
+ nullable: true
46842
+ preCheckTaskDetail:
46843
+ type: object
46844
+ properties:
46845
+ taskID:
46846
+ type: string
46847
+ taskStatus:
46848
+ $ref: '#/components/schemas/preCheckStatus'
46849
+ progress:
46850
+ type: integer
46851
+ format: int32
46852
+ nullable: true
46853
+ checkers:
46854
+ type: array
46855
+ items:
46856
+ $ref: '#/components/schemas/preCheckTaskItem'
46857
+ errors:
46858
+ type: array
46859
+ items:
46860
+ $ref: '#/components/schemas/preCheckResult'
46861
+ nullable: true
46862
+ warnings:
46863
+ type: array
46864
+ items:
46865
+ $ref: '#/components/schemas/preCheckResult'
46866
+ nullable: true
46867
+ createdAt:
46868
+ type: string
46869
+ format: date-time
46870
+ completedAt:
46871
+ type: string
46872
+ format: date-time
46873
+ nullable: true
46874
+ ImportQueryObjectsRequest:
46875
+ description: Request payload for querying import data source objects.
46876
+ type: object
46877
+ required:
46878
+ - sourceType
46879
+ - connectionConfig
46880
+ properties:
46881
+ sourceType:
46882
+ $ref: '#/components/schemas/ImportSourceType'
46883
+ description: Data source type to query objects from.
46884
+ connectionConfig:
46885
+ type: object
46886
+ description: Connection configuration parameters that vary by data source type.
46887
+ example:
46888
+ host: mysql-source.example.com
46889
+ port: 3306
46890
+ username: migration_user
46891
+ password: secret123
46892
+ sslMode: disable
46893
+ nodeType:
46894
+ type: string
46895
+ description: Current node type in the replication object tree.
46896
+ nodeValue:
46897
+ type: string
46898
+ description: Encoded node value of the current tree node.
46899
+ queryNodeType:
46900
+ type: string
46901
+ description: Target node type to enumerate for the next level.
46902
+ replicationObjectNode:
46903
+ type: object
46904
+ properties:
46905
+ nodeName:
46906
+ type: string
46907
+ nodeValue:
46908
+ type: string
46909
+ replicationObjectTree:
46910
+ type: object
46911
+ properties:
46912
+ nodeType:
46913
+ type: string
46914
+ nodeValues:
46915
+ type: array
46916
+ items:
46917
+ $ref: '#/components/schemas/replicationObjectNode'
46918
+ childrenNodeTypes:
46919
+ type: array
46920
+ nullable: true
46921
+ items:
46922
+ type: string
46923
+ ImportTaskStatus:
46924
+ type: string
46925
+ description: Import task status
46926
+ enum:
46927
+ - Pending
46928
+ - Initializing
46929
+ - Finished
46930
+ - Failed
46931
+ - Deleting
46932
+ ImportTaskResponse:
46933
+ description: Import task response
46934
+ type: object
46935
+ properties:
46936
+ id:
46937
+ type: string
46938
+ description: Import task ID
46939
+ name:
46940
+ type: string
46941
+ description: Import name
46942
+ status:
46943
+ $ref: '#/components/schemas/ImportTaskStatus'
46944
+ sourceEndpoint:
46945
+ type: string
46946
+ description: Source endpoint address
46947
+ targetClusterName:
46948
+ type: string
46949
+ description: Target cluster name
46950
+ progress:
46951
+ type: integer
46952
+ format: int32
46953
+ minimum: 0
46954
+ maximum: 100
46955
+ default: 0
46956
+ description: Overall progress
46957
+ sourceType:
46958
+ type: string
46959
+ description: Data source type
46960
+ targetEngine:
46961
+ type: string
46962
+ description: Target engine type
46963
+ syncTimestamp:
46964
+ type: string
46965
+ format: date-time
46966
+ description: Sync timestamp
46967
+ nullable: true
46968
+ delaySecond:
46969
+ type: integer
46970
+ description: Delay seconds
46971
+ nullable: true
46972
+ createdAt:
46973
+ type: string
46974
+ format: date-time
46975
+ description: Creation time
46976
+ updatedAt:
46977
+ type: string
46978
+ format: date-time
46979
+ description: Update time
46980
+ finishedAt:
46981
+ type: string
46982
+ format: date-time
46983
+ description: Finish time
46984
+ nullable: true
46985
+ message:
46986
+ type: string
46987
+ description: Operation result message
46988
+ nullable: true
46989
+ required:
46990
+ - id
46991
+ - name
46992
+ - status
46993
+ - sourceEndpoint
46994
+ - targetClusterName
46995
+ - progress
46996
+ - sourceType
46997
+ - targetEngine
46998
+ - createdAt
46999
+ - updatedAt
47000
+ - message
47001
+ ImportTaskListResponse:
47002
+ description: Import task list response
46081
47003
  type: object
46082
47004
  properties:
46083
- includeObjects:
46084
- type: array
46085
- items:
46086
- type: string
46087
- excludeObjects:
47005
+ items:
46088
47006
  type: array
46089
47007
  items:
46090
- type: string
46091
- nullable: true
46092
- ImportPreflightRequest:
46093
- description: Data source preflight request
47008
+ $ref: '#/components/schemas/ImportTaskResponse'
47009
+ description: Task list
47010
+ required:
47011
+ - items
47012
+ ImportTaskCreateRequest:
47013
+ description: Create import task request
46094
47014
  type: object
46095
47015
  required:
46096
47016
  - sourceType
46097
47017
  - connectionConfig
46098
47018
  properties:
46099
- sourceType:
47019
+ name:
46100
47020
  type: string
46101
- description: Data source type
47021
+ description: Import name
47022
+ sourceType:
47023
+ $ref: '#/components/schemas/ImportSourceType'
46102
47024
  connectionConfig:
46103
47025
  type: object
46104
- description: Connection configuration parameters that vary by data source type
46105
- example:
46106
- host: mysql-source.example.com
46107
- port: 3306
46108
- username: migration_user
46109
- password: secret123
46110
- sslMode: disable
47026
+ description: Connection configuration
46111
47027
  objectSelection:
46112
47028
  $ref: '#/components/schemas/dataChannelObject'
46113
- preCheckTaskResponse:
46114
- type: object
46115
- properties:
46116
- taskId:
46117
- type: string
46118
- preCheckStatus:
46119
- enum:
46120
- - Pending
46121
- - Running
46122
- - Succeed
46123
- - Failed
47029
+ ImportOpsType:
46124
47030
  type: string
46125
- preCheckTaskItem:
47031
+ description: Import task operation type
47032
+ enum:
47033
+ - pause
47034
+ - resume
47035
+ environmentPricing:
46126
47036
  type: object
47037
+ description: the information of environment pricing
47038
+ required:
47039
+ - envName
47040
+ - cpuPrice
47041
+ - memoryPrice
47042
+ - storagePrice
47043
+ - backupPrice
46127
47044
  properties:
46128
- checkerName:
47045
+ envName:
47046
+ description: The environment name
46129
47047
  type: string
46130
- checkerDesc:
47048
+ nullable: true
47049
+ cpuPrice:
47050
+ description: The price of CPU, the unit is 'Core'
46131
47051
  type: string
46132
- message:
47052
+ nullable: true
47053
+ memoryPrice:
47054
+ description: The price of Memory, the unit is 'GB'
46133
47055
  type: string
46134
47056
  nullable: true
46135
- status:
46136
- $ref: '#/components/schemas/preCheckStatus'
46137
- preCheckResult:
47057
+ storagePrice:
47058
+ description: The price of Storage, the unit is 'GB'
47059
+ type: string
47060
+ nullable: true
47061
+ backupPrice:
47062
+ description: The price of Backup, the unit is 'GB'
47063
+ type: string
47064
+ nullable: true
47065
+ environmentPricingList:
46138
47066
  type: object
47067
+ description: list of information with environment pricing
46139
47068
  properties:
46140
- name:
47069
+ items:
47070
+ description: Items is the list of environment pricing information
47071
+ items:
47072
+ $ref: '#/components/schemas/environmentPricing'
47073
+ type: array
47074
+ required:
47075
+ - items
47076
+ globalPricing:
47077
+ type: object
47078
+ description: the global information of pricing
47079
+ required:
47080
+ - billScheduleTime
47081
+ - cpuPrice
47082
+ - memoryPrice
47083
+ - storagePrice
47084
+ - backupPrice
47085
+ properties:
47086
+ enabled:
47087
+ description: Enable global pricing
47088
+ type: boolean
47089
+ x-omitempty: false
47090
+ currencyUnit:
47091
+ description: The currency uint for display in bill query
46141
47092
  type: string
46142
- checkerName:
47093
+ nullable: true
47094
+ billScheduleTime:
47095
+ description: Scheduled production time for daily bills, the format is 'HH:mm:ss', such as '01:00:00' meas every day at 1:00 AM, use the configured timezone
46143
47096
  type: string
46144
- message:
47097
+ nullable: true
47098
+ example: '01:00:00'
47099
+ lastBillingTime:
47100
+ description: |
47101
+ The last billing time in RFC3339 format (e.g., '2025-09-01T00:00:00Z' or '2025-09-01T00:00:00+08:00').
47102
+ This timestamp represents when the end time of the latest bill.
46145
47103
  type: string
47104
+ format: date-time
46146
47105
  nullable: true
46147
- advice:
47106
+ example: '2025-09-02T00:00:00Z'
47107
+ cpuPrice:
47108
+ description: The price of CPU, the unit is 'Core'
46148
47109
  type: string
46149
47110
  nullable: true
46150
- preCheckTaskDetail:
47111
+ memoryPrice:
47112
+ description: The price of Memory, the unit is 'GB'
47113
+ type: string
47114
+ nullable: true
47115
+ storagePrice:
47116
+ description: The price of Storage, the unit is 'GB'
47117
+ type: string
47118
+ nullable: true
47119
+ backupPrice:
47120
+ description: The price of Backup, the unit is 'GB'
47121
+ type: string
47122
+ nullable: true
47123
+ timezone:
47124
+ description: |
47125
+ The timezone used for billing calculations and time alignment, specified as an IANA timezone identifier.
47126
+
47127
+ This timezone determines:
47128
+ - When daily billing periods start and end (aligned to midnight in this timezone)
47129
+ - How input timestamps are converted and normalized for billing calculations
47130
+ - The timezone context for scheduled billing operations
47131
+
47132
+ Examples of valid timezone values:
47133
+ - "UTC" - Coordinated Universal Time
47134
+ - "Asia/Shanghai" - China Standard Time (CST, UTC+8)
47135
+ - "America/New_York" - Eastern Time (EST/EDT, UTC-5/-4)
47136
+ - "Europe/London" - Greenwich Mean Time/British Summer Time (GMT/BST, UTC+0/+1)
47137
+
47138
+ **The system defaults to UTC and not support to change for now.**
47139
+ type: string
47140
+ nullable: true
47141
+ example: UTC
47142
+ BasicTask:
46151
47143
  type: object
47144
+ description: Task information
46152
47145
  properties:
46153
- taskID:
47146
+ taskId:
47147
+ description: Task ID
46154
47148
  type: string
46155
- taskStatus:
46156
- $ref: '#/components/schemas/preCheckStatus'
46157
- progress:
47149
+ nullable: true
47150
+ required:
47151
+ - taskId
47152
+ aggregationTimeType:
47153
+ description: The type of aggregation time
47154
+ enum:
47155
+ - yearly
47156
+ - monthly
47157
+ - quarterly
47158
+ - daily
47159
+ type: string
47160
+ nullable: true
47161
+ aggregationGroupType:
47162
+ description: The type of aggregation group
47163
+ enum:
47164
+ - global
47165
+ - organization
47166
+ - project
47167
+ - cluster
47168
+ type: string
47169
+ nullable: true
47170
+ Bill:
47171
+ type: object
47172
+ description: Task information
47173
+ properties:
47174
+ dataTime:
47175
+ description: |
47176
+ The Unix timestamp (seconds since epoch) representing the start of the billing period.
46158
47177
  type: integer
46159
- format: int32
47178
+ format: int64
47179
+ example: 1756656000
47180
+ price:
47181
+ description: The total price
47182
+ type: string
47183
+ clusterID:
47184
+ description: The ID of cluster
47185
+ type: string
46160
47186
  nullable: true
46161
- checkers:
46162
- type: array
46163
- items:
46164
- $ref: '#/components/schemas/preCheckTaskItem'
46165
- errors:
46166
- type: array
46167
- items:
46168
- $ref: '#/components/schemas/preCheckResult'
47187
+ x-omitempty: true
47188
+ clusterName:
47189
+ description: The Name of cluster
47190
+ type: string
46169
47191
  nullable: true
46170
- warnings:
46171
- type: array
46172
- items:
46173
- $ref: '#/components/schemas/preCheckResult'
47192
+ x-omitempty: true
47193
+ clusterDisplayName:
47194
+ description: The Display Name of cluster
47195
+ type: string
47196
+ nullable: true
47197
+ x-omitempty: true
47198
+ engine:
47199
+ description: Cluster Application Engine
47200
+ type: string
47201
+ nullable: true
47202
+ x-omitempty: true
47203
+ version:
47204
+ description: Cluster Application Version
47205
+ type: string
47206
+ nullable: true
47207
+ x-omitempty: true
47208
+ mode:
47209
+ description: Cluster topology mode
47210
+ type: string
46174
47211
  nullable: true
46175
- createdAt:
47212
+ x-omitempty: true
47213
+ orgName:
47214
+ description: The Name of organization
46176
47215
  type: string
46177
- format: date-time
46178
- completedAt:
47216
+ nullable: true
47217
+ x-omitempty: true
47218
+ projectName:
47219
+ description: The Name of project
46179
47220
  type: string
46180
- format: date-time
46181
47221
  nullable: true
46182
- ImportQueryObjectsRequest:
46183
- description: Request payload for querying import data source objects.
47222
+ x-omitempty: true
47223
+ BillList:
46184
47224
  type: object
47225
+ description: list price details in date range
47226
+ properties:
47227
+ items:
47228
+ description: Items of the price
47229
+ items:
47230
+ $ref: '#/components/schemas/Bill'
47231
+ type: array
46185
47232
  required:
46186
- - sourceType
46187
- - connectionConfig
47233
+ - items
47234
+ MeteringTrack:
47235
+ type: object
47236
+ description: RTS metering track information
46188
47237
  properties:
46189
- sourceType:
46190
- $ref: '#/components/schemas/ImportSourceType'
46191
- description: Data source type to query objects from.
46192
- connectionConfig:
46193
- type: object
46194
- description: Connection configuration parameters that vary by data source type.
46195
- example:
46196
- host: mysql-source.example.com
46197
- port: 3306
46198
- username: migration_user
46199
- password: secret123
46200
- sslMode: disable
46201
- nodeType:
47238
+ clusterID:
47239
+ description: The ID of cluster
46202
47240
  type: string
46203
- description: Current node type in the replication object tree.
46204
- nodeValue:
47241
+ nullable: true
47242
+ x-omitempty: true
47243
+ orgName:
47244
+ description: The Name of organization
46205
47245
  type: string
46206
- description: Encoded node value of the current tree node.
46207
- queryNodeType:
47246
+ nullable: true
47247
+ x-omitempty: true
47248
+ projectName:
47249
+ description: The Name of project
46208
47250
  type: string
46209
- description: Target node type to enumerate for the next level.
46210
- replicationObjectNode:
46211
- type: object
46212
- properties:
46213
- nodeName:
47251
+ nullable: true
47252
+ x-omitempty: true
47253
+ environmentID:
47254
+ description: The ID of environment
46214
47255
  type: string
46215
- nodeValue:
47256
+ nullable: true
47257
+ x-omitempty: true
47258
+ startTime:
47259
+ description: The clipped start time of the metering track in Unix timestamp (seconds since epoch)
47260
+ type: integer
47261
+ format: int64
47262
+ example: 1756656000
47263
+ endTime:
47264
+ description: The clipped end time of the metering track in Unix timestamp (seconds since epoch)
47265
+ type: integer
47266
+ format: int64
47267
+ example: 1756663200
47268
+ cpu:
47269
+ description: The CPU usage tracked for the interval
46216
47270
  type: string
46217
- replicationObjectTree:
47271
+ memory:
47272
+ description: The memory usage tracked for the interval
47273
+ type: string
47274
+ storage:
47275
+ description: The storage usage tracked for the interval
47276
+ type: string
47277
+ backup:
47278
+ description: The backup usage tracked for the interval
47279
+ type: string
47280
+ MeteringTrackList:
46218
47281
  type: object
47282
+ description: list metering tracks in date range
46219
47283
  properties:
46220
- nodeType:
46221
- type: string
46222
- nodeValues:
46223
- type: array
47284
+ items:
47285
+ description: Items of the metering tracks
46224
47286
  items:
46225
- $ref: '#/components/schemas/replicationObjectNode'
46226
- childrenNodeTypes:
47287
+ $ref: '#/components/schemas/MeteringTrack'
46227
47288
  type: array
46228
- nullable: true
46229
- items:
46230
- type: string
46231
- ImportTaskStatus:
46232
- type: string
46233
- description: Import task status
46234
- enum:
46235
- - Pending
46236
- - Initializing
46237
- - Finished
46238
- - Failed
46239
- - Deleting
46240
- ImportTaskResponse:
46241
- description: Import task response
47289
+ pagination:
47290
+ $ref: '#/components/schemas/paginationResult'
47291
+ required:
47292
+ - items
47293
+ SLACluster:
46242
47294
  type: object
47295
+ description: The cluster summary used by SLA calculation results. SLA responses can be built from historical outage data, so general cluster list fields may be unavailable.
46243
47296
  properties:
46244
47297
  id:
46245
47298
  type: string
46246
- description: Import task ID
47299
+ description: ID of cluster.
46247
47300
  name:
46248
47301
  type: string
46249
- description: Import name
46250
- status:
46251
- $ref: '#/components/schemas/ImportTaskStatus'
46252
- sourceEndpoint:
47302
+ description: Name of cluster.
47303
+ displayName:
46253
47304
  type: string
46254
- description: Source endpoint address
46255
- targetClusterName:
47305
+ description: Display name of cluster.
47306
+ orgName:
46256
47307
  type: string
46257
- description: Target cluster name
46258
- progress:
46259
- type: integer
46260
- format: int32
46261
- minimum: 0
46262
- maximum: 100
46263
- default: 0
46264
- description: Overall progress
46265
- sourceType:
47308
+ description: Org Name.
47309
+ environmentName:
46266
47310
  type: string
46267
- description: Data source type
46268
- targetEngine:
47311
+ description: Environment Name.
47312
+ engine:
46269
47313
  type: string
46270
- description: Target engine type
46271
- syncTimestamp:
47314
+ description: Cluster Application Engine.
47315
+ clusterType:
47316
+ $ref: '#/components/schemas/clusterType'
47317
+ createdAt:
46272
47318
  type: string
46273
47319
  format: date-time
46274
- description: Sync timestamp
47320
+ x-nullable: true
47321
+ description: The timestamp when the cluster was created, when available.
47322
+ status:
47323
+ type: string
47324
+ description: The SLA calculation status for the cluster.
47325
+ version:
47326
+ type: string
47327
+ description: Cluster Application Version.
47328
+ OutageRecord:
47329
+ type: object
47330
+ description: Records the outage events of a cluster for SLA calculation. It is designed to ensure that for any given cluster, there can be at most one active outage record at any time.
47331
+ required:
47332
+ - clusterID
47333
+ properties:
47334
+ id:
47335
+ type: string
47336
+ description: The unique identifier for the outage record.
47337
+ clusterID:
47338
+ type: string
47339
+ description: The id of cluster.
47340
+ outageStartTime:
47341
+ type: integer
47342
+ format: int64
47343
+ description: The Unix timestamp (in seconds) when the outage began (UTC).
47344
+ outageEndTime:
47345
+ type: integer
47346
+ format: int64
46275
47347
  nullable: true
46276
- delaySecond:
47348
+ description: The Unix timestamp (in seconds) when the outage was resolved (UTC). A null value indicates that the outage is still ongoing.
47349
+ lastFailureReason:
47350
+ type: string
47351
+ nullable: true
47352
+ description: The error message from the last failed probe.
47353
+ failureCount:
46277
47354
  type: integer
46278
- description: Delay seconds
47355
+ format: int32
46279
47356
  nullable: true
47357
+ description: The number of consecutive failures in this outage event.
47358
+ default: 1
46280
47359
  createdAt:
46281
47360
  type: string
46282
47361
  format: date-time
46283
- description: Creation time
47362
+ description: The timestamp when the record was created.
47363
+ readOnly: true
46284
47364
  updatedAt:
46285
47365
  type: string
46286
47366
  format: date-time
46287
- description: Update time
46288
- finishedAt:
46289
- type: string
46290
- format: date-time
46291
- description: Finish time
46292
- nullable: true
46293
- message:
46294
- type: string
46295
- description: Operation result message
46296
- nullable: true
46297
- required:
46298
- - id
46299
- - name
46300
- - status
46301
- - sourceEndpoint
46302
- - targetClusterName
46303
- - progress
46304
- - sourceType
46305
- - targetEngine
46306
- - createdAt
46307
- - updatedAt
46308
- - message
46309
- ImportTaskListResponse:
46310
- description: Import task list response
47367
+ description: The timestamp when the record was last updated.
47368
+ readOnly: true
47369
+ OutageRecordList:
47370
+ type: array
47371
+ description: A list of outage records.
47372
+ items:
47373
+ $ref: '#/components/schemas/OutageRecord'
47374
+ SLA:
47375
+ type: object
47376
+ description: The SLA (Service Level Agreement) for a cluster.
47377
+ properties:
47378
+ cluster:
47379
+ type: object
47380
+ $ref: '#/components/schemas/SLACluster'
47381
+ detail:
47382
+ type: object
47383
+ $ref: '#/components/schemas/OutageRecordList'
47384
+ sla:
47385
+ type: number
47386
+ description: The SLA value for the cluster.
47387
+ targetThreshold:
47388
+ type: number
47389
+ description: The target SLA threshold value for the cluster.
47390
+ totalDuration:
47391
+ type: integer
47392
+ format: int64
47393
+ description: The total duration of the outage records.
47394
+ totalDowntime:
47395
+ type: integer
47396
+ format: int64
47397
+ description: The total downtime duration of the outage records.
47398
+ SLAList:
47399
+ type: array
47400
+ description: A list of SLA records.
47401
+ items:
47402
+ $ref: '#/components/schemas/SLA'
47403
+ ClustersSLA:
46311
47404
  type: object
47405
+ description: The SLA (Service Level Agreement) for a cluster.
46312
47406
  properties:
46313
47407
  items:
46314
- type: array
46315
- items:
46316
- $ref: '#/components/schemas/ImportTaskResponse'
46317
- description: Task list
46318
- required:
46319
- - items
46320
- ImportTaskCreateRequest:
46321
- description: Create import task request
46322
- type: object
46323
- required:
46324
- - sourceType
46325
- - connectionConfig
46326
- properties:
46327
- name:
46328
- type: string
46329
- description: Import name
46330
- sourceType:
46331
- $ref: '#/components/schemas/ImportSourceType'
46332
- connectionConfig:
46333
47408
  type: object
46334
- description: Connection configuration
46335
- objectSelection:
46336
- $ref: '#/components/schemas/dataChannelObject'
46337
- ImportOpsType:
46338
- type: string
46339
- description: Import task operation type
46340
- enum:
46341
- - pause
46342
- - resume
46343
- environmentPricing:
47409
+ $ref: '#/components/schemas/SLAList'
47410
+ total:
47411
+ type: integer
47412
+ format: int64
47413
+ description: The total number of cluster SLA records.
47414
+ DailySLA:
46344
47415
  type: object
46345
- description: the information of environment pricing
46346
- required:
46347
- - envName
46348
- - cpuPrice
46349
- - memoryPrice
46350
- - storagePrice
46351
- - backupPrice
47416
+ description: The SLA (Service Level Agreement) for a cluster on a specific date.
46352
47417
  properties:
46353
- envName:
46354
- description: The environment name
46355
- type: string
46356
- nullable: true
46357
- cpuPrice:
46358
- description: The price of CPU, the unit is 'Core'
47418
+ date:
46359
47419
  type: string
47420
+ description: The date for which the SLA is calculated, formatted as YYYY-MM-DD.
47421
+ sla:
47422
+ type: number
47423
+ description: The SLA value for the cluster on the specified date. Null indicates that the cluster was not existing on that date.
47424
+ x-omitempty: false
46360
47425
  nullable: true
46361
- memoryPrice:
46362
- description: The price of Memory, the unit is 'GB'
47426
+ DailySLAList:
47427
+ type: array
47428
+ description: A list of daily SLA records.
47429
+ items:
47430
+ $ref: '#/components/schemas/DailySLA'
47431
+ SLASettings:
47432
+ type: object
47433
+ properties:
47434
+ environmentName:
46363
47435
  type: string
46364
- nullable: true
46365
- storagePrice:
46366
- description: The price of Storage, the unit is 'GB'
47436
+ description: The name of the environment.
47437
+ probeInterval:
46367
47438
  type: string
46368
- nullable: true
46369
- backupPrice:
46370
- description: The price of Backup, the unit is 'GB'
47439
+ format: duration
47440
+ probeTimeout:
46371
47441
  type: string
46372
- nullable: true
46373
- environmentPricingList:
46374
- type: object
46375
- description: list of information with environment pricing
46376
- properties:
46377
- items:
46378
- description: Items is the list of environment pricing information
46379
- items:
46380
- $ref: '#/components/schemas/environmentPricing'
46381
- type: array
46382
- required:
46383
- - items
46384
- globalPricing:
46385
- type: object
46386
- description: the global information of pricing
46387
- required:
46388
- - billScheduleTime
46389
- - cpuPrice
46390
- - memoryPrice
46391
- - storagePrice
46392
- - backupPrice
46393
- properties:
46394
- enabled:
46395
- description: Enable global pricing
47442
+ format: duration
47443
+ enableProbeRetry:
46396
47444
  type: boolean
46397
47445
  x-omitempty: false
46398
- currencyUnit:
46399
- description: The currency uint for display in bill query
47446
+ probeRetryCount:
47447
+ type: integer
47448
+ x-omitempty: false
47449
+ probeRetryInterval:
46400
47450
  type: string
46401
- nullable: true
46402
- billScheduleTime:
46403
- description: Scheduled production time for daily bills, the format is 'HH:mm:ss', such as '01:00:00' meas every day at 1:00 AM, use the configured timezone
47451
+ format: duration
47452
+ probeEngines:
47453
+ type: array
47454
+ items:
47455
+ type: string
47456
+ probePoolSize:
47457
+ type: integer
47458
+ x-omitempty: false
47459
+ collectorBatchSize:
47460
+ type: integer
47461
+ collectorMaxWaitTime:
46404
47462
  type: string
46405
- nullable: true
46406
- example: '01:00:00'
46407
- lastBillingTime:
46408
- description: |
46409
- The last billing time in RFC3339 format (e.g., '2025-09-01T00:00:00Z' or '2025-09-01T00:00:00+08:00').
46410
- This timestamp represents when the end time of the latest bill.
47463
+ format: duration
47464
+ slaThreshold:
47465
+ type: number
47466
+ description: The SLA threshold value for the cluster.
47467
+ affectedClusterItem:
47468
+ description: a cluster which is affected by the vulnerability
47469
+ properties:
47470
+ id:
47471
+ description: the ID of the cluster
46411
47472
  type: string
46412
- format: date-time
46413
- nullable: true
46414
- example: '2025-09-02T00:00:00Z'
46415
- cpuPrice:
46416
- description: The price of CPU, the unit is 'Core'
47473
+ name:
47474
+ description: the name of the cluster
46417
47475
  type: string
46418
- nullable: true
46419
- memoryPrice:
46420
- description: The price of Memory, the unit is 'GB'
47476
+ displayName:
47477
+ description: the display name of the cluster
46421
47478
  type: string
46422
- nullable: true
46423
- storagePrice:
46424
- description: The price of Storage, the unit is 'GB'
47479
+ clusterType:
47480
+ description: the type of the cluster
46425
47481
  type: string
46426
- nullable: true
46427
- backupPrice:
46428
- description: The price of Backup, the unit is 'GB'
47482
+ engine:
47483
+ description: the engine of the cluster
46429
47484
  type: string
46430
- nullable: true
46431
- timezone:
46432
- description: |
46433
- The timezone used for billing calculations and time alignment, specified as an IANA timezone identifier.
46434
-
46435
- This timezone determines:
46436
- - When daily billing periods start and end (aligned to midnight in this timezone)
46437
- - How input timestamps are converted and normalized for billing calculations
46438
- - The timezone context for scheduled billing operations
46439
-
46440
- Examples of valid timezone values:
46441
- - "UTC" - Coordinated Universal Time
46442
- - "Asia/Shanghai" - China Standard Time (CST, UTC+8)
46443
- - "America/New_York" - Eastern Time (EST/EDT, UTC-5/-4)
46444
- - "Europe/London" - Greenwich Mean Time/British Summer Time (GMT/BST, UTC+0/+1)
46445
-
46446
- **The system defaults to UTC and not support to change for now.**
47485
+ orgName:
47486
+ description: the name of the organization
46447
47487
  type: string
46448
- nullable: true
46449
- example: UTC
46450
- BasicTask:
46451
- type: object
46452
- description: Task information
47488
+ refItem:
47489
+ description: a reference of the vulnerability
46453
47490
  properties:
46454
- taskId:
46455
- description: Task ID
47491
+ rType:
47492
+ description: the type of the reference
47493
+ type: string
47494
+ url:
47495
+ description: the URL of the reference
46456
47496
  type: string
46457
- nullable: true
46458
47497
  required:
46459
- - taskId
46460
- aggregationTimeType:
46461
- description: The type of aggregation time
46462
- enum:
46463
- - yearly
46464
- - monthly
46465
- - quarterly
46466
- - daily
46467
- type: string
46468
- nullable: true
46469
- aggregationGroupType:
46470
- description: The type of aggregation group
46471
- enum:
46472
- - global
46473
- - organization
46474
- - project
46475
- - cluster
46476
- type: string
46477
- nullable: true
46478
- Bill:
46479
- type: object
46480
- description: Task information
47498
+ - rType
47499
+ - url
47500
+ vulnListItem:
47501
+ description: a vulnerability which affected the cluster
46481
47502
  properties:
46482
- dataTime:
46483
- description: |
46484
- The Unix timestamp (seconds since epoch) representing the start of the billing period.
46485
- type: integer
46486
- format: int64
46487
- example: 1756656000
46488
- price:
46489
- description: The total price
46490
- type: string
46491
- clusterID:
46492
- description: The ID of cluster
47503
+ cveId:
47504
+ description: the CVE ID of the vulnerability
46493
47505
  type: string
46494
- nullable: true
46495
- x-omitempty: true
46496
- clusterName:
46497
- description: The Name of cluster
47506
+ engineName:
47507
+ description: the engine name of the vulnerability
46498
47508
  type: string
46499
- nullable: true
46500
- x-omitempty: true
46501
- clusterDisplayName:
46502
- description: The Display Name of cluster
47509
+ productName:
47510
+ description: the product name of the vulnerability
46503
47511
  type: string
46504
- nullable: true
46505
- x-omitempty: true
46506
- engine:
46507
- description: Cluster Application Engine
47512
+ versions:
47513
+ description: the versions of the product which are affected by the vulnerability
47514
+ type: array
47515
+ items:
47516
+ type: string
47517
+ fixedVersions:
47518
+ description: the fixed versions of the product which fixed the vulnerability
47519
+ type: array
47520
+ items:
47521
+ type: string
47522
+ affectedClusters:
47523
+ description: the clusters which are affected by the vulnerability
47524
+ type: array
47525
+ items:
47526
+ $ref: '#/components/schemas/affectedClusterItem'
47527
+ detail:
47528
+ description: the detail of the vulnerability
46508
47529
  type: string
46509
- nullable: true
46510
- x-omitempty: true
46511
- version:
46512
- description: Cluster Application Version
47530
+ severity:
47531
+ description: the severity of the vulnerability
46513
47532
  type: string
46514
- nullable: true
46515
- x-omitempty: true
46516
- mode:
46517
- description: Cluster topology mode
47533
+ cvssVector:
47534
+ description: the CVSS vector and score of the vulnerability
46518
47535
  type: string
46519
- nullable: true
46520
- x-omitempty: true
46521
- orgName:
46522
- description: The Name of organization
47536
+ publishedAt:
47537
+ description: the published time of the vulnerability
46523
47538
  type: string
46524
- nullable: true
46525
- x-omitempty: true
46526
- projectName:
46527
- description: The Name of project
47539
+ format: date-time
47540
+ modifiedAt:
47541
+ description: the modified time of the vulnerability
46528
47542
  type: string
46529
- nullable: true
46530
- x-omitempty: true
46531
- BillList:
46532
- type: object
46533
- description: list price details in date range
47543
+ format: date-time
47544
+ refs:
47545
+ description: the references of the vulnerability
47546
+ type: array
47547
+ items:
47548
+ $ref: '#/components/schemas/refItem'
47549
+ required:
47550
+ - cveId
47551
+ - engineName
47552
+ - productName
47553
+ - versions
47554
+ - severity
47555
+ - publishedAt
47556
+ - modifiedAt
47557
+ vulnList:
47558
+ description: a list of vulnerabilities
46534
47559
  properties:
46535
47560
  items:
46536
- description: Items of the price
47561
+ description: a list of vulnerabilities
46537
47562
  items:
46538
- $ref: '#/components/schemas/Bill'
47563
+ $ref: '#/components/schemas/vulnListItem'
46539
47564
  type: array
47565
+ pageResult:
47566
+ $ref: '#/components/schemas/pageResult'
46540
47567
  required:
46541
47568
  - items
46542
- MeteringTrack:
46543
47569
  type: object
46544
- description: RTS metering track information
47570
+ vulnUploadFormData:
47571
+ description: the data of the upload task
47572
+ type: object
47573
+ required:
47574
+ - file
46545
47575
  properties:
46546
- clusterID:
46547
- description: The ID of cluster
47576
+ file:
46548
47577
  type: string
46549
- nullable: true
46550
- x-omitempty: true
46551
- orgName:
46552
- description: The Name of organization
47578
+ format: binary
47579
+ description: the data file, zip or other format
47580
+ markVulnsAsIgnored:
47581
+ description: the data of the mark request
47582
+ type: object
47583
+ required:
47584
+ - cveId
47585
+ - engineName
47586
+ - productName
47587
+ properties:
47588
+ cveId:
46553
47589
  type: string
46554
- nullable: true
46555
- x-omitempty: true
46556
- projectName:
46557
- description: The Name of project
47590
+ description: the CVE ID of the vulnerability
47591
+ engineName:
46558
47592
  type: string
46559
- nullable: true
46560
- x-omitempty: true
46561
- environmentID:
46562
- description: The ID of environment
47593
+ description: the engine name of the vulnerability
47594
+ productName:
46563
47595
  type: string
46564
- nullable: true
46565
- x-omitempty: true
46566
- startTime:
46567
- description: The clipped start time of the metering track in Unix timestamp (seconds since epoch)
46568
- type: integer
46569
- format: int64
46570
- example: 1756656000
46571
- endTime:
46572
- description: The clipped end time of the metering track in Unix timestamp (seconds since epoch)
46573
- type: integer
46574
- format: int64
46575
- example: 1756663200
46576
- cpu:
46577
- description: The CPU usage tracked for the interval
47596
+ description: the product name of the vulnerability
47597
+ vulnItem:
47598
+ description: a vulnerability which affected the cluster
47599
+ properties:
47600
+ cveId:
47601
+ description: the CVE ID of the vulnerability
46578
47602
  type: string
46579
- memory:
46580
- description: The memory usage tracked for the interval
47603
+ detail:
47604
+ description: the detail of the vulnerability
46581
47605
  type: string
46582
- storage:
46583
- description: The storage usage tracked for the interval
47606
+ severity:
47607
+ description: the severity of the vulnerability
46584
47608
  type: string
46585
- backup:
46586
- description: The backup usage tracked for the interval
47609
+ cvssVector:
47610
+ description: the CVSS vector and score of the vulnerability
46587
47611
  type: string
46588
- MeteringTrackList:
47612
+ publishedAt:
47613
+ description: the published time of the vulnerability
47614
+ type: string
47615
+ format: date-time
47616
+ modifiedAt:
47617
+ description: the modified time of the vulnerability
47618
+ type: string
47619
+ format: date-time
47620
+ refs:
47621
+ description: the references of the vulnerability
47622
+ type: array
47623
+ items:
47624
+ $ref: '#/components/schemas/refItem'
47625
+ required:
47626
+ - cveId
47627
+ - severity
47628
+ - publishedAt
47629
+ - modifiedAt
47630
+ clusterVulns:
47631
+ description: a list of vulnerabilities which affected the cluster
46589
47632
  type: object
46590
- description: list metering tracks in date range
47633
+ required:
47634
+ - items
46591
47635
  properties:
46592
47636
  items:
46593
- description: Items of the metering tracks
46594
- items:
46595
- $ref: '#/components/schemas/MeteringTrack'
46596
47637
  type: array
46597
- pagination:
46598
- $ref: '#/components/schemas/paginationResult'
46599
- required:
46600
- - items
46601
- SLACluster:
47638
+ items:
47639
+ $ref: '#/components/schemas/vulnItem'
47640
+ engineSchedulingPolicy:
46602
47641
  type: object
46603
- description: The cluster summary used by SLA calculation results. SLA responses can be built from historical outage data, so general cluster list fields may be unavailable.
47642
+ description: Engine-level default scheduling policy for a specific engine and engine mode.
46604
47643
  properties:
46605
47644
  id:
46606
47645
  type: string
46607
- description: ID of cluster.
46608
- name:
47646
+ description: Id of engine scheduling policy.
47647
+ schedulingPolicyType:
47648
+ description: Scheduling policy type applied by default to matching clusters unless overridden by a environment-level or cluster-level setting.
47649
+ $ref: '#/components/schemas/schedulingPolicyType'
47650
+ engine:
46609
47651
  type: string
46610
- description: Name of cluster.
46611
- displayName:
47652
+ description: Database engine that this policy applies to. Used together with `engineMode`.
47653
+ engineMode:
46612
47654
  type: string
46613
- description: Display name of cluster.
46614
- orgName:
47655
+ description: Engine mode that this policy applies to, such as `standalone` or `replication`.
47656
+ description:
46615
47657
  type: string
46616
- description: Org Name.
46617
- environmentName:
47658
+ description: Human-readable description of the engine scheduling policy.
47659
+ required:
47660
+ - engine
47661
+ - engineMode
47662
+ - schedulingPolicyType
47663
+ target_role:
47664
+ type: string
47665
+ enum:
47666
+ - Primary
47667
+ - '*'
47668
+ description: |
47669
+ Role name to match. Use `*` to match all roles, including components without an explicit role.
47670
+ default: '*'
47671
+ target:
47672
+ type: object
47673
+ description: Identifies one side of a scheduling rule match, including component and role.
47674
+ properties:
47675
+ component:
46618
47676
  type: string
46619
- description: Environment Name.
46620
- engine:
47677
+ description: |
47678
+ Component name to match. Use `*` to match all components for the selected engine mode.
47679
+ default: '*'
47680
+ role:
47681
+ $ref: '#/components/schemas/target_role'
47682
+ engineSchedulingRule:
47683
+ type: object
47684
+ properties:
47685
+ id:
46621
47686
  type: string
46622
- description: Cluster Application Engine.
46623
- clusterType:
46624
- $ref: '#/components/schemas/clusterType'
46625
- createdAt:
47687
+ description: Id of engine scheduling rule.
47688
+ name:
46626
47689
  type: string
46627
- format: date-time
46628
- x-nullable: true
46629
- description: The timestamp when the cluster was created, when available.
46630
- status:
47690
+ description: Rule name, used to reference this rule when applying scheduling policies to a cluster.
47691
+ engine:
46631
47692
  type: string
46632
- description: The SLA calculation status for the cluster.
46633
- version:
47693
+ description: Database engine type this rule applies to. Used to match rules to clusters by engine.
47694
+ engineMode:
46634
47695
  type: string
46635
- description: Cluster Application Version.
46636
- OutageRecord:
47696
+ description: Cluster mode this rule applies to. Used to match rules to clusters by mode.
47697
+ targetSelector:
47698
+ type: array
47699
+ description: Selects the two mutually exclusive targets that this rule applies to. The array length must be exactly 2.
47700
+ items:
47701
+ $ref: '#/components/schemas/target'
47702
+ schedulingPolicyType:
47703
+ description: Scheduling policy type to apply when this rule matches.
47704
+ $ref: '#/components/schemas/schedulingPolicyType'
47705
+ description:
47706
+ type: string
47707
+ description: Optional description of the scheduling rule.
47708
+ default:
47709
+ description: Indicates whether this rule is used as the fallback when no other rule matches.
47710
+ type: boolean
47711
+ nullable: true
47712
+ required:
47713
+ - name
47714
+ - engine
47715
+ - engineMode
47716
+ - targetSelector
47717
+ - schedulingPolicyType
47718
+ environmentEngineOption:
46637
47719
  type: object
46638
- description: Records the outage events of a cluster for SLA calculation. It is designed to ensure that for any given cluster, there can be at most one active outage record at any time.
46639
47720
  required:
46640
- - clusterID
47721
+ - id
47722
+ - engineName
47723
+ - mode
47724
+ - networkModes
47725
+ - envId
47726
+ - envName
46641
47727
  properties:
46642
47728
  id:
46643
47729
  type: string
46644
- description: The unique identifier for the outage record.
46645
- clusterID:
47730
+ description: record id
47731
+ engineName:
46646
47732
  type: string
46647
- description: The id of cluster.
46648
- outageStartTime:
46649
- type: integer
46650
- format: int64
46651
- description: The Unix timestamp (in seconds) when the outage began (UTC).
46652
- outageEndTime:
46653
- type: integer
46654
- format: int64
46655
- nullable: true
46656
- description: The Unix timestamp (in seconds) when the outage was resolved (UTC). A null value indicates that the outage is still ongoing.
46657
- lastFailureReason:
47733
+ description: engine name
47734
+ mode:
46658
47735
  type: string
46659
- nullable: true
46660
- description: The error message from the last failed probe.
46661
- failureCount:
46662
- type: integer
46663
- format: int32
46664
- nullable: true
46665
- description: The number of consecutive failures in this outage event.
46666
- default: 1
46667
- createdAt:
47736
+ description: engine mode
47737
+ networkModes:
47738
+ type: array
47739
+ items:
47740
+ type: string
47741
+ description: network modes configured for this engine+mode+env combination
47742
+ envId:
47743
+ type: string
47744
+ format: uuid
47745
+ description: environment id
47746
+ envName:
47747
+ type: string
47748
+ description: environment name
47749
+ createTime:
46668
47750
  type: string
46669
47751
  format: date-time
46670
- description: The timestamp when the record was created.
46671
- readOnly: true
46672
- updatedAt:
47752
+ description: create time
47753
+ updateTime:
46673
47754
  type: string
46674
47755
  format: date-time
46675
- description: The timestamp when the record was last updated.
46676
- readOnly: true
46677
- OutageRecordList:
47756
+ description: update time
47757
+ environmentEngineOptionList:
46678
47758
  type: array
46679
- description: A list of outage records.
46680
47759
  items:
46681
- $ref: '#/components/schemas/OutageRecord'
46682
- SLA:
47760
+ $ref: '#/components/schemas/environmentEngineOption'
47761
+ environmentEngineOptionCreate:
46683
47762
  type: object
46684
- description: The SLA (Service Level Agreement) for a cluster.
47763
+ required:
47764
+ - engineName
47765
+ - mode
47766
+ - networkModes
46685
47767
  properties:
46686
- cluster:
46687
- type: object
46688
- $ref: '#/components/schemas/SLACluster'
46689
- detail:
47768
+ engineName:
47769
+ type: string
47770
+ description: engine name
47771
+ mode:
47772
+ type: string
47773
+ description: engine mode
47774
+ networkModes:
47775
+ type: array
47776
+ items:
47777
+ type: string
47778
+ description: network modes
47779
+ environmentEngineOptionUpdate:
47780
+ type: object
47781
+ required:
47782
+ - networkModes
47783
+ properties:
47784
+ networkModes:
47785
+ type: array
47786
+ items:
47787
+ type: string
47788
+ description: environment engine option to update
47789
+ engineNetworkModeSupported:
47790
+ type: object
47791
+ properties:
47792
+ supported:
47793
+ type: array
47794
+ items:
47795
+ $ref: '#/components/schemas/networkMode'
47796
+ description: supported network modes
47797
+ notSupportedVersions:
46690
47798
  type: object
46691
- $ref: '#/components/schemas/OutageRecordList'
46692
- sla:
46693
- type: number
46694
- description: The SLA value for the cluster.
46695
- targetThreshold:
46696
- type: number
46697
- description: The target SLA threshold value for the cluster.
46698
- totalDuration:
46699
- type: integer
46700
- format: int64
46701
- description: The total duration of the outage records.
46702
- totalDowntime:
46703
- type: integer
46704
- format: int64
46705
- description: The total downtime duration of the outage records.
46706
- SLAList:
47799
+ additionalProperties:
47800
+ type: array
47801
+ items:
47802
+ type: string
47803
+ description: not supported versions, key is networkMode, value is array of versions
47804
+ engineNetworkModeOptions:
46707
47805
  type: array
46708
- description: A list of SLA records.
46709
47806
  items:
46710
- $ref: '#/components/schemas/SLA'
46711
- ClustersSLA:
47807
+ type: object
47808
+ required:
47809
+ - engineName
47810
+ - mode
47811
+ - networkModes
47812
+ properties:
47813
+ engineName:
47814
+ type: string
47815
+ description: engine name
47816
+ mode:
47817
+ type: string
47818
+ description: engine mode
47819
+ networkModes:
47820
+ type: array
47821
+ items:
47822
+ $ref: '#/components/schemas/networkMode'
47823
+ description: available network modes for this engine+mode
47824
+ channelStatus:
47825
+ enum:
47826
+ - Pending
47827
+ - Initializing
47828
+ - Running
47829
+ - Finished
47830
+ - Failed
47831
+ - Pausing
47832
+ - Paused
47833
+ - Deleting
47834
+ type: string
47835
+ dataReplicationEndpointType:
47836
+ enum:
47837
+ - custom
47838
+ - kubeblocks
47839
+ type: string
47840
+ authType:
47841
+ enum:
47842
+ - basic
47843
+ type: string
47844
+ basicAuthModel:
46712
47845
  type: object
46713
- description: The SLA (Service Level Agreement) for a cluster.
46714
47846
  properties:
46715
- items:
46716
- type: object
46717
- $ref: '#/components/schemas/SLAList'
46718
- total:
46719
- type: integer
46720
- format: int64
46721
- description: The total number of cluster SLA records.
46722
- DailySLA:
47847
+ userName:
47848
+ type: string
47849
+ password:
47850
+ type: string
47851
+ description: if password is not provided when patch replication channel, it means not to modify the password
47852
+ nullable: true
47853
+ customEndpoint:
46723
47854
  type: object
46724
- description: The SLA (Service Level Agreement) for a cluster on a specific date.
46725
47855
  properties:
46726
- date:
47856
+ connectionString:
47857
+ description: display connection string information, including connection details such as url, database, etc
46727
47858
  type: string
46728
- description: The date for which the SLA is calculated, formatted as YYYY-MM-DD.
46729
- sla:
46730
- type: number
46731
- description: The SLA value for the cluster on the specified date. Null indicates that the cluster was not existing on that date.
46732
- x-omitempty: false
47859
+ connection:
47860
+ type: string
47861
+ authType:
47862
+ $ref: '#/components/schemas/authType'
47863
+ basicAuth:
47864
+ $ref: '#/components/schemas/basicAuthModel'
46733
47865
  nullable: true
46734
- DailySLAList:
46735
- type: array
46736
- description: A list of daily SLA records.
46737
- items:
46738
- $ref: '#/components/schemas/DailySLA'
46739
- SLASettings:
47866
+ kubeblocksEndpoint:
46740
47867
  type: object
46741
47868
  properties:
47869
+ environmentID:
47870
+ type: string
46742
47871
  environmentName:
46743
47872
  type: string
46744
- description: The name of the environment.
46745
- probeInterval:
47873
+ clusterID:
46746
47874
  type: string
46747
- format: duration
46748
- probeTimeout:
47875
+ clusterName:
46749
47876
  type: string
46750
- format: duration
46751
- enableProbeRetry:
46752
- type: boolean
46753
- x-omitempty: false
46754
- probeRetryCount:
46755
- type: integer
46756
- x-omitempty: false
46757
- probeRetryInterval:
47877
+ displayName:
46758
47878
  type: string
46759
- format: duration
46760
- probeEngines:
47879
+ nullable: true
47880
+ dataChannelListEndpoint:
47881
+ type: object
47882
+ properties:
47883
+ engineName:
47884
+ type: string
47885
+ endpointType:
47886
+ $ref: '#/components/schemas/dataReplicationEndpointType'
47887
+ custom:
47888
+ $ref: '#/components/schemas/customEndpoint'
47889
+ nullable: true
47890
+ kubeblocks:
47891
+ $ref: '#/components/schemas/kubeblocksEndpoint'
47892
+ nullable: true
47893
+ extraCfgs:
47894
+ type: object
47895
+ additionalProperties:
47896
+ type: string
47897
+ nullable: true
47898
+ dataChannelItem:
47899
+ type: object
47900
+ properties:
47901
+ channelID:
47902
+ type: string
47903
+ channelName:
47904
+ type: string
47905
+ orgName:
47906
+ type: string
47907
+ channelStatus:
47908
+ $ref: '#/components/schemas/channelStatus'
47909
+ environmentID:
47910
+ type: string
47911
+ environmentName:
47912
+ type: string
47913
+ project:
47914
+ type: string
47915
+ kubernetesName:
47916
+ type: string
47917
+ standardDefinition:
47918
+ type: string
47919
+ source:
47920
+ $ref: '#/components/schemas/dataChannelListEndpoint'
47921
+ target:
47922
+ $ref: '#/components/schemas/dataChannelListEndpoint'
47923
+ replicationObjects:
47924
+ $ref: '#/components/schemas/dataChannelObject'
47925
+ modules:
46761
47926
  type: array
46762
47927
  items:
46763
47928
  type: string
46764
- probePoolSize:
46765
- type: integer
46766
- x-omitempty: false
46767
- collectorBatchSize:
46768
- type: integer
46769
- collectorMaxWaitTime:
47929
+ events:
47930
+ type: array
47931
+ items:
47932
+ $ref: '#/components/schemas/eventObject'
47933
+ createdAt:
46770
47934
  type: string
46771
- format: duration
46772
- slaThreshold:
46773
- type: number
46774
- description: The SLA threshold value for the cluster.
46775
- affectedClusterItem:
46776
- description: a cluster which is affected by the vulnerability
46777
- properties:
46778
- id:
46779
- description: the ID of the cluster
47935
+ format: date-time
47936
+ FinishedAt:
46780
47937
  type: string
46781
- name:
46782
- description: the name of the cluster
47938
+ format: date-time
47939
+ nullable: true
47940
+ dataChannelList:
47941
+ type: array
47942
+ items:
47943
+ $ref: '#/components/schemas/dataChannelItem'
47944
+ dataChannelModuleProgress:
47945
+ type: object
47946
+ properties:
47947
+ moduleName:
46783
47948
  type: string
46784
- displayName:
46785
- description: the display name of the cluster
47949
+ kubernetesName:
46786
47950
  type: string
46787
- clusterType:
46788
- description: the type of the cluster
47951
+ nullable: true
47952
+ progress:
47953
+ type: number
47954
+ format: double
47955
+ nullable: true
47956
+ status:
46789
47957
  type: string
46790
- engine:
46791
- description: the engine of the cluster
47958
+ message:
46792
47959
  type: string
46793
- orgName:
46794
- description: the name of the organization
47960
+ nullable: true
47961
+ dataChannelProgress:
47962
+ type: object
47963
+ properties:
47964
+ progress:
47965
+ type: number
47966
+ format: double
47967
+ nullable: true
47968
+ moduleProgress:
47969
+ type: array
47970
+ items:
47971
+ $ref: '#/components/schemas/dataChannelModuleProgress'
47972
+ dataChannelDetail:
47973
+ type: object
47974
+ properties:
47975
+ channel:
47976
+ $ref: '#/components/schemas/dataChannelItem'
47977
+ progress:
47978
+ $ref: '#/components/schemas/dataChannelProgress'
47979
+ customEndpointCreate:
47980
+ type: object
47981
+ properties:
47982
+ connection:
46795
47983
  type: string
46796
- refItem:
46797
- description: a reference of the vulnerability
47984
+ authType:
47985
+ $ref: '#/components/schemas/authType'
47986
+ basicAuth:
47987
+ $ref: '#/components/schemas/basicAuthModel'
47988
+ nullable: true
47989
+ dataChannelEndpointCreate:
47990
+ type: object
46798
47991
  properties:
46799
- rType:
46800
- description: the type of the reference
47992
+ engineName:
46801
47993
  type: string
46802
- url:
46803
- description: the URL of the reference
47994
+ definitionName:
46804
47995
  type: string
46805
- required:
46806
- - rType
46807
- - url
46808
- vulnListItem:
46809
- description: a vulnerability which affected the cluster
47996
+ endpointType:
47997
+ $ref: '#/components/schemas/dataReplicationEndpointType'
47998
+ custom:
47999
+ $ref: '#/components/schemas/customEndpointCreate'
48000
+ nullable: true
48001
+ kubeblocks:
48002
+ $ref: '#/components/schemas/kubeblocksEndpoint'
48003
+ nullable: true
48004
+ extraCfgs:
48005
+ type: object
48006
+ additionalProperties:
48007
+ type: string
48008
+ nullable: true
48009
+ dataChannelParameterKeyValue:
48010
+ type: object
46810
48011
  properties:
46811
- cveId:
46812
- description: the CVE ID of the vulnerability
48012
+ key:
46813
48013
  type: string
46814
- engineName:
46815
- description: the engine name of the vulnerability
48014
+ value:
46816
48015
  type: string
46817
- productName:
46818
- description: the product name of the vulnerability
48016
+ required:
48017
+ - key
48018
+ - value
48019
+ dataReplicationCreate:
48020
+ type: object
48021
+ properties:
48022
+ channelName:
46819
48023
  type: string
46820
- versions:
46821
- description: the versions of the product which are affected by the vulnerability
46822
- type: array
46823
- items:
46824
- type: string
46825
- fixedVersions:
46826
- description: the fixed versions of the product which fixed the vulnerability
48024
+ modules:
46827
48025
  type: array
46828
48026
  items:
46829
48027
  type: string
46830
- affectedClusters:
46831
- description: the clusters which are affected by the vulnerability
48028
+ environmentID:
48029
+ type: string
48030
+ project:
48031
+ type: string
48032
+ default: kubeblocks-cloud-ns
48033
+ standardDefinition:
48034
+ type: string
48035
+ source:
48036
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48037
+ target:
48038
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48039
+ replicationObjects:
48040
+ $ref: '#/components/schemas/dataChannelObject'
48041
+ events:
46832
48042
  type: array
46833
48043
  items:
46834
- $ref: '#/components/schemas/affectedClusterItem'
46835
- detail:
46836
- description: the detail of the vulnerability
46837
- type: string
46838
- severity:
46839
- description: the severity of the vulnerability
48044
+ $ref: '#/components/schemas/eventObject'
48045
+ parameters:
48046
+ type: object
48047
+ additionalProperties:
48048
+ type: array
48049
+ items:
48050
+ $ref: '#/components/schemas/dataChannelParameterKeyValue'
48051
+ nullable: true
48052
+ dataReplicationUpdate:
48053
+ type: object
48054
+ properties:
48055
+ clusterUpdates:
48056
+ $ref: '#/components/schemas/dataReplicationCreate'
48057
+ isRestart:
48058
+ type: boolean
48059
+ nullable: true
48060
+ dataChannelResponse:
48061
+ type: object
48062
+ properties:
48063
+ channelID:
46840
48064
  type: string
46841
- cvssVector:
46842
- description: the CVSS vector and score of the vulnerability
48065
+ channelName:
46843
48066
  type: string
46844
- publishedAt:
46845
- description: the published time of the vulnerability
48067
+ createdAt:
46846
48068
  type: string
46847
48069
  format: date-time
46848
- modifiedAt:
46849
- description: the modified time of the vulnerability
48070
+ updatedAt:
46850
48071
  type: string
46851
48072
  format: date-time
46852
- refs:
46853
- description: the references of the vulnerability
46854
- type: array
46855
- items:
46856
- $ref: '#/components/schemas/refItem'
46857
- required:
46858
- - cveId
46859
- - engineName
46860
- - productName
46861
- - versions
46862
- - severity
46863
- - publishedAt
46864
- - modifiedAt
46865
- vulnList:
46866
- description: a list of vulnerabilities
46867
- properties:
46868
- items:
46869
- description: a list of vulnerabilities
46870
- items:
46871
- $ref: '#/components/schemas/vulnListItem'
46872
- type: array
46873
- pageResult:
46874
- $ref: '#/components/schemas/pageResult'
46875
- required:
46876
- - items
46877
- type: object
46878
- vulnUploadFormData:
46879
- description: the data of the upload task
48073
+ nullable: true
48074
+ dataCheckType:
48075
+ type: string
48076
+ description: Type of check to run. A standalone check runs exactly one type.
48077
+ enum:
48078
+ - struct
48079
+ - snapshot
48080
+ dataCheckStatus:
48081
+ type: string
48082
+ enum:
48083
+ - Running
48084
+ - Finished
48085
+ - Failed
48086
+ dataCheckListSummary:
46880
48087
  type: object
46881
- required:
46882
- - file
46883
48088
  properties:
46884
- file:
46885
- type: string
46886
- format: binary
46887
- description: the data file, zip or other format
46888
- markVulnsAsIgnored:
46889
- description: the data of the mark request
48089
+ is_consistent:
48090
+ type: boolean
48091
+ nullable: true
48092
+ miss_count:
48093
+ type: integer
48094
+ format: int64
48095
+ diff_count:
48096
+ type: integer
48097
+ format: int64
48098
+ skip_count:
48099
+ type: integer
48100
+ format: int64
48101
+ sql_count:
48102
+ type: integer
48103
+ format: int64
48104
+ dataCheckListItem:
46890
48105
  type: object
46891
- required:
46892
- - cveId
46893
- - engineName
46894
- - productName
46895
48106
  properties:
46896
- cveId:
48107
+ checkID:
46897
48108
  type: string
46898
- description: the CVE ID of the vulnerability
46899
- engineName:
48109
+ checkName:
46900
48110
  type: string
46901
- description: the engine name of the vulnerability
46902
- productName:
48111
+ orgName:
46903
48112
  type: string
46904
- description: the product name of the vulnerability
46905
- vulnItem:
46906
- description: a vulnerability which affected the cluster
46907
- properties:
46908
- cveId:
46909
- description: the CVE ID of the vulnerability
48113
+ checkType:
48114
+ $ref: '#/components/schemas/dataCheckType'
48115
+ checkStatus:
48116
+ $ref: '#/components/schemas/dataCheckStatus'
48117
+ checkSummary:
48118
+ $ref: '#/components/schemas/dataCheckListSummary'
48119
+ nullable: true
48120
+ environmentID:
46910
48121
  type: string
46911
- detail:
46912
- description: the detail of the vulnerability
48122
+ environmentName:
46913
48123
  type: string
46914
- severity:
46915
- description: the severity of the vulnerability
48124
+ project:
46916
48125
  type: string
46917
- cvssVector:
46918
- description: the CVSS vector and score of the vulnerability
48126
+ source:
48127
+ $ref: '#/components/schemas/dataChannelListEndpoint'
48128
+ target:
48129
+ $ref: '#/components/schemas/dataChannelListEndpoint'
48130
+ replicationObjects:
48131
+ $ref: '#/components/schemas/dataChannelObject'
48132
+ errorMessage:
46919
48133
  type: string
46920
- publishedAt:
46921
- description: the published time of the vulnerability
48134
+ nullable: true
48135
+ createdAt:
46922
48136
  type: string
46923
48137
  format: date-time
46924
- modifiedAt:
46925
- description: the modified time of the vulnerability
48138
+ updatedAt:
46926
48139
  type: string
46927
48140
  format: date-time
46928
- refs:
46929
- description: the references of the vulnerability
46930
- type: array
46931
- items:
46932
- $ref: '#/components/schemas/refItem'
46933
- required:
46934
- - cveId
46935
- - severity
46936
- - publishedAt
46937
- - modifiedAt
46938
- clusterVulns:
46939
- description: a list of vulnerabilities which affected the cluster
48141
+ finishedAt:
48142
+ type: string
48143
+ format: date-time
48144
+ nullable: true
48145
+ dataCheckList:
48146
+ type: array
48147
+ items:
48148
+ $ref: '#/components/schemas/dataCheckListItem'
48149
+ dataCheckTableSummary:
46940
48150
  type: object
46941
- required:
46942
- - items
46943
48151
  properties:
46944
- items:
48152
+ schema:
48153
+ type: string
48154
+ tb:
48155
+ type: string
48156
+ target_schema:
48157
+ type: string
48158
+ target_tb:
48159
+ type: string
48160
+ checked_count:
48161
+ type: integer
48162
+ format: int64
48163
+ miss_count:
48164
+ type: integer
48165
+ format: int64
48166
+ diff_count:
48167
+ type: integer
48168
+ format: int64
48169
+ skip_count:
48170
+ type: integer
48171
+ format: int64
48172
+ dataCheckSummary:
48173
+ type: object
48174
+ properties:
48175
+ is_consistent:
48176
+ type: boolean
48177
+ nullable: true
48178
+ miss_count:
48179
+ type: integer
48180
+ format: int64
48181
+ diff_count:
48182
+ type: integer
48183
+ format: int64
48184
+ skip_count:
48185
+ type: integer
48186
+ format: int64
48187
+ sql_count:
48188
+ type: integer
48189
+ format: int64
48190
+ tables:
46945
48191
  type: array
46946
48192
  items:
46947
- $ref: '#/components/schemas/vulnItem'
46948
- engineSchedulingPolicy:
48193
+ $ref: '#/components/schemas/dataCheckTableSummary'
48194
+ dataCheckItem:
46949
48195
  type: object
46950
- description: Engine-level default scheduling policy for a specific engine and engine mode.
46951
48196
  properties:
46952
- id:
48197
+ orgName:
46953
48198
  type: string
46954
- description: Id of engine scheduling policy.
46955
- schedulingPolicyType:
46956
- description: Scheduling policy type applied by default to matching clusters unless overridden by a environment-level or cluster-level setting.
46957
- $ref: '#/components/schemas/schedulingPolicyType'
46958
- engine:
48199
+ checkID:
46959
48200
  type: string
46960
- description: Database engine that this policy applies to. Used together with `engineMode`.
46961
- engineMode:
48201
+ checkName:
46962
48202
  type: string
46963
- description: Engine mode that this policy applies to, such as `standalone` or `replication`.
46964
- description:
48203
+ checkType:
48204
+ $ref: '#/components/schemas/dataCheckType'
48205
+ checkStatus:
48206
+ $ref: '#/components/schemas/dataCheckStatus'
48207
+ checkSummary:
48208
+ $ref: '#/components/schemas/dataCheckSummary'
48209
+ nullable: true
48210
+ environmentID:
46965
48211
  type: string
46966
- description: Human-readable description of the engine scheduling policy.
46967
- required:
46968
- - engine
46969
- - engineMode
46970
- - schedulingPolicyType
46971
- target_role:
48212
+ environmentName:
48213
+ type: string
48214
+ project:
48215
+ type: string
48216
+ source:
48217
+ $ref: '#/components/schemas/dataChannelListEndpoint'
48218
+ target:
48219
+ $ref: '#/components/schemas/dataChannelListEndpoint'
48220
+ replicationObjects:
48221
+ $ref: '#/components/schemas/dataChannelObject'
48222
+ errorMessage:
48223
+ type: string
48224
+ nullable: true
48225
+ createdAt:
48226
+ type: string
48227
+ format: date-time
48228
+ updatedAt:
48229
+ type: string
48230
+ format: date-time
48231
+ finishedAt:
48232
+ type: string
48233
+ format: date-time
48234
+ nullable: true
48235
+ dataCheckDetailType:
46972
48236
  type: string
46973
48237
  enum:
46974
- - Primary
46975
- - '*'
46976
- description: |
46977
- Role name to match. Use `*` to match all roles, including components without an explicit role.
46978
- default: '*'
46979
- target:
48238
+ - miss
48239
+ - diff
48240
+ dataCheckDiffValue:
46980
48241
  type: object
46981
- description: Identifies one side of a scheduling rule match, including component and role.
46982
48242
  properties:
46983
- component:
48243
+ src:
46984
48244
  type: string
46985
- description: |
46986
- Component name to match. Use `*` to match all components for the selected engine mode.
46987
- default: '*'
46988
- role:
46989
- $ref: '#/components/schemas/target_role'
46990
- engineSchedulingRule:
48245
+ nullable: true
48246
+ dst:
48247
+ type: string
48248
+ nullable: true
48249
+ src_type:
48250
+ type: string
48251
+ nullable: true
48252
+ dst_type:
48253
+ type: string
48254
+ nullable: true
48255
+ dataCheckDetailItem:
46991
48256
  type: object
46992
48257
  properties:
46993
- id:
48258
+ key:
46994
48259
  type: string
46995
- description: Id of engine scheduling rule.
46996
- name:
48260
+ description: Struct check object key. Present for struct details; omitted for snapshot row details.
48261
+ schema:
46997
48262
  type: string
46998
- description: Rule name, used to reference this rule when applying scheduling policies to a cluster.
46999
- engine:
48263
+ description: Source schema or database from the requested detail scope.
48264
+ tb:
47000
48265
  type: string
47001
- description: Database engine type this rule applies to. Used to match rules to clusters by engine.
47002
- engineMode:
48266
+ description: Source table from the requested detail scope.
48267
+ target_schema:
47003
48268
  type: string
47004
- description: Cluster mode this rule applies to. Used to match rules to clusters by mode.
47005
- targetSelector:
47006
- type: array
47007
- description: Selects the two mutually exclusive targets that this rule applies to. The array length must be exactly 2.
47008
- items:
47009
- $ref: '#/components/schemas/target'
47010
- schedulingPolicyType:
47011
- description: Scheduling policy type to apply when this rule matches.
47012
- $ref: '#/components/schemas/schedulingPolicyType'
47013
- description:
48269
+ nullable: true
48270
+ description: Target schema or database for snapshot details when routing changes the target object.
48271
+ target_tb:
47014
48272
  type: string
47015
- description: Optional description of the scheduling rule.
47016
- default:
47017
- description: Indicates whether this rule is used as the fallback when no other rule matches.
47018
- type: boolean
47019
48273
  nullable: true
47020
- required:
47021
- - name
47022
- - engine
47023
- - engineMode
47024
- - targetSelector
47025
- - schedulingPolicyType
47026
- environmentEngineOption:
48274
+ description: Target table for snapshot details when routing changes the target object.
48275
+ id_col_values:
48276
+ type: object
48277
+ additionalProperties: {}
48278
+ src_sql:
48279
+ type: string
48280
+ nullable: true
48281
+ diff_col_values:
48282
+ type: object
48283
+ additionalProperties:
48284
+ $ref: '#/components/schemas/dataCheckDiffValue'
48285
+ nullable: true
48286
+ src_row:
48287
+ type: object
48288
+ additionalProperties: true
48289
+ nullable: true
48290
+ dst_row:
48291
+ type: object
48292
+ additionalProperties: true
48293
+ nullable: true
48294
+ dst_sql:
48295
+ type: string
48296
+ nullable: true
48297
+ dataCheckDetails:
47027
48298
  type: object
47028
48299
  required:
47029
- - id
47030
- - engineName
47031
- - mode
47032
- - networkModes
47033
- - envId
47034
- - envName
48300
+ - items
47035
48301
  properties:
47036
- id:
47037
- type: string
47038
- description: record id
47039
- engineName:
47040
- type: string
47041
- description: engine name
47042
- mode:
47043
- type: string
47044
- description: engine mode
47045
- networkModes:
48302
+ items:
47046
48303
  type: array
47047
48304
  items:
47048
- type: string
47049
- description: network modes configured for this engine+mode+env combination
47050
- envId:
48305
+ $ref: '#/components/schemas/dataCheckDetailItem'
48306
+ pagination:
48307
+ $ref: '#/components/schemas/paginationResult'
48308
+ dataReplicationOpsType:
48309
+ description: data replication ops type
48310
+ enum:
48311
+ - pause
48312
+ - resume
48313
+ - restart
48314
+ type: string
48315
+ eventItem:
48316
+ type: object
48317
+ properties:
48318
+ eventID:
47051
48319
  type: string
47052
- format: uuid
47053
- description: environment id
47054
- envName:
48320
+ eventName:
47055
48321
  type: string
47056
- description: environment name
47057
- createTime:
48322
+ eventTime:
47058
48323
  type: string
47059
48324
  format: date-time
47060
- description: create time
47061
- updateTime:
48325
+ eventMessage:
47062
48326
  type: string
47063
- format: date-time
47064
- description: update time
47065
- environmentEngineOptionList:
48327
+ operator:
48328
+ type: string
48329
+ operatorID:
48330
+ type: string
48331
+ nullable: true
48332
+ dataReplicationEventList:
47066
48333
  type: array
47067
48334
  items:
47068
- $ref: '#/components/schemas/environmentEngineOption'
47069
- environmentEngineOptionCreate:
48335
+ $ref: '#/components/schemas/eventItem'
48336
+ replicationObjectQuery:
47070
48337
  type: object
47071
- required:
47072
- - engineName
47073
- - mode
47074
- - networkModes
47075
48338
  properties:
47076
- engineName:
48339
+ sourceEngineDefinition:
47077
48340
  type: string
47078
- description: engine name
47079
- mode:
48341
+ targetEngineDefinition:
47080
48342
  type: string
47081
- description: engine mode
47082
- networkModes:
47083
- type: array
47084
- items:
47085
- type: string
47086
- description: network modes
47087
- environmentEngineOptionUpdate:
48343
+ endpoint:
48344
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48345
+ nodeType:
48346
+ type: string
48347
+ nullable: true
48348
+ nodeValue:
48349
+ type: string
48350
+ nullable: true
48351
+ queryNodeType:
48352
+ type: string
48353
+ nullable: true
48354
+ preCheckCreate:
47088
48355
  type: object
47089
- required:
47090
- - networkModes
47091
48356
  properties:
47092
- networkModes:
48357
+ modules:
47093
48358
  type: array
47094
48359
  items:
47095
48360
  type: string
47096
- description: environment engine option to update
47097
- engineNetworkModeSupported:
48361
+ environmentID:
48362
+ type: string
48363
+ source:
48364
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48365
+ target:
48366
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48367
+ replicationObjects:
48368
+ $ref: '#/components/schemas/dataChannelObject'
48369
+ dataReplicationChannelContainer:
47098
48370
  type: object
47099
48371
  properties:
47100
- supported:
47101
- type: array
47102
- items:
47103
- $ref: '#/components/schemas/networkMode'
47104
- description: supported network modes
47105
- notSupportedVersions:
47106
- type: object
47107
- additionalProperties:
47108
- type: array
47109
- items:
47110
- type: string
47111
- description: not supported versions, key is networkMode, value is array of versions
47112
- engineNetworkModeOptions:
47113
- type: array
47114
- items:
47115
- type: object
47116
- required:
47117
- - engineName
47118
- - mode
47119
- - networkModes
47120
- properties:
47121
- engineName:
47122
- type: string
47123
- description: engine name
47124
- mode:
47125
- type: string
47126
- description: engine mode
47127
- networkModes:
47128
- type: array
47129
- items:
47130
- $ref: '#/components/schemas/networkMode'
47131
- description: available network modes for this engine+mode
48372
+ name:
48373
+ type: string
48374
+ isMainContainer:
48375
+ type: boolean
48376
+ default: false
48377
+ isInitContainer:
48378
+ type: boolean
48379
+ default: false
48380
+ dataReplicationParametersResponseDetail:
48381
+ type: object
48382
+ properties:
48383
+ displayName:
48384
+ type: string
48385
+ desc:
48386
+ $ref: '#/components/schemas/internationalDesc'
48387
+ key:
48388
+ type: string
48389
+ defaultValue:
48390
+ type: string
48391
+ value:
48392
+ type: string
48393
+ valueType:
48394
+ $ref: '#/components/schemas/parameterValueType'
48395
+ required:
48396
+ - key
48397
+ dataReplicationParametersResponse:
48398
+ type: object
48399
+ description: the parameters of the data channel, the key is the module name, the value is the parameter template
48400
+ additionalProperties:
48401
+ type: array
48402
+ items:
48403
+ $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
47132
48404
  responses:
47133
48405
  '204':
47134
48406
  description: No Content