@alicloud/dts20200101 1.8.5 → 1.8.7

package/src/models/DescribeJobMonitorRuleRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeJobMonitorRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the data migration, 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 migration, data synchronization, or change tracking task. You can call [DescribeDtsJobs](https://help.aliyun.com/document_detail/209702.html) to obtain the task ID.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class DescribeJobMonitorRuleRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The region ID of the DTS instance. 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 [List of supported regions](https://help.aliyun.com/document_detail/141033.html).
    * 
    * @example
    * cn-shenzhen
@@ -23,7 +23,7 @@ export class DescribeJobMonitorRuleRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzydi675xfea

package/src/models/DescribeJobMonitorRuleResponseBody.ts

@@ -5,18 +5,15 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model {
   /**
    * @remarks
-   * The threshold that triggers the alert.
-   * 
-   * *   If the request parameter **Type** of the [CreateJobMonitorRule](https://help.aliyun.com/document_detail/212332.html) operation is set to **delay**, the unit of DelayRuleTime is seconds.
-   * *   If the request parameter **Type** of the [CreateJobMonitorRule](https://help.aliyun.com/document_detail/212332.html) operation is set to **full_timeout**, the unit of DelayRuleTime is hours.
+   * The threshold that triggers a latency alert. Unit: seconds.
    * 
    * @example
-   * 11
+   * 60
    */
   delayRuleTime?: number;
   /**
    * @remarks
-   * Task ID.
+   * The task ID.
    * 
    * @example
    * bi6e22ay243****
@@ -24,7 +21,10 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
   jobId?: string;
   /**
    * @remarks
-   * The task type of the DTS instance, with values: - **normal**: Migration or synchronization task. - **full_check**: Associated full check task. - **etl_check**: Associated incremental check task.
+   * The task type of the DTS instance. Valid values:
+   * - **normal**: data migration or data synchronization task.
+   * - **full_check**: associated full data validation task.
+   * - **etl_check**: associated incremental data validation task.
    * 
    * @example
    * normal
@@ -32,7 +32,7 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
   jobType?: string;
   /**
    * @remarks
-   * Alarm threshold.
+   * The alert threshold.
    * 
    * @example
    * 2
@@ -40,8 +40,9 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
   noticeValue?: number;
   /**
    * @remarks
-   * The statistical period for incremental validation tasks, in minutes.
-   * > Currently supported values are 1 minute, 5 minutes, 10 minutes, and 30 minutes.
+   * The statistical period of the incremental data validation task. Unit: minutes.
+   * 
+   * > Valid values: 1, 5, 10, and 30 minutes.
    * 
    * @example
    * 5
@@ -49,7 +50,7 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
   period?: number;
   /**
    * @remarks
-   * The mobile phone numbers that receive alert notifications. Multiple mobile numbers are separated by commas (,).
+   * The phone numbers of the contacts to be notified when an alert is triggered. Multiple phone numbers are separated by commas (,).
    * 
    * @example
    * 1361234****,1371234****
@@ -59,8 +60,8 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
    * @remarks
    * Indicates whether the monitoring rule is enabled. Valid values:
    * 
-   * *   **Y**: The monitoring rule is enabled.
-   * *   **N**: The monitoring rule is disabled.
+   * - **Y**: enabled.
+   * - **N**: disabled.
    * 
    * @example
    * Y
@@ -68,7 +69,7 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
   state?: string;
   /**
    * @remarks
-   * The number of cycles for the incremental validation task.
+   * The number of periods for the incremental data validation task.
    * 
    * @example
    * 2
@@ -77,9 +78,10 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
   /**
    * @remarks
    * The type of the monitoring rule. Valid values:
-   * 
-   * *   **delay**: If the task latency reaches the threshold, an alert is triggered.
-   * *   **error**: If an exception occurs, an alert is triggered.
+   * - **delay**: latency alert.
+   * - **error**: anomaly alert.
+   * - **full_timeout**: alert for the runtime of the full data module.
+   * - **warn**: notification alert (the task succeeded but the result did not meet expectations).
    * 
    * @example
    * delay
@@ -125,7 +127,7 @@ export class DescribeJobMonitorRuleResponseBodyMonitorRules extends $dara.Model
 export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code. This parameter will be removed in the future.
+   * The error code. This parameter will be deprecated.
    * 
    * @example
    * 200
@@ -141,9 +143,8 @@ export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter is used to replace the **%s** variable in the **ErrMessage** parameter.
-   * 
-   * >  If the specified **DtsJobId** parameter is invalid, **The Value of Input Parameter %s is not valid** is returned for **ErrMessage** and **DtsJobId** is returned for **DynamicMessage**.
+   * The dynamic error message used to replace the **%s** placeholder in the **ErrMessage** response parameter.
+   * > For example, if **ErrMessage** returns **The Value of Input Parameter %s is not valid** and **DynamicMessage** returns **DtsJobId**, the request parameter **DtsJobId** is invalid.
    * 
    * @example
    * DtsJobId
@@ -151,7 +152,7 @@ export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the call failed.
+   * The error code returned if the call fails.
    * 
    * @example
    * 403
@@ -159,7 +160,7 @@ export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the call failed.
+   * The error message returned if the call fails.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -175,12 +176,12 @@ export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * The monitoring rules of the DTS task.
+   * The monitoring rule information of the DTS task.
    */
   monitorRules?: DescribeJobMonitorRuleResponseBodyMonitorRules[];
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 0CA14388-DD89-4A7B-8CDD-884A10CE****
@@ -188,10 +189,9 @@ export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful. Valid values:
-   * 
-   * *   **true**: The call was successful.
-   * *   **false**:The call failed.
+   * Indicates whether the request was successful. Valid values:
+   * - **true**: The request was successful.
+   * - **false**: The request failed.
    * 
    * @example
    * true
@@ -199,7 +199,7 @@ export class DescribeJobMonitorRuleResponseBody extends $dara.Model {
   success?: boolean;
   /**
    * @remarks
-   * The topics of all subtasks in the distributed change tracking task.
+   * The Kafka topics.
    */
   topics?: string[];
   static names(): { [key: string]: string } {

package/src/models/DescribeMetricListRequest.ts

@@ -13,7 +13,7 @@ export class DescribeMetricListRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. **The token can contain only ASCII characters and cannot exceed 64 characters in length.
+   * Ensures the idempotency of the request. Generate a parameter value from your client to make sure that the value is unique among different requests. **ClientToken** supports only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * 0c593ea1-3bea-11e9-b96b-88e9fe63****
@@ -21,7 +21,7 @@ export class DescribeMetricListRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * The ID of the data migration or synchronization task.
+   * The ID of the data migration or data synchronization task.
    * 
    * @example
    * k2gm967v16f****
@@ -29,7 +29,7 @@ export class DescribeMetricListRequest extends $dara.Model {
   dtsJobId?: string;
   /**
    * @remarks
-   * The timestamp that indicates the end of the time range to query. Unit: milliseconds.
+   * The end timestamp, in milliseconds.
    * 
    * @example
    * 1642476194000
@@ -45,13 +45,13 @@ export class DescribeMetricListRequest extends $dara.Model {
   env?: string;
   /**
    * @remarks
-   * *   **InternetOut**: the outbound traffic over the Internet. Unit: byte.
-   * *   **diskusage_utilization**: the disk usage.
-   * *   **IntranetInRate**: the inbound traffic over the internal network. Unit: byte.
-   * *   **InternetIn**: the inbound traffic from the Internet. Unit: byte.
-   * *   **cpu_total**: the CPU utilization.
-   * *   **memory_usedutilization**: the memory usage.
-   * *   **IntranetOutRate**: the outbound traffic over the internal network. Unit: byte.
+   * - **InternetOut**: outbound Internet traffic, in bytes.
+   * - **diskusage_utilization**: disk usage.
+   * - **IntranetInRate**: inbound internal network traffic, in bytes.
+   * - **InternetIn**: inbound Internet traffic, in bytes.
+   * - **cpu_total**: CPU utilization.
+   * - **memory_usedutilization**: memory utilization.
+   * - **IntranetOutRate**: outbound internal network traffic, in bytes.
    * 
    * This parameter is required.
    * 
@@ -61,10 +61,9 @@ export class DescribeMetricListRequest extends $dara.Model {
   metricName?: string;
   /**
    * @remarks
-   * Indicates whether the metrics of the cluster or a node are queried. Valid values:
-   * 
-   * *   **CLUSTER**: The metrics of the cluster are queried.
-   * *   **NODE**: The metrics of a node are queried.
+   * Specifies whether to query a cluster or a node. Valid values:
+   * - **CLUSTER**: cluster.
+   * - **NODE**: node.
    * 
    * @example
    * NODE
@@ -73,7 +72,7 @@ export class DescribeMetricListRequest extends $dara.Model {
   ownerID?: string;
   /**
    * @remarks
-   * The monitored object. If the **MetricType** parameter is set to **NODE**, set this parameter to the ID of the node that is monitored.
+   * The observation value. If **MetricType** is set to **NODE**, the value is **nodeid**.
    * 
    * This parameter is required.
    * 
@@ -83,7 +82,7 @@ export class DescribeMetricListRequest extends $dara.Model {
   param?: string;
   /**
    * @remarks
-   * The monitoring interval. Unit: seconds. The minimum value is 15.
+   * The observation interval in seconds. The minimum interval is 15 seconds.
    * 
    * @example
    * 15
@@ -99,7 +98,7 @@ export class DescribeMetricListRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * The timestamp that indicates the beginning of the time range to query. Unit: milliseconds.
+   * The start timestamp, in milliseconds.
    * 
    * @example
    * 1642476144000

package/src/models/DescribeMetricListResponseBody.ts

@@ -13,7 +13,7 @@ export class DescribeMetricListResponseBodyDataPoints extends $dara.Model {
   statistics?: number;
   /**
    * @remarks
-   * The timestamp of the record. Unit: milliseconds.
+   * The record timestamp, in milliseconds.
    * 
    * @example
    * 1650872310000
@@ -45,7 +45,7 @@ export class DescribeMetricListResponseBodyDataPoints extends $dara.Model {
 export class DescribeMetricListResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The error code returned by the backend service. The number is incremented.
+   * The backend error code, which is an incrementing number.
    * 
    * @example
    * 403
@@ -53,12 +53,12 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   code?: string;
   /**
    * @remarks
-   * The monitoring statistics.
+   * The monitoring statistics information.
    */
   dataPoints?: DescribeMetricListResponseBodyDataPoints[];
   /**
    * @remarks
-   * The dynamic part in the error message. This parameter is used to replace the %s variable in the **ErrMessage** parameter.
+   * The dynamic error message, which is used to replace the %s placeholder in the **ErrMessage** error message.
    * 
    * @example
    * Type
@@ -66,7 +66,7 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   dynamicMessage?: string;
   /**
    * @remarks
-   * The error code returned if the request failed.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -74,7 +74,7 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * The error message returned if the request failed.
+   * The error message.
    * 
    * @example
    * The Value of Input Parameter %s is not valid.
@@ -82,7 +82,7 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * The HTTP status code returned for an exception.
+   * The HTTP status code corresponding to the exception.
    * 
    * @example
    * 403
@@ -90,13 +90,13 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   httpStatusCode?: number;
   /**
    * @remarks
-   * *   **InternetOut**: the outbound traffic over the Internet. Unit: byte.
-   * *   **diskusage_utilization**: the disk usage.
-   * *   **IntranetInRate**: the inbound traffic over the internal network. Unit: byte.
-   * *   **InternetIn**: the inbound traffic from the Internet. Unit: byte.
-   * *   **cpu_total**: the CPU utilization.
-   * *   **memory_usedutilization**: the memory usage.
-   * *   **IntranetOutRate**: the outbound traffic over the internal network. Unit: byte.
+   * - **InternetOut**: outbound Internet traffic, in bytes.
+   * - **diskusage_utilization**: disk usage.
+   * - **IntranetInRate**: inbound internal network traffic, in bytes.
+   * - **InternetIn**: inbound Internet traffic, in bytes.
+   * - **cpu_total**: CPU utilization.
+   * - **memory_usedutilization**: memory utilization.
+   * - **IntranetOutRate**: outbound internal network traffic, in bytes.
    * 
    * @example
    * cpu_total
@@ -104,10 +104,9 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   metricName?: string;
   /**
    * @remarks
-   * Indicates whether the metrics of the cluster or a node are queried. Valid values:
-   * 
-   * *   **CLUSTER**: The metrics of the cluster are queried.
-   * *   **NODE**: The metrics of a node are queried.
+   * Specifies whether to query a cluster or a node. Valid values:
+   * - **CLUSTER**: cluster.
+   * - **NODE**: node.
    * 
    * @example
    * CLUSTER
@@ -115,10 +114,10 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   metricType?: string;
   /**
    * @remarks
-   * The monitored object.
+   * The observation value.
    * 
-   * *   If the **MetricType** parameter is set to **NODE**, the value of this parameter is the ID of the node that is monitored.****
-   * *   If the **MetricType** parameter is set to **CLUSTER**, the value of this parameter is the ID of the dedicated cluster. You can obtain the ID by calling the ListDedicatedCluster operation.
+   * - If **MetricType** is set to **NODE**, the value is **nodeid**.
+   * - If **MetricType** is set to **CLUSTER**, the value is the ID of the dedicated cluster, which can be obtained by calling the ListDedicatedCluster operation.
    * 
    * @example
    * ecs-jhjnjjn
@@ -126,7 +125,7 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   param?: string;
   /**
    * @remarks
-   * The monitoring interval. Unit: seconds. Minimum value: 15.
+   * The observation interval in seconds. The minimum interval is 15 seconds.
    * 
    * @example
    * 15
@@ -134,7 +133,7 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   period?: number;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * 621BB4F8-3016-4FAA-8D5A-5D3163CC****
@@ -142,7 +141,7 @@ export class DescribeMetricListResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the call was successful.
    * 
    * @example
    * true

package/src/models/DescribeMigrationJobAlertRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMigrationJobAlertRequest extends $dara.Model {
   /**
    * @remarks
-   * ID of the Alibaba Cloud primary account. No need to set this parameter as it will be deprecated soon.
+   * The ID of the Alibaba Cloud account. You do not need to specify this parameter because this parameter is about to be discontinued.
    * 
    * @example
    * 12323344****
@@ -13,7 +13,7 @@ export class DescribeMigrationJobAlertRequest extends $dara.Model {
   accountId?: string;
   /**
    * @remarks
-   * Used to ensure the idempotence of requests. This parameter value should be generated by the client, ensuring uniqueness across different requests. The maximum length is 64 ASCII characters, and the value must not contain non-ASCII characters.
+   * The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The value can contain only ASCII characters and cannot exceed 64 characters in length.
    * 
    * @example
    * ETnLKlblzczshOTUbOCz****
@@ -21,7 +21,7 @@ export class DescribeMigrationJobAlertRequest extends $dara.Model {
   clientToken?: string;
   /**
    * @remarks
-   * Data migration instance ID, which can be queried by calling the DescribeMigrationJobs interface.
+   * The ID of the data migration instance. You can call the DescribeMigrationJobs operation to query the ID.
    * 
    * This parameter is required.
    * 
@@ -32,7 +32,7 @@ export class DescribeMigrationJobAlertRequest extends $dara.Model {
   ownerId?: string;
   /**
    * @remarks
-   * The ID of the region where the data migration instance is located. For more details, please refer to the [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
@@ -40,7 +40,7 @@ export class DescribeMigrationJobAlertRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfmzawhxxc****

package/src/models/DescribeMigrationJobAlertResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Phone number of the contact for delay alarm.
+   * The mobile phone number of the contact for latency alerts.
    * 
    * @example
    * 1361234****,1371234****
@@ -13,8 +13,10 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   delayAlertPhone?: string;
   /**
    * @remarks
-   * Whether to monitor the delay status, return values:
-   * - **enable**: Yes. - **disable**: No.
+   * Indicates whether latency status monitoring is enabled. Valid values:
+   * 
+   * - **enable**: Enabled.
+   * - **disable**: Disabled.
    * 
    * @example
    * enable
@@ -22,7 +24,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   delayAlertStatus?: string;
   /**
    * @remarks
-   * The threshold for triggering a delayed alarm, in seconds.
+   * The threshold that triggers a latency alert. Unit: seconds.
    * 
    * @example
    * 0
@@ -30,7 +32,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   delayOverSeconds?: string;
   /**
    * @remarks
-   * Error code returned when the call fails.
+   * The error code returned when the call fails.
    * 
    * @example
    * InternalError
@@ -38,7 +40,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   errCode?: string;
   /**
    * @remarks
-   * Indicates whether the call was successful.
+   * The error message returned when the call fails.
    * 
    * @example
    * The request processing has failed due to some unknown error.
@@ -46,7 +48,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   errMessage?: string;
   /**
    * @remarks
-   * Phone number of the contact for abnormal alarm notifications
+   * The mobile phone number of the contact for error alerts.
    * 
    * @example
    * 1361234****,1371234****
@@ -54,8 +56,10 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   errorAlertPhone?: string;
   /**
    * @remarks
-   * Whether to monitor for abnormal status, return values:
-   * - **enable**: Yes. - **disable**: No.
+   * Indicates whether error status monitoring is enabled. Valid values:
+   * 
+   * - **enable**: Enabled.
+   * - **disable**: Disabled.
    * 
    * @example
    * enable
@@ -63,7 +67,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   errorAlertStatus?: string;
   /**
    * @remarks
-   * Data migration instance ID.
+   * The ID of the data migration instance.
    * 
    * @example
    * dtslb9113qq11n****
@@ -71,7 +75,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   migrationJobId?: string;
   /**
    * @remarks
-   * Name of the data migration task.
+   * The name of the data migration task.
    * 
    * @example
    * zwy-test5
@@ -79,7 +83,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   migrationJobName?: string;
   /**
    * @remarks
-   * The ID of the request.
+   * The request ID.
    * 
    * @example
    * CFB89C51-6F03-519C-A921-AAE28D50AEFB
@@ -87,7 +91,7 @@ export class DescribeMigrationJobAlertResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the request was successful.
+   * Indicates whether the request was successful.
    * 
    * @example
    * true