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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'ROA', 'product' => 'PAIFlow', 'version' => '2021-02-02'],
'directories' => [
[
'children' => ['CreatePipelineRun', 'DeletePipelineRun', 'StartPipelineRun', 'UpdatePipelineRun', 'GetPipelineRun', 'ListPipelineRunNodeLogs', 'GetPipelineRunNode', 'ListPipelineRunNodeOutputs', 'ListPipelineRunNodeStatus', 'ListPipelineRunsStatus', 'ListPipelineRuns', 'TerminatePipelineRun', 'RerunPipelineRun'],
'type' => 'directory',
'title' => '工作流任务',
'id' => 435352,
],
[
'children' => ['CreatePipeline', 'DeletePipeline', 'UpdatePipeline', 'GetPipeline', 'ListPipelines'],
'type' => 'directory',
'title' => '工作流',
'id' => 435346,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreatePipeline' => [
'path' => '/api/v1/pipelines',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '13800',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求body。',
'type' => 'object',
'properties' => [
'WorkspaceId' => ['description' => '工作空间ID。如何获取工作空间ID,请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => true, 'example' => '72***'],
'Manifest' => ['description' => '工作流定义,具体样例见下方请求参数补充说明。', 'type' => 'string', 'required' => true, 'example' => 'apiVersion: "core/v1"*********'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681******'],
'PipelineId' => ['description' => '工作流ID。', 'type' => 'string', 'example' => 'pipeline-hynm2bv8**********'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建工作流',
'summary' => '创建工作流(Pipeline)。工作流是由一系列节点组成的有向无环图,定义了一个机器学习流程。',
'requestParamsDescription' => '工作流定义样例:该工作流由读数据表(`data_source`),类型转换(`type_transform`)组成。'."\n"
."\n"
.'```'."\n"
.'apiVersion: "core/v1"'."\n"
.'metadata:'."\n"
.' provider: "166233998075****"'."\n"
.' version: "v1"'."\n"
.' identifier: "my_pipeline"'."\n"
.' name: "source-transform"'."\n"
.'spec:'."\n"
.' inputs:'."\n"
.' parameters:'."\n"
.' - name: "execution_maxcompute"'."\n"
.' value:'."\n"
.' spec:'."\n"
.' endpoint: "http://service.cn.maxcompute.aliyun-inc.com/api"'."\n"
.' odpsProject: "test_i****"'."\n"
.' type: "Map"'."\n"
.' pipelines:'."\n"
.' - apiVersion: "core/v1"'."\n"
.' metadata:'."\n"
.' provider: "pai"'."\n"
.' version: "v1"'."\n"
.' identifier: "data_source"'."\n"
.' name: "data-source"'."\n"
.' displayName: "读数据表-1"'."\n"
.' spec:'."\n"
.' arguments:'."\n"
.' parameters:'."\n"
.' - name: "inputTableName"'."\n"
.' value: "pai_online_project.wumai_data"'."\n"
.' - name: "execution"'."\n"
.' from: "{{inputs.parameters.execution_maxcompute}}"'."\n"
.' - apiVersion: "core/v1"'."\n"
.' metadata:'."\n"
.' provider: "pai"'."\n"
.' version: "v1"'."\n"
.' identifier: "type_transform"'."\n"
.' name: "type-transform"'."\n"
.' displayName: "类型转换-1"'."\n"
.' spec:'."\n"
.' arguments:'."\n"
.' artifacts:'."\n"
.' - name: "inputTable"'."\n"
.' from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"'."\n"
.' parameters:'."\n"
.' - name: "cols_to_double"'."\n"
.' value: "time,hour,pm2,pm10,so2,co,no2"'."\n"
.' - name: "execution"'."\n"
.' from: "{{inputs.parameters.execution_maxcompute}}"'."\n"
.' dependencies:'."\n"
.' - "data_source"'."\n"
.'```'."\n"
.'其中关键参数配置如下:'."\n"
."\n"
.'- **provider**:替换为您的账号ID。'."\n"
.'- **odpsProject**:替换为绑定到工作空间中的MaxCompute资源名称。如何查询MaxCompute资源名称,请参见[管理工作空间](~~430481~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipeline'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'paiflow:CreatePipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681******\\",\\n \\"PipelineId\\": \\"pipeline-hynm2bv8**********\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePipelineResponse>\\n <RequestId>DA869D1B-035A-43B2-ACC1-C56681BD9FAA</RequestId>\\n <PipelineId>pipeline-hynm2bv8**********</PipelineId>\\n</CreatePipelineResponse>","errorExample":""}]',
],
'CreatePipelineRun' => [
'summary' => '创建工作流任务。',
'path' => '/api/v1/pipelineruns',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140030',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '工作流任务。',
'type' => 'object',
'properties' => [
'PipelineId' => ['title' => 'Pipeline的id; PipelineId和PipelineManifest 二选一', 'description' => '工作流的ID。'."\n"
.'PipelineId和PipelineManifest二选一。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'flow-rer7y***'],
'Name' => ['title' => 'Run的名字,若为空,则自动生成名字', 'description' => '工作流任务名字。若为空,则自动生成名字。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'testName'],
'PipelineManifest' => ['title' => 'Pipeline内容; PipelineId和PipelineManifest 二选一一', 'description' => '工作流定义,具体样例见下方请求参数补充说明。'."\n"
.'PipelineId和PipelineManifest二选一。', 'type' => 'string', 'required' => false, 'example' => 'apiVersion: "core/v1"\\nmetadata:\\n provider: "1557702098******"\\n version: "v1"\\n identifier: "my_pipeline"\\n name: "source-transform"\\nspec:\\n inputs:\\n parameters:\\n - name: "execution_maxcompute"\\n type: "Map"\\n pipelines:\\n - apiVersion: "core/v1"\\n metadata:\\n provider: "pai"\\n version: "v1"\\n identifier: "data_source"\\n name: "data_source"\\n displayName: "Read data table-1"\\n spec:\\n arguments:\\n parameters:\\n - name: "inputTableName"\\n value: "pai_online_project.wumai_data"\\n - name: "partition"\\n value: "20220101"\\n - name: "execution"\\n from: "{{inputs.parameters.execution_maxcompute}}"\\n - apiVersion: "core/v1"\\n metadata:\\n provider: "pai"\\n version: "v1"\\n identifier: "type_transform"\\n name: "type_transform"\\n displayName: "Type transform-1"\\n spec:\\n arguments:\\n artifacts:\\n - name: "inputTable"\\n from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"\\n parameters:\\n - name: "cols_to_double"\\n value: "time,hour,pm2,pm10,so2,co,no2"\\n - name: "execution"\\n from: "{{inputs.parameters.execution_maxcompute}}"\\n dependencies:\\n - "data_source"'],
'Arguments' => ['title' => '参数', 'description' => '参数。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'arguments: parameters: - name: "execution_maxcompute" value: endpoint: "http://service***" odpsProject: "pai***"'],
'NoConfirmRequired' => ['title' => 'true代表直接启动; false代表只创建run但先不启动', 'description' => '是否直接启动pipelineRun,取值如下:'."\n"
.'- true代表直接启动(默认)。'."\n"
.'- false代表只创建run,但先不启动。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'WorkspaceId' => ['title' => '项目空间id', 'description' => '工作空间ID。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => '84***'],
'SourceType' => ['title' => '来源,支持如下值:SDK; PAI_STUDIO; M6; UNKNOWN;', 'description' => '工作流任务来源类型,支持如下值:'."\n"
.'- UNKNOWN(默认)'."\n"
.'- SDK'."\n"
.'- DESIGNER'."\n"
.'- M6', 'type' => 'string', 'required' => false, 'example' => 'UNKNOWN'],
'SourceId' => ['title' => '实验id', 'description' => '来源ID。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'experiment-ybpy***'],
'Options' => ['title' => '选项,json格式', 'description' => '创建工作流任务选项,格式为JSON。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '{"mlflow":{"experimentId":"exp-1jdk***"}}'],
'Accessibility' => ['title' => 'PUBLIC 公开;PRIVATE 私有', 'description' => '工作流的可见性:'."\n"
.'- PUBLIC(默认):工作空间内公开可见。'."\n"
.'- PRIVATE:仅自己可见。', 'type' => 'string', 'required' => false, 'example' => 'PUBLIC'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'],
'PipelineRunId' => ['title' => 'run的id', 'description' => '工作流任务ID。'."\n"
."\n", 'type' => 'string', 'example' => 'flow-rbvg***'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\",\\n \\"PipelineRunId\\": \\"flow-rbvg***\\"\\n}","type":"json"}]',
'title' => '创建工作流任务 ',
'requestParamsDescription' => '工作流定义样例:该工作流由读数据表(`data_source`),类型转换(`type_transform`)组成。'."\n"
."\n"
.'```'."\n"
.'apiVersion: "core/v1"'."\n"
.'metadata:'."\n"
.' provider: "1557702098******"'."\n"
.' version: "v1"'."\n"
.' identifier: "my_pipeline"'."\n"
.' name: "source-transform"'."\n"
.'spec:'."\n"
.' inputs:'."\n"
.' parameters:'."\n"
.' - name: "execution_maxcompute"'."\n"
.' type: "Map"'."\n"
.' pipelines:'."\n"
.' - apiVersion: "core/v1"'."\n"
.' metadata:'."\n"
.' provider: "pai"'."\n"
.' version: "v1"'."\n"
.' identifier: "data_source"'."\n"
.' name: "data_source"'."\n"
.' displayName: "读数据表-1"'."\n"
.' spec:'."\n"
.' arguments:'."\n"
.' parameters:'."\n"
.' - name: "inputTableName"'."\n"
.' value: "pai_online_project.wumai_data"'."\n"
.' - name: "partition"'."\n"
.' value: "20220101"'."\n"
.' - name: "execution"'."\n"
.' from: "{{inputs.parameters.execution_maxcompute}}"'."\n"
.' - apiVersion: "core/v1"'."\n"
.' metadata:'."\n"
.' provider: "pai"'."\n"
.' version: "v1"'."\n"
.' identifier: "type_transform"'."\n"
.' name: "type_transform"'."\n"
.' displayName: "类型转换-1"'."\n"
.' spec:'."\n"
.' arguments:'."\n"
.' artifacts:'."\n"
.' - name: "inputTable"'."\n"
.' from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"'."\n"
.' parameters:'."\n"
.' - name: "cols_to_double"'."\n"
.' value: "time,hour,pm2,pm10,so2,co,no2"'."\n"
.' - name: "execution"'."\n"
.' from: "{{inputs.parameters.execution_maxcompute}}"'."\n"
.' dependencies:'."\n"
.' - "data_source"'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePipelineRun'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'paiflow:CreatePipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeletePipeline' => [
'summary' => '删除工作流。',
'path' => '/api/v1/pipelines/{PipelineId}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '13813',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'path',
'schema' => ['description' => '工作流ID。如何获取工作流ID,请参见[ListPipelines](~~438051~~)。', 'type' => 'string', 'required' => true, 'example' => 'pipeline-hynm2bv8wqhp5e****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除工作流',
'description' => '如果指定的工作流作为共享工作流被用户订阅、或者作为子工作流被其它工作流引用,则不允许删除。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'paiflow:DeletePipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePipelineResponse>\\n <RequestId>DA869D1B-035A-43B2-ACC1-C56681BD9FAA</RequestId>\\n</DeletePipelineResponse>","errorExample":""}]',
],
'DeletePipelineRun' => [
'path' => '/api/v1/pipelineruns/{PipelineRunId}',
'methods' => ['delete'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140374',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => 'PipelineRunId', 'description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-hynm2bv8wqhp5esfxq'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除工作流任务 ',
'summary' => '删除工作流任务。',
'description' => '调用该接口时,工作流任务需要处于以下状态:'."\n"
.'- Initialized:初始化完成'."\n"
.'- Terminated:已终止'."\n"
.'- Succeeded:成功'."\n"
.'- Failed:失败',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelineRun'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'GetPipeline' => [
'path' => '/api/v1/pipelines/{PipelineId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '13812',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'path',
'schema' => ['description' => '工作流ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'pipeline-hynm2bv8wqhp5e****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '63EDFF2F-4D51-46F0-9D65-2F8F393B****'],
'PipelineId' => ['description' => '工作流ID。', 'type' => 'string', 'example' => 'pipeline-hynm2bv8wqhp5e****'],
'Provider' => ['description' => '自定义工作流,为用户ID。官方工作流为PAI。', 'type' => 'string', 'example' => '132668941337****'],
'Identifier' => ['description' => '工作流标识。', 'type' => 'string', 'example' => 'SqlWrite'],
'Version' => ['description' => '工作流版本。', 'type' => 'string', 'example' => 'v1'],
'Manifest' => ['description' => '工作流定义。', 'type' => 'string', 'example' => 'apiVersion: ****'],
'GmtCreateTime' => ['description' => '创建UTC时间,日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'],
'GmtModifiedTime' => ['description' => '最后修改UTC时间,日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'],
'Uuid' => ['description' => '工作流当前版本标识,用户每次更新,会生成该Uuid。', 'type' => 'string', 'example' => 'q8dp9hklueznhg****'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '726**'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流',
'summary' => '获取Pipeline信息。',
'responseParamsDescription' => '返回参数Manifest补充说明'."\n"
.'```'."\n"
.'apiVersion: "core/v1"'."\n"
.'metadata:'."\n"
.' version: "v1"'."\n"
.' # 工作流的提供方。'."\n"
.' provider: "132668**********"'."\n"
.' identifier: "my***"'."\n"
.'spec:'."\n"
.' inputs:'."\n"
.' parameters:'."\n"
.' - name: "inputTableName"'."\n"
.' value: "myDefault"'."\n"
.' # 类型,支持String, Double, Bool, Int, Map, List。'."\n"
.' type: "String"'."\n"
.' desc: "Table Name"'."\n"
.' # 参数是否必填,默认false。'."\n"
.' required: false'."\n"
.' outputs:'."\n"
.' artifacts:'."\n"
.' - name: "outputTable"'."\n"
.' metadata:'."\n"
.' # 类型,支持DataSet,Model,ModelEvaluation,Any,DataStream,Raw(原始数据),本例为DataSet。'."\n"
.' type:'."\n"
.' DataSet:'."\n"
.' locationType: "MaxComputeTable"'."\n"
.' desc: "Source MaxCompute Table Output Port"'."\n"
.' container:'."\n"
.' image: "registry.***.com/***/***:v*"'."\n"
.' command:'."\n"
.' - "bash"'."\n"
.' - "***.sh"'."\n"
.' volumeMounts:'."\n"
.' - name: "download-volume"'."\n"
.' path: "/***"'."\n"
.' initContainers:'."\n"
.' - image: "registry.***.com/***/***:v*"'."\n"
.' command:'."\n"
.' - "***.sh"'."\n"
.' args:'."\n"
.' - "--***"'."\n"
.' name: "initdownload"'."\n"
.' volumeMounts:'."\n"
.' - name: "download-volume"'."\n"
.' path: "/downloadPath"'."\n"
.' volumes:'."\n"
.' - name: "download-volume"'."\n"
.' emptyDir: {}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipeline'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'paiflow:GetPipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"63EDFF2F-4D51-46F0-9D65-2F8F393B****\\",\\n \\"PipelineId\\": \\"pipeline-hynm2bv8wqhp5e****\\",\\n \\"Provider\\": \\"132668941337****\\",\\n \\"Identifier\\": \\"SqlWrite\\",\\n \\"Version\\": \\"v1\\",\\n \\"Manifest\\": \\"apiVersion: ****\\",\\n \\"GmtCreateTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"Uuid\\": \\"q8dp9hklueznhg****\\",\\n \\"WorkspaceId\\": \\"726**\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'GetPipelineRun' => [
'summary' => '获取工作流任务详情信息。',
'path' => '/api/v1/pipelineruns/{PipelineRunId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140029',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => 'run的id', 'description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'run-rbvg**********ks92'."\n"],
],
[
'name' => 'Verbose',
'in' => 'query',
'schema' => ['title' => '是否返回详细信息,目前详细信息包含: RuntimeManifest', 'description' => '是否返回详细信息,取值如下。'."\n"
.'- 关闭开关:不显示详细信息。'."\n"
.'- 打开开关:显示详细信息,目前详细信息包含Manifest字段。', 'type' => 'boolean', 'required' => false, 'example' => 'false'."\n"],
],
[
'name' => 'ManifestType',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => [
'description' => '具体返回哪种类型的Manifest信息,取值如下。'."\n"
.'- Raw(默认):用户提交的原始Manifest。'."\n"
.'- Frozen:针对每个Pipeline生成唯一Uuid,将其版本固化下来。即使遇到子Pipeline定义三元组不变进行升级,依然会使用一开始的版本(Uuid),不受影响;即可基于该Manifest进行重跑。'."\n"
.'- Rendered:将相关信息进行注入和渲染,包括:补全运行环境信息并优化等。'."\n"
.'- Expanded: 针对每个Pipeline补充完整定义。'."\n"
.'- Runtime:待运行的工作流。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Runtime' => 'Runtime', 'Raw' => 'Raw', 'Frozen' => 'Frozen', 'Rendered' => 'Rendered', 'Expanded' => 'Expanded'],
'example' => 'Raw',
'default' => 'Raw',
'enum' => ['Raw', 'Frozen', 'Expanded', 'Rendered', 'Runtime'],
],
],
[
'name' => 'TokenId',
'in' => 'query',
'schema' => ['description' => '被分享的工作流任务的ID。', 'type' => 'string', 'required' => false, 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'."\n"],
'PipelineRunId' => ['description' => '工作流任务ID。'."\n"
."\n", 'type' => 'string', 'example' => 'flow-j94y**********lf7a'."\n"],
'Name' => ['description' => '工作流任务名字。'."\n"
."\n", 'type' => 'string', 'example' => 'testName'],
'Status' => ['description' => '工作流任务状态,可能值如下:'."\n"
."\n"
.'- Initialized'."\n"
.'- Running'."\n"
.'- Succeeded'."\n"
.'- Failed'."\n"
.'- Suspended'."\n"
.'- Terminated'."\n"
.'- Unknown'."\n"
.'- Skipped'."\n"
.'- Terminating', 'type' => 'string', 'example' => 'Succeeded'],
'Manifest' => ['description' => '工作流任务的定义。'."\n"
."\n", 'type' => 'string', 'example' => '{"ApiVersion":"core/v1","Metadata":{"NodeId":"node-n06d**********fc53","Provider":"155**********904","Name":"flow-j94y**********lf7a","Version":"v1","Identifier":"9fe11111-****-****-****-****ec811861","Namespace":null,"DisplayName":"name","NodeType":"Dag"},"Spec":{}}'],
'Arguments' => ['description' => '工作流任务的参数。'."\n"
."\n", 'type' => 'string', 'example' => '{"arguments":{"parameters":[{"name":"execution","value":{"endpoint":"http://service.******","odpsProject":"******","spec":{"endpoint":"http://service.******","odpsProject":"*****"},"resourceType":"MaxCompute"}}]}}'],
'UserId' => ['description' => '创建用户ID。'."\n"
."\n", 'type' => 'string', 'example' => '155**********904'."\n"],
'ParentUserId' => ['description' => '创建用户阿里云账号的ID。', 'type' => 'string', 'example' => '155**********904'."\n"],
'StartedAt' => ['description' => '工作流任务的开始UTC时间,格式ISO8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'."\n"],
'FinishedAt' => ['description' => '工作流任务的结束UTC时间,格式ISO8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:52:33.028Z'."\n"],
'NodeId' => ['description' => '工作流任务的节点ID。'."\n"
."\n", 'type' => 'string', 'example' => 'node-n06d**********fc53'."\n"],
'Duration' => ['description' => '工作流任务的运行时长,单位为秒。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
'WorkspaceId' => ['description' => '所属工作空间ID。'."\n"
."\n", 'type' => 'string', 'example' => '15945'],
'Message' => ['description' => '工作流任务失败提示信息。'."\n"
."\n", 'type' => 'string', 'example' => 'error message'."\n"],
'SourceType' => ['description' => '工作流任务来源类型,可能值:'."\n"
.'- UNKNOWN(默认):未指定来源类型时的默认值。'."\n"
.'- SDK:通过SDK创建的工作流任务。'."\n"
.'- DESIGNER:通过Designer创建的工作流任务。'."\n"
.'- M6:通过其他网站创建的工作流任务。', 'type' => 'string', 'example' => 'UNKNOWN'],
'SourceId' => ['description' => '工作流任务的来源ID。', 'type' => 'string', 'example' => 'abcd*********hxfu'."\n"],
'Options' => ['description' => '工作流任务选项,格式为JSON。'."\n"
."\n", 'type' => 'string', 'example' => '{"mlflow":{"experimentId":"exp-**********"}}'."\n"],
'GmtCreateTime' => ['description' => '创建UTC时间,格式ISO8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'."\n"],
'GmtModifiedTime' => ['description' => '最近修改UTC时间,格式ISO8601。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'."\n"],
'PipelineId' => ['description' => '工作流ID。'."\n"
."\n", 'type' => 'string', 'example' => 'pipeline-j94y**********lf7a'."\n"],
'Accessibility' => ['description' => '工作流任务的可见性,目前支持:'."\n"
.'- PUBLIC'."\n"
.'- PRIVATE', 'type' => 'string', 'example' => 'PUBLIC'],
'PipelineRunUri' => ['description' => '工作流任务详情URL。', 'type' => 'string', 'example' => 'https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流任务信息 ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineRun'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'paiflow:GetPipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\\\n\\",\\n \\"PipelineRunId\\": \\"flow-j94y**********lf7a\\\\n\\",\\n \\"Name\\": \\"testName\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Manifest\\": \\"{\\\\\\"ApiVersion\\\\\\":\\\\\\"core/v1\\\\\\",\\\\\\"Metadata\\\\\\":{\\\\\\"NodeId\\\\\\":\\\\\\"node-n06d**********fc53\\\\\\",\\\\\\"Provider\\\\\\":\\\\\\"155**********904\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"flow-j94y**********lf7a\\\\\\",\\\\\\"Version\\\\\\":\\\\\\"v1\\\\\\",\\\\\\"Identifier\\\\\\":\\\\\\"9fe11111-****-****-****-****ec811861\\\\\\",\\\\\\"Namespace\\\\\\":null,\\\\\\"DisplayName\\\\\\":\\\\\\"name\\\\\\",\\\\\\"NodeType\\\\\\":\\\\\\"Dag\\\\\\"},\\\\\\"Spec\\\\\\":{}}\\",\\n \\"Arguments\\": \\"{\\\\\\"arguments\\\\\\":{\\\\\\"parameters\\\\\\":[{\\\\\\"name\\\\\\":\\\\\\"execution\\\\\\",\\\\\\"value\\\\\\":{\\\\\\"endpoint\\\\\\":\\\\\\"http://service.******\\\\\\",\\\\\\"odpsProject\\\\\\":\\\\\\"******\\\\\\",\\\\\\"spec\\\\\\":{\\\\\\"endpoint\\\\\\":\\\\\\"http://service.******\\\\\\",\\\\\\"odpsProject\\\\\\":\\\\\\"*****\\\\\\"},\\\\\\"resourceType\\\\\\":\\\\\\"MaxCompute\\\\\\"}}]}}\\",\\n \\"UserId\\": \\"155**********904\\\\n\\",\\n \\"ParentUserId\\": \\"155**********904\\\\n\\",\\n \\"StartedAt\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"FinishedAt\\": \\"2021-01-30T12:52:33.028Z\\\\n\\",\\n \\"NodeId\\": \\"node-n06d**********fc53\\\\n\\",\\n \\"Duration\\": 60,\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Message\\": \\"error message\\\\n\\",\\n \\"SourceType\\": \\"UNKNOWN\\",\\n \\"SourceId\\": \\"abcd*********hxfu\\\\n\\",\\n \\"Options\\": \\"{\\\\\\"mlflow\\\\\\":{\\\\\\"experimentId\\\\\\":\\\\\\"exp-**********\\\\\\"}}\\\\n\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"PipelineId\\": \\"pipeline-j94y**********lf7a\\\\n\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"PipelineRunUri\\": \\"https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****\\"\\n}","type":"json"}]',
],
'GetPipelineRunNode' => [
'summary' => '工作流任务中包含多个节点,通过该接口获取节点的详细信息。',
'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140269',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => 'run 的 id', 'description' => '工作流任务的ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-ebppc********5lwea'],
],
[
'name' => 'NodeId',
'in' => 'path',
'schema' => ['title' => 'node 的 id', 'description' => '工作流任务中一个节点的ID。如何查看节点ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'node-wcs9z********27ps3'],
],
[
'name' => 'Depth',
'in' => 'query',
'schema' => ['title' => '查询深度', 'description' => '查询节点详细信息的深度(层数),当Depth为2时,将会返回该节点及其下一层的所有子节点的详细信息。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '节点类型,取值如下:'."\n"
.'* Logical(默认值):表示逻辑节点,用户提交节点的都是逻辑节点。'."\n"
.'* Physical:表示物理节点,对应一个执行特定逻辑的容器的运行,逻辑节点在后台运行时会转换为物理节点。', 'type' => 'string', 'required' => false, 'example' => 'Logical'],
],
[
'name' => 'TokenId',
'in' => 'query',
'schema' => ['description' => '被分享的工作流任务的ID。', 'type' => 'string', 'required' => false, 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回体结构',
'description' => '返回体结构。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求 id', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '0a981ea816**********42244e7ba2'],
'ApiVersion' => ['title' => 'api 版本', 'description' => '工作流定义的版本。'."\n"
."\n", 'type' => 'string', 'example' => 'core/v1'],
'Metadata' => [
'title' => 'node 的元信息',
'description' => '节点的元信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'NodeId' => ['title' => '节点 id', 'description' => '节点的ID。'."\n"
."\n", 'type' => 'string', 'example' => 'node-wcs9z********27ps3'],
'Provider' => ['title' => '提供方', 'description' => '节点所对应的工作流的提供方,通常情况下指代工作流的上传者(官方提供的工作流Provider为PAI)。', 'type' => 'string', 'example' => '15577********904'],
'Name' => ['title' => '名字', 'description' => '节点的名称。', 'type' => 'string', 'example' => 'flow-ebppc********5lwea'],
'Version' => ['title' => '版本', 'description' => '节点所对应的工作流的版本。'."\n"
."\n", 'type' => 'string', 'example' => 'v1'],
'Identifier' => ['title' => '标识符', 'description' => '节点所对应的工作流的标识名。'."\n"
."\n", 'type' => 'string', 'example' => 'composite-pipeline'],
'NodeType' => ['title' => '节点类型', 'description' => '节点的类型,可能值:'."\n"
."\n"
.'- Pod:具体运行的一个节点。'."\n"
.'- Dag:复合类型节点,本质是一个由子节点组成的Dag图。', 'type' => 'string', 'example' => 'Dag'],
'RelatedNodeIds' => [
'title' => 'Alink逻辑节点所对应的物理节点ID / Alink物理节点所对应的逻辑节点ID',
'description' => 'Alink逻辑节点所对应的物理节点ID或Alink物理节点所对应的逻辑节点ID。',
'type' => 'array',
'items' => ['description' => '节点ID。'."\n"
."\n", 'type' => 'string', 'example' => 'node-wcs9z********27ps3'],
],
'DisplayName' => ['title' => '展示名称', 'description' => '节点的展示名称(可能会被修改)。'."\n"
."\n", 'type' => 'string', 'example' => 'flow-ebppc********5lwea'],
],
],
'Spec' => [
'title' => '算法体',
'description' => '节点的定义。',
'type' => 'object',
'properties' => [
'HasPipelines' => ['title' => '是否有子 pipeline', 'description' => '该节点是否含有子节点,可能值:'."\n"
.'- true:该节点为复合类型节点,如果需要进一步查询其子节点信息,需要传入更深的Depth参数。'."\n"
.'- false:该节点为实际运行的节点。', 'type' => 'boolean', 'example' => 'true'],
'Dependencies' => [
'title' => '依赖',
'description' => '节点与其他节点的依赖关系。'."\n"
."\n",
'type' => 'array',
'items' => ['description' => '所依赖的其他节点对应工作流的名称。'."\n"
."\n", 'type' => 'string', 'example' => '"single-node-sub1"'],
],
'Pipelines' => [
'title' => '子 pipeline 列表',
'description' => '子节点列表。'."\n"
."\n\n",
'type' => 'array',
'items' => ['description' => '子节点的详细信息。'."\n"
."\n", 'type' => 'object', 'example' => '详细结构参见Pipeline相关接口描述。'."\n"],
'example' => 'For the detailed structure, see the description of Pipeline-related API operations.',
],
'Inputs' => [
'description' => '节点的输入信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'Artifacts' => [
'description' => '节点的输入产物列表。 ',
'type' => 'array',
'items' => ['description' => '节点的输入产物。'."\n"
."\n", 'type' => 'object', 'example' => '{"Name":"input","Value":"******"}'],
],
'Parameters' => [
'description' => '节点的输入参数列表。',
'type' => 'array',
'items' => ['description' => '节点的输入参数。', 'type' => 'object', 'example' => '{"Name":"inputTable","Value":"******"}'],
],
],
],
'Outputs' => [
'description' => '节点的输出信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'Artifacts' => [
'description' => '节点的输出产物列表。'."\n"
."\n",
'type' => 'array',
'items' => ['description' => '节点的输出产物。'."\n"
."\n", 'type' => 'object', 'example' => '{"Name":"output","Value":"******"}'],
],
'Parameters' => [
'description' => '节点的输出参数列表。'."\n"
."\n",
'type' => 'array',
'items' => ['description' => '节点的输出参数。'."\n"
."\n", 'type' => 'object', 'example' => '{"Name":"outputTable","Value":"******"}'],
],
],
],
'When' => ['description' => '节点运行的判断条件。'."\n"
.'- 如果运行条件返回为真,就执行该节点。'."\n"
.'- 如果运行条件返回为假,该节点被跳过,状态为Skipped。', 'type' => 'string', 'example' => '”{{inputs.parameters.skip}} == false“'],
'WithItems' => [
'description' => '将工作流节点扩展为多个工作流节点。',
'type' => 'array',
'items' => ['description' => '数据集中的一项,会扩展为一个工作流节点。', 'type' => 'string', 'example' => 'abc'],
],
'WithParam' => ['description' => '指向一个参数,该参数的值是一个数组,数组的每一项会扩展为一个工作流节点。', 'type' => 'string', 'example' => '"{{pipelines.generate.outputs.result}}"'],
'WithSequence' => [
'description' => '指向一个数字序列,序列中的每一项会扩展为一个工作流节点。',
'type' => 'object',
'properties' => [
'Start' => ['description' => '数字序列的起始数字。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'End' => ['description' => '数字序列的结束数字。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Format' => ['description' => '对数字序列的值进行格式化。', 'type' => 'string', 'example' => '"2020-05-%d"'],
],
],
'Parallelism' => ['description' => '节点并行度上限。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
'StatusInfo' => [
'title' => 'node 运行状态',
'description' => '节点的执行状态信息。'."\n"
."\n",
'type' => 'object',
'properties' => [
'FinishedAt' => ['title' => '结束时间', 'description' => '节点执行的结束时间。'."\n"
."\n", 'type' => 'string', 'example' => '2021-10-15T10:40:54.000Z'],
'StartedAt' => ['title' => '开始时间', 'description' => '节点执行的开始时间。'."\n"
."\n", 'type' => 'string', 'example' => '2021-10-15T10:39:58.000Z'],
'Status' => ['title' => '状态', 'description' => '节点的运行状态,可能值:'."\n"
.'- Succeeded:运行成功。'."\n"
.'- Running:运行中。'."\n"
.'- Failed:运行失败。'."\n"
.'- Skipped:跳过(前序节点失败导致)。'."\n"
.'- ReadyToSchedule:准备运行(前序节点未完成导致)。'."\n"
.'- Unknown:未知。', 'type' => 'string', 'example' => 'Succeeded'],
'Conditions' => [
'description' => '节点的运行状况列表。',
'type' => 'array',
'items' => ['description' => '节点的详细运行状况。', 'type' => 'object', 'example' => '{"ArtifactArchived": "true"}'],
],
'Progress' => ['description' => '节点的运行进度。', 'type' => 'string', 'example' => '9/9'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0a981ea816**********42244e7ba2\\",\\n \\"ApiVersion\\": \\"core/v1\\",\\n \\"Metadata\\": {\\n \\"NodeId\\": \\"node-wcs9z********27ps3\\",\\n \\"Provider\\": \\"15577********904\\",\\n \\"Name\\": \\"flow-ebppc********5lwea\\",\\n \\"Version\\": \\"v1\\",\\n \\"Identifier\\": \\"composite-pipeline\\",\\n \\"NodeType\\": \\"Dag\\",\\n \\"RelatedNodeIds\\": [\\n \\"node-wcs9z********27ps3\\"\\n ],\\n \\"DisplayName\\": \\"flow-ebppc********5lwea\\"\\n },\\n \\"Spec\\": {\\n \\"HasPipelines\\": true,\\n \\"Dependencies\\": [\\n \\"\\\\\\"single-node-sub1\\\\\\"\\"\\n ],\\n \\"Pipelines\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Inputs\\": {\\n \\"Artifacts\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"Value\\": \\"******\\"\\n }\\n ],\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"inputTable\\",\\n \\"Value\\": \\"******\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"Artifacts\\": [\\n {\\n \\"Name\\": \\"output\\",\\n \\"Value\\": \\"******\\"\\n }\\n ],\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"outputTable\\",\\n \\"Value\\": \\"******\\"\\n }\\n ]\\n },\\n \\"When\\": \\"”{{inputs.parameters.skip}} == false“\\",\\n \\"WithItems\\": [\\n \\"abc\\"\\n ],\\n \\"WithParam\\": \\"\\\\\\"{{pipelines.generate.outputs.result}}\\\\\\"\\",\\n \\"WithSequence\\": {\\n \\"Start\\": 1,\\n \\"End\\": 10,\\n \\"Format\\": \\"\\\\\\"2020-05-%d\\\\\\"\\"\\n },\\n \\"Parallelism\\": 2\\n },\\n \\"StatusInfo\\": {\\n \\"FinishedAt\\": \\"2021-10-15T10:40:54.000Z\\",\\n \\"StartedAt\\": \\"2021-10-15T10:39:58.000Z\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"Conditions\\": [\\n {\\n \\"ArtifactArchived\\": \\"true\\"\\n }\\n ],\\n \\"Progress\\": \\"9/9\\"\\n }\\n}","type":"json"}]',
'title' => '获取工作流任务节点信息 ',
'description' => 'PAIFlow支持复合形式的工作流,这些工作流在运行时也会体现为复合形式的节点。想要获取到这类节点的详细信息,可以传入Depth参数(默认值为2),可以递归地获取到所查询节点及其内含有的Depth层数的子节点的详细信息。'."\n"
."\n"
.'工作流的每次运行会存在一个虚拟的根节点,这个根节点可以通过GetRun接口返回获取。调用GetNode接口查询该根节点,可以获取到对应运行的所有节点的详细信息及其组织结构。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineRunNode'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'paiflow:GetPipelineRunNode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListPipelineRunNodeLogs' => [
'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/logs',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140372',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => 'Run id', 'description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-73186********nku43'],
],
[
'name' => 'NodeId',
'in' => 'path',
'schema' => ['title' => 'Node id', 'description' => '工作流任务节点ID。如何获取节点ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'node-hh5yc********mz8ms'],
],
[
'name' => 'Offset',
'in' => 'query',
'schema' => ['title' => '当前偏移量', 'description' => '页数(偏移量),默认值为0。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '每页返回的log数目', 'description' => '每页返回的日志数目。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'FromTimeInSeconds',
'in' => 'query',
'schema' => ['title' => '开始时间', 'description' => '查询时间范围的开始时间,格式为时间戳,单位为秒。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1612180056'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['title' => '搜索词', 'description' => '搜索词。支持模糊匹配。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
'name' => 'Reverse',
'in' => 'query',
'schema' => ['title' => '是否倒排', 'description' => '是否倒排,取值如下:'."\n"
.'- false(默认值):正序排列日志。'."\n"
.'- true:倒序排列日志。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ToTimeInSeconds',
'in' => 'query',
'schema' => ['title' => '结束时间', 'description' => '查询时间范围的结束时间,格式为时间戳,单位为秒。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1612180056'],
],
[
'name' => 'TokenId',
'in' => 'query',
'schema' => ['description' => '被分享的工作流任务的ID。', 'type' => 'string', 'required' => false, 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回结构体',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求 ID', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
'TotalCount' => ['title' => '符合过滤条件的作业数量', 'description' => '符合过滤条件的作业数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Logs' => [
'title' => '日志列表',
'description' => '查询返回的日志列表。'."\n"
."\n",
'type' => 'array',
'items' => ['description' => '查询到的日志行。'."\n"
."\n", 'type' => 'string', 'example' => 'abc'],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流任务节点日志 ',
'summary' => '获取工作流任务节点运行产生的日志。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunNodeLogs'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRunNodeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 10,\\n \\"Logs\\": [\\n \\"abc\\"\\n ]\\n}","type":"json"}]',
],
'ListPipelineRunNodeOutputs' => [
'summary' => '获取工作流任务节点输出。',
'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/outputs',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140373',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => 'Run id', 'description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-n06dn********rfc53'],
],
[
'name' => 'NodeId',
'in' => 'path',
'schema' => ['title' => 'Node id', 'description' => '工作流任务节点ID。如何获取节点ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'node-n06dn********rfc53'],
],
[
'name' => 'Depth',
'in' => 'query',
'schema' => ['title' => '节点往下拿多少层子节点', 'description' => '查询节点详细信息的深度(层数),当Depth为2时,将会返回该节点及其下一层的所有子节点的信息。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '99999', 'minimum' => '1', 'example' => '2'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '节点名字', 'description' => '查询的工作流任务节点的名称。', 'type' => 'string', 'required' => false, 'example' => 'myName'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '当前页,页码从1开始', 'description' => '当前页,起始值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '每页返回的输出数目', 'description' => '每页返回的输出数目。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['title' => '排序字段', 'description' => '用于排序返回结果的字段,目前支持如下字段:'."\n"
.'- Name'."\n"
.'- Type'."\n"
.'- GmtCreateTime', 'type' => 'string', 'required' => false, 'example' => 'GmtCreateTime'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['title' => '排序顺序, 顺序:ASC,倒序:DESC', 'description' => '排序顺序,取值如下,与SortBy一起使用:'."\n"
.'- DESC(默认值):降序排列'."\n"
.'- ASC:升序排列', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['title' => 'artifact 类型', 'description' => '工作流任务节点产物(Artifact)的类型:'."\n"
.'- Model:模型'."\n"
.'- DataSet:数据集'."\n"
.'- Metrics:度量数据'."\n"
.'- ModelEvaluation:模型评估结果', 'type' => 'string', 'required' => false, 'example' => 'DataSet'],
],
[
'name' => 'TokenId',
'in' => 'query',
'schema' => ['description' => '被分享的工作流任务的ID。', 'type' => 'string', 'required' => false, 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '返回结构',
'description' => '返回结构体。'."\n"
."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
'TotalCount' => ['title' => '符合过滤条件的作业数量', 'description' => '工作流任务节点输出产物的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Outputs' => [
'title' => '输出列表',
'description' => '工作流任务节点的输出产物列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '工作流任务节点的的输出产物。'."\n"
."\n",
'type' => 'object',
'properties' => [
'Name' => ['title' => '名字', 'description' => '工作流任务节点的输出产物名称。'."\n"
."\n", 'type' => 'string', 'example' => 'model_******'],
'Type' => ['title' => '类型', 'description' => '输出产物的类型,可能值:'."\n"
.'- Model:模型'."\n"
.'- DataSet:数据集'."\n"
.'- Metrics:度量数据'."\n"
.'- ModelEvaluation:模型评估结果', 'type' => 'string', 'example' => 'Model'],
'GmtCreateTime' => ['title' => '创建时间', 'description' => '输出产物的创建时间。', 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'],
'Id' => ['title' => 'id', 'description' => '输出产物的ID。'."\n"
."\n", 'type' => 'string', 'example' => 'artifact-ty1xwv*******s8zf'],
'NodeId' => ['title' => '输出所属节点 id', 'description' => '输出产物所属的工作流任务节点的ID。', 'type' => 'string', 'example' => 'node-obpzu*******418grb7'],
'ExpandedArtifactIndex' => ['title' => '被扩展artifact的索引号,以0开始', 'description' => '被扩展的输出产物的索引号,起始值为0。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ExpandableArtifactName' => ['title' => '可扩展artifact的名字', 'description' => '被扩展的输出产物的名称。', 'type' => 'string', 'example' => 'inputArtifact'],
'Info' => ['title' => 'artifact内容', 'description' => '输出产物的信息。'."\n"
."\n", 'type' => 'object', 'example' => '{ "metadata": { "type": { "Model": { "locationType": "MaxComputeOfflineModel", "modelType": "OfflineModel" } } }'],
'Producer' => ['title' => 'rtifact生产者', 'description' => '输出产物的生产者。', 'type' => 'string', 'example' => 'id-3d25-************-77856'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流任务节点输出 ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunNodeOutputs'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRunNodeOutputs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 2,\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"model_******\\",\\n \\"Type\\": \\"Model\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Id\\": \\"artifact-ty1xwv*******s8zf\\",\\n \\"NodeId\\": \\"node-obpzu*******418grb7\\",\\n \\"ExpandedArtifactIndex\\": 0,\\n \\"ExpandableArtifactName\\": \\"inputArtifact\\",\\n \\"Info\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Producer\\": \\"id-3d25-************-77856\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPipelineRunNodeStatus' => [
'path' => '/api/v1/pipelineruns/{PipelineRunId}/nodes/{NodeId}/status',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140268',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => '工作流任务ID', 'description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-rbvg5wzljzjhc9****'],
],
[
'name' => 'NodeId',
'in' => 'path',
'schema' => ['title' => '节点ID', 'description' => '工作流任务的节点ID。如何获取节点ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'node-kdkfkfds****'],
],
[
'name' => 'Depth',
'in' => 'query',
'schema' => ['title' => '深度', 'description' => '查询节点深度,当深度为N时,返回指定节点的N-1层子节点运行状态。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'Type',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['title' => '类型', 'description' => '节点类型,取值如下:'."\n"
.'* Logical(默认值):表示逻辑节点,用户提交节点的都是逻辑节点。'."\n"
.'* Physical:表示物理节点,对应一个执行特定逻辑的容器的运行,逻辑节点在后台运行时会转换为物理节点。', 'type' => 'string', 'required' => false, 'example' => 'Logical'],
],
[
'name' => 'TokenId',
'in' => 'query',
'schema' => ['description' => '被分享的工作流任务的ID。', 'type' => 'string', 'required' => false, 'example' => 'https://pai.console.aliyun.com/?regionId=cn-hangzhou&workspaceId=102******&mode=noSidebar#/paiflow/pipeline-runs/flow-6y7******?Token=eyJ0e******'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '请求ID', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'."\n"],
'Status' => [
'title' => '工作流任务的节点状态列表',
'description' => '工作流任务节点状态列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NodeId' => ['title' => '工作流中节点ID', 'description' => '工作流任务的节点ID。'."\n"
."\n", 'type' => 'string', 'example' => 'node-1jlzg7ncv0j6i3****'],
'NodeName' => ['title' => '工作流中节点名字', 'description' => '工作流任务的节点名字。'."\n"
."\n", 'type' => 'string', 'example' => 'sql'],
'Status' => ['title' => '节点运行状态', 'description' => '节点运行状态。'."\n"
."\n", 'type' => 'string', 'example' => 'Succeeded'],
'StartedAt' => ['title' => '节点开始运行时间', 'description' => '节点的开始运行时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddTHH:mmZ。'."\n"
."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:35.232Z'],
'FinishedAt' => ['title' => '节点结束运行时间', 'description' => '节点的结束运行时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddTHH:mmZ。'."\n"
."\n", 'type' => 'string', 'example' => '2021-01-21T17:12:40.232Z'],
'RuntimeInfo' => ['title' => '节点运行时信息', 'description' => '节点运行时信息,格式为转义后的Map,用户可以自定义输出多个KV对,相同的Key值会取最后输出的Value。当信息为空时,返回“{}”。'."\n"
."\n", 'type' => 'string', 'example' => '{\\"DLC_INSTANCE_IDS\\": \\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\"}'."\n"],
],
'description' => '',
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流任务节点状态 ',
'summary' => '获取工作流任务节点运行状态。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunNodeStatus'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRunNodeStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\\\n\\",\\n \\"Status\\": [\\n {\\n \\"NodeId\\": \\"node-1jlzg7ncv0j6i3****\\",\\n \\"NodeName\\": \\"sql\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"StartedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"FinishedAt\\": \\"2021-01-21T17:12:40.232Z\\",\\n \\"RuntimeInfo\\": \\"{\\\\\\\\\\\\\\"DLC_INSTANCE_IDS\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"i-12224afdfsaf,i-22224afdfsaf,i-13224afdfsaf\\\\\\\\\\\\\\"}\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPipelineRuns' => [
'summary' => '获取工作流任务列表,支持过滤、排序和分页查询。',
'path' => '/api/v1/pipelineruns',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140028',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '工作流任务列表的页码。起始值为1,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页显示的工作流任务数量,默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'SourceId',
'in' => 'query',
'schema' => ['description' => '工作流任务来源ID。请在工作流详情页面查看工作流任务来源ID,详情请参见[管理工作流](~~480625~~)。', 'type' => 'string', 'required' => false, 'example' => 'ybpy**********fb2z'."\n"],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '工作流任务名称。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'testName'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['description' => '排序的顺序,取值如下,与SortBy一起使用。'."\n"
.'- ASC:升序。'."\n"
.'- DESC(默认值):降序。', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
],
[
'name' => 'SourceType',
'in' => 'query',
'schema' => ['description' => '工作流任务来源类型,支持如下值:'."\n"
.'- UNKNOWN(默认):未指定来源类型时的默认值。'."\n"
.'- SDK:通过SDK创建的工作流任务。'."\n"
.'- DESIGNER:通过Designer创建的工作流任务。'."\n"
.'- M6:通过其他网站创建的工作流任务。', 'type' => 'string', 'required' => false, 'example' => 'UNKNOWN'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '需要过滤的工作流任务的状态,目前有如下几种状态:'."\n"
."\n"
.'- Initialized'."\n"
.'- Running'."\n"
.'- Succeeded'."\n"
.'- Failed'."\n"
.'- Terminated'."\n"
.'- Unknown'."\n"
.'- Skipped'."\n"
.'- Terminating', 'type' => 'string', 'required' => false, 'example' => 'Succeeded'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '工作空间ID。如何获取工作空间ID,请参见 [ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '104623'],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['title' => '用户id', 'description' => '用户ID。', 'type' => 'string', 'required' => false, 'example' => '155**********904'."\n"],
],
[
'name' => 'PipelineIds',
'in' => 'query',
'schema' => ['title' => 'Pipeline的id集合,只有Source为M6可以使用该参数', 'description' => '工作流的ID集合,多个工作流ID使用半角逗号(,)分隔。如何获取工作流ID,请参见[ListPipelines](~~438051~~)。', 'type' => 'string', 'required' => false, 'example' => 'flow-rer7**********0otv, flow-hynm**********sfef'],
],
[
'name' => 'SortBy',
'in' => 'query',
'schema' => ['description' => '用于排序的字段。目前有如下字段支持用于排序:'."\n"
."\n"
.'- PipelineId'."\n"
.'- UserId'."\n"
.'- ParentUserId'."\n"
.'- StartedAt'."\n"
.'- FinishedAt'."\n"
.'- WorkflowServiceId'."\n"
.'- Duration'."\n"
.'- GmtCreateTime'."\n"
.'- GmtModifiedTime', 'type' => 'string', 'required' => false, 'example' => 'PipelineId'],
],
[
'name' => 'PipelineRunId',
'in' => 'query',
'schema' => ['description' => '工作流任务ID,如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => false, 'example' => "\n"
.'flow-14vioac3k1s07k****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
'TotalCount' => ['description' => '返回的工作流任务总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
'PipelineRuns' => [
'description' => '返回的工作流任务列表。'."\n"
."\n",
'type' => 'array',
'items' => [
'description' => '工作流任务的详情。'."\n"
."\n",
'type' => 'object',
'properties' => [
'PipelineRunId' => ['description' => '工作流任务ID。'."\n"
."\n", 'type' => 'string', 'example' => 'flow-j94y**********lf7a'."\n"],
'Name' => ['description' => '工作流任务名字。'."\n"
."\n", 'type' => 'string', 'example' => 'testName'."\n"],
'Status' => ['description' => '工作流任务状态,目前有下面几种状态:'."\n"
."\n"
.'- Initialized'."\n"
.'- Running'."\n"
.'- Succeeded'."\n"
.'- Failed'."\n"
.'- Suspended'."\n"
.'- Terminated'."\n"
.'- Unknown'."\n"
.'- Skipped'."\n"
.'- Terminating', 'type' => 'string', 'example' => 'Succeeded'],
'UserId' => ['description' => '创建用户ID。', 'type' => 'string', 'example' => '155**********904'],
'ParentUserId' => ['description' => '创建用户主账户的ID。', 'type' => 'string', 'example' => '155**********904'],
'StartedAt' => ['description' => '工作流任务的开始UTC时间,格式iso8601。'."\n"
."\n", 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'."\n"],
'FinishedAt' => ['description' => '工作流任务的结束UTC时间,格式iso8601。'."\n"
."\n", 'type' => 'string', 'example' => '2021-01-30T12:52:33.028Z'."\n"],
'NodeId' => ['description' => '工作流任务的节点ID。', 'type' => 'string', 'example' => 'node-n06d**********fc53'."\n"],
'Duration' => ['description' => '工作流任务的运行时长,单位为秒。'."\n"
."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'WorkspaceId' => ['description' => '所属工作空间ID。'."\n"
."\n", 'type' => 'string', 'example' => '15945'],
'Message' => ['description' => '工作流任务失败提示信息。'."\n"
."\n", 'type' => 'string', 'example' => 'error message'."\n"],
'SourceType' => ['description' => '工作流任务来源类型,支持如下值:'."\n"
.'- UNKNOWN'."\n"
.'- SDK'."\n"
.'- DESIGNER'."\n"
.'- M6'."\n", 'type' => 'string', 'example' => 'UNKNOWN'],
'SourceId' => ['description' => '工作流任务的来源ID。'."\n"
."\n", 'type' => 'string', 'example' => 'abcd*********hxfu'."\n"],
'GmtCreateTime' => ['description' => '创建UTC时间,格式iso8601。'."\n"
."\n", 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'."\n"],
'GmtModifiedTime' => ['description' => '最近修改UTC时间,格式iso8601。'."\n"
."\n", 'type' => 'string', 'example' => '2021-01-30T12:51:33.028Z'."\n"],
'PipelineId' => ['description' => '工作流ID。'."\n"
."\n", 'type' => 'string', 'example' => 'pipeline-j94y**********lf7a'."\n"],
'Accessibility' => ['description' => '工作流任务的可见性,目前支持:'."\n"
.'- PUBLIC'."\n"
.'- PRIVATE', 'type' => 'string', 'example' => 'PUBLIC'],
'PipelineRunUri' => ['description' => '工作流任务详情URL。', 'type' => 'string', 'example' => 'https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****'],
],
],
'required' => true,
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流任务列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRuns'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRuns',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"TotalCount\\": 15,\\n \\"PipelineRuns\\": [\\n {\\n \\"PipelineRunId\\": \\"flow-j94y**********lf7a\\\\n\\",\\n \\"Name\\": \\"testName\\\\n\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"UserId\\": \\"155**********904\\",\\n \\"ParentUserId\\": \\"155**********904\\",\\n \\"StartedAt\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"FinishedAt\\": \\"2021-01-30T12:52:33.028Z\\\\n\\",\\n \\"NodeId\\": \\"node-n06d**********fc53\\\\n\\",\\n \\"Duration\\": 60,\\n \\"WorkspaceId\\": \\"15945\\",\\n \\"Message\\": \\"error message\\\\n\\",\\n \\"SourceType\\": \\"UNKNOWN\\",\\n \\"SourceId\\": \\"abcd*********hxfu\\\\n\\",\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"GmtModifiedTime\\": \\"2021-01-30T12:51:33.028Z\\\\n\\",\\n \\"PipelineId\\": \\"pipeline-j94y**********lf7a\\\\n\\",\\n \\"Accessibility\\": \\"PUBLIC\\",\\n \\"PipelineRunUri\\": \\"https://pai.console.aliyun.com/?regionId=cn-shanghai&workspaceId=24****#/studio/task/detail/flow-dsfbjt4k07lvp1****\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPipelineRunsStatus' => [
'path' => '/api/v1/pipelineruns',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140038',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '查询请求。',
'type' => 'object',
'properties' => [
'PipelineRuns' => [
'description' => '要查询的工作流任务列表,PipelineRuns参数与Nodes参数两选一,优先Nodes。',
'type' => 'array',
'items' => ['description' => '工作流任务的ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => false, 'example' => 'flow-hynm2bv8wqhp5esfxq'],
'required' => false,
],
'Nodes' => [
'description' => '要查询的节点列表,Nodes参数与PipelineRuns参数两选一,优先Nodes。',
'type' => 'array',
'items' => [
'description' => '要查询的节点。',
'type' => 'object',
'properties' => [
'PipelineRunId' => ['description' => '工作流任务的ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => false, 'example' => 'flow-hynm2bv8wqhp5esfxq'],
'NodeId' => ['description' => '工作流任务节点的ID。如何获取节点ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => false, 'example' => 'node-hynm2bv8wqhp5esfx1'],
],
'required' => false,
],
'required' => false,
],
'WorkspaceId' => ['description' => '工作空间的ID。如何获取工作空间ID,请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '948**'."\n"],
'OutputType' => ['description' => '工作流任务节点产物(Artifact)的类型,取值如下:'."\n"
.'- Model:模型。'."\n"
.'- DataSet:数据集。'."\n"
.'- Metrics:度量数据。'."\n"
.'- ModelEvaluation:模型评估结果。', 'type' => 'string', 'required' => false, 'example' => 'DataSet'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
'PipelineRuns' => [
'description' => '工作流任务列表。',
'type' => 'array',
'items' => [
'description' => '工作流任务。',
'type' => 'object',
'properties' => [
'PipelineRunId' => ['title' => 'run的id', 'description' => '工作流任务ID。'."\n"
."\n", 'type' => 'string', 'example' => 'flow-hynm2bv8wqhp5esfxq'],
'Status' => ['title' => 'run状态', 'description' => '工作流任务状态。'."\n"
."\n", 'type' => 'string', 'example' => 'Running'],
'Name' => ['title' => 'run名字', 'description' => '工作流任务名字。'."\n"
."\n", 'type' => 'string', 'example' => 'myName'],
'UserId' => ['title' => '用户id', 'description' => '工作流所属用户ID。'."\n"
."\n", 'type' => 'string', 'example' => '1557702098194904'],
'ParentUserId' => ['title' => '父账户id', 'description' => '工作流所属主账户ID。'."\n"
."\n", 'type' => 'string', 'example' => '1557702098194904'],
'NodeId' => ['title' => '节点id', 'description' => '节点ID。'."\n"
."\n", 'type' => 'string', 'example' => 'node-98odqfpcjzwdf3caq3'],
'SourceId' => ['title' => '实验id', 'description' => '工作流任务来源ID。', 'type' => 'string', 'example' => 'lmi7d24h3kr0xczjlu'],
'IsDeleted' => ['title' => '是否被删除', 'description' => '是否被删除,可能值:'."\n"
.'- true:代表已被删除。'."\n"
.'- false:代表未被删除。', 'type' => 'boolean', 'example' => 'false'],
],
],
],
'Nodes' => [
'description' => '工作流任务节点列表。',
'type' => 'array',
'items' => [
'description' => '工作流任务节点。',
'type' => 'object',
'properties' => [
'PipelineRunId' => ['title' => '运行Id', 'description' => '工作流任务ID。'."\n"
."\n", 'type' => 'string', 'example' => 'flow-hynm2bv8wqhp5esfxq'],
'NodeId' => ['title' => '节点Id', 'description' => '工作流任务节点ID。'."\n"
."\n", 'type' => 'string', 'example' => 'node-hynm2bv8wqhp5esfx1'],
'Status' => ['title' => '状态', 'description' => '工作流任务节点状态。'."\n"
."\n", 'type' => 'string', 'example' => 'Running'],
'InputArtifactArchived' => ['title' => '输入artifact是否已保存', 'description' => '输入Artifact是否已保存:'."\n"
.'- true:表示已保存。'."\n"
.'- false:表示未保存。', 'type' => 'boolean', 'example' => 'true'],
'OutputArtifactArchived' => ['title' => '输出artifact是否已保存', 'description' => '输出Artifact是否已保存:'."\n"
.'- true:表示已保存。'."\n"
.'- false:表示未保存。', 'type' => 'boolean', 'example' => 'true'],
'StartedAt' => ['title' => '修改 UTC 时间,日期格式 iso8601', 'description' => '工作流任务节点的开始运行时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddTHH:mmZ。'."\n"
."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-21T17:12:35.232Z'],
'FinishedAt' => ['title' => '修改 UTC 时间,日期格式 iso8601', 'description' => '工作流任务节点的结束运行时间。按照ISO8601标准表示,使用UTC+0时间。格式为:yyyy-MM-ddTHH:mmZ。'."\n"
."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-21T17:12:35.232Z'],
'NodeName' => ['title' => '节点名', 'description' => '工作流任务节点名。', 'type' => 'string', 'example' => 'dataSource'],
],
],
],
'Outputs' => [
'description' => '工作流任务节点的输出产物列表。',
'type' => 'array',
'items' => [
'description' => '工作流任务节点的输出产物。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '工作流任务节点的输出产物名称。', 'type' => 'string', 'example' => 'model_******'],
'Type' => ['description' => '输出产物的类型,可能值:'."\n"
.'- Model:模型。'."\n"
.'- DataSet:数据集。'."\n"
.'- Metrics:度量数据。'."\n"
.'- ModelEvaluation:模型评估结果。', 'type' => 'string', 'example' => 'DataSet'],
'Metadata' => ['description' => '输出产物的元数据。', 'type' => 'object'],
'GmtCreateTime' => ['description' => '输出产物的创建时间。', 'type' => 'string', 'format' => 'iso8601', 'example' => '2021-01-30T12:51:33.028Z'],
'Id' => ['description' => '输出产物的ID。', 'type' => 'string', 'example' => 'artifact-ty1xwv*******s8zf'],
'Producer' => ['description' => '输出产物的生产者。', 'type' => 'string', 'example' => 'id-3d25-************-77856'],
'NodeId' => ['description' => '输出产物所属的工作流任务节点的ID。', 'type' => 'string', 'example' => 'node-obpzu*******418grb7'."\n"],
'PipelineRunId' => ['description' => '输出产物所属的工作流任务的ID。', 'type' => 'string', 'example' => 'flow-dsjfk******jdskls'],
'Value' => ['description' => '输出产物的值。', 'type' => 'string', 'example' => '{\\"name\\": \\"model_flow_*********_node_**********_model\\", \\"location\\": {\\"name\\": \\"model_flow_**********_node_***********_model\\", \\"endpoint\\": \\"http://service.odps.aliyun.com/api\\", \\"project\\": \\"********\\"}}'],
'ExpandedArtifactIndex' => ['description' => '输出产物被扩展Artifact的索引号,起始值为0。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpandableArtifactName' => ['description' => '输出产物可扩展Artifact的名称。', 'type' => 'string', 'example' => 'inputArtifact'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '批量获取工作流任务状态',
'summary' => '批量获取工作流任务或节点的状态。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunsStatus'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\",\\n \\"PipelineRuns\\": [\\n {\\n \\"PipelineRunId\\": \\"flow-hynm2bv8wqhp5esfxq\\",\\n \\"Status\\": \\"Running\\",\\n \\"Name\\": \\"myName\\",\\n \\"UserId\\": \\"1557702098194904\\",\\n \\"ParentUserId\\": \\"1557702098194904\\",\\n \\"NodeId\\": \\"node-98odqfpcjzwdf3caq3\\",\\n \\"SourceId\\": \\"lmi7d24h3kr0xczjlu\\",\\n \\"IsDeleted\\": false\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"PipelineRunId\\": \\"flow-hynm2bv8wqhp5esfxq\\",\\n \\"NodeId\\": \\"node-hynm2bv8wqhp5esfx1\\",\\n \\"Status\\": \\"Running\\",\\n \\"InputArtifactArchived\\": true,\\n \\"OutputArtifactArchived\\": true,\\n \\"StartedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"FinishedAt\\": \\"2021-01-21T17:12:35.232Z\\",\\n \\"NodeName\\": \\"dataSource\\"\\n }\\n ],\\n \\"Outputs\\": [\\n {\\n \\"Name\\": \\"model_******\\",\\n \\"Type\\": \\"DataSet\\",\\n \\"Metadata\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GmtCreateTime\\": \\"2021-01-30T12:51:33.028Z\\",\\n \\"Id\\": \\"artifact-ty1xwv*******s8zf\\",\\n \\"Producer\\": \\"id-3d25-************-77856\\",\\n \\"NodeId\\": \\"node-obpzu*******418grb7\\\\n\\",\\n \\"PipelineRunId\\": \\"flow-dsjfk******jdskls\\",\\n \\"Value\\": \\"{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"model_flow_*********_node_**********_model\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"location\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"model_flow_**********_node_***********_model\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"endpoint\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"http://service.odps.aliyun.com/api\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"project\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"********\\\\\\\\\\\\\\"}}\\",\\n \\"ExpandedArtifactIndex\\": 0,\\n \\"ExpandableArtifactName\\": \\"inputArtifact\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListPipelines' => [
'path' => '/api/v1/pipelines',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '13816',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '工作流列表的页码。起始值为1,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询时设置的每页显示的工作流数量。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PipelineIdentifier',
'in' => 'query',
'schema' => ['description' => '需要过滤的工作流标识。您可以在**ListPipelines**查询结果中获取**Identifier**。', 'type' => 'string', 'required' => false, 'example' => 'SqlWriteTable_2'],
],
[
'name' => 'PipelineProvider',
'in' => 'query',
'schema' => ['description' => '需要过滤的工作流提供者。'."\n"
.'- PAI官方提供的工作流,Provider为pai。'."\n"
.'- 您创建的工作流,该值为您的阿里云账号ID。', 'type' => 'string', 'required' => false, 'example' => 'pai'],
],
[
'name' => 'PipelineVersion',
'in' => 'query',
'schema' => ['description' => '需要过滤的工作流版本。', 'type' => 'string', 'required' => false, 'example' => 'v1'],
],
[
'name' => 'WorkspaceId',
'in' => 'query',
'schema' => ['description' => '需要过滤的工作空间ID。如何获取工作空间ID,请参见[ListWorkspaces](~~449124~~)。', 'type' => 'string', 'required' => false, 'example' => '726**'],
],
[
'name' => 'FuzzyMatching',
'in' => 'query',
'schema' => [
'title' => '模糊匹配',
'description' => '是否支持模糊匹配。取值如下:'."\n"
.'- false:不支持'."\n"
.'- true:支持',
'type' => 'boolean',
'required' => false,
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681B****'],
'Pipelines' => [
'description' => '工作流列表。',
'type' => 'array',
'items' => [
'description' => '工作流。',
'type' => 'object',
'properties' => [
'PipelineId' => ['description' => '工作流ID。', 'type' => 'string', 'example' => 'pipeline-c0h44g3wlwkj8o*****'],
'GmtCreateTime' => ['description' => '创建UTC时间,日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-06T14:32:50Z'],
'GmtModifiedTime' => ['description' => '修改UTC时间,日期格式ISO8601。', 'type' => 'string', 'example' => '2021-01-06T22:26:24Z'],
'Provider' => ['description' => '工作流提供者。'."\n"
.'- PAI平台提供的工作流Provider为pai。'."\n"
.'- 您创建的工作流,该值为您的阿里云账号ID。', 'type' => 'string', 'example' => 'pai'],
'Identifier' => ['description' => '工作流标识。', 'type' => 'string', 'example' => 'SqlWriteTable_2'],
'Version' => ['description' => '工作流版本。', 'type' => 'string', 'example' => 'v1'],
'Uuid' => ['description' => '工作流当前版本标识,用户每次更新,会生成该uuid。', 'type' => 'string', 'example' => 'q8dp9hklueznh*****'],
'WorkspaceId' => ['description' => '工作空间ID。', 'type' => 'string', 'example' => '726**'],
],
],
],
'TotalCount' => ['description' => '总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '15'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取工作流列表',
'summary' => '获取工作流列表。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelines'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelines',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681B****\\",\\n \\"Pipelines\\": [\\n {\\n \\"PipelineId\\": \\"pipeline-c0h44g3wlwkj8o*****\\",\\n \\"GmtCreateTime\\": \\"2021-01-06T14:32:50Z\\",\\n \\"GmtModifiedTime\\": \\"2021-01-06T22:26:24Z\\",\\n \\"Provider\\": \\"pai\\",\\n \\"Identifier\\": \\"SqlWriteTable_2\\",\\n \\"Version\\": \\"v1\\",\\n \\"Uuid\\": \\"q8dp9hklueznh*****\\",\\n \\"WorkspaceId\\": \\"726**\\"\\n }\\n ],\\n \\"TotalCount\\": 15\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'RerunPipelineRun' => [
'path' => '/api/v1/pipelineruns/{PipelineRunId}/rerun',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '146517',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['description' => '工作流ID,如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'run-rbvg5wzljzjhc9ks92'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结果。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681BD9FAA'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开始工作流任务',
'summary' => '重新执行工作流任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RerunPipelineRun'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:RerunPipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681BD9FAA\\"\\n}","type":"json"}]',
],
'StartPipelineRun' => [
'path' => '/api/v1/pipelineruns/{PipelineRunId}/start',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140031',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-rbvg5wzljzjhc9ks92'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '启动工作流任务 ',
'summary' => '启动工作流任务。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPipelineRun'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'TerminatePipelineRun' => [
'summary' => '终止工作流任务。',
'path' => '/api/v1/pipelineruns/{PipelineRunId}/termination',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140033',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['title' => 'Run id', 'description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-rbvg5wzljzjhc9ks92'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '终止工作流任务 ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminatePipelineRun'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:TerminatePipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
'UpdatePipeline' => [
'path' => '/api/v1/pipelines/{PipelineId}',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '13807',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineId',
'in' => 'path',
'schema' => ['description' => '工作流ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'pipeline-hynm2bv8**********'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '请求Body。',
'type' => 'object',
'properties' => [
'Manifest' => ['description' => '工作流定义,具体样例见下方请求参数补充说明。', 'type' => 'string', 'required' => true, 'example' => 'apiVersion: "core/v1"*********'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DA869D1B-035A-43B2-ACC1-C56681******'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新工作流',
'summary' => '更新工作流的定义。',
'requestParamsDescription' => '工作流定义样例:该工作流由读数据表(`data_source`),类型转换(`type_transform`)组成。'."\n"
."\n"
.'```'."\n"
.'apiVersion: "core/v1"'."\n"
.'metadata:'."\n"
.' provider: "166233998075****"'."\n"
.' version: "v1"'."\n"
.' identifier: "my_pipeline"'."\n"
.' name: "source-transform"'."\n"
.'spec:'."\n"
.' inputs:'."\n"
.' parameters:'."\n"
.' - name: "execution_maxcompute"'."\n"
.' value:'."\n"
.' spec:'."\n"
.' endpoint: "http://service.cn.maxcompute.aliyun-inc.com/api"'."\n"
.' odpsProject: "test_i****"'."\n"
.' type: "Map"'."\n"
.' pipelines:'."\n"
.' - apiVersion: "core/v1"'."\n"
.' metadata:'."\n"
.' provider: "pai"'."\n"
.' version: "v1"'."\n"
.' identifier: "data_source"'."\n"
.' name: "data-source"'."\n"
.' displayName: "读数据表-1"'."\n"
.' spec:'."\n"
.' arguments:'."\n"
.' parameters:'."\n"
.' - name: "inputTableName"'."\n"
.' value: "pai_online_project.wumai_data"'."\n"
.' - name: "execution"'."\n"
.' from: "{{inputs.parameters.execution_maxcompute}}"'."\n"
.' - apiVersion: "core/v1"'."\n"
.' metadata:'."\n"
.' provider: "pai"'."\n"
.' version: "v1"'."\n"
.' identifier: "type_transform"'."\n"
.' name: "type-transform"'."\n"
.' displayName: "类型转换-1"'."\n"
.' spec:'."\n"
.' arguments:'."\n"
.' artifacts:'."\n"
.' - name: "inputTable"'."\n"
.' from: "{{pipelines.data_source.outputs.artifacts.outputTable}}"'."\n"
.' parameters:'."\n"
.' - name: "cols_to_double"'."\n"
.' value: "time,hour,pm2,pm10,so2,co,no2"'."\n"
.' - name: "execution"'."\n"
.' from: "{{inputs.parameters.execution_maxcompute}}"'."\n"
.' dependencies:'."\n"
.' - "data_source"'."\n"
.'```'."\n"
.'其中关键参数配置如下:'."\n"
.'- **provider**:替换为您的账号ID。'."\n"
.'- **odpsProject**:替换为绑定到工作空间中的MaxCompute资源名称。如何查询MaxCompute资源名称,请参见[管理工作空间](~~430481~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:UpdatePipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA869D1B-035A-43B2-ACC1-C56681******\\"\\n}","type":"json"}]',
],
'UpdatePipelineRun' => [
'path' => '/api/v1/pipelineruns/{PipelineRunId}',
'methods' => ['put'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '140032',
'abilityTreeNodes' => ['FEATURElearnWUYTTV'],
],
'parameters' => [
[
'name' => 'PipelineRunId',
'in' => 'path',
'schema' => ['description' => '工作流任务ID。如何获取工作流任务ID,请参见[ListPipelineRuns](~~438042~~)。', 'type' => 'string', 'required' => true, 'example' => 'flow-rbvg5wzljzjhc9ks92'],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
'description' => '工作流任务。',
'type' => 'object',
'properties' => [
'Name' => ['description' => '输入更新后的工作流任务名称。', 'type' => 'string', 'required' => true, 'example' => 'testName'],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回结构体。',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '473469C7-****-****-****-A3DC0DE3C83E'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新工作流任务',
'summary' => '更新工作流任务。目前仅支持修改工作流任务名称。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineRun'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:UpdatePipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"473469C7-****-****-****-A3DC0DE3C83E\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.cn-shenzhen.aliyuncs.com', 'endpoint' => 'paiflow.cn-shenzhen.aliyuncs.com', 'vpc' => 'paiflow-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'paiflow.cn-wulanchabu.aliyuncs.com', 'vpc' => 'paiflow-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.cn-beijing.aliyuncs.com', 'endpoint' => 'paiflow.cn-beijing.aliyuncs.com', 'vpc' => 'paiflow-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.cn-shanghai.aliyuncs.com', 'endpoint' => 'paiflow.cn-shanghai.aliyuncs.com', 'vpc' => 'paiflow-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.cn-hongkong.aliyuncs.com', 'endpoint' => 'paiflow.cn-hongkong.aliyuncs.com', 'vpc' => 'paiflow-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.ap-southeast-1.aliyuncs.com', 'endpoint' => 'paiflow.ap-southeast-1.aliyuncs.com', 'vpc' => 'paiflow-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.ap-southeast-5.aliyuncs.com', 'endpoint' => 'paiflow.ap-southeast-5.aliyuncs.com', 'vpc' => 'paiflow-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'paiflow.cn-hangzhou.aliyuncs.com', 'endpoint' => 'paiflow.cn-hangzhou.aliyuncs.com', 'vpc' => 'paiflow-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'paiflow.us-west-1.aliyuncs.com', 'endpoint' => 'paiflow.us-west-1.aliyuncs.com', 'vpc' => 'paiflow-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'paiflow.us-east-1.aliyuncs.com', 'endpoint' => 'paiflow.us-east-1.aliyuncs.com', 'vpc' => 'paiflow-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'paiflow.eu-central-1.aliyuncs.com', 'endpoint' => 'paiflow.eu-central-1.aliyuncs.com', 'vpc' => 'paiflow-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'paiflow.ap-south-1.aliyuncs.com', 'endpoint' => 'paiflow.ap-south-1.aliyuncs.com', 'vpc' => 'paiflow-vpc.ap-south-1.aliyuncs.com'],
],
'errorCodes' => [],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunNodeStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunNodeLogs'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineRunNode'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipelineRun'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartPipelineRun'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePipeline'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelines'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminatePipelineRun'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunNodeOutputs'],
['threshold' => '30', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePipelineRun'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipeline'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPipelineRun'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRunsStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipelineRun'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePipeline'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePipeline'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPipelineRuns'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RerunPipelineRun'],
],
],
'ram' => [
'productCode' => 'PAIFlow',
'productName' => '人工智能平台 PAI',
'ramCodes' => ['paiflow'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'ListPipelineRunNodeLogs',
'description' => '获取工作流任务节点日志 ',
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRunNodeLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPipelineRunNodeStatus',
'description' => '获取工作流任务节点状态 ',
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRunNodeStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdatePipeline',
'description' => '更新工作流',
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:UpdatePipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeletePipeline',
'description' => '删除工作流',
'operationType' => 'delete',
'ramAction' => [
'action' => 'paiflow:DeletePipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RerunPipelineRun',
'description' => '开始工作流任务',
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:RerunPipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPipeline',
'description' => '获取工作流',
'operationType' => 'get',
'ramAction' => [
'action' => 'paiflow:GetPipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPipelineRunNodeOutputs',
'description' => '获取工作流任务节点输出 ',
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRunNodeOutputs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPipelineRuns',
'description' => '获取工作流任务列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelineRuns',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdatePipelineRun',
'description' => '更新工作流任务',
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:UpdatePipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListPipelines',
'description' => '获取工作流列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'paiflow:ListPipelines',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePipeline',
'description' => '创建工作流',
'operationType' => 'create',
'ramAction' => [
'action' => 'paiflow:CreatePipeline',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'TerminatePipelineRun',
'description' => '终止工作流任务 ',
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:TerminatePipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreatePipelineRun',
'description' => '创建工作流任务 ',
'operationType' => 'create',
'ramAction' => [
'action' => 'paiflow:CreatePipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPipelineRunNode',
'description' => '获取工作流任务节点信息 ',
'operationType' => 'get',
'ramAction' => [
'action' => 'paiflow:GetPipelineRunNode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartPipelineRun',
'description' => '启动工作流任务 ',
'operationType' => 'update',
'ramAction' => [
'action' => 'paiflow:StartPipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPipelineRun',
'description' => '获取工作流任务信息 ',
'operationType' => 'get',
'ramAction' => [
'action' => 'paiflow:GetPipelineRun',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'PAIFlow', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|