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

package/src/adminapi/models/dms-service-account-create-request.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * MinIO service account access-key create request
+ * @export
+ * @interface DmsServiceAccountCreateRequest
+ */
+export interface DmsServiceAccountCreateRequest {
+    /**
+     * MinIO user that owns the service account.
+     * @type {string}
+     * @memberof DmsServiceAccountCreateRequest
+     */
+    'userName': string;
+    /**
+     * Optional fixed access key. If omitted, MinIO generates it.
+     * @type {string}
+     * @memberof DmsServiceAccountCreateRequest
+     */
+    'accessKey'?: string;
+    /**
+     * Optional fixed secret key. If omitted, MinIO generates it.
+     * @type {string}
+     * @memberof DmsServiceAccountCreateRequest
+     */
+    'secretKey'?: string;
+    /**
+     * Display name of the service account.
+     * @type {string}
+     * @memberof DmsServiceAccountCreateRequest
+     */
+    'name'?: string;
+    /**
+     * Description of the service account.
+     * @type {string}
+     * @memberof DmsServiceAccountCreateRequest
+     */
+    'description'?: string;
+    /**
+     * Optional service account expiration time.
+     * @type {string}
+     * @memberof DmsServiceAccountCreateRequest
+     */
+    'expiration'?: string;
+}
+

package/src/adminapi/models/dms-service-account-status.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * MinIO service account status.
+ * @export
+ * @enum {string}
+ */
+
+export const DmsServiceAccountStatus = {
+    enabled: 'enabled',
+    disabled: 'disabled'
+} as const;
+
+export type DmsServiceAccountStatus = typeof DmsServiceAccountStatus[keyof typeof DmsServiceAccountStatus];
+
+
+

package/src/adminapi/models/dms-service-account-update-request.ts

@@ -0,0 +1,41 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 { DmsServiceAccountStatus } from './dms-service-account-status';
+
+/**
+ * MinIO service account access-key update request
+ * @export
+ * @interface DmsServiceAccountUpdateRequest
+ */
+export interface DmsServiceAccountUpdateRequest {
+    /**
+     * 
+     * @type {DmsServiceAccountStatus}
+     * @memberof DmsServiceAccountUpdateRequest
+     */
+    'status'?: DmsServiceAccountStatus;
+    /**
+     * Optional service account expiration time. Use the Unix epoch to clear expiration.
+     * @type {string}
+     * @memberof DmsServiceAccountUpdateRequest
+     */
+    'expiration'?: string;
+}
+
+
+

package/src/adminapi/models/dms-service-account.ts

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * MinIO service account access-key
+ * @export
+ * @interface DmsServiceAccount
+ */
+export interface DmsServiceAccount {
+    /**
+     * MinIO user that owns the service account.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'userName'?: string;
+    /**
+     * Service account access key.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'accessKey'?: string;
+    /**
+     * Secret key returned only by create.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'secretKey'?: string;
+    /**
+     * Service account status.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'status'?: string;
+    /**
+     * Display name of the service account.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'name'?: string;
+    /**
+     * Description of the service account.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'description'?: string;
+    /**
+     * Service account expiration time.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'expiration'?: string;
+    /**
+     * Service account policy text.
+     * @type {string}
+     * @memberof DmsServiceAccount
+     */
+    'policy'?: string;
+    /**
+     * Whether the policy is implied from the parent user.
+     * @type {boolean}
+     * @memberof DmsServiceAccount
+     */
+    'impliedPolicy'?: boolean;
+}
+

package/src/adminapi/models/index.ts

@@ -275,6 +275,10 @@ export * from './dms-query-request';
 export * from './dms-query-response';
 export * from './dms-result';
 export * from './dms-result-stats';
+export * from './dms-service-account';
+export * from './dms-service-account-create-request';
+export * from './dms-service-account-status';
+export * from './dms-service-account-update-request';
 export * from './dms-session';
 export * from './dms-table-column';
 export * from './dms-table-column-generated';

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
@@ -35719,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: