@alicloud/dataworks-public20240518 6.1.0 → 6.1.1
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 +335 -166
- package/dist/client.js +32 -10
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +341 -166
package/dist/client.d.ts
CHANGED
|
@@ -1516,7 +1516,7 @@ export declare class CreateAlertRuleRequestTriggerCondition extends $dara.Model
|
|
|
1516
1516
|
export declare class CreateDIAlarmRuleRequestNotificationSettingsNotificationChannels extends $dara.Model {
|
|
1517
1517
|
/**
|
|
1518
1518
|
* @remarks
|
|
1519
|
-
* The alert notification
|
|
1519
|
+
* The alert notification method. Valid values:
|
|
1520
1520
|
*
|
|
1521
1521
|
* * Mail
|
|
1522
1522
|
* * Phone
|
|
@@ -1577,7 +1577,7 @@ export declare class CreateDIAlarmRuleRequestNotificationSettingsNotificationRec
|
|
|
1577
1577
|
export declare class CreateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
|
|
1578
1578
|
/**
|
|
1579
1579
|
* @remarks
|
|
1580
|
-
*
|
|
1580
|
+
* This parameter is deprecated and replaced by the MuteInterval parameter.
|
|
1581
1581
|
*
|
|
1582
1582
|
* @example
|
|
1583
1583
|
* 5
|
|
@@ -1587,7 +1587,7 @@ export declare class CreateDIAlarmRuleRequestNotificationSettings extends $dara.
|
|
|
1587
1587
|
inhibitionInterval?: number;
|
|
1588
1588
|
/**
|
|
1589
1589
|
* @remarks
|
|
1590
|
-
*
|
|
1590
|
+
* The duration of the alert suppression interval. Default value: 5. Unit: minutes.
|
|
1591
1591
|
*
|
|
1592
1592
|
* @example
|
|
1593
1593
|
* 5
|
|
@@ -1617,14 +1617,14 @@ export declare class CreateDIAlarmRuleRequestNotificationSettings extends $dara.
|
|
|
1617
1617
|
export declare class CreateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
|
|
1618
1618
|
/**
|
|
1619
1619
|
* @remarks
|
|
1620
|
-
*
|
|
1620
|
+
* This parameter is deprecated and replaced by the DdlTypes parameter.
|
|
1621
1621
|
*
|
|
1622
1622
|
* @deprecated
|
|
1623
1623
|
*/
|
|
1624
1624
|
ddlReportTags?: string[];
|
|
1625
1625
|
/**
|
|
1626
1626
|
* @remarks
|
|
1627
|
-
*
|
|
1627
|
+
* The types of DDL operations for which the alert rule takes effect.
|
|
1628
1628
|
*/
|
|
1629
1629
|
ddlTypes?: string[];
|
|
1630
1630
|
/**
|
|
@@ -1799,8 +1799,8 @@ export declare class CreateDIJobRequestJobSettingsRuntimeSettings extends $dara.
|
|
|
1799
1799
|
* * runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
|
|
1800
1800
|
* * runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
|
|
1801
1801
|
* * runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
|
|
1802
|
-
* * runtime.realtime.failover.minute.dataxcdc:
|
|
1803
|
-
* * runtime.realtime.failover.times.dataxcdc:
|
|
1802
|
+
* * runtime.realtime.failover.minute.dataxcdc: specifies the maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.
|
|
1803
|
+
* * runtime.realtime.failover.times.dataxcdc: specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.
|
|
1804
1804
|
*
|
|
1805
1805
|
* @example
|
|
1806
1806
|
* runtime.offline.concurrent
|
|
@@ -1830,19 +1830,19 @@ export declare class CreateDIJobRequestJobSettings extends $dara.Model {
|
|
|
1830
1830
|
* @remarks
|
|
1831
1831
|
* The channel control settings for the synchronization task. You can configure special channel control settings for the following synchronization links: data synchronization between Hologres data sources and data synchronization from Hologres to Kafka.
|
|
1832
1832
|
*
|
|
1833
|
-
* 1.
|
|
1833
|
+
* 1. Holo2Kafka
|
|
1834
1834
|
*
|
|
1835
1835
|
* * Example: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}
|
|
1836
1836
|
* * kafkaClientProperties: the parameters related to a Kafka producer, which are used when you write data to a Kafka data source.
|
|
1837
1837
|
* * keyColumns: the names of Kafka columns to which you want to write data.
|
|
1838
|
-
* * writeMode: the writing format. Valid values: json and canal.
|
|
1838
|
+
* * writeMode: the writing format of the Kafka data source. Valid values: json and canal.
|
|
1839
1839
|
*
|
|
1840
|
-
* 2.
|
|
1840
|
+
* 2. Holo2Holo
|
|
1841
1841
|
*
|
|
1842
1842
|
* * Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}
|
|
1843
1843
|
* * conflictMode: the policy used to handle a conflict that occurs during data writing to Hologres. Valid values: replace and ignore.
|
|
1844
1844
|
* * writeMode: the mode in which you want to write data to Hologres. Valid values: replay and insert.
|
|
1845
|
-
* * dynamicColumnAction: the
|
|
1845
|
+
* * dynamicColumnAction: the mode in which you want to write data to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.
|
|
1846
1846
|
*
|
|
1847
1847
|
* @example
|
|
1848
1848
|
* {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
|
|
@@ -2805,6 +2805,8 @@ export declare class CreateDataQualityEvaluationTaskRequestTarget extends $dara.
|
|
|
2805
2805
|
* * emr
|
|
2806
2806
|
* * analyticdb_for_postgresql
|
|
2807
2807
|
*
|
|
2808
|
+
* This parameter is required.
|
|
2809
|
+
*
|
|
2808
2810
|
* @example
|
|
2809
2811
|
* maxcompute
|
|
2810
2812
|
*/
|
|
@@ -2821,6 +2823,8 @@ export declare class CreateDataQualityEvaluationTaskRequestTarget extends $dara.
|
|
|
2821
2823
|
* @remarks
|
|
2822
2824
|
* The ID of the table in Data Map.
|
|
2823
2825
|
*
|
|
2826
|
+
* This parameter is required.
|
|
2827
|
+
*
|
|
2824
2828
|
* @example
|
|
2825
2829
|
* odps.api_test.ods_openapi_log_d
|
|
2826
2830
|
*/
|
|
@@ -3442,10 +3446,11 @@ export declare class CreateResourceGroupResponseBodyResourceGroupOrder extends $
|
|
|
3442
3446
|
export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAlert extends $dara.Model {
|
|
3443
3447
|
/**
|
|
3444
3448
|
* @remarks
|
|
3445
|
-
* The notification method.
|
|
3446
|
-
*
|
|
3447
|
-
*
|
|
3448
|
-
*
|
|
3449
|
+
* The alert notification method. Valid values:
|
|
3450
|
+
*
|
|
3451
|
+
* * Sms
|
|
3452
|
+
* * Mail
|
|
3453
|
+
* * SmsMail
|
|
3449
3454
|
*
|
|
3450
3455
|
* @example
|
|
3451
3456
|
* Sms
|
|
@@ -3453,10 +3458,11 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAlert ext
|
|
|
3453
3458
|
noticeType?: string;
|
|
3454
3459
|
/**
|
|
3455
3460
|
* @remarks
|
|
3456
|
-
* The
|
|
3457
|
-
*
|
|
3458
|
-
*
|
|
3459
|
-
*
|
|
3461
|
+
* The alerting policy. Valid values:
|
|
3462
|
+
*
|
|
3463
|
+
* * SUCCESS: An alert is reported when data backfill succeeds.
|
|
3464
|
+
* * FAILURE: An alert is reported when data backfill fails.
|
|
3465
|
+
* * SuccessFailure: An alert is reported regardless of whether data backfill succeeds or fails.
|
|
3460
3466
|
*
|
|
3461
3467
|
* @example
|
|
3462
3468
|
* Succes
|
|
@@ -3476,7 +3482,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAlert ext
|
|
|
3476
3482
|
export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis extends $dara.Model {
|
|
3477
3483
|
/**
|
|
3478
3484
|
* @remarks
|
|
3479
|
-
*
|
|
3485
|
+
* Specifies whether to block the running of the instance if the analysis fails.
|
|
3480
3486
|
*
|
|
3481
3487
|
* @example
|
|
3482
3488
|
* true
|
|
@@ -3484,7 +3490,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis
|
|
|
3484
3490
|
blocked?: boolean;
|
|
3485
3491
|
/**
|
|
3486
3492
|
* @remarks
|
|
3487
|
-
*
|
|
3493
|
+
* Specifies whether to enable the analysis feature.
|
|
3488
3494
|
*
|
|
3489
3495
|
* @example
|
|
3490
3496
|
* true
|
|
@@ -3504,7 +3510,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis
|
|
|
3504
3510
|
export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy extends $dara.Model {
|
|
3505
3511
|
/**
|
|
3506
3512
|
* @remarks
|
|
3507
|
-
* The
|
|
3513
|
+
* The time when the instance finishes running. This parameter is required if you specify the RunPolicy parameter.
|
|
3508
3514
|
*
|
|
3509
3515
|
* @example
|
|
3510
3516
|
* 23:59:59
|
|
@@ -3512,7 +3518,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
|
|
|
3512
3518
|
endTime?: string;
|
|
3513
3519
|
/**
|
|
3514
3520
|
* @remarks
|
|
3515
|
-
*
|
|
3521
|
+
* Specifies whether the instance can be run immediately during the time period in the future. Default value: false.
|
|
3516
3522
|
*
|
|
3517
3523
|
* @example
|
|
3518
3524
|
* false
|
|
@@ -3520,7 +3526,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
|
|
|
3520
3526
|
immediately?: boolean;
|
|
3521
3527
|
/**
|
|
3522
3528
|
* @remarks
|
|
3523
|
-
* The
|
|
3529
|
+
* The time when the instance starts to run. This parameter is required if you specify the RunPolicy parameter.
|
|
3524
3530
|
*
|
|
3525
3531
|
* @example
|
|
3526
3532
|
* 00:00:00
|
|
@@ -3528,9 +3534,10 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
|
|
|
3528
3534
|
startTime?: string;
|
|
3529
3535
|
/**
|
|
3530
3536
|
* @remarks
|
|
3531
|
-
* The type of the time period. This
|
|
3532
|
-
*
|
|
3533
|
-
*
|
|
3537
|
+
* The type of the time period during which the data is backfilled. This parameter is required if you specify the RunPolicy parameter. Valid values:
|
|
3538
|
+
*
|
|
3539
|
+
* * Daily
|
|
3540
|
+
* * Weekend
|
|
3534
3541
|
*
|
|
3535
3542
|
* @example
|
|
3536
3543
|
* Daily
|
|
@@ -3550,41 +3557,42 @@ export declare class CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy
|
|
|
3550
3557
|
export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends $dara.Model {
|
|
3551
3558
|
/**
|
|
3552
3559
|
* @remarks
|
|
3553
|
-
*
|
|
3560
|
+
* The alert settings.
|
|
3554
3561
|
*/
|
|
3555
3562
|
alert?: CreateWorkflowInstancesRequestDefaultRunPropertiesAlert;
|
|
3556
3563
|
/**
|
|
3557
3564
|
* @remarks
|
|
3558
|
-
*
|
|
3565
|
+
* The analysis of the configurations.
|
|
3559
3566
|
*/
|
|
3560
3567
|
analysis?: CreateWorkflowInstancesRequestDefaultRunPropertiesAnalysis;
|
|
3561
3568
|
/**
|
|
3562
3569
|
* @remarks
|
|
3563
|
-
* The
|
|
3570
|
+
* The IDs of the projects that do not need to be run.
|
|
3564
3571
|
*/
|
|
3565
3572
|
excludeProjectIds?: number[];
|
|
3566
3573
|
/**
|
|
3567
3574
|
* @remarks
|
|
3568
|
-
* The
|
|
3575
|
+
* The IDs of the tasks that do not need to be run.
|
|
3569
3576
|
*/
|
|
3570
3577
|
excludeTaskIds?: number[];
|
|
3571
3578
|
/**
|
|
3572
3579
|
* @remarks
|
|
3573
|
-
* The
|
|
3580
|
+
* The IDs of the projects that need to be run.
|
|
3574
3581
|
*/
|
|
3575
3582
|
includeProjectIds?: number[];
|
|
3576
3583
|
/**
|
|
3577
3584
|
* @remarks
|
|
3578
|
-
* The
|
|
3585
|
+
* The IDs of the tasks that need to be run.
|
|
3579
3586
|
*/
|
|
3580
3587
|
includeTaskIds?: number[];
|
|
3581
3588
|
/**
|
|
3582
3589
|
* @remarks
|
|
3583
|
-
* The data
|
|
3584
|
-
*
|
|
3585
|
-
*
|
|
3586
|
-
*
|
|
3587
|
-
*
|
|
3590
|
+
* The data backfill mode. Default value: ManualSelection. Valid values:
|
|
3591
|
+
*
|
|
3592
|
+
* * General: You can specify only one root task ID. The `IncludeTaskIds` parameter is optional. If you do not specify the IncludeTaskIds parameter, the tasks that are specified by the `RootTaskIds` parameter are included by default.``
|
|
3593
|
+
* * ManualSelection: You can specify multiple root tasks IDs. The `IncludeTaskIds` parameter is optional. If you do not specify the IncludeTaskIds parameter, the tasks that are specified by the `RootTaskIds` parameter are included by default.``
|
|
3594
|
+
* * Chain: The value of the `RootTaskIds` parameter is left empty. You must set the `IncludeTaskIds` parameter to the start task ID and the end task ID.
|
|
3595
|
+
* * AllDownstream: You can specify only one root task ID.``
|
|
3588
3596
|
*
|
|
3589
3597
|
* @example
|
|
3590
3598
|
* ManualSelection
|
|
@@ -3592,9 +3600,10 @@ export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends
|
|
|
3592
3600
|
mode?: string;
|
|
3593
3601
|
/**
|
|
3594
3602
|
* @remarks
|
|
3595
|
-
* The running
|
|
3596
|
-
*
|
|
3597
|
-
*
|
|
3603
|
+
* The running order. Default value: Asc. Valid values:
|
|
3604
|
+
*
|
|
3605
|
+
* * Asc: The tasks are sorted by data timestamp in ascending order.
|
|
3606
|
+
* * Desc: The tasks are sorted by data timestamp in descending order.
|
|
3598
3607
|
*
|
|
3599
3608
|
* @example
|
|
3600
3609
|
* Asc
|
|
@@ -3602,7 +3611,7 @@ export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends
|
|
|
3602
3611
|
order?: string;
|
|
3603
3612
|
/**
|
|
3604
3613
|
* @remarks
|
|
3605
|
-
* The number of
|
|
3614
|
+
* The number of tasks that can be run in parallel. If you specify the value to 2 to 10, the value indicates the number of tasks that can be run in parallel. If you specify the value to 1, the tasks are run one by one.
|
|
3606
3615
|
*
|
|
3607
3616
|
* @example
|
|
3608
3617
|
* 2
|
|
@@ -3610,17 +3619,17 @@ export declare class CreateWorkflowInstancesRequestDefaultRunProperties extends
|
|
|
3610
3619
|
parallelism?: number;
|
|
3611
3620
|
/**
|
|
3612
3621
|
* @remarks
|
|
3613
|
-
* The
|
|
3622
|
+
* The root task IDs.
|
|
3614
3623
|
*/
|
|
3615
3624
|
rootTaskIds?: number[];
|
|
3616
3625
|
/**
|
|
3617
3626
|
* @remarks
|
|
3618
|
-
*
|
|
3627
|
+
* The data backfill policy. If you leave this parameter empty, the runtime configuration is used.
|
|
3619
3628
|
*/
|
|
3620
3629
|
runPolicy?: CreateWorkflowInstancesRequestDefaultRunPropertiesRunPolicy;
|
|
3621
3630
|
/**
|
|
3622
3631
|
* @remarks
|
|
3623
|
-
* The identifier of the custom
|
|
3632
|
+
* The identifier of the custom resource group for scheduling. If you leave this parameter empty, the runtime configuration is used.
|
|
3624
3633
|
*
|
|
3625
3634
|
* @example
|
|
3626
3635
|
* S_res_group_524258031846018_1684XXXXXXXXX
|
|
@@ -5196,7 +5205,7 @@ export declare class GetDIJobResponseBodyPagingInfo extends $dara.Model {
|
|
|
5196
5205
|
destinationDataSourceSettings?: GetDIJobResponseBodyPagingInfoDestinationDataSourceSettings[];
|
|
5197
5206
|
/**
|
|
5198
5207
|
* @remarks
|
|
5199
|
-
* The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute,
|
|
5208
|
+
* The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB_For_MySQL, Kafka, Hive.
|
|
5200
5209
|
*
|
|
5201
5210
|
* @example
|
|
5202
5211
|
* Hologres
|
|
@@ -5231,6 +5240,7 @@ export declare class GetDIJobResponseBodyPagingInfo extends $dara.Model {
|
|
|
5231
5240
|
* Running
|
|
5232
5241
|
*/
|
|
5233
5242
|
jobStatus?: string;
|
|
5243
|
+
jobType?: string;
|
|
5234
5244
|
/**
|
|
5235
5245
|
* @remarks
|
|
5236
5246
|
* The synchronization type. Valid values:
|
|
@@ -5267,7 +5277,7 @@ export declare class GetDIJobResponseBodyPagingInfo extends $dara.Model {
|
|
|
5267
5277
|
sourceDataSourceSettings?: GetDIJobResponseBodyPagingInfoSourceDataSourceSettings[];
|
|
5268
5278
|
/**
|
|
5269
5279
|
* @remarks
|
|
5270
|
-
* The source type. Valid values: PolarDB, MySQL, Kafka,
|
|
5280
|
+
* The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive, SQLServer, Doris, ClickHouse.
|
|
5271
5281
|
*
|
|
5272
5282
|
* @example
|
|
5273
5283
|
* Mysql
|
|
@@ -5614,10 +5624,10 @@ export declare class GetDataQualityEvaluationTaskResponseBodyDataQualityEvaluati
|
|
|
5614
5624
|
export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskHooks extends $dara.Model {
|
|
5615
5625
|
/**
|
|
5616
5626
|
* @remarks
|
|
5617
|
-
*
|
|
5627
|
+
* The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported:
|
|
5618
5628
|
*
|
|
5619
|
-
*
|
|
5620
|
-
*
|
|
5629
|
+
* * Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.
|
|
5630
|
+
* * Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.
|
|
5621
5631
|
*
|
|
5622
5632
|
* @example
|
|
5623
5633
|
* (${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")
|
|
@@ -5721,10 +5731,10 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
|
|
|
5721
5731
|
export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskNotifications extends $dara.Model {
|
|
5722
5732
|
/**
|
|
5723
5733
|
* @remarks
|
|
5724
|
-
* The notification trigger condition. When this condition is met,
|
|
5734
|
+
* The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported:
|
|
5725
5735
|
*
|
|
5726
|
-
*
|
|
5727
|
-
*
|
|
5736
|
+
* * Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.
|
|
5737
|
+
* * Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.
|
|
5728
5738
|
*
|
|
5729
5739
|
* @example
|
|
5730
5740
|
* ${severity} == "High" AND ${status} == "Critical"
|
|
@@ -5799,10 +5809,10 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
|
|
|
5799
5809
|
taskIds?: number[];
|
|
5800
5810
|
/**
|
|
5801
5811
|
* @remarks
|
|
5802
|
-
*
|
|
5812
|
+
* The trigger type of the monitor. Valid values:
|
|
5803
5813
|
*
|
|
5804
|
-
*
|
|
5805
|
-
*
|
|
5814
|
+
* * ByManual (default): The monitor is manually triggered.
|
|
5815
|
+
* * ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.
|
|
5806
5816
|
*
|
|
5807
5817
|
* @example
|
|
5808
5818
|
* ByScheduledTaskInstance
|
|
@@ -5830,7 +5840,7 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
|
|
|
5830
5840
|
description?: string;
|
|
5831
5841
|
/**
|
|
5832
5842
|
* @remarks
|
|
5833
|
-
*
|
|
5843
|
+
* The hook.
|
|
5834
5844
|
*/
|
|
5835
5845
|
hooks?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskHooks[];
|
|
5836
5846
|
/**
|
|
@@ -5877,12 +5887,12 @@ export declare class GetDataQualityEvaluationTaskInstanceResponseBodyDataQuality
|
|
|
5877
5887
|
runtimeConf?: string;
|
|
5878
5888
|
/**
|
|
5879
5889
|
* @remarks
|
|
5880
|
-
*
|
|
5890
|
+
* The monitored object of the monitor.
|
|
5881
5891
|
*/
|
|
5882
5892
|
target?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskTarget;
|
|
5883
5893
|
/**
|
|
5884
5894
|
* @remarks
|
|
5885
|
-
* The trigger configuration of the
|
|
5895
|
+
* The trigger configuration of the monitor.
|
|
5886
5896
|
*/
|
|
5887
5897
|
trigger?: GetDataQualityEvaluationTaskInstanceResponseBodyDataQualityEvaluationTaskInstanceTaskTrigger;
|
|
5888
5898
|
static names(): {
|
|
@@ -10142,8 +10152,8 @@ export declare class GetWorkflowInstanceResponseBodyWorkflowInstance extends $da
|
|
|
10142
10152
|
* @remarks
|
|
10143
10153
|
* The environment of the workspace. Valid values:
|
|
10144
10154
|
*
|
|
10145
|
-
* * Prod
|
|
10146
|
-
* * Dev
|
|
10155
|
+
* * Prod
|
|
10156
|
+
* * Dev
|
|
10147
10157
|
*
|
|
10148
10158
|
* @example
|
|
10149
10159
|
* Prod
|
|
@@ -11528,7 +11538,7 @@ export declare class ListDIJobsResponseBodyPagingInfoDIJobs extends $dara.Model
|
|
|
11528
11538
|
DIJobId?: number;
|
|
11529
11539
|
/**
|
|
11530
11540
|
* @remarks
|
|
11531
|
-
* The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS,
|
|
11541
|
+
* The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS, DataHub, ANALYTICDB_FOR_MYSQL, Kafka, and Hive.
|
|
11532
11542
|
*
|
|
11533
11543
|
* @example
|
|
11534
11544
|
* Hologres
|
|
@@ -14114,7 +14124,10 @@ export declare class ListDataSourcesResponseBodyPagingInfoDataSourcesDataSource
|
|
|
14114
14124
|
connectionProperties?: any;
|
|
14115
14125
|
/**
|
|
14116
14126
|
* @remarks
|
|
14117
|
-
* The mode in which the data source is added. The mode varies based on the data source type. Valid values:
|
|
14127
|
+
* The mode in which the data source is added. The mode varies based on the data source type. Valid values:
|
|
14128
|
+
*
|
|
14129
|
+
* * InstanceMode: instance mode
|
|
14130
|
+
* * UrlMode: connection string mode
|
|
14118
14131
|
*
|
|
14119
14132
|
* @example
|
|
14120
14133
|
* UrlMode
|
|
@@ -15076,9 +15089,6 @@ export declare class ListDownstreamTaskInstancesResponseBodyPagingInfoTaskInstan
|
|
|
15076
15089
|
* @remarks
|
|
15077
15090
|
* The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:
|
|
15078
15091
|
*
|
|
15079
|
-
* * Prod: production environment
|
|
15080
|
-
* * Dev: development environment
|
|
15081
|
-
*
|
|
15082
15092
|
* @example
|
|
15083
15093
|
* Prod
|
|
15084
15094
|
*
|
|
@@ -18044,8 +18054,8 @@ export declare class ListProjectMembersResponseBodyPagingInfoProjectMembersRoles
|
|
|
18044
18054
|
* @remarks
|
|
18045
18055
|
* The type of the role. Valid values:
|
|
18046
18056
|
*
|
|
18047
|
-
* * UserCustom:
|
|
18048
|
-
* * System:
|
|
18057
|
+
* * UserCustom: user-defined role
|
|
18058
|
+
* * System: system role
|
|
18049
18059
|
*
|
|
18050
18060
|
* @example
|
|
18051
18061
|
* System
|
|
@@ -20166,8 +20176,8 @@ export declare class ListUpstreamTaskInstancesResponseBodyPagingInfoTaskInstance
|
|
|
20166
20176
|
* @remarks
|
|
20167
20177
|
* The environment of the workspace. Valid values:
|
|
20168
20178
|
*
|
|
20169
|
-
* * Prod
|
|
20170
|
-
* * Dev
|
|
20179
|
+
* * Prod
|
|
20180
|
+
* * Dev
|
|
20171
20181
|
*
|
|
20172
20182
|
* @example
|
|
20173
20183
|
* Prod
|
|
@@ -21074,9 +21084,8 @@ export declare class ListUpstreamTasksResponseBodyPagingInfoTasks extends $dara.
|
|
|
21074
21084
|
* @remarks
|
|
21075
21085
|
* The instance generation mode. Valid values:
|
|
21076
21086
|
*
|
|
21077
|
-
* T+1
|
|
21078
|
-
*
|
|
21079
|
-
* Immediately
|
|
21087
|
+
* * T+1
|
|
21088
|
+
* * Immediately
|
|
21080
21089
|
*
|
|
21081
21090
|
* @example
|
|
21082
21091
|
* T+1
|
|
@@ -21184,9 +21193,8 @@ export declare class ListUpstreamTasksResponseBodyPagingInfoTasks extends $dara.
|
|
|
21184
21193
|
* @remarks
|
|
21185
21194
|
* The scheduling dependency type. Valid values:
|
|
21186
21195
|
*
|
|
21187
|
-
* Normal: same-cycle scheduling dependency
|
|
21188
|
-
*
|
|
21189
|
-
* CrossCycle: cross-cycle scheduling dependency
|
|
21196
|
+
* * Normal: same-cycle scheduling dependency
|
|
21197
|
+
* * CrossCycle: cross-cycle scheduling dependency
|
|
21190
21198
|
*
|
|
21191
21199
|
* @example
|
|
21192
21200
|
* Normal
|
|
@@ -22289,17 +22297,30 @@ export declare class TagDataAssetsRequestTags extends $dara.Model {
|
|
|
22289
22297
|
}
|
|
22290
22298
|
export declare class TestDataSourceConnectivityResponseBodyConnectivityDetailLogs extends $dara.Model {
|
|
22291
22299
|
/**
|
|
22300
|
+
* @remarks
|
|
22301
|
+
* The code of the test item.
|
|
22302
|
+
*
|
|
22292
22303
|
* @example
|
|
22293
22304
|
* validate_input_parameters
|
|
22294
22305
|
*/
|
|
22295
22306
|
code?: string;
|
|
22296
22307
|
/**
|
|
22308
|
+
* @remarks
|
|
22309
|
+
* The end time of a step.
|
|
22310
|
+
*
|
|
22297
22311
|
* @example
|
|
22298
22312
|
* 1730217604002
|
|
22299
22313
|
*/
|
|
22300
22314
|
endTime?: number;
|
|
22315
|
+
/**
|
|
22316
|
+
* @remarks
|
|
22317
|
+
* The name of the step.
|
|
22318
|
+
*/
|
|
22301
22319
|
message?: string;
|
|
22302
22320
|
/**
|
|
22321
|
+
* @remarks
|
|
22322
|
+
* The start time of a step.
|
|
22323
|
+
*
|
|
22303
22324
|
* @example
|
|
22304
22325
|
* 1730217600001
|
|
22305
22326
|
*/
|
|
@@ -22316,12 +22337,23 @@ export declare class TestDataSourceConnectivityResponseBodyConnectivityDetailLog
|
|
|
22316
22337
|
});
|
|
22317
22338
|
}
|
|
22318
22339
|
export declare class TestDataSourceConnectivityResponseBodyConnectivity extends $dara.Model {
|
|
22340
|
+
/**
|
|
22341
|
+
* @remarks
|
|
22342
|
+
* The error message returned if the connectivity test fails. No such a message is returned if the connectivity test is successful.
|
|
22343
|
+
*/
|
|
22319
22344
|
connectMessage?: string;
|
|
22320
22345
|
/**
|
|
22346
|
+
* @remarks
|
|
22347
|
+
* The result of the connectivity test. Valid values: Connectable: The network can be connected. ConfigError: The network can be connected, but the configurations are incorrect. Unreachable: The network cannot be connected. Unsupport: An error is reported due to other causes. For example, the desired resource group is being initialized.
|
|
22348
|
+
*
|
|
22321
22349
|
* @example
|
|
22322
22350
|
* Connectable
|
|
22323
22351
|
*/
|
|
22324
22352
|
connectState?: string;
|
|
22353
|
+
/**
|
|
22354
|
+
* @remarks
|
|
22355
|
+
* The detailed logs of each step in the connectivity test.
|
|
22356
|
+
*/
|
|
22325
22357
|
detailLogs?: TestDataSourceConnectivityResponseBodyConnectivityDetailLogs[];
|
|
22326
22358
|
static names(): {
|
|
22327
22359
|
[key: string]: string;
|
|
@@ -22832,7 +22864,7 @@ export declare class UpdateDIAlarmRuleRequestNotificationSettingsNotificationRec
|
|
|
22832
22864
|
export declare class UpdateDIAlarmRuleRequestNotificationSettings extends $dara.Model {
|
|
22833
22865
|
/**
|
|
22834
22866
|
* @remarks
|
|
22835
|
-
*
|
|
22867
|
+
* This parameter is deprecated and replaced by the MuteInterval parameter.
|
|
22836
22868
|
*
|
|
22837
22869
|
* @example
|
|
22838
22870
|
* 5
|
|
@@ -22872,7 +22904,7 @@ export declare class UpdateDIAlarmRuleRequestNotificationSettings extends $dara.
|
|
|
22872
22904
|
export declare class UpdateDIAlarmRuleRequestTriggerConditions extends $dara.Model {
|
|
22873
22905
|
/**
|
|
22874
22906
|
* @remarks
|
|
22875
|
-
*
|
|
22907
|
+
* This parameter is deprecated and replaced by the DdlTypes parameter.
|
|
22876
22908
|
*
|
|
22877
22909
|
* @deprecated
|
|
22878
22910
|
*/
|
|
@@ -22927,7 +22959,7 @@ export declare class UpdateDIAlarmRuleRequestTriggerConditions extends $dara.Mod
|
|
|
22927
22959
|
export declare class UpdateDIJobRequestJobSettingsColumnDataTypeSettings extends $dara.Model {
|
|
22928
22960
|
/**
|
|
22929
22961
|
* @remarks
|
|
22930
|
-
* The data type of the destination field.
|
|
22962
|
+
* The data type of the destination field. Valid values: bigint, boolean, string, text, datetime, timestamp, decimal, and binary. Different types of data sources support different data types.
|
|
22931
22963
|
*
|
|
22932
22964
|
* @example
|
|
22933
22965
|
* text
|
|
@@ -22935,7 +22967,7 @@ export declare class UpdateDIJobRequestJobSettingsColumnDataTypeSettings extends
|
|
|
22935
22967
|
destinationDataType?: string;
|
|
22936
22968
|
/**
|
|
22937
22969
|
* @remarks
|
|
22938
|
-
* The data type of the source field.
|
|
22970
|
+
* The data type of the source field. Valid values: Valid values: bigint, boolean, string, text, datetime, timestamp, decimal, and binary. Different types of data sources support different data types.
|
|
22939
22971
|
*
|
|
22940
22972
|
* @example
|
|
22941
22973
|
* bigint
|
|
@@ -23017,14 +23049,14 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
|
|
|
23017
23049
|
* @remarks
|
|
23018
23050
|
* The name of the configuration item. Valid values:
|
|
23019
23051
|
*
|
|
23020
|
-
* *
|
|
23021
|
-
* *
|
|
23022
|
-
* *
|
|
23023
|
-
* * runtime.offline.concurrent:
|
|
23024
|
-
* *
|
|
23025
|
-
* * runtime.
|
|
23026
|
-
* *
|
|
23027
|
-
* * runtime.realtime.
|
|
23052
|
+
* * 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.
|
|
23053
|
+
* * dst.offline.truncate: specifies whether to clear the destination table before data writing.
|
|
23054
|
+
* * runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.
|
|
23055
|
+
* * runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.
|
|
23056
|
+
* * runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.
|
|
23057
|
+
* * runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.
|
|
23058
|
+
* * runtime.realtime.failover.minute.dataxcdc: specifies the maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.
|
|
23059
|
+
* * runtime.realtime.failover.times.dataxcdc: specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.
|
|
23028
23060
|
*
|
|
23029
23061
|
* @example
|
|
23030
23062
|
* runtime.offline.concurrent
|
|
@@ -23052,7 +23084,21 @@ export declare class UpdateDIJobRequestJobSettingsRuntimeSettings extends $dara.
|
|
|
23052
23084
|
export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
|
|
23053
23085
|
/**
|
|
23054
23086
|
* @remarks
|
|
23055
|
-
* The channel control settings for the synchronization task.
|
|
23087
|
+
* The channel control settings for the synchronization task. You can configure special channel control settings for the following synchronization links: data synchronization between Hologres data sources and data synchronization from Hologres to Kafka.
|
|
23088
|
+
*
|
|
23089
|
+
* 1. Holo2Kafka
|
|
23090
|
+
*
|
|
23091
|
+
* * Example: {"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}
|
|
23092
|
+
* * kafkaClientProperties: the parameters related to a Kafka producer, which are used when you read data from a Kafka data source.
|
|
23093
|
+
* * keyColumns: the names of Kafka columns to which you want to write data.
|
|
23094
|
+
* * writeMode: the writing format. Valid values: json and canal.
|
|
23095
|
+
*
|
|
23096
|
+
* 2. Holo2Holo
|
|
23097
|
+
*
|
|
23098
|
+
* * Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}
|
|
23099
|
+
* * conflictMode: the policy used to handle a conflict that occurs during data writing to Hologres. Valid values: replace and ignore.
|
|
23100
|
+
* * writeMode: the mode in which you want to write data to Hologres. Valid values: replay and insert.
|
|
23101
|
+
* * dynamicColumnAction: the mode in which you want to write data to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.
|
|
23056
23102
|
*
|
|
23057
23103
|
* @example
|
|
23058
23104
|
* {"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}
|
|
@@ -23061,6 +23107,8 @@ export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
|
|
|
23061
23107
|
/**
|
|
23062
23108
|
* @remarks
|
|
23063
23109
|
* The data type mappings between source fields and destination fields.
|
|
23110
|
+
*
|
|
23111
|
+
* > "ColumnDataTypeSettings":[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]
|
|
23064
23112
|
*/
|
|
23065
23113
|
columnDataTypeSettings?: UpdateDIJobRequestJobSettingsColumnDataTypeSettings[];
|
|
23066
23114
|
/**
|
|
@@ -23071,6 +23119,8 @@ export declare class UpdateDIJobRequestJobSettings extends $dara.Model {
|
|
|
23071
23119
|
/**
|
|
23072
23120
|
* @remarks
|
|
23073
23121
|
* The processing settings for DDL messages.
|
|
23122
|
+
*
|
|
23123
|
+
* > "DDLHandlingSettings":[ { "Type":"Insert", "Action":"Normal" } ]
|
|
23074
23124
|
*/
|
|
23075
23125
|
ddlHandlingSettings?: UpdateDIJobRequestJobSettingsDdlHandlingSettings[];
|
|
23076
23126
|
/**
|
|
@@ -23230,6 +23280,7 @@ export declare class UpdateDIJobRequestTableMappingsSourceObjectSelectionRules e
|
|
|
23230
23280
|
* The object type. Valid values:
|
|
23231
23281
|
*
|
|
23232
23282
|
* * Table
|
|
23283
|
+
* * Schema
|
|
23233
23284
|
* * Database
|
|
23234
23285
|
*
|
|
23235
23286
|
* @example
|
|
@@ -23275,6 +23326,7 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
|
|
|
23275
23326
|
*
|
|
23276
23327
|
* * Table
|
|
23277
23328
|
* * Schema
|
|
23329
|
+
* * Database
|
|
23278
23330
|
*
|
|
23279
23331
|
* @example
|
|
23280
23332
|
* Table
|
|
@@ -23294,12 +23346,12 @@ export declare class UpdateDIJobRequestTableMappingsTransformationRules extends
|
|
|
23294
23346
|
export declare class UpdateDIJobRequestTableMappings extends $dara.Model {
|
|
23295
23347
|
/**
|
|
23296
23348
|
* @remarks
|
|
23297
|
-
* The list of rules
|
|
23349
|
+
* The list of rules that you want to use to select synchronization objects in the source.
|
|
23298
23350
|
*/
|
|
23299
23351
|
sourceObjectSelectionRules?: UpdateDIJobRequestTableMappingsSourceObjectSelectionRules[];
|
|
23300
23352
|
/**
|
|
23301
23353
|
* @remarks
|
|
23302
|
-
* The
|
|
23354
|
+
* The transformation rules that you want to apply to the synchronization objects selected from the source.
|
|
23303
23355
|
*/
|
|
23304
23356
|
transformationRules?: UpdateDIJobRequestTableMappingsTransformationRules[];
|
|
23305
23357
|
static names(): {
|
|
@@ -23322,6 +23374,9 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
|
|
|
23322
23374
|
* * Rename
|
|
23323
23375
|
* * AddColumn
|
|
23324
23376
|
* * HandleDml
|
|
23377
|
+
* * DefineIncrementalCondition
|
|
23378
|
+
* * DefineCycleScheduleSettings
|
|
23379
|
+
* * DefinePartitionKey
|
|
23325
23380
|
*
|
|
23326
23381
|
* @example
|
|
23327
23382
|
* Rename
|
|
@@ -23331,15 +23386,48 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
|
|
|
23331
23386
|
* @remarks
|
|
23332
23387
|
* The expression of the rule. The expression must be a JSON string.
|
|
23333
23388
|
*
|
|
23334
|
-
* Example of a renaming rule
|
|
23389
|
+
* 1. Example of a renaming rule
|
|
23390
|
+
*
|
|
23391
|
+
* * Example: {"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }
|
|
23392
|
+
* * expression: the expression of the renaming rule. You can use the following variables in an expression: ${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.
|
|
23393
|
+
*
|
|
23394
|
+
* 2. Example of a column addition rule
|
|
23395
|
+
*
|
|
23396
|
+
* * Example: {"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}
|
|
23397
|
+
* * If you do not configure such a rule, no fields are added to the destination and no values are assigned by default.
|
|
23398
|
+
* * columnName: the name of the field that is added.
|
|
23399
|
+
* * columnValueType: the value type of the field. Valid values: Constant and Variable.
|
|
23400
|
+
* * columnValue: the value of the field. If the columnValueType parameter is set to Constant, set the columnValue parameter to a constant of the STRING data type. If the columnValueType parameter is set to Variable, set the columnValue parameter 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 specifies 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.
|
|
23401
|
+
*
|
|
23402
|
+
* 3. Example of a rule used to specify primary key fields for a destination table
|
|
23403
|
+
*
|
|
23404
|
+
* * Example: {"columns":["ukcolumn1","ukcolumn2"]}
|
|
23405
|
+
* * 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.
|
|
23406
|
+
* * 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.
|
|
23407
|
+
* * 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.
|
|
23408
|
+
*
|
|
23409
|
+
* 4. Example of a rule used to process DML messages
|
|
23335
23410
|
*
|
|
23336
|
-
*
|
|
23411
|
+
* * Example: {"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}
|
|
23412
|
+
* * If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal.
|
|
23413
|
+
* * dmlType: the DML operation. Valid values: Insert, Update, and Delete.
|
|
23414
|
+
* * 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.
|
|
23415
|
+
* * filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.
|
|
23416
|
+
*
|
|
23417
|
+
* 5. Example of a rule used to perform incremental synchronization
|
|
23418
|
+
*
|
|
23419
|
+
* * Example: {"where":"id > 0"}
|
|
23420
|
+
* * You can configure such a rule to perform incremental synchronization.
|
|
23337
23421
|
*
|
|
23338
|
-
*
|
|
23422
|
+
* 6. Example of a rule used to configure scheduling parameters for an auto triggered task
|
|
23339
23423
|
*
|
|
23340
|
-
*
|
|
23424
|
+
* * Example: {"cronExpress":" \\* \\* \\* \\* \\* \\*", "cycleType":"1"}
|
|
23425
|
+
* * You can configure such a rule to configure scheduling parameters for an auto triggered task.
|
|
23341
23426
|
*
|
|
23342
|
-
*
|
|
23427
|
+
* 7. Example of a rule used to specify a partition key
|
|
23428
|
+
*
|
|
23429
|
+
* * Example: {"columns":["id"]}
|
|
23430
|
+
* * You can configure such a rule to specify a partition key.
|
|
23343
23431
|
*
|
|
23344
23432
|
* @example
|
|
23345
23433
|
* {"expression":"${srcDatasoureName}_${srcDatabaseName}"}
|
|
@@ -23359,6 +23447,7 @@ export declare class UpdateDIJobRequestTransformationRules extends $dara.Model {
|
|
|
23359
23447
|
*
|
|
23360
23448
|
* * Table
|
|
23361
23449
|
* * Schema
|
|
23450
|
+
* * Database
|
|
23362
23451
|
*
|
|
23363
23452
|
* @example
|
|
23364
23453
|
* Table
|
|
@@ -25234,8 +25323,8 @@ export declare class UpdateWorkflowRequestTasksTrigger extends $dara.Model {
|
|
|
25234
25323
|
* @remarks
|
|
25235
25324
|
* The trigger type. Valid values:
|
|
25236
25325
|
*
|
|
25237
|
-
* * Scheduler:
|
|
25238
|
-
* * Manual: manual
|
|
25326
|
+
* * Scheduler: scheduling cycle-based trigger
|
|
25327
|
+
* * Manual: manual trigger
|
|
25239
25328
|
*
|
|
25240
25329
|
* @example
|
|
25241
25330
|
* Scheduler
|
|
@@ -26576,6 +26665,7 @@ export declare class CreateDIJobRequest extends $dara.Model {
|
|
|
26576
26665
|
* The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.
|
|
26577
26666
|
*/
|
|
26578
26667
|
jobSettings?: CreateDIJobRequestJobSettings;
|
|
26668
|
+
jobType?: string;
|
|
26579
26669
|
/**
|
|
26580
26670
|
* @remarks
|
|
26581
26671
|
* The synchronization type. Valid values:
|
|
@@ -26702,6 +26792,7 @@ export declare class CreateDIJobShrinkRequest extends $dara.Model {
|
|
|
26702
26792
|
* The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.
|
|
26703
26793
|
*/
|
|
26704
26794
|
jobSettingsShrink?: string;
|
|
26795
|
+
jobType?: string;
|
|
26705
26796
|
/**
|
|
26706
26797
|
* @remarks
|
|
26707
26798
|
* The synchronization type. Valid values:
|
|
@@ -27003,6 +27094,8 @@ export declare class CreateDataQualityEvaluationTaskRequest extends $dara.Model
|
|
|
27003
27094
|
* @remarks
|
|
27004
27095
|
* The data source ID. You can call the [ListDataSources](https://help.aliyun.com/document_detail/211431.html) operation to query the ID.
|
|
27005
27096
|
*
|
|
27097
|
+
* This parameter is required.
|
|
27098
|
+
*
|
|
27006
27099
|
* @example
|
|
27007
27100
|
* 1
|
|
27008
27101
|
*/
|
|
@@ -27041,6 +27134,8 @@ export declare class CreateDataQualityEvaluationTaskRequest extends $dara.Model
|
|
|
27041
27134
|
*
|
|
27042
27135
|
* You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.
|
|
27043
27136
|
*
|
|
27137
|
+
* This parameter is required.
|
|
27138
|
+
*
|
|
27044
27139
|
* @example
|
|
27045
27140
|
* 10000
|
|
27046
27141
|
*/
|
|
@@ -27063,6 +27158,8 @@ export declare class CreateDataQualityEvaluationTaskRequest extends $dara.Model
|
|
|
27063
27158
|
/**
|
|
27064
27159
|
* @remarks
|
|
27065
27160
|
* The monitored object of the monitor.
|
|
27161
|
+
*
|
|
27162
|
+
* This parameter is required.
|
|
27066
27163
|
*/
|
|
27067
27164
|
target?: CreateDataQualityEvaluationTaskRequestTarget;
|
|
27068
27165
|
/**
|
|
@@ -27091,6 +27188,8 @@ export declare class CreateDataQualityEvaluationTaskShrinkRequest extends $dara.
|
|
|
27091
27188
|
* @remarks
|
|
27092
27189
|
* The data source ID. You can call the [ListDataSources](https://help.aliyun.com/document_detail/211431.html) operation to query the ID.
|
|
27093
27190
|
*
|
|
27191
|
+
* This parameter is required.
|
|
27192
|
+
*
|
|
27094
27193
|
* @example
|
|
27095
27194
|
* 1
|
|
27096
27195
|
*/
|
|
@@ -27129,6 +27228,8 @@ export declare class CreateDataQualityEvaluationTaskShrinkRequest extends $dara.
|
|
|
27129
27228
|
*
|
|
27130
27229
|
* You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.
|
|
27131
27230
|
*
|
|
27231
|
+
* This parameter is required.
|
|
27232
|
+
*
|
|
27132
27233
|
* @example
|
|
27133
27234
|
* 10000
|
|
27134
27235
|
*/
|
|
@@ -27151,6 +27252,8 @@ export declare class CreateDataQualityEvaluationTaskShrinkRequest extends $dara.
|
|
|
27151
27252
|
/**
|
|
27152
27253
|
* @remarks
|
|
27153
27254
|
* The monitored object of the monitor.
|
|
27255
|
+
*
|
|
27256
|
+
* This parameter is required.
|
|
27154
27257
|
*/
|
|
27155
27258
|
targetShrink?: string;
|
|
27156
27259
|
/**
|
|
@@ -29483,14 +29586,15 @@ export declare class CreateWorkflowInstancesRequest extends $dara.Model {
|
|
|
29483
29586
|
comment?: string;
|
|
29484
29587
|
/**
|
|
29485
29588
|
* @remarks
|
|
29486
|
-
*
|
|
29589
|
+
* The runtime configuration.
|
|
29487
29590
|
*/
|
|
29488
29591
|
defaultRunProperties?: CreateWorkflowInstancesRequestDefaultRunProperties;
|
|
29489
29592
|
/**
|
|
29490
29593
|
* @remarks
|
|
29491
|
-
* The
|
|
29492
|
-
*
|
|
29493
|
-
*
|
|
29594
|
+
* The environment of the workspace. Valid values:
|
|
29595
|
+
*
|
|
29596
|
+
* * Prod: production environment
|
|
29597
|
+
* * Dev: development environment
|
|
29494
29598
|
*
|
|
29495
29599
|
* @example
|
|
29496
29600
|
* Prod
|
|
@@ -29534,10 +29638,10 @@ export declare class CreateWorkflowInstancesRequest extends $dara.Model {
|
|
|
29534
29638
|
taskParameters?: string;
|
|
29535
29639
|
/**
|
|
29536
29640
|
* @remarks
|
|
29537
|
-
* The type of the workflow instance.
|
|
29641
|
+
* The type of the workflow instance. Valid values:
|
|
29538
29642
|
*
|
|
29539
|
-
*
|
|
29540
|
-
*
|
|
29643
|
+
* * SupplementData
|
|
29644
|
+
* * ManualWorkflow
|
|
29541
29645
|
*
|
|
29542
29646
|
* This parameter is required.
|
|
29543
29647
|
*
|
|
@@ -29596,14 +29700,15 @@ export declare class CreateWorkflowInstancesShrinkRequest extends $dara.Model {
|
|
|
29596
29700
|
comment?: string;
|
|
29597
29701
|
/**
|
|
29598
29702
|
* @remarks
|
|
29599
|
-
*
|
|
29703
|
+
* The runtime configuration.
|
|
29600
29704
|
*/
|
|
29601
29705
|
defaultRunPropertiesShrink?: string;
|
|
29602
29706
|
/**
|
|
29603
29707
|
* @remarks
|
|
29604
|
-
* The
|
|
29605
|
-
*
|
|
29606
|
-
*
|
|
29708
|
+
* The environment of the workspace. Valid values:
|
|
29709
|
+
*
|
|
29710
|
+
* * Prod: production environment
|
|
29711
|
+
* * Dev: development environment
|
|
29607
29712
|
*
|
|
29608
29713
|
* @example
|
|
29609
29714
|
* Prod
|
|
@@ -29647,10 +29752,10 @@ export declare class CreateWorkflowInstancesShrinkRequest extends $dara.Model {
|
|
|
29647
29752
|
taskParameters?: string;
|
|
29648
29753
|
/**
|
|
29649
29754
|
* @remarks
|
|
29650
|
-
* The type of the workflow instance.
|
|
29755
|
+
* The type of the workflow instance. Valid values:
|
|
29651
29756
|
*
|
|
29652
|
-
*
|
|
29653
|
-
*
|
|
29757
|
+
* * SupplementData
|
|
29758
|
+
* * ManualWorkflow
|
|
29654
29759
|
*
|
|
29655
29760
|
* This parameter is required.
|
|
29656
29761
|
*
|
|
@@ -29803,6 +29908,8 @@ export declare class DeleteAlertRuleResponse extends $dara.Model {
|
|
|
29803
29908
|
export declare class DeleteCertificateRequest extends $dara.Model {
|
|
29804
29909
|
/**
|
|
29805
29910
|
* @remarks
|
|
29911
|
+
* The ID of the certificate file.
|
|
29912
|
+
*
|
|
29806
29913
|
* This parameter is required.
|
|
29807
29914
|
*
|
|
29808
29915
|
* @example
|
|
@@ -29810,6 +29917,9 @@ export declare class DeleteCertificateRequest extends $dara.Model {
|
|
|
29810
29917
|
*/
|
|
29811
29918
|
id?: number;
|
|
29812
29919
|
/**
|
|
29920
|
+
* @remarks
|
|
29921
|
+
* The ID of the workspace to which the certificate file belongs.
|
|
29922
|
+
*
|
|
29813
29923
|
* @example
|
|
29814
29924
|
* 106560
|
|
29815
29925
|
*/
|
|
@@ -29827,11 +29937,17 @@ export declare class DeleteCertificateRequest extends $dara.Model {
|
|
|
29827
29937
|
}
|
|
29828
29938
|
export declare class DeleteCertificateResponseBody extends $dara.Model {
|
|
29829
29939
|
/**
|
|
29940
|
+
* @remarks
|
|
29941
|
+
* The request ID.
|
|
29942
|
+
*
|
|
29830
29943
|
* @example
|
|
29831
29944
|
* D9A61DC0-B922-421B-B706
|
|
29832
29945
|
*/
|
|
29833
29946
|
requestId?: string;
|
|
29834
29947
|
/**
|
|
29948
|
+
* @remarks
|
|
29949
|
+
* Indicates whether the request was successful.
|
|
29950
|
+
*
|
|
29835
29951
|
* @example
|
|
29836
29952
|
* true
|
|
29837
29953
|
*/
|
|
@@ -30800,7 +30916,7 @@ export declare class DeleteProjectMemberRequest extends $dara.Model {
|
|
|
30800
30916
|
projectId?: number;
|
|
30801
30917
|
/**
|
|
30802
30918
|
* @remarks
|
|
30803
|
-
* The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.
|
|
30919
|
+
* The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the **Tenant Members and Roles** page, view the ID of the account used by the member in the workspace.
|
|
30804
30920
|
*
|
|
30805
30921
|
* This parameter is required.
|
|
30806
30922
|
*
|
|
@@ -32109,10 +32225,10 @@ export declare class GetDIJobLogRequest extends $dara.Model {
|
|
|
32109
32225
|
instanceId?: number;
|
|
32110
32226
|
/**
|
|
32111
32227
|
* @remarks
|
|
32112
|
-
*
|
|
32228
|
+
* The type of the node. This parameter is applicable only to the tasks that are run on serverless resource groups. Valid values:
|
|
32113
32229
|
*
|
|
32114
|
-
*
|
|
32115
|
-
*
|
|
32230
|
+
* * **MASTER**: the master node, which is used to query the logs of JobManagers.
|
|
32231
|
+
* * **WORKER**: the worker node, which is used to query the logs of TaskManagers.
|
|
32116
32232
|
*
|
|
32117
32233
|
* @example
|
|
32118
32234
|
* MASTER
|
|
@@ -32941,7 +33057,7 @@ export declare class GetProjectMemberRequest extends $dara.Model {
|
|
|
32941
33057
|
projectId?: number;
|
|
32942
33058
|
/**
|
|
32943
33059
|
* @remarks
|
|
32944
|
-
* The ID of the account used by the member. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the
|
|
33060
|
+
* The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.
|
|
32945
33061
|
*
|
|
32946
33062
|
* This parameter is required.
|
|
32947
33063
|
*
|
|
@@ -35981,7 +36097,7 @@ export declare class ListDataSourcesRequest extends $dara.Model {
|
|
|
35981
36097
|
* * Desc: descending order
|
|
35982
36098
|
* * Asc: ascending order
|
|
35983
36099
|
*
|
|
35984
|
-
* Default value:
|
|
36100
|
+
* Default value: Desc
|
|
35985
36101
|
*
|
|
35986
36102
|
* @example
|
|
35987
36103
|
* Asc
|
|
@@ -36023,7 +36139,7 @@ export declare class ListDataSourcesRequest extends $dara.Model {
|
|
|
36023
36139
|
* * Id
|
|
36024
36140
|
* * Name
|
|
36025
36141
|
*
|
|
36026
|
-
* Default value:
|
|
36142
|
+
* Default value: CreateTime
|
|
36027
36143
|
*
|
|
36028
36144
|
* @example
|
|
36029
36145
|
* Id
|
|
@@ -36034,7 +36150,7 @@ export declare class ListDataSourcesRequest extends $dara.Model {
|
|
|
36034
36150
|
* The tag of the data source. This parameter specifies a filter condition.
|
|
36035
36151
|
*
|
|
36036
36152
|
* * You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`.
|
|
36037
|
-
* * If you do not configure this parameter, tag-based filtering is not performed.
|
|
36153
|
+
* * If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.
|
|
36038
36154
|
*
|
|
36039
36155
|
* @example
|
|
36040
36156
|
* ["tag1", "tag2", "tag3"]
|
|
@@ -36083,7 +36199,7 @@ export declare class ListDataSourcesShrinkRequest extends $dara.Model {
|
|
|
36083
36199
|
* * Desc: descending order
|
|
36084
36200
|
* * Asc: ascending order
|
|
36085
36201
|
*
|
|
36086
|
-
* Default value:
|
|
36202
|
+
* Default value: Desc
|
|
36087
36203
|
*
|
|
36088
36204
|
* @example
|
|
36089
36205
|
* Asc
|
|
@@ -36125,7 +36241,7 @@ export declare class ListDataSourcesShrinkRequest extends $dara.Model {
|
|
|
36125
36241
|
* * Id
|
|
36126
36242
|
* * Name
|
|
36127
36243
|
*
|
|
36128
|
-
* Default value:
|
|
36244
|
+
* Default value: CreateTime
|
|
36129
36245
|
*
|
|
36130
36246
|
* @example
|
|
36131
36247
|
* Id
|
|
@@ -36136,7 +36252,7 @@ export declare class ListDataSourcesShrinkRequest extends $dara.Model {
|
|
|
36136
36252
|
* The tag of the data source. This parameter specifies a filter condition.
|
|
36137
36253
|
*
|
|
36138
36254
|
* * You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`.
|
|
36139
|
-
* * If you do not configure this parameter, tag-based filtering is not performed.
|
|
36255
|
+
* * If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.
|
|
36140
36256
|
*
|
|
36141
36257
|
* @example
|
|
36142
36258
|
* ["tag1", "tag2", "tag3"]
|
|
@@ -37305,18 +37421,6 @@ export declare class ListProjectsRequest extends $dara.Model {
|
|
|
37305
37421
|
* * Updating
|
|
37306
37422
|
* * UpdateFailed
|
|
37307
37423
|
*
|
|
37308
|
-
* <!---->
|
|
37309
|
-
*
|
|
37310
|
-
* *
|
|
37311
|
-
* *
|
|
37312
|
-
* *
|
|
37313
|
-
* *
|
|
37314
|
-
* *
|
|
37315
|
-
* *
|
|
37316
|
-
* *
|
|
37317
|
-
* *
|
|
37318
|
-
* *
|
|
37319
|
-
*
|
|
37320
37424
|
* @example
|
|
37321
37425
|
* Available
|
|
37322
37426
|
*/
|
|
@@ -37421,18 +37525,6 @@ export declare class ListProjectsShrinkRequest extends $dara.Model {
|
|
|
37421
37525
|
* * Updating
|
|
37422
37526
|
* * UpdateFailed
|
|
37423
37527
|
*
|
|
37424
|
-
* <!---->
|
|
37425
|
-
*
|
|
37426
|
-
* *
|
|
37427
|
-
* *
|
|
37428
|
-
* *
|
|
37429
|
-
* *
|
|
37430
|
-
* *
|
|
37431
|
-
* *
|
|
37432
|
-
* *
|
|
37433
|
-
* *
|
|
37434
|
-
* *
|
|
37435
|
-
*
|
|
37436
37528
|
* @example
|
|
37437
37529
|
* Available
|
|
37438
37530
|
*/
|
|
@@ -38645,7 +38737,28 @@ export declare class ListTasksRequest extends $dara.Model {
|
|
|
38645
38737
|
sortBy?: string;
|
|
38646
38738
|
/**
|
|
38647
38739
|
* @remarks
|
|
38648
|
-
* The type of the task.
|
|
38740
|
+
* The type of the task. Valid values:
|
|
38741
|
+
*
|
|
38742
|
+
* * ODPS_SQL
|
|
38743
|
+
* * SPARK
|
|
38744
|
+
* * PY_ODPS
|
|
38745
|
+
* * PY_ODPS3
|
|
38746
|
+
* * ODPS_SCRIPT
|
|
38747
|
+
* * ODPS_MR
|
|
38748
|
+
* * COMPONENT_SQL
|
|
38749
|
+
* * EMR_HIVE
|
|
38750
|
+
* * EMR_MR
|
|
38751
|
+
* * EMR_SPARK_SQL
|
|
38752
|
+
* * EMR_SPARK
|
|
38753
|
+
* * EMR_SHELL
|
|
38754
|
+
* * EMR_PRESTO
|
|
38755
|
+
* * EMR_IMPALA
|
|
38756
|
+
* * SPARK_STREAMING
|
|
38757
|
+
* * EMR_KYUUBI
|
|
38758
|
+
* * EMR_TRINO
|
|
38759
|
+
* * HOLOGRES_SQL
|
|
38760
|
+
* * HOLOGRES_SYNC_DDL
|
|
38761
|
+
* * HOLOGRES_SYNC_DATA
|
|
38649
38762
|
*
|
|
38650
38763
|
* @example
|
|
38651
38764
|
* ODPS_SQL
|
|
@@ -38784,7 +38897,28 @@ export declare class ListTasksShrinkRequest extends $dara.Model {
|
|
|
38784
38897
|
sortBy?: string;
|
|
38785
38898
|
/**
|
|
38786
38899
|
* @remarks
|
|
38787
|
-
* The type of the task.
|
|
38900
|
+
* The type of the task. Valid values:
|
|
38901
|
+
*
|
|
38902
|
+
* * ODPS_SQL
|
|
38903
|
+
* * SPARK
|
|
38904
|
+
* * PY_ODPS
|
|
38905
|
+
* * PY_ODPS3
|
|
38906
|
+
* * ODPS_SCRIPT
|
|
38907
|
+
* * ODPS_MR
|
|
38908
|
+
* * COMPONENT_SQL
|
|
38909
|
+
* * EMR_HIVE
|
|
38910
|
+
* * EMR_MR
|
|
38911
|
+
* * EMR_SPARK_SQL
|
|
38912
|
+
* * EMR_SPARK
|
|
38913
|
+
* * EMR_SHELL
|
|
38914
|
+
* * EMR_PRESTO
|
|
38915
|
+
* * EMR_IMPALA
|
|
38916
|
+
* * SPARK_STREAMING
|
|
38917
|
+
* * EMR_KYUUBI
|
|
38918
|
+
* * EMR_TRINO
|
|
38919
|
+
* * HOLOGRES_SQL
|
|
38920
|
+
* * HOLOGRES_SYNC_DDL
|
|
38921
|
+
* * HOLOGRES_SYNC_DATA
|
|
38788
38922
|
*
|
|
38789
38923
|
* @example
|
|
38790
38924
|
* ODPS_SQL
|
|
@@ -38987,9 +39121,7 @@ export declare class ListUpstreamTasksRequest extends $dara.Model {
|
|
|
38987
39121
|
pageSize?: number;
|
|
38988
39122
|
/**
|
|
38989
39123
|
* @remarks
|
|
38990
|
-
* The environment of the workspace.
|
|
38991
|
-
*
|
|
38992
|
-
* Valid values:
|
|
39124
|
+
* The environment of the workspace. Valid values:
|
|
38993
39125
|
*
|
|
38994
39126
|
* * Prod: production environment
|
|
38995
39127
|
* * Dev: development environment
|
|
@@ -41679,6 +41811,8 @@ export declare class TagDataAssetsResponse extends $dara.Model {
|
|
|
41679
41811
|
export declare class TestDataSourceConnectivityRequest extends $dara.Model {
|
|
41680
41812
|
/**
|
|
41681
41813
|
* @remarks
|
|
41814
|
+
* The ID of the data source for which you want to test the network connectivity.
|
|
41815
|
+
*
|
|
41682
41816
|
* This parameter is required.
|
|
41683
41817
|
*
|
|
41684
41818
|
* @example
|
|
@@ -41687,6 +41821,8 @@ export declare class TestDataSourceConnectivityRequest extends $dara.Model {
|
|
|
41687
41821
|
dataSourceId?: number;
|
|
41688
41822
|
/**
|
|
41689
41823
|
* @remarks
|
|
41824
|
+
* The DataWorks workspace ID.
|
|
41825
|
+
*
|
|
41690
41826
|
* This parameter is required.
|
|
41691
41827
|
*
|
|
41692
41828
|
* @example
|
|
@@ -41695,6 +41831,8 @@ export declare class TestDataSourceConnectivityRequest extends $dara.Model {
|
|
|
41695
41831
|
projectId?: number;
|
|
41696
41832
|
/**
|
|
41697
41833
|
* @remarks
|
|
41834
|
+
* The resource group ID.
|
|
41835
|
+
*
|
|
41698
41836
|
* This parameter is required.
|
|
41699
41837
|
*
|
|
41700
41838
|
* @example
|
|
@@ -41713,8 +41851,15 @@ export declare class TestDataSourceConnectivityRequest extends $dara.Model {
|
|
|
41713
41851
|
});
|
|
41714
41852
|
}
|
|
41715
41853
|
export declare class TestDataSourceConnectivityResponseBody extends $dara.Model {
|
|
41854
|
+
/**
|
|
41855
|
+
* @remarks
|
|
41856
|
+
* The details of the connectivity test.
|
|
41857
|
+
*/
|
|
41716
41858
|
connectivity?: TestDataSourceConnectivityResponseBodyConnectivity;
|
|
41717
41859
|
/**
|
|
41860
|
+
* @remarks
|
|
41861
|
+
* The request ID.
|
|
41862
|
+
*
|
|
41718
41863
|
* @example
|
|
41719
41864
|
* 4CDF7B72-020B-542A-8465-21CFFA81****
|
|
41720
41865
|
*/
|
|
@@ -42422,11 +42567,15 @@ export declare class UpdateDIJobRequest extends $dara.Model {
|
|
|
42422
42567
|
/**
|
|
42423
42568
|
* @remarks
|
|
42424
42569
|
* The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.
|
|
42570
|
+
*
|
|
42571
|
+
* > [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]
|
|
42425
42572
|
*/
|
|
42426
42573
|
tableMappings?: UpdateDIJobRequestTableMappings[];
|
|
42427
42574
|
/**
|
|
42428
42575
|
* @remarks
|
|
42429
|
-
* The list of transformation rules for objects involved in the synchronization task.
|
|
42576
|
+
* The list of transformation rules for objects involved in the synchronization task.
|
|
42577
|
+
*
|
|
42578
|
+
* > [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
|
|
42430
42579
|
*/
|
|
42431
42580
|
transformationRules?: UpdateDIJobRequestTransformationRules[];
|
|
42432
42581
|
static names(): {
|
|
@@ -42490,11 +42639,15 @@ export declare class UpdateDIJobShrinkRequest extends $dara.Model {
|
|
|
42490
42639
|
/**
|
|
42491
42640
|
* @remarks
|
|
42492
42641
|
* The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.
|
|
42642
|
+
*
|
|
42643
|
+
* > [ { "SourceObjectSelectionRules":[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]
|
|
42493
42644
|
*/
|
|
42494
42645
|
tableMappingsShrink?: string;
|
|
42495
42646
|
/**
|
|
42496
42647
|
* @remarks
|
|
42497
|
-
* The list of transformation rules for objects involved in the synchronization task.
|
|
42648
|
+
* The list of transformation rules for objects involved in the synchronization task.
|
|
42649
|
+
*
|
|
42650
|
+
* > [ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}_${srcDatabaseName}"}" } ]
|
|
42498
42651
|
*/
|
|
42499
42652
|
transformationRulesShrink?: string;
|
|
42500
42653
|
static names(): {
|
|
@@ -42975,7 +43128,7 @@ export declare class UpdateDataQualityRuleRequest extends $dara.Model {
|
|
|
42975
43128
|
samplingConfig?: UpdateDataQualityRuleRequestSamplingConfig;
|
|
42976
43129
|
/**
|
|
42977
43130
|
* @remarks
|
|
42978
|
-
* The strength of the rule.
|
|
43131
|
+
* The strength of the rule. Valid values:
|
|
42979
43132
|
*
|
|
42980
43133
|
* * Normal
|
|
42981
43134
|
* * High
|
|
@@ -43060,7 +43213,7 @@ export declare class UpdateDataQualityRuleShrinkRequest extends $dara.Model {
|
|
|
43060
43213
|
samplingConfigShrink?: string;
|
|
43061
43214
|
/**
|
|
43062
43215
|
* @remarks
|
|
43063
|
-
* The strength of the rule.
|
|
43216
|
+
* The strength of the rule. Valid values:
|
|
43064
43217
|
*
|
|
43065
43218
|
* * Normal
|
|
43066
43219
|
* * High
|
|
@@ -45141,7 +45294,7 @@ export default class Client extends OpenApi {
|
|
|
45141
45294
|
*/
|
|
45142
45295
|
createDataQualityEvaluationTask(request: CreateDataQualityEvaluationTaskRequest): Promise<CreateDataQualityEvaluationTaskResponse>;
|
|
45143
45296
|
/**
|
|
45144
|
-
* Creates a monitor instance
|
|
45297
|
+
* Creates a monitor instance.
|
|
45145
45298
|
*
|
|
45146
45299
|
* @param tmpReq - CreateDataQualityEvaluationTaskInstanceRequest
|
|
45147
45300
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -45149,7 +45302,7 @@ export default class Client extends OpenApi {
|
|
|
45149
45302
|
*/
|
|
45150
45303
|
createDataQualityEvaluationTaskInstanceWithOptions(tmpReq: CreateDataQualityEvaluationTaskInstanceRequest, runtime: $dara.RuntimeOptions): Promise<CreateDataQualityEvaluationTaskInstanceResponse>;
|
|
45151
45304
|
/**
|
|
45152
|
-
* Creates a monitor instance
|
|
45305
|
+
* Creates a monitor instance.
|
|
45153
45306
|
*
|
|
45154
45307
|
* @param request - CreateDataQualityEvaluationTaskInstanceRequest
|
|
45155
45308
|
* @returns CreateDataQualityEvaluationTaskInstanceResponse
|
|
@@ -45453,7 +45606,7 @@ export default class Client extends OpenApi {
|
|
|
45453
45606
|
*/
|
|
45454
45607
|
createWorkflowInstances(request: CreateWorkflowInstancesRequest): Promise<CreateWorkflowInstancesResponse>;
|
|
45455
45608
|
/**
|
|
45456
|
-
* Deletes a custom alert
|
|
45609
|
+
* Deletes a custom monitoring alert rule.
|
|
45457
45610
|
*
|
|
45458
45611
|
* @param request - DeleteAlertRuleRequest
|
|
45459
45612
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -45461,14 +45614,18 @@ export default class Client extends OpenApi {
|
|
|
45461
45614
|
*/
|
|
45462
45615
|
deleteAlertRuleWithOptions(request: DeleteAlertRuleRequest, runtime: $dara.RuntimeOptions): Promise<DeleteAlertRuleResponse>;
|
|
45463
45616
|
/**
|
|
45464
|
-
* Deletes a custom alert
|
|
45617
|
+
* Deletes a custom monitoring alert rule.
|
|
45465
45618
|
*
|
|
45466
45619
|
* @param request - DeleteAlertRuleRequest
|
|
45467
45620
|
* @returns DeleteAlertRuleResponse
|
|
45468
45621
|
*/
|
|
45469
45622
|
deleteAlertRule(request: DeleteAlertRuleRequest): Promise<DeleteAlertRuleResponse>;
|
|
45470
45623
|
/**
|
|
45471
|
-
*
|
|
45624
|
+
* Deletes a certificate file.
|
|
45625
|
+
*
|
|
45626
|
+
* @remarks
|
|
45627
|
+
* 1. This API operation is available for all DataWorks editions.
|
|
45628
|
+
* 2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M.
|
|
45472
45629
|
*
|
|
45473
45630
|
* @param request - DeleteCertificateRequest
|
|
45474
45631
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -45476,7 +45633,11 @@ export default class Client extends OpenApi {
|
|
|
45476
45633
|
*/
|
|
45477
45634
|
deleteCertificateWithOptions(request: DeleteCertificateRequest, runtime: $dara.RuntimeOptions): Promise<DeleteCertificateResponse>;
|
|
45478
45635
|
/**
|
|
45479
|
-
*
|
|
45636
|
+
* Deletes a certificate file.
|
|
45637
|
+
*
|
|
45638
|
+
* @remarks
|
|
45639
|
+
* 1. This API operation is available for all DataWorks editions.
|
|
45640
|
+
* 2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M.
|
|
45480
45641
|
*
|
|
45481
45642
|
* @param request - DeleteCertificateRequest
|
|
45482
45643
|
* @returns DeleteCertificateResponse
|
|
@@ -46478,7 +46639,7 @@ export default class Client extends OpenApi {
|
|
|
46478
46639
|
*/
|
|
46479
46640
|
grantMemberProjectRoles(request: GrantMemberProjectRolesRequest): Promise<GrantMemberProjectRolesResponse>;
|
|
46480
46641
|
/**
|
|
46481
|
-
*
|
|
46642
|
+
* Imports a certificate file.
|
|
46482
46643
|
*
|
|
46483
46644
|
* @param request - ImportCertificateRequest
|
|
46484
46645
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -46486,7 +46647,7 @@ export default class Client extends OpenApi {
|
|
|
46486
46647
|
*/
|
|
46487
46648
|
importCertificateWithOptions(request: ImportCertificateRequest, runtime: $dara.RuntimeOptions): Promise<ImportCertificateResponse>;
|
|
46488
46649
|
/**
|
|
46489
|
-
*
|
|
46650
|
+
* Imports a certificate file.
|
|
46490
46651
|
*
|
|
46491
46652
|
* @param request - ImportCertificateRequest
|
|
46492
46653
|
* @returns ImportCertificateResponse
|
|
@@ -47607,7 +47768,11 @@ export default class Client extends OpenApi {
|
|
|
47607
47768
|
*/
|
|
47608
47769
|
tagDataAssets(request: TagDataAssetsRequest): Promise<TagDataAssetsResponse>;
|
|
47609
47770
|
/**
|
|
47610
|
-
*
|
|
47771
|
+
* Tests the network connectivity between a resource group and a data source.
|
|
47772
|
+
*
|
|
47773
|
+
* @remarks
|
|
47774
|
+
* 1. This API operation is available for all DataWorks editions.
|
|
47775
|
+
* 2. Your account must be assigned one of the following roles of the desired workspace: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O\\&M
|
|
47611
47776
|
*
|
|
47612
47777
|
* @param request - TestDataSourceConnectivityRequest
|
|
47613
47778
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -47615,7 +47780,11 @@ export default class Client extends OpenApi {
|
|
|
47615
47780
|
*/
|
|
47616
47781
|
testDataSourceConnectivityWithOptions(request: TestDataSourceConnectivityRequest, runtime: $dara.RuntimeOptions): Promise<TestDataSourceConnectivityResponse>;
|
|
47617
47782
|
/**
|
|
47618
|
-
*
|
|
47783
|
+
* Tests the network connectivity between a resource group and a data source.
|
|
47784
|
+
*
|
|
47785
|
+
* @remarks
|
|
47786
|
+
* 1. This API operation is available for all DataWorks editions.
|
|
47787
|
+
* 2. Your account must be assigned one of the following roles of the desired workspace: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O\\&M
|
|
47619
47788
|
*
|
|
47620
47789
|
* @param request - TestDataSourceConnectivityRequest
|
|
47621
47790
|
* @returns TestDataSourceConnectivityResponse
|