@alicloud/dataworks-public20240518 3.1.0 → 4.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 +171 -67
- package/dist/client.js +38 -6
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +171 -67
package/dist/client.d.ts
CHANGED
|
@@ -311,7 +311,7 @@ export declare class AssociateProjectToResourceGroupResponseBody extends $tea.Mo
|
|
|
311
311
|
requestId?: string;
|
|
312
312
|
/**
|
|
313
313
|
* @remarks
|
|
314
|
-
* Indicates whether the request was successful.
|
|
314
|
+
* Indicates whether the request was successful.
|
|
315
315
|
*
|
|
316
316
|
* @example
|
|
317
317
|
* true
|
|
@@ -2920,6 +2920,9 @@ export declare class CreateRouteResponseBody extends $tea.Model {
|
|
|
2920
2920
|
*/
|
|
2921
2921
|
routeId?: number;
|
|
2922
2922
|
/**
|
|
2923
|
+
* @remarks
|
|
2924
|
+
* Indicates whether the request was successful.
|
|
2925
|
+
*
|
|
2923
2926
|
* @example
|
|
2924
2927
|
* true
|
|
2925
2928
|
*/
|
|
@@ -3630,6 +3633,9 @@ export declare class DeleteNetworkResponseBody extends $tea.Model {
|
|
|
3630
3633
|
*/
|
|
3631
3634
|
requestId?: string;
|
|
3632
3635
|
/**
|
|
3636
|
+
* @remarks
|
|
3637
|
+
* Indicates whether the request was successful.
|
|
3638
|
+
*
|
|
3633
3639
|
* @example
|
|
3634
3640
|
* true
|
|
3635
3641
|
*/
|
|
@@ -3972,7 +3978,7 @@ export declare class DeleteResourceGroupResponseBody extends $tea.Model {
|
|
|
3972
3978
|
requestId?: string;
|
|
3973
3979
|
/**
|
|
3974
3980
|
* @remarks
|
|
3975
|
-
* Indicates whether the request was successful.
|
|
3981
|
+
* Indicates whether the request was successful.
|
|
3976
3982
|
*
|
|
3977
3983
|
* @example
|
|
3978
3984
|
* true
|
|
@@ -4030,6 +4036,9 @@ export declare class DeleteRouteResponseBody extends $tea.Model {
|
|
|
4030
4036
|
*/
|
|
4031
4037
|
requestId?: string;
|
|
4032
4038
|
/**
|
|
4039
|
+
* @remarks
|
|
4040
|
+
* Indicates whether the request was successful.
|
|
4041
|
+
*
|
|
4033
4042
|
* @example
|
|
4034
4043
|
* true
|
|
4035
4044
|
*/
|
|
@@ -4360,7 +4369,7 @@ export declare class DissociateProjectFromResourceGroupResponseBody extends $tea
|
|
|
4360
4369
|
requestId?: string;
|
|
4361
4370
|
/**
|
|
4362
4371
|
* @remarks
|
|
4363
|
-
* Indicates whether the request was successful.
|
|
4372
|
+
* Indicates whether the request was successful.
|
|
4364
4373
|
*
|
|
4365
4374
|
* @example
|
|
4366
4375
|
* true
|
|
@@ -5189,6 +5198,10 @@ export declare class GetNetworkRequest extends $tea.Model {
|
|
|
5189
5198
|
});
|
|
5190
5199
|
}
|
|
5191
5200
|
export declare class GetNetworkResponseBody extends $tea.Model {
|
|
5201
|
+
/**
|
|
5202
|
+
* @remarks
|
|
5203
|
+
* The information about the network resource.
|
|
5204
|
+
*/
|
|
5192
5205
|
network?: GetNetworkResponseBodyNetwork;
|
|
5193
5206
|
/**
|
|
5194
5207
|
* @example
|
|
@@ -5196,6 +5209,9 @@ export declare class GetNetworkResponseBody extends $tea.Model {
|
|
|
5196
5209
|
*/
|
|
5197
5210
|
requestId?: string;
|
|
5198
5211
|
/**
|
|
5212
|
+
* @remarks
|
|
5213
|
+
* Indicates whether the request was successful.
|
|
5214
|
+
*
|
|
5199
5215
|
* @example
|
|
5200
5216
|
* true
|
|
5201
5217
|
*/
|
|
@@ -5375,7 +5391,7 @@ export declare class GetProjectMemberRequest extends $tea.Model {
|
|
|
5375
5391
|
projectId?: number;
|
|
5376
5392
|
/**
|
|
5377
5393
|
* @remarks
|
|
5378
|
-
* The ID of the account used by the member
|
|
5394
|
+
* 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 IDs of the accounts used by the members in the workspace.
|
|
5379
5395
|
*
|
|
5380
5396
|
* This parameter is required.
|
|
5381
5397
|
*
|
|
@@ -5680,6 +5696,9 @@ export declare class GetRouteResponseBody extends $tea.Model {
|
|
|
5680
5696
|
*/
|
|
5681
5697
|
route?: GetRouteResponseBodyRoute;
|
|
5682
5698
|
/**
|
|
5699
|
+
* @remarks
|
|
5700
|
+
* Indicates whether the request was successful.
|
|
5701
|
+
*
|
|
5683
5702
|
* @example
|
|
5684
5703
|
* true
|
|
5685
5704
|
*/
|
|
@@ -6010,7 +6029,7 @@ export declare class GrantMemberProjectRolesRequest extends $tea.Model {
|
|
|
6010
6029
|
roleCodes?: string[];
|
|
6011
6030
|
/**
|
|
6012
6031
|
* @remarks
|
|
6013
|
-
* The
|
|
6032
|
+
* The DataWorks workspace ID. 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 IDs of the accounts used by the members in the workspace.
|
|
6014
6033
|
*
|
|
6015
6034
|
* This parameter is required.
|
|
6016
6035
|
*
|
|
@@ -6050,7 +6069,7 @@ export declare class GrantMemberProjectRolesShrinkRequest extends $tea.Model {
|
|
|
6050
6069
|
roleCodesShrink?: string;
|
|
6051
6070
|
/**
|
|
6052
6071
|
* @remarks
|
|
6053
|
-
* The
|
|
6072
|
+
* The DataWorks workspace ID. 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 IDs of the accounts used by the members in the workspace.
|
|
6054
6073
|
*
|
|
6055
6074
|
* This parameter is required.
|
|
6056
6075
|
*
|
|
@@ -6346,7 +6365,7 @@ export declare class ListAlertRulesResponse extends $tea.Model {
|
|
|
6346
6365
|
export declare class ListDIAlarmRulesRequest extends $tea.Model {
|
|
6347
6366
|
/**
|
|
6348
6367
|
* @remarks
|
|
6349
|
-
* The ID of the alert rule.
|
|
6368
|
+
* The ID of the alert rule. If you leave this parameter empty, all alert rules of the task are queried.
|
|
6350
6369
|
*
|
|
6351
6370
|
* @example
|
|
6352
6371
|
* 34988
|
|
@@ -6354,7 +6373,7 @@ export declare class ListDIAlarmRulesRequest extends $tea.Model {
|
|
|
6354
6373
|
DIAlarmRuleId?: number;
|
|
6355
6374
|
/**
|
|
6356
6375
|
* @remarks
|
|
6357
|
-
* The ID of the
|
|
6376
|
+
* The ID of the task for which alert rules are configured.
|
|
6358
6377
|
*
|
|
6359
6378
|
* @example
|
|
6360
6379
|
* 1000001
|
|
@@ -7167,11 +7186,17 @@ export declare class ListDataQualityResultsRequest extends $tea.Model {
|
|
|
7167
7186
|
*/
|
|
7168
7187
|
dataQualityRuleId?: number;
|
|
7169
7188
|
/**
|
|
7189
|
+
* @remarks
|
|
7190
|
+
* The page number. Default value: 1.
|
|
7191
|
+
*
|
|
7170
7192
|
* @example
|
|
7171
7193
|
* 1
|
|
7172
7194
|
*/
|
|
7173
7195
|
pageNumber?: number;
|
|
7174
7196
|
/**
|
|
7197
|
+
* @remarks
|
|
7198
|
+
* The number of entries per page. Default value: 10.
|
|
7199
|
+
*
|
|
7175
7200
|
* @example
|
|
7176
7201
|
* 10
|
|
7177
7202
|
*/
|
|
@@ -7561,6 +7586,12 @@ export declare class ListDataSourcesRequest extends $tea.Model {
|
|
|
7561
7586
|
*/
|
|
7562
7587
|
sortBy?: string;
|
|
7563
7588
|
/**
|
|
7589
|
+
* @remarks
|
|
7590
|
+
* The tag of the data source. This parameter specifies a filter condition.
|
|
7591
|
+
*
|
|
7592
|
+
* * 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"]`.
|
|
7593
|
+
* * If you do not configure this parameter, tag-based filtering is not performed.
|
|
7594
|
+
*
|
|
7564
7595
|
* @example
|
|
7565
7596
|
* ["tag1", "tag2", "tag3"]
|
|
7566
7597
|
*/
|
|
@@ -7656,6 +7687,12 @@ export declare class ListDataSourcesShrinkRequest extends $tea.Model {
|
|
|
7656
7687
|
*/
|
|
7657
7688
|
sortBy?: string;
|
|
7658
7689
|
/**
|
|
7690
|
+
* @remarks
|
|
7691
|
+
* The tag of the data source. This parameter specifies a filter condition.
|
|
7692
|
+
*
|
|
7693
|
+
* * 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"]`.
|
|
7694
|
+
* * If you do not configure this parameter, tag-based filtering is not performed.
|
|
7695
|
+
*
|
|
7659
7696
|
* @example
|
|
7660
7697
|
* ["tag1", "tag2", "tag3"]
|
|
7661
7698
|
*/
|
|
@@ -8271,6 +8308,10 @@ export declare class ListNodesRequest extends $tea.Model {
|
|
|
8271
8308
|
* 12345
|
|
8272
8309
|
*/
|
|
8273
8310
|
projectId?: string;
|
|
8311
|
+
/**
|
|
8312
|
+
* @example
|
|
8313
|
+
* Normal
|
|
8314
|
+
*/
|
|
8274
8315
|
recurrence?: string;
|
|
8275
8316
|
/**
|
|
8276
8317
|
* @remarks
|
|
@@ -8384,7 +8425,7 @@ export declare class ListProjectMembersRequest extends $tea.Model {
|
|
|
8384
8425
|
roleCodes?: string[];
|
|
8385
8426
|
/**
|
|
8386
8427
|
* @remarks
|
|
8387
|
-
* The IDs of the accounts used by the members in the workspace. You can log on to the [DataWorks console](https://
|
|
8428
|
+
* The IDs of the accounts used by the members 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 IDs of the accounts used by the members in the workspace.
|
|
8388
8429
|
*/
|
|
8389
8430
|
userIds?: string[];
|
|
8390
8431
|
static names(): {
|
|
@@ -8433,7 +8474,7 @@ export declare class ListProjectMembersShrinkRequest extends $tea.Model {
|
|
|
8433
8474
|
roleCodesShrink?: string;
|
|
8434
8475
|
/**
|
|
8435
8476
|
* @remarks
|
|
8436
|
-
* The IDs of the accounts used by the members in the workspace. You can log on to the [DataWorks console](https://
|
|
8477
|
+
* The IDs of the accounts used by the members 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 IDs of the accounts used by the members in the workspace.
|
|
8437
8478
|
*/
|
|
8438
8479
|
userIdsShrink?: string;
|
|
8439
8480
|
static names(): {
|
|
@@ -9187,6 +9228,9 @@ export declare class ListRoutesResponseBody extends $tea.Model {
|
|
|
9187
9228
|
*/
|
|
9188
9229
|
routeList?: ListRoutesResponseBodyRouteList[];
|
|
9189
9230
|
/**
|
|
9231
|
+
* @remarks
|
|
9232
|
+
* Indicates whether the request was successful.
|
|
9233
|
+
*
|
|
9190
9234
|
* @example
|
|
9191
9235
|
* true
|
|
9192
9236
|
*/
|
|
@@ -13124,6 +13168,12 @@ export declare class UpdateProjectRequest extends $tea.Model {
|
|
|
13124
13168
|
*/
|
|
13125
13169
|
paiTaskEnabled?: boolean;
|
|
13126
13170
|
/**
|
|
13171
|
+
* @remarks
|
|
13172
|
+
* Specifies whether to disable or enable the workspace. Valid values:
|
|
13173
|
+
*
|
|
13174
|
+
* * Available: enables the workspace.
|
|
13175
|
+
* * Forbidden: disables the workspace.
|
|
13176
|
+
*
|
|
13127
13177
|
* @example
|
|
13128
13178
|
* Forbidden
|
|
13129
13179
|
*/
|
|
@@ -13337,6 +13387,8 @@ export declare class UpdateResourceGroupResponse extends $tea.Model {
|
|
|
13337
13387
|
export declare class UpdateRouteRequest extends $tea.Model {
|
|
13338
13388
|
/**
|
|
13339
13389
|
* @remarks
|
|
13390
|
+
* The destination CIDR block of the route that you want to update.
|
|
13391
|
+
*
|
|
13340
13392
|
* This parameter is required.
|
|
13341
13393
|
*
|
|
13342
13394
|
* @example
|
|
@@ -13368,6 +13420,9 @@ export declare class UpdateRouteResponseBody extends $tea.Model {
|
|
|
13368
13420
|
*/
|
|
13369
13421
|
requestId?: string;
|
|
13370
13422
|
/**
|
|
13423
|
+
* @remarks
|
|
13424
|
+
* Indicates whether the request was successful.
|
|
13425
|
+
*
|
|
13371
13426
|
* @example
|
|
13372
13427
|
* true
|
|
13373
13428
|
*/
|
|
@@ -18370,12 +18425,12 @@ export declare class GetDeploymentResponseBodyPipelineStages extends $tea.Model
|
|
|
18370
18425
|
*
|
|
18371
18426
|
* Valid values:
|
|
18372
18427
|
*
|
|
18373
|
-
* *
|
|
18374
|
-
* *
|
|
18375
|
-
* *
|
|
18376
|
-
* *
|
|
18377
|
-
* *
|
|
18378
|
-
* *
|
|
18428
|
+
* * Init
|
|
18429
|
+
* * Running
|
|
18430
|
+
* * Success
|
|
18431
|
+
* * Fail
|
|
18432
|
+
* * Termination
|
|
18433
|
+
* * Cancel
|
|
18379
18434
|
*
|
|
18380
18435
|
* @example
|
|
18381
18436
|
* INIT
|
|
@@ -18395,11 +18450,11 @@ export declare class GetDeploymentResponseBodyPipelineStages extends $tea.Model
|
|
|
18395
18450
|
*
|
|
18396
18451
|
* Valid values:
|
|
18397
18452
|
*
|
|
18398
|
-
* *
|
|
18399
|
-
* *
|
|
18400
|
-
* *
|
|
18401
|
-
* *
|
|
18402
|
-
* *
|
|
18453
|
+
* * Deploy
|
|
18454
|
+
* * Check
|
|
18455
|
+
* * Offline
|
|
18456
|
+
* * Build
|
|
18457
|
+
* * Delete
|
|
18403
18458
|
*
|
|
18404
18459
|
* @example
|
|
18405
18460
|
* BUILD
|
|
@@ -18472,12 +18527,12 @@ export declare class GetDeploymentResponseBodyPipeline extends $tea.Model {
|
|
|
18472
18527
|
*
|
|
18473
18528
|
* Valid values:
|
|
18474
18529
|
*
|
|
18475
|
-
* *
|
|
18476
|
-
* *
|
|
18477
|
-
* *
|
|
18478
|
-
* *
|
|
18479
|
-
* *
|
|
18480
|
-
* *
|
|
18530
|
+
* * Init
|
|
18531
|
+
* * Running
|
|
18532
|
+
* * Success
|
|
18533
|
+
* * Fail
|
|
18534
|
+
* * Termination
|
|
18535
|
+
* * Cancel
|
|
18481
18536
|
*
|
|
18482
18537
|
* @example
|
|
18483
18538
|
* RUNNING
|
|
@@ -18649,6 +18704,15 @@ export declare class GetNetworkResponseBodyNetwork extends $tea.Model {
|
|
|
18649
18704
|
*/
|
|
18650
18705
|
securityGroupId?: string;
|
|
18651
18706
|
/**
|
|
18707
|
+
* @remarks
|
|
18708
|
+
* The status of the network resource. Valid values:
|
|
18709
|
+
*
|
|
18710
|
+
* * Pending: The network resource is waiting to be created.
|
|
18711
|
+
* * Creating: The network resource is being created.
|
|
18712
|
+
* * Running: The network resource is running as expected.
|
|
18713
|
+
* * Deleting: The network resource is being deleted.
|
|
18714
|
+
* * Deleted: The network resource is deleted.
|
|
18715
|
+
*
|
|
18652
18716
|
* @example
|
|
18653
18717
|
* Running
|
|
18654
18718
|
*/
|
|
@@ -21276,12 +21340,7 @@ export declare class ListAlertRulesResponseBodyPagingInfo extends $tea.Model {
|
|
|
21276
21340
|
export declare class ListDIAlarmRulesResponseBodyPagingInfoDIJobAlarmRulesNotificationSettingsNotificationChannels extends $tea.Model {
|
|
21277
21341
|
/**
|
|
21278
21342
|
* @remarks
|
|
21279
|
-
* The alert notification
|
|
21280
|
-
*
|
|
21281
|
-
* * Mail
|
|
21282
|
-
* * Phone
|
|
21283
|
-
* * Sms
|
|
21284
|
-
* * Ding
|
|
21343
|
+
* The alert notification methods.
|
|
21285
21344
|
*/
|
|
21286
21345
|
channels?: string[];
|
|
21287
21346
|
/**
|
|
@@ -21364,7 +21423,7 @@ export declare class ListDIAlarmRulesResponseBodyPagingInfoDIJobAlarmRulesNotifi
|
|
|
21364
21423
|
export declare class ListDIAlarmRulesResponseBodyPagingInfoDIJobAlarmRulesTriggerConditions extends $tea.Model {
|
|
21365
21424
|
/**
|
|
21366
21425
|
* @remarks
|
|
21367
|
-
* The types of DDL operations for which the alert rule takes effect.
|
|
21426
|
+
* The types of DDL operations for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport.
|
|
21368
21427
|
*/
|
|
21369
21428
|
ddlReportTags?: string[];
|
|
21370
21429
|
/**
|
|
@@ -21465,7 +21524,7 @@ export declare class ListDIAlarmRulesResponseBodyPagingInfoDIJobAlarmRules exten
|
|
|
21465
21524
|
name?: string;
|
|
21466
21525
|
/**
|
|
21467
21526
|
* @remarks
|
|
21468
|
-
* The alert notification settings.
|
|
21527
|
+
* The alert notification method and recipient settings.
|
|
21469
21528
|
*/
|
|
21470
21529
|
notificationSettings?: ListDIAlarmRulesResponseBodyPagingInfoDIJobAlarmRulesNotificationSettings;
|
|
21471
21530
|
/**
|
|
@@ -23979,7 +24038,12 @@ export declare class ListDataSourceSharedRulesResponseBodyDataSourceSharedRules
|
|
|
23979
24038
|
export declare class ListDataSourcesResponseBodyPagingInfoDataSourcesDataSource extends $tea.Model {
|
|
23980
24039
|
/**
|
|
23981
24040
|
* @remarks
|
|
23982
|
-
* The connection
|
|
24041
|
+
* The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:
|
|
24042
|
+
*
|
|
24043
|
+
* * Dev: development environment
|
|
24044
|
+
* * Prod: production environment
|
|
24045
|
+
*
|
|
24046
|
+
* The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](https://help.aliyun.com/zh/dataworks/developer-reference/data-source-connection-information-connectionproperties/?spm=a2c4g.11186623.0.0.3fbb6fe7fo5AMK).
|
|
23983
24047
|
*
|
|
23984
24048
|
* @example
|
|
23985
24049
|
* {
|
|
@@ -24051,7 +24115,7 @@ export declare class ListDataSourcesResponseBodyPagingInfoDataSourcesDataSource
|
|
|
24051
24115
|
modifyUser?: string;
|
|
24052
24116
|
/**
|
|
24053
24117
|
* @remarks
|
|
24054
|
-
* The unique business key of the data source. For example, the unique business key of a Hologres data source is in the
|
|
24118
|
+
* The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.
|
|
24055
24119
|
*
|
|
24056
24120
|
* @example
|
|
24057
24121
|
* 1648711121000:cn-beijing:odps:yongxunQA_beijing_standard
|
|
@@ -24068,6 +24132,10 @@ export declare class ListDataSourcesResponseBodyPagingInfoDataSourcesDataSource
|
|
|
24068
24132
|
});
|
|
24069
24133
|
}
|
|
24070
24134
|
export declare class ListDataSourcesResponseBodyPagingInfoDataSources extends $tea.Model {
|
|
24135
|
+
/**
|
|
24136
|
+
* @remarks
|
|
24137
|
+
* The data sources. Each element is the information of a single data source with a unique data source ID.
|
|
24138
|
+
*/
|
|
24071
24139
|
dataSource?: ListDataSourcesResponseBodyPagingInfoDataSourcesDataSource[];
|
|
24072
24140
|
/**
|
|
24073
24141
|
* @remarks
|
|
@@ -24096,6 +24164,10 @@ export declare class ListDataSourcesResponseBodyPagingInfoDataSources extends $t
|
|
|
24096
24164
|
});
|
|
24097
24165
|
}
|
|
24098
24166
|
export declare class ListDataSourcesResponseBodyPagingInfo extends $tea.Model {
|
|
24167
|
+
/**
|
|
24168
|
+
* @remarks
|
|
24169
|
+
* The data source groups. Each element in the array indicates a data source group. Each data source group contains data sources in the development environment (if any) and the production environment.
|
|
24170
|
+
*/
|
|
24099
24171
|
dataSources?: ListDataSourcesResponseBodyPagingInfoDataSources[];
|
|
24100
24172
|
/**
|
|
24101
24173
|
* @remarks
|
|
@@ -24168,12 +24240,12 @@ export declare class ListDeploymentsResponseBodyPagingInfoDeploymentsStages exte
|
|
|
24168
24240
|
*
|
|
24169
24241
|
* Valid values:
|
|
24170
24242
|
*
|
|
24171
|
-
* *
|
|
24172
|
-
* *
|
|
24173
|
-
* *
|
|
24174
|
-
* *
|
|
24175
|
-
* *
|
|
24176
|
-
* *
|
|
24243
|
+
* * Init
|
|
24244
|
+
* * Running
|
|
24245
|
+
* * Success
|
|
24246
|
+
* * Fail
|
|
24247
|
+
* * Termination
|
|
24248
|
+
* * Cancel
|
|
24177
24249
|
*
|
|
24178
24250
|
* @example
|
|
24179
24251
|
* RUNNING
|
|
@@ -24193,11 +24265,11 @@ export declare class ListDeploymentsResponseBodyPagingInfoDeploymentsStages exte
|
|
|
24193
24265
|
*
|
|
24194
24266
|
* Valid values:
|
|
24195
24267
|
*
|
|
24196
|
-
* *
|
|
24197
|
-
* *
|
|
24198
|
-
* *
|
|
24199
|
-
* *
|
|
24200
|
-
* *
|
|
24268
|
+
* * Deploy
|
|
24269
|
+
* * Check
|
|
24270
|
+
* * Offline
|
|
24271
|
+
* * Build
|
|
24272
|
+
* * Delete
|
|
24201
24273
|
*
|
|
24202
24274
|
* @example
|
|
24203
24275
|
* CHECK
|
|
@@ -24270,12 +24342,12 @@ export declare class ListDeploymentsResponseBodyPagingInfoDeployments extends $t
|
|
|
24270
24342
|
*
|
|
24271
24343
|
* Valid values:
|
|
24272
24344
|
*
|
|
24273
|
-
* *
|
|
24274
|
-
* *
|
|
24275
|
-
* *
|
|
24276
|
-
* *
|
|
24277
|
-
* *
|
|
24278
|
-
* *
|
|
24345
|
+
* * Init
|
|
24346
|
+
* * Running
|
|
24347
|
+
* * Success
|
|
24348
|
+
* * Fail
|
|
24349
|
+
* * Termination
|
|
24350
|
+
* * Cancel
|
|
24279
24351
|
*
|
|
24280
24352
|
* @example
|
|
24281
24353
|
* RUNNING
|
|
@@ -24294,7 +24366,7 @@ export declare class ListDeploymentsResponseBodyPagingInfoDeployments extends $t
|
|
|
24294
24366
|
export declare class ListDeploymentsResponseBodyPagingInfo extends $tea.Model {
|
|
24295
24367
|
/**
|
|
24296
24368
|
* @remarks
|
|
24297
|
-
* The processes.
|
|
24369
|
+
* The deployment processes.
|
|
24298
24370
|
*/
|
|
24299
24371
|
deployments?: ListDeploymentsResponseBodyPagingInfoDeployments[];
|
|
24300
24372
|
/**
|
|
@@ -25369,12 +25441,12 @@ export declare class ListFunctionsResponseBodyPagingInfoFunctions extends $tea.M
|
|
|
25369
25441
|
*
|
|
25370
25442
|
* Valid values:
|
|
25371
25443
|
*
|
|
25372
|
-
* *
|
|
25373
|
-
* *
|
|
25374
|
-
* *
|
|
25375
|
-
* *
|
|
25376
|
-
* *
|
|
25377
|
-
* *
|
|
25444
|
+
* * Math: mathematical operation function
|
|
25445
|
+
* * Aggregate: aggregate function
|
|
25446
|
+
* * String: string processing function
|
|
25447
|
+
* * Date: date function
|
|
25448
|
+
* * Analytic: window function
|
|
25449
|
+
* * Other: other functions
|
|
25378
25450
|
*
|
|
25379
25451
|
* @example
|
|
25380
25452
|
* MATH
|
|
@@ -32489,7 +32561,7 @@ export default class Client extends OpenApi {
|
|
|
32489
32561
|
*/
|
|
32490
32562
|
getDataQualityRule(request: GetDataQualityRuleRequest): Promise<GetDataQualityRuleResponse>;
|
|
32491
32563
|
/**
|
|
32492
|
-
*
|
|
32564
|
+
* Queries the information about a data quality monitoring rule template.
|
|
32493
32565
|
*
|
|
32494
32566
|
* @remarks
|
|
32495
32567
|
* This API operation is available for all DataWorks editions.
|
|
@@ -32500,7 +32572,7 @@ export default class Client extends OpenApi {
|
|
|
32500
32572
|
*/
|
|
32501
32573
|
getDataQualityRuleTemplateWithOptions(request: GetDataQualityRuleTemplateRequest, runtime: $Util.RuntimeOptions): Promise<GetDataQualityRuleTemplateResponse>;
|
|
32502
32574
|
/**
|
|
32503
|
-
*
|
|
32575
|
+
* Queries the information about a data quality monitoring rule template.
|
|
32504
32576
|
*
|
|
32505
32577
|
* @remarks
|
|
32506
32578
|
* This API operation is available for all DataWorks editions.
|
|
@@ -32633,6 +32705,9 @@ export default class Client extends OpenApi {
|
|
|
32633
32705
|
/**
|
|
32634
32706
|
* Queries the details about a member in a workspace.
|
|
32635
32707
|
*
|
|
32708
|
+
* @remarks
|
|
32709
|
+
* This API operation is available for all DataWorks editions.
|
|
32710
|
+
*
|
|
32636
32711
|
* @param request - GetProjectMemberRequest
|
|
32637
32712
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
32638
32713
|
* @returns GetProjectMemberResponse
|
|
@@ -32641,6 +32716,9 @@ export default class Client extends OpenApi {
|
|
|
32641
32716
|
/**
|
|
32642
32717
|
* Queries the details about a member in a workspace.
|
|
32643
32718
|
*
|
|
32719
|
+
* @remarks
|
|
32720
|
+
* This API operation is available for all DataWorks editions.
|
|
32721
|
+
*
|
|
32644
32722
|
* @param request - GetProjectMemberRequest
|
|
32645
32723
|
* @returns GetProjectMemberResponse
|
|
32646
32724
|
*/
|
|
@@ -32648,6 +32726,9 @@ export default class Client extends OpenApi {
|
|
|
32648
32726
|
/**
|
|
32649
32727
|
* Queries the information about a role in a DataWorks workspace.
|
|
32650
32728
|
*
|
|
32729
|
+
* @remarks
|
|
32730
|
+
* This API operation is available for all DataWorks editions.
|
|
32731
|
+
*
|
|
32651
32732
|
* @param request - GetProjectRoleRequest
|
|
32652
32733
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
32653
32734
|
* @returns GetProjectRoleResponse
|
|
@@ -32656,6 +32737,9 @@ export default class Client extends OpenApi {
|
|
|
32656
32737
|
/**
|
|
32657
32738
|
* Queries the information about a role in a DataWorks workspace.
|
|
32658
32739
|
*
|
|
32740
|
+
* @remarks
|
|
32741
|
+
* This API operation is available for all DataWorks editions.
|
|
32742
|
+
*
|
|
32659
32743
|
* @param request - GetProjectRoleRequest
|
|
32660
32744
|
* @returns GetProjectRoleResponse
|
|
32661
32745
|
*/
|
|
@@ -32769,7 +32853,7 @@ export default class Client extends OpenApi {
|
|
|
32769
32853
|
*/
|
|
32770
32854
|
getTaskInstanceLog(request: GetTaskInstanceLogRequest): Promise<GetTaskInstanceLogResponse>;
|
|
32771
32855
|
/**
|
|
32772
|
-
* Queries the
|
|
32856
|
+
* Queries the information about a workflow.
|
|
32773
32857
|
*
|
|
32774
32858
|
* @param request - GetWorkflowDefinitionRequest
|
|
32775
32859
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -32777,7 +32861,7 @@ export default class Client extends OpenApi {
|
|
|
32777
32861
|
*/
|
|
32778
32862
|
getWorkflowDefinitionWithOptions(request: GetWorkflowDefinitionRequest, runtime: $Util.RuntimeOptions): Promise<GetWorkflowDefinitionResponse>;
|
|
32779
32863
|
/**
|
|
32780
|
-
* Queries the
|
|
32864
|
+
* Queries the information about a workflow.
|
|
32781
32865
|
*
|
|
32782
32866
|
* @param request - GetWorkflowDefinitionRequest
|
|
32783
32867
|
* @returns GetWorkflowDefinitionResponse
|
|
@@ -32786,6 +32870,9 @@ export default class Client extends OpenApi {
|
|
|
32786
32870
|
/**
|
|
32787
32871
|
* Assigns roles to members in a workspace.
|
|
32788
32872
|
*
|
|
32873
|
+
* @remarks
|
|
32874
|
+
* This API operation is available for all DataWorks editions.
|
|
32875
|
+
*
|
|
32789
32876
|
* @param tmpReq - GrantMemberProjectRolesRequest
|
|
32790
32877
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
32791
32878
|
* @returns GrantMemberProjectRolesResponse
|
|
@@ -32794,6 +32881,9 @@ export default class Client extends OpenApi {
|
|
|
32794
32881
|
/**
|
|
32795
32882
|
* Assigns roles to members in a workspace.
|
|
32796
32883
|
*
|
|
32884
|
+
* @remarks
|
|
32885
|
+
* This API operation is available for all DataWorks editions.
|
|
32886
|
+
*
|
|
32797
32887
|
* @param request - GrantMemberProjectRolesRequest
|
|
32798
32888
|
* @returns GrantMemberProjectRolesResponse
|
|
32799
32889
|
*/
|
|
@@ -33035,7 +33125,8 @@ export default class Client extends OpenApi {
|
|
|
33035
33125
|
* Queries a list of data sources based on the business information of data sources.
|
|
33036
33126
|
*
|
|
33037
33127
|
* @remarks
|
|
33038
|
-
*
|
|
33128
|
+
* 1. This API operation is available for all DataWorks editions.
|
|
33129
|
+
* 2. You can call this operation only if you are assigned one of the following roles in DataWorks:
|
|
33039
33130
|
* * Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator
|
|
33040
33131
|
*
|
|
33041
33132
|
* @param tmpReq - ListDataSourcesRequest
|
|
@@ -33047,7 +33138,8 @@ export default class Client extends OpenApi {
|
|
|
33047
33138
|
* Queries a list of data sources based on the business information of data sources.
|
|
33048
33139
|
*
|
|
33049
33140
|
* @remarks
|
|
33050
|
-
*
|
|
33141
|
+
* 1. This API operation is available for all DataWorks editions.
|
|
33142
|
+
* 2. You can call this operation only if you are assigned one of the following roles in DataWorks:
|
|
33051
33143
|
* * Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator
|
|
33052
33144
|
*
|
|
33053
33145
|
* @param request - ListDataSourcesRequest
|
|
@@ -33168,6 +33260,9 @@ export default class Client extends OpenApi {
|
|
|
33168
33260
|
/**
|
|
33169
33261
|
* Queries details about members in a workspace.
|
|
33170
33262
|
*
|
|
33263
|
+
* @remarks
|
|
33264
|
+
* This API operation is available for all DataWorks editions.
|
|
33265
|
+
*
|
|
33171
33266
|
* @param tmpReq - ListProjectMembersRequest
|
|
33172
33267
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
33173
33268
|
* @returns ListProjectMembersResponse
|
|
@@ -33176,6 +33271,9 @@ export default class Client extends OpenApi {
|
|
|
33176
33271
|
/**
|
|
33177
33272
|
* Queries details about members in a workspace.
|
|
33178
33273
|
*
|
|
33274
|
+
* @remarks
|
|
33275
|
+
* This API operation is available for all DataWorks editions.
|
|
33276
|
+
*
|
|
33179
33277
|
* @param request - ListProjectMembersRequest
|
|
33180
33278
|
* @returns ListProjectMembersResponse
|
|
33181
33279
|
*/
|
|
@@ -33183,6 +33281,9 @@ export default class Client extends OpenApi {
|
|
|
33183
33281
|
/**
|
|
33184
33282
|
* Queries the information about roles in a DataWorks workspace by page.
|
|
33185
33283
|
*
|
|
33284
|
+
* @remarks
|
|
33285
|
+
* This API operation is available for all DataWorks editions.
|
|
33286
|
+
*
|
|
33186
33287
|
* @param tmpReq - ListProjectRolesRequest
|
|
33187
33288
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
33188
33289
|
* @returns ListProjectRolesResponse
|
|
@@ -33191,6 +33292,9 @@ export default class Client extends OpenApi {
|
|
|
33191
33292
|
/**
|
|
33192
33293
|
* Queries the information about roles in a DataWorks workspace by page.
|
|
33193
33294
|
*
|
|
33295
|
+
* @remarks
|
|
33296
|
+
* This API operation is available for all DataWorks editions.
|
|
33297
|
+
*
|
|
33194
33298
|
* @param request - ListProjectRolesRequest
|
|
33195
33299
|
* @returns ListProjectRolesResponse
|
|
33196
33300
|
*/
|