@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/InitDtsRdsInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class InitDtsRdsInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data synchronization task.
+   * The instance ID of the synchronization node.
    * 
    * @example
    * dtszvxa4qmot6p****
@@ -13,9 +13,8 @@ export class InitDtsRdsInstanceRequest extends $dara.Model {
   dtsInstanceId?: string;
   /**
    * @remarks
-   * If the node is a self-managed MySQL database that is connected over CEN, you must specify the ID of the CEN instance.
-   * 
-   * > You must specify the **EndpointRegion** and **EndpointInstanceId** parameters or the EndpointCenId parameter based on the type of the node.
+   * The instance ID of the CEN instance. This parameter is required if the unit node is a self-managed MySQL database connected through CEN.
+   * > You must specify either this parameter or the ApsaraDB RDS for MySQL-related parameters (**EndpointRegion** and **EndpointInstanceId**).
    * 
    * @example
    * cen-9kqshqum*******
@@ -23,10 +22,9 @@ export class InitDtsRdsInstanceRequest extends $dara.Model {
   endpointCenId?: string;
   /**
    * @remarks
-   * If the node is an ApsaraDB RDS for MySQL instance, you must specify the ID of the ApsaraDB RDS for MySQL instance.
-   * 
-   * > *   You must also specify the **EndpointRegion** parameter.
-   * >*   You must specify the EndpointInstanceId parameter or the **EndpointCenId** parameter based on the type of the node.
+   * The instance ID of the ApsaraDB RDS for MySQL instance. This parameter is required if the unit node is an ApsaraDB RDS for MySQL instance.
+   * > - You must also specify the **EndpointRegion** parameter.
+   * - You must specify either this parameter or **EndpointCenId**.
    * 
    * @example
    * rm-bp1162kryivb8****
@@ -34,10 +32,10 @@ export class InitDtsRdsInstanceRequest extends $dara.Model {
   endpointInstanceId?: string;
   /**
    * @remarks
-   * The type of the node. Valid values:
+   * The instance type of the unit node. Valid values:
    * 
-   * *   **RDS**: an ApsaraDB RDS for MySQL instance
-   * *   **CEN**: a self-managed MySQL database that is connected over CEN
+   * - **RDS**: ApsaraDB RDS for MySQL instance.
+   * - **CEN**: self-managed MySQL database connected through CEN.
    * 
    * @example
    * RDS
@@ -45,10 +43,10 @@ export class InitDtsRdsInstanceRequest extends $dara.Model {
   endpointInstanceType?: string;
   /**
    * @remarks
-   * If the node is an ApsaraDB RDS for MySQL instance, you must specify the region in which the ApsaraDB RDS for MySQL instance resides.
+   * The region in which the ApsaraDB RDS for MySQL instance resides. This parameter is required if the unit node is an ApsaraDB RDS for MySQL instance.
    * 
-   * > *   You must also specify the **EndpointInstanceId** parameter.
-   * >*   You must specify the EndpointRegion parameter or the **EndpointCenId** parameter based on the type of the node.
+   * > - You must also specify the **EndpointInstanceId** parameter.
+   * - You must specify either this parameter or **EndpointCenId**.
    * 
    * @example
    * cn-hangzhou
@@ -56,7 +54,7 @@ export class InitDtsRdsInstanceRequest extends $dara.Model {
   endpointRegion?: string;
   /**
    * @remarks
-   * The ID of the region in which the active geo-redundancy database cluster resides.
+   * The region in which the active geo-redundancy database cluster resides.
    * 
    * @example
    * cn-hangzhou
@@ -64,10 +62,10 @@ export class InitDtsRdsInstanceRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The ID of the resource group. This is a global parameter and does not need to be specified for this operation.
    * 
    * @example
-   * rg-acfmzawhxxc****
+   * 资源组ID，全局参数，当前API无需传入。
    */
   resourceGroupId?: string;
   static names(): { [key: string]: string } {

package/src/models/InitDtsRdsInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class InitDtsRdsInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The built-in account that is used by DTS to connect to the node.
+   * The built-in account that DTS uses to connect to the unit node.
    * 
    * @example
    * rdsdt_dtsacct
@@ -21,7 +21,7 @@ export class InitDtsRdsInstanceResponseBody extends $dara.Model {
   adminPassword?: string;
   /**
    * @remarks
-   * The error code returned if the request fails.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -29,7 +29,7 @@ export class InitDtsRdsInstanceResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request fails.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -45,7 +45,7 @@ export class InitDtsRdsInstanceResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 7796ECE0-9C17-5E4D-9CE6-B7EC825A****

package/src/models/ListDedicatedClusterRequest.ts

@@ -5,10 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class ListDedicatedClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * The basis on which the retrieved entries are sorted if multiple DTS dedicated clusters are returned. Valid values:
+   * The sort column when the response contains multiple DTS dedicated cluster instances. Valid values:
    * 
-   * *   **gmtCreated**: the time when a cluster was created.
-   * *   **orderCount**: the number of nodes in a cluster.
+   * - **gmtCreated**: creation time.
+   * - **orderCount**: number of nodes.
    * 
    * @example
    * gmtCreated
@@ -16,10 +16,10 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   orderColumn?: string;
   /**
    * @remarks
-   * The order in which you want to sort the retrieved entries. Valid values:
+   * The sort order. Valid values:
    * 
-   * *   asc: sorts the retrieved entries in ascending order. This is the default value.
-   * *   desc: sorts the retrieved entries in descending order.
+   * - **asc**: ascending order. This is the default value.
+   * - **desc**: descending order.
    * 
    * @example
    * asc
@@ -28,7 +28,7 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The number of the page to return. The value of this parameter must be an integer that is greater than 0. 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
@@ -36,7 +36,7 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of clusters to return on each page.
+   * The number of clusters to display per page.
    * 
    * @example
    * 10
@@ -44,9 +44,9 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The content of the query condition.
+   * The specific content of the query condition.
    * 
-   * >  You must set the **Type parameter** to specify the type of the query condition.
+   * > You must first specify the **Type** parameter to define the query key.
    * 
    * @example
    * dtspk3f13r731m****
@@ -54,7 +54,7 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   params?: string;
   /**
    * @remarks
-   * The ID of the region.
+   * The region ID. This parameter is used as a query condition.
    * 
    * @example
    * cn-hangzhou
@@ -70,16 +70,16 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The status of the cluster. Valid values:
+   * The cluster status. Valid values:
    * 
-   * *   **init**: The cluster is being initialized.
-   * *   **schedule**: The cluster is pending scheduling.
-   * *   **running**: The cluster is running.
-   * *   **upgrade**: The cluster is being upgraded.
-   * *   **downgrade**: The cluster is being downgraded.
-   * *   **locked**: The cluster is locked.
-   * *   **releasing**: The cluster is being released.
-   * *   **released**: The cluster is released.
+   * - **init**: initializing.
+   * - **schedule**: pending scheduling.
+   * - **running**: running.
+   * - **upgrade**: upgrading.
+   * - **downgrade**: downgrading.
+   * - **locked**: locked.
+   * - **releasing**: being released.
+   * - **released**: released.
    * 
    * @example
    * init
@@ -87,13 +87,13 @@ export class ListDedicatedClusterRequest extends $dara.Model {
   state?: string;
   /**
    * @remarks
-   * The type of the query condition. Valid values:
+   * The query key. Valid values:
    * 
-   * *   **NAME**: the name of the cluster.
-   * *   **INSTANCE**: the ID of a cluster instance.
-   * *   **DEDICAETEDCLUSTERID**: the ID of a dedicated cluster.
+   * - **NAME**: cluster name.
+   * - **INSTANCE**: cluster instance ID.
+   * - **DEDICATEDCLUSTERID**: dedicated cluster ID.
    * 
-   * >  You must specify the query condition by using the **Params** parameter.
+   * > You must also specify the **Params** parameter to provide the specific content of the query condition.
    * 
    * @example
    * NAME

package/src/models/ListDedicatedClusterResponseBody.ts

@@ -136,7 +136,7 @@ export class ListDedicatedClusterResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * The page number of the returned page. The value must be an integer that is greater than 0. Default value: 1.
+   * The page number. The value is a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.
    * 
    * @example
    * 1
@@ -144,7 +144,7 @@ export class ListDedicatedClusterResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries returned per page.
+   * The maximum number of records that can be displayed on the current page.
    * 
    * @example
    * 20
@@ -152,7 +152,7 @@ export class ListDedicatedClusterResponseBody extends $dara.Model {
   pageRecordCount?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
@@ -168,7 +168,7 @@ export class ListDedicatedClusterResponseBody extends $dara.Model {
   success?: string;
   /**
    * @remarks
-   * The total number of clusters that meet the query condition.
+   * The total number of clusters that meet the specified conditions.
    * 
    * @example
    * 15

package/src/models/ListJobStepRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListJobStepRequest extends $dara.Model {
   /**
    * @remarks
+   * Migration or sync task ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,16 +14,27 @@ export class ListJobStepRequest extends $dara.Model {
    */
   dtsJobId?: string;
   /**
+   * @remarks
+   * 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-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-aek3dcgyq7p****
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * Indicates whether the job is a seamless integration (Zero-ETL) job. Valid values:
+   * - **true**: Yes.
+   * - **false**: No.
+   * 
    * @example
    * true
    */

package/src/models/ListJobStepResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListJobStepResponseBodyJobStepsErrorDetails extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * 200
    */
   errorCode?: string;
   /**
+   * @remarks
+   * URL of the help document.
+   * 
    * @example
    * ****
    */
@@ -38,11 +44,17 @@ export class ListJobStepResponseBodyJobStepsErrorDetails extends $dara.Model {
 
 export class ListJobStepResponseBodyJobStepsSubJobStepsErrorDetails extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * Success
    */
   errorCode?: string;
   /**
+   * @remarks
+   * URL of the help document.
+   * 
    * @example
    * ****
    */
@@ -72,72 +84,133 @@ export class ListJobStepResponseBodyJobStepsSubJobStepsErrorDetails extends $dar
 
 export class ListJobStepResponseBodyJobStepsSubJobSteps extends $dara.Model {
   /**
+   * @remarks
+   * The time when the sub-job was started, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2025-01-02T02:00:21Z
    */
   bootTime?: string;
   /**
+   * @remarks
+   * Sub-task step identity.
+   * 
    * @example
    * 03
    */
   code?: string;
   /**
+   * @remarks
+   * The time when the sub-job was created, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2024-09-20T02:13:12Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * Error message.
+   * 
    * @example
    * UncaughtException:java.lang.NullPointerException
    */
   errMsg?: string;
+  /**
+   * @remarks
+   * Error message.
+   */
   errorDetails?: ListJobStepResponseBodyJobStepsSubJobStepsErrorDetails[];
   /**
+   * @remarks
+   * End time of the sub-task, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2024-03-15T02:15:14Z
    */
   finishTime?: string;
   /**
+   * @remarks
+   * Incremental data latency, in milliseconds.
+   * 
    * @example
    * 1
    */
   incLatencyMilliseconds?: string;
   /**
+   * @remarks
+   * Incremental data latency, in seconds.
+   * 
    * @example
    * 1
    */
   incLatencySeconds?: number;
   /**
+   * @remarks
+   * Job ID.
+   * 
    * @example
    * mj3z9w9s10am68o_0004_0000
    */
   jobStepId?: string;
   /**
+   * @remarks
+   * Sub-job step information. Valid values are as follows:
+   * 
+   * - Precheck: precheck phase
+   * - Incremental data service: incremental data collection phase
+   * - dts.step.struct.load: schema migration phase
+   * - dts.step.data.load: full migration phase
+   * - etl-check: extract, transform, and load (ETL) phase
+   * - Consistency validation: data verification phase
+   * - Synchronization: incremental synchronization phase
+   * 
    * @example
    * test
    */
   jobStepName?: string;
   /**
+   * @remarks
+   * The time when the sub-job was updated, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2024-08-22T02:04:35Z
    */
   modifyTime?: string;
   /**
+   * @remarks
+   * Indicates whether the acceleration feature is required.
+   * 
    * @example
    * true
    */
   needAcceleration?: boolean;
   /**
+   * @remarks
+   * Progress of the sub-job step.
+   * 
    * @example
    * 0
    */
   progress?: number;
   /**
+   * @remarks
+   * Serial number of the sub-task step. Indicates the task execution order; the smaller the numeric value, the earlier the execution order.
+   * 
    * @example
    * 123
    */
   serial?: number;
   /**
+   * @remarks
+   * Status of the sub-task step. Valid values:
+   * - Failed: failed.
+   * - Pause: paused.
+   * - Schedule: scheduled.
+   * - Init: initialization.
+   * - Running: synchronizing.
+   * - Catched: waiting for synchronization.
+   * - Finished: ended.
+   * 
    * @example
    * running
    */
@@ -196,79 +269,149 @@ export class ListJobStepResponseBodyJobStepsSubJobSteps extends $dara.Model {
 
 export class ListJobStepResponseBodyJobSteps extends $dara.Model {
   /**
+   * @remarks
+   * The job start time, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2024-04-11T09:33:23Z
    */
   bootTime?: string;
   /**
+   * @remarks
+   * Task step identity.
+   * 
    * @example
    * 01
    */
   code?: string;
   /**
+   * @remarks
+   * The job creation time, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2023-11-28T17:13:51Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * fullcheck find different records : 2372
    */
   errMsg?: string;
+  /**
+   * @remarks
+   * The error message.
+   */
   errorDetails?: ListJobStepResponseBodyJobStepsErrorDetails[];
   /**
+   * @remarks
+   * Task end time, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2024-03-15T02:15:14Z
    */
   finishTime?: string;
   /**
+   * @remarks
+   * Incremental data latency, in milliseconds.
+   * 
    * @example
    * 1
    */
   incLatencyMilliseconds?: number;
   /**
+   * @remarks
+   * Incremental data latency, in seconds.
+   * 
    * @example
    * -1
    */
   incLatencySeconds?: number;
   /**
+   * @remarks
+   * The task step ID.
+   * 
    * @example
    * l02c1f7h179****
    */
   jobStepId?: string;
+  /**
+   * @remarks
+   * Task step information. Valid values:
+   * 
+   * - Precheck: precheck phase
+   * - Incremental data service: incremental data collection phase
+   * - dts.step.struct.load: schema migration phase
+   * - dts.step.data.load: full migration phase
+   * - etl-check: extract, transform, and load phase
+   * - Consistency validation: data verification phase
+   * - Synchronization: incremental synchronization phase
+   * 
+   * @example
+   * 预检查
+   */
   jobStepName?: string;
   /**
+   * @remarks
+   * The time when the job was updated, in the format <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).
+   * 
    * @example
    * 2025-01-03T02:26:14Z
    */
   modifyTime?: string;
   /**
+   * @remarks
+   * Indicates whether the acceleration feature should be provided.
+   * 
    * @example
    * true
    */
   needAcceleration?: boolean;
   /**
+   * @remarks
+   * The progress of the task step.
+   * 
    * @example
    * 100
    */
   progress?: number;
   /**
+   * @remarks
+   * Task step serial number. Indicates the task execution order. A smaller value indicates an earlier execution order.
+   * 
    * @example
    * 1
    */
   serial?: number;
   /**
+   * @remarks
+   * Task step status.
+   * 
    * @example
    * ○ Finished
    */
   state?: string;
   /**
+   * @remarks
+   * The number of sub-jobs.
+   * 
    * @example
    * 1
    */
   subJobCount?: number;
+  /**
+   * @remarks
+   * Step information of the sub-job.
+   */
   subJobSteps?: ListJobStepResponseBodyJobStepsSubJobSteps[];
   /**
+   * @remarks
+   * Used to distinguish between the Redis full and incremental phases. Valid values:
+   * - full: Full phase
+   * - inc: Incremental phase
+   * 
    * @example
    * full
    */
@@ -336,27 +479,46 @@ export class ListJobStepResponseBodyJobSteps extends $dara.Model {
 
 export class ListJobStepResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The task step information.
+   */
   jobSteps?: ListJobStepResponseBodyJobSteps[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request succeeded.
+   * 
    * @example
    * true
    */
   success?: boolean;
   /**
+   * @remarks
+   * Indicates whether the Console 2.0 API is used.
+   * 
    * @example
    * True
    */