kb-cloud-client-typescript 2.4.0-alpha.114 → 2.4.0-alpha.116

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 (93) hide show
  1. package/dist/adminapi/apis/data-replication-api.d.ts +326 -0
  2. package/dist/adminapi/apis/data-replication-api.d.ts.map +1 -1
  3. package/dist/adminapi/apis/data-replication-api.js +377 -0
  4. package/dist/adminapi/apis/data-replication-api.js.map +1 -1
  5. package/dist/adminapi/models/data-channel-endpoint-create.d.ts +20 -1
  6. package/dist/adminapi/models/data-channel-endpoint-create.d.ts.map +1 -1
  7. package/dist/adminapi/models/data-channel-list-endpoint.d.ts +25 -0
  8. package/dist/adminapi/models/data-channel-list-endpoint.d.ts.map +1 -1
  9. package/dist/adminapi/models/data-endpoint-create.d.ts +72 -0
  10. package/dist/adminapi/models/data-endpoint-create.d.ts.map +1 -0
  11. package/dist/adminapi/models/data-endpoint-create.js +16 -0
  12. package/dist/adminapi/models/data-endpoint-create.js.map +1 -0
  13. package/dist/adminapi/models/data-endpoint-response.d.ts +43 -0
  14. package/dist/adminapi/models/data-endpoint-response.d.ts.map +1 -0
  15. package/dist/adminapi/models/data-endpoint-response.js +16 -0
  16. package/dist/adminapi/models/data-endpoint-response.js.map +1 -0
  17. package/dist/adminapi/models/data-endpoint-type-creation.d.ts +22 -0
  18. package/dist/adminapi/models/data-endpoint-type-creation.d.ts.map +1 -0
  19. package/dist/adminapi/models/data-endpoint-type-creation.js +26 -0
  20. package/dist/adminapi/models/data-endpoint-type-creation.js.map +1 -0
  21. package/dist/adminapi/models/data-replication-endpoint-type.d.ts +1 -0
  22. package/dist/adminapi/models/data-replication-endpoint-type.d.ts.map +1 -1
  23. package/dist/adminapi/models/data-replication-endpoint-type.js +2 -1
  24. package/dist/adminapi/models/data-replication-endpoint-type.js.map +1 -1
  25. package/dist/adminapi/models/definition-endpoint.d.ts +25 -0
  26. package/dist/adminapi/models/definition-endpoint.d.ts.map +1 -0
  27. package/dist/adminapi/models/definition-endpoint.js +16 -0
  28. package/dist/adminapi/models/definition-endpoint.js.map +1 -0
  29. package/dist/adminapi/models/index.d.ts +4 -0
  30. package/dist/adminapi/models/index.d.ts.map +1 -1
  31. package/dist/adminapi/models/index.js +4 -0
  32. package/dist/adminapi/models/index.js.map +1 -1
  33. package/dist/adminapi/models/redis-key-analysis-report.d.ts +2 -2
  34. package/dist/adminapi/models/redis-key-analysis-report.d.ts.map +1 -1
  35. package/dist/openapi/apis/data-replication-api.d.ts +326 -0
  36. package/dist/openapi/apis/data-replication-api.d.ts.map +1 -1
  37. package/dist/openapi/apis/data-replication-api.js +377 -0
  38. package/dist/openapi/apis/data-replication-api.js.map +1 -1
  39. package/dist/openapi/models/data-channel-endpoint-create.d.ts +20 -1
  40. package/dist/openapi/models/data-channel-endpoint-create.d.ts.map +1 -1
  41. package/dist/openapi/models/data-channel-list-endpoint.d.ts +25 -0
  42. package/dist/openapi/models/data-channel-list-endpoint.d.ts.map +1 -1
  43. package/dist/openapi/models/data-endpoint-create.d.ts +72 -0
  44. package/dist/openapi/models/data-endpoint-create.d.ts.map +1 -0
  45. package/dist/openapi/models/data-endpoint-create.js +16 -0
  46. package/dist/openapi/models/data-endpoint-create.js.map +1 -0
  47. package/dist/openapi/models/data-endpoint-response.d.ts +43 -0
  48. package/dist/openapi/models/data-endpoint-response.d.ts.map +1 -0
  49. package/dist/openapi/models/data-endpoint-response.js +16 -0
  50. package/dist/openapi/models/data-endpoint-response.js.map +1 -0
  51. package/dist/openapi/models/data-endpoint-type-creation.d.ts +22 -0
  52. package/dist/openapi/models/data-endpoint-type-creation.d.ts.map +1 -0
  53. package/dist/openapi/models/data-endpoint-type-creation.js +26 -0
  54. package/dist/openapi/models/data-endpoint-type-creation.js.map +1 -0
  55. package/dist/openapi/models/data-replication-endpoint-type.d.ts +1 -0
  56. package/dist/openapi/models/data-replication-endpoint-type.d.ts.map +1 -1
  57. package/dist/openapi/models/data-replication-endpoint-type.js +2 -1
  58. package/dist/openapi/models/data-replication-endpoint-type.js.map +1 -1
  59. package/dist/openapi/models/definition-endpoint.d.ts +25 -0
  60. package/dist/openapi/models/definition-endpoint.d.ts.map +1 -0
  61. package/dist/openapi/models/definition-endpoint.js +16 -0
  62. package/dist/openapi/models/definition-endpoint.js.map +1 -0
  63. package/dist/openapi/models/index.d.ts +4 -0
  64. package/dist/openapi/models/index.d.ts.map +1 -1
  65. package/dist/openapi/models/index.js +4 -0
  66. package/dist/openapi/models/index.js.map +1 -1
  67. package/dist/openapi/models/redis-key-analysis-report.d.ts +2 -2
  68. package/dist/openapi/models/redis-key-analysis-report.d.ts.map +1 -1
  69. package/package.json +1 -1
  70. package/src/adminapi/.openapi-generator/FILES +4 -0
  71. package/src/adminapi/apis/data-replication-api.ts +584 -0
  72. package/src/adminapi/models/data-channel-endpoint-create.ts +22 -1
  73. package/src/adminapi/models/data-channel-list-endpoint.ts +27 -0
  74. package/src/adminapi/models/data-endpoint-create.ts +83 -0
  75. package/src/adminapi/models/data-endpoint-response.ts +48 -0
  76. package/src/adminapi/models/data-endpoint-type-creation.ts +31 -0
  77. package/src/adminapi/models/data-replication-endpoint-type.ts +2 -1
  78. package/src/adminapi/models/definition-endpoint.ts +30 -0
  79. package/src/adminapi/models/index.ts +4 -0
  80. package/src/adminapi/models/redis-key-analysis-report.ts +2 -2
  81. package/src/adminapi.yaml +255 -2
  82. package/src/openapi/.openapi-generator/FILES +4 -0
  83. package/src/openapi/apis/data-replication-api.ts +583 -0
  84. package/src/openapi/models/data-channel-endpoint-create.ts +22 -1
  85. package/src/openapi/models/data-channel-list-endpoint.ts +27 -0
  86. package/src/openapi/models/data-endpoint-create.ts +83 -0
  87. package/src/openapi/models/data-endpoint-response.ts +48 -0
  88. package/src/openapi/models/data-endpoint-type-creation.ts +31 -0
  89. package/src/openapi/models/data-replication-endpoint-type.ts +2 -1
  90. package/src/openapi/models/definition-endpoint.ts +30 -0
  91. package/src/openapi/models/index.ts +4 -0
  92. package/src/openapi/models/redis-key-analysis-report.ts +2 -2
  93. package/src/openapi.yaml +1496 -1244
package/src/openapi.yaml CHANGED
@@ -23660,249 +23660,6 @@ paths:
23660
23660
  tags:
23661
23661
  - dataReplication
23662
23662
  x-codegen-request-body-name: body
23663
- /api/v1/organizations/{orgName}/checks:
23664
- get:
23665
- operationId: listDataChecks
23666
- summary: List Data Checks
23667
- description: Retrieve a list of standalone data checks.
23668
- parameters:
23669
- - description: The Name of the organization
23670
- in: path
23671
- name: orgName
23672
- required: true
23673
- schema:
23674
- type: string
23675
- - description: The name of the check
23676
- in: query
23677
- name: name
23678
- required: false
23679
- schema:
23680
- type: string
23681
- - description: The status of the check
23682
- in: query
23683
- name: status
23684
- required: false
23685
- schema:
23686
- type: array
23687
- items:
23688
- type: string
23689
- responses:
23690
- '200':
23691
- content:
23692
- application/json:
23693
- schema:
23694
- $ref: '#/components/schemas/dataCheckList'
23695
- description: A list of checks.
23696
- '401':
23697
- $ref: '#/components/responses/401'
23698
- '403':
23699
- $ref: '#/components/responses/403'
23700
- '404':
23701
- $ref: '#/components/responses/404'
23702
- tags:
23703
- - dataReplication
23704
- post:
23705
- operationId: createDataCheck
23706
- summary: Create a data check
23707
- description: 'Create an independent data check. The request must use exactly one entry point: provide channelID with checkType, or provide the full direct check configuration.'
23708
- parameters:
23709
- - description: The Name of the organization
23710
- in: path
23711
- name: orgName
23712
- required: true
23713
- schema:
23714
- type: string
23715
- requestBody:
23716
- content:
23717
- application/json:
23718
- schema:
23719
- $ref: '#/components/schemas/dataCheckCreate'
23720
- required: true
23721
- responses:
23722
- '200':
23723
- content:
23724
- application/json:
23725
- schema:
23726
- $ref: '#/components/schemas/dataCheckResponse'
23727
- description: A successful response.
23728
- '401':
23729
- $ref: '#/components/responses/401'
23730
- '403':
23731
- $ref: '#/components/responses/403'
23732
- '404':
23733
- $ref: '#/components/responses/404'
23734
- tags:
23735
- - dataReplication
23736
- x-codegen-request-body-name: body
23737
- /api/v1/organizations/{orgName}/checks/{checkID}:
23738
- get:
23739
- operationId: getDataCheck
23740
- summary: Get Data Check
23741
- description: Retrieve a standalone data check detail.
23742
- parameters:
23743
- - description: The Name of the organization
23744
- in: path
23745
- name: orgName
23746
- required: true
23747
- schema:
23748
- type: string
23749
- - description: The ID of the check
23750
- in: path
23751
- name: checkID
23752
- required: true
23753
- schema:
23754
- type: string
23755
- responses:
23756
- '200':
23757
- content:
23758
- application/json:
23759
- schema:
23760
- $ref: '#/components/schemas/dataCheckItem'
23761
- description: A check detail.
23762
- '401':
23763
- $ref: '#/components/responses/401'
23764
- '403':
23765
- $ref: '#/components/responses/403'
23766
- '404':
23767
- $ref: '#/components/responses/404'
23768
- tags:
23769
- - dataReplication
23770
- delete:
23771
- operationId: deleteDataCheck
23772
- summary: Delete a data check
23773
- description: Delete a standalone data check and its runtime resources.
23774
- parameters:
23775
- - description: The Name of the organization
23776
- in: path
23777
- name: orgName
23778
- required: true
23779
- schema:
23780
- type: string
23781
- - description: The ID of the check
23782
- in: path
23783
- name: checkID
23784
- required: true
23785
- schema:
23786
- type: string
23787
- responses:
23788
- '204':
23789
- content: {}
23790
- description: Returned when check is deleted successfully.
23791
- '401':
23792
- $ref: '#/components/responses/401'
23793
- '403':
23794
- $ref: '#/components/responses/403'
23795
- '404':
23796
- $ref: '#/components/responses/404'
23797
- tags:
23798
- - dataReplication
23799
- /api/v1/organizations/{orgName}/checks/{checkID}/details:
23800
- get:
23801
- operationId: getDataCheckDetails
23802
- summary: Get Data Check Difference Details
23803
- description: Read typed check miss or diff details from the latest parsed check result.
23804
- parameters:
23805
- - description: The Name of the organization
23806
- in: path
23807
- name: orgName
23808
- required: true
23809
- schema:
23810
- type: string
23811
- - description: The ID of the check
23812
- in: path
23813
- name: checkID
23814
- required: true
23815
- schema:
23816
- type: string
23817
- - description: The detail type
23818
- in: query
23819
- name: type
23820
- required: true
23821
- schema:
23822
- $ref: '#/components/schemas/dataCheckDetailType'
23823
- - description: Source schema or database. Required for snapshot checks.
23824
- in: query
23825
- name: schema
23826
- required: false
23827
- schema:
23828
- type: string
23829
- - description: Source table. Required for snapshot checks.
23830
- in: query
23831
- name: table
23832
- required: false
23833
- schema:
23834
- type: string
23835
- - description: Struct object key. Optional for struct checks; omitted to page all struct details.
23836
- in: query
23837
- name: key
23838
- required: false
23839
- schema:
23840
- type: string
23841
- - description: Page number for pagination.
23842
- in: query
23843
- name: page
23844
- required: false
23845
- schema:
23846
- type: integer
23847
- minimum: 1
23848
- default: 1
23849
- - description: Number of items per page.
23850
- in: query
23851
- name: pageSize
23852
- required: false
23853
- schema:
23854
- type: integer
23855
- minimum: 1
23856
- maximum: 1000
23857
- default: 100
23858
- responses:
23859
- '200':
23860
- content:
23861
- application/json:
23862
- schema:
23863
- $ref: '#/components/schemas/dataCheckDetails'
23864
- description: A successful response.
23865
- '401':
23866
- $ref: '#/components/responses/401'
23867
- '403':
23868
- $ref: '#/components/responses/403'
23869
- '404':
23870
- $ref: '#/components/responses/404'
23871
- tags:
23872
- - dataReplication
23873
- /api/v1/organizations/{orgName}/checks/{checkID}/sqlLogs:
23874
- get:
23875
- operationId: getDataCheckSQLLogs
23876
- summary: Get Data Check SQL Logs
23877
- description: Read raw SQL lines emitted by check sql_logger entries.
23878
- parameters:
23879
- - description: The Name of the organization
23880
- in: path
23881
- name: orgName
23882
- required: true
23883
- schema:
23884
- type: string
23885
- - description: The ID of the check
23886
- in: path
23887
- name: checkID
23888
- required: true
23889
- schema:
23890
- type: string
23891
- responses:
23892
- '200':
23893
- content:
23894
- text/plain:
23895
- schema:
23896
- type: string
23897
- description: Raw SQL lines.
23898
- '401':
23899
- $ref: '#/components/responses/401'
23900
- '403':
23901
- $ref: '#/components/responses/403'
23902
- '404':
23903
- $ref: '#/components/responses/404'
23904
- tags:
23905
- - dataReplication
23906
23663
  /api/v1/organizations/{orgName}/replication/channel/{channelID}/ops/{opsType}:
23907
23664
  post:
23908
23665
  operationId: createDataChannelOps
@@ -24240,365 +23997,408 @@ paths:
24240
23997
  $ref: '#/components/responses/404'
24241
23998
  tags:
24242
23999
  - dataReplication
24243
- /api/v1/organizations/{orgName}/clusters/{clusterName}/import/preflight:
24244
- post:
24245
- tags:
24246
- - import
24247
- - shared
24248
- summary: Data source preflight check
24249
- description: Initiates async validation with the selected source configuration
24250
- operationId: importPreflight
24000
+ /api/v1/organizations/{orgName}/replication/endpoints:
24001
+ get:
24002
+ operationId: listDataEndpoints
24003
+ summary: List Data Endpoints
24004
+ description: Retrieve a list of data endpoints.
24251
24005
  parameters:
24252
- - name: orgName
24006
+ - description: The Name of the organization
24253
24007
  in: path
24254
- description: Organization name
24008
+ name: orgName
24255
24009
  required: true
24256
24010
  schema:
24257
24011
  type: string
24258
- - name: clusterName
24012
+ - description: The name of the data endpoint
24013
+ in: query
24014
+ name: name
24015
+ required: false
24016
+ schema:
24017
+ type: string
24018
+ responses:
24019
+ '200':
24020
+ content:
24021
+ application/json:
24022
+ schema:
24023
+ $ref: '#/components/schemas/dataEndpointList'
24024
+ description: A list of data endpoints.
24025
+ '401':
24026
+ $ref: '#/components/responses/401'
24027
+ '403':
24028
+ $ref: '#/components/responses/403'
24029
+ '404':
24030
+ $ref: '#/components/responses/404'
24031
+ tags:
24032
+ - dataReplication
24033
+ post:
24034
+ operationId: createDataEndpoint
24035
+ summary: Create a new data endpoint
24036
+ description: Create a new data endpoint.
24037
+ parameters:
24038
+ - description: The Name of the organization
24259
24039
  in: path
24260
- description: Cluster name
24040
+ name: orgName
24261
24041
  required: true
24262
24042
  schema:
24263
24043
  type: string
24264
24044
  requestBody:
24265
- required: true
24266
- description: Data source connection configuration and selection rules
24267
24045
  content:
24268
24046
  application/json:
24269
24047
  schema:
24270
- $ref: '#/components/schemas/ImportPreflightRequest'
24048
+ $ref: '#/components/schemas/dataEndpointCreate'
24049
+ required: true
24271
24050
  responses:
24272
24051
  '200':
24273
- description: Preflight initiated successfully, returns task ID for querying results
24274
24052
  content:
24275
24053
  application/json:
24276
24054
  schema:
24277
- $ref: '#/components/schemas/preCheckTaskResponse'
24055
+ $ref: '#/components/schemas/dataEndpointResponse'
24056
+ description: A successful response.
24278
24057
  '401':
24279
24058
  $ref: '#/components/responses/401'
24280
24059
  '403':
24281
24060
  $ref: '#/components/responses/403'
24282
24061
  '404':
24283
24062
  $ref: '#/components/responses/404'
24284
- /api/v1/organizations/{orgName}/clusters/{clusterName}/import/preflight/{taskId}:
24285
- get:
24286
24063
  tags:
24287
- - import
24288
- - shared
24289
- summary: Get preflight task details
24290
- description: Retrieves detailed information about a specific data import preflight task by its ID
24291
- operationId: getImportPreflightTask
24064
+ - dataReplication
24065
+ x-codegen-request-body-name: body
24066
+ /api/v1/organizations/{orgName}/replication/endpoint/{endpointID}:
24067
+ get:
24068
+ operationId: getDataEndpoint
24069
+ summary: Get Data Endpoint Details
24070
+ description: Retrieve a data endpoint detail.
24292
24071
  parameters:
24293
- - name: orgName
24294
- in: path
24295
- description: Organization name
24296
- required: true
24297
- schema:
24298
- type: string
24299
- - name: clusterName
24072
+ - description: The Name of the organization
24300
24073
  in: path
24301
- description: Cluster name
24074
+ name: orgName
24302
24075
  required: true
24303
24076
  schema:
24304
24077
  type: string
24305
- - name: taskId
24078
+ - description: The ID of the data endpoint
24306
24079
  in: path
24307
- description: Preflight task ID
24080
+ name: endpointID
24308
24081
  required: true
24309
24082
  schema:
24310
24083
  type: string
24311
24084
  responses:
24312
24085
  '200':
24313
- description: Successfully returns preflight task details
24314
24086
  content:
24315
24087
  application/json:
24316
24088
  schema:
24317
- $ref: '#/components/schemas/preCheckTaskDetail'
24089
+ $ref: '#/components/schemas/dataChannelListEndpoint'
24090
+ description: A detail of data endpoint.
24318
24091
  '401':
24319
24092
  $ref: '#/components/responses/401'
24320
24093
  '403':
24321
24094
  $ref: '#/components/responses/403'
24322
24095
  '404':
24323
24096
  $ref: '#/components/responses/404'
24324
- /api/v1/organizations/{orgName}/clusters/{clusterName}/import/objects:
24325
- post:
24326
24097
  tags:
24327
- - import
24328
- - shared
24329
- summary: Query replication objects for import
24330
- description: |
24331
- Enumerates replication objects (databases, schemas, tables, etc.) for the requested node. The metadata levels depend on the source engine (for example MySQL uses `database -> table`, PostgreSQL uses `schema -> table`).
24332
- operationId: queryImportObjects
24098
+ - dataReplication
24099
+ delete:
24100
+ operationId: deleteDataEndpoint
24101
+ summary: Delete a data endpoint
24102
+ description: Delete a data endpoint.
24333
24103
  parameters:
24334
- - name: orgName
24104
+ - description: The Name of the organization
24335
24105
  in: path
24336
- description: Organization name
24106
+ name: orgName
24337
24107
  required: true
24338
24108
  schema:
24339
24109
  type: string
24340
- - name: clusterName
24110
+ - description: The ID of the data endpoint
24341
24111
  in: path
24342
- description: Cluster name
24112
+ name: endpointID
24113
+ required: true
24114
+ schema:
24115
+ type: string
24116
+ responses:
24117
+ '204':
24118
+ content: {}
24119
+ description: Returned when endpoint is deleted successfully.
24120
+ '401':
24121
+ $ref: '#/components/responses/401'
24122
+ '403':
24123
+ $ref: '#/components/responses/403'
24124
+ '404':
24125
+ $ref: '#/components/responses/404'
24126
+ tags:
24127
+ - dataReplication
24128
+ patch:
24129
+ operationId: updateDataEndpoint
24130
+ summary: Update a data endpoint
24131
+ description: Update an existing data endpoint.
24132
+ parameters:
24133
+ - description: The Name of the organization
24134
+ in: path
24135
+ name: orgName
24136
+ required: true
24137
+ schema:
24138
+ type: string
24139
+ - description: The ID of the data endpoint
24140
+ in: path
24141
+ name: endpointID
24343
24142
  required: true
24344
24143
  schema:
24345
24144
  type: string
24346
24145
  requestBody:
24347
- required: true
24348
- description: Connection configuration and current object tree position
24349
24146
  content:
24350
24147
  application/json:
24351
24148
  schema:
24352
- $ref: '#/components/schemas/ImportQueryObjectsRequest'
24149
+ $ref: '#/components/schemas/dataEndpointCreate'
24150
+ required: true
24353
24151
  responses:
24354
24152
  '200':
24355
- description: Object tree nodes retrieved successfully
24356
24153
  content:
24357
24154
  application/json:
24358
24155
  schema:
24359
- $ref: '#/components/schemas/replicationObjectTree'
24156
+ $ref: '#/components/schemas/dataEndpointResponse'
24157
+ description: A successful response.
24360
24158
  '401':
24361
24159
  $ref: '#/components/responses/401'
24362
24160
  '403':
24363
24161
  $ref: '#/components/responses/403'
24364
24162
  '404':
24365
24163
  $ref: '#/components/responses/404'
24366
- '501':
24367
- $ref: '#/components/responses/501'
24368
- /api/v1/organizations/{orgName}/clusters/{clusterName}/import:
24369
- get:
24370
24164
  tags:
24371
- - import
24372
- - shared
24373
- summary: Query import task list
24374
- description: Gets import task list for specified cluster, supports filtering by status and pagination
24375
- operationId: listImportTask
24165
+ - dataReplication
24166
+ x-codegen-request-body-name: body
24167
+ /api/v1/organizations/{orgName}/checks:
24168
+ get:
24169
+ operationId: listDataChecks
24170
+ summary: List Data Checks
24171
+ description: Retrieve a list of standalone data checks.
24376
24172
  parameters:
24377
- - name: orgName
24173
+ - description: The Name of the organization
24378
24174
  in: path
24379
- description: Organization name
24175
+ name: orgName
24380
24176
  required: true
24381
24177
  schema:
24382
24178
  type: string
24383
- - name: clusterName
24384
- in: path
24385
- description: Cluster name
24386
- required: true
24179
+ - description: The name of the check
24180
+ in: query
24181
+ name: name
24182
+ required: false
24387
24183
  schema:
24388
24184
  type: string
24185
+ - description: The status of the check
24186
+ in: query
24187
+ name: status
24188
+ required: false
24189
+ schema:
24190
+ type: array
24191
+ items:
24192
+ type: string
24389
24193
  responses:
24390
24194
  '200':
24391
- description: Successfully returns task list with pagination info
24392
24195
  content:
24393
24196
  application/json:
24394
24197
  schema:
24395
- $ref: '#/components/schemas/ImportTaskListResponse'
24198
+ $ref: '#/components/schemas/dataCheckList'
24199
+ description: A list of checks.
24396
24200
  '401':
24397
24201
  $ref: '#/components/responses/401'
24398
24202
  '403':
24399
24203
  $ref: '#/components/responses/403'
24400
24204
  '404':
24401
24205
  $ref: '#/components/responses/404'
24402
- post:
24403
24206
  tags:
24404
- - import
24405
- - shared
24406
- summary: Create import task
24407
- description: Creates new data import task based on data source configuration and import options
24408
- operationId: createImportTask
24207
+ - dataReplication
24208
+ post:
24209
+ operationId: createDataCheck
24210
+ summary: Create a data check
24211
+ description: 'Create an independent data check. The request must use exactly one entry point: provide channelID with checkType, or provide the full direct check configuration.'
24409
24212
  parameters:
24410
- - name: orgName
24411
- in: path
24412
- description: Organization name
24413
- required: true
24414
- schema:
24415
- type: string
24416
- - name: clusterName
24213
+ - description: The Name of the organization
24417
24214
  in: path
24418
- description: Cluster name
24215
+ name: orgName
24419
24216
  required: true
24420
24217
  schema:
24421
24218
  type: string
24422
24219
  requestBody:
24423
- required: true
24424
- description: Import task configuration including data source connection, object selection and import options
24425
24220
  content:
24426
24221
  application/json:
24427
24222
  schema:
24428
- $ref: '#/components/schemas/ImportTaskCreateRequest'
24223
+ $ref: '#/components/schemas/dataCheckCreate'
24224
+ required: true
24429
24225
  responses:
24430
- '201':
24431
- description: Task created successfully, returns basic task information
24226
+ '200':
24432
24227
  content:
24433
24228
  application/json:
24434
24229
  schema:
24435
- $ref: '#/components/schemas/ImportTaskResponse'
24230
+ $ref: '#/components/schemas/dataCheckResponse'
24231
+ description: A successful response.
24436
24232
  '401':
24437
24233
  $ref: '#/components/responses/401'
24438
24234
  '403':
24439
24235
  $ref: '#/components/responses/403'
24440
24236
  '404':
24441
24237
  $ref: '#/components/responses/404'
24442
- '409':
24443
- $ref: '#/components/responses/409'
24444
- /api/v1/organizations/{orgName}/clusters/{clusterName}/import/{id}:
24445
- get:
24446
24238
  tags:
24447
- - import
24448
- - shared
24449
- summary: Get import task details
24450
- description: Gets detailed information about a specific import task by its ID
24451
- operationId: getImportTask
24239
+ - dataReplication
24240
+ x-codegen-request-body-name: body
24241
+ /api/v1/organizations/{orgName}/checks/{checkID}:
24242
+ get:
24243
+ operationId: getDataCheck
24244
+ summary: Get Data Check
24245
+ description: Retrieve a standalone data check detail.
24452
24246
  parameters:
24453
- - name: orgName
24454
- in: path
24455
- description: Organization name
24456
- required: true
24457
- schema:
24458
- type: string
24459
- - name: clusterName
24247
+ - description: The Name of the organization
24460
24248
  in: path
24461
- description: Cluster name
24249
+ name: orgName
24462
24250
  required: true
24463
24251
  schema:
24464
24252
  type: string
24465
- - name: id
24253
+ - description: The ID of the check
24466
24254
  in: path
24467
- description: Import task ID
24255
+ name: checkID
24468
24256
  required: true
24469
24257
  schema:
24470
24258
  type: string
24471
24259
  responses:
24472
24260
  '200':
24473
- description: Successfully returns import task details
24474
24261
  content:
24475
24262
  application/json:
24476
24263
  schema:
24477
- $ref: '#/components/schemas/ImportTaskResponse'
24264
+ $ref: '#/components/schemas/dataCheckItem'
24265
+ description: A check detail.
24478
24266
  '401':
24479
24267
  $ref: '#/components/responses/401'
24480
24268
  '403':
24481
24269
  $ref: '#/components/responses/403'
24482
24270
  '404':
24483
24271
  $ref: '#/components/responses/404'
24484
- delete:
24485
24272
  tags:
24486
- - import
24487
- - shared
24488
- summary: Delete import task
24489
- description: Stops and deletes specified import task, will clean up related Kubernetes resources
24490
- operationId: deleteImportTask
24273
+ - dataReplication
24274
+ delete:
24275
+ operationId: deleteDataCheck
24276
+ summary: Delete a data check
24277
+ description: Delete a standalone data check and its runtime resources.
24491
24278
  parameters:
24492
- - name: orgName
24493
- in: path
24494
- description: Organization name
24495
- required: true
24496
- schema:
24497
- type: string
24498
- - name: clusterName
24279
+ - description: The Name of the organization
24499
24280
  in: path
24500
- description: Cluster name
24281
+ name: orgName
24501
24282
  required: true
24502
24283
  schema:
24503
24284
  type: string
24504
- - name: id
24285
+ - description: The ID of the check
24505
24286
  in: path
24506
- description: Import task ID
24287
+ name: checkID
24507
24288
  required: true
24508
24289
  schema:
24509
24290
  type: string
24510
24291
  responses:
24511
24292
  '204':
24512
- description: Task deleted successfully
24293
+ content: {}
24294
+ description: Returned when check is deleted successfully.
24513
24295
  '401':
24514
24296
  $ref: '#/components/responses/401'
24515
24297
  '403':
24516
24298
  $ref: '#/components/responses/403'
24517
24299
  '404':
24518
24300
  $ref: '#/components/responses/404'
24519
- /api/v1/organizations/{orgName}/clusters/{clusterName}/import/{id}/ops/{opsType}:
24520
- patch:
24521
24301
  tags:
24522
- - import
24523
- - shared
24524
- summary: Create a import task operation
24525
- description: Performs pause or resume operation on import task based on opsType parameter
24526
- operationId: updateImportTaskOps
24302
+ - dataReplication
24303
+ /api/v1/organizations/{orgName}/checks/{checkID}/details:
24304
+ get:
24305
+ operationId: getDataCheckDetails
24306
+ summary: Get Data Check Difference Details
24307
+ description: Read typed check miss or diff details from the latest parsed check result.
24527
24308
  parameters:
24528
- - name: orgName
24309
+ - description: The Name of the organization
24529
24310
  in: path
24530
- description: Organization name
24311
+ name: orgName
24531
24312
  required: true
24532
24313
  schema:
24533
24314
  type: string
24534
- - name: clusterName
24315
+ - description: The ID of the check
24535
24316
  in: path
24536
- description: Cluster name
24317
+ name: checkID
24537
24318
  required: true
24538
24319
  schema:
24539
24320
  type: string
24540
- - name: id
24541
- in: path
24542
- description: Import task ID
24321
+ - description: The detail type
24322
+ in: query
24323
+ name: type
24543
24324
  required: true
24325
+ schema:
24326
+ $ref: '#/components/schemas/dataCheckDetailType'
24327
+ - description: Source schema or database. Required for snapshot checks.
24328
+ in: query
24329
+ name: schema
24330
+ required: false
24544
24331
  schema:
24545
24332
  type: string
24546
- - name: opsType
24547
- in: path
24548
- description: Operation type
24549
- required: true
24333
+ - description: Source table. Required for snapshot checks.
24334
+ in: query
24335
+ name: table
24336
+ required: false
24550
24337
  schema:
24551
- $ref: '#/components/schemas/ImportOpsType'
24338
+ type: string
24339
+ - description: Struct object key. Optional for struct checks; omitted to page all struct details.
24340
+ in: query
24341
+ name: key
24342
+ required: false
24343
+ schema:
24344
+ type: string
24345
+ - description: Page number for pagination.
24346
+ in: query
24347
+ name: page
24348
+ required: false
24349
+ schema:
24350
+ type: integer
24351
+ minimum: 1
24352
+ default: 1
24353
+ - description: Number of items per page.
24354
+ in: query
24355
+ name: pageSize
24356
+ required: false
24357
+ schema:
24358
+ type: integer
24359
+ minimum: 1
24360
+ maximum: 1000
24361
+ default: 100
24552
24362
  responses:
24553
24363
  '200':
24554
- description: Import task operation completed successfully
24555
24364
  content:
24556
24365
  application/json:
24557
24366
  schema:
24558
- $ref: '#/components/schemas/ImportTaskResponse'
24367
+ $ref: '#/components/schemas/dataCheckDetails'
24368
+ description: A successful response.
24559
24369
  '401':
24560
24370
  $ref: '#/components/responses/401'
24561
24371
  '403':
24562
24372
  $ref: '#/components/responses/403'
24563
24373
  '404':
24564
24374
  $ref: '#/components/responses/404'
24565
- /api/v1/license:
24566
- get:
24567
24375
  tags:
24568
- - license
24569
- summary: Get license
24570
- description: Get license
24571
- operationId: getLicense
24572
- responses:
24573
- '200':
24574
- description: OK
24575
- content:
24576
- application/json:
24577
- schema:
24578
- $ref: '#/components/schemas/license'
24579
- '401':
24580
- $ref: '#/components/responses/401'
24581
- '403':
24582
- $ref: '#/components/responses/403'
24583
- '404':
24584
- $ref: '#/components/responses/404'
24585
- /api/v1/pricing:
24376
+ - dataReplication
24377
+ /api/v1/organizations/{orgName}/checks/{checkID}/sqlLogs:
24586
24378
  get:
24587
- operationId: getEnvironmentPricing
24588
- summary: Get the environment pricing
24379
+ operationId: getDataCheckSQLLogs
24380
+ summary: Get Data Check SQL Logs
24381
+ description: Read raw SQL lines emitted by check sql_logger entries.
24589
24382
  parameters:
24590
- - description: name of the environment (if provided, returns a list with one item; if omitted, returns all environment prices)
24591
- in: query
24592
- name: environmentName
24383
+ - description: The Name of the organization
24384
+ in: path
24385
+ name: orgName
24386
+ required: true
24387
+ schema:
24388
+ type: string
24389
+ - description: The ID of the check
24390
+ in: path
24391
+ name: checkID
24392
+ required: true
24593
24393
  schema:
24594
24394
  type: string
24595
24395
  responses:
24596
24396
  '200':
24597
24397
  content:
24598
- application/json:
24398
+ text/plain:
24599
24399
  schema:
24600
- $ref: '#/components/schemas/environmentPricingList'
24601
- description: Retrieve the price of environment(s) as a list
24400
+ type: string
24401
+ description: Raw SQL lines.
24602
24402
  '401':
24603
24403
  $ref: '#/components/responses/401'
24604
24404
  '403':
@@ -24606,167 +24406,160 @@ paths:
24606
24406
  '404':
24607
24407
  $ref: '#/components/responses/404'
24608
24408
  tags:
24609
- - pricing
24610
- /api/v1/pricing/global:
24611
- get:
24612
- operationId: getGlobalPricing
24613
- summary: Get the global information of pricing
24409
+ - dataReplication
24410
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/import/preflight:
24411
+ post:
24412
+ tags:
24413
+ - import
24414
+ - shared
24415
+ summary: Data source preflight check
24416
+ description: Initiates async validation with the selected source configuration
24417
+ operationId: importPreflight
24418
+ parameters:
24419
+ - name: orgName
24420
+ in: path
24421
+ description: Organization name
24422
+ required: true
24423
+ schema:
24424
+ type: string
24425
+ - name: clusterName
24426
+ in: path
24427
+ description: Cluster name
24428
+ required: true
24429
+ schema:
24430
+ type: string
24431
+ requestBody:
24432
+ required: true
24433
+ description: Data source connection configuration and selection rules
24434
+ content:
24435
+ application/json:
24436
+ schema:
24437
+ $ref: '#/components/schemas/ImportPreflightRequest'
24614
24438
  responses:
24615
24439
  '200':
24440
+ description: Preflight initiated successfully, returns task ID for querying results
24616
24441
  content:
24617
24442
  application/json:
24618
24443
  schema:
24619
- $ref: '#/components/schemas/globalPricing'
24620
- description: Retrieve the global information of pricing
24444
+ $ref: '#/components/schemas/preCheckTaskResponse'
24621
24445
  '401':
24622
24446
  $ref: '#/components/responses/401'
24623
24447
  '403':
24624
24448
  $ref: '#/components/responses/403'
24625
24449
  '404':
24626
24450
  $ref: '#/components/responses/404'
24627
- tags:
24628
- - pricing
24629
- /api/v1/organizations/{orgName}/bills:
24451
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/import/preflight/{taskId}:
24630
24452
  get:
24631
- operationId: listOrgBills
24632
- summary: List bills in the organization
24453
+ tags:
24454
+ - import
24455
+ - shared
24456
+ summary: Get preflight task details
24457
+ description: Retrieves detailed information about a specific data import preflight task by its ID
24458
+ operationId: getImportPreflightTask
24633
24459
  parameters:
24634
- - description: name of the organization
24460
+ - name: orgName
24635
24461
  in: path
24636
- name: orgName
24462
+ description: Organization name
24637
24463
  required: true
24638
24464
  schema:
24639
24465
  type: string
24640
- - description: The ID of the bill
24641
- in: query
24642
- name: billID
24643
- schema:
24644
- type: string
24645
- - description: The ID of the cluster
24646
- in: query
24647
- name: clusterID
24648
- schema:
24649
- type: string
24650
- - description: name of the project
24651
- in: query
24652
- name: projectName
24653
- schema:
24654
- type: string
24655
- - description: The type of aggregation time
24656
- in: query
24657
- name: aggregationTime
24466
+ - name: clusterName
24467
+ in: path
24468
+ description: Cluster name
24658
24469
  required: true
24659
24470
  schema:
24660
- $ref: '#/components/schemas/aggregationTimeType'
24661
- - description: The type of aggregation group
24662
- in: query
24663
- name: aggregationGroup
24471
+ type: string
24472
+ - name: taskId
24473
+ in: path
24474
+ description: Preflight task ID
24664
24475
  required: true
24665
24476
  schema:
24666
- $ref: '#/components/schemas/orgAggregationGroupType'
24667
- - $ref: '#/components/parameters/startTime'
24668
- - $ref: '#/components/parameters/endTime'
24477
+ type: string
24669
24478
  responses:
24670
24479
  '200':
24480
+ description: Successfully returns preflight task details
24671
24481
  content:
24672
24482
  application/json:
24673
24483
  schema:
24674
- $ref: '#/components/schemas/BillList'
24675
- description: List bill details
24676
- '400':
24677
- $ref: '#/components/responses/400'
24484
+ $ref: '#/components/schemas/preCheckTaskDetail'
24678
24485
  '401':
24679
24486
  $ref: '#/components/responses/401'
24680
24487
  '403':
24681
24488
  $ref: '#/components/responses/403'
24682
24489
  '404':
24683
24490
  $ref: '#/components/responses/404'
24491
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/import/objects:
24492
+ post:
24684
24493
  tags:
24685
- - billing
24686
- /api/v1/organizations/{orgName}/metering/tracks:
24687
- get:
24688
- operationId: listOrgMeteringTracks
24689
- summary: List metering tracks in the organization
24494
+ - import
24495
+ - shared
24496
+ summary: Query replication objects for import
24497
+ description: |
24498
+ Enumerates replication objects (databases, schemas, tables, etc.) for the requested node. The metadata levels depend on the source engine (for example MySQL uses `database -> table`, PostgreSQL uses `schema -> table`).
24499
+ operationId: queryImportObjects
24690
24500
  parameters:
24691
- - description: Name of organization
24501
+ - name: orgName
24692
24502
  in: path
24693
- name: orgName
24503
+ description: Organization name
24694
24504
  required: true
24695
24505
  schema:
24696
24506
  type: string
24697
- - description: The ID of the cluster
24698
- in: query
24699
- name: clusterID
24700
- schema:
24701
- type: string
24702
- - description: name of the project
24703
- in: query
24704
- name: projectName
24705
- schema:
24706
- type: string
24707
- - description: The name of the environment
24708
- in: query
24709
- name: environmentName
24507
+ - name: clusterName
24508
+ in: path
24509
+ description: Cluster name
24510
+ required: true
24710
24511
  schema:
24711
24512
  type: string
24712
- - description: the pageNumber of the query
24713
- in: query
24714
- name: pageNumber
24715
- schema:
24716
- type: integer
24717
- format: int64
24718
- - description: the pageSize of the query
24719
- in: query
24720
- name: pageSize
24721
- schema:
24722
- type: integer
24723
- format: int64
24724
- - $ref: '#/components/parameters/startTime'
24725
- - $ref: '#/components/parameters/endTime'
24513
+ requestBody:
24514
+ required: true
24515
+ description: Connection configuration and current object tree position
24516
+ content:
24517
+ application/json:
24518
+ schema:
24519
+ $ref: '#/components/schemas/ImportQueryObjectsRequest'
24726
24520
  responses:
24727
24521
  '200':
24522
+ description: Object tree nodes retrieved successfully
24728
24523
  content:
24729
24524
  application/json:
24730
24525
  schema:
24731
- $ref: '#/components/schemas/MeteringTrackList'
24732
- description: List metering tracks
24733
- '400':
24734
- $ref: '#/components/responses/400'
24526
+ $ref: '#/components/schemas/replicationObjectTree'
24735
24527
  '401':
24736
24528
  $ref: '#/components/responses/401'
24737
24529
  '403':
24738
24530
  $ref: '#/components/responses/403'
24739
24531
  '404':
24740
24532
  $ref: '#/components/responses/404'
24741
- tags:
24742
- - metering
24743
- /api/v1/inspectionScripts:
24533
+ '501':
24534
+ $ref: '#/components/responses/501'
24535
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/import:
24744
24536
  get:
24745
24537
  tags:
24746
- - inspection
24747
- operationId: listInspectionScripts
24748
- summary: list inspection scripts
24538
+ - import
24539
+ - shared
24540
+ summary: Query import task list
24541
+ description: Gets import task list for specified cluster, supports filtering by status and pagination
24542
+ operationId: listImportTask
24749
24543
  parameters:
24750
- - description: name of the Org, multiple orgs separated by ',', if not provided, return all scripts
24751
- in: query
24752
- name: orgNames
24753
- required: false
24544
+ - name: orgName
24545
+ in: path
24546
+ description: Organization name
24547
+ required: true
24754
24548
  schema:
24755
24549
  type: string
24756
- - description: query by, such as "node"/"mysql", multiple engines separated by ','
24757
- in: query
24758
- name: engines
24550
+ - name: clusterName
24551
+ in: path
24552
+ description: Cluster name
24553
+ required: true
24759
24554
  schema:
24760
24555
  type: string
24761
24556
  responses:
24762
24557
  '200':
24763
- description: A successful response.
24558
+ description: Successfully returns task list with pagination info
24764
24559
  content:
24765
24560
  application/json:
24766
24561
  schema:
24767
- type: array
24768
- items:
24769
- $ref: '#/components/schemas/inspectionScript'
24562
+ $ref: '#/components/schemas/ImportTaskListResponse'
24770
24563
  '401':
24771
24564
  $ref: '#/components/responses/401'
24772
24565
  '403':
@@ -24775,54 +24568,80 @@ paths:
24775
24568
  $ref: '#/components/responses/404'
24776
24569
  post:
24777
24570
  tags:
24778
- - inspection
24779
- operationId: createInspectionScript
24780
- summary: Create inspection script
24571
+ - import
24572
+ - shared
24573
+ summary: Create import task
24574
+ description: Creates new data import task based on data source configuration and import options
24575
+ operationId: createImportTask
24576
+ parameters:
24577
+ - name: orgName
24578
+ in: path
24579
+ description: Organization name
24580
+ required: true
24581
+ schema:
24582
+ type: string
24583
+ - name: clusterName
24584
+ in: path
24585
+ description: Cluster name
24586
+ required: true
24587
+ schema:
24588
+ type: string
24781
24589
  requestBody:
24590
+ required: true
24591
+ description: Import task configuration including data source connection, object selection and import options
24782
24592
  content:
24783
24593
  application/json:
24784
24594
  schema:
24785
- $ref: '#/components/schemas/inspectionScript'
24786
- required: true
24595
+ $ref: '#/components/schemas/ImportTaskCreateRequest'
24787
24596
  responses:
24788
- '200':
24789
- description: A successful response.
24597
+ '201':
24598
+ description: Task created successfully, returns basic task information
24790
24599
  content:
24791
24600
  application/json:
24792
24601
  schema:
24793
- $ref: '#/components/schemas/inspectionScript'
24602
+ $ref: '#/components/schemas/ImportTaskResponse'
24794
24603
  '401':
24795
24604
  $ref: '#/components/responses/401'
24796
24605
  '403':
24797
24606
  $ref: '#/components/responses/403'
24798
24607
  '404':
24799
24608
  $ref: '#/components/responses/404'
24800
- /api/v1/inspectionScripts/{scriptId}:
24801
- patch:
24609
+ '409':
24610
+ $ref: '#/components/responses/409'
24611
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/import/{id}:
24612
+ get:
24802
24613
  tags:
24803
- - inspection
24804
- operationId: updateInspectionScript
24805
- summary: Update inspection script
24614
+ - import
24615
+ - shared
24616
+ summary: Get import task details
24617
+ description: Gets detailed information about a specific import task by its ID
24618
+ operationId: getImportTask
24806
24619
  parameters:
24807
- - description: id of the inspection script
24620
+ - name: orgName
24808
24621
  in: path
24809
- name: scriptId
24622
+ description: Organization name
24623
+ required: true
24624
+ schema:
24625
+ type: string
24626
+ - name: clusterName
24627
+ in: path
24628
+ description: Cluster name
24629
+ required: true
24630
+ schema:
24631
+ type: string
24632
+ - name: id
24633
+ in: path
24634
+ description: Import task ID
24810
24635
  required: true
24811
24636
  schema:
24812
24637
  type: string
24813
- requestBody:
24814
- content:
24815
- application/json:
24816
- schema:
24817
- $ref: '#/components/schemas/inspectionScript'
24818
- required: true
24819
24638
  responses:
24820
24639
  '200':
24821
- description: A successful response.
24640
+ description: Successfully returns import task details
24822
24641
  content:
24823
24642
  application/json:
24824
24643
  schema:
24825
- $ref: '#/components/schemas/inspectionScript'
24644
+ $ref: '#/components/schemas/ImportTaskResponse'
24826
24645
  '401':
24827
24646
  $ref: '#/components/responses/401'
24828
24647
  '403':
@@ -24831,322 +24650,279 @@ paths:
24831
24650
  $ref: '#/components/responses/404'
24832
24651
  delete:
24833
24652
  tags:
24834
- - inspection
24835
- operationId: deleteInspectionScript
24836
- summary: Delete inspection script
24653
+ - import
24654
+ - shared
24655
+ summary: Delete import task
24656
+ description: Stops and deletes specified import task, will clean up related Kubernetes resources
24657
+ operationId: deleteImportTask
24837
24658
  parameters:
24838
- - description: id of the inspection script
24659
+ - name: orgName
24839
24660
  in: path
24840
- name: scriptId
24661
+ description: Organization name
24662
+ required: true
24663
+ schema:
24664
+ type: string
24665
+ - name: clusterName
24666
+ in: path
24667
+ description: Cluster name
24668
+ required: true
24669
+ schema:
24670
+ type: string
24671
+ - name: id
24672
+ in: path
24673
+ description: Import task ID
24841
24674
  required: true
24842
24675
  schema:
24843
24676
  type: string
24844
24677
  responses:
24845
24678
  '204':
24846
- description: No content.
24847
- content: {}
24848
- '401':
24849
- $ref: '#/components/responses/401'
24850
- '403':
24851
- $ref: '#/components/responses/403'
24852
- '404':
24853
- $ref: '#/components/responses/404'
24854
- /api/v1/autoInspections:
24855
- post:
24856
- tags:
24857
- - inspection
24858
- operationId: createAutoInspection
24859
- summary: Create inspection cron job
24860
- requestBody:
24861
- content:
24862
- application/json:
24863
- schema:
24864
- $ref: '#/components/schemas/autoInspection'
24865
- required: true
24866
- responses:
24867
- '200':
24868
- description: A successful response.
24869
- content:
24870
- application/json:
24871
- schema:
24872
- $ref: '#/components/schemas/autoInspection'
24679
+ description: Task deleted successfully
24873
24680
  '401':
24874
24681
  $ref: '#/components/responses/401'
24875
24682
  '403':
24876
24683
  $ref: '#/components/responses/403'
24877
24684
  '404':
24878
24685
  $ref: '#/components/responses/404'
24879
- /api/v1/autoInspection:
24880
- get:
24686
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/import/{id}/ops/{opsType}:
24687
+ patch:
24881
24688
  tags:
24882
- - inspection
24883
- operationId: getAutoInspection
24884
- summary: get auto inspection
24689
+ - import
24690
+ - shared
24691
+ summary: Create a import task operation
24692
+ description: Performs pause or resume operation on import task based on opsType parameter
24693
+ operationId: updateImportTaskOps
24885
24694
  parameters:
24886
- - description: id of the auto inspection
24887
- in: query
24888
- name: id
24889
- required: false
24695
+ - name: orgName
24696
+ in: path
24697
+ description: Organization name
24698
+ required: true
24890
24699
  schema:
24891
24700
  type: string
24892
- - description: name of the Org
24893
- in: query
24894
- name: orgName
24895
- required: false
24701
+ - name: clusterName
24702
+ in: path
24703
+ description: Cluster name
24704
+ required: true
24896
24705
  schema:
24897
24706
  type: string
24898
- - description: name of the environment
24899
- in: query
24900
- name: envName
24901
- required: false
24707
+ - name: id
24708
+ in: path
24709
+ description: Import task ID
24710
+ required: true
24902
24711
  schema:
24903
24712
  type: string
24904
- - description: name of the cluster, must be used with orgName
24905
- in: query
24906
- name: clusterName
24907
- required: false
24713
+ - name: opsType
24714
+ in: path
24715
+ description: Operation type
24716
+ required: true
24908
24717
  schema:
24909
- type: string
24718
+ $ref: '#/components/schemas/ImportOpsType'
24910
24719
  responses:
24911
24720
  '200':
24912
- description: A successful response.
24721
+ description: Import task operation completed successfully
24913
24722
  content:
24914
24723
  application/json:
24915
24724
  schema:
24916
- $ref: '#/components/schemas/autoInspection'
24725
+ $ref: '#/components/schemas/ImportTaskResponse'
24917
24726
  '401':
24918
24727
  $ref: '#/components/responses/401'
24919
24728
  '403':
24920
24729
  $ref: '#/components/responses/403'
24921
24730
  '404':
24922
24731
  $ref: '#/components/responses/404'
24923
- /api/v1/autoInspections/{id}:
24924
- patch:
24732
+ /api/v1/license:
24733
+ get:
24925
24734
  tags:
24926
- - inspection
24927
- operationId: updateAutoInspection
24928
- summary: update auto inspection
24929
- parameters:
24930
- - description: id of the auto inspection
24931
- in: path
24932
- name: id
24933
- required: true
24934
- schema:
24935
- type: string
24936
- requestBody:
24937
- content:
24938
- application/json:
24939
- schema:
24940
- $ref: '#/components/schemas/autoInspection'
24941
- required: true
24735
+ - license
24736
+ summary: Get license
24737
+ description: Get license
24738
+ operationId: getLicense
24942
24739
  responses:
24943
24740
  '200':
24944
- description: A successful response.
24741
+ description: OK
24945
24742
  content:
24946
24743
  application/json:
24947
24744
  schema:
24948
- $ref: '#/components/schemas/autoInspection'
24745
+ $ref: '#/components/schemas/license'
24949
24746
  '401':
24950
24747
  $ref: '#/components/responses/401'
24951
24748
  '403':
24952
24749
  $ref: '#/components/responses/403'
24953
24750
  '404':
24954
24751
  $ref: '#/components/responses/404'
24955
- delete:
24956
- tags:
24957
- - inspection
24958
- operationId: deleteAutoInspection
24959
- summary: delete auto inspection
24752
+ /api/v1/pricing:
24753
+ get:
24754
+ operationId: getEnvironmentPricing
24755
+ summary: Get the environment pricing
24960
24756
  parameters:
24961
- - description: id of the auto inspection
24962
- in: path
24963
- name: id
24964
- required: true
24757
+ - description: name of the environment (if provided, returns a list with one item; if omitted, returns all environment prices)
24758
+ in: query
24759
+ name: environmentName
24965
24760
  schema:
24966
24761
  type: string
24967
24762
  responses:
24968
- '204':
24969
- description: No content.
24970
- content: {}
24763
+ '200':
24764
+ content:
24765
+ application/json:
24766
+ schema:
24767
+ $ref: '#/components/schemas/environmentPricingList'
24768
+ description: Retrieve the price of environment(s) as a list
24971
24769
  '401':
24972
24770
  $ref: '#/components/responses/401'
24973
24771
  '403':
24974
24772
  $ref: '#/components/responses/403'
24975
24773
  '404':
24976
24774
  $ref: '#/components/responses/404'
24977
- /api/v1/organizations/{orgName}/inspectionTasksByOrg:
24978
- get:
24979
24775
  tags:
24980
- - inspection
24981
- operationId: listInspectionTasksByOrg
24982
- summary: list inspection tasks by org
24983
- parameters:
24984
- - description: name of the Org
24985
- in: path
24986
- name: orgName
24987
- required: true
24988
- schema:
24989
- type: string
24990
- - description: list tasks for the specified cluster
24991
- in: query
24992
- name: clusterId
24993
- schema:
24994
- type: string
24995
- - $ref: '#/components/parameters/startTime'
24996
- - $ref: '#/components/parameters/endTime'
24776
+ - pricing
24777
+ /api/v1/pricing/global:
24778
+ get:
24779
+ operationId: getGlobalPricing
24780
+ summary: Get the global information of pricing
24997
24781
  responses:
24998
24782
  '200':
24999
- description: A successful response.
25000
24783
  content:
25001
24784
  application/json:
25002
24785
  schema:
25003
- type: array
25004
- items:
25005
- $ref: '#/components/schemas/inspectionTask'
24786
+ $ref: '#/components/schemas/globalPricing'
24787
+ description: Retrieve the global information of pricing
25006
24788
  '401':
25007
24789
  $ref: '#/components/responses/401'
25008
24790
  '403':
25009
24791
  $ref: '#/components/responses/403'
25010
24792
  '404':
25011
24793
  $ref: '#/components/responses/404'
25012
- post:
25013
24794
  tags:
25014
- - inspection
25015
- operationId: createInspectionTaskByOrg
25016
- summary: Trigger inspection for selected clusters in an organization
25017
- description: Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
24795
+ - pricing
24796
+ /api/v1/organizations/{orgName}/bills:
24797
+ get:
24798
+ operationId: listOrgBills
24799
+ summary: List bills in the organization
25018
24800
  parameters:
25019
- - description: name of the Org
24801
+ - description: name of the organization
25020
24802
  in: path
25021
24803
  name: orgName
25022
24804
  required: true
25023
24805
  schema:
25024
24806
  type: string
25025
- requestBody:
25026
- content:
25027
- application/json:
25028
- schema:
25029
- $ref: '#/components/schemas/inspectionTaskCreate'
25030
- required: true
25031
- responses:
25032
- '204':
25033
- description: Inspection tasks created and accepted for asynchronous execution.
25034
- content: {}
25035
- '400':
25036
- $ref: '#/components/responses/400'
25037
- '401':
25038
- $ref: '#/components/responses/401'
25039
- '403':
25040
- $ref: '#/components/responses/403'
25041
- '404':
25042
- $ref: '#/components/responses/404'
25043
- /api/v1/organizations/{orgName}/inspectionTasksByOrg/{taskId}:
25044
- get:
25045
- tags:
25046
- - inspection
25047
- operationId: getInspectionTaskByOrg
25048
- summary: get inspection task by org
25049
- parameters:
25050
- - description: name of the Org
25051
- in: path
25052
- name: orgName
25053
- required: true
24807
+ - description: The ID of the bill
24808
+ in: query
24809
+ name: billID
25054
24810
  schema:
25055
24811
  type: string
25056
- - description: list task details if specified
25057
- in: path
25058
- name: taskId
25059
- required: true
24812
+ - description: The ID of the cluster
24813
+ in: query
24814
+ name: clusterID
25060
24815
  schema:
25061
24816
  type: string
25062
- - description: the format of the task
24817
+ - description: name of the project
25063
24818
  in: query
25064
- name: format
25065
- required: false
24819
+ name: projectName
25066
24820
  schema:
25067
- $ref: '#/components/schemas/inspectionTaskFormat'
24821
+ type: string
24822
+ - description: The type of aggregation time
24823
+ in: query
24824
+ name: aggregationTime
24825
+ required: true
24826
+ schema:
24827
+ $ref: '#/components/schemas/aggregationTimeType'
24828
+ - description: The type of aggregation group
24829
+ in: query
24830
+ name: aggregationGroup
24831
+ required: true
24832
+ schema:
24833
+ $ref: '#/components/schemas/orgAggregationGroupType'
24834
+ - $ref: '#/components/parameters/startTime'
24835
+ - $ref: '#/components/parameters/endTime'
25068
24836
  responses:
25069
24837
  '200':
25070
- description: A successful response.
25071
24838
  content:
25072
24839
  application/json:
25073
24840
  schema:
25074
- $ref: '#/components/schemas/inspectionTask'
24841
+ $ref: '#/components/schemas/BillList'
24842
+ description: List bill details
24843
+ '400':
24844
+ $ref: '#/components/responses/400'
25075
24845
  '401':
25076
24846
  $ref: '#/components/responses/401'
25077
24847
  '403':
25078
24848
  $ref: '#/components/responses/403'
25079
24849
  '404':
25080
24850
  $ref: '#/components/responses/404'
25081
- /api/v1/inspectionTasks/aggregate:
25082
- get:
25083
24851
  tags:
25084
- - inspection
25085
- operationId: getAggregateTaskResult
25086
- summary: get aggregate task result
24852
+ - billing
24853
+ /api/v1/organizations/{orgName}/metering/tracks:
24854
+ get:
24855
+ operationId: listOrgMeteringTracks
24856
+ summary: List metering tracks in the organization
25087
24857
  parameters:
25088
- - description: the type of the aggregate task
25089
- in: query
25090
- name: aggregateType
24858
+ - description: Name of organization
24859
+ in: path
24860
+ name: orgName
25091
24861
  required: true
25092
24862
  schema:
25093
- $ref: '#/components/schemas/aggregateTaskType'
25094
- - description: the engine of the task
24863
+ type: string
24864
+ - description: The ID of the cluster
25095
24865
  in: query
25096
- name: engine
25097
- required: false
24866
+ name: clusterID
25098
24867
  schema:
25099
24868
  type: string
25100
- - description: only show the result of the specific organization or environment
24869
+ - description: name of the project
25101
24870
  in: query
25102
- name: resourceName
25103
- required: false
24871
+ name: projectName
25104
24872
  schema:
25105
24873
  type: string
25106
- - description: result of the task
24874
+ - description: The name of the environment
25107
24875
  in: query
25108
- name: resultType
25109
- required: false
24876
+ name: environmentName
25110
24877
  schema:
25111
- $ref: '#/components/schemas/aggregateTaskResultType'
24878
+ type: string
24879
+ - description: the pageNumber of the query
24880
+ in: query
24881
+ name: pageNumber
24882
+ schema:
24883
+ type: integer
24884
+ format: int64
24885
+ - description: the pageSize of the query
24886
+ in: query
24887
+ name: pageSize
24888
+ schema:
24889
+ type: integer
24890
+ format: int64
25112
24891
  - $ref: '#/components/parameters/startTime'
25113
24892
  - $ref: '#/components/parameters/endTime'
25114
24893
  responses:
25115
24894
  '200':
25116
- description: A successful response.
25117
24895
  content:
25118
24896
  application/json:
25119
24897
  schema:
25120
- $ref: '#/components/schemas/aggregateTaskResultList'
24898
+ $ref: '#/components/schemas/MeteringTrackList'
24899
+ description: List metering tracks
24900
+ '400':
24901
+ $ref: '#/components/responses/400'
25121
24902
  '401':
25122
24903
  $ref: '#/components/responses/401'
25123
24904
  '403':
25124
24905
  $ref: '#/components/responses/403'
25125
24906
  '404':
25126
24907
  $ref: '#/components/responses/404'
25127
- /api/v1/engines/{engineName}/schedulingPolicies:
24908
+ tags:
24909
+ - metering
24910
+ /api/v1/inspectionScripts:
25128
24911
  get:
25129
24912
  tags:
25130
- - engine
25131
- operationId: listEngineSchedulingPolicies
25132
- summary: List engine scheduling policies
24913
+ - inspection
24914
+ operationId: listInspectionScripts
24915
+ summary: list inspection scripts
25133
24916
  parameters:
25134
- - name: engineName
25135
- in: path
25136
- description: engine name
25137
- required: true
25138
- schema:
25139
- type: string
25140
- - name: engineMode
24917
+ - description: name of the Org, multiple orgs separated by ',', if not provided, return all scripts
25141
24918
  in: query
25142
- description: engine mode
24919
+ name: orgNames
25143
24920
  required: false
25144
24921
  schema:
25145
24922
  type: string
25146
- - name: env
24923
+ - description: query by, such as "node"/"mysql", multiple engines separated by ','
25147
24924
  in: query
25148
- description: environment name
25149
- required: false
24925
+ name: engines
25150
24926
  schema:
25151
24927
  type: string
25152
24928
  responses:
@@ -25157,169 +24933,170 @@ paths:
25157
24933
  schema:
25158
24934
  type: array
25159
24935
  items:
25160
- $ref: '#/components/schemas/engineSchedulingPolicy'
24936
+ $ref: '#/components/schemas/inspectionScript'
25161
24937
  '401':
25162
24938
  $ref: '#/components/responses/401'
25163
24939
  '403':
25164
24940
  $ref: '#/components/responses/403'
25165
24941
  '404':
25166
24942
  $ref: '#/components/responses/404'
25167
- /api/v1/environments/{environmentName}/engineNetworkModes/supported:
25168
- get:
24943
+ post:
25169
24944
  tags:
25170
- - engine
25171
- operationId: getEngineNetworkModeSupported
25172
- summary: Get supported network modes for engine+mode from engineOption config
25173
- parameters:
25174
- - name: environmentName
25175
- in: path
25176
- description: environment name
25177
- required: true
25178
- schema:
25179
- type: string
25180
- - name: engineName
25181
- in: query
25182
- description: engine name
25183
- required: true
25184
- schema:
25185
- type: string
25186
- - name: mode
25187
- in: query
25188
- description: engine mode
25189
- required: true
25190
- schema:
25191
- type: string
24945
+ - inspection
24946
+ operationId: createInspectionScript
24947
+ summary: Create inspection script
24948
+ requestBody:
24949
+ content:
24950
+ application/json:
24951
+ schema:
24952
+ $ref: '#/components/schemas/inspectionScript'
24953
+ required: true
25192
24954
  responses:
25193
24955
  '200':
25194
24956
  description: A successful response.
25195
24957
  content:
25196
24958
  application/json:
25197
24959
  schema:
25198
- $ref: '#/components/schemas/engineNetworkModeSupported'
24960
+ $ref: '#/components/schemas/inspectionScript'
25199
24961
  '401':
25200
24962
  $ref: '#/components/responses/401'
25201
24963
  '403':
25202
24964
  $ref: '#/components/responses/403'
25203
24965
  '404':
25204
24966
  $ref: '#/components/responses/404'
25205
- /api/v1/organizations/{orgName}/blueGreenDeployment/{deploymentID}:
25206
- get:
25207
- operationId: getBlueGreenDeployment
25208
- summary: Get a blue-green deployment instance
25209
- description: Retrieve details for a single blue-green deployment instance by parent cluster and organization.
24967
+ /api/v1/inspectionScripts/{scriptId}:
24968
+ patch:
24969
+ tags:
24970
+ - inspection
24971
+ operationId: updateInspectionScript
24972
+ summary: Update inspection script
25210
24973
  parameters:
25211
- - description: The unique identifier of the blue-green deployment instance
25212
- in: path
25213
- name: deploymentID
25214
- required: true
25215
- schema:
25216
- type: string
25217
- - description: Name of the organization
24974
+ - description: id of the inspection script
25218
24975
  in: path
25219
- name: orgName
24976
+ name: scriptId
25220
24977
  required: true
25221
24978
  schema:
25222
24979
  type: string
24980
+ requestBody:
24981
+ content:
24982
+ application/json:
24983
+ schema:
24984
+ $ref: '#/components/schemas/inspectionScript'
24985
+ required: true
25223
24986
  responses:
25224
24987
  '200':
24988
+ description: A successful response.
25225
24989
  content:
25226
24990
  application/json:
25227
24991
  schema:
25228
- $ref: '#/components/schemas/blueGreenDeploymentItem'
25229
- description: Details of the blue-green deployment instance.
24992
+ $ref: '#/components/schemas/inspectionScript'
25230
24993
  '401':
25231
24994
  $ref: '#/components/responses/401'
25232
24995
  '403':
25233
24996
  $ref: '#/components/responses/403'
25234
24997
  '404':
25235
24998
  $ref: '#/components/responses/404'
25236
- '501':
25237
- $ref: '#/components/responses/501'
25238
- tags:
25239
- - blueGreenDeployment
25240
24999
  delete:
25241
- operationId: deleteBlueGreenDeployment
25242
- summary: Delete a blue-green deployment instance
25243
- description: Delete a specified blue-green deployment instance.
25000
+ tags:
25001
+ - inspection
25002
+ operationId: deleteInspectionScript
25003
+ summary: Delete inspection script
25244
25004
  parameters:
25245
- - description: The unique identifier of the blue-green deployment instance
25246
- in: path
25247
- name: deploymentID
25248
- required: true
25249
- schema:
25250
- type: string
25251
- - description: Name of the organization
25005
+ - description: id of the inspection script
25252
25006
  in: path
25253
- name: orgName
25007
+ name: scriptId
25254
25008
  required: true
25255
25009
  schema:
25256
25010
  type: string
25011
+ responses:
25012
+ '204':
25013
+ description: No content.
25014
+ content: {}
25015
+ '401':
25016
+ $ref: '#/components/responses/401'
25017
+ '403':
25018
+ $ref: '#/components/responses/403'
25019
+ '404':
25020
+ $ref: '#/components/responses/404'
25021
+ /api/v1/autoInspections:
25022
+ post:
25023
+ tags:
25024
+ - inspection
25025
+ operationId: createAutoInspection
25026
+ summary: Create inspection cron job
25027
+ requestBody:
25028
+ content:
25029
+ application/json:
25030
+ schema:
25031
+ $ref: '#/components/schemas/autoInspection'
25032
+ required: true
25257
25033
  responses:
25258
25034
  '200':
25035
+ description: A successful response.
25259
25036
  content:
25260
25037
  application/json:
25261
25038
  schema:
25262
- $ref: '#/components/schemas/blueGreenDeploymentTask'
25263
- description: Async job task information for blue-green deployment instance deletion.
25039
+ $ref: '#/components/schemas/autoInspection'
25264
25040
  '401':
25265
25041
  $ref: '#/components/responses/401'
25266
25042
  '403':
25267
25043
  $ref: '#/components/responses/403'
25268
25044
  '404':
25269
25045
  $ref: '#/components/responses/404'
25270
- '501':
25271
- $ref: '#/components/responses/501'
25272
- tags:
25273
- - blueGreenDeployment
25274
- /api/v1/organizations/{orgName}/parent/{parentClusterID}/blueGreenDeployment:
25046
+ /api/v1/autoInspection:
25275
25047
  get:
25276
- operationId: listBlueGreenDeployments
25277
- summary: List blue-green deployment instances for the specified parent cluster
25278
- description: Retrieve a list of blue-green deployment instances associated with the given parent database cluster.
25048
+ tags:
25049
+ - inspection
25050
+ operationId: getAutoInspection
25051
+ summary: get auto inspection
25279
25052
  parameters:
25280
- - description: The unique identifier of the parent database cluster
25281
- in: path
25282
- name: parentClusterID
25283
- required: true
25053
+ - description: id of the auto inspection
25054
+ in: query
25055
+ name: id
25056
+ required: false
25284
25057
  schema:
25285
25058
  type: string
25286
- - description: Name of the organization
25287
- in: path
25059
+ - description: name of the Org
25060
+ in: query
25288
25061
  name: orgName
25289
- required: true
25062
+ required: false
25063
+ schema:
25064
+ type: string
25065
+ - description: name of the environment
25066
+ in: query
25067
+ name: envName
25068
+ required: false
25069
+ schema:
25070
+ type: string
25071
+ - description: name of the cluster, must be used with orgName
25072
+ in: query
25073
+ name: clusterName
25074
+ required: false
25290
25075
  schema:
25291
25076
  type: string
25292
25077
  responses:
25293
25078
  '200':
25079
+ description: A successful response.
25294
25080
  content:
25295
25081
  application/json:
25296
25082
  schema:
25297
- $ref: '#/components/schemas/blueGreenDeploymentItemList'
25298
- description: A list of blue-green deployment instances.
25083
+ $ref: '#/components/schemas/autoInspection'
25299
25084
  '401':
25300
25085
  $ref: '#/components/responses/401'
25301
25086
  '403':
25302
25087
  $ref: '#/components/responses/403'
25303
25088
  '404':
25304
25089
  $ref: '#/components/responses/404'
25305
- '501':
25306
- $ref: '#/components/responses/501'
25090
+ /api/v1/autoInspections/{id}:
25091
+ patch:
25307
25092
  tags:
25308
- - blueGreenDeployment
25309
- post:
25310
- operationId: createBlueGreenDeployment
25311
- summary: Create a new blue-green deployment instance
25312
- description: Create a blue-green deployment instance for the specified parent cluster.
25093
+ - inspection
25094
+ operationId: updateAutoInspection
25095
+ summary: update auto inspection
25313
25096
  parameters:
25314
- - description: The unique identifier of the parent database cluster
25315
- in: path
25316
- name: parentClusterID
25317
- required: true
25318
- schema:
25319
- type: string
25320
- - description: Name of the organization
25097
+ - description: id of the auto inspection
25321
25098
  in: path
25322
- name: orgName
25099
+ name: id
25323
25100
  required: true
25324
25101
  schema:
25325
25102
  type: string
@@ -25327,144 +25104,534 @@ paths:
25327
25104
  content:
25328
25105
  application/json:
25329
25106
  schema:
25330
- $ref: '#/components/schemas/blueGreenDeploymentCreation'
25107
+ $ref: '#/components/schemas/autoInspection'
25331
25108
  required: true
25332
25109
  responses:
25333
- '204':
25334
- content: {}
25335
- description: Returned when blue-green deployment instance is created successfully.
25110
+ '200':
25111
+ description: A successful response.
25112
+ content:
25113
+ application/json:
25114
+ schema:
25115
+ $ref: '#/components/schemas/autoInspection'
25336
25116
  '401':
25337
25117
  $ref: '#/components/responses/401'
25338
25118
  '403':
25339
25119
  $ref: '#/components/responses/403'
25340
25120
  '404':
25341
25121
  $ref: '#/components/responses/404'
25342
- '501':
25343
- $ref: '#/components/responses/501'
25122
+ delete:
25344
25123
  tags:
25345
- - blueGreenDeployment
25346
- x-codegen-request-body-name: body
25347
- /api/v1/organizations/{orgName}/blueGreenDeployment/{deploymentID}/switch:
25348
- post:
25349
- operationId: switchBlueGreenDeployment
25350
- summary: Switch roles of blue-green deployment instances
25351
- description: Switch the specified blue-green deployment cluster to act as the primary instance.
25124
+ - inspection
25125
+ operationId: deleteAutoInspection
25126
+ summary: delete auto inspection
25352
25127
  parameters:
25353
- - description: The unique identifier of the blue-green deployment cluster
25128
+ - description: id of the auto inspection
25354
25129
  in: path
25355
- name: deploymentID
25130
+ name: id
25356
25131
  required: true
25357
25132
  schema:
25358
25133
  type: string
25359
- - description: Name of the organization
25134
+ responses:
25135
+ '204':
25136
+ description: No content.
25137
+ content: {}
25138
+ '401':
25139
+ $ref: '#/components/responses/401'
25140
+ '403':
25141
+ $ref: '#/components/responses/403'
25142
+ '404':
25143
+ $ref: '#/components/responses/404'
25144
+ /api/v1/organizations/{orgName}/inspectionTasksByOrg:
25145
+ get:
25146
+ tags:
25147
+ - inspection
25148
+ operationId: listInspectionTasksByOrg
25149
+ summary: list inspection tasks by org
25150
+ parameters:
25151
+ - description: name of the Org
25360
25152
  in: path
25361
25153
  name: orgName
25362
25154
  required: true
25363
25155
  schema:
25364
25156
  type: string
25157
+ - description: list tasks for the specified cluster
25158
+ in: query
25159
+ name: clusterId
25160
+ schema:
25161
+ type: string
25162
+ - $ref: '#/components/parameters/startTime'
25163
+ - $ref: '#/components/parameters/endTime'
25365
25164
  responses:
25366
25165
  '200':
25166
+ description: A successful response.
25367
25167
  content:
25368
25168
  application/json:
25369
25169
  schema:
25370
- $ref: '#/components/schemas/blueGreenDeploymentSwitchResponse'
25371
- description: Async job task information for the blue-green deployment switch operation.
25170
+ type: array
25171
+ items:
25172
+ $ref: '#/components/schemas/inspectionTask'
25372
25173
  '401':
25373
25174
  $ref: '#/components/responses/401'
25374
25175
  '403':
25375
25176
  $ref: '#/components/responses/403'
25376
25177
  '404':
25377
25178
  $ref: '#/components/responses/404'
25378
- '501':
25379
- $ref: '#/components/responses/501'
25179
+ post:
25380
25180
  tags:
25381
- - blueGreenDeployment
25382
- x-codegen-request-body-name: body
25383
- get:
25384
- operationId: getBlueGreenDeploymentSwitchDetail
25385
- summary: Get blue-green deployment switch job detail
25386
- description: Retrieve detailed information about the switch-over operation for a blue-green deployment cluster.
25181
+ - inspection
25182
+ operationId: createInspectionTaskByOrg
25183
+ summary: Trigger inspection for selected clusters in an organization
25184
+ description: Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
25387
25185
  parameters:
25388
- - description: The unique identifier of the blue-green deployment instance
25389
- in: path
25390
- name: deploymentID
25391
- required: true
25392
- schema:
25393
- type: string
25394
- - description: Name of the organization
25186
+ - description: name of the Org
25395
25187
  in: path
25396
25188
  name: orgName
25397
25189
  required: true
25398
25190
  schema:
25399
25191
  type: string
25192
+ requestBody:
25193
+ content:
25194
+ application/json:
25195
+ schema:
25196
+ $ref: '#/components/schemas/inspectionTaskCreate'
25197
+ required: true
25400
25198
  responses:
25401
- '200':
25402
- content:
25403
- application/json:
25404
- schema:
25405
- $ref: '#/components/schemas/blueGreenDeploymentSwitchResponse'
25406
- description: Details of the blue-green deployment switch job/task.
25199
+ '204':
25200
+ description: Inspection tasks created and accepted for asynchronous execution.
25201
+ content: {}
25202
+ '400':
25203
+ $ref: '#/components/responses/400'
25407
25204
  '401':
25408
25205
  $ref: '#/components/responses/401'
25409
25206
  '403':
25410
25207
  $ref: '#/components/responses/403'
25411
25208
  '404':
25412
25209
  $ref: '#/components/responses/404'
25413
- '501':
25414
- $ref: '#/components/responses/501'
25210
+ /api/v1/organizations/{orgName}/inspectionTasksByOrg/{taskId}:
25211
+ get:
25415
25212
  tags:
25416
- - blueGreenDeployment
25417
- /api/v1/organizations/{orgName}/parent/{parentClusterID}/blueGreenDeployment/precheck:
25418
- post:
25419
- operationId: createBlueGreenDeploymentPreCheck
25420
- summary: Run a precheck for blue-green deployment
25421
- description: Trigger a precheck task to verify settings or readiness for blue-green deployment.
25213
+ - inspection
25214
+ operationId: getInspectionTaskByOrg
25215
+ summary: get inspection task by org
25422
25216
  parameters:
25423
- - description: Name of the organization
25217
+ - description: name of the Org
25424
25218
  in: path
25425
25219
  name: orgName
25426
25220
  required: true
25427
25221
  schema:
25428
25222
  type: string
25429
- - description: The unique identifier of the parent database cluster
25223
+ - description: list task details if specified
25430
25224
  in: path
25431
- name: parentClusterID
25225
+ name: taskId
25432
25226
  required: true
25433
25227
  schema:
25434
25228
  type: string
25435
- - description: The version of the green cluster
25229
+ - description: the format of the task
25436
25230
  in: query
25437
- name: greenClusterVersion
25438
- required: true
25231
+ name: format
25232
+ required: false
25439
25233
  schema:
25440
- type: string
25234
+ $ref: '#/components/schemas/inspectionTaskFormat'
25441
25235
  responses:
25442
25236
  '200':
25237
+ description: A successful response.
25443
25238
  content:
25444
25239
  application/json:
25445
25240
  schema:
25446
- $ref: '#/components/schemas/blueGreenDeploymentPreCheckResponse'
25447
- description: Precheck task creation response.
25241
+ $ref: '#/components/schemas/inspectionTask'
25448
25242
  '401':
25449
25243
  $ref: '#/components/responses/401'
25450
25244
  '403':
25451
25245
  $ref: '#/components/responses/403'
25452
25246
  '404':
25453
25247
  $ref: '#/components/responses/404'
25454
- '501':
25455
- $ref: '#/components/responses/501'
25456
- tags:
25457
- - blueGreenDeployment
25458
- x-codegen-request-body-name: body
25459
- /api/v1/organizations/{orgName}/blueGreenDeployment/precheck/{preCheckID}:
25248
+ /api/v1/inspectionTasks/aggregate:
25460
25249
  get:
25461
- operationId: getBlueGreenDeploymentPreCheckDetail
25462
- summary: Get blue-green deployment precheck task detail
25463
- description: Retrieve the details of a precheck task for a blue-green deployment.
25250
+ tags:
25251
+ - inspection
25252
+ operationId: getAggregateTaskResult
25253
+ summary: get aggregate task result
25464
25254
  parameters:
25465
- - description: The unique identifier of the precheck task
25466
- in: path
25467
- name: preCheckID
25255
+ - description: the type of the aggregate task
25256
+ in: query
25257
+ name: aggregateType
25258
+ required: true
25259
+ schema:
25260
+ $ref: '#/components/schemas/aggregateTaskType'
25261
+ - description: the engine of the task
25262
+ in: query
25263
+ name: engine
25264
+ required: false
25265
+ schema:
25266
+ type: string
25267
+ - description: only show the result of the specific organization or environment
25268
+ in: query
25269
+ name: resourceName
25270
+ required: false
25271
+ schema:
25272
+ type: string
25273
+ - description: result of the task
25274
+ in: query
25275
+ name: resultType
25276
+ required: false
25277
+ schema:
25278
+ $ref: '#/components/schemas/aggregateTaskResultType'
25279
+ - $ref: '#/components/parameters/startTime'
25280
+ - $ref: '#/components/parameters/endTime'
25281
+ responses:
25282
+ '200':
25283
+ description: A successful response.
25284
+ content:
25285
+ application/json:
25286
+ schema:
25287
+ $ref: '#/components/schemas/aggregateTaskResultList'
25288
+ '401':
25289
+ $ref: '#/components/responses/401'
25290
+ '403':
25291
+ $ref: '#/components/responses/403'
25292
+ '404':
25293
+ $ref: '#/components/responses/404'
25294
+ /api/v1/engines/{engineName}/schedulingPolicies:
25295
+ get:
25296
+ tags:
25297
+ - engine
25298
+ operationId: listEngineSchedulingPolicies
25299
+ summary: List engine scheduling policies
25300
+ parameters:
25301
+ - name: engineName
25302
+ in: path
25303
+ description: engine name
25304
+ required: true
25305
+ schema:
25306
+ type: string
25307
+ - name: engineMode
25308
+ in: query
25309
+ description: engine mode
25310
+ required: false
25311
+ schema:
25312
+ type: string
25313
+ - name: env
25314
+ in: query
25315
+ description: environment name
25316
+ required: false
25317
+ schema:
25318
+ type: string
25319
+ responses:
25320
+ '200':
25321
+ description: A successful response.
25322
+ content:
25323
+ application/json:
25324
+ schema:
25325
+ type: array
25326
+ items:
25327
+ $ref: '#/components/schemas/engineSchedulingPolicy'
25328
+ '401':
25329
+ $ref: '#/components/responses/401'
25330
+ '403':
25331
+ $ref: '#/components/responses/403'
25332
+ '404':
25333
+ $ref: '#/components/responses/404'
25334
+ /api/v1/environments/{environmentName}/engineNetworkModes/supported:
25335
+ get:
25336
+ tags:
25337
+ - engine
25338
+ operationId: getEngineNetworkModeSupported
25339
+ summary: Get supported network modes for engine+mode from engineOption config
25340
+ parameters:
25341
+ - name: environmentName
25342
+ in: path
25343
+ description: environment name
25344
+ required: true
25345
+ schema:
25346
+ type: string
25347
+ - name: engineName
25348
+ in: query
25349
+ description: engine name
25350
+ required: true
25351
+ schema:
25352
+ type: string
25353
+ - name: mode
25354
+ in: query
25355
+ description: engine mode
25356
+ required: true
25357
+ schema:
25358
+ type: string
25359
+ responses:
25360
+ '200':
25361
+ description: A successful response.
25362
+ content:
25363
+ application/json:
25364
+ schema:
25365
+ $ref: '#/components/schemas/engineNetworkModeSupported'
25366
+ '401':
25367
+ $ref: '#/components/responses/401'
25368
+ '403':
25369
+ $ref: '#/components/responses/403'
25370
+ '404':
25371
+ $ref: '#/components/responses/404'
25372
+ /api/v1/organizations/{orgName}/blueGreenDeployment/{deploymentID}:
25373
+ get:
25374
+ operationId: getBlueGreenDeployment
25375
+ summary: Get a blue-green deployment instance
25376
+ description: Retrieve details for a single blue-green deployment instance by parent cluster and organization.
25377
+ parameters:
25378
+ - description: The unique identifier of the blue-green deployment instance
25379
+ in: path
25380
+ name: deploymentID
25381
+ required: true
25382
+ schema:
25383
+ type: string
25384
+ - description: Name of the organization
25385
+ in: path
25386
+ name: orgName
25387
+ required: true
25388
+ schema:
25389
+ type: string
25390
+ responses:
25391
+ '200':
25392
+ content:
25393
+ application/json:
25394
+ schema:
25395
+ $ref: '#/components/schemas/blueGreenDeploymentItem'
25396
+ description: Details of the blue-green deployment instance.
25397
+ '401':
25398
+ $ref: '#/components/responses/401'
25399
+ '403':
25400
+ $ref: '#/components/responses/403'
25401
+ '404':
25402
+ $ref: '#/components/responses/404'
25403
+ '501':
25404
+ $ref: '#/components/responses/501'
25405
+ tags:
25406
+ - blueGreenDeployment
25407
+ delete:
25408
+ operationId: deleteBlueGreenDeployment
25409
+ summary: Delete a blue-green deployment instance
25410
+ description: Delete a specified blue-green deployment instance.
25411
+ parameters:
25412
+ - description: The unique identifier of the blue-green deployment instance
25413
+ in: path
25414
+ name: deploymentID
25415
+ required: true
25416
+ schema:
25417
+ type: string
25418
+ - description: Name of the organization
25419
+ in: path
25420
+ name: orgName
25421
+ required: true
25422
+ schema:
25423
+ type: string
25424
+ responses:
25425
+ '200':
25426
+ content:
25427
+ application/json:
25428
+ schema:
25429
+ $ref: '#/components/schemas/blueGreenDeploymentTask'
25430
+ description: Async job task information for blue-green deployment instance deletion.
25431
+ '401':
25432
+ $ref: '#/components/responses/401'
25433
+ '403':
25434
+ $ref: '#/components/responses/403'
25435
+ '404':
25436
+ $ref: '#/components/responses/404'
25437
+ '501':
25438
+ $ref: '#/components/responses/501'
25439
+ tags:
25440
+ - blueGreenDeployment
25441
+ /api/v1/organizations/{orgName}/parent/{parentClusterID}/blueGreenDeployment:
25442
+ get:
25443
+ operationId: listBlueGreenDeployments
25444
+ summary: List blue-green deployment instances for the specified parent cluster
25445
+ description: Retrieve a list of blue-green deployment instances associated with the given parent database cluster.
25446
+ parameters:
25447
+ - description: The unique identifier of the parent database cluster
25448
+ in: path
25449
+ name: parentClusterID
25450
+ required: true
25451
+ schema:
25452
+ type: string
25453
+ - description: Name of the organization
25454
+ in: path
25455
+ name: orgName
25456
+ required: true
25457
+ schema:
25458
+ type: string
25459
+ responses:
25460
+ '200':
25461
+ content:
25462
+ application/json:
25463
+ schema:
25464
+ $ref: '#/components/schemas/blueGreenDeploymentItemList'
25465
+ description: A list of blue-green deployment instances.
25466
+ '401':
25467
+ $ref: '#/components/responses/401'
25468
+ '403':
25469
+ $ref: '#/components/responses/403'
25470
+ '404':
25471
+ $ref: '#/components/responses/404'
25472
+ '501':
25473
+ $ref: '#/components/responses/501'
25474
+ tags:
25475
+ - blueGreenDeployment
25476
+ post:
25477
+ operationId: createBlueGreenDeployment
25478
+ summary: Create a new blue-green deployment instance
25479
+ description: Create a blue-green deployment instance for the specified parent cluster.
25480
+ parameters:
25481
+ - description: The unique identifier of the parent database cluster
25482
+ in: path
25483
+ name: parentClusterID
25484
+ required: true
25485
+ schema:
25486
+ type: string
25487
+ - description: Name of the organization
25488
+ in: path
25489
+ name: orgName
25490
+ required: true
25491
+ schema:
25492
+ type: string
25493
+ requestBody:
25494
+ content:
25495
+ application/json:
25496
+ schema:
25497
+ $ref: '#/components/schemas/blueGreenDeploymentCreation'
25498
+ required: true
25499
+ responses:
25500
+ '204':
25501
+ content: {}
25502
+ description: Returned when blue-green deployment instance is created successfully.
25503
+ '401':
25504
+ $ref: '#/components/responses/401'
25505
+ '403':
25506
+ $ref: '#/components/responses/403'
25507
+ '404':
25508
+ $ref: '#/components/responses/404'
25509
+ '501':
25510
+ $ref: '#/components/responses/501'
25511
+ tags:
25512
+ - blueGreenDeployment
25513
+ x-codegen-request-body-name: body
25514
+ /api/v1/organizations/{orgName}/blueGreenDeployment/{deploymentID}/switch:
25515
+ post:
25516
+ operationId: switchBlueGreenDeployment
25517
+ summary: Switch roles of blue-green deployment instances
25518
+ description: Switch the specified blue-green deployment cluster to act as the primary instance.
25519
+ parameters:
25520
+ - description: The unique identifier of the blue-green deployment cluster
25521
+ in: path
25522
+ name: deploymentID
25523
+ required: true
25524
+ schema:
25525
+ type: string
25526
+ - description: Name of the organization
25527
+ in: path
25528
+ name: orgName
25529
+ required: true
25530
+ schema:
25531
+ type: string
25532
+ responses:
25533
+ '200':
25534
+ content:
25535
+ application/json:
25536
+ schema:
25537
+ $ref: '#/components/schemas/blueGreenDeploymentSwitchResponse'
25538
+ description: Async job task information for the blue-green deployment switch operation.
25539
+ '401':
25540
+ $ref: '#/components/responses/401'
25541
+ '403':
25542
+ $ref: '#/components/responses/403'
25543
+ '404':
25544
+ $ref: '#/components/responses/404'
25545
+ '501':
25546
+ $ref: '#/components/responses/501'
25547
+ tags:
25548
+ - blueGreenDeployment
25549
+ x-codegen-request-body-name: body
25550
+ get:
25551
+ operationId: getBlueGreenDeploymentSwitchDetail
25552
+ summary: Get blue-green deployment switch job detail
25553
+ description: Retrieve detailed information about the switch-over operation for a blue-green deployment cluster.
25554
+ parameters:
25555
+ - description: The unique identifier of the blue-green deployment instance
25556
+ in: path
25557
+ name: deploymentID
25558
+ required: true
25559
+ schema:
25560
+ type: string
25561
+ - description: Name of the organization
25562
+ in: path
25563
+ name: orgName
25564
+ required: true
25565
+ schema:
25566
+ type: string
25567
+ responses:
25568
+ '200':
25569
+ content:
25570
+ application/json:
25571
+ schema:
25572
+ $ref: '#/components/schemas/blueGreenDeploymentSwitchResponse'
25573
+ description: Details of the blue-green deployment switch job/task.
25574
+ '401':
25575
+ $ref: '#/components/responses/401'
25576
+ '403':
25577
+ $ref: '#/components/responses/403'
25578
+ '404':
25579
+ $ref: '#/components/responses/404'
25580
+ '501':
25581
+ $ref: '#/components/responses/501'
25582
+ tags:
25583
+ - blueGreenDeployment
25584
+ /api/v1/organizations/{orgName}/parent/{parentClusterID}/blueGreenDeployment/precheck:
25585
+ post:
25586
+ operationId: createBlueGreenDeploymentPreCheck
25587
+ summary: Run a precheck for blue-green deployment
25588
+ description: Trigger a precheck task to verify settings or readiness for blue-green deployment.
25589
+ parameters:
25590
+ - description: Name of the organization
25591
+ in: path
25592
+ name: orgName
25593
+ required: true
25594
+ schema:
25595
+ type: string
25596
+ - description: The unique identifier of the parent database cluster
25597
+ in: path
25598
+ name: parentClusterID
25599
+ required: true
25600
+ schema:
25601
+ type: string
25602
+ - description: The version of the green cluster
25603
+ in: query
25604
+ name: greenClusterVersion
25605
+ required: true
25606
+ schema:
25607
+ type: string
25608
+ responses:
25609
+ '200':
25610
+ content:
25611
+ application/json:
25612
+ schema:
25613
+ $ref: '#/components/schemas/blueGreenDeploymentPreCheckResponse'
25614
+ description: Precheck task creation response.
25615
+ '401':
25616
+ $ref: '#/components/responses/401'
25617
+ '403':
25618
+ $ref: '#/components/responses/403'
25619
+ '404':
25620
+ $ref: '#/components/responses/404'
25621
+ '501':
25622
+ $ref: '#/components/responses/501'
25623
+ tags:
25624
+ - blueGreenDeployment
25625
+ x-codegen-request-body-name: body
25626
+ /api/v1/organizations/{orgName}/blueGreenDeployment/precheck/{preCheckID}:
25627
+ get:
25628
+ operationId: getBlueGreenDeploymentPreCheckDetail
25629
+ summary: Get blue-green deployment precheck task detail
25630
+ description: Retrieve the details of a precheck task for a blue-green deployment.
25631
+ parameters:
25632
+ - description: The unique identifier of the precheck task
25633
+ in: path
25634
+ name: preCheckID
25468
25635
  required: true
25469
25636
  schema:
25470
25637
  type: string
@@ -39238,9 +39405,12 @@ components:
39238
39405
  totalNumKeys:
39239
39406
  type: integer
39240
39407
  format: int64
39408
+ x-omitempty: false
39241
39409
  description: Sum of counts across all byteLevelStat buckets.
39242
- totlSizeKeys:
39243
- type: string
39410
+ totalSizeKeys:
39411
+ type: integer
39412
+ format: int64
39413
+ x-omitempty: false
39244
39414
  description: Sum of bytes across all byteLevelStat buckets.
39245
39415
  expireStat:
39246
39416
  type: object
@@ -44319,202 +44489,513 @@ components:
44319
44489
  enum:
44320
44490
  - custom
44321
44491
  - kubeblocks
44492
+ - definition
44322
44493
  type: string
44323
44494
  authType:
44324
44495
  enum:
44325
- - basic
44496
+ - basic
44497
+ type: string
44498
+ basicAuthModel:
44499
+ type: object
44500
+ properties:
44501
+ userName:
44502
+ type: string
44503
+ password:
44504
+ type: string
44505
+ description: if password is not provided when patch replication channel, it means not to modify the password
44506
+ nullable: true
44507
+ customEndpoint:
44508
+ type: object
44509
+ properties:
44510
+ connectionString:
44511
+ description: display connection string information, including connection details such as url, database, etc
44512
+ type: string
44513
+ connection:
44514
+ type: string
44515
+ authType:
44516
+ $ref: '#/components/schemas/authType'
44517
+ basicAuth:
44518
+ $ref: '#/components/schemas/basicAuthModel'
44519
+ nullable: true
44520
+ kubeblocksEndpoint:
44521
+ type: object
44522
+ properties:
44523
+ environmentID:
44524
+ type: string
44525
+ environmentName:
44526
+ type: string
44527
+ clusterID:
44528
+ type: string
44529
+ clusterName:
44530
+ type: string
44531
+ displayName:
44532
+ type: string
44533
+ nullable: true
44534
+ definitionEndpoint:
44535
+ type: object
44536
+ description: Reference to an existing data endpoint in the same organization.
44537
+ required:
44538
+ - endpointID
44539
+ properties:
44540
+ endpointID:
44541
+ type: string
44542
+ minLength: 1
44543
+ dataChannelListEndpoint:
44544
+ type: object
44545
+ properties:
44546
+ id:
44547
+ type: string
44548
+ nullable: true
44549
+ name:
44550
+ type: string
44551
+ nullable: true
44552
+ engineName:
44553
+ type: string
44554
+ endpointType:
44555
+ $ref: '#/components/schemas/dataReplicationEndpointType'
44556
+ custom:
44557
+ $ref: '#/components/schemas/customEndpoint'
44558
+ nullable: true
44559
+ kubeblocks:
44560
+ $ref: '#/components/schemas/kubeblocksEndpoint'
44561
+ nullable: true
44562
+ definition:
44563
+ $ref: '#/components/schemas/definitionEndpoint'
44564
+ nullable: true
44565
+ description:
44566
+ type: string
44567
+ nullable: true
44568
+ extraCfgs:
44569
+ type: object
44570
+ additionalProperties:
44571
+ type: string
44572
+ nullable: true
44573
+ dataChannelObject:
44574
+ type: object
44575
+ properties:
44576
+ includeObjects:
44577
+ type: array
44578
+ items:
44579
+ type: string
44580
+ excludeObjects:
44581
+ type: array
44582
+ items:
44583
+ type: string
44584
+ nullable: true
44585
+ dataChannelItem:
44586
+ type: object
44587
+ properties:
44588
+ channelID:
44589
+ type: string
44590
+ channelName:
44591
+ type: string
44592
+ orgName:
44593
+ type: string
44594
+ channelStatus:
44595
+ $ref: '#/components/schemas/channelStatus'
44596
+ environmentID:
44597
+ type: string
44598
+ environmentName:
44599
+ type: string
44600
+ project:
44601
+ type: string
44602
+ kubernetesName:
44603
+ type: string
44604
+ standardDefinition:
44605
+ type: string
44606
+ source:
44607
+ $ref: '#/components/schemas/dataChannelListEndpoint'
44608
+ target:
44609
+ $ref: '#/components/schemas/dataChannelListEndpoint'
44610
+ replicationObjects:
44611
+ $ref: '#/components/schemas/dataChannelObject'
44612
+ modules:
44613
+ type: array
44614
+ items:
44615
+ type: string
44616
+ events:
44617
+ type: array
44618
+ items:
44619
+ $ref: '#/components/schemas/eventObject'
44620
+ createdAt:
44621
+ type: string
44622
+ format: date-time
44623
+ FinishedAt:
44624
+ type: string
44625
+ format: date-time
44626
+ nullable: true
44627
+ dataChannelList:
44628
+ type: array
44629
+ items:
44630
+ $ref: '#/components/schemas/dataChannelItem'
44631
+ customEndpointCreate:
44632
+ type: object
44633
+ properties:
44634
+ connection:
44635
+ type: string
44636
+ authType:
44637
+ $ref: '#/components/schemas/authType'
44638
+ basicAuth:
44639
+ $ref: '#/components/schemas/basicAuthModel'
44640
+ nullable: true
44641
+ dataChannelEndpointCreate:
44642
+ type: object
44643
+ description: Use endpointType custom or kubeblocks with the corresponding inline connection configuration, or endpointType definition with definition.endpointID to reuse an existing data endpoint. Inline connection configuration is not used for endpointType definition.
44644
+ properties:
44645
+ name:
44646
+ type: string
44647
+ nullable: true
44648
+ engineName:
44649
+ type: string
44650
+ definitionName:
44651
+ type: string
44652
+ endpointType:
44653
+ $ref: '#/components/schemas/dataReplicationEndpointType'
44654
+ custom:
44655
+ $ref: '#/components/schemas/customEndpointCreate'
44656
+ nullable: true
44657
+ kubeblocks:
44658
+ $ref: '#/components/schemas/kubeblocksEndpoint'
44659
+ nullable: true
44660
+ definition:
44661
+ $ref: '#/components/schemas/definitionEndpoint'
44662
+ nullable: true
44663
+ description:
44664
+ type: string
44665
+ nullable: true
44666
+ extraCfgs:
44667
+ type: object
44668
+ additionalProperties:
44669
+ type: string
44670
+ nullable: true
44671
+ dataChannelParameterKeyValue:
44672
+ type: object
44673
+ properties:
44674
+ key:
44675
+ type: string
44676
+ value:
44677
+ type: string
44678
+ required:
44679
+ - key
44680
+ - value
44681
+ dataReplicationCreate:
44682
+ type: object
44683
+ properties:
44684
+ channelName:
44685
+ type: string
44686
+ modules:
44687
+ type: array
44688
+ items:
44689
+ type: string
44690
+ environmentID:
44691
+ type: string
44692
+ project:
44693
+ type: string
44694
+ default: kubeblocks-cloud-ns
44695
+ standardDefinition:
44696
+ type: string
44697
+ source:
44698
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
44699
+ target:
44700
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
44701
+ replicationObjects:
44702
+ $ref: '#/components/schemas/dataChannelObject'
44703
+ events:
44704
+ type: array
44705
+ items:
44706
+ $ref: '#/components/schemas/eventObject'
44707
+ parameters:
44708
+ type: object
44709
+ additionalProperties:
44710
+ type: array
44711
+ items:
44712
+ $ref: '#/components/schemas/dataChannelParameterKeyValue'
44713
+ nullable: true
44714
+ dataChannelResponse:
44715
+ type: object
44716
+ properties:
44717
+ channelID:
44718
+ type: string
44719
+ channelName:
44720
+ type: string
44721
+ createdAt:
44722
+ type: string
44723
+ format: date-time
44724
+ updatedAt:
44725
+ type: string
44726
+ format: date-time
44727
+ nullable: true
44728
+ dataChannelModuleProgress:
44729
+ type: object
44730
+ properties:
44731
+ moduleName:
44732
+ type: string
44733
+ kubernetesName:
44734
+ type: string
44735
+ nullable: true
44736
+ progress:
44737
+ type: number
44738
+ format: double
44739
+ nullable: true
44740
+ status:
44741
+ type: string
44742
+ message:
44743
+ type: string
44744
+ nullable: true
44745
+ dataChannelProgress:
44746
+ type: object
44747
+ properties:
44748
+ progress:
44749
+ type: number
44750
+ format: double
44751
+ nullable: true
44752
+ moduleProgress:
44753
+ type: array
44754
+ items:
44755
+ $ref: '#/components/schemas/dataChannelModuleProgress'
44756
+ dataChannelDetail:
44757
+ type: object
44758
+ properties:
44759
+ channel:
44760
+ $ref: '#/components/schemas/dataChannelItem'
44761
+ progress:
44762
+ $ref: '#/components/schemas/dataChannelProgress'
44763
+ dataReplicationUpdate:
44764
+ type: object
44765
+ properties:
44766
+ clusterUpdates:
44767
+ $ref: '#/components/schemas/dataReplicationCreate'
44768
+ isRestart:
44769
+ type: boolean
44770
+ nullable: true
44771
+ dataReplicationOpsType:
44772
+ description: data replication ops type
44773
+ enum:
44774
+ - pause
44775
+ - resume
44776
+ - restart
44326
44777
  type: string
44327
- basicAuthModel:
44778
+ eventItem:
44328
44779
  type: object
44329
44780
  properties:
44330
- userName:
44781
+ eventID:
44331
44782
  type: string
44332
- password:
44783
+ eventName:
44333
44784
  type: string
44334
- description: if password is not provided when patch replication channel, it means not to modify the password
44335
- nullable: true
44336
- customEndpoint:
44337
- type: object
44338
- properties:
44339
- connectionString:
44340
- description: display connection string information, including connection details such as url, database, etc
44785
+ eventTime:
44341
44786
  type: string
44342
- connection:
44787
+ format: date-time
44788
+ eventMessage:
44789
+ type: string
44790
+ operator:
44791
+ type: string
44792
+ operatorID:
44343
44793
  type: string
44344
- authType:
44345
- $ref: '#/components/schemas/authType'
44346
- basicAuth:
44347
- $ref: '#/components/schemas/basicAuthModel'
44348
44794
  nullable: true
44349
- kubeblocksEndpoint:
44795
+ dataReplicationEventList:
44796
+ type: array
44797
+ items:
44798
+ $ref: '#/components/schemas/eventItem'
44799
+ replicationObjectQuery:
44350
44800
  type: object
44351
44801
  properties:
44352
- environmentID:
44802
+ sourceEngineDefinition:
44353
44803
  type: string
44354
- environmentName:
44804
+ targetEngineDefinition:
44355
44805
  type: string
44356
- clusterID:
44806
+ endpoint:
44807
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
44808
+ nodeType:
44357
44809
  type: string
44358
- clusterName:
44810
+ nullable: true
44811
+ nodeValue:
44359
44812
  type: string
44360
- displayName:
44813
+ nullable: true
44814
+ queryNodeType:
44361
44815
  type: string
44362
44816
  nullable: true
44363
- dataChannelListEndpoint:
44817
+ replicationObjectNode:
44364
44818
  type: object
44365
44819
  properties:
44366
- engineName:
44820
+ nodeName:
44367
44821
  type: string
44368
- endpointType:
44369
- $ref: '#/components/schemas/dataReplicationEndpointType'
44370
- custom:
44371
- $ref: '#/components/schemas/customEndpoint'
44372
- nullable: true
44373
- kubeblocks:
44374
- $ref: '#/components/schemas/kubeblocksEndpoint'
44375
- nullable: true
44376
- extraCfgs:
44377
- type: object
44378
- additionalProperties:
44379
- type: string
44380
- nullable: true
44381
- dataChannelObject:
44822
+ nodeValue:
44823
+ type: string
44824
+ replicationObjectTree:
44382
44825
  type: object
44383
44826
  properties:
44384
- includeObjects:
44827
+ nodeType:
44828
+ type: string
44829
+ nodeValues:
44830
+ type: array
44831
+ items:
44832
+ $ref: '#/components/schemas/replicationObjectNode'
44833
+ childrenNodeTypes:
44385
44834
  type: array
44835
+ nullable: true
44386
44836
  items:
44387
44837
  type: string
44388
- excludeObjects:
44838
+ preCheckCreate:
44839
+ type: object
44840
+ properties:
44841
+ modules:
44389
44842
  type: array
44390
44843
  items:
44391
44844
  type: string
44392
- nullable: true
44393
- dataChannelItem:
44845
+ environmentID:
44846
+ type: string
44847
+ source:
44848
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
44849
+ target:
44850
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
44851
+ replicationObjects:
44852
+ $ref: '#/components/schemas/dataChannelObject'
44853
+ preCheckTaskResponse:
44394
44854
  type: object
44395
44855
  properties:
44396
- channelID:
44856
+ taskId:
44397
44857
  type: string
44398
- channelName:
44858
+ preCheckStatus:
44859
+ enum:
44860
+ - Pending
44861
+ - Running
44862
+ - Succeed
44863
+ - Failed
44864
+ type: string
44865
+ preCheckTaskItem:
44866
+ type: object
44867
+ properties:
44868
+ checkerName:
44399
44869
  type: string
44400
- orgName:
44870
+ checkerDesc:
44401
44871
  type: string
44402
- channelStatus:
44403
- $ref: '#/components/schemas/channelStatus'
44404
- environmentID:
44872
+ message:
44405
44873
  type: string
44406
- environmentName:
44874
+ nullable: true
44875
+ status:
44876
+ $ref: '#/components/schemas/preCheckStatus'
44877
+ preCheckResult:
44878
+ type: object
44879
+ properties:
44880
+ name:
44407
44881
  type: string
44408
- project:
44882
+ checkerName:
44409
44883
  type: string
44410
- kubernetesName:
44884
+ message:
44411
44885
  type: string
44412
- standardDefinition:
44886
+ nullable: true
44887
+ advice:
44413
44888
  type: string
44414
- source:
44415
- $ref: '#/components/schemas/dataChannelListEndpoint'
44416
- target:
44417
- $ref: '#/components/schemas/dataChannelListEndpoint'
44418
- replicationObjects:
44419
- $ref: '#/components/schemas/dataChannelObject'
44420
- modules:
44889
+ nullable: true
44890
+ preCheckTaskDetail:
44891
+ type: object
44892
+ properties:
44893
+ taskID:
44894
+ type: string
44895
+ taskStatus:
44896
+ $ref: '#/components/schemas/preCheckStatus'
44897
+ progress:
44898
+ type: integer
44899
+ format: int32
44900
+ nullable: true
44901
+ checkers:
44421
44902
  type: array
44422
44903
  items:
44423
- type: string
44424
- events:
44904
+ $ref: '#/components/schemas/preCheckTaskItem'
44905
+ errors:
44425
44906
  type: array
44426
44907
  items:
44427
- $ref: '#/components/schemas/eventObject'
44908
+ $ref: '#/components/schemas/preCheckResult'
44909
+ nullable: true
44910
+ warnings:
44911
+ type: array
44912
+ items:
44913
+ $ref: '#/components/schemas/preCheckResult'
44914
+ nullable: true
44428
44915
  createdAt:
44429
44916
  type: string
44430
44917
  format: date-time
44431
- FinishedAt:
44918
+ completedAt:
44432
44919
  type: string
44433
44920
  format: date-time
44434
44921
  nullable: true
44435
- dataChannelList:
44436
- type: array
44437
- items:
44438
- $ref: '#/components/schemas/dataChannelItem'
44439
- customEndpointCreate:
44922
+ dataReplicationChannelContainer:
44440
44923
  type: object
44441
44924
  properties:
44442
- connection:
44925
+ name:
44443
44926
  type: string
44444
- authType:
44445
- $ref: '#/components/schemas/authType'
44446
- basicAuth:
44447
- $ref: '#/components/schemas/basicAuthModel'
44448
- nullable: true
44449
- dataChannelEndpointCreate:
44927
+ isMainContainer:
44928
+ type: boolean
44929
+ default: false
44930
+ isInitContainer:
44931
+ type: boolean
44932
+ default: false
44933
+ dataReplicationParametersResponseDetail:
44450
44934
  type: object
44451
44935
  properties:
44452
- engineName:
44453
- type: string
44454
- definitionName:
44936
+ displayName:
44455
44937
  type: string
44456
- endpointType:
44457
- $ref: '#/components/schemas/dataReplicationEndpointType'
44458
- custom:
44459
- $ref: '#/components/schemas/customEndpointCreate'
44460
- nullable: true
44461
- kubeblocks:
44462
- $ref: '#/components/schemas/kubeblocksEndpoint'
44463
- nullable: true
44464
- extraCfgs:
44465
- type: object
44466
- additionalProperties:
44467
- type: string
44468
- nullable: true
44469
- dataChannelParameterKeyValue:
44470
- type: object
44471
- properties:
44938
+ desc:
44939
+ $ref: '#/components/schemas/internationalDesc'
44472
44940
  key:
44473
44941
  type: string
44942
+ defaultValue:
44943
+ type: string
44474
44944
  value:
44475
44945
  type: string
44946
+ valueType:
44947
+ $ref: '#/components/schemas/parameterValueType'
44476
44948
  required:
44477
44949
  - key
44478
- - value
44479
- dataReplicationCreate:
44950
+ dataReplicationParametersResponse:
44951
+ type: object
44952
+ description: the parameters of the data channel, the key is the module name, the value is the parameter template
44953
+ additionalProperties:
44954
+ type: array
44955
+ items:
44956
+ $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
44957
+ dataEndpointList:
44958
+ type: array
44959
+ items:
44960
+ $ref: '#/components/schemas/dataChannelListEndpoint'
44961
+ dataEndpointTypeCreation:
44962
+ enum:
44963
+ - custom
44964
+ - kubeblocks
44965
+ type: string
44966
+ dataEndpointCreate:
44480
44967
  type: object
44968
+ description: Connection configuration for an independently managed data endpoint.
44481
44969
  properties:
44482
- channelName:
44970
+ name:
44483
44971
  type: string
44484
- modules:
44485
- type: array
44486
- items:
44487
- type: string
44488
- environmentID:
44972
+ nullable: true
44973
+ engineName:
44489
44974
  type: string
44490
- project:
44975
+ definitionName:
44491
44976
  type: string
44492
- default: kubeblocks-cloud-ns
44493
- standardDefinition:
44977
+ endpointType:
44978
+ $ref: '#/components/schemas/dataEndpointTypeCreation'
44979
+ custom:
44980
+ $ref: '#/components/schemas/customEndpointCreate'
44981
+ nullable: true
44982
+ kubeblocks:
44983
+ $ref: '#/components/schemas/kubeblocksEndpoint'
44984
+ nullable: true
44985
+ description:
44494
44986
  type: string
44495
- source:
44496
- $ref: '#/components/schemas/dataChannelEndpointCreate'
44497
- target:
44498
- $ref: '#/components/schemas/dataChannelEndpointCreate'
44499
- replicationObjects:
44500
- $ref: '#/components/schemas/dataChannelObject'
44501
- events:
44502
- type: array
44503
- items:
44504
- $ref: '#/components/schemas/eventObject'
44505
- parameters:
44987
+ nullable: true
44988
+ extraCfgs:
44506
44989
  type: object
44507
44990
  additionalProperties:
44508
- type: array
44509
- items:
44510
- $ref: '#/components/schemas/dataChannelParameterKeyValue'
44991
+ type: string
44511
44992
  nullable: true
44512
- dataChannelResponse:
44993
+ dataEndpointResponse:
44513
44994
  type: object
44514
44995
  properties:
44515
- channelID:
44996
+ endpointID:
44516
44997
  type: string
44517
- channelName:
44998
+ endpointName:
44518
44999
  type: string
44519
45000
  createdAt:
44520
45001
  type: string
@@ -44523,49 +45004,6 @@ components:
44523
45004
  type: string
44524
45005
  format: date-time
44525
45006
  nullable: true
44526
- dataChannelModuleProgress:
44527
- type: object
44528
- properties:
44529
- moduleName:
44530
- type: string
44531
- kubernetesName:
44532
- type: string
44533
- nullable: true
44534
- progress:
44535
- type: number
44536
- format: double
44537
- nullable: true
44538
- status:
44539
- type: string
44540
- message:
44541
- type: string
44542
- nullable: true
44543
- dataChannelProgress:
44544
- type: object
44545
- properties:
44546
- progress:
44547
- type: number
44548
- format: double
44549
- nullable: true
44550
- moduleProgress:
44551
- type: array
44552
- items:
44553
- $ref: '#/components/schemas/dataChannelModuleProgress'
44554
- dataChannelDetail:
44555
- type: object
44556
- properties:
44557
- channel:
44558
- $ref: '#/components/schemas/dataChannelItem'
44559
- progress:
44560
- $ref: '#/components/schemas/dataChannelProgress'
44561
- dataReplicationUpdate:
44562
- type: object
44563
- properties:
44564
- clusterUpdates:
44565
- $ref: '#/components/schemas/dataReplicationCreate'
44566
- isRestart:
44567
- type: boolean
44568
- nullable: true
44569
45007
  dataCheckType:
44570
45008
  type: string
44571
45009
  description: Type of check to run. A standalone check runs exactly one type.
@@ -44839,192 +45277,6 @@ components:
44839
45277
  $ref: '#/components/schemas/dataCheckDetailItem'
44840
45278
  pagination:
44841
45279
  $ref: '#/components/schemas/paginationResult'
44842
- dataReplicationOpsType:
44843
- description: data replication ops type
44844
- enum:
44845
- - pause
44846
- - resume
44847
- - restart
44848
- type: string
44849
- eventItem:
44850
- type: object
44851
- properties:
44852
- eventID:
44853
- type: string
44854
- eventName:
44855
- type: string
44856
- eventTime:
44857
- type: string
44858
- format: date-time
44859
- eventMessage:
44860
- type: string
44861
- operator:
44862
- type: string
44863
- operatorID:
44864
- type: string
44865
- nullable: true
44866
- dataReplicationEventList:
44867
- type: array
44868
- items:
44869
- $ref: '#/components/schemas/eventItem'
44870
- replicationObjectQuery:
44871
- type: object
44872
- properties:
44873
- sourceEngineDefinition:
44874
- type: string
44875
- targetEngineDefinition:
44876
- type: string
44877
- endpoint:
44878
- $ref: '#/components/schemas/dataChannelEndpointCreate'
44879
- nodeType:
44880
- type: string
44881
- nullable: true
44882
- nodeValue:
44883
- type: string
44884
- nullable: true
44885
- queryNodeType:
44886
- type: string
44887
- nullable: true
44888
- replicationObjectNode:
44889
- type: object
44890
- properties:
44891
- nodeName:
44892
- type: string
44893
- nodeValue:
44894
- type: string
44895
- replicationObjectTree:
44896
- type: object
44897
- properties:
44898
- nodeType:
44899
- type: string
44900
- nodeValues:
44901
- type: array
44902
- items:
44903
- $ref: '#/components/schemas/replicationObjectNode'
44904
- childrenNodeTypes:
44905
- type: array
44906
- nullable: true
44907
- items:
44908
- type: string
44909
- preCheckCreate:
44910
- type: object
44911
- properties:
44912
- modules:
44913
- type: array
44914
- items:
44915
- type: string
44916
- environmentID:
44917
- type: string
44918
- source:
44919
- $ref: '#/components/schemas/dataChannelEndpointCreate'
44920
- target:
44921
- $ref: '#/components/schemas/dataChannelEndpointCreate'
44922
- replicationObjects:
44923
- $ref: '#/components/schemas/dataChannelObject'
44924
- preCheckTaskResponse:
44925
- type: object
44926
- properties:
44927
- taskId:
44928
- type: string
44929
- preCheckStatus:
44930
- enum:
44931
- - Pending
44932
- - Running
44933
- - Succeed
44934
- - Failed
44935
- type: string
44936
- preCheckTaskItem:
44937
- type: object
44938
- properties:
44939
- checkerName:
44940
- type: string
44941
- checkerDesc:
44942
- type: string
44943
- message:
44944
- type: string
44945
- nullable: true
44946
- status:
44947
- $ref: '#/components/schemas/preCheckStatus'
44948
- preCheckResult:
44949
- type: object
44950
- properties:
44951
- name:
44952
- type: string
44953
- checkerName:
44954
- type: string
44955
- message:
44956
- type: string
44957
- nullable: true
44958
- advice:
44959
- type: string
44960
- nullable: true
44961
- preCheckTaskDetail:
44962
- type: object
44963
- properties:
44964
- taskID:
44965
- type: string
44966
- taskStatus:
44967
- $ref: '#/components/schemas/preCheckStatus'
44968
- progress:
44969
- type: integer
44970
- format: int32
44971
- nullable: true
44972
- checkers:
44973
- type: array
44974
- items:
44975
- $ref: '#/components/schemas/preCheckTaskItem'
44976
- errors:
44977
- type: array
44978
- items:
44979
- $ref: '#/components/schemas/preCheckResult'
44980
- nullable: true
44981
- warnings:
44982
- type: array
44983
- items:
44984
- $ref: '#/components/schemas/preCheckResult'
44985
- nullable: true
44986
- createdAt:
44987
- type: string
44988
- format: date-time
44989
- completedAt:
44990
- type: string
44991
- format: date-time
44992
- nullable: true
44993
- dataReplicationChannelContainer:
44994
- type: object
44995
- properties:
44996
- name:
44997
- type: string
44998
- isMainContainer:
44999
- type: boolean
45000
- default: false
45001
- isInitContainer:
45002
- type: boolean
45003
- default: false
45004
- dataReplicationParametersResponseDetail:
45005
- type: object
45006
- properties:
45007
- displayName:
45008
- type: string
45009
- desc:
45010
- $ref: '#/components/schemas/internationalDesc'
45011
- key:
45012
- type: string
45013
- defaultValue:
45014
- type: string
45015
- value:
45016
- type: string
45017
- valueType:
45018
- $ref: '#/components/schemas/parameterValueType'
45019
- required:
45020
- - key
45021
- dataReplicationParametersResponse:
45022
- type: object
45023
- description: the parameters of the data channel, the key is the module name, the value is the parameter template
45024
- additionalProperties:
45025
- type: array
45026
- items:
45027
- $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
45028
45280
  ImportPreflightRequest:
45029
45281
  description: Data source preflight request
45030
45282
  type: object