kb-cloud-client-typescript 2.3.0-alpha.110 → 2.3.0-alpha.112

package/src/adminapi.yaml

@@ -71,6 +71,8 @@ tags:
     description: Platform Component APIs
   - name: AI Agent
     description: Chat With AI Agent APIs
+  - name: diagnostics
+    description: Diagnostics APIs
 paths:
   /admin/v1/user:
     get:
@@ -4382,11 +4384,13 @@ paths:
         - description: engine Name
           in: query
           name: engineName
+          required: true
           schema:
             type: string
         - description: component type
           in: query
           name: component
+          required: true
           schema:
             type: string
       responses:
@@ -18908,6 +18912,49 @@ paths:
         - session
         - rdbms
         - shared
+  /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}:
+    get:
+      tags:
+        - diagnostics
+      summary: Get PostgreSQL session basic diagnostics
+      description: Get one PostgreSQL session basic diagnostics record by backend pid.
+      operationId: getDiagnosticsPostgresqlSession
+      parameters:
+        - name: orgName
+          in: path
+          description: Organization name
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          description: Cluster name
+          required: true
+          schema:
+            type: string
+        - name: pid
+          in: path
+          description: PostgreSQL backend process id.
+          required: true
+          schema:
+            type: integer
+            format: int64
+            minimum: 1
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/postgresqlSession'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
   /admin/v1/data/mongodb/organizations/{orgName}/clusters/{clusterName}/accounts:
     get:
       description: list accounts in mongodb
@@ -35293,6 +35340,66 @@ components:
         - name
         - role
       type: object
+    postgresqlSession:
+      type: object
+      required:
+        - pid
+        - user
+        - database
+        - applicationName
+        - clientAddr
+        - clientPort
+        - state
+        - waitEventType
+        - waitEvent
+        - durationSeconds
+        - xactDurationSeconds
+        - queryDigest
+        - querySummary
+        - backendType
+      properties:
+        pid:
+          type: integer
+          format: int64
+        user:
+          type: string
+        database:
+          type: string
+        applicationName:
+          type: string
+        clientAddr:
+          type: string
+          description: Client address.
+        clientPort:
+          type: string
+          description: Client port.
+        state:
+          type: string
+        waitEventType:
+          type: string
+        waitEvent:
+          type: string
+        backendStart:
+          type: string
+          description: Backend start timestamp if available.
+        queryStart:
+          type: string
+          description: Query start timestamp if available.
+        xactStart:
+          type: string
+          description: Transaction start timestamp if available.
+        durationSeconds:
+          type: integer
+          format: int64
+        xactDurationSeconds:
+          type: integer
+          format: int64
+        queryDigest:
+          type: string
+        querySummary:
+          type: string
+        backendType:
+          type: string
     dbTDERequest:
       type: object
       properties:
@@ -36657,6 +36764,9 @@ x-tagGroups:
   - name: AI Agent
     tags:
       - AI Agent
+  - name: Diagnostics
+    tags:
+      - diagnostics
   - name: PlatformParameter
     tags:
       - platformParameter

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

@@ -27,6 +27,7 @@ apis/cluster-tag-api.ts
 apis/dameng-api.ts
 apis/data-replication-api.ts
 apis/database-api.ts
+apis/diagnostics-api.ts
 apis/disaster-recovery-api.ts
 apis/dms-api.ts
 apis/enable-service-version-api.ts
@@ -649,6 +650,7 @@ models/phone-verification-request.ts
 models/platform-parameter-constraints.ts
 models/platform-parameter-list.ts
 models/platform-parameter.ts
+models/postgresql-session.ts
 models/pre-check-create.ts
 models/pre-check-result.ts
 models/pre-check-status.ts

package/src/openapi/api.ts

@@ -39,6 +39,7 @@ export * from './apis/cluster-tag-api';
 export * from './apis/dameng-api';
 export * from './apis/data-replication-api';
 export * from './apis/database-api';
+export * from './apis/diagnostics-api';
 export * from './apis/disaster-recovery-api';
 export * from './apis/dms-api';
 export * from './apis/enable-service-version-api';

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

@@ -0,0 +1,196 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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.
+ */
+
+
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { APIErrorResponse } from '../models';
+// @ts-ignore
+import type { PostgresqlSession } from '../models';
+/**
+ * DiagnosticsApi - axios parameter creator
+ * @export
+ */
+export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Get one PostgreSQL session basic diagnostics record by backend pid.
+         * @summary Get PostgreSQL session basic diagnostics
+         * @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}
+         */
+        getDiagnosticsPostgresqlSession: async (orgName: string, clusterName: string, pid: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'orgName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSession', 'orgName', orgName)
+            // verify required parameter 'clusterName' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSession', 'clusterName', clusterName)
+            // verify required parameter 'pid' is not null or undefined
+            assertParamExists('getDiagnosticsPostgresqlSession', 'pid', pid)
+            const localVarPath = `/api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}`
+                .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};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * DiagnosticsApi - functional programming interface
+ * @export
+ */
+export const DiagnosticsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = DiagnosticsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Get one PostgreSQL session basic diagnostics record by backend pid.
+         * @summary Get PostgreSQL session basic diagnostics
+         * @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 getDiagnosticsPostgresqlSession(orgName: string, clusterName: string, pid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSession>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlSession(orgName, clusterName, pid, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSession']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * DiagnosticsApi - factory interface
+ * @export
+ */
+export const DiagnosticsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = DiagnosticsApiFp(configuration)
+    return {
+        /**
+         * Get one PostgreSQL session basic diagnostics record by backend pid.
+         * @summary Get PostgreSQL session basic diagnostics
+         * @param {DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getDiagnosticsPostgresqlSession(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSession> {
+            return localVarFp.getDiagnosticsPostgresqlSession(requestParameters.orgName, requestParameters.clusterName, requestParameters.pid, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * DiagnosticsApi - interface
+ * @export
+ * @interface DiagnosticsApi
+ */
+export interface DiagnosticsApiInterface {
+    /**
+     * Get one PostgreSQL session basic diagnostics record by backend pid.
+     * @summary Get PostgreSQL session basic diagnostics
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApiInterface
+     */
+    getDiagnosticsPostgresqlSession(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSession>;
+
+}
+
+/**
+ * Request parameters for getDiagnosticsPostgresqlSession operation in DiagnosticsApi.
+ * @export
+ * @interface DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest
+ */
+export interface DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest {
+    /**
+     * Organization name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSession
+     */
+    readonly orgName: string
+
+    /**
+     * Cluster name
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSession
+     */
+    readonly clusterName: string
+
+    /**
+     * PostgreSQL backend process id.
+     * @type {number}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSession
+     */
+    readonly pid: number
+}
+
+/**
+ * DiagnosticsApi - object-oriented interface
+ * @export
+ * @class DiagnosticsApi
+ * @extends {BaseAPI}
+ */
+export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
+    /**
+     * Get one PostgreSQL session basic diagnostics record by backend pid.
+     * @summary Get PostgreSQL session basic diagnostics
+     * @param {DiagnosticsApiGetDiagnosticsPostgresqlSessionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DiagnosticsApi
+     */
+    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));
+    }
+}
+

package/src/openapi/models/index.ts

@@ -563,6 +563,7 @@ export * from './phone-verification-request';
 export * from './platform-parameter';
 export * from './platform-parameter-constraints';
 export * from './platform-parameter-list';
+export * from './postgresql-session';
 export * from './pre-check-create';
 export * from './pre-check-result';
 export * from './pre-check-status';

package/src/openapi/models/postgresql-session.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * KubeBlocks Cloud API is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * 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 PostgresqlSession
+ */
+export interface PostgresqlSession {
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlSession
+     */
+    'pid': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'user': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'database': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'applicationName': string;
+    /**
+     * Client address.
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'clientAddr': string;
+    /**
+     * Client port.
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'clientPort': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'state': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'waitEventType': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'waitEvent': string;
+    /**
+     * Backend start timestamp if available.
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'backendStart'?: string;
+    /**
+     * Query start timestamp if available.
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'queryStart'?: string;
+    /**
+     * Transaction start timestamp if available.
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'xactStart'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlSession
+     */
+    'durationSeconds': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PostgresqlSession
+     */
+    'xactDurationSeconds': number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'queryDigest': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'querySummary': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PostgresqlSession
+     */
+    'backendType': string;
+}
+

package/src/openapi.yaml

@@ -4666,6 +4666,49 @@ paths:
         - cluster
         - shared
       x-codegen-request-body-name: body
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}:
+    get:
+      tags:
+        - diagnostics
+      summary: Get PostgreSQL session basic diagnostics
+      description: Get one PostgreSQL session basic diagnostics record by backend pid.
+      operationId: getDiagnosticsPostgresqlSession
+      parameters:
+        - name: orgName
+          in: path
+          description: Organization name
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          description: Cluster name
+          required: true
+          schema:
+            type: string
+        - name: pid
+          in: path
+          description: PostgreSQL backend process id.
+          required: true
+          schema:
+            type: integer
+            format: int64
+            minimum: 1
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/postgresqlSession'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
   /api/v1/organizations/{orgName}/clusters/{clusterName}/metrics:
     get:
       description: Query cluster metrics by specified metric name and instance name, support instant and range query
@@ -21362,6 +21405,66 @@ components:
         taskId:
           type: string
           description: Task ID if the operation is asynchronous (e.g. reconfigure)
+    postgresqlSession:
+      type: object
+      required:
+        - pid
+        - user
+        - database
+        - applicationName
+        - clientAddr
+        - clientPort
+        - state
+        - waitEventType
+        - waitEvent
+        - durationSeconds
+        - xactDurationSeconds
+        - queryDigest
+        - querySummary
+        - backendType
+      properties:
+        pid:
+          type: integer
+          format: int64
+        user:
+          type: string
+        database:
+          type: string
+        applicationName:
+          type: string
+        clientAddr:
+          type: string
+          description: Client address.
+        clientPort:
+          type: string
+          description: Client port.
+        state:
+          type: string
+        waitEventType:
+          type: string
+        waitEvent:
+          type: string
+        backendStart:
+          type: string
+          description: Backend start timestamp if available.
+        queryStart:
+          type: string
+          description: Query start timestamp if available.
+        xactStart:
+          type: string
+          description: Transaction start timestamp if available.
+        durationSeconds:
+          type: integer
+          format: int64
+        xactDurationSeconds:
+          type: integer
+          format: int64
+        queryDigest:
+          type: string
+        querySummary:
+          type: string
+        backendType:
+          type: string
     metricsQueryType:
       type: string
       enum: