kb-cloud-client-typescript 2.3.0-alpha.85 → 2.3.0-alpha.87

package/src/sdk/adminapi/models/engine-network-mode-options-inner.ts

@@ -0,0 +1,45 @@
+/* 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 { NetworkMode } from './network-mode';
+
+/**
+ * 
+ * @export
+ * @interface EngineNetworkModeOptionsInner
+ */
+export interface EngineNetworkModeOptionsInner {
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EngineNetworkModeOptionsInner
+     */
+    'engineName': string;
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EngineNetworkModeOptionsInner
+     */
+    'mode': string;
+    /**
+     * available network modes for this engine+mode
+     * @type {Array<NetworkMode>}
+     * @memberof EngineNetworkModeOptionsInner
+     */
+    'networkModes': Array<NetworkMode>;
+}
+

package/src/sdk/adminapi/models/engine-network-mode-supported.ts

@@ -0,0 +1,39 @@
+/* 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 { NetworkMode } from './network-mode';
+
+/**
+ * 
+ * @export
+ * @interface EngineNetworkModeSupported
+ */
+export interface EngineNetworkModeSupported {
+    /**
+     * supported network modes
+     * @type {Array<NetworkMode>}
+     * @memberof EngineNetworkModeSupported
+     */
+    'supported'?: Array<NetworkMode>;
+    /**
+     * not supported versions, key is networkMode, value is array of versions
+     * @type {{ [key: string]: Array<string>; }}
+     * @memberof EngineNetworkModeSupported
+     */
+    'notSupportedVersions'?: { [key: string]: Array<string>; };
+}
+

package/src/sdk/adminapi/models/environment-engine-option-create.ts

@@ -0,0 +1,42 @@
+/* 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 EnvironmentEngineOptionCreate
+ */
+export interface EnvironmentEngineOptionCreate {
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EnvironmentEngineOptionCreate
+     */
+    'engineName': string;
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EnvironmentEngineOptionCreate
+     */
+    'mode': string;
+    /**
+     * network modes
+     * @type {Array<string>}
+     * @memberof EnvironmentEngineOptionCreate
+     */
+    'networkModes': Array<string>;
+}
+

package/src/sdk/adminapi/models/environment-engine-option-update.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface EnvironmentEngineOptionUpdate
+ */
+export interface EnvironmentEngineOptionUpdate {
+    /**
+     * environment engine option to update
+     * @type {Array<string>}
+     * @memberof EnvironmentEngineOptionUpdate
+     */
+    'networkModes': Array<string>;
+}
+

package/src/sdk/adminapi/models/environment-engine-option.ts

@@ -0,0 +1,72 @@
+/* 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 EnvironmentEngineOption
+ */
+export interface EnvironmentEngineOption {
+    /**
+     * record id
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'id': string;
+    /**
+     * engine name
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'engineName': string;
+    /**
+     * engine mode
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'mode': string;
+    /**
+     * network modes configured for this engine+mode+env combination
+     * @type {Array<string>}
+     * @memberof EnvironmentEngineOption
+     */
+    'networkModes': Array<string>;
+    /**
+     * environment id
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'envId': string;
+    /**
+     * environment name
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'envName': string;
+    /**
+     * create time
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'createTime'?: string;
+    /**
+     * update time
+     * @type {string}
+     * @memberof EnvironmentEngineOption
+     */
+    'updateTime'?: string;
+}
+

package/src/sdk/adminapi/models/index.ts

@@ -315,6 +315,8 @@ export * from './engine-license-entity-list';
 export * from './engine-license-list';
 export * from './engine-mapping';
 export * from './engine-mode-transition';
+export * from './engine-network-mode-options-inner';
+export * from './engine-network-mode-supported';
 export * from './engine-option';
 export * from './engine-option-history';
 export * from './engine-option-history-list';
@@ -356,6 +358,9 @@ export * from './environment-credential-usage';
 export * from './environment-credential-usage-hint';
 export * from './environment-delete';
 export * from './environment-delete-policy';
+export * from './environment-engine-option';
+export * from './environment-engine-option-create';
+export * from './environment-engine-option-update';
 export * from './environment-list';
 export * from './environment-module';
 export * from './environment-module-action';

package/src/sdk/adminapi.yaml

@@ -20307,6 +20307,206 @@ paths:
           $ref: '#/components/responses/403'
         '404':
           $ref: '#/components/responses/404'
+  /admin/v1/environments/{environmentName}/engineOptions:
+    get:
+      tags:
+        - engine
+      operationId: listEnvironmentEngineOptions
+      summary: List environment engine options
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+        - name: engineName
+          in: query
+          description: filter by engine name
+          required: false
+          schema:
+            type: string
+        - name: mode
+          in: query
+          description: filter by engine mode
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/environmentEngineOptionList'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+    post:
+      tags:
+        - engine
+      operationId: createEnvironmentEngineOption
+      summary: Create environment engine option
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/environmentEngineOptionCreate'
+        required: true
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/environmentEngineOption'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+      x-codegen-request-body-name: body
+  /admin/v1/environments/{environmentName}/engineOption/{id}:
+    delete:
+      tags:
+        - engine
+      operationId: deleteEnvironmentEngineOption
+      summary: Delete environment engine option
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+        - name: id
+          in: path
+          description: engine environment engine option id
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: No Content
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+    put:
+      tags:
+        - engine
+      operationId: updateEnvironmentEngineOption
+      summary: Update environment engine option
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+        - name: id
+          in: path
+          description: engine environment engine option record id
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/environmentEngineOptionUpdate'
+        required: true
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/environmentEngineOption'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      x-codegen-request-body-name: body
+  /admin/v1/environments/{environmentName}/engineNetworkModes/supported:
+    get:
+      tags:
+        - engine
+      operationId: getEngineNetworkModeSupported
+      summary: Get supported network modes for engine+mode from engineOption config
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+        - name: engineName
+          in: query
+          description: engine name
+          required: true
+          schema:
+            type: string
+        - name: mode
+          in: query
+          description: engine mode
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/engineNetworkModeSupported'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+  /admin/v1/environments/{environmentName}/engineNetworkModes/options:
+    get:
+      tags:
+        - engine
+      operationId: getEngineNetworkModeOptions
+      summary: Get available network modes for all engines from engineOption config
+      parameters:
+        - name: environmentName
+          in: path
+          description: environment name
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: A successful response.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/engineNetworkModeOptions'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
 components:
   securitySchemes:
     BearerToken:
@@ -35865,6 +36065,112 @@ components:
         - engineMode
         - targetSelector
         - schedulingPolicyType
+    environmentEngineOption:
+      type: object
+      required:
+        - id
+        - engineName
+        - mode
+        - networkModes
+        - envId
+        - envName
+      properties:
+        id:
+          type: string
+          description: record id
+        engineName:
+          type: string
+          description: engine name
+        mode:
+          type: string
+          description: engine mode
+        networkModes:
+          type: array
+          items:
+            type: string
+          description: network modes configured for this engine+mode+env combination
+        envId:
+          type: string
+          format: uuid
+          description: environment id
+        envName:
+          type: string
+          description: environment name
+        createTime:
+          type: string
+          format: date-time
+          description: create time
+        updateTime:
+          type: string
+          format: date-time
+          description: update time
+    environmentEngineOptionList:
+      type: array
+      items:
+        $ref: '#/components/schemas/environmentEngineOption'
+    environmentEngineOptionCreate:
+      type: object
+      required:
+        - engineName
+        - mode
+        - networkModes
+      properties:
+        engineName:
+          type: string
+          description: engine name
+        mode:
+          type: string
+          description: engine mode
+        networkModes:
+          type: array
+          items:
+            type: string
+          description: network modes
+    environmentEngineOptionUpdate:
+      type: object
+      required:
+        - networkModes
+      properties:
+        networkModes:
+          type: array
+          items:
+            type: string
+          description: environment engine option to update
+    engineNetworkModeSupported:
+      type: object
+      properties:
+        supported:
+          type: array
+          items:
+            $ref: '#/components/schemas/networkMode'
+          description: supported network modes
+        notSupportedVersions:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              type: string
+          description: not supported versions, key is networkMode, value is array of versions
+    engineNetworkModeOptions:
+      type: array
+      items:
+        type: object
+        required:
+          - engineName
+          - mode
+          - networkModes
+        properties:
+          engineName:
+            type: string
+            description: engine name
+          mode:
+            type: string
+            description: engine mode
+          networkModes:
+            type: array
+            items:
+              $ref: '#/components/schemas/networkMode'
+            description: available network modes for this engine+mode
   responses:
     '204':
       description: No Content

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

@@ -413,6 +413,7 @@ models/engine-license-list.ts
 models/engine-license.ts
 models/engine-mapping.ts
 models/engine-mode-transition.ts
+models/engine-network-mode-supported.ts
 models/engine-option-license.ts
 models/engine-option-list.ts
 models/engine-option-status.ts