kb-cloud-client-typescript 2.3.40 → 2.3.42

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

@@ -34,6 +34,8 @@ import type { AccountListItem } from '../models';
 // @ts-ignore
 import type { AlertCluster } from '../models';
 // @ts-ignore
+import type { AlertRuleList } from '../models';
+// @ts-ignore
 import type { AlertStatistic } from '../models';
 // @ts-ignore
 import type { Apikey } from '../models';
@@ -5807,7 +5809,7 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
         },
         /**
          * 
-         * @summary Check if cluster alert is disabled
+         * @summary Get cluster alert settings
          * @param {string} orgName name of the Org
          * @param {string} clusterName clusterName
          * @param {*} [options] Override http request option.
@@ -9366,6 +9368,51 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * 
+         * @summary List applicable alert rules for a cluster
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName clusterName
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listClusterAlertRules: async (orgName: string, clusterName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('listClusterAlertRules', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('listClusterAlertRules', 'clusterName', clusterName)
+            const localVarPath = `/admin/v1/organizations/{orgName}/alerts/cluster/{clusterName}/rules`
+                .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 BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -13107,11 +13154,13 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
          * @param {string} [limit] 
          * @param {string} [componentName] 
          * @param {string} [instanceName] 
+         * @param {string} [query] 
+         * @param {string} [filename] 
          * @param {SortType} [sortType] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        queryAuditLogs: async (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, sortType?: SortType, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        queryAuditLogs: async (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, query?: string, filename?: string, sortType?: SortType, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('queryAuditLogs', 'orgName', orgName)
             // verify required parameter 'clusterName' is not null or undefined
@@ -13161,6 +13210,14 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
                 localVarQueryParameter['instanceName'] = instanceName;
             }
 
+            if (query !== undefined) {
+                localVarQueryParameter['query'] = query;
+            }
+
+            if (filename !== undefined) {
+                localVarQueryParameter['filename'] = filename;
+            }
+
             if (sortType !== undefined) {
                 localVarQueryParameter['sortType'] = sortType;
             }
@@ -13557,11 +13614,13 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
          * @param {string} [limit] 
          * @param {string} [componentName] 
          * @param {string} [instanceName] 
+         * @param {string} [query] 
+         * @param {string} [filename] 
          * @param {SortType} [sortType] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        queryLokiAuditLogs: async (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, sortType?: SortType, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        queryLokiAuditLogs: async (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, query?: string, filename?: string, sortType?: SortType, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('queryLokiAuditLogs', 'orgName', orgName)
             // verify required parameter 'clusterName' is not null or undefined
@@ -13611,6 +13670,14 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
                 localVarQueryParameter['instanceName'] = instanceName;
             }
 
+            if (query !== undefined) {
+                localVarQueryParameter['query'] = query;
+            }
+
+            if (filename !== undefined) {
+                localVarQueryParameter['filename'] = filename;
+            }
+
             if (sortType !== undefined) {
                 localVarQueryParameter['sortType'] = sortType;
             }
@@ -15181,7 +15248,7 @@ export const SharedApiAxiosParamCreator = function (configuration?: Configuratio
         },
         /**
          * 
-         * @summary Set cluster alert disabled or enabled
+         * @summary Update cluster alert settings
          * @param {string} orgName name of the Org
          * @param {string} clusterName clusterName
          * @param {AlertCluster} [alertCluster] 
@@ -19389,7 +19456,7 @@ export const SharedApiFp = function(configuration?: Configuration) {
         },
         /**
          * 
-         * @summary Check if cluster alert is disabled
+         * @summary Get cluster alert settings
          * @param {string} orgName name of the Org
          * @param {string} clusterName clusterName
          * @param {*} [options] Override http request option.
@@ -20429,6 +20496,20 @@ export const SharedApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['SharedApi.listCluster']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 
+         * @summary List applicable alert rules for a cluster
+         * @param {string} orgName name of the Org
+         * @param {string} clusterName clusterName
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listClusterAlertRules(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AlertRuleList>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listClusterAlertRules(orgName, clusterName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['SharedApi.listClusterAlertRules']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 
          * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -21553,12 +21634,14 @@ export const SharedApiFp = function(configuration?: Configuration) {
          * @param {string} [limit] 
          * @param {string} [componentName] 
          * @param {string} [instanceName] 
+         * @param {string} [query] 
+         * @param {string} [filename] 
          * @param {SortType} [sortType] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async queryAuditLogs(orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, sortType?: SortType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionLog>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.queryAuditLogs(orgName, clusterName, startTime, endTime, limit, componentName, instanceName, sortType, options);
+        async queryAuditLogs(orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, query?: string, filename?: string, sortType?: SortType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionLog>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.queryAuditLogs(orgName, clusterName, startTime, endTime, limit, componentName, instanceName, query, filename, sortType, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SharedApi.queryAuditLogs']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -21663,12 +21746,14 @@ export const SharedApiFp = function(configuration?: Configuration) {
          * @param {string} [limit] 
          * @param {string} [componentName] 
          * @param {string} [instanceName] 
+         * @param {string} [query] 
+         * @param {string} [filename] 
          * @param {SortType} [sortType] 
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async queryLokiAuditLogs(orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, sortType?: SortType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionLog>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.queryLokiAuditLogs(orgName, clusterName, startTime, endTime, limit, componentName, instanceName, sortType, options);
+        async queryLokiAuditLogs(orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, query?: string, filename?: string, sortType?: SortType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterExecutionLog>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.queryLokiAuditLogs(orgName, clusterName, startTime, endTime, limit, componentName, instanceName, query, filename, sortType, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['SharedApi.queryLokiAuditLogs']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -22083,7 +22168,7 @@ export const SharedApiFp = function(configuration?: Configuration) {
         },
         /**
          * 
-         * @summary Set cluster alert disabled or enabled
+         * @summary Update cluster alert settings
          * @param {string} orgName name of the Org
          * @param {string} clusterName clusterName
          * @param {AlertCluster} [alertCluster] 
@@ -23872,7 +23957,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         },
         /**
          * 
-         * @summary Check if cluster alert is disabled
+         * @summary Get cluster alert settings
          * @param {SharedApiGetClusterAlertDisabledRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -24528,6 +24613,16 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         listCluster(requestParameters: SharedApiListClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterList> {
             return localVarFp.listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 
+         * @summary List applicable alert rules for a cluster
+         * @param {SharedApiListClusterAlertRulesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listClusterAlertRules(requestParameters: SharedApiListClusterAlertRulesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertRuleList> {
+            return localVarFp.listClusterAlertRules(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
+        },
         /**
          * 
          * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -25283,7 +25378,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
          * @throws {RequiredError}
          */
         queryAuditLogs(requestParameters: SharedApiQueryAuditLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterExecutionLog> {
-            return localVarFp.queryAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.sortType, options).then((request) => request(axios, basePath));
+            return localVarFp.queryAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.query, requestParameters.filename, requestParameters.sortType, options).then((request) => request(axios, basePath));
         },
         /**
          * Query cluster metrics by specified metric name and instance name, support instant and range query
@@ -25333,7 +25428,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
          * @throws {RequiredError}
          */
         queryLokiAuditLogs(requestParameters: SharedApiQueryLokiAuditLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterExecutionLog> {
-            return localVarFp.queryLokiAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.sortType, options).then((request) => request(axios, basePath));
+            return localVarFp.queryLokiAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.query, requestParameters.filename, requestParameters.sortType, options).then((request) => request(axios, basePath));
         },
         /**
          * Query error logs through the Loki compatibility API.
@@ -25546,7 +25641,7 @@ export const SharedApiFactory = function (configuration?: Configuration, basePat
         },
         /**
          * 
-         * @summary Set cluster alert disabled or enabled
+         * @summary Update cluster alert settings
          * @param {SharedApiSetClusterAlertDisabledRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -27055,7 +27150,7 @@ export interface SharedApiInterface {
 
     /**
      * 
-     * @summary Check if cluster alert is disabled
+     * @summary Get cluster alert settings
      * @param {SharedApiGetClusterAlertDisabledRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -27711,6 +27806,16 @@ export interface SharedApiInterface {
      */
     listCluster(requestParameters: SharedApiListClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClusterList>;
 
+    /**
+     * 
+     * @summary List applicable alert rules for a cluster
+     * @param {SharedApiListClusterAlertRulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApiInterface
+     */
+    listClusterAlertRules(requestParameters: SharedApiListClusterAlertRulesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertRuleList>;
+
     /**
      * 
      * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -28729,7 +28834,7 @@ export interface SharedApiInterface {
 
     /**
      * 
-     * @summary Set cluster alert disabled or enabled
+     * @summary Update cluster alert settings
      * @param {SharedApiSetClusterAlertDisabledRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -34622,6 +34727,27 @@ export interface SharedApiListClusterRequest {
     readonly includeEndpoints?: boolean
 }
 
+/**
+ * Request parameters for listClusterAlertRules operation in SharedApi.
+ * @export
+ * @interface SharedApiListClusterAlertRulesRequest
+ */
+export interface SharedApiListClusterAlertRulesRequest {
+    /**
+     * name of the Org
+     * @type {string}
+     * @memberof SharedApiListClusterAlertRules
+     */
+    readonly orgName: string
+
+    /**
+     * clusterName
+     * @type {string}
+     * @memberof SharedApiListClusterAlertRules
+     */
+    readonly clusterName: string
+}
+
 /**
  * Request parameters for listClusterJars operation in SharedApi.
  * @export
@@ -36665,6 +36791,20 @@ export interface SharedApiQueryAuditLogsRequest {
      */
     readonly instanceName?: string
 
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiQueryAuditLogs
+     */
+    readonly query?: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiQueryAuditLogs
+     */
+    readonly filename?: string
+
     /**
      * 
      * @type {SortType}
@@ -37050,6 +37190,20 @@ export interface SharedApiQueryLokiAuditLogsRequest {
      */
     readonly instanceName?: string
 
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiQueryLokiAuditLogs
+     */
+    readonly query?: string
+
+    /**
+     * 
+     * @type {string}
+     * @memberof SharedApiQueryLokiAuditLogs
+     */
+    readonly filename?: string
+
     /**
      * 
      * @type {SortType}
@@ -41122,7 +41276,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
 
     /**
      * 
-     * @summary Check if cluster alert is disabled
+     * @summary Get cluster alert settings
      * @param {SharedApiGetClusterAlertDisabledRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -41910,6 +42064,18 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
         return SharedApiFp(this.configuration).listCluster(requestParameters.orgName, requestParameters.clusterDefinition, requestParameters.environmentName, requestParameters.environmentType, requestParameters.tagKey, requestParameters.tagValue, requestParameters.tagKeys, requestParameters.tagValues, requestParameters.licenseId, requestParameters.refClusterName, requestParameters.endpointHost, requestParameters.includeEndpoints, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 
+     * @summary List applicable alert rules for a cluster
+     * @param {SharedApiListClusterAlertRulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    public listClusterAlertRules(requestParameters: SharedApiListClusterAlertRulesRequest, options?: RawAxiosRequestConfig) {
+        return SharedApiFp(this.configuration).listClusterAlertRules(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 
      * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -42816,7 +42982,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     public queryAuditLogs(requestParameters: SharedApiQueryAuditLogsRequest, options?: RawAxiosRequestConfig) {
-        return SharedApiFp(this.configuration).queryAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.sortType, options).then((request) => request(this.axios, this.basePath));
+        return SharedApiFp(this.configuration).queryAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.query, requestParameters.filename, requestParameters.sortType, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -42876,7 +43042,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     public queryLokiAuditLogs(requestParameters: SharedApiQueryLokiAuditLogsRequest, options?: RawAxiosRequestConfig) {
-        return SharedApiFp(this.configuration).queryLokiAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.sortType, options).then((request) => request(this.axios, this.basePath));
+        return SharedApiFp(this.configuration).queryLokiAuditLogs(requestParameters.orgName, requestParameters.clusterName, requestParameters.startTime, requestParameters.endTime, requestParameters.limit, requestParameters.componentName, requestParameters.instanceName, requestParameters.query, requestParameters.filename, requestParameters.sortType, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**
@@ -43132,7 +43298,7 @@ export class SharedApi extends BaseAPI implements SharedApiInterface {
 
     /**
      * 
-     * @summary Set cluster alert disabled or enabled
+     * @summary Update cluster alert settings
      * @param {SharedApiSetClusterAlertDisabledRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/src/adminapi/models/alert-cluster-silence-mode.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+
+/**
+ * Required when enabled. Once uses absolute timestamps; weekly uses weekdays and local times in timeZone.
+ * @export
+ * @enum {string}
+ */
+
+export const AlertClusterSilenceMode = {
+    once: 'once',
+    weekly: 'weekly'
+} as const;
+
+export type AlertClusterSilenceMode = typeof AlertClusterSilenceMode[keyof typeof AlertClusterSilenceMode];
+
+
+

package/src/adminapi/models/alert-cluster-silence.ts

@@ -0,0 +1,83 @@
+/* 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 { AlertClusterSilenceMode } from './alert-cluster-silence-mode';
+
+/**
+ * Pause notifications while continuing to record alerts. Set enabled to false to cancel. Time windows include their start and exclude their end.
+ * @export
+ * @interface AlertClusterSilence
+ */
+export interface AlertClusterSilence {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AlertClusterSilence
+     */
+    'enabled': boolean;
+    /**
+     * Alert names to silence. Empty or omitted means all cluster alerts.
+     * @type {Array<string>}
+     * @memberof AlertClusterSilence
+     */
+    'rules'?: Array<string>;
+    /**
+     * 
+     * @type {AlertClusterSilenceMode}
+     * @memberof AlertClusterSilence
+     */
+    'mode'?: AlertClusterSilenceMode;
+    /**
+     * Required for once. Absolute start of the silence window.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'startsAt'?: string;
+    /**
+     * Required for once. Must be later than startsAt.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'endsAt'?: string;
+    /**
+     * Required for weekly. Sunday is 0. Overnight windows belong to the weekday on which they start.
+     * @type {Array<number>}
+     * @memberof AlertClusterSilence
+     */
+    'weekdays'?: Array<number>;
+    /**
+     * Required for weekly, in HH:mm format.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'startTime'?: string;
+    /**
+     * Required for weekly, in HH:mm format. Earlier than startTime means the following day; equal times are invalid.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'endTime'?: string;
+    /**
+     * Required for weekly. IANA timezone, e.g. Asia/Shanghai or UTC.
+     * @type {string}
+     * @memberof AlertClusterSilence
+     */
+    'timeZone'?: string;
+}
+
+
+

package/src/adminapi/models/alert-cluster.ts

@@ -13,18 +13,39 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { AlertClusterSilence } from './alert-cluster-silence';
 
 /**
- * 
+ * Cluster-scoped alert settings. PATCH updates only supplied fields; settings apply to both tenant and administrator notifications.
  * @export
  * @interface AlertCluster
  */
 export interface AlertCluster {
+    /**
+     * Disable all cluster alerts. Existing rule and silence settings are preserved.
+     * @type {boolean}
+     * @memberof AlertCluster
+     */
+    'disabled'?: boolean | null;
+    /**
+     * Alert names disabled only for this cluster. An empty array clears all rule overrides; omission preserves them.
+     * @type {Array<string>}
+     * @memberof AlertCluster
+     */
+    'disabledRules'?: Array<string>;
     /**
      * 
+     * @type {AlertClusterSilence}
+     * @memberof AlertCluster
+     */
+    'silence'?: AlertClusterSilence;
+    /**
+     * Whether the configured silence window is active now, regardless of the alert master switch.
      * @type {boolean}
      * @memberof AlertCluster
      */
-    'disabled': boolean;
+    'silenceActive'?: boolean;
 }
 

package/src/adminapi/models/component-item-create.ts

@@ -42,13 +42,13 @@ export interface ComponentItemCreate {
      */
     'compNum'?: number;
     /**
-     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. If the rendered component has instance templates, this must equal the sum of all template replica counts in the complete instanceTemplates list.
+     * The number of replicas, for standalone mode, the replicas is 1, for raftGroup mode, the default replicas is 3. When instanceTemplates is provided, this must equal the sum of all template replica counts.
      * @type {number}
      * @memberof ComponentItemCreate
      */
     'replicas'?: number;
     /**
-     * Per-template replicas and optional overlays (env, annotations, labels). Required when the chart renders instance templates. Names must exactly match all chart-rendered instances, without missing, extra, or duplicate names; order does not matter. Component replicas must equal the sum of all requested instance template replica counts.
+     * Per-template replicas and optional overlays (env, annotations, labels, availability zone, storage class). Required when the current mode component declares instanceTemplate in engine_options; otherwise omit. Names must exactly match all chart-rendered instances, without missing, extra, or duplicate names; order does not matter. Component replicas must equal the sum of all requested instance template replica counts.
      * @type {Array<InstanceTemplateCreate>}
      * @memberof ComponentItemCreate
      */

package/src/adminapi/models/component-option-version-blocked-upgrade-from-inner.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.
+ */
+
+
+
+/**
+ * One upgrade restriction while the cluster runs a service version matching from, upgrading to a service version matching to is not allowed.
+ * @export
+ * @interface ComponentOptionVersionBlockedUpgradeFromInner
+ */
+export interface ComponentOptionVersionBlockedUpgradeFromInner {
+    /**
+     * Pattern of the service version the cluster currently runs. Supports exact version \"7.4.7\", version prefix \"7.4\", and comparisons \">=7.4.5\", \">7.4.4\", \"<=7.4.7\", \"<7.4.8\".
+     * @type {string}
+     * @memberof ComponentOptionVersionBlockedUpgradeFromInner
+     */
+    'from': string;
+    /**
+     * Pattern of the service version the upgrade is blocked to, with the same syntax as from. Omit to block every upgrade target, which makes from the end of the line for the component.
+     * @type {string}
+     * @memberof ComponentOptionVersionBlockedUpgradeFromInner
+     */
+    'to'?: string;
+}
+

package/src/adminapi/models/component-option-version.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ComponentOptionVersionBlockedUpgradeFromInner } from './component-option-version-blocked-upgrade-from-inner';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { ComponentOptionVersionMajorVersion } from './component-option-version-major-version';
@@ -53,5 +56,11 @@ export interface ComponentOptionVersion {
      * @memberof ComponentOptionVersion
      */
     'architecture'?: ComponentVersionArchitecture | null;
+    /**
+     * Upgrades that must not be offered or accepted for this component, keyed by the service version the cluster currently runs. Use it when a target version is not a drop-in replacement for a source version, for example when the source image ships modules the target image no longer carries. Upgrades matching no rule stay untouched.
+     * @type {Array<ComponentOptionVersionBlockedUpgradeFromInner>}
+     * @memberof ComponentOptionVersion
+     */
+    'blockedUpgradeFrom'?: Array<ComponentOptionVersionBlockedUpgradeFromInner>;
 }