@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/CreateJobMonitorRuleRequest.ts

@@ -7,10 +7,11 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
    * @remarks
    * The threshold for triggering an alert.
    * 
-   * *   If **Type** is set to **delay**, the threshold must be an integer in units of seconds. You can specify the threshold based on your business requirements. To prevent jitters caused by network and database overloads, we recommend that you set the threshold to more than 10 seconds.
-   * *   If **Type** is set to **full_timeout**, the threshold must be an integer in units of hours.
+   * - If **Type** is set to **delay**, the unit is seconds and the value must be an integer. Set the threshold based on your business requirements. A value of 10 or greater is recommended to avoid alert fluctuations caused by network issues or database loads.
    * 
-   * > This parameter is required if **Type** is set to **delay** or **full_timeout** and **State** is set to **Y**.
+   * - If **Type** is set to **full_timeout**, the unit is hours and the value must be an integer.
+   * 
+   * > This parameter is required when **Type** is set to **delay** or **full_timeout** and **State** is set to **Y**.
    * 
    * @example
    * 11
@@ -18,7 +19,7 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   delayRuleTime?: number;
   /**
    * @remarks
-   * The ID of the data migration, data synchronization, or change tracking task. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
+   * The ID of the data migration, data synchronization, or change tracking task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to obtain the task ID.
    * 
    * This parameter is required.
    * 
@@ -36,9 +37,9 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   noticeValue?: number;
   /**
    * @remarks
-   * The statistical period of the incremental data verification task. Unit: minutes.
+   * The statistical period of the incremental verification task. Unit: minutes.
    * 
-   * > Valid values: 1, 3, 5, and 30.
+   * > Valid values: 1, 5, 10, and 30.
    * 
    * @example
    * 5
@@ -46,13 +47,9 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   period?: number;
   /**
    * @remarks
-   * The mobile numbers that receive alert notifications. Separate multiple mobile numbers with commas (,).
-   * 
-   * > 
-   * 
-   * *   This parameter is available only for users of the China site (aliyun.com). Only mobile numbers in the Chinese mainland are supported. You can specify up to 10 mobile numbers.
-   * 
-   * *   Users of the international site (alibabacloud.com) cannot receive notifications on alerts by using mobile numbers, but can configure alert rules for DTS tasks in the CloudMonitor console. For more information, see [Configure alert rules for DTS tasks in the CloudMonitor console](https://help.aliyun.com/document_detail/175876.html).
+   * The mobile phone numbers of alert contacts, separated by commas (,).
+   * >-  This parameter is supported only on the China site (aliyun.com) and only for the Chinese mainland mobile phone numbers. A maximum of 10 mobile phone numbers can be specified.
+   * - The international site does not support SMS-based alerting. You can only [set alert rules for DTS tasks through the CloudMonitor monitoring platform](https://help.aliyun.com/document_detail/175876.html).
    * 
    * @example
    * 1361234****,1371234****
@@ -60,7 +57,7 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   phone?: string;
   /**
    * @remarks
-   * The region ID of the DTS instance. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region in which the DTS instance resides. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -68,7 +65,7 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -78,8 +75,8 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
    * @remarks
    * Specifies whether to enable the alert rule. Valid values:
    * 
-   * *   **Y**: enables the alert rule.
-   * *   **N**: disables the alert rule.
+   * - **Y**: Enable the alert rule.
+   * - **N**: Disable the alert rule.
    * 
    * Default value: **Y**.
    * 
@@ -89,7 +86,7 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   state?: string;
   /**
    * @remarks
-   * The number of statistical periods of the incremental data verification task.
+   * The number of statistical periods for the incremental verification task.
    * 
    * @example
    * 2
@@ -97,13 +94,12 @@ export class CreateJobMonitorRuleRequest extends $dara.Model {
   times?: number;
   /**
    * @remarks
-   * The metric that is used to monitor the task. Valid values:
-   * 
-   * *   **delay**: the **Latency** metric.
-   * *   **error**: the **Status** metric.
-   * *   **full_timeout**: the **Full Timeout** metric.
+   * The type of the alert metric. Valid values:
+   * - **delay**: the **Latency** metric.
+   * - **error**: the **Migration Status** metric.
+   * - **full_timeout**: the **Full Migration Duration** metric.
    * 
-   * Default value: **error**. You must manually set this value.
+   * Default value: **error**. This parameter must be manually specified.
    * 
    * @example
    * delay

package/src/models/CreateJobMonitorRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateJobMonitorRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code. This parameter will be removed in the future.
+   * The error code. This parameter will be deprecated.
    * 
    * @example
    * 200
@@ -21,9 +21,8 @@ export class CreateJobMonitorRuleResponseBody extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. The value of this parameter is used to replace the \\*\\*%s\\*\\* variable in the value of **ErrMessage**.
-   * 
-   * > If the return value of **ErrMessage** is **The Value of Input Parameter %s is not valid** and the return value of **DynamicMessage** is **DtsJobId**, the specified value of **DtsJobId** is invalid.
+   * The dynamic error message used to replace the **%s** variable in the **ErrMessage** response parameter.
+   * > For example, if **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.
    * 
    * @example
    * DtsJobId
@@ -31,7 +30,7 @@ export class CreateJobMonitorRuleResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call failed.
    * 
    * @example
    * 403
@@ -39,7 +38,7 @@ export class CreateJobMonitorRuleResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned if the call failed.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -64,9 +63,8 @@ export class CreateJobMonitorRuleResponseBody extends $dara.Model {
   /**
    * @remarks
    * Indicates whether the request was successful. Valid values:
-   * 
-   * *   **true**
-   * *   **false**
+   * - **true**: The request was successful.
+   * - **false**: The request failed.
    * 
    * @example
    * true

package/src/models/CreateMigrationJobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateMigrationJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be discontinued.
    * 
    * @example
    * 12323344****
@@ -13,7 +13,7 @@ export class CreateMigrationJobRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The **ClientToken** parameter can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. Generate a value from your client to ensure that the value is unique among different requests. The **ClientToken** parameter supports only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88e9fe63****
@@ -23,9 +23,8 @@ export class CreateMigrationJobRequest extends $dara.Model {
    * @remarks
    * The specification of the data migration instance. Valid values: **small**, **medium**, **large**, **xlarge**, and **2xlarge**.
    * 
-   * > 
-   * *   For more information about the test performance of each specification, see [Specifications of data migration instances](https://help.aliyun.com/document_detail/26606.html).
-   * *   For more information about the pricing of data migration instances, see [Pricing](https://help.aliyun.com/document_detail/117780.html).
+   * > - For the test performance of each specification, see [Data migration specifications](https://help.aliyun.com/document_detail/26606.html).
+   * - For instance specifications and pricing, see [Pricing](https://help.aliyun.com/document_detail/117780.html).
    * 
    * This parameter is required.
    * 
@@ -36,7 +35,7 @@ export class CreateMigrationJobRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the data migration instance resides. The region ID of the data migration instance is the same as that of the destination database. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region of the data migration instance, which is the region of the destination database instance. For more information, see the supported [region list](https://help.aliyun.com/document_detail/141033.html).
    * 
    * This parameter is required.
    * 
@@ -46,7 +45,7 @@ export class CreateMigrationJobRequest extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The ID of the region where the data migration instance resides. You do not need to specify this parameter because this parameter will be removed in the future.
+   * The region of the data migration instance. You do not need to specify this parameter. This parameter will be discontinued.
    * 
    * @example
    * cn-hangzhou
@@ -54,7 +53,7 @@ export class CreateMigrationJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/CreateMigrationJobResponseBody.ts

@@ -21,7 +21,7 @@ export class CreateMigrationJobResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the data migration instance.
+   * The instance ID of the data migration instance.
    * 
    * @example
    * dtsi8911td9233****
@@ -29,7 +29,7 @@ export class CreateMigrationJobResponseBody extends $dara.Model {
   migrationJobId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * C166D79D-436B-45F0-B5A5-25E1959F****
@@ -37,7 +37,7 @@ export class CreateMigrationJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/CreateReverseDtsJobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateReverseDtsJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the synchronization or migration task, which can be queried by calling [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html).
+   * The ID of the synchronization or migration task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query the task ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateReverseDtsJobRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * Resource GroupId
+   * The ID of the resource group. This is a global parameter that does not need to be specified for this operation.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -23,7 +23,10 @@ export class CreateReverseDtsJobRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Shard Password
+   * The password of the shard in a MongoDB sharded cluster instance.
+   * 
+   * > - This parameter is available and required only when the source database instance is a MongoDB sharded cluster instance.
+   * - This parameter takes effect only when **ModifyAccount** is set to **true**.
    * 
    * @example
    * DTStest****
@@ -31,7 +34,7 @@ export class CreateReverseDtsJobRequest extends $dara.Model {
   shardPassword?: string;
   /**
    * @remarks
-   * Shard User name
+   * The account of the shard in a MongoDB sharded cluster instance.
    * 
    * @example
    * dtstest

package/src/models/CreateReverseDtsJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateReverseDtsJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the instance corresponding to the generated reverse task.
+   * The ID of the DTS instance that corresponds to the generated reverse task.
    * 
    * @example
    * dtsor1f9kr822l****
@@ -21,7 +21,7 @@ export class CreateReverseDtsJobResponseBody extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * Error code returned when the call fails.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -29,7 +29,7 @@ export class CreateReverseDtsJobResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * Error message returned when the call fails.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -37,7 +37,7 @@ export class CreateReverseDtsJobResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * Status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -45,7 +45,7 @@ export class CreateReverseDtsJobResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
@@ -53,7 +53,7 @@ export class CreateReverseDtsJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the request was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/CreateSubscriptionInstanceRequest.ts

@@ -5,9 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateSubscriptionInstanceRequestSourceEndpoint extends $dara.Model {
   /**
    * @remarks
-   * The type of the source instance. Valid values: **MySQL**, **PolarDB**, **DRDS**, and **Oracle**.
-   * 
-   * >  Default value: **MySQL**.
+   * 数据订阅的实例类型，取值为：**MySQL**、**PolarDB**、**DRDS**、**Oracle**。
+   * > 默认取值为：**MySQL**。
    * 
    * @example
    * MySQL
@@ -38,7 +37,7 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   sourceEndpoint?: CreateSubscriptionInstanceRequestSourceEndpoint;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter will be removed in the future.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be discontinued.
    * 
    * @example
    * 12323344****
@@ -46,7 +45,7 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The **ClientToken** parameter can contain only ASCII characters and cannot exceed 64 characters in length.
+   * The client token that is used to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among different requests. **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88e9fe63****
@@ -55,10 +54,10 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The billing method of the change tracking instance.
+   * The billing method.
    * 
-   * *   **Postpaid**: pay-as-you-go
-   * *   **Prepaid**: subscription
+   * - **Postpaid**: pay-as-you-go. This is the default value.
+   * - **Prepaid**: subscription.
    * 
    * @example
    * Prepaid
@@ -66,12 +65,12 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   payType?: string;
   /**
    * @remarks
-   * The billing cycle of the subscription instance. Valid values:
+   * The billing method of the subscription instance. Valid values:
    * 
-   * *   **Year**
-   * *   **Month**
+   * - **Year**: annual subscription.
+   * - **Month**: monthly subscription.
    * 
-   * >  You must specify this parameter only if you set the PayType parameter to **Prepaid**.
+   * > This parameter is valid and required only when PayType is set to **Prepaid** (subscription).
    * 
    * @example
    * Month
@@ -79,7 +78,7 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   period?: string;
   /**
    * @remarks
-   * The region ID of the change tracking instance. The region ID is the same as that of the source instance. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID. Set this parameter to the region where the subscription object resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * This parameter is required.
    * 
@@ -89,7 +88,7 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The region ID of the change tracking instance. You do not need to specify this parameter because this parameter will be removed in the future.
+   * The region to which the change tracking instance belongs. You do not need to specify this parameter. This parameter will be discontinued.
    * 
    * @example
    * cn-hangzhou
@@ -97,7 +96,7 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -105,12 +104,12 @@ export class CreateSubscriptionInstanceRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The subscription length.
+   * The purchase duration of the subscription instance.
    * 
-   * *   If the billing cycle is **Year**, the value range is **1 to 5**.
-   * *   If the billing cycle is **Month**, the value range is **1 to 60**.
+   * - If the billing method is set to **Year** (annual subscription), the valid values are **1 to 5**.
+   * - If the billing method is set to **Month** (monthly subscription), the valid values are **1 to 60**.
    * 
-   * >  You must specify this parameter only if you set the PayType parameter to **Prepaid**.
+   * > This parameter is valid and required only when PayType is set to **Prepaid** (subscription).
    * 
    * @example
    * 12

package/src/models/CreateSubscriptionInstanceResponseBody.ts

@@ -21,7 +21,7 @@ export class CreateSubscriptionInstanceResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 4E9564C5-F99D-4176-A6BA-2D7F2DC8****
@@ -29,7 +29,7 @@ export class CreateSubscriptionInstanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The ID of the change tracking instance.
+   * The change tracking instance ID.
    * 
    * @example
    * dtsfen11q2g23x****
@@ -37,7 +37,7 @@ export class CreateSubscriptionInstanceResponseBody extends $dara.Model {
   subscriptionInstanceId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true