@alicloud/dds20151201 8.4.0 → 8.4.1

package/src/models/DescribeVpcsForMongoDbresponseBody.ts

@@ -3,41 +3,67 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeVpcsForMongoDBResponseBodyVpcsVSwitchs extends $dara.Model {
+  /**
+   * @remarks
+   * The CIDR block of the vSwitch.
+   */
   cidrBlock?: string;
   /**
+   * @remarks
+   * This parameter is deprecated. No value is returned.
+   * 
    * @example
    * null
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * This parameter is deprecated. No value is returned.
+   * 
    * @example
    * null
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * Indicates whether the vSwitch is the default vSwitch. Valid values:
+   * 
+   * - **true**: The vSwitch is the default vSwitch.
+   * 
+   * - **false**: The vSwitch is not the default vSwitch.
+   * 
    * @example
    * true
    */
   isDefault?: boolean;
   /**
+   * @remarks
+   * The zone to which the vSwitch belongs.
+   * 
    * @example
    * cn-hangzhou-i
    */
   izNo?: string;
   /**
+   * @remarks
+   * The status of the vSwitch. A value of **Available** indicates that the vSwitch is active.
+   * 
    * @example
    * Available
    */
   status?: string;
   /**
    * @remarks
-   * VSwitch ID。
+   * The vSwitch ID.
    * 
    * @example
    * vsw-bp*******************
    */
   vSwitchId?: string;
   /**
+   * @remarks
+   * The name of the vSwitch.
+   * 
    * @example
    * vsw-name
    */
@@ -79,51 +105,87 @@ export class DescribeVpcsForMongoDBResponseBodyVpcsVSwitchs extends $dara.Model
 
 export class DescribeVpcsForMongoDBResponseBodyVpcs extends $dara.Model {
   /**
+   * @remarks
+   * This parameter is deprecated. No value is returned.
+   * 
    * @example
    * null
    */
   aliUid?: string;
   /**
+   * @remarks
+   * This parameter is deprecated. No value is returned.
+   * 
    * @example
    * null
    */
   bid?: string;
+  /**
+   * @remarks
+   * The CIDR block of the VPC.
+   */
   cidrBlock?: string;
   /**
+   * @remarks
+   * This parameter is deprecated. No value is returned.
+   * 
    * @example
    * null
    */
   gmtCreate?: string;
   /**
+   * @remarks
+   * This parameter is deprecated. No value is returned.
+   * 
    * @example
    * null
    */
   gmtModified?: string;
   /**
+   * @remarks
+   * Indicates whether the VPC is the default one. Valid values:
+   * 
+   * - **true**: The VPC is the default one.
+   * 
+   * - **false**: The VPC is not the default one.
+   * 
    * @example
    * true
    */
   isDefault?: boolean;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionNo?: string;
   /**
+   * @remarks
+   * The status of the VPC. A value of **Available** indicates that the VPC is active.
+   * 
    * @example
    * Available
    */
   status?: string;
+  /**
+   * @remarks
+   * The list of vSwitches.
+   */
   vSwitchs?: DescribeVpcsForMongoDBResponseBodyVpcsVSwitchs[];
   /**
    * @remarks
-   * VPC ID。
+   * The VPC ID.
    * 
    * @example
    * vpc-2zep2pepkthg5ueal****
    */
   vpcId?: string;
   /**
+   * @remarks
+   * The name of the VPC.
+   * 
    * @example
    * vpc-name
    */
@@ -174,25 +236,41 @@ export class DescribeVpcsForMongoDBResponseBodyVpcs extends $dara.Model {
 
 export class DescribeVpcsForMongoDBResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries returned per page.
+   * 
    * @example
    * 10
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 53924AF0-1628-5AA2-9C95-D4**********
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 4
    */
   totalCount?: number;
+  /**
+   * @remarks
+   * The list of VPCs.
+   */
   vpcs?: DescribeVpcsForMongoDBResponseBodyVpcs[];
   static names(): { [key: string]: string } {
     return {

package/src/models/EvaluateResourceRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class EvaluateResourceRequest extends $dara.Model {
   /**
    * @remarks
-   * The type of the instance.
+   * The instance type.
    * 
-   * > This parameter is required when you check whether resources are sufficient for creating or upgrading a replica set instance. For more information about instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
+   * > This parameter is required when you evaluate resources for a replica set instance. For details about instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
    * 
    * @example
    * dds.mongo.mid
@@ -15,7 +15,7 @@ export class EvaluateResourceRequest extends $dara.Model {
   DBInstanceClass?: string;
   /**
    * @remarks
-   * The ID of the instance. This parameter is required when you check whether resources are sufficient for upgrading an instance.
+   * The instance ID. This parameter is required when you evaluate resources for an instance upgrade or downgrade.
    * 
    * @example
    * dds-bp14bf67a76d****
@@ -23,7 +23,7 @@ export class EvaluateResourceRequest extends $dara.Model {
   DBInstanceId?: string;
   /**
    * @remarks
-   * The database engine of the instance. Set the value to **MongoDB**.
+   * The database engine. Set the value to **MongoDB**.
    * 
    * @example
    * MongoDB
@@ -31,12 +31,12 @@ export class EvaluateResourceRequest extends $dara.Model {
   engine?: string;
   /**
    * @remarks
-   * The version of the database engine.
+   * The database engine version.
    * 
    * This parameter is required.
    * 
    * @example
-   * 4.0
+   * 4.2
    */
   engineVersion?: string;
   ownerAccount?: string;
@@ -45,7 +45,7 @@ export class EvaluateResourceRequest extends $dara.Model {
    * @remarks
    * The number of read-only nodes in the instance. Valid values: **1** to **5**.
    * 
-   * > This parameter is not required for standalone or serverless instances.
+   * > This parameter is not required for standalone instances<props="china"> and Serverless instances.
    * 
    * @example
    * 1
@@ -53,7 +53,7 @@ export class EvaluateResourceRequest extends $dara.Model {
   readonlyReplicas?: string;
   /**
    * @remarks
-   * The region ID of the instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the region ID.
+   * The ID of the region. For more information, see [DescribeRegions](https://help.aliyun.com/document_detail/61933.html).
    * 
    * This parameter is required.
    * 
@@ -65,10 +65,15 @@ export class EvaluateResourceRequest extends $dara.Model {
    * @remarks
    * The number of nodes in the instance.
    * 
-   * *   Set the value to **1** for standalone instances.
-   * *   Valid values for replica set instances: **3**, **5**, and **7**
+   * - Set the value to **1** for a standalone instance.
    * 
-   * > This parameter is not required for serverless instances.
+   * - Set the value to **2** for an instance that uses shared storage.
+   * 
+   * - For a replica set instance, valid values are **3**, **5**, and **7**.
+   * 
+   * <props="china">
+   * 
+   * > This parameter is not required for Serverless instances.
    * 
    * @example
    * 3
@@ -78,37 +83,46 @@ export class EvaluateResourceRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The node information about the sharded cluster instance. This parameter is required when you check whether resources are sufficient for creating or upgrading a sharded cluster instance.
+   * The shard information of the sharded cluster. This parameter is required when you evaluate resources for a sharded cluster instance.
+   * 
+   * To evaluate resources for a new sharded cluster instance, specify the instance type for each shard in a JSON string. Example:
+   * 
+   * ```
+   * {
+   *      "ConfigSvrs":
+   *          [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}],
+   *      "Mongos":
+   *          [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}],
+   *      "Shards":
+   *          [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"},   {"Storage":50,"DBInstanceClass":"dds.shard.standard"}]
+   *  }
+   * ```
+   * 
+   * The parameters in the example are described as follows:
+   * 
+   * - ConfigSvrs: The ConfigServer nodes.
+   * 
+   * - Mongos: The Mongos nodes.
    * 
-   * To check whether resources are sufficient for creating a sharded cluster instance, specify the specifications of each node in the instance. The value must be a JSON string. Example:
+   * - Shards: The shard nodes.
    * 
-   *     {
-   *          "ConfigSvrs":
-   *              [{"Storage":20,"DBInstanceClass":"dds.cs.mid"}],
-   *          "Mongos":
-   *              [{"DBInstanceClass":"dds.mongos.standard"},{"DBInstanceClass":"dds.mongos.standard"}],
-   *          "Shards":
-   *              [{"Storage":50,"DBInstanceClass":"dds.shard.standard"},{"Storage":50,"DBInstanceClass":"dds.shard.standard"},   {"Storage":50,"DBInstanceClass":"dds.shard.standard"}]
-   *      }
+   * - Storage: The storage space of the target shard.
    * 
-   * Parameters in the example:
+   * - DBInstanceClass: The instance type of the target shard. For details about instance types, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
    * 
-   * *   ConfigSvrs: the Configserver node.
-   * *   Mongos: the mongos node.
-   * *   Shards: the shard node.
-   * *   Storage: the storage space of the node.
-   * *   DBInstanceClass: the instance type of the node. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
+   * To evaluate resources for upgrading or downgrading a sharded cluster instance, specify only the node information in a JSON string. Example:
    * 
-   * To check whether resources are sufficient for upgrading a single node of a sharded cluster instance, specify only the information about the node to be upgraded. The value must be a JSON string. Example:
+   * ```
+   * {
+   *      "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"
+   * } 
+   * ```
    * 
-   *     {
-   *          "NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"
-   *     } 
+   * The parameters in the example are described as follows:
    * 
-   * Parameters in the example:
+   * - NodeId: The ID of the target node.
    * 
-   * *   NodeId: the ID of the node.
-   * *   NodeClass: the instance type of the node. For more information, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
+   * - NodeClass: The instance type of the target node. For details about instance types, see [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html).
    * 
    * @example
    * {"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"}
@@ -116,9 +130,9 @@ export class EvaluateResourceRequest extends $dara.Model {
   shardsInfo?: string;
   /**
    * @remarks
-   * The storage capacity of the replica set instance. Unit: GB.
+   * The storage space of the replica set. Unit: GB.
    * 
-   * > This parameter is required for the instances that use cloud disks.
+   * > This parameter is required if the instance uses cloud disks.
    * 
    * @example
    * 10
@@ -126,7 +140,7 @@ export class EvaluateResourceRequest extends $dara.Model {
   storage?: string;
   /**
    * @remarks
-   * The zone ID of the instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the zone ID.
+   * The ID of the zone. For more information, see [DescribeRegions](https://help.aliyun.com/document_detail/61933.html).
    * 
    * This parameter is required.
    * 

package/src/models/EvaluateResourceResponseBody.ts

@@ -5,10 +5,11 @@ import * as $dara from '@darabonba/typescript';
 export class EvaluateResourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the resources are sufficient in the region. Valid values:
+   * Indicates whether resources are available in the current region. Valid values:
    * 
-   * *   **1**: The resources are sufficient.
-   * *   **0**: The resources are insufficient.
+   * - **1**: Resources are sufficient.
+   * 
+   * - **0**: Resources are insufficient.
    * 
    * @example
    * 1
@@ -16,7 +17,7 @@ export class EvaluateResourceResponseBody extends $dara.Model {
   DBInstanceAvailable?: string;
   /**
    * @remarks
-   * The database engine of the instance. Only MongoDB is returned.
+   * The database engine. The value is fixed to MongoDB.
    * 
    * @example
    * MongoDB
@@ -24,7 +25,7 @@ export class EvaluateResourceResponseBody extends $dara.Model {
   engine?: string;
   /**
    * @remarks
-   * The version of the database engine.
+   * The database engine version.
    * 
    * @example
    * 4.0
@@ -32,7 +33,7 @@ export class EvaluateResourceResponseBody extends $dara.Model {
   engineVersion?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * AE2DE465-E45F-481F-ABD8-37D64173****

package/src/models/ListTagResourcesRequest.ts

@@ -8,7 +8,7 @@ export class ListTagResourcesRequestTag extends $dara.Model {
    * The key of tag.
    * 
    * @example
-   * env
+   * Development group
    */
   key?: string;
   /**
@@ -16,7 +16,7 @@ export class ListTagResourcesRequestTag extends $dara.Model {
    * The value of tag.
    * 
    * @example
-   * dev
+   * 4.0 environment
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -47,7 +47,7 @@ export class ListTagResourcesRequest extends $dara.Model {
    * @remarks
    * The token used to start the next query to retrieve more results.
    * 
-   * >  This parameter is not required in the first query. If not all results are returned in one query, you can pass in the **NextToken** value returned in the previous query to perform the query again.
+   * > This parameter is not required in the first query. If not all results are returned in one query, you can pass in the **NextToken** value returned in the previous query to perform the query again.
    * 
    * @example
    * 212db86****
@@ -70,7 +70,7 @@ export class ListTagResourcesRequest extends $dara.Model {
    * The resource IDs. You must specify this parameter or the Tag parameter.
    * 
    * @example
-   * dds-bpxxxxxxxx
+   * Development group
    */
   resourceId?: string[];
   resourceOwnerAccount?: string;

package/src/models/ListTagResourcesResponseBody.ts

@@ -65,7 +65,7 @@ export class ListTagResourcesResponseBody extends $dara.Model {
    * @remarks
    * The token used to start the next query.
    * 
-   * >  If not all results are returned in the first query, this parameter is returned. You can pass in the returned value of this parameter in the next query.
+   * > If not all results are returned in the first query, this parameter is returned. You can pass in the returned value of this parameter in the next query.
    * 
    * @example
    * 212db86****

package/src/models/MigrateAvailableZoneRequest.ts

@@ -19,8 +19,9 @@ export class MigrateAvailableZoneRequest extends $dara.Model {
    * @remarks
    * The time when the instance is migrated to the destination zone. Valid values:
    * 
-   * *   **Immediately**: The instance is immediately migrated to the destination zone.
-   * *   **MaintainTime**: The instance is migrated to the destination zone during the maintenance window of the instance.
+   * - **Immediately**: The instance is immediately migrated to the destination zone.
+   * 
+   * - **MaintainTime**: The instance is migrated to the destination zone during the maintenance window of the instance.
    * 
    * Default value: **Immediately**.
    * 
@@ -62,11 +63,11 @@ export class MigrateAvailableZoneRequest extends $dara.Model {
    * @remarks
    * The ID of the destination zone.
    * 
-   * > 
+   * >
    * 
-   * *   The source zone and the destination zone belong to the same region.
+   * - The source zone and the destination zone belong to the same region.
    * 
-   * *   You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the zone ID.
+   * - You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the zone ID.
    * 
    * This parameter is required.
    * 

package/src/models/MigrateToOtherZoneRequest.ts

@@ -7,8 +7,9 @@ export class MigrateToOtherZoneRequest extends $dara.Model {
    * @remarks
    * The time when the instance is migrated to the destination zone. Valid values:
    * 
-   * *   **Immediately** (default): The instance is migrated immediately.
-   * *   **MaintainTime**: The instance is migrated during its maintenance window.
+   * - **Immediately** (default): The instance is migrated immediately.
+   * 
+   * - **MaintainTime**: The instance is migrated during its maintenance window.
    * 
    * @example
    * Immediately
@@ -18,7 +19,7 @@ export class MigrateToOtherZoneRequest extends $dara.Model {
    * @remarks
    * The ID of the instance.
    * 
-   * >  If the network type of the instance is VPC, you must specify the **Vswitch** parameter .
+   * > If the network type of the instance is VPC, you must specify the **Vswitch** parameter .
    * 
    * This parameter is required.
    * 
@@ -34,7 +35,7 @@ export class MigrateToOtherZoneRequest extends $dara.Model {
    * @remarks
    * The ID of the vSwitch in the destination zone.
    * 
-   * >  This parameter is valid and required only when the network type of the instance is VPC.
+   * > This parameter is valid and required only when the network type of the instance is VPC.
    * 
    * @example
    * vsw-bp67ac****
@@ -44,8 +45,9 @@ export class MigrateToOtherZoneRequest extends $dara.Model {
    * @remarks
    * The ID of the destination zone to which you want to migrate the ApsaraDB for MongoDB instance.
    * 
-   * > * The destination and source zones must be in one region.
-   * > * You can call [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) to query the zone IDs.
+   * > - The destination and source zones must be in one region.
+   * >
+   * > - You can call [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) to query the zone IDs.
    * 
    * This parameter is required.
    * 

package/src/models/ModifyAccountDescriptionRequest.ts

@@ -7,8 +7,9 @@ export class ModifyAccountDescriptionRequest extends $dara.Model {
    * @remarks
    * The description of the account.
    * 
-   * *   The description must start with a letter and cannot start with http:// or https://.
-   * *   The description must be 2 to 256 characters in length, and can contain letters, digits, underscores (_), and hyphens (-).
+   * - The description must start with a letter and cannot start with http\\:// or https\\://.
+   * 
+   * - The description must be 2 to 256 characters in length, and can contain letters, digits, underscores (_), and hyphens (-).
    * 
    * This parameter is required.
    * 
@@ -30,11 +31,13 @@ export class ModifyAccountDescriptionRequest extends $dara.Model {
    * @remarks
    * The type of the account whose description you can modify. Valid values:
    * 
-   * *   **db**: shard account
-   * *   **cs**: ConfigServer account
-   * *   **normal** (default): replica set account (available)
+   * - **db**: shard account
+   * 
+   * - **cs**: ConfigServer account
+   * 
+   * - **normal** (default): replica set account (available)
    * 
-   * >  You can set this parameter only to **normal**.
+   * > You can set this parameter only to **normal**.
    * 
    * @example
    * normal

package/src/models/ModifyActiveOperationMaintenanceConfigRequest.ts

@@ -4,21 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyActiveOperationMaintenanceConfigRequest extends $dara.Model {
   /**
+   * @remarks
+   * The day of the cycle.
+   * 
+   * - If CycleType is set to Month, enter a number from 1 to 28 to specify the day of the month. Use a comma (,) to separate multiple days.
+   * 
+   * - If CycleType is set to Week, enter a number from 1 to 7 to specify the day of the week. Use a comma (,) to separate multiple days.
+   * 
    * @example
    * 1,2,3
    */
   cycleTime?: string;
   /**
+   * @remarks
+   * The cycle type.
+   * 
+   * - Month: monthly
+   * 
+   * - Week: weekly
+   * 
    * @example
    * Week
    */
   cycleType?: string;
   /**
+   * @remarks
+   * The end time of the O\\&M window for the instance. The time is in the HH:mmZ format and is in UTC.
+   * 
    * @example
    * 22:00Z
    */
   maintainEndTime?: string;
   /**
+   * @remarks
+   * The start time of the O\\&M window for the instance. The time is in the HH:mmZ format and is in UTC.
+   * 
    * @example
    * 21:00Z
    */
@@ -28,6 +48,13 @@ export class ModifyActiveOperationMaintenanceConfigRequest extends $dara.Model {
   resourceOwnerAccount?: string;
   resourceOwnerId?: number;
   /**
+   * @remarks
+   * Specifies whether the configuration is enabled.
+   * 
+   * - 1: enabled
+   * 
+   * - 2: disabled
+   * 
    * @example
    * 1
    */

package/src/models/ModifyActiveOperationMaintenanceConfigResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyActiveOperationMaintenanceConfigResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * D8F1D721-6439-4257-A89C-F1E8E9C9****
    */

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