@alicloud/dataworks-public20200518 6.2.2 → 6.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/client.d.ts CHANGED
@@ -2996,7 +2996,7 @@ export declare class GetBaselineResponseBodyDataOverTimeSettings extends $dara.M
2996
2996
  cycle?: number;
2997
2997
  /**
2998
2998
  * @remarks
2999
- * 承诺时间,hh:mm格式,hh的取值范围为[0,47]mm的取值范围为[0,59]
2999
+ * Commitment time, hh:mm format, hh value range is [0,47],mm value range is [0,59].
3000
3000
  *
3001
3001
  * @example
3002
3002
  * 00:00
@@ -4875,10 +4875,51 @@ export declare class GetDISyncInstanceInfoResponseBodyData extends $dara.Model {
4875
4875
  });
4876
4876
  }
4877
4877
  export declare class GetDISyncTaskResponseBodyDataAlarmListAlarmRuleList extends $dara.Model {
4878
+ /**
4879
+ * @remarks
4880
+ * The calculation method of indicators,
4881
+ * - avg interval average
4882
+ * - max interval takes the maximum value
4883
+ *
4884
+ * @example
4885
+ * avg
4886
+ */
4878
4887
  aggregator?: string;
4888
+ /**
4889
+ * @remarks
4890
+ * Comparison method of comparison symbols, indicators and alarm rules
4891
+ * - \\"=\\"
4892
+ * - \\"<\\"
4893
+ * - \\">\\"
4894
+ *
4895
+ * @example
4896
+ * =
4897
+ */
4879
4898
  comparator?: string;
4899
+ /**
4900
+ * @remarks
4901
+ * Duration: How long does this condition last before an alarm is triggered, in minutes.
4902
+ *
4903
+ * @example
4904
+ * 3
4905
+ */
4880
4906
  duration?: number;
4907
+ /**
4908
+ * @remarks
4909
+ * - WARNING WARNING: alert
4910
+ * - CRITICAL CRITICAL: alarm
4911
+ *
4912
+ * @example
4913
+ * WARNING
4914
+ */
4881
4915
  level?: string;
4916
+ /**
4917
+ * @remarks
4918
+ * Comparison threshold between metrics and alarm rules.
4919
+ *
4920
+ * @example
4921
+ * 1
4922
+ */
4882
4923
  threshold?: number;
4883
4924
  static names(): {
4884
4925
  [key: string]: string;
@@ -4892,8 +4933,23 @@ export declare class GetDISyncTaskResponseBodyDataAlarmListAlarmRuleList extends
4892
4933
  });
4893
4934
  }
4894
4935
  export declare class GetDISyncTaskResponseBodyDataAlarmListNotifyRule extends $dara.Model {
4936
+ /**
4937
+ * @remarks
4938
+ * Critical-level alert notification list.
4939
+ */
4895
4940
  critical?: string[];
4941
+ /**
4942
+ * @remarks
4943
+ * Alarm interval, in minutes.
4944
+ *
4945
+ * @example
4946
+ * 5
4947
+ */
4896
4948
  interval?: number;
4949
+ /**
4950
+ * @remarks
4951
+ * Warning-level alert notification list.
4952
+ */
4897
4953
  warning?: string[];
4898
4954
  static names(): {
4899
4955
  [key: string]: string;
@@ -4907,12 +4963,62 @@ export declare class GetDISyncTaskResponseBodyDataAlarmListNotifyRule extends $d
4907
4963
  });
4908
4964
  }
4909
4965
  export declare class GetDISyncTaskResponseBodyDataAlarmList extends $dara.Model {
4966
+ /**
4967
+ * @remarks
4968
+ * Alarm Notification configuration array.
4969
+ */
4910
4970
  alarmRuleList?: GetDISyncTaskResponseBodyDataAlarmListAlarmRuleList[];
4971
+ /**
4972
+ * @remarks
4973
+ * Alarm rule description.
4974
+ *
4975
+ * @example
4976
+ * Description
4977
+ */
4911
4978
  description?: string;
4979
+ /**
4980
+ * @remarks
4981
+ * Whether alarm rules are enabled.
4982
+ *
4983
+ * @example
4984
+ * true
4985
+ */
4912
4986
  enabled?: boolean;
4987
+ /**
4988
+ * @remarks
4989
+ * Alarm rule id.
4990
+ *
4991
+ * @example
4992
+ * 45242
4993
+ */
4913
4994
  id?: number;
4995
+ /**
4996
+ * @remarks
4997
+ * Alarm Type:
4998
+ *
4999
+ * - taskStatus: task status
5000
+ * - bizDelay: business latency
5001
+ * - taskFailoverCount: monitoring Failover
5002
+ * - ddlUnsupport: DDL is not supported
5003
+ * - ddlReport: DDL notifications
5004
+ * - totalDirtyRecordWriteInLines: dirty data
5005
+ *
5006
+ * @example
5007
+ * taskStatus
5008
+ */
4914
5009
  metric?: string;
5010
+ /**
5011
+ * @remarks
5012
+ * Alert notification rule array.
5013
+ */
4915
5014
  notifyRule?: GetDISyncTaskResponseBodyDataAlarmListNotifyRule;
5015
+ /**
5016
+ * @remarks
5017
+ * Alarm rule name.
5018
+ *
5019
+ * @example
5020
+ * Delay alert rule name 1
5021
+ */
4916
5022
  ruleName?: string;
4917
5023
  static names(): {
4918
5024
  [key: string]: string;
@@ -5037,6 +5143,10 @@ export declare class GetDISyncTaskResponseBodyDataSolutionDetail extends $dara.M
5037
5143
  });
5038
5144
  }
5039
5145
  export declare class GetDISyncTaskResponseBodyData extends $dara.Model {
5146
+ /**
5147
+ * @remarks
5148
+ * Array of alarm rules associated with real-time tasks.
5149
+ */
5040
5150
  alarmList?: GetDISyncTaskResponseBodyDataAlarmList[];
5041
5151
  /**
5042
5152
  * @remarks
@@ -7390,7 +7500,7 @@ export declare class GetDeploymentResponseBodyDataDeployment extends $dara.Model
7390
7500
  creatorId?: string;
7391
7501
  /**
7392
7502
  * @remarks
7393
- * The error message that was returned when the deployment task failed. In this case, the value of the Status parameter is 2.
7503
+ * The error message that was returned when the deployment package failed. In this case, the value of the Status parameter is 2.
7394
7504
  *
7395
7505
  * @example
7396
7506
  * Success
@@ -7463,7 +7573,7 @@ export declare class GetDeploymentResponseBodyData extends $dara.Model {
7463
7573
  deployedItems?: GetDeploymentResponseBodyDataDeployedItems[];
7464
7574
  /**
7465
7575
  * @remarks
7466
- * The details of the deployment task.
7576
+ * The details of the deployment package.
7467
7577
  */
7468
7578
  deployment?: GetDeploymentResponseBodyDataDeployment;
7469
7579
  static names(): {
@@ -8080,12 +8190,13 @@ export declare class GetFileResponseBodyDataNodeConfiguration extends $dara.Mode
8080
8190
  endEffectDate?: number;
8081
8191
  /**
8082
8192
  * @remarks
8083
- * Scheduling configuration-> previous cycle-> whether to skip the upstream empty run attribute
8193
+ * Indicates whether to skip the dry-run property of the ancestor nodes of the node that corresponds to the file. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.
8084
8194
  *
8085
8195
  * @example
8086
8196
  * true
8087
8197
  */
8088
8198
  ignoreParentSkipRunningProperty?: string;
8199
+ imageId?: string;
8089
8200
  /**
8090
8201
  * @remarks
8091
8202
  * The output names of the parent files on which the current file depends.
@@ -8192,7 +8303,7 @@ export declare class GetFileResponseBodyDataNodeConfiguration extends $dara.Mode
8192
8303
  stop?: boolean;
8193
8304
  /**
8194
8305
  * @remarks
8195
- * Scheduling configuration timeout definition
8306
+ * The timeout period.
8196
8307
  *
8197
8308
  * @example
8198
8309
  * 1
@@ -8212,7 +8323,7 @@ export declare class GetFileResponseBodyDataNodeConfiguration extends $dara.Mode
8212
8323
  export declare class GetFileResponseBodyDataResourceDownloadLink extends $dara.Model {
8213
8324
  /**
8214
8325
  * @remarks
8215
- * Resource download address link
8326
+ * The download URL of the resource.
8216
8327
  *
8217
8328
  * @example
8218
8329
  * http://xx
@@ -8242,7 +8353,7 @@ export declare class GetFileResponseBodyData extends $dara.Model {
8242
8353
  nodeConfiguration?: GetFileResponseBodyDataNodeConfiguration;
8243
8354
  /**
8244
8355
  * @remarks
8245
- * Resource download address
8356
+ * The download URL of the resource.
8246
8357
  */
8247
8358
  resourceDownloadLink?: GetFileResponseBodyDataResourceDownloadLink;
8248
8359
  static names(): {
@@ -10791,7 +10902,7 @@ export declare class GetMetaTableColumnResponseBodyData extends $dara.Model {
10791
10902
  export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dara.Model {
10792
10903
  /**
10793
10904
  * @remarks
10794
- * The description of the column.
10905
+ * The description of the field.
10795
10906
  *
10796
10907
  * @example
10797
10908
  * data comment
@@ -10799,7 +10910,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10799
10910
  caption?: string;
10800
10911
  /**
10801
10912
  * @remarks
10802
- * The unique identifier of the column.
10913
+ * The unique identifier of the field.
10803
10914
  *
10804
10915
  * @example
10805
10916
  * odps.engine_name.table_name.1
@@ -10807,7 +10918,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10807
10918
  columnGuid?: string;
10808
10919
  /**
10809
10920
  * @remarks
10810
- * The name of the column.
10921
+ * The name of the field.
10811
10922
  *
10812
10923
  * @example
10813
10924
  * 1
@@ -10815,7 +10926,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10815
10926
  columnName?: string;
10816
10927
  /**
10817
10928
  * @remarks
10818
- * The type of the column.
10929
+ * The data type of the field.
10819
10930
  *
10820
10931
  * @example
10821
10932
  * string
@@ -10823,7 +10934,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10823
10934
  columnType?: string;
10824
10935
  /**
10825
10936
  * @remarks
10826
- * The comment for the column.
10937
+ * The remarks of the field.
10827
10938
  *
10828
10939
  * @example
10829
10940
  * comment
@@ -10831,9 +10942,10 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10831
10942
  comment?: string;
10832
10943
  /**
10833
10944
  * @remarks
10834
- * Whether the field is a foreign key, with values as follows:
10835
- * - true, it is a foreign key.
10836
- * - false, it is not a foreign key.
10945
+ * Indicates whether the field is a foreign key. Valid values:
10946
+ *
10947
+ * * true
10948
+ * * false
10837
10949
  *
10838
10950
  * @example
10839
10951
  * true
@@ -10841,9 +10953,10 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10841
10953
  isForeignKey?: boolean;
10842
10954
  /**
10843
10955
  * @remarks
10844
- * Indicates whether the column is a partition column, with the following values:
10845
- * - true: It is a partition column.
10846
- * - false: It is not a partition column.
10956
+ * Indicates whether the field is a partition field. Valid values:
10957
+ *
10958
+ * * true
10959
+ * * false
10847
10960
  *
10848
10961
  * @example
10849
10962
  * true
@@ -10851,9 +10964,10 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10851
10964
  isPartitionColumn?: boolean;
10852
10965
  /**
10853
10966
  * @remarks
10854
- * Indicates whether the column is a primary key, with the following values:
10855
- * - true: It is a primary key.
10856
- * - false: It is not a primary key.
10967
+ * Indicates whether the field is a primary key. Valid values:
10968
+ *
10969
+ * * true
10970
+ * * false
10857
10971
  *
10858
10972
  * @example
10859
10973
  * false
@@ -10861,7 +10975,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10861
10975
  isPrimaryKey?: boolean;
10862
10976
  /**
10863
10977
  * @remarks
10864
- * The position of the column in the order.
10978
+ * The sequence number of the field.
10865
10979
  *
10866
10980
  * @example
10867
10981
  * 1
@@ -10881,7 +10995,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10881
10995
  export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10882
10996
  /**
10883
10997
  * @remarks
10884
- * The ID of the EMR cluster.
10998
+ * The EMR cluster ID.
10885
10999
  *
10886
11000
  * @example
10887
11001
  * C-010A704DA760****
@@ -10889,12 +11003,12 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10889
11003
  clusterId?: string;
10890
11004
  /**
10891
11005
  * @remarks
10892
- * A list of columns.
11006
+ * The fields in the table.
10893
11007
  */
10894
11008
  columnList?: GetMetaTableFullInfoResponseBodyDataColumnList[];
10895
11009
  /**
10896
11010
  * @remarks
10897
- * The comment of the table.
11011
+ * The comment on the table.
10898
11012
  *
10899
11013
  * @example
10900
11014
  * comment
@@ -10902,7 +11016,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10902
11016
  comment?: string;
10903
11017
  /**
10904
11018
  * @remarks
10905
- * The time when the table was created. The result is displayed as a timestamp, which you can convert to the corresponding date based on your timezone.
11019
+ * The time when the table was created. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.
10906
11020
  *
10907
11021
  * @example
10908
11022
  * 1589870293000
@@ -10910,7 +11024,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10910
11024
  createTime?: number;
10911
11025
  /**
10912
11026
  * @remarks
10913
- * The storage space occupied by the table, in bytes (B).
11027
+ * The size of the storage space that is consumed by the table. Unit: bytes.
10914
11028
  *
10915
11029
  * @example
10916
11030
  * 10
@@ -10926,9 +11040,10 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10926
11040
  databaseName?: string;
10927
11041
  /**
10928
11042
  * @remarks
10929
- * Environment type, with the following values:
10930
- * - 0 indicates a table in the development environment.
10931
- * - 1 indicates a table in the production environment.
11043
+ * The type of the environment. Valid values:
11044
+ *
11045
+ * * 0: indicates that the table resides in the development environment.
11046
+ * * 1: indicates that the table resides in the production environment.
10932
11047
  *
10933
11048
  * @example
10934
11049
  * 1
@@ -10936,11 +11051,12 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10936
11051
  envType?: number;
10937
11052
  /**
10938
11053
  * @remarks
10939
- * Indicates whether the table is visible, with the following values:
10940
- * - 0: The table is visible to workspace members.
10941
- * - 1: The table is visible within the tenant.
10942
- * - 2: The table is visible across tenants.
10943
- * - 3: The table is only visible to the responsible person.
11054
+ * The scope in which the table is visible. Valid values:
11055
+ *
11056
+ * * 0: indicates that the table is visible to workspace members.
11057
+ * * 1: indicates that the table is visible to users within a tenant.
11058
+ * * 2: indicates that the table is visible to all tenants.
11059
+ * * 3: indicates that the table is visible only to the table owner.
10944
11060
  *
10945
11061
  * @example
10946
11062
  * 1
@@ -10948,7 +11064,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10948
11064
  isVisible?: number;
10949
11065
  /**
10950
11066
  * @remarks
10951
- * The last time the table was accessed. The result is displayed as a timestamp, which you can convert to the corresponding date based on your timezone.
11067
+ * The time when the table was last accessed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.
10952
11068
  *
10953
11069
  * @example
10954
11070
  * 1589870294000
@@ -10956,7 +11072,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10956
11072
  lastAccessTime?: number;
10957
11073
  /**
10958
11074
  * @remarks
10959
- * The last time the table structure was changed. The result is displayed as a timestamp, which you can convert to the corresponding date based on your timezone.
11075
+ * The time when the schema of the table was last changed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.
10960
11076
  *
10961
11077
  * @example
10962
11078
  * 1589870294000
@@ -10964,7 +11080,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10964
11080
  lastDdlTime?: number;
10965
11081
  /**
10966
11082
  * @remarks
10967
- * The last time the table was updated. The result is displayed as a timestamp, which you can convert to the corresponding date based on your timezone.
11083
+ * The time when the table was last updated. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.
10968
11084
  *
10969
11085
  * @example
10970
11086
  * 1589870294000
@@ -10972,7 +11088,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10972
11088
  lastModifyTime?: number;
10973
11089
  /**
10974
11090
  * @remarks
10975
- * The lifecycle of the table, in days.
11091
+ * The lifecycle of the table. Unit: days.
10976
11092
  *
10977
11093
  * @example
10978
11094
  * 5
@@ -10980,7 +11096,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10980
11096
  lifeCycle?: number;
10981
11097
  /**
10982
11098
  * @remarks
10983
- * The storage location of the Hive table.
11099
+ * The storage path of the Hive table.
10984
11100
  *
10985
11101
  * @example
10986
11102
  * hdfs://localhost:777/user/hadoop/test.txt
@@ -10996,7 +11112,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10996
11112
  ownerId?: string;
10997
11113
  /**
10998
11114
  * @remarks
10999
- * Partition keys.
11115
+ * The partition key column.
11000
11116
  *
11001
11117
  * @example
11002
11118
  * abc
@@ -11004,7 +11120,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
11004
11120
  partitionKeys?: string;
11005
11121
  /**
11006
11122
  * @remarks
11007
- * The ID of the workspace where the table is located.
11123
+ * The ID of the workspace to which the table belongs.
11008
11124
  *
11009
11125
  * @example
11010
11126
  * 22
@@ -11012,12 +11128,19 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
11012
11128
  projectId?: number;
11013
11129
  /**
11014
11130
  * @remarks
11015
- * The name of the workspace where the table is located.
11131
+ * The name of the workspace to which the table belongs.
11016
11132
  *
11017
11133
  * @example
11018
11134
  * test
11019
11135
  */
11020
11136
  projectName?: string;
11137
+ /**
11138
+ * @remarks
11139
+ * The schema information of the table.
11140
+ *
11141
+ * @example
11142
+ * default
11143
+ */
11021
11144
  schema?: string;
11022
11145
  /**
11023
11146
  * @remarks
@@ -11045,7 +11168,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
11045
11168
  tenantId?: number;
11046
11169
  /**
11047
11170
  * @remarks
11048
- * The total number of columns.
11171
+ * The total number of fields.
11049
11172
  *
11050
11173
  * @example
11051
11174
  * 22
@@ -11812,6 +11935,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11812
11935
  * odps_first_dev
11813
11936
  */
11814
11937
  connection?: string;
11938
+ /**
11939
+ * @remarks
11940
+ * The creation time.
11941
+ *
11942
+ * @example
11943
+ * 1727280000000
11944
+ */
11815
11945
  createTime?: number;
11816
11946
  /**
11817
11947
  * @remarks
@@ -11821,6 +11951,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11821
11951
  * 00 00 00 * * ?
11822
11952
  */
11823
11953
  cronExpress?: string;
11954
+ /**
11955
+ * @remarks
11956
+ * The deployment date.
11957
+ *
11958
+ * @example
11959
+ * 1727280000000
11960
+ */
11824
11961
  deployDate?: number;
11825
11962
  /**
11826
11963
  * @remarks
@@ -11846,9 +11983,37 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11846
11983
  * 1
11847
11984
  */
11848
11985
  dqcType?: number;
11986
+ /**
11987
+ * @remarks
11988
+ * The ID of the file.
11989
+ *
11990
+ * @example
11991
+ * 123
11992
+ */
11849
11993
  fileId?: number;
11994
+ /**
11995
+ * @remarks
11996
+ * The file type. Different file types have different codes. For more information, see [DataWorks node collection](https://help.aliyun.com/document_detail/600169.html).
11997
+ *
11998
+ * @example
11999
+ * 10
12000
+ */
11850
12001
  fileType?: number;
12002
+ /**
12003
+ * @remarks
12004
+ * The version of the file.
12005
+ *
12006
+ * @example
12007
+ * 1
12008
+ */
11851
12009
  fileVersion?: number;
12010
+ /**
12011
+ * @remarks
12012
+ * The modification time.
12013
+ *
12014
+ * @example
12015
+ * 1727280000000
12016
+ */
11852
12017
  modifyTime?: number;
11853
12018
  /**
11854
12019
  * @remarks
@@ -11927,6 +12092,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11927
12092
  * 60
11928
12093
  */
11929
12094
  repeatInterval?: number;
12095
+ /**
12096
+ * @remarks
12097
+ * Rerun mode. 0 indicates that you can rerun only if you fail, 1 indicates that you can rerun in all cases, and 2 indicates that you cannot rerun in all cases.
12098
+ *
12099
+ * @example
12100
+ * 1
12101
+ */
11930
12102
  repeatMode?: number;
11931
12103
  /**
11932
12104
  * @remarks
@@ -11936,6 +12108,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11936
12108
  * true
11937
12109
  */
11938
12110
  repeatability?: string;
12111
+ /**
12112
+ * @remarks
12113
+ * The unique identifier of the resource group.
12114
+ *
12115
+ * @example
12116
+ * group_123
12117
+ */
11939
12118
  resGroupIdentifier?: string;
11940
12119
  /**
11941
12120
  * @remarks
@@ -12354,6 +12533,9 @@ export declare class GetPermissionApplyOrderDetailResponseBodyApplyOrderDetailAp
12354
12533
  /**
12355
12534
  * @remarks
12356
12535
  * The description of the column on which you request permissions.
12536
+ *
12537
+ * @example
12538
+ * Field description
12357
12539
  */
12358
12540
  columnComment?: string;
12359
12541
  /**
@@ -13289,38 +13471,78 @@ export declare class GetQualityEntityResponseBodyData extends $dara.Model {
13289
13471
  }
13290
13472
  export declare class GetQualityFollowerResponseBodyData extends $dara.Model {
13291
13473
  /**
13474
+ * @remarks
13475
+ * The alert mode. The value is as follows:
13476
+ *
13477
+ * - 1 (Mail)
13478
+ * - 2 (email and SMS)
13479
+ * - 4 (DingTalk groups of robots or hook)
13480
+ * - 5 (DingTalk groups of robots @ ALL)
13481
+ *
13292
13482
  * @example
13293
13483
  * 1
13294
13484
  */
13295
13485
  alarmMode?: number;
13486
+ /**
13487
+ * @remarks
13488
+ * The time when the data quality rule subscription configuration was created.
13489
+ *
13490
+ * @example
13491
+ * 1541576644000
13492
+ */
13296
13493
  createTime?: number;
13297
13494
  /**
13495
+ * @remarks
13496
+ * The ID of the partition expression.
13497
+ *
13298
13498
  * @example
13299
13499
  * 1234
13300
13500
  */
13301
13501
  entityId?: string;
13302
13502
  /**
13503
+ * @remarks
13504
+ * The subscriber to receive alert information.
13505
+ *
13303
13506
  * @example
13304
13507
  * 1234
13305
13508
  */
13306
13509
  follower?: string;
13307
13510
  /**
13511
+ * @remarks
13512
+ * The Alibaba Cloud account name of the subscriber.
13513
+ *
13308
13514
  * @example
13309
13515
  * test
13310
13516
  */
13311
13517
  followerAccountName?: string;
13312
13518
  /**
13519
+ * @remarks
13520
+ * The ID of the subscription relationship.
13521
+ *
13313
13522
  * @example
13314
13523
  * 123
13315
13524
  */
13316
13525
  id?: number;
13526
+ /**
13527
+ * @remarks
13528
+ * The update time of the data quality rule subscription configuration.
13529
+ *
13530
+ * @example
13531
+ * 1541576644000
13532
+ */
13317
13533
  modifyTime?: number;
13318
13534
  /**
13535
+ * @remarks
13536
+ * The name of the engine or data source.
13537
+ *
13319
13538
  * @example
13320
13539
  * autotest
13321
13540
  */
13322
13541
  projectName?: string;
13323
13542
  /**
13543
+ * @remarks
13544
+ * The name of the partitioned table.
13545
+ *
13324
13546
  * @example
13325
13547
  * dual
13326
13548
  */
@@ -13553,6 +13775,9 @@ export declare class GetRemindResponseBodyDataBaselines extends $dara.Model {
13553
13775
  /**
13554
13776
  * @remarks
13555
13777
  * The name of the baseline.
13778
+ *
13779
+ * @example
13780
+ * Baseline name
13556
13781
  */
13557
13782
  baselineName?: string;
13558
13783
  static names(): {
@@ -13578,6 +13803,9 @@ export declare class GetRemindResponseBodyDataBizProcesses extends $dara.Model {
13578
13803
  /**
13579
13804
  * @remarks
13580
13805
  * The name of the workflow.
13806
+ *
13807
+ * @example
13808
+ * Business process name
13581
13809
  */
13582
13810
  bizProcessName?: string;
13583
13811
  static names(): {
@@ -13603,6 +13831,9 @@ export declare class GetRemindResponseBodyDataNodes extends $dara.Model {
13603
13831
  /**
13604
13832
  * @remarks
13605
13833
  * The name of the node.
13834
+ *
13835
+ * @example
13836
+ * Node name
13606
13837
  */
13607
13838
  nodeName?: string;
13608
13839
  /**
@@ -13653,8 +13884,19 @@ export declare class GetRemindResponseBodyDataProjects extends $dara.Model {
13653
13884
  });
13654
13885
  }
13655
13886
  export declare class GetRemindResponseBodyDataReceivers extends $dara.Model {
13887
+ /**
13888
+ * @remarks
13889
+ * The alert recipient.
13890
+ */
13656
13891
  alertTargets?: string[];
13657
13892
  /**
13893
+ * @remarks
13894
+ * The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values:
13895
+ *
13896
+ * * OWNER: indicate the task owner.
13897
+ * * OTHER: indicates specified personnel.
13898
+ * * SHIFT_SCHEDULE: indicates personnel in a shift schedule.
13899
+ *
13658
13900
  * @example
13659
13901
  * OWNER
13660
13902
  */
@@ -13709,22 +13951,30 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13709
13951
  alertInterval?: number;
13710
13952
  /**
13711
13953
  * @remarks
13712
- * The alert notification method.
13954
+ * The notification method.
13713
13955
  */
13714
13956
  alertMethods?: string[];
13715
13957
  /**
13716
13958
  * @remarks
13717
- * The description of the alert recipient.
13959
+ * The description of the alert recipient. For more information about alert recipients, see the Receivers parameter.
13718
13960
  */
13719
13961
  alertTargets?: string[];
13720
13962
  /**
13721
13963
  * @remarks
13722
- * The recipient of the alert. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.
13964
+ * The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values:
13965
+ *
13966
+ * * OWNER: the task owner
13967
+ * * OTHER: specified personnel
13968
+ * * SHIFT_SCHEDULE: personnel in a shift schedule
13723
13969
  *
13724
13970
  * @example
13725
13971
  * OWNER
13726
13972
  */
13727
13973
  alertUnit?: string;
13974
+ /**
13975
+ * @remarks
13976
+ * The IDs of the nodes that are added to a whitelist.
13977
+ */
13728
13978
  allowNodes?: number[];
13729
13979
  /**
13730
13980
  * @remarks
@@ -13790,6 +14040,10 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13790
14040
  * The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.
13791
14041
  */
13792
14042
  projects?: GetRemindResponseBodyDataProjects[];
14043
+ /**
14044
+ * @remarks
14045
+ * The information about the alert recipients.
14046
+ */
13793
14047
  receivers?: GetRemindResponseBodyDataReceivers[];
13794
14048
  /**
13795
14049
  * @remarks
@@ -13802,6 +14056,9 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13802
14056
  /**
13803
14057
  * @remarks
13804
14058
  * The name of the rule.
14059
+ *
14060
+ * @example
14061
+ * Rule name
13805
14062
  */
13806
14063
  remindName?: string;
13807
14064
  /**
@@ -13835,7 +14092,7 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13835
14092
  useflag?: boolean;
13836
14093
  /**
13837
14094
  * @remarks
13838
- * The information about the webhook URL.
14095
+ * WebHook URL
13839
14096
  */
13840
14097
  webhooks?: string[];
13841
14098
  static names(): {
@@ -14012,6 +14269,9 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14012
14269
  /**
14013
14270
  * @remarks
14014
14271
  * The name of the baseline to which the worst baseline instance belongs.
14272
+ *
14273
+ * @example
14274
+ * Baseline name
14015
14275
  */
14016
14276
  baselineName?: string;
14017
14277
  /**
@@ -14089,6 +14349,9 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14089
14349
  /**
14090
14350
  * @remarks
14091
14351
  * The name of the node that triggered the event.
14352
+ *
14353
+ * @example
14354
+ * Node name
14092
14355
  */
14093
14356
  nodeName?: string;
14094
14357
  /**
@@ -14118,6 +14381,9 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14118
14381
  /**
14119
14382
  * @remarks
14120
14383
  * The name of the event.
14384
+ *
14385
+ * @example
14386
+ * 1234 error
14121
14387
  */
14122
14388
  topicName?: string;
14123
14389
  /**
@@ -14150,44 +14416,72 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14150
14416
  export declare class GetTopicInfluenceResponseBodyDataInfluences extends $dara.Model {
14151
14417
  /**
14152
14418
  * @remarks
14153
- * The baseline ID.
14419
+ * The ID of the baseline.
14154
14420
  *
14155
14421
  * @example
14156
- * 1234
14422
+ * 12345
14157
14423
  */
14158
14424
  baselineId?: number;
14425
+ /**
14426
+ * @remarks
14427
+ * The name of the baseline.
14428
+ *
14429
+ * @example
14430
+ * Baseline name
14431
+ */
14159
14432
  baselineName?: string;
14160
14433
  /**
14434
+ * @remarks
14435
+ * The data timestamp of the baseline instance.
14436
+ *
14161
14437
  * @example
14162
14438
  * 1553356800000
14163
14439
  */
14164
14440
  bizdate?: number;
14165
14441
  /**
14442
+ * @remarks
14443
+ * The margin of the baseline instance. Unit: seconds.
14444
+ *
14166
14445
  * @example
14167
14446
  * 360
14168
14447
  */
14169
14448
  buffer?: number;
14170
14449
  /**
14450
+ * @remarks
14451
+ * The ID of the cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.
14452
+ *
14171
14453
  * @example
14172
14454
  * 1
14173
14455
  */
14174
14456
  inGroupId?: number;
14175
14457
  /**
14458
+ * @remarks
14459
+ * The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).
14460
+ *
14176
14461
  * @example
14177
14462
  * 952795****
14178
14463
  */
14179
14464
  owner?: string;
14180
14465
  /**
14466
+ * @remarks
14467
+ * The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.
14468
+ *
14181
14469
  * @example
14182
14470
  * 1
14183
14471
  */
14184
14472
  priority?: number;
14185
14473
  /**
14474
+ * @remarks
14475
+ * The ID of the workspace to which the baseline belongs.
14476
+ *
14186
14477
  * @example
14187
14478
  * 1234
14188
14479
  */
14189
14480
  projectId?: number;
14190
14481
  /**
14482
+ * @remarks
14483
+ * The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.
14484
+ *
14191
14485
  * @example
14192
14486
  * SAFE
14193
14487
  */
@@ -14206,10 +14500,13 @@ export declare class GetTopicInfluenceResponseBodyDataInfluences extends $dara.M
14206
14500
  export declare class GetTopicInfluenceResponseBodyData extends $dara.Model {
14207
14501
  /**
14208
14502
  * @remarks
14209
- * The affected baseline instances.
14503
+ * The list of affected baseline instances.
14210
14504
  */
14211
14505
  influences?: GetTopicInfluenceResponseBodyDataInfluences[];
14212
14506
  /**
14507
+ * @remarks
14508
+ * The ID of the event.
14509
+ *
14213
14510
  * @example
14214
14511
  * 1234
14215
14512
  */
@@ -14276,6 +14573,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesInstances ext
14276
14573
  /**
14277
14574
  * @remarks
14278
14575
  * The name of the node.
14576
+ *
14577
+ * @example
14578
+ * Node name
14279
14579
  */
14280
14580
  nodeName?: string;
14281
14581
  /**
@@ -14317,6 +14617,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesNodes extends
14317
14617
  /**
14318
14618
  * @remarks
14319
14619
  * The name of the node.
14620
+ *
14621
+ * @example
14622
+ * Node name
14320
14623
  */
14321
14624
  nodeName?: string;
14322
14625
  /**
@@ -14358,6 +14661,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesSlaAlert exte
14358
14661
  /**
14359
14662
  * @remarks
14360
14663
  * The name of the baseline.
14664
+ *
14665
+ * @example
14666
+ * Baseline name
14361
14667
  */
14362
14668
  baselineName?: string;
14363
14669
  /**
@@ -14439,6 +14745,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesTopics extend
14439
14745
  /**
14440
14746
  * @remarks
14441
14747
  * The name of the event.
14748
+ *
14749
+ * @example
14750
+ * 9527 error
14442
14751
  */
14443
14752
  topicName?: string;
14444
14753
  /**
@@ -14512,6 +14821,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessages extends $dar
14512
14821
  /**
14513
14822
  * @remarks
14514
14823
  * The content of the alert.
14824
+ *
14825
+ * @example
14826
+ * Node error
14515
14827
  */
14516
14828
  content?: string;
14517
14829
  /**
@@ -14538,6 +14850,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessages extends $dar
14538
14850
  /**
14539
14851
  * @remarks
14540
14852
  * The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.
14853
+ *
14854
+ * @example
14855
+ * Custom monitoring rule name
14541
14856
  */
14542
14857
  remindName?: string;
14543
14858
  /**
@@ -14622,6 +14937,9 @@ export declare class ListBaselineConfigsResponseBodyDataBaselines extends $dara.
14622
14937
  /**
14623
14938
  * @remarks
14624
14939
  * The name of the baseline.
14940
+ *
14941
+ * @example
14942
+ * Baseline name
14625
14943
  */
14626
14944
  baselineName?: string;
14627
14945
  /**
@@ -15475,46 +15793,76 @@ export declare class ListCalcEnginesResponseBodyData extends $dara.Model {
15475
15793
  }
15476
15794
  export declare class ListCheckProcessesResponseBodyPagingInfoCheckProcesses extends $dara.Model {
15477
15795
  /**
15796
+ * @remarks
15797
+ * Extension point event encoding.
15798
+ *
15478
15799
  * @example
15479
15800
  * commit-file
15480
15801
  */
15481
15802
  eventCode?: string;
15482
15803
  /**
15804
+ * @remarks
15805
+ * The name of the extension point event.
15806
+ *
15483
15807
  * @example
15484
15808
  * DnsEvent
15485
15809
  */
15486
15810
  eventName?: string;
15487
15811
  /**
15812
+ * @remarks
15813
+ * The English name of the event.
15814
+ *
15488
15815
  * @example
15489
15816
  * Pre-event for Node Commit
15490
15817
  */
15491
15818
  eventNameEn?: string;
15492
15819
  /**
15820
+ * @remarks
15821
+ * DataWorks the message ID of the open message. After an extended point event is triggered, you can obtain the message ID from the received event message.
15822
+ *
15493
15823
  * @example
15494
15824
  * b824a5de-4223-4315-af3e-c4449d236db4
15495
15825
  */
15496
15826
  messageId?: string;
15497
15827
  /**
15828
+ * @remarks
15829
+ * The operator ID.
15830
+ *
15498
15831
  * @example
15499
15832
  * 297635
15500
15833
  */
15501
15834
  operator?: string;
15502
15835
  /**
15836
+ * @remarks
15837
+ * The ID of the process instance.
15838
+ *
15503
15839
  * @example
15504
15840
  * rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203
15505
15841
  */
15506
15842
  processId?: string;
15507
15843
  /**
15844
+ * @remarks
15845
+ * The name of the check object, such as the file name or node name.
15846
+ *
15508
15847
  * @example
15509
15848
  * odps_sql_test
15510
15849
  */
15511
15850
  processName?: string;
15512
15851
  /**
15852
+ * @remarks
15853
+ * The ID of the DataWorks workspace.
15854
+ *
15513
15855
  * @example
15514
15856
  * 32563
15515
15857
  */
15516
15858
  projectId?: number;
15517
15859
  /**
15860
+ * @remarks
15861
+ * The status of the extender check.
15862
+ * - CHECKING CHECKING
15863
+ * - PASSED the pass check
15864
+ * - BLOCKED check failed
15865
+ *
15518
15866
  * @example
15519
15867
  * CHECKING
15520
15868
  */
@@ -15531,18 +15879,31 @@ export declare class ListCheckProcessesResponseBodyPagingInfoCheckProcesses exte
15531
15879
  });
15532
15880
  }
15533
15881
  export declare class ListCheckProcessesResponseBodyPagingInfo extends $dara.Model {
15882
+ /**
15883
+ * @remarks
15884
+ * The check details of the extension.
15885
+ */
15534
15886
  checkProcesses?: ListCheckProcessesResponseBodyPagingInfoCheckProcesses[];
15535
15887
  /**
15888
+ * @remarks
15889
+ * The page number.
15890
+ *
15536
15891
  * @example
15537
15892
  * 1
15538
15893
  */
15539
15894
  pageNumber?: number;
15540
15895
  /**
15896
+ * @remarks
15897
+ * The number of entries displayed on each page.
15898
+ *
15541
15899
  * @example
15542
15900
  * 10
15543
15901
  */
15544
15902
  pageSize?: number;
15545
15903
  /**
15904
+ * @remarks
15905
+ * The total number of entries returned.
15906
+ *
15546
15907
  * @example
15547
15908
  * 12
15548
15909
  */
@@ -16150,6 +16511,9 @@ export declare class ListDIAlarmRulesResponseBodyDIAlarmRulePagingDIJobAlarmRule
16150
16511
  /**
16151
16512
  * @remarks
16152
16513
  * The description of the alert rule.
16514
+ *
16515
+ * @example
16516
+ * mysql synchronizes to hologres heartbeat alert
16153
16517
  */
16154
16518
  description?: string;
16155
16519
  /**
@@ -17488,6 +17852,9 @@ export declare class ListDataServiceApisResponseBodyDataApis extends $dara.Model
17488
17852
  /**
17489
17853
  * @remarks
17490
17854
  * The name of the API.
17855
+ *
17856
+ * @example
17857
+ * My API name
17491
17858
  */
17492
17859
  apiName?: string;
17493
17860
  /**
@@ -17517,6 +17884,9 @@ export declare class ListDataServiceApisResponseBodyDataApis extends $dara.Model
17517
17884
  /**
17518
17885
  * @remarks
17519
17886
  * The description of the API.
17887
+ *
17888
+ * @example
17889
+ * Test API description
17520
17890
  */
17521
17891
  description?: string;
17522
17892
  /**
@@ -18941,6 +19311,9 @@ export declare class ListDataServicePublishedApisResponseBodyDataApis extends $d
18941
19311
  /**
18942
19312
  * @remarks
18943
19313
  * The name of the API.
19314
+ *
19315
+ * @example
19316
+ * My API name
18944
19317
  */
18945
19318
  apiName?: string;
18946
19319
  /**
@@ -18970,6 +19343,9 @@ export declare class ListDataServicePublishedApisResponseBodyDataApis extends $d
18970
19343
  /**
18971
19344
  * @remarks
18972
19345
  * The description.
19346
+ *
19347
+ * @example
19348
+ * Test API description
18973
19349
  */
18974
19350
  description?: string;
18975
19351
  /**
@@ -19557,11 +19933,17 @@ export declare class ListEnabledExtensionsForProjectResponseBodyExtensions exten
19557
19933
  /**
19558
19934
  * @remarks
19559
19935
  * The description of the extension.
19936
+ *
19937
+ * @example
19938
+ * ODPS SQL compatible Spark engine detection
19560
19939
  */
19561
19940
  extensionDesc?: string;
19562
19941
  /**
19563
19942
  * @remarks
19564
19943
  * The name of the extension.
19944
+ *
19945
+ * @example
19946
+ * max_pt function is not allowed.
19565
19947
  */
19566
19948
  extensionName?: string;
19567
19949
  /**
@@ -19644,6 +20026,9 @@ export declare class ListExtensionsResponseBodyPagingInfoExtensionsBindEventList
19644
20026
  /**
19645
20027
  * @remarks
19646
20028
  * The name of the event.
20029
+ *
20030
+ * @example
20031
+ * File submission pre-event
19647
20032
  */
19648
20033
  eventName?: string;
19649
20034
  static names(): {
@@ -19666,16 +20051,25 @@ export declare class ListExtensionsResponseBodyPagingInfoExtensions extends $dar
19666
20051
  /**
19667
20052
  * @remarks
19668
20053
  * The unique code of the extension.
20054
+ *
20055
+ * @example
20056
+ * Extension Code
19669
20057
  */
19670
20058
  extensionCode?: string;
19671
20059
  /**
19672
20060
  * @remarks
19673
20061
  * The description of the extension.
20062
+ *
20063
+ * @example
20064
+ * This is a description
19674
20065
  */
19675
20066
  extensionDesc?: string;
19676
20067
  /**
19677
20068
  * @remarks
19678
20069
  * The name of the extension.
20070
+ *
20071
+ * @example
20072
+ * Extension name
19679
20073
  */
19680
20074
  extensionName?: string;
19681
20075
  /**
@@ -19827,6 +20221,9 @@ export declare class ListFileVersionsResponseBodyDataFileVersions extends $dara.
19827
20221
  /**
19828
20222
  * @remarks
19829
20223
  * The description of the file version.
20224
+ *
20225
+ * @example
20226
+ * Second version submission
19830
20227
  */
19831
20228
  comment?: string;
19832
20229
  /**
@@ -19970,6 +20367,13 @@ export declare class ListFileVersionsResponseBodyData extends $dara.Model {
19970
20367
  });
19971
20368
  }
19972
20369
  export declare class ListFilesResponseBodyDataFiles extends $dara.Model {
20370
+ /**
20371
+ * @remarks
20372
+ * The path of the folder where the file is located.
20373
+ *
20374
+ * @example
20375
+ * Business_process/my_first_business_process/MaxCompute/ods_layer
20376
+ */
19973
20377
  absoluteFolderPath?: string;
19974
20378
  /**
19975
20379
  * @remarks
@@ -20217,6 +20621,9 @@ export declare class ListFoldersResponseBodyDataFolders extends $dara.Model {
20217
20621
  /**
20218
20622
  * @remarks
20219
20623
  * The path of the folder.
20624
+ *
20625
+ * @example
20626
+ * Business_process/my_first_business_process/MaxCompute/ods_layer
20220
20627
  */
20221
20628
  folderPath?: string;
20222
20629
  static names(): {
@@ -20403,6 +20810,9 @@ export declare class ListInnerNodesResponseBodyPagingNodes extends $dara.Model {
20403
20810
  /**
20404
20811
  * @remarks
20405
20812
  * The name of the resource group.
20813
+ *
20814
+ * @example
20815
+ * Default Resource Group
20406
20816
  */
20407
20817
  resGroupName?: string;
20408
20818
  /**
@@ -21481,6 +21891,9 @@ export declare class ListMigrationsResponseBodyDataMigrations extends $dara.Mode
21481
21891
  /**
21482
21892
  * @remarks
21483
21893
  * The description of the export task.
21894
+ *
21895
+ * @example
21896
+ * Automated Test creation
21484
21897
  */
21485
21898
  description?: string;
21486
21899
  /**
@@ -21744,6 +22157,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21744
22157
  * odps_first
21745
22158
  */
21746
22159
  connection?: string;
22160
+ /**
22161
+ * @remarks
22162
+ * The timestamp when the node was created. Unit: milliseconds.
22163
+ *
22164
+ * @example
22165
+ * 1593879116000
22166
+ */
21747
22167
  createTime?: number;
21748
22168
  /**
21749
22169
  * @remarks
@@ -21753,6 +22173,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21753
22173
  * 00 00 00 * * ?
21754
22174
  */
21755
22175
  cronExpress?: string;
22176
+ /**
22177
+ * @remarks
22178
+ * The timestamp when the node was deployed. Unit: milliseconds.
22179
+ *
22180
+ * @example
22181
+ * 1734537600000
22182
+ */
21756
22183
  deployDate?: number;
21757
22184
  /**
21758
22185
  * @remarks
@@ -21778,9 +22205,38 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21778
22205
  * 1
21779
22206
  */
21780
22207
  dqcType?: number;
22208
+ /**
22209
+ * @remarks
22210
+ * The file ID. You can call the ListFiles operation to query the ID.
22211
+ *
22212
+ * @example
22213
+ * 20
22214
+ */
21781
22215
  fileId?: number;
22216
+ /**
22217
+ * @remarks
22218
+ * Different file types have different codes. For more information, see [DataWorks node collection](https://help.aliyun.com/document_detail/600169.html).
22219
+ * You can also call the [ListFileType](https://help.aliyun.com/document_detail/212428.html) interface to query the code type of the file.
22220
+ *
22221
+ * @example
22222
+ * 10
22223
+ */
21782
22224
  fileType?: number;
22225
+ /**
22226
+ * @remarks
22227
+ * The latest version number of the file.
22228
+ *
22229
+ * @example
22230
+ * 3
22231
+ */
21783
22232
  fileVersion?: number;
22233
+ /**
22234
+ * @remarks
22235
+ * The timestamp when the node was modified. Unit: milliseconds.
22236
+ *
22237
+ * @example
22238
+ * 1593879116000
22239
+ */
21784
22240
  modifyTime?: number;
21785
22241
  /**
21786
22242
  * @remarks
@@ -21854,6 +22310,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21854
22310
  * 60
21855
22311
  */
21856
22312
  repeatInterval?: number;
22313
+ /**
22314
+ * @remarks
22315
+ * The rerun mode. The value 0 indicates that rerun can be performed only if a failure occurs. The value 1 indicates that rerun can be performed in all cases. The value 2 indicates that rerun cannot be performed in all cases.
22316
+ *
22317
+ * @example
22318
+ * 1
22319
+ */
21857
22320
  repeatMode?: number;
21858
22321
  /**
21859
22322
  * @remarks
@@ -21863,6 +22326,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21863
22326
  * true
21864
22327
  */
21865
22328
  repeatability?: boolean;
22329
+ /**
22330
+ * @remarks
22331
+ * The identifier of the resource group.
22332
+ *
22333
+ * @example
22334
+ * group_123
22335
+ */
21866
22336
  resGroupIdentifier?: string;
21867
22337
  /**
21868
22338
  * @remarks
@@ -21894,12 +22364,7 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21894
22364
  export declare class ListNodesResponseBodyData extends $dara.Model {
21895
22365
  /**
21896
22366
  * @remarks
21897
- * The scheduling type of the node. Valid values:
21898
- *
21899
- * * NORMAL: indicates that the node is a normal auto triggered node.
21900
- * * MANUAL: indicates that the node is a manually triggered node.
21901
- * * PAUSE: indicates that the node is a paused node.
21902
- * * SKIP: indicates that the node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.
22367
+ * The information about the nodes.
21903
22368
  */
21904
22369
  nodes?: ListNodesResponseBodyDataNodes[];
21905
22370
  /**
@@ -21949,6 +22414,9 @@ export declare class ListNodesByBaselineResponseBodyData extends $dara.Model {
21949
22414
  /**
21950
22415
  * @remarks
21951
22416
  * The name of the node.
22417
+ *
22418
+ * @example
22419
+ * Node name
21952
22420
  */
21953
22421
  nodeName?: string;
21954
22422
  /**
@@ -22120,6 +22588,9 @@ export declare class ListNodesByOutputResponseBodyDataNodeList extends $dara.Mod
22120
22588
  /**
22121
22589
  * @remarks
22122
22590
  * The name of the resource group.
22591
+ *
22592
+ * @example
22593
+ * Default Resource Group
22123
22594
  */
22124
22595
  resGroupName?: string;
22125
22596
  /**
@@ -22993,6 +23464,9 @@ export declare class ListQualityResultsByEntityResponseBodyDataRuleChecks extend
22993
23464
  /**
22994
23465
  * @remarks
22995
23466
  * The description of the monitoring rule.
23467
+ *
23468
+ * @example
23469
+ * The description of the rule.
22996
23470
  */
22997
23471
  comment?: string;
22998
23472
  /**
@@ -23164,6 +23638,9 @@ export declare class ListQualityResultsByEntityResponseBodyDataRuleChecks extend
23164
23638
  /**
23165
23639
  * @remarks
23166
23640
  * The name of the monitoring rule.
23641
+ *
23642
+ * @example
23643
+ * The name of the rule.
23167
23644
  */
23168
23645
  ruleName?: string;
23169
23646
  /**
@@ -23198,6 +23675,9 @@ export declare class ListQualityResultsByEntityResponseBodyDataRuleChecks extend
23198
23675
  /**
23199
23676
  * @remarks
23200
23677
  * The name of the monitoring template.
23678
+ *
23679
+ * @example
23680
+ * Expected value verification
23201
23681
  */
23202
23682
  templateName?: string;
23203
23683
  /**
@@ -23459,6 +23939,9 @@ export declare class ListQualityResultsByRuleResponseBodyDataRuleChecks extends
23459
23939
  /**
23460
23940
  * @remarks
23461
23941
  * The description of the monitoring rule.
23942
+ *
23943
+ * @example
23944
+ * The description of the rule.
23462
23945
  */
23463
23946
  comment?: string;
23464
23947
  /**
@@ -23638,6 +24121,9 @@ export declare class ListQualityResultsByRuleResponseBodyDataRuleChecks extends
23638
24121
  /**
23639
24122
  * @remarks
23640
24123
  * The name of the monitoring rule.
24124
+ *
24125
+ * @example
24126
+ * The name of the rule.
23641
24127
  */
23642
24128
  ruleName?: string;
23643
24129
  /**
@@ -23672,6 +24158,9 @@ export declare class ListQualityResultsByRuleResponseBodyDataRuleChecks extends
23672
24158
  /**
23673
24159
  * @remarks
23674
24160
  * The name of the monitoring template.
24161
+ *
24162
+ * @example
24163
+ * Expected value verification
23675
24164
  */
23676
24165
  templateName?: string;
23677
24166
  /**
@@ -23789,6 +24278,9 @@ export declare class ListQualityRulesResponseBodyDataRules extends $dara.Model {
23789
24278
  /**
23790
24279
  * @remarks
23791
24280
  * The description of the system defense rule.
24281
+ *
24282
+ * @example
24283
+ * Verify table rules
23792
24284
  */
23793
24285
  comment?: string;
23794
24286
  /**
@@ -23958,6 +24450,9 @@ export declare class ListQualityRulesResponseBodyDataRules extends $dara.Model {
23958
24450
  /**
23959
24451
  * @remarks
23960
24452
  * The name of the monitoring template.
24453
+ *
24454
+ * @example
24455
+ * Number of SQL task table rows, 1, 7, and 30 days wave detection
23961
24456
  */
23962
24457
  templateName?: string;
23963
24458
  /**
@@ -24509,6 +25004,9 @@ export declare class ListShiftPersonnelsResponseBodyPagingShiftPersons extends $
24509
25004
  /**
24510
25005
  * @remarks
24511
25006
  * The name of the on-duty engineer.
25007
+ *
25008
+ * @example
25009
+ * Zhang San
24512
25010
  */
24513
25011
  shiftPersonName?: string;
24514
25012
  /**
@@ -24583,6 +25081,9 @@ export declare class ListShiftSchedulesResponseBodyPagingShiftSchedules extends
24583
25081
  /**
24584
25082
  * @remarks
24585
25083
  * The name of the shift schedule.
25084
+ *
25085
+ * @example
25086
+ * Duty table name
24586
25087
  */
24587
25088
  shiftScheduleName?: string;
24588
25089
  static names(): {
@@ -24920,31 +25421,49 @@ export declare class ListTableThemeResponseBodyData extends $dara.Model {
24920
25421
  }
24921
25422
  export declare class ListTablesResponseBodyDataTableEntityListEntityContent extends $dara.Model {
24922
25423
  /**
25424
+ * @remarks
25425
+ * The unique identifier of the data source.
25426
+ *
24923
25427
  * @example
24924
25428
  * accountId:cn-shanghai:odps:project
24925
25429
  */
24926
25430
  dataSourceQualifiedName?: string;
24927
25431
  /**
25432
+ * @remarks
25433
+ * The unique ID of the data source identifier.
25434
+ *
24928
25435
  * @example
24929
25436
  * e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg
24930
25437
  */
24931
25438
  dataSourceUniqueId?: string;
24932
25439
  /**
25440
+ * @remarks
25441
+ * The name of the database.
25442
+ *
24933
25443
  * @example
24934
25444
  * database
24935
25445
  */
24936
25446
  databaseName?: string;
24937
25447
  /**
25448
+ * @remarks
25449
+ * The ID of the data source instance.
25450
+ *
24938
25451
  * @example
24939
25452
  * rm-uf6rn0123
24940
25453
  */
24941
25454
  instanceId?: string;
24942
25455
  /**
25456
+ * @remarks
25457
+ * The name of the ODPS project.
25458
+ *
24943
25459
  * @example
24944
25460
  * project
24945
25461
  */
24946
25462
  projectName?: string;
24947
25463
  /**
25464
+ * @remarks
25465
+ * The name of the table.
25466
+ *
24948
25467
  * @example
24949
25468
  * table
24950
25469
  */
@@ -24961,8 +25480,15 @@ export declare class ListTablesResponseBodyDataTableEntityListEntityContent exte
24961
25480
  });
24962
25481
  }
24963
25482
  export declare class ListTablesResponseBodyDataTableEntityList extends $dara.Model {
25483
+ /**
25484
+ * @remarks
25485
+ * Table entity information.
25486
+ */
24964
25487
  entityContent?: ListTablesResponseBodyDataTableEntityListEntityContent;
24965
25488
  /**
25489
+ * @remarks
25490
+ * The unique identifier of the table entity.
25491
+ *
24966
25492
  * @example
24967
25493
  * maxcompute-table.project.table
24968
25494
  */
@@ -24980,12 +25506,22 @@ export declare class ListTablesResponseBodyDataTableEntityList extends $dara.Mod
24980
25506
  }
24981
25507
  export declare class ListTablesResponseBodyData extends $dara.Model {
24982
25508
  /**
25509
+ * @remarks
25510
+ * Pagination information, which specifies the starting point of the next read.
25511
+ *
24983
25512
  * @example
24984
25513
  * AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=
24985
25514
  */
24986
25515
  nextToken?: string;
25516
+ /**
25517
+ * @remarks
25518
+ * Entity array.
25519
+ */
24987
25520
  tableEntityList?: ListTablesResponseBodyDataTableEntityList[];
24988
25521
  /**
25522
+ * @remarks
25523
+ * The total number.
25524
+ *
24989
25525
  * @example
24990
25526
  * 100
24991
25527
  */
@@ -25689,6 +26225,9 @@ export declare class TestNetworkConnectionResponseBodyTaskList extends $dara.Mod
25689
26225
  /**
25690
26226
  * @remarks
25691
26227
  * The reason why the data source and resource group failed the connectivity test. If data source and the resource group passed the connectivity test, this parameter is left empty.
26228
+ *
26229
+ * @example
26230
+ * Connectable
25692
26231
  */
25693
26232
  connectMessage?: string;
25694
26233
  /**
@@ -25749,6 +26288,9 @@ export declare class TopTenElapsedTimeInstanceResponseBodyInstanceConsumeTimeRan
25749
26288
  /**
25750
26289
  * @remarks
25751
26290
  * The name of the node.
26291
+ *
26292
+ * @example
26293
+ * Node name
25752
26294
  */
25753
26295
  nodeName?: string;
25754
26296
  /**
@@ -25823,6 +26365,9 @@ export declare class TopTenErrorTimesInstanceResponseBodyInstanceErrorRankErrorR
25823
26365
  /**
25824
26366
  * @remarks
25825
26367
  * The name of the node.
26368
+ *
26369
+ * @example
26370
+ * Node name
25826
26371
  */
25827
26372
  nodeName?: string;
25828
26373
  /**
@@ -26200,6 +26745,9 @@ export declare class UpdateDIJobRequestJobSettingsColumnDataTypeSettings extends
26200
26745
  }
26201
26746
  export declare class UpdateDIJobRequestJobSettingsCycleScheduleSettings extends $dara.Model {
26202
26747
  /**
26748
+ * @remarks
26749
+ * The scheduling parameters.
26750
+ *
26203
26751
  * @example
26204
26752
  * bizdate=$bizdate
26205
26753
  */
@@ -26260,14 +26808,14 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
26260
26808
  * @remarks
26261
26809
  * The name of the configuration item. Valid values:
26262
26810
  *
26263
- * * runtime.offline.speed.limit.mb: indicates the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.
26264
- * * runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.
26265
- * * dst.offline.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.
26266
- * * runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.
26267
- * * dst.realtime.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.
26268
- * * runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.
26269
- * * src.offline.datasource.max.connection: indicates the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.
26270
- * * runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.
26811
+ * * runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.
26812
+ * * runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.
26813
+ * * dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.
26814
+ * * runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
26815
+ * * dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.
26816
+ * * runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
26817
+ * * src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.
26818
+ * * runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
26271
26819
  *
26272
26820
  * @example
26273
26821
  * runtime.offline.concurrent
@@ -26294,6 +26842,9 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
26294
26842
  }
26295
26843
  export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
26296
26844
  /**
26845
+ * @remarks
26846
+ * The channel control settings for the synchronization task. The value of this parameter must be a JSON string.
26847
+ *
26297
26848
  * @example
26298
26849
  * {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
26299
26850
  */
@@ -26303,6 +26854,10 @@ export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
26303
26854
  * The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.
26304
26855
  */
26305
26856
  columnDataTypeSettings?: UpdateDIJobRequestJobSettingsColumnDataTypeSettings[];
26857
+ /**
26858
+ * @remarks
26859
+ * The settings for periodic scheduling.
26860
+ */
26306
26861
  cycleScheduleSettings?: UpdateDIJobRequestJobSettingsCycleScheduleSettings;
26307
26862
  /**
26308
26863
  * @remarks
@@ -26377,6 +26932,9 @@ export declare class UpdateDIJobRequestResourceSettings extends $dara.Model {
26377
26932
  */
26378
26933
  realtimeResourceSettings?: UpdateDIJobRequestResourceSettingsRealtimeResourceSettings;
26379
26934
  /**
26935
+ * @remarks
26936
+ * The number of compute units (CUs) in the resource group that are used for full and incremental synchronization.
26937
+ *
26380
26938
  * @example
26381
26939
  * 2.0
26382
26940
  */
@@ -26432,6 +26990,10 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
26432
26990
  * * Rename
26433
26991
  * * AddColumn
26434
26992
  * * HandleDml
26993
+ * * DefineIncrementalCondition
26994
+ * * DefineCycleScheduleSettings
26995
+ * * DefineRuntimeSettings
26996
+ * * DefinePartitionKey
26435
26997
  *
26436
26998
  * @example
26437
26999
  * Rename
@@ -26470,12 +27032,12 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
26470
27032
  export declare class UpdateDIJobRequestTableMappings extends $dara.Model {
26471
27033
  /**
26472
27034
  * @remarks
26473
- * The rule used to select synchronization objects in the source. You can configure multiple rules.
27035
+ * The list of rules that you want to use to select synchronization objects in the source.
26474
27036
  */
26475
27037
  sourceObjectSelectionRules?: UpdateDIJobRequestTableMappingsSourceObjectSelectionRules[];
26476
27038
  /**
26477
27039
  * @remarks
26478
- * The transformation rules that are applied to the selected synchronization objects.
27040
+ * The list of transformation rules that you want to apply to the synchronization objects selected from the source.
26479
27041
  */
26480
27042
  transformationRules?: UpdateDIJobRequestTableMappingsTransformationRules[];
26481
27043
  static names(): {
@@ -26498,6 +27060,10 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
26498
27060
  * * Rename
26499
27061
  * * AddColumn
26500
27062
  * * HandleDml
27063
+ * * DefineIncrementalCondition
27064
+ * * DefineCycleScheduleSettings
27065
+ * * DefineRuntimeSettings
27066
+ * * DefinePartitionKey
26501
27067
  *
26502
27068
  * @example
26503
27069
  * Rename
@@ -26505,17 +27071,17 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
26505
27071
  ruleActionType?: string;
26506
27072
  /**
26507
27073
  * @remarks
26508
- * The expression of the rule. The expression is a JSON string.
27074
+ * The expression of the rule. The expression must be a JSON string.
26509
27075
  *
26510
27076
  * Example of a renaming rule: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":[{"variableName":"srcDatabaseName","variableRules":[{"from":"fromdb","to":"todb"}]}]}.
26511
27077
  *
26512
- * expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} indicates the name of the source. ${srcDatabaseName} indicates the name of a source database. ${srcTableName} indicates the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. The variable name is not enclosed in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence for string replacement. from indicates the original string. to indicates the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.
27078
+ * expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} specifies the name of the source. ${srcDatabaseName} specifies the name of a source database. ${srcTableName} specifies the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from specifies the original string. to specifies the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.
26513
27079
  *
26514
- * If no rule of this type is configured, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that is added. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field that is added. If the valueType parameter is set to Constant, the value of the columnValue parameter must be a constant of the STRING type. If the valueType parameter is set to Variable, the value of the columnValue parameter must be a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME indicates the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC indicates the name of the source. TABLE_NAME_SRC indicates the name of a source table. DB_NAME_DEST indicates the name of a destination database. DATASOURCE_NAME_DEST indicates the name of the destination. TABLE_NAME_DEST indicates the name of a destination table. DB_NAME_SRC_TRANSED indicates the database name obtained after a transformation. Example of a rule used to specify primary key fields for a destination table: {"columns":["ukcolumn1","ukcolumn2"]}.
27080
+ * If you do not configure such a rule, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that you want to add. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation. Example of a rule used to specify primary key fields for a destination table: {"columns":["ukcolumn1","ukcolumn2"]}.
26515
27081
  *
26516
- * If no rule of this type is configured, the primary key fields in the mapped source table are used for the destination table by default. If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. Example of a rule used to process DML messages: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.
27082
+ * If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default. If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. Example of a rule used to process DML messages: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.
26517
27083
  *
26518
- * If no rule of this type is configured, the default processing policy for messages generated for insert, update, and delete operations is Normal. dmlType: the DML operation. Valid values: Insert, Update, and Delete. dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.
27084
+ * If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal. dmlType: the DML operation. Valid values: Insert, Update, and Delete. dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.
26519
27085
  *
26520
27086
  * @example
26521
27087
  * {"expression":"${srcDatasoureName}_${srcDatabaseName}"}
@@ -28737,10 +29303,10 @@ export declare class CreateBusinessRequest extends $dara.Model {
28737
29303
  projectIdentifier?: string;
28738
29304
  /**
28739
29305
  * @remarks
28740
- * The module to which the business process belongs. Valid values:
29306
+ * The module to which the workflow belongs. Valid values:
28741
29307
  *
28742
- * - NORMAL: The business process is initiated automatically.
28743
- * - MANUAL_BIZ: The business process requires manual initiation.
29308
+ * * NORMAL: The workflow belongs to auto triggered workflows.
29309
+ * * MANUAL_BIZ: The workflow belongs to manually triggered workflows.
28744
29310
  *
28745
29311
  * @example
28746
29312
  * NORMAL
@@ -28760,7 +29326,7 @@ export declare class CreateBusinessRequest extends $dara.Model {
28760
29326
  export declare class CreateBusinessResponseBody extends $dara.Model {
28761
29327
  /**
28762
29328
  * @remarks
28763
- * The ID of the business process.
29329
+ * The workflow ID.
28764
29330
  *
28765
29331
  * @example
28766
29332
  * 100001
@@ -28792,7 +29358,7 @@ export declare class CreateBusinessResponseBody extends $dara.Model {
28792
29358
  httpStatusCode?: number;
28793
29359
  /**
28794
29360
  * @remarks
28795
- * The request ID. You can use the request ID to query logs and troubleshoot issues.
29361
+ * The request ID.
28796
29362
  *
28797
29363
  * @example
28798
29364
  * 0000-ABCD-EFG****
@@ -28800,7 +29366,7 @@ export declare class CreateBusinessResponseBody extends $dara.Model {
28800
29366
  requestId?: string;
28801
29367
  /**
28802
29368
  * @remarks
28803
- * Indicates whether the request is successful.
29369
+ * Indicates whether the request was successful.
28804
29370
  *
28805
29371
  * @example
28806
29372
  * true
@@ -29182,7 +29748,7 @@ export declare class CreateDIAlarmRuleRequest extends $dara.Model {
29182
29748
  DIJobId?: number;
29183
29749
  /**
29184
29750
  * @remarks
29185
- * The description of the alert rule.
29751
+ * The description of the task.
29186
29752
  *
29187
29753
  * @example
29188
29754
  * mysql synchronizes to hologres heartbeat alert
@@ -29248,7 +29814,7 @@ export declare class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
29248
29814
  DIJobId?: number;
29249
29815
  /**
29250
29816
  * @remarks
29251
- * The description of the alert rule.
29817
+ * The description of the task.
29252
29818
  *
29253
29819
  * @example
29254
29820
  * mysql synchronizes to hologres heartbeat alert
@@ -31077,10 +31643,10 @@ export declare class CreateFileRequest extends $dara.Model {
31077
31643
  content?: string;
31078
31644
  /**
31079
31645
  * @remarks
31080
- * If the directory specified in the parameter (FileFolderPath) does not exist in the system, whether the directory is automatically created. The values are as follows:
31646
+ * Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:
31081
31647
  *
31082
- * - true: If the directory does not exist, the directory is automatically created.
31083
- * - false: If the directory does not exist, the call fails.
31648
+ * * true: The system automatically creates the directory if the directory does not exist.
31649
+ * * false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.
31084
31650
  *
31085
31651
  * @example
31086
31652
  * false
@@ -31200,6 +31766,7 @@ export declare class CreateFileRequest extends $dara.Model {
31200
31766
  * false
31201
31767
  */
31202
31768
  ignoreParentSkipRunningProperty?: boolean;
31769
+ imageId?: string;
31203
31770
  /**
31204
31771
  * @remarks
31205
31772
  * The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).
@@ -31452,7 +32019,7 @@ export declare class CreateFileResponse extends $dara.Model {
31452
32019
  export declare class CreateFolderRequest extends $dara.Model {
31453
32020
  /**
31454
32021
  * @remarks
31455
- * The HTTP status code returned.
32022
+ * The path of the folder.
31456
32023
  *
31457
32024
  * This parameter is required.
31458
32025
  *
@@ -33235,7 +33802,7 @@ export declare class CreateQualityRuleRequest extends $dara.Model {
33235
33802
  checker?: number;
33236
33803
  /**
33237
33804
  * @remarks
33238
- * The description of the monitoring rule.
33805
+ * The description of the rule.
33239
33806
  *
33240
33807
  * @example
33241
33808
  * Verification
@@ -34517,10 +35084,10 @@ export declare class CreateUdfFileRequest extends $dara.Model {
34517
35084
  cmdDescription?: string;
34518
35085
  /**
34519
35086
  * @remarks
34520
- * If the directory specified in the parameter (FileFolderPath) does not exist in the system, whether the directory is automatically created. The values are as follows:
35087
+ * Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:
34521
35088
  *
34522
- * - true: If the directory does not exist, the directory is automatically created.
34523
- * - false: If the directory does not exist, the call fails.
35089
+ * * true: The system automatically creates the directory if the directory does not exist.
35090
+ * * false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.
34524
35091
  *
34525
35092
  * @example
34526
35093
  * false
@@ -34608,7 +35175,7 @@ export declare class CreateUdfFileRequest extends $dara.Model {
34608
35175
  returnValue?: string;
34609
35176
  /**
34610
35177
  * @remarks
34611
- * The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function in the DataWorks console.
35178
+ * The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
34612
35179
  *
34613
35180
  * @example
34614
35181
  * Concatenate several strings to generate a new string
@@ -39062,7 +39629,7 @@ export declare class DsgSceneQuerySceneListByNameRequest extends $dara.Model {
39062
39629
  export declare class DsgSceneQuerySceneListByNameResponseBody extends $dara.Model {
39063
39630
  /**
39064
39631
  * @remarks
39065
- * The data entries returned.
39632
+ * The returned data.
39066
39633
  */
39067
39634
  data?: DsgSceneQuerySceneListByNameResponseBodyData[];
39068
39635
  /**
@@ -45530,7 +46097,9 @@ export declare class GetMetaTableColumnResponse extends $dara.Model {
45530
46097
  export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45531
46098
  /**
45532
46099
  * @remarks
45533
- * The ID of the EMR cluster. You can log in to the EMR management console to obtain the cluster ID.
46100
+ * The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.
46101
+ *
46102
+ * You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.
45534
46103
  *
45535
46104
  * @example
45536
46105
  * C-010A704DA760****
@@ -45538,7 +46107,7 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45538
46107
  clusterId?: string;
45539
46108
  /**
45540
46109
  * @remarks
45541
- * Data type, currently only supports the value `emr`.
46110
+ * The type of the data source. Set the value to emr.
45542
46111
  *
45543
46112
  * @example
45544
46113
  * emr
@@ -45546,7 +46115,9 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45546
46115
  dataSourceType?: string;
45547
46116
  /**
45548
46117
  * @remarks
45549
- * The name of the EMR database. You can obtain the database name by calling the [ListMetaDB](https://help.aliyun.com/document_detail/185662.html) interface.
46118
+ * The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.
46119
+ *
46120
+ * You can call the [ListMetaDB](https://help.aliyun.com/document_detail/185662.html) operation to query the database name.
45550
46121
  *
45551
46122
  * @example
45552
46123
  * abc
@@ -45570,7 +46141,7 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45570
46141
  pageSize?: number;
45571
46142
  /**
45572
46143
  * @remarks
45573
- * The unique identifier of the table. You can obtain the unique identifier by calling the [GetMetaDBTableList](https://help.aliyun.com/document_detail/173916.html) interface.
46144
+ * The unique identifier of the table. You can call the [GetMetaDBTableList](https://help.aliyun.com/document_detail/173916.html) operation to query the unique identifier of the table.
45574
46145
  *
45575
46146
  * @example
45576
46147
  * odps.engine_name.table_name
@@ -45578,7 +46149,9 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45578
46149
  tableGuid?: string;
45579
46150
  /**
45580
46151
  * @remarks
45581
- * The name of the EMR table. You can obtain the table name by calling the [GetMetaDBTableList](https://help.aliyun.com/document_detail/173916.html) interface.
46152
+ * The name of the table in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.
46153
+ *
46154
+ * You can call the [GetMetaDBTableList](https://help.aliyun.com/document_detail/173916.html) operation to query the table name.
45582
46155
  *
45583
46156
  * @example
45584
46157
  * abc
@@ -45598,12 +46171,12 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45598
46171
  export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45599
46172
  /**
45600
46173
  * @remarks
45601
- * Business data.
46174
+ * The business data.
45602
46175
  */
45603
46176
  data?: GetMetaTableFullInfoResponseBodyData;
45604
46177
  /**
45605
46178
  * @remarks
45606
- * Error code.
46179
+ * The error code.
45607
46180
  *
45608
46181
  * @example
45609
46182
  * 1031203110005
@@ -45611,7 +46184,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45611
46184
  errorCode?: string;
45612
46185
  /**
45613
46186
  * @remarks
45614
- * Error message.
46187
+ * The error message.
45615
46188
  *
45616
46189
  * @example
45617
46190
  * The specified parameters are invalid.
@@ -45619,7 +46192,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45619
46192
  errorMessage?: string;
45620
46193
  /**
45621
46194
  * @remarks
45622
- * HTTP status code.
46195
+ * The HTTP status code.
45623
46196
  *
45624
46197
  * @example
45625
46198
  * 200
@@ -45627,7 +46200,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45627
46200
  httpStatusCode?: number;
45628
46201
  /**
45629
46202
  * @remarks
45630
- * Request ID. Used for locating logs and troubleshooting issues.
46203
+ * The request ID.
45631
46204
  *
45632
46205
  * @example
45633
46206
  * 0bc1411515937****
@@ -45635,7 +46208,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45635
46208
  requestId?: string;
45636
46209
  /**
45637
46210
  * @remarks
45638
- * Whether the call was successful.
46211
+ * Indicates whether the request was successful.
45639
46212
  *
45640
46213
  * @example
45641
46214
  * true
@@ -46857,7 +47430,7 @@ export declare class GetNodeRequest extends $dara.Model {
46857
47430
  nodeId?: number;
46858
47431
  /**
46859
47432
  * @remarks
46860
- * The priority of the node. Valid values: 1, 3, 5, 7, and 8.
47433
+ * The environment of the workspace. Valid values: PROD and DEV.
46861
47434
  *
46862
47435
  * This parameter is required.
46863
47436
  *
@@ -47524,10 +48097,13 @@ export declare class GetOpRiskDataRequest extends $dara.Model {
47524
48097
  pageSize?: number;
47525
48098
  /**
47526
48099
  * @remarks
47527
- * The method that you use to identify risks. Valid values:
48100
+ * The method that you use to identify risks.
47528
48101
  *
47529
48102
  * * You can manually identify risks.
47530
48103
  * * You can also use a sensitive data identification rule to identify risks. You can log on to the DataWorks console and go to the Risk Identification Rules page in Data Security Guard to obtain the name of the rule.
48104
+ *
48105
+ * @example
48106
+ * Manual identification
47531
48107
  */
47532
48108
  riskType?: string;
47533
48109
  static names(): {
@@ -47560,6 +48136,21 @@ export declare class GetOpRiskDataResponseBody extends $dara.Model {
47560
48136
  * * sql: the SQL statement that is executed
47561
48137
  * * opAccount: the account that is used to perform the operation
47562
48138
  * * opTime: the time when the operation was performed
48139
+ *
48140
+ * @example
48141
+ * {
48142
+ * "opRiskDatas": [
48143
+ * {
48144
+ * "riskType": "Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine",
48145
+ * "opTime": "2021-01-04 23:39:13",
48146
+ * "opType": "SQL_SELECT",
48147
+ * "opAccount": "user",
48148
+ * "sensType": "Email/name/mobile phone number",
48149
+ * "sql": "SELECT * FROM default.jiade_1219_test_create LIMIT 20"
48150
+ * }
48151
+ * ],
48152
+ * "totalCount": 499
48153
+ * }
47563
48154
  */
47564
48155
  riskData?: string;
47565
48156
  static names(): {
@@ -47674,6 +48265,9 @@ export declare class GetOpSensitiveDataResponseBody extends $dara.Model {
47674
48265
  * * sql: the SQL statement that is executed.
47675
48266
  * * opAccount: the account that is used to perform the operation.
47676
48267
  * * opTime: the time when the operation was performed.
48268
+ *
48269
+ * @example
48270
+ * "opSensDatas": [ { "sensLevel": "L4", "opTime": "2021-02-07 00:14:51", "opAccount": "ALIYUN$dsg_test", "sensType": "Mobile phone number", "sql": "select * from dsg_demo.tbl_phonebook where phone_no = &#39;1331111****&#39;;" } ], "totalCount": 6
47677
48271
  */
47678
48272
  opSensitiveData?: string;
47679
48273
  /**
@@ -48161,15 +48755,26 @@ export declare class GetQualityEntityResponse extends $dara.Model {
48161
48755
  export declare class GetQualityFollowerRequest extends $dara.Model {
48162
48756
  /**
48163
48757
  * @remarks
48758
+ * The ID of the partition filter expression.
48759
+ *
48164
48760
  * This parameter is required.
48165
48761
  *
48166
48762
  * @example
48167
48763
  * 1234
48168
48764
  */
48169
48765
  entityId?: number;
48766
+ /**
48767
+ * @remarks
48768
+ * The ID of the DataWorks workspace.
48769
+ *
48770
+ * @example
48771
+ * 27
48772
+ */
48170
48773
  projectId?: number;
48171
48774
  /**
48172
48775
  * @remarks
48776
+ * The name of the engine or data source.
48777
+ *
48173
48778
  * This parameter is required.
48174
48779
  *
48175
48780
  * @example
@@ -48188,28 +48793,47 @@ export declare class GetQualityFollowerRequest extends $dara.Model {
48188
48793
  });
48189
48794
  }
48190
48795
  export declare class GetQualityFollowerResponseBody extends $dara.Model {
48796
+ /**
48797
+ * @remarks
48798
+ * The information about the subscription relationship.
48799
+ */
48191
48800
  data?: GetQualityFollowerResponseBodyData[];
48192
48801
  /**
48802
+ * @remarks
48803
+ * The error code.
48804
+ *
48193
48805
  * @example
48194
48806
  * Invalid.Tenant.ConnectionNotExists
48195
48807
  */
48196
48808
  errorCode?: string;
48197
48809
  /**
48810
+ * @remarks
48811
+ * The error message.
48812
+ *
48198
48813
  * @example
48199
48814
  * You have no permission.
48200
48815
  */
48201
48816
  errorMessage?: string;
48202
48817
  /**
48818
+ * @remarks
48819
+ * The HTTP return code.
48820
+ *
48203
48821
  * @example
48204
48822
  * 200
48205
48823
  */
48206
48824
  httpStatusCode?: number;
48207
48825
  /**
48826
+ * @remarks
48827
+ * The ID of the request.
48828
+ *
48208
48829
  * @example
48209
48830
  * 38cbdef0-f6cf-49
48210
48831
  */
48211
48832
  requestId?: string;
48212
48833
  /**
48834
+ * @remarks
48835
+ * Whether the call is successful.
48836
+ *
48213
48837
  * @example
48214
48838
  * true
48215
48839
  */
@@ -48410,7 +49034,7 @@ export declare class GetRemindResponseBody extends $dara.Model {
48410
49034
  httpStatusCode?: number;
48411
49035
  /**
48412
49036
  * @remarks
48413
- * The request ID. You can use the ID to troubleshoot issues.
49037
+ * The request ID.
48414
49038
  *
48415
49039
  * @example
48416
49040
  * 0000-ABCD-EFGH-IJKLMNOPQ
@@ -48713,6 +49337,8 @@ export declare class GetTopicResponse extends $dara.Model {
48713
49337
  export declare class GetTopicInfluenceRequest extends $dara.Model {
48714
49338
  /**
48715
49339
  * @remarks
49340
+ * The ID of the event.
49341
+ *
48716
49342
  * This parameter is required.
48717
49343
  *
48718
49344
  * @example
@@ -48733,30 +49359,45 @@ export declare class GetTopicInfluenceRequest extends $dara.Model {
48733
49359
  export declare class GetTopicInfluenceResponseBody extends $dara.Model {
48734
49360
  /**
48735
49361
  * @remarks
48736
- * The data returned.
49362
+ * The list of baseline instances affected by the event.
48737
49363
  */
48738
49364
  data?: GetTopicInfluenceResponseBodyData;
48739
49365
  /**
49366
+ * @remarks
49367
+ * The error code returned.
49368
+ *
48740
49369
  * @example
48741
49370
  * 1031203110005
48742
49371
  */
48743
49372
  errorCode?: string;
48744
49373
  /**
49374
+ * @remarks
49375
+ * The error message returned.
49376
+ *
48745
49377
  * @example
48746
49378
  * The specified parameters are invalid.
48747
49379
  */
48748
49380
  errorMessage?: string;
48749
49381
  /**
49382
+ * @remarks
49383
+ * The HTTP status code returned.
49384
+ *
48750
49385
  * @example
48751
49386
  * 200
48752
49387
  */
48753
49388
  httpStatusCode?: number;
48754
49389
  /**
49390
+ * @remarks
49391
+ * The ID of the request. You can use the ID to troubleshoot issues.
49392
+ *
48755
49393
  * @example
48756
49394
  * 0000-ABCD-EFG****
48757
49395
  */
48758
49396
  requestId?: string;
48759
49397
  /**
49398
+ * @remarks
49399
+ * Indicates whether the request was successful.
49400
+ *
48760
49401
  * @example
48761
49402
  * true
48762
49403
  */
@@ -49103,6 +49744,9 @@ export declare class ListBaselineConfigsRequest extends $dara.Model {
49103
49744
  /**
49104
49745
  * @remarks
49105
49746
  * The keyword in the baseline name, which is used to search for the baseline.
49747
+ *
49748
+ * @example
49749
+ * Baseline name search keywords
49106
49750
  */
49107
49751
  searchText?: string;
49108
49752
  /**
@@ -49800,12 +50444,21 @@ export declare class ListCalcEnginesResponse extends $dara.Model {
49800
50444
  export declare class ListCheckProcessesRequest extends $dara.Model {
49801
50445
  /**
49802
50446
  * @remarks
50447
+ * Extension point event encoding.
50448
+ *
49803
50449
  * This parameter is required.
49804
50450
  *
49805
50451
  * @example
49806
50452
  * commit-file
49807
50453
  */
49808
50454
  eventCode?: string;
50455
+ /**
50456
+ * @remarks
50457
+ * The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.
50458
+ *
50459
+ * @example
50460
+ * 03400b03-b721-4c34-8727-2****1
50461
+ */
49809
50462
  messageId?: string;
49810
50463
  /**
49811
50464
  * @remarks
@@ -49816,21 +50469,37 @@ export declare class ListCheckProcessesRequest extends $dara.Model {
49816
50469
  */
49817
50470
  operator?: string;
49818
50471
  /**
50472
+ * @remarks
50473
+ * The page number. Default value: 1.
50474
+ *
49819
50475
  * @example
49820
50476
  * 1
49821
50477
  */
49822
50478
  pageNumber?: number;
49823
50479
  /**
50480
+ * @remarks
50481
+ * The number of entries per page.
50482
+ *
49824
50483
  * @example
49825
50484
  * 10
49826
50485
  */
49827
50486
  pageSize?: number;
49828
50487
  /**
50488
+ * @remarks
50489
+ * The ID of the workspace.
50490
+ *
49829
50491
  * @example
49830
50492
  * 123465
49831
50493
  */
49832
50494
  projectId?: number;
49833
50495
  /**
50496
+ * @remarks
50497
+ * The check status of the extension. Valid values:
50498
+ *
50499
+ * * CHECKING
50500
+ * * PASSED
50501
+ * * BLOCKED
50502
+ *
49834
50503
  * @example
49835
50504
  * True
49836
50505
  */
@@ -49847,8 +50516,15 @@ export declare class ListCheckProcessesRequest extends $dara.Model {
49847
50516
  });
49848
50517
  }
49849
50518
  export declare class ListCheckProcessesResponseBody extends $dara.Model {
50519
+ /**
50520
+ * @remarks
50521
+ * The pagination information.
50522
+ */
49850
50523
  pagingInfo?: ListCheckProcessesResponseBodyPagingInfo;
49851
50524
  /**
50525
+ * @remarks
50526
+ * The ID of the request.
50527
+ *
49852
50528
  * @example
49853
50529
  * 0000-ABCD-EF****
49854
50530
  */
@@ -50863,6 +51539,9 @@ export declare class ListDataServiceApisRequest extends $dara.Model {
50863
51539
  /**
50864
51540
  * @remarks
50865
51541
  * The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.
51542
+ *
51543
+ * @example
51544
+ * My API name
50866
51545
  */
50867
51546
  apiNameKeyword?: string;
50868
51547
  /**
@@ -51452,6 +52131,9 @@ export declare class ListDataServicePublishedApisRequest extends $dara.Model {
51452
52131
  /**
51453
52132
  * @remarks
51454
52133
  * The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.
52134
+ *
52135
+ * @example
52136
+ * My API name
51455
52137
  */
51456
52138
  apiNameKeyword?: string;
51457
52139
  /**
@@ -52551,6 +53233,9 @@ export declare class ListFileVersionsResponse extends $dara.Model {
52551
53233
  }
52552
53234
  export declare class ListFilesRequest extends $dara.Model {
52553
53235
  /**
53236
+ * @remarks
53237
+ * The exact matching file name. The file name of the query result is exactly the same as this parameter.
53238
+ *
52554
53239
  * @example
52555
53240
  * ods_create.sql
52556
53241
  */
@@ -52558,9 +53243,15 @@ export declare class ListFilesRequest extends $dara.Model {
52558
53243
  /**
52559
53244
  * @remarks
52560
53245
  * The path of the files.
53246
+ *
53247
+ * @example
53248
+ * Business_process/my_first_business_process/MaxCompute/ods_layer
52561
53249
  */
52562
53250
  fileFolderPath?: string;
52563
53251
  /**
53252
+ * @remarks
53253
+ * The file ID list. The File ID set of the query result can only be a subset of the list. You can specify up to 50 fileids at a time.
53254
+ *
52564
53255
  * @example
52565
53256
  * 78237,816123
52566
53257
  */
@@ -52584,11 +53275,17 @@ export declare class ListFilesRequest extends $dara.Model {
52584
53275
  */
52585
53276
  keyword?: string;
52586
53277
  /**
53278
+ * @remarks
53279
+ * Whether the query result contains the path of the folder where the file is located.
53280
+ *
52587
53281
  * @example
52588
53282
  * false
52589
53283
  */
52590
53284
  needAbsoluteFolderPath?: boolean;
52591
53285
  /**
53286
+ * @remarks
53287
+ * Whether the query results contain file content (for files with more content, there may be a long network transmission delay).
53288
+ *
52592
53289
  * @example
52593
53290
  * false
52594
53291
  */
@@ -52774,6 +53471,9 @@ export declare class ListFoldersRequest extends $dara.Model {
52774
53471
  * The path of the parent folder.
52775
53472
  *
52776
53473
  * This parameter is required.
53474
+ *
53475
+ * @example
53476
+ * Business_process/my_first_business_process/MaxCompute
52777
53477
  */
52778
53478
  parentFolderPath?: string;
52779
53479
  /**
@@ -53228,6 +53928,16 @@ export declare class ListInstancesRequest extends $dara.Model {
53228
53928
  * openmr_8****
53229
53929
  */
53230
53930
  nodeName?: string;
53931
+ /**
53932
+ * @remarks
53933
+ * The sorting rule of the instances to be returned. Valid values:
53934
+ *
53935
+ * * CREATE_TIME_DESC: The instances are sorted in descending order of their creation time.
53936
+ * * INSTANCE_ID_DESC (default): The instances are sorted in descending order of their IDs.
53937
+ *
53938
+ * @example
53939
+ * INSTANCE_ID_DESC
53940
+ */
53231
53941
  orderBy?: string;
53232
53942
  /**
53233
53943
  * @remarks
@@ -53263,7 +53973,7 @@ export declare class ListInstancesRequest extends $dara.Model {
53263
53973
  programType?: string;
53264
53974
  /**
53265
53975
  * @remarks
53266
- * The time when the node was last modified.
53976
+ * The environment in which the node runs. Valid values: DEV and PROD.
53267
53977
  *
53268
53978
  * This parameter is required.
53269
53979
  *
@@ -53283,7 +53993,16 @@ export declare class ListInstancesRequest extends $dara.Model {
53283
53993
  projectId?: number;
53284
53994
  /**
53285
53995
  * @remarks
53286
- * The time when the instance started to wait to be scheduled.
53996
+ * The status of the node. Valid values:
53997
+ *
53998
+ * * NOT_RUN: The node is not run.
53999
+ * * WAIT_TIME: The node is waiting for the scheduling time to arrive.
54000
+ * * WAIT_RESOURCE: The node is waiting for resources.
54001
+ * * RUNNING: The node is running.
54002
+ * * CHECKING: Data quality is being checked for the node.
54003
+ * * CHECKING_CONDITION: Branch conditions are being checked for the node.
54004
+ * * FAILURE: The node fails to run.
54005
+ * * SUCCESS: The node is successfully run.
53287
54006
  *
53288
54007
  * @example
53289
54008
  * NOT_RUN
@@ -54500,7 +55219,7 @@ export declare class ListNodesRequest extends $dara.Model {
54500
55219
  owner?: string;
54501
55220
  /**
54502
55221
  * @remarks
54503
- * The number of entries to return on each page. Default value: 10. Maximum value: 100.
55222
+ * The page number. Minimum value: 1. Maximum value: 100.
54504
55223
  *
54505
55224
  * @example
54506
55225
  * 1
@@ -54508,7 +55227,7 @@ export declare class ListNodesRequest extends $dara.Model {
54508
55227
  pageNumber?: number;
54509
55228
  /**
54510
55229
  * @remarks
54511
- * The ID of the workspace.
55230
+ * The number of entries per page. Default value: 10. Maximum value: 100.
54512
55231
  *
54513
55232
  * @example
54514
55233
  * 10
@@ -54524,7 +55243,7 @@ export declare class ListNodesRequest extends $dara.Model {
54524
55243
  programType?: string;
54525
55244
  /**
54526
55245
  * @remarks
54527
- * The number of entries returned per page. Default value: 10. Maximum value: 100.
55246
+ * The environment in which the node runs. Valid values: DEV and PROD.
54528
55247
  *
54529
55248
  * This parameter is required.
54530
55249
  *
@@ -54542,6 +55261,17 @@ export declare class ListNodesRequest extends $dara.Model {
54542
55261
  * 1234
54543
55262
  */
54544
55263
  projectId?: number;
55264
+ /**
55265
+ * @remarks
55266
+ * The scheduling type. Valid values:
55267
+ *
55268
+ * * NORMAL: Nodes are scheduled as expected.
55269
+ * * PAUSE: Nodes are paused.
55270
+ * * SKIP: Nodes are dry-run. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.
55271
+ *
55272
+ * @example
55273
+ * NORMAL
55274
+ */
54545
55275
  schedulerType?: string;
54546
55276
  static names(): {
54547
55277
  [key: string]: string;
@@ -54557,7 +55287,7 @@ export declare class ListNodesRequest extends $dara.Model {
54557
55287
  export declare class ListNodesResponseBody extends $dara.Model {
54558
55288
  /**
54559
55289
  * @remarks
54560
- * The ID of the associated workflow.
55290
+ * The nodes.
54561
55291
  */
54562
55292
  data?: ListNodesResponseBodyData;
54563
55293
  /**
@@ -56439,6 +57169,9 @@ export declare class ListShiftSchedulesRequest extends $dara.Model {
56439
57169
  /**
56440
57170
  * @remarks
56441
57171
  * The keyword used to perform a fuzzy search on shift schedules.
57172
+ *
57173
+ * @example
57174
+ * Duty table name keyword
56442
57175
  */
56443
57176
  shiftScheduleName?: string;
56444
57177
  static names(): {
@@ -56801,6 +57534,8 @@ export declare class ListTableThemeResponse extends $dara.Model {
56801
57534
  export declare class ListTablesRequest extends $dara.Model {
56802
57535
  /**
56803
57536
  * @remarks
57537
+ * The type of the data source. Valid values: ODPS, emr, mysql, holo, analyticdb_for_mysql, oracle, postgresql, sqlserver, clickhouse, and starrocks.
57538
+ *
56804
57539
  * This parameter is required.
56805
57540
  *
56806
57541
  * @example
@@ -56811,11 +57546,17 @@ export declare class ListTablesRequest extends $dara.Model {
56811
57546
  */
56812
57547
  dataSourceType?: string;
56813
57548
  /**
57549
+ * @remarks
57550
+ * Pagination information, which specifies the starting point of this read.
57551
+ *
56814
57552
  * @example
56815
57553
  * 12222
56816
57554
  */
56817
57555
  nextToken?: string;
56818
57556
  /**
57557
+ * @remarks
57558
+ * The number of entries displayed on each page. The default value is 10 and the maximum value is 100.
57559
+ *
56819
57560
  * @example
56820
57561
  * 10
56821
57562
  */
@@ -57492,6 +58233,9 @@ export declare class QueryDefaultTemplateResponseBody extends $dara.Model {
57492
58233
  * The returned data about the default data category and data sensitivity level template. The data is in the JSON array format.
57493
58234
  *
57494
58235
  * This parameter is required.
58236
+ *
58237
+ * @example
58238
+ * [{"gmtModified":1709022365000,"fileName":"default file","isDelete":false,"isDefaultTemplate":true}]
57495
58239
  */
57496
58240
  data?: any;
57497
58241
  /**
@@ -57509,6 +58253,9 @@ export declare class QueryDefaultTemplateResponseBody extends $dara.Model {
57509
58253
  * The error message.
57510
58254
  *
57511
58255
  * This parameter is required.
58256
+ *
58257
+ * @example
58258
+ * Parameter error
57512
58259
  */
57513
58260
  errorMessage?: string;
57514
58261
  /**
@@ -57705,6 +58452,9 @@ export declare class QueryRecognizeDataByRuleTypeResponseBody extends $dara.Mode
57705
58452
  /**
57706
58453
  * @remarks
57707
58454
  * The error message.
58455
+ *
58456
+ * @example
58457
+ * Missing parameter
57708
58458
  */
57709
58459
  errorMessage?: string;
57710
58460
  /**
@@ -57768,6 +58518,9 @@ export declare class QueryRecognizeRuleDetailRequest extends $dara.Model {
57768
58518
  * The name of the sensitive field. To obtain the name of the sensitive field, call the [QuerySensNodeInfo](https://help.aliyun.com/document_detail/2747189.html) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Category and Sensitivity Level page.
57769
58519
  *
57770
58520
  * This parameter is required.
58521
+ *
58522
+ * @example
58523
+ * Name
57771
58524
  */
57772
58525
  sensitiveName?: string;
57773
58526
  /**
@@ -57795,6 +58548,9 @@ export declare class QueryRecognizeRuleDetailResponseBody extends $dara.Model {
57795
58548
  /**
57796
58549
  * @remarks
57797
58550
  * The details of the sensitive field in the JSON format.
58551
+ *
58552
+ * @example
58553
+ * {"nodeName":"basic unit overview","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"," defineType ":1,": ydAccuracy ":{" contentRule ":))," operationType ":0}," nodeParent ":" unit/unit basic information/unit basic overview "," level ":6," keyRuleId ":" 228248921215042mobile-yinni "," isDelete ":false," levelName ":" 6level "," sensitive ":false," operationType ":0," sourceName ": dsg-test-zuoyue","nodeId":"bea2fc81-90c9-45f3-b7a9-26d534208a0d","status":1}
57798
58554
  */
57799
58555
  data?: any;
57800
58556
  /**
@@ -57808,6 +58564,9 @@ export declare class QueryRecognizeRuleDetailResponseBody extends $dara.Model {
57808
58564
  /**
57809
58565
  * @remarks
57810
58566
  * The error message.
58567
+ *
58568
+ * @example
58569
+ * Missing parameter
57811
58570
  */
57812
58571
  errorMessage?: string;
57813
58572
  /**
@@ -57885,6 +58644,9 @@ export declare class QueryRecognizeRulesTypeResponseBody extends $dara.Model {
57885
58644
  /**
57886
58645
  * @remarks
57887
58646
  * The error message.
58647
+ *
58648
+ * @example
58649
+ * Missing parameter
57888
58650
  */
57889
58651
  errorMessage?: string;
57890
58652
  /**
@@ -57994,6 +58756,9 @@ export declare class QuerySensClassificationResponseBody extends $dara.Model {
57994
58756
  /**
57995
58757
  * @remarks
57996
58758
  * The error message.
58759
+ *
58760
+ * @example
58761
+ * Missing parameter
57997
58762
  */
57998
58763
  errorMessage?: string;
57999
58764
  /**
@@ -58103,6 +58868,9 @@ export declare class QuerySensLevelResponseBody extends $dara.Model {
58103
58868
  /**
58104
58869
  * @remarks
58105
58870
  * The error message.
58871
+ *
58872
+ * @example
58873
+ * Missing parameter
58106
58874
  */
58107
58875
  errorMessage?: string;
58108
58876
  /**
@@ -58188,6 +58956,9 @@ export declare class QuerySensNodeInfoRequest extends $dara.Model {
58188
58956
  /**
58189
58957
  * @remarks
58190
58958
  * The name of the sensitive field. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the name.
58959
+ *
58960
+ * @example
58961
+ * ID card
58191
58962
  */
58192
58963
  sensitiveName?: string;
58193
58964
  /**
@@ -58236,6 +59007,9 @@ export declare class QuerySensNodeInfoResponseBody extends $dara.Model {
58236
59007
  /**
58237
59008
  * @remarks
58238
59009
  * The returned business data in the JSON format.
59010
+ *
59011
+ * @example
59012
+ * {"success": true, "httpStatusCode": 200, "data": { "result": [ { "sensitiveName": "certificate expiration date", "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12", "status": 0, "templateName": "built-in classification and grading template", "keyRuleId": "228248921215042 certificate expiration date"} ], "totalCount": 1, "currentPage": 1, "pageSize": 10 }, "requestId": 10000001}
58239
59013
  */
58240
59014
  data?: any;
58241
59015
  /**
@@ -58249,6 +59023,9 @@ export declare class QuerySensNodeInfoResponseBody extends $dara.Model {
58249
59023
  /**
58250
59024
  * @remarks
58251
59025
  * The error message.
59026
+ *
59027
+ * @example
59028
+ * Missing parameter
58252
59029
  */
58253
59030
  errorMessage?: string;
58254
59031
  /**
@@ -58376,7 +59153,7 @@ export declare class RegisterLineageRelationResponseBody extends $dara.Model {
58376
59153
  lineageRelation?: RegisterLineageRelationResponseBodyLineageRelation;
58377
59154
  /**
58378
59155
  * @remarks
58379
- * The request ID.
59156
+ * The request ID. You can locate logs and troubleshoot issues based on the ID.
58380
59157
  *
58381
59158
  * @example
58382
59159
  * EE50E05E-028C-182B-9xxx
@@ -59397,6 +60174,9 @@ export declare class RunManualDagNodesRequest extends $dara.Model {
59397
60174
  * The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.
59398
60175
  *
59399
60176
  * This parameter is required.
60177
+ *
60178
+ * @example
60179
+ * PROD or DEV
59400
60180
  */
59401
60181
  projectEnv?: string;
59402
60182
  /**
@@ -59740,6 +60520,9 @@ export declare class SaveDataServiceApiTestResultRequest extends $dara.Model {
59740
60520
  /**
59741
60521
  * @remarks
59742
60522
  * The sample failure response of the API. This parameter is optional.
60523
+ *
60524
+ * @example
60525
+ * {"apiLog": null, "data": null, "errCode": 1108110622, "errMsg": "data Source query failed", "requestId": "0 bc14a **** 5902762031 ****"}
59743
60526
  */
59744
60527
  failResultSample?: string;
59745
60528
  /**
@@ -61240,6 +62023,9 @@ export declare class SubmitFileRequest extends $dara.Model {
61240
62023
  /**
61241
62024
  * @remarks
61242
62025
  * The description of the commit operation.
62026
+ *
62027
+ * @example
62028
+ * Submit a task for the first time
61243
62029
  */
61244
62030
  comment?: string;
61245
62031
  /**
@@ -62484,11 +63270,15 @@ export declare class UpdateClusterConfigsRequest extends $dara.Model {
62484
63270
  configType?: string;
62485
63271
  /**
62486
63272
  * @remarks
63273
+ * The configuration information of the cluster submodule.
63274
+ *
62487
63275
  * This parameter is required.
62488
63276
  */
62489
63277
  configValues?: ClusterConfig[];
62490
63278
  /**
62491
63279
  * @remarks
63280
+ * The ID of the workspace.
63281
+ *
62492
63282
  * This parameter is required.
62493
63283
  *
62494
63284
  * @example
@@ -62531,11 +63321,15 @@ export declare class UpdateClusterConfigsShrinkRequest extends $dara.Model {
62531
63321
  configType?: string;
62532
63322
  /**
62533
63323
  * @remarks
63324
+ * The configuration information of the cluster submodule.
63325
+ *
62534
63326
  * This parameter is required.
62535
63327
  */
62536
63328
  configValuesShrink?: string;
62537
63329
  /**
62538
63330
  * @remarks
63331
+ * The ID of the workspace.
63332
+ *
62539
63333
  * This parameter is required.
62540
63334
  *
62541
63335
  * @example
@@ -62566,21 +63360,33 @@ export declare class UpdateClusterConfigsResponseBody extends $dara.Model {
62566
63360
  */
62567
63361
  data?: boolean;
62568
63362
  /**
63363
+ * @remarks
63364
+ * The error code.
63365
+ *
62569
63366
  * @example
62570
63367
  * 101011005
62571
63368
  */
62572
63369
  errorCode?: string;
62573
63370
  /**
63371
+ * @remarks
63372
+ * The error message.
63373
+ *
62574
63374
  * @example
62575
63375
  * Invalid.Cluster.ClusterNotFound
62576
63376
  */
62577
63377
  errorMessage?: string;
62578
63378
  /**
63379
+ * @remarks
63380
+ * The HTTP status code.
63381
+ *
62579
63382
  * @example
62580
63383
  * 200
62581
63384
  */
62582
63385
  httpStatusCode?: number;
62583
63386
  /**
63387
+ * @remarks
63388
+ * The ID of the request. It is used to locate logs and troubleshoot problems.
63389
+ *
62584
63390
  * @example
62585
63391
  * 0000-ABCD-E****
62586
63392
  */
@@ -62932,6 +63738,9 @@ export declare class UpdateDIAlarmRuleRequest extends $dara.Model {
62932
63738
  /**
62933
63739
  * @remarks
62934
63740
  * The description of the alert rule.
63741
+ *
63742
+ * @example
63743
+ * mysql synchronizes to hologres heartbeat alert
62935
63744
  */
62936
63745
  description?: string;
62937
63746
  /**
@@ -62995,6 +63804,9 @@ export declare class UpdateDIAlarmRuleShrinkRequest extends $dara.Model {
62995
63804
  /**
62996
63805
  * @remarks
62997
63806
  * The description of the alert rule.
63807
+ *
63808
+ * @example
63809
+ * mysql synchronizes to hologres heartbeat alert
62998
63810
  */
62999
63811
  description?: string;
63000
63812
  /**
@@ -63093,6 +63905,9 @@ export declare class UpdateDIJobRequest extends $dara.Model {
63093
63905
  /**
63094
63906
  * @remarks
63095
63907
  * The description of the synchronization task.
63908
+ *
63909
+ * @example
63910
+ * Synchronize mysql to hologres
63096
63911
  */
63097
63912
  description?: string;
63098
63913
  /**
@@ -63112,7 +63927,7 @@ export declare class UpdateDIJobRequest extends $dara.Model {
63112
63927
  tableMappings?: UpdateDIJobRequestTableMappings[];
63113
63928
  /**
63114
63929
  * @remarks
63115
- * The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.
63930
+ * The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.
63116
63931
  */
63117
63932
  transformationRules?: UpdateDIJobRequestTransformationRules[];
63118
63933
  static names(): {
@@ -63138,6 +63953,9 @@ export declare class UpdateDIJobShrinkRequest extends $dara.Model {
63138
63953
  /**
63139
63954
  * @remarks
63140
63955
  * The description of the synchronization task.
63956
+ *
63957
+ * @example
63958
+ * Synchronize mysql to hologres
63141
63959
  */
63142
63960
  description?: string;
63143
63961
  /**
@@ -63157,7 +63975,7 @@ export declare class UpdateDIJobShrinkRequest extends $dara.Model {
63157
63975
  tableMappingsShrink?: string;
63158
63976
  /**
63159
63977
  * @remarks
63160
- * The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.
63978
+ * The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.
63161
63979
  */
63162
63980
  transformationRulesShrink?: string;
63163
63981
  static names(): {
@@ -63945,6 +64763,9 @@ export declare class UpdateFileRequest extends $dara.Model {
63945
64763
  */
63946
64764
  advancedSettings?: string;
63947
64765
  /**
64766
+ * @remarks
64767
+ * Whether the scheduling configuration takes effect immediately after the release.
64768
+ *
63948
64769
  * @example
63949
64770
  * true
63950
64771
  */
@@ -64067,11 +64888,17 @@ export declare class UpdateFileRequest extends $dara.Model {
64067
64888
  /**
64068
64889
  * @remarks
64069
64890
  * The description of the file.
64891
+ *
64892
+ * @example
64893
+ * Here is the file description
64070
64894
  */
64071
64895
  fileDescription?: string;
64072
64896
  /**
64073
64897
  * @remarks
64074
64898
  * The path of the file.
64899
+ *
64900
+ * @example
64901
+ * Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
64075
64902
  */
64076
64903
  fileFolderPath?: string;
64077
64904
  /**
@@ -64095,10 +64922,14 @@ export declare class UpdateFileRequest extends $dara.Model {
64095
64922
  */
64096
64923
  fileName?: string;
64097
64924
  /**
64925
+ * @remarks
64926
+ * Scheduling configuration-> previous cycle-> whether to skip the upstream empty run attribute.
64927
+ *
64098
64928
  * @example
64099
64929
  * true
64100
64930
  */
64101
64931
  ignoreParentSkipRunningProperty?: boolean;
64932
+ imageId?: string;
64102
64933
  /**
64103
64934
  * @remarks
64104
64935
  * The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).
@@ -66650,7 +67481,7 @@ export declare class UpdateUdfFileRequest extends $dara.Model {
66650
67481
  returnValue?: string;
66651
67482
  /**
66652
67483
  * @remarks
66653
- * The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function in the DataWorks console.
67484
+ * The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.
66654
67485
  *
66655
67486
  * @example
66656
67487
  * Concatenate several strings to generate a new string
@@ -69103,7 +69934,10 @@ export default class Client extends OpenApi {
69103
69934
  */
69104
69935
  getMetaTableColumn(request: GetMetaTableColumnRequest): Promise<GetMetaTableColumnResponse>;
69105
69936
  /**
69106
- * Invoke the GetMetaTableFullInfo interface to obtain the complete information of a table (including field information).
69937
+ * Queries the complete information about a table, including information about fields in the table.
69938
+ *
69939
+ * @remarks
69940
+ * You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.
69107
69941
  *
69108
69942
  * @param request - GetMetaTableFullInfoRequest
69109
69943
  * @param runtime - runtime options for this request RuntimeOptions
@@ -69111,7 +69945,10 @@ export default class Client extends OpenApi {
69111
69945
  */
69112
69946
  getMetaTableFullInfoWithOptions(request: GetMetaTableFullInfoRequest, runtime: $dara.RuntimeOptions): Promise<GetMetaTableFullInfoResponse>;
69113
69947
  /**
69114
- * Invoke the GetMetaTableFullInfo interface to obtain the complete information of a table (including field information).
69948
+ * Queries the complete information about a table, including information about fields in the table.
69949
+ *
69950
+ * @remarks
69951
+ * You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.
69115
69952
  *
69116
69953
  * @param request - GetMetaTableFullInfoRequest
69117
69954
  * @returns GetMetaTableFullInfoResponse
@@ -69462,12 +70299,16 @@ export default class Client extends OpenApi {
69462
70299
  */
69463
70300
  getQualityEntity(request: GetQualityEntityRequest): Promise<GetQualityEntityResponse>;
69464
70301
  /**
70302
+ * Queries the subscribers of a partition filter expression.
70303
+ *
69465
70304
  * @param request - GetQualityFollowerRequest
69466
70305
  * @param runtime - runtime options for this request RuntimeOptions
69467
70306
  * @returns GetQualityFollowerResponse
69468
70307
  */
69469
70308
  getQualityFollowerWithOptions(request: GetQualityFollowerRequest, runtime: $dara.RuntimeOptions): Promise<GetQualityFollowerResponse>;
69470
70309
  /**
70310
+ * Queries the subscribers of a partition filter expression.
70311
+ *
69471
70312
  * @param request - GetQualityFollowerRequest
69472
70313
  * @returns GetQualityFollowerResponse
69473
70314
  */
@@ -69566,12 +70407,24 @@ export default class Client extends OpenApi {
69566
70407
  */
69567
70408
  getTopic(request: GetTopicRequest): Promise<GetTopicResponse>;
69568
70409
  /**
70410
+ * Queries baseline instances affected by an event.
70411
+ *
70412
+ * @remarks
70413
+ * ## Debugging
70414
+ * [OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetTopicInfluence\\&type=RPC\\&version=2020-05-18)
70415
+ *
69569
70416
  * @param request - GetTopicInfluenceRequest
69570
70417
  * @param runtime - runtime options for this request RuntimeOptions
69571
70418
  * @returns GetTopicInfluenceResponse
69572
70419
  */
69573
70420
  getTopicInfluenceWithOptions(request: GetTopicInfluenceRequest, runtime: $dara.RuntimeOptions): Promise<GetTopicInfluenceResponse>;
69574
70421
  /**
70422
+ * Queries baseline instances affected by an event.
70423
+ *
70424
+ * @remarks
70425
+ * ## Debugging
70426
+ * [OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetTopicInfluence\\&type=RPC\\&version=2020-05-18)
70427
+ *
69575
70428
  * @param request - GetTopicInfluenceRequest
69576
70429
  * @returns GetTopicInfluenceResponse
69577
70430
  */
@@ -69692,7 +70545,7 @@ export default class Client extends OpenApi {
69692
70545
  */
69693
70546
  listCalcEngines(request: ListCalcEnginesRequest): Promise<ListCalcEnginesResponse>;
69694
70547
  /**
69695
- * 查询扩展事件的检查列表
70548
+ * Queries the check results of extension point events.
69696
70549
  *
69697
70550
  * @param request - ListCheckProcessesRequest
69698
70551
  * @param runtime - runtime options for this request RuntimeOptions
@@ -69700,7 +70553,7 @@ export default class Client extends OpenApi {
69700
70553
  */
69701
70554
  listCheckProcessesWithOptions(request: ListCheckProcessesRequest, runtime: $dara.RuntimeOptions): Promise<ListCheckProcessesResponse>;
69702
70555
  /**
69703
- * 查询扩展事件的检查列表
70556
+ * Queries the check results of extension point events.
69704
70557
  *
69705
70558
  * @param request - ListCheckProcessesRequest
69706
70559
  * @returns ListCheckProcessesResponse
@@ -70089,23 +70942,31 @@ export default class Client extends OpenApi {
70089
70942
  */
70090
70943
  listFileType(request: ListFileTypeRequest): Promise<ListFileTypeResponse>;
70091
70944
  /**
70945
+ * Queries a list of file versions.
70946
+ *
70092
70947
  * @param request - ListFileVersionsRequest
70093
70948
  * @param runtime - runtime options for this request RuntimeOptions
70094
70949
  * @returns ListFileVersionsResponse
70095
70950
  */
70096
70951
  listFileVersionsWithOptions(request: ListFileVersionsRequest, runtime: $dara.RuntimeOptions): Promise<ListFileVersionsResponse>;
70097
70952
  /**
70953
+ * Queries a list of file versions.
70954
+ *
70098
70955
  * @param request - ListFileVersionsRequest
70099
70956
  * @returns ListFileVersionsResponse
70100
70957
  */
70101
70958
  listFileVersions(request: ListFileVersionsRequest): Promise<ListFileVersionsResponse>;
70102
70959
  /**
70960
+ * Queries a list of files.
70961
+ *
70103
70962
  * @param request - ListFilesRequest
70104
70963
  * @param runtime - runtime options for this request RuntimeOptions
70105
70964
  * @returns ListFilesResponse
70106
70965
  */
70107
70966
  listFilesWithOptions(request: ListFilesRequest, runtime: $dara.RuntimeOptions): Promise<ListFilesResponse>;
70108
70967
  /**
70968
+ * Queries a list of files.
70969
+ *
70109
70970
  * @param request - ListFilesRequest
70110
70971
  * @returns ListFilesResponse
70111
70972
  */
@@ -70171,7 +71032,7 @@ export default class Client extends OpenApi {
70171
71032
  */
70172
71033
  listInstanceHistory(request: ListInstanceHistoryRequest): Promise<ListInstanceHistoryResponse>;
70173
71034
  /**
70174
- * The ID of the directed acyclic graph (DAG). You can set this parameter to the value of the DagId parameter returned by the [RunCycleDagNodes](https://help.aliyun.com/document_detail/212961.html), [RunSmokeTest](https://help.aliyun.com/document_detail/212949.html), or [RunManualDagNodes](https://help.aliyun.com/document_detail/212830.html) operation based on your business requirements. The RunManualDagNodes operation is used to backfill data, the RunSmokeTest operation is used to perform smoke testing, and the RunManualDagNodes operation is used to run nodes in a manually triggered workflow.
71035
+ * Queries a list of instances.
70175
71036
  *
70176
71037
  * @param request - ListInstancesRequest
70177
71038
  * @param runtime - runtime options for this request RuntimeOptions
@@ -70179,7 +71040,7 @@ export default class Client extends OpenApi {
70179
71040
  */
70180
71041
  listInstancesWithOptions(request: ListInstancesRequest, runtime: $dara.RuntimeOptions): Promise<ListInstancesResponse>;
70181
71042
  /**
70182
- * The ID of the directed acyclic graph (DAG). You can set this parameter to the value of the DagId parameter returned by the [RunCycleDagNodes](https://help.aliyun.com/document_detail/212961.html), [RunSmokeTest](https://help.aliyun.com/document_detail/212949.html), or [RunManualDagNodes](https://help.aliyun.com/document_detail/212830.html) operation based on your business requirements. The RunManualDagNodes operation is used to backfill data, the RunSmokeTest operation is used to perform smoke testing, and the RunManualDagNodes operation is used to run nodes in a manually triggered workflow.
71043
+ * Queries a list of instances.
70183
71044
  *
70184
71045
  * @param request - ListInstancesRequest
70185
71046
  * @returns ListInstancesResponse
@@ -71430,7 +72291,7 @@ export default class Client extends OpenApi {
71430
72291
  */
71431
72292
  updateBusiness(request: UpdateBusinessRequest): Promise<UpdateBusinessResponse>;
71432
72293
  /**
71433
- * 更新集群的配置信息
72294
+ * Updates the configurations of submodules in a workspace. You can configure SPARK parameters.
71434
72295
  *
71435
72296
  * @param tmpReq - UpdateClusterConfigsRequest
71436
72297
  * @param runtime - runtime options for this request RuntimeOptions
@@ -71438,7 +72299,7 @@ export default class Client extends OpenApi {
71438
72299
  */
71439
72300
  updateClusterConfigsWithOptions(tmpReq: UpdateClusterConfigsRequest, runtime: $dara.RuntimeOptions): Promise<UpdateClusterConfigsResponse>;
71440
72301
  /**
71441
- * 更新集群的配置信息
72302
+ * Updates the configurations of submodules in a workspace. You can configure SPARK parameters.
71442
72303
  *
71443
72304
  * @param request - UpdateClusterConfigsRequest
71444
72305
  * @returns UpdateClusterConfigsResponse