@alicloud/dts20200101 1.8.7 → 1.9.0

package/src/models/ConfigureSubscriptionInstanceAlertRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter. This parameter will be deprecated.
    * 
    * @example
    * 12323344****
@@ -13,9 +13,9 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The mobile phone numbers of contacts for latency alerts. Separate multiple mobile phone numbers with commas (,).
-   * >- This parameter is supported only on the China site (aliyun.com). Only Chinese mainland mobile phone numbers are supported, and you can specify up to 10 mobile phone numbers.
-   * - China site (Chinese mainland) does not support Chinese mainland mobile phone alerts. You can only [configure alert rules for DTS tasks in CloudMonitor](https://help.aliyun.com/document_detail/175876.html).
+   * The mobile phone numbers of the contacts to receive latency alerts. Separate multiple mobile phone numbers with commas (,).
+   * > - This parameter is supported only on the Alibaba Cloud China site. Only mobile phone numbers in the Chinese mainland are supported, and you can specify up to 10 mobile phone numbers.
+   * - The Alibaba Cloud International site does not support mobile phone alerts. You can only [configure alert rules for DTS tasks by using CloudMonitor](https://help.aliyun.com/document_detail/175876.html).
    * 
    * @example
    * 1361234****,1371234****
@@ -25,11 +25,11 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
    * @remarks
    * Specifies whether to monitor the latency status. Valid values:
    * 
-   * - **enable**: yes.
-   * - **disable**: no.
+   * - **enable**: Yes.
+   * - **disable**: No.
    * 
    * > - Default value: **enable**.
-   * - You must specify at least one of this parameter and the **ErrorAlertStatus** parameter.
+   * - You must specify at least one of the **DelayAlertStatus** and **ErrorAlertStatus** parameters.
    * 
    * @example
    * enable
@@ -37,8 +37,8 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   delayAlertStatus?: string;
   /**
    * @remarks
-   * The threshold for triggering a latency alert. Unit: seconds. The value must be an integer. Set the threshold based on your business requirements. To avoid alert fluctuations caused by network issues or database loads, set the threshold to 10 seconds or more.
-   * > This parameter is required when **DelayAlertStatus** is set to **enable**.
+   * The threshold for triggering a latency alert. Unit: seconds. The value must be an integer. You can set the threshold based on your business requirements. Set the threshold to 10 seconds or more to avoid latency fluctuations caused by network or database loads.
+   * > This parameter is required when the **DelayAlertStatus** parameter is set to **enable**.
    * 
    * @example
    * 10
@@ -46,9 +46,9 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   delayOverSeconds?: string;
   /**
    * @remarks
-   * The mobile phone numbers of contacts for exception alerts. Separate multiple mobile phone numbers with commas (,).
-   * >- This parameter is supported only on the China site (aliyun.com). Only Chinese mainland mobile phone numbers are supported, and you can specify up to 10 mobile phone numbers.
-   * - China site (Chinese mainland) does not support Chinese mainland mobile phone alerts. You can only [configure alert rules for DTS tasks in CloudMonitor](https://help.aliyun.com/document_detail/175876.html).
+   * The mobile phone numbers of the contacts to receive abnormal status alerts. Separate multiple mobile phone numbers with commas (,).
+   * > - This parameter is supported only on the Alibaba Cloud China site. Only mobile phone numbers in the Chinese mainland are supported, and you can specify up to 10 mobile phone numbers.
+   * - The Alibaba Cloud International site does not support mobile phone alerts. You can only [configure alert rules for DTS tasks by using CloudMonitor](https://help.aliyun.com/document_detail/175876.html).
    * 
    * @example
    * 1361234****,1371234****
@@ -56,14 +56,14 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   errorAlertPhone?: string;
   /**
    * @remarks
-   * Specifies whether to monitor the exception status. Valid values:
+   * Specifies whether to monitor the abnormal status. Valid values:
    * 
-   * - **enable**: yes.
-   * - **disable**: no.
+   * - **enable**: Yes.
+   * - **disable**: No.
    * 
    * > - Default value: **enable**.
-   * - You must specify at least one of this parameter and the **DelayAlertStatus** parameter.
-   * - After you enable exception status monitoring, an alert is triggered when an exception is detected.
+   * - You must specify at least one of the **ErrorAlertStatus** and **DelayAlertStatus** parameters.
+   * - After the abnormal status monitoring feature is enabled, an alert is triggered if an exception is detected.
    * 
    * @example
    * enable
@@ -72,7 +72,7 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the change tracking instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID of the change tracking instance. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -80,7 +80,7 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/ConfigureSubscriptionInstanceAlertResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureSubscriptionInstanceAlertResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned when the call fails.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class ConfigureSubscriptionInstanceAlertResponseBody extends $dara.Model
   errCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned if the call fails.
    * 
    * @example
    * InternalError  The request processing has failed due to some unknown error.
@@ -21,7 +21,7 @@ export class ConfigureSubscriptionInstanceAlertResponseBody extends $dara.Model
   errMessage?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 0a2a047516051973705541561d****
@@ -29,7 +29,7 @@ export class ConfigureSubscriptionInstanceAlertResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/ConfigureSubscriptionInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Model {
   /**
    * @remarks
-   * 待订阅的数据库名称。
+   * The name of the database to be tracked.
    * 
    * @example
    * dtstestdata
@@ -13,8 +13,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   databaseName?: string;
   /**
    * @remarks
-   * 源数据库的连接地址。
-   * > 当源数据库为自建数据库时，本参数才可用且必须传入。
+   * The endpoint of the source database.
+   * > This parameter is available and required only when the source database is a self-managed database.
    * 
    * @example
    * 172.16.88.***
@@ -22,8 +22,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   IP?: string;
   /**
    * @remarks
-   * 源实例ID。
-   * > 源数据库的实例类型为RDS MySQL、PolarDB-X 1.0、PolarDB MySQL时，本参数才可用且必须传入。
+   * The instance ID of the source instance.
+   * > This parameter is available and required only when the source database is an ApsaraDB RDS for MySQL instance, a PolarDB-X 1.0 instance, or a PolarDB for MySQL cluster.
    * 
    * @example
    * rm-bp1zc3iyqe3qw****
@@ -31,16 +31,16 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   instanceID?: string;
   /**
    * @remarks
-   * 源数据库的实例类型，取值：
-   * - **RDS**：RDS MySQL。
-   * - **PolarDB**：PolarDB MySQL。
-   * - **LocalInstance**：有公网IP的自建数据库。
-   * - **ECS**：ECS上的自建数据库。
-   * - **Express**：通过专线接入的自建数据库。
-   * - **CEN**：通过云企业网CEN接入的自建数据库。
-   * - **dg**：通过数据库网关接入的自建数据库。
+   * The instance type of the source database. Valid values:
+   * - **RDS**: ApsaraDB RDS for MySQL.
+   * - **PolarDB**: PolarDB for MySQL.
+   * - **LocalInstance**: a self-managed database with a public IP address.
+   * - **ECS**: a self-managed database hosted on an ECS instance.
+   * - **Express**: a self-managed database connected over an Express Connect circuit.
+   * - **CEN**: a self-managed database connected over a Cloud Enterprise Network (CEN) instance.
+   * - **dg**: a self-managed database connected over a database gateway.
    * 
-   * > 支持自建数据库的数据库类型为MySQL、Oracle，您需要提前调用[CreateSubscriptionInstance](https://help.aliyun.com/document_detail/49436.html)设置。
+   * > Self-managed MySQL and Oracle databases are supported. You must call the [CreateSubscriptionInstance](https://help.aliyun.com/document_detail/49436.html) operation to configure the database type in advance.
    * 
    * @example
    * RDS
@@ -48,8 +48,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   instanceType?: string;
   /**
    * @remarks
-   * Oracle数据库的SID信息。
-   * > 当源数据库为自建Oracle时，且Oracle数据库为非RAC实例时，本参数才可用且必须传入。
+   * The system ID (SID) of the Oracle database.
+   * > This parameter is available and required only when the source database is a self-managed Oracle database and the Oracle database is not a Real Application Clusters (RAC) instance.
    * 
    * @example
    * testsid
@@ -57,8 +57,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   oracleSID?: string;
   /**
    * @remarks
-   * 源实例所属的阿里云账号ID。
-   * > 仅在配置跨阿里云账号的数据订阅时本参数才可用，且必须传入。
+   * The Alibaba Cloud account ID of the source instance.
+   * > This parameter is available and required only when you configure change tracking across Alibaba Cloud accounts.
    * 
    * @example
    * 140692647406****
@@ -66,7 +66,7 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   ownerID?: string;
   /**
    * @remarks
-   * 源实例的数据库账号密码。
+   * The password of the database account of the source instance.
    * 
    * @example
    * Test123456
@@ -74,8 +74,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   password?: string;
   /**
    * @remarks
-   * 源数据库的服务端口。
-   * > 当源数据库为自建数据库时，本参数才可用且必须传入。
+   * The service port number of the source database.
+   * > This parameter is available and required only when the source database is a self-managed database.
    * 
    * @example
    * 3306
@@ -83,8 +83,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   port?: string;
   /**
    * @remarks
-   * 源实例的授权角色。当源实例与配置订阅任务所属阿里云账号不同时，需传入该参数，来指定源实例的授权角色，以允许配置订阅任务所属阿里云账号访问源实例的实例信息。
-   * > 角色所需的权限及授权方式，请参见[跨阿里云账号数据迁移或同步时如何配置RAM授权](https://help.aliyun.com/document_detail/48468.html)。
+   * The RAM role that is authorized to access the source instance. If the source instance and the change tracking task belong to different Alibaba Cloud accounts, you must specify this parameter to authorize the Alibaba Cloud account that owns the change tracking task to access the source instance.
+   * > For more information about the required permissions and authorization methods for the RAM role, see [Configure RAM authorization for cross-account data migration or synchronization](https://help.aliyun.com/document_detail/48468.html).
    * 
    * @example
    * ram-for-dts
@@ -92,8 +92,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   role?: string;
   /**
    * @remarks
-   * 源实例的数据库账号。
-   * > 订阅不同的数据库所需的权限有所差异，详情请参见[DTS数据订阅方案概览](https://help.aliyun.com/document_detail/145715.html)中对应的配置案例。
+   * The database account of the source instance.
+   * > The required permissions vary based on the database to be tracked. For more information, see the corresponding configuration examples in [Overview of DTS change tracking solutions](https://help.aliyun.com/document_detail/145715.html).
    * 
    * @example
    * dtstestaccount
@@ -141,10 +141,10 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
 export class ConfigureSubscriptionInstanceRequestSubscriptionDataType extends $dara.Model {
   /**
    * @remarks
-   * 是否订阅DDL类型的数据，取值：
+   * Specifies whether to track data definition language (DDL) operations. Valid values:
    * 
-   * - **true**：是，为默认值。
-   * - **false**：否。
+   * - **true**: yes. This is the default value.
+   * - **false**: no.
    * 
    * This parameter is required.
    * 
@@ -154,9 +154,9 @@ export class ConfigureSubscriptionInstanceRequestSubscriptionDataType extends $d
   DDL?: boolean;
   /**
    * @remarks
-   * 是否订阅DML类型的数据，取值：
-   * - **true**：是，为默认值。
-   * - **false**：否。
+   * Specifies whether to track data manipulation language (DML) operations. Valid values:
+   * - **true**: yes. This is the default value.
+   * - **false**: no.
    * 
    * This parameter is required.
    * 
@@ -190,8 +190,8 @@ export class ConfigureSubscriptionInstanceRequestSubscriptionDataType extends $d
 export class ConfigureSubscriptionInstanceRequestSubscriptionInstance extends $dara.Model {
   /**
    * @remarks
-   * 订阅实例的专有网络ID。
-   * > 当**SubscriptionInstanceNetworkType**取值为**vpc**时，本参数才可用且必须传入。
+   * The VPC ID of the change tracking instance.
+   * > This parameter is available and required only when **SubscriptionInstanceNetworkType** is set to **vpc**.
    * 
    * @example
    * vpc-bp1vwnn14rqpyiczj****
@@ -199,8 +199,8 @@ export class ConfigureSubscriptionInstanceRequestSubscriptionInstance extends $d
   VPCId?: string;
   /**
    * @remarks
-   * 订阅实例的虚拟交换机ID。
-   * > 当**SubscriptionInstanceNetworkType**取值为**vpc**时，本参数才可用且必须传入。
+   * The vSwitch ID of the change tracking instance.
+   * > This parameter is available and required only when **SubscriptionInstanceNetworkType** is set to **vpc**.
    * 
    * @example
    * vsw-bp10df3mxae6lpmku****
@@ -235,7 +235,7 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   subscriptionInstance?: ConfigureSubscriptionInstanceRequestSubscriptionInstance;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated soon.
    * 
    * @example
    * 12323344****
@@ -244,7 +244,8 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the change tracking instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The ID of the region where the change tracking instance resides. For more information, see
+   * [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -252,7 +253,7 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -274,15 +275,15 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
    * > Specify a descriptive name for easy identification. The name does not need to be unique.
    * 
    * @example
-   * MySQL订阅
+   * MySQL change tracking
    */
   subscriptionInstanceName?: string;
   /**
    * @remarks
-   * The network type of the change tracking instance. The only valid value is **vpc**, which indicates a virtual private cloud (VPC).
+   * The network type of the change tracking instance. Set the value to **vpc**, which specifies a virtual private cloud (VPC).
    * 
-   * > - If you specify this parameter, the change tracking instance is defined as the new version. You must also correctly set the **SubscriptionInstance.VPCId** and **SubscriptionInstance.VSwitchID** parameters. If you do not specify this parameter, the change tracking instance is defined as the legacy version.
-   * > - The legacy version supports change tracking for self-managed MySQL, ApsaraDB RDS for MySQL, and DRDS. The new version supports change tracking for self-managed MySQL, ApsaraDB RDS for MySQL, PolarDB for MySQL, and Oracle.
+   * > - If you specify this parameter, the change tracking instance is defined as a new version instance, and you must also correctly set the **SubscriptionInstance.VPCId** and **SubscriptionInstance.VSwitchID** parameters. If you do not specify this parameter, the change tracking instance is defined as a legacy instance.
+   * - Legacy change tracking instances support tracking data from self-managed MySQL databases, ApsaraDB RDS for MySQL instances, and DRDS instances. New version change tracking instances support tracking data from self-managed MySQL databases, ApsaraDB RDS for MySQL instances, PolarDB for MySQL clusters, and Oracle databases.
    * 
    * @example
    * vpc
@@ -290,7 +291,7 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   subscriptionInstanceNetworkType?: string;
   /**
    * @remarks
-   * The objects to be subscribed to. The value is a JSON string that supports regular expressions. For more information, see [Subscription object configuration](https://help.aliyun.com/document_detail/141902.html).
+   * The objects to be tracked. The value is a JSON string and supports specific regular expressions. For more information, see [Configure the objects to be tracked](https://help.aliyun.com/document_detail/141902.html).
    * 
    * This parameter is required.
    * 

package/src/models/ConfigureSubscriptionInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureSubscriptionInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned if the call failed.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class ConfigureSubscriptionInstanceResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * The request processing has failed due to some unknown error.