kb-cloud-client-typescript 2.3.27 → 2.3.29

package/src/openapi.yaml

@@ -13887,6 +13887,525 @@ paths:
           $ref: '#/components/responses/404'
         '500':
           $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups:
+    get:
+      tags:
+        - computeGroup
+      operationId: listComputeGroups
+      summary: List compute groups
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/computeGroupList'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+    post:
+      tags:
+        - computeGroup
+      operationId: createComputeGroup
+      summary: Create compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Accepted; poll taskId for convergence.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/computeGroupCreate'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}:
+    get:
+      tags:
+        - computeGroup
+      operationId: getComputeGroup
+      summary: Get compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/computeGroup'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+    delete:
+      tags:
+        - computeGroup
+      operationId: deleteComputeGroup
+      summary: Delete compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Accepted; poll taskId for convergence.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}/scale:
+    post:
+      tags:
+        - computeGroup
+      operationId: scaleComputeGroup
+      summary: Scale compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Accepted; poll taskId for convergence.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/computeGroupScale'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}/start:
+    post:
+      tags:
+        - computeGroup
+      operationId: startComputeGroup
+      summary: Start compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Accepted; poll taskId for convergence.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}/stop:
+    post:
+      tags:
+        - computeGroup
+      operationId: stopComputeGroup
+      summary: Stop compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Accepted; poll taskId for convergence.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/opsRequestName'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}/accounts:
+    get:
+      tags:
+        - computeGroup
+      operationId: listComputeGroupAccounts
+      summary: List compute group accounts
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/computeGroupAccountList'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}/accounts/{accountName}:
+    put:
+      tags:
+        - computeGroup
+      operationId: grantComputeGroupAccount
+      summary: Grant compute group account
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: accountName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Updated
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+    delete:
+      tags:
+        - computeGroup
+      operationId: revokeComputeGroupAccount
+      summary: Revoke compute group account
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: accountName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Updated
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/computeGroups/{groupName}/accounts/{accountName}/default:
+    put:
+      tags:
+        - computeGroup
+      operationId: setDefaultComputeGroup
+      summary: Set default compute group
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Supported engine name (doris or selectdb).
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: groupName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: accountName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Updated
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
   /api/v1/data/kafka/organizations/{orgName}/clusters/{clusterName}/brokers:
     get:
       summary: Get all brokers in cluster
@@ -19575,6 +20094,28 @@ paths:
           $ref: '#/components/responses/401'
         '403':
           $ref: '#/components/responses/403'
+  /api/v1/dashboardConfigs/{key}:
+    get:
+      parameters:
+        - $ref: '#/components/parameters/dashboardConfigKey'
+      tags:
+        - dashboardConfig
+      operationId: getDashboardConfig
+      summary: Get dashboard configuration by key
+      description: Requires authentication. Reads platform-wide configuration; organization identifiers in a key do not restrict access. Missing keys return 200 with a null value.
+      responses:
+        '200':
+          description: Stored configuration or a null value for a missing key.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/dashboardConfig'
+        '400':
+          $ref: '#/components/responses/400'
+        '401':
+          $ref: '#/components/responses/401'
+        '500':
+          $ref: '#/components/responses/500'
   /api/v1/platformParameters:
     get:
       tags:
@@ -21218,7 +21759,8 @@ paths:
       tags:
         - inspection
       operationId: createInspectionTaskByOrg
-      summary: create inspection task by org
+      summary: Trigger inspection for selected clusters in an organization
+      description: Creates one inspection task per matching non-stopped cluster in the path organization. Omit engines or pass an empty array to select all engines. Omit clusterIDs or pass an empty array to select all clusters. When both arrays are non-empty, clusters must match both filters. All tasks and items are persisted in one transaction before asynchronous execution starts.
       parameters:
         - description: name of the Org
           in: path
@@ -21230,12 +21772,14 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/inspectionTask'
+              $ref: '#/components/schemas/inspectionTaskCreate'
         required: true
       responses:
         '204':
-          description: No content.
+          description: Inspection tasks created and accepted for asynchronous execution.
           content: {}
+        '400':
+          description: Invalid request, invalid cluster selection, or no eligible clusters.
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -31332,14 +31876,36 @@ components:
             Object storage serviceRef configs supported by this mode. Use this when different object
             storage engines may require different serviceRef or Helm value mappings. When it is set,
             the cluster create request selects one item by objectStorageConfig.serviceRef.name.
+    envRerender:
+      type: object
+      description: Rule telling whether the env of an existing component is re-rendered when the mode transitions.
+      properties:
+        allEnv:
+          type: boolean
+          description: Re-render the whole env of the component.
+        includeEnvs:
+          type: array
+          description: Re-render only these env vars, when allEnv is not set.
+          items:
+            type: string
     engineModeTransition:
       type: object
       required:
         - mode
       properties:
+        envRerender:
+          $ref: '#/components/schemas/envRerender'
         mode:
           type: string
           description: Target mode name.
+        waitComponentsRunningAfterModeChange:
+          type: array
+          description: |
+            Components that must be running once the mode change is done, in addition to the ones the
+            transition creates. Declare a component here when the transition re-renders it instead of
+            creating it, so it must settle before the transition is considered finished.
+          items:
+            type: string
     modeOption:
       type: object
       required:
@@ -36370,6 +36936,147 @@ components:
       type: array
       items:
         $ref: '#/components/schemas/relatedClusterListItem'
+    computeGroupBackend:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Opaque backend ID; do not convert to a JavaScript number.
+        host:
+          type: string
+        heartbeatPort:
+          type: integer
+          format: int64
+        alive:
+          type: boolean
+        decommissioned:
+          type: boolean
+        tabletCount:
+          type: integer
+          format: int64
+        lastHeartbeat:
+          type: string
+        version:
+          type: string
+        errorMessage:
+          type: string
+    computeGroup:
+      type: object
+      properties:
+        name:
+          type: string
+        componentName:
+          type: string
+        managed:
+          type: boolean
+        isDefault:
+          type: boolean
+        phase:
+          type: string
+          description: Kubernetes component phase, independent of engine membership.
+        stopped:
+          type: boolean
+        replicas:
+          type: integer
+          format: int64
+        classCode:
+          type: string
+        cpu:
+          type: number
+        memory:
+          type: number
+        backendCount:
+          type: integer
+          format: int64
+        aliveBackendCount:
+          type: integer
+          format: int64
+        defaultUsers:
+          type: array
+          items:
+            type: string
+        backends:
+          type: array
+          items:
+            $ref: '#/components/schemas/computeGroupBackend'
+        allowedActions:
+          type: array
+          items:
+            type: string
+    computeGroupList:
+      type: object
+      required:
+        - items
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/computeGroup'
+        managementSupported:
+          type: boolean
+        unsupportedReason:
+          type: string
+    computeGroupCreate:
+      type: object
+      required:
+        - name
+        - replicas
+        - classCode
+      properties:
+        name:
+          type: string
+          pattern: ^[A-Za-z][A-Za-z0-9_]{0,63}$
+        replicas:
+          type: integer
+          format: int64
+          minimum: 1
+          maximum: 1000
+        classCode:
+          type: string
+          minLength: 1
+          maxLength: 128
+      additionalProperties: false
+    computeGroupScale:
+      type: object
+      properties:
+        replicas:
+          x-nullable: true
+          type: integer
+          format: int64
+          minimum: 1
+          maximum: 1000
+        classCode:
+          type: string
+          minLength: 1
+          maxLength: 128
+      additionalProperties: false
+    computeGroupAccount:
+      type: object
+      properties:
+        identity:
+          type: string
+        accountName:
+          type: string
+        manageable:
+          type: boolean
+        globalGrants:
+          type: string
+        computeGrants:
+          type: string
+        roles:
+          type: string
+        isDefault:
+          type: boolean
+      description: Grants reported by the engine can include role inheritance. Revoking a direct grant does not remove inherited permissions.
+    computeGroupAccountList:
+      type: object
+      required:
+        - items
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/computeGroupAccount'
     Broker:
       x-go-name: KafkaBroker
       type: object
@@ -38446,6 +39153,19 @@ components:
       required:
         - items
       type: object
+    dashboardConfig:
+      type: object
+      required:
+        - key
+      properties:
+        key:
+          type: string
+          description: Frontend-defined platform-wide key. Organization identifiers in this key do not enforce tenant isolation.
+          minLength: 1
+          maxLength: 512
+        value:
+          description: Stored JSON value, or null when the key has no configuration.
+          x-omitempty: false
     platformParameterCategory:
       type: string
       description: platformParameter category, representing the platformParameter group
@@ -40004,6 +40724,35 @@ components:
         timeRangeEnd:
           format: date-time
           type: string
+    inspectionTaskCreate:
+      type: object
+      properties:
+        engines:
+          description: Engine names to inspect in the path organization. Omit or pass an empty array to inspect all engines.
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            pattern: ^[^,\s]+$
+        clusterIDs:
+          description: Cluster IDs to inspect in the path organization. Omit or pass an empty array to inspect all clusters selected by engines.
+          type: array
+          uniqueItems: true
+          items:
+            type: string
+            pattern: ^[1-9][0-9]*$
+        timeRangeStart:
+          type: string
+          format: date-time
+          description: Start of the inspection window. If either bound is omitted, defaults to the preceding 24 hours.
+        timeRangeEnd:
+          type: string
+          format: date-time
+        savedDays:
+          type: integer
+          format: int64
+          minimum: 0
+          description: Report retention in days. Zero uses the existing default retention policy.
     inspectionTaskFormat:
       description: Specifies the format of the task in the aggregate task result.
       enum:
@@ -40408,6 +41157,15 @@ components:
       name: query
       schema:
         type: string
+    dashboardConfigKey:
+      in: path
+      name: key
+      required: true
+      description: Frontend-defined non-blank configuration key, up to 512 Unicode characters. URL-encode the key when used in a request path.
+      schema:
+        type: string
+        minLength: 1
+        maxLength: 512
 x-tagGroups:
   - name: User
     tags: