kb-cloud-client-typescript 2.3.0-alpha.122 → 2.3.0-alpha.124

package/src/adminapi.yaml

@@ -18790,6 +18790,257 @@ paths:
         - rdbms
         - shared
       x-codegen-request-body-name: body
+  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/access-keys:
+    get:
+      description: list MinIO service account access keys
+      summary: List MinIO access keys
+      operationId: listServiceAccounts
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: MinIO user that owns the service accounts
+          in: query
+          name: userName
+          required: false
+          schema:
+            type: string
+      responses:
+        '200':
+          description: list MinIO access keys success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DmsServiceAccountList'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - account
+        - rdbms
+        - shared
+    post:
+      description: create a MinIO service account access key
+      summary: Create MinIO access key
+      operationId: createServiceAccount
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DmsServiceAccountCreateRequest'
+        required: true
+      responses:
+        '201':
+          description: create MinIO access key success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DmsServiceAccount'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - account
+        - rdbms
+        - shared
+      x-codegen-request-body-name: body
+  /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/access-keys/{accessKey}:
+    get:
+      description: get a MinIO service account access key
+      summary: Get MinIO access key
+      operationId: getServiceAccount
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: MinIO access key
+          in: path
+          name: accessKey
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: get MinIO access key success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DmsServiceAccount'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - account
+        - rdbms
+        - shared
+    patch:
+      description: update a MinIO service account access key
+      summary: Update MinIO access key
+      operationId: updateServiceAccount
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: MinIO access key
+          in: path
+          name: accessKey
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DmsServiceAccountUpdateRequest'
+        required: true
+      responses:
+        '200':
+          description: update MinIO access key success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DmsServiceAccount'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - account
+        - rdbms
+        - shared
+      x-codegen-request-body-name: body
+    delete:
+      description: delete a MinIO service account access key
+      summary: Delete MinIO access key
+      operationId: deleteServiceAccount
+      parameters:
+        - description: name of the engine
+          in: path
+          name: engineName
+          required: true
+          schema:
+            type: string
+        - description: name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: name of the cluster
+          in: path
+          name: clusterName
+          required: true
+          schema:
+            type: string
+        - description: MinIO access key
+          in: path
+          name: accessKey
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          content: {}
+          description: Returned when access key is deleted successfully.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '500':
+          $ref: '#/components/responses/500'
+      tags:
+        - account
+        - rdbms
+        - shared
   /admin/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/root-password:
     get:
       description: get root account password
@@ -19144,6 +19395,12 @@ paths:
           required: true
           schema:
             type: string
+        - name: databaseName
+          in: query
+          description: Optional database name for selected table, index, and TOAST details. When omitted, the backend selects the largest connectable non-template database.
+          required: false
+          schema:
+            type: string
       responses:
         '200':
           description: OK
@@ -19157,6 +19414,8 @@ paths:
           $ref: '#/components/responses/401'
         '403':
           $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
   /admin/v1/organizations/{orgName}/clusters/{clusterName}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
@@ -23662,6 +23921,7 @@ components:
         - timestamp
         - usedBytes
         - totalBytes
+        - availableBytes
         - usageRatio
       properties:
         timestamp:
@@ -23672,17 +23932,43 @@ components:
         totalBytes:
           type: integer
           format: int64
+        availableBytes:
+          type: integer
+          format: int64
         usageRatio:
           type: number
           format: double
+    clusterStorageUsageHistoryInstance:
+      type: object
+      required:
+        - points
+      properties:
+        instanceName:
+          type: string
+          description: Kubernetes pod name for this storage usage series.
+        pvcName:
+          type: string
+          description: PersistentVolumeClaim name when it can be read from metrics labels.
+        role:
+          type: string
+          description: Raw database replica role value read from metrics labels, kept aligned with instance detail display.
+        componentName:
+          type: string
+          description: Optional KubeBlocks component name when it can be read from metrics labels.
+        points:
+          type: array
+          items:
+            $ref: '#/components/schemas/clusterStorageUsageHistoryPoint'
+        source:
+          type: string
     clusterStorageUsageHistory:
       type: object
-      description: Cluster storage usage history collected from backend-owned fixed metrics.
+      description: Per-instance cluster storage usage history collected from backend-owned fixed metrics.
       required:
         - timeRange
         - start
         - end
-        - points
+        - instances
         - source
         - collectedAt
       properties:
@@ -23695,10 +23981,10 @@ components:
         end:
           type: string
           description: History query end timestamp in UTC.
-        points:
+        instances:
           type: array
           items:
-            $ref: '#/components/schemas/clusterStorageUsageHistoryPoint'
+            $ref: '#/components/schemas/clusterStorageUsageHistoryInstance'
         source:
           type: string
           description: Metrics source used to build the history.
@@ -35684,6 +35970,85 @@ components:
         - name
         - role
       type: object
+    DmsServiceAccount:
+      description: MinIO service account access-key
+      type: object
+      properties:
+        userName:
+          type: string
+          description: MinIO user that owns the service account.
+        accessKey:
+          type: string
+          description: Service account access key.
+        secretKey:
+          type: string
+          description: Secret key returned only by create.
+        status:
+          type: string
+          description: Service account status.
+        name:
+          type: string
+          description: Display name of the service account.
+        description:
+          type: string
+          description: Description of the service account.
+        expiration:
+          type: string
+          format: date-time
+          description: Service account expiration time.
+        policy:
+          type: string
+          description: Service account policy text.
+        impliedPolicy:
+          type: boolean
+          description: Whether the policy is implied from the parent user.
+    DmsServiceAccountList:
+      description: MinIO service account access-key list
+      type: array
+      items:
+        $ref: '#/components/schemas/DmsServiceAccount'
+    DmsServiceAccountCreateRequest:
+      description: MinIO service account access-key create request
+      type: object
+      required:
+        - userName
+      properties:
+        userName:
+          type: string
+          description: MinIO user that owns the service account.
+        accessKey:
+          type: string
+          description: Optional fixed access key. If omitted, MinIO generates it.
+        secretKey:
+          type: string
+          description: Optional fixed secret key. If omitted, MinIO generates it.
+        name:
+          type: string
+          description: Display name of the service account.
+        description:
+          type: string
+          description: Description of the service account.
+        expiration:
+          type: string
+          format: date-time
+          description: Optional service account expiration time.
+    DmsServiceAccountStatus:
+      description: MinIO service account status.
+      type: string
+      enum:
+        - enabled
+        - disabled
+    DmsServiceAccountUpdateRequest:
+      description: MinIO service account access-key update request
+      type: object
+      properties:
+        status:
+          $ref: '#/components/schemas/DmsServiceAccountStatus'
+          description: Optional service account status.
+        expiration:
+          type: string
+          format: date-time
+          description: Optional service account expiration time. Use the Unix epoch to clear expiration.
     postgresqlSession:
       type: object
       required:
@@ -35781,32 +36146,56 @@ components:
           type: boolean
         indexListTruncated:
           type: boolean
-    postgresqlStorageOverview:
+    postgresqlStorageInstanceUsage:
       type: object
-      required:
-        - source
       properties:
+        instanceName:
+          type: string
+          description: Kubernetes pod name for this PostgreSQL replica storage sample.
+        pvcName:
+          type: string
+          description: PersistentVolumeClaim name when it can be read from metrics labels.
+        role:
+          type: string
+          description: Raw PostgreSQL replica role value read from metrics labels, kept aligned with instance detail display.
+        componentName:
+          type: string
+          description: Optional KubeBlocks component name when it can be read from metrics labels.
         totalBytes:
           type: integer
           format: int64
-          description: Current total PVC capacity in bytes when backend-owned metrics are available.
+          description: Physical PVC capacity in bytes for this replica storage sample.
         usedBytes:
           type: integer
           format: int64
-          description: Current PVC used bytes when backend-owned metrics are available.
+          description: Physical PVC used bytes for this replica storage sample.
         availableBytes:
           type: integer
           format: int64
-          description: Current available PVC bytes derived from totalBytes - usedBytes when both values are available.
+          description: Available bytes derived from totalBytes - usedBytes when both values are available.
         usageRatio:
           type: number
           format: double
-          description: Current usedBytes / totalBytes ratio when both values are available.
+          nullable: true
+          description: usedBytes / totalBytes for this replica storage sample when both values are available.
         updatedAt:
           type: string
           description: Metrics collection timestamp in UTC.
         source:
           type: string
+    postgresqlStorageOverview:
+      type: object
+      required:
+        - source
+        - instances
+      properties:
+        source:
+          type: string
+        instances:
+          type: array
+          description: Physical PostgreSQL replica storage usage split by pod/PVC/role.
+          items:
+            $ref: '#/components/schemas/postgresqlStorageInstanceUsage'
     postgresqlDatabaseSpace:
       type: object
       properties:
@@ -35937,6 +36326,7 @@ components:
         - summary
         - storageOverview
         - databases
+        - selectedDatabase
         - tables
         - indexes
         - toastRelations
@@ -35949,18 +36339,25 @@ components:
           $ref: '#/components/schemas/postgresqlStorageOverview'
         databases:
           type: array
+          description: Sizes of all connectable non-template databases in the PostgreSQL instance.
           items:
             $ref: '#/components/schemas/postgresqlDatabaseSpace'
+        selectedDatabase:
+          type: string
+          description: Database used for tables, indexes, and toastRelations in this response.
         tables:
           type: array
+          description: Top tables from selectedDatabase.
           items:
             $ref: '#/components/schemas/postgresqlTableSpace'
         indexes:
           type: array
+          description: Top indexes from selectedDatabase.
           items:
             $ref: '#/components/schemas/postgresqlIndexSpace'
         toastRelations:
           type: array
+          description: Toast relations derived from selectedDatabase table space data.
           items:
             $ref: '#/components/schemas/postgresqlToastRelationSpace'
         sources:

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

@@ -256,6 +256,7 @@ models/cluster-slow-log-explain-response.ts
 models/cluster-slow-log-stats.ts
 models/cluster-slow-log-template-list.ts
 models/cluster-slow-log-template.ts
+models/cluster-storage-usage-history-instance.ts
 models/cluster-storage-usage-history-point.ts
 models/cluster-storage-usage-history.ts
 models/cluster-tags.ts
@@ -665,6 +666,7 @@ models/postgresql-session.ts
 models/postgresql-space-analysis.ts
 models/postgresql-space-source.ts
 models/postgresql-space-summary.ts
+models/postgresql-storage-instance-usage.ts
 models/postgresql-storage-overview.ts
 models/postgresql-table-space.ts
 models/postgresql-toast-relation-space.ts

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

@@ -138,10 +138,11 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
          * @summary Get PostgreSQL space analysis
          * @param {string} orgName Organization name
          * @param {string} clusterName Cluster name
+         * @param {string} [databaseName] Optional database name for selected table, index, and TOAST details. When omitted, the backend selects the largest connectable non-template database.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getDiagnosticsPostgresqlSpaceAnalysis: async (orgName: string, clusterName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+        getDiagnosticsPostgresqlSpaceAnalysis: async (orgName: string, clusterName: string, databaseName?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
             // verify required parameter 'orgName' is not null or undefined
             assertParamExists('getDiagnosticsPostgresqlSpaceAnalysis', 'orgName', orgName)
             // verify required parameter 'clusterName' is not null or undefined
@@ -167,6 +168,10 @@ export const DiagnosticsApiAxiosParamCreator = function (configuration?: Configu
             // authentication DigestAuth required
             await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
 
+            if (databaseName !== undefined) {
+                localVarQueryParameter['databaseName'] = databaseName;
+            }
+
 
     
             setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -273,11 +278,12 @@ export const DiagnosticsApiFp = function(configuration?: Configuration) {
          * @summary Get PostgreSQL space analysis
          * @param {string} orgName Organization name
          * @param {string} clusterName Cluster name
+         * @param {string} [databaseName] Optional database name for selected table, index, and TOAST details. When omitted, the backend selects the largest connectable non-template database.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async getDiagnosticsPostgresqlSpaceAnalysis(orgName: string, clusterName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSpaceAnalysis>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlSpaceAnalysis(orgName, clusterName, options);
+        async getDiagnosticsPostgresqlSpaceAnalysis(orgName: string, clusterName: string, databaseName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostgresqlSpaceAnalysis>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getDiagnosticsPostgresqlSpaceAnalysis(orgName, clusterName, databaseName, options);
             const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
             const localVarOperationServerBasePath = operationServerMap['DiagnosticsApi.getDiagnosticsPostgresqlSpaceAnalysis']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -335,7 +341,7 @@ export const DiagnosticsApiFactory = function (configuration?: Configuration, ba
          * @throws {RequiredError}
          */
         getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostgresqlSpaceAnalysis> {
-            return localVarFp.getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(axios, basePath));
+            return localVarFp.getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.databaseName, options).then((request) => request(axios, basePath));
         },
         /**
          * List PostgreSQL session basic diagnostics records. The response includes waitEventType and waitEvent so clients can identify lock-waiting sessions without loading lock rows.
@@ -473,6 +479,13 @@ export interface DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest {
      * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysis
      */
     readonly clusterName: string
+
+    /**
+     * Optional database name for selected table, index, and TOAST details. When omitted, the backend selects the largest connectable non-template database.
+     * @type {string}
+     * @memberof DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysis
+     */
+    readonly databaseName?: string
 }
 
 /**
@@ -543,7 +556,7 @@ export class DiagnosticsApi extends BaseAPI implements DiagnosticsApiInterface {
      * @memberof DiagnosticsApi
      */
     public getDiagnosticsPostgresqlSpaceAnalysis(requestParameters: DiagnosticsApiGetDiagnosticsPostgresqlSpaceAnalysisRequest, options?: RawAxiosRequestConfig) {
-        return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, options).then((request) => request(this.axios, this.basePath));
+        return DiagnosticsApiFp(this.configuration).getDiagnosticsPostgresqlSpaceAnalysis(requestParameters.orgName, requestParameters.clusterName, requestParameters.databaseName, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**

package/src/openapi/models/cluster-storage-usage-history-instance.ts

@@ -0,0 +1,63 @@
+/* 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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ClusterStorageUsageHistoryPoint } from './cluster-storage-usage-history-point';
+
+/**
+ * 
+ * @export
+ * @interface ClusterStorageUsageHistoryInstance
+ */
+export interface ClusterStorageUsageHistoryInstance {
+    /**
+     * Kubernetes pod name for this storage usage series.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistoryInstance
+     */
+    'instanceName'?: string;
+    /**
+     * PersistentVolumeClaim name when it can be read from metrics labels.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistoryInstance
+     */
+    'pvcName'?: string;
+    /**
+     * Raw database replica role value read from metrics labels, kept aligned with instance detail display.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistoryInstance
+     */
+    'role'?: string;
+    /**
+     * Optional KubeBlocks component name when it can be read from metrics labels.
+     * @type {string}
+     * @memberof ClusterStorageUsageHistoryInstance
+     */
+    'componentName'?: string;
+    /**
+     * 
+     * @type {Array<ClusterStorageUsageHistoryPoint>}
+     * @memberof ClusterStorageUsageHistoryInstance
+     */
+    'points': Array<ClusterStorageUsageHistoryPoint>;
+    /**
+     * 
+     * @type {string}
+     * @memberof ClusterStorageUsageHistoryInstance
+     */
+    'source'?: string;
+}
+

package/src/openapi/models/cluster-storage-usage-history-point.ts

@@ -38,6 +38,12 @@ export interface ClusterStorageUsageHistoryPoint {
      * @memberof ClusterStorageUsageHistoryPoint
      */
     'totalBytes': number;
+    /**
+     * 
+     * @type {number}
+     * @memberof ClusterStorageUsageHistoryPoint
+     */
+    'availableBytes': number;
     /**
      * 
      * @type {number}