@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/ConfigureMigrationJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ConfigureMigrationJobResponseBody 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 error code returned if the request failed.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class ConfigureMigrationJobResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The error message returned if the request failed.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -21,7 +21,7 @@ export class ConfigureMigrationJobResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The start offset of incremental data migration. The value is a UNIX timestamp. Unit: seconds.
+   * The request ID.
    * 
    * @example
    * 40E35BD9-002E-4D63-9BE5-FBA48833****
@@ -29,9 +29,10 @@ export class ConfigureMigrationJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The SID of the Oracle database.
+   * Indicates whether the request was successful. Valid values:
    * 
-   * >  You must specify this parameter only if the **DestinationEndpoint.EngineName** parameter is set to **Oracle** and the **Oracle** database is deployed in a non-RAC architecture.
+   * - **true**: The request was successful.
+   * - **false**: The request failed.
    * 
    * @example
    * true

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 this parameter will be removed in the future.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated.
    * 
    * @example
    * 12323344****
@@ -13,11 +13,9 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The mobile phone numbers that receive latency-related alerts. Separate mobile phone numbers with commas (,).
-   * 
-   * > 
-   * *   This parameter is available only for China site (aliyun.com) users. Only mobile phone numbers in the Chinese mainland are supported. Up to 10 mobile phone numbers can be specified.
-   * *   International site (alibabacloud.com) users cannot receive alerts by using mobile phones, but can [set alert rules for DTS tasks in the Cloud Monitor console](https://help.aliyun.com/document_detail/175876.html).
+   * 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).
    * 
    * @example
    * 1361234****,1371234****
@@ -25,14 +23,13 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   delayAlertPhone?: string;
   /**
    * @remarks
-   * Specifies whether to monitor task latency. Valid values:
+   * Specifies whether to monitor the latency status. Valid values:
    * 
-   * *   **enable**: yes
-   * *   **disable**: no
+   * - **enable**: yes.
+   * - **disable**: no.
    * 
-   * > 
-   * *   The default value is **enable**.
-   * *   You must specify at least one of the DelayAlertStatus and **ErrorAlertStatus** parameters.
+   * > - Default value: **enable**.
+   * - You must specify at least one of this parameter and the **ErrorAlertStatus** parameter.
    * 
    * @example
    * enable
@@ -40,9 +37,8 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   delayAlertStatus?: string;
   /**
    * @remarks
-   * The threshold for triggering latency alerts. The unit is seconds and the value must be an integer. You can set the threshold based on your business needs. To avoid delay fluctuations caused by network and database loads, we recommend that you set the threshold to more than 10 seconds.
-   * 
-   * >  If the **DelayAlertStatus** parameter is set to **enable**, this parameter must be specified.
+   * 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**.
    * 
    * @example
    * 10
@@ -50,11 +46,9 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   delayOverSeconds?: string;
   /**
    * @remarks
-   * The mobile phone numbers that receive status-related alerts. Separate mobile phone numbers with commas (,).
-   * 
-   * > 
-   * *   This parameter is available only for China site (aliyun.com) users. Only mobile phone numbers in the Chinese mainland are supported. Up to 10 mobile phone numbers can be specified.
-   * *   International site (alibabacloud.com) users cannot receive alerts by using mobile phones, but can [set alert rules for DTS tasks in the Cloud Monitor console](https://help.aliyun.com/document_detail/175876.html).
+   * 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).
    * 
    * @example
    * 1361234****,1371234****
@@ -62,15 +56,14 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   errorAlertPhone?: string;
   /**
    * @remarks
-   * Specifies whether to monitor task status. Valid values:
+   * Specifies whether to monitor the exception status. Valid values:
    * 
-   * *   **enable**: yes
-   * *   **disable**: no
+   * - **enable**: yes.
+   * - **disable**: no.
    * 
-   * > 
-   * *   The default value is **enable**.
-   * *   You must specify at least one of the **DelayAlertStatus** and ErrorAlertStatus parameters.
-   * *   If the task that you monitor enters an abnormal state, an alert is triggered.
+   * > - 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.
    * 
    * @example
    * enable
@@ -79,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 [List of 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
@@ -87,7 +80,7 @@ export class ConfigureSubscriptionInstanceAlertRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @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 if the call failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class ConfigureSubscriptionInstanceAlertResponseBody extends $dara.Model
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned when 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 ID of the request.
+   * The request ID.
    * 
    * @example
    * 0a2a047516051973705541561d****
@@ -29,7 +29,7 @@ export class ConfigureSubscriptionInstanceAlertResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was 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 source database.
+   * 待订阅的数据库名称。
    * 
    * @example
    * dtstestdata
@@ -13,9 +13,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   databaseName?: string;
   /**
    * @remarks
-   * The endpoint of the source database.
-   * 
-   * > This parameter is available and required only if the source database is a self-managed database.
+   * 源数据库的连接地址。
+   * > 当源数据库为自建数据库时，本参数才可用且必须传入。
    * 
    * @example
    * 172.16.88.***
@@ -23,9 +22,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   IP?: string;
   /**
    * @remarks
-   * The ID of the source instance.
-   * 
-   * > This parameter is available and required only if the source instance is an ApsaraDB RDS for MySQL instance, a PolarDB-X 1.0 instance, or a PolarDB for MySQL cluster.
+   * 源实例ID。
+   * > 源数据库的实例类型为RDS MySQL、PolarDB-X 1.0、PolarDB MySQL时，本参数才可用且必须传入。
    * 
    * @example
    * rm-bp1zc3iyqe3qw****
@@ -33,17 +31,16 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   instanceID?: string;
   /**
    * @remarks
-   * The type of the source instance. Valid values:
+   * 源数据库的实例类型，取值：
+   * - **RDS**：RDS MySQL。
+   * - **PolarDB**：PolarDB MySQL。
+   * - **LocalInstance**：有公网IP的自建数据库。
+   * - **ECS**：ECS上的自建数据库。
+   * - **Express**：通过专线接入的自建数据库。
+   * - **CEN**：通过云企业网CEN接入的自建数据库。
+   * - **dg**：通过数据库网关接入的自建数据库。
    * 
-   * *   **RDS**: ApsaraDB RDS for MySQL instance
-   * *   **PolarDB**: PolarDB for MySQL cluster.
-   * *   **LocalInstance**: self-managed database with a public IP address
-   * *   **ECS**: self-managed database hosted on an Elastic Compute Service (ECS) instance
-   * *   **Express**: self-managed database connected over Express Connect
-   * *   **CEN**: self-managed database connected over Cloud Enterprise Network (CEN)
-   * *   **dg**: self-managed database connected over Database Gateway
-   * 
-   * > The engine of a self-managed database can be MySQL or Oracle. You must specify the engine type when you call the [CreateSubscriptionInstance](https://help.aliyun.com/document_detail/49436.html) operation.
+   * > 支持自建数据库的数据库类型为MySQL、Oracle，您需要提前调用[CreateSubscriptionInstance](https://help.aliyun.com/document_detail/49436.html)设置。
    * 
    * @example
    * RDS
@@ -51,9 +48,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   instanceType?: string;
   /**
    * @remarks
-   * The system ID (SID) of the Oracle database.
-   * 
-   * > This parameter is available and required only if the source database is a self-managed Oracle database and the Oracle database is deployed in a non-RAC architecture.
+   * Oracle数据库的SID信息。
+   * > 当源数据库为自建Oracle时，且Oracle数据库为非RAC实例时，本参数才可用且必须传入。
    * 
    * @example
    * testsid
@@ -61,9 +57,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   oracleSID?: string;
   /**
    * @remarks
-   * The ID of the Alibaba Cloud account to which the source database belongs.
-   * 
-   * > This parameter is available and required only if you track data changes across different Alibaba Cloud accounts.
+   * 源实例所属的阿里云账号ID。
+   * > 仅在配置跨阿里云账号的数据订阅时本参数才可用，且必须传入。
    * 
    * @example
    * 140692647406****
@@ -71,7 +66,7 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   ownerID?: string;
   /**
    * @remarks
-   * The password of the account that is used to connect to the source database.
+   * 源实例的数据库账号密码。
    * 
    * @example
    * Test123456
@@ -79,9 +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 if the source database is a self-managed database.
+   * 源数据库的服务端口。
+   * > 当源数据库为自建数据库时，本参数才可用且必须传入。
    * 
    * @example
    * 3306
@@ -89,9 +83,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   port?: string;
   /**
    * @remarks
-   * The RAM role that is authorized to access the source database. This parameter is required if the source database does not belong to the Alibaba Cloud account that you use to configure the change tracking task. In this case, you must authorize the Alibaba Cloud account to access the source database by using a RAM role.
-   * 
-   * > For more information about the permissions that are required for the RAM role and how to grant permissions to the RAM role, see [Configure RAM authorization for cross-account data migration and synchronization](https://help.aliyun.com/document_detail/48468.html).
+   * 源实例的授权角色。当源实例与配置订阅任务所属阿里云账号不同时，需传入该参数，来指定源实例的授权角色，以允许配置订阅任务所属阿里云账号访问源实例的实例信息。
+   * > 角色所需的权限及授权方式，请参见[跨阿里云账号数据迁移或同步时如何配置RAM授权](https://help.aliyun.com/document_detail/48468.html)。
    * 
    * @example
    * ram-for-dts
@@ -99,9 +92,8 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
   role?: string;
   /**
    * @remarks
-   * The username of the account that is used to connect to the source database.
-   * 
-   * > The permissions that are required for the database account vary based on change tracking scenarios. For more information, see [Overview of change tracking scenarios](https://help.aliyun.com/document_detail/145715.html).
+   * 源实例的数据库账号。
+   * > 订阅不同的数据库所需的权限有所差异，详情请参见[DTS数据订阅方案概览](https://help.aliyun.com/document_detail/145715.html)中对应的配置案例。
    * 
    * @example
    * dtstestaccount
@@ -149,10 +141,10 @@ export class ConfigureSubscriptionInstanceRequestSourceEndpoint extends $dara.Mo
 export class ConfigureSubscriptionInstanceRequestSubscriptionDataType extends $dara.Model {
   /**
    * @remarks
-   * Specifies whether to track DDL statements. Default value: true. Valid values:
+   * 是否订阅DDL类型的数据，取值：
    * 
-   * *   **true**: tracks DDL statements.
-   * *   **false**: does not track DDL statements.
+   * - **true**：是，为默认值。
+   * - **false**：否。
    * 
    * This parameter is required.
    * 
@@ -162,10 +154,9 @@ export class ConfigureSubscriptionInstanceRequestSubscriptionDataType extends $d
   DDL?: boolean;
   /**
    * @remarks
-   * Specifies whether to track DML statements. Default value: true. Valid values:
-   * 
-   * *   **true**: tracks DML statements.
-   * *   **false**: does not track DML statements.
+   * 是否订阅DML类型的数据，取值：
+   * - **true**：是，为默认值。
+   * - **false**：否。
    * 
    * This parameter is required.
    * 
@@ -199,9 +190,8 @@ export class ConfigureSubscriptionInstanceRequestSubscriptionDataType extends $d
 export class ConfigureSubscriptionInstanceRequestSubscriptionInstance extends $dara.Model {
   /**
    * @remarks
-   * The ID of the VPC in which the change tracking instance is deployed.
-   * 
-   * > This parameter is available and required only if the **SubscriptionInstanceNetworkType** parameter is set to **vpc**.
+   * 订阅实例的专有网络ID。
+   * > 当**SubscriptionInstanceNetworkType**取值为**vpc**时，本参数才可用且必须传入。
    * 
    * @example
    * vpc-bp1vwnn14rqpyiczj****
@@ -209,9 +199,8 @@ export class ConfigureSubscriptionInstanceRequestSubscriptionInstance extends $d
   VPCId?: string;
   /**
    * @remarks
-   * The ID of the vSwitch in the specified VPC.
-   * 
-   * > This parameter is available and required only if the **SubscriptionInstanceNetworkType** parameter is set to **vpc**.
+   * 订阅实例的虚拟交换机ID。
+   * > 当**SubscriptionInstanceNetworkType**取值为**vpc**时，本参数才可用且必须传入。
    * 
    * @example
    * vsw-bp10df3mxae6lpmku****
@@ -246,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 this parameter is about to be discontinued.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because it will be deprecated.
    * 
    * @example
    * 12323344****
@@ -254,13 +243,16 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   accountId?: string;
   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).
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
-   * 资源组ID。
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -279,22 +271,18 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   /**
    * @remarks
    * The name of the change tracking instance.
-   * 
-   * > We recommend that you specify a descriptive name for easy identification. You do not need to use a unique name.
+   * > Specify a descriptive name for easy identification. The name does not need to be unique.
    * 
    * @example
-   * MySQL Subscription
+   * MySQL订阅
    */
   subscriptionInstanceName?: string;
   /**
    * @remarks
-   * The network type of the change tracking instance. Set the value to **vpc**, which specifies the Virtual Private Cloud (VPC) network type.
-   * 
-   * > 
-   * 
-   * *   To use the new version of the change tracking feature, you must specify the SubscriptionInstanceNetworkType parameter. You must also specify the **SubscriptionInstance.VPCId** and **SubscriptionInstance.VSwitchID** parameters. If you do not specify the SubscriptionInstanceNetworkType parameter, the previous version of the change tracking feature is used.
+   * The network type of the change tracking instance. The only valid value is **vpc**, which indicates a virtual private cloud (VPC).
    * 
-   * *   The previous version of the change tracking feature supports self-managed MySQL databases, ApsaraDB RDS for MySQL instances, and PolarDB-X 1.0 instances. The new version of the change tracking feature supports self-managed MySQL databases, ApsaraDB RDS for MySQL instances, PolarDB for MySQL clusters, and Oracle databases.
+   * > - 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.
    * 
    * @example
    * vpc
@@ -302,7 +290,7 @@ export class ConfigureSubscriptionInstanceRequest extends $dara.Model {
   subscriptionInstanceNetworkType?: string;
   /**
    * @remarks
-   * The objects for which you want to track data changes. The value is a JSON string and can contain regular expressions. For more information, see [SubscriptionObjects](https://help.aliyun.com/document_detail/141902.html).
+   * 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).
    * 
    * 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 request fails.
+   * The error code returned if the call failed.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class ConfigureSubscriptionInstanceResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request fails.
+   * The error message returned if the call failed.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -21,7 +21,7 @@ export class ConfigureSubscriptionInstanceResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0CC15092-8957-4532-B559-B4FB80AC****