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
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'sophonsoar', 'version' => '2022-07-28'],
'directories' => [
[
'children' => [
'BatchModifyInstanceStatus', 'RunPython3Script', 'ComparePlaybooks', 'CreatePlaybook', 'DebugPlaybook', 'DeleteComponentAsset', 'DeletePlaybook', 'DescribeComponentAssetForm', 'DescribeComponentAssets', 'DescribeComponentList', 'DescribeComponentPlaybook', 'DescribeComponentsJs', 'DescribeDistinctReleases', 'DescribeEnumItems', 'DescribeExecutePlaybooks', 'DescribeField', 'DescribeLatestRecordSchema', 'DescribeNodeParamTags', 'DescribeNodeUsedInfos', 'DescribePlaybook',
'DescribePlaybookInputOutput', 'DescribePlaybookMetrics', 'DescribePlaybookNodesOutput', 'DescribePlaybookNumberMetrics', 'DescribePlaybookReleases', 'DescribePlaybooks', 'DescribePopApi', 'DescribeSoarRecordActionOutputList', 'DescribeSoarRecordInOutput', 'DescribeSoarRecords', 'DescribeSoarTaskAndActions', 'DescriberPython3ScriptLogs', 'ModifyComponentAsset', 'ModifyPlaybook', 'ModifyPlaybookInputOutput', 'ModifyPlaybookInstanceStatus', 'PublishPlaybook', 'QueryTreeData', 'RevertPlaybookRelease', 'TriggerPlaybook',
'TriggerSophonPlaybook', 'VerifyPlaybook', 'VerifyPythonFile',
],
'type' => 'directory',
'title' => 'Playbook orchestration',
],
[
'children' => ['DescribeProcessStatistics', 'DescribeProcessTasks', 'DescribeProcessTaskCount', 'DescribeSophonCommands', 'TriggerProcessTask'],
'type' => 'directory',
'title' => 'Remediation tasks',
],
[
'children' => ['DescribeOpenApiList', 'DescribeGroupProductions', 'RunNotifyComponentWithEmail', 'RunNotifyComponentWithMessageCenter', 'RunNotifyComponentWithWebhook', 'ConvertPlaybook', 'CopyPlaybook', 'DescribeNotifyTemplateList', 'DescribeOpenApiInfo', 'DescribeVendorApiList'],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'BatchModifyInstanceStatus' => [
'summary' => 'Enables or disables a batch of playbooks.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The UUID of the playbook. To modify multiple playbooks, separate the UUIDs with commas.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,s8df2e-s8dfs-xxxx'],
],
[
'name' => 'Active',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The status to set for the playbook. Valid values:'."\n"
."\n"
.'- **0**: Disables the playbook.'."\n"
."\n"
.'- **1**: Enables the playbook.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9ED0-A1A361CDE615\\"\\n}","type":"json"}]',
'title' => 'BatchModifyInstanceStatus',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'ComparePlaybooks' => [
'summary' => 'Compares the configurations of two published playbook versions.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f916b93e-e814-459f-9662-xxxxx'],
],
[
'name' => 'OldPlaybookReleaseId',
'in' => 'query',
'schema' => ['description' => 'The UUID of the first published version for comparison.'."\n"
."\n"
.'> To obtain the UUID of a historical version, call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation. The system automatically generates a UUID for a new version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => 'sflk23423-e814-459f-9662-xxxxx'],
],
[
'name' => 'NewPlaybookReleaseId',
'in' => 'query',
'schema' => ['description' => 'The UUID of the second published version for comparison.'."\n"
."\n"
.'> To obtain the UUID of a historical version, call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation. The system automatically generates a UUID for a new version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => 'sfdf2395-e814-459f-9662-xxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<CompareResult>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A'],
'CompareResult' => [
'title' => '',
'description' => 'The result of the comparison.',
'type' => 'object',
'properties' => [
'Same' => ['description' => 'Indicates whether the two versions are identical.'."\n"
."\n"
.'- **true**: Identical.'."\n"
."\n"
.'- **false**: Not identical.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'New' => ['description' => 'Indicates whether the second version used for comparison is a new version.'."\n"
."\n"
.'- **true**: The version is new.'."\n"
."\n"
.'- **false**: The version is not new.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Description' => ['description' => 'The description of the comparison result.', 'type' => 'string', 'example' => 'The first version adds one node compared to the second version', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"CompareResult\\": {\\n \\"Same\\": false,\\n \\"New\\": true,\\n \\"Description\\": \\"The first version adds one node compared to the second version\\"\\n }\\n}","type":"json"}]',
'title' => 'ComparePlaybooks',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ComparePlaybooks'],
],
],
'ramActions' => [],
],
'ConvertPlaybook' => [
'summary' => 'Convert XML configuration.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '208668',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Taskflow',
'in' => 'formData',
'schema' => ['title' => '剧本编辑配置', 'description' => 'XML configuration information for playbook orchestration.', 'type' => 'string', 'required' => true, 'example' => '<?xml version=\\"1.0\\" encoding=\\"UTF-8\\"?>'."\n"
.'<bpmn:definitions xmlns:xsi=\\"http://www.w3.org/2001/XMLSchema-instance\\" xmlns:bpmn=\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\" xmlns:bpmndi=\\"http://www.omg.org/spec/BPMN/20100524/DI\\" xmlns:dc=\\"http://www.omg.org/spec/DD/20100524/DC\\" id=\\"Definitions_1\\" targetNamespace=\\"http://bpmn.io/schema/bpmn\\">'."\n"
.' <bpmn:process id=\\"Process_1\\" isExecutable=\\"false\\">'."\n"
.' <bpmn:startEvent id=\\"StartEvent_1\\" />'."\n"
.' </bpmn:process>'."\n"
.' <bpmndi:BPMNDiagram id=\\"BPMNDiagram_1\\">'."\n"
.' <bpmndi:BPMNPlane id=\\"BPMNPlane_1\\" bpmnElement=\\"Process_1\\">'."\n"
.' <bpmndi:BPMNShape id=\\"_BPMNShape_StartEvent_2\\" bpmnElement=\\"StartEvent_1\\">'."\n"
.' <dc:Bounds x=\\"173\\" y=\\"102\\" width=\\"36\\" height=\\"36\\" />'."\n"
.' </bpmndi:BPMNShape>'."\n"
.' </bpmndi:BPMNPlane>'."\n"
.' </bpmndi:BPMNDiagram>'."\n"
.'</bpmn:definitions>'."\n"
.' '],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'Language type for request and response messages. Values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'View type. Values:'."\n"
."\n"
.'- 0: Current Alibaba Cloud account view.'."\n"
.'- 1: View for all accounts under the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'User ID for the administrator to switch to another member\'s perspective.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13760*****718726', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'SophonResult<String>',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for this request, and can be used for troubleshooting and problem localization.', 'type' => 'string', 'example' => '39C38A34-****-*****-****-7263B435C316'],
'Config' => ['title' => '传输的数据', 'description' => 'The configurations.', 'type' => 'string', 'example' => '{}'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-****-*****-****-7263B435C316\\",\\n \\"Config\\": \\"{}\\"\\n}","type":"json"}]',
'title' => 'Convert Playbook Flowchart Configuration Format',
'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the orchestration product before using this interface.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:ConvertPlaybook',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'],
],
],
],
'CopyPlaybook' => [
'summary' => 'Copies a playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '218814',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The display name of the playbook.'."\n", 'type' => 'string', 'required' => true, 'example' => 'playbook_xxx'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The description of the playbook.'."\n", 'type' => 'string', 'required' => false, 'example' => 'playbook description'],
],
[
'name' => 'SourcePlaybookUuid',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The UUID of the playbook that you want to copy.'."\n"
."\n"
.'> You can call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to query the UUIDs of playbooks.'."\n", 'type' => 'string', 'required' => true, 'example' => '94bc318c-****-4cba-****-801ccb0d739f'],
],
[
'name' => 'ReleaseVersion',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The release version of the playbook that you want to copy. Default value: 0. Valid values:'."\n"
."\n"
.'* \\-1: The version that is being edited.'."\n"
.'* 0: The latest online version of the current playbook.'."\n", 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the request and the response. Valid values:'."\n"
."\n"
.'* **zh**: Chinese (default).'."\n"
.'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The type of the view. Valid values:'."\n"
."\n"
.'* **0** (default): the view of the current account.'."\n"
.'* **1**: the view of the global account.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602*****718726', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookCloudDTO>',
'description' => 'SophonResult'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2EC05B06-****-5F3E-****-3B1FAD76087A'],
'Data' => [
'title' => '',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'DisplayName' => ['title' => '', 'description' => 'The name of the new playbook.'."\n", 'type' => 'string', 'example' => '11111'],
'PlaybookUuid' => ['title' => '', 'description' => 'The UUID of the new playbook.'."\n", 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'],
'OwnType' => ['title' => '', 'description' => 'The type of the playbook. Valid values:'."\n"
."\n"
.'* preset: predefined playbook.'."\n"
.'* user: custom playbook.'."\n", 'type' => 'string', 'example' => 'user'],
'Active' => ['title' => '', 'description' => 'The status of the playbook. Valid values:'."\n"
."\n"
.'* 1: enabled.'."\n"
.'* 0: disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'LastRuntime' => ['title' => '', 'description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1725258397847'],
'Permission' => ['title' => '', 'description' => 'The permission to operate the playbook. Valid values:'."\n"
."\n"
.'* 1: view.'."\n"
.'* 2: edit.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'GmtCreate' => ['title' => '', 'description' => 'The time when the playbook was created. The value is a 13-digit timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1655951601000'],
'GmtModified' => ['title' => '', 'description' => 'The time when the playbook was modified. The value is a 13-digit timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1638270967000'],
'HistoryMd5' => ['title' => '', 'description' => 'The number of historical versions of the playbook.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SuccNum' => ['title' => '', 'description' => 'The number of successful playbook executions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'FailNum' => ['title' => '', 'description' => 'The number of playbook execution failures.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'FailRate' => ['title' => '', 'description' => 'The failure rate of playbook execution.'."\n", 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'InputParams' => ['title' => '', 'description' => 'The input parameters of the playbook.'."\n", 'type' => 'string', 'example' => '[{\\"name\\":\\"1\\",\\"dataType\\":\\"String\\",\\"required\\":false,\\"isArray\\":false,\\"example\\":\\"\\",\\"description\\":\\"\\",\\"id\\":0,\\"typeName\\":\\"String\\",\\"dataClass\\":\\"normal\\"}]'],
'OutputParams' => ['title' => '', 'description' => 'The output parameters of the playbook.'."\n", 'type' => 'string', 'example' => '[]'],
'Description' => ['title' => '', 'description' => 'The description of the playbook.'."\n", 'type' => 'string', 'example' => 'This is a action of processing for WAF'],
'LogicReleaseTaskflowMd5' => ['title' => '', 'description' => 'The online version MD5 of the playbook.'."\n", 'type' => 'string', 'example' => '037046****1b00c4717963818ccbf2xx'],
'PlaybookStatus' => ['title' => '', 'description' => 'The status of the playbook.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TenantId' => ['title' => '', 'description' => 'The ID of the user to which the playbook belongs.'."\n", 'type' => 'string', 'example' => '13760*****8718726'],
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.'."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CopyPlaybook',
'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'yundun-sas:CopyPlaybook',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2EC05B06-****-5F3E-****-3B1FAD76087A\\",\\n \\"Data\\": {\\n \\"DisplayName\\": \\"11111\\",\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1725258397847,\\n \\"Permission\\": 1,\\n \\"GmtCreate\\": 1655951601000,\\n \\"GmtModified\\": 1638270967000,\\n \\"HistoryMd5\\": 1,\\n \\"SuccNum\\": 1,\\n \\"FailNum\\": 1,\\n \\"FailRate\\": 0.5,\\n \\"InputParams\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"required\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"isArray\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"example\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"typeName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"String\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"dataClass\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"normal\\\\\\\\\\\\\\"}]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"Description\\": \\"This is a action of processing for WAF\\",\\n \\"LogicReleaseTaskflowMd5\\": \\"037046****1b00c4717963818ccbf2xx\\",\\n \\"PlaybookStatus\\": 1,\\n \\"TenantId\\": \\"13760*****8718726\\"\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
],
'CreatePlaybook' => [
'summary' => 'Creates a new playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '167210',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['title' => '剧本名称', 'description' => 'The name of the playbook.', 'type' => 'string', 'required' => true, 'example' => 'test09'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['title' => '剧本的描述', 'description' => 'The description of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'This is a new version'],
],
[
'name' => 'TaskflowType',
'in' => 'formData',
'schema' => ['description' => 'The configuration format of the playbook.'."\n"
."\n"
.'- **xml**: XML format.'."\n"
."\n"
.'- **x6**: JSON format.', 'type' => 'string', 'required' => false, 'example' => 'x6', 'title' => ''],
],
[
'name' => 'Lang',
'in' => 'formData',
'schema' => ['description' => 'The language of the messages to receive. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'OutputParams',
'in' => 'formData',
'schema' => ['description' => 'The output configuration of the playbook.', 'type' => 'string', 'example' => '{\'result\': \'success\'}', 'title' => '', 'required' => false],
],
[
'name' => 'InputParams',
'in' => 'formData',
'schema' => ['description' => 'The input configuration of the playbook.', 'type' => 'string', 'example' => '{\'key1\': \'value1\', \'key2\': \'value2\'}', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookCloudDTO>',
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of the request. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'B09B40B2-F11E-512C-B755-423F2056C17B'],
'Data' => [
'title' => '传输的数据',
'description' => 'The returned result of the creation.',
'type' => 'object',
'properties' => [
'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => 'The UUID of the newly created playbook.', 'type' => 'string', 'example' => '9e38111e-9794-4784-9ca8-xxxxxxx'],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B09B40B2-F11E-512C-B755-423F2056C17B\\",\\n \\"Data\\": {\\n \\"PlaybookUuid\\": \\"9e38111e-9794-4784-9ca8-xxxxxxx\\"\\n }\\n}","type":"json"}]',
'title' => 'CreatePlaybook',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'yundun-sas:CreatePlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/*'],
],
],
],
],
],
'DebugPlaybook' => [
'summary' => 'Debugs a playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'f916b93e-e814-459f-9662-xxxxx'],
],
[
'name' => 'Record',
'in' => 'formData',
'schema' => ['description' => 'The user-defined input parameters for debugging the playbook.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n"
.' "param1":"a",'."\n"
.' "param2":"b"'."\n"
.'}'],
],
[
'name' => 'Taskflow',
'in' => 'formData',
'schema' => ['description' => 'The XML configuration of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybook](~~DescribePlaybook~~) operation to obtain this configuration.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'."\n"],
],
[
'name' => 'Lang',
'in' => 'formData',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookTriggerDTO>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF'],
'RequestUuid' => ['description' => 'The run UUID of the debugging task. Use this UUID to query information, such as the task result.', 'type' => 'string', 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"75E56B2C-C8FA-5A2F-AA08-8745E2AC33EF\\",\\n \\"RequestUuid\\": \\"6d412cfa-0905-4567-8a83-xxxxxx\\"\\n}","type":"json"}]',
'title' => 'DebugPlaybook',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DebugPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DeleteComponentAsset' => [
'summary' => 'Deletes a component asset.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AssetId',
'in' => 'query',
'schema' => ['description' => 'The asset ID of the component.'."\n"
."\n"
.'> Call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to obtain this parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '12x'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '39C38A34-8532-5D44-B88A-7263B435C316'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"39C38A34-8532-5D44-B88A-7263B435C316\\"\\n}","type":"json"}]',
'title' => 'DeleteComponentAsset',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'yundun-sas:DeleteComponentAsset',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DeletePlaybook' => [
'summary' => 'Deletes a specified custom playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'formData',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '6F3CA8A9-B5BB-506A-9182-FFE80A6E0584'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F3CA8A9-B5BB-506A-9182-FFE80A6E0584\\"\\n}","type":"json"}]',
'title' => 'DeletePlaybook',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlaybook'],
],
],
'ramActions' => [],
],
'DescribeComponentAssetForm' => [
'summary' => 'Obtains the metadata for a component asset, which defines the fields that constitute the asset.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ComponentName',
'in' => 'query',
'schema' => ['description' => 'The name of the component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This is a unique identifier that is generated by Alibaba Cloud for the request. This ID can be used to locate and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '9D1651AC-31CC-5CC4-A14E-626B3FCC1022'],
'ComponentAssetForm' => ['description' => 'The configuration metadata for the component asset. The value is a string in the JSON array format. The array contains the following fields:'."\n"
."\n"
.'- **name**: The name of the parameter.'."\n"
."\n"
.'- **defaultValue**: The default value of the parameter.'."\n"
."\n"
.'- **description**: The description of the parameter.'."\n"
."\n"
.'- **required**: Specifies whether the parameter is required. A value of **true** means it is required. A value of **false** means it is optional.', 'type' => 'string', 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "defaultValue": "",'."\n"
.' "description": "assetname",'."\n"
.' "name": "assetname",'."\n"
.' "required": true'."\n"
.' }'."\n"
.']'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9D1651AC-31CC-5CC4-A14E-626B3FCC1022\\",\\n \\"ComponentAssetForm\\": \\"[\\\\n {\\\\n \\\\\\"defaultValue\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"assetname\\\\\\",\\\\n \\\\\\"required\\\\\\": true\\\\n }\\\\n]\\"\\n}","type":"json"}]',
'title' => 'DescribeComponentAssetForm',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeComponentAssetForm',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeComponentAssets' => [
'summary' => 'Retrieves the asset list for a component.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ComponentName',
'in' => 'query',
'schema' => ['description' => 'The component name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<SaoAsset>>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F'],
'ComponentAssets' => [
'title' => '',
'description' => 'A list of assets.',
'type' => 'array',
'items' => [
'description' => 'Asset information.',
'type' => 'object',
'properties' => [
'Id' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The unique ID of the asset.', 'type' => 'integer', 'format' => 'int64', 'example' => '7xx'],
'GmtCreate' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The time when the asset was created. The time is in UTC and follows the yyyy-MM-ddTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2023-03-23T14:38Z'],
'GmtModified' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The time when the asset was last modified. The time is in UTC and follows the yyyy-MM-ddTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2023-03-23T14:38Z'],
'Name' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The asset name.', 'type' => 'string', 'example' => 'test asset'],
'Componentname' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The name of the component that the asset belongs to.', 'type' => 'string', 'example' => 'pyhton3'],
'Params' => ['title' => 'This field was generated by MyBatis Generator.', 'description' => 'The asset configuration in JSON format.'."\n"
."\n"
.'> For more information about the format, see [DescribeComponentAssetForm](~~DescribeComponentAssetForm~~).', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "name": "authMethod",'."\n"
.' "value": "ak"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "accessKeyId",'."\n"
.' "value": "xxxxxxx"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "accessKeySecret",'."\n"
.' "value": "xxxxx"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "roleArn",'."\n"
.' "value": ""'."\n"
.' }'."\n"
.']'],
'AssetUuid' => ['description' => 'The asset\'s UUID.', 'type' => 'string', 'example' => 'ff6fe161-93e2-464c-a326-fxxxxxx', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BFEFB76D-DD0E-5529-BD57-0DAC10B9B30F\\",\\n \\"ComponentAssets\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": \\"2023-03-23T14:38Z\\",\\n \\"GmtModified\\": \\"2023-03-23T14:38Z\\",\\n \\"Name\\": \\"test asset\\",\\n \\"Componentname\\": \\"pyhton3\\",\\n \\"Params\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"authMethod\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"ak\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeyId\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"accessKeySecret\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"xxxxx\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"roleArn\\\\\\",\\\\n \\\\\\"value\\\\\\": \\\\\\"\\\\\\"\\\\n }\\\\n]\\",\\n \\"AssetUuid\\": \\"ff6fe161-93e2-464c-a326-fxxxxxx\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeComponentAssets',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeComponentAssets',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeComponentList' => [
'summary' => 'Retrieves a list of standard components that you can use.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'B0A255B3-495C-56FB-8B6B-DB073F80388A'],
'Components' => ['description' => 'The component information. The value is a string in the format of a JSON array.', 'type' => 'string', 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "actions": ['."\n"
.' {'."\n"
.' "description": "mysql component",'."\n"
.' "name": "storeIdb",'."\n"
.' "parameters": ['."\n"
.' {'."\n"
.' "description": "update the mysql db",'."\n"
.' "name": "updateSql",'."\n"
.' "required": false'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ],'."\n"
.' "basic": {'."\n"
.' "description": "mysq sql component for 5.6",'."\n"
.' "logo": "https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg",'."\n"
.' "name": "Mysql"'."\n"
.' }'."\n"
.' }'."\n"
.']'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B0A255B3-495C-56FB-8B6B-DB073F80388A\\",\\n \\"Components\\": \\"[\\\\n {\\\\n \\\\\\"actions\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"mysql component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"storeIdb\\\\\\",\\\\n \\\\\\"parameters\\\\\\": [\\\\n {\\\\n \\\\\\"description\\\\\\": \\\\\\"update the mysql db\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"updateSql\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n ]\\\\n }\\\\n ],\\\\n \\\\\\"basic\\\\\\": {\\\\n \\\\\\"description\\\\\\": \\\\\\"mysq sql component for 5.6\\\\\\",\\\\n \\\\\\"logo\\\\\\": \\\\\\"https://img.alicdn.com/tfs/TB1H89IpH3nBKNjSZFMXXaUSFXa-200-200.svg\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Mysql\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]',
'title' => 'DescribeComponentList',
'responseParamsDescription' => 'The **Components** parameter is in JSON format and includes the following fields:'."\n"
."\n"
.'- **actions**: The executable actions of the component. This parameter is a JSON array that contains the following fields:'."\n"
."\n"
.' - **description**: The description of the action.'."\n"
."\n"
.' - **name**: The name of the action.'."\n"
."\n"
.' - **parameters**: The input parameters for the action. This parameter is a JSON object that contains the following fields:'."\n"
."\n"
.' - **description**: The description of the input parameter.'."\n"
."\n"
.' - **name**: The name of the input parameter.'."\n"
."\n"
.' - **required**: Specifies whether the input parameter is required. A value of true indicates that the parameter is required. A value of false indicates that the parameter is optional.'."\n"
."\n"
.'- **basic**: The basic information about the component. This parameter contains the following fields:'."\n"
."\n"
.'- **description**: The description of the component.'."\n"
."\n"
.'- **logo**: The URL of the component logo.'."\n"
."\n"
.'- **name**: The name of the component.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeComponentList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribeComponentPlaybook' => [
'summary' => 'Retrieves a list of predefined components.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the component playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1cxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<PlaybookCloudDTO>>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C5F5D6C9-DF1A-5381-92B1-39676F777D20', 'title' => ''],
'Playbooks' => [
'title' => '',
'description' => 'The list of component playbooks.',
'type' => 'array',
'items' => [
'description' => 'The information about the component playbook.',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'The name of the component playbook.', 'type' => 'string', 'example' => 'AegisKillQuara', 'title' => ''],
'InputParams' => ['description' => 'The input parameter configurations of the component playbook. The value is a JSON array.'."\n"
."\n"
.'> For more information about the format, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "typeName": "String",'."\n"
.' "dataClass": "normal",'."\n"
.' "dataType": "String",'."\n"
.' "description": "period",'."\n"
.' "example": "",'."\n"
.' "name": "period",'."\n"
.' "required": false'."\n"
.' }'."\n"
.']', 'title' => ''],
'Description' => ['description' => 'The description of the component playbook.', 'type' => 'string', 'example' => 'aegis_kill_process', 'title' => ''],
'ParamType' => ['description' => 'The input parameter type of the component playbook.'."\n"
."\n"
.'template-ip: IP request template.'."\n"
.'template-file: file request template.'."\n"
.'template-process: process request template.'."\n"
.'custom: custom parameters.', 'type' => 'string', 'example' => 'template-alert', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C5F5D6C9-DF1A-5381-92B1-39676F777D20\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"AegisKillQuara\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"ParamType\\": \\"template-alert\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeComponentPlaybook',
'changeSet' => [
['createdAt' => '2025-10-09T09:35:06.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeComponentPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribeComponentsJs' => [
'summary' => 'Obtains the JavaScript (JS) file that a component uses to render the page.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. This is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073'],
'ComponentsJs' => ['description' => 'The configuration information of the component\'s JS file.', 'type' => 'string', 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "js": "https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx",'."\n"
.' "name": "python3",'."\n"
.' "ownType": "sys"'."\n"
.' }'."\n"
.']'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\",\\n \\"ComponentsJs\\": \\"[\\\\n {\\\\n \\\\\\"js\\\\\\": \\\\\\"https://xxxxx.oss-cn-zhangjiakou.aliyuncs.com/componentUpload/xxxxx\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"python3\\\\\\",\\\\n \\\\\\"ownType\\\\\\": \\\\\\"sys\\\\\\"\\\\n }\\\\n]\\"\\n}","type":"json"}]',
'title' => 'DescribeComponentsJs',
'responseParamsDescription' => 'The **ComponentsJs** parameter is in the JSONArray format and contains the following fields:'."\n"
."\n"
.'- **js**: The URL of the JS file.'."\n"
."\n"
.'- **name**: The name of the component.'."\n"
."\n"
.'- **ownType**: The type of the component. The value is fixed to **sys**. Other component types are not supported.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentsJs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeComponentsJs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeDistinctReleases' => [
'summary' => 'Retrieves a list of distinct playbook releases.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '172028',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'bc0b8424-535c-4ed5-bd94-xxxxxx'],
],
[
'name' => 'TaskflowMd5',
'in' => 'query',
'schema' => ['description' => 'The MD5 value of the playbook\'s XML configuration.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'be0a4ef084dd174abe47xxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<SaoReleaseInfo>>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and is used to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '145CACF6-D276-5197-8549-CB1AD76E2AC8'],
'Records' => [
'title' => '',
'description' => 'The version records.',
'type' => 'array',
'items' => [
'description' => 'The version information.',
'type' => 'object',
'properties' => [
'Description' => ['description' => 'The description of the version.', 'type' => 'string', 'title' => '', 'example' => 'demo version'],
'TaskflowMd5' => ['description' => 'The MD5 value of the version\'s XML configuration.', 'type' => 'string', 'title' => '', 'example' => '17cf53049bc8efa941207xxxxx'],
'TaskflowType' => ['description' => 'The configuration format of the playbook.'."\n"
."\n"
.'- **xml**: XML format.'."\n"
."\n"
.'- **x6**: JSON format.', 'type' => 'string', 'example' => 'x6', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"145CACF6-D276-5197-8549-CB1AD76E2AC8\\",\\n \\"Records\\": [\\n {\\n \\"Description\\": \\"demo version\\",\\n \\"TaskflowMd5\\": \\"17cf53049bc8efa941207xxxxx\\",\\n \\"TaskflowType\\": \\"x6\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeDistinctReleases',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeDistinctReleases',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribeEnumItems' => [
'summary' => 'Queries the enumeration information for a product.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EnumType',
'in' => 'query',
'schema' => ['description' => 'The type of the enumeration. Valid value:'."\n"
."\n"
.'- **process**: The enumeration for response scenarios.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'process'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh\\_cn**: The default value. Simplified Chinese.'."\n"
."\n"
.'- **en\\_us**: American English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<EnumDTO>>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'],
'Data' => [
'title' => '',
'description' => 'The enumeration information.',
'type' => 'array',
'items' => [
'description' => 'The key-value pair of the enumeration.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the enumeration.', 'type' => 'string', 'example' => 'system_xxxxx_process_book', 'title' => ''],
'Value' => ['description' => 'The value of the enumeration.', 'type' => 'string', 'example' => 'system_xxxxx_process_book', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": [\\n {\\n \\"Key\\": \\"system_xxxxx_process_book\\",\\n \\"Value\\": \\"system_xxxxx_process_book\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeEnumItems',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'yundun-sas:DescribeEnumItems',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeExecutePlaybooks' => [
'summary' => 'Queries a list of executable playbooks that are used to configure automated response plans.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '172464',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'InputMode',
'in' => 'query',
'schema' => ['title' => '入参类型筛选', 'description' => 'The entity type of the input parameter for the playbook. To query multiple entity types, separate them with commas.'."\n"
."\n"
.'- **ip**: IP entity.'."\n"
."\n"
.'- **file**: file entity.'."\n"
."\n"
.'- **process**: process entity.'."\n"
."\n"
.'- **incident**: event entity.', 'type' => 'string', 'required' => false, 'example' => 'ip,file,process,host'],
],
[
'name' => 'PlaybookName',
'in' => 'query',
'schema' => ['description' => 'The name of the playbook. Fuzzy search is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo_test'],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'ParamType',
'in' => 'query',
'schema' => ['description' => 'The type of the input parameter for the playbook.'."\n"
."\n"
.'- **template-ip**: IP request template.'."\n"
."\n"
.'- **template-file**: file request template.'."\n"
."\n"
.'- **template-process**: process request template.'."\n"
."\n"
.'- **custom**: custom parameter.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<PlaybookExecuteMetrics>>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is unique to the request and is generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '88A39217-2802-5B1E-BA2B-CF1BBC43C1F5'],
'PlaybookMetrics' => [
'title' => '',
'description' => 'The list of playbooks.',
'type' => 'array',
'items' => [
'description' => 'Summary information about the playbook.',
'type' => 'object',
'properties' => [
'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'a demo playbook', 'title' => ''],
'DisplayName' => ['description' => 'The name of the playbook.', 'type' => 'string', 'example' => 'demo_playbook', 'title' => ''],
'Uuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'c5c88b5e-97ca-435d-8c20-2xxxxx', 'title' => ''],
'ParamConfig' => ['description' => 'The configuration of the input parameters for the playbook. The value is in the JSONArray format.'."\n"
."\n"
.'> For more information about the format, see the [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~) operation.', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "typeName": "String",'."\n"
.' "dataClass": "normal",'."\n"
.' "dataType": "String",'."\n"
.' "description": "period",'."\n"
.' "example": "",'."\n"
.' "name": "period",'."\n"
.' "required": false'."\n"
.' }'."\n"
.']', 'title' => ''],
'ParamType' => ['description' => 'The type of the input parameter for the playbook.'."\n"
."\n"
.'- **template-ip**: IP request template.'."\n"
."\n"
.'- **template-file**: file request template.'."\n"
."\n"
.'- **template-process**: process request template.'."\n"
."\n"
.'- **custom**: custom parameter.', 'type' => 'string', 'example' => 'custom', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88A39217-2802-5B1E-BA2B-CF1BBC43C1F5\\",\\n \\"PlaybookMetrics\\": [\\n {\\n \\"Description\\": \\"a demo playbook\\",\\n \\"DisplayName\\": \\"demo_playbook\\",\\n \\"Uuid\\": \\"c5c88b5e-97ca-435d-8c20-2xxxxx\\",\\n \\"ParamConfig\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"ParamType\\": \\"custom\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeExecutePlaybooks',
'changeSet' => [
['createdAt' => '2024-03-19T03:26:12.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutePlaybooks'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeExecutePlaybooks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeField' => [
'summary' => 'Retrieves global configuration information for the product.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'QueryKey',
'in' => 'query',
'schema' => ['description' => 'The key of the global configuration. Valid value:'."\n"
."\n"
.'- **soar\\_filed\\_tags**: Obtains the input field template for a playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'soar_filed_tags'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response messages. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<SystemConfigView>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'BCDE6498-83CC-50A1-8307-3D5A539C42F8'],
'Name' => ['description' => 'The name of the global configuration.', 'type' => 'string', 'example' => 'soar_filed_tags', 'title' => ''],
'Fields' => ['description' => 'The content of the configuration.', 'type' => 'string', 'example' => '["ip","name","hostinfo","md5"]', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BCDE6498-83CC-50A1-8307-3D5A539C42F8\\",\\n \\"Name\\": \\"soar_filed_tags\\",\\n \\"Fields\\": \\"[\\\\\\"ip\\\\\\",\\\\\\"name\\\\\\",\\\\\\"hostinfo\\\\\\",\\\\\\"md5\\\\\\"]\\"\\n}","type":"json"}]',
'title' => 'DescribeField',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeField'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeField',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeGroupProductions' => [
'summary' => 'Queries groups of Alibaba Cloud services.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '203522',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the response. Valid values:'."\n"
."\n"
.'* **zh** (default)'."\n"
.'* **en**'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The type of the view. Valid values:'."\n"
."\n"
.'* **0** (default): the view of the current Alibaba Cloud account.'."\n"
.'* **1**: the view of all accounts for the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11824150xxx50980', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<ProductionGroup>>',
'description' => 'SophonResult\\<List>'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '358E012F-B516-599D-9Exxx-A1A361CDE615'],
'Data' => [
'title' => '',
'description' => 'The information about the groups.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the group.'."\n",
'type' => 'object',
'properties' => [
'GroupName' => ['description' => 'The name of the cloud service.'."\n", 'type' => 'string', 'example' => 'Database', 'title' => ''],
'Productions' => [
'description' => 'The information about the cloud services.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the cloud service.'."\n",
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The code of the cloud service.'."\n", 'type' => 'string', 'example' => 'Rds', 'title' => ''],
'Name' => ['description' => 'The name of the cloud service.'."\n", 'type' => 'string', 'example' => 'ApsaraDB RDS', 'title' => ''],
'ShortName' => ['description' => 'The short name of the cloud service.'."\n", 'type' => 'string', 'example' => 'RDS', 'title' => ''],
'Description' => ['description' => 'The description of the cloud service.'."\n", 'type' => 'string', 'example' => 'ApsaraDB', 'title' => ''],
'Group' => ['description' => 'The name of the group.'."\n", 'type' => 'string', 'example' => 'ApsaraDB', 'title' => ''],
'Versions' => [
'description' => 'The API versions.'."\n",
'type' => 'array',
'items' => ['description' => 'The API version.'."\n", 'type' => 'string', 'example' => '2014-08-15', 'title' => ''],
'title' => '',
'example' => '',
],
'DefaultVersion' => ['description' => 'The default version.'."\n", 'type' => 'string', 'example' => '2014-08-15', 'title' => ''],
'DefaultDomain' => ['description' => 'The default requested domain name.'."\n", 'type' => 'string', 'example' => 'rds.aliyuncs.com', 'title' => ''],
'FullDomains' => [
'description' => 'The requested domain names.'."\n",
'type' => 'array',
'items' => ['description' => 'The requested domain name.'."\n", 'type' => 'string', 'example' => 'rds.aliyuncs.com', 'title' => ''],
'title' => '',
'example' => '',
],
'RamCode' => ['description' => 'The Resource Access Management (RAM) code of the POP to which the resource belongs.'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''],
'Source' => ['description' => 'The information source of the cloud service.'."\n", 'type' => 'string', 'example' => 'next', 'title' => ''],
'PolicyList' => [
'title' => '',
'description' => 'The RAM policies of the cloud service.'."\n",
'type' => 'array',
'items' => [
'description' => 'The RAM policy of the cloud service.'."\n",
'type' => 'object',
'properties' => [
'PolicyName' => ['title' => '', 'description' => 'The name of the RAM policy.'."\n", 'type' => 'string', 'example' => 'AliyunRAMReadOnlyAccess'],
'Type' => ['title' => '', 'description' => 'The type of the RAM policy. Valid values:'."\n"
."\n"
.'* **All**: permissions.'."\n"
.'* **Read-only**: permissions.', 'type' => 'string', 'example' => 'Read-only permission'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.'."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9Exxx-A1A361CDE615\\",\\n \\"Data\\": [\\n {\\n \\"GroupName\\": \\"Database\\",\\n \\"Productions\\": [\\n {\\n \\"Code\\": \\"Rds\\",\\n \\"Name\\": \\"ApsaraDB RDS\\",\\n \\"ShortName\\": \\"RDS\\",\\n \\"Description\\": \\"ApsaraDB\\",\\n \\"Group\\": \\"ApsaraDB\\",\\n \\"Versions\\": [\\n \\"2014-08-15\\"\\n ],\\n \\"DefaultVersion\\": \\"2014-08-15\\",\\n \\"DefaultDomain\\": \\"rds.aliyuncs.com\\",\\n \\"FullDomains\\": [\\n \\"rds.aliyuncs.com\\"\\n ],\\n \\"RamCode\\": \\"rds\\",\\n \\"Source\\": \\"next\\",\\n \\"PolicyList\\": [\\n {\\n \\"PolicyName\\": \\"AliyunRAMReadOnlyAccess\\",\\n \\"Type\\": \\"Read-only permission\\"\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'DescribeGroupProductions',
'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupProductions'],
],
],
'ramActions' => [],
],
'DescribeLatestRecordSchema' => [
'summary' => 'Describes the output structure of each node in a playbook based on the latest execution record.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookNodeSchema>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '10B92EE1-4597-593B-A131-7A17D25EF5C9'],
'PlaybookNodeSchema' => [
'title' => '',
'description' => 'The output structure of the playbook.',
'type' => 'object',
'properties' => [
'NodeSchema' => [
'description' => 'The structure information.',
'type' => 'array',
'items' => [
'description' => 'The structure information.',
'type' => 'object',
'properties' => [
'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''],
'ComponentName' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'DataFormat', 'title' => ''],
'ActionName' => ['description' => 'The action name of the component.', 'type' => 'string', 'example' => 'formatedata', 'title' => ''],
'OutputFields' => [
'description' => 'The output fields.',
'type' => 'array',
'items' => ['description' => 'The reference path of the output field.', 'type' => 'string', 'example' => 'play_group.datalist.*.ids', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"10B92EE1-4597-593B-A131-7A17D25EF5C9\\",\\n \\"PlaybookNodeSchema\\": {\\n \\"NodeSchema\\": [\\n {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"ComponentName\\": \\"DataFormat\\",\\n \\"ActionName\\": \\"formatedata\\",\\n \\"OutputFields\\": [\\n \\"play_group.datalist.*.ids\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeLatestRecordSchema',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeLatestRecordSchema',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribeNodeParamTags' => [
'summary' => 'Returns the reference paths for component inputs in a playbook orchestration.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['description' => 'The name of the component node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3_2'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<ParamReferredPathsInfo>>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '6BE94351-712A-505D-A40A-BC77CC8254A9'],
'ParamReferredPaths' => [
'title' => '',
'description' => 'The recommended path configurations.',
'type' => 'array',
'items' => [
'description' => 'The path information.',
'type' => 'object',
'properties' => [
'ParamName' => ['description' => 'The name of the ancestor node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''],
'ReferredPath' => [
'description' => 'An array of paths.',
'type' => 'array',
'items' => ['description' => 'The reference path configuration.', 'type' => 'string', 'example' => 'filter_1.datalist.*.score', 'title' => ''],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6BE94351-712A-505D-A40A-BC77CC8254A9\\",\\n \\"ParamReferredPaths\\": [\\n {\\n \\"ParamName\\": \\"DataFormat_1\\",\\n \\"ReferredPath\\": [\\n \\"filter_1.datalist.*.score\\"\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeNodeParamTags',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeParamTags'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeNodeParamTags',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribeNodeUsedInfos' => [
'summary' => 'Queries the nodes that reference a specific node in a playbook.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['description' => 'The name of the component node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'python3_2'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and the response. Valid values:'."\n"
."\n"
.'- **zh**: Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID to help you troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '3B10F836-C2B1-54FA-AB59-7591B548FB59'],
'NodeUsedInfos' => ['description' => 'The reference information for the node. This is returned in a JSON string and includes the following fields:'."\n"
."\n"
.'- **action**: The referenced action. It contains the following information:'."\n"
."\n"
.' - **name**: The name of the referenced node.'."\n"
."\n"
.' - **inputParams**: The referenced parameter settings.', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "action": ['."\n"
.' {'."\n"
.' "name": "query_books",'."\n"
.' "inputParams": ['."\n"
.' {'."\n"
.' "referInfos": ['."\n"
.' "${play_group.datalist.*.ids}"'."\n"
.' ],'."\n"
.' "name": "querySql"'."\n"
.' }'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3B10F836-C2B1-54FA-AB59-7591B548FB59\\",\\n \\"NodeUsedInfos\\": \\"{\\\\n \\\\\\"action\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"query_books\\\\\\",\\\\n \\\\\\"inputParams\\\\\\": [\\\\n {\\\\n \\\\\\"referInfos\\\\\\": [\\\\n \\\\\\"${play_group.datalist.*.ids}\\\\\\"\\\\n ],\\\\n \\\\\\"name\\\\\\": \\\\\\"querySql\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]',
'title' => 'DescribeNodeUsedInfos',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeUsedInfos'],
],
],
'ramActions' => [],
],
'DescribeNotifyTemplateList' => [
'summary' => 'Queries notification templates.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '225868',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the request and the response. Valid values:'."\n"
."\n"
.'* **zh** (default): Chinese.'."\n"
.'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The type of the view. Default value: 0. Valid values:'."\n"
."\n"
.'* 0: the view of the current Alibaba Cloud account.'."\n"
.'* 1: the view of all accounts for the enterprise.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602425xxx8726', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<NotifyTemplateDTO>>',
'description' => 'SophonResult\\<List>'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573'],
'Data' => [
'title' => '',
'description' => 'The data returned.'."\n",
'type' => 'array',
'items' => [
'description' => 'The data that is returned.'."\n",
'type' => 'object',
'properties' => [
'TemplateName' => ['title' => '', 'description' => 'The name of the template.'."\n", 'type' => 'string', 'example' => 'incident generate'],
'EventId' => ['title' => '', 'description' => 'The ID of the message event corresponding to the template.'."\n", 'type' => 'string', 'example' => 'yundun_soar_incident_generate'],
'Subject' => ['title' => '', 'description' => 'The title of the template.'."\n", 'type' => 'string', 'example' => '[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)'],
'Content' => ['title' => '', 'description' => 'The body of the template.'."\n", 'type' => 'string', 'example' => 'Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.'],
'Params' => ['title' => '', 'description' => 'The parameters of the template.'."\n", 'type' => 'string', 'example' => '[\\"aliyunUID\\",\\"incidentName\\",\\"incidentID\\",\\"startTime\\"]'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.'."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\",\\n \\"Data\\": [\\n {\\n \\"TemplateName\\": \\"incident generate\\",\\n \\"EventId\\": \\"yundun_soar_incident_generate\\",\\n \\"Subject\\": \\"[Alibaba Cloud Threat Analysis and Response] has detected a newly discovered security incident $incidentName($incidentID)\\",\\n \\"Content\\": \\"Dear $aliyunUID : Cloud Security Center Threat Analysis and Response has detected a newly discovered security incident $incidentName(Incident id :$incidentID) in $startTime, Please go to Cloud Security Center Console View.\\",\\n \\"Params\\": \\"[\\\\\\\\\\\\\\"aliyunUID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"incidentName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"incidentID\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\"]\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'DescribeNotifyTemplateList',
'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR). For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n",
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeNotifyTemplateList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNotifyTemplateList'],
],
],
],
'DescribeOpenApiInfo' => [
'summary' => 'Queries the details of an API operation.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '203523',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PopCode',
'in' => 'query',
'schema' => ['description' => 'The POP code of the Alibaba Cloud service.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Sas', 'title' => ''],
],
[
'name' => 'ApiVersion',
'in' => 'query',
'schema' => ['description' => 'The version number of the API.'."\n"
."\n"
.'> You can call the [DescribeGroupProductions](~~DescribeGroupProductions~~) operation to query version numbers.'."\n", 'type' => 'string', 'required' => true, 'example' => '2018-12-03', 'title' => ''],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'The operation that you want to perform.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DescribePopApiItemList', 'title' => ''],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the response. Valid values:'."\n"
."\n"
.'* **zh** (default): Chinese.'."\n"
.'* **en**: English.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The type of the view. Valid values:'."\n"
."\n"
.'* 0 (default): the view of the current Alibaba Cloud account.'."\n"
.'* 1: the view of all accounts for the enterprise.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The ID of the user who switches from the current view to the destination view by using the management account.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1592757xxx002956', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<APIDetailVO>',
'description' => 'SophonResult'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '358E012F-B516-599D-9ED0-A1A361CDE615'],
'Data' => [
'title' => '',
'description' => 'The data returned.'."\n",
'type' => 'object',
'properties' => [
'OutputParams' => ['description' => 'The output parameters of the API operation.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''],
'InputParams' => ['description' => 'The input parameters of the API operation.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''],
'ResponseDemo' => ['description' => 'The sample response parameters.'."\n", 'type' => 'string', 'example' => '[]', 'title' => ''],
'Title' => ['description' => 'The title of the API operation.'."\n", 'type' => 'string', 'example' => 'describeEcs', 'title' => ''],
'Summary' => ['description' => 'The summary of the API operation.'."\n", 'type' => 'string', 'example' => 'describeEcs', 'title' => ''],
'Description' => ['description' => 'The description of the API operation.'."\n", 'type' => 'string', 'example' => 'describeEcs', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"358E012F-B516-599D-9ED0-A1A361CDE615\\",\\n \\"Data\\": {\\n \\"OutputParams\\": \\"[]\\",\\n \\"InputParams\\": \\"{}\\",\\n \\"ResponseDemo\\": \\"[]\\",\\n \\"Title\\": \\"describeEcs\\",\\n \\"Summary\\": \\"describeEcs\\",\\n \\"Description\\": \\"describeEcs\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeOpenApiInfo',
'description' => 'Before you call this operation, make sure that you understand the billing method and pricing of Security Orchestration Automation Response (SOAR) or pricing for the log data added to the Cloud Threat Detection and Response (CTDR) feature. For more information, see [Pricing](https://www.aliyun.com/price/product#/sas/detail/sas).'."\n",
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeOpenApiInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiInfo'],
],
],
],
'DescribeOpenApiList' => [
'summary' => 'Retrieve the API list for a product.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '203524',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PopCode',
'in' => 'query',
'schema' => ['description' => 'The POP CODE of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'Sas', 'title' => ''],
],
[
'name' => 'ApiVersion',
'in' => 'query',
'schema' => ['description' => 'The API version number.'."\n"
."\n"
.'> Call the [DescribeGroupProductions](~~DescribeGroupProductions~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'example' => '2021-10-01', 'title' => ''],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'The API name.', 'type' => 'string', 'required' => false, 'example' => 'DescribePopApiItemList', 'title' => ''],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language type for requests and responses. The default value is **zh**. Values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The view type. The default is 0. Values:'."\n"
."\n"
.'- 0: Current Alibaba Cloud account view.'."\n"
."\n"
.'- 1: View of all accounts under the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The user ID of the member whose perspective the administrator switches to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602xxx8718726', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<APITreeBO>',
'description' => 'SophonResult',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of this request, a unique identifier generated by Alibaba Cloud for this request, used for troubleshooting and locating issues.', 'type' => 'string', 'title' => '', 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2'],
'Data' => [
'title' => '',
'description' => 'Returned result data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The response code. Values:'."\n"
."\n"
.'- 200: Success'."\n"
."\n"
.'- 500: Failed', 'type' => 'string', 'example' => '200', 'title' => ''],
'Version' => ['description' => 'The API version number.', 'type' => 'string', 'example' => '2018-12-03', 'title' => ''],
'Directories' => ['description' => 'The returned API list content.', 'type' => 'any', 'example' => '[{"apis":[{"summary":"get account information","deprecated":false,"name":"DescAccountSummary","title":"get account information"}],"childrens":[],"title":"account"}]', 'title' => ''],
'Versions' => ['description' => 'List of supported versions.', 'type' => 'any', 'title' => '', 'example' => '["2018-12-03" ]'],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Data\\": {\\n \\"Code\\": \\"200\\",\\n \\"Version\\": \\"2018-12-03\\",\\n \\"Directories\\": \\"[{\\\\\\"apis\\\\\\":[{\\\\\\"summary\\\\\\":\\\\\\"get account information\\\\\\",\\\\\\"deprecated\\\\\\":false,\\\\\\"name\\\\\\":\\\\\\"DescAccountSummary\\\\\\",\\\\\\"title\\\\\\":\\\\\\"get account information\\\\\\"}],\\\\\\"childrens\\\\\\":[],\\\\\\"title\\\\\\":\\\\\\"account\\\\\\"}]\\",\\n \\"Versions\\": \\"[\\\\\\"2018-12-03\\\\\\" ]\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeOpenApiList',
'description' => 'Before you use this API, review the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for the orchestration product, which supports threat analysis, response, log access, and traffic monitoring.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeOpenApiList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribePlaybook' => [
'summary' => 'Retrieves the XML configuration of a playbook.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9030076b-6733-4842-b05a-xxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'TaskflowMd5',
'in' => 'query',
'schema' => ['description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'required' => false, 'example' => '7a8f608dc64c242632aa578xxxxx', 'title' => ''],
],
[
'name' => 'DebugFlag',
'in' => 'query',
'schema' => ['description' => 'A flag that indicates whether the version is a published version or a debug version. Valid values:'."\n"
."\n"
.'- **1**: retrieves the debug version.'."\n"
."\n"
.'- **0**: retrieves the published version.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookDetailDTO>',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. This is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '2989BC59-E9F0-5C83-B453-B368857649C8'],
'Playbook' => [
'title' => '',
'description' => 'The configuration of the playbook.',
'type' => 'object',
'properties' => [
'GmtCreate' => ['description' => 'The time when the playbook was created. This is a 13-digit timestamp.', 'type' => 'string', 'example' => '1665288858000', 'title' => ''],
'GmtModified' => ['description' => 'The time when the playbook was last modified. This is a 13-digit timestamp.', 'type' => 'string', 'example' => '1677482519000', 'title' => ''],
'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '8db257d3-e2b2-44fd-b2cc-xxxxx', 'title' => ''],
'Taskflow' => ['description' => 'The XML configuration of the playbook.', 'type' => 'string', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>', 'title' => ''],
'TaskflowType' => ['description' => 'The configuration format of the playbook.'."\n"
."\n"
.'- **xml**: XML format.'."\n"
."\n"
.'- **x6**: JSON format.', 'type' => 'string', 'example' => 'xml', 'title' => ''],
'OwnType' => ['description' => 'The type of the playbook. Valid values:'."\n"
."\n"
.'- **preset**: predefined playbook.'."\n"
."\n"
.'- **user**: custom playbook.', 'type' => 'string', 'example' => 'preset', 'title' => ''],
'SuccessExeNum' => ['description' => 'The number of times the playbook was successfully run.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'FailExeNum' => ['description' => 'The number of times the playbook failed to run.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'LastExeTime' => ['description' => 'The last time when the playbook was run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1665288858000', 'title' => ''],
'DisplayName' => ['description' => 'The display name of the playbook.', 'type' => 'string', 'example' => 'demo_test', 'title' => ''],
'InputParams' => ['description' => 'The input parameter configuration of the playbook. The value is a JSONArray string.'."\n"
."\n"
.'> For more information about the format, see [DescribePlaybookInputOutput](~~DescribePlaybookInputOutput~~).', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "typeName": "String",'."\n"
.' "dataClass": "normal",'."\n"
.' "dataType": "String",'."\n"
.' "description": "period",'."\n"
.' "example": "",'."\n"
.' "name": "period",'."\n"
.' "required": false'."\n"
.' }'."\n"
.']', 'title' => ''],
'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'demo playbook', 'title' => ''],
'OnlineActive' => ['description' => 'A flag that indicates whether the playbook is enabled. Valid values:'."\n"
."\n"
.'- **0**: The playbook is disabled.'."\n"
."\n"
.'- **1**: The playbook is enabled.', 'type' => 'boolean', 'example' => '0', 'title' => ''],
'OnlineReleaseTaskflowMd5' => ['description' => 'The MD5 value of the latest published version of the playbook.', 'type' => 'string', 'example' => 'asdfsdfe232-e2b2-44fd-b2cc-xxxxx', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2989BC59-E9F0-5C83-B453-B368857649C8\\",\\n \\"Playbook\\": {\\n \\"GmtCreate\\": \\"1665288858000\\",\\n \\"GmtModified\\": \\"1677482519000\\",\\n \\"PlaybookUuid\\": \\"8db257d3-e2b2-44fd-b2cc-xxxxx\\",\\n \\"Taskflow\\": \\"<?xml version=\\\\\\"1.0\\\\\\" encoding=\\\\\\"UTF-8\\\\\\"?><bpmn:definitions xmlns:xsi=\\\\\\"http://www.w3.org/2001/XMLSchema-instance\\\\\\" xmlns:bpmn=\\\\\\"http://www.omg.org/spec/BPMN/20100524/MODEL\\\\\\" xmlns:bpmndi=\\\\\\"http://www.omg.org/spec/BPMN/20100524/DI\\\\\\" xmlns:dc=\\\\\\"http://www.omg.org/spec/DD/20100524/DC\\\\\\" targetNamespace=\\\\\\"http://bpmn.io/schema/bpmn\\\\\\" id=\\\\\\"Definitions_1\\\\\\"><bpmn:process id=\\\\\\"Process_1\\\\\\" isExecutable=\\\\\\"false\\\\\\"><bpmn:startEvent id=\\\\\\"StartEvent_1\\\\\\"/></bpmn:process><bpmndi:BPMNDiagram id=\\\\\\"BPMNDiagram_1\\\\\\"><bpmndi:BPMNPlane id=\\\\\\"BPMNPlane_1\\\\\\" bpmnElement=\\\\\\"Process_1\\\\\\"><bpmndi:BPMNShape id=\\\\\\"_BPMNShape_StartEvent_2\\\\\\" bpmnElement=\\\\\\"StartEvent_1\\\\\\"><dc:Bounds height=\\\\\\"36.0\\\\\\" width=\\\\\\"36.0\\\\\\" x=\\\\\\"173.0\\\\\\" y=\\\\\\"102.0\\\\\\"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>\\",\\n \\"TaskflowType\\": \\"xml\\",\\n \\"OwnType\\": \\"preset\\",\\n \\"SuccessExeNum\\": 100,\\n \\"FailExeNum\\": 1,\\n \\"LastExeTime\\": 1665288858000,\\n \\"DisplayName\\": \\"demo_test\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"Description\\": \\"demo playbook\\",\\n \\"OnlineActive\\": true,\\n \\"OnlineReleaseTaskflowMd5\\": \\"asdfsdfe232-e2b2-44fd-b2cc-xxxxx\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribePlaybook',
'changeSet' => [
['createdAt' => '2025-02-26T03:24:20.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-03-19T03:26:13.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybook'],
],
],
'ramActions' => [],
],
'DescribePlaybookInputOutput' => [
'summary' => 'Retrieves the input and output parameter configurations for a playbook.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '167574',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'b724d2b0-3c3b-4223-9bfd-xxxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookInputOutputDTO>',
'description' => 'The response that is returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '688B4CCD-5272-5DCF-9D76-FE5EFEF545F8'],
'Config' => [
'title' => '',
'description' => 'The configuration information.',
'type' => 'object',
'properties' => [
'ParamType' => ['description' => 'The type of the input parameters for the playbook.'."\n"
."\n"
.'- **template-ip**: IP request template.'."\n"
."\n"
.'- **template-file**: file request template.'."\n"
."\n"
.'- **template-process**: process request template.'."\n"
."\n"
.'- **custom**: custom parameters.', 'type' => 'string', 'title' => '', 'example' => 'custom'],
'ExeConfig' => ['title' => '输入类型', 'description' => 'The execution method of the playbook. The value is in the JSONObject format.', 'type' => 'string', 'example' => '{'."\n"
.' "executeMode":"mul",'."\n"
.' "cron":"0 0 1 */1 * ?"'."\n"
.'}'],
'InputParams' => ['description' => 'The input parameter configurations of the playbook. The value is in the JSONArray format.', 'type' => 'string', 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "typeName": "String",'."\n"
.' "dataClass": "normal",'."\n"
.' "dataType": "String",'."\n"
.' "description": "period",'."\n"
.' "example": "",'."\n"
.' "name": "period",'."\n"
.' "required": false'."\n"
.' }'."\n"
.']'],
'OutputParams' => ['description' => 'Playbooks do not support output parameter configurations. This parameter is empty.', 'type' => 'string', 'title' => '', 'example' => '[]'],
'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => '9030076b-6733-4842-b05a-xxxxxx', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"688B4CCD-5272-5DCF-9D76-FE5EFEF545F8\\",\\n \\"Config\\": {\\n \\"ParamType\\": \\"custom\\",\\n \\"ExeConfig\\": \\"{\\\\n \\\\\\"executeMode\\\\\\":\\\\\\"mul\\\\\\",\\\\n \\\\\\"cron\\\\\\":\\\\\\"0 0 1 */1 * ?\\\\\\"\\\\n}\\",\\n \\"InputParams\\": \\"[\\\\n {\\\\n \\\\\\"typeName\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"dataClass\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"dataType\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"example\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"period\\\\\\",\\\\n \\\\\\"required\\\\\\": false\\\\n }\\\\n]\\",\\n \\"OutputParams\\": \\"[]\\",\\n \\"PlaybookUuid\\": \\"9030076b-6733-4842-b05a-xxxxxx\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribePlaybookInputOutput',
'responseParamsDescription' => 'The **InputParams** parameter is in JSON array format. It contains the following fields:'."\n"
."\n"
.'- typeName: The name of the parameter type.'."\n"
."\n"
.'- dataClass: The class of the parameter type. Valid values include **normal** for a standard parameter and **custom** for a complex parameter.'."\n"
."\n"
.'- dataType: The data type of the parameter. Valid values: string, long, int, ip, file, and **account**.'."\n"
."\n"
.'- description: The description of the parameter.'."\n"
."\n"
.'- example: An example of the parameter value.'."\n"
."\n"
.'- name: The name of the parameter.'."\n"
."\n"
.'- required: Specifies whether the parameter is required. Valid values: **true** and **false**.',
'changeSet' => [
['createdAt' => '2024-03-21T02:56:44.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-03-15T02:09:26.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-01-16T08:25:46.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookInputOutput'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribePlaybookInputOutput',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribePlaybookMetrics' => [
'summary' => 'Queries playbook metadata, including its name, description, number of runs, and failure rate.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2a687089-d4dd-47d4-9709-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookCloudDTO>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and is used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '567D3D0B-2153-5860-BF9A-F9DEED55FB73'],
'Metrics' => [
'title' => '',
'description' => 'The details of the playbook.',
'type' => 'object',
'properties' => [
'DisplayName' => ['description' => 'The name of the playbook.', 'type' => 'string', 'title' => '', 'example' => 'demo name'],
'PlaybookUuid' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'title' => '', 'example' => '0fbc9bdb-9ae3-4ef4-a709-xxxxx'],
'OwnType' => ['description' => 'The type of the playbook. Valid values:'."\n"
."\n"
.'- **preset**: predefined playbook.'."\n"
."\n"
.'- **user**: custom playbook.', 'type' => 'string', 'title' => '', 'example' => 'user'],
'Active' => ['description' => 'The status of the playbook. Valid values:'."\n"
."\n"
.'- **1**: The playbook is enabled.'."\n"
."\n"
.'- **0**: The playbook is disabled.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'],
'LastRuntime' => ['description' => 'The time when the playbook was last run. The value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1683526277415'],
'GmtCreate' => ['description' => 'The time when the playbook was created. The value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1655277397000'],
'HistoryMd5' => ['description' => 'The number of historical versions of the playbook.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
'SuccNum' => ['description' => 'The number of successful playbook runs.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '100'],
'FailNum' => ['description' => 'The number of failed playbook runs.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'],
'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'This is a playbook for waf processing', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"567D3D0B-2153-5860-BF9A-F9DEED55FB73\\",\\n \\"Metrics\\": {\\n \\"DisplayName\\": \\"demo name\\",\\n \\"PlaybookUuid\\": \\"0fbc9bdb-9ae3-4ef4-a709-xxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1655277397000,\\n \\"HistoryMd5\\": 10,\\n \\"SuccNum\\": 100,\\n \\"FailNum\\": 10,\\n \\"Description\\": \\"This is a playbook for waf processing\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribePlaybookMetrics',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribePlaybookMetrics',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribePlaybookNodesOutput' => [
'summary' => 'Retrieves the historical output data of a component.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['description' => 'The name of the component node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DataFormat_1'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookNodeOutput>',
'description' => 'The response that is returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A491170C-FE1F-520E-83D4-72ED205B72ED'],
'PlaybookNodesOutput' => [
'title' => '',
'description' => 'The output data of the node.',
'type' => 'object',
'properties' => [
'NodeName' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''],
'NodeOutput' => ['description' => 'The historical output data of the component. The data is in the JSON format. If no data exists, this parameter is empty.', 'type' => 'string', 'example' => '{'."\n"
.' "datalist": ['."\n"
.' {'."\n"
.' "score": "10",'."\n"
.' "ip": "1.1.1.1"'."\n"
.' }'."\n"
.' ],'."\n"
.' "total_data_successful": 1,'."\n"
.' "filter_total_data": 1,'."\n"
.' "total_data": 1,'."\n"
.' "total_exe_successful": 1,'."\n"
.' "total_exe": 1,'."\n"
.' "total_data_with_dup": 1,'."\n"
.' "filter_total_data_successful": 1,'."\n"
.' "status": true'."\n"
.'}', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A491170C-FE1F-520E-83D4-72ED205B72ED\\",\\n \\"PlaybookNodesOutput\\": {\\n \\"NodeName\\": \\"DataFormat_1\\",\\n \\"NodeOutput\\": \\"{\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"score\\\\\\": \\\\\\"10\\\\\\",\\\\n \\\\\\"ip\\\\\\": \\\\\\"1.1.1.1\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"filter_total_data\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"filter_total_data_successful\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n}\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribePlaybookNodesOutput',
'responseParamsDescription' => 'The **NodeOutput** parameter is a JSON object that contains the following fields:'."\n"
."\n"
.'- **datalist**: The details of the output data.'."\n"
."\n"
.'- **total\\_data\\_successful**: The number of successfully processed data entries.'."\n"
."\n"
.'- **total\\_data**: The total number of data entries.'."\n"
."\n"
.'- **total\\_exe\\_successful**: The number of successful executions.'."\n"
."\n"
.'- **total\\_exe**: The total number of executions.'."\n"
."\n"
.'- **total\\_data\\_with\\_dup**: The number of duplicate data entries.'."\n"
."\n"
.'- **status**: Indicates whether the execution was successful. A value of **true** indicates success and a value of **false** indicates failure.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNodesOutput'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'yundun-sas:DescribePlaybookNodesOutput',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribePlaybookNumberMetrics' => [
'summary' => 'Retrieves metrics for the response orchestration product, including the total number of playbooks and the number of enabled playbooks.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookMetrics>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'Metrics' => [
'title' => '',
'description' => 'The statistics.',
'type' => 'object',
'properties' => [
'TotalNum' => ['description' => 'The total number of playbooks.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'StartUpNum' => ['description' => 'The number of enabled playbooks.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''],
],
'example' => '',
],
'RequestId' => ['description' => 'The unique ID of the request. If you have an issue with a request, provide this ID for troubleshooting.', 'type' => 'string', 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Metrics\\": {\\n \\"TotalNum\\": 100,\\n \\"StartUpNum\\": 50\\n },\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\"\\n}","type":"json"}]',
'title' => 'DescribePlaybookNumberMetrics',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribePlaybookNumberMetrics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribePlaybookReleases' => [
'summary' => 'Queries a list of published versions of a playbook.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Default value: 20. If you do not specify this parameter, 10 entries are returned.'."\n"
."\n"
.'> Specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<SaoReleaseInfo>>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '3DFBE11C-6EB6-5166-92D6-3397796AFE1E'],
'Records' => [
'title' => '',
'description' => 'A list of playbook versions.',
'type' => 'array',
'items' => [
'description' => 'The version information.',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The record ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '80xxx', 'title' => ''],
'GmtCreate' => ['description' => 'The time when the version was created. This is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1655277397000'],
'GmtModified' => ['description' => 'The time when the version was last modified. This is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1691460804000'],
'Creator' => ['description' => 'The ID of the Alibaba Cloud account that published the version.', 'type' => 'string', 'title' => '', 'example' => '145xxxx985'],
'Description' => ['description' => 'The description of the version.', 'type' => 'string', 'title' => '', 'example' => 'This is a new version'],
'TaskflowMd5' => ['description' => 'The MD5 hash of the playbook configuration for the published version.', 'type' => 'string', 'title' => '', 'example' => 'be0a4ef084dd174abe47xxxxx'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3DFBE11C-6EB6-5166-92D6-3397796AFE1E\\",\\n \\"Records\\": [\\n {\\n \\"Id\\": 0,\\n \\"GmtCreate\\": 1655277397000,\\n \\"GmtModified\\": 1691460804000,\\n \\"Creator\\": \\"145xxxx985\\",\\n \\"Description\\": \\"This is a new version\\",\\n \\"TaskflowMd5\\": \\"be0a4ef084dd174abe47xxxxx\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'DescribePlaybookReleases',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribePlaybookReleases',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribePlaybooks' => [
'summary' => 'Queries a list of playbooks.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '167066',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Active',
'in' => 'query',
'schema' => ['title' => '剧本的状态', 'description' => 'The status of the playbook. Valid values:'."\n"
."\n"
.'- **1**: The playbook is enabled.'."\n"
."\n"
.'- **0**: The playbook is disabled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'OwnType',
'in' => 'query',
'schema' => ['title' => '剧本的类型', 'description' => 'The type of the playbook. Valid values:'."\n"
."\n"
.'- **preset**: predefined playbook.'."\n"
."\n"
.'- **user**: custom playbook.', 'type' => 'string', 'required' => false, 'example' => 'user'],
],
[
'name' => 'StartMillis',
'in' => 'query',
'schema' => ['title' => '开始时间', 'description' => 'The start of the time range to query. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526277415'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['title' => '结束时间', 'description' => 'The end of the time range to query. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683858064361'],
],
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['title' => '剧本UUID', 'description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [CreatePlaybook](~~CreatePlaybook~~) operation to obtain this parameter.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx'],
],
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '剧本名称', 'description' => 'The name of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'demo_playbook'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the request and response. Default value: **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned by default.'."\n"
."\n"
.'> Specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the page to return. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Sort',
'in' => 'query',
'schema' => ['title' => '排序依据 1-上次修改时间 2-最近执行时间', 'description' => 'The field to sort by. Default value: **1**. Valid values:'."\n"
."\n"
.'- **1**: last modification time.'."\n"
."\n"
.'- **2**: last running time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Order',
'in' => 'query',
'schema' => ['title' => '排序逻辑:desc asc,默认desc', 'description' => 'The sort order. Default value: **desc**. Valid values:'."\n"
."\n"
.'- **desc**: descending.'."\n"
."\n"
.'- **asc**: ascending.', 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'ParamTypes',
'in' => 'query',
'schema' => ['description' => 'The trigger type of the playbook. If you do not specify this parameter, playbooks of all trigger types are queried. Valid values:'."\n"
."\n"
.'- **template-incident**: security event.'."\n"
."\n"
.'- **template-ip**: IP entity.'."\n"
."\n"
.'- **template-file**: file entity.'."\n"
."\n"
.'- **template-process**: process entity.'."\n"
."\n"
.'- **template-alert**: security alert.'."\n"
."\n"
.'- **template-domain**: domain name entity.'."\n"
."\n"
.'- **template-container**: container entity.'."\n"
."\n"
.'- **template-host**: host entity.'."\n"
."\n"
.'- **template-custom**: custom.', 'type' => 'string', 'required' => false, 'example' => 'template-alert', 'title' => ''],
],
[
'name' => 'PlaybookUuids',
'in' => 'query',
'schema' => ['description' => 'A comma-separated list of playbook UUIDs. You can specify up to 100 UUIDs.', 'type' => 'string', 'required' => false, 'example' => '8baa6cff-319e-4ede-97bc-1xxxxxx,8rrt6cff-319e-4ede-97bc-1xxxxxx', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<PlaybookCloudDTO>>',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The request ID. This ID is generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => '138B5AB7-****-5814-87A3-E3E****F207E'],
'Playbooks' => [
'title' => '传输的数据',
'description' => 'The list of playbooks.',
'type' => 'array',
'items' => [
'description' => 'The information about the playbook.',
'type' => 'object',
'properties' => [
'DisplayName' => ['title' => '剧本的名称', 'description' => 'The display name of the playbook.', 'type' => 'string', 'example' => 'demo_playbook'],
'PlaybookUuid' => ['title' => '剧本的UUID', 'description' => 'The UUID of the playbook.', 'type' => 'string', 'example' => 'bb5a8640-a14f-44ef-8376-cxxxxx'],
'OwnType' => ['title' => '剧本的权限类型', 'description' => 'The type of the playbook. Valid values:'."\n"
."\n"
.'- **preset**: predefined playbook.'."\n"
."\n"
.'- **user**: custom playbook.', 'type' => 'string', 'example' => 'user'],
'Active' => ['title' => '剧本的启用状态', 'description' => 'The status of the playbook. Valid values:'."\n"
."\n"
.'- **1**: The playbook is enabled.'."\n"
."\n"
.'- **0**: The playbook is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'LastRuntime' => ['title' => '剧本的最后执行时间', 'description' => 'The last time the playbook was run. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'],
'GmtCreate' => ['title' => '剧本创建时间', 'description' => 'The time when the playbook was created. This value is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683526277415'],
'GmtModified' => ['title' => '剧本修改时间', 'description' => 'The time when the playbook was modified.', 'type' => 'string', 'example' => '1681396398000'],
'ParamType' => ['description' => 'The trigger type of the playbook. Valid values:'."\n"
."\n"
.'- **template-incident**: security event.'."\n"
."\n"
.'- **template-ip**: IP entity.'."\n"
."\n"
.'- **template-file**: file entity.'."\n"
."\n"
.'- **template-process**: process entity.'."\n"
."\n"
.'- **template-alert**: security alert.'."\n"
."\n"
.'- **template-domain**: domain name entity.'."\n"
."\n"
.'- **template-container**: container entity.'."\n"
."\n"
.'- **template-host**: host entity.', 'type' => 'string', 'example' => 'template-alert', 'title' => ''],
'Description' => ['description' => 'The description of the playbook.', 'type' => 'string', 'example' => 'aegis_kill_process', 'title' => ''],
'TenantId' => ['description' => 'The ID of the user to which the playbook belongs.', 'type' => 'string', 'example' => '123456', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"138B5AB7-****-5814-87A3-E3E****F207E\\",\\n \\"Playbooks\\": [\\n {\\n \\"DisplayName\\": \\"demo_playbook\\",\\n \\"PlaybookUuid\\": \\"bb5a8640-a14f-44ef-8376-cxxxxx\\",\\n \\"OwnType\\": \\"user\\",\\n \\"Active\\": 1,\\n \\"LastRuntime\\": 1683526277415,\\n \\"GmtCreate\\": 1683526277415,\\n \\"GmtModified\\": \\"1681396398000\\",\\n \\"ParamType\\": \\"template-alert\\",\\n \\"Description\\": \\"aegis_kill_process\\",\\n \\"TenantId\\": \\"123456\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'Get Playbook List',
'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for Security Orchestration, Automation, and Response (SOAR).',
'changeSet' => [
['createdAt' => '2025-04-10T12:08:27.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-04-08T11:52:10.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-02-24T09:31:52.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-02-14T05:49:40.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-01-22T03:42:28.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2024-11-01T08:32:26.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybooks'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribePlaybooks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/*'],
],
],
],
],
],
'DescribePopApi' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PopCode',
'in' => 'query',
'schema' => ['description' => 'The POP code of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'Sas', 'title' => ''],
],
[
'name' => 'ApiVersion',
'in' => 'query',
'schema' => ['description' => 'The version number of the API.', 'type' => 'string', 'required' => true, 'example' => '2021-10-01', 'title' => ''],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'The name of the Alibaba Cloud product API.', 'type' => 'string', 'required' => true, 'example' => 'DescribeInstanceInfo', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<ListApiMetaResponse>',
'description' => 'The response contains the requested information.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '1A01B0BA-****-5813-****-A5DA15FA95AE'],
'PopCode' => ['description' => 'The POP code of the Alibaba Cloud product API.', 'type' => 'string', 'example' => 'Sas', 'title' => ''],
'Version' => ['description' => 'The version number of the API.', 'type' => 'string', 'example' => '2019-09-10', 'title' => ''],
'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'AddAssetCleanConfig', 'title' => ''],
'OpenApiMetaList' => [
'description' => 'List of API information.',
'type' => 'array',
'items' => [
'description' => 'Detailed information.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'DescribePopApi', 'title' => ''],
'Required' => ['description' => 'Indicates whether the parameter is required.'."\n"
."\n"
.'- **true**: required.'."\n"
."\n"
.'- **false**: not required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'ExampleValue' => ['description' => 'The example value.', 'type' => 'string', 'example' => '12.xx.xx.xx', 'title' => ''],
'Description' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'demo parameter', 'title' => ''],
'Type' => ['description' => 'The data type of the parameter. Valid values:'."\n"
."\n"
.'- **string**: a string.'."\n"
."\n"
.'- **boolean**: a Boolean value.'."\n"
."\n"
.'- **integer**: an integer.'."\n"
."\n"
.'- **long**: a long integer.', 'type' => 'string', 'example' => 'string', 'title' => ''],
'Style' => ['description' => 'The serialization method for an array parameter. Valid values:'."\n"
."\n"
.'- **repeatList**: An array is serialized in the XXX.N format. Example: Instance.1=i-instance1&\\&Instance.2=i-instance2.'."\n"
."\n"
.'- **simple**: An array is serialized as a comma-separated string. Example: i-instance1,i-instance2.'."\n"
."\n"
.'- **spaceDelimited**: An array is serialized as a space-separated string. Example: i-instance1 i-instance2.'."\n"
."\n"
.'- **pipeDelimited**: An array is serialized as a pipe-separated string. Example: i-instance1|i-instance2.'."\n"
."\n"
.'- **json**: An array is serialized in JSON format. Example: \\["i-instance1","i-instance2"].'."\n"
."\n"
.'- **flat**: An array is serialized in the XXX.N format. Example: Instance.1=i-instance1\\&Instance.2=i-instance2.', 'type' => 'string', 'example' => 'json', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DescribePopApi',
'summary' => 'Retrieves the details of an OpenAPI.',
'changeSet' => [
['createdAt' => '2025-05-15T01:38:42.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-04-08T09:37:47.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePopApi'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribePopApi',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A01B0BA-****-5813-****-A5DA15FA95AE\\",\\n \\"PopCode\\": \\"Sas\\",\\n \\"Version\\": \\"2019-09-10\\",\\n \\"ApiName\\": \\"AddAssetCleanConfig\\",\\n \\"OpenApiMetaList\\": [\\n {\\n \\"Name\\": \\"DescribePopApi\\",\\n \\"Required\\": false,\\n \\"ExampleValue\\": \\"12.xx.xx.xx\\",\\n \\"Description\\": \\"demo parameter\\",\\n \\"Type\\": \\"string\\",\\n \\"Style\\": \\"json\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeProcessStatistics' => [
'summary' => 'Retrieves statistics information.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '208550',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The view type. Valid values:'."\n"
."\n"
.'- 0 (default): the view of the current Alibaba Cloud account.'."\n"
.'- 1: the view of all accounts in the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The user ID of the member to which the administrator switches the view.', 'type' => 'string', 'required' => false, 'example' => '1709821xxxxx3093', 'title' => ''],
],
[
'name' => 'ProcessActionStart',
'in' => 'query',
'schema' => ['description' => 'The start time of the query for response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17000XXX83572', 'title' => ''],
],
[
'name' => 'ProcessActionEnd',
'in' => 'query',
'schema' => ['description' => 'The end time of the query for response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17561XXX77435', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'SophonResult<ProcessMetricsDTO>',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => '4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F'],
'Metrics' => [
'title' => '',
'description' => 'The returned result data.',
'type' => 'object',
'properties' => [
'TaskNum' => ['description' => 'The number of response tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'BanIpNum' => ['description' => 'The number of blocked IP addresses.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'BanFileNum' => ['description' => 'The number of blocked files.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'BanProcessNum' => ['description' => 'The number of blocked processes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CFC0F8A-D600-5FFF-A0DF-3121C4C1B90F\\",\\n \\"Metrics\\": {\\n \\"TaskNum\\": 1,\\n \\"BanIpNum\\": 1,\\n \\"BanFileNum\\": 1,\\n \\"BanProcessNum\\": 1\\n }\\n}","type":"json"}]',
'title' => 'Retrieve statistics of response tasks',
'description' => 'Make sure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (Cloud Threat Detection and Response (CTDR) log traffic) before you call this operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessStatistics'],
],
],
'ramActions' => [],
],
'DescribeProcessTaskCount' => [
'summary' => 'Queries the count of response tasks associated with an entity UUID.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '245000',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'EntityUuidList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '实体的entityUuid集合',
'description' => 'The UUIDs of the entities.',
'type' => 'array',
'items' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'required' => false, 'example' => 'a680c9ae-****-4c39-****-0302****fc8e', 'title' => ''],
'required' => true,
'maxItems' => 100,
'example' => '',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The view type.'."\n"
."\n"
.'- **0**: The view of the current Alibaba Cloud account.'."\n"
."\n"
.'- **1**: The view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The UID of the member whose permissions you want to use to call the operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '104739******259', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<ProcessTaskNumberDTO>>',
'description' => 'The data that is returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'e866cce0-****-41de-817e-****8d5e2650'],
'Data' => [
'title' => '传输的数据',
'description' => 'The data that is returned.',
'type' => 'array',
'items' => [
'description' => 'The result set.',
'type' => 'object',
'properties' => [
'EntityUuid' => ['title' => '实体uuid', 'description' => 'The UUID of the entity.', 'type' => 'string', 'example' => 'a680c9ae-****-4c39-****-0302****fc8e'],
'Count' => ['title' => '数量', 'description' => 'The number of tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '67'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"e866cce0-****-41de-817e-****8d5e2650\\",\\n \\"Data\\": [\\n {\\n \\"EntityUuid\\": \\"a680c9ae-****-4c39-****-0302****fc8e\\",\\n \\"Count\\": 67\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query the Number of Associated Disposal Tasks by Entity UUID',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTaskCount'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeProcessTaskNumber',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeProcessTasks' => [
'summary' => 'Retrieves a list of response tasks.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '186031',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'ProcessStrategyUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the response policy.'."\n"
."\n"
.'> Call the [ListDisposeStrategy](~~2584440~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****'],
],
[
'name' => 'EntityName',
'in' => 'query',
'schema' => ['description' => 'The name of the entity to which the response is performed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '127.0.0.1'],
],
[
'name' => 'EntityType',
'in' => 'query',
'schema' => ['description' => 'The type of the entity to which the response is performed. Valid values:'."\n"
."\n"
.'- **ip**: an IP address.'."\n"
."\n"
.'- **file**: a file.'."\n"
."\n"
.'- **process**: a process.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ip'],
],
[
'name' => 'SceneCode',
'in' => 'query',
'schema' => ['description' => 'The code of the response scenario.'."\n"
."\n"
.'> Call the [DescribeEnumItems](~~DescribeEnumItems~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'event_xxx_whole_process'],
],
[
'name' => 'TaskStatus',
'in' => 'query',
'schema' => ['description' => 'The statuses of the response tasks. The value is a string in an array format. Valid values:'."\n"
."\n"
.'- **11**: The task is in progress.'."\n"
."\n"
.'- **21**: The entity is being blocked.'."\n"
."\n"
.'- **22**: The entity is in isolation.'."\n"
."\n"
.'- **23**: The task is complete.'."\n"
."\n"
.'- **24**: The entity is added to the whitelist.'."\n"
."\n"
.'- **20**: The task is successful.'."\n"
."\n"
.'- **90**: The task failed.'."\n"
."\n"
.'- **91**: Unblocking failed.'."\n"
."\n"
.'- **92**: Removing the entity from isolation failed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '["11","21"]'],
],
[
'name' => 'Scope',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account for which the response task is performed.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '125xxxxx9870'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['description' => 'The source that triggers the response task. The value is a string in an array format. Valid values:'."\n"
."\n"
.'- **system**: The task is triggered by manually responding to an event.'."\n"
."\n"
.'- **custom**: The task is triggered by an automatic response rule for an event.'."\n"
."\n"
.'- **custom\\_alert**: The task is triggered by an automatic response rule for an alert.'."\n"
."\n"
.'- **soar-manual**: The task is triggered by a playbook that is manually run in Security Orchestration Automation Response (SOAR).'."\n"
."\n"
.'- **soar-mdr**: The task is triggered by Managed Security Service.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '["system"]'],
],
[
'name' => 'ProcessActionStart',
'in' => 'query',
'schema' => ['description' => 'The start of the time range to query response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'],
],
[
'name' => 'ProcessActionEnd',
'in' => 'query',
'schema' => ['description' => 'The end of the time range to query response tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'],
],
[
'name' => 'ProcessRemoveStart',
'in' => 'query',
'schema' => ['description' => 'The start of the time range to query unblocking tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'],
],
[
'name' => 'ProcessRemoveEnd',
'in' => 'query',
'schema' => ['description' => 'The end of the time range to query unblocking tasks. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1700031183572'],
],
[
'name' => 'ParamContent',
'in' => 'query',
'schema' => ['description' => 'The keyword for a fuzzy search. The operation queries the entity, response scenario, and response parameter fields.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '12.x.x.x'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you do not specify this parameter, 10 entries are returned.'."\n"
."\n"
.'> Specify this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number to return. Default value: 1. This value indicates the first page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'YunCode',
'in' => 'query',
'schema' => ['description' => 'The cloud service associated with the response task. The value is a string in an array format. Valid values:'."\n"
."\n"
.'- **WAF**: Web Application Firewall'."\n"
."\n"
.'- **CFW**: Cloud Firewall'."\n"
."\n"
.'- **Aegis**: Security Center', 'type' => 'string', 'required' => false, 'example' => '["WAF"]', 'title' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => 'The unique ID of the response task.'."\n"
."\n"
.'> Use this parameter to query a specific task. You can obtain the task ID from the response to a previous request.', 'type' => 'string', 'required' => false, 'example' => '150xxxxxxxxx95066', 'title' => ''],
],
[
'name' => 'OrderField',
'in' => 'query',
'schema' => ['description' => 'The field by which to sort the query results.'."\n"
."\n"
.'> You can obtain the field from the response.', 'type' => 'string', 'required' => false, 'example' => 'gmtCreate', 'title' => ''],
],
[
'name' => 'Direction',
'in' => 'query',
'schema' => ['description' => 'The sort order. Valid values:'."\n"
."\n"
.'- **desc**: descending (default)'."\n"
."\n"
.'- **asc**: ascending', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''],
],
[
'name' => 'EntityUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n"],
],
[
'name' => 'EventUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the event.', 'type' => 'string', 'required' => false, 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****', 'title' => ''],
],
[
'name' => 'TriggerSource',
'in' => 'query',
'schema' => ['description' => 'The source that triggers the response task. Valid values:'."\n"
."\n"
.'- **system**: The task is triggered by manually responding to an event.'."\n"
."\n"
.'- **custom**: The task is triggered by an automatic response rule for an event.'."\n"
."\n"
.'- **custom\\_alert**: The task is triggered by an automatic response rule for an alert.'."\n"
."\n"
.'- **soar-manual**: The task is triggered by a playbook that is manually run in SOAR.'."\n"
."\n"
.'- **soar-mdr**: The task is triggered by Managed Security Service.', 'type' => 'string', 'required' => false, 'example' => 'system', 'title' => ''],
],
[
'name' => 'ReqUuid',
'in' => 'query',
'schema' => ['description' => 'The playbook trigger ID.', 'type' => 'string', 'required' => false, 'example' => 'b73d0b08-f1bd-4e8f-967a-8e2982c9****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<ProcessTaskDTO>>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'],
'ProcessTasks' => [
'title' => '',
'description' => 'A list of response tasks.',
'type' => 'array',
'items' => [
'description' => 'The details of the response task.',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => 'The unique ID of the response task.', 'type' => 'string', 'example' => '150xxxxxxxxx95066', 'title' => ''],
'Creator' => ['description' => 'The ID of the Alibaba Cloud account that submitted the response task.', 'type' => 'string', 'title' => '', 'example' => '123xxxx355'],
'GmtCreateMillis' => ['description' => 'The time when the response task was created. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'],
'GmtModifiedMillis' => ['description' => 'The time when the response task was last modified. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'],
'YunCode' => ['description' => 'The code of the cloud service that is associated with the response task.', 'type' => 'string', 'title' => '', 'example' => 'WAF'],
'EntityName' => ['description' => 'The name of the entity to which the response was performed.', 'type' => 'string', 'title' => '', 'example' => '1.1.1.x'],
'EntityType' => ['description' => 'The type of the entity to which the response was performed.', 'type' => 'string', 'title' => '', 'example' => 'ip'],
'TaskStatus' => ['description' => 'The status of the response task.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '11'],
'Scope' => ['description' => 'The ID of the Alibaba Cloud account for which the response task was performed.', 'type' => 'string', 'title' => '', 'example' => '123xxxxx234'],
'InputParams' => ['description' => 'The input parameters of the response task.', 'type' => 'string', 'title' => '', 'example' => '{"groupuuid":"c6a9b1df-f4ac-4078-bef4-99xxxxxx"}'],
'SceneCode' => ['description' => 'The code of the response scenario.', 'type' => 'string', 'title' => '', 'example' => 'event_xxx_whole_process'],
'SceneName' => ['description' => 'The name of the response scenario.', 'type' => 'string', 'title' => '', 'example' => 'waf_whole_process'],
'ProcessTime' => ['description' => 'The time when the response task was delivered. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'],
'RemoveTime' => ['description' => 'The time when the entity was unblocked. This value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1700031183572'],
'ProcessStrategyUuid' => ['description' => 'The ID of the associated policy.', 'type' => 'string', 'title' => '', 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536_****'],
'Source' => ['description' => 'The source from which the response task was submitted.', 'type' => 'string', 'example' => 'system', 'title' => ''],
'ErrCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'sts_openapi.Info.DefenseSceneNotSupported', 'title' => ''],
'ErrMsg' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ParamError : The parameters of your request are invalid', 'title' => ''],
'ErrTip' => ['description' => 'The error message details.', 'type' => 'string', 'example' => 'Verify that the input parameters of the components are correct', 'title' => ''],
'EntityUuid' => ['description' => 'The UUID of the entity.', 'type' => 'string', 'example' => '69d189e2-ec17-4676-a2fe-02969234****'."\n", 'title' => ''],
'EventUuid' => ['description' => 'The UUID of the event.', 'type' => 'string', 'example' => 'c1020ce1-d6a5-11e8-8298-00163e10****'."\n", 'title' => ''],
'ReqUuid' => ['description' => 'The UUID of the playbook execution record.', 'type' => 'string', 'example' => '93e5df20-3d03-42e1-b44b-58197c71****'."\n", 'title' => ''],
'TriggerSource' => ['description' => 'The source that triggers the response task. Valid values:'."\n"
."\n"
.'- **system**: The task is triggered by manually responding to an event.'."\n"
."\n"
.'- **custom**: The task is triggered by an automatic response rule for an event.'."\n"
."\n"
.'- **custom\\_alert**: The task is triggered by an automatic response rule for an alert.'."\n"
."\n"
.'- **soar-manual**: The task is triggered by a playbook that is manually run in SOAR.'."\n"
."\n"
.'- **soar-mdr**: The task is triggered by Managed Security Service.', 'type' => 'string', 'example' => 'system', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"ProcessTasks\\": [\\n {\\n \\"TaskId\\": \\"150xxxxxxxxx95066\\",\\n \\"Creator\\": \\"123xxxx355\\",\\n \\"GmtCreateMillis\\": 1700031183572,\\n \\"GmtModifiedMillis\\": 1700031183572,\\n \\"YunCode\\": \\"WAF\\",\\n \\"EntityName\\": \\"1.1.1.x\\",\\n \\"EntityType\\": \\"ip\\",\\n \\"TaskStatus\\": 11,\\n \\"Scope\\": \\"123xxxxx234\\",\\n \\"InputParams\\": \\"{\\\\\\"groupuuid\\\\\\":\\\\\\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\\\\\\"}\\",\\n \\"SceneCode\\": \\"event_xxx_whole_process\\",\\n \\"SceneName\\": \\"waf_whole_process\\",\\n \\"ProcessTime\\": 1700031183572,\\n \\"RemoveTime\\": 1700031183572,\\n \\"ProcessStrategyUuid\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536_****\\",\\n \\"Source\\": \\"system\\",\\n \\"ErrCode\\": \\"sts_openapi.Info.DefenseSceneNotSupported\\",\\n \\"ErrMsg\\": \\"ParamError : The parameters of your request are invalid\\",\\n \\"ErrTip\\": \\"Verify that the input parameters of the components are correct\\",\\n \\"EntityUuid\\": \\"69d189e2-ec17-4676-a2fe-02969234****\\\\n\\",\\n \\"EventUuid\\": \\"c1020ce1-d6a5-11e8-8298-00163e10****\\\\n\\",\\n \\"ReqUuid\\": \\"93e5df20-3d03-42e1-b44b-58197c71****\\\\n\\",\\n \\"TriggerSource\\": \\"system\\"\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'DescribeProcessTasks',
'description' => 'Before you call this operation, review the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for Threat Analysis and Response. Response orchestration is billed based on the volume of ingested log traffic.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTasks'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeProcessTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeSoarRecordActionOutputList' => [
'summary' => 'Retrieves the output data generated by a component for an action in a playbook task.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ActionUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the component action.'."\n"
."\n"
.'> Call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) operation to get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2202c90d-fa93-4726-bc32-xxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Default value: **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned.'."\n"
."\n"
.'> We recommend that you specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number of the results to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. It is a unique identifier generated by Alibaba Cloud. You can use it to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90'],
'ActionOutputs' => ['description' => 'The output data from the component action. The data is in the JSONArray format.'."\n"
."\n"
.'> The data format is determined by the component that you configure in the playbook.', 'type' => 'string', 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "a": "a",'."\n"
.' "taskname": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",'."\n"
.' "log_time": 1699868849000'."\n"
.' }'."\n"
.']'],
'PageNumber' => ['description' => 'The returned page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A2BF9CF-3E32-5E45-A79B-8F67E0A4FE90\\",\\n \\"ActionOutputs\\": \\"[\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\",\\\\n \\\\\\"taskname\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbd1e45536_xxxx\\\\\\",\\\\n \\\\\\"log_time\\\\\\": 1699868849000\\\\n }\\\\n]\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
'title' => 'DescribeSoarRecordActionOutputList',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordActionOutputList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeSoarRecordActionOutputList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeSoarRecordInOutput' => [
'summary' => 'Retrieves the input and output data of a component action after a playbook task is executed.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ActionUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the component action.'."\n"
."\n"
.'> Call the [DescribeSoarTaskAndActions](~~DescribeSoarTaskAndActions~~) API to get this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0531ff66-dd05-4f24-84bf-xxxxxxxx'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '372D8B41-AF8D-573A-9B3F-0924950F241F'],
'InOutputInfo' => ['description' => 'The execution result of the component action.', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "actionUuid": "3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx",'."\n"
.' "outputSummary": {'."\n"
.' "datalist": ['."\n"
.' {'."\n"
.' "a": "a"'."\n"
.' }'."\n"
.' ],'."\n"
.' "total_data_successful": 1,'."\n"
.' "total_data": 1,'."\n"
.' "total_exe_successful": 1,'."\n"
.' "total_exe": 1,'."\n"
.' "total_data_with_dup": 1,'."\n"
.' "status": true'."\n"
.' },'."\n"
.' "outputSchema": {'."\n"
.' "a": "String",'."\n"
.' "startTime": "DateTime"'."\n"
.' },'."\n"
.' "inputParams": {'."\n"
.' "inputData": ['."\n"
.' {'."\n"
.' "outputFields": {'."\n"
.' "a": "a"'."\n"
.' }'."\n"
.' }'."\n"
.' ],'."\n"
.' "totalSize": 1'."\n"
.' },'."\n"
.' "startTime": "2023-11-13 17:47:28.645",'."\n"
.' "taskName": "92af3c79-1754-4646-9366-9ddbxxxxx"'."\n"
.'}'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"372D8B41-AF8D-573A-9B3F-0924950F241F\\",\\n \\"InOutputInfo\\": \\"{\\\\n \\\\\\"actionUuid\\\\\\": \\\\\\"3896a25d-4967-493c-942e-4e60f27da1f7-xxxxx\\\\\\",\\\\n \\\\\\"outputSummary\\\\\\": {\\\\n \\\\\\"datalist\\\\\\": [\\\\n {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"total_data_successful\\\\\\": 1,\\\\n \\\\\\"total_data\\\\\\": 1,\\\\n \\\\\\"total_exe_successful\\\\\\": 1,\\\\n \\\\\\"total_exe\\\\\\": 1,\\\\n \\\\\\"total_data_with_dup\\\\\\": 1,\\\\n \\\\\\"status\\\\\\": true\\\\n },\\\\n \\\\\\"outputSchema\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"DateTime\\\\\\"\\\\n },\\\\n \\\\\\"inputParams\\\\\\": {\\\\n \\\\\\"inputData\\\\\\": [\\\\n {\\\\n \\\\\\"outputFields\\\\\\": {\\\\n \\\\\\"a\\\\\\": \\\\\\"a\\\\\\"\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"totalSize\\\\\\": 1\\\\n },\\\\n \\\\\\"startTime\\\\\\": \\\\\\"2023-11-13 17:47:28.645\\\\\\",\\\\n \\\\\\"taskName\\\\\\": \\\\\\"92af3c79-1754-4646-9366-9ddbxxxxx\\\\\\"\\\\n}\\"\\n}","type":"json"}]',
'title' => 'DescribeSoarRecordInOutput',
'responseParamsDescription' => '**InOutputInfo** is a JSON string that contains the following fields:'."\n"
."\n"
.'- **actionUuid**: The UUID of the component action execution record.'."\n"
."\n"
.'- **startTime**: The time when the component action started.'."\n"
."\n"
.'- **taskName**: The name of the playbook task that corresponds to the component action.'."\n"
."\n"
.'- **outputSchema**: The metadata of the action\'s output data. This is in JSON format and is defined during playbook orchestration.'."\n"
."\n"
.'- **outputSummary**: The output parameters of the action. This is in JSON format and contains the following fields:'."\n"
."\n"
.' - **datalist**: The details of the output data.'."\n"
."\n"
.' - **total\\_data\\_successful**: The number of successfully executed data entries.'."\n"
."\n"
.' - **total\\_data**: The total number of data entries.'."\n"
."\n"
.' - **total\\_exe\\_successful**: The number of successful executions.'."\n"
."\n"
.' - **total\\_exe**: The total number of executions.'."\n"
."\n"
.' - **total\\_data\\_with\\_dup**: The number of duplicate data entries.'."\n"
."\n"
.' - **status**: Indicates whether the execution was successful. **true** indicates success, and **false** indicates failure.'."\n"
."\n"
.'- **inputParams**: The input data for the action. This is in JSON format and contains the following fields:'."\n"
."\n"
.' - **inputData**: The specific input data for the action.'."\n"
."\n"
.' - **totalSize**: The number of input data entries for the action.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordInOutput'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeSoarRecordInOutput',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeSoarRecords' => [
'summary' => 'Queries the execution records for a playbook.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['title' => '剧本的UUID', 'description' => 'The UUID of the playbook.'."\n"
."\n"
.'> For more information, see [DescribePlaybooks](~~DescribePlaybooks~~).', 'type' => 'string', 'required' => false, 'example' => '8f55e76d-b5d5-4720-9cd7-xxxxx'],
],
[
'name' => 'TaskflowMd5',
'in' => 'query',
'schema' => ['title' => '任务的版本ID', 'description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'required' => false, 'example' => 'be0a4ef084dd174abe478df52xxxxx'],
],
[
'name' => 'StartMillis',
'in' => 'query',
'schema' => ['title' => '任务开始时间', 'description' => 'The start time of the task run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526284584'],
],
[
'name' => 'EndMillis',
'in' => 'query',
'schema' => ['title' => '任务结束时间', 'description' => 'The end time of the task run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683772744953'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Default value: **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'TriggerUser',
'in' => 'query',
'schema' => ['description' => 'The ID of the Alibaba Cloud account that runs the playbook task.', 'type' => 'string', 'required' => false, 'example' => '127xxxx4392', 'title' => ''],
],
[
'name' => 'TaskStatus',
'in' => 'query',
'schema' => ['description' => 'The status of the task run. Valid values:'."\n"
."\n"
.'- **success**: The task is successful.'."\n"
."\n"
.'- **failed**: The task failed.'."\n"
."\n"
.'- **inprogress**: The task is in progress.', 'type' => 'string', 'required' => false, 'example' => 'inprogress', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Default value: 20. If you leave this parameter empty, 10 entries are returned on each page.'."\n"
."\n"
.'> Specify a value for PageSize.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'RequestUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook task execution.'."\n"
."\n"
.'> For more information, see [DescribeSoarRecords](~~2627455~~).', 'type' => 'string', 'required' => false, 'example' => '6d412cfa-0905-4567-8a83-xxxxxx', 'title' => ''],
],
[
'name' => 'TriggerType',
'in' => 'query',
'schema' => ['description' => 'The trigger type of the task. Valid values:'."\n"
."\n"
.'- **stream**: stream'."\n"
."\n"
.'- **debug**: test'."\n"
."\n"
.'- **manual**: manual'."\n"
."\n"
.'- **timer**: scheduled'."\n"
."\n"
.'- **SubInvoke**: child flow'."\n"
."\n"
.'- **siem**: triggered by a SIEM product', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''],
],
[
'name' => 'QueryValue',
'in' => 'query',
'schema' => ['description' => 'The input parameter of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'input', 'title' => ''],
],
[
'name' => 'CompletedBeginTime',
'in' => 'query',
'schema' => ['description' => 'The start time when the task was completed. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1755676363777', 'title' => ''],
],
[
'name' => 'CompletedEndTime',
'in' => 'query',
'schema' => ['description' => 'The end time when the task was completed. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1683526284584', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<SaoExecuteInfo>>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The unique request ID, generated by Alibaba Cloud. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '601C2DAC-6A67-5237-BEE8-5BF1CEE9*****'],
'SoarExecuteRecords' => [
'title' => '传输的数据',
'description' => 'The execution records.',
'type' => 'array',
'items' => [
'description' => 'The details of an execution record.',
'type' => 'object',
'properties' => [
'TriggerType' => ['description' => 'The type of the playbook task. Valid values:'."\n"
."\n"
.'- **debug**: a test task'."\n"
."\n"
.'- **manual**: a one-time task'."\n"
."\n"
.'- **siem**: a task that is triggered by an event or alert', 'type' => 'string', 'example' => 'debug', 'title' => ''],
'TaskName' => ['description' => 'The name of the playbook task. The value is the UUID of the playbook.', 'type' => 'string', 'example' => '82848ebc-eaff-4791-acd4-xxxxx', 'title' => ''],
'StartTime' => ['description' => 'The start time of the task run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1675823338433', 'title' => ''],
'EndTime' => ['description' => 'The end time of the component run. The value is a 13-digit UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686294686000', 'title' => ''],
'Status' => ['description' => 'The status of the playbook task. Valid values:'."\n"
."\n"
.'- **success**: The execution is successful.'."\n"
."\n"
.'- **fail**: The execution failed.'."\n"
."\n"
.'- **running**: The execution is in progress.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestUuid' => ['description' => 'The request ID of the playbook task. The ID is unique for each task run.', 'type' => 'string', 'example' => 'ba1ec480-aa90-4bb6-a1a7-9e311ae*****', 'title' => ''],
'TriggerUser' => ['description' => 'The ID of the Alibaba Cloud account that runs the playbook task.', 'type' => 'string', 'example' => '127xxxx4392', 'title' => ''],
'ErrorMsg' => ['description' => 'The error message of the playbook task. This parameter is empty if the task is successful.', 'type' => 'string', 'example' => 'stime not match', 'title' => ''],
'RawEventReq' => ['description' => 'The request parameters of the playbook task.', 'type' => 'string', 'example' => '{'."\n"
.' "input1": "xx.xx.xx.xx",'."\n"
.' "input2": "7d"'."\n"
.'}', 'title' => ''],
'TaskflowMd5' => ['description' => 'The MD5 value of the playbook configuration.', 'type' => 'string', 'example' => 'dea65a3db87fb9bd84bbxxxxx', 'title' => ''],
'OutputList' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Content' => ['description' => 'The output content.', 'type' => 'string', 'example' => ' {"msg":"process has been killed","code":"KillSuccess","status":"success"}', 'title' => ''],
'NodeName' => ['description' => 'The name of the node that generates the output.', 'type' => 'string', 'example' => 'TriggerPlaybook_4', 'title' => ''],
'ActionUuid' => ['description' => 'The UUID of the node.', 'type' => 'string', 'example' => '4e78d665-2366-4485-8fbc-048a8d41a2c3-25****', 'title' => ''],
],
'description' => 'JSONArray',
'title' => '',
'example' => '',
],
'description' => 'The output information of the playbook.',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'default' => '0', 'example' => '22', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'example' => '10', 'title' => ''],
],
'required' => true,
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"601C2DAC-6A67-5237-BEE8-5BF1CEE9*****\\",\\n \\"SoarExecuteRecords\\": [\\n {\\n \\"TriggerType\\": \\"debug\\",\\n \\"TaskName\\": \\"82848ebc-eaff-4791-acd4-xxxxx\\",\\n \\"StartTime\\": 1675823338433,\\n \\"EndTime\\": 1686294686000,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"ba1ec480-aa90-4bb6-a1a7-9e311ae*****\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"TaskflowMd5\\": \\"dea65a3db87fb9bd84bbxxxxx\\",\\n \\"OutputList\\": [\\n {\\n \\"Content\\": \\" {\\\\\\"msg\\\\\\":\\\\\\"process has been killed\\\\\\",\\\\\\"code\\\\\\":\\\\\\"KillSuccess\\\\\\",\\\\\\"status\\\\\\":\\\\\\"success\\\\\\"}\\",\\n \\"NodeName\\": \\"TriggerPlaybook_4\\",\\n \\"ActionUuid\\": \\"4e78d665-2366-4485-8fbc-048a8d41a2c3-25****\\"\\n }\\n ]\\n }\\n ],\\n \\"Page\\": {\\n \\"TotalCount\\": 22,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'DescribeSoarRecords',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecords'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeSoarRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'DescribeSoarTaskAndActions' => [
'summary' => 'Retrieves the component execution records for a single playbook run.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RequestUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1077f2f9-25e8-42d9-bfdf-1528e1313f6d'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 20. If you do not specify this parameter, 10 entries are returned.'."\n"
."\n"
.'> Specify a value for this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'QueryValue',
'in' => 'query',
'schema' => ['description' => 'The input parameter of the playbook.', 'type' => 'string', 'required' => false, 'example' => 'input', 'title' => ''],
],
[
'name' => 'QueryType',
'in' => 'query',
'schema' => ['description' => 'The trigger type of the task. Valid values:'."\n"
."\n"
.'- **stream**: The task is triggered by a data stream.'."\n"
."\n"
.'- **debug**: The task is triggered by a debugging process.'."\n"
."\n"
.'- **manual**: The task is triggered manually.'."\n"
."\n"
.'- **timer**: The task is triggered by a timer.'."\n"
."\n"
.'- **SubInvoke**: The task is triggered by a child flow.', 'type' => 'string', 'required' => false, 'example' => 'debug', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<SaoExecuteInfo>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '18017A93-3D5D-503A-8308-914543F1CBA3'],
'Details' => [
'title' => '',
'description' => 'The details of the task execution.',
'type' => 'object',
'properties' => [
'TriggerType' => ['description' => 'The trigger type. Valid values:'."\n"
."\n"
.'- **debug**: A task for debugging a playbook.'."\n"
."\n"
.'- **manual**: A manually triggered task.'."\n"
."\n"
.'- **siem**: An event-triggered task.', 'type' => 'string', 'example' => 'siem', 'title' => ''],
'TaskName' => ['description' => 'The name of the playbook task. This is the same as the playbook UUID.', 'type' => 'string', 'example' => '92af3c79-1754-4646-9366-9ddbd1e45536', 'title' => ''],
'StartTime' => ['description' => 'The start time of the playbook run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848645', 'title' => ''],
'EndTime' => ['description' => 'The end time of the playbook run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848767', 'title' => ''],
'Status' => ['description' => 'The status of the playbook task. Valid values:'."\n"
."\n"
.'- **success**: The task was successful.'."\n"
."\n"
.'- **fail**: The task failed.'."\n"
."\n"
.'- **running**: The task is running.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'RequestUuid' => ['description' => 'The request ID of the playbook task. This is the unique ID for each task run.', 'type' => 'string', 'example' => '17f75844-75cc-4174-86da-cec07a690142', 'title' => ''],
'TriggerUser' => ['description' => 'The ID of the Alibaba Cloud account that triggered the playbook task.', 'type' => 'string', 'example' => '127xxxx4392', 'title' => ''],
'ErrorMsg' => ['description' => 'The error message for the playbook task. This field is empty if the task is successful.', 'type' => 'string', 'example' => 'stime not match', 'title' => ''],
'RawEventReq' => ['description' => 'The request parameters of the playbook task.', 'type' => 'string', 'example' => '{'."\n"
.' "input1": "xx.xx.xx.xx",'."\n"
.' "input2": "7d"'."\n"
.'}', 'title' => ''],
'Actions' => [
'description' => 'The list of component actions executed in the playbook.',
'type' => 'array',
'items' => [
'description' => 'The details of a component action executed in the playbook.',
'type' => 'object',
'properties' => [
'Component' => ['description' => 'The name of the component.', 'type' => 'string', 'example' => 'DataFormat', 'title' => ''],
'Action' => ['description' => 'The name of the component action.', 'type' => 'string', 'example' => 'formatdata', 'title' => ''],
'StartTime' => ['description' => 'The start time of the component run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848731', 'title' => ''],
'EndTime' => ['description' => 'The end time of the component run. This is a 13-digit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1699868848766', 'title' => ''],
'Status' => ['description' => 'The result of the component run. Valid values:'."\n"
."\n"
.'- **success**: The run was successful.'."\n"
."\n"
.'- **fail**: The run failed.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'ActionUuid' => ['description' => 'The UUID of the component action execution record.', 'type' => 'string', 'example' => '091be399-a937-4276-af78-xxxxxxxx', 'title' => ''],
'AssetName' => ['description' => 'The name of the asset used by the component.', 'type' => 'string', 'example' => 'SLS Asset', 'title' => ''],
'NodeName' => ['description' => 'The custom node name of the component.', 'type' => 'string', 'example' => 'DataFormat_1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'TaskFlowMd5' => ['description' => 'The MD5 value of the playbook configuration that was run.', 'type' => 'string', 'example' => 'ed127287-6699-4e4d-b986-9f770879xxx', 'title' => ''],
'ActionLogNum' => ['description' => 'The total number of action logs.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
],
'example' => '',
],
'Page' => [
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '20', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'string', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'example' => '10', 'title' => ''],
],
'description' => 'The pagination information.',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"18017A93-3D5D-503A-8308-914543F1CBA3\\",\\n \\"Details\\": {\\n \\"TriggerType\\": \\"siem\\",\\n \\"TaskName\\": \\"92af3c79-1754-4646-9366-9ddbd1e45536\\",\\n \\"StartTime\\": 1699868848645,\\n \\"EndTime\\": 1699868848767,\\n \\"Status\\": \\"success\\",\\n \\"RequestUuid\\": \\"17f75844-75cc-4174-86da-cec07a690142\\",\\n \\"TriggerUser\\": \\"127xxxx4392\\",\\n \\"ErrorMsg\\": \\"stime not match\\",\\n \\"RawEventReq\\": \\"{\\\\n \\\\\\"input1\\\\\\": \\\\\\"xx.xx.xx.xx\\\\\\",\\\\n \\\\\\"input2\\\\\\": \\\\\\"7d\\\\\\"\\\\n}\\",\\n \\"Actions\\": [\\n {\\n \\"Component\\": \\"DataFormat\\",\\n \\"Action\\": \\"formatdata\\",\\n \\"StartTime\\": 1699868848731,\\n \\"EndTime\\": 1699868848766,\\n \\"Status\\": \\"success\\",\\n \\"ActionUuid\\": \\"091be399-a937-4276-af78-xxxxxxxx\\",\\n \\"AssetName\\": \\"SLS Asset\\",\\n \\"NodeName\\": \\"DataFormat_1\\"\\n }\\n ],\\n \\"TaskFlowMd5\\": \\"ed127287-6699-4e4d-b986-9f770879xxx\\",\\n \\"ActionLogNum\\": 5\\n },\\n \\"Page\\": {\\n \\"TotalCount\\": \\"20\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeSoarTaskAndActions',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarTaskAndActions'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeSoarTaskAndActions',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeSophonCommands' => [
'summary' => 'Queries the commands that are used to manage entities.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the command. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'waf_process', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<SophonCommandBO>>',
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '',
'description' => 'The list of returned commands.',
'type' => 'array',
'items' => [
'description' => 'The details of the command.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the command.', 'type' => 'string', 'example' => 'waf_process_ip_v2', 'title' => ''],
'DisplayName' => ['description' => 'The display name of the command.', 'type' => 'string', 'example' => 'WAF Process IP', 'title' => ''],
'ParamConfig' => [
'description' => 'The parameter settings.',
'type' => 'array',
'items' => [
'description' => 'The parameter settings.',
'type' => 'object',
'properties' => [
'Necessary' => ['description' => 'Indicates whether the parameter is required. Valid values:'."\n"
."\n"
.'- **true**: The parameter is required. This is the default value.'."\n"
."\n"
.'- **false**: The parameter is optional.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Field' => ['description' => 'The name of the parameter field.', 'type' => 'string', 'example' => 'ip', 'title' => ''],
'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => '12.xx.xx.xx', 'title' => ''],
'CheckField' => ['description' => 'The regular expression that is used to check the format of the field. If this parameter is empty, no check is performed.', 'type' => 'string', 'example' => '[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}\\.[0-9]{4}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Description' => ['description' => 'The description of the command.', 'type' => 'string', 'example' => 'This is a action of processing for WAF', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '1E1EC464-3BD7-518F-9937-BCC12E6855FE', 'title' => ''],
],
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"waf_process_ip_v2\\",\\n \\"DisplayName\\": \\"WAF Process IP\\",\\n \\"ParamConfig\\": [\\n {\\n \\"Necessary\\": true,\\n \\"Field\\": \\"ip\\",\\n \\"Value\\": \\"12.xx.xx.xx\\",\\n \\"CheckField\\": \\"[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\\\\\\\.[0-9]{4}\\"\\n }\\n ],\\n \\"Description\\": \\"This is a action of processing for WAF\\"\\n }\\n ],\\n \\"RequestId\\": \\"1E1EC464-3BD7-518F-9937-BCC12E6855FE\\"\\n}","type":"json"}]',
'title' => 'DescribeSophonCommands',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSophonCommands'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeSophonCommands',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'DescribeVendorApiList' => [
'summary' => 'Queries the API operations of a cloud service provider.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The current page number for pagination. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of items per page when displaying paginated results. The default is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'KeyWord',
'in' => 'query',
'schema' => ['description' => 'Keyword.', 'type' => 'string', 'required' => false, 'example' => 'Create', 'title' => ''],
],
[
'name' => 'ProductCode',
'in' => 'query',
'schema' => ['description' => 'Vendor\'s product identifier:'."\n"
.'- **waf**: Web Application Firewall.'."\n"
.'- **cfw**: Cloud Firewall.', 'type' => 'string', 'required' => false, 'example' => 'waf', 'title' => ''],
],
[
'name' => 'ApiName',
'in' => 'query',
'schema' => ['description' => 'The name of the Alibaba Cloud product interface, supporting fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'AddAssetCleanConfig', 'title' => ''],
],
[
'name' => 'VendorCode',
'in' => 'query',
'schema' => ['description' => 'Vendor code:'."\n"
.'- **Tencent**: Tencent.'."\n"
.'- **HUAWEICLOUD**: Huawei.'."\n"
.'- **Azure**: Microsoft Azure.'."\n"
.'- **AWS**: Amazon Web Services.'."\n"
.'- **Chaitin**: Chaitin.', 'type' => 'string', 'required' => false, 'example' => 'Azure', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, and can be used to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94', 'title' => ''],
'Page' => [
'description' => 'Pagination query information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'Total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'PageNumber' => ['description' => 'The current page number in the pagination query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of items displayed per page in the pagination query.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
'ApiList' => [
'description' => 'Product information.',
'type' => 'array',
'items' => [
'description' => 'Product information.',
'type' => 'object',
'properties' => [
'VendorCode' => ['description' => 'Vendor code:'."\n"
.'- **Tencent**: Tencent.'."\n"
.'- **HUAWEICLOUD**: Huawei.'."\n"
.'- **Azure**: Microsoft Azure.'."\n"
.'- **AWS**: Amazon Web Services.'."\n"
.'- **Chaitin**: Chaitin.', 'type' => 'string', 'example' => 'Azure', 'title' => ''],
'ProductCode' => ['description' => 'Vendor\'s product identifier:'."\n"
.'- **waf**: Web Application Firewall.'."\n"
.'- **cfw**: Cloud Firewall.', 'type' => 'string', 'example' => 'cfw', 'title' => ''],
'ProductName' => ['description' => 'Product name.', 'type' => 'string', 'example' => 'waf', 'title' => ''],
'Parameter' => ['description' => 'Interface request parameter configuration information.', 'type' => 'string', 'example' => '['."\n"
.' {'."\n"
.' "name": "Domain",'."\n"
.' "type": "String",'."\n"
.' "isRequired": true,'."\n"
.' "exampleValue": "www.***.com",'."\n"
.' "description": "www.***.com"'."\n"
.' }'."\n"
.']', 'title' => ''],
'ProductDomain' => ['description' => 'Default domain of the product.', 'type' => 'string', 'example' => 'cfw.xxx.com', 'title' => ''],
'Protocol' => ['description' => 'Request protocol. Values:'."\n"
.'- **http**: HTTP request protocol.'."\n"
.'- **https**: HTTPS request protocol.', 'type' => 'string', 'example' => 'https', 'title' => ''],
'Method' => ['description' => 'Request methods: '."\n"
.'- **POST**: POST request method. '."\n"
.'- **GET**: GET request method. '."\n"
.'- **PUT**: PUT request method. '."\n"
.'- **DELETE**: DELETE request method.', 'type' => 'string', 'example' => 'POST', 'title' => ''],
'ApiName' => ['description' => 'The name of the vendor\'s API.', 'type' => 'string', 'example' => 'VerifyMobile', 'title' => ''],
'NeedPageInfo' => ['description' => 'Indicates whether pagination is needed.'."\n"
.'- **true**: Yes.'."\n"
.'- **false**: No.', 'type' => 'boolean', 'example' => 'false', 'title' => ''],
'PageInfo' => ['description' => 'Information displayed on the page.', 'type' => 'string', 'example' => '{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}', 'title' => ''],
'ApiVersion' => ['description' => 'The version number of the API.', 'type' => 'string', 'example' => '2017-08-01', 'title' => ''],
'NeedAdvanceConfig' => ['description' => 'Indicates whether advanced configuration is included.'."\n"
.'- **true**: Yes.'."\n"
.'- **false**: No.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'AdvanceConfig' => ['description' => 'Advanced configuration for the API.', 'type' => 'string', 'example' => '{'."\n"
.' "cmd": "DescribeAclApiDispatch"'."\n"
.'}', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n },\\n \\"ApiList\\": [\\n {\\n \\"VendorCode\\": \\"Azure\\",\\n \\"ProductCode\\": \\"cfw\\",\\n \\"ProductName\\": \\"waf\\",\\n \\"Parameter\\": \\"[\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Domain\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"String\\\\\\",\\\\n \\\\\\"isRequired\\\\\\": true,\\\\n \\\\\\"exampleValue\\\\\\": \\\\\\"www.***.com\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"www.***.com\\\\\\"\\\\n }\\\\n]\\",\\n \\"ProductDomain\\": \\"cfw.xxx.com\\",\\n \\"Protocol\\": \\"https\\",\\n \\"Method\\": \\"POST\\",\\n \\"ApiName\\": \\"VerifyMobile\\",\\n \\"NeedPageInfo\\": false,\\n \\"PageInfo\\": \\"{\'Count\': 10, \'TotalCount\': 23, \'PageSize\': 10, \'CurrentPage\': 1}\\",\\n \\"ApiVersion\\": \\"2017-08-01\\",\\n \\"NeedAdvanceConfig\\": true,\\n \\"AdvanceConfig\\": \\"{\\\\n \\\\\\"cmd\\\\\\": \\\\\\"DescribeAclApiDispatch\\\\\\"\\\\n}\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeVendorApiList',
'description' => 'Please ensure that you fully understand the billing method and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product (i.e., threat analysis and response log access traffic) before using this interface.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescribeVendorApiList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVendorApiList'],
],
],
],
'DescriberPython3ScriptLogs' => [
'summary' => 'After you submit a task for a Python 3 script, use the returned requestUuid to retrieve the operational logs.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RequestUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID that is returned when you run a Python 3 script.'."\n"
."\n"
.'> Call the [RunPython3Script](~~RunPython3Script~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '69edc2b4-c95c-424f-9114-xxxxxxx', 'title' => ''],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID of the request. This ID is generated by Alibaba Cloud and can be used to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => 'D22D8A0C-6E86-57B2-A142-929184122AB1'],
'RunResult' => ['description' => 'The operational logs of the Python 3 script.', 'type' => 'string', 'title' => '', 'example' => '{'."\n"
.' "logs": ['."\n"
.' {'."\n"
.' "message": "function input is {}"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D22D8A0C-6E86-57B2-A142-929184122AB1\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"logs\\\\\\": [\\\\n {\\\\n \\\\\\"message\\\\\\": \\\\\\"function input is {}\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n}","type":"json"}]',
'title' => 'DescriberPython3ScriptLogs',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescriberPython3ScriptLogs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:DescriberPython3ScriptLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifyComponentAsset' => [
'summary' => 'You can call this operation to modify the asset information for a component.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AssetConfig',
'in' => 'query',
'schema' => ['description' => 'The configuration of the component asset. This parameter is a JSON object.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n"
.' "name": "test asset",'."\n"
.' "componentName": "SLS",'."\n"
.' "params": ['."\n"
.' {'."\n"
.' "name": "end_point",'."\n"
.' "value": "xxx"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "sub_id",'."\n"
.' "value": "xxxx"'."\n"
.' },'."\n"
.' {'."\n"
.' "name": "access_key",'."\n"
.' "value": "xxxx"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is unique to each request and is used to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '1C5F11E9-464E-51F0-9296-43BB312A0557'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1C5F11E9-464E-51F0-9296-43BB312A0557\\"\\n}","type":"json"}]',
'title' => 'ModifyComponentAsset',
'requestParamsDescription' => 'Description of the **AssetConfig** parameter:'."\n"
."\n"
.'- **name**: The name of the asset.'."\n"
."\n"
.'- **componentName**: The name of the component.'."\n"
."\n"
.'- **params**: The configuration details. This parameter includes the following fields:'."\n"
."\n"
.' - **end\\_point**: The connection endpoint.'."\n"
."\n"
.' - **sub\\_id**: The AccessKey ID of your account.'."\n"
."\n"
.' - **access\\_key**: The AccessKey secret of your account.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyComponentAsset'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:ModifyComponentAsset',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ModifyPlaybook' => [
'summary' => 'Modifies the configuration of a playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-1586c35e61f8'],
],
[
'name' => 'DisplayName',
'in' => 'formData',
'schema' => ['description' => 'The display name of the playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'aliyun_waf_test_playbook'],
],
[
'name' => 'Taskflow',
'in' => 'formData',
'schema' => ['description' => 'The XML configuration of the playbook.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The description of the playbook.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'demo test task'],
],
[
'name' => 'Lang',
'in' => 'formData',
'schema' => ['description' => 'The language of the request and response.'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID of the request. Use this ID to locate and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '9B584F84-D66A-5525-8E7B-05612A903ABF'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9B584F84-D66A-5525-8E7B-05612A903ABF\\"\\n}","type":"json"}]',
'title' => 'ModifyPlaybook',
'changeSet' => [
['createdAt' => '2023-12-07T09:16:28.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:ModifyPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'ModifyPlaybookInputOutput' => [
'summary' => 'Modifies the input and output parameters of a playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx'],
],
[
'name' => 'InputParams',
'in' => 'formData',
'schema' => ['description' => 'The input parameter configuration for the playbook. This parameter is in the JSONArray format.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "typeName": "String",'."\n"
.' "dataClass": "normal",'."\n"
.' "dataType": "String",'."\n"
.' "description": "period",'."\n"
.' "example": "",'."\n"
.' "name": "period",'."\n"
.' "required": false'."\n"
.' }'."\n"
.']'],
],
[
'name' => 'OutputParams',
'in' => 'formData',
'schema' => ['description' => 'Playbooks do not support output parameter configurations. This parameter is fixed to an empty value.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '[]'],
],
[
'name' => 'ParamType',
'in' => 'formData',
'schema' => ['description' => 'The type of the input parameter for the playbook.'."\n"
."\n"
.'- **template-ip**: IP request template.'."\n"
."\n"
.'- **template-file**: file request template.'."\n"
."\n"
.'- **template-process**: process request template.'."\n"
."\n"
.'- **custom**: custom parameter.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''],
],
[
'name' => 'ExeConfig',
'in' => 'formData',
'schema' => ['description' => 'The execution method for the playbook. This parameter is in the JSONObject format.', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
.' "executeMode":"mul",'."\n"
.' "cron":"0 0 1 */1 * ?"'."\n"
.'}', 'title' => ''],
],
[
'name' => 'Lang',
'in' => 'formData',
'schema' => ['description' => 'The language of the request and response messages.'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier that is generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '8DDC07CE-D41B-5142-8D91-469462719C77'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8DDC07CE-D41B-5142-8D91-469462719C77\\"\\n}","type":"json"}]',
'title' => 'ModifyPlaybookInputOutput',
'requestParamsDescription' => '**InputParams** is in the JSONArray format. The parameters are described as follows:'."\n"
."\n"
.'- typeName: The name of the parameter type.'."\n"
."\n"
.'- dataClass: The class of the parameter type. Valid values: **normal** for a standard parameter and **custom** for a complex parameter.'."\n"
."\n"
.'- dataType: The data type of the parameter. Valid values: string, long, int, ip, file, and **account**.'."\n"
."\n"
.'- description: The parameter description.'."\n"
."\n"
.'- example: An example value for the parameter.'."\n"
."\n"
.'- name: The parameter name.'."\n"
."\n"
.'- required: Specifies whether the parameter is required. Valid values: **true** and **false**.'."\n"
."\n"
.'**ExeConfig** is in the JSONObject format. The parameters are described as follows:'."\n"
."\n"
.'- executeMode: The execution method. The only valid value is **mul**.'."\n"
."\n"
.'- cron: The CRON expression. The expression must follow the CRON standard.',
'changeSet' => [
['createdAt' => '2024-01-16T08:25:44.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:ModifyPlaybookInputOutput',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'ModifyPlaybookInstanceStatus' => [
'summary' => 'Starts or stops a playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '9fcd3829-80ff-4681-be1e-xxxxxxxx'],
],
[
'name' => 'Active',
'in' => 'formData',
'schema' => ['title' => '', 'description' => 'The status of the playbook. Valid values:'."\n"
."\n"
.'- **1**: Starts the playbook.'."\n"
."\n"
.'- **0**: Stops the playbook.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. The default value is **zh**. Valid values:'."\n"
."\n"
.'- **zh**: Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'zh'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'C2A32830-2842-5F8F-B4ED-E4783E400BBE'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C2A32830-2842-5F8F-B4ED-E4783E400BBE\\"\\n}","type":"json"}]',
'title' => 'ModifyPlaybookInstanceStatus',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
],
'PublishPlaybook' => [
'summary' => 'Publishes a playbook. Once published, the playbook runs with the new logic.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsasK0Q1Y8'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ac343acc-1a61-4084-9a1c-xxxxxxx'],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => ['description' => 'The description of the published version.', 'type' => 'string', 'maxLength' => 128, 'title' => '', 'required' => false, 'example' => 'This is a waf processing playbook'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C513FCEA-D71F-5E50-ADC4-FCF8C5DCF6BF\\"\\n}","type":"json"}]',
'title' => 'PublishPlaybook',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:PublishPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'QueryTreeData' => [
'summary' => 'Retrieves a list of all playbooks.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2'],
'Playbooks' => ['description' => 'A list of playbooks in JSON string format. The string contains the following fields:'."\n"
."\n"
.'- **active**: Indicates whether the playbook is active. A value of **true** means the playbook is active. A value of **false** means the playbook is inactive.'."\n"
."\n"
.'- **displayName**: The name of the playbook.'."\n"
."\n"
.'- **playbookUuid**: The UUID of the playbook.', 'type' => 'string', 'title' => '', 'example' => '['."\n"
.' {'."\n"
.' "playbook": {'."\n"
.' "active": false,'."\n"
.' "displayName": "test_playbook",'."\n"
.' "playbookUuid": "09a20455-3d3a-424c-a1df-xxxxxx"'."\n"
.' }'."\n"
.' }'."\n"
.']'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EF2ECA2D-D8E6-5021-BF5C-19DD6D52C5B2\\",\\n \\"Playbooks\\": \\"[\\\\n {\\\\n \\\\\\"playbook\\\\\\": {\\\\n \\\\\\"active\\\\\\": false,\\\\n \\\\\\"displayName\\\\\\": \\\\\\"test_playbook\\\\\\",\\\\n \\\\\\"playbookUuid\\\\\\": \\\\\\"09a20455-3d3a-424c-a1df-xxxxxx\\\\\\"\\\\n }\\\\n }\\\\n]\\"\\n}","type":"json"}]',
'title' => 'QueryTreeData',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTreeData'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:QueryTreeData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'RevertPlaybookRelease' => [
'summary' => 'Rolls back a playbook to a specified version. You can also specify whether to publish that version after the rollback.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '185295a1-c987-4b64-8796-xxxxxxxx'],
],
[
'name' => 'PlayReleaseId',
'in' => 'formData',
'schema' => ['description' => 'The ID of the published playbook version.'."\n"
."\n"
.'> Call the [DescribePlaybookReleases](~~DescribePlaybookReleases~~) operation to obtain this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '3f97b56e-064e-47e7-a309-xxxxxxx'],
],
[
'name' => 'IsPublish',
'in' => 'formData',
'schema' => ['description' => 'Specifies whether to publish the playbook after the rollback.'."\n"
."\n"
.'- **true** (default): Publishes the playbook after the rollback.'."\n"
."\n"
.'- **false**: Rolls back the playbook without publishing it.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is unique to the request and can be used for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'B3FED5B9-190A-5952-93A4-24FBF0F0C573'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B3FED5B9-190A-5952-93A4-24FBF0F0C573\\"\\n}","type":"json"}]',
'title' => 'RevertPlaybookRelease',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertPlaybookRelease'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:RevertPlaybookRelease',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Application', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'RunNotifyComponentWithEmail' => [
'summary' => 'Runs the notification component to send an email message.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '226653',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Receivers',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'A list of email addresses.',
'type' => 'array',
'items' => ['description' => 'A single email address.', 'type' => 'string', 'required' => false, 'example' => '123xxx@163.com', 'title' => ''],
'required' => true,
'maxItems' => 100,
'example' => '',
],
],
[
'name' => 'Subject',
'in' => 'query',
'schema' => ['description' => 'The title of the email.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'title'],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => 'The body of the email.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'email content'],
],
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'e99dab31-499b-4307-9248-xxxxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notify_message_1'],
],
[
'name' => 'ComponentName',
'in' => 'query',
'schema' => ['description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'NotifyMessage'],
],
[
'name' => 'ActionName',
'in' => 'query',
'schema' => ['description' => 'The name of the component action.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notifyByCustom'],
],
[
'name' => 'AssetId',
'in' => 'query',
'schema' => ['description' => 'The ID of the asset that is used to send the email.'."\n"
."\n"
.'> Call the [DescribeComponentAssets](~~DescribeComponentAssets~~) operation to obtain this parameter.', 'type' => 'string', 'title' => '', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The view type. Valid values:'."\n"
."\n"
.'- 0: The view of the current Alibaba Cloud account.'."\n"
."\n"
.'- 1: The view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The UID of the member whose data an administrator wants to access.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '137602xxx718726', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'SophonResult',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Use this ID for troubleshooting.', 'type' => 'string', 'title' => '', 'example' => 'D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B'],
'Data' => ['description' => 'The returned data.', 'type' => 'string', 'title' => '', 'example' => '{}'],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'RunNotifyComponentWithEmail',
'description' => 'Before calling this operation, understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for Security Orchestration Application Response (SOAR). SOAR is billed based on the log traffic added to the service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithEmail'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'yundun-sas:RunNotifyComponentWithEmail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D4CC979E-3D5B-5A6A-BC87-C93C9E861C7B\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
],
'RunNotifyComponentWithMessageCenter' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '226714',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Aliuid',
'in' => 'query',
'schema' => ['title' => '要发送的aliuid', 'description' => 'The ID of the user who receives the message.', 'type' => 'string', 'required' => true, 'example' => '146789xxxx733152'],
],
[
'name' => 'EventId',
'in' => 'query',
'schema' => ['title' => '云鸽的消息事件id', 'description' => 'The ID of the message event in Message Center. Valid values:'."\n"
."\n"
.'- yundun\\_soar\\_incident\\_generate: An event is generated.'."\n"
."\n"
.'- yundun\\_soar\\_alert\\_generate: An alert is generated.'."\n"
."\n"
.'- yundun\\_soar\\_incident\\_update: An event is updated.', 'type' => 'string', 'required' => true, 'example' => 'yundun_soar_incident_generate'],
],
[
'name' => 'Params',
'in' => 'query',
'schema' => ['title' => '消息参数', 'description' => 'The template parameters for the message event.'."\n"
."\n"
.'- Event generation: aliyunUID, incidentName, incidentID, startTime'."\n"
."\n"
.'- Alert generation: aliyunUID, alertName, alertID, startTime'."\n"
."\n"
.'- Event update: aliyunUID, incidentName, incidentID, startTime, endTime, status, level', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"test222","incidentName":"test123","incidentID":"teset123"}'],
],
[
'name' => 'ChannelTypeList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '通道类型集合,不传默认发送消息事件配置的所有通道',
'description' => 'A collection of channel types. If you do not specify this parameter, messages are sent through all channels by default.',
'type' => 'array',
'items' => ['description' => 'A channel type. Valid values:'."\n"
."\n"
.'- sms: text message'."\n"
."\n"
.'- email: email'."\n"
."\n"
.'- webhook: DingTalk group webhook'."\n"
."\n"
.'- pmsg: internal message', 'type' => 'string', 'required' => false, 'example' => 'sms', 'title' => ''],
'required' => false,
'maxItems' => 100,
'example' => '',
],
],
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['title' => '剧本uuid', 'description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain the value of this parameter.', 'type' => 'string', 'required' => true, 'example' => 'c5c88b5e-97ca-435d-8c20-xxxxxx'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['title' => '剧本的节点名称', 'description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'example' => 'notify_message'],
],
[
'name' => 'ComponentName',
'in' => 'query',
'schema' => ['title' => '剧本的组件名称', 'description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'example' => 'NotifyMessage'],
],
[
'name' => 'ActionName',
'in' => 'query',
'schema' => ['title' => '剧本的动作名称', 'description' => 'The name of the playbook action.', 'type' => 'string', 'required' => true, 'example' => 'notifyByMessageCenter'],
],
[
'name' => 'AssetId',
'in' => 'query',
'schema' => ['title' => '资源实例id', 'description' => 'The ID of the asset. This parameter is deprecated.', 'type' => 'string', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese'."\n"
."\n"
.'- **en**: English', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The view type. Valid values:'."\n"
."\n"
.'- 0 (default): The view of the current Alibaba Cloud account.'."\n"
."\n"
.'- 1: The view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The user ID of the member. This parameter is used when an administrator calls the operation on behalf of a member.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1467894xxx733152', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'SophonResult',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '接口请求的requestId', 'description' => 'The unique ID generated for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'E7698CFB-4E1C-5840-8EC9-691B86729E94'],
'Data' => ['title' => '传输的数据', 'description' => 'The data returned.', 'type' => 'string', 'example' => '{}'],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Notification Component - Test Message Center Message Sending',
'summary' => 'Sends a message using the notification component in Message Center.',
'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Security Orchestration Automation Response (SOAR). The service is billed based on the log traffic for threat analysis and response.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithMessageCenter'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'yundun-sas:RunNotifyComponentWithMessageCenter',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-4E1C-5840-8EC9-691B86729E94\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
],
'RunNotifyComponentWithWebhook' => [
'summary' => 'Sends a message from a notification component using a webhook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '226713',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'Webhook',
'in' => 'query',
'schema' => ['description' => 'The IDs of the DingTalk robots. Obtain the IDs on the robot management page in Message Center.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '[\\"10651\\"]'],
],
[
'name' => 'Secret',
'in' => 'query',
'schema' => ['description' => 'The secret key for the webhook of the DingTalk group robot. This parameter is deprecated and no longer used.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SECc1*****e157b32b380f********bb8c70e1a67a22072'],
],
[
'name' => 'MsgType',
'in' => 'query',
'schema' => ['description' => 'The message type of the webhook. Valid values:'."\n"
."\n"
.'- text'."\n"
."\n"
.'- markdown'."\n"
."\n"
.'- actionCard', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'text'],
],
[
'name' => 'Content',
'in' => 'query',
'schema' => ['description' => 'The content of the message sent by the webhook of the DingTalk group robot.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n"
.' "at": {'."\n"
.' "atMobiles":['."\n"
.' "180xxxxxx"'."\n"
.' ],'."\n"
.' "atUserIds":['."\n"
.' "user123"'."\n"
.' ],'."\n"
.' "isAtAll": false'."\n"
.' },'."\n"
.' "text": {'."\n"
.' "content":"1234"'."\n"
.' },'."\n"
.' "msgtype":"text"'."\n"
.'}'],
],
[
'name' => 'PlaybookUuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~3000306~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '94bc318c-****-4cba-****-801ccb0d739f'],
],
[
'name' => 'NodeName',
'in' => 'query',
'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notify_message_node'],
],
[
'name' => 'ComponentName',
'in' => 'query',
'schema' => ['description' => 'The name of the playbook component.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'NotifyMessage'],
],
[
'name' => 'ActionName',
'in' => 'query',
'schema' => ['description' => 'The name of the playbook action.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'notifyByCustom'],
],
[
'name' => 'AssetId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource. This parameter is deprecated and no longer used.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the request and response. Valid values:'."\n"
."\n"
.'- **zh** (default): Chinese.'."\n"
."\n"
.'- **en**: English.', 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''],
],
[
'name' => 'RoleType',
'in' => 'query',
'schema' => ['description' => 'The view type. Valid values:'."\n"
."\n"
.'- 0 (default): the view of the current Alibaba Cloud account.'."\n"
."\n"
.'- 1: the view of all accounts that belong to the enterprise.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''],
],
[
'name' => 'RoleFor',
'in' => 'query',
'schema' => ['description' => 'The UID of the member that the administrator wants to switch to.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '126339xxxx805497', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'SophonResult',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'E7698CFB-****-5840-8EC9-691B86729E94'],
'Data' => ['description' => 'The data returned.', 'type' => 'string', 'title' => '', 'example' => '{}'],
'Page' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned. This parameter is available only for paged queries.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7698CFB-****-5840-8EC9-691B86729E94\\",\\n \\"Data\\": \\"{}\\",\\n \\"Page\\": {\\n \\"TotalCount\\": 30,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => 'RunNotifyComponentWithWebhook',
'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of response orchestration. This feature is billed based on the log traffic for threat analysis and response.',
'changeSet' => [
['createdAt' => '2025-12-09T11:25:07.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithWebhook'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'yundun-sas:RunNotifyComponentWithWebhook',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'RunPython3Script' => [
'summary' => 'Executes a Python 3 code snippet for data processing.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PythonScript',
'in' => 'formData',
'schema' => ['description' => 'The Python 3 script.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'import logging'."\n"
.'def execute (params):'."\n"
.' #ip = params[\'ip\']'."\n"
.' #logging.info("enter execute,ip is "+ip)'."\n"
.' success=True'."\n"
.' message=\'OK\''."\n"
.' data=[]'."\n"
.' return (success,message,data)'],
],
[
'name' => 'Params',
'in' => 'formData',
'schema' => ['description' => 'The input parameters for the Python 3 script.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n"
.' "input1": "xx.xx.xx.xx",'."\n"
.' "input2": "7d"'."\n"
.'}'],
],
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '8baa6cff-319e-4ede-97bc-xxxxxxx'],
],
[
'name' => 'NodeName',
'in' => 'formData',
'schema' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'python3_3'],
],
[
'name' => 'PythonVersion',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => 'The Python version.', 'title' => '', 'required' => false, 'example' => 'python2.0'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<String>',
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request. Alibaba Cloud generates this unique ID for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'F210521C-D9BF-5264-8369-83EDDC617DB0'],
'RunResult' => ['title' => '', 'description' => 'The data returned after the script is run.', 'type' => 'string', 'example' => '{'."\n"
.' "requestUuid": "fe240b98-27b1-4a36-aec1-550b894318d9",'."\n"
.' "content": {'."\n"
.' "resultData": [],'."\n"
.' "success": true'."\n"
.' }'."\n"
.'}'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F210521C-D9BF-5264-8369-83EDDC617DB0\\",\\n \\"RunResult\\": \\"{\\\\n \\\\\\"requestUuid\\\\\\": \\\\\\"fe240b98-27b1-4a36-aec1-550b894318d9\\\\\\",\\\\n \\\\\\"content\\\\\\": {\\\\n \\\\\\"resultData\\\\\\": [],\\\\n \\\\\\"success\\\\\\": true\\\\n }\\\\n}\\"\\n}","type":"json"}]',
'title' => 'RunPython3Script',
'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of the response orchestration product.',
'responseParamsDescription' => 'The **RunResult** parameter is a JSON object that contains the following fields:'."\n"
."\n"
.'- **requestUuid**: The UUID of the request. You can use this UUID to query the run logs.'."\n"
."\n"
.'- **content**: The result of the script execution. This field is user-defined.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPython3Script'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'yundun-sas:RunPython3Script',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'TriggerPlaybook' => [
'summary' => 'Triggers an enabled custom or predefined playbook.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2a687089-d4dd-47d4-9709-xxxxxxxx'],
],
[
'name' => 'InputParam',
'in' => 'formData',
'schema' => ['description' => 'The input parameters for the playbook.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n"
.' "input1": "xx.xx.xx.xx",'."\n"
.' "input2": "7d"'."\n"
.'}'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PlaybookTriggerDTO>',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'BD5A8DB6-A42C-532B-BCE8-83E69550CD59'],
'TriggerUuid' => ['description' => 'The UUID of the playbook run. You can use this UUID to obtain the results of the playbook run.', 'type' => 'string', 'example' => '55E63C57-D6C8-5036-A770-5CB10AC807AA', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BD5A8DB6-A42C-532B-BCE8-83E69550CD59\\",\\n \\"TriggerUuid\\": \\"55E63C57-D6C8-5036-A770-5CB10AC807AA\\"\\n}","type":"json"}]',
'title' => 'TriggerPlaybook',
'description' => 'Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) of Response Orchestration.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:TriggerPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'TriggerProcessTask' => [
'summary' => 'When an event is handled using response orchestration, the response center creates a task. Perform follow-up actions on the task, such as unblocking, retrying a block, and removing from isolation.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'formData',
'schema' => ['description' => 'The unique ID of the handling task.'."\n"
."\n"
.'> Call the [DescribeProcessTasks](~~DescribeProcessTasks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => true, 'example' => '15355xxxxxx82894882', 'title' => ''],
],
[
'name' => 'ActionType',
'in' => 'query',
'schema' => ['description' => 'The type of the handling action. Valid values:'."\n"
."\n"
.'- **remove**: Removes a block or an asset from isolation.'."\n"
."\n"
.'- **retry**: Resubmits the task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'remove'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<Void>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The unique ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '58A518BC-E4A8-5BD7-AFEA-366046ED9073'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58A518BC-E4A8-5BD7-AFEA-366046ED9073\\"\\n}","type":"json"}]',
'title' => 'TriggerProcessTask',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TriggerProcessTask'],
],
],
'ramActions' => [],
],
'TriggerSophonPlaybook' => [
'summary' => 'Triggers a playbook or responds to a command.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '149322',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'CommandName',
'in' => 'query',
'schema' => ['description' => 'The name of the command to trigger.'."\n"
."\n"
.'> Call the [DescribeSophonCommands](~~DescribeSophonCommands~~) operation to obtain the command name.', 'type' => 'string', 'required' => false, 'example' => 'waf_process_command', 'title' => ''],
],
[
'name' => 'InputParams',
'in' => 'query',
'schema' => ['description' => 'The input parameters to trigger the command or playbook.', 'type' => 'string', 'required' => true, 'example' => '{'."\n"
.' "param1": "xx.xx.xx.xx",'."\n"
.' "param2": "7d"'."\n"
.'}', 'title' => ''],
],
[
'name' => 'SophonTaskId',
'in' => 'query',
'schema' => ['description' => 'A custom ID for the task. If you do not specify this parameter when you trigger the playbook, a random ID is generated. You can use the ID to locate and troubleshoot issues.', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', 'title' => ''],
],
[
'name' => 'Uuid',
'in' => 'query',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain the playbook UUID.', 'type' => 'string', 'required' => false, 'example' => 'f916b93e-e814-459f-9662-xxxxxxxxxx', 'title' => ''],
],
[
'name' => 'TriggerType',
'in' => 'query',
'schema' => ['description' => 'The trigger type. Valid values:'."\n"
."\n"
.'- **command**: triggers a command task'."\n"
."\n"
.'- **playbook**: triggers a playbook task', 'type' => 'string', 'required' => false, 'example' => 'playbook', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<SophonTaskResult>',
'description' => 'The information returned.',
'type' => 'object',
'properties' => [
'Data' => [
'title' => '',
'description' => 'The details returned after the command or playbook is triggered.',
'type' => 'object',
'properties' => [
'SophonTaskId' => ['description' => 'A custom ID for the task. If you do not specify this parameter when you trigger the playbook, a random ID is generated. You can use the ID to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'a7c6d055-a72f-4676-bc89-3cd9edc0284c', 'title' => ''],
],
'example' => '',
],
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SophonTaskId\\": \\"a7c6d055-a72f-4676-bc89-3cd9edc0284c\\"\\n },\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\"\\n}","type":"json"}]',
'title' => 'TriggerSophonPlaybook',
'description' => 'Before calling this operation, ensure you understand the billing methods and [pricing](https://www.aliyun.com/price/product#/sas/detail/sas) for response orchestration.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 2, 'regionId' => '*', 'api' => 'TriggerSophonPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'yundun-sas:TriggerSophonPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'VerifyPlaybook' => [
'summary' => 'Verifies that a playbook configuration is correct and its orchestration logic is valid.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsas104PTS'],
],
'parameters' => [
[
'name' => 'PlaybookUuid',
'in' => 'formData',
'schema' => ['description' => 'The UUID of the playbook.'."\n"
."\n"
.'> Call the [DescribePlaybooks](~~DescribePlaybooks~~) operation to obtain this parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9fcd3829-80ff-4681-be1e-4d2662c35fed'],
],
[
'name' => 'TaskFlow',
'in' => 'formData',
'schema' => ['description' => 'The XML configuration of the playbook.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '<?xml version="1.0" encoding="UTF-8"?><bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" targetNamespace="http://bpmn.io/schema/bpmn" id="Definitions_1"><bpmn:process id="Process_1" isExecutable="false"><bpmn:startEvent id="StartEvent_1"/></bpmn:process><bpmndi:BPMNDiagram id="BPMNDiagram_1"><bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_1"><bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1"><dc:Bounds height="36.0" width="36.0" x="173.0" y="102.0"/></bpmndi:BPMNShape></bpmndi:BPMNPlane></bpmndi:BPMNDiagram></bpmn:definitions>'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<List<CheckTaskInfo>>',
'description' => 'The response parameters for the playbook verification.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates this unique identifier for the request. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '0DFC9403-54EB-5672-B690-9AA93C9EBB54'],
'CheckTaskInfos' => [
'title' => '',
'description' => 'The verification results.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RiskLevel' => ['description' => 'The severity level of the verification message. Valid values:'."\n"
."\n"
.'- **warn**: A warning message. An issue may occur when the playbook runs.'."\n"
."\n"
.'- **error**: An error message. The playbook fails to be compiled.'."\n"
."\n"
.'- **remind**: A suggestion. This does not affect publishing or running the playbook. Optimize the playbook format.', 'type' => 'string', 'example' => 'error', 'title' => ''],
'NodeName' => ['description' => 'The name of the playbook node.', 'type' => 'string', 'example' => 'python3_3', 'title' => ''],
'Detail' => ['description' => 'The specific error message that is returned if the verification fails.', 'type' => 'string', 'example' => 'Node [python3_3] doesn\'t have the asset information', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
'Prerequisites' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PrerequisiteType' => ['description' => 'The check type. Valid values:'."\n"
."\n"
.'- **role**: The name of the custom RAM role.'."\n"
."\n"
.'- **policies**: The list of RAM system policies.', 'type' => 'string', 'example' => 'role', 'title' => ''],
'PrerequisiteValue' => ['description' => 'The check content. The value is determined as follows:'."\n"
."\n"
.'- If PrerequisiteType is **role**, the value is the static field AliyunSiemSoarExecutionDefaultRole.'."\n"
."\n"
.'- If PrerequisiteType is **policies**, the value is a collection of policy names.', 'type' => 'string', 'example' => 'AliyunSiemSoarExecutionDefaultRole', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'The prerequisite check information for the playbook.',
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0DFC9403-54EB-5672-B690-9AA93C9EBB54\\",\\n \\"CheckTaskInfos\\": [\\n {\\n \\"RiskLevel\\": \\"error\\",\\n \\"NodeName\\": \\"python3_3\\",\\n \\"Detail\\": \\"Node [python3_3] doesn\'t have the asset information\\"\\n }\\n ],\\n \\"Prerequisites\\": [\\n {\\n \\"PrerequisiteType\\": \\"role\\",\\n \\"PrerequisiteValue\\": \\"AliyunSiemSoarExecutionDefaultRole\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'VerifyPlaybook',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPlaybook'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:VerifyPlaybook',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'Playbook', 'arn' => 'acs:yundun-sas::{#accountId}:playbook/{#PlaybookUuid}'],
],
],
],
],
],
'VerifyPythonFile' => [
'summary' => 'Verifies the syntax of a Python code snippet.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Content',
'in' => 'formData',
'schema' => ['description' => 'The Python code snippet to verify.', 'type' => 'string', 'required' => true, 'example' => 'import logging'."\n"
.'def execute (params):'."\n"
.' success=True'."\n"
.' message=\'OK\''."\n"
.' data=[]'."\n"
.' return (success,message,data)', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SophonResult<PythonVerifyDTO>',
'description' => 'The code hinting information returned after verification.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'F72685FB-A6E6-5A9A-97F7-6DC1056E63CE'],
'Syntax' => [
'description' => 'The result set of the Python code verification. If this parameter is empty, the code syntax is correct.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'StartLineNumber' => ['description' => 'The starting line number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'StartColumn' => ['description' => 'The starting column number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'EndLineNumber' => ['description' => 'The ending line number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'EndColumn' => ['description' => 'The ending column number of the code that contains an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''],
'Message' => ['description' => 'The error message for the code.', 'type' => 'string', 'example' => 'undefined name \'ab\'', 'title' => ''],
'Severity' => [
'description' => 'The error level of the code.'."\n"
."\n"
.'- 4: General error'."\n"
."\n"
.'- 8: Critical error',
'enumValueTitles' => [4 => 'General error', 8 => 'Critical error'],
'type' => 'integer',
'format' => 'int32',
'example' => '4',
'title' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
491 => [
['errorCode' => 'Playbook.External.ParamError', 'errorMessage' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F72685FB-A6E6-5A9A-97F7-6DC1056E63CE\\",\\n \\"Syntax\\": [\\n {\\n \\"StartLineNumber\\": 2,\\n \\"StartColumn\\": 2,\\n \\"EndLineNumber\\": 5,\\n \\"EndColumn\\": 5,\\n \\"Message\\": \\"undefined name \'ab\'\\",\\n \\"Severity\\": 4\\n }\\n ]\\n}","type":"json"}]',
'title' => 'VerifyPythonFile',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPythonFile'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'yundun-sas:VerifyPythonFile',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'ThreatDetection', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'endpoint' => 'sophonsoar.ap-southeast-1.aliyuncs.com', 'vpc' => 'sophonsoar-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'sophonsoar.aliyuncs.com', 'endpoint' => 'sophonsoar.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'Component.External.NotExist', 'message' => 'Component does not exist.', 'http_code' => 400, 'description' => 'Component does not exist.'],
['code' => 'ComponentAsset.External.NotExist', 'message' => 'The component asset is not exist.', 'http_code' => 400, 'description' => 'The asset corresponding to the component you entered does not exist. Please enter it again.'],
['code' => 'Playbook.Abnormal.ERROR', 'message' => 'Interface call exception, please contact the developer.', 'http_code' => 400, 'description' => ''],
['code' => 'Playbook.External.AccountError', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'Parameter error. Please login with an buy user account. Verify the provided parameters and try again.'],
['code' => 'Playbook.External.DebugError', 'message' => 'Debugging the script failed. Please verify whether the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => ''],
['code' => 'Playbook.External.InvalidParameter', 'message' => 'The request parameter is incorrect. Please verify the provided parameters and try again.', 'http_code' => 400, 'description' => 'The request parameter is incorrect. Please verify the provided parameters and try again.'],
['code' => 'Playbook.External.ParamError', 'message' => 'The parameters of the request interface are wrong. Please verify the parameters and request again.', 'http_code' => 400, 'description' => 'The parameters of the request interface are incorrect. Please verify the parameters and request again.'],
['code' => 'Playbook.External.PublishError', 'message' => 'Failed to publish or run the script. Please verify that the status and configuration of the script are correct before trying again.', 'http_code' => 400, 'description' => 'Failed to publish or run the script. Please check whether the status and configuration of the script are correct before trying again.'],
['code' => 'Playbook.External.StatusError', 'message' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.', 'http_code' => 400, 'description' => 'The status of the script or disposal task is abnormal. Please check whether the status of the script or disposal task is correct.'],
['code' => 'Playbook.Internal.MetricsError', 'message' => 'The configuration information is abnormal, please check the relevant configuration.', 'http_code' => 400, 'description' => 'The configuration information is abnormal. You are requested to check the configuration.'],
['code' => 'Playbook.Internal.RecordError', 'message' => 'The data format is abnormal, please check whether the data format meets the requirements.', 'http_code' => 400, 'description' => 'The data format is abnormal. Check whether the data format meets the requirements.'],
['code' => 'SYS_ERROR', 'message' => 'Please login with an buy user account.', 'http_code' => 400, 'description' => 'The parameter is incorrect. Please verify the provided parameters and try again: Please use the purchase account to access.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'RunNotifyComponentWithEmail'],
['description' => 'Request parameters changed', 'api' => 'RunNotifyComponentWithMessageCenter'],
['description' => 'Request parameters changed', 'api' => 'RunNotifyComponentWithWebhook'],
],
'createdAt' => '2025-12-09T11:25:25.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'RunPython3Script'],
],
'createdAt' => '2025-11-27T13:31:32.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribePlaybooks'],
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeProcessTasks'],
],
'createdAt' => '2024-11-01T08:33:07.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribeProcessTasks'],
],
'createdAt' => '2024-05-21T08:18:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribePlaybookInputOutput'],
],
'createdAt' => '2024-03-21T02:56:51.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'DescribeExecutePlaybooks'],
['description' => 'Response parameters changed', 'api' => 'DescribePlaybook'],
['description' => 'Response parameters changed', 'api' => 'DescribeProcessTasks'],
],
'createdAt' => '2024-03-19T03:26:23.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'DescribePlaybookInputOutput'],
],
'createdAt' => '2024-03-15T02:09:33.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ModifyPlaybook'],
],
'createdAt' => '2023-12-07T09:16:36.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeUsedInfos'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordInOutput'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookInputOutput'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentsJs'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunPython3Script'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DebugPlaybook'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerPlaybook'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeGroupProductions'],
['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTasks'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPythonFile'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarTaskAndActions'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePlaybook'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteComponentAsset'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentPlaybook'],
['threshold' => '35', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybooks'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentList'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssets'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNodeParamTags'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiList'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookReleases'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CopyPlaybook'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeField'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeVendorApiList'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePopApi'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSophonCommands'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeOpenApiInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybook'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyComponentAsset'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNumberMetrics'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDistinctReleases'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchModifyInstanceStatus'],
['threshold' => '40', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessTaskCount'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyPlaybook'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ConvertPlaybook'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInputOutput'],
['threshold' => '20', 'countWindow' => 2, 'regionId' => '*', 'api' => 'TriggerSophonPlaybook'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishPlaybook'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescriberPython3ScriptLogs'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ComparePlaybooks'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeExecutePlaybooks'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeNotifyTemplateList'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeProcessStatistics'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RevertPlaybookRelease'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybook'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeComponentAssetForm'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookMetrics'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePlaybook'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeLatestRecordSchema'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPlaybookInstanceStatus'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithEmail'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RenamePlaybookNode'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecords'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryTreeData'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnumItems'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithWebhook'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePlaybookNodesOutput'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSoarRecordActionOutputList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunNotifyComponentWithMessageCenter'],
['threshold' => '50', 'countWindow' => 5, 'regionId' => '*', 'api' => 'TriggerProcessTask'],
],
],
'ram' => [
'productCode' => 'ThreatDetection',
'productName' => 'Security Center',
'ramCodes' => ['threatdetection', 'yundun-aegis', 'yundun-sas'],
'ramLevel' => 'SERVICE',
'ramConditions' => [
[
'name' => 'acs:ResourceGroupId',
'schema' => ['type' => 'String', 'description' => '资源组ID'],
],
],
'ramActions' => [],
'resourceTypes' => [],
],
];
|