kb-cloud-client-typescript 2.3.0-alpha.227 → 2.3.0-alpha.229

package/src/openapi/models/environment.ts

@@ -30,6 +30,9 @@ import type { EnvironmentType } from './environment-type';
 import type { IpPoolProvider } from './ip-pool-provider';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { LogBackendType } from './log-backend-type';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkConfig } from './network-config';
 
 /**
@@ -62,6 +65,12 @@ export interface Environment {
      * @memberof Environment
      */
     'networkConfig'?: NetworkConfig;
+    /**
+     * 
+     * @type {LogBackendType}
+     * @memberof Environment
+     */
+    'logBackend'?: LogBackendType;
     /**
      * CreatedAt is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists
      * @type {string}

package/src/openapi/models/index.ts

@@ -502,6 +502,7 @@ export * from './load-balancer-available-type';
 export * from './load-balancer-ipam-status';
 export * from './load-balancer-status';
 export * from './localized-description';
+export * from './log-backend-type';
 export * from './log-disk';
 export * from './log-option';
 export * from './mapping-description';

package/src/openapi/models/log-backend-type.ts

@@ -0,0 +1,31 @@
+/* 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.
+ */
+
+
+
+/**
+ * Log query backend configured for this environment.
+ * @export
+ * @enum {string}
+ */
+
+export const LogBackendType = {
+    loki: 'loki',
+    victoria_logs: 'victoria-logs'
+} as const;
+
+export type LogBackendType = typeof LogBackendType[keyof typeof LogBackendType];
+
+
+

package/src/openapi.yaml

@@ -3847,6 +3847,251 @@ paths:
       tags:
         - clusterLog
         - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/pod:
+    get:
+      description: Query pod logs through the Loki compatibility API.
+      summary: Query Loki pod logs
+      operationId: queryLokiPodLogs
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+        - $ref: '#/components/parameters/filename'
+        - $ref: '#/components/parameters/startTime-2'
+        - $ref: '#/components/parameters/endTime-2'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/sortType'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterRawLogResponse'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/running:
+    get:
+      description: Query running logs through the Loki compatibility API.
+      summary: Query Loki running logs
+      operationId: queryLokiRunningLogs
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+        - $ref: '#/components/parameters/filename'
+        - $ref: '#/components/parameters/startTime-2'
+        - $ref: '#/components/parameters/endTime-2'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/query'
+        - $ref: '#/components/parameters/sortType'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterRawLogResponse'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/error:
+    get:
+      description: Query error logs through the Loki compatibility API.
+      summary: Query Loki error logs
+      operationId: queryLokiErrorLogs
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+        - $ref: '#/components/parameters/filename'
+        - $ref: '#/components/parameters/startTime-2'
+        - $ref: '#/components/parameters/endTime-2'
+        - $ref: '#/components/parameters/query'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/sortType'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterRawLogResponse'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/slow:
+    get:
+      description: Query slow logs through the Loki compatibility API.
+      summary: Query Loki slow logs
+      operationId: queryLokiSlowLogs
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - $ref: '#/components/parameters/startTime-2'
+        - $ref: '#/components/parameters/endTime-2'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+        - $ref: '#/components/parameters/query'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/sortType'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterExecutionLog'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/audit:
+    get:
+      description: Query audit logs through the Loki compatibility API.
+      summary: Query Loki audit logs
+      operationId: queryLokiAuditLogs
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - $ref: '#/components/parameters/startTime-2'
+        - $ref: '#/components/parameters/endTime-2'
+        - $ref: '#/components/parameters/limit'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+        - $ref: '#/components/parameters/sortType'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterExecutionLog'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/slow/stats:
+    get:
+      description: Query slow-log statistics through the Loki compatibility API.
+      summary: Query Loki slow-log statistics
+      operationId: getLokiSlowLogStats
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - $ref: '#/components/parameters/startTime-2'
+        - $ref: '#/components/parameters/endTime-2'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterSlowLogStats'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
+  /api/v1/organizations/{orgName}/clusters/{clusterName}/logs/loki/export:
+    get:
+      description: Export logs through the Loki compatibility API.
+      summary: Export Loki logs
+      operationId: exportLokiClusterLogs
+      parameters:
+        - $ref: '#/components/parameters/orgName'
+        - $ref: '#/components/parameters/clusterName'
+        - in: query
+          name: logType
+          required: true
+          description: 'Log type: runninglog, errorlog, slow, auditlog'
+          schema:
+            type: string
+        - in: query
+          name: startTime
+          description: Start time in epoch nanoseconds. If omitted, exports from the earliest available log
+          schema:
+            type: integer
+            format: int64
+        - in: query
+          name: endTime
+          description: End time in epoch nanoseconds. If omitted, exports up to the latest available log
+          schema:
+            type: integer
+            format: int64
+        - in: query
+          name: format
+          description: 'Export format: csv, raw, jsonl'
+          schema:
+            type: string
+            default: csv
+        - $ref: '#/components/parameters/query'
+        - $ref: '#/components/parameters/filename'
+        - $ref: '#/components/parameters/componentName'
+        - $ref: '#/components/parameters/instanceName'
+        - in: query
+          name: maxLines
+          description: Maximum number of lines to export. Defaults to 100000 if omitted
+          schema:
+            type: integer
+            format: int64
+      responses:
+        '200':
+          description: File download
+          content:
+            application/octet-stream:
+              schema:
+                type: string
+                format: binary
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - clusterLokiLog
+        - shared
   /api/v1/organizations/{orgName}/clusters/{clusterName}/reconfigure:
     post:
       operationId: reconfigureCluster
@@ -20732,6 +20977,12 @@ components:
           items:
             $ref: '#/components/schemas/networkMode'
           description: Network modes of the environment
+    logBackendType:
+      type: string
+      description: Log query backend configured for this environment.
+      enum:
+        - loki
+        - victoria-logs
     environmentState:
       type: string
       description: Output only. State of the Environment resource
@@ -20794,6 +21045,8 @@ components:
           type: array
         networkConfig:
           $ref: '#/components/schemas/networkConfig'
+        logBackend:
+          $ref: '#/components/schemas/logBackendType'
         createdAt:
           description: CreatedAt is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC. Populated by the system. Read-only. Null for lists
           format: date-time
@@ -37638,6 +37891,62 @@ components:
         type: boolean
       required: false
       default: true
+    orgName:
+      in: path
+      name: orgName
+      required: true
+      schema:
+        type: string
+    clusterName:
+      in: path
+      name: clusterName
+      required: true
+      schema:
+        type: string
+    componentName:
+      in: query
+      name: componentName
+      schema:
+        type: string
+    instanceName:
+      in: query
+      name: instanceName
+      schema:
+        type: string
+    filename:
+      in: query
+      name: filename
+      schema:
+        type: string
+    startTime-2:
+      in: query
+      name: startTime
+      description: Start time in epoch nanoseconds.
+      required: true
+      schema:
+        type: string
+    endTime-2:
+      in: query
+      name: endTime
+      description: End time in epoch nanoseconds.
+      required: true
+      schema:
+        type: string
+    limit:
+      in: query
+      name: limit
+      schema:
+        type: string
+    sortType:
+      in: query
+      name: sortType
+      schema:
+        $ref: '#/components/schemas/sortType'
+    query:
+      in: query
+      name: query
+      schema:
+        type: string
 x-tagGroups:
   - name: User
     tags: