kb-cloud-client-typescript 2.4.0-alpha.88 → 2.4.0-alpha.89

package/src/adminapi.yaml

@@ -7609,6 +7609,203 @@ paths:
           $ref: '#/components/responses/403'
         '500':
           $ref: '#/components/responses/500'
+  /admin/v1/environments/{environmentName}/logs/retention:
+    get:
+      summary: Get environment log retention
+      operationId: getEnvironmentLogRetention
+      parameters:
+        - in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+      tags:
+        - environment
+      responses:
+        '200':
+          description: Log retention settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/logRetention'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+    put:
+      summary: Set environment log retention
+      description: Replaces the current settings. Applies to the next cleanup.
+      operationId: putEnvironmentLogRetention
+      parameters:
+        - in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+      tags:
+        - environment
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/logRetention'
+      responses:
+        '200':
+          description: Log retention settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/logRetention'
+        '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'
+    delete:
+      summary: Reset environment log retention
+      description: Removes environment settings and returns the built-in defaults.
+      operationId: deleteEnvironmentLogRetention
+      parameters:
+        - in: path
+          name: environmentName
+          required: true
+          schema:
+            type: string
+      tags:
+        - environment
+      responses:
+        '200':
+          description: Default log retention settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/logRetention'
+        '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'
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/logs/retention:
+    get:
+      summary: Get cluster log retention
+      operationId: getClusterLogRetention
+      parameters:
+        - in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      tags:
+        - clusterLog
+      responses:
+        '200':
+          description: Log retention settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/logRetention'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+    put:
+      summary: Set cluster log retention
+      description: Replaces the current settings. Applies to the next cleanup.
+      operationId: putClusterLogRetention
+      parameters:
+        - in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      tags:
+        - clusterLog
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/logRetention'
+      responses:
+        '200':
+          description: Log retention settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/logRetention'
+        '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'
+    delete:
+      summary: Reset cluster log retention
+      description: Removes cluster overrides and returns the retention inherited from the environment.
+      operationId: deleteClusterLogRetention
+      parameters:
+        - in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      tags:
+        - clusterLog
+      responses:
+        '200':
+          description: Effective log retention settings
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/logRetention'
+        '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'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/logs/pod:
     get:
       description: Query pod logs of a cluster
@@ -34817,6 +35014,36 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/DmsSession'
+    logRetention:
+      type: object
+      description: Log retention in days.
+      required:
+        - pod
+        - running
+        - error
+        - slow
+        - audit
+      properties:
+        pod:
+          type: integer
+          format: int64
+          minimum: 1
+        running:
+          type: integer
+          format: int64
+          minimum: 1
+        error:
+          type: integer
+          format: int64
+          minimum: 1
+        slow:
+          type: integer
+          format: int64
+          minimum: 1
+        audit:
+          type: integer
+          format: int64
+          minimum: 1
     sortType:
       description: Represents the type of sorting.
       enum:

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

@@ -11,6 +11,8 @@ apis/engine-api.ts
 apis/environment-api.ts
 apis/imagepullsecret-api.ts
 apis/nodeplane-api.ts
+apis/opsrequest-api.ts
+apis/parameter-api.ts
 apis/platform-parameter-api.ts
 apis/recycle-bin-cluster-api.ts
 apis/shared-api.ts
@@ -66,13 +68,18 @@ models/ip-pool-selection.ts
 models/koordinator-reservation-resource-class.ts
 models/localized-description.ts
 models/network-mode.ts
+models/ops-request-name.ts
 models/outage-record.ts
 models/page-result.ts
 models/param-tpls-item.ts
+models/parameter-item.ts
+models/parameter-list.ts
+models/parameter-prop.ts
 models/parameter-template-partition.ts
 models/platform-parameter-constraints.ts
 models/platform-parameter.ts
 models/postable-alert.ts
+models/reconfigure-create.ts
 models/scheduling-policy-type.ts
 models/service-descriptor.ts
 models/service-ref.ts
@@ -80,3 +87,5 @@ models/static-cluster.ts
 models/storage-create.ts
 models/storage.ts
 models/tag.ts
+models/task-schedule-type.ts
+models/task-schedule.ts

package/src/internalapi/api.ts

@@ -23,6 +23,8 @@ export * from './apis/engine-api';
 export * from './apis/environment-api';
 export * from './apis/imagepullsecret-api';
 export * from './apis/nodeplane-api';
+export * from './apis/opsrequest-api';
+export * from './apis/parameter-api';
 export * from './apis/platform-parameter-api';
 export * from './apis/recycle-bin-cluster-api';
 export * from './apis/slaapi';

package/src/internalapi/apis/opsrequest-api.ts

@@ -0,0 +1,197 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { APIErrorResponse } from '../models';
+// @ts-ignore
+import type { OpsRequestName } from '../models';
+// @ts-ignore
+import type { ReconfigureCreate } from '../models';
+/**
+ * OpsrequestApi - axios parameter creator
+ * @export
+ */
+export const OpsrequestApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary Update cluster configuration
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the KubeBlocks cluster
+         * @param {ReconfigureCreate} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reconfigureCluster: async (orgName: string, clusterName: string, body: ReconfigureCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('reconfigureCluster', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('reconfigureCluster', 'clusterName', clusterName)
+            // verify required parameter 'body' is not null or undefined
+            assertParamExists('reconfigureCluster', 'body', body)
+            const localVarPath = `/internal/v1/organizations/{orgName}/clusters/{clusterName}/reconfigure`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * OpsrequestApi - functional programming interface
+ * @export
+ */
+export const OpsrequestApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = OpsrequestApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary Update cluster configuration
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName name of the KubeBlocks cluster
+         * @param {ReconfigureCreate} body 
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async reconfigureCluster(orgName: string, clusterName: string, body: ReconfigureCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OpsRequestName>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.reconfigureCluster(orgName, clusterName, body, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['OpsrequestApi.reconfigureCluster']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * OpsrequestApi - factory interface
+ * @export
+ */
+export const OpsrequestApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = OpsrequestApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary Update cluster configuration
+         * @param {OpsrequestApiReconfigureClusterRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        reconfigureCluster(requestParameters: OpsrequestApiReconfigureClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<OpsRequestName> {
+            return localVarFp.reconfigureCluster(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * OpsrequestApi - interface
+ * @export
+ * @interface OpsrequestApi
+ */
+export interface OpsrequestApiInterface {
+    /**
+     * 
+     * @summary Update cluster configuration
+     * @param {OpsrequestApiReconfigureClusterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OpsrequestApiInterface
+     */
+    reconfigureCluster(requestParameters: OpsrequestApiReconfigureClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<OpsRequestName>;
+
+}
+
+/**
+ * Request parameters for reconfigureCluster operation in OpsrequestApi.
+ * @export
+ * @interface OpsrequestApiReconfigureClusterRequest
+ */
+export interface OpsrequestApiReconfigureClusterRequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof OpsrequestApiReconfigureCluster
+     */
+    readonly orgName: string
+
+    /**
+     * name of the KubeBlocks cluster
+     * @type {string}
+     * @memberof OpsrequestApiReconfigureCluster
+     */
+    readonly clusterName: string
+
+    /**
+     * 
+     * @type {ReconfigureCreate}
+     * @memberof OpsrequestApiReconfigureCluster
+     */
+    readonly body: ReconfigureCreate
+}
+
+/**
+ * OpsrequestApi - object-oriented interface
+ * @export
+ * @class OpsrequestApi
+ * @extends {BaseAPI}
+ */
+export class OpsrequestApi extends BaseAPI implements OpsrequestApiInterface {
+    /**
+     * 
+     * @summary Update cluster configuration
+     * @param {OpsrequestApiReconfigureClusterRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OpsrequestApi
+     */
+    public reconfigureCluster(requestParameters: OpsrequestApiReconfigureClusterRequest, options?: RawAxiosRequestConfig) {
+        return OpsrequestApiFp(this.configuration).reconfigureCluster(requestParameters.orgName, requestParameters.clusterName, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/src/internalapi/apis/parameter-api.ts

@@ -0,0 +1,207 @@
+/* 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { APIErrorResponse } from '../models';
+// @ts-ignore
+import type { ParameterList } from '../models';
+/**
+ * ParameterApi - axios parameter creator
+ * @export
+ */
+export const ParameterApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 
+         * @summary List parameter properties of the cluster
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} [component] component type
+         * @param {boolean} [rawContent] whether to return the raw template content
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listParameterProps: async (orgName: string, clusterName: string, component?: string, rawContent?: boolean, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('listParameterProps', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('listParameterProps', 'clusterName', clusterName)
+            const localVarPath = `/internal/v1/organizations/{orgName}/clusters/{clusterName}/parameters`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BasicAuth required
+            // http basic authentication required
+            setBasicAuthToObject(localVarRequestOptions, configuration)
+
+            if (component !== undefined) {
+                localVarQueryParameter['component'] = component;
+            }
+
+            if (rawContent !== undefined) {
+                localVarQueryParameter['rawContent'] = rawContent;
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ParameterApi - functional programming interface
+ * @export
+ */
+export const ParameterApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ParameterApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 
+         * @summary List parameter properties of the cluster
+         * @param {string} orgName name of the organization
+         * @param {string} clusterName name of the cluster
+         * @param {string} [component] component type
+         * @param {boolean} [rawContent] whether to return the raw template content
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listParameterProps(orgName: string, clusterName: string, component?: string, rawContent?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ParameterList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listParameterProps(orgName, clusterName, component, rawContent, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['ParameterApi.listParameterProps']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * ParameterApi - factory interface
+ * @export
+ */
+export const ParameterApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ParameterApiFp(configuration)
+    return {
+        /**
+         * 
+         * @summary List parameter properties of the cluster
+         * @param {ParameterApiListParameterPropsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listParameterProps(requestParameters: ParameterApiListParameterPropsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParameterList> {
+            return localVarFp.listParameterProps(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, requestParameters.rawContent, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * ParameterApi - interface
+ * @export
+ * @interface ParameterApi
+ */
+export interface ParameterApiInterface {
+    /**
+     * 
+     * @summary List parameter properties of the cluster
+     * @param {ParameterApiListParameterPropsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ParameterApiInterface
+     */
+    listParameterProps(requestParameters: ParameterApiListParameterPropsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ParameterList>;
+
+}
+
+/**
+ * Request parameters for listParameterProps operation in ParameterApi.
+ * @export
+ * @interface ParameterApiListParameterPropsRequest
+ */
+export interface ParameterApiListParameterPropsRequest {
+    /**
+     * name of the organization
+     * @type {string}
+     * @memberof ParameterApiListParameterProps
+     */
+    readonly orgName: string
+
+    /**
+     * name of the cluster
+     * @type {string}
+     * @memberof ParameterApiListParameterProps
+     */
+    readonly clusterName: string
+
+    /**
+     * component type
+     * @type {string}
+     * @memberof ParameterApiListParameterProps
+     */
+    readonly component?: string
+
+    /**
+     * whether to return the raw template content
+     * @type {boolean}
+     * @memberof ParameterApiListParameterProps
+     */
+    readonly rawContent?: boolean
+}
+
+/**
+ * ParameterApi - object-oriented interface
+ * @export
+ * @class ParameterApi
+ * @extends {BaseAPI}
+ */
+export class ParameterApi extends BaseAPI implements ParameterApiInterface {
+    /**
+     * 
+     * @summary List parameter properties of the cluster
+     * @param {ParameterApiListParameterPropsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ParameterApi
+     */
+    public listParameterProps(requestParameters: ParameterApiListParameterPropsRequest, options?: RawAxiosRequestConfig) {
+        return ParameterApiFp(this.configuration).listParameterProps(requestParameters.orgName, requestParameters.clusterName, requestParameters.component, requestParameters.rawContent, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+