@alicloud/dts20200101 1.8.5 → 1.8.7

package/src/models/ModifyGadInstanceNameResponseBody.ts

@@ -4,61 +4,98 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyGadInstanceNameResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The time when the task was created, in the format of <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2021-06-28 17:34:53.0
    */
   createTime?: number;
   /**
+   * @remarks
+   * The dynamic error code. This parameter will be deprecated.
+   * 
    * @example
    * 403
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * The dynamic error message, which replaces **%s** 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
    * present environment is not support,so skip.
    */
   dynamicMessage?: string;
   /**
+   * @remarks
+   * The error code returned if the call failed.
+   * 
    * @example
    * InternalError
    */
   errCode?: string;
   /**
+   * @remarks
+   * The error message returned if the call failed.
+   * 
    * @example
    * The request processing has failed due to some unknown error.
    */
   errMessage?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: string;
   /**
+   * @remarks
+   * The active geo-redundancy instance group ID.
+   * 
    * @example
    * rm-bp162d4tp0500****
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * rm-2zehh163694qs5c3v
    */
   instanceName?: string;
   /**
+   * @remarks
+   * The region ID of the instance. For more information, see Supported regions.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 4D0ADAD5-DD97-41B6-B78F-D1961AB1****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-acfmzawhxxc****
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/ModifyJobStepCheckpointRequest.ts

@@ -4,22 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyJobStepCheckpointRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the migration, synchronization, or tracking task.
+   * 
    * @example
    * l5512es7w15****
    */
   dtsJobId?: string;
   /**
+   * @remarks
+   * The task step ID, which corresponds to the **synchronization** step ID returned by the ListJobStep API.
+   * 
    * @example
    * wn3z4ukia9wi9xu_0004_0000
    */
   jobStepId?: string;
   /**
+   * @remarks
+   * The new offset as a UNIX timestamp in seconds. The specified value must fall within the offset range of the incremental data collection step.
+   * 
    * @example
    * 1760406***
    */
   newCheckPoint?: number;
   /**
    * @remarks
+   * The region where the DTS instance resides.
+   * 
+   * > For regions that support dedicated clusters, see [DTS dedicated cluster](https://help.aliyun.com/document_detail/417481.html).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,6 +40,9 @@ export class ModifyJobStepCheckpointRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-aek2ilvoxlrd***
    */

package/src/models/ModifyJobStepCheckpointResponseBody.ts

@@ -4,36 +4,61 @@ import * as $dara from '@darabonba/typescript';
 
 export class ModifyJobStepCheckpointResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * The dynamic error message used to replace the %s placeholder in the ErrMessage parameter.
+   * 
+   * > For example, if ErrMessage returns "The Value of Input Parameter %s is not valid" and DynamicMessage returns "JobId", it indicates that the JobId request parameter you provided is invalid.
+   * 
    * @example
    * can not find env: zbyk-pre
    */
   dynamicMessage?: string;
   /**
+   * @remarks
+   * The error code returned when the API call fails.
+   * 
    * @example
    * InternalError
    */
   errCode?: string;
   /**
+   * @remarks
+   * The error message returned when the API call fails.
+   * 
    * @example
    * The request processing has failed due to some unknown error.
    */
   errMessage?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C306C198-7807-409D-930A-D6CE6C32****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded. Valid values:
+   * - **true**: The request succeeded.
+   * - **false**: The request failed.
+   * 
    * @example
    * true
    */

package/src/models/ModifySubscriptionObjectRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifySubscriptionObjectRequest 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 ModifySubscriptionObjectRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the data synchronization 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
@@ -22,7 +22,7 @@ export class ModifySubscriptionObjectRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -40,7 +40,7 @@ export class ModifySubscriptionObjectRequest extends $dara.Model {
   subscriptionInstanceId?: string;
   /**
    * @remarks
-   * The objects from 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 subscription objects. 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/ModifySubscriptionObjectResponseBody.ts

@@ -21,7 +21,7 @@ export class ModifySubscriptionObjectResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * ABBACEFC-CBA9-4F80-A337-42F202F5****
@@ -29,7 +29,7 @@ export class ModifySubscriptionObjectResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/ModifySubscriptionRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class ModifySubscriptionRequest extends $dara.Model {
   /**
    * @remarks
-   * The objects of the change tracking task. The value is a JSON string. For more information, see [Objects of DTS tasks](https://help.aliyun.com/document_detail/209545.html).
-   * 
-   * >  You can call the [DescribeDtsJobDetail](https://help.aliyun.com/document_detail/208925.html) operation to query the original objects of the task.
+   * The modified subscription objects, in JSON format. For more information about the definition, see [Objects of DTS tasks](https://help.aliyun.com/document_detail/209545.html).
+   * > - The new DbList value overwrites the original DbList value. Make sure that the new DbList value contains all the objects that you want to track. Otherwise, objects may be lost. Modify this parameter with caution.
+   * - You can call [DescribeDtsJobDetail](https://help.aliyun.com/document_detail/208925.html) to query the original subscription objects.
    * 
    * @example
    * {"dtstest":{"name":"dtstest","all":true}}
@@ -15,7 +15,7 @@ export class ModifySubscriptionRequest extends $dara.Model {
   dbList?: string;
   /**
    * @remarks
-   * The ID of the change tracking instance. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the instance ID.
+   * The ID of the change tracking instance. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query the instance ID.
    * 
    * @example
    * dtsboss6pn1w******
@@ -23,7 +23,7 @@ export class ModifySubscriptionRequest extends $dara.Model {
   dtsInstanceId?: string;
   /**
    * @remarks
-   * The ID of the change tracking task. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
+   * The ID of the change tracking task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query the task ID.
    * 
    * @example
    * boss6pn1w******
@@ -32,7 +32,7 @@ export class ModifySubscriptionRequest extends $dara.Model {
   modifyType?: 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 region in which the DTS instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -41,7 +41,7 @@ export class ModifySubscriptionRequest extends $dara.Model {
   reserved?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -49,10 +49,10 @@ export class ModifySubscriptionRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Specifies whether to retrieve data definition language (DDL) statements. Valid values:
+   * Specifies whether the modified task subscribes to DDL data. Valid values:
    * 
-   * *   **true**: yes
-   * *   **false**: no
+   * - **true**: The task subscribes to DDL data.
+   * - **false**: The task does not subscribe to DDL data.
    * 
    * @example
    * true
@@ -60,10 +60,9 @@ export class ModifySubscriptionRequest extends $dara.Model {
   subscriptionDataTypeDDL?: boolean;
   /**
    * @remarks
-   * Specifies whether to retrieve data manipulation language (DML) statements. Valid values:
-   * 
-   * *   **true**: yes
-   * *   **false**: no
+   * Specifies whether the modified task subscribes to DML data. Valid values:
+   * - **true**: The task subscribes to DML data.
+   * - **false**: The task does not subscribe to DML data.
    * 
    * @example
    * true

package/src/models/ModifySubscriptionResponseBody.ts

@@ -29,7 +29,7 @@ export class ModifySubscriptionResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 068FA72F-4800-4A54-90BB-94806068****
@@ -37,7 +37,7 @@ export class ModifySubscriptionResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true

package/src/models/ModifySynchronizationObjectRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifySynchronizationObjectRequest 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 discontinued.
    * 
    * @example
    * 12323344****
@@ -14,7 +14,7 @@ export class ModifySynchronizationObjectRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the data synchronization 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
@@ -22,7 +22,7 @@ export class ModifySynchronizationObjectRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -31,13 +31,11 @@ export class ModifySynchronizationObjectRequest extends $dara.Model {
   /**
    * @remarks
    * The synchronization direction. Valid values:
+   * - **Forward**: forward.
+   * - **Reverse**: reverse.
    * 
-   * *   **Forward**
-   * *   **Reverse**
-   * 
-   * > 
-   * *   Default value: **Forward**.
-   * *   This parameter is required only when 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
@@ -45,7 +43,7 @@ export class ModifySynchronizationObjectRequest extends $dara.Model {
   synchronizationDirection?: string;
   /**
    * @remarks
-   * The ID of the data synchronization instance. You can call the DescribeSynchronizationJobs operation to query the instance ID.
+   * The ID of the data synchronization instance. You can call the [DescribeSynchronizationJobs](https://help.aliyun.com/document_detail/49454.html) operation to query the instance ID.
    * 
    * This parameter is required.
    * 
@@ -55,7 +53,7 @@ export class ModifySynchronizationObjectRequest extends $dara.Model {
   synchronizationJobId?: string;
   /**
    * @remarks
-   * The objects that you want to synchronize. The value is a JSON string and can contain regular expressions. For more information, see [SynchronizationObjects](https://help.aliyun.com/document_detail/141901.html).
+   * The modified synchronization objects. The value is a JSON string that supports certain regular expressions. For more information, see [Synchronization object configuration](https://help.aliyun.com/document_detail/141901.html).
    * 
    * This parameter is required.
    * 

package/src/models/ModifySynchronizationObjectResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ModifySynchronizationObjectResponseBody 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 ModifySynchronizationObjectResponseBody 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 ModifySynchronizationObjectResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 902DDCDE-C755-4458-85DA-DF9A323C****
@@ -29,7 +29,7 @@ export class ModifySynchronizationObjectResponseBody 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 ModifySynchronizationObjectResponseBody extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * The ID of the task that changes the objects. You must specify the task ID when you call the DescribeSynchronizationObjectModifyStatus operation to query the status and progress of the task.
+   * The task ID. You can call the [DescribeSynchronizationObjectModifyStatus](https://help.aliyun.com/document_detail/49452.html) operation based on this parameter to query the status and progress of the synchronization object modification.
    * 
    * @example
    * tl911uvi25z****

package/src/models/PreCheckCreateGadOrderRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class PreCheckCreateGadOrderRequest extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the active geo-redundancy instance group.
+   * 
    * @example
    * gad-bp1i99e8l7913****
    */
@@ -14,22 +17,34 @@ export class PreCheckCreateGadOrderRequest extends $dara.Model {
   masterShardAccountPassword?: string;
   ownerId?: string;
   /**
+   * @remarks
+   * The region in which the DTS instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-acfntftbiobqyky
    */
   resourceGroupId?: string;
   slaveDatabaseName?: string;
   /**
+   * @remarks
+   * The instance ID of the database instance that assumes the secondary role.
+   * 
    * @example
    * rm-bp17562h64****
    */
   slaveDbInstanceId?: string;
   /**
+   * @remarks
+   * The region of the database instance that assumes the secondary role.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/PreCheckCreateGadOrderResponseBody.ts

@@ -4,47 +4,82 @@ import * as $dara from '@darabonba/typescript';
 
 export class PreCheckCreateGadOrderResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The dynamic error code. This parameter will be deprecated.
+   * 
    * @example
    * 403
    */
   dynamicCode?: string;
+  /**
+   * @remarks
+   * 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 JobId, the value of the JobId request parameter is invalid.
+   */
   dynamicMessage?: string;
   /**
+   * @remarks
+   * The error code returned if the call failed.
+   * 
    * @example
    * InternalError
    */
   errCode?: string;
   /**
+   * @remarks
+   * The error message returned if the call failed.
+   * 
    * @example
    * The request processing has failed due to some unknown error.
    */
   errMessage?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: string;
   /**
+   * @remarks
+   * The ID of the active geo-redundancy instance group.
+   * 
    * @example
    * rm-bp162d4tp0500****
    */
   instanceId?: string;
   /**
+   * @remarks
+   * The ID of the region in which the instance resides. For more information, see Supported regions.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C166D79D-436B-45F0-B5A5-25E1959F****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the call was successful. Valid values:
+   * - true: The call was successful.
+   * - false: The call failed.
+   * 
    * @example
    * true
    */
   success?: string;
   /**
+   * @remarks
+   * The precheck task ID.
+   * 
    * @example
    * z2v12jfo309****
    */

package/src/models/PromoteToMasterRequest.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class PromoteToMasterRequest extends $dara.Model {
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * gad-bp162d4tp0500****
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Primary instance ID.
+   * 
    * @example
    * rm-bp1756****
    */
   masterDbInstanceId?: string;
   /**
+   * @remarks
+   * Region ID. Specify this parameter to indicate the region where the instance resides. For more information, see the list of supported regions.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-acfmzawhxxc****
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * Secondary instance ID.
+   * 
    * @example
    * rm-bp1756****
    */