kb-cloud-client-typescript 2.3.0-alpha.185 → 2.3.0-alpha.186

package/src/adminapi.yaml

@@ -11011,6 +11011,34 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /admin/v1/environments/{environmentName}/network/ipPools:
+    get:
+      tags:
+        - environment
+      operationId: listEnvironmentIPPools
+      summary: Discover Pod IP pools and explicit selection policy in an environment
+      parameters:
+        - description: name of the Environment
+          in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ipPoolList'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
   /admin/v1/environmentObjectStorage:
     post:
       operationId: listEnvironmentObjectStorage
@@ -24880,6 +24908,35 @@ components:
           $ref: '#/components/schemas/ioQuantity'
         ioReserves:
           $ref: '#/components/schemas/ioQuantity'
+    ipPoolProvider:
+      type: string
+      description: KBE provider used for Pod IP pool discovery and explicit selection.
+      enum:
+        - spiderpool
+    ipPoolSelection:
+      type: object
+      description: Provider-qualified Pod IP pool selection for component pod IP allocation.
+      required:
+        - provider
+      properties:
+        provider:
+          $ref: '#/components/schemas/ipPoolProvider'
+        ipv4Pools:
+          type: array
+          items:
+            type: string
+          description: IPv4 pool names resolved within the selected provider.
+        ipv6Pools:
+          type: array
+          items:
+            type: string
+          description: IPv6 pool names resolved within the selected provider.
+    componentNetwork:
+      type: object
+      description: Per-component network configuration.
+      properties:
+        ipPool:
+          $ref: '#/components/schemas/ipPoolSelection'
     componentItemCreate:
       type: object
       description: ComponentItem is the information of a component
@@ -24928,6 +24985,8 @@ components:
         systemAccountSecretName:
           description: The name of the secret that contains the system account credentials
           type: string
+        network:
+          $ref: '#/components/schemas/componentNetwork'
     componentsCreate:
       type: array
       description: Components is the list of components
@@ -25244,6 +25303,8 @@ components:
         systemAccountSecretName:
           description: The name of the secret that contains the system account credentials
           type: string
+        network:
+          $ref: '#/components/schemas/componentNetwork'
     components:
       type: array
       description: Components is the list of components
@@ -30587,6 +30648,7 @@ components:
         - provisionConfig
         - createdAt
         - updatedAt
+        - ipPoolProviders
       properties:
         provider:
           description: Cloud Provider
@@ -30662,6 +30724,11 @@ components:
           description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
           type: boolean
           default: false
+        ipPoolProviders:
+          description: KBE Pod IP pool providers enabled for discovery and explicit pool selection.
+          type: array
+          items:
+            $ref: '#/components/schemas/ipPoolProvider'
     environmentList:
       description: EnvironmentList is a list of Environments
       properties:
@@ -30745,6 +30812,12 @@ components:
           description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
           type: boolean
           default: false
+        ipPoolProviders:
+          description: KBE Pod IP pool providers enabled for discovery and explicit pool selection.
+          type: array
+          default: []
+          items:
+            $ref: '#/components/schemas/ipPoolProvider'
     preflight:
       title: Preflight results
       description: The result of preflight check
@@ -30877,6 +30950,11 @@ components:
           description: Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
           type: boolean
           default: false
+        ipPoolProviders:
+          description: KBE Pod IP pool providers enabled for discovery and explicit pool selection. An empty array disables this capability.
+          type: array
+          items:
+            $ref: '#/components/schemas/ipPoolProvider'
         clusterSchedulingPolicy:
           $ref: '#/components/schemas/clusterSchedulingPolicy'
     environmentStateEvent:
@@ -31704,6 +31782,83 @@ components:
       items:
         type: string
       type: array
+    ipPoolSelectionRequirement:
+      type: string
+      enum:
+        - required
+        - optional
+        - unsupported
+    ipPoolSelectionPolicy:
+      type: object
+      description: Per-address-family requirements for explicit IP pool selection.
+      properties:
+        ipv4:
+          $ref: '#/components/schemas/ipPoolSelectionRequirement'
+        ipv6:
+          $ref: '#/components/schemas/ipPoolSelectionRequirement'
+      required:
+        - ipv4
+        - ipv6
+    ipPoolIPFamily:
+      type: string
+      enum:
+        - IPv4
+        - IPv6
+    ipPool:
+      type: object
+      description: Provider-neutral Pod IP pool summary.
+      properties:
+        name:
+          type: string
+        ipFamily:
+          $ref: '#/components/schemas/ipPoolIPFamily'
+        subnet:
+          type: string
+        disabled:
+          type: boolean
+        default:
+          type: boolean
+        allocatedIPCount:
+          type: integer
+          format: int64
+        totalIPCount:
+          type: integer
+          format: int64
+        availableIPCount:
+          type: integer
+          format: int64
+        capacityReliable:
+          type: boolean
+        affinitySummary:
+          type: array
+          items:
+            type: string
+    ipPoolProviderList:
+      type: object
+      description: Pod IP pools and selection policy reported by one provider.
+      properties:
+        name:
+          $ref: '#/components/schemas/ipPoolProvider'
+        selectionPolicy:
+          $ref: '#/components/schemas/ipPoolSelectionPolicy'
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/ipPool'
+      required:
+        - name
+        - selectionPolicy
+        - items
+    ipPoolList:
+      type: object
+      description: Pod IP pool discovery result for an environment.
+      properties:
+        providers:
+          type: array
+          items:
+            $ref: '#/components/schemas/ipPoolProviderList'
+      required:
+        - providers
     rawCluster:
       type: object
       description: cluster info

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

@@ -41,6 +41,7 @@ models/cluster-type.ts
 models/cluster-update.ts
 models/cluster.ts
 models/component-item.ts
+models/component-network.ts
 models/component-volume-item.ts
 models/dbdoctor-response.ts
 models/endpoint-list.ts
@@ -59,6 +60,8 @@ models/image-registry.ts
 models/index.ts
 models/init-option-item.ts
 models/io-quantity.ts
+models/ip-pool-provider.ts
+models/ip-pool-selection.ts
 models/koordinator-reservation-resource-class.ts
 models/localized-description.ts
 models/network-mode.ts

package/src/internalapi/models/component-item.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
@@ -89,5 +92,11 @@ export interface ComponentItem {
      * @memberof ComponentItem
      */
     'systemAccountSecretName'?: string;
+    /**
+     * 
+     * @type {ComponentNetwork}
+     * @memberof ComponentItem
+     */
+    'network'?: ComponentNetwork;
 }
 

package/src/internalapi/models/component-network.ts

@@ -0,0 +1,33 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { IpPoolSelection } from './ip-pool-selection';
+
+/**
+ * Per-component network configuration.
+ * @export
+ * @interface ComponentNetwork
+ */
+export interface ComponentNetwork {
+    /**
+     * 
+     * @type {IpPoolSelection}
+     * @memberof ComponentNetwork
+     */
+    'ipPool'?: IpPoolSelection;
+}
+

package/src/internalapi/models/index.ts

@@ -17,6 +17,7 @@ export * from './cluster-termination-policy';
 export * from './cluster-type';
 export * from './cluster-update';
 export * from './component-item';
+export * from './component-network';
 export * from './component-volume-item';
 export * from './dbdoctor-response';
 export * from './endpoint';
@@ -34,6 +35,8 @@ export * from './http-body';
 export * from './image-registry';
 export * from './init-option-item';
 export * from './io-quantity';
+export * from './ip-pool-provider';
+export * from './ip-pool-selection';
 export * from './koordinator-reservation-resource-class';
 export * from './localized-description';
 export * from './network-mode';

package/src/internalapi/models/ip-pool-provider.ts

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * KBE provider used for Pod IP pool discovery and explicit selection.
+ * @export
+ * @enum {string}
+ */
+
+export const IpPoolProvider = {
+    spiderpool: 'spiderpool'
+} as const;
+
+export type IpPoolProvider = typeof IpPoolProvider[keyof typeof IpPoolProvider];
+
+
+

package/src/internalapi/models/ip-pool-selection.ts

@@ -0,0 +1,47 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { IpPoolProvider } from './ip-pool-provider';
+
+/**
+ * Provider-qualified Pod IP pool selection for component pod IP allocation.
+ * @export
+ * @interface IpPoolSelection
+ */
+export interface IpPoolSelection {
+    /**
+     * 
+     * @type {IpPoolProvider}
+     * @memberof IpPoolSelection
+     */
+    'provider': IpPoolProvider;
+    /**
+     * IPv4 pool names resolved within the selected provider.
+     * @type {Array<string>}
+     * @memberof IpPoolSelection
+     */
+    'ipv4Pools'?: Array<string>;
+    /**
+     * IPv6 pool names resolved within the selected provider.
+     * @type {Array<string>}
+     * @memberof IpPoolSelection
+     */
+    'ipv6Pools'?: Array<string>;
+}
+
+
+

package/src/internalapi.yaml

@@ -1315,6 +1315,35 @@ components:
           $ref: '#/components/schemas/ioQuantity'
         ioReserves:
           $ref: '#/components/schemas/ioQuantity'
+    ipPoolProvider:
+      type: string
+      description: KBE provider used for Pod IP pool discovery and explicit selection.
+      enum:
+        - spiderpool
+    ipPoolSelection:
+      type: object
+      description: Provider-qualified Pod IP pool selection for component pod IP allocation.
+      required:
+        - provider
+      properties:
+        provider:
+          $ref: '#/components/schemas/ipPoolProvider'
+        ipv4Pools:
+          type: array
+          items:
+            type: string
+          description: IPv4 pool names resolved within the selected provider.
+        ipv6Pools:
+          type: array
+          items:
+            type: string
+          description: IPv6 pool names resolved within the selected provider.
+    componentNetwork:
+      type: object
+      description: Per-component network configuration.
+      properties:
+        ipPool:
+          $ref: '#/components/schemas/ipPoolSelection'
     componentItem:
       type: object
       description: ComponentItem is the information of a component
@@ -1359,6 +1388,8 @@ components:
         systemAccountSecretName:
           description: The name of the secret that contains the system account credentials
           type: string
+        network:
+          $ref: '#/components/schemas/componentNetwork'
     components:
       type: array
       description: Components is the list of components

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

@@ -272,6 +272,7 @@ models/cluster-validation-policy.ts
 models/cluster.ts
 models/component-item-create.ts
 models/component-item.ts
+models/component-network.ts
 models/component-ops-option-backup-method.ts
 models/component-ops-option-dependent-custom-ops-params-inner.ts
 models/component-ops-option-dependent-custom-ops.ts
@@ -535,6 +536,14 @@ models/instance.ts
 models/integer-option.ts
 models/international-desc.ts
 models/io-quantity.ts
+models/ip-pool-ipfamily.ts
+models/ip-pool-list.ts
+models/ip-pool-provider-list.ts
+models/ip-pool-provider.ts
+models/ip-pool-selection-policy.ts
+models/ip-pool-selection-requirement.ts
+models/ip-pool-selection.ts
+models/ip-pool.ts
 models/ip-whitelist-list.ts
 models/ip-whitelist.ts
 models/key-list.ts

package/src/openapi/apis/environment-api.ts

@@ -30,6 +30,8 @@ import type { EnvironmentList } from '../models';
 // @ts-ignore
 import type { EnvironmentModuleInfo } from '../models';
 // @ts-ignore
+import type { IpPoolList } from '../models';
+// @ts-ignore
 import type { KoordinatorReservationSummary } from '../models';
 // @ts-ignore
 import type { NodeGroup } from '../models';
@@ -212,6 +214,51 @@ export const EnvironmentApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary Discover Pod IP pools and explicit selection policy in an environment
+         * @param {string} orgName name of the Org
+         * @param {string} environmentName name of the Environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listEnvironmentIPPools: async (orgName: string, environmentName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('listEnvironmentIPPools', 'orgName', orgName)
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('listEnvironmentIPPools', 'environmentName', environmentName)
+            const localVarPath = `/api/v1/organizations/{orgName}/environments/{environmentName}/network/ipPools`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)));
+            // 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)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -378,6 +425,20 @@ export const EnvironmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['EnvironmentApi.listEnvironment']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary Discover Pod IP pools and explicit selection policy in an environment
+         * @param {string} orgName name of the Org
+         * @param {string} environmentName name of the Environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listEnvironmentIPPools(orgName: string, environmentName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IpPoolList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listEnvironmentIPPools(orgName, environmentName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['EnvironmentApi.listEnvironmentIPPools']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Koordinator Reservation summary for the cluster creation page.
          * @summary List Koordinator Reservations
@@ -456,6 +517,16 @@ export const EnvironmentApiFactory = function (configuration?: Configuration, ba
         listEnvironment(requestParameters: EnvironmentApiListEnvironmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<EnvironmentList> {
             return localVarFp.listEnvironment(requestParameters.orgName, requestParameters.engine, requestParameters.version, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary Discover Pod IP pools and explicit selection policy in an environment
+         * @param {EnvironmentApiListEnvironmentIPPoolsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listEnvironmentIPPools(requestParameters: EnvironmentApiListEnvironmentIPPoolsRequest, options?: RawAxiosRequestConfig): AxiosPromise<IpPoolList> {
+            return localVarFp.listEnvironmentIPPools(requestParameters.orgName, requestParameters.environmentName, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Koordinator Reservation summary for the cluster creation page.
          * @summary List Koordinator Reservations
@@ -525,6 +596,16 @@ export interface EnvironmentApiInterface {
      */
     listEnvironment(requestParameters: EnvironmentApiListEnvironmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<EnvironmentList>;
 
+    /**
+     * 
+     * @summary Discover Pod IP pools and explicit selection policy in an environment
+     * @param {EnvironmentApiListEnvironmentIPPoolsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnvironmentApiInterface
+     */
+    listEnvironmentIPPools(requestParameters: EnvironmentApiListEnvironmentIPPoolsRequest, options?: RawAxiosRequestConfig): AxiosPromise<IpPoolList>;
+
     /**
      * Get Koordinator Reservation summary for the cluster creation page.
      * @summary List Koordinator Reservations
@@ -631,6 +712,27 @@ export interface EnvironmentApiListEnvironmentRequest {
     readonly version?: string
 }
 
+/**
+ * Request parameters for listEnvironmentIPPools operation in EnvironmentApi.
+ * @export
+ * @interface EnvironmentApiListEnvironmentIPPoolsRequest
+ */
+export interface EnvironmentApiListEnvironmentIPPoolsRequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof EnvironmentApiListEnvironmentIPPools
+     */
+    readonly orgName: string
+
+    /**
+     * name of the Environment
+     * @type {string}
+     * @memberof EnvironmentApiListEnvironmentIPPools
+     */
+    readonly environmentName: string
+}
+
 /**
  * Request parameters for listKoordinatorReservations operation in EnvironmentApi.
  * @export
@@ -728,6 +830,18 @@ export class EnvironmentApi extends BaseAPI implements EnvironmentApiInterface {
         return EnvironmentApiFp(this.configuration).listEnvironment(requestParameters.orgName, requestParameters.engine, requestParameters.version, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @summary Discover Pod IP pools and explicit selection policy in an environment
+     * @param {EnvironmentApiListEnvironmentIPPoolsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnvironmentApi
+     */
+    public listEnvironmentIPPools(requestParameters: EnvironmentApiListEnvironmentIPPoolsRequest, options?: RawAxiosRequestConfig) {
+        return EnvironmentApiFp(this.configuration).listEnvironmentIPPools(requestParameters.orgName, requestParameters.environmentName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Koordinator Reservation summary for the cluster creation page.
      * @summary List Koordinator Reservations

package/src/openapi/models/component-item-create.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
@@ -83,5 +86,11 @@ export interface ComponentItemCreate {
      * @memberof ComponentItemCreate
      */
     'systemAccountSecretName'?: string;
+    /**
+     * 
+     * @type {ComponentNetwork}
+     * @memberof ComponentItemCreate
+     */
+    'network'?: ComponentNetwork;
 }
 

package/src/openapi/models/component-item.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
@@ -89,5 +92,11 @@ export interface ComponentItem {
      * @memberof ComponentItem
      */
     'systemAccountSecretName'?: string;
+    /**
+     * 
+     * @type {ComponentNetwork}
+     * @memberof ComponentItem
+     */
+    'network'?: ComponentNetwork;
 }