kb-cloud-client-typescript 2.3.0-alpha.121 → 2.3.0-alpha.123

package/src/openapi.yaml

@@ -4857,6 +4857,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
@@ -4870,6 +4876,8 @@ paths:
           $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}/diagnostics/postgresql/sessions/{pid}/lockAnalysis:
@@ -13963,6 +13971,257 @@ paths:
         - account
         - rdbms
         - shared
+  /api/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
+  /api/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
   /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/sessions:
     get:
       description: list sessions in cluster
@@ -21767,32 +22026,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:
@@ -21923,6 +22206,7 @@ components:
         - summary
         - storageOverview
         - databases
+        - selectedDatabase
         - tables
         - indexes
         - toastRelations
@@ -21935,18 +22219,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:
@@ -22132,6 +22423,7 @@ components:
         - timestamp
         - usedBytes
         - totalBytes
+        - availableBytes
         - usageRatio
       properties:
         timestamp:
@@ -22142,17 +22434,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:
@@ -22165,10 +22483,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.
@@ -24420,6 +24738,9 @@ components:
         supportLock:
           type: boolean
           description: Whether the engine supports account lock and unlock actions.
+        supportServiceAccount:
+          type: boolean
+          description: Whether the engine supports service account access-key management.
         protectedAccounts:
           type: array
           description: Account names that are protected from update, delete, lock, and unlock actions.
@@ -29311,6 +29632,85 @@ components:
       required:
         - name
       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.
     dbTDERequest:
       type: object
       properties: