kb-cloud-client-typescript 2.4.0-alpha.54 → 2.4.0-alpha.56

package/src/adminapi/apis/inspection-api.ts

@@ -38,6 +38,8 @@ import type { InspectionScript } from '../models';
 // @ts-ignore
 import type { InspectionTask } from '../models';
 // @ts-ignore
+import type { InspectionTaskCreate } from '../models';
+// @ts-ignore
 import type { InspectionTaskFormat } from '../models';
 /**
  * InspectionApi - axios parameter creator
@@ -179,18 +181,18 @@ export const InspectionApiAxiosParamCreator = function (configuration?: Configur
             };
         },
         /**
-         * 
-         * @summary create inspection task by org
+         * Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
+         * @summary Trigger inspection for selected clusters in an organization
          * @param {string} orgName name of the Org
-         * @param {InspectionTask} inspectionTask 
+         * @param {InspectionTaskCreate} inspectionTaskCreate 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        createInspectionTaskByOrg: async (orgName: string, inspectionTask: InspectionTask, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        createInspectionTaskByOrg: async (orgName: string, inspectionTaskCreate: InspectionTaskCreate, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('createInspectionTaskByOrg', 'orgName', orgName)
-            // verify required parameter 'inspectionTask' is not null or undefined
-            assertParamExists('createInspectionTaskByOrg', 'inspectionTask', inspectionTask)
+            // verify required parameter 'inspectionTaskCreate' is not null or undefined
+            assertParamExists('createInspectionTaskByOrg', 'inspectionTaskCreate', inspectionTaskCreate)
             const localVarPath = `/admin/v1/organizations/{orgName}/inspectionTasksByOrg`
                 .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)));
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -218,7 +220,7 @@ export const InspectionApiAxiosParamCreator = function (configuration?: Configur
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
-            localVarRequestOptions.data = serializeDataIfNeeded(inspectionTask, localVarRequestOptions, configuration)
+            localVarRequestOptions.data = serializeDataIfNeeded(inspectionTaskCreate, localVarRequestOptions, configuration)
 
             return {
                 url: toPathString(localVarUrlObj),
@@ -893,15 +895,15 @@ export const InspectionApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * 
-         * @summary create inspection task by org
+         * Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
+         * @summary Trigger inspection for selected clusters in an organization
          * @param {string} orgName name of the Org
-         * @param {InspectionTask} inspectionTask 
+         * @param {InspectionTaskCreate} inspectionTaskCreate 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async createInspectionTaskByOrg(orgName: string, inspectionTask: InspectionTask, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.createInspectionTaskByOrg(orgName, inspectionTask, options);
+        async createInspectionTaskByOrg(orgName: string, inspectionTaskCreate: InspectionTaskCreate, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createInspectionTaskByOrg(orgName, inspectionTaskCreate, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['InspectionApi.createInspectionTaskByOrg']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1124,14 +1126,14 @@ export const InspectionApiFactory = function (configuration?: Configuration, bas
             return localVarFp.createInspectionTaskByEnv(requestParameters.environmentName, requestParameters.inspectionTask, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
-         * @summary create inspection task by org
+         * Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
+         * @summary Trigger inspection for selected clusters in an organization
          * @param {InspectionApiCreateInspectionTaskByOrgRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
         createInspectionTaskByOrg(requestParameters: InspectionApiCreateInspectionTaskByOrgRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
-            return localVarFp.createInspectionTaskByOrg(requestParameters.orgName, requestParameters.inspectionTask, options).then((request) => request(axios, basePath));
+            return localVarFp.createInspectionTaskByOrg(requestParameters.orgName, requestParameters.inspectionTaskCreate, options).then((request) => request(axios, basePath));
         },
         /**
          * 
@@ -1293,8 +1295,8 @@ export interface InspectionApiInterface {
     createInspectionTaskByEnv(requestParameters: InspectionApiCreateInspectionTaskByEnvRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
 
     /**
-     * 
-     * @summary create inspection task by org
+     * Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
+     * @summary Trigger inspection for selected clusters in an organization
      * @param {InspectionApiCreateInspectionTaskByOrgRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1488,10 +1490,10 @@ export interface InspectionApiCreateInspectionTaskByOrgRequest {
 
     /**
      * 
-     * @type {InspectionTask}
+     * @type {InspectionTaskCreate}
      * @memberof InspectionApiCreateInspectionTaskByOrg
      */
-    readonly inspectionTask: InspectionTask
+    readonly inspectionTaskCreate: InspectionTaskCreate
 }
 
 /**
@@ -1853,15 +1855,15 @@ export class InspectionApi extends BaseAPI implements InspectionApiInterface {
     }
 
     /**
-     * 
-     * @summary create inspection task by org
+     * Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
+     * @summary Trigger inspection for selected clusters in an organization
      * @param {InspectionApiCreateInspectionTaskByOrgRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof InspectionApi
      */
     public createInspectionTaskByOrg(requestParameters: InspectionApiCreateInspectionTaskByOrgRequest, options?: RawAxiosRequestConfig) {
-        return InspectionApiFp(this.configuration).createInspectionTaskByOrg(requestParameters.orgName, requestParameters.inspectionTask, options).then((request) => request(this.axios, this.basePath));
+        return InspectionApiFp(this.configuration).createInspectionTaskByOrg(requestParameters.orgName, requestParameters.inspectionTaskCreate, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/adminapi/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/adminapi/models/compute-group-account-list.ts

@@ -0,0 +1,33 @@
+/* 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 { ComputeGroupAccount } from './compute-group-account';
+
+/**
+ * 
+ * @export
+ * @interface ComputeGroupAccountList
+ */
+export interface ComputeGroupAccountList {
+    /**
+     * 
+     * @type {Array<ComputeGroupAccount>}
+     * @memberof ComputeGroupAccountList
+     */
+    'items': Array<ComputeGroupAccount>;
+}
+

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

@@ -0,0 +1,66 @@
+/* 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.
+ */
+
+
+
+/**
+ * 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/adminapi/models/compute-group-backend.ts

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

package/src/adminapi/models/compute-group-list.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 { 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/adminapi/models/compute-group-scale.ts

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

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

@@ -0,0 +1,117 @@
+/* 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 { 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>;
+}
+

package/src/adminapi/models/engine-mode-transition.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { EnvRerender } from './env-rerender';
 
 /**
  * 
@@ -20,11 +23,23 @@
  * @interface EngineModeTransition
  */
 export interface EngineModeTransition {
+    /**
+     * 
+     * @type {EnvRerender}
+     * @memberof EngineModeTransition
+     */
+    'envRerender'?: EnvRerender;
     /**
      * Target mode name.
      * @type {string}
      * @memberof EngineModeTransition
      */
     'mode': string;
+    /**
+     * Components that must be running once the mode change is done, in addition to the ones the transition creates. Declare a component here when the transition re-renders it instead of creating it, so it must settle before the transition is considered finished. 
+     * @type {Array<string>}
+     * @memberof EngineModeTransition
+     */
+    'waitComponentsRunningAfterModeChange'?: Array<string>;
 }
 

package/src/adminapi/models/env-rerender.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * Rule telling whether the env of an existing component is re-rendered when the mode transitions.
+ * @export
+ * @interface EnvRerender
+ */
+export interface EnvRerender {
+    /**
+     * Re-render the whole env of the component.
+     * @type {boolean}
+     * @memberof EnvRerender
+     */
+    'allEnv'?: boolean;
+    /**
+     * Re-render only these env vars, when allEnv is not set.
+     * @type {Array<string>}
+     * @memberof EnvRerender
+     */
+    'includeEnvs'?: Array<string>;
+}
+

package/src/adminapi/models/index.ts

@@ -219,6 +219,13 @@ export * from './component-option-version-major-version-version-mapping-inner';
 export * from './component-option-version-minor-version';
 export * from './component-version-architecture';
 export * from './component-volume-item';
+export * from './compute-group';
+export * from './compute-group-account';
+export * from './compute-group-account-list';
+export * from './compute-group-backend';
+export * from './compute-group-create';
+export * from './compute-group-list';
+export * from './compute-group-scale';
 export * from './config-entry';
 export * from './config-spec-option';
 export * from './config-type';
@@ -461,6 +468,7 @@ export * from './engine-version-disable-service-version';
 export * from './engine-version-list';
 export * from './engine-version-update';
 export * from './env-module-version';
+export * from './env-rerender';
 export * from './environment';
 export * from './environment-architecture';
 export * from './environment-backup-repo';
@@ -553,6 +561,7 @@ export * from './inspection-evaluation-mode';
 export * from './inspection-script';
 export * from './inspection-script-category';
 export * from './inspection-task';
+export * from './inspection-task-create';
 export * from './inspection-task-format';
 export * from './inspection-task-item';
 export * from './inspection-threshold-direction';