@alicloud/dataworks-public20200518 6.2.2 → 7.0.0

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
@@ -738,6 +738,7 @@ export declare class CreateMetaCategoryResponseBodyData extends $dara.Model {
738
738
  });
739
739
  }
740
740
  export declare class CreatePermissionApplyOrderRequestApplyObjectColumnMetaList extends $dara.Model {
741
+ actions?: string;
741
742
  /**
742
743
  * @remarks
743
744
  * The field on which you want to request permissions. If you want to request permissions on an entire table, enter all fields in the table. You can request permissions on specific fields of a table in a MaxCompute project only after LabelSecurity is enabled for this project. If LabelSecurity is disabled, you can request permissions only on an entire table.
@@ -764,8 +765,6 @@ export declare class CreatePermissionApplyOrderRequestApplyObject extends $dara.
764
765
  * @remarks
765
766
  * The permission that you want to request. If you want to request multiple permissions at the same time, separate them with commas (,). You can request only the following permissions: Select, Describe, Drop, Alter, Update, and Download.
766
767
  *
767
- * This parameter is required.
768
- *
769
768
  * @example
770
769
  * Select,Describe
771
770
  */
@@ -773,8 +772,6 @@ export declare class CreatePermissionApplyOrderRequestApplyObject extends $dara.
773
772
  /**
774
773
  * @remarks
775
774
  * The fields on which you want to request permissions.
776
- *
777
- * This parameter is required.
778
775
  */
779
776
  columnMetaList?: CreatePermissionApplyOrderRequestApplyObjectColumnMetaList[];
780
777
  /**
@@ -2996,7 +2993,7 @@ export declare class GetBaselineResponseBodyDataOverTimeSettings extends $dara.M
2996
2993
  cycle?: number;
2997
2994
  /**
2998
2995
  * @remarks
2999
- * 承诺时间,hh:mm格式,hh的取值范围为[0,47]mm的取值范围为[0,59]
2996
+ * Commitment time, hh:mm format, hh value range is [0,47],mm value range is [0,59].
3000
2997
  *
3001
2998
  * @example
3002
2999
  * 00:00
@@ -4875,10 +4872,53 @@ export declare class GetDISyncInstanceInfoResponseBodyData extends $dara.Model {
4875
4872
  });
4876
4873
  }
4877
4874
  export declare class GetDISyncTaskResponseBodyDataAlarmListAlarmRuleList extends $dara.Model {
4875
+ /**
4876
+ * @remarks
4877
+ * The calculation method of a metric. Valid values:
4878
+ *
4879
+ * * avg
4880
+ * * max
4881
+ *
4882
+ * @example
4883
+ * avg
4884
+ */
4878
4885
  aggregator?: string;
4886
+ /**
4887
+ * @remarks
4888
+ * The comparison operator, which indicates the method used to compare a metric with the alert rule.
4889
+ *
4890
+ * * \\"=\\"
4891
+ * * \\"<\\"
4892
+ * * \\">\\"
4893
+ *
4894
+ * @example
4895
+ * =
4896
+ */
4879
4897
  comparator?: string;
4898
+ /**
4899
+ * @remarks
4900
+ * The duration that a condition is met before an alert is triggered. Unit: minutes.
4901
+ *
4902
+ * @example
4903
+ * 3
4904
+ */
4880
4905
  duration?: number;
4906
+ /**
4907
+ * @remarks
4908
+ * * WARNING
4909
+ * * CRITICAL
4910
+ *
4911
+ * @example
4912
+ * WARNING
4913
+ */
4881
4914
  level?: string;
4915
+ /**
4916
+ * @remarks
4917
+ * The threshold for the comparison between a metric and the alert rule.
4918
+ *
4919
+ * @example
4920
+ * 1
4921
+ */
4882
4922
  threshold?: number;
4883
4923
  static names(): {
4884
4924
  [key: string]: string;
@@ -4892,8 +4932,23 @@ export declare class GetDISyncTaskResponseBodyDataAlarmListAlarmRuleList extends
4892
4932
  });
4893
4933
  }
4894
4934
  export declare class GetDISyncTaskResponseBodyDataAlarmListNotifyRule extends $dara.Model {
4935
+ /**
4936
+ * @remarks
4937
+ * The settings for Critical-level alert notifications.
4938
+ */
4895
4939
  critical?: string[];
4940
+ /**
4941
+ * @remarks
4942
+ * The alert interval. Unit: minutes.
4943
+ *
4944
+ * @example
4945
+ * 5
4946
+ */
4896
4947
  interval?: number;
4948
+ /**
4949
+ * @remarks
4950
+ * The settings for Warning-level alert notifications.
4951
+ */
4897
4952
  warning?: string[];
4898
4953
  static names(): {
4899
4954
  [key: string]: string;
@@ -4907,12 +4962,62 @@ export declare class GetDISyncTaskResponseBodyDataAlarmListNotifyRule extends $d
4907
4962
  });
4908
4963
  }
4909
4964
  export declare class GetDISyncTaskResponseBodyDataAlarmList extends $dara.Model {
4965
+ /**
4966
+ * @remarks
4967
+ * The alert notification settings. The value of this parameter is an array.
4968
+ */
4910
4969
  alarmRuleList?: GetDISyncTaskResponseBodyDataAlarmListAlarmRuleList[];
4970
+ /**
4971
+ * @remarks
4972
+ * The description of the alert rule.
4973
+ *
4974
+ * @example
4975
+ * Description
4976
+ */
4911
4977
  description?: string;
4978
+ /**
4979
+ * @remarks
4980
+ * Indicates whether the alert rule is enabled.
4981
+ *
4982
+ * @example
4983
+ * true
4984
+ */
4912
4985
  enabled?: boolean;
4986
+ /**
4987
+ * @remarks
4988
+ * The ID of the alert rule.
4989
+ *
4990
+ * @example
4991
+ * 45242
4992
+ */
4913
4993
  id?: number;
4994
+ /**
4995
+ * @remarks
4996
+ * The alert type. Valid values:
4997
+ *
4998
+ * * taskStatus
4999
+ * * bizDelay
5000
+ * * taskFailoverCount
5001
+ * * ddlUnsupport
5002
+ * * ddlReport
5003
+ * * totalDirtyRecordWriteInLines
5004
+ *
5005
+ * @example
5006
+ * taskStatus
5007
+ */
4914
5008
  metric?: string;
5009
+ /**
5010
+ * @remarks
5011
+ * The settings for alert notification rules. The value of this parameter is an array.
5012
+ */
4915
5013
  notifyRule?: GetDISyncTaskResponseBodyDataAlarmListNotifyRule;
5014
+ /**
5015
+ * @remarks
5016
+ * The name of the alert rule.
5017
+ *
5018
+ * @example
5019
+ * Delay alert rule name 1
5020
+ */
4916
5021
  ruleName?: string;
4917
5022
  static names(): {
4918
5023
  [key: string]: string;
@@ -5037,6 +5142,10 @@ export declare class GetDISyncTaskResponseBodyDataSolutionDetail extends $dara.M
5037
5142
  });
5038
5143
  }
5039
5144
  export declare class GetDISyncTaskResponseBodyData extends $dara.Model {
5145
+ /**
5146
+ * @remarks
5147
+ * The alert rules that are associated with the real-time synchronization task. The value of this parameter is an array.
5148
+ */
5040
5149
  alarmList?: GetDISyncTaskResponseBodyDataAlarmList[];
5041
5150
  /**
5042
5151
  * @remarks
@@ -7390,7 +7499,7 @@ export declare class GetDeploymentResponseBodyDataDeployment extends $dara.Model
7390
7499
  creatorId?: string;
7391
7500
  /**
7392
7501
  * @remarks
7393
- * The error message that was returned when the deployment task failed. In this case, the value of the Status parameter is 2.
7502
+ * The error message that was returned when the deployment package failed. In this case, the value of the Status parameter is 2.
7394
7503
  *
7395
7504
  * @example
7396
7505
  * Success
@@ -7463,7 +7572,7 @@ export declare class GetDeploymentResponseBodyData extends $dara.Model {
7463
7572
  deployedItems?: GetDeploymentResponseBodyDataDeployedItems[];
7464
7573
  /**
7465
7574
  * @remarks
7466
- * The details of the deployment task.
7575
+ * The details of the deployment package.
7467
7576
  */
7468
7577
  deployment?: GetDeploymentResponseBodyDataDeployment;
7469
7578
  static names(): {
@@ -8080,12 +8189,20 @@ export declare class GetFileResponseBodyDataNodeConfiguration extends $dara.Mode
8080
8189
  endEffectDate?: number;
8081
8190
  /**
8082
8191
  * @remarks
8083
- * Scheduling configuration-> previous cycle-> whether to skip the upstream empty run attribute
8192
+ * 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
8193
  *
8085
8194
  * @example
8086
8195
  * true
8087
8196
  */
8088
8197
  ignoreParentSkipRunningProperty?: string;
8198
+ /**
8199
+ * @remarks
8200
+ * The ID of the custom image.
8201
+ *
8202
+ * @example
8203
+ * m-bp1h4b5a8ogkbll2f3tr
8204
+ */
8205
+ imageId?: string;
8089
8206
  /**
8090
8207
  * @remarks
8091
8208
  * The output names of the parent files on which the current file depends.
@@ -8192,7 +8309,7 @@ export declare class GetFileResponseBodyDataNodeConfiguration extends $dara.Mode
8192
8309
  stop?: boolean;
8193
8310
  /**
8194
8311
  * @remarks
8195
- * Scheduling configuration timeout definition
8312
+ * The timeout period.
8196
8313
  *
8197
8314
  * @example
8198
8315
  * 1
@@ -8212,7 +8329,7 @@ export declare class GetFileResponseBodyDataNodeConfiguration extends $dara.Mode
8212
8329
  export declare class GetFileResponseBodyDataResourceDownloadLink extends $dara.Model {
8213
8330
  /**
8214
8331
  * @remarks
8215
- * Resource download address link
8332
+ * The download URL of the resource.
8216
8333
  *
8217
8334
  * @example
8218
8335
  * http://xx
@@ -8242,7 +8359,7 @@ export declare class GetFileResponseBodyData extends $dara.Model {
8242
8359
  nodeConfiguration?: GetFileResponseBodyDataNodeConfiguration;
8243
8360
  /**
8244
8361
  * @remarks
8245
- * Resource download address
8362
+ * The download URL of the resource.
8246
8363
  */
8247
8364
  resourceDownloadLink?: GetFileResponseBodyDataResourceDownloadLink;
8248
8365
  static names(): {
@@ -10791,7 +10908,7 @@ export declare class GetMetaTableColumnResponseBodyData extends $dara.Model {
10791
10908
  export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dara.Model {
10792
10909
  /**
10793
10910
  * @remarks
10794
- * The description of the column.
10911
+ * The description of the field.
10795
10912
  *
10796
10913
  * @example
10797
10914
  * data comment
@@ -10799,7 +10916,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10799
10916
  caption?: string;
10800
10917
  /**
10801
10918
  * @remarks
10802
- * The unique identifier of the column.
10919
+ * The unique identifier of the field.
10803
10920
  *
10804
10921
  * @example
10805
10922
  * odps.engine_name.table_name.1
@@ -10807,7 +10924,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10807
10924
  columnGuid?: string;
10808
10925
  /**
10809
10926
  * @remarks
10810
- * The name of the column.
10927
+ * The name of the field.
10811
10928
  *
10812
10929
  * @example
10813
10930
  * 1
@@ -10815,7 +10932,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10815
10932
  columnName?: string;
10816
10933
  /**
10817
10934
  * @remarks
10818
- * The type of the column.
10935
+ * The data type of the field.
10819
10936
  *
10820
10937
  * @example
10821
10938
  * string
@@ -10823,7 +10940,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10823
10940
  columnType?: string;
10824
10941
  /**
10825
10942
  * @remarks
10826
- * The comment for the column.
10943
+ * The remarks of the field.
10827
10944
  *
10828
10945
  * @example
10829
10946
  * comment
@@ -10831,9 +10948,10 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10831
10948
  comment?: string;
10832
10949
  /**
10833
10950
  * @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.
10951
+ * Indicates whether the field is a foreign key. Valid values:
10952
+ *
10953
+ * * true
10954
+ * * false
10837
10955
  *
10838
10956
  * @example
10839
10957
  * true
@@ -10841,9 +10959,10 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10841
10959
  isForeignKey?: boolean;
10842
10960
  /**
10843
10961
  * @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.
10962
+ * Indicates whether the field is a partition field. Valid values:
10963
+ *
10964
+ * * true
10965
+ * * false
10847
10966
  *
10848
10967
  * @example
10849
10968
  * true
@@ -10851,9 +10970,10 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10851
10970
  isPartitionColumn?: boolean;
10852
10971
  /**
10853
10972
  * @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.
10973
+ * Indicates whether the field is a primary key. Valid values:
10974
+ *
10975
+ * * true
10976
+ * * false
10857
10977
  *
10858
10978
  * @example
10859
10979
  * false
@@ -10861,7 +10981,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10861
10981
  isPrimaryKey?: boolean;
10862
10982
  /**
10863
10983
  * @remarks
10864
- * The position of the column in the order.
10984
+ * The sequence number of the field.
10865
10985
  *
10866
10986
  * @example
10867
10987
  * 1
@@ -10881,7 +11001,7 @@ export declare class GetMetaTableFullInfoResponseBodyDataColumnList extends $dar
10881
11001
  export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10882
11002
  /**
10883
11003
  * @remarks
10884
- * The ID of the EMR cluster.
11004
+ * The EMR cluster ID.
10885
11005
  *
10886
11006
  * @example
10887
11007
  * C-010A704DA760****
@@ -10889,12 +11009,12 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10889
11009
  clusterId?: string;
10890
11010
  /**
10891
11011
  * @remarks
10892
- * A list of columns.
11012
+ * The fields in the table.
10893
11013
  */
10894
11014
  columnList?: GetMetaTableFullInfoResponseBodyDataColumnList[];
10895
11015
  /**
10896
11016
  * @remarks
10897
- * The comment of the table.
11017
+ * The comment on the table.
10898
11018
  *
10899
11019
  * @example
10900
11020
  * comment
@@ -10902,7 +11022,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10902
11022
  comment?: string;
10903
11023
  /**
10904
11024
  * @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.
11025
+ * 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
11026
  *
10907
11027
  * @example
10908
11028
  * 1589870293000
@@ -10910,7 +11030,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10910
11030
  createTime?: number;
10911
11031
  /**
10912
11032
  * @remarks
10913
- * The storage space occupied by the table, in bytes (B).
11033
+ * The size of the storage space that is consumed by the table. Unit: bytes.
10914
11034
  *
10915
11035
  * @example
10916
11036
  * 10
@@ -10926,9 +11046,10 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10926
11046
  databaseName?: string;
10927
11047
  /**
10928
11048
  * @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.
11049
+ * The type of the environment. Valid values:
11050
+ *
11051
+ * * 0: indicates that the table resides in the development environment.
11052
+ * * 1: indicates that the table resides in the production environment.
10932
11053
  *
10933
11054
  * @example
10934
11055
  * 1
@@ -10936,11 +11057,12 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10936
11057
  envType?: number;
10937
11058
  /**
10938
11059
  * @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.
11060
+ * The scope in which the table is visible. Valid values:
11061
+ *
11062
+ * * 0: indicates that the table is visible to workspace members.
11063
+ * * 1: indicates that the table is visible to users within a tenant.
11064
+ * * 2: indicates that the table is visible to all tenants.
11065
+ * * 3: indicates that the table is visible only to the table owner.
10944
11066
  *
10945
11067
  * @example
10946
11068
  * 1
@@ -10948,7 +11070,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10948
11070
  isVisible?: number;
10949
11071
  /**
10950
11072
  * @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.
11073
+ * 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
11074
  *
10953
11075
  * @example
10954
11076
  * 1589870294000
@@ -10956,7 +11078,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10956
11078
  lastAccessTime?: number;
10957
11079
  /**
10958
11080
  * @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.
11081
+ * 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
11082
  *
10961
11083
  * @example
10962
11084
  * 1589870294000
@@ -10964,7 +11086,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10964
11086
  lastDdlTime?: number;
10965
11087
  /**
10966
11088
  * @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.
11089
+ * 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
11090
  *
10969
11091
  * @example
10970
11092
  * 1589870294000
@@ -10972,7 +11094,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10972
11094
  lastModifyTime?: number;
10973
11095
  /**
10974
11096
  * @remarks
10975
- * The lifecycle of the table, in days.
11097
+ * The lifecycle of the table. Unit: days.
10976
11098
  *
10977
11099
  * @example
10978
11100
  * 5
@@ -10980,7 +11102,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10980
11102
  lifeCycle?: number;
10981
11103
  /**
10982
11104
  * @remarks
10983
- * The storage location of the Hive table.
11105
+ * The storage path of the Hive table.
10984
11106
  *
10985
11107
  * @example
10986
11108
  * hdfs://localhost:777/user/hadoop/test.txt
@@ -10996,7 +11118,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
10996
11118
  ownerId?: string;
10997
11119
  /**
10998
11120
  * @remarks
10999
- * Partition keys.
11121
+ * The partition key column.
11000
11122
  *
11001
11123
  * @example
11002
11124
  * abc
@@ -11004,7 +11126,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
11004
11126
  partitionKeys?: string;
11005
11127
  /**
11006
11128
  * @remarks
11007
- * The ID of the workspace where the table is located.
11129
+ * The ID of the workspace to which the table belongs.
11008
11130
  *
11009
11131
  * @example
11010
11132
  * 22
@@ -11012,12 +11134,19 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
11012
11134
  projectId?: number;
11013
11135
  /**
11014
11136
  * @remarks
11015
- * The name of the workspace where the table is located.
11137
+ * The name of the workspace to which the table belongs.
11016
11138
  *
11017
11139
  * @example
11018
11140
  * test
11019
11141
  */
11020
11142
  projectName?: string;
11143
+ /**
11144
+ * @remarks
11145
+ * The schema information of the table.
11146
+ *
11147
+ * @example
11148
+ * default
11149
+ */
11021
11150
  schema?: string;
11022
11151
  /**
11023
11152
  * @remarks
@@ -11045,7 +11174,7 @@ export declare class GetMetaTableFullInfoResponseBodyData extends $dara.Model {
11045
11174
  tenantId?: number;
11046
11175
  /**
11047
11176
  * @remarks
11048
- * The total number of columns.
11177
+ * The total number of fields.
11049
11178
  *
11050
11179
  * @example
11051
11180
  * 22
@@ -11812,6 +11941,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11812
11941
  * odps_first_dev
11813
11942
  */
11814
11943
  connection?: string;
11944
+ /**
11945
+ * @remarks
11946
+ * The creation time.
11947
+ *
11948
+ * @example
11949
+ * 1727280000000
11950
+ */
11815
11951
  createTime?: number;
11816
11952
  /**
11817
11953
  * @remarks
@@ -11821,6 +11957,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11821
11957
  * 00 00 00 * * ?
11822
11958
  */
11823
11959
  cronExpress?: string;
11960
+ /**
11961
+ * @remarks
11962
+ * The deployment date.
11963
+ *
11964
+ * @example
11965
+ * 1727280000000
11966
+ */
11824
11967
  deployDate?: number;
11825
11968
  /**
11826
11969
  * @remarks
@@ -11846,9 +11989,37 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11846
11989
  * 1
11847
11990
  */
11848
11991
  dqcType?: number;
11992
+ /**
11993
+ * @remarks
11994
+ * The ID of the file.
11995
+ *
11996
+ * @example
11997
+ * 123
11998
+ */
11849
11999
  fileId?: number;
12000
+ /**
12001
+ * @remarks
12002
+ * The file type. Different file types have different codes. For more information, see [DataWorks node collection](https://help.aliyun.com/document_detail/600169.html).
12003
+ *
12004
+ * @example
12005
+ * 10
12006
+ */
11850
12007
  fileType?: number;
12008
+ /**
12009
+ * @remarks
12010
+ * The version of the file.
12011
+ *
12012
+ * @example
12013
+ * 1
12014
+ */
11851
12015
  fileVersion?: number;
12016
+ /**
12017
+ * @remarks
12018
+ * The modification time.
12019
+ *
12020
+ * @example
12021
+ * 1727280000000
12022
+ */
11852
12023
  modifyTime?: number;
11853
12024
  /**
11854
12025
  * @remarks
@@ -11927,6 +12098,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11927
12098
  * 60
11928
12099
  */
11929
12100
  repeatInterval?: number;
12101
+ /**
12102
+ * @remarks
12103
+ * 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.
12104
+ *
12105
+ * @example
12106
+ * 1
12107
+ */
11930
12108
  repeatMode?: number;
11931
12109
  /**
11932
12110
  * @remarks
@@ -11936,6 +12114,13 @@ export declare class GetNodeResponseBodyData extends $dara.Model {
11936
12114
  * true
11937
12115
  */
11938
12116
  repeatability?: string;
12117
+ /**
12118
+ * @remarks
12119
+ * The unique identifier of the resource group.
12120
+ *
12121
+ * @example
12122
+ * group_123
12123
+ */
11939
12124
  resGroupIdentifier?: string;
11940
12125
  /**
11941
12126
  * @remarks
@@ -12351,9 +12536,13 @@ export declare class GetPermissionApplyOrderDetailResponseBodyApplyOrderDetailAp
12351
12536
  });
12352
12537
  }
12353
12538
  export declare class GetPermissionApplyOrderDetailResponseBodyApplyOrderDetailApproveContentProjectMetaObjectMetaListColumnMetaList extends $dara.Model {
12539
+ columnActions?: string[];
12354
12540
  /**
12355
12541
  * @remarks
12356
12542
  * The description of the column on which you request permissions.
12543
+ *
12544
+ * @example
12545
+ * Field description
12357
12546
  */
12358
12547
  columnComment?: string;
12359
12548
  /**
@@ -12384,6 +12573,7 @@ export declare class GetPermissionApplyOrderDetailResponseBodyApplyOrderDetailAp
12384
12573
  });
12385
12574
  }
12386
12575
  export declare class GetPermissionApplyOrderDetailResponseBodyApplyOrderDetailApproveContentProjectMetaObjectMetaList extends $dara.Model {
12576
+ actions?: string[];
12387
12577
  /**
12388
12578
  * @remarks
12389
12579
  * The information about the column fields in the object on which you request permissions.
@@ -13289,38 +13479,78 @@ export declare class GetQualityEntityResponseBodyData extends $dara.Model {
13289
13479
  }
13290
13480
  export declare class GetQualityFollowerResponseBodyData extends $dara.Model {
13291
13481
  /**
13482
+ * @remarks
13483
+ * The alert mode. The value is as follows:
13484
+ *
13485
+ * - 1 (Mail)
13486
+ * - 2 (email and SMS)
13487
+ * - 4 (DingTalk groups of robots or hook)
13488
+ * - 5 (DingTalk groups of robots @ ALL)
13489
+ *
13292
13490
  * @example
13293
13491
  * 1
13294
13492
  */
13295
13493
  alarmMode?: number;
13494
+ /**
13495
+ * @remarks
13496
+ * The time when the data quality rule subscription configuration was created.
13497
+ *
13498
+ * @example
13499
+ * 1541576644000
13500
+ */
13296
13501
  createTime?: number;
13297
13502
  /**
13503
+ * @remarks
13504
+ * The ID of the partition expression.
13505
+ *
13298
13506
  * @example
13299
13507
  * 1234
13300
13508
  */
13301
13509
  entityId?: string;
13302
13510
  /**
13511
+ * @remarks
13512
+ * The subscriber to receive alert information.
13513
+ *
13303
13514
  * @example
13304
13515
  * 1234
13305
13516
  */
13306
13517
  follower?: string;
13307
13518
  /**
13519
+ * @remarks
13520
+ * The Alibaba Cloud account name of the subscriber.
13521
+ *
13308
13522
  * @example
13309
13523
  * test
13310
13524
  */
13311
13525
  followerAccountName?: string;
13312
13526
  /**
13527
+ * @remarks
13528
+ * The ID of the subscription relationship.
13529
+ *
13313
13530
  * @example
13314
13531
  * 123
13315
13532
  */
13316
13533
  id?: number;
13534
+ /**
13535
+ * @remarks
13536
+ * The update time of the data quality rule subscription configuration.
13537
+ *
13538
+ * @example
13539
+ * 1541576644000
13540
+ */
13317
13541
  modifyTime?: number;
13318
13542
  /**
13543
+ * @remarks
13544
+ * The name of the engine or data source.
13545
+ *
13319
13546
  * @example
13320
13547
  * autotest
13321
13548
  */
13322
13549
  projectName?: string;
13323
13550
  /**
13551
+ * @remarks
13552
+ * The name of the partitioned table.
13553
+ *
13324
13554
  * @example
13325
13555
  * dual
13326
13556
  */
@@ -13367,6 +13597,9 @@ export declare class GetQualityRuleResponseBodyData extends $dara.Model {
13367
13597
  /**
13368
13598
  * @remarks
13369
13599
  * The description of the monitoring rule.
13600
+ *
13601
+ * @example
13602
+ * Verify that the primary key is unique
13370
13603
  */
13371
13604
  comment?: string;
13372
13605
  /**
@@ -13479,6 +13712,9 @@ export declare class GetQualityRuleResponseBodyData extends $dara.Model {
13479
13712
  /**
13480
13713
  * @remarks
13481
13714
  * The name of the monitoring rule.
13715
+ *
13716
+ * @example
13717
+ * View table fluctuations
13482
13718
  */
13483
13719
  ruleName?: string;
13484
13720
  /**
@@ -13489,6 +13725,13 @@ export declare class GetQualityRuleResponseBodyData extends $dara.Model {
13489
13725
  * 0
13490
13726
  */
13491
13727
  ruleType?: number;
13728
+ /**
13729
+ * @remarks
13730
+ * The variable settings inserted before the custom rule. Format: x=a,y=b.
13731
+ *
13732
+ * @example
13733
+ * x=a,y=b
13734
+ */
13492
13735
  taskSetting?: string;
13493
13736
  /**
13494
13737
  * @remarks
@@ -13553,6 +13796,9 @@ export declare class GetRemindResponseBodyDataBaselines extends $dara.Model {
13553
13796
  /**
13554
13797
  * @remarks
13555
13798
  * The name of the baseline.
13799
+ *
13800
+ * @example
13801
+ * Baseline name
13556
13802
  */
13557
13803
  baselineName?: string;
13558
13804
  static names(): {
@@ -13578,6 +13824,9 @@ export declare class GetRemindResponseBodyDataBizProcesses extends $dara.Model {
13578
13824
  /**
13579
13825
  * @remarks
13580
13826
  * The name of the workflow.
13827
+ *
13828
+ * @example
13829
+ * Business process name
13581
13830
  */
13582
13831
  bizProcessName?: string;
13583
13832
  static names(): {
@@ -13603,6 +13852,9 @@ export declare class GetRemindResponseBodyDataNodes extends $dara.Model {
13603
13852
  /**
13604
13853
  * @remarks
13605
13854
  * The name of the node.
13855
+ *
13856
+ * @example
13857
+ * Node name
13606
13858
  */
13607
13859
  nodeName?: string;
13608
13860
  /**
@@ -13653,8 +13905,19 @@ export declare class GetRemindResponseBodyDataProjects extends $dara.Model {
13653
13905
  });
13654
13906
  }
13655
13907
  export declare class GetRemindResponseBodyDataReceivers extends $dara.Model {
13908
+ /**
13909
+ * @remarks
13910
+ * The alert recipient.
13911
+ */
13656
13912
  alertTargets?: string[];
13657
13913
  /**
13914
+ * @remarks
13915
+ * The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values:
13916
+ *
13917
+ * * OWNER: indicate the task owner.
13918
+ * * OTHER: indicates specified personnel.
13919
+ * * SHIFT_SCHEDULE: indicates personnel in a shift schedule.
13920
+ *
13658
13921
  * @example
13659
13922
  * OWNER
13660
13923
  */
@@ -13709,22 +13972,30 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13709
13972
  alertInterval?: number;
13710
13973
  /**
13711
13974
  * @remarks
13712
- * The alert notification method.
13975
+ * The notification method.
13713
13976
  */
13714
13977
  alertMethods?: string[];
13715
13978
  /**
13716
13979
  * @remarks
13717
- * The description of the alert recipient.
13980
+ * The description of the alert recipient. For more information about alert recipients, see the Receivers parameter.
13718
13981
  */
13719
13982
  alertTargets?: string[];
13720
13983
  /**
13721
13984
  * @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.
13985
+ * The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values:
13986
+ *
13987
+ * * OWNER: the task owner
13988
+ * * OTHER: specified personnel
13989
+ * * SHIFT_SCHEDULE: personnel in a shift schedule
13723
13990
  *
13724
13991
  * @example
13725
13992
  * OWNER
13726
13993
  */
13727
13994
  alertUnit?: string;
13995
+ /**
13996
+ * @remarks
13997
+ * The IDs of the nodes that are added to a whitelist.
13998
+ */
13728
13999
  allowNodes?: number[];
13729
14000
  /**
13730
14001
  * @remarks
@@ -13790,6 +14061,10 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13790
14061
  * The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.
13791
14062
  */
13792
14063
  projects?: GetRemindResponseBodyDataProjects[];
14064
+ /**
14065
+ * @remarks
14066
+ * The information about the alert recipients.
14067
+ */
13793
14068
  receivers?: GetRemindResponseBodyDataReceivers[];
13794
14069
  /**
13795
14070
  * @remarks
@@ -13802,6 +14077,9 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13802
14077
  /**
13803
14078
  * @remarks
13804
14079
  * The name of the rule.
14080
+ *
14081
+ * @example
14082
+ * Rule name
13805
14083
  */
13806
14084
  remindName?: string;
13807
14085
  /**
@@ -13835,7 +14113,7 @@ export declare class GetRemindResponseBodyData extends $dara.Model {
13835
14113
  useflag?: boolean;
13836
14114
  /**
13837
14115
  * @remarks
13838
- * The information about the webhook URL.
14116
+ * WebHook URL
13839
14117
  */
13840
14118
  webhooks?: string[];
13841
14119
  static names(): {
@@ -14012,6 +14290,9 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14012
14290
  /**
14013
14291
  * @remarks
14014
14292
  * The name of the baseline to which the worst baseline instance belongs.
14293
+ *
14294
+ * @example
14295
+ * Baseline name
14015
14296
  */
14016
14297
  baselineName?: string;
14017
14298
  /**
@@ -14089,6 +14370,9 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14089
14370
  /**
14090
14371
  * @remarks
14091
14372
  * The name of the node that triggered the event.
14373
+ *
14374
+ * @example
14375
+ * Node name
14092
14376
  */
14093
14377
  nodeName?: string;
14094
14378
  /**
@@ -14118,6 +14402,9 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14118
14402
  /**
14119
14403
  * @remarks
14120
14404
  * The name of the event.
14405
+ *
14406
+ * @example
14407
+ * 1234 error
14121
14408
  */
14122
14409
  topicName?: string;
14123
14410
  /**
@@ -14150,44 +14437,72 @@ export declare class GetTopicResponseBodyData extends $dara.Model {
14150
14437
  export declare class GetTopicInfluenceResponseBodyDataInfluences extends $dara.Model {
14151
14438
  /**
14152
14439
  * @remarks
14153
- * The baseline ID.
14440
+ * The ID of the baseline.
14154
14441
  *
14155
14442
  * @example
14156
- * 1234
14443
+ * 12345
14157
14444
  */
14158
14445
  baselineId?: number;
14446
+ /**
14447
+ * @remarks
14448
+ * The name of the baseline.
14449
+ *
14450
+ * @example
14451
+ * Baseline name
14452
+ */
14159
14453
  baselineName?: string;
14160
14454
  /**
14455
+ * @remarks
14456
+ * The data timestamp of the baseline instance.
14457
+ *
14161
14458
  * @example
14162
14459
  * 1553356800000
14163
14460
  */
14164
14461
  bizdate?: number;
14165
14462
  /**
14463
+ * @remarks
14464
+ * The margin of the baseline instance. Unit: seconds.
14465
+ *
14166
14466
  * @example
14167
14467
  * 360
14168
14468
  */
14169
14469
  buffer?: number;
14170
14470
  /**
14471
+ * @remarks
14472
+ * 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.
14473
+ *
14171
14474
  * @example
14172
14475
  * 1
14173
14476
  */
14174
14477
  inGroupId?: number;
14175
14478
  /**
14479
+ * @remarks
14480
+ * The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).
14481
+ *
14176
14482
  * @example
14177
14483
  * 952795****
14178
14484
  */
14179
14485
  owner?: string;
14180
14486
  /**
14487
+ * @remarks
14488
+ * The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.
14489
+ *
14181
14490
  * @example
14182
14491
  * 1
14183
14492
  */
14184
14493
  priority?: number;
14185
14494
  /**
14495
+ * @remarks
14496
+ * The ID of the workspace to which the baseline belongs.
14497
+ *
14186
14498
  * @example
14187
14499
  * 1234
14188
14500
  */
14189
14501
  projectId?: number;
14190
14502
  /**
14503
+ * @remarks
14504
+ * 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.
14505
+ *
14191
14506
  * @example
14192
14507
  * SAFE
14193
14508
  */
@@ -14210,6 +14525,9 @@ export declare class GetTopicInfluenceResponseBodyData extends $dara.Model {
14210
14525
  */
14211
14526
  influences?: GetTopicInfluenceResponseBodyDataInfluences[];
14212
14527
  /**
14528
+ * @remarks
14529
+ * The ID of the event.
14530
+ *
14213
14531
  * @example
14214
14532
  * 1234
14215
14533
  */
@@ -14276,6 +14594,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesInstances ext
14276
14594
  /**
14277
14595
  * @remarks
14278
14596
  * The name of the node.
14597
+ *
14598
+ * @example
14599
+ * Node name
14279
14600
  */
14280
14601
  nodeName?: string;
14281
14602
  /**
@@ -14317,6 +14638,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesNodes extends
14317
14638
  /**
14318
14639
  * @remarks
14319
14640
  * The name of the node.
14641
+ *
14642
+ * @example
14643
+ * Node name
14320
14644
  */
14321
14645
  nodeName?: string;
14322
14646
  /**
@@ -14358,6 +14682,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesSlaAlert exte
14358
14682
  /**
14359
14683
  * @remarks
14360
14684
  * The name of the baseline.
14685
+ *
14686
+ * @example
14687
+ * Baseline name
14361
14688
  */
14362
14689
  baselineName?: string;
14363
14690
  /**
@@ -14439,6 +14766,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessagesTopics extend
14439
14766
  /**
14440
14767
  * @remarks
14441
14768
  * The name of the event.
14769
+ *
14770
+ * @example
14771
+ * 9527 error
14442
14772
  */
14443
14773
  topicName?: string;
14444
14774
  /**
@@ -14512,6 +14842,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessages extends $dar
14512
14842
  /**
14513
14843
  * @remarks
14514
14844
  * The content of the alert.
14845
+ *
14846
+ * @example
14847
+ * Node error
14515
14848
  */
14516
14849
  content?: string;
14517
14850
  /**
@@ -14538,6 +14871,9 @@ export declare class ListAlertMessagesResponseBodyDataAlertMessages extends $dar
14538
14871
  /**
14539
14872
  * @remarks
14540
14873
  * The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.
14874
+ *
14875
+ * @example
14876
+ * Custom monitoring rule name
14541
14877
  */
14542
14878
  remindName?: string;
14543
14879
  /**
@@ -14622,6 +14958,9 @@ export declare class ListBaselineConfigsResponseBodyDataBaselines extends $dara.
14622
14958
  /**
14623
14959
  * @remarks
14624
14960
  * The name of the baseline.
14961
+ *
14962
+ * @example
14963
+ * Baseline name
14625
14964
  */
14626
14965
  baselineName?: string;
14627
14966
  /**
@@ -14789,6 +15128,14 @@ export declare class ListBaselineStatusesResponseBodyDataBaselineStatuses extend
14789
15128
  * Baseline name
14790
15129
  */
14791
15130
  baselineName?: string;
15131
+ /**
15132
+ * @remarks
15133
+ * The type of the baseline, including DAILY and HOURLY. Separate multiple types with commas (,).
15134
+ *
15135
+ * @example
15136
+ * DAILY,HOURLY
15137
+ */
15138
+ baselineType?: string;
14792
15139
  /**
14793
15140
  * @remarks
14794
15141
  * The data timestamp.
@@ -15475,46 +15822,76 @@ export declare class ListCalcEnginesResponseBodyData extends $dara.Model {
15475
15822
  }
15476
15823
  export declare class ListCheckProcessesResponseBodyPagingInfoCheckProcesses extends $dara.Model {
15477
15824
  /**
15825
+ * @remarks
15826
+ * Extension point event encoding.
15827
+ *
15478
15828
  * @example
15479
15829
  * commit-file
15480
15830
  */
15481
15831
  eventCode?: string;
15482
15832
  /**
15833
+ * @remarks
15834
+ * The name of the extension point event.
15835
+ *
15483
15836
  * @example
15484
15837
  * DnsEvent
15485
15838
  */
15486
15839
  eventName?: string;
15487
15840
  /**
15841
+ * @remarks
15842
+ * The English name of the event.
15843
+ *
15488
15844
  * @example
15489
15845
  * Pre-event for Node Commit
15490
15846
  */
15491
15847
  eventNameEn?: string;
15492
15848
  /**
15849
+ * @remarks
15850
+ * 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.
15851
+ *
15493
15852
  * @example
15494
15853
  * b824a5de-4223-4315-af3e-c4449d236db4
15495
15854
  */
15496
15855
  messageId?: string;
15497
15856
  /**
15857
+ * @remarks
15858
+ * The operator ID.
15859
+ *
15498
15860
  * @example
15499
15861
  * 297635
15500
15862
  */
15501
15863
  operator?: string;
15502
15864
  /**
15865
+ * @remarks
15866
+ * The ID of the process instance.
15867
+ *
15503
15868
  * @example
15504
15869
  * rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203
15505
15870
  */
15506
15871
  processId?: string;
15507
15872
  /**
15873
+ * @remarks
15874
+ * The name of the check object, such as the file name or node name.
15875
+ *
15508
15876
  * @example
15509
15877
  * odps_sql_test
15510
15878
  */
15511
15879
  processName?: string;
15512
15880
  /**
15881
+ * @remarks
15882
+ * The ID of the DataWorks workspace.
15883
+ *
15513
15884
  * @example
15514
15885
  * 32563
15515
15886
  */
15516
15887
  projectId?: number;
15517
15888
  /**
15889
+ * @remarks
15890
+ * The status of the extender check.
15891
+ * - CHECKING CHECKING
15892
+ * - PASSED the pass check
15893
+ * - BLOCKED check failed
15894
+ *
15518
15895
  * @example
15519
15896
  * CHECKING
15520
15897
  */
@@ -15531,18 +15908,31 @@ export declare class ListCheckProcessesResponseBodyPagingInfoCheckProcesses exte
15531
15908
  });
15532
15909
  }
15533
15910
  export declare class ListCheckProcessesResponseBodyPagingInfo extends $dara.Model {
15911
+ /**
15912
+ * @remarks
15913
+ * The check details of the extension.
15914
+ */
15534
15915
  checkProcesses?: ListCheckProcessesResponseBodyPagingInfoCheckProcesses[];
15535
15916
  /**
15917
+ * @remarks
15918
+ * The page number.
15919
+ *
15536
15920
  * @example
15537
15921
  * 1
15538
15922
  */
15539
15923
  pageNumber?: number;
15540
15924
  /**
15925
+ * @remarks
15926
+ * The number of entries displayed on each page.
15927
+ *
15541
15928
  * @example
15542
15929
  * 10
15543
15930
  */
15544
15931
  pageSize?: number;
15545
15932
  /**
15933
+ * @remarks
15934
+ * The total number of entries returned.
15935
+ *
15546
15936
  * @example
15547
15937
  * 12
15548
15938
  */
@@ -16150,6 +16540,9 @@ export declare class ListDIAlarmRulesResponseBodyDIAlarmRulePagingDIJobAlarmRule
16150
16540
  /**
16151
16541
  * @remarks
16152
16542
  * The description of the alert rule.
16543
+ *
16544
+ * @example
16545
+ * mysql synchronizes to hologres heartbeat alert
16153
16546
  */
16154
16547
  description?: string;
16155
16548
  /**
@@ -17488,6 +17881,9 @@ export declare class ListDataServiceApisResponseBodyDataApis extends $dara.Model
17488
17881
  /**
17489
17882
  * @remarks
17490
17883
  * The name of the API.
17884
+ *
17885
+ * @example
17886
+ * My API name
17491
17887
  */
17492
17888
  apiName?: string;
17493
17889
  /**
@@ -17517,6 +17913,9 @@ export declare class ListDataServiceApisResponseBodyDataApis extends $dara.Model
17517
17913
  /**
17518
17914
  * @remarks
17519
17915
  * The description of the API.
17916
+ *
17917
+ * @example
17918
+ * Test API description
17520
17919
  */
17521
17920
  description?: string;
17522
17921
  /**
@@ -18941,6 +19340,9 @@ export declare class ListDataServicePublishedApisResponseBodyDataApis extends $d
18941
19340
  /**
18942
19341
  * @remarks
18943
19342
  * The name of the API.
19343
+ *
19344
+ * @example
19345
+ * My API name
18944
19346
  */
18945
19347
  apiName?: string;
18946
19348
  /**
@@ -18970,6 +19372,9 @@ export declare class ListDataServicePublishedApisResponseBodyDataApis extends $d
18970
19372
  /**
18971
19373
  * @remarks
18972
19374
  * The description.
19375
+ *
19376
+ * @example
19377
+ * Test API description
18973
19378
  */
18974
19379
  description?: string;
18975
19380
  /**
@@ -19163,7 +19568,7 @@ export declare class ListDataSourcesResponseBodyDataDataSources extends $dara.Mo
19163
19568
  * "authType": "2"
19164
19569
  * }
19165
19570
  *
19166
- * * MySQL
19571
+ * * mysql
19167
19572
  *
19168
19573
  * {
19169
19574
  * "configType": "1",
@@ -19175,7 +19580,7 @@ export declare class ListDataSourcesResponseBodyDataDataSources extends $dara.Mo
19175
19580
  * "username": "mysql_db111"
19176
19581
  * }
19177
19582
  *
19178
- * * ApsaraDB RDS for SQL Server
19583
+ * * sqlserver
19179
19584
  *
19180
19585
  * {
19181
19586
  * "configType": "1",
@@ -19185,18 +19590,18 @@ export declare class ListDataSourcesResponseBodyDataDataSources extends $dara.Mo
19185
19590
  * "username": "sqlserver_db111"
19186
19591
  * }
19187
19592
  *
19188
- * * Object Storage Service (OSS)
19593
+ * * oss
19189
19594
  *
19190
19595
  * {
19191
- * "accessId": "LTAINbR9Uxxxx",
19192
- * "accessKey": "***",
19596
+ * "accessId": "***********",
19597
+ * "accessKey": "***********",
19193
19598
  * "bucket": "bigxxx1223",
19194
19599
  * "configType": "1",
19195
19600
  * "endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
19196
19601
  * "tag": "public"
19197
19602
  * }
19198
19603
  *
19199
- * * ApsaraDB RDS for PostgreSQL
19604
+ * * postgresql
19200
19605
  *
19201
19606
  * {
19202
19607
  * "configType": "1",
@@ -19208,7 +19613,7 @@ export declare class ListDataSourcesResponseBodyDataDataSources extends $dara.Mo
19208
19613
  * "username": "cdp_xxx"
19209
19614
  * }
19210
19615
  *
19211
- * * AnalyticDB for MySQL
19616
+ * * ads
19212
19617
  *
19213
19618
  * {
19214
19619
  * "configType": "1",
@@ -19557,11 +19962,17 @@ export declare class ListEnabledExtensionsForProjectResponseBodyExtensions exten
19557
19962
  /**
19558
19963
  * @remarks
19559
19964
  * The description of the extension.
19965
+ *
19966
+ * @example
19967
+ * ODPS SQL compatible Spark engine detection
19560
19968
  */
19561
19969
  extensionDesc?: string;
19562
19970
  /**
19563
19971
  * @remarks
19564
19972
  * The name of the extension.
19973
+ *
19974
+ * @example
19975
+ * max_pt function is not allowed.
19565
19976
  */
19566
19977
  extensionName?: string;
19567
19978
  /**
@@ -19644,6 +20055,9 @@ export declare class ListExtensionsResponseBodyPagingInfoExtensionsBindEventList
19644
20055
  /**
19645
20056
  * @remarks
19646
20057
  * The name of the event.
20058
+ *
20059
+ * @example
20060
+ * File submission pre-event
19647
20061
  */
19648
20062
  eventName?: string;
19649
20063
  static names(): {
@@ -19666,16 +20080,25 @@ export declare class ListExtensionsResponseBodyPagingInfoExtensions extends $dar
19666
20080
  /**
19667
20081
  * @remarks
19668
20082
  * The unique code of the extension.
20083
+ *
20084
+ * @example
20085
+ * Extension Code
19669
20086
  */
19670
20087
  extensionCode?: string;
19671
20088
  /**
19672
20089
  * @remarks
19673
20090
  * The description of the extension.
20091
+ *
20092
+ * @example
20093
+ * This is a description
19674
20094
  */
19675
20095
  extensionDesc?: string;
19676
20096
  /**
19677
20097
  * @remarks
19678
20098
  * The name of the extension.
20099
+ *
20100
+ * @example
20101
+ * Extension name
19679
20102
  */
19680
20103
  extensionName?: string;
19681
20104
  /**
@@ -19827,6 +20250,9 @@ export declare class ListFileVersionsResponseBodyDataFileVersions extends $dara.
19827
20250
  /**
19828
20251
  * @remarks
19829
20252
  * The description of the file version.
20253
+ *
20254
+ * @example
20255
+ * Second version submission
19830
20256
  */
19831
20257
  comment?: string;
19832
20258
  /**
@@ -19931,7 +20357,7 @@ export declare class ListFileVersionsResponseBodyDataFileVersions extends $dara.
19931
20357
  export declare class ListFileVersionsResponseBodyData extends $dara.Model {
19932
20358
  /**
19933
20359
  * @remarks
19934
- * The details of the file version.
20360
+ * The details of file versions.
19935
20361
  */
19936
20362
  fileVersions?: ListFileVersionsResponseBodyDataFileVersions[];
19937
20363
  /**
@@ -19970,6 +20396,13 @@ export declare class ListFileVersionsResponseBodyData extends $dara.Model {
19970
20396
  });
19971
20397
  }
19972
20398
  export declare class ListFilesResponseBodyDataFiles extends $dara.Model {
20399
+ /**
20400
+ * @remarks
20401
+ * The path of the folder to which the file belongs.
20402
+ *
20403
+ * @example
20404
+ * Business_process/my_first_business_process/MaxCompute/ods_layer
20405
+ */
19973
20406
  absoluteFolderPath?: string;
19974
20407
  /**
19975
20408
  * @remarks
@@ -20217,6 +20650,9 @@ export declare class ListFoldersResponseBodyDataFolders extends $dara.Model {
20217
20650
  /**
20218
20651
  * @remarks
20219
20652
  * The path of the folder.
20653
+ *
20654
+ * @example
20655
+ * Business_process/my_first_business_process/MaxCompute/ods_layer
20220
20656
  */
20221
20657
  folderPath?: string;
20222
20658
  static names(): {
@@ -20403,6 +20839,9 @@ export declare class ListInnerNodesResponseBodyPagingNodes extends $dara.Model {
20403
20839
  /**
20404
20840
  * @remarks
20405
20841
  * The name of the resource group.
20842
+ *
20843
+ * @example
20844
+ * Default Resource Group
20406
20845
  */
20407
20846
  resGroupName?: string;
20408
20847
  /**
@@ -20996,7 +21435,8 @@ export declare class ListLineageResponseBodyDataDataEntityListRelationList exten
20996
21435
  * @remarks
20997
21436
  * The data channel. Valid values:
20998
21437
  *
20999
- * FIRST_PARTY: DataWorks platformTHIRD_PARTY: user registration
21438
+ * * **FIRST_PARTY: DataWorks platform**
21439
+ * * **THIRD_PARTY: user registration**
21000
21440
  *
21001
21441
  * @example
21002
21442
  * THIRD_PARTY
@@ -21004,7 +21444,7 @@ export declare class ListLineageResponseBodyDataDataEntityListRelationList exten
21004
21444
  channel?: string;
21005
21445
  /**
21006
21446
  * @remarks
21007
- * The name of the data source.
21447
+ * The data source.
21008
21448
  *
21009
21449
  * @example
21010
21450
  * mysql
@@ -21481,6 +21921,9 @@ export declare class ListMigrationsResponseBodyDataMigrations extends $dara.Mode
21481
21921
  /**
21482
21922
  * @remarks
21483
21923
  * The description of the export task.
21924
+ *
21925
+ * @example
21926
+ * Automated Test creation
21484
21927
  */
21485
21928
  description?: string;
21486
21929
  /**
@@ -21744,6 +22187,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21744
22187
  * odps_first
21745
22188
  */
21746
22189
  connection?: string;
22190
+ /**
22191
+ * @remarks
22192
+ * The timestamp when the node was created. Unit: milliseconds.
22193
+ *
22194
+ * @example
22195
+ * 1593879116000
22196
+ */
21747
22197
  createTime?: number;
21748
22198
  /**
21749
22199
  * @remarks
@@ -21753,6 +22203,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21753
22203
  * 00 00 00 * * ?
21754
22204
  */
21755
22205
  cronExpress?: string;
22206
+ /**
22207
+ * @remarks
22208
+ * The timestamp when the node was deployed. Unit: milliseconds.
22209
+ *
22210
+ * @example
22211
+ * 1734537600000
22212
+ */
21756
22213
  deployDate?: number;
21757
22214
  /**
21758
22215
  * @remarks
@@ -21778,9 +22235,38 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21778
22235
  * 1
21779
22236
  */
21780
22237
  dqcType?: number;
22238
+ /**
22239
+ * @remarks
22240
+ * The file ID. You can call the ListFiles operation to query the ID.
22241
+ *
22242
+ * @example
22243
+ * 20
22244
+ */
21781
22245
  fileId?: number;
22246
+ /**
22247
+ * @remarks
22248
+ * Different file types have different codes. For more information, see [DataWorks node collection](https://help.aliyun.com/document_detail/600169.html).
22249
+ * You can also call the [ListFileType](https://help.aliyun.com/document_detail/212428.html) interface to query the code type of the file.
22250
+ *
22251
+ * @example
22252
+ * 10
22253
+ */
21782
22254
  fileType?: number;
22255
+ /**
22256
+ * @remarks
22257
+ * The latest version number of the file.
22258
+ *
22259
+ * @example
22260
+ * 3
22261
+ */
21783
22262
  fileVersion?: number;
22263
+ /**
22264
+ * @remarks
22265
+ * The timestamp when the node was modified. Unit: milliseconds.
22266
+ *
22267
+ * @example
22268
+ * 1593879116000
22269
+ */
21784
22270
  modifyTime?: number;
21785
22271
  /**
21786
22272
  * @remarks
@@ -21854,6 +22340,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21854
22340
  * 60
21855
22341
  */
21856
22342
  repeatInterval?: number;
22343
+ /**
22344
+ * @remarks
22345
+ * 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.
22346
+ *
22347
+ * @example
22348
+ * 1
22349
+ */
21857
22350
  repeatMode?: number;
21858
22351
  /**
21859
22352
  * @remarks
@@ -21863,6 +22356,13 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21863
22356
  * true
21864
22357
  */
21865
22358
  repeatability?: boolean;
22359
+ /**
22360
+ * @remarks
22361
+ * The identifier of the resource group.
22362
+ *
22363
+ * @example
22364
+ * group_123
22365
+ */
21866
22366
  resGroupIdentifier?: string;
21867
22367
  /**
21868
22368
  * @remarks
@@ -21894,12 +22394,7 @@ export declare class ListNodesResponseBodyDataNodes extends $dara.Model {
21894
22394
  export declare class ListNodesResponseBodyData extends $dara.Model {
21895
22395
  /**
21896
22396
  * @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.
22397
+ * The information about the nodes.
21903
22398
  */
21904
22399
  nodes?: ListNodesResponseBodyDataNodes[];
21905
22400
  /**
@@ -21949,6 +22444,9 @@ export declare class ListNodesByBaselineResponseBodyData extends $dara.Model {
21949
22444
  /**
21950
22445
  * @remarks
21951
22446
  * The name of the node.
22447
+ *
22448
+ * @example
22449
+ * Node name
21952
22450
  */
21953
22451
  nodeName?: string;
21954
22452
  /**
@@ -22120,6 +22618,9 @@ export declare class ListNodesByOutputResponseBodyDataNodeList extends $dara.Mod
22120
22618
  /**
22121
22619
  * @remarks
22122
22620
  * The name of the resource group.
22621
+ *
22622
+ * @example
22623
+ * Default Resource Group
22123
22624
  */
22124
22625
  resGroupName?: string;
22125
22626
  /**
@@ -22993,6 +23494,9 @@ export declare class ListQualityResultsByEntityResponseBodyDataRuleChecks extend
22993
23494
  /**
22994
23495
  * @remarks
22995
23496
  * The description of the monitoring rule.
23497
+ *
23498
+ * @example
23499
+ * The description of the rule.
22996
23500
  */
22997
23501
  comment?: string;
22998
23502
  /**
@@ -23164,6 +23668,9 @@ export declare class ListQualityResultsByEntityResponseBodyDataRuleChecks extend
23164
23668
  /**
23165
23669
  * @remarks
23166
23670
  * The name of the monitoring rule.
23671
+ *
23672
+ * @example
23673
+ * The name of the rule.
23167
23674
  */
23168
23675
  ruleName?: string;
23169
23676
  /**
@@ -23198,6 +23705,9 @@ export declare class ListQualityResultsByEntityResponseBodyDataRuleChecks extend
23198
23705
  /**
23199
23706
  * @remarks
23200
23707
  * The name of the monitoring template.
23708
+ *
23709
+ * @example
23710
+ * Expected value verification
23201
23711
  */
23202
23712
  templateName?: string;
23203
23713
  /**
@@ -23459,6 +23969,9 @@ export declare class ListQualityResultsByRuleResponseBodyDataRuleChecks extends
23459
23969
  /**
23460
23970
  * @remarks
23461
23971
  * The description of the monitoring rule.
23972
+ *
23973
+ * @example
23974
+ * The description of the rule.
23462
23975
  */
23463
23976
  comment?: string;
23464
23977
  /**
@@ -23638,6 +24151,9 @@ export declare class ListQualityResultsByRuleResponseBodyDataRuleChecks extends
23638
24151
  /**
23639
24152
  * @remarks
23640
24153
  * The name of the monitoring rule.
24154
+ *
24155
+ * @example
24156
+ * The name of the rule.
23641
24157
  */
23642
24158
  ruleName?: string;
23643
24159
  /**
@@ -23672,6 +24188,9 @@ export declare class ListQualityResultsByRuleResponseBodyDataRuleChecks extends
23672
24188
  /**
23673
24189
  * @remarks
23674
24190
  * The name of the monitoring template.
24191
+ *
24192
+ * @example
24193
+ * Expected value verification
23675
24194
  */
23676
24195
  templateName?: string;
23677
24196
  /**
@@ -23788,7 +24307,10 @@ export declare class ListQualityRulesResponseBodyDataRules extends $dara.Model {
23788
24307
  checkerId?: number;
23789
24308
  /**
23790
24309
  * @remarks
23791
- * The description of the system defense rule.
24310
+ * The description of the monitoring rule.
24311
+ *
24312
+ * @example
24313
+ * Verify table rules
23792
24314
  */
23793
24315
  comment?: string;
23794
24316
  /**
@@ -23958,6 +24480,9 @@ export declare class ListQualityRulesResponseBodyDataRules extends $dara.Model {
23958
24480
  /**
23959
24481
  * @remarks
23960
24482
  * The name of the monitoring template.
24483
+ *
24484
+ * @example
24485
+ * Number of SQL task table rows, 1, 7, and 30 days wave detection
23961
24486
  */
23962
24487
  templateName?: string;
23963
24488
  /**
@@ -24006,7 +24531,7 @@ export declare class ListQualityRulesResponseBodyData extends $dara.Model {
24006
24531
  pageSize?: number;
24007
24532
  /**
24008
24533
  * @remarks
24009
- * The details of the monitoring rule.
24534
+ * The details of the monitoring rules.
24010
24535
  */
24011
24536
  rules?: ListQualityRulesResponseBodyDataRules[];
24012
24537
  /**
@@ -24509,6 +25034,9 @@ export declare class ListShiftPersonnelsResponseBodyPagingShiftPersons extends $
24509
25034
  /**
24510
25035
  * @remarks
24511
25036
  * The name of the on-duty engineer.
25037
+ *
25038
+ * @example
25039
+ * Zhang San
24512
25040
  */
24513
25041
  shiftPersonName?: string;
24514
25042
  /**
@@ -24549,7 +25077,7 @@ export declare class ListShiftPersonnelsResponseBodyPaging extends $dara.Model {
24549
25077
  pageSize?: number;
24550
25078
  /**
24551
25079
  * @remarks
24552
- * A list of on-duty engineers in a shift schedule.
25080
+ * The on-duty engineers in the shift schedule.
24553
25081
  */
24554
25082
  shiftPersons?: ListShiftPersonnelsResponseBodyPagingShiftPersons[];
24555
25083
  /**
@@ -24583,6 +25111,9 @@ export declare class ListShiftSchedulesResponseBodyPagingShiftSchedules extends
24583
25111
  /**
24584
25112
  * @remarks
24585
25113
  * The name of the shift schedule.
25114
+ *
25115
+ * @example
25116
+ * Duty table name
24586
25117
  */
24587
25118
  shiftScheduleName?: string;
24588
25119
  static names(): {
@@ -24920,31 +25451,49 @@ export declare class ListTableThemeResponseBodyData extends $dara.Model {
24920
25451
  }
24921
25452
  export declare class ListTablesResponseBodyDataTableEntityListEntityContent extends $dara.Model {
24922
25453
  /**
25454
+ * @remarks
25455
+ * The unique identifier of the data source.
25456
+ *
24923
25457
  * @example
24924
25458
  * accountId:cn-shanghai:odps:project
24925
25459
  */
24926
25460
  dataSourceQualifiedName?: string;
24927
25461
  /**
25462
+ * @remarks
25463
+ * The unique ID of the data source identifier.
25464
+ *
24928
25465
  * @example
24929
25466
  * e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg
24930
25467
  */
24931
25468
  dataSourceUniqueId?: string;
24932
25469
  /**
25470
+ * @remarks
25471
+ * The name of the database.
25472
+ *
24933
25473
  * @example
24934
25474
  * database
24935
25475
  */
24936
25476
  databaseName?: string;
24937
25477
  /**
25478
+ * @remarks
25479
+ * The ID of the data source instance.
25480
+ *
24938
25481
  * @example
24939
25482
  * rm-uf6rn0123
24940
25483
  */
24941
25484
  instanceId?: string;
24942
25485
  /**
25486
+ * @remarks
25487
+ * The name of the ODPS project.
25488
+ *
24943
25489
  * @example
24944
25490
  * project
24945
25491
  */
24946
25492
  projectName?: string;
24947
25493
  /**
25494
+ * @remarks
25495
+ * The name of the table.
25496
+ *
24948
25497
  * @example
24949
25498
  * table
24950
25499
  */
@@ -24961,8 +25510,15 @@ export declare class ListTablesResponseBodyDataTableEntityListEntityContent exte
24961
25510
  });
24962
25511
  }
24963
25512
  export declare class ListTablesResponseBodyDataTableEntityList extends $dara.Model {
25513
+ /**
25514
+ * @remarks
25515
+ * The information about the table.
25516
+ */
24964
25517
  entityContent?: ListTablesResponseBodyDataTableEntityListEntityContent;
24965
25518
  /**
25519
+ * @remarks
25520
+ * The unique identifier of the table entity.
25521
+ *
24966
25522
  * @example
24967
25523
  * maxcompute-table.project.table
24968
25524
  */
@@ -24980,12 +25536,22 @@ export declare class ListTablesResponseBodyDataTableEntityList extends $dara.Mod
24980
25536
  }
24981
25537
  export declare class ListTablesResponseBodyData extends $dara.Model {
24982
25538
  /**
25539
+ * @remarks
25540
+ * Pagination information, which specifies the starting point of the next read.
25541
+ *
24983
25542
  * @example
24984
25543
  * AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=
24985
25544
  */
24986
25545
  nextToken?: string;
25546
+ /**
25547
+ * @remarks
25548
+ * An array of entities.
25549
+ */
24987
25550
  tableEntityList?: ListTablesResponseBodyDataTableEntityList[];
24988
25551
  /**
25552
+ * @remarks
25553
+ * The total number.
25554
+ *
24989
25555
  * @example
24990
25556
  * 100
24991
25557
  */
@@ -25689,6 +26255,9 @@ export declare class TestNetworkConnectionResponseBodyTaskList extends $dara.Mod
25689
26255
  /**
25690
26256
  * @remarks
25691
26257
  * 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.
26258
+ *
26259
+ * @example
26260
+ * Connectable
25692
26261
  */
25693
26262
  connectMessage?: string;
25694
26263
  /**
@@ -25749,6 +26318,9 @@ export declare class TopTenElapsedTimeInstanceResponseBodyInstanceConsumeTimeRan
25749
26318
  /**
25750
26319
  * @remarks
25751
26320
  * The name of the node.
26321
+ *
26322
+ * @example
26323
+ * Node name
25752
26324
  */
25753
26325
  nodeName?: string;
25754
26326
  /**
@@ -25823,6 +26395,9 @@ export declare class TopTenErrorTimesInstanceResponseBodyInstanceErrorRankErrorR
25823
26395
  /**
25824
26396
  * @remarks
25825
26397
  * The name of the node.
26398
+ *
26399
+ * @example
26400
+ * Node name
25826
26401
  */
25827
26402
  nodeName?: string;
25828
26403
  /**
@@ -26012,7 +26587,7 @@ export declare class UpdateBaselineRequestAlertSettings extends $dara.Model {
26012
26587
  export declare class UpdateBaselineRequestOvertimeSettings extends $dara.Model {
26013
26588
  /**
26014
26589
  * @remarks
26015
- * The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that does not exceed 24.
26590
+ * The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.
26016
26591
  *
26017
26592
  * @example
26018
26593
  * 1
@@ -26200,6 +26775,9 @@ export declare class UpdateDIJobRequestJobSettingsColumnDataTypeSettings extends
26200
26775
  }
26201
26776
  export declare class UpdateDIJobRequestJobSettingsCycleScheduleSettings extends $dara.Model {
26202
26777
  /**
26778
+ * @remarks
26779
+ * The scheduling parameters.
26780
+ *
26203
26781
  * @example
26204
26782
  * bizdate=$bizdate
26205
26783
  */
@@ -26260,14 +26838,14 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
26260
26838
  * @remarks
26261
26839
  * The name of the configuration item. Valid values:
26262
26840
  *
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.
26841
+ * * 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.
26842
+ * * runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.
26843
+ * * dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.
26844
+ * * runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
26845
+ * * 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.
26846
+ * * runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
26847
+ * * 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.
26848
+ * * runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
26271
26849
  *
26272
26850
  * @example
26273
26851
  * runtime.offline.concurrent
@@ -26294,6 +26872,9 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
26294
26872
  }
26295
26873
  export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
26296
26874
  /**
26875
+ * @remarks
26876
+ * The channel control settings for the synchronization task. The value of this parameter must be a JSON string.
26877
+ *
26297
26878
  * @example
26298
26879
  * {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
26299
26880
  */
@@ -26303,6 +26884,10 @@ export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
26303
26884
  * The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.
26304
26885
  */
26305
26886
  columnDataTypeSettings?: UpdateDIJobRequestJobSettingsColumnDataTypeSettings[];
26887
+ /**
26888
+ * @remarks
26889
+ * The settings for periodic scheduling.
26890
+ */
26306
26891
  cycleScheduleSettings?: UpdateDIJobRequestJobSettingsCycleScheduleSettings;
26307
26892
  /**
26308
26893
  * @remarks
@@ -26377,6 +26962,9 @@ export declare class UpdateDIJobRequestResourceSettings extends $dara.Model {
26377
26962
  */
26378
26963
  realtimeResourceSettings?: UpdateDIJobRequestResourceSettingsRealtimeResourceSettings;
26379
26964
  /**
26965
+ * @remarks
26966
+ * The number of compute units (CUs) in the resource group that are used for full and incremental synchronization.
26967
+ *
26380
26968
  * @example
26381
26969
  * 2.0
26382
26970
  */
@@ -26432,6 +27020,10 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
26432
27020
  * * Rename
26433
27021
  * * AddColumn
26434
27022
  * * HandleDml
27023
+ * * DefineIncrementalCondition
27024
+ * * DefineCycleScheduleSettings
27025
+ * * DefineRuntimeSettings
27026
+ * * DefinePartitionKey
26435
27027
  *
26436
27028
  * @example
26437
27029
  * Rename
@@ -26470,12 +27062,12 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
26470
27062
  export declare class UpdateDIJobRequestTableMappings extends $dara.Model {
26471
27063
  /**
26472
27064
  * @remarks
26473
- * The rule used to select synchronization objects in the source. You can configure multiple rules.
27065
+ * The list of rules that you want to use to select synchronization objects in the source.
26474
27066
  */
26475
27067
  sourceObjectSelectionRules?: UpdateDIJobRequestTableMappingsSourceObjectSelectionRules[];
26476
27068
  /**
26477
27069
  * @remarks
26478
- * The transformation rules that are applied to the selected synchronization objects.
27070
+ * The list of transformation rules that you want to apply to the synchronization objects selected from the source.
26479
27071
  */
26480
27072
  transformationRules?: UpdateDIJobRequestTableMappingsTransformationRules[];
26481
27073
  static names(): {
@@ -26498,6 +27090,10 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
26498
27090
  * * Rename
26499
27091
  * * AddColumn
26500
27092
  * * HandleDml
27093
+ * * DefineIncrementalCondition
27094
+ * * DefineCycleScheduleSettings
27095
+ * * DefineRuntimeSettings
27096
+ * * DefinePartitionKey
26501
27097
  *
26502
27098
  * @example
26503
27099
  * Rename
@@ -26505,17 +27101,17 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
26505
27101
  ruleActionType?: string;
26506
27102
  /**
26507
27103
  * @remarks
26508
- * The expression of the rule. The expression is a JSON string.
27104
+ * The expression of the rule. The expression must be a JSON string.
26509
27105
  *
26510
27106
  * Example of a renaming rule: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":[{"variableName":"srcDatabaseName","variableRules":[{"from":"fromdb","to":"todb"}]}]}.
26511
27107
  *
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"}]}.
27108
+ * 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
27109
  *
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"]}.
27110
+ * 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
27111
  *
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"}]}.
27112
+ * 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
27113
  *
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.
27114
+ * 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
27115
  *
26520
27116
  * @example
26521
27117
  * {"expression":"${srcDatasoureName}_${srcDatabaseName}"}
@@ -28737,10 +29333,10 @@ export declare class CreateBusinessRequest extends $dara.Model {
28737
29333
  projectIdentifier?: string;
28738
29334
  /**
28739
29335
  * @remarks
28740
- * The module to which the business process belongs. Valid values:
29336
+ * The module to which the workflow belongs. Valid values:
28741
29337
  *
28742
- * - NORMAL: The business process is initiated automatically.
28743
- * - MANUAL_BIZ: The business process requires manual initiation.
29338
+ * * NORMAL: The workflow belongs to auto triggered workflows.
29339
+ * * MANUAL_BIZ: The workflow belongs to manually triggered workflows.
28744
29340
  *
28745
29341
  * @example
28746
29342
  * NORMAL
@@ -28760,7 +29356,7 @@ export declare class CreateBusinessRequest extends $dara.Model {
28760
29356
  export declare class CreateBusinessResponseBody extends $dara.Model {
28761
29357
  /**
28762
29358
  * @remarks
28763
- * The ID of the business process.
29359
+ * The workflow ID.
28764
29360
  *
28765
29361
  * @example
28766
29362
  * 100001
@@ -28792,7 +29388,7 @@ export declare class CreateBusinessResponseBody extends $dara.Model {
28792
29388
  httpStatusCode?: number;
28793
29389
  /**
28794
29390
  * @remarks
28795
- * The request ID. You can use the request ID to query logs and troubleshoot issues.
29391
+ * The request ID.
28796
29392
  *
28797
29393
  * @example
28798
29394
  * 0000-ABCD-EFG****
@@ -28800,7 +29396,7 @@ export declare class CreateBusinessResponseBody extends $dara.Model {
28800
29396
  requestId?: string;
28801
29397
  /**
28802
29398
  * @remarks
28803
- * Indicates whether the request is successful.
29399
+ * Indicates whether the request was successful.
28804
29400
  *
28805
29401
  * @example
28806
29402
  * true
@@ -29182,7 +29778,7 @@ export declare class CreateDIAlarmRuleRequest extends $dara.Model {
29182
29778
  DIJobId?: number;
29183
29779
  /**
29184
29780
  * @remarks
29185
- * The description of the alert rule.
29781
+ * The description of the task.
29186
29782
  *
29187
29783
  * @example
29188
29784
  * mysql synchronizes to hologres heartbeat alert
@@ -29248,7 +29844,7 @@ export declare class CreateDIAlarmRuleShrinkRequest extends $dara.Model {
29248
29844
  DIJobId?: number;
29249
29845
  /**
29250
29846
  * @remarks
29251
- * The description of the alert rule.
29847
+ * The description of the task.
29252
29848
  *
29253
29849
  * @example
29254
29850
  * mysql synchronizes to hologres heartbeat alert
@@ -30554,8 +31150,8 @@ export declare class CreateDataSourceRequest extends $dara.Model {
30554
31150
  * * odps
30555
31151
  *
30556
31152
  * {
30557
- * "accessId": "xssssss",
30558
- * "accessKey": "xsaxsaxsa",
31153
+ * "accessId": "*****",
31154
+ * "accessKey": "*****",
30559
31155
  * "authType": 2,
30560
31156
  * "endpoint": "http://service.odps.aliyun.com/api",
30561
31157
  * "project": "xsaxsax",
@@ -30589,8 +31185,8 @@ export declare class CreateDataSourceRequest extends $dara.Model {
30589
31185
  * * oss
30590
31186
  *
30591
31187
  * {
30592
- * "accessId": "sssssxx",
30593
- * "accessKey": "xsaxaxsaxs",
31188
+ * "accessId": "*****",
31189
+ * "accessKey": "*****",
30594
31190
  * "bucket": "xsa-xs-xs",
30595
31191
  * "endpoint": "http://oss-cn-shanghai.aliyuncs.com",
30596
31192
  * "tag": "public"
@@ -30647,11 +31243,11 @@ export declare class CreateDataSourceRequest extends $dara.Model {
30647
31243
  * * emr
30648
31244
  *
30649
31245
  * {
30650
- * "accessId": "xsaxsa",
31246
+ * "accessId": "*****",
30651
31247
  * "emrClusterId": "C-dsads",
30652
31248
  * "emrResourceQueueName": "default",
30653
31249
  * "emrEndpoint": "emr.aliyuncs.com",
30654
- * "accessKey": "dsadsad",
31250
+ * "accessKey": "*****",
30655
31251
  * "emrUserId": "224833315798889783",
30656
31252
  * "name": "sasdsadsa",
30657
31253
  * "emrAccessMode": "simple",
@@ -30694,8 +31290,8 @@ export declare class CreateDataSourceRequest extends $dara.Model {
30694
31290
  * * holo
30695
31291
  *
30696
31292
  * {
30697
- * "accessId": "xsaxsaxs",
30698
- * "accessKey": "xsaxsaxsa",
31293
+ * "accessId": "*****",
31294
+ * "accessKey": "*****",
30699
31295
  * "database": "xsaxsaxsa",
30700
31296
  * "instanceId": "xsaxa",
30701
31297
  * "tag": "aliyun"
@@ -31077,10 +31673,10 @@ export declare class CreateFileRequest extends $dara.Model {
31077
31673
  content?: string;
31078
31674
  /**
31079
31675
  * @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:
31676
+ * Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:
31081
31677
  *
31082
- * - true: If the directory does not exist, the directory is automatically created.
31083
- * - false: If the directory does not exist, the call fails.
31678
+ * * true: The system automatically creates the directory if the directory does not exist.
31679
+ * * false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.
31084
31680
  *
31085
31681
  * @example
31086
31682
  * false
@@ -31200,6 +31796,14 @@ export declare class CreateFileRequest extends $dara.Model {
31200
31796
  * false
31201
31797
  */
31202
31798
  ignoreParentSkipRunningProperty?: boolean;
31799
+ /**
31800
+ * @remarks
31801
+ * Custom image ID
31802
+ *
31803
+ * @example
31804
+ * m-bp1h4b5a8ogkbll2f3tr
31805
+ */
31806
+ imageId?: string;
31203
31807
  /**
31204
31808
  * @remarks
31205
31809
  * 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 +32056,7 @@ export declare class CreateFileResponse extends $dara.Model {
31452
32056
  export declare class CreateFolderRequest extends $dara.Model {
31453
32057
  /**
31454
32058
  * @remarks
31455
- * The HTTP status code returned.
32059
+ * The path of the folder.
31456
32060
  *
31457
32061
  * This parameter is required.
31458
32062
  *
@@ -32297,6 +32901,7 @@ export declare class CreatePermissionApplyOrderRequest extends $dara.Model {
32297
32901
  * I need to use this table
32298
32902
  */
32299
32903
  applyReason?: string;
32904
+ applyType?: string;
32300
32905
  /**
32301
32906
  * @remarks
32302
32907
  * The ID of the Alibaba Cloud account for which you want to request permissions. If you want to request permissions for multiple Alibaba Cloud accounts, separate the IDs of the accounts with commas (,).
@@ -32307,6 +32912,7 @@ export declare class CreatePermissionApplyOrderRequest extends $dara.Model {
32307
32912
  * 267842600408993176,267842600408993177
32308
32913
  */
32309
32914
  applyUserIds?: string;
32915
+ catalogName?: string;
32310
32916
  /**
32311
32917
  * @remarks
32312
32918
  * The expiration time of the permissions that you request. This value is a UNIX timestamp. The default value is January 1, 2065. If LabelSecurity is disabled for the MaxCompute project in which you want to request permissions on the fields of a table, or the security level of the fields is 0 or is lower than or equal to the security level of the Alibaba Cloud account for which you want to request permissions, you can request only permanent permissions. You can go to the Workspace Management page in the DataWorks console, click MaxCompute Management in the left-side navigation pane, and then check whether column-level access control is enabled. You can go to your DataWorks workspace, view the security level of the fields in Data Map, and then view the security level of the Alibaba Cloud account on the User Management page.
@@ -32327,8 +32933,6 @@ export declare class CreatePermissionApplyOrderRequest extends $dara.Model {
32327
32933
  * @remarks
32328
32934
  * The name of the MaxCompute project in which you request permissions on the fields of a table.
32329
32935
  *
32330
- * This parameter is required.
32331
- *
32332
32936
  * @example
32333
32937
  * aMaxcomputeProjectName
32334
32938
  */
@@ -32345,8 +32949,6 @@ export declare class CreatePermissionApplyOrderRequest extends $dara.Model {
32345
32949
  * @remarks
32346
32950
  * The ID of the DataWorks workspace that is associated with the MaxCompute project in which you want to request permissions on the fields of a table. You can go to the SettingCenter page in the DataWorks console to view the workspace ID.
32347
32951
  *
32348
- * This parameter is required.
32349
- *
32350
32952
  * @example
32351
32953
  * 12345
32352
32954
  */
@@ -33235,7 +33837,7 @@ export declare class CreateQualityRuleRequest extends $dara.Model {
33235
33837
  checker?: number;
33236
33838
  /**
33237
33839
  * @remarks
33238
- * The description of the monitoring rule.
33840
+ * The description of the rule.
33239
33841
  *
33240
33842
  * @example
33241
33843
  * Verification
@@ -34517,10 +35119,10 @@ export declare class CreateUdfFileRequest extends $dara.Model {
34517
35119
  cmdDescription?: string;
34518
35120
  /**
34519
35121
  * @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:
35122
+ * Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:
34521
35123
  *
34522
- * - true: If the directory does not exist, the directory is automatically created.
34523
- * - false: If the directory does not exist, the call fails.
35124
+ * * true: The system automatically creates the directory if the directory does not exist.
35125
+ * * false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.
34524
35126
  *
34525
35127
  * @example
34526
35128
  * false
@@ -34608,7 +35210,7 @@ export declare class CreateUdfFileRequest extends $dara.Model {
34608
35210
  returnValue?: string;
34609
35211
  /**
34610
35212
  * @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.
35213
+ * 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
35214
  *
34613
35215
  * @example
34614
35216
  * Concatenate several strings to generate a new string
@@ -39062,7 +39664,7 @@ export declare class DsgSceneQuerySceneListByNameRequest extends $dara.Model {
39062
39664
  export declare class DsgSceneQuerySceneListByNameResponseBody extends $dara.Model {
39063
39665
  /**
39064
39666
  * @remarks
39065
- * The data entries returned.
39667
+ * The returned data.
39066
39668
  */
39067
39669
  data?: DsgSceneQuerySceneListByNameResponseBodyData[];
39068
39670
  /**
@@ -45530,7 +46132,9 @@ export declare class GetMetaTableColumnResponse extends $dara.Model {
45530
46132
  export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45531
46133
  /**
45532
46134
  * @remarks
45533
- * The ID of the EMR cluster. You can log in to the EMR management console to obtain the cluster ID.
46135
+ * The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.
46136
+ *
46137
+ * 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
46138
  *
45535
46139
  * @example
45536
46140
  * C-010A704DA760****
@@ -45538,7 +46142,7 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45538
46142
  clusterId?: string;
45539
46143
  /**
45540
46144
  * @remarks
45541
- * Data type, currently only supports the value `emr`.
46145
+ * The type of the data source. Set the value to emr.
45542
46146
  *
45543
46147
  * @example
45544
46148
  * emr
@@ -45546,7 +46150,9 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45546
46150
  dataSourceType?: string;
45547
46151
  /**
45548
46152
  * @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.
46153
+ * The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.
46154
+ *
46155
+ * You can call the [ListMetaDB](https://help.aliyun.com/document_detail/185662.html) operation to query the database name.
45550
46156
  *
45551
46157
  * @example
45552
46158
  * abc
@@ -45570,7 +46176,7 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45570
46176
  pageSize?: number;
45571
46177
  /**
45572
46178
  * @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.
46179
+ * 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
46180
  *
45575
46181
  * @example
45576
46182
  * odps.engine_name.table_name
@@ -45578,7 +46184,9 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45578
46184
  tableGuid?: string;
45579
46185
  /**
45580
46186
  * @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.
46187
+ * The name of the table in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.
46188
+ *
46189
+ * You can call the [GetMetaDBTableList](https://help.aliyun.com/document_detail/173916.html) operation to query the table name.
45582
46190
  *
45583
46191
  * @example
45584
46192
  * abc
@@ -45598,12 +46206,12 @@ export declare class GetMetaTableFullInfoRequest extends $dara.Model {
45598
46206
  export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45599
46207
  /**
45600
46208
  * @remarks
45601
- * Business data.
46209
+ * The business data.
45602
46210
  */
45603
46211
  data?: GetMetaTableFullInfoResponseBodyData;
45604
46212
  /**
45605
46213
  * @remarks
45606
- * Error code.
46214
+ * The error code.
45607
46215
  *
45608
46216
  * @example
45609
46217
  * 1031203110005
@@ -45611,7 +46219,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45611
46219
  errorCode?: string;
45612
46220
  /**
45613
46221
  * @remarks
45614
- * Error message.
46222
+ * The error message.
45615
46223
  *
45616
46224
  * @example
45617
46225
  * The specified parameters are invalid.
@@ -45619,7 +46227,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45619
46227
  errorMessage?: string;
45620
46228
  /**
45621
46229
  * @remarks
45622
- * HTTP status code.
46230
+ * The HTTP status code.
45623
46231
  *
45624
46232
  * @example
45625
46233
  * 200
@@ -45627,7 +46235,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45627
46235
  httpStatusCode?: number;
45628
46236
  /**
45629
46237
  * @remarks
45630
- * Request ID. Used for locating logs and troubleshooting issues.
46238
+ * The request ID.
45631
46239
  *
45632
46240
  * @example
45633
46241
  * 0bc1411515937****
@@ -45635,7 +46243,7 @@ export declare class GetMetaTableFullInfoResponseBody extends $dara.Model {
45635
46243
  requestId?: string;
45636
46244
  /**
45637
46245
  * @remarks
45638
- * Whether the call was successful.
46246
+ * Indicates whether the request was successful.
45639
46247
  *
45640
46248
  * @example
45641
46249
  * true
@@ -46762,7 +47370,7 @@ export declare class GetMigrationSummaryRequest extends $dara.Model {
46762
47370
  * @remarks
46763
47371
  * The migration task ID.
46764
47372
  *
46765
- * You can call the [CreateImportMigration](https://help.aliyun.com/document_detail/2809123.html) operation to obtain the ID of the import task and call the [CreateExportMigration](https://help.aliyun.com/document_detail/3241603.html) operation to obtain the ID of the export task.
47373
+ * You can call the [CreateImportMigration](https://help.aliyun.com/document_detail/2780280.html) operation to obtain the ID of the import task and call the [CreateExportMigration](https://help.aliyun.com/document_detail/2780281.html) operation to obtain the ID of the export task.
46766
47374
  *
46767
47375
  * This parameter is required.
46768
47376
  *
@@ -46857,7 +47465,7 @@ export declare class GetNodeRequest extends $dara.Model {
46857
47465
  nodeId?: number;
46858
47466
  /**
46859
47467
  * @remarks
46860
- * The priority of the node. Valid values: 1, 3, 5, 7, and 8.
47468
+ * The environment of the workspace. Valid values: PROD and DEV.
46861
47469
  *
46862
47470
  * This parameter is required.
46863
47471
  *
@@ -47524,10 +48132,13 @@ export declare class GetOpRiskDataRequest extends $dara.Model {
47524
48132
  pageSize?: number;
47525
48133
  /**
47526
48134
  * @remarks
47527
- * The method that you use to identify risks. Valid values:
48135
+ * The method that you use to identify risks.
47528
48136
  *
47529
48137
  * * You can manually identify risks.
47530
48138
  * * 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.
48139
+ *
48140
+ * @example
48141
+ * Manual identification
47531
48142
  */
47532
48143
  riskType?: string;
47533
48144
  static names(): {
@@ -47560,6 +48171,21 @@ export declare class GetOpRiskDataResponseBody extends $dara.Model {
47560
48171
  * * sql: the SQL statement that is executed
47561
48172
  * * opAccount: the account that is used to perform the operation
47562
48173
  * * opTime: the time when the operation was performed
48174
+ *
48175
+ * @example
48176
+ * {
48177
+ * "opRiskDatas": [
48178
+ * {
48179
+ * "riskType": "Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine",
48180
+ * "opTime": "2021-01-04 23:39:13",
48181
+ * "opType": "SQL_SELECT",
48182
+ * "opAccount": "user",
48183
+ * "sensType": "Email/name/mobile phone number",
48184
+ * "sql": "SELECT * FROM default.jiade_1219_test_create LIMIT 20"
48185
+ * }
48186
+ * ],
48187
+ * "totalCount": 499
48188
+ * }
47563
48189
  */
47564
48190
  riskData?: string;
47565
48191
  static names(): {
@@ -47674,6 +48300,9 @@ export declare class GetOpSensitiveDataResponseBody extends $dara.Model {
47674
48300
  * * sql: the SQL statement that is executed.
47675
48301
  * * opAccount: the account that is used to perform the operation.
47676
48302
  * * opTime: the time when the operation was performed.
48303
+ *
48304
+ * @example
48305
+ * "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
48306
  */
47678
48307
  opSensitiveData?: string;
47679
48308
  /**
@@ -48161,15 +48790,26 @@ export declare class GetQualityEntityResponse extends $dara.Model {
48161
48790
  export declare class GetQualityFollowerRequest extends $dara.Model {
48162
48791
  /**
48163
48792
  * @remarks
48793
+ * The ID of the partition filter expression.
48794
+ *
48164
48795
  * This parameter is required.
48165
48796
  *
48166
48797
  * @example
48167
48798
  * 1234
48168
48799
  */
48169
48800
  entityId?: number;
48801
+ /**
48802
+ * @remarks
48803
+ * The ID of the DataWorks workspace.
48804
+ *
48805
+ * @example
48806
+ * 27
48807
+ */
48170
48808
  projectId?: number;
48171
48809
  /**
48172
48810
  * @remarks
48811
+ * The name of the engine or data source.
48812
+ *
48173
48813
  * This parameter is required.
48174
48814
  *
48175
48815
  * @example
@@ -48188,28 +48828,47 @@ export declare class GetQualityFollowerRequest extends $dara.Model {
48188
48828
  });
48189
48829
  }
48190
48830
  export declare class GetQualityFollowerResponseBody extends $dara.Model {
48831
+ /**
48832
+ * @remarks
48833
+ * The information about the subscription relationship.
48834
+ */
48191
48835
  data?: GetQualityFollowerResponseBodyData[];
48192
48836
  /**
48837
+ * @remarks
48838
+ * The error code.
48839
+ *
48193
48840
  * @example
48194
48841
  * Invalid.Tenant.ConnectionNotExists
48195
48842
  */
48196
48843
  errorCode?: string;
48197
48844
  /**
48845
+ * @remarks
48846
+ * The error message.
48847
+ *
48198
48848
  * @example
48199
48849
  * You have no permission.
48200
48850
  */
48201
48851
  errorMessage?: string;
48202
48852
  /**
48853
+ * @remarks
48854
+ * The HTTP return code.
48855
+ *
48203
48856
  * @example
48204
48857
  * 200
48205
48858
  */
48206
48859
  httpStatusCode?: number;
48207
48860
  /**
48861
+ * @remarks
48862
+ * The ID of the request.
48863
+ *
48208
48864
  * @example
48209
48865
  * 38cbdef0-f6cf-49
48210
48866
  */
48211
48867
  requestId?: string;
48212
48868
  /**
48869
+ * @remarks
48870
+ * Whether the call is successful.
48871
+ *
48213
48872
  * @example
48214
48873
  * true
48215
48874
  */
@@ -48410,7 +49069,7 @@ export declare class GetRemindResponseBody extends $dara.Model {
48410
49069
  httpStatusCode?: number;
48411
49070
  /**
48412
49071
  * @remarks
48413
- * The request ID. You can use the ID to troubleshoot issues.
49072
+ * The request ID.
48414
49073
  *
48415
49074
  * @example
48416
49075
  * 0000-ABCD-EFGH-IJKLMNOPQ
@@ -48713,6 +49372,8 @@ export declare class GetTopicResponse extends $dara.Model {
48713
49372
  export declare class GetTopicInfluenceRequest extends $dara.Model {
48714
49373
  /**
48715
49374
  * @remarks
49375
+ * The ID of the event.
49376
+ *
48716
49377
  * This parameter is required.
48717
49378
  *
48718
49379
  * @example
@@ -48737,26 +49398,41 @@ export declare class GetTopicInfluenceResponseBody extends $dara.Model {
48737
49398
  */
48738
49399
  data?: GetTopicInfluenceResponseBodyData;
48739
49400
  /**
49401
+ * @remarks
49402
+ * The error code returned.
49403
+ *
48740
49404
  * @example
48741
49405
  * 1031203110005
48742
49406
  */
48743
49407
  errorCode?: string;
48744
49408
  /**
49409
+ * @remarks
49410
+ * The error message returned.
49411
+ *
48745
49412
  * @example
48746
49413
  * The specified parameters are invalid.
48747
49414
  */
48748
49415
  errorMessage?: string;
48749
49416
  /**
49417
+ * @remarks
49418
+ * The HTTP status code returned.
49419
+ *
48750
49420
  * @example
48751
49421
  * 200
48752
49422
  */
48753
49423
  httpStatusCode?: number;
48754
49424
  /**
49425
+ * @remarks
49426
+ * The ID of the request. You can use the ID to troubleshoot issues.
49427
+ *
48755
49428
  * @example
48756
49429
  * 0000-ABCD-EFG****
48757
49430
  */
48758
49431
  requestId?: string;
48759
49432
  /**
49433
+ * @remarks
49434
+ * Indicates whether the request was successful.
49435
+ *
48760
49436
  * @example
48761
49437
  * true
48762
49438
  */
@@ -49103,6 +49779,9 @@ export declare class ListBaselineConfigsRequest extends $dara.Model {
49103
49779
  /**
49104
49780
  * @remarks
49105
49781
  * The keyword in the baseline name, which is used to search for the baseline.
49782
+ *
49783
+ * @example
49784
+ * Baseline name search keywords
49106
49785
  */
49107
49786
  searchText?: string;
49108
49787
  /**
@@ -49800,12 +50479,21 @@ export declare class ListCalcEnginesResponse extends $dara.Model {
49800
50479
  export declare class ListCheckProcessesRequest extends $dara.Model {
49801
50480
  /**
49802
50481
  * @remarks
50482
+ * Extension point event encoding.
50483
+ *
49803
50484
  * This parameter is required.
49804
50485
  *
49805
50486
  * @example
49806
50487
  * commit-file
49807
50488
  */
49808
50489
  eventCode?: string;
50490
+ /**
50491
+ * @remarks
50492
+ * The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.
50493
+ *
50494
+ * @example
50495
+ * 03400b03-b721-4c34-8727-2****1
50496
+ */
49809
50497
  messageId?: string;
49810
50498
  /**
49811
50499
  * @remarks
@@ -49816,21 +50504,37 @@ export declare class ListCheckProcessesRequest extends $dara.Model {
49816
50504
  */
49817
50505
  operator?: string;
49818
50506
  /**
50507
+ * @remarks
50508
+ * The page number. Default value: 1.
50509
+ *
49819
50510
  * @example
49820
50511
  * 1
49821
50512
  */
49822
50513
  pageNumber?: number;
49823
50514
  /**
50515
+ * @remarks
50516
+ * The number of entries per page.
50517
+ *
49824
50518
  * @example
49825
50519
  * 10
49826
50520
  */
49827
50521
  pageSize?: number;
49828
50522
  /**
50523
+ * @remarks
50524
+ * The ID of the workspace.
50525
+ *
49829
50526
  * @example
49830
50527
  * 123465
49831
50528
  */
49832
50529
  projectId?: number;
49833
50530
  /**
50531
+ * @remarks
50532
+ * The check status of the extension. Valid values:
50533
+ *
50534
+ * * CHECKING
50535
+ * * PASSED
50536
+ * * BLOCKED
50537
+ *
49834
50538
  * @example
49835
50539
  * True
49836
50540
  */
@@ -49847,8 +50551,15 @@ export declare class ListCheckProcessesRequest extends $dara.Model {
49847
50551
  });
49848
50552
  }
49849
50553
  export declare class ListCheckProcessesResponseBody extends $dara.Model {
50554
+ /**
50555
+ * @remarks
50556
+ * The pagination information.
50557
+ */
49850
50558
  pagingInfo?: ListCheckProcessesResponseBodyPagingInfo;
49851
50559
  /**
50560
+ * @remarks
50561
+ * The ID of the request.
50562
+ *
49852
50563
  * @example
49853
50564
  * 0000-ABCD-EF****
49854
50565
  */
@@ -50863,6 +51574,9 @@ export declare class ListDataServiceApisRequest extends $dara.Model {
50863
51574
  /**
50864
51575
  * @remarks
50865
51576
  * The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.
51577
+ *
51578
+ * @example
51579
+ * My API name
50866
51580
  */
50867
51581
  apiNameKeyword?: string;
50868
51582
  /**
@@ -51452,6 +52166,9 @@ export declare class ListDataServicePublishedApisRequest extends $dara.Model {
51452
52166
  /**
51453
52167
  * @remarks
51454
52168
  * The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.
52169
+ *
52170
+ * @example
52171
+ * My API name
51455
52172
  */
51456
52173
  apiNameKeyword?: string;
51457
52174
  /**
@@ -52478,7 +53195,7 @@ export declare class ListFileVersionsRequest extends $dara.Model {
52478
53195
  export declare class ListFileVersionsResponseBody extends $dara.Model {
52479
53196
  /**
52480
53197
  * @remarks
52481
- * The file versions returned.
53198
+ * The file versions.
52482
53199
  */
52483
53200
  data?: ListFileVersionsResponseBodyData;
52484
53201
  /**
@@ -52551,16 +53268,25 @@ export declare class ListFileVersionsResponse extends $dara.Model {
52551
53268
  }
52552
53269
  export declare class ListFilesRequest extends $dara.Model {
52553
53270
  /**
53271
+ * @remarks
53272
+ * The exact matching file name. The file name of the query result is exactly the same as this parameter.
53273
+ *
52554
53274
  * @example
52555
53275
  * ods_create.sql
52556
53276
  */
52557
53277
  exactFileName?: string;
52558
53278
  /**
52559
53279
  * @remarks
52560
- * The path of the files.
53280
+ * The path of the folder to which files belong.
53281
+ *
53282
+ * @example
53283
+ * Business_process/my_first_business_process/MaxCompute/ods_layer
52561
53284
  */
52562
53285
  fileFolderPath?: string;
52563
53286
  /**
53287
+ * @remarks
53288
+ * 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.
53289
+ *
52564
53290
  * @example
52565
53291
  * 78237,816123
52566
53292
  */
@@ -52583,12 +53309,19 @@ export declare class ListFilesRequest extends $dara.Model {
52583
53309
  * ods
52584
53310
  */
52585
53311
  keyword?: string;
53312
+ lastEditUser?: string;
52586
53313
  /**
53314
+ * @remarks
53315
+ * Whether the query result contains the path of the folder where the file is located.
53316
+ *
52587
53317
  * @example
52588
53318
  * false
52589
53319
  */
52590
53320
  needAbsoluteFolderPath?: boolean;
52591
53321
  /**
53322
+ * @remarks
53323
+ * Whether the query results contain file content (for files with more content, there may be a long network transmission delay).
53324
+ *
52592
53325
  * @example
52593
53326
  * false
52594
53327
  */
@@ -52774,6 +53507,9 @@ export declare class ListFoldersRequest extends $dara.Model {
52774
53507
  * The path of the parent folder.
52775
53508
  *
52776
53509
  * This parameter is required.
53510
+ *
53511
+ * @example
53512
+ * Business_process/my_first_business_process/MaxCompute
52777
53513
  */
52778
53514
  parentFolderPath?: string;
52779
53515
  /**
@@ -53228,6 +53964,16 @@ export declare class ListInstancesRequest extends $dara.Model {
53228
53964
  * openmr_8****
53229
53965
  */
53230
53966
  nodeName?: string;
53967
+ /**
53968
+ * @remarks
53969
+ * The sorting rule of the instances to be returned. Valid values:
53970
+ *
53971
+ * * CREATE_TIME_DESC: The instances are sorted in descending order of their creation time.
53972
+ * * INSTANCE_ID_DESC (default): The instances are sorted in descending order of their IDs.
53973
+ *
53974
+ * @example
53975
+ * INSTANCE_ID_DESC
53976
+ */
53231
53977
  orderBy?: string;
53232
53978
  /**
53233
53979
  * @remarks
@@ -53263,7 +54009,7 @@ export declare class ListInstancesRequest extends $dara.Model {
53263
54009
  programType?: string;
53264
54010
  /**
53265
54011
  * @remarks
53266
- * The time when the node was last modified.
54012
+ * The environment in which the node runs. Valid values: DEV and PROD.
53267
54013
  *
53268
54014
  * This parameter is required.
53269
54015
  *
@@ -53283,7 +54029,16 @@ export declare class ListInstancesRequest extends $dara.Model {
53283
54029
  projectId?: number;
53284
54030
  /**
53285
54031
  * @remarks
53286
- * The time when the instance started to wait to be scheduled.
54032
+ * The status of the node. Valid values:
54033
+ *
54034
+ * * NOT_RUN: The node is not run.
54035
+ * * WAIT_TIME: The node is waiting for the scheduling time to arrive.
54036
+ * * WAIT_RESOURCE: The node is waiting for resources.
54037
+ * * RUNNING: The node is running.
54038
+ * * CHECKING: Data quality is being checked for the node.
54039
+ * * CHECKING_CONDITION: Branch conditions are being checked for the node.
54040
+ * * FAILURE: The node fails to run.
54041
+ * * SUCCESS: The node is successfully run.
53287
54042
  *
53288
54043
  * @example
53289
54044
  * NOT_RUN
@@ -53379,9 +54134,10 @@ export declare class ListInstancesResponse extends $dara.Model {
53379
54134
  export declare class ListLineageRequest extends $dara.Model {
53380
54135
  /**
53381
54136
  * @remarks
53382
- * The lineage type. Valid values:\\
53383
- * up: ancestor lineage\\
53384
- * down: descendant lineage
54137
+ * The lineage type. Valid values:
54138
+ *
54139
+ * * up: ancestor lineage
54140
+ * * down: descendant lineage
53385
54141
  *
53386
54142
  * This parameter is required.
53387
54143
  *
@@ -53476,9 +54232,8 @@ export declare class ListLineageResponseBody extends $dara.Model {
53476
54232
  * @remarks
53477
54233
  * Indicates whether the request was successful. Valid values:
53478
54234
  *
53479
- * true
53480
- *
53481
- * false
54235
+ * * true
54236
+ * * false
53482
54237
  *
53483
54238
  * @example
53484
54239
  * true
@@ -54500,7 +55255,7 @@ export declare class ListNodesRequest extends $dara.Model {
54500
55255
  owner?: string;
54501
55256
  /**
54502
55257
  * @remarks
54503
- * The number of entries to return on each page. Default value: 10. Maximum value: 100.
55258
+ * The page number. Minimum value: 1. Maximum value: 100.
54504
55259
  *
54505
55260
  * @example
54506
55261
  * 1
@@ -54508,7 +55263,7 @@ export declare class ListNodesRequest extends $dara.Model {
54508
55263
  pageNumber?: number;
54509
55264
  /**
54510
55265
  * @remarks
54511
- * The ID of the workspace.
55266
+ * The number of entries per page. Default value: 10. Maximum value: 100.
54512
55267
  *
54513
55268
  * @example
54514
55269
  * 10
@@ -54524,7 +55279,7 @@ export declare class ListNodesRequest extends $dara.Model {
54524
55279
  programType?: string;
54525
55280
  /**
54526
55281
  * @remarks
54527
- * The number of entries returned per page. Default value: 10. Maximum value: 100.
55282
+ * The environment in which the node runs. Valid values: DEV and PROD.
54528
55283
  *
54529
55284
  * This parameter is required.
54530
55285
  *
@@ -54542,6 +55297,17 @@ export declare class ListNodesRequest extends $dara.Model {
54542
55297
  * 1234
54543
55298
  */
54544
55299
  projectId?: number;
55300
+ /**
55301
+ * @remarks
55302
+ * The scheduling type. Valid values:
55303
+ *
55304
+ * * NORMAL: Nodes are scheduled as expected.
55305
+ * * PAUSE: Nodes are paused.
55306
+ * * 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.
55307
+ *
55308
+ * @example
55309
+ * NORMAL
55310
+ */
54545
55311
  schedulerType?: string;
54546
55312
  static names(): {
54547
55313
  [key: string]: string;
@@ -54557,7 +55323,7 @@ export declare class ListNodesRequest extends $dara.Model {
54557
55323
  export declare class ListNodesResponseBody extends $dara.Model {
54558
55324
  /**
54559
55325
  * @remarks
54560
- * The ID of the associated workflow.
55326
+ * The nodes.
54561
55327
  */
54562
55328
  data?: ListNodesResponseBodyData;
54563
55329
  /**
@@ -54831,6 +55597,8 @@ export declare class ListNodesByOutputResponse extends $dara.Model {
54831
55597
  });
54832
55598
  }
54833
55599
  export declare class ListPermissionApplyOrdersRequest extends $dara.Model {
55600
+ applyType?: string;
55601
+ catalogName?: string;
54834
55602
  /**
54835
55603
  * @remarks
54836
55604
  * The end of the time range to query. You can query all the permissions request orders that have been submitted before the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders that are submitted before the current time are queried.
@@ -54843,8 +55611,6 @@ export declare class ListPermissionApplyOrdersRequest extends $dara.Model {
54843
55611
  * @remarks
54844
55612
  * The type of the compute engine with which the permission request order is associated. The parameter value is odps and cannot be changed. This value indicates that you can request permissions only on fields of tables in the MaxCompute compute engine.
54845
55613
  *
54846
- * This parameter is required.
54847
- *
54848
55614
  * @example
54849
55615
  * odps
54850
55616
  */
@@ -54883,8 +55649,6 @@ export declare class ListPermissionApplyOrdersRequest extends $dara.Model {
54883
55649
  * @remarks
54884
55650
  * The type of the permission request order. The parameter value is 1 and cannot be changed. This value indicates ACL-based authorization.
54885
55651
  *
54886
- * This parameter is required.
54887
- *
54888
55652
  * @example
54889
55653
  * 1
54890
55654
  */
@@ -56372,7 +57136,7 @@ export declare class ListShiftPersonnelsRequest extends $dara.Model {
56372
57136
  export declare class ListShiftPersonnelsResponseBody extends $dara.Model {
56373
57137
  /**
56374
57138
  * @remarks
56375
- * The pagination data.
57139
+ * The pagination information.
56376
57140
  */
56377
57141
  paging?: ListShiftPersonnelsResponseBodyPaging;
56378
57142
  /**
@@ -56439,6 +57203,9 @@ export declare class ListShiftSchedulesRequest extends $dara.Model {
56439
57203
  /**
56440
57204
  * @remarks
56441
57205
  * The keyword used to perform a fuzzy search on shift schedules.
57206
+ *
57207
+ * @example
57208
+ * Duty table name keyword
56442
57209
  */
56443
57210
  shiftScheduleName?: string;
56444
57211
  static names(): {
@@ -56455,7 +57222,7 @@ export declare class ListShiftSchedulesRequest extends $dara.Model {
56455
57222
  export declare class ListShiftSchedulesResponseBody extends $dara.Model {
56456
57223
  /**
56457
57224
  * @remarks
56458
- * The pagination data.
57225
+ * The pagination information.
56459
57226
  */
56460
57227
  paging?: ListShiftSchedulesResponseBodyPaging;
56461
57228
  /**
@@ -56801,6 +57568,8 @@ export declare class ListTableThemeResponse extends $dara.Model {
56801
57568
  export declare class ListTablesRequest extends $dara.Model {
56802
57569
  /**
56803
57570
  * @remarks
57571
+ * The type of the data source. Valid values: ODPS, emr, mysql, holo, analyticdb_for_mysql, oracle, postgresql, sqlserver, clickhouse, and starrocks.
57572
+ *
56804
57573
  * This parameter is required.
56805
57574
  *
56806
57575
  * @example
@@ -56811,11 +57580,17 @@ export declare class ListTablesRequest extends $dara.Model {
56811
57580
  */
56812
57581
  dataSourceType?: string;
56813
57582
  /**
57583
+ * @remarks
57584
+ * Pagination information, which specifies the starting point of this read.
57585
+ *
56814
57586
  * @example
56815
57587
  * 12222
56816
57588
  */
56817
57589
  nextToken?: string;
56818
57590
  /**
57591
+ * @remarks
57592
+ * The number of entries displayed on each page. The default value is 10 and the maximum value is 100.
57593
+ *
56819
57594
  * @example
56820
57595
  * 10
56821
57596
  */
@@ -57039,128 +57814,6 @@ export declare class ListTopicsResponse extends $dara.Model {
57039
57814
  [key: string]: any;
57040
57815
  });
57041
57816
  }
57042
- export declare class MountDirectoryRequest extends $dara.Model {
57043
- /**
57044
- * @remarks
57045
- * The ID of the directory that you want to add to the left-side navigation pane of DataAnalysis. This parameter is used together with the TargetType parameter. For example, if you set the TargetType parameter to META_ALBUM, you must set the TargetId parameter to the ID of the related data album. You can call the [ListMetaCollections](https://help.aliyun.com/document_detail/469938.html) operation to obtain the ID of the data album. The ID is indicated by the QualifiedName parameter.
57046
- *
57047
- * @example
57048
- * album.339
57049
- */
57050
- targetId?: string;
57051
- /**
57052
- * @remarks
57053
- * The type of the directory that you want to add to the left-side navigation pane of DataAnalysis. Example: META_ALBUM, which indicates the data album.
57054
- *
57055
- * @example
57056
- * META_ALBUM
57057
- */
57058
- targetType?: string;
57059
- /**
57060
- * @remarks
57061
- * The ID of the user in the tenant.
57062
- *
57063
- * * If you do not configure TargetUserId, the specified directory belongs to you.
57064
- * * If you configure TargetUserId, the specified directory belongs to the user specified by using TargetUserId.
57065
- *
57066
- * @example
57067
- * 1234567890
57068
- */
57069
- targetUserId?: string;
57070
- static names(): {
57071
- [key: string]: string;
57072
- };
57073
- static types(): {
57074
- [key: string]: any;
57075
- };
57076
- validate(): void;
57077
- constructor(map?: {
57078
- [key: string]: any;
57079
- });
57080
- }
57081
- export declare class MountDirectoryResponseBody extends $dara.Model {
57082
- /**
57083
- * @remarks
57084
- * The number of directories that are added. Valid values:
57085
- *
57086
- * * 0: No directories are added. The left-side navigation pane may contain the specified directory.
57087
- * * 1: One directory is added.
57088
- *
57089
- * @example
57090
- * 1
57091
- */
57092
- data?: number;
57093
- /**
57094
- * @remarks
57095
- * The error code. The value 200 indicates that the task is successful.
57096
- *
57097
- * @example
57098
- * 200
57099
- */
57100
- errorCode?: string;
57101
- /**
57102
- * @remarks
57103
- * The error message.
57104
- *
57105
- * @example
57106
- * You have no permission.
57107
- */
57108
- errorMessage?: string;
57109
- /**
57110
- * @remarks
57111
- * The HTTP status code.
57112
- *
57113
- * @example
57114
- * 200
57115
- */
57116
- httpStatusCode?: number;
57117
- /**
57118
- * @remarks
57119
- * The request ID. You can use the ID to troubleshoot issues.
57120
- *
57121
- * @example
57122
- * C27D4FB9-C59B-5E17-BD6C-1099B9D6A381
57123
- */
57124
- requestId?: string;
57125
- /**
57126
- * @remarks
57127
- * Indicates whether the request was successful. Valid values:
57128
- *
57129
- * * true
57130
- * * false
57131
- *
57132
- * @example
57133
- * true
57134
- */
57135
- success?: boolean;
57136
- static names(): {
57137
- [key: string]: string;
57138
- };
57139
- static types(): {
57140
- [key: string]: any;
57141
- };
57142
- validate(): void;
57143
- constructor(map?: {
57144
- [key: string]: any;
57145
- });
57146
- }
57147
- export declare class MountDirectoryResponse extends $dara.Model {
57148
- headers?: {
57149
- [key: string]: string;
57150
- };
57151
- statusCode?: number;
57152
- body?: MountDirectoryResponseBody;
57153
- static names(): {
57154
- [key: string]: string;
57155
- };
57156
- static types(): {
57157
- [key: string]: any;
57158
- };
57159
- validate(): void;
57160
- constructor(map?: {
57161
- [key: string]: any;
57162
- });
57163
- }
57164
57817
  export declare class OfflineNodeRequest extends $dara.Model {
57165
57818
  /**
57166
57819
  * @remarks
@@ -57492,6 +58145,9 @@ export declare class QueryDefaultTemplateResponseBody extends $dara.Model {
57492
58145
  * The returned data about the default data category and data sensitivity level template. The data is in the JSON array format.
57493
58146
  *
57494
58147
  * This parameter is required.
58148
+ *
58149
+ * @example
58150
+ * [{"gmtModified":1709022365000,"fileName":"default file","isDelete":false,"isDefaultTemplate":true}]
57495
58151
  */
57496
58152
  data?: any;
57497
58153
  /**
@@ -57509,6 +58165,9 @@ export declare class QueryDefaultTemplateResponseBody extends $dara.Model {
57509
58165
  * The error message.
57510
58166
  *
57511
58167
  * This parameter is required.
58168
+ *
58169
+ * @example
58170
+ * Parameter error
57512
58171
  */
57513
58172
  errorMessage?: string;
57514
58173
  /**
@@ -57705,6 +58364,9 @@ export declare class QueryRecognizeDataByRuleTypeResponseBody extends $dara.Mode
57705
58364
  /**
57706
58365
  * @remarks
57707
58366
  * The error message.
58367
+ *
58368
+ * @example
58369
+ * Missing parameter
57708
58370
  */
57709
58371
  errorMessage?: string;
57710
58372
  /**
@@ -57768,6 +58430,9 @@ export declare class QueryRecognizeRuleDetailRequest extends $dara.Model {
57768
58430
  * 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
58431
  *
57770
58432
  * This parameter is required.
58433
+ *
58434
+ * @example
58435
+ * Name
57771
58436
  */
57772
58437
  sensitiveName?: string;
57773
58438
  /**
@@ -57795,6 +58460,9 @@ export declare class QueryRecognizeRuleDetailResponseBody extends $dara.Model {
57795
58460
  /**
57796
58461
  * @remarks
57797
58462
  * The details of the sensitive field in the JSON format.
58463
+ *
58464
+ * @example
58465
+ * {"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
58466
  */
57799
58467
  data?: any;
57800
58468
  /**
@@ -57808,6 +58476,9 @@ export declare class QueryRecognizeRuleDetailResponseBody extends $dara.Model {
57808
58476
  /**
57809
58477
  * @remarks
57810
58478
  * The error message.
58479
+ *
58480
+ * @example
58481
+ * Missing parameter
57811
58482
  */
57812
58483
  errorMessage?: string;
57813
58484
  /**
@@ -57885,6 +58556,9 @@ export declare class QueryRecognizeRulesTypeResponseBody extends $dara.Model {
57885
58556
  /**
57886
58557
  * @remarks
57887
58558
  * The error message.
58559
+ *
58560
+ * @example
58561
+ * Missing parameter
57888
58562
  */
57889
58563
  errorMessage?: string;
57890
58564
  /**
@@ -57994,6 +58668,9 @@ export declare class QuerySensClassificationResponseBody extends $dara.Model {
57994
58668
  /**
57995
58669
  * @remarks
57996
58670
  * The error message.
58671
+ *
58672
+ * @example
58673
+ * Missing parameter
57997
58674
  */
57998
58675
  errorMessage?: string;
57999
58676
  /**
@@ -58103,6 +58780,9 @@ export declare class QuerySensLevelResponseBody extends $dara.Model {
58103
58780
  /**
58104
58781
  * @remarks
58105
58782
  * The error message.
58783
+ *
58784
+ * @example
58785
+ * Missing parameter
58106
58786
  */
58107
58787
  errorMessage?: string;
58108
58788
  /**
@@ -58188,6 +58868,9 @@ export declare class QuerySensNodeInfoRequest extends $dara.Model {
58188
58868
  /**
58189
58869
  * @remarks
58190
58870
  * 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.
58871
+ *
58872
+ * @example
58873
+ * ID card
58191
58874
  */
58192
58875
  sensitiveName?: string;
58193
58876
  /**
@@ -58236,6 +58919,9 @@ export declare class QuerySensNodeInfoResponseBody extends $dara.Model {
58236
58919
  /**
58237
58920
  * @remarks
58238
58921
  * The returned business data in the JSON format.
58922
+ *
58923
+ * @example
58924
+ * {"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
58925
  */
58240
58926
  data?: any;
58241
58927
  /**
@@ -58249,6 +58935,9 @@ export declare class QuerySensNodeInfoResponseBody extends $dara.Model {
58249
58935
  /**
58250
58936
  * @remarks
58251
58937
  * The error message.
58938
+ *
58939
+ * @example
58940
+ * Missing parameter
58252
58941
  */
58253
58942
  errorMessage?: string;
58254
58943
  /**
@@ -58376,7 +59065,7 @@ export declare class RegisterLineageRelationResponseBody extends $dara.Model {
58376
59065
  lineageRelation?: RegisterLineageRelationResponseBodyLineageRelation;
58377
59066
  /**
58378
59067
  * @remarks
58379
- * The request ID.
59068
+ * The request ID. You can locate logs and troubleshoot issues based on the ID.
58380
59069
  *
58381
59070
  * @example
58382
59071
  * EE50E05E-028C-182B-9xxx
@@ -58743,121 +59432,12 @@ export declare class RestartInstanceResponseBody extends $dara.Model {
58743
59432
  [key: string]: any;
58744
59433
  });
58745
59434
  }
58746
- export declare class RestartInstanceResponse extends $dara.Model {
58747
- headers?: {
58748
- [key: string]: string;
58749
- };
58750
- statusCode?: number;
58751
- body?: RestartInstanceResponseBody;
58752
- static names(): {
58753
- [key: string]: string;
58754
- };
58755
- static types(): {
58756
- [key: string]: any;
58757
- };
58758
- validate(): void;
58759
- constructor(map?: {
58760
- [key: string]: any;
58761
- });
58762
- }
58763
- export declare class ResumeInstanceRequest extends $dara.Model {
58764
- /**
58765
- * @remarks
58766
- * The instance ID.
58767
- *
58768
- * This parameter is required.
58769
- *
58770
- * @example
58771
- * 1234
58772
- */
58773
- instanceId?: number;
58774
- /**
58775
- * @remarks
58776
- * The environment of the workspace. Valid values: PROD and DEV.
58777
- *
58778
- * This parameter is required.
58779
- *
58780
- * @example
58781
- * PROD
58782
- */
58783
- projectEnv?: string;
58784
- static names(): {
58785
- [key: string]: string;
58786
- };
58787
- static types(): {
58788
- [key: string]: any;
58789
- };
58790
- validate(): void;
58791
- constructor(map?: {
58792
- [key: string]: any;
58793
- });
58794
- }
58795
- export declare class ResumeInstanceResponseBody extends $dara.Model {
58796
- /**
58797
- * @remarks
58798
- * The result returned.
58799
- *
58800
- * @example
58801
- * true
58802
- */
58803
- data?: boolean;
58804
- /**
58805
- * @remarks
58806
- * The error code.
58807
- *
58808
- * @example
58809
- * Invalid.Tenant.ConnectionNotExists
58810
- */
58811
- errorCode?: string;
58812
- /**
58813
- * @remarks
58814
- * The error message.
58815
- *
58816
- * @example
58817
- * The connection does not exist.
58818
- */
58819
- errorMessage?: string;
58820
- /**
58821
- * @remarks
58822
- * The HTTP status code.
58823
- *
58824
- * @example
58825
- * 200
58826
- */
58827
- httpStatusCode?: number;
58828
- /**
58829
- * @remarks
58830
- * The request ID.
58831
- *
58832
- * @example
58833
- * E6F0DBDD-5AD****
58834
- */
58835
- requestId?: string;
58836
- /**
58837
- * @remarks
58838
- * Indicates whether the request was successful.
58839
- *
58840
- * @example
58841
- * true
58842
- */
58843
- success?: boolean;
58844
- static names(): {
58845
- [key: string]: string;
58846
- };
58847
- static types(): {
58848
- [key: string]: any;
58849
- };
58850
- validate(): void;
58851
- constructor(map?: {
58852
- [key: string]: any;
58853
- });
58854
- }
58855
- export declare class ResumeInstanceResponse extends $dara.Model {
59435
+ export declare class RestartInstanceResponse extends $dara.Model {
58856
59436
  headers?: {
58857
59437
  [key: string]: string;
58858
59438
  };
58859
59439
  statusCode?: number;
58860
- body?: ResumeInstanceResponseBody;
59440
+ body?: RestartInstanceResponseBody;
58861
59441
  static names(): {
58862
59442
  [key: string]: string;
58863
59443
  };
@@ -58869,96 +59449,87 @@ export declare class ResumeInstanceResponse extends $dara.Model {
58869
59449
  [key: string]: any;
58870
59450
  });
58871
59451
  }
58872
- export declare class RevokeColumnPermissionRequest extends $dara.Model {
59452
+ export declare class ResumeInstanceRequest extends $dara.Model {
58873
59453
  /**
58874
59454
  * @remarks
58875
- * The fields for which you want to revoke permissions from a user. Separate multiple fields with commas (,). You can revoke the permissions on the fields only in MaxCompute tables.
59455
+ * The instance ID.
58876
59456
  *
58877
59457
  * This parameter is required.
58878
59458
  *
58879
59459
  * @example
58880
- * id,name
59460
+ * 1234
58881
59461
  */
58882
- columns?: string;
59462
+ instanceId?: number;
58883
59463
  /**
58884
59464
  * @remarks
58885
- * The name of the MaxCompute project to which the fields belong. You can log on to the DataWorks console and go to the SettingCenter page to obtain the name of the MaxCompute project that you associate with the workspace.
59465
+ * The environment of the workspace. Valid values: PROD and DEV.
58886
59466
  *
58887
59467
  * This parameter is required.
58888
59468
  *
58889
59469
  * @example
58890
- * aMaxcomputeProjectName
59470
+ * PROD
58891
59471
  */
58892
- maxComputeProjectName?: string;
59472
+ projectEnv?: string;
59473
+ static names(): {
59474
+ [key: string]: string;
59475
+ };
59476
+ static types(): {
59477
+ [key: string]: any;
59478
+ };
59479
+ validate(): void;
59480
+ constructor(map?: {
59481
+ [key: string]: any;
59482
+ });
59483
+ }
59484
+ export declare class ResumeInstanceResponseBody extends $dara.Model {
58893
59485
  /**
58894
59486
  * @remarks
58895
- * The ID of the Alibaba Cloud account of the user from which you want to revoke permissions. You can log on to the DataWorks console and go to the Security Settings page to obtain the ID. You must specify either this parameter or the RevokeUserName parameter. If you specify both this parameter and the RevokeUserName parameter and the parameter values are different, the value of this parameter prevails.
59487
+ * The result returned.
58896
59488
  *
58897
59489
  * @example
58898
- * 267842600408993176
59490
+ * true
58899
59491
  */
58900
- revokeUserId?: string;
59492
+ data?: boolean;
58901
59493
  /**
58902
59494
  * @remarks
58903
- * The Alibaba Cloud account from which you want to revoke permissions. Specify this parameter in the format that is the same as the format of the account used to access the MaxCompute project.
58904
- *
58905
- * * If the account is an Alibaba Cloud account, the value is in the ALIYUN$+Account name format.
58906
- * * If the account is a RAM user, the value is in the RAM$+Account name format.
58907
- *
58908
- * You must specify either this parameter or the RevokeUserId parameter. If you specify both this parameter and the RevokeUserId parameter and the parameter values are different, the value of the RevokeUserId parameter prevails.
59495
+ * The error code.
58909
59496
  *
58910
59497
  * @example
58911
- * RAM$dataworks_3h1_1:stsramuser
59498
+ * Invalid.Tenant.ConnectionNotExists
58912
59499
  */
58913
- revokeUserName?: string;
59500
+ errorCode?: string;
58914
59501
  /**
58915
59502
  * @remarks
58916
- * The name of the MaxCompute table to which the fields belong. You can call the [SearchMetaTables](https://help.aliyun.com/document_detail/173919.html) operation to query the name of the MaxCompute table.
58917
- *
58918
- * This parameter is required.
59503
+ * The error message.
58919
59504
  *
58920
59505
  * @example
58921
- * aTableName
59506
+ * The connection does not exist.
58922
59507
  */
58923
- tableName?: string;
59508
+ errorMessage?: string;
58924
59509
  /**
58925
59510
  * @remarks
58926
- * The ID of the DataWorks workspace with which the MaxCompute project is associated. You can log on to the DataWorks console and go to the Workspace page to obtain the ID.
58927
- *
58928
- * This parameter is required.
59511
+ * The HTTP status code.
58929
59512
  *
58930
59513
  * @example
58931
- * 12345
59514
+ * 200
58932
59515
  */
58933
- workspaceId?: number;
58934
- static names(): {
58935
- [key: string]: string;
58936
- };
58937
- static types(): {
58938
- [key: string]: any;
58939
- };
58940
- validate(): void;
58941
- constructor(map?: {
58942
- [key: string]: any;
58943
- });
58944
- }
58945
- export declare class RevokeColumnPermissionResponseBody extends $dara.Model {
59516
+ httpStatusCode?: number;
58946
59517
  /**
58947
59518
  * @remarks
58948
59519
  * The request ID.
58949
59520
  *
58950
59521
  * @example
58951
- * 0bc1ec92159376****
59522
+ * E6F0DBDD-5AD****
58952
59523
  */
58953
59524
  requestId?: string;
58954
59525
  /**
58955
59526
  * @remarks
58956
- * Indicates whether the permissions are revoked.
59527
+ * Indicates whether the request was successful.
58957
59528
  *
58958
59529
  * @example
58959
59530
  * true
58960
59531
  */
58961
- revokeSuccess?: boolean;
59532
+ success?: boolean;
58962
59533
  static names(): {
58963
59534
  [key: string]: string;
58964
59535
  };
@@ -58970,12 +59541,12 @@ export declare class RevokeColumnPermissionResponseBody extends $dara.Model {
58970
59541
  [key: string]: any;
58971
59542
  });
58972
59543
  }
58973
- export declare class RevokeColumnPermissionResponse extends $dara.Model {
59544
+ export declare class ResumeInstanceResponse extends $dara.Model {
58974
59545
  headers?: {
58975
59546
  [key: string]: string;
58976
59547
  };
58977
59548
  statusCode?: number;
58978
- body?: RevokeColumnPermissionResponseBody;
59549
+ body?: ResumeInstanceResponseBody;
58979
59550
  static names(): {
58980
59551
  [key: string]: string;
58981
59552
  };
@@ -59397,6 +59968,9 @@ export declare class RunManualDagNodesRequest extends $dara.Model {
59397
59968
  * 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
59969
  *
59399
59970
  * This parameter is required.
59971
+ *
59972
+ * @example
59973
+ * PROD or DEV
59400
59974
  */
59401
59975
  projectEnv?: string;
59402
59976
  /**
@@ -59740,6 +60314,9 @@ export declare class SaveDataServiceApiTestResultRequest extends $dara.Model {
59740
60314
  /**
59741
60315
  * @remarks
59742
60316
  * The sample failure response of the API. This parameter is optional.
60317
+ *
60318
+ * @example
60319
+ * {"apiLog": null, "data": null, "errCode": 1108110622, "errMsg": "data Source query failed", "requestId": "0 bc14a **** 5902762031 ****"}
59743
60320
  */
59744
60321
  failResultSample?: string;
59745
60322
  /**
@@ -61240,6 +61817,9 @@ export declare class SubmitFileRequest extends $dara.Model {
61240
61817
  /**
61241
61818
  * @remarks
61242
61819
  * The description of the commit operation.
61820
+ *
61821
+ * @example
61822
+ * Submit a task for the first time
61243
61823
  */
61244
61824
  comment?: string;
61245
61825
  /**
@@ -61901,128 +62481,6 @@ export declare class TopTenErrorTimesInstanceResponse extends $dara.Model {
61901
62481
  [key: string]: any;
61902
62482
  });
61903
62483
  }
61904
- export declare class UmountDirectoryRequest extends $dara.Model {
61905
- /**
61906
- * @remarks
61907
- * The ID of the directory that you want to remove from the left-side navigation pane of DataAnalysis. This parameter is used together with the TargetType parameter. For example, if you set the TargetType parameter to META_ALBUM, you must set the TargetId parameter to the ID of the metadata data album. You can call the [ListMetaCollections](https://help.aliyun.com/document_detail/469938.html) operation to obtain the ID of the data album. The ID is indicated by the QualifiedName parameter.
61908
- *
61909
- * @example
61910
- * album.339
61911
- */
61912
- targetId?: string;
61913
- /**
61914
- * @remarks
61915
- * The type of the directory that you want to remove from the left-side navigation pane of DataAnalysis. Example: META_ALBUM, which indicates the metadata data album.
61916
- *
61917
- * @example
61918
- * META_ALBUM
61919
- */
61920
- targetType?: string;
61921
- /**
61922
- * @remarks
61923
- * The ID of the user in the tenant.
61924
- *
61925
- * * If you do not configure TargetUserId, the directory belongs to you.
61926
- * * If you configure TargetUserId, the directory belongs to the user specified by using TargetUserId.
61927
- *
61928
- * @example
61929
- * 1234567890
61930
- */
61931
- targetUserId?: string;
61932
- static names(): {
61933
- [key: string]: string;
61934
- };
61935
- static types(): {
61936
- [key: string]: any;
61937
- };
61938
- validate(): void;
61939
- constructor(map?: {
61940
- [key: string]: any;
61941
- });
61942
- }
61943
- export declare class UmountDirectoryResponseBody extends $dara.Model {
61944
- /**
61945
- * @remarks
61946
- * The number of directories that are removed. Valid values:
61947
- *
61948
- * * 0: No directories are removed. The left-side navigation pane may not contain the specified directory.
61949
- * * 1: One directory is removed.
61950
- *
61951
- * @example
61952
- * 1
61953
- */
61954
- data?: number;
61955
- /**
61956
- * @remarks
61957
- * The error code. The value 200 indicates that the task is successful.
61958
- *
61959
- * @example
61960
- * 200
61961
- */
61962
- errorCode?: string;
61963
- /**
61964
- * @remarks
61965
- * The error message.
61966
- *
61967
- * @example
61968
- * You have no permission.
61969
- */
61970
- errorMessage?: string;
61971
- /**
61972
- * @remarks
61973
- * The HTTP status code. The value 200 indicates that the request was successful.
61974
- *
61975
- * @example
61976
- * 200
61977
- */
61978
- httpStatusCode?: number;
61979
- /**
61980
- * @remarks
61981
- * The request ID. You can use the ID to troubleshoot issues.
61982
- *
61983
- * @example
61984
- * 0bc5aa2716455247597991794e65bd
61985
- */
61986
- requestId?: string;
61987
- /**
61988
- * @remarks
61989
- * Indicates whether the request was successful. Valid values:
61990
- *
61991
- * * true
61992
- * * false
61993
- *
61994
- * @example
61995
- * true
61996
- */
61997
- success?: boolean;
61998
- static names(): {
61999
- [key: string]: string;
62000
- };
62001
- static types(): {
62002
- [key: string]: any;
62003
- };
62004
- validate(): void;
62005
- constructor(map?: {
62006
- [key: string]: any;
62007
- });
62008
- }
62009
- export declare class UmountDirectoryResponse extends $dara.Model {
62010
- headers?: {
62011
- [key: string]: string;
62012
- };
62013
- statusCode?: number;
62014
- body?: UmountDirectoryResponseBody;
62015
- static names(): {
62016
- [key: string]: string;
62017
- };
62018
- static types(): {
62019
- [key: string]: any;
62020
- };
62021
- validate(): void;
62022
- constructor(map?: {
62023
- [key: string]: any;
62024
- });
62025
- }
62026
62484
  export declare class UpdateBaselineRequest extends $dara.Model {
62027
62485
  /**
62028
62486
  * @remarks
@@ -62484,11 +62942,15 @@ export declare class UpdateClusterConfigsRequest extends $dara.Model {
62484
62942
  configType?: string;
62485
62943
  /**
62486
62944
  * @remarks
62945
+ * The configuration information of the cluster submodule.
62946
+ *
62487
62947
  * This parameter is required.
62488
62948
  */
62489
62949
  configValues?: ClusterConfig[];
62490
62950
  /**
62491
62951
  * @remarks
62952
+ * The ID of the workspace.
62953
+ *
62492
62954
  * This parameter is required.
62493
62955
  *
62494
62956
  * @example
@@ -62531,11 +62993,15 @@ export declare class UpdateClusterConfigsShrinkRequest extends $dara.Model {
62531
62993
  configType?: string;
62532
62994
  /**
62533
62995
  * @remarks
62996
+ * The configuration information of the cluster submodule.
62997
+ *
62534
62998
  * This parameter is required.
62535
62999
  */
62536
63000
  configValuesShrink?: string;
62537
63001
  /**
62538
63002
  * @remarks
63003
+ * The ID of the workspace.
63004
+ *
62539
63005
  * This parameter is required.
62540
63006
  *
62541
63007
  * @example
@@ -62566,21 +63032,33 @@ export declare class UpdateClusterConfigsResponseBody extends $dara.Model {
62566
63032
  */
62567
63033
  data?: boolean;
62568
63034
  /**
63035
+ * @remarks
63036
+ * The error code.
63037
+ *
62569
63038
  * @example
62570
63039
  * 101011005
62571
63040
  */
62572
63041
  errorCode?: string;
62573
63042
  /**
63043
+ * @remarks
63044
+ * The error message.
63045
+ *
62574
63046
  * @example
62575
63047
  * Invalid.Cluster.ClusterNotFound
62576
63048
  */
62577
63049
  errorMessage?: string;
62578
63050
  /**
63051
+ * @remarks
63052
+ * The HTTP status code.
63053
+ *
62579
63054
  * @example
62580
63055
  * 200
62581
63056
  */
62582
63057
  httpStatusCode?: number;
62583
63058
  /**
63059
+ * @remarks
63060
+ * The ID of the request. It is used to locate logs and troubleshoot problems.
63061
+ *
62584
63062
  * @example
62585
63063
  * 0000-ABCD-E****
62586
63064
  */
@@ -62932,6 +63410,9 @@ export declare class UpdateDIAlarmRuleRequest extends $dara.Model {
62932
63410
  /**
62933
63411
  * @remarks
62934
63412
  * The description of the alert rule.
63413
+ *
63414
+ * @example
63415
+ * mysql synchronizes to hologres heartbeat alert
62935
63416
  */
62936
63417
  description?: string;
62937
63418
  /**
@@ -62995,6 +63476,9 @@ export declare class UpdateDIAlarmRuleShrinkRequest extends $dara.Model {
62995
63476
  /**
62996
63477
  * @remarks
62997
63478
  * The description of the alert rule.
63479
+ *
63480
+ * @example
63481
+ * mysql synchronizes to hologres heartbeat alert
62998
63482
  */
62999
63483
  description?: string;
63000
63484
  /**
@@ -63093,6 +63577,9 @@ export declare class UpdateDIJobRequest extends $dara.Model {
63093
63577
  /**
63094
63578
  * @remarks
63095
63579
  * The description of the synchronization task.
63580
+ *
63581
+ * @example
63582
+ * Synchronize mysql to hologres
63096
63583
  */
63097
63584
  description?: string;
63098
63585
  /**
@@ -63112,7 +63599,7 @@ export declare class UpdateDIJobRequest extends $dara.Model {
63112
63599
  tableMappings?: UpdateDIJobRequestTableMappings[];
63113
63600
  /**
63114
63601
  * @remarks
63115
- * The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.
63602
+ * 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
63603
  */
63117
63604
  transformationRules?: UpdateDIJobRequestTransformationRules[];
63118
63605
  static names(): {
@@ -63138,6 +63625,9 @@ export declare class UpdateDIJobShrinkRequest extends $dara.Model {
63138
63625
  /**
63139
63626
  * @remarks
63140
63627
  * The description of the synchronization task.
63628
+ *
63629
+ * @example
63630
+ * Synchronize mysql to hologres
63141
63631
  */
63142
63632
  description?: string;
63143
63633
  /**
@@ -63157,7 +63647,7 @@ export declare class UpdateDIJobShrinkRequest extends $dara.Model {
63157
63647
  tableMappingsShrink?: string;
63158
63648
  /**
63159
63649
  * @remarks
63160
- * The list of transformation rules for objects involved in the synchronization task. Each entry in the list defines a transformation rule.
63650
+ * 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
63651
  */
63162
63652
  transformationRulesShrink?: string;
63163
63653
  static names(): {
@@ -63945,6 +64435,9 @@ export declare class UpdateFileRequest extends $dara.Model {
63945
64435
  */
63946
64436
  advancedSettings?: string;
63947
64437
  /**
64438
+ * @remarks
64439
+ * Specifies whether scheduling configurations immediately take effect after the node is deployed.
64440
+ *
63948
64441
  * @example
63949
64442
  * true
63950
64443
  */
@@ -64067,11 +64560,17 @@ export declare class UpdateFileRequest extends $dara.Model {
64067
64560
  /**
64068
64561
  * @remarks
64069
64562
  * The description of the file.
64563
+ *
64564
+ * @example
64565
+ * Here is the file description
64070
64566
  */
64071
64567
  fileDescription?: string;
64072
64568
  /**
64073
64569
  * @remarks
64074
64570
  * The path of the file.
64571
+ *
64572
+ * @example
64573
+ * Business_process/First_Business_Process/data_integration/Folder_1/Folder_2
64075
64574
  */
64076
64575
  fileFolderPath?: string;
64077
64576
  /**
@@ -64095,10 +64594,21 @@ export declare class UpdateFileRequest extends $dara.Model {
64095
64594
  */
64096
64595
  fileName?: string;
64097
64596
  /**
64597
+ * @remarks
64598
+ * Specifies whether to skip the dry-run property of the ancestor nodes of the node. 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.
64599
+ *
64098
64600
  * @example
64099
64601
  * true
64100
64602
  */
64101
64603
  ignoreParentSkipRunningProperty?: boolean;
64604
+ /**
64605
+ * @remarks
64606
+ * The ID of the custom image.
64607
+ *
64608
+ * @example
64609
+ * m-uf6d7npxk1hhek8ng0cb
64610
+ */
64611
+ imageId?: string;
64102
64612
  /**
64103
64613
  * @remarks
64104
64614
  * 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 +67160,7 @@ export declare class UpdateUdfFileRequest extends $dara.Model {
66650
67160
  returnValue?: string;
66651
67161
  /**
66652
67162
  * @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.
67163
+ * 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
67164
  *
66655
67165
  * @example
66656
67166
  * Concatenate several strings to generate a new string
@@ -67097,6 +67607,9 @@ export default class Client extends OpenApi {
67097
67607
  /**
67098
67608
  * Creates a data synchronization task.
67099
67609
  *
67610
+ * @remarks
67611
+ * You cannot configure scheduling properties for a task by calling this operation. If you want to configure scheduling properties for a task, you can call the UpdateFile operation.[](~~2780137~~)
67612
+ *
67100
67613
  * @param request - CreateDISyncTaskRequest
67101
67614
  * @param runtime - runtime options for this request RuntimeOptions
67102
67615
  * @returns CreateDISyncTaskResponse
@@ -67105,6 +67618,9 @@ export default class Client extends OpenApi {
67105
67618
  /**
67106
67619
  * Creates a data synchronization task.
67107
67620
  *
67621
+ * @remarks
67622
+ * You cannot configure scheduling properties for a task by calling this operation. If you want to configure scheduling properties for a task, you can call the UpdateFile operation.[](~~2780137~~)
67623
+ *
67108
67624
  * @param request - CreateDISyncTaskRequest
67109
67625
  * @returns CreateDISyncTaskResponse
67110
67626
  */
@@ -69103,7 +69619,10 @@ export default class Client extends OpenApi {
69103
69619
  */
69104
69620
  getMetaTableColumn(request: GetMetaTableColumnRequest): Promise<GetMetaTableColumnResponse>;
69105
69621
  /**
69106
- * Invoke the GetMetaTableFullInfo interface to obtain the complete information of a table (including field information).
69622
+ * Queries the complete information about a table, including information about fields in the table.
69623
+ *
69624
+ * @remarks
69625
+ * You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.
69107
69626
  *
69108
69627
  * @param request - GetMetaTableFullInfoRequest
69109
69628
  * @param runtime - runtime options for this request RuntimeOptions
@@ -69111,7 +69630,10 @@ export default class Client extends OpenApi {
69111
69630
  */
69112
69631
  getMetaTableFullInfoWithOptions(request: GetMetaTableFullInfoRequest, runtime: $dara.RuntimeOptions): Promise<GetMetaTableFullInfoResponse>;
69113
69632
  /**
69114
- * Invoke the GetMetaTableFullInfo interface to obtain the complete information of a table (including field information).
69633
+ * Queries the complete information about a table, including information about fields in the table.
69634
+ *
69635
+ * @remarks
69636
+ * You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.
69115
69637
  *
69116
69638
  * @param request - GetMetaTableFullInfoRequest
69117
69639
  * @returns GetMetaTableFullInfoResponse
@@ -69462,12 +69984,16 @@ export default class Client extends OpenApi {
69462
69984
  */
69463
69985
  getQualityEntity(request: GetQualityEntityRequest): Promise<GetQualityEntityResponse>;
69464
69986
  /**
69987
+ * Queries the subscribers of a partition filter expression.
69988
+ *
69465
69989
  * @param request - GetQualityFollowerRequest
69466
69990
  * @param runtime - runtime options for this request RuntimeOptions
69467
69991
  * @returns GetQualityFollowerResponse
69468
69992
  */
69469
69993
  getQualityFollowerWithOptions(request: GetQualityFollowerRequest, runtime: $dara.RuntimeOptions): Promise<GetQualityFollowerResponse>;
69470
69994
  /**
69995
+ * Queries the subscribers of a partition filter expression.
69996
+ *
69471
69997
  * @param request - GetQualityFollowerRequest
69472
69998
  * @returns GetQualityFollowerResponse
69473
69999
  */
@@ -69566,12 +70092,24 @@ export default class Client extends OpenApi {
69566
70092
  */
69567
70093
  getTopic(request: GetTopicRequest): Promise<GetTopicResponse>;
69568
70094
  /**
70095
+ * Queries baseline instances affected by an event.
70096
+ *
70097
+ * @remarks
70098
+ * ## Debugging
70099
+ * [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)
70100
+ *
69569
70101
  * @param request - GetTopicInfluenceRequest
69570
70102
  * @param runtime - runtime options for this request RuntimeOptions
69571
70103
  * @returns GetTopicInfluenceResponse
69572
70104
  */
69573
70105
  getTopicInfluenceWithOptions(request: GetTopicInfluenceRequest, runtime: $dara.RuntimeOptions): Promise<GetTopicInfluenceResponse>;
69574
70106
  /**
70107
+ * Queries baseline instances affected by an event.
70108
+ *
70109
+ * @remarks
70110
+ * ## Debugging
70111
+ * [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)
70112
+ *
69575
70113
  * @param request - GetTopicInfluenceRequest
69576
70114
  * @returns GetTopicInfluenceResponse
69577
70115
  */
@@ -69692,7 +70230,7 @@ export default class Client extends OpenApi {
69692
70230
  */
69693
70231
  listCalcEngines(request: ListCalcEnginesRequest): Promise<ListCalcEnginesResponse>;
69694
70232
  /**
69695
- * 查询扩展事件的检查列表
70233
+ * Queries the check results of extension point events.
69696
70234
  *
69697
70235
  * @param request - ListCheckProcessesRequest
69698
70236
  * @param runtime - runtime options for this request RuntimeOptions
@@ -69700,7 +70238,7 @@ export default class Client extends OpenApi {
69700
70238
  */
69701
70239
  listCheckProcessesWithOptions(request: ListCheckProcessesRequest, runtime: $dara.RuntimeOptions): Promise<ListCheckProcessesResponse>;
69702
70240
  /**
69703
- * 查询扩展事件的检查列表
70241
+ * Queries the check results of extension point events.
69704
70242
  *
69705
70243
  * @param request - ListCheckProcessesRequest
69706
70244
  * @returns ListCheckProcessesResponse
@@ -70089,23 +70627,31 @@ export default class Client extends OpenApi {
70089
70627
  */
70090
70628
  listFileType(request: ListFileTypeRequest): Promise<ListFileTypeResponse>;
70091
70629
  /**
70630
+ * Queries a list of file versions.
70631
+ *
70092
70632
  * @param request - ListFileVersionsRequest
70093
70633
  * @param runtime - runtime options for this request RuntimeOptions
70094
70634
  * @returns ListFileVersionsResponse
70095
70635
  */
70096
70636
  listFileVersionsWithOptions(request: ListFileVersionsRequest, runtime: $dara.RuntimeOptions): Promise<ListFileVersionsResponse>;
70097
70637
  /**
70638
+ * Queries a list of file versions.
70639
+ *
70098
70640
  * @param request - ListFileVersionsRequest
70099
70641
  * @returns ListFileVersionsResponse
70100
70642
  */
70101
70643
  listFileVersions(request: ListFileVersionsRequest): Promise<ListFileVersionsResponse>;
70102
70644
  /**
70645
+ * Queries a list of files.
70646
+ *
70103
70647
  * @param request - ListFilesRequest
70104
70648
  * @param runtime - runtime options for this request RuntimeOptions
70105
70649
  * @returns ListFilesResponse
70106
70650
  */
70107
70651
  listFilesWithOptions(request: ListFilesRequest, runtime: $dara.RuntimeOptions): Promise<ListFilesResponse>;
70108
70652
  /**
70653
+ * Queries a list of files.
70654
+ *
70109
70655
  * @param request - ListFilesRequest
70110
70656
  * @returns ListFilesResponse
70111
70657
  */
@@ -70171,7 +70717,7 @@ export default class Client extends OpenApi {
70171
70717
  */
70172
70718
  listInstanceHistory(request: ListInstanceHistoryRequest): Promise<ListInstanceHistoryResponse>;
70173
70719
  /**
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.
70720
+ * Queries a list of instances.
70175
70721
  *
70176
70722
  * @param request - ListInstancesRequest
70177
70723
  * @param runtime - runtime options for this request RuntimeOptions
@@ -70179,7 +70725,7 @@ export default class Client extends OpenApi {
70179
70725
  */
70180
70726
  listInstancesWithOptions(request: ListInstancesRequest, runtime: $dara.RuntimeOptions): Promise<ListInstancesResponse>;
70181
70727
  /**
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.
70728
+ * Queries a list of instances.
70183
70729
  *
70184
70730
  * @param request - ListInstancesRequest
70185
70731
  * @returns ListInstancesResponse
@@ -70684,21 +71230,6 @@ export default class Client extends OpenApi {
70684
71230
  * @returns ListTopicsResponse
70685
71231
  */
70686
71232
  listTopics(request: ListTopicsRequest): Promise<ListTopicsResponse>;
70687
- /**
70688
- * Adds a directory to the left-side navigation pane of DataAnalysis.
70689
- *
70690
- * @param request - MountDirectoryRequest
70691
- * @param runtime - runtime options for this request RuntimeOptions
70692
- * @returns MountDirectoryResponse
70693
- */
70694
- mountDirectoryWithOptions(request: MountDirectoryRequest, runtime: $dara.RuntimeOptions): Promise<MountDirectoryResponse>;
70695
- /**
70696
- * Adds a directory to the left-side navigation pane of DataAnalysis.
70697
- *
70698
- * @param request - MountDirectoryRequest
70699
- * @returns MountDirectoryResponse
70700
- */
70701
- mountDirectory(request: MountDirectoryRequest): Promise<MountDirectoryResponse>;
70702
71233
  /**
70703
71234
  * Undeploys a node.
70704
71235
  *
@@ -70959,21 +71490,6 @@ export default class Client extends OpenApi {
70959
71490
  * @returns ResumeInstanceResponse
70960
71491
  */
70961
71492
  resumeInstance(request: ResumeInstanceRequest): Promise<ResumeInstanceResponse>;
70962
- /**
70963
- * Revokes permissions on table fields from a user.
70964
- *
70965
- * @param request - RevokeColumnPermissionRequest
70966
- * @param runtime - runtime options for this request RuntimeOptions
70967
- * @returns RevokeColumnPermissionResponse
70968
- */
70969
- revokeColumnPermissionWithOptions(request: RevokeColumnPermissionRequest, runtime: $dara.RuntimeOptions): Promise<RevokeColumnPermissionResponse>;
70970
- /**
70971
- * Revokes permissions on table fields from a user.
70972
- *
70973
- * @param request - RevokeColumnPermissionRequest
70974
- * @returns RevokeColumnPermissionResponse
70975
- */
70976
- revokeColumnPermission(request: RevokeColumnPermissionRequest): Promise<RevokeColumnPermissionResponse>;
70977
71493
  /**
70978
71494
  * Revokes permissions on a table from a user.
70979
71495
  *
@@ -71384,21 +71900,6 @@ export default class Client extends OpenApi {
71384
71900
  * @returns TopTenErrorTimesInstanceResponse
71385
71901
  */
71386
71902
  topTenErrorTimesInstance(request: TopTenErrorTimesInstanceRequest): Promise<TopTenErrorTimesInstanceResponse>;
71387
- /**
71388
- * Removes a directory from the left-side navigation pane of DataAnalysis.
71389
- *
71390
- * @param request - UmountDirectoryRequest
71391
- * @param runtime - runtime options for this request RuntimeOptions
71392
- * @returns UmountDirectoryResponse
71393
- */
71394
- umountDirectoryWithOptions(request: UmountDirectoryRequest, runtime: $dara.RuntimeOptions): Promise<UmountDirectoryResponse>;
71395
- /**
71396
- * Removes a directory from the left-side navigation pane of DataAnalysis.
71397
- *
71398
- * @param request - UmountDirectoryRequest
71399
- * @returns UmountDirectoryResponse
71400
- */
71401
- umountDirectory(request: UmountDirectoryRequest): Promise<UmountDirectoryResponse>;
71402
71903
  /**
71403
71904
  * Updates a baseline.
71404
71905
  *
@@ -71430,7 +71931,7 @@ export default class Client extends OpenApi {
71430
71931
  */
71431
71932
  updateBusiness(request: UpdateBusinessRequest): Promise<UpdateBusinessResponse>;
71432
71933
  /**
71433
- * 更新集群的配置信息
71934
+ * Updates the configurations of submodules in a workspace. You can configure SPARK parameters.
71434
71935
  *
71435
71936
  * @param tmpReq - UpdateClusterConfigsRequest
71436
71937
  * @param runtime - runtime options for this request RuntimeOptions
@@ -71438,7 +71939,7 @@ export default class Client extends OpenApi {
71438
71939
  */
71439
71940
  updateClusterConfigsWithOptions(tmpReq: UpdateClusterConfigsRequest, runtime: $dara.RuntimeOptions): Promise<UpdateClusterConfigsResponse>;
71440
71941
  /**
71441
- * 更新集群的配置信息
71942
+ * Updates the configurations of submodules in a workspace. You can configure SPARK parameters.
71442
71943
  *
71443
71944
  * @param request - UpdateClusterConfigsRequest
71444
71945
  * @returns UpdateClusterConfigsResponse