kb-cloud-client-typescript 2.4.0-alpha.114 → 2.4.0-alpha.116

package/src/adminapi/models/data-channel-endpoint-create.ts

@@ -21,14 +21,23 @@ import type { CustomEndpointCreate } from './custom-endpoint-create';
 import type { DataReplicationEndpointType } from './data-replication-endpoint-type';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { DefinitionEndpoint } from './definition-endpoint';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { KubeblocksEndpoint } from './kubeblocks-endpoint';
 
 /**
- * 
+ * Use endpointType custom or kubeblocks with the corresponding inline connection configuration, or endpointType definition with definition.endpointID to reuse an existing data endpoint. Inline connection configuration is not used for endpointType definition.
  * @export
  * @interface DataChannelEndpointCreate
  */
 export interface DataChannelEndpointCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataChannelEndpointCreate
+     */
+    'name'?: string | null;
     /**
      * 
      * @type {string}
@@ -59,6 +68,18 @@ export interface DataChannelEndpointCreate {
      * @memberof DataChannelEndpointCreate
      */
     'kubeblocks'?: KubeblocksEndpoint;
+    /**
+     * 
+     * @type {DefinitionEndpoint}
+     * @memberof DataChannelEndpointCreate
+     */
+    'definition'?: DefinitionEndpoint;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataChannelEndpointCreate
+     */
+    'description'?: string | null;
     /**
      * 
      * @type {{ [key: string]: string; }}

package/src/adminapi/models/data-channel-list-endpoint.ts

@@ -21,6 +21,9 @@ import type { CustomEndpoint } from './custom-endpoint';
 import type { DataReplicationEndpointType } from './data-replication-endpoint-type';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { DefinitionEndpoint } from './definition-endpoint';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { KubeblocksEndpoint } from './kubeblocks-endpoint';
 
 /**
@@ -29,6 +32,18 @@ import type { KubeblocksEndpoint } from './kubeblocks-endpoint';
  * @interface DataChannelListEndpoint
  */
 export interface DataChannelListEndpoint {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataChannelListEndpoint
+     */
+    'id'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataChannelListEndpoint
+     */
+    'name'?: string | null;
     /**
      * 
      * @type {string}
@@ -53,6 +68,18 @@ export interface DataChannelListEndpoint {
      * @memberof DataChannelListEndpoint
      */
     'kubeblocks'?: KubeblocksEndpoint;
+    /**
+     * 
+     * @type {DefinitionEndpoint}
+     * @memberof DataChannelListEndpoint
+     */
+    'definition'?: DefinitionEndpoint;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataChannelListEndpoint
+     */
+    'description'?: string | null;
     /**
      * 
      * @type {{ [key: string]: string; }}

package/src/adminapi/models/data-endpoint-create.ts

@@ -0,0 +1,83 @@
+/* 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 { CustomEndpointCreate } from './custom-endpoint-create';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DataEndpointTypeCreation } from './data-endpoint-type-creation';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KubeblocksEndpoint } from './kubeblocks-endpoint';
+
+/**
+ * Connection configuration for an independently managed data endpoint.
+ * @export
+ * @interface DataEndpointCreate
+ */
+export interface DataEndpointCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointCreate
+     */
+    'name'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointCreate
+     */
+    'engineName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointCreate
+     */
+    'definitionName'?: string;
+    /**
+     * 
+     * @type {DataEndpointTypeCreation}
+     * @memberof DataEndpointCreate
+     */
+    'endpointType'?: DataEndpointTypeCreation;
+    /**
+     * 
+     * @type {CustomEndpointCreate}
+     * @memberof DataEndpointCreate
+     */
+    'custom'?: CustomEndpointCreate;
+    /**
+     * 
+     * @type {KubeblocksEndpoint}
+     * @memberof DataEndpointCreate
+     */
+    'kubeblocks'?: KubeblocksEndpoint;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointCreate
+     */
+    'description'?: string | null;
+    /**
+     * 
+     * @type {{ [key: string]: string; }}
+     * @memberof DataEndpointCreate
+     */
+    'extraCfgs'?: { [key: string]: string; } | null;
+}
+
+
+

package/src/adminapi/models/data-endpoint-response.ts

@@ -0,0 +1,48 @@
+/* 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 DataEndpointResponse
+ */
+export interface DataEndpointResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointResponse
+     */
+    'endpointID'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointResponse
+     */
+    'endpointName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointResponse
+     */
+    'createdAt'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataEndpointResponse
+     */
+    'updatedAt'?: string | null;
+}
+

package/src/adminapi/models/data-endpoint-type-creation.ts

@@ -0,0 +1,31 @@
+/* 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
+ * @enum {string}
+ */
+
+export const DataEndpointTypeCreation = {
+    custom: 'custom',
+    kubeblocks: 'kubeblocks'
+} as const;
+
+export type DataEndpointTypeCreation = typeof DataEndpointTypeCreation[keyof typeof DataEndpointTypeCreation];
+
+
+

package/src/adminapi/models/data-replication-endpoint-type.ts

@@ -22,7 +22,8 @@
 
 export const DataReplicationEndpointType = {
     custom: 'custom',
-    kubeblocks: 'kubeblocks'
+    kubeblocks: 'kubeblocks',
+    definition: 'definition'
 } as const;
 
 export type DataReplicationEndpointType = typeof DataReplicationEndpointType[keyof typeof DataReplicationEndpointType];

package/src/adminapi/models/definition-endpoint.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * Reference to an existing data endpoint in the same organization.
+ * @export
+ * @interface DefinitionEndpoint
+ */
+export interface DefinitionEndpoint {
+    /**
+     * 
+     * @type {string}
+     * @memberof DefinitionEndpoint
+     */
+    'endpointID': string;
+}
+

package/src/adminapi/models/index.ts

@@ -302,6 +302,9 @@ export * from './data-check-summary';
 export * from './data-check-table-summary';
 export * from './data-check-type';
 export * from './data-disk';
+export * from './data-endpoint-create';
+export * from './data-endpoint-response';
+export * from './data-endpoint-type-creation';
 export * from './data-import200-response';
 export * from './data-replication-channel-container';
 export * from './data-replication-create';
@@ -323,6 +326,7 @@ export * from './database-parameter-list-item';
 export * from './database-parameter-type';
 export * from './datasource';
 export * from './db-tderequest';
+export * from './definition-endpoint';
 export * from './delete-database-parameter-item';
 export * from './delete-storage-class204-response';
 export * from './disaster-recovery-cluster-item';

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

@@ -85,10 +85,10 @@ export interface RedisKeyAnalysisReport {
     'totalNumKeys'?: number;
     /**
      * Sum of bytes across all byteLevelStat buckets.
-     * @type {string}
+     * @type {number}
      * @memberof RedisKeyAnalysisReport
      */
-    'totlSizeKeys'?: string;
+    'totalSizeKeys'?: number;
     /**
      * Key statistics by remaining TTL bucket: {bucket: {count, bytes}}.
      * @type {{ [key: string]: RedisKeyAnalysisReportTypeStatValue; }}

package/src/adminapi.yaml

@@ -30540,6 +30540,174 @@ paths:
           $ref: '#/components/responses/404'
       tags:
         - dataReplication
+  /admin/v1/replication/endpoints:
+    get:
+      operationId: listAdminDataEndpoints
+      summary: List Data Endpoints
+      description: Retrieve a list of data endpoints.
+      parameters:
+        - description: The Name of the organization
+          in: query
+          name: orgName
+          required: false
+          schema:
+            type: string
+        - description: The name of the data endpoint
+          in: query
+          name: name
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataEndpointList'
+          description: A list of data endpoints.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+  /admin/v1/organizations/{orgName}/replication/endpoint:
+    post:
+      operationId: createAdminDataEndpoint
+      summary: Create a new data endpoint
+      description: Create a new data endpoint.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/dataEndpointCreate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataEndpointResponse'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+      x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/replication/endpoint/{endpointID}:
+    get:
+      operationId: getDataEndpoint
+      summary: Get Data Endpoint Details
+      description: Retrieve a data endpoint detail.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data endpoint
+          in: path
+          name: endpointID
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataChannelListEndpoint'
+          description: A detail of data endpoint.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+    delete:
+      operationId: deleteDataEndpoint
+      summary: Delete a data endpoint
+      description: Delete a data endpoint.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data endpoint
+          in: path
+          name: endpointID
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when endpoint is deleted successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+    patch:
+      operationId: updateDataEndpoint
+      summary: Update a data endpoint
+      description: Update an existing data endpoint.
+      parameters:
+        - description: The Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the data endpoint
+          in: path
+          name: endpointID
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/dataEndpointCreate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dataEndpointResponse'
+          description: A successful response.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - dataReplication
+      x-codegen-request-body-name: body
   /admin/v1/checks:
     get:
       operationId: listAdminDataChecks
@@ -53632,9 +53800,12 @@ components:
         totalNumKeys:
           type: integer
           format: int64
+          x-omitempty: false
           description: Sum of counts across all byteLevelStat buckets.
-        totlSizeKeys:
-          type: string
+        totalSizeKeys:
+          type: integer
+          format: int64
+          x-omitempty: false
           description: Sum of bytes across all byteLevelStat buckets.
         expireStat:
           type: object
@@ -53686,6 +53857,7 @@ components:
       enum:
         - custom
         - kubeblocks
+        - definition
       type: string
     authType:
       enum:
@@ -53727,9 +53899,24 @@ components:
         displayName:
           type: string
           nullable: true
+    definitionEndpoint:
+      type: object
+      description: Reference to an existing data endpoint in the same organization.
+      required:
+        - endpointID
+      properties:
+        endpointID:
+          type: string
+          minLength: 1
     dataChannelListEndpoint:
       type: object
       properties:
+        id:
+          type: string
+          nullable: true
+        name:
+          type: string
+          nullable: true
         engineName:
           type: string
         endpointType:
@@ -53740,6 +53927,12 @@ components:
         kubeblocks:
           $ref: '#/components/schemas/kubeblocksEndpoint'
           nullable: true
+        definition:
+          $ref: '#/components/schemas/definitionEndpoint'
+          nullable: true
+        description:
+          type: string
+          nullable: true
         extraCfgs:
           type: object
           additionalProperties:
@@ -53803,7 +53996,11 @@ components:
           nullable: true
     dataChannelEndpointCreate:
       type: object
+      description: Use endpointType custom or kubeblocks with the corresponding inline connection configuration, or endpointType definition with definition.endpointID to reuse an existing data endpoint. Inline connection configuration is not used for endpointType definition.
       properties:
+        name:
+          type: string
+          nullable: true
         engineName:
           type: string
         definitionName:
@@ -53816,6 +54013,12 @@ components:
         kubeblocks:
           $ref: '#/components/schemas/kubeblocksEndpoint'
           nullable: true
+        definition:
+          $ref: '#/components/schemas/definitionEndpoint'
+          nullable: true
+        description:
+          type: string
+          nullable: true
         extraCfgs:
           type: object
           additionalProperties:
@@ -53989,6 +54192,56 @@ components:
         type: array
         items:
           $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
+    dataEndpointList:
+      type: array
+      items:
+        $ref: '#/components/schemas/dataChannelListEndpoint'
+    dataEndpointTypeCreation:
+      enum:
+        - custom
+        - kubeblocks
+      type: string
+    dataEndpointCreate:
+      type: object
+      description: Connection configuration for an independently managed data endpoint.
+      properties:
+        name:
+          type: string
+          nullable: true
+        engineName:
+          type: string
+        definitionName:
+          type: string
+        endpointType:
+          $ref: '#/components/schemas/dataEndpointTypeCreation'
+        custom:
+          $ref: '#/components/schemas/customEndpointCreate'
+          nullable: true
+        kubeblocks:
+          $ref: '#/components/schemas/kubeblocksEndpoint'
+          nullable: true
+        description:
+          type: string
+          nullable: true
+        extraCfgs:
+          type: object
+          additionalProperties:
+            type: string
+          nullable: true
+    dataEndpointResponse:
+      type: object
+      properties:
+        endpointID:
+          type: string
+        endpointName:
+          type: string
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+          nullable: true
     dataCheckType:
       type: string
       description: Type of check to run. A standalone check runs exactly one type.

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

@@ -376,6 +376,9 @@ models/data-check-summary.ts
 models/data-check-table-summary.ts
 models/data-check-type.ts
 models/data-disk.ts
+models/data-endpoint-create.ts
+models/data-endpoint-response.ts
+models/data-endpoint-type-creation.ts
 models/data-import200-response.ts
 models/data-replication-channel-container.ts
 models/data-replication-create.ts
@@ -392,6 +395,7 @@ models/database-option.ts
 models/database.ts
 models/datasource.ts
 models/db-tderequest.ts
+models/definition-endpoint.ts
 models/delete-bench-option.ts
 models/disaster-recovery-cluster-item.ts
 models/disaster-recovery-cluster-list.ts