kb-cloud-client-typescript 2.3.0-beta.0 → 2.3.0-beta.2

package/src/adminapi.yaml

@@ -2263,6 +2263,19 @@ paths:
           required: false
           schema:
             type: boolean
+        - name: endpointHost
+          in: query
+          description: Case-insensitive substring to match against the host part of cached cluster endpoints
+          required: false
+          schema:
+            type: string
+        - name: includeEndpoints
+          in: query
+          description: Whether to include cached user-visible endpoints in each cluster item
+          required: false
+          schema:
+            type: boolean
+            default: false
       responses:
         '200':
           description: OK
@@ -2339,6 +2352,17 @@ paths:
           description: list clusters referenced by this cluster
           schema:
             type: string
+        - name: endpointHost
+          in: query
+          description: Case-insensitive substring to match against the host part of cached cluster endpoints
+          schema:
+            type: string
+        - name: includeEndpoints
+          in: query
+          description: Whether to include cached user-visible endpoints in each cluster item
+          schema:
+            type: boolean
+            default: false
       responses:
         '200':
           description: A successful response.
@@ -10792,6 +10816,85 @@ paths:
         '404':
           $ref: '#/components/responses/404'
       x-codegen-request-body-name: body
+  /admin/v1/environments/{environmentName}/loadbalancer/config:
+    get:
+      tags:
+        - loadBalancer
+      operationId: getLoadBalancerConfig
+      summary: Get the effective load balancer configuration of an environment
+      parameters:
+        - name: environmentName
+          in: path
+          description: name of the environment
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/loadBalancerConfig'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+    put:
+      tags:
+        - loadBalancer
+      operationId: updateLoadBalancerConfig
+      summary: Save and immediately activate the load balancer configuration of an environment
+      parameters:
+        - name: environmentName
+          in: path
+          description: name of the environment
+          required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/loadBalancerConfigUpdate'
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/loadBalancerConfig'
+        '400':
+          $ref: '#/components/responses/400'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      x-codegen-request-body-name: body
+    delete:
+      tags:
+        - loadBalancer
+      operationId: resetLoadBalancerConfig
+      summary: Reset the environment load balancer configuration to the current provider defaults
+      parameters:
+        - name: environmentName
+          in: path
+          description: name of the environment
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: The effective provider defaults after reset.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/loadBalancerConfig'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
   /admin/v1/environments/{environmentName}/loadbalancer/vipPool:
     get:
       operationId: listVIPPool
@@ -25629,6 +25732,88 @@ components:
         - Normal
         - DisasterRecovery
         - BlueGreenDeployment
+    tag:
+      description: tag info
+      properties:
+        id:
+          description: The id of the tag
+          format: int64
+          type: string
+        key:
+          description: the key of the tag
+          type: string
+        value:
+          description: The value corresponding to the key
+          type: string
+      required:
+        - id
+      type: object
+    endpointType:
+      description: Type of endpoint
+      type: string
+      enum:
+        - ClusterIP
+        - NodePort
+        - LoadBalancer
+        - PodIP
+        - HostNetwork
+        - PodFQDN
+    endpointNetworkType:
+      description: Network type of endpoint
+      type: string
+      enum:
+        - Internet
+        - Intranet
+    endpoint:
+      description: Endpoint is the information of cluster endpoints
+      properties:
+        title:
+          description: title of the endpoint
+          type: string
+        component:
+          description: Component type name
+          type: string
+        hosts:
+          description: Endpoint hosts
+          type: array
+          items:
+            type: string
+        port:
+          description: Endpoint port
+          type: integer
+          format: int32
+        type:
+          $ref: '#/components/schemas/endpointType'
+        networkType:
+          $ref: '#/components/schemas/endpointNetworkType'
+        serviceName:
+          description: Service name of endpoint
+          type: string
+        podService:
+          description: Pod service name of endpoint
+          type: boolean
+        portName:
+          description: Port name of endpoint
+          type: string
+        instances:
+          description: Endpoint backend instances
+          type: array
+          items:
+            type: string
+        mutable:
+          description: Whether the endpoint is mutable
+          type: boolean
+      required:
+        - title
+        - component
+        - hosts
+        - port
+        - type
+        - networkType
+        - serviceName
+        - portName
+        - mutable
+      type: object
     clusterListItem:
       description: KubeBlocks cluster information
       properties:
@@ -25735,6 +25920,20 @@ components:
         orgName:
           description: Org Name
           type: string
+        project:
+          description: Name of project, it is the alias of environment namespace
+          type: string
+        tags:
+          description: Tags bound to the cluster
+          items:
+            $ref: '#/components/schemas/tag'
+          type: array
+        endpoints:
+          description: Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+          items:
+            $ref: '#/components/schemas/endpoint'
+          type: array
+          x-omitempty: true
       required:
         - cloudProvider
         - createdAt
@@ -26716,72 +26915,6 @@ components:
         log:
           type: string
           description: log is the log of the specified container
-    endpointType:
-      description: Type of endpoint
-      type: string
-      enum:
-        - ClusterIP
-        - NodePort
-        - LoadBalancer
-        - PodIP
-        - HostNetwork
-        - PodFQDN
-    endpointNetworkType:
-      description: Network type of endpoint
-      type: string
-      enum:
-        - Internet
-        - Intranet
-    endpoint:
-      description: Endpoint is the information of cluster endpoints
-      properties:
-        title:
-          description: title of the endpoint
-          type: string
-        component:
-          description: Component type name
-          type: string
-        hosts:
-          description: Endpoint hosts
-          type: array
-          items:
-            type: string
-        port:
-          description: Endpoint port
-          type: integer
-          format: int32
-        type:
-          $ref: '#/components/schemas/endpointType'
-        networkType:
-          $ref: '#/components/schemas/endpointNetworkType'
-        serviceName:
-          description: Service name of endpoint
-          type: string
-        podService:
-          description: Pod service name of endpoint
-          type: boolean
-        portName:
-          description: Port name of endpoint
-          type: string
-        instances:
-          description: Endpoint backend instances
-          type: array
-          items:
-            type: string
-        mutable:
-          description: Whether the endpoint is mutable
-          type: boolean
-      required:
-        - title
-        - component
-        - hosts
-        - port
-        - type
-        - networkType
-        - serviceName
-        - portName
-        - mutable
-      type: object
     endpointList:
       required:
         - items
@@ -26868,22 +27001,6 @@ components:
         taskId:
           type: string
           description: Task ID if the operation is asynchronous (e.g. reconfigure)
-    tag:
-      description: tag info
-      properties:
-        id:
-          description: The id of the tag
-          format: int64
-          type: string
-        key:
-          description: the key of the tag
-          type: string
-        value:
-          description: The value corresponding to the key
-          type: string
-      required:
-        - id
-      type: object
     clusterTags:
       properties:
         clusterId:
@@ -31719,6 +31836,12 @@ components:
           type: array
           items:
             type: string
+    systemComponentSchedulerPolicy:
+      type: string
+      enum:
+        - default
+        - koordinator
+      default: default
     schedulingConfig:
       type: object
       title: SchedulingConfig
@@ -31728,6 +31851,13 @@ components:
           $ref: '#/components/schemas/clusterSchedulingPolicy'
         tolerateDefaultTaints:
           $ref: '#/components/schemas/tolerateDefaultTaints'
+        systemComponentSchedulerPolicy:
+          $ref: '#/components/schemas/systemComponentSchedulerPolicy'
+          description: Scheduler policy used by internal system component clusters, including MinIO, VictoriaMetrics, and Victoria Logs. The persisted policy is resolved to the current scheduler name when a component is created.
+        systemComponentReservationResourceClass:
+          nullable: true
+          $ref: '#/components/schemas/koordinatorReservationResourceClass'
+          description: Optional Reservation resource class used by internal system component clusters when the Koordinator scheduler is selected. No Reservation label is added unless the user explicitly selects a resource class. The value is persisted on the environment.
     networkConfig:
       type: object
       title: NetworkConfig
@@ -32905,6 +33035,43 @@ components:
       required:
         - status
       type: object
+    loadBalancerAnnotations:
+      description: Provider-neutral annotations applied to load balancer Services by exposure type.
+      type: object
+      properties:
+        vpc:
+          description: Annotations used for load balancers exposed inside the VPC.
+          type: object
+          additionalProperties:
+            type: string
+        internet:
+          description: Annotations used for load balancers exposed to the Internet.
+          type: object
+          additionalProperties:
+            type: string
+      required:
+        - vpc
+        - internet
+    loadBalancerConfig:
+      description: Effective load balancer annotations for an environment.
+      type: object
+      properties:
+        provider:
+          description: Current environment provider returned by the server.
+          type: string
+        annotations:
+          $ref: '#/components/schemas/loadBalancerAnnotations'
+      required:
+        - provider
+        - annotations
+    loadBalancerConfigUpdate:
+      description: Complete editable load balancer annotations for an environment.
+      type: object
+      properties:
+        annotations:
+          $ref: '#/components/schemas/loadBalancerAnnotations'
+      required:
+        - annotations
     vipPool:
       description: VIP Pool
       properties:

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

@@ -78,3 +78,4 @@ models/service-ref.ts
 models/static-cluster.ts
 models/storage-create.ts
 models/storage.ts
+models/tag.ts

package/src/internalapi/apis/cluster-api.ts

@@ -342,10 +342,12 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
          * @param {Array<string>} [tagKeys] A list of tags\&#39; keys
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        listCluster: async (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, endpointHost?: string, includeEndpoints?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('listCluster', 'orgName', orgName)
             const localVarPath = `/internal/v1/organizations/{orgName}/clusters`
@@ -397,6 +399,14 @@ export const ClusterApiAxiosParamCreator = function (configuration?: Configurati
                 localVarQueryParameter['licenseId'] = licenseId;
             }
 
+            if (endpointHost !== undefined) {
+                localVarQueryParameter['endpointHost'] = endpointHost;
+            }
+
+            if (includeEndpoints !== undefined) {
+                localVarQueryParameter['includeEndpoints'] = includeEndpoints;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -621,11 +631,13 @@ export const ClusterApiFp = function(configuration?: Configuration) {
          * @param {Array<string>} [tagKeys] A list of tags\&#39; keys
          * @param {Array<string>} [tagValues] A list of tags\&#39; values corresponding to the tagKeys
          * @param {number} [licenseId] license id
+         * @param {string} [endpointHost] Case-insensitive substring to match against the host part of cached cluster endpoints
+         * @param {boolean} [includeEndpoints] Whether to include cached user-visible endpoints in each cluster item
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, options);
+        async listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, endpointHost?: string, includeEndpoints?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCluster(orgName, clusterDefinition, environmentName, environmentType, tagKey, tagValue, tagKeys, tagValues, licenseId, endpointHost, includeEndpoints, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['ClusterApi.listCluster']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -748,7 +760,7 @@ export const ClusterApiFactory = function (configuration?: Configuration, basePa
          * @throws {RequiredError}
          */
         listCluster(requestParameters: ClusterApiListClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterList> {
-            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, options).then((request) => request(axios, basePath));
+            return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -1082,6 +1094,20 @@ export interface ClusterApiListClusterRequest {
      * @memberof ClusterApiListCluster
      */
     readonly licenseId?: number
+
+    /**
+     * Case-insensitive substring to match against the host part of cached cluster endpoints
+     * @type {string}
+     * @memberof ClusterApiListCluster
+     */
+    readonly endpointHost?: string
+
+    /**
+     * Whether to include cached user-visible endpoints in each cluster item
+     * @type {boolean}
+     * @memberof ClusterApiListCluster
+     */
+    readonly includeEndpoints?: boolean
 }
 
 /**
@@ -1240,7 +1266,7 @@ export class ClusterApi extends BaseAPI implements ClusterApiInterface {
      * @memberof ClusterApi
      */
     public listCluster(requestParameters: ClusterApiListClusterRequest, options?: RawAxiosRequestConfig) {
-        return ClusterApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, options).then((request) => request(this.axios, this.basePath));
+        return ClusterApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/internalapi/models/cluster-list-item.ts

@@ -16,6 +16,12 @@
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ClusterType } from './cluster-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Endpoint } from './endpoint';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { Tag } from './tag';
 
 /**
  * KubeBlocks cluster information
@@ -179,6 +185,24 @@ export interface ClusterListItem {
      * @memberof ClusterListItem
      */
     'orgName'?: string;
+    /**
+     * Name of project, it is the alias of environment namespace
+     * @type {string}
+     * @memberof ClusterListItem
+     */
+    'project'?: string;
+    /**
+     * Tags bound to the cluster
+     * @type {Array<Tag>}
+     * @memberof ClusterListItem
+     */
+    'tags'?: Array<Tag>;
+    /**
+     * Cached user-visible endpoints of the cluster; omitted unless includeEndpoints is true
+     * @type {Array<Endpoint>}
+     * @memberof ClusterListItem
+     */
+    'endpoints'?: Array<Endpoint>;
 }
 
 

package/src/internalapi/models/index.ts

@@ -53,3 +53,4 @@ export * from './service-ref';
 export * from './static-cluster';
 export * from './storage';
 export * from './storage-create';
+export * from './tag';

package/src/internalapi/models/tag.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud Internal API
+ * The Internal API is using for interaction of ApeCloud platform microservices. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * tag info
+ * @export
+ * @interface Tag
+ */
+export interface Tag {
+    /**
+     * The id of the tag
+     * @type {string}
+     * @memberof Tag
+     */
+    'id': string;
+    /**
+     * the key of the tag
+     * @type {string}
+     * @memberof Tag
+     */
+    'key'?: string;
+    /**
+     * The value corresponding to the key
+     * @type {string}
+     * @memberof Tag
+     */
+    'value'?: string;
+}
+