kb-cloud-client-typescript 2.3.0-alpha.134 → 2.3.0-alpha.136

package/src/adminapi/models/redis-analysis-response.ts

@@ -0,0 +1,132 @@
+/* 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 { RedisAnalysisExpirationGroup } from './redis-analysis-expiration-group';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisAnalysisFilter } from './redis-analysis-filter';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisAnalysisKey } from './redis-analysis-key';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisAnalysisNamespaceSummary } from './redis-analysis-namespace-summary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisAnalysisProgress } from './redis-analysis-progress';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisAnalysisTypedSummary } from './redis-analysis-typed-summary';
+
+/**
+ * Instant Redis key analysis report sampled by bounded SCAN. This aligns with RedisInsight-style analysis dimensions but is not a persisted historical report.
+ * @export
+ * @interface RedisAnalysisResponse
+ */
+export interface RedisAnalysisResponse {
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisResponse
+     */
+    'db'?: number;
+    /**
+     * 
+     * @type {RedisAnalysisFilter}
+     * @memberof RedisAnalysisResponse
+     */
+    'filter'?: RedisAnalysisFilter;
+    /**
+     * Actual delimiter used to aggregate top namespaces.
+     * @type {string}
+     * @memberof RedisAnalysisResponse
+     */
+    'delimiter'?: string;
+    /**
+     * 
+     * @type {RedisAnalysisProgress}
+     * @memberof RedisAnalysisResponse
+     */
+    'progress'?: RedisAnalysisProgress;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisResponse
+     */
+    'createdAt'?: string;
+    /**
+     * Connected client count from Redis INFO when available.
+     * @type {number}
+     * @memberof RedisAnalysisResponse
+     */
+    'connectedClients'?: number;
+    /**
+     * 
+     * @type {RedisAnalysisTypedSummary}
+     * @memberof RedisAnalysisResponse
+     */
+    'totalKeys'?: RedisAnalysisTypedSummary;
+    /**
+     * 
+     * @type {RedisAnalysisTypedSummary}
+     * @memberof RedisAnalysisResponse
+     */
+    'totalMemory'?: RedisAnalysisTypedSummary;
+    /**
+     * 
+     * @type {Array<RedisAnalysisNamespaceSummary>}
+     * @memberof RedisAnalysisResponse
+     */
+    'topKeysNsp'?: Array<RedisAnalysisNamespaceSummary>;
+    /**
+     * 
+     * @type {Array<RedisAnalysisNamespaceSummary>}
+     * @memberof RedisAnalysisResponse
+     */
+    'topMemoryNsp'?: Array<RedisAnalysisNamespaceSummary>;
+    /**
+     * 
+     * @type {Array<RedisAnalysisKey>}
+     * @memberof RedisAnalysisResponse
+     */
+    'topKeysLength'?: Array<RedisAnalysisKey>;
+    /**
+     * 
+     * @type {Array<RedisAnalysisKey>}
+     * @memberof RedisAnalysisResponse
+     */
+    'topKeysMemory'?: Array<RedisAnalysisKey>;
+    /**
+     * 
+     * @type {Array<RedisAnalysisExpirationGroup>}
+     * @memberof RedisAnalysisResponse
+     */
+    'expirationGroups'?: Array<RedisAnalysisExpirationGroup>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RedisAnalysisResponse
+     */
+    'warnings'?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RedisAnalysisResponse
+     */
+    'recommendations'?: Array<string>;
+}
+

package/src/adminapi/models/redis-analysis-simple-type-summary.ts

@@ -0,0 +1,42 @@
+/* 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 RedisAnalysisSimpleTypeSummary
+ */
+export interface RedisAnalysisSimpleTypeSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisSimpleTypeSummary
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisSimpleTypeSummary
+     */
+    'total'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisSimpleTypeSummary
+     */
+    'ratio'?: number;
+}
+

package/src/adminapi/models/redis-analysis-typed-summary.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 { RedisAnalysisSimpleTypeSummary } from './redis-analysis-simple-type-summary';
+
+/**
+ * 
+ * @export
+ * @interface RedisAnalysisTypedSummary
+ */
+export interface RedisAnalysisTypedSummary {
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisTypedSummary
+     */
+    'total'?: number;
+    /**
+     * 
+     * @type {Array<RedisAnalysisSimpleTypeSummary>}
+     * @memberof RedisAnalysisTypedSummary
+     */
+    'types'?: Array<RedisAnalysisSimpleTypeSummary>;
+}
+

package/src/adminapi/models/redis-data-capabilities.ts

@@ -23,6 +23,12 @@ import type { RedisCapability } from './redis-capability';
  * @interface RedisDataCapabilities
  */
 export interface RedisDataCapabilities {
+    /**
+     * 
+     * @type {RedisCapability}
+     * @memberof RedisDataCapabilities
+     */
+    'analysis'?: RedisCapability;
     /**
      * 
      * @type {RedisCapability}

package/src/adminapi.yaml

@@ -5400,6 +5400,74 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/RedisKeySummaryList'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/redis/analysis:
+    get:
+      tags:
+        - dms
+      operationId: analyzeRedisKeys
+      summary: analyze Redis keys by bounded SCAN sampling
+      description: Returns an instant sample analysis for Redis keys. The result is not a persisted or full historical report; callers must use progress.complete, progress.processed, progress.sampleLimit, and generatedAt to present the sampling boundary.
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: database
+          in: query
+          required: false
+          schema:
+            type: integer
+            format: int64
+        - name: match
+          in: query
+          description: Redis SCAN match pattern.
+          required: false
+          schema:
+            type: string
+        - name: cursor
+          in: query
+          description: Cursor returned by a previous analysis scan. Empty starts a new sample scan.
+          required: false
+          schema:
+            type: string
+        - name: sampleLimit
+          in: query
+          description: Maximum number of keys to sample in this analysis request.
+          required: false
+          schema:
+            type: integer
+            format: int64
+        - name: topN
+          in: query
+          description: Maximum number of top keys or namespaces to return.
+          required: false
+          schema:
+            type: integer
+            format: int64
+        - name: namespaceSeparator
+          in: query
+          description: Separator used to group key namespaces.
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: analyze redis key sample success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/RedisAnalysisResponse'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/redis/key/detail:
     post:
       tags:
@@ -19975,13 +20043,13 @@ paths:
             type: string
         - name: range
           in: query
-          description: Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
+          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, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
+          description: Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h. Defaults to 1m for 1h, 5m for 6h, 15m for 24h, and 1h for 7d.
           required: false
           schema:
             type: string
@@ -26200,6 +26268,8 @@ components:
     RedisDataCapabilities:
       type: object
       properties:
+        analysis:
+          $ref: '#/components/schemas/RedisCapability'
         browser:
           $ref: '#/components/schemas/RedisCapability'
         workbench:
@@ -26315,6 +26385,235 @@ components:
           type: boolean
           description: Whether another key page should be requested.
           x-omitempty: false
+    RedisAnalysisFilter:
+      type: object
+      properties:
+        match:
+          type: string
+        count:
+          type: integer
+          format: int64
+          x-omitempty: false
+    RedisAnalysisProgress:
+      type: object
+      properties:
+        total:
+          type: integer
+          format: int64
+          x-omitempty: false
+        scanned:
+          type: integer
+          format: int64
+          x-omitempty: false
+        processed:
+          type: integer
+          format: int64
+          x-omitempty: false
+        sampleLimit:
+          type: integer
+          format: int64
+          x-omitempty: false
+        cursor:
+          type: string
+        nextCursor:
+          type: string
+        scannedPercent:
+          type: number
+          format: double
+          x-omitempty: false
+        complete:
+          type: boolean
+          x-omitempty: false
+        sampled:
+          type: boolean
+          x-omitempty: false
+        extrapolationFactor:
+          type: number
+          format: double
+          x-omitempty: false
+        generatedAt:
+          type: string
+          format: date-time
+    RedisAnalysisSimpleTypeSummary:
+      type: object
+      properties:
+        type:
+          type: string
+        total:
+          type: integer
+          format: int64
+          x-omitempty: false
+        ratio:
+          type: number
+          format: double
+          x-omitempty: false
+    RedisAnalysisTypedSummary:
+      type: object
+      properties:
+        total:
+          type: integer
+          format: int64
+          x-omitempty: false
+        types:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisSimpleTypeSummary'
+            nullable: true
+    RedisAnalysisNamespaceTypeSummary:
+      type: object
+      properties:
+        type:
+          type: string
+        keys:
+          type: integer
+          format: int64
+          x-omitempty: false
+        memory:
+          type: integer
+          format: int64
+          x-omitempty: false
+        keyRatio:
+          type: number
+          format: double
+          x-omitempty: false
+        memoryRatio:
+          type: number
+          format: double
+          x-omitempty: false
+    RedisAnalysisNamespaceSummary:
+      type: object
+      properties:
+        nsp:
+          type: string
+        keys:
+          type: integer
+          format: int64
+          x-omitempty: false
+        memory:
+          type: integer
+          format: int64
+          x-omitempty: false
+        keyRatio:
+          type: number
+          format: double
+          x-omitempty: false
+        memoryRatio:
+          type: number
+          format: double
+          x-omitempty: false
+        types:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisNamespaceTypeSummary'
+            nullable: true
+    RedisAnalysisKey:
+      type: object
+      properties:
+        name:
+          type: string
+        type:
+          type: string
+        nsp:
+          type: string
+        ttl:
+          type: integer
+          format: int64
+        memory:
+          type: integer
+          format: int64
+          x-omitempty: false
+        length:
+          type: integer
+          format: int64
+          x-omitempty: false
+        encoding:
+          type: string
+    RedisAnalysisExpirationGroup:
+      type: object
+      properties:
+        threshold:
+          type: integer
+          format: int64
+          x-omitempty: false
+        label:
+          type: string
+        total:
+          type: integer
+          format: int64
+          x-omitempty: false
+          description: Memory bytes likely to be freed in this TTL group.
+        keys:
+          type: integer
+          format: int64
+          x-omitempty: false
+        keyRatio:
+          type: number
+          format: double
+          x-omitempty: false
+        memoryRatio:
+          type: number
+          format: double
+          x-omitempty: false
+    RedisAnalysisResponse:
+      type: object
+      description: Instant Redis key analysis report sampled by bounded SCAN. This aligns with RedisInsight-style analysis dimensions but is not a persisted historical report.
+      properties:
+        db:
+          type: integer
+          format: int64
+          x-omitempty: false
+        filter:
+          $ref: '#/components/schemas/RedisAnalysisFilter'
+        delimiter:
+          type: string
+          description: Actual delimiter used to aggregate top namespaces.
+        progress:
+          $ref: '#/components/schemas/RedisAnalysisProgress'
+        createdAt:
+          type: string
+          format: date-time
+        connectedClients:
+          type: integer
+          format: int64
+          description: Connected client count from Redis INFO when available.
+          x-omitempty: false
+        totalKeys:
+          $ref: '#/components/schemas/RedisAnalysisTypedSummary'
+        totalMemory:
+          $ref: '#/components/schemas/RedisAnalysisTypedSummary'
+        topKeysNsp:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisNamespaceSummary'
+            nullable: true
+        topMemoryNsp:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisNamespaceSummary'
+            nullable: true
+        topKeysLength:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisKey'
+            nullable: true
+        topKeysMemory:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisKey'
+            nullable: true
+        expirationGroups:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisAnalysisExpirationGroup'
+            nullable: true
+        warnings:
+          type: array
+          items:
+            type: string
+        recommendations:
+          type: array
+          items:
+            type: string
     RedisKeyDetailRequest:
       type: object
       required:
@@ -37544,7 +37843,7 @@ components:
       properties:
         label:
           type: string
-          description: Controlled query range label. Values are 1h, 6h, or 24h.
+          description: Controlled query range label. Values are 1h, 6h, 24h, or 7d.
         start:
           type: string
         end:
@@ -37570,7 +37869,7 @@ components:
           $ref: '#/components/schemas/localizedDescription'
         category:
           type: string
-          description: Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
+          description: Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
         dimension:
           type: string
           description: Optional series dimension. Values include cluster, instance, pvc, and database.
@@ -37633,7 +37932,7 @@ components:
           $ref: '#/components/schemas/localizedDescription'
         category:
           type: string
-          description: Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
+          description: Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
         dimension:
           type: string
           description: Optional series dimension. Values include cluster, instance, pvc, and database.

package/src/openapi/.openapi-generator/FILES

@@ -707,6 +707,15 @@ models/recycle-bin-cluster-list-item.ts
 models/recycle-bin-cluster-list.ts
 models/recycle-bin-cluster.ts
 models/redis-aclcontext.ts
+models/redis-analysis-expiration-group.ts
+models/redis-analysis-filter.ts
+models/redis-analysis-key.ts
+models/redis-analysis-namespace-summary.ts
+models/redis-analysis-namespace-type-summary.ts
+models/redis-analysis-progress.ts
+models/redis-analysis-response.ts
+models/redis-analysis-simple-type-summary.ts
+models/redis-analysis-typed-summary.ts
 models/redis-capability.ts
 models/redis-cluster-node.ts
 models/redis-cluster-slot.ts

package/src/openapi/apis/diagnostics-api.ts

@@ -44,8 +44,8 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
          * @summary Get PostgreSQL performance trends
          * @param {string} orgName Organization name
          * @param {string} clusterName Cluster name
-         * @param {string} [range] Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
-         * @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.
+         * @param {string} [range] Controlled query range. Allowed values are 1h, 6h, 24h, and 7d. Defaults to 1h.
+         * @param {string} [step] Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h. Defaults to 1m for 1h, 5m for 6h, 15m for 24h, and 1h for 7d.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -362,8 +362,8 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
          * @summary Get PostgreSQL performance trends
          * @param {string} orgName Organization name
          * @param {string} clusterName Cluster name
-         * @param {string} [range] Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
-         * @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.
+         * @param {string} [range] Controlled query range. Allowed values are 1h, 6h, 24h, and 7d. Defaults to 1h.
+         * @param {string} [step] Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h. Defaults to 1m for 1h, 5m for 6h, 15m for 24h, and 1h for 7d.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -611,14 +611,14 @@ export interface DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrendsRequest
     readonly clusterName: string
 
     /**
-     * Controlled query range. Allowed values are 1h, 6h, and 24h. Defaults to 1h.
+     * Controlled query range. Allowed values are 1h, 6h, 24h, and 7d. Defaults to 1h.
      * @type {string}
      * @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
      */
     readonly range?: string
 
     /**
-     * Controlled query granularity. Allowed values are 1m, 5m, and 15m. Defaults to 1m for 1h, 5m for 6h, and 15m for 24h.
+     * Controlled query granularity. Allowed values are 1m, 5m, 15m, and 1h. Defaults to 1m for 1h, 5m for 6h, 15m for 24h, and 1h for 7d.
      * @type {string}
      * @memberof DiagnosticsApiGetDiagnosticsPostgresqlPerformanceTrends
      */