@alicloud/dts20200101 1.8.4 → 1.8.6

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****
    */

package/src/models/PromoteToMasterResponseBody.ts

@@ -4,41 +4,66 @@ import * as $dara from '@darabonba/typescript';
 
 export class PromoteToMasterResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Dynamic error code. This parameter will be unpublished soon.
+   * 
    * @example
    * 403
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * Dynamic error message, used to replace the **%s** placeholder in the **ErrMessage** error message.  
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, it indicates that the request parameter **DtsJobId** is invalid.
+   * 
    * @example
    * present environment is not support,so skip.
    */
   dynamicMessage?: string;
   /**
+   * @remarks
+   * Error code returned when the invocation fails.
+   * 
    * @example
    * InternalError
    */
   errCode?: string;
   /**
+   * @remarks
+   * Error message returned when the invocation fails.
+   * 
    * @example
    * The request processing has failed due to some unknown error.
    */
   errMessage?: string;
   /**
+   * @remarks
+   * Status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 210ec2e116055198849072222d****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * Job ID. This parameter will be unpublished soon.
+   * 
    * @example
    * z2v12jfo309****
    */

package/src/models/RenewInstanceRequest.ts

@@ -5,10 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class RenewInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * The subscription duration of the DTS instance after renewal. Default value: 1.
-   * 
-   * *   If **Period** is set to **Year**, the valid values are **1 to 5**.
-   * *   If **Period** is set to **Month**, the valid values are **1 to 60**.
+   * The subscription duration of the renewed instance. Default value: 1.
+   * - If **Period** is set to **Year**, the valid values are **1 to 5**.
+   * - If **Period** is set to **Month**, the valid values are **1 to 60**.
    * 
    * @example
    * 1
@@ -16,7 +15,7 @@ export class RenewInstanceRequest extends $dara.Model {
   buyCount?: string;
   /**
    * @remarks
-   * The billing method of the DTS instance. Set the value to **PREPAY**, which specifies the subscription billing method.
+   * The billing method. Set the value to **PREPAY**, which indicates the subscription billing method.
    * 
    * This parameter is required.
    * 
@@ -26,7 +25,7 @@ export class RenewInstanceRequest extends $dara.Model {
   chargeType?: string;
   /**
    * @remarks
-   * The ID of the data synchronization or 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 data synchronization or change tracking task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to query the task ID.
    * 
    * This parameter is required.
    * 
@@ -36,10 +35,9 @@ export class RenewInstanceRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The billing cycle of the DTS instance after renewal. Valid values:
-   * 
-   * *   **Year**
-   * *   **Month** (default)
+   * The billing method for the renewal instance. Valid values:
+   * - **Year**: yearly subscription.
+   * - **Month**: monthly subscription (default).
    * 
    * @example
    * Month
@@ -47,7 +45,7 @@ export class RenewInstanceRequest extends $dara.Model {
   period?: string;
   /**
    * @remarks
-   * The region ID of the DTS instance. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The ID of 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
@@ -55,7 +53,7 @@ export class RenewInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/RenewInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class RenewInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The billing method of the DTS instance. Only **PREPAY** may be returned, which indicates the subscription billing method.
+   * The billing method. Set the value to **PREPAY**, which indicates the subscription billing method.
    * 
    * @example
    * PREPAY
@@ -13,9 +13,9 @@ export class RenewInstanceResponseBody extends $dara.Model {
   chargeType?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code.
    * 
-   * > This parameter will be removed in the future.
+   * > This parameter will be deprecated.
    * 
    * @example
    * 200
@@ -31,9 +31,9 @@ export class RenewInstanceResponseBody extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter is used to replace the **%s** variable in the value of **ErrMessage**.
+   * The dynamic error message, which is used to replace the %**s** variable in the **ErrMessage** response parameter.
    * 
-   * > 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** is invalid.
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.
    * 
    * @example
    * DtsJobId
@@ -41,9 +41,9 @@ export class RenewInstanceResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The time when the DTS instance expires after renewal. The time follows the ISO 8601 standard in the *yyyy-MM-dd*T*HH:mm:ssZZZ* format. The time is displayed in UTC.
+   * The time when the renewal instance expires. The time is displayed in the format of <i>yyyy-MM-dd</i>T<i>HH:mm:ssZZZ</i> (UTC).
    * 
-   * > **ZZZ** indicates the offset of the time zone, which is displayed in the format of a plus sign (+) or a minus sign (-) followed by hours and minutes, such as **+00:00**.
+   * > **ZZZ** indicates the full time zone offset ("+" or "-" followed by hours and minutes), for example, **+00:00**.
    * 
    * @example
    * 2021-08-04T16:00:00.000+00:00
@@ -51,7 +51,7 @@ export class RenewInstanceResponseBody extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -59,7 +59,7 @@ export class RenewInstanceResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -75,7 +75,7 @@ export class RenewInstanceResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The ID of the instance
+   * The instance ID.
    * 
    * @example
    * dtsqi0r643lc31****
@@ -93,8 +93,8 @@ export class RenewInstanceResponseBody 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/ResetDtsJobRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResetDtsJobRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data synchronization or change tracking instance.
+   * The synchronization or subscribe instance ID.
    * 
    * @example
    * dtsl3m1213ye7l****
@@ -21,7 +21,7 @@ export class ResetDtsJobRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The region where the DTS instance is located. For more information, see [List of Supported Regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID of the DTS instance. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -29,7 +29,7 @@ export class ResetDtsJobRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aekzn4iqlbsm7hy
@@ -39,12 +39,11 @@ export class ResetDtsJobRequest extends $dara.Model {
    * @remarks
    * The synchronization direction. Valid values:
    * 
-   * *   **Forward**
-   * *   **Reverse**
+   * - **Forward**: forward.
+   * - **Reverse**: reverse.
    * 
-   * > 
-   * *   Default value: **Forward**.
-   * *   You can set this parameter to **Reverse** to reset the reverse synchronization task only when the topology is two-way synchronization.
+   * > - Default value: **Forward**.
+   * - You can set this parameter to **Reverse** to reset the reverse synchronization task only if the topology of the data synchronization instance is two-way synchronization.
    * 
    * @example
    * Forward

package/src/models/ResetDtsJobResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ResetDtsJobResponseBody 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 ResetDtsJobResponseBody extends $dara.Model {
   dynamicCode?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter 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 ResetDtsJobResponseBody 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 ResetDtsJobResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true