kb-cloud-client-typescript 2.4.0-alpha.110 → 2.4.0-alpha.112

package/src/adminapi/models/redis-key-analysis-report-type-stat-value.ts

@@ -0,0 +1,36 @@
+/* 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 RedisKeyAnalysisReportTypeStatValue
+ */
+export interface RedisKeyAnalysisReportTypeStatValue {
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyAnalysisReportTypeStatValue
+     */
+    'count'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyAnalysisReportTypeStatValue
+     */
+    'bytes'?: string;
+}
+

package/src/adminapi/models/redis-key-analysis-report.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 { RedisKeyAnalysisReportParameters } from './redis-key-analysis-report-parameters';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisKeyAnalysisReportTypeStatValue } from './redis-key-analysis-report-type-stat-value';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisKeyEntry } from './redis-key-entry';
+
+/**
+ * One Redis keys analysis report row. Rows are persisted per shard. The query response appends one non-persisted aggregate row with isSummary=true. 
+ * @export
+ * @interface RedisKeyAnalysisReport
+ */
+export interface RedisKeyAnalysisReport {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'taskId'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'clusterId'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'shardName'?: string;
+    /**
+     * True for the aggregate row that is not persisted.
+     * @type {boolean}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'isSummary'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'createTime'?: string;
+    /**
+     * 
+     * @type {RedisKeyAnalysisReportParameters}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'parameters'?: RedisKeyAnalysisReportParameters;
+    /**
+     * Key statistics by Redis data type: {type: {count, bytes}}.
+     * @type {{ [key: string]: RedisKeyAnalysisReportTypeStatValue; }}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'typeStat'?: { [key: string]: RedisKeyAnalysisReportTypeStatValue; };
+    /**
+     * Key statistics by memory size bucket: {bucket: {count, bytes}}.
+     * @type {{ [key: string]: RedisKeyAnalysisReportTypeStatValue; }}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'byteLevelStat'?: { [key: string]: RedisKeyAnalysisReportTypeStatValue; };
+    /**
+     * Key statistics by remaining TTL bucket: {bucket: {count, bytes}}.
+     * @type {{ [key: string]: RedisKeyAnalysisReportTypeStatValue; }}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'expireStat'?: { [key: string]: RedisKeyAnalysisReportTypeStatValue; };
+    /**
+     * 
+     * @type {Array<RedisKeyEntry>}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'topBigKeyByteStat'?: Array<RedisKeyEntry>;
+    /**
+     * 
+     * @type {Array<RedisKeyEntry>}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'topBigKeyElemStat'?: Array<RedisKeyEntry>;
+    /**
+     * Top cluster slots by memory usage: [{slot: bytes}]. Only populated for Redis Cluster mode.
+     * @type {Array<{ [key: string]: number; }>}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'topSlotKeyByteStat'?: Array<{ [key: string]: number; }>;
+    /**
+     * Top cluster slots by key count: [{slot: count}]. Only populated for Redis Cluster mode.
+     * @type {Array<{ [key: string]: number; }>}
+     * @memberof RedisKeyAnalysisReport
+     */
+    'topSlotKeyCountStat'?: Array<{ [key: string]: number; }>;
+}
+

package/src/adminapi/models/redis-key-entry.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 RedisKeyEntry
+ */
+export interface RedisKeyEntry {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyEntry
+     */
+    'Key'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'Bytes'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyEntry
+     */
+    'Type'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'NumOfElem'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'LenOfLargestElem'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyEntry
+     */
+    'FieldOfLargestElem'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'Db'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyEntry
+     */
+    'Encoding'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'Expiration'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'LruIdle'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeyEntry
+     */
+    'LfuFreq'?: number;
+}
+

package/src/adminapi.yaml

@@ -75,6 +75,8 @@ tags:
     description: Diagnostics APIs
   - name: disasterRecovery
     description: Cluster Disaster Recovery APIs
+  - name: redisKeyAnalysis
+    description: Redis Keys Analysis APIs
 paths:
   /admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/rbac/users/{database}/{username}/password:
     put:
@@ -29503,6 +29505,134 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/redis/keyAnalysis:
+    post:
+      tags:
+        - redisKeyAnalysis
+      operationId: adminCreateRedisKeyAnalysis
+      summary: Create a Redis keys analysis task
+      description: Admin variant of createRedisKeyAnalysis.
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: false
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                parameters:
+                  type: object
+                  properties:
+                    topBigKey:
+                      type: integer
+                      format: int64
+                      minimum: 1
+                      maximum: 500
+                      default: 100
+                    numOfElemMin:
+                      type: integer
+                      format: int64
+                      minimum: 1
+                      default: 3000
+                    bigKeySizeMin:
+                      type: string
+                      default: 10kb
+                    topSlot:
+                      type: integer
+                      format: int64
+                      minimum: 1
+                      maximum: 500
+                      default: 100
+      responses:
+        '200':
+          description: Analysis task submitted.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - taskId
+                properties:
+                  taskId:
+                    type: string
+                  status:
+                    type: string
+        '400':
+          $ref: '#/components/responses/400'
+        '404':
+          $ref: '#/components/responses/404'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/redis/keyAnalysis/{taskId}:
+    get:
+      tags:
+        - redisKeyAnalysis
+      operationId: adminGetRedisKeyAnalysisReport
+      summary: Get a Redis keys analysis report
+      description: |
+        Returns one persisted row per shard plus one non-persisted aggregate row with
+        isSummary=true when more than one row is returned.
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: taskId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Report rows plus an optional aggregate row.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/RedisKeyAnalysisReport'
+        '404':
+          $ref: '#/components/responses/404'
+    delete:
+      tags:
+        - redisKeyAnalysis
+      operationId: adminDeleteRedisKeyAnalysisReport
+      summary: Delete a Redis keys analysis report
+      parameters:
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: taskId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Report deleted.
+        '404':
+          $ref: '#/components/responses/404'
   /admin/v1/replication/channel:
     get:
       operationId: listAdminDataChannels
@@ -42265,7 +42395,7 @@ components:
           description: Whether the engine supports service account access-key management.
         protectedAccounts:
           type: array
-          description: Account names that are protected from update, delete, lock, and unlock actions.
+          description: Account names that cannot be deleted, locked, or unlocked. This does not hide accounts or restrict password or privilege actions.
           items:
             type: string
         displayRootAccount:
@@ -52738,6 +52868,138 @@ components:
             items:
               $ref: '#/components/schemas/networkMode'
             description: available network modes for this engine+mode
+    RedisKeyEntry:
+      type: object
+      properties:
+        Key:
+          type: string
+        Bytes:
+          type: integer
+          format: int64
+        Type:
+          type: string
+        NumOfElem:
+          type: integer
+          format: int64
+        LenOfLargestElem:
+          type: integer
+          format: int64
+        FieldOfLargestElem:
+          type: string
+        Db:
+          type: integer
+        Encoding:
+          type: string
+        Expiration:
+          type: integer
+          format: int64
+        LruIdle:
+          type: integer
+          format: int64
+        LfuFreq:
+          type: integer
+    RedisKeyAnalysisReport:
+      type: object
+      description: |
+        One Redis keys analysis report row. Rows are persisted per shard. The query
+        response appends one non-persisted aggregate row with isSummary=true.
+      properties:
+        taskId:
+          type: string
+        clusterId:
+          type: string
+        shardName:
+          type: string
+        isSummary:
+          type: boolean
+          description: True for the aggregate row that is not persisted.
+        createTime:
+          type: string
+          format: date-time
+        parameters:
+          type: object
+          description: |
+            Parameters for a Redis keys analysis task. topBigKey and topSlot are capped at 500.
+            numOfElemMin filters keys whose element count is below the threshold. bigKeySizeMin
+            filters keys whose memory usage is below the threshold (for example "10kb").
+          properties:
+            topBigKey:
+              type: integer
+              format: int64
+              minimum: 1
+              maximum: 500
+              default: 100
+            numOfElemMin:
+              type: integer
+              format: int64
+              minimum: 1
+              default: 3000
+            bigKeySizeMin:
+              type: string
+              default: 10kb
+            topSlot:
+              type: integer
+              format: int64
+              minimum: 1
+              maximum: 500
+              default: 100
+        typeStat:
+          type: object
+          description: 'Key statistics by Redis data type: {type: {count, bytes}}.'
+          additionalProperties:
+            type: object
+            properties:
+              count:
+                type: integer
+                format: int64
+              bytes:
+                type: string
+        byteLevelStat:
+          type: object
+          description: 'Key statistics by memory size bucket: {bucket: {count, bytes}}.'
+          additionalProperties:
+            type: object
+            properties:
+              count:
+                type: integer
+                format: int64
+              bytes:
+                type: string
+        expireStat:
+          type: object
+          description: 'Key statistics by remaining TTL bucket: {bucket: {count, bytes}}.'
+          additionalProperties:
+            type: object
+            properties:
+              count:
+                type: integer
+                format: int64
+              bytes:
+                type: string
+        topBigKeyByteStat:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisKeyEntry'
+        topBigKeyElemStat:
+          type: array
+          items:
+            $ref: '#/components/schemas/RedisKeyEntry'
+        topSlotKeyByteStat:
+          type: array
+          description: 'Top cluster slots by memory usage: [{slot: bytes}]. Only populated for Redis Cluster mode.'
+          items:
+            type: object
+            additionalProperties:
+              type: integer
+              format: int64
+        topSlotKeyCountStat:
+          type: array
+          description: 'Top cluster slots by key count: [{slot: count}]. Only populated for Redis Cluster mode.'
+          items:
+            type: object
+            additionalProperties:
+              type: integer
+              format: int64
     channelStatus:
       enum:
         - Pending

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

@@ -73,6 +73,7 @@ apis/rabbit-mqapi.ts
 apis/rdbms-api.ts
 apis/recycle-bin-cluster-api.ts
 apis/redis-api.ts
+apis/redis-key-analysis-api.ts
 apis/relation-api.ts
 apis/resource-stats-api.ts
 apis/restore-api.ts
@@ -328,6 +329,9 @@ models/cpu.ts
 models/create-clickhouse-account-request.ts
 models/create-ipwhitelist-request.ts
 models/create-pg-extension-resp.ts
+models/create-redis-key-analysis-request-parameters.ts
+models/create-redis-key-analysis-request.ts
+models/create-redis-key-analysis200-response.ts
 models/create-topic-request.ts
 models/custom-endpoint-create.ts
 models/custom-endpoint.ts
@@ -943,8 +947,12 @@ models/redis-dangerous-operation-request.ts
 models/redis-data-capabilities.ts
 models/redis-data-context.ts
 models/redis-info-response.ts
+models/redis-key-analysis-report-parameters.ts
+models/redis-key-analysis-report-type-stat-value.ts
+models/redis-key-analysis-report.ts
 models/redis-key-detail-request.ts
 models/redis-key-detail.ts
+models/redis-key-entry.ts
 models/redis-key-mutate-request.ts
 models/redis-key-mutate-response.ts
 models/redis-key-scan-progress.ts

package/src/openapi/api.ts

@@ -85,6 +85,7 @@ export * from './apis/rabbit-mqapi';
 export * from './apis/rdbms-api';
 export * from './apis/recycle-bin-cluster-api';
 export * from './apis/redis-api';
+export * from './apis/redis-key-analysis-api';
 export * from './apis/relation-api';
 export * from './apis/resource-stats-api';
 export * from './apis/restore-api';