@alicloud/dataworks-public20200518 10.1.0 → 10.1.2

package/src/models/CreateDataSourceRequest.ts

@@ -5,166 +5,166 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataSourceRequest extends $dara.Model {
   /**
    * @remarks
-   * The details of the data source. Examples of details of some common data sources:
-   * 
-   * *   odps
-   * 
-   *         {
-   *           "accessId": "*****",
-   *           "accessKey": "*****",
-   *           "authType": 2,
-   *           "endpoint": "http://service.odps.aliyun.com/api",
-   *           "project": "xsaxsax",
-   *           "tag": "public"
-   *         }
-   * 
-   * *   mysql
-   * 
-   *         {
-   *           "database": "xsaxsa",
-   *           "instanceName": "rm-xsaxsa",
-   *           "password": "xsaxsa",
-   *           "rdsOwnerId": "xasxsa",
-   *           "regionId": "cn-shanghai",
-   *           "tag": "rds",
-   *           "username": "xsaxsa"
-   *         }
-   * 
-   * *   rds
-   * 
-   *         {
-   *           "configType": 1,
-   *           "tag": "rds",
-   *           "database": "xsaxsa",
-   *           "username": "xsaxsa",
-   *           "password": "xssaxsa$32050",
-   *           "instanceName": "rm-xsaxs",
-   *           "rdsOwnerId": "11111111"
-   *         }
-   * 
-   * *   oss
-   * 
-   *         {
-   *           "accessId": "*****",
-   *           "accessKey": "*****",
-   *           "bucket": "xsa-xs-xs",
-   *           "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
-   *           "tag": "public"
-   *         }
-   * 
-   * *   sqlserver
-   * 
-   *         {
-   *           "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",
-   *           "password": "sdasda$fs",
-   *           "tag": "public",
-   *           "username": "sxaxacdacdd"
-   *         }
-   * 
-   * *   polardb
-   * 
-   *         {
-   *           "clusterId": "pc-sdadsadsa",
-   *           "database": "dsadsadsa",
-   *           "ownerId": "121212122",
-   *           "password": "sdasdafssa",
-   *           "region": "cn-shanghai",
-   *           "tag": "polardb",
-   *           "username": "asdadsads"
-   *         }
-   * 
-   * *   redis
-   * 
-   *         {    
-   *         "password": "xxxxxx",   
-   *          "address":"[{\\"host\\":\\"xxxxxxx.redis.rds.aliyuncs.com\\",\\"port\\":6379}]",    
-   *         "tag": "public"
-   *         }
-   * 
-   * *   oracle
-   * 
-   *         {
-   *           "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",
-   *           "password": "sxasaxsa",
-   *           "tag": "public",
-   *           "username": "sasfadfa"
-   *         }
-   * 
-   * *   mongodb
-   * 
-   *         {
-   *           "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",
-   *           "database": "admin",
-   *           "password": "sadsda@",
-   *           "tag": "public",
-   *           "username": "dsadsadas"
-   *         }
-   * 
-   * *   emr
-   * 
-   *         {
-   *           "accessId": "*****",
-   *           "emrClusterId": "C-dsads",
-   *           "emrResourceQueueName": "default",
-   *           "emrEndpoint": "emr.aliyuncs.com",
-   *           "accessKey": "*****",
-   *           "emrUserId": "224833315798889783",
-   *           "name": "sasdsadsa",
-   *           "emrAccessMode": "simple",
-   *           "region": "cn-shanghai",
-   *           "authType": "2",
-   *           "emrProjectId": "FP-sdadsad"
-   *         }
-   * 
-   * *   postgresql
-   * 
-   *         {
-   *           "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",
-   *           "password": "sdadsads",
-   *           "tag": "public",
-   *           "username": "sdsasda"
-   *         }
-   * 
-   * *   analyticdb_for_mysql
-   * 
-   *         {
-   *           "instanceId": "am-sadsada",
-   *           "database": "xsxsx",
-   *           "username": "xsxsa",
-   *           "password": "asdadsa",
-   *           "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"
-   *         }
-   * 
-   * *   hybriddb_for_postgresql
-   * 
-   *         {
-   *           "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",
-   *           "database": "xsaxsaxas",
-   *           "password": "xsaxsaxsa@11",
-   *           "instanceId": "gp-xsaxsaxsa",
-   *           "port": "541132",
-   *           "ownerId": "xsaxsaxsas",
-   *           "username": "sadsad"
-   *         }
-   * 
-   * *   holo
-   * 
-   *         {
-   *           "accessId": "*****",
-   *           "accessKey": "*****",
-   *           "database": "xsaxsaxsa",
-   *           "instanceId": "xsaxa",
-   *           "tag": "aliyun"
-   *         }
-   * 
-   * *   kafka
-   * 
-   *         {
-   *           "instanceId": "xsax-cn-xsaxsa",
-   *           "regionId": "cn-shanghai",
-   *           "tag": "aliyun",
-   *           "ownerId": "1212121212112"
-   *         }
+   * The detailed information about the data source. The following examples show the configurations of common data sources:
+   * - odps
+   *   ```
+   *   {
+   *     "accessId": "*****",
+   *     "accessKey": "*****",
+   *     "authType": 2,
+   *     "endpoint": "http://service.odps.aliyun.com/api",
+   *     "project": "xsaxsax",
+   *     "tag": "public"
+   *   }
+   *   ```
+   * - mysql
+   *   ```
+   *   {
+   *     "database": "xsaxsa",
+   *     "instanceName": "rm-xsaxsa",
+   *     "password": "xsaxsa",
+   *     "rdsOwnerId": "xasxsa",
+   *     "regionId": "cn-shanghai",
+   *     "tag": "rds",
+   *     "username": "xsaxsa"
+   *   }
+   *   ```
+   * - rds
+   *   ```
+   *   {
+   *     "configType": 1,
+   *     "tag": "rds",
+   *     "database": "xsaxsa",
+   *     "username": "xsaxsa",
+   *     "password": "xssaxsa$32050",
+   *     "instanceName": "rm-xsaxs",
+   *     "rdsOwnerId": "11111111"
+   *   }
+   *   ```
+   * - oss
+   *   ```
+   *   {
+   *     "accessId": "*****",
+   *     "accessKey": "*****",
+   *     "bucket": "xsa-xs-xs",
+   *     "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
+   *     "tag": "public"
+   *   }
+   *   ```
+   * - sqlserver
+   *   ```
+   *   {
+   *     "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",
+   *     "password": "sdasda$fs",
+   *     "tag": "public",
+   *     "username": "sxaxacdacdd"
+   *   }
+   *   ```
+   * - polardb
+   *   ```
+   *   {
+   *     "clusterId": "pc-sdadsadsa",
+   *     "database": "dsadsadsa",
+   *     "ownerId": "121212122",
+   *     "password": "sdasdafssa",
+   *     "region": "cn-shanghai",
+   *     "tag": "polardb",
+   *     "username": "asdadsads"
+   *   }
+   *   ```
+   * - redis
+   *   ```
+   *   {    
+   *   "password": "xxxxxx",   
+   *    "address":"[{\\"host\\":\\"xxxxxxx.redis.rds.aliyuncs.com\\",\\"port\\":6379}]",    
+   *   "tag": "public"
+   *   }
+   *   ```
+   * - oracle
+   *   ```
+   *   {
+   *     "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",
+   *     "password": "sxasaxsa",
+   *     "tag": "public",
+   *     "username": "sasfadfa"
+   *   }
+   *   ```
+   * - mongodb
+   *   ```
+   *   {
+   *     "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",
+   *     "database": "admin",
+   *     "password": "sadsda@",
+   *     "tag": "public",
+   *     "username": "dsadsadas"
+   *   }
+   *   ```
+   * - emr
+   *   ```
+   *   {
+   *     "accessId": "*****",
+   *     "emrClusterId": "C-dsads",
+   *     "emrResourceQueueName": "default",
+   *     "emrEndpoint": "emr.aliyuncs.com",
+   *     "accessKey": "*****",
+   *     "emrUserId": "224833315798889783",
+   *     "name": "sasdsadsa",
+   *     "emrAccessMode": "simple",
+   *     "region": "cn-shanghai",
+   *     "authType": "2",
+   *     "emrProjectId": "FP-sdadsad"
+   *   }
+   *   ```
+   * - postgresql
+   *   ```
+   *   {
+   *     "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",
+   *     "password": "sdadsads",
+   *     "tag": "public",
+   *     "username": "sdsasda"
+   *   }
+   *   ```
+   * - analyticdb_for_mysql
+   *   ```
+   *   {
+   *     "instanceId": "am-sadsada",
+   *     "database": "xsxsx",
+   *     "username": "xsxsa",
+   *     "password": "asdadsa",
+   *     "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"
+   *   }
+   *   ```
+   * - hybriddb_for_postgresql
+   *   ```
+   *   {
+   *     "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",
+   *     "database": "xsaxsaxas",
+   *     "password": "xsaxsaxsa@11",
+   *     "instanceId": "gp-xsaxsaxsa",
+   *     "port": "541132",
+   *     "ownerId": "xsaxsaxsas",
+   *     "username": "sadsad"
+   *   }
+   *   ```
+   * - holo
+   *   ```
+   *   {
+   *     "accessId": "*****",
+   *     "accessKey": "*****",
+   *     "database": "xsaxsaxsa",
+   *     "instanceId": "xsaxa",
+   *     "tag": "aliyun"
+   *   }
+   *   ```
+   * - kafka
+   *   ```
+   *   {
+   *     "instanceId": "xsax-cn-xsaxsa",
+   *     "regionId": "cn-shanghai",
+   *     "tag": "aliyun",
+   *     "ownerId": "1212121212112"
+   *   }
+   *   ```
    * 
    * This parameter is required.
    * 
@@ -174,21 +174,20 @@ export class CreateDataSourceRequest extends $dara.Model {
   content?: string;
   /**
    * @remarks
-   * The type of the data source. Valid values:
-   * 
-   * *   odps
-   * *   mysql
-   * *   rds
-   * *   oss
-   * *   sqlserver
-   * *   polardb
-   * *   oracle
-   * *   mongodb
-   * *   emr
-   * *   postgresql
-   * *   analyticdb_for_mysql
-   * *   hybriddb_for_postgresql
-   * *   holo
+   * The type of the data source. Common types include:
+   * - odps
+   * - mysql
+   * - rds
+   * - oss
+   * - sqlserver
+   * - polardb
+   * - oracle
+   * - mongodb
+   * - emr
+   * - postgresql
+   * - analyticdb_for_mysql
+   * - hybriddb_for_postgresql
+   * - holo
    * 
    * This parameter is required.
    * 
@@ -206,7 +205,7 @@ export class CreateDataSourceRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.
+   * The environment to which the data source belongs. Valid values: 0 (development environment) and 1 (production environment).
    * 
    * This parameter is required.
    * 
@@ -226,7 +225,7 @@ export class CreateDataSourceRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
-   * The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](https://help.aliyun.com/document_detail/2780068.html) operation to query the ID.
+   * The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](https://help.aliyun.com/document_detail/2780068.html) operation to obtain the workspace ID.
    * 
    * This parameter is required.
    * 
@@ -236,10 +235,10 @@ export class CreateDataSourceRequest extends $dara.Model {
   projectId?: number;
   /**
    * @remarks
-   * The subtype of the data source.
+   * The subtype of the data source. Take note of the following items:
    * 
-   * *   This parameter takes effect only if you set the DataSourceType parameter to rds.
-   * *   If the DataSourceType parameter is set to rds, this parameter can be set to mysql, sqlserver, or postgresql.
+   * - This parameter takes effect only when the DataSourceType parameter is set to RDS.
+   * - If the DataSourceType parameter is set to RDS, you can set the SubType parameter to mysql, sqlserver, or postgresql.
    * 
    * @example
    * mysql

package/src/models/CreateDataSourceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDataSourceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The data source ID.
+   * The ID of the data source.
    * 
    * @example
    * 123
@@ -29,7 +29,7 @@ export class CreateDataSourceResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Indicates whether the request was successful.
+   * Indicates whether the request is successful.
    * 
    * @example
    * true

package/src/models/CreateDialarmRuleRequest.ts

@@ -5,15 +5,13 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDIAlarmRuleRequestNotificationSettingsNotificationChannels extends $dara.Model {
   /**
    * @remarks
-   * The alert notification methods.
+   * The list of channels.
    */
   channels?: string[];
   /**
    * @remarks
    * The severity level. Valid values:
-   * 
    * - Warning
-   * 
    * - Critical
    * 
    * @example
@@ -49,11 +47,9 @@ export class CreateDIAlarmRuleRequestNotificationSettingsNotificationChannels ex
 export class CreateDIAlarmRuleRequestNotificationSettingsNotificationReceivers extends $dara.Model {
   /**
    * @remarks
-   * The recipient type. Valid values: AliyunUid and DingToken.
-   * 
-   * - If the alert notification method is Mail, Phone, or Sms, set this parameter to **AliyunUid**, which specifies the Alibaba Cloud account ID.
-   * 
-   * - If the alert notification method is Ding, set this parameter to **DingToken**, which indicates the DingTalk chatbot token.
+   * The recipient type.
+   * - When the alert notification channel is email, phone call, or text message, set the recipient type to Alibaba Cloud user ID (**AliyunUid**).
+   * - When the alert notification channel is DingTalk, set the recipient type to DingTalk token (**DingToken**).
    * 
    * @example
    * DingToken
@@ -61,7 +57,7 @@ export class CreateDIAlarmRuleRequestNotificationSettingsNotificationReceivers e
   receiverType?: string;
   /**
    * @remarks
-   * The recipients.
+   * The list of recipient values.
    */
   receiverValues?: string[];
   static names(): { [key: string]: string } {
@@ -93,7 +89,7 @@ export class CreateDIAlarmRuleRequestNotificationSettingsNotificationReceivers e
 export class CreateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
   /**
    * @remarks
-   * The duration of the alert suppression interval. Default value: 5. Unit: minutes.
+   * The alert suppression interval, in minutes. Default value: 5.
    * 
    * @example
    * 5
@@ -101,14 +97,14 @@ export class CreateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
   inhibitionInterval?: number;
   /**
    * @remarks
-   * The alert notification methods.
+   * The alert notification channels. Multiple values are supported.
    * 
    * This parameter is required.
    */
   notificationChannels?: CreateDIAlarmRuleRequestNotificationSettingsNotificationChannels[];
   /**
    * @remarks
-   * The settings of alert notification recipients.
+   * The alert notification recipients. Multiple values are supported.
    * 
    * This parameter is required.
    */
@@ -147,7 +143,7 @@ export class CreateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
 export class CreateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
   /**
    * @remarks
-   * The time interval for alert calculation. Unit: minutes.
+   * The time interval for alert calculation, in minutes.
    * 
    * @example
    * 15
@@ -156,9 +152,7 @@ export class CreateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
   /**
    * @remarks
    * The severity level. Valid values:
-   * 
    * - Warning
-   * 
    * - Critical
    * 
    * @example
@@ -168,12 +162,9 @@ export class CreateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
   /**
    * @remarks
    * The alert threshold.
-   * 
-   * - If the alert rule is for task status, you do not need to specify a threshold.
-   * 
-   * - If the alert rule is for failovers, specify the number of failovers.
-   * 
-   * - If the alert rule is for latency, the threshold is the latency duration, in seconds.
+   * - Task status alert: No threshold is required.
+   * - Failover count alert: The threshold is the number of failovers.
+   * - Task latency alert: The threshold is the latency duration, in seconds.
    * 
    * @example
    * 5
@@ -207,7 +198,7 @@ export class CreateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
 export class CreateDIAlarmRuleRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the task with which the alert rule is associated.
+   * The ID of the task. This is the ID of the task associated with the alert rule.
    * 
    * This parameter is required.
    * 
@@ -217,7 +208,7 @@ export class CreateDIAlarmRuleRequest extends $dara.Model {
   DIJobId?: number;
   /**
    * @remarks
-   * The description of the task.
+   * The description.
    * 
    * @example
    * mysql synchronizes to hologres heartbeat alert
@@ -225,7 +216,7 @@ export class CreateDIAlarmRuleRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Specifies whether to enable the alert rule. By default, the alert rule is disabled.
+   * Specifies whether the alert rule is enabled. Default value: false.
    * 
    * @example
    * true
@@ -233,13 +224,10 @@ export class CreateDIAlarmRuleRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The metric type in the alert rule. Valid values:
-   * 
-   * - Heartbeat
-   * 
-   * - FailoverCount
-   * 
-   * - Delay
+   * The alert metric type. Valid values:
+   * - Heartbeat: task status alert
+   * - FailoverCount: failover count alert
+   * - Delay: task latency alert
    * 
    * This parameter is required.
    * 
@@ -256,7 +244,7 @@ export class CreateDIAlarmRuleRequest extends $dara.Model {
   notificationSettings?: CreateDIAlarmRuleRequestNotificationSettings;
   /**
    * @remarks
-   * The conditions that are used to trigger the alert rule.
+   * The list of alert trigger conditions. Multiple conditions are supported.
    * 
    * This parameter is required.
    */

package/src/models/CreateDialarmRuleShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the task with which the alert rule is associated.
+   * The ID of the task. This is the ID of the task associated with the alert rule.
    * 
    * This parameter is required.
    * 
@@ -15,7 +15,7 @@ export class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
   DIJobId?: number;
   /**
    * @remarks
-   * The description of the task.
+   * The description.
    * 
    * @example
    * mysql synchronizes to hologres heartbeat alert
@@ -23,7 +23,7 @@ export class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Specifies whether to enable the alert rule. By default, the alert rule is disabled.
+   * Specifies whether the alert rule is enabled. Default value: false.
    * 
    * @example
    * true
@@ -31,13 +31,10 @@ export class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
   enabled?: boolean;
   /**
    * @remarks
-   * The metric type in the alert rule. Valid values:
-   * 
-   * - Heartbeat
-   * 
-   * - FailoverCount
-   * 
-   * - Delay
+   * The alert metric type. Valid values:
+   * - Heartbeat: task status alert
+   * - FailoverCount: failover count alert
+   * - Delay: task latency alert
    * 
    * This parameter is required.
    * 
@@ -54,7 +51,7 @@ export class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
   notificationSettingsShrink?: string;
   /**
    * @remarks
-   * The conditions that are used to trigger the alert rule.
+   * The list of alert trigger conditions. Multiple conditions are supported.
    * 
    * This parameter is required.
    */