kb-cloud-client-typescript 2.4.0-alpha.64 → 2.4.0-alpha.66

package/src/openapi.yaml

@@ -114,6 +114,402 @@ tags:
   - name: blueGreenDeployment
     description: Blue Green Deployment APIs
 paths:
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/config:
+    get:
+      operationId: getClusterJarConfig
+      summary: Get external JAR capability and configuration
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterJarConfig'
+        '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}/jars:
+    get:
+      operationId: listClusterJars
+      summary: List external JAR versions with metadata and per-instance synchronization state
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterJarList'
+        '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:
+      operationId: uploadClusterJar
+      summary: Upload an immutable JAR version
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: Idempotency-Key
+          in: header
+          required: true
+          schema:
+            type: string
+            minLength: 1
+            maxLength: 128
+      responses:
+        '201':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterJarPackage'
+        '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'
+        '413':
+          $ref: '#/components/responses/413'
+        '500':
+          $ref: '#/components/responses/500'
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              properties:
+                name:
+                  type: string
+                  minLength: 1
+                  maxLength: 128
+                kind:
+                  $ref: '#/components/schemas/clusterJarKind'
+                file:
+                  type: string
+                  format: binary
+              required:
+                - name
+                - kind
+                - file
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}:
+    delete:
+      operationId: deleteClusterJar
+      summary: Delete an unpublished JAR version
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: jarId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Success
+        '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}/jars/{jarId}/download:
+    get:
+      operationId: downloadClusterJar
+      summary: Download the original JAR
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: jarId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Success
+          content:
+            application/java-archive:
+              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'
+        '409':
+          $ref: '#/components/responses/409'
+        '500':
+          $ref: '#/components/responses/500'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/distribute:
+    post:
+      operationId: distributeClusterJar
+      summary: Publish a JAR with optimistic manifest version checking
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: jarId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterJarTask'
+        '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/clusterJarPublish'
+  /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/jars/{jarId}/retry:
+    post:
+      operationId: retryClusterJar
+      summary: Retry synchronization of published JARs
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: jarId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '202':
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/clusterJarTask'
+        '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}/jars/{jarId}/archive:
+    post:
+      operationId: archiveClusterJar
+      summary: Archive a JAR while retaining published files and startup synchronization
+      tags:
+        - clusterJar
+        - shared
+      parameters:
+        - name: engineName
+          in: path
+          required: true
+          description: Doris or SelectDB engine of the target cluster.
+          schema:
+            type: string
+        - name: orgName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: clusterName
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: jarId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Success
+        '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/user:
     get:
       description: Get authenticated login user info
@@ -17989,7 +18385,7 @@ paths:
                 $ref: '#/components/schemas/accountList'
           description: Success
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -17997,9 +18393,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -18036,7 +18432,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/account'
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -18044,9 +18440,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -18081,7 +18477,7 @@ paths:
           content: {}
           description: Identity deleted
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -18089,9 +18485,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -18133,7 +18529,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/account'
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -18141,9 +18537,9 @@ paths:
         '404':
           $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       tags:
         - account
         - seaweedfs
@@ -18232,7 +18628,7 @@ paths:
         required: true
       responses:
         '400':
-          description: SeaweedFS uses the named policy binding API
+          $ref: '#/components/responses/400'
       tags:
         - account
         - seaweedfs
@@ -18281,17 +18677,17 @@ paths:
                           type: object
                           additionalProperties: true
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
   /api/v1/data/seaweedfs/organizations/{orgName}/clusters/{clusterName}/policies/{policyName}:
     put:
       summary: putSeaweedFSPolicy
@@ -18320,17 +18716,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       requestBody:
         required: true
         content:
@@ -18366,17 +18762,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       description: Deletes an unused named policy. Attached policies are rejected; no identities or groups are implicitly changed.
   /api/v1/data/seaweedfs/organizations/{orgName}/clusters/{clusterName}/accounts/{accountName}/policies:
     put:
@@ -18406,17 +18802,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       requestBody:
         required: true
         content:
@@ -18463,17 +18859,17 @@ paths:
               schema:
                 $ref: '#/components/schemas/account'
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
       requestBody:
         required: true
         content:
@@ -18514,17 +18910,17 @@ paths:
         '204':
           description: Successful response
         '400':
-          description: Invalid request
+          $ref: '#/components/responses/400'
         '401':
-          description: Unauthenticated
+          $ref: '#/components/responses/401'
         '403':
-          description: Permission denied or protected identity
+          $ref: '#/components/responses/403'
         '404':
-          description: Resource not found
+          $ref: '#/components/responses/404'
         '409':
-          description: Resource conflict or policy in use
+          $ref: '#/components/responses/409'
         '503':
-          description: IAM unavailable; mutation outcome may be unknown
+          $ref: '#/components/responses/503'
   /api/v1/data/{engineName}/organizations/{orgName}/clusters/{clusterName}/accounts:
     get:
       description: list accounts in cluster
@@ -22535,7 +22931,7 @@ paths:
           description: Inspection tasks created and accepted for asynchronous execution.
           content: {}
         '400':
-          description: Invalid request, invalid cluster selection, or no eligible clusters.
+          $ref: '#/components/responses/400'
         '401':
           $ref: '#/components/responses/401'
         '403':
@@ -23013,6 +23409,160 @@ components:
         curl --digest -u "accessKey:secretKey" https://api.example.com/api/v1/user
         ```
   schemas:
+    clusterJarConfig:
+      type: object
+      properties:
+        supported:
+          type: boolean
+        reason:
+          type: string
+        generation:
+          type: integer
+          format: int64
+        maxFileBytes:
+          type: integer
+          format: int64
+        maxTotalBytes:
+          type: integer
+          format: int64
+        usedBytes:
+          type: integer
+          format: int64
+        taskId:
+          type: string
+      required:
+        - supported
+        - generation
+        - maxFileBytes
+        - maxTotalBytes
+        - usedBytes
+    APIErrorResponse:
+      description: API error response.
+      properties:
+        code:
+          description: The HTTP status code.
+          type: integer
+        reason:
+          description: The reason for the error.
+          type: string
+        message:
+          description: The message for the error.
+          type: string
+      required:
+        - code
+      type: object
+    clusterJarKind:
+      type: string
+      enum:
+        - udf
+        - jdbc
+    clusterJarReplica:
+      type: object
+      properties:
+        component:
+          type: string
+        podName:
+          type: string
+        podUID:
+          type: string
+        status:
+          type: string
+        error:
+          type: string
+        generation:
+          type: integer
+          format: int64
+        updatedAt:
+          type: string
+          format: date-time
+      required:
+        - component
+        - podName
+        - podUID
+        - status
+        - generation
+    clusterJarPackage:
+      type: object
+      properties:
+        id:
+          type: string
+        name:
+          type: string
+        kind:
+          $ref: '#/components/schemas/clusterJarKind'
+        filename:
+          type: string
+        sha256:
+          type: string
+        size:
+          type: integer
+          format: int64
+        uri:
+          type: string
+        published:
+          type: boolean
+        archived:
+          type: boolean
+        status:
+          type: string
+        synced:
+          type: integer
+          format: int64
+        total:
+          type: integer
+          format: int64
+        createdBy:
+          type: string
+        createdAt:
+          type: string
+          format: date-time
+        instances:
+          type: array
+          items:
+            $ref: '#/components/schemas/clusterJarReplica'
+      required:
+        - id
+        - name
+        - kind
+        - filename
+        - sha256
+        - size
+        - uri
+        - published
+        - archived
+        - status
+        - synced
+        - total
+        - createdBy
+        - createdAt
+        - instances
+    clusterJarList:
+      type: object
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/clusterJarPackage'
+        generation:
+          type: integer
+          format: int64
+      required:
+        - items
+        - generation
+    clusterJarPublish:
+      type: object
+      properties:
+        generation:
+          type: integer
+          format: int64
+          minimum: 0
+      required:
+        - generation
+    clusterJarTask:
+      type: object
+      properties:
+        taskId:
+          type: string
     phoneNumber:
       description: The phonenumber for the user.
       example: '+8618912345678'
@@ -23053,21 +23603,6 @@ components:
         - userName
         - createdAt
         - updatedAt
-    APIErrorResponse:
-      description: API error response.
-      properties:
-        code:
-          description: The HTTP status code.
-          type: integer
-        reason:
-          description: The reason for the error.
-          type: string
-        message:
-          description: The message for the error.
-          type: string
-      required:
-        - code
-      type: object
     userUpdate:
       description: User update
       properties:
@@ -41903,6 +42438,12 @@ components:
           schema:
             $ref: '#/components/schemas/APIErrorResponse'
       description: Conflict
+    '413':
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/APIErrorResponse'
+      description: Payload Too Large
     '429':
       content:
         application/json: