tencentcloud-sdk-nodejs 4.1.310 → 4.1.312
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/es/common/sdk_version.js +1 -1
- package/es/services/cfw/v20190904/cfw_client.js +15 -9
- package/es/services/cngw/v20230418/cngw_client.js +72 -12
- package/es/services/databuddy/index.js +4 -0
- package/es/services/databuddy/v20260715/databuddy_client.js +57 -0
- package/es/services/databuddy/v20260715/databuddy_models.js +1 -0
- package/es/services/databuddy/v20260715/index.js +6 -0
- package/es/services/index.js +1 -0
- package/es/services/iotexplorer/v20190423/iotexplorer_client.js +12 -6
- package/es/services/tcb/v20180608/tcb_client.js +32 -11
- package/es/services/trtc/v20190722/trtc_client.js +163 -160
- package/es/services/tsf/v20180326/tsf_client.js +2 -5
- package/package.json +1 -1
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/adp/v20260520/adp_client.d.ts +1 -1
- package/tencentcloud/services/adp/v20260520/adp_client.js +1 -1
- package/tencentcloud/services/adp/v20260520/adp_models.d.ts +110 -28
- package/tencentcloud/services/ags/v20250920/ags_models.d.ts +23 -7
- package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +11 -7
- package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +19 -11
- package/tencentcloud/services/cfw/v20190904/cfw_client.js +27 -15
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +406 -40
- package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +12 -12
- package/tencentcloud/services/cngw/v20230418/cngw_client.d.ts +93 -13
- package/tencentcloud/services/cngw/v20230418/cngw_client.js +138 -18
- package/tencentcloud/services/cngw/v20230418/cngw_models.d.ts +1348 -152
- package/tencentcloud/services/databuddy/index.d.ts +6 -0
- package/tencentcloud/services/databuddy/index.js +7 -0
- package/tencentcloud/services/databuddy/v20260715/databuddy_client.d.ts +139 -0
- package/tencentcloud/services/databuddy/v20260715/databuddy_client.js +194 -0
- package/tencentcloud/services/databuddy/v20260715/databuddy_models.d.ts +3061 -0
- package/tencentcloud/services/databuddy/v20260715/databuddy_models.js +18 -0
- package/tencentcloud/services/databuddy/v20260715/index.d.ts +6 -0
- package/tencentcloud/services/databuddy/v20260715/index.js +10 -0
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +176 -434
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -13
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -13
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +15 -16
- package/tencentcloud/services/index.d.ts +1 -0
- package/tencentcloud/services/index.js +7 -5
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +15 -7
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +21 -9
- package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +173 -4
- package/tencentcloud/services/keewidb/v20220308/keewidb_models.d.ts +28 -16
- package/tencentcloud/services/mps/v20190612/mps_client.d.ts +1 -1
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +444 -139
- package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +12 -0
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +23 -30
- package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +50 -20
- package/tencentcloud/services/tcb/v20180608/tcb_client.js +69 -25
- package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +4770 -3942
- package/tencentcloud/services/teo/v20220901/teo_client.d.ts +4 -2
- package/tencentcloud/services/teo/v20220901/teo_client.js +4 -2
- package/tencentcloud/services/teo/v20220901/teo_models.d.ts +107 -43
- package/tencentcloud/services/tke/v20220501/tke_models.d.ts +13 -0
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.d.ts +3 -1
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_client.js +3 -1
- package/tencentcloud/services/tokenhub/v20260322/tokenhub_models.d.ts +43 -15
- package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +333 -329
- package/tencentcloud/services/trtc/v20190722/trtc_client.js +425 -419
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +196 -27
- package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +3 -9
- package/tencentcloud/services/tsf/v20180326/tsf_client.js +3 -11
- package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +0 -30
- package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -1
- package/tencentcloud/services/vod/v20180717/vod_models.d.ts +65 -6
|
@@ -0,0 +1,3061 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* 任务依赖简要信息
|
|
3
|
+
*/
|
|
4
|
+
export interface DependOnBrief {
|
|
5
|
+
/**
|
|
6
|
+
* 任务ID,可通过 ListWorkflowTasks 获取
|
|
7
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
8
|
+
*/
|
|
9
|
+
TaskId?: string;
|
|
10
|
+
/**
|
|
11
|
+
* 任务名称
|
|
12
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
13
|
+
*/
|
|
14
|
+
TaskName?: string;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* 文件详情
|
|
18
|
+
*/
|
|
19
|
+
export interface FileInfo {
|
|
20
|
+
/**
|
|
21
|
+
* <p>主账号 AppId</p>
|
|
22
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
23
|
+
*/
|
|
24
|
+
AppId?: string;
|
|
25
|
+
/**
|
|
26
|
+
* <p>工作空间 ID</p>
|
|
27
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
28
|
+
*/
|
|
29
|
+
WorkspaceId?: string;
|
|
30
|
+
/**
|
|
31
|
+
* <p>文件 ID</p>
|
|
32
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
33
|
+
*/
|
|
34
|
+
FileId?: string;
|
|
35
|
+
/**
|
|
36
|
+
* <p>文件名,含后缀</p>
|
|
37
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
38
|
+
*/
|
|
39
|
+
FileName?: string;
|
|
40
|
+
/**
|
|
41
|
+
* <p>文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType</p>
|
|
42
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
43
|
+
*/
|
|
44
|
+
FileType?: string;
|
|
45
|
+
/**
|
|
46
|
+
* <p>文件在工作空间中的完整路径,以 / 开头,如 /etl/daily/demo.ipynb</p>
|
|
47
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
48
|
+
*/
|
|
49
|
+
Path?: string;
|
|
50
|
+
/**
|
|
51
|
+
* <p>文件运行配置</p>
|
|
52
|
+
*/
|
|
53
|
+
FileConfig?: FileConfig;
|
|
54
|
+
/**
|
|
55
|
+
* <p>绑定的 BundleId</p>
|
|
56
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
57
|
+
*/
|
|
58
|
+
BundleId?: string;
|
|
59
|
+
/**
|
|
60
|
+
* <p>绑定的 BundleInfo,JSON 字符串</p>
|
|
61
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
62
|
+
*/
|
|
63
|
+
BundleInfo?: string;
|
|
64
|
+
/**
|
|
65
|
+
* <p>文件状态。active=正常,deleted=已删除</p>
|
|
66
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
67
|
+
*/
|
|
68
|
+
Status?: string;
|
|
69
|
+
/**
|
|
70
|
+
* <p>文件负责人用户名</p>
|
|
71
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
72
|
+
*/
|
|
73
|
+
OwnerUserName?: string;
|
|
74
|
+
/**
|
|
75
|
+
* <p>创建人子账号 Uin</p>
|
|
76
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
77
|
+
*/
|
|
78
|
+
CreateUserUin?: string;
|
|
79
|
+
/**
|
|
80
|
+
* <p>最近更新人子账号 Uin</p>
|
|
81
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
82
|
+
*/
|
|
83
|
+
UpdateUserUin?: string;
|
|
84
|
+
/**
|
|
85
|
+
* <p>创建时间,毫秒级时间戳</p>
|
|
86
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
87
|
+
*/
|
|
88
|
+
CreateTime?: string;
|
|
89
|
+
/**
|
|
90
|
+
* <p>最近更新时间,毫秒级时间戳</p>
|
|
91
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
92
|
+
*/
|
|
93
|
+
UpdateTime?: string;
|
|
94
|
+
/**
|
|
95
|
+
* <p>文件存储信息。仅当请求 IncludeContent=true 时返回内容</p>
|
|
96
|
+
*/
|
|
97
|
+
Storage?: FileStorage;
|
|
98
|
+
/**
|
|
99
|
+
* <p>当前调用方对该文件的权限点列表</p>
|
|
100
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
101
|
+
*/
|
|
102
|
+
Permissions?: string;
|
|
103
|
+
/**
|
|
104
|
+
* <p>是否已发布</p>
|
|
105
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
106
|
+
*/
|
|
107
|
+
ReleaseStatus?: boolean;
|
|
108
|
+
/**
|
|
109
|
+
* <p>资源模式。1=分布式,2=单节点</p>
|
|
110
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
111
|
+
*/
|
|
112
|
+
ResourceMode?: number;
|
|
113
|
+
/**
|
|
114
|
+
* ZIP 异步创建时透传 Workspace 作业信息;普通同步创建或其他复用该返回结构的接口不设置该字段
|
|
115
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
116
|
+
*/
|
|
117
|
+
AsyncOperation?: AsyncOperation;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* 工作流完整配置
|
|
121
|
+
*/
|
|
122
|
+
export interface Workflow {
|
|
123
|
+
/**
|
|
124
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取</p>
|
|
125
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
126
|
+
*/
|
|
127
|
+
WorkspaceId?: string;
|
|
128
|
+
/**
|
|
129
|
+
* <p>工作流基本信息</p>
|
|
130
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
131
|
+
*/
|
|
132
|
+
BaseInfo?: WorkflowBaseInfo;
|
|
133
|
+
/**
|
|
134
|
+
* <p>工作流调度配置</p>
|
|
135
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
136
|
+
*/
|
|
137
|
+
Trigger?: Array<WorkflowTriggerConfiguration>;
|
|
138
|
+
/**
|
|
139
|
+
* <p>工作流参数列表 参数名必填且只能包含数字、大小写字母、空格、.$@#!%^&*()-_+=><!--',最长128个字符--></p>
|
|
140
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
141
|
+
*/
|
|
142
|
+
ParamList?: Array<ParamInfo>;
|
|
143
|
+
/**
|
|
144
|
+
* <p>标签 标签名必填且只能包含数字、大小写字母、空格、.$@#!%^&*()-_+=><!--',最长128个字符--></p>
|
|
145
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
146
|
+
*/
|
|
147
|
+
LabelList?: Array<LabelBrief>;
|
|
148
|
+
/**
|
|
149
|
+
* <p>工作流告警配置</p>
|
|
150
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
151
|
+
*/
|
|
152
|
+
Alarm?: AlarmBrief;
|
|
153
|
+
/**
|
|
154
|
+
* <p>监控指标配置</p>
|
|
155
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
156
|
+
*/
|
|
157
|
+
MonitorMetric?: MonitorMetricBrief;
|
|
158
|
+
/**
|
|
159
|
+
* <p>工作流高级设置</p>
|
|
160
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
161
|
+
*/
|
|
162
|
+
AdvanceConfig?: WorkflowAdvanceConfig;
|
|
163
|
+
/**
|
|
164
|
+
* <p>工作流任务列表</p>
|
|
165
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
166
|
+
*/
|
|
167
|
+
TaskList?: Array<WorkflowTask>;
|
|
168
|
+
/**
|
|
169
|
+
* <p>BundleId,可通过 Bundle 相关接口获取</p>
|
|
170
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
171
|
+
*/
|
|
172
|
+
BundleId?: string;
|
|
173
|
+
/**
|
|
174
|
+
* <p>Bundle信息</p>
|
|
175
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
176
|
+
*/
|
|
177
|
+
BundleInfo?: string;
|
|
178
|
+
/**
|
|
179
|
+
* <p>GIT配置ID,对应GetWorkspaceConfig接口中的ConfigKey</p>
|
|
180
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
181
|
+
*/
|
|
182
|
+
GitConfigId?: string;
|
|
183
|
+
/**
|
|
184
|
+
* <p>Git分支信息</p>
|
|
185
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
186
|
+
*/
|
|
187
|
+
GitBranch?: string;
|
|
188
|
+
}
|
|
189
|
+
/**
|
|
190
|
+
* 任务重试策略
|
|
191
|
+
*/
|
|
192
|
+
export interface TaskRetryStrategy {
|
|
193
|
+
/**
|
|
194
|
+
* 最多重试次数,默认3
|
|
195
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
196
|
+
*/
|
|
197
|
+
MaxRetryTimes?: number;
|
|
198
|
+
/**
|
|
199
|
+
* 重试之间等待时间,默认5
|
|
200
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
201
|
+
*/
|
|
202
|
+
RetryBetweenWaitTime?: number;
|
|
203
|
+
/**
|
|
204
|
+
* 重试之间等待时间单位
|
|
205
|
+
毫秒:MILLISECOND秒:SECOND分钟(默认):MINUTE小时:HOUR
|
|
206
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
207
|
+
*/
|
|
208
|
+
RetryBetweenWaitTimeUnit?: string;
|
|
209
|
+
/**
|
|
210
|
+
* 任务运行失败时重试开关,默认为true
|
|
211
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
212
|
+
*/
|
|
213
|
+
TaskRunFailureRetrySwitch?: boolean;
|
|
214
|
+
/**
|
|
215
|
+
* 任务运行超时时重试开关,默认为false
|
|
216
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
217
|
+
*/
|
|
218
|
+
TaskRunTimeoutRetrySwitch?: boolean;
|
|
219
|
+
}
|
|
220
|
+
/**
|
|
221
|
+
* 文件存储
|
|
222
|
+
*/
|
|
223
|
+
export interface FileStorage {
|
|
224
|
+
/**
|
|
225
|
+
* 存储类型
|
|
226
|
+
*/
|
|
227
|
+
StorageType?: number;
|
|
228
|
+
/**
|
|
229
|
+
* 存储路径
|
|
230
|
+
*/
|
|
231
|
+
StoragePath?: string;
|
|
232
|
+
/**
|
|
233
|
+
* 文件内容
|
|
234
|
+
*/
|
|
235
|
+
Content?: string;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* 工作流调度高级配置。
|
|
239
|
+
*/
|
|
240
|
+
export interface WorkflowTriggerAdvancedConfiguration {
|
|
241
|
+
/**
|
|
242
|
+
* 任务重试模式
|
|
243
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
244
|
+
*/
|
|
245
|
+
TaskRetryMode?: string;
|
|
246
|
+
}
|
|
247
|
+
/**
|
|
248
|
+
* DeleteWorkflow返回参数结构体
|
|
249
|
+
*/
|
|
250
|
+
export interface DeleteWorkflowResponse {
|
|
251
|
+
/**
|
|
252
|
+
* <p>删除工作流响应内容</p>
|
|
253
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
254
|
+
*/
|
|
255
|
+
Data?: DeleteWorkflowRsp;
|
|
256
|
+
/**
|
|
257
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
258
|
+
*/
|
|
259
|
+
RequestId?: string;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
* 内嵌工作流任务简要信息(目前只有 FOR_EACH 工作流任务该字段才有值)
|
|
263
|
+
*/
|
|
264
|
+
export interface InnerWorkflowTaskBrief {
|
|
265
|
+
/**
|
|
266
|
+
* 任务ID
|
|
267
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
268
|
+
*/
|
|
269
|
+
TaskId?: string;
|
|
270
|
+
/**
|
|
271
|
+
* 任务名称
|
|
272
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
273
|
+
*/
|
|
274
|
+
TaskName?: string;
|
|
275
|
+
/**
|
|
276
|
+
* 任务类型名称
|
|
277
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
278
|
+
*/
|
|
279
|
+
TaskTypeName?: string;
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* 监控指标配置
|
|
283
|
+
*/
|
|
284
|
+
export interface MonitorMetricBrief {
|
|
285
|
+
/**
|
|
286
|
+
* 监控指标 ID,创建时无需传入,由服务端生成
|
|
287
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
288
|
+
*/
|
|
289
|
+
MonitorMetricId?: string;
|
|
290
|
+
/**
|
|
291
|
+
* 告警的监控对象类型,如工作流、任务等,当前支持 1. WORKFLOW 2. TASK
|
|
292
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
293
|
+
*/
|
|
294
|
+
AlarmMonitorType?: string;
|
|
295
|
+
/**
|
|
296
|
+
* 监控指标列表
|
|
297
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
298
|
+
*/
|
|
299
|
+
Metrics?: Array<MonitorMetricItem>;
|
|
300
|
+
}
|
|
301
|
+
/**
|
|
302
|
+
* 内嵌工作流单次迭代运行信息
|
|
303
|
+
*/
|
|
304
|
+
export interface InnerWorkflowTaskRunIteration {
|
|
305
|
+
/**
|
|
306
|
+
* <p>内嵌工作流运行ID</p>
|
|
307
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
308
|
+
*/
|
|
309
|
+
WorkflowRunId?: string;
|
|
310
|
+
/**
|
|
311
|
+
* <p>迭代序号</p>
|
|
312
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
313
|
+
*/
|
|
314
|
+
IterationIndex?: string;
|
|
315
|
+
/**
|
|
316
|
+
* <p>运行开始时间,单位:毫秒时间戳</p>
|
|
317
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
318
|
+
*/
|
|
319
|
+
RunStartTime?: string;
|
|
320
|
+
/**
|
|
321
|
+
* <p>运行结束时间,单位:毫秒时间戳</p>
|
|
322
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
323
|
+
*/
|
|
324
|
+
RunEndTime?: string;
|
|
325
|
+
/**
|
|
326
|
+
* <p>运行状态(参考工作流运行状态枚举)</p>
|
|
327
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
328
|
+
*/
|
|
329
|
+
RunState?: string;
|
|
330
|
+
/**
|
|
331
|
+
* <p>运行时长,单位:秒</p>
|
|
332
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
333
|
+
*/
|
|
334
|
+
RunCostTime?: string;
|
|
335
|
+
/**
|
|
336
|
+
* <p>运行参数</p>
|
|
337
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
338
|
+
*/
|
|
339
|
+
WorkflowParams?: string;
|
|
340
|
+
/**
|
|
341
|
+
* <p>错误码</p>
|
|
342
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
343
|
+
*/
|
|
344
|
+
ErrorCodeString?: string;
|
|
345
|
+
/**
|
|
346
|
+
* <p>内嵌工作流内部的任务运行</p>
|
|
347
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
348
|
+
*/
|
|
349
|
+
InnerTaskRun?: InnerWorkflowTaskRunIterationBrief;
|
|
350
|
+
}
|
|
351
|
+
/**
|
|
352
|
+
* DeleteWorkflow请求参数结构体
|
|
353
|
+
*/
|
|
354
|
+
export interface DeleteWorkflowRequest {
|
|
355
|
+
/**
|
|
356
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
357
|
+
*/
|
|
358
|
+
WorkspaceId: string;
|
|
359
|
+
/**
|
|
360
|
+
* <p>待删除的工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
361
|
+
*/
|
|
362
|
+
WorkflowId: string;
|
|
363
|
+
}
|
|
364
|
+
/**
|
|
365
|
+
* ListWorkflowTaskRuns请求参数结构体
|
|
366
|
+
*/
|
|
367
|
+
export interface ListWorkflowTaskRunsRequest {
|
|
368
|
+
/**
|
|
369
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
370
|
+
*/
|
|
371
|
+
WorkspaceId: string;
|
|
372
|
+
/**
|
|
373
|
+
* <p>任务ID,可通过 ListWorkflowTasks 获取。非必填,精确匹配。与 WorkflowRunId 至少传一个:仅传 TaskId 时查询该任务的全部运行历史。</p>
|
|
374
|
+
*/
|
|
375
|
+
TaskId?: string;
|
|
376
|
+
/**
|
|
377
|
+
* <p>工作流运行ID,可通过 ListWorkflowRuns 获取。非必填,精确匹配。与 TaskId 至少传一个:仅传 WorkflowRunId 时查询该次工作流运行下的全部任务运行。</p>
|
|
378
|
+
*/
|
|
379
|
+
WorkflowRunId?: string;
|
|
380
|
+
/**
|
|
381
|
+
* <p>分页页码,从 1 开始。非必填,默认 1</p>
|
|
382
|
+
*/
|
|
383
|
+
PageNumber?: number;
|
|
384
|
+
/**
|
|
385
|
+
* <p>每页大小。非必填,默认 10,取值范围 [10, 200]</p>
|
|
386
|
+
*/
|
|
387
|
+
PageSize?: number;
|
|
388
|
+
}
|
|
389
|
+
/**
|
|
390
|
+
* 告警配置
|
|
391
|
+
*/
|
|
392
|
+
export interface AlarmBrief {
|
|
393
|
+
/**
|
|
394
|
+
* 告警 ID,创建时无需传入,由服务端生成
|
|
395
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
396
|
+
*/
|
|
397
|
+
AlarmId?: string;
|
|
398
|
+
/**
|
|
399
|
+
* 告警的监控对象类型,如工作流、任务等,当前支持 1. WORKFLOW 2. TASK
|
|
400
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
401
|
+
*/
|
|
402
|
+
AlarmMonitorType?: string;
|
|
403
|
+
/**
|
|
404
|
+
* 告警组,最多 50 个
|
|
405
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
406
|
+
*/
|
|
407
|
+
AlarmGroups?: Array<AlarmGroup>;
|
|
408
|
+
/**
|
|
409
|
+
* 被跳过时免打扰,默认值 false
|
|
410
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
411
|
+
*/
|
|
412
|
+
DoNotDisturbWhenSkipped?: boolean;
|
|
413
|
+
/**
|
|
414
|
+
* 被手动终止时免打扰,默认值 false
|
|
415
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
416
|
+
*/
|
|
417
|
+
DoNotDisturbWhenManuallyTerminated?: boolean;
|
|
418
|
+
/**
|
|
419
|
+
* 最后一次重试前免打扰,默认值 false
|
|
420
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
421
|
+
*/
|
|
422
|
+
DoNotDisturbUntilTheLastRetry?: boolean;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* 工作流列表项中的工作流任务节点简要信息
|
|
426
|
+
*/
|
|
427
|
+
export interface WorkflowTaskNodeBrief {
|
|
428
|
+
/**
|
|
429
|
+
* 工作流ID
|
|
430
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
431
|
+
*/
|
|
432
|
+
WorkflowId?: string;
|
|
433
|
+
/**
|
|
434
|
+
* 任务ID
|
|
435
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
436
|
+
*/
|
|
437
|
+
TaskId?: string;
|
|
438
|
+
/**
|
|
439
|
+
* 任务名称
|
|
440
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
441
|
+
*/
|
|
442
|
+
TaskName?: string;
|
|
443
|
+
/**
|
|
444
|
+
* 任务类型名称
|
|
445
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
446
|
+
*/
|
|
447
|
+
TaskTypeName?: string;
|
|
448
|
+
/**
|
|
449
|
+
* 任务依赖列表
|
|
450
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
451
|
+
*/
|
|
452
|
+
DependOnList?: Array<DependOnBrief>;
|
|
453
|
+
/**
|
|
454
|
+
* 任务资源组ID
|
|
455
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
456
|
+
*/
|
|
457
|
+
ResourceGroupId?: string;
|
|
458
|
+
/**
|
|
459
|
+
* 任务资源组名称
|
|
460
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
461
|
+
*/
|
|
462
|
+
ResourceGroupName?: string;
|
|
463
|
+
/**
|
|
464
|
+
* 任务X坐标
|
|
465
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
466
|
+
*/
|
|
467
|
+
LeftCoordinate?: number;
|
|
468
|
+
/**
|
|
469
|
+
* 任务Y坐标
|
|
470
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
471
|
+
*/
|
|
472
|
+
TopCoordinate?: number;
|
|
473
|
+
/**
|
|
474
|
+
* 任务重试策略
|
|
475
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
476
|
+
*/
|
|
477
|
+
TaskRetryStrategy?: TaskRetryStrategy;
|
|
478
|
+
/**
|
|
479
|
+
* 依赖运行条件
|
|
480
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
481
|
+
*/
|
|
482
|
+
DependOnRunCondition?: string;
|
|
483
|
+
/**
|
|
484
|
+
* 高级依赖配置
|
|
485
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
486
|
+
*/
|
|
487
|
+
AdvancedDependencyConfig?: AdvancedDependencyConfig;
|
|
488
|
+
/**
|
|
489
|
+
* 内嵌工作流任务节点
|
|
490
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
491
|
+
*/
|
|
492
|
+
InnerTask?: WorkflowTaskNodeBrief;
|
|
493
|
+
}
|
|
494
|
+
/**
|
|
495
|
+
* 工作流基本信息(出参用,含系统生成字段与负责人展示信息)
|
|
496
|
+
*/
|
|
497
|
+
export interface WorkflowBaseInfoDetail {
|
|
498
|
+
/**
|
|
499
|
+
* 工作流名称
|
|
500
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
501
|
+
*/
|
|
502
|
+
WorkflowName?: string;
|
|
503
|
+
/**
|
|
504
|
+
* 工作流ID
|
|
505
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
506
|
+
*/
|
|
507
|
+
WorkflowId?: string;
|
|
508
|
+
/**
|
|
509
|
+
* 创建人UIN
|
|
510
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
511
|
+
*/
|
|
512
|
+
CreateUserUin?: string;
|
|
513
|
+
/**
|
|
514
|
+
* 工作流运行人UIN
|
|
515
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
516
|
+
*/
|
|
517
|
+
RunUserUin?: string;
|
|
518
|
+
/**
|
|
519
|
+
* 描述
|
|
520
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
521
|
+
*/
|
|
522
|
+
Description?: string;
|
|
523
|
+
/**
|
|
524
|
+
* 工作流负责人用户名
|
|
525
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
526
|
+
*/
|
|
527
|
+
OwnerUserName?: string;
|
|
528
|
+
/**
|
|
529
|
+
* 工作流负责人UIN
|
|
530
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
531
|
+
*/
|
|
532
|
+
OwnerUserUin?: string;
|
|
533
|
+
/**
|
|
534
|
+
* 工作流负责人展示名
|
|
535
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
536
|
+
*/
|
|
537
|
+
OwnerDisplayName?: string;
|
|
538
|
+
/**
|
|
539
|
+
* 创建时间,单位:毫秒时间戳
|
|
540
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
541
|
+
*/
|
|
542
|
+
CreateTime?: string;
|
|
543
|
+
/**
|
|
544
|
+
* 更新时间,单位:毫秒时间戳
|
|
545
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
546
|
+
*/
|
|
547
|
+
UpdateTime?: string;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* 工作流列表项的运行情况
|
|
551
|
+
*/
|
|
552
|
+
export interface WorkflowRunBrief {
|
|
553
|
+
/**
|
|
554
|
+
* 工作流运行ID
|
|
555
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
556
|
+
*/
|
|
557
|
+
WorkflowRunId?: string;
|
|
558
|
+
/**
|
|
559
|
+
* 运行开始时间,单位:毫秒时间戳
|
|
560
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
561
|
+
*/
|
|
562
|
+
RunStartTime?: string;
|
|
563
|
+
/**
|
|
564
|
+
* 运行状态
|
|
565
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
566
|
+
*/
|
|
567
|
+
RunState?: string;
|
|
568
|
+
/**
|
|
569
|
+
* 运行错误码
|
|
570
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
571
|
+
*/
|
|
572
|
+
ErrorCodeString?: string;
|
|
573
|
+
}
|
|
574
|
+
/**
|
|
575
|
+
* 批量异步操作的逐项结果
|
|
576
|
+
*/
|
|
577
|
+
export interface AsyncActionRsp {
|
|
578
|
+
/**
|
|
579
|
+
* 多个操作项的结果列表
|
|
580
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
581
|
+
*/
|
|
582
|
+
ActionResults?: Array<RunActionBrief>;
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
* Notebook/Python单元格输出配置
|
|
586
|
+
*/
|
|
587
|
+
export interface FileOutputConf {
|
|
588
|
+
/**
|
|
589
|
+
* 单元格 ID
|
|
590
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
591
|
+
*/
|
|
592
|
+
CellId?: string;
|
|
593
|
+
/**
|
|
594
|
+
* Dashboard 图表配置,JSON 字符串
|
|
595
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
596
|
+
*/
|
|
597
|
+
DashboardConf?: string;
|
|
598
|
+
/**
|
|
599
|
+
* 执行结果文件的预签名下载链接
|
|
600
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
601
|
+
*/
|
|
602
|
+
OutputPath?: string;
|
|
603
|
+
}
|
|
604
|
+
/**
|
|
605
|
+
* 任务调度参数(运行/重跑工作流时的自定义参数)
|
|
606
|
+
*/
|
|
607
|
+
export interface TaskSchedulingParameterBrief {
|
|
608
|
+
/**
|
|
609
|
+
* 参数名
|
|
610
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
611
|
+
*/
|
|
612
|
+
ParamKey?: string;
|
|
613
|
+
/**
|
|
614
|
+
* 参数值
|
|
615
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
616
|
+
*/
|
|
617
|
+
ParamValue?: string;
|
|
618
|
+
}
|
|
619
|
+
/**
|
|
620
|
+
* UpdateWorkflow请求参数结构体
|
|
621
|
+
*/
|
|
622
|
+
export interface UpdateWorkflowRequest {
|
|
623
|
+
/**
|
|
624
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
625
|
+
*/
|
|
626
|
+
WorkspaceId: string;
|
|
627
|
+
/**
|
|
628
|
+
* <p>待更新的工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
629
|
+
*/
|
|
630
|
+
WorkflowId: string;
|
|
631
|
+
/**
|
|
632
|
+
* <p>需要清空的字段名列表,用于将指定字段重置为空</p>
|
|
633
|
+
*/
|
|
634
|
+
FieldToRemoveList?: Array<string>;
|
|
635
|
+
/**
|
|
636
|
+
* <p>更新后的工作流配置,仅传入需要变更的部分即可</p>
|
|
637
|
+
*/
|
|
638
|
+
NewSetting?: Workflow;
|
|
639
|
+
}
|
|
640
|
+
/**
|
|
641
|
+
* 任务运行条件规则
|
|
642
|
+
*/
|
|
643
|
+
export interface TaskRunConditionRule {
|
|
644
|
+
/**
|
|
645
|
+
* 上游任务ID
|
|
646
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
647
|
+
*/
|
|
648
|
+
UpstreamTaskId?: string;
|
|
649
|
+
/**
|
|
650
|
+
* 上游任务名称
|
|
651
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
652
|
+
*/
|
|
653
|
+
UpstreamTaskName?: string;
|
|
654
|
+
/**
|
|
655
|
+
* 任务可运行条件
|
|
656
|
+
支持的状态值: - SUCCESS: 成功 - FAILED: 失败 - UPSTREAM_FAILED: 上游失败 - EXCLUDED: 排除运行
|
|
657
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
658
|
+
*/
|
|
659
|
+
AllowedStates?: Array<string>;
|
|
660
|
+
}
|
|
661
|
+
/**
|
|
662
|
+
* 资源组信息
|
|
663
|
+
*/
|
|
664
|
+
export interface ResourceGroupInfo {
|
|
665
|
+
/**
|
|
666
|
+
* 资源组ID
|
|
667
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
668
|
+
*/
|
|
669
|
+
ResourceGroupId?: string;
|
|
670
|
+
/**
|
|
671
|
+
* 资源组名称
|
|
672
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
673
|
+
*/
|
|
674
|
+
ResourceGroupName?: string;
|
|
675
|
+
/**
|
|
676
|
+
* 资源组状态
|
|
677
|
+
COMPUTE_RESOURCE_STATUS_UNSPECIFIED 未指定
|
|
678
|
+
COMPUTE_RESOURCE_STATUS_PENDING_CREATE 待创建
|
|
679
|
+
COMPUTE_RESOURCE_STATUS_CREATING 创建中
|
|
680
|
+
COMPUTE_RESOURCE_STATUS_RUNNING 运行中
|
|
681
|
+
COMPUTE_RESOURCE_STATUS_STOPPED 已停止
|
|
682
|
+
COMPUTE_RESOURCE_STATUS_STOPPING 停止中
|
|
683
|
+
COMPUTE_RESOURCE_STATUS_STARTING 启动中
|
|
684
|
+
COMPUTE_RESOURCE_STATUS_UPDATING 更新中
|
|
685
|
+
COMPUTE_RESOURCE_STATUS_DELETING 删除中
|
|
686
|
+
COMPUTE_RESOURCE_STATUS_DELETED 已删除
|
|
687
|
+
COMPUTE_RESOURCE_STATUS_FAILED 失败
|
|
688
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
689
|
+
*/
|
|
690
|
+
ResourceGroupStatus?: string;
|
|
691
|
+
}
|
|
692
|
+
/**
|
|
693
|
+
* UnbindWorkflowBundle返回参数结构体
|
|
694
|
+
*/
|
|
695
|
+
export interface UnbindWorkflowBundleResponse {
|
|
696
|
+
/**
|
|
697
|
+
* <p>解绑工作流Bundle信息响应内容</p>
|
|
698
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
699
|
+
*/
|
|
700
|
+
Data?: UnbindWorkflowBundleRsp;
|
|
701
|
+
/**
|
|
702
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
703
|
+
*/
|
|
704
|
+
RequestId?: string;
|
|
705
|
+
}
|
|
706
|
+
/**
|
|
707
|
+
* KillWorkflowRun返回参数结构体
|
|
708
|
+
*/
|
|
709
|
+
export interface KillWorkflowRunResponse {
|
|
710
|
+
/**
|
|
711
|
+
* <p>终止工作流的运行响应内容</p>
|
|
712
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
713
|
+
*/
|
|
714
|
+
Data?: AsyncActionRsp;
|
|
715
|
+
/**
|
|
716
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
717
|
+
*/
|
|
718
|
+
RequestId?: string;
|
|
719
|
+
}
|
|
720
|
+
/**
|
|
721
|
+
* ListWorkflowRuns请求参数结构体
|
|
722
|
+
*/
|
|
723
|
+
export interface ListWorkflowRunsRequest {
|
|
724
|
+
/**
|
|
725
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
726
|
+
*/
|
|
727
|
+
WorkspaceId: string;
|
|
728
|
+
/**
|
|
729
|
+
* <p>分页页码,从 1 开始。非必填,默认 1</p>
|
|
730
|
+
*/
|
|
731
|
+
PageNumber?: number;
|
|
732
|
+
/**
|
|
733
|
+
* <p>每页大小。非必填,默认 10,取值范围 [10, 200]</p>
|
|
734
|
+
*/
|
|
735
|
+
PageSize?: number;
|
|
736
|
+
/**
|
|
737
|
+
* <p>工作流ID,精确匹配。非必填,单值</p>
|
|
738
|
+
*/
|
|
739
|
+
WorkflowId?: string;
|
|
740
|
+
/**
|
|
741
|
+
* <p>工作流名称关键字,对 WorkflowName 做模糊匹配。非必填,单值</p>
|
|
742
|
+
*/
|
|
743
|
+
WorkflowNameKeyword?: string;
|
|
744
|
+
/**
|
|
745
|
+
* <p>运行创建时间下界,范围匹配(CreateTime >= 本值),单位:毫秒时间戳。<br>非必填,单值,对应出参 WorkflowRun.CreateTime</p>
|
|
746
|
+
*/
|
|
747
|
+
CreateStartTime?: string;
|
|
748
|
+
/**
|
|
749
|
+
* <p>运行创建时间上界,范围匹配(CreateTime <= 本值),单位:毫秒时间戳。<br>非必填,单值,对应出参 WorkflowRun.CreateTime</p>
|
|
750
|
+
*/
|
|
751
|
+
CreateEndTime?: string;
|
|
752
|
+
/**
|
|
753
|
+
* <p>运行状态,精确匹配。非必填,多选(多个值之间为 OR 关系)。</p><p>可填 SUCCESS / FAILED 等,具体参考本接口出参 WorkflowRun.RunState 字段返回值。</p>
|
|
754
|
+
*/
|
|
755
|
+
RunStates?: Array<string>;
|
|
756
|
+
/**
|
|
757
|
+
* <p>错误码,精确匹配。非必填,多选(多个值之间为 OR 关系)</p>
|
|
758
|
+
*/
|
|
759
|
+
ErrorCodeStrings?: Array<string>;
|
|
760
|
+
/**
|
|
761
|
+
* <p>运行人UIN,精确匹配。非必填,多选(多个值之间为 OR 关系)</p>
|
|
762
|
+
*/
|
|
763
|
+
RunUserUins?: Array<string>;
|
|
764
|
+
/**
|
|
765
|
+
* <p>标签名称ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)</p>
|
|
766
|
+
*/
|
|
767
|
+
LabelKeyIds?: Array<string>;
|
|
768
|
+
/**
|
|
769
|
+
* <p>标签值ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)</p>
|
|
770
|
+
*/
|
|
771
|
+
LabelValueIds?: Array<string>;
|
|
772
|
+
/**
|
|
773
|
+
* <p>排序条件,多个之间按数组顺序表示优先级。非必填,默认按 CreateTime Desc。<br>可排序字段白名单:CreateTime、EndTime、RunCostTime</p>
|
|
774
|
+
*/
|
|
775
|
+
OrderBys?: Array<OrderBy>;
|
|
776
|
+
}
|
|
777
|
+
/**
|
|
778
|
+
* 工作流调度配置。
|
|
779
|
+
*/
|
|
780
|
+
export interface WorkflowTriggerConfiguration {
|
|
781
|
+
/**
|
|
782
|
+
* 调度配置ID,创建时无需传入,由服务端生成
|
|
783
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
784
|
+
*/
|
|
785
|
+
TriggerId?: string;
|
|
786
|
+
/**
|
|
787
|
+
* 调度状态 启动:START,暂停:PAUSE
|
|
788
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
789
|
+
*/
|
|
790
|
+
SchedulerStatus?: string;
|
|
791
|
+
/**
|
|
792
|
+
* 触发方式,
|
|
793
|
+
- 定时触发:TIME_TRIGGER
|
|
794
|
+
- 持续运行:CONTINUE_RUN
|
|
795
|
+
|
|
796
|
+
注意:
|
|
797
|
+
- TIME_TRIGGER 模式下,SchedulerStatus、SchedulerTimeZone、StartTime、EndTime、ConfigMode、CycleType、CrontabExpression 必填;
|
|
798
|
+
- CONTINUE_RUN 模式下,AdvancedConfig必填;
|
|
799
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
800
|
+
*/
|
|
801
|
+
TriggerMode?: string;
|
|
802
|
+
/**
|
|
803
|
+
* 调度时区
|
|
804
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
805
|
+
*/
|
|
806
|
+
SchedulerTimeZone?: string;
|
|
807
|
+
/**
|
|
808
|
+
* 调度生效时间,单位:毫秒时间戳。必须小于 EndTime
|
|
809
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
810
|
+
*/
|
|
811
|
+
StartTime?: string;
|
|
812
|
+
/**
|
|
813
|
+
* 调度结束时间,单位:毫秒时间戳。必须大于 StartTime
|
|
814
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
815
|
+
*/
|
|
816
|
+
EndTime?: string;
|
|
817
|
+
/**
|
|
818
|
+
* 配置方式,常规:COMMON,CRON表达式:CRON_EXPRESSION
|
|
819
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
820
|
+
*/
|
|
821
|
+
ConfigMode?: string;
|
|
822
|
+
/**
|
|
823
|
+
* 周期类型:支持的类型为 ONEOFF_CYCLE: 一次性 YEAR_CYCLE: 年 MONTH_CYCLE: 月 WEEK_CYCLE: 周 DAY_CYCLE: 天
|
|
824
|
+
HOUR_CYCLE: 小时 MINUTE_CYCLE: 分钟 CRONTAB_CYCLE: crontab表达式类型
|
|
825
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
826
|
+
*/
|
|
827
|
+
CycleType?: string;
|
|
828
|
+
/**
|
|
829
|
+
* cron表达式
|
|
830
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
831
|
+
*/
|
|
832
|
+
CrontabExpression?: string;
|
|
833
|
+
/**
|
|
834
|
+
* Json格式,对账使用
|
|
835
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
836
|
+
*/
|
|
837
|
+
ExtraInfo?: string;
|
|
838
|
+
/**
|
|
839
|
+
* 高级配置
|
|
840
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
841
|
+
*/
|
|
842
|
+
AdvancedConfig?: WorkflowTriggerAdvancedConfiguration;
|
|
843
|
+
}
|
|
844
|
+
/**
|
|
845
|
+
* GetWorkflowTaskRun返回参数结构体
|
|
846
|
+
*/
|
|
847
|
+
export interface GetWorkflowTaskRunResponse {
|
|
848
|
+
/**
|
|
849
|
+
* <p>查询任务运行详情响应内容</p>
|
|
850
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
851
|
+
*/
|
|
852
|
+
Data?: GetWorkflowTaskRunRsp;
|
|
853
|
+
/**
|
|
854
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
855
|
+
*/
|
|
856
|
+
RequestId?: string;
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
* GetFile请求参数结构体
|
|
860
|
+
*/
|
|
861
|
+
export interface GetFileRequest {
|
|
862
|
+
/**
|
|
863
|
+
* <p>工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId</p>
|
|
864
|
+
*/
|
|
865
|
+
WorkspaceId: string;
|
|
866
|
+
/**
|
|
867
|
+
* <p>文件 ID。来源:CreateFile / ListFiles 接口返回的 FileId。与 FilePath 二选一</p>
|
|
868
|
+
*/
|
|
869
|
+
FileId?: string;
|
|
870
|
+
/**
|
|
871
|
+
* <p>文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType</p>
|
|
872
|
+
*/
|
|
873
|
+
FileType?: string;
|
|
874
|
+
/**
|
|
875
|
+
* <p>是否返回文件内容。true 时 Storage.Content 返回 base64 内容,默认 false</p>
|
|
876
|
+
*/
|
|
877
|
+
IncludeContent?: boolean;
|
|
878
|
+
/**
|
|
879
|
+
* <p>文件版本 ID。来源:ListFileVersions 接口返回的 VersionId。不传则读取最新版本</p>
|
|
880
|
+
*/
|
|
881
|
+
VersionId?: string;
|
|
882
|
+
/**
|
|
883
|
+
* <p>文件完整路径,以 / 开头,如 /etl/daily/demo.ipynb。与 FileId 二选一</p>
|
|
884
|
+
*/
|
|
885
|
+
FilePath?: string;
|
|
886
|
+
}
|
|
887
|
+
/**
|
|
888
|
+
* 工作流基本信息(入参用)
|
|
889
|
+
*/
|
|
890
|
+
export interface WorkflowBaseInfo {
|
|
891
|
+
/**
|
|
892
|
+
* 工作流名称,长度不超过 1024
|
|
893
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
894
|
+
*/
|
|
895
|
+
WorkflowName?: string;
|
|
896
|
+
/**
|
|
897
|
+
* 工作流ID,创建时无需传入,由服务端生成
|
|
898
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
899
|
+
*/
|
|
900
|
+
WorkflowId?: string;
|
|
901
|
+
/**
|
|
902
|
+
* 工作流运行人UIN
|
|
903
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
904
|
+
*/
|
|
905
|
+
RunUserUin?: string;
|
|
906
|
+
/**
|
|
907
|
+
* 描述
|
|
908
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
909
|
+
*/
|
|
910
|
+
Description?: string;
|
|
911
|
+
/**
|
|
912
|
+
* 工作流负责人用户名
|
|
913
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
914
|
+
*/
|
|
915
|
+
OwnerUserName?: string;
|
|
916
|
+
/**
|
|
917
|
+
* 创建人UIN。系统生成字段,入参传值不生效(服务端忽略且不报错)
|
|
918
|
+
【已废弃】服务端忽略传入值,不报错。
|
|
919
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
920
|
+
*/
|
|
921
|
+
CreateUserUin?: string;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* ### `TaskTypePropertyList` 中 `TaskTypeProperty` 针对不同任务类型需要填写不同的 key 和 value;
|
|
925
|
+
|
|
926
|
+
### 1. NOTEBOOK 任务类型
|
|
927
|
+
|
|
928
|
+
#### 属性配置
|
|
929
|
+
|
|
930
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
931
|
+
| ------------ | ----------------- | ---------------------------------- | ----------------------- |
|
|
932
|
+
| Source | 来源 | 可填2或5,来源 2:GIT, 5:工作空间 | 是 |
|
|
933
|
+
| NotebookPath | Notebook 相对路径 | Source为5时,需从(ListFiles)获取 | Source 为 2、5 时,必填 |
|
|
934
|
+
|
|
935
|
+
### 2. DATA_INTEGRATION 任务类型
|
|
936
|
+
|
|
937
|
+
#### 属性配置
|
|
938
|
+
|
|
939
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
940
|
+
| --------------------- | -------------------- | --------------------------------------- | -------- |
|
|
941
|
+
| Source | 来源 | 必填:4,表示来源为COS | 是 |
|
|
942
|
+
| TemplatePath | 数据接入任务配置路径 | 需从(ListBatchIngestionTasks)接口获取 | 是 |
|
|
943
|
+
| DataIntegrationTaskId | 数据接入任务ID | 需从(ListBatchIngestionTasks)接口获取 | 是 |
|
|
944
|
+
|
|
945
|
+
### 3. RUN_WORKFLOW 任务类型
|
|
946
|
+
|
|
947
|
+
#### 属性配置
|
|
948
|
+
|
|
949
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
950
|
+
| ---------- | ---------- | ----------------------------- | -------- |
|
|
951
|
+
| WorkflowId | 选择工作流 | 需从(ListWorkflows)接口获取 | 是 |
|
|
952
|
+
|
|
953
|
+
### 4. SQL 任务类型
|
|
954
|
+
|
|
955
|
+
#### 属性配置
|
|
956
|
+
|
|
957
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
958
|
+
| --------------- | ----------- | --------------------------------------------- | -------------------- |
|
|
959
|
+
| Source | 来源 | 可填2或5,来源 2:GIT, 5:工作空间 | 是 |
|
|
960
|
+
| SqlPath | SQL脚本路径 | SQL脚本路径 | Source 为 2 时,必填 |
|
|
961
|
+
| CodeFileName | 文件名称 | Source为5时,需从(ListReleasedQueries)接口获取 | 否 |
|
|
962
|
+
| CodeFileId | 文件ID | Source为5时,需从(ListReleasedQueries)接口获取 | Source 为 5 时,必填 |
|
|
963
|
+
| CodeFileVersion | 文件版本 | Source为5时,需从(ListReleasedQueries)接口获取 | 否 |
|
|
964
|
+
|
|
965
|
+
### 5. PYTHON 任务类型
|
|
966
|
+
|
|
967
|
+
#### 属性配置
|
|
968
|
+
|
|
969
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
970
|
+
| ---------- | -------------- | -------------------------------------- | -------- |
|
|
971
|
+
| Source | 来源 | 可填2或5,来源 2:GIT, 5:工作空间 | 是 |
|
|
972
|
+
| SourcePath | Python脚本路径 | Source为5时,需从(ListFiles)接口获取 | 是 |
|
|
973
|
+
|
|
974
|
+
### 6. DATA_QUALITY(质量监控)任务类型
|
|
975
|
+
|
|
976
|
+
#### 属性配置
|
|
977
|
+
|
|
978
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
979
|
+
| -------------- | ---------------- | --------------------------------------------- | -------- |
|
|
980
|
+
| Source | 来源 | 必填:4,表示来源为COS | 是 |
|
|
981
|
+
| TemplatePath | 质量监控配置路径 | 需从(ListDataQualityTaskSummaries)接口获取 | 是 |
|
|
982
|
+
| SourceUniqueId | 质量监控ID | 需从(ListDataQualityTaskSummaries)接口获取 | 是 |
|
|
983
|
+
| ExecutionType | 执行类型 | 必填:SQL | 是 |
|
|
984
|
+
| AfterAspect | 质量任务后置切面 | 需从(ListDataQualityTaskSummaries)接口获取 | 否 |
|
|
985
|
+
| BeforeAspect | 质量任务前置切面 | 需从(ListDataQualityTaskSummaries)接口获取 | 否 |
|
|
986
|
+
|
|
987
|
+
### 7. IF_ELSE 任务类型
|
|
988
|
+
|
|
989
|
+
#### 属性配置
|
|
990
|
+
|
|
991
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
992
|
+
| ---------- | -------- | --------------- | -------- |
|
|
993
|
+
| Conditions | 条件列表 | IF-ELSE条件配置 | 是 |
|
|
994
|
+
|
|
995
|
+
### 8. FOR_EACH 任务类型
|
|
996
|
+
|
|
997
|
+
#### 属性配置
|
|
998
|
+
|
|
999
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
1000
|
+
| -------------- | ------------ | ---------------------------------- | -------- |
|
|
1001
|
+
| MaxConcurrency | 最大并发数 | 最大并发数,默认为1 | 是 |
|
|
1002
|
+
| MaxIterations | 最大迭代次数 | 最大迭代次数,默认1000 | 是 |
|
|
1003
|
+
| LoopDataArray | 循环参数 | JSON格式的数组,或 {{}} 包裹的变量 | 是 |
|
|
1004
|
+
|
|
1005
|
+
### 9. RAY_JOB(Ray作业)任务类型
|
|
1006
|
+
|
|
1007
|
+
#### 属性配置
|
|
1008
|
+
|
|
1009
|
+
| 属性键 | 属性名称 | 描述 | 是否必需 |
|
|
1010
|
+
| -------------- | -------------------- | ---------------------------------- | -------- |
|
|
1011
|
+
| RunMode | 运行方式 | 运行方式,取值:SERVERLESS(按需拉起集群)/ DEDICATED(提交到指定集群)。默认 DEDICATED | 是 |
|
|
1012
|
+
| Entrypoint | 入口指令 | 入口指令 | 是 |
|
|
1013
|
+
| JobConfig | 任务配置 | 如存储配置 + 计算环境。传值请参考前端页面保存Ray作业任务时调用UpdateWorkflow。Image请调用DLC接口ListImages接口Url字段获取 | RunMode 为 SERVERLESS 时,必填 |
|
|
1014
|
+
| ClusterId | Ray 集群 | 需从所选计算资源下已配置的 Ray 集群(引擎)列表中选择,可通过计算资源相关接口获取 | RunMode 为 DEDICATED 时,必填 |
|
|
1015
|
+
| Source | 任务来源 | 任务来源,取值:1(本地文件)/ 5(工作空间) | 是 |
|
|
1016
|
+
| JobPackage | 任务来源文件地址 | 任务来源路径:Source 为 1 时存本地上传文件的 COS 地址(支持 .zip / .py 文件);Source 为 5 时存所选工作空间文件/文件夹路径 | 是 |
|
|
1017
|
+
| JobPackageName | 任务来源本地文件名 | 任务来源本地文件名 | Source 为 1 时,必填 |
|
|
1018
|
+
| CodeFileId | 代码文件ID | Source 为 5 时,需从工作空间文件选择组件获取所选文件/文件夹对应的ID | Source 为 5 时,必填 |
|
|
1019
|
+
| WorkspaceEntryType | 工作空间入口类型 | Source 为 5 时,所选工作空间条目的类型:FILE(文件)/ FOLDER(文件夹),由前端选择器随选择目标自动写入 | Source 为 5 时,必填 |
|
|
1020
|
+
|
|
1021
|
+
### RuntimePropertyList
|
|
1022
|
+
<p>任务运行参数列表,用于配置任务运行时的计算资源,与 TaskTypePropertyList(任务扩展属性)区分:TaskTypePropertyList 承载任务自身的业务配置(如脚本来源、路径等),RuntimePropertyList 承载任务运行时的资源配置(如资源模式、CU规格、Executor数量等)。</p>
|
|
1023
|
+
<p>主要适用于需要配置计算资源的任务类型(如 NOTEBOOK、PYTHON)。</p>
|
|
1024
|
+
<p>具体可填写的属性键以任务类型属性配置为准,可通过 ListWorkflowTaskTypeProperties 接口获取(propertyType 为 RUNTIME 的属性项)。常见运行参数键说明:</p>
|
|
1025
|
+
|
|
1026
|
+
| 属性键 | 属性名称 | 描述 | 必填性(联动条件满足时) | 默认值 |
|
|
1027
|
+
| ---------- | -------------- | ---------------------------------- | -------- | -------- |
|
|
1028
|
+
| ResourceMode | 资源模式 | 1:分布式;2:单节点 | 是 | 1 |
|
|
1029
|
+
| ConfigType | 配置类型 | DEFAULT:默认配置;CUSTOM:自定义配置 | 是 | DEFAULT |
|
|
1030
|
+
| ExecutorAllocation | Executor分配模式 | DYNAMIC:动态分配;FIXED:固定分配 | 是(分布式且自定义配置时) | DYNAMIC |
|
|
1031
|
+
| ExecutorMinNum | Executor最小个数 | 正整数 | 是(动态分配时) | 1 |
|
|
1032
|
+
| ExecutorMaxNum | Executor最大个数 | 正整数 | 是(动态分配时) | 1 |
|
|
1033
|
+
| ExecutorFixedNum | Executor固定个数 | 正整数 | 否(固定分配时) | - |
|
|
1034
|
+
| ExecutorCU | Executor资源规格 | small / medium / large / xlarge / 4xlarge | 否(分布式且自定义配置时) | - |
|
|
1035
|
+
| DriverCU | Driver资源规格 | small / medium / large / xlarge / 4xlarge | 否(分布式且自定义配置时 或者单节点时) | - |
|
|
1036
|
+
| ExecutorGPU | Executor GPU数量 | 0表示不使用GPU | 否(分布式且自定义配置时) | - |
|
|
1037
|
+
| DriverGPU | Driver GPU数量 | 0表示不使用GPU | 否(分布式且自定义配置时) | - |
|
|
1038
|
+
| Style | 配置样式 | UI / JSON | 是(自定义配置时) | UI |
|
|
1039
|
+
|
|
1040
|
+
<p>补充说明:</p>
|
|
1041
|
+
<p>1. "必填性"指属性配置中的必填标记,仅当属性联动条件(如 ResourceMode=1 且 ConfigType=CUSTOM)满足时才触发必填校验;</p>
|
|
1042
|
+
<p>2. ConfigType 为 DEFAULT(默认配置)时,需调用 ListComputeResourceOptions 接口获取所选计算资源的默认规格值,并将其填充到运行参数(ExecutorCU、DriverCU、ExecutorMinNum、ExecutorMaxNum 等)后传入;ConfigType 为 CUSTOM(自定义配置)时,运行参数由调用方自行指定;</p>
|
|
1043
|
+
*/
|
|
1044
|
+
export interface TaskType {
|
|
1045
|
+
/**
|
|
1046
|
+
* <p>任务类型:SQL:用于执行SQL查询和数据处理操作;DATA_INTEGRATION:用于离线数据接入操作;NOTEBOOK:用于运行Notebook脚本;RUN_WORKFLOW:用于执行嵌套工作流;PYTHON:用于运行Python脚本;RAY_JOB:用于运行Ray作业;DATA_QUALITY:用于数据质量监控;IF_ELSE:用于条件分支判断;FOR_EACH:用于循环遍历执行;</p>
|
|
1047
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1048
|
+
*/
|
|
1049
|
+
TaskTypeName?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* <p>Notebook 类型扩展信息</p>
|
|
1052
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1053
|
+
*/
|
|
1054
|
+
Notebook?: TaskTypeNotebookExt;
|
|
1055
|
+
/**
|
|
1056
|
+
* <p>任务扩展属性列表,具体填写参考 ListWorkflowTaskTypeProperties 接口</p>
|
|
1057
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1058
|
+
*/
|
|
1059
|
+
TaskTypePropertyList?: Array<TaskTypeProperty>;
|
|
1060
|
+
/**
|
|
1061
|
+
* <p>运行时属性列表</p>
|
|
1062
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1063
|
+
*/
|
|
1064
|
+
RuntimePropertyList?: Array<TaskTypeProperty>;
|
|
1065
|
+
}
|
|
1066
|
+
/**
|
|
1067
|
+
* Notebook 类型任务扩展
|
|
1068
|
+
*/
|
|
1069
|
+
export interface TaskTypeNotebookExt {
|
|
1070
|
+
/**
|
|
1071
|
+
* 脚本来源。取值:SCRIPT_SOURCE_LOCAL(本地)/ SCRIPT_SOURCE_GIT(Git 仓库)/
|
|
1072
|
+
SCRIPT_SOURCE_CFS(CFS 文件系统)/ SCRIPT_SOURCE_COS(COS 对象存储)/
|
|
1073
|
+
SCRIPT_SOURCE_WORKSPACE(工作空间)
|
|
1074
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1075
|
+
*/
|
|
1076
|
+
Source?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* 前端显示使用,对执行平台无意义
|
|
1079
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1080
|
+
*/
|
|
1081
|
+
DisplayPath?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* Notebook 相对路径
|
|
1084
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1085
|
+
*/
|
|
1086
|
+
NotebookPath?: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Notebook 绝对路径
|
|
1089
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1090
|
+
*/
|
|
1091
|
+
NotebookAbsolutePath?: string;
|
|
1092
|
+
}
|
|
1093
|
+
/**
|
|
1094
|
+
* RerunWorkflowRun返回参数结构体
|
|
1095
|
+
*/
|
|
1096
|
+
export interface RerunWorkflowRunResponse {
|
|
1097
|
+
/**
|
|
1098
|
+
* <p>重跑工作流响应内容</p>
|
|
1099
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1100
|
+
*/
|
|
1101
|
+
Data?: AsyncActionRsp;
|
|
1102
|
+
/**
|
|
1103
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1104
|
+
*/
|
|
1105
|
+
RequestId?: string;
|
|
1106
|
+
}
|
|
1107
|
+
/**
|
|
1108
|
+
* CreateWorkflowRsp
|
|
1109
|
+
*/
|
|
1110
|
+
export interface CreateWorkflowRsp {
|
|
1111
|
+
/**
|
|
1112
|
+
* 工作流ID
|
|
1113
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1114
|
+
*/
|
|
1115
|
+
WorkflowId?: string;
|
|
1116
|
+
}
|
|
1117
|
+
/**
|
|
1118
|
+
* GetFile返回参数结构体
|
|
1119
|
+
*/
|
|
1120
|
+
export interface GetFileResponse {
|
|
1121
|
+
/**
|
|
1122
|
+
* <p>返回结果</p>
|
|
1123
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1124
|
+
*/
|
|
1125
|
+
Data?: FileInfo;
|
|
1126
|
+
/**
|
|
1127
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1128
|
+
*/
|
|
1129
|
+
RequestId?: string;
|
|
1130
|
+
}
|
|
1131
|
+
/**
|
|
1132
|
+
* OneFlow 透传的 Workspace 异步文件操作信息;作业状态由 Workspace 持久化和维护
|
|
1133
|
+
*/
|
|
1134
|
+
export interface AsyncOperation {
|
|
1135
|
+
/**
|
|
1136
|
+
* 是否异步执行;ZIP 解压创建时为 true
|
|
1137
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1138
|
+
*/
|
|
1139
|
+
IsAsync: boolean;
|
|
1140
|
+
/**
|
|
1141
|
+
* Workspace 持久化的异步作业 ID,用于查询作业进度
|
|
1142
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1143
|
+
*/
|
|
1144
|
+
JobId: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* 调用方生成的提交幂等与链路追踪标识
|
|
1147
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1148
|
+
*/
|
|
1149
|
+
OperationId: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* 异步作业状态:0-未指定,1-已受理,2-解压中,3-回调处理中,4-成功,5-部分失败,6-失败
|
|
1152
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1153
|
+
*/
|
|
1154
|
+
Status: number;
|
|
1155
|
+
}
|
|
1156
|
+
/**
|
|
1157
|
+
* CreateWorkflow请求参数结构体
|
|
1158
|
+
*/
|
|
1159
|
+
export interface CreateWorkflowRequest {
|
|
1160
|
+
/**
|
|
1161
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
1162
|
+
*/
|
|
1163
|
+
WorkspaceId: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* <p>工作流基本信息。必填,其中 WorkflowName 必填且工作空间内唯一</p>
|
|
1166
|
+
*/
|
|
1167
|
+
BaseInfo: WorkflowBaseInfo;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>工作流调度配置</p>
|
|
1170
|
+
*/
|
|
1171
|
+
Trigger?: Array<WorkflowTriggerConfiguration>;
|
|
1172
|
+
/**
|
|
1173
|
+
* <p>工作流参数列表</p>
|
|
1174
|
+
*/
|
|
1175
|
+
ParamList?: Array<ParamInfo>;
|
|
1176
|
+
/**
|
|
1177
|
+
* <p>标签列表</p>
|
|
1178
|
+
*/
|
|
1179
|
+
LabelList?: Array<LabelBrief>;
|
|
1180
|
+
/**
|
|
1181
|
+
* <p>工作流告警配置</p>
|
|
1182
|
+
*/
|
|
1183
|
+
Alarm?: AlarmBrief;
|
|
1184
|
+
/**
|
|
1185
|
+
* <p>监控指标配置。若告警条件中选择了监控告警,则本字段必填</p>
|
|
1186
|
+
*/
|
|
1187
|
+
MonitorMetric?: MonitorMetricBrief;
|
|
1188
|
+
/**
|
|
1189
|
+
* <p>工作流高级设置</p>
|
|
1190
|
+
*/
|
|
1191
|
+
AdvanceConfig?: WorkflowAdvanceConfig;
|
|
1192
|
+
/**
|
|
1193
|
+
* <p>工作流任务列表</p>
|
|
1194
|
+
*/
|
|
1195
|
+
TaskList?: Array<WorkflowTask>;
|
|
1196
|
+
/**
|
|
1197
|
+
* <p>BundleId,可通过 Bundle 相关接口获取</p>
|
|
1198
|
+
*/
|
|
1199
|
+
BundleId?: string;
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>Bundle信息</p>
|
|
1202
|
+
*/
|
|
1203
|
+
BundleInfo?: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* <p>Git配置ID,可通过 Git 配置相关接口获取</p>
|
|
1206
|
+
*/
|
|
1207
|
+
GitConfigId?: string;
|
|
1208
|
+
/**
|
|
1209
|
+
* <p>Git分支信息</p>
|
|
1210
|
+
*/
|
|
1211
|
+
GitBranch?: string;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* 查询工作流运行详情响应。
|
|
1215
|
+
*/
|
|
1216
|
+
export interface GetWorkflowRunRsp {
|
|
1217
|
+
/**
|
|
1218
|
+
* 工作流运行信息
|
|
1219
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1220
|
+
*/
|
|
1221
|
+
WorkflowRun?: WorkflowRun;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* 查询工作流任务运行列表响应。
|
|
1225
|
+
*/
|
|
1226
|
+
export interface ListWorkflowTaskRunsRsp {
|
|
1227
|
+
/**
|
|
1228
|
+
* 当前页码
|
|
1229
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1230
|
+
*/
|
|
1231
|
+
PageNumber?: number;
|
|
1232
|
+
/**
|
|
1233
|
+
* 每页大小
|
|
1234
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1235
|
+
*/
|
|
1236
|
+
PageSize?: number;
|
|
1237
|
+
/**
|
|
1238
|
+
* 总记录数
|
|
1239
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1240
|
+
*/
|
|
1241
|
+
TotalCount?: number;
|
|
1242
|
+
/**
|
|
1243
|
+
* 总页数
|
|
1244
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1245
|
+
*/
|
|
1246
|
+
TotalPageNumber?: number;
|
|
1247
|
+
/**
|
|
1248
|
+
* 任务运行历史列表
|
|
1249
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1250
|
+
*/
|
|
1251
|
+
Items?: Array<WorkflowTaskRun>;
|
|
1252
|
+
}
|
|
1253
|
+
/**
|
|
1254
|
+
* 枚举项统计(如运行状态、错误码的数量分布)
|
|
1255
|
+
*/
|
|
1256
|
+
export interface ScheduleBizEnumBrief {
|
|
1257
|
+
/**
|
|
1258
|
+
* 枚举标签键
|
|
1259
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1260
|
+
*/
|
|
1261
|
+
LabelKey?: string;
|
|
1262
|
+
/**
|
|
1263
|
+
* 枚举标签值
|
|
1264
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1265
|
+
*/
|
|
1266
|
+
LabelValue?: string;
|
|
1267
|
+
/**
|
|
1268
|
+
* 枚举项统计数量
|
|
1269
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1270
|
+
*/
|
|
1271
|
+
Count?: number;
|
|
1272
|
+
}
|
|
1273
|
+
/**
|
|
1274
|
+
* 内嵌工作流迭代中的任务运行简要信息
|
|
1275
|
+
*/
|
|
1276
|
+
export interface InnerWorkflowTaskRunIterationBrief {
|
|
1277
|
+
/**
|
|
1278
|
+
* <p>任务运行ID</p>
|
|
1279
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1280
|
+
*/
|
|
1281
|
+
WorkflowTaskRunId?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>迭代序号</p>
|
|
1284
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1285
|
+
*/
|
|
1286
|
+
IterationIndex?: string;
|
|
1287
|
+
/**
|
|
1288
|
+
* <p>运行开始时间,单位:毫秒时间戳</p>
|
|
1289
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1290
|
+
*/
|
|
1291
|
+
RunStartTime?: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>运行结束时间,单位:毫秒时间戳</p>
|
|
1294
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1295
|
+
*/
|
|
1296
|
+
RunEndTime?: string;
|
|
1297
|
+
/**
|
|
1298
|
+
* <p>运行状态</p>
|
|
1299
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1300
|
+
*/
|
|
1301
|
+
RunState?: string;
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>运行时长,单位:秒</p>
|
|
1304
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1305
|
+
*/
|
|
1306
|
+
RunCostTime?: string;
|
|
1307
|
+
/**
|
|
1308
|
+
* <p>运行参数</p>
|
|
1309
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1310
|
+
*/
|
|
1311
|
+
TaskParams?: string;
|
|
1312
|
+
/**
|
|
1313
|
+
* <p>错误码</p>
|
|
1314
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1315
|
+
*/
|
|
1316
|
+
ErrorCodeString?: string;
|
|
1317
|
+
}
|
|
1318
|
+
/**
|
|
1319
|
+
* ListWorkflowsRsp
|
|
1320
|
+
*/
|
|
1321
|
+
export interface ListWorkflowsRsp {
|
|
1322
|
+
/**
|
|
1323
|
+
* 当前页码
|
|
1324
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1325
|
+
*/
|
|
1326
|
+
PageNumber?: number;
|
|
1327
|
+
/**
|
|
1328
|
+
* 每页大小
|
|
1329
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1330
|
+
*/
|
|
1331
|
+
PageSize?: number;
|
|
1332
|
+
/**
|
|
1333
|
+
* 总记录数
|
|
1334
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1335
|
+
*/
|
|
1336
|
+
TotalCount?: number;
|
|
1337
|
+
/**
|
|
1338
|
+
* 总页数
|
|
1339
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1340
|
+
*/
|
|
1341
|
+
TotalPageNumber?: number;
|
|
1342
|
+
/**
|
|
1343
|
+
* 工作流列表
|
|
1344
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1345
|
+
*/
|
|
1346
|
+
Items?: Array<WorkflowBrief>;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
* RerunWorkflowRun请求参数结构体
|
|
1350
|
+
*/
|
|
1351
|
+
export interface RerunWorkflowRunRequest {
|
|
1352
|
+
/**
|
|
1353
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
1354
|
+
*/
|
|
1355
|
+
WorkspaceId: string;
|
|
1356
|
+
/**
|
|
1357
|
+
* <p>工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
1358
|
+
*/
|
|
1359
|
+
WorkflowId: string;
|
|
1360
|
+
/**
|
|
1361
|
+
* <p>工作流运行ID,可通过 ListWorkflowRuns 获取。必填</p>
|
|
1362
|
+
*/
|
|
1363
|
+
WorkflowRunId: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* <p>运行类型。必填。取值:1 普通运行,2 高级运行</p>
|
|
1366
|
+
*/
|
|
1367
|
+
RunType: number;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>运行类型为高级运行时填写的自定义运行参数</p>
|
|
1370
|
+
*/
|
|
1371
|
+
AdvancedParams?: Array<TaskSchedulingParameterBrief>;
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>本次需要重跑指定的任务ID集合,可通过 ListWorkflowTasks 获取,不传默认重跑该工作流下所有任务</p>
|
|
1374
|
+
*/
|
|
1375
|
+
TaskIds?: Array<string>;
|
|
1376
|
+
}
|
|
1377
|
+
/**
|
|
1378
|
+
* ListWorkflows返回参数结构体
|
|
1379
|
+
*/
|
|
1380
|
+
export interface ListWorkflowsResponse {
|
|
1381
|
+
/**
|
|
1382
|
+
* <p>查询工作流列表响应内容</p>
|
|
1383
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1384
|
+
*/
|
|
1385
|
+
Data?: ListWorkflowsRsp;
|
|
1386
|
+
/**
|
|
1387
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1388
|
+
*/
|
|
1389
|
+
RequestId?: string;
|
|
1390
|
+
}
|
|
1391
|
+
/**
|
|
1392
|
+
* 标签信息
|
|
1393
|
+
*/
|
|
1394
|
+
export interface LabelBrief {
|
|
1395
|
+
/**
|
|
1396
|
+
* 标签名称
|
|
1397
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1398
|
+
*/
|
|
1399
|
+
LabelKey?: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* 标签值
|
|
1402
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1403
|
+
*/
|
|
1404
|
+
LabelValue?: string;
|
|
1405
|
+
/**
|
|
1406
|
+
* 标签名称ID,可通过标签相关接口获取
|
|
1407
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1408
|
+
*/
|
|
1409
|
+
LabelKeyId?: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* 标签值ID,可通过标签相关接口获取
|
|
1412
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1413
|
+
*/
|
|
1414
|
+
LabelValueId?: string;
|
|
1415
|
+
}
|
|
1416
|
+
/**
|
|
1417
|
+
* 工作流列表项
|
|
1418
|
+
*/
|
|
1419
|
+
export interface WorkflowBrief {
|
|
1420
|
+
/**
|
|
1421
|
+
* <p>工作流名称</p>
|
|
1422
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1423
|
+
*/
|
|
1424
|
+
WorkflowName?: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* <p>工作流ID</p>
|
|
1427
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1428
|
+
*/
|
|
1429
|
+
WorkflowId?: string;
|
|
1430
|
+
/**
|
|
1431
|
+
* <p>描述</p>
|
|
1432
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1433
|
+
*/
|
|
1434
|
+
Description?: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* <p>创建人UIN</p>
|
|
1437
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1438
|
+
*/
|
|
1439
|
+
CreateUserUin?: string;
|
|
1440
|
+
/**
|
|
1441
|
+
* <p>工作流负责人用户名</p>
|
|
1442
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1443
|
+
*/
|
|
1444
|
+
OwnerUserName?: string;
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>工作流负责人UIN</p>
|
|
1447
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1448
|
+
*/
|
|
1449
|
+
OwnerUserUin?: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* <p>工作流负责人展示名</p>
|
|
1452
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1453
|
+
*/
|
|
1454
|
+
OwnerDisplayName?: string;
|
|
1455
|
+
/**
|
|
1456
|
+
* <p>创建时间,单位:毫秒时间戳</p>
|
|
1457
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1458
|
+
*/
|
|
1459
|
+
CreateTime?: string;
|
|
1460
|
+
/**
|
|
1461
|
+
* <p>更新时间,单位:毫秒时间戳</p>
|
|
1462
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1463
|
+
*/
|
|
1464
|
+
UpdateTime?: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* <p>标签列表</p>
|
|
1467
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1468
|
+
*/
|
|
1469
|
+
LabelList?: Array<LabelBrief>;
|
|
1470
|
+
/**
|
|
1471
|
+
* <p>工作流调度配置</p>
|
|
1472
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1473
|
+
*/
|
|
1474
|
+
Trigger?: Array<WorkflowTriggerConfiguration>;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>工作流运行人UIN</p>
|
|
1477
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1478
|
+
*/
|
|
1479
|
+
RunUserUin?: string;
|
|
1480
|
+
/**
|
|
1481
|
+
* <p>工作流运行人用户名</p>
|
|
1482
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1483
|
+
*/
|
|
1484
|
+
RunUserName?: string;
|
|
1485
|
+
/**
|
|
1486
|
+
* <p>工作流任务节点列表</p>
|
|
1487
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1488
|
+
*/
|
|
1489
|
+
TaskList?: Array<WorkflowTaskNodeBrief>;
|
|
1490
|
+
/**
|
|
1491
|
+
* <p>工作流运行情况列表</p>
|
|
1492
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1493
|
+
*/
|
|
1494
|
+
WorkflowRunList?: Array<WorkflowRunBrief>;
|
|
1495
|
+
/**
|
|
1496
|
+
* <p>资源组信息列表</p>
|
|
1497
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1498
|
+
*/
|
|
1499
|
+
ResourceGroupInfoList?: Array<ResourceGroupInfo>;
|
|
1500
|
+
/**
|
|
1501
|
+
* <p>工作流权限信息</p>
|
|
1502
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1503
|
+
*/
|
|
1504
|
+
Permission?: string;
|
|
1505
|
+
/**
|
|
1506
|
+
* <p>工作流绑定的 Bundle 唯一标识,未绑定时为空</p>
|
|
1507
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1508
|
+
*/
|
|
1509
|
+
BundleId?: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* <p>Bundle信息</p>
|
|
1512
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1513
|
+
*/
|
|
1514
|
+
BundleInfo?: string;
|
|
1515
|
+
/**
|
|
1516
|
+
* <p>Git配置ID</p>
|
|
1517
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1518
|
+
*/
|
|
1519
|
+
GitConfigId?: string;
|
|
1520
|
+
/**
|
|
1521
|
+
* <p>Git分支信息</p>
|
|
1522
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1523
|
+
*/
|
|
1524
|
+
GitBranch?: string;
|
|
1525
|
+
}
|
|
1526
|
+
/**
|
|
1527
|
+
* KillWorkflowRun请求参数结构体
|
|
1528
|
+
*/
|
|
1529
|
+
export interface KillWorkflowRunRequest {
|
|
1530
|
+
/**
|
|
1531
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
1532
|
+
*/
|
|
1533
|
+
WorkspaceId: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* <p>工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
1536
|
+
*/
|
|
1537
|
+
WorkflowId: string;
|
|
1538
|
+
/**
|
|
1539
|
+
* <p>待终止的工作流运行ID列表,可通过 ListWorkflowRuns 获取</p>
|
|
1540
|
+
*/
|
|
1541
|
+
WorkflowRunIds?: Array<string>;
|
|
1542
|
+
/**
|
|
1543
|
+
* <p>是否终止该工作流下所有未进入终态的运行。非必填,默认 false</p>
|
|
1544
|
+
*/
|
|
1545
|
+
KillAllRuns?: boolean;
|
|
1546
|
+
/**
|
|
1547
|
+
* <p>是否只终止处于等待中(Pending)状态的运行。非必填,默认 false</p>
|
|
1548
|
+
*/
|
|
1549
|
+
OnlyKillPendingRuns?: boolean;
|
|
1550
|
+
}
|
|
1551
|
+
/**
|
|
1552
|
+
* ListWorkflowTaskRuns返回参数结构体
|
|
1553
|
+
*/
|
|
1554
|
+
export interface ListWorkflowTaskRunsResponse {
|
|
1555
|
+
/**
|
|
1556
|
+
* <p>查询工作流任务历史运行列表响应内容</p>
|
|
1557
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1558
|
+
*/
|
|
1559
|
+
Data?: ListWorkflowTaskRunsRsp;
|
|
1560
|
+
/**
|
|
1561
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1562
|
+
*/
|
|
1563
|
+
RequestId?: string;
|
|
1564
|
+
}
|
|
1565
|
+
/**
|
|
1566
|
+
* 参数键值对
|
|
1567
|
+
*/
|
|
1568
|
+
export interface ParamInfo {
|
|
1569
|
+
/**
|
|
1570
|
+
* 参数ID,创建时无需传入,由服务端生成
|
|
1571
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1572
|
+
*/
|
|
1573
|
+
ParamId?: string;
|
|
1574
|
+
/**
|
|
1575
|
+
* 参数名
|
|
1576
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1577
|
+
*/
|
|
1578
|
+
ParamKey?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* 参数值
|
|
1581
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1582
|
+
*/
|
|
1583
|
+
ParamValue?: string;
|
|
1584
|
+
}
|
|
1585
|
+
/**
|
|
1586
|
+
* UnbindWorkflowBundleRsp
|
|
1587
|
+
*/
|
|
1588
|
+
export interface UnbindWorkflowBundleRsp {
|
|
1589
|
+
/**
|
|
1590
|
+
* 操作状态,true 表示成功
|
|
1591
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1592
|
+
*/
|
|
1593
|
+
Status?: boolean;
|
|
1594
|
+
}
|
|
1595
|
+
/**
|
|
1596
|
+
* 文件删除结果
|
|
1597
|
+
*/
|
|
1598
|
+
export interface DeleteFileResult {
|
|
1599
|
+
/**
|
|
1600
|
+
* <p>被删除的文件 ID</p>
|
|
1601
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1602
|
+
*/
|
|
1603
|
+
FileId?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* <p>删除是否成功</p>
|
|
1606
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1607
|
+
*/
|
|
1608
|
+
Status?: boolean;
|
|
1609
|
+
}
|
|
1610
|
+
/**
|
|
1611
|
+
* 单个操作项的执行结果。 由 RunWorkflow / RerunWorkflowRun / KillWorkflowRun 共用: RunWorkflow—— WorkflowId / WorkflowName 有值,WorkflowRunId 为空 RerunWorkflowRun —— WorkflowId / WorkflowName / WorkflowRunId 均有值 KillWorkflowRun —— WorkflowId / WorkflowName / WorkflowRunId 均有值
|
|
1612
|
+
*/
|
|
1613
|
+
export interface RunActionBrief {
|
|
1614
|
+
/**
|
|
1615
|
+
* 工作流ID
|
|
1616
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1617
|
+
*/
|
|
1618
|
+
WorkflowId?: string;
|
|
1619
|
+
/**
|
|
1620
|
+
* 工作流名称
|
|
1621
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1622
|
+
*/
|
|
1623
|
+
WorkflowName?: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* 操作动作ID,用于追踪具体的执行动作
|
|
1626
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1627
|
+
*/
|
|
1628
|
+
RunActionId?: string;
|
|
1629
|
+
/**
|
|
1630
|
+
* 失败错误信息,操作失败时返回具体的错误描述
|
|
1631
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1632
|
+
*/
|
|
1633
|
+
ErrorMessage?: string;
|
|
1634
|
+
/**
|
|
1635
|
+
* 操作状态,true 表示成功,false 表示失败
|
|
1636
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1637
|
+
*/
|
|
1638
|
+
OpStatus?: boolean;
|
|
1639
|
+
/**
|
|
1640
|
+
* 工作流运行ID。重跑 / 终止场景返回被操作的运行ID;运行工作流场景为空
|
|
1641
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1642
|
+
*/
|
|
1643
|
+
WorkflowRunId?: string;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* CreateFile返回参数结构体
|
|
1647
|
+
*/
|
|
1648
|
+
export interface CreateFileResponse {
|
|
1649
|
+
/**
|
|
1650
|
+
* <p>返回结果</p>
|
|
1651
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1652
|
+
*/
|
|
1653
|
+
Data?: FileInfo;
|
|
1654
|
+
/**
|
|
1655
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1656
|
+
*/
|
|
1657
|
+
RequestId?: string;
|
|
1658
|
+
}
|
|
1659
|
+
/**
|
|
1660
|
+
* RunWorkflow请求参数结构体
|
|
1661
|
+
*/
|
|
1662
|
+
export interface RunWorkflowRequest {
|
|
1663
|
+
/**
|
|
1664
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
1665
|
+
*/
|
|
1666
|
+
WorkspaceId: string;
|
|
1667
|
+
/**
|
|
1668
|
+
* <p>工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
1669
|
+
*/
|
|
1670
|
+
WorkflowId: string;
|
|
1671
|
+
/**
|
|
1672
|
+
* <p>运行类型。必填。取值:1 普通运行,2 高级运行</p>
|
|
1673
|
+
*/
|
|
1674
|
+
RunType: number;
|
|
1675
|
+
/**
|
|
1676
|
+
* <p>运行类型为高级运行时填写的自定义运行参数</p>
|
|
1677
|
+
*/
|
|
1678
|
+
AdvancedParams?: Array<TaskSchedulingParameterBrief>;
|
|
1679
|
+
/**
|
|
1680
|
+
* <p>本次需要运行指定的任务ID集合,可通过 ListWorkflowTasks 获取,不传默认运行该工作流下所有任务</p>
|
|
1681
|
+
*/
|
|
1682
|
+
TaskIds?: Array<string>;
|
|
1683
|
+
/**
|
|
1684
|
+
* <p>幂等令牌。非必填,相同令牌的重复请求只会触发一次运行</p>
|
|
1685
|
+
*/
|
|
1686
|
+
IdempotencyToken?: string;
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* 工作流任务运行信息
|
|
1690
|
+
*/
|
|
1691
|
+
export interface WorkflowTaskRun {
|
|
1692
|
+
/**
|
|
1693
|
+
* <p>任务名称</p>
|
|
1694
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1695
|
+
*/
|
|
1696
|
+
TaskName?: string;
|
|
1697
|
+
/**
|
|
1698
|
+
* <p>任务运行ID</p>
|
|
1699
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1700
|
+
*/
|
|
1701
|
+
WorkflowTaskRunId?: string;
|
|
1702
|
+
/**
|
|
1703
|
+
* <p>运行状态。取值参考工作流任务运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed</p>
|
|
1704
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1705
|
+
*/
|
|
1706
|
+
RunState?: string;
|
|
1707
|
+
/**
|
|
1708
|
+
* <p>工作空间ID</p>
|
|
1709
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1710
|
+
*/
|
|
1711
|
+
WorkspaceId?: string;
|
|
1712
|
+
/**
|
|
1713
|
+
* <p>工作流ID</p>
|
|
1714
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1715
|
+
*/
|
|
1716
|
+
WorkflowId?: string;
|
|
1717
|
+
/**
|
|
1718
|
+
* <p>工作流运行ID</p>
|
|
1719
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1720
|
+
*/
|
|
1721
|
+
WorkflowRunId?: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* <p>任务ID</p>
|
|
1724
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1725
|
+
*/
|
|
1726
|
+
TaskId?: string;
|
|
1727
|
+
/**
|
|
1728
|
+
* <p>任务类型名称</p>
|
|
1729
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1730
|
+
*/
|
|
1731
|
+
TaskTypeName?: string;
|
|
1732
|
+
/**
|
|
1733
|
+
* <p>任务版本ID</p>
|
|
1734
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1735
|
+
*/
|
|
1736
|
+
TaskVersionId?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* <p>触发类型 (参考SchedulerTriggerType枚举)</p>
|
|
1739
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1740
|
+
*/
|
|
1741
|
+
TriggerType?: string;
|
|
1742
|
+
/**
|
|
1743
|
+
* <p>所属资源组ID</p>
|
|
1744
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1745
|
+
*/
|
|
1746
|
+
ResourceGroupId?: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* <p>错误码</p>
|
|
1749
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1750
|
+
*/
|
|
1751
|
+
ErrorCodeString?: string;
|
|
1752
|
+
/**
|
|
1753
|
+
* <p>运行用户UIN</p>
|
|
1754
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1755
|
+
*/
|
|
1756
|
+
RunUserUin?: string;
|
|
1757
|
+
/**
|
|
1758
|
+
* <p>运行用户名称</p>
|
|
1759
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1760
|
+
*/
|
|
1761
|
+
RunUserName?: string;
|
|
1762
|
+
/**
|
|
1763
|
+
* <p>创建人UIN</p>
|
|
1764
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1765
|
+
*/
|
|
1766
|
+
CreateUserUin?: string;
|
|
1767
|
+
/**
|
|
1768
|
+
* <p>执行平台执行ID</p>
|
|
1769
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1770
|
+
*/
|
|
1771
|
+
JobId?: string;
|
|
1772
|
+
/**
|
|
1773
|
+
* <p>创建时间,单位:毫秒时间戳</p>
|
|
1774
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1775
|
+
*/
|
|
1776
|
+
CreateTime?: string;
|
|
1777
|
+
/**
|
|
1778
|
+
* <p>更新时间,单位:毫秒时间戳</p>
|
|
1779
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1780
|
+
*/
|
|
1781
|
+
UpdateTime?: string;
|
|
1782
|
+
/**
|
|
1783
|
+
* <p>依赖任务完成时间,单位:毫秒时间戳</p>
|
|
1784
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1785
|
+
*/
|
|
1786
|
+
DependenceFinishedTime?: string;
|
|
1787
|
+
/**
|
|
1788
|
+
* <p>运行开始时间,单位:毫秒时间戳</p>
|
|
1789
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1790
|
+
*/
|
|
1791
|
+
RunStartTime?: string;
|
|
1792
|
+
/**
|
|
1793
|
+
* <p>运行结束时间,单位:毫秒时间戳</p>
|
|
1794
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1795
|
+
*/
|
|
1796
|
+
RunEndTime?: string;
|
|
1797
|
+
/**
|
|
1798
|
+
* <p>运行时长,单位:秒</p>
|
|
1799
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1800
|
+
*/
|
|
1801
|
+
RunCostTime?: string;
|
|
1802
|
+
/**
|
|
1803
|
+
* <p>等待时长(依赖就绪到开始运行的等待耗时),单位:秒</p>
|
|
1804
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1805
|
+
*/
|
|
1806
|
+
WaitTime?: string;
|
|
1807
|
+
/**
|
|
1808
|
+
* <p>下发执行平台时间,单位:毫秒时间戳</p>
|
|
1809
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1810
|
+
*/
|
|
1811
|
+
IssueTime?: string;
|
|
1812
|
+
/**
|
|
1813
|
+
* <p>时区</p>
|
|
1814
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1815
|
+
*/
|
|
1816
|
+
TimeZone?: string;
|
|
1817
|
+
/**
|
|
1818
|
+
* <p>依赖上游任务ID列表</p>
|
|
1819
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1820
|
+
*/
|
|
1821
|
+
DependOnList?: Array<string>;
|
|
1822
|
+
/**
|
|
1823
|
+
* <p>运行参数</p>
|
|
1824
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1825
|
+
*/
|
|
1826
|
+
RunParams?: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* <p>任务扩展信息,包含脚本路径</p>
|
|
1829
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1830
|
+
*/
|
|
1831
|
+
TaskTypeExtensions?: string;
|
|
1832
|
+
/**
|
|
1833
|
+
* <p>任务X坐标</p>
|
|
1834
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1835
|
+
*/
|
|
1836
|
+
LeftCoordinate?: number;
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>任务Y坐标</p>
|
|
1839
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1840
|
+
*/
|
|
1841
|
+
TopCoordinate?: number;
|
|
1842
|
+
/**
|
|
1843
|
+
* <p>重试次数,为 0 则表示首次运行</p>
|
|
1844
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1845
|
+
*/
|
|
1846
|
+
RetryTimes?: number;
|
|
1847
|
+
/**
|
|
1848
|
+
* <p>工作流名称</p>
|
|
1849
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1850
|
+
*/
|
|
1851
|
+
WorkflowName?: string;
|
|
1852
|
+
/**
|
|
1853
|
+
* <p>重跑次数</p>
|
|
1854
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1855
|
+
*/
|
|
1856
|
+
RerunTimes?: number;
|
|
1857
|
+
/**
|
|
1858
|
+
* <p>是否最新一次运行</p>
|
|
1859
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1860
|
+
*/
|
|
1861
|
+
IsLatestRun?: boolean;
|
|
1862
|
+
/**
|
|
1863
|
+
* <p>资源组信息列表</p>
|
|
1864
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1865
|
+
*/
|
|
1866
|
+
ResourceGroupInfoList?: Array<ResourceGroupInfo>;
|
|
1867
|
+
/**
|
|
1868
|
+
* <p>运行结果</p>
|
|
1869
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1870
|
+
*/
|
|
1871
|
+
RunResult?: string;
|
|
1872
|
+
/**
|
|
1873
|
+
* <p>依赖运行条件</p>
|
|
1874
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1875
|
+
*/
|
|
1876
|
+
DependOnRunCondition?: string;
|
|
1877
|
+
/**
|
|
1878
|
+
* <p>高级依赖配置</p>
|
|
1879
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1880
|
+
*/
|
|
1881
|
+
AdvancedDependencyConfig?: AdvancedDependencyConfig;
|
|
1882
|
+
/**
|
|
1883
|
+
* <p>内嵌工作流任务信息</p>
|
|
1884
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1885
|
+
*/
|
|
1886
|
+
InnerTask?: InnerWorkflowTaskBrief;
|
|
1887
|
+
}
|
|
1888
|
+
/**
|
|
1889
|
+
* GetWorkflow返回参数结构体
|
|
1890
|
+
*/
|
|
1891
|
+
export interface GetWorkflowResponse {
|
|
1892
|
+
/**
|
|
1893
|
+
* <p>获取工作流详细信息响应内容</p>
|
|
1894
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1895
|
+
*/
|
|
1896
|
+
Data?: GetWorkflowRsp;
|
|
1897
|
+
/**
|
|
1898
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1899
|
+
*/
|
|
1900
|
+
RequestId?: string;
|
|
1901
|
+
}
|
|
1902
|
+
/**
|
|
1903
|
+
* GetWorkflowTaskRun请求参数结构体
|
|
1904
|
+
*/
|
|
1905
|
+
export interface GetWorkflowTaskRunRequest {
|
|
1906
|
+
/**
|
|
1907
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
1908
|
+
*/
|
|
1909
|
+
WorkspaceId: string;
|
|
1910
|
+
/**
|
|
1911
|
+
* <p>任务运行ID,可通过 ListWorkflowTaskRuns 获取。必填</p>
|
|
1912
|
+
*/
|
|
1913
|
+
WorkflowTaskRunId: string;
|
|
1914
|
+
/**
|
|
1915
|
+
* <p>内嵌工作流任务运行列表选项(仅限 FOR_EACH 任务使用)。非必填</p>
|
|
1916
|
+
*/
|
|
1917
|
+
InnerWorkflowTaskRunListOption?: InnerWorkflowTaskRunListOption;
|
|
1918
|
+
}
|
|
1919
|
+
/**
|
|
1920
|
+
* DeleteFile返回参数结构体
|
|
1921
|
+
*/
|
|
1922
|
+
export interface DeleteFileResponse {
|
|
1923
|
+
/**
|
|
1924
|
+
* <p>返回结果</p>
|
|
1925
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1926
|
+
*/
|
|
1927
|
+
Data?: DeleteFileResult;
|
|
1928
|
+
/**
|
|
1929
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
1930
|
+
*/
|
|
1931
|
+
RequestId?: string;
|
|
1932
|
+
}
|
|
1933
|
+
/**
|
|
1934
|
+
* ListWorkflowRunsRsp
|
|
1935
|
+
*/
|
|
1936
|
+
export interface ListWorkflowRunsRsp {
|
|
1937
|
+
/**
|
|
1938
|
+
* 当前页码
|
|
1939
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1940
|
+
*/
|
|
1941
|
+
PageNumber?: number;
|
|
1942
|
+
/**
|
|
1943
|
+
* 每页大小
|
|
1944
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1945
|
+
*/
|
|
1946
|
+
PageSize?: number;
|
|
1947
|
+
/**
|
|
1948
|
+
* 总记录数
|
|
1949
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1950
|
+
*/
|
|
1951
|
+
TotalCount?: number;
|
|
1952
|
+
/**
|
|
1953
|
+
* 总页数
|
|
1954
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1955
|
+
*/
|
|
1956
|
+
TotalPageNumber?: number;
|
|
1957
|
+
/**
|
|
1958
|
+
* 工作流运行列表
|
|
1959
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1960
|
+
*/
|
|
1961
|
+
Items?: Array<WorkflowRun>;
|
|
1962
|
+
/**
|
|
1963
|
+
* 工作流运行状态数量统计。
|
|
1964
|
+
统计口径为当前筛选条件下的全量数据,不受 PageNumber / PageSize 影响
|
|
1965
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1966
|
+
*/
|
|
1967
|
+
BizStateEnumInfos?: Array<ScheduleBizEnumBrief>;
|
|
1968
|
+
/**
|
|
1969
|
+
* 工作流运行错误码数量统计。
|
|
1970
|
+
统计口径为当前筛选条件下的全量数据,不受 PageNumber / PageSize 影响
|
|
1971
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1972
|
+
*/
|
|
1973
|
+
BizErrorCodeEnumInfos?: Array<ScheduleBizEnumBrief>;
|
|
1974
|
+
}
|
|
1975
|
+
/**
|
|
1976
|
+
* 工作流任务信息。 注意:本结构同时用于入参(CreateWorkflow / UpdateWorkflow)与出参(GetWorkflow), 其中 CreateTime / UpdateTime / CreateUserUin 为系统生成字段,仅在出参中有值, 入参传值不生效(服务端忽略且不报错)。
|
|
1977
|
+
*/
|
|
1978
|
+
export interface WorkflowTask {
|
|
1979
|
+
/**
|
|
1980
|
+
* 任务参数
|
|
1981
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1982
|
+
*/
|
|
1983
|
+
ParamList?: Array<ParamInfo>;
|
|
1984
|
+
/**
|
|
1985
|
+
* 任务依赖
|
|
1986
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1987
|
+
*/
|
|
1988
|
+
DependOnList?: Array<DependOnBrief>;
|
|
1989
|
+
/**
|
|
1990
|
+
* 任务ID,创建时无需传入,由服务端生成
|
|
1991
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1992
|
+
*/
|
|
1993
|
+
TaskId?: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* 任务名称
|
|
1996
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
1997
|
+
*/
|
|
1998
|
+
TaskName?: string;
|
|
1999
|
+
/**
|
|
2000
|
+
* 任务类型
|
|
2001
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2002
|
+
*/
|
|
2003
|
+
TaskType?: TaskType;
|
|
2004
|
+
/**
|
|
2005
|
+
* 资源组ID,可通过资源组相关接口获取
|
|
2006
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2007
|
+
*/
|
|
2008
|
+
ResourceGroupId?: string;
|
|
2009
|
+
/**
|
|
2010
|
+
* 任务描述
|
|
2011
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2012
|
+
*/
|
|
2013
|
+
Description?: string;
|
|
2014
|
+
/**
|
|
2015
|
+
* 任务告警
|
|
2016
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2017
|
+
*/
|
|
2018
|
+
Alarm?: AlarmBrief;
|
|
2019
|
+
/**
|
|
2020
|
+
* 监控指标
|
|
2021
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2022
|
+
*/
|
|
2023
|
+
MonitorMetric?: MonitorMetricBrief;
|
|
2024
|
+
/**
|
|
2025
|
+
* 任务重试策略
|
|
2026
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2027
|
+
*/
|
|
2028
|
+
TaskRetryStrategy?: TaskRetryStrategy;
|
|
2029
|
+
/**
|
|
2030
|
+
* <p>任依赖运行条件</p><ul><li>ALL_SUCCESS: 全部成功:所有上游依赖任务均已执行并成功</li><li>ONE_SUCCESS: 至少一个成功:至少有一个上游依赖任务成功</li><li>NONE_FAILED: 目前没有失败:没有依赖任务失败,并且至少有一个依赖任务在运行中</li><li>ALL_DONE: 全部完成:所有上游依赖任务均已执行并完成(无论成功或失败</li><li>ONE_FAILED: 至少一个失败:至少有一个上游依赖任务失败</li><li>ALL_FAILED: 全部失败:所有上游依赖任务都失败</li><li>ALL_DONE_AT_LEAST_ONE_SUCCESS:上游全部完成至少一个成功: 所有上游依赖任务都达到终态时,进行依赖判断,至少有一个成功,则依赖判断成功,否则就是跳过运行</li><li>ALL_SKIPPED:上游全部完成,没有跳过运行: 所有上游依赖任务都达到终态时,进行依赖判断, 如果上游状态全部都是成功、失败、上游失败状态,则依赖判断成功,否则为跳过运行</li><li>ONE_DONE:至少一个完成:上游只要有一个完成了,就进行依赖判断,且依赖判断成功,否则还是等待上游</li><li>ALL_DONE_NONE_FAILED_AT_LEAST_ONE_SUCCESS:上游全部完成,没有失败,至少有一个成功: 所有上游依赖任务都达到终态时,进行依赖判断,上游没有一个失败且至少有一个成功的情况下,依赖判断成功,否则就是跳过运行</li><li>NONE_SKIPPED:上游全部完成,没有跳过运行: 所有上游依赖任务都达到终态时,进行依赖判断, 如果上游状态全部都是成功、失败、上游失败状态,则依赖判断成功,否则为跳过运行</li><li>ALL_DONE_AT_LEAST_ONE_FAILED:上游全部完成至少一个失败: 所有上游依赖任务都达到终态时,进行依赖判断,至少有一个失败,则依赖判断成功,否则就是跳过运行</li><li>ADVANCED:运行条件为高级模式时配置</li></ul>
|
|
2031
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2032
|
+
*/
|
|
2033
|
+
DependOnRunCondition?: string;
|
|
2034
|
+
/**
|
|
2035
|
+
* 任务X坐标
|
|
2036
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2037
|
+
*/
|
|
2038
|
+
LeftCoordinate?: number;
|
|
2039
|
+
/**
|
|
2040
|
+
* 任务Y坐标
|
|
2041
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2042
|
+
*/
|
|
2043
|
+
TopCoordinate?: number;
|
|
2044
|
+
/**
|
|
2045
|
+
* <p>任务高级运行参数,当DependOnRunCondition为ADVANCED时配置</p>
|
|
2046
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2047
|
+
*/
|
|
2048
|
+
AdvancedDependencyConfig?: AdvancedDependencyConfig;
|
|
2049
|
+
/**
|
|
2050
|
+
* <p>内嵌任务(FOR_EACH任务的子任务)</p>
|
|
2051
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2052
|
+
*/
|
|
2053
|
+
InnerTask?: WorkflowTask;
|
|
2054
|
+
/**
|
|
2055
|
+
* 创建时间,单位:毫秒时间戳。出参专用,系统生成,入参传值不生效
|
|
2056
|
+
【已废弃】服务端忽略传入值,不报错。
|
|
2057
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2058
|
+
*/
|
|
2059
|
+
CreateTime?: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* 更新时间,单位:毫秒时间戳。出参专用,系统生成,入参传值不生效
|
|
2062
|
+
【已废弃】服务端忽略传入值,不报错。
|
|
2063
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2064
|
+
*/
|
|
2065
|
+
UpdateTime?: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* 创建人UIN。出参专用,系统生成,入参传值不生效
|
|
2068
|
+
【已废弃】服务端忽略传入值,不报错。
|
|
2069
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2070
|
+
*/
|
|
2071
|
+
CreateUserUin?: string;
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* 高级依赖配置
|
|
2075
|
+
*/
|
|
2076
|
+
export interface AdvancedDependencyConfig {
|
|
2077
|
+
/**
|
|
2078
|
+
* 逻辑运算符号OR / AND
|
|
2079
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2080
|
+
*/
|
|
2081
|
+
Operator?: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* 任务运行条件规则列表
|
|
2084
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2085
|
+
*/
|
|
2086
|
+
Conditions?: Array<TaskRunConditionRule>;
|
|
2087
|
+
}
|
|
2088
|
+
/**
|
|
2089
|
+
* UpdateWorkflow返回参数结构体
|
|
2090
|
+
*/
|
|
2091
|
+
export interface UpdateWorkflowResponse {
|
|
2092
|
+
/**
|
|
2093
|
+
* <p>更新工作流响应内容</p>
|
|
2094
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2095
|
+
*/
|
|
2096
|
+
Data?: UpdateWorkflowRsp;
|
|
2097
|
+
/**
|
|
2098
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2099
|
+
*/
|
|
2100
|
+
RequestId?: string;
|
|
2101
|
+
}
|
|
2102
|
+
/**
|
|
2103
|
+
* GetWorkflow请求参数结构体
|
|
2104
|
+
*/
|
|
2105
|
+
export interface GetWorkflowRequest {
|
|
2106
|
+
/**
|
|
2107
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
2108
|
+
*/
|
|
2109
|
+
WorkspaceId: string;
|
|
2110
|
+
/**
|
|
2111
|
+
* <p>工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
2112
|
+
*/
|
|
2113
|
+
WorkflowId: string;
|
|
2114
|
+
}
|
|
2115
|
+
/**
|
|
2116
|
+
* 内嵌工作流任务运行列表选项(仅限 FOR_EACH 任务使用)
|
|
2117
|
+
*/
|
|
2118
|
+
export interface InnerWorkflowTaskRunListOption {
|
|
2119
|
+
/**
|
|
2120
|
+
* <p>分页页码,从 1 开始。非必填,默认 1</p>
|
|
2121
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2122
|
+
*/
|
|
2123
|
+
PageNumber?: number;
|
|
2124
|
+
/**
|
|
2125
|
+
* <p>每页大小。非必填,默认 10,取值范围 [10, 200]</p>
|
|
2126
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2127
|
+
*/
|
|
2128
|
+
PageSize?: number;
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>迭代运行状态,精确匹配。非必填,多选(多个值之间为 OR 关系)。</p><p>可填 SUCCESS / FAILED 等,具体参考本接口出参 InnerWorkflowTaskRunIteration.RunState 字段返回值。</p>
|
|
2131
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2132
|
+
*/
|
|
2133
|
+
RunStates?: Array<string>;
|
|
2134
|
+
}
|
|
2135
|
+
/**
|
|
2136
|
+
* 工作流运行信息
|
|
2137
|
+
*/
|
|
2138
|
+
export interface WorkflowRun {
|
|
2139
|
+
/**
|
|
2140
|
+
* 主账号ID
|
|
2141
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2142
|
+
*/
|
|
2143
|
+
AppId?: string;
|
|
2144
|
+
/**
|
|
2145
|
+
* 工作流名称
|
|
2146
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2147
|
+
*/
|
|
2148
|
+
WorkflowName?: string;
|
|
2149
|
+
/**
|
|
2150
|
+
* 工作流ID
|
|
2151
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2152
|
+
*/
|
|
2153
|
+
WorkflowId?: string;
|
|
2154
|
+
/**
|
|
2155
|
+
* 工作流运行ID
|
|
2156
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2157
|
+
*/
|
|
2158
|
+
WorkflowRunId?: string;
|
|
2159
|
+
/**
|
|
2160
|
+
* 工作空间ID
|
|
2161
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2162
|
+
*/
|
|
2163
|
+
WorkspaceId?: string;
|
|
2164
|
+
/**
|
|
2165
|
+
* 触发方式,Scheduler、ManualTrigger、Event (参考SchedulerTriggerType)
|
|
2166
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2167
|
+
*/
|
|
2168
|
+
TriggerType?: string;
|
|
2169
|
+
/**
|
|
2170
|
+
* 运行开始时间,单位:毫秒时间戳
|
|
2171
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2172
|
+
*/
|
|
2173
|
+
RunStartTime?: string;
|
|
2174
|
+
/**
|
|
2175
|
+
* pending 状态开始时间,单位:毫秒时间戳
|
|
2176
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2177
|
+
*/
|
|
2178
|
+
PendingStartTime?: string;
|
|
2179
|
+
/**
|
|
2180
|
+
* queue 状态开始时间,单位:毫秒时间戳
|
|
2181
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2182
|
+
*/
|
|
2183
|
+
QueueStartTime?: string;
|
|
2184
|
+
/**
|
|
2185
|
+
* 运行结束时间,单位:毫秒时间戳
|
|
2186
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2187
|
+
*/
|
|
2188
|
+
RunEndTime?: string;
|
|
2189
|
+
/**
|
|
2190
|
+
* 终态时间,运行进入终态时都有值,单位:毫秒时间戳
|
|
2191
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2192
|
+
*/
|
|
2193
|
+
EndTime?: string;
|
|
2194
|
+
/**
|
|
2195
|
+
* 运行时长,单位:秒
|
|
2196
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2197
|
+
*/
|
|
2198
|
+
RunCostTime?: string;
|
|
2199
|
+
/**
|
|
2200
|
+
* 并发排队花费时间,单位:秒
|
|
2201
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2202
|
+
*/
|
|
2203
|
+
QueueCostTime?: string;
|
|
2204
|
+
/**
|
|
2205
|
+
* 等待资源花费时间,单位:秒
|
|
2206
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2207
|
+
*/
|
|
2208
|
+
PendingCostTime?: string;
|
|
2209
|
+
/**
|
|
2210
|
+
* 运行状态。取值参考工作流运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed
|
|
2211
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2212
|
+
*/
|
|
2213
|
+
RunState?: string;
|
|
2214
|
+
/**
|
|
2215
|
+
* 计算资源(任务的资源组ID集合)
|
|
2216
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2217
|
+
*/
|
|
2218
|
+
ResourceGroupIds?: Array<string>;
|
|
2219
|
+
/**
|
|
2220
|
+
* 运行用户UIN
|
|
2221
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2222
|
+
*/
|
|
2223
|
+
RunUserUin?: string;
|
|
2224
|
+
/**
|
|
2225
|
+
* 运行用户名称
|
|
2226
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2227
|
+
*/
|
|
2228
|
+
RunUserName?: string;
|
|
2229
|
+
/**
|
|
2230
|
+
* 错误码
|
|
2231
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2232
|
+
*/
|
|
2233
|
+
ErrorCodeString?: string;
|
|
2234
|
+
/**
|
|
2235
|
+
* 运行参数
|
|
2236
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2237
|
+
*/
|
|
2238
|
+
WorkflowParams?: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* 工作流版本ID
|
|
2241
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2242
|
+
*/
|
|
2243
|
+
WorkflowVersionId?: string;
|
|
2244
|
+
/**
|
|
2245
|
+
* 当前工作流是否支持重跑
|
|
2246
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2247
|
+
*/
|
|
2248
|
+
SupportRerun?: boolean;
|
|
2249
|
+
/**
|
|
2250
|
+
* 工作流运行创建时间,单位:毫秒时间戳
|
|
2251
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2252
|
+
*/
|
|
2253
|
+
CreateTime?: string;
|
|
2254
|
+
/**
|
|
2255
|
+
* 重跑次数
|
|
2256
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2257
|
+
*/
|
|
2258
|
+
RerunTimes?: number;
|
|
2259
|
+
/**
|
|
2260
|
+
* 运行的任务范围,任务ID列表
|
|
2261
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2262
|
+
*/
|
|
2263
|
+
SelectedTaskIds?: Array<string>;
|
|
2264
|
+
/**
|
|
2265
|
+
* 资源组信息列表
|
|
2266
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2267
|
+
*/
|
|
2268
|
+
ResourceGroupInfoList?: Array<ResourceGroupInfo>;
|
|
2269
|
+
/**
|
|
2270
|
+
* 标签列表
|
|
2271
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2272
|
+
*/
|
|
2273
|
+
LabelList?: Array<LabelBrief>;
|
|
2274
|
+
/**
|
|
2275
|
+
* 父工作流运行ID 【由嵌套工作流触发独有】
|
|
2276
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2277
|
+
*/
|
|
2278
|
+
ParentWorkflowRunId?: string;
|
|
2279
|
+
/**
|
|
2280
|
+
* 父工作流任务运行ID 【由嵌套工作流触发独有】
|
|
2281
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2282
|
+
*/
|
|
2283
|
+
ParentWorkflowTaskRunId?: string;
|
|
2284
|
+
/**
|
|
2285
|
+
* 父工作流任务运行名称 【由嵌套工作流触发独有】
|
|
2286
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2287
|
+
*/
|
|
2288
|
+
ParentWorkflowTaskRunName?: string;
|
|
2289
|
+
/**
|
|
2290
|
+
* 权限信息
|
|
2291
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2292
|
+
*/
|
|
2293
|
+
Permission?: string;
|
|
2294
|
+
/**
|
|
2295
|
+
* 工作流高级运行时用户填入的参数
|
|
2296
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2297
|
+
*/
|
|
2298
|
+
AdvancedParameters?: Array<AdvancedParameter>;
|
|
2299
|
+
}
|
|
2300
|
+
/**
|
|
2301
|
+
* 任务类型属性键值对
|
|
2302
|
+
*/
|
|
2303
|
+
export interface TaskTypeProperty {
|
|
2304
|
+
/**
|
|
2305
|
+
* 属性名
|
|
2306
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2307
|
+
*/
|
|
2308
|
+
PropertyKey?: string;
|
|
2309
|
+
/**
|
|
2310
|
+
* 属性值
|
|
2311
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2312
|
+
*/
|
|
2313
|
+
PropertyValue?: string;
|
|
2314
|
+
}
|
|
2315
|
+
/**
|
|
2316
|
+
* CreateFile请求参数结构体
|
|
2317
|
+
*/
|
|
2318
|
+
export interface CreateFileRequest {
|
|
2319
|
+
/**
|
|
2320
|
+
* <p>工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId</p>
|
|
2321
|
+
*/
|
|
2322
|
+
WorkspaceId: string;
|
|
2323
|
+
/**
|
|
2324
|
+
* <p>文件名,含后缀,最长 255 字节。不能以 . 或 .. 开头/结尾,不能含空格与控制字符</p>
|
|
2325
|
+
*/
|
|
2326
|
+
FileName: string;
|
|
2327
|
+
/**
|
|
2328
|
+
* <p>父文件夹路径,以 / 开头、末尾不带 /,根目录传 /。来源:ListFiles 接口返回的 Path</p>
|
|
2329
|
+
*/
|
|
2330
|
+
ParentFolderPath?: string;
|
|
2331
|
+
/**
|
|
2332
|
+
* <p>文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType</p>
|
|
2333
|
+
*/
|
|
2334
|
+
FileType?: string;
|
|
2335
|
+
/**
|
|
2336
|
+
* <p>文件运行配置</p>
|
|
2337
|
+
*/
|
|
2338
|
+
FileConfig?: FileConfig;
|
|
2339
|
+
/**
|
|
2340
|
+
* <p>绑定的 BundleId。来源:ListBundles 接口返回的 BundleId</p>
|
|
2341
|
+
*/
|
|
2342
|
+
BundleId?: string;
|
|
2343
|
+
/**
|
|
2344
|
+
* <p>绑定的 BundleInfo,JSON 字符串</p>
|
|
2345
|
+
*/
|
|
2346
|
+
BundleInfo?: string;
|
|
2347
|
+
/**
|
|
2348
|
+
* <p>文件初始内容。不传则按FileType 生成默认内容</p>
|
|
2349
|
+
*/
|
|
2350
|
+
Storage?: FileStorage;
|
|
2351
|
+
/**
|
|
2352
|
+
* 是否将 Storage 中的 ZIP 文件异步解压创建,默认 false。true 时异步作业由 Workspace 负责全生命周期,响应仅通过 AsyncOperation 返回作业信息(FileId 为空);作业进度查询由基础平台 WS 接口实现,不在本协议中定义。
|
|
2353
|
+
*/
|
|
2354
|
+
ExtractArchive?: boolean;
|
|
2355
|
+
}
|
|
2356
|
+
/**
|
|
2357
|
+
* UpdateFile请求参数结构体
|
|
2358
|
+
*/
|
|
2359
|
+
export interface UpdateFileRequest {
|
|
2360
|
+
/**
|
|
2361
|
+
* <p>工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId</p>
|
|
2362
|
+
*/
|
|
2363
|
+
WorkspaceId: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* <p>文件 ID。来源:CreateFile / ListFiles / GetFile 接口返回的 FileId</p>
|
|
2366
|
+
*/
|
|
2367
|
+
FileId: string;
|
|
2368
|
+
/**
|
|
2369
|
+
* <p>文件运行配置。不传则不更新配置</p>
|
|
2370
|
+
*/
|
|
2371
|
+
FileConfig?: FileConfig;
|
|
2372
|
+
/**
|
|
2373
|
+
* <p>文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType</p>
|
|
2374
|
+
*/
|
|
2375
|
+
FileType?: string;
|
|
2376
|
+
/**
|
|
2377
|
+
* <p>绑定的 BundleId。来源:ListBundles 接口返回的 BundleId</p>
|
|
2378
|
+
*/
|
|
2379
|
+
BundleId?: string;
|
|
2380
|
+
/**
|
|
2381
|
+
* <p>绑定的 BundleInfo,JSON 字符串</p>
|
|
2382
|
+
*/
|
|
2383
|
+
BundleInfo?: string;
|
|
2384
|
+
/**
|
|
2385
|
+
* <p>文件内容。不传则不更新内容</p>
|
|
2386
|
+
*/
|
|
2387
|
+
Storage?: FileStorage;
|
|
2388
|
+
/**
|
|
2389
|
+
* <p>目标文件名,非空且与当前文件名不同时执行 rename 动作。长度不超过 SCRIPT_NAME_MAX_LENGTH,禁止以 . 或 .. 开头/结尾,禁止空格、双点、控制字符及 Linux 保留名(参考 docs/linux_filename_rules.md)。与 ExtensionType 一起校验后缀合法性</p>
|
|
2390
|
+
*/
|
|
2391
|
+
FileName?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* <p>目标父目录路径,非空时执行 move 动作。根目录传 /;与 FileName 可同时出现,语义为「移动+重命名」。与 CreateFile 的 ParentFolderPath 保持一致</p>
|
|
2394
|
+
*/
|
|
2395
|
+
ParentFolderPath?: string;
|
|
2396
|
+
/**
|
|
2397
|
+
* <p>目标父目录的 FileType。取值:FOLDER、GIT_FOLDER。仅当 ParentFolderPath 非空时使用;缺省时按解析出的父目录实际类型处理</p>
|
|
2398
|
+
*/
|
|
2399
|
+
TargetFileType?: string;
|
|
2400
|
+
/**
|
|
2401
|
+
* <p>动作类型(必填,未来版本会强制校验)。取值:1 = UPDATE_CONTENT(仅更新 FileConfig / Storage / Bundle*,禁止传 FileName / ParentFolderPath / TargetFileType);2 = RENAME(仅重命名,必须传 FileName,禁止传 ParentFolderPath / FileConfig / Storage / Bundle*);3 = MOVE(仅移动,必须传 ParentFolderPath,禁止传 FileName / FileConfig / Storage / Bundle*)。参数互斥校验失败会返回 ParamIllegal 错误</p>
|
|
2402
|
+
*/
|
|
2403
|
+
UpdateAction?: number;
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* GetWorkflowRun请求参数结构体
|
|
2407
|
+
*/
|
|
2408
|
+
export interface GetWorkflowRunRequest {
|
|
2409
|
+
/**
|
|
2410
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
2411
|
+
*/
|
|
2412
|
+
WorkspaceId: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* <p>工作流运行ID,可通过 ListWorkflowRuns 获取。必填</p>
|
|
2415
|
+
*/
|
|
2416
|
+
WorkflowRunId: string;
|
|
2417
|
+
}
|
|
2418
|
+
/**
|
|
2419
|
+
* ListWorkflows请求参数结构体
|
|
2420
|
+
*/
|
|
2421
|
+
export interface ListWorkflowsRequest {
|
|
2422
|
+
/**
|
|
2423
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
2424
|
+
*/
|
|
2425
|
+
WorkspaceId: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* <p>分页页码,从 1 开始。非必填,默认 1</p>
|
|
2428
|
+
*/
|
|
2429
|
+
PageNumber?: number;
|
|
2430
|
+
/**
|
|
2431
|
+
* <p>每页大小。非必填,默认 10,取值范围 [10, 200]</p>
|
|
2432
|
+
*/
|
|
2433
|
+
PageSize?: number;
|
|
2434
|
+
/**
|
|
2435
|
+
* <p>工作流名称关键字,对 WorkflowName 做模糊匹配。非必填,单值</p>
|
|
2436
|
+
*/
|
|
2437
|
+
WorkflowNameKeyword?: string;
|
|
2438
|
+
/**
|
|
2439
|
+
* <p>工作流名称,精确匹配。非必填,多选(多个值之间为 OR 关系)</p>
|
|
2440
|
+
*/
|
|
2441
|
+
WorkflowNames?: Array<string>;
|
|
2442
|
+
/**
|
|
2443
|
+
* <p>工作流ID,精确匹配。非必填,多选(多个值之间为 OR 关系)</p>
|
|
2444
|
+
*/
|
|
2445
|
+
WorkflowIds?: Array<string>;
|
|
2446
|
+
/**
|
|
2447
|
+
* <p>工作流运行人UIN,精确匹配。非必填,多选(多个值之间为 OR 关系)</p>
|
|
2448
|
+
*/
|
|
2449
|
+
RunUserUins?: Array<string>;
|
|
2450
|
+
/**
|
|
2451
|
+
* <p>标签名称ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)</p>
|
|
2452
|
+
*/
|
|
2453
|
+
LabelKeyIds?: Array<string>;
|
|
2454
|
+
/**
|
|
2455
|
+
* <p>标签值ID,精确匹配,可通过标签相关接口获取。非必填,多选(多个值之间为 OR 关系)</p>
|
|
2456
|
+
*/
|
|
2457
|
+
LabelValueIds?: Array<string>;
|
|
2458
|
+
/**
|
|
2459
|
+
* <p>快速筛选类型。非必填,单值</p><p>对齐老云 API(wedata/2025-10-10)文档示例值:</p><ul><li>MY_FAVORITE:我收藏的</li><li>MY_OWNER:我负责的</li><li>MY_AUTHORITY:我有权限</li><li>WorkflowId:支持多个工作流ID筛选</li></ul><p>后端实现现状:当前仅 MY_FAVORITE 生效(设置 favoriteUserUin 过滤当前用户收藏),MY_OWNER / MY_AUTHORITY 暂未在 Service 层实现,传入会被忽略(按全量返回)。</p>
|
|
2460
|
+
*/
|
|
2461
|
+
QuickSelectionType?: string;
|
|
2462
|
+
/**
|
|
2463
|
+
* <p>排序条件,多个之间按数组顺序表示优先级。非必填。<br>可排序字段白名单:CreateTime</p>
|
|
2464
|
+
*/
|
|
2465
|
+
OrderBys?: Array<OrderBy>;
|
|
2466
|
+
}
|
|
2467
|
+
/**
|
|
2468
|
+
* 文件运行配置
|
|
2469
|
+
*/
|
|
2470
|
+
export interface FileConfig {
|
|
2471
|
+
/**
|
|
2472
|
+
* <p>高级运行参数,变量替换用,map-json String,String</p>
|
|
2473
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2474
|
+
*/
|
|
2475
|
+
Params?: string;
|
|
2476
|
+
/**
|
|
2477
|
+
* <p>执行资源 ID。来源:ListComputeResources 接口返回的 ResourceId</p>
|
|
2478
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2479
|
+
*/
|
|
2480
|
+
ResourceId?: string;
|
|
2481
|
+
/**
|
|
2482
|
+
* <p>默认 catalog</p>
|
|
2483
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2484
|
+
*/
|
|
2485
|
+
DefaultCatalog?: string;
|
|
2486
|
+
/**
|
|
2487
|
+
* <p>默认 schema</p>
|
|
2488
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2489
|
+
*/
|
|
2490
|
+
DefaultSchema?: string;
|
|
2491
|
+
/**
|
|
2492
|
+
* <p>高级配置,JSON 字符串</p>
|
|
2493
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2494
|
+
*/
|
|
2495
|
+
AdvanceConfig?: string;
|
|
2496
|
+
/**
|
|
2497
|
+
* <p>扩展参数,JSON 字符串</p>
|
|
2498
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2499
|
+
*/
|
|
2500
|
+
ExtraParams?: string;
|
|
2501
|
+
/**
|
|
2502
|
+
* <p>Notebook 交互控件定义,JSON 字符串</p>
|
|
2503
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2504
|
+
*/
|
|
2505
|
+
Widgets?: string;
|
|
2506
|
+
/**
|
|
2507
|
+
* <p>各单元格输出配置。仅 Get 出参返回,入参忽略</p>
|
|
2508
|
+
*/
|
|
2509
|
+
OutputConf?: Array<FileOutputConf>;
|
|
2510
|
+
/**
|
|
2511
|
+
* <p>SQL脚本语法标记</p>
|
|
2512
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2513
|
+
*/
|
|
2514
|
+
SqlSyntax?: string;
|
|
2515
|
+
/**
|
|
2516
|
+
* <p>平台集群id</p>
|
|
2517
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2518
|
+
*/
|
|
2519
|
+
ClusterId?: string;
|
|
2520
|
+
}
|
|
2521
|
+
/**
|
|
2522
|
+
* RunWorkflow返回参数结构体
|
|
2523
|
+
*/
|
|
2524
|
+
export interface RunWorkflowResponse {
|
|
2525
|
+
/**
|
|
2526
|
+
* <p>运行工作流响应内容</p>
|
|
2527
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2528
|
+
*/
|
|
2529
|
+
Data?: AsyncActionRsp;
|
|
2530
|
+
/**
|
|
2531
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2532
|
+
*/
|
|
2533
|
+
RequestId?: string;
|
|
2534
|
+
}
|
|
2535
|
+
/**
|
|
2536
|
+
* ListWorkflowRuns返回参数结构体
|
|
2537
|
+
*/
|
|
2538
|
+
export interface ListWorkflowRunsResponse {
|
|
2539
|
+
/**
|
|
2540
|
+
* <p>工作流运行列表响应内容</p>
|
|
2541
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2542
|
+
*/
|
|
2543
|
+
Data?: ListWorkflowRunsRsp;
|
|
2544
|
+
/**
|
|
2545
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2546
|
+
*/
|
|
2547
|
+
RequestId?: string;
|
|
2548
|
+
}
|
|
2549
|
+
/**
|
|
2550
|
+
* 高级运行参数(工作流高级运行时用户填入的参数)
|
|
2551
|
+
*/
|
|
2552
|
+
export interface AdvancedParameter {
|
|
2553
|
+
/**
|
|
2554
|
+
* 参数名
|
|
2555
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2556
|
+
*/
|
|
2557
|
+
ParamKey?: string;
|
|
2558
|
+
/**
|
|
2559
|
+
* 参数值
|
|
2560
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2561
|
+
*/
|
|
2562
|
+
ParamValue?: string;
|
|
2563
|
+
}
|
|
2564
|
+
/**
|
|
2565
|
+
* UpdateWorkflowRsp
|
|
2566
|
+
*/
|
|
2567
|
+
export interface UpdateWorkflowRsp {
|
|
2568
|
+
/**
|
|
2569
|
+
* 更新状态,true 表示成功
|
|
2570
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2571
|
+
*/
|
|
2572
|
+
Status?: boolean;
|
|
2573
|
+
}
|
|
2574
|
+
/**
|
|
2575
|
+
* 排序字段
|
|
2576
|
+
*/
|
|
2577
|
+
export interface OrderBy {
|
|
2578
|
+
/**
|
|
2579
|
+
* 排序方向,Asc(升序)或 Desc(降序),大小写不敏感
|
|
2580
|
+
*/
|
|
2581
|
+
Direction?: string;
|
|
2582
|
+
/**
|
|
2583
|
+
* 排序字段名
|
|
2584
|
+
*/
|
|
2585
|
+
Name?: string;
|
|
2586
|
+
}
|
|
2587
|
+
/**
|
|
2588
|
+
* 工作流高级设置
|
|
2589
|
+
*/
|
|
2590
|
+
export interface WorkflowAdvanceConfig {
|
|
2591
|
+
/**
|
|
2592
|
+
* 排队模式,ON(默认), OFF
|
|
2593
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2594
|
+
*/
|
|
2595
|
+
QueuingMode?: string;
|
|
2596
|
+
/**
|
|
2597
|
+
*
|
|
2598
|
+
默认值为1
|
|
2599
|
+
|
|
2600
|
+
QueuingMode为ON时,MaxConcurrentNum 设置才生效;只能输入大于0的整数,输入非法值自动转换为1
|
|
2601
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2602
|
+
*/
|
|
2603
|
+
MaxConcurrentNum?: number;
|
|
2604
|
+
}
|
|
2605
|
+
/**
|
|
2606
|
+
* 内嵌工作流任务运行详情(仅限 FOR_EACH 任务)
|
|
2607
|
+
*/
|
|
2608
|
+
export interface InnerWorkflowTaskRun {
|
|
2609
|
+
/**
|
|
2610
|
+
* 当前页码
|
|
2611
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2612
|
+
*/
|
|
2613
|
+
PageNumber?: number;
|
|
2614
|
+
/**
|
|
2615
|
+
* 每页大小
|
|
2616
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2617
|
+
*/
|
|
2618
|
+
PageSize?: number;
|
|
2619
|
+
/**
|
|
2620
|
+
* 总记录数
|
|
2621
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2622
|
+
*/
|
|
2623
|
+
TotalCount?: number;
|
|
2624
|
+
/**
|
|
2625
|
+
* 总页数
|
|
2626
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2627
|
+
*/
|
|
2628
|
+
TotalPageNumber?: number;
|
|
2629
|
+
/**
|
|
2630
|
+
* 迭代运行列表
|
|
2631
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2632
|
+
*/
|
|
2633
|
+
Items?: Array<InnerWorkflowTaskRunIteration>;
|
|
2634
|
+
/**
|
|
2635
|
+
* 迭代次数
|
|
2636
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2637
|
+
*/
|
|
2638
|
+
IterationCount?: number;
|
|
2639
|
+
/**
|
|
2640
|
+
* 失败次数
|
|
2641
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2642
|
+
*/
|
|
2643
|
+
FailureCount?: number;
|
|
2644
|
+
/**
|
|
2645
|
+
* 成功次数
|
|
2646
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2647
|
+
*/
|
|
2648
|
+
SuccessCount?: number;
|
|
2649
|
+
/**
|
|
2650
|
+
* 内嵌工作流ID,可通过 ListWorkflows 获取
|
|
2651
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2652
|
+
*/
|
|
2653
|
+
InnerWorkflowId?: string;
|
|
2654
|
+
/**
|
|
2655
|
+
* 内嵌任务ID,可通过 ListWorkflowTasks 获取
|
|
2656
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2657
|
+
*/
|
|
2658
|
+
InnerTaskId?: string;
|
|
2659
|
+
/**
|
|
2660
|
+
* 内嵌任务运行状态数量统计(实例业务枚举键值对列表)
|
|
2661
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2662
|
+
*/
|
|
2663
|
+
InnerTaskRunBizEnumInfos?: Array<ScheduleBizEnumBrief>;
|
|
2664
|
+
}
|
|
2665
|
+
/**
|
|
2666
|
+
* 单个监控指标
|
|
2667
|
+
*/
|
|
2668
|
+
export interface MonitorMetricItem {
|
|
2669
|
+
/**
|
|
2670
|
+
* 监控指标类型,有三种类型:1. RUN_DURATION(运行时长)2. WAIT_DURATION(等待时长)3. COMPLETION_TIME(完成时间)
|
|
2671
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2672
|
+
*/
|
|
2673
|
+
MetricType?: string;
|
|
2674
|
+
/**
|
|
2675
|
+
* 警告阈值,单位为毫秒级别,对于COMPLETION_TIME:从当日时间点00:00起算
|
|
2676
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2677
|
+
*/
|
|
2678
|
+
WarningThreshold?: string;
|
|
2679
|
+
/**
|
|
2680
|
+
* 超时阈值,单位为毫秒级别,对于COMPLETION_TIME:从当日时间点00:00起算
|
|
2681
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2682
|
+
*/
|
|
2683
|
+
TimeoutThreshold?: string;
|
|
2684
|
+
}
|
|
2685
|
+
/**
|
|
2686
|
+
* CreateWorkflow返回参数结构体
|
|
2687
|
+
*/
|
|
2688
|
+
export interface CreateWorkflowResponse {
|
|
2689
|
+
/**
|
|
2690
|
+
* <p>创建工作流响应内容</p>
|
|
2691
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2692
|
+
*/
|
|
2693
|
+
Data?: CreateWorkflowRsp;
|
|
2694
|
+
/**
|
|
2695
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2696
|
+
*/
|
|
2697
|
+
RequestId?: string;
|
|
2698
|
+
}
|
|
2699
|
+
/**
|
|
2700
|
+
* 告警组
|
|
2701
|
+
*/
|
|
2702
|
+
export interface AlarmGroup {
|
|
2703
|
+
/**
|
|
2704
|
+
* 通知渠道ID,可通过基础平台通知渠道相关接口获取
|
|
2705
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2706
|
+
*/
|
|
2707
|
+
ChannelId?: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* 通知渠道名称,可以是用户组名称或邮箱地址
|
|
2710
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2711
|
+
*/
|
|
2712
|
+
ChannelName?: string;
|
|
2713
|
+
/**
|
|
2714
|
+
* 是否启用邮件渠道,默认值:false
|
|
2715
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2716
|
+
*/
|
|
2717
|
+
IsEmailChannel?: boolean;
|
|
2718
|
+
/**
|
|
2719
|
+
* 一组告警条件,有 启动,成功,失败和任务超时告警
|
|
2720
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2721
|
+
*/
|
|
2722
|
+
AlarmConditions?: Array<string>;
|
|
2723
|
+
/**
|
|
2724
|
+
* 通知渠道类型。取值:0 未指定,1 Email,2 Webhook,3 Teams,4 Slack
|
|
2725
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2726
|
+
*/
|
|
2727
|
+
ChannelType?: number;
|
|
2728
|
+
}
|
|
2729
|
+
/**
|
|
2730
|
+
* DeleteFile请求参数结构体
|
|
2731
|
+
*/
|
|
2732
|
+
export interface DeleteFileRequest {
|
|
2733
|
+
/**
|
|
2734
|
+
* <p>工作空间 ID。来源:ListWorkspaces 接口返回的 WorkspaceId</p>
|
|
2735
|
+
*/
|
|
2736
|
+
WorkspaceId: string;
|
|
2737
|
+
/**
|
|
2738
|
+
* <p>文件 ID。来源:CreateFile / ListFiles / GetFile 接口返回的 FileId</p>
|
|
2739
|
+
*/
|
|
2740
|
+
FileId: string;
|
|
2741
|
+
/**
|
|
2742
|
+
* <p>文件类型。取值:FILE(普通文件/脚本)、NOTEBOOK_FILE(Notebook)、SQL_FILE(SQL文件)。对应 common/domain/entity.proto EntityType</p>
|
|
2743
|
+
*/
|
|
2744
|
+
FileType?: string;
|
|
2745
|
+
}
|
|
2746
|
+
/**
|
|
2747
|
+
* DeleteWorkflowRsp
|
|
2748
|
+
*/
|
|
2749
|
+
export interface DeleteWorkflowRsp {
|
|
2750
|
+
/**
|
|
2751
|
+
* 删除状态,true 表示成功
|
|
2752
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2753
|
+
*/
|
|
2754
|
+
Status?: boolean;
|
|
2755
|
+
}
|
|
2756
|
+
/**
|
|
2757
|
+
* GetWorkflowRun返回参数结构体
|
|
2758
|
+
*/
|
|
2759
|
+
export interface GetWorkflowRunResponse {
|
|
2760
|
+
/**
|
|
2761
|
+
* <p>查询工作流运行详情响应内容</p>
|
|
2762
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2763
|
+
*/
|
|
2764
|
+
Data?: GetWorkflowRunRsp;
|
|
2765
|
+
/**
|
|
2766
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2767
|
+
*/
|
|
2768
|
+
RequestId?: string;
|
|
2769
|
+
}
|
|
2770
|
+
/**
|
|
2771
|
+
* GetWorkflowRsp
|
|
2772
|
+
*/
|
|
2773
|
+
export interface GetWorkflowRsp {
|
|
2774
|
+
/**
|
|
2775
|
+
* <p>工作空间ID</p>
|
|
2776
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2777
|
+
*/
|
|
2778
|
+
WorkspaceId?: string;
|
|
2779
|
+
/**
|
|
2780
|
+
* <p>工作流基本信息</p>
|
|
2781
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2782
|
+
*/
|
|
2783
|
+
BaseInfo?: WorkflowBaseInfoDetail;
|
|
2784
|
+
/**
|
|
2785
|
+
* <p>工作流调度配置</p>
|
|
2786
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2787
|
+
*/
|
|
2788
|
+
Trigger?: Array<WorkflowTriggerConfiguration>;
|
|
2789
|
+
/**
|
|
2790
|
+
* <p>工作流参数列表</p>
|
|
2791
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2792
|
+
*/
|
|
2793
|
+
ParamList?: Array<ParamInfo>;
|
|
2794
|
+
/**
|
|
2795
|
+
* <p>标签列表</p>
|
|
2796
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2797
|
+
*/
|
|
2798
|
+
LabelList?: Array<LabelBrief>;
|
|
2799
|
+
/**
|
|
2800
|
+
* <p>工作流告警配置</p>
|
|
2801
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2802
|
+
*/
|
|
2803
|
+
Alarm?: AlarmBrief;
|
|
2804
|
+
/**
|
|
2805
|
+
* <p>监控指标配置</p>
|
|
2806
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2807
|
+
*/
|
|
2808
|
+
MonitorMetric?: MonitorMetricBrief;
|
|
2809
|
+
/**
|
|
2810
|
+
* <p>工作流高级设置</p>
|
|
2811
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2812
|
+
*/
|
|
2813
|
+
AdvanceConfig?: WorkflowAdvanceConfig;
|
|
2814
|
+
/**
|
|
2815
|
+
* <p>工作流任务列表</p>
|
|
2816
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2817
|
+
*/
|
|
2818
|
+
TaskList?: Array<WorkflowTask>;
|
|
2819
|
+
/**
|
|
2820
|
+
* <p>工作流绑定的 Bundle唯一标识,未绑定时为空</p>
|
|
2821
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2822
|
+
*/
|
|
2823
|
+
BundleId?: string;
|
|
2824
|
+
/**
|
|
2825
|
+
* <p>Bundle信息</p>
|
|
2826
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2827
|
+
*/
|
|
2828
|
+
BundleInfo?: string;
|
|
2829
|
+
/**
|
|
2830
|
+
* <p>Git配置ID</p>
|
|
2831
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2832
|
+
*/
|
|
2833
|
+
GitConfigId?: string;
|
|
2834
|
+
/**
|
|
2835
|
+
* <p>Git分支信息</p>
|
|
2836
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2837
|
+
*/
|
|
2838
|
+
GitBranch?: string;
|
|
2839
|
+
}
|
|
2840
|
+
/**
|
|
2841
|
+
* UnbindWorkflowBundle请求参数结构体
|
|
2842
|
+
*/
|
|
2843
|
+
export interface UnbindWorkflowBundleRequest {
|
|
2844
|
+
/**
|
|
2845
|
+
* <p>工作空间ID,可通过 ListWorkspaces 获取。必填</p>
|
|
2846
|
+
*/
|
|
2847
|
+
WorkspaceId: string;
|
|
2848
|
+
/**
|
|
2849
|
+
* <p>工作流ID,可通过 ListWorkflows 获取。必填</p>
|
|
2850
|
+
*/
|
|
2851
|
+
WorkflowId: string;
|
|
2852
|
+
}
|
|
2853
|
+
/**
|
|
2854
|
+
* UpdateFile返回参数结构体
|
|
2855
|
+
*/
|
|
2856
|
+
export interface UpdateFileResponse {
|
|
2857
|
+
/**
|
|
2858
|
+
* <p>返回结果</p>
|
|
2859
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2860
|
+
*/
|
|
2861
|
+
Data?: FileInfo;
|
|
2862
|
+
/**
|
|
2863
|
+
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
|
|
2864
|
+
*/
|
|
2865
|
+
RequestId?: string;
|
|
2866
|
+
}
|
|
2867
|
+
/**
|
|
2868
|
+
* GetWorkflowTaskRunRsp
|
|
2869
|
+
*/
|
|
2870
|
+
export interface GetWorkflowTaskRunRsp {
|
|
2871
|
+
/**
|
|
2872
|
+
* 任务名称
|
|
2873
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2874
|
+
*/
|
|
2875
|
+
TaskName?: string;
|
|
2876
|
+
/**
|
|
2877
|
+
* 任务运行ID
|
|
2878
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2879
|
+
*/
|
|
2880
|
+
WorkflowTaskRunId?: string;
|
|
2881
|
+
/**
|
|
2882
|
+
* 运行状态。取值参考工作流任务运行状态枚举,如 Pending / Running / Succeeded / Failed / Killed
|
|
2883
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2884
|
+
*/
|
|
2885
|
+
RunState?: string;
|
|
2886
|
+
/**
|
|
2887
|
+
* 工作空间ID
|
|
2888
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2889
|
+
*/
|
|
2890
|
+
WorkspaceId?: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* 工作流ID
|
|
2893
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2894
|
+
*/
|
|
2895
|
+
WorkflowId?: string;
|
|
2896
|
+
/**
|
|
2897
|
+
* 工作流运行ID
|
|
2898
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2899
|
+
*/
|
|
2900
|
+
WorkflowRunId?: string;
|
|
2901
|
+
/**
|
|
2902
|
+
* 任务ID
|
|
2903
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2904
|
+
*/
|
|
2905
|
+
TaskId?: string;
|
|
2906
|
+
/**
|
|
2907
|
+
* 任务类型名称
|
|
2908
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2909
|
+
*/
|
|
2910
|
+
TaskTypeName?: string;
|
|
2911
|
+
/**
|
|
2912
|
+
* 任务版本ID
|
|
2913
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2914
|
+
*/
|
|
2915
|
+
TaskVersionId?: string;
|
|
2916
|
+
/**
|
|
2917
|
+
* 触发类型 (参考SchedulerTriggerType枚举)
|
|
2918
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2919
|
+
*/
|
|
2920
|
+
TriggerType?: string;
|
|
2921
|
+
/**
|
|
2922
|
+
* 所属资源组ID
|
|
2923
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2924
|
+
*/
|
|
2925
|
+
ResourceGroupId?: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* 错误码
|
|
2928
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2929
|
+
*/
|
|
2930
|
+
ErrorCodeString?: string;
|
|
2931
|
+
/**
|
|
2932
|
+
* 运行用户UIN
|
|
2933
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2934
|
+
*/
|
|
2935
|
+
RunUserUin?: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* 运行用户名称
|
|
2938
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2939
|
+
*/
|
|
2940
|
+
RunUserName?: string;
|
|
2941
|
+
/**
|
|
2942
|
+
* 创建人UIN
|
|
2943
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2944
|
+
*/
|
|
2945
|
+
CreateUserUin?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* 执行平台执行ID
|
|
2948
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2949
|
+
*/
|
|
2950
|
+
JobId?: string;
|
|
2951
|
+
/**
|
|
2952
|
+
* 创建时间,单位:毫秒时间戳
|
|
2953
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2954
|
+
*/
|
|
2955
|
+
CreateTime?: string;
|
|
2956
|
+
/**
|
|
2957
|
+
* 更新时间,单位:毫秒时间戳
|
|
2958
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2959
|
+
*/
|
|
2960
|
+
UpdateTime?: string;
|
|
2961
|
+
/**
|
|
2962
|
+
* 依赖任务完成时间,单位:毫秒时间戳
|
|
2963
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2964
|
+
*/
|
|
2965
|
+
DependenceFinishedTime?: string;
|
|
2966
|
+
/**
|
|
2967
|
+
* 运行开始时间,单位:毫秒时间戳
|
|
2968
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2969
|
+
*/
|
|
2970
|
+
RunStartTime?: string;
|
|
2971
|
+
/**
|
|
2972
|
+
* 运行结束时间,单位:毫秒时间戳
|
|
2973
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2974
|
+
*/
|
|
2975
|
+
RunEndTime?: string;
|
|
2976
|
+
/**
|
|
2977
|
+
* 运行时长,单位:秒
|
|
2978
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2979
|
+
*/
|
|
2980
|
+
RunCostTime?: string;
|
|
2981
|
+
/**
|
|
2982
|
+
* 等待时长(依赖就绪到开始运行的等待耗时),单位:秒
|
|
2983
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2984
|
+
*/
|
|
2985
|
+
WaitTime?: string;
|
|
2986
|
+
/**
|
|
2987
|
+
* 下发执行平台时间,单位:毫秒时间戳
|
|
2988
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2989
|
+
*/
|
|
2990
|
+
IssueTime?: string;
|
|
2991
|
+
/**
|
|
2992
|
+
* 时区
|
|
2993
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2994
|
+
*/
|
|
2995
|
+
TimeZone?: string;
|
|
2996
|
+
/**
|
|
2997
|
+
* 依赖上游任务ID列表
|
|
2998
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2999
|
+
*/
|
|
3000
|
+
DependOnList?: Array<string>;
|
|
3001
|
+
/**
|
|
3002
|
+
* 运行参数
|
|
3003
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3004
|
+
*/
|
|
3005
|
+
RunParams?: string;
|
|
3006
|
+
/**
|
|
3007
|
+
* 任务扩展信息,包含脚本路径
|
|
3008
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3009
|
+
*/
|
|
3010
|
+
TaskTypeExtensions?: string;
|
|
3011
|
+
/**
|
|
3012
|
+
* 任务X坐标
|
|
3013
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3014
|
+
*/
|
|
3015
|
+
LeftCoordinate?: number;
|
|
3016
|
+
/**
|
|
3017
|
+
* 任务Y坐标
|
|
3018
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3019
|
+
*/
|
|
3020
|
+
TopCoordinate?: number;
|
|
3021
|
+
/**
|
|
3022
|
+
* 重试次数
|
|
3023
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3024
|
+
*/
|
|
3025
|
+
RetryTimes?: number;
|
|
3026
|
+
/**
|
|
3027
|
+
* 工作流名称
|
|
3028
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3029
|
+
*/
|
|
3030
|
+
WorkflowName?: string;
|
|
3031
|
+
/**
|
|
3032
|
+
* 重跑次数
|
|
3033
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3034
|
+
*/
|
|
3035
|
+
RerunTimes?: number;
|
|
3036
|
+
/**
|
|
3037
|
+
* 是否最新一次运行
|
|
3038
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3039
|
+
*/
|
|
3040
|
+
IsLatestRun?: boolean;
|
|
3041
|
+
/**
|
|
3042
|
+
* 资源组信息列表
|
|
3043
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3044
|
+
*/
|
|
3045
|
+
ResourceGroupInfoList?: Array<ResourceGroupInfo>;
|
|
3046
|
+
/**
|
|
3047
|
+
* 错误消息
|
|
3048
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3049
|
+
*/
|
|
3050
|
+
ErrorMessage?: string;
|
|
3051
|
+
/**
|
|
3052
|
+
* 运行结果
|
|
3053
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3054
|
+
*/
|
|
3055
|
+
RunResult?: string;
|
|
3056
|
+
/**
|
|
3057
|
+
* 内嵌工作流任务运行详情(仅限 FOR_EACH 任务,其他任务类型不返回该字段)
|
|
3058
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
3059
|
+
*/
|
|
3060
|
+
InnerWorkflowTaskRun?: InnerWorkflowTaskRun;
|
|
3061
|
+
}
|