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

package/src/adminapi/apis/dms-api.ts

@@ -124,6 +124,8 @@ import type { MongoWriteResult } from '../models';
 // @ts-ignore
 import type { ParameterHistoryList } from '../models';
 // @ts-ignore
+import type { RedisAnalysisResponse } from '../models';
+// @ts-ignore
 import type { RedisClusterTopology } from '../models';
 // @ts-ignore
 import type { RedisDangerousOperationRequest } from '../models';
@@ -220,6 +222,85 @@ export const DmsApiAxiosParamCreator = function (configuration?: Configuration)
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary analyze Redis keys by bounded SCAN sampling
+         * @param {string} orgName 
+         * @param {string} clusterName 
+         * @param {string} id 
+         * @param {number} [database] 
+         * @param {string} [match] Redis SCAN match pattern.
+         * @param {string} [cursor] Cursor returned by a previous analysis scan. Empty starts a new sample scan.
+         * @param {number} [sampleLimit] Maximum number of keys to sample in this analysis request.
+         * @param {number} [topN] Maximum number of top keys or namespaces to return.
+         * @param {string} [namespaceSeparator] Separator used to group key namespaces.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analyzeRedisKeys: async (orgName: string, clusterName: string, id: string, database?: number, match?: string, cursor?: string, sampleLimit?: number, topN?: number, namespaceSeparator?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('analyzeRedisKeys', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('analyzeRedisKeys', 'clusterName', clusterName)
+            // verify required parameter 'id' is not null or undefined
+            assertParamExists('analyzeRedisKeys', 'id', id)
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/datasource/{id}/redis/analysis`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+            if (database !== undefined) {
+                localVarQueryParameter['database'] = database;
+            }
+
+            if (match !== undefined) {
+                localVarQueryParameter['match'] = match;
+            }
+
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
+
+            if (sampleLimit !== undefined) {
+                localVarQueryParameter['sampleLimit'] = sampleLimit;
+            }
+
+            if (topN !== undefined) {
+                localVarQueryParameter['topN'] = topN;
+            }
+
+            if (namespaceSeparator !== undefined) {
+                localVarQueryParameter['namespaceSeparator'] = namespaceSeparator;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 
          * @summary close a Redis Pub/Sub polling session
@@ -3933,6 +4014,27 @@ export const DmsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DmsApi.alterParameter']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary analyze Redis keys by bounded SCAN sampling
+         * @param {string} orgName 
+         * @param {string} clusterName 
+         * @param {string} id 
+         * @param {number} [database] 
+         * @param {string} [match] Redis SCAN match pattern.
+         * @param {string} [cursor] Cursor returned by a previous analysis scan. Empty starts a new sample scan.
+         * @param {number} [sampleLimit] Maximum number of keys to sample in this analysis request.
+         * @param {number} [topN] Maximum number of top keys or namespaces to return.
+         * @param {string} [namespaceSeparator] Separator used to group key namespaces.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async analyzeRedisKeys(orgName: string, clusterName: string, id: string, database?: number, match?: string, cursor?: string, sampleLimit?: number, topN?: number, namespaceSeparator?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedisAnalysisResponse>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.analyzeRedisKeys(orgName, clusterName, id, database, match, cursor, sampleLimit, topN, namespaceSeparator, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DmsApi.analyzeRedisKeys']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary close a Redis Pub/Sub polling session
@@ -5039,6 +5141,16 @@ export const DmsApiFactory = function (configuration?: Configuration, basePath?:
         alterParameter(requestParameters: DmsApiAlterParameterRequest, options?: RawAxiosRequestConfig): AxiosPromise<string> {
             return localVarFp.alterParameter(requestParameters.orgName, requestParameters.clusterName, requestParameters.tenantId, requestParameters.dmsObAlterParameter, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary analyze Redis keys by bounded SCAN sampling
+         * @param {DmsApiAnalyzeRedisKeysRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        analyzeRedisKeys(requestParameters: DmsApiAnalyzeRedisKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise<RedisAnalysisResponse> {
+            return localVarFp.analyzeRedisKeys(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.database, requestParameters.match, requestParameters.cursor, requestParameters.sampleLimit, requestParameters.topN, requestParameters.namespaceSeparator, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary close a Redis Pub/Sub polling session
@@ -5720,6 +5832,16 @@ export interface DmsApiInterface {
      */
     alterParameter(requestParameters: DmsApiAlterParameterRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
 
+    /**
+     * 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.
+     * @summary analyze Redis keys by bounded SCAN sampling
+     * @param {DmsApiAnalyzeRedisKeysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DmsApiInterface
+     */
+    analyzeRedisKeys(requestParameters: DmsApiAnalyzeRedisKeysRequest, options?: RawAxiosRequestConfig): AxiosPromise<RedisAnalysisResponse>;
+
     /**
      * 
      * @summary close a Redis Pub/Sub polling session
@@ -6419,6 +6541,76 @@ export interface DmsApiAlterParameterRequest {
     readonly dmsObAlterParameter: DmsObAlterParameter
 }
 
+/**
+ * Request parameters for analyzeRedisKeys operation in DmsApi.
+ * @export
+ * @interface DmsApiAnalyzeRedisKeysRequest
+ */
+export interface DmsApiAnalyzeRedisKeysRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly orgName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly clusterName: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly id: string
+
+    /**
+     * 
+     * @type {number}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly database?: number
+
+    /**
+     * Redis SCAN match pattern.
+     * @type {string}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly match?: string
+
+    /**
+     * Cursor returned by a previous analysis scan. Empty starts a new sample scan.
+     * @type {string}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly cursor?: string
+
+    /**
+     * Maximum number of keys to sample in this analysis request.
+     * @type {number}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly sampleLimit?: number
+
+    /**
+     * Maximum number of top keys or namespaces to return.
+     * @type {number}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly topN?: number
+
+    /**
+     * Separator used to group key namespaces.
+     * @type {string}
+     * @memberof DmsApiAnalyzeRedisKeys
+     */
+    readonly namespaceSeparator?: string
+}
+
 /**
  * Request parameters for closeRedisPubSubSession operation in DmsApi.
  * @export
@@ -8944,6 +9136,18 @@ export class DmsApi extends BaseAPI implements DmsApiInterface {
         return DmsApiFp(this.configuration).alterParameter(requestParameters.orgName, requestParameters.clusterName, requestParameters.tenantId, requestParameters.dmsObAlterParameter, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary analyze Redis keys by bounded SCAN sampling
+     * @param {DmsApiAnalyzeRedisKeysRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DmsApi
+     */
+    public analyzeRedisKeys(requestParameters: DmsApiAnalyzeRedisKeysRequest, options?: RawAxiosRequestConfig) {
+        return DmsApiFp(this.configuration).analyzeRedisKeys(requestParameters.orgName, requestParameters.clusterName, requestParameters.id, requestParameters.database, requestParameters.match, requestParameters.cursor, requestParameters.sampleLimit, requestParameters.topN, requestParameters.namespaceSeparator, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary close a Redis Pub/Sub polling session

package/src/adminapi/models/index.ts

@@ -688,6 +688,15 @@ export * from './recycle-bin-cluster';
 export * from './recycle-bin-cluster-list';
 export * from './recycle-bin-cluster-list-item';
 export * from './redis-aclcontext';
+export * from './redis-analysis-expiration-group';
+export * from './redis-analysis-filter';
+export * from './redis-analysis-key';
+export * from './redis-analysis-namespace-summary';
+export * from './redis-analysis-namespace-type-summary';
+export * from './redis-analysis-progress';
+export * from './redis-analysis-response';
+export * from './redis-analysis-simple-type-summary';
+export * from './redis-analysis-typed-summary';
 export * from './redis-capability';
 export * from './redis-cluster-node';
 export * from './redis-cluster-slot';

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

@@ -21,7 +21,7 @@
  */
 export interface PerformanceTrendRange {
     /**
-     * Controlled query range label. Values are 1h, 6h, or 24h.
+     * Controlled query range label. Values are 1h, 6h, 24h, or 7d.
      * @type {string}
      * @memberof PerformanceTrendRange
      */

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

@@ -39,7 +39,7 @@ export interface PerformanceTrendSeries {
      */
     'displayName': LocalizedDescription;
     /**
-     * Metric category. Values are connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
+     * Metric category. Values are availability, performance, connections, resource, capacity, or 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 connectionsSessions, workload, resourcePressure, storagePVC, availability, maintenance, performance, or capacity.
+     * Metric category. Values are availability, performance, connections, resource, capacity, or vacuumWraparound.
      * @type {string}
      * @memberof PerformanceTrendSummary
      */

package/src/adminapi/models/redis-analysis-expiration-group.ts

@@ -0,0 +1,60 @@
+/* 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 RedisAnalysisExpirationGroup
+ */
+export interface RedisAnalysisExpirationGroup {
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisExpirationGroup
+     */
+    'threshold'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisExpirationGroup
+     */
+    'label'?: string;
+    /**
+     * Memory bytes likely to be freed in this TTL group.
+     * @type {number}
+     * @memberof RedisAnalysisExpirationGroup
+     */
+    'total'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisExpirationGroup
+     */
+    'keys'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisExpirationGroup
+     */
+    'keyRatio'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisExpirationGroup
+     */
+    'memoryRatio'?: number;
+}
+

package/src/adminapi/models/redis-analysis-filter.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 RedisAnalysisFilter
+ */
+export interface RedisAnalysisFilter {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisFilter
+     */
+    'match'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisFilter
+     */
+    'count'?: number;
+}
+

package/src/adminapi/models/redis-analysis-key.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 RedisAnalysisKey
+ */
+export interface RedisAnalysisKey {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisKey
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisKey
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisKey
+     */
+    'nsp'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisKey
+     */
+    'ttl'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisKey
+     */
+    'memory'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisKey
+     */
+    'length'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisKey
+     */
+    'encoding'?: string;
+}
+

package/src/adminapi/models/redis-analysis-namespace-summary.ts

@@ -0,0 +1,63 @@
+/* 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 { RedisAnalysisNamespaceTypeSummary } from './redis-analysis-namespace-type-summary';
+
+/**
+ * 
+ * @export
+ * @interface RedisAnalysisNamespaceSummary
+ */
+export interface RedisAnalysisNamespaceSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisNamespaceSummary
+     */
+    'nsp'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceSummary
+     */
+    'keys'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceSummary
+     */
+    'memory'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceSummary
+     */
+    'keyRatio'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceSummary
+     */
+    'memoryRatio'?: number;
+    /**
+     * 
+     * @type {Array<RedisAnalysisNamespaceTypeSummary>}
+     * @memberof RedisAnalysisNamespaceSummary
+     */
+    'types'?: Array<RedisAnalysisNamespaceTypeSummary>;
+}
+

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

@@ -0,0 +1,54 @@
+/* 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 RedisAnalysisNamespaceTypeSummary
+ */
+export interface RedisAnalysisNamespaceTypeSummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisNamespaceTypeSummary
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceTypeSummary
+     */
+    'keys'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceTypeSummary
+     */
+    'memory'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceTypeSummary
+     */
+    'keyRatio'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisNamespaceTypeSummary
+     */
+    'memoryRatio'?: number;
+}
+

package/src/adminapi/models/redis-analysis-progress.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 RedisAnalysisProgress
+ */
+export interface RedisAnalysisProgress {
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisProgress
+     */
+    'total'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisProgress
+     */
+    'scanned'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisProgress
+     */
+    'processed'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisProgress
+     */
+    'sampleLimit'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisProgress
+     */
+    'cursor'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisProgress
+     */
+    'nextCursor'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisProgress
+     */
+    'scannedPercent'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RedisAnalysisProgress
+     */
+    'complete'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RedisAnalysisProgress
+     */
+    'sampled'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisAnalysisProgress
+     */
+    'extrapolationFactor'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisAnalysisProgress
+     */
+    'generatedAt'?: string;
+}
+