kb-cloud-client-typescript 2.3.0-alpha.129 → 2.3.0-alpha.131
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.
- package/dist/adminapi/apis/diagnostics-api.d.ts +80 -0
- package/dist/adminapi/apis/diagnostics-api.d.ts.map +1 -1
- package/dist/adminapi/apis/diagnostics-api.js +84 -0
- package/dist/adminapi/apis/diagnostics-api.js.map +1 -1
- package/dist/adminapi/models/cdc-settings.d.ts +10 -6
- package/dist/adminapi/models/cdc-settings.d.ts.map +1 -1
- package/dist/adminapi/models/cdc-sql-executor.d.ts +6 -0
- package/dist/adminapi/models/cdc-sql-executor.d.ts.map +1 -1
- package/dist/adminapi/models/engine-mapping.d.ts +7 -0
- package/dist/adminapi/models/engine-mapping.d.ts.map +1 -1
- package/dist/adminapi/models/index.d.ts +7 -0
- package/dist/adminapi/models/index.d.ts.map +1 -1
- package/dist/adminapi/models/index.js +7 -0
- package/dist/adminapi/models/index.js.map +1 -1
- package/dist/adminapi/models/performance-trend-point.d.ts +31 -0
- package/dist/adminapi/models/performance-trend-point.d.ts.map +1 -0
- package/dist/adminapi/models/performance-trend-point.js +16 -0
- package/dist/adminapi/models/performance-trend-point.js.map +1 -0
- package/dist/adminapi/models/performance-trend-range.d.ts +43 -0
- package/dist/adminapi/models/performance-trend-range.d.ts.map +1 -0
- package/dist/adminapi/models/performance-trend-range.js +16 -0
- package/dist/adminapi/models/performance-trend-range.js.map +1 -0
- package/dist/adminapi/models/performance-trend-series.d.ts +83 -0
- package/dist/adminapi/models/performance-trend-series.d.ts.map +1 -0
- package/dist/adminapi/models/performance-trend-series.js +16 -0
- package/dist/adminapi/models/performance-trend-series.js.map +1 -0
- package/dist/adminapi/models/performance-trend-source.d.ts +49 -0
- package/dist/adminapi/models/performance-trend-source.d.ts.map +1 -0
- package/dist/adminapi/models/performance-trend-source.js +16 -0
- package/dist/adminapi/models/performance-trend-source.js.map +1 -0
- package/dist/adminapi/models/performance-trend-summary.d.ts +106 -0
- package/dist/adminapi/models/performance-trend-summary.d.ts.map +1 -0
- package/dist/adminapi/models/performance-trend-summary.js +16 -0
- package/dist/adminapi/models/performance-trend-summary.js.map +1 -0
- package/dist/adminapi/models/performance-trends.d.ts +65 -0
- package/dist/adminapi/models/performance-trends.d.ts.map +1 -0
- package/dist/adminapi/models/performance-trends.js +16 -0
- package/dist/adminapi/models/performance-trends.js.map +1 -0
- package/dist/adminapi/models/select-module-mode.d.ts +22 -0
- package/dist/adminapi/models/select-module-mode.d.ts.map +1 -0
- package/dist/adminapi/models/select-module-mode.js +26 -0
- package/dist/adminapi/models/select-module-mode.js.map +1 -0
- package/dist/openapi/apis/diagnostics-api.d.ts +80 -0
- package/dist/openapi/apis/diagnostics-api.d.ts.map +1 -1
- package/dist/openapi/apis/diagnostics-api.js +84 -0
- package/dist/openapi/apis/diagnostics-api.js.map +1 -1
- package/dist/openapi/models/cdc-settings.d.ts +10 -6
- package/dist/openapi/models/cdc-settings.d.ts.map +1 -1
- package/dist/openapi/models/cdc-sql-executor.d.ts +6 -0
- package/dist/openapi/models/cdc-sql-executor.d.ts.map +1 -1
- package/dist/openapi/models/engine-mapping.d.ts +7 -0
- package/dist/openapi/models/engine-mapping.d.ts.map +1 -1
- package/dist/openapi/models/index.d.ts +7 -0
- package/dist/openapi/models/index.d.ts.map +1 -1
- package/dist/openapi/models/index.js +7 -0
- package/dist/openapi/models/index.js.map +1 -1
- package/dist/openapi/models/performance-trend-point.d.ts +31 -0
- package/dist/openapi/models/performance-trend-point.d.ts.map +1 -0
- package/dist/openapi/models/performance-trend-point.js +16 -0
- package/dist/openapi/models/performance-trend-point.js.map +1 -0
- package/dist/openapi/models/performance-trend-range.d.ts +43 -0
- package/dist/openapi/models/performance-trend-range.d.ts.map +1 -0
- package/dist/openapi/models/performance-trend-range.js +16 -0
- package/dist/openapi/models/performance-trend-range.js.map +1 -0
- package/dist/openapi/models/performance-trend-series.d.ts +83 -0
- package/dist/openapi/models/performance-trend-series.d.ts.map +1 -0
- package/dist/openapi/models/performance-trend-series.js +16 -0
- package/dist/openapi/models/performance-trend-series.js.map +1 -0
- package/dist/openapi/models/performance-trend-source.d.ts +49 -0
- package/dist/openapi/models/performance-trend-source.d.ts.map +1 -0
- package/dist/openapi/models/performance-trend-source.js +16 -0
- package/dist/openapi/models/performance-trend-source.js.map +1 -0
- package/dist/openapi/models/performance-trend-summary.d.ts +106 -0
- package/dist/openapi/models/performance-trend-summary.d.ts.map +1 -0
- package/dist/openapi/models/performance-trend-summary.js +16 -0
- package/dist/openapi/models/performance-trend-summary.js.map +1 -0
- package/dist/openapi/models/performance-trends.d.ts +65 -0
- package/dist/openapi/models/performance-trends.d.ts.map +1 -0
- package/dist/openapi/models/performance-trends.js +16 -0
- package/dist/openapi/models/performance-trends.js.map +1 -0
- package/dist/openapi/models/select-module-mode.d.ts +22 -0
- package/dist/openapi/models/select-module-mode.d.ts.map +1 -0
- package/dist/openapi/models/select-module-mode.js +26 -0
- package/dist/openapi/models/select-module-mode.js.map +1 -0
- package/package.json +1 -1
- package/src/adminapi/.openapi-generator/FILES +7 -0
- package/src/adminapi/apis/diagnostics-api.ts +140 -0
- package/src/adminapi/models/cdc-settings.ts +6 -6
- package/src/adminapi/models/cdc-sql-executor.ts +6 -0
- package/src/adminapi/models/engine-mapping.ts +11 -0
- package/src/adminapi/models/index.ts +7 -0
- package/src/adminapi/models/performance-trend-point.ts +36 -0
- package/src/adminapi/models/performance-trend-range.ts +48 -0
- package/src/adminapi/models/performance-trend-series.ts +90 -0
- package/src/adminapi/models/performance-trend-source.ts +54 -0
- package/src/adminapi/models/performance-trend-summary.ts +111 -0
- package/src/adminapi/models/performance-trends.ts +78 -0
- package/src/adminapi/models/select-module-mode.ts +31 -0
- package/src/adminapi.yaml +249 -2
- package/src/openapi/.openapi-generator/FILES +7 -0
- package/src/openapi/apis/diagnostics-api.ts +140 -0
- package/src/openapi/models/cdc-settings.ts +6 -6
- package/src/openapi/models/cdc-sql-executor.ts +6 -0
- package/src/openapi/models/engine-mapping.ts +11 -0
- package/src/openapi/models/index.ts +7 -0
- package/src/openapi/models/performance-trend-point.ts +36 -0
- package/src/openapi/models/performance-trend-range.ts +48 -0
- package/src/openapi/models/performance-trend-series.ts +90 -0
- package/src/openapi/models/performance-trend-source.ts +54 -0
- package/src/openapi/models/performance-trend-summary.ts +111 -0
- package/src/openapi/models/performance-trends.ts +78 -0
- package/src/openapi/models/select-module-mode.ts +31 -0
- package/src/openapi.yaml +249 -2
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Admin API
|
|
5
|
+
* The Admin API is used to manage the ApeCloud platform.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@apecloud.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
// May contain unused imports in some cases
|
|
17
|
+
// @ts-ignore
|
|
18
|
+
import type { PerformanceTrendRange } from './performance-trend-range';
|
|
19
|
+
// May contain unused imports in some cases
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import type { PerformanceTrendSeries } from './performance-trend-series';
|
|
22
|
+
// May contain unused imports in some cases
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import type { PerformanceTrendSource } from './performance-trend-source';
|
|
25
|
+
// May contain unused imports in some cases
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { PerformanceTrendSummary } from './performance-trend-summary';
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @export
|
|
32
|
+
* @interface PerformanceTrends
|
|
33
|
+
*/
|
|
34
|
+
export interface PerformanceTrends {
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {PerformanceTrendRange}
|
|
38
|
+
* @memberof PerformanceTrends
|
|
39
|
+
*/
|
|
40
|
+
'range': PerformanceTrendRange;
|
|
41
|
+
/**
|
|
42
|
+
* Controlled backend query step.
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof PerformanceTrends
|
|
45
|
+
*/
|
|
46
|
+
'granularity': string;
|
|
47
|
+
/**
|
|
48
|
+
* Per-series numeric summary. changeDirection is present only when at least two points exist.
|
|
49
|
+
* @type {Array<PerformanceTrendSummary>}
|
|
50
|
+
* @memberof PerformanceTrends
|
|
51
|
+
*/
|
|
52
|
+
'summary': Array<PerformanceTrendSummary>;
|
|
53
|
+
/**
|
|
54
|
+
* Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
|
|
55
|
+
* @type {Array<PerformanceTrendSeries>}
|
|
56
|
+
* @memberof PerformanceTrends
|
|
57
|
+
*/
|
|
58
|
+
'series': Array<PerformanceTrendSeries>;
|
|
59
|
+
/**
|
|
60
|
+
* Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
|
|
61
|
+
* @type {Array<PerformanceTrendSource>}
|
|
62
|
+
* @memberof PerformanceTrends
|
|
63
|
+
*/
|
|
64
|
+
'sources': Array<PerformanceTrendSource>;
|
|
65
|
+
/**
|
|
66
|
+
*
|
|
67
|
+
* @type {Array<string>}
|
|
68
|
+
* @memberof PerformanceTrends
|
|
69
|
+
*/
|
|
70
|
+
'warnings': Array<string>;
|
|
71
|
+
/**
|
|
72
|
+
* Backend collection timestamp in UTC.
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof PerformanceTrends
|
|
75
|
+
*/
|
|
76
|
+
'collectedAt': string;
|
|
77
|
+
}
|
|
78
|
+
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Admin API
|
|
5
|
+
* The Admin API is used to manage the ApeCloud platform.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
* Contact: support@apecloud.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
*
|
|
19
|
+
* @export
|
|
20
|
+
* @enum {string}
|
|
21
|
+
*/
|
|
22
|
+
|
|
23
|
+
export const SelectModuleMode = {
|
|
24
|
+
single: 'single',
|
|
25
|
+
multiple: 'multiple'
|
|
26
|
+
} as const;
|
|
27
|
+
|
|
28
|
+
export type SelectModuleMode = typeof SelectModuleMode[keyof typeof SelectModuleMode];
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
package/src/adminapi.yaml
CHANGED
|
@@ -19953,6 +19953,53 @@ paths:
|
|
|
19953
19953
|
$ref: '#/components/responses/404'
|
|
19954
19954
|
'500':
|
|
19955
19955
|
$ref: '#/components/responses/500'
|
|
19956
|
+
/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/performanceTrends:
|
|
19957
|
+
get:
|
|
19958
|
+
tags:
|
|
19959
|
+
- diagnostics
|
|
19960
|
+
summary: Get PostgreSQL performance trends
|
|
19961
|
+
description: Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
|
|
19962
|
+
operationId: getDiagnosticsPostgresqlPerformanceTrends
|
|
19963
|
+
parameters:
|
|
19964
|
+
- name: orgName
|
|
19965
|
+
in: path
|
|
19966
|
+
description: Organization name
|
|
19967
|
+
required: true
|
|
19968
|
+
schema:
|
|
19969
|
+
type: string
|
|
19970
|
+
- name: clusterName
|
|
19971
|
+
in: path
|
|
19972
|
+
description: Cluster name
|
|
19973
|
+
required: true
|
|
19974
|
+
schema:
|
|
19975
|
+
type: string
|
|
19976
|
+
- name: range
|
|
19977
|
+
in: query
|
|
19978
|
+
description: Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
|
|
19979
|
+
required: false
|
|
19980
|
+
schema:
|
|
19981
|
+
type: string
|
|
19982
|
+
- name: step
|
|
19983
|
+
in: query
|
|
19984
|
+
description: Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
|
|
19985
|
+
required: false
|
|
19986
|
+
schema:
|
|
19987
|
+
type: string
|
|
19988
|
+
responses:
|
|
19989
|
+
'200':
|
|
19990
|
+
description: OK
|
|
19991
|
+
content:
|
|
19992
|
+
application/json:
|
|
19993
|
+
schema:
|
|
19994
|
+
$ref: '#/components/schemas/performanceTrends'
|
|
19995
|
+
'400':
|
|
19996
|
+
$ref: '#/components/responses/400'
|
|
19997
|
+
'401':
|
|
19998
|
+
$ref: '#/components/responses/401'
|
|
19999
|
+
'403':
|
|
20000
|
+
$ref: '#/components/responses/403'
|
|
20001
|
+
'500':
|
|
20002
|
+
$ref: '#/components/responses/500'
|
|
19956
20003
|
/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
|
|
19957
20004
|
get:
|
|
19958
20005
|
tags:
|
|
@@ -32609,6 +32656,10 @@ components:
|
|
|
32609
32656
|
authDatabase:
|
|
32610
32657
|
type: string
|
|
32611
32658
|
nullable: true
|
|
32659
|
+
nameGroupExpression:
|
|
32660
|
+
type: string
|
|
32661
|
+
description: A regular expression containing named groups, used to extract the named groups from the SQL result and match them to the names defined in result
|
|
32662
|
+
nullable: true
|
|
32612
32663
|
cdcLifecycleAction:
|
|
32613
32664
|
type: object
|
|
32614
32665
|
properties:
|
|
@@ -32633,9 +32684,15 @@ components:
|
|
|
32633
32684
|
config:
|
|
32634
32685
|
$ref: '#/components/schemas/cdcClusterConfig'
|
|
32635
32686
|
account:
|
|
32636
|
-
|
|
32687
|
+
type: object
|
|
32688
|
+
description: engine mode and account setting mappings. '_default' key means default mode setting
|
|
32689
|
+
additionalProperties:
|
|
32690
|
+
$ref: '#/components/schemas/cdcClusterAccount'
|
|
32637
32691
|
endpoint:
|
|
32638
|
-
|
|
32692
|
+
type: object
|
|
32693
|
+
description: engine mode and account setting mappings. '_default' key means default mode setting
|
|
32694
|
+
additionalProperties:
|
|
32695
|
+
$ref: '#/components/schemas/cdcClusterEndpoint'
|
|
32639
32696
|
lifecycle:
|
|
32640
32697
|
$ref: '#/components/schemas/cdcLifecycle'
|
|
32641
32698
|
cdcConfigResourceType:
|
|
@@ -32845,6 +32902,11 @@ components:
|
|
|
32845
32902
|
$ref: '#/components/schemas/engineDefinitionDetail'
|
|
32846
32903
|
target:
|
|
32847
32904
|
$ref: '#/components/schemas/engineDefinitionDetail'
|
|
32905
|
+
selectModuleMode:
|
|
32906
|
+
enum:
|
|
32907
|
+
- single
|
|
32908
|
+
- multiple
|
|
32909
|
+
type: string
|
|
32848
32910
|
eventType:
|
|
32849
32911
|
enum:
|
|
32850
32912
|
- dml
|
|
@@ -32919,6 +32981,9 @@ components:
|
|
|
32919
32981
|
type: array
|
|
32920
32982
|
items:
|
|
32921
32983
|
type: string
|
|
32984
|
+
moduleSelectMode:
|
|
32985
|
+
$ref: '#/components/schemas/selectModuleMode'
|
|
32986
|
+
nullable: true
|
|
32922
32987
|
events:
|
|
32923
32988
|
type: array
|
|
32924
32989
|
items:
|
|
@@ -37469,6 +37534,188 @@ components:
|
|
|
37469
37534
|
description: SQL fingerprint ranking rows from pg_stat_statements. The list may be empty when no statement statistics exist.
|
|
37470
37535
|
items:
|
|
37471
37536
|
$ref: '#/components/schemas/postgresqlSQLFingerprint'
|
|
37537
|
+
performanceTrendRange:
|
|
37538
|
+
type: object
|
|
37539
|
+
required:
|
|
37540
|
+
- label
|
|
37541
|
+
- start
|
|
37542
|
+
- end
|
|
37543
|
+
- durationSeconds
|
|
37544
|
+
properties:
|
|
37545
|
+
label:
|
|
37546
|
+
type: string
|
|
37547
|
+
description: Controlled query range label. Values are 1h, 6h, or 24h.
|
|
37548
|
+
start:
|
|
37549
|
+
type: string
|
|
37550
|
+
end:
|
|
37551
|
+
type: string
|
|
37552
|
+
durationSeconds:
|
|
37553
|
+
type: integer
|
|
37554
|
+
format: int64
|
|
37555
|
+
performanceTrendSummary:
|
|
37556
|
+
type: object
|
|
37557
|
+
required:
|
|
37558
|
+
- metric
|
|
37559
|
+
- displayName
|
|
37560
|
+
- category
|
|
37561
|
+
- unit
|
|
37562
|
+
- min
|
|
37563
|
+
- max
|
|
37564
|
+
- avg
|
|
37565
|
+
- latest
|
|
37566
|
+
properties:
|
|
37567
|
+
metric:
|
|
37568
|
+
type: string
|
|
37569
|
+
displayName:
|
|
37570
|
+
$ref: '#/components/schemas/localizedDescription'
|
|
37571
|
+
category:
|
|
37572
|
+
type: string
|
|
37573
|
+
description: Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
|
|
37574
|
+
dimension:
|
|
37575
|
+
type: string
|
|
37576
|
+
description: Optional series dimension. Values include cluster, instance, pvc, and database.
|
|
37577
|
+
labels:
|
|
37578
|
+
type: object
|
|
37579
|
+
additionalProperties:
|
|
37580
|
+
type: string
|
|
37581
|
+
description: Optional dimension labels, for example instance, pvc, role, or datname.
|
|
37582
|
+
unit:
|
|
37583
|
+
type: string
|
|
37584
|
+
warnThreshold:
|
|
37585
|
+
type: number
|
|
37586
|
+
format: double
|
|
37587
|
+
description: Optional warning threshold in the same unit as this metric.
|
|
37588
|
+
critThreshold:
|
|
37589
|
+
type: number
|
|
37590
|
+
format: double
|
|
37591
|
+
description: Optional critical threshold in the same unit as this metric.
|
|
37592
|
+
thresholdDirection:
|
|
37593
|
+
type: string
|
|
37594
|
+
description: Optional threshold direction. Values are above, below, or boolean.
|
|
37595
|
+
min:
|
|
37596
|
+
type: number
|
|
37597
|
+
format: double
|
|
37598
|
+
max:
|
|
37599
|
+
type: number
|
|
37600
|
+
format: double
|
|
37601
|
+
avg:
|
|
37602
|
+
type: number
|
|
37603
|
+
format: double
|
|
37604
|
+
latest:
|
|
37605
|
+
type: number
|
|
37606
|
+
format: double
|
|
37607
|
+
changeDirection:
|
|
37608
|
+
type: string
|
|
37609
|
+
description: Change direction when at least two samples exist. Values are increasing, decreasing, or stable.
|
|
37610
|
+
performanceTrendPoint:
|
|
37611
|
+
type: object
|
|
37612
|
+
required:
|
|
37613
|
+
- timestamp
|
|
37614
|
+
- value
|
|
37615
|
+
properties:
|
|
37616
|
+
timestamp:
|
|
37617
|
+
type: string
|
|
37618
|
+
value:
|
|
37619
|
+
type: number
|
|
37620
|
+
format: double
|
|
37621
|
+
performanceTrendSeries:
|
|
37622
|
+
type: object
|
|
37623
|
+
required:
|
|
37624
|
+
- metric
|
|
37625
|
+
- displayName
|
|
37626
|
+
- category
|
|
37627
|
+
- unit
|
|
37628
|
+
- points
|
|
37629
|
+
properties:
|
|
37630
|
+
metric:
|
|
37631
|
+
type: string
|
|
37632
|
+
displayName:
|
|
37633
|
+
$ref: '#/components/schemas/localizedDescription'
|
|
37634
|
+
category:
|
|
37635
|
+
type: string
|
|
37636
|
+
description: Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
|
|
37637
|
+
dimension:
|
|
37638
|
+
type: string
|
|
37639
|
+
description: Optional series dimension. Values include cluster, instance, pvc, and database.
|
|
37640
|
+
labels:
|
|
37641
|
+
type: object
|
|
37642
|
+
additionalProperties:
|
|
37643
|
+
type: string
|
|
37644
|
+
description: Optional dimension labels, for example instance, pvc, role, or datname.
|
|
37645
|
+
unit:
|
|
37646
|
+
type: string
|
|
37647
|
+
warnThreshold:
|
|
37648
|
+
type: number
|
|
37649
|
+
format: double
|
|
37650
|
+
description: Optional warning threshold in the same unit as this metric.
|
|
37651
|
+
critThreshold:
|
|
37652
|
+
type: number
|
|
37653
|
+
format: double
|
|
37654
|
+
description: Optional critical threshold in the same unit as this metric.
|
|
37655
|
+
thresholdDirection:
|
|
37656
|
+
type: string
|
|
37657
|
+
description: Optional threshold direction. Values are above, below, or boolean.
|
|
37658
|
+
points:
|
|
37659
|
+
type: array
|
|
37660
|
+
items:
|
|
37661
|
+
$ref: '#/components/schemas/performanceTrendPoint'
|
|
37662
|
+
performanceTrendSource:
|
|
37663
|
+
type: object
|
|
37664
|
+
required:
|
|
37665
|
+
- name
|
|
37666
|
+
- kind
|
|
37667
|
+
- status
|
|
37668
|
+
- collectedAt
|
|
37669
|
+
properties:
|
|
37670
|
+
name:
|
|
37671
|
+
type: string
|
|
37672
|
+
kind:
|
|
37673
|
+
type: string
|
|
37674
|
+
status:
|
|
37675
|
+
type: string
|
|
37676
|
+
description: Coarse source status. Values are success, partial, failed, skipped, or noData.
|
|
37677
|
+
collectedAt:
|
|
37678
|
+
type: string
|
|
37679
|
+
message:
|
|
37680
|
+
type: string
|
|
37681
|
+
performanceTrends:
|
|
37682
|
+
type: object
|
|
37683
|
+
required:
|
|
37684
|
+
- range
|
|
37685
|
+
- granularity
|
|
37686
|
+
- summary
|
|
37687
|
+
- series
|
|
37688
|
+
- sources
|
|
37689
|
+
- warnings
|
|
37690
|
+
- collectedAt
|
|
37691
|
+
properties:
|
|
37692
|
+
range:
|
|
37693
|
+
$ref: '#/components/schemas/performanceTrendRange'
|
|
37694
|
+
granularity:
|
|
37695
|
+
type: string
|
|
37696
|
+
description: Controlled backend query step.
|
|
37697
|
+
summary:
|
|
37698
|
+
type: array
|
|
37699
|
+
description: Per-series numeric summary. changeDirection is present only when at least two points exist.
|
|
37700
|
+
items:
|
|
37701
|
+
$ref: '#/components/schemas/performanceTrendSummary'
|
|
37702
|
+
series:
|
|
37703
|
+
type: array
|
|
37704
|
+
description: Successfully collected and displayable metric series only. Unsupported, empty, or failed metrics are not represented as per-metric entries.
|
|
37705
|
+
items:
|
|
37706
|
+
$ref: '#/components/schemas/performanceTrendSeries'
|
|
37707
|
+
sources:
|
|
37708
|
+
type: array
|
|
37709
|
+
description: Coarse collection source status. Messages are sanitized and do not expose PromQL, endpoints, credentials, or raw internal errors.
|
|
37710
|
+
items:
|
|
37711
|
+
$ref: '#/components/schemas/performanceTrendSource'
|
|
37712
|
+
warnings:
|
|
37713
|
+
type: array
|
|
37714
|
+
items:
|
|
37715
|
+
type: string
|
|
37716
|
+
collectedAt:
|
|
37717
|
+
type: string
|
|
37718
|
+
description: Backend collection timestamp in UTC.
|
|
37472
37719
|
postgresqlLockRow:
|
|
37473
37720
|
type: object
|
|
37474
37721
|
required:
|
|
@@ -647,6 +647,12 @@ models/parameter-value-type.ts
|
|
|
647
647
|
models/parameters-value-value.ts
|
|
648
648
|
models/partition-info.ts
|
|
649
649
|
models/partition.ts
|
|
650
|
+
models/performance-trend-point.ts
|
|
651
|
+
models/performance-trend-range.ts
|
|
652
|
+
models/performance-trend-series.ts
|
|
653
|
+
models/performance-trend-source.ts
|
|
654
|
+
models/performance-trend-summary.ts
|
|
655
|
+
models/performance-trends.ts
|
|
650
656
|
models/permission-list.ts
|
|
651
657
|
models/permission.ts
|
|
652
658
|
models/pg-create-extension-opt.ts
|
|
@@ -755,6 +761,7 @@ models/role-list.ts
|
|
|
755
761
|
models/role-update.ts
|
|
756
762
|
models/role.ts
|
|
757
763
|
models/scheduling-policy-type.ts
|
|
764
|
+
models/select-module-mode.ts
|
|
758
765
|
models/selected-object-option-convert-to-parameters-inner.ts
|
|
759
766
|
models/selected-object-option-tree-level-order-inner.ts
|
|
760
767
|
models/selected-object-option-tree.ts
|
|
@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
import type { APIErrorResponse } from '../models';
|
|
26
26
|
// @ts-ignore
|
|
27
|
+
import type { PerformanceTrends } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
27
29
|
import type { PostgresqlLockAnalysis } from '../models';
|
|
28
30
|
// @ts-ignore
|
|
29
31
|
import type { PostgresqlSQLAnalysis } from '../models';
|
|
@@ -37,6 +39,61 @@ import type { PostgresqlSpaceAnalysis } from '../models';
|
|
|
37
39
|
*/
|
|
38
40
|
export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
39
41
|
return {
|
|
42
|
+
/**
|
|
43
|
+
* Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
|
|
44
|
+
* @summary Get PostgreSQL performance trends
|
|
45
|
+
* @param {string} orgName Organization name
|
|
46
|
+
* @param {string} clusterName Cluster name
|
|
47
|
+
* @param {string} [range] Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
|
|
48
|
+
* @param {string} [step] Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
|
|
49
|
+
* @param {*} [options] Override http request option.
|
|
50
|
+
* @throws {RequiredError}
|
|
51
|
+
*/
|
|
52
|
+
getDiagnosticsPostgresqlPerformanceTrends: async (orgName: string, clusterName: string, range?: string, step?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53
|
+
// verify required parameter 'orgName' is not null or undefined
|
|
54
|
+
assertParamExists('getDiagnosticsPostgresqlPerformanceTrends', 'orgName', orgName)
|
|
55
|
+
// verify required parameter 'clusterName' is not null or undefined
|
|
56
|
+
assertParamExists('getDiagnosticsPostgresqlPerformanceTrends', 'clusterName', clusterName)
|
|
57
|
+
const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/performanceTrends`
|
|
58
|
+
.replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
|
|
59
|
+
.replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
|
|
60
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
61
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
62
|
+
let baseOptions;
|
|
63
|
+
if (configuration) {
|
|
64
|
+
baseOptions = configuration.baseOptions;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
68
|
+
const localVarHeaderParameter = {} as any;
|
|
69
|
+
const localVarQueryParameter = {} as any;
|
|
70
|
+
|
|
71
|
+
// authentication BearerToken required
|
|
72
|
+
// http bearer authentication required
|
|
73
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
74
|
+
|
|
75
|
+
// authentication DigestAuth required
|
|
76
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
77
|
+
|
|
78
|
+
if (range !== undefined) {
|
|
79
|
+
localVarQueryParameter['range'] = range;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
if (step !== undefined) {
|
|
83
|
+
localVarQueryParameter['step'] = step;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
89
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
90
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
91
|
+
|
|
92
|
+
return {
|
|
93
|
+
url: toPathString(localVarUrlObj),
|
|
94
|
+
options: localVarRequestOptions,
|
|
95
|
+
};
|
|
96
|
+
},
|
|
40
97
|
/**
|
|
41
98
|
* Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
|
|
42
99
|
* @summary Get PostgreSQL SQL analysis
|
|
@@ -300,6 +357,22 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
300
357
|
export const DiagnosticsApiFp = function(configuration?: Configuration) {
|
|
301
358
|
const localVarAxiosParamCreator = DiagnosticsApiAxiosParamCreator(configuration)
|
|
302
359
|
return {
|
|
360
|
+
/**
|
|
361
|
+
* Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
|
|
362
|
+
* @summary Get PostgreSQL performance trends
|
|
363
|
+
* @param {string} orgName Organization name
|
|
364
|
+
* @param {string} clusterName Cluster name
|
|
365
|
+
* @param {string} [range] Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
|
|
366
|
+
* @param {string} [step] Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
|
|
367
|
+
* @param {*} [options] Override http request option.
|
|
368
|
+
* @throws {RequiredError}
|
|
369
|
+
*/
|
|
370
|
+
async getDiagnosticsPostgresqlPerformanceTrends(orgName: string, clusterName: string, range?: string, step?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PerformanceTrends>> {
|
|
371
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlPerformanceTrends(orgName, clusterName, range, step, options);
|
|
372
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
373
|
+
const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlPerformanceTrends']?.[localVarOperationServerIndex]?.url;
|
|
374
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
375
|
+
},
|
|
303
376
|
/**
|
|
304
377
|
* Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
|
|
305
378
|
* @summary Get PostgreSQL SQL analysis
|
|
@@ -386,6 +459,16 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
|
|
|
386
459
|
export const DiagnosticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
387
460
|
const localVarFp = DiagnosticsApiFp(configuration)
|
|
388
461
|
return {
|
|
462
|
+
/**
|
|
463
|
+
* Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
|
|
464
|
+
* @summary Get PostgreSQL performance trends
|
|
465
|
+
* @param {DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest} requestParameters Request parameters.
|
|
466
|
+
* @param {*} [options] Override http request option.
|
|
467
|
+
* @throws {RequiredError}
|
|
468
|
+
*/
|
|
469
|
+
getDiagnosticsPostgresqlPerformanceTrends(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PerformanceTrends> {
|
|
470
|
+
return localVarFp.getDiagnosticsPostgresqlPerformanceTrends(requestParameters.orgName, requestParameters.clusterName, requestParameters.range, requestParameters.step, options).then((request) => request(axios, basePath));
|
|
471
|
+
},
|
|
389
472
|
/**
|
|
390
473
|
* Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
|
|
391
474
|
* @summary Get PostgreSQL SQL analysis
|
|
@@ -445,6 +528,16 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
|
|
|
445
528
|
* @interface DiagnosticsApi
|
|
446
529
|
*/
|
|
447
530
|
export interface DiagnosticsApiInterface {
|
|
531
|
+
/**
|
|
532
|
+
* Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
|
|
533
|
+
* @summary Get PostgreSQL performance trends
|
|
534
|
+
* @param {DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest} requestParameters Request parameters.
|
|
535
|
+
* @param {*} [options] Override http request option.
|
|
536
|
+
* @throws {RequiredError}
|
|
537
|
+
* @memberof DiagnosticsApiInterface
|
|
538
|
+
*/
|
|
539
|
+
getDiagnosticsPostgresqlPerformanceTrends(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PerformanceTrends>;
|
|
540
|
+
|
|
448
541
|
/**
|
|
449
542
|
* Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
|
|
450
543
|
* @summary Get PostgreSQL SQL analysis
|
|
@@ -497,6 +590,41 @@ export interface DiagnosticsApiInterface {
|
|
|
497
590
|
|
|
498
591
|
}
|
|
499
592
|
|
|
593
|
+
/**
|
|
594
|
+
* Request parameters for getDiagnosticsPostgresqlPerformanceTrends operation in DiagnosticsApi.
|
|
595
|
+
* @export
|
|
596
|
+
* @interface DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest
|
|
597
|
+
*/
|
|
598
|
+
export interface DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest {
|
|
599
|
+
/**
|
|
600
|
+
* Organization name
|
|
601
|
+
* @type {string}
|
|
602
|
+
* @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
|
|
603
|
+
*/
|
|
604
|
+
readonly orgName: string
|
|
605
|
+
|
|
606
|
+
/**
|
|
607
|
+
* Cluster name
|
|
608
|
+
* @type {string}
|
|
609
|
+
* @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
|
|
610
|
+
*/
|
|
611
|
+
readonly clusterName: string
|
|
612
|
+
|
|
613
|
+
/**
|
|
614
|
+
* Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
|
|
615
|
+
* @type {string}
|
|
616
|
+
* @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
|
|
617
|
+
*/
|
|
618
|
+
readonly range?: string
|
|
619
|
+
|
|
620
|
+
/**
|
|
621
|
+
* Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
|
|
622
|
+
* @type {string}
|
|
623
|
+
* @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
|
|
624
|
+
*/
|
|
625
|
+
readonly step?: string
|
|
626
|
+
}
|
|
627
|
+
|
|
500
628
|
/**
|
|
501
629
|
* Request parameters for getDiagnosticsPostgresqlSQLAnalysis operation in DiagnosticsApi.
|
|
502
630
|
* @export
|
|
@@ -651,6 +779,18 @@ export interface DiagnosticsApiListDiagnosticsPostgresqlSessionsRequest {
|
|
|
651
779
|
* @extends {BaseAPI}
|
|
652
780
|
*/
|
|
653
781
|
export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
|
|
782
|
+
/**
|
|
783
|
+
* Get read-only PostgreSQL performance trends from backend-owned Prometheus queries. The response does not expose SQL, PromQL, internal endpoints, or remediation actions.
|
|
784
|
+
* @summary Get PostgreSQL performance trends
|
|
785
|
+
* @param {DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest} requestParameters Request parameters.
|
|
786
|
+
* @param {*} [options] Override http request option.
|
|
787
|
+
* @throws {RequiredError}
|
|
788
|
+
* @memberof DiagnosticsApi
|
|
789
|
+
*/
|
|
790
|
+
public getDiagnosticsPostgresqlPerformanceTrends(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest, options?: RawAxiosRequestConfig) {
|
|
791
|
+
return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlPerformanceTrends(requestParameters.orgName, requestParameters.clusterName, requestParameters.range, requestParameters.step, options).then((request) => request(this.axios, this.basePath));
|
|
792
|
+
}
|
|
793
|
+
|
|
654
794
|
/**
|
|
655
795
|
* Get a read-only PostgreSQL SQL fingerprint ranking from pg_stat_statements. The response does not expose full SQL text, time-window aggregation, summary cards, slow-log relation, execution plans, or remediation actions.
|
|
656
796
|
* @summary Get PostgreSQL SQL analysis
|
|
@@ -39,17 +39,17 @@ export interface CdcSettings {
|
|
|
39
39
|
*/
|
|
40
40
|
'config'?: CdcClusterConfig;
|
|
41
41
|
/**
|
|
42
|
-
*
|
|
43
|
-
* @type {CdcClusterAccount}
|
|
42
|
+
* engine mode and account setting mappings. \'_default\' key means default mode setting
|
|
43
|
+
* @type {{ [key: string]: CdcClusterAccount; }}
|
|
44
44
|
* @memberof CdcSettings
|
|
45
45
|
*/
|
|
46
|
-
'account'?: CdcClusterAccount;
|
|
46
|
+
'account'?: { [key: string]: CdcClusterAccount; };
|
|
47
47
|
/**
|
|
48
|
-
*
|
|
49
|
-
* @type {CdcClusterEndpoint}
|
|
48
|
+
* engine mode and account setting mappings. \'_default\' key means default mode setting
|
|
49
|
+
* @type {{ [key: string]: CdcClusterEndpoint; }}
|
|
50
50
|
* @memberof CdcSettings
|
|
51
51
|
*/
|
|
52
|
-
'endpoint'?: CdcClusterEndpoint;
|
|
52
|
+
'endpoint'?: { [key: string]: CdcClusterEndpoint; };
|
|
53
53
|
/**
|
|
54
54
|
*
|
|
55
55
|
* @type {CdcLifecycle}
|
|
@@ -38,5 +38,11 @@ export interface CdcSqlExecutor {
|
|
|
38
38
|
* @memberof CdcSqlExecutor
|
|
39
39
|
*/
|
|
40
40
|
'authDatabase'?: string | null;
|
|
41
|
+
/**
|
|
42
|
+
* A regular expression containing named groups, used to extract the named groups from the SQL result and match them to the names defined in result
|
|
43
|
+
* @type {string}
|
|
44
|
+
* @memberof CdcSqlExecutor
|
|
45
|
+
*/
|
|
46
|
+
'nameGroupExpression'?: string | null;
|
|
41
47
|
}
|
|
42
48
|
|
|
@@ -25,6 +25,9 @@ import type { MappingDescription } from './mapping-description';
|
|
|
25
25
|
// May contain unused imports in some cases
|
|
26
26
|
// @ts-ignore
|
|
27
27
|
import type { ReplicationMetadataObject } from './replication-metadata-object';
|
|
28
|
+
// May contain unused imports in some cases
|
|
29
|
+
// @ts-ignore
|
|
30
|
+
import type { SelectModuleMode } from './select-module-mode';
|
|
28
31
|
|
|
29
32
|
/**
|
|
30
33
|
*
|
|
@@ -50,6 +53,12 @@ export interface EngineMapping {
|
|
|
50
53
|
* @memberof EngineMapping
|
|
51
54
|
*/
|
|
52
55
|
'modules'?: Array<string>;
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @type {SelectModuleMode}
|
|
59
|
+
* @memberof EngineMapping
|
|
60
|
+
*/
|
|
61
|
+
'moduleSelectMode'?: SelectModuleMode;
|
|
53
62
|
/**
|
|
54
63
|
*
|
|
55
64
|
* @type {Array<Array<EventObject>>}
|
|
@@ -82,3 +91,5 @@ export interface EngineMapping {
|
|
|
82
91
|
'parameterTemplate'?: { [key: string]: Array<DataChannelParameter>; };
|
|
83
92
|
}
|
|
84
93
|
|
|
94
|
+
|
|
95
|
+
|