kb-cloud-client-typescript 2.4.0-alpha.123 → 2.4.0-alpha.124

package/src/adminapi/models/clickhouse-source.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSource
+ */
+export interface ClickhouseSource {
+    /**
+     * Source expression, for example clusterAllReplicas(\'ck\', system.processes).
+     * @type {string}
+     * @memberof ClickhouseSource
+     */
+    'name'?: string;
+    /**
+     * Logical source kind (system table or collection step).
+     * @type {string}
+     * @memberof ClickhouseSource
+     */
+    'kind'?: string;
+    /**
+     * Collection status (success, partial, failed).
+     * @type {string}
+     * @memberof ClickhouseSource
+     */
+    'status'?: string;
+    /**
+     * Short human-readable status detail.
+     * @type {string}
+     * @memberof ClickhouseSource
+     */
+    'message'?: string;
+}
+

package/src/adminapi/models/clickhouse-space-analysis.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseMerge } from './clickhouse-merge';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseMutation } from './clickhouse-mutation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhousePartitionSpace } from './clickhouse-partition-space';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSource } from './clickhouse-source';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSpaceSummary } from './clickhouse-space-summary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseTableSpace } from './clickhouse-table-space';
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSpaceAnalysis
+ */
+export interface ClickhouseSpaceAnalysis {
+    /**
+     * Collection time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'collectedAt': string;
+    /**
+     * success when all sources were collected, partial when at least one best-effort source failed.
+     * @type {string}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'status': string;
+    /**
+     * Database filter applied to the collection, empty when all databases are included.
+     * @type {string}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'database'?: string;
+    /**
+     * 
+     * @type {ClickhouseSpaceSummary}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'summary'?: ClickhouseSpaceSummary;
+    /**
+     * Top tables ordered by physical bytes_on_disk. Totals are physical usage across all hosts, not deduplicated logical usage.
+     * @type {Array<ClickhouseTableSpace>}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'tables': Array<ClickhouseTableSpace>;
+    /**
+     * Top partitions ordered by physical bytes_on_disk.
+     * @type {Array<ClickhousePartitionSpace>}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'partitions': Array<ClickhousePartitionSpace>;
+    /**
+     * In-progress background merges from system.merges ordered by elapsed time.
+     * @type {Array<ClickhouseMerge>}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'merges': Array<ClickhouseMerge>;
+    /**
+     * Unfinished mutations from system.mutations ordered by creation time.
+     * @type {Array<ClickhouseMutation>}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'mutations': Array<ClickhouseMutation>;
+    /**
+     * Per-source collection status.
+     * @type {Array<ClickhouseSource>}
+     * @memberof ClickhouseSpaceAnalysis
+     */
+    'sources': Array<ClickhouseSource>;
+}
+

package/src/adminapi/models/clickhouse-space-summary.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSpaceSummary
+ */
+export interface ClickhouseSpaceSummary {
+    /**
+     * Number of databases with active parts.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'databaseCount'?: number;
+    /**
+     * Number of tables with active parts.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'tableCount'?: number;
+    /**
+     * Physical bytes_on_disk across all hosts.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'totalBytes'?: number;
+    /**
+     * Sum of data_compressed_bytes.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'dataCompressedBytes'?: number;
+    /**
+     * Sum of data_uncompressed_bytes.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'dataUncompressedBytes'?: number;
+    /**
+     * data_compressed_bytes / data_uncompressed_bytes. Lower is better; zero when uncompressed size is unknown.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'compressionRatio'?: number;
+    /**
+     * Sum of active part rows across all hosts.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'totalRows'?: number;
+    /**
+     * Number of active parts across all hosts.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'activeParts'?: number;
+    /**
+     * Sum of per-table partition counts. Replicated partitions can be counted more than once.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'partitionCount'?: number;
+    /**
+     * Tables whose active part count reached parts_to_delay_insert.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'warningTables'?: number;
+    /**
+     * Tables whose active part count reached parts_to_throw_insert.
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'criticalTables'?: number;
+    /**
+     * Effective parts_to_delay_insert from system.merge_tree_settings (default 150).
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'partsToDelayInsert'?: number;
+    /**
+     * Effective parts_to_throw_insert from system.merge_tree_settings (default 300).
+     * @type {number}
+     * @memberof ClickhouseSpaceSummary
+     */
+    'partsToThrowInsert'?: number;
+}
+

package/src/adminapi/models/clickhouse-sqlanalysis-range.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSQLAnalysisRange
+ */
+export interface ClickhouseSQLAnalysisRange {
+    /**
+     * Requested range label (1h, 6h, 24h, 7d).
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysisRange
+     */
+    'label'?: string;
+    /**
+     * Range start in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysisRange
+     */
+    'start'?: string;
+    /**
+     * Range end in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysisRange
+     */
+    'end'?: string;
+    /**
+     * Range duration in seconds.
+     * @type {number}
+     * @memberof ClickhouseSQLAnalysisRange
+     */
+    'durationSeconds'?: number;
+}
+

package/src/adminapi/models/clickhouse-sqlanalysis.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseFailedQuery } from './clickhouse-failed-query';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseQueryPattern } from './clickhouse-query-pattern';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSQLAnalysisRange } from './clickhouse-sqlanalysis-range';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSQLSummary } from './clickhouse-sqlsummary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSlowQuery } from './clickhouse-slow-query';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSource } from './clickhouse-source';
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSQLAnalysis
+ */
+export interface ClickhouseSQLAnalysis {
+    /**
+     * Collection time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'collectedAt': string;
+    /**
+     * available when system.query_log was collected, unavailable when query logging is disabled or the table is missing.
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'status': string;
+    /**
+     * Stable reason code when status is unavailable, for example query_log_unavailable.
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'unavailableReason'?: string;
+    /**
+     * Human-readable guidance when the analysis is unavailable.
+     * @type {string}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'message'?: string;
+    /**
+     * 
+     * @type {ClickhouseSQLAnalysisRange}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'range'?: ClickhouseSQLAnalysisRange;
+    /**
+     * 
+     * @type {ClickhouseSQLSummary}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'summary'?: ClickhouseSQLSummary;
+    /**
+     * Top initial queries ordered by query_duration_ms descending. Distributed child queries are excluded via is_initial_query = 1.
+     * @type {Array<ClickhouseSlowQuery>}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'slowestQueries': Array<ClickhouseSlowQuery>;
+    /**
+     * Query patterns grouped by normalized_query_hash and ordered by the requested metric.
+     * @type {Array<ClickhouseQueryPattern>}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'patterns': Array<ClickhouseQueryPattern>;
+    /**
+     * Failed queries (type = ExceptionWhileProcessing) ordered by event_time descending.
+     * @type {Array<ClickhouseFailedQuery>}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'failures': Array<ClickhouseFailedQuery>;
+    /**
+     * Per-source collection status.
+     * @type {Array<ClickhouseSource>}
+     * @memberof ClickhouseSQLAnalysis
+     */
+    'sources': Array<ClickhouseSource>;
+}
+

package/src/adminapi/models/clickhouse-sqlsummary.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseSQLSummary
+ */
+export interface ClickhouseSQLSummary {
+    /**
+     * Finished and failed queries in the selected range.
+     * @type {number}
+     * @memberof ClickhouseSQLSummary
+     */
+    'queryCount'?: number;
+    /**
+     * Queries that ended with ExceptionWhileProcessing.
+     * @type {number}
+     * @memberof ClickhouseSQLSummary
+     */
+    'failedCount'?: number;
+    /**
+     * Queries whose duration is at least 1000 ms.
+     * @type {number}
+     * @memberof ClickhouseSQLSummary
+     */
+    'slowQueryCount'?: number;
+    /**
+     * Sum of query_duration_ms for all finished and failed queries.
+     * @type {number}
+     * @memberof ClickhouseSQLSummary
+     */
+    'totalDurationMs'?: number;
+}
+

package/src/adminapi/models/clickhouse-table-space.ts

@@ -0,0 +1,111 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseDiskUsage } from './clickhouse-disk-usage';
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseTableSpace
+ */
+export interface ClickhouseTableSpace {
+    /**
+     * Database name.
+     * @type {string}
+     * @memberof ClickhouseTableSpace
+     */
+    'database'?: string;
+    /**
+     * Table name.
+     * @type {string}
+     * @memberof ClickhouseTableSpace
+     */
+    'table'?: string;
+    /**
+     * Table engine.
+     * @type {string}
+     * @memberof ClickhouseTableSpace
+     */
+    'engine'?: string;
+    /**
+     * Physical bytes_on_disk across all hosts and disks.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'bytesOnDisk'?: number;
+    /**
+     * Sum of data_compressed_bytes.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'dataCompressedBytes'?: number;
+    /**
+     * Sum of data_uncompressed_bytes.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'dataUncompressedBytes'?: number;
+    /**
+     * data_compressed_bytes / data_uncompressed_bytes.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'compressionRatio'?: number;
+    /**
+     * Sum of active part rows.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'rows'?: number;
+    /**
+     * Active part count used for the Too many parts risk check.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'activeParts'?: number;
+    /**
+     * Distinct partitions across disks and hosts.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'partitionCount'?: number;
+    /**
+     * Number of hosts that own active parts for this table.
+     * @type {number}
+     * @memberof ClickhouseTableSpace
+     */
+    'hosts'?: number;
+    /**
+     * Latest part modification time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseTableSpace
+     */
+    'lastModifiedAt'?: string;
+    /**
+     * normal, warning (parts >= parts_to_delay_insert) or critical (parts >= parts_to_throw_insert).
+     * @type {string}
+     * @memberof ClickhouseTableSpace
+     */
+    'risk'?: string;
+    /**
+     * Per-disk and per-host breakdown.
+     * @type {Array<ClickhouseDiskUsage>}
+     * @memberof ClickhouseTableSpace
+     */
+    'disks'?: Array<ClickhouseDiskUsage>;
+}
+

package/src/adminapi/models/index.ts

@@ -169,6 +169,26 @@ export * from './ck-account-type';
 export * from './class';
 export * from './class-batch';
 export * from './class-type';
+export * from './clickhouse-cluster-health';
+export * from './clickhouse-cluster-health-summary';
+export * from './clickhouse-cluster-node';
+export * from './clickhouse-disk-usage';
+export * from './clickhouse-failed-query';
+export * from './clickhouse-merge';
+export * from './clickhouse-mutation';
+export * from './clickhouse-partition-space';
+export * from './clickhouse-query-pattern';
+export * from './clickhouse-replica-health';
+export * from './clickhouse-sqlanalysis';
+export * from './clickhouse-sqlanalysis-range';
+export * from './clickhouse-sqlsummary';
+export * from './clickhouse-session';
+export * from './clickhouse-session-list';
+export * from './clickhouse-slow-query';
+export * from './clickhouse-source';
+export * from './clickhouse-space-analysis';
+export * from './clickhouse-space-summary';
+export * from './clickhouse-table-space';
 export * from './cloud-resource-clean-policy';
 export * from './cluster';
 export * from './cluster-backup';