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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Sas', 'version' => '2021-01-14'],
'directories' => [
[
'id' => 195991,
'title' => null,
'type' => 'directory',
'children' => ['DescribeScreenOperateInfo', 'DescribeScreenAttackAnalysisData', 'DescribeScreenCloudHcRisk', 'DescribeScreenEmerRisk', 'DescribeScreenDataMap', 'CreateScreenSetting', 'DeleteScreenSetting', 'DescribeScreenVersionConfig', 'DescribeScreenUploadPicture', 'DescribeScreenTitles', 'DescribeScreenSummaryInfo', 'DescribeScreenSetting', 'DescribeScreenSecurityStatInfo', 'DescribeScreenScoreThread', 'DescribeScreenOssUploadInfo', 'DescribeScreenHostStatistics', 'DescribeScreenAlarmEventList'],
],
[
'id' => 0,
'title' => '其它',
'type' => 'directory',
'children' => ['ListGlobalUserConfig', 'GetFileDetectResultInner'],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'DescribeScreenOperateInfo' => [
'summary' => 'Queries operations information.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171980',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [
[
'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"
.'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The beginning of the time range to query. This value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1634725571000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6xxxxxxxx'],
'HealthCheckDealedCount' => ['description' => 'The number of handled baseline risks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SecurityEventDealedCount' => ['description' => 'The number of handled alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'VulnerabilityDealedCount' => ['description' => 'The number of handled vulnerabilities.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'VulValueArray' => [
'description' => 'The numbers of vulnerabilities that are detected at specified points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of vulnerabilities.'."\n", 'type' => 'string', 'example' => '4'],
],
'HealthCheckValueArray' => [
'description' => 'The numbers of baseline risks that are detected at specified points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of baseline risks.'."\n", 'type' => 'string', 'example' => '3'],
],
'SuspEventValueArray' => [
'description' => 'The numbers of alerts that are detected at specified points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of alerts.'."\n", 'type' => 'string', 'example' => '2'],
],
'DateArray' => [
'description' => 'The points in time when data is collected in the trend chart.'."\n",
'type' => 'array',
'items' => ['description' => 'The point in time when data is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2024-08-05'],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6xxxxxxxx\\",\\n \\"HealthCheckDealedCount\\": 1,\\n \\"SecurityEventDealedCount\\": 1,\\n \\"VulnerabilityDealedCount\\": 1,\\n \\"VulValueArray\\": [\\n \\"4\\"\\n ],\\n \\"HealthCheckValueArray\\": [\\n \\"3\\"\\n ],\\n \\"SuspEventValueArray\\": [\\n \\"2\\"\\n ],\\n \\"DateArray\\": [\\n \\"2024-08-05\\"\\n ]\\n}","type":"json"}]',
'title' => 'DescribeScreenOperateInfo',
],
'DescribeScreenAttackAnalysisData' => [
'summary' => 'Queries attack and defense events that are displayed on a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The details of attack analysis. Valid values:'."\n"
."\n"
.'* **TOTAL**: number of attacks'."\n"
.'* **TREND**: attack trend'."\n"
.'* **PIE_CHART**: distribution of attack by type'."\n"
.'* **SOURCE_TOP**: Top 5 attack sources'."\n"
.'* **CLIENT_TOP**: Top 5 attacked assets'."\n"
.'* **DETAILS**: attack details'."\n"
."\n"
.'> If the Type parameter is set to **DETAILS**, you must specify the CurrentPage and PageSize parameters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'DETAILS'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The timestamp when the attack starts. Unit: seconds.'."\n"
."\n"
.'> The start time that you specify must be within the previous 40 days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1644027670'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The timestamp when the attack stops. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1668064495000'],
],
[
'name' => 'Data',
'in' => 'query',
'schema' => ['description' => 'The condition that is used to filter attack events.'."\n"
."\n"
.'> The following list describes the valid values of the crack_type field:'."\n"
."\n"
.'* 3: brute-force attack on MySQL'."\n"
."\n"
.'* 4: FTP brute-force attack'."\n"
."\n"
.'* 5: SSH brute-force attack'."\n"
."\n"
.'* 6: RDP brute-force attack'."\n"
."\n"
.'* 9: brute-force attack on Microsoft SQL Server'."\n"
."\n"
.'* 101: intercepted attack on Java Struts 2'."\n"
."\n"
.'* 102: intercepted attack on Redis'."\n"
."\n"
.'* 103: communication with AntSword Webshell'."\n"
."\n"
.'* 104: communication with China Chopper Webshell'."\n"
."\n"
.'* 133: communication with XISE Webshell'."\n"
."\n"
.'* sqli: SQL injection'."\n"
."\n"
.'* codei: code execution'."\n"
."\n"
.'* xss: Cross-Site Scripting (XSS) attack'."\n"
."\n"
.'* lfi: local file inclusion'."\n"
."\n"
.'* rfi: remote file inclusion'."\n"
."\n"
.'* webshell: trojan script'."\n"
."\n"
.'* upload: vulnerability upload'."\n"
."\n"
.'* path: directory traversal'."\n"
."\n"
.'* bypass: unauthorized access'."\n"
."\n"
.'* csrf: cross-site request forgery (CSRF)'."\n"
."\n"
.'* crlf: carriage return line feed (CRLF)'."\n"
."\n"
.'* other: others'."\n", 'type' => 'string', 'required' => false, 'example' => '{"crack_type":"9"}'],
],
[
'name' => 'Base64',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to encode the value of the **client_url** field in the query results by using the Base64 algorithm. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The page number. Pages start from page **1**.'."\n"
."\n"
.'> If the Type parameter is set to **DETAILS**, you must specify this parameter. If the Type parameter is not set to **DETAILS**, you cannot specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.'."\n"
."\n"
.'> If the Type parameter is set to **DETAILS**, you must specify this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => 'The attack events. Valid values:'."\n"
."\n"
.'* **client_url**: the URL of the attack request.'."\n"
."\n"
.'* **internetIp**: the IP address of the asset.'."\n"
."\n"
.'* **instanceName**: the name of the asset.'."\n"
."\n"
.'* **table_src**: the data source.'."\n"
."\n"
.'* **uuid**: the Universally Unique Identifier (UUID) of the asset.'."\n"
."\n"
.'* **crack_method**: the method of the attack request.'."\n"
."\n"
.'* **crack_hour**: the attack time.'."\n"
."\n"
.'* **crack_src_ip**: the IP address from which the attack is launched.'."\n"
."\n"
.'* **instanceId**: the ID of the asset.'."\n"
."\n"
.'* **dst_port**: the attacked port.'."\n"
."\n"
.'* **client_ip**: the attacked IP address.'."\n"
."\n"
.'* **location**: the region from which the attack is launched.'."\n"
."\n"
.'* **aliuid**: the ID of the Alibaba Cloud account.'."\n"
."\n"
.'* **crack_cnt**: the number of times that the attack is launched.'."\n"
."\n"
.'* **crack_type**: the type of the attack. Valid values:'."\n"
."\n"
.' * **113**: improper authorization'."\n"
.' * **112**: redirection attack'."\n"
.' * **upload**: vulnerability upload'."\n"
.' * **other**: others'."\n"
.' * **webshell**: trojan script'."\n"
.' * **201**: suspicious connection'."\n"
.' * **9**: brute-force attack on Microsoft SQL Server'."\n"
.' * **5**: SSH brute-force attack'."\n"
.' * **6**: RDP brute-force attack'."\n"
.' * **lfi**: local file inclusion'."\n"
.' * **7**: code execution'."\n"
.' * **sqli**: SQL injection'."\n"
.' * **209**: web attack'."\n"
.' * **31**: buffer overflow'."\n"
.' * **3**: brute-force attack on MySQL'."\n"
.' * **30**: clickjacking'."\n"
.' * **4**: FTP brute-force attack'."\n"
.' * **bypass**: unauthorized access'."\n"
.' * **33**: format string'."\n"
.' * **deeplearning**: others'."\n"
.' * **32**: integer overflow'."\n"
.' * **203**: brute-force attack'."\n"
.' * **34**: race condition'."\n"
.' * **rfi**: remote file inclusion'."\n"
.' * **0**: SQL injection attack'."\n"
.' * **212**: mining behavior'."\n"
.' * **213**: reverse shell'."\n"
.' * **211**: worm'."\n"
.' * **61**: session timeout'."\n"
.' * **20**: directory traversal'."\n"
.' * **xss**: XSS attack'."\n"
.' * **22**: unauthorized access'."\n"
.' * **21**: scan attack'."\n"
.' * **24**: file modification'."\n"
.' * **26**: file deletion'."\n"
.' * **25**: file reading'."\n"
.' * **28**: CRLF injection'."\n"
.' * **27**: logic error'."\n"
.' * **29**: template injection'."\n"
.' * **csrf**: CSRF'."\n"
.' * **path**: directory traversal'."\n"
.' * **crlf**: CRLF'."\n"
.' * **102**: CSRF'."\n"
.' * **103**: server-side request forgery (SSRF)'."\n"
.' * **101**: XSS'."\n"
.' * **11**: file inclusion'."\n"
.' * **10**: file upload'."\n"
.' * **12**: vulnerability upload'."\n"
.' * **15**: unauthorized access'."\n"
.' * **14**: information leakage'."\n"
.' * **17**: XML entity injection'."\n"
.' * **16**: insecure configuration'."\n"
.' * **19**: Lightweight Directory Access Protocol (LDAP) injection'."\n"
.' * **18**: XPath injection'."\n"
.' * **codei**: code execution'."\n", 'type' => 'string', 'example' => '[{\\"crack_hour\\":1662480000000,\\"crack_cnt\\":471},{\\"crack_hour\\":1662483600000,\\"crack_cnt\\":461},{\\"crack_hour\\":1662487200000,\\"crack_cnt\\":445},{\\"crack_hour\\":1662490800000,\\"crack_cnt\\":471},{\\"crack_hour\\":1662494400000,\\"crack_cnt\\":534},{\\"crack_hour\\":1662498000000,\\"crack_cnt\\":652},{\\"crack_hour\\":1662501600000,\\"crack_cnt\\":706},{\\"crack_hour\\":1662505200000,\\"crack_cnt\\":613},{\\"crack_hour\\":1662508800000,\\"crack_cnt\\":578},{\\"crack_hour\\":1662512400000,\\"crack_cnt\\":577},{\\"crack_hour\\":1662516000000,\\"crack_cnt\\":616},{\\"crack_hour\\":1662519600000,\\"crack_cnt\\":597},{\\"crack_hour\\":1662523200000,\\"crack_cnt\\":575},{\\"crack_hour\\":1662526800000,\\"crack_cnt\\":507}]'],
'PageSize' => ['description' => 'The number of entries per page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-Bxxxxxxxx'],
'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
'Page' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'A server error occurred.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662480000000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":471},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662483600000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":461},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662487200000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":445},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662490800000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":471},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662494400000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":534},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662498000000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":652},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662501600000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":706},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662505200000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":613},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662508800000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":578},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662512400000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":577},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662516000000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":616},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662519600000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":597},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662523200000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":575},{\\\\\\\\\\\\\\"crack_hour\\\\\\\\\\\\\\":1662526800000,\\\\\\\\\\\\\\"crack_cnt\\\\\\\\\\\\\\":507}]\\",\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-Bxxxxxxxx\\",\\n \\"Total\\": 11,\\n \\"Page\\": 1\\n}","type":"json"}]',
'title' => 'DescribeScreenAttackAnalysisData',
],
'DescribeScreenCloudHcRisk' => [
'summary' => 'Queries the baseline risks of a cloud service.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171953',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0C8487EF-50C2-54BB-8634-10F8C35D****'],
'CloudHcRiskItems' => [
'description' => 'An array that consists of the check items.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Pass' => ['description' => 'The status of the check item. Valid values:'."\n"
."\n"
.'* **true**: The check item is configured or enabled, and the check is passed.'."\n"
.'* **false**: The check item is not configured or disabled, and the check fails.'."\n", 'type' => 'boolean'],
'CheckItem' => ['description' => 'The name of the check item.'."\n", 'type' => 'string', 'example' => 'OSS-PublicReadOpenManifestFileWithoutEncryption'],
'Level' => ['description' => 'The severity of the check item. Valid values:'."\n"
."\n"
.'* **HIGH**'."\n"
.'* **MEDIUM**'."\n"
.'* **LOW**'."\n", 'type' => 'string', 'example' => 'HIGH'],
'AffectCount' => ['description' => 'The number of affected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0C8487EF-50C2-54BB-8634-10F8C35D****\\",\\n \\"CloudHcRiskItems\\": [\\n {\\n \\"Pass\\": true,\\n \\"CheckItem\\": \\"OSS-PublicReadOpenManifestFileWithoutEncryption\\",\\n \\"Level\\": \\"HIGH\\",\\n \\"AffectCount\\": 5\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeScreenCloudHcRisk',
],
'DescribeScreenEmerRisk' => [
'summary' => 'Queries the urgent vulnerabilities of a cloud service.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '171869',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-6xxxxxxxx'],
'CloudHcRiskItems' => [
'description' => 'The information about the urgent vulnerability.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VulName' => ['description' => 'The name of the vulnerability.'."\n", 'type' => 'string', 'example' => 'ALINUX3-SA-2025:0155: cups security update'],
'Level' => ['description' => 'The risk level of the vulnerability. Valid values:'."\n"
."\n"
.'* **asap**: high'."\n"
.'* **LATER**: medium'."\n"
.'* **NNTF**: low'."\n", 'type' => 'string', 'example' => 'ASAP'],
'AffectCount' => ['description' => 'The number of affected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-6xxxxxxxx\\",\\n \\"CloudHcRiskItems\\": [\\n {\\n \\"VulName\\": \\"polkit pkexec 本地提权漏洞(CVE-2021-4034)\\",\\n \\"Level\\": \\"ASAP\\",\\n \\"AffectCount\\": 3\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeScreenEmerRisk',
],
'DescribeScreenDataMap' => [
'summary' => 'Queries the data records that can be displayed on a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => 'The data objects that are used for the call.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7532B7EE-7CE7-5F4D-BF04-XXXXXXXX'],
'SasScreenTypeList' => [
'description' => 'The data types that can be displayed on the dashboard.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TypeCode' => ['description' => 'The data type code. Valid values:'."\n"
."\n"
.'* **ASSETS**: asset'."\n"
.'* **VUL**: vulnerability'."\n"
.'* **HC**: baseline'."\n"
.'* **ALARM**: alert'."\n"
.'* **SE_OP**: security operations information'."\n"
.'* **BEST_PRA**: best practices on the cloud platform'."\n", 'type' => 'string', 'example' => 'ASSETS'],
'Type' => ['description' => 'The data type.', 'type' => 'string', 'example' => 'ASSETS'],
'TypeData' => [
'description' => 'The data models.'."\n",
'type' => 'array',
'items' => [
'description' => 'The data model object.'."\n",
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The code of the data record. Valid values:'."\n"
."\n"
.'* **ASSETS_ASSETS**: asset'."\n"
.'* **VUL_VUL**: vulnerability'."\n"
.'* **HC_HC**: baseline'."\n"
.'* **ALARM_ALARM**: alert'."\n"
.'* **SE_OP_SE_TREND**: security posture'."\n"
.'* **SE_OP_ATTACK_CLASS**: attack type'."\n"
.'* **SE_OP_SE_OP**: security operations information'."\n"
.'* **SE_OP_ATTACK_TOP5**: TOP 5 attack sources'."\n"
.'* **SE_OP_FLOW_TREND**: traffic trend'."\n"
.'* **SE_OP_ATTACK_TREND**: attack trend'."\n", 'type' => 'string', 'example' => 'VUL_VUL'],
'Title' => ['description' => 'The title of the data record.', 'type' => 'string', 'example' => 'ASSETS'],
'Id' => ['description' => 'The ID of the data record.'."\n", 'type' => 'string', 'example' => '25'],
'Date' => [
'description' => 'The time ranges.'."\n",
'type' => 'array',
'items' => [
'description' => 'The time range.'."\n",
'type' => 'object',
'properties' => [
'Unit' => ['description' => 'The time unit. Valid values:'."\n"
."\n"
.'* **second**'."\n"
.'* **hour**'."\n"
.'* **day**'."\n", 'type' => 'string', 'example' => 'second'],
'Value' => ['description' => 'The time range of the corresponding time unit.'."\n", 'type' => 'string', 'example' => '1'],
],
],
],
],
],
],
],
'description' => '',
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7532B7EE-7CE7-5F4D-BF04-XXXXXXXX\\",\\n \\"SasScreenTypeList\\": [\\n {\\n \\"TypeCode\\": \\"ASSETS\\",\\n \\"Type\\": \\"资产\\",\\n \\"TypeData\\": [\\n {\\n \\"Code\\": \\"VUL_VUL\\",\\n \\"Title\\": \\"资产\\",\\n \\"Id\\": \\"25\\",\\n \\"Date\\": [\\n {\\n \\"Unit\\": \\"second\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeScreenDataMap',
],
'CreateScreenSetting' => [
'summary' => 'Creates configurations for a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '171935',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Title',
'in' => 'query',
'schema' => ['description' => 'The title.'."\n"
."\n"
.'> We recommend that the title contain up to five characters.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test'],
],
[
'name' => 'ScreenDataMap',
'in' => 'query',
'schema' => ['description' => 'The configurations of the dashboard.'."\n", 'type' => 'string', 'required' => true, 'example' => '[{"positionId":1,"componentId":3,"date":"7-day"},{"positionId":2,"componentId":1,"date":"0-second"},{"positionId":3,"componentId":8,"date":"15-day"},{"positionId":4,"componentId":11,"date":"15-day"},{"positionId":5,"componentId":23,"date":"24-hour"},{"positionId":6,"componentId":17,"date":"24-hour"},{"positionId":7,"componentId":13,"date":"24-hour"},{"positionId":8,"componentId":25,"date":"0-second"}]'],
],
[
'name' => 'LogoUrl',
'in' => 'query',
'schema' => ['description' => 'The URL of the dashboard logo.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://img.alicdn.com/tfs/xxxx.png'],
],
[
'name' => 'LogoPower',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to highlight the title. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'false'],
],
[
'name' => 'MonitorUrl',
'in' => 'query',
'schema' => ['description' => 'The custom monitoring URL.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://monitor.xxxxxxx'],
],
[
'name' => 'ScreenDefault',
'in' => 'query',
'schema' => ['description' => 'The default dashboard identifier. Valid values:'."\n"
."\n"
.'* **0**: custom dashboard'."\n"
.'* **1**: default dashboard'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => 'The dashboard ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Id' => ['description' => 'The dashboard ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123'],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '898F7AA7-CECD-5EC7-AF4D-664C601B****'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 123,\\n \\"RequestId\\": \\"898F7AA7-CECD-5EC7-AF4D-664C601B****\\"\\n}","type":"json"}]',
'title' => 'CreateScreenSetting',
],
'DeleteScreenSetting' => [
'summary' => 'Deletes dashboard configurations.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '171997',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => 'The dashboard ID.'."\n"
."\n"
.'> You can call the [DescribeScreenTitles](~~DescribeScreenTitles~~) operation to query the dashboard ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-156E0F9F****'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-156E0F9F****\\"\\n}","type":"json"}]',
'title' => 'DeleteScreenSetting',
],
'DescribeScreenVersionConfig' => [
'summary' => 'Queries the configurations of the security dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171756',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SasLog' => ['description' => 'Indicates whether the log analysis feature is purchased. Valid values:'."\n"
."\n"
.'* **0**: no'."\n"
.'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SasScreen' => ['description' => 'Indicates whether the security dashboard is purchased. Valid values:'."\n"
."\n"
.'* **0**: no'."\n"
.'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AssetLevel' => ['description' => 'The quota for servers that can be protected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'example' => 'sas-b5***'],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'CE500770-42D3-442E-9DDD-1XXXXXXX'],
'Version' => ['description' => 'The edition of purchased Security Center. Valid values:'."\n"
."\n"
.'* **1**: Basic edition'."\n"
.'* **3**: Enterprise edition'."\n"
.'* **5**: Advanced edition'."\n"
.'* **6**: Anti-virus edition'."\n"
.'* **7**: Ultimate edition'."\n"
.'* **8**: Multi-version edition'."\n"
.'* **10**: Value-added Plan edition'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'ReleaseTime' => ['description' => 'The timestamp when the Security Center subscription ends. Unit: milliseconds.'."\n"
."\n"
.'> If you do not renew the subscription within seven days after the expiration date, Security Center of a paid edition is automatically downgraded to Security Center Basic. In this case, you can no longer use the features of the paid edition or view the existing configurations or statistics such as DDoS alerts in Security Center. You must purchase Security Center of a paid edition to use relevant features. For more information, see [Purchase Security Center](~~42308~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1625846400000'],
'IsTrialVersion' => ['description' => 'Indicates whether Security Center runs the free trial edition. Valid values:'."\n"
."\n"
.'* **0**: no'."\n"
.'* **1**: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SasLog\\": 1,\\n \\"SasScreen\\": 0,\\n \\"AssetLevel\\": 30,\\n \\"InstanceId\\": \\"sas-b5***\\",\\n \\"RequestId\\": \\"CE500770-42D3-442E-9DDD-1XXXXXXX\\",\\n \\"Version\\": 3,\\n \\"ReleaseTime\\": 1625846400000,\\n \\"IsTrialVersion\\": 0\\n}","type":"json"}]',
'title' => 'DescribeScreenVersionConfig',
'responseParamsDescription' => 'When you call this operation, both the response parameters in the preceding table and the following parameters are returned.'."\n"
."\n"
.'* **AvdsFlag**'."\n"
.'* **FLag**'."\n"
.'* **CreateTime**'."\n"
.'* **IsSasOpening**'."\n"
.'* **Log**'."\n"
.'* **AgentlessCapacity**'."\n"
."\n"
.'> The preceding parameters are deprecated. You can ignore the parameters.'."\n",
],
'DescribeScreenUploadPicture' => [
'summary' => 'Queries the URL of an image on the security dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '172535',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'LogoUrl',
'in' => 'query',
'schema' => ['description' => 'The Object Storage Service (OSS) URL of the logo image on the security dashboard.'."\n"
."\n"
.'> You can call the [DescribeScreenOssUploadInfo](~~DescribeScreenOssUploadInfo~~) operation to concatenate the values of the host and key fields.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://security-pic.oss-cn-hangzhou.aliyuncs.com/screenLogo/1766185894104675/c28bd4d2-c5c1-43f8-9ef5-de41d762xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Url' => ['description' => 'The image URL.'."\n", 'type' => 'string', 'example' => 'http://security-pic.oss-cn-hangzhou.aliyuncs.com/screenLogo/1766185894104675/c28bd4d2-c5c1-43f8-9ef5-de41d76218eb?Expires=1723720214&OSSAccessKeyId=LTAI4G1mgPbjvGQuiV1Xxxxx&Signature=4o3xxxx'],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0Dxxxx'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Url\\": \\"http://security-pic.oss-cn-hangzhou.aliyuncs.com/screenLogo/1766185894104675/c28bd4d2-c5c1-43f8-9ef5-de41d76218eb?Expires=1723720214&OSSAccessKeyId=LTAI4G1mgPbjvGQuiV1Xxxxx&Signature=4o3xxxx\\",\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0Dxxxx\\"\\n}","type":"json"}]',
'title' => 'DescribeScreenUploadPicture',
],
'DescribeScreenTitles' => [
'summary' => 'Queries all dashboard configurations.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '171930',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-XXXXXXXXXXX'],
'SasScreenSettingList' => [
'description' => 'The dashboard configurations within the current account.'."\n",
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ScreenTitle' => ['description' => 'The dashboard title.'."\n", 'type' => 'string', 'example' => 'titlexxx'],
'ScreenID' => ['description' => 'The dashboard ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3267'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-XXXXXXXXXXX\\",\\n \\"SasScreenSettingList\\": [\\n {\\n \\"ScreenTitle\\": \\"titlexxx\\",\\n \\"ScreenID\\": 3267\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeScreenTitles',
],
'DescribeScreenSummaryInfo' => [
'summary' => 'Queries the statistics of a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171871',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '23AD0BD2-8771-5647-819E-XXXXXXXX'],
'AegisClientOfflineCount' => ['description' => 'The number of unprotected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'AegisClientOnlineCount' => ['description' => 'The number of protected assets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '127'],
'SecurityScore' => ['description' => 'The security score of the assets. Valid values:'."\n"
."\n"
.'* 95 to 100: The assets are secure.'."\n"
.'* 85 to 94: The assets are exposed to a few security risks. We recommend that you reinforce your security system at the earliest opportunity.'."\n"
.'* 70 to 84: The assets are exposed to multiple security risks. We recommend that you reinforce your security system at the earliest opportunity.'."\n"
.'* 69 or lower: The current security system is unable to protect the assets against intrusions. We recommend that you reinforce your security system at the earliest opportunity.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23AD0BD2-8771-5647-819E-XXXXXXXX\\",\\n \\"AegisClientOfflineCount\\": 12,\\n \\"AegisClientOnlineCount\\": 127,\\n \\"SecurityScore\\": 100\\n}","type":"json"}]',
'title' => 'DescribeScreenSummaryInfo',
],
'DescribeScreenSetting' => [
'summary' => 'Queries the configurations of a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171876',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [
[
'name' => 'Id',
'in' => 'query',
'schema' => ['description' => 'The dashboard ID.'."\n"
."\n"
.'> You can call the [DescribeScreenTitles](~~DescribeScreenTitles~~) operation to query the dashboard ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '101786'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'ScreenId' => ['description' => 'The ID of the current dashboard. The value is the same as the value of the Id request parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1004770'],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'B9A68671-BD84-55CD-807A-XXXXXXXXX'],
'ScreenDefault' => ['description' => 'Indicates whether the dashboard is the default dashboard. Valid values:'."\n"
."\n"
.'* **1**: yes'."\n"
.'* **0**: no'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7849'],
'LogoPower' => ['description' => 'Indicates whether the dashboard is enabled. Valid values:'."\n"
."\n"
.'* **yes**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'false'],
'LogoUrl' => ['description' => 'The URL of the dashboard logo.'."\n", 'type' => 'string', 'example' => 'https://img.alicdn.XXXXXXXXXXX.jpg'],
'Title' => ['description' => 'The dashboard title.'."\n", 'type' => 'string', 'example' => 'Daily Report'],
'ScreenDataMap' => ['description' => 'The time range.'."\n", 'type' => 'string', 'example' => '[{\\"positionId\\":XX,\\"componentId\\":XX,\\"date\\":\\"XXX\\"},{\\"positionId\\":X,\\"componentId\\":X,\\"date\\":\\"XXX\\"},{\\"positionId\\":X,\\"componentId\\":X,\\"date\\":\\"XX\\"},{\\"positionId\\":X,\\"componentId\\":XX,\\"date\\":\\"XXX\\"},{\\"positionId\\":X,\\"componentId\\":XX,\\"date\\":\\"XX\\"},{\\"positionId\\":X,\\"componentId\\":XX,\\"date\\":\\"XX\\"},{\\"positionId\\":X,\\"componentId\\":XX,\\"date\\":\\"XXX\\"},{\\"positionId\\":X,\\"componentId\\":,\\"date\\":\\"XXXX\\"}]'],
'MonitorUrl' => ['description' => 'The URL for dashboard service monitoring.'."\n", 'type' => 'string', 'example' => 'https://XXX.monitor.XXXXcom'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ScreenId\\": 1004770,\\n \\"RequestId\\": \\"B9A68671-BD84-55CD-807A-XXXXXXXXX\\",\\n \\"ScreenDefault\\": 7849,\\n \\"LogoPower\\": false,\\n \\"LogoUrl\\": \\"https://img.alicdn.XXXXXXXXXXX.jpg\\",\\n \\"Title\\": \\"Daily Report\\",\\n \\"ScreenDataMap\\": \\"[{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":XX,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":XX,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XXX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XXX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":XX,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XXX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":XX,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":XX,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":XX,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XXX\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"positionId\\\\\\\\\\\\\\":X,\\\\\\\\\\\\\\"componentId\\\\\\\\\\\\\\":,\\\\\\\\\\\\\\"date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"XXXX\\\\\\\\\\\\\\"}]\\",\\n \\"MonitorUrl\\": \\"https://XXX.monitor.XXXXcom\\"\\n}","type":"json"}]',
'title' => 'DescribeScreenSetting',
],
'DescribeScreenSecurityStatInfo' => [
'summary' => 'Queries the handled risks.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F8B6F758-BCD4-597A-8A2C-DA5A552C****'],
'SecurityEvent' => [
'description' => 'The statistics of handled alerts.'."\n",
'type' => 'object',
'properties' => [
'SuspiciousCount' => ['description' => 'The total number of alerts at the suspicious level.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'SeriousCount' => ['description' => 'The total number of alerts at the urgent level.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'RemindCount' => ['description' => 'The total number of alerts at the reminding level.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'TotalCount' => ['description' => 'The total number of counts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'ValueArray' => [
'description' => 'The numbers of handled alerts at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of handled alerts at each point in time.'."\n", 'type' => 'string', 'example' => '444'],
],
'RemindList' => [
'description' => 'The numbers of **remind** alerts at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of **remind** alerts at each point in time.'."\n", 'type' => 'string', 'example' => '5,'],
],
'LevelsOn' => [
'description' => 'The risk levels of the involved alerts. Valid values:'."\n"
."\n"
.'* **remind**'."\n"
.'* **suspicious**'."\n"
.'* **serious**'."\n",
'type' => 'array',
'items' => ['description' => 'The risk level of the unhandled alert. Valid values:'."\n"
."\n"
.'* **remind**'."\n"
.'* **suspicious**'."\n"
.'* **serious**'."\n", 'type' => 'string', 'example' => 'remind'],
],
'DateArray' => [
'description' => 'The points in time when data of handled alerts is collected in the trend chart.'."\n",
'type' => 'array',
'items' => ['description' => 'The point in time when data of unhandled alerts is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-08'],
],
'SuspiciousList' => [
'description' => 'The numbers of **suspicious** alerts at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of **suspicious** alerts at each point in time.'."\n", 'type' => 'string', 'example' => '111,'],
],
'SeriousList' => [
'description' => 'The numbers of **serious** alerts at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of **serious** alerts at each point in time.'."\n", 'type' => 'string', 'example' => '111'],
],
],
],
'AttackEvent' => [
'description' => 'The detailed statistics of attacks.'."\n",
'type' => 'object',
'properties' => [
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1096'],
'DateArray' => [
'description' => 'The points in time when the number of attacks is collected in the trend chart.'."\n",
'type' => 'array',
'items' => ['description' => 'The point in time when the number of attacks is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-04'],
],
'ValueArray' => [
'description' => 'The numbers of attacks at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of attacks at each point in time.'."\n", 'type' => 'string', 'example' => '2620'],
],
],
],
'HealthCheck' => [
'description' => 'The detailed statistics of baseline risk items.'."\n",
'type' => 'object',
'properties' => [
'HighCount' => ['description' => 'The number of baseline risk items that have the high-risk level on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'LowCount' => ['description' => 'The number of baseline risk items that have the low-risk level on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'TotalCount' => ['description' => 'The total number of baseline risk items on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
'MediumCount' => ['description' => 'The number of baseline risk items that have the medium-risk level on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '21'],
'ValueArray' => [
'description' => 'The total numbers of baseline risk items at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The total number of baseline risk items at each point in time.'."\n", 'type' => 'string', 'example' => '31'],
],
'LevelsOn' => [
'description' => 'The risk levels of baseline risk items. Valid values:'."\n"
."\n"
.'* **high**'."\n"
.'* **medium**'."\n"
.'* **low**'."\n",
'type' => 'array',
'items' => ['description' => 'The risk level of the baseline risk item. Valid values:'."\n"
."\n"
.'* **high**'."\n"
.'* **medium**'."\n"
.'* **low**'."\n", 'type' => 'string', 'example' => 'high'],
],
'LowList' => [
'description' => 'The numbers of baseline risk items that have the low-risk level at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of baseline risk items that have the low-risk level at each point in time.'."\n", 'type' => 'string', 'example' => '0'],
],
'MediumList' => [
'description' => 'The numbers of baseline risk items that have the medium-risk level at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of baseline risk items that have the medium-risk level at each point in time.'."\n", 'type' => 'string', 'example' => '0'],
],
'DateArray' => [
'description' => 'The points in time when data of baseline risk items is collected in the trend chart.'."\n",
'type' => 'array',
'items' => ['description' => 'The point in time when data of baseline risk items is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-04'],
],
'HighList' => [
'description' => 'The numbers of baseline risk items that have the high-risk level at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of baseline risk items that have the high-risk level at each point in time.'."\n", 'type' => 'string', 'example' => '11'],
],
],
],
'Vulnerability' => [
'description' => 'The number of vulnerabilities.'."\n",
'type' => 'object',
'properties' => [
'NntfCount' => ['description' => 'The number of **low-risk** unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'LaterCount' => ['description' => 'The number of **medium-risk** unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '275'],
'TotalCount' => ['description' => 'The total number of unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '384'],
'AsapCount' => ['description' => 'The number of **high-risk** unfixed vulnerabilities on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '109'],
'NntfList' => [
'description' => 'The numbers of **low-risk** unfixed vulnerabilities at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of **low-risk** unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '0'],
],
'AsapList' => [
'description' => 'The numbers of **high-risk** unfixed vulnerabilities at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of **high-risk** unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '60'],
],
'ValueArray' => [
'description' => 'The numbers of unfixed vulnerabilities at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '384'],
],
'LevelsOn' => [
'description' => 'The risk levels of unfixed vulnerabilities. Valid values:'."\n"
."\n"
.'* **asap**: high'."\n"
.'* **later**: medium'."\n"
.'* **nntf**: low'."\n",
'type' => 'array',
'items' => ['description' => 'The risk level of the unfixed vulnerability. Valid values:'."\n"
."\n"
.'* **asap**: high'."\n"
.'* **later**: medium'."\n"
.'* **nntf**: low'."\n", 'type' => 'string', 'example' => 'later'],
],
'LaterList' => [
'description' => 'The numbers of **medium-risk** unfixed vulnerabilities at all points in time.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of **medium-risk** unfixed vulnerabilities at each point in time.'."\n", 'type' => 'string', 'example' => '275'],
],
'DateArray' => [
'description' => 'The points in time when data of unfixed vulnerabilities is collected in the trend chart.'."\n",
'type' => 'array',
'items' => ['description' => 'The point in time when data of unfixed vulnerabilities is collected in the trend chart.'."\n", 'type' => 'string', 'example' => '2020-01-04'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F8B6F758-BCD4-597A-8A2C-DA5A552C****\\",\\n \\"SecurityEvent\\": {\\n \\"SuspiciousCount\\": 10,\\n \\"SeriousCount\\": 2,\\n \\"RemindCount\\": 0,\\n \\"TotalCount\\": 8,\\n \\"ValueArray\\": [\\n \\"444\\"\\n ],\\n \\"RemindList\\": [\\n \\"5,\\"\\n ],\\n \\"LevelsOn\\": [\\n \\"remind\\"\\n ],\\n \\"DateArray\\": [\\n \\"2020-01-08\\"\\n ],\\n \\"SuspiciousList\\": [\\n \\"111,\\"\\n ],\\n \\"SeriousList\\": [\\n \\"111\\"\\n ]\\n },\\n \\"AttackEvent\\": {\\n \\"TotalCount\\": 1096,\\n \\"DateArray\\": [\\n \\"2020-01-04\\"\\n ],\\n \\"ValueArray\\": [\\n \\"2620\\"\\n ]\\n },\\n \\"HealthCheck\\": {\\n \\"HighCount\\": 10,\\n \\"LowCount\\": 0,\\n \\"TotalCount\\": 32,\\n \\"MediumCount\\": 21,\\n \\"ValueArray\\": [\\n \\"31\\"\\n ],\\n \\"LevelsOn\\": [\\n \\"high\\"\\n ],\\n \\"LowList\\": [\\n \\"0\\"\\n ],\\n \\"MediumList\\": [\\n \\"0\\"\\n ],\\n \\"DateArray\\": [\\n \\"2020-01-04\\"\\n ],\\n \\"HighList\\": [\\n \\"11\\"\\n ]\\n },\\n \\"Vulnerability\\": {\\n \\"NntfCount\\": 0,\\n \\"LaterCount\\": 275,\\n \\"TotalCount\\": 384,\\n \\"AsapCount\\": 109,\\n \\"NntfList\\": [\\n \\"0\\"\\n ],\\n \\"AsapList\\": [\\n \\"60\\"\\n ],\\n \\"ValueArray\\": [\\n \\"384\\"\\n ],\\n \\"LevelsOn\\": [\\n \\"later\\"\\n ],\\n \\"LaterList\\": [\\n \\"275\\"\\n ],\\n \\"DateArray\\": [\\n \\"2020-01-04\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeScreenSecurityStatInfo',
],
'DescribeScreenScoreThread' => [
'summary' => 'Queries the trends of the scores on the security dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171949',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => 'The beginning of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.'."\n"
."\n"
.'> The time range between the start timestamp and the end timestamp cannot exceed **seven** days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1722840664501'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => 'The end of the time range to query. This value is a UNIX timestamp. Unit: milliseconds.'."\n"
."\n"
.'> The time range between the start timestamp and the end timestamp cannot exceed **seven** days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1723445464501'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D03DD0FD-6041-5107-AC00-383E28F1****'],
'Data' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'SocreThread' => [
'description' => 'The score on the security dashboard.'."\n",
'type' => 'array',
'items' => ['description' => 'The score on the security dashboard.'."\n", 'type' => 'string', 'example' => '80'],
],
'SocreThreadDate' => [
'description' => 'The date of the score on the security dashboard.'."\n",
'type' => 'array',
'items' => ['description' => 'The date of the score on the security dashboard.'."\n", 'type' => 'string', 'example' => '2024-07-01'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D03DD0FD-6041-5107-AC00-383E28F1****\\",\\n \\"Data\\": {\\n \\"SocreThread\\": [\\n \\"80\\"\\n ],\\n \\"SocreThreadDate\\": [\\n \\"2024-07-01\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeScreenScoreThread',
],
'DescribeScreenOssUploadInfo' => [
'summary' => 'Queries the configurations of a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '171993',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The name of the Object Storage Service (OSS) object.'."\n", 'type' => 'string', 'example' => 'DegradePool_Offset_****'],
'Signature' => ['description' => 'The OSS signature.'."\n", 'type' => 'string', 'example' => 'wBiwkhd5LGcLzijtc3FhI****'],
'Host' => ['description' => 'The OSS endpoint.'."\n", 'type' => 'string', 'example' => 'https://oss-cipxxxxxxxxxliyuncs.com'],
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '30CBF632-109F-596F-97F2-451C8B2A****'],
'Policy' => ['description' => 'The OSS security policy.'."\n", 'type' => 'string', 'example' => '******'],
'Expire' => ['description' => 'The validity period of the OSS signature. The value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1719919893'],
'AccessId' => ['description' => 'The AccessKey ID that is used to access the OSS bucket.'."\n", 'type' => 'string', 'example' => 'LTAI5txxxxxxx'],
'SecurityToken' => ['description' => 'The security token.', 'type' => 'string', 'example' => '***'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Key\\": \\"DegradePool_Offset_****\\",\\n \\"Signature\\": \\"wBiwkhd5LGcLzijtc3FhI****\\",\\n \\"Host\\": \\"https://oss-cipxxxxxxxxxliyuncs.com\\",\\n \\"RequestId\\": \\"30CBF632-109F-596F-97F2-451C8B2A****\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNC0wOC0xNVQwOToxMTo1My40MDVaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCJzY3JlZW5Mb2dvXC8xNzY2MTg1ODkxxxx\\",\\n \\"Expire\\": 1719919893,\\n \\"AccessId\\": \\"LTAI5txxxxxxx\\",\\n \\"SecurityToken\\": \\"***\\"\\n}","type":"json"}]',
'title' => 'DescribeScreenOssUploadInfo',
],
'DescribeScreenHostStatistics' => [
'summary' => 'Queries the host statistics displayed on a dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '171775',
'abilityTreeNodes' => ['FEATUREsasBB3BJE'],
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8'],
'Data' => [
'description' => 'The host statistics displayed on the dashboard.'."\n",
'type' => 'object',
'properties' => [
'SafeCount' => [
'description' => 'The number of assets on which no risks are detected.'."\n",
'type' => 'array',
'items' => ['description' => 'The number of assets on which no risks are detected.'."\n", 'type' => 'string', 'example' => '10'],
],
'WeaknessMachineNames' => [
'description' => 'The assets on which baseline risks are detected.'."\n",
'type' => 'array',
'items' => ['description' => 'The asset on which baseline risks are detected.'."\n", 'type' => 'string', 'example' => 'testmachinexxx|8.152.x.xx|172.31.xx.xxx'],
],
'SuspEventMachineNames' => [
'description' => 'The assets on which alerts are detected.'."\n",
'type' => 'array',
'items' => ['description' => 'The asset on which alerts are detected.'."\n", 'type' => 'string', 'example' => 'testmachinexxx|8.152.x.xx|172.31.xx.xxx'],
],
'SuspEventUuids' => [
'description' => 'The universally unique identifiers (UUIDs) of the assets on which alerts are detected.'."\n",
'type' => 'array',
'items' => ['description' => 'The UUID of the asset on which alerts are detected.'."\n", 'type' => 'string', 'example' => 'e16f5243-aa33-4506-84ab-xxxxxxx'],
],
'WeaknessUuids' => [
'description' => 'The UUIDs of the assets on which baseline risks are detected.'."\n",
'type' => 'array',
'items' => ['description' => 'The UUID of the asset on which baseline risks are detected.'."\n", 'type' => 'string', 'example' => 'e16f5243-aa33-4506-84ab-xxxxxxx'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D65AADFC-1D20-5A6A-8F6A-9FA53C0DC1F8\\",\\n \\"Data\\": {\\n \\"SafeCount\\": [\\n \\"10\\"\\n ],\\n \\"WeaknessMachineNames\\": [\\n \\"testmachinexxx|8.152.x.xx|172.31.xx.xxx\\"\\n ],\\n \\"SuspEventMachineNames\\": [\\n \\"testmachinexxx|8.152.x.xx|172.31.xx.xxx\\"\\n ],\\n \\"SuspEventUuids\\": [\\n \\"e16f5243-aa33-4506-84ab-xxxxxxx\\"\\n ],\\n \\"WeaknessUuids\\": [\\n \\"e16f5243-aa33-4506-84ab-xxxxxxx\\"\\n ]\\n }\\n}","type":"json"}]',
'title' => 'DescribeScreenHostStatistics',
],
'DescribeScreenAlarmEventList' => [
'summary' => 'Queries alert events on the security dashboard.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => 'The language of the content within the request and response. Valid values:'."\n"
."\n"
.'* **zh**: Chinese'."\n"
.'* **en**: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'],
],
[
'name' => 'Dealed',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the alert event is handled. Valid values:'."\n"
."\n"
.'* **N**: unhandled'."\n"
.'* **Y**: handled'."\n", 'type' => 'string', 'required' => false, 'example' => 'Y'],
],
[
'name' => 'From',
'in' => 'query',
'schema' => ['description' => 'The ID of the request source. Set the value to **sas**, which indicates that the request is sent from Security Center.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sas'],
],
[
'name' => 'Levels',
'in' => 'query',
'schema' => ['description' => 'The severity of the alert event. Separate multiple severities with commas (,). Valid values:'."\n"
."\n"
.'* **serious**'."\n"
.'* **suspicious**'."\n"
.'* **remind**'."\n", 'type' => 'string', 'required' => false, 'example' => 'serious'],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The name of the alert or the information about the asset.'."\n", 'type' => 'string', 'required' => false, 'example' => '222.185.XX.XX'],
],
[
'name' => 'AlarmEventName',
'in' => 'query',
'schema' => ['description' => 'The name of the alert event.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Trojan'],
],
[
'name' => 'AlarmEventType',
'in' => 'query',
'schema' => ['description' => 'The type of the alert event.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Malicious Software'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Default value: **10**.'."\n", 'type' => 'string', 'required' => true, 'example' => '20'],
],
[
'name' => 'TimeStart',
'in' => 'query',
'schema' => ['description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '1687104000000'],
],
[
'name' => 'TimeEnd',
'in' => 'query',
'schema' => ['description' => 'The end of the time range to query.'."\n", 'type' => 'string', 'required' => false, 'example' => '1683862286000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F'],
'PageInfo' => [
'description' => 'The pagination information.'."\n",
'type' => 'object',
'properties' => [
'CurrentPage' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'Count' => ['description' => 'The number of entries returned on the current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
'SuspEvents' => [
'description' => 'The list of the alert events.'."\n",
'type' => 'array',
'items' => [
'description' => 'The information about the alert event.'."\n",
'type' => 'object',
'properties' => [
'Dealed' => ['description' => 'Indicates whether the alert event is handled. Valid values:'."\n"
."\n"
.'* **true**: handled'."\n"
.'* **false**: unhandled'."\n", 'type' => 'boolean', 'example' => 'false'],
'DataSource' => ['description' => 'The data source of the alert event.'."\n", 'type' => 'string', 'example' => 'sas'],
'InternetIp' => ['description' => 'The public IP address of the affected asset.'."\n", 'type' => 'string', 'example' => '123.21.XX.XX'],
'SuspiciousEventCount' => ['description' => 'The number of associated alert events.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'IntranetIp' => ['description' => 'The private IP address of the associated instance.'."\n", 'type' => 'string', 'example' => '100.100.XX.XX'],
'AlarmUniqueInfo' => ['description' => 'The unique ID of the alert event.'."\n", 'type' => 'string', 'example' => '8df914418f4211fbf756efe7a6f4****'],
'CanCancelFault' => ['description' => 'Indicates whether you can cancel marking the alert event as a false positive. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'false'],
'EndTime' => ['description' => 'The timestamp when the alert event was last detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1543740301000'],
'Uuid' => ['description' => 'The unique ID of the associated instance.'."\n", 'type' => 'string', 'example' => 'bf6b30d3-eea8-4924-9f0a-****'],
'StartTime' => ['description' => 'The timestamp generated when the alert event was first detected. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1543740301000'],
'CanBeDealOnLine' => ['description' => 'Indicates whether you can handle the alert event online, such as quarantining the source file of the malicious process. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false**'."\n", 'type' => 'boolean', 'example' => 'true'],
'Description' => ['description' => 'The description of the alert event.'."\n", 'type' => 'string', 'example' => '{\'Type\': \'text\', \'Value\': u\'\\u5efa\\u8bae\\u8fdb\\u884c\\u79c1\\u7f51\\u767d\\u540d\\u5355\\u914d\\u7f6e\\uff0c\\u786e\\u4fdd\\u8bbf\\u95ee\\u5b89\\u5168\\u3002\'}'],
'AlarmEventType' => ['description' => 'The type of the alert event.'."\n", 'type' => 'string', 'example' => 'Unusual Logon'],
'InstanceName' => ['description' => 'The name of the affected instance.'."\n", 'type' => 'string', 'example' => 'fzerp-dev'],
'SaleVersion' => ['description' => 'The edition of Security Center in which alert event detection is supported. Valid values:'."\n"
."\n"
.'* **0**: Basic edition'."\n"
.'* **1**: Enterprise edition'."\n", 'type' => 'string', 'example' => '1'],
'AlarmEventName' => ['description' => 'The name of the alert event.'."\n", 'type' => 'string', 'example' => 'Trojan'],
'Solution' => ['description' => 'The solution to the alert event.'."\n", 'type' => 'string', 'example' => '{\'Type\': \'text\', \'Value\': \'Enter NAS console - monitoring and auditing - log analysis - log management - new log dump to create a log recording service for the file system.\'}'],
'Level' => ['description' => 'The severity of the alert event. Valid values:'."\n"
."\n"
.'* **serious**'."\n"
.'* **suspicious**'."\n"
.'* **remind**'."\n", 'type' => 'string', 'example' => 'serious'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"09969D2C-4FAD-429E-BFBF-9A60DEF8BF6F\\",\\n \\"PageInfo\\": {\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"Count\\": 2\\n },\\n \\"SuspEvents\\": [\\n {\\n \\"Dealed\\": false,\\n \\"DataSource\\": \\"sas\\",\\n \\"InternetIp\\": \\"123.21.XX.XX\\",\\n \\"SuspiciousEventCount\\": 1,\\n \\"IntranetIp\\": \\"100.100.XX.XX\\",\\n \\"AlarmUniqueInfo\\": \\"8df914418f4211fbf756efe7a6f4****\\",\\n \\"CanCancelFault\\": false,\\n \\"EndTime\\": 1543740301000,\\n \\"Uuid\\": \\"bf6b30d3-eea8-4924-9f0a-****\\",\\n \\"StartTime\\": 1543740301000,\\n \\"CanBeDealOnLine\\": true,\\n \\"Description\\": \\"{\'Type\': \'text\', \'Value\': u\'\\\\\\\\u5efa\\\\\\\\u8bae\\\\\\\\u8fdb\\\\\\\\u884c\\\\\\\\u79c1\\\\\\\\u7f51\\\\\\\\u767d\\\\\\\\u540d\\\\\\\\u5355\\\\\\\\u914d\\\\\\\\u7f6e\\\\\\\\uff0c\\\\\\\\u786e\\\\\\\\u4fdd\\\\\\\\u8bbf\\\\\\\\u95ee\\\\\\\\u5b89\\\\\\\\u5168\\\\\\\\u3002\'}\\",\\n \\"AlarmEventType\\": \\"精准防御\\",\\n \\"InstanceName\\": \\"fzerp-dev\\",\\n \\"SaleVersion\\": \\"1\\",\\n \\"AlarmEventName\\": \\"疑似对外发起登录扫描活动\\",\\n \\"Solution\\": \\"{\'Type\': \'text\', \'Value\': \'Enter NAS console - monitoring and auditing - log analysis - log management - new log dump to create a log recording service for the file system.\'}\\",\\n \\"Level\\": \\"serious\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'DescribeScreenAlarmEventList',
],
'ListGlobalUserConfig' => [
'summary' => 'Homepage Configuration Summary Interface.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '169084',
'abilityTreeNodes' => ['FEATUREsasGC725T'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ModuleList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => 'Module list.',
'type' => 'array',
'items' => ['description' => 'Module name.', 'type' => 'string', 'required' => false, 'example' => 'ransomware_breaking'],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListResult<AegisGlobalUserConfigResponse>',
'description' => 'ListResult<AegisGlobalUserConfigResponse>',
'type' => 'object',
'properties' => [
'Data' => [
'description' => 'List of function module switches.',
'type' => 'array',
'items' => [
'description' => 'Function module switch.',
'type' => 'object',
'properties' => [
'ModuleName' => ['title' => '模块名称', 'description' => 'Function module name.', 'type' => 'string', 'example' => 'ransomware_breaking'],
'GlobalConfigSwitch' => ['title' => '是否已经配置', 'description' => 'Whether it has been configured.', 'type' => 'boolean', 'example' => 'true'],
],
],
],
'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' => 'D81DD78E-E006-5C65-A171-C8CB09XXXXX'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ModuleName\\": \\"ransomware_breaking\\",\\n \\"GlobalConfigSwitch\\": true\\n }\\n ],\\n \\"RequestId\\": \\"D81DD78E-E006-5C65-A171-C8CB09XXXXX\\"\\n}","type":"json"}]',
'title' => 'ListGlobalUserConfig',
'translator' => 'machine',
],
'GetFileDetectResultInner' => [
'summary' => 'Get file detect result.',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREsasNPORLE'],
],
'parameters' => [
[
'name' => 'SourceIp',
'in' => 'query',
'schema' => ['description' => 'The source IP address of the request.'."\n", 'type' => 'string', 'required' => false, 'example' => '192.168.X.X'],
],
[
'name' => 'HashKeyList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The identifiers of files.',
'type' => 'array',
'items' => ['description' => 'The identifiers of files.', 'type' => 'string', 'required' => false, 'example' => '8d73f3293ec7b168f213d427fb******'],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The type of the file. Valid values:'."\n"
."\n"
.'* **0**: unknown file'."\n"
.'* **1**: binary file'."\n"
.'* **2**: webshell file'."\n"
.'* **4**: script file'."\n"
."\n"
.'> If you do not know the type of the file, set this parameter to 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
'name' => 'Level',
'in' => 'query',
'schema' => ['description' => 'The risk level of the file.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
'name' => 'DnaHashKeyList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The Micro-Generalized Hash identifiers of files.',
'type' => 'array',
'items' => ['description' => 'The Micro-Generalized Hash identifiers of files.', 'type' => 'string', 'required' => false, 'example' => '013EC082AB246203B1AOBD1C281D5B3D73B2FO5C62E8D263CEA3687EB5DCBF16******'],
'required' => false,
'maxItems' => 200,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '69BFFCDE-37D6-5A49-A8BC-BB03AC83****'],
'ResultList' => [
'description' => 'The detection results of the file.'."\n",
'type' => 'array',
'items' => [
'description' => 'The detection results of the file.'."\n",
'type' => 'object',
'properties' => [
'HashKey' => ['description' => 'The identifier of the file.'."\n", 'type' => 'string', 'example' => '0a212417e65c26ff133cfff28f6c****'],
'Result' => ['description' => 'The file detection result. Valid values:'."\n"
."\n"
.'* **0**: The file is normal.'."\n"
.'* **1**: The file is suspicious.'."\n"
.'* **3**: The detection is in progress.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Score' => ['description' => 'The score of file detection result.'."\n"
."\n"
.'> A higher score indicates a more suspicious file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'VirusType' => ['description' => 'The type of the virus.', 'type' => 'string', 'example' => 'WebShell'],
'Code' => ['description' => 'The status code returned. The status code **200** indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.'."\n", 'type' => 'string', 'example' => '200'],
'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'successful'],
'Ext' => ['description' => 'The extended information about the file detection result.'."\n", 'type' => 'string', 'example' => '{'."\n"
.' "HighLight":'."\n"
.' ['."\n"
.' ['."\n"
.' 23245,'."\n"
.' 23212'."\n"
.' ]'."\n"
.' ],'."\n"
.' "FileLabel":'."\n"
.' ['."\n"
.' "PE32",'."\n"
.' "Zip",'."\n"
.' "SFX",'."\n"
.' "encrypted"'."\n"
.' ]'."\n"
.'}'],
'ExpireTime' => ['description' => 'The expiration time of the result.', 'type' => 'string', 'example' => '2025-02-10T16:00:00Z'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'RequestTooFrequently', 'errorMessage' => 'Request too frequently, please try again later'],
['errorCode' => 'GetResultFail', 'errorMessage' => 'Get result fail, found no detect record for this file or result has been expired'],
['errorCode' => 'InvalidApiDetectType', 'errorMessage' => 'Unsupported Api Detect Type.'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'caller has no permission'],
],
500 => [
['errorCode' => 'ServerError', 'errorMessage' => 'ServerError'],
['errorCode' => 'SystemBusy', 'errorMessage' => 'System busy, please try again later.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"69BFFCDE-37D6-5A49-A8BC-BB03AC83****\\",\\n \\"ResultList\\": [\\n {\\n \\"HashKey\\": \\"0a212417e65c26ff133cfff28f6c****\\",\\n \\"Result\\": 0,\\n \\"Score\\": 100,\\n \\"VirusType\\": \\"WebShell\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Ext\\": \\"{\\\\n \\\\\\"HighLight\\\\\\":\\\\n [\\\\n [\\\\n 23245,\\\\n 23212\\\\n ]\\\\n ],\\\\n \\\\\\"FileLabel\\\\\\":\\\\n [\\\\n \\\\\\"PE32\\\\\\",\\\\n \\\\\\"Zip\\\\\\",\\\\n \\\\\\"SFX\\\\\\",\\\\n \\\\\\"encrypted\\\\\\"\\\\n ]\\\\n}\\",\\n \\"ExpireTime\\": \\"2025-02-10T16:00:00Z\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'GetFileDetectResultInner',
],
],
'endpoints' => [
['regionId' => 'cn-beijing', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-nanjing', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-fuzhou', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-heyuan', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-2', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com '],
['regionId' => 'ap-southeast-5', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com '],
['regionId' => 'ap-southeast-6', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-7', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'endpoint' => 'tds.ap-southeast-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-beijing-finance-1', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-heyuan-acdr-1', 'endpoint' => 'tds.cn-shanghai.aliyuncs.com'],
],
];
|