@alicloud/dds20151201 8.3.0 → 8.4.1

package/src/models/ModifyAuditLogFilterRequest.ts

@@ -17,13 +17,19 @@ export class ModifyAuditLogFilterRequest extends $dara.Model {
    * @remarks
    * The type of logs collected by the audit log feature of the instance. Separate multiple types with commas (,). Valid values:
    * 
-   * *   **admin**: O\\&M and management operations
-   * *   **slow**: slow query logs
-   * *   **query**: query operations
-   * *   **insert**: insert operations
-   * *   **update**: update operations
-   * *   **delete**: delete operations
-   * *   **command**: protocol commands such as the aggregate method
+   * - **admin**: O\\&M and management operations
+   * 
+   * - **slow**: slow query logs
+   * 
+   * - **query**: query operations
+   * 
+   * - **insert**: insert operations
+   * 
+   * - **update**: update operations
+   * 
+   * - **delete**: delete operations
+   * 
+   * - **command**: protocol commands such as the aggregate method
    * 
    * This parameter is required.
    * 
@@ -39,8 +45,9 @@ export class ModifyAuditLogFilterRequest extends $dara.Model {
    * @remarks
    * The role of the node in the instance. Valid values:
    * 
-   * *   **primary**
-   * *   **secondary**
+   * - **primary**
+   * 
+   * - **secondary**
    * 
    * @example
    * primary

package/src/models/ModifyAuditPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyAuditPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The request source for the audit log feature. Set the value to **Console**.
+   * The source of the request. Set this parameter to **Console**.
    * 
    * @example
    * Console
@@ -13,10 +13,11 @@ export class ModifyAuditPolicyRequest extends $dara.Model {
   auditLogSwitchSource?: string;
   /**
    * @remarks
-   * Specifies whether to enable the audit log feature. Valid values:
+   * The status of the audit log. Valid values:
    * 
-   * *   **enable**
-   * *   **disabled**
+   * - **enable**: Enables the audit log feature.
+   * 
+   * - **disabled**: Disables the audit log feature.
    * 
    * This parameter is required.
    * 
@@ -34,18 +35,31 @@ export class ModifyAuditPolicyRequest extends $dara.Model {
    * dds-bp1785659e3f****
    */
   DBInstanceId?: string;
+  /**
+   * @remarks
+   * This parameter is effective only for the **V2_Standard** (DAS Enterprise Edition (NoSQL Compatible) audit log) edition. It specifies the hot storage duration for the audit log. Valid values: 0 to 7. Unit: days.
+   * 
+   * @example
+   * 7
+   */
+  hotStoragePeriod?: number;
   ownerAccount?: string;
   ownerId?: number;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The type of the audit log feature. Valid values:
+   * The edition of the audit log. Valid values:
+   * 
+   * - **Trial**: Trial Edition.
    * 
-   * *   **Trail**: free trial edition.
-   * *   **Standard**: official edition.
+   * - **Standard**: Standard Edition.
    * 
-   * > The default value is **Trail**. Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and the free trial edition of the feature can no longer be applied for. We recommend that you set this parameter to **Standard**.
+   * - **V2_Standard**: DAS Enterprise Edition (NoSQL Compatible) audit log.
+   * 
+   * > * The default value of this parameter is **Trial**. Starting from January 6, 2022, the Standard edition is being rolled out across regions, and new applications for the Trial edition are no longer accepted.
+   * >
+   * > * Starting from February 2026, the DAS Enterprise Edition (NoSQL Compatible) audit log will be rolled out across regions, and new applications for the Standard edition will no longer be accepted.
    * 
    * @example
    * Standard
@@ -53,7 +67,9 @@ export class ModifyAuditPolicyRequest extends $dara.Model {
   serviceType?: string;
   /**
    * @remarks
-   * The log retention period. Valid values: 1 to 365 days. Default value: 30 days.
+   * - For the **Standard** edition, this parameter specifies the retention period for the audit log. Valid values: 1 to 365. The default value is 30. Unit: days.
+   * 
+   * - For the **V2_Standard** (DAS Enterprise Edition (NoSQL Compatible) audit log) edition, this parameter specifies the cold storage duration for the audit log. Valid values: 30, 180, 365, 1095, and 1825. Unit: days.
    * 
    * @example
    * 30
@@ -64,6 +80,7 @@ export class ModifyAuditPolicyRequest extends $dara.Model {
       auditLogSwitchSource: 'AuditLogSwitchSource',
       auditStatus: 'AuditStatus',
       DBInstanceId: 'DBInstanceId',
+      hotStoragePeriod: 'HotStoragePeriod',
       ownerAccount: 'OwnerAccount',
       ownerId: 'OwnerId',
       resourceOwnerAccount: 'ResourceOwnerAccount',
@@ -78,6 +95,7 @@ export class ModifyAuditPolicyRequest extends $dara.Model {
       auditLogSwitchSource: 'string',
       auditStatus: 'string',
       DBInstanceId: 'string',
+      hotStoragePeriod: 'number',
       ownerAccount: 'string',
       ownerId: 'number',
       resourceOwnerAccount: 'string',

package/src/models/ModifyBackupExpireTimeRequest.ts

@@ -4,12 +4,23 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyBackupExpireTimeRequest extends $dara.Model {
   /**
+   * @remarks
+   * The time-to-live (TTL) of the backup. The time must be in the *yyyy-MM-dd*T*HH:mm:ss*Z format and in UTC.
+   * 
+   * > - *9999-01-01*T*00:00:00*Z* indicates that the backup is retained permanently.*
+   * >
+   * >   *- You can only extend the retention period. You cannot shorten it.- If you do not set the time to *9999-01-01*T*00:00:00*Z, the new expiration time must be within 730 days after the end time of the backup set.*
+   * >
+   * > **
+   * 
    * @example
    * 2025-03-29T03:47:12Z
    */
   backupExpireTime?: string;
   /**
    * @remarks
+   * The backup ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +29,8 @@ export class ModifyBackupExpireTimeRequest extends $dara.Model {
   backupId?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyBackupExpireTimeResponseBody.ts

@@ -4,16 +4,31 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyBackupExpireTimeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The time-to-live (TTL) of the backup. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is in UTC.
+   * 
+   * > - *9999-01-01*T*00:00:00*Z* indicates that the backup is retained permanently.*
+   * >
+   * >   **
+   * >
+   * > **
+   * 
    * @example
    * 2025-03-29T03:47:12Z
    */
   backupExpireTime?: string;
   /**
+   * @remarks
+   * The backup ID.
+   * 
    * @example
    * 260032xxxx
    */
   backupId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * A0181AC4-XXXX-XXXX-87CA-100C70B86729
    */

package/src/models/ModifyBackupPolicyRequest.ts

@@ -5,23 +5,29 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyBackupPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * The frequency at which high-frequency backups are generated. Valid values:
+   * The frequency of high-frequency backups. Valid values:
    * 
-   * *   **-1**: High-frequency backup is disabled.
-   * *   **30**: High-frequency backups are generated every 30 minutes.
-   * *   **60**: High-frequency backups are generated every 1 hour.
-   * *   **120**: High-frequency backups are generated every 2 hours.
-   * *   **180**: High-frequency backups are generated every 3 hours.
-   * *   **240**: High-frequency backups are generated every 4 hours.
-   * *   **360**: High-frequency backups are generated every 6 hours.
-   * *   **480**: High-frequency backups are generated every 8 hours.
-   * *   **720**: High-frequency backups are generated every 12 hours.
+   * - **-1**: High-frequency backup is disabled.
    * 
-   * > 
+   * - **30**: every 30 minutes.
    * 
-   * *   If you set the **SnapshotBackupType** parameter to **Standard**, you must fix the value of this parameter to -1.
+   * - **60**: every 1 hour.
    * 
-   * *   High-frequency backup takes effect only when you set the **SnapshotBackupType** parameter to **Flash** and this parameter to a value greater than 0.
+   * - **120**: every 2 hours.
+   * 
+   * - **180**: every 3 hours.
+   * 
+   * - **240**: every 4 hours.
+   * 
+   * - **360**: every 6 hours.
+   * 
+   * - **480**: every 8 hours.
+   * 
+   * - **720**: every 12 hours.
+   * 
+   * > * If you set **SnapshotBackupType** to **Standard**, the value of this parameter is -1.
+   * >
+   * > * High-frequency backup takes effect only if you set **SnapshotBackupType** to **Flash** and set this parameter to a value greater than 0.
    * 
    * @example
    * -1
@@ -29,13 +35,11 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   backupInterval?: string;
   /**
    * @remarks
-   * The retention period of full backups.
+   * The number of days to retain full backups.
    * 
-   * > 
-   * 
-   * *   If your instance is created before September 10, 2021, backups are retained for seven days by default.
-   * 
-   * *   If your instance is created after September 10, 2021, backups are retained for 30 days by default.
+   * > - For instances that were created before September 10, 2021, the default retention period is 7 days.
+   * >
+   * > - For instances that are created after September 10, 2021, the default retention period is 30 days.
    * 
    * @example
    * 30
@@ -43,13 +47,15 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   backupRetentionPeriod?: number;
   /**
    * @remarks
-   * The backup retention policy configured for the instance. Valid values:
+   * The policy to retain backups when you release the instance.
+   * 
+   * - 0: All backup sets of the instance are deleted when the instance is released.
    * 
-   * *   0: All backup sets are immediately deleted when the instance is released.
-   * *   1: Automatic backup is performed when the instance is released and the backup set is retained for a long period of time.
-   * *   2: Automatic backup is performed when the instance is released and all backup sets are retained for a long period of time.
+   * - 1: An automatic backup is performed when the instance is released, and this backup is retained for a long time.
    * 
-   * 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: An automatic backup is performed when the instance is released, and all backup sets of the instance are retained for a long time.
+   * 
+   * For more information, see [Long-term backup retention](https://help.aliyun.com/document_detail/2779111.html).
    * 
    * @example
    * 2
@@ -57,21 +63,27 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   backupRetentionPolicyOnClusterDeletion?: number;
   /**
    * @remarks
-   * The day of the week on which the cross-region backup files are retained. Valid values:
+   * The days of the week to perform geo-redundant backups. Valid values:
+   * 
+   * 1. Monday
    * 
-   * 1.  Monday
-   * 2.  Tuesday
-   * 3.  Wednesday
-   * 4.  Thursday
-   * 5.  Friday
-   * 6.  Saturday
-   * 7.  Sunday
+   * 2. Tuesday
    * 
-   * >  This parameter is required for a cross-region backup operation.
+   * 3. Wednesday
    * 
-   * *   Separate multiple values with commas (,).
+   * 4. Thursday
    * 
-   * *   If you set the SnapshotBackupType parameter to Standard, the parameter value must fall within the value of the PreferredBackupPeriod parameter that specifies the standard backup period.
+   * 5. Friday
+   * 
+   * 6. Saturday
+   * 
+   * 7. Sunday
+   * 
+   * > This parameter is required if you enable geo-redundancy.
+   * >
+   * > - To specify multiple days, separate them with commas (,).
+   * >
+   * > - If you set the backup method to conventional backup, the days of the week specified by this parameter must be a subset of the days of the week specified by PreferredBackupPeriod.
    * 
    * @example
    * Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday
@@ -79,12 +91,13 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   crossBackupPeriod?: string;
   /**
    * @remarks
-   * The action performed for the cross-region backup policy. Valid values:
+   * The policy for geo-redundant backups. Valid values:
    * 
-   * *   update: modifies the cross-region backup policy.
-   * *   delete: deletes the cross-region backup policy.
+   * - update: Modify the geo-redundancy policy.
    * 
-   * >  This parameter is required for a cross-region backup operation.
+   * - delete: Delete the geo-redundancy policy.
+   * 
+   * > This parameter is required if you enable geo-redundancy.
    * 
    * @example
    * update
@@ -92,12 +105,13 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   crossBackupType?: string;
   /**
    * @remarks
-   * The retention type of the cross-region log backup files. Valid values:
+   * The retention policy for cross-region log backups. Valid values:
+   * 
+   * - delay: Retain the backup for a specified period.
    * 
-   * *   delay: retains the cross-region backup files for a period of time.
-   * *   never: permanently retains the cross-region backup files.
+   * - never: Retain the backup permanently.
    * 
-   * >  This parameter is required for a cross-region backup operation.
+   * > This parameter is required if you enable geo-redundancy.
    * 
    * @example
    * delay
@@ -105,9 +119,9 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   crossLogRetentionType?: string;
   /**
    * @remarks
-   * The retention period of the cross-region log backup files. Valid values: 3 to 1825. Unit: day. The parameter value must be less than or equal to the value of the CrossRetentionValue parameter.
+   * The number of days to retain cross-region log backups. Valid values: 3 to 1825. The value must be less than or equal to the value of CrossRetentionValue.
    * 
-   * >  This parameter is required for a cross-region backup operation.
+   * > This parameter is required if you enable geo-redundancy.
    * 
    * @example
    * 3
@@ -115,12 +129,13 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   crossLogRetentionValue?: number;
   /**
    * @remarks
-   * The retention type of the cross-region backup files. Valid values:
+   * The retention policy for geo-redundant backups. Valid values:
+   * 
+   * - delay: Retain the backup for a specified period.
    * 
-   * *   delay: retains the cross-region backup files for a period of time.
-   * *   never: permanently retains the cross-region backup files.
+   * - never: Retain the backup permanently.
    * 
-   * >  This parameter is required for a cross-region backup operation.
+   * > This parameter is required if you enable geo-redundancy.
    * 
    * @example
    * delay
@@ -128,13 +143,11 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   crossRetentionType?: string;
   /**
    * @remarks
-   * The retention period of the cross-region backup files. Valid values: 3 to 1825. Unit: day.
+   * The number of days to retain geo-redundant backups. Valid values: 3 to 1825.
    * 
-   * > 
-   * 
-   * *   This parameter is required for a cross-region backup operation.
-   * 
-   * *   This parameter is required when you set the CrossRetentionType parameter to delay.
+   * > - This parameter is required if you enable geo-redundancy.
+   * >
+   * > - This parameter is required if you set CrossRetentionType to delay.
    * 
    * @example
    * 7
@@ -152,9 +165,9 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The region in which the backup files are retained.
+   * The region ID of the geo-redundant backup.
    * 
-   * >  This parameter is required for a cross-region backup operation.
+   * > This parameter is required if you enable geo-redundancy.
    * 
    * @example
    * cn-hangzhou
@@ -162,10 +175,15 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   destRegion?: string;
   /**
    * @remarks
-   * Specifies whether to enable the log backup feature. Valid values:
+   * Specifies whether to enable log backup. Valid values:
+   * 
+   * - **0**: Disable log backup. This is the default value.
+   * 
+   * - **1**: Enable log backup.
+   * 
+   * >Notice: 
    * 
-   * *   **0** (default): The log backup feature is disabled.
-   * *   **1**: The log backup feature is enabled.
+   * You cannot disable log backup for sharded cluster instances.
    * 
    * @example
    * 0
@@ -173,13 +191,13 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   enableBackupLog?: number;
   /**
    * @remarks
-   * Specifies whether to enable the cross-region log backup feature.
+   * Specifies whether to enable cross-region log backup. Valid values:
    * 
-   * >  This parameter is required for a cross-region backup operation.
-   * 
-   * *   Valid values:1: enables the feature. The parameter value must be 1 for sharded cluster instances.
-   * 
-   * *   0: disables the feature. The parameter value must be 0 for replica set instances.
+   * > This parameter is required if you enable geo-redundancy.
+   * >
+   * > - 1: Enable cross-region log backup. This value is required for sharded cluster instances. This value is also required for replica set instances if you want to enable geo-redundant point-in-time recovery.
+   * >
+   * > - 0: Disable cross-region log backup.
    * 
    * @example
    * 1
@@ -187,7 +205,7 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   enableCrossLogBackup?: number;
   /**
    * @remarks
-   * The number of days for which high-frequency backup files are retained. Before you use this parameter, make sure that you specify the BackupInterval parameter. By default, high-frequency backup files are retained for one day.
+   * The number of days to retain high-frequency backups. Before you specify this parameter, you must set the BackupInterval parameter. The default retention period is 1 day.
    * 
    * @example
    * 1
@@ -195,16 +213,15 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   highFrequencyBackupRetention?: number;
   /**
    * @remarks
-   * The instance architecture. Valid values:
-   * 
-   * *   replicate
-   * *   sharding
+   * The instance type. Valid values:
    * 
-   * > 
+   * - replicate
    * 
-   * *   This parameter is required when you set the RestoreType parameter to 2.
+   * - sharding
    * 
-   * *   This parameter is required when you set the RestoreType parameter to 3.
+   * > * This parameter is required when you restore a deleted instance.
+   * >
+   * > * This parameter is required when you clone an instance from a geo-redundant backup.
    * 
    * @example
    * replicate
@@ -212,7 +229,7 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   instanceType?: string;
   /**
    * @remarks
-   * The number of days for which log backups are retained. Default value: 7.
+   * The number of days to retain log backups. Default value: 7.
    * 
    * Valid values: 7 to 730.
    * 
@@ -224,21 +241,29 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The day of a week when the system regularly backs up data. Valid values:
+   * The backup cycle. Valid values:
+   * 
+   * - **Monday**
+   * 
+   * - **Tuesday**
+   * 
+   * - **Wednesday**
+   * 
+   * - **Thursday**
+   * 
+   * - **Friday**
+   * 
+   * - **Saturday**
+   * 
+   * - **Sunday**
+   * 
+   * >Notice: 
    * 
-   * *   **Monday**
-   * *   **Tuesday**
-   * *   **Wednesday**
-   * *   **Thursday**
-   * *   **Friday**
-   * *   **Saturday**
-   * *   **Sunday**
+   * To ensure data security, back up the MongoDB instance at least twice a week.
    * 
-   * **
    * 
-   * **Notice**: To ensure data security, make sure that the system backs up data at least twice a week.
    * 
-   * >  Separate multiple values with commas (,).
+   * > To specify multiple backup cycles, separate them with commas (,).
    * 
    * @example
    * Monday,Wednesday,Friday,Sunday
@@ -246,14 +271,25 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
   preferredBackupPeriod?: string;
   /**
    * @remarks
-   * The start time of the backup. Specify the time in the ISO 8601 standard in the *HH:mm*Z-*HH:mm*Z format. The time must be in UTC.
+   * The time range to perform a backup. Specify the time in the *HH:mm*Z-*HH:mm*Z format. The time is displayed in Coordinated Universal Time (UTC).
    * 
-   * >  The time range is 1 hour.
+   * > The time range must be 1 hour.
    * 
    * @example
    * 03:00Z-04:00Z
    */
   preferredBackupTime?: string;
+  /**
+   * @remarks
+   * Specifies whether to enable hourly sparse backup. Valid values:
+   * 
+   * - true: If the backup frequency is in minutes, all snapshots that are generated within the last hour are retained. For snapshots that were generated more than 1 hour ago but less than 24 hours ago, only the first snapshot that is generated after each full hour is retained.
+   * 
+   * - false: All snapshots are retained within the high-frequency backup retention period.
+   * 
+   * @example
+   * true
+   */
   preserveOneEachHour?: boolean;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
@@ -261,8 +297,9 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
    * @remarks
    * The snapshot backup type. Valid values:
    * 
-   * *   **Flash**: single-digit second backup
-   * *   **Standard** (default): standard backup
+   * - **Flash**: second-level backup.
+   * 
+   * - **Standard**: conventional backup. This is the default value.
    * 
    * @example
    * Standard
@@ -272,11 +309,9 @@ export class ModifyBackupPolicyRequest extends $dara.Model {
    * @remarks
    * The region ID of the instance.
    * 
-   * > 
-   * 
-   * *   This parameter is required for the data restoration of a deleted instance.
-   * 
-   * *   This parameter is required for a cross-region backup operation.
+   * > - This parameter is required if you restore a deleted instance.
+   * >
+   * > - This parameter is required if you enable geo-redundancy.
    * 
    * @example
    * cn-beijing

package/src/models/ModifyDbinstanceAttributeRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBInstanceAttributeRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,6 +14,13 @@ export class ModifyDBInstanceAttributeRequest extends $dara.Model {
    */
   DBInstanceId?: string;
   /**
+   * @remarks
+   * Specifies whether to enable instance release protection. Valid values:
+   * 
+   * - **true**: enabled.
+   * 
+   * - **false**: disabled.
+   * 
    * @example
    * false
    */

package/src/models/ModifyDbinstanceAttributeResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceAttributeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 6826DEE3-B374-5DB7-909D-C8978827C534
    */

package/src/models/ModifyDbinstanceConfigRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDBInstanceConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration item name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ModifyDBInstanceConfigRequest extends $dara.Model {
   configName?: string;
   /**
    * @remarks
+   * The configuration item value
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ModifyDBInstanceConfigRequest extends $dara.Model {
   configValue?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ModifyDbinstanceConfigResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyDBInstanceConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E466EFD6-2AD2-xxxx-A1A6-C7AFA1B323E1
    */