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
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
18921
18922
18923
18924
18925
18926
18927
18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'DAS', 'version' => '2020-01-16'],
'directories' => [
[
'children' => ['AddHDMInstance'],
'type' => 'directory',
'title' => '实例接入',
'id' => 446812,
],
[
'children' => ['GetInstanceInspections'],
'type' => 'directory',
'title' => '巡检评分',
'id' => 446813,
],
[
'children' => ['SetEventSubscription', 'GetEventSubscription', 'GetAutonomousNotifyEventContent', 'GetAutonomousNotifyEventsInRange'],
'type' => 'directory',
'title' => '事件通知',
'id' => 446814,
],
[
'children' => ['CreateDiagnosticReport', 'DescribeDiagnosticReportList', 'GetDBInstanceConnectivityDiagnosis'],
'type' => 'directory',
'title' => '诊断报告',
'id' => 446815,
],
[
'children' => ['CreateCacheAnalysisJob', 'DescribeCacheAnalysisJob', 'DescribeCacheAnalysisJobs'],
'type' => 'directory',
'title' => '缓存分析',
'id' => 446817,
],
[
'children' => ['EnableSqlConcurrencyControl', 'DisableSqlConcurrencyControl', 'DisableAllSqlConcurrencyControlRules', 'GetRunningSqlConcurrencyControlRules', 'GetSqlConcurrencyControlRulesHistory', 'GetSqlConcurrencyControlKeywordsFromSqlText'],
'type' => 'directory',
'title' => 'SQL限流',
'id' => 446818,
],
[
'children' => ['CreateRequestDiagnosis', 'GetRequestDiagnosisResult', 'GetRequestDiagnosisPage', 'DescribeQueryExplain'],
'type' => 'directory',
'title' => 'SQL诊断',
'id' => 446819,
],
[
'children' => ['DescribeHotBigKeys', 'DescribeTopHotKeys', 'DescribeTopBigKeys', 'DescribeHotKeys'],
'type' => 'directory',
'title' => 'Key分析',
'id' => 446820,
],
[
'children' => ['CreateQueryOptimizeTag', 'GetQueryOptimizeExecErrorStats', 'GetQueryOptimizeExecErrorSample', 'GetQueryOptimizeSolution', 'GetQueryOptimizeRuleList', 'GetQueryOptimizeDataTrend', 'GetQueryOptimizeDataTop', 'GetQueryOptimizeDataStats', 'GetQueryOptimizeTag', 'GetQueryOptimizeShareUrl'],
'type' => 'directory',
'title' => '查询治理',
'id' => 446821,
],
[
'children' => ['GetErrorRequestSample', 'GetAsyncErrorRequestStatResult', 'GetAsyncErrorRequestListByCode', 'GetAsyncErrorRequestStatByCode', 'GetFullRequestOriginStatByInstanceId', 'GetFullRequestStatResultByInstanceId', 'GetFullRequestSampleByInstanceId'],
'type' => 'directory',
'title' => 'SQL洞察',
'id' => 446822,
],
[
'children' => ['DescribeSqlLogConfig', 'ModifySqlLogConfig', 'DescribeSqlLogStatistic', 'GetDasSQLLogHotData', 'CreateSqlLogTask', 'DescribeSqlLogTask', 'DescribeSqlLogTasks'],
'type' => 'directory',
'title' => '企业版管理',
'id' => 446823,
],
[
'children' => ['GetRedisAllSession', 'GetMongoDBCurrentOp', 'KillInstanceAllSession', 'CreateKillInstanceSessionTask', 'GetKillInstanceSessionTaskResult', 'GetMySQLAllSessionAsync'],
'type' => 'directory',
'title' => '实例会话',
'id' => 446824,
],
[
'children' => ['CreateStorageAnalysisTask', 'GetStorageAnalysisResult', 'GetAutoIncrementUsageStatistic'],
'type' => 'directory',
'title' => '空间分析',
'id' => 446825,
],
[
'children' => ['GetDeadLockDetailList', 'GetBlockingDetailList', 'CreateLatestDeadLockAnalysis', 'GetDeadLockHistory', 'GetDeadLockDetail', 'GetDeadlockHistogram'],
'type' => 'directory',
'title' => '锁优化',
'id' => 446826,
],
[
'children' => ['GetInstanceMissingIndexList'],
'type' => 'directory',
'title' => '索引诊断',
'id' => 446827,
],
[
'children' => ['DescribeSlowLogHistogramAsync', 'DescribeSlowLogStatistic', 'DescribeSlowLogRecords'],
'type' => 'directory',
'title' => '慢日志',
'id' => 446828,
],
[
'children' => ['UpdateAutoThrottleRulesAsync', 'DisableAutoThrottleRules', 'GetAutoThrottleRules'],
'type' => 'directory',
'title' => '自动SQL限流',
'id' => 446830,
],
[
'children' => ['UpdateAutoSqlOptimizeStatus', 'GetSqlOptimizeAdvice', 'GetInstanceSqlOptimizeStatistic'],
'type' => 'directory',
'title' => '自动SQL优化',
'id' => 446831,
],
[
'children' => ['UpdateAutoResourceOptimizeRulesAsync', 'DisableAutoResourceOptimizeRules', 'GetAutoResourceOptimizeRules'],
'type' => 'directory',
'title' => '自动空间优化',
'id' => 446832,
],
[
'children' => ['ModifyAutoScalingConfig', 'DescribeAutoScalingConfig', 'DescribeAutoScalingHistory', 'DisableInstanceDasConfig'],
'type' => 'directory',
'title' => '自动弹性伸缩',
'id' => 446833,
],
[
'children' => ['GetPartitionsHeatmap'],
'type' => 'directory',
'title' => '分区热力图',
'id' => 446834,
],
[
'children' => ['GetPfsSqlSample', 'GetPfsMetricTrends', 'GetPfsSqlSummaries'],
'type' => 'directory',
'title' => '性能洞察(新版)',
'id' => 446835,
],
[
'children' => ['DescribeErrorLogRecords'],
'type' => 'directory',
'title' => '错误日志',
'id' => 446836,
],
[
'children' => ['Chat', 'GetInstanceGroupInspectReportList', 'GetInstanceGroupInspectReportDetail'],
'type' => 'directory',
'title' => 'DAS Agent',
'id' => 446837,
],
[
'children' => ['CreateSecurityIPGroup', 'DescribeSecurityIPGroup', 'DescribeSecurityIPGroupRelation', 'ModifySecurityIPGroup', 'ModifySecurityIPGroupRelation', 'DeleteSecurityIPGroup'],
'type' => 'directory',
'title' => '跨产品白名单',
'id' => 446838,
],
[
'children' => ['GetDasAgentSSE', 'GetHDMAliyunResourceSyncResult', 'DescribeSqlLogRecords', 'EnableDasPro', 'DisableDasPro', 'DescribeInstanceDasPro', 'GetDasProServiceUsage', 'RunCloudBenchTask', 'DescribeCloudbenchTask', 'DescribeCloudBenchTasks', 'CreateCloudBenchTasks', 'DescribeCloudbenchTaskConfig', 'DeleteCloudBenchTask', 'DeleteStopGateway', 'GetYaoChiAgent', 'DescribeAuditLogs'],
'type' => 'directory',
'title' => '其他',
'id' => 446839,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddHDMInstance' => [
'summary' => '调用AddHDMInstance接口,将数据库实例接入DAS。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => '__context',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceArea',
'in' => 'query',
'schema' => ['description' => '实例所属的数据库产品,取值:'."\n"
."\n"
.'- **RDS**:云实例。'."\n"
.'- **ECS**:ECS自建实例。'."\n"
.'- **IDC**:非公有云自建实例。'."\n"
."\n"
.'> IDC为用户数据中心。', 'type' => 'string', 'required' => true, 'example' => 'ECS'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'Ip',
'in' => 'query',
'schema' => ['description' => '待接入实例的内网连接地址。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze1jdv45i7l6****.mysql.rds.aliyuncs.com'],
],
[
'name' => 'Port',
'in' => 'query',
'schema' => ['description' => '实例的内网连接端口。', 'type' => 'string', 'required' => false, 'example' => '3306'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PostgreSQL**'."\n"
.'- **SQLServer**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PolarDBPostgreSQL**'."\n"
.'- **Redis**'."\n"
.'- **MongoDB**'."\n"
.'- **PolarDBOracle**'."\n"
.'- **PolarDBX**', 'type' => 'string', 'required' => false, 'example' => 'MySQL'],
],
[
'name' => 'Username',
'in' => 'query',
'schema' => ['description' => '用户名。', 'type' => 'string', 'required' => false, 'example' => 'test****'],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => '用户名的密码。', 'type' => 'string', 'required' => false, 'example' => '122****'],
],
[
'name' => 'InstanceAlias',
'in' => 'query',
'schema' => ['description' => '实例名称。', 'type' => 'string', 'required' => false, 'example' => 'yuecq--test****'],
],
[
'name' => 'NetworkType',
'in' => 'query',
'schema' => ['description' => '实例的网络类型。', 'type' => 'string', 'required' => false, 'example' => 'VPC'],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-m5e666n89m2bx8jar****'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属的地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'FlushAccount',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Synchro' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-m5e666n89m2bx8jar****'],
'Token' => ['description' => '客户端token(即自定义的唯一随机字符串)。', 'type' => 'string', 'example' => 'tokenID'],
'Ip' => ['description' => '实例的IP连接地址。', 'type' => 'string', 'example' => 'rm-de21209****.mysql.rds.aliyuncs.com'],
'CallerUid' => ['description' => '调用者用户ID。', 'type' => 'string', 'example' => '31063db679****'],
'InstanceId' => ['description' => '实例的ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
'Port' => ['description' => '目标实例的端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'],
'OwnerId' => ['description' => '所有者ID。', 'type' => 'string', 'example' => '325352345'],
'Uuid' => ['description' => '实例的唯一标识符号。', 'type' => 'string', 'example' => 'hdm_3063db6792965c080a4bcb6e6304****'],
'Error' => ['description' => '错误消息。', 'type' => 'string', 'example' => 'InvalidRequestURL'],
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Role' => ['description' => '角色信息。', 'type' => 'string', 'example' => 'master'],
'TenantId' => ['description' => '所属的租户ID。', 'type' => 'string', 'example' => 'L0EPfLS****=SCE00000*****'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Synchro\\": \\"None\\",\\n \\"Data\\": {\\n \\"VpcId\\": \\"vpc-m5e666n89m2bx8jar****\\",\\n \\"Token\\": \\"tokenID\\",\\n \\"Ip\\": \\"rm-de21209****.mysql.rds.aliyuncs.com\\",\\n \\"CallerUid\\": \\"31063db679****\\",\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\",\\n \\"Port\\": 3306,\\n \\"OwnerId\\": \\"325352345\\",\\n \\"Uuid\\": \\"hdm_3063db6792965c080a4bcb6e6304****\\",\\n \\"Error\\": \\"InvalidRequestURL\\",\\n \\"Code\\": 200,\\n \\"Role\\": \\"master\\",\\n \\"TenantId\\": \\"L0EPfLS****=SCE00000*****\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<AddHDMInstanceResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Synchro>None</Synchro>\\n <Data>\\n <VpcId>vpc-m5e666n89m2bx8jar****</VpcId>\\n <Token>tokenID</Token>\\n <Ip>rm-de21209****.mysql.rds.aliyuncs.com</Ip>\\n <CallerUid>31063db679****</CallerUid>\\n <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>\\n <Port>3306</Port>\\n <OwnerId>325352345</OwnerId>\\n <Uuid>hdm_3063db6792965c080a4bcb6e6304****</Uuid>\\n <Error>InvalidRequestURL</Error>\\n <Code>200</Code>\\n <Role>master</Role>\\n <TenantId>L0EPfLS****=SCE00000*****</TenantId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddHDMInstanceResponse>","errorExample":""}]',
'title' => '接入数据库实例',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:AddHDMInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'Chat' => [
'summary' => 'DAS大模型能力异步逻辑接口',
'path' => '/chat',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmB8MM4L', 'FEATUREhdmROFBLE', 'FEATUREhdm1XKIXR', 'FEATUREhdmR88NLD', 'FEATUREhdm3TU4OK'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Message',
'in' => 'query',
'schema' => ['description' => '消息', 'type' => 'string', 'required' => true, 'example' => '{"id":"68fe0321-37fe-4c75-a118-b61b33156f6a","role":"user","content":[{"type":"text","text":"hello"}]}'],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['description' => '可选,会话 ID,格式为 UUID 字符串。如未指定默认创建新的会话。上下文对话需保持同一个会话 ID。', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-xxxxxxxxxxxx'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '可选,用于服务的 Agent ID。可指定为开启 DAS Agent 后生成的Agent 或主动创建的 Agent。如未指定则使用默认 Agent 进行服务。', 'type' => 'string', 'required' => false, 'example' => 'ag-472T0DxtmjIxxxxx'],
],
[
'name' => 'Summary',
'in' => 'query',
'schema' => ['description' => '是否输出摘要信息', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Type' => ['description' => '事件类型', 'type' => 'string', 'example' => 'TEXT_MESSAGE_CONTENT'],
'MessageId' => ['description' => '消息ID', 'type' => 'string', 'example' => '61820b594664275c4429****'],
'Role' => ['description' => '对话角色ID', 'type' => 'string', 'example' => 'assistant'],
'Delta' => ['description' => '是否增量内容', 'type' => 'string', 'example' => 'hello'],
'ActivityType' => ['description' => '心跳', 'type' => 'string', 'example' => 'waiting_for_agent_thinking'],
'ToolCallId' => ['description' => '工具调用ID', 'type' => 'string', 'example' => 'call_edf9cdb69e0e4c9796a6a5a6'],
'ToolCallName' => ['description' => '工具名称', 'type' => 'string', 'example' => 'das_api'],
'Content' => ['description' => '回答内容', 'type' => 'string', 'example' => 'I see you have several PolarDB instances, and I will query them for you shortly'],
'ParentMessageId' => ['description' => '父消息 ID', 'type' => 'string', 'example' => '76bee207-31ee-4707-8851-6b9d4da033aa'],
'ThreadId' => ['description' => '线程ID', 'type' => 'string', 'example' => '8e481be1-21d5-4a92-a2fb-fb54be0ab4f6'],
'StepName' => ['description' => '执行步骤名称', 'type' => 'string', 'example' => 'sub_agent_performance_diagnose_mysql'],
'RunId' => ['description' => '运行ID', 'type' => 'string', 'example' => 'ed7cb7b1-ddc8-45d7-9ff3-b315726cb5f7'],
'TaskTrackerId' => ['description' => '回调工具类', 'type' => 'string', 'example' => 'das_api'],
'Name' => ['description' => '扩展Key', 'type' => 'string', 'example' => 'summary'],
'Value' => ['description' => '扩展Value', 'type' => 'any', 'example' => '{"CharCount":393,"End":1777428785996,"RequestId":"BE59AED5-D831-5811-BBAD-590B917B2089","SessionId":"123e4567-e89b-12d3-a456-xxxxxxxxxxxx","Start":1777428707927}'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
[
['errorCode' => 'InstanceNotFound', 'errorMessage' => 'Requested instance not found.', 'description' => '对应实例id无法找到'],
],
500 => [
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', 'description' => '由于超时请求处理失败。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DAS Agent 交互接口',
'description' => '前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 仅开通了DAS企业版的数据库实例支持创建离线任务。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。'."\n"
."\n"
.'更多使用Chat接口与DAS Agent进行交互的方法和示例,请参考 [DAS Agent交互最佳实践(集成Chat API)](https://help.aliyun.com/zh/das/developer-reference/chat-api-best-practice)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:Chat',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Type\\": \\"TEXT_MESSAGE_CONTENT\\",\\n \\"MessageId\\": \\"61820b594664275c4429****\\",\\n \\"Role\\": \\"assistant\\",\\n \\"Delta\\": \\"hello\\",\\n \\"ActivityType\\": \\"waiting_for_agent_thinking\\",\\n \\"ToolCallId\\": \\"call_edf9cdb69e0e4c9796a6a5a6\\",\\n \\"ToolCallName\\": \\"das_api\\",\\n \\"Content\\": \\"I see you have several PolarDB instances, and I will query them for you shortly\\",\\n \\"ParentMessageId\\": \\"76bee207-31ee-4707-8851-6b9d4da033aa\\",\\n \\"ThreadId\\": \\"8e481be1-21d5-4a92-a2fb-fb54be0ab4f6\\",\\n \\"StepName\\": \\"sub_agent_performance_diagnose_mysql\\",\\n \\"RunId\\": \\"ed7cb7b1-ddc8-45d7-9ff3-b315726cb5f7\\",\\n \\"TaskTrackerId\\": \\"das_api\\",\\n \\"Name\\": \\"summary\\",\\n \\"Value\\": \\"{\\\\\\"CharCount\\\\\\":393,\\\\\\"End\\\\\\":1777428785996,\\\\\\"RequestId\\\\\\":\\\\\\"BE59AED5-D831-5811-BBAD-590B917B2089\\\\\\",\\\\\\"SessionId\\\\\\":\\\\\\"123e4567-e89b-12d3-a456-xxxxxxxxxxxx\\\\\\",\\\\\\"Start\\\\\\":1777428707927}\\"\\n}","type":"json"}]',
],
'CreateCacheAnalysisJob' => [
'summary' => '调用CreateCacheAnalysisJob接口,创建缓存分析任务。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Redis实例ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '实例的数据节点ID,传入本参数可查询指定节点的监控信息。'."\n"
.'>当您传入BackupSetId参数,系统会忽略此参数,您可调用[DescribeLogicInstanceTopology](~~473786~~)接口查询节点ID。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
[
'name' => 'BackupSetId',
'in' => 'query',
'schema' => ['description' => '备份文件ID,可以通过[DescribeBackups](~~473823~~)接口获取。'."\n"
."\n"
.'- 如需传入多个备份文件ID,请使用英文逗号(,)分隔,例如`12345,67890`。'."\n"
.'- 如果不传入本参数,系统会自动执行备份并对该备份文件执行缓存分析。', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
'name' => 'Separators',
'in' => 'query',
'schema' => ['description' => '用于识别Key前缀的分隔符。当分隔符为默认的`:;,_-+@=|#`时,不需要输入。', 'type' => 'string', 'required' => false, 'example' => '&'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'TaskState' => ['description' => '缓存分析任务的状态:'."\n"
."\n"
.'- **BACKUP**:备份中。'."\n"
.'- **ANALYZING**:分析中。'."\n"
.'- **FINISHED**:分析完成。'."\n"
.'- **FAILED**:出现错误。', 'type' => 'string', 'example' => 'BACKUP'],
'JobId' => ['description' => '缓存分析任务ID。'."\n"
.'>此参数可用于查询缓存分析任务使用,当您调用该API时,由于创建缓存分析任务需要一定的时间,不会立即返回分析结果,您需要通过此参数,结合[DescribeCacheAnalysisJob](~~180983~~)接口,查询具体的分析结果。', 'type' => 'string', 'example' => 'sf79-sd99-sa37-****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'BigKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyInfo' => [
'description' => '大Key详细信息,根据Key占用字节数降序排列。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Db' => ['description' => '数据库名称。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpirationTimeMillis' => ['description' => 'Key过期时间,单位:毫秒(ms),0表示不过期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596256542547'],
'Key' => ['description' => 'Key的名称。', 'type' => 'string', 'example' => 'task_x****'],
'Encoding' => ['description' => 'Key内部数据类型。', 'type' => 'string', 'example' => 'hashtable'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
],
],
],
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'r-bp18ff4a195d****'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"TaskState\\": \\"BACKUP\\",\\n \\"JobId\\": \\"sf79-sd99-sa37-****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"BigKeys\\": {\\n \\"KeyInfo\\": [\\n {\\n \\"Type\\": \\"hash\\",\\n \\"Db\\": 0,\\n \\"ExpirationTimeMillis\\": 1596256542547,\\n \\"Key\\": \\"task_x****\\",\\n \\"Encoding\\": \\"hashtable\\",\\n \\"Bytes\\": 12345,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"r-bp18ff4a195d****\\",\\n \\"NodeId\\": \\"r-x****-db-0\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateCacheAnalysisJobResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <TaskState>BACKUP</TaskState>\\n <JobId>sf79-sd99-sa37-****</JobId>\\n <Message>Successful</Message>\\n <BigKeys>\\n <Type>hash</Type>\\n <Db>0</Db>\\n <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>\\n <Key>task_x****</Key>\\n <Encoding>hashtable</Encoding>\\n <Bytes>12345</Bytes>\\n <NodeId>r-x****-db-0</NodeId>\\n <Count>127</Count>\\n </BigKeys>\\n <InstanceId>r-bp18ff4a195d****</InstanceId>\\n <NodeId>r-x****-db-0</NodeId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateCacheAnalysisJobResponse>","errorExample":""}]',
'title' => '创建缓存分析任务',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 只支持分析Redis数据结构和以下Tair自研数据结构:TairString、TairHash、TairGIS、TairBloom、TairDoc、TairCpc、TairZset,暂不支持分析其他Tair自研数据结构。'."\n"
.'- 如果目标实例规格已发生变更,则不支持分析实例变更前的备份文件。'."\n"
.'- 暂不支持Tair磁盘型实例。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateCacheAnalysisJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateCloudBenchTasks' => [
'summary' => '调用CreateCloudBenchTasks接口,创建压测任务。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => '压测任务类型。取值:'."\n"
.'- **pressure test**(默认):智能压测,将从源实例上捕获的流量,按照目标实例规格支持的极限速度,在目标实例上进行回放。'."\n"
.'- **smart pressure test**:生成压测,通过分析和学习短时间内在源实例上捕获的流量,生成和原始流量的业务模型和流量分布基本一致的流量进行持续压测,减少从源实例采集数据的时间,降低存储成本和性能开销。', 'type' => 'string', 'required' => true, 'example' => 'pressure test'],
],
[
'name' => 'SrcInstanceId',
'in' => 'query',
'schema' => ['description' => '源实例ID,仅支持RDS MySQL、PolarDB MySQL版实例,您可通过调用[GetInstanceInspections](~~202857~~)接口获取。'."\n"
.'>当**DstType**为**Instance**时,本参数需要传入。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'Description',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '压测任务描述。', 'type' => 'string', 'required' => true, 'example' => 'test-das-bench-0501'],
],
[
'name' => 'SrcPublicIp',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'DstInstanceId',
'in' => 'query',
'schema' => ['description' => '目标实例ID,仅支持RDS MySQL、PolarDB MySQL版实例,您可通过调用[GetInstanceInspections](~~202857~~)接口获取。'."\n"
.'>当**DstType**为**Instance**时,本参数需要传入。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'GatewayVpcId',
'in' => 'query',
'schema' => ['description' => '数据库网关的专有网络ID。'."\n"
.'>若**ClientType**取值为**ECS**,则此参数必传入。', 'type' => 'string', 'required' => false, 'example' => 'vpc-t4nsnwvpbc1h76ja4****'],
],
[
'name' => 'GatewayVpcIp',
'in' => 'query',
'schema' => ['description' => '数据库网关的IP地址或域名。'."\n"
.'>若**ClientType**取值为**ECS**,则此参数必传入。', 'type' => 'string', 'required' => false, 'example' => '172.30.XX.XX'],
],
[
'name' => 'ClientType',
'in' => 'query',
'schema' => ['description' => '压测机器类型。取值:'."\n"
."\n"
.'- **ECS**:您需要自己准备[数据库网关](~~64905~~)。'."\n"
.'- **DAS_ECS**:DAS自动购买和部署的ECS。', 'type' => 'string', 'required' => true, 'example' => 'ECS'],
],
[
'name' => 'RequestStartTime',
'in' => 'query',
'schema' => ['description' => '压测任务的开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => false, 'example' => '1608888296000'],
],
[
'name' => 'RequestEndTime',
'in' => 'query',
'schema' => ['description' => '压测任务的结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => false, 'example' => '1608888296001'],
],
[
'name' => 'RequestDuration',
'in' => 'query',
'schema' => ['description' => '压测任务的持续时间,单位为毫秒。', 'type' => 'string', 'required' => false, 'example' => '86400000'],
],
[
'name' => 'Rate',
'in' => 'query',
'schema' => ['description' => '源实例流量在目标实例上的回放速度,回放速度必须是正整数,取值:**1**~**30**,默认为**1**。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'SmartPressureTime',
'in' => 'query',
'schema' => ['description' => '生成压测的持续时间,单位为毫秒。'."\n"
.'>当**TaskType**为**smart pressure test**时本参数需要传入。', 'type' => 'string', 'required' => false, 'example' => '86400000'],
],
[
'name' => 'DtsJobClass',
'in' => 'query',
'schema' => ['description' => 'DTS迁移任务规格,您可以通过调用[DescribeCloudbenchTask](~~230669~~)接口获取。'."\n"
.'>压测任务需要先将源实例基准数据迁移至目标实例,当您新建DTS任务时需要传入本参数。', 'type' => 'string', 'required' => false, 'example' => 'medium'],
],
[
'name' => 'DtsJobId',
'in' => 'query',
'schema' => ['description' => 'DTS迁移任务ID,您可调用[ConfigureDtsJob](~~208399~~)接口获取。'."\n"
.'>已在DTS控制台创建完DTS任务时本参数必传入。', 'type' => 'string', 'required' => false, 'example' => '23127'],
],
[
'name' => 'SrcSuperAccount',
'in' => 'query',
'schema' => ['description' => '源端实例高权限账号。取值:**admin**。'."\n"
.'>当**DstType**为**Instance**时,本参数需要传入。', 'type' => 'string', 'required' => false, 'example' => 'admin'],
],
[
'name' => 'SrcSuperPassword',
'in' => 'query',
'schema' => ['description' => '源端实例高权限账号的密码。'."\n"
.'>当**DstType**为**Instance**时,本参数需要传入。', 'type' => 'string', 'required' => false, 'example' => 'test123'],
],
[
'name' => 'DstSuperAccount',
'in' => 'query',
'schema' => ['description' => '目标实例的高权限账号。', 'type' => 'string', 'required' => false, 'example' => 'root'],
],
[
'name' => 'DstSuperPassword',
'in' => 'query',
'schema' => ['description' => '目标实例高权限账号的密码。', 'type' => 'string', 'required' => false, 'example' => 'test123'],
],
[
'name' => 'DstType',
'in' => 'query',
'schema' => ['description' => '目标实例的类型。取值:'."\n"
.'- **Instance**(默认):实例ID。'."\n"
.'- **ConnectionString**:实例的连接地址。', 'type' => 'string', 'required' => false, 'example' => 'Instance'],
],
[
'name' => 'DstConnectionString',
'in' => 'query',
'schema' => ['description' => '目标实例的连接地址,仅支持RDS MySQL、PolarDB MySQL版实例。'."\n"
.'>**DstType**为**ConnectionString**本参数有效。', 'type' => 'string', 'required' => false, 'example' => 'rm-de21209****.mysql.rds.aliyuncs.com'],
],
[
'name' => 'DstPort',
'in' => 'query',
'schema' => ['description' => '目标实例的端口。'."\n"
.'>**DstType**为**ConnectionString**本参数有效。', 'type' => 'string', 'required' => false, 'example' => '3306'],
],
[
'name' => 'WorkDir',
'in' => 'query',
'schema' => ['description' => '压测生成的临时目录。', 'type' => 'string', 'required' => false, 'example' => '/tmp/bench/'],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['description' => '备份集ID,可通过查询备份列表接口[DescribeBackups](~~26273~~)获取。', 'type' => 'string', 'required' => false, 'example' => '229132'],
],
[
'name' => 'BackupTime',
'in' => 'query',
'schema' => ['description' => '备份的时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。', 'type' => 'string', 'required' => false, 'example' => '2021-04-23T13:22:14Z'],
],
[
'name' => 'Amount',
'in' => 'query',
'schema' => ['description' => '创建压测任务的总个数,取值:**0**~**30**,默认为**1**。', 'type' => 'string', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'EndState',
'in' => 'query',
'schema' => ['description' => '压测任务结束后的状态。取值:'."\n"
."\n"
.'- **WAIT_TARGET**:准备压测的目标实例。'."\n"
.'- **WAIT_DBGATEWAY**:准备压测部署。'."\n"
.'- **WAIT_SQL**:准备全量SQL。'."\n"
.'- **WAIT_LOGIC**:准备开始回放流量。'."\n"
."\n"
.'>当压测任务执行完EndState设置的状态之后,任务将直接到达完成状态。', 'type' => 'string', 'required' => false, 'example' => 'WAIT_TARGET'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'taskIds' => [
'description' => '详细信息列表。',
'type' => 'array',
'items' => ['description' => '详细信息列表,包括信息总数、错误码等。', 'type' => 'string', 'example' => '"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }'],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '创建压测任务',
'description' => '数据库自治服务DAS提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见[智能压测](~~155068~~)。数据库需满足如下前提条件:'."\n"
."\n"
.' - 源数据库仅支持RDS MySQL高可用系列或三节点企业系列、PolarDB MySQL版的集群版。'."\n"
.' - 目标数据库实例为RDS MySQL、PolarDB MySQL版。'."\n"
.' - 实例已接入DAS,详情请参见[接入阿里云数据库实例](~~65405~~)。'."\n"
.' - 需开启DAS企业版,详情请参见[DAS企业版](~~190912~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCloudBenchTasks'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateCloudBenchTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"taskIds\\": [\\n \\"\\\\\\"Data\\\\\\": { \\\\\\"total\\\\\\": 1, \\\\\\"list\\\\\\":[...] }, \\\\\\"Code\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateCloudBenchTasksResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\"Data\\": { \\"total\\": 1, \\"list\\":[...] }, \\"Code\\": 200, \\"Success\\": true }</Data>\\n</CreateCloudBenchTasksResponse>","errorExample":""}]',
],
'CreateDiagnosticReport' => [
'summary' => '调用CreateDiagnosticReport接口,创建诊断报告。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '创建任务开始时间,格式为Unix时间戳(UTC时间),单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '创建任务结束时间,格式为Unix时间戳(UTC时间),单位为毫秒。'."\n"
.'>创建任务结束时间需晚于创建任务开始时间。', 'type' => 'string', 'required' => true, 'example' => '1596177993001'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'ac544623-f6ad-45fd-9a74-9be3db65****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '返回的数据。', 'type' => 'string', 'example' => '70af71852fcdf2c5dc7b90596e2cf05b'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '创建诊断报告',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.3或以上。'."\n"
.'- 在调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - Redis',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDiagnosticReport'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateDiagnosticReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ac544623-f6ad-45fd-9a74-9be3db65****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"70af71852fcdf2c5dc7b90596e2cf05b\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDiagnosticReportResponse>\\n <RequestId>ac544623-f6ad-45fd-9a74-9be3db65****</RequestId>\\n <Message>Successful</Message>\\n <Data>70af71852fcdf2c5dc7b90596e2cf05b</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateDiagnosticReportResponse>","errorExample":""}]',
],
'CreateKillInstanceSessionTask' => [
'summary' => '调用CreateKillInstanceSessionTask接口,创建结束会话的任务。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。如果没有提供节点ID,并且请求参数**KillAllSessions**配置为**true**(即结束全部会话),将会遍历PolarDB MySQL版实例所有节点,并结束每个节点上正在进行的会话。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp1v203xzzh0a****'],
],
[
'name' => 'DbUser',
'in' => 'query',
'schema' => ['description' => '具有结束会话权限的数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'testUser'],
],
[
'name' => 'DbUserPassword',
'in' => 'query',
'schema' => ['description' => '数据库账号密码。', 'type' => 'string', 'required' => true, 'example' => 'testPassword'],
],
[
'name' => 'IgnoredUsers',
'in' => 'query',
'schema' => ['description' => '忽略账号列表,该列表中账号的会话不会被结束。'."\n"
."\n"
.'> 数据格式为JSONArray字符串,例如\\[\'数据库账号1\',\'数据库账号2\'\\],数据库账号间用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '[\'db_user1\',\'db_user2\']'],
],
[
'name' => 'KillAllSessions',
'in' => 'query',
'schema' => ['description' => '是否结束全部会话。'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。'."\n"
."\n"
.'> 该参数取值为**true**时,请求参数**IgnoredUsers**中账号的会话、阿里云内部运维账号的会话和**Binlog Dump**会话都不会被结束。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
'name' => 'SessionIds',
'in' => 'query',
'schema' => ['description' => '需要被结束的会话ID列表。'."\n"
."\n"
.'> 数据格式为JSONArray,例如\\[会话ID1,会话ID2\\],会话ID间用英文逗号(,)分隔。如果请求参数**KillAllSessions**取值为**true**(即结束全部会话),该列表会被忽略。', 'type' => 'string', 'required' => false, 'example' => '[10805639,10805623,10805645,10805553,10805566,10805616]'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '结束会话的任务ID。'."\n"
."\n"
.'> PolarDB MySQL版实例调用该API接口,请求参数**NodeId**为空(即未指定节点ID),并且请求参数**KillAllSessions**配置为**true**(即结束全部会话)时,会按照节点数量返回任务ID列表,例如\\["f77d535b45405bd462b21caa3ee8\\*\\*\\*\\*", "e93ab549abb081eb5dcd5396a29b\\*\\*\\*\\*"\\]', 'type' => 'string', 'example' => 'f77d535b45405bd462b21caa3ee8****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"f77d535b45405bd462b21caa3ee8****\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateKillInstanceSessionTaskResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>f77d535b45405bd462b21caa3ee8****</Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</CreateKillInstanceSessionTaskResponse>","errorExample":""}]',
'title' => '创建结束会话的任务',
'description' => '- 本接口只适用于RDS MySQL和PolarDB MySQL版实例。'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateKillInstanceSessionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateLatestDeadLockAnalysis' => [
'summary' => '创建最近死锁分析任务。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdm7GLEEO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1u5mas9exx7****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp16v3824rt73****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => 'OpenAPI请求的ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => [
'description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。',
'type' => 'boolean',
'enumValueTitles' => ['执行成功' => 'true', '执行失败' => 'false'],
'example' => 'true',
],
'Data' => [
'description' => '创建任务是否成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。',
'type' => 'boolean',
'enumValueTitles' => ['执行成功' => 'true', '执行失败' => 'false'],
'example' => 'true',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '创建最近死锁分析任务',
'description' => '本接口用于创建最近死锁分析任务。DAS基于SHOW ENGINE INNODB STATUS返回的最近一次死锁日志进行分析。如果发生过多次死锁,DAS只会对最近一次死锁进行分析。详情请参见[最近死锁分析](~~2858236~~)。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 目标数据库引擎为:RDS MySQL、自建MySQL、PolarDB MySQL版、PolarDB-X 2.0。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLatestDeadLockAnalysis'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:CreateLatestDeadLockAnalysis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]',
],
'CreateQueryOptimizeTag' => [
'summary' => '调用CreateQueryOptimizeTag接口,对目标SQL进行打标。',
'methods' => ['post'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**:RDS MySQL'."\n"
.'- **PolarDBMySQL**:PolarDB MySQL版'."\n"
.'- **PostgreSQL**:RDS PostgreSQL', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'SqlIds',
'in' => 'query',
'schema' => ['description' => 'SQL模板ID,您可以调用[GetQueryOptimizeDataStats](~~405261~~)接口查询SQL模板ID。支持英文逗号(,)分隔传入多个模板ID,进行批量打标。', 'type' => 'string', 'required' => true, 'example' => '6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****'],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => [
'description' => 'SQL标签。支持英文逗号(,)分隔传入多个值。'."\n"
."\n"
.'- **DAS\\_IMPORTANT**:重要SQL。'."\n"
.'- **DAS\\_NOT\\_IMPORTANT**:不重要SQL。'."\n"
.'- **USER\\_IGNORE**:无需优化。'."\n"
.'- **DAS\\_IN\\_PLAN**:排期优化。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'DAS_IN_PLAN,DAS_NOT_IMPORTANT',
],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '设置请求参数**Tags**的状态:'."\n"
."\n"
.'- **0**:清空请求参数**SqlIds**对应的全部标签,忽略请求参数**Tags**设置。'."\n"
.'- **1**:设置请求参数**SqlIds**对应的标签为请求参数**Tags**的值。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Comments',
'in' => 'query',
'schema' => ['description' => '备注。'."\n"
."\n"
.'长度为1~300个字符。', 'type' => 'string', 'required' => false, 'example' => 'Slow SQL from offline synchronization. No optimization needed.'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => ['title' => 'Boolean', 'description' => '打标操作是否执行成功:'."\n"
."\n"
.'- **true**:打标成功。'."\n"
.'- **false**:打标失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateQueryOptimizeTagResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>true</Data>\\n</CreateQueryOptimizeTagResponse>","errorExample":""}]',
'title' => '对目标SQL进行打标',
'description' => '- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQueryOptimizeTag'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:CreateQueryOptimizeTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateRequestDiagnosis' => [
'summary' => '调用CreateRequestDiagnosis接口,发起SQL诊断请求。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-0iwhhl8gx0ld6****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
.'> 对于PolarDB MySQL版、PolarDB PostgreSQL版(兼容Oracle)和云数据库MongoDB等集群实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => '202****'],
],
[
'name' => 'Database',
'in' => 'query',
'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => true, 'example' => 'das'],
],
[
'name' => 'Sql',
'in' => 'query',
'schema' => ['description' => '待诊断的SQL。', 'type' => 'string', 'required' => true, 'example' => 'select * from test where name = \'mockUser\''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回的消息。'."\n"
."\n"
.'> 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '诊断ID,是诊断的唯一标识,后续用于查询诊断结果。', 'type' => 'string', 'example' => '61820b594664275c4429****'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '800FBAF5-A539-5B97-A09E-C63AB2F7****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '发起SQL诊断请求',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
."\n"
.' - RDS MySQL'."\n"
.' - RDS PostgreSQL'."\n"
.' - RDS SQL Server'."\n"
.' - PolarDB MySQL版'."\n"
.' - PolarDB PostgreSQL版(兼容Oracle)'."\n"
.' - 云数据库MongoDB版'."\n"
."\n"
.'> RDS PostgreSQL实例内核小版本为20221230及以上。查看和升级内核小版本,请参见[升级内核小版本](~~146895~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRequestDiagnosis'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateRequestDiagnosis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"61820b594664275c4429****\\",\\n \\"RequestId\\": \\"800FBAF5-A539-5B97-A09E-C63AB2F7****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateRequestDiagnosisResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>61820b594664275c4429****</Data>\\n <RequestId>800FBAF5-A539-5B97-A09E-C63AB2F7****</RequestId>\\n <Success>true</Success>\\n</CreateRequestDiagnosisResponse>","errorExample":""}]',
],
'CreateSecurityIPGroup' => [
'summary' => '创建用户跨产品白名单模板',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247410',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'GlobalIgName',
'in' => 'query',
'schema' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求:'."\n"
."\n"
.'- 由小写字母、数字、下划线(_)组成。'."\n"
."\n"
.'- 由字母开头、字母或数字结尾。'."\n"
."\n"
.'- 长度为2~120个字符。', 'type' => 'string', 'required' => true, 'example' => 'test_123'],
],
[
'name' => 'GIpList',
'in' => 'query',
'schema' => ['description' => '白名单模板内的IP地址。'."\n"
."\n"
.'> 多个IP地址需要用英文逗号(,)分隔,不可重复,上限为1000个。', 'type' => 'string', 'required' => true, 'example' => '192.168.0.1'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'ListResult<InstanceSSL>',
'description' => 'ListResult<InstanceSSL>',
'type' => 'object',
'properties' => [
'GlobalSecurityIPGroup' => [
'description' => '跨产品白名单模板信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SecurityIpType' => ['description' => 'IP类型', 'type' => 'string', 'example' => 'ipv4'],
'RegionId' => ['description' => '地域 ID。'."\n"
."\n"
.'示例值:'."\n"
.'cn-hangzhou', 'type' => 'string', 'example' => 'cn-shenzhen'],
'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求:'."\n"
."\n"
.'- 由小写字母、数字、下划线(_)组成。'."\n"
."\n"
.'- 由字母开头、字母或数字结尾。'."\n"
."\n"
.'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test'],
'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-2uztsd6yvhmsqyjXXX'],
'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'],
'GIpList' => ['description' => '白名单模板内的IP地址。'."\n"
."\n"
.'> 多个IP地址需要用英文逗号隔开,所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.0/24'],
],
'description' => '',
],
],
],
],
'Message' => ['description' => '请求返回的消息。'."\n"
."\n"
.'> 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D578DB3C-06BF-54F2-A78F-C6C25Exxxxxx'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'description' => '前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 仅开通了DAS企业版的数据库实例支持创建离线任务。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。'."\n"
."\n"
.'接口限制:'."\n"
."\n"
.'最大同时执行数量为10。',
'title' => '跨产品白名单模板创建接口',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateSecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"SecurityIpType\\": \\"ipv4\\",\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GlobalIgName\\": \\"test\\",\\n \\"GlobalSecurityGroupId\\": \\"g-2uztsd6yvhmsqyjXXX\\",\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"GIpList\\": \\"192.168.0.0/24\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"D578DB3C-06BF-54F2-A78F-C6C25Exxxxxx\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'CreateSqlLogTask' => [
'summary' => '创建明细数据异步任务。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '199695',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
.'>该参数仅适用于集群版实例,可以选择查询指定节点离线任务。若不传该参数,默认返回主节点离线任务。', 'type' => 'string', 'required' => false, 'example' => 'pi-uf6k5f6g3912i****'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => ['description' => '任务类型'."\n"
."\n"
.'- **Export**:导出任务。'."\n"
.'> **Export**支持的过滤参数及其取值请参考**请求参数补充说明**。'."\n"
.'- **Query**:查询任务。', 'type' => 'string', 'required' => false, 'example' => 'Export'],
],
[
'name' => 'Name',
'in' => 'formData',
'schema' => ['description' => '任务名称。', 'type' => 'string', 'required' => false, 'example' => 'SQL audit export 1'],
],
[
'name' => 'Filters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '筛选条件列表。',
'type' => 'array',
'items' => [
'description' => '筛选条件。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数的名称。'."\n"
."\n"
.'> 支持的过滤参数及其取值请参考**请求参数补充说明**。', 'type' => 'string', 'required' => false, 'example' => 'KeyWords'],
'Value' => ['description' => '过滤参数的数值。', 'type' => 'string', 'required' => false, 'example' => 'select'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '任务的开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1596177993000'."\n"],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '任务结束时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1608888296000'."\n"],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => ['description' => 'PolarDB-X 2.0数据库实例节点信息。'."\n"
."\n"
.'- **polarx_cn**:计算节点。'."\n"
."\n"
.'- **polarx_dn**:数据节点。', 'type' => 'string', 'required' => false, 'example' => 'polarx_cn'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '83D9D59B-057A-54A9-BFF9-CF2B42F05645'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'SqlLogTask',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '54f8041743ca3a9ac5cb9342d050527c'],
'InstanceId' => ['title' => '实例标识', 'description' => '数据库实例ID。', 'type' => 'string', 'example' => 'pc-2ze8g2am97624****'],
'Name' => ['title' => '任务别名', 'description' => '任务名称。', 'type' => 'string', 'example' => 'Export_test'],
'Start' => ['title' => '查询开始时间', 'description' => '开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596177993000'],
'End' => ['title' => '查询结束时间', 'description' => '结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296000'."\n"],
'Status' => ['title' => '任务状态', 'description' => '任务状态。'."\n"
.'- **INIT**:待调度。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **FAILED**:失败。'."\n"
.'- **CANCELED**:已取消。'."\n"
.'- **COMPLETED**:完成。'."\n"
."\n"
.'> 当任务处于**COMPLETED**时,可以查看任务的结果。', 'type' => 'string', 'example' => 'COMPLETED'],
'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1681363254423'."\n"],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"83D9D59B-057A-54A9-BFF9-CF2B42F05645\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"54f8041743ca3a9ac5cb9342d050527c\\",\\n \\"InstanceId\\": \\"pc-2ze8g2am97624****\\",\\n \\"Name\\": \\"Export_test\\",\\n \\"Start\\": 1596177993000,\\n \\"End\\": 1608888296000,\\n \\"Status\\": \\"COMPLETED\\",\\n \\"CreateTime\\": 1681363254423\\n }\\n}","type":"json"}]',
'title' => '创建DAS企业版离线任务',
'description' => '前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 仅开通了DAS企业版的数据库实例支持创建离线任务。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。'."\n"
."\n"
.'接口限制:'."\n"
."\n"
.'最大同时执行数量为10。',
'requestParamsDescription' => '**Key**支持的参数和取值:'."\n"
.'- **KeyWords**:关键字,多个关键字间使用空格隔开。'."\n"
.'- **LogicalOperator**:关键字间的逻辑操作,取值为and或or。'."\n"
.'- **AccountName**:用户名,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **DbName**:数据库名称,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **HostAddress**:客户端IP地址,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **MaxConsume**:最大耗时,单位us。'."\n"
.'- **MinConsume**:最小耗时,单位us。'."\n"
.'- **MaxScanRows**:最大扫描行。'."\n"
.'- **MinScanRows**:最小扫描行。'."\n"
.'- **SqlType**:SQL类型,取值select、update、insert或delete。'."\n"
.'- **State**:执行结果,取值0(成功)或1(失败)。'."\n"
.'- **ThreadId**:线程ID。'."\n"
.'- **SortKey**:排序列名称,取值ScanRows(扫描行数)、UpdateRows(更新行数)、Consume(耗时)、ExecuteTime(执行时间)、ReturnRows(返回行数)、LockTime(锁等待时间)、Frows(PolarDB-X 2.0计算节点的拉取行数)、Scnt(PolarDB-X 2.0计算节点的DN请求数)、CpuTime(CPU执行时间)、PhysicalRead(物理读)。'."\n"
.'- **SortMethod**:排序方式,取值DESC(降序)、ASC(升序)。默认为DESC。'."\n"
.'- **TraceId**:PolarDB-X 2.0实例的跟踪ID。'."\n"
.'- **MinRows**:最小更新行数。'."\n"
.'- **MaxRows**:最大更新行数。'."\n"
.'- **MinScnt**:PolarDB-X 2.0计算节点(CN)的DN最小请求数。'."\n"
.'- **MaxScnt**:PolarDB-X 2.0计算节点(CN)的DN最大请求数。'."\n"
.'- **TrxId**:事务ID。'."\n"
.'- **Fail**:错误码。'."\n"
.'- **SqlId**:SQL ID。'."\n"
.'- **JobId**:通过异步任务ID进一步查询返回结果。'."\n"
.'- **Delimiter**:分隔符,支持的`|` `,` `$` `#` 四种。'."\n"
.'- **Columns**:**Type** = **Export**,任务类型为导出任务时,传入选择的导出列,导出列用空格隔开,可选的有'."\n"
.' - **columnDBName**:数据库'."\n"
.' - **columnThreadId**:线程ID'."\n"
.' - **columnAccountName**:用户'."\n"
.' - **columnHostAddress**:客户端IP'."\n"
.' - **columnSqlType**:sql类型'."\n"
.' - **columnState**:状态'."\n"
.' - **columnConsume**:耗时us'."\n"
.' - **columnUpdateRows**:更新行数'."\n"
.' - **columnScanRows**:扫描行数'."\n"
.' - **columnReturnRows**:返回行数'."\n"
.' - **columnLockTime**:锁等待时间'."\n"
.' - **columnLogicRead**:逻辑读'."\n"
.' - **columnPhysicSyncRead**:物理同步读'."\n"
.' - **columnPhysicASyncRead**:物理异步读'."\n"
.' - **columnOriginTime**:执行时间(us)'."\n"
.' - **columnExecuteTime**:执行时间(类似于 2024-07-30 11:00:00)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSqlLogTask'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateSqlLogTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'CreateStorageAnalysisTask' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
.'对于MongoDB实例,通过该参数指定节点进行空间分析。调用[DescribeRoleZoneInfo](~~123802~~)接口,可以查询MongoDB实例各个节点的详细信息。'."\n"
."\n"
.'- 当传入目标节点的**InsName**(节点ID)时,例如`d-bp1872fa24d5****`,调用该接口分析其对应的Hidden节点。'."\n"
.'- 当传入目标节点的`InsName#RoleId`时,例如`d-bp1872fa24d5****#299****5`,调用该接口分析指定的节点。'."\n"
."\n"
.'><notice>对于MongoDB副本集实例,不传入此参数时,调用该接口会默认分析唯一的Hidden节点。对于MongoDB分片集群实例,推荐传入此参数,指定目标节点。</notice>', 'type' => 'string', 'required' => false, 'example' => 'd-bp1872fa24d5****'],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => '数据库名。传入该参数时,分析指定数据库的空间使用情况。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
[
'name' => 'TableName',
'in' => 'query',
'schema' => ['description' => '表名。传入该参数时,分析指定数据库中指定表的空间使用情况。传入该参数时,必须同时传入**DbName**,指定该表所属的数据库。', 'type' => 'string', 'required' => false, 'example' => 'test_table'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '910f83f4b96df0524ddc5749f61539f8'],
'CreateTaskSuccess' => ['description' => '创建任务是否成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'false'],
'ErrorMessage' => ['description' => '创建任务失败时的错误提示。', 'type' => 'string', 'example' => 'unknown error'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '创建空间分析任务',
'summary' => '调用CreateStorageAnalysisTask接口,创建空间分析任务,获取数据库及表的空间使用数据。',
'description' => '- 本接口仅适用于RDS MySQL、PolarDB MySQL版和MongoDB实例。'."\n"
.'- 对于RDS MySQL和PolarDB MySQL版实例,本接口对应于旧版空间分析功能,该接口生成的任务无法在DAS控制台新版空间分析页面查看。如有需要查看任务及结果,请调用接口获取数据后自行保存。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStorageAnalysisTask'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:CreateStorageAnalysisTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"910f83f4b96df0524ddc5749f61539f8\\",\\n \\"CreateTaskSuccess\\": false,\\n \\"ErrorMessage\\": \\"unknown error\\"\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'DeleteCloudBenchTask' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID,您可通过[DescribeCloudBenchTasks](~~230670~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '删除压测任务',
'summary' => '调用DeleteCloudBenchTask接口,删除压测任务。',
'description' => '数据库自治服务DAS提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见[智能压测](~~155068~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCloudBenchTask'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DeleteCloudBenchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"None\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteCloudBenchTaskResponse>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Message>Successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteCloudBenchTaskResponse>","errorExample":""}]',
],
'DeleteSecurityIPGroup' => [
'summary' => '删除用户跨产品白名单模板',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247410',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'GlobalSecurityGroupId',
'in' => 'query',
'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-rcge12hbfooad3m****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'ListResult<InstanceSSL>',
'description' => 'ListResult<InstanceSSL>',
'type' => 'object',
'properties' => [
'GlobalSecurityIPGroup' => [
'description' => '跨产品白名单模板信息。',
'type' => 'array',
'items' => [
'description' => '跨产品白名单模板信息。',
'type' => 'object',
'properties' => [
'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-1no2rzybnqcv0m****'."\n"],
],
],
],
],
],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'description' => '- 本接口用于删除[CreateCloudBenchTasks](~~230665~~)接口创建的智能压测任务中已释放的DBgateway元数据。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'> 当DBGateway与接入点超过20秒无心跳时,此DBGateway为停止状态。',
'title' => '跨产品白名单模板删除接口',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DeleteSecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"GlobalSecurityGroupId\\": \\"g-1no2rzybnqcv0m****\\\\n\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'DeleteStopGateway' => [
'summary' => '调用DeleteStopGateway接口,删除已停止的DBGateway元数据。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'GatewayId',
'in' => 'query',
'schema' => ['description' => 'DBGateway的ID,是DBGateway的唯一标识。可通过[DescribeCloudbenchTask](~~230669~~)接口获取,返回的**ClientGatewayId**字段值即为DBGateway的ID。', 'type' => 'string', 'required' => true, 'example' => '22938c83fcfbced4b4869b9695e3****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => 'DBGateway元数据删除结果:'."\n"
."\n"
.'- **0**:执行成功。'."\n"
.'- **-1**:系统错误。'."\n"
.'- **-2**:DBGateway不存在。'."\n"
.'- **-3**:DBGateway未停止,无法删除元数据。'."\n"
.'- **-4**:删除元数据信息失败。'."\n", 'type' => 'string', 'example' => '0'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FC6C0929-29E1-59FD-8DFE-70D9D41E****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '删除已停止的DBGateway元数据',
'description' => '- 本接口用于删除[CreateCloudBenchTasks](~~230665~~)接口创建的智能压测任务中已释放的DBgateway元数据。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'> 当DBGateway与接入点超过20秒无心跳时,此DBGateway为停止状态。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStopGateway'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DeleteStopGateway',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"0\\",\\n \\"RequestId\\": \\"FC6C0929-29E1-59FD-8DFE-70D9D41E****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteStopGatewayResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>0</Data>\\n <RequestId>FC6C0929-29E1-59FD-8DFE-70D9D41E****</RequestId>\\n <Success>true</Success>\\n</DeleteStopGatewayResponse>","errorExample":""}]',
],
'DescribeAuditLogs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '212859',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Lang',
'in' => 'query',
'schema' => ['description' => '请求和接收消息的语言类型,默认为zh_cn。取值:'."\n"
."\n"
.'- zh_cn:中文。'."\n"
.'- en_us:英文。', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'UserName',
'in' => 'query',
'schema' => ['description' => '用户名', 'type' => 'string', 'required' => false, 'example' => 'admin'],
],
[
'name' => 'ClientIp',
'in' => 'query',
'schema' => ['description' => '请求客户端 IP。', 'type' => 'string', 'required' => false, 'example' => '11.26.118.7'],
],
[
'name' => 'ClientUa',
'in' => 'query',
'schema' => ['description' => '客户端类型。', 'type' => 'string', 'required' => false, 'example' => 'mysql'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '资产实例名称', 'type' => 'string', 'required' => false, 'example' => 'rm-t4ni1cezz5y3xxxx'],
],
[
'name' => 'DatabaseName',
'in' => 'query',
'schema' => ['description' => '数据库的名称。', 'type' => 'string', 'required' => false, 'example' => 'TestDB'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '告警日志起始时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1608888296000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '告警日志结束时间,以毫秒为单位的 unix 时间戳。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15682887991222'],
],
[
'name' => 'ProductCode',
'in' => 'query',
'schema' => ['description' => '数据资产所属的产品名称。取值:**RDS、PolarDB、PolarDB-X 2.0**等。', 'type' => 'string', 'required' => false, 'example' => 'RDS'],
],
[
'name' => 'ProductId',
'in' => 'query',
'schema' => ['description' => '数据对象所属的产品名称对应的 ID。取值:'."\n"
."\n"
.'- 3:ADB-MYSQL'."\n"
.'- 5:RDS'."\n"
.'- 7:PolarDB-X'."\n"
.'- 8:PolarDB'."\n"
.'- 9:ADB-PG'."\n"
.'- 11:MongoDB'."\n"
.'- 25:Redis', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'],
],
[
'name' => 'SqlText',
'in' => 'query',
'schema' => ['description' => 'SQL 语句内容。', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM test where name = \'das\''],
],
[
'name' => 'ExecuteTimeRange',
'in' => 'query',
'schema' => ['description' => '执行时间的范围。', 'type' => 'string', 'required' => false, 'example' => 'in[1000 2000]'],
],
[
'name' => 'EffectRowRange',
'in' => 'query',
'schema' => ['description' => '影响行数范围。', 'type' => 'string', 'required' => false, 'example' => 'in[1 33]'],
],
[
'name' => 'RuleID',
'in' => 'query',
'schema' => ['description' => '审计规则id。', 'type' => 'string', 'required' => false, 'example' => '9953411'],
],
[
'name' => 'RuleName',
'in' => 'query',
'schema' => ['description' => '审计规则名称。', 'type' => 'string', 'required' => false, 'example' => 'test_rule'],
],
[
'name' => 'OperateType',
'in' => 'query',
'schema' => ['description' => '操作类型。', 'type' => 'string', 'required' => false, 'example' => 'Insert'],
],
[
'name' => 'OssObjectKey',
'in' => 'query',
'schema' => ['description' => 'OSS存储对象的key值。', 'type' => 'string', 'required' => false, 'example' => 'N.A'],
],
[
'name' => 'AsyncRequestId',
'in' => 'query',
'schema' => ['description' => '请求id。', 'type' => 'string', 'required' => false, 'example' => '2c548e83-1473-4fda-b3dc-5a189074ead5'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
'name' => 'RuleCategory',
'in' => 'query',
'schema' => ['description' => '规则类型。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'LoadWhiteList',
'in' => 'query',
'schema' => ['description' => '是否加载白名单状态。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'IpType',
'in' => 'query',
'schema' => ['description' => '网络类型。枚举类型,取值:'."\n"
."\n"
.'- **default**(默认值):非阿里云服务'."\n"
."\n"
.'- **aliyun**: 阿里云服务', 'type' => 'string', 'required' => false, 'example' => 'aliyun'],
],
[
'name' => 'LogSource',
'in' => 'query',
'schema' => ['description' => '数据来源', 'type' => 'string', 'required' => false, 'example' => 'SLOW_SQL'],
],
[
'name' => 'RuleAggQuery',
'in' => 'query',
'schema' => ['description' => '是否聚合查询', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'RuleId',
'in' => 'query',
'schema' => ['description' => '规则ID', 'type' => 'string', 'required' => false, 'example' => '867028'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AsyncRequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '3926fba5-1774-44f4-af2d-ac7b33e86c3b'],
'CurrentPage' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '分页查询,每页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A7021857-AFD9-5AD6-979D-AA7DFC5AFADF'],
'TotalCount' => ['description' => '总的记录数(仅 Redis 引擎有效)', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'Items' => [
'description' => 'SQL日志记录中的客户端IP'."\n"
.'SQL日志记录中客户端的IP地址',
'type' => 'array',
'items' => [
'description' => '物理异步读。',
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => '告警时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1536751124000'],
'WarnLevel' => ['description' => '危险等级。'."\n"
.'- **1**:低危。'."\n"
.'- **2**:中危。'."\n"
.'- **3**:高危。', 'type' => 'string', 'example' => '1'],
'ClientPort' => ['description' => '查询中客户端端口号', 'type' => 'string', 'example' => '53815'],
'TableName' => ['description' => '查询中使用的表名', 'type' => 'string', 'example' => 'it_table'],
'EffectRow' => ['description' => '影响行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PackageName' => ['description' => 'MaxCompute包名称。', 'type' => 'string', 'example' => 'test01'],
'UserId' => ['description' => '用户 UID。', 'type' => 'string', 'example' => '19********94'],
'Message' => ['description' => '原始日志内容。', 'type' => 'string', 'example' => 'success'],
'RuleId' => ['description' => '审计规则 id。', 'type' => 'string', 'example' => '9953411'],
'OperateType' => ['description' => '操作类型。', 'type' => 'string', 'example' => 'Drop'],
'LogTime' => ['description' => '日志执行时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1751870592000'],
'WarnLevelName' => ['description' => '危险等级名称。'."\n"
.'- 低危。'."\n"
.'- 中危。'."\n"
.'- 高危。', 'type' => 'string', 'example' => '1'],
'InstanceName' => ['description' => '实例别名。', 'type' => 'string', 'example' => 'test-instance-003'],
'DatabaseName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'chngc_b2b_migration_sh'],
'OssObjectKey' => ['description' => 'OSS存储对象的key值。', 'type' => 'string', 'example' => 'N.A'],
'ExecuteStatus' => ['description' => '执行状态:0:未成功 1:执行成功', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ProductId' => ['description' => '数据对象所属的产品名称对应的 ID。取值:'."\n"
."\n"
.'- 3:ADB-MYSQL'."\n"
.'- 5:RDS'."\n"
.'- 7:PolarDB-X'."\n"
.'- 8:PolarDB'."\n"
.'- 9:ADB-PG'."\n"
.'- 11:MongoDB'."\n"
.'- 25:Redis', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'ExecuteTime' => ['description' => '执行时长,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1751870592000'],
'UserName' => ['description' => '用户名', 'type' => 'string', 'example' => 'admin'],
'InstanceDescription' => ['description' => '数据资产实例的描述信息。', 'type' => 'string', 'example' => 'instance dscription'],
'RuleName' => ['description' => '审计规则名称。', 'type' => 'string', 'example' => 'name'],
'ColumnName' => ['description' => '列名。', 'type' => 'string', 'example' => 'ds'],
'ClientIp' => ['description' => '查询中的客户端IP地址', 'type' => 'string', 'example' => '100.104.16.251'],
'ClientUa' => ['description' => '客户端类型。', 'type' => 'string', 'example' => 'mysql'],
'Id' => ['description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ProductCode' => ['description' => '数据资产所属的产品名称。取值:RDS、PolarDB、PolarDB-X 2.0等。', 'type' => 'string', 'example' => 'RDS'],
'SqlText' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'select * from test03'],
'InWhiteList' => ['description' => '告警是否在加白列表。', 'type' => 'boolean', 'example' => 'True'],
'IpType' => ['description' => '网络类型。枚举类型,取值:'."\n"
."\n"
.'**default**(默认值):非阿里云服务'."\n"
."\n"
.'**aliyun**: 阿里云服务', 'type' => 'string', 'example' => 'aliyun'],
'RuleCategory' => ['description' => '规则类型。', 'type' => 'string', 'example' => '10'],
'LogSource' => ['description' => '数据来源', 'type' => 'string', 'example' => 'SLOW_SQL'],
'InstanceAuditStatus' => ['description' => '实例审计状态', 'type' => 'string', 'example' => '2'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询审计告警日志',
'summary' => '本接口一般用于数据审计告警日志列表查询,便于告警搜索和告警处理。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AsyncRequestId\\": \\"3926fba5-1774-44f4-af2d-ac7b33e86c3b\\",\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"A7021857-AFD9-5AD6-979D-AA7DFC5AFADF\\",\\n \\"TotalCount\\": 12,\\n \\"Items\\": [\\n {\\n \\"CreationTime\\": 1536751124000,\\n \\"WarnLevel\\": \\"1\\",\\n \\"ClientPort\\": \\"53815\\",\\n \\"TableName\\": \\"it_table\\",\\n \\"EffectRow\\": 10,\\n \\"PackageName\\": \\"test01\\",\\n \\"UserId\\": \\"19********94\\",\\n \\"Message\\": \\"success\\",\\n \\"RuleId\\": \\"9953411\\",\\n \\"OperateType\\": \\"Drop\\",\\n \\"LogTime\\": 1751870592000,\\n \\"WarnLevelName\\": \\"1\\",\\n \\"InstanceName\\": \\"test-instance-003\\",\\n \\"DatabaseName\\": \\"chngc_b2b_migration_sh\\",\\n \\"OssObjectKey\\": \\"N.A\\",\\n \\"ExecuteStatus\\": 1,\\n \\"ProductId\\": 5,\\n \\"ExecuteTime\\": 1751870592000,\\n \\"UserName\\": \\"admin\\",\\n \\"InstanceDescription\\": \\"instance dscription\\",\\n \\"RuleName\\": \\"name\\",\\n \\"ColumnName\\": \\"ds\\",\\n \\"ClientIp\\": \\"100.104.16.251\\",\\n \\"ClientUa\\": \\"mysql\\",\\n \\"Id\\": 1,\\n \\"ProductCode\\": \\"RDS\\",\\n \\"SqlText\\": \\"select * from test03\\",\\n \\"InWhiteList\\": true,\\n \\"IpType\\": \\"aliyun\\",\\n \\"RuleCategory\\": \\"10\\",\\n \\"LogSource\\": \\"SLOW_SQL\\",\\n \\"InstanceAuditStatus\\": \\"2\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeAutoScalingConfig' => [
'summary' => '调用DescribeAutoScalingConfig接口,查询实例弹性伸缩功能配置信息。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-2ze1prap1k46r****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'description' => '实例弹性伸缩功能配置信息。',
'type' => 'object',
'properties' => [
'Spec' => [
'description' => '规格弹性伸缩功能配置信息。',
'type' => 'object',
'properties' => [
'Upgrade' => ['description' => '规格自动扩容是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'CpuUsageUpperThreshold' => ['description' => '触发规格自动扩容的CPU平均利用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'MemUsageUpperThreshold' => ['description' => '触发规格自动扩容的内存平均利用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'MaxSpec' => ['description' => '自动扩容的规格上限。详情请参见各数据库实例的产品规格文档:'."\n"
.'<props="china">'."\n"
."\n"
.'- PolarDB MySQL版的集群版请参见[计算节点规格](~~102542~~)。'."\n"
.'- RDS MySQL高可用系列云盘版请参见[产品规格](~~276974~~)。'."\n"
.'- Redis社区云盘版请参见[实例规格](~~144986~~)。'."\n"
."\n"
.'</props>'."\n"
."\n"
.'<props="intl">'."\n"
."\n"
.'- PolarDB MySQL版的集群版请参见[计算节点规格](~~102542~~)。'."\n"
.'- RDS MySQL高可用系列云盘版请参见[产品规格](~~276974~~)。'."\n"
."\n"
.'</props>', 'type' => 'string', 'example' => 'polar.mysql.x8.12xlarge'],
'MaxReadOnlyNodes' => ['description' => '实例只读节点数的最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'ObservationWindowSize' => ['description' => '观测窗口。 返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**5m**表示5分钟。', 'type' => 'string', 'example' => '5m'],
'CoolDownTime' => ['description' => '静默期。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**5m**表示5分钟。', 'type' => 'string', 'example' => '5m'],
'Downgrade' => ['description' => '规格自动回缩是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
],
],
'Storage' => [
'description' => '实例存储自动扩容功能配置信息。',
'type' => 'object',
'properties' => [
'Upgrade' => ['description' => '存储自动扩容是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'DiskUsageUpperThreshold' => ['description' => '触发存储自动扩容的存储空间平均利用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'MaxStorage' => ['description' => '存储空间上限,单位为GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '32000'],
],
],
'Resource' => [
'description' => '实例本地资源弹性伸缩功能配置信息。',
'type' => 'object',
'properties' => [
'Enable' => ['description' => '本地资源弹性伸缩是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'CpuUsageUpperThreshold' => ['description' => '触发本地资源自动扩容的CPU平均利用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'CpuStep' => ['description' => 'CPU扩容步长。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'UpgradeObservationWindowSize' => ['description' => '扩容观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**5m**表示5分钟。', 'type' => 'string', 'example' => '5m'],
'DowngradeObservationWindowSize' => ['description' => '缩容观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**5m**表示5分钟。', 'type' => 'string', 'example' => '5m'],
],
],
'Shard' => [
'description' => '实例分片弹性伸缩功能配置信息。',
'type' => 'object',
'properties' => [
'Upgrade' => ['description' => '自动增加分片是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n", 'type' => 'boolean', 'example' => 'true'],
'MemUsageUpperThreshold' => ['description' => '触发自动增加分片的内存平均利用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'MaxShards' => ['description' => '实例总分片数的最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'UpgradeObservationWindowSize' => ['description' => '自动增加分片观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**5m**表示5分钟。', 'type' => 'string', 'example' => '5m'],
'Downgrade' => ['description' => '自动减少分片是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n", 'type' => 'boolean', 'example' => 'true'],
'MemUsageLowerThreshold' => ['description' => '触发自动减少分片的内存平均利用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'MinShards' => ['description' => '实例总分片数的最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'DowngradeObservationWindowSize' => ['description' => '自动减少分片观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**1d**表示1天。', 'type' => 'string', 'example' => '1d'],
],
],
'Bandwidth' => [
'description' => '实例带宽弹性伸缩功能配置信息。',
'type' => 'object',
'properties' => [
'Upgrade' => ['description' => '带宽自动扩展是否开启:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n", 'type' => 'boolean', 'example' => 'true'],
'BandwidthUsageUpperThreshold' => ['description' => '触发带宽自动扩展的带宽平均使用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
'ObservationWindowSize' => ['description' => '带宽自动扩展的观测窗口。返回值由数值和时间单位后缀组成,其中时间单位后缀含义如下:'."\n"
."\n"
.'- **s**:表示秒。'."\n"
.'- **m**:表示分钟。'."\n"
.'- **h**:表示小时。'."\n"
.'- **d**:表示天。 '."\n"
."\n"
.'> 例如,返回**5m**表示5分钟。', 'type' => 'string', 'example' => '5m'],
'Downgrade' => ['description' => '带宽自动回缩是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'BandwidthUsageLowerThreshold' => ['description' => '触发带宽自动回缩的带宽平均使用率阈值,单位为%。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"Spec\\": {\\n \\"Upgrade\\": true,\\n \\"CpuUsageUpperThreshold\\": 70,\\n \\"MemUsageUpperThreshold\\": 70,\\n \\"MaxSpec\\": \\"polar.mysql.x8.12xlarge\\",\\n \\"MaxReadOnlyNodes\\": 10,\\n \\"ObservationWindowSize\\": \\"5m\\",\\n \\"CoolDownTime\\": \\"5m\\",\\n \\"Downgrade\\": true\\n },\\n \\"Storage\\": {\\n \\"Upgrade\\": true,\\n \\"DiskUsageUpperThreshold\\": 70,\\n \\"MaxStorage\\": 32000\\n },\\n \\"Resource\\": {\\n \\"Enable\\": true,\\n \\"CpuUsageUpperThreshold\\": 70,\\n \\"CpuStep\\": 2,\\n \\"UpgradeObservationWindowSize\\": \\"5m\\",\\n \\"DowngradeObservationWindowSize\\": \\"5m\\"\\n },\\n \\"Shard\\": {\\n \\"Upgrade\\": true,\\n \\"MemUsageUpperThreshold\\": 70,\\n \\"MaxShards\\": 16,\\n \\"UpgradeObservationWindowSize\\": \\"5m\\",\\n \\"Downgrade\\": true,\\n \\"MemUsageLowerThreshold\\": 30,\\n \\"MinShards\\": 4,\\n \\"DowngradeObservationWindowSize\\": \\"1d\\"\\n },\\n \\"Bandwidth\\": {\\n \\"Upgrade\\": true,\\n \\"BandwidthUsageUpperThreshold\\": 70,\\n \\"ObservationWindowSize\\": \\"5m\\",\\n \\"Downgrade\\": true,\\n \\"BandwidthUsageLowerThreshold\\": 30\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeAutoScalingConfigResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Spec>\\n <Upgrade>true</Upgrade>\\n <CpuUsageUpperThreshold>70</CpuUsageUpperThreshold>\\n <MemUsageUpperThreshold>70</MemUsageUpperThreshold>\\n <MaxSpec>polar.mysql.x8.12xlarge</MaxSpec>\\n <MaxReadOnlyNodes>10</MaxReadOnlyNodes>\\n <ObservationWindowSize>5m</ObservationWindowSize>\\n <CoolDownTime>5m</CoolDownTime>\\n <Downgrade>true</Downgrade>\\n </Spec>\\n </Data>\\n</DescribeAutoScalingConfigResponse>","errorExample":""}]',
'title' => '查询实例弹性伸缩功能配置信息',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeAutoScalingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeAutoScalingHistory' => [
'methods' => ['get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
."\n"
.'> 当前仅支持RDS MySQL实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'AutoScalingTaskType',
'in' => 'query',
'schema' => ['description' => '查询的弹性伸缩业务种类。当前仅支持**SPEC**,表示仅支持查询自动性能扩展历史信息。', 'type' => 'string', 'required' => true, 'example' => 'SPEC'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务的开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'>查询任务的开始时间最大不能早于当前时间45天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1675833788056'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>查询任务结束时间需晚于查询任务开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1676605305796'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'AutoScalingInstanceHistory',
'description' => '弹性伸缩历史记录。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
'SpecHistory' => [
'description' => '自动性能扩展历史记录。',
'type' => 'array',
'items' => [
'description' => '自动性能扩展历史信息。',
'type' => 'object',
'properties' => [
'ScaleType' => ['description' => '自动性能扩展任务类型,取值:'."\n"
.'- **SCALE_UP**:规格自动扩容。'."\n"
.'- **SCALE_DOWN**:规格自动缩容。', 'type' => 'string', 'example' => 'SCALE_UP'],
'TaskExcuteStatus' => ['description' => '任务执行状态:'."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'ErrorCode' => ['description' => '扩缩容内部任务返回的错误码:'."\n"
."\n"
.'- **Insufficient_Balance** :用户余额不足或存在未支付订单。'."\n"
.'- **REACH_SPEC_UPPERBOUND** :已达到用户规格上限。'."\n"
.'- **Control_Error_Timeout_Msg** :管控任务超时。'."\n"
.'- **Invoke_Rds_Api_Error_Msg** :调用RDS API失败。', 'type' => 'string', 'example' => 'Insufficient_Balance'],
'OriginInstanceClass' => ['description' => '原始实例规格码。', 'type' => 'string', 'example' => 'mysql.n2.large.2c'],
'TargetInstanceClass' => ['description' => '目标实例规格码。', 'type' => 'string', 'example' => 'mysql.n2.xlarge.2c'],
'OriginCore' => ['description' => '原始实例CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
'OriginMemory' => ['description' => '原始实例内存大小,单位GB。', 'type' => 'number', 'format' => 'double', 'example' => '8'],
'TargetCore' => ['description' => '目标实例CPU核数。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
'TargetMemory' => ['description' => '目标实例内存大小,单位GB。', 'type' => 'number', 'format' => 'double', 'example' => '16'],
'TaskTime' => ['description' => '任务执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1684830763000'],
],
],
],
'Storage' => [
'description' => '存储扩容历史记录,暂不支持。',
'type' => 'array',
'items' => ['description' => '实例存储扩容历史信息。', 'type' => 'object', 'example' => 'None'],
],
'Resource' => [
'description' => 'Redis资源扩容历史记录,暂不支持。',
'type' => 'array',
'items' => ['description' => 'Redis资源扩容历史信息。', 'type' => 'object', 'example' => 'None'],
],
'Shard' => [
'description' => 'Redis自动分片扩容历史记录,暂不支持。',
'type' => 'array',
'items' => ['description' => 'Redis自动分片扩容历史信息。', 'type' => 'object', 'example' => 'None'],
],
'Bandwidth' => [
'description' => 'Redis带宽弹性伸缩历史记录,暂不支持。',
'type' => 'array',
'items' => ['description' => 'Redis带宽弹性伸缩历史信息。', 'type' => 'object', 'example' => 'None'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询实例弹性伸缩历史信息',
'summary' => '调用DescribeAutoScalingHistory接口,查询实例弹性伸缩历史信息。',
'description' => '- 当前仅支持查询RDS MySQL高可用系列云盘版的自动性能扩展历史信息。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'requestParamsDescription' => 'AutoScalingTaskType取值为SPEC时,表示查询自动性能扩展历史,当前仅支持取值为SPEC。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAutoScalingHistory'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeAutoScalingHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\",\\n \\"SpecHistory\\": [\\n {\\n \\"ScaleType\\": \\"SCALE_UP\\",\\n \\"TaskExcuteStatus\\": true,\\n \\"ErrorCode\\": \\"Insufficient_Balance\\",\\n \\"OriginInstanceClass\\": \\"mysql.n2.large.2c\\",\\n \\"TargetInstanceClass\\": \\"mysql.n2.xlarge.2c\\",\\n \\"OriginCore\\": 4,\\n \\"OriginMemory\\": 8,\\n \\"TargetCore\\": 8,\\n \\"TargetMemory\\": 16,\\n \\"TaskTime\\": 1684830763000\\n }\\n ],\\n \\"Storage\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Resource\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Shard\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Bandwidth\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeCacheAnalysisJob' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '23813',
'abilityTreeNodes' => ['FEATUREhdmJC65CS'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'JobId',
'in' => 'query',
'schema' => ['description' => '缓存分析任务ID,您可通过调用[CreateCacheAnalysisJob](~~180982~~)接口获取返回参数的JobId。', 'type' => 'string', 'required' => true, 'example' => 'sf79-sd99-sa37-****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'TaskState' => ['description' => '缓存分析任务的状态:'."\n"
."\n"
.'- **BACKUP**:备份中。'."\n"
.'- **ANALYZING**:分析中。'."\n"
.'- **FINISHED**:分析完成。'."\n"
.'- **FAILED**:出现错误。', 'type' => 'string', 'example' => 'BACKUP'],
'JobId' => ['description' => '缓存分析任务ID。', 'type' => 'string', 'example' => 'sf79-sd99-sa37-****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'BigKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyInfo' => [
'description' => '大Key详细信息,根据Key占用字节数降序排列。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Db' => ['description' => '数据库名称。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpirationTimeMillis' => ['description' => 'Key过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0表示不过期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596256542547'],
'Key' => ['description' => 'Key的名称。', 'type' => 'string', 'example' => 'task_x****'],
'Encoding' => ['description' => 'Key内部数据类型。', 'type' => 'string', 'example' => 'hashtable'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
'description' => '',
],
],
],
'description' => '',
],
'KeyPrefixes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Prefix' => [
'description' => 'Key前缀列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KeyNum' => ['description' => '该前缀Key的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '123'],
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'Prefix' => ['description' => 'Key的前缀。', 'type' => 'string', 'example' => 'task_'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
'description' => '',
],
],
],
'description' => '',
],
'BigKeysOfNum' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyInfo' => [
'description' => '大Key详细信息,根据Key数量降序排列。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Db' => ['description' => '数据库名称。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpirationTimeMillis' => ['description' => 'Key过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0表示不过期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596256542547'],
'Key' => ['description' => 'Key的名称。', 'type' => 'string', 'example' => 'task_x****'],
'Encoding' => ['description' => 'Key内部数据类型。', 'type' => 'string', 'example' => 'hashtable'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
'description' => '',
],
],
],
'description' => '',
],
'UnexBigKeysOfBytes' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyInfo' => [
'description' => '永不过期Key的详细信息,根据Key占用字节数降序排列。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Db' => ['description' => '数据库名称。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpirationTimeMillis' => ['description' => 'Key过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0表示不过期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596256542547'],
'Key' => ['description' => 'Key的名称。', 'type' => 'string', 'example' => 'task_x****'],
'Encoding' => ['description' => 'Key内部数据类型。', 'type' => 'string', 'example' => 'hashtable'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'NodeId' => ['description' => '实例的数据节点ID', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
'description' => '',
],
],
],
'description' => '',
],
'UnexBigKeysOfNum' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyInfo' => [
'description' => '永不过期Key的详细信息,根据Key数量降序排列。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Db' => ['description' => '数据库名称。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpirationTimeMillis' => ['description' => 'Key过期时间,格式为 Unix 时间戳,单位为毫秒(ms),0表示不过期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596256542547'],
'Key' => ['description' => 'Key的名称。', 'type' => 'string', 'example' => 'task_x****'],
'Encoding' => ['description' => 'Key内部数据类型。', 'type' => 'string', 'example' => 'hashtable'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
'description' => '',
],
],
],
'description' => '',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'r-bp18ff4a195d****'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'ExpiryKeysLevelCount' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ExpiryLevel' => [
'description' => '按过期时间分类的Key统计信息。',
'type' => 'array',
'items' => [
'description' => '按过期时间分类的Key统计信息。',
'type' => 'object',
'properties' => [
'AnalysisTs' => ['description' => '分析完成的时间,格式为 Unix 时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1717469347000'],
'Level' => ['description' => '过期时间级别。取值:'."\n"
."\n"
.'- **0**:不过期。'."\n"
.'- **1**:已过期。'."\n"
.'- **2**:过期0~1小时。'."\n"
.'- **3**:过期1~3小时。'."\n"
.'- **4**:过期3~12小时。'."\n"
.'- **5**:过期12~24小时。'."\n"
.'- **6**:过期1~2天。'."\n"
.'- **7**:过期3~7天。'."\n"
.'- **8**:过期超过7天。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'TotalBytes' => ['description' => '按过期时间分类统计的Key占用的字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '8064'],
'TotalKeys' => ['description' => '按过期时间分类统计的Key总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '62'],
],
],
],
],
'description' => '',
],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询缓存分析任务详情',
'summary' => '调用DescribeCacheAnalysisJob接口,查询缓存分析任务详情。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口只适用于Redis引擎。'."\n"
."\n"
.'> 调用本接口可查询实例缓存分析任务中排名前500的Key信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisJob'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCacheAnalysisJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"TaskState\\": \\"BACKUP\\",\\n \\"JobId\\": \\"sf79-sd99-sa37-****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"BigKeys\\": {\\n \\"KeyInfo\\": [\\n {\\n \\"Type\\": \\"hash\\",\\n \\"Db\\": 0,\\n \\"ExpirationTimeMillis\\": 1596256542547,\\n \\"Key\\": \\"task_x****\\",\\n \\"Encoding\\": \\"hashtable\\",\\n \\"Bytes\\": 12345,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"KeyPrefixes\\": {\\n \\"Prefix\\": [\\n {\\n \\"KeyNum\\": 123,\\n \\"Type\\": \\"hash\\",\\n \\"Bytes\\": 12345,\\n \\"Prefix\\": \\"task_\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"BigKeysOfNum\\": {\\n \\"KeyInfo\\": [\\n {\\n \\"Type\\": \\"hash\\",\\n \\"Db\\": 0,\\n \\"ExpirationTimeMillis\\": 1596256542547,\\n \\"Key\\": \\"task_x****\\",\\n \\"Encoding\\": \\"hashtable\\",\\n \\"Bytes\\": 12345,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"UnexBigKeysOfBytes\\": {\\n \\"KeyInfo\\": [\\n {\\n \\"Type\\": \\"hash\\",\\n \\"Db\\": 0,\\n \\"ExpirationTimeMillis\\": 1596256542547,\\n \\"Key\\": \\"task_x****\\",\\n \\"Encoding\\": \\"hashtable\\",\\n \\"Bytes\\": 12345,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"UnexBigKeysOfNum\\": {\\n \\"KeyInfo\\": [\\n {\\n \\"Type\\": \\"hash\\",\\n \\"Db\\": 0,\\n \\"ExpirationTimeMillis\\": 1596256542547,\\n \\"Key\\": \\"task_x****\\",\\n \\"Encoding\\": \\"hashtable\\",\\n \\"Bytes\\": 12345,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"r-bp18ff4a195d****\\",\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"ExpiryKeysLevelCount\\": {\\n \\"ExpiryLevel\\": [\\n {\\n \\"AnalysisTs\\": 1717469347000,\\n \\"Level\\": 0,\\n \\"TotalBytes\\": 8064,\\n \\"TotalKeys\\": 62\\n }\\n ]\\n }\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCacheAnalysisJobResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <TaskState>BACKUP</TaskState>\\n <JobId>sf79-sd99-sa37-****</JobId>\\n <Message>Successful</Message>\\n <BigKeys>\\n <Type>hash</Type>\\n <Db>0</Db>\\n <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>\\n <Key>task_x****</Key>\\n <Encoding>hashtable</Encoding>\\n <Bytes>12345</Bytes>\\n <NodeId>r-x****-db-0</NodeId>\\n <Count>127</Count>\\n </BigKeys>\\n <KeyPrefixes>\\n <KeyNum>123</KeyNum>\\n <Type>hash</Type>\\n <Bytes>12345</Bytes>\\n <Prefix>task_</Prefix>\\n <Count>127</Count>\\n </KeyPrefixes>\\n <BigKeysOfNum>\\n <Type>hash</Type>\\n <Db>0</Db>\\n <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>\\n <Key>task_x****</Key>\\n <Encoding>hashtable</Encoding>\\n <Bytes>12345</Bytes>\\n <NodeId>r-x****-db-0</NodeId>\\n <Count>127</Count>\\n </BigKeysOfNum>\\n <UnexBigKeysOfBytes>\\n <Type>hash</Type>\\n <Db>0</Db>\\n <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>\\n <Key>task_x****</Key>\\n <Encoding>hashtable</Encoding>\\n <Bytes>12345</Bytes>\\n <NodeId>r-x****-db-0</NodeId>\\n <Count>127</Count>\\n </UnexBigKeysOfBytes>\\n <UnexBigKeysOfNum>\\n <Type>hash</Type>\\n <Db>0</Db>\\n <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>\\n <Key>task_x****</Key>\\n <Encoding>hashtable</Encoding>\\n <Bytes>12345</Bytes>\\n <NodeId>r-x****-db-0</NodeId>\\n <Count>127</Count>\\n </UnexBigKeysOfNum>\\n <InstanceId>r-bp18ff4a195d****</InstanceId>\\n <NodeId>r-x****-db-0</NodeId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeCacheAnalysisJobResponse>","errorExample":""}]',
],
'DescribeCacheAnalysisJobs' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>查询任务结束时间需晚于查询任务开始时间。', 'type' => 'string', 'required' => true, 'example' => '1596177993001'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'description' => '信息列表。',
'type' => 'object',
'properties' => [
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'CacheAnalysisJob' => [
'description' => '信息详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TaskState' => ['description' => '缓存分析任务的状态:'."\n"
."\n"
.'- **BACKUP**:备份中。'."\n"
.'- **ANALYZING**:分析中。'."\n"
.'- **FINISHED**:分析完成。'."\n"
.'- **FAILED**:出现错误。', 'type' => 'string', 'example' => 'BACKUP'],
'JobId' => ['description' => '缓存分析任务ID。', 'type' => 'string', 'example' => 'sf79-sd99-sa37-****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'BigKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyInfo' => [
'description' => '大Key详细信息。'."\n"
."\n"
.'>当前已不再返回该参数的子参数及其内容,请调用[DescribeCacheAnalysisJob](~~180983~~)接口查询缓存分析任务的详细信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'Redis数据结构类型。', 'type' => 'string', 'example' => 'hash'],
'Db' => ['description' => '数据库名称。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'ExpirationTimeMillis' => ['description' => 'Key过期时间,单位:毫秒(ms),0表示不过期。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596256542547'],
'Key' => ['description' => 'Key的名称。', 'type' => 'string', 'example' => 'task_*****'],
'Encoding' => ['description' => 'Key内部数据类型。', 'type' => 'string', 'example' => 'hashtable'],
'Bytes' => ['description' => 'Key占用字节数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-****-db-0'],
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '127'],
],
'description' => '',
],
],
],
'description' => '',
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'r-bp18ff4a195d****'],
'NodeId' => ['description' => '实例的数据节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
],
'description' => '',
],
],
],
'description' => '',
],
'PageNo' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Total' => ['description' => '结果数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询缓存分析任务列表',
'summary' => '调用DescribeCacheAnalysisJobs接口,查询缓存分析任务列表。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口只适用于Redis引擎。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisJobs'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCacheAnalysisJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"List\\": {\\n \\"CacheAnalysisJob\\": [\\n {\\n \\"TaskState\\": \\"BACKUP\\",\\n \\"JobId\\": \\"sf79-sd99-sa37-****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"BigKeys\\": {\\n \\"KeyInfo\\": [\\n {\\n \\"Type\\": \\"hash\\",\\n \\"Db\\": 0,\\n \\"ExpirationTimeMillis\\": 1596256542547,\\n \\"Key\\": \\"task_*****\\",\\n \\"Encoding\\": \\"hashtable\\",\\n \\"Bytes\\": 12345,\\n \\"NodeId\\": \\"r-****-db-0\\",\\n \\"Count\\": 127\\n }\\n ]\\n },\\n \\"InstanceId\\": \\"r-bp18ff4a195d****\\",\\n \\"NodeId\\": \\"r-x****-db-0\\"\\n }\\n ]\\n },\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Extra\\": \\"None\\",\\n \\"Total\\": 4\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeCacheAnalysisJobsResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <List>\\n <TaskState>BACKUP</TaskState>\\n <JobId>sf79-sd99-sa37-****</JobId>\\n <Message>Successful</Message>\\n <BigKeys>\\n <Type>hash</Type>\\n <Db>0</Db>\\n <ExpirationTimeMillis>1596256542547</ExpirationTimeMillis>\\n <Key>task_*****</Key>\\n <Encoding>hashtable</Encoding>\\n <Bytes>12345</Bytes>\\n <NodeId>r-****-db-0</NodeId>\\n <Count>127</Count>\\n </BigKeys>\\n <InstanceId>r-bp18ff4a195d****</InstanceId>\\n <NodeId>r-x****-db-0</NodeId>\\n </List>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Extra>None</Extra>\\n <Total>4</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeCacheAnalysisJobsResponse>","errorExample":""}]',
],
'DescribeCloudBenchTasks' => [
'summary' => '调用DescribeCloudBenchTasks接口,查询压测任务列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '29456',
'abilityTreeNodes' => ['FEATUREhdmB8MM4L'],
],
'parameters' => [
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '任务的运行状态。取值:'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
.'- **IGNORED**:忽略。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **EXCEPTION**:异常。', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => '压测任务类型。取值:'."\n"
.'- **pressure test**(默认):智能压测,将从源实例上捕获的流量,按照目标实例规格支持的极限速度,在目标实例上进行回放。'."\n"
.'- **smart pressure test**:生成压测,通过分析和学习短时间内在源实例上捕获的流量,生成和原始流量的业务模型和流量分布基本一致的流量进行持续压测,减少从源实例采集数据的时间,降低存储成本和性能开销。', 'type' => 'string', 'required' => false, 'example' => 'pressure test'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => false, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>查询任务结束时间需晚于查询任务开始时间。', 'type' => 'string', 'required' => false, 'example' => '1596177993001'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页最大记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Extra' => ['description' => ' 备用参数。', 'type' => 'string', 'example' => 'None'],
'Total' => ['description' => '结果的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'cloudbenchTasks' => [
'description' => '压测任务的详细信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DtsJobName' => ['description' => 'DTS的任务名称。', 'type' => 'string', 'example' => 'RDS间迁移'],
'ErrorMessage' => ['description' => '任务失败的错误提示。', 'type' => 'string', 'example' => 'DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\n\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].'],
'External' => ['description' => '其他信息。', 'type' => 'string', 'example' => 'Null'],
'BackupType' => ['description' => '备份类型。取值:'."\n"
."\n"
.'- **TIMESTAMP**:按备份时间。'."\n"
.'- **BACKUPID**:按备份集ID。', 'type' => 'string', 'example' => 'TIMESTAMP'],
'UserId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1091411816252****'],
'DstType' => ['description' => '目标实例的类型。取值:'."\n"
.'- **Instance**(默认):实例ID。'."\n"
.'- **ConnectionString**:实例的连接地址。', 'type' => 'string', 'example' => 'Instance'],
'EcsInstanceId' => ['description' => 'ECS的实例ID。', 'type' => 'string', 'example' => 'i-bp1ecr5go2go1****'],
'DstInstanceUuid' => ['description' => '目标实例的唯一标识符号。', 'type' => 'string', 'example' => 'hdm_d887b5ccf99fa0dc9a1e5aaac368****'],
'TaskType' => ['description' => '压测任务类型。取值:'."\n"
.'- **pressure test**(默认):智能压测,将从源实例上捕获的流量,按照目标实例规格支持的极限速度,在目标实例上进行回放。'."\n"
.'- **smart pressure test**:生成压测,通过分析和学习短时间内在源实例上捕获的流量,生成和原始流量的业务模型和流量分布基本一致的流量进行持续压测,减少从源实例采集数据的时间,降低存储成本和性能开销。', 'type' => 'string', 'example' => 'pressure test'],
'BenchStep' => ['description' => '压测的子步骤。取值:'."\n"
."\n"
.'- **NEW**:任务初始化。'."\n"
.'- **WAIT_BUY_ECS**:新购ECS实例。'."\n"
.'- **WAIT_START_ECS**:ECS实例启动。'."\n"
.'- **WAIT_INSTALL_JDK**:安装JDK。'."\n"
.'- **WAIT_INSTALL_DBGATEWAY**:安装DBGateway。'."\n"
.'- **ADD_SECURITY_IPS_STEP**:配置安全组白名单。'."\n"
.'- **ARCHIVE**:全量SQL归档。'."\n"
.'- **DOWNLOAD**:下载全量SQL文件。'."\n"
.'- **PROCEED**:预处理全量SQL文件。'."\n"
.'- **PRE_LOAD**:预加载全量SQL文件。'."\n"
.'- **VALIDATE**:功能验证。'."\n"
.'- **PRESSURE**:性能压测。', 'type' => 'string', 'example' => 'PROCEED'],
'Version' => ['description' => '压测任务版本。取值:'."\n"
."\n"
.'- **V2.0**。'."\n"
.'- **V3.0**。', 'type' => 'string', 'example' => 'V3.0'],
'EndState' => ['description' => '压测任务结束后的状态。取值:'."\n"
."\n"
.'- **WAIT_TARGET**:准备压测的目标实例。'."\n"
.'- **WAIT_DBGATEWAY**:准备压测部署。'."\n"
.'- **WAIT_SQL**:准备全量SQL。'."\n"
.'- **WAIT_LOGIC**:准备开始回放流量。'."\n"
."\n"
.'>当压测任务执行完EndState设置的状态之后,任务将直接到达完成状态。', 'type' => 'string', 'example' => 'WAIT_TARGET'],
'SrcInstanceUuid' => ['description' => '源实例的唯一标识符号。', 'type' => 'string', 'example' => 'hdm_3063db6792965c080a4bcb6e6304****'],
'ClientType' => ['description' => '压测机器类型。取值:'."\n"
."\n"
.'- **ECS**:您需要自己准备[数据库网关](~~64905~~)。'."\n"
.'- **DAS_ECS**:DAS自动购买和部署的ECS。', 'type' => 'string', 'example' => 'ECS'],
'State' => ['description' => '目前压测任务的状态。取值:'."\n"
."\n"
.'- **WAIT_TARGET**:准备压测的目标实例。'."\n"
.'- **WAIT_DBGATEWAY**:准备压测部署。'."\n"
.'- **WAIT_SQL**:准备全量SQL。'."\n"
.'- **WAIT_LOGIC**:准备开始回放流量。', 'type' => 'string', 'example' => 'WAIT_TARGET'],
'DstIp' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'SrcPublicIp' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'BackupId' => ['description' => '备份集ID,可通过查询备份列表接口[DescribeBackups](~~26273~~)获取。', 'type' => 'string', 'example' => '229132'],
'SqlCompleteReuse' => ['description' => '全量SQL的复用信息。', 'type' => 'string', 'example' => '{"sqlUuid":"task_a37d2f07-45cb-4413-a2a6-c66c68****","metaUuid":"task_211e2561-5c0c-486b-864c-56b511****","sqlFile":"cl-1620057600000-1800626.sc","metaFile":"cl-1620057600000-1800626.meta"}'],
'SmartPressureTime' => ['description' => '生成压测的时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400000'],
'ArchiveState' => ['description' => 'SQL归档状态,取值:'."\n"
."\n"
.'- **0**:未开始。'."\n"
.'- **1**:完成。'."\n"
.'- **2**:错误。'."\n"
.'- **3**:运行中。'."\n"
.'- **4**:无需下载。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Status' => ['description' => '压测任务的运行状态。取值:'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
.'- **IGNORED**:忽略。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **EXCEPTION**:异常。', 'type' => 'string', 'example' => 'RUNNING'],
'WorkDir' => ['description' => '压测生成的临时目录。', 'type' => 'string', 'example' => '/tmp/bench/'],
'ArchiveOssTableName' => ['description' => '归档至OSS的表名。', 'type' => 'string', 'example' => 'custins15546355_161604665****'],
'DtsJobId' => ['description' => 'DTS迁移的任务ID。', 'type' => 'string', 'example' => 'i03e3zty16i****'],
'DtsJobState' => ['description' => 'DTS任务状态,取值:'."\n"
."\n"
.'- **NOT_STARTED**:未启动。'."\n"
.'- **PRE_CHECKING**:预检查中。'."\n"
.'- **PRE_CHECK_FAILED**:预检查失败。'."\n"
.'- **CHECKING**:检查中。'."\n"
.'- **MIGRATING**:迁移中。'."\n"
.'- **CATCHED**:已经追平。'."\n"
.'- **SUSPENDING**:暂停中。'."\n"
.'- **MIGRATION_FAILED**:迁移失败。'."\n"
.'- **FINISHED**:完成。'."\n"
.'- **INITIALIZING**:同步初始化。'."\n"
.'- **INITIALIZE_FAILED**:同步初始化失败。'."\n"
.'- **SYNCHRONIZING**:同步中。'."\n"
.'- **MODIFYING**:同步对象变更中。'."\n"
.'- **SWITCHING**:切换中。'."\n"
.'- **FAILED**:失败。'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => 'CHECKING'],
'DstPort' => ['description' => '目标实例的端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'],
'DtsJobClass' => ['description' => 'DTS链路规格。'."\n"
.'>关于各链路规格的说明及性能测试情况请参见[数据迁移链路规格说明](~~26606~~)。', 'type' => 'string', 'example' => 'medium'],
'ClientGatewayId' => ['description' => '压测机的数据库网关ID。', 'type' => 'string', 'example' => '58598b2af48a0193dfc16fc6964ef****'],
'Description' => ['description' => '压测任务描述。', 'type' => 'string', 'example' => 'test-das-bench-0501'],
'ErrorCode' => ['description' => '压测内部任务返回的错误码。', 'type' => 'string', 'example' => '10109'],
'TableSchema' => ['description' => '压测中涉及的表名。', 'type' => 'string', 'example' => '[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]'],
'DtsJobStatus' => ['description' => 'DTS任务状态,取值:'."\n"
."\n"
.'- **NOT_STARTED**:未启动。'."\n"
.'- **PRE_CHECKING**:预检查中。'."\n"
.'- **PRE_CHECK_FAILED**:预检查失败。'."\n"
.'- **CHECKING**:检查中。'."\n"
.'- **MIGRATING**:迁移中。'."\n"
.'- **CATCHED**:已经追平。'."\n"
.'- **SUSPENDING**:暂停中。'."\n"
.'- **MIGRATION_FAILED**:迁移失败。'."\n"
.'- **FINISHED**:完成。'."\n"
.'- **INITIALIZING**:同步初始化。'."\n"
.'- **INITIALIZE_FAILED**:同步初始化失败。'."\n"
.'- **SYNCHRONIZING**:同步中。'."\n"
.'- **MODIFYING**:同步对象变更中。'."\n"
.'- **SWITCHING**:切换中。'."\n"
.'- **FAILED**:失败。'."\n", 'type' => 'string', 'example' => 'PRE_CHECK_FAILED'],
'SrcInstanceArea' => ['description' => '源实例的数据库类型。', 'type' => 'string', 'example' => 'RDS'],
'BenchStepStatus' => ['description' => '压测子步骤状态。取值:'."\n"
."\n"
.'- **NEW**:任务初始化。'."\n"
.'- **RUNNING**:正在执行。'."\n"
.'- **FAILED**:失败。'."\n"
.'- **FINISHED**:完成。'."\n"
.'- **Terminated**:已终止。'."\n"
.'- **Deleted**:已删除。'."\n", 'type' => 'string', 'example' => 'FINISHED'],
'Source' => ['description' => '任务来源。取值:'."\n"
."\n"
.'- **DAS**。'."\n"
.'- **OPEN_API**。', 'type' => 'string', 'example' => 'DAS'],
'ArchiveJobId' => ['description' => '归档任务ID。', 'type' => 'string', 'example' => '\'202105211430070112231480820340758****'],
'Topic' => ['description' => 'kafka的消费Topic。', 'type' => 'string', 'example' => 'das'],
'RequestDuration' => ['description' => '压测任务持续时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '86400000'],
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
'Rate' => ['description' => '源实例流量在目标实例上的回放速度,回放速度必须是正整数,取值:**0**~**30**,默认为**1**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Extra\\": \\"None\\",\\n \\"Total\\": 2,\\n \\"List\\": {\\n \\"cloudbenchTasks\\": [\\n {\\n \\"DtsJobName\\": \\"RDS间迁移\\",\\n \\"ErrorMessage\\": \\"DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\\\\\\\n\\\\\\\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].\\",\\n \\"External\\": \\"Null\\",\\n \\"BackupType\\": \\"TIMESTAMP\\",\\n \\"UserId\\": \\"1091411816252****\\",\\n \\"DstType\\": \\"Instance\\",\\n \\"EcsInstanceId\\": \\"i-bp1ecr5go2go1****\\",\\n \\"DstInstanceUuid\\": \\"hdm_d887b5ccf99fa0dc9a1e5aaac368****\\",\\n \\"TaskType\\": \\"pressure test\\",\\n \\"BenchStep\\": \\"PROCEED\\",\\n \\"Version\\": \\"V3.0\\",\\n \\"EndState\\": \\"WAIT_TARGET\\",\\n \\"SrcInstanceUuid\\": \\"hdm_3063db6792965c080a4bcb6e6304****\\",\\n \\"ClientType\\": \\"ECS\\",\\n \\"State\\": \\"WAIT_TARGET\\",\\n \\"DstIp\\": \\"None\\",\\n \\"SrcPublicIp\\": \\"None\\",\\n \\"BackupId\\": \\"229132\\",\\n \\"SqlCompleteReuse\\": \\"{\\\\\\"sqlUuid\\\\\\":\\\\\\"task_a37d2f07-45cb-4413-a2a6-c66c68****\\\\\\",\\\\\\"metaUuid\\\\\\":\\\\\\"task_211e2561-5c0c-486b-864c-56b511****\\\\\\",\\\\\\"sqlFile\\\\\\":\\\\\\"cl-1620057600000-1800626.sc\\\\\\",\\\\\\"metaFile\\\\\\":\\\\\\"cl-1620057600000-1800626.meta\\\\\\"}\\",\\n \\"SmartPressureTime\\": 86400000,\\n \\"ArchiveState\\": 1,\\n \\"Status\\": \\"RUNNING\\",\\n \\"WorkDir\\": \\"/tmp/bench/\\",\\n \\"ArchiveOssTableName\\": \\"custins15546355_161604665****\\",\\n \\"DtsJobId\\": \\"i03e3zty16i****\\",\\n \\"DtsJobState\\": 0,\\n \\"DstPort\\": 3306,\\n \\"DtsJobClass\\": \\"medium\\",\\n \\"ClientGatewayId\\": \\"58598b2af48a0193dfc16fc6964ef****\\",\\n \\"Description\\": \\"test-das-bench-0501\\",\\n \\"ErrorCode\\": \\"10109\\",\\n \\"TableSchema\\": \\"[{\\\\\\"TABLE_NAME\\\\\\":\\\\\\"customer1\\\\\\",\\\\\\"TABLE_SCHEMA\\\\\\":\\\\\\"tpcc\\\\\\"}]\\",\\n \\"DtsJobStatus\\": \\"PRE_CHECK_FAILED\\",\\n \\"SrcInstanceArea\\": \\"RDS\\",\\n \\"BenchStepStatus\\": \\"FINISHED\\",\\n \\"Source\\": \\"DAS\\",\\n \\"ArchiveJobId\\": \\"\'202105211430070112231480820340758****\\",\\n \\"Topic\\": \\"das\\",\\n \\"RequestDuration\\": 86400000,\\n \\"TaskId\\": \\"e5cec704-0518-430f-8263-76f4dcds****\\",\\n \\"Rate\\": 1\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCloudBenchTasksResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Extra>None</Extra>\\n <Total>2</Total>\\n <List>\\n <DtsJobName>RDS间迁移</DtsJobName>\\n <ErrorMessage>DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\\\n\\\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].</ErrorMessage>\\n <External>Null</External>\\n <BackupType>TIMESTAMP</BackupType>\\n <UserId>1091411816252****</UserId>\\n <DstType>Instance</DstType>\\n <EcsInstanceId>i-bp1ecr5go2go1****</EcsInstanceId>\\n <DstInstanceUuid>hdm_d887b5ccf99fa0dc9a1e5aaac368****</DstInstanceUuid>\\n <TaskType>pressure test</TaskType>\\n <BenchStep>PROCEED</BenchStep>\\n <Version>V3.0</Version>\\n <EndState>WAIT_TARGET</EndState>\\n <SrcInstanceUuid>hdm_3063db6792965c080a4bcb6e6304****</SrcInstanceUuid>\\n <ClientType>ECS</ClientType>\\n <State>WAIT_TARGET</State>\\n <DstIp>None</DstIp>\\n <SrcPublicIp>None</SrcPublicIp>\\n <BackupId>229132</BackupId>\\n <SqlCompleteReuse>{\\"sqlUuid\\":\\"task_a37d2f07-45cb-4413-a2a6-c66c68****\\",\\"metaUuid\\":\\"task_211e2561-5c0c-486b-864c-56b511****\\",\\"sqlFile\\":\\"cl-1620057600000-1800626.sc\\",\\"metaFile\\":\\"cl-1620057600000-1800626.meta\\"}</SqlCompleteReuse>\\n <SmartPressureTime>86400000</SmartPressureTime>\\n <ArchiveState>1</ArchiveState>\\n <Status>RUNNING</Status>\\n <WorkDir>/tmp/bench/</WorkDir>\\n <ArchiveOssTableName>custins15546355_161604665****</ArchiveOssTableName>\\n <DtsJobId>i03e3zty16i****</DtsJobId>\\n <DstPort>3306</DstPort>\\n <DtsJobClass>medium</DtsJobClass>\\n <ClientGatewayId>58598b2af48a0193dfc16fc6964ef****</ClientGatewayId>\\n <Description>test-das-bench-0501</Description>\\n <ErrorCode>10109</ErrorCode>\\n <TableSchema>[{\\"TABLE_NAME\\":\\"customer1\\",\\"TABLE_SCHEMA\\":\\"tpcc\\"}]</TableSchema>\\n <DtsJobStatus>PRE_CHECK_FAILED</DtsJobStatus>\\n <SrcInstanceArea>RDS</SrcInstanceArea>\\n <BenchStepStatus>FINISHED</BenchStepStatus>\\n <Source>DAS</Source>\\n <ArchiveJobId>\'202105211430070112231480820340758****</ArchiveJobId>\\n <Topic>das</Topic>\\n <RequestDuration>86400000</RequestDuration>\\n <TaskId>e5cec704-0518-430f-8263-76f4dcds****</TaskId>\\n <Rate>1</Rate>\\n </List>\\n </Data>\\n</DescribeCloudBenchTasksResponse>","errorExample":""}]',
'title' => '查询压测任务列表',
'description' => '数据库自治服务DAS提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见[智能压测](~~155068~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudBenchTasks'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCloudBenchTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeCloudbenchTask' => [
'summary' => '调用DescribeCloudbenchTask接口,查询压测任务。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID,您可通过[DescribeCloudBenchTasks](~~230670~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'DtsJobName' => ['description' => 'DTS的任务名称。', 'type' => 'string', 'example' => 'Migration between RDS instances'],
'ErrorMessage' => ['description' => '任务失败的错误提示。', 'type' => 'string', 'example' => 'DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\n\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].'],
'External' => ['description' => '其他信息。', 'type' => 'string', 'example' => 'Null'],
'BackupType' => ['description' => '备份类型。取值:'."\n"
."\n"
.'- **TIMESTAMP**:按备份时间。'."\n"
.'- **BACKUPID**:按备份集ID。', 'type' => 'string', 'example' => 'TIMESTAMP'],
'UserId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '109141182625****'],
'DstType' => ['description' => '目标实例的类型。取值:'."\n"
.'- **Instance**(默认):实例ID。'."\n"
.'- **ConnectionString**:实例的连接地址。', 'type' => 'string', 'example' => 'Instance'],
'EcsInstanceId' => ['description' => 'ECS的实例ID。', 'type' => 'string', 'example' => 'i-bp1ecr5go2go1****'],
'DstInstanceUuid' => ['description' => '目标实例的唯一标识符号。', 'type' => 'string', 'example' => 'hdm_d887b5ccf99fa0dc9a1e5aaac368****'],
'TaskType' => ['description' => '压测任务类型。取值:'."\n"
.'- **pressure test**(默认):智能压测,将从源实例上捕获的流量,按照目标实例规格支持的极限速度,在目标实例上进行回放。'."\n"
.'- **smart pressure test**:生成压测,通过分析和学习短时间内在源实例上捕获的流量,生成和原始流量的业务模型和流量分布基本一致的流量进行持续压测,减少从源实例采集数据的时间,降低存储成本和性能开销。', 'type' => 'string', 'example' => 'pressure test'],
'BenchStep' => ['description' => '压测的子步骤。取值:'."\n"
."\n"
.'- **NEW**:任务初始化。'."\n"
.'- **WAIT_BUY_ECS**:新购ECS实例。'."\n"
.'- **WAIT_START_ECS**:ECS实例启动。'."\n"
.'- **WAIT_INSTALL_JDK**:安装JDK。'."\n"
.'- **WAIT_INSTALL_DBGATEWAY**:安装DBGateway。'."\n"
.'- **ADD_SECURITY_IPS_STEP**:配置安全组白名单。'."\n"
.'- **ARCHIVE**:全量SQL归档。'."\n"
.'- **DOWNLOAD**:下载全量SQL文件。'."\n"
.'- **PROCEED**:预处理全量SQL文件。'."\n"
.'- **PRE_LOAD**:预加载全量SQL文件。'."\n"
.'- **VALIDATE**:功能验证。'."\n"
.'- **PRESSURE**:性能压测。', 'type' => 'string', 'example' => 'PROCEED'],
'Version' => ['description' => '压测任务版本。取值:'."\n"
."\n"
.'- **V2.0**'."\n"
.'- **V3.0**', 'type' => 'string', 'example' => 'V3.0'],
'EndState' => ['description' => '压测任务结束后的状态。取值:'."\n"
."\n"
.'- **WAIT_TARGET**:准备压测的目标实例。'."\n"
.'- **WAIT_DBGATEWAY**:准备压测部署。'."\n"
.'- **WAIT_SQL**:准备全量SQL。'."\n"
.'- **WAIT_LOGIC**:准备开始回放流量。'."\n"
."\n"
.'>当压测任务执行完EndState设置的状态之后,任务将直接到达完成状态。', 'type' => 'string', 'example' => 'WAIT_LOGIC'],
'SrcInstanceUuid' => ['description' => '源实例的唯一标识符号。', 'type' => 'string', 'example' => 'a364e414-e68b-4e5c-9166-65b3a153****'],
'ClientType' => ['description' => '压测机器类型。取值:'."\n"
."\n"
.'- **ECS**:您需要自己准备[数据库网关](~~64905~~)。'."\n"
.'- **DAS_ECS**:DAS自动购买和部署的ECS。', 'type' => 'string', 'example' => 'ECS'],
'State' => ['description' => '目前压测任务的状态。取值:'."\n"
."\n"
.'- **WAIT_TARGET**:准备压测的目标实例。'."\n"
.'- **WAIT_DBGATEWAY**:准备压测部署。'."\n"
.'- **WAIT_SQL**:准备全量SQL。'."\n"
.'- **WAIT_LOGIC**:准备开始回放流量。', 'type' => 'string', 'example' => 'WAIT_TARGET'],
'DstIp' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'SrcPublicIp' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'BackupId' => ['description' => '备份集ID,可通过查询备份列表接口[DescribeBackups](~~26273~~)获取。', 'type' => 'string', 'example' => '229132'],
'SqlCompleteReuse' => ['description' => '全量SQL的复用信息。', 'type' => 'string', 'example' => '{"sqlUuid":"task_a37d2f07-45cb-****-a2a6-c66c62****","metaUuid":"task_211e2561-5c0c-486b-864c-56b511****","sqlFile":"cl-1620057600000-1800626.sc","metaFile":"cl-1620057600000-180****.meta"}'],
'SmartPressureTime' => ['description' => '生成压测时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int32', 'example' => '86400000'],
'ArchiveState' => ['description' => 'SQL归档状态,取值:'."\n"
."\n"
.'- **0**:未开始。'."\n"
.'- **1**:完成。'."\n"
.'- **2**:错误。'."\n"
.'- **3**:运行中。'."\n"
.'- **4**:无需下载。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Status' => ['description' => '压测任务的运行状态。取值:'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
.'- **IGNORED**:忽略。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **EXCEPTION**:异常。', 'type' => 'string', 'example' => 'RUNNING'],
'WorkDir' => ['description' => '压测生成的临时目录。', 'type' => 'string', 'example' => '/tmp/bench/'],
'ArchiveOssTableName' => ['description' => '归档的OSS表名。', 'type' => 'string', 'example' => 'custins15546355_161604665****'],
'DtsJobId' => ['description' => 'DTS迁移任务ID。', 'type' => 'string', 'example' => 'i03e3zty16i****'],
'DtsJobState' => ['description' => 'DTS任务状态,取值:'."\n"
."\n"
.'- **NOT_STARTED**:未启动。'."\n"
.'- **PRE_CHECKING**:预检查中。'."\n"
.'- **PRE_CHECK_FAILED**:预检查失败。'."\n"
.'- **CHECKING**:检查中。'."\n"
.'- **MIGRATING**:迁移中。'."\n"
.'- **CATCHED**:已经追平。'."\n"
.'- **SUSPENDING**:暂停中。'."\n"
.'- **MIGRATION_FAILED**:迁移失败。'."\n"
.'- **FINISHED**:完成。'."\n"
.'- **INITIALIZING**:同步初始化。'."\n"
.'- **INITIALIZE_FAILED**:同步初始化失败。'."\n"
.'- **SYNCHRONIZING**:同步中。'."\n"
.'- **MODIFYING**:同步对象变更中。'."\n"
.'- **SWITCHING**:切换中。'."\n"
.'- **FAILED**:失败。', 'type' => 'integer', 'format' => 'int32', 'example' => 'CHECKING'],
'DstPort' => ['description' => '目标实例的端口。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'],
'DtsJobClass' => ['description' => 'DTS任务规格。', 'type' => 'string', 'example' => 'medium'],
'ClientGatewayId' => ['description' => '压测机的数据库网关ID。', 'type' => 'string', 'example' => '58598b2af48a0193dfc16fc6964ef****'],
'Description' => ['description' => '压测任务描述。', 'type' => 'string', 'example' => 'test-das-bench-0501'],
'ErrorCode' => ['description' => '压测内部任务返回的错误码。', 'type' => 'string', 'example' => '10910'],
'TableSchema' => ['description' => '压测中涉及的表名。', 'type' => 'string', 'example' => '[{"TABLE_NAME":"customer1","TABLE_SCHEMA":"tpcc"}]'],
'DtsJobStatus' => ['description' => 'DTS任务状态,取值:'."\n"
."\n"
.'- **NOT_STARTED**:未启动。'."\n"
.'- **PRE_CHECKING**:预检查中。'."\n"
.'- **PRE_CHECK_FAILED**:预检查失败。'."\n"
.'- **CHECKING**:检查中。'."\n"
.'- **MIGRATING**:迁移中。'."\n"
.'- **CATCHED**:已经追平。'."\n"
.'- **SUSPENDING**:暂停中。'."\n"
.'- **MIGRATION_FAILED**:迁移失败。'."\n"
.'- **FINISHED**:完成。'."\n"
.'- **INITIALIZING**:同步初始化。'."\n"
.'- **INITIALIZE_FAILED**:同步初始化失败。'."\n"
.'- **SYNCHRONIZING**:同步中。'."\n"
.'- **MODIFYING**:同步对象变更中。'."\n"
.'- **SWITCHING**:切换中。'."\n"
.'- **FAILED**:失败。'."\n", 'type' => 'string', 'example' => 'PRE_CHECKING'],
'SrcInstanceArea' => ['description' => '源实例的数据库类型。', 'type' => 'string', 'example' => 'RDS'],
'BenchStepStatus' => ['description' => '压测子步骤状态。取值:'."\n"
."\n"
.'- **NEW**:任务初始化。'."\n"
.'- **RUNNING**:正在执行。'."\n"
.'- **FAILED**:失败。'."\n"
.'- **FINISHED**:已完成。'."\n"
.'- **Terminated**:已终止。'."\n"
.'- **Deleted**:已删除。'."\n"
."\n", 'type' => 'string', 'example' => 'FINISHED'],
'Source' => ['description' => '任务来源。取值:'."\n"
."\n"
.'- **DAS**。'."\n"
.'- **OPEN_API**。', 'type' => 'string', 'example' => 'DAS'],
'ArchiveJobId' => ['description' => '归档任务ID。', 'type' => 'string', 'example' => '\'202105211430070112231480820340758****'],
'Topic' => ['description' => 'kafka的消费Topic。', 'type' => 'string', 'example' => 'das'],
'RequestDuration' => ['description' => '压测任务的持续时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '864000'],
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
'Rate' => ['description' => '压测倍率。回放倍率必须是正整数,取值范围为:**0**~**30**,默认为**1**。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"DtsJobName\\": \\"Migration between RDS instances\\",\\n \\"ErrorMessage\\": \\"DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\\\\\\\n\\\\\\\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].\\",\\n \\"External\\": \\"Null\\",\\n \\"BackupType\\": \\"TIMESTAMP\\",\\n \\"UserId\\": \\"109141182625****\\",\\n \\"DstType\\": \\"Instance\\",\\n \\"EcsInstanceId\\": \\"i-bp1ecr5go2go1****\\",\\n \\"DstInstanceUuid\\": \\"hdm_d887b5ccf99fa0dc9a1e5aaac368****\\",\\n \\"TaskType\\": \\"pressure test\\",\\n \\"BenchStep\\": \\"PROCEED\\",\\n \\"Version\\": \\"V3.0\\",\\n \\"EndState\\": \\"WAIT_LOGIC\\",\\n \\"SrcInstanceUuid\\": \\"a364e414-e68b-4e5c-9166-65b3a153****\\",\\n \\"ClientType\\": \\"ECS\\",\\n \\"State\\": \\"WAIT_TARGET\\",\\n \\"DstIp\\": \\"None\\",\\n \\"SrcPublicIp\\": \\"None\\",\\n \\"BackupId\\": \\"229132\\",\\n \\"SqlCompleteReuse\\": \\"{\\\\\\"sqlUuid\\\\\\":\\\\\\"task_a37d2f07-45cb-****-a2a6-c66c62****\\\\\\",\\\\\\"metaUuid\\\\\\":\\\\\\"task_211e2561-5c0c-486b-864c-56b511****\\\\\\",\\\\\\"sqlFile\\\\\\":\\\\\\"cl-1620057600000-1800626.sc\\\\\\",\\\\\\"metaFile\\\\\\":\\\\\\"cl-1620057600000-180****.meta\\\\\\"}\\",\\n \\"SmartPressureTime\\": 86400000,\\n \\"ArchiveState\\": 1,\\n \\"Status\\": \\"RUNNING\\",\\n \\"WorkDir\\": \\"/tmp/bench/\\",\\n \\"ArchiveOssTableName\\": \\"custins15546355_161604665****\\",\\n \\"DtsJobId\\": \\"i03e3zty16i****\\",\\n \\"DtsJobState\\": 0,\\n \\"DstPort\\": 3306,\\n \\"DtsJobClass\\": \\"medium\\",\\n \\"ClientGatewayId\\": \\"58598b2af48a0193dfc16fc6964ef****\\",\\n \\"Description\\": \\"test-das-bench-0501\\",\\n \\"ErrorCode\\": \\"10910\\",\\n \\"TableSchema\\": \\"[{\\\\\\"TABLE_NAME\\\\\\":\\\\\\"customer1\\\\\\",\\\\\\"TABLE_SCHEMA\\\\\\":\\\\\\"tpcc\\\\\\"}]\\",\\n \\"DtsJobStatus\\": \\"PRE_CHECKING\\",\\n \\"SrcInstanceArea\\": \\"RDS\\",\\n \\"BenchStepStatus\\": \\"FINISHED\\",\\n \\"Source\\": \\"DAS\\",\\n \\"ArchiveJobId\\": \\"\'202105211430070112231480820340758****\\",\\n \\"Topic\\": \\"das\\",\\n \\"RequestDuration\\": 864000,\\n \\"TaskId\\": \\"e5cec704-0518-430f-8263-76f4dcds****\\",\\n \\"Rate\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCloudbenchTaskResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <DtsJobName>RDS间迁移</DtsJobName>\\n <ErrorMessage>DTS-070211: Connect Source DB failed. cause by [com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException:Could not create connection to database server. Attempted reconnect 3 times. Giving up.][com.mysql.jdbc.exceptions.jdbc4.CommunicationsException:Communications link failure\\\\n\\\\nThe last packet sent successfully to the server was 0 milliseconds ago. The driver has not received any packets from the server.][java.net.ConnectException:Connection timed out (Connection timed out)] About more information in [https://yq.aliyun.com/articles/499178].</ErrorMessage>\\n <External>Null</External>\\n <BackupType>TIMESTAMP</BackupType>\\n <UserId>109141182625****</UserId>\\n <DstType>Instance</DstType>\\n <EcsInstanceId>i-bp1ecr5go2go1****</EcsInstanceId>\\n <DstInstanceUuid>hdm_d887b5ccf99fa0dc9a1e5aaac368****</DstInstanceUuid>\\n <TaskType>pressure test</TaskType>\\n <BenchStep>PROCEED</BenchStep>\\n <Version>V3.0</Version>\\n <EndState>WAIT_LOGIC</EndState>\\n <SrcInstanceUuid>a364e414-e68b-4e5c-9166-65b3a153****</SrcInstanceUuid>\\n <ClientType>ECS</ClientType>\\n <State>WAIT_TARGET</State>\\n <DstIp>None</DstIp>\\n <SrcPublicIp>None</SrcPublicIp>\\n <BackupId>229132</BackupId>\\n <SqlCompleteReuse>{\\"sqlUuid\\":\\"task_a37d2f07-45cb-****-a2a6-c66c62****\\",\\"metaUuid\\":\\"task_211e2561-5c0c-486b-864c-56b511****\\",\\"sqlFile\\":\\"cl-1620057600000-1800626.sc\\",\\"metaFile\\":\\"cl-1620057600000-180****.meta\\"}</SqlCompleteReuse>\\n <SmartPressureTime>86400000</SmartPressureTime>\\n <ArchiveState>1</ArchiveState>\\n <Status>RUNNING</Status>\\n <WorkDir>/tmp/bench/</WorkDir>\\n <ArchiveOssTableName>custins15546355_161604665****</ArchiveOssTableName>\\n <DtsJobId>i03e3zty16i****</DtsJobId>\\n <DstPort>3306</DstPort>\\n <DtsJobClass>medium</DtsJobClass>\\n <ClientGatewayId>58598b2af48a0193dfc16fc6964ef****</ClientGatewayId>\\n <Description>test-das-bench-0501</Description>\\n <ErrorCode>10910</ErrorCode>\\n <TableSchema>[{\\"TABLE_NAME\\":\\"customer1\\",\\"TABLE_SCHEMA\\":\\"tpcc\\"}]</TableSchema>\\n <DtsJobStatus>PRE_CHECKING</DtsJobStatus>\\n <SrcInstanceArea>RDS</SrcInstanceArea>\\n <BenchStepStatus>FINISHED</BenchStepStatus>\\n <Source>DAS</Source>\\n <ArchiveJobId>\'202105211430070112231480820340758****</ArchiveJobId>\\n <Topic>das</Topic>\\n <RequestDuration>864000</RequestDuration>\\n <TaskId>e5cec704-0518-430f-8263-76f4dcds****</TaskId>\\n <Rate>1</Rate>\\n </Data>\\n</DescribeCloudbenchTaskResponse>","errorExample":""}]',
'title' => '查询压测任务',
'description' => '数据库自治服务DAS提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见[智能压测](~~155068~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudbenchTask'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCloudbenchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeCloudbenchTaskConfig' => [
'summary' => '调用DescribeCloudbenchTaskConfig接口,查询压测任务配置信息。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID,您可通过[DescribeCloudBenchTasks](~~230670~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'WorkDir' => ['description' => '压测生成的临时目录。', 'type' => 'string', 'example' => '/tmp/bench/'],
'ArchiveFolder' => ['description' => '归档文件路径。', 'type' => 'string', 'example' => '/tmp/das/cloudbench/archive-sqls/'],
'MetaFilePath' => ['description' => '元文件路径。', 'type' => 'string', 'example' => '/tmp/das/cloudbench/cl-1621353601000-360****.meta'],
'MetaFileName' => ['description' => '元文件名。', 'type' => 'string', 'example' => 'cl-1621353601000-360****.meta'],
'MetaFileOnOss' => ['description' => '元文件在OSS的名称。', 'type' => 'string', 'example' => '"https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl****'],
'UserId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => '1091411816252****'],
'BenchCmd' => ['description' => '压测的命令。', 'type' => 'string', 'example' => 'java -jar /tmp/das/cloudbench/CloudBenchClient.jar --bench --rocksdb /tmp/das/cloudbench/rocksdb --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-a836-49e6-9f70-1c3822fc9239 --result_file /tmp/das/cloudbench/null.result --user cloudb**** --pwd \\"cloudbench@****\\" --host rm-bp1j5f8s5x26kq79216****.mysql.rds.aliyuncs.com --port 3306 --charset utf8mb4 --interval 1 --bench_time 3600 --rate_factor 1.0 --start_time 1621353601 --rt > /tmp/das/cloudbench/null.log'],
'SqlFileOnOss' => ['description' => '全量SQL文件在OSS的名称。', 'type' => 'string', 'example' => 'https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw****'],
'LoadCmd' => ['description' => 'SQL文件预加载的命令。', 'type' => 'string', 'example' => 'java -jar /tmp/das/cloudbench/CloudBenchClient.jar --load --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-****-49e6-9f70-1c3822fc**** --rocksdb /tmp/das/cloudbench/rocksdb'],
'RocksDbPath' => ['description' => 'RocksDB存储系统在压测机中的位置。', 'type' => 'string', 'example' => '/tmp/das/cloudbench/rocksdb'],
'ParseCmd' => ['description' => 'SQL文件解析的命令。', 'type' => 'string', 'example' => 'cd /tmp/das/cloudbench && java -jar CloudBenchClient.jar --parse --threads 32 --file /tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc9239.archiveSql --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --parent_patmp/das/cloudbench --source RDS --h /thost rm-bp1j5f8s5x266****.mysql.rds.aliyuncs.com --port 3306 --user cloudb**** --pwd \\"cloudbench@****\\" --cutSqlLen 8192 --db_black_list=information_schema,test,unknow,null'],
'SqlFileName' => ['description' => '全量SQL文件名。', 'type' => 'string', 'example' => 'cl-1621353601000-360****.sc'],
'ClientJarPath' => ['description' => '压测Jar包路径。', 'type' => 'string', 'example' => '/tmp/das/cloudbench/CloudBenchClient.jar'],
'SqlFilePath' => ['description' => 'SQL文件路径。', 'type' => 'string', 'example' => '/tmp/das/cloudbench/cl-1621353601000-360****.sc'],
'ParseFilePath' => ['description' => '解析后的SQL文件路径。', 'type' => 'string', 'example' => '/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql'],
'JarOnOss' => ['description' => '压测Jar包在OSS的路径。', 'type' => 'string', 'example' => 'https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****'],
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询压测任务配置',
'description' => '数据库自治服务DAS提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见[智能压测](~~155068~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudbenchTaskConfig'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCloudbenchTaskConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"WorkDir\\": \\"/tmp/bench/\\",\\n \\"ArchiveFolder\\": \\"/tmp/das/cloudbench/archive-sqls/\\",\\n \\"MetaFilePath\\": \\"/tmp/das/cloudbench/cl-1621353601000-360****.meta\\",\\n \\"MetaFileName\\": \\"cl-1621353601000-360****.meta\\",\\n \\"MetaFileOnOss\\": \\"\\\\\\"https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl****\\",\\n \\"UserId\\": \\"1091411816252****\\",\\n \\"BenchCmd\\": \\"java -jar /tmp/das/cloudbench/CloudBenchClient.jar --bench --rocksdb /tmp/das/cloudbench/rocksdb --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-a836-49e6-9f70-1c3822fc9239 --result_file /tmp/das/cloudbench/null.result --user cloudb**** --pwd \\\\\\\\\\\\\\"cloudbench@****\\\\\\\\\\\\\\" --host rm-bp1j5f8s5x26kq79216****.mysql.rds.aliyuncs.com --port 3306 --charset utf8mb4 --interval 1 --bench_time 3600 --rate_factor 1.0 --start_time 1621353601 --rt > /tmp/das/cloudbench/null.log\\",\\n \\"SqlFileOnOss\\": \\"https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw****\\",\\n \\"LoadCmd\\": \\"java -jar /tmp/das/cloudbench/CloudBenchClient.jar --load --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-****-49e6-9f70-1c3822fc**** --rocksdb /tmp/das/cloudbench/rocksdb\\",\\n \\"RocksDbPath\\": \\"/tmp/das/cloudbench/rocksdb\\",\\n \\"ParseCmd\\": \\"cd /tmp/das/cloudbench && java -jar CloudBenchClient.jar --parse --threads 32 --file /tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc9239.archiveSql --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --parent_patmp/das/cloudbench --source RDS --h /thost rm-bp1j5f8s5x266****.mysql.rds.aliyuncs.com --port 3306 --user cloudb**** --pwd \\\\\\\\\\\\\\"cloudbench@****\\\\\\\\\\\\\\" --cutSqlLen 8192 --db_black_list=information_schema,test,unknow,null\\",\\n \\"SqlFileName\\": \\"cl-1621353601000-360****.sc\\",\\n \\"ClientJarPath\\": \\"/tmp/das/cloudbench/CloudBenchClient.jar\\",\\n \\"SqlFilePath\\": \\"/tmp/das/cloudbench/cl-1621353601000-360****.sc\\",\\n \\"ParseFilePath\\": \\"/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql\\",\\n \\"JarOnOss\\": \\"https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****\\",\\n \\"TaskId\\": \\"e5cec704-0518-430f-8263-76f4dcds****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeCloudbenchTaskConfigResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <WorkDir>/tmp/bench/</WorkDir>\\n <ArchiveFolder>/tmp/das/cloudbench/archive-sqls/</ArchiveFolder>\\n <MetaFilePath>/tmp/das/cloudbench/cl-1621353601000-360****.meta</MetaFilePath>\\n <MetaFileName>cl-1621353601000-360****.meta</MetaFileName>\\n <MetaFileOnOss>\\"https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.meta?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=Qsehg3tzeA57M%2BIixAbWPWAtvl****</MetaFileOnOss>\\n <UserId>1091411816252****</UserId>\\n <BenchCmd>java -jar /tmp/das/cloudbench/CloudBenchClient.jar --bench --rocksdb /tmp/das/cloudbench/rocksdb --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-a836-49e6-9f70-1c3822fc9239 --result_file /tmp/das/cloudbench/null.result --user cloudb**** --pwd \\\\\\"cloudbench@****\\\\\\" --host rm-bp1j5f8s5x26kq79216****.mysql.rds.aliyuncs.com --port 3306 --charset utf8mb4 --interval 1 --bench_time 3600 --rate_factor 1.0 --start_time 1621353601 --rt > /tmp/das/cloudbench/null.log</BenchCmd>\\n <SqlFileOnOss>https://cb-rm-bp1w9g06h560l****.oss-cn-hangzhou.aliyuncs.com/cl-1621353601000-360****.sc?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=LYMADwo%2BRrJeqR3e4d8OlIkVmw****</SqlFileOnOss>\\n <LoadCmd>java -jar /tmp/das/cloudbench/CloudBenchClient.jar --load --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --task_name 2777bba9-****-49e6-9f70-1c3822fc**** --rocksdb /tmp/das/cloudbench/rocksdb</LoadCmd>\\n <RocksDbPath>/tmp/das/cloudbench/rocksdb</RocksDbPath>\\n <ParseCmd>cd /tmp/das/cloudbench && java -jar CloudBenchClient.jar --parse --threads 32 --file /tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc9239.archiveSql --meta /tmp/das/cloudbench/cl-1621353601000-360****.meta --out /tmp/das/cloudbench/cl-1621353601000-360****.sc --parent_patmp/das/cloudbench --source RDS --h /thost rm-bp1j5f8s5x266****.mysql.rds.aliyuncs.com --port 3306 --user cloudb**** --pwd \\\\\\"cloudbench@****\\\\\\" --cutSqlLen 8192 --db_black_list=information_schema,test,unknow,null</ParseCmd>\\n <SqlFileName>cl-1621353601000-360****.sc</SqlFileName>\\n <ClientJarPath>/tmp/das/cloudbench/CloudBenchClient.jar</ClientJarPath>\\n <SqlFilePath>/tmp/das/cloudbench/cl-1621353601000-360****.sc</SqlFilePath>\\n <ParseFilePath>/tmp/das/cloudbench/2777bba9-a836-49e6-9f70-1c3822fc****.archiveSql</ParseFilePath>\\n <JarOnOss>https://cloudbench-cn-hangzhou.oss-cn-hangzhou.aliyuncs.com/CloudBenchClient.jar?OSSAccessKeyId=LTAI5tKj8B4wikkVtupK****&Expires=1622441372&Signature=28p%2BCe4tNHpr9VPOcHc3Si9iOb****</JarOnOss>\\n <TaskId>e5cec704-0518-430f-8263-76f4dcds****</TaskId>\\n </Data>\\n</DescribeCloudbenchTaskConfigResponse>","errorExample":""}]',
],
'DescribeDiagnosticReportList' => [
'summary' => '调用DescribeDiagnosticReportList接口,查询诊断报告。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'DBInstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳(UTC时间),单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1668398892000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> 查询任务结束时间需晚于查询任务开始时间。', 'type' => 'string', 'required' => true, 'example' => '1668420492000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D00DB161-FEF6-5428-B37A-8D29A4C2****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Synchro' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Data' => ['description' => '返回的数据:'."\n"
."\n"
.'- **total**:数据量。'."\n"
.'- **score**:诊断分数。'."\n"
.'- **diagnosticTime**:诊断生成时间(UTC 时间)。'."\n"
.'- **startTime**:查询开始时间(UTC 时间)。'."\n"
.'- **endTime**:查询结束时间(UTC 时间)。', 'type' => 'string', 'example' => '{ "total": 1, "list": [ { "score": 100, "diagnosticTime": "2022-11-14T08:17:00Z", "startTime": "2022-11-14T07:16:59Z", "endTime": "2022-11-14T08:16:59Z" } ] }'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询诊断报告',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - Redis',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosticReportList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeDiagnosticReportList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D00DB161-FEF6-5428-B37A-8D29A4C2****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Synchro\\": \\"None\\",\\n \\"Data\\": \\"{ \\\\\\"total\\\\\\": 1, \\\\\\"list\\\\\\": [ { \\\\\\"score\\\\\\": 100, \\\\\\"diagnosticTime\\\\\\": \\\\\\"2022-11-14T08:17:00Z\\\\\\", \\\\\\"startTime\\\\\\": \\\\\\"2022-11-14T07:16:59Z\\\\\\", \\\\\\"endTime\\\\\\": \\\\\\"2022-11-14T08:16:59Z\\\\\\" } ] }\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDiagnosticReportListResponse>\\n <RequestId>D00DB161-FEF6-5428-B37A-8D29A4C2****</RequestId>\\n <Message>Successful</Message>\\n <Data>\\n <total>1</total>\\n <list>\\n <score>100</score>\\n <diagnosticTime>2022-11-14T08:17:00Z</diagnosticTime>\\n <startTime>2022-11-14T07:16:59Z</startTime>\\n <endTime>2022-11-14T08:16:59Z</endTime>\\n </list>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeDiagnosticReportListResponse>","errorExample":""}]',
],
'DescribeErrorLogRecords' => [
'summary' => '查询实例指定时间范围内的错误日志明细。',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '235508',
'abilityTreeNodes' => ['FEATUREhdmR88NLD'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1u5mas9exx7****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp16v3824rt73****'],
],
[
'name' => 'Role',
'in' => 'formData',
'schema' => ['description' => '节点角色:'."\n"
."\n"
.'- db'."\n"
.'- mongos'."\n"
."\n"
.'> 仅云数据库MongoDB版实例支持。', 'type' => 'string', 'required' => false, 'example' => 'db'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'><notice>该字段类型为Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于9007199254740991。></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1731983066000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'><notice>该字段类型为Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于9007199254740991。></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732069466000'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页大小,最大值为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Filters',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '筛选条件。'."\n"
."\n"
.'> 仅支持RDS MySQL、RDS PostgreSQL、PolarDB MySQL版、PolarDB PostgreSQL版、PolarDB PostgreSQL版(兼容Oracle)的错误日志筛选。',
'type' => 'array',
'items' => [
'description' => '筛选条件。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '筛选参数,需填写为filters。', 'type' => 'string', 'required' => false, 'example' => 'filters'],
'Value' => ['description' => '筛选的错误日志内容。', 'type' => 'string', 'required' => false, 'example' => 'deadlock'."\n"],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => 'AAA17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'title' => 'ListResult<VariableInspectionStrategy>',
'description' => '数据详情。',
'type' => 'object',
'properties' => [
'ItemsNumbers' => ['description' => '当前返回的日志明细总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'StartTime' => ['description' => '查询开始时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'example' => '2025-07-22T05:48:43Z'],
'EndTime' => ['description' => '查询结束时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'example' => '2025-07-23T05:48:43Z'],
'TotalRecords' => ['description' => '查询时间范围内的日志明细总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'PageNumbers' => ['description' => '当前查询的页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxRecordsPerPage' => ['description' => '每页显示的最大记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Logs' => [
'description' => '日志明细。',
'type' => 'array',
'items' => [
'description' => '日志明细。',
'type' => 'object',
'properties' => [
'CreateTime' => ['description' => '错误日志生成时间。格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'><notice>对于云数据库MongoDB版实例,格式为yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。></notice>', 'type' => 'string', 'example' => '1731983067000'],
'DBInstanceName' => ['description' => '节点ID。'."\n"
."\n"
.'> 仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'd-bp128a003436****'."\n"],
'Category' => ['description' => '日志类别,取值:'."\n"
.'- **NETWORK**:网络连接日志。'."\n"
.'- **ACCESS**:访问控制日志。'."\n"
.'- **-**:普通日志。'."\n"
.'- **COMMAND**:慢日志。'."\n"
.'- **SHARDING**:集群日志。'."\n"
.'- **STORAGE**:存储引擎日志。'."\n"
.'- **CONNPOOL**:连接池日志。'."\n"
.'- **ASIO**:异步 IO 日志。'."\n"
.'- **WRITE**:慢更新日志。'."\n"
."\n"
.'> 仅云数据库 MongoDB 版实例支持。', 'type' => 'string', 'example' => 'NETWORK'],
'ConnInfo' => ['description' => '日志连接信息。'."\n"
."\n"
.'> 仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'conn18xxxxxx'],
'Content' => ['description' => '错误日志。', 'type' => 'string', 'example' => '2025-07-15T15:14:27.175188+08:00 0 [Note] [MY-012468] [InnoDB] Transactions deadlock detected, dumping detailed information.'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询错误日志明细',
'description' => '本接口用于查询实例指定时间范围内的错误日志明细。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 目标数据库引擎为:RDS MySQL、RDS PostgreSQL、PolarDB MySQL 版、PolarDB PostgreSQL 版、PolarDB PostgreSQL版(兼容Oracle)、云数据库 MongoDB 版。'."\n"
.'- 使用阿里云或 DAS 的 SDK 时,建议使用最新版本。'."\n"
.'- 使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:DescribeErrorLogRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"AAA17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ItemsNumbers\\": 10,\\n \\"StartTime\\": \\"2025-07-22T05:48:43Z\\",\\n \\"EndTime\\": \\"2025-07-23T05:48:43Z\\",\\n \\"TotalRecords\\": 100,\\n \\"PageNumbers\\": 1,\\n \\"MaxRecordsPerPage\\": 10,\\n \\"Logs\\": [\\n {\\n \\"CreateTime\\": \\"1731983067000\\",\\n \\"DBInstanceName\\": \\"d-bp128a003436****\\\\n\\",\\n \\"Category\\": \\"NETWORK\\",\\n \\"ConnInfo\\": \\"conn18xxxxxx\\",\\n \\"Content\\": \\"2025-07-15T15:14:27.175188+08:00 0 [Note] [MY-012468] [InnoDB] Transactions deadlock detected, dumping detailed information.\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeHotBigKeys' => [
'summary' => '调用DescribeHotBigKeys接口,实时获取当前内存中的热Key和大Key。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmROFBLE'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Redis实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'required' => false, 'example' => 'r-****-db-0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'description' => '详情信息列表。',
'type' => 'object',
'properties' => [
'HotKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HotKey' => [
'description' => '按QPS统计的热Key列表。',
'type' => 'array',
'items' => [
'description' => '按QPS统计的热Key列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'Db' => ['description' => 'Key所在的DB。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Hot' => ['description' => 'Key的访问频次,即Key的每秒访问数。', 'type' => 'string', 'example' => '5500~6000'],
'KeyType' => ['description' => 'Key的类型。', 'type' => 'string', 'example' => 'zset'],
'Lfu' => ['description' => 'LFU算法的统计值。', 'type' => 'integer', 'format' => 'int32', 'example' => '253'],
'NodeId' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Size' => ['description' => '元素的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
],
'description' => '',
],
'BigKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BigKey' => [
'description' => '按子元素数量统计的大Key列表。',
'type' => 'array',
'items' => [
'description' => '按子元素数量统计的大Key列表。',
'type' => 'object',
'properties' => [
'Db' => ['description' => 'Key所在的DB。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'KeyType' => ['description' => 'Key类型。', 'type' => 'string', 'example' => 'zset'],
'Size' => ['description' => '元素的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'NodeId' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
],
],
],
],
'description' => '',
],
'HotKeyMsg' => ['description' => '获取按QPS统计的热Key失败的原因。', 'type' => 'string', 'example' => 'current version doesn\'t support'],
'BigKeyMsg' => ['description' => '获取按子元素数量统计的大Key失败的原因。', 'type' => 'string', 'example' => 'current version doesn\'t support'],
'HighTrafficKeyMsg' => ['description' => '获取按流量统计的热Key失败的原因。', 'type' => 'string', 'example' => 'current version doesn\'t support'],
'HighTrafficKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HighTrafficKey' => [
'description' => '按流量统计的热Key列表。',
'type' => 'array',
'items' => [
'description' => '按流量统计的热Key列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'Db' => ['description' => 'Key所在的DB。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Hot' => ['description' => 'Key的访问频次,即Key的每秒访问数。', 'type' => 'string', 'example' => '1988'],
'KeyType' => ['description' => 'Key的类型。', 'type' => 'string', 'example' => 'string'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'."\n"],
'inBytes' => ['description' => '入流量,单位:Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '85767'],
'outBytes' => ['description' => '出流量,单位:Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1054684'],
'Size' => ['description' => '元素的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
],
'description' => '',
],
'LargeKeys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'LargeKey' => [
'description' => '按内存占用统计的大Key列表。',
'type' => 'array',
'items' => [
'description' => '按内存占用统计的大Key列表。',
'type' => 'object',
'properties' => [
'Db' => ['description' => 'Key所在的DB。', 'type' => 'string', 'example' => '0'],
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'KeyType' => ['description' => 'Key的类型。', 'type' => 'string', 'example' => 'string'],
'DataSize' => ['description' => 'Key的内存占用,单位:Byte。', 'type' => 'string', 'example' => '33554439'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
],
],
],
],
'description' => '',
],
'LargeKeyMsg' => ['description' => '获取按内存占用统计的大Key失败的原因。', 'type' => 'string', 'example' => 'current version doesn\'t support'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"HotKeys\\": {\\n \\"HotKey\\": [\\n {\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"Db\\": 0,\\n \\"Hot\\": \\"5500~6000\\",\\n \\"KeyType\\": \\"zset\\",\\n \\"Lfu\\": 253,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Size\\": 2\\n }\\n ]\\n },\\n \\"BigKeys\\": {\\n \\"BigKey\\": [\\n {\\n \\"Db\\": 0,\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"KeyType\\": \\"zset\\",\\n \\"Size\\": 2,\\n \\"NodeId\\": \\"r-x****-db-0\\"\\n }\\n ]\\n },\\n \\"HotKeyMsg\\": \\"current version doesn\'t support\\",\\n \\"BigKeyMsg\\": \\"current version doesn\'t support\\",\\n \\"HighTrafficKeyMsg\\": \\"current version doesn\'t support\\",\\n \\"HighTrafficKeys\\": {\\n \\"HighTrafficKey\\": [\\n {\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"Db\\": 0,\\n \\"Hot\\": \\"1988\\",\\n \\"KeyType\\": \\"string\\",\\n \\"NodeId\\": \\"r-x****-db-0\\\\n\\",\\n \\"inBytes\\": 85767,\\n \\"outBytes\\": 1054684,\\n \\"Size\\": 2\\n }\\n ]\\n },\\n \\"LargeKeys\\": {\\n \\"LargeKey\\": [\\n {\\n \\"Db\\": \\"0\\",\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"KeyType\\": \\"string\\",\\n \\"DataSize\\": \\"33554439\\",\\n \\"NodeId\\": \\"r-x****-db-0\\"\\n }\\n ]\\n },\\n \\"LargeKeyMsg\\": \\"current version doesn\'t support\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeHotBigKeysResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <HotKeys>\\n <Key>abc:def:eng</Key>\\n <Db>0</Db>\\n <Hot>5500~6000</Hot>\\n <KeyType>zset</KeyType>\\n <Lfu>253</Lfu>\\n <NodeId>r-x****-db-0</NodeId>\\n </HotKeys>\\n <BigKeys>\\n <Db>0</Db>\\n <Key>abc:def:eng</Key>\\n <KeyType>zset</KeyType>\\n <Size>2</Size>\\n <NodeId>r-x****-db-0</NodeId>\\n </BigKeys>\\n <HotKeyMsg>current version doesn\'t support</HotKeyMsg>\\n <BigKeyMsg>current version doesn\'t support</BigKeyMsg>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeHotBigKeysResponse>","errorExample":""}]',
'title' => '实时获取当前热Key和大Key',
'description' => '对数据结构为List、Hash、Set、Zset的Key,按照Key中元素的数量排序并展示排名前3的Key,记录为大Key。如果某个Key的QPS大于5,000,会被记录为热点Key。关于大Key和热点Key的具体定义,请参见[Top Key统计](https://help.aliyun.com/zh/das/user-guide/key-analysis)。'."\n"
.'>'."\n"
.'> - 在Redis开源版7.0.18、6.0.2.9、5.5.2.9及更早版本的实例,或Tair内存型5.0.50、25.2.0.0版本及更早版本的实例中,QPS大于3,000的Key即会被记录为热点Key,且该阈值不支持调整。'."\n"
."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.2或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口只适用于如下Redis实例:'."\n"
.' - 实例为Redis开源版或Tair(企业版)内存型。'."\n"
.' - 实例的小版本为最新。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHotBigKeys'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeHotBigKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeHotKeys' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Redis实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HotKey' => [
'description' => '详细信息列表。',
'type' => 'array',
'items' => [
'description' => '结果集。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'Db' => ['description' => 'Key所在的DB。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Hot' => ['description' => 'Key的访问频次,即Key的每秒访问数。', 'type' => 'string', 'example' => '5500~6000'],
'KeyType' => ['description' => 'Key的类型。', 'type' => 'string', 'example' => 'zset'],
'Size' => ['description' => '元素的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'InBytes' => ['description' => '入流量,单位Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '85766'],
'OutBytes' => ['description' => '出流量,单位Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1054688'],
'NodeId' => ['description' => '节点id。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'Category' => ['description' => '热Key类别:'."\n"
.'- **qps**:按QPS统计的热Key。'."\n"
.'- **traffic**:按流量统计的热Key。', 'type' => 'string', 'example' => 'qps'],
],
],
],
],
'description' => '',
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询实例当前的热Key',
'summary' => '调用DescribeHotKeys接口,查询Redis实例的热Key。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.2或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口只适用于如下Redis实例:'."\n"
.' - 实例为Redis开源版或Tair(企业版)内存型。'."\n"
.' - 实例的小版本为最新。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHotKeys'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeHotKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"HotKey\\": [\\n {\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"Db\\": 0,\\n \\"Hot\\": \\"5500~6000\\",\\n \\"KeyType\\": \\"zset\\",\\n \\"Size\\": 2,\\n \\"InBytes\\": 85766,\\n \\"OutBytes\\": 1054688,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"Category\\": \\"qps\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeHotKeysResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <Key>abc:def:eng</Key>\\n <Db>0</Db>\\n <Hot>5500~6000</Hot>\\n <KeyType>zset</KeyType>\\n <Size>2</Size>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeHotKeysResponse>","errorExample":""}]',
],
'DescribeInstanceDasPro' => [
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdm543Z01'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9CB97BC4-6479-55D0-B9D0-EA925AFE****'],
'Data' => ['description' => '数据库实例是否开启了DAS企业版:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询是否开启了DAS企业版 V1或V2',
'summary' => '调用DescribeInstanceDasPro接口,查询指定数据库实例是否开启了DAS企业版 V1或企业版 V2。',
'description' => '- 目前支持的数据库实例请参见[DAS企业版使用说明](~~190912~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 该接口仅适用于DAS企业版 V1、V2。'."\n"
.'>推荐使用[DescribeSqlLogConfig](~~2778837~~)接口,查询数据库实例的DAS企业版配置信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDasPro'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeInstanceDasPro',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"9CB97BC4-6479-55D0-B9D0-EA925AFE****\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeInstanceDasProResponse>\\n <Message>Successful</Message>\\n <RequestId>9CB97BC4-6479-55D0-B9D0-EA925AFE****</RequestId>\\n <Data>true</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeInstanceDasProResponse>","errorExample":""}]',
],
'DescribeQueryExplain' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmI71917'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,若提供节点ID,将到指定节点查询执行计划,否则将在备节点查询执行计划。'."\n"
.'> 对于RDS MySQL高可用实例,若将实例ID传入,将到指定节点查询执行计划,否则将在备节点查询执行计划。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp1v203xzzh0a****'],
],
[
'name' => 'Sql',
'in' => 'formData',
'schema' => ['description' => '待查询执行计划的SQL。', 'type' => 'string', 'required' => true, 'example' => 'select * from test where name = \'mockUser\''],
],
[
'name' => 'DbName',
'in' => 'formData',
'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => false, 'example' => 'dbtest01'],
],
[
'name' => 'Schema',
'in' => 'formData',
'schema' => ['description' => 'schema信息,预留参数。', 'type' => 'string', 'required' => false, 'example' => '无'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码,200表示成功。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'List<ExplainedSqlDO>',
'description' => 'List<ExplainedSqlDO>',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '查询ID。', 'type' => 'string', 'example' => '1'],
'SelectType' => ['description' => '查询类型。', 'type' => 'string', 'example' => 'SIMPLE'],
'Table' => ['description' => '表名。', 'type' => 'string', 'example' => 'test'],
'Type' => ['description' => 'Join类型。', 'type' => 'string', 'example' => 'eq_ref'],
'PossibleKeys' => ['description' => '可能被选择的索引。', 'type' => 'string', 'example' => 'test_idx'],
'Key' => ['description' => '执行计划中,实际选择的索引。', 'type' => 'string', 'example' => 'PRIMARY'],
'KeyLen' => ['description' => '实际选择索引的长度。', 'type' => 'string', 'example' => '3'],
'Ref' => ['description' => '索引所用的列。', 'type' => 'string', 'example' => 'test_column'],
'Rows' => ['description' => '待扫描行数。', 'type' => 'string', 'example' => '1000'],
'Extra' => ['description' => '附加信息。', 'type' => 'string', 'example' => '无'],
'QueryPlan' => ['title' => 'QUEYR_PLAN展示用', 'description' => '保留字段,用于PG引擎。', 'type' => 'string', 'example' => '无'],
'TableList' => [
'title' => 'queryPlan中用到的表名',
'description' => '保留字段,用于PG引擎。',
'type' => 'array',
'items' => ['description' => '保留字段,用于PG引擎。', 'type' => 'string', 'example' => '无'],
],
'IndexList' => [
'title' => 'queryPlan中用到的索引名',
'description' => '保留字段,用于PG引擎。',
'type' => 'array',
'items' => ['description' => '保留字段,用于PG引擎。', 'type' => 'string', 'example' => '无'],
],
'LogicalPlanList' => [
'description' => '保留字段,用于PolarDB X引擎。',
'type' => 'array',
'items' => ['description' => '保留字段,用于PolarDB X引擎。', 'type' => 'string', 'example' => '无'],
],
'StmtText' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'StmtId' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'NodeId' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'Parent' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'PhysicalOp' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'LogicalOp' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'Argument' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'DefinedValues' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'EstimateRows' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'EstimateIO' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'EstimateCPU' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'AvgRowSize' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'TotalSubtreeCost' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'OutputList' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'Warnings' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'Parallel' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
'EstimateExecutions' => ['description' => '保留字段,用于SQLServer引擎。', 'type' => 'string', 'example' => '无'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询SQL执行计划',
'summary' => '查询SQL的执行计划。',
'description' => '- 当前仅支持RDS MySQL和PolarDB MySQL实例查询SQL的执行计划。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeQueryExplain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"SelectType\\": \\"SIMPLE\\",\\n \\"Table\\": \\"test\\",\\n \\"Type\\": \\"eq_ref\\",\\n \\"PossibleKeys\\": \\"test_idx\\",\\n \\"Key\\": \\"PRIMARY\\",\\n \\"KeyLen\\": \\"3\\",\\n \\"Ref\\": \\"test_column\\",\\n \\"Rows\\": \\"1000\\",\\n \\"Extra\\": \\"无\\",\\n \\"QueryPlan\\": \\"无\\",\\n \\"TableList\\": [\\n \\"无\\"\\n ],\\n \\"IndexList\\": [\\n \\"无\\"\\n ],\\n \\"LogicalPlanList\\": [\\n \\"无\\"\\n ],\\n \\"StmtText\\": \\"无\\",\\n \\"StmtId\\": \\"无\\",\\n \\"NodeId\\": \\"无\\",\\n \\"Parent\\": \\"无\\",\\n \\"PhysicalOp\\": \\"无\\",\\n \\"LogicalOp\\": \\"无\\",\\n \\"Argument\\": \\"无\\",\\n \\"DefinedValues\\": \\"无\\",\\n \\"EstimateRows\\": \\"无\\",\\n \\"EstimateIO\\": \\"无\\",\\n \\"EstimateCPU\\": \\"无\\",\\n \\"AvgRowSize\\": \\"无\\",\\n \\"TotalSubtreeCost\\": \\"无\\",\\n \\"OutputList\\": \\"无\\",\\n \\"Warnings\\": \\"无\\",\\n \\"Parallel\\": \\"无\\",\\n \\"EstimateExecutions\\": \\"无\\"\\n }\\n ]\\n}","type":"json"}]',
],
'DescribeSecurityIPGroup' => [
'summary' => '展示用户跨产品白名单模板具体信息',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247410',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'ListResult<InstanceSSL>',
'description' => 'ListResult<InstanceSSL>',
'type' => 'object',
'properties' => [
'SecurityIpGroups' => [
'description' => '用户在该region下的所有跨产品白名单模板列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbInstances' => [
'description' => '该跨产品白名单模板所绑定的数据库实例列表。',
'type' => 'array',
'items' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => '["r-2ze9g6mnhu1***",'."\n"
.'"pc-2zew5qn1m***",'."\n"
.'"r-2ze9g6mn****",'."\n"
.'"pc-2zew5qh41*****"]'],
],
'SecurityIpType' => ['description' => 'ip类型', 'type' => 'string', 'example' => 'ipv4'],
'Uid' => ['description' => '账号ID,您可在阿里云**账号管理**的**安全设置**页面获取**登录账号**的ID。', 'type' => 'string', 'example' => '160-79abe3f4****'],
'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'GEcsSgIdList' => ['description' => 'ECS 安全组ID,已无效,是冗余数据,待下线', 'type' => 'string', 'example' => ' null'],
'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求:'."\n"
."\n"
.'- 由小写字母、数字、下划线(_)组成。'."\n"
."\n"
.'- 由字母开头、字母或数字结尾。'."\n"
."\n"
.'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'test_123'],
'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-1no2rzybnqcv****'],
'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'],
'EngineInfoList' => [
'description' => '该模板所绑定的各产品下的实例信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceNum' => ['description' => '当前登录账号包含的实例数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'EngineName' => ['description' => '目标实例的数据库类型。', 'type' => 'string', 'example' => 'PolarDBMySQL'],
'InstanceIds' => [
'description' => '数据库实例ID列表。',
'type' => 'array',
'items' => ['description' => '数据库实例ID。'."\n"
."\n"
.'> 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。', 'type' => 'string', 'example' => 'rm-2ze8ygcc****'],
],
],
'description' => '',
],
],
'UserId' => ['description' => '用户id', 'type' => 'string', 'example' => '641***'],
'GIpList' => ['description' => '白名单模板内的IP地址。'."\n"
.'> 多个IP地址需要用英文逗号(,)分隔。', 'type' => 'string', 'example' => '192.168.1.28/32'],
],
'description' => '',
],
],
],
],
'Message' => ['description' => '请求返回的消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'CAC553F1-C669-53F1-A295-2CF050E****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '跨产品白名单模板展示接口',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"SecurityIpGroups\\": [\\n {\\n \\"DbInstances\\": [\\n \\"[\\\\\\"r-2ze9g6mnhu1***\\\\\\",\\\\n\\\\\\"pc-2zew5qn1m***\\\\\\",\\\\n\\\\\\"r-2ze9g6mn****\\\\\\",\\\\n\\\\\\"pc-2zew5qh41*****\\\\\\"]\\"\\n ],\\n \\"SecurityIpType\\": \\"ipv4\\",\\n \\"Uid\\": \\"160-79abe3f4****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GEcsSgIdList\\": \\" null\\",\\n \\"GlobalIgName\\": \\"test_123\\",\\n \\"GlobalSecurityGroupId\\": \\"g-1no2rzybnqcv****\\",\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"EngineInfoList\\": [\\n {\\n \\"InstanceNum\\": 10,\\n \\"EngineName\\": \\"PolarDBMySQL\\",\\n \\"InstanceIds\\": [\\n \\"rm-2ze8ygcc****\\"\\n ]\\n }\\n ],\\n \\"UserId\\": \\"641***\\",\\n \\"GIpList\\": \\"192.168.1.28/32\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"CAC553F1-C669-53F1-A295-2CF050E****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'DescribeSecurityIPGroupRelation' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247410',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2zegsc57ofexxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'ListResult<InstanceSSL>',
'description' => 'ListResult<InstanceSSL>',
'type' => 'object',
'properties' => [
'GlobalSecurityIPGroupRel' => [
'description' => '全局IP白名单模板信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-shenzhen'],
'GlobalIgName' => ['description' => 'IP白名单模板名称。', 'type' => 'string', 'example' => 'test2'],
'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-1no2rzybnqcv0xxxxxx'],
'GIpList' => ['description' => '白名单模板内的IP地址。'."\n"
."\n"
.'> 多个IP地址需要用英文逗号隔开,所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.1.28/32'],
],
'description' => '',
],
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
],
],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A6D1C8EE-013C-541F-83EB-B13C8xxxxxx'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'summary' => '展示用户跨产品白名单模板与实例绑定信息',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'title' => '跨产品白名单模板绑定信息展示接口',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSecurityIPGroupRelation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"RegionId\\": \\"cn-shenzhen\\",\\n \\"GlobalIgName\\": \\"test2\\",\\n \\"GlobalSecurityGroupId\\": \\"g-1no2rzybnqcv0xxxxxx\\",\\n \\"GIpList\\": \\"192.168.1.28/32\\"\\n }\\n ],\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\"\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"A6D1C8EE-013C-541F-83EB-B13C8xxxxxx\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'DescribeSlowLogHistogramAsync' => [
'summary' => '异步获取实例慢日志趋势数据。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '236527',
'abilityTreeNodes' => ['FEATUREhdmR88NLD'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'."\n"],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'r-****-db-0'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> 查询结束时间需晚于任务开始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1662518540764'],
],
[
'name' => 'Filters',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '查询筛选条件列表。',
'type' => 'array',
'items' => [
'description' => 'Key支持的参数和取值:'."\n"
."\n"
.'hostAddress:来源,多个逗号分隔。'."\n"
."\n"
.'sqlId:sqlId,多个逗号分隔。'."\n"
."\n"
.'user:用户,多个逗号分隔。'."\n"
."\n"
.'dbName:数据库,多个逗号分隔。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
'Value' => ['description' => '过滤参数的值。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'AsyncResult<Histogram>',
'description' => 'AsyncResult<Histogram>。',
'type' => 'object',
'properties' => [
'RequestKey' => ['title' => '请求参数的Key', 'description' => '请求参数的Key。', 'type' => 'string', 'example' => '无'],
'ResultId' => ['title' => '结果ID', 'description' => '结果ID。', 'type' => 'string', 'example' => 'async__20ee808e72257f16a4fe024057ca****'],
'State' => ['title' => '当前状态 (RUNNING: 正在运行, SUCCESS: 成功, FAIL: 失败)', 'description' => '当前状态:'."\n"
.'- **RUNNING**:正在运行。'."\n"
.'- **SUCCESS**:成功。'."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'IsFinish' => ['title' => '是否完成', 'description' => '是否完成。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'title' => '数据',
'description' => '数据。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '查询的总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Count' => [
'description' => '慢日志数量趋势。',
'type' => 'array',
'items' => ['description' => '慢日志个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
'Ts' => [
'title' => '关系型数据库只使用这个',
'description' => '关系型数据库只使用这个。',
'type' => 'array',
'items' => ['description' => '第一个事件发生的时间,使用UNIX时间戳表示,单位:毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 1735098480000,'."\n"
.' 1735098540000,'."\n"
.' 1735098600000,'."\n"
.' 1735098660000,'."\n"
.' 1735098720000,'."\n"
.' 1735098780000'."\n"
.' ]'],
],
'TsEnd' => [
'description' => '无用,预留字段。',
'type' => 'array',
'items' => ['description' => '查询结束时间戳。'."\n"
."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '暂无'],
],
'Item' => [
'description' => '趋势指标。',
'type' => 'array',
'items' => [
'description' => '具体项目名称。',
'type' => 'object',
'properties' => [
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'r-bp1hi0wg57s3n0i3n8-db-0'],
'Count' => [
'description' => '慢日志数量。',
'type' => 'array',
'items' => ['description' => '慢日志数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
'InsItems' => [
'description' => '趋势指标。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => [
'description' => '趋势指标。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'object',
'properties' => [
'InsId' => ['description' => '实例角色ID。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => '2492'],
'InsRole' => ['description' => '实例角色。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'userAdmin'],
'Count' => [
'description' => '执行次数。',
'type' => 'array',
'items' => ['description' => '执行次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
'TotalCount' => ['description' => '物理节点的慢日志数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
'TotalCount' => ['description' => '总的慢日志数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'InsRole' => ['description' => '实例角色。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string'],
],
],
],
'Rt' => [
'description' => '总执行耗时,单位为秒。',
'type' => 'array',
'items' => ['description' => '总执行耗时,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 0.0,'."\n"
.' 4.538,'."\n"
.' 1.247,'."\n"
.' 1.972'."\n"
.' ]'],
],
'AvgRt' => [
'description' => '平均执行耗时。',
'type' => 'array',
'items' => ['description' => '平均执行耗时。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.593,'."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 0.0,'."\n"
.' 1.5127,'."\n"
.' 1.247'."\n"
.' ]'],
],
'MaxRt' => [
'description' => '最大执行耗时,单位秒。',
'type' => 'array',
'items' => ['description' => '最大执行耗时,单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.593,'."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 14.115'."\n"
.' 0.0,'."\n"
.' 1.972'."\n"
.' ]'],
],
'LockTime' => [
'description' => '总锁等待时间,单位秒。',
'type' => 'array',
'items' => ['description' => '总锁等待时间,单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.051,'."\n"
.' 1.007,'."\n"
.' 0.0,'."\n"
.' 0.755,'."\n"
.' 0.096,'."\n"
.' 0.0'."\n"
.' ]'],
],
'AvgLockTime' => [
'description' => '平均锁等待时间,单位为秒。',
'type' => 'array',
'items' => ['description' => '平均锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.051,'."\n"
.' 0.0,'."\n"
.' 0.3357,'."\n"
.' 0.755,'."\n"
.' 0.324,'."\n"
.' 0.814'."\n"
.' ]'],
],
'MaxLockTime' => [
'description' => '最大锁等待时间,单位为秒。',
'type' => 'array',
'items' => ['description' => '最大锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.051,'."\n"
.' 1.007,'."\n"
.' 0.755,'."\n"
.' 0.0,'."\n"
.' 0.05,'."\n"
.' 0.656'."\n"
.' ]'],
],
'RowsExamined' => [
'description' => '总扫描行数。'."\n"
.'> 目前支持该字段的数据库:云数据库RDS MySQL版、云数据库RDS PostgreSQL版、云原生数据库PolarDB MySQL版。',
'type' => 'array',
'items' => ['description' => '总扫描行数。'."\n"
.'> 目前支持该字段的数据库:云数据库RDS MySQL版、云数据库RDS PostgreSQL版、云原生数据库PolarDB MySQL版。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 1,'."\n"
.' 512,'."\n"
.' 0,'."\n"
.' 1476678,'."\n"
.' 24430'."\n"
.' ]'],
],
'AvgRowsExamined' => [
'description' => '平均扫描行数。',
'type' => 'array',
'items' => ['description' => '平均扫描行数。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 256.0,'."\n"
.' 256.3333,'."\n"
.' 512.0,'."\n"
.' 370860.1111,'."\n"
.' 0.0,'."\n"
.' 1.0'."\n"
.' ]'],
],
'MaxRowsExamined' => [
'description' => '最大扫描行数。',
'type' => 'array',
'items' => ['description' => '最大扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 1,'."\n"
.' 512,'."\n"
.' 0,'."\n"
.' 1476678,'."\n"
.' 24430'."\n"
.' ]'],
],
'RowsSent' => [
'description' => '返回行数。',
'type' => 'array',
'items' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 384,'."\n"
.' 256,'."\n"
.' 0,'."\n"
.' 207030,'."\n"
.' 4,'."\n"
.' 256'."\n"
.' ]'],
],
'AvgRowsSent' => [
'description' => '平均返回行数。',
'type' => 'array',
'items' => ['description' => '平均返回行数。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 128.0,'."\n"
.' 0.0,'."\n"
.' 256.0,'."\n"
.' 25878.75,'."\n"
.' 192.0,'."\n"
.' 72.7778'."\n"
.' ]'],
],
'MaxRowsSent' => [
'description' => '最大返回行数。',
'type' => 'array',
'items' => ['description' => '最大返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'KeysExamined' => [
'description' => '索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 384,'."\n"
.' 256,'."\n"
.' 0,'."\n"
.' 207030,'."\n"
.' 4,'."\n"
.' 256'."\n"
.' ]'],
],
'AvgKeysExamined' => [
'description' => '平均索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '平均索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 128.0,'."\n"
.' 0.0,'."\n"
.' 256.0,'."\n"
.' 25878.75,'."\n"
.' 192.0,'."\n"
.' 72.7778'."\n"
.' ]'],
],
'MaxKeysExamined' => [
'description' => '最大索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '最大索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 384,'."\n"
.' 256,'."\n"
.' 0,'."\n"
.' 207030,'."\n"
.' 4,'."\n"
.' 256'."\n"
.' ]'],
],
'DocExamined' => [
'description' => '扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'AvgDocExamined' => [
'description' => '平均扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '平均扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 128.0,'."\n"
.' 0.0,'."\n"
.' 256.0,'."\n"
.' 25878.75,'."\n"
.' 192.0,'."\n"
.' 72.7778'."\n"
.' ]'],
],
'MaxDocExamined' => [
'description' => '最大扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '最大扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'ReturnNum' => [
'description' => '返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'AvgReturnNum' => [
'description' => '平均返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '平均返回行数'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 128.0,'."\n"
.' 0.0,'."\n"
.' 256.0,'."\n"
.' 25878.75,'."\n"
.' 192.0,'."\n"
.' 72.7778'."\n"
.' ]'],
],
'MaxReturnNum' => [
'description' => '最大返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。',
'type' => 'array',
'items' => ['description' => '最大返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'IOWrites' => [
'description' => 'I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => 'I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'AvgIOWrites' => [
'description' => '平均 I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均 I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 384,'."\n"
.' 256,'."\n"
.' 0,'."\n"
.' 207030,'."\n"
.' 4,'."\n"
.' 256'."\n"
.' ]'],
],
'MaxIOWrites' => [
'description' => '最大 I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '最大 I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 1,'."\n"
.' 512,'."\n"
.' 0,'."\n"
.' 1476678,'."\n"
.' 24430'."\n"
.' ]'],
],
'LastRowsCountAffected' => [
'description' => '最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 256,'."\n"
.' 207023,'."\n"
.' 0,'."\n"
.' 128,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'],
],
'AvgLastRowsCountAffected' => [
'description' => '平均最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.593,'."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 0.0,'."\n"
.' 1.5127,'."\n"
.' 1.247'."\n"
.' ]'],
],
'MaxLastRowsCountAffected' => [
'description' => '最大最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 1,'."\n"
.' 1,'."\n"
.' 3,'."\n"
.' 1,'."\n"
.' 2,'."\n"
.' 3'."\n"
.' ]'],
],
'LogicalIOReads' => [
'description' => '逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 384,'."\n"
.' 256,'."\n"
.' 0,'."\n"
.' 207030,'."\n"
.' 4,'."\n"
.' 256'."\n"
.' ]'],
],
'AvgLogicalIOReads' => [
'description' => '平均逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.593,'."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 0.0,'."\n"
.' 1.5127,'."\n"
.' 1.247'."\n"
.' ]'],
],
'MaxLogicalIOReads' => [
'description' => '最大逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '最大逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 124,'."\n"
.' 2,'."\n"
.' 24,'."\n"
.' 251,'."\n"
.' 191,'."\n"
.' 721'."\n"
.' ]'],
],
'PhysicalIOReads' => [
'description' => '物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 324,'."\n"
.' 22,'."\n"
.' 254,'."\n"
.' 251,'."\n"
.' 191,'."\n"
.' 721'."\n"
.' ]'],
],
'AvgPhysicalIOReads' => [
'description' => '平均物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 128.0,'."\n"
.' 0.0,'."\n"
.' 256.0,'."\n"
.' 25878.75,'."\n"
.' 192.0,'."\n"
.' 72.7778'."\n"
.' ]'],
],
'MaxPhysicalIOReads' => [
'description' => '最大物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '最大物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 314,'."\n"
.' 242,'."\n"
.' 114,'."\n"
.' 351,'."\n"
.' 191,'."\n"
.' 721'."\n"
.' ]'],
],
'RowsCountAffected' => [
'description' => '影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 34,'."\n"
.' 42,'."\n"
.' 14,'."\n"
.' 51,'."\n"
.' 91,'."\n"
.' 71'."\n"
.' ]'],
],
'AvgRowsCountAffected' => [
'description' => '平均影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.593,'."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 14.115,'."\n"
.' 0.0,'."\n"
.' 1.783,'."\n"
.' 0.0,'."\n"
.' 1.972'."\n"
.' ]'],
],
'MaxRowsCountAffected' => [
'description' => '最大影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '最大影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.' 714,'."\n"
.' 442,'."\n"
.' 314,'."\n"
.' 151,'."\n"
.' 291,'."\n"
.' 521'."\n"
.' ]'],
],
'CPUTime' => [
'description' => 'CPU处理时长。单位:秒(s)。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => 'CPU处理时长。单位:秒(s)。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 1.051,'."\n"
.' 1.007,'."\n"
.' 0.755,'."\n"
.' 0.0,'."\n"
.' 0.05,'."\n"
.' 0.656'."\n"
.' ]'],
],
'AvgCPUTime' => [
'description' => '平均CPU处理时长。单位:秒(s)。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '平均CPU处理时长。单位:秒(s)。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 0.0,'."\n"
.' 4.538,'."\n"
.' 1.247,'."\n"
.' 0.0'."\n"
.' ]'],
],
'MaxCPUTime' => [
'description' => '最大CPU处理时长。单位:秒(s)。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。',
'type' => 'array',
'items' => ['description' => '最大CPU处理时长。单位:秒(s)。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '['."\n"
.' 2.306,'."\n"
.' 1.141,'."\n"
.' 0.0,'."\n"
.' 4.538,'."\n"
.' 1.247,'."\n"
.' 0.0'."\n"
.' ]'],
],
'Rows' => [
'description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。',
'type' => 'array',
'items' => ['description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '[]'],
],
'AvgRows' => [
'description' => '平均行数。',
'type' => 'array',
'items' => ['description' => '平均行数。', 'type' => 'number', 'format' => 'double'],
],
'MaxRows' => [
'description' => '最大行数。',
'type' => 'array',
'items' => ['description' => '最大行数。', 'type' => 'integer', 'format' => 'int64'],
],
'Frows' => [
'description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。',
'type' => 'array',
'items' => ['description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64'],
],
'AvgFrows' => [
'description' => '平均拉取行数。',
'type' => 'array',
'items' => ['description' => '平均拉取行数。', 'type' => 'number', 'format' => 'double'],
],
'MaxFrows' => [
'description' => '最大拉取行数。',
'type' => 'array',
'items' => ['description' => '最大拉取行数。', 'type' => 'integer', 'format' => 'int64'],
],
'Scnt' => [
'description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。',
'type' => 'array',
'items' => ['description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64'],
],
'AvgScnt' => [
'description' => '平均请求数。',
'type' => 'array',
'items' => ['description' => '平均请求数。', 'type' => 'number', 'format' => 'double'],
],
'MaxScnt' => [
'description' => '最大请求数。',
'type' => 'array',
'items' => ['description' => '最大请求数。', 'type' => 'integer', 'format' => 'int64'],
],
'TotalCount' => ['description' => '慢日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
],
],
'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '10910'],
'Message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Successful'],
'Timestamp' => ['title' => '请求时间', 'description' => '请求时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1645668213000'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"RequestKey\\": \\"无\\",\\n \\"ResultId\\": \\"async__20ee808e72257f16a4fe024057ca****\\",\\n \\"State\\": \\"SUCCESS\\",\\n \\"IsFinish\\": true,\\n \\"Data\\": {\\n \\"Total\\": 1,\\n \\"Count\\": [\\n 100\\n ],\\n \\"Ts\\": [\\n 0\\n ],\\n \\"TsEnd\\": [\\n 0\\n ],\\n \\"Item\\": [\\n {\\n \\"NodeId\\": \\"r-bp1hi0wg57s3n0i3n8-db-0\\",\\n \\"Count\\": [\\n 100\\n ],\\n \\"InsItems\\": [\\n {\\n \\"InsId\\": \\"2492\\",\\n \\"InsRole\\": \\"userAdmin\\",\\n \\"Count\\": [\\n 1\\n ],\\n \\"TotalCount\\": 10\\n }\\n ],\\n \\"TotalCount\\": 20,\\n \\"InsRole\\": \\"\\"\\n }\\n ],\\n \\"Rt\\": [\\n 0\\n ],\\n \\"AvgRt\\": [\\n 0\\n ],\\n \\"MaxRt\\": [\\n 0\\n ],\\n \\"LockTime\\": [\\n 0\\n ],\\n \\"AvgLockTime\\": [\\n 0\\n ],\\n \\"MaxLockTime\\": [\\n 0\\n ],\\n \\"RowsExamined\\": [\\n 0\\n ],\\n \\"AvgRowsExamined\\": [\\n 0\\n ],\\n \\"MaxRowsExamined\\": [\\n 0\\n ],\\n \\"RowsSent\\": [\\n 0\\n ],\\n \\"AvgRowsSent\\": [\\n 0\\n ],\\n \\"MaxRowsSent\\": [\\n 0\\n ],\\n \\"KeysExamined\\": [\\n 0\\n ],\\n \\"AvgKeysExamined\\": [\\n 0\\n ],\\n \\"MaxKeysExamined\\": [\\n 0\\n ],\\n \\"DocExamined\\": [\\n 0\\n ],\\n \\"AvgDocExamined\\": [\\n 0\\n ],\\n \\"MaxDocExamined\\": [\\n 0\\n ],\\n \\"ReturnNum\\": [\\n 0\\n ],\\n \\"AvgReturnNum\\": [\\n 0\\n ],\\n \\"MaxReturnNum\\": [\\n 0\\n ],\\n \\"IOWrites\\": [\\n 0\\n ],\\n \\"AvgIOWrites\\": [\\n 0\\n ],\\n \\"MaxIOWrites\\": [\\n 0\\n ],\\n \\"LastRowsCountAffected\\": [\\n 0\\n ],\\n \\"AvgLastRowsCountAffected\\": [\\n 0\\n ],\\n \\"MaxLastRowsCountAffected\\": [\\n 0\\n ],\\n \\"LogicalIOReads\\": [\\n 0\\n ],\\n \\"AvgLogicalIOReads\\": [\\n 0\\n ],\\n \\"MaxLogicalIOReads\\": [\\n 0\\n ],\\n \\"PhysicalIOReads\\": [\\n 0\\n ],\\n \\"AvgPhysicalIOReads\\": [\\n 0\\n ],\\n \\"MaxPhysicalIOReads\\": [\\n 0\\n ],\\n \\"RowsCountAffected\\": [\\n 0\\n ],\\n \\"AvgRowsCountAffected\\": [\\n 0\\n ],\\n \\"MaxRowsCountAffected\\": [\\n 0\\n ],\\n \\"CPUTime\\": [\\n 0\\n ],\\n \\"AvgCPUTime\\": [\\n 0\\n ],\\n \\"MaxCPUTime\\": [\\n 0\\n ],\\n \\"Rows\\": [\\n 0\\n ],\\n \\"AvgRows\\": [\\n 0\\n ],\\n \\"MaxRows\\": [\\n 0\\n ],\\n \\"Frows\\": [\\n 0\\n ],\\n \\"AvgFrows\\": [\\n 0\\n ],\\n \\"MaxFrows\\": [\\n 0\\n ],\\n \\"Scnt\\": [\\n 0\\n ],\\n \\"AvgScnt\\": [\\n 0\\n ],\\n \\"MaxScnt\\": [\\n 0\\n ],\\n \\"TotalCount\\": 5\\n },\\n \\"ErrorCode\\": 10910,\\n \\"Message\\": \\"Successful\\",\\n \\"Timestamp\\": 1645668213000\\n }\\n}","type":"json"}]',
'title' => '异步获取实例慢日志趋势数据',
'description' => '**请确保在使用该接口前,已充分了解DAS产品的[收费方式和价格](~~156195~~)。**'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 请求实例已开通**DAS企业版**,或者智能运维服务(暂未上线)。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'该接口异步调用后不会立即返回完整结果,当返回数据中 isFinish 取值为 false 时,请等待 1s 后重新发起调用,直到 isFinish 取值为 true 时,返回完整结果。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlowLogHistogramAsync'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSlowLogHistogramAsync',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSlowLogRecords' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '236528',
'abilityTreeNodes' => ['FEATUREhdmR88NLD'],
'autoTest' => true,
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例id。', 'type' => 'string', 'required' => true, 'example' => 'rm-8vbk4xz99su8****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点id。', 'type' => 'string', 'required' => false, 'example' => 'pi-d9j9fe7wq7t9i****'."\n"],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '起始时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '结束时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1634972640000'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '页码,从1开始。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Filters',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '筛选条件列表。',
'type' => 'array',
'items' => [
'description' => '筛选条件列表。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数。'."\n"
."\n"
.'> 详情请参见补充说明。', 'type' => 'string', 'required' => false, 'example' => 'None'],
'Value' => ['description' => '过滤参数取值。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '- **MySQL** '."\n"
.' - QueryTimeSeconds:查询耗时(秒)。'."\n"
.' - LockTimeSeconds:锁时间(秒)。'."\n"
.' - RowsSent:配置行。'."\n"
.' - RowsExamined:检查行。'."\n"
.'- **Redis**'."\n"
.' - QueryTime:耗时。'."\n"
.' - Timestamp:执行结束时间。'."\n"
.'- **MongoDB**'."\n"
.' - QueryTime:耗时。'."\n"
.' - Timestamp:执行结束时间。'."\n"
.' - KeysExamined:已检查密匙。'."\n"
.' - DocExamined:已检查文件。'."\n"
.' - ReturnNum:返回行。'."\n"
."\n"
.'<notice>RDS PostgreSQL、PolarDB PostgreSQL和SQLServer不支持排序。</notice>', 'type' => 'string', 'required' => false, 'example' => 'QueryTimeSeconds'],
],
[
'name' => 'Asc',
'in' => 'query',
'schema' => ['description' => '是否升序排序,默认为**true**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A1C79EE2-D04D-571B-8C60-961FAF8E****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'DBLogRecords<SlowLogItem>',
'description' => 'DBLogRecords<SlowLogItem>',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-bp157g54vy772****'],
'NodeId' => ['description' => '节点id。', 'type' => 'string', 'example' => 'node123'],
'ItemsNumbers' => ['description' => '当前页查询日志列表内的Item数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'StartTime' => ['description' => '起始时间。', 'type' => 'string', 'example' => '1672531200000'],
'EndTime' => ['description' => '结束时间。', 'type' => 'string', 'example' => '1672617600000'],
'DbInstanceId' => ['description' => '实例数字ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalRecords' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'PageNumbers' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxRecordsPerPage' => ['description' => '分页查询每页最大记录数。取值范围:5~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Logs' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'SqlId' => ['description' => 'SQL模板ID', 'type' => 'string', 'example' => 'sqlId'],
'Scheme' => ['description' => '数据Schema', 'type' => 'string', 'example' => 'HTTPS'],
'SubInstanceId' => ['description' => '子实例ID。', 'type' => 'string', 'example' => 'r-8vb219d10038****'],
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2zebg30mk056g****'],
'InsName' => ['description' => '实例名字', 'type' => 'string', 'example' => 'test'],
'AccountName' => ['description' => '用户。', 'type' => 'string', 'example' => 'user1'],
'HostAddress' => ['description' => '来源。', 'type' => 'string', 'example' => '192.168.1.1'],
'QueryStartTime' => ['description' => '查询开始的时间。格式:yyyy-MM-dd hh:mm:ss(UTC时间)。', 'type' => 'string', 'example' => '2024-04-01 11:00:00'],
'SQLText' => ['description' => 'sql文本。', 'type' => 'string', 'example' => 'SELECT * FROM my_table WHERE ROWNUM <= 10'],
'Psql' => ['description' => 'SQL模板。', 'type' => 'string', 'example' => 'SELECT * FROM my_table WHERE ROWNUM <= 10'."\n"],
'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'test'],
'QueryTime' => ['description' => '查询耗时。', 'type' => 'integer', 'format' => 'int64', 'example' => '121'],
'ReturnItemNumbers' => ['description' => '返回项目编号。', 'type' => 'string', 'example' => 'test'],
'DocsExamined' => ['description' => 'MongoDB该操作执行时扫描的文档数。', 'type' => 'string', 'example' => '100'],
'KeysExamined' => ['description' => 'MongoDB 索引扫描行数。', 'type' => 'string', 'example' => 'valueA'],
'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'tableNameExample'],
'LockTime' => ['description' => '锁等待时间。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
'RowsExamined' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RowsSent' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'ThreadId' => ['title' => '仅 PolarDB MySQL 有thread_id', 'description' => '线程ID。', 'type' => 'string', 'example' => '57472578'],
'Timestamp' => ['description' => '时间戳。', 'type' => 'integer', 'format' => 'int64', 'example' => '1747118812'],
'SqlTag' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'SqlId' => ['description' => 'sqlid。', 'type' => 'string', 'example' => '8ad7069f236bcdaaa9b3ae4b6299****'],
'Tags' => ['description' => '逗号分隔的多个tag。', 'type' => 'string', 'example' => 'DAS_IMPORTANT,DAS_IN_PLAN'],
'Comments' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'test'],
],
],
'LockTimeSeconds' => ['description' => '锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
'QueryTimeSeconds' => ['description' => '查询耗时,单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
'SqlType' => ['description' => '选择SQL的类型。'."\n"
.'- **SELECT**'."\n"
.'- **UPDATE**'."\n"
.'- **DELETE**', 'type' => 'string', 'example' => 'SELECT'],
'CPUTime' => ['description' => 'CPU 查询时间。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '50'],
'IOWrites' => ['description' => 'I/O 写次数。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'LastRowsCountAffected' => ['description' => '最后一条语句的影响行数。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'LogicalIOReads' => ['description' => '逻辑读次数。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PhysicalIOReads' => ['description' => '物理读次数。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'RowsCountAffected' => ['description' => '影响的行数。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Command' => ['description' => '慢查询语句。'."\n"
.'>仅云数据库 Tair(兼容 Redis)实例支持。', 'type' => 'string', 'example' => 'SELECT'],
'Namespace' => ['description' => '命名空间。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'pro-test'],
'QueryId' => ['description' => 'Query ID。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'sq-1pzcdMwRb'],
'ReturnNum' => ['description' => '返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => '20'],
'ApplicationName' => ['description' => '应用名。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'string', 'example' => 'MyApp'],
'CPUTimeSeconds' => ['description' => 'CPU 查询时间,单位秒。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
'Rows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'Frows' => ['description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Scnt' => ['description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TraceId' => ['description' => 'PolarDB-X 2.0的跟踪ID,即SQL在数据节点的执行ID。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'string', 'example' => '074ce334-5247-40b9-b0c1-158aea5d****'],
'TemplateId' => ['description' => 'PolarDB-X 2.0 模板ID。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'string', 'example' => '6a63b6ac4572abfaef7d1163f684****'],
'NodeId' => ['type' => 'string'],
'Cmd' => ['type' => 'string'],
'Rt' => ['type' => 'integer', 'format' => 'int64'],
'RequestSize' => ['type' => 'integer', 'format' => 'int64'],
'ResponseSize' => ['type' => 'integer', 'format' => 'int64'],
'ClientIp' => ['type' => 'string'],
'DbId' => ['type' => 'string'],
'OriginTime' => ['type' => 'string'],
'OpType' => ['type' => 'string'],
'Fail' => ['type' => 'string'],
'Params' => ['type' => 'string'],
'Reason' => ['type' => 'string'],
'ReqId' => ['type' => 'string'],
'ExtText' => ['type' => 'string'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '慢日志记录查询',
'summary' => '本接口用于查询数据库实例的慢日志记录,支持按多种条件过滤和排序。',
'description' => '- `InstanceId` 为实例ID,必填参数。'."\n"
.'- `StartTime` 和 `EndTime` 为查询的时间范围,必填参数。'."\n"
.'- 可以通过设置 `PageNumber` 和 `PageSize` 来分页获取结果。'."\n"
.'- 支持通过 `OrderBy` 参数对结果进行排序,具体可排序字段请参考文档。'."\n"
.'- 使用 `Filters` 参数可以进一步细化查询条件,如按主机地址、SQL ID等过滤。'."\n"
.'<notice>某些数据库类型(如pg和polarPG)不支持特定的排序方式,请根据实际情况选择合适的参数。</notice>',
'requestParamsDescription' => '**Key**支持的参数和取值:'."\n"
.'- **RDS MySQL、PolarDB MySQL、RDS PostgreSQL、PolarDB PostgreSQL版**'."\n"
.' - hostAddress:来源,多个使用逗号分隔。'."\n"
.' - sqlId:SqlID,多个使用逗号分隔。'."\n"
.' - user:用户,多个使用逗号分隔。'."\n"
.' - dbName:数据库名称,多个使用逗号分隔。'."\n"
.' - tags:标签,多个使用逗号分隔。'."\n"
.'- **MongoDB**'."\n"
.' - hostInsId:角色ID,多个使用逗号分隔。'."\n"
.' - insRole:实例角色,多个使用逗号分隔。'."\n"
.' - opType:操作类型,多个使用逗号分隔。'."\n"
.' - namespace:命名空间,多个使用逗号分隔。'."\n"
.' - nodeType:组件类型,多个使用逗号分隔。'."\n"
.' - queryId:查询ID,多个使用逗号分隔。'."\n"
.'- **云数据库Tair(兼容redis)**'."\n"
.' - hostAddress:来源。'."\n"
.' - user:用户。'."\n"
.' - dbName:数据库。'."\n"
.' - nodeType:节点类型。'."\n"
.'- **RDS SQL Server**'."\n"
.' - hostAddress:来源,多个使用逗号分隔。'."\n"
.' - sqlId:SqlID,多个使用逗号分隔。'."\n"
.' - user:用户,多个使用逗号分隔。'."\n"
.' - dbName:数据库,多个使用逗号分隔。'."\n"
.' - tags:标签,多个使用逗号分隔。'."\n"
.'- **PolarDB-X**'."\n"
.' - traceId:实例的跟踪 ID。'."\n"
.' - role:节点角色,取值CN或DN(计算节点/存储节点),必传。'."\n"
.' - hostAddress:来源,多个使用逗号分隔。'."\n"
.' - sqlId:SqlID,多个使用逗号分隔。'."\n"
.' - user:user,多个使用逗号分隔。'."\n"
.' - dbName:数据库,多个使用逗号分隔。'."\n"
.' - tags:标签,多个使用逗号分隔。'."\n"
.'> - SQL引擎支持根据sqlId查询数据,且sqlId支持逗号分隔传入多个,最多20个。'."\n"
.'> - MongoDB支持根据queryId查询数据,且queryId支持逗号分隔传入多个,最多20个。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSlowLogRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"A1C79EE2-D04D-571B-8C60-961FAF8E****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"DbInstanceName\\": \\"rm-bp157g54vy772****\\",\\n \\"NodeId\\": \\"node123\\",\\n \\"ItemsNumbers\\": 10,\\n \\"StartTime\\": \\"1672531200000\\",\\n \\"EndTime\\": \\"1672617600000\\",\\n \\"DbInstanceId\\": 100,\\n \\"TotalRecords\\": 100,\\n \\"PageNumbers\\": 1,\\n \\"MaxRecordsPerPage\\": 20,\\n \\"Logs\\": [\\n {\\n \\"SqlId\\": \\"sqlId\\",\\n \\"Scheme\\": \\"HTTPS\\",\\n \\"SubInstanceId\\": \\"r-8vb219d10038****\\",\\n \\"DbInstanceName\\": \\"rm-2zebg30mk056g****\\",\\n \\"InsName\\": \\"test\\",\\n \\"AccountName\\": \\"user1\\",\\n \\"HostAddress\\": \\"192.168.1.1\\",\\n \\"QueryStartTime\\": \\"2024-04-01 11:00:00\\",\\n \\"SQLText\\": \\"SELECT * FROM my_table WHERE ROWNUM <= 10\\",\\n \\"Psql\\": \\"SELECT * FROM my_table WHERE ROWNUM <= 10\\\\n\\",\\n \\"DBName\\": \\"test\\",\\n \\"QueryTime\\": 121,\\n \\"ReturnItemNumbers\\": \\"test\\",\\n \\"DocsExamined\\": \\"100\\",\\n \\"KeysExamined\\": \\"valueA\\",\\n \\"TableName\\": \\"tableNameExample\\",\\n \\"LockTime\\": 100,\\n \\"RowsExamined\\": 100,\\n \\"RowsSent\\": 10,\\n \\"ThreadId\\": \\"57472578\\",\\n \\"Timestamp\\": 1747118812,\\n \\"SqlTag\\": {\\n \\"SqlId\\": \\"8ad7069f236bcdaaa9b3ae4b6299****\\",\\n \\"Tags\\": \\"DAS_IMPORTANT,DAS_IN_PLAN\\",\\n \\"Comments\\": \\"test\\"\\n },\\n \\"LockTimeSeconds\\": 100,\\n \\"QueryTimeSeconds\\": 100,\\n \\"SqlType\\": \\"SELECT\\",\\n \\"CPUTime\\": 50,\\n \\"IOWrites\\": 1,\\n \\"LastRowsCountAffected\\": 10,\\n \\"LogicalIOReads\\": 1,\\n \\"PhysicalIOReads\\": 1,\\n \\"RowsCountAffected\\": 10,\\n \\"Command\\": \\"SELECT\\",\\n \\"Namespace\\": \\"pro-test\\",\\n \\"QueryId\\": \\"sq-1pzcdMwRb\\",\\n \\"ReturnNum\\": \\"20\\",\\n \\"ApplicationName\\": \\"MyApp\\",\\n \\"CPUTimeSeconds\\": 100,\\n \\"Rows\\": 20,\\n \\"Frows\\": 10,\\n \\"Scnt\\": 10,\\n \\"TraceId\\": \\"074ce334-5247-40b9-b0c1-158aea5d****\\",\\n \\"TemplateId\\": \\"6a63b6ac4572abfaef7d1163f684****\\",\\n \\"NodeId\\": \\"\\",\\n \\"Cmd\\": \\"\\",\\n \\"Rt\\": 0,\\n \\"RequestSize\\": 0,\\n \\"ResponseSize\\": 0,\\n \\"ClientIp\\": \\"\\",\\n \\"DbId\\": \\"\\",\\n \\"OriginTime\\": \\"\\",\\n \\"OpType\\": \\"\\",\\n \\"Fail\\": \\"\\",\\n \\"Params\\": \\"\\",\\n \\"Reason\\": \\"\\",\\n \\"ReqId\\": \\"\\",\\n \\"ExtText\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeSlowLogStatistic' => [
'summary' => '慢日志统计信息。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '236526',
'abilityTreeNodes' => ['FEATUREhdmR88NLD'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'- 对于RDS MySQL和PolarDB MySQL版,该参数仅适用于集群版实例。若不传该参数,默认查询主节点日志明细。'."\n"
.'- 对于PolarDB-X 2.0,该参数传入**polarx_cn**(计算节点)或**polarx_dn**(数据节点)。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
[
'name' => 'Type',
'in' => 'formData',
'schema' => [
'description' => '任务类型:'."\n"
."\n"
.'SQL引擎特有:'."\n"
."\n"
.'**SlowLogRequestOrigin**:通过来源IP聚合日志。'."\n"
."\n"
.'**SlowLogRequestUser**:通过来源USER聚合日志。'."\n"
."\n"
.'**SQL**:通过SQLID聚合日志。'."\n"
."\n\n"
.'MongoDB引擎特有:'."\n"
."\n"
.'**SlowLogRequestOrigin**:通过来源IP聚合日志。'."\n"
."\n"
.'**SlowLogRequestUser**:通过来源USER聚合日志。'."\n"
."\n"
.'**SQL**:通过Query ID聚合日志。'."\n"
."\n"
.'**SlowLogRequestOpType**:通过操作类型聚合日志。'."\n"
."\n"
.'**SlowLogRequestNamespace**:通过namespace聚合日志。'."\n"
."\n"
.'Redis引擎特有:'."\n"
."\n"
.'**SlowLogRequestNodeId**:通过nodeId聚合日志。'."\n"
."\n"
.'**SlowLogRequestHostInsId**:通过HostInsId聚合日志。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['SlowLogRequestOrigin' => 'SlowLogRequestOrigin', 'OriginHost' => 'OriginHost', 'SlowLogRequestUser' => 'SlowLogRequestUser', 'SQL' => 'SQL'],
'example' => 'SQL',
],
],
[
'name' => 'TemplateId',
'in' => 'formData',
'schema' => ['description' => '模板ID。', 'type' => 'string', 'required' => false, 'example' => '04ea3310df40c3fa8a6b4854db49f79a'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳(UTC时间),单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1568269711000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳(UTC时间),单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1608888296000'],
],
[
'name' => 'OrderBy',
'in' => 'formData',
'schema' => ['description' => '排序方式,可选为:'."\n"
."\n"
.'**Count**'."\n"
."\n"
.'**QueryTime**'."\n"
."\n"
.'**LockTime**'."\n"
."\n"
.'**RowsExamined**'."\n"
."\n"
.'**RowsSent**', 'type' => 'string', 'required' => false, 'example' => 'count'],
],
[
'name' => 'Asc',
'in' => 'formData',
'schema' => ['description' => '升序排序开关,默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'PageNumber',
'in' => 'formData',
'schema' => ['description' => '查询列表的页码,起始值为1,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'Filters',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '查询筛选条件列表。',
'type' => 'array',
'items' => [
'description' => 'Key支持的参数和取值:'."\n"
."\n"
.'hostAddress:来源,多个逗号分隔。'."\n"
."\n"
.'sqlId:sqlId,多个逗号分隔。'."\n"
."\n"
.'user:用户,多个逗号分隔。'."\n"
."\n"
.'dbName:数据库,多个逗号分隔。'."\n"
."\n"
.'keyWord:关键字,多个空格分隔。'."\n"
."\n"
.'tags:标签,多个逗号分隔。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数', 'type' => 'string', 'required' => false, 'example' => 'KeyWords'],
'Value' => ['description' => '过滤参数的值。', 'type' => 'string', 'required' => false, 'example' => 'select'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '52D540CF-C517-1F57-BB42-9035F96******'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'AsyncResult<DBLogRecords<SlowLogStat>>',
'description' => 'AsyncResult<DBLogRecords<SlowLogStat>>',
'type' => 'object',
'properties' => [
'RequestKey' => ['title' => '请求参数的Key', 'description' => '请求参数的Key。', 'type' => 'string', 'example' => '123456789'],
'ResultId' => ['title' => '结果ID', 'description' => '结果ID。', 'type' => 'string', 'example' => 'async__665ee69612f1627c7fd9f3c85075****'],
'State' => ['title' => '当前状态 (RUNNING: 正在运行, SUCCESS: 成功, FAIL: 失败)', 'description' => '当前状态:'."\n"
."\n"
.'-**RUNNING**:正在运行。'."\n"
."\n"
.'-**SUCCESS**:成功。'."\n"
."\n"
.'-**FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'IsFinish' => ['title' => '是否完成', 'description' => '是否完成。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'title' => '数据',
'description' => '数据。',
'type' => 'object',
'properties' => [
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => '0'],
'NodeId' => ['description' => '节点ID。'."\n"
."\n"
.'对于MongoDB实例,通过该参数指定节点进行空间分析。调用[DescribeRoleZoneInfo](~~123802~~)接口,可以查询MongoDB实例各个节点的详细信息。'."\n"
."\n"
.'- 当传入目标节点的**InsName**(节点ID)时,例如`d-bp1872fa24d5****`,调用该接口分析其对应的Hidden节点。'."\n"
.'- 当传入目标节点的`InsName#RoleId`时,例如`d-bp1872fa24d5****#299****5`,调用该接口分析指定的节点。'."\n"
."\n"
.'><notice>对于MongoDB副本集实例,不传入此参数时,调用该接口会默认分析唯一的Hidden节点。对于MongoDB分片集群实例,推荐传入此参数,指定目标节点。</notice>', 'type' => 'string', 'example' => 'pi-wz99g5rn7w1x8h0sf'],
'ItemsNumbers' => ['description' => '当前页查询日志列表内的Item数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'StartTime' => ['description' => '开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '2024-10-08T02:01:00Z'],
'EndTime' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> 查询任务结束时间需晚于查询任务开始时间。', 'type' => 'string', 'example' => '2024-08-08T02:15:00Z'],
'DbInstanceId' => ['description' => '实例数字ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'rm-k2ja51w7cnusg5a1x'],
'TotalRecords' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
'PageNumbers' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MaxRecordsPerPage' => ['description' => '分页查询每页最大记录数。取值范围:5~100。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Logs' => [
'description' => '操作对象名称。',
'type' => 'array',
'items' => [
'description' => '日志。',
'type' => 'object',
'properties' => [
'Count' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'MaxLockTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'],
'MaxQueryTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'],
'MaxRowsExamined' => ['description' => '最大扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '318613'],
'MaxRowsSent' => ['description' => '最大返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '256'],
'AvgQueryTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'],
'QueryTimeRate' => ['description' => '查询耗时比例。', 'type' => 'number', 'format' => 'double', 'example' => '0.1018'],
'CountRate' => ['description' => '执行次数比例。', 'type' => 'number', 'format' => 'double', 'example' => '0.2034'],
'AvgRowsExamined' => ['description' => '平均扫描行数。', 'type' => 'number', 'format' => 'double', 'example' => '53421.0'],
'OriginAlias' => ['description' => '来源别名。', 'type' => 'string', 'example' => 'order-1'],
'User' => ['description' => '用户。', 'type' => 'string', 'example' => 'user-1'],
'SqlTag' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => 'a3931d8c3a9315dd5ed016d71cf*****'],
'Tags' => ['title' => '逗号分隔的多个tag', 'description' => '逗号分隔的多个tag。', 'type' => 'string', 'example' => 'DAS_IN_PLAN'],
'Comments' => ['description' => '备注。'."\n"
."\n"
.'长度为1~300个字符。', 'type' => 'string', 'example' => 'dba 归档'],
],
],
'Trend' => [
'description' => '慢日志趋势。',
'type' => 'array',
'items' => [
'description' => '慢日志趋势。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1723775362'],
'Value' => ['description' => '过滤参数的值。', 'type' => 'any', 'example' => 'tf-testacc-oos-parameter'],
],
],
],
'Database' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'work-wechat-api'],
'Histogram' => [
'description' => '趋势图数据。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '查询的总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
'Count' => [
'description' => '慢日志数量。',
'type' => 'array',
'items' => ['description' => '慢日志数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
'Ts' => [
'title' => '关系型数据库只使用这个',
'description' => '执行时间戳。',
'type' => 'array',
'items' => ['description' => '事件发生的时间,使用UNIX时间戳表示,单位:秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715220818'],
],
'TsEnd' => [
'description' => '已废弃。',
'type' => 'array',
'items' => ['description' => '已废弃。', 'type' => 'integer', 'format' => 'int64', 'example' => '-'],
],
'Item' => [
'description' => '任务状态。',
'type' => 'array',
'items' => [
'description' => '错误码信息。',
'type' => 'object',
'properties' => [
'NodeId' => ['description' => '节点id。', 'type' => 'string', 'example' => 'r-bp1s1m8hwzrm77kfvz-db-0'],
'Count' => [
'description' => '慢日志数量。',
'type' => 'array',
'items' => ['description' => 'Key的元素个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
],
],
],
],
'Rt' => [
'description' => '执行耗时,单位为秒。',
'type' => 'array',
'items' => ['description' => '执行耗时,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '1854'],
],
'AvgRt' => [
'description' => '平均执行耗时。',
'type' => 'array',
'items' => ['description' => '平均执行耗时。', 'type' => 'number', 'format' => 'double', 'example' => '3709'],
],
'MaxRt' => [
'description' => '最大RT,单位ms。',
'type' => 'array',
'items' => ['description' => '最大RT,单位ms。', 'type' => 'number', 'format' => 'double', 'example' => '2516.0'],
],
'LockTime' => [
'description' => '锁等待时间,单位毫秒。',
'type' => 'array',
'items' => ['description' => '锁等待时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '300'],
],
'AvgLockTime' => [
'description' => '平均锁等待时间,单位为秒。',
'type' => 'array',
'items' => ['description' => '平均锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '15'],
],
'MaxLockTime' => [
'description' => '最大锁等待时间,单位为秒。',
'type' => 'array',
'items' => ['description' => '最大锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '1051'],
],
'RowsExamined' => [
'description' => '总扫描行数。'."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。',
'type' => 'array',
'items' => ['description' => '总扫描行数。'."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'integer', 'format' => 'int64', 'example' => '641057'],
],
'AvgRowsExamined' => [
'description' => '平均扫描行数。',
'type' => 'array',
'items' => ['description' => '平均扫描行数。', 'type' => 'number', 'format' => 'double', 'example' => '222189'],
],
'MaxRowsExamined' => [
'description' => '最大扫描行数。',
'type' => 'array',
'items' => ['description' => '最大扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '878511'],
],
'RowsSent' => [
'description' => '返回行数。',
'type' => 'array',
'items' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
],
'AvgRowsSent' => [
'description' => '平均返回行数。',
'type' => 'array',
'items' => ['description' => '平均返回行数。', 'type' => 'number', 'format' => 'double', 'example' => '2.0'],
],
'MaxRowsSent' => [
'description' => '最大返回行数。',
'type' => 'array',
'items' => ['description' => '最大返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '256'],
],
],
],
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => '2dca88762ec6b3812504ab8a4b******'],
'Scheme' => ['description' => 'HTTP或HTTPS。', 'type' => 'string', 'example' => 'HTTP'],
'SubInstanceId' => ['description' => '子实例ID。', 'type' => 'string', 'example' => 'r-8vba51c588ba3a94'],
'DbInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => '0'],
'InsName' => ['description' => '分片名。', 'type' => 'string', 'example' => 'rm-uf6zix1z2jh1y6fe5'],
'AccountName' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'edu_admin'],
'HostAddress' => ['description' => '客户端IP地址。', 'type' => 'string', 'example' => '172.23.142.178'],
'QueryStartTime' => ['description' => '查询开始的时间。格式:yyyy-MM-dd hh:mm:ss(UTC时间)。', 'type' => 'string', 'example' => '2024-12-25T03:00:00Z'],
'SQLText' => ['description' => 'SQL语句详情。', 'type' => 'string', 'example' => 'SELECT \'Hello, World!\' FROM DUAL'],
'Psql' => ['description' => 'SQL模板。', 'type' => 'string', 'example' => 'SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.id DESC'],
'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'member_score'],
'QueryTime' => ['description' => '查询执行时间阈值,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '272.444'],
'ReturnItemNumbers' => ['description' => '返回项目编号。', 'type' => 'string', 'example' => '暂无'],
'DocsExamined' => ['description' => 'MongoDB该操作执行时扫描的文档数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'KeysExamined' => ['description' => 'MongoDB索引扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20000'."\n"],
'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'users\\nifconfig\\n'],
'LockTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'],
'RowsExamined' => ['description' => '总扫描行数。'."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'integer', 'format' => 'int64', 'example' => '2444081'],
'RowsSent' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '772'],
'ThreadId' => ['title' => '仅 PolarDB MySQL 有thread_id', 'description' => '仅 PolarDB MySQL 有thread_id。', 'type' => 'string', 'example' => '1'],
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1708568930'],
'AvgLockTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'],
'AvgRowsSent' => ['description' => '平均返回行数。', 'type' => 'number', 'format' => 'double', 'example' => '2.0'],
'LockTimeSeconds' => ['description' => '锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.0'],
'QueryTimeSeconds' => ['description' => '查询耗时,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '25.472'],
'AvgLockTimeSeconds' => ['description' => '平均锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.0'],
'MaxLockTimeSeconds' => ['description' => '最大锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.0'],
'MaxQueryTimeSeconds' => ['description' => '最大查询耗时,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '14.402'],
'AvgQueryTimeSeconds' => ['description' => '平均查询耗时,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '6.211'],
'SqlType' => ['description' => 'SQL语句的类型。', 'type' => 'string', 'example' => 'LOGIN'],
'QueryId' => ['description' => 'Query ID。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'sq-1pzcdMwRb'],
'NodeType' => ['description' => '节点类型。'."\n"
.'> 目前支持该字段的数据库:云数据库MongoDB版、云数据库 Tair(兼容 Redis)。', 'type' => 'string', 'example' => 'DLNode'],
'HostInsId' => ['description' => '主机实例id。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'mongo-abc123456'],
'InsRole' => ['description' => '实例角色。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => '__system'],
'OpType' => ['description' => '操作类型。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'Insert'],
'Namespace' => ['description' => '命名空间。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'string', 'example' => 'database.collection'],
'AvgKeysExamined' => ['description' => '平均索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '20000'],
'AvgDocExamined' => ['description' => '平均扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'AvgReturnNum' => ['description' => '平均返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
'MaxKeysExamined' => ['description' => '最大索引扫描行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000000'],
'MaxDocExamined' => ['description' => '最大扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000'],
'MaxReturnNum' => ['description' => '最大返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ReturnNum' => ['description' => '返回行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'DocExamined' => ['description' => '扫描文档行数。'."\n"
.'>仅云数据库MongoDB版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000000'],
'Command' => ['description' => '慢查询语句。'."\n"
.'>仅云数据库 Tair(兼容 Redis)实例支持。', 'type' => 'string', 'example' => 'SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.t? DESC'],
'IOWrites' => ['description' => 'I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'MaxIOWrites' => ['description' => '最大 I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'LastRowsCountAffected' => ['description' => '最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'MaxLastRowsCountAffected' => ['description' => '最大最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'LogicalIOReads' => ['description' => '逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'MaxLogicalIOReads' => ['description' => '最大逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'PhysicalIOReads' => ['description' => '物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'MaxPhysicalIOReads' => ['description' => '最大物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'RowsCountAffected' => ['description' => '影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'MaxRowsCountAffected' => ['description' => '最大影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'CPUTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'],
'AvgCPUTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'."\n"],
'MaxCPUTime' => ['description' => '已废弃。', 'type' => 'number', 'format' => 'double', 'example' => '-'."\n"],
'AvgIOWrites' => ['description' => '平均 I/O 写次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
'AvgLastRowsCountAffected' => ['description' => '平均最后一条语句的影响行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
'AvgLogicalIOReads' => ['description' => '平均逻辑读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
'AvgPhysicalIOReads' => ['description' => '平均物理读次数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
'AvgRowsCountAffected' => ['description' => '平均影响的行数。'."\n"
.'>仅云数据库RDS SQL Server版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
'AvgCPUTimeSeconds' => ['description' => 'CPU 平均查询时间,单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '456'],
'MaxCPUTimeSeconds' => ['description' => 'CPU 最长查询时间,单位秒。', 'type' => 'number', 'format' => 'double', 'example' => '456'],
'CPUTimeSeconds' => ['description' => 'CPU 查询时间,单位秒。'."\n"
."\n"
.'> 仅云数据库 RDS SQL Server 版实例支持。', 'type' => 'number', 'format' => 'double', 'example' => '456'],
'Rows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '105'],
'AvgRows' => ['description' => '平均行数。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'MaxRows' => ['description' => '最大行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Frows' => ['description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'AvgFrows' => ['description' => '平均拉取行数。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'MaxFrows' => ['description' => '最大拉取行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Scnt' => ['description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。'."\n"
."\n"
.'> 仅云数据库 PolarDB-X 2.0 版实例支持。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'AvgScnt' => ['description' => '平均请求数。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'MaxScnt' => ['description' => '最大请求数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'RuleId' => ['description' => '规则ID,具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'example' => '181**47'],
'AvgRt' => ['description' => '平均执行耗时。', 'type' => 'number', 'format' => 'double'],
'MaxRt' => ['description' => '最大执行耗时,单位秒。', 'type' => 'number', 'format' => 'double'],
'AvgRequestSize' => ['description' => '平均请求长度,单位字节(仅 Redis 有效)。', 'type' => 'number', 'format' => 'double'],
'MaxRequestSize' => ['description' => '最大请求长度,单位字节(仅 Redis 有效)。', 'type' => 'number', 'format' => 'double'],
'AvgResponseSize' => ['description' => '平均响应长度,单位字节(仅 Redis 有效)。', 'type' => 'number', 'format' => 'double'],
'MaxResponseSize' => ['description' => '最大响应长度,单位字节(仅 Redis 有效)。', 'type' => 'number', 'format' => 'double'],
'TotalCount' => ['description' => '总的记录数(仅 Redis 引擎有效)', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Cmd' => ['description' => '执行的命令(仅 Redis 有效)', 'type' => 'string', 'example' => 'systemctl restart nginx.service'],
'ClientIp' => ['description' => '查询中的客户端IP地址', 'type' => 'string', 'example' => '10.57.84.109'],
'DbId' => ['description' => '数据库ID(仅 Redis 有效)', 'type' => 'string', 'example' => '0'],
],
],
],
],
],
'ErrorCode' => ['title' => '错误码', 'description' => '错误码。', 'type' => 'integer', 'format' => 'int32', 'example' => '10910'],
'Message' => ['title' => '错误信息', 'description' => '错误信息。', 'type' => 'string', 'example' => 'Successful'],
'Timestamp' => ['title' => '请求时间', 'description' => '请求时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1735104224250'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"52D540CF-C517-1F57-BB42-9035F96******\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"RequestKey\\": \\"123456789\\",\\n \\"ResultId\\": \\"async__665ee69612f1627c7fd9f3c85075****\\",\\n \\"State\\": \\"SUCCESS\\",\\n \\"IsFinish\\": true,\\n \\"Data\\": {\\n \\"DbInstanceName\\": \\"0\\",\\n \\"NodeId\\": \\"pi-wz99g5rn7w1x8h0sf\\",\\n \\"ItemsNumbers\\": 10,\\n \\"StartTime\\": \\"2024-10-08T02:01:00Z\\",\\n \\"EndTime\\": \\"2024-08-08T02:15:00Z\\",\\n \\"DbInstanceId\\": 0,\\n \\"TotalRecords\\": 13,\\n \\"PageNumbers\\": 1,\\n \\"MaxRecordsPerPage\\": 10,\\n \\"Logs\\": [\\n {\\n \\"Count\\": 12,\\n \\"MaxLockTime\\": 0,\\n \\"MaxQueryTime\\": 0,\\n \\"MaxRowsExamined\\": 318613,\\n \\"MaxRowsSent\\": 256,\\n \\"AvgQueryTime\\": 0,\\n \\"QueryTimeRate\\": 0.1018,\\n \\"CountRate\\": 0.2034,\\n \\"AvgRowsExamined\\": 53421,\\n \\"OriginAlias\\": \\"order-1\\",\\n \\"User\\": \\"user-1\\",\\n \\"SqlTag\\": {\\n \\"SqlId\\": \\"a3931d8c3a9315dd5ed016d71cf*****\\",\\n \\"Tags\\": \\"DAS_IN_PLAN\\",\\n \\"Comments\\": \\"dba 归档\\"\\n },\\n \\"Trend\\": [\\n {\\n \\"Timestamp\\": 1723775362,\\n \\"Value\\": \\"tf-testacc-oos-parameter\\"\\n }\\n ],\\n \\"Database\\": \\"work-wechat-api\\",\\n \\"Histogram\\": {\\n \\"Total\\": 7,\\n \\"Count\\": [\\n 100\\n ],\\n \\"Ts\\": [\\n 1715220818\\n ],\\n \\"TsEnd\\": [\\n 0\\n ],\\n \\"Item\\": [\\n {\\n \\"NodeId\\": \\"r-bp1s1m8hwzrm77kfvz-db-0\\",\\n \\"Count\\": [\\n 100\\n ]\\n }\\n ],\\n \\"Rt\\": [\\n 1854\\n ],\\n \\"AvgRt\\": [\\n 3709\\n ],\\n \\"MaxRt\\": [\\n 2516\\n ],\\n \\"LockTime\\": [\\n 300\\n ],\\n \\"AvgLockTime\\": [\\n 15\\n ],\\n \\"MaxLockTime\\": [\\n 1051\\n ],\\n \\"RowsExamined\\": [\\n 641057\\n ],\\n \\"AvgRowsExamined\\": [\\n 222189\\n ],\\n \\"MaxRowsExamined\\": [\\n 878511\\n ],\\n \\"RowsSent\\": [\\n 4\\n ],\\n \\"AvgRowsSent\\": [\\n 2\\n ],\\n \\"MaxRowsSent\\": [\\n 256\\n ]\\n },\\n \\"SqlId\\": \\"2dca88762ec6b3812504ab8a4b******\\",\\n \\"Scheme\\": \\"HTTP\\",\\n \\"SubInstanceId\\": \\"r-8vba51c588ba3a94\\",\\n \\"DbInstanceName\\": \\"0\\",\\n \\"InsName\\": \\"rm-uf6zix1z2jh1y6fe5\\",\\n \\"AccountName\\": \\"edu_admin\\",\\n \\"HostAddress\\": \\"172.23.142.178\\",\\n \\"QueryStartTime\\": \\"2024-12-25T03:00:00Z\\",\\n \\"SQLText\\": \\"SELECT \'Hello, World!\' FROM DUAL\\",\\n \\"Psql\\": \\"SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.id DESC\\",\\n \\"DBName\\": \\"member_score\\",\\n \\"QueryTime\\": 272.444,\\n \\"ReturnItemNumbers\\": \\"暂无\\",\\n \\"DocsExamined\\": 1,\\n \\"KeysExamined\\": 20000,\\n \\"TableName\\": \\"users\\\\\\\\nifconfig\\\\\\\\n\\",\\n \\"LockTime\\": 0,\\n \\"RowsExamined\\": 2444081,\\n \\"RowsSent\\": 772,\\n \\"ThreadId\\": \\"1\\",\\n \\"Timestamp\\": 1708568930,\\n \\"AvgLockTime\\": 0,\\n \\"AvgRowsSent\\": 2,\\n \\"LockTimeSeconds\\": 0,\\n \\"QueryTimeSeconds\\": 25.472,\\n \\"AvgLockTimeSeconds\\": 0,\\n \\"MaxLockTimeSeconds\\": 0,\\n \\"MaxQueryTimeSeconds\\": 14.402,\\n \\"AvgQueryTimeSeconds\\": 6.211,\\n \\"SqlType\\": \\"LOGIN\\",\\n \\"QueryId\\": \\"sq-1pzcdMwRb\\",\\n \\"NodeType\\": \\"DLNode\\",\\n \\"HostInsId\\": \\"mongo-abc123456\\",\\n \\"InsRole\\": \\"__system\\",\\n \\"OpType\\": \\"Insert\\",\\n \\"Namespace\\": \\"database.collection\\",\\n \\"AvgKeysExamined\\": 20000,\\n \\"AvgDocExamined\\": 10000,\\n \\"AvgReturnNum\\": 1,\\n \\"MaxKeysExamined\\": 2000000,\\n \\"MaxDocExamined\\": 1000000,\\n \\"MaxReturnNum\\": 1,\\n \\"ReturnNum\\": 1,\\n \\"DocExamined\\": 2000000,\\n \\"Command\\": \\"SELECT b?.id,b?.t?,b?.id,b?.t? FROM testtb? b? JOIN testtb? b? ON b?.id=b?.id WHERE b?.t? LIKE ? ORDER BY b?.t? DESC\\",\\n \\"IOWrites\\": 1000,\\n \\"MaxIOWrites\\": 1000,\\n \\"LastRowsCountAffected\\": 1000,\\n \\"MaxLastRowsCountAffected\\": 1000,\\n \\"LogicalIOReads\\": 1000,\\n \\"MaxLogicalIOReads\\": 1000,\\n \\"PhysicalIOReads\\": 1000,\\n \\"MaxPhysicalIOReads\\": 1000,\\n \\"RowsCountAffected\\": 1000,\\n \\"MaxRowsCountAffected\\": 1000,\\n \\"CPUTime\\": 0,\\n \\"AvgCPUTime\\": 0,\\n \\"MaxCPUTime\\": 0,\\n \\"AvgIOWrites\\": 1000,\\n \\"AvgLastRowsCountAffected\\": 1000,\\n \\"AvgLogicalIOReads\\": 1000,\\n \\"AvgPhysicalIOReads\\": 1000,\\n \\"AvgRowsCountAffected\\": 1000,\\n \\"AvgCPUTimeSeconds\\": 456,\\n \\"MaxCPUTimeSeconds\\": 456,\\n \\"CPUTimeSeconds\\": 456,\\n \\"Rows\\": 105,\\n \\"AvgRows\\": 10,\\n \\"MaxRows\\": 10,\\n \\"Frows\\": 10,\\n \\"AvgFrows\\": 10,\\n \\"MaxFrows\\": 10,\\n \\"Scnt\\": 10,\\n \\"AvgScnt\\": 10,\\n \\"MaxScnt\\": 10,\\n \\"RuleId\\": \\"181**47\\",\\n \\"AvgRt\\": 0,\\n \\"MaxRt\\": 0,\\n \\"AvgRequestSize\\": 0,\\n \\"MaxRequestSize\\": 0,\\n \\"AvgResponseSize\\": 0,\\n \\"MaxResponseSize\\": 0,\\n \\"TotalCount\\": 0,\\n \\"Cmd\\": \\"systemctl restart nginx.service\\",\\n \\"ClientIp\\": \\"10.57.84.109\\",\\n \\"DbId\\": \\"0\\"\\n }\\n ]\\n },\\n \\"ErrorCode\\": 10910,\\n \\"Message\\": \\"Successful\\",\\n \\"Timestamp\\": 1735104224250\\n }\\n}","type":"json"}]',
'title' => '慢日志统计信息',
'description' => '**请确保在使用该接口前,已充分了解DAS产品的[收费方式和价格](~~156195~~)。**'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
.'- 请求实例已开通智能运维服务。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'该接口异步调用后不会立即返回完整结果,当返回数据中 isFinish 取值为 false 时,请等待 1s 后重新发起调用,直到 isFinish 取值为 true 时,返回完整结果。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlowLogStatistic'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSlowLogStatistic',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSqlLogConfig' => [
'summary' => '调用DescribeSqlLogConfig接口,查询数据库实例的DAS企业版配置信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '198881',
'abilityTreeNodes' => ['FEATUREhdmPGXCEW', 'FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'SqlLogConfig',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'ColdEnable' => ['description' => '是否开启数据冷存储。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'ColdRetention' => ['title' => '冷数据存储周期(不落库),通过 retention - hotRetention 计算', 'description' => '数据冷存储时长,单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
'ColdStartTime' => ['description' => '数据冷存储开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'CollectorVersion' => ['description' => '采集器版本。'."\n"
."\n"
.'- **MYSQL_V0**:MySQL V0版。'."\n"
.'- **MYSQL_V1**:MySQL V1版。'."\n"
.'- **MYSQL_V2**:MySQL V2版。'."\n"
.'- **MYSQL_V3**:MySQL V3版。'."\n"
.'- **PG_V1**:PostgreSQL V1版。'."\n"
.'- **rdspg_v1**:RDS PostgreSQL V1版。'."\n"
.'- **polarpg_v1**:PolarDB PostgreSQL版 V1版。', 'type' => 'string', 'example' => 'MYSQL_V3'],
'HotEnable' => ['description' => '是否开启数据热存储。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'HotRetention' => ['description' => '数据热存储时长,单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'HotStartTime' => ['description' => '数据热存储开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'LogFilter' => ['description' => '预留参数。', 'type' => 'string', 'example' => 'None'],
'RequestEnable' => ['description' => '是否开启SQL洞察。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'RequestStartTime' => ['description' => 'SQL洞察开启时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'RequestStopTime' => ['description' => 'DAS企业版V1到期时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715335200000'],
'Retention' => ['description' => '数据总存储时长,**HotRetention**与**ColdRetention**之和,单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'SqlLogEnable' => ['description' => '是否开启了DAS企业版。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'SqlLogSource' => ['description' => '预留参数。', 'type' => 'string', 'example' => 'None'],
'SqlLogState' => ['description' => '数据迁移状态。'."\n"
."\n"
.'- **FINISH**: 历史数据迁移完成。'."\n"
.'- **RUNNING**: 历史数据迁移中。'."\n"
.'- **FAILURE**: 历史数据迁移失败。', 'type' => 'string', 'example' => 'FINISH'],
'SqlLogVisibleTime' => ['description' => 'DAS企业版开启的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'SupportMigration' => ['description' => '预留参数。', 'type' => 'boolean', 'example' => 'None'],
'SupportVersion' => ['title' => '当前实例支持的数据库版本(不落库)', 'description' => '当前支持的最新DAS企业版版本。'."\n"
.'- **SQL_LOG_V0**:企业版 V0。'."\n"
.'- **SQL_LOG_V1**:企业版 V1。'."\n"
.'- **SQL_LOG_V2**:企业版 V2。'."\n"
.'- **SQL_LOG_V3**:企业版 V3。'."\n"
.'- **SQL_LOG_NOT_ENABLE**:未开启企业版。'."\n"
.'- **SQL_LOG_NOT_SUPPORT**: 不支持企业版。', 'type' => 'string', 'example' => 'SQL_LOG_V3'],
'Version' => ['title' => '当前审计日志的版本', 'description' => '当前开启的DAS企业版版本。'."\n"
.'- **SQL_LOG_V0**:企业版 V0。'."\n"
.'- **SQL_LOG_V1**:企业版 V1。'."\n"
.'- **SQL_LOG_V2**:企业版 V2。'."\n"
.'- **SQL_LOG_V3**:企业版 V3。'."\n"
.'- **SQL_LOG_NOT_ENABLE**:未开启企业版。'."\n"
.'- **SQL_LOG_NOT_SUPPORT**: 不支持企业版。', 'type' => 'string', 'example' => 'SQL_LOG_V3'],
],
],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0A74B755-98B7-59DB-8724-1321B394****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* **true**:执行成功'."\n"
.'* **false**:执行失败', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询DAS企业版配置信息',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'responseParamsDescription' => '对于**SQL_LOG_V0**(企业版 V0)和**SQL_LOG_V1**(企业版 V1) ,其数据存储在CStore中,视为热存储。开通该版本的数据库实例,查询返回结果中`SqlLogEnable = HotEnable = true, Retention = HotRetention, ColdEnable = false, ColdRetention = 0`。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogConfig'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"ColdEnable\\": true,\\n \\"ColdRetention\\": 23,\\n \\"ColdStartTime\\": 1683712800000,\\n \\"CollectorVersion\\": \\"MYSQL_V3\\",\\n \\"HotEnable\\": true,\\n \\"HotRetention\\": 7,\\n \\"HotStartTime\\": 1683712800000,\\n \\"LogFilter\\": \\"None\\",\\n \\"RequestEnable\\": true,\\n \\"RequestStartTime\\": 1683712800000,\\n \\"RequestStopTime\\": 1715335200000,\\n \\"Retention\\": 30,\\n \\"SqlLogEnable\\": true,\\n \\"SqlLogSource\\": \\"None\\",\\n \\"SqlLogState\\": \\"FINISH\\",\\n \\"SqlLogVisibleTime\\": 1683712800000,\\n \\"SupportMigration\\": true,\\n \\"SupportVersion\\": \\"SQL_LOG_V3\\",\\n \\"Version\\": \\"SQL_LOG_V3\\"\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"0A74B755-98B7-59DB-8724-1321B394****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'DescribeSqlLogRecords' => [
'summary' => '调用DescribeSqlLogRecords接口,查询DAS企业版日志明细。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '199697',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['title' => '实例ID', 'description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-2ze8g2am97624****'."\n"],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'- 对于RDS MySQL和PolarDB MySQL版,该参数仅适用于集群版实例。若不传该参数,默认查询主节点日志明细。'."\n"
.'- 对于PolarDB-X 2.0,该参数传入**polarx_cn**(计算节点)或**polarx_dn**(数据节点)。', 'type' => 'string', 'required' => false, 'example' => 'pi-uf6k5f6g3912i****'],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => ['description' => 'PolarDB-X 2.0数据库实例节点的角色。'."\n"
."\n"
.'- **polarx_cn **:计算节点。'."\n"
.'- **polarx_dn **:数据节点。', 'type' => 'string', 'required' => false, 'example' => 'polarx_cn '],
],
[
'name' => 'Filters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '筛选条件列表。',
'type' => 'array',
'items' => [
'description' => '筛选条件。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数。'."\n"
."\n"
.'> 支持的过滤参数及其取值请参考**请求参数补充说明**。', 'type' => 'string', 'required' => false, 'example' => 'keyWords'],
'Value' => ['description' => '过滤参数取值。', 'type' => 'string', 'required' => false, 'example' => 'select'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1608888296000'],
],
[
'name' => 'PageNo',
'in' => 'formData',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页最大记录数,最大支持100,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '根节点或根目录',
'description' => '根节点或根目录',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'SqlLogDetailResult',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'StartTime' => ['description' => '开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596177993000'],
'EndTime' => ['description' => '结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296000'],
'TotalRecords' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Items' => [
'description' => '列表数据',
'type' => 'object',
'properties' => [
'SQLLogRecord' => [
'description' => 'SQL日志数据。',
'type' => 'array',
'items' => [
'description' => 'SQL日志数据。',
'type' => 'object',
'properties' => [
'Ext' => ['description' => '扩展信息字段,备用参数。', 'type' => 'string', 'example' => 'None'],
'ExecuteTime' => ['description' => '执行时间,格式为UTC时间:`yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'example' => '2023-12-07T02:15:32Z'],
'OriginTime' => ['description' => '执行时间戳,格式为Unix时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1701886532000'],
'HostAddress' => ['description' => '客户端IP地址。', 'type' => 'string', 'example' => '11.197.XX.XX'],
'UpdateRows' => ['description' => '更新行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LogicRead' => ['description' => '逻辑读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SqlText' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'select resource_id as cluster_id, tpl_name \\n\\tfrom dbfree_alert_resource_tpl_ref\\n\\twhere user_id=? and type=\'cluster\' group by resource_id, tpl_name'],
'LockTime' => ['description' => '锁等待时间,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ScanRows' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ThreadId' => ['description' => '线程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'None'],
'State' => ['description' => '执行状态。'."\n"
."\n"
.'- **0**:执行成功。'."\n"
.'- **1**:执行失败。', 'type' => 'string', 'example' => '0'],
'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb'],
'SqlType' => ['description' => 'SQL语句的类型。', 'type' => 'string', 'example' => 'select'],
'AccountName' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'testname'],
'PhysicSyncRead' => ['description' => '物理同步读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicAsyncRead' => ['description' => '物理异步读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TrxId' => ['description' => '事务ID。', 'type' => 'string', 'example' => '200000'],
'ReturnRows' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Consume' => ['description' => '执行耗时(us)。', 'type' => 'integer', 'format' => 'int64', 'example' => '58'],
'Vip' => ['description' => '查询链接的endpoint解析地址。', 'type' => 'string', 'example' => '100.115.XX.XX'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-uf6k5f6g3912i****'],
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => 'c67649d4a7fb62c4f8c7a447c52b5b17'],
'UseImciEngine' => ['description' => 'PolarDB MySQL版实例是否使用列存索引。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'string', 'example' => 'true'],
'ParallelQueueTime' => ['description' => 'PolarDB MySQL版实例的并行度。', 'type' => 'string', 'example' => '2'],
'ParallelDegree' => ['description' => 'PolarDB MySQL版实例的并行排队时间,单位为毫秒。', 'type' => 'string', 'example' => '10'],
'Scnt' => ['description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Rows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Frows' => ['description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TraceId' => ['description' => 'PolarDB-X 2.0的跟踪ID,即SQL在数据节点的执行ID。', 'type' => 'string', 'example' => '14c93b7c7bf00000 '],
'PhysicRead' => ['description' => '物理读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CpuTime' => ['description' => 'CPU执行时间,单位为微秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Writes' => ['description' => 'RDS SQL Server引擎的写入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Collection' => ['description' => '预留参数。', 'type' => 'string', 'example' => 'None'],
'TableName' => ['title' => 'SQL日志记录中的表名', 'description' => 'SQL日志记录中的表名', 'type' => 'string', 'example' => 'das'],
'ConnectionId' => ['title' => 'SQL日志记录的连接ID', 'description' => 'SQL日志记录的连接ID', 'type' => 'string', 'example' => 'ld-******'],
'Protocol' => ['title' => 'SQL日志记录的协议类型', 'description' => 'SQL日志记录的协议类型', 'type' => 'string', 'example' => 'MySQL'],
'Params' => ['title' => 'SQL日志记录的参数', 'description' => 'SQL日志记录的参数', 'type' => 'string', 'example' => '[1, "das"]'],
'ClientIp' => ['title' => 'SQL日志记录中的客户端IP'."\n"
.'SQL日志记录中客户端的IP地址', 'description' => 'SQL日志记录中的客户端IP'."\n"
.'SQL日志记录中客户端的IP地址', 'type' => 'string', 'example' => '10.0.0.1xx'],
'ClientPort' => ['title' => '客户端端口号', 'description' => '客户端端口号', 'type' => 'integer', 'format' => 'int64', 'example' => '3306'],
'RowKey' => ['title' => 'SQL日志记录的行键', 'description' => 'SQL日志记录的行键', 'type' => 'string', 'example' => '23'],
'AffectColumns' => ['title' => '受影响的列', 'description' => '受影响的列', 'type' => 'string', 'example' => '["col1"]'],
],
],
],
],
],
'Finish' => ['description' => '任务是否完成。'."\n"
.'- **0**:未完成'."\n"
.'- **1**:已完成'."\n"
."\n"
.'> 当**Finish**返回为0,并且包含**JobId**字段时,说明当前请求为异步请求,无法直接获取返回结果,需要进一步根据**JobId**进行查询。查询时将**JobId**作为**Filters**的输入值,例如:`Filters=[{"Key": "JobId", "Value": "******"}]`。', 'type' => 'string', 'example' => '1'],
'JobId' => ['description' => '异步任务ID。', 'type' => 'string', 'example' => 'MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '(废弃)查询DAS企业版日志明细',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'requestParamsDescription' => '**Key**支持的参数和取值:'."\n"
."\n"
.'- **KeyWords**:关键字,多个关键字间使用空格隔开。'."\n"
.'- **LogicalOperator**:关键字间的逻辑操作,取值为and或or。'."\n"
.'- **AccountName**:用户名,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **dbName**:数据库名称,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **HostAddress**:客户端IP地址,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **MaxConsume**:最大耗时,单位us。'."\n"
.'- **MinConsume**:最小耗时,单位us。'."\n"
.'- **MaxScanRows**:最大扫描行。'."\n"
.'- **MinScanRows**:最小扫描行。'."\n"
.'- **SqlType**:SQL类型,取值select、update、insert或delete。'."\n"
.'- **State**:执行结果,取值0(成功)或1(失败)。'."\n"
.'- **ThreadId**:线程ID。'."\n"
.'- **SortKey**:排序列名称,取值ScanRows(扫描行数)、UpdateRows(更新行数)、Consume(耗时)、ExecuteTime(执行时间)、ReturnRows(返回行数)、LockTime(锁等待时间)、Frows(PolarDB-X 2.0计算节点的拉取行数)、Scnt(PolarDB-X 2.0计算节点的DN请求数)、CpuTime(CPU执行时间)、PhysicalRead(物理读)。'."\n"
.'- **SortMethod**:排序方式,取值DESC(降序)、ASC(升序)。默认为DESC。'."\n"
.'- **TraceId**:PolarDB-X 2.0实例的跟踪ID。'."\n"
.'- **MinRows**:最小更新行数。'."\n"
.'- **MaxRows**:最大更新行数。'."\n"
.'- **MinScnt**:PolarDB-X 2.0计算节点(CN)的DN最小请求数。'."\n"
.'- **MaxScnt**:PolarDB-X 2.0计算节点(CN)的DN最大请求数。'."\n"
.'- **TrxId**:事务ID。'."\n"
.'- **Fail**:错误码。'."\n"
.'- **SqlId**:SQL ID。'."\n"
.'- **JobId**:通过异步任务ID进一步查询返回结果。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogRecords'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"F43E7FB3-CE67-5FFD-A59C-EFD278BCD7BE\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"StartTime\\": 1596177993000,\\n \\"EndTime\\": 1608888296000,\\n \\"TotalRecords\\": 1,\\n \\"Items\\": {\\n \\"SQLLogRecord\\": [\\n {\\n \\"Ext\\": \\"None\\",\\n \\"ExecuteTime\\": \\"2023-12-07T02:15:32Z\\",\\n \\"OriginTime\\": 1701886532000,\\n \\"HostAddress\\": \\"11.197.XX.XX\\",\\n \\"UpdateRows\\": 0,\\n \\"LogicRead\\": 0,\\n \\"SqlText\\": \\"select resource_id as cluster_id, tpl_name \\\\\\\\n\\\\\\\\tfrom dbfree_alert_resource_tpl_ref\\\\\\\\n\\\\\\\\twhere user_id=? and type=\'cluster\' group by resource_id, tpl_name\\",\\n \\"LockTime\\": 0,\\n \\"ScanRows\\": 0,\\n \\"ThreadId\\": 0,\\n \\"State\\": \\"0\\",\\n \\"DBName\\": \\"testdb\\",\\n \\"SqlType\\": \\"select\\",\\n \\"AccountName\\": \\"testname\\",\\n \\"PhysicSyncRead\\": 0,\\n \\"PhysicAsyncRead\\": 0,\\n \\"TrxId\\": \\"200000\\",\\n \\"ReturnRows\\": 0,\\n \\"Consume\\": 58,\\n \\"Vip\\": \\"100.115.XX.XX\\",\\n \\"NodeId\\": \\"pi-uf6k5f6g3912i****\\",\\n \\"SqlId\\": \\"c67649d4a7fb62c4f8c7a447c52b5b17\\",\\n \\"UseImciEngine\\": \\"true\\",\\n \\"ParallelQueueTime\\": \\"2\\",\\n \\"ParallelDegree\\": \\"10\\",\\n \\"Scnt\\": 10,\\n \\"Rows\\": 10,\\n \\"Frows\\": 10,\\n \\"TraceId\\": \\"14c93b7c7bf00000 \\",\\n \\"PhysicRead\\": 0,\\n \\"CpuTime\\": 100,\\n \\"Writes\\": 10,\\n \\"Collection\\": \\"None\\",\\n \\"TableName\\": \\"das\\",\\n \\"ConnectionId\\": \\"ld-******\\",\\n \\"Protocol\\": \\"MySQL\\",\\n \\"Params\\": \\"[1, \\\\\\"das\\\\\\"]\\",\\n \\"ClientIp\\": \\"10.0.0.1xx\\",\\n \\"ClientPort\\": 3306,\\n \\"RowKey\\": \\"23\\",\\n \\"AffectColumns\\": \\"[\\\\\\"col1\\\\\\"]\\"\\n }\\n ]\\n },\\n \\"Finish\\": \\"1\\",\\n \\"JobId\\": \\"MzI4NTZfUUlOR0RBT19DTTlfTlUyMF9NWVNRTF9PREJTX0xWU18zMjg1Nl9teXNxbF9XZWQgTWFyIDA2IDE0OjUwOjQ3IENTVCAyMDI0XzBfMzBfRXhlY3V0ZVRpbWVfREVTQ19XZWQgTWFyIDA2IDE0OjM1OjQ3IENTVCAyMDI0Xw==_1709708406465\\"\\n }\\n}","type":"json"}]',
],
'DescribeSqlLogStatistic' => [
'summary' => '调用DescribeSqlLogStatistic接口,查询DAS企业版的数据统计信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '198879',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* true:执行成功'."\n"
.'* false:执行失败'."\n", 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'SqlLogStatistic',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Timestamp' => ['title' => '时间戳', 'description' => '时间戳,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1712568564928'],
'HotSqlSize' => [
'title' => '热数据量',
'description' => '总的热存储数据,单位字节(Byte)。',
'type' => 'integer',
'format' => 'int64',
'enumValueTitles' => [],
'example' => '1118042',
],
'ColdSqlSize' => ['title' => '冷数据量', 'description' => '总的冷存储数据,单位字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '8585901'],
'ImportSqlSize' => ['title' => '引入量', 'description' => '最近一天该的数据引入量,单位字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '297245'],
'FreeHotSqlSize' => ['description' => '免费的热存储数据,单位字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '297245'],
'FreeColdSqlSize' => ['description' => '免费的冷存储数据,单位字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '5041450'],
'TotalSqlSize' => ['description' => '总存储数据(冷数据+热数据)', 'type' => 'integer', 'format' => 'int64', 'example' => '9703943'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"Timestamp\\": 1712568564928,\\n \\"HotSqlSize\\": 1118042,\\n \\"ColdSqlSize\\": 8585901,\\n \\"ImportSqlSize\\": 297245,\\n \\"FreeHotSqlSize\\": 297245,\\n \\"FreeColdSqlSize\\": 5041450,\\n \\"TotalSqlSize\\": 9703943\\n }\\n}","type":"json"}]',
'title' => '查询DAS企业版数据统计信息',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogStatistic'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSqlLogTask' => [
'summary' => '调用DescribeSqlLogTask接口,查询DAS企业版离线任务详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '213185',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => false, 'example' => 'r-bp1nti25tc7bq5****'."\n"],
],
[
'name' => 'TaskId',
'in' => 'formData',
'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'a4f5c4494dbd6713185d87a97aa53e8'."\n"],
],
[
'name' => 'PageNo',
'in' => 'formData',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页查询每页最大记录数,最大支持100,默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '根节点或根目录',
'description' => '根节点或根目录',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'SqlLogTaskDetail',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Name' => ['title' => '任务名', 'description' => '任务名称。', 'type' => 'string', 'example' => 'SQL audit export 1'],
'TaskId' => ['title' => '任务ID', 'description' => '任务ID。', 'type' => 'string', 'example' => '9a4f5c4494dbd6713185d87a97aa53e8'."\n"],
'TaskType' => ['title' => '任务类型', 'description' => '任务类型。'."\n"
."\n"
.'- **Export**:导出任务。'."\n"
.'- **Query**:查询任务。', 'type' => 'string', 'example' => 'Query'],
'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1681363254423'."\n"],
'Status' => ['title' => '任务状态', 'description' => '任务状态。'."\n"
.'- **INIT**:待调度 。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **FAILED**:失败。'."\n"
.'- **CANCELED**:已取消。'."\n"
.'- **COMPLETED**:完成。'."\n"
.'> 当任务处于**COMPLETED**时,可以查看离线任务的结果。', 'type' => 'string', 'example' => 'COMPLETED'],
'Expire' => ['description' => '任务是否过期。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'."\n"],
'Start' => ['title' => '查询开始时间', 'description' => '查询开始时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1596177993000'."\n"],
'End' => ['title' => '查询结束时间', 'description' => '查询结束时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296000'."\n"],
'Filters' => [
'title' => '过滤条件',
'description' => '过滤条件。',
'type' => 'array',
'items' => [
'description' => '查询筛选条件。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数的名称。'."\n"
.'>支持的过滤参数及其取值请参考**返回参数补充说明**。', 'type' => 'string', 'example' => 'keyWords'."\n"],
'Value' => ['title' => '过滤值', 'description' => '过滤参数的值。', 'type' => 'any', 'example' => 'select'],
],
],
],
'Total' => ['title' => '总条数', 'description' => '任务总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Queries' => [
'title' => '明细列表',
'description' => '离线查询任务结果。'."\n"
.'当TaskType == Query 时才会返回该值。',
'type' => 'array',
'items' => [
'description' => '离线查询任务结果。',
'type' => 'object',
'properties' => [
'Vip' => ['description' => '查询链接的endpoint解析地址。', 'type' => 'string', 'example' => '10.146.XX.XX'],
'NodeId' => ['description' => '子节点ID。', 'type' => 'string', 'example' => 'pi-bp1o58x3ib7e6****'."\n"],
'SqlText' => ['description' => 'SQL语句详情。', 'type' => 'string', 'example' => 'SELECT @@session.transaction_read_only'],
'SqlType' => ['description' => '选择SQL的类型。取值:'."\n"
.'- **SELECT**'."\n"
.'- **UPDATE**'."\n"
.'- **DELETE**', 'type' => 'string', 'example' => 'SELECT'],
'State' => ['description' => '执行结果。'."\n"
."\n"
.'- **0**:执行成功。'."\n"
.'- **1**:执行失败。', 'type' => 'string', 'example' => '0'],
'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb01'],
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => 'a4111670e80596c5bf42cf5154438a91'],
'ExecuteTime' => ['title' => 'yyyy-MM-dd\'T\'HH:mm:ss.SSS\'Z\'', 'description' => '执行时间,格式为UTC时间:`yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'example' => '2023-12-07T02:15:32Z'],
'OriginTime' => ['title' => 'ts unix', 'description' => '执行时间戳,格式为Unix时间,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1701886532000'."\n"],
'AccountName' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'testname'."\n"],
'HostAddress' => ['description' => '客户端IP地址。', 'type' => 'string', 'example' => '11.197.XX.XX'."\n"],
'Consume' => ['description' => '执行耗时,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '58'],
'LockTime' => ['description' => '锁等待时间,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'UpdateRows' => ['description' => '更新行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ScanRows' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ReturnRows' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'LogicRead' => ['description' => '逻辑读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicSyncRead' => ['description' => '物理同步读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicAsyncRead' => ['description' => '物理异步读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ThreadId' => ['description' => '线程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'None'],
'TrxId' => ['description' => '事务ID。', 'type' => 'string', 'example' => '200000'."\n"],
'Ext' => ['description' => '扩展信息字段,备用参数。', 'type' => 'string', 'example' => 'None'],
'Scnt' => ['title' => 'polarx cn节点,dn请求总数', 'description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'."\n"],
'Rows' => ['title' => 'polarx cn节点,总更新/返回行数', 'description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Frows' => ['title' => 'polarx cn节点,拉取行数', 'description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'TraceId' => ['description' => 'PolarDB-X 2.0的跟踪ID,即SQL在数据节点的执行ID。', 'type' => 'string', 'example' => '14c93b7c7bf00000 '],
'UseImciEngine' => ['description' => 'PolarDB MySQL版实例是否使用列存索引。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'string', 'example' => 'true'."\n"],
'ParallelDegree' => ['description' => 'PolarDB MySQL版实例的并行排队时间,单位为毫秒。', 'type' => 'string', 'example' => '10'."\n"],
'ParallelQueueTime' => ['description' => 'PolarDB MySQL版实例的并行度。', 'type' => 'string', 'example' => '2'],
'PhysicRead' => ['description' => '物理读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'CpuTime' => ['description' => 'CPU执行时间,单位为微秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'."\n"],
'Writes' => ['description' => 'RDS SQL Server引擎的写入数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Collection' => ['description' => '预留参数', 'type' => 'string', 'example' => 'None'],
'SqlCommand' => ['title' => '查询中的SQL命令', 'description' => '查询中的SQL命令', 'type' => 'integer', 'format' => 'int64', 'example' => 'sql'],
'ConnectionId' => ['title' => '查询中使用的连接ID', 'description' => '查询中使用的连接ID', 'type' => 'string', 'example' => 'ld-******'],
'Protected' => ['title' => '查询项是否受保护', 'description' => '查询项是否受保护', 'type' => 'string', 'example' => 'MySQL'],
'Params' => ['title' => '查询参数列表', 'description' => '查询参数列表', 'type' => 'string', 'example' => '[1, "das"]'],
'ClientIp' => ['title' => '查询中的客户端IP地址', 'description' => '查询中的客户端IP地址', 'type' => 'string', 'example' => '10.0.0.1xx'],
'ClientPort' => ['title' => '查询中客户端端口号', 'description' => '查询中客户端端口号', 'type' => 'integer', 'format' => 'int64', 'example' => '3306'],
'RowKey' => ['title' => '查询中的行键', 'description' => '查询中的行键', 'type' => 'string', 'example' => '23'],
'AffectColumns' => ['title' => '影响的列', 'description' => '影响的列', 'type' => 'string', 'example' => '["col1"]'],
'TableName' => ['title' => '查询中使用的表名', 'description' => '查询中使用的表名', 'type' => 'string', 'example' => 'das'],
],
],
],
'Export' => ['title' => '导出地址', 'description' => '导出任务的下载地址。当TaskType == Export 时才会返回该值。', 'type' => 'string', 'example' => '"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****"'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"Name\\": \\"SQL audit export 1\\",\\n \\"TaskId\\": \\"9a4f5c4494dbd6713185d87a97aa53e8\\\\n\\",\\n \\"TaskType\\": \\"Query\\",\\n \\"CreateTime\\": 1681363254423,\\n \\"Status\\": \\"COMPLETED\\",\\n \\"Expire\\": true,\\n \\"Start\\": 1596177993000,\\n \\"End\\": 1608888296000,\\n \\"Filters\\": [\\n {\\n \\"Key\\": \\"keyWords\\\\n\\",\\n \\"Value\\": \\"select\\"\\n }\\n ],\\n \\"Total\\": 1,\\n \\"Queries\\": [\\n {\\n \\"Vip\\": \\"10.146.XX.XX\\",\\n \\"NodeId\\": \\"pi-bp1o58x3ib7e6****\\\\n\\",\\n \\"SqlText\\": \\"SELECT @@session.transaction_read_only\\",\\n \\"SqlType\\": \\"SELECT\\",\\n \\"State\\": \\"0\\",\\n \\"DBName\\": \\"testdb01\\",\\n \\"SqlId\\": \\"a4111670e80596c5bf42cf5154438a91\\",\\n \\"ExecuteTime\\": \\"2023-12-07T02:15:32Z\\",\\n \\"OriginTime\\": 1701886532000,\\n \\"AccountName\\": \\"testname\\\\n\\",\\n \\"HostAddress\\": \\"11.197.XX.XX\\\\n\\",\\n \\"Consume\\": 58,\\n \\"LockTime\\": 0,\\n \\"UpdateRows\\": 0,\\n \\"ScanRows\\": 0,\\n \\"ReturnRows\\": 0,\\n \\"LogicRead\\": 0,\\n \\"PhysicSyncRead\\": 0,\\n \\"PhysicAsyncRead\\": 0,\\n \\"ThreadId\\": 0,\\n \\"TrxId\\": \\"200000\\\\n\\",\\n \\"Ext\\": \\"None\\",\\n \\"Scnt\\": 10,\\n \\"Rows\\": 10,\\n \\"Frows\\": 10,\\n \\"TraceId\\": \\"14c93b7c7bf00000 \\",\\n \\"UseImciEngine\\": \\"true\\\\n\\",\\n \\"ParallelDegree\\": \\"10\\\\n\\",\\n \\"ParallelQueueTime\\": \\"2\\",\\n \\"PhysicRead\\": 0,\\n \\"CpuTime\\": 100,\\n \\"Writes\\": 10,\\n \\"Collection\\": \\"None\\",\\n \\"SqlCommand\\": 0,\\n \\"ConnectionId\\": \\"ld-******\\",\\n \\"Protected\\": \\"MySQL\\",\\n \\"Params\\": \\"[1, \\\\\\"das\\\\\\"]\\",\\n \\"ClientIp\\": \\"10.0.0.1xx\\",\\n \\"ClientPort\\": 3306,\\n \\"RowKey\\": \\"23\\",\\n \\"AffectColumns\\": \\"[\\\\\\"col1\\\\\\"]\\",\\n \\"TableName\\": \\"das\\"\\n }\\n ],\\n \\"Export\\": \\"\\\\\\"https://das-sqllog-download-cn-hongkong.oss-cn-hongkong.aliyuncs.com/****\\\\\\"\\"\\n }\\n}","type":"json"}]',
'title' => '查询DAS企业版离线任务详情',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'responseParamsDescription' => '**Key**支持的参数和取值:'."\n"
."\n"
.'- **KeyWords**:关键字,多个关键字间使用空格隔开。'."\n"
.'- **LogicalOperator**:关键字间的逻辑操作,取值为and或or。'."\n"
.'- **AccountName**:用户名,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **dbName**:数据库名称,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **HostAddress**:客户端IP地址,可以传递多个的,用逗号分开,上限为5。'."\n"
.'- **MaxConsume**:最大耗时,单位us。'."\n"
.'- **MinConsume**:最小耗时,单位us。'."\n"
.'- **MaxScanRows**:最大扫描行。'."\n"
.'- **MinScanRows**:最小扫描行。'."\n"
.'- **SqlType**:SQL类型,取值select、update、insert或delete。'."\n"
.'- **State**:执行结果,取值0(成功)或1(失败)。'."\n"
.'- **ThreadId**:线程ID。'."\n"
.'- **SortKey**:排序列名称,取值ScanRows(扫描行数)、UpdateRows(更新行数)、Consume(耗时)、ExecuteTime(执行时间)、ReturnRows(返回行数)、LockTime(锁等待时间)、Frows(PolarDB-X 2.0计算节点的拉取行数)、Scnt(PolarDB-X 2.0计算节点的DN请求数)、CpuTime(CPU执行时间)、PhysicalRead(物理读)。'."\n"
.'- **SortMethod**:排序方式,取值DESC(降序)、ASC(升序)。默认为DESC。'."\n"
.'- **TraceId**:PolarDB-X 2.0实例的跟踪ID。'."\n"
.'- **MinRows**:最小更新行数。'."\n"
.'- **MaxRows**:最大更新行数。'."\n"
.'- **MinScnt**:PolarDB-X 2.0计算节点(CN)的DN最小请求数。'."\n"
.'- **MaxScnt**:PolarDB-X 2.0计算节点(CN)的DN最大请求数。'."\n"
.'- **TrxId**:事务ID。'."\n"
.'- **Fail**:错误码。'."\n"
.'- **SqlId**:SQL ID。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogTask'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeSqlLogTasks' => [
'summary' => '查询实例的审计日志任务列表。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '199696',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => false, 'example' => 'r-bp1nti25tc7bq5****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
.'>该参数仅适用于集群版实例,可以选择查询指定节点离线任务。若不传该参数,默认返回主节点离线任务。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp1o58x3ib7e6****'],
],
[
'name' => 'Filters',
'in' => 'formData',
'style' => 'repeatList',
'schema' => [
'description' => '查询筛选条件列表。',
'type' => 'array',
'items' => [
'description' => '查询筛选条件。',
'type' => 'object',
'properties' => [
'Key' => ['title' => '过滤参数', 'description' => '过滤参数。'."\n"
."\n"
.'> 支持的过滤参数及其取值请参考**请求参数补充说明**。', 'type' => 'string', 'required' => false, 'example' => 'keyWords'],
'Value' => ['description' => '过滤参数的值。', 'type' => 'string', 'required' => false, 'example' => 'select'."\n"],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1608888296000'],
],
[
'name' => 'PageNo',
'in' => 'formData',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '每页最大记录数,最大支持100,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'ListResult<SqlLogTask>',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '返回信息列表。',
'type' => 'array',
'items' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '9a4f5c4494dbd6713185d87a97aa53e8'],
'InstanceId' => ['title' => '实例标识', 'description' => '数据库实例ID。', 'type' => 'string', 'example' => 'r-bp1nti25tc7bq5****'."\n"],
'Name' => ['title' => '任务别名', 'description' => '任务名称。', 'type' => 'string', 'example' => 'SQL audit export 1'],
'Start' => ['title' => '查询开始时间', 'description' => '任务开始时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683859555482'],
'End' => ['title' => '查询结束时间', 'description' => '任务结束时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1705975320000'],
'Status' => ['title' => '任务状态', 'description' => '任务状态。'."\n"
."\n"
.'- **INIT**:待调度 。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **FAILED**:失败。'."\n"
.'- **CANCELED**:已取消。'."\n"
.'- **COMPLETED**:完成。'."\n"
."\n"
.'> 当任务处于**COMPLETED**时,可以查看离线任务的结果。', 'type' => 'string', 'example' => 'RUNNING'],
'LogCount' => ['title' => '日志总数', 'description' => '日志总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '99999'],
'Progress' => ['title' => '任务进度', 'description' => '任务进度。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'ScanFileSize' => ['title' => '扫描的文件量', 'description' => '扫描的文件数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000'],
'Expire' => ['title' => '任务是否过期', 'description' => '任务是否过期。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'CreateTime' => ['title' => '任务创建时间', 'description' => '任务创建时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1681363254423'],
'AnalysisTaskFinishTime' => ['title' => '分析任务完成时间', 'description' => '分析任务完成时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1712751923000'],
'AnalysisTaskStatus' => ['description' => '分析任务状态。'."\n"
."\n"
.'> 系统内部参数,用户无需关注。', 'type' => 'string', 'example' => 'SCAN_ANALYZE_COMPLETED'],
'Result' => ['title' => 'oss链接或其他信息', 'description' => '任务类型为**Export**时的链接地址。', 'type' => 'string', 'example' => 'https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la'],
'TaskType' => ['description' => '任务类型。'."\n"
."\n"
.'- **Export**:导出任务。'."\n"
.'- **Query**:查询任务。', 'type' => 'string', 'example' => 'Export'],
'Filters' => [
'description' => '查询筛选条件列表。',
'type' => 'array',
'items' => [
'description' => '查询筛选条件。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '过滤参数。'."\n"
."\n"
.'> 支持的过滤参数及其取值请参考**请求参数补充说明**。', 'type' => 'string', 'example' => 'keyWords'."\n"],
'Value' => ['description' => '过滤参数的值。', 'type' => 'string', 'example' => 'select'."\n"],
],
],
],
'InnerResult' => ['description' => 'VPC内网地址', 'type' => 'string', 'example' => 'https://das-sqllog-download-oss-cn-shanghai-internal.aliyuncs.com'."\n"
.'/la'],
],
],
],
'Total' => ['description' => '任务数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '40'],
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"9a4f5c4494dbd6713185d87a97aa53e8\\",\\n \\"InstanceId\\": \\"r-bp1nti25tc7bq5****\\\\n\\",\\n \\"Name\\": \\"SQL audit export 1\\",\\n \\"Start\\": 1683859555482,\\n \\"End\\": 1705975320000,\\n \\"Status\\": \\"RUNNING\\",\\n \\"LogCount\\": 99999,\\n \\"Progress\\": 100,\\n \\"ScanFileSize\\": 3000,\\n \\"Expire\\": false,\\n \\"CreateTime\\": 1681363254423,\\n \\"AnalysisTaskFinishTime\\": 1712751923000,\\n \\"AnalysisTaskStatus\\": \\"SCAN_ANALYZE_COMPLETED\\",\\n \\"Result\\": \\"https://das-sqllog-download-cn-shanghai.oss-cn-shanghai.aliyuncs.com/la\\",\\n \\"TaskType\\": \\"Export\\",\\n \\"Filters\\": [\\n {\\n \\"Key\\": \\"keyWords\\\\n\\",\\n \\"Value\\": \\"select\\\\n\\"\\n }\\n ],\\n \\"InnerResult\\": \\"https://das-sqllog-download-oss-cn-shanghai-internal.aliyuncs.com\\\\n/la\\"\\n }\\n ],\\n \\"Total\\": 40,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]',
'title' => '查询DAS企业版离线任务列表',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'requestParamsDescription' => '**Key**支持的参数和取值:'."\n"
."\n"
.'- **taskId**:任务ID。'."\n"
.'- **keyWords**:任务名。'."\n"
.'- **status**:状态筛选,取值INIT(待调度)、RUNNING(运行中)、FAILED(失败)、CANCELED(已取消)、COMPLETED(完成)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogTasks'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'DescribeTopBigKeys' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTQGIFY'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Redis实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> - 查询任务结束时间需晚于查询任务开始时间。'."\n"
.'> - 仅支持最大查询时间范围为4天内的数据。'."\n"
.'> - **StartTime**和**EndTime**最大查询间隔为3小时内。', 'type' => 'string', 'required' => true, 'example' => '1596177993001'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BigKey' => [
'description' => '大Key详细信息列表。'."\n"
."\n"
.'> 查询时间段内没有大Key时,返回为空。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'Db' => ['description' => 'Key所在的DB。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'KeyType' => ['description' => 'Key的类型。', 'type' => 'string', 'example' => 'zset'],
'Size' => ['description' => '元素的个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'NodeId' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
],
'description' => '',
],
],
],
'description' => '',
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => ' 获取排名前100的大Key',
'summary' => '调用DescribeTopBigKeys接口,获取一段时间内排名前100的大Key。',
'description' => '对数据结构为List、Hash、Set、Zset的Key,按照Key中元素的数量排序并展示排名前3的Key,记录为大Key。'."\n"
."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.2或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口只适用于如下Redis实例:'."\n"
.' - 实例为Redis开源版或Tair(企业版)内存型。'."\n"
.' - 实例的小版本为最新。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTopBigKeys'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeTopBigKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"BigKey\\": [\\n {\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"Db\\": 0,\\n \\"KeyType\\": \\"zset\\",\\n \\"Size\\": 2,\\n \\"NodeId\\": \\"r-x****-db-0\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTopBigKeysResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <Key>abc:def:eng</Key>\\n <Db>0</Db>\\n <KeyType>zset</KeyType>\\n <Size>2</Size>\\n <NodeId>r-x****-db-0</NodeId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeTopBigKeysResponse>","errorExample":""}]',
],
'DescribeTopHotKeys' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmROFBLE'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => 'Redis实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp18ff4a195d****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'required' => false, 'example' => 'r-****-db-0'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> - 查询任务结束时间需晚于查询任务开始时间。'."\n"
.'> - 仅支持最大查询时间范围为4天内的数据。'."\n"
.'> - **StartTime**和**EndTime**最大查询间隔为3小时内。', 'type' => 'string', 'required' => true, 'example' => '1596177993001'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'HotKey' => [
'description' => '热Key详细信息列表。',
'type' => 'array',
'items' => [
'description' => '热key详细信息列表。',
'type' => 'object',
'properties' => [
'Db' => ['description' => 'Key所在的DB。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Key' => ['description' => '具体的Key。', 'type' => 'string', 'example' => 'abc:def:eng'],
'Hot' => ['description' => 'Key的访问频次,即Key的每秒访问数。', 'type' => 'string', 'example' => '5500~6000'],
'KeyType' => ['description' => 'Key类型。', 'type' => 'string', 'example' => 'zset'],
'Lfu' => ['description' => 'LFU算法的统计值。', 'type' => 'integer', 'format' => 'int32', 'example' => '253'],
'NodeId' => ['description' => 'Redis实例的数据分片ID。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'InBytes' => ['description' => '入流量,单位Byte。仅按流量统计的热 Key 返回。', 'type' => 'integer', 'format' => 'int64', 'example' => '4502693'],
'OutBytes' => ['description' => '出流量,单位Byte。仅按流量统计的热 Key 返回。', 'type' => 'integer', 'format' => 'int64', 'example' => '1291659'],
'Category' => ['description' => '热Key类别:'."\n"
.'- **qps**:按QPS统计的热Key。'."\n"
.'- **traffic**:按流量统计的热Key。', 'type' => 'string', 'example' => 'qps'],
],
],
],
],
'description' => '',
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取排名前100的热Key',
'summary' => '调用DescribeTopHotKeys接口,获取一段时间内排名前100的热Key。',
'description' => '当某个Key的QPS大于3,000时会被记录为热点Key。'."\n"
."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.2或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口只适用于如下Redis实例:'."\n"
.' - 实例为Redis开源版或Tair(企业版)内存型。'."\n"
.' - 实例的小版本为最新。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTopHotKeys'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeTopHotKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"HotKey\\": [\\n {\\n \\"Db\\": 0,\\n \\"Key\\": \\"abc:def:eng\\",\\n \\"Hot\\": \\"5500~6000\\",\\n \\"KeyType\\": \\"zset\\",\\n \\"Lfu\\": 253,\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"InBytes\\": 4502693,\\n \\"OutBytes\\": 1291659,\\n \\"Category\\": \\"qps\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTopHotKeysResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <Db>0</Db>\\n <Key>abc:def:eng</Key>\\n <Hot>5500~6000</Hot>\\n <KeyType>zset</KeyType>\\n <Lfu>253</Lfu>\\n <NodeId>r-x****-db-0</NodeId>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DescribeTopHotKeysResponse>","errorExample":""}]',
],
'DisableAllSqlConcurrencyControlRules' => [
'summary' => '调用DisableAllSqlConcurrencyControlRules接口,关闭全部正在执行的限流规则。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL和 PolarDB MySQL版实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => ' 关闭全部正在执行的限流规则',
'description' => '本接口适用的数据库引擎为:'."\n"
.'- RDS MySQL'."\n"
.'- PolarDB MySQL版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAllSqlConcurrencyControlRules'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:DisableAllSqlConcurrencyControlRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"None\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableAllSqlConcurrencyControlRulesResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</DisableAllSqlConcurrencyControlRulesResponse>","errorExample":""}]',
],
'DisableAutoResourceOptimizeRules' => [
'summary' => '调用DisableAutoResourceOptimizeRules接口,批量关闭指定数据库实例的空间碎片自动回收功能。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTFSOG0'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n"
.'> 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。', 'type' => 'string', 'required' => true, 'example' => '[\'rm-2ze8g2am97624****\',\'rm-2ze9xrhze0709****\']'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'TotalInstanceCount' => ['description' => '总数据库实例ID数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ConfigSuccessInstanceCount' => ['description' => '关闭空间碎片自动回收功能成功的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigFailInstanceCount' => ['description' => '关闭空间碎片自动回收功能失败的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigSuccessInstanceList' => [
'description' => '关闭空间碎片自动回收功能成功的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '关闭设置是否成功:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
],
'description' => '',
],
],
'ConfigFailInstanceList' => [
'description' => '关闭空间碎片自动回收功能失败的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '关闭设置是否成功:'."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze9xrhze0709****'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'cannot found instance by rm-2ze9xrhze0709****'],
],
'description' => '',
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。'."\n", 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关闭空间碎片自动回收功能',
'description' => '在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAutoResourceOptimizeRules'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:DisableAutoResourceOptimizeRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TotalInstanceCount\\": 2,\\n \\"ConfigSuccessInstanceCount\\": 1,\\n \\"ConfigFailInstanceCount\\": 1,\\n \\"ConfigSuccessInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": true,\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\"\\n }\\n ],\\n \\"ConfigFailInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": false,\\n \\"InstanceId\\": \\"rm-2ze9xrhze0709****\\",\\n \\"ErrorMessage\\": \\"cannot found instance by rm-2ze9xrhze0709****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DisableAutoResourceOptimizeRulesResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <TotalInstanceCount>2</TotalInstanceCount>\\n <ConfigSuccessInstanceCount>1</ConfigSuccessInstanceCount>\\n <ConfigFailInstanceCount>1</ConfigFailInstanceCount>\\n <ConfigSuccessInstanceList>\\n <ConfigSuccess>true</ConfigSuccess>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n </ConfigSuccessInstanceList>\\n <ConfigFailInstanceList>\\n <ConfigSuccess>false</ConfigSuccess>\\n <InstanceId>rm-2ze9xrhze0709****</InstanceId>\\n <ErrorMessage>cannot found instance by rm-2ze9xrhze0709****</ErrorMessage>\\n </ConfigFailInstanceList>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</DisableAutoResourceOptimizeRulesResponse>","errorExample":""}]',
],
'DisableAutoThrottleRules' => [
'summary' => '调用DisableAutoThrottleRules接口,批量关闭指定数据库实例的自动SQL限流功能。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmDSULQV'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n"
.'> 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。', 'type' => 'string', 'required' => true, 'example' => '[\'rm-2ze8g2am97624****\',\'rm-2ze9xrhze0709****\']'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'TotalInstanceCount' => ['description' => '总数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ConfigSuccessInstanceCount' => ['description' => '关闭自动SQL限流功能成功的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigFailInstanceCount' => ['description' => '关闭自动SQL限流功能失败的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigSuccessInstanceList' => [
'description' => '关闭自动SQL限流功能成功的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '关闭设置是否成功:'."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
],
'description' => '',
],
],
'ConfigFailInstanceList' => [
'description' => '关闭自动SQL限流功能失败的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '关闭设置是否成功:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze9xrhze0709****'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'cannot found instance by rm-2ze9xrhze0709****'],
],
'description' => '',
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '关闭自动SQL限流功能',
'description' => '在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAutoThrottleRules'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:DisableAutoThrottleRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TotalInstanceCount\\": 2,\\n \\"ConfigSuccessInstanceCount\\": 1,\\n \\"ConfigFailInstanceCount\\": 1,\\n \\"ConfigSuccessInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": true,\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\"\\n }\\n ],\\n \\"ConfigFailInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": false,\\n \\"InstanceId\\": \\"rm-2ze9xrhze0709****\\",\\n \\"ErrorMessage\\": \\"cannot found instance by rm-2ze9xrhze0709****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DisableAutoThrottleRulesResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <TotalInstanceCount>2</TotalInstanceCount>\\n <ConfigSuccessInstanceCount>1</ConfigSuccessInstanceCount>\\n <ConfigFailInstanceCount>1</ConfigFailInstanceCount>\\n <ConfigSuccessInstanceList>\\n <ConfigSuccess>true</ConfigSuccess>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n </ConfigSuccessInstanceList>\\n <ConfigFailInstanceList>\\n <ConfigSuccess>false</ConfigSuccess>\\n <InstanceId>rm-2ze9xrhze0709****</InstanceId>\\n <ErrorMessage>cannot found instance by rm-2ze9xrhze0709****</ErrorMessage>\\n </ConfigFailInstanceList>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</DisableAutoThrottleRulesResponse>","errorExample":""}]',
],
'DisableDasPro' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。'."\n"
."\n"
.'> 非必填,输入目标数据库实例ID后,在调用API接口时,系统会自动获取用户ID。', 'type' => 'string', 'required' => false, 'example' => '196278346919****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Synchro' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Data' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
['errorCode' => '-1020004', 'errorMessage' => 'the dbconfig is applying', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '关闭DAS企业版 V1',
'summary' => '关闭指定实例DAS专业版。',
'description' => '- 目前支持的数据库实例请参见[DAS企业版使用说明](~~190912~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 该接口仅适用于DAS企业版 V1。'."\n"
.'>推荐使用[ModifySqlLogConfig](~~2778835~~)接口,为实例开启或关闭DAS企业版。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDasPro'],
],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DisableDasPro',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Synchro\\": \\"None\\",\\n \\"Data\\": \\"None\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableDasProResponse>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Message>Successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DisableDasProResponse>","errorExample":""}]',
],
'DisableInstanceDasConfig' => [
'summary' => '调用DisableInstanceDasConfig接口,关闭指定弹性伸缩功能。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-bp1nti25tc7bq5****'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,当前仅支持Redis。', 'type' => 'string', 'required' => true, 'example' => 'Redis'],
],
[
'name' => 'ScaleType',
'in' => 'query',
'schema' => [
'description' => '弹性伸缩类型,取值:'."\n"
.'- **specScale**:规格自动弹性伸缩。'."\n"
.'- **shardScale**:分片自动弹性伸缩。'."\n"
.'- **bandwidthScale**:带宽自动弹性伸缩。',
'type' => 'string',
'required' => true,
'example' => 'bandwidthScale',
'enum' => ['specScale', 'shardScale', 'bandwidthScale'],
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '关闭数据库实例指定弹性伸缩功能的结果。', 'type' => 'string', 'example' => 'success'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* **true**:执行成功。'."\n"
.'* **false**:执行失败。'."\n", 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '关闭指定弹性伸缩功能',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口当前仅适用于Redis数据库实例。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInstanceDasConfig'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:DisableInstanceDasConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableInstanceDasConfigResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>success</Data>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Success>true</Success>\\n</DisableInstanceDasConfigResponse>","errorExample":""}]',
],
'DisableSqlConcurrencyControl' => [
'summary' => '调用DisableSqlConcurrencyControl接口,关闭指定限流规则。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL和PolarDB MySQL版实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'ItemId',
'in' => 'query',
'schema' => ['description' => '当前实例限流规则ID,可调用[GetRunningSqlConcurrencyControlRules](~~223538~~)接口获取。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '详细信息列表,包括信息总数、错误码等。', 'type' => 'string', 'example' => 'Null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '关闭指定限流规则',
'description' => '本接口适用的数据库引擎为:'."\n"
.'- RDS MySQL'."\n"
.'- PolarDB MySQL版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlConcurrencyControl'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:DisableSqlConcurrencyControl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"Null\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<DisableSqlConcurrencyControlResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>Null</Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</DisableSqlConcurrencyControlResponse>","errorExample":""}]',
],
'EnableDasPro' => [
'summary' => '开启指定实例DAS专业版。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '23825',
'abilityTreeNodes' => ['FEATUREhdm543Z01'],
],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。'."\n"
."\n"
.'> 非必填,输入目标数据库实例ID后,在调用API接口时,系统会自动获取用户ID。', 'type' => 'string', 'required' => false, 'example' => '196278346919****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'SqlRetention',
'in' => 'query',
'schema' => ['description' => 'SQL洞察数据存储时长,单位为天,默认为**30**。'."\n"
."\n"
.'- **30**'."\n"
.'- **180**'."\n"
.'- **365**'."\n"
.'- **1095**'."\n"
.'- **1825**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Synchro' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Data' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Synchro\\": \\"None\\",\\n \\"Data\\": \\"None\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableDasProResponse>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Message>Successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n</EnableDasProResponse>","errorExample":""}]',
'title' => '开启DAS企业版 V1',
'description' => '- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 该接口仅适用于DAS企业版 V1。'."\n"
."\n"
.'>推荐使用[ModifySqlLogConfig](~~2778835~~)接口,为实例开启或关闭DAS企业版。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:EnableDasPro',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'EnableSqlConcurrencyControl' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL和 PolarDB MySQL版实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'SqlType',
'in' => 'query',
'schema' => ['description' => '选择SQL的类型。取值:'."\n"
.'- **SELECT**'."\n"
.'- **UPDATE**'."\n"
.'- **DELETE**', 'type' => 'string', 'required' => true, 'example' => 'SELECT'],
],
[
'name' => 'MaxConcurrency',
'in' => 'query',
'schema' => ['description' => 'SQL最大并发数,取值为大于或等于1的整数。'."\n"
.'>当包含关键词的SQL达到最大并发数时会触发限流规则。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3'],
],
[
'name' => 'SqlKeywords',
'in' => 'query',
'schema' => ['description' => '需要限流的SQL关键词。'."\n"
.'>多个关键词间用波浪线(~)分隔,SQL语句中需要同时包含这些关键词才会触发限流规则。', 'type' => 'string', 'required' => true, 'example' => 'call~open~api~test~4~from~POP'],
],
[
'name' => 'ConcurrencyControlTime',
'in' => 'query',
'schema' => ['description' => 'SQL限流的生效时长,单位为秒。'."\n"
.'>限流规则仅在生效时间内开启。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '详细信息列表,包括信息总数、错误码等。', 'type' => 'string', 'example' => 'Null'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '启用SQL限流',
'summary' => '调用EnableSqlConcurrencyControl接口,启用SQL限流来控制数据库请求访问量和SQL并发量。',
'description' => '本接口适用的数据库引擎为:'."\n"
.'- RDS MySQL'."\n"
.'- PolarDB MySQL版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlConcurrencyControl'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:EnableSqlConcurrencyControl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"Null\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<EnableSqlConcurrencyControlResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\"Data\\": { \\"total\\": 1, \\"list\\":[...] }, \\"Code\\": 200, \\"Success\\": true }</Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</EnableSqlConcurrencyControlResponse>","errorExample":""}]',
],
'GetAsyncErrorRequestListByCode' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-wz9s658475e58****'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需要在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642556990714'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642566830000'],
],
[
'name' => 'ErrorCode',
'in' => 'query',
'schema' => ['description' => '错误码,您可调用[GetAsyncErrorRequestStatByCode](~~409804~~)接口查询实例的MySQL错误码。', 'type' => 'string', 'required' => false, 'example' => '1064'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'fail' => ['description' => '请求是否失败:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'result' => [
'description' => '产生指定MySQL错误码的SQL ID列表。',
'type' => 'array',
'items' => [
'description' => '产生指定MySQL错误码的SQL ID列表。',
'type' => 'object',
'properties' => [
'sqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => 'ad78a4e7d3ce81590c9dc2d5f4bc****'],
'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
],
],
],
'resultId' => ['description' => '异步请求ID。', 'type' => 'string', 'example' => 'async__c39d43ece52d35267cc4b92a0c26****'],
'isFinish' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'state' => ['description' => '异步请求的执行状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'complete' => ['description' => '异步请求是否完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1644559407740'],
],
'example' => '{ "fail": false, "data": [ { "sqlId": "ad78a4e7d3ce81590c9dc2d5f4bc****", "instanceId": "rm-2ze8g2am97624****" }, { "sqlId": "0f92feacd92c048b06a16617a633****", "instanceId": "rm-2ze8g2am97624****" } ], "resultId": "async__c39d43ece52d35267cc4b92a0c26****", "isFinish": true, "state": "SUCCESS", "complete": true, "timestamp": 1644559407740 }',
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9CB97BC4-6479-55D0-B9D0-EA925AFE****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询产生指定MySQL错误码的SQL ID',
'summary' => '调用GetAsyncErrorRequestListByCode接口,异步查询数据库实例SQL洞察结果中产生指定MySQL错误码的SQL ID。',
'description' => '> 异步调用后不会立即返回完整结果,当返回数据中**isFinish**取值为**false**时,请等待1s后重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。'."\n"
."\n\n"
.'- 目前仅支持RDS MySQL和PolarDB MySQL版实例,请确保在使用该接口前,该实例已经开启DAS企业版,具体请参见[购买DAS企业版](~~163298~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 2024年09月01日起,由于SQL的模板化算法优化,调用本接口时,SqlId 字段的值将发生变更。详情请参见[【通知】SQL模板化算法优化](~~2845725~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncErrorRequestListByCode'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAsyncErrorRequestListByCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"fail\\": false,\\n \\"result\\": [\\n {\\n \\"sqlId\\": \\"ad78a4e7d3ce81590c9dc2d5f4bc****\\",\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\"\\n }\\n ],\\n \\"resultId\\": \\"async__c39d43ece52d35267cc4b92a0c26****\\",\\n \\"isFinish\\": true,\\n \\"state\\": \\"SUCCESS\\",\\n \\"complete\\": true,\\n \\"timestamp\\": 1644559407740\\n },\\n \\"RequestId\\": \\"9CB97BC4-6479-55D0-B9D0-EA925AFE****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAsyncErrorRequestListByCodeResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <fail>false</fail>\\n <result>\\n <sqlId>ad78a4e7d3ce81590c9dc2d5f4bc****</sqlId>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n </result>\\n <resultId>async__c39d43ece52d35267cc4b92a0c26****</resultId>\\n <isFinish>true</isFinish>\\n <state>SUCCESS</state>\\n <complete>true</complete>\\n <timestamp>1644559407740</timestamp>\\n </Data>\\n <RequestId>9CB97BC4-6479-55D0-B9D0-EA925AFE****</RequestId>\\n <Success>true</Success>\\n</GetAsyncErrorRequestListByCodeResponse>","errorExample":""}]',
],
'GetAsyncErrorRequestStatByCode' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-wz9s658475e58****'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642556990714'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询的结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642566830000'],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。'."\n"
."\n",
'type' => 'object',
'properties' => [
'fail' => ['description' => '请求是否失败:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'isFinish' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'resultId' => ['description' => '异步请求ID。', 'type' => 'string', 'example' => 'async__fcd7c35788e62324622c3b4a03de****'],
'state' => ['description' => '异步请求的执行状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1644560866961'],
'complete' => ['description' => '异步请求是否完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'result' => [
'description' => '返回的错误码以及每个错误码对应的SQL数量列表。',
'type' => 'array',
'items' => [
'description' => '返回的错误码以及每个错误码对应的SQL数量列表。',
'type' => 'object',
'properties' => [
'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'errorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '1062'],
'count' => ['description' => '错误码对应SQL的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
'example' => '{ "fail": false, "data": [ { "instanceId": "rm-2ze8g2am97624****", "count": 1, "errorCode": "1062" }, { "instanceId": "rm-2ze8g2am97624****", "count": 2, "errorCode": "1064" } ], "resultId": "async__fcd7c35788e62324622c3b4a03de****", "isFinish": true, "state": "SUCCESS", "complete": true, "timestamp": 1644560866961 }',
],
'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '840F51F7-9C01-538D-94F6-AE712905****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询MySQL错误码以及每个错误码对应的SQL数量',
'summary' => '调用GetAsyncErrorRequestStatByCode接口,异步查询数据库实例SQL洞察结果中的MySQL错误码以及每个错误码对应的SQL数量。',
'description' => '> 异步调用后不会立即返回完整结果,当返回数据中**isFinish**取值为**false**时,请等待1s后重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。'."\n"
."\n"
.'- 目前仅支持RDS MySQL和PolarDB MySQL版实例,请确保在使用该接口前,该实例已经开启DAS企业版,具体请参见[购买DAS企业版](~~163298~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncErrorRequestStatByCode'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAsyncErrorRequestStatByCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"fail\\": false,\\n \\"isFinish\\": true,\\n \\"resultId\\": \\"async__fcd7c35788e62324622c3b4a03de****\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"timestamp\\": 1644560866961,\\n \\"complete\\": true,\\n \\"result\\": [\\n {\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"errorCode\\": \\"1062\\",\\n \\"count\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"840F51F7-9C01-538D-94F6-AE712905****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAsyncErrorRequestStatByCodeResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <fail>false</fail>\\n <isFinish>true</isFinish>\\n <resultId>async__fcd7c35788e62324622c3b4a03de****</resultId>\\n <state>SUCCESS</state>\\n <timestamp>1644560866961</timestamp>\\n <complete>true</complete>\\n <result>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n <errorCode>1062</errorCode>\\n <count>1</count>\\n </result>\\n </Data>\\n <RequestId>840F51F7-9C01-538D-94F6-AE712905****</RequestId>\\n <Success>true</Success>\\n</GetAsyncErrorRequestStatByCodeResponse>","errorExample":""}]',
],
'GetAsyncErrorRequestStatResult' => [
'summary' => '调用GetAsyncErrorRequestStatResult接口,异步获取数据库实例SQL洞察结果中指定SQL的执行错误次数。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp179lg03445l****'],
],
[
'name' => 'SqlIdList',
'in' => 'query',
'schema' => ['description' => 'SQL ID,多个SQL ID请使用英文逗号分隔。您可以调用[GetAsyncErrorRequestListByCode](~~410746~~)接口查询实例中产生MySQL错误码的SQL ID。', 'type' => 'string', 'required' => false, 'example' => 'ad78a4e7d3ce81590c9dc2d5f4bc****,0f92feacd92c048b06a16617a633****'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642556990714'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642566830000'],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据列表。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'fail' => ['description' => '请求是否失败:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'isFinish' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'resultId' => ['description' => '异步请求ID。', 'type' => 'string', 'example' => 'async__61f45ee381b2fa4e8a6545e3bee9****'],
'state' => ['description' => '异步请求的执行状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1644558576717'],
'complete' => ['description' => '异步请求是否完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'result' => [
'description' => '异步请求的返回数据列表。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'sqlId' => ['type' => 'string', 'description' => 'SQL模板ID', 'example' => '61f45ee381b2fa4e8a6545e3bee9'],
'instanceId' => ['type' => 'string', 'example' => 'rm-xxx', 'description' => '实例ID'],
'count' => ['type' => 'integer', 'format' => 'int32', 'description' => '数量', 'example' => '10'],
],
'description' => '异步请求的返回数据列表。',
],
],
],
'example' => '{ "fail": false, "data": { "ad78a4e7d3ce81590c9dc2d5f4bc****": { "sqlId": "ad78a4e7d3ce81590c9dc2d5f4bc****", "instanceId": "rm-2ze8g2am97624****", "count": 1 }, "0f92feacd92c048b06a16617a633****": { "sqlId": "0f92feacd92c048b06a16617a633****", "instanceId": "rm-2ze8g2am97624****", "count": 2 } }, "resultId": "async__61f45ee381b2fa4e8a6545e3bee9****", "isFinish": true, "state": "SUCCESS", "complete": true, "timestamp": 1644558576717 }',
],
'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '3FC3F8EB-3564-5D1A-B187-3B03E5B0****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"fail\\": false,\\n \\"isFinish\\": true,\\n \\"resultId\\": \\"async__61f45ee381b2fa4e8a6545e3bee9****\\",\\n \\"state\\": \\"SUCCESS\\",\\n \\"timestamp\\": 1644558576717,\\n \\"complete\\": true,\\n \\"result\\": {\\n \\"key\\": {\\n \\"sqlId\\": \\"61f45ee381b2fa4e8a6545e3bee9\\",\\n \\"instanceId\\": \\"rm-xxx\\",\\n \\"count\\": 10\\n }\\n }\\n },\\n \\"RequestId\\": \\"3FC3F8EB-3564-5D1A-B187-3B03E5B0****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAsyncErrorRequestStatResultResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <fail>false</fail>\\n <isFinish>true</isFinish>\\n <resultId>async__61f45ee381b2fa4e8a6545e3bee9****</resultId>\\n <state>SUCCESS</state>\\n <timestamp>1644558576717</timestamp>\\n <complete>true</complete>\\n <result>\\n <key>\\n <sqlId>ad78a4e7d3ce81590c9dc2d5f4bc****</sqlId>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n <count>1</count>\\n </key>\\n </result>\\n </Data>\\n <RequestId>3FC3F8EB-3564-5D1A-B187-3B03E5B0****</RequestId>\\n <Success>true</Success>\\n</GetAsyncErrorRequestStatResultResponse>","errorExample":""}]',
'title' => '获取指定SQL的执行错误次数',
'description' => '> 异步调用后不会立即返回完整结果,当返回数据中**isFinish**取值为**false**时,请等待1s后重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。'."\n"
."\n\n"
.'- 目前仅支持RDS MySQL和PolarDB MySQL版实例,请确保在使用该接口前,该实例已经开启DAS企业版,具体请参见[购买DAS企业版](~~163298~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncErrorRequestStatResult'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAsyncErrorRequestStatResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetAutoIncrementUsageStatistic' => [
'summary' => '调用GetAutoIncrementUsageStatistic接口,获取表自增ID的使用数据。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'DbNames',
'in' => 'query',
'schema' => ['description' => '数据库名。传入此参数时,查询指定数据库中表自增ID使用情况,不传入时查询实例上所有数据库的表自增ID使用情况。'."\n"
.'>数据格式为JSONArray,例如[\'db1\',\'db2\'],数据库名间用英文逗号(,)分隔。', 'type' => 'string', 'required' => false, 'example' => '[\'db1\',\'db2\']'],
],
[
'name' => 'RatioFilter',
'in' => 'query',
'schema' => ['description' => '自增ID使用比例过滤值,只返回超过该比例的自增ID使用数据。取值为0~1的小数。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.9'],
],
[
'name' => 'RealTime',
'in' => 'query',
'schema' => ['description' => '是否获取实时数据:'."\n"
."\n"
.'- **true**:实时查询实例上数据并计算。最小查询时间粒度为10分钟,即有10分钟内的数据时,即使传递**true**也不进行实时查询。'."\n"
.'- **false**:当有近两小时的数据时,返回该数据,否则查询实例上最新数据。', 'type' => 'boolean', 'required' => true, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'Finish' => ['description' => '任务是否结束:'."\n"
."\n"
.'- **true**:任务结束。'."\n"
.'- **false**:任务未结束。', 'type' => 'boolean', 'example' => 'false'],
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1697183353000'],
'TaskStatus' => ['description' => '任务状态:'."\n"
.'- **INIT**:初始化。'."\n"
.'- **RUNNING**:任务执行中。'."\n"
.'- **SUCCESS**:任务成功。'."\n"
.'- **FAIL**:任务失败。', 'type' => 'string', 'example' => 'INIT'],
'ErrorInfo' => ['description' => '任务失败时的错误信息。', 'type' => 'string', 'example' => 'the given database name list invalid, none of the database names in the list exist on the instance'],
'AutoIncrementUsageList' => [
'description' => '自增ID使用数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'db01'],
'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'test_table'],
'ColumnName' => ['description' => '列名。', 'type' => 'string', 'example' => 'id'],
'AutoIncrementCurrentValue' => ['description' => '自增ID当前值。', 'type' => 'integer', 'format' => 'int64', 'example' => '2147483647'],
'MaximumValue' => ['description' => '该数据类型的自增ID支持的最大值。', 'type' => 'integer', 'format' => 'int64', 'example' => '2147483647'],
'AutoIncrementRatio' => ['description' => '自增ID使用比例。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
],
'description' => '',
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0A74B755-98B7-59DB-8724-1321B394****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取表自增ID使用数据',
'description' => '- 本接口只适用于RDS MySQL和PolarDB MySQL版实例。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'extraInfo' => '- 调用接口时,当返回数据中Finish不为true时,需要继续调用。当Finish为true且TaskStatus为SUCCESS时,可以查看具体的自增ID使用数据。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutoIncrementUsageStatistic'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetAutoIncrementUsageStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Finish\\": false,\\n \\"Timestamp\\": 1697183353000,\\n \\"TaskStatus\\": \\"INIT\\",\\n \\"ErrorInfo\\": \\"the given database name list invalid, none of the database names in the list exist on the instance\\",\\n \\"AutoIncrementUsageList\\": [\\n {\\n \\"DbName\\": \\"db01\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"ColumnName\\": \\"id\\",\\n \\"AutoIncrementCurrentValue\\": 2147483647,\\n \\"MaximumValue\\": 2147483647,\\n \\"AutoIncrementRatio\\": 1\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0A74B755-98B7-59DB-8724-1321B394****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetAutoResourceOptimizeRules' => [
'summary' => '获取指定数据库实例的空间碎片自动回收规则。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n"
.'- 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。'."\n"
.'- 不输入数据库实例ID时,默认返回当前账号曾经开启过空间碎片自动回收功能的全部数据库实例信息,包括:'."\n"
.' - 正在使用该功能的数据库实例。'."\n"
.' - 已关闭该功能的数据库实例(包含已经关闭了DAS企业版数据库实例,但不包含已经释放的数据库实例)。', 'type' => 'string', 'required' => false, 'example' => '[\'rm-2ze8g2am97624****\',\'rm-2vc54m2a6pd6p****\',\'rm-2ze9xrhze0709****\',\'rm-2ze8g2am97627****\']'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。'."\n"
."\n",
'type' => 'object',
'properties' => [
'TotalAutoResourceOptimizeRulesCount' => ['description' => '所有开启过空间碎片自动回收功能的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'EnableAutoResourceOptimizeCount' => ['description' => '正在使用空间碎片自动回收功能的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TurnOffAutoResourceOptimizeCount' => ['description' => '曾经开启并且当前已关闭空间碎片自动回收功能的数据库实例数量。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'HasEnableRuleButNotDasProCount' => ['description' => '已开启并且未关闭空间碎片自动回收功能,但已不再使用DAS企业版的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'EnableAutoResourceOptimizeList' => [
'description' => '正在使用空间碎片自动回收功能的数据库实例信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'AutoDefragment' => ['description' => '是否开启了自动空间碎片回收功能。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'TableSpaceSize' => ['description' => '触发空间碎片自动回收单个物理表的最小空间,单位为GB。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'DasProOn' => ['description' => '是否开启了DAS企业版。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'TableFragmentationRatio' => ['description' => '触发空间碎片自动回收单个物理表的碎片率。', 'type' => 'number', 'format' => 'double', 'example' => '0.2'],
'UserId' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。', 'type' => 'string', 'example' => '140692647406****'],
],
'description' => '',
],
],
'TurnOffAutoResourceOptimizeList' => [
'description' => '曾经开启并且当前已关闭空间碎片自动回收功能的数据库实例信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2vc54m2a6pd6p****'],
'AutoDefragment' => ['description' => '是否开启了自动空间碎片回收功能。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'TableSpaceSize' => ['description' => '触发空间碎片自动回收单个物理表的最小空间,单位为GB。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'DasProOn' => ['description' => '是否开启了DAS企业版。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'TableFragmentationRatio' => ['description' => '触发空间碎片自动回收单个物理表的碎片率。', 'type' => 'number', 'format' => 'double', 'example' => '0.2'],
'UserId' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。', 'type' => 'string', 'example' => '140692647406****'],
],
'description' => '',
],
],
'HasEnableRuleButNotDasProList' => [
'description' => '已开启并且未关闭空间碎片自动回收功能,但已不再使用DAS企业版的数据库实例列表。'."\n"
.'> 此类数据库实例不会执行空间碎片自动回收,直至再次为数据库实例开启DAS企业版。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze9xrhze0709****'],
'AutoDefragment' => ['description' => '是否开启了自动空间碎片回收功能。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'TableSpaceSize' => ['description' => '触发空间碎片自动回收单个物理表的最小空间,单位为GB。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'DasProOn' => ['description' => '是否开启了DAS企业版。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'TableFragmentationRatio' => ['description' => '触发空间碎片自动回收单个物理表的碎片率。', 'type' => 'number', 'format' => 'double', 'example' => '0.2'],
'UserId' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。', 'type' => 'string', 'example' => '140692647406****'],
],
'description' => '',
],
],
'NeverEnableAutoResourceOptimizeOrReleasedInstanceCount' => ['description' => '从未开启过空间碎片自动回收或者实例不存在的数据库实例数量。'."\n"
.'> 实例不存在:数据库实例已经释放或者传入的数据库实例ID存在错误。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList' => [
'description' => '从未开启过空间碎片自动回收或者实例不存在的数据库实例信息列表。',
'type' => 'array',
'items' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取空间碎片自动回收规则',
'description' => '使用该接口需满足以下前提条件:'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'- 实例类型为RDS MySQL高可用系列。'."\n"
."\n"
.'- 数据库实例的CPU规格不小于4核,且**innodb_file_per_table**参数值为**ON**。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutoResourceOptimizeRules'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetAutoResourceOptimizeRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TotalAutoResourceOptimizeRulesCount\\": 3,\\n \\"EnableAutoResourceOptimizeCount\\": 1,\\n \\"TurnOffAutoResourceOptimizeCount\\": 1,\\n \\"HasEnableRuleButNotDasProCount\\": 1,\\n \\"EnableAutoResourceOptimizeList\\": [\\n {\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"AutoDefragment\\": true,\\n \\"TableSpaceSize\\": 10,\\n \\"DasProOn\\": true,\\n \\"TableFragmentationRatio\\": 0.2,\\n \\"UserId\\": \\"140692647406****\\"\\n }\\n ],\\n \\"TurnOffAutoResourceOptimizeList\\": [\\n {\\n \\"InstanceId\\": \\"rm-2vc54m2a6pd6p****\\",\\n \\"AutoDefragment\\": false,\\n \\"TableSpaceSize\\": 10,\\n \\"DasProOn\\": true,\\n \\"TableFragmentationRatio\\": 0.2,\\n \\"UserId\\": \\"140692647406****\\"\\n }\\n ],\\n \\"HasEnableRuleButNotDasProList\\": [\\n {\\n \\"InstanceId\\": \\"rm-2ze9xrhze0709****\\",\\n \\"AutoDefragment\\": true,\\n \\"TableSpaceSize\\": 10,\\n \\"DasProOn\\": false,\\n \\"TableFragmentationRatio\\": 0.2,\\n \\"UserId\\": \\"140692647406****\\"\\n }\\n ],\\n \\"NeverEnableAutoResourceOptimizeOrReleasedInstanceCount\\": 1,\\n \\"NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList\\": [\\n \\"rm-2ze8g2am97624****\\"\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAutoResourceOptimizeRulesResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <TotalAutoResourceOptimizeRulesCount>3</TotalAutoResourceOptimizeRulesCount>\\n <EnableAutoResourceOptimizeCount>1</EnableAutoResourceOptimizeCount>\\n <TurnOffAutoResourceOptimizeCount>1</TurnOffAutoResourceOptimizeCount>\\n <HasEnableRuleButNotDasProCount>1</HasEnableRuleButNotDasProCount>\\n <EnableAutoResourceOptimizeList>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n <AutoDefragment>true</AutoDefragment>\\n <TableSpaceSize>10</TableSpaceSize>\\n <DasProOn>true</DasProOn>\\n <TableFragmentationRatio>0.2</TableFragmentationRatio>\\n <UserId>140692647406****</UserId>\\n </EnableAutoResourceOptimizeList>\\n <TurnOffAutoResourceOptimizeList>\\n <InstanceId>rm-2vc54m2a6pd6p****</InstanceId>\\n <AutoDefragment>false</AutoDefragment>\\n <TableSpaceSize>10</TableSpaceSize>\\n <DasProOn>true</DasProOn>\\n <TableFragmentationRatio>0.2</TableFragmentationRatio>\\n <UserId>140692647406****</UserId>\\n </TurnOffAutoResourceOptimizeList>\\n <HasEnableRuleButNotDasProList>\\n <InstanceId>rm-2ze9xrhze0709****</InstanceId>\\n <AutoDefragment>true</AutoDefragment>\\n <TableSpaceSize>10</TableSpaceSize>\\n <DasProOn>false</DasProOn>\\n <TableFragmentationRatio>0.2</TableFragmentationRatio>\\n <UserId>140692647406****</UserId>\\n </HasEnableRuleButNotDasProList>\\n <NeverEnableAutoResourceOptimizeOrReleasedInstanceCount>1</NeverEnableAutoResourceOptimizeOrReleasedInstanceCount>\\n <NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList>rm-2ze8g2am97624****</NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetAutoResourceOptimizeRulesResponse>","errorExample":""}]',
],
'GetAutoThrottleRules' => [
'summary' => '获取指定数据库实例的自动SQL限流规则。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n"
.'- 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。'."\n"
.'- 不输入数据库实例ID时,默认返回当前账号曾经开启过自动SQL限流功能的全部数据库实例信息,包括:'."\n"
.' - 正在使用该功能的数据库实例。'."\n"
.' - 已关闭该功能的数据库实例(不包含已经释放的数据库实例)。', 'type' => 'string', 'required' => false, 'example' => '[\'rm-2ze8g2am97624****\',\'rm-2vc54m2a6pd6p****\',\'rm-2ze9xrhze0709****\']'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'TotalAutoThrottleRulesCount' => ['description' => '所有开启过自动SQL限流功能的数据库数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
'EnableAutoThrottleCount' => ['description' => '正在使用自动SQL限流功能的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TurnOffAutoThrottleCount' => ['description' => '曾经开启并且当前已关闭自动SQL限流功能的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'NeverEnableAutoThrottleOrReleasedInstanceCount' => ['description' => '从未开启过自动SQL限流或者实例不存在的数据库实例数量。'."\n"
.'> 实例不存在:数据库实例已经释放或者传入的数据库实例ID存在错误。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'EnableAutoThrottleList' => [
'description' => '正在使用自动SQL限流功能的数据库实例信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AbnormalDuration' => ['description' => '触发自动限SQL流规则的异常的持续时间阈值,单位:分钟。', 'type' => 'number', 'format' => 'double', 'example' => '2'],
'CpuUsage' => ['description' => 'CPU利用率阈值。', 'type' => 'number', 'format' => 'double', 'example' => '70'],
'CpuSessionRelation' => ['description' => 'CPU利用率阈值和活跃会话数阈值的逻辑关系:'."\n"
."\n"
.'- **AND**:且。'."\n"
.'- **OR**:或。', 'type' => 'string', 'example' => 'AND'],
'ActiveSessions' => ['description' => '活跃会话数量阈值。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'MaxThrottleTime' => ['description' => '最大限流时长,单位:分钟。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'AllowThrottleStartTime' => ['description' => '可限流时间段的开始时间(UTC时间)。', 'type' => 'string', 'example' => '00:00Z'],
'AllowThrottleEndTime' => ['description' => '可限流时间段的结束时间(UTC时间)。', 'type' => 'string', 'example' => '23:59Z'],
'Visible' => ['description' => '自动SQL限流规则是否开启:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'AutoKillSession' => ['description' => '是否同时KILL执行中的异常SQL:'."\n"
.'> 异常SQL:与需要限流的SQL模板相同。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'UserId' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。', 'type' => 'string', 'example' => '140692647406****'],
],
'description' => '',
],
],
'TurnOffAutoThrottleList' => [
'description' => '曾经开启并且当前已关闭自动SQL限流功能的数据库实例信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'AbnormalDuration' => ['description' => '触发自动限流规则的持续时间阈值,单位:分钟。', 'type' => 'number', 'format' => 'double', 'example' => '2'],
'CpuUsage' => ['description' => 'CPU利用率阈值。', 'type' => 'number', 'format' => 'double', 'example' => '80'],
'AllowThrottleEndTime' => ['description' => '可限流时间段的结束时间(UTC时间)。', 'type' => 'string', 'example' => '23:59Z'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze9xrhze0709****'],
'Visible' => ['description' => '自动SQL限流规则是否开启:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'CpuSessionRelation' => ['description' => 'CPU利用率阈值和活跃会话数阈值的关系:'."\n"
.'- **AND**:且。'."\n"
.'- **OR**:或。', 'type' => 'string', 'example' => 'OR'],
'AutoKillSession' => ['description' => '是否同时KILL执行中的异常SQL:'."\n"
.'> 异常SQL:与需要限流的SQL模板相同。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'ActiveSessions' => ['description' => '活跃会话数阈值。', 'type' => 'integer', 'format' => 'int64', 'example' => '64'],
'MaxThrottleTime' => ['description' => '最大限流时长,单位:分钟。', 'type' => 'number', 'format' => 'double', 'example' => '10'],
'UserId' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。', 'type' => 'string', 'example' => '140692647406****'],
'AllowThrottleStartTime' => ['description' => '可限流时间段的开始时间(UTC时间)。', 'type' => 'string', 'example' => '00:00Z'],
],
'description' => '',
],
],
'NeverEnableAutoThrottleOrReleasedInstanceIdList' => [
'description' => '从未开启过自动SQL限流或者实例不存在的数据库实例数量。'."\n"
.'> 实例不存在:数据库实例已经释放或者传入的数据库实例ID存在错误。',
'type' => 'array',
'items' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2vc54m2a6pd6p****'],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取自动SQL限流规则',
'description' => '使用该接口需满足以下前提条件:'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 目标数据库实例为:'."\n"
.' - RDS MySQL 5.6、5.7、 8.0高可用系列、三节点企业系列。'."\n"
.' - PolarDB MySQL版 5.6集群版、5.7集群版、 8.0集群版。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutoThrottleRules'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetAutoThrottleRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TotalAutoThrottleRulesCount\\": 3,\\n \\"EnableAutoThrottleCount\\": 1,\\n \\"TurnOffAutoThrottleCount\\": 1,\\n \\"NeverEnableAutoThrottleOrReleasedInstanceCount\\": 1,\\n \\"EnableAutoThrottleList\\": [\\n {\\n \\"AbnormalDuration\\": 2,\\n \\"CpuUsage\\": 70,\\n \\"CpuSessionRelation\\": \\"AND\\",\\n \\"ActiveSessions\\": 32,\\n \\"MaxThrottleTime\\": 10,\\n \\"AllowThrottleStartTime\\": \\"00:00Z\\",\\n \\"AllowThrottleEndTime\\": \\"23:59Z\\",\\n \\"Visible\\": true,\\n \\"AutoKillSession\\": true,\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"UserId\\": \\"140692647406****\\"\\n }\\n ],\\n \\"TurnOffAutoThrottleList\\": [\\n {\\n \\"AbnormalDuration\\": 2,\\n \\"CpuUsage\\": 80,\\n \\"AllowThrottleEndTime\\": \\"23:59Z\\",\\n \\"InstanceId\\": \\"rm-2ze9xrhze0709****\\",\\n \\"Visible\\": false,\\n \\"CpuSessionRelation\\": \\"OR\\",\\n \\"AutoKillSession\\": true,\\n \\"ActiveSessions\\": 64,\\n \\"MaxThrottleTime\\": 10,\\n \\"UserId\\": \\"140692647406****\\",\\n \\"AllowThrottleStartTime\\": \\"00:00Z\\"\\n }\\n ],\\n \\"NeverEnableAutoThrottleOrReleasedInstanceIdList\\": [\\n \\"rm-2vc54m2a6pd6p****\\"\\n ]\\n },\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAutoThrottleRulesResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <TotalAutoThrottleRulesCount>3</TotalAutoThrottleRulesCount>\\n <EnableAutoThrottleCount>1</EnableAutoThrottleCount>\\n <TurnOffAutoThrottleCount>1</TurnOffAutoThrottleCount>\\n <NeverEnableAutoThrottleOrReleasedInstanceCount>1</NeverEnableAutoThrottleOrReleasedInstanceCount>\\n <EnableAutoThrottleList>\\n <AbnormalDuration>2</AbnormalDuration>\\n <CpuUsage>70</CpuUsage>\\n <CpuSessionRelation>AND</CpuSessionRelation>\\n <ActiveSessions>32</ActiveSessions>\\n <MaxThrottleTime>10</MaxThrottleTime>\\n <AllowThrottleStartTime>00:00Z</AllowThrottleStartTime>\\n <AllowThrottleEndTime>23:59Z</AllowThrottleEndTime>\\n <Visible>true</Visible>\\n <AutoKillSession>true</AutoKillSession>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n <UserId>140692647406****</UserId>\\n </EnableAutoThrottleList>\\n <TurnOffAutoThrottleList>\\n <AbnormalDuration>2</AbnormalDuration>\\n <CpuUsage>80</CpuUsage>\\n <AllowThrottleEndTime>23:59Z</AllowThrottleEndTime>\\n <InstanceId>rm-2ze9xrhze0709****</InstanceId>\\n <Visible>false</Visible>\\n <CpuSessionRelation>OR</CpuSessionRelation>\\n <AutoKillSession>true</AutoKillSession>\\n <ActiveSessions>64</ActiveSessions>\\n <MaxThrottleTime>10</MaxThrottleTime>\\n <UserId>140692647406****</UserId>\\n <AllowThrottleStartTime>00:00Z</AllowThrottleStartTime>\\n </TurnOffAutoThrottleList>\\n <NeverEnableAutoThrottleOrReleasedInstanceIdList>rm-2vc54m2a6pd6p****</NeverEnableAutoThrottleOrReleasedInstanceIdList>\\n </Data>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Success>true</Success>\\n</GetAutoThrottleRulesResponse>","errorExample":""}]',
],
'GetAutonomousNotifyEventContent' => [
'summary' => '调用GetAutonomousNotifyEventContent接口,获取指定数据库实例自治事件的内容。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '23868',
'abilityTreeNodes' => ['FEATUREhdmETIPZF'],
],
'parameters' => [
[
'name' => '__context',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-18ff4a195d****'],
],
[
'name' => 'SpanId',
'in' => 'query',
'schema' => ['description' => '事件的唯一标识,您可调用[GetAutonomousNotifyEventsInRange](~~288371~~)接口查看返回参数中的SpanId。', 'type' => 'string', 'required' => true, 'example' => '7e7b2774-95b8-4fa3-bd9c-0ab47cb7****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Data' => ['description' => '详细信息列表。', 'type' => 'string', 'example' => '{\\"taskId\\":\\"7e1ba595-0889-48ff-a6ff-010f54991d****\\",\\"taskType\\":\\"SQL_OPTIMIZE\\",\\"advisorId\\":\\"636dc5f34664dd56ff0****\\",\\"sqlId\\":\\"e2b1d6c1ee1bb29555a828b59f16****\\",\\"indexAdviceCount\\":1,\\"indexAdvices\\":[{\\"schemaName\\":\\"das\\",\\"tableName\\":\\"students\\",\\"indexName\\":\\"idx_name\\",\\"columns\\":[\\"name\\"],\\"unique\\":false,\\"ddlAddIndex\\":\\"ALTER TABLE `das`.`students` ADD INDEX `idx_name` (`name`)\\",\\"priority\\":0,\\"optimizeId\\":\\"96232794517277511\\"}],\\"tuningAdvices\\":[],\\"improvement\\":8127.25,\\"supportLevel\\":3,\\"priority\\":\\"HIGH\\"}'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取实例自治事件内容',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 当您的实例接入DAS之后,DAS异常检测发现数据库相关的监控指标发生变化,就会触发快照抓取等通知类事件。'."\n"
."\n"
.' '."\n"
.'>只有开启[自治中心](~~152139~~)才能获取通知事件的详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutonomousNotifyEventContent'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAutonomousNotifyEventContent',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"taskId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"7e1ba595-0889-48ff-a6ff-010f54991d****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"taskType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SQL_OPTIMIZE\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"advisorId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"636dc5f34664dd56ff0****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"sqlId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"e2b1d6c1ee1bb29555a828b59f16****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"indexAdviceCount\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"indexAdvices\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"schemaName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"das\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"students\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"indexName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"idx_name\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"columns\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"unique\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"ddlAddIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ALTER TABLE `das`.`students` ADD INDEX `idx_name` (`name`)\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"priority\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"optimizeId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"96232794517277511\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"tuningAdvices\\\\\\\\\\\\\\":[],\\\\\\\\\\\\\\"improvement\\\\\\\\\\\\\\":8127.25,\\\\\\\\\\\\\\"supportLevel\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\"priority\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HIGH\\\\\\\\\\\\\\"}\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAutonomousNotifyEventContentResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>{\\"taskId\\":\\"7e1ba595-0889-48ff-a6ff-010f54991d****\\",\\"taskType\\":\\"SQL_OPTIMIZE\\",\\"advisorId\\":\\"636dc5f34664dd56ff0****\\",\\"sqlId\\":\\"e2b1d6c1ee1bb29555a828b59f16****\\",\\"indexAdviceCount\\":1,\\"indexAdvices\\":[{\\"schemaName\\":\\"das\\",\\"tableName\\":\\"students\\",\\"indexName\\":\\"idx_name\\",\\"columns\\":[\\"name\\"],\\"unique\\":false,\\"ddlAddIndex\\":\\"ALTER TABLE `das`.`students` ADD INDEX `idx_name` (`name`)\\",\\"priority\\":0,\\"optimizeId\\":\\"96232794517277511\\"}],\\"tuningAdvices\\":[],\\"improvement\\":8127.25,\\"supportLevel\\":3,\\"priority\\":\\"HIGH\\"}</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetAutonomousNotifyEventContentResponse>","errorExample":""}]',
],
'GetAutonomousNotifyEventsInRange' => [
'summary' => '调用GetAutonomousNotifyEventsInRange接口,获取指定类型或范围的通知事件。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '23871',
'abilityTreeNodes' => ['FEATUREhdm56JBRC'],
],
'parameters' => [
[
'name' => '__context',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-18ff4a195d****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1568269711000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>查询任务结束时间需晚于查询任务开始时间。', 'type' => 'string', 'required' => true, 'example' => '1568265711221'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => 'PolarDB的节点ID,您可以通过调用[DescribeDBClusters](~~98094~~)接口查看返回参数的DBNodeId。'."\n"
.'>仅支持PolarDB MySQL版实例。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
[
'name' => 'EventContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Level',
'in' => 'query',
'schema' => ['description' => '指定事件紧急程度,当该字段设置时,MinLevel参数将无效。取值:'."\n"
."\n"
.'- **Notice**:通知类事件。'."\n"
.'- **Optimization**:优化类事件。'."\n"
.'- **Warn**:警告类事件。'."\n"
.'- **Critical**:危机类事件。', 'type' => 'string', 'required' => false, 'example' => 'Warn'],
],
[
'name' => 'MinLevel',
'in' => 'query',
'schema' => ['description' => '最小事件紧急程度。取值:'."\n"
."\n"
.'- **Notice**:通知类事件。'."\n"
.'- **Optimization**:优化类事件。'."\n"
.'- **Warn**:警告类事件。'."\n"
.'- **Critical**:危机类事件。', 'type' => 'string', 'required' => false, 'example' => 'Notice'],
],
[
'name' => 'PageOffset',
'in' => 'query',
'schema' => ['description' => '分页查询,页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询,每页大小。', 'type' => 'string', 'required' => false, 'example' => '30'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'T' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'array',
'items' => ['description' => '详细信息列表。', 'type' => 'string', 'example' => '"T": []'],
],
],
'description' => '',
],
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页最大记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
],
],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取指定类型或范围的通知事件',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 当您的实例接入DAS之后,DAS异常检测发现数据库相关的监控指标发生变化,就会触发快照抓取等通知类事件。'."\n"
."\n"
.' '."\n"
.'>只有开启[自治中心](~~152139~~)才能获取通知事件的详情。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutonomousNotifyEventsInRange'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAutonomousNotifyEventsInRange',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Extra\\": \\"None\\",\\n \\"List\\": {\\n \\"T\\": [\\n \\"\\\\\\"T\\\\\\": []\\"\\n ]\\n },\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 4\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAutonomousNotifyEventsInRangeResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <List>\\n </List>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Extra>None</Extra>\\n <Total>4</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetAutonomousNotifyEventsInRangeResponse>","errorExample":""}]',
],
'GetBlockingDetailList' => [
'summary' => '调用GetBlockingDetailList接口,查询RDS SQL Server实例的锁阻塞列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-t4nfalp2ap421****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1679429913757'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1682490480548'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'QueryHash',
'in' => 'query',
'schema' => ['description' => 'SQL哈希值。将SQL语句进行Hash之后得出的值,同一种SQL对应同一个QueryHash。', 'type' => 'string', 'required' => false, 'example' => 'DC08B955CAD25E7B'],
],
[
'name' => 'DbNameList',
'in' => 'query',
'schema' => ['description' => '数据库名。传入多个数据库时,各个数据库名称间使用英文逗号(,)进行分隔。', 'type' => 'string', 'required' => false, 'example' => 'testdb1,testdb2'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '返回信息列表。',
'type' => 'array',
'items' => [
'description' => '数据详情。',
'type' => 'object',
'properties' => [
'BatchId' => ['description' => '采集批次。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683530096156'],
'ClientAppName' => ['description' => '客户端名称。', 'type' => 'string', 'example' => '.Net SqlClient Data Provider'],
'DataBase' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb1'],
'HostName' => ['description' => '客户端主机名称。', 'type' => 'string', 'example' => 'ALLBNMGTAPPRD01'],
'LoginId' => ['description' => '登录用户名。', 'type' => 'string', 'example' => 'Testuser'],
'QueryHash' => ['description' => 'SQL HASH值。', 'type' => 'string', 'example' => 'DC08B955CAD25E7B'],
'Spid' => ['description' => '会话ID。', 'type' => 'string', 'example' => '1717'],
'SqlText' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'select * from test1'],
'StartTime' => ['description' => '开始执行的时间。格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '1608888296000'],
'WaitTimeMs' => ['description' => '阻塞时长,单位毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '30000'],
'WaitType' => ['description' => '等待类型。更多等待类型及说明,请参见[等待类型](https://learn.microsoft.com/en-us/sql/relational-databases/system-dynamic-management-views/sys-dm-os-wait-stats-transact-sql?view=sql-server-ver15)。', 'type' => 'string', 'example' => 'MISCELLANEOUS'],
'CurrentCollectionTime' => ['description' => '阻塞的采集时间。格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1700065800000'],
],
],
],
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RDS SQL Server实例的锁阻塞列表',
'description' => '* 本接口仅适用于RDS SQL Server版实例。'."\n"
.'* 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'* 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBlockingDetailList'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:GetBlockingDetailList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"BatchId\\": 1683530096156,\\n \\"ClientAppName\\": \\".Net SqlClient Data Provider\\",\\n \\"DataBase\\": \\"testdb1\\",\\n \\"HostName\\": \\"ALLBNMGTAPPRD01\\",\\n \\"LoginId\\": \\"Testuser\\",\\n \\"QueryHash\\": \\"DC08B955CAD25E7B\\",\\n \\"Spid\\": \\"1717\\",\\n \\"SqlText\\": \\"select * from test1\\",\\n \\"StartTime\\": \\"1608888296000\\",\\n \\"WaitTimeMs\\": 30000,\\n \\"WaitType\\": \\"MISCELLANEOUS\\",\\n \\"CurrentCollectionTime\\": 1700065800000\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 19\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'GetDBInstanceConnectivityDiagnosis' => [
'summary' => '获取用户输入IP地址到指定数据库实例的网络连通性诊断结果。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'SrcIp',
'in' => 'query',
'schema' => ['title' => '源IP', 'description' => '源IP地址。', 'type' => 'string', 'required' => true, 'example' => '47.100.XX.XX'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'instanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'success' => [
'title' => '是否检测通过',
'description' => '是否检测通过:'."\n"
."\n"
.'- **true**:检测通过。'."\n"
.'- **false**:检测不通过。',
'type' => 'boolean',
'enumValueTitles' => [],
'example' => 'false',
],
'failType' => ['title' => '异常类型', 'description' => '异常类型:'."\n"
."\n"
.'- **0**:用户可自助处理的。'."\n"
.'- **1**:需要联系值班人员处理的。', 'type' => 'string', 'example' => '0'],
'connCheckErrorCode' => ['title' => '异常检测项', 'description' => '异常检测项:'."\n"
."\n"
.'- **SRC\\_IP\\_NOT\\_IN\\_USER\\_WHITELIST**:源IP地址没有配置在用户白名单中。'."\n"
.'- **VIP\\_NOT\\_EXISTS**:VIP对应的ALB实例不存在。'."\n"
.'- **RS\\_NOT\\_EXISTS**:RS不正常挂载。'."\n"
.'- **VIP\\_TUNNEL\\_ID\\_NOT\\_CONSISTENT**:VPC类型VIP使用的TUNNEL ID与VPC对应的实际TUNNEL ID不一致。'."\n"
.'- **VIP\\_VPC\\_CLOUD\\_INSTANCE\\_NOT\\_EXISTS**:VPC类型VIP不存在。'."\n"
.'- **VIP\\_IS\\_NOT\\_NGLB**:VIP关闭了NGLB模式。'."\n"
.'- **CUSTINS\\_NOT\\_ASSOCIATE\\_ECS\\_SECURITY\\_GROUP**:实例没有关联安全组。'."\n"
.'- **SRC\\_IP\\_NOT\\_IN\\_USER\\_WHITELIST**:源IP地址没有配置在用户白名单中。'."\n"
.'- **SRC\\_IP\\_NOT\\_IN\\_ADMIN\\_WHITELIST**:源IP地址没有配置在管理机白名单中。'."\n"
.'- **SRC\\_IP\\_NOT\\_IN\\_ECS\\_SECURITY\\_GROUP**:源IP地址没有配置在实例关联的安全组中。'."\n"
.'- **VPC\\_INSTANCE\\_IP\\_NOT\\_WORKING\\_STATUS**:VPC IP地址状态异常。', 'type' => 'string', 'example' => 'SRC_IP_NOT_IN_USER_WHITELIST'],
'connCheckErrorMessage' => ['title' => '异常检测详情信息', 'description' => '异常检测详情信息。', 'type' => 'string', 'example' => 'Src ip:47.100.XX.XX not in user whitelist'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* **true**:执行成功。'."\n"
.'* **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"success\\": false,\\n \\"failType\\": \\"0\\",\\n \\"connCheckErrorCode\\": \\"SRC_IP_NOT_IN_USER_WHITELIST\\",\\n \\"connCheckErrorMessage\\": \\"Src ip:47.100.XX.XX not in user whitelist\\"\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
'title' => '获取数据库实例网络连通性诊断结果',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 数据库实例已接入DAS。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDBInstanceConnectivityDiagnosis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDasAgentSSE' => [
'summary' => 'DAS大模型交互SSE接口。可以进行知识问答,性能诊断等功能。',
'path' => '/getDasAgentSSE',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmB8MM4L', 'FEATUREhdmROFBLE', 'FEATUREhdm1XKIXR', 'FEATUREhdmR88NLD', 'FEATUREhdm3TU4OK'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => '问答自然语言描述', 'type' => 'string', 'required' => true, 'example' => 'Are there any issues or abnormalities with my instance rm-xxx?'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => '废弃参数, 实例Id通过Query字段传入', 'type' => 'string', 'required' => false, 'example' => 'rm-xxxx'],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['description' => '可选,会话Id,格式为UUID字符串,未传入会创建新的会话,上下文对话需保持同一个会话Id', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-xxxxxxxxxxxx'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '可选,默认使用默认Agent进行服务,或者传入开启DASAgent服务后生成的或者主动创建的Agent', 'type' => 'string', 'required' => false, 'example' => 'ag-472T0DxtmjIxxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Id' => ['description' => 'SessionId, 同请求参数中的SessionId', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-xxxxxxxxxxxx'],
'Answer' => ['description' => '回答内容', 'type' => 'string', 'example' => 'rm-xxxx'],
'Metadata' => [
'description' => '元信息',
'type' => 'object',
'properties' => [
'Code' => ['description' => '如果异常,会返回错误类型,无异常时返回为空', 'type' => 'integer', 'format' => 'int32', 'example' => '-1810001'],
'CharCount' => ['description' => '回答的字符数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1403'],
'ToolName' => ['description' => '调用的工具命令', 'type' => 'string', 'example' => 'SqlFilter'],
'ToolParams' => [
'description' => '工具参数',
'type' => 'array',
'items' => ['description' => '字符串列表', 'type' => 'string', 'example' => '["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"]'],
],
'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '04930480-9404-50CB-8252-Axxxxxxxx'],
],
],
'Event' => [
'description' => '返回回答信息的类型',
'type' => 'string',
'enumValueTitles' => ['summary' => '回答的相关统计', ' error ' => '报错信息', 'agent_message ' => '大模型生成的回答'],
'example' => 'summary',
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
[
['errorCode' => 'InstanceNotFound', 'errorMessage' => 'Requested instance not found.', 'description' => '对应实例id无法找到'],
],
500 => [
['errorCode' => 'Timeout', 'errorMessage' => 'The request processing has failed due to timeout.', 'description' => '由于超时请求处理失败。'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '(废弃)Das Agent 数据流接口',
'description' => '该接口是付费接口,会按照输出字符进行计费,请确保在使用该接口前,已充分了解DAS Agent产品的收费方式和[价格](https://help.aliyun.com/zh/das/product-overview/billing-details-of-the-previous-version?spm=a2c4g.11186623.help-menu-63907.d_0_1_0.b7203b87MDNqHO&scm=20140722.H_156195._.OR_help-T_cn~zh-V_1#cad160563fbkd)。',
'extraInfo' => '### Java 版本示例'."\n"
."\n"
.'```'."\n"
.'import com.aliyun.auth.credentials.Credential;'."\n"
.'import com.aliyun.auth.credentials.provider.StaticCredentialProvider;'."\n"
.'import com.aliyun.sdk.gateway.pop.Configuration;'."\n"
.'import com.aliyun.sdk.gateway.pop.auth.SignatureVersion;'."\n"
.'import com.aliyun.sdk.service.das20200116.models.GetDasAgentSSERequest;'."\n"
.'import com.aliyun.sdk.service.das20200116.models.GetDasAgentSSEResponseBody;'."\n"
.'import com.aliyun.sdk.service.das20200116.models.*;'."\n"
.'import com.aliyun.sdk.service.das20200116.*;'."\n"
.'import darabonba.core.ResponseIterable;'."\n"
.'import darabonba.core.client.ClientOverrideConfiguration;'."\n"
."\n"
.'import java.util.*;'."\n"
.'import java.io.*;'."\n"
."\n"
.'public class GetDasAgentSSESample {'."\n"
."\n"
.' public static void main(String[] args) throws Exception {'."\n"
."\n"
.' StaticCredentialProvider provider = StaticCredentialProvider.create(Credential.builder()'."\n"
.' .accessKeyId(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"))'."\n"
.' .accessKeySecret(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"))'."\n"
.' .build());'."\n"
."\n"
.' AsyncClient client = AsyncClient.builder()'."\n"
.' .region("cn-shanghai")'."\n"
.' .credentialsProvider(provider)'."\n"
.' .serviceConfiguration(Configuration.create().setSignatureVersion(SignatureVersion.V3))'."\n"
.' .overrideConfiguration(ClientOverrideConfiguration.create().setProtocol("HTTPS")'."\n"
.' .setEndpointOverride("das.cn-shanghai.aliyuncs.com"))'."\n"
.' .build();'."\n"
."\n"
.' GetDasAgentSSERequest request = GetDasAgentSSERequest.builder()'."\n"
.' .query("麻烦介绍下DAS Agent,相关文字在1000字左右").build();'."\n"
.' ResponseIterable<GetDasAgentSSEResponseBody> x = client.getDasAgentSSEWithResponseIterable(request);'."\n"
.' for (GetDasAgentSSEResponseBody event : x) {'."\n"
.' System.out.printf(event.getAnswer());'."\n"
.' }'."\n"
."\n"
.' client.close();'."\n"
.' }'."\n"
."\n"
.'}'."\n"
.'```'."\n"
.'### Python 版本示例'."\n"
."\n"
.'```'."\n"
.'# -*- coding: utf-8 -*-'."\n"
.'import os'."\n"
.'import sys'."\n"
.'import json'."\n"
.'import asyncio'."\n"
."\n"
.'from typing import List'."\n"
."\n"
.'from alibabacloud_das20200116.client import Client as DAS20200116Client'."\n"
.'from alibabacloud_credentials.client import Client as CredentialClient'."\n"
.'from alibabacloud_tea_openapi import models as open_api_models'."\n"
.'from alibabacloud_das20200116 import models as das20200116_models'."\n"
.'from alibabacloud_tea_util import models as util_models'."\n"
.'from alibabacloud_tea_util.client import Client as UtilClient'."\n"
."\n\n"
.'class GetDasAgentSseSample:'."\n"
.' def __init__(self):'."\n"
.' pass'."\n"
."\n"
.' @staticmethod'."\n"
.' def create_client() -> DAS20200116Client:'."\n"
.' """'."\n"
.' 使用凭据初始化账号Client'."\n"
.' @return: Client'."\n"
.' @throws Exception'."\n"
.' """'."\n"
.' credential = CredentialClient()'."\n"
.' config = open_api_models.Config('."\n"
.' credential=credential'."\n"
.' )'."\n"
.' config.endpoint = f\'das.cn-shanghai.aliyuncs.com\''."\n"
.' return DAS20200116Client(config)'."\n"
."\n"
.' @staticmethod'."\n"
.' def create_api_info() -> open_api_models.Params:'."\n"
.' params = open_api_models.Params('."\n"
.' action=\'GetDasAgentSSE\','."\n"
.' version=\'2020-01-16\','."\n"
.' protocol=\'HTTPS\','."\n"
.' pathname=\'/\','."\n"
.' method=\'POST\','."\n"
.' auth_type=\'AK\','."\n"
.' style=\'RPC\','."\n"
.' req_body_type=\'json\','."\n"
.' body_type=\'sse\''."\n"
.' )'."\n"
.' return params'."\n"
."\n"
.' @staticmethod'."\n"
.' def build_open_api_request(request_obj) -> open_api_models.OpenApiRequest:'."\n"
.' query_dict = {} '."\n"
.' for attr_name in dir(request_obj):'."\n"
.' if attr_name.startswith(\'_\'):'."\n"
.' continue'."\n"
.' if callable(getattr(request_obj, attr_name, None)):'."\n"
.' continue'."\n"
.' try:'."\n"
.' value = getattr(request_obj, attr_name)'."\n"
.' except AttributeError:'."\n"
.' continue '."\n"
.' if UtilClient.is_unset(value):'."\n"
.' continue'."\n"
.' '."\n"
.' api_key = \'\'.join(word.capitalize() for word in attr_name.split(\'_\'))'."\n"
.' query_dict[api_key] = value'."\n"
.' '."\n"
.' return open_api_models.OpenApiRequest('."\n"
.' query=query_dict,'."\n"
.' headers={}'."\n"
.' )'."\n"
."\n"
.' @staticmethod'."\n"
.' def run() -> None:'."\n"
.' client = GetDasAgentSseSample.create_client()'."\n"
.' params = GetDasAgentSseSample.create_api_info()'."\n"
.' runtime = util_models.RuntimeOptions()'."\n"
.' '."\n"
.' # 创建请求对象(可以通过命令行参数传递 query)'."\n"
.' get_das_agent_sserequest = das20200116_models.GetDasAgentSSERequest('."\n"
.' query=\'麻烦介绍下DAS Agent,相关文字在1000字左右\''."\n"
.' )'."\n"
.' '."\n"
.' # 转换为 OpenApiRequest 格式'."\n"
.' open_api_request = GetDasAgentSseSample.build_open_api_request(get_das_agent_sserequest)'."\n"
.' '."\n"
.' response = client.call_sseapi(params, open_api_request, runtime)'."\n"
.' for res in response:'."\n"
.' answer = None '."\n"
.' if hasattr(res.event, \'data\'):'."\n"
.' # event.data 可能是字符串或字典'."\n"
.' event_data = res.event.data'."\n"
.' if isinstance(event_data, str):'."\n"
.' try:'."\n"
.' event_data = json.loads(event_data)'."\n"
.' except json.JSONDecodeError:'."\n"
.' pass'."\n"
.' if isinstance(event_data, dict):'."\n"
.' answer = event_data.get(\'Answer\')'."\n"
.' if answer:'."\n"
.' print(answer, end=\'\', flush=True)'."\n"
."\n\n"
.'if __name__ == \'__main__\':'."\n"
.' GetDasAgentSseSample.run()'."\n"
.'```',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDasAgentSSE',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": \\"123e4567-e89b-12d3-a456-xxxxxxxxxxxx\\",\\n \\"Answer\\": \\"rm-xxxx\\",\\n \\"Metadata\\": {\\n \\"Code\\": -1810001,\\n \\"CharCount\\": 1403,\\n \\"ToolName\\": \\"SqlFilter\\",\\n \\"ToolParams\\": [\\n \\"[\\\\\\"--instanceId\\\\\\", \\\\\\"rm-*****\\\\\\", \\\\\\"--sqlText\\\\\\", \\\\\\"select~from~das~where~name~das1\\\\\\"]\\"\\n ],\\n \\"RequestId\\": \\"04930480-9404-50CB-8252-Axxxxxxxx\\"\\n },\\n \\"Event\\": \\"summary\\"\\n}","type":"json"}]',
],
'GetDasProServiceUsage' => [
'summary' => '调用GetDasProServiceUsage接口,查询数据库实例DAS企业版 V1或企业版 V2存储空间的使用情况。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。'."\n"
."\n"
.'> 非必填,输入目标数据库实例ID后,在调用API接口时,系统会自动获取用户ID。', 'type' => 'string', 'required' => false, 'example' => '196278346919****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'storageFreeQuotaInMB' => ['description' => '赠送的SQL洞察数据存储空间,单位为MB。', 'type' => 'number', 'format' => 'double', 'example' => '5120'],
'ip' => ['description' => '数据库实例的地址。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****.mysql.****.com'],
'userId' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。', 'type' => 'string', 'example' => '196278346919****'],
'expireTime' => ['description' => '数据库实例企业版到期时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1648742400000'],
'instanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'storageUsed' => ['description' => '数据库实例已使用的SQL洞察数据存储空间,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '35903498'],
'engine' => ['description' => '数据库引擎。', 'type' => 'string', 'example' => 'MySQL'],
'instanceAlias' => ['description' => '数据库实例名称。', 'type' => 'string', 'example' => 'TESTDB01'],
'port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int32', 'example' => '3306'],
'vpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-2zentqj1sk4qmolci****'],
'commodityInstanceId' => ['description' => 'DAS企业版ID。', 'type' => 'string', 'example' => 'daspro-cn-v0h1l6i****'],
'startTime' => ['description' => '开启企业版的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1646100892000'],
'isSpare' => ['description' => '数据库实例的企业版是否过期:'."\n"
."\n"
.'- **true**:过期。'."\n"
.'- **false**:未过期。', 'type' => 'boolean', 'example' => 'false'],
'region' => ['description' => '数据库实例所属的地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
'serviceUnitId' => ['description' => '服务单元ID。', 'type' => 'string', 'example' => '4'],
'sqlRetention' => ['description' => 'SQL洞察数据存储时长,单位为天。', 'type' => 'string', 'example' => '180'],
'migrationPredictRemainingTime' => ['description' => '旧版SQL洞察和审计迁移到新版的预计剩余时间,单位为毫秒。'."\n"
.'><notice>仅当进行旧版SQL洞察和审计迁移到新版操作时,返回此参数。'."\n"
.'></notice>', 'type' => 'integer', 'format' => 'int64', 'example' => '60000'],
],
'example' => '{ "storageFreeQuotaInMB": 5120, "ip": "rm-2ze8g2am97624****.mysql.****.com", "custinsId": 12448331, "userId": "196278346919****", "uuid": "hdm_b0ae36343407609bf3e8df8709d8****", "expireTime": 1924963200000, "instanceId": "rm-2ze8g2am97624****", "storageUsed": 10773752667393, "engine": "MySQL", "instanceAlias": "TESTDB01_PROD", "port": 3310, "vpcId": "hdm_****", "commodityInstanceId": "daspro-****", "startTime": 1606381940000, "isSpare": false, "region": "cn-shanghai", "serviceUnitId": "5", "sqlRetention": 30 }',
],
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询DAS企业版(V1或V2)存储空间使用情况',
'description' => '- 当前支持的数据库请参见[DAS企业版使用说明](~~190912~~)。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 该接口仅适用于DAS企业版 V1、V2。'."\n"
.'>推荐使用[DescribeSqlLogStatistic](~~2778836~~)接口,查询DAS企业版的数据统计信息。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDasProServiceUsage'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDasProServiceUsage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Data\\": {\\n \\"storageFreeQuotaInMB\\": 5120,\\n \\"ip\\": \\"rm-2ze8g2am97624****.mysql.****.com\\",\\n \\"userId\\": \\"196278346919****\\",\\n \\"expireTime\\": 1648742400000,\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"storageUsed\\": 35903498,\\n \\"engine\\": \\"MySQL\\",\\n \\"instanceAlias\\": \\"TESTDB01\\",\\n \\"port\\": 3306,\\n \\"vpcId\\": \\"vpc-2zentqj1sk4qmolci****\\",\\n \\"commodityInstanceId\\": \\"daspro-cn-v0h1l6i****\\",\\n \\"startTime\\": 1646100892000,\\n \\"isSpare\\": false,\\n \\"region\\": \\"cn-shanghai\\",\\n \\"serviceUnitId\\": \\"4\\",\\n \\"sqlRetention\\": \\"180\\",\\n \\"migrationPredictRemainingTime\\": 60000\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDasProServiceUsageResponse>\\n <Message>Successful</Message>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Data>\\n <storageFreeQuotaInMB>5120</storageFreeQuotaInMB>\\n <ip>rm-2ze8g2am97624****.mysql.****.com</ip>\\n <userId>196278346919****</userId>\\n <expireTime>1648742400000</expireTime>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n <storageUsed>35903498</storageUsed>\\n <engine>MySQL</engine>\\n <instanceAlias>TESTDB01</instanceAlias>\\n <port>3306</port>\\n <vpcId>vpc-2zentqj1sk4qmolci****</vpcId>\\n <commodityInstanceId>daspro-cn-v0h1l6i****</commodityInstanceId>\\n <startTime>1646100892000</startTime>\\n <isSpare>false</isSpare>\\n <region>cn-shanghai</region>\\n <serviceUnitId>4</serviceUnitId>\\n <sqlRetention>180</sqlRetention>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetDasProServiceUsageResponse>","errorExample":""}]',
],
'GetDasSQLLogHotData' => [
'summary' => '获取审计日志热数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '178715',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'Start',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 只能查询开启DAS企业版后的数据,查询开始时间最大不能早于当前时间7天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1684734297000'],
],
[
'name' => 'End',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1684820697000'],
],
[
'name' => 'QueryKeyword',
'in' => 'formData',
'schema' => [
'description' => '关键字。'."\n"
."\n"
.'> 支持模糊查询;最多支持10个关键字组合查询,关键字之间以空格分隔。例如:a1 b2 c3。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'a1 b2',
],
],
[
'name' => 'AccountName',
'in' => 'formData',
'schema' => ['description' => '数据库账号。'."\n"
."\n"
.'> 支持多个数据库账号组合查询,数据库账号间以空格分隔,例如:`user1 user2 user3`。', 'type' => 'string', 'required' => false, 'example' => 'testuser'],
],
[
'name' => 'DBName',
'in' => 'formData',
'schema' => ['description' => '数据库名。'."\n"
."\n"
.'> 支持多个数据库名组合查询,数据库名间以空格分隔,例如:`DB1 DB2 DB3`。', 'type' => 'string', 'required' => false, 'example' => 'testDB'],
],
[
'name' => 'HostAddress',
'in' => 'formData',
'schema' => ['description' => '客户端IP地址。'."\n"
."\n"
.'> 支持多个客户端IP地址组合查询,客户端IP地址间以空格分隔,例如:`IP1 IP2 IP3`。', 'type' => 'string', 'required' => false, 'example' => '47.100.XX.XX'],
],
[
'name' => 'LogicalOperator',
'in' => 'formData',
'schema' => ['description' => '多个关键字的逻辑关系。'."\n"
."\n"
.'- **or**:或。'."\n"
.'- **and**:与。', 'type' => 'string', 'required' => false, 'example' => 'or'],
],
[
'name' => 'MaxLatancy',
'in' => 'formData',
'schema' => ['description' => '最大执行耗时 ,单位为微秒。查询执行耗时小于该参数值的SQL语句。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
],
[
'name' => 'MaxScanRows',
'in' => 'formData',
'schema' => ['description' => '最大扫描行数 ,查询扫描行数小于该参数值的SQL语句。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'],
],
[
'name' => 'MinLatancy',
'in' => 'formData',
'schema' => ['description' => '最小执行耗时 ,单位为微秒。查询执行耗时大于等于该参数值的SQL语句。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'MinScanRows',
'in' => 'formData',
'schema' => ['description' => '最小扫描行数 ,查询扫描行数大于等于该参数值的SQL语句。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'SqlType',
'in' => 'formData',
'schema' => [
'description' => 'SQL语句的类型。取值:'."\n"
.'- **select**'."\n"
.'- **update**'."\n"
.'- **delete**',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['select' => '查询', 'update' => '修改', 'delete' => '删除'],
'example' => 'select',
],
],
[
'name' => 'State',
'in' => 'formData',
'schema' => ['description' => '执行结果,输入**0**时表示查询执行成功的SQL,您也可以输入具体的错误码,查询对应的SQL。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'ThreadID',
'in' => 'formData',
'schema' => ['description' => '线程ID。'."\n"
."\n"
.'> 支持多个线程ID组合查询,线程ID间以空格分隔,例如:`线程ID1 线程ID2 线程ID3`。', 'type' => 'string', 'required' => false, 'example' => '657'],
],
[
'name' => 'PageNumbers',
'in' => 'formData',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
],
[
'name' => 'MaxRecordsPerPage',
'in' => 'formData',
'schema' => ['description' => '分页查询每页最大记录数。取值范围:5~100。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
'name' => 'SortKey',
'in' => 'formData',
'schema' => ['description' => '排序依据。'."\n"
."\n"
.'- **ScanRows**:扫描行数。'."\n"
.'- **UpdateRows**:更新行数。'."\n"
.'- **Consume**:耗时。'."\n"
.'- **OriginTime**:执行时间。'."\n"
.'- **ReturnRows**:返回行数。', 'type' => 'string', 'required' => false, 'example' => 'ScanRows'],
],
[
'name' => 'SortMethod',
'in' => 'formData',
'schema' => ['description' => '排序方式。'."\n"
.'- **ASC**:正序。'."\n"
.'- **DESC**:倒序。', 'type' => 'string', 'required' => false, 'example' => 'ASC'],
],
[
'name' => 'ChildDBInstanceIDs',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp179lg03445l****'],
],
[
'name' => 'Role',
'in' => 'formData',
'schema' => ['description' => '预留参数,暂不支持。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'TraceId',
'in' => 'formData',
'schema' => ['description' => '预留参数,暂不支持。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'MinRows',
'in' => 'formData',
'schema' => ['description' => '预留参数,暂不支持。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'None'],
],
[
'name' => 'MaxRows',
'in' => 'formData',
'schema' => ['description' => '预留参数,暂不支持。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'None'],
],
[
'name' => 'MinSpillCnt',
'in' => 'formData',
'schema' => ['description' => '预留参数,暂不支持。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'None'],
],
[
'name' => 'MaxSpillCnt',
'in' => 'formData',
'schema' => ['description' => '预留参数,暂不支持。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'None'],
],
[
'name' => 'TransactionId',
'in' => 'formData',
'schema' => ['description' => '事务ID。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'Fail',
'in' => 'formData',
'schema' => ['description' => 'SQL执行错误码,您可以调用[GetAsyncErrorRequestStatByCode](~~409804~~)获取错误码。', 'type' => 'string', 'required' => false, 'example' => '1064'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => '0A74B755-98B7-59DB-8724-1321B394****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'ListResult<Map<String, Object>>',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '返回信息列表。',
'type' => 'array',
'items' => [
'description' => '返回SQL洞察和审计数据。',
'type' => 'object',
'properties' => [
'Latancy' => ['description' => '执行耗时,单位微秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'Ext' => ['description' => '扩展信息字段,备用参数。', 'type' => 'string', 'example' => 'None'],
'ExecuteTime' => ['description' => '执行时间,格式为UTC时间:`yyyy-MM-ddTHH:mm:ssZ`。', 'type' => 'string', 'example' => '2023-05-23 T12:11:20Z'],
'OriginTime' => ['description' => '执行时间,格式为UTC时间:`yyyy-MM-ddTHH:mm:ss.SSSZ`。', 'type' => 'string', 'example' => '2023-05-23 T12:11:20.999Z'],
'HostAddress' => ['description' => '客户端IP地址。', 'type' => 'string', 'example' => '47.100.XX.XX'],
'UpdateRows' => ['description' => '更新行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'LogicRead' => ['description' => '逻辑读。', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
'SQLText' => ['description' => 'SQL语句详情。', 'type' => 'string', 'example' => 'select 1'],
'LockTime' => ['description' => '锁等待时间,单位微秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ScanRows' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '29'],
'ThreadID' => ['description' => '线程ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '657'],
'State' => ['description' => '状态。返回**0**时表示执行成功,否则返回错误码。', 'type' => 'string', 'example' => '0'],
'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testDB'],
'SqlType' => ['description' => 'SQL的类型。取值:'."\n"
.'- **select**'."\n"
.'- **update**'."\n"
.'- **delete**', 'type' => 'string', 'example' => 'select'],
'AccountName' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'testuser'],
'PhysicSyncRead' => ['description' => '物理同步读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicAsyncRead' => ['description' => '物理异步读。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TransactionId' => ['description' => '开启的事务ID。', 'type' => 'string', 'example' => '0'],
'ReturnRows' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'pi-bp120roy76f3qbd84'],
],
],
],
'Total' => ['description' => '返回总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'PageNo' => ['description' => '分页页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Extra' => ['description' => '备用参数。', 'type' => 'any', 'example' => 'None'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"0A74B755-98B7-59DB-8724-1321B394****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Latancy\\": 10000,\\n \\"Ext\\": \\"None\\",\\n \\"ExecuteTime\\": \\"2023-05-23 T12:11:20Z\\",\\n \\"OriginTime\\": \\"2023-05-23 T12:11:20.999Z\\",\\n \\"HostAddress\\": \\"47.100.XX.XX\\",\\n \\"UpdateRows\\": 30,\\n \\"LogicRead\\": 12,\\n \\"SQLText\\": \\"select 1\\",\\n \\"LockTime\\": 1,\\n \\"ScanRows\\": 29,\\n \\"ThreadID\\": 657,\\n \\"State\\": \\"0\\",\\n \\"DBName\\": \\"testDB\\",\\n \\"SqlType\\": \\"select\\",\\n \\"AccountName\\": \\"testuser\\",\\n \\"PhysicSyncRead\\": 0,\\n \\"PhysicAsyncRead\\": 0,\\n \\"TransactionId\\": \\"0\\",\\n \\"ReturnRows\\": 1,\\n \\"NodeId\\": \\"pi-bp120roy76f3qbd84\\"\\n }\\n ],\\n \\"Total\\": 20,\\n \\"PageNo\\": 2,\\n \\"PageSize\\": 10,\\n \\"Extra\\": \\"None\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetDasSQLLogHotDataResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>0A74B755-98B7-59DB-8724-1321B394****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <List>\\n <Latancy>10000</Latancy>\\n <Ext>None</Ext>\\n <ExecuteTime>2023-05-23 T12:11:20Z</ExecuteTime>\\n <OriginTime>2023-05-23 T12:11:20.999Z</OriginTime>\\n <HostAddress>47.100.XX.XX</HostAddress>\\n <UpdateRows>30</UpdateRows>\\n <LogicRead>12</LogicRead>\\n <SQLText>select 1</SQLText>\\n <LockTime>1</LockTime>\\n <ScanRows>29</ScanRows>\\n <ThreadID>657</ThreadID>\\n <State>0</State>\\n <DBName>testDB</DBName>\\n <SqlType>SELECT</SqlType>\\n <AccountName>testuser</AccountName>\\n <PhysicSyncRead>0</PhysicSyncRead>\\n <PhysicAsyncRead>0</PhysicAsyncRead>\\n <TransactionId>0</TransactionId>\\n <ReturnRows>1</ReturnRows>\\n </List>\\n <Total>20</Total>\\n <PageNo>2</PageNo>\\n <PageSize>10</PageSize>\\n <Extra>None</Extra>\\n </Data>\\n</GetDasSQLLogHotDataResponse>","errorExample":""}]',
'title' => '查询DAS企业版热存储数据明细',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 适用于 Polar MySQL、RDS MYSQL、RDS PostgreSQL、RDS SQLServer。'."\n"
.'- 实例已开启日志索引。'."\n"
."\n"
.'> 查询开始时间不能早于7天以前,查询开始时间和查询结束时间的间隔不能超过1天,并且该API返回的条数最多为1W条。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDasSQLLogHotData'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDasSQLLogHotData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetDeadLockDetail' => [
'summary' => '查询单个死锁详情。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdm7GLEEO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1u5mas9exx7****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp16v3824rt73****'],
],
[
'name' => 'TextId',
'in' => 'query',
'schema' => ['description' => '查询死锁历史任务列表GetDeadLockHistory中返回的死锁TextId。', 'type' => 'string', 'required' => true, 'example' => 'a0e390cd5aca9ae964448f040153****'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['description' => '任务来源:'."\n"
.'- **MANUAL**或**不传入**:查询最近死锁分析任务。'."\n"
.'- **AUTO**:查询全量死锁分析任务。', 'type' => 'string', 'required' => false, 'example' => 'AUTO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9CB97BC4-6479-55D0-B9D0-EA925AFE****'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Synchro' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Data' => ['description' => '返回的JSON格式数据:'."\n"
."\n"
.'- accountId:用户ID。'."\n"
.'- textId:死锁文本ID。'."\n"
.'- gmtModified:诊断生成时间。'."\n"
.'- originText:LATEST DETECTED DEADLOCK的原始死锁文本或错误日志中的原始死锁文本。'."\n"
.'- deadlock:死锁详情:'."\n"
.' - occurTime:死锁发生时间。'."\n"
.' - originTextId:死锁文本ID。'."\n"
.' - rollbackTrxId:回滚的事务编号。'."\n"
.' - transactions:'."\n"
.' - deadlockIdInDB:DB中的死锁编号。'."\n"
.' - ip:访问IP。'."\n"
.' - queryId:请求ID。'."\n"
.' - queryType:请求类型。'."\n"
.' - relatedTables:相关表。'."\n"
.' - tableNamesString:相关表。'."\n"
.' - sqlText:SQL文本。'."\n"
.' - threadId:线程ID。'."\n"
.' - transactionId:事务ID。'."\n"
.' - trxIdInLock:死锁中的事务编号。'."\n"
.' - userName:数据库用户名。'."\n"
.' - waitLockIndexName:等待锁索引名。'."\n"
.' - waitLockMode:等待锁类型。'."\n"
.' - lockWait:等待锁。'."\n"
.' - holdLockIndexName:持有锁索引名。'."\n"
.' - holdLockMode:持有锁类型。'."\n"
.' - lockHold:持有锁。'."\n"
.' - trxNum:事务数量。'."\n"
.'- gmtCreate:诊断创建时间。'."\n"
.'- nodeId:节点ID。'."\n"
.'- uuid:实例ID。', 'type' => 'string', 'example' => '{'."\n"
.' "accountId": "108************",'."\n"
.' "textId": "35303d12d52d29ba73bb************",'."\n"
.' "gmtModified": 1732712680000,'."\n"
.' "originText": "LATEST DETECTED DEADLOCK****",'."\n"
.' "deadlock": "{\\"id\\":0,\\"occurTime\\":1732687047000,\\"originTextId\\":\\"35303d12d52d29ba73bb************\\",\\"rollbackTrxId\\":\\"2\\",\\"transactions\\":[{\\"deadlockIdInDB\\":0,\\"ip\\":\\"100.***.***.***\\",\\"lockWait\\":\\"index PRIMARY of table `das`.`students` trx id 15989454 lock_mode X locks rec but not gap waiting\\",\\"queryId\\":\\"386737457\\",\\"queryType\\":\\"updating\\",\\"relatedTables\\":[\\"`das`.`students`\\"],\\"sqlText\\":\\"update students set name=UUID() where id = 2 \\",\\"tableNamesString\\":\\"`das`.`students`\\",\\"threadId\\":\\"9194526\\",\\"transactionId\\":\\"15989454\\",\\"trxIdInLock\\":1,\\"userName\\":\\"das\\",\\"waitLockIndexName\\":\\"PRIMARY \\",\\"waitLockMode\\":\\"X locks rec but not gap waiting\\"},{\\"deadlockIdInDB\\":0,\\"holdLockIndexName\\":\\"PRIMARY \\",\\"holdLockMode\\":\\"X locks rec but not gap\\",\\"ip\\":\\"100.***.***.***\\",\\"lockHold\\":\\"index PRIMARY of table `das`.`students` trx id 15989451 lock_mode X locks rec but not gap\\",\\"lockWait\\":\\"index PRIMARY of table `das`.`students` trx id 15989451 lock_mode X locks rec but not gap waiting\\",\\"queryId\\":\\"386737566\\",\\"queryType\\":\\"updating\\",\\"relatedTables\\":[\\"`das`.`students`\\"],\\"sqlText\\":\\"update students set name=UUID() where id = 3 \\",\\"tableNamesString\\":\\"`das`.`students`\\",\\"threadId\\":\\"9194501\\",\\"transactionId\\":\\"15989451\\",\\"trxIdInLock\\":2,\\"userName\\":\\"das\\",\\"waitLockIndexName\\":\\"PRIMARY \\",\\"waitLockMode\\":\\"X locks rec but not gap waiting\\"}],\\"trxNum\\":2}",'."\n"
.' "gmtCreate": 1732712680000,'."\n"
.' "nodeId": "pi-8****************",'."\n"
.' "uuid": "pc-8v***************"'."\n"
.'}'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询单个死锁详情',
'description' => '本接口用于获取最近死锁分析、全量死锁分析的单个死锁详情。详情请参见[死锁分析](~~2858236~~)。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 查询最近死锁分析详情的目标数据库引擎为:RDS MySQL、自建MySQL、PolarDB MySQL版、PolarDB-X 2.0。'."\n"
.'- 查询全量死锁分析详情的目标数据库引擎为:RDS MySQL、PolarDB MySQL版,且已开通[DAS运维服务(原经济版)](~~2666482~~)。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadLockDetail'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetDeadLockDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9CB97BC4-6479-55D0-B9D0-EA925AFE****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Synchro\\": \\"None\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"accountId\\\\\\": \\\\\\"108************\\\\\\",\\\\n \\\\\\"textId\\\\\\": \\\\\\"35303d12d52d29ba73bb************\\\\\\",\\\\n \\\\\\"gmtModified\\\\\\": 1732712680000,\\\\n \\\\\\"originText\\\\\\": \\\\\\"LATEST DETECTED DEADLOCK****\\\\\\",\\\\n \\\\\\"deadlock\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"occurTime\\\\\\\\\\\\\\":1732687047000,\\\\\\\\\\\\\\"originTextId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"35303d12d52d29ba73bb************\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rollbackTrxId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"transactions\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"deadlockIdInDB\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"100.***.***.***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"lockWait\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"index PRIMARY of table `das`.`students` trx id 15989454 lock_mode X locks rec but not gap waiting\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"386737457\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queryType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"updating\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"relatedTables\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"`das`.`students`\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"sqlText\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"update students set name=UUID() where id = 2 \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableNamesString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"`das`.`students`\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"threadId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9194526\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"transactionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"15989454\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"trxIdInLock\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"userName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"das\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"waitLockIndexName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRIMARY \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"waitLockMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"X locks rec but not gap waiting\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"deadlockIdInDB\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"holdLockIndexName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRIMARY \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"holdLockMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"X locks rec but not gap\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ip\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"100.***.***.***\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"lockHold\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"index PRIMARY of table `das`.`students` trx id 15989451 lock_mode X locks rec but not gap\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"lockWait\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"index PRIMARY of table `das`.`students` trx id 15989451 lock_mode X locks rec but not gap waiting\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queryId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"386737566\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"queryType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"updating\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"relatedTables\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"`das`.`students`\\\\\\\\\\\\\\"],\\\\\\\\\\\\\\"sqlText\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"update students set name=UUID() where id = 3 \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tableNamesString\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"`das`.`students`\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"threadId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"9194501\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"transactionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"15989451\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"trxIdInLock\\\\\\\\\\\\\\":2,\\\\\\\\\\\\\\"userName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"das\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"waitLockIndexName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"PRIMARY \\\\\\\\\\\\\\",\\\\\\\\\\\\\\"waitLockMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"X locks rec but not gap waiting\\\\\\\\\\\\\\"}],\\\\\\\\\\\\\\"trxNum\\\\\\\\\\\\\\":2}\\\\\\",\\\\n \\\\\\"gmtCreate\\\\\\": 1732712680000,\\\\n \\\\\\"nodeId\\\\\\": \\\\\\"pi-8****************\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"pc-8v***************\\\\\\"\\\\n}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'GetDeadLockDetailList' => [
'summary' => '调用GetDeadLockDetailList接口,查询RDS SQL Server实例的死锁详情列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze2016723b32****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1701755730292'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1702360530292'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'string', 'required' => false, 'example' => '5'],
],
[
'name' => 'DbNameList',
'in' => 'query',
'schema' => ['description' => '数据库名。传入多个数据库时,各个数据库名称间使用英文逗号(,)进行分隔。', 'type' => 'string', 'required' => false, 'example' => 'testdb1,testdb2'."\n"],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '详细信息列表。',
'type' => 'array',
'items' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'BatchId' => ['description' => '采集的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1702301170701'],
'BlockProcessList' => [
'description' => '阻塞列表。即主动造成锁定的会话信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ClientApp' => ['description' => '当前事务所使用的客户端名称。', 'type' => 'string', 'example' => 'Microsoft SQL Server Management Studio - Query'],
'HostName' => ['description' => '主机名。', 'type' => 'string', 'example' => 'sd7402****'],
'LastTranStarted' => ['description' => '事务开启的时间。格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1702301152000'],
'LockMode' => ['description' => '锁模式。更多信息,请参见[锁模式](~~2362804~~)。', 'type' => 'string', 'example' => 'U'],
'LogUsed' => ['description' => '会话已经生成的日志大小。单位:字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '352'],
'LoginName' => ['description' => '用户登录名。', 'type' => 'string', 'example' => 'sd7402****\\\\Administrator'],
'ObjectOwned' => ['description' => '已经被锁住的对象。', 'type' => 'string', 'example' => 'testdb1.dbo.test2'],
'ObjectRequested' => ['description' => '当前事务请求加锁的对象。', 'type' => 'string', 'example' => 'testdb1.dbo.test1'],
'OwnMode' => ['description' => '会话当前持有的锁模式。更多信息,请参见[锁模式](~~2362804~~)。', 'type' => 'string', 'example' => 'X'],
'Spid' => ['description' => '开启事务的会话ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '61'],
'SqlText' => ['description' => 'SQL语句详情。', 'type' => 'string', 'example' => 'update test1 set col1 =9'],
'Status' => ['description' => '当前事务的状态。', 'type' => 'string', 'example' => 'suspended'],
'Victim' => ['description' => '是否是死锁的受害者:'."\n"
."\n"
.'- **0**:不是。'."\n"
.'- **1**:是。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'WaitMode' => ['description' => '会话当前正在等待的锁模式。更多信息,请参见[锁模式](~~2362804~~)。', 'type' => 'string', 'example' => 'U'],
'WaitResource' => ['description' => '当前事务等待中的资源。', 'type' => 'string', 'example' => 'RID: 5:1:312:0'],
'WaitResourceDescription' => ['description' => '当前事务等待中的资源详情。', 'type' => 'string', 'example' => 'RID:school:school.mdf:312:0'],
'DatabaseName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb1'],
],
'description' => '',
],
],
'ClientApp' => ['description' => '客户端名称。', 'type' => 'string', 'example' => 'Microsoft SQL Server Management Studio - Query'],
'HostName' => ['description' => '主机名。', 'type' => 'string', 'example' => 'sd7402****'],
'LastTranStarted' => ['description' => '事务开启的时间。格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1702301141000'],
'LockMode' => ['description' => '锁模式。更多信息,请参见[锁模式](~~2362804~~)。', 'type' => 'string', 'example' => 'U'],
'LogUsed' => ['description' => '会话已经生成的日志大小。单位:字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '352'],
'LoginName' => ['description' => '用户登录名。', 'type' => 'string', 'example' => 'sd7402****\\\\Administrator'],
'ObjectRequested' => ['description' => '当前事务请求加锁的对象。', 'type' => 'string', 'example' => 'testdb1.dbo.test2'],
'ObjectOwned' => ['description' => '已经被锁住的对象。', 'type' => 'string', 'example' => 'testdb1.dbo.test1'],
'OwnMode' => ['description' => '会话当前持有的锁模式。更多信息,请参见[锁模式](~~2362804~~)。', 'type' => 'string', 'example' => 'X'],
'Spid' => ['description' => '开启事务的会话ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '56'],
'SqlText' => ['description' => 'SQL语句详情。', 'type' => 'string', 'example' => 'update test2 set col1 =88'],
'Status' => ['description' => '当前事务的状态。', 'type' => 'string', 'example' => 'suspended'],
'Victim' => ['description' => '是否是死锁的受害者:'."\n"
."\n"
.'- **0**:不是。'."\n"
.'- **1**:是。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'."\n"],
'WaitMode' => ['description' => '会话当前正在等待的锁模式。更多信息,请参见[锁模式](~~2362804~~)。', 'type' => 'string', 'example' => 'U'],
'WaitResource' => ['description' => '当前事务等待中的资源。', 'type' => 'string', 'example' => 'RID: 5:1:376:0'],
'WaitResourceDescription' => ['description' => '当前事务等待中的资源详情。', 'type' => 'string', 'example' => 'RID:school:school.mdf:376:0'],
'DatabaseName' => ['description' => '数据库的名称。', 'type' => 'string', 'example' => 'testdb1'],
],
],
],
'PageNo' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Total' => ['description' => '返回总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '840F51F7-9C01-538D-94F6-AE712905****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RDS SQL Server实例的死锁列表',
'description' => '* 本接口仅适用于RDS SQL Server版实例。'."\n"
.'* 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'* 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadLockDetailList'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:GetDeadLockDetailList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"BatchId\\": 1702301170701,\\n \\"BlockProcessList\\": [\\n {\\n \\"ClientApp\\": \\"Microsoft SQL Server Management Studio - Query\\",\\n \\"HostName\\": \\"sd7402****\\",\\n \\"LastTranStarted\\": 1702301152000,\\n \\"LockMode\\": \\"U\\",\\n \\"LogUsed\\": 352,\\n \\"LoginName\\": \\"sd7402****\\\\\\\\\\\\\\\\Administrator\\",\\n \\"ObjectOwned\\": \\"testdb1.dbo.test2\\",\\n \\"ObjectRequested\\": \\"testdb1.dbo.test1\\",\\n \\"OwnMode\\": \\"X\\",\\n \\"Spid\\": 61,\\n \\"SqlText\\": \\"update test1 set col1 =9\\",\\n \\"Status\\": \\"suspended\\",\\n \\"Victim\\": 0,\\n \\"WaitMode\\": \\"U\\",\\n \\"WaitResource\\": \\"RID: 5:1:312:0\\",\\n \\"WaitResourceDescription\\": \\"RID:school:school.mdf:312:0\\",\\n \\"DatabaseName\\": \\"testdb1\\"\\n }\\n ],\\n \\"ClientApp\\": \\"Microsoft SQL Server Management Studio - Query\\",\\n \\"HostName\\": \\"sd7402****\\",\\n \\"LastTranStarted\\": 1702301141000,\\n \\"LockMode\\": \\"U\\",\\n \\"LogUsed\\": 352,\\n \\"LoginName\\": \\"sd7402****\\\\\\\\\\\\\\\\Administrator\\",\\n \\"ObjectRequested\\": \\"testdb1.dbo.test2\\",\\n \\"ObjectOwned\\": \\"testdb1.dbo.test1\\",\\n \\"OwnMode\\": \\"X\\",\\n \\"Spid\\": 56,\\n \\"SqlText\\": \\"update test2 set col1 =88\\",\\n \\"Status\\": \\"suspended\\",\\n \\"Victim\\": 1,\\n \\"WaitMode\\": \\"U\\",\\n \\"WaitResource\\": \\"RID: 5:1:376:0\\",\\n \\"WaitResourceDescription\\": \\"RID:school:school.mdf:376:0\\",\\n \\"DatabaseName\\": \\"testdb1\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 2\\n },\\n \\"RequestId\\": \\"840F51F7-9C01-538D-94F6-AE712905****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'GetDeadLockHistory' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdm7GLEEO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1u5mas9exx7****'."\n"],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp16v3824rt73****'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页大小,最大值为**100**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'><notice>该字段类型为Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于9007199254740991。></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1731983066000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'><notice>该字段类型为Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于9007199254740991。></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732069466000'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['description' => '任务来源:'."\n"
.'- **MANUAL**或**不传入**:查询最近死锁分析任务。'."\n"
.'- **AUTO**:查询全量死锁分析任务。'."\n"
.'><notice>传入AUTO查询全量死锁分析任务时,查询开始时间最大不能早于结束时间7天。></notice>', 'type' => 'string', 'required' => false, 'example' => 'AUTO'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Synchro' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'Data' => ['description' => '返回的JSON格式数据。'."\n"
."\n"
.'- total: 死锁总数。'."\n"
.'- list: 死锁列表:'."\n"
.' - accountId: 用户ID。'."\n"
.' - textId: 死锁的文本ID。'."\n"
.' - gmtModified: 诊断生成时间。'."\n"
.' - lockTime: 死锁发生时间。'."\n"
.' - gmtCreate: 诊断创建时间。'."\n"
.' - nodeId: 节点ID。'."\n"
.' - uuid: 实例ID。', 'type' => 'string', 'example' => '{'."\n"
.' "total": 2,'."\n"
.' "list": ['."\n"
.' {'."\n"
.' "accountId": "108************",'."\n"
.' "textId": "35303d12d52d29ba73bb85fa2d5b****",'."\n"
.' "gmtModified": 1732712680000,'."\n"
.' "lockTime": 1732687047000,'."\n"
.' "gmtCreate": 1732712680000,'."\n"
.' "nodeId": "pi-8****************",'."\n"
.' "uuid": "pc-8v**************"'."\n"
.' },'."\n"
.' {'."\n"
.' "accountId": "108************",'."\n"
.' "textId": "50a24bdcc5fe7e03f92a55ae7574****",'."\n"
.' "gmtModified": 1732626448000,'."\n"
.' "lockTime": 1722500305000,'."\n"
.' "gmtCreate": 1732626448000,'."\n"
.' "nodeId": "pi-8****************",'."\n"
.' "uuid": "pc-8v**************"'."\n"
.' }'."\n"
.' ]'."\n"
.'}'],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取死锁分析的任务列表',
'summary' => '获取最近死锁分析、全量死锁分析的历史分析任务列表。',
'description' => '本接口用于获取最近死锁分析、全量死锁分析的历史分析记录。详情请参见[死锁分析](~~2858236~~)。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 查询最近死锁分析历史分析记录的目标数据库引擎为:RDS MySQL、自建MySQL、PolarDB MySQL版、PolarDB-X 2.0。'."\n"
.'- 查询全量死锁分析历史分析记录的目标数据库引擎为:RDS MySQL、PolarDB MySQL版,且已开通[DAS运维服务(原经济版)](~~2666482~~)。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadLockHistory'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetDeadLockHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Synchro\\": \\"None\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"total\\\\\\": 2,\\\\n \\\\\\"list\\\\\\": [\\\\n {\\\\n \\\\\\"accountId\\\\\\": \\\\\\"108************\\\\\\",\\\\n \\\\\\"textId\\\\\\": \\\\\\"35303d12d52d29ba73bb85fa2d5b****\\\\\\",\\\\n \\\\\\"gmtModified\\\\\\": 1732712680000,\\\\n \\\\\\"lockTime\\\\\\": 1732687047000,\\\\n \\\\\\"gmtCreate\\\\\\": 1732712680000,\\\\n \\\\\\"nodeId\\\\\\": \\\\\\"pi-8****************\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"pc-8v**************\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"accountId\\\\\\": \\\\\\"108************\\\\\\",\\\\n \\\\\\"textId\\\\\\": \\\\\\"50a24bdcc5fe7e03f92a55ae7574****\\\\\\",\\\\n \\\\\\"gmtModified\\\\\\": 1732626448000,\\\\n \\\\\\"lockTime\\\\\\": 1722500305000,\\\\n \\\\\\"gmtCreate\\\\\\": 1732626448000,\\\\n \\\\\\"nodeId\\\\\\": \\\\\\"pi-8****************\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"pc-8v**************\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'GetDeadlockHistogram' => [
'summary' => '查询时间范围内基于错误日志全量死锁分析的死锁数量趋势。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '208479',
'abilityTreeNodes' => ['FEATUREhdm7GLEEO'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1u5mas9exx7****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp16v3824rt73****'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为 Unix 时间戳,单位为毫秒。'."\n"
."\n"
.'>查询开始时间最大不能早于结束时间 7 天。'."\n"
."\n"
.'><notice>该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1731983066000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为 Unix 时间戳,单位为毫秒。'."\n"
.'><notice>该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。></notice>', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1732069466000'],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => ['description' => '任务的分析状态。', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0A74B755-98B7-59DB-8724-1321B394****'],
'Success' => [
'description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。',
'type' => 'boolean',
'enumValueTitles' => ['执行成功' => 'true', '执行失败' => 'false'],
'example' => 'true',
],
'Data' => [
'title' => 'List<DeadlockTrendItem>',
'description' => '返回数据。',
'type' => 'array',
'items' => [
'description' => '返回信息列表。'."\n",
'type' => 'object',
'properties' => [
'UserId' => ['title' => '用户ID', 'description' => '用户ID。', 'type' => 'string', 'example' => '108************'],
'InstanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pc-bp1u5mas9exx7****'],
'NodeId' => ['title' => '子实例名称,对polar集群使用', 'description' => '节点ID,对PolarDB MySQL集群使用。', 'type' => 'string', 'example' => 'pi-bp16v3824rt73****'],
'TaskId' => ['title' => '死锁任务ID', 'description' => '全量死锁分析任务ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-1321B394****'],
'StartTime' => ['title' => '诊断范围开始时间', 'description' => '分析任务范围的开始时间。', 'type' => 'string', 'example' => '1729994400000'],
'EndTime' => ['title' => '诊断范围结束时间', 'description' => '分析任务范围的结束时间。', 'type' => 'string', 'example' => '1729998000000'],
'LockNumber' => ['title' => '死锁数量', 'description' => '死锁数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'Status' => ['title' => '任务状态 (SUCCESS: 诊断完成, FAILED: 诊断异常/失败)', 'description' => '任务状态:'."\n"
.'- **SUCCESS**: 分析成功。'."\n"
.'- **FAILED**: 分析异常或失败。', 'type' => 'string', 'example' => 'SUCCESS'],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询时间范围内全量死锁分析的数量趋势',
'description' => '本接口用于查询时间范围内全量死锁分析的死锁数量。DAS定时对错误日志进行分析,解析其中的死锁信息,并统计死锁的数量趋势。详情请参见[全量死锁分析](~~2858236~~)。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 目标数据库引擎为:RDS MySQL、PolarDB MySQL版,且已开通[DAS运维服务(原经济版)](~~2666482~~)。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadlockHistogram'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetDeadlockHistogram',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"0A74B755-98B7-59DB-8724-1321B394****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"UserId\\": \\"108************\\",\\n \\"InstanceId\\": \\"pc-bp1u5mas9exx7****\\",\\n \\"NodeId\\": \\"pi-bp16v3824rt73****\\",\\n \\"TaskId\\": \\"B6D17591-B48B-4D31-9CD6-1321B394****\\",\\n \\"StartTime\\": \\"1729994400000\\",\\n \\"EndTime\\": \\"1729998000000\\",\\n \\"LockNumber\\": 2,\\n \\"Status\\": \\"SUCCESS\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetErrorRequestSample' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp179lg03445l****'],
],
[
'name' => 'SqlId',
'in' => 'query',
'schema' => ['description' => 'SQL ID,您可以调用[GetAsyncErrorRequestListByCode](~~410746~~)接口查询实例中产生MySQL错误码的SQL ID。', 'type' => 'string', 'required' => false, 'example' => '2cd4432556c3dab9d825ba363637****'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642556990714'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1642566830000'],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'sqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => '2cd4432556c3dab9d825ba363637****'],
'database' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbgateway'],
'originHost' => ['description' => '执行SQL的客户端IP地址。', 'type' => 'string', 'example' => '172.16.1****'],
'tables' => [
'description' => '表数据。',
'type' => 'array',
'items' => ['description' => '表名。', 'type' => 'string', 'example' => 'meter_****'],
],
'instanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'errorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '1062'],
'user' => ['description' => '数据库用户名。', 'type' => 'string', 'example' => 'dbgat****'],
'sql' => ['description' => 'SQL语句。', 'type' => 'string', 'example' => 'insert into meter_****'],
'timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1644476100435'],
],
],
'example' => '[ { "sqlId": "2cd4432556c3dab9d825ba363637****", "database": "dbgateway", "originHost": "172.16.1****", "tables": [ "meter_****" ], "instanceId": "rm-2ze8g2am97624****", "errorCode": "1062", "user": "dbgat****", "sql": "insert into meter_****\\n ( \\n ****\\n )\\n values (now(), now(), \'bbbc8624-5e19-455a-9714-8466f688****\', \'2022-02-10 14:00:00\', \'{\\"endTime\\":\\"2022-02-10 14:00:00\\",\\"endTimestamp\\":1644472800,\\"startTime\\":\\"2022-02-10 13:00:00\\",\\"startTimestamp\\":1644469200}\', null, null)", "timestamp": 1644476100435 }]',
],
'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": [\\n {\\n \\"sqlId\\": \\"2cd4432556c3dab9d825ba363637****\\",\\n \\"database\\": \\"dbgateway\\",\\n \\"originHost\\": \\"172.16.1****\\",\\n \\"tables\\": [\\n \\"meter_****\\"\\n ],\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"errorCode\\": \\"1062\\",\\n \\"user\\": \\"dbgat****\\",\\n \\"sql\\": \\"insert into meter_****\\",\\n \\"timestamp\\": 1644476100435\\n }\\n ],\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetErrorRequestSampleResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <sqlId>2cd4432556c3dab9d825ba363637****</sqlId>\\n <database>dbgateway</database>\\n <originHost>172.16.1****</originHost>\\n <tables>meter_****</tables>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n <errorCode>1062</errorCode>\\n <user>dbgat****</user>\\n <sql>insert into meter_****</sql>\\n <timestamp>1644476100435</timestamp>\\n </Data>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Success>true</Success>\\n</GetErrorRequestSampleResponse>","errorExample":""}]',
'title' => '查询执行错误的SQL样本数据',
'summary' => '调用GetErrorRequestSample接口,异步查询数据库实例SQL洞察结果中执行错误的SQL样本数据,最多返回指定时间范围内20条数据。',
'description' => '> 异步调用后不会立即返回完整结果,当返回数据中**isFinish**取值为**false**时,请等待1s后重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。'."\n"
."\n\n"
.'- 目前仅支持RDS MySQL和PolarDB MySQL版实例,请确保在使用该接口前,该实例已经开启DAS企业版,具体请参见[购买DAS企业版](~~163298~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetErrorRequestSample'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetErrorRequestSample',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetEventSubscription' => [
'summary' => '调用GetEventSubscription接口,获取数据库实例的事件订阅设置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'."\n"],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'userId' => ['title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1088760496****'],
'instanceId' => ['title' => '实例ID。', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'eventContext' => ['title' => '事件场景。', 'description' => '支持的事件场景,当前仅支持**AllContext**,表示支持所有场景。', 'type' => 'string', 'example' => 'AllContext'],
'lang' => ['title' => '语言', 'description' => '事件通知的语言,当前仅支持**zh-CN**,表示事件通知为中文。', 'type' => 'string', 'example' => 'zh_CN'],
'active' => ['title' => '是否开启。', 'description' => '是否启用事件订阅:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'minInterval' => ['title' => '通知最小间隔。', 'description' => '通知最小间隔时间,单位秒(s)。', 'type' => 'string', 'example' => '60'],
'contactName' => ['title' => '告警订阅人。', 'description' => '告警事件订阅人名称,多个名称间以英文逗号分隔。', 'type' => 'string', 'example' => 'Default contact'],
'contactGroupName' => ['title' => '告警订阅组', 'description' => '告警事件订阅组名称,多个名称间以英文逗号分隔。', 'type' => 'string', 'example' => 'Default contact group'],
'channelType' => ['title' => '通知方式。', 'description' => '通知方式:'."\n"
."\n"
.'- **hdm\\_alarm\\_sms**:手机短信。'."\n"
.'- **dingtalk**:钉钉机器人。'."\n"
.'- **hdm\\_alarm\\_sms\\_and\\_email**:手机短信+邮件。'."\n"
.'- **hdm\\_alarm\\_sms,dingtalk**:手机短信+钉钉机器人。', 'type' => 'string', 'example' => 'hdm_alarm_sms,dingtalk'],
'level' => ['title' => '事件风险级别。', 'description' => '事件风险级别,即触发哪种级别的事件后需要通知您:'."\n"
."\n"
.'- **Notice**:通知。'."\n"
.'- **Optimization**:优化。'."\n"
.'- **Warn**:警告。'."\n"
.'- **Critical**:严重。', 'type' => 'string', 'example' => 'Optimization'],
'contacts' => [
'title' => '告警联系人信息。',
'description' => '告警联系人列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'name' => ['title' => '告警联系人名称。', 'description' => '告警联系人名称。', 'type' => 'string', 'example' => 'Mr. Zhang'],
'phone' => ['title' => '告警联系人电话', 'description' => '告警联系人电话。', 'type' => 'string', 'example' => '1390000****'],
'email' => ['title' => '告警联系人邮箱。', 'description' => '告警联系人邮箱。', 'type' => 'string', 'example' => 'a***@example.net'],
'dingtalkHook' => ['title' => '告警联系人钉钉机器人webhook。', 'description' => '钉钉机器人的Webhook地址。', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****'],
'groups' => [
'title' => '告警联系人所属联系组列表。',
'description' => '告警联系人所属的联系组列表。',
'type' => 'array',
'items' => ['description' => '告警联系人名称。', 'type' => 'string', 'example' => '张先生'],
'example' => 'Mr. Zhang',
],
'isCmsReduplicated' => ['title' => '是否和云监控上的联系人重名。', 'description' => '是否和云监控上的联系人姓名相同。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'userId' => ['title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1088760496****'],
],
'description' => '',
],
],
'contactGroups' => [
'description' => '告警联系组列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'name' => ['title' => '告警联系人组姓名。', 'description' => '告警联系组名称。', 'type' => 'string', 'example' => '张先生'],
'description' => ['title' => '告警联系人组描述。', 'description' => '告警联系组描述。', 'type' => 'string', 'example' => 'Default contact'],
'contacts' => ['title' => '告警联系人组内成员。', 'description' => '告警联系组成员列表。', 'type' => 'string', 'example' => '"[\\"Mr. Zhang\\",\\"Mr. Wang\\",\\"Mr. Li\\"]"'],
'userId' => ['title' => '用户ID。', 'description' => '用户ID。', 'type' => 'string', 'example' => '1088760496****'],
],
'description' => '',
],
],
'eventSendGroup' => [
'title' => '对应事件订阅的场景。',
'description' => '支持发送的事件场景列表。',
'type' => 'array',
'items' => ['description' => '支持发送的事件场景,当前仅支持**AllContext**,表示支持所有场景。', 'type' => 'string', 'example' => 'AllContext'],
],
'id' => ['title' => '订阅关系序号。', 'description' => '数据库主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'gmtCreate' => ['title' => '创建时间。', 'description' => '开启事件订阅的时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633071840000'],
'gmtModified' => ['title' => '最后修改时间。', 'description' => '最后修改事件订阅设置的时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1633071850000'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"userId\\": \\"1088760496****\\",\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"eventContext\\": \\"AllContext\\",\\n \\"lang\\": \\"zh_CN\\",\\n \\"active\\": 1,\\n \\"minInterval\\": \\"60\\",\\n \\"contactName\\": \\"Default contact\\",\\n \\"contactGroupName\\": \\"Default contact group\\",\\n \\"channelType\\": \\"hdm_alarm_sms,dingtalk\\",\\n \\"level\\": \\"Optimization\\",\\n \\"contacts\\": [\\n {\\n \\"name\\": \\"Mr. Zhang\\",\\n \\"phone\\": \\"1390000****\\",\\n \\"email\\": \\"a***@example.net\\",\\n \\"dingtalkHook\\": \\"https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****\\",\\n \\"groups\\": [\\n \\"张先生\\"\\n ],\\n \\"isCmsReduplicated\\": true,\\n \\"userId\\": \\"1088760496****\\"\\n }\\n ],\\n \\"contactGroups\\": [\\n {\\n \\"name\\": \\"张先生\\",\\n \\"description\\": \\"Default contact\\",\\n \\"contacts\\": \\"\\\\\\"[\\\\\\\\\\\\\\"Mr. Zhang\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Mr. Wang\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Mr. Li\\\\\\\\\\\\\\"]\\\\\\"\\",\\n \\"userId\\": \\"1088760496****\\"\\n }\\n ],\\n \\"eventSendGroup\\": [\\n \\"AllContext\\"\\n ],\\n \\"id\\": 1,\\n \\"gmtCreate\\": 1633071840000,\\n \\"gmtModified\\": 1633071850000\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetEventSubscriptionResponse>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Message>Successful</Message>\\n <Data>\\n <userId>1088760496****</userId>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n <eventContext>AllContext</eventContext>\\n <lang>zh_CN</lang>\\n <active>1</active>\\n <minInterval>60</minInterval>\\n <contactName>默认联系人</contactName>\\n <contactGroupName>默认联系组</contactGroupName>\\n <channelType>hdm_alarm_sms,dingtalk</channelType>\\n <level>Optimization</level>\\n <contacts>\\n <name>张先生</name>\\n <phone>1390000****</phone>\\n <email>a***@example.net</email>\\n <dingtalkHook>https://oapi.dingtalk.com/robot/send?access_token=68fa29a9eaf3ba9994f54fxxxc1aa9879700308f90e9c23ebfb3663642c9****</dingtalkHook>\\n <groups>张先生</groups>\\n <isCmsReduplicated>true</isCmsReduplicated>\\n <userId>1088760496****</userId>\\n </contacts>\\n <contactGroups>\\n <name>张先生</name>\\n <description>默认联系人</description>\\n <contacts>\\"[\\\\\\"张先生\\\\\\",\\\\\\"王女士\\\\\\",\\\\\\"李先生\\\\\\"]\\"</contacts>\\n <userId>1088760496****</userId>\\n </contactGroups>\\n <eventSendGroup>AllContext</eventSendGroup>\\n <id>1</id>\\n <gmtCreate>1633071840000</gmtCreate>\\n <gmtModified>1633071850000</gmtModified>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetEventSubscriptionResponse>","errorExample":""}]',
'title' => '获取事件订阅设置',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 数据库实例已接入DAS。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEventSubscription'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetEventSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetFullRequestOriginStatByInstanceId' => [
'methods' => ['post'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。'."\n"
."\n"
.'> 非必填,输入目标数据库实例ID后,在调用API接口时,系统会自动获取用户ID。', 'type' => 'string', 'required' => false, 'example' => '196278346919****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp12v7243x012****'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1644716649000'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.' '."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1644803409000'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,默认为**count**。'."\n"
."\n"
.'- **count**:执行次数。'."\n"
."\n"
.'- **avgRt**:平均执行时间。'."\n"
."\n"
.'- **rtRate**:耗时比例。'."\n"
."\n"
.'- **rowsExamined**:总扫描行数。'."\n"
."\n"
.'- **avgRowsExamined**:平均扫描行数。'."\n"
."\n"
.'- **avgRowsReturned**:平均返回行数。', 'type' => 'string', 'required' => false, 'example' => 'count'],
],
[
'name' => 'Asc',
'in' => 'query',
'schema' => ['description' => '升序排序开关,默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'False'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询每页最大记录数,默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
],
[
'name' => 'SqlType',
'in' => 'query',
'schema' => ['description' => 'SQL语句的类型,取值包括:**SELECT**、**INSERT**、**UPDATE**、**DELETE**、**MERGE**、**ALTER**、**CREATEINDEX**、**DROPINDEX**、**CREATE**、**DROP**、**SET**、**DESC**、**REPLACE**、**CALL**、**BEGIN**、**DESCRIBE**、**ROLLBACK**、**FLUSH**、**USE**、**SHOW**、**START**、**COMMIT**和**RENAME**。'."\n"
."\n"
.'> 当数据库实例为RDS MySQL、PolarDB MySQL版、PolarDB-X 2.0时,可以通过SQL语句类型进行统计。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => ['description' => 'PolarDB-X 2.0数据库实例节点(角色)信息。'."\n"
."\n"
.'- **polarx_cn**:计算节点。'."\n"
."\n"
.'- **polarx_en**:数据节点。'."\n", 'type' => 'string', 'required' => false, 'example' => 'polarx_cn'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息的详细列表。',
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '全量请求数据列表。',
'type' => 'array',
'items' => [
'description' => '全量请求数据列表。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '执行SQL的客户端IP地址。', 'type' => 'string', 'example' => '172.26.6****'],
'AvgFetchRows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点平均拉取数据节点的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AvgLockWaitTime' => ['description' => '平均锁等待时长,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.00009589874265269765'],
'AvgLogicalRead' => ['description' => '平均逻辑读。', 'type' => 'number', 'format' => 'double', 'example' => '654.4470327860251'],
'AvgPhysicalAsyncRead' => ['description' => '平均物理异步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AvgPhysicalSyncRead' => ['description' => '平均物理同步读取。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'AvgRows' => ['description' => '平均行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AvgExaminedRows' => ['description' => '平均扫描行数。'."\n"
."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'AvgReturnedRows' => ['description' => '平均返回行数。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'AvgUpdatedRows' => ['description' => '平均修改行数。'."\n"
."\n"
.'> 目前支持该字段的数据库:RDS MySQL、PolarDB-X 2.0。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'AvgRt' => ['description' => '平均执行耗时。', 'type' => 'number', 'format' => 'double', 'example' => '2.499'],
'AvgSqlCount' => ['description' => '平均SQL数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'Count' => ['description' => '总执行次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
'CountRate' => ['description' => '执行次数比例。', 'type' => 'number', 'format' => 'double', 'example' => '0.0586'],
'Database' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbtest01'],
'ErrorCount' => ['description' => '执行错误次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'FetchRows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点拉取数据节点的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Ip' => ['description' => '实例的网络地址。', 'type' => 'string', 'example' => 'rm-uf6dyi58dm6****.mysql.rds.aliy****.com'],
'LockWaitTime' => ['description' => '锁等待时长,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '1089.4177720290281'],
'LogicalRead' => ['description' => '逻辑读。', 'type' => 'integer', 'format' => 'int64', 'example' => '7.434573266E9'],
'OriginHost' => ['description' => '执行SQL的客户端IP地址。', 'type' => 'string', 'example' => '172.26.6****'],
'PhysicalAsyncRead' => ['description' => '物理异步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicalSyncRead' => ['description' => '物理同步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int64', 'example' => '3306'],
'Rows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ExaminedRows' => ['description' => '总扫描行数。'."\n"
."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'RtGreaterThanOneSecondCount' => ['description' => '执行时长大于1秒的SQL数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'RtRate' => ['description' => '耗时比例。', 'type' => 'number', 'format' => 'double', 'example' => '0.1384'],
'SqlCount' => ['description' => 'SQL的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'SumUpdatedRows' => ['description' => '总变更行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Version' => ['description' => '版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-2zentqj1sk4qmolci****'],
],
],
],
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"Key\\": \\"172.26.6****\\",\\n \\"AvgFetchRows\\": 0,\\n \\"AvgLockWaitTime\\": 0.00009589874265269765,\\n \\"AvgLogicalRead\\": 654.4470327860251,\\n \\"AvgPhysicalAsyncRead\\": 0,\\n \\"AvgPhysicalSyncRead\\": 0,\\n \\"AvgRows\\": 0,\\n \\"AvgExaminedRows\\": 10000,\\n \\"AvgReturnedRows\\": 10000,\\n \\"AvgUpdatedRows\\": 10000,\\n \\"AvgRt\\": 2.499,\\n \\"AvgSqlCount\\": 10000,\\n \\"Count\\": 100000,\\n \\"CountRate\\": 0.0586,\\n \\"Database\\": \\"dbtest01\\",\\n \\"ErrorCount\\": 1,\\n \\"FetchRows\\": 200,\\n \\"Ip\\": \\"rm-uf6dyi58dm6****.mysql.rds.aliy****.com\\",\\n \\"LockWaitTime\\": 1089.4177720290281,\\n \\"LogicalRead\\": 7434573266,\\n \\"OriginHost\\": \\"172.26.6****\\",\\n \\"PhysicalAsyncRead\\": 0,\\n \\"PhysicalSyncRead\\": 0,\\n \\"Port\\": 3306,\\n \\"Rows\\": 0,\\n \\"ExaminedRows\\": 10000,\\n \\"RtGreaterThanOneSecondCount\\": 2,\\n \\"RtRate\\": 0.1384,\\n \\"SqlCount\\": 200,\\n \\"SumUpdatedRows\\": 200,\\n \\"Version\\": 1,\\n \\"VpcId\\": \\"vpc-2zentqj1sk4qmolci****\\"\\n }\\n ],\\n \\"Total\\": 1\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetFullRequestOriginStatByInstanceIdResponse>\\n <Message>Successful</Message>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Data>\\n <List>\\n <Key>172.26.6****</Key>\\n <AvgFetchRows>0</AvgFetchRows>\\n <AvgLockWaitTime>0.00009589874265269765</AvgLockWaitTime>\\n <AvgLogicalRead>654.4470327860251</AvgLogicalRead>\\n <AvgPhysicalAsyncRead>0</AvgPhysicalAsyncRead>\\n <AvgPhysicalSyncRead>0</AvgPhysicalSyncRead>\\n <AvgRows>0</AvgRows>\\n <AvgExaminedRows>10000</AvgExaminedRows>\\n <AvgReturnedRows>10000</AvgReturnedRows>\\n <AvgUpdatedRows>10000</AvgUpdatedRows>\\n <AvgRt>2.499</AvgRt>\\n <AvgSqlCount>10000</AvgSqlCount>\\n <Count>100000</Count>\\n <CountRate>0.0586</CountRate>\\n <Database>dbtest01</Database>\\n <ErrorCount>1</ErrorCount>\\n <FetchRows>200</FetchRows>\\n <Ip>rm-uf6dyi58dm6****.mysql.rds.aliy****.com</Ip>\\n <LockWaitTime>1089.4177720290281</LockWaitTime>\\n <OriginHost>172.26.6****</OriginHost>\\n <PhysicalAsyncRead>0</PhysicalAsyncRead>\\n <PhysicalSyncRead>0</PhysicalSyncRead>\\n <Port>3306</Port>\\n <Rows>0</Rows>\\n <ExaminedRows>10000</ExaminedRows>\\n <RtGreaterThanOneSecondCount>2</RtGreaterThanOneSecondCount>\\n <RtRate>0.1384</RtRate>\\n <SqlCount>200</SqlCount>\\n <SumUpdatedRows>200</SumUpdatedRows>\\n <Version>1</Version>\\n <VpcId>vpc-2zentqj1sk4qmolci****</VpcId>\\n </List>\\n <Total>1</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetFullRequestOriginStatByInstanceIdResponse>","errorExample":""}]',
'title' => '按照访问来源统计全量请求数据',
'summary' => '调用GetFullRequestOriginStatByInstanceId接口,按照访问来源统计数据库实例SQL洞察结果中的全量请求数据。',
'description' => 'SQL洞察功能可对SQL进行健康情况诊断、性能问题排查,详情请参见[SQL洞察](~~204096~~)。'."\n"
."\n"
.'- 目前支持的数据库实例请参见[DAS企业版使用说明](~~190912~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFullRequestOriginStatByInstanceId'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetFullRequestOriginStatByInstanceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetFullRequestSampleByInstanceId' => [
'summary' => '调用GetFullRequestSampleByInstanceId接口,按照SQL ID查询数据库实例SQL洞察结果中的SQL样本数据,最大返回20条样本数据。',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'UserId',
'in' => 'formData',
'schema' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。'."\n"
."\n"
.'> 非必填,输入目标数据库实例ID后,在调用API接口时,系统会自动获取用户ID。', 'type' => 'string', 'required' => false, 'example' => '196278346919****'],
],
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'SqlId',
'in' => 'formData',
'schema' => ['description' => 'SQL ID。', 'type' => 'string', 'required' => true, 'example' => '651b56fe9418d48edb8fdf0980ec****'],
],
[
'name' => 'Start',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需要在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1660097421000'],
],
[
'name' => 'End',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能小于1小时。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1660104621000'],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => ['description' => 'PolarDB-X 2.0数据库实例节点信息。'."\n"
."\n"
.'- **polarx_cn**:计算节点。'."\n"
.'- **polarx_en**:数据节点。', 'type' => 'string', 'required' => false, 'example' => 'polarx_cn'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '0A74B755-98B7-59DB-8724-1321B394****'],
'Data' => [
'description' => '返回数据',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '执行SQL的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1660100753556'],
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => '651b56fe9418d48edb8fdf0980ec****'],
'Sql' => ['description' => 'SQL样本。', 'type' => 'string', 'example' => 'select * from testdb01 where ****'],
'Database' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbtest'],
'Rt' => ['description' => '执行耗时,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.409789'],
'User' => ['description' => '执行SQL的用户名称。', 'type' => 'string', 'example' => 'testuser'],
'LockWaitTime' => ['description' => '锁等待时长,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.0137'],
'LogicalRead' => ['description' => '逻辑读。', 'type' => 'number', 'format' => 'double', 'example' => '165848'],
'PhysicalSyncRead' => ['description' => '物理同步读取。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'PhysicalAsyncRead' => ['description' => '物理异步读取。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'RowsExamined' => ['title' => '扫描行数', 'description' => '总扫描行数。'."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'integer', 'format' => 'int64', 'example' => '2048576'],
'RowsReturned' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '14'],
'OriginHost' => ['description' => '访问来源。', 'type' => 'string', 'example' => '172.17.XX.XX'],
'ScanRows' => ['title' => '扫描行数, RDS MySQL DescribeTemplateSqlDetail', 'description' => '扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'UpdateRows' => ['title' => '更新行数, RDS MySQL DescribeTemplateSqlDetail', 'description' => '更新行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SqlType' => ['description' => 'SQL语句的类型,取值包括:**SELECT**、**INSERT**、**UPDATE**、**DELETE**、**LOGIN**、**LOGOUT**、**MERGE**、**ALTER**、**CREATEINDEX**、**DROPINDEX**、**CREATE**、**DROP**、**SET**、**DESC**、**REPLACE**、**CALL**、**BEGIN**、**DESCRIBE**、**ROLLBACK**、**FLUSH**、**USE**、**SHOW**、**START**、**COMMIT**和**RENAME**。', 'type' => 'string', 'example' => 'SELECT'],
'Scnt' => ['title' => 'polarx cn节点,dn请求总数', 'description' => 'PolarDB-X 2.0计算节点(CN)的DN请求数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Rows' => ['title' => 'polarx cn节点,总更新/返回行数', 'description' => 'PolarDB-X 2.0计算节点(CN)的更新/返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Frows' => ['title' => 'polarx cn节点,拉取行数', 'description' => 'PolarDB-X 2.0计算节点(CN)的拉取行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
],
'description' => '',
],
],
'Code' => ['description' => '返回的状态码。'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '按照SQL ID查询SQL样本数据',
'description' => 'SQL洞察功能可对SQL进行健康情况诊断、性能问题排查,详情请参见[SQL洞察](~~204096~~)。'."\n"
."\n"
.'- 支持的数据库引擎请参见[SQL洞察](~~204096~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFullRequestSampleByInstanceId'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetFullRequestSampleByInstanceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"0A74B755-98B7-59DB-8724-1321B394****\\",\\n \\"Data\\": [\\n {\\n \\"Timestamp\\": 1660100753556,\\n \\"SqlId\\": \\"651b56fe9418d48edb8fdf0980ec****\\",\\n \\"Sql\\": \\"select * from testdb01 where ****\\",\\n \\"Database\\": \\"dbtest\\",\\n \\"Rt\\": 0.409789,\\n \\"User\\": \\"testuser\\",\\n \\"LockWaitTime\\": 0.0137,\\n \\"LogicalRead\\": 165848,\\n \\"PhysicalSyncRead\\": 0,\\n \\"PhysicalAsyncRead\\": 0,\\n \\"RowsExamined\\": 2048576,\\n \\"RowsReturned\\": 14,\\n \\"OriginHost\\": \\"172.17.XX.XX\\",\\n \\"ScanRows\\": 0,\\n \\"UpdateRows\\": 0,\\n \\"SqlType\\": \\"SELECT\\",\\n \\"Scnt\\": 0,\\n \\"Rows\\": 0,\\n \\"Frows\\": 0\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetFullRequestSampleByInstanceIdResponse>\\n <Message>Successful</Message>\\n <RequestId>0A74B755-98B7-59DB-8724-1321B394****</RequestId>\\n <Data>\\n <Timestamp>1660100753556</Timestamp>\\n <SqlId>651b56fe9418d48edb8fdf0980ec****</SqlId>\\n <Sql>select * from testdb01 where ****</Sql>\\n <Database>dbtest</Database>\\n <Rt>0.409789</Rt>\\n <User>testuser</User>\\n <LockWaitTime>0.0137</LockWaitTime>\\n <LogicalRead>165848</LogicalRead>\\n <PhysicalSyncRead>0</PhysicalSyncRead>\\n <PhysicalAsyncRead>0</PhysicalAsyncRead>\\n <RowsExamined>2048576</RowsExamined>\\n <RowsReturned>14</RowsReturned>\\n <OriginHost>172.17.XX.XX</OriginHost>\\n <ScanRows>0</ScanRows>\\n <UpdateRows>0</UpdateRows>\\n <SqlType>SELECT</SqlType>\\n <Scnt>0</Scnt>\\n <Rows>0</Rows>\\n <Frows>0</Frows>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetFullRequestSampleByInstanceIdResponse>","errorExample":""}]',
],
'GetFullRequestStatResultByInstanceId' => [
'methods' => ['post'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['description' => '用户ID,即创建数据库实例的阿里云主账号ID。'."\n"
."\n"
.'> 非必填,输入目标数据库实例ID后,在调用API接口时,系统会自动获取用户ID。', 'type' => 'string', 'required' => false, 'example' => '196278346919****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp12v7243x012****'],
],
[
'name' => 'SqlId',
'in' => 'query',
'schema' => ['description' => 'SQL ID。'."\n"
."\n"
.'> 填写SQL ID时,统计目标SQL ID的全量请求数据;为空时,统计整个数据库实例的全量请求数据。', 'type' => 'string', 'required' => false, 'example' => 'd71f82be1eef72bd105128204d2e****'],
],
[
'name' => 'OriginHost',
'in' => 'query',
'schema' => ['description' => '执行SQL的客户端IP地址。'."\n"
."\n"
.'> 非必填,输入目标客户端IP地址后,统计目标客户端IP地址的全量请求数据;为空时,统计整个数据库实例的全量请求数据。', 'type' => 'string', 'required' => false, 'example' => '172.26.XX.XXX'],
],
[
'name' => 'Keyword',
'in' => 'query',
'schema' => ['description' => '查询关键词。', 'type' => 'string', 'required' => false, 'example' => 'dbtest01'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间需要在数据库实例SQL洞察存储时长范围内,最大不能早于当前时间90天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1645581813000'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,且查询开始时间和查询结束时间的间隔不能超过1天。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1645668213000'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,默认为**count**。'."\n"
."\n"
.'- **count**:执行次数。'."\n"
."\n"
.'- **avgRt**:平均执行时间。'."\n"
."\n"
.'- **rtRate**:耗时比例。'."\n"
."\n"
.'- **rowsExamined**:总扫描行数。'."\n"
."\n"
.'- **avgRowsExamined**:平均扫描行数。'."\n"
."\n"
.'- **avgRowsReturned**:平均返回行数。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'count'],
],
[
'name' => 'Asc',
'in' => 'query',
'schema' => ['description' => '升序排序开关,默认关闭。', 'type' => 'boolean', 'required' => false, 'example' => 'False'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询每页数据量,默认为20。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
],
[
'name' => 'SqlType',
'in' => 'query',
'schema' => ['description' => 'SQL语句的类型,取值包括:**SELECT**、**INSERT**、**UPDATE**、**DELETE**、**LOGIN**、**LOGOUT**、**MERGE**、**ALTER**、**CREATEINDEX**、**DROPINDEX**、**CREATE**、**DROP**、**SET**、**DESC**、**REPLACE**、**CALL**、**BEGIN**、**DESCRIBE**、**ROLLBACK**、**FLUSH**、**USE**、**SHOW**、**START**、**COMMIT**和**RENAME**。'."\n"
."\n"
.'> 当数据库实例为RDS MySQL、PolarDB MySQL版、PolarDB-X 2.0时,可以通过SQL语句类型进行统计。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'],
],
[
'name' => 'DbName',
'in' => 'query',
'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => false, 'example' => 'dbtest01'],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => ['description' => 'PolarDB-X 2.0数据库实例节点信息。'."\n"
."\n"
.'- **polarx_cn**:计算节点。'."\n"
."\n"
.'- **polarx_dn**:数据节点。', 'type' => 'string', 'required' => false, 'example' => 'polarx_cn'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息的详细列表。',
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Result' => [
'description' => '返回的全量请求数据。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '全量请求数据列表。',
'type' => 'array',
'items' => [
'description' => '全量请求数据列表。',
'type' => 'object',
'properties' => [
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => 'd71f82be1eef72bd105128204d2e****'],
'AvgFetchRows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点平均拉取数据节点的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AvgLockWaitTime' => ['description' => '平均锁等待时长,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.00009589874265269765'],
'AvgLogicalRead' => ['description' => '平均逻辑读。', 'type' => 'number', 'format' => 'double', 'example' => '654.4470327860251'],
'AvgPhysicalAsyncRead' => ['description' => '平均物理异步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AvgPhysicalSyncRead' => ['description' => '平均物理同步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'AvgExaminedRows' => ['description' => '平均扫描行数。'."\n"
."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'AvgReturnedRows' => ['description' => '平均返回行数。', 'type' => 'number', 'format' => 'double', 'example' => '10000'],
'AvgUpdatedRows' => ['description' => '平均修改行数。'."\n"
."\n"
.'> 目前支持该字段的数据库:RDS MySQL、PolarDB-X 2.0。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'AvgRt' => ['description' => '平均执行耗时。', 'type' => 'number', 'format' => 'double', 'example' => '2.499'],
'AvgSqlCount' => ['description' => '平均SQL计数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'Count' => ['description' => '总执行次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
'CountRate' => ['description' => '执行次数比例。', 'type' => 'number', 'format' => 'double', 'example' => '0.0586'],
'Database' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbtest01'],
'ErrorCount' => ['description' => '执行错误次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'FetchRows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点拉取数据节点的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Ip' => ['description' => '实例的网络地址。', 'type' => 'string', 'example' => 'rm-uf6dyi58dm6****.mysql.rds.aliy****.com'],
'LockWaitTime' => ['description' => '锁等待时长,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '1089.4177720290281'],
'LogicalRead' => ['description' => '逻辑读。', 'type' => 'integer', 'format' => 'int64', 'example' => '7.434573266E9'],
'PhysicalAsyncRead' => ['description' => '物理异步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicalSyncRead' => ['description' => '物理同步读取。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Port' => ['description' => '端口号。', 'type' => 'integer', 'format' => 'int64', 'example' => '3306'],
'Psql' => ['description' => 'SQL模板。', 'type' => 'string', 'example' => 'select * from dbtest01 where ****'],
'Rows' => ['description' => 'PolarDB-X 2.0数据库实例计算节点总更新或返回的行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ExaminedRows' => ['description' => '总扫描行数。'."\n"
."\n"
.'> 目前支持该字段的数据库:RDS MySQL、RDS PostgreSQL、PolarDB MySQL版。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'RtGreaterThanOneSecondCount' => ['description' => '执行时长大于1秒的SQL数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'RtRate' => ['description' => '耗时比例。', 'type' => 'number', 'format' => 'double', 'example' => '2.499'],
'SqlCount' => ['description' => 'SQL的数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'SumUpdatedRows' => ['description' => '总变更行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'Tables' => [
'description' => '数据库表名。',
'type' => 'array',
'items' => ['description' => '数据库表名。'."\n", 'type' => 'string', 'example' => 'tabletest01,tabletest02'],
],
'Version' => ['description' => '版本。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-2zentqj1sk4qmolci****'],
],
],
],
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
'Fail' => ['description' => '请求是否失败。'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'IsFinish' => ['description' => '异步请求是否执行完成。'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'ResultId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '9CB97BC4-6479-55D0-B9D0-EA925AFE****'],
'State' => ['description' => '异步请求的执行状态。'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1645668213000'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"Data\\": {\\n \\"Result\\": {\\n \\"List\\": [\\n {\\n \\"SqlId\\": \\"d71f82be1eef72bd105128204d2e****\\",\\n \\"AvgFetchRows\\": 0,\\n \\"AvgLockWaitTime\\": 0.00009589874265269765,\\n \\"AvgLogicalRead\\": 654.4470327860251,\\n \\"AvgPhysicalAsyncRead\\": 0,\\n \\"AvgPhysicalSyncRead\\": 0,\\n \\"AvgExaminedRows\\": 10000,\\n \\"AvgReturnedRows\\": 10000,\\n \\"AvgUpdatedRows\\": 10000,\\n \\"AvgRt\\": 2.499,\\n \\"AvgSqlCount\\": 10000,\\n \\"Count\\": 100000,\\n \\"CountRate\\": 0.0586,\\n \\"Database\\": \\"dbtest01\\",\\n \\"ErrorCount\\": 1,\\n \\"FetchRows\\": 0,\\n \\"Ip\\": \\"rm-uf6dyi58dm6****.mysql.rds.aliy****.com\\",\\n \\"LockWaitTime\\": 1089.4177720290281,\\n \\"LogicalRead\\": 7434573266,\\n \\"PhysicalAsyncRead\\": 0,\\n \\"PhysicalSyncRead\\": 0,\\n \\"Port\\": 3306,\\n \\"Psql\\": \\"select * from dbtest01 where ****\\",\\n \\"Rows\\": 0,\\n \\"ExaminedRows\\": 10000,\\n \\"RtGreaterThanOneSecondCount\\": 20,\\n \\"RtRate\\": 2.499,\\n \\"SqlCount\\": 200,\\n \\"SumUpdatedRows\\": 100,\\n \\"Tables\\": [\\n \\"tabletest01,tabletest02\\"\\n ],\\n \\"Version\\": 1,\\n \\"VpcId\\": \\"vpc-2zentqj1sk4qmolci****\\"\\n }\\n ],\\n \\"Total\\": 1\\n },\\n \\"Fail\\": false,\\n \\"IsFinish\\": true,\\n \\"ResultId\\": \\"9CB97BC4-6479-55D0-B9D0-EA925AFE****\\",\\n \\"State\\": \\"SUCCESS\\",\\n \\"Timestamp\\": 1645668213000\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetFullRequestStatResultByInstanceIdResponse>\\n <Message>Successful</Message>\\n <RequestId>7172BECE-588A-5961-8126-C216E16B****</RequestId>\\n <Data>\\n <Result>\\n <List>\\n <SqlId>d71f82be1eef72bd105128204d2e****</SqlId>\\n <AvgFetchRows>0</AvgFetchRows>\\n <AvgLockWaitTime>0.00009589874265269765</AvgLockWaitTime>\\n <AvgLogicalRead>654.4470327860251</AvgLogicalRead>\\n <AvgPhysicalAsyncRead>0</AvgPhysicalAsyncRead>\\n <AvgPhysicalSyncRead>0</AvgPhysicalSyncRead>\\n <AvgExaminedRows>10000</AvgExaminedRows>\\n <AvgReturnedRows>10000</AvgReturnedRows>\\n <AvgUpdatedRows>10000</AvgUpdatedRows>\\n <AvgRt>2.499</AvgRt>\\n <AvgSqlCount>10000</AvgSqlCount>\\n <Count>100000</Count>\\n <CountRate>0.0586</CountRate>\\n <Database>dbtest01</Database>\\n <ErrorCount>1</ErrorCount>\\n <FetchRows>0</FetchRows>\\n <Ip>rm-uf6dyi58dm6****.mysql.rds.aliy****.com</Ip>\\n <LockWaitTime>1089.4177720290281</LockWaitTime>\\n <PhysicalAsyncRead>0</PhysicalAsyncRead>\\n <PhysicalSyncRead>0</PhysicalSyncRead>\\n <Port>3306</Port>\\n <Psql>select * from dbtest01 where ****</Psql>\\n <Rows>0</Rows>\\n <ExaminedRows>10000</ExaminedRows>\\n <RtGreaterThanOneSecondCount>20</RtGreaterThanOneSecondCount>\\n <RtRate>2.499</RtRate>\\n <SqlCount>200</SqlCount>\\n <SumUpdatedRows>100</SumUpdatedRows>\\n <Tables>tabletest01,tabletest02</Tables>\\n <Version>1</Version>\\n <VpcId>vpc-2zentqj1sk4qmolci****</VpcId>\\n </List>\\n <Total>1</Total>\\n </Result>\\n <Fail>false</Fail>\\n <IsFinish>true</IsFinish>\\n <ResultId>9CB97BC4-6479-55D0-B9D0-EA925AFE****</ResultId>\\n <State>SUCCESS</State>\\n <Timestamp>1645668213000</Timestamp>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetFullRequestStatResultByInstanceIdResponse>","errorExample":""}]',
'title' => '按照SQL ID异步统计全量请求数据',
'summary' => '调用GetFullRequestStatResultByInstanceId接口,按照SQL ID异步统计数据库实例SQL洞察结果中的全量请求数据。',
'description' => '> 异步调用后不会立即返回完整结果,当返回数据中isFinish取值为**false**时,请等待1s后重新发起调用,直到isFinish取值为**true**时,返回完整结果。'."\n"
."\n"
.'SQL洞察功能可对SQL进行健康情况诊断、性能问题排查,详情请参见[SQL洞察](~~204096~~)。'."\n"
."\n"
.'- 目前支持的数据库实例请参见[DAS企业版使用说明](~~190912~~)。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 2024年09月01日起,由于SQL的模板化算法优化,调用本接口时,SqlId 字段的值将发生变更。详情请参见[【通知】SQL模板化算法优化](~~2845725~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFullRequestStatResultByInstanceId'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetFullRequestStatResultByInstanceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetHDMAliyunResourceSyncResult' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'accessKey',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'signature',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'timestamp',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => '__context',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'skipAuth',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'default' => 'true', 'description' => ''],
],
[
'name' => 'UserId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['type' => 'string', 'description' => ''],
'RequestId' => ['type' => 'string', 'description' => ''],
'Synchro' => ['type' => 'string', 'description' => ''],
'Data' => [
'type' => 'object',
'properties' => [
'SyncStatus' => ['type' => 'string', 'description' => ''],
'ErrorMsg' => ['type' => 'string', 'description' => ''],
'SubResults' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ResourceSyncSubResult' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SyncCount' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
'ResourceType' => ['type' => 'string', 'description' => ''],
'Success' => ['type' => 'boolean', 'description' => ''],
'ErrMsg' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'description' => '',
],
],
'description' => '',
],
'Results' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
'Code' => ['type' => 'string', 'description' => ''],
'Success' => ['type' => 'string', 'description' => ''],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHDMAliyunResourceSyncResult'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetHDMAliyunResourceSyncResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Synchro\\": \\"\\",\\n \\"Data\\": {\\n \\"SyncStatus\\": \\"\\",\\n \\"ErrorMsg\\": \\"\\",\\n \\"SubResults\\": {\\n \\"ResourceSyncSubResult\\": [\\n {\\n \\"SyncCount\\": 0,\\n \\"ResourceType\\": \\"\\",\\n \\"Success\\": true,\\n \\"ErrMsg\\": \\"\\"\\n }\\n ]\\n },\\n \\"Results\\": \\"\\"\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": \\"\\"\\n}","type":"json"}]',
],
'GetInstanceGroupInspectReportDetail' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmJC65CS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ReportId',
'in' => 'formData',
'schema' => ['title' => '报告ID', 'description' => '运维报告ID', 'type' => 'string', 'required' => true, 'example' => '13f52040-5a6e-42c3-bb84-051f5d6d****'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '用户购买的智能体ID。', 'type' => 'string', 'required' => false, 'example' => 'ag-472T0DxtmjIxxxxx'],
],
[
'name' => 'ReportType',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回的消息。'."\n"
."\n"
.'> 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* true:执行成功'."\n"
.'* false:执行失败'."\n", 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'ReportDetail',
'description' => 'ReportDetail',
'type' => 'object',
'properties' => [
'ReportId' => ['description' => '报告ID', 'type' => 'string', 'example' => '13f52040-5a6e-42c3-bb84-051f5d6d****'."\n"],
'ReportDetail' => ['description' => '运维报告的内容,主要包括报告日期、纳管实例的诊断详情。', 'type' => 'string', 'example' => '"### 概要\\n\\n报告日期:2025-12-10 \\n对比周期:[昨日日期] → 2025-12-10 以下省略"'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询DAS Agent运维报告明细',
'summary' => '获取DAS Agent运维报告详情。',
'description' => '开启DAS Agent的运维报告功能可让系统对目标实例进行定期巡检并给出报告。当前仅支持生成日报。该接口用于查询报告明细。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 用户开通DAS Agent并且该Agent仍在有效期。'."\n"
.'- 用户在DAS Agent的配置页面,开启日报功能。'."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.3或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceGroupInspectReportDetail',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"ReportId\\": \\"13f52040-5a6e-42c3-bb84-051f5d6d****\\\\n\\",\\n \\"ReportDetail\\": \\"\\\\\\"### 概要\\\\\\\\n\\\\\\\\n报告日期:2025-12-10 \\\\\\\\n对比周期:[昨日日期] → 2025-12-10 以下省略\\\\\\"\\"\\n }\\n}","type":"json"}]',
],
'GetInstanceGroupInspectReportList' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmJC65CS'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '保留参数', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'AgentId',
'in' => 'query',
'schema' => ['description' => '可选,默认使用默认Agent进行服务,或者传入开启DASAgent服务后生成的或者主动创建的Agent', 'type' => 'string', 'required' => false, 'example' => 'ag-472T0DxtmjIxxxxx'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['title' => '开始时间戳', 'description' => '开始时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1596177993000'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['title' => '结束时间戳', 'description' => '结束时间戳', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1655427625000'],
],
[
'name' => 'ReportType',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* **true**:执行成功。'."\n"
.'* **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'List<ReportStatus>',
'description' => 'List<ReportStatus>',
'type' => 'array',
'items' => [
'description' => '详细信息列表,报告ID、任务日期、任务状态。',
'type' => 'object',
'properties' => [
'ReportId' => ['description' => '报告ID', 'type' => 'string', 'example' => '13f52040-5a6e-42c3-bb84-051f5d6d****'],
'Status' => ['title' => '任务状态 WAITING_UNREADY = 0 WAITING_READY = 1 PROCESSING = 2 FINISHED = 3 ERROR = 4 STOPPED = -1', 'description' => '任务状态 WAITING_UNREADY = 0 WAITING_READY = 1 PROCESSING = 2 FINISHED = 3 ERROR = 4 STOPPED = -1', 'type' => 'string', 'example' => '3'],
'ReportDate' => ['title' => '诊断的日期', 'description' => '诊断的日期', 'type' => 'string', 'example' => '2025-12-10'],
'CreateTime' => ['description' => '任务创建时间。', 'type' => 'string', 'example' => '2025-12-11 00:39:00'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询DAS Agent运维报告列表',
'summary' => '用于查询DAS Agent生成的运维报告列表。',
'description' => '开启DAS Agent的运维报告功能可让系统对目标实例进行定期巡检并给出报告。当前仅支持生成日报。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
.'- 用户开通DAS Agent并且该Agent仍在有效期。'."\n"
.'- 用户在DAS Agent的配置页面,开启日报功能。'."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.3或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceGroupInspectReportList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"ReportId\\": \\"13f52040-5a6e-42c3-bb84-051f5d6d****\\",\\n \\"Status\\": \\"3\\",\\n \\"ReportDate\\": \\"2025-12-10\\",\\n \\"CreateTime\\": \\"2025-12-11 00:39:00\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetInstanceInspections' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '24190',
'abilityTreeNodes' => ['FEATUREhdmB8MM4L'],
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **Redis**'."\n"
.'- **PolarDB MySQL**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySQL'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1655416825000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>任务结束时间需晚于任务开始时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1655427625000'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'InstanceArea',
'in' => 'query',
'schema' => ['description' => '实例所属的数据库产品,取值:'."\n"
."\n"
.'* **RDS**:云实例。'."\n"
.'* **ECS**:ECS自建实例。'."\n"
.'* **IDC**:非公有云自建实例。'."\n"
."\n"
.'> IDC为用户数据中心。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RDS'],
],
[
'name' => 'SearchMap',
'in' => 'query',
'schema' => ['description' => '过滤条件,可以按照如下条件进行过滤:'."\n"
."\n"
.'- 以单个实例ID为过滤条件时,输入格式为:{"InstanceId":"实例ID"}。'."\n"
.'- 以多个实例ID为过滤条件时,输入格式为:{"InstanceIds":\\["实例ID1","实例ID2"\\]},其中实例ID间以英文逗号(,)分隔。'."\n"
.'- 以实例所在地域为过滤条件时,输入格式为:{"region":"实例所在地域"}。', 'type' => 'string', 'required' => false, 'example' => '{"InstanceId":"rm-bp10usoc1erj7****"}'],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2eil6npi****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Data' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '详细信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EndTime' => ['description' => '任务结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>任务结束时间需晚于任务开始时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296001'],
'StartTime' => ['description' => '任务开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296000'],
'Data' => ['description' => '返回的数据。', 'type' => 'object', 'example' => '"data": { "hasDeadLock": false, "exceptionTableMap": {}, "bigTransactionCount": 0, "cpu": 4, "isRds": true, "rdsEnable": true, "enable": false, "activeSessions": [], "bigTransactionList": [], "bigSessionList": [ { "blockDuration": 0, "active": false, "Time": 0, "db": "" },'],
'Instance' => [
'description' => '实例信息。',
'type' => 'object',
'properties' => [
'VpcId' => ['description' => '实例的VPC ID。', 'type' => 'string', 'example' => 'vpc-bp1knt7m55z9exoo7****'],
'Uuid' => ['description' => '实例的唯一标识符号。', 'type' => 'string', 'example' => 'hdm_3063db6792965c080a4bcb6e6304****'],
'InstanceArea' => ['description' => '实例所属的数据库产品,取值:'."\n"
."\n"
.'- **RDS**:云实例。'."\n"
.'- **ECS**:ECS自建实例。'."\n"
.'- **IDC**:非公有云自建实例。'."\n"
.'> IDC为用户数据中心。', 'type' => 'string', 'example' => 'RDS'],
'InstanceClass' => ['description' => '实例的规格。', 'type' => 'string', 'example' => 'rds.mysql.s2.xlarge'],
'Region' => ['description' => '实例所属的地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'AccountId' => ['description' => '账号ID,您可在阿里云**账号管理**的**安全设置**页面获取登录账号的ID。', 'type' => 'string', 'example' => '108398049688****'],
'NetworkType' => ['description' => '实例的网络类型。', 'type' => 'string', 'example' => 'VPC'],
'Engine' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **Redis**'."\n"
.'- **PolarDBMySQL**', 'type' => 'string', 'example' => 'MySQL'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-bp10usoc1erj7****'],
'NodeId' => ['description' => '实例的节点ID。', 'type' => 'string', 'example' => 'rm-bp10usoc1erj7****'],
'EngineVersion' => ['description' => '数据库引擎的版本号。', 'type' => 'string', 'example' => '8.0'],
'InstanceAlias' => ['description' => '实例名称', 'type' => 'string', 'example' => 'test-01'],
'Cpu' => ['description' => 'CPU规格,例如返回8时代表CPU规格为8核。', 'type' => 'string', 'example' => '8'],
'Memory' => ['description' => '数据库内存,单位为MB。', 'type' => 'integer', 'format' => 'int32', 'example' => '32768'],
'Storage' => ['description' => '存储空间,单位为GB。', 'type' => 'integer', 'format' => 'int32', 'example' => '150'],
'Category' => ['description' => '实例的访问模式,取值:'."\n"
.'- **standard**:标准访问模式。'."\n"
.'- **safe**:数据库代理模式。', 'type' => 'string', 'example' => 'standard'],
],
],
'ScoreMap' => ['description' => '扣分详情。', 'type' => 'object'],
'GmtCreate' => ['description' => '任务的创建时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1603247192000'],
'Score' => ['description' => '巡检得分。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'AutoFunction' => [
'description' => '自治功能开启情况。',
'type' => 'object',
'properties' => [
'EventSubscription' => ['description' => '事件订阅:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。'."\n"
.'- **2**:不支持。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AutoIndex' => ['description' => '自动索引创建和删除:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。'."\n"
.'- **2**:不支持。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AutoLimitedSql' => ['description' => '自动限流:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。'."\n"
.'- **2**:不支持。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'AutoResourceOptimize' => ['description' => '空间碎片自动回收:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。'."\n"
.'- **2**:不支持。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'AutoScale' => ['description' => '自动弹性伸缩:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。'."\n"
.'- **2**:不支持。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
'EnableDasPro' => ['description' => 'DAS企业版:'."\n"
."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。'."\n"
.'- **2**:不支持。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'State' => ['description' => '巡检任务状态:'."\n"
."\n"
.'- **0**:等待执行。'."\n"
.'- **1**:正在执行。'."\n"
.'- **2**:巡检完成。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'TaskType' => ['description' => '巡检任务发起类型:'."\n"
."\n"
.'- **0**:自动。'."\n"
.'- **1**:手动。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
'description' => '',
],
],
'PageNo' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取数据库实例巡检评分结果',
'summary' => '调用GetInstanceInspections接口,获取数据库实例巡检评分的结果。',
'description' => 'DAS支持巡检评分功能,可以对目标实例进行定期巡检并给出健康评分,帮助您清楚地了解数据库运行情况,更多信息,请参见[巡检评分](~~205659~~)。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 本接口只适用于RDS MySQL、ECS上的MySQL自建库、IDC MySQL自建库、云数据库 Tair(兼容 Redis)、PolarDB MySQL版。'."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.3或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceInspections'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceInspections',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"EndTime\\": 1608888296001,\\n \\"StartTime\\": 1608888296000,\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Instance\\": {\\n \\"VpcId\\": \\"vpc-bp1knt7m55z9exoo7****\\",\\n \\"Uuid\\": \\"hdm_3063db6792965c080a4bcb6e6304****\\",\\n \\"InstanceArea\\": \\"RDS\\",\\n \\"InstanceClass\\": \\"rds.mysql.s2.xlarge\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"AccountId\\": \\"108398049688****\\",\\n \\"NetworkType\\": \\"VPC\\",\\n \\"Engine\\": \\"MySQL\\",\\n \\"InstanceId\\": \\"rm-bp10usoc1erj7****\\",\\n \\"NodeId\\": \\"rm-bp10usoc1erj7****\\",\\n \\"EngineVersion\\": \\"8.0\\",\\n \\"InstanceAlias\\": \\"test-01\\",\\n \\"Cpu\\": \\"8\\",\\n \\"Memory\\": 32768,\\n \\"Storage\\": 150,\\n \\"Category\\": \\"standard\\"\\n },\\n \\"ScoreMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"GmtCreate\\": 1603247192000,\\n \\"Score\\": 100,\\n \\"AutoFunction\\": {\\n \\"EventSubscription\\": 0,\\n \\"AutoIndex\\": 2,\\n \\"AutoLimitedSql\\": 2,\\n \\"AutoResourceOptimize\\": 0,\\n \\"AutoScale\\": 0\\n },\\n \\"EnableDasPro\\": 0,\\n \\"State\\": 2,\\n \\"TaskType\\": 0\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 4\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceInspectionsResponse>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Data>\\n <List>\\n <EndTime>1608888296001</EndTime>\\n <StartTime>1608888296000</StartTime>\\n <Instance>\\n <VpcId>vpc-bp1knt7m55z9exoo7****</VpcId>\\n <Uuid>hdm_3063db6792965c080a4bcb6e6304****</Uuid>\\n <InstanceArea>RDS</InstanceArea>\\n <InstanceClass>rds.mysql.s2.xlarge</InstanceClass>\\n <Region>cn-hangzhou</Region>\\n <AccountId>108398049688****</AccountId>\\n <NetworkType>VPC</NetworkType>\\n <Engine>MySQL</Engine>\\n <InstanceId>rm-bp10usoc1erj7****</InstanceId>\\n <NodeId>rm-bp10usoc1erj7****</NodeId>\\n <EngineVersion>8.0</EngineVersion>\\n <InstanceAlias>test-01</InstanceAlias>\\n <Cpu>8</Cpu>\\n <Memory>32768</Memory>\\n <Storage>150</Storage>\\n <Category>standard</Category>\\n </Instance>\\n <GmtCreate>1603247192000</GmtCreate>\\n <Score>100</Score>\\n <AutoFunction>\\n <EventSubscription>0</EventSubscription>\\n <AutoIndex>2</AutoIndex>\\n <AutoLimitedSql>2</AutoLimitedSql>\\n <AutoResourceOptimize>0</AutoResourceOptimize>\\n <AutoScale>0</AutoScale>\\n </AutoFunction>\\n <EnableDasPro>0</EnableDasPro>\\n <State>2</State>\\n <TaskType>0</TaskType>\\n </List>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Total>4</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetInstanceInspectionsResponse>","errorExample":""}]',
],
'GetInstanceMissingIndexList' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-t4nfalp2ap421****'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,默认值为10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'ObjectName',
'in' => 'query',
'schema' => ['description' => '对象名。', 'type' => 'string', 'required' => false, 'example' => 'bas_customer'],
],
[
'name' => 'ReservedSize',
'in' => 'query',
'schema' => ['description' => '表总空间筛选条件。单位为MB。输入格式为`运算符+分割服“|”+表总空间大小`,例如筛选条件设置为查询总空间大于等于100M的表时,输入:`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|100'],
],
[
'name' => 'RowCount',
'in' => 'query',
'schema' => ['description' => '表记录数筛选条件。输入格式为`运算符+分割服“|”+表记录数`,例如`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|100000'],
],
[
'name' => 'ReservedPages',
'in' => 'query',
'schema' => ['description' => '总页数筛选条件。输入格式为`运算符+分割服“|”+总页数`,例如`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|100'],
],
[
'name' => 'IndexCount',
'in' => 'query',
'schema' => ['description' => '索引个数(索引缺失表目前所拥有的索引个数)筛选条件。输入格式为`运算符+分割服“|”+索引个数`,例如`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|8'],
],
[
'name' => 'UniqueCompiles',
'in' => 'query',
'schema' => ['description' => '编译次数筛选条件。输入格式为`运算符+分割服“|”+编译次数`,例如`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|10000'],
],
[
'name' => 'UserSeeks',
'in' => 'query',
'schema' => ['description' => '查找次数筛选条件。输入格式为`运算符+分割服“|”+查找次数`,例如`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|1000'],
],
[
'name' => 'UserScans',
'in' => 'query',
'schema' => ['description' => '扫描次数筛选条件。输入格式为`运算符+分割服“|”+扫描次数`,例如`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>=|10000'],
],
[
'name' => 'AvgTotalUserCost',
'in' => 'query',
'schema' => ['description' => '平均开销节约百分比(预测建立了缺失索引后,用户的平均CPU开销节约百分比。)筛选条件。输入格式为`运算符+分割服“|”+平均开销节约百分比`,例如筛选条件设置为查询平均开销节约百分比小于等于10%时,输入:`<=|10`。', 'type' => 'string', 'required' => false, 'example' => '<=|8'],
],
[
'name' => 'AvgUserImpact',
'in' => 'query',
'schema' => ['description' => '性能提升百分比(预测建立了缺失索引后,用户的平均查询性能提升百分比。)筛选条件。输入格式为`运算符+分割服“|”+性能提升百分比`,例如筛选条件设置为查询性能提升百分比大于等于100%时,输入:`>=|100`。', 'type' => 'string', 'required' => false, 'example' => '>|10000'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '索引最后查找时间的开始时间。格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => false, 'example' => '1679414400000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '索引最后查找时间的结束时间。格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => false, 'example' => '1681869544000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'List' => [
'description' => '返回信息列表。',
'type' => 'array',
'items' => [
'description' => '记录详情。',
'type' => 'object',
'properties' => [
'AvgTotalUserCost' => ['description' => '预测建立了缺失索引后,用户的平均CPU开销节约百分比。', 'type' => 'number', 'format' => 'double', 'example' => '4.67'],
'AvgUserImpact' => ['description' => '预测建立了缺失索引后,用户的平均查询性能提升百分比。', 'type' => 'number', 'format' => 'double', 'example' => '98.3'."\n"],
'DatabaseName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb'],
'EqualityColumns' => ['description' => '相等列。缺失索引被使用来做等于查询的列。', 'type' => 'string', 'example' => 'col1,col2,col3'],
'IncludedColumns' => ['description' => '包含列。缺失索引包含列。', 'type' => 'string', 'example' => 'col3,col4'],
'IndexCount' => ['description' => '索引个数。索引缺失表目前所拥有的索引个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'LastUserSeek' => ['description' => '用户最后查找时间。缺失索引用户最后的查找时间点。', 'type' => 'integer', 'format' => 'int64', 'example' => '1702023327000'],
'ObjectName' => ['description' => '对象名。', 'type' => 'string', 'example' => 'stu'],
'ReservedPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '5025'],
'ReservedSize' => ['description' => '总空间大小。', 'type' => 'number', 'format' => 'double', 'example' => '39.26'],
'RowCount' => ['description' => '记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '226945'],
'SchemaName' => ['description' => '架构名。', 'type' => 'string', 'example' => 'dbo'],
'SystemScans' => ['description' => '扫描次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SystemSeeks' => ['description' => '查找次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'UniqueCompiles' => ['description' => '编译次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2392'],
'UserScans' => ['description' => '用户扫描次数。索引缺失表被扫描的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'UserSeeks' => ['description' => '用户查找次数。索引缺失被查找的次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1081'],
'InequalityColumns' => ['description' => '不等列。缺失索引被使用来做不等于查询的列。', 'type' => 'string', 'example' => '2392'],
'CreateIndex' => ['description' => '索引创建语句。您可以使用这个语句来创建缺失索引。', 'type' => 'string', 'example' => 'CREATE INDEX [IX_CLOUDDBA_school_dbo_stu@col1_@col2] ON [school].[dbo].[stu]([col1],[col2],[col3]) INCLUDE ([col4],[col5]) WITH (FILLFACTOR = 90, ONLINE = OFF);'],
],
],
],
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '0A74B755-98B7-59DB-8724-1321B394****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询RDS SQL Server实例索引缺失情况',
'summary' => '调用GetInstanceMissingIndexList接口,查询RDS SQL Server实例所有缺失索引的详细信息。',
'description' => '* 本接口仅适用于RDS SQL Server版实例。'."\n"
.'* 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'* 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceMissingIndexList'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:GetInstanceMissingIndexList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"List\\": [\\n {\\n \\"AvgTotalUserCost\\": 4.67,\\n \\"AvgUserImpact\\": 98.3,\\n \\"DatabaseName\\": \\"testdb\\",\\n \\"EqualityColumns\\": \\"col1,col2,col3\\",\\n \\"IncludedColumns\\": \\"col3,col4\\",\\n \\"IndexCount\\": 1,\\n \\"LastUserSeek\\": 1702023327000,\\n \\"ObjectName\\": \\"stu\\",\\n \\"ReservedPages\\": 5025,\\n \\"ReservedSize\\": 39.26,\\n \\"RowCount\\": 226945,\\n \\"SchemaName\\": \\"dbo\\",\\n \\"SystemScans\\": 0,\\n \\"SystemSeeks\\": 0,\\n \\"UniqueCompiles\\": 2392,\\n \\"UserScans\\": 0,\\n \\"UserSeeks\\": 1081,\\n \\"InequalityColumns\\": \\"2392\\",\\n \\"CreateIndex\\": \\"CREATE INDEX [IX_CLOUDDBA_school_dbo_stu@col1_@col2] ON [school].[dbo].[stu]([col1],[col2],[col3]) INCLUDE ([col4],[col5]) WITH (FILLFACTOR = 90, ONLINE = OFF);\\"\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 16\\n },\\n \\"RequestId\\": \\"0A74B755-98B7-59DB-8724-1321B394****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'GetInstanceSqlOptimizeStatistic' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '数据库实例ID。'."\n"
."\n"
.'> 仅支持RDS MySQL、PolarDB MySQL版数据库实例。', 'type' => 'string', 'required' => true, 'example' => 'pc-wz90h9560rvdz****'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '开始时间', 'description' => '查询开始时间,格式为Unix时间戳(UTC时间),单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1661308902060'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '结束时间', 'description' => '查询结束时间,格式为Unix时间戳(UTC时间),单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1662518540764'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['title' => '子节点ID', 'description' => '节点ID。'."\n"
."\n"
.'> 对于RDS MySQL集群系列数据库实例或PolarDB MySQL版数据库实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-bp12v7243x012****'],
],
[
'name' => 'Threshold',
'in' => 'query',
'schema' => ['title' => '阈值', 'description' => '自动SQL优化事件的持续时间阈值。'."\n"
.'设置此参数后,只会统计持续时间不超过阈值的自动SQL优化事件。'."\n"
."\n"
.'> 此参数为备用参数,当前暂不生效。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'FilterEnable',
'in' => 'query',
'schema' => [
'title' => '是否过滤专业版',
'description' => '是否过滤开启了DAS企业版的数据库实例:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'> 取值为**true**时,只统计未开启DAS企业版的数据库实例;取值为**false**时,统计所有数据库实例。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'false',
],
],
[
'name' => 'UseMerging',
'in' => 'query',
'schema' => [
'title' => '是否合并事件',
'description' => '是否合并事件:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'> 此参数为备用参数,当前暂不生效。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'true',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'count' => ['title' => 'SQL自动优化事件总数', 'description' => '自动SQL优化事件总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '16'],
'improvement' => ['title' => '收益倍数', 'description' => '返回的自动SQL优化事件中,SQL优化后的最大收益倍数。', 'type' => 'number', 'format' => 'double', 'example' => '1003'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => ' 获取自动SQL优化事件的统计数据',
'summary' => '调用GetInstanceSqlOptimizeStatistic接口,获取指定时间段内自动SQL优化任务的统计数据,包括任务总数和最大收益等。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 数据库引擎为RDS MySQL或PolarDB MySQL版。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceSqlOptimizeStatistic'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceSqlOptimizeStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"count\\": 16,\\n \\"improvement\\": 1003\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetInstanceSqlOptimizeStatisticResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <count>16</count>\\n <improvement>1003</improvement>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetInstanceSqlOptimizeStatisticResponse>","errorExample":""}]',
],
'GetKillInstanceSessionTaskResult' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'pi-8vbkfj5a756um****'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '<props="china">任务ID,调用[CreateKillInstanceSessionTask](~~609246~~)接口时返回的任务ID。</props>'."\n"
."\n"
.'<props="intl">任务ID,调用[CreateKillInstanceSessionTask](~~609246~~)接口时返回的任务ID。</props>'."\n", 'type' => 'string', 'required' => true, 'example' => 'f77d535b45405bd462b21caa3ee8****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => 'f77d535b45405bd462b21caa3ee8****'],
'UserId' => ['description' => '阿里云主账号ID。', 'type' => 'string', 'example' => '164882191396****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
'NodeId' => ['description' => '节点ID。'."\n"
."\n"
.'> PolarDB MySQL版实例的结束会话任务才会返回该数据。', 'type' => 'string', 'example' => 'pi-bp1h12rv501cv****'],
'TaskState' => ['description' => '结束会话任务的状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
.'- **SUCCESS**:成功。'."\n"
.'- **FAILURE**:失败。'."\n"
.'- **ERROR**:其他错误。', 'type' => 'string', 'example' => 'SUCCESS'],
'Sessions' => [
'description' => '需要结束的会话ID列表。'."\n"
."\n"
.'> 结束全部会话时,实例或节点上的所有会话ID列表。',
'type' => 'array',
'items' => ['description' => '会话ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '['."\n"
.'152,'."\n"
.'112,'."\n"
.'106,'."\n"
.'146,'."\n"
.'8357323,'."\n"
.'5697053,'."\n"
.'8357518,'."\n"
.'8357519,'."\n"
.'14964383'."\n"
.']'],
],
'KillSuccessCount' => ['description' => '结束成功的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'KillFailCount' => ['description' => '结束失败的会话数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'IgnoredUserSessionCount' => ['description' => '指定的不会被结束的会话数量,包含忽略列表中账号的会话、阿里云内部运维账号的会话和**Binlog Dump**会话。', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
'Result' => [
'description' => '结束会话的详情列表。',
'type' => 'array',
'items' => [
'description' => '结束会话的详情。',
'type' => 'object',
'properties' => [
'Id' => ['description' => '会话ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '8357518'],
'User' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'testUser'],
'Host' => ['description' => '发起该会话主机的IP地址和端口。', 'type' => 'string', 'example' => '100.104.XX.XX:23428'],
'Db' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbTest'],
'Command' => ['description' => '会话执行的命令类型。', 'type' => 'string', 'example' => 'Sleep'],
'Time' => ['description' => '执行时间,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'State' => ['description' => '会话状态。', 'type' => 'string', 'example' => 'Sending data'],
'Info' => ['description' => '会话执行的SQL语句。', 'type' => 'string', 'example' => 'SELECT sleep(60)'],
'Active' => ['description' => '是否是活跃会话。'."\n"
."\n"
.'> 活跃会话判断逻辑: 命令是Query或者Execute,以及未结束事务中的会话。', 'type' => 'boolean', 'example' => 'true'],
'TaskId' => ['description' => '结束该会话的子任务ID。', 'type' => 'string', 'example' => 'task_d9e94107-6116-4ac3-b874-81466aff****'],
'Reason' => ['description' => '结束该会话时的结果描述。'."\n"
.'- **SESSION_KILLED**:结束会话成功。'."\n"
.'- **SESSION_EXPIRED**:会话已过期。'."\n"
.'- **SESSION\\_NO\\_PERMISSION**:用于结束会话的账号权限不足。'."\n"
.'- **SESSION\\_ACCOUNT\\_ERROR**:用于结束会话的账号或密码错误。'."\n"
.'- **SESSION\\_IGNORED\\_USER**:不需要结束的账号的会话。'."\n"
.'- **SESSION\\_INTERNAL\\_USER\\_OR\\_COMMAND**:阿里云运维账号的会话或者命令。'."\n"
.'- **SESSION\\_KILL\\_TASK\\_TIMEOUT**:结束会话超时。'."\n"
.'- **SESSION\\_OTHER\\_ERROR**:其他错误。', 'type' => 'string', 'example' => 'SESSION_KILLED'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取结束会话任务的结果',
'summary' => '调用GetKillInstanceSessionTaskResult接口,获取结束会话任务的结果。',
'description' => '- 本接口只适用于RDS MySQL和PolarDB MySQL版实例。'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKillInstanceSessionTaskResult'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetKillInstanceSessionTaskResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"f77d535b45405bd462b21caa3ee8****\\",\\n \\"UserId\\": \\"164882191396****\\",\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\",\\n \\"NodeId\\": \\"pi-bp1h12rv501cv****\\",\\n \\"TaskState\\": \\"SUCCESS\\",\\n \\"Sessions\\": [\\n 0\\n ],\\n \\"KillSuccessCount\\": 100,\\n \\"KillFailCount\\": 0,\\n \\"IgnoredUserSessionCount\\": 9,\\n \\"Result\\": [\\n {\\n \\"Id\\": 8357518,\\n \\"User\\": \\"testUser\\",\\n \\"Host\\": \\"100.104.XX.XX:23428\\",\\n \\"Db\\": \\"dbTest\\",\\n \\"Command\\": \\"Sleep\\",\\n \\"Time\\": 1,\\n \\"State\\": \\"Sending data\\",\\n \\"Info\\": \\"SELECT sleep(60)\\",\\n \\"Active\\": true,\\n \\"TaskId\\": \\"task_d9e94107-6116-4ac3-b874-81466aff****\\",\\n \\"Reason\\": \\"SESSION_KILLED\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetKillInstanceSessionTaskResultResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <TaskId>f77d535b45405bd462b21caa3ee8****</TaskId>\\n <UserId>164882191396****</UserId>\\n <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>\\n <TaskState>SUCCESS</TaskState>\\n <KillSuccessCount>100</KillSuccessCount>\\n <KillFailCount>0</KillFailCount>\\n <IgnoredUserSessionCount>9</IgnoredUserSessionCount>\\n <Result>\\n <Id>8357518</Id>\\n <User>testUser</User>\\n <Host>100.104.XX.XX:23428</Host>\\n <Db>dbTest</Db>\\n <Command>Sleep</Command>\\n <Time>1</Time>\\n <State>Sending data</State>\\n <Info>SELECT sleep(60)</Info>\\n <Active>true</Active>\\n <TaskId>task_d9e94107-6116-4ac3-b874-81466aff****</TaskId>\\n <Reason>SESSION_KILLED</Reason>\\n </Result>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetKillInstanceSessionTaskResultResponse>","errorExample":""}]',
],
'GetMongoDBCurrentOp' => [
'summary' => '调用GetMongoDBCurrentOp接口,获取MongoDB实例当前会话。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'dds-uf6079bda570****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 不提供节点ID时,默认获取Primary节点会话。', 'type' => 'string', 'required' => false, 'example' => '23302531'],
],
[
'name' => 'Role',
'in' => 'query',
'schema' => ['description' => '预留参数,可不传递。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'FilterDoc',
'in' => 'query',
'schema' => ['description' => '采用`db.currentOp()`命令在获取会话时进行过滤,命令详情请参考MongoDB的[db.currentOp()](https://docs.mongodb.com/manual/reference/method/db.currentOp/)命令。', 'type' => 'string', 'required' => false, 'example' => '{ "active" : true }'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '获取数据库会话数据的时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1692029584428'],
'SessionList' => [
'description' => '会话列表。',
'type' => 'array',
'items' => [
'description' => '会话。',
'type' => 'object',
'properties' => [
'OpId' => ['description' => '操作ID。', 'type' => 'string', 'example' => '14508'],
'Active' => ['description' => '是否是活跃的操作:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Command' => ['description' => '包含与此操作关联的完整命令对象的文档。', 'type' => 'string', 'example' => '"command" : {'."\n"
.' "find" : "items",'."\n"
.' "filter" : {'."\n"
.' "sku" : 1403978'."\n"
.' },'."\n"
.' ...'."\n"
.' "$db" : "test"'."\n"
.'}'],
'Op' => ['description' => '操作类型。', 'type' => 'string', 'example' => 'update'],
'SecsRunning' => ['description' => '操作持续时间,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'PlanSummary' => ['description' => '执行计划描述。', 'type' => 'string', 'example' => 'None'],
'Host' => ['description' => '主机。', 'type' => 'string', 'example' => 'a79****.cloud.et15:3328'],
'Client' => ['description' => '客户端的地址。', 'type' => 'string', 'example' => '219.143.XX.XX:52324'],
'Desc' => ['description' => '连接描述。', 'type' => 'string', 'example' => 'conn1013858'],
'Ns' => ['description' => '命名空间。', 'type' => 'string', 'example' => 'admin.cmd'],
'ConnectionId' => ['description' => '连接ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '66378736'],
'Driver' => ['description' => 'MongoDB驱动。', 'type' => 'string', 'example' => 'mongo-java-driver|legacy@3.11.2'],
'OsType' => ['description' => '系统类型。', 'type' => 'string', 'example' => 'Linux'],
'OsName' => ['description' => '系统名。', 'type' => 'string', 'example' => 'Linux'],
'OsArch' => ['description' => '系统架构。', 'type' => 'string', 'example' => 'AMD64'],
'Platform' => ['description' => '平台。', 'type' => 'string', 'example' => 'Java/Alibaba/1.8.0_152-b5'],
'KillPending' => ['description' => '该操作是否被标记为终止:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Shard' => ['description' => '分片节点ID。'."\n"
."\n"
.'> 分片集群实例时返回该参数。', 'type' => 'string', 'example' => 'd-bp1689995b78****'],
],
],
],
'SessionStat' => [
'description' => '会话统计数据。',
'type' => 'object',
'properties' => [
'ActiveCount' => ['description' => '活跃会话数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalCount' => ['description' => '会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '11'],
'LongestSecsRunning' => ['description' => '会话执行最长耗时,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ClientStats' => [
'description' => '客户端地址的统计数据。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'ActiveCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '活跃数。', 'example' => '0'],
'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '总数。', 'example' => '11'],
],
'description' => '客户端地址维度。',
],
],
'DbStats' => [
'description' => '命名空间统计数据。',
'type' => 'object',
'additionalProperties' => [
'type' => 'object',
'properties' => [
'ActiveCount' => ['type' => 'integer', 'format' => 'int64', 'description' => '活跃数。', 'example' => '0'],
'TotalCount' => ['type' => 'integer', 'format' => 'int64', 'example' => '11', 'description' => '总数。'],
],
'description' => '命名空间维度。',
],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FC6C0929-29E1-59FD-8DFE-70D9D41E****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取MongoDB实例当前会话',
'description' => '- 本接口只适用于MongoDB实例。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'responseParamsDescription' => '可参考MongoDB命令currentOp返回数据。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMongoDBCurrentOp'],
],
],
'ramActions' => [
[
'operationType' => '',
'ramAction' => [
'action' => 'hdm:GetMongoDBCurrentOp',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Timestamp\\": 1692029584428,\\n \\"SessionList\\": [\\n {\\n \\"OpId\\": \\"14508\\",\\n \\"Active\\": true,\\n \\"Command\\": \\"\\\\\\"command\\\\\\" : {\\\\n \\\\\\"find\\\\\\" : \\\\\\"items\\\\\\",\\\\n \\\\\\"filter\\\\\\" : {\\\\n \\\\\\"sku\\\\\\" : 1403978\\\\n },\\\\n ...\\\\n \\\\\\"$db\\\\\\" : \\\\\\"test\\\\\\"\\\\n}\\",\\n \\"Op\\": \\"update\\",\\n \\"SecsRunning\\": 5,\\n \\"PlanSummary\\": \\"None\\",\\n \\"Host\\": \\"a79****.cloud.et15:3328\\",\\n \\"Client\\": \\"219.143.XX.XX:52324\\",\\n \\"Desc\\": \\"conn1013858\\",\\n \\"Ns\\": \\"admin.cmd\\",\\n \\"ConnectionId\\": 66378736,\\n \\"Driver\\": \\"mongo-java-driver|legacy@3.11.2\\",\\n \\"OsType\\": \\"Linux\\",\\n \\"OsName\\": \\"Linux\\",\\n \\"OsArch\\": \\"AMD64\\",\\n \\"Platform\\": \\"Java/Alibaba/1.8.0_152-b5\\",\\n \\"KillPending\\": true,\\n \\"Shard\\": \\"d-bp1689995b78****\\"\\n }\\n ],\\n \\"SessionStat\\": {\\n \\"ActiveCount\\": 0,\\n \\"TotalCount\\": 11,\\n \\"LongestSecsRunning\\": 0,\\n \\"ClientStats\\": {\\n \\"key\\": {\\n \\"ActiveCount\\": 0,\\n \\"TotalCount\\": 11\\n }\\n },\\n \\"DbStats\\": {\\n \\"key\\": {\\n \\"ActiveCount\\": 0,\\n \\"TotalCount\\": 11\\n }\\n }\\n }\\n },\\n \\"RequestId\\": \\"FC6C0929-29E1-59FD-8DFE-70D9D41E****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetMySQLAllSessionAsync' => [
'summary' => '调用GetMySQLAllSessionAsync接口,采用异步方式获取实例当前会话数据,并按照不同维度统计会话信息。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL、PolarDB MySQL版和PolarDB-X 2.0实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'."\n"],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版实例,需要提供节点ID。不指定节点ID时,默认返回主节点的会话数据。', 'type' => 'string', 'required' => false, 'example' => 'pi-wz954ryd8f893****'],
],
[
'name' => 'ResultId',
'in' => 'query',
'schema' => ['description' => '异步请求的ID。'."\n"
.'> 异步调用方式不会立即返回完整结果,首先需要调用该接口获取**ResultId**,然后使用返回数据的**ResultId**,重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。', 'type' => 'string', 'required' => false, 'example' => 'async__507044db6c4eadfa2dab9b084e80****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'Fail' => ['description' => '请求是否失败:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'SessionData' => [
'description' => '会话数据。',
'type' => 'object',
'properties' => [
'TotalSessionCount' => ['description' => '会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '988'],
'ActiveSessionCount' => ['description' => '运行中会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'MaxActiveTime' => ['description' => '运行中会话执行的最长时间,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'SessionList' => [
'description' => '会话列表。',
'type' => 'array',
'items' => [
'description' => '会话。',
'type' => 'object',
'properties' => [
'SessionId' => ['description' => '会话ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '14521783'],
'User' => ['description' => '数据库用户名。', 'type' => 'string', 'example' => 'testUser'],
'Client' => ['description' => '客户端IP地址。', 'type' => 'string', 'example' => '47.100.XX.XX'],
'DbName' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbTest'],
'Command' => ['description' => '会话执行的命令类型。', 'type' => 'string', 'example' => 'Query'],
'Time' => ['description' => '会话执行时间,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'State' => ['description' => '会话状态。', 'type' => 'string', 'example' => 'starting'],
'SqlText' => ['description' => '会话执行的SQL语句。', 'type' => 'string', 'example' => 'INSERT INTO ...'],
'UserClientAlias' => ['description' => '客户端IP别名。', 'type' => 'string', 'example' => 'master-shanghai'],
'TrxId' => ['description' => '会话所在事务ID。', 'type' => 'string', 'example' => '754300775132'],
'TrxDuration' => ['description' => '事务持续时间,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'SqlTemplateId' => ['description' => 'SQL模板ID。'."\n"
."\n"
.'> 仅PolarDB-X 2.0实例返回该字段。', 'type' => 'string', 'example' => 'a7cac1a9'],
],
],
],
'UserStats' => [
'description' => '按数据库账号统计会话。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '数据库账号名。', 'type' => 'string', 'example' => 'testUser'],
'TotalCount' => ['description' => '该账号会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ActiveCount' => ['description' => '该账号活跃会话数。'."\n"
."\n"
.'> 活跃会话判断逻辑: 命令是Query或者Execute,以及未结束事务中的会话。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ThreadIdList' => [
'description' => '该账号对应的会话ID列表。',
'type' => 'array',
'items' => ['description' => '会话ID列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '[14525727,14526269]'],
],
'UserList' => [
'description' => '会话对应的账号列表。',
'type' => 'array',
'items' => ['description' => '数据库账号。', 'type' => 'string', 'example' => '[\'testUser\']'],
],
],
'description' => '',
],
],
'ClientStats' => [
'description' => '按客户端IP统计会话。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '客户端IP地址。', 'type' => 'string', 'example' => '47.100.XX.XX'],
'TotalCount' => ['description' => '该客户端IP地址下的会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ActiveCount' => ['description' => '该客户端IP地址下的活跃会话数。'."\n"
."\n"
.'> 活跃会话判断逻辑: 命令是Query或者Execute,以及未结束事务中的会话。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ThreadIdList' => [
'description' => '该客户端IP对应的会话ID列表。',
'type' => 'array',
'items' => ['description' => '会话ID列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '[14526018,14525956]'],
],
'UserList' => [
'description' => '会话对应的账号列表。',
'type' => 'array',
'items' => ['description' => '数据库账号。', 'type' => 'string', 'example' => '[\'testUser\']'],
],
],
'description' => '',
],
],
'DbStats' => [
'description' => '按数据库统计会话。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'dbTest'],
'TotalCount' => ['description' => '该数据库会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ActiveCount' => ['description' => '该数据库活跃会话数。'."\n"
."\n"
.'> 活跃会话判断逻辑: 命令是Query或者Execute,以及未结束事务中的会话。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ThreadIdList' => [
'description' => '该数据库名对应的会话ID列表。',
'type' => 'array',
'items' => ['description' => '会话ID列表。', 'type' => 'integer', 'format' => 'int64', 'example' => '[14525727,14526269]'],
],
'UserList' => [
'description' => '会话对应的账号列表。',
'type' => 'array',
'items' => ['description' => '数据库账号。', 'type' => 'string', 'example' => '[\'testUser\']'],
],
],
'description' => '',
],
],
'TimeStamp' => ['description' => '获取会话的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1659581514000020'],
],
],
'ResultId' => ['description' => '异步请求ID。', 'type' => 'string', 'example' => 'async__507044db6c4eadfa2dab9b084e80****'],
'IsFinish' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'State' => ['description' => '异步请求的执行状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'Complete' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1660100753556'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取实例当前会话',
'description' => '> - 异步调用方式不会立即返回完整结果,首先需要调用该接口获取ResultId,然后使用返回数据的ResultId,重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。'."\n"
.'> - 对于RDS MySQL 8.0实例,小版本小于20230610时,并发执行COM_STATISTICS、COM_CHANGE_USER等命令和SHOW PROCESSLIST语句时,可能导致死锁(表现为实例无法连接),建议[升级](~~96059~~)到最新小版本。'."\n"
."\n"
.'- 本接口只适用于RDS MySQL,PolarDB MySQL版和PolarDB-X 2.0实例。'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMySQLAllSessionAsync'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetMySQLAllSessionAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Fail\\": false,\\n \\"SessionData\\": {\\n \\"TotalSessionCount\\": 988,\\n \\"ActiveSessionCount\\": 10,\\n \\"MaxActiveTime\\": 6,\\n \\"SessionList\\": [\\n {\\n \\"SessionId\\": 14521783,\\n \\"User\\": \\"testUser\\",\\n \\"Client\\": \\"47.100.XX.XX\\",\\n \\"DbName\\": \\"dbTest\\",\\n \\"Command\\": \\"Query\\",\\n \\"Time\\": 6,\\n \\"State\\": \\"starting\\",\\n \\"SqlText\\": \\"INSERT INTO ...\\",\\n \\"UserClientAlias\\": \\"master-shanghai\\",\\n \\"TrxId\\": \\"754300775132\\",\\n \\"TrxDuration\\": 6,\\n \\"SqlTemplateId\\": \\"a7cac1a9\\"\\n }\\n ],\\n \\"UserStats\\": [\\n {\\n \\"Key\\": \\"testUser\\",\\n \\"TotalCount\\": 2,\\n \\"ActiveCount\\": 1,\\n \\"ThreadIdList\\": [\\n 0\\n ],\\n \\"UserList\\": [\\n \\"[\'testUser\']\\"\\n ]\\n }\\n ],\\n \\"ClientStats\\": [\\n {\\n \\"Key\\": \\"47.100.XX.XX\\",\\n \\"TotalCount\\": 2,\\n \\"ActiveCount\\": 1,\\n \\"ThreadIdList\\": [\\n 0\\n ],\\n \\"UserList\\": [\\n \\"[\'testUser\']\\"\\n ]\\n }\\n ],\\n \\"DbStats\\": [\\n {\\n \\"Key\\": \\"dbTest\\",\\n \\"TotalCount\\": 2,\\n \\"ActiveCount\\": 1,\\n \\"ThreadIdList\\": [\\n 0\\n ],\\n \\"UserList\\": [\\n \\"[\'testUser\']\\"\\n ]\\n }\\n ],\\n \\"TimeStamp\\": 1659581514000020\\n },\\n \\"ResultId\\": \\"async__507044db6c4eadfa2dab9b084e80****\\",\\n \\"IsFinish\\": true,\\n \\"State\\": \\"SUCCESS\\",\\n \\"Complete\\": true,\\n \\"Timestamp\\": 1660100753556\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetMySQLAllSessionAsyncResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Fail>false</Fail>\\n <SessionData>\\n <TotalSessionCount>988</TotalSessionCount>\\n <ActiveSessionCount>10</ActiveSessionCount>\\n <MaxActiveTime>6</MaxActiveTime>\\n <SessionList>\\n <SessionId>14521783</SessionId>\\n <User>testUser</User>\\n <Client>47.100.XX.XX</Client>\\n <DbName>dbTest</DbName>\\n <Command>Query</Command>\\n <Time>6</Time>\\n <State>starting</State>\\n <SqlText>INSERT INTO ...</SqlText>\\n <UserClientAlias>master-shanghai</UserClientAlias>\\n <TrxId>754300775132</TrxId>\\n <TrxDuration>6</TrxDuration>\\n </SessionList>\\n <UserStats>\\n <Key>testUser</Key>\\n <TotalCount>984</TotalCount>\\n <ActiveCount>11</ActiveCount>\\n <UserList>[\'testUser\']</UserList>\\n </UserStats>\\n <ClientStats>\\n <Key>47.100.XX.XX</Key>\\n <TotalCount>50</TotalCount>\\n <ActiveCount>3</ActiveCount>\\n <UserList>[\'testUser\']</UserList>\\n </ClientStats>\\n <DbStats>\\n <Key>dbTest</Key>\\n <TotalCount>60</TotalCount>\\n <ActiveCount>5</ActiveCount>\\n <UserList>[\'testUser\']</UserList>\\n </DbStats>\\n <TimeStamp>1659581514000020</TimeStamp>\\n </SessionData>\\n <ResultId>async__507044db6c4eadfa2dab9b084e80****</ResultId>\\n <IsFinish>true</IsFinish>\\n <State>SUCCESS</State>\\n <Complete>true</Complete>\\n <Timestamp>1660100753556</Timestamp>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetMySQLAllSessionAsyncResponse>","errorExample":""}]',
],
'GetPartitionsHeatmap' => [
'summary' => '调用GetPartitionsHeatmap接口,查看PolarDB-X 2.0分区访问热度和数据热点。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pxc-hzrciqy62c****'],
],
[
'name' => 'TimeRange',
'in' => 'query',
'schema' => ['description' => '需要查询的时间范围:'."\n"
."\n"
.'- **LAST\\_ONE\\_HOURS**:过去一小时。'."\n"
.'- **LAST\\_SIX\\_HOURS**:过去六小时。'."\n"
.'- **LAST\\_ONE\\_DAYS**:过去一天。'."\n"
.'- **LAST\\_THREE\\_DAYS**:过去三天。'."\n"
.'- **LAST\\_SEVEN\\_DAYS**:过去七天。', 'type' => 'string', 'required' => false, 'example' => 'LAST_SIX_HOURS'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '需要查询的数据类型:'."\n"
.'- **READ_ROWS**:读行数。'."\n"
.'- **WRITTEN_ROWS**:写行数。'."\n"
.'- **READ\\_WRITTEN\\_ROWS**:读写行数。'."\n"
.'- **UPDATE_ROWS**:更新行数。'."\n"
.'- **INSERTED_ROWS**:插入行数。'."\n"
.'- **DELETED_ROWS**:删除行数。'."\n"
.'- **READ\\_ROWS\\_WITH\\_DN**:以DN视角返回的读行数。'."\n"
.'- **WRITTEN\\_ROWS\\_WITH\\_DN**:以DN视角返回的写行数。'."\n"
.'- **READ\\_WRITTEN\\_ROWS\\_WITH\\_DN**:以DN视角返回的读写行数。', 'type' => 'string', 'required' => false, 'example' => 'WRITTEN_ROWS_WITH_DN'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '分布式数据库的数据热点数据。返回JSON格式的文本。', 'type' => 'string', 'example' => '{'."\n"
.' "boundAxis": ['."\n"
.' {'."\n"
.' "bound": "A,B,C,D",'."\n"
.' "labels": ['."\n"
.' "L1",'."\n"
.' "L2",'."\n"
.' "L3",'."\n"
.' "L4"'."\n"
.' ],'."\n"
.' "rows": 3171'."\n"
.' },'."\n"
.' {'."\n"
.' "bound": "A,B,C,D",'."\n"
.' "labels": ['."\n"
.' "L1",'."\n"
.' "L2",'."\n"
.' "L3",'."\n"
.' "L4"'."\n"
.' ],'."\n"
.' "rows": 277128'."\n"
.' }'."\n"
.' ],'."\n"
.' "dataMap": {'."\n"
.' "READ_WRITTEN_ROWS": ['."\n"
.' ['."\n"
.' 0,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ],'."\n"
.' ['."\n"
.' 0,'."\n"
.' 0,'."\n"
.' 0'."\n"
.' ]'."\n"
.' ]'."\n"
.' },'."\n"
.' "timeAxis": ['."\n"
.' 1671701056070,'."\n"
.' 1671701116551,'."\n"
.' 1671701177020'."\n"
.' ]'."\n"
.'}'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D00DB161-FEF6-5428-B37A-8D29A4C2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"{\\\\n \\\\\\"boundAxis\\\\\\": [\\\\n {\\\\n \\\\\\"bound\\\\\\": \\\\\\"A,B,C,D\\\\\\",\\\\n \\\\\\"labels\\\\\\": [\\\\n \\\\\\"L1\\\\\\",\\\\n \\\\\\"L2\\\\\\",\\\\n \\\\\\"L3\\\\\\",\\\\n \\\\\\"L4\\\\\\"\\\\n ],\\\\n \\\\\\"rows\\\\\\": 3171\\\\n },\\\\n {\\\\n \\\\\\"bound\\\\\\": \\\\\\"A,B,C,D\\\\\\",\\\\n \\\\\\"labels\\\\\\": [\\\\n \\\\\\"L1\\\\\\",\\\\n \\\\\\"L2\\\\\\",\\\\n \\\\\\"L3\\\\\\",\\\\n \\\\\\"L4\\\\\\"\\\\n ],\\\\n \\\\\\"rows\\\\\\": 277128\\\\n }\\\\n ],\\\\n \\\\\\"dataMap\\\\\\": {\\\\n \\\\\\"READ_WRITTEN_ROWS\\\\\\": [\\\\n [\\\\n 0,\\\\n 0,\\\\n 0\\\\n ],\\\\n [\\\\n 0,\\\\n 0,\\\\n 0\\\\n ]\\\\n ]\\\\n },\\\\n \\\\\\"timeAxis\\\\\\": [\\\\n 1671701056070,\\\\n 1671701116551,\\\\n 1671701177020\\\\n ]\\\\n}\\",\\n \\"RequestId\\": \\"D00DB161-FEF6-5428-B37A-8D29A4C2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPartitionsHeatmapResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>{\\n \\"boundAxis\\": [\\n {\\n \\"bound\\": \\"A,B,C,D\\",\\n \\"labels\\": [\\n \\"L1\\",\\n \\"L2\\",\\n \\"L3\\",\\n \\"L4\\"\\n ],\\n \\"rows\\": 3171\\n },\\n {\\n \\"bound\\": \\"A,B,C,D\\",\\n \\"labels\\": [\\n \\"L1\\",\\n \\"L2\\",\\n \\"L3\\",\\n \\"L4\\"\\n ],\\n \\"rows\\": 277128\\n }\\n ],\\n \\"dataMap\\": {\\n \\"READ_WRITTEN_ROWS\\": [\\n [\\n 0,\\n 0,\\n 0\\n ],\\n [\\n 0,\\n 0,\\n 0\\n ]\\n ]\\n },\\n \\"timeAxis\\": [\\n 1671701056070,\\n 1671701116551,\\n 1671701177020\\n ]\\n}</Data>\\n <RequestId>D00DB161-FEF6-5428-B37A-8D29A4C2****</RequestId>\\n <Success>true</Success>\\n</GetPartitionsHeatmapResponse>","errorExample":""}]',
'title' => '获取分区热度信息',
'description' => '该接口不建议用户自行调用,因为返回的数据格式比较特殊,自行解析会非常复杂,建议使用阿里云DAS的[分区热力图](~~470302~~)功能查看该数据。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPartitionsHeatmap',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetPfsMetricTrends' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmF0MV2I'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-m5ea73876ukci****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于RDS MySQL集群系列或PolarDB MySQL版数据库实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
[
'name' => 'Metric',
'in' => 'formData',
'schema' => ['description' => '需要查询趋势的指标:'."\n"
."\n"
.'- **count**:执行次数。'."\n"
.'- **avgRt**:平均执行时间。'."\n"
.'- **rtRate**:耗时比例。'."\n"
.'- **rowsExamined**:总扫描行数。', 'type' => 'string', 'required' => false, 'example' => 'Count'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1677461663092'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> 查询结束时间需晚于查询开始时间,最多可查看最近一个月内任意七天的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1678432430967'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'additionalProperties' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Timestamp' => ['type' => 'string', 'example' => '1681975870000', 'description' => '时间戳,格式为unix时间戳,单位为毫秒。'],
'Value' => ['type' => 'any', 'description' => '指标值。', 'example' => '478.28'],
],
'description' => '返回指标趋势结果。',
],
'description' => '返回数据列表。',
],
],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F4C27966-284E-51C4-9407-DB50CAB8****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '查询指定指标趋势',
'summary' => '调用GetPfsMetricTrends接口,查询数据库实例性能洞察(新版)指定指标的趋势。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 目标数据库实例为RDS MySQL或PolarDB MySQL版。'."\n"
.'- 目标数据库实例已开启性能洞察(新版),详情请参见[性能洞察(新版)](~~469117~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPfsMetricTrends'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPfsMetricTrends',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"key\\": [\\n {\\n \\"Timestamp\\": \\"1681975870000\\",\\n \\"Value\\": \\"478.28\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"F4C27966-284E-51C4-9407-DB50CAB8****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetPfsMetricTrendsResponse>\\n <Message>Successful</Message>\\n <RequestId>F4C27966-284E-51C4-9407-DB50CAB8****</RequestId>\\n <Data>\\n <Timestamp>1681975870000</Timestamp>\\n <Value>478.28</Value>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetPfsMetricTrendsResponse>","errorExample":""}]',
],
'GetPfsSqlSample' => [
'summary' => '调用GetPfsSqlSample接口,获取性能洞察(新版)功能的SQL样本数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '152860',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL和PolarDB MySQL版数据库实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于RDS MySQL集群系列或PolarDB MySQL版数据库实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'r-x****-db-0'],
],
[
'name' => 'SqlId',
'in' => 'formData',
'schema' => ['description' => 'SQL ID。', 'type' => 'string', 'required' => false, 'example' => '651b56fe9418d48edb8fdf0980ec****'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1676511134614'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,最多可查看最近一个月内任意七天的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1678074351197'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9CB97BC4-6479-55D0-B9D0-EA925AFE****'],
'Code' => ['description' => '返回状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '返回的SQL样本数据。',
'type' => 'array',
'items' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '196278346919****'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
'NodeId' => ['description' => '节点ID。'."\n"
."\n"
.'> RDS MySQL集群系列或PolarDB MySQL版数据库实例才会返回该数据。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'LogicId' => ['description' => '逻辑库ID。', 'type' => 'string', 'example' => 'xxxxx'],
'Timestamp' => ['description' => '执行SQL的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1660100753556'],
'SqlId' => ['description' => 'SQL ID。', 'type' => 'string', 'example' => '651b56fe9418d48edb8fdf0980ec****'],
'Sql' => ['description' => 'SQL样本。', 'type' => 'string', 'example' => 'select * from xxxx where ****'],
'ThreadId' => ['description' => '线程ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '81751940'],
'EventId' => ['description' => '事件ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '63735293'],
'EndEventId' => ['description' => '该参数在事件开始时默认为NULL,在事件结束时更新为线程当前事件编号。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'EventName' => ['description' => '事件名称。', 'type' => 'string', 'example' => 'statement/sql/select'],
'Latency' => ['description' => '执行耗时,单位为毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.199'],
'LockLatency' => ['description' => '锁等待时间,单位为毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.09'],
'Errors' => ['description' => 'SQL语句错误数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Warnings' => ['description' => 'SQL语句警告数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RowsAffected' => ['description' => '影响行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RowsSent' => ['description' => '返回的SQL语句的当前行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RowsExamined' => ['description' => '扫描行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '2048576'],
'CreateTmpDiskTables' => ['description' => '执行语句时创建的磁盘上内部临时表的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'CreateTmpTables' => ['description' => '执行语句时创建的内部临时表的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SelectFullJoin' => ['description' => '不使用索引而执行表扫描的连接数。'."\n"
.'><notice>该参数是用来统计联合查询过程中没有利用索引的情况,如果该参数值不为0,请仔细检查表的索引。'."\n"
.'></notice>', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SelectFullRangeJoin' => ['description' => '在引用表上使用范围搜索的连接数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SelectRange' => ['description' => '在第一个表中使用范围的连接数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SelectRangeCheck' => ['description' => '在每一行数据后对键值进行检查,统计不带键值的连接的数量。'."\n"
.'><notice>该参数是用来统计联合查询过程中没有利用索引的情况,如果该参数值不为0,请仔细检查表的索引。'."\n"
.'></notice>', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SelectScan' => ['description' => '扫描数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SortMergePasses' => ['description' => '排序算法必须执行的合并次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SortRange' => ['description' => '使用范围进行排序的次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SortRows' => ['description' => '排序行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'SortScan' => ['description' => '扫描排序次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'NoIndexUsed' => ['description' => '语句在不使用索引的情况下是否执行了表扫描:'."\n"
."\n"
.'- **1**:是。'."\n"
.'- **0**:否。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'NoGoodIndexUsed' => ['description' => '服务器是否查找不到可用于该语句的索引:'."\n"
."\n"
.'- **1**:是。'."\n"
.'- **0**:否。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Db' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testDB'],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取SQL样本数据',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 目标数据库实例为RDS MySQL或PolarDB MySQL版。'."\n"
.'- 目标数据库实例已开启性能洞察(新版),详情请参见[性能洞察(新版)](~~469117~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPfsSqlSample'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPfsSqlSample',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"9CB97BC4-6479-55D0-B9D0-EA925AFE****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"UserId\\": \\"196278346919****\\",\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\",\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"LogicId\\": \\"xxxxx\\",\\n \\"Timestamp\\": 1660100753556,\\n \\"SqlId\\": \\"651b56fe9418d48edb8fdf0980ec****\\",\\n \\"Sql\\": \\"select * from xxxx where ****\\",\\n \\"ThreadId\\": 81751940,\\n \\"EventId\\": 63735293,\\n \\"EndEventId\\": 0,\\n \\"EventName\\": \\"statement/sql/select\\",\\n \\"Latency\\": 0.199,\\n \\"LockLatency\\": 0.09,\\n \\"Errors\\": 0,\\n \\"Warnings\\": 0,\\n \\"RowsAffected\\": 0,\\n \\"RowsSent\\": 0,\\n \\"RowsExamined\\": 2048576,\\n \\"CreateTmpDiskTables\\": 0,\\n \\"CreateTmpTables\\": 0,\\n \\"SelectFullJoin\\": 0,\\n \\"SelectFullRangeJoin\\": 0,\\n \\"SelectRange\\": 0,\\n \\"SelectRangeCheck\\": 0,\\n \\"SelectScan\\": 0,\\n \\"SortMergePasses\\": 0,\\n \\"SortRange\\": 0,\\n \\"SortRows\\": 0,\\n \\"SortScan\\": 1,\\n \\"NoIndexUsed\\": 1,\\n \\"NoGoodIndexUsed\\": 1,\\n \\"Db\\": \\"testDB\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetPfsSqlSampleResponse>\\n <Message>Successful</Message>\\n <RequestId>9CB97BC4-6479-55D0-B9D0-EA925AFE****</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <UserId>196278346919****</UserId>\\n <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>\\n <NodeId>r-x****-db-0</NodeId>\\n <LogicId>xxxxx</LogicId>\\n <Timestamp>1660100753556</Timestamp>\\n <SqlId>651b56fe9418d48edb8fdf0980ec****</SqlId>\\n <Sql>select * from xxxx where ****</Sql>\\n <ThreadId>81751940</ThreadId>\\n <EventId>63735293</EventId>\\n <EndEventId>0</EndEventId>\\n <EventName>statement/sql/select</EventName>\\n <Latency>0.199</Latency>\\n <LockLatency>0.09</LockLatency>\\n <Errors>0</Errors>\\n <Warnings>0</Warnings>\\n <RowsAffected>0</RowsAffected>\\n <RowsSent>0</RowsSent>\\n <RowsExamined>2048576</RowsExamined>\\n <CreateTmpDiskTables>0</CreateTmpDiskTables>\\n <CreateTmpTables>0</CreateTmpTables>\\n <SelectFullJoin>0</SelectFullJoin>\\n <SelectFullRangeJoin>0</SelectFullRangeJoin>\\n <SelectRange>0</SelectRange>\\n <SelectRangeCheck>0</SelectRangeCheck>\\n <SelectScan>0</SelectScan>\\n <SortMergePasses>0</SortMergePasses>\\n <SortRange>0</SortRange>\\n <SortRows>0</SortRows>\\n <SortScan>1</SortScan>\\n <NoIndexUsed>1</NoIndexUsed>\\n <NoGoodIndexUsed>1</NoGoodIndexUsed>\\n <Db>testDB</Db>\\n </Data>\\n</GetPfsSqlSampleResponse>","errorExample":""}]',
],
'GetPfsSqlSummaries' => [
'summary' => '调用GetPfsSqlSummaries接口,查询数据库实例性能洞察(新版)中按照SQL ID维度的全量请求数据。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-uf61swc4cru0b****'],
],
[
'name' => 'NodeId',
'in' => 'formData',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于RDS MySQL集群系列或PolarDB MySQL版数据库实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => 'r-****-db-0'],
],
[
'name' => 'SqlId',
'in' => 'formData',
'schema' => ['description' => 'SQL ID。'."\n"
."\n"
.'> 传入SQL ID时,统计目标SQL ID的全量请求数据;为空时,统计整个数据库实例的全量请求数据。', 'type' => 'string', 'required' => false, 'example' => '651b56fe9418d48edb8fdf0980ec****'],
],
[
'name' => 'Keywords',
'in' => 'formData',
'schema' => ['description' => 'SQL文本关键词,多个关键词以空格分隔。', 'type' => 'string', 'required' => false, 'example' => 'select update'],
],
[
'name' => 'StartTime',
'in' => 'formData',
'schema' => ['description' => '查询开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1675833788056'],
],
[
'name' => 'EndTime',
'in' => 'formData',
'schema' => ['description' => '查询结束时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'> 查询结束时间需晚于查询开始时间,最多可查看最近一个月内任意七天的数据。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1679297005999'],
],
[
'name' => 'OrderBy',
'in' => 'formData',
'schema' => ['description' => '排序字段,默认为**count**。'."\n"
."\n"
.'- **count**:执行次数。'."\n"
."\n"
.'- **avgLatency**:平均执行时间。'."\n"
."\n"
.'- **rowsExamined**:总扫描行数。'."\n"
."\n"
.'- **rowsExaminedAvg**:平均扫描行数。'."\n"
."\n"
.'- **rowsSentAvg**:平均返回行数。', 'type' => 'string', 'required' => false, 'example' => 'count'],
],
[
'name' => 'Asc',
'in' => 'formData',
'schema' => ['description' => '是否升序排序,默认为**false**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'PageNo',
'in' => 'formData',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'formData',
'schema' => ['description' => '分页查询每页最大记录数,默认为10,最大为100。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListResult<PfsSqlSummary>',
'description' => 'ListResult<PfsSqlSummary>',
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54F3DBAE-9420-511A-9C29-265E8C04****'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '264'],
'List' => [
'description' => '详细信息列表。',
'type' => 'array',
'items' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '196278346919****'],
'Psql' => ['description' => 'SQL模板。', 'type' => 'string', 'example' => 'select ?'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'NodeId' => ['description' => '节点ID。'."\n"
.'> 对于RDS MySQL集群系列或PolarDB MySQL版数据库实例,返回此参数。', 'type' => 'string', 'example' => 'r-x****-db-0'],
'SqlType' => ['description' => 'SQL的类型。取值:'."\n"
.'- **SELECT**'."\n"
.'- **UPDATE**'."\n"
.'- **DELETE**', 'type' => 'string', 'example' => 'SELECT'],
'LogicId' => ['description' => '逻辑库ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '58275984'],
'SqlId' => ['description' => 'SQL模板ID。', 'type' => 'string', 'example' => '2e8147b5ca2dfc640dfd5e43d96a****'],
'Timestamp' => ['description' => '数据日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1643040000000'],
'RtRate' => ['title' => '耗时占比', 'description' => '耗时占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.1384'],
'CountRate' => ['title' => '执行次数占比', 'description' => '执行次数占比。', 'type' => 'number', 'format' => 'double', 'example' => '0.0586'],
'FullScan' => ['description' => '是否全表扫描。取值:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Count' => ['description' => '总执行次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
'ErrCount' => ['description' => '错误次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'WarnCount' => ['description' => '警告次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TotalLatency' => ['description' => '总执行耗时,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '60913.256'],
'MaxLatency' => ['description' => '最大执行耗时,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '36.233'],
'AvgLatency' => ['description' => 'SQL平均执行耗时,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.1717'],
'RowsSent' => ['description' => '返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'RowsSendAvg' => ['description' => '平均发送行数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'RowsExamined' => ['description' => '总扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'RowsExaminedAvg' => ['description' => '平均扫描行数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'RowsAffected' => ['description' => '影响行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'RowsAffectedAvg' => ['description' => '平均影响行数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'TmpTables' => ['description' => '临时表数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'TmpDiskTables' => ['description' => '临时磁盘表数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'RowsSorted' => ['description' => '排序行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SortMergePasses' => ['description' => '排序算法必须执行的合并次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicalReads' => ['description' => '物理节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'PhysicalAsyncReads' => ['description' => '物理异步节点数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'SemisyncDelayTime' => ['description' => '半同步延迟时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.12'],
'RowsSentAvg' => ['description' => '返回SQL句的平均行数。', 'type' => 'number', 'format' => 'double', 'example' => '0.52'],
'LogicReads' => ['description' => '逻辑节点数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'RedoWrites' => ['description' => '重做节点数。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'DataWriteTime' => ['description' => '数据写入时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'DataWrites' => ['description' => '可写数据节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'DataReadTime' => ['description' => '可读数据时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'DataReads' => ['description' => '可读数据节点数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RwlockOsWaits' => ['description' => '是否开启了读写分离。取值:'."\n"
."\n"
.'- **0**:未开启。'."\n"
.'- **1**:开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RwlockSpinRounds' => ['description' => '读写分离参数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'RwlockSpinWaits' => ['description' => '是否开启多重索引扫描。取值:'."\n"
."\n"
.'- **0**:未开启。'."\n"
.'- **1**:开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'MutexWaits' => ['description' => '互斥等待次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MutexSpins' => ['description' => '互斥旋转次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'TransactionLockTime' => ['description' => '存储事务锁定时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'ServerLockTime' => ['description' => '服务器锁定时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'CpuTime' => ['description' => 'CPU运行时间,单位为毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'ElapsedTime' => ['description' => '实际运行时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'Id' => ['title' => '主键', 'description' => '主键ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '26186357'],
'SelectScanAvg' => ['description' => '平均扫描数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'SelectRangeAvg' => ['description' => '平均选取范围。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'SelectFullJoinAvg' => ['description' => '不使用索引而执行表扫描的平均连接数。'."\n"
.'><notice>如果该参数值不为0,则应仔细检查表的索引。'."\n"
.'></notice>', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'SelectFullRangeJoinAvg' => ['description' => '平均范围连接数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'SortScanAvg' => ['description' => '平均扫描排序数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'SortRowsAvg' => ['description' => '平均排序行数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'TmpTablesAvg' => ['description' => '临时表平均数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'TmpDiskTablesAvg' => ['description' => '临时磁盘表平均数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'FirstTime' => ['description' => '首次执行时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1659308149000'],
'LastTime' => ['description' => '最后变更时间,格式为unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1661306520000'],
'LockLatencyAvg' => ['description' => '平均锁等待时间,单位毫秒。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'TimerWaitAvg' => ['description' => '备用参数。', 'type' => 'number', 'format' => 'double', 'example' => 'None'],
'SortRangeAvg' => ['description' => '使用范围排序平均次数。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'CpuRate' => ['description' => 'CPU执行时间与SQL总执行时间的比值。', 'type' => 'number', 'format' => 'double', 'example' => '0'],
'Db' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testDB'],
'Tables' => [
'description' => '数据库表名。'."\n",
'type' => 'array',
'items' => ['description' => '数据库表名。'."\n", 'type' => 'string', 'example' => 'test_table'],
],
],
],
],
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页最大记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Extra' => ['description' => '备用参数。', 'type' => 'any', 'example' => 'None'],
],
],
'Code' => ['description' => '返回状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"54F3DBAE-9420-511A-9C29-265E8C04****\\",\\n \\"Data\\": {\\n \\"Total\\": 264,\\n \\"List\\": [\\n {\\n \\"UserId\\": \\"196278346919****\\",\\n \\"Psql\\": \\"select ?\\",\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"NodeId\\": \\"r-x****-db-0\\",\\n \\"SqlType\\": \\"SELECT\\",\\n \\"LogicId\\": 58275984,\\n \\"SqlId\\": \\"2e8147b5ca2dfc640dfd5e43d96a****\\",\\n \\"Timestamp\\": 1643040000000,\\n \\"RtRate\\": 0.1384,\\n \\"CountRate\\": 0.0586,\\n \\"FullScan\\": true,\\n \\"Count\\": 100000,\\n \\"ErrCount\\": 0,\\n \\"WarnCount\\": 0,\\n \\"TotalLatency\\": 60913.256,\\n \\"MaxLatency\\": 36.233,\\n \\"AvgLatency\\": 0.1717,\\n \\"RowsSent\\": 0,\\n \\"RowsSendAvg\\": 0,\\n \\"RowsExamined\\": 100,\\n \\"RowsExaminedAvg\\": 0,\\n \\"RowsAffected\\": 0,\\n \\"RowsAffectedAvg\\": 0,\\n \\"TmpTables\\": 0,\\n \\"TmpDiskTables\\": 0,\\n \\"RowsSorted\\": 0,\\n \\"SortMergePasses\\": 0,\\n \\"PhysicalReads\\": 0,\\n \\"PhysicalAsyncReads\\": 0,\\n \\"SemisyncDelayTime\\": 0.12,\\n \\"RowsSentAvg\\": 0.52,\\n \\"LogicReads\\": 0,\\n \\"RedoWrites\\": 0,\\n \\"DataWriteTime\\": 0,\\n \\"DataWrites\\": 0,\\n \\"DataReadTime\\": 0,\\n \\"DataReads\\": 0,\\n \\"RwlockOsWaits\\": 0,\\n \\"RwlockSpinRounds\\": 0,\\n \\"RwlockSpinWaits\\": 0,\\n \\"MutexWaits\\": 1,\\n \\"MutexSpins\\": 1,\\n \\"TransactionLockTime\\": 0,\\n \\"ServerLockTime\\": 0,\\n \\"CpuTime\\": 0,\\n \\"ElapsedTime\\": 0,\\n \\"Id\\": 26186357,\\n \\"SelectScanAvg\\": 0,\\n \\"SelectRangeAvg\\": 0,\\n \\"SelectFullJoinAvg\\": 0,\\n \\"SelectFullRangeJoinAvg\\": 0,\\n \\"SortScanAvg\\": 0,\\n \\"SortRowsAvg\\": 0,\\n \\"TmpTablesAvg\\": 0,\\n \\"TmpDiskTablesAvg\\": 0,\\n \\"FirstTime\\": 1659308149000,\\n \\"LastTime\\": 1661306520000,\\n \\"LockLatencyAvg\\": 0,\\n \\"TimerWaitAvg\\": 0,\\n \\"SortRangeAvg\\": 0,\\n \\"CpuRate\\": 0,\\n \\"Db\\": \\"testDB\\",\\n \\"Tables\\": [\\n \\"test_table\\"\\n ]\\n }\\n ],\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Extra\\": \\"None\\"\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetPfsSqlSummariesResponse>\\n <Message>Successful</Message>\\n <RequestId>54F3DBAE-9420-511A-9C29-265E8C04****</RequestId>\\n <Data>\\n <Total>264</Total>\\n <List>\\n <UserId>196278346919****</UserId>\\n <Psql>select ?</Psql>\\n <SqlFeature>None</SqlFeature>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n <NodeId>r-x****-db-0</NodeId>\\n <SqlType>SELECT</SqlType>\\n <LogicId>58275984</LogicId>\\n <SqlId>2e8147b5ca2dfc640dfd5e43d96a****</SqlId>\\n <Timestamp>1643040000000</Timestamp>\\n <RtRate>0.1384</RtRate>\\n <CountRate>0.0586</CountRate>\\n <FullScan>true</FullScan>\\n <Count>100000</Count>\\n <ErrCount>0</ErrCount>\\n <WarnCount>0</WarnCount>\\n <TotalLatency>60913.256</TotalLatency>\\n <MaxLatency>36.233</MaxLatency>\\n <AvgLatency>0.1717</AvgLatency>\\n <RowsSent>0</RowsSent>\\n <RowsSendAvg>0</RowsSendAvg>\\n <RowsExamined>100</RowsExamined>\\n <RowsExaminedAvg>0</RowsExaminedAvg>\\n <RowsAffected>0</RowsAffected>\\n <RowsAffectedAvg>0</RowsAffectedAvg>\\n <TmpTables>0</TmpTables>\\n <TmpDiskTables>0</TmpDiskTables>\\n <RowsSorted>0</RowsSorted>\\n <SortMergePasses>0</SortMergePasses>\\n <PhysicalReads>0</PhysicalReads>\\n <PhysicalAsyncReads>0</PhysicalAsyncReads>\\n <SemisyncDelayTime>0.12</SemisyncDelayTime>\\n <RowsSentAvg>0.52</RowsSentAvg>\\n <LogicReads>0</LogicReads>\\n <RedoWrites>0</RedoWrites>\\n <DataWriteTime>0</DataWriteTime>\\n <DataWrites>0</DataWrites>\\n <DataReadTime>0</DataReadTime>\\n <DataReads>0</DataReads>\\n <RwlockOsWaits>0</RwlockOsWaits>\\n <RwlockSpinRounds>0</RwlockSpinRounds>\\n <RwlockSpinWaits>0</RwlockSpinWaits>\\n <MutexWaits>1</MutexWaits>\\n <MutexSpins>1</MutexSpins>\\n <TransactionLockTime>0</TransactionLockTime>\\n <ServerLockTime>0</ServerLockTime>\\n <CpuTime>0</CpuTime>\\n <ElapsedTime>0</ElapsedTime>\\n <Id>26186357</Id>\\n <SelectScanAvg>0</SelectScanAvg>\\n <SelectRangeAvg>0</SelectRangeAvg>\\n <SelectFullJoinAvg>0</SelectFullJoinAvg>\\n <SelectFullRangeJoinAvg>0</SelectFullRangeJoinAvg>\\n <SortScanAvg>0</SortScanAvg>\\n <SortRowsAvg>0</SortRowsAvg>\\n <TmpTablesAvg>0</TmpTablesAvg>\\n <TmpDiskTablesAvg>0</TmpDiskTablesAvg>\\n <FirstTime>1659308149000</FirstTime>\\n <LastTime>1661306520000</LastTime>\\n <LockLatencyAvg>0</LockLatencyAvg>\\n <SortRangeAvg>0</SortRangeAvg>\\n <CpuRate>0</CpuRate>\\n <Db>testDB</Db>\\n <Tables>test_table</Tables>\\n </List>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Extra>None</Extra>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetPfsSqlSummariesResponse>","errorExample":""}]',
'title' => '查询按照SQL ID维度统计的全量请求数据',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 目标数据库实例为RDS MySQL或PolarDB MySQL版。'."\n"
.'- 目标数据库实例已开启性能洞察(新版),详情请参见[性能洞察(新版)](~~469117~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPfsSqlSummaries'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPfsSqlSummaries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetQueryOptimizeDataStats' => [
'summary' => '调用GetQueryOptimizeDataStats接口,获取查询治理模板数据。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'TagNames',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => ['description' => 'SQL文本关键词,多个关键词以空格分隔。', 'type' => 'string', 'required' => false, 'example' => 'select update'],
],
[
'name' => 'LogicalOperator',
'in' => 'query',
'schema' => ['description' => '多个SQL文本关键词的逻辑关系。'."\n"
."\n"
.'- **or**:或。'."\n"
.'- **and**:与。', 'type' => 'string', 'required' => false, 'example' => 'or'],
],
[
'name' => 'Rules',
'in' => 'query',
'schema' => ['description' => '需要过滤的规则,多个规则以逗号分隔。具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'required' => false, 'example' => 'DAS_NOT_IMPORTANT'],
],
[
'name' => 'DbNames',
'in' => 'query',
'schema' => ['description' => '需要查询的数据库名。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
[
'name' => 'Time',
'in' => 'query',
'schema' => ['description' => '查询数据的日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1642953600000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询每页最大记录数,默认为10。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,默认为**count**。'."\n"
."\n"
.'- **count**:执行次数。'."\n"
.'- **maxQueryTime**:最大执行时间。'."\n"
.'- **avgQueryTime**:平均执行时间。'."\n"
.'- **maxLockTime**:最大锁等待时间。'."\n"
.'- **avgLockTime**:平均锁等待时间。'."\n"
.'- **maxRowsExamined**:最大扫描行数。'."\n"
.'- **avgRowsExamined**:平均扫描行数。'."\n"
.'- **maxRowsSent**:最大返回行数。'."\n"
.'- **avgRowsSent**:平均返回行数。', 'type' => 'string', 'required' => false, 'example' => 'count'],
],
[
'name' => 'Asc',
'in' => 'query',
'schema' => ['description' => '是否升序排序,默认为**true**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'OnlyOptimizedSql',
'in' => 'query',
'schema' => ['description' => '是否只查询待优化的SQL,默认为**false**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
[
'name' => 'SqlIds',
'in' => 'query',
'schema' => ['description' => 'SQL模板ID,您可调用[GetQueryOptimizeExecErrorStats](~~405235~~)接口查询SQL模板ID。', 'type' => 'string', 'required' => false, 'example' => '2e8147b5ca2dfc640dfd5e43d96a****'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
[
'name' => 'User',
'in' => 'query',
'schema' => ['description' => '需要查询的数据库账号。', 'type' => 'string', 'required' => false, 'example' => 'testUser'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNo' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageSize' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '模板数据列表。',
'type' => 'array',
'items' => [
'description' => '模板数据列表。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'Dbname' => ['description' => 'SQL所属数据库名。', 'type' => 'string', 'example' => 'testdb01'],
'SqlId' => ['description' => 'SQL模板ID。', 'type' => 'string', 'example' => '2e8147b5ca2dfc640dfd5e43d96a****'],
'SqlType' => ['description' => 'SQL类别。', 'type' => 'string', 'example' => 'INSERT'],
'Psql' => ['description' => 'SQL模板。', 'type' => 'string', 'example' => 'select 1'],
'SqlSample' => ['description' => 'SQL模板下执行最慢的SQL样本。', 'type' => 'string', 'example' => 'select 2'],
'Count' => ['description' => 'SQL执行次数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'MaxQueryTime' => ['description' => '最大查询时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '1.1'],
'AvgQueryTime' => ['description' => '平均查询时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '1.1'],
'MaxLockTime' => ['description' => '最大锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.1'],
'AvgLockTime' => ['description' => '平均锁等待时间,单位为秒。', 'type' => 'number', 'format' => 'double', 'example' => '0.1'],
'MaxRowsExamined' => ['description' => '最大扫描行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000'],
'AvgRowsExamined' => ['description' => '平均扫描行数。', 'type' => 'number', 'format' => 'double', 'example' => '100.1'],
'MaxRowsSent' => ['description' => '最大返回行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'AvgRowsSent' => ['description' => '平均返回行数。', 'type' => 'number', 'format' => 'double', 'example' => '100.1'],
'MaxRowsAffected' => ['description' => '最大影响行数。'."\n"
."\n"
.'> 取值为-1说明暂未采集到该字段。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'AvgRowsAffected' => ['description' => '平均影响行数。'."\n"
."\n"
.'> 取值为-1说明暂未采集到该字段。', 'type' => 'number', 'format' => 'double', 'example' => '100.1'],
'RuleList' => [
'description' => '规则列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Name' => ['description' => '规则名,具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'example' => 'DAS_NOT_IMPORTANT'],
'Type' => ['description' => '规则类别:'."\n"
."\n"
.'- **Predefined**:系统预定义。'."\n"
.'- **UserDefined**:用户自定义。', 'type' => 'string', 'example' => 'Predefined'],
],
'description' => '',
],
],
'User' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'testUser'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取查询治理模板数据',
'description' => '- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于2.1.8,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为2.1.8或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeDataStats'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeDataStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"Dbname\\": \\"testdb01\\",\\n \\"SqlId\\": \\"2e8147b5ca2dfc640dfd5e43d96a****\\",\\n \\"SqlType\\": \\"INSERT\\",\\n \\"Psql\\": \\"select 1\\",\\n \\"SqlSample\\": \\"select 2\\",\\n \\"Count\\": 100,\\n \\"MaxQueryTime\\": 1.1,\\n \\"AvgQueryTime\\": 1.1,\\n \\"MaxLockTime\\": 0.1,\\n \\"AvgLockTime\\": 0.1,\\n \\"MaxRowsExamined\\": 100000,\\n \\"AvgRowsExamined\\": 100.1,\\n \\"MaxRowsSent\\": 10000,\\n \\"AvgRowsSent\\": 100.1,\\n \\"MaxRowsAffected\\": 10000,\\n \\"AvgRowsAffected\\": 100.1,\\n \\"RuleList\\": [\\n {\\n \\"Name\\": \\"DAS_NOT_IMPORTANT\\",\\n \\"Type\\": \\"Predefined\\"\\n }\\n ],\\n \\"User\\": \\"testUser\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeDataStatsResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>10</Total>\\n <Extra>None</Extra>\\n <List>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n <Dbname>testdb01</Dbname>\\n <SqlId>2e8147b5ca2dfc640dfd5e43d96a****</SqlId>\\n <SqlType>INSERT</SqlType>\\n <Psql>select 1</Psql>\\n <SqlSample>select 2</SqlSample>\\n <Count>100</Count>\\n <MaxQueryTime>1.1</MaxQueryTime>\\n <AvgQueryTime>1.1</AvgQueryTime>\\n <MaxLockTime>0.1</MaxLockTime>\\n <AvgLockTime>0.1</AvgLockTime>\\n <MaxRowsExamined>100000</MaxRowsExamined>\\n <AvgRowsExamined>100.1</AvgRowsExamined>\\n <MaxRowsSent>10000</MaxRowsSent>\\n <AvgRowsSent>100.1</AvgRowsSent>\\n <MaxRowsAffected>10000</MaxRowsAffected>\\n <AvgRowsAffected>100.1</AvgRowsAffected>\\n <RuleList>\\n <Name>DAS_NOT_IMPORTANT</Name>\\n <Type>Predefined</Type>\\n </RuleList>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeDataStatsResponse>","errorExample":""}]',
],
'GetQueryOptimizeDataTop' => [
'summary' => '调用GetQueryOptimizeDataTop接口,获取查询治理实例红榜和实例黑榜的数据。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'TagNames',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Time',
'in' => 'query',
'schema' => ['description' => '查询数据的日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1642953600000'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => '需要查询的榜单类型:'."\n"
."\n"
.'- **RED**:实例红榜。'."\n"
.'- **BLACK**:实例黑榜。', 'type' => 'string', 'required' => true, 'example' => 'RED'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNo' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageSize' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '榜单信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'Type' => ['description' => '指标名:'."\n"
."\n"
.'- **sqlExecuteCount**:慢SQL执行次数。'."\n"
.'- **optimizedSqlExecuteCount**:推荐优化的慢SQL执行次数。', 'type' => 'string', 'example' => 'sqlExecuteCount'],
'Value' => ['description' => '指标的数值。', 'type' => 'number', 'format' => 'double', 'example' => '100'],
],
'description' => '',
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取查询治理实例红榜和实例黑榜的数据',
'description' => '- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于2.1.8,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为2.1.8或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeDataTop'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeDataTop',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"Type\\": \\"sqlExecuteCount\\",\\n \\"Value\\": 100\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeDataTopResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>10</Total>\\n <Extra>None</Extra>\\n <List>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n <Type>sqlExecuteCount</Type>\\n <Value>100</Value>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeDataTopResponse>","errorExample":""}]',
],
'GetQueryOptimizeDataTrend' => [
'summary' => '调用GetQueryOptimizeDataTrend接口,获取查询治理趋势数据。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'TagNames',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Start',
'in' => 'query',
'schema' => ['description' => '查询数据的起始日期,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询开始时间最大不能早于当前时间2个月。', 'type' => 'string', 'required' => true, 'example' => '1642435200000'],
],
[
'name' => 'End',
'in' => 'query',
'schema' => ['description' => '查询数据的终止日期,格式为Unix时间戳,单位为毫秒。'."\n"
."\n"
.'> 查询结束时间需晚于查询开始时间,最晚只能查询到当天凌晨0点的数据。', 'type' => 'string', 'required' => true, 'example' => '1643040000000'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'PageNo' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageSize' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '趋势数据列表。',
'type' => 'array',
'items' => [
'description' => '趋势数据列表。',
'type' => 'object',
'properties' => [
'Kpi' => ['description' => '指标名,指标名及其含义如下:'."\n"
."\n"
.'- **sqlExecuteCount**:慢SQL执行次数。'."\n"
.'- **sqlExecuteCountDiff**:慢SQL执行次数相较于前一天的差值。'."\n"
.'- **sqlCount**:慢SQL模板数据。'."\n"
.'- **sqlCountDiff**:慢SQL模板数相较于前一天的差值。'."\n"
.'- **optimizedSqlExecuteCount**:推荐优化的慢SQL执行次。'."\n"
.'- **optimizedSqlExecuteCountDiff**:推荐优化的慢SQL执行次数相较于前一天的差值。'."\n"
.'- **optimizedSqlCount**:推荐优化的慢SQL数。'."\n"
.'- **optimizedSqlCountDiff**:推荐优化的慢SQL数相较于前一天的差值。', 'type' => 'string', 'example' => 'sqlExecuteCount'],
'Timestamp' => ['description' => '数据日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1643040000000'],
'Value' => ['description' => '指标数据的值。', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 10,\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"Kpi\\": \\"sqlExecuteCount\\",\\n \\"Timestamp\\": 1643040000000,\\n \\"Value\\": 1000\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeDataTrendResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>10</Total>\\n <Extra>None</Extra>\\n <List>\\n <Kpi>sqlExecuteCount</Kpi>\\n <Timestamp>1643040000000</Timestamp>\\n <Value>1000</Value>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeDataTrendResponse>","errorExample":""}]',
'title' => '获取查询治理趋势数据',
'description' => '- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于2.1.8,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为2.1.8或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeDataTrend',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetQueryOptimizeExecErrorSample' => [
'summary' => '调用GetQueryOptimizeExecErrorSample接口,获取执行失败的样本数据。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTQGIFY'],
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'SqlId',
'in' => 'query',
'schema' => ['description' => 'SQL模板ID,您可调用[GetQueryOptimizeExecErrorStats](~~405235~~)接口查询SQL模板ID。', 'type' => 'string', 'required' => true, 'example' => '2e8147b5ca2dfc640dfd5e43d96a****'],
],
[
'name' => 'Time',
'in' => 'query',
'schema' => ['description' => '查询数据的日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1642953600000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'PageNo' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageSize' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '返回信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OrigHost' => ['description' => '执行SQL的客户端IP地址。', 'type' => 'string', 'example' => '100.104.XX.XX'],
'User' => ['description' => '执行SQL的客户端用户名。', 'type' => 'string', 'example' => 'test01'],
'Dbname' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'testdb01'],
'SqlId' => ['description' => 'SQL模板ID。', 'type' => 'string', 'example' => '2e8147b5ca2dfc640dfd5e43d96a****'],
'SqlText' => ['description' => '执行错误的SQL文本。', 'type' => 'string', 'example' => 'select * from test1'],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '1146'],
'Timestamp' => ['description' => '错误SQL执行的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1643020306739'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 2,\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"OrigHost\\": \\"100.104.XX.XX\\",\\n \\"User\\": \\"test01\\",\\n \\"Dbname\\": \\"testdb01\\",\\n \\"SqlId\\": \\"2e8147b5ca2dfc640dfd5e43d96a****\\",\\n \\"SqlText\\": \\"select * from test1\\",\\n \\"ErrorCode\\": \\"1146\\",\\n \\"Timestamp\\": 1643020306739\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeExecErrorSampleResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>2</Total>\\n <Extra>None</Extra>\\n <List>\\n <OrigHost>100.104.XX.XX</OrigHost>\\n <User>test01</User>\\n <Dbname>testdb01</Dbname>\\n <SqlId>2e8147b5ca2dfc640dfd5e43d96a****</SqlId>\\n <SqlText>select * from test1</SqlText>\\n <ErrorCode>1146</ErrorCode>\\n <Timestamp>1643020306739</Timestamp>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeExecErrorSampleResponse>","errorExample":""}]',
'title' => '获取执行失败的样本数据',
'description' => '- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于2.1.8,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为2.1.8或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeExecErrorSample',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetQueryOptimizeExecErrorStats' => [
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID间用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => ['description' => 'SQL文本关键词,多个关键词以空格分隔。', 'type' => 'string', 'required' => false, 'example' => 'select update'],
],
[
'name' => 'LogicalOperator',
'in' => 'query',
'schema' => ['description' => '多个SQL文本关键词逻辑关系,当前支持:'."\n"
."\n"
.'- **or**:或。'."\n"
.'- **and**:与。', 'type' => 'string', 'required' => false, 'example' => 'or'],
],
[
'name' => 'DbNames',
'in' => 'query',
'schema' => ['description' => '需要查询的数据库名。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
[
'name' => 'Time',
'in' => 'query',
'schema' => ['description' => '查询数据的日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'required' => true, 'example' => '1642953600000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询每页数据量,默认为10。', 'type' => 'string', 'required' => true, 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'string', 'required' => true, 'example' => '1'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,当前仅支持error_count(SQL执行错误次数)。', 'type' => 'string', 'required' => false, 'example' => 'error_count'],
],
[
'name' => 'Asc',
'in' => 'query',
'schema' => ['description' => '是否升序排序,默认为**true**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'string', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '19'],
'PageNo' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '执行失败的模板数据列表。',
'type' => 'array',
'items' => [
'description' => '执行失败的模板数据列表。',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'InstanceName' => ['description' => '实例别名。', 'type' => 'string', 'example' => 'test01'],
'Dbname' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'testdb01'],
'SqlId' => ['description' => 'SQL模板ID。', 'type' => 'string', 'example' => '2e8147b5ca2dfc640dfd5e43d96a****'],
'SqlText' => ['description' => '执行错误的SQL文本。', 'type' => 'string', 'example' => 'select * from test1'],
'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '1146'],
'ErrorCount' => ['description' => '错误次数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取执行失败的模板数据',
'summary' => '调用GetQueryOptimizeExecErrorStats接口,获取执行失败的模板数据。',
'description' => '- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeExecErrorStats'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeExecErrorStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 19,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"InstanceName\\": \\"test01\\",\\n \\"Dbname\\": \\"testdb01\\",\\n \\"SqlId\\": \\"2e8147b5ca2dfc640dfd5e43d96a****\\",\\n \\"SqlText\\": \\"select * from test1\\",\\n \\"ErrorCode\\": \\"1146\\",\\n \\"ErrorCount\\": 10\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeExecErrorStatsResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>19</Total>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Extra>None</Extra>\\n <List>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n <InstanceName>test01</InstanceName>\\n <Dbname>testdb01</Dbname>\\n <SqlId>2e8147b5ca2dfc640dfd5e43d96a****</SqlId>\\n <SqlText>select * from test1</SqlText>\\n <ErrorCode>1146</ErrorCode>\\n <ErrorCount>10</ErrorCount>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeExecErrorStatsResponse>","errorExample":""}]',
],
'GetQueryOptimizeRuleList' => [
'summary' => '调用GetQueryOptimizeRuleList接口,获取规则列表。',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'TagNames',
'in' => 'query',
'schema' => ['title' => '', 'description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNo' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageSize' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '规则数据列表。',
'type' => 'array',
'items' => [
'description' => '规则数据列表。',
'type' => 'object',
'properties' => [
'Type' => ['description' => '规则类型,当前只支持 **Predefined**(系统预定义)。', 'type' => 'string', 'example' => 'Predefined'],
'Name' => ['description' => '规则名,具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'example' => 'LARGE_ROWS_EXAMINED'],
'RuleId' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取规则列表',
'description' => '- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于2.1.8,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为2.1.8或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeRuleList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeRuleList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 1,\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"Type\\": \\"Predefined\\",\\n \\"Name\\": \\"LARGE_ROWS_EXAMINED\\",\\n \\"RuleId\\": \\"None\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeRuleListResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>1</Total>\\n <Extra>None</Extra>\\n <List>\\n <Type>Predefined</Type>\\n <Name>LARGE_ROWS_EXAMINED</Name>\\n <RuleId>None</RuleId>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeRuleListResponse>","errorExample":""}]',
],
'GetQueryOptimizeShareUrl' => [
'summary' => '调用GetQueryOptimizeShareUrl接口,获取查询治理的分享链接。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTQGIFY'],
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**:RDS MySQL'."\n"
.'- **PolarDBMySQL**:PolarDB MySQL版'."\n"
.'- **PostgreSQL**:RDS PostgreSQL', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID,多个实例ID间用逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'TagNames',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Keywords',
'in' => 'query',
'schema' => ['description' => 'SQL文本关键词,多个关键词以空格分隔。', 'type' => 'string', 'required' => false, 'example' => 'select update'],
],
[
'name' => 'LogicalOperator',
'in' => 'query',
'schema' => ['description' => '多个SQL文本关键词的逻辑关系。'."\n"
."\n"
.'- **or**:或。'."\n"
.'- **and**:与。', 'type' => 'string', 'required' => false, 'example' => 'or'],
],
[
'name' => 'Rules',
'in' => 'query',
'schema' => ['description' => '需要过滤的规则,多个规则以逗号分隔。具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'required' => false, 'example' => 'DAS_NOT_IMPORTANT'],
],
[
'name' => 'DbNames',
'in' => 'query',
'schema' => ['description' => '需要查询的数据库名。', 'type' => 'string', 'required' => false, 'example' => 'testdb01'],
],
[
'name' => 'Time',
'in' => 'query',
'schema' => ['description' => '查询数据的日期,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1642953600000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '分页查询每页最大记录数,默认为10。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '分页查询的页码,从1开始,默认为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'OrderBy',
'in' => 'query',
'schema' => ['description' => '排序字段,默认为**count**。'."\n"
."\n"
.'- **count**:执行次数。'."\n"
.'- **maxQueryTime**:最大执行时间。'."\n"
.'- **avgQueryTime**:平均执行时间。'."\n"
.'- **maxLockTime**:最大锁等待时间。'."\n"
.'- **avgLockTime**:平均锁等待时间。'."\n"
.'- **maxRowsExamined**:最大扫描行数。'."\n"
.'- **avgRowsExamined**:平均扫描行数。'."\n"
.'- **maxRowsSent**:最大返回行数。'."\n"
.'- **avgRowsSent**:平均返回行数。', 'type' => 'string', 'required' => false, 'example' => 'count'],
],
[
'name' => 'Asc',
'in' => 'query',
'schema' => ['description' => '是否升序排序,默认为**true**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'OnlyOptimizedSql',
'in' => 'query',
'schema' => ['description' => '是否只查询待优化的SQL,默认为**false**。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'SqlIds',
'in' => 'query',
'schema' => ['description' => 'SQL模板ID,您可调用[GetQueryOptimizeDataStats](~~405261~~)接口查询SQL模板ID。', 'type' => 'string', 'required' => false, 'example' => '6068ce044e3dc9b903979672fb0b69df,d12515c015fc9f41a0778a9e1de0****'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
[
'name' => 'User',
'in' => 'query',
'schema' => ['description' => '需要查询的数据库账号。', 'type' => 'string', 'required' => false, 'example' => 'testUser'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => ['title' => 'String', 'description' => '分享链接', 'type' => 'string', 'example' => 'https://hdm.console.aliyun.com/#/queryOptimize****'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取查询治理的分享链接',
'description' => '- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeShareUrl'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeShareUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": \\"https://hdm.console.aliyun.com/#/queryOptimize****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeShareUrlResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>https://hdm.console.aliyun.com/#/queryOptimize****</Data>\\n</GetQueryOptimizeShareUrlResponse>","errorExample":""}]',
],
'GetQueryOptimizeSolution' => [
'summary' => '调用GetQueryOptimizeSolution接口,获取治理建议。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTQGIFY'],
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PostgreSQL**', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'SqlId',
'in' => 'query',
'schema' => ['description' => 'SQL模板ID。'."\n"
.'您可调用[GetQueryOptimizeDataStats](~~405261~~)接口查询SQL模板ID。', 'type' => 'string', 'required' => true, 'example' => '05fecf7e7b3efd123c4d5197035f****'],
],
[
'name' => 'RuleIds',
'in' => 'query',
'schema' => ['description' => '规则ID,具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'required' => true, 'example' => 'LARGE_ROWS_EXAMINED'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'您可调用[GetQueryOptimizeDataStats](~~405261~~)接口查询实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1o3z6beqpej****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总数据量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageNo' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'PageSize' => ['description' => '备用参数。', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
'Extra' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'List' => [
'description' => '治理建议列表。',
'type' => 'array',
'items' => [
'description' => '治理建议列表。',
'type' => 'object',
'properties' => [
'Level' => ['description' => '建议级别:'."\n"
."\n"
.'- **INFO**:提示。'."\n"
.'- **WARN**:警告。', 'type' => 'string', 'example' => 'INFO'],
'RuleId' => ['description' => '规则ID,具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'example' => 'LARGE_ROWS_EXAMINED'],
'Solution' => ['description' => '解决方案,具体信息请参见[查询治理](~~290038~~)。', 'type' => 'string', 'example' => 'LARGE_ROWS_EXAMINED_SOLUTION'],
'SolutionExt' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30FF4E40-17F3-5A51-AB23-43F30D9B****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取治理建议',
'description' => '- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeSolution'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeSolution',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 1,\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Extra\\": \\"None\\",\\n \\"List\\": [\\n {\\n \\"Level\\": \\"INFO\\",\\n \\"RuleId\\": \\"LARGE_ROWS_EXAMINED\\",\\n \\"Solution\\": \\"LARGE_ROWS_EXAMINED_SOLUTION\\",\\n \\"SolutionExt\\": \\"None\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"30FF4E40-17F3-5A51-AB23-43F30D9B****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeSolutionResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>1</Total>\\n <Extra>None</Extra>\\n <List>\\n <Level>INFO</Level>\\n <RuleId>LARGE_ROWS_EXAMINED</RuleId>\\n <Solution>LARGE_ROWS_EXAMINED_SOLUTION</Solution>\\n <SolutionExt>None</SolutionExt>\\n </List>\\n </Data>\\n <RequestId>30FF4E40-17F3-5A51-AB23-43F30D9B****</RequestId>\\n <Success>true</Success>\\n</GetQueryOptimizeSolutionResponse>","errorExample":""}]',
],
'GetQueryOptimizeTag' => [
'summary' => '调用GetQueryOptimizeTag接口,获取指定SQL的标签。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTQGIFY'],
],
'parameters' => [
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**:RDS MySQL'."\n"
.'- **PolarDBMySQL**:PolarDB MySQL版'."\n"
.'- **PostgreSQL**:RDS PostgreSQL', 'type' => 'string', 'required' => true, 'example' => 'MySQL'],
],
[
'name' => 'SqlId',
'in' => 'query',
'schema' => ['description' => 'SQL模板ID。'."\n"
.'您可调用[GetQueryOptimizeDataStats](~~405261~~)接口查询SQL模板ID。', 'type' => 'string', 'required' => true, 'example' => '29d9fef63e347d39c3436658a5fe****'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'title' => 'SqlTag',
'description' => '返回的SQL标签数据。',
'type' => 'object',
'properties' => [
'SqlId' => ['description' => 'SQL模板ID', 'type' => 'string', 'example' => '29d9fef63e347d39c3436658a5fe****'],
'Tags' => ['title' => '逗号分隔的多个tag', 'description' => 'SQL标签,多个标签间使用英文逗号(,)分隔。', 'type' => 'string', 'example' => 'DAS_IN_PLAN,DAS_NOT_IMPORTANT'],
'Comments' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'Slow SQL from offline synchronization. No optimization needed.'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"SqlId\\": \\"29d9fef63e347d39c3436658a5fe****\\",\\n \\"Tags\\": \\"DAS_IN_PLAN,DAS_NOT_IMPORTANT\\",\\n \\"Comments\\": \\"Slow SQL from offline synchronization. No optimization needed.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetQueryOptimizeTagResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <SqlId>29d9fef63e347d39c3436658a5fe****</SqlId>\\n <Tags>DAS_IN_PLAN,DAS_NOT_IMPORTANT</Tags>\\n <Comments>离线同步类慢SQL,无需优化。</Comments>\\n </Data>\\n</GetQueryOptimizeTagResponse>","errorExample":""}]',
'title' => '获取SQL标签',
'description' => '- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL'."\n"
.' - PolarDB MySQL版'."\n"
.' - RDS PostgreSQL',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeTag'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetRedisAllSession' => [
'summary' => '调用GetRedisAllSession接口,获取Redis实例当前会话数据。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '154787',
'abilityTreeNodes' => ['FEATUREhdmMEY212'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => 'r-2zemyfd1sh1u2i****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回的消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '会话数据。',
'type' => 'object',
'properties' => [
'Timestamp' => ['description' => '获取数据库会话数据的时间,格式为Unix时间戳,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1660100753556'],
'Total' => ['description' => '会话总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Sessions' => [
'description' => '会话信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Sub' => ['description' => '频道订阅数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Psub' => ['description' => '模式匹配的订阅数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Idle' => ['description' => '空闲时长,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
'Flags' => ['description' => '客户端标志,取值如下:'."\n"
."\n"
.'- **A**:尽快关闭连接。'."\n"
.'- **b**:客户端正在等待阻塞事件。'."\n"
.'- **c**:写入全部回复后将关闭连接。'."\n"
.'- **d**:受监视的键已被修改,`EXEC`命令将失败。'."\n"
.'- **i**:客户端正在等待虚拟机I/O操作(已废弃)。'."\n"
.'- **M**:客户端是主节点。'."\n"
.'- **N**:未设置特点标志。'."\n"
.'- **O**:处于监视模式的客户端。'."\n"
.'- **r**:客户端是只读模式的集群节点。'."\n"
.'- **S**:客户端是一般模式下的从节点。'."\n"
.'- **u**:客户端未被阻塞。'."\n"
.'- **U**:通过Unix域套接字连接的客户端。'."\n"
.'- **x**:客户端正在执行事务。'."\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n", 'type' => 'string', 'example' => 'N'],
'Oll' => ['description' => '输出列表包含的对象数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'QbufFree' => ['description' => '输入缓冲区剩余大小,单位为字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Multi' => ['description' => '`MULTI`/`EXEC`上下文中的命令数。', 'type' => 'integer', 'format' => 'int64', 'example' => '-1'],
'Omem' => ['description' => '输出缓冲区大小,单位为字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Qbuf' => ['description' => '输入缓冲区大小,单位为字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Name' => ['description' => '客户端名称。', 'type' => 'string', 'example' => 'test'],
'Obl' => ['description' => '输出固定缓冲区大小,单位为字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Client' => ['description' => '客户端的地址。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'Cmd' => ['description' => '最近一次执行的命令。', 'type' => 'string', 'example' => 'PING'],
'Id' => ['description' => '客户端ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '9080586'],
'Addr' => ['description' => '客户端的地址和端口。', 'type' => 'string', 'example' => '172.16.XX.XX:53458'],
'NodeId' => ['description' => '节点ID。', 'type' => 'string', 'example' => 'r-2zemyfd1sh1u2i****-proxy-14#1679****'],
'Age' => ['description' => '已连接时长,单位为秒(s)。', 'type' => 'string', 'example' => '12'],
'Db' => ['description' => '该客户端正在使用的数据库ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'Events' => ['description' => '文件描述符事件,取值为:'."\n"
."\n"
.'- **r**:客户端套接字在事件Loop中可读。'."\n"
.'- **w**:客户端套接字在事件Loop中可写。', 'type' => 'string', 'example' => 'r'],
'Fd' => ['description' => '套接字所使用的文件描述符。', 'type' => 'integer', 'format' => 'int64', 'example' => '73'],
'ClientDesc' => ['description' => '客户端别名。', 'type' => 'string', 'example' => 'prod ip'],
],
'description' => '',
],
],
'SourceStats' => [
'description' => '访问来源统计数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Key' => ['description' => '访问来源。', 'type' => 'string', 'example' => '172.16.XX.XX'],
'Count' => ['description' => '该访问来源的会话总数。', 'type' => 'string', 'example' => '1'],
'Ids' => [
'description' => '客户端ID数据。',
'type' => 'array',
'items' => ['description' => '客户端ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '9080586'],
],
],
'description' => '',
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '40C6E9AF-6C23-5614-AA83-34344CC6****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取Redis实例当前会话',
'description' => "\n"
.'- 本接口只适用于Redis引擎。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'> 对于Redis集群版数据库实例,无法获取使用直连模式产生的会话。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRedisAllSession'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRedisAllSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Timestamp\\": 1660100753556,\\n \\"Total\\": 2,\\n \\"Sessions\\": [\\n {\\n \\"Sub\\": 0,\\n \\"Psub\\": 0,\\n \\"Idle\\": 8,\\n \\"Flags\\": \\"N\\",\\n \\"Oll\\": 0,\\n \\"QbufFree\\": 0,\\n \\"Multi\\": -1,\\n \\"Omem\\": 0,\\n \\"Qbuf\\": 0,\\n \\"Name\\": \\"test\\",\\n \\"Obl\\": 0,\\n \\"Client\\": \\"172.16.XX.XX\\",\\n \\"Cmd\\": \\"PING\\",\\n \\"Id\\": 9080586,\\n \\"Addr\\": \\"172.16.XX.XX:53458\\",\\n \\"NodeId\\": \\"r-2zemyfd1sh1u2i****-proxy-14#1679****\\",\\n \\"Age\\": \\"12\\",\\n \\"Db\\": 0,\\n \\"Events\\": \\"r\\",\\n \\"Fd\\": 73,\\n \\"ClientDesc\\": \\"prod ip\\"\\n }\\n ],\\n \\"SourceStats\\": [\\n {\\n \\"Key\\": \\"172.16.XX.XX\\",\\n \\"Count\\": \\"1\\",\\n \\"Ids\\": [\\n 9080586\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"40C6E9AF-6C23-5614-AA83-34344CC6****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetRedisAllSessionResponse>\\n <Message>Successful</Message>\\n <RequestId>40C6E9AF-6C23-5614-AA83-34344CC6****</RequestId>\\n <Data>\\n <SourceStats>\\n <Ids>5</Ids>\\n <Count>1</Count>\\n <Key>11.200.XX.XX</Key>\\n </SourceStats>\\n <SourceStats>\\n <Ids>106909499</Ids>\\n <Count>1</Count>\\n <Key>127.0.XX.XX</Key>\\n </SourceStats>\\n <Total>2</Total>\\n <Sessions>\\n <Sub>0</Sub>\\n <Omem>0</Omem>\\n <Qbuf>0</Qbuf>\\n <Multi>-1</Multi>\\n <Flags>N</Flags>\\n <Oll>0</Oll>\\n <Addr>127.0.XX.XX:44019</Addr>\\n <Name/>\\n <Events>r</Events>\\n <Psub>0</Psub>\\n <Idle>1</Idle>\\n <Obl>0</Obl>\\n <Cmd>config</Cmd>\\n <Id>106909499</Id>\\n <Client>127.0.XX.XX</Client>\\n <Age>6101538</Age>\\n <Db>0</Db>\\n <Fd>6</Fd>\\n </Sessions>\\n <Sessions>\\n <Sub>0</Sub>\\n <Omem>0</Omem>\\n <Qbuf>0</Qbuf>\\n <Multi>-1</Multi>\\n <Flags>S</Flags>\\n <Oll>0</Oll>\\n <Addr>127.0.XX.XX:44019</Addr>\\n <Name/>\\n <Events>r</Events>\\n <Psub>0</Psub>\\n <Idle>1</Idle>\\n <Obl>0</Obl>\\n <Cmd>replconf</Cmd>\\n <Id>5</Id>\\n <Client>11.200.XX.XX</Client>\\n <Age>67387263</Age>\\n <Db>0</Db>\\n <Fd>10</Fd>\\n </Sessions>\\n <Timestamp>1663912392217</Timestamp>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetRedisAllSessionResponse>","errorExample":""}]',
],
'GetRequestDiagnosisPage' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-0iwhhl8gx0ld6****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版、PolarDB PostgreSQL版(兼容Oracle)和云数据库MongoDB等集群实例,需要提供节点ID。', 'type' => 'string', 'required' => false, 'example' => '202****'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '查询任务的开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1633071840000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '查询任务的结束时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1634972640000'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求的ID。', 'type' => 'string', 'example' => '800FBAF5-A539-5B97-A09E-C63AB2F7****'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'list' => [
'description' => 'SQL诊断历史记录列表。',
'type' => 'array',
'items' => [
'description' => 'SQL诊断历史记录列表。',
'type' => 'object',
'properties' => [
'messageId' => ['description' => '诊断ID,唯一标识。', 'type' => 'string', 'example' => '61820b594664275c4429****'],
'uuid' => ['description' => '诊断实例的唯一标识。', 'type' => 'string', 'example' => 'hdm_51fe9bc19ec413f4d530431af87a****'],
'accountId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '2093****'],
'sqlId' => ['description' => 'SQL模板ID。', 'type' => 'string', 'example' => '0c95dae3afef77be06572612df9b****'],
'engine' => ['description' => '数据库引擎:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PostgreSQL**'."\n"
.'- **SQLServer**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PolarDBOracle**'."\n"
.'- **MongoDB**', 'type' => 'string', 'example' => 'MySQL'],
'dbSchema' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'das'],
'param' => ['description' => '额外信息。', 'type' => 'string', 'example' => '{"":""}'],
'state' => ['description' => '诊断状态:'."\n"
."\n"
.'- **0**:诊断中。'."\n"
."\n"
.'- **1**:诊断错误。'."\n"
."\n"
.'- **2**:诊断完成。'."\n"
."\n"
.'- **3**:SQL错误。'."\n"
."\n"
.'- **4**:引擎错误。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'result' => ['description' => 'SQL诊断结果:'."\n"
."\n"
.'- **endTime**:SQL诊断的结束时间。'."\n"
.'- **errorCode**:错误码。'."\n"
.' - **0001**:诊断成功。'."\n"
.' - **0003**:诊断失败。'."\n"
.'- **errorMessage**:错误信息。'."\n"
.'- **estimateCost**:预估得消耗。'."\n"
.' - **cpu**:索引的CPU消耗预估值。'."\n"
.' - **io**:索引的IO消耗预估值。'."\n"
.' - **rows**:索引的返回列预估值。'."\n"
.'- **improvement**:性能提升比。'."\n"
.'- **indexAdvices**:索引建议。'."\n"
.' - **columns**:索引列。'."\n"
.' - **ddlAddIndex**:索引DDL语句。'."\n"
.' - **indexName**:索引名。'."\n"
.' - **schemaName**:数据库名。'."\n"
.' - **tableName**:表名。'."\n"
.' - **unique**:是否唯一索引。'."\n"
.'- **ip**:实例的IP地址。'."\n"
.'- **messageId**:诊断ID。'."\n"
.'- **port**:实例的端口。'."\n"
.'- **sqlTag**:SQL标签。'."\n"
.'- **startTime**:SQL诊断的开始时间。'."\n"
.'- **success**:请求是否执行成功。'."\n"
.'- **support**:SQL语句是否支持诊断。'."\n"
.' - **true**:支持。'."\n"
.' - **false**:不支持。'."\n"
.'- **tuningAdvices**:SQL改写建议。'."\n"
."\n", 'type' => 'string', 'example' => '{ "endTime":1636354256000, "errorCode":"0001", "errorMessage":"TFX成功", "estimateCost":{ "cpu":1.7878745150389268, "io":9.948402604746128, "rows":8.889372575194633 }, "improvement":12933.97, "indexAdvices":[ { "columns":[ "work_no" ], "ddlAddIndex":"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)", "indexName":"idx_workno", "schemaName":"test", "tableName":"work_order", "unique":false } ], "ip":"****.mysql.rds.aliyuncs.com", "messageId":"6188c8cb2f1365b16aee****", "port":3306, "sqlTag":"{\\"PRED_EQUAL\\":\\"Y\\",\\"CNT_QB\\":\\"1\\",\\"CNT_TB\\":\\"1\\"}", "startTime":1636354252000, "success":true, "support":true, "tuningAdvices":[ ] }'],
'gmtCreate' => ['description' => 'SQL诊断创建时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '1633071840000'],
'gmtModified' => ['description' => 'SQL诊断修改时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '1633071850000'],
],
],
],
'pageNo' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'pageSize' => ['description' => '每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'total' => ['description' => '查询到的总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'extra' => ['description' => '其他信息。', 'type' => 'string', 'example' => '{"":""}'],
],
],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '分页获取SQL诊断历史记录',
'summary' => '调用GetRequestDiagnosisPage接口,分页获取SQL诊断历史记录。',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
."\n"
.' - RDS MySQL'."\n"
.' - RDS PostgreSQL'."\n"
.' - RDS SQL Server'."\n"
.' - PolarDB MySQL版'."\n"
.' - PolarDB PostgreSQL版(兼容Oracle)'."\n"
.' - 云数据库MongoDB版'."\n"
."\n"
.'> RDS PostgreSQL实例内核小版本为20220130及以上。查看和升级内核小版本,请参见[升级内核小版本](~~146895~~)。'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRequestDiagnosisPage'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRequestDiagnosisPage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"800FBAF5-A539-5B97-A09E-C63AB2F7****\\",\\n \\"Data\\": {\\n \\"list\\": [\\n {\\n \\"messageId\\": \\"61820b594664275c4429****\\",\\n \\"uuid\\": \\"hdm_51fe9bc19ec413f4d530431af87a****\\",\\n \\"accountId\\": \\"2093****\\",\\n \\"sqlId\\": \\"0c95dae3afef77be06572612df9b****\\",\\n \\"engine\\": \\"MySQL\\",\\n \\"dbSchema\\": \\"das\\",\\n \\"param\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"state\\": 2,\\n \\"result\\": \\"{ \\\\\\"endTime\\\\\\":1636354256000, \\\\\\"errorCode\\\\\\":\\\\\\"0001\\\\\\", \\\\\\"errorMessage\\\\\\":\\\\\\"TFX成功\\\\\\", \\\\\\"estimateCost\\\\\\":{ \\\\\\"cpu\\\\\\":1.7878745150389268, \\\\\\"io\\\\\\":9.948402604746128, \\\\\\"rows\\\\\\":8.889372575194633 }, \\\\\\"improvement\\\\\\":12933.97, \\\\\\"indexAdvices\\\\\\":[ { \\\\\\"columns\\\\\\":[ \\\\\\"work_no\\\\\\" ], \\\\\\"ddlAddIndex\\\\\\":\\\\\\"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)\\\\\\", \\\\\\"indexName\\\\\\":\\\\\\"idx_workno\\\\\\", \\\\\\"schemaName\\\\\\":\\\\\\"test\\\\\\", \\\\\\"tableName\\\\\\":\\\\\\"work_order\\\\\\", \\\\\\"unique\\\\\\":false } ], \\\\\\"ip\\\\\\":\\\\\\"****.mysql.rds.aliyuncs.com\\\\\\", \\\\\\"messageId\\\\\\":\\\\\\"6188c8cb2f1365b16aee****\\\\\\", \\\\\\"port\\\\\\":3306, \\\\\\"sqlTag\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"PRED_EQUAL\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Y\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNT_QB\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNT_TB\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\\\\\", \\\\\\"startTime\\\\\\":1636354252000, \\\\\\"success\\\\\\":true, \\\\\\"support\\\\\\":true, \\\\\\"tuningAdvices\\\\\\":[ ] }\\",\\n \\"gmtCreate\\": \\"1633071840000\\",\\n \\"gmtModified\\": \\"1633071850000\\"\\n }\\n ],\\n \\"pageNo\\": 1,\\n \\"pageSize\\": 10,\\n \\"total\\": 100,\\n \\"extra\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetRequestDiagnosisPageResponse>\\n <Message>Successful</Message>\\n <RequestId>800FBAF5-A539-5B97-A09E-C63AB2F7****</RequestId>\\n <Data>\\n <list>\\n <messageId>61820b594664275c4429****</messageId>\\n <uuid>hdm_51fe9bc19ec413f4d530431af87a****</uuid>\\n <accountId>2093****</accountId>\\n <sqlId>0c95dae3afef77be06572612df9b****</sqlId>\\n <engine>MySQL</engine>\\n <dbSchema>das</dbSchema>\\n <param>{\\"\\":\\"\\"}</param>\\n <state>2</state>\\n <result>{ \\"endTime\\":1636354256000, \\"errorCode\\":\\"0001\\", \\"errorMessage\\":\\"TFX成功\\", \\"estimateCost\\":{ \\"cpu\\":1.7878745150389268, \\"io\\":9.948402604746128, \\"rows\\":8.889372575194633 }, \\"improvement\\":12933.97, \\"indexAdvices\\":[ { \\"columns\\":[ \\"work_no\\" ], \\"ddlAddIndex\\":\\"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)\\", \\"indexName\\":\\"idx_workno\\", \\"schemaName\\":\\"test\\", \\"tableName\\":\\"work_order\\", \\"unique\\":false } ], \\"ip\\":\\"****.mysql.rds.aliyuncs.com\\", \\"messageId\\":\\"6188c8cb2f1365b16aee****\\", \\"port\\":3306, \\"sqlTag\\":\\"{\\\\\\"PRED_EQUAL\\\\\\":\\\\\\"Y\\\\\\",\\\\\\"CNT_QB\\\\\\":\\\\\\"1\\\\\\",\\\\\\"CNT_TB\\\\\\":\\\\\\"1\\\\\\"}\\", \\"startTime\\":1636354252000, \\"success\\":true, \\"support\\":true, \\"tuningAdvices\\":[ ] }</result>\\n <gmtCreate>1633071840000</gmtCreate>\\n <gmtModified>1633071850000</gmtModified>\\n </list>\\n <pageNo>1</pageNo>\\n <pageSize>10</pageSize>\\n <total>100</total>\\n <extra>{\\"\\":\\"\\"}</extra>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetRequestDiagnosisPageResponse>","errorExample":""}]',
],
'GetRequestDiagnosisResult' => [
'summary' => '调用GetRequestDiagnosisResult接口,查询SQL诊断的结果。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-0iwhhl8gx0ld6****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 对于PolarDB MySQL版、PolarDB PostgreSQL版(兼容Oracle)和云数据库MongoDB等集群实例,需要提供节点ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '202****'],
],
[
'name' => 'MessageId',
'in' => 'query',
'schema' => ['description' => '诊断ID,[CreateRequestDiagnosis](~~341609~~)接口返回的诊断唯一标识。'."\n"
.'>当MessageId为自动SQL优化的诊断ID时,该接口无法返回诊断结果', 'type' => 'string', 'required' => true, 'example' => '61820b594664275c4429****'],
],
[
'name' => 'SqlId',
'in' => 'query',
'schema' => ['title' => 'SQL模板ID', 'description' => 'SQL模板ID。'."\n"
."\n"
.'> 此参数是DAS控制台调用API时使用,用户使用此API时无需传入。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['title' => '诊断来源', 'description' => '任务来源。'."\n"
."\n"
.'> 此参数是DAS控制台调用API时使用,用户使用此API时无需传入。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。'."\n"
."\n", 'type' => 'string', 'example' => '800FBAF5-A539-5B97-A09E-C63AB2F7****'],
'Data' => [
'description' => '返回数据',
'type' => 'object',
'properties' => [
'messageId' => ['description' => '诊断ID,唯一标识。', 'type' => 'string', 'example' => '61820b594664275c4429****'],
'uuid' => ['description' => '诊断实例唯一标识。', 'type' => 'string', 'example' => 'hdm_51fe9bc19ec413f4d530431af87a****'],
'accountId' => ['description' => '用户ID。', 'type' => 'string', 'example' => '2093****'],
'sqlId' => ['description' => 'SQL模板ID。', 'type' => 'string', 'example' => '0c95dae3afef77be06572612df9b****'],
'engine' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**'."\n"
.'- **PostgreSQL**'."\n"
.'- **SQLServer**'."\n"
.'- **PolarDBMySQL**'."\n"
.'- **PolarDBOracle**'."\n"
.'- **MongoDB**'."\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n"
."\n\n", 'type' => 'string', 'example' => 'MySQL'],
'dbSchema' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'das'],
'param' => ['description' => '额外信息。', 'type' => 'string', 'example' => '{"":""}'],
'state' => ['description' => '诊断状态:'."\n"
."\n"
.'- **0**:诊断中。'."\n"
.'- **1**:诊断错误。'."\n"
.'- **2**:诊断完成。'."\n"
.'- **3**:SQL错误。'."\n"
.'- **4**:引擎错误。', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
'result' => ['description' => 'SQL诊断结果。'."\n"
."\n"
.'- **endTime**:SQL诊断的结束时间。'."\n"
.'- **errorCode**:错误码。'."\n"
.' - **0001**:诊断成功。'."\n"
.' - **0003**:诊断失败。'."\n"
.'- **errorMessage**:错误信息。'."\n"
.'- **estimateCost**:预估得消耗。'."\n"
.' - **cpu**:索引的CPU消耗预估值。'."\n"
.' - **io**:索引的IO消耗预估值。'."\n"
.' - **rows**:索引的返回列预估值。'."\n"
.'- **improvement**:性能提升比。'."\n"
.'- **indexAdvices**:索引建议。'."\n"
.' - **columns**:索引列。'."\n"
.' - **ddlAddIndex**:索引DDL语句。'."\n"
.' - **indexName**:索引名。'."\n"
.' - **schemaName**:数据库名。'."\n"
.' - **tableName**:表名。'."\n"
.' - **unique**:是否唯一索引。'."\n"
.'- **ip**:实例的IP地址。'."\n"
.'- **messageId**:诊断ID。'."\n"
.'- **port**:实例的端口。'."\n"
.'- **sqlTag**:SQL标签。'."\n"
.' - **PRED_EQUAL**:等值谓词。'."\n"
.' - **CNT_QB**:查询块数量。'."\n"
.' - **CNT_TB**:表数量。'."\n"
.' - **JOIN_LEFT**:左连接。'."\n"
.' - **SEL_SMALL**:小结果集选择。'."\n"
.' - **AGGR_SEL**:聚合选择。'."\n"
.' - **PRED_LT_EQ / PRED_GT_EQ**:小于等于 / 大于等于谓词。'."\n"
.' - **PRED_LIKE_PREFIX**:LIKE 前缀匹配。'."\n"
.' - **ORDER_BY**:包含 ORDER BY 子句。'."\n"
.' - **LIMIT**:包含 LIMIT 子句。'."\n"
.' - **GROUP_BY**:包含 GROUP BY 子句。'."\n"
.' - **JOIN_INNER**:内连接。'."\n"
.' - **JOIN_RIGHT**:右连接。'."\n"
.' - **HAVING**:包含 HAVING 子句。'."\n"
.' - **UNION**:包含 UNION 操作。'."\n"
.'- **startTime**:SQL诊断的开始时间。'."\n"
.'- **success**:请求是否执行成功。'."\n"
.'- **support**:SQL语句是否支持诊断。'."\n"
.' - **true**:支持。'."\n"
.' - **false**:不支持。'."\n"
.'- **tuningAdvices**:SQL改写建议。', 'type' => 'string', 'example' => '{ "endTime":1636354256000, "errorCode":"0001", "errorMessage":"TFX成功", "estimateCost":{ "cpu":1.7878745150389268, "io":9.948402604746128, "rows":8.889372575194633 }, "improvement":12933.97, "indexAdvices":[ { "columns":[ "work_no" ], "ddlAddIndex":"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)", "indexName":"idx_workno", "schemaName":"test", "tableName":"work_order", "unique":false } ], "ip":"****.mysql.rds.aliyuncs.com", "messageId":"6188c8cb2f1365b16aee****", "port":3306, "sqlTag":"{\\"PRED_EQUAL\\":\\"Y\\",\\"CNT_QB\\":\\"1\\",\\"CNT_TB\\":\\"1\\"}", "startTime":1636354252000, "success":true, "support":true, "tuningAdvices":[ ] }'],
'gmtCreate' => ['description' => 'SQL诊断创建时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '1633071840000'],
'gmtModified' => ['description' => 'SQL诊断修改时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '1633071850000'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"800FBAF5-A539-5B97-A09E-C63AB2F7****\\",\\n \\"Data\\": {\\n \\"messageId\\": \\"61820b594664275c4429****\\",\\n \\"uuid\\": \\"hdm_51fe9bc19ec413f4d530431af87a****\\",\\n \\"accountId\\": \\"2093****\\",\\n \\"sqlId\\": \\"0c95dae3afef77be06572612df9b****\\",\\n \\"engine\\": \\"MySQL\\",\\n \\"dbSchema\\": \\"das\\",\\n \\"param\\": \\"{\\\\\\"\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"state\\": 2,\\n \\"result\\": \\"{ \\\\\\"endTime\\\\\\":1636354256000, \\\\\\"errorCode\\\\\\":\\\\\\"0001\\\\\\", \\\\\\"errorMessage\\\\\\":\\\\\\"TFX成功\\\\\\", \\\\\\"estimateCost\\\\\\":{ \\\\\\"cpu\\\\\\":1.7878745150389268, \\\\\\"io\\\\\\":9.948402604746128, \\\\\\"rows\\\\\\":8.889372575194633 }, \\\\\\"improvement\\\\\\":12933.97, \\\\\\"indexAdvices\\\\\\":[ { \\\\\\"columns\\\\\\":[ \\\\\\"work_no\\\\\\" ], \\\\\\"ddlAddIndex\\\\\\":\\\\\\"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)\\\\\\", \\\\\\"indexName\\\\\\":\\\\\\"idx_workno\\\\\\", \\\\\\"schemaName\\\\\\":\\\\\\"test\\\\\\", \\\\\\"tableName\\\\\\":\\\\\\"work_order\\\\\\", \\\\\\"unique\\\\\\":false } ], \\\\\\"ip\\\\\\":\\\\\\"****.mysql.rds.aliyuncs.com\\\\\\", \\\\\\"messageId\\\\\\":\\\\\\"6188c8cb2f1365b16aee****\\\\\\", \\\\\\"port\\\\\\":3306, \\\\\\"sqlTag\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"PRED_EQUAL\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Y\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNT_QB\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CNT_TB\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\"}\\\\\\", \\\\\\"startTime\\\\\\":1636354252000, \\\\\\"success\\\\\\":true, \\\\\\"support\\\\\\":true, \\\\\\"tuningAdvices\\\\\\":[ ] }\\",\\n \\"gmtCreate\\": \\"1633071840000\\",\\n \\"gmtModified\\": \\"1633071850000\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetRequestDiagnosisResultResponse>\\n <Message>Successful</Message>\\n <RequestId>800FBAF5-A539-5B97-A09E-C63AB2F7****</RequestId>\\n <Data>\\n <messageId>61820b594664275c4429****</messageId>\\n <uuid>hdm_51fe9bc19ec413f4d530431af87a****</uuid>\\n <accountId>2093****</accountId>\\n <sqlId>0c95dae3afef77be06572612df9b****</sqlId>\\n <engine>MySQL</engine>\\n <dbSchema>das</dbSchema>\\n <param>{\\"\\":\\"\\"}</param>\\n <state>2</state>\\n <result>{ \\"endTime\\":1636354256000, \\"errorCode\\":\\"0001\\", \\"errorMessage\\":\\"TFX成功\\", \\"estimateCost\\":{ \\"cpu\\":1.7878745150389268, \\"io\\":9.948402604746128, \\"rows\\":8.889372575194633 }, \\"improvement\\":12933.97, \\"indexAdvices\\":[ { \\"columns\\":[ \\"work_no\\" ], \\"ddlAddIndex\\":\\"ALTER TABLE `test`.`work_order` ADD INDEX `idx_workno` (`work_no`)\\", \\"indexName\\":\\"idx_workno\\", \\"schemaName\\":\\"test\\", \\"tableName\\":\\"work_order\\", \\"unique\\":false } ], \\"ip\\":\\"****.mysql.rds.aliyuncs.com\\", \\"messageId\\":\\"6188c8cb2f1365b16aee****\\", \\"port\\":3306, \\"sqlTag\\":\\"{\\\\\\"PRED_EQUAL\\\\\\":\\\\\\"Y\\\\\\",\\\\\\"CNT_QB\\\\\\":\\\\\\"1\\\\\\",\\\\\\"CNT_TB\\\\\\":\\\\\\"1\\\\\\"}\\", \\"startTime\\":1636354252000, \\"success\\":true, \\"support\\":true, \\"tuningAdvices\\":[ ] }</result>\\n <gmtCreate>1633071840000</gmtCreate>\\n <gmtModified>1633071850000</gmtModified>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetRequestDiagnosisResultResponse>","errorExample":""}]',
'title' => '查询SQL诊断的结果',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 该接口不支持查询自动SQL优化的诊断结果'."\n"
.'- 本接口适用的数据库引擎为:'."\n"
."\n"
.' - RDS MySQL'."\n"
.' - RDS PostgreSQL'."\n"
.' - RDS SQL Server'."\n"
.' - PolarDB MySQL版'."\n"
.' - PolarDB PostgreSQL版(兼容Oracle)'."\n"
.' - 云数据库MongoDB版'."\n"
."\n"
.'> RDS PostgreSQL实例内核小版本为20220130及以上。查看和升级内核小版本,请参见[升级内核小版本](~~146895~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRequestDiagnosisResult'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRequestDiagnosisResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetRunningSqlConcurrencyControlRules' => [
'summary' => '调用GetRunningSqlConcurrencyControlRules接口,获取正在执行的限流规则。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL和 PolarDB MySQL版实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'runningRules' => [
'description' => '返回信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemId' => ['description' => '当前实例的限流规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'SqlType' => ['description' => '选择SQL的类型。取值:'."\n"
.'- **SELECT**'."\n"
.'- **UPDATE**'."\n"
.'- **DELETE**', 'type' => 'string', 'example' => 'SELECT'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
'SqlKeywords' => ['description' => '需要限流的SQL关键词。'."\n"
.'>多个关键词间用波浪线(~)分隔,SQL语句中需要同时包含这些关键词才会触发限流规则。', 'type' => 'string', 'example' => 'call~open~api~test~4~from~POP'],
'StartTime' => ['description' => '获取正在执行的限流规则的开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296000'],
'KeywordsHash' => ['description' => '哈希值,根据输入的限流关键词计算出来的值。', 'type' => 'string', 'example' => 'b0b8aceeb43baea87b219c81767b****'],
'ConcurrencyControlTime' => ['description' => 'SQL限流的生效时长,单位为秒。'."\n"
.'>限流规则仅在生效时间内开启。', 'type' => 'integer', 'format' => 'int64', 'example' => '600'],
'UserId' => ['description' => '阿里云账号ID。', 'type' => 'string', 'example' => 'testxxx'],
'MaxConcurrency' => ['description' => 'SQL最大并发数,取值为大于或等于1的整数。'."\n"
.'>当包含关键词的SQL达到最大并发数时会触发限流策略。', 'type' => 'string', 'example' => '2'],
'Status' => ['description' => '限流规则的生效状态,取值为**Open**:限流规则正在生效中。', 'type' => 'string', 'example' => 'Open'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取正在执行的限流规则',
'description' => '本接口适用的数据库引擎为:'."\n"
.'- RDS MySQL'."\n"
.'- PolarDB MySQL版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRunningSqlConcurrencyControlRules'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRunningSqlConcurrencyControlRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 2,\\n \\"List\\": {\\n \\"runningRules\\": [\\n {\\n \\"ItemId\\": 16,\\n \\"SqlType\\": \\"SELECT\\",\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\",\\n \\"SqlKeywords\\": \\"call~open~api~test~4~from~POP\\",\\n \\"StartTime\\": 1608888296000,\\n \\"KeywordsHash\\": \\"b0b8aceeb43baea87b219c81767b****\\",\\n \\"ConcurrencyControlTime\\": 600,\\n \\"UserId\\": \\"testxxx\\",\\n \\"MaxConcurrency\\": \\"2\\",\\n \\"Status\\": \\"Open\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetRunningSqlConcurrencyControlRulesResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>2</Total>\\n <List>\\n <ItemId>16</ItemId>\\n <SqlType>SELECT</SqlType>\\n <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>\\n <SqlKeywords>call~open~api~test~4~from~POP</SqlKeywords>\\n <StartTime>1608888296000</StartTime>\\n <KeywordsHash>b0b8aceeb43baea87b219c81767b****</KeywordsHash>\\n <ConcurrencyControlTime>600</ConcurrencyControlTime>\\n <UserId>testxxx</UserId>\\n <MaxConcurrency>2</MaxConcurrency>\\n <Status>Open</Status>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetRunningSqlConcurrencyControlRulesResponse>","errorExample":""}]',
],
'GetSqlConcurrencyControlKeywordsFromSqlText' => [
'summary' => '调用GetSqlConcurrencyControlKeywordsFromSqlText接口,根据原始SQL语句,生成限流关键词串。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze5hpn2b99d2****'],
],
[
'name' => 'SqlText',
'in' => 'query',
'schema' => ['description' => '待生成限流关键词的SQL文本。', 'type' => 'string', 'required' => true, 'example' => 'SELECT * FROM test where name = \'das\''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '根据模板化后的SQL生成的限流关键词串。', 'type' => 'string', 'example' => 'SELECT~FROM~test~where~name'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '30A643F5-D7A6-55F5-AB75-DF501427****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '根据SQL语句生成限流关键词',
'description' => '本接口适用的数据库引擎为:'."\n"
.'- RDS MySQL'."\n"
.'- PolarDB MySQL版',
'responseParamsDescription' => '返回的限流关键词串,是根据模板化后的SQL生成的,如果需要限流某个特定值,则需要带上相应的参数。例如:原始SQL语句为`SELECT \\* FROM test where name = \'das\'`,返回的限流关键词串是`SELECT~FROM~test~where~name`,如果需要限流`name = \'das\'`,则需要在返回的限流关键词串中增加`~das`,即限流关键词串为`SELECT~FROM~test~where~name~das`。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlConcurrencyControlKeywordsFromSqlText'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetSqlConcurrencyControlKeywordsFromSqlText',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"SELECT~FROM~test~where~name\\",\\n \\"RequestId\\": \\"30A643F5-D7A6-55F5-AB75-DF501427****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSqlConcurrencyControlKeywordsFromSqlTextResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>SELECT~FROM~test~where~name</Data>\\n <RequestId>30A643F5-D7A6-55F5-AB75-DF501427****</RequestId>\\n <Success>true</Success>\\n</GetSqlConcurrencyControlKeywordsFromSqlTextResponse>","errorExample":""}]',
],
'GetSqlConcurrencyControlRulesHistory' => [
'summary' => '调用GetSqlConcurrencyControlRulesHistory接口,获取正在执行或被触发过的限流规则。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL和 PolarDB MySQL版实例。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '页码,取值大于0且不超过Integer数据类型的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页最大记录数,取值大于0且不超过Integer数据类型的最大值,默认值为10。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'Total' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
'List' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'rules' => [
'description' => '详细信息列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ItemId' => ['description' => '当前实例的限流规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16'],
'SqlType' => ['description' => '选择SQL的类型。取值:'."\n"
.'- **SELECT**'."\n"
.'- **UPDATE**'."\n"
.'- **DELETE**', 'type' => 'string', 'example' => 'SELECT'],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
'SqlKeywords' => ['description' => '需要限流的SQL关键词。'."\n"
.'>多个关键词间以波浪线(~)分隔,SQL语句中需要同时包含这些关键词才会触发限流规则。', 'type' => 'string', 'example' => 'call~open~api~test~4~from~POP'],
'StartTime' => ['description' => '获取限流规则历史的开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1608888296000'],
'KeywordsHash' => ['description' => '哈希值,根据输入的限流关键词计算出来的值。', 'type' => 'string', 'example' => 'b0b8aceeb43baea87b219c81767b****'],
'ConcurrencyControlTime' => ['description' => 'SQL限流的生效时长,单位为秒。'."\n"
.'>限流规则仅在生效时间内开启。', 'type' => 'integer', 'format' => 'int64', 'example' => '600'],
'UserId' => ['description' => '用户ID。', 'type' => 'string', 'example' => 'testxxx'],
'MaxConcurrency' => ['description' => 'SQL最大并发数,取值为大于或等于1的整数。'."\n"
.'>当包含关键词的SQL达到最大并发数时会触发限流策略。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Status' => ['description' => '限流规则的生效状态,取值:'."\n"
."\n"
.'- **Open**:限流规则正在生效中。'."\n"
.'- **Closed**:限流规则已执行结束。', 'type' => 'string', 'example' => 'Open'],
],
'description' => '',
],
],
],
'description' => '',
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '获取正在执行或被触发过的限流规则',
'description' => '本接口适用的数据库引擎为:'."\n"
.'- RDS MySQL'."\n"
.'- PolarDB MySQL版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlConcurrencyControlRulesHistory'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetSqlConcurrencyControlRulesHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Total\\": 4,\\n \\"List\\": {\\n \\"rules\\": [\\n {\\n \\"ItemId\\": 16,\\n \\"SqlType\\": \\"SELECT\\",\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\",\\n \\"SqlKeywords\\": \\"call~open~api~test~4~from~POP\\",\\n \\"StartTime\\": 1608888296000,\\n \\"KeywordsHash\\": \\"b0b8aceeb43baea87b219c81767b****\\",\\n \\"ConcurrencyControlTime\\": 600,\\n \\"UserId\\": \\"testxxx\\",\\n \\"MaxConcurrency\\": 2,\\n \\"Status\\": \\"Open\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSqlConcurrencyControlRulesHistoryResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Total>4</Total>\\n <List>\\n <ItemId>16</ItemId>\\n <SqlType>SELECT</SqlType>\\n <InstanceId>rm-2ze1jdv45i7l6****</InstanceId>\\n <SqlKeywords>call~open~api~test~4~from~POP</SqlKeywords>\\n <StartTime>1608888296000</StartTime>\\n <KeywordsHash>b0b8aceeb43baea87b219c81767b****</KeywordsHash>\\n <ConcurrencyControlTime>600</ConcurrencyControlTime>\\n <UserId>testxxx</UserId>\\n <MaxConcurrency>2</MaxConcurrency>\\n <Status>Open</Status>\\n </List>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetSqlConcurrencyControlRulesHistoryResponse>","errorExample":""}]',
],
'GetSqlOptimizeAdvice' => [
'summary' => '调用GetSqlOptimizeAdvice接口,查询DAS自动SQL优化产生的诊断建议。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'Engine',
'in' => 'query',
'schema' => ['description' => '数据库引擎,取值:'."\n"
."\n"
.'- **MySQL**:RDS MySQL。'."\n"
.'- **PolarDBMySQL**:PolarDB MySQL版。'."\n", 'type' => 'string', 'required' => false, 'example' => 'MySQL'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
.'>仅支持RDS MySQL、PolarDB MySQL版实例。', 'type' => 'string', 'required' => false, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'StartDt',
'in' => 'query',
'schema' => ['description' => '查询开始日期,格式:<i>yyyyMMdd</i>(UTC时间)。'."\n"
."\n"
.'- 为空时,默认为当前日期的前一天。'."\n"
.'- 只能查询当前日期前一天及之前的数据。', 'type' => 'string', 'required' => false, 'example' => '20210916'],
],
[
'name' => 'EndDt',
'in' => 'query',
'schema' => ['description' => '查询结束日期,格式:<i>yyyyMMdd</i>(UTC时间)。'."\n"
."\n"
.'- 为空时,默认为当前日期的前一天。'."\n"
.'- 只能查询当前日期前一天及之前的数据,查询开始日期和查询结束日期的间隔不能超过30天。', 'type' => 'string', 'required' => false, 'example' => '20210917'],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => ['description' => '实例所属地域,取值:'."\n"
."\n"
.'- **cn-china**:中国内地。'."\n"
.'- **cn-hongkong**:中国香港。'."\n"
.'- **ap-southeast-1**:新加坡。'."\n"
."\n"
.'此参数只有在请求参数**InstanceIds**为空时有效。如果请求参数**InstanceIds**为空时,按照**Region**参数设置的地域获取数据,系统默认实例所属地域为**cn-china**;如果请求参数**InstanceIds**不为空时,即使设置了**Region**参数,也以**InstanceIds**所传入的第一个实例所在地域为准获取数据。'."\n"
."\n"
.'> 在中国内地各地域创建的实例,传入此参数时,都为**cn-china**。', 'type' => 'string', 'required' => false, 'example' => 'cn-china'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表,包括信息总数、错误码等。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '任务运行状态:'."\n"
."\n"
.'- **INIT**:初始化。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **FINISH**:完成。'."\n"
.'- **FAILED**:失败。', 'type' => 'string', 'example' => 'FINISH'],
'StatusCode' => ['description' => '任务状态码说明:'."\n"
."\n"
.'- **NO_DATA**:没有数据。'."\n"
.'- **INTERNAL_ERROR**:内部错误。'."\n"
.'- **SUCCESS**:成功。', 'type' => 'string', 'example' => 'SUCCESS'],
'DownloadUrl' => ['description' => '文件下载的链接。', 'type' => 'string', 'example' => 'https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******'],
'CreateTime' => ['description' => '任务创建时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'string', 'example' => '1632303861000'],
'ExpireTime' => ['description' => '文件过期时间,格式为Unix时间戳,单位为毫秒。'."\n"
.'>任务创建3天后,文件过期。', 'type' => 'string', 'example' => '1632563061000'],
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '2021091710461519216****'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Status\\": \\"FINISH\\",\\n \\"StatusCode\\": \\"SUCCESS\\",\\n \\"DownloadUrl\\": \\"https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******\\",\\n \\"CreateTime\\": \\"1632303861000\\",\\n \\"ExpireTime\\": \\"1632563061000\\",\\n \\"TaskId\\": \\"2021091710461519216****\\"\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSqlOptimizeAdviceResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Status>FINISH</Status>\\n <StatusCode>SUCCESS</StatusCode>\\n <DownloadUrl>https://das-sql-optimize.oss-cn-shanghai.aliyuncs.com/adb/oss_sql_optimize_advice/1083*******</DownloadUrl>\\n <CreateTime>1632303861000</CreateTime>\\n <ExpireTime>1632563061000</ExpireTime>\\n <TaskId>2021091710461519216****</TaskId>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</GetSqlOptimizeAdviceResponse>","errorExample":""}]',
'title' => '查询自动SQL优化产生的诊断建议',
'description' => 'SQL诊断功能提供实例诊断建议,您可通过诊断建议优化实例的索引,详情请参见[自动SQL优化](~~167895~~)。'."\n"
."\n"
.'> 调用本接口只能查询由DAS自动SQL优化功能产生的诊断建议。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 数据库引擎为RDS MySQL和PolarDB MySQL版。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetSqlOptimizeAdvice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetStorageAnalysisResult' => [
'summary' => '调用GetStorageAnalysisResult接口,查询空间分析任务状态和分析结果。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '204031',
'abilityTreeNodes' => ['FEATUREhdm3TU4OK'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze1jdv45i7l6****'],
],
[
'name' => 'NodeId',
'in' => 'query',
'schema' => ['description' => '节点ID。'."\n"
."\n"
.'> 预留参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID,调用[CreateStorageAnalysisTask](~~2639140~~)接口返回的任务ID。', 'type' => 'string', 'required' => true, 'example' => '910f83f4b96df0524ddc5749f615****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '910f83f4b96df0524ddc5749f615****'],
'TaskFinish' => ['description' => '任务是否结束:'."\n"
."\n"
.'- **true**:任务结束。'."\n"
.'- **false**:任务未结束。', 'type' => 'boolean', 'example' => 'true'],
'TaskSuccess' => ['description' => '任务是否成功:'."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。'."\n"
."\n"
.'> 当任务结束时才返回该字段。', 'type' => 'boolean', 'example' => 'true'],
'TaskState' => ['description' => '空间分析任务的状态:'."\n"
."\n"
.'- **INIT**:初始化。'."\n"
.'- **PENDING**:等待执行。'."\n"
.'- **RECEIVED**:任务已选择。'."\n"
.'- **RUNNING**:任务执行中。'."\n"
.'- **RETRY**:重试任务。'."\n"
.'- **SUCCESS**:任务成功。'."\n"
.'- **FAILURE**:任务失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'TaskProgress' => ['description' => '任务进度,取值为0~100的整数。'."\n"
."\n"
.'> 例如取值为100时,表示任务进度100%。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TotalDbCount' => ['description' => '空间分析任务需要分析的数据库数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
'AnalyzedDbCount' => ['description' => '已分析结束的数据库数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'StorageAnalysisResult' => [
'description' => '空间分析详情。',
'type' => 'object',
'properties' => [
'TotalStorageSize' => ['description' => '实例总空间大小,单位为Byte。'."\n"
."\n"
.'> 当前仅支持RDS MySQL。', 'type' => 'integer', 'format' => 'int64', 'example' => '214748364800'],
'TotalUsedStorageSize' => ['description' => '已使用的空间,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '68345135104'],
'TotalFreeStorageSize' => ['description' => '剩余可用空间,单位为Byte。'."\n"
."\n"
.'> 当前仅支持RDS MySQL。', 'type' => 'integer', 'format' => 'int64', 'example' => '146403229696'],
'DailyIncrement' => ['description' => '近一周空间日均增长量估算值,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'EstimateAvailableDays' => ['description' => '剩余空间可使用天数估算值。', 'type' => 'integer', 'format' => 'int64', 'example' => '99'],
'AnalysisSuccess' => ['description' => '数据库和表空间分析是否成功。'."\n"
."\n"
.'- **true**:成功。'."\n"
.'- **false**:失败。', 'type' => 'boolean', 'example' => 'true'],
'AnalysisErrorType' => ['description' => '数据库和表空间分析任务失败类型:'."\n"
.'- **DB_OR_TABLE_NOT_EXIST**:指定的数据库或表不存在。'."\n"
.'- **DB_NOT_EXIST**:指定的数据库不存在。', 'type' => 'string', 'example' => 'DB_NOT_EXIST'],
'NeedOptimizeItemList' => [
'description' => '根据DAS默认规则生成的待优化项列表。用户也可根据自身业务情况忽略该列表中的内容,然后根据接口返回的其他基础数据自定义规则生成待优化项列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'testdb01'],
'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'test_table'],
'OptimizeItemName' => ['description' => '待优化项:'."\n"
.'- **NEED_ANALYZE_TABLE**:`information_schema.tables`中该表空间统计数据和物理文件大小差值超过50 GB。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **NEED_OPTIMIZE_TABLE**:表的碎片空间大于6 GB,并且碎片率大于30%。表的碎片率计算方式:'."\n"
.' - RDS MySQL和PolarDB MySQL版为:`DataFree/(DataSize+IndexSize+DataFree)`,本接口中即`DataFree/PhyTotalSize`。'."\n"
.' - MongoDB为:`FragmentSize/PhyTotalSize`。'."\n"
.'- **TABLE_ENGINE**:表使用的存储引擎不是InnoDB或者XEngine。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **AUTO_INCREMENT_ID_BE_TO_RUN_OUT**:表自增ID使用率超过80%。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **DUPLICATE_INDEX**:索引冗余或者重复。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **TABLE_SIZE**:单表空间大于50 GB。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **TABLE_ROWS_AND_AVG_ROW_LENGTH**:单表行数大于500万,且平均行长大于10 KB。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **TOTAL_DATA_FREE**:实例可回收空间大于60 GB,且总碎片率大于5%。'."\n"
.'- **STORAGE_USED_PERCENT**:实例空间使用率大于90%。', 'type' => 'string', 'example' => 'NEED_OPTIMIZE_TABLE'],
'OptimizeAdvice' => ['description' => '优化建议:'."\n"
.'- **NEED_ANALYZE_TABLE**:如有需要可在业务低峰时期对相关的表执行`ANALYZE TABLE`。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **NEED_OPTIMIZE_TABLE**:如有需要可在业务低峰时期进行表空间碎片回收。'."\n"
.'- **CHANGE_TABLE_ENGINE_IF_NECESSARY**:如果有需要可以在评估风险后更改表的存储引擎类型。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **AUTO_INCREMENT_ID_BE_TO_RUN_OUT**:注意自增ID使用情况。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **DUPLICATE_INDEX**:建议优化精简表上的索引。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **TABLE_SIZE**:注意表大小。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **TABLE_ROWS_AND_AVG_ROW_LENGTH**:注意表行数以及平均行长。仅适用于RDS MySQL和PolarDB MySQL版。'."\n"
.'- **STORAGE_USED_PERCENT**:注意空间使用情况,避免实例写满后锁定。', 'type' => 'string', 'example' => 'NEED_OPTIMIZE_TABLE'],
'AssociatedData' => ['description' => '待优化项关联数据,以JSON格式返回。', 'type' => 'string', 'example' => '{'."\n"
.' "autoIncrementCurrentValue": 2147483647,'."\n"
.' "autoIncrementRatio": 1,'."\n"
.' "dbName": "testdb01",'."\n"
.' "maximumValue": 2147483647,'."\n"
.' "columnName": "id",'."\n"
.' "tableName": "test_table"'."\n"
.'}'],
],
],
],
'TableStats' => [
'description' => '表空间数据列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'DbName' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'testdb01'],
'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'test_table'],
'TableType' => ['description' => '表类型。'."\n"
."\n"
.'> 该参数适用于RDS MySQL和PolarDB MySQL版。', 'type' => 'string', 'example' => 'BASE TABLE'],
'Engine' => ['description' => '表使用的存储引擎类型。'."\n"
."\n"
.'> 该参数适用于RDS MySQL和PolarDB MySQL版。', 'type' => 'string', 'example' => 'InnoDB'],
'PhysicalFileSize' => ['description' => '表物理文件大小,单位为Byte。'."\n"
.'> 该参数适用于RDS MySQL和PolarDB MySQL版。部分实例因部署形态的原因不支持获取该数据。', 'type' => 'integer', 'format' => 'int64', 'example' => '3057655808'],
'PhyTotalSize' => ['description' => '表空间大小,单位为Byte。'."\n"
.'> 对于RDS MySQL和PolarDB MySQL版,取值为**DataSize**、**IndexSize**、**DataFree**之和;对于MongoDB,取值为**DataSize**、**IndexSize**之和。', 'type' => 'integer', 'format' => 'int64', 'example' => '3012493312'],
'TotalSize' => ['description' => '- 对于RDS MySQL和PolarDB MySQL版,该参数是表数据和索引占用空间大小,单位为Byte。取值为**DataSize**、**IndexSize**之和。'."\n"
."\n"
.'- 对于MongoDB,该参数是Block Manager实际分配的空间大小,单位为Byte。MongoDB实例压缩率计算方式为:`TotalSize/DataSize`。', 'type' => 'integer', 'format' => 'int64', 'example' => '3005153280'],
'IndexSize' => ['description' => '索引占用的空间大小,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1022296064'],
'DataSize' => ['description' => '- 对于RDS MySQL和PolarDB MySQL版,该参数是数据占用的空间大小,单位为Byte。'."\n"
.'- 对于MongoDB,该参数是未压缩数据的大小,即数据量,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '1982857216'],
'DataFree' => ['description' => '碎片空间大小,单位为Byte。'."\n"
."\n"
.'> 该参数适用于RDS MySQL和PolarDB MySQL版。表碎片率计算方式一般为:`DataFree/(DataSize+IndexSize+DataFree)`,本接口中即`DataFree/PhyTotalSize`。', 'type' => 'integer', 'format' => 'int64', 'example' => '7340032'],
'TableRows' => ['description' => '表行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '12794732'],
'AvgRowLength' => ['description' => '平均行长,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '154'],
'FragmentSize' => ['description' => '可回收空间大小(碎片空间大小),单位为Byte。'."\n"
."\n"
.'> 该参数仅适用于MongoDB实例。表碎片率计算方式为:`FragmentSize/PhyTotalSize`。', 'type' => 'integer', 'format' => 'int64', 'example' => '362221568'],
],
],
],
],
],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"910f83f4b96df0524ddc5749f615****\\",\\n \\"TaskFinish\\": true,\\n \\"TaskSuccess\\": true,\\n \\"TaskState\\": \\"SUCCESS\\",\\n \\"TaskProgress\\": 100,\\n \\"TotalDbCount\\": 32,\\n \\"AnalyzedDbCount\\": 2,\\n \\"StorageAnalysisResult\\": {\\n \\"TotalStorageSize\\": 214748364800,\\n \\"TotalUsedStorageSize\\": 68345135104,\\n \\"TotalFreeStorageSize\\": 146403229696,\\n \\"DailyIncrement\\": 0,\\n \\"EstimateAvailableDays\\": 99,\\n \\"AnalysisSuccess\\": true,\\n \\"AnalysisErrorType\\": \\"DB_NOT_EXIST\\",\\n \\"NeedOptimizeItemList\\": [\\n {\\n \\"DbName\\": \\"testdb01\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"OptimizeItemName\\": \\"NEED_OPTIMIZE_TABLE\\",\\n \\"OptimizeAdvice\\": \\"NEED_OPTIMIZE_TABLE\\",\\n \\"AssociatedData\\": \\"{\\\\n \\\\\\"autoIncrementCurrentValue\\\\\\": 2147483647,\\\\n \\\\\\"autoIncrementRatio\\\\\\": 1,\\\\n \\\\\\"dbName\\\\\\": \\\\\\"testdb01\\\\\\",\\\\n \\\\\\"maximumValue\\\\\\": 2147483647,\\\\n \\\\\\"columnName\\\\\\": \\\\\\"id\\\\\\",\\\\n \\\\\\"tableName\\\\\\": \\\\\\"test_table\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"TableStats\\": [\\n {\\n \\"DbName\\": \\"testdb01\\",\\n \\"TableName\\": \\"test_table\\",\\n \\"TableType\\": \\"BASE TABLE\\",\\n \\"Engine\\": \\"InnoDB\\",\\n \\"PhysicalFileSize\\": 3057655808,\\n \\"PhyTotalSize\\": 3012493312,\\n \\"TotalSize\\": 3005153280,\\n \\"IndexSize\\": 1022296064,\\n \\"DataSize\\": 1982857216,\\n \\"DataFree\\": 7340032,\\n \\"TableRows\\": 12794732,\\n \\"AvgRowLength\\": 154,\\n \\"FragmentSize\\": 362221568\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取空间分析任务的结果',
'description' => '> 物理文件大小获取的是文件真实大小(需实例部署形态支持);表级别其他数据基于`information_schema.tables`。由于MySQL中统计信息不是实时更新,所以可能和物理文件大小存在差异,如有需要获取最新数据,可在业务低峰时期对相关的表执行`ANALYZE TABLE`。'."\n"
."\n"
.'- 本接口只适用于RDS MySQL、PolarDB MySQL版和MongoDB实例。'."\n"
.'- 对于RDS MySQL和PolarDB MySQL版实例,本接口对应于旧版空间分析功能,该接口生成的任务无法在DAS控制台新版空间分析页面查看。如有需要查看任务及结果,请调用接口后自行保存数据。'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetStorageAnalysisResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'GetYaoChiAgent' => [
'path' => '/agent',
'methods' => ['post'],
'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmROFBLE'],
],
'parameters' => [
[
'name' => 'Query',
'in' => 'query',
'schema' => ['description' => '问答自然语言描述', 'type' => 'string', 'required' => true, 'example' => 'Are there any issues or abnormalities with my instance rm-xxx?'],
],
[
'name' => 'SessionId',
'in' => 'query',
'schema' => ['description' => '可选,会话Id,格式为UUID字符串。'."\n"
.'未传入会创建新的会话,上下文对话需保持同一个会话Id', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-xxxxxxxxxxxx'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => [
'description' => '非必填,云产品来源,指定问答所属的云产品,未填写默认为yaochi',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['tair' => 'tair', 'dbs' => 'dbs', 'polardb-ai' => 'polardb-ai', 'polarx' => 'polarx', 'yaochi' => 'yaochi', 'polarx-light' => 'polarx-light', 'lindorm' => 'lindorm', 'mongodb' => 'mongodb', 'polardb' => 'polardb'],
'example' => 'yaochi',
],
],
[
'name' => 'ExtraInfo',
'in' => 'query',
'schema' => ['description' => '非必填,附加信息,json字符串', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
[
'name' => 'ImageKeys',
'in' => 'query',
'schema' => ['type' => 'string'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Content' => ['title' => 'Id of the request', 'description' => '回答内容', 'type' => 'string', 'example' => 'xxx'],
'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '7172BECE-588A-5961-8126-C216E16B****'],
'ReasoningContent' => ['description' => '模型思维内容', 'type' => 'string', 'example' => 'xxx'],
'Product' => ['description' => '云产品类型', 'type' => 'string', 'example' => 'polardb'],
'FunctionCall' => [
'description' => '工具调用列表',
'type' => 'array',
'items' => [
'description' => '字符串列表',
'type' => 'object',
'properties' => [
'Name' => ['description' => '调用工具名称', 'type' => 'string', 'example' => 'sqlReview'],
'Arguments' => ['description' => '调用工具参数', 'type' => 'string', 'example' => '{"arg": "xxx"}'],
'Id' => ['description' => '工具ID', 'type' => 'string', 'example' => '12345'],
'Status' => ['description' => '工具调用状态', 'type' => 'string', 'example' => 'RUNNING'],
],
],
],
'UiFunctionCall' => [
'description' => '卡片工具调用列表',
'type' => 'array',
'items' => [
'description' => '字符串列表',
'type' => 'object',
'properties' => [
'ArgsText' => ['description' => '卡片工具参数', 'type' => 'string', 'example' => '{"arg": "xxx"}'],
'ToolName' => ['description' => '卡片工具名称', 'type' => 'string', 'example' => 'card'],
],
],
],
'SessionId' => ['description' => 'SessionId, 同请求参数中的 SessionId', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-xxxxxxxxxxxx'],
'QueryId' => ['description' => 'QueryId, 同请求参数中的 QueryId', 'type' => 'string', 'example' => '123e4567-e89b-12d3-a456-xxxxxxxxxxxx'],
'SubAgentCall' => [
'description' => '子Agent调用信息列表',
'type' => 'array',
'items' => [
'description' => '字符串列表',
'type' => 'object',
'properties' => [
'SubAgentId' => ['description' => '子AgentID', 'type' => 'string', 'example' => '12345'],
'SubAgentName' => ['description' => '子Agent名称', 'type' => 'string', 'example' => 'XX Agent'],
'Status' => ['description' => '子Agent状态', 'type' => 'string', 'example' => 'running'],
],
],
],
'ParentId' => ['description' => '仅当消息为子Agent输出时,存在ParentId字段,且值为子AgentID', 'type' => 'string', 'example' => '12345'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '瑶池Agent大模型能力接口',
'summary' => '瑶池Agent大模型能力接口,可以进行知识问答,性能诊断等功能',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetYaoChiAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Content\\": \\"xxx\\",\\n \\"RequestId\\": \\"7172BECE-588A-5961-8126-C216E16B****\\",\\n \\"ReasoningContent\\": \\"xxx\\",\\n \\"Product\\": \\"polardb\\",\\n \\"FunctionCall\\": [\\n {\\n \\"Name\\": \\"sqlReview\\",\\n \\"Arguments\\": \\"{\\\\\\"arg\\\\\\": \\\\\\"xxx\\\\\\"}\\",\\n \\"Id\\": \\"12345\\",\\n \\"Status\\": \\"RUNNING\\"\\n }\\n ],\\n \\"UiFunctionCall\\": [\\n {\\n \\"ArgsText\\": \\"{\\\\\\"arg\\\\\\": \\\\\\"xxx\\\\\\"}\\",\\n \\"ToolName\\": \\"card\\"\\n }\\n ],\\n \\"SessionId\\": \\"123e4567-e89b-12d3-a456-xxxxxxxxxxxx\\",\\n \\"QueryId\\": \\"123e4567-e89b-12d3-a456-xxxxxxxxxxxx\\",\\n \\"SubAgentCall\\": [\\n {\\n \\"SubAgentId\\": \\"12345\\",\\n \\"SubAgentName\\": \\"XX Agent\\",\\n \\"Status\\": \\"running\\"\\n }\\n ],\\n \\"ParentId\\": \\"12345\\"\\n}","type":"json"}]',
],
'KillInstanceAllSession' => [
'summary' => '调用KillInstanceAllSession接口,结束指定实例上的全部会话。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'r-8vbcyr4sw0c4yc****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => ['description' => '备用参数。', 'type' => 'string', 'example' => 'None'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": \\"None\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<KillInstanceAllSessionResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</KillInstanceAllSessionResponse>","errorExample":""}]',
'title' => '结束全部会话',
'description' => '- 本接口只适用于Redis引擎。'."\n"
.'- 在使用阿里云SDK时,需要保证aliyun-sdk-core的版本大于4.3.3,建议使用最新版本。'."\n"
.'- 使用DAS的SDK的版本为1.0.2或以上。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:KillInstanceAllSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'ModifyAutoScalingConfig' => [
'summary' => '调用ModifyAutoScalingConfig接口,修改实例弹性伸缩功能配置。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'Spec',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '规格弹性伸缩功能配置项。',
'type' => 'object',
'properties' => [
'Apply' => ['description' => '是否应用规格弹性伸缩功能配置项**Spec**下的配置:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'Upgrade' => ['description' => '是否开启规格自动扩容:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'CpuUsageUpperThreshold' => [
'description' => '触发规格自动扩容的CPU平均利用率阈值,单位为%,取值:'."\n"
."\n"
.'- **50**'."\n"
.'- **60**'."\n"
.'- **70**'."\n"
.'- **80**'."\n"
.'- **90**'."\n"
."\n"
.'><notice>目标数据库实例为PolarDB MySQL版的集群版、RDS MySQL高可用系列云盘版时,需要设置本参数。'."\n"
.'></notice>',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '70',
'enum' => ['50', '60', '70', '80', '90'],
],
'MemUsageUpperThreshold' => [
'description' => '触发规格自动扩容的内存平均利用率阈值,单位为%,取值:'."\n"
.'- **50**'."\n"
.'- **60**'."\n"
.'- **70**'."\n"
.'- **80**'."\n"
.'- **90**'."\n"
."\n"
.'><notice>目标数据库实例为中国站Redis云原生(原云盘)开源版时,需要设置本参数。'."\n"
.'></notice>',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '70',
'enum' => ['50', '60', '70', '80', '90'],
],
'MaxSpec' => ['description' => '自动扩容的规格上限。仅支持扩容到数据库实例同系列的更高规格,详情请参见各数据库实例的产品规格文档:'."\n"
.'<props="china">'."\n"
."\n"
.'- PolarDB MySQL版的集群版请参见[计算节点规格](~~102542~~)。'."\n"
.'- RDS MySQL高可用系列云盘版请参见[产品规格](~~276974~~)。'."\n"
.'- Redis云原生(原云盘)开源版请参见[实例规格](~~144986~~)。'."\n"
."\n"
.'</props>'."\n"
."\n"
.'<props="intl">'."\n"
."\n"
.'- PolarDB MySQL版的集群版请参见[计算节点规格](~~102542~~)。'."\n"
.'- RDS MySQL高可用系列云盘版请参见[产品规格](~~276974~~)。'."\n"
."\n"
.'</props>', 'type' => 'string', 'required' => false, 'example' => 'polar.mysql.x8.12xlarge'."\n"],
'MaxReadOnlyNodes' => ['description' => '实例只读节点数的最大值。'."\n"
."\n"
.'><notice>目标数据库实例为PolarDB MySQL版的集群版时,需要设置本参数。'."\n"
.'></notice>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '15', 'minimum' => '1', 'example' => '10'],
'ObservationWindowSize' => ['description' => '观测窗口。参数值由数值和时间单位后缀组成,支持的数据库实例及其取值如下,其中时间后缀**m**表示分钟,**h**表示小时:'."\n"
."\n"
.'- PolarDB MySQL版的集群版:**5m**、**10m**、**15m**、**30m**。'."\n"
.'- RDS MySQL高可用系列云盘版:**5m**、**20m**、**30m**、**40m**、**1h**。'."\n"
.'- Redis云原生(原云盘)开源版:**5m**、**10m**、**15m**、**30m**。', 'type' => 'string', 'required' => false, 'example' => '5m'],
'CoolDownTime' => ['description' => '静默期。参数值由数值和时间单位后缀组成,支持的数据库实例及其取值如下,其中时间单位后缀**m**表示分钟,**h**表示小时,**d**:表示天:'."\n"
."\n"
.'- PolarDB MySQL版的集群版:**5m**、**10m**、**30m**、**1h**、**2h**、**3h**、**1d**、**7d**。'."\n"
.'- RDS MySQL高可用系列云盘版:**5m**、**10m**、**30m**、**1h**、**2h**、**3h**、**1d**、**7d**。', 'type' => 'string', 'required' => false, 'example' => '5m'],
'Downgrade' => ['description' => '是否开启规格自动回缩:'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'><notice>目标数据库实例为PolarDB MySQL版的集群版、RDS MySQL高可用系列云盘版时,需要设置本参数。'."\n"
.'></notice>', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
],
'required' => false,
],
],
[
'name' => 'Storage',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '存储自动扩容功能配置项。',
'type' => 'object',
'properties' => [
'Apply' => ['description' => '是否应用存储自动扩容功能配置项**Storage**下的配置:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'Upgrade' => ['description' => '是否开启存储自动扩容:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'DiskUsageUpperThreshold' => [
'description' => '触发存储自动扩容的存储空间平均利用率阈值,单位为%,取值:'."\n"
.'- **50**'."\n"
.'- **60**'."\n"
.'- **70**'."\n"
.'- **80**'."\n"
.'- **90**',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '70',
'enum' => ['50', '60', '70', '80', '90'],
],
'MaxStorage' => ['description' => '存储空间上限,需要大于等于实例当前存储空间总大小,取值:'."\n"
."\n"
.'- ESSD云盘上限:32000 GB。'."\n"
.'- SSD云盘上限:6000 GB。'."\n"
."\n"
.'> SSD云盘已下线,建议[升级至ESSD云盘](~~314678~~)。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '32000', 'minimum' => '20', 'example' => '32000'],
],
'required' => false,
],
],
[
'name' => 'Bandwidth',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '带宽弹性伸缩功能配置项。',
'type' => 'object',
'properties' => [
'Apply' => ['description' => '是否应用带宽弹性伸缩功能配置项**Bandwidth**下的配置:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'Upgrade' => ['description' => '是否开启带宽自动扩展:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'BandwidthUsageUpperThreshold' => [
'description' => '触发带宽自动扩展的带宽平均使用率阈值,单位为%,取值:'."\n"
."\n"
.'- **50**'."\n"
.'- **60**'."\n"
.'- **70**'."\n"
.'- **80**'."\n"
.'- **90**'."\n"
.'- **95**',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '95',
'minimum' => '50',
'example' => '70',
'enum' => [],
],
'ObservationWindowSize' => [
'description' => '带宽自动扩展的观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀**m**表示分钟:'."\n"
."\n"
.'- **1m**'."\n"
.'- **5m**'."\n"
.'- **10m**'."\n"
.'- **15m**'."\n"
.'- **30m**',
'type' => 'string',
'required' => false,
'example' => '5m',
'enum' => ['1m', '5m', '10m', '15m', '30m'],
],
'Downgrade' => ['description' => '是否开启带宽自动回缩:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'BandwidthUsageLowerThreshold' => [
'description' => '触发带宽自动回缩的带宽平均使用率阈值,单位为%,取值:'."\n"
."\n"
.'- **10**'."\n"
.'- **20**'."\n"
.'- **30**',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'maximum' => '70',
'minimum' => '10',
'example' => '30',
'enum' => [],
],
],
'required' => false,
],
],
[
'name' => 'Shard',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '分片弹性伸缩功能配置项。',
'type' => 'object',
'properties' => [
'Apply' => ['description' => '是否应用分片弹性伸缩功能配置项**Shard**下的配置:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'><notice>仅当目标数据库实例为中国站Redis云原生(原云盘)版集群架构时,支持分片弹性伸缩功能。'."\n"
.'></notice>', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'Upgrade' => ['description' => '是否开启自动增加分片:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'MemUsageUpperThreshold' => [
'description' => '触发自动增加分片的内存平均利用率阈值,单位为%,取值:'."\n"
."\n"
.'- **50**'."\n"
.'- **60**'."\n"
.'- **70**'."\n"
.'- **80**'."\n"
.'- **90**',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '70',
'enum' => ['50', '60', '70', '80', '90'],
],
'MaxShards' => ['description' => '实例总分片数的最大值, 取值为正整数,取值范围:4~32。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '2', 'example' => '16'],
'UpgradeObservationWindowSize' => [
'description' => '自动增加分片观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀**m**表示分钟:'."\n"
."\n"
.'- **5m**'."\n"
.'- **10m**'."\n"
.'- **15m**'."\n"
.'- **30m**'."\n",
'type' => 'string',
'required' => false,
'example' => '5m',
'enum' => ['5m', '10m', '15m', '30m'],
],
'Downgrade' => ['description' => '自动减少分片是否开启:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'>自动减少分片功能目前在灰度发布中。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'MemUsageLowerThreshold' => [
'description' => '触发自动减少分片的内存平均利用率阈值,单位为%,取值:'."\n"
."\n"
.'- **10**'."\n"
.'- **20**'."\n"
.'- **30**',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '30',
'enum' => ['10', '20', '30'],
],
'MinShards' => ['description' => '实例总分片数的最小值,取值为正整数,取值范围:4~32。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '2', 'example' => '4'],
'DowngradeObservationWindowSize' => [
'description' => '自动减少分片观测窗口,参数由数值和时间单位后缀组成,其中时间单位后缀**h**表示小时,**d**表示天:'."\n"
."\n"
.'- **1h**'."\n"
.'- **2h**'."\n"
.'- **3h**'."\n"
.'- **1d**'."\n"
.'- **7d**',
'type' => 'string',
'required' => false,
'example' => '1h',
'enum' => ['1h', '2h', '3h', '1d', '7d'],
],
],
'required' => false,
],
],
[
'name' => 'Resource',
'in' => 'query',
'style' => 'flat',
'schema' => [
'description' => '资源弹性伸缩功能配置项。',
'type' => 'object',
'properties' => [
'Apply' => ['description' => '是否应用资源弹性伸缩功能配置项**Resource**下的配置:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'Enable' => ['description' => '是否开启资源弹性伸缩:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false'],
'CpuUsageUpperThreshold' => [
'description' => '触发资源自动扩容的CPU平均利用率阈值,单位为%,取值:'."\n"
."\n"
.'- **70**'."\n"
.'- **80**'."\n"
.'- **90**',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '70',
'enum' => ['70', '80', '90'],
],
'UpgradeObservationWindowSize' => [
'description' => '扩容观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀**m**表示分钟:'."\n"
."\n"
.'- **1m**'."\n"
.'- **3m**'."\n"
.'- **5m**'."\n"
.'- **10m**'."\n"
.'- **20m**'."\n"
.'- **30m**',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['30m' => '30m', '5m' => '5m', '3m' => '3m', '1m' => '1m', '10m' => '10m', '20m' => '20m'],
'example' => '5m',
'enum' => ['1m', '3m', '5m', '10m', '20m', '30m'],
],
'DowngradeObservationWindowSize' => [
'description' => '缩容观测窗口。参数值由数值和时间单位后缀组成,其中时间单位后缀**m**表示分钟:'."\n"
."\n"
.'- **1m**'."\n"
.'- **3m**'."\n"
.'- **5m**'."\n"
.'- **10m**'."\n"
.'- **20m**'."\n"
.'- **30m**',
'type' => 'string',
'required' => false,
'example' => '5m',
'enum' => ['1m', '3m', '5m', '10m', '20m', '30m'],
],
],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '修改实例弹性伸缩功能配置',
'description' => '<props="china">API支持修改数据库实例的**规格弹性伸缩**功能、**存储自动扩容**功能、**带宽弹性伸缩**功能、**分片弹性伸缩**功能以及**资源弹性伸缩**功能:</props>'."\n"
.'<props="intl">API支持修改数据库实例的**规格弹性伸缩**功能、**存储自动扩容**功能、**带宽弹性伸缩**功能以及**资源弹性伸缩**功能:</props>'."\n"
.'<props="china">'."\n"
."\n"
.'- 以下目标数据库实例支持修改**规格弹性伸缩**功能:'."\n"
.' - PolarDB MySQL版的集群版,功能介绍及费用说明参见[自动性能扩展](~~169686~~)。'."\n"
.' - RDS MySQL高可用系列云盘版,功能介绍及费用说明参见[自动性能扩展](~~169686~~)。'."\n"
.' - Redis云原生(原云盘)开源版,功能介绍及费用说明参见[开启自动扩容](~~208236~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**存储自动扩容**功能:'."\n"
.' - RDS MySQL高可用系列云盘实例,功能介绍及费用说明参见[自动空间扩展](~~173345~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**带宽弹性伸缩**功能:'."\n"
.' - Redis经典(原本地盘)实例,功能介绍及费用说明参见[自动调整带宽](~~216312~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**分片弹性伸缩**功能:'."\n"
.' - Redis云原生(原云盘)开源版集群架构,功能介绍及费用说明参见[自动增加分片](~~358868~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**资源弹性伸缩**功能:'."\n"
.' - RDS MySQL高可用系列本地盘版(通用型)和三节点企业系列(通用型),功能介绍及费用说明参见[自动性能扩展](~~169686~~)。'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'</props>'."\n"
."\n"
.'<props="intl">'."\n"
."\n"
.'- 以下目标数据库实例支持修改**规格弹性伸缩**功能:'."\n"
.' - PolarDB MySQL版的集群版,功能介绍及费用说明参见[自动性能扩展](~~169686~~)。'."\n"
.' - RDS MySQL高可用系列云盘版,功能介绍及费用说明参见[自动性能扩展](~~169686~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**存储自动扩容**功能:'."\n"
.' - RDS MySQL高可用系列云盘实例,功能介绍及费用说明参见[自动空间扩展](~~173345~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**带宽弹性伸缩**功能:'."\n"
.' - Redis经典(原本地盘)实例,功能介绍及费用说明参见[自动调整带宽](~~216312~~)。'."\n"
."\n"
.'- 以下目标数据库实例支持修改**资源弹性伸缩**功能:'."\n"
.' - RDS MySQL三节点企业系列(通用型),功能介绍及费用说明参见[自动性能扩展](~~169686~~)。'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'</props>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAutoScalingConfig'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifyAutoScalingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ModifyAutoScalingConfigResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</ModifyAutoScalingConfigResponse>","errorExample":""}]',
],
'ModifySecurityIPGroup' => [
'summary' => '修改用户跨产品白名单模板',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247410',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'GlobalIgName',
'in' => 'query',
'schema' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求:'."\n"
.'- 由小写字母、数字、下划线(_)组成。'."\n"
.'- 由字母开头、字母或数字结尾。'."\n"
.'- 长度为2~120个字符。'."\n"
.'> 本参数将覆盖原值。', 'type' => 'string', 'required' => true, 'example' => 'test_123'],
],
[
'name' => 'GIpList',
'in' => 'query',
'schema' => ['description' => '白名单模板内的IP地址。'."\n"
."\n"
.'> 多个IP地址需要用英文逗号隔开,所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'required' => true, 'example' => '192.168.0.1'],
],
[
'name' => 'GlobalSecurityGroupId',
'in' => 'query',
'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-9ubyrqeoko****,g-pdxlrvn13k****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'ListResult<InstanceSSL>',
'description' => 'ListResult<InstanceSSL>',
'type' => 'object',
'properties' => [
'GlobalSecurityIPGroup' => [
'description' => '跨产品白名单模板信息。',
'type' => 'array',
'items' => [
'description' => '跨产品白名单模板信息。',
'type' => 'object',
'properties' => [
'SecurityIpType' => ['description' => 'ip类型', 'type' => 'string', 'example' => 'ipv4'],
'RegionId' => ['description' => '地域 ID。'."\n"
."\n"
.'示例值:'."\n"
.'cn-hangzhou', 'type' => 'string', 'example' => 'cn-beijing'],
'GlobalIgName' => ['description' => 'IP白名单模板名称。', 'type' => 'string', 'example' => 'test'],
'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-b1asblm5ae****'],
'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'],
'GIpList' => ['description' => '白名单模板内的IP地址。'."\n"
."\n"
.'> 多个IP地址需要用英文逗号隔开,所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1'],
],
],
],
],
],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* **true**:执行成功'."\n"
.'* **false**:执行失败'."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'description' => '使用该接口需满足以下前提条件:'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 使用该接口默认开启当前支持的最新版本。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。',
'title' => '跨产品白名单模板修改接口',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifySecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"GlobalSecurityIPGroup\\": [\\n {\\n \\"SecurityIpType\\": \\"ipv4\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"GlobalIgName\\": \\"test\\",\\n \\"GlobalSecurityGroupId\\": \\"g-b1asblm5ae****\\",\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"GIpList\\": \\"192.168.0.1\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'ModifySecurityIPGroupRelation' => [
'summary' => '绑定/解绑用户跨产品白名单模板',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '247410',
'abilityTreeNodes' => ['FEATUREhdmQULC0I'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionName',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'pc-bp1u5mas9exx7****'],
],
[
'name' => 'GlobalSecurityGroupId',
'in' => 'query',
'schema' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => 'g-ggh7qvrrwikyxe****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => 'ListResult<InstanceSSL>',
'description' => 'ListResult<InstanceSSL>',
'type' => 'object',
'properties' => [
'GlobalSecurityIPGroupRel' => [
'description' => '跨产品IP白名单模板绑定信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => '地域 ID。', 'type' => 'string', 'example' => 'cn-shanghai'],
'GlobalIgName' => ['description' => 'IP白名单模板名称。IP白名单模板名称需满足如下要求:'."\n"
."\n"
.'- 由小写字母、数字、下划线(_)组成。'."\n"
."\n"
.'- 由字母开头、字母或数字结尾。'."\n"
."\n"
.'- 长度为2~120个字符。', 'type' => 'string', 'example' => 'saas_jump'],
'GlobalSecurityGroupId' => ['description' => 'IP白名单模板ID。', 'type' => 'string', 'example' => 'g-v8kwereyd6u7kx****'],
'GIpList' => ['description' => '白名单模板内的IP地址。'."\n"
."\n"
.'> 多个IP地址需要用英文逗号隔开,所有IP白名单累积支持添加1000个IP地址或地址段。', 'type' => 'string', 'example' => '192.168.0.1,192.168.100.0/24'],
],
'description' => '',
],
],
'InstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze1jdv45i7l6****'],
],
],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回Successful,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '840F51F7-9C01-538D-94F6-AE712905****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
.'* true:执行成功'."\n"
.'* false:执行失败'."\n", 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'description' => '- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 目前支持的数据库实例请参见SQL洞察和审计的[功能概览](~~92561~~)。'."\n"
.'- 目标数据库实例已开启SQL洞察和审计(旧版)功能,开启方法请参见[开启SQL洞察和审计](~~92561~~)。',
'title' => '跨产品白名单模板绑定/解绑接口',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifySecurityIPGroupRelation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"GlobalSecurityIPGroupRel\\": [\\n {\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"GlobalIgName\\": \\"saas_jump\\",\\n \\"GlobalSecurityGroupId\\": \\"g-v8kwereyd6u7kx****\\",\\n \\"GIpList\\": \\"192.168.0.1,192.168.100.0/24\\"\\n }\\n ],\\n \\"InstanceId\\": \\"rm-2ze1jdv45i7l6****\\"\\n },\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"840F51F7-9C01-538D-94F6-AE712905****\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
],
'ModifySqlLogConfig' => [
'summary' => '调用ModifySqlLogConfig接口,为数据库实例开启或配置DAS企业版。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '198880',
'abilityTreeNodes' => ['FEATUREhdmPGXCEW', 'FEATUREhdmFT57I0'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'formData',
'schema' => ['description' => '数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rr-2ze770smbq3tp****'],
],
[
'name' => 'Enable',
'in' => 'formData',
'schema' => ['description' => '是否开启DAS企业版:'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
.'> 开通企业版时必须配置,默认开启当前支持的最新版本。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'RequestEnable',
'in' => 'formData',
'schema' => ['description' => '是否开启SQL洞察。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。'."\n"
."\n"
.'> 仅支持开通企业版 V3时,需要配置该参数。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'Retention',
'in' => 'formData',
'schema' => ['description' => '数据总存储时长,单位为天,取值为:'."\n"
."\n"
.'- 7'."\n"
.'- 30'."\n"
.'- 180'."\n"
.'- 365'."\n"
."\n"
.'> 开通DAS企业版 V3时,该参数取值必须大于等于30。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'],
],
[
'name' => 'HotRetention',
'in' => 'formData',
'schema' => ['description' => '数据热存储时长,单位为天,取值为[1, 7]范围内的整数。'."\n"
."\n"
.'> 仅支持开通企业版 V3时,需要配置该参数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'Filters',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '预留参数。',
'type' => 'array',
'items' => [
'description' => '预留参数。',
'type' => 'object',
'properties' => [
'Key' => ['description' => '预留参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
'Value' => ['description' => '预留参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
'required' => false,
],
'required' => false,
'maxItems' => 100,
],
],
[
'name' => 'EnableAudit',
'in' => 'query',
'schema' => ['description' => '开启安全审计。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '03C88D8E-1541-518E-8BFF-BEC6589B6334'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'false'],
'Data' => [
'title' => 'SqlLogConfig',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'SqlLogVisibleTime' => ['description' => 'DAS企业版开启的时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'RequestStopTime' => ['description' => 'DAS企业版V1到期时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1715335200000'],
'CollectorVersion' => ['description' => '采集器版本。'."\n"
.'- **MYSQL_V0**:MySQL V0版。'."\n"
.'- **MYSQL_V1**:MySQL V1版。'."\n"
.'- **MYSQL_V2**:MySQL V2版。'."\n"
.'- **MYSQL_V3**:MySQL V3版。'."\n"
.'- **PG_V1**:PostgreSQL V1版。'."\n"
.'- **rdspg_v1**:RDS PostgreSQL V1版。'."\n"
.'- **polarpg_v1**:PolarDB PostgreSQL版 V1版。', 'type' => 'string', 'example' => 'MYSQL_V3'],
'SupportVersion' => ['title' => '当前实例支持的数据库版本(不落库)', 'description' => '当前支持的最新DAS企业版版本。'."\n"
."\n"
.'- **SQL_LOG_V0**:企业版 V0。'."\n"
.'- **SQL_LOG_V1**:企业版 V1。'."\n"
.'- **SQL_LOG_V2**:企业版 V2。'."\n"
.'- **SQL_LOG_V3**:企业版 V3。'."\n"
.'- **SQL_LOG_NOT_ENABLE**:未开启企业版。'."\n"
.'- **SQL_LOG_NOT_SUPPORT**: 不支持企业版。', 'type' => 'string', 'example' => 'SQL_LOG_V3'],
'ColdRetention' => ['title' => '冷数据存储周期(不落库),通过 retention - hotRetention 计算', 'description' => '数据冷存储时长,单位为天,由` Retention - HotRetention` 计算获得。', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
'SqlLogEnable' => ['description' => '是否开启了DAS企业版。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Retention' => ['description' => '数据总存储时长,单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'HotRetention' => ['description' => '数据热存储时长,单位为天。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'RequestEnable' => ['description' => '是否开启SQL洞察。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'Version' => ['title' => '当前审计日志的版本', 'description' => '当前开启的DAS企业版版本。'."\n"
."\n"
.'- **SQL_LOG_V0**:企业版 V0。'."\n"
.'- **SQL_LOG_V1**:企业版 V1。'."\n"
.'- **SQL_LOG_V2**:企业版 V2。'."\n"
.'- **SQL_LOG_V3**:企业版 V3。'."\n"
.'- **SQL_LOG_NOT_ENABLE**:未开启企业版。'."\n"
.'- **SQL_LOG_NOT_SUPPORT**: 不支持企业版。', 'type' => 'string', 'example' => 'SQL_LOG_V3'],
'RequestStartTime' => ['description' => 'SQL洞察开启时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'HotEnable' => ['description' => '是否开启数据热存储。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'HotStartTime' => ['description' => '数据热存储开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'ColdEnable' => ['description' => '是否开启数据冷存储。'."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'ColdStartTime' => ['description' => '数据冷存储开始时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1683712800000'],
'SqlLogState' => ['description' => '数据迁移状态。'."\n"
."\n"
.'- **FINISH**: 历史数据迁移完成。'."\n"
.'- **RUNNING**: 历史数据迁移中。'."\n"
.'- **FAILURE**: 历史数据迁移失败。', 'type' => 'string', 'example' => 'FINISH'],
'LogFilter' => ['description' => '预留参数。', 'type' => 'string', 'example' => 'None'],
'SqlLogSource' => ['title' => '开启审计日志来源', 'description' => '开启审计日志来源', 'type' => 'string'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"03C88D8E-1541-518E-8BFF-BEC6589B6334\\",\\n \\"Success\\": \\"false\\",\\n \\"Data\\": {\\n \\"SqlLogVisibleTime\\": 1683712800000,\\n \\"RequestStopTime\\": 1715335200000,\\n \\"CollectorVersion\\": \\"MYSQL_V3\\",\\n \\"SupportVersion\\": \\"SQL_LOG_V3\\",\\n \\"ColdRetention\\": 23,\\n \\"SqlLogEnable\\": true,\\n \\"Retention\\": 30,\\n \\"HotRetention\\": 7,\\n \\"RequestEnable\\": false,\\n \\"Version\\": \\"SQL_LOG_V3\\",\\n \\"RequestStartTime\\": 1683712800000,\\n \\"HotEnable\\": true,\\n \\"HotStartTime\\": 1683712800000,\\n \\"ColdEnable\\": true,\\n \\"ColdStartTime\\": 1683712800000,\\n \\"SqlLogState\\": \\"FINISH\\",\\n \\"LogFilter\\": \\"None\\",\\n \\"SqlLogSource\\": \\"\\"\\n }\\n}","type":"json"}]',
'title' => '开启或配置DAS企业版',
'description' => '使用该接口需满足以下前提条件:'."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 使用该接口默认开启当前支持的最新版本。DAS企业版各个版本支持的数据库和地域请参见[DAS产品系列及支持的功能](~~156204~~)。',
'requestParamsDescription' => 'DAS企业版当前存在V0、V1、V2、V3四个版本,默认开通当前支持的最新版本。'."\n"
."\n"
.'- 对于仅支持开启企业版 V0的数据库实例,仅需传入参数**Enable**和**Retention**。'."\n"
.'- 对于支持开启企业版 V1的数据库实例,仅需传入参数**Enable**和**Retention**,系统自动开启SQL洞察功能(即**RequestEnable**默认配置为**true**)。'."\n"
.'- 对于支持开启企业版 V2的数据库实例,仅需传入参数**Enable**和**Retention**,系统自动开启SQL洞察功能(即**RequestEnable**默认配置为**true**),且数据热存储时长(**HotRetention**)固定为7天,数据冷存储时长为`Retention - 7`天。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySqlLogConfig'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifySqlLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'RunCloudBenchTask' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID,您可通过[DescribeCloudBenchTasks](~~230670~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => 'e5cec704-0518-430f-8263-76f4dcds****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'PreCheckItem' => [
'description' => '详细信息列表,包括信息的总数、错误码等。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Status' => ['description' => '任务的运行状态。取值:'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
.'- **IGNORED**:忽略。'."\n"
.'- **RUNNING**:运行中。'."\n"
.'- **EXCEPTION**:异常。', 'type' => 'string', 'example' => 'SUCCESS'],
'Order' => ['description' => '检查项的顺序,取值范围:**0**~**10**。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Name' => ['description' => '检查项。取值:'."\n"
."\n"
.'- **SqlArchiveStatusChecker**:检查SQL洞察数据是否可用。'."\n"
.'- **BenchClientEnvChecker**:检查压测机上程序运行环境是否可用。'."\n"
.'- **SpecChecker**:检查压测目标规格和压测机规格是否可用。'."\n"
.'- **SourceInstanceChecker**:检查压测源实例账号和网络是否可用。'."\n"
.'- **BenchTargetChecker**:检查压测目标实例账号和网络是否可用。', 'type' => 'string', 'example' => 'BenchTargetChecker'],
'Details' => ['description' => '检查项的详细信息。', 'type' => 'string', 'example' => '"Data": { "total": 1, "list":[...] }, "Code": 200, "Success": true }'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '执行压测任务',
'summary' => '调用RunCloudBenchTask接口,执行压测任务。',
'description' => '数据库自治服务DAS提供智能压测功能,帮助您验证您的实例规格是否需要扩容,有效应对业务流量高峰。更多信息,请参见[智能压测](~~155068~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunCloudBenchTask'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:RunCloudBenchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"PreCheckItem\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Order\\": 0,\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Name\\": \\"BenchTargetChecker\\",\\n \\"Details\\": \\"\\\\\\"Data\\\\\\": { \\\\\\"total\\\\\\": 1, \\\\\\"list\\\\\\":[...] }, \\\\\\"Code\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<RunCloudBenchTaskResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <Status>SUCCESS</Status>\\n <Order>0</Order>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Name>BenchTarget</Name>\\n <Details>\\"Data\\": { \\"total\\": 1, \\"list\\":[...] }, \\"Code\\": 200, \\"Success\\": true }</Details>\\n </Data>\\n</RunCloudBenchTaskResponse>","errorExample":""}]',
],
'SetEventSubscription' => [
'summary' => '调用SetEventSubscription接口,配置数据库实例的事件订阅设置。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmETIPZF'],
],
'parameters' => [
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-2ze8g2am97624****'],
],
[
'name' => 'EventContext',
'in' => 'query',
'schema' => [
'title' => '事件场景',
'description' => '支持的事件场景,当前仅支持**AllContext**,表示支持所有场景。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'AllContext',
],
],
[
'name' => 'Lang',
'in' => 'query',
'schema' => [
'title' => '语言',
'description' => '事件通知的语言,当前仅支持**zh-CN**,表示事件通知为中文。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'zh-CN',
],
],
[
'name' => 'MinInterval',
'in' => 'query',
'schema' => ['title' => '通知最小间隔', 'description' => '通知最小间隔时间,单位为秒(s)。', 'type' => 'string', 'required' => false, 'example' => '60'],
],
[
'name' => 'ContactName',
'in' => 'query',
'schema' => ['title' => '告警订阅人', 'description' => '告警事件订阅人名称,多个名称间以英文逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'Default contact'],
],
[
'name' => 'ChannelType',
'in' => 'query',
'schema' => [
'title' => '通知方式',
'description' => '通知方式。'."\n"
.'- **hdm\\_alarm\\_sms**:手机短信。'."\n"
.'- **dingtalk**:钉钉机器人。'."\n"
.'- **hdm\\_alarm\\_sms\\_and\\_email**:手机短信+邮件。'."\n"
.'- **hdm\\_alarm\\_sms,dingtalk**:手机短信+钉钉机器人。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'hdm_alarm_sms,dingtalk',
],
],
[
'name' => 'ContactGroupName',
'in' => 'query',
'schema' => ['title' => '告警订阅组', 'description' => '告警事件订阅组名称,多个名称以英文逗号分隔。', 'type' => 'string', 'required' => false, 'example' => 'Default contact group'],
],
[
'name' => 'Level',
'in' => 'query',
'schema' => [
'title' => '事件风险级别',
'description' => '需要进行通知的事件级别,取值:'."\n"
.'- **Notice**:通知(包含**Notice**、**Optimization**、**Warn**和**Critical**级别的事件)。'."\n"
.'- **Optimization**:优化(包含**Optimization**、**Warn**和**Critical**级别的事件)。'."\n"
.'- **Warn**:警告(包含**Warn**和**Critical**级别的事件)。'."\n"
.'- **Critical**:严重(仅包含**Critical**级别的事件)。'."\n"
."\n"
.'各个级别事件的含义如下:'."\n"
."\n"
.'- 通知:暂无建议的数据库异常事件。'."\n"
.'- 优化:根据数据库运行情况给出优化建议的事件。'."\n"
.'- 警告:需要关注的可能会影响数据库的事件。'."\n"
.'- 严重:影响数据库运行的事件。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => 'Optimization',
],
],
[
'name' => 'Active',
'in' => 'query',
'schema' => [
'title' => '是否启用',
'description' => '是否启用事件订阅功能:'."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。',
'type' => 'string',
'required' => false,
'enumValueTitles' => [],
'example' => '1',
],
],
[
'name' => 'Severity',
'in' => 'query',
'schema' => ['description' => '按照事件类型设置事件的告警级别。'."\n"
."\n"
.'输入格式:`{"事件类型1":"告警级别", "事件类型2":"告警级别"}`。'."\n"
."\n"
.'事件类型:'."\n"
."\n"
.'- **AutoScale**:弹性伸缩事件。'."\n"
.'- **SQLThrottle**:限流事件。'."\n"
.'- **TimeSeriesAbnormal**:时序异常检测事件。'."\n"
.'- **SQLOptimize**:SQL优化事件。'."\n"
.'- **ResourceOptimize**:空间优化事件。'."\n"
."\n"
.'告警级别:'."\n"
.'- **info**:一般。'."\n"
.'- **noticed**:通知。'."\n"
.'- **warning**:警告。'."\n"
.'- **critical**:严重。', 'type' => 'string', 'required' => false, 'example' => '{"AutoScale":"critical","SQLThrottle":"info","TimeSeriesAbnormal":"warning"}'],
],
[
'name' => 'DispatchRule',
'in' => 'query',
'schema' => ['description' => '按照事件类型设置事件的消息通知规则,此参数为空时,以**MinInterval**和**ChannelType**设置为准。'."\n"
."\n"
.'输入格式:`{"silenced": {"事件类型1":是否打开自适应静默, "事件类型2":是否打开自适应静默},"min_interval":{"事件类型1":通知最小间隔, "事件类型2":通知最小间隔},"alert_type": {"事件类型1":"通知方式", "事件类型2":"通知方式"}}`。'."\n"
."\n"
.'- **silenced**:是否打开自适应静默。打开自适应静默后,事件中连续告警的发送间隔变为**min\\_interval**设置值和该事件持续时间1/3中的最大值。'."\n"
.' - 1:打开。'."\n"
.' - 2:关闭。'."\n"
.'- **min\\_interval**:通知最小间隔时间,单位为秒(s)。'."\n"
.'- **alert_type**:通知方式,取值:'."\n"
.' - **hdm\\_alarm\\_sms**:手机短信。'."\n"
.' - **dingtalk**:钉钉机器人。'."\n"
.' - **hdm\\_alarm\\_sms\\_and\\_email**:手机短信+邮件。'."\n"
.' - **hdm\\_alarm\\_sms,dingtalk**:手机短信+钉钉机器人。', 'type' => 'string', 'required' => false, 'example' => '{"silenced": {"AutoScale":1, "SQLThrottle":0, "TimeSeriesAbnormal": 1}, "min_interval": {"AutoScale":300, "SQLThrottle":360, "TimeSeriesAbnormal": 120}, "alert_type": {"AutoScale":"hdm_alarm_sms", "SQLThrottle":"hdm_alarm_sms_and_email", "TimeSeriesAbnormal": "hdm_alarm_sms,dingtalk"}}'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '返回信息列表。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '097F0C56-B252-515A-B602-FC56EF93EF8A'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '详细信息列表。',
'type' => 'object',
'properties' => [
'userId' => ['title' => '用户ID ', 'description' => '用户ID。', 'type' => 'string', 'example' => '1088760496****'],
'instanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
'eventContext' => ['title' => '事件场景', 'description' => '支持的事件场景,当前仅支持**AllContext**,表示支持所有场景。', 'type' => 'string', 'example' => 'AllContext'],
'lang' => ['title' => '语言', 'description' => '事件通知的语言,当前仅支持**zh-CN**,表示事件通知为中文。', 'type' => 'string', 'example' => 'zh_CN'],
'active' => ['title' => '是否启用', 'description' => '是否启用事件订阅:'."\n"
.'- **0**:关闭。'."\n"
.'- **1**:开启。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'minInterval' => ['title' => '通知最小间隔', 'description' => '通知最小间隔时间,单位秒(s)。', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
'contactName' => ['title' => '告警订阅人', 'description' => '告警事件订阅人名称,多个名称间以英文逗号分隔。', 'type' => 'string', 'example' => 'Default contact'],
'contactGroupName' => ['title' => '告警订阅组', 'description' => '告警事件订阅组名称,多个名称间以英文逗号分隔。', 'type' => 'string', 'example' => 'Default contact group'],
'channelType' => ['title' => '通知方式', 'description' => '通知方式:'."\n"
.'- **hdm\\_alarm\\_sms**:手机短信。'."\n"
.'- **dingtalk**:钉钉机器人。'."\n"
.'- **hdm\\_alarm\\_sms\\_and\\_email**:手机短信+邮件。'."\n"
.'- **hdm\\_alarm\\_sms,dingtalk**:手机短信+钉钉机器人。', 'type' => 'string', 'example' => 'hdm_alarm_sms,dingtalk'],
'level' => ['title' => '事件风险级别', 'description' => '事件风险级别:'."\n"
.'- **Notice**:通知。'."\n"
.'- **Optimization**:优化。'."\n"
.'- **Warn**:警告。'."\n"
.'- **Critical**:严重。'."\n", 'type' => 'string', 'example' => 'Optimization'],
],
],
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"097F0C56-B252-515A-B602-FC56EF93EF8A\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"userId\\": \\"1088760496****\\",\\n \\"instanceId\\": \\"rm-2ze8g2am97624****\\",\\n \\"eventContext\\": \\"AllContext\\",\\n \\"lang\\": \\"zh_CN\\",\\n \\"active\\": 1,\\n \\"minInterval\\": 60,\\n \\"contactName\\": \\"Default contact\\",\\n \\"contactGroupName\\": \\"Default contact group\\",\\n \\"channelType\\": \\"hdm_alarm_sms,dingtalk\\",\\n \\"level\\": \\"Optimization\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<SetEventSubscriptionResponse>\\n <RequestId>097F0C56-B252-515A-B602-FC56EF93EF8A</RequestId>\\n <Message>Successful</Message>\\n <Data>\\n <userId>1088760496****</userId>\\n <instanceId>rm-2ze8g2am97624****</instanceId>\\n <eventContext>AllContext</eventContext>\\n <lang>zh_CN</lang>\\n <active>1</active>\\n <minInterval>60</minInterval>\\n <contactName>默认联系人</contactName>\\n <contactGroupName>默认联系组</contactGroupName>\\n <channelType>hdm_alarm_sms,dingtalk</channelType>\\n <level>Optimization</level>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</SetEventSubscriptionResponse>","errorExample":""}]',
'title' => '配置事件订阅设置',
'description' => '使用该接口需满足以下前提条件:'."\n"
."\n"
.'- 使用阿里云或DAS的SDK时,建议使用最新版本。'."\n"
.'- 使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
.'- 数据库实例已接入DAS。'."\n"
."\n"
.'<props="china"> <note>事件订阅已集成至告警功能。如果在控制台配置了事件告警,通过该API接口配置的事件订阅设置将被事件告警覆盖。配置事件告警请参见[配置告警](~~87017~~)。</note></props>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetEventSubscription'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:SetEventSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'UpdateAutoResourceOptimizeRulesAsync' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdm3TU4OK'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n"
.'> 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。'."\n"
."\n", 'type' => 'string', 'required' => true, 'example' => '[\'rm-2ze8g2am97624****\',\'rm-2ze9xrhze0709****\']'],
],
[
'name' => 'TableSpaceSize',
'in' => 'query',
'schema' => ['description' => '触发空间碎片自动回收单个物理表的最小空间,取值范围:**5**~**100**,单位为GB。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '10'],
],
[
'name' => 'TableFragmentationRatio',
'in' => 'query',
'schema' => ['description' => '触发空间碎片自动回收单个物理表的碎片率,取值范围:**0.10**~**0.99**。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.2'],
],
[
'name' => 'ResultId',
'in' => 'query',
'schema' => ['description' => '异步请求的ID。'."\n"
.'> 异步调用后不会立即返回完整结果,首先需要调用该接口获取**ResultId**,然后使用返回数据的**ResultId**,重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。', 'type' => 'string', 'required' => false, 'example' => 'async__507044db6c4eadfa2dab9b084e80****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'Fail' => ['description' => '请求是否失败:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'ConfigResponse' => [
'description' => '批量设置的返回数据。'."\n"
.'> 异步请求完成时(即isFinish取值为**true**时)才会返回该数据。',
'type' => 'object',
'properties' => [
'TotalInstanceCount' => ['description' => '总数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ConfigSuccessInstanceCount' => ['description' => '设置成功的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigFailInstanceCount' => ['description' => '设置失败的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigSuccessInstanceList' => [
'description' => '设置成功的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '设置是否成功:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
],
'description' => '',
],
],
'ConfigFailInstanceList' => [
'description' => '设置失败的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '设置是否成功:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze9xrhze0709****'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON'],
],
'description' => '',
],
],
],
],
'ResultId' => ['description' => '异步请求的ID。', 'type' => 'string', 'example' => 'async__20ee808e72257f16a4fe024057ca****'],
'IsFinish' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'State' => ['description' => '异步请求的执行状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'Complete' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1645668213000'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9CB97BC4-6479-55D0-B9D0-EA925AFE****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '设置空间碎片自动回收功能的配置参数',
'summary' => '调用UpdateAutoResourceOptimizeRulesAsync接口,采用异步方式,批量设置指定数据库实例空间碎片自动回收功能的配置参数。',
'description' => '> 异步调用后不会立即返回完整结果,首先需要调用该接口获取**ResultId**,然后使用返回数据的**ResultId**,重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'- 数据库实例类型为RDS MySQL高可用系列。'."\n"
."\n"
.'- 数据库实例已开启DAS企业版,您可以调用[DescribeInstanceDasPro](~~413866~~)查询。'."\n"
."\n"
.'- 数据库实例的CPU规格不小于4核,且**innodb_file_per_table**参数值为**ON**。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoResourceOptimizeRulesAsync'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:UpdateAutoResourceOptimizeRulesAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Fail\\": false,\\n \\"ConfigResponse\\": {\\n \\"TotalInstanceCount\\": 2,\\n \\"ConfigSuccessInstanceCount\\": 1,\\n \\"ConfigFailInstanceCount\\": 1,\\n \\"ConfigSuccessInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": true,\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\"\\n }\\n ],\\n \\"ConfigFailInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": false,\\n \\"InstanceId\\": \\"rm-2ze9xrhze0709****\\",\\n \\"ErrorMessage\\": \\"Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON\\"\\n }\\n ]\\n },\\n \\"ResultId\\": \\"async__20ee808e72257f16a4fe024057ca****\\",\\n \\"IsFinish\\": true,\\n \\"State\\": \\"SUCCESS\\",\\n \\"Complete\\": true,\\n \\"Timestamp\\": 1645668213000\\n },\\n \\"RequestId\\": \\"9CB97BC4-6479-55D0-B9D0-EA925AFE****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAutoResourceOptimizeRulesAsyncResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Fail>false</Fail>\\n <ConfigResponse>\\n <TotalInstanceCount>2</TotalInstanceCount>\\n <ConfigSuccessInstanceCount>1</ConfigSuccessInstanceCount>\\n <ConfigFailInstanceCount>1</ConfigFailInstanceCount>\\n <ConfigSuccessInstanceList>\\n <ConfigSuccess>true</ConfigSuccess>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n </ConfigSuccessInstanceList>\\n <ConfigFailInstanceList>\\n <ConfigSuccess>false</ConfigSuccess>\\n <InstanceId>rm-2ze9xrhze0709****</InstanceId>\\n <ErrorMessage>Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON</ErrorMessage>\\n </ConfigFailInstanceList>\\n </ConfigResponse>\\n <ResultId>async__20ee808e72257f16a4fe024057ca****</ResultId>\\n <IsFinish>true</IsFinish>\\n <State>SUCCESS</State>\\n <Complete>true</Complete>\\n <Timestamp>1645668213000</Timestamp>\\n </Data>\\n <RequestId>9CB97BC4-6479-55D0-B9D0-EA925AFE****</RequestId>\\n <Success>true</Success>\\n</UpdateAutoResourceOptimizeRulesAsyncResponse>","errorExample":""}]',
],
'UpdateAutoSqlOptimizeStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Instances',
'in' => 'query',
'schema' => ['description' => '数据库实例ID,多个ID间以英文逗号(,)分隔。'."\n"
."\n"
.'> 最多不能输入超过50个数据库实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-bp10usoc1erj7****,rm-bp10usoc1erj7****'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '自动SQL优化功能的状态:'."\n"
."\n"
.'- **0**:关闭自动SQL优化功能。'."\n"
.'- **1**:设置为**SQL诊断并自动索引创建**。'."\n"
.'- **3**:设置为**仅SQL诊断**。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'string', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
."\n"
.'> 请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'Success' => ['description' => '设置自动SQL优化功能请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'false'],
'ErrorCode' => ['description' => '错误码:'."\n"
."\n"
.'- **-1001**:参数错误。'."\n"
.'- **-91029**:系统错误。'."\n"
."\n", 'type' => 'string', 'example' => '-1001'],
'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'invalid param'],
],
],
'RequestId' => ['description' => 'OpenAPI请求的ID。', 'type' => 'string', 'example' => 'A52AD37C-35ED-581A-AC23-2232BE54****'],
'Success' => ['description' => 'OpenAPI请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'string', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => '请求参数错误'],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => '没有权限执行该操作'],
],
],
'title' => '批量开启、修改或关闭自动SQL优化功能',
'summary' => '调用UpdateAutoSqlOptimizeStatus接口,批量开启、修改或关闭自动SQL优化功能。',
'description' => '使用该接口需满足以下前提条件:'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'- 目标数据库实例已开启DAS企业版,您可以调用[EnableDasPro](~~411645~~)接口为指定数据库实例开启DAS企业版。'."\n"
."\n"
.'- 目标数据库实例已开启自治服务,详情请参见[自治中心](~~152139~~)。'."\n"
."\n"
.'- 本接口适用的数据库引擎为:'."\n"
.' - RDS MySQL高可用系列、三节点企业系列'."\n"
.' - PolarDB MySQL版的集群版',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoSqlOptimizeStatus'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:UpdateAutoSqlOptimizeStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Success\\": \\"false\\",\\n \\"ErrorCode\\": \\"-1001\\",\\n \\"ErrorMsg\\": \\"invalid param\\"\\n },\\n \\"RequestId\\": \\"A52AD37C-35ED-581A-AC23-2232BE54****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAutoSqlOptimizeStatusResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Success>false</Success>\\n <ErrorCode>-1001</ErrorCode>\\n <ErrorMsg>invalid param</ErrorMsg>\\n </Data>\\n <RequestId>A52AD37C-35ED-581A-AC23-2232BE54****</RequestId>\\n <Success>true</Success>\\n</UpdateAutoSqlOptimizeStatusResponse>","errorExample":""}]',
],
'UpdateAutoThrottleRulesAsync' => [
'summary' => '调用UpdateAutoThrottleRulesAsync接口,采用异步方式,批量设置指定数据库实例的自动SQL限流配置参数。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREhdmTFSOG0'],
],
'parameters' => [
[
'name' => 'ConsoleContext',
'in' => 'query',
'schema' => ['description' => '备用参数。', 'type' => 'string', 'required' => false, 'example' => 'None'],
],
[
'name' => 'InstanceIds',
'in' => 'query',
'schema' => ['description' => '数据库实例ID。'."\n"
."\n"
.'> 数据格式为JSONArray,例如`[\'实例ID1\',\'实例ID2\']`,实例ID间用英文逗号(,)分隔。', 'type' => 'string', 'required' => true, 'example' => '[\'rm-2ze8g2am97624****\',\'rm-2ze9xrhze0709****\']'],
],
[
'name' => 'CpuUsage',
'in' => 'query',
'schema' => ['description' => 'CPU利用率阈值,取值范围:70%~100%。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '70'],
],
[
'name' => 'CpuSessionRelation',
'in' => 'query',
'schema' => [
'title' => '[AND | OR]',
'description' => 'CPU利用率阈值和活跃会话数阈值的逻辑关系。'."\n"
.'- **AND**:且。'."\n"
.'- **OR**:或。',
'type' => 'string',
'required' => true,
'enumValueTitles' => [],
'example' => 'OR',
],
],
[
'name' => 'ActiveSessions',
'in' => 'query',
'schema' => ['description' => '活跃会话数阈值。 '."\n"
."\n"
.'- 与CPU利用率阈值关系为**OR**(或)时,大于等于16。'."\n"
.'- 与CPU利用率阈值关系为**AND**(且)时,大于等于2。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '16'],
],
[
'name' => 'AbnormalDuration',
'in' => 'query',
'schema' => ['description' => '触发自动SQL限流的异常的持续时间阈值,取值范围:大于等于2的正整数,单位:分钟。'."\n", 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '2'],
],
[
'name' => 'MaxThrottleTime',
'in' => 'query',
'schema' => ['description' => '最大限流时长,取值为正整数,单位:分钟。', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '10'],
],
[
'name' => 'AllowThrottleStartTime',
'in' => 'query',
'schema' => ['description' => '可限流时间段的开始时间(UTC时间)。', 'type' => 'string', 'required' => true, 'example' => '00:00Z'],
],
[
'name' => 'AllowThrottleEndTime',
'in' => 'query',
'schema' => ['description' => '可限流时间段的结束时间(UTC时间)。', 'type' => 'string', 'required' => true, 'example' => '23:59Z'],
],
[
'name' => 'AutoKillSession',
'in' => 'query',
'schema' => ['description' => '是否同时KILL执行中的异常SQL:'."\n"
.'> 异常SQL:与需要限流的SQL模板相同。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
'name' => 'ResultId',
'in' => 'query',
'schema' => ['description' => '异步请求的ID。'."\n"
.'> 异步调用后不会立即返回完整结果,首先需要调用该接口获取**ResultId**,然后使用返回数据的**ResultId**,重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。', 'type' => 'string', 'required' => false, 'example' => 'async__507044db6c4eadfa2dab9b084e80****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '返回的状态码。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'Message' => ['description' => '请求返回消息。'."\n"
.'>请求成功时该参数返回**Successful**,请求失败时会返回请求异常信息(如错误码等)。', 'type' => 'string', 'example' => 'Successful'],
'Data' => [
'description' => '返回的数据。',
'type' => 'object',
'properties' => [
'Fail' => ['description' => '请求是否失败:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'ConfigResponse' => [
'description' => '批量设置的返回数据。'."\n"
.'> 异步请求完成时(即isFinish取值为**true**时)才会返回该数据。',
'type' => 'object',
'properties' => [
'TotalInstanceCount' => ['description' => '总数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'ConfigSuccessInstanceCount' => ['description' => '设置成功的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigFailInstanceCount' => ['description' => '设置失败的数据库实例数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'ConfigSuccessInstanceList' => [
'description' => '设置成功的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '设置是否成功:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze8g2am97624****'],
],
],
],
'ConfigFailInstanceList' => [
'description' => '设置失败的数据库实例列表。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigSuccess' => ['description' => '设置是否成功:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'false'],
'InstanceId' => ['description' => '数据库实例ID。', 'type' => 'string', 'example' => 'rm-2ze9xrhze0709****'],
'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'instance das autonomy service is off or can not find instance'],
],
],
],
],
],
'ResultId' => ['description' => '异步请求ID。', 'type' => 'string', 'example' => 'async__665ee69612f1627c7fd9f3c85075****'],
'IsFinish' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'State' => ['description' => '异步请求的执行状态:'."\n"
."\n"
.'- **RUNNING**:正在运行。'."\n"
."\n"
.'- **SUCCESS**:成功。'."\n"
."\n"
.'- **FAIL**:失败。', 'type' => 'string', 'example' => 'SUCCESS'],
'Complete' => ['description' => '异步请求是否执行完成:'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'Timestamp' => ['description' => '执行时间,格式为Unix时间戳,单位为毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1645668213000'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'B6D17591-B48B-4D31-9CD6-9B9796B2****'],
'Success' => ['description' => '请求是否执行成功:'."\n"
."\n"
.'- **true**:执行成功。'."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParams', 'errorMessage' => 'The request parameters are invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to do this action.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Fail\\": false,\\n \\"ConfigResponse\\": {\\n \\"TotalInstanceCount\\": 2,\\n \\"ConfigSuccessInstanceCount\\": 1,\\n \\"ConfigFailInstanceCount\\": 1,\\n \\"ConfigSuccessInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": true,\\n \\"InstanceId\\": \\"rm-2ze8g2am97624****\\"\\n }\\n ],\\n \\"ConfigFailInstanceList\\": [\\n {\\n \\"ConfigSuccess\\": false,\\n \\"InstanceId\\": \\"rm-2ze9xrhze0709****\\",\\n \\"ErrorMessage\\": \\"instance das autonomy service is off or can not find instance\\"\\n }\\n ]\\n },\\n \\"ResultId\\": \\"async__665ee69612f1627c7fd9f3c85075****\\",\\n \\"IsFinish\\": true,\\n \\"State\\": \\"SUCCESS\\",\\n \\"Complete\\": true,\\n \\"Timestamp\\": 1645668213000\\n },\\n \\"RequestId\\": \\"B6D17591-B48B-4D31-9CD6-9B9796B2****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAutoThrottleRulesAsyncResponse>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Fail>false</Fail>\\n <ConfigResponse>\\n <TotalInstanceCount>2</TotalInstanceCount>\\n <ConfigSuccessInstanceCount>1</ConfigSuccessInstanceCount>\\n <ConfigFailInstanceCount>1</ConfigFailInstanceCount>\\n <ConfigSuccessInstanceList>\\n <ConfigSuccess>true</ConfigSuccess>\\n <InstanceId>rm-2ze8g2am97624****</InstanceId>\\n </ConfigSuccessInstanceList>\\n <ConfigFailInstanceList>\\n <ConfigSuccess>false</ConfigSuccess>\\n <InstanceId>rm-2ze9xrhze0709****</InstanceId>\\n <ErrorMessage>instance das autonomy service is off or can not find instance</ErrorMessage>\\n </ConfigFailInstanceList>\\n </ConfigResponse>\\n <ResultId>async__665ee69612f1627c7fd9f3c85075****</ResultId>\\n <IsFinish>true</IsFinish>\\n <State>SUCCESS</State>\\n <Complete>true</Complete>\\n <Timestamp>1645668213000</Timestamp>\\n </Data>\\n <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>\\n <Success>true</Success>\\n</UpdateAutoThrottleRulesAsyncResponse>","errorExample":""}]',
'title' => '设置自动SQL限流配置参数',
'description' => '> 异步调用后不会立即返回完整结果,首先需要调用该接口获取**ResultId**,然后使用返回数据的**ResultId**,重新发起调用,直到**isFinish**取值为**true**时,返回完整结果。即获取一次完整数据,至少需要调用该接口两次。'."\n"
."\n"
.'使用该接口需满足以下前提条件:'."\n"
.'- 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。'."\n"
."\n"
.'- 目标数据库实例已开启自治服务,详情请参见[自治中心](~~152139~~)。'."\n"
."\n"
.'- 目标数据库实例为:'."\n"
.' - RDS MySQL 5.6、5.7、 8.0高可用系列、三节点企业系列。'."\n"
.' - PolarDB MySQL版 5.6集群版、5.7集群版、 8.0集群版。',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:UpdateAutoThrottleRulesAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'das.cn-shanghai.aliyuncs.com', 'endpoint' => 'das.cn-shanghai.aliyuncs.com', 'vpc' => 'das.vpc-proxy.aliyuncs.com'],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'das.aliyuncs.com', 'endpoint' => 'das.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => '-1005', 'message' => 'Service request timed out. Please try again later.', 'http_code' => 503, 'description' => '后端接口查询超时'],
['code' => '-10200017', 'message' => 'The instance already enable other version audit.', 'http_code' => 517, 'description' => '该实例已经开启其它版本审计日志'],
['code' => '-10200030', 'message' => 'Invalid query parameter.', 'http_code' => 432, 'description' => '审计日志查询参数非法'],
['code' => '-1120002', 'message' => 'Node ID is duplicate. Please check and try again.', 'http_code' => 438, 'description' => '节点ID重复,请检查并重试。'],
['code' => '-1150006', 'message' => 'Auto-scaling system error. Please contact support.', 'http_code' => 512, 'description' => '弹性伸缩内部错误'],
['code' => '-1170007', 'message' => 'Query time out of hot records range.', 'http_code' => 433, 'description' => '查询时间超过热数据范围'],
['code' => '-404', 'message' => 'Resource not found.', 'http_code' => 516, 'description' => '实体未发现'],
['code' => '-40402', 'message' => 'Instance not found.', 'http_code' => 515, 'description' => '找不到实例'],
['code' => '-5001', 'message' => 'Task run error. Please check the task configuration.', 'http_code' => 514, 'description' => '任务执行失败'],
['code' => '-80000', 'message' => 'Analysis task threshold exceeds the limit. Please adjust the threshold.', 'http_code' => 513, 'description' => '空间分析任务超过阈值,半个小时内仅允许创建一个任务'],
['code' => '-8063', 'message' => 'Invalid result ID. Please check and try again.', 'http_code' => 439, 'description' => '无效的异步任务结果ID'],
['code' => '-90005', 'message' => 'Unsupported engine minor version. Please upgrade or downgrade to a supported version.', 'http_code' => 518, 'description' => '引擎小版本不支持'],
['code' => '-9006', 'message' => 'Request is not enabled. Please enable the related feature first.', 'http_code' => 437, 'description' => 'SQL 洞察未开启'],
['code' => '-91007', 'message' => 'DAS Pro is not enabled. Please enable DAS Pro first.', 'http_code' => 402, 'description' => '未购买DAS专业版(企业版)'],
['code' => '-91023', 'message' => 'SQL log detail archive exceeds the limit. Please clean up the archive.', 'http_code' => 435, 'description' => 'sql archive 超过上限'],
['code' => '-91045', 'message' => 'Page number is too large. Please use a smaller page number.', 'http_code' => 434, 'description' => '翻页PageNo太大'],
['code' => '-996', 'message' => 'Operation is too fast. Please try again later.', 'http_code' => 429, 'description' => '操作过快'],
['code' => '-998', 'message' => 'Unsupported operation. Please check the operation type.', 'http_code' => 405, 'description' => '该操作类型不支持'],
['code' => '-999', 'message' => 'Can not get endpoint.', 'http_code' => 452, 'description' => '无法获取链接地址'],
['code' => '2', 'message' => 'Time not match the format: yyyyMMdd.', 'http_code' => 440, 'description' => '时间参数格式不合法'],
['code' => '400', 'message' => 'The provided API key is malformed. Please check the format of the key and ensure it is correctly configured.', 'http_code' => 441, 'description' => '提供的密钥不合法'],
['code' => '500', 'message' => 'The request processing has failed due to timeout.', 'http_code' => 519, 'description' => '访问超时'],
['code' => 'InstanceNotFound', 'message' => 'Requested instance not found.', 'http_code' => 404, 'description' => '对应实例id无法找到'],
['code' => 'InstanceNotFound', 'message' => 'The specified instance does not exist.', 'http_code' => 404, 'description' => '实例不存在'],
['code' => 'InvalidParams', 'message' => 'The request parameters are invalid.', 'http_code' => 400, 'description' => '请求参数错误'],
['code' => 'NoPermission', 'message' => 'You are not authorized to do this action.', 'http_code' => 403, 'description' => '没有权限执行该操作'],
['code' => 'Timeout', 'message' => 'The request processing has failed due to timeout.', 'http_code' => 500, 'description' => '由于超时请求处理失败。'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutoResourceOptimizeRules'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFullRequestSampleByInstanceId'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeExecErrorStats'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPartitionsHeatmap'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFullRequestStatResultByInstanceId'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMongoDBCurrentOp'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMySQLAllSessionAsync'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRequestDiagnosisResult'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeDataStats'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAutoResourceOptimizeRules'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutonomousNotifyEventsInRange'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDasSQLLogHotData'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFullRequestOriginStatByInstanceId'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutoIncrementUsageStatistic'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeDataTop'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSqlLogTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableInstanceDasConfig'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableDasPro'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeSolution'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlConcurrencyControlKeywordsFromSqlText'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAutoThrottleRules'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogRecords'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCacheAnalysisJob'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudBenchTasks'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDiagnosticReport'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadLockDetailList'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogStatistic'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetErrorRequestSample'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeExecErrorSample'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDBInstanceConnectivityDiagnosis'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncErrorRequestListByCode'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RunCloudBenchTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableSqlConcurrencyControl'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncErrorRequestStatResult'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRedisAllSession'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHDMAliyunResourceSyncResult'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutoThrottleRules'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceMissingIndexList'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddHDMInstance'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadLockDetail'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableSqlConcurrencyControl'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlOptimizeAdvice'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeDiagnosticReportList'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeDataTrend'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisJob'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDasProServiceUsage'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlowLogHistogramAsync'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetKillInstanceSessionTaskResult'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoResourceOptimizeRulesAsync'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHotKeys'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeRuleList'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableAllSqlConcurrencyControlRules'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAutoScalingConfig'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogTasks'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPfsSqlSample'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStorageAnalysisResult'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceInspections'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEndpointSwitchTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetEventSubscription'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateKillInstanceSessionTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateLatestDeadLockAnalysis'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadlockHistogram'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'KillInstanceAllSession'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRequestDiagnosisPage'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyAutoScalingConfig'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateStorageAnalysisTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRunningSqlConcurrencyControlRules'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogConfig'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateQueryOptimizeTag'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeInstanceDasPro'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeHotBigKeys'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateRequestDiagnosis'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTopBigKeys'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DisableDasPro'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeTopHotKeys'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHDMLastAliyunResourceSyncResult'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAutonomousNotifyEventContent'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPfsSqlSummaries'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlowLogStatistic'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteStopGateway'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBlockingDetailList'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetEventSubscription'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudbenchTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSlowLogRecords'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCloudbenchTaskConfig'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeTag'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDeadLockHistory'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeCacheAnalysisJobs'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAsyncErrorRequestStatByCode'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCloudBenchTasks'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAutoScalingHistory'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSqlConcurrencyControlRulesHistory'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoThrottleRulesAsync'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPfsMetricTrends'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInstanceSqlOptimizeStatistic'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeSqlLogTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCloudBenchTask'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueryOptimizeShareUrl'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifySqlLogConfig'],
['threshold' => '60', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoSqlOptimizeStatus'],
],
],
'ram' => [
'productCode' => 'DAS',
'productName' => '数据库自治服务',
'ramCodes' => ['hdm'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetAsyncErrorRequestStatResult',
'description' => '获取指定SQL的执行错误次数',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAsyncErrorRequestStatResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeadlockHistogram',
'description' => '查询时间范围内全量死锁分析的数量趋势',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetDeadlockHistogram',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCacheAnalysisJob',
'description' => '查询缓存分析任务详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCacheAnalysisJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRunningSqlConcurrencyControlRules',
'description' => '获取正在执行的限流规则',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRunningSqlConcurrencyControlRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAutoIncrementUsageStatistic',
'description' => '获取表自增ID使用数据',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetAutoIncrementUsageStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAutoThrottleRules',
'description' => '获取自动SQL限流规则',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetAutoThrottleRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSqlLogTasks',
'description' => '查询DAS企业版离线任务列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPartitionsHeatmap',
'description' => '获取分区热度信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPartitionsHeatmap',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetYaoChiAgent',
'description' => '瑶池Agent大模型能力接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetYaoChiAgent',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPfsMetricTrends',
'description' => '查询指定指标趋势',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPfsMetricTrends',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'KillInstanceAllSession',
'description' => '结束全部会话',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:KillInstanceAllSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCacheAnalysisJobs',
'description' => '查询缓存分析任务列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCacheAnalysisJobs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableInstanceDasConfig',
'description' => '关闭指定弹性伸缩功能',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:DisableInstanceDasConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMongoDBCurrentOp',
'description' => '获取MongoDB实例当前会话',
'operationType' => '',
'ramAction' => [
'action' => 'hdm:GetMongoDBCurrentOp',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeTag',
'description' => '获取SQL标签',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAutoScalingHistory',
'description' => '查询实例弹性伸缩历史信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeAutoScalingHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAutonomousNotifyEventsInRange',
'description' => '获取指定类型或范围的通知事件',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAutonomousNotifyEventsInRange',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSqlLogConfig',
'description' => '查询DAS企业版配置信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetEventSubscription',
'description' => '获取事件订阅设置',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetEventSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDasAgentSSE',
'description' => '(废弃)Das Agent 数据流接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDasAgentSSE',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSecurityIPGroup',
'description' => '跨产品白名单模板展示接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDiagnosticReport',
'description' => '创建诊断报告',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateDiagnosticReport',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateAutoThrottleRulesAsync',
'description' => '设置自动SQL限流配置参数',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:UpdateAutoThrottleRulesAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSecurityIPGroup',
'description' => '跨产品白名单模板创建接口',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateSecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDiagnosticReportList',
'description' => '查询诊断报告',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeDiagnosticReportList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSqlConcurrencyControlRulesHistory',
'description' => '获取正在执行或被触发过的限流规则',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetSqlConcurrencyControlRulesHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFullRequestOriginStatByInstanceId',
'description' => '按照访问来源统计全量请求数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetFullRequestOriginStatByInstanceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeadLockHistory',
'description' => '获取死锁分析的任务列表',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetDeadLockHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetBlockingDetailList',
'description' => '查询RDS SQL Server实例的锁阻塞列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:GetBlockingDetailList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateQueryOptimizeTag',
'description' => '对目标SQL进行打标',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:CreateQueryOptimizeTag',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCloudBenchTasks',
'description' => '创建压测任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateCloudBenchTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceInspections',
'description' => '获取数据库实例巡检评分结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceInspections',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSqlLogStatistic',
'description' => '查询DAS企业版数据统计信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateKillInstanceSessionTask',
'description' => '创建结束会话的任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateKillInstanceSessionTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAsyncErrorRequestListByCode',
'description' => '查询产生指定MySQL错误码的SQL ID',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAsyncErrorRequestListByCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeExecErrorSample',
'description' => '获取执行失败的样本数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeExecErrorSample',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeDataStats',
'description' => '获取查询治理模板数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeDataStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudBenchTasks',
'description' => '查询压测任务列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCloudBenchTasks',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySecurityIPGroup',
'description' => '跨产品白名单模板修改接口',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifySecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyAutoScalingConfig',
'description' => '修改实例弹性伸缩功能配置',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifyAutoScalingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeQueryExplain',
'description' => '查询SQL执行计划',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeQueryExplain',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeShareUrl',
'description' => '获取查询治理的分享链接',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeShareUrl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRequestDiagnosisPage',
'description' => '分页获取SQL诊断历史记录',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRequestDiagnosisPage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateSqlLogTask',
'description' => '创建DAS企业版离线任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateSqlLogTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceMissingIndexList',
'description' => '查询RDS SQL Server实例索引缺失情况',
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:GetInstanceMissingIndexList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateLatestDeadLockAnalysis',
'description' => '创建最近死锁分析任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:CreateLatestDeadLockAnalysis',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeHotBigKeys',
'description' => '实时获取当前热Key和大Key',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeHotBigKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateRequestDiagnosis',
'description' => '发起SQL诊断请求',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateRequestDiagnosis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSqlLogRecords',
'description' => '(废弃)查询DAS企业版日志明细',
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogRecords',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCacheAnalysisJob',
'description' => '创建缓存分析任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:CreateCacheAnalysisJob',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAuditLogs',
'description' => '查询审计告警日志',
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:DescribeAuditLogs',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMySQLAllSessionAsync',
'description' => '获取实例当前会话',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetMySQLAllSessionAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RunCloudBenchTask',
'description' => '执行压测任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:RunCloudBenchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteStopGateway',
'description' => '删除已停止的DBGateway元数据',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DeleteStopGateway',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddHDMInstance',
'description' => '接入数据库实例',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:AddHDMInstance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeadLockDetail',
'description' => '查询单个死锁详情',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetDeadLockDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDasSQLLogHotData',
'description' => '查询DAS企业版热存储数据明细',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDasSQLLogHotData',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceGroupInspectReportList',
'description' => '查询DAS Agent运维报告列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceGroupInspectReportList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnableDasPro',
'description' => '开启DAS企业版 V1',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:EnableDasPro',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeRuleList',
'description' => '获取规则列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeRuleList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFullRequestStatResultByInstanceId',
'description' => '按照SQL ID异步统计全量请求数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetFullRequestStatResultByInstanceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSlowLogRecords',
'description' => '慢日志记录查询',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSlowLogRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetFullRequestSampleByInstanceId',
'description' => '按照SQL ID查询SQL样本数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetFullRequestSampleByInstanceId',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateStorageAnalysisTask',
'description' => '创建空间分析任务',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:CreateStorageAnalysisTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableAutoThrottleRules',
'description' => '关闭自动SQL限流功能',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:DisableAutoThrottleRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeErrorLogRecords',
'description' => '查询错误日志明细',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:DescribeErrorLogRecords',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSqlOptimizeAdvice',
'description' => '查询自动SQL优化产生的诊断建议',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetSqlOptimizeAdvice',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetErrorRequestSample',
'description' => '查询执行错误的SQL样本数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetErrorRequestSample',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRequestDiagnosisResult',
'description' => '查询SQL诊断的结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRequestDiagnosisResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySqlLogConfig',
'description' => '开启或配置DAS企业版',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifySqlLogConfig',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSecurityIPGroupRelation',
'description' => '跨产品白名单模板绑定信息展示接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSecurityIPGroupRelation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetRedisAllSession',
'description' => '获取Redis实例当前会话',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetRedisAllSession',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSlowLogHistogramAsync',
'description' => '异步获取实例慢日志趋势数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSlowLogHistogramAsync',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeDataTrend',
'description' => '获取查询治理趋势数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeDataTrend',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeHotKeys',
'description' => '查询实例当前的热Key',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeHotKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAutonomousNotifyEventContent',
'description' => '获取实例自治事件内容',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAutonomousNotifyEventContent',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeAutoScalingConfig',
'description' => '查询实例弹性伸缩功能配置信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeAutoScalingConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetKillInstanceSessionTaskResult',
'description' => '获取结束会话任务的结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetKillInstanceSessionTaskResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateAutoSqlOptimizeStatus',
'description' => '批量开启、修改或关闭自动SQL优化功能',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:UpdateAutoSqlOptimizeStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeSolution',
'description' => '获取治理建议',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeSolution',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAsyncErrorRequestStatByCode',
'description' => '查询MySQL错误码以及每个错误码对应的SQL数量',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetAsyncErrorRequestStatByCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDBInstanceConnectivityDiagnosis',
'description' => '获取数据库实例网络连通性诊断结果',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDBInstanceConnectivityDiagnosis',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeExecErrorStats',
'description' => '获取执行失败的模板数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeExecErrorStats',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudbenchTaskConfig',
'description' => '查询压测任务配置',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCloudbenchTaskConfig',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSlowLogStatistic',
'description' => '慢日志统计信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSlowLogStatistic',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'Chat',
'description' => 'DAS Agent 交互接口',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:Chat',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCloudbenchTask',
'description' => '查询压测任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeCloudbenchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceGroupInspectReportDetail',
'description' => '查询DAS Agent运维报告明细',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceGroupInspectReportDetail',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableSqlConcurrencyControl',
'description' => '关闭指定限流规则',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:DisableSqlConcurrencyControl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetStorageAnalysisResult',
'description' => '获取空间分析任务的结果',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetStorageAnalysisResult',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTopBigKeys',
'description' => ' 获取排名前100的大Key',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeTopBigKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCloudBenchTask',
'description' => '删除压测任务',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DeleteCloudBenchTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeInstanceDasPro',
'description' => '查询是否开启了DAS企业版 V1或V2',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeInstanceDasPro',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeTopHotKeys',
'description' => '获取排名前100的热Key',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeTopHotKeys',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDasProServiceUsage',
'description' => '查询DAS企业版(V1或V2)存储空间使用情况',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetDasProServiceUsage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInstanceSqlOptimizeStatistic',
'description' => ' 获取自动SQL优化事件的统计数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetInstanceSqlOptimizeStatistic',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSqlConcurrencyControlKeywordsFromSqlText',
'description' => '根据SQL语句生成限流关键词',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetSqlConcurrencyControlKeywordsFromSqlText',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateAutoResourceOptimizeRulesAsync',
'description' => '设置空间碎片自动回收功能的配置参数',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:UpdateAutoResourceOptimizeRulesAsync',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableAutoResourceOptimizeRules',
'description' => '关闭空间碎片自动回收功能',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:DisableAutoResourceOptimizeRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAutoResourceOptimizeRules',
'description' => '获取空间碎片自动回收规则',
'operationType' => 'none',
'ramAction' => [
'action' => 'hdm:GetAutoResourceOptimizeRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableDasPro',
'description' => '关闭DAS企业版 V1',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DisableDasPro',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDeadLockDetailList',
'description' => '查询RDS SQL Server实例的死锁列表',
'operationType' => 'list',
'ramAction' => [
'action' => 'hdm:GetDeadLockDetailList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifySecurityIPGroupRelation',
'description' => '跨产品白名单模板绑定/解绑接口',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:ModifySecurityIPGroupRelation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPfsSqlSummaries',
'description' => '查询按照SQL ID维度统计的全量请求数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPfsSqlSummaries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'EnableSqlConcurrencyControl',
'description' => '启用SQL限流',
'operationType' => 'create',
'ramAction' => [
'action' => 'hdm:EnableSqlConcurrencyControl',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetEventSubscription',
'description' => '配置事件订阅设置',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:SetEventSubscription',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DisableAllSqlConcurrencyControlRules',
'description' => ' 关闭全部正在执行的限流规则',
'operationType' => 'update',
'ramAction' => [
'action' => 'hdm:DisableAllSqlConcurrencyControlRules',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSecurityIPGroup',
'description' => '跨产品白名单模板删除接口',
'operationType' => 'delete',
'ramAction' => [
'action' => 'hdm:DeleteSecurityIPGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSqlLogTask',
'description' => '查询DAS企业版离线任务详情',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:DescribeSqlLogTask',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPfsSqlSample',
'description' => '获取SQL样本数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetPfsSqlSample',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetQueryOptimizeDataTop',
'description' => '获取查询治理实例红榜和实例黑榜的数据',
'operationType' => 'get',
'ramAction' => [
'action' => 'hdm:GetQueryOptimizeDataTop',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DAS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'conditional', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
['validationType' => 'conditional', 'resourceType' => 'DBCluster', 'arn' => 'acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}'],
['validationType' => 'conditional', 'resourceType' => 'DBInstance', 'arn' => 'acs:drds:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
['validationType' => 'conditional', 'resourceType' => 'DBInstance', 'arn' => 'acs:kvstore:{#regionId}:{#accountId}:dbinstance/{#DBInstanceId}'],
['validationType' => 'conditional', 'resourceType' => 'Instance', 'arn' => 'acs:mongodb:{#regionId}:{#accountId}:instance/{#InstanceId}'],
['validationType' => 'conditional', 'resourceType' => 'PolarDBXInstance', 'arn' => 'acs:polardbx:{#RegionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}'],
['validationType' => 'conditional', 'resourceType' => 'HDMInstance', 'arn' => 'acs:hdm::{#accountId}:hdminstance/*'],
['validationType' => 'always', 'resourceType' => 'SwitchDasPro', 'arn' => 'acs:hdm::{#accountId}:switchdaspro/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'CloudbenchTask', 'arn' => 'acs:hdm:*:{#accountId}:cloudbenchtask/{#TaskId}'],
['validationType' => 'always', 'resourceType' => 'SwitchDasPro', 'arn' => 'acs:hdm:*:{#accountId}:switchdaspro/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'InstanceMonitoringData', 'arn' => 'acs:hdm:*:{#accountId}:instancemonitoringdata/{#InstanceId}'],
['validationType' => 'always', 'resourceType' => 'DBInstance', 'arn' => 'acs:hdm:{#regionId}:{#accountId}:dbinstance/*'],
['validationType' => 'always', 'resourceType' => 'DBCluster', 'arn' => 'acs:hdm:{#regionId}:{#accountId}:dbcluster/*'],
['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:hdm:{#regionId}:{#accountId}:instance/*'],
],
],
];
|