kb-cloud-client-typescript 2.3.0-alpha.111 → 2.3.0-alpha.113

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

@@ -718,7 +718,13 @@ models/pod-condition.ts
 models/pod-owner-reference.ts
 models/pod-resources.ts
 models/pod.ts
+models/postgresql-deadlock-evidence.ts
+models/postgresql-lock-analysis.ts
+models/postgresql-lock-row.ts
 models/postgresql-session.ts
+models/postgresql-wait-chain-edge.ts
+models/postgresql-wait-chain-node.ts
+models/postgresql-wait-chain.ts
 models/pre-check-result.ts
 models/pre-check-status.ts
 models/pre-check-task-detail.ts

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

@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError
 // @ts-ignore
 import type { APIErrorResponse } from '../models';
 // @ts-ignore
+import type { PostgresqlLockAnalysis } from '../models';
+// @ts-ignore
 import type { PostgresqlSession } from '../models';
 /**
  * DiagnosticsApi - axios parameter creator
@@ -71,6 +73,55 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
+         * @summary Get PostgreSQL session lock analysis
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {number} pid PostgreSQL backend process id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSessionLockAnalysis: async (orgName: string, clusterName: string, pid: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSessionLockAnalysis', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSessionLockAnalysis', 'clusterName', clusterName)
+            // verify required parameter 'pid' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSessionLockAnalysis', 'pid', pid)
+            const localVarPath = `/admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis`
+                .replace(`{${"orgName"}}`, encodeURIComponent(String(orgName)))
+                .replace(`{${"clusterName"}}`, encodeURIComponent(String(clusterName)))
+                .replace(`{${"pid"}}`, encodeURIComponent(String(pid)));
+            // 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};
@@ -105,6 +156,21 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSession']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
+         * @summary Get PostgreSQL session lock analysis
+         * @param {string} orgName Organization name
+         * @param {string} clusterName Cluster name
+         * @param {number} pid PostgreSQL backend process id.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getDiagnosticsPostgresqlSessionLockAnalysis(orgName: string, clusterName: string, pid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlLockAnalysis>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlSessionLockAnalysis(orgName, clusterName, pid, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSessionLockAnalysis']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
     }
 };
 
@@ -125,6 +191,16 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
         getDiagnosticsPostgresqlSession(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSession> {
             return localVarFp.getDiagnosticsPostgresqlSession(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
+         * @summary Get PostgreSQL session lock analysis
+         * @param {DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlLockAnalysis> {
+            return localVarFp.getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(axios, basePath));
+        },
     };
 };
 
@@ -144,6 +220,16 @@ export interface DiagnosticsApiInterface {
      */
     getDiagnosticsPostgresqlSession(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSession>;
 
+    /**
+     * Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
+     * @summary Get PostgreSQL session lock analysis
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApiInterface
+     */
+    getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlLockAnalysis>;
+
 }
 
 /**
@@ -174,6 +260,34 @@ export interface DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest {
     readonly pid: number
 }
 
+/**
+ * Request parameters for getDiagnosticsPostgresqlSessionLockAnalysis operation in DiagnosticsApi.
+ * @export
+ * @interface DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest
+ */
+export interface DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysis
+     */
+    readonly orgName: string
+
+    /**
+     * Cluster name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysis
+     */
+    readonly clusterName: string
+
+    /**
+     * PostgreSQL backend process id.
+     * @type {number}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysis
+     */
+    readonly pid: number
+}
+
 /**
  * DiagnosticsApi - object-oriented interface
  * @export
@@ -192,5 +306,17 @@ export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
     public getDiagnosticsPostgresqlSession(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest, options?: RawAxiosRequestConfig) {
         return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSession(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(this.axios, this.basePath));
     }
+
+    /**
+     * Get read-only lock analysis for one PostgreSQL backend pid from the current DMS PostgreSQL lock snapshot.
+     * @summary Get PostgreSQL session lock analysis
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApi
+     */
+    public getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionLockAnalysisRequest, options?: RawAxiosRequestConfig) {
+        return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSessionLockAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 

package/src/adminapi/models/index.ts

@@ -620,7 +620,13 @@ export * from './pod';
 export * from './pod-condition';
 export * from './pod-owner-reference';
 export * from './pod-resources';
+export * from './postgresql-deadlock-evidence';
+export * from './postgresql-lock-analysis';
+export * from './postgresql-lock-row';
 export * from './postgresql-session';
+export * from './postgresql-wait-chain';
+export * from './postgresql-wait-chain-edge';
+export * from './postgresql-wait-chain-node';
 export * from './pre-check-result';
 export * from './pre-check-status';
 export * from './pre-check-task-detail';

package/src/adminapi/models/postgresql-deadlock-evidence.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 PostgresqlDeadlockEvidence
+ */
+export interface PostgresqlDeadlockEvidence {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostgresqlDeadlockEvidence
+     */
+    'detected': boolean;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof PostgresqlDeadlockEvidence
+     */
+    'cyclePids': Array<number>;
+}
+

package/src/adminapi/models/postgresql-lock-analysis.ts

@@ -0,0 +1,90 @@
+/* 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 { PostgresqlDeadlockEvidence } from './postgresql-deadlock-evidence';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PostgresqlLockRow } from './postgresql-lock-row';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PostgresqlSession } from './postgresql-session';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PostgresqlWaitChain } from './postgresql-wait-chain';
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlLockAnalysis
+ */
+export interface PostgresqlLockAnalysis {
+    /**
+     * 
+     * @type {PostgresqlSession}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'selectedSession': PostgresqlSession;
+    /**
+     * 
+     * @type {Array<PostgresqlSession>}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'blockingSessions': Array<PostgresqlSession>;
+    /**
+     * 
+     * @type {Array<PostgresqlSession>}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'blockedSessions': Array<PostgresqlSession>;
+    /**
+     * 
+     * @type {Array<PostgresqlLockRow>}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'lockRows': Array<PostgresqlLockRow>;
+    /**
+     * 
+     * @type {PostgresqlWaitChain}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'waitChain': PostgresqlWaitChain;
+    /**
+     * 
+     * @type {PostgresqlDeadlockEvidence}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'deadlock': PostgresqlDeadlockEvidence;
+    /**
+     * Whether the current snapshot cannot prove the lock relationship conclusively.
+     * @type {boolean}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'cannotProve': boolean;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'warnings': Array<string>;
+    /**
+     * Snapshot capture timestamp in UTC.
+     * @type {string}
+     * @memberof PostgresqlLockAnalysis
+     */
+    'capturedAt': string;
+}
+

package/src/adminapi/models/postgresql-lock-row.ts

@@ -0,0 +1,114 @@
+/* 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 PostgresqlLockRow
+ */
+export interface PostgresqlLockRow {
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlLockRow
+     */
+    'pid': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'lockType': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'mode': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PostgresqlLockRow
+     */
+    'granted': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'relationOid'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'relationName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'databaseName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'transactionID'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'virtualTransaction'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'virtualXID'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'tuple'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'page'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'classID'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'objID'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlLockRow
+     */
+    'objSubID'?: string;
+}
+

package/src/adminapi/models/postgresql-wait-chain-edge.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 PostgresqlWaitChainEdge
+ */
+export interface PostgresqlWaitChainEdge {
+    /**
+     * PID that blocks another session.
+     * @type {number}
+     * @memberof PostgresqlWaitChainEdge
+     */
+    'blockingPid': number;
+    /**
+     * PID that is blocked by another session.
+     * @type {number}
+     * @memberof PostgresqlWaitChainEdge
+     */
+    'blockedPid': number;
+}
+

package/src/adminapi/models/postgresql-wait-chain-node.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 { PostgresqlSession } from './postgresql-session';
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlWaitChainNode
+ */
+export interface PostgresqlWaitChainNode {
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlWaitChainNode
+     */
+    'pid': number;
+    /**
+     * Role in the selected session wait graph. Known values are selected, blocking, blocked, and related.
+     * @type {string}
+     * @memberof PostgresqlWaitChainNode
+     */
+    'role': string;
+    /**
+     * 
+     * @type {PostgresqlSession}
+     * @memberof PostgresqlWaitChainNode
+     */
+    'session'?: PostgresqlSession;
+}
+

package/src/adminapi/models/postgresql-wait-chain.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PostgresqlWaitChainEdge } from './postgresql-wait-chain-edge';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { PostgresqlWaitChainNode } from './postgresql-wait-chain-node';
+
+/**
+ * 
+ * @export
+ * @interface PostgresqlWaitChain
+ */
+export interface PostgresqlWaitChain {
+    /**
+     * 
+     * @type {Array<PostgresqlWaitChainNode>}
+     * @memberof PostgresqlWaitChain
+     */
+    'nodes': Array<PostgresqlWaitChainNode>;
+    /**
+     * 
+     * @type {Array<PostgresqlWaitChainEdge>}
+     * @memberof PostgresqlWaitChain
+     */
+    'edges': Array<PostgresqlWaitChainEdge>;
+}
+