kb-cloud-client-typescript 2.4.0-alpha.3 → 2.4.0-alpha.30

package/src/openapi/models/mode-object-storage-additional-helm-value-path.ts

@@ -38,6 +38,24 @@ export interface ModeObjectStorageAdditionalHelmValuePath {
      * @memberof ModeObjectStorageAdditionalHelmValuePath
      */
     'usePathStyle'?: string;
+    /**
+     * whether the object storage endpoint uses TLS. If not set, it means the engine does not need this option. 
+     * @type {string}
+     * @memberof ModeObjectStorageAdditionalHelmValuePath
+     */
+    'tlsEnabled'?: string;
+    /**
+     * Secret name that stores the CA certificate for TLS object storage. If not set, it means the engine does not need this option. 
+     * @type {string}
+     * @memberof ModeObjectStorageAdditionalHelmValuePath
+     */
+    'tlsCACertSecret'?: string;
+    /**
+     * Secret key that stores the CA certificate for TLS object storage. If not set, it means the engine does not need this option. 
+     * @type {string}
+     * @memberof ModeObjectStorageAdditionalHelmValuePath
+     */
+    'tlsCACertSecretKey'?: string;
     /**
      * Region to use. If not set, it means the engine does not need this option. 
      * @type {string}

package/src/openapi/models/mode-service-ref-helm-value-path.ts

@@ -74,5 +74,11 @@ export interface ModeServiceRefHelmValuePath {
      * @memberof ModeServiceRefHelmValuePath
      */
     'mode'?: string;
+    /**
+     * the helm value path prefix for the extraForManualInput fields of this serviceRef. ClusterCreate API will map each key of serviceRefs[].extraForManualInput to `<extraForManualInput>.<key>` in the cluster chart values. 
+     * @type {string}
+     * @memberof ModeServiceRefHelmValuePath
+     */
+    'extraForManualInput'?: string;
 }
 

package/src/openapi/models/mode-service-ref.ts

@@ -74,6 +74,24 @@ export interface ModeServiceRef {
      * @memberof ModeServiceRef
      */
     'disableManualInput'?: boolean;
+    /**
+     * whether to disable auto creating the ServiceDescriptor object for this serviceRef. If set to false, the serviceDescriptor content (host/port/username/password) will be set directly into the helm values under the helmValuePath.serviceDescriptor path. If omitted, the generated ServiceDescriptor name will be set instead. 
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'disableAutoCreateServiceDescriptor'?: boolean | null;
+    /**
+     * whether to disable selecting a related cluster created in the platform for this serviceRef. If set to true, the frontend should only allow manual input instead of selecting from the clusters provided by the list clusters api. 
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'disableRelatedCluster'?: boolean;
+    /**
+     * Extra form field definitions for manual input of the serviceRef. The keys are the field names and the frontend renders them as input items. The user-entered values are passed in ClusterCreate serviceRefs[].extraForManualInput and mapped to helm values via helmValuePath.extraForManualInput. 
+     * @type {{ [key: string]: any; }}
+     * @memberof ModeServiceRef
+     */
+    'extraForManualInput'?: { [key: string]: any; };
     /**
      * 
      * @type {ModeServiceRefHelmValuePath}
@@ -92,6 +110,12 @@ export interface ModeServiceRef {
      * @memberof ModeServiceRef
      */
     'serviceVersionCompatibility'?: Array<ModeServiceRefVersionCompatibility>;
+    /**
+     * whether the serviceRef can be updated. If set to false, the frontend should not allow users to update the serviceRef.
+     * @type {boolean}
+     * @memberof ModeServiceRef
+     */
+    'updatable'?: boolean;
 }
 
 

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

@@ -26,12 +26,6 @@ export interface OpsRequestName {
      * @memberof OpsRequestName
      */
     'opsRequestName'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OpsRequestName
-     */
-    'clusterTaskId'?: string;
     /**
      * 
      * @type {string}

package/src/openapi/models/rbmq-password-update-request.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.
+ */
+
+
+
+/**
+ * RabbitMQ account password update request.
+ * @export
+ * @interface RbmqPasswordUpdateRequest
+ */
+export interface RbmqPasswordUpdateRequest {
+    /**
+     * New RabbitMQ account password.
+     * @type {string}
+     * @memberof RbmqPasswordUpdateRequest
+     */
+    'password': string;
+}
+

package/src/openapi/models/redis-info-response.ts

@@ -20,6 +20,12 @@
  * @interface RedisInfoResponse
  */
 export interface RedisInfoResponse {
+    /**
+     * INFO scope, either node or cluster.
+     * @type {string}
+     * @memberof RedisInfoResponse
+     */
+    'scope'?: string;
     /**
      * 
      * @type {string}

package/src/openapi/models/redis-key-scan-progress.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+
+/**
+ * Redis key browser scan progress for the current page.
+ * @export
+ * @interface RedisKeyScanProgress
+ */
+export interface RedisKeyScanProgress {
+    /**
+     * Scan scope, either node or cluster.
+     * @type {string}
+     * @memberof RedisKeyScanProgress
+     */
+    'scope'?: string;
+    /**
+     * Total keys in the scan scope when available.
+     * @type {number}
+     * @memberof RedisKeyScanProgress
+     */
+    'total'?: number;
+    /**
+     * Number of key names returned by SCAN in this page before type filtering.
+     * @type {number}
+     * @memberof RedisKeyScanProgress
+     */
+    'scanned'?: number;
+    /**
+     * Number of key summaries loaded in this page after filtering and metadata lookup.
+     * @type {number}
+     * @memberof RedisKeyScanProgress
+     */
+    'loaded'?: number;
+    /**
+     * Whether the scan cursor is complete after this page.
+     * @type {boolean}
+     * @memberof RedisKeyScanProgress
+     */
+    'complete'?: boolean;
+}
+

package/src/openapi/models/redis-key-summary-list.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisKeyScanProgress } from './redis-key-scan-progress';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { RedisKeySummary } from './redis-key-summary';
@@ -41,5 +44,11 @@ export interface RedisKeySummaryList {
      * @memberof RedisKeySummaryList
      */
     'hasMore'?: boolean;
+    /**
+     * 
+     * @type {RedisKeyScanProgress}
+     * @memberof RedisKeySummaryList
+     */
+    'progress'?: RedisKeyScanProgress;
 }
 

package/src/openapi/models/redis-key-value-item.ts

@@ -27,11 +27,11 @@ export interface RedisKeyValueItem {
      */
     'field'?: string;
     /**
-     * Hash/list/set/json item value.
-     * @type {{ [key: string]: any; }}
+     * Hash/list/set/json item value. The value may be a scalar, array, or object depending on Redis value type.
+     * @type {any}
      * @memberof RedisKeyValueItem
      */
-    'value'?: { [key: string]: any; };
+    'value'?: any;
     /**
      * Set or sorted-set member.
      * @type {string}

package/src/openapi/models/replication-check-option.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ReplicationCheckOption
+ */
+export interface ReplicationCheckOption {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ReplicationCheckOption
+     */
+    'enabled'?: boolean;
+}
+

package/src/openapi/models/revoke-clickhouse-role-privileges-request-privileges-inner.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.
+ */
+
+
+
+/**
+ * A single privilege granted on a scope.
+ * @export
+ * @interface RevokeClickhouseRolePrivilegesRequestPrivilegesInner
+ */
+export interface RevokeClickhouseRolePrivilegesRequestPrivilegesInner {
+    /**
+     * The ON-clause operand of the grant, e.g. \"db.*\" or \"*.*\".
+     * @type {string}
+     * @memberof RevokeClickhouseRolePrivilegesRequestPrivilegesInner
+     */
+    'scope'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RevokeClickhouseRolePrivilegesRequestPrivilegesInner
+     */
+    'privilege'?: string;
+}
+

package/src/openapi/models/revoke-clickhouse-role-privileges-request.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 { RevokeClickhouseRolePrivilegesRequestPrivilegesInner } from './revoke-clickhouse-role-privileges-request-privileges-inner';
+
+/**
+ * Revoke privileges from a role request.
+ * @export
+ * @interface RevokeClickhouseRolePrivilegesRequest
+ */
+export interface RevokeClickhouseRolePrivilegesRequest {
+    /**
+     * 
+     * @type {Array<RevokeClickhouseRolePrivilegesRequestPrivilegesInner>}
+     * @memberof RevokeClickhouseRolePrivilegesRequest
+     */
+    'privileges': Array<RevokeClickhouseRolePrivilegesRequestPrivilegesInner>;
+}
+

package/src/openapi/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; };
 }
 

package/src/openapi/models/update-clickhouse-account-password-request.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.
+ */
+
+
+
+/**
+ * Update a ClickHouse account password request.
+ * @export
+ * @interface UpdateClickhouseAccountPasswordRequest
+ */
+export interface UpdateClickhouseAccountPasswordRequest {
+    /**
+     * The new account password.
+     * @type {string}
+     * @memberof UpdateClickhouseAccountPasswordRequest
+     */
+    'password': string;
+}
+

package/src/openapi/models/update-clickhouse-account-roles-request.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.
+ */
+
+
+
+/**
+ * Update the roles granted to a ClickHouse account request.
+ * @export
+ * @interface UpdateClickhouseAccountRolesRequest
+ */
+export interface UpdateClickhouseAccountRolesRequest {
+    /**
+     * The full set of roles to grant to the account. Existing roles are replaced.
+     * @type {Array<string>}
+     * @memberof UpdateClickhouseAccountRolesRequest
+     */
+    'roles': Array<string>;
+}
+