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
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'fnf', 'version' => '2019-03-15'],
'directories' => [
[
'children' => ['DescribeRegions'],
'type' => 'directory',
'title' => '地域',
'id' => 87038,
],
[
'children' => [
'CreateFlow',
'DeleteFlow',
'UpdateFlow',
'DescribeFlow',
'ListFlows',
[
'children' => ['PublishFlowVersion', 'ListFlowVersions', 'DeleteFlowVersion'],
'type' => 'directory',
'title' => '流程版本',
'id' => 212631,
],
[
'children' => ['ListFlowAliases', 'CreateFlowAlias', 'DescribeFlowAlias', 'UpdateFlowAlias', 'DeleteFlowAlias'],
'type' => 'directory',
'title' => '流程别名',
'id' => 212954,
],
],
'type' => 'directory',
'title' => '流程',
'id' => 46915,
],
[
'children' => ['StartExecution', 'StopExecution', 'DescribeExecution', 'ListExecutions', 'GetExecutionHistory', 'StartSyncExecution', 'DescribeMapRun', 'UpdateMapRun'],
'type' => 'directory',
'title' => '执行',
'id' => 46927,
],
[
'children' => ['ReportTaskFailed', 'ReportTaskSucceeded'],
'type' => 'directory',
'title' => '任务',
'id' => 46912,
],
[
'children' => ['CreateSchedule', 'DeleteSchedule', 'UpdateSchedule', 'DescribeSchedule', 'ListSchedules'],
'type' => 'directory',
'title' => '定时调度',
'id' => 46921,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'CreateFlow' => [
'summary' => '创建一个流程。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '98854',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '流程名称。该名称在同一地域内唯一,创建后不可修改。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'Definition',
'in' => 'formData',
'schema' => ['description' => '流程定义,遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容,当系统支持两种规范的流程定义规范。'."\n"
."\n"
.'> '."\n"
.'> 以上流程定义示例中Name:my_flow_name是指流程名称,需和入参Name保持一致', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Legacy version:'."\n"
.'"'."\n"
.'type: flow'."\n"
.'version: v1'."\n"
.'name: my_flow_name'."\n"
.'steps:'."\n"
.' - type: pass'."\n"
.' name: mypass'."\n"
.'"'."\n"
."\n"
.'New version:'."\n"
.'"'."\n"
.'Type: StateMachine'."\n"
.'SpecVersion: v1'."\n"
.'Name: my_flow_name'."\n"
.'StartAt: my_state'."\n"
.'States:'."\n"
.' - Type: Pass'."\n"
.' Name: my_state'."\n"
.' End: true'."\n"
.'"'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '流程描述。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my test flow'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '流程类型,取值:**FDL**。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'enumValueTitles' => ['FDL' => '流程描述语言'],
'example' => 'FDL',
],
],
[
'name' => 'RoleArn',
'in' => 'formData',
'schema' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时,Serverless 工作流服务扮演该角色(AssumeRole)操作相关的流程资源。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram:${region}:${accountID}:${role}'],
],
[
'name' => 'ExternalStorageLocation',
'in' => 'formData',
'schema' => ['description' => '外部存储位置。', 'type' => 'string', 'required' => false, 'example' => '/path'],
],
[
'name' => 'ExecutionMode',
'in' => 'formData',
'schema' => [
'title' => '执行模式,枚举类型,可以是Express和Standard,空串等价于Standard',
'description' => '执行模式,枚举类型,可以是Express和Standard;考虑到向前兼容,空串等价于Standard 执行模式。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['Express' => '快速执行模式', 'Standard' => '标准执行模式'],
'example' => 'Standard',
],
],
[
'name' => 'Environment',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '配置 Flow 执行期间可以访问的变量列表',
'description' => '配置 Flow 执行期间可以访问的环境信息',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => '配置 Flow 执行期间可以访问的变量列表',
'description' => '配置 Flow 执行期间可以访问的环境变量列表',
'type' => 'array',
'items' => [
'title' => '配置 Flow 执行期间可以访问的变量列表',
'description' => '配置 Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'required' => false, 'example' => 'value'],
'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
[
'name' => 'ResourceGroupId',
'in' => 'formData',
'schema' => ['title' => '资源组id', 'type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Type' => [
'description' => '流程类型。',
'type' => 'string',
'enumValueTitles' => ['FDL' => '流程描述语言'],
'example' => 'FDL',
],
'Definition' => ['description' => '流程定义,考虑到向前兼容,当系统支持两种规范的流程定义规范。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n"
."\n"
.'New version:'."\n"
.'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'],
'RoleArn' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时,Serverless 工作流服务扮演该角色(AssumeRole)操作相关的流程资源。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'],
'RequestId' => ['description' => '请求ID。当有`http status code`返回时,Serverless工作流都会返回请求ID。', 'type' => 'string', 'example' => 'testRequestID'],
'Description' => ['description' => '流程描述信息。', 'type' => 'string', 'example' => 'my test flow'],
'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '流程最近一次的更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'Id' => ['description' => '流程的唯一标识。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****'],
'ExecutionMode' => ['title' => '执行模式,枚举类型,可以是Express和Standard,空串等价于Standard', 'description' => '执行模式,枚举类型,可以是Express和Standard,考虑到向前兼容,该字段可能为空字符串,这种情况等价于Standard模式。', 'type' => 'string', 'example' => 'Standard'],
'Environment' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'],
],
],
],
],
],
'ResourceGroupId' => ['title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
409 => [
['errorCode' => 'FlowAlreadyExists', 'errorMessage' => 'Flow %s already exists.', 'description' => '已存在同名流程。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '创建一个流程',
'description' => '## 接口说明'."\n"
.'- 每个用户所能创建的流程个数受资源限制(详见[使用限制](~~122093~~)),如果您有特殊需求,可以提工单进行调整。'."\n"
.'- 流程在用户级别是按照名称来区分的,即单一账号下不可以存在同名流程。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'fnf:CreateFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'],
],
],
],
],
],
'CreateFlowAlias' => [
'summary' => '为流程创建别名,此后可以在发起执行时指定流程别名',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'required' => true, 'example' => 'example-alias-name'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'required' => false, 'example' => 'example description'],
],
[
'name' => 'RoutingConfigurations',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '流量分发设置',
'description' => '流量分发配置,支持配置一个或两个流程版本。当指定别名发起执行时,系统会根据权重选择对应的流程版本进行执行。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Version' => ['title' => '流程版本', 'description' => '流程版本', 'type' => 'string', 'required' => true, 'example' => '1'],
'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '30'],
],
'required' => false,
],
'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'testRequestID'],
'FlowName' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'example' => 'example-flow-name'],
'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'exampe-alias-name'],
'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'example description'],
'RoutingConfigurations' => [
'description' => '流量分发配置,支持配置一个或两个流程版本。当指定别名发起执行时,系统会根据权重选择对应的流程版本进行执行。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本名称', 'description' => '版本名称', 'type' => 'string', 'example' => '1'],
'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
],
],
],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建一个流程别名',
'description' => '## 接口说明'."\n"
.'- 每个用户所能创建的流程个数受资源限制(详见[使用限制](~~122093~~)),如果您有特殊需求,可以提工单进行调整。'."\n"
.'- 流程在用户级别是按照名称来区分的,即单一账号下不可以存在同名流程。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"FlowName\\": \\"example-flow-name\\",\\n \\"Name\\": \\"exampe-alias-name\\",\\n \\"Description\\": \\"example description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 30\\n }\\n ],\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\"\\n}","type":"json"}]',
],
'CreateSchedule' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '98855',
'abilityTreeNodes' => ['FEATUREfnf06LH4G'],
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => '定时调度绑定的工作流名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ScheduleName',
'in' => 'formData',
'schema' => ['description' => '定时调度的名称。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_schedule_name'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '定时调度的描述。', 'type' => 'string', 'required' => false, 'example' => 'my test schedule'],
],
[
'name' => 'Payload',
'in' => 'formData',
'schema' => ['description' => '定时调度的触发消息,必须为JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"key": "value"}'],
],
[
'name' => 'CronExpression',
'in' => 'formData',
'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0 * * * * *'],
],
[
'name' => 'Enable',
'in' => 'formData',
'schema' => ['description' => '是否启用定时调度。取值说明如下:'."\n"
.'- **true**:启用。'."\n"
.'- **false**:禁用。'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SignatureVersion',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'test description'],
'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'],
'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'],
'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'testScheduleName'],
'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '定时调度最近一次的更改时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'],
'Enable' => ['description' => '是否启用定时调度。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
],
409 => [
['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''],
['errorCode' => 'ScheduleAlreadyExists', 'errorMessage' => 'The schedule %s already exists in flow %s.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"testScheduleName\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '创建一个定时调度(仅适用于旧版工作流)',
'summary' => '创建一个定时调度。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'fnf:CreateSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteFlow' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '98856',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '要删除的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
],
409 => [
['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除一个已存在的流程',
'summary' => '删除一个已存在的流程。',
'description' => '## 接口说明'."\n"
.'删除动作为异步删除,API调用成功后您将收到成功的返回。待删除后您重新建立的同名流程不会受到历史的流程影响。删除流程后,所有的历史执行信息将无法再查询,处于执行中的每个执行将会完成最近的一个步骤后停止。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'fnf:DeleteFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DeleteFlowAlias' => [
'summary' => '删除流程别名',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => 'Flow名称', 'type' => 'string', 'required' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '别名名称', 'type' => 'string', 'required' => true, 'example' => 'alias_name'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除指定的流程别名',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]',
],
'DeleteFlowVersion' => [
'summary' => '删除流程版本',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'high',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow'],
],
[
'name' => 'FlowVersion',
'in' => 'formData',
'schema' => ['title' => '流程版本', 'description' => '流程版本', 'type' => 'string', 'required' => true, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '删除指定的流程版本',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\"\\n}","type":"json"}]',
],
'DeleteSchedule' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '98857',
'abilityTreeNodes' => ['FEATUREfnf06LH4G'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => '待删除调度任务绑定的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'flow'],
],
[
'name' => 'ScheduleName',
'in' => 'formData',
'schema' => ['description' => '待删除调度的名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'testScheduleName'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
['errorCode' => 'ScheduleNotExists', 'errorMessage' => 'The schedule %s for flow %s does not exist.', 'description' => ''],
],
409 => [
['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '删除一个定时调度(仅适用于旧版工作流)',
'summary' => '删除一个定时调度。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'fnf:DeleteSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeExecution' => [
'summary' => '获取一次执行的状态信息,支持长轮询模式,长轮询最长等待时间由 WaitTimeSeconds 参数指定。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '98858',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'query',
'schema' => ['description' => '执行名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'],
],
[
'name' => 'WaitTimeSeconds',
'in' => 'query',
'schema' => ['description' => '请求长轮询的最长等待时间。取值范围\\[0,60],单位为秒。取值说明如下:'."\n"
.'- 取值等于0:请求立即返回当前执行状态。'."\n"
.'- 取值大于0:请求在服务端长轮询等待执行结束,最长等待设定的秒数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '执行状态。取值说明如下:'."\n"
.'- **Starting**'."\n"
.'- **Running**'."\n"
.'- **Stopped**'."\n"
.'- **Succeeded**'."\n"
.'- **Failed**'."\n"
.'- **TimedOut**', 'type' => 'string', 'example' => 'Succeeded'],
'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n"
."\n"
.'New version:'."\n"
.'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'],
'Output' => ['description' => '执行的输出,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'],
'Input' => ['description' => '执行的输入,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'Environment' => [
'title' => 'Flow 执行时使用的环境变量列表',
'description' => 'Flow 执行时使用的环境变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行时使用的环境变量列表',
'description' => 'Flow 执行时使用的环境变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
],
403 => [
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建并存在待查询的执行。'],
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取一次执行的状态信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:DescribeExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeFlow' => [
'summary' => '获取一个流程的相关信息。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '98859',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => '流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'FlowVersion',
'in' => 'query',
'schema' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'FDL'],
'Definition' => ['description' => '流程定义,遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容,当系统支持两种规范的流程定义规范。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"'."\n"
.'type: flow'."\n"
.'version: v1'."\n"
.'name: my_flow_name'."\n"
.'steps:'."\n"
.' - type: pass'."\n"
.' name: mypass'."\n"
.'"'."\n"
."\n"
.'New version:'."\n"
.'"'."\n"
.'Type: StateMachine'."\n"
.'SpecVersion: v1'."\n"
.'Name: my_flow_name'."\n"
.'StartAt: my_state'."\n"
.'States:'."\n"
.' - Type: Pass'."\n"
.' Name: my_state'."\n"
.' End: true'."\n"
.'"'],
'RoleArn' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时,Serverless 工作流服务扮演该角色(AssumeRole)操作相关的流程资源。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Description' => ['description' => '流程描述。', 'type' => 'string', 'example' => 'my test flow'],
'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '流程最近一次的更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'Id' => ['description' => '流程的唯一ID。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****'],
'ExecutionMode' => ['title' => '执行模式,枚举类型,可以是Express和Standard,空串等价于Standard', 'description' => '执行模式,枚举类型,可以是Express和Standard,空串等价于Standard', 'type' => 'string', 'example' => 'Standard'],
'Environment' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'],
],
],
],
],
],
'ResourceGroupId' => ['title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"Legacy version:\\\\n\\\\\\"\\\\ntype: flow\\\\nversion: v1\\\\nname: my_flow_name\\\\nsteps:\\\\n - type: pass\\\\n name: mypass\\\\n\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"\\\\nType: StateMachine\\\\nSpecVersion: v1\\\\nName: my_flow_name\\\\nStartAt: my_state\\\\nStates:\\\\n - Type: Pass\\\\n Name: my_state\\\\n End: true\\\\n\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取一个流程的相关信息',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:DescribeFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeFlowAlias' => [
'summary' => '查询流程版本别名详情',
'path' => '',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '别名', 'description' => '别名', 'type' => 'string', 'required' => true, 'example' => 'example-alias-name'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'],
'Alias' => [
'title' => '别名信息',
'description' => '别名信息',
'type' => 'object',
'properties' => [
'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'alias-name'],
'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'alias description'],
'RoutingConfigurations' => [
'title' => '权重配置',
'description' => '权重配置',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1'],
'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-04-22T06:09:39.907Z'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询指定的流程别名配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"Alias\\": {\\n \\"Name\\": \\"alias-name\\",\\n \\"Description\\": \\"alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 10\\n }\\n ],\\n \\"CreatedTime\\": \\"2024-04-22T06:09:39.907Z\\"\\n }\\n}","type":"json"}]',
],
'DescribeMapRun' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227531',
'abilityTreeNodes' => ['FEATUREfnfR0JC2A'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RequestId',
'in' => 'query',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
],
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '流程名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'query',
'schema' => ['description' => '执行名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'],
],
[
'name' => 'MapRunName',
'in' => 'query',
'schema' => ['description' => 'MapRun 名称,当 Execution 中发起 MapRun 执行后,会产生 MapRunStarted 事件,MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', 'type' => 'string', 'required' => true, 'example' => 'c39142f1345b196d678333c41f113200'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '执行状态。取值说明如下:'."\n"
.'- **Pending**'."\n"
.'- **Running**'."\n"
.'- **Failed**'."\n"
.'- **Succeeded**'."\n"
.'- **Aborted**', 'type' => 'string', 'example' => 'Succeeded'],
'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2025-10-24T14:11:28+08:00'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'],
'Concurrency' => ['description' => 'MapRun 运行时的并发限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ToleratedFailedCount' => ['description' => '允许失败的 Item 数量的最大值', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ToleratedFailedPercentage' => ['description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比', 'type' => 'number', 'format' => 'float', 'example' => '20'],
'ExecutionName' => ['description' => '执行名称', 'type' => 'string', 'example' => 'my_exec_name'],
'MapRunName' => ['description' => 'MapRun 名称', 'type' => 'string', 'example' => 'c39142f1345b196d678333c41f113000'],
'ItemCounts' => [
'description' => 'MapRun 任务中处于不同处理状态的 Item 数量汇总',
'type' => 'object',
'properties' => [
'Pending' => ['description' => '待开始的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Running' => ['description' => '正在处理的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Succeed' => ['description' => '处理完成的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Failed' => ['description' => '处理失败的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Aborted' => ['description' => '处理终止的 Item 数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Total' => ['description' => 'Item 总数量', 'type' => 'integer', 'format' => 'int64', 'example' => '500'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
],
403 => [
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建并存在待查询的执行。'],
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询 MapRun 执行详情',
'summary' => '查询 MapRun 详情',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2025-10-24T14:11:28+08:00\\",\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"StartedTime\\": \\"2025-10-24T14:11:26+08:00\\",\\n \\"Concurrency\\": 1,\\n \\"ToleratedFailedCount\\": 100,\\n \\"ToleratedFailedPercentage\\": 20,\\n \\"ExecutionName\\": \\"my_exec_name\\",\\n \\"MapRunName\\": \\"c39142f1345b196d678333c41f113000\\",\\n \\"ItemCounts\\": {\\n \\"Pending\\": 100,\\n \\"Running\\": 100,\\n \\"Succeed\\": 100,\\n \\"Failed\\": 100,\\n \\"Aborted\\": 100,\\n \\"Total\\": 500\\n }\\n}","type":"json"}]',
],
'DescribeRegions' => [
'summary' => '查询云工作流产品支持的地域信息。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '264118',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'formData',
'schema' => [
'title' => '根据汉语、英语筛选返回结果。更多详情,请参见RFC 7231。取值范围:'."\n"
."\n"
.'zh-CN:简体中文。'."\n"
.'en-US:英文。'."\n"
.'默认值:zh-CN。',
'description' => '根据汉语、英语筛选返回结果。更多详情,请参见RFC 7231。取值范围:'."\n"
."\n"
.'zh-CN:简体中文。'."\n"
.'en-US:英文。'."\n"
.'默认值:zh-CN。',
'type' => 'string',
'required' => false,
'example' => 'zh-CN',
'default' => 'zh-CN',
'enum' => ['zh-CN', 'en-US'],
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '0aa3f793-6e5f-8472-c7a2-70d2b84c04ac'],
'Regions' => [
'description' => '地域信息。',
'type' => 'object',
'properties' => [
'Region' => [
'description' => '地域信息集合。',
'type' => 'array',
'items' => [
'description' => '地域对象。',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-qingdao'],
'RegionEndpoint' => ['description' => '地域对应的公网接入点。', 'type' => 'string', 'example' => 'cn-qingdao.fnf.aliyuncs.com'],
'LocalName' => ['description' => '地域名称。', 'type' => 'string', 'example' => 'China (Qingdao)'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation %s is incorrect. Please check.', 'description' => '所请求方法错误。请参照API文档并检查拼写。'],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version %s is not supported yet. Please check.', 'description' => '所请求接口版本不正确。请参考API简介。'],
],
403 => [
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0aa3f793-6e5f-8472-c7a2-70d2b84c04ac\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-qingdao\\",\\n \\"RegionEndpoint\\": \\"cn-qingdao.fnf.aliyuncs.com\\",\\n \\"LocalName\\": \\"China (Qingdao)\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '查询地域信息',
'responseParamsDescription' => '正常返回示例'."\n"
.'JSON格式'."\n"
.'```json'."\n"
.'{'."\n"
.' "RequestId": "67623904-2da4-d950-c8c0-7c68573899ab",'."\n"
.' "Regions": {'."\n"
.' "Region": ['."\n"
.' {'."\n"
.' "RegionId": "cn-qingdao",'."\n"
.' "RegionEndpoint": "cn-qingdao.fnf.aliyuncs.com",'."\n"
.' "LocalName": "华北1(青岛)"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.'}'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'DescribeSchedule' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '98860',
'abilityTreeNodes' => ['FEATUREfnf06LH4G'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '定时调度绑定的流程名称。该名称在同一地域内唯一,创建后不可修改。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_test_flow'],
],
[
'name' => 'ScheduleName',
'in' => 'query',
'schema' => ['description' => '定时调度的名称。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_schedule_name'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'test description'],
'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'],
'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'],
'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'my_schedule_name'],
'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '定时调度最近一次的更改时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'],
'Enable' => ['description' => '是否启用定时调度。取值说明如下:'."\n"
.'- **true**:启用。'."\n"
.'- **false**:禁用。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
['errorCode' => 'ScheduleNotExists', 'errorMessage' => 'The schedule %s for flow %s does not exist.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取一个定时调度(仅适用于旧版工作流)',
'summary' => '获取一个定时调度信息。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:DescribeSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetExecutionHistory' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '98861',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'query',
'schema' => ['description' => '执行名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'Event查询开始名称,根据本接口返回获取。', 'type' => 'string', 'required' => false, 'example' => 'flow_xxx'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询数量。取值范围\\[1,1000),默认值为60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '首次查询非必填,该字段是以返回的**ScheduleEventId**作为下次查询的Token;无数据时,该字段不返回。', 'type' => 'string', 'example' => '3'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Events' => [
'description' => '事件信息。',
'type' => 'array',
'items' => [
'description' => '事件信息。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '执行步骤类型。取值说明如下:'."\n"
.'- **StepEntered**'."\n"
.'- **StepStarted**'."\n"
.'- **StepSucceeded**'."\n"
.'- **StepFailed**'."\n"
.'- **StepExited**'."\n"
.'- **BranchEntered**'."\n"
.'- **BranchExited**'."\n"
.'- **IterationEntered**'."\n"
.'- **IterationExited**'."\n"
.'- **TaskScheduled**'."\n"
.'- **TaskStarted**'."\n"
.'- **TaskSubmitted**'."\n"
.'- **TaskSubmitFailed**'."\n"
.'- **TaskSucceeded**'."\n"
.'- **TaskFailed**'."\n"
.'- **TaskTimedOut**'."\n"
.'- **ExecutionStarted**'."\n"
.'- **ExecutionStopped**'."\n"
.'- **ExecutionSucceeded**'."\n"
.'- **ExecutionFailed**'."\n"
.'- **ExecutionTimedOut**', 'type' => 'string', 'example' => 'TaskSucceeded'],
'EventId' => ['description' => '执行步骤ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Time' => ['description' => '事件更新时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'ScheduleEventId' => ['description' => '调度步骤ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'EventDetail' => ['description' => '执行步骤详情。', 'type' => 'string', 'example' => '{}'],
'StepName' => ['description' => '执行步骤名称。', 'type' => 'string', 'example' => 'passStep'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''],
],
[
['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => ''],
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"3\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Events\\": [\\n {\\n \\"Type\\": \\"TaskSucceeded\\",\\n \\"EventId\\": 2,\\n \\"Time\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"ScheduleEventId\\": 1,\\n \\"EventDetail\\": \\"{}\\",\\n \\"StepName\\": \\"passStep\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取一次执行的步骤详情',
'summary' => '获取指定执行过程中的每个步骤详细信息。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'fnf:GetExecutionHistory',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListExecutions' => [
'summary' => '获取一个流程的所有历史执行。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '98862',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '流程名称。该名称在同一地域内唯一,创建后不可修改。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '执行查询开始名称,根据本接口返回获取。首次查询非必填。', 'type' => 'string', 'required' => false, 'example' => 'flow_xxx'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询数量。取值范围\\[1,100],默认值为60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '需要过滤的执行状态。取值说明如下:'."\n"
.'- **Starting**'."\n"
.'- **Running**'."\n"
.'- **Stopped**'."\n"
.'- **Succeeded**'."\n"
.'- **Failed**'."\n"
.'- **TimedOut**', 'type' => 'string', 'required' => false, 'example' => 'Succeeded'],
],
[
'name' => 'StartedTimeBegin',
'in' => 'query',
'schema' => ['description' => '筛选某个执行的起始时间后的所有执行,格式为UTC RFC3339。', 'type' => 'string', 'required' => false, 'example' => '2020-12-02T02:39:20.402Z'],
],
[
'name' => 'StartedTimeEnd',
'in' => 'query',
'schema' => ['description' => '筛选某个执行的起始时间前的所有执行,格式为UTC RFC3339。', 'type' => 'string', 'required' => false, 'example' => '2020-12-02T02:23:54.817Z'],
],
[
'name' => 'ExecutionNamePrefix',
'in' => 'query',
'schema' => ['description' => '执行的名称前缀。', 'type' => 'string', 'required' => false, 'example' => 'run'],
],
[
'name' => 'MetadataOnly',
'in' => 'query',
'schema' => ['title' => '是否只返回执行的元数据。为true时,返回值中不包括Flow定义、Input和Output,为false时会返回全部数据', 'description' => '是否只返回执行的元数据。为true时,返回值中不包括Flow定义、Input和Output,为false时会返回全部数据', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'Qualifier',
'in' => 'query',
'schema' => ['title' => '指定流程的版本或别名', 'description' => '指定流程的版本或别名', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'MapRunName',
'in' => 'query',
'schema' => ['title' => 'MapRun 名称', 'description' => 'MapRun 名称,当 Execution 中发起 MapRun 执行后,会产生 MapRunStarted 事件,MapRunName 可以从 MapRunStarted 事件的 Output 中获取。'."\n"
."\n"
.'可以通过设置 MapRunName 过滤当前 Flow 中指定 MapRun 发起的子执行。', 'type' => 'string', 'required' => false, 'example' => 'c39142f1345b196d678333c41f113100'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下个查询起始Key,如无其他数据则不返回。'."\n"
.'> '."\n"
.'> 返回结果中,可能因为没有下一页内容不显示该参数。', 'type' => 'string', 'example' => '397aba96-4d85-11ef-9c97-************'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '69AD2AA7-DB47-449B-941B-B14409DF****'],
'Executions' => [
'description' => '执行信息。',
'type' => 'array',
'items' => [
'description' => '执行信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '执行的状态。', 'type' => 'string', 'example' => 'Succeeded'],
'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n"
."\n"
.'New version:'."\n"
.'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'],
'Output' => ['description' => '执行的输出,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'],
'Input' => ['description' => '执行的输入,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'Environment' => [
'title' => 'Flow 执行时使用的环境变量列表',
'description' => 'Flow 执行时使用的环境变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行时使用的环境变量列表',
'description' => 'Flow 执行时使用的环境变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"397aba96-4d85-11ef-9c97-************\\",\\n \\"RequestId\\": \\"69AD2AA7-DB47-449B-941B-B14409DF****\\",\\n \\"Executions\\": [\\n {\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取一个流程的历史执行',
'description' => '## 接口说明'."\n"
."\n"
.'当您删除流程后,即便后续创建了同名流程,系统将不再支持查询原流程所有的执行历史。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ListExecutions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ListFlowAliases' => [
'summary' => '查询流程版本别名列表',
'path' => '',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'required' => false, 'example' => 'token'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['title' => '最大返回的结果数量', 'description' => '最大返回的结果数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
'NextToken' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'example' => 'testNextToken'],
'Aliases' => [
'title' => '别名列表',
'description' => '别名列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'my-alias-name'],
'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'my alias description'],
'RoutingConfigurations' => [
'title' => '权重配置',
'description' => '流量分发配置,支持配置一个或两个流程版本。当指定别名发起执行时,系统会根据权重选择对应的流程版本进行执行。',
'type' => 'array',
'items' => [
'description' => '流量分发配置,支持配置一个或两个流程版本。当指定别名发起执行时,系统会根据权重选择对应的流程版本进行执行。',
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1'],
'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'string', 'example' => '20'],
],
],
],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询流程别名列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"NextToken\\": \\"testNextToken\\",\\n \\"Aliases\\": [\\n {\\n \\"Name\\": \\"my-alias-name\\",\\n \\"Description\\": \\"my alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": \\"20\\"\\n }\\n ],\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListFlowVersions' => [
'summary' => '查询流程版本列表',
'path' => '',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'required' => false, 'example' => 'token'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['title' => '返回的最大结果数量', 'description' => '返回的最大结果数量', 'type' => 'string', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'],
'NextToken' => ['title' => 'list token', 'description' => 'list token', 'type' => 'string', 'example' => 'token'],
'FlowVersions' => [
'title' => '流程版本列表',
'description' => '流程版本列表',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本名称', 'description' => '版本名称', 'type' => 'string', 'example' => '1'],
'Description' => ['title' => '版本描述', 'description' => '版本描述', 'type' => 'string', 'example' => 'version description'],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'],
],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询流程版本列表',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"NextToken\\": \\"token\\",\\n \\"FlowVersions\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"version description\\",\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListFlows' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '98863',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '流程查询开始名称。', 'type' => 'string', 'required' => false, 'example' => 'flow_nextxxx'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询数量。取值范围\\[1,1000),默认值为60。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['type' => 'string', 'example' => 'rg-xxx'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '流程列表。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下次查询起始Key,如果没有其他数据则不返回。', 'type' => 'string', 'example' => 'flow_nextxxx'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Flows' => [
'description' => '流程列表。',
'type' => 'array',
'items' => [
'description' => '流程列表。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'FDL'],
'Definition' => ['description' => '流程定义,遵循FDL语法标准。', 'type' => 'string', 'example' => 'version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass'],
'RoleArn' => ['description' => '流程执行所需资源描述符信息。', 'type' => 'string', 'example' => 'acs:ram::${accountID}:${role}'],
'Description' => ['description' => '流程描述。', 'type' => 'string', 'example' => 'my test flow'],
'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '流程最后更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'Id' => ['description' => '流程的唯一ID。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddf5****'],
'ExecutionMode' => ['title' => '执行模式,枚举类型,可以是Express和Standard,空串等价于Standard', 'description' => '执行模式,枚举类型,可以是Express和Standard,空串等价于Standard', 'type' => 'string', 'example' => 'Standard'],
'Environment' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'],
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
'ResourceGroupId' => ['type' => 'string', 'example' => 'rg-xxx'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'title' => '批量查询流程信息',
'summary' => '批量查询流程信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ListFlows',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"flow_nextxxx\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Flows\\": [\\n {\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"version: v1.0\\\\\\\\ntype: flow\\\\\\\\nname: test\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\",\\n \\"RoleArn\\": \\"acs:ram::${accountID}:${role}\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddf5****\\",\\n \\"ExecutionMode\\": \\"Standard\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Description\\": \\"description\\",\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
],
'ListSchedules' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '98864',
'abilityTreeNodes' => ['FEATUREfnf06LH4G'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '定时调度绑定的流程名称。该名称在同一地域内唯一,创建后不可修改。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => '首次查询非必填,**NextToken**是以**FlowName**作为下次查询的Token,无下一页数据时,该字段不返回。', 'type' => 'string', 'required' => false, 'example' => 'testNextToken'],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => ['description' => '查询数量。取值范围\\[1,1000]。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '60'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'NextToken' => ['description' => '下一次查询的开始Token。', 'type' => 'string', 'example' => 'testNextToken'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Schedules' => [
'description' => '定时调度信息。',
'type' => 'array',
'items' => [
'description' => '定时调度信息。'."\n",
'type' => 'object',
'properties' => [
'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'test description'],
'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'],
'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'],
'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'my_schedule_name'],
'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '定时调度最近一次的更改时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'],
'Enable' => ['description' => '是否启用定时调度。取值说明如下:'."\n"
.'- **true**:启用。'."\n"
.'- **false**:禁用。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"NextToken\\": \\"testNextToken\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Schedules\\": [\\n {\\n \\"Description\\": \\"test description\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '获取定时调度列表(仅适用于旧版工作流)',
'summary' => '获取定时调度列表。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ListSchedules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'PublishFlowVersion' => [
'summary' => '以当前工作流的定义发布新的流程版本,版本号从1递增,流程版本会包含工作流定义、描述、环境变量设置和执行角色定义信息。',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '版本描述', 'description' => '版本描述', 'type' => 'string', 'required' => false, 'example' => 'example flow description'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'],
'FlowName' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'example' => 'my-flow-name'],
'Version' => ['title' => '流程版本', 'description' => '流程版本', 'type' => 'string', 'example' => '1'],
'Description' => ['title' => '流程版本描述', 'description' => '流程版本描述', 'type' => 'string', 'example' => 'my flow description'],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '发布流程版本',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"FlowName\\": \\"my-flow-name\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"my flow description\\",\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n}","type":"json"}]',
],
'ReportTaskFailed' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '98865',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskToken',
'in' => 'query',
'schema' => ['description' => '汇报任务指定的令牌。TaskToken会传递给被调用的服务,比如消息队列MNS或函数计算FC。对于MNS,用户可以从接收到的消息中获取,对于FC,用户可以从Event中获取。'."\n"
.'详情请参见[服务集成模式](~~2592915~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'djEjYSNkZTdkYWZjMi0zMGRlLTRlMDMtOTA2OC0yMTMxYmM5NGJlZTIjNSMvV1ZHYks3RTc0WUsra25nQTNYSmtFa0t6****'],
],
[
'name' => 'Error',
'in' => 'formData',
'schema' => ['description' => '失败错误代码。长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'InvalidArgument'],
],
[
'name' => 'Cause',
'in' => 'formData',
'schema' => ['description' => '失败错误原因。长度为1~4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'emptyString'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'EventId' => ['description' => '事件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'TaskAlreadyCompleted', 'errorMessage' => 'Task %s has already completed.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''],
],
409 => [
['errorCode' => 'TaskInvalidState', 'errorMessage' => 'Task is in an invalid state, please retry.', 'description' => ''],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EventId\\": 1,\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '汇报指定的任务执行失败',
'summary' => '汇报指定的任务执行失败。',
'description' => '## 接口说明'."\n"
.'在旧版Serverless 工作流中,使用该接口回调`pattern: waitForCallback`的任务步骤,表明当前任务执行失败。'."\n"
."\n"
.'在新版云工作流中,使用该接口回调`TaskMode: WaitForCustomCallback`的任务步骤,表明当前任务执行失败。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ReportTaskFailed',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ReportTaskSucceeded' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '98866',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'TaskToken',
'in' => 'query',
'schema' => ['description' => '汇报任务指定的令牌。TaskToken会传递给被调用的服务,比如消息队列MNS或函数计算FC。对于MNS,用户可以从接收到的消息中获取,对于FC,用户可以从Event中获取。详情请参见[服务集成模式](~~2592915~~)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'djEjYSNkZTdkYWZjMi0zMGRlLTRlMDMtOTA2OC0yMTMxYmM5NGJlZTIjNSMvV1ZHYks3RTc0WUsra25nQTNYSmtFa0t6U****'],
],
[
'name' => 'Output',
'in' => 'formData',
'schema' => ['description' => '汇报任务指定的输出信息。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"key":"value"}'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'EventId' => ['description' => '事件ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'TaskAlreadyCompleted', 'errorMessage' => 'Task %s has already completed.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => ''],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => ''],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => ''],
],
409 => [
['errorCode' => 'TaskInvalidState', 'errorMessage' => 'Task is in an invalid state, please retry.', 'description' => ''],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => ''],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EventId\\": 1,\\n \\"RequestId\\": \\"testRequestId\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '汇报指定的任务执行成功',
'summary' => '汇报指定的任务执行成功。',
'description' => '## 接口说明'."\n"
.'在旧版Serverless 工作流中,使用该接口回调pattern: waitForCallback的任务步骤,表明当前任务执行成功。'."\n"
."\n"
.'在新版云工作流中,使用该接口回调TaskMode: WaitForCustomCallback的任务步骤,表明当前任务执行成功。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ReportTaskSucceeded',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'StartExecution' => [
'summary' => '开始一个流程的执行。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '98867',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => '开始执行的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'formData',
'schema' => ['description' => '执行名称,在同一流程内唯一。取值说明如下:'."\n"
."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'my_exec_name'],
],
[
'name' => 'Input',
'in' => 'formData',
'schema' => ['description' => '执行的输入,为JSON对象格式。', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}'],
],
[
'name' => 'CallbackFnFTaskToken',
'in' => 'formData',
'schema' => ['description' => '流程执行结束后回调**TaskToken**相关任务。', 'type' => 'string', 'required' => false, 'example' => '12'],
],
[
'name' => 'Qualifier',
'in' => 'formData',
'schema' => ['title' => '指定流程版本或别名', 'description' => '指定流程版本或别名', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '执行状态。取值说明如下:'."\n"
.'- **Starting**'."\n"
.'- **Running**'."\n"
.'- **Stopped**'."\n"
.'- **Succeeded**'."\n"
.'- **Failed**'."\n"
.'- **TimedOut**', 'type' => 'string', 'example' => 'Succeeded'],
'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n"
."\n"
.'New version:'."\n"
.'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'],
'Output' => ['description' => '执行的输出,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'],
'Input' => ['description' => '执行的输入,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
['errorCode' => 'ExecutionAlreadyExists', 'errorMessage' => 'Execution %s for flow %s already exists.', 'description' => '对应流程下已存在同名执行。'],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Succeeded\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '异步调用开始一个流程的执行',
'description' => '## 接口说明'."\n"
.'- 流程必须已经存在,当前仅支持 Standard 执行模式的流程。'."\n"
.'- 如果没有指定执行名称,则服务会自动生成执行名称并开始执行。'."\n"
.'- 如果有同名执行正在进行,则不会开始新的执行,直接返回正在进行中的同名执行。'."\n"
.'- 如果同名执行已经结束(成功或者失败),则会返回`ExecutionAlreadyExists`。'."\n"
.'- 如果没有同名执行,则开始新的执行。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:StartExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'StartSyncExecution' => [
'summary' => '同步调用开始一个流程的执行。',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'high',
'chargeType' => 'paid',
'abilityTreeCode' => '195751',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => '开始执行的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'formData',
'schema' => ['description' => '执行名称。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。'."\n"
."\n"
.'不同于StartExecution接口,考虑到同步调用的特殊性,在同步执行模式下,不再要求执行名称在同一流程内唯一,调用侧可以选择提供执行名称,对本次执行进行标识,系统会在当前执行名称后添加UUID,具体形式如 {ExecutionName}:{UUID},如果用户没有指定相关的执行名称信息,那么系统会自动生成标识本次执行的ExecutionName。', 'type' => 'string', 'required' => false, 'example' => 'my_exec_name'],
],
[
'name' => 'Input',
'in' => 'formData',
'schema' => ['description' => '执行的输入,为JSON对象格式。', 'type' => 'string', 'required' => false, 'example' => '{"key":"value"}'],
],
[
'name' => 'Qualifier',
'in' => 'formData',
'schema' => ['title' => '指定流程版本或别名', 'description' => '指定流程版本或别名', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'Name' => ['description' => '流程执行名称。', 'type' => 'string', 'example' => 'my_exec_name:{UUID}'],
'Status' => ['description' => '执行状态。取值说明如下:'."\n"
.'- **Starting**'."\n"
.'- **Running**'."\n"
.'- **Stopped**'."\n"
.'- **Succeeded**'."\n"
.'- **Failed**'."\n"
.'- **TimedOut**', 'type' => 'string', 'example' => 'Succeeded'],
'ErrorCode' => ['description' => '执行错误时的错误码。', 'type' => 'string', 'example' => 'ActionNotSupported'],
'ErrorMessage' => ['description' => '执行超时。', 'type' => 'string', 'example' => 'Standard execution is not supported'],
'Output' => ['description' => '执行的输出,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'Environment' => [
'title' => 'Flow 执行时使用的环境变量列表',
'description' => 'Flow 执行时使用的环境变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行时使用的环境变量列表',
'description' => 'Flow 执行时使用的环境变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
['errorCode' => 'ExecutionAlreadyExists', 'errorMessage' => 'Execution %s for flow %s already exists.', 'description' => '对应流程下已存在同名执行。'],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation %s is incorrect. Please check.', 'description' => '所请求方法错误。请参照API文档并检查拼写。'],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version %s is not supported yet. Please check.', 'description' => '所请求接口版本不正确。请参考API简介。'],
],
403 => [
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources does not belong to you.', 'description' => '请求鉴权未通过,具体内容请参考实际错误信息。'],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name:{UUID}\\",\\n \\"Status\\": \\"Succeeded\\",\\n \\"ErrorCode\\": \\"ActionNotSupported\\",\\n \\"ErrorMessage\\": \\"Standard execution is not supported\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '同步调用开始一个流程的执行',
'description' => '- 仅支持 Express 执行模式的流程。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:StartSyncExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'StopExecution' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '98868',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => '需要停止的流程名称,可以通过**ListFlows**的返回值获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'formData',
'schema' => ['description' => '需要停止的执行名称,可以通过**ListExecutions**的返回值获取。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'],
],
[
'name' => 'Cause',
'in' => 'formData',
'schema' => ['description' => '停止错误原因。长度为1~4096个字符。', 'type' => 'string', 'required' => false, 'example' => 'for test'],
],
[
'name' => 'Error',
'in' => 'formData',
'schema' => ['description' => '停止错误代码。长度为1~128个字符。', 'type' => 'string', 'required' => false, 'example' => 'InvalidArgument'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '执行状态。取值说明如下:'."\n"
.'- **Starting**'."\n"
.'- **Running**'."\n"
.'- **Stopped**'."\n"
.'- **Succeeded**'."\n"
.'- **Failed**'."\n"
.'- **TimedOut**', 'type' => 'string', 'example' => 'Running'],
'StoppedTime' => ['description' => '执行停止时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'StartedTime' => ['description' => '执行开始时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'FlowDefinition' => ['description' => '执行的流程定义。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n"
."\n"
.'New version:'."\n"
.'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'],
'Output' => ['description' => '执行的输出,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'FlowName' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'Name' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'],
'Input' => ['description' => '执行的输入,为JSON对象格式。', 'type' => 'string', 'example' => '{"key":"value"}'],
'RoleArn' => ['description' => '执行的角色权限配置。若流程定义中的RoleArn在执行期间发生变更,系统将记录并返回执行初始时刻的RoleArn的快照。'."\n"
.'> 如果您的流程在执行时未配置执行角色,则该字段不会出现。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
['errorCode' => 'ExecutionAlreadyCompleted', 'errorMessage' => 'Execution \'%s\' for flow \'%s\' has already completed.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
[
['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建并存在待查询的执行。'],
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
409 => [
['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => '所请求资源存在并发写操作。请等待一段时间后再次操作。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"Running\\",\\n \\"StoppedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"StartedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"FlowDefinition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"Output\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"Name\\": \\"my_exec_name\\",\\n \\"Input\\": \\"{\\\\\\"key\\\\\\":\\\\\\"value\\\\\\"}\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\"\\n}","errorExample":""},{"type":"xml","example":"<StopExecutionResponse>\\n <Status>Running</Status>\\n <StoppedTime>2019-01-01T01:01:01.001Z</StoppedTime>\\n <RequestId>testRequestId</RequestId>\\n <StartedTime>2019-01-01T01:01:01.001Z</StartedTime>\\n <FlowDefinition>version: v1.0\\\\ntype: flow\\\\nname: test\\\\nsteps:\\\\n - type: pass\\\\n name: mypass</FlowDefinition>\\n <Output>{\\"key\\":\\"value\\"}</Output>\\n <FlowName>flow</FlowName>\\n <Name>exec</Name>\\n <Input>{\\"key\\":\\"value\\"}</Input>\\n</StopExecutionResponse>","errorExample":""}]',
'title' => '停止一个正在执行的流程',
'summary' => '停止一个正在执行的流程。',
'description' => '## 接口说明'."\n"
.'流程必须为执行中。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:StopExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'UpdateFlow' => [
'summary' => '更新一个流程的内容。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '98869',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '已创建的流程名称。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'Definition',
'in' => 'formData',
'schema' => ['description' => '流程定义,遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容,当系统支持两种规范的流程定义规范。'."\n"
.'> '."\n"
.'> 以上流程定义示例中Name:my_flow_name是指流程名称,需和入参Name保持一致', 'type' => 'string', 'required' => false, 'example' => 'Legacy version:'."\n"
.'"'."\n"
.'type: flow'."\n"
.'version: v1'."\n"
.'name: my_flow_name'."\n"
.'steps:'."\n"
.' - type: pass'."\n"
.' name: mypass'."\n"
.'"'."\n"
."\n"
.'New version:'."\n"
.'"'."\n"
.'Type: StateMachine'."\n"
.'SpecVersion: v1'."\n"
.'Name: my_flow_name'."\n"
.'StartAt: my_state'."\n"
.'States:'."\n"
.' - Type: Pass'."\n"
.' Name: my_state'."\n"
.' End: true'."\n"
.'"'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '流程描述。', 'type' => 'string', 'required' => false, 'example' => 'my test flow'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '流程类型,取值:**FDL**。', 'type' => 'string', 'required' => false, 'example' => 'FDL'],
],
[
'name' => 'RoleArn',
'in' => 'formData',
'schema' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时,流程执行引擎扮演该角色(AssumeRole)调用相关的流程资源API。', 'type' => 'string', 'required' => false, 'example' => 'acs:ram:${region}:${accountID}:${role}'],
],
[
'name' => 'Environment',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '配置 Flow 执行期间可以访问的变量列表',
'description' => '配置 Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => '配置 Flow 执行期间可以访问的变量列表',
'description' => '配置 Flow 执行期间可以访问的变量列表',
'type' => 'array',
'items' => [
'title' => '配置 Flow 执行期间可以访问的变量列表',
'description' => '配置 Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'required' => false, 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'required' => false, 'example' => 'value'],
'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'required' => false, 'example' => 'description'],
],
'required' => false,
],
'required' => false,
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '流程类型。', 'type' => 'string', 'example' => 'FDL'],
'Definition' => ['description' => '流程定义,遵循Flow Definition Language (FDL)语法标准。考虑到向前兼容,当系统支持两种规范的流程定义规范。', 'type' => 'string', 'example' => 'Legacy version:'."\n"
.'"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass"'."\n"
."\n"
.'New version:'."\n"
.'"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true"'],
'RoleArn' => ['description' => '流程执行依赖的授权角色资源描述符信息。用于在执行流程时,流程执行引擎扮演该角色(AssumeRole)调用相关的流程资源API。', 'type' => 'string', 'example' => 'acs:ram:${region}:${accountID}:${role}'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestID'],
'Description' => ['description' => '流程描述。', 'type' => 'string', 'example' => 'my test flow'],
'ExternalStorageLocation' => ['description' => '外部存储位置。', 'type' => 'string', 'example' => '/path'],
'Name' => ['description' => '流程名称。', 'type' => 'string', 'example' => 'my_flow_name'],
'CreatedTime' => ['description' => '流程创建时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '流程最近一次的更改时间。', 'type' => 'string', 'example' => '2019-01-01T01:01:01.001Z'],
'Id' => ['description' => '流程的唯一ID。', 'type' => 'string', 'example' => 'e589e092-e2c0-4dee-b306-3574ddfdddf5****'],
'Environment' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Variables' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'array',
'items' => [
'title' => 'Flow 执行期间可以访问的变量列表',
'description' => 'Flow 执行期间可以访问的变量列表',
'type' => 'object',
'properties' => [
'Name' => ['title' => '变量名称', 'description' => '变量名称', 'type' => 'string', 'example' => 'key'],
'Value' => ['title' => '变量值', 'description' => '变量值', 'type' => 'string', 'example' => 'value'],
'Description' => ['title' => '变量描述', 'description' => '变量描述', 'type' => 'string', 'example' => 'description'],
],
],
],
],
],
'ResourceGroupId' => ['title' => '资源组id', 'type' => 'string', 'example' => 'rg-xxx'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
409 => [
['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => '所请求资源存在并发写操作。请等待一段时间后再次操作。'],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"FDL\\",\\n \\"Definition\\": \\"Legacy version:\\\\n\\\\\\"type: flow\\\\\\\\nversion: v1\\\\\\\\nname: my_flow_name\\\\\\\\nsteps:\\\\\\\\n - type: pass\\\\\\\\n name: mypass\\\\\\"\\\\n\\\\nNew version:\\\\n\\\\\\"Type: StateMachine\\\\\\\\nSpecVersion: v1\\\\\\\\nName: my_flow_name\\\\\\\\nStartAt: my_state\\\\\\\\nStates:\\\\\\\\n - Type: Pass\\\\\\\\n Name: my_state\\\\\\\\n End: true\\\\\\"\\",\\n \\"RoleArn\\": \\"acs:ram:${region}:${accountID}:${role}\\",\\n \\"RequestId\\": \\"testRequestID\\",\\n \\"Description\\": \\"my test flow\\",\\n \\"ExternalStorageLocation\\": \\"/path\\",\\n \\"Name\\": \\"my_flow_name\\",\\n \\"CreatedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2019-01-01T01:01:01.001Z\\",\\n \\"Id\\": \\"e589e092-e2c0-4dee-b306-3574ddfdddf5****\\",\\n \\"Environment\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"Description\\": \\"description\\"\\n }\\n ]\\n },\\n \\"ResourceGroupId\\": \\"rg-xxx\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '更新一个已有流程',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:UpdateFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'UpdateFlowAlias' => [
'summary' => '更新流程版本别名配置',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREfnf8CPMA5'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['title' => '流程名称', 'description' => '流程名称', 'type' => 'string', 'required' => true, 'example' => 'example-flow-name'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'required' => true, 'example' => 'alias name'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'required' => false, 'example' => 'example description'],
],
[
'name' => 'RoutingConfigurations',
'in' => 'formData',
'style' => 'json',
'schema' => [
'title' => '权重配置',
'description' => '权重配置',
'type' => 'array',
'items' => [
'description' => '流量分发配置,支持配置一个或两个流程版本。当指定别名发起执行时,系统会根据权重选择对应的流程版本进行执行。',
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'required' => false, 'example' => '1'],
'Weight' => ['description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
'required' => false,
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '294D68C1-5108-5971-853A-1A9CC87B4816'],
'Alias' => [
'title' => '别名信息',
'description' => '别名信息',
'type' => 'object',
'properties' => [
'Name' => ['title' => '别名名称', 'description' => '别名名称', 'type' => 'string', 'example' => 'my-alias-name'],
'Description' => ['title' => '别名描述', 'description' => '别名描述', 'type' => 'string', 'example' => 'my alias description'],
'RoutingConfigurations' => [
'title' => '权重配置',
'description' => '权重配置',
'type' => 'array',
'items' => [
'description' => '流量分发配置,支持配置一个或两个流程版本。当指定别名发起执行时,系统会根据权重选择对应的流程版本进行执行。',
'type' => 'object',
'properties' => [
'Version' => ['title' => '版本', 'description' => '版本', 'type' => 'string', 'example' => '1'],
'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
'CreatedTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-10-24T14:11:26+08:00'],
],
],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新流程别名配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"294D68C1-5108-5971-853A-1A9CC87B4816\\",\\n \\"Alias\\": {\\n \\"Name\\": \\"my-alias-name\\",\\n \\"Description\\": \\"my alias description\\",\\n \\"RoutingConfigurations\\": [\\n {\\n \\"Version\\": \\"1\\",\\n \\"Weight\\": 20\\n }\\n ],\\n \\"CreatedTime\\": \\"2025-10-24T14:11:26+08:00\\"\\n }\\n}","type":"json"}]',
],
'UpdateMapRun' => [
'summary' => '更新 MapRun 配置',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227533',
'abilityTreeNodes' => ['FEATUREfnfR0JC2A'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'RequestId',
'in' => 'query',
'schema' => ['description' => '请求ID。', 'type' => 'string', 'required' => false, 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
],
[
'name' => 'FlowName',
'in' => 'query',
'schema' => ['description' => '流程名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ExecutionName',
'in' => 'query',
'schema' => ['description' => '执行名称', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_exec_name'],
],
[
'name' => 'MapRunName',
'in' => 'query',
'schema' => ['description' => 'MapRun 名称,当 Execution 中发起 MapRun 执行后,会产生 MapRunStarted 事件,MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', 'type' => 'string', 'required' => true, 'example' => 'c39142f1345b196d678333c41f113100'],
],
[
'name' => 'Concurrency',
'in' => 'query',
'schema' => ['description' => 'MapRun 运行时的并发限制。单账户配额默认最大300,可以通过配额中心提升。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'ToleratedFailedCount',
'in' => 'query',
'schema' => ['description' => '允许失败的 Item 数量的最大值', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
'name' => 'ToleratedFailedPercentage',
'in' => 'query',
'schema' => ['description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比。取值区间为 0 - 100。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3A44E113-9962-5B0B-AB92-14060EFE3164'],
'FlowName' => ['description' => '流程名称', 'type' => 'string', 'example' => 'my_flow_name'],
'ExecutionName' => ['description' => '执行名称。', 'type' => 'string', 'example' => 'my_exec_name'],
'MapRunName' => ['description' => 'MapRun 名称,当 Execution 中发起 MapRun 执行后,会产生 MapRunStarted 事件,MapRunName 可以从 MapRunStarted 事件的 Output 中获取。', 'type' => 'string', 'example' => 'c39142f1345b196d678333c41f113000'],
'Concurrency' => ['description' => 'MapRun 运行时的并发限制。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ToleratedFailedCount' => ['description' => '允许失败的 Item 数量的最大值', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'ToleratedFailedPercentage' => ['description' => '允许失败的 Item 数量占全部 Item 数量的最大百分比', 'type' => 'number', 'format' => 'float', 'example' => '20'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['errorCode' => 'ActionNotSupported', 'errorMessage' => 'The requested API operation \'%s\' is incorrect. Please check.', 'description' => ''],
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'EntityTooLarge', 'errorMessage' => 'The payload size exceeds maximum allowed size (%s bytes).', 'description' => '请求消息体过大。'],
],
403 => [
['errorCode' => 'InvalidAccessKeyID', 'errorMessage' => 'The AccessKey ID %s is invalid.', 'description' => 'AccessKey ID无效。'],
['errorCode' => 'RequestTimeTooSkewed', 'errorMessage' => 'The difference between the request time %s and the current time %s is too large.', 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['errorCode' => 'SignatureNotMatch', 'errorMessage' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'ExecutionNotExists', 'errorMessage' => 'Execution %s for flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建并存在待查询的执行。'],
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => '所请求资源不存在,请确保流程已创建。'],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
],
415 => [
['errorCode' => 'UnsupportedMediaType', 'errorMessage' => 'The content type must be "application/json".', 'description' => '请求消息体类型错误。'],
],
429 => [
['errorCode' => 'ResourceThrottled', 'errorMessage' => 'The request is throttled. Please try again later.', 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => '服务器内部错误。请稍后重试。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '更新 MapRun 执行配置',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3A44E113-9962-5B0B-AB92-14060EFE3164\\",\\n \\"FlowName\\": \\"my_flow_name\\",\\n \\"ExecutionName\\": \\"my_exec_name\\",\\n \\"MapRunName\\": \\"c39142f1345b196d678333c41f113000\\",\\n \\"Concurrency\\": 1,\\n \\"ToleratedFailedCount\\": 100,\\n \\"ToleratedFailedPercentage\\": 20\\n}","type":"json"}]',
],
'UpdateSchedule' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '98870',
'abilityTreeNodes' => ['FEATUREfnf06LH4G'],
],
'parameters' => [
[
'name' => 'FlowName',
'in' => 'formData',
'schema' => ['description' => '定时调度绑定的流程名称。该名称在同一地域内唯一,创建后不可修改。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_flow_name'],
],
[
'name' => 'ScheduleName',
'in' => 'formData',
'schema' => ['description' => '定时调度的名称。取值说明如下:'."\n"
."\n"
.'- 支持英文字符(a~z)或(A~Z)、数字(0~9)、下划线(_)和短划线(-)。'."\n"
.'- 首字母必须为英文字母(a~z)、(A~Z)或下划线(_)。'."\n"
.'- 区分大小写。'."\n"
.'- 长度为1~128个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'my_schedule_name'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => '定时调度的描述。', 'type' => 'string', 'required' => false, 'example' => 'my test schedule'],
],
[
'name' => 'Payload',
'in' => 'formData',
'schema' => ['description' => '定时调度的触发消息,必须为JSON格式。', 'type' => 'string', 'required' => false, 'example' => '{"key": "value"}'],
],
[
'name' => 'CronExpression',
'in' => 'formData',
'schema' => ['description' => 'Cron表达式。', 'type' => 'string', 'required' => false, 'example' => '0 * * * * *'],
],
[
'name' => 'Enable',
'in' => 'formData',
'schema' => ['description' => '是否启用定时调度。取值说明如下:'."\n"
.'- **true**:启用。'."\n"
.'- **false**:禁用。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'testRequestId'],
'Description' => ['description' => '定时调度的描述。', 'type' => 'string', 'example' => 'my test schedule'],
'ScheduleId' => ['description' => '定时调度的ID。', 'type' => 'string', 'example' => 'testScheduleId'],
'Payload' => ['description' => '定时调度的触发消息。', 'type' => 'string', 'example' => '{"key": "value"}'],
'ScheduleName' => ['description' => '定时调度的名称。', 'type' => 'string', 'example' => 'my_schedule_name'],
'CreatedTime' => ['description' => '定时调度的创建时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'LastModifiedTime' => ['description' => '定时调度最近一次的更新时间。', 'type' => 'string', 'example' => '2020-01-01T01:01:01.001Z'],
'CronExpression' => ['description' => 'Cron表达式。', 'type' => 'string', 'example' => '0 * * * * *'],
'Enable' => ['description' => '是否启用定时调度。取值说明如下:'."\n"
.'- **true**:启用。'."\n"
.'- **false**:禁用。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'APIVersionNotSupported', 'errorMessage' => 'The requested API version \'%s\' is not supported yet. Please check.', 'description' => ''],
['errorCode' => 'InvalidArgument', 'errorMessage' => 'Parameter error.', 'description' => ''],
['errorCode' => 'MissingRequiredHeader', 'errorMessage' => 'The HTTP header \'%s\' must be specified.', 'description' => ''],
['errorCode' => 'MissingRequiredParams', 'errorMessage' => 'The HTTP query \'%s\' must be specified.', 'description' => ''],
],
403 => [
['errorCode' => 'AccessDenied', 'errorMessage' => 'The resources doesn\'t belong to you.', 'description' => ''],
],
[
['errorCode' => 'FlowNotExists', 'errorMessage' => 'Flow %s does not exist.', 'description' => ''],
['errorCode' => 'ScheduleNotExists', 'errorMessage' => 'The schedule %s for flow %s does not exist.', 'description' => ''],
],
409 => [
['errorCode' => 'ConcurrentUpdateError', 'errorMessage' => 'Update conflict, please retry.', 'description' => ''],
],
412 => [
['errorCode' => 'PreconditionFailed', 'errorMessage' => 'The resource to be modified has been changed.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalServerError', 'errorMessage' => 'An internal error has occurred. Please retry.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"testRequestId\\",\\n \\"Description\\": \\"my test schedule\\",\\n \\"ScheduleId\\": \\"testScheduleId\\",\\n \\"Payload\\": \\"{\\\\\\"key\\\\\\": \\\\\\"value\\\\\\"}\\",\\n \\"ScheduleName\\": \\"my_schedule_name\\",\\n \\"CreatedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"LastModifiedTime\\": \\"2020-01-01T01:01:01.001Z\\",\\n \\"CronExpression\\": \\"0 * * * * *\\",\\n \\"Enable\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]',
'title' => '更新一个定时调度(仅适用于旧版工作流)',
'summary' => '更新一个定时调度。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:UpdateSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'ap-southeast-1.fnf.aliyuncs.com', 'endpoint' => 'ap-southeast-1.fnf.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-beijing.fnf.aliyuncs.com', 'endpoint' => 'cn-beijing.fnf.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-hangzhou.fnf.aliyuncs.com', 'endpoint' => 'cn-hangzhou.fnf.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-qingdao.fnf.aliyuncs.com', 'endpoint' => 'cn-qingdao.fnf.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-shanghai.fnf.aliyuncs.com', 'endpoint' => 'cn-shanghai.fnf.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'cn-shenzhen.fnf.aliyuncs.com', 'endpoint' => 'cn-shenzhen.fnf.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'us-west-1.fnf.aliyuncs.com', 'endpoint' => 'us-west-1.fnf.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'AccessDenied', 'message' => 'The resources does not belong to you.', 'http_code' => 403, 'description' => '请求鉴权未通过,具体内容请参考实际错误信息。'],
['code' => 'ActionNotSupported', 'message' => 'The requested API operation %s is incorrect. Please check.', 'http_code' => 400, 'description' => '所请求方法错误。请参照API文档并检查拼写。'],
['code' => 'APIVersionNotSupported', 'message' => 'The requested API version %s is not supported yet. Please check.', 'http_code' => 400, 'description' => '所请求接口版本不正确。请参考API简介。'],
['code' => 'ConcurrentUpdateError', 'message' => 'Update conflict, please retry.', 'http_code' => 409, 'description' => '所请求资源存在并发写操作。请等待一段时间后再次操作。'],
['code' => 'EntityTooLarge', 'message' => 'The payload size exceeds maximum allowed size (%s bytes).', 'http_code' => 400, 'description' => '请求消息体过大。'],
['code' => 'ExecutionAlreadyCompleted', 'message' => 'Execution %s for flow %s has already completed.', 'http_code' => 400, 'description' => '该执行已处于中止状态。'],
['code' => 'ExecutionAlreadyExists', 'message' => 'Execution %s for flow %s already exists.', 'http_code' => 400, 'description' => '对应流程下已存在同名执行。'],
['code' => 'ExecutionNotExists', 'message' => 'Execution %s for flow %s does not exist.', 'http_code' => 404, 'description' => '所请求资源不存在,请确保流程已创建并存在待查询的执行。'],
['code' => 'FlowAlreadyExists', 'message' => 'Flow %s already exists.', 'http_code' => 409, 'description' => '已存在同名流程。'],
['code' => 'FlowNotEmpty', 'message' => 'The flow %s has schedules. Please delete all its schedules before deleting the flow.', 'http_code' => 409, 'description' => '删除工作流之前,请先删除工作流绑定的调度器。'],
['code' => 'FlowNotExists', 'message' => 'Flow %s does not exist.', 'http_code' => 404, 'description' => '所请求资源不存在,请确保流程已创建。'],
['code' => 'InternalServerError', 'message' => 'An internal error has occurred. Please retry.', 'http_code' => 500, 'description' => '服务器内部错误。请稍后重试。'],
['code' => 'InvalidAccessKeyID', 'message' => 'The AccessKey ID %s is invalid.', 'http_code' => 403, 'description' => 'AccessKey ID无效。'],
['code' => 'InvalidArgument', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => '请求参数错误。具体内容请参考实际错误信息。'],
['code' => 'MissingRequiredHeader', 'message' => 'The HTTP header \'%s\' must be specified.', 'http_code' => 400, 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['code' => 'MissingRequiredParams', 'message' => 'The HTTP query \'%s\' must be specified.', 'http_code' => 400, 'description' => '请求所需参数缺失。具体内容请参考实际错误信息。'],
['code' => 'PreconditionFailed', 'message' => 'The resource to be modified has been changed.', 'http_code' => 412, 'description' => '资源查看或更新检查失败,该资源可能已被更改。请稍后重试。'],
['code' => 'RequestTimeTooSkewed', 'message' => 'The difference between the request time %s and the current time %s is too large.', 'http_code' => 403, 'description' => '您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。'],
['code' => 'ResourceThrottled', 'message' => 'The request is throttled. Please try again later.', 'http_code' => 429, 'description' => '因某些原因系统流量已达瓶颈。请稍后重试。'],
['code' => 'ScheduleAlreadyExists', 'message' => 'The schedule %s already exists in flow %s.', 'http_code' => 409, 'description' => '定时调度已存在。'],
['code' => 'ScheduleNotExists', 'message' => 'The schedule %s for flow %s does not exist.', 'http_code' => 404, 'description' => '定时调度不存在。'],
['code' => 'SignatureNotMatch', 'message' => 'The request signature we calculated does not match the signature you provided. Check your access key and signing method.', 'http_code' => 403, 'description' => '您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。'],
['code' => 'TaskAlreadyCompleted', 'message' => 'Task %s has already completed.', 'http_code' => 400, 'description' => '指定任务已经完成。'],
['code' => 'TaskInvalidState', 'message' => 'Task is in an invalid state, please retry.', 'http_code' => 409, 'description' => '任务目前在无效的状态,请稍后重试。'],
['code' => 'UnsupportedMediaType', 'message' => 'The content type must be "application/json".', 'http_code' => 415, 'description' => '请求消息体类型错误。'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
],
],
'ram' => [
'productCode' => 'FnF',
'productName' => '云工作流',
'ramCodes' => ['fnf'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'StartSyncExecution',
'description' => '同步调用开始一个流程的执行',
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:StartSyncExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteFlow',
'description' => '删除一个已存在的流程',
'operationType' => 'delete',
'ramAction' => [
'action' => 'fnf:DeleteFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeExecution',
'description' => '获取一次执行的状态信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:DescribeExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSchedule',
'description' => '创建一个定时调度(仅适用于旧版工作流)',
'operationType' => 'create',
'ramAction' => [
'action' => 'fnf:CreateSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateFlow',
'description' => '创建一个流程',
'operationType' => 'create',
'ramAction' => [
'action' => 'fnf:CreateFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'],
],
],
],
[
'apiName' => 'DescribeSchedule',
'description' => '获取一个定时调度(仅适用于旧版工作流)',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:DescribeSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateSchedule',
'description' => '更新一个定时调度(仅适用于旧版工作流)',
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:UpdateSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ReportTaskFailed',
'description' => '汇报指定的任务执行失败',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ReportTaskFailed',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StartExecution',
'description' => '异步调用开始一个流程的执行',
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:StartExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateFlow',
'description' => '更新一个已有流程',
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:UpdateFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSchedule',
'description' => '删除一个定时调度(仅适用于旧版工作流)',
'operationType' => 'delete',
'ramAction' => [
'action' => 'fnf:DeleteSchedule',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ReportTaskSucceeded',
'description' => '汇报指定的任务执行成功',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ReportTaskSucceeded',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListExecutions',
'description' => '获取一个流程的历史执行',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ListExecutions',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetExecutionHistory',
'description' => '获取一次执行的步骤详情',
'operationType' => 'create',
'ramAction' => [
'action' => 'fnf:GetExecutionHistory',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopExecution',
'description' => '停止一个正在执行的流程',
'operationType' => 'update',
'ramAction' => [
'action' => 'fnf:StopExecution',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListSchedules',
'description' => '获取定时调度列表(仅适用于旧版工作流)',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ListSchedules',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeFlow',
'description' => '获取一个流程的相关信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:DescribeFlow',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListFlows',
'description' => '批量查询流程信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'fnf:ListFlows',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'FnF', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}'],
['validationType' => 'always', 'resourceType' => 'Execution', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/execution/{#ExecutionName}'],
['validationType' => 'always', 'resourceType' => 'Schedule', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/schedule/*'],
['validationType' => 'always', 'resourceType' => 'Flow', 'arn' => 'acs:fnf:{#regionId}:{#accountId}:flow/*'],
['validationType' => 'always', 'resourceType' => 'Schedule', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/schedule/{#ScheduleName}'],
['validationType' => 'always', 'resourceType' => 'Execution', 'arn' => 'acs:fnf:*:{#accountId}:flow/{#FlowName}/execution/*'],
],
],
];
|