@alicloud/dds20151201 8.3.0 → 8.4.1

package/src/models/DescribeBackupPolicyResponseBody.ts

@@ -5,18 +5,27 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The frequency at which high-frequency backup is created. Valid values:
-   * 
-   * *   **-1**: High-frequency backup is disabled.
-   * *   **15**: every 15 minutes.
-   * *   **30**: every 30 minutes.
-   * *   **60**: every hour.
-   * *   **120**: every 2 hours.
-   * *   **180**: every 3 hours.
-   * *   **240**: every 4 hours.
-   * *   **360**: every 6 hours.
-   * *   **480**: every 8 hours.
-   * *   **720**: every 12 hours.
+   * The high-frequency backup frequency. Valid values:
+   * 
+   * - **-1**: high-frequency backup is disabled.
+   * 
+   * - **15**: every 15 minutes.
+   * 
+   * - **30**: every 30 minutes.
+   * 
+   * - **60**: every 1 hour.
+   * 
+   * - **120**: every 2 hours.
+   * 
+   * - **180**: every 3 hours.
+   * 
+   * - **240**: every 4 hours.
+   * 
+   * - **360**: every 6 hours.
+   * 
+   * - **480**: every 8 hours.
+   * 
+   * - **720**: every 12 hours.
    * 
    * @example
    * -1
@@ -24,7 +33,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   backupInterval?: number;
   /**
    * @remarks
-   * The retention period of the backup data. Unit: day.
+   * The backup retention period in days.
    * 
    * @example
    * 30
@@ -32,13 +41,15 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   backupRetentionPeriod?: string;
   /**
    * @remarks
-   * The backup retention policy configured for the instance. Valid values:
+   * The backup retention policy.
    * 
-   * 1.  0: All backup sets are immediately deleted when the instance is released.
-   * 2.  1: Automatic backup is performed and the backup set is retained for a long period of time when the instance is released.
-   * 3.  2: Automatic backup is performed and all backup sets are retained for a long period of time when the instance is released.
+   * 1. 0: All backup sets of the instance are immediately deleted when the instance is released
    * 
-   * For more information, see [Retain the backup files of an ApsaraDB for MongoDB instance for a long period of time](https://help.aliyun.com/document_detail/2779111.html).
+   * 2. 1: The instance is automatically backed up when it is released, and the backup set is retained for a long time
+   * 
+   * 3. 2: The instance is automatically backed up when it is released, and all backup sets of the cluster are retained for a long time
+   * 
+   * For more information, see [Long-term backup retention](https://help.aliyun.com/document_detail/2779111.html)
    * 
    * @example
    * 0
@@ -46,16 +57,23 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   backupRetentionPolicyOnClusterDeletion?: number;
   /**
    * @remarks
-   * The retention period of Cross-regional backup.
-   * Valid values:
+   * The geo-redundancy backup retention time.
+   * 
+   * 1. Monday: Monday.
+   * 
+   * 2. Tuesday: Tuesday.
+   * 
+   * 3. Wednesday: Wednesday.
+   * 
+   * 4. Thursday: Thursday.
+   * 
+   * 5. Friday: Friday.
+   * 
+   * 6. Saturday: Saturday.
+   * 
+   * 7. Sunday: Sunday.
    * 
-   * *   **Monday**
-   * *   **Tuesday**
-   * *   **Wednesday**
-   * *   **Thursday**
-   * *   **Friday**
-   * *   **Saturday**
-   * *   **Sunday**
+   * > Required for geo-redundancy backup
    * 
    * @example
    * Monday
@@ -63,10 +81,11 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   crossBackupPeriod?: string;
   /**
    * @remarks
-   * The retention type of Cross-regional  log backup.
+   * The geo-redundancy log backup retention type.
    * 
-   * - delay : retain the backup for a period of time.
-   * - never : retain the backup permanently.
+   * - delay: retained for a period of time
+   * 
+   * - never: never expires
    * 
    * @example
    * delay
@@ -74,7 +93,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   crossLogRetentionType?: string;
   /**
    * @remarks
-   * The retention time of Cross-regional log backup.
+   * The geo-redundancy log backup retention period.
    * 
    * @example
    * 7
@@ -82,10 +101,11 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   crossLogRetentionValue?: number;
   /**
    * @remarks
-   * The retention type of Cross-regional backup.
+   * The geo-redundancy backup retention type.
+   * 
+   * - delay: retained for a period of time
    * 
-   * - delay : retain the backup for a period of time.
-   * - never : retain the backup permanently.
+   * - never: never expires
    * 
    * @example
    * delay
@@ -93,7 +113,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   crossRetentionType?: string;
   /**
    * @remarks
-   * The retention time of Cross-regional backup.
+   * The geo-redundancy backup retention period.
    * 
    * @example
    * 7
@@ -101,7 +121,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   crossRetentionValue?: number;
   /**
    * @remarks
-   * The region ID of the cross-regional backup..
+   * The region where the geo-redundancy backup is located.
    * 
    * @example
    * cn-shenzhen
@@ -109,10 +129,11 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   destRegion?: string;
   /**
    * @remarks
-   * Indicates whether the log backup feature is enabled. Valid values:
+   * Indicates whether log backup is enabled. Valid values:
+   * 
+   * - **0**: disabled (default).
    * 
-   * *   **0** (default): The log backup feature is disabled.
-   * *   **1**: The log backup feature is enabled.
+   * - **1**: enabled.
    * 
    * @example
    * 1
@@ -120,9 +141,13 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   enableBackupLog?: number;
   /**
    * @remarks
-   * Whether to turn on cross-regional log backup.
-   * - 1: turn on . Used for sharded cluster.
-   * - 0: turn off. Used for replicate set.
+   * Indicates whether cross-region log backup is enabled.
+   * 
+   * > Required for geo-redundancy backup
+   * >
+   * > - 1: enabled (must be 1 for sharded cluster instances)
+   * >
+   * > - 0: disabled (must be 0 for replica set instances)
    * 
    * @example
    * 1
@@ -130,7 +155,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   enableCrossLogBackup?: number;
   /**
    * @remarks
-   * The retention period of high-frequency backups. Unit: day.
+   * The high-frequency backup retention period in days.
    * 
    * @example
    * 1
@@ -138,7 +163,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   highFrequencyBackupRetention?: string;
   /**
    * @remarks
-   * The number of days for which log backups are retained. Valid values: 7 to 730.
+   * The log backup retention period in days. Valid values: 7 to 730.
    * 
    * @example
    * 7
@@ -146,15 +171,21 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   logBackupRetentionPeriod?: number;
   /**
    * @remarks
-   * The day of a week on which to back up data. Valid values:
+   * The backup cycle. Valid values:
+   * 
+   * - **Monday**: Monday.
+   * 
+   * - **Tuesday**: Tuesday.
+   * 
+   * - **Wednesday**: Wednesday.
+   * 
+   * - **Thursday**: Thursday.
+   * 
+   * - **Friday**: Friday.
    * 
-   * *   **Monday**
-   * *   **Tuesday**
-   * *   **Wednesday**
-   * *   **Thursday**
-   * *   **Friday**
-   * *   **Saturday**
-   * *   **Sunday**
+   * - **Saturday**: Saturday.
+   * 
+   * - **Sunday**: Sunday.
    * 
    * @example
    * Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
@@ -162,7 +193,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   preferredBackupPeriod?: string;
   /**
    * @remarks
-   * The time range during which the backup was created. The time follows the ISO 8601 standard in the *HH:mm*Z-*HH:mm*Z format. The time is displayed in UTC.
+   * The backup time in the format of *HH:mm*Z-*HH:mm*Z (UTC time).
    * 
    * @example
    * 09:00Z-10:00Z
@@ -170,12 +201,23 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   preferredBackupTime?: string;
   /**
    * @remarks
-   * The time of next standard backup.
+   * The next regular backup time in the format of *yyyy-mm-dd*t*hh:mm*z (UTC time).
    * 
    * @example
    * 2024-06-19T19:11Z
    */
   preferredNextBackupTime?: string;
+  /**
+   * @remarks
+   * Indicates whether sparse backup within an hour is enabled.
+   * 
+   * - true: When the backup frequency is at the minute level, all snapshots within 1 hour from the current time are retained. For snapshots that are more than 1 hour but within 24 hours from the current time, only the first snapshot after each hour is retained.
+   * 
+   * - false: Sparse backup within an hour is disabled: all snapshots within the high-frequency backup retention period are retained.
+   * 
+   * @example
+   * false
+   */
   preserveOneEachHour?: boolean;
   /**
    * @remarks
@@ -189,8 +231,9 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
    * @remarks
    * The snapshot backup type. Valid values:
    * 
-   * *   **Flash**: single-digit second backup
-   * *   **Standard** (default): standard backup
+   * - **Flash**: second-level backup.
+   * 
+   * - **Standard**: regular backup (default).
    * 
    * @example
    * Standard
@@ -198,7 +241,7 @@ export class DescribeBackupPolicyResponseBody extends $dara.Model {
   snapshotBackupType?: string;
   /**
    * @remarks
-   * The region ID of the instance.
+   * The region where the source instance is located.
    * 
    * @example
    * cn-hangzhou

package/src/models/DescribeBackupStorageRequest.ts

@@ -17,7 +17,7 @@ export class DescribeBackupStorageRequest extends $dara.Model {
    * @remarks
    * The ID of the shard node in the sharded cluster instance.
    * 
-   * >  This parameter is required only when the **DBInstanceId** parameter is set to the ID of a sharded cluster instance.
+   * > This parameter is required if the **DBInstanceId** parameter specifies the ID of a sharded cluster instance.
    * 
    * @example
    * d-2zee48956b4axxxx
@@ -27,7 +27,7 @@ export class DescribeBackupStorageRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the instance. You can call the [DescribeDBInstanceAttribute](https://help.aliyun.com/document_detail/62010.html) operation to query the most recent region list.
+   * The ID of the region where the instance is located. Call the [DescribeDBInstanceAttribute](https://help.aliyun.com/document_detail/62010.html) operation to query the region ID.
    * 
    * @example
    * cn-bejing

package/src/models/DescribeBackupStorageResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupStorageResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The free quota for the storage capacity used for backup. Unit: bytes.
+   * The free backup quota for the instance. Unit: bytes.
    * 
    * @example
    * 42949672960
@@ -13,9 +13,9 @@ export class DescribeBackupStorageResponseBody extends $dara.Model {
   freeSize?: number;
   /**
    * @remarks
-   * The storage capacity used for the full backup. Unit: bytes.
+   * The storage space used by full backups. Unit: bytes.
    * 
-   * >  Instances that use cloud disks support snapshot backup. The size of the storage used for the current full backup is the size of the snapshot chain.
+   * > Instances that use cloud disks are backed up using snapshots. The size of a full backup is the total size of the snapshot chain.
    * 
    * @example
    * 789221621
@@ -23,7 +23,7 @@ export class DescribeBackupStorageResponseBody extends $dara.Model {
   fullStorageSize?: number;
   /**
    * @remarks
-   * The storage capacity used for the log backup. Unit: bytes.
+   * The storage space used by log backups. Unit: bytes.
    * 
    * @example
    * 7892216

package/src/models/DescribeBackupTasksRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupTasksRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the backup task.
+   * The backup job ID.
    * 
-   * >  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.
+   * > If you call [CreateBackup](https://help.aliyun.com/document_detail/468439.html) to perform a manual backup, you can pass the returned backup ID to query the backup progress.
    * 
    * @example
    * 170034

package/src/models/DescribeBackupTasksResponseBody.ts

@@ -5,12 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
   /**
    * @remarks
-   * The backup task status. Valid values:
+   * The status of the backup job.
    * 
-   * *   **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.
+   * - **Scheduled**: The backup job is scheduled. This includes regular backup jobs that have not started.
+   * 
+   * - **Checking**: The instance is being checked before the backup.
+   * 
+   * - **Backuping**: The backup is in progress.
+   * 
+   * - **Finished**: The backup is complete.
    * 
    * @example
    * Scheduled
@@ -18,7 +21,7 @@ export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
   backupSetStatus?: string;
   /**
    * @remarks
-   * The start time of the backup task.
+   * The start time of the backup.
    * 
    * @example
    * 2024-01-16T11:04:56Z
@@ -26,7 +29,7 @@ export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
   backupStartTime?: string;
   /**
    * @remarks
-   * The ID of the backup task.
+   * The backup job ID.
    * 
    * @example
    * 170034
@@ -36,8 +39,9 @@ export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
    * @remarks
    * The backup mode. Valid values:
    * 
-   * *   **Automated**: automatic backup
-   * *   **Manual**: manual backup
+   * - **Automated**: automatic backup.
+   * 
+   * - **Manual**: manual backup.
    * 
    * @example
    * Manual
@@ -45,7 +49,7 @@ export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
   jobMode?: string;
   /**
    * @remarks
-   * The progress of the backup task. Unit: %. The progress is returned only for running backup tasks.
+   * The backup progress in percentage. The progress is displayed only for running backup jobs.
    * 
    * @example
    * 18%
@@ -83,7 +87,7 @@ export class DescribeBackupTasksResponseBodyBackupJobs extends $dara.Model {
 export class DescribeBackupTasksResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The details of the backup task.
+   * The details of the backup jobs.
    */
   backupJobs?: DescribeBackupTasksResponseBodyBackupJobs[];
   /**

package/src/models/DescribeBackupsRequest.ts

@@ -5,24 +5,27 @@ 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.
+   * The backup 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 (,).
+   * If you specify the ID of a sharded cluster instance for the **DBInstanceId** parameter, the number of backup IDs must be the same as the number of shard nodes. Separate the backup IDs with commas (,).
    * 
    * @example
    * 2072****,2072****,2072****
    */
   backupId?: string;
   /**
+   * @remarks
+   * The backup job ID.
+   * 
    * @example
    * 775051
    */
   backupJobId?: string;
   /**
    * @remarks
-   * The instance ID.
+   * The ID of the instance.
    * 
-   * > If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.
+   * > If the instance is a sharded cluster instance, you must also specify the **NodeId** parameter.
    * 
    * This parameter is required.
    * 
@@ -32,9 +35,9 @@ export class DescribeBackupsRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The region ID of the Cross-regional backup.
+   * The region where the backup resides.
    * 
-   * >  This parameter is required for the Cross-regional backup.
+   * > This parameter is required for geo-redundancy.
    * 
    * @example
    * cn-hangzhou
@@ -42,7 +45,9 @@ export class DescribeBackupsRequest extends $dara.Model {
   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.
+   * The end of the time range to query. The end time must be later than the start time. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in UTC.
+   * 
+   * > This parameter is invalid if you specify the BackupId parameter.
    * 
    * @example
    * 2022-01-14T13:00Z
@@ -52,7 +57,7 @@ export class DescribeBackupsRequest extends $dara.Model {
    * @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.
+   * > This parameter is required if you specify the ID of a sharded cluster instance for the **DBInstanceId** parameter.
    * 
    * @example
    * d-bp128a003436****
@@ -62,7 +67,7 @@ export class DescribeBackupsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: **1**.
+   * The page number. The value must be greater than 0 and not greater than the maximum value of the integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -70,17 +75,22 @@ export class DescribeBackupsRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return per page. Valid values:
+   * The number of entries to return on each page. Valid values:
+   * 
+   * - **30** (Default)
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-xxxx
    */
@@ -89,10 +99,11 @@ export class DescribeBackupsRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The region ID of the instance.
+   * The region where the instance resides.
    * 
-   * >- 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.
+   * > - This parameter is required to restore a deleted instance.
+   * >
+   * > - This parameter is required for geo-redundancy.
    * 
    * @example
    * cn-beijing
@@ -100,7 +111,9 @@ export class DescribeBackupsRequest extends $dara.Model {
   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.
+   * The beginning of the time range to query. Specify the time in the *yyyy-MM-dd*T*HH:mm*Z format. The time must be in Coordinated Universal Time (UTC).
+   * 
+   * > This parameter is invalid if you specify the BackupId parameter.
    * 
    * @example
    * 2022-01-13T13:00Z