kb-cloud-client-typescript 2.3.0-alpha.135 → 2.3.0-alpha.137

package/src/openapi.yaml

@@ -4952,13 +4952,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
@@ -9047,6 +9047,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Current logical Redis database index for this context. Omitted uses the datasource default; Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       responses:
         '200':
           description: A successful response.
@@ -9076,6 +9083,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
         - name: cursor
           in: query
           required: false
@@ -9115,6 +9129,74 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/RedisKeySummaryList'
+  /api/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'
   /api/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/redis/key/detail:
     post:
       tags:
@@ -9137,6 +9219,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -9172,6 +9261,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -9208,6 +9304,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index for this command. Redis Cluster only supports 0.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -9243,6 +9346,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index for this Pub/Sub client. Redis Pub/Sub is server-level, but the client connection is still scoped to the selected DB for consistency.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -9278,6 +9388,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index for the polling client connection.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -9389,6 +9506,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. SlowLog is server-level; the parameter is accepted for API consistency.
+          schema:
+            type: integer
+            format: int64
         - name: limit
           in: query
           required: false
@@ -9429,6 +9553,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. SlowLog reset is server-level; the parameter is accepted for API consistency.
+          schema:
+            type: integer
+            format: int64
       requestBody:
         content:
           application/json:
@@ -9464,6 +9595,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. INFO is server-level; the parameter is accepted for API consistency.
+          schema:
+            type: integer
+            format: int64
         - name: section
           in: query
           required: false
@@ -9503,6 +9641,13 @@ paths:
           required: true
           schema:
             type: string
+        - name: database
+          in: query
+          required: false
+          description: Logical Redis database index. Redis Cluster topology only supports database 0.
+          schema:
+            type: integer
+            format: int64
       responses:
         '200':
           description: A successful response.
@@ -22935,7 +23080,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:
@@ -22961,7 +23106,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.
@@ -23024,7 +23169,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.
@@ -28304,8 +28449,12 @@ components:
     RedisDataCapabilities:
       type: object
       properties:
+        analysis:
+          $ref: '#/components/schemas/RedisCapability'
         browser:
           $ref: '#/components/schemas/RedisCapability'
+        database:
+          $ref: '#/components/schemas/RedisCapability'
         workbench:
           $ref: '#/components/schemas/RedisCapability'
         pubsub:
@@ -28367,6 +28516,12 @@ components:
         dbIndex:
           type: integer
           format: int64
+          description: Current logical Redis database index for this request context.
+        dbCount:
+          type: integer
+          format: int64
+          description: Available logical Redis database count. Non-cluster Redis defaults to 16 when the server does not expose a count; Redis Cluster is always 1.
+          x-omitempty: false
         mode:
           type: string
           description: Redis architecture mode, such as standalone, replication, sentinel, or cluster
@@ -28419,6 +28574,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:
@@ -33101,13 +33485,31 @@ components:
         - items
     inspectionScriptCategory:
       type: string
-      description: Specifies the category of the inspection script.
+      description: Current inspection category vocabulary. Existing legacy categories are normalized by the backend before they are returned.
       enum:
-        - performance
         - availability
-        - security
+        - performance
+        - connections
+        - resource
+        - capacity
+        - vacuumWraparound
         - backup
-        - other
+        - security
+    inspectionCriticality:
+      type: string
+      description: First-version criticality assumption for score weighting and red-item veto behavior. Missing legacy values are treated as medium.
+      enum:
+        - critical
+        - high
+        - medium
+        - low
+    inspectionThresholdDirection:
+      type: string
+      description: Direction used to interpret warnThreshold and critThreshold. asc means larger values are worse, desc means smaller values are worse, boolean means the check expression decides.
+      enum:
+        - asc
+        - desc
+        - boolean
     inspectionScript:
       required:
         - name
@@ -33139,6 +33541,24 @@ components:
           type: string
         checkExpr:
           type: string
+        criticality:
+          $ref: '#/components/schemas/inspectionCriticality'
+        warnThreshold:
+          type: number
+          format: double
+          x-nullable: true
+          description: First-version warning threshold assumption. It documents the script contract and is not a permanent product conclusion.
+        critThreshold:
+          type: number
+          format: double
+          x-nullable: true
+          description: First-version critical threshold assumption. It documents the script contract and is not a permanent product conclusion.
+        direction:
+          $ref: '#/components/schemas/inspectionThresholdDirection'
+        remediation:
+          $ref: '#/components/schemas/localizedDescription'
+        docLink:
+          type: string
         scopeType:
           description: scope type, such as "system"/"global"/"org"
           type: string
@@ -33214,6 +33634,10 @@ components:
           type: string
         enabled:
           type: boolean
+    inspectionTaskItemEvidence:
+      type: object
+      description: Structured evidence used to explain the item result. Prometheus/exporter no-data is reported here as no data or unknown instead of being converted into a healthy result.
+      additionalProperties: true
     inspectionTaskItem:
       properties:
         id:
@@ -33238,6 +33662,33 @@ components:
           type: string
         result:
           type: string
+        valueNum:
+          type: number
+          format: double
+          x-nullable: true
+          description: Numeric form of result when the result is parseable.
+        warnThreshold:
+          type: number
+          format: double
+          x-nullable: true
+        critThreshold:
+          type: number
+          format: double
+          x-nullable: true
+        direction:
+          $ref: '#/components/schemas/inspectionThresholdDirection'
+        criticality:
+          $ref: '#/components/schemas/inspectionCriticality'
+        evidence:
+          $ref: '#/components/schemas/inspectionTaskItemEvidence'
+        statusChangedAt:
+          format: date-time
+          type: string
+          description: Item-level timestamp for when this item's status was last evaluated or changed.
+        remediation:
+          $ref: '#/components/schemas/localizedDescription'
+        docLink:
+          type: string
         severity:
           type: string
         unit:
@@ -33277,6 +33728,21 @@ components:
           type: integer
         result:
           type: string
+          description: Backend truth derived from the worst item state and criticality-aware score caps. A red item makes the task red; a critical red item caps score at 40.
+        latestRunAt:
+          format: date-time
+          type: string
+          description: Last inspection execution timestamp used for freshness checks.
+        expectedInterval:
+          type: string
+          description: Expected first-version inspection interval assumption, for example 1h.
+        nextRunAt:
+          format: date-time
+          type: string
+          description: Expected next inspection time derived from latestRunAt and expectedInterval.
+        isStale:
+          type: boolean
+          description: True when the latest inspection is older than the expected interval. Stale or missing inspection data must not be displayed as healthy.
         items:
           type: array
           items: