kb-cloud-client-typescript 2.4.0-alpha.6 → 2.4.0-alpha.61

package/src/openapi/models/aggregate-task-result-summary.ts

@@ -38,5 +38,11 @@ export interface AggregateTaskResultSummary {
      * @memberof AggregateTaskResultSummary
      */
     'normal'?: number;
+    /**
+     * Number of completed tasks with no evaluable inspection item. Tasks that contain both evaluable and unknown items retain the conclusion derived from their evaluable items.
+     * @type {number}
+     * @memberof AggregateTaskResultSummary
+     */
+    'unknown'?: number;
 }
 

package/src/openapi/models/aggregate-task-result-type.ts

@@ -23,7 +23,8 @@
 export const AggregateTaskResultType = {
     green: 'green',
     yellow: 'yellow',
-    red: 'red'
+    red: 'red',
+    unknown: 'unknown'
 } as const;
 
 export type AggregateTaskResultType = typeof AggregateTaskResultType[keyof typeof AggregateTaskResultType];

package/src/openapi/models/ck-account-type.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.
+ */
+
+
+
+/**
+ * The account role type.
+ * @export
+ * @enum {string}
+ */
+
+export const CkAccountType = {
+    SUPERUSER: 'SUPERUSER',
+    BASICUSER: 'BASICUSER',
+    ROOT: 'ROOT'
+} as const;
+
+export type CkAccountType = typeof CkAccountType[keyof typeof CkAccountType];
+
+
+

package/src/openapi/models/ck-account.ts

@@ -0,0 +1,59 @@
+/* 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 { CkAccountType } from './ck-account-type';
+
+/**
+ * A ClickHouse account.
+ * @export
+ * @interface CkAccount
+ */
+export interface CkAccount {
+    /**
+     * The account (user) name.
+     * @type {string}
+     * @memberof CkAccount
+     */
+    'name'?: string;
+    /**
+     * Host IPs the account is allowed to log in from.
+     * @type {Array<string>}
+     * @memberof CkAccount
+     */
+    'hostIp'?: Array<string>;
+    /**
+     * Host names the account is allowed to log in from.
+     * @type {Array<string>}
+     * @memberof CkAccount
+     */
+    'hostNames'?: Array<string>;
+    /**
+     * Roles granted to the account, separated by commas.
+     * @type {string}
+     * @memberof CkAccount
+     */
+    'roles'?: string;
+    /**
+     * 
+     * @type {CkAccountType}
+     * @memberof CkAccount
+     */
+    'type'?: CkAccountType;
+}
+
+
+

package/src/openapi/models/cluster-metrics.ts

@@ -28,9 +28,9 @@ export interface ClusterMetrics {
     'value'?: Array<any> | null;
     /**
      * 
-     * @type {Array<Array<any> | null>}
+     * @type {Array<Array<{ [key: string]: any; }> | null>}
      * @memberof ClusterMetrics
      */
-    'values'?: Array<Array<any> | null>;
+    'values'?: Array<Array<{ [key: string]: any; }> | null>;
 }
 

package/src/openapi/models/cluster-mode-transition.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { OpsHScale } from './ops-hscale';
@@ -44,5 +47,13 @@ export interface ClusterModeTransition {
      * @memberof ClusterModeTransition
      */
     'hScale'?: OpsHScale;
+    /**
+     * 
+     * @type {NetworkMode}
+     * @memberof ClusterModeTransition
+     */
+    'networkMode'?: NetworkMode;
 }
 
+
+

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

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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/openapi/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/openapi/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/openapi/models/component-item-create.ts

@@ -39,11 +39,11 @@ export interface ComponentItemCreate {
      */
     'compNum'?: number;
     /**
-     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3.
+     * Omit to use the cluster chart default. Set zero to disable the component when its resource constraints allow zero replicas.
      * @type {number}
      * @memberof ComponentItemCreate
      */
-    'replicas'?: number;
+    'replicas'?: number | null;
     /**
      * Whether to skip resource constraint validation when creating cluster
      * @type {boolean}

package/src/openapi/models/compute-group-account-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 { ComputeGroupAccount } from './compute-group-account';
+
+/**
+ * 
+ * @export
+ * @interface ComputeGroupAccountList
+ */
+export interface ComputeGroupAccountList {
+    /**
+     * 
+     * @type {Array<ComputeGroupAccount>}
+     * @memberof ComputeGroupAccountList
+     */
+    'items': Array<ComputeGroupAccount>;
+}
+

package/src/openapi/models/compute-group-account.ts

@@ -0,0 +1,66 @@
+/* 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.
+ */
+
+
+
+/**
+ * Grants reported by the engine can include role inheritance. Revoking a direct grant does not remove inherited permissions.
+ * @export
+ * @interface ComputeGroupAccount
+ */
+export interface ComputeGroupAccount {
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupAccount
+     */
+    'identity'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupAccount
+     */
+    'accountName'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroupAccount
+     */
+    'manageable'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupAccount
+     */
+    'globalGrants'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupAccount
+     */
+    'computeGrants'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupAccount
+     */
+    'roles'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroupAccount
+     */
+    'isDefault'?: boolean;
+}
+

package/src/openapi/models/compute-group-backend.ts

@@ -0,0 +1,78 @@
+/* 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
+ * @interface ComputeGroupBackend
+ */
+export interface ComputeGroupBackend {
+    /**
+     * Opaque backend ID; do not convert to a JavaScript number.
+     * @type {string}
+     * @memberof ComputeGroupBackend
+     */
+    'id'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupBackend
+     */
+    'host'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroupBackend
+     */
+    'heartbeatPort'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroupBackend
+     */
+    'alive'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroupBackend
+     */
+    'decommissioned'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroupBackend
+     */
+    'tabletCount'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupBackend
+     */
+    'lastHeartbeat'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupBackend
+     */
+    'version'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupBackend
+     */
+    'errorMessage'?: string;
+}
+

package/src/openapi/models/compute-group-create.ts

@@ -0,0 +1,42 @@
+/* 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
+ * @interface ComputeGroupCreate
+ */
+export interface ComputeGroupCreate {
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupCreate
+     */
+    'name': string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroupCreate
+     */
+    'replicas': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupCreate
+     */
+    'classCode': string;
+}
+

package/src/openapi/models/compute-group-list.ts

@@ -0,0 +1,45 @@
+/* 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 { ComputeGroup } from './compute-group';
+
+/**
+ * 
+ * @export
+ * @interface ComputeGroupList
+ */
+export interface ComputeGroupList {
+    /**
+     * 
+     * @type {Array<ComputeGroup>}
+     * @memberof ComputeGroupList
+     */
+    'items': Array<ComputeGroup>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroupList
+     */
+    'managementSupported'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupList
+     */
+    'unsupportedReason'?: string;
+}
+

package/src/openapi/models/compute-group-scale.ts

@@ -0,0 +1,36 @@
+/* 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
+ * @interface ComputeGroupScale
+ */
+export interface ComputeGroupScale {
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroupScale
+     */
+    'replicas'?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroupScale
+     */
+    'classCode'?: string;
+}
+

package/src/openapi/models/compute-group.ts

@@ -0,0 +1,117 @@
+/* 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 { ComputeGroupBackend } from './compute-group-backend';
+
+/**
+ * 
+ * @export
+ * @interface ComputeGroup
+ */
+export interface ComputeGroup {
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroup
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroup
+     */
+    'componentName'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroup
+     */
+    'managed'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroup
+     */
+    'isDefault'?: boolean;
+    /**
+     * Kubernetes component phase, independent of engine membership.
+     * @type {string}
+     * @memberof ComputeGroup
+     */
+    'phase'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ComputeGroup
+     */
+    'stopped'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroup
+     */
+    'replicas'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof ComputeGroup
+     */
+    'classCode'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroup
+     */
+    'cpu'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroup
+     */
+    'memory'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroup
+     */
+    'backendCount'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ComputeGroup
+     */
+    'aliveBackendCount'?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ComputeGroup
+     */
+    'defaultUsers'?: Array<string>;
+    /**
+     * 
+     * @type {Array<ComputeGroupBackend>}
+     * @memberof ComputeGroup
+     */
+    'backends'?: Array<ComputeGroupBackend>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ComputeGroup
+     */
+    'allowedActions'?: Array<string>;
+}
+