kb-cloud-client-typescript 2.3.0-alpha.138 → 2.3.0-alpha.139

package/src/adminapi/models/cluster-slow-log-recommendation.ts

@@ -0,0 +1,57 @@
+/* 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 { ClusterSlowLogLocalizedText } from './cluster-slow-log-localized-text';
+
+/**
+ * A rule-based recommendation for a slow log diagnosis
+ * @export
+ * @interface ClusterSlowLogRecommendation
+ */
+export interface ClusterSlowLogRecommendation {
+    /**
+     * Recommendation type. Current values are create_index, rewrite_sql, reduce_result_set, and investigate_lock.
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'sql'?: string;
+    /**
+     * 
+     * @type {ClusterSlowLogLocalizedText}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'description'?: ClusterSlowLogLocalizedText;
+    /**
+     * Evidence source used by the local rule
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'source'?: string;
+    /**
+     * Recommendation safety level. Current values are manual_review_required and safe_hint_only.
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'safety'?: string;
+}
+

package/src/adminapi/models/index.ts

@@ -175,7 +175,11 @@ export * from './cluster-raw-log-response';
 export * from './cluster-scheduling-policy';
 export * from './cluster-slow-log-database-distribution';
 export * from './cluster-slow-log-detail';
+export * from './cluster-slow-log-diagnosis';
+export * from './cluster-slow-log-diagnosis-issue';
 export * from './cluster-slow-log-explain-response';
+export * from './cluster-slow-log-localized-text';
+export * from './cluster-slow-log-recommendation';
 export * from './cluster-slow-log-stats';
 export * from './cluster-slow-log-template';
 export * from './cluster-slow-log-template-list';

package/src/adminapi.yaml

@@ -27681,6 +27681,80 @@ components:
           type: array
         pagination:
           $ref: '#/components/schemas/clusterLogPagination'
+    clusterSlowLogLocalizedText:
+      type: object
+      description: Localized slow log diagnosis text with dynamic arguments
+      properties:
+        message:
+          $ref: '#/components/schemas/localizedDescription'
+        args:
+          type: object
+          additionalProperties:
+            type: string
+          description: Dynamic values used by the message
+    clusterSlowLogDiagnosisIssue:
+      type: object
+      description: A single detected slow log diagnosis issue
+      properties:
+        code:
+          type: string
+          x-omitempty: false
+        severity:
+          type: string
+          description: Issue severity. Current values are info, low, medium, and high.
+          x-omitempty: false
+        source:
+          type: string
+          description: Evidence source used by the local rule
+          x-omitempty: false
+        message:
+          $ref: '#/components/schemas/localizedDescription'
+        evidence:
+          type: array
+          items:
+            $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        nodeId:
+          type: string
+    clusterSlowLogRecommendation:
+      type: object
+      description: A rule-based recommendation for a slow log diagnosis
+      properties:
+        type:
+          type: string
+          description: Recommendation type. Current values are create_index, rewrite_sql, reduce_result_set, and investigate_lock.
+          x-omitempty: false
+        sql:
+          type: string
+        description:
+          $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        source:
+          type: string
+          description: Evidence source used by the local rule
+          x-omitempty: false
+        safety:
+          type: string
+          description: Recommendation safety level. Current values are manual_review_required and safe_hint_only.
+          x-omitempty: false
+    clusterSlowLogDiagnosis:
+      type: object
+      description: Primary rule-based diagnosis card for a slow log EXPLAIN result
+      properties:
+        engine:
+          type: string
+          description: Diagnosis engine. Current value is rule_based.
+          x-omitempty: false
+        summary:
+          $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        primaryIssue:
+          $ref: '#/components/schemas/clusterSlowLogDiagnosisIssue'
+        optimizationStrategy:
+          $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        recommendedAction:
+          $ref: '#/components/schemas/clusterSlowLogRecommendation'
+        expectedBenefit:
+          type: string
+          description: Expected optimization benefit. Current values are unknown, low, medium, and high.
+          x-omitempty: false
     clusterSlowLogExplainResponse:
       type: object
       description: Explain response for a selected slow log template sample
@@ -27718,6 +27792,8 @@ components:
           $ref: '#/components/schemas/clusterExecutionLogItem'
         explainResult:
           $ref: '#/components/schemas/DmsQueryResponse'
+        diagnosis:
+          $ref: '#/components/schemas/clusterSlowLogDiagnosis'
     clusterSlowLogTemplate:
       type: object
       description: Aggregated slow log query template

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

@@ -252,7 +252,11 @@ models/cluster-raw-log-item.ts
 models/cluster-raw-log-response.ts
 models/cluster-slow-log-database-distribution.ts
 models/cluster-slow-log-detail.ts
+models/cluster-slow-log-diagnosis-issue.ts
+models/cluster-slow-log-diagnosis.ts
 models/cluster-slow-log-explain-response.ts
+models/cluster-slow-log-localized-text.ts
+models/cluster-slow-log-recommendation.ts
 models/cluster-slow-log-stats.ts
 models/cluster-slow-log-template-list.ts
 models/cluster-slow-log-template.ts

package/src/openapi/models/cluster-slow-log-diagnosis-issue.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 { ClusterSlowLogLocalizedText } from './cluster-slow-log-localized-text';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { LocalizedDescription } from './localized-description';
+
+/**
+ * A single detected slow log diagnosis issue
+ * @export
+ * @interface ClusterSlowLogDiagnosisIssue
+ */
+export interface ClusterSlowLogDiagnosisIssue {
+    /**
+     * 
+     * @type {string}
+     * @memberof ClusterSlowLogDiagnosisIssue
+     */
+    'code'?: string;
+    /**
+     * Issue severity. Current values are info, low, medium, and high.
+     * @type {string}
+     * @memberof ClusterSlowLogDiagnosisIssue
+     */
+    'severity'?: string;
+    /**
+     * Evidence source used by the local rule
+     * @type {string}
+     * @memberof ClusterSlowLogDiagnosisIssue
+     */
+    'source'?: string;
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof ClusterSlowLogDiagnosisIssue
+     */
+    'message'?: LocalizedDescription;
+    /**
+     * 
+     * @type {Array<ClusterSlowLogLocalizedText>}
+     * @memberof ClusterSlowLogDiagnosisIssue
+     */
+    'evidence'?: Array<ClusterSlowLogLocalizedText>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClusterSlowLogDiagnosisIssue
+     */
+    'nodeId'?: string;
+}
+

package/src/openapi/models/cluster-slow-log-diagnosis.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 { ClusterSlowLogDiagnosisIssue } from './cluster-slow-log-diagnosis-issue';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClusterSlowLogLocalizedText } from './cluster-slow-log-localized-text';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClusterSlowLogRecommendation } from './cluster-slow-log-recommendation';
+
+/**
+ * Primary rule-based diagnosis card for a slow log EXPLAIN result
+ * @export
+ * @interface ClusterSlowLogDiagnosis
+ */
+export interface ClusterSlowLogDiagnosis {
+    /**
+     * Diagnosis engine. Current value is rule_based.
+     * @type {string}
+     * @memberof ClusterSlowLogDiagnosis
+     */
+    'engine'?: string;
+    /**
+     * 
+     * @type {ClusterSlowLogLocalizedText}
+     * @memberof ClusterSlowLogDiagnosis
+     */
+    'summary'?: ClusterSlowLogLocalizedText;
+    /**
+     * 
+     * @type {ClusterSlowLogDiagnosisIssue}
+     * @memberof ClusterSlowLogDiagnosis
+     */
+    'primaryIssue'?: ClusterSlowLogDiagnosisIssue;
+    /**
+     * 
+     * @type {ClusterSlowLogLocalizedText}
+     * @memberof ClusterSlowLogDiagnosis
+     */
+    'optimizationStrategy'?: ClusterSlowLogLocalizedText;
+    /**
+     * 
+     * @type {ClusterSlowLogRecommendation}
+     * @memberof ClusterSlowLogDiagnosis
+     */
+    'recommendedAction'?: ClusterSlowLogRecommendation;
+    /**
+     * Expected optimization benefit. Current values are unknown, low, medium, and high.
+     * @type {string}
+     * @memberof ClusterSlowLogDiagnosis
+     */
+    'expectedBenefit'?: string;
+}
+

package/src/openapi/models/cluster-slow-log-explain-response.ts

@@ -18,6 +18,9 @@
 import type { ClusterExecutionLogItem } from './cluster-execution-log-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { ClusterSlowLogDiagnosis } from './cluster-slow-log-diagnosis';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { DmsQueryResponse } from './dms-query-response';
 
 /**
@@ -80,5 +83,11 @@ export interface ClusterSlowLogExplainResponse {
      * @memberof ClusterSlowLogExplainResponse
      */
     'explainResult'?: DmsQueryResponse;
+    /**
+     * 
+     * @type {ClusterSlowLogDiagnosis}
+     * @memberof ClusterSlowLogExplainResponse
+     */
+    'diagnosis'?: ClusterSlowLogDiagnosis;
 }
 

package/src/openapi/models/cluster-slow-log-localized-text.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 { LocalizedDescription } from './localized-description';
+
+/**
+ * Localized slow log diagnosis text with dynamic arguments
+ * @export
+ * @interface ClusterSlowLogLocalizedText
+ */
+export interface ClusterSlowLogLocalizedText {
+    /**
+     * 
+     * @type {LocalizedDescription}
+     * @memberof ClusterSlowLogLocalizedText
+     */
+    'message'?: LocalizedDescription;
+    /**
+     * Dynamic values used by the message
+     * @type {{ [key: string]: string; }}
+     * @memberof ClusterSlowLogLocalizedText
+     */
+    'args'?: { [key: string]: string; };
+}
+

package/src/openapi/models/cluster-slow-log-recommendation.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 { ClusterSlowLogLocalizedText } from './cluster-slow-log-localized-text';
+
+/**
+ * A rule-based recommendation for a slow log diagnosis
+ * @export
+ * @interface ClusterSlowLogRecommendation
+ */
+export interface ClusterSlowLogRecommendation {
+    /**
+     * Recommendation type. Current values are create_index, rewrite_sql, reduce_result_set, and investigate_lock.
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'sql'?: string;
+    /**
+     * 
+     * @type {ClusterSlowLogLocalizedText}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'description'?: ClusterSlowLogLocalizedText;
+    /**
+     * Evidence source used by the local rule
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'source'?: string;
+    /**
+     * Recommendation safety level. Current values are manual_review_required and safe_hint_only.
+     * @type {string}
+     * @memberof ClusterSlowLogRecommendation
+     */
+    'safety'?: string;
+}
+

package/src/openapi/models/index.ts

@@ -168,7 +168,11 @@ export * from './cluster-raw-log-item';
 export * from './cluster-raw-log-response';
 export * from './cluster-slow-log-database-distribution';
 export * from './cluster-slow-log-detail';
+export * from './cluster-slow-log-diagnosis';
+export * from './cluster-slow-log-diagnosis-issue';
 export * from './cluster-slow-log-explain-response';
+export * from './cluster-slow-log-localized-text';
+export * from './cluster-slow-log-recommendation';
 export * from './cluster-slow-log-stats';
 export * from './cluster-slow-log-template';
 export * from './cluster-slow-log-template-list';

package/src/openapi.yaml

@@ -21668,6 +21668,80 @@ components:
           items:
             type: string
           nullable: true
+    clusterSlowLogLocalizedText:
+      type: object
+      description: Localized slow log diagnosis text with dynamic arguments
+      properties:
+        message:
+          $ref: '#/components/schemas/localizedDescription'
+        args:
+          type: object
+          additionalProperties:
+            type: string
+          description: Dynamic values used by the message
+    clusterSlowLogDiagnosisIssue:
+      type: object
+      description: A single detected slow log diagnosis issue
+      properties:
+        code:
+          type: string
+          x-omitempty: false
+        severity:
+          type: string
+          description: Issue severity. Current values are info, low, medium, and high.
+          x-omitempty: false
+        source:
+          type: string
+          description: Evidence source used by the local rule
+          x-omitempty: false
+        message:
+          $ref: '#/components/schemas/localizedDescription'
+        evidence:
+          type: array
+          items:
+            $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        nodeId:
+          type: string
+    clusterSlowLogRecommendation:
+      type: object
+      description: A rule-based recommendation for a slow log diagnosis
+      properties:
+        type:
+          type: string
+          description: Recommendation type. Current values are create_index, rewrite_sql, reduce_result_set, and investigate_lock.
+          x-omitempty: false
+        sql:
+          type: string
+        description:
+          $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        source:
+          type: string
+          description: Evidence source used by the local rule
+          x-omitempty: false
+        safety:
+          type: string
+          description: Recommendation safety level. Current values are manual_review_required and safe_hint_only.
+          x-omitempty: false
+    clusterSlowLogDiagnosis:
+      type: object
+      description: Primary rule-based diagnosis card for a slow log EXPLAIN result
+      properties:
+        engine:
+          type: string
+          description: Diagnosis engine. Current value is rule_based.
+          x-omitempty: false
+        summary:
+          $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        primaryIssue:
+          $ref: '#/components/schemas/clusterSlowLogDiagnosisIssue'
+        optimizationStrategy:
+          $ref: '#/components/schemas/clusterSlowLogLocalizedText'
+        recommendedAction:
+          $ref: '#/components/schemas/clusterSlowLogRecommendation'
+        expectedBenefit:
+          type: string
+          description: Expected optimization benefit. Current values are unknown, low, medium, and high.
+          x-omitempty: false
     clusterSlowLogExplainResponse:
       type: object
       description: Explain response for a selected slow log template sample
@@ -21705,6 +21779,8 @@ components:
           $ref: '#/components/schemas/clusterExecutionLogItem'
         explainResult:
           $ref: '#/components/schemas/DmsQueryResponse'
+        diagnosis:
+          $ref: '#/components/schemas/clusterSlowLogDiagnosis'
     clusterSlowLogTemplate:
       type: object
       description: Aggregated slow log query template