kb-cloud-client-typescript 2.4.0-alpha.46 → 2.4.0-alpha.47

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 (115) hide show
  1. package/dist/adminapi/api.d.ts +1 -0
  2. package/dist/adminapi/api.d.ts.map +1 -1
  3. package/dist/adminapi/api.js +1 -0
  4. package/dist/adminapi/api.js.map +1 -1
  5. package/dist/adminapi/apis/diagnostics-api.d.ts +229 -0
  6. package/dist/adminapi/apis/diagnostics-api.d.ts.map +1 -1
  7. package/dist/adminapi/apis/diagnostics-api.js +247 -0
  8. package/dist/adminapi/apis/diagnostics-api.js.map +1 -1
  9. package/dist/adminapi/apis/oracle-api.d.ts +422 -0
  10. package/dist/adminapi/apis/oracle-api.d.ts.map +1 -0
  11. package/dist/adminapi/apis/oracle-api.js +471 -0
  12. package/dist/adminapi/apis/oracle-api.js.map +1 -0
  13. package/dist/adminapi/models/index.d.ts +7 -0
  14. package/dist/adminapi/models/index.d.ts.map +1 -1
  15. package/dist/adminapi/models/index.js +7 -0
  16. package/dist/adminapi/models/index.js.map +1 -1
  17. package/dist/adminapi/models/oracle-tablespace-contents.d.ts +22 -0
  18. package/dist/adminapi/models/oracle-tablespace-contents.d.ts.map +1 -0
  19. package/dist/adminapi/models/oracle-tablespace-contents.js +26 -0
  20. package/dist/adminapi/models/oracle-tablespace-contents.js.map +1 -0
  21. package/dist/adminapi/models/oracle-tablespace-create.d.ts +45 -0
  22. package/dist/adminapi/models/oracle-tablespace-create.d.ts.map +1 -0
  23. package/dist/adminapi/models/oracle-tablespace-create.js +16 -0
  24. package/dist/adminapi/models/oracle-tablespace-create.js.map +1 -0
  25. package/dist/adminapi/models/oracle-tablespace-expand-action.d.ts +22 -0
  26. package/dist/adminapi/models/oracle-tablespace-expand-action.d.ts.map +1 -0
  27. package/dist/adminapi/models/oracle-tablespace-expand-action.js +26 -0
  28. package/dist/adminapi/models/oracle-tablespace-expand-action.js.map +1 -0
  29. package/dist/adminapi/models/oracle-tablespace-expand.d.ts +45 -0
  30. package/dist/adminapi/models/oracle-tablespace-expand.d.ts.map +1 -0
  31. package/dist/adminapi/models/oracle-tablespace-expand.js +16 -0
  32. package/dist/adminapi/models/oracle-tablespace-expand.js.map +1 -0
  33. package/dist/adminapi/models/oracle-tablespace-file-spec.d.ts +49 -0
  34. package/dist/adminapi/models/oracle-tablespace-file-spec.d.ts.map +1 -0
  35. package/dist/adminapi/models/oracle-tablespace-file-spec.js +16 -0
  36. package/dist/adminapi/models/oracle-tablespace-file-spec.js.map +1 -0
  37. package/dist/adminapi/models/oracle-tablespace-file.d.ts +67 -0
  38. package/dist/adminapi/models/oracle-tablespace-file.d.ts.map +1 -0
  39. package/dist/adminapi/models/oracle-tablespace-file.js +16 -0
  40. package/dist/adminapi/models/oracle-tablespace-file.js.map +1 -0
  41. package/dist/adminapi/models/oracle-tablespace.d.ts +86 -0
  42. package/dist/adminapi/models/oracle-tablespace.d.ts.map +1 -0
  43. package/dist/adminapi/models/oracle-tablespace.js +16 -0
  44. package/dist/adminapi/models/oracle-tablespace.js.map +1 -0
  45. package/dist/openapi/api.d.ts +1 -0
  46. package/dist/openapi/api.d.ts.map +1 -1
  47. package/dist/openapi/api.js +1 -0
  48. package/dist/openapi/api.js.map +1 -1
  49. package/dist/openapi/apis/diagnostics-api.d.ts +229 -0
  50. package/dist/openapi/apis/diagnostics-api.d.ts.map +1 -1
  51. package/dist/openapi/apis/diagnostics-api.js +247 -0
  52. package/dist/openapi/apis/diagnostics-api.js.map +1 -1
  53. package/dist/openapi/apis/oracle-api.d.ts +422 -0
  54. package/dist/openapi/apis/oracle-api.d.ts.map +1 -0
  55. package/dist/openapi/apis/oracle-api.js +471 -0
  56. package/dist/openapi/apis/oracle-api.js.map +1 -0
  57. package/dist/openapi/models/index.d.ts +7 -0
  58. package/dist/openapi/models/index.d.ts.map +1 -1
  59. package/dist/openapi/models/index.js +7 -0
  60. package/dist/openapi/models/index.js.map +1 -1
  61. package/dist/openapi/models/oracle-tablespace-contents.d.ts +22 -0
  62. package/dist/openapi/models/oracle-tablespace-contents.d.ts.map +1 -0
  63. package/dist/openapi/models/oracle-tablespace-contents.js +26 -0
  64. package/dist/openapi/models/oracle-tablespace-contents.js.map +1 -0
  65. package/dist/openapi/models/oracle-tablespace-create.d.ts +45 -0
  66. package/dist/openapi/models/oracle-tablespace-create.d.ts.map +1 -0
  67. package/dist/openapi/models/oracle-tablespace-create.js +16 -0
  68. package/dist/openapi/models/oracle-tablespace-create.js.map +1 -0
  69. package/dist/openapi/models/oracle-tablespace-expand-action.d.ts +22 -0
  70. package/dist/openapi/models/oracle-tablespace-expand-action.d.ts.map +1 -0
  71. package/dist/openapi/models/oracle-tablespace-expand-action.js +26 -0
  72. package/dist/openapi/models/oracle-tablespace-expand-action.js.map +1 -0
  73. package/dist/openapi/models/oracle-tablespace-expand.d.ts +45 -0
  74. package/dist/openapi/models/oracle-tablespace-expand.d.ts.map +1 -0
  75. package/dist/openapi/models/oracle-tablespace-expand.js +16 -0
  76. package/dist/openapi/models/oracle-tablespace-expand.js.map +1 -0
  77. package/dist/openapi/models/oracle-tablespace-file-spec.d.ts +49 -0
  78. package/dist/openapi/models/oracle-tablespace-file-spec.d.ts.map +1 -0
  79. package/dist/openapi/models/oracle-tablespace-file-spec.js +16 -0
  80. package/dist/openapi/models/oracle-tablespace-file-spec.js.map +1 -0
  81. package/dist/openapi/models/oracle-tablespace-file.d.ts +67 -0
  82. package/dist/openapi/models/oracle-tablespace-file.d.ts.map +1 -0
  83. package/dist/openapi/models/oracle-tablespace-file.js +16 -0
  84. package/dist/openapi/models/oracle-tablespace-file.js.map +1 -0
  85. package/dist/openapi/models/oracle-tablespace.d.ts +86 -0
  86. package/dist/openapi/models/oracle-tablespace.d.ts.map +1 -0
  87. package/dist/openapi/models/oracle-tablespace.js +16 -0
  88. package/dist/openapi/models/oracle-tablespace.js.map +1 -0
  89. package/package.json +1 -1
  90. package/src/adminapi/.openapi-generator/FILES +8 -0
  91. package/src/adminapi/api.ts +1 -0
  92. package/src/adminapi/apis/diagnostics-api.ts +401 -0
  93. package/src/adminapi/apis/oracle-api.ts +726 -0
  94. package/src/adminapi/models/index.ts +7 -0
  95. package/src/adminapi/models/oracle-tablespace-contents.ts +31 -0
  96. package/src/adminapi/models/oracle-tablespace-create.ts +56 -0
  97. package/src/adminapi/models/oracle-tablespace-expand-action.ts +31 -0
  98. package/src/adminapi/models/oracle-tablespace-expand.ts +56 -0
  99. package/src/adminapi/models/oracle-tablespace-file-spec.ts +54 -0
  100. package/src/adminapi/models/oracle-tablespace-file.ts +72 -0
  101. package/src/adminapi/models/oracle-tablespace.ts +93 -0
  102. package/src/adminapi.yaml +966 -449
  103. package/src/openapi/.openapi-generator/FILES +8 -0
  104. package/src/openapi/api.ts +1 -0
  105. package/src/openapi/apis/diagnostics-api.ts +401 -0
  106. package/src/openapi/apis/oracle-api.ts +726 -0
  107. package/src/openapi/models/index.ts +7 -0
  108. package/src/openapi/models/oracle-tablespace-contents.ts +31 -0
  109. package/src/openapi/models/oracle-tablespace-create.ts +56 -0
  110. package/src/openapi/models/oracle-tablespace-expand-action.ts +31 -0
  111. package/src/openapi/models/oracle-tablespace-expand.ts +56 -0
  112. package/src/openapi/models/oracle-tablespace-file-spec.ts +54 -0
  113. package/src/openapi/models/oracle-tablespace-file.ts +72 -0
  114. package/src/openapi/models/oracle-tablespace.ts +93 -0
  115. package/src/openapi.yaml +1668 -1151
package/src/openapi.yaml CHANGED
@@ -5099,6 +5099,144 @@ paths:
5099
5099
  - cluster
5100
5100
  - shared
5101
5101
  x-codegen-request-body-name: body
5102
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mariadb/spaceAnalysis:
5103
+ get:
5104
+ tags:
5105
+ - diagnostics
5106
+ summary: Get MariaDB space analysis
5107
+ description: Get a read-only MariaDB compatible space snapshot and fixed backend-owned storage metrics.
5108
+ operationId: getDiagnosticsMariaDBSpaceAnalysis
5109
+ parameters:
5110
+ - name: orgName
5111
+ in: path
5112
+ required: true
5113
+ schema:
5114
+ type: string
5115
+ - name: clusterName
5116
+ in: path
5117
+ required: true
5118
+ schema:
5119
+ type: string
5120
+ - name: databaseName
5121
+ in: query
5122
+ description: Optional database name for table and index details. When omitted, the largest non-system database is selected.
5123
+ required: false
5124
+ schema:
5125
+ type: string
5126
+ responses:
5127
+ '200':
5128
+ description: OK
5129
+ content:
5130
+ application/json:
5131
+ schema:
5132
+ $ref: '#/components/schemas/mysqlSpaceAnalysis'
5133
+ '400':
5134
+ $ref: '#/components/responses/400'
5135
+ '401':
5136
+ $ref: '#/components/responses/401'
5137
+ '403':
5138
+ $ref: '#/components/responses/403'
5139
+ '404':
5140
+ $ref: '#/components/responses/404'
5141
+ '500':
5142
+ $ref: '#/components/responses/500'
5143
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mariadb/sqlAnalysis:
5144
+ get:
5145
+ tags:
5146
+ - diagnostics
5147
+ summary: Get MariaDB SQL analysis
5148
+ description: Get a read-only MariaDB SQL fingerprint ranking from Performance Schema statement digests. The response does not expose raw SQL text, time-window aggregation, execution plans, or remediation actions.
5149
+ operationId: getDiagnosticsMariaDBSQLAnalysis
5150
+ parameters:
5151
+ - name: orgName
5152
+ in: path
5153
+ description: Organization name
5154
+ required: true
5155
+ schema:
5156
+ type: string
5157
+ - name: clusterName
5158
+ in: path
5159
+ description: Cluster name
5160
+ required: true
5161
+ schema:
5162
+ type: string
5163
+ - name: limit
5164
+ in: query
5165
+ description: Maximum number of SQL fingerprints to return. The backend applies its own upper bound.
5166
+ required: false
5167
+ schema:
5168
+ type: integer
5169
+ format: int64
5170
+ - name: orderBy
5171
+ in: query
5172
+ description: Sort key. Allowed values are totalTime, meanTime, maxTime, and calls. Defaults to totalTime.
5173
+ required: false
5174
+ schema:
5175
+ type: string
5176
+ responses:
5177
+ '200':
5178
+ description: OK
5179
+ content:
5180
+ application/json:
5181
+ schema:
5182
+ $ref: '#/components/schemas/mysqlSQLAnalysis'
5183
+ '400':
5184
+ $ref: '#/components/responses/400'
5185
+ '401':
5186
+ $ref: '#/components/responses/401'
5187
+ '403':
5188
+ $ref: '#/components/responses/403'
5189
+ '404':
5190
+ $ref: '#/components/responses/404'
5191
+ '500':
5192
+ $ref: '#/components/responses/500'
5193
+ /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mariadb/performanceTrends:
5194
+ get:
5195
+ tags:
5196
+ - diagnostics
5197
+ summary: Get MariaDB performance trends
5198
+ description: Get read-only MariaDB performance trends from backend-owned metrics and database capability checks. The response does not expose SQL, PromQL, internal endpoints, or credentials.
5199
+ operationId: getDiagnosticsMariaDBPerformanceTrends
5200
+ parameters:
5201
+ - name: orgName
5202
+ in: path
5203
+ description: Organization name
5204
+ required: true
5205
+ schema:
5206
+ type: string
5207
+ - name: clusterName
5208
+ in: path
5209
+ description: Cluster name
5210
+ required: true
5211
+ schema:
5212
+ type: string
5213
+ - name: range
5214
+ in: query
5215
+ description: Controlled query range. Allowed values are 1h, 6h, 24h, and 7d. Defaults to 1h.
5216
+ required: false
5217
+ schema:
5218
+ type: string
5219
+ - name: step
5220
+ in: query
5221
+ description: Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h.
5222
+ required: false
5223
+ schema:
5224
+ type: string
5225
+ responses:
5226
+ '200':
5227
+ description: OK
5228
+ content:
5229
+ application/json:
5230
+ schema:
5231
+ $ref: '#/components/schemas/performanceTrends'
5232
+ '400':
5233
+ $ref: '#/components/responses/400'
5234
+ '401':
5235
+ $ref: '#/components/responses/401'
5236
+ '403':
5237
+ $ref: '#/components/responses/403'
5238
+ '500':
5239
+ $ref: '#/components/responses/500'
5102
5240
  /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/spaceAnalysis:
5103
5241
  get:
5104
5242
  tags:
@@ -16419,13 +16557,13 @@ paths:
16419
16557
  $ref: '#/components/responses/404'
16420
16558
  '500':
16421
16559
  $ref: '#/components/responses/500'
16422
- /api/v1/data/damengdb/organizations/{orgName}/clusters/{clusterName}/tablespaces:
16560
+ /api/v1/data/oracle/organizations/{orgName}/clusters/{clusterName}/tablespaces:
16423
16561
  get:
16424
16562
  tags:
16425
- - dameng
16426
- summary: List damengdb tablespaces
16427
- description: List tablespaces for a Dameng cluster.
16428
- operationId: listTablespaces
16563
+ - oracle
16564
+ summary: List Oracle tablespaces
16565
+ description: List tablespaces for a Oracle cluster.
16566
+ operationId: listOracleTablespaces
16429
16567
  parameters:
16430
16568
  - name: orgName
16431
16569
  in: path
@@ -16444,7 +16582,9 @@ paths:
16444
16582
  content:
16445
16583
  application/json:
16446
16584
  schema:
16447
- $ref: '#/components/schemas/DmTablespaceList'
16585
+ type: array
16586
+ items:
16587
+ $ref: '#/components/schemas/OracleTablespace'
16448
16588
  description: A successful response.
16449
16589
  '400':
16450
16590
  $ref: '#/components/responses/400'
@@ -16458,10 +16598,10 @@ paths:
16458
16598
  $ref: '#/components/responses/500'
16459
16599
  post:
16460
16600
  tags:
16461
- - dameng
16462
- summary: Create damengdb tablespace
16463
- description: Create tablespace for a Dameng cluster.
16464
- operationId: createTablespace
16601
+ - oracle
16602
+ summary: Create Oracle tablespace
16603
+ description: Create tablespace for a Oracle cluster.
16604
+ operationId: createOracleTablespace
16465
16605
  parameters:
16466
16606
  - name: orgName
16467
16607
  in: path
@@ -16476,16 +16616,17 @@ paths:
16476
16616
  type: string
16477
16617
  description: Cluster name
16478
16618
  requestBody:
16619
+ required: true
16479
16620
  content:
16480
16621
  application/json:
16481
16622
  schema:
16482
- $ref: '#/components/schemas/DmTablespace'
16623
+ $ref: '#/components/schemas/OracleTablespaceCreate'
16483
16624
  responses:
16484
16625
  '200':
16485
16626
  content:
16486
16627
  application/json:
16487
16628
  schema:
16488
- $ref: '#/components/schemas/DmTablespace'
16629
+ $ref: '#/components/schemas/OracleTablespace'
16489
16630
  description: A successful response.
16490
16631
  '400':
16491
16632
  $ref: '#/components/responses/400'
@@ -16497,12 +16638,12 @@ paths:
16497
16638
  $ref: '#/components/responses/404'
16498
16639
  '500':
16499
16640
  $ref: '#/components/responses/500'
16500
- /api/v1/data/damengdb/organizations/{orgName}/clusters/{clusterName}/tablespaces/{tablespaceName}:
16641
+ /api/v1/data/oracle/organizations/{orgName}/clusters/{clusterName}/tablespaces/{tablespaceName}:
16501
16642
  get:
16502
16643
  tags:
16503
- - dameng
16504
- summary: Get Dameng tablespace info
16505
- operationId: getTablespace
16644
+ - oracle
16645
+ summary: Get Oracle tablespace info
16646
+ operationId: getOracleTablespace
16506
16647
  parameters:
16507
16648
  - name: orgName
16508
16649
  in: path
@@ -16527,7 +16668,7 @@ paths:
16527
16668
  content:
16528
16669
  application/json:
16529
16670
  schema:
16530
- $ref: '#/components/schemas/DmTablespace'
16671
+ $ref: '#/components/schemas/OracleTablespace'
16531
16672
  description: A successful response.
16532
16673
  '400':
16533
16674
  $ref: '#/components/responses/400'
@@ -16541,10 +16682,10 @@ paths:
16541
16682
  $ref: '#/components/responses/500'
16542
16683
  delete:
16543
16684
  tags:
16544
- - dameng
16545
- summary: Delete damengdb tablespace
16546
- description: Delete tablespace for a Dameng cluster.
16547
- operationId: deleteTablespace
16685
+ - oracle
16686
+ summary: Delete Oracle tablespace
16687
+ description: Delete tablespace for a Oracle cluster.
16688
+ operationId: deleteOracleTablespace
16548
16689
  parameters:
16549
16690
  - name: orgName
16550
16691
  in: path
@@ -16564,6 +16705,18 @@ paths:
16564
16705
  schema:
16565
16706
  type: string
16566
16707
  description: Tablespace name
16708
+ - name: includingContents
16709
+ in: query
16710
+ schema:
16711
+ type: boolean
16712
+ default: false
16713
+ description: Explicitly delete all objects in the tablespace. Without this flag Oracle rejects nonempty tablespaces.
16714
+ - name: deleteDatafiles
16715
+ in: query
16716
+ schema:
16717
+ type: boolean
16718
+ default: false
16719
+ description: Also remove physical files. Requires includingContents. Otherwise manually managed files are retained.
16567
16720
  responses:
16568
16721
  '204':
16569
16722
  content: {}
@@ -16580,10 +16733,10 @@ paths:
16580
16733
  $ref: '#/components/responses/500'
16581
16734
  patch:
16582
16735
  tags:
16583
- - dameng
16584
- summary: Update damengdb tablespace
16585
- description: Update tablespace for a Dameng cluster.
16586
- operationId: updateTablespace
16736
+ - oracle
16737
+ summary: Expand Oracle tablespace
16738
+ description: Expand one existing datafile/tempfile or add one file in the current container.
16739
+ operationId: expandOracleTablespace
16587
16740
  parameters:
16588
16741
  - name: orgName
16589
16742
  in: path
@@ -16604,16 +16757,17 @@ paths:
16604
16757
  type: string
16605
16758
  description: Tablespace name
16606
16759
  requestBody:
16760
+ required: true
16607
16761
  content:
16608
16762
  application/json:
16609
16763
  schema:
16610
- $ref: '#/components/schemas/DmTablespace'
16764
+ $ref: '#/components/schemas/OracleTablespaceExpand'
16611
16765
  responses:
16612
16766
  '200':
16613
16767
  content:
16614
16768
  application/json:
16615
16769
  schema:
16616
- $ref: '#/components/schemas/DmTablespace'
16770
+ $ref: '#/components/schemas/OracleTablespace'
16617
16771
  description: A successful response.
16618
16772
  '400':
16619
16773
  $ref: '#/components/responses/400'
@@ -16625,40 +16779,35 @@ paths:
16625
16779
  $ref: '#/components/responses/404'
16626
16780
  '500':
16627
16781
  $ref: '#/components/responses/500'
16628
- /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/console:
16782
+ /api/v1/data/damengdb/organizations/{orgName}/clusters/{clusterName}/tablespaces:
16629
16783
  get:
16630
16784
  tags:
16631
- - dms
16632
- - shared
16633
- summary: get engine available console
16634
- description: get engine available console
16635
- operationId: getEngineAvailableConsole
16785
+ - dameng
16786
+ summary: List damengdb tablespaces
16787
+ description: List tablespaces for a Dameng cluster.
16788
+ operationId: listTablespaces
16636
16789
  parameters:
16637
- - name: engineName
16638
- in: path
16639
- description: name of the engine
16640
- required: true
16641
- schema:
16642
- type: string
16643
16790
  - name: orgName
16644
16791
  in: path
16645
- description: name of the Org
16646
16792
  required: true
16647
16793
  schema:
16648
16794
  type: string
16795
+ description: Organization name
16649
16796
  - name: clusterName
16650
16797
  in: path
16651
- description: name of the cluster
16652
16798
  required: true
16653
16799
  schema:
16654
16800
  type: string
16801
+ description: Cluster name
16655
16802
  responses:
16656
16803
  '200':
16657
- description: OK
16658
16804
  content:
16659
16805
  application/json:
16660
16806
  schema:
16661
- $ref: '#/components/schemas/console'
16807
+ $ref: '#/components/schemas/DmTablespaceList'
16808
+ description: A successful response.
16809
+ '400':
16810
+ $ref: '#/components/responses/400'
16662
16811
  '401':
16663
16812
  $ref: '#/components/responses/401'
16664
16813
  '403':
@@ -16667,35 +16816,39 @@ paths:
16667
16816
  $ref: '#/components/responses/404'
16668
16817
  '500':
16669
16818
  $ref: '#/components/responses/500'
16670
- delete:
16819
+ post:
16671
16820
  tags:
16672
- - dms
16673
- - shared
16674
- summary: disable console
16675
- description: disable console
16676
- operationId: disableConsole
16821
+ - dameng
16822
+ summary: Create damengdb tablespace
16823
+ description: Create tablespace for a Dameng cluster.
16824
+ operationId: createTablespace
16677
16825
  parameters:
16678
- - name: engineName
16679
- in: path
16680
- description: name of the engine
16681
- required: true
16682
- schema:
16683
- type: string
16684
16826
  - name: orgName
16685
16827
  in: path
16686
- description: name of the Org
16687
16828
  required: true
16688
16829
  schema:
16689
16830
  type: string
16831
+ description: Organization name
16690
16832
  - name: clusterName
16691
16833
  in: path
16692
- description: name of the cluster
16693
16834
  required: true
16694
16835
  schema:
16695
16836
  type: string
16837
+ description: Cluster name
16838
+ requestBody:
16839
+ content:
16840
+ application/json:
16841
+ schema:
16842
+ $ref: '#/components/schemas/DmTablespace'
16696
16843
  responses:
16697
- '204':
16698
- description: disable console successfully
16844
+ '200':
16845
+ content:
16846
+ application/json:
16847
+ schema:
16848
+ $ref: '#/components/schemas/DmTablespace'
16849
+ description: A successful response.
16850
+ '400':
16851
+ $ref: '#/components/responses/400'
16699
16852
  '401':
16700
16853
  $ref: '#/components/responses/401'
16701
16854
  '403':
@@ -16704,37 +16857,244 @@ paths:
16704
16857
  $ref: '#/components/responses/404'
16705
16858
  '500':
16706
16859
  $ref: '#/components/responses/500'
16707
- post:
16860
+ /api/v1/data/damengdb/organizations/{orgName}/clusters/{clusterName}/tablespaces/{tablespaceName}:
16861
+ get:
16708
16862
  tags:
16709
- - dms
16710
- - shared
16711
- summary: enable console
16712
- description: enable console
16713
- operationId: enableConsole
16863
+ - dameng
16864
+ summary: Get Dameng tablespace info
16865
+ operationId: getTablespace
16714
16866
  parameters:
16715
- - name: engineName
16867
+ - name: orgName
16716
16868
  in: path
16717
- description: name of the engine
16718
16869
  required: true
16719
16870
  schema:
16720
16871
  type: string
16721
- - name: orgName
16872
+ description: Organization name
16873
+ - name: clusterName
16722
16874
  in: path
16723
- description: name of the Org
16724
16875
  required: true
16725
16876
  schema:
16726
16877
  type: string
16727
- - name: clusterName
16878
+ description: Cluster name
16879
+ - name: tablespaceName
16728
16880
  in: path
16729
- description: name of the cluster
16730
16881
  required: true
16731
16882
  schema:
16732
16883
  type: string
16733
- requestBody:
16734
- content:
16735
- application/json:
16736
- schema:
16737
- $ref: '#/components/schemas/DMSConsoleEnableOpt'
16884
+ description: Tablespace name
16885
+ responses:
16886
+ '200':
16887
+ content:
16888
+ application/json:
16889
+ schema:
16890
+ $ref: '#/components/schemas/DmTablespace'
16891
+ description: A successful response.
16892
+ '400':
16893
+ $ref: '#/components/responses/400'
16894
+ '401':
16895
+ $ref: '#/components/responses/401'
16896
+ '403':
16897
+ $ref: '#/components/responses/403'
16898
+ '404':
16899
+ $ref: '#/components/responses/404'
16900
+ '500':
16901
+ $ref: '#/components/responses/500'
16902
+ delete:
16903
+ tags:
16904
+ - dameng
16905
+ summary: Delete damengdb tablespace
16906
+ description: Delete tablespace for a Dameng cluster.
16907
+ operationId: deleteTablespace
16908
+ parameters:
16909
+ - name: orgName
16910
+ in: path
16911
+ required: true
16912
+ schema:
16913
+ type: string
16914
+ description: Organization name
16915
+ - name: clusterName
16916
+ in: path
16917
+ required: true
16918
+ schema:
16919
+ type: string
16920
+ description: Cluster name
16921
+ - name: tablespaceName
16922
+ in: path
16923
+ required: true
16924
+ schema:
16925
+ type: string
16926
+ description: Tablespace name
16927
+ responses:
16928
+ '204':
16929
+ content: {}
16930
+ description: A successful response.
16931
+ '400':
16932
+ $ref: '#/components/responses/400'
16933
+ '401':
16934
+ $ref: '#/components/responses/401'
16935
+ '403':
16936
+ $ref: '#/components/responses/403'
16937
+ '404':
16938
+ $ref: '#/components/responses/404'
16939
+ '500':
16940
+ $ref: '#/components/responses/500'
16941
+ patch:
16942
+ tags:
16943
+ - dameng
16944
+ summary: Update damengdb tablespace
16945
+ description: Update tablespace for a Dameng cluster.
16946
+ operationId: updateTablespace
16947
+ parameters:
16948
+ - name: orgName
16949
+ in: path
16950
+ required: true
16951
+ schema:
16952
+ type: string
16953
+ description: Organization name
16954
+ - name: clusterName
16955
+ in: path
16956
+ required: true
16957
+ schema:
16958
+ type: string
16959
+ description: Cluster name
16960
+ - name: tablespaceName
16961
+ in: path
16962
+ required: true
16963
+ schema:
16964
+ type: string
16965
+ description: Tablespace name
16966
+ requestBody:
16967
+ content:
16968
+ application/json:
16969
+ schema:
16970
+ $ref: '#/components/schemas/DmTablespace'
16971
+ responses:
16972
+ '200':
16973
+ content:
16974
+ application/json:
16975
+ schema:
16976
+ $ref: '#/components/schemas/DmTablespace'
16977
+ description: A successful response.
16978
+ '400':
16979
+ $ref: '#/components/responses/400'
16980
+ '401':
16981
+ $ref: '#/components/responses/401'
16982
+ '403':
16983
+ $ref: '#/components/responses/403'
16984
+ '404':
16985
+ $ref: '#/components/responses/404'
16986
+ '500':
16987
+ $ref: '#/components/responses/500'
16988
+ /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/console:
16989
+ get:
16990
+ tags:
16991
+ - dms
16992
+ - shared
16993
+ summary: get engine available console
16994
+ description: get engine available console
16995
+ operationId: getEngineAvailableConsole
16996
+ parameters:
16997
+ - name: engineName
16998
+ in: path
16999
+ description: name of the engine
17000
+ required: true
17001
+ schema:
17002
+ type: string
17003
+ - name: orgName
17004
+ in: path
17005
+ description: name of the Org
17006
+ required: true
17007
+ schema:
17008
+ type: string
17009
+ - name: clusterName
17010
+ in: path
17011
+ description: name of the cluster
17012
+ required: true
17013
+ schema:
17014
+ type: string
17015
+ responses:
17016
+ '200':
17017
+ description: OK
17018
+ content:
17019
+ application/json:
17020
+ schema:
17021
+ $ref: '#/components/schemas/console'
17022
+ '401':
17023
+ $ref: '#/components/responses/401'
17024
+ '403':
17025
+ $ref: '#/components/responses/403'
17026
+ '404':
17027
+ $ref: '#/components/responses/404'
17028
+ '500':
17029
+ $ref: '#/components/responses/500'
17030
+ delete:
17031
+ tags:
17032
+ - dms
17033
+ - shared
17034
+ summary: disable console
17035
+ description: disable console
17036
+ operationId: disableConsole
17037
+ parameters:
17038
+ - name: engineName
17039
+ in: path
17040
+ description: name of the engine
17041
+ required: true
17042
+ schema:
17043
+ type: string
17044
+ - name: orgName
17045
+ in: path
17046
+ description: name of the Org
17047
+ required: true
17048
+ schema:
17049
+ type: string
17050
+ - name: clusterName
17051
+ in: path
17052
+ description: name of the cluster
17053
+ required: true
17054
+ schema:
17055
+ type: string
17056
+ responses:
17057
+ '204':
17058
+ description: disable console successfully
17059
+ '401':
17060
+ $ref: '#/components/responses/401'
17061
+ '403':
17062
+ $ref: '#/components/responses/403'
17063
+ '404':
17064
+ $ref: '#/components/responses/404'
17065
+ '500':
17066
+ $ref: '#/components/responses/500'
17067
+ post:
17068
+ tags:
17069
+ - dms
17070
+ - shared
17071
+ summary: enable console
17072
+ description: enable console
17073
+ operationId: enableConsole
17074
+ parameters:
17075
+ - name: engineName
17076
+ in: path
17077
+ description: name of the engine
17078
+ required: true
17079
+ schema:
17080
+ type: string
17081
+ - name: orgName
17082
+ in: path
17083
+ description: name of the Org
17084
+ required: true
17085
+ schema:
17086
+ type: string
17087
+ - name: clusterName
17088
+ in: path
17089
+ description: name of the cluster
17090
+ required: true
17091
+ schema:
17092
+ type: string
17093
+ requestBody:
17094
+ content:
17095
+ application/json:
17096
+ schema:
17097
+ $ref: '#/components/schemas/DMSConsoleEnableOpt'
16738
17098
  responses:
16739
17099
  '204':
16740
17100
  description: enable console successfully
@@ -26223,1047 +26583,900 @@ components:
26223
26583
  collectedAt:
26224
26584
  type: string
26225
26585
  description: Backend collection timestamp in UTC.
26226
- mssqlRequest:
26586
+ mysqlSQLFingerprint:
26227
26587
  type: object
26228
26588
  required:
26229
- - requestId
26230
- - startedAt
26231
- - status
26232
- - command
26589
+ - queryID
26590
+ - fingerprint
26591
+ - querySummary
26592
+ - calls
26593
+ - totalTimeMs
26594
+ - meanTimeMs
26595
+ - maxTimeMs
26596
+ - rows
26597
+ - rowsSent
26598
+ - rowsAffected
26599
+ - rowsExamined
26600
+ - lockTimeMs
26601
+ - errors
26602
+ - warnings
26603
+ - tmpTables
26604
+ - tmpDiskTables
26605
+ - noIndexUsed
26606
+ - noGoodIndexUsed
26233
26607
  - database
26234
- - sql
26235
- - sqlTruncated
26236
- - elapsedMs
26237
- - cpuMs
26238
- - reads
26239
- - logicalReads
26240
- - writes
26241
- - waitType
26242
- - waitMs
26243
- - waitResource
26244
- - blockingSessionId
26245
26608
  properties:
26246
- requestId:
26247
- type: integer
26248
- format: int64
26249
- startedAt:
26250
- type: string
26251
- description: Opaque SQL Server local start time, used to detect session or request reuse. Pass back unchanged; it is not a UTC timestamp.
26252
- status:
26609
+ queryID:
26253
26610
  type: string
26254
- command:
26255
- type: string
26256
- database:
26611
+ description: MySQL Performance Schema DIGEST value.
26612
+ fingerprint:
26257
26613
  type: string
26258
- sql:
26614
+ description: Stable SQL fingerprint identifier. M1 uses DIGEST.
26615
+ querySummary:
26259
26616
  type: string
26260
- description: Current statement extracted with byte offsets. Truncated to 8192 characters.
26261
- sqlTruncated:
26262
- type: boolean
26263
- elapsedMs:
26617
+ description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
26618
+ calls:
26264
26619
  type: integer
26265
26620
  format: int64
26266
- cpuMs:
26621
+ description: Number of executions accumulated in the current digest row.
26622
+ totalTimeMs:
26623
+ type: number
26624
+ format: double
26625
+ description: Total statement wait time in milliseconds.
26626
+ meanTimeMs:
26627
+ type: number
26628
+ format: double
26629
+ description: Mean statement wait time in milliseconds.
26630
+ maxTimeMs:
26631
+ type: number
26632
+ format: double
26633
+ description: Maximum statement wait time in milliseconds.
26634
+ rows:
26267
26635
  type: integer
26268
26636
  format: int64
26269
- reads:
26637
+ description: Sum of rows sent and rows affected.
26638
+ rowsSent:
26270
26639
  type: integer
26271
26640
  format: int64
26272
- logicalReads:
26641
+ description: Total rows sent to clients.
26642
+ rowsAffected:
26273
26643
  type: integer
26274
26644
  format: int64
26275
- writes:
26645
+ description: Total rows affected by statements.
26646
+ rowsExamined:
26276
26647
  type: integer
26277
26648
  format: int64
26278
- waitType:
26279
- type: string
26280
- waitMs:
26649
+ description: Total rows examined by statements.
26650
+ lockTimeMs:
26651
+ type: number
26652
+ format: double
26653
+ description: Total statement lock time in milliseconds.
26654
+ errors:
26281
26655
  type: integer
26282
26656
  format: int64
26283
- waitResource:
26284
- type: string
26285
- blockingSessionId:
26657
+ description: Total statement errors.
26658
+ warnings:
26286
26659
  type: integer
26287
26660
  format: int64
26288
- mssqlSession:
26661
+ description: Total statement warnings.
26662
+ tmpTables:
26663
+ type: integer
26664
+ format: int64
26665
+ description: Total internal temporary tables created.
26666
+ tmpDiskTables:
26667
+ type: integer
26668
+ format: int64
26669
+ description: Total internal on-disk temporary tables created.
26670
+ noIndexUsed:
26671
+ type: integer
26672
+ format: int64
26673
+ description: Executions that used no index.
26674
+ noGoodIndexUsed:
26675
+ type: integer
26676
+ format: int64
26677
+ description: Executions for which no good index was found.
26678
+ database:
26679
+ type: string
26680
+ description: Default schema name associated with the digest row.
26681
+ firstSeen:
26682
+ type: string
26683
+ description: UTC timestamp when the digest was first observed.
26684
+ lastSeen:
26685
+ type: string
26686
+ description: UTC timestamp when the digest was most recently observed.
26687
+ mysqlSQLAnalysis:
26289
26688
  type: object
26290
26689
  required:
26291
- - sessionId
26292
- - startedAt
26690
+ - source
26293
26691
  - status
26294
- - user
26295
- - host
26296
- - application
26297
- - client
26298
- - database
26299
- - openTransactions
26300
- - transactionSeconds
26301
- - lastSql
26302
- - lastSqlTruncated
26303
- - requests
26304
- - requestsTruncated
26692
+ - collectedAt
26693
+ - limit
26694
+ - orderBy
26695
+ - items
26305
26696
  properties:
26306
- sessionId:
26307
- type: integer
26308
- format: int64
26309
- startedAt:
26697
+ source:
26310
26698
  type: string
26311
- description: Opaque SQL Server local start time, used to detect session or request reuse. Pass back unchanged; it is not a UTC timestamp.
26699
+ description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
26312
26700
  status:
26313
26701
  type: string
26314
- user:
26702
+ description: Source status. Expected values are available or unavailable.
26703
+ unavailableReason:
26315
26704
  type: string
26316
- host:
26705
+ description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
26706
+ message:
26317
26707
  type: string
26318
- application:
26708
+ description: User-facing recovery guidance when SQL analysis is unavailable.
26709
+ collectedAt:
26319
26710
  type: string
26320
- client:
26711
+ description: Backend collection timestamp in UTC. It is not a sampling-window end time.
26712
+ firstSeen:
26321
26713
  type: string
26322
- database:
26714
+ description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
26715
+ lastSeen:
26323
26716
  type: string
26324
- openTransactions:
26717
+ description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
26718
+ limit:
26325
26719
  type: integer
26326
26720
  format: int64
26327
- transactionSeconds:
26721
+ description: Effective row limit after backend normalization.
26722
+ orderBy:
26723
+ type: string
26724
+ description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
26725
+ totalTimeMsAll:
26726
+ type: number
26727
+ format: double
26728
+ x-nullable: true
26729
+ description: Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
26730
+ callsAll:
26328
26731
  type: integer
26329
26732
  format: int64
26330
- lastSql:
26331
- type: string
26332
- description: Most recent batch on the connection, not necessarily the SQL that acquired its locks. Truncated to 8192 characters.
26333
- lastSqlTruncated:
26334
- type: boolean
26335
- requests:
26733
+ x-nullable: true
26734
+ description: Total execution count across all visible digest rows, not limited to the returned top-N items.
26735
+ digestLost:
26736
+ type: integer
26737
+ format: int64
26738
+ x-nullable: true
26739
+ description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
26740
+ items:
26336
26741
  type: array
26742
+ description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
26337
26743
  items:
26338
- $ref: '#/components/schemas/mssqlRequest'
26339
- requestsTruncated:
26340
- type: boolean
26341
- mssqlSessionSnapshot:
26744
+ $ref: '#/components/schemas/mysqlSQLFingerprint'
26745
+ performanceTrendRange:
26342
26746
  type: object
26343
26747
  required:
26344
- - capturedAt
26345
- - sessions
26346
- - truncated
26748
+ - label
26749
+ - start
26750
+ - end
26751
+ - durationSeconds
26347
26752
  properties:
26348
- capturedAt:
26753
+ label:
26349
26754
  type: string
26350
- sessions:
26351
- type: array
26352
- items:
26353
- $ref: '#/components/schemas/mssqlSession'
26354
- truncated:
26355
- type: boolean
26356
- mssqlWait:
26357
- type: object
26358
- required:
26359
- - sessionId
26360
- - requestId
26361
- - blockingSessionId
26362
- - waitType
26363
- - waitMs
26364
- - resource
26365
- - source
26366
- properties:
26367
- sessionId:
26368
- type: integer
26369
- format: int64
26370
- requestId:
26371
- type: integer
26372
- format: int64
26373
- description: Request ID, or -1 when a waiting task cannot be associated with a live request.
26374
- blockingSessionId:
26375
- type: integer
26376
- format: int64
26377
- description: SQL Server blocking owner. Negative values are special owners, not session IDs.
26378
- waitType:
26755
+ description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
26756
+ start:
26379
26757
  type: string
26380
- waitMs:
26758
+ end:
26759
+ type: string
26760
+ durationSeconds:
26381
26761
  type: integer
26382
26762
  format: int64
26383
- resource:
26384
- type: string
26385
- source:
26386
- type: string
26387
- mssqlLock:
26763
+ performanceTrendSummary:
26388
26764
  type: object
26389
26765
  required:
26390
- - sessionId
26391
- - requestId
26392
- - database
26393
- - resourceType
26394
- - resource
26395
- - entityId
26396
- - mode
26397
- - status
26398
- - ownerType
26766
+ - metric
26767
+ - displayName
26768
+ - category
26769
+ - unit
26770
+ - min
26771
+ - max
26772
+ - avg
26773
+ - latest
26399
26774
  properties:
26400
- sessionId:
26401
- type: integer
26402
- format: int64
26403
- requestId:
26404
- type: integer
26405
- format: int64
26406
- database:
26775
+ metric:
26407
26776
  type: string
26408
- resourceType:
26777
+ displayName:
26778
+ $ref: '#/components/schemas/localizedDescription'
26779
+ category:
26409
26780
  type: string
26410
- resource:
26781
+ description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
26782
+ dimension:
26411
26783
  type: string
26412
- entityId:
26784
+ description: Optional series dimension. Values include cluster, instance, pvc, and database.
26785
+ labels:
26786
+ type: object
26787
+ additionalProperties:
26788
+ type: string
26789
+ description: Optional dimension labels, for example instance, pvc, role, or datname.
26790
+ unit:
26413
26791
  type: string
26414
- mode:
26792
+ warnThreshold:
26793
+ type: number
26794
+ format: double
26795
+ description: Optional warning threshold in the same unit as this metric.
26796
+ critThreshold:
26797
+ type: number
26798
+ format: double
26799
+ description: Optional critical threshold in the same unit as this metric.
26800
+ thresholdDirection:
26415
26801
  type: string
26416
- status:
26417
- type: string
26418
- ownerType:
26802
+ description: Optional threshold direction. Values are above, below, or boolean.
26803
+ min:
26804
+ type: number
26805
+ format: double
26806
+ max:
26807
+ type: number
26808
+ format: double
26809
+ avg:
26810
+ type: number
26811
+ format: double
26812
+ latest:
26813
+ type: number
26814
+ format: double
26815
+ changeDirection:
26419
26816
  type: string
26420
- mssqlLockSnapshot:
26817
+ description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
26818
+ performanceTrendPoint:
26421
26819
  type: object
26422
26820
  required:
26423
- - capturedAt
26424
- - sessions
26425
- - waits
26426
- - locks
26427
- - truncated
26821
+ - timestamp
26822
+ - value
26428
26823
  properties:
26429
- capturedAt:
26824
+ timestamp:
26430
26825
  type: string
26431
- sessions:
26432
- type: array
26433
- items:
26434
- $ref: '#/components/schemas/mssqlSession'
26435
- waits:
26436
- type: array
26437
- items:
26438
- $ref: '#/components/schemas/mssqlWait'
26439
- locks:
26440
- type: array
26441
- items:
26442
- $ref: '#/components/schemas/mssqlLock'
26443
- truncated:
26444
- type: boolean
26445
- description: Bounded live DMV observations. Edges are SQL Server reported blocking identifiers. Collection is not atomic; graph cycles are not historical deadlock evidence.
26446
- mssqlCachedPlan:
26826
+ value:
26827
+ type: number
26828
+ format: double
26829
+ performanceTrendSeries:
26447
26830
  type: object
26448
26831
  required:
26449
- - capturedAt
26450
- - xml
26451
- - available
26832
+ - metric
26833
+ - displayName
26834
+ - category
26835
+ - unit
26836
+ - points
26452
26837
  properties:
26453
- capturedAt:
26454
- type: string
26455
- xml:
26838
+ metric:
26456
26839
  type: string
26457
- available:
26458
- type: boolean
26459
- description: Cached compiled plan for the selected live request. No captured SQL is executed. This is not an actual runtime plan.
26460
- postgresqlSession:
26461
- type: object
26462
- required:
26463
- - pid
26464
- - user
26465
- - database
26466
- - applicationName
26467
- - clientAddr
26468
- - clientPort
26469
- - state
26470
- - waitEventType
26471
- - waitEvent
26472
- - durationSeconds
26473
- - xactDurationSeconds
26474
- - queryDigest
26475
- - querySummary
26476
- - backendType
26477
- properties:
26478
- pid:
26479
- type: integer
26480
- format: int64
26481
- user:
26840
+ displayName:
26841
+ $ref: '#/components/schemas/localizedDescription'
26842
+ category:
26482
26843
  type: string
26483
- database:
26844
+ description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
26845
+ dimension:
26484
26846
  type: string
26485
- applicationName:
26847
+ description: Optional series dimension. Values include cluster, instance, pvc, and database.
26848
+ labels:
26849
+ type: object
26850
+ additionalProperties:
26851
+ type: string
26852
+ description: Optional dimension labels, for example instance, pvc, role, or datname.
26853
+ unit:
26486
26854
  type: string
26487
- clientAddr:
26855
+ warnThreshold:
26856
+ type: number
26857
+ format: double
26858
+ description: Optional warning threshold in the same unit as this metric.
26859
+ critThreshold:
26860
+ type: number
26861
+ format: double
26862
+ description: Optional critical threshold in the same unit as this metric.
26863
+ thresholdDirection:
26488
26864
  type: string
26489
- description: Client address.
26490
- clientPort:
26865
+ description: Optional threshold direction. Values are above, below, or boolean.
26866
+ points:
26867
+ type: array
26868
+ items:
26869
+ $ref: '#/components/schemas/performanceTrendPoint'
26870
+ performanceTrendSource:
26871
+ type: object
26872
+ required:
26873
+ - name
26874
+ - kind
26875
+ - status
26876
+ - collectedAt
26877
+ properties:
26878
+ name:
26491
26879
  type: string
26492
- description: Client port.
26493
- state:
26880
+ kind:
26494
26881
  type: string
26495
- waitEventType:
26882
+ status:
26496
26883
  type: string
26497
- waitEvent:
26884
+ description: Coarse source status. Values are success, partial, failed, skipped, or noData.
26885
+ collectedAt:
26498
26886
  type: string
26499
- backendStart:
26887
+ message:
26500
26888
  type: string
26501
- description: Backend start timestamp if available.
26502
- queryStart:
26889
+ performanceTrends:
26890
+ type: object
26891
+ required:
26892
+ - range
26893
+ - granularity
26894
+ - summary
26895
+ - series
26896
+ - sources
26897
+ - warnings
26898
+ - collectedAt
26899
+ properties:
26900
+ range:
26901
+ $ref: '#/components/schemas/performanceTrendRange'
26902
+ granularity:
26503
26903
  type: string
26504
- description: Query start timestamp if available.
26505
- xactStart:
26904
+ description: Controlled backend query step.
26905
+ summary:
26906
+ type: array
26907
+ description: Per-series numeric summary. changeDirection is present only when at least two points exist.
26908
+ items:
26909
+ $ref: '#/components/schemas/performanceTrendSummary'
26910
+ series:
26911
+ type: array
26912
+ description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
26913
+ items:
26914
+ $ref: '#/components/schemas/performanceTrendSeries'
26915
+ sources:
26916
+ type: array
26917
+ description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
26918
+ items:
26919
+ $ref: '#/components/schemas/performanceTrendSource'
26920
+ warnings:
26921
+ type: array
26922
+ items:
26923
+ type: string
26924
+ collectedAt:
26506
26925
  type: string
26507
- description: Transaction start timestamp if available.
26508
- durationSeconds:
26509
- type: integer
26510
- format: int64
26511
- xactDurationSeconds:
26926
+ description: Backend collection timestamp in UTC.
26927
+ mssqlRequest:
26928
+ type: object
26929
+ required:
26930
+ - requestId
26931
+ - startedAt
26932
+ - status
26933
+ - command
26934
+ - database
26935
+ - sql
26936
+ - sqlTruncated
26937
+ - elapsedMs
26938
+ - cpuMs
26939
+ - reads
26940
+ - logicalReads
26941
+ - writes
26942
+ - waitType
26943
+ - waitMs
26944
+ - waitResource
26945
+ - blockingSessionId
26946
+ properties:
26947
+ requestId:
26512
26948
  type: integer
26513
26949
  format: int64
26514
- queryDigest:
26950
+ startedAt:
26515
26951
  type: string
26516
- querySummary:
26952
+ description: Opaque SQL Server local start time, used to detect session or request reuse. Pass back unchanged; it is not a UTC timestamp.
26953
+ status:
26517
26954
  type: string
26518
- backendType:
26955
+ command:
26519
26956
  type: string
26520
- postgresqlSessionList:
26521
- type: array
26522
- items:
26523
- $ref: '#/components/schemas/postgresqlSession'
26524
- postgresqlSpaceSummary:
26525
- type: object
26526
- required:
26527
- - tableCount
26528
- - indexCount
26529
- - toastRelationCount
26530
- - tableListTruncated
26531
- - indexListTruncated
26532
- properties:
26533
- databaseName:
26957
+ database:
26534
26958
  type: string
26535
- databaseSizeBytes:
26959
+ sql:
26960
+ type: string
26961
+ description: Current statement extracted with byte offsets. Truncated to 8192 characters.
26962
+ sqlTruncated:
26963
+ type: boolean
26964
+ elapsedMs:
26536
26965
  type: integer
26537
26966
  format: int64
26538
- tableCount:
26967
+ cpuMs:
26539
26968
  type: integer
26540
26969
  format: int64
26541
- indexCount:
26970
+ reads:
26542
26971
  type: integer
26543
26972
  format: int64
26544
- toastRelationCount:
26973
+ logicalReads:
26545
26974
  type: integer
26546
26975
  format: int64
26547
- largestTableBytes:
26976
+ writes:
26548
26977
  type: integer
26549
26978
  format: int64
26550
- largestIndexBytes:
26979
+ waitType:
26980
+ type: string
26981
+ waitMs:
26551
26982
  type: integer
26552
26983
  format: int64
26553
- tableListTruncated:
26554
- type: boolean
26555
- indexListTruncated:
26556
- type: boolean
26557
- postgresqlStorageInstanceUsage:
26558
- type: object
26559
- properties:
26560
- instanceName:
26561
- type: string
26562
- description: Kubernetes pod name for this PostgreSQL replica storage sample.
26563
- pvcName:
26984
+ waitResource:
26564
26985
  type: string
26565
- description: PersistentVolumeClaim name when it can be read from metrics labels.
26566
- role:
26567
- type: string
26568
- description: Raw PostgreSQL replica role value read from metrics labels, kept aligned with instance detail display.
26569
- componentName:
26570
- type: string
26571
- description: Optional KubeBlocks component name when it can be read from metrics labels.
26572
- totalBytes:
26573
- type: integer
26574
- format: int64
26575
- description: Physical PVC capacity in bytes for this replica storage sample.
26576
- usedBytes:
26986
+ blockingSessionId:
26577
26987
  type: integer
26578
26988
  format: int64
26579
- description: Physical PVC used bytes for this replica storage sample.
26580
- availableBytes:
26989
+ mssqlSession:
26990
+ type: object
26991
+ required:
26992
+ - sessionId
26993
+ - startedAt
26994
+ - status
26995
+ - user
26996
+ - host
26997
+ - application
26998
+ - client
26999
+ - database
27000
+ - openTransactions
27001
+ - transactionSeconds
27002
+ - lastSql
27003
+ - lastSqlTruncated
27004
+ - requests
27005
+ - requestsTruncated
27006
+ properties:
27007
+ sessionId:
26581
27008
  type: integer
26582
27009
  format: int64
26583
- description: Available bytes derived from totalBytes - usedBytes when both values are available.
26584
- usageRatio:
26585
- type: number
26586
- format: double
26587
- nullable: true
26588
- description: usedBytes / totalBytes for this replica storage sample when both values are available.
26589
- updatedAt:
27010
+ startedAt:
26590
27011
  type: string
26591
- description: Metrics collection timestamp in UTC.
26592
- source:
27012
+ description: Opaque SQL Server local start time, used to detect session or request reuse. Pass back unchanged; it is not a UTC timestamp.
27013
+ status:
26593
27014
  type: string
26594
- postgresqlStorageOverview:
26595
- type: object
26596
- required:
26597
- - source
26598
- - instances
26599
- properties:
26600
- source:
27015
+ user:
26601
27016
  type: string
26602
- instances:
26603
- type: array
26604
- description: Physical PostgreSQL replica storage usage split by pod/PVC/role.
26605
- items:
26606
- $ref: '#/components/schemas/postgresqlStorageInstanceUsage'
26607
- postgresqlDatabaseSpace:
26608
- type: object
26609
- properties:
26610
- name:
27017
+ host:
26611
27018
  type: string
26612
- sizeBytes:
26613
- type: integer
26614
- format: int64
26615
- postgresqlTableSpace:
26616
- type: object
26617
- properties:
26618
- database:
27019
+ application:
26619
27020
  type: string
26620
- schema:
27021
+ client:
26621
27022
  type: string
26622
- name:
27023
+ database:
26623
27024
  type: string
26624
- relationOid:
26625
- type: integer
26626
- format: int64
26627
- totalBytes:
26628
- type: integer
26629
- format: int64
26630
- tableBytes:
26631
- type: integer
26632
- format: int64
26633
- indexBytes:
26634
- type: integer
26635
- format: int64
26636
- toastBytes:
26637
- type: integer
26638
- format: int64
26639
- toastRelationOid:
26640
- type: integer
26641
- format: int64
26642
- liveTuples:
26643
- type: integer
26644
- format: int64
26645
- deadTuples:
26646
- type: integer
26647
- format: int64
26648
- seqScan:
27025
+ openTransactions:
26649
27026
  type: integer
26650
27027
  format: int64
26651
- indexScan:
27028
+ transactionSeconds:
26652
27029
  type: integer
26653
27030
  format: int64
26654
- lastVacuum:
26655
- type: string
26656
- lastAutoVacuum:
26657
- type: string
26658
- lastAnalyze:
26659
- type: string
26660
- lastAutoAnalyze:
27031
+ lastSql:
26661
27032
  type: string
26662
- postgresqlIndexSpace:
27033
+ description: Most recent batch on the connection, not necessarily the SQL that acquired its locks. Truncated to 8192 characters.
27034
+ lastSqlTruncated:
27035
+ type: boolean
27036
+ requests:
27037
+ type: array
27038
+ items:
27039
+ $ref: '#/components/schemas/mssqlRequest'
27040
+ requestsTruncated:
27041
+ type: boolean
27042
+ mssqlSessionSnapshot:
26663
27043
  type: object
27044
+ required:
27045
+ - capturedAt
27046
+ - sessions
27047
+ - truncated
26664
27048
  properties:
26665
- database:
26666
- type: string
26667
- schema:
26668
- type: string
26669
- table:
26670
- type: string
26671
- name:
27049
+ capturedAt:
26672
27050
  type: string
26673
- tableRelationOid:
27051
+ sessions:
27052
+ type: array
27053
+ items:
27054
+ $ref: '#/components/schemas/mssqlSession'
27055
+ truncated:
27056
+ type: boolean
27057
+ mssqlWait:
27058
+ type: object
27059
+ required:
27060
+ - sessionId
27061
+ - requestId
27062
+ - blockingSessionId
27063
+ - waitType
27064
+ - waitMs
27065
+ - resource
27066
+ - source
27067
+ properties:
27068
+ sessionId:
26674
27069
  type: integer
26675
27070
  format: int64
26676
- relationOid:
27071
+ requestId:
26677
27072
  type: integer
26678
27073
  format: int64
26679
- sizeBytes:
27074
+ description: Request ID, or -1 when a waiting task cannot be associated with a live request.
27075
+ blockingSessionId:
26680
27076
  type: integer
26681
27077
  format: int64
26682
- isPrimary:
26683
- type: boolean
26684
- isUnique:
26685
- type: boolean
26686
- scanCount:
27078
+ description: SQL Server blocking owner. Negative values are special owners, not session IDs.
27079
+ waitType:
27080
+ type: string
27081
+ waitMs:
26687
27082
  type: integer
26688
27083
  format: int64
26689
- tuplesRead:
27084
+ resource:
27085
+ type: string
27086
+ source:
27087
+ type: string
27088
+ mssqlLock:
27089
+ type: object
27090
+ required:
27091
+ - sessionId
27092
+ - requestId
27093
+ - database
27094
+ - resourceType
27095
+ - resource
27096
+ - entityId
27097
+ - mode
27098
+ - status
27099
+ - ownerType
27100
+ properties:
27101
+ sessionId:
26690
27102
  type: integer
26691
27103
  format: int64
26692
- tuplesFetch:
27104
+ requestId:
26693
27105
  type: integer
26694
27106
  format: int64
26695
- postgresqlToastRelationSpace:
26696
- type: object
26697
- properties:
26698
27107
  database:
26699
27108
  type: string
26700
- schema:
27109
+ resourceType:
26701
27110
  type: string
26702
- table:
27111
+ resource:
26703
27112
  type: string
26704
- tableRelationOid:
26705
- type: integer
26706
- format: int64
26707
- toastRelationOid:
26708
- type: integer
26709
- format: int64
26710
- toastBytes:
26711
- type: integer
26712
- format: int64
26713
- postgresqlSpaceSource:
26714
- type: object
26715
- required:
26716
- - name
26717
- - kind
26718
- - status
26719
- - collectedAt
26720
- properties:
26721
- name:
27113
+ entityId:
26722
27114
  type: string
26723
- kind:
27115
+ mode:
26724
27116
  type: string
26725
27117
  status:
26726
27118
  type: string
26727
- collectedAt:
26728
- type: string
26729
- message:
27119
+ ownerType:
26730
27120
  type: string
26731
- postgresqlSpaceAnalysis:
27121
+ mssqlLockSnapshot:
26732
27122
  type: object
26733
27123
  required:
26734
- - summary
26735
- - storageOverview
26736
- - databases
26737
- - selectedDatabase
26738
- - tables
26739
- - indexes
26740
- - toastRelations
26741
- - sources
26742
- - collectedAt
27124
+ - capturedAt
27125
+ - sessions
27126
+ - waits
27127
+ - locks
27128
+ - truncated
26743
27129
  properties:
26744
- summary:
26745
- $ref: '#/components/schemas/postgresqlSpaceSummary'
26746
- storageOverview:
26747
- $ref: '#/components/schemas/postgresqlStorageOverview'
26748
- databases:
26749
- type: array
26750
- description: Sizes of all connectable non-template databases in the PostgreSQL instance.
26751
- items:
26752
- $ref: '#/components/schemas/postgresqlDatabaseSpace'
26753
- selectedDatabase:
27130
+ capturedAt:
26754
27131
  type: string
26755
- description: Database used for tables, indexes, and toastRelations in this response.
26756
- tables:
27132
+ sessions:
26757
27133
  type: array
26758
- description: Top tables from selectedDatabase.
26759
27134
  items:
26760
- $ref: '#/components/schemas/postgresqlTableSpace'
26761
- indexes:
27135
+ $ref: '#/components/schemas/mssqlSession'
27136
+ waits:
26762
27137
  type: array
26763
- description: Top indexes from selectedDatabase.
26764
27138
  items:
26765
- $ref: '#/components/schemas/postgresqlIndexSpace'
26766
- toastRelations:
26767
- type: array
26768
- description: Toast relations derived from selectedDatabase table space data.
26769
- items:
26770
- $ref: '#/components/schemas/postgresqlToastRelationSpace'
26771
- sources:
27139
+ $ref: '#/components/schemas/mssqlWait'
27140
+ locks:
26772
27141
  type: array
26773
27142
  items:
26774
- $ref: '#/components/schemas/postgresqlSpaceSource'
26775
- collectedAt:
27143
+ $ref: '#/components/schemas/mssqlLock'
27144
+ truncated:
27145
+ type: boolean
27146
+ description: Bounded live DMV observations. Edges are SQL Server reported blocking identifiers. Collection is not atomic; graph cycles are not historical deadlock evidence.
27147
+ mssqlCachedPlan:
27148
+ type: object
27149
+ required:
27150
+ - capturedAt
27151
+ - xml
27152
+ - available
27153
+ properties:
27154
+ capturedAt:
26776
27155
  type: string
26777
- description: Backend collection timestamp in UTC.
26778
- postgresqlSQLFingerprint:
27156
+ xml:
27157
+ type: string
27158
+ available:
27159
+ type: boolean
27160
+ description: Cached compiled plan for the selected live request. No captured SQL is executed. This is not an actual runtime plan.
27161
+ postgresqlSession:
26779
27162
  type: object
26780
27163
  required:
26781
- - queryID
26782
- - fingerprint
26783
- - querySummary
26784
- - calls
26785
- - totalTimeMs
26786
- - meanTimeMs
26787
- - maxTimeMs
26788
- - rows
26789
- - database
27164
+ - pid
26790
27165
  - user
26791
- - topLevel
27166
+ - database
27167
+ - applicationName
27168
+ - clientAddr
27169
+ - clientPort
27170
+ - state
27171
+ - waitEventType
27172
+ - waitEvent
27173
+ - durationSeconds
27174
+ - xactDurationSeconds
27175
+ - queryDigest
27176
+ - querySummary
27177
+ - backendType
26792
27178
  properties:
26793
- queryID:
27179
+ pid:
27180
+ type: integer
27181
+ format: int64
27182
+ user:
26794
27183
  type: string
26795
- description: PostgreSQL pg_stat_statements queryid represented as a string.
26796
- fingerprint:
27184
+ database:
26797
27185
  type: string
26798
- description: Stable SQL fingerprint identifier for UI grouping. M1 uses queryID.
26799
- querySummary:
27186
+ applicationName:
26800
27187
  type: string
26801
- description: Redacted SQL summary. Full raw SQL is intentionally not returned.
26802
- calls:
27188
+ clientAddr:
27189
+ type: string
27190
+ description: Client address.
27191
+ clientPort:
27192
+ type: string
27193
+ description: Client port.
27194
+ state:
27195
+ type: string
27196
+ waitEventType:
27197
+ type: string
27198
+ waitEvent:
27199
+ type: string
27200
+ backendStart:
27201
+ type: string
27202
+ description: Backend start timestamp if available.
27203
+ queryStart:
27204
+ type: string
27205
+ description: Query start timestamp if available.
27206
+ xactStart:
27207
+ type: string
27208
+ description: Transaction start timestamp if available.
27209
+ durationSeconds:
26803
27210
  type: integer
26804
27211
  format: int64
26805
- description: Number of executions accumulated by pg_stat_statements since statsReset.
26806
- totalTimeMs:
26807
- type: number
26808
- format: double
26809
- description: Total execution time in milliseconds accumulated by pg_stat_statements since statsReset.
26810
- meanTimeMs:
26811
- type: number
26812
- format: double
26813
- description: Mean execution time in milliseconds.
26814
- maxTimeMs:
26815
- type: number
26816
- format: double
26817
- description: Max execution time in milliseconds.
26818
- rows:
27212
+ xactDurationSeconds:
26819
27213
  type: integer
26820
27214
  format: int64
26821
- description: Rows returned or affected by the fingerprint, as reported by pg_stat_statements.
26822
- database:
27215
+ queryDigest:
26823
27216
  type: string
26824
- description: Database name resolved from pg_stat_statements.dbid when visible.
26825
- user:
27217
+ querySummary:
26826
27218
  type: string
26827
- description: Database user name resolved from pg_stat_statements.userid when visible.
26828
- topLevel:
26829
- type: boolean
26830
- description: Whether pg_stat_statements recorded the statement as top-level. Legacy PostgreSQL versions without the toplevel column report true.
26831
- postgresqlSQLAnalysis:
27219
+ backendType:
27220
+ type: string
27221
+ postgresqlSessionList:
27222
+ type: array
27223
+ items:
27224
+ $ref: '#/components/schemas/postgresqlSession'
27225
+ postgresqlSpaceSummary:
26832
27226
  type: object
26833
27227
  required:
26834
- - source
26835
- - status
26836
- - collectedAt
26837
- - limit
26838
- - orderBy
26839
- - items
27228
+ - tableCount
27229
+ - indexCount
27230
+ - toastRelationCount
27231
+ - tableListTruncated
27232
+ - indexListTruncated
26840
27233
  properties:
26841
- source:
27234
+ databaseName:
26842
27235
  type: string
26843
- description: Data source. M1 uses pg_stat_statements only.
26844
- status:
27236
+ databaseSizeBytes:
27237
+ type: integer
27238
+ format: int64
27239
+ tableCount:
27240
+ type: integer
27241
+ format: int64
27242
+ indexCount:
27243
+ type: integer
27244
+ format: int64
27245
+ toastRelationCount:
27246
+ type: integer
27247
+ format: int64
27248
+ largestTableBytes:
27249
+ type: integer
27250
+ format: int64
27251
+ largestIndexBytes:
27252
+ type: integer
27253
+ format: int64
27254
+ tableListTruncated:
27255
+ type: boolean
27256
+ indexListTruncated:
27257
+ type: boolean
27258
+ postgresqlStorageInstanceUsage:
27259
+ type: object
27260
+ properties:
27261
+ instanceName:
26845
27262
  type: string
26846
- description: Source status. Expected values are available or unavailable.
26847
- unavailableReason:
27263
+ description: Kubernetes pod name for this PostgreSQL replica storage sample.
27264
+ pvcName:
26848
27265
  type: string
26849
- description: Reason when status is unavailable, such as extension_disabled, permission_denied, or query_failed.
26850
- statsReset:
27266
+ description: PersistentVolumeClaim name when it can be read from metrics labels.
27267
+ role:
26851
27268
  type: string
26852
- description: UTC timestamp reported by pg_stat_statements_info.stats_reset when available. Empty means the source did not expose this timestamp.
26853
- collectedAt:
27269
+ description: Raw PostgreSQL replica role value read from metrics labels, kept aligned with instance detail display.
27270
+ componentName:
26854
27271
  type: string
26855
- description: Backend collection timestamp in UTC. It is not a sampling-window end time.
26856
- limit:
27272
+ description: Optional KubeBlocks component name when it can be read from metrics labels.
27273
+ totalBytes:
26857
27274
  type: integer
26858
27275
  format: int64
26859
- description: Effective row limit after backend normalization.
26860
- orderBy:
26861
- type: string
26862
- description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
26863
- totalTimeMsAll:
26864
- type: number
26865
- format: double
26866
- x-nullable: true
26867
- description: Total execution time in milliseconds across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
26868
- callsAll:
27276
+ description: Physical PVC capacity in bytes for this replica storage sample.
27277
+ usedBytes:
26869
27278
  type: integer
26870
27279
  format: int64
26871
- x-nullable: true
26872
- description: Total execution count across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
26873
- items:
27280
+ description: Physical PVC used bytes for this replica storage sample.
27281
+ availableBytes:
27282
+ type: integer
27283
+ format: int64
27284
+ description: Available bytes derived from totalBytes - usedBytes when both values are available.
27285
+ usageRatio:
27286
+ type: number
27287
+ format: double
27288
+ nullable: true
27289
+ description: usedBytes / totalBytes for this replica storage sample when both values are available.
27290
+ updatedAt:
27291
+ type: string
27292
+ description: Metrics collection timestamp in UTC.
27293
+ source:
27294
+ type: string
27295
+ postgresqlStorageOverview:
27296
+ type: object
27297
+ required:
27298
+ - source
27299
+ - instances
27300
+ properties:
27301
+ source:
27302
+ type: string
27303
+ instances:
26874
27304
  type: array
26875
- description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
27305
+ description: Physical PostgreSQL replica storage usage split by pod/PVC/role.
26876
27306
  items:
26877
- $ref: '#/components/schemas/postgresqlSQLFingerprint'
26878
- DmsExecutionPlanPlanningMode:
26879
- type: string
26880
- enum:
26881
- - standard
26882
- - generic
26883
- DmsExecutionPlanMode:
26884
- type: string
26885
- enum:
26886
- - estimate
26887
- - analyze
26888
- - actual
26889
- - autotrace
26890
- DmsExecutionPlanRawFormat:
26891
- type: string
26892
- enum:
26893
- - json
26894
- - xml
26895
- - text
26896
- - table
26897
- DmsExecutionPlanNodeCategory:
26898
- type: string
26899
- enum:
26900
- - result
26901
- - sort
26902
- - join
26903
- - table_scan
26904
- - index_scan
26905
- - lookup
26906
- - materialize
26907
- - aggregate
26908
- - exchange
26909
- - modify
26910
- - other
26911
- DmsExecutionPlanNodeCost:
27307
+ $ref: '#/components/schemas/postgresqlStorageInstanceUsage'
27308
+ postgresqlDatabaseSpace:
26912
27309
  type: object
26913
27310
  properties:
26914
- startup:
26915
- type: number
26916
- format: double
26917
- nullable: true
26918
- x-omitempty: true
26919
- total:
26920
- type: number
26921
- format: double
26922
- nullable: true
26923
- x-omitempty: true
26924
- self:
26925
- type: number
26926
- format: double
26927
- nullable: true
26928
- x-omitempty: true
26929
- percent:
26930
- type: number
26931
- format: double
26932
- nullable: true
26933
- x-omitempty: true
26934
- DmsExecutionPlanNodeRows:
26935
- type: object
26936
- properties:
26937
- estimated:
26938
- type: number
26939
- format: double
26940
- nullable: true
26941
- x-omitempty: true
26942
- actual:
26943
- type: number
26944
- format: double
26945
- nullable: true
26946
- x-omitempty: true
26947
- actualPerLoop:
26948
- type: number
26949
- format: double
26950
- nullable: true
26951
- x-omitempty: true
26952
- removedByFilter:
26953
- type: number
26954
- format: double
26955
- nullable: true
26956
- x-omitempty: true
26957
- mismatchRatio:
26958
- type: number
26959
- format: double
26960
- nullable: true
26961
- x-omitempty: true
26962
- DmsExecutionPlanNodeTiming:
26963
- type: object
26964
- properties:
26965
- startupMs:
26966
- type: number
26967
- format: double
26968
- nullable: true
26969
- x-omitempty: true
26970
- totalMs:
26971
- type: number
26972
- format: double
26973
- nullable: true
26974
- x-omitempty: true
26975
- selfMs:
26976
- type: number
26977
- format: double
26978
- nullable: true
26979
- x-omitempty: true
26980
- loops:
26981
- type: number
26982
- format: double
26983
- nullable: true
26984
- x-omitempty: true
26985
- DmsExecutionPlanNodeConditions:
27311
+ name:
27312
+ type: string
27313
+ sizeBytes:
27314
+ type: integer
27315
+ format: int64
27316
+ postgresqlTableSpace:
26986
27317
  type: object
26987
27318
  properties:
26988
- filter:
26989
- type: string
26990
- nullable: true
26991
- x-omitempty: true
26992
- indexCond:
26993
- type: string
26994
- nullable: true
26995
- x-omitempty: true
26996
- joinCond:
27319
+ database:
26997
27320
  type: string
26998
- nullable: true
26999
- x-omitempty: true
27000
- hashCond:
27321
+ schema:
27001
27322
  type: string
27002
- nullable: true
27003
- x-omitempty: true
27004
- sortKey:
27005
- type: array
27006
- items:
27007
- type: string
27008
- DmsExecutionPlanNode:
27009
- type: object
27010
- properties:
27011
- id:
27323
+ name:
27012
27324
  type: string
27013
- parentIds:
27014
- type: array
27015
- items:
27016
- type: string
27017
- childIds:
27018
- type: array
27019
- items:
27020
- type: string
27021
- order:
27325
+ relationOid:
27022
27326
  type: integer
27023
27327
  format: int64
27024
- nullable: true
27025
- x-omitempty: true
27026
- category:
27027
- $ref: '#/components/schemas/DmsExecutionPlanNodeCategory'
27028
- nodeType:
27029
- type: string
27030
- label:
27031
- type: string
27032
- relationName:
27328
+ totalBytes:
27329
+ type: integer
27330
+ format: int64
27331
+ tableBytes:
27332
+ type: integer
27333
+ format: int64
27334
+ indexBytes:
27335
+ type: integer
27336
+ format: int64
27337
+ toastBytes:
27338
+ type: integer
27339
+ format: int64
27340
+ toastRelationOid:
27341
+ type: integer
27342
+ format: int64
27343
+ liveTuples:
27344
+ type: integer
27345
+ format: int64
27346
+ deadTuples:
27347
+ type: integer
27348
+ format: int64
27349
+ seqScan:
27350
+ type: integer
27351
+ format: int64
27352
+ indexScan:
27353
+ type: integer
27354
+ format: int64
27355
+ lastVacuum:
27033
27356
  type: string
27034
- nullable: true
27035
- x-omitempty: true
27036
- schemaName:
27357
+ lastAutoVacuum:
27037
27358
  type: string
27038
- nullable: true
27039
- x-omitempty: true
27040
- alias:
27359
+ lastAnalyze:
27041
27360
  type: string
27042
- nullable: true
27043
- x-omitempty: true
27044
- indexName:
27361
+ lastAutoAnalyze:
27045
27362
  type: string
27046
- nullable: true
27047
- x-omitempty: true
27048
- cost:
27049
- $ref: '#/components/schemas/DmsExecutionPlanNodeCost'
27050
- nullable: true
27051
- x-omitempty: true
27052
- rows:
27053
- $ref: '#/components/schemas/DmsExecutionPlanNodeRows'
27054
- nullable: true
27055
- x-omitempty: true
27056
- timing:
27057
- $ref: '#/components/schemas/DmsExecutionPlanNodeTiming'
27058
- nullable: true
27059
- x-omitempty: true
27060
- conditions:
27061
- $ref: '#/components/schemas/DmsExecutionPlanNodeConditions'
27062
- nullable: true
27063
- x-omitempty: true
27064
- details:
27065
- type: object
27066
- additionalProperties: true
27067
- x-omitempty: true
27068
- DmsExecutionPlanEdgeRows:
27069
- type: object
27070
- properties:
27071
- estimated:
27072
- type: number
27073
- format: double
27074
- nullable: true
27075
- x-omitempty: true
27076
- actual:
27077
- type: number
27078
- format: double
27079
- nullable: true
27080
- x-omitempty: true
27081
- DmsExecutionPlanEdge:
27363
+ postgresqlIndexSpace:
27082
27364
  type: object
27083
27365
  properties:
27084
- id:
27366
+ database:
27085
27367
  type: string
27086
- source:
27368
+ schema:
27087
27369
  type: string
27088
- target:
27370
+ table:
27089
27371
  type: string
27090
- rows:
27091
- $ref: '#/components/schemas/DmsExecutionPlanEdgeRows'
27092
- nullable: true
27093
- x-omitempty: true
27094
- widthWeight:
27095
- type: number
27096
- format: double
27097
- nullable: true
27098
- x-omitempty: true
27099
- label:
27372
+ name:
27100
27373
  type: string
27101
- nullable: true
27102
- x-omitempty: true
27103
- DmsExecutionPlanSummary:
27104
- type: object
27105
- properties:
27106
- totalCost:
27107
- type: number
27108
- format: double
27109
- nullable: true
27110
- x-omitempty: true
27111
- totalActualTimeMs:
27112
- type: number
27113
- format: double
27114
- nullable: true
27115
- x-omitempty: true
27116
- planRows:
27117
- type: number
27118
- format: double
27119
- nullable: true
27120
- x-omitempty: true
27121
- actualRows:
27122
- type: number
27123
- format: double
27124
- nullable: true
27125
- x-omitempty: true
27126
- nodeCount:
27374
+ tableRelationOid:
27127
27375
  type: integer
27128
27376
  format: int64
27129
- maxCostNodeId:
27377
+ relationOid:
27378
+ type: integer
27379
+ format: int64
27380
+ sizeBytes:
27381
+ type: integer
27382
+ format: int64
27383
+ isPrimary:
27384
+ type: boolean
27385
+ isUnique:
27386
+ type: boolean
27387
+ scanCount:
27388
+ type: integer
27389
+ format: int64
27390
+ tuplesRead:
27391
+ type: integer
27392
+ format: int64
27393
+ tuplesFetch:
27394
+ type: integer
27395
+ format: int64
27396
+ postgresqlToastRelationSpace:
27397
+ type: object
27398
+ properties:
27399
+ database:
27130
27400
  type: string
27131
- nullable: true
27132
- x-omitempty: true
27133
- maxRowsNodeId:
27401
+ schema:
27134
27402
  type: string
27135
- nullable: true
27136
- x-omitempty: true
27137
- maxTimeNodeId:
27403
+ table:
27138
27404
  type: string
27139
- nullable: true
27140
- x-omitempty: true
27141
- DmsExecutionPlanWarningSeverity:
27142
- type: string
27143
- enum:
27144
- - info
27145
- - warning
27146
- - critical
27147
- DmsExecutionPlanWarning:
27405
+ tableRelationOid:
27406
+ type: integer
27407
+ format: int64
27408
+ toastRelationOid:
27409
+ type: integer
27410
+ format: int64
27411
+ toastBytes:
27412
+ type: integer
27413
+ format: int64
27414
+ postgresqlSpaceSource:
27148
27415
  type: object
27416
+ required:
27417
+ - name
27418
+ - kind
27419
+ - status
27420
+ - collectedAt
27149
27421
  properties:
27150
- code:
27422
+ name:
27151
27423
  type: string
27152
- severity:
27153
- $ref: '#/components/schemas/DmsExecutionPlanWarningSeverity'
27154
- nodeId:
27424
+ kind:
27425
+ type: string
27426
+ status:
27427
+ type: string
27428
+ collectedAt:
27155
27429
  type: string
27156
- nullable: true
27157
- x-omitempty: true
27158
27430
  message:
27159
27431
  type: string
27160
- DmsExecutionPlanResult:
27432
+ postgresqlSpaceAnalysis:
27161
27433
  type: object
27434
+ required:
27435
+ - summary
27436
+ - storageOverview
27437
+ - databases
27438
+ - selectedDatabase
27439
+ - tables
27440
+ - indexes
27441
+ - toastRelations
27442
+ - sources
27443
+ - collectedAt
27162
27444
  properties:
27163
- originSQL:
27164
- type: string
27165
- explainSQL:
27166
- type: string
27167
- nullable: true
27168
- x-omitempty: true
27169
- engineType:
27170
- type: string
27171
- mode:
27172
- $ref: '#/components/schemas/DmsExecutionPlanMode'
27173
- planMode:
27174
- $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
27175
- parameterized:
27176
- type: boolean
27177
- x-omitempty: false
27178
- parameterCount:
27179
- type: integer
27180
- format: int64
27181
- nullable: true
27182
- x-omitempty: true
27183
- hasActualStats:
27184
- type: boolean
27185
- x-omitempty: false
27186
- rawFormat:
27187
- $ref: '#/components/schemas/DmsExecutionPlanRawFormat'
27188
- rawPlan:
27189
- type: object
27190
- description: Engine-native raw plan payload exposed for fallback display. SDKs model it as a free-form JSON object.
27191
- additionalProperties: true
27192
- x-omitempty: true
27193
- rootNodeIds:
27194
- type: array
27195
- items:
27196
- type: string
27197
- nodes:
27445
+ summary:
27446
+ $ref: '#/components/schemas/postgresqlSpaceSummary'
27447
+ storageOverview:
27448
+ $ref: '#/components/schemas/postgresqlStorageOverview'
27449
+ databases:
27198
27450
  type: array
27451
+ description: Sizes of all connectable non-template databases in the PostgreSQL instance.
27199
27452
  items:
27200
- $ref: '#/components/schemas/DmsExecutionPlanNode'
27201
- edges:
27453
+ $ref: '#/components/schemas/postgresqlDatabaseSpace'
27454
+ selectedDatabase:
27455
+ type: string
27456
+ description: Database used for tables, indexes, and toastRelations in this response.
27457
+ tables:
27202
27458
  type: array
27459
+ description: Top tables from selectedDatabase.
27203
27460
  items:
27204
- $ref: '#/components/schemas/DmsExecutionPlanEdge'
27205
- summary:
27206
- $ref: '#/components/schemas/DmsExecutionPlanSummary'
27207
- nullable: true
27208
- x-omitempty: true
27209
- warnings:
27461
+ $ref: '#/components/schemas/postgresqlTableSpace'
27462
+ indexes:
27210
27463
  type: array
27211
- items:
27212
- $ref: '#/components/schemas/DmsExecutionPlanWarning'
27213
- fallbackTable:
27214
- $ref: '#/components/schemas/DmsQueryResponse'
27215
- nullable: true
27216
- x-omitempty: true
27217
- postgresqlSQLFingerprintExplainResponse:
27218
- type: object
27219
- required:
27220
- - queryID
27221
- - fingerprint
27222
- - database
27223
- - user
27224
- - topLevel
27225
- - planMode
27226
- - parameterized
27227
- - explainResult
27228
- properties:
27229
- queryID:
27230
- type: string
27231
- description: PostgreSQL pg_stat_statements queryid represented as a string.
27232
- fingerprint:
27233
- type: string
27234
- description: Stable SQL fingerprint identifier for UI grouping. Currently aligned with PostgreSQL pg_stat_statements queryid.
27235
- database:
27236
- type: string
27237
- description: Database name from the requested SQL fingerprint identity.
27238
- user:
27239
- type: string
27240
- description: Database user from the requested SQL fingerprint identity.
27241
- topLevel:
27242
- type: boolean
27243
- description: Top-level flag from the requested SQL fingerprint identity.
27244
- statementSource:
27245
- type: string
27246
- description: Server-side source used to resolve the parameterized SQL statement. Raw SQL is not returned.
27247
- statementResolvedAt:
27464
+ description: Top indexes from selectedDatabase.
27465
+ items:
27466
+ $ref: '#/components/schemas/postgresqlIndexSpace'
27467
+ toastRelations:
27468
+ type: array
27469
+ description: Toast relations derived from selectedDatabase table space data.
27470
+ items:
27471
+ $ref: '#/components/schemas/postgresqlToastRelationSpace'
27472
+ sources:
27473
+ type: array
27474
+ items:
27475
+ $ref: '#/components/schemas/postgresqlSpaceSource'
27476
+ collectedAt:
27248
27477
  type: string
27249
- description: Timestamp when the parameterized SQL statement was resolved.
27250
- planMode:
27251
- $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
27252
- description: Whether DMS produced a standard estimated plan or a generic parameterized estimated plan.
27253
- parameterized:
27254
- type: boolean
27255
- description: Whether generic parameterized planning was used (planMode is generic). False means standard planning, not that historical parameter values were used. This endpoint never retrieves historical parameter values.
27256
- x-omitempty: false
27257
- parameterCount:
27258
- type: integer
27259
- format: int64
27260
- nullable: true
27261
- x-omitempty: true
27262
- description: Number of parameters when DMS can determine it. It may be omitted for PostgreSQL generic-plan paths that do not expose the count.
27263
- explainResult:
27264
- $ref: '#/components/schemas/DmsExecutionPlanResult'
27265
- description: Normalized DMS estimated visual plan. The resolved statement and generated EXPLAIN SQL are intentionally removed.
27266
- mysqlSQLFingerprint:
27478
+ description: Backend collection timestamp in UTC.
27479
+ postgresqlSQLFingerprint:
27267
27480
  type: object
27268
27481
  required:
27269
27482
  - queryID
@@ -27274,97 +27487,49 @@ components:
27274
27487
  - meanTimeMs
27275
27488
  - maxTimeMs
27276
27489
  - rows
27277
- - rowsSent
27278
- - rowsAffected
27279
- - rowsExamined
27280
- - lockTimeMs
27281
- - errors
27282
- - warnings
27283
- - tmpTables
27284
- - tmpDiskTables
27285
- - noIndexUsed
27286
- - noGoodIndexUsed
27287
27490
  - database
27491
+ - user
27492
+ - topLevel
27288
27493
  properties:
27289
27494
  queryID:
27290
27495
  type: string
27291
- description: MySQL Performance Schema DIGEST value.
27496
+ description: PostgreSQL pg_stat_statements queryid represented as a string.
27292
27497
  fingerprint:
27293
27498
  type: string
27294
- description: Stable SQL fingerprint identifier. M1 uses DIGEST.
27499
+ description: Stable SQL fingerprint identifier for UI grouping. M1 uses queryID.
27295
27500
  querySummary:
27296
27501
  type: string
27297
- description: Normalized DIGEST_TEXT. Raw SQL text is intentionally not returned.
27502
+ description: Redacted SQL summary. Full raw SQL is intentionally not returned.
27298
27503
  calls:
27299
27504
  type: integer
27300
27505
  format: int64
27301
- description: Number of executions accumulated in the current digest row.
27506
+ description: Number of executions accumulated by pg_stat_statements since statsReset.
27302
27507
  totalTimeMs:
27303
27508
  type: number
27304
27509
  format: double
27305
- description: Total statement wait time in milliseconds.
27510
+ description: Total execution time in milliseconds accumulated by pg_stat_statements since statsReset.
27306
27511
  meanTimeMs:
27307
27512
  type: number
27308
27513
  format: double
27309
- description: Mean statement wait time in milliseconds.
27514
+ description: Mean execution time in milliseconds.
27310
27515
  maxTimeMs:
27311
27516
  type: number
27312
27517
  format: double
27313
- description: Maximum statement wait time in milliseconds.
27518
+ description: Max execution time in milliseconds.
27314
27519
  rows:
27315
27520
  type: integer
27316
27521
  format: int64
27317
- description: Sum of rows sent and rows affected.
27318
- rowsSent:
27319
- type: integer
27320
- format: int64
27321
- description: Total rows sent to clients.
27322
- rowsAffected:
27323
- type: integer
27324
- format: int64
27325
- description: Total rows affected by statements.
27326
- rowsExamined:
27327
- type: integer
27328
- format: int64
27329
- description: Total rows examined by statements.
27330
- lockTimeMs:
27331
- type: number
27332
- format: double
27333
- description: Total statement lock time in milliseconds.
27334
- errors:
27335
- type: integer
27336
- format: int64
27337
- description: Total statement errors.
27338
- warnings:
27339
- type: integer
27340
- format: int64
27341
- description: Total statement warnings.
27342
- tmpTables:
27343
- type: integer
27344
- format: int64
27345
- description: Total internal temporary tables created.
27346
- tmpDiskTables:
27347
- type: integer
27348
- format: int64
27349
- description: Total internal on-disk temporary tables created.
27350
- noIndexUsed:
27351
- type: integer
27352
- format: int64
27353
- description: Executions that used no index.
27354
- noGoodIndexUsed:
27355
- type: integer
27356
- format: int64
27357
- description: Executions for which no good index was found.
27522
+ description: Rows returned or affected by the fingerprint, as reported by pg_stat_statements.
27358
27523
  database:
27359
27524
  type: string
27360
- description: Default schema name associated with the digest row.
27361
- firstSeen:
27362
- type: string
27363
- description: UTC timestamp when the digest was first observed.
27364
- lastSeen:
27525
+ description: Database name resolved from pg_stat_statements.dbid when visible.
27526
+ user:
27365
27527
  type: string
27366
- description: UTC timestamp when the digest was most recently observed.
27367
- mysqlSQLAnalysis:
27528
+ description: Database user name resolved from pg_stat_statements.userid when visible.
27529
+ topLevel:
27530
+ type: boolean
27531
+ description: Whether pg_stat_statements recorded the statement as top-level. Legacy PostgreSQL versions without the toplevel column report true.
27532
+ postgresqlSQLAnalysis:
27368
27533
  type: object
27369
27534
  required:
27370
27535
  - source
@@ -27374,236 +27539,431 @@ components:
27374
27539
  - orderBy
27375
27540
  - items
27376
27541
  properties:
27377
- source:
27378
- type: string
27379
- description: Data source. M1 uses performance_schema.events_statements_summary_by_digest.
27380
- status:
27381
- type: string
27382
- description: Source status. Expected values are available or unavailable.
27383
- unavailableReason:
27384
- type: string
27385
- description: Reason when status is unavailable, such as performance_schema_disabled, digest_consumer_disabled, permission_denied, or query_failed.
27386
- message:
27387
- type: string
27388
- description: User-facing recovery guidance when SQL analysis is unavailable.
27389
- collectedAt:
27542
+ source:
27543
+ type: string
27544
+ description: Data source. M1 uses pg_stat_statements only.
27545
+ status:
27546
+ type: string
27547
+ description: Source status. Expected values are available or unavailable.
27548
+ unavailableReason:
27549
+ type: string
27550
+ description: Reason when status is unavailable, such as extension_disabled, permission_denied, or query_failed.
27551
+ statsReset:
27552
+ type: string
27553
+ description: UTC timestamp reported by pg_stat_statements_info.stats_reset when available. Empty means the source did not expose this timestamp.
27554
+ collectedAt:
27555
+ type: string
27556
+ description: Backend collection timestamp in UTC. It is not a sampling-window end time.
27557
+ limit:
27558
+ type: integer
27559
+ format: int64
27560
+ description: Effective row limit after backend normalization.
27561
+ orderBy:
27562
+ type: string
27563
+ description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
27564
+ totalTimeMsAll:
27565
+ type: number
27566
+ format: double
27567
+ x-nullable: true
27568
+ description: Total execution time in milliseconds across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
27569
+ callsAll:
27570
+ type: integer
27571
+ format: int64
27572
+ x-nullable: true
27573
+ description: Total execution count across all visible pg_stat_statements rows, not limited to the returned top-N items. Present only when the source is available.
27574
+ items:
27575
+ type: array
27576
+ description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
27577
+ items:
27578
+ $ref: '#/components/schemas/postgresqlSQLFingerprint'
27579
+ DmsExecutionPlanPlanningMode:
27580
+ type: string
27581
+ enum:
27582
+ - standard
27583
+ - generic
27584
+ DmsExecutionPlanMode:
27585
+ type: string
27586
+ enum:
27587
+ - estimate
27588
+ - analyze
27589
+ - actual
27590
+ - autotrace
27591
+ DmsExecutionPlanRawFormat:
27592
+ type: string
27593
+ enum:
27594
+ - json
27595
+ - xml
27596
+ - text
27597
+ - table
27598
+ DmsExecutionPlanNodeCategory:
27599
+ type: string
27600
+ enum:
27601
+ - result
27602
+ - sort
27603
+ - join
27604
+ - table_scan
27605
+ - index_scan
27606
+ - lookup
27607
+ - materialize
27608
+ - aggregate
27609
+ - exchange
27610
+ - modify
27611
+ - other
27612
+ DmsExecutionPlanNodeCost:
27613
+ type: object
27614
+ properties:
27615
+ startup:
27616
+ type: number
27617
+ format: double
27618
+ nullable: true
27619
+ x-omitempty: true
27620
+ total:
27621
+ type: number
27622
+ format: double
27623
+ nullable: true
27624
+ x-omitempty: true
27625
+ self:
27626
+ type: number
27627
+ format: double
27628
+ nullable: true
27629
+ x-omitempty: true
27630
+ percent:
27631
+ type: number
27632
+ format: double
27633
+ nullable: true
27634
+ x-omitempty: true
27635
+ DmsExecutionPlanNodeRows:
27636
+ type: object
27637
+ properties:
27638
+ estimated:
27639
+ type: number
27640
+ format: double
27641
+ nullable: true
27642
+ x-omitempty: true
27643
+ actual:
27644
+ type: number
27645
+ format: double
27646
+ nullable: true
27647
+ x-omitempty: true
27648
+ actualPerLoop:
27649
+ type: number
27650
+ format: double
27651
+ nullable: true
27652
+ x-omitempty: true
27653
+ removedByFilter:
27654
+ type: number
27655
+ format: double
27656
+ nullable: true
27657
+ x-omitempty: true
27658
+ mismatchRatio:
27659
+ type: number
27660
+ format: double
27661
+ nullable: true
27662
+ x-omitempty: true
27663
+ DmsExecutionPlanNodeTiming:
27664
+ type: object
27665
+ properties:
27666
+ startupMs:
27667
+ type: number
27668
+ format: double
27669
+ nullable: true
27670
+ x-omitempty: true
27671
+ totalMs:
27672
+ type: number
27673
+ format: double
27674
+ nullable: true
27675
+ x-omitempty: true
27676
+ selfMs:
27677
+ type: number
27678
+ format: double
27679
+ nullable: true
27680
+ x-omitempty: true
27681
+ loops:
27682
+ type: number
27683
+ format: double
27684
+ nullable: true
27685
+ x-omitempty: true
27686
+ DmsExecutionPlanNodeConditions:
27687
+ type: object
27688
+ properties:
27689
+ filter:
27390
27690
  type: string
27391
- description: Backend collection timestamp in UTC. It is not a sampling-window end time.
27392
- firstSeen:
27691
+ nullable: true
27692
+ x-omitempty: true
27693
+ indexCond:
27393
27694
  type: string
27394
- description: Earliest FIRST_SEEN timestamp across currently visible digest rows, when available.
27395
- lastSeen:
27695
+ nullable: true
27696
+ x-omitempty: true
27697
+ joinCond:
27396
27698
  type: string
27397
- description: Latest LAST_SEEN timestamp across currently visible digest rows, when available.
27398
- limit:
27399
- type: integer
27400
- format: int64
27401
- description: Effective row limit after backend normalization.
27402
- orderBy:
27699
+ nullable: true
27700
+ x-omitempty: true
27701
+ hashCond:
27403
27702
  type: string
27404
- description: Effective sort key. Expected values are totalTime, meanTime, maxTime, or calls.
27405
- totalTimeMsAll:
27406
- type: number
27407
- format: double
27408
- x-nullable: true
27409
- description: Total execution time in milliseconds across all visible digest rows, not limited to the returned top-N items.
27410
- callsAll:
27411
- type: integer
27412
- format: int64
27413
- x-nullable: true
27414
- description: Total execution count across all visible digest rows, not limited to the returned top-N items.
27415
- digestLost:
27416
- type: integer
27417
- format: int64
27418
- x-nullable: true
27419
- description: Number of statement digests not recorded because the digest table was full, when exposed by the server.
27420
- items:
27703
+ nullable: true
27704
+ x-omitempty: true
27705
+ sortKey:
27421
27706
  type: array
27422
- description: SQL fingerprint ranking rows from Performance Schema. The list may be empty when no statement statistics exist.
27423
27707
  items:
27424
- $ref: '#/components/schemas/mysqlSQLFingerprint'
27425
- performanceTrendRange:
27708
+ type: string
27709
+ DmsExecutionPlanNode:
27426
27710
  type: object
27427
- required:
27428
- - label
27429
- - start
27430
- - end
27431
- - durationSeconds
27432
27711
  properties:
27433
- label:
27434
- type: string
27435
- description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
27436
- start:
27437
- type: string
27438
- end:
27712
+ id:
27439
27713
  type: string
27440
- durationSeconds:
27714
+ parentIds:
27715
+ type: array
27716
+ items:
27717
+ type: string
27718
+ childIds:
27719
+ type: array
27720
+ items:
27721
+ type: string
27722
+ order:
27441
27723
  type: integer
27442
27724
  format: int64
27443
- performanceTrendSummary:
27444
- type: object
27445
- required:
27446
- - metric
27447
- - displayName
27448
- - category
27449
- - unit
27450
- - min
27451
- - max
27452
- - avg
27453
- - latest
27454
- properties:
27455
- metric:
27456
- type: string
27457
- displayName:
27458
- $ref: '#/components/schemas/localizedDescription'
27725
+ nullable: true
27726
+ x-omitempty: true
27459
27727
  category:
27728
+ $ref: '#/components/schemas/DmsExecutionPlanNodeCategory'
27729
+ nodeType:
27460
27730
  type: string
27461
- description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
27462
- dimension:
27731
+ label:
27463
27732
  type: string
27464
- description: Optional series dimension. Values include cluster, instance, pvc, and database.
27465
- labels:
27466
- type: object
27467
- additionalProperties:
27468
- type: string
27469
- description: Optional dimension labels, for example instance, pvc, role, or datname.
27470
- unit:
27733
+ relationName:
27471
27734
  type: string
27472
- warnThreshold:
27735
+ nullable: true
27736
+ x-omitempty: true
27737
+ schemaName:
27738
+ type: string
27739
+ nullable: true
27740
+ x-omitempty: true
27741
+ alias:
27742
+ type: string
27743
+ nullable: true
27744
+ x-omitempty: true
27745
+ indexName:
27746
+ type: string
27747
+ nullable: true
27748
+ x-omitempty: true
27749
+ cost:
27750
+ $ref: '#/components/schemas/DmsExecutionPlanNodeCost'
27751
+ nullable: true
27752
+ x-omitempty: true
27753
+ rows:
27754
+ $ref: '#/components/schemas/DmsExecutionPlanNodeRows'
27755
+ nullable: true
27756
+ x-omitempty: true
27757
+ timing:
27758
+ $ref: '#/components/schemas/DmsExecutionPlanNodeTiming'
27759
+ nullable: true
27760
+ x-omitempty: true
27761
+ conditions:
27762
+ $ref: '#/components/schemas/DmsExecutionPlanNodeConditions'
27763
+ nullable: true
27764
+ x-omitempty: true
27765
+ details:
27766
+ type: object
27767
+ additionalProperties: true
27768
+ x-omitempty: true
27769
+ DmsExecutionPlanEdgeRows:
27770
+ type: object
27771
+ properties:
27772
+ estimated:
27473
27773
  type: number
27474
27774
  format: double
27475
- description: Optional warning threshold in the same unit as this metric.
27476
- critThreshold:
27775
+ nullable: true
27776
+ x-omitempty: true
27777
+ actual:
27477
27778
  type: number
27478
27779
  format: double
27479
- description: Optional critical threshold in the same unit as this metric.
27480
- thresholdDirection:
27780
+ nullable: true
27781
+ x-omitempty: true
27782
+ DmsExecutionPlanEdge:
27783
+ type: object
27784
+ properties:
27785
+ id:
27481
27786
  type: string
27482
- description: Optional threshold direction. Values are above, below, or boolean.
27483
- min:
27787
+ source:
27788
+ type: string
27789
+ target:
27790
+ type: string
27791
+ rows:
27792
+ $ref: '#/components/schemas/DmsExecutionPlanEdgeRows'
27793
+ nullable: true
27794
+ x-omitempty: true
27795
+ widthWeight:
27484
27796
  type: number
27485
27797
  format: double
27486
- max:
27798
+ nullable: true
27799
+ x-omitempty: true
27800
+ label:
27801
+ type: string
27802
+ nullable: true
27803
+ x-omitempty: true
27804
+ DmsExecutionPlanSummary:
27805
+ type: object
27806
+ properties:
27807
+ totalCost:
27487
27808
  type: number
27488
27809
  format: double
27489
- avg:
27810
+ nullable: true
27811
+ x-omitempty: true
27812
+ totalActualTimeMs:
27490
27813
  type: number
27491
27814
  format: double
27492
- latest:
27815
+ nullable: true
27816
+ x-omitempty: true
27817
+ planRows:
27493
27818
  type: number
27494
27819
  format: double
27495
- changeDirection:
27496
- type: string
27497
- description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
27498
- performanceTrendPoint:
27499
- type: object
27500
- required:
27501
- - timestamp
27502
- - value
27503
- properties:
27504
- timestamp:
27505
- type: string
27506
- value:
27820
+ nullable: true
27821
+ x-omitempty: true
27822
+ actualRows:
27507
27823
  type: number
27508
27824
  format: double
27509
- performanceTrendSeries:
27510
- type: object
27511
- required:
27512
- - metric
27513
- - displayName
27514
- - category
27515
- - unit
27516
- - points
27517
- properties:
27518
- metric:
27519
- type: string
27520
- displayName:
27521
- $ref: '#/components/schemas/localizedDescription'
27522
- category:
27523
- type: string
27524
- description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
27525
- dimension:
27825
+ nullable: true
27826
+ x-omitempty: true
27827
+ nodeCount:
27828
+ type: integer
27829
+ format: int64
27830
+ maxCostNodeId:
27526
27831
  type: string
27527
- description: Optional series dimension. Values include cluster, instance, pvc, and database.
27528
- labels:
27529
- type: object
27530
- additionalProperties:
27531
- type: string
27532
- description: Optional dimension labels, for example instance, pvc, role, or datname.
27533
- unit:
27832
+ nullable: true
27833
+ x-omitempty: true
27834
+ maxRowsNodeId:
27534
27835
  type: string
27535
- warnThreshold:
27536
- type: number
27537
- format: double
27538
- description: Optional warning threshold in the same unit as this metric.
27539
- critThreshold:
27540
- type: number
27541
- format: double
27542
- description: Optional critical threshold in the same unit as this metric.
27543
- thresholdDirection:
27836
+ nullable: true
27837
+ x-omitempty: true
27838
+ maxTimeNodeId:
27544
27839
  type: string
27545
- description: Optional threshold direction. Values are above, below, or boolean.
27546
- points:
27547
- type: array
27548
- items:
27549
- $ref: '#/components/schemas/performanceTrendPoint'
27550
- performanceTrendSource:
27840
+ nullable: true
27841
+ x-omitempty: true
27842
+ DmsExecutionPlanWarningSeverity:
27843
+ type: string
27844
+ enum:
27845
+ - info
27846
+ - warning
27847
+ - critical
27848
+ DmsExecutionPlanWarning:
27551
27849
  type: object
27552
- required:
27553
- - name
27554
- - kind
27555
- - status
27556
- - collectedAt
27557
27850
  properties:
27558
- name:
27559
- type: string
27560
- kind:
27561
- type: string
27562
- status:
27851
+ code:
27563
27852
  type: string
27564
- description: Coarse source status. Values are success, partial, failed, skipped, or noData.
27565
- collectedAt:
27853
+ severity:
27854
+ $ref: '#/components/schemas/DmsExecutionPlanWarningSeverity'
27855
+ nodeId:
27566
27856
  type: string
27857
+ nullable: true
27858
+ x-omitempty: true
27567
27859
  message:
27568
27860
  type: string
27569
- performanceTrends:
27861
+ DmsExecutionPlanResult:
27570
27862
  type: object
27571
- required:
27572
- - range
27573
- - granularity
27574
- - summary
27575
- - series
27576
- - sources
27577
- - warnings
27578
- - collectedAt
27579
27863
  properties:
27580
- range:
27581
- $ref: '#/components/schemas/performanceTrendRange'
27582
- granularity:
27864
+ originSQL:
27583
27865
  type: string
27584
- description: Controlled backend query step.
27585
- summary:
27866
+ explainSQL:
27867
+ type: string
27868
+ nullable: true
27869
+ x-omitempty: true
27870
+ engineType:
27871
+ type: string
27872
+ mode:
27873
+ $ref: '#/components/schemas/DmsExecutionPlanMode'
27874
+ planMode:
27875
+ $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
27876
+ parameterized:
27877
+ type: boolean
27878
+ x-omitempty: false
27879
+ parameterCount:
27880
+ type: integer
27881
+ format: int64
27882
+ nullable: true
27883
+ x-omitempty: true
27884
+ hasActualStats:
27885
+ type: boolean
27886
+ x-omitempty: false
27887
+ rawFormat:
27888
+ $ref: '#/components/schemas/DmsExecutionPlanRawFormat'
27889
+ rawPlan:
27890
+ type: object
27891
+ description: Engine-native raw plan payload exposed for fallback display. SDKs model it as a free-form JSON object.
27892
+ additionalProperties: true
27893
+ x-omitempty: true
27894
+ rootNodeIds:
27586
27895
  type: array
27587
- description: Per-series numeric summary. changeDirection is present only when at least two points exist.
27588
27896
  items:
27589
- $ref: '#/components/schemas/performanceTrendSummary'
27590
- series:
27897
+ type: string
27898
+ nodes:
27591
27899
  type: array
27592
- description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
27593
27900
  items:
27594
- $ref: '#/components/schemas/performanceTrendSeries'
27595
- sources:
27901
+ $ref: '#/components/schemas/DmsExecutionPlanNode'
27902
+ edges:
27596
27903
  type: array
27597
- description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
27598
27904
  items:
27599
- $ref: '#/components/schemas/performanceTrendSource'
27905
+ $ref: '#/components/schemas/DmsExecutionPlanEdge'
27906
+ summary:
27907
+ $ref: '#/components/schemas/DmsExecutionPlanSummary'
27908
+ nullable: true
27909
+ x-omitempty: true
27600
27910
  warnings:
27601
27911
  type: array
27602
27912
  items:
27603
- type: string
27604
- collectedAt:
27913
+ $ref: '#/components/schemas/DmsExecutionPlanWarning'
27914
+ fallbackTable:
27915
+ $ref: '#/components/schemas/DmsQueryResponse'
27916
+ nullable: true
27917
+ x-omitempty: true
27918
+ postgresqlSQLFingerprintExplainResponse:
27919
+ type: object
27920
+ required:
27921
+ - queryID
27922
+ - fingerprint
27923
+ - database
27924
+ - user
27925
+ - topLevel
27926
+ - planMode
27927
+ - parameterized
27928
+ - explainResult
27929
+ properties:
27930
+ queryID:
27605
27931
  type: string
27606
- description: Backend collection timestamp in UTC.
27932
+ description: PostgreSQL pg_stat_statements queryid represented as a string.
27933
+ fingerprint:
27934
+ type: string
27935
+ description: Stable SQL fingerprint identifier for UI grouping. Currently aligned with PostgreSQL pg_stat_statements queryid.
27936
+ database:
27937
+ type: string
27938
+ description: Database name from the requested SQL fingerprint identity.
27939
+ user:
27940
+ type: string
27941
+ description: Database user from the requested SQL fingerprint identity.
27942
+ topLevel:
27943
+ type: boolean
27944
+ description: Top-level flag from the requested SQL fingerprint identity.
27945
+ statementSource:
27946
+ type: string
27947
+ description: Server-side source used to resolve the parameterized SQL statement. Raw SQL is not returned.
27948
+ statementResolvedAt:
27949
+ type: string
27950
+ description: Timestamp when the parameterized SQL statement was resolved.
27951
+ planMode:
27952
+ $ref: '#/components/schemas/DmsExecutionPlanPlanningMode'
27953
+ description: Whether DMS produced a standard estimated plan or a generic parameterized estimated plan.
27954
+ parameterized:
27955
+ type: boolean
27956
+ description: Whether generic parameterized planning was used (planMode is generic). False means standard planning, not that historical parameter values were used. This endpoint never retrieves historical parameter values.
27957
+ x-omitempty: false
27958
+ parameterCount:
27959
+ type: integer
27960
+ format: int64
27961
+ nullable: true
27962
+ x-omitempty: true
27963
+ description: Number of parameters when DMS can determine it. It may be omitted for PostgreSQL generic-plan paths that do not expose the count.
27964
+ explainResult:
27965
+ $ref: '#/components/schemas/DmsExecutionPlanResult'
27966
+ description: Normalized DMS estimated visual plan. The resolved statement and generated EXPLAIN SQL are intentionally removed.
27607
27967
  elasticsearchHotThreadsType:
27608
27968
  type: string
27609
27969
  enum:
@@ -37063,6 +37423,163 @@ components:
37063
37423
  description: Roles granted to the account, separated by commas.
37064
37424
  type:
37065
37425
  $ref: '#/components/schemas/CkAccountType'
37426
+ OracleTablespaceFile:
37427
+ type: object
37428
+ required:
37429
+ - id
37430
+ - name
37431
+ - status
37432
+ - allocatedSizeMB
37433
+ - usedSizeMB
37434
+ - autoExtend
37435
+ - nextSizeMB
37436
+ - maxSizeMB
37437
+ properties:
37438
+ id:
37439
+ type: integer
37440
+ format: int64
37441
+ name:
37442
+ type: string
37443
+ status:
37444
+ type: string
37445
+ allocatedSizeMB:
37446
+ type: number
37447
+ format: double
37448
+ usedSizeMB:
37449
+ type: number
37450
+ format: double
37451
+ autoExtend:
37452
+ type: boolean
37453
+ nextSizeMB:
37454
+ type: number
37455
+ format: double
37456
+ maxSizeMB:
37457
+ type: number
37458
+ format: double
37459
+ OracleTablespace:
37460
+ type: object
37461
+ description: Oracle tablespace in the datasource connection's current container. Sizes are in MiB. Supports Oracle 12c and 19c.
37462
+ required:
37463
+ - name
37464
+ - contents
37465
+ - status
37466
+ - bigfile
37467
+ - blockSize
37468
+ - containerName
37469
+ - isDefault
37470
+ - allocatedSizeMB
37471
+ - usedSizeMB
37472
+ - maxSizeMB
37473
+ - files
37474
+ properties:
37475
+ name:
37476
+ type: string
37477
+ contents:
37478
+ type: string
37479
+ description: PERMANENT, TEMPORARY, or UNDO.
37480
+ status:
37481
+ type: string
37482
+ bigfile:
37483
+ type: boolean
37484
+ blockSize:
37485
+ type: integer
37486
+ format: int64
37487
+ containerName:
37488
+ type: string
37489
+ isDefault:
37490
+ type: boolean
37491
+ description: Whether this is a default permanent or temporary tablespace, including default temporary group members.
37492
+ allocatedSizeMB:
37493
+ type: number
37494
+ format: double
37495
+ usedSizeMB:
37496
+ type: number
37497
+ format: double
37498
+ description: Allocated file space minus free extents, or temporary file space currently allocated to temporary segments.
37499
+ maxSizeMB:
37500
+ type: number
37501
+ format: double
37502
+ description: Configured file growth limit; does not imply available disk capacity.
37503
+ files:
37504
+ type: array
37505
+ items:
37506
+ $ref: '#/components/schemas/OracleTablespaceFile'
37507
+ OracleTablespaceContents:
37508
+ type: string
37509
+ enum:
37510
+ - PERMANENT
37511
+ - TEMPORARY
37512
+ description: New tablespaces default to PERMANENT when omitted.
37513
+ OracleTablespaceFileSpec:
37514
+ type: object
37515
+ required:
37516
+ - sizeMB
37517
+ properties:
37518
+ name:
37519
+ type: string
37520
+ description: Absolute database-server file path or ASM destination. Omit to use Oracle Managed Files (DB_CREATE_FILE_DEST must be configured). Existing files are never reused.
37521
+ maxLength: 1024
37522
+ sizeMB:
37523
+ type: integer
37524
+ format: int64
37525
+ minimum: 1
37526
+ autoExtend:
37527
+ type: boolean
37528
+ default: false
37529
+ nextSizeMB:
37530
+ type: integer
37531
+ format: int64
37532
+ minimum: 0
37533
+ description: Required positive increment when autoExtend is true; otherwise omit.
37534
+ maxSizeMB:
37535
+ type: integer
37536
+ format: int64
37537
+ minimum: 0
37538
+ description: Maximum size when autoExtend is true; zero or omitted means UNLIMITED. Otherwise omit.
37539
+ OracleTablespaceCreate:
37540
+ type: object
37541
+ required:
37542
+ - name
37543
+ - files
37544
+ properties:
37545
+ name:
37546
+ type: string
37547
+ pattern: ^[A-Za-z][A-Za-z0-9_$#]{0,29}$
37548
+ description: Converted to uppercase. Limited to 30 ASCII bytes for compatibility with Oracle 12.1.
37549
+ contents:
37550
+ $ref: '#/components/schemas/OracleTablespaceContents'
37551
+ bigfile:
37552
+ type: boolean
37553
+ default: false
37554
+ files:
37555
+ type: array
37556
+ minItems: 1
37557
+ description: Exactly one file for BIGFILE tablespaces.
37558
+ items:
37559
+ $ref: '#/components/schemas/OracleTablespaceFileSpec'
37560
+ OracleTablespaceExpandAction:
37561
+ type: string
37562
+ enum:
37563
+ - resize
37564
+ - addFile
37565
+ OracleTablespaceExpand:
37566
+ type: object
37567
+ description: One DDL operation per request. Use resize with fileId and sizeMB, or addFile with file. Shrinking and adding files to BIGFILE tablespaces are rejected.
37568
+ required:
37569
+ - action
37570
+ properties:
37571
+ action:
37572
+ $ref: '#/components/schemas/OracleTablespaceExpandAction'
37573
+ fileId:
37574
+ type: integer
37575
+ format: int64
37576
+ minimum: 1
37577
+ sizeMB:
37578
+ type: integer
37579
+ format: int64
37580
+ minimum: 1
37581
+ file:
37582
+ $ref: '#/components/schemas/OracleTablespaceFileSpec'
37066
37583
  DmFile:
37067
37584
  type: object
37068
37585
  required: