summaryrefslogtreecommitdiff
path: root/data/emrstudio/2023-10-09/api-docs.php
blob: bc95d70f75b5766e7e01be6233617d5c115d2252 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
<?php return [
    'version' => '1.0',
    'info' => ['style' => 'ROA', 'product' => 'EmrStudio', 'version' => '2023-10-09'],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'DescribeManualTaskInstance' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances/{manualTaskInstanceId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'manualTaskInstanceId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListManualTaskInstances' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTaskInstances',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'searchVal',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'executionStatus',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'startTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'endTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'ListManualTasks' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'searchVal',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'taskType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'DescribeManualTask' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/manualTasks/{manualTaskId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'manualTaskId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListTaskInstances' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/taskInstances',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'workflowInstanceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'searchVal',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'executionStatus',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'startTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'endTime',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
            ],
        ],
        'DescribeTaskInstance' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowInstanceId}/taskInstances/{taskInstanceId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'workflowInstanceId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'taskInstanceId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListTasks' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/tasks',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'searchVal',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'taskType',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'workflowId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
            ],
        ],
        'DescribeTask' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/workflows/{workflowId}/tasks/{taskId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'workflowId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
                [
                    'name' => 'taskId',
                    'in' => 'path',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListWorkflowInstances' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/processInstances',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'startDate',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'endDate',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'workflowId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false],
                ],
            ],
        ],
        'DescribeWorkflowInstance' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/processInstances/{workflowInstanceId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'workflowInstanceId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true],
                ],
            ],
        ],
        'ListWorkflows' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/processDefinitions',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'searchVal',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
        ],
        'DescribeWorkflow' => [
            'path' => '/dolphinscheduler/v3/projects/{projectId}/processDefinitions/{workflowId}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'projectId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'workflowId',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
        ],
        'DescribeProject' => [
            'path' => '/dolphinscheduler/v3/projects/{code}',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'code',
                    'in' => 'path',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => true],
                ],
            ],
        ],
        'ListProjects' => [
            'path' => '/dolphinscheduler/v3/projects',
            'methods' => ['get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'consumes' => ['application/json'],
            'produces' => ['application/json'],
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'nextToken',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'searchVal',
                    'in' => 'query',
                    'schema' => ['type' => 'string', 'required' => false],
                ],
                [
                    'name' => 'maxResults',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false],
                ],
                [
                    'name' => 'workspaceId',
                    'in' => 'query',
                    'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true],
                ],
            ],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'cn-beijing', 'endpoint' => 'emrstudio.cn-beijing.aliyuncs.com'],
        ['regionId' => 'cn-hangzhou', 'endpoint' => 'emrstudio.cn-hangzhou.aliyuncs.com'],
        ['regionId' => 'cn-shanghai', 'endpoint' => 'emrstudio.cn-shanghai.aliyuncs.com'],
        ['regionId' => 'cn-shenzhen', 'endpoint' => 'emrstudio.cn-shenzhen.aliyuncs.com'],
        ['regionId' => 'cn-chengdu', 'endpoint' => 'emrstudio.cn-chengdu.aliyuncs.com'],
        ['regionId' => 'cn-zhangjiakou', 'endpoint' => 'emrstudio.cn-zhangjiakou.aliyuncs.com'],
        ['regionId' => 'ap-southeast-1', 'endpoint' => 'emrstudio.ap-southeast-1.aliyuncs.com'],
        ['regionId' => 'ap-southeast-3', 'endpoint' => 'emrstudio.ap-southeast-3.aliyuncs.com'],
        ['regionId' => 'us-west-1', 'endpoint' => 'emrstudio.us-west-1.aliyuncs.com'],
        ['regionId' => 'eu-central-1', 'endpoint' => 'emrstudio.eu-central-1.aliyuncs.com'],
        ['regionId' => 'cn-hongkong', 'endpoint' => 'emrstudio.cn-hongkong.aliyuncs.com'],
    ],
];