@alicloud/dts20200101 1.8.4 → 1.8.6

package/src/models/DescribeDedicatedClusterMonitorRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDedicatedClusterMonitorRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the cluster.
+   * The cluster ID.
    * 
    * @example
    * dtsClustervcwn1oeyu5fx4yf
@@ -14,7 +14,7 @@ export class DescribeDedicatedClusterMonitorRuleRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region in which the instance resides.
+   * The region in which the instance resides.
    * 
    * @example
    * cn-hangzhou
@@ -22,10 +22,10 @@ export class DescribeDedicatedClusterMonitorRuleRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID. This is a global parameter that does not need to be passed in for this operation.
    * 
    * @example
-   * rg-acfmzawhxxc****
+   * 资源组ID，全局参数，当前API无需传入。
    */
   resourceGroupId?: string;
   static names(): { [key: string]: string } {

package/src/models/DescribeDedicatedClusterMonitorRuleResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The alert threshold for CPU utilization. Unit: percentage.
+   * The CPU alert threshold, in percentage.
    * 
    * @example
    * 80
@@ -13,7 +13,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   cpuAlarmThreshold?: string;
   /**
    * @remarks
-   * The ID of the cluster.
+   * The cluster ID.
    * 
    * @example
    * dtsClustervcwn1oeyu5fx4yf
@@ -21,7 +21,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   dedicatedClusterId?: string;
   /**
    * @remarks
-   * The alert threshold for disk usage. Unit: percentage.
+   * The disk alert threshold, in percentage.
    * 
    * @example
    * 80
@@ -29,7 +29,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   diskAlarmThreshold?: string;
   /**
    * @remarks
-   * The alert threshold for DTS Unit (DU) usage. Unit: percentage.
+   * The DU alert threshold, in percentage.
    * 
    * @example
    * 46
@@ -37,7 +37,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   duAlarmThreshold?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned if the call fails.
    * 
    * @example
    * InternalError
@@ -45,7 +45,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -61,7 +61,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   httpStatusCode?: string;
   /**
    * @remarks
-   * The alert threshold for memory usage. Unit: percentage.
+   * The memory alert threshold, in percentage.
    * 
    * @example
    * 80
@@ -69,10 +69,10 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   memAlarmThreshold?: string;
   /**
    * @remarks
-   * Indicates whether the alert feature is enabled. Valid values:
+   * The alert switch. Valid values:
    * 
-   * *   **1**: The alert feature is enabled.
-   * *   **0**: The alert feature is disabled.
+   * - **1**: enabled.
+   * - **0**: disabled.
    * 
    * @example
    * 1
@@ -80,7 +80,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   noticeSwitch?: string;
   /**
    * @remarks
-   * The mobile phone number to which alerts are sent. Separate multiple mobile phone numbers with commas (,).
+   * The phone numbers that receive alerts. If there are multiple phone numbers, they are separated by commas (,).
    * 
    * @example
    * 186****7653
@@ -88,7 +88,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   phones?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
@@ -96,7 +96,7 @@ export class DescribeDedicatedClusterMonitorRuleResponseBody extends $dara.Model
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/DescribeDedicatedClusterRequest.ts

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

package/src/models/DescribeDedicatedClusterResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The CPU utilization. Unit: percentage.
+   * The CPU utilization percentage.
    * 
    * @example
    * 30
@@ -13,7 +13,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   cpuUtilization?: number;
   /**
    * @remarks
-   * The ID of the cluster.
+   * The cluster ID.
    * 
    * @example
    * dtsCluster****
@@ -21,7 +21,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   dedicatedClusterId?: string;
   /**
    * @remarks
-   * The name of the cluster.
+   * The cluster name.
    * 
    * @example
    * daily_test
@@ -29,7 +29,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   dedicatedClusterName?: string;
   /**
    * @remarks
-   * The disk usage.
+   * The disk utilization.
    * 
    * @example
    * 50
@@ -37,7 +37,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   diskUtilization?: number;
   /**
    * @remarks
-   * The ID of the instance.
+   * The instance ID.
    * 
    * @example
    * dtsb8r****
@@ -45,7 +45,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   dtsInstanceID?: string;
   /**
    * @remarks
-   * The number of DTS units (DUs).
+   * The number of DUs.
    * 
    * @example
    * 30
@@ -53,7 +53,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   du?: number;
   /**
    * @remarks
-   * The DU usage. Unit: percentage.
+   * The DU utilization percentage.
    * 
    * @example
    * 16
@@ -61,7 +61,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   duUtilization?: number;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -69,7 +69,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message returned when the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -77,7 +77,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The time when the cluster was created.
+   * The creation time.
    * 
    * @example
    * 1642476144000
@@ -85,7 +85,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   gmtCreated?: number;
   /**
    * @remarks
-   * The time when the cluster stopped.
+   * The end time.
    * 
    * @example
    * 1645200000000
@@ -101,7 +101,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   httpStatusCode?: string;
   /**
    * @remarks
-   * The memory usage.
+   * The memory utilization.
    * 
    * @example
    * 20
@@ -117,7 +117,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   nodeCount?: number;
   /**
    * @remarks
-   * The number of DUs that exceeds the upper limit.
+   * The number of oversold DUs.
    * 
    * @example
    * 60
@@ -125,7 +125,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   oversoldDu?: number;
   /**
    * @remarks
-   * The ID of the region in which the instance resides.
+   * The region in which the instance resides.
    * 
    * @example
    * cn-hangzhou
@@ -133,7 +133,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
@@ -141,16 +141,16 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   requestId?: 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**: initialization.
+   * - **schedule**: pending scheduling.
+   * - **running**: running.
+   * - **upgrade**: upgrading.
+   * - **downgrade**: downgrading.
+   * - **locked**: locked.
+   * - **releasing**: being released.
+   * - **released**: released.
    * 
    * @example
    * inti
@@ -174,7 +174,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   totalCpuCore?: number;
   /**
    * @remarks
-   * The total disk size. Unit: GB.
+   * The total disk size, in GB.
    * 
    * @example
    * 2048
@@ -182,7 +182,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   totalDiskGBSize?: number;
   /**
    * @remarks
-   * The total amount of memory. Unit: GB.
+   * The total memory size, in GB.
    * 
    * @example
    * 256
@@ -198,7 +198,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   usedCpuCore?: number;
   /**
    * @remarks
-   * The used disk size. Unit: GB.
+   * The used disk size, in GB.
    * 
    * @example
    * 1024
@@ -214,7 +214,7 @@ export class DescribeDedicatedClusterResponseBody extends $dara.Model {
   usedDu?: number;
   /**
    * @remarks
-   * The amount of used memory. Unit: GB.
+   * The used memory size, in GB.
    * 
    * @example
    * 128

package/src/models/DescribeDocParserJobResultRequest.ts

@@ -4,17 +4,33 @@ 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.
+   * 
    * @example
    * dts-20250729-y0zz3t13h7d****
    */
   dtsJobId?: string;
+  /**
+   * @remarks
+   * The instance ID of the DTS RagFlow instance.
+   * 
+   * @example
+   * dtsgbe12he619iy801
+   */
   ragInstanceId?: string;
   /**
+   * @remarks
+   * The region ID of the task. 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****
    */

package/src/models/DescribeDocParserJobResultResponseBody.ts

@@ -4,11 +4,17 @@ 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.
+   * 
    * @example
    * * Demo * ** Demo title **
    */
   content?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
@@ -37,44 +43,83 @@ export class DescribeDocParserJobResultResponseBodyContentList extends $dara.Mod
 }
 
 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.
+   */
   contentList?: DescribeDocParserJobResultResponseBodyContentList[];
   /**
+   * @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
    * DtsJobId
    */
   dynamicMessage?: string;
   /**
+   * @remarks
+   * The error code returned when the call fails.
+   * 
    * @example
    * InternalError
    */
   errCode?: string;
   /**
+   * @remarks
+   * The error message returned when the call fails.
+   * 
    * @example
    * The request processing has failed due to some unknown error.
    */
   errMessage?: string;
   /**
+   * @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.
+   * 
    * @example
    * https://oss-cn-hangzhou.aliyuncs.com/806a_209584525031252870_078f1180f27b4c069c0f271758aa****
    */
   fileUrl?: string;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: number;
+  /**
+   * @remarks
+   * The public OSS download URL of the file.
+   * 
+   * @example
+   * https://oss-cn-hangzhou.aliyuncs.com/806a_209584525031252870_078f1180f27b4c069c0f271758aa****
+   */
   outerFileUrl?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C166D79D-436B-45F0-B5A5-25E1959F****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeDocParserJobStatusRequest.ts

@@ -4,17 +4,26 @@ 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.
+   * 
    * @example
    * dts-20250729-l3m1213ye7l****
    */
   dtsJobId?: string;
   ragInstanceId?: string;
   /**
+   * @remarks
+   * The region ID of the task. 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****
    */

package/src/models/DescribeDocParserJobStatusResponseBody.ts

@@ -4,41 +4,72 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDocParserJobStatusResponseBody 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 **DtsJobId**, the request parameter **DtsJobId** is invalid.
+   * 
    * @example
    * DtsJobId
    */
   dynamicMessage?: string;
   /**
+   * @remarks
+   * The error code returned when the call fails.
+   * 
    * @example
    * InternalError
    */
   errCode?: string;
   /**
+   * @remarks
+   * The error message returned when the 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
    * FDC111B1-ACBF-457D-9656-247FDEE9****
    */
   requestId?: string;
   /**
+   * @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.
+   * 
    * @example
    * Finished
    */
   status?: string;
   /**
+   * @remarks
+   * Indicates whether the request was 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 ID of the Data Transmission Service (DTS) instance. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the instance ID.
+   * The DTS instance ID. 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 ID of the ETL task. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
+   * The ETL task ID. You can call the [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) operation to query the task ID.
    * 
    * @example
    * l5512es7w15****
@@ -23,7 +23,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The number of the page to return. Default value: 1.
+   * The page number of the instance status list. Default value: 1.
    * 
    * @example
    * 1
@@ -31,7 +31,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   pageNumber?: number;
   /**
    * @remarks
-   * The number of entries to return on each page. Default value: 20.
+   * The number of entries per page in a paged query. Settings this parameter for paging. Default value: 20.
    * 
    * @example
    * 20
@@ -39,7 +39,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   pageSize?: number;
   /**
    * @remarks
-   * The ID of the region in which the DTS instance resides. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/25609.html) operation to query the available Alibaba Cloud regions.
+   * 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.
    * 
    * @example
    * cn-hangzhou
@@ -47,7 +47,7 @@ export class DescribeDtsEtlJobVersionInfoRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****