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

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

@@ -0,0 +1,33 @@
+/* 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 { IpPoolSelection } from './ip-pool-selection';
+
+/**
+ * Per-component network configuration.
+ * @export
+ * @interface ComponentNetwork
+ */
+export interface ComponentNetwork {
+    /**
+     * 
+     * @type {IpPoolSelection}
+     * @memberof ComponentNetwork
+     */
+    'ipPool'?: IpPoolSelection;
+}
+

package/src/openapi/models/environment.ts

@@ -27,6 +27,9 @@ import type { EnvironmentState } from './environment-state';
 import type { EnvironmentType } from './environment-type';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { IpPoolProvider } from './ip-pool-provider';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkConfig } from './network-config';
 
 /**
@@ -131,6 +134,12 @@ export interface Environment {
      * @memberof Environment
      */
     'kbVersion'?: string;
+    /**
+     * KBE Pod IP pool providers enabled for discovery and explicit pool selection.
+     * @type {Array<IpPoolProvider>}
+     * @memberof Environment
+     */
+    'ipPoolProviders': Array<IpPoolProvider>;
     /**
      * namespace info for environment
      * @type {Array<string>}

package/src/openapi/models/index.ts

@@ -186,6 +186,7 @@ export * from './cluster-update';
 export * from './cluster-validation-policy';
 export * from './component-item';
 export * from './component-item-create';
+export * from './component-network';
 export * from './component-ops-option';
 export * from './component-ops-option-backup-method';
 export * from './component-ops-option-dependent-custom-ops';
@@ -447,6 +448,14 @@ export * from './instance-storage-item';
 export * from './integer-option';
 export * from './international-desc';
 export * from './io-quantity';
+export * from './ip-pool';
+export * from './ip-pool-ipfamily';
+export * from './ip-pool-list';
+export * from './ip-pool-provider';
+export * from './ip-pool-provider-list';
+export * from './ip-pool-selection';
+export * from './ip-pool-selection-policy';
+export * from './ip-pool-selection-requirement';
 export * from './ip-whitelist';
 export * from './ip-whitelist-list';
 export * from './key';

package/src/openapi/models/ip-pool-ipfamily.ts

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

package/src/openapi/models/ip-pool-list.ts

@@ -0,0 +1,33 @@
+/* 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 { IpPoolProviderList } from './ip-pool-provider-list';
+
+/**
+ * Pod IP pool discovery result for an environment.
+ * @export
+ * @interface IpPoolList
+ */
+export interface IpPoolList {
+    /**
+     * 
+     * @type {Array<IpPoolProviderList>}
+     * @memberof IpPoolList
+     */
+    'providers': Array<IpPoolProviderList>;
+}
+

package/src/openapi/models/ip-pool-provider-list.ts

@@ -0,0 +1,53 @@
+/* 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 { IpPool } from './ip-pool';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { IpPoolProvider } from './ip-pool-provider';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { IpPoolSelectionPolicy } from './ip-pool-selection-policy';
+
+/**
+ * Pod IP pools and selection policy reported by one provider.
+ * @export
+ * @interface IpPoolProviderList
+ */
+export interface IpPoolProviderList {
+    /**
+     * 
+     * @type {IpPoolProvider}
+     * @memberof IpPoolProviderList
+     */
+    'name': IpPoolProvider;
+    /**
+     * 
+     * @type {IpPoolSelectionPolicy}
+     * @memberof IpPoolProviderList
+     */
+    'selectionPolicy': IpPoolSelectionPolicy;
+    /**
+     * 
+     * @type {Array<IpPool>}
+     * @memberof IpPoolProviderList
+     */
+    'items': Array<IpPool>;
+}
+
+
+

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

@@ -0,0 +1,30 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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/openapi/models/ip-pool-selection-policy.ts

@@ -0,0 +1,41 @@
+/* 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 { IpPoolSelectionRequirement } from './ip-pool-selection-requirement';
+
+/**
+ * Per-address-family requirements for explicit IP pool selection.
+ * @export
+ * @interface IpPoolSelectionPolicy
+ */
+export interface IpPoolSelectionPolicy {
+    /**
+     * 
+     * @type {IpPoolSelectionRequirement}
+     * @memberof IpPoolSelectionPolicy
+     */
+    'ipv4': IpPoolSelectionRequirement;
+    /**
+     * 
+     * @type {IpPoolSelectionRequirement}
+     * @memberof IpPoolSelectionPolicy
+     */
+    'ipv6': IpPoolSelectionRequirement;
+}
+
+
+

package/src/openapi/models/ip-pool-selection-requirement.ts

@@ -0,0 +1,32 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const IpPoolSelectionRequirement = {
+    required: 'required',
+    optional: 'optional',
+    unsupported: 'unsupported'
+} as const;
+
+export type IpPoolSelectionRequirement = typeof IpPoolSelectionRequirement[keyof typeof IpPoolSelectionRequirement];
+
+
+

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

@@ -0,0 +1,47 @@
+/* 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 { 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/openapi/models/ip-pool.ts

@@ -0,0 +1,89 @@
+/* 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 { IpPoolIPFamily } from './ip-pool-ipfamily';
+
+/**
+ * Provider-neutral Pod IP pool summary.
+ * @export
+ * @interface IpPool
+ */
+export interface IpPool {
+    /**
+     * 
+     * @type {string}
+     * @memberof IpPool
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {IpPoolIPFamily}
+     * @memberof IpPool
+     */
+    'ipFamily'?: IpPoolIPFamily;
+    /**
+     * 
+     * @type {string}
+     * @memberof IpPool
+     */
+    'subnet'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IpPool
+     */
+    'disabled'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IpPool
+     */
+    'default'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof IpPool
+     */
+    'allocatedIPCount'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IpPool
+     */
+    'totalIPCount'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof IpPool
+     */
+    'availableIPCount'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof IpPool
+     */
+    'capacityReliable'?: boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof IpPool
+     */
+    'affinitySummary'?: Array<string>;
+}
+
+
+

package/src/openapi.yaml

@@ -1075,6 +1075,42 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+  /api/v1/organizations/{orgName}/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 Org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - 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'
+        '500':
+          $ref: '#/components/responses/500'
   /api/v1/organizations/{orgName}/environments/{environmentName}/storageClasses:
     get:
       description: Provides a summary of storage class statistics, aggregated and organized by namespace.
@@ -1116,6 +1152,8 @@ paths:
         - storageClass
   /api/v1/organizations/{orgName}/environments/{environmentName}/koordinatorReservations/summary:
     get:
+      tags:
+        - environment
       description: Get Koordinator Reservation summary for the cluster creation page.
       summary: List Koordinator Reservations
       operationId: listKoordinatorReservations
@@ -1149,8 +1187,6 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
-      tags:
-        - environment
   /api/v1/organizations/{orgName}/environments/{environmentName}/loadbalancer:
     get:
       operationId: getLoadBalancer
@@ -20138,6 +20174,11 @@ components:
         - public
         - private
       default: public
+    ipPoolProvider:
+      type: string
+      description: KBE provider used for Pod IP pool discovery and explicit selection.
+      enum:
+        - spiderpool
     clusterValidationPolicy:
       type: string
       description: Cluster operation validation policy, such as create, hscale, vscale, etc.
@@ -20212,6 +20253,11 @@ components:
         kbVersion:
           type: string
           description: KubeBlocks version of the environment
+        ipPoolProviders:
+          description: KBE Pod IP pool providers enabled for discovery and explicit pool selection.
+          type: array
+          items:
+            $ref: '#/components/schemas/ipPoolProvider'
         namespaces:
           items:
             type: string
@@ -20238,6 +20284,7 @@ components:
         - state
         - updatedAt
         - defaultStorageClass
+        - ipPoolProviders
       type: object
     environmentList:
       description: EnvironmentList is a list of Environments
@@ -20257,6 +20304,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
     storageClassInfo:
       description: StorageClassInfo provides detailed information about a specific storage class.
       properties:
@@ -21437,6 +21561,30 @@ components:
           $ref: '#/components/schemas/ioQuantity'
         ioReserves:
           $ref: '#/components/schemas/ioQuantity'
+    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
@@ -21485,6 +21633,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
@@ -21788,6 +21938,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