@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/DescribeMigrationJobsRequest.ts

@@ -5,11 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMigrationJobsRequestTag extends $dara.Model {
   /**
    * @remarks
-   * The tag key. You can call the [ListTagResources](https://help.aliyun.com/document_detail/191187.html) operation to query the tag key.
+   * The tag key. You can call the [ListTagResources](https://help.aliyun.com/document_detail/191187.html) operation to query tag keys.
    * 
-   * > 
-   * *   N specifies the serial number of the tag. For example, Tag.1.Key specifies the key of the first tag and Tag.2.Key specifies the key of the second tag. You can specify 1 to 20 tag keys at a time.
-   * *   This parameter cannot be an empty string.
+   * > - N specifies the serial number of the tag key. For example, Tag.1.Key specifies the key of the first tag, and Tag.2.Key specifies the key of the second tag. You can specify 1 to 20 tag keys at a time.
+   * - This parameter cannot be set to an empty string.
    * 
    * This parameter is required.
    * 
@@ -19,11 +18,9 @@ export class DescribeMigrationJobsRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The tag value. You can call the [ListTagResources](https://help.aliyun.com/document_detail/191187.html) operation to query the tag value.
-   * 
-   * > 
-   * *   N specifies the serial number of the tag. For example, Tag.1.Value specifies the value of the first tag and Tag.2.Value specifies the value of the second tag. You can specify 1 to 20 tag values at a time.
-   * *   This parameter can be an empty string.
+   * The tag value. You can call the [ListTagResources](https://help.aliyun.com/document_detail/191187.html) operation to query tag values.
+   * >- N specifies the serial number of the tag value. For example, Tag.1.Value specifies the value of the first tag, and Tag.2.Value specifies the value of the second tag. You can specify 1 to 20 tag values at a time.
+   * - An empty string is allowed.
    * 
    * @example
    * testvalue1
@@ -55,7 +52,7 @@ export class DescribeMigrationJobsRequestTag extends $dara.Model {
 export class DescribeMigrationJobsRequest 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. This parameter will be deprecated.
    * 
    * @example
    * 12323344****
@@ -63,9 +60,8 @@ export class DescribeMigrationJobsRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The name of the data migration task.
-   * 
-   * >  Fuzzy match is supported.
+   * The name of the migration instance.
+   * > Fuzzy match is supported.
    * 
    * @example
    * MySQL迁移
@@ -74,7 +70,7 @@ export class DescribeMigrationJobsRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The number of the page to return. The value must be an integer that is greater than **0** and does not exceed the maximum value of the Integer data type. Default value: **1**.
+   * The page number. The value must be greater than **0** and must not exceed the maximum value of the Integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -82,7 +78,7 @@ export class DescribeMigrationJobsRequest extends $dara.Model {
   pageNum?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Valid values: **30**, **50**, and **100**. Default value: **30**.
+   * The number of data migration instances to display per page. Valid values: **10**, **20**, and **30**. Default value: **30**. Maximum value: **30**.
    * 
    * @example
    * 30
@@ -90,7 +86,7 @@ export class DescribeMigrationJobsRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the region where the data migration instances reside. For more information, see [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The ID of the region where the data migration instance resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -98,7 +94,7 @@ export class DescribeMigrationJobsRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -106,7 +102,7 @@ export class DescribeMigrationJobsRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The tag of the data migration instance, used as a filter. When this is not empty, only the instance tasks with this tag will be returned.
+   * The tags of the data migration instance, used as filter conditions. When this parameter is not empty, only instance tasks that have the specified tags are returned.
    */
   tag?: DescribeMigrationJobsRequestTag[];
   static names(): { [key: string]: string } {

package/src/models/DescribeMigrationJobsResponseBody.ts

@@ -501,7 +501,7 @@ export class DescribeMigrationJobsResponseBodyMigrationJobs extends $dara.Model
 export class DescribeMigrationJobsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned if the call failed.
+   * The error code returned if the request failed.
    * 
    * @example
    * InternalError
@@ -509,7 +509,7 @@ export class DescribeMigrationJobsResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned if the request failed.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -518,7 +518,7 @@ export class DescribeMigrationJobsResponseBody extends $dara.Model {
   migrationJobs?: DescribeMigrationJobsResponseBodyMigrationJobs;
   /**
    * @remarks
-   * The page number of the returned page.
+   * The page number.
    * 
    * @example
    * 1
@@ -526,7 +526,7 @@ export class DescribeMigrationJobsResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The maximum number of entries that can be displayed on the current page.
+   * The maximum number of records that can be displayed on the current page.
    * 
    * @example
    * 30
@@ -534,7 +534,7 @@ export class DescribeMigrationJobsResponseBody extends $dara.Model {
   pageRecordCount?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0ED4846D-ED60-435D-88C0-7EC0CE4D****
@@ -542,7 +542,7 @@ export class DescribeMigrationJobsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true
@@ -550,7 +550,7 @@ export class DescribeMigrationJobsResponseBody extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * The total number of data migration instances that belong to your Alibaba Cloud account.
+   * The total number of data migration instances that meet the specified conditions under the Alibaba Cloud account.
    * 
    * @example
    * 300

package/src/models/DescribePreCheckCreateGadOrderResultRequest.ts

@@ -4,22 +4,34 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribePreCheckCreateGadOrderResultRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID of the GAD instance group.
+   * 
    * @example
    * gad-bp162d4tp0500****
    */
   instanceId?: string;
   ownerId?: string;
   /**
+   * @remarks
+   * 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
    */
   regionId?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-acfmzawhxxc****
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * The ID of the precheck task.
+   * 
    * @example
    * k71r16fj13g****
    */

package/src/models/DescribePreCheckCreateGadOrderResultResponseBody.ts

@@ -59,57 +59,91 @@ export class DescribePreCheckCreateGadOrderResultResponseBodyPreCheckItems exten
 
 export class DescribePreCheckCreateGadOrderResultResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The dynamic error code. This parameter will be deprecated.
+   * 
    * @example
    * 403
    */
   dynamicCode?: string;
   /**
+   * @remarks
+   * The dynamic error message 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
    * 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 instance ID of the GAD instance group.
+   * 
    * @example
    * gad-bp1i99e8l7913****
    */
   instanceId?: string;
   preCheckItems?: DescribePreCheckCreateGadOrderResultResponseBodyPreCheckItems;
   /**
+   * @remarks
+   * The overall precheck result.
+   * 
    * @example
    * True
    */
   preCheckResult?: boolean;
   /**
+   * @remarks
+   * 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
    */
   regionId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 92E1E99D-5224-4AD3-8C94-23A3516B****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */
   success?: string;
   /**
+   * @remarks
+   * The ID of the precheck task.
+   * 
    * @example
    * 11****
    */

package/src/models/DescribePreCheckStatusRequest.ts

@@ -15,12 +15,12 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The task code that specifies the type of the DTS subtask. Valid values:
+   * The task code. Specify this parameter to query a specific subtask type of the DTS task. Valid values:
    * 
-   * *   **01**: precheck.
-   * *   **02**: schema migration or initial schema synchronization.
-   * *   **03**: full data migration or initial full data synchronization.
-   * *   **04**: incremental data migration or synchronization.
+   * - **01**: precheck.
+   * - **02**: schema migration or initial schema synchronization.
+   * - **03**: full data migration or initial full data synchronization.
+   * - **04**: incremental data migration or incremental data synchronization.
    * 
    * This parameter is required.
    * 
@@ -30,7 +30,7 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   jobCode?: string;
   /**
    * @remarks
-   * The filter item used to filter tables in fuzzy match.
+   * The filter. Performs a fuzzy match on table names.
    * 
    * @example
    * dewuprop
@@ -38,7 +38,7 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The page number. Pages start from page 1. Default value: **1**.
+   * The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: **1**.
    * 
    * @example
    * 1
@@ -46,7 +46,7 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   pageNo?: string;
   /**
    * @remarks
-   * The number of entries per page. Default value: **20**.
+   * The number of records per page. Default value: **20**.
    * 
    * @example
    * 30
@@ -54,15 +54,15 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   pageSize?: 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 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).
    * 
    * @example
-   * cn-beijing
+   * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aekz4us4iruleja
@@ -70,7 +70,7 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The filter item used to filter tables, views, and functions during schema migration.
+   * The filter. Filters tables, views, and functions in schema migration.
    * 
    * @example
    * View
@@ -80,8 +80,8 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
    * @remarks
    * The type of schema definition. Valid values:
    * 
-   * *   **before**: schema migration or initial schema synchronization.
-   * *   **after**: DDL operations performed during incremental data migration or synchronization.
+   * - **before**: schema migration or initial schema synchronization.
+   * - **after**: DDL operations during incremental data migration or incremental data synchronization.
    * 
    * @example
    * before
@@ -89,8 +89,10 @@ export class DescribePreCheckStatusRequest extends $dara.Model {
   structType?: 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
    * false