@alicloud/dds20151201 8.0.0 → 8.1.0

package/src/models/DescribeBackupTasksRequest.ts

@@ -0,0 +1,63 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeBackupTasksRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the backup task.
+   * 
+   * >  If you call the [CreateBackup](https://help.aliyun.com/document_detail/468439.html) operation to perform a manual backup task, you can set this parameter to the returned backup ID to query the backup progress of the task.
+   * 
+   * @example
+   * 170034
+   */
+  backupJobId?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * dds-2zeb2d64cb46xxxx
+   */
+  DBInstanceId?: string;
+  ownerAccount?: string;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  securityToken?: string;
+  static names(): { [key: string]: string } {
+    return {
+      backupJobId: 'BackupJobId',
+      DBInstanceId: 'DBInstanceId',
+      ownerAccount: 'OwnerAccount',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      securityToken: 'SecurityToken',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backupJobId: 'string',
+      DBInstanceId: 'string',
+      ownerAccount: 'string',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      securityToken: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeBackupTasksResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeBackupTasksResponseBody } from "./DescribeBackupTasksResponseBody";
+
+
+export class DescribeBackupTasksResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeBackupTasksResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeBackupTasksResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeBackupTasksResponseBody.ts

@@ -0,0 +1,122 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
+  /**
+   * @remarks
+   * The backup task status. Valid values:
+   * 
+   * *   **Scheduled**: The backup task is in planning. Regular backup tasks that have not started are also in this state.
+   * *   **Checking**: The instance is being checked before the backup.
+   * *   **Backuping**: The backup task is in progress.
+   * *   **Finished**: The backup task is completed.
+   * 
+   * @example
+   * Scheduled
+   */
+  backupSetStatus?: string;
+  /**
+   * @remarks
+   * The start time of the backup task.
+   * 
+   * @example
+   * 2024-01-16T11:04:56Z
+   */
+  backupStartTime?: string;
+  /**
+   * @remarks
+   * The ID of the backup task.
+   * 
+   * @example
+   * 170034
+   */
+  backupjobId?: string;
+  /**
+   * @remarks
+   * The backup mode. Valid values:
+   * 
+   * *   **Automated**: automatic backup
+   * *   **Manual**: manual backup
+   * 
+   * @example
+   * Manual
+   */
+  jobMode?: string;
+  /**
+   * @remarks
+   * The progress of the backup task. Unit: %. The progress is returned only for running backup tasks.
+   * 
+   * @example
+   * 18%
+   */
+  progress?: string;
+  static names(): { [key: string]: string } {
+    return {
+      backupSetStatus: 'BackupSetStatus',
+      backupStartTime: 'BackupStartTime',
+      backupjobId: 'BackupjobId',
+      jobMode: 'JobMode',
+      progress: 'Progress',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backupSetStatus: 'string',
+      backupStartTime: 'string',
+      backupjobId: 'string',
+      jobMode: 'string',
+      progress: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeBackupTasksResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the backup task.
+   */
+  backupJobs?: DescribeBackupTasksResponseBodyBackupJobs[];
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * D648B367-15B6-1B42-BD4B-47507C9CC****
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      backupJobs: 'BackupJobs',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backupJobs: { 'type': 'array', 'itemType': DescribeBackupTasksResponseBodyBackupJobs },
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.backupJobs)) {
+      $dara.Model.validateArray(this.backupJobs);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeBackupsRequest.ts

@@ -0,0 +1,143 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeBackupsRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the backup set. You can call the [CreateBackup](https://help.aliyun.com/document_detail/62171.html) operation to query the backup set ID.
+   * 
+   * If you set the **DBInstanceId** parameter to the ID of a sharded cluster instance, the number of backup IDs is the same as the number of shard nodes. Multiple backup IDs are separated with commas (,).
+   * 
+   * @example
+   * 2072****,2072****,2072****
+   */
+  backupId?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * > If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * dds-bp1a7009eb24****
+   */
+  DBInstanceId?: string;
+  /**
+   * @remarks
+   * The region ID of the Cross-regional backup.
+   * 
+   * >  This parameter is required for the Cross-regional backup.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  destRegion?: string;
+  /**
+   * @remarks
+   * The end of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC. The end time must be later than the start time.
+   * 
+   * @example
+   * 2022-01-14T13:00Z
+   */
+  endTime?: string;
+  /**
+   * @remarks
+   * The ID of the shard node in the sharded cluster instance.
+   * 
+   * > This parameter takes effect only when you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.
+   * 
+   * @example
+   * d-bp128a003436****
+   */
+  nodeId?: string;
+  ownerAccount?: string;
+  ownerId?: number;
+  /**
+   * @remarks
+   * The page number. Pages start from page 1. Default value: **1**.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries to return per page. Valid values:
+   * 
+   * *   **30** (default)
+   * *   **50**
+   * *   **100**
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The region ID of the instance.
+   * 
+   * >- This parameter is required if you want to query the backup sets of a released instance.
+   * >-  This parameter is required if you want to query cross-region backups.
+   * 
+   * @example
+   * cn-beijing
+   */
+  srcRegion?: string;
+  /**
+   * @remarks
+   * The beginning of the time range to query. Specify the time in the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.
+   * 
+   * @example
+   * 2022-01-13T13:00Z
+   */
+  startTime?: string;
+  static names(): { [key: string]: string } {
+    return {
+      backupId: 'BackupId',
+      DBInstanceId: 'DBInstanceId',
+      destRegion: 'DestRegion',
+      endTime: 'EndTime',
+      nodeId: 'NodeId',
+      ownerAccount: 'OwnerAccount',
+      ownerId: 'OwnerId',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      srcRegion: 'SrcRegion',
+      startTime: 'StartTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backupId: 'string',
+      DBInstanceId: 'string',
+      destRegion: 'string',
+      endTime: 'string',
+      nodeId: 'string',
+      ownerAccount: 'string',
+      ownerId: 'number',
+      pageNumber: 'number',
+      pageSize: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      srcRegion: 'string',
+      startTime: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeBackupsResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeBackupsResponseBody } from "./DescribeBackupsResponseBody";
+
+
+export class DescribeBackupsResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeBackupsResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeBackupsResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeBackupsResponseBody.ts

@@ -0,0 +1,305 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeBackupsResponseBodyBackupsBackup extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the database that has been backed up.
+   * 
+   * @example
+   * database
+   */
+  backupDBNames?: string;
+  /**
+   * @remarks
+   * The URL that is used to download the backup set over the Internet. If the backup set cannot be downloaded, an empty string is returned.
+   */
+  backupDownloadURL?: string;
+  /**
+   * @remarks
+   * The end time of the backup. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.
+   * 
+   * @example
+   * 2022-01-14T03:57:34Z
+   */
+  backupEndTime?: string;
+  backupExpireTime?: string;
+  /**
+   * @remarks
+   * The ID of the backup set.
+   * 
+   * @example
+   * 32102****
+   */
+  backupId?: string;
+  /**
+   * @remarks
+   * The internal download URL of the backup set.
+   * 
+   * >  You can use the URL to download the specified backup set on an Elastic Compute Service (ECS) instance that is in the same virtual private cloud (VPC) as the ApsaraDB for MongoDB instance.
+   */
+  backupIntranetDownloadURL?: string;
+  /**
+   * @remarks
+   * The ID of the backup task.
+   * 
+   * @example
+   * 1123xxxx
+   */
+  backupJobId?: string;
+  /**
+   * @remarks
+   * The method that is used to generate the backup set. Valid values:
+   * 
+   * *   **Snapshot**
+   * *   **Physical**
+   * *   **Logical**
+   * 
+   * @example
+   * Physical
+   */
+  backupMethod?: string;
+  /**
+   * @remarks
+   * The backup mode of the backup set. Valid values:
+   * 
+   * *   **Automated**
+   * *   **Manual**
+   * 
+   * @example
+   * Automated
+   */
+  backupMode?: string;
+  /**
+   * @remarks
+   * The name of the backup set. The parameter is invalid.
+   * 
+   * @example
+   * 12345678.tar.gz
+   */
+  backupName?: string;
+  /**
+   * @remarks
+   * The backup granularity. The parameter is invalid.
+   * 
+   * @example
+   * DBInstance
+   */
+  backupScale?: string;
+  /**
+   * @remarks
+   * The size of the backup set. Unit: bytes.
+   * 
+   * @example
+   * 6168576
+   */
+  backupSize?: number;
+  /**
+   * @remarks
+   * The start time of the backup. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in UTC.
+   * 
+   * @example
+   * 2022-01-14T03:56:17Z
+   */
+  backupStartTime?: string;
+  /**
+   * @remarks
+   * The status of the backup task. Valid values:
+   * 
+   * *   **Success**: The backup task is successful.
+   * *   **Failed**: The backup task failed.
+   * 
+   * @example
+   * Success
+   */
+  backupStatus?: string;
+  /**
+   * @remarks
+   * The backup type. Valid values:
+   * 
+   * *   **FullBackup**
+   * *   **IncrementalBackup**
+   * 
+   * @example
+   * FullBackup
+   */
+  backupType?: string;
+  /**
+   * @remarks
+   * Version of the backuped instance.
+   * 
+   * *   **6.0**
+   * *   **5.0**
+   * *   **4.4**
+   * *   **4.2**
+   * *   **4.0**
+   * *   **3.4**
+   * 
+   * @example
+   * 4.2
+   */
+  engineVersion?: string;
+  /**
+   * @remarks
+   * Availability of the backup set.
+   * - 0: unavailable
+   * - 1: available
+   * 
+   * @example
+   * 1
+   */
+  isAvail?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      backupDBNames: 'BackupDBNames',
+      backupDownloadURL: 'BackupDownloadURL',
+      backupEndTime: 'BackupEndTime',
+      backupExpireTime: 'BackupExpireTime',
+      backupId: 'BackupId',
+      backupIntranetDownloadURL: 'BackupIntranetDownloadURL',
+      backupJobId: 'BackupJobId',
+      backupMethod: 'BackupMethod',
+      backupMode: 'BackupMode',
+      backupName: 'BackupName',
+      backupScale: 'BackupScale',
+      backupSize: 'BackupSize',
+      backupStartTime: 'BackupStartTime',
+      backupStatus: 'BackupStatus',
+      backupType: 'BackupType',
+      engineVersion: 'EngineVersion',
+      isAvail: 'IsAvail',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backupDBNames: 'string',
+      backupDownloadURL: 'string',
+      backupEndTime: 'string',
+      backupExpireTime: 'string',
+      backupId: 'string',
+      backupIntranetDownloadURL: 'string',
+      backupJobId: 'string',
+      backupMethod: 'string',
+      backupMode: 'string',
+      backupName: 'string',
+      backupScale: 'string',
+      backupSize: 'number',
+      backupStartTime: 'string',
+      backupStatus: 'string',
+      backupType: 'string',
+      engineVersion: 'string',
+      isAvail: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeBackupsResponseBodyBackups extends $dara.Model {
+  backup?: DescribeBackupsResponseBodyBackupsBackup[];
+  static names(): { [key: string]: string } {
+    return {
+      backup: 'Backup',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backup: { 'type': 'array', 'itemType': DescribeBackupsResponseBodyBackupsBackup },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.backup)) {
+      $dara.Model.validateArray(this.backup);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeBackupsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the backup set.
+   */
+  backups?: DescribeBackupsResponseBodyBackups;
+  /**
+   * @remarks
+   * The page number of the returned page.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries returned per page. Valid values:
+   * 
+   * *   **30** (default)
+   * *   **50**
+   * *   **100**
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 275D43C3-F12F-5224-B375-0C6BF453BD56
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The total number of backup sets.
+   * 
+   * @example
+   * 1
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      backups: 'Backups',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      backups: DescribeBackupsResponseBodyBackups,
+      pageNumber: 'number',
+      pageSize: 'number',
+      requestId: 'string',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(this.backups && typeof (this.backups as any).validate === 'function') {
+      (this.backups as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+