@alicloud/dts20200101 1.8.5 → 1.8.7

package/src/models/ModifyDtsJobAdvanceRequest.ts

@@ -6,7 +6,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobAdvanceRequest 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****
@@ -14,10 +14,10 @@ export class ModifyDtsJobAdvanceRequest 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
@@ -27,8 +27,8 @@ export class ModifyDtsJobAdvanceRequest extends $dara.Model {
    * @remarks
    * Specifies whether to perform incremental data migration or synchronization. Valid values:
    * 
-   * *   **false**
-   * *   **true**
+   * - **false**: no.
+   * - **true**: yes.
    * 
    * @example
    * true
@@ -36,13 +36,12 @@ export class ModifyDtsJobAdvanceRequest 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}}
@@ -50,7 +49,7 @@ export class ModifyDtsJobAdvanceRequest 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.
    * 
@@ -60,7 +59,7 @@ export class ModifyDtsJobAdvanceRequest 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***
@@ -68,7 +67,7 @@ export class ModifyDtsJobAdvanceRequest 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
    * {
@@ -114,7 +113,7 @@ export class ModifyDtsJobAdvanceRequest 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_************
@@ -130,7 +129,7 @@ export class ModifyDtsJobAdvanceRequest 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
@@ -138,7 +137,7 @@ export class ModifyDtsJobAdvanceRequest 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
@@ -146,15 +145,15 @@ export class ModifyDtsJobAdvanceRequest 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****
@@ -162,10 +161,10 @@ export class ModifyDtsJobAdvanceRequest 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
@@ -174,13 +173,11 @@ export class ModifyDtsJobAdvanceRequest 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
@@ -188,8 +185,9 @@ export class ModifyDtsJobAdvanceRequest 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/ModifyDtsJobConfigRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobConfigRequest extends $dara.Model {
   /**
    * @remarks
-   * DTS job ID, which can be queried by calling [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html).
+   * The ID of the DTS task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query the task ID.
    * 
    * @example
    * lxsn87r328d****
@@ -14,15 +14,15 @@ export class ModifyDtsJobConfigRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The parameters that you want to modify. Specify a JSON string. For more information, see [Parameters](https://help.aliyun.com/document_detail/2536412.html).
+   * The parameters to be modified, in JSON character string format. For more information, see [Parameters metric description](https://help.aliyun.com/document_detail/2536412.html).
    * 
    * @example
-   * [{\\"module\\":\\"07\\",\\"name\\":\\"sink.connection.idle.second\\",\\"value\\":60},{\\"module\\":\\"07\\",\\"name\\":\\"sink.batch.size.maximum\\",\\"value\\":64}]
+   * [{"module":"07","name":"sink.connection.idle.second","value":60},{"module":"07","name":"sink.batch.size.maximum","value":64}]
    */
   parameters?: string;
   /**
    * @remarks
-   * The region where the instance is located. For more details, 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

package/src/models/ModifyDtsJobConfigResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobConfigResponseBody extends $dara.Model {
   /**
    * @remarks
-   * request ID
+   * The request ID.
    * 
    * @example
    * 068FA72F-4800-4A54-90BB-94806068****

package/src/models/ModifyDtsJobDedicatedClusterRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobDedicatedClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * The dedicated cluster ID.
+   * The ID of the dedicated cluster.
    * 
    * @example
    * dtsxxxx
@@ -13,7 +13,7 @@ export class ModifyDtsJobDedicatedClusterRequest extends $dara.Model {
   dedicatedClusterId?: string;
   /**
    * @remarks
-   * The DTS task IDs. The value can be a JSON array that consists of multiple DTS task IDs. Separate the IDs with commas (,).
+   * The task ID. You can specify multiple task IDs in a JSON array. Separate the IDs with commas (,).
    * 
    * @example
    * ["dtsxxxx01", "dtsxxx02"]
@@ -22,9 +22,9 @@ export class ModifyDtsJobDedicatedClusterRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the DTS instance resides.
+   * The region in which the DTS instance resides.
    * 
-   * > For information about the regions that support dedicated clusters, see [DTS dedicated cluster](https://help.aliyun.com/document_detail/417481.html).
+   * > For the regions supported by dedicated clusters, see [DTS dedicated cluster](https://help.aliyun.com/document_detail/417481.html).
    * 
    * @example
    * cn-hangzhou

package/src/models/ModifyDtsJobDedicatedClusterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobDedicatedClusterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned by the backend service.
+   * The error code returned by the backend. The value is incremental.
    * 
    * @example
    * 500
@@ -13,7 +13,7 @@ export class ModifyDtsJobDedicatedClusterResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter is used to replace %s in **ErrMessage**.
+   * The dynamic error message used to replace the %s variable in the ErrMessage parameter.
    * 
    * @example
    * Type
@@ -21,7 +21,7 @@ export class ModifyDtsJobDedicatedClusterResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -29,7 +29,7 @@ export class ModifyDtsJobDedicatedClusterResponseBody 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.

package/src/models/ModifyDtsJobDuLimitRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobDuLimitRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data migration, data synchronization, or change tracking task.
+   * The ID of the DTS migration, synchronization, or change tracking task.
    * 
    * This parameter is required.
    * 
@@ -15,9 +15,9 @@ export class ModifyDtsJobDuLimitRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The upper limit of DUs for the DTS task.
+   * The DU upper limit of the task.
    * 
-   * >  Minimum value: **1**.
+   * > The minimum value is **1**.
    * 
    * This parameter is required.
    * 
@@ -28,7 +28,7 @@ export class ModifyDtsJobDuLimitRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region in which the DTS instance resides.
+   * The region ID.
    * 
    * @example
    * cn-hangzhou
@@ -36,7 +36,7 @@ export class ModifyDtsJobDuLimitRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/ModifyDtsJobDuLimitResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifyDtsJobDuLimitResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned by the backend service. The number is incremented.
+   * The backend error code, which is an incrementing number.
    * 
    * @example
    * 500
@@ -13,7 +13,7 @@ export class ModifyDtsJobDuLimitResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter is used to replace the %s variable in the **ErrMessage** parameter.
+   * The dynamic error message. This parameter is used to replace the %s variable in the **ErrMessage** parameter.
    * 
    * @example
    * Type
@@ -21,7 +21,7 @@ export class ModifyDtsJobDuLimitResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -29,7 +29,7 @@ export class ModifyDtsJobDuLimitResponseBody 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.
@@ -45,7 +45,7 @@ export class ModifyDtsJobDuLimitResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****