kb-cloud-client-typescript 2.3.0-alpha.116 → 2.3.0-alpha.117

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

@@ -207,7 +207,7 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      */
     addOrgMember: (orgName: string, body: OrgMemberAdd, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Aggregate slow logs of a cluster (Victoria Logs backend only)
+     * Aggregate slow logs of a cluster over the full requested time range (Victoria Logs backend only). The result is not limited by the slow log list page size.
      * @summary Aggregate cluster slow logs
      * @param {string} orgName
      * @param {string} clusterName
@@ -844,10 +844,22 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * @param {string} [componentName]
      * @param {string} [instanceName]
      * @param {string} [query]
+     * @param {number} [minExecutionTime] Minimum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [maxExecutionTime] Maximum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [minLockTime] Minimum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [maxLockTime] Maximum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [minRowsExamined]
+     * @param {number} [maxRowsExamined]
+     * @param {number} [minRowsSent]
+     * @param {number} [maxRowsSent]
+     * @param {string} [dbName] Filter slow logs whose database name contains this value.
+     * @param {string} [userName] Filter slow logs whose user name contains this value.
+     * @param {string} [clientIp] Filter slow logs whose client IP contains this value, or is within this CIDR range when the value is valid CIDR.
+     * @param {string} [appName] Filter slow logs whose application name contains this value.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    explainSlowLogTemplate: (orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    explainSlowLogTemplate: (orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, minExecutionTime?: number, maxExecutionTime?: number, minLockTime?: number, maxLockTime?: number, minRowsExamined?: number, maxRowsExamined?: number, minRowsSent?: number, maxRowsSent?: number, dbName?: string, userName?: string, clientIp?: string, appName?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
      * @summary Export parameter template from cluster
@@ -1283,7 +1295,7 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      */
     getSchemaList: (orgName: string, clusterName: string, id: string, database?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Get statistics summary for slow logs of a cluster
+     * Get statistics summary for slow logs of a cluster. When the same slow log filters are supplied, totalSlowLogs can be used as the filtered list preview count.
      * @summary Get cluster slow log statistics
      * @param {string} orgName
      * @param {string} clusterName
@@ -1321,10 +1333,22 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      * @param {string} [componentName]
      * @param {string} [instanceName]
      * @param {string} [query]
+     * @param {number} [minExecutionTime] Minimum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [maxExecutionTime] Maximum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [minLockTime] Minimum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [maxLockTime] Maximum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [minRowsExamined]
+     * @param {number} [maxRowsExamined]
+     * @param {number} [minRowsSent]
+     * @param {number} [maxRowsSent]
+     * @param {string} [dbName] Filter slow logs whose database name contains this value.
+     * @param {string} [userName] Filter slow logs whose user name contains this value.
+     * @param {string} [clientIp] Filter slow logs whose client IP contains this value, or is within this CIDR range when the value is valid CIDR.
+     * @param {string} [appName] Filter slow logs whose application name contains this value.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSlowLogTemplate: (orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    getSlowLogTemplate: (orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, minExecutionTime?: number, maxExecutionTime?: number, minLockTime?: number, maxLockTime?: number, minRowsExamined?: number, maxRowsExamined?: number, minRowsSent?: number, maxRowsSent?: number, dbName?: string, userName?: string, clientIp?: string, appName?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Query the SQL audit log switch status for a cluster component
      * @summary Get SQL audit log status
@@ -2153,7 +2177,7 @@ export declare const SharedApiAxiosParamCreator: (configuration?: Configuration)
      */
     queryImportObjects: (orgName: string, clusterName: string, importQueryObjectsRequest: ImportQueryObjectsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only)
+     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only). When logType=slow, buckets also include avgExecutionTime in seconds; templateId can be supplied for slow template trends.
      * @summary Query log hits histogram
      * @param {string} orgName
      * @param {string} clusterName
@@ -2782,7 +2806,7 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      */
     addOrgMember(orgName: string, body: OrgMemberAdd, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrgMember>>;
     /**
-     * Aggregate slow logs of a cluster (Victoria Logs backend only)
+     * Aggregate slow logs of a cluster over the full requested time range (Victoria Logs backend only). The result is not limited by the slow log list page size.
      * @summary Aggregate cluster slow logs
      * @param {string} orgName
      * @param {string} clusterName
@@ -3419,10 +3443,22 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * @param {string} [componentName]
      * @param {string} [instanceName]
      * @param {string} [query]
+     * @param {number} [minExecutionTime] Minimum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [maxExecutionTime] Maximum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [minLockTime] Minimum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [maxLockTime] Maximum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [minRowsExamined]
+     * @param {number} [maxRowsExamined]
+     * @param {number} [minRowsSent]
+     * @param {number} [maxRowsSent]
+     * @param {string} [dbName] Filter slow logs whose database name contains this value.
+     * @param {string} [userName] Filter slow logs whose user name contains this value.
+     * @param {string} [clientIp] Filter slow logs whose client IP contains this value, or is within this CIDR range when the value is valid CIDR.
+     * @param {string} [appName] Filter slow logs whose application name contains this value.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    explainSlowLogTemplate(orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterSlowLogExplainResponse>>;
+    explainSlowLogTemplate(orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, minExecutionTime?: number, maxExecutionTime?: number, minLockTime?: number, maxLockTime?: number, minRowsExamined?: number, maxRowsExamined?: number, minRowsSent?: number, maxRowsSent?: number, dbName?: string, userName?: string, clientIp?: string, appName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterSlowLogExplainResponse>>;
     /**
      *
      * @summary Export parameter template from cluster
@@ -3858,7 +3894,7 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      */
     getSchemaList(orgName: string, clusterName: string, id: string, database?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
     /**
-     * Get statistics summary for slow logs of a cluster
+     * Get statistics summary for slow logs of a cluster. When the same slow log filters are supplied, totalSlowLogs can be used as the filtered list preview count.
      * @summary Get cluster slow log statistics
      * @param {string} orgName
      * @param {string} clusterName
@@ -3896,10 +3932,22 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      * @param {string} [componentName]
      * @param {string} [instanceName]
      * @param {string} [query]
+     * @param {number} [minExecutionTime] Minimum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [maxExecutionTime] Maximum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @param {number} [minLockTime] Minimum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [maxLockTime] Maximum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @param {number} [minRowsExamined]
+     * @param {number} [maxRowsExamined]
+     * @param {number} [minRowsSent]
+     * @param {number} [maxRowsSent]
+     * @param {string} [dbName] Filter slow logs whose database name contains this value.
+     * @param {string} [userName] Filter slow logs whose user name contains this value.
+     * @param {string} [clientIp] Filter slow logs whose client IP contains this value, or is within this CIDR range when the value is valid CIDR.
+     * @param {string} [appName] Filter slow logs whose application name contains this value.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSlowLogTemplate(orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterSlowLogTemplate>>;
+    getSlowLogTemplate(orgName: string, clusterName: string, templateId: string, startTime: string, endTime: string, componentName?: string, instanceName?: string, query?: string, minExecutionTime?: number, maxExecutionTime?: number, minLockTime?: number, maxLockTime?: number, minRowsExamined?: number, maxRowsExamined?: number, minRowsSent?: number, maxRowsSent?: number, dbName?: string, userName?: string, clientIp?: string, appName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClusterSlowLogTemplate>>;
     /**
      * Query the SQL audit log switch status for a cluster component
      * @summary Get SQL audit log status
@@ -4728,7 +4776,7 @@ export declare const SharedApiFp: (configuration?: Configuration) => {
      */
     queryImportObjects(orgName: string, clusterName: string, importQueryObjectsRequest: ImportQueryObjectsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReplicationObjectTree>>;
     /**
-     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only)
+     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only). When logType=slow, buckets also include avgExecutionTime in seconds; templateId can be supplied for slow template trends.
      * @summary Query log hits histogram
      * @param {string} orgName
      * @param {string} clusterName
@@ -5356,7 +5404,7 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      */
     addOrgMember(requestParameters: SharedApiAddOrgMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgMember>;
     /**
-     * Aggregate slow logs of a cluster (Victoria Logs backend only)
+     * Aggregate slow logs of a cluster over the full requested time range (Victoria Logs backend only). The result is not limited by the slow log list page size.
      * @summary Aggregate cluster slow logs
      * @param {SharedApiAggregateSlowLogsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -6188,7 +6236,7 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      */
     getSchemaList(requestParameters: SharedApiGetSchemaListRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
     /**
-     * Get statistics summary for slow logs of a cluster
+     * Get statistics summary for slow logs of a cluster. When the same slow log filters are supplied, totalSlowLogs can be used as the filtered list preview count.
      * @summary Get cluster slow log statistics
      * @param {SharedApiGetSlowLogStatsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -6856,7 +6904,7 @@ export declare const SharedApiFactory: (configuration?: Configuration, basePath?
      */
     queryImportObjects(requestParameters: SharedApiQueryImportObjectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReplicationObjectTree>;
     /**
-     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only)
+     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only). When logType=slow, buckets also include avgExecutionTime in seconds; templateId can be supplied for slow template trends.
      * @summary Query log hits histogram
      * @param {SharedApiQueryLogHitsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -7278,7 +7326,7 @@ export interface SharedApiInterface {
      */
     addOrgMember(requestParameters: SharedApiAddOrgMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrgMember>;
     /**
-     * Aggregate slow logs of a cluster (Victoria Logs backend only)
+     * Aggregate slow logs of a cluster over the full requested time range (Victoria Logs backend only). The result is not limited by the slow log list page size.
      * @summary Aggregate cluster slow logs
      * @param {SharedApiAggregateSlowLogsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -8214,7 +8262,7 @@ export interface SharedApiInterface {
      */
     getSchemaList(requestParameters: SharedApiGetSchemaListRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
     /**
-     * Get statistics summary for slow logs of a cluster
+     * Get statistics summary for slow logs of a cluster. When the same slow log filters are supplied, totalSlowLogs can be used as the filtered list preview count.
      * @summary Get cluster slow log statistics
      * @param {SharedApiGetSlowLogStatsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -8966,7 +9014,7 @@ export interface SharedApiInterface {
      */
     queryImportObjects(requestParameters: SharedApiQueryImportObjectsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReplicationObjectTree>;
     /**
-     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only)
+     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only). When logType=slow, buckets also include avgExecutionTime in seconds; templateId can be supplied for slow template trends.
      * @summary Query log hits histogram
      * @param {SharedApiQueryLogHitsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -11110,6 +11158,78 @@ export interface SharedApiExplainSlowLogTemplateRequest {
      * @memberof SharedApiExplainSlowLogTemplate
      */
     readonly query?: string;
+    /**
+     * Minimum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly minExecutionTime?: number;
+    /**
+     * Maximum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly maxExecutionTime?: number;
+    /**
+     * Minimum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly minLockTime?: number;
+    /**
+     * Maximum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly maxLockTime?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly minRowsExamined?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly maxRowsExamined?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly minRowsSent?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly maxRowsSent?: number;
+    /**
+     * Filter slow logs whose database name contains this value.
+     * @type {string}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly dbName?: string;
+    /**
+     * Filter slow logs whose user name contains this value.
+     * @type {string}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly userName?: string;
+    /**
+     * Filter slow logs whose client IP contains this value, or is within this CIDR range when the value is valid CIDR.
+     * @type {string}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly clientIp?: string;
+    /**
+     * Filter slow logs whose application name contains this value.
+     * @type {string}
+     * @memberof SharedApiExplainSlowLogTemplate
+     */
+    readonly appName?: string;
 }
 /**
  * Request parameters for exportParameterTemplateFromCluster operation in SharedApi.
@@ -12432,6 +12552,78 @@ export interface SharedApiGetSlowLogTemplateRequest {
      * @memberof SharedApiGetSlowLogTemplate
      */
     readonly query?: string;
+    /**
+     * Minimum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly minExecutionTime?: number;
+    /**
+     * Maximum slow log execution time in seconds. Decimal values are supported, for example 0.5.
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly maxExecutionTime?: number;
+    /**
+     * Minimum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly minLockTime?: number;
+    /**
+     * Maximum slow log lock time in seconds. Decimal values are supported, for example 0.001.
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly maxLockTime?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly minRowsExamined?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly maxRowsExamined?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly minRowsSent?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly maxRowsSent?: number;
+    /**
+     * Filter slow logs whose database name contains this value.
+     * @type {string}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly dbName?: string;
+    /**
+     * Filter slow logs whose user name contains this value.
+     * @type {string}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly userName?: string;
+    /**
+     * Filter slow logs whose client IP contains this value, or is within this CIDR range when the value is valid CIDR.
+     * @type {string}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly clientIp?: string;
+    /**
+     * Filter slow logs whose application name contains this value.
+     * @type {string}
+     * @memberof SharedApiGetSlowLogTemplate
+     */
+    readonly appName?: string;
 }
 /**
  * Request parameters for getSqlAudit operation in SharedApi.
@@ -16389,7 +16581,7 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      */
     addOrgMember(requestParameters: SharedApiAddOrgMemberRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrgMember, any, {}>>;
     /**
-     * Aggregate slow logs of a cluster (Victoria Logs backend only)
+     * Aggregate slow logs of a cluster over the full requested time range (Victoria Logs backend only). The result is not limited by the slow log list page size.
      * @summary Aggregate cluster slow logs
      * @param {SharedApiAggregateSlowLogsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -17325,7 +17517,7 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      */
     getSchemaList(requestParameters: SharedApiGetSchemaListRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
     /**
-     * Get statistics summary for slow logs of a cluster
+     * Get statistics summary for slow logs of a cluster. When the same slow log filters are supplied, totalSlowLogs can be used as the filtered list preview count.
      * @summary Get cluster slow log statistics
      * @param {SharedApiGetSlowLogStatsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -18077,7 +18269,7 @@ export declare class SharedApi extends BaseAPI implements SharedApiInterface {
      */
     queryImportObjects(requestParameters: SharedApiQueryImportObjectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReplicationObjectTree, any, {}>>;
     /**
-     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only)
+     * Query log hits histogram for time-bucketed log counts (VictoriaLogs only). When logType=slow, buckets also include avgExecutionTime in seconds; templateId can be supplied for slow template trends.
      * @summary Query log hits histogram
      * @param {SharedApiQueryLogHitsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.