kb-cloud-client-typescript 2.4.0-alpha.12 → 2.4.0-alpha.121

package/src/internalapi/models/cluster-reference.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * Cluster reference information returned by cluster detail APIs.
+ * @export
+ * @interface ClusterReference
+ */
+export interface ClusterReference {
+    /**
+     * Name of the cluster that references this cluster.
+     * @type {string}
+     * @memberof ClusterReference
+     */
+    'cluster'?: string;
+    /**
+     * Cluster definition of the referencing cluster.
+     * @type {string}
+     * @memberof ClusterReference
+     */
+    'clusterDefinition'?: string;
+}
+

package/src/internalapi/models/cluster-update.ts

@@ -53,6 +53,12 @@ export interface ClusterUpdate {
      * @memberof ClusterUpdate
      */
     'newServiceRefs'?: Array<ServiceRef>;
+    /**
+     * ServiceRefs to update. Each serviceRef name must match an existing serviceRef of the cluster, and the corresponding engine option modeServiceRef.update.enable must be true. ServiceRefs that auto create their ServiceDescriptor and Secret get their corresponding K8s objects updated; serviceRefs with manual input must be handled by each engine individually and are rejected. 
+     * @type {Array<ServiceRef>}
+     * @memberof ClusterUpdate
+     */
+    'serviceRefsUpdate'?: Array<ServiceRef>;
 }
 
 

package/src/internalapi/models/cluster.ts

@@ -27,6 +27,9 @@ import type { ClusterMaintainceWindow } from './cluster-maintaince-window';
 import type { ClusterObjectStorageConfig } from './cluster-object-storage-config';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { ClusterReference } from './cluster-reference';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { ClusterTerminationPolicy } from './cluster-termination-policy';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -295,10 +298,10 @@ export interface Cluster {
     'serviceRefs'?: Array<ServiceRef>;
     /**
      * this list of objects (currently, object is a cluster) that uses this cluster as a serviceRef
-     * @type {Array<ServiceRef>}
+     * @type {Array<ClusterReference>}
      * @memberof Cluster
      */
-    'referencedBy'?: Array<ServiceRef>;
+    'referencedBy'?: Array<ClusterReference>;
     /**
      * 
      * @type {ClusterObjectStorageConfig}

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

@@ -19,6 +19,9 @@ import type { ComponentNetwork } from './component-network';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentVolumeItem } from './component-volume-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateCreate } from './instance-template-create';
 
 /**
  * ComponentItem is the information of a component
@@ -26,6 +29,30 @@ import type { ComponentVolumeItem } from './component-volume-item';
  * @interface ComponentItem
  */
 export interface ComponentItem {
+    /**
+     * User-provided component annotations. Does not include chart defaults or system-generated values.
+     * @type {{ [key: string]: string; }}
+     * @memberof ComponentItem
+     */
+    'annotations'?: { [key: string]: string; };
+    /**
+     * Optional host group in this environment. Explicit placement does not inherit an upper-level host group.
+     * @type {string}
+     * @memberof ComponentItem
+     */
+    'nodeGroup'?: string;
+    /**
+     * Explicit component AZ selection, if configured.
+     * @type {string}
+     * @memberof ComponentItem
+     */
+    'availabilityZone'?: string;
+    /**
+     * Instance template assignments with effective replicas, placement and storage class, and user-provided env, labels and annotations.
+     * @type {Array<InstanceTemplateCreate>}
+     * @memberof ComponentItem
+     */
+    'instanceTemplates'?: Array<InstanceTemplateCreate>;
     /**
      * component name
      * @type {string}

package/src/internalapi/models/index.ts

@@ -1,4 +1,5 @@
 export * from './apierror-response';
+export * from './access-level';
 export * from './alert';
 export * from './alert-status';
 export * from './apiserver-phase-detail';
@@ -13,6 +14,7 @@ export * from './cluster-list';
 export * from './cluster-list-item';
 export * from './cluster-maintaince-window';
 export * from './cluster-object-storage-config';
+export * from './cluster-reference';
 export * from './cluster-termination-policy';
 export * from './cluster-type';
 export * from './cluster-update';
@@ -34,19 +36,28 @@ export * from './grafana-datasource-create';
 export * from './http-body';
 export * from './image-registry';
 export * from './init-option-item';
+export * from './instance-template-create';
+export * from './instance-template-create-env-inner';
 export * from './io-quantity';
 export * from './ip-pool-provider';
 export * from './ip-pool-selection';
 export * from './koordinator-reservation-resource-class';
+export * from './llm';
+export * from './llm-list';
 export * from './localized-description';
 export * from './network-mode';
+export * from './ops-request-name';
 export * from './outage-record';
 export * from './page-result';
 export * from './param-tpls-item';
+export * from './parameter-item';
+export * from './parameter-list';
+export * from './parameter-prop';
 export * from './parameter-template-partition';
 export * from './platform-parameter';
 export * from './platform-parameter-constraints';
 export * from './postable-alert';
+export * from './reconfigure-create';
 export * from './scheduling-policy-type';
 export * from './service-descriptor';
 export * from './service-ref';
@@ -54,3 +65,5 @@ export * from './static-cluster';
 export * from './storage';
 export * from './storage-create';
 export * from './tag';
+export * from './task-schedule';
+export * from './task-schedule-type';

package/src/internalapi/models/instance-template-create-env-inner.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface InstanceTemplateCreateEnvInner
+ */
+export interface InstanceTemplateCreateEnvInner {
+    /**
+     * 
+     * @type {string}
+     * @memberof InstanceTemplateCreateEnvInner
+     */
+    'name': string;
+    /**
+     * Plain string value only. valueFrom is not supported.
+     * @type {string}
+     * @memberof InstanceTemplateCreateEnvInner
+     */
+    'value': string;
+}
+

package/src/internalapi/models/instance-template-create.ts

@@ -0,0 +1,75 @@
+/* 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 { InstanceTemplateCreateEnvInner } from './instance-template-create-env-inner';
+
+/**
+ * Create assignment for one instance template. name and replicas are required. env, annotations, labels, availabilityZone, nodeGroup and storageClass are optional overlays. The request must include every chart-rendered instance template exactly once. Explicit placement requires availabilityZone and optionally accepts nodeGroup, without inheriting upper-level AZ or NodeGroup. Omitting both leaves SchedulingPolicy unset for KubeBlocks default inheritance. Hostname, user scheduling rules and additional topology keys are preserved.
+ * @export
+ * @interface InstanceTemplateCreate
+ */
+export interface InstanceTemplateCreate {
+    /**
+     * Optional host group in this environment and the explicitly selected availabilityZone. Requires availabilityZone; no upper-level host group is inherited.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'nodeGroup'?: string;
+    /**
+     * Instance template name; must match a chart-rendered instance.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'name': string;
+    /**
+     * Replica count for this instance template.
+     * @type {number}
+     * @memberof InstanceTemplateCreate
+     */
+    'replicas': number;
+    /**
+     * Single AZ for explicit template placement (topology.kubernetes.io/zone). Must be enabled in the environment and is required when nodeGroup is specified. An omitted nodeGroup does not inherit the component or cluster host group. Omitting both leaves SchedulingPolicy unset for KubeBlocks inheritance.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'availabilityZone'?: string;
+    /**
+     * StorageClass name for all persistent volumes in this template. Copied from component volumeClaimTemplates, preserving volume sizes and other settings while overriding storageClassName. Chart instance volume templates are cleared; omitted or empty leaves instance volumeClaimTemplates unset.
+     * @type {string}
+     * @memberof InstanceTemplateCreate
+     */
+    'storageClass'?: string;
+    /**
+     * Simple env vars (name and value only) merged into this template. valueFrom is not supported; overlaying a name clears any chart valueFrom.
+     * @type {Array<InstanceTemplateCreateEnvInner>}
+     * @memberof InstanceTemplateCreate
+     */
+    'env'?: Array<InstanceTemplateCreateEnvInner>;
+    /**
+     * Annotation map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted.
+     * @type {{ [key: string]: string; }}
+     * @memberof InstanceTemplateCreate
+     */
+    'annotations'?: { [key: string]: string; };
+    /**
+     * Label map (string key to string value). Merged into this template; same-name keys overwritten. Chart keys are not deleted. The apps.kubeblocks.io/instance-template label is managed by the system and must equal the template name if supplied.
+     * @type {{ [key: string]: string; }}
+     * @memberof InstanceTemplateCreate
+     */
+    'labels'?: { [key: string]: string; };
+}
+

package/src/internalapi/models/llm-list.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 { Llm } from './llm';
+
+/**
+ * 
+ * @export
+ * @interface LlmList
+ */
+export interface LlmList {
+    /**
+     * Items is the list of llm objects
+     * @type {Array<Llm>}
+     * @memberof LlmList
+     */
+    'items': Array<Llm>;
+}
+

package/src/internalapi/models/llm.ts

@@ -0,0 +1,71 @@
+/* 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 { AccessLevel } from './access-level';
+
+/**
+ * llm
+ * @export
+ * @interface Llm
+ */
+export interface Llm {
+    /**
+     * ID of the llm
+     * @type {string}
+     * @memberof Llm
+     */
+    'id'?: string;
+    /**
+     * Name of the llm
+     * @type {string}
+     * @memberof Llm
+     */
+    'name': string;
+    /**
+     * Whether this LLM is enabled
+     * @type {boolean}
+     * @memberof Llm
+     */
+    'enabled': boolean;
+    /**
+     * Config.  For OpenAI-compatible providers, model entries under `available_models` may include `max_tokens` as the maximum output token count and `context_length` as the total context window. `context_window` is a deprecated compatibility alias and should not be used by new clients. 
+     * @type {{ [key: string]: object; }}
+     * @memberof Llm
+     */
+    'config': { [key: string]: object; };
+    /**
+     * 
+     * @type {AccessLevel}
+     * @memberof Llm
+     */
+    'level'?: AccessLevel;
+    /**
+     * CreatedAt is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.  Populated by the system. Read-only. Null for lists
+     * @type {string}
+     * @memberof Llm
+     */
+    'createdAt'?: string;
+    /**
+     * UpdatedAt is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.  Populated by the system. Read-only. Null for lists
+     * @type {string}
+     * @memberof Llm
+     */
+    'updatedAt'?: string;
+}
+
+
+

package/src/internalapi/models/ops-request-name.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * OpsRequestName is the name of a KubeBlocks OpsRequest response
+ * @export
+ * @interface OpsRequestName
+ */
+export interface OpsRequestName {
+    /**
+     * 
+     * @type {string}
+     * @memberof OpsRequestName
+     */
+    'opsRequestName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof OpsRequestName
+     */
+    'taskId': string;
+}
+

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

@@ -0,0 +1,57 @@
+/* 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 { ParameterProp } from './parameter-prop';
+
+/**
+ * With the list of parameter properties and the configuration file name
+ * @export
+ * @interface ParameterItem
+ */
+export interface ParameterItem {
+    /**
+     * The list of parameters properties
+     * @type {Array<ParameterProp>}
+     * @memberof ParameterItem
+     */
+    'props'?: Array<ParameterProp>;
+    /**
+     * The additional properties of the parameter
+     * @type {Array<ParameterProp>}
+     * @memberof ParameterItem
+     */
+    'additionalProps'?: Array<ParameterProp>;
+    /**
+     * The name of the configuration file
+     * @type {string}
+     * @memberof ParameterItem
+     */
+    'fileName'?: string;
+    /**
+     * The name of the config spec
+     * @type {string}
+     * @memberof ParameterItem
+     */
+    'specName'?: string;
+    /**
+     * The raw content of the configuration file, return only when raw is true in the query.
+     * @type {string}
+     * @memberof ParameterItem
+     */
+    'rawContent'?: string;
+}
+

package/src/internalapi/models/parameter-list.ts

@@ -0,0 +1,45 @@
+/* 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 { ParameterItem } from './parameter-item';
+
+/**
+ * A list of cluster parameter
+ * @export
+ * @interface ParameterList
+ */
+export interface ParameterList {
+    /**
+     * Name of database engine
+     * @type {string}
+     * @memberof ParameterList
+     */
+    'engine': string;
+    /**
+     * Name of component
+     * @type {string}
+     * @memberof ParameterList
+     */
+    'component': string;
+    /**
+     * 
+     * @type {Array<ParameterItem>}
+     * @memberof ParameterList
+     */
+    'items'?: Array<ParameterItem>;
+}
+

package/src/internalapi/models/parameter-prop.ts

@@ -0,0 +1,90 @@
+/* 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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ParameterProp
+ */
+export interface ParameterProp {
+    /**
+     * The name of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'name': string;
+    /**
+     * The description of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'description'?: string;
+    /**
+     * The type of the parameter value
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'type': string;
+    /**
+     * The value of the parameter, if parameter is not set in tpl, it\'s value equal to cue default value.
+     * @type {object}
+     * @memberof ParameterProp
+     */
+    'value'?: object;
+    /**
+     * The value of the parameter, if parameter is not set in tpl, it\'s value equal to cue default value.
+     * @type {object}
+     * @memberof ParameterProp
+     */
+    'default'?: object;
+    /**
+     * Whether the parameter requires a restart to take effect
+     * @type {boolean}
+     * @memberof ParameterProp
+     */
+    'needRestart': boolean;
+    /**
+     * Whether the parameter is an immutable parameter, immutable parameters cannot be modified
+     * @type {boolean}
+     * @memberof ParameterProp
+     */
+    'immutable': boolean;
+    /**
+     * The maximum value of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'maximum'?: string;
+    /**
+     * The minimum value of the parameter
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'minimum'?: string;
+    /**
+     * The value options of the parameter
+     * @type {Array<any>}
+     * @memberof ParameterProp
+     */
+    'enum'?: Array<any>;
+    /**
+     * The unit of the parameter value (e.g., seconds, bytes, ms, percentage)
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'unit'?: string;
+}
+

package/src/internalapi/models/reconfigure-create.ts

@@ -0,0 +1,57 @@
+/* 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 { TaskSchedule } from './task-schedule';
+
+/**
+ * ReconfigureCreate is the payload to reconfigure a KubeBlocks cluster
+ * @export
+ * @interface ReconfigureCreate
+ */
+export interface ReconfigureCreate {
+    /**
+     * component type
+     * @type {string}
+     * @memberof ReconfigureCreate
+     */
+    'component': string;
+    /**
+     * config file name
+     * @type {string}
+     * @memberof ReconfigureCreate
+     */
+    'configFileName'?: string;
+    /**
+     * Specify parameters list to be updated
+     * @type {{ [key: string]: string; }}
+     * @memberof ReconfigureCreate
+     */
+    'parameters'?: { [key: string]: string; };
+    /**
+     * The raw content of the configuration file
+     * @type {string}
+     * @memberof ReconfigureCreate
+     */
+    'rawContent'?: string;
+    /**
+     * 
+     * @type {TaskSchedule}
+     * @memberof ReconfigureCreate
+     */
+    'schedule'?: TaskSchedule;
+}
+

package/src/internalapi/models/service-ref.ts

@@ -47,5 +47,11 @@ export interface ServiceRef {
      * @memberof ServiceRef
      */
     'serviceDescriptor'?: ServiceDescriptor;
+    /**
+     * extra fields for manual input of the serviceRef. The keys must be defined in the engineoption modeServiceRef.extraForManualInput. They are mapped to helm values via the corresponding helmValuePath.extraForManualInput. 
+     * @type {{ [key: string]: string; }}
+     * @memberof ServiceRef
+     */
+    'extraForManualInput'?: { [key: string]: string; };
 }