kb-cloud-client-typescript 2.3.0-alpha.215 → 2.3.0-alpha.216

package/src/adminapi/models/disaster-recovery-history-item.ts

@@ -0,0 +1,116 @@
+/* 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 { DisasterRecoveryEventType } from './disaster-recovery-event-type';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { DisasterRecoveryStatus } from './disaster-recovery-status';
+
+/**
+ * DisasterRecovery history detail for Cluster
+ * @export
+ * @interface DisasterRecoveryHistoryItem
+ */
+export interface DisasterRecoveryHistoryItem {
+    /**
+     * the ID of disaster recovery task in TaskFlow
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'taskID'?: string | null;
+    /**
+     * the ID of parent cluster
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'parentClusterID'?: string | null;
+    /**
+     * the Name of parent cluster
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'parentClusterName'?: string | null;
+    /**
+     * parent env name
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'parentEnvName'?: string | null;
+    /**
+     * the ID of promote cluster
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'clusterID'?: string | null;
+    /**
+     * the Name of promote cluster
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'clusterName'?: string | null;
+    /**
+     * env name
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'envName'?: string | null;
+    /**
+     * 
+     * @type {DisasterRecoveryEventType}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'eventType'?: DisasterRecoveryEventType | null;
+    /**
+     * the reason of promote
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'reason'?: string | null;
+    /**
+     * the operator name
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'operator'?: string;
+    /**
+     * the user ID of the operator
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'operatorId'?: string;
+    /**
+     * the create time of promote event
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'createdAt'?: string;
+    /**
+     * the update time of promote event
+     * @type {string}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'updateAt'?: string;
+    /**
+     * 
+     * @type {DisasterRecoveryStatus}
+     * @memberof DisasterRecoveryHistoryItem
+     */
+    'status'?: DisasterRecoveryStatus | null;
+}
+
+
+

package/src/adminapi/models/disaster-recovery-history.ts

@@ -0,0 +1,33 @@
+/* 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 { DisasterRecoveryHistoryItem } from './disaster-recovery-history-item';
+
+/**
+ * DisasterRecovery history for Cluster
+ * @export
+ * @interface DisasterRecoveryHistory
+ */
+export interface DisasterRecoveryHistory {
+    /**
+     * Items is the list of DisasterRecovery logs
+     * @type {Array<DisasterRecoveryHistoryItem>}
+     * @memberof DisasterRecoveryHistory
+     */
+    'items': Array<DisasterRecoveryHistoryItem>;
+}
+

package/src/adminapi/models/disaster-recovery-promote.ts

@@ -0,0 +1,36 @@
+/* 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.
+ */
+
+
+
+/**
+ * the Promote object for disasterRecovery instance
+ * @export
+ * @interface DisasterRecoveryPromote
+ */
+export interface DisasterRecoveryPromote {
+    /**
+     * the mode of cluster after promotion. default is the primary cluster\'s mode
+     * @type {string}
+     * @memberof DisasterRecoveryPromote
+     */
+    'mode'?: string | null;
+    /**
+     * the reason for promoting
+     * @type {string}
+     * @memberof DisasterRecoveryPromote
+     */
+    'reason'?: string;
+}
+

package/src/adminapi/models/disaster-recovery-status-response.ts

@@ -0,0 +1,84 @@
+/* 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.
+ */
+
+
+
+/**
+ * Status of the Disaster Recovery instance
+ * @export
+ * @interface DisasterRecoveryStatusResponse
+ */
+export interface DisasterRecoveryStatusResponse {
+    /**
+     * Unique identifier for the cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'clusterId': string;
+    /**
+     * Name of the cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'clusterName'?: string | null;
+    /**
+     * User-friendly name of the cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'displayName'?: string | null;
+    /**
+     * Current operational status of the cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'status'?: string | null;
+    /**
+     * ID of the parent cluster, if applicable; can be empty if there is no parent relationship
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'parentId': string;
+    /**
+     * Name of the parent cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'parentName'?: string | null;
+    /**
+     * User-friendly name of the parent cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'parentDisplayName'?: string | null;
+    /**
+     * Current operational status of the parent cluster
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'parentStatus'?: string | null;
+    /**
+     * Delay time in seconds
+     * @type {number}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'delay'?: number | null;
+    /**
+     * Current replication point for the disaster recovery instance
+     * @type {string}
+     * @memberof DisasterRecoveryStatusResponse
+     */
+    'currentReplicationPoint'?: string | null;
+}
+

package/src/adminapi/models/disaster-recovery-status.ts

@@ -0,0 +1,34 @@
+/* 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.
+ */
+
+
+
+/**
+ * the status of promote event, support values: [Pending, Succeed, Failed, Running, Unknown]
+ * @export
+ * @enum {string}
+ */
+
+export const DisasterRecoveryStatus = {
+    Pending: 'Pending',
+    Succeed: 'Succeed',
+    Failed: 'Failed',
+    Running: 'Running',
+    Unknown: 'Unknown'
+} as const;
+
+export type DisasterRecoveryStatus = typeof DisasterRecoveryStatus[keyof typeof DisasterRecoveryStatus];
+
+
+

package/src/adminapi/models/index.ts

@@ -269,8 +269,14 @@ export * from './delete-storage-class204-response';
 export * from './disaster-recovery-cluster-item';
 export * from './disaster-recovery-cluster-list';
 export * from './disaster-recovery-create';
+export * from './disaster-recovery-event-type';
+export * from './disaster-recovery-history';
+export * from './disaster-recovery-history-item';
 export * from './disaster-recovery-option';
+export * from './disaster-recovery-promote';
 export * from './disaster-recovery-settings';
+export * from './disaster-recovery-status';
+export * from './disaster-recovery-status-response';
 export * from './disaster-recovery-task';
 export * from './dm-file';
 export * from './dm-tablespace';

package/src/adminapi.yaml

@@ -73,6 +73,8 @@ tags:
     description: Chat With AI Agent APIs
   - name: diagnostics
     description: Diagnostics APIs
+  - name: disasterRecovery
+    description: Cluster Disaster Recovery APIs
 paths:
   /admin/v1/user:
     get:
@@ -3778,6 +3780,43 @@ paths:
         - cluster
         - shared
       x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/disasterRecovery:
+    delete:
+      operationId: deleteDisasterRecovery
+      summary: Delete a disaster recovery instance
+      description: Delete a specific disaster recovery instance
+      parameters:
+        - description: name of the org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+        - description: The ID of the disaster recovery logical instance
+          in: query
+          name: logicalInstanceID
+          schema:
+            type: string
+        - description: The ID of the disaster recovery cluster
+          in: query
+          name: clusterID
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/disasterRecoveryTask'
+          description: Disaster recovery instance async job task information.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - disasterRecovery
   /admin/v1/organizations/{orgName}/parent/{parentClusterID}/disasterRecovery:
     get:
       operationId: listDisasterRecovery
@@ -3850,6 +3889,112 @@ paths:
       tags:
         - disasterRecovery
       x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/disasterRecovery/{clusterID}/promote:
+    post:
+      operationId: promoteDisasterRecovery
+      summary: Promote a disaster recovery instance to the main instance
+      description: Promote the disaster recovery instance to the primary database instance.
+      parameters:
+        - description: The ID of the disaster recovery instance
+          in: path
+          name: clusterID
+          required: true
+          schema:
+            type: string
+        - description: name of the org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/disasterRecoveryPromote'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/disasterRecoveryTask'
+          description: Disaster recovery instance async job task information.
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - disasterRecovery
+      x-codegen-request-body-name: body
+  /admin/v1/organizations/{orgName}/disasterRecovery/{clusterID}/switchHistory:
+    get:
+      operationId: getDisasterRecoveryHistory
+      summary: Get switch history of a disaster recovery instance
+      description: Retrieve the history of failover and failback operations for a specific disaster recovery instance.
+      parameters:
+        - description: The ID of the disaster recovery instance
+          in: path
+          name: clusterID
+          required: true
+          schema:
+            type: string
+        - description: name of the org
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/disasterRecoveryHistory'
+          description: Switch history retrieved successfully
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - disasterRecovery
+  /admin/v1/organizations/{orgName}/disasterRecovery/{clusterID}/status:
+    get:
+      operationId: getDisasterRecoveryStatus
+      summary: Retrieve Disaster Recovery Instance Status
+      description: Get detailed information about the status of a specific disaster recovery instance, including delay and current replication point.
+      parameters:
+        - description: Unique identifier of the disaster recovery instance
+          in: path
+          name: clusterID
+          required: true
+          schema:
+            type: string
+        - description: Name of the organization
+          in: path
+          name: orgName
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/disasterRecoveryStatusResponse'
+          description: Status query successfully
+        '401':
+          $ref: '#/components/responses/401'
+        '403':
+          $ref: '#/components/responses/403'
+        '404':
+          $ref: '#/components/responses/404'
+      tags:
+        - disasterRecovery
   /admin/v1/eventfilter/{filterType}:
     get:
       description: Query available filters for event listing
@@ -26935,6 +27080,24 @@ components:
       required:
         - taskId
       type: object
+    disasterRecoveryTask:
+      description: Task information of disasterRecovery job
+      properties:
+        logicalInstanceID:
+          description: Logical instance ID
+          type: string
+          nullable: true
+        taskId:
+          description: Task ID
+          type: string
+          nullable: true
+        clusterTaskId:
+          description: Cluster task ID
+          type: string
+          nullable: true
+      required:
+        - taskId
+      type: object
     taskSummary:
       type: object
       properties:
@@ -26982,23 +27145,156 @@ components:
       required:
         - cluster
       type: object
-    disasterRecoveryTask:
-      description: Task information of disasterRecovery job
+    disasterRecoveryPromote:
+      description: the Promote object for disasterRecovery instance
       properties:
-        logicalInstanceID:
-          description: Logical instance ID
+        mode:
+          description: the mode of cluster after promotion. default is the primary cluster's mode
           type: string
           nullable: true
-        taskId:
-          description: Task ID
+        reason:
+          description: the reason for promoting
+          type: string
+      type: object
+    disasterRecoveryEventType:
+      description: 'the event type of disasterRecovery history, support values: [CreateInstance, DeleteInstance, Promote]'
+      enum:
+        - CreateInstance
+        - DeleteInstance
+        - Promote
+      type: string
+      nullable: true
+    disasterRecoveryStatus:
+      default: Pending
+      description: 'the status of promote event, support values: [Pending, Succeed, Failed, Running, Unknown]'
+      enum:
+        - Pending
+        - Succeed
+        - Failed
+        - Running
+        - Unknown
+      type: string
+      nullable: true
+    disasterRecoveryHistoryItem:
+      description: DisasterRecovery history detail for Cluster
+      properties:
+        taskID:
+          description: the ID of disaster recovery task in TaskFlow
           type: string
           nullable: true
-        clusterTaskId:
-          description: Cluster task ID
+        parentClusterID:
+          description: the ID of parent cluster
+          type: string
+          nullable: true
+        parentClusterName:
+          description: the Name of parent cluster
+          type: string
+          nullable: true
+        parentEnvName:
+          description: parent env name
+          type: string
+          nullable: true
+        clusterID:
+          description: the ID of promote cluster
+          type: string
+          nullable: true
+        clusterName:
+          description: the Name of promote cluster
+          type: string
+          nullable: true
+        envName:
+          description: env name
           type: string
           nullable: true
+        eventType:
+          $ref: '#/components/schemas/disasterRecoveryEventType'
+        reason:
+          description: the reason of promote
+          type: string
+          nullable: true
+        operator:
+          description: the operator name
+          type: string
+        operatorId:
+          description: the user ID of the operator
+          type: string
+        createdAt:
+          description: the create time of promote event
+          type: string
+          format: date-time
+        updateAt:
+          description: the update time of promote event
+          type: string
+          format: date-time
+        status:
+          $ref: '#/components/schemas/disasterRecoveryStatus'
+      type: object
+    disasterRecoveryHistory:
+      description: DisasterRecovery history for Cluster
+      properties:
+        items:
+          description: Items is the list of DisasterRecovery logs
+          items:
+            $ref: '#/components/schemas/disasterRecoveryHistoryItem'
+          type: array
       required:
-        - taskId
+        - items
+      type: object
+    disasterRecoveryStatusResponse:
+      description: Status of the Disaster Recovery instance
+      properties:
+        clusterId:
+          title: Cluster ID
+          type: string
+          description: Unique identifier for the cluster
+        clusterName:
+          title: Cluster Name
+          type: string
+          nullable: true
+          description: Name of the cluster
+        displayName:
+          title: Display Name
+          type: string
+          nullable: true
+          description: User-friendly name of the cluster
+        status:
+          title: Status
+          type: string
+          nullable: true
+          description: Current operational status of the cluster
+        parentId:
+          title: Parent Cluster ID
+          type: string
+          description: ID of the parent cluster, if applicable; can be empty if there is no parent relationship
+        parentName:
+          title: Parent Cluster Name
+          type: string
+          nullable: true
+          description: Name of the parent cluster
+        parentDisplayName:
+          title: Parent Cluster Display Name
+          type: string
+          nullable: true
+          description: User-friendly name of the parent cluster
+        parentStatus:
+          title: Parent Cluster Status
+          type: string
+          nullable: true
+          description: Current operational status of the parent cluster
+        delay:
+          title: Delay
+          type: number
+          format: double
+          nullable: true
+          description: Delay time in seconds
+        currentReplicationPoint:
+          title: Current Replication Point
+          type: string
+          nullable: true
+          description: Current replication point for the disaster recovery instance
+      required:
+        - clusterId
+        - parentId
       type: object
     eventFilterType:
       description: Console do not support orgName.
@@ -43101,3 +43397,6 @@ x-tagGroups:
   - name: import
     tags:
       - import
+  - name: disasterRecovery
+    tags:
+      - disasterRecovery