@alicloud/dds20151201 8.4.0 → 8.4.1

package/src/models/DescribeBackupsResponseBody.ts

@@ -103,7 +103,7 @@ export class DescribeBackupsResponseBody extends $dara.Model {
   backups?: DescribeBackupsResponseBodyBackups;
   /**
    * @remarks
-   * The page number of the returned page.
+   * The page number.
    * 
    * @example
    * 1
@@ -113,9 +113,11 @@ export class DescribeBackupsResponseBody extends $dara.Model {
    * @remarks
    * The number of entries returned per page. Valid values:
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **30** (Default)
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 30
@@ -126,12 +128,12 @@ export class DescribeBackupsResponseBody extends $dara.Model {
    * The request ID.
    * 
    * @example
-   * 275D43C3-F12F-5224-B375-0C6BF453BD56
+   * 275D43C3-F12F-5224-B375-************
    */
   requestId?: string;
   /**
    * @remarks
-   * The total number of backup sets.
+   * The total number of backups.
    * 
    * @example
    * 1

package/src/models/DescribeBinlogFilesRequest.ts

@@ -3,18 +3,38 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeBinlogFilesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The binlog ID. This parameter is not currently supported.
+   * 
+   * @example
+   * null
+   */
   binlogId?: string;
   /**
    * @remarks
+   * The ID of the instance. If the instance is a sharded cluster, you must also specify the **NodeId** parameter.
+   * 
    * This parameter is required.
    * 
    * @example
    * dds-wz9ca592fc637a54
    */
   DBInstanceId?: string;
+  /**
+   * @remarks
+   * The region where the cross-region backup is stored.
+   * 
+   * > This parameter is required when you query cross-region backups.
+   * 
+   * @example
+   * cn-beijing
+   */
   destRegion?: string;
   /**
    * @remarks
+   * The end time of the query. The time must be later than the start time. The time is in the *yyyy-MM-dd*T*HH:mm:ss.xxx*Z format. The time is displayed in UTC.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +42,11 @@ export class DescribeBinlogFilesRequest extends $dara.Model {
    */
   endTime?: string;
   /**
+   * @remarks
+   * The ID of the mongos node or shard node in the sharded cluster instance.
+   * 
+   * > This parameter is applicable only to sharded cluster instances.
+   * 
    * @example
    * d-uf696817a1b5d9f4
    */
@@ -29,30 +54,53 @@ export class DescribeBinlogFilesRequest extends $dara.Model {
   ownerAccount?: string;
   ownerId?: number;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The ID of the region.
+   * 
    * @example
    * cn-zhangjiakou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-xxxx
    */
   resourceGroupId?: string;
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
+  /**
+   * @remarks
+   * The region of the source instance for a cross-region backup.
+   * 
+   * > - This parameter is required when you query cross-region backups.
+   * 
+   * @example
+   * ap-southeast-1
+   */
   srcRegion?: string;
   /**
    * @remarks
+   * The start time of the query. The time is in the *yyyy-MM-dd*T*HH:mm:ss.xxx*Z format. The time is displayed in UTC.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeBinlogFilesResponseBody.ts

@@ -90,21 +90,33 @@ export class DescribeBinlogFilesResponseBodyItems extends $dara.Model {
 export class DescribeBinlogFilesResponseBody extends $dara.Model {
   items?: DescribeBinlogFilesResponseBodyItems;
   /**
+   * @remarks
+   * The number of entries to return on each page.
+   * 
    * @example
    * 30
    */
   maxRecordsPerPage?: number;
   /**
+   * @remarks
+   * The page number of the returned results.
+   * 
    * @example
    * 3
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * F8CA8312-530A-413A-9129-F2BB32A8D404
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of binlog files found.
+   * 
    * @example
    * 240
    */

package/src/models/DescribeClusterBackupsRequest.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeClusterBackupsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cluster backup set.
+   * The ID of the cluster backup.
    * 
    * @example
    * 5664****
    */
   backupId?: string;
   /**
+   * @remarks
+   * The ID of the backup job.
+   * 
    * @example
    * 775051
    */
@@ -28,9 +31,9 @@ export class DescribeClusterBackupsRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The region where cross-region backups reside.
+   * The region where the geo-redundant backup resides.
    * 
-   * >  This parameter is required if you want to query cross-region backups.
+   * > This parameter is required when you query geo-redundant backups.
    * 
    * @example
    * cn-shanghai
@@ -38,7 +41,9 @@ export class DescribeClusterBackupsRequest extends $dara.Model {
   destRegion?: string;
   /**
    * @remarks
-   * The end of the time range to query. Specify the time in the yyyy-MM-ddTHH:mmZ 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
    * 2019-03-14T13:10Z
@@ -46,10 +51,11 @@ export class DescribeClusterBackupsRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * Specifies whether to query information about child nodes in the cluster backup. Valid values:
+   * Specifies whether to query the information about the child nodes in the cluster backup. Valid values:
    * 
-   * *   **true**: The system returns only the basic information of the cluster backup.
-   * *   **false** (default): The system returns the backup information of all child nodes.
+   * - **true**: Returns only the basic information about the cluster backup, not the backup information about all child nodes.
+   * 
+   * - **false** (Default): Returns the backup information about all child nodes.
    * 
    * @example
    * true
@@ -59,7 +65,7 @@ export class DescribeClusterBackupsRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The page number. Default value: **1**. The page number must be a positive integer.
+   * The number of the page to return. The value must be a positive integer. Default value: **1**.
    * 
    * @example
    * 1
@@ -69,15 +75,20 @@ export class DescribeClusterBackupsRequest extends $dara.Model {
    * @remarks
    * The number of entries to return on each page. Valid values:
    * 
-   * *   **30** (default)
-   * *   **50**
-   * *   **100**
+   * - **30** (Default)
+   * 
+   * - **50**
+   * 
+   * - **100**
    * 
    * @example
    * 30
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-xxxx
    */
@@ -86,13 +97,11 @@ export class DescribeClusterBackupsRequest 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 when you query the backup sets of a released instance.
+   * >
+   * > - This parameter is required when you query geo-redundant backups.
    * 
    * @example
    * cn-hangzhou
@@ -100,10 +109,12 @@ export class DescribeClusterBackupsRequest 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
-   * 2019-03-13T12:11:14Z
+   * 2019-03-13T12:11Z
    */
   startTime?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribeClusterBackupsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeClusterBackupsResponseBodyClusterBackupsBackupsExtraInfo extends $dara.Model {
   /**
    * @remarks
-   * The instance type of the node.
+   * The specifications of the node.
    * 
    * @example
    * mdb.shard.4x.large.d
@@ -13,7 +13,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackupsExtraInfo ex
   instanceClass?: string;
   /**
    * @remarks
-   * The node ID.
+   * The ID of the node.
    * 
    * @example
    * d-2ze75ab1fa5d****
@@ -21,7 +21,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackupsExtraInfo ex
   nodeId?: string;
   /**
    * @remarks
-   * The node type.
+   * The type of the node.
    * 
    * @example
    * db
@@ -29,7 +29,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackupsExtraInfo ex
   nodeType?: string;
   /**
    * @remarks
-   * The storage capacity of the node. Unit: MB.
+   * The storage space of the node, in MB.
    * 
    * @example
    * 20480
@@ -65,7 +65,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackupsExtraInfo ex
 export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $dara.Model {
   /**
    * @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.
+   * The public URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.
    * 
    * @example
    * http://oss.com/xxx
@@ -73,7 +73,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   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.
+   * The time when the backup finished. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.
    * 
    * @example
    * 2023-10-16T19:33:20Z
@@ -81,7 +81,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupEndTime?: string;
   /**
    * @remarks
-   * The ID of the backup set.
+   * The ID of the backup.
    * 
    * @example
    * 738025367
@@ -89,7 +89,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupId?: string;
   /**
    * @remarks
-   * The URL that is used to download the backup set over an internal network. If the backup set cannot be downloaded, null is returned.
+   * The internal URL from which you can download the backup file. If the backup file is unavailable for download, an empty string is returned.
    * 
    * @example
    * http://oss.com/xxx
@@ -97,7 +97,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupIntranetDownloadURL?: string;
   /**
    * @remarks
-   * The backup name.
+   * The name of the backup.
    * 
    * @example
    * 12345678.tar.gz
@@ -105,7 +105,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupName?: string;
   /**
    * @remarks
-   * The size of the backup file. Unit: bytes.
+   * The size of the backup file, in bytes.
    * 
    * @example
    * 77544597650
@@ -113,7 +113,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupSize?: string;
   /**
    * @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.
+   * The time when the backup started. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.
    * 
    * @example
    * 2023-10-16T19:33:20Z
@@ -121,10 +121,11 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupStartTime?: string;
   /**
    * @remarks
-   * The status of the backup task. Valid values:
+   * The backup status. Valid values:
+   * 
+   * - **Success**: The backup is successful.
    * 
-   * *   **Success**: The backup task is successful.
-   * *   **Failed**: The backup task failed.
+   * - **Failed**: The backup failed.
    * 
    * @example
    * Success
@@ -132,12 +133,12 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
   backupStatus?: string;
   /**
    * @remarks
-   * The information of the node associated with the backup.
+   * The information about the instance node that is associated with the backup.
    */
   extraInfo?: DescribeClusterBackupsResponseBodyClusterBackupsBackupsExtraInfo;
   /**
    * @remarks
-   * The shard name.
+   * The name of the shard in the MongoDB cluster.
    * 
    * @example
    * d-bp16cb162771****
@@ -147,8 +148,9 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
    * @remarks
    * Indicates whether the backup set is available. Valid values:
    * 
-   * *   **0**: unavailable
-   * *   **1**: available
+   * - **0**: unavailable.
+   * 
+   * - **1**: available.
    * 
    * @example
    * 1
@@ -201,7 +203,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsBackups extends $da
 export class DescribeClusterBackupsResponseBodyClusterBackupsExtraInfo extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the cluster backups are migrated from the historical backup sets. If the value of this parameter is **1**, the cluster backups are migrated from the historical backup sets.
+   * Indicates whether the backup set was migrated from a historical backup. A value of **1** indicates that the backup was migrated.
    * 
    * @example
    * 1
@@ -231,29 +233,44 @@ export class DescribeClusterBackupsResponseBodyClusterBackupsExtraInfo extends $
 export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Model {
   /**
    * @remarks
-   * The backup status. Valid values:
+   * The status of the attached log backup. Valid values:
+   * 
+   * - **Init**: initialization.
+   * 
+   * - **No_Need**: No attached log backup is available.
    * 
-   * *   **init**: The backup is being initialized.
-   * *   **No_Need**: Log backup is not performed.
-   * *   **Running**: Log backup is being performed.
-   * *   **Ready**: Log backup is complete.
-   * *   **Failed**: Log backup failed.
+   * - **Running**: The attached log backup is in progress.
    * 
-   * >  If the **ClusterBackupStatus** parameter is set to OK, full backup is successful. If you want to perform point-in-time-restoration on an instance for which log backup is enabled or to implement consistency restoration, make sure that log backup is complete.
+   * - **Ready**: The attached log backup is complete.
+   * 
+   * - **Failed**: The attached log backup failed.
+   * 
+   * > If the value of the **ClusterBackupStatus** parameter is OK, it only indicates that the full backup was successful. For a cluster instance for which log backup is enabled, the attached log backup must be complete before you can perform a point-in-time restore or ensure data consistency.
    * 
    * @example
    * Ready
    */
   attachLogStatus?: string;
+  /**
+   * @remarks
+   * The time when the backup expires. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.
+   * 
+   * >Notice: 
+   * 
+   * A value of "9999-01-01T00:00:00Z" indicates that the backup is permanently retained.
+   * 
+   * @example
+   * 2025-03-29T03:47:12Z
+   */
   backupExpireTime?: string;
   /**
    * @remarks
-   * The collection of the backup sets of each child node in a cluster backup set.
+   * The backup sets of each child node in the cluster backup.
    */
   backups?: DescribeClusterBackupsResponseBodyClusterBackupsBackups[];
   /**
    * @remarks
-   * The end of the time range within which the cluster backup is performed.
+   * The time when the cluster backup finished.
    * 
    * @example
    * 2023-10-16T19:33:20Z
@@ -261,7 +278,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   clusterBackupEndTime?: string;
   /**
    * @remarks
-   * The backup set ID.
+   * The ID of the cluster backup.
    * 
    * @example
    * cb-o8c2ugnxo26kx***
@@ -269,7 +286,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   clusterBackupId?: string;
   /**
    * @remarks
-   * The cluster backup mode.
+   * The mode of the cluster backup.
    * 
    * @example
    * Automated
@@ -277,7 +294,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   clusterBackupMode?: string;
   /**
    * @remarks
-   * The size of the cluster backup set. Unit: bytes.
+   * The size of the cluster backup set, in bytes.
    * 
    * @example
    * 107374182400
@@ -285,7 +302,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   clusterBackupSize?: string;
   /**
    * @remarks
-   * The beginning of the time range within which the cluster backup is performed.
+   * The time when the cluster backup started.
    * 
    * @example
    * 2023-10-16T19:33:20Z
@@ -293,7 +310,7 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   clusterBackupStartTime?: string;
   /**
    * @remarks
-   * The status of the cluster backup set.
+   * The status of the cluster backup.
    * 
    * @example
    * OK
@@ -301,14 +318,21 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   clusterBackupStatus?: string;
   /**
    * @remarks
-   * Version of the backuped instance.
+   * The database engine version of the instance when the backup was created. Valid values:
+   * 
+   * - **7.0**
+   * 
+   * - **6.0**
    * 
-   * *   **6.0**
-   * *   **5.0**
-   * *   **4.4**
-   * *   **4.2**
-   * *   **4.0**
-   * *   **3.4**
+   * - **5.0**
+   * 
+   * - **4.4**
+   * 
+   * - **4.2**
+   * 
+   * - **4.0**
+   * 
+   * - **3.4**
    * 
    * @example
    * 4.2
@@ -316,15 +340,16 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   engineVersion?: string;
   /**
    * @remarks
-   * The additional information in the JSON format.
+   * The supplementary information. The value is a JSON-formatted string.
    */
   extraInfo?: DescribeClusterBackupsResponseBodyClusterBackupsExtraInfo;
   /**
    * @remarks
-   * Indicates whether the cluster backup sets take effect. Valid values:
+   * Indicates whether the cluster backup set is valid. Valid values:
+   * 
+   * - **1**: The cluster backup set is valid.
    * 
-   * *   **1**: The cluster backup sets take effect.
-   * *   **0**: The backup sets of child nodes are incomplete or fail.
+   * - **0**: The backup sets of child nodes are not complete or have failed.
    * 
    * @example
    * 1
@@ -332,7 +357,8 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
   isAvail?: number;
   /**
    * @remarks
-   * The progress of the backup task. Unit: %. The progress is returned only for running backup tasks.
+   * The backup progress in percentage.
+   * This parameter is returned only for backups that are in progress.
    * 
    * @example
    * 50
@@ -392,12 +418,12 @@ export class DescribeClusterBackupsResponseBodyClusterBackups extends $dara.Mode
 export class DescribeClusterBackupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The cluster backup sets. A cluster backup file contains the backup sets of each node.
+   * The details of the cluster backup sets. A cluster backup contains the backup sets of all nodes.
    */
   clusterBackups?: DescribeClusterBackupsResponseBodyClusterBackups[];
   /**
    * @remarks
-   * The maximum number of entries returned.
+   * The maximum number of entries returned in this request.
    * 
    * @example
    * 10
@@ -405,7 +431,7 @@ export class DescribeClusterBackupsResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The page number of the page returned.
+   * The page number of the returned page.
    * 
    * @example
    * 1
@@ -413,7 +439,7 @@ export class DescribeClusterBackupsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page.
+   * The number of entries returned per page.
    * 
    * @example
    * 30
@@ -421,7 +447,7 @@ export class DescribeClusterBackupsResponseBody extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 2F42BB4E-461F-5B55-A37C-53B1141C****