@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/ModifyDtsJobEndpointResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobEndpointResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Error code returned when the call fails.
+   * The error code returned if the call failed.
    * 
    * @example
    * DTS.Msg.InvalidEndpoint
@@ -13,7 +13,7 @@ export class ModifyDtsJobEndpointResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * Error message returned when the call fails.
+   * The error message returned if the call failed.
    * 
    * @example
    * The endpoint is invalid.
@@ -21,7 +21,7 @@ export class ModifyDtsJobEndpointResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * Status code.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -29,7 +29,7 @@ export class ModifyDtsJobEndpointResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * request ID
+   * The request ID.
    * 
    * @example
    * 3FA98DF2-2F81-51FF-8A38-AA5112DD****
@@ -37,7 +37,7 @@ export class ModifyDtsJobEndpointResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the request was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/ModifyDtsJobNameRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobNameRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the DTS task. The DTS task can be a data migration, data synchronization, or change tracking task.
+   * The ID of the data migration, data synchronization, or change tracking task.
    * 
    * This parameter is required.
    * 
@@ -15,19 +15,18 @@ export class ModifyDtsJobNameRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The new name of the DTS task.
-   * 
-   * >  We recommend that you specify a descriptive name for easy identification. You do not need to use a unique name.
+   * The new name of the task.
+   * > Configure a descriptive name that has business meaning (uniqueness is not required) for easy identification.
    * 
    * This parameter is required.
    * 
    * @example
-   * dtstest
+   * RDS间迁移
    */
   dtsJobName?: string;
   /**
    * @remarks
-   * The ID of the region in which the DTS instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID of the task. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-beijing
@@ -35,7 +34,7 @@ export class ModifyDtsJobNameRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource GroupId
+   * The resource group ID.
    * 
    * @example
    * rg-aekzfkjjb5gyy6i
@@ -43,8 +42,9 @@ export class ModifyDtsJobNameRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Whether it is a seamless integration (Zero-ETL) task, the value can be:
-   * - **false**: No. - **true**: Yes.
+   * Specifies whether the node is a seamless integration (zero-ETL) node. Valid values:
+   * - **true**: The node is a seamless integration (zero-ETL) node.
+   * - **false**: The node is not a seamless integration (zero-ETL) node.
    * 
    * @example
    * true

package/src/models/ModifyDtsJobNameResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobNameResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code. This parameter is going to be removed in the future.
+   * The error code. This parameter will be deprecated.
    * 
    * @example
    * 200
@@ -13,9 +13,8 @@ export class ModifyDtsJobNameResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. 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** in the request is invalid.
+   * The dynamic error message, which is used to replace the **%s** placeholder in the **ErrMessage** response parameter.
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.
    * 
    * @example
    * DtsJobId
@@ -23,7 +22,7 @@ export class ModifyDtsJobNameResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -31,7 +30,7 @@ export class ModifyDtsJobNameResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -39,7 +38,7 @@ export class ModifyDtsJobNameResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The HTTP status code returned.
+   * The HTTP status code.
    * 
    * @example
    * 200

package/src/models/ModifyDtsJobPasswordRequest.ts

@@ -5,9 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobPasswordRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data migration, data synchronization, or change tracking instance.
-   * 
-   * >  You can call the [DescribeMigrationJobs](https://help.aliyun.com/document_detail/208139.html), [DescribeSubscriptionInstances](https://help.aliyun.com/document_detail/49442.html), or [DescribeSynchronizationJobs](https://help.aliyun.com/document_detail/49454.html) operation to query the instance ID
+   * The instance ID of the data migration, synchronization, or subscribe instance.
    * 
    * @example
    * dtsl3m1213ye7l****
@@ -15,7 +13,7 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   dtsInstanceId?: string;
   /**
    * @remarks
-   * The ID of the DTS task. The DTS task can be a data migration, data synchronization, or change tracking task.
+   * The ID of the data migration, synchronization, or change tracking task.
    * 
    * @example
    * l3m1213ye7l****
@@ -23,12 +21,12 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The database to which the password belongs. Valid values:
+   * The database to which the account belongs. Valid values:
    * 
-   * *   **src**: source database.
-   * *   **dest**: destination database.
+   * - **src**: the source database.
+   * - **dest**: the destination database.
    * 
-   * >  This parameter is required.
+   * > This parameter is required.
    * 
    * @example
    * src
@@ -36,9 +34,8 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   endpoint?: string;
   /**
    * @remarks
-   * The new password.
-   * 
-   * >  This parameter is required and cannot be set to a value that is the same as the current password.
+   * The new password for the database account.
+   * > This parameter is required and must be different from the current password.
    * 
    * @example
    * Test123456
@@ -46,7 +43,7 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   password?: string;
   /**
    * @remarks
-   * The ID of the region where the DTS instance resides. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID of the instance. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -54,7 +51,7 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -62,8 +59,12 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Synchronization direction, with values:
-   * - **Forward** (default): Forward. - **Reverse**: Reverse.
+   * The synchronization direction. Valid values:
+   * - **Forward**: forward.
+   * - **Reverse**: reverse.
+   * 
+   * > - Default value: **Forward**.
+   * - This parameter is required only when the synchronization topology of the data synchronization instance is two-way synchronization.
    * 
    * @example
    * Forward
@@ -71,9 +72,7 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   synchronizationDirection?: string;
   /**
    * @remarks
-   * The account of the source or destination database.
-   * 
-   * >  This parameter is required.
+   * The username of the database account to modify.
    * 
    * @example
    * dtstest
@@ -81,8 +80,9 @@ export class ModifyDtsJobPasswordRequest extends $dara.Model {
   userName?: string;
   /**
    * @remarks
-   * Whether it is a seamless integration (Zero-ETL) task, the value can be:
-   * - **false**: No. - **true**: Yes.
+   * Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values:
+   * - **true**
+   * - **false**.
    * 
    * @example
    * false

package/src/models/ModifyDtsJobPasswordResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobPasswordResponseBody 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
@@ -13,9 +13,8 @@ export class ModifyDtsJobPasswordResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. 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** in the request is invalid.
+   * The dynamic error message used to replace the **%s** placeholder 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
@@ -23,7 +22,7 @@ export class ModifyDtsJobPasswordResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call failed.
    * 
    * @example
    * InternalError
@@ -31,7 +30,7 @@ export class ModifyDtsJobPasswordResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message that is returned if the request failed.
+   * The error message returned if the call failed.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -39,7 +38,7 @@ export class ModifyDtsJobPasswordResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The status code returned.
+   * The HTTP status code.
    * 
    * @example
    * 200
@@ -55,7 +54,7 @@ export class ModifyDtsJobPasswordResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/ModifyDtsJobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobRequest extends $dara.Model {
   /**
    * @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. You can use the client to generate the value, but you must make sure that it is unique among different requests. **ClientToken** can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88e9fe63****
@@ -13,10 +13,10 @@ export class ModifyDtsJobRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Specifies whether to perform full data migration or synchronization. Valid values:
+   * Specifies whether to perform full data migration or initial full data synchronization. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: yes.
+   * - **false**: no.
    * 
    * @example
    * true
@@ -26,8 +26,8 @@ export class ModifyDtsJobRequest extends $dara.Model {
    * @remarks
    * Specifies whether to perform incremental data migration or synchronization. Valid values:
    * 
-   * *   **false**
-   * *   **true**
+   * - **false**: no.
+   * - **true**: yes.
    * 
    * @example
    * true
@@ -35,13 +35,12 @@ export class ModifyDtsJobRequest extends $dara.Model {
   dataSynchronization?: boolean;
   /**
    * @remarks
-   * The objects of the data synchronization task after modification. The value must be a JSON string. For more information, see [Objects of DTS tasks](https://help.aliyun.com/document_detail/209545.html).
-   * 
-   * > 
-   * 
-   * *   The new value of DbList overwrites the original value. Make sure that all the objects that you want to synchronize are specified. Otherwise, some objects may be lost. Specify this parameter with caution.
-   * 
-   * *   Before you call the ModifyDtsJob operation, we recommend that you call the [DescribeDtsJobDetail](https://help.aliyun.com/document_detail/208925.html) operation to query the current objects of the data synchronization task. Then, you can specify the new objects based on your business requirements. For example, if the current objects are Table A and Table B and you need to add Table C, you must specify Table A, Table B, and Table C for this parameter.
+   * The modified synchronization objects, in JSON format. For more information about the definition, see [Objects of DTS tasks](https://help.aliyun.com/document_detail/209545.html).
+   * - The original DbList is overwritten by the new DbList. Make sure that the new DbList contains all the objects that need to be synchronized. Otherwise, synchronization objects may be lost. Modify this parameter with caution.
+   * - Call [DescribeDtsJobDetail](https://help.aliyun.com/document_detail/208925.html) to query the current synchronization objects before you modify them based on your business requirements. For example, if the current objects are tables A and B, and you want to add table C, specify tables A, B, and C in this parameter.
+   * - The maximum size of DbList is 1 MB.
+   * - If DbList contains filter conditions, the total length of DbList (including filter conditions) cannot exceed 1 MB.
+   * - For distributed tasks (such as migration or synchronization tasks whose source is PolarDB-X 1.0), DbList is split based on physical shards and multiple subtasks are generated. The maximum size of DbList for each subtask is 1 MB.
    * 
    * @example
    * {"dtstest":{"name":"dtstest","all":true}}
@@ -49,7 +48,7 @@ export class ModifyDtsJobRequest extends $dara.Model {
   dbList?: { [key: string]: any };
   /**
    * @remarks
-   * The ID of the data synchronization instance.
+   * The instance ID of the data synchronization instance.
    * 
    * This parameter is required.
    * 
@@ -59,7 +58,7 @@ export class ModifyDtsJobRequest extends $dara.Model {
   dtsInstanceId?: string;
   /**
    * @remarks
-   * The synchronization task ID. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
+   * The ID of the synchronization task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query the task ID.
    * 
    * @example
    * fpx1149rw7p***
@@ -67,7 +66,7 @@ export class ModifyDtsJobRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The operator that is related to the extract, transform, and load (ETL) feature and dedicated to T+1 business.
+   * A field dedicated to T+1 business scenarios. This is an ETL operator and a business-specific field.
    * 
    * @example
    * {
@@ -113,7 +112,7 @@ export class ModifyDtsJobRequest extends $dara.Model {
   etlOperatorColumnReference?: string;
   /**
    * @remarks
-   * The endpoint of the Object Storage Service (OSS) bucket in which the files to be synchronized are stored.
+   * The OSS URL of the synchronization file.
    * 
    * @example
    * http://db-list-os-file.oss-cn-shanghai.aliyuncs.com/8e42_12185******43989_************
@@ -129,7 +128,7 @@ export class ModifyDtsJobRequest extends $dara.Model {
   filterTableName?: string;
   /**
    * @remarks
-   * The method that is used to modify the data synchronization task. If you do not specify the parameter, the objects of the data synchronization task are modified by default. If you specify UPDATE_RESERVED for the parameter, the reserved parameters are modified.
+   * The method used to modify the synchronization task. If this parameter is not specified, the synchronization objects are modified by default. Set this parameter to UPDATE_RESERVED to modify reserved parameters.
    * 
    * @example
    * UPDATE_RESERVED
@@ -137,7 +136,7 @@ export class ModifyDtsJobRequest extends $dara.Model {
   modifyTypeEnum?: string;
   /**
    * @remarks
-   * The ID of the region in which the data synchronization instance resides. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region in which the instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -145,15 +144,15 @@ export class ModifyDtsJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The reserved parameters of the data synchronization task. You can add reserved parameters instead of overwriting the existing reserved parameters. The value of the parameter is a MAP JSON string. You can specify this parameter to meet special requirements, such as specifying whether to automatically start the precheck of the data synchronization task. For more information, see [MigrationReserved](https://help.aliyun.com/document_detail/176470.html).
+   * The reserved parameters of DTS. The update method is append rather than overwrite. The value is in the MAP JSON format. You can specify this parameter to meet special requirements, such as whether to automatically start a precheck. The usage is similar to that of the Reserve parameter. For details, see [Reserve parameter description](https://help.aliyun.com/document_detail/273111.html).
    * 
    * @example
-   * {\\"srcHostPorts\\":\\"\\",\\"whitelist.dms.online.ddl.enable\\":false,\\"filterDDL\\":false,\\"sqlparser.dms.original.ddl\\":true,\\"srcOracleType\\":\\"sid\\",\\"maxRetryTime\\":43200,\\"destSSL\\":\\"0\\",\\"destOracleType\\":\\"sid\\",\\"srcSSL\\":\\"0\\",\\"dbListCaseChangeMode\\":\\"default\\",\\"SourceEngineVersion\\":\\"8.0.18\\",\\"srcNetType\\":\\"VPC\\",\\"destNetType\\":\\"VPC\\",\\"srcVpcNetMappingInst\\":\\"172.16.1**.**:10803\\",\\"destVpcNetMappingInst\\":\\"172.16.1**.**:11077\\",\\"useJobTask\\":\\"1\\"}
+   * {"definer": false,"syncArchitecture": "oneway","whitelist.dms.online.ddl.enable": false,"destSSL": "0","triggerMode": "manual","sqlparser.dms.original.ddl": true,"whitelist.ghost.online.ddl.enable": false,"privilegeMigration": false,"maxRetryTime": 43200,"srcSSL": "0","autoStartModulesAfterConfig": "none"}
    */
   reserved?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -161,10 +160,10 @@ export class ModifyDtsJobRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Specifies whether to perform schema migration or synchronization. Valid values:
+   * Specifies whether to perform schema migration or initial schema synchronization. Valid values:
    * 
-   * *   **true**
-   * *   **false**
+   * - **true**: yes.
+   * - **false**: no.
    * 
    * @example
    * true
@@ -173,13 +172,11 @@ export class ModifyDtsJobRequest extends $dara.Model {
   /**
    * @remarks
    * The synchronization direction. Valid values:
+   * - **Forward**: forward.
+   * - **Reverse**: reverse.
    * 
-   * *   **Forward**: Data is synchronized from the source database to the destination database.
-   * *   **Reverse**: Data is synchronized from the destination database to the source database.
-   * 
-   * > 
-   * *   Default value: **Forward**.
-   * *   This parameter is required only if the topology of the data synchronization instance is two-way synchronization.
+   * > - Default value: **Forward**.
+   * - This parameter is required only when the synchronization topology of the data synchronization instance is two-way synchronization.
    * 
    * @example
    * Forward
@@ -187,8 +184,9 @@ export class ModifyDtsJobRequest extends $dara.Model {
   synchronizationDirection?: string;
   /**
    * @remarks
-   * Whether it is a seamless integration (Zero-ETL) task, the value can be:
-   * - **false**: No. - **true**: Yes.
+   * Specifies whether this is a seamless integration (zero-ETL) node. Valid values:
+   * - **true**: yes.
+   * - **false**: no.
    * 
    * @example
    * false

package/src/models/ModifyDtsJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the DTS task.
+   * The DTS task ID.
    * 
    * @example
    * bi6e22a****
@@ -13,7 +13,7 @@ export class ModifyDtsJobResponseBody extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call failed.
    * 
    * @example
    * InternalError
@@ -21,9 +21,8 @@ export class ModifyDtsJobResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
-   * 
-   * >  The data type of this parameter is String. Sample value: **The actual sample value is The request processing has failed due to some unknown error.
+   * The error message returned if the call failed.
+   * > The data type of this parameter should be String. An example value is **The request processing has failed due to some unknown error**.
    * 
    * @example
    * true
@@ -31,7 +30,7 @@ export class ModifyDtsJobResponseBody extends $dara.Model {
   errMessage?: boolean;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 1D6ECADF-C5E9-4C96-8811-77602B31****
@@ -39,7 +38,7 @@ export class ModifyDtsJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The HTTP status code.
+   * The status code.
    * 
    * @example
    * 200