@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/StartMigrationJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartMigrationJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call failed.
    * 
    * @example
    * InternalError
@@ -21,7 +21,7 @@ export class StartMigrationJobResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * FDC111B1-ACBF-457D-9656-247FDEE9****

package/src/models/StartReverseWriterRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class StartReverseWriterRequest extends $dara.Model {
   /**
    * @remarks
-   * The offset of the Incremental Write module. Specify a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. 
+   * The checkpoint of the incremental write module. The value is a UNIX timestamp.
    * 
-   * > The default value is the offset that is automatically saved by DTS when the task is paused.
+   * > Default value: the checkpoint that is automatically saved by DTS when the original task is stopped.
    * 
    * @example
    * 1695613785
@@ -15,7 +15,7 @@ export class StartReverseWriterRequest extends $dara.Model {
   checkPoint?: string;
   /**
    * @remarks
-   * The ID of the reverse task that was created by calling the CreateReverseDtsJob operation.
+   * The ID of the task generated by calling the **CreateReverseDtsJob** operation.
    * 
    * This parameter is required.
    * 
@@ -25,10 +25,10 @@ export class StartReverseWriterRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID. This is a global parameter and does not need to be passed in for this operation.
    * 
    * @example
-   * rg-acfmzawhxxc****
+   * 资源组ID，全局参数，当前API无需传入。
    */
   resourceGroupId?: string;
   static names(): { [key: string]: string } {

package/src/models/StartReverseWriterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartReverseWriterResponseBody 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 StartReverseWriterResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -21,7 +21,7 @@ export class StartReverseWriterResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 291BA4F1-2035-3FAA-6D5A-5D2015CC****
@@ -29,7 +29,7 @@ export class StartReverseWriterResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/StartSubscriptionInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartSubscriptionInstanceRequest 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 this parameter is about to be deprecated.
    * 
    * @example
    * 12323344****
@@ -14,7 +14,7 @@ export class StartSubscriptionInstanceRequest 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
@@ -22,7 +22,7 @@ export class StartSubscriptionInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-aekz4us4iruleja
@@ -30,7 +30,7 @@ export class StartSubscriptionInstanceRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The ID of the change tracking instance. You can call the DescribeSubscriptionInstances operation to query the instance ID.
+   * The ID of the change tracking instance. You can call the [DescribeSubscriptionInstances](https://help.aliyun.com/document_detail/49442.html) operation to query the instance ID.
    * 
    * This parameter is required.
    * 

package/src/models/StartSubscriptionInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartSubscriptionInstanceResponseBody 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 StartSubscriptionInstanceResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -21,7 +21,7 @@ export class StartSubscriptionInstanceResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * B083F9AB-BE9B-4716-8AD3-CFA04391****
@@ -29,7 +29,7 @@ export class StartSubscriptionInstanceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true
@@ -37,7 +37,7 @@ export class StartSubscriptionInstanceResponseBody extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * The task ID. This parameter will be removed in the future.
+   * The task ID. This parameter is about to be deprecated.
    * 
    * @example
    * 11****

package/src/models/StartSynchronizationJobRequest.ts

@@ -5,16 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class StartSynchronizationJobRequest 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 this parameter is about to be discontinued.
    * 
    * @example
-   * 12323344****
+   * 1689726061829****
    */
   accountId?: string;
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region in which the data synchronization instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The ID of the region where the data synchronization instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -22,7 +22,7 @@ export class StartSynchronizationJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -31,15 +31,11 @@ export class StartSynchronizationJobRequest extends $dara.Model {
   /**
    * @remarks
    * The synchronization direction. Valid values:
+   * - **Forward**: forward.
+   * - **Reverse**: reverse.
    * 
-   * *   **Forward**
-   * *   **Reverse**
-   * 
-   * > 
-   * 
-   * *   The default value is **Forward**.
-   * 
-   * *   You can set this parameter to **Reverse** to start the reverse synchronization task only if the topology is two-way synchronization.
+   * > - Default value: **Forward**.
+   * > - You can set this parameter to **Reverse** to start the reverse synchronization link only if the topology of the data synchronization instance is two-way synchronization.
    * 
    * @example
    * Forward

package/src/models/StartSynchronizationJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StartSynchronizationJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call failed.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class StartSynchronizationJobResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned if the call failed.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -30,9 +30,8 @@ export class StartSynchronizationJobResponseBody 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/StopDedicatedClusterRequest.ts

@@ -5,9 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class StopDedicatedClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cluster.
-   * 
-   * >  You must specify one of the **InstanceId** and **DedicatedClusterId** parameters.
+   * The cluster ID.
+   * > You must specify either **InstanceId** or **DedicatedClusterId**.
    * 
    * @example
    * dtscluster_h3fl1cs217sx952
@@ -15,7 +14,7 @@ export class StopDedicatedClusterRequest extends $dara.Model {
   dedicatedClusterId?: string;
   /**
    * @remarks
-   * The name of the cluster.
+   * The cluster name.
    * 
    * @example
    * dtscluster_test_001
@@ -23,9 +22,8 @@ export class StopDedicatedClusterRequest extends $dara.Model {
   dedicatedClusterName?: string;
   /**
    * @remarks
-   * The ID of the instance.
-   * 
-   * >  You must specify one of the **InstanceId** and **DedicatedClusterId** parameters.
+   * The instance ID.
+   * > You must specify either **InstanceId** or **DedicatedClusterId**.
    * 
    * @example
    * rm-bp1162kryivb8****
@@ -34,7 +32,7 @@ export class StopDedicatedClusterRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region in which the instance resides.
+   * The region in which the instance resides.
    * 
    * @example
    * cn-hangzhou
@@ -42,10 +40,10 @@ export class StopDedicatedClusterRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID. This parameter is a global parameter and not required.
+   * The resource group ID. This is a global parameter that does not need to be specified for this operation.
    * 
    * @example
-   * The resource group ID. This parameter is a global parameter and not required.
+   * 资源组ID，全局参数，当前API无需传入。
    */
   resourceGroupId?: string;
   static names(): { [key: string]: string } {

package/src/models/StopDedicatedClusterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StopDedicatedClusterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class StopDedicatedClusterResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.q
@@ -29,7 +29,7 @@ export class StopDedicatedClusterResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****

package/src/models/StopDtsJobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StopDtsJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data migration, data synchronization, or change tracking instance.
+   * The instance ID of the data migration, data synchronization, or subscribe instance.
    * 
    * @example
    * dtsl3m1213ye7l****
@@ -21,30 +21,29 @@ export class StopDtsJobRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The region ID of the Data Transmission Service (DTS) instance. For more information, see [List of 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-qingdao
+   * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
-   * rg-aekznwnajjh4d3a
+   * rg-acfm2jr35xnjh7i
    */
   resourceGroupId?: string;
   /**
    * @remarks
    * The synchronization direction. Valid values:
    * 
-   * *   **Forward**
-   * *   **Reverse**
+   * - **Forward**: forward.
+   * - **Reverse**: reverse.
    * 
-   * > 
-   * *   Default value: **Forward**.
-   * *   You can set this parameter to **Reverse** to stop the reverse synchronization task only when the topology is two-way synchronization.
+   * > - Default value: **Forward**.
+   * - You can set this parameter to **Reverse** to stop the reverse synchronization link only if the topology of the data synchronization instance is two-way synchronization.
    * 
    * @example
    * Forward
@@ -52,8 +51,10 @@ export class StopDtsJobRequest 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 the node is a seamless integration (zero-ETL) node. Valid values:
+   * 
+   * - **false**: No.
+   * - **true**: Yes.
    * 
    * @example
    * true

package/src/models/StopDtsJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StopDtsJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The dynamic error code. This parameter will be removed in the future.
+   * The dynamic error code. This parameter will be deprecated.
    * 
    * @example
    * 403
@@ -13,9 +13,8 @@ export class StopDtsJobResponseBody extends $dara.Model {
   dynamicCode?: string;
   /**
    * @remarks
-   * The dynamic error message, which is used to replace **%s** in the **ErrMessage** parameter.
-   * 
-   * >  If the return value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the return value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.
+   * The dynamic error message, which is used to replace the **%s** variable 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
@@ -47,7 +46,7 @@ export class StopDtsJobResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 01B6F25-21E7-4484-99D5-3EF2625C****
@@ -55,7 +54,7 @@ export class StopDtsJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/StopDtsJobsRequest.ts

@@ -5,11 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class StopDtsJobsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data migration or data synchronization task.
-   * 
-   * > 
-   * *   Separate multiple task IDs by **,** (commas).
-   * *   You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query task IDs.
+   * The IDs of the data migration or data synchronization tasks.
+   * > - Separate multiple task IDs with commas (,).
+   * - Call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query DTS task IDs.
    * 
    * This parameter is required.
    * 
@@ -19,7 +17,7 @@ export class StopDtsJobsRequest extends $dara.Model {
   dtsJobIds?: string;
   /**
    * @remarks
-   * The region ID of the DTS instance. For more information, see [List of 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
@@ -27,7 +25,7 @@ export class StopDtsJobsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aekzsf6yoxhfpva
@@ -35,8 +33,10 @@ export class StopDtsJobsRequest 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:
+   * 
+   * - **false**: No.
+   * - **true**: Yes.
    * 
    * @example
    * true

package/src/models/StopDtsJobsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StopDtsJobsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The dynamic error code. This parameter will be removed in the future.
+   * The dynamic error code. This parameter will be deprecated.
    * 
    * @example
    * 403
@@ -13,9 +13,7 @@ export class StopDtsJobsResponseBody extends $dara.Model {
   dynamicCode?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.
-   * 
-   * >  If the returned value of the **ErrMessage** parameter is **The Value of Input Parameter %s is not valid** and the returned value of the **DynamicMessage** parameter is **DtsJobId**, the specified **DtsJobId** parameter is invalid.
+   * The dynamic error message, which is used to replace the **%s** variable in the **ErrMessage** parameter. > For example, if **ErrMessage** returns **The value of input parameter %s is not valid** and **DynamicMessage** returns **[timeout]**, the request parameter **timeout** is invalid.
    * 
    * @example
    * DtsJobId
@@ -23,7 +21,7 @@ export class StopDtsJobsResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the call failed.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -31,7 +29,7 @@ export class StopDtsJobsResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -47,7 +45,7 @@ export class StopDtsJobsResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * AD823BD3-1BA6-4117-A536-165CB280****
@@ -55,7 +53,7 @@ export class StopDtsJobsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request is successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/StopMigrationJobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StopMigrationJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The IDoftheAlibabaCloudaccount. Youdonotneed 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 this parameter will be discontinued.
    * 
    * @example
    * 12323344****
@@ -13,7 +13,7 @@ export class StopMigrationJobRequest 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 ensure uniqueness across different requests. **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88e9fe63****
@@ -21,7 +21,7 @@ export class StopMigrationJobRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the data migration instance. You can call the **DescribeMigrationJobs** operation to query all data migration instances.
+   * Instance ID of the data migration instance. You can call the **DescribeMigrationJobs** operation to query instance ID.
    * 
    * This parameter is required.
    * 
@@ -32,7 +32,7 @@ export class StopMigrationJobRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the data migration instance resides. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID. Specify this parameter to indicate the region where the instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -40,7 +40,7 @@ export class StopMigrationJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/StopMigrationJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class StopMigrationJobResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data migration instance. You can call the **DescribeMigrationJobs** operation to query all data migration instances.
+   * The error code returned if the call failed.
    * 
    * @example
    * InternalError
@@ -13,7 +13,7 @@ export class StopMigrationJobResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @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 message returned if the call failed.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -21,7 +21,7 @@ export class StopMigrationJobResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the region where the data migration instance resides. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The request ID.
    * 
    * @example
    * C306C198-7807-409D-930A-D6CE6C32****
@@ -29,7 +29,7 @@ export class StopMigrationJobResponseBody extends $dara.Model {
   requestId?: 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.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true