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

package/src/adminapi/models/clickhouse-cluster-health-summary.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseClusterHealthSummary
+ */
+export interface ClickhouseClusterHealthSummary {
+    /**
+     * Number of replicated table replicas collected.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'replicaCount'?: number;
+    /**
+     * Number of nodes in system.clusters.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'nodeCount'?: number;
+    /**
+     * Number of distinct cluster names.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'clusterCount'?: number;
+    /**
+     * Sum of total_replicas across replicated tables.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'totalReplicas'?: number;
+    /**
+     * Sum of active_replicas across replicated tables.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'activeReplicas'?: number;
+    /**
+     * Replicas currently in readonly mode.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'readonlyReplicas'?: number;
+    /**
+     * Replicas whose Keeper session expired.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'sessionExpiredReplicas'?: number;
+    /**
+     * Maximum absolute_delay in seconds.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'maxAbsoluteDelaySeconds'?: number;
+    /**
+     * Sum of replication queue sizes.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'totalQueueSize'?: number;
+    /**
+     * Replicas classified as warning.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'warningReplicas'?: number;
+    /**
+     * Replicas classified as critical.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'criticalReplicas'?: number;
+    /**
+     * Nodes with connection errors, slowdowns or a non-zero estimated recovery time.
+     * @type {number}
+     * @memberof ClickhouseClusterHealthSummary
+     */
+    'unhealthyNodes'?: number;
+}
+

package/src/adminapi/models/clickhouse-cluster-health.ts

@@ -0,0 +1,84 @@
+/* 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 { ClickhouseClusterHealthSummary } from './clickhouse-cluster-health-summary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseClusterNode } from './clickhouse-cluster-node';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseReplicaHealth } from './clickhouse-replica-health';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClickhouseSource } from './clickhouse-source';
+
+/**
+ * 
+ * @export
+ * @interface ClickhouseClusterHealth
+ */
+export interface ClickhouseClusterHealth {
+    /**
+     * Collection time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseClusterHealth
+     */
+    'collectedAt': string;
+    /**
+     * Collection status. success when every source was collected, partial when topology or replicas could only be partially read.
+     * @type {string}
+     * @memberof ClickhouseClusterHealth
+     */
+    'status': string;
+    /**
+     * Derived health status. normal, warning or critical.
+     * @type {string}
+     * @memberof ClickhouseClusterHealth
+     */
+    'overallStatus'?: string;
+    /**
+     * Detected deployment mode (standalone or cluster).
+     * @type {string}
+     * @memberof ClickhouseClusterHealth
+     */
+    'clusterMode'?: string;
+    /**
+     * 
+     * @type {ClickhouseClusterHealthSummary}
+     * @memberof ClickhouseClusterHealth
+     */
+    'summary'?: ClickhouseClusterHealthSummary;
+    /**
+     * Replicated tables ordered by risk, absolute delay and queue size.
+     * @type {Array<ClickhouseReplicaHealth>}
+     * @memberof ClickhouseClusterHealth
+     */
+    'replicas': Array<ClickhouseReplicaHealth>;
+    /**
+     * Shard and replica topology from system.clusters on the connected node.
+     * @type {Array<ClickhouseClusterNode>}
+     * @memberof ClickhouseClusterHealth
+     */
+    'nodes': Array<ClickhouseClusterNode>;
+    /**
+     * Per-source collection status.
+     * @type {Array<ClickhouseSource>}
+     * @memberof ClickhouseClusterHealth
+     */
+    'sources': Array<ClickhouseSource>;
+}
+

package/src/adminapi/models/clickhouse-cluster-node.ts

@@ -0,0 +1,114 @@
+/* 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 ClickhouseClusterNode
+ */
+export interface ClickhouseClusterNode {
+    /**
+     * Cluster name.
+     * @type {string}
+     * @memberof ClickhouseClusterNode
+     */
+    'cluster'?: string;
+    /**
+     * Shard number.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'shardNum'?: number;
+    /**
+     * Shard weight.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'shardWeight'?: number;
+    /**
+     * Replica number inside the shard.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'replicaNum'?: number;
+    /**
+     * Configured host name.
+     * @type {string}
+     * @memberof ClickhouseClusterNode
+     */
+    'hostName'?: string;
+    /**
+     * Configured host address.
+     * @type {string}
+     * @memberof ClickhouseClusterNode
+     */
+    'hostAddress'?: string;
+    /**
+     * Configured TCP port.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'port'?: number;
+    /**
+     * Whether this node is the connected node.
+     * @type {boolean}
+     * @memberof ClickhouseClusterNode
+     */
+    'isLocal'?: boolean;
+    /**
+     * Configured user.
+     * @type {string}
+     * @memberof ClickhouseClusterNode
+     */
+    'user'?: string;
+    /**
+     * Configured default database.
+     * @type {string}
+     * @memberof ClickhouseClusterNode
+     */
+    'defaultDatabase'?: string;
+    /**
+     * Connection errors observed for this node.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'errorsCount'?: number;
+    /**
+     * Slowdown events observed for this node.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'slowdownsCount'?: number;
+    /**
+     * Estimated recovery time in seconds, zero when the node is healthy.
+     * @type {number}
+     * @memberof ClickhouseClusterNode
+     */
+    'estimatedRecoveryTime'?: number;
+    /**
+     * normal or warning.
+     * @type {string}
+     * @memberof ClickhouseClusterNode
+     */
+    'risk'?: string;
+    /**
+     * Detected issue codes such as connection_errors, slowdowns or estimated_recovery_time.
+     * @type {Array<string>}
+     * @memberof ClickhouseClusterNode
+     */
+    'issues'?: Array<string>;
+}
+

package/src/adminapi/models/clickhouse-disk-usage.ts

@@ -0,0 +1,66 @@
+/* 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 ClickhouseDiskUsage
+ */
+export interface ClickhouseDiskUsage {
+    /**
+     * ClickHouse disk name.
+     * @type {string}
+     * @memberof ClickhouseDiskUsage
+     */
+    'diskName'?: string;
+    /**
+     * ClickHouse server host.
+     * @type {string}
+     * @memberof ClickhouseDiskUsage
+     */
+    'hostName'?: string;
+    /**
+     * bytes_on_disk for this disk and host.
+     * @type {number}
+     * @memberof ClickhouseDiskUsage
+     */
+    'bytesOnDisk'?: number;
+    /**
+     * data_compressed_bytes for this disk and host.
+     * @type {number}
+     * @memberof ClickhouseDiskUsage
+     */
+    'dataCompressedBytes'?: number;
+    /**
+     * data_uncompressed_bytes for this disk and host.
+     * @type {number}
+     * @memberof ClickhouseDiskUsage
+     */
+    'dataUncompressedBytes'?: number;
+    /**
+     * Rows on this disk and host.
+     * @type {number}
+     * @memberof ClickhouseDiskUsage
+     */
+    'rows'?: number;
+    /**
+     * Active parts on this disk and host.
+     * @type {number}
+     * @memberof ClickhouseDiskUsage
+     */
+    'activeParts'?: number;
+}
+

package/src/adminapi/models/clickhouse-failed-query.ts

@@ -0,0 +1,90 @@
+/* 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 ClickhouseFailedQuery
+ */
+export interface ClickhouseFailedQuery {
+    /**
+     * query_log event time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'eventTime'?: string;
+    /**
+     * ClickHouse query_id.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'queryId'?: string;
+    /**
+     * User that ran the query.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'user'?: string;
+    /**
+     * Current database at execution time.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'database'?: string;
+    /**
+     * Query text with string and numeric literals and comments masked as ?.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'query'?: string;
+    /**
+     * ClickHouse exception code.
+     * @type {number}
+     * @memberof ClickhouseFailedQuery
+     */
+    'exceptionCode'?: number;
+    /**
+     * Best-effort category such as memory_limit_exceeded, timeout, too_many_parts, readonly, unknown_table or syntax_error.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'exceptionCategory'?: string;
+    /**
+     * Full exception text.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'exception'?: string;
+    /**
+     * query_duration_ms before the failure.
+     * @type {number}
+     * @memberof ClickhouseFailedQuery
+     */
+    'durationMs'?: number;
+    /**
+     * Memory usage in bytes.
+     * @type {number}
+     * @memberof ClickhouseFailedQuery
+     */
+    'memoryUsageBytes'?: number;
+    /**
+     * ClickHouse server host that ran the query.
+     * @type {string}
+     * @memberof ClickhouseFailedQuery
+     */
+    'hostName'?: string;
+}
+

package/src/adminapi/models/clickhouse-merge.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 ClickhouseMerge
+ */
+export interface ClickhouseMerge {
+    /**
+     * Database name.
+     * @type {string}
+     * @memberof ClickhouseMerge
+     */
+    'database'?: string;
+    /**
+     * Table name.
+     * @type {string}
+     * @memberof ClickhouseMerge
+     */
+    'table'?: string;
+    /**
+     * ClickHouse server host running the merge.
+     * @type {string}
+     * @memberof ClickhouseMerge
+     */
+    'hostName'?: string;
+    /**
+     * Seconds elapsed since the merge started.
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'elapsedSeconds'?: number;
+    /**
+     * Merge progress (0-1).
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'progress'?: number;
+    /**
+     * Number of source parts.
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'numParts'?: number;
+    /**
+     * Resulting part name.
+     * @type {string}
+     * @memberof ClickhouseMerge
+     */
+    'resultPartName'?: string;
+    /**
+     * Partition being merged.
+     * @type {string}
+     * @memberof ClickhouseMerge
+     */
+    'partitionId'?: string;
+    /**
+     * Whether this merge also applies a mutation.
+     * @type {boolean}
+     * @memberof ClickhouseMerge
+     */
+    'isMutation'?: boolean;
+    /**
+     * Memory usage in bytes.
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'memoryUsageBytes'?: number;
+    /**
+     * Rows read by the merge.
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'rowsRead'?: number;
+    /**
+     * Rows written by the merge.
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'rowsWritten'?: number;
+    /**
+     * Compressed size of the source parts.
+     * @type {number}
+     * @memberof ClickhouseMerge
+     */
+    'totalSizeBytesCompressed'?: number;
+}
+

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

@@ -0,0 +1,84 @@
+/* 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 ClickhouseMutation
+ */
+export interface ClickhouseMutation {
+    /**
+     * Database name.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'database'?: string;
+    /**
+     * Table name.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'table'?: string;
+    /**
+     * ClickHouse server host running the mutation.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'hostName'?: string;
+    /**
+     * Mutation identifier.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'mutationId'?: string;
+    /**
+     * Mutation command (ALTER/UPDATE/DELETE) with string and numeric literals and comments masked as ?.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'command'?: string;
+    /**
+     * Mutation creation time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'createTime'?: string;
+    /**
+     * Parts still waiting to be mutated.
+     * @type {number}
+     * @memberof ClickhouseMutation
+     */
+    'partsToDo'?: number;
+    /**
+     * Most recent part that failed mutation.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'latestFailedPart'?: string;
+    /**
+     * Most recent mutation failure time in RFC3339 UTC.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'latestFailTime'?: string;
+    /**
+     * Most recent mutation failure reason.
+     * @type {string}
+     * @memberof ClickhouseMutation
+     */
+    'latestFailReason'?: string;
+}
+