@alicloud/dts20200101 1.8.6 → 1.9.0

package/src/models/DescribeDedicatedClusterRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDedicatedClusterRequest extends $dara.Model {
   /**
    * @remarks
-   * The cluster ID.
+   * The ID of the dedicated cluster.
    * 
    * This parameter is required.
    * 
@@ -16,7 +16,7 @@ export class DescribeDedicatedClusterRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The region in which the instance resides.
+   * The region ID of the instance.
    * 
    * @example
    * cn-hangzhou
@@ -24,7 +24,7 @@ export class DescribeDedicatedClusterRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/DescribeDedicatedClusterResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   cpuUtilization?: number;
   /**
    * @remarks
-   * The cluster ID.
+   * The ID of the dedicated cluster.
    * 
    * @example
    * dtsCluster****
@@ -21,7 +21,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   dedicatedClusterId?: string;
   /**
    * @remarks
-   * The cluster name.
+   * The name of the dedicated cluster.
    * 
    * @example
    * daily_test
@@ -29,7 +29,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   dedicatedClusterName?: string;
   /**
    * @remarks
-   * The disk utilization.
+   * The disk usage.
    * 
    * @example
    * 50
@@ -61,7 +61,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   duUtilization?: number;
   /**
    * @remarks
-   * The error code returned when the call fails.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -69,7 +69,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -85,7 +85,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   gmtCreated?: number;
   /**
    * @remarks
-   * The end time.
+   * The completion time.
    * 
    * @example
    * 1645200000000
@@ -101,7 +101,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * The memory utilization.
+   * The memory usage.
    * 
    * @example
    * 20
@@ -109,7 +109,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   memUtilization?: number;
   /**
    * @remarks
-   * The number of nodes in the cluster.
+   * The number of nodes in the dedicated cluster.
    * 
    * @example
    * 5
@@ -125,7 +125,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   oversoldDu?: number;
   /**
    * @remarks
-   * The region in which the instance resides.
+   * The region where the instance is deployed.
    * 
    * @example
    * cn-hangzhou
@@ -133,7 +133,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
@@ -141,16 +141,15 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The cluster status. Valid values:
-   * 
-   * - **init**: initialization.
-   * - **schedule**: pending scheduling.
-   * - **running**: running.
-   * - **upgrade**: upgrading.
-   * - **downgrade**: downgrading.
-   * - **locked**: locked.
-   * - **releasing**: being released.
-   * - **released**: released.
+   * The status of the dedicated cluster. Valid values:
+   * - **init**: initializing
+   * - **schedule**: pending scheduling
+   * - **running**: running
+   * - **upgrade**: upgrading
+   * - **downgrade**: downgrading
+   * - **locked**: locked
+   * - **releasing**: releasing
+   * - **released**: released
    * 
    * @example
    * inti
@@ -174,7 +173,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   totalCpuCore?: number;
   /**
    * @remarks
-   * The total disk size, in GB.
+   * The total disk size in GB.
    * 
    * @example
    * 2048
@@ -182,7 +181,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   totalDiskGBSize?: number;
   /**
    * @remarks
-   * The total memory size, in GB.
+   * The total memory size in GB.
    * 
    * @example
    * 256
@@ -198,7 +197,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   usedCpuCore?: number;
   /**
    * @remarks
-   * The used disk size, in GB.
+   * The used disk size in GB.
    * 
    * @example
    * 1024
@@ -214,7 +213,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   usedDu?: number;
   /**
    * @remarks
-   * The used memory size, in GB.
+   * The used memory size in GB.
    * 
    * @example
    * 128

package/src/models/DescribeDocParserJobResultRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDocParserJobResultRequest extends $dara.Model {
   /**
    * @remarks
-   * The task ID (DtsJobId) returned when the document parsing task was created.
+   * The task ID (DtsJobId) returned when the document parsing task is created.
    * 
    * @example
    * dts-20250729-y0zz3t13h7d****
@@ -13,7 +13,7 @@ export class DescribeDocParserJobResultRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The instance ID of the DTS RagFlow instance.
+   * The instance ID of the DTS RagFlow.
    * 
    * @example
    * dtsgbe12he619iy801

package/src/models/DescribeDocParserJobResultResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDocParserJobResultResponseBodyContentList extends $dara.Model {
   /**
    * @remarks
-   * The text content of the corresponding page, which is the complete Markdown text after parsing.
+   * The text content of the corresponding page, which is the complete parsed Markdown text.
    * 
    * @example
    * * Demo * ** Demo title **
@@ -46,12 +46,12 @@ export class DescribeDocParserJobResultResponseBody extends $dara.Model {
   /**
    * @remarks
    * The complete text parsing content.
-   * > If the task type is content, ContentList splits the original document by page. Each page has a separate Markdown text entry.
+   * > For a content task, ContentList splits the original document by page. Each page has a separate Markdown text block.
    */
   contentList?: DescribeDocParserJobResultResponseBodyContentList[];
   /**
    * @remarks
-   * The dynamic error code. This parameter will be deprecated.
+   * The dynamic error code. This parameter will be deprecated soon.
    * 
    * @example
    * 403
@@ -59,8 +59,8 @@ export class DescribeDocParserJobResultResponseBody extends $dara.Model {
   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.
+   * The dynamic error message. It is 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**, the specified **DtsJobId** request parameter is invalid.
    * 
    * @example
    * DtsJobId
@@ -68,7 +68,7 @@ export class DescribeDocParserJobResultResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned when the call fails.
+   * The error code returned when an error occurs.
    * 
    * @example
    * InternalError
@@ -76,7 +76,7 @@ export class DescribeDocParserJobResultResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned when an error occurs.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -86,7 +86,7 @@ export class DescribeDocParserJobResultResponseBody extends $dara.Model {
    * @remarks
    * The OSS download URL of the file.
    * 
-   * > If the task type is zip, this field returns the download URL of the zip package. The URL is valid for 30 minutes.
+   * > For a ZIP task, this field returns the download URL of the ZIP package. The URL is valid for 30 minutes.
    * 
    * @example
    * https://oss-cn-hangzhou.aliyuncs.com/806a_209584525031252870_078f1180f27b4c069c0f271758aa****
@@ -118,7 +118,7 @@ export class DescribeDocParserJobResultResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/DescribeDocParserJobStatusRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDocParserJobStatusRequest extends $dara.Model {
   /**
    * @remarks
-   * The task ID (DtsJobId) returned when the document parsing task was created.
+   * The task ID (DtsJobId) returned when the document parsing task is created.
    * 
    * @example
    * dts-20250729-l3m1213ye7l****

package/src/models/DescribeDocParserJobStatusResponseBody.ts

@@ -13,8 +13,8 @@ export class DescribeDocParserJobStatusResponseBody extends $dara.Model {
   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 **DtsJobId**, the request parameter **DtsJobId** is invalid.
+   * The dynamic error message, which is used to replace **%s** in the **ErrMessage** error message.
+   * > If **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the **DtsJobId** request parameter is invalid.
    * 
    * @example
    * DtsJobId
@@ -22,7 +22,7 @@ export class DescribeDocParserJobStatusResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned when the call fails.
+   * The error code returned when an error occurs.
    * 
    * @example
    * InternalError
@@ -30,7 +30,7 @@ export class DescribeDocParserJobStatusResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned when the call fails.
+   * The error message returned when an error occurs.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -56,11 +56,11 @@ export class DescribeDocParserJobStatusResponseBody extends $dara.Model {
    * @remarks
    * The status of the DTS document parsing task. Valid values:
    * 
-   * - **NotStarted**: not started.
-   * - **Running**: document parsing in progress.
-   * - **Suspending**: pausing.
-   * - **Failed**: document parsing failed.
-   * - **Finished**: document parsing completed.
+   * - **NotStarted**: Not started.
+   * - **Running**: Parsing documents.
+   * - **Suspending**: Suspending.
+   * - **Failed**: Document parsing failed.
+   * - **Finished**: Document parsing completed.
    * 
    * @example
    * Finished
@@ -68,7 +68,7 @@ export class DescribeDocParserJobStatusResponseBody extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/DescribeDtsEtlJobVersionInfoRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   /**
    * @remarks
-   * The DTS instance ID. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the instance ID.
+   * The ID of the DTS instance. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the instance ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   dtsInstanceId?: string;
   /**
    * @remarks
-   * The ETL task ID. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
+   * The ID of the ETL task. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
    * 
    * @example
    * l5512es7w15****
@@ -31,7 +31,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries per page in a paged query. Settings this parameter for paging. Default value: 20.
+   * The paging Settings for the number of entries per page in a paged query. Default value: 20.
    * 
    * @example
    * 20
@@ -39,7 +39,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The region ID of the DTS instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query available regions.
+   * The region ID of the DTS instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the list of Alibaba Cloud regions.
    * 
    * @example
    * cn-hangzhou
@@ -47,7 +47,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/DescribeDtsEtlJobVersionInfoResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBodyDtsEtlJobVersionInfos exten
   createTime?: string;
   /**
    * @remarks
-   * The creator ID.
+   * The ID of the creator.
    * 
    * @example
    * 10000000
@@ -37,7 +37,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBodyDtsEtlJobVersionInfos exten
   dtsInstanceId?: string;
   /**
    * @remarks
-   * The ETL task ID.
+   * The ID of the ETL task.
    * 
    * @example
    * l5512es7w15****
@@ -61,7 +61,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBodyDtsEtlJobVersionInfos exten
   modifyTime?: string;
   /**
    * @remarks
-   * The safe checkpoint, which indicates the current position of the ETL task.
+   * The security checkpoint, which is the current checkpoint of the ETL task.
    * 
    * @example
    * 1637230117000
@@ -130,7 +130,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   dtsEtlJobVersionInfos?: DescribeDtsEtlJobVersionInfoResponseBodyDtsEtlJobVersionInfos[];
   /**
    * @remarks
-   * The dynamic error code associated with this request.
+   * The dynamic error code associated with the request.
    * 
    * @example
    * 403
@@ -138,7 +138,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   dynamicCode?: string;
   /**
    * @remarks
-   * The dynamic error message associated with this request.
+   * The dynamic error message associated with the request.
    * 
    * @example
    * present environment is not support,so skip
@@ -146,7 +146,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned when the specified ETL task ID is invalid and the corresponding task cannot be found.
+   * The error code returned when the specified ETL task ID is incorrect and the corresponding task cannot be found.
    * 
    * @example
    * InvalidJobId
@@ -154,7 +154,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned when the specified ETL task ID is invalid and the corresponding task cannot be found. The task may have been deleted.
+   * The error message returned when the specified ETL task ID is incorrect and the corresponding task cannot be found. The task may have been deleted.
    * 
    * @example
    * The specified dts job id %s is not exists.
@@ -178,7 +178,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of records on the current page.
+   * The number of entries returned on the current page.
    * 
    * @example
    * 20
@@ -194,7 +194,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful. A value of false indicates a failure.
+   * Indicates whether the request was successful. If the request fails, false is returned.
    * 
    * @example
    * true
@@ -202,7 +202,7 @@ export class DescribeDtsEtlJobVersionInfoResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The total number of records.
+   * The total number of entries.
    * 
    * @example
    * 200

package/src/models/DescribeDtsJobDetailRequest.ts

@@ -3,10 +3,17 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDtsJobDetailRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The output type of the migration object information.
+   * 
+   * @example
+   * NONE
+   */
   dbObjectOutputType?: string;
   /**
    * @remarks
-   * The instance ID of the data migration, data synchronization, or subscribe instance.
+   * The data migration, data synchronization, or subscribe instance ID.
    * 
    * @example
    * dtsta7w132u12h****
@@ -22,7 +29,7 @@ export class DescribeDtsJobDetailRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The ID of the region in which the task resides. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
+   * The region ID of the task. For more information, see [Supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-hangzhou
@@ -30,7 +37,7 @@ export class DescribeDtsJobDetailRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The resource group ID.
+   * The ID of the resource group.
    * 
    * @example
    * rg-acfmzawhxxc****
@@ -38,7 +45,7 @@ export class DescribeDtsJobDetailRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Specifies whether to return information about all synchronization subtasks. Default value: **false**, which returns only the synchronization subtask that is in progress or the most recently executed synchronization subtask.
+   * Specifies whether to return the information about all synchronization subtasks. Default value: **false**. If this parameter is set to false, only the information about the ongoing or most recently executed synchronization subtask is returned.
    * 
    * @example
    * false
@@ -51,7 +58,7 @@ export class DescribeDtsJobDetailRequest extends $dara.Model {
    * - **Reverse**: reverse.
    * 
    * > - Default value: **Forward**.
-   * - The value **Reverse** takes effect only when the synchronization topology of the data synchronization instance is two-way synchronization.
+   * - This parameter takes effect only when you set it to **Reverse** and the synchronization topology of the data synchronization instance is two-way synchronization.
    * 
    * @example
    * Forward
@@ -59,9 +66,9 @@ export class DescribeDtsJobDetailRequest extends $dara.Model {
   synchronizationDirection?: string;
   /**
    * @remarks
-   * Specifies whether the task is a zero-ETL task. Valid values:
-   * - **true**: The task is a zero-ETL task.
-   * - **false**: The task is not a zero-ETL task.
+   * Specifies whether the node is a seamless integration (Zero-ETL) node. Valid values:
+   * - **true**: yes.
+   * - **false**: no.
    * 
    * @example
    * false