kb-cloud-client-typescript 2.3.40 → 2.3.42

package/dist/adminapi/apis/shared-api.d.ts

@@ -17,6 +17,7 @@ import type { ACLUserResponse } from '../models';
 import type { Account } from '../models';
 import type { AccountListItem } from '../models';
 import type { AlertCluster } from '../models';
+import type { AlertRuleList } from '../models';
 import type { AlertStatistic } from '../models';
 import type { Apikey } from '../models';
 import type { ApikeyCreate } from '../models';
@@ -1299,7 +1300,7 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
     getCluster: (orgName: string, clusterName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @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.
@@ -2009,6 +2010,15 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     listCluster: (orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, endpointHost?: string, includeEndpoints?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @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: (orgName: string, clusterName: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -2760,11 +2770,13 @@ export declare const SharedApiAxiosParamCreator: (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}
      */
-    queryAuditLogs: (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, sortType?: SortType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    queryAuditLogs: (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, query?: string, filename?: string, sortType?: SortType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Query cluster metrics by specified metric name and instance name, support instant and range query
      * @summary Query cluster metrics
@@ -2845,11 +2857,13 @@ export declare const SharedApiAxiosParamCreator: (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}
      */
-    queryLokiAuditLogs: (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, sortType?: SortType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    queryLokiAuditLogs: (orgName: string, clusterName: string, startTime: string, endTime: string, limit?: string, componentName?: string, instanceName?: string, query?: string, filename?: string, sortType?: SortType, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Query error logs through the Loki compatibility API.
      * @summary Query Loki error logs
@@ -3155,7 +3169,7 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
     revokeClickhouseRolePrivileges: (orgName: string, clusterName: string, roleName: string, body: RevokeClickhouseRolePrivilegesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @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]
@@ -4751,7 +4765,7 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
     getCluster(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Cluster>>;
     /**
      *
-     * @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.
@@ -5463,6 +5477,15 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listCluster(orgName: string, clusterDefinition?: string, environmentName?: string, environmentType?: EnvironmentType, tagKey?: string, tagValue?: string, tagKeys?: Array<string>, tagValues?: Array<string>, licenseId?: number, refClusterName?: string, endpointHost?: string, includeEndpoints?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterList>>;
+    /**
+     *
+     * @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(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AlertRuleList>>;
     /**
      *
      * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -6220,11 +6243,13 @@ export declare const SharedApiFp: (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}
      */
-    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>>;
+    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>>;
     /**
      * Query cluster metrics by specified metric name and instance name, support instant and range query
      * @summary Query cluster metrics
@@ -6305,11 +6330,13 @@ export declare const SharedApiFp: (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}
      */
-    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>>;
+    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>>;
     /**
      * Query error logs through the Loki compatibility API.
      * @summary Query Loki error logs
@@ -6615,7 +6642,7 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
     revokeClickhouseRolePrivileges(orgName: string, clusterName: string, roleName: string, body: RevokeClickhouseRolePrivilegesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
      *
-     * @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]
@@ -7955,7 +7982,7 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
     getCluster(requestParameters: SharedApiGetClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<Cluster>;
     /**
      *
-     * @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}
@@ -8481,6 +8508,14 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     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}
+     */
+    listClusterAlertRules(requestParameters: SharedApiListClusterAlertRulesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AlertRuleList>;
     /**
      *
      * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -9301,7 +9336,7 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
     revokeClickhouseRolePrivileges(requestParameters: SharedApiRevokeClickhouseRolePrivilegesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
-     * @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}
@@ -10609,7 +10644,7 @@ export interface SharedApiInterface {
     getCluster(requestParameters: SharedApiGetClusterRequest, options?: RawAxiosRequestConfig): AxiosPromise<Cluster>;
     /**
      *
-     * @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}
@@ -11201,6 +11236,15 @@ export interface SharedApiInterface {
      * @memberof 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
@@ -12123,7 +12167,7 @@ export interface SharedApiInterface {
     revokeClickhouseRolePrivileges(requestParameters: SharedApiRevokeClickhouseRolePrivilegesRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
     /**
      *
-     * @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}
@@ -17359,6 +17403,25 @@ 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
@@ -19184,6 +19247,18 @@ export interface SharedApiQueryAuditLogsRequest {
      * @memberof SharedApiQueryAuditLogs
      */
     readonly instanceName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiQueryAuditLogs
+     */
+    readonly query?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiQueryAuditLogs
+     */
+    readonly filename?: string;
     /**
      *
      * @type {SortType}
@@ -19519,6 +19594,18 @@ export interface SharedApiQueryLokiAuditLogsRequest {
      * @memberof SharedApiQueryLokiAuditLogs
      */
     readonly instanceName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiQueryLokiAuditLogs
+     */
+    readonly query?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof SharedApiQueryLokiAuditLogs
+     */
+    readonly filename?: string;
     /**
      *
      * @type {SortType}
@@ -22952,7 +23039,7 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
     getCluster(requestParameters: SharedApiGetClusterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Cluster, any, {}>>;
     /**
      *
-     * @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}
@@ -23544,6 +23631,15 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      * @memberof SharedApi
      */
     listCluster(requestParameters: SharedApiListClusterRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClusterList, any, {}>>;
+    /**
+     *
+     * @summary List applicable alert rules for a cluster
+     * @param {SharedApiListClusterAlertRulesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SharedApi
+     */
+    listClusterAlertRules(requestParameters: SharedApiListClusterAlertRulesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AlertRuleList, any, {}>>;
     /**
      *
      * @summary List external JAR versions with metadata and per-instance synchronization state
@@ -24466,7 +24562,7 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
     revokeClickhouseRolePrivileges(requestParameters: SharedApiRevokeClickhouseRolePrivilegesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
      *
-     * @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}