@alicloud/dds20151201 8.3.0 → 8.4.1

package/src/models/DescribeDbinstanceEncryptionKeyResponseBody.ts

@@ -39,8 +39,9 @@ export class DescribeDBInstanceEncryptionKeyResponseBody extends $dara.Model {
    * @remarks
    * Indicates whether the key for the instance is enabled. Valid values:
    * 
-   * *   **Enabled**
-   * *   **Disabled**
+   * - **Enabled**
+   * 
+   * - **Disabled**
    * 
    * @example
    * Enabled

package/src/models/DescribeDbinstancePerformanceRequest.ts

@@ -7,7 +7,7 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
    * @remarks
    * The instance ID.
    * 
-   * >  If you set this parameter to the ID of a sharded cluster instance, you must also specify the **NodeId** parameter.
+   * > **NodeId** is required when specifying a sharded cluster instance ID
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
   DBInstanceId?: 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 required.
    * 
@@ -27,7 +27,7 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The interval at which performance data is collected. Valid values: 5, 30, 60, 600, 1800, 3600, 86400.
+   * The data granularity of the performance metrics in seconds. Valid values: 5, 30, 60, 600, 1800, 3600, and 86400.
    * 
    * @example
    * 60
@@ -35,9 +35,9 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
   interval?: string;
   /**
    * @remarks
-   * The performance metric. For more information about valid values, see [Monitoring items and metrics](https://help.aliyun.com/document_detail/216973.html).
+   * The performance metrics. For more information, see [Metrics](https://help.aliyun.com/document_detail/216973.html).
    * 
-   * >  If you need to specify multiple metrics, separate the metrics with commas (,).
+   * > To specify multiple metrics, separate them with commas (,).
    * 
    * This parameter is required.
    * 
@@ -47,9 +47,9 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The ID of the mongos or shard node in a sharded cluster instance. You can specify this parameter to view the performance data of a single node.
+   * The ID of a mongos or shard node in the sharded cluster instance. This parameter lets you query the performance of a single node.
    * 
-   * >  This parameter is valid when you set the **DBInstanceId** parameter to the ID of a sharded cluster instance.
+   * > Available only when **DBInstanceId** is set to the ID of a sharded cluster instance.
    * 
    * @example
    * d-bp2287****
@@ -59,13 +59,15 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The role of the node in the standalone or replica set instance. Valid values:
+   * The role of a node in a standalone or replica set instance. Valid values:
    * 
-   * *   **Primary**
-   * *   **Secondary**
+   * - **Primary**: The primary node.
    * 
-   * >  *  This parameter is valid only when you specify the **DBInstanceId** parameter to the ID of a standalone instance or a replica set instance.
-   * > *  This parameter can be set only to **Primary** when you specify the **DBInstanceId** parameter to the ID of a standalone instance.
+   * - **Secondary**: A secondary node.
+   * 
+   * > * Available only when **DBInstanceId** is set to the ID of a standalone or replica set instance.
+   * >
+   * > * If **DBInstanceId** is set to the ID of a standalone instance, this parameter only supports the value **Primary**.
    * 
    * @example
    * Primary
@@ -75,18 +77,27 @@ export class DescribeDBInstancePerformanceRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * The role ID of the node in a standalone or replica set instance. You can call the [DescribeReplicaSetRole](https://help.aliyun.com/document_detail/62134.html) operation to query the role ID of the node.
+   * The role ID of a node in a standalone or replica set instance. To query the role ID, call the [DescribeReplicaSetRole](https://help.aliyun.com/document_detail/62134.html) operation.
    * 
-   * >  This parameter is available when you set the **DBInstanceId** parameter to the ID of a standalone instance or a replica set instance.
+   * > Available only when **DBInstanceId** is set to the ID of a standalone or replica set instance.
    * 
    * @example
    * 6025****
    */
   roleId?: string;
+  /**
+   * @remarks
+   * The Search node ID.
+   * 
+   * > Available only after the Search feature is enabled for the instance.
+   * 
+   * @example
+   * dds-2zec12675c9e****-search
+   */
   searchId?: 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 UTC.
    * 
    * This parameter is required.
    * 

package/src/models/DescribeDbinstancePerformanceResponseBody.ts

@@ -3,21 +3,7 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDBInstancePerformanceResponseBodyPerformanceKeysPerformanceKeyPerformanceValuesPerformanceValue extends $dara.Model {
-  /**
-   * @remarks
-   * The date and time when the metric value was generated.
-   * 
-   * @example
-   * 2022-06-13T10:58:00Z
-   */
   date?: string;
-  /**
-   * @remarks
-   * The value of the performance metric.
-   * 
-   * @example
-   * 0.23
-   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -69,36 +55,9 @@ export class DescribeDBInstancePerformanceResponseBodyPerformanceKeysPerformance
 }
 
 export class DescribeDBInstancePerformanceResponseBodyPerformanceKeysPerformanceKey extends $dara.Model {
-  /**
-   * @remarks
-   * The performance metrics that are returned.
-   * 
-   * @example
-   * CpuUsage
-   */
   key?: string;
-  /**
-   * @remarks
-   * The details of the performance metric values.
-   */
   performanceValues?: DescribeDBInstancePerformanceResponseBodyPerformanceKeysPerformanceKeyPerformanceValues;
-  /**
-   * @remarks
-   * The unit of the performance metric.
-   * 
-   * @example
-   * %
-   */
   unit?: string;
-  /**
-   * @remarks
-   * The format of the performance metric value. If the performance metric contains multiple fields, the fields are separated with ampersands ( &).
-   * 
-   * For example, if you query disk space usage, the returned value of the **ValueFormat** parameter is **ins_size\\&data_size\\&log_size**.
-   * 
-   * @example
-   * cpu_usage
-   */
   valueFormat?: string;
   static names(): { [key: string]: string } {
     return {
@@ -159,16 +118,12 @@ export class DescribeDBInstancePerformanceResponseBodyPerformanceKeys extends $d
 export class DescribeDBInstancePerformanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The end of the queried time range. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.
+   * The end of the time range to query. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.
    * 
    * @example
    * 2022-06-13T11:58Z
    */
   endTime?: string;
-  /**
-   * @remarks
-   * The details of performance metrics.
-   */
   performanceKeys?: DescribeDBInstancePerformanceResponseBodyPerformanceKeys;
   /**
    * @remarks
@@ -180,7 +135,7 @@ export class DescribeDBInstancePerformanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The beginning of the queried time range. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.
+   * The beginning of the time range to query. The time is in the *yyyy-MM-dd*T*HH:mm*Z format. The time is displayed in UTC.
    * 
    * @example
    * 2022-06-13T10:58Z

package/src/models/DescribeDbinstanceSpecInfoRequest.ts

@@ -5,6 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBInstanceSpecInfoRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance type. You can query this parameter by calling the [DescribeDBInstanceAttribute](https://next.api.aliyun.com/api/Dds/2015-12-01/DescribeDBInstanceAttribute) operation.
+   * 
+   * For instance types of different instance categories, see the following topics:
+   * 
+   * - [Specifications of standalone instances](https://help.aliyun.com/document_detail/311407.html)
+   * 
+   * - [Specifications of replica set instances](https://help.aliyun.com/document_detail/311410.html)
+   * 
+   * - [Specifications of sharded cluster instances](https://help.aliyun.com/document_detail/311414.html)
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeDbinstanceSpecInfoResponseBody.ts

@@ -4,17 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDBInstanceSpecInfoResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The number of CPU cores.
+   * 
    * @example
    * 2
    */
   CPU?: string;
+  /**
+   * @remarks
+   * The description of the instance type.
+   * 
+   * @example
+   * 2核8GB（独享型）
+   */
   description?: string;
   /**
+   * @remarks
+   * The memory size, in GB.
+   * 
    * @example
    * 8
    */
   memory?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 6B82A9EF-9961-5A31-A19F-009B709xxxxx
    */

package/src/models/DescribeDbinstanceSslresponseBody.ts

@@ -11,6 +11,17 @@ export class DescribeDBInstanceSSLResponseBody extends $dara.Model {
    * dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
    */
   certCommonName?: string;
+  /**
+   * @remarks
+   * Specifies whether connections must be encrypted using SSL. Valid values:
+   * 
+   * - **1**: Connections must be encrypted using SSL.
+   * 
+   * - **0**: Connections do not need to be encrypted using SSL.
+   * 
+   * @example
+   * 0
+   */
   forceEncryption?: string;
   /**
    * @remarks
@@ -22,7 +33,7 @@ export class DescribeDBInstanceSSLResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The time when the SSL certificate expires. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ss*Z format. The time is displayed in Coordinated Universal Time (UTC).
+   * The expiration time of the SSL certificate. The time is in the *yyyy-MM-dd*T*HH:mm:ss*Z format and is displayed in UTC.
    * 
    * @example
    * 2020-03-11T02:28:25Z
@@ -30,10 +41,11 @@ export class DescribeDBInstanceSSLResponseBody extends $dara.Model {
   SSLExpiredTime?: string;
   /**
    * @remarks
-   * The status of the SSL feature. Valid values:
+   * The status of the SSL feature.
+   * 
+   * - **Open**: The SSL feature is enabled.
    * 
-   * *   **Open**: The SSL feature is enabled.
-   * *   **Closed**: The SSL feature is disabled.
+   * - **Closed**: The SSL feature is disabled.
    * 
    * @example
    * Open

package/src/models/DescribeDbinstanceSwitchLogResponseBody.ts

@@ -8,19 +8,24 @@ export class DescribeDBInstanceSwitchLogResponseBodyLogItems extends $dara.Model
    * The ID of the replica set instance or the ID of the node on which a primary/secondary switchover is performed.
    * 
    * @example
-   * dds-uf68f1b5a57exxxx
+   * NodeId-example-id-****
    */
   nodeId?: string;
   /**
    * @remarks
    * The code that indicates the reason of a primary/secondary switchover. Valid values:
    * 
-   * *   USER_CONSOLE_OPERATION: The switchover is manually performed.
-   * *   OPERATION_AND_MAINTENANCE: Potential risks exist.
-   * *   MACHINE_DOWNTIME: The host is offline.
-   * *   PRIMARY_UNHEALTHY: An exception occurs on the primary node of the instance.
-   * *   SECONDARY_UNHEALTHY: An exception occurs on the secondary node of the instance.
-   * *   MULTIPLE_NODE_FAILURES: An exception occurs on multiple nodes of the instance.
+   * - USER_CONSOLE_OPERATION: The switchover is manually performed.
+   * 
+   * - OPERATION_AND_MAINTENANCE: Potential risks exist.
+   * 
+   * - MACHINE_DOWNTIME: The host is offline.
+   * 
+   * - PRIMARY_UNHEALTHY: An exception occurs on the primary node of the instance.
+   * 
+   * - SECONDARY_UNHEALTHY: An exception occurs on the secondary node of the instance.
+   * 
+   * - MULTIPLE_NODE_FAILURES: An exception occurs on multiple nodes of the instance.
    * 
    * @example
    * USER_CONSOLE_OPERATION

package/src/models/DescribeDbinstanceTdeinfoResponseBody.ts

@@ -5,18 +5,18 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBInstanceTDEInfoResponseBody extends $dara.Model {
   /**
    * @remarks
-   * 实例的自定义密钥。
+   * The custom key of the instance.
    * 
-   * 目前仅以下地域支持BYOK（Bring Your Own Key，用户可以自行管理和拥有加密密钥）：
-   * - 华东1（杭州）
-   * - 华东2（上海）
-   * - 华北2（北京）
-   * - 华南1（深圳）
-   * - 中国（香港）
-   * - 新加坡
-   * - 马来西亚（吉隆坡）
+   * Currently, only the following regions support Bring Your Own Key (BYOK), which allows you to manage and own encryption keys:
+   * - China (Hangzhou)
+   * - China (Shanghai)
+   * - China (Beijing)
+   * - China (Shenzhen)
+   * - Hong Kong (China)
+   * - Singapore
+   * - Malaysia (Kuala Lumpur)
    * 
-   * > 支持BYOK，用户可以管理且拥有密钥，系统将返回用户的自定义密钥；不支持BYOK，用户不可管理密钥，系统将返回字符串`NoActiveBYOK`。
+   * > If BYOK is supported, you can manage and own the key, and the system returns your custom key. If BYOK is not supported, you cannot manage the key, and the system returns the string `NoActiveBYOK`.
    * 
    * @example
    * 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
@@ -24,7 +24,7 @@ export class DescribeDBInstanceTDEInfoResponseBody extends $dara.Model {
   encryptionKey?: string;
   /**
    * @remarks
-   * 加密算法。
+   * The encryption algorithm.
    * 
    * @example
    * aes-256-cbc
@@ -40,7 +40,7 @@ export class DescribeDBInstanceTDEInfoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * 指定待授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息。
+   * The global resource descriptor ARN (Alibaba Cloud Resource Name) of the role pending authorization.
    * 
    * @example
    * acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
@@ -48,10 +48,11 @@ export class DescribeDBInstanceTDEInfoResponseBody extends $dara.Model {
   roleARN?: string;
   /**
    * @remarks
-   * The TDE status. Valid values:
+   * The TDE enabling status. Valid values:
+   * - **enabled**: TDE is enabled.
+   * - **disabled**: TDE is disabled.
    * 
-   * *   **enabled**
-   * *   **disabled**
+   * > If the TDE status is disabled, the **RoleARN**, **EncryptionKey**, and **EncryptorName** parameters are not returned.
    * 
    * @example
    * enabled

package/src/models/DescribeDbinstancesOverviewRequest.ts

@@ -7,8 +7,9 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
    * @remarks
    * The billing method of the instance. Valid values:
    * 
-   * *   **PrePaid**: subscription
-   * *   **PostPaid**: pay-as-you-go
+   * - **PrePaid**: subscription
+   * 
+   * - **PostPaid**: pay-as-you-go
    * 
    * @example
    * PostPaid
@@ -24,11 +25,17 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   engineVersion?: string;
   /**
    * @remarks
-   * The instance type. The instance type varies based on the instance architecture. For more information about instance types supported by different instance architectures, see the following references:
+   * The instance type. For more information about the instance types available for different instance architectures, see:
+   * 
+   * - [Standalone instance types](https://help.aliyun.com/document_detail/311407.html)
+   * 
+   * - [Replica set instance types](https://help.aliyun.com/document_detail/311410.html)
    * 
-   * *   [Standalone instance types](https://help.aliyun.com/document_detail/311407.html)
-   * *   [Replica set instance types](https://help.aliyun.com/document_detail/311410.html)
-   * *   [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html)
+   * - [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html)
+   * 
+   * <props="china">
+   * 
+   * > This parameter is not required for Serverless instances.
    * 
    * @example
    * dds.mongo.2xlarge
@@ -36,13 +43,11 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   instanceClass?: string;
   /**
    * @remarks
-   * The ID of the instance for which you want to query the overview information.
-   * 
-   * > 
+   * The ID of the instance whose overview you want to query.
    * 
-   * *   If you do not specify this parameter, the overview information of all instances within this account is queried.
-   * 
-   * *   Separate the instance IDs with commas (,).
+   * > - If you do not specify this parameter, an overview of all instances in your Alibaba Cloud account is returned.
+   * >
+   * > - You can specify multiple instance IDs. Separate the IDs with commas (,).
    * 
    * @example
    * dds-bp12c5b040dc****
@@ -50,7 +55,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   instanceIds?: string;
   /**
    * @remarks
-   * The state of the instance. For more information about valid values, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
+   * The status of the instance. For more information, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
    * 
    * @example
    * Running
@@ -58,16 +63,22 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   instanceStatus?: string;
   /**
    * @remarks
-   * The architecture of the instance. Valid values:
+   * The instance architecture. Valid values:
+   * 
+   * - **sharding**: sharded cluster instance
+   * 
+   * - **replicate**: replica set or standalone instance
    * 
-   * *   **sharding**: sharded cluster instance
-   * *   **replicate**: replica set or standalone instance
+   * <props="china">
    * 
-   * > 
+   * - **serverless**: Serverless instance
    * 
-   * *   To query the overview information of a sharded cluster instance, you must set the parameter to **sharding**.
    * 
-   * *   If you do not specify this parameter, the overview information of all instances within this account is queried.
+   * 
+   * 
+   * > * Set this parameter as needed. For example, to query the overview of a sharded cluster instance, set this parameter to **sharding**.
+   * >
+   * > * If you do not specify this parameter, an overview of all instances is returned.
    * 
    * @example
    * replicate
@@ -77,8 +88,9 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
    * @remarks
    * The network type of the instance. Valid values:
    * 
-   * *   **Classic**: classic network
-   * *   **VPC**: Virtual Private Cloud (VPC)
+   * - **Classic**: classic network
+   * 
+   * - **VPC**: virtual private cloud (VPC)
    * 
    * @example
    * Classic
@@ -88,7 +100,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
-   * The region ID of the instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the most recent region list.
+   * The region ID. Call [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) to query the latest region list.
    * 
    * This parameter is required.
    * 
@@ -98,7 +110,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the resource group to which the instance belongs. For more information, see [View the basic information of a resource group](https://help.aliyun.com/document_detail/151181.html).
+   * The ID of the resource group. For more information about resource groups, see [View basic information about a resource group](https://help.aliyun.com/document_detail/151181.html).
    * 
    * @example
    * rg-acfmyiu4ekp****
@@ -108,7 +120,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   resourceOwnerId?: number;
   /**
    * @remarks
-   * Specifies whether to display instance tags. Default value: False.
+   * Specifies whether to return instance tags. The default value is false.
    * 
    * @example
    * false
@@ -116,7 +128,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   showTags?: boolean;
   /**
    * @remarks
-   * The ID of the vSwitch to which the instance is connected.
+   * The ID of the vSwitch.
    * 
    * @example
    * vsw-bp1e7clcw529l773d****
@@ -124,7 +136,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   vSwitchId?: string;
   /**
    * @remarks
-   * The ID of the VPC in which the instance is deployed.
+   * The ID of the VPC.
    * 
    * @example
    * vpc-bp1nme44gek34slfc****
@@ -132,7 +144,7 @@ export class DescribeDBInstancesOverviewRequest extends $dara.Model {
   vpcId?: string;
   /**
    * @remarks
-   * The zone ID of the instance.
+   * The ID of the zone.
    * 
    * @example
    * cn-hangzhou-b