kb-cloud-client-typescript 2.3.0-alpha.196 → 2.3.0-alpha.198

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

@@ -0,0 +1,78 @@
+/* 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 MysqlSpaceSummary
+ */
+export interface MysqlSpaceSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlSpaceSummary
+     */
+    'databaseName': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlSpaceSummary
+     */
+    'databaseSizeBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlSpaceSummary
+     */
+    'dataBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlSpaceSummary
+     */
+    'indexBytes': number;
+    /**
+     * DATA_FREE reported by information_schema. Its per-table meaning is most reliable with innodb_file_per_table.
+     * @type {number}
+     * @memberof MysqlSpaceSummary
+     */
+    'freeBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlSpaceSummary
+     */
+    'tableCount': number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MysqlSpaceSummary
+     */
+    'tableListTruncated': boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MysqlSpaceSummary
+     */
+    'indexListTruncated': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlSpaceSummary
+     */
+    'indexSizeSource'?: string;
+}
+

package/src/adminapi/models/mysql-storage-instance-usage.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 MysqlStorageInstanceUsage
+ */
+export interface MysqlStorageInstanceUsage {
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'instanceName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'pvcName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'role'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'componentName'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'totalBytes'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'usedBytes'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'availableBytes'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'usageRatio'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'updatedAt'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageInstanceUsage
+     */
+    'source'?: string;
+}
+

package/src/adminapi/models/mysql-storage-overview.ts

@@ -0,0 +1,39 @@
+/* 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 { MysqlStorageInstanceUsage } from './mysql-storage-instance-usage';
+
+/**
+ * 
+ * @export
+ * @interface MysqlStorageOverview
+ */
+export interface MysqlStorageOverview {
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlStorageOverview
+     */
+    'source': string;
+    /**
+     * 
+     * @type {Array<MysqlStorageInstanceUsage>}
+     * @memberof MysqlStorageOverview
+     */
+    'instances': Array<MysqlStorageInstanceUsage>;
+}
+

package/src/adminapi/models/mysql-table-space.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 MysqlTableSpace
+ */
+export interface MysqlTableSpace {
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlTableSpace
+     */
+    'database': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlTableSpace
+     */
+    'name': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlTableSpace
+     */
+    'engine': string;
+    /**
+     * Estimated row count for InnoDB tables.
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'rows': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'dataBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'indexBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'freeBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'totalBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'avgRowLength': number;
+    /**
+     * freeBytes divided by totalBytes plus freeBytes when available.
+     * @type {number}
+     * @memberof MysqlTableSpace
+     */
+    'fragmentationRatio'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlTableSpace
+     */
+    'createTime'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MysqlTableSpace
+     */
+    'updateTime'?: string;
+}
+

package/src/adminapi/models/performance-trend-series.ts

@@ -39,7 +39,7 @@ export interface PerformanceTrendSeries {
      */
     'displayName': LocalizedDescription;
     /**
-     * Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
+     * Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
      * @type {string}
      * @memberof PerformanceTrendSeries
      */

package/src/adminapi/models/performance-trend-summary.ts

@@ -36,7 +36,7 @@ export interface PerformanceTrendSummary {
      */
     'displayName': LocalizedDescription;
     /**
-     * Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
+     * Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
      * @type {string}
      * @memberof PerformanceTrendSummary
      */

package/src/adminapi.yaml

@@ -21059,6 +21059,47 @@ paths:
         - session
         - rdbms
         - shared
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/spaceAnalysis:
+    get:
+      tags:
+        - diagnostics
+      summary: Get MySQL space analysis
+      description: Get a read-only MySQL 5.7, 8.0, or 8.4 compatible space snapshot and fixed backend-owned storage metrics.
+      operationId: getDiagnosticsMysqlSpaceAnalysis
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: databaseName
+          in: query
+          description: Optional database name for table and index details. When omitted, the largest non-system database is selected.
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/mysqlSpaceAnalysis'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions:
     get:
       tags:
@@ -21292,6 +21333,53 @@ paths:
           $ref: '#/components/responses/403'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/mysql/performanceTrends:
+    get:
+      tags:
+        - diagnostics
+      summary: Get MySQL performance trends
+      description: Get read-only MySQL 5.7, 8.0, and 8.4 performance trends from backend-owned metrics and database capability checks. The response does not expose SQL, PromQL, internal endpoints, or credentials.
+      operationId: getDiagnosticsMysqlPerformanceTrends
+      parameters:
+        - name: orgName
+          in: path
+          description: Organization name
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          description: Cluster name
+          required: true
+          schema:
+            type: string
+        - name: range
+          in: query
+          description: Controlled query range. Allowed values are 1h, 6h, 24h, and 7d. Defaults to 1h.
+          required: false
+          schema:
+            type: string
+        - name: step
+          in: query
+          description: Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h.
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/performanceTrends'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '500':
+          $ref: '#/components/responses/500'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
     get:
       tags:
@@ -33814,6 +33902,7 @@ components:
           properties:
             compatibleKBVersions:
               type: array
+              description: if omitted, all KB versions are compatible
               items:
                 type: string
             mappings:
@@ -39675,6 +39764,264 @@ components:
           type: string
           format: date-time
           description: Optional service account expiration time. Use the Unix epoch to clear expiration.
+    mysqlSpaceSummary:
+      type: object
+      required:
+        - databaseName
+        - databaseSizeBytes
+        - dataBytes
+        - indexBytes
+        - freeBytes
+        - tableCount
+        - tableListTruncated
+        - indexListTruncated
+      properties:
+        databaseName:
+          type: string
+        databaseSizeBytes:
+          type: integer
+          format: int64
+        dataBytes:
+          type: integer
+          format: int64
+        indexBytes:
+          type: integer
+          format: int64
+        freeBytes:
+          type: integer
+          format: int64
+          description: DATA_FREE reported by information_schema. Its per-table meaning is most reliable with innodb_file_per_table.
+        tableCount:
+          type: integer
+          format: int64
+        tableListTruncated:
+          type: boolean
+        indexListTruncated:
+          type: boolean
+        indexSizeSource:
+          type: string
+    mysqlStorageInstanceUsage:
+      type: object
+      properties:
+        instanceName:
+          type: string
+        pvcName:
+          type: string
+        role:
+          type: string
+        componentName:
+          type: string
+        totalBytes:
+          type: integer
+          format: int64
+        usedBytes:
+          type: integer
+          format: int64
+        availableBytes:
+          type: integer
+          format: int64
+        usageRatio:
+          type: number
+          format: double
+          nullable: true
+        updatedAt:
+          type: string
+        source:
+          type: string
+    mysqlStorageOverview:
+      type: object
+      required:
+        - source
+        - instances
+      properties:
+        source:
+          type: string
+        instances:
+          type: array
+          items:
+            $ref: '#/components/schemas/mysqlStorageInstanceUsage'
+    mysqlDatabaseSpace:
+      type: object
+      required:
+        - name
+        - dataBytes
+        - indexBytes
+        - freeBytes
+        - totalBytes
+        - tableCount
+      properties:
+        name:
+          type: string
+        dataBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        indexBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        freeBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        totalBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        tableCount:
+          type: integer
+          format: int64
+          x-omitempty: false
+    mysqlTableSpace:
+      type: object
+      required:
+        - database
+        - name
+        - engine
+        - rows
+        - dataBytes
+        - indexBytes
+        - freeBytes
+        - totalBytes
+        - avgRowLength
+      properties:
+        database:
+          type: string
+        name:
+          type: string
+        engine:
+          type: string
+        rows:
+          type: integer
+          format: int64
+          x-omitempty: false
+          description: Estimated row count for InnoDB tables.
+        dataBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        indexBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        freeBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        totalBytes:
+          type: integer
+          format: int64
+          x-omitempty: false
+        avgRowLength:
+          type: integer
+          format: int64
+          x-omitempty: false
+        fragmentationRatio:
+          type: number
+          format: double
+          nullable: true
+          description: freeBytes divided by totalBytes plus freeBytes when available.
+        createTime:
+          type: string
+        updateTime:
+          type: string
+    mysqlIndexSpace:
+      type: object
+      required:
+        - database
+        - table
+        - name
+        - isUnique
+        - isPrimary
+        - cardinality
+      properties:
+        database:
+          type: string
+        table:
+          type: string
+        name:
+          type: string
+        sizeBytes:
+          type: integer
+          format: int64
+          nullable: true
+          description: Estimated from mysql.innodb_index_stats pages multiplied by innodb_page_size.
+        isUnique:
+          type: boolean
+          x-omitempty: false
+        isPrimary:
+          type: boolean
+          x-omitempty: false
+        cardinality:
+          type: integer
+          format: int64
+          x-omitempty: false
+        scanCount:
+          type: integer
+          format: int64
+          nullable: true
+          description: COUNT_READ from performance_schema; resets with server statistics.
+        lastStatUpdate:
+          type: string
+    mysqlSpaceSource:
+      type: object
+      required:
+        - name
+        - kind
+        - status
+        - collectedAt
+      properties:
+        name:
+          type: string
+        kind:
+          type: string
+        status:
+          type: string
+        collectedAt:
+          type: string
+        message:
+          type: string
+    mysqlSpaceAnalysis:
+      type: object
+      required:
+        - summary
+        - storageOverview
+        - databases
+        - selectedDatabase
+        - tables
+        - indexes
+        - sources
+        - collectedAt
+      properties:
+        summary:
+          $ref: '#/components/schemas/mysqlSpaceSummary'
+        storageOverview:
+          $ref: '#/components/schemas/mysqlStorageOverview'
+        databases:
+          type: array
+          description: Sizes of all non-system MySQL databases.
+          items:
+            $ref: '#/components/schemas/mysqlDatabaseSpace'
+        selectedDatabase:
+          type: string
+          description: Database used for table and index details.
+        tables:
+          type: array
+          description: Top tables from selectedDatabase.
+          items:
+            $ref: '#/components/schemas/mysqlTableSpace'
+        indexes:
+          type: array
+          description: Top indexes from selectedDatabase. Individual index size can be unavailable when mysql.innodb_index_stats is inaccessible.
+          items:
+            $ref: '#/components/schemas/mysqlIndexSpace'
+        sources:
+          type: array
+          items:
+            $ref: '#/components/schemas/mysqlSpaceSource'
+        collectedAt:
+          type: string
+          description: Backend collection timestamp in UTC.
     postgresqlSession:
       type: object
       required:
@@ -40284,7 +40631,7 @@ components:
           $ref: '#/components/schemas/localizedDescription'
         category:
           type: string
-          description: Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
+          description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
         dimension:
           type: string
           description: Optional series dimension. Values include cluster, instance, pvc, and database.
@@ -40347,7 +40694,7 @@ components:
           $ref: '#/components/schemas/localizedDescription'
         category:
           type: string
-          description: Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
+          description: Metric category. Values include availability, performance, connections, resource, capacity, innodb, and vacuumWraparound.
         dimension:
           type: string
           description: Optional series dimension. Values include cluster, instance, pvc, and database.