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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Kms', 'version' => '2016-01-20'],
'directories' => [
[
'children' => ['DescribeAccountKmsStatus', 'OpenKmsService'],
'type' => 'directory',
'title' => 'Service management',
],
[
'children' => ['ListKmsInstances', 'GetKmsInstance', 'UpdateKmsInstanceBindVpc', 'ReleaseKmsInstance', 'GetDefaultKmsInstance'],
'type' => 'directory',
'title' => 'Instance management',
],
[
'children' => ['CreateKey', 'ListKeys', 'DescribeKey', 'UpdateKeyDescription', 'GetPublicKey', 'ListAliases', 'ImportKeyMaterial', 'DeleteKeyMaterial', 'SetDeletionProtection', 'UpdateRotationPolicy', 'DescribeKeyVersion', 'CreateKeyVersion', 'ListKeyVersions', 'SetKeyPolicy', 'GetKeyPolicy'],
'type' => 'directory',
'title' => 'Key management',
],
[
'children' => ['GenerateDataKey', 'GenerateAndExportDataKey', 'Encrypt', 'Decrypt', 'ReEncrypt', 'ExportDataKey', 'GenerateDataKeyWithoutPlaintext', 'AsymmetricSign', 'AsymmetricVerify', 'AsymmetricEncrypt', 'AsymmetricDecrypt'],
'type' => 'directory',
'title' => 'Cryptographic operations',
],
[
'children' => ['UpdateSecretVersionStage', 'ListSecretVersionIds', 'GetRandomPassword', 'PutSecretValue', 'RotateSecret', 'SetSecretPolicy', 'GetSecretPolicy'],
'type' => 'directory',
'title' => 'Credential management',
],
[
'children' => ['GetKmsInstanceQuotaInfos', 'TagResource', 'UntagResource'],
'type' => 'directory',
'title' => 'Tag management',
],
[
'children' => ['ListNetworkRules', 'DescribeNetworkRule', 'UpdateNetworkRule', 'DeleteNetworkRule', 'ListPolicies', 'DescribePolicy', 'ListApplicationAccessPoints', 'DescribeApplicationAccessPoint', 'DeleteApplicationAccessPoint', 'ListClientKeys', 'GetClientKey', 'DeleteClientKey'],
'type' => 'directory',
'title' => 'Application management',
],
[
'children' => [
'CreateSecret', 'DescribeRegions', 'GetSecretValue', 'ListSecrets', 'ListTagResources', 'TagResources', 'CancelKeyDeletion', 'ConnectKmsInstance', 'CreateAlias', 'CreateApplicationAccessPoint', 'CreateClientKey', 'CreateNetworkRule', 'CreatePolicy', 'DeleteAlias', 'DeletePolicy', 'DeleteSecret', 'DescribeSecret', 'DisableKey', 'EnableKey', 'GenerateMac',
'GetParametersForImport', 'ListAliasesByKeyId', 'ListResourceTags', 'RestoreSecret', 'ScheduleKeyDeletion', 'UntagResources', 'UpdateAlias', 'UpdateApplicationAccessPoint', 'UpdatePolicy', 'UpdateSecret', 'UpdateSecretRotationPolicy', 'VerifyMac',
],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AsymmetricDecrypt' => [
'summary' => 'Decrypts data by using the private key of an asymmetric CMK.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54534',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'CiphertextBlob',
'in' => 'query',
'schema' => ['description' => 'The ciphertext to be decrypted. The ciphertext is encoded in Base64.'."\n"
."\n"
.'> You can generate a ciphertext by calling the [AsymmetricEncrypt](~~148131~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1W****==', 'title' => ''],
],
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify the alias or Amazon Resource Name (ARN) of the key. For more information about aliases, see [Manage aliases](~~480655~~).'."\n"
."\n"
.'> When you access a key in another Alibaba Cloud account, you must specify the ARN of the key. The ARN of a key is in the `acs:kms:${region}:${account}:key/${keyid}` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'KeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key version. The globally unique identifier of the key version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => ['description' => 'The decryption algorithm.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSAES_OAEP_SHA_1', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the dry run feature.'."\n"
."\n"
.'- true: enables the dry run feature.'."\n"
."\n"
.'- false: disables the dry run feature. This is the default value.'."\n"
."\n"
.'The dry run feature is used to test API calls, verify the permissions on the specified resources, and check the validity of the request parameters. If you enable the dry run feature, KMS always returns a failure response and the cause of the failure. The causes of the failure include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter is not specified.'."\n"
."\n"
.'- ValidationError: The specified parameter in the request is invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The version of the master key that was used to encrypt the plaintext.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the key. If the KeyId parameter in the request is a key alias or key ARN, the key ID is also returned in the response.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier that is generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d', 'title' => ''],
'Plaintext' => ['description' => 'The decrypted plaintext. The plaintext is encoded in Base64.', 'type' => 'string', 'example' => 'SGVsbG8gd29ybGQ=', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Rejected.UnsupportedOperation', 'errorMessage' => 'Unsupported operation.', 'description' => 'The operation is not supported.'],
],
404 => [
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\",\\n \\"Plaintext\\": \\"SGVsbG8gd29ybGQ=\\"\\n}","type":"json"}]',
'title' => 'AsymmetricDecrypt',
'description' => '### Usage notes'."\n"
."\n"
.'- For information about the access policy required for a RAM user or RAM role to call this API operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation can be called through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or a VPC. To access KMS over the Internet, you must enable the public endpoint. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- If you use a shared gateway, the queries per second (QPS) limit for each Alibaba Cloud account is 200. If the QPS exceeds the limit, the API call is throttled. This can affect your business. We recommend that you plan your calls to avoid exceeding this limit.'."\n"
."\n"
.'- If you use a dedicated gateway, the QPS limit for each Alibaba Cloud account is subject to the performance specifications of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'This operation supports only asymmetric keys for which the **Usage** parameter is set to **ENCRYPT/DECRYPT**. The following table describes the supported encryption algorithms.'."\n"
."\n"
.'| KeySpec | Algorithm | Description | Ciphertext length (bytes) |'."\n"
.'| --------- | --------------------- | -------------------------------------------------- | ------------------------- |'."\n"
.'| RSA\\_2048 | RSAES\\_OAEP\\_SHA\\_256 | RSAES-OAEP using SHA-256 and MGF1 with SHA-256 | 256 |'."\n"
.'| RSA\\_2048 | RSAES\\_OAEP\\_SHA\\_1 | RSAES-OAEP using SHA1 and MGF1 with SHA1 | 256 |'."\n"
.'| RSA\\_3072 | RSAES\\_OAEP\\_SHA\\_256 | RSAES-OAEP using SHA-256 and MGF1 with SHA-256 | 384 |'."\n"
.'| RSA\\_3072 | RSAES\\_OAEP\\_SHA\\_1 | RSAES-OAEP using SHA1 and MGF1 with SHA1 | 384 |'."\n"
.'| EC\\_SM2 | SM2PKE | SM2 elliptic curve public key encryption algorithm | Maximum 6,144 |'."\n"
."\n"
.'This topic provides an example of how to use the asymmetric key whose ID is `key-hzz630494463ejqjx****` and version ID is `2ab1a983-7072-4bbc-a582-584b5bd8****` to decrypt the ciphertext `BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1W****==` using the `RSAES_OAEP_SHA_1` decryption algorithm.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'AsymmetricEncrypt' => [
'summary' => 'Encrypts data by using the public key of an asymmetric CMK.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54535',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'Plaintext',
'in' => 'query',
'schema' => ['description' => 'The plaintext to be encrypted. The value must be Base64-encoded.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SGVsbG8gd29ybGQ=', 'title' => ''],
],
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify the alias or the Amazon Resource Name (ARN) of the key. For more information about aliases, see [Manage aliases](~~480655~~).'."\n"
."\n"
.'> To access a key of another Alibaba Cloud account, you must specify the ARN of the key. The key ARN is in the format of `acs:kms:${region}:${account}:key/${keyid}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'KeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key version. The ID must be a globally unique identifier.'."\n"
."\n"
.'> To obtain the key version ID, call the [ListKeyVersions](~~133966~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => ['description' => 'The encryption algorithm.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSAES_OAEP_SHA_1', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the dry run feature.'."\n"
."\n"
.'- true: enables the feature.'."\n"
."\n"
.'- false (default): disables the feature.'."\n"
."\n"
.'The dry run feature is used to test the API call and verify the permissions on the specified resources and the validity of the request parameters. If you enable the dry run feature, KMS always returns a failed result and a failure reason. The failure reasons include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter was not specified.'."\n"
."\n"
.'- ValidationError: The specified parameters in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The version number of the master key that is used to encrypt the plaintext.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the key. If you specify an alias or an ARN of the key in the request, the ID of the key is returned.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'CiphertextBlob' => ['description' => 'The ciphertext of the data that is encrypted. The value is Base64-encoded.', 'type' => 'string', 'example' => 'BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Rejected.UnsupportedOperation', 'errorMessage' => 'Unsupported operation.', 'description' => 'The operation is not supported.'],
],
404 => [
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"CiphertextBlob\\": \\"BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVsv1Wbjwg==\\",\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\"\\n}","type":"json"}]',
'title' => 'AsymmetricEncrypt',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the permissions that are required to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation can be called through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or using a VPC domain name. To access KMS over the Internet, you must enable Internet access. For more information, see [Access a key in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- If you use a shared gateway: The number of queries per second (QPS) for a single user is limited to 200. If the limit is exceeded, API calls are throttled. This may affect your business. We recommend that you plan your API calls to avoid exceeding this limit.'."\n"
."\n"
.'- If you use a dedicated gateway: The QPS limit for a single user depends on the computing performance specifications of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'This operation supports only asymmetric keys that have the **Usage** parameter set to **ENCRYPT/DECRYPT**. The following table describes the supported encryption algorithms.'."\n"
."\n"
.'| KeySpec | Algorithm | Description | Maximum number of bytes that can be encrypted |'."\n"
.'| --------- | --------------------- | -------------------------------------------------- | --------------------------------------------- |'."\n"
.'| RSA\\_2048 | RSAES\\_OAEP\\_SHA\\_256 | RSAES-OAEP using SHA-256 and MGF1 with SHA-256 | 190 |'."\n"
.'| RSA\\_2048 | RSAES\\_OAEP\\_SHA\\_1 | RSAES-OAEP using SHA1 and MGF1 with SHA1 | 214 |'."\n"
.'| RSA\\_3072 | RSAES\\_OAEP\\_SHA\\_256 | RSAES-OAEP using SHA-256 and MGF1 with SHA-256 | 318 |'."\n"
.'| RSA\\_3072 | RSAES\\_OAEP\\_SHA\\_1 | RSAES-OAEP using SHA1 and MGF1 with SHA1 | 342 |'."\n"
.'| EC\\_SM2 | SM2PKE | SM2 elliptic curve public key encryption algorithm | 6047 |'."\n"
."\n"
.'In this example, the plaintext `SGVsbG8gd29ybGQ=` is encrypted using an asymmetric key with the key ID `key-hzz630494463ejqjx****`, the key version ID `2ab1a983-7072-4bbc-a582-584b5bd8****`, and the `RSAES_OAEP_SHA_1` encryption algorithm.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'AsymmetricSign' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54536',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique identifier (GUID) of the customer master key (CMK).'."\n"
."\n"
.'> You can also specify the alias that is bound to the CMK. For more information, see [Overview of aliases](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
],
[
'name' => 'KeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key version. The ID must be the GUID of the key version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => ['description' => 'The signature algorithm.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSA_PSS_SHA_256', 'title' => ''],
],
[
'name' => 'Digest',
'in' => 'query',
'schema' => ['description' => 'The digest of the original message. The digest is generated using the hash algorithm that corresponds to the value of the Algorithm parameter.'."\n"
."\n"
.'> - The value is Base64-encoded.'."\n"
."\n"
.'- For information about how to calculate a message digest, see the "Pre-signing: calculate a message digest" section of the [Asymmetric digital signature](~~148146~~) topic.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiu****=', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the dry-run feature.'."\n"
."\n"
.'- true: enables the feature.'."\n"
."\n"
.'- false (default): disables the feature.'."\n"
."\n"
.'The dry-run feature is used to test API calls and verify the permissions on the resources that you have and the validity of the request parameters. If you enable the dry-run feature, KMS always returns a failure response and a failure reason. The failure reasons include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter is not configured.'."\n"
."\n"
.'- ValidationError: The specified parameters in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform the operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version. The ID is the GUID of the key version.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The GUID of the CMK.'."\n"
."\n"
.'> If you use an alias of the CMK in the request, the ID of the CMK to which the alias is bound is returned.', 'type' => 'string', 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
'Value' => ['description' => 'The generated signature.'."\n"
."\n"
.'> The value is Base64-encoded.', 'type' => 'string', 'example' => 'M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the request ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"5c438b18-05be-40ad-b6c2-3be6752c****\\",\\n \\"Value\\": \\"M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==\\",\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\"\\n}","type":"json"}]',
'title' => 'AsymmetricSign',
'summary' => 'Generates a digital signature by using an asymmetric CMK.',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the access policies that are required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation can be called through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or a VPC. This method requires you to enable Internet access. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- Shared gateway: This operation is limited to 200 queries per second (QPS) for each user. If the limit is exceeded, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.'."\n"
."\n"
.'- Dedicated gateway: The QPS for each user is limited by the performance specifications of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'This operation supports only asymmetric keys for which the **Usage** parameter is set to **SIGN/VERIFY**. The following table describes the supported signature algorithms.'."\n"
."\n"
.'| KeySpec | Algorithm | Description |'."\n"
.'| --------- | -------------------- | ---------------------------------------------------------- |'."\n"
.'| RSA\\_2048 | RSA\\_PSS\\_SHA\\_256 | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 |'."\n"
.'| RSA\\_2048 | RSA\\_PKCS1\\_SHA\\_256 | RSASSA-PKCS1-v1\\_5 using SHA-256 |'."\n"
.'| RSA\\_3072 | RSA\\_PSS\\_SHA\\_256 | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 |'."\n"
.'| RSA\\_3072 | RSA\\_PKCS1\\_SHA\\_256 | RSASSA-PKCS1-v1\\_5 using SHA-256 |'."\n"
.'| EC\\_P256 | ECDSA\\_SHA\\_256 | ECDSA on the P-256 Curve(secp256r1) with a SHA-256 digest |'."\n"
.'| EC\\_P256K | ECDSA\\_SHA\\_256 | ECDSA on the P-256K Curve(secp256k1) with a SHA-256 digest |'."\n"
.'| EC\\_SM2 | SM2DSA | SM2 elliptic curve digital signature algorithm |'."\n"
."\n"
.'> According to the GB/T 32918.2 standard "Information security technology - SM2 elliptic curve public key cryptography - Part 2: Digital signature algorithm", when you calculate an SM2 signature, the value of the **Digest** parameter is not the SM3 hash value of the original message. Instead, the value is the SM3 hash value of the result of concatenating Z(A) and M. M is the original message to be signed. Z(A) is the hash value of user A, as defined in GB/T 32918.2.'."\n"
."\n"
.'This topic provides an example of how to use an asymmetric key with the key ID `5c438b18-05be-40ad-b6c2-3be6752c****` and the key version ID `2ab1a983-7072-4bbc-a582-584b5bd8****` to sign the digest `ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****=` using the `RSA_PSS_SHA_256` signature algorithm.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'AsymmetricVerify' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54537',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique identifier (GUID) of the customer master key (CMK).'."\n"
."\n"
.'> You can also specify the alias that is bound to the CMK. For more information, see [Overview of aliases](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
],
[
'name' => 'KeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key version. The ID must be the GUID of the key version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => ['description' => 'The signature algorithm.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSA_PSS_SHA_256', 'title' => ''],
],
[
'name' => 'Digest',
'in' => 'query',
'schema' => ['description' => 'The digest that is generated using the hash algorithm that corresponds to the value of **Algorithm** to hash the original message.'."\n"
."\n"
.'> The value is Base64-encoded.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuy****=', 'title' => ''],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['description' => 'The signature value to be verified.'."\n"
."\n"
.'> The value is Base64-encoded.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq****==', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run.'."\n"
."\n"
.'- true: performs a dry run.'."\n"
."\n"
.'- false (default): does not perform a dry run.'."\n"
."\n"
.'A dry run is used to test API calls and verify whether you have the permissions to access the specified resources and whether the request parameters are valid. If you perform a dry run, KMS always returns a failure response that indicates the cause of the failure. The following failure causes are included:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter is not specified.'."\n"
."\n"
.'- ValidationError: The specified parameters in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version that is used for signature verification.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The GUID of the CMK.'."\n"
."\n"
.'> If you use an alias of the CMK in the request, the ID of the CMK is returned.', 'type' => 'string', 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
'Value' => ['description' => 'Indicates whether the signature is valid.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"5c438b18-05be-40ad-b6c2-3be6752c****\\",\\n \\"Value\\": true,\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\"\\n}","type":"json"}]',
'title' => 'AsymmetricVerify',
'summary' => 'Verifies a digital signature by using the public key of an asymmetric CMK.',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the access policy required for a RAM user or RAM role to call this API operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation can be called through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or through a VPC. To access KMS over the Internet, you must enable the public endpoint. For more information, see [Access KMS instances over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- If you use a shared gateway, the queries per second (QPS) limit for this operation is 200 for a single user. If you exceed this limit, API calls are throttled, which may impact your business. We recommend that you manage your call frequency to stay within the QPS limit.'."\n"
."\n"
.'- If you use a dedicated gateway, the QPS limit for this operation for a single user is determined by the computing performance specifications of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'This operation supports only asymmetric keys for which the **Usage** parameter is set to **SIGN/VERIFY**. The following table lists the supported signature algorithms.'."\n"
."\n"
.'| KeySpec | Algorithm | Description |'."\n"
.'| --------- | -------------------- | ---------------------------------------------------------- |'."\n"
.'| RSA\\_2048 | RSA\\_PSS\\_SHA\\_256 | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 |'."\n"
.'| RSA\\_2048 | RSA\\_PKCS1\\_SHA\\_256 | RSASSA-PKCS1-v1\\_5 using SHA-256 |'."\n"
.'| RSA\\_3072 | RSA\\_PSS\\_SHA\\_256 | RSASSA-PSS using SHA-256 and MGF1 with SHA-256 |'."\n"
.'| RSA\\_3072 | RSA\\_PKCS1\\_SHA\\_256 | RSASSA-PKCS1-v1\\_5 using SHA-256 |'."\n"
.'| EC\\_P256 | ECDSA\\_SHA\\_256 | ECDSA on the P-256 Curve(secp256r1) with a SHA-256 digest |'."\n"
.'| EC\\_P256K | ECDSA\\_SHA\\_256 | ECDSA on the P-256K Curve(secp256k1) with a SHA-256 digest |'."\n"
.'| EC\\_SM2 | SM2DSA | SM2 elliptic curve digital signature algorithm |'."\n"
."\n"
.'> In accordance with the GBT32918 standard, when an SM2 signature is calculated, the value of the **Digest** parameter is not the SM3 hash value of the original message. Instead, the value is the SM3 hash value of the result generated by concatenating Z(A) and M. In this formula, M is the original message to be signed, and Z(A) is the hash value of user A as defined in GBT32918.'."\n"
."\n"
.'This topic provides an example of how to use an asymmetric key with the key ID \\`5c438b18-05be-40ad-b6c2-3be6752c\\*\\*\\*\\*\\` and the key version ID \\`2ab1a983-7072-4bbc-a582-584b5bd8\\*\\*\\*\\*\\` to verify the signature \\`M2CceNZH00ZgL9ED/ZHFp21YRAvYeZHknJUc207OCZ0N9wNn9As4z2bON3FF3je+1Nu+2+/8Zj50HpMTpzYpMp2R93cYmACCmhaYoKydxylbyGzJR8y9likZRCrkD38lRoS40aBBvv/6iRKzQuo9EGYVcel36cMNg00VmYNBy3pa1rwg3gA4l3cy6kjayZja1WGPkVhrVKsrJMdbpl0ApLjXKuD8rw1n1XLCwCUEL5eLPljTZaAveqdOFQOiZnZEGI27qIiZe7I1fN8tcz6anS/gTM7xRKE++5egEvRWlTQQTJeApnPSiUPA+8ZykNdelQsOQh5SrGoyI4A5pq\\*\\*\\*\\*==\\` for the digest \\`ZOyIygCyaOW6GjVnihtTFtIS9PNmskdyMlNKiuyjfzw=\\` using the RSA\\_PSS\\_SHA\\_256 signature algorithm.',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CancelKeyDeletion' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3da5b8cc-8107-40ac-a170-793cd181d7b7', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3da5b8cc-8107-40ac-a170-793cd181d7b7\\"\\n}","errorExample":""},{"type":"xml","example":"<CancelKeyDeletionResponse>\\n <RequestId>3da5b8cc-8107-40ac-a170-793cd181d7b7</RequestId>\\n</CancelKeyDeletionResponse>","errorExample":""}]',
'title' => 'CancelKeyDeletion',
'summary' => 'Cancels the deletion task of a CMK.',
'description' => 'If the deletion task of a CMK is canceled, the CMK returns to the Enabled state.'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'ConnectKmsInstance' => [
'summary' => 'Enables a Key Management Service (KMS) instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '190287',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
],
'parameters' => [
[
'name' => 'KmsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS instance that you want to enable.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kst-phzz64f722a1buamw0****', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The ID of the virtual private cloud (VPC) that is associated with the KMS instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-bp19z7cwmltad5dff****', 'title' => ''],
],
[
'name' => 'ZoneIds',
'in' => 'query',
'schema' => ['description' => 'The two zones for the KMS instance. Dual-zone deployment improves service availability and disaster recovery capabilities.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou-k,cn-hangzhou-j', 'title' => ''],
],
[
'name' => 'VSwitchIds',
'in' => 'query',
'schema' => ['description' => 'The vSwitch in the two zones. The vSwitch must have at least one available IP address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1i512amda6d10a0****', 'title' => ''],
],
[
'name' => 'KMProvider',
'in' => 'query',
'schema' => ['description' => 'The provider of the KMS instance. Set the value to Aliyun.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Aliyun', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response message.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'd3eca5c8-a856-4347-8eb6-e1898c3fda2e'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"d3eca5c8-a856-4347-8eb6-e1898c3fda2e\\"\\n}","errorExample":""},{"type":"xml","example":"<ConnectKmsInstanceResponse>\\n <RequestId>d3eca5c8-a856-4347-8eb6-e1898c3fda2e</RequestId>\\n</ConnectKmsInstanceResponse>","errorExample":""}]',
'title' => 'ConnectKmsInstance',
'description' => '### [](#)Limits'."\n"
."\n"
.'You can enable only instances of the software key management type. You cannot enable instances of the hardware key management type.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CreateAlias' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7906979c-8e06-46a2-be2d-68e3ccbc****', 'title' => ''],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => ['description' => 'The alias of the CMK.'."\n"
."\n"
.'The alias must be 1 to 255 characters in length and must contain the prefix `alias/`. The alias cannot be prefixed with the reserved word `alias/acs`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alias/example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1d2baaf3-d357-46c2-832e-13560c2bd9cd', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1d2baaf3-d357-46c2-832e-13560c2bd9cd\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAliasResponse>\\n <RequestId>1d2baaf3-d357-46c2-832e-13560c2bd9cd</RequestId>\\n</CreateAliasResponse>","errorExample":""}]',
'title' => 'CreateAlias',
'summary' => 'Creates an alias for a key.',
'description' => '* Each alias can be bound to only one CMK at a time.'."\n"
.'* The aliases of CMKs in the same region must be unique.'."\n"
."\n"
.'In this topic, an alias named `alias/example` is created for a CMK named `7906979c-8e06-46a2-be2d-68e3ccbc****`.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'CreateApplicationAccessPoint' => [
'summary' => 'Creates an application access point (AAP)',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '54651',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the AAP.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aap_test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the AAP.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aap description', 'title' => ''],
],
[
'name' => 'AuthenticationMethod',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The authentication method. Currently, only ClientKey is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ClientKey'],
],
[
'name' => 'Policies',
'in' => 'query',
'schema' => ['description' => 'The permission policy.'."\n"
."\n"
.'> You can bind up to three permission policies to each AAP.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'bcfefe15-46f0-44a3-bd96-3d422474b71a', 'title' => ''],
'Description' => ['description' => 'The description of the AAP.'."\n", 'type' => 'string', 'example' => 'aap description', 'title' => ''],
'Policies' => ['description' => 'The permission policy.'."\n", 'type' => 'string', 'example' => '["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]', 'title' => ''],
'Name' => ['description' => 'The name of the AAP.'."\n", 'type' => 'string', 'example' => 'aap_test', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the AAP.'."\n", 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test', 'title' => ''],
'AuthenticationMethod' => ['description' => 'The authentication method.'."\n", 'type' => 'string', 'example' => 'ClientKey', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
409 => [
['errorCode' => 'Rejected.ResourceExist', 'errorMessage' => 'The request was rejected because the resource already exists.', 'description' => 'The resource already exists.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"bcfefe15-46f0-44a3-bd96-3d422474b71a\\",\\n \\"Description\\": \\"aap description\\",\\n \\"Policies\\": \\"[\\\\\\"kst-hzz62ee817bvyyr5x****.efkd\\\\\\",\\\\\\"kst-hzz62ee817bvyyr5x****.eyyp\\\\\\"]\\",\\n \\"Name\\": \\"aap_test\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test\\",\\n \\"AuthenticationMethod\\": \\"ClientKey\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateApplicationAccessPointResponse>\\n <RequestId>bcfefe15-46f0-44a3-bd96-3d422474b71a</RequestId>\\n <Description>aap description</Description>\\n <Policies>[\\"kst-hzz62ee817bvyyr5x****.efkd\\",\\"kst-hzz62ee817bvyyr5x****.eyyp\\"]</Policies>\\n <Name>aap_test</Name>\\n <Arn>acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test</Arn>\\n <AuthenticationMethod>ClientKey</AuthenticationMethod>\\n</CreateApplicationAccessPointResponse>","errorExample":""}]',
'title' => 'CreateApplicationAccessPoint',
'description' => 'To perform cryptographic operations and retrieve secret values, self-managed applications must use a client key to access a Key Management Service (KMS) instance. The following process shows how to create a client key-based AAP:'."\n"
."\n"
.'1.Create a network access rule: You can configure the private IP addresses or private CIDR blocks that are allowed to access KMS. For more information, see [CreateNetworkRule](~~2539407~~).'."\n"
."\n"
.'2.Create a permission policy: You can configure the keys and secrets that are allowed to access and bind network access rules to the keys and secrets. For more information, see [CreatePolicy](~~2539454~~).'."\n"
."\n"
.'3.Create an AAP: You can configure an authentication method and bind a permission policy to an AAP. This topic describes how to create an AAP.'."\n"
."\n"
.'4.Create a client key: You can configure the encryption password and validity period of a client key and bind the client key to an AAP. For more information, see [CreateClientKey](~~2539509~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CreateClientKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '54635',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AapName',
'in' => 'query',
'schema' => ['description' => 'The operation that you want to perform. Set the value to **CreateClientKey**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aap_test', 'title' => ''],
],
[
'name' => 'Password',
'in' => 'query',
'schema' => ['description' => 'The name of the AAP.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bcfefe15-46f0****', 'title' => ''],
],
[
'name' => 'NotAfter',
'in' => 'query',
'schema' => ['description' => 'The encryption password of the client key.'."\n"
."\n"
.'The password must be 8 to 64 characters in length and must contain at least two of the following types: digits, letters, and special characters. Special characters include `~ ! @ # $ % ^ & * ? _ -`.'."\n", 'type' => 'string', 'required' => false, 'example' => '2028-08-31T17:14:33Z', 'title' => ''],
],
[
'name' => 'NotBefore',
'in' => 'query',
'schema' => ['description' => 'The end of the validity period of the client key.'."\n"
."\n"
.'Specify the time in the ISO 8601 standard. The time must be in UTC. The time must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n"
."\n"
.'> '."\n"
."\n"
.'* If you do not configure NotAfter, the default value is the time when the client key was created plus five years.'."\n"
.'* If you configure NotAfter, you must configure NotBefore.'."\n", 'type' => 'string', 'required' => false, 'example' => '2023-08-31T17:14:33Z', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The beginning of the validity period of the client key.'."\n"
."\n"
.'Specify the time in the ISO 8601 standard. The time must be in UTC. The time must be in the yyyy-MM-ddTHH:mm:ssZ format.'."\n"
."\n"
.'> '."\n"
."\n"
.'* If you do not configure NotBefore, the default value is the time when the client key was created.'."\n"
.'* If you configure NotBefore, you must configure NotAfter.'."\n", 'type' => 'string', 'example' => '2312e45f-b2fa-4c34-ad94-3eca50932916', 'title' => ''],
'ClientKeyId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'KAAP.66abf237-63f6-4625-b8cf-47e1086e****', 'title' => ''],
'KeyAlgorithm' => ['description' => 'The ID of the client key.'."\n", 'type' => 'string', 'example' => 'RSA_2048', 'title' => ''],
'PrivateKeyData' => ['description' => 'The algorithm that is used to encrypt the private key of the client key. Currently, only RSA\\_2048 is supported.'."\n", 'type' => 'string', 'example' => 'MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******', 'title' => ''],
'NotBefore' => ['description' => 'The private key of the client key.'."\n", 'type' => 'string', 'example' => '2023-08-31T17:14:33Z', 'title' => ''],
'NotAfter' => ['description' => 'The beginning of the validity period of the client key.'."\n", 'type' => 'string', 'example' => '2028-08-31T17:14:33Z', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2312e45f-b2fa-4c34-ad94-3eca50932916\\",\\n \\"ClientKeyId\\": \\"KAAP.66abf237-63f6-4625-b8cf-47e1086e****\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"PrivateKeyData\\": \\"MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******\\",\\n \\"NotBefore\\": \\"2023-08-31T17:14:33Z\\",\\n \\"NotAfter\\": \\"2028-08-31T17:14:33Z\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateClientKeyResponse>\\n <RequestId>2312e45f-b2fa-4c34-ad94-3eca50932916</RequestId>\\n <ClientKeyId>KAAP.66abf237-63f6-4625-b8cf-47e1086e****</ClientKeyId>\\n <KeyAlgorithm>RSA_2048</KeyAlgorithm>\\n <PrivateKeyData>MIIJqwIBAzCCCXcGCSqGSIb3DQEHAaCCCWgEgglkMIIJYDCCBBcGCSqGSIb3DQEHBqCCBAgwgg******</PrivateKeyData>\\n <NotBefore>2023-08-31T17:14:33Z</NotBefore>\\n <NotAfter>2028-08-31T17:14:33Z</NotAfter>\\n</CreateClientKeyResponse>","errorExample":""}]',
'title' => 'CreateClientKey',
'summary' => 'Creates a client key.',
'description' => 'To perform cryptographic operations and retrieve secret values, self-managed applications must use a client key to access a Key Management Service (KMS) instance. The following process shows how to create a client key-based application access point (AAP):'."\n"
."\n"
.'1.Create an access control rule: You can configure the private IP addresses or private CIDR blocks that are allowed to access a KMS instance. For more information, see [CreateNetworkRule](~~2539407~~).'."\n"
."\n"
.'2.Create a permission policy: You can configure the keys and secrets that are allowed to access and bind access control rules to the keys and secrets. For more information, see [CreatePolicy](~~2539454~~).'."\n"
."\n"
.'3.Create an AAP: You can configure an authentication method and bind a permission policy to an AAP. For more information, see [CreateApplicationAccessPoint](~~2539467~~).'."\n"
."\n"
.'4.Create a client key: You can configure the encryption password and validity period of a client key and bind the client key to an AAP.'."\n"
.'### Precautions'."\n"
.'A client key has a validity period. After a client key expires, applications into which the client key is integrated cannot access the required KMS instance. You must replace the client key before the client key expires. We recommend that you delete the expired client key in KMS after the new client key is used.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CreateKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '54546',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the key.<br> The description can be 0 to 8,192 characters in length.<br>', 'type' => 'string', 'required' => false, 'example' => 'key description example', 'title' => ''],
],
[
'name' => 'KeyUsage',
'in' => 'query',
'schema' => ['description' => 'The usage of the key. Valid values:'."\n"
."\n"
.'- ENCRYPT/DECRYPT: encrypts and decrypts data.'."\n"
."\n"
.'- SIGN/VERIFY: generates and verifies digital signatures.'."\n"
."\n"
.'Default value: If the key supports signature verification, the default value is SIGN/VERIFY. Otherwise, the default value is ENCRYPT/DECRYPT.', 'type' => 'string', 'required' => false, 'default' => 'ENCRYPT/DECRYPT', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''],
],
[
'name' => 'Origin',
'in' => 'query',
'schema' => ['description' => 'The source of the key material. Valid values:'."\n"
."\n"
.'- Aliyun\\_KMS (default): The key material is generated by Alibaba Cloud KMS.'."\n"
."\n"
.'- EXTERNAL: The key material is imported.'."\n"
."\n"
.'> * The value is case-sensitive.'."\n"
."\n"
.'- If you set this parameter to EXTERNAL, import key material. For more information, see [Import key material for a symmetric key](~~607841~~) or [Import key material for an asymmetric key](~~608827~~).', 'type' => 'string', 'required' => false, 'example' => 'Aliyun_KMS', 'title' => ''],
],
[
'name' => 'ProtectionLevel',
'in' => 'query',
'schema' => ['description' => 'You do not need to specify this parameter. KMS automatically sets an appropriate protection level for your key.'."\n"
."\n"
.'The protection level of the key. Valid values:'."\n"
."\n"
.'- SOFTWARE'."\n"
."\n"
.'- HSM'."\n"
."\n"
.'> * If you specify DKMSInstanceId, this parameter is ignored. If the instance is a software key management instance, the protection level is SOFTWARE. If the instance is a hardware key management instance, the protection level is HSM.'."\n"
."\n"
.'- If you do not specify DKMSInstanceId, leave this parameter empty. KMS sets the protection level. If a managed HSM is available in the region, KMS sets this parameter to HSM. Otherwise, KMS sets this parameter to SOFTWARE. For more information, see [Managed HSM overview](~~125803~~).', 'type' => 'string', 'required' => false, 'example' => 'SOFTWARE', 'title' => ''],
],
[
'name' => 'EnableAutomaticRotation',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable automatic key rotation. Valid values:'."\n"
."\n"
.'- true: enables automatic key rotation.'."\n"
."\n"
.'- false (default): disables automatic key rotation.'."\n"
."\n"
.'This parameter is valid only when the key management type of the key supports automatic rotation. For more information, see [Key rotation](~~2358146~~).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RotationInterval',
'in' => 'query',
'schema' => ['description' => 'The automatic rotation period. The format is \\`integer\\[unit]\\`. \\`integer\\` indicates the length of the period. \\`unit\\` indicates the unit of time. Valid units: d (day), h (hour), m (minute), and s (second). For example, both 7d and 604800s represent a period of 7 days.'."\n"
."\n"
.'- If the key is a default key, the value is 365d.'."\n"
."\n"
.'- If the key is a software-protected key, the value can be from 7d to 365d.'."\n"
."\n"
.'- If the key is a hardware-protected key, automatic rotation is not supported.'."\n"
."\n"
.'> This parameter is required if you set EnableAutomaticRotation to true.', 'type' => 'string', 'required' => false, 'example' => '365d', 'title' => ''],
],
[
'name' => 'KeySpec',
'in' => 'query',
'schema' => ['description' => 'The specification of the key. The valid values vary based on the key management type. For more information about key specifications, supported standards, and algorithms, see [Key management types and key specifications](~~480161~~).'."\n"
."\n"
.'> If you do not specify this parameter, the key specification is Aliyun\\_AES\\_256 by default.', 'type' => 'string', 'required' => false, 'example' => 'Aliyun_AES_256', 'title' => ''],
],
[
'name' => 'DKMSInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS instance.'."\n"
."\n"
.'> This parameter is required when you create a key for a KMS instance. This parameter is not required when you create a default key (master key).', 'type' => 'string', 'required' => false, 'example' => 'kst-bjj62d8f5e0sgtx8h****', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The tags to bind to the key. Each tag consists of a key-value pair (Key:Value), which includes a tag key and a tag value.'."\n"
."\n"
.'Specify a maximum of 20 tags. To specify multiple tags, use the following format: `[{"TagKey":"key1","TagValue":"value1"},{"TagKey":"key2","TagValue":"value2"},...]`.'."\n"
."\n"
.'Each tag key and tag value can be up to 128 characters in length and can contain uppercase letters, lowercase letters, digits, forward slashes (/), backslashes (\\), underscores (\\_), hyphens (-), periods (.), plus signs (+), equal signs (=), colons (:), and at signs (@).'."\n"
."\n"
.'> The tag key cannot start with aliyun or acs:.', 'type' => 'string', 'required' => false, 'example' => '[{"TagKey":"disk-encryption","TagValue":"true"}]', 'title' => ''],
],
[
'name' => 'Policy',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The content of the key policy. The value is in the JSON format. The policy can be up to 32,768 bytes in length. For more information about key policies, see [Key policy overview](~~2716468~~). If you do not specify this parameter, the default credential policy is used.'."\n"
."\n"
.'A key policy contains the following content:'."\n"
."\n"
.'- Version: The version of the key policy. Only version 1 is supported.'."\n"
."\n"
.'- Statement: The statements of the key policy. Each key policy contains one or more statements.'."\n"
."\n"
.'The following is the format of a key policy:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Version": "1",'."\n"
.' "Statement": ['."\n"
.' {'."\n"
.' "Sid": "Enable RAM User Permissions",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "RAM": ["acs:ram::112890462****:root"]'."\n"
.' },'."\n"
.' "Action": ['."\n"
.' "kms:*"'."\n"
.' ],'."\n"
.' "Resource": ['."\n"
.' "*"'."\n"
.' ],'."\n"
.' "Condition": {'."\n"
.' "condition operator": {'."\n"
.' "condition key": "condition value"'."\n"
.' }'."\n"
.' }'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'Details about a statement:'."\n"
."\n"
.'- Sid: (Optional) The custom statement identifier. The identifier can be up to 128 characters in length and can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), and special characters, including underscores (\\_), forward slashes (/), plus signs (+), equal signs (=), periods (.), at signs (@), and hyphens (-).'."\n"
."\n"
.'- Effect: (Required) The effect of the policy statement. Valid values: Allow and Deny.'."\n"
."\n"
.'- Principal: (Required) The principal to which the permission is granted. Set this parameter to the current Alibaba Cloud account (the Alibaba Cloud account to which the key belongs), a RAM user or RAM role of the current Alibaba Cloud account, or a RAM user or RAM role of another Alibaba Cloud account.'."\n"
."\n"
.'- Action: (Required) The API operations that are allowed or denied. The value must start with "kms:". For a list of supported operations, see [Key policy overview](~~2716468~~). If you specify an operation that is not in the list, the setting does not take effect.'."\n"
."\n"
.'- Resource: (Required) The value can only be \\*, which indicates the current KMS key.'."\n"
."\n"
.'- Condition: (Optional) The conditions for the authorization to take effect. Use conditions to evaluate the context of an API request to determine whether to apply the policy statement. The format is `"Condition": {"condition operator": {"condition key": "condition value"}}`. For more information, see [Key policy overview](~~2716468~~).'."\n"
."\n"
.'> After granting permissions to a RAM user or RAM role of another Alibaba Cloud account, use that account to grant the RAM user or RAM role permissions to use the key in the RAM console. The RAM user or RAM role can use the key only after this is complete. For more information, see [Custom policies for Key Management Service](~~480682~~), [Grant permissions to a RAM user](~~116146~~), and [Grant permissions to a RAM role](~~116147~~).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"Statement":[{"Action":["kms:*"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:*"]},"Resource":["*"],"Sid":"kms default key policy"},{"Action":["kms:List*","kms:Describe*","kms:Create*","kms:Enable*","kms:Disable*","kms:Get*","kms:Set*","kms:Update*","kms:Delete*","kms:Cancel*","kms:TagResource","kms:UntagResource","kms:ImportKeyMaterial","kms:ScheduleKeyDeletion"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:user/for_test_policy"]},"Resource":["*"]}],"Version":"1"}'],
],
[
'name' => 'KeyStorageMechanism',
'in' => 'query',
'schema' => ['description' => 'The key storage location. This parameter is valid only when DKMSInstanceId is specified for a hardware key management instance. Valid values:'."\n"
."\n"
.'- HsmInternal (default): The key is stored in an HSM and does not support rotation.'."\n"
."\n"
.'- HsmEncryptedDatabase: The key is stored in a database.'."\n"
."\n"
.' - Symmetric keys: Rotation is supported.'."\n"
."\n"
.' - Asymmetric keys: Rotation is not supported.', 'type' => 'string', 'required' => false, 'example' => 'HsmInternal', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a globally unique identifier (GUID) generated by Alibaba Cloud for the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '381D5D33-BB8F-395F-8EE4-AE3BB4B523C4', 'title' => ''],
'KeyMetadata' => [
'description' => 'The metadata of the key.',
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The globally unique identifier (GUID) of the key.', 'type' => 'string', 'example' => 'key-hzz62f1cb66fa42qo****', 'title' => ''],
'NextRotationDate' => ['description' => 'The time when the next rotation is scheduled.'."\n"
."\n"
.'This parameter is returned only when the value of AutomaticRotation is Enabled or Suspended.', 'type' => 'string', 'example' => '2024-03-25T10:00:00Z', 'title' => ''],
'KeyState' => ['description' => 'The status of the key.<br> For more information, see [Impact of CMK status on API calls](~~44211~~).<br>', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'RotationInterval' => ['description' => 'The automatic rotation period of the key. The value is in seconds. The value is an integer followed by the character s. For example, a rotation period of 7 days is 604800s.'."\n"
."\n"
.'This parameter is returned only when the value of AutomaticRotation is Enabled or Suspended.', 'type' => 'string', 'example' => '31536000s', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the key.', 'type' => 'string', 'example' => 'acs:kms:cn-qingdao:154035569884****:key/key-hzz62f1cb66fa42qo****', 'title' => ''],
'Creator' => ['description' => 'The creator of the key.', 'type' => 'string', 'example' => '154035569884****', 'title' => ''],
'LastRotationDate' => ['description' => 'The time when the last rotation was performed. The time is in UTC.<br> If the key is new, this value is the generation time of the initial key version.<br>', 'type' => 'string', 'example' => '2023-03-25T10:00:00Z', 'title' => ''],
'DeleteDate' => ['description' => 'The scheduled time to delete the key. For more information, see [ScheduleKeyDeletion](~~601417~~) .'."\n"
."\n"
.'This parameter is returned only when the value of KeyState is PendingDeletion.', 'type' => 'string', 'example' => '2025-03-25T10:00:00Z', 'title' => ''],
'PrimaryKeyVersion' => ['description' => 'The ID of the current primary version of the key.', 'type' => 'string', 'example' => '7ce1d081-06cb-42e6-aab6-5c5de030****', 'title' => ''],
'Description' => ['description' => 'The description of the key.', 'type' => 'string', 'example' => 'key description example', 'title' => ''],
'KeySpec' => ['description' => 'The specification of the key.', 'type' => 'string', 'example' => 'Aliyun_AES_256', 'title' => ''],
'Origin' => ['description' => 'The source of the key material.', 'type' => 'string', 'example' => 'Aliyun_KMS', 'title' => ''],
'MaterialExpireTime' => ['description' => 'The expiration time of the key material. The time is in UTC.<br> If this value is empty, the key material does not expire.<br>', 'type' => 'string', 'example' => '2025-03-25T10:00:00Z', 'title' => ''],
'AutomaticRotation' => ['description' => 'Indicates whether automatic key rotation is enabled. Valid values:'."\n"
."\n"
.'- Enabled: Automatic rotation is enabled.'."\n"
."\n"
.'- Disabled: Automatic rotation is disabled.'."\n"
."\n"
.'- Suspended: Automatic rotation is suspended.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'ProtectionLevel' => ['description' => 'The protection level of the key.', 'type' => 'string', 'example' => 'SOFTWARE', 'title' => ''],
'KeyUsage' => ['description' => 'The usage of the key.', 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''],
'CreationDate' => ['description' => 'The date and time when the key was created. The time is in UTC.', 'type' => 'string', 'example' => '2024-03-25T10:00:00Z', 'title' => ''],
'DKMSInstanceId' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'example' => 'kst-bjj62d8f5e0sgtx8h****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Rejected.LimitExceeded', 'errorMessage' => 'The request was rejected because user create resource limit was exceeded', 'description' => 'The request is rejected because the number of created resources reaches the upper limit.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'UnsupportedOperation', 'errorMessage' => 'This action is not supported.', 'description' => 'The operation is not supported.'],
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system.', 'description' => 'You are not authorized to perform this operation.'],
['errorCode' => 'Rejected.ShareQuotaExceedLimit', 'errorMessage' => 'Instance Share Quota Exceed Limit.', 'description' => 'The instance share quota exceeds the limit.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceNotFound', 'errorMessage' => 'The specified DKMS Instance is not found.', 'description' => 'Your dedicated KMS instance is not found.'],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => 'An internal error occurred.'],
],
503 => [
['errorCode' => 'SerivceUnvailableTemporary', 'errorMessage' => 'Service Unvailable Temporary', 'description' => 'The service is temporarily unavailable.'],
],
],
'title' => 'CreateKey',
'summary' => 'Creates a customer master key (CMK) for envelope encryption, digital signatures, or other cryptographic operations.',
'description' => '- For information about the access policies required for a RAM user or RAM role to call this OpenAPI operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Alibaba Cloud Key Management Service (KMS) supports common specifications for symmetric and asymmetric keys. For more information, see [Key management types and key specifications](~~480161~~).',
'requestParamsDescription' => 'For information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"381D5D33-BB8F-395F-8EE4-AE3BB4B523C4\\",\\n \\"KeyMetadata\\": {\\n \\"KeyId\\": \\"key-hzz62f1cb66fa42qo****\\",\\n \\"NextRotationDate\\": \\"2024-03-25T10:00:00Z\\",\\n \\"KeyState\\": \\"Enabled\\",\\n \\"RotationInterval\\": \\"31536000s\\",\\n \\"Arn\\": \\"acs:kms:cn-qingdao:154035569884****:key/key-hzz62f1cb66fa42qo****\\",\\n \\"Creator\\": \\"154035569884****\\",\\n \\"LastRotationDate\\": \\"2023-03-25T10:00:00Z\\",\\n \\"DeleteDate\\": \\"2025-03-25T10:00:00Z\\",\\n \\"PrimaryKeyVersion\\": \\"7ce1d081-06cb-42e6-aab6-5c5de030****\\",\\n \\"Description\\": \\"key description example\\",\\n \\"KeySpec\\": \\"Aliyun_AES_256\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"MaterialExpireTime\\": \\"2025-03-25T10:00:00Z\\",\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"ProtectionLevel\\": \\"SOFTWARE\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"CreationDate\\": \\"2024-03-25T10:00:00Z\\",\\n \\"DKMSInstanceId\\": \\"kst-bjj62d8f5e0sgtx8h****\\"\\n }\\n}","type":"json"}]',
],
'CreateKeyVersion' => [
'summary' => 'Creates a version for a customer master key (CMK).',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.'."\n"
."\n"
.'> You can also set the value to an alias that is bound to the CMK. For more information, see [Overview of aliases](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz62f1cb66fa42qo***', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'b96f250a-4b75-498c-91be-22c6928f85be', 'title' => ''],
'KeyVersion' => [
'description' => 'The metadata of the version.',
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The ID of the CMK. The ID must be globally unique.', 'type' => 'string', 'example' => 'key-hzz62f1cb66fa42qo****', 'title' => ''],
'KeyVersionId' => ['description' => 'The ID of the version.', 'type' => 'string', 'example' => 'key-hzz62f1cb66fa42qo****-20v29b****', 'title' => ''],
'CreationDate' => ['description' => 'The date and time when the version was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2023-07-02T10:38:27Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Rejected.UnsupportedOperation', 'errorMessage' => 'Unsupported operation.', 'description' => 'The operation is not supported.'],
],
404 => [
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
409 => [
['errorCode' => 'Rejected.Disabled', 'errorMessage' => 'The request was rejected because the key state is Disabled.', 'description' => 'The request was rejected because the key state is Disabled.'],
['errorCode' => 'Rejected.Unavailable', 'errorMessage' => 'The request was rejected because the key state is Unavailable.', 'description' => 'The request was denied because the key status is unavailable.'],
['errorCode' => 'Rejected.PendingDeletion', 'errorMessage' => 'The request was rejected because the key state is PendingDeletion.', 'description' => 'The request was rejected because the key state is PendingDeletion.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"b96f250a-4b75-498c-91be-22c6928f85be\\",\\n \\"KeyVersion\\": {\\n \\"KeyId\\": \\"key-hzz62f1cb66fa42qo****\\",\\n \\"KeyVersionId\\": \\"key-hzz62f1cb66fa42qo****-20v29b****\\",\\n \\"CreationDate\\": \\"2023-07-02T10:38:27Z\\"\\n }\\n}","type":"json"}]',
'title' => 'CreateKeyVersion',
'description' => '- You can create a version only for an asymmetric CMK that is in the Enabled state. You can call the [CreateKey](~~28947~~) operation to create an asymmetric CMK and the [DescribeKey](~~28952~~) operation to query the status of the CMK. The status is specified by the KeyState parameter.'."\n"
."\n"
.'- The minimum interval for creating a version of the same CMK is seven days. You can call the [DescribeKey](~~28952~~) operation to query the time when the last version of a CMK was created. The time is specified by the LastRotationDate parameter.'."\n"
."\n"
.'- If a CMK is in a private key store, you cannot create a version for the CMK.'."\n"
."\n"
.'- You can create a maximum of 50 versions for a CMK in the same region.'."\n"
."\n"
.'You can create a version for the CMK whose ID is `0b30658a-ed1a-4922-b8f7-a673ca9c****` by using the parameter settings provided in this topic.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CreateNetworkRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '54653',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the access control rule.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'networkrule_test'],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The network type.'."\n"
."\n"
.'Only private IP addresses are supported. Set the value to Private.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Private'],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'networkrule description', 'title' => ''],
],
[
'name' => 'SourcePrivateIp',
'in' => 'query',
'schema' => ['description' => 'The private IP address or private CIDR block. Separate multiple items with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '["192.10.XX.XX","192.168.XX.XX/24"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The network type.'."\n", 'type' => 'string', 'example' => 'Private', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3bf02f7a-015b-4f93-be0f-cc043fda2dd3', 'title' => ''],
'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'networkrule description', 'title' => ''],
'SourcePrivateIp' => ['description' => 'The private IP address or private CIDR block.'."\n", 'type' => 'string', 'example' => '["192.10.XX.XX","192.168.XX.XX/24"]', 'title' => ''],
'Name' => ['description' => 'The name of the access control rule.'."\n", 'type' => 'string', 'example' => 'networkrule_test', 'title' => ''],
'Arn' => ['description' => 'The ARN of the access control rule.'."\n", 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:119285303511****:network/networkrule_test', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Type\\": \\"Private\\",\\n \\"RequestId\\": \\"3bf02f7a-015b-4f93-be0f-cc043fda2dd3\\",\\n \\"Description\\": \\"networkrule description\\",\\n \\"SourcePrivateIp\\": \\"[\\\\\\"192.10.XX.XX\\\\\\",\\\\\\"192.168.XX.XX/24\\\\\\"]\\",\\n \\"Name\\": \\"networkrule_test\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:119285303511****:network/networkrule_test\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateNetworkRuleResponse>\\n <Type>Private</Type>\\n <RequestId>3bf02f7a-015b-4f93-be0f-cc043fda2dd3</RequestId>\\n <Description>networkrule description</Description>\\n <SourcePrivateIp>[\\"192.10.XX.XX\\",\\"192.168.XX.XX/24\\"]</SourcePrivateIp>\\n <Name>networkrule_test</Name>\\n <Arn>acs:kms:cn-hangzhou:119285303511****:network/networkrule_test</Arn>\\n</CreateNetworkRuleResponse>","errorExample":""}]',
'title' => 'CreateNetworkRule',
'summary' => 'Creates a network access rule to configure the private IP addresses or private CIDR blocks that are allowed to access a Key Management Service (KMS) instance.',
'description' => 'To perform cryptographic operations and retrieve secret values, self-managed applications must use a client key to access a KMS instance. The following process shows how to create a client key-based application access point (AAP):'."\n"
."\n"
.'1.Create an access control rule: You can configure the private IP addresses or private CIDR blocks that are allowed to access a KMS instance.'."\n"
."\n"
.'2.Create a permission policy: You can configure the keys and secrets that are allowed to access and bind access control rules to the keys and secrets. For more information, see [CreatePolicy](~~2539454~~).'."\n"
."\n"
.'3.Create an AAP: You can configure an authentication method and bind a permission policy to an AAP. For more information, see [CreateApplicationAccessPoint](~~2539467~~).'."\n"
."\n"
.'4.Create a client key: You can configure the encryption password and validity period of a client key and bind the client key to an AAP. For more information, see [CreateClientKey](~~2539509~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CreatePolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '54642',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the permission policy.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'policy_test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'policy description', 'title' => ''],
],
[
'name' => 'KmsInstance',
'in' => 'query',
'schema' => ['description' => 'The scope of the permission policy. You need to specify the KMS instance that you want to access.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kst-hzz634e67d126u9p9****', 'title' => ''],
],
[
'name' => 'Permissions',
'in' => 'query',
'schema' => ['description' => 'The operations that can be performed. Valid values:'."\n"
."\n"
.'* RbacPermission/Template/CryptoServiceKeyUser: allows you to perform cryptographic operations.'."\n"
.'* RbacPermission/Template/CryptoServiceSecretUser: allows you to perform secret-related operations.'."\n"
."\n"
.'You can select both.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["RbacPermission/Template/CryptoServiceKeyUser", "RbacPermission/Template/CryptoServiceSecretUser"]', 'title' => ''],
],
[
'name' => 'Resources',
'in' => 'query',
'schema' => ['description' => 'The key and secret that are allowed to access.'."\n"
."\n"
.'* Key: Enter a key in the `key/${KeyId}` format. To allow access to all keys of a KMS instance, enter key/\\*.'."\n"
.'* Secret: Enter a secret in the `secret/${SecretName}` format. To allow access to all secrets of a KMS instance, enter secret/\\*.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["secret/acs/ram/user/ram-secret", "secret/acs/ram/user/acr-master", "key/key-hzz63d9c8d3dfv8cv****"]', 'title' => ''],
],
[
'name' => 'AccessControlRules',
'in' => 'query',
'schema' => ['description' => 'The name of the access control rule.'."\n"
."\n"
.'> For more information about how to query created access control rules, see [ListNetworkRules](~~2539433~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '{"NetworkRules":["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3bf02f7a-015b-4f34-be0f-c4543fda2d33', 'title' => ''],
'Arn' => ['description' => 'The ARN of the permission policy.'."\n", 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:119285303511****:policy/policy_test', 'title' => ''],
'Name' => ['description' => 'The name of the permission policy.'."\n", 'type' => 'string', 'example' => 'policy_test', 'title' => ''],
'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'policy description', 'title' => ''],
'KmsInstance' => ['description' => 'The scope of the permission policy.'."\n", 'type' => 'string', 'example' => 'kst-hzz634e67d126u9p9****', 'title' => ''],
'Permissions' => ['description' => 'The operations that can be performed.'."\n", 'type' => 'string', 'example' => '["RbacPermission/Template/CryptoServiceKeyUser", "RbacPermission/Template/CryptoServiceSecretUser"]', 'title' => ''],
'Resources' => ['description' => 'The key and secret that are allowed to access.'."\n"
."\n"
.'* `key/*` indicates that all keys of the KMS instance can be accessed.'."\n"
.'* `secret/*` indicates all secrets of the KMS instance can be accessed.'."\n", 'type' => 'string', 'example' => '["secret/acs/ram/user/ram-secret", "secret/acs/ram/user/acr-master", "key/key-hzz63d9c8d3dfv8cv****"]', 'title' => ''],
'AccessControlRules' => ['description' => 'The name of the access control rule.'."\n", 'type' => 'string', 'example' => '{"NetworkRules":["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]}', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3bf02f7a-015b-4f34-be0f-c4543fda2d33\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:119285303511****:policy/policy_test\\",\\n \\"Name\\": \\"policy_test\\",\\n \\"Description\\": \\"policy description\\",\\n \\"KmsInstance\\": \\"kst-hzz634e67d126u9p9****\\",\\n \\"Permissions\\": \\"[\\\\\\"RbacPermission/Template/CryptoServiceKeyUser\\\\\\", \\\\\\"RbacPermission/Template/CryptoServiceSecretUser\\\\\\"]\\",\\n \\"Resources\\": \\"[\\\\\\"secret/acs/ram/user/ram-secret\\\\\\", \\\\\\"secret/acs/ram/user/acr-master\\\\\\", \\\\\\"key/key-hzz63d9c8d3dfv8cv****\\\\\\"]\\",\\n \\"AccessControlRules\\": \\"{\\\\\\"NetworkRules\\\\\\":[\\\\\\"kst-hzz62ee817bvyyr5x****.efkd\\\\\\",\\\\\\"kst-hzz62ee817bvyyr5x****.eyyp\\\\\\"]}\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePolicyResponse>\\n <RequestId>3bf02f7a-015b-4f34-be0f-c4543fda2d33</RequestId>\\n <Arn>acs:kms:cn-hangzhou:119285303511****:policy/policy_test</Arn>\\n <Name>policy_test</Name>\\n <Description>policy description</Description>\\n <KmsInstance>kst-hzz634e67d126u9p9****</KmsInstance>\\n <Permissions>[\\"RbacPermission/Template/CryptoServiceKeyUser\\", \\"RbacPermission/Template/CryptoServiceSecretUser\\"]</Permissions>\\n <Resources>[\\"secret/acs/ram/user/ram-secret\\", \\"secret/acs/ram/user/acr-master\\", \\"key/key-hzz63d9c8d3dfv8cv****\\"]</Resources>\\n <AccessControlRules>{\\"NetworkRules\\":[\\"kst-hzz62ee817bvyyr5x****.efkd\\",\\"kst-hzz62ee817bvyyr5x****.eyyp\\"]}</AccessControlRules>\\n</CreatePolicyResponse>","errorExample":""}]',
'title' => 'CreatePolicy',
'summary' => 'Creates a permission policy to configure the keys and secrets that are allowed to access.',
'description' => 'To perform cryptographic operations and retrieve secret values, self-managed applications must use a client key to access a Key Management Service (KMS) instance. The following process shows how to create a client key-based application access point (AAP):'."\n"
."\n"
.'1.Create an access control rule: You can configure the private IP addresses or private CIDR blocks that are allowed to access a KMS instance. For more information, see [CreateNetworkRule](~~2539407~~).'."\n"
."\n"
.'2.Create a permission policy: You can configure the keys and secrets that are allowed to access and bind access control rules to the keys and secrets.'."\n"
."\n"
.'3.Create an AAP: You can configure an authentication method and bind a permission policy to an AAP. For more information, see [CreateApplicationAccessPoint](~~2539467~~).'."\n"
."\n"
.'4.Create a client key: You can configure the encryption password and validity period of a client key and bind the client key to an AAP. For more information, see [CreateClientKey](~~2539509~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'CreateSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '54548',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret. The name must be unique in the same region.'."\n"
.'The name can be up to 192 characters in length and can contain letters, digits, underscores (\\_), forward slashes (/), plus signs (+), equal signs (=), periods (.), hyphens (-), and at signs (@). The following limits apply to secret names for different types of secrets:'."\n"
."\n"
.'- If SecretType is set to Generic, Rds, or Redis, the name cannot start with `acs/`.'."\n"
."\n"
.'- If SecretType is set to RAMCredentials, set this parameter to the fixed value `$Auto`. In this case, KMS automatically generates a secret name that starts with `acs/ram/user/` and contains the display name of the RAM user.'."\n"
."\n"
.'- If SecretType is set to ECS, the name must start with `acs/ecs/`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mydbconninfo', 'title' => ''],
],
[
'name' => 'VersionId',
'in' => 'query',
'schema' => ['description' => 'The version number of the initial version. The version number must be unique within the secret.'."\n"
.'The version number can be up to 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v1', 'title' => ''],
],
[
'name' => 'EncryptionKeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key used to encrypt the secret value.'."\n"
."\n"
.'> The key and the secret must be in the same KMS instance. The key must be a symmetric key.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => '', 'example' => 'key-gzz63ff0db5hg3qje****', 'title' => ''],
],
[
'name' => 'SecretData',
'in' => 'query',
'schema' => ['description' => 'The value of the secret. The value can be up to 30,720 bytes (30 KB) in length. KMS encrypts the secret value with the specified key and stores the encrypted value in the initial version.'."\n"
."\n"
.'- If SecretType is set to Generic, you can specify a custom secret value.'."\n"
."\n"
.'- If SecretType is set to Rds, the secret value must be in the following format: `{"Accounts":[{"AccountName":"","AccountPassword":""}]}`. In the format, `AccountName` specifies the username of the account for the RDS instance and `AccountPassword` specifies the password of the account.'."\n"
."\n"
.'- If SecretType is set to Redis, set this parameter to `$Auto`.'."\n"
."\n"
.'- If SecretType is set to RAMCredentials, the secret value must be in the following format: `{"AccessKeys":[{"AccessKeyId":"","AccessKeySecret":""}]}`. In the format, `AccessKeyId` specifies the AccessKey ID and `AccessKeySecret` specifies the AccessKey secret. You must specify all AccessKey pairs of the RAM user.'."\n"
."\n"
.'- If SecretType is set to PolarDB, set this parameter to `$Auto`.'."\n"
."\n"
.'- If SecretType is set to ECS, the secret value must be in one of the following formats:'."\n"
."\n"
.' - If SecretSubType in the ExtendedConfig parameter is set to Password: `{"UserName":"","Password": ""}`. In the format, `UserName` specifies the username used to log on to the ECS instance and `Password` specifies the password used to log on to the ECS instance.'."\n"
."\n"
.' - If SecretSubType in the ExtendedConfig parameter is set to SSHKey: `{"UserName":"","PublicKey": "", "PrivateKey": ""}`. In the format, `PublicKey` specifies the SSH-formatted public key used to log on to the ECS instance and `PrivateKey` specifies the private key used to log on to the ECS instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"Accounts":[{"AccountName":"user1","AccountPassword":"****"}]}', 'title' => ''],
],
[
'name' => 'SecretDataType',
'in' => 'query',
'schema' => [
'description' => 'The type of the secret value. Valid values:'."\n"
."\n"
.'- text (default): The secret value is a text string.'."\n"
."\n"
.'- binary: The secret value is a binary string.'."\n"
."\n"
.'> If SecretType is set to Rds, Redis, PolarDB, RAMCredentials, or ECS, SecretDataType must be set to text.',
'type' => 'string',
'required' => false,
'docRequired' => false,
'default' => 'text',
'enum' => ['text', 'binary'],
'example' => 'text',
'title' => '',
],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the secret.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'mydbinfo', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => 'The tags of the secret. Each tag consists of a key-value pair. A tag consists of a tag key and a tag value.'."\n"
."\n"
.'The tag key and tag value can be up to 128 characters in length and can contain letters, digits, forward slashes (/), backslashes (\\), underscores (\\_), hyphens (-), periods (.), plus signs (+), equal signs (=), colons (:), and at signs (@).'."\n"
."\n"
.'- The tag key cannot start with aliyun or acs:.'."\n"
."\n"
.'- You can specify up to 20 key-value pairs for each secret.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{\\"TagKey\\":\\"key1\\",\\"TagValue\\":\\"val1\\"},{\\"TagKey\\":\\"key2\\",\\"TagValue\\":\\"val2\\"}]', 'title' => ''],
],
[
'name' => 'SecretType',
'in' => 'query',
'schema' => ['description' => 'The type of the secret. Valid values:'."\n"
."\n"
.'- Generic (default): a generic secret.'."\n"
."\n"
.'- Rds: an RDS secret.'."\n"
."\n"
.'- Redis: a Redis secret.'."\n"
."\n"
.'- RAMCredentials: a RAM secret.'."\n"
."\n"
.'- ECS: an ECS secret.'."\n"
."\n"
.'- PolarDB: a PolarDB secret.', 'type' => 'string', 'required' => false, 'example' => 'Rds', 'title' => ''],
],
[
'name' => 'ExtendedConfig',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The extended configuration of the secret. This parameter specifies the properties of the secret of a specific type. The value can be up to 1,024 characters in length.'."\n"
."\n"
.'- If SecretType is set to Generic, this parameter is ignored.'."\n"
."\n"
.'- If SecretType is set to Rds, you must specify the following parameters in ExtendedConfig:'."\n"
."\n"
.' - SecretSubType (Required): The subtype of the secret. Valid values:'."\n"
."\n"
.' - SingleUser: Secrets Manager manages the RDS secret in single-account mode. When the secret is rotated, the password of the specified account is reset to a new random password.'."\n"
."\n"
.' - DoubleUsers: Secrets Manager manages the RDS secret in double-account mode. ACSCurrent and ACSPrevious point to one of the accounts. When the secret is rotated, the password of the account pointed to by ACSPrevious is reset to a new random password. Then, Secrets Manager swaps the accounts that ACSCurrent and ACSPrevious point to.'."\n"
."\n"
.' - DBInstanceId (Required): The ID of the RDS instance to which the account belongs.'."\n"
."\n"
.' - CustomData (Optional): The custom data. The value is a key-value pair in the JSON format. You can specify up to 10 key-value pairs. Separate multiple key-value pairs with commas (,). Example: `{"Key1": "v1", "fds":"fdsf"}`. The default value is `{}`.'."\n"
."\n"
.'- If SecretType is set to Redis, you must specify the following parameters in ExtendedConfig:'."\n"
."\n"
.' - SecretSubType (Required): The subtype of the secret. Valid values:'."\n"
."\n"
.' - DoubleUsers: Secrets Manager manages the Redis secret in double-account mode. ACSCurrent and ACSPrevious point to one of the accounts. When the secret is rotated, the password of the account pointed to by ACSPrevious is reset to a new random password. Then, Secrets Manager swaps the accounts that ACSCurrent and ACSPrevious point to.'."\n"
."\n"
.' - AccountName (Required): The database username.'."\n"
."\n"
.' - CloneAccountName (Required): The database username, which is the value of AccountName with the `_clone` suffix.'."\n"
."\n"
.' - AccountPrivilege (Required): The permissions to access the database.'."\n"
."\n"
.' - InstanceId (Required): The ID of the Redis instance.'."\n"
."\n"
.' - RegionId (Required): The ID of the region where the Redis instance resides.'."\n"
."\n"
.' - CustomData (Optional): The custom data. The value is a key-value pair in the JSON format. You can specify up to 10 key-value pairs. Separate multiple key-value pairs with commas (,). Example: `{"Key1": "v1", "fds":"fdsf"}`. The default value is `{}`.'."\n"
."\n"
.'- If SecretType is set to RAMCredentials, you must specify the following parameters in ExtendedConfig:'."\n"
."\n"
.' - SecretSubType (Required): The subtype of the secret. The value is RamUserAccessKey.'."\n"
."\n"
.' - UserName (Required): The name of the RAM user.'."\n"
."\n"
.' - CustomData (Optional): The custom data. The value is a key-value pair in the JSON format. You can specify up to 10 key-value pairs. Separate multiple key-value pairs with commas (,). The default value is `{}`.'."\n"
."\n"
.'- If SecretType is set to ECS, you must specify the following parameters in ExtendedConfig:'."\n"
."\n"
.' - SecretSubType (Required): The subtype of the secret. Valid values:'."\n"
."\n"
.' - Password: an ECS password.'."\n"
."\n"
.' - SSHKey: an ECS SSH key pair.'."\n"
."\n"
.' - RegionId (Required): The ID of the region where the ECS instance resides.'."\n"
."\n"
.' - InstanceId (Required): The ID of the ECS instance.'."\n"
."\n"
.' - CustomData (Optional): The custom data. The value is a key-value pair in the JSON format. You can specify up to 10 key-value pairs. Separate multiple key-value pairs with commas (,). The default value is `{}`.'."\n"
."\n"
.'- If SecretType is set to PolarDB, you must specify the following parameters in ExtendedConfig:'."\n"
."\n"
.' - SecretSubType (Required): The fixed value is DoubleUsers.'."\n"
."\n"
.' - RegionId (Required): The region.'."\n"
."\n"
.' - DBClusterId (Required): The ID of the PolarDB instance.'."\n"
."\n"
.' - DBType (Required): MySQL or PostgreSQL.'."\n"
."\n"
.' - AccountName (Required): The account name.'."\n"
."\n"
.' - CloneAccountName: The value is AccountName\\_clone.'."\n"
."\n"
.' - AccountType: Only Normal is supported.'."\n"
."\n"
.' - AccountPrivilege: This parameter is available only for MySQL.'."\n"
."\n"
.' - DBName: This parameter is available only for MySQL.'."\n"
."\n"
.' - CustomData (Optional): The custom data. The value is a key-value pair in the JSON format. You can specify up to 10 key-value pairs. Separate multiple key-value pairs with commas (,). Example: {"Key1": "v1", "fds":"fdsf"}. The default value is {}.'."\n"
."\n"
.'> If SecretType is set to Rds, Redis, PolarDB, RAMCredentials, or ECS, you must configure this parameter.', 'type' => 'object', 'required' => false, 'example' => '{"SecretSubType":"SingleUser", "DBInstanceId":"rm-bp1b3dd3a506e****" ,"CustomData":{"Key1": "v1", "fds":"fdsf"}}', 'title' => ''],
],
[
'name' => 'EnableAutomaticRotation',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable automatic rotation. Valid values:'."\n"
."\n"
.'- true: enables automatic rotation.'."\n"
."\n"
.'- false (default): disables automatic rotation.'."\n"
."\n"
.'> This parameter is valid only if SecretType is set to Rds, PolarDB, Redis, RAMCredentials, or ECS. If SecretType is set to Generic, automatic rotation is not supported. You can call the [PutSecretValue](~~154503~~) operation to manually rotate the secret.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RotationInterval',
'in' => 'query',
'schema' => ['description' => 'The interval for automatic rotation. The value is in the range of 6 hours to 8,760 hours (365 days).<br>'."\n"
.'The value is in the `integer[unit]` format. `integer` indicates the interval. `unit` indicates the unit of time.<br>'."\n"
.'Valid values for unit: d (day), h (hour), m (minute), and s (second). For example, both 7d and 604,800s indicate a rotation interval of 7 days.<br><br>'."\n"
."\n"
.'> You must specify this parameter if you set EnableAutomaticRotation to true. You do not need to specify this parameter if you set EnableAutomaticRotation to false.', 'type' => 'string', 'required' => false, 'example' => '30d', 'title' => ''],
],
[
'name' => 'DKMSInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'required' => false, 'example' => 'kst-bjj62d8f5e0sgtx8h****', 'title' => ''],
],
[
'name' => 'Policy',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'The content of the secret policy. The value is in the JSON format. The value can be up to 32,768 bytes in length.'."\n"
."\n"
.'For more information about secret policies, see [Overview of secret policies](~~2716465~~). If you do not specify this parameter, the default secret policy is used.'."\n"
."\n"
.'A secret policy contains the following parts:'."\n"
."\n"
.'- Version: The version of the secret policy. Only 1 is supported.'."\n"
."\n"
.'- Statement: The statements of the secret policy. Each secret policy can contain one or more statements.'."\n"
."\n"
.'The following is the format of a secret policy:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Version": "1",'."\n"
.' "Statement": ['."\n"
.' {'."\n"
.' "Sid": "Enable RAM User Permissions",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "RAM": ["acs:ram::12345678****:*"]'."\n"
.' },'."\n"
.' "Action": ['."\n"
.' "kms:*"'."\n"
.' ],'."\n"
.' "Resource": ['."\n"
.' "*"'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'Details about a statement:'."\n"
."\n"
.'- Sid: (Optional) The custom identifier of the statement. The value can be up to 128 characters in length and can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), and special characters, including underscores (\\_), forward slashes (/), plus signs (+), equal signs (=), periods (.), at signs (@), and hyphens (-).'."\n"
."\n"
.'- Effect: (Required) The effect of the policy statement. Valid values: Allow and Deny.'."\n"
."\n"
.'- Principal: (Required) The principal that is authorized by the policy. You can specify the current Alibaba Cloud account (the account to which the secret belongs), a RAM user or RAM role of the current Alibaba Cloud account, or a RAM user or RAM role of another Alibaba Cloud account.'."\n"
."\n"
.'- Action: (Required) The API operations that are allowed or denied. The value must start with "kms:". For the list of supported operations, see [Overview of secret policies](~~2716465~~). If you specify an operation that is not in the list, the setting does not take effect.'."\n"
."\n"
.'- Resource: (Required) The resource. The value can only be \\*, which indicates the current KMS secret.'."\n"
."\n"
.'- Condition: (Optional) The conditions for the authorization to take effect. You can use conditions to evaluate the context of an API request to determine whether to apply the policy statement. The format is `"Condition": {"condition operator": {"condition key": "condition value"}}`. For more information, see [Overview of secret policies](~~2716465~~).'."\n"
."\n"
.'> After you grant permissions to a RAM user or RAM role of another Alibaba Cloud account, you must use the Alibaba Cloud account to which the RAM user or RAM role belongs to grant the RAM user or RAM role the permissions to use the secret in the RAM console. Then, the RAM user or RAM role can use the secret. For more information, see [Custom policies for KMS](~~480682~~), [Grant permissions to a RAM user](~~116146~~), and [Grant permissions to a RAM role](~~116147~~).', 'type' => 'string', 'required' => false, 'example' => '{"Version":"1","Statement": [{"Sid":"kms default secret policy","Effect":"Allow","Principal":{"RAM": ["acs:ram::119285303511****:*"]},"Action":["kms:*"],"Resource": ["*"] }] }', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '3bf02f7a-015b-4f93-be0f-cc043fda2dd3', 'title' => ''],
'AutomaticRotation' => ['description' => 'Indicates whether automatic rotation is enabled. Valid values:'."\n"
."\n"
.'- Enabled: Automatic rotation is enabled.'."\n"
."\n"
.'- Disabled: Automatic rotation is disabled.'."\n"
."\n"
.'- Invalid: The rotation status is abnormal. Secrets Manager cannot automatically rotate the secret for you.'."\n"
."\n"
.'> This parameter is returned if SecretType is set to Rds, Redis, PolarDB, RAMCredentials, or ECS.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'SecretName' => ['description' => 'The name of the secret.', 'type' => 'string', 'example' => 'mydbconninfo', 'title' => ''],
'VersionId' => ['description' => 'The version number of the secret.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
'NextRotationDate' => ['description' => 'The time when the secret is next rotated.'."\n"
."\n"
.'> This parameter is returned if automatic rotation is enabled.', 'type' => 'string', 'example' => '2023-07-06T18:22:03Z', 'title' => ''],
'SecretType' => ['description' => 'The type of the secret. Valid values:'."\n"
."\n"
.'- Generic: a generic secret.'."\n"
."\n"
.'- Rds: an RDS secret.'."\n"
."\n"
.'- Redis: a Redis secret.'."\n"
."\n"
.'- RAMCredentials: a RAM secret.'."\n"
."\n"
.'- ECS: an ECS secret.'."\n"
."\n"
.'- PolarDB: a PolarDB secret.', 'type' => 'string', 'example' => 'Rds', 'title' => ''],
'RotationInterval' => ['description' => 'The interval for automatic rotation.<br>'."\n"
.'The value is in the `integer[unit]` format. `integer` indicates the interval. `unit` indicates the unit of time. The unit is s (second). For example, a rotation interval of 7 days is 604800s.<br>'."\n"
."\n"
.'> This parameter is returned if automatic rotation is enabled.', 'type' => 'string', 'example' => '604800s', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the secret.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo', 'title' => ''],
'ExtendedConfig' => ['description' => 'The extended configuration of the secret.'."\n"
."\n"
.'> This parameter is returned if SecretType is set to Rds, Redis, PolarDB, RAMCredentials, or ECS.', 'type' => 'string', 'example' => '{\\"SecretSubType\\":\\"SingleUser\\", \\"DBInstanceId\\":\\"rm-uf667446pc955****\\", \\"CustomData\\":"Key1": "v1", "fds":"fdsf"} }', 'title' => ''],
'DKMSInstanceId' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'example' => 'kst-bjj62d8f5e0sgtx8h****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnsupportedOperation', 'errorMessage' => 'This action is not supported.', 'description' => 'The operation is not supported.'],
['errorCode' => 'Rejected.LimitExceeded', 'errorMessage' => 'The request was rejected because user create resource limit was exceeded', 'description' => 'The request is rejected because the number of created resources reaches the upper limit.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'Rejected.ShareQuotaExceedLimit', 'errorMessage' => 'Instance Share Quota Exceed Limit.', 'description' => 'The instance share quota exceeds the limit.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceNotFound', 'errorMessage' => 'The specified DKMS Instance is not found.', 'description' => 'Your dedicated KMS instance is not found.'],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'The resource is not found.', 'description' => 'The resource does not exist.'],
],
409 => [
['errorCode' => 'Rejected.ResourceExist', 'errorMessage' => 'The resource already exists.', 'description' => 'The resource already exists.'],
['errorCode' => 'Rejected.ResourceInDeleteWindow', 'errorMessage' => 'The secret is planned to be deleted.', 'description' => 'The secret is to be deleted.'],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => 'An internal error occurred.'],
],
],
'title' => 'CreateSecret',
'summary' => 'Creates a secret and stores its initial version.',
'description' => '- For information about the access policy required for a Resource Access Management (RAM) user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Specify the secret name, the secret value for the initial version, and the version number. The initial version is marked with the ACSCurrent stage label.'."\n"
."\n"
.'- Key Management Service (KMS) uses the key that you specify to encrypt the secret value. The key and the secret must be in the same KMS instance. The key must be a symmetric key.'."\n"
."\n"
.' > KMS encrypts the secret value of each version. Metadata such as the secret name, version number, and version stage labels are not encrypted.'."\n"
."\n"
.'- Before you encrypt the secret value, you must have the `kms:GenerateDataKey` permission on the key.'."\n"
."\n"
.'This topic provides an example of how to create an RDS secret. The secret is named `mydbconninfo`. The `VersionId` of the initial version is `v1`. The `SecretData` is `{"Accounts":[{"AccountName":"user1","AccountPassword":"****"}]}`.',
'requestParamsDescription' => 'For information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3bf02f7a-015b-4f93-be0f-cc043fda2dd3\\",\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"SecretName\\": \\"mydbconninfo\\",\\n \\"VersionId\\": \\"v1\\",\\n \\"NextRotationDate\\": \\"2023-07-06T18:22:03Z\\",\\n \\"SecretType\\": \\"Rds\\",\\n \\"RotationInterval\\": \\"604800s\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:154035569884****:secret/mydbconninfo\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\\\\\\\\\"SecretSubType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SingleUser\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"DBInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-uf667446pc955****\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CustomData\\\\\\\\\\\\\\":\\\\\\"Key1\\\\\\": \\\\\\"v1\\\\\\", \\\\\\"fds\\\\\\":\\\\\\"fdsf\\\\\\"} }\\",\\n \\"DKMSInstanceId\\": \\"kst-bjj62d8f5e0sgtx8h****\\"\\n}","type":"json"}]',
],
'Decrypt' => [
'summary' => 'Decrypts ciphertext that was encrypted by using a CMK.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54550',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'CiphertextBlob',
'in' => 'query',
'schema' => ['description' => 'The ciphertext that you want to decrypt.<br> The ciphertext is generated by calling the following API operations:<br>'."\n"
."\n"
.'- [GenerateDataKey](~~28948~~)'."\n"
."\n"
.'- [Encrypt](~~28949~~)'."\n"
."\n"
.'- [GenerateDataKeyWithoutPlaintext](~~134043~~)', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****', 'title' => ''],
],
[
'name' => 'EncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs.'."\n"
."\n"
.'> If you specify EncryptionContext when you call the [GenerateDataKey](~~28948~~), [Encrypt](~~28949~~), or [GenerateDataKeyWithoutPlaintext](~~134043~~) operation to encrypt data, you must specify the same parameter for decryption. For more information, see [EncryptionContext](~~42975~~).', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the dry run feature.'."\n"
."\n"
.'- true: enables the dry run feature.'."\n"
."\n"
.'- false (default): disables the dry run feature.'."\n"
."\n"
.'The dry run feature lets you test API calls, check whether you have the required permissions on resources, and check whether the request parameters are valid. If you enable the dry run feature, KMS always returns a failure response that indicates the cause of the failure. The following causes are possible:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter was not specified.'."\n"
."\n"
.'- ValidationError: The parameters specified in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version that is used to decrypt the ciphertext. This key version is a version of the master key.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the master key that is used to decrypt the ciphertext.<br> The globally unique identifier of the master key.<br>', 'type' => 'string', 'example' => '202b9877-5a25-46e3-a763-e20791b5****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '207596a2-36d3-4840-b1bd-f87044699bd7', 'title' => ''],
'Plaintext' => ['description' => 'The decrypted plaintext.', 'type' => 'string', 'example' => 'tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnsupportedOperation', 'errorMessage' => 'This action is not supported.', 'description' => 'The operation is not supported.'],
],
404 => [
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
409 => [
['errorCode' => 'Rejected.Disabled', 'errorMessage' => 'The request was rejected because the key state is Disabled.', 'description' => 'The request was rejected because the key state is Disabled.'],
['errorCode' => 'Rejected.PendingDeletion', 'errorMessage' => 'The request was rejected because the key state is PendingDeletion.', 'description' => 'The request was rejected because the key state is PendingDeletion.'],
['errorCode' => 'Rejected.Unavailable', 'errorMessage' => 'The request was rejected because the key state is Unavailable.', 'description' => 'The request was denied because the key status is unavailable.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\",\\n \\"RequestId\\": \\"207596a2-36d3-4840-b1bd-f87044699bd7\\",\\n \\"Plaintext\\": \\"tRYXuCwgja12xxO1N/gZERDDCLw9doZEQiPDk/Bv****\\"\\n}","type":"json"}]',
'title' => 'Decrypt',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the access policy required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation can be called through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or using a VPC domain name. To use a shared gateway, you must enable Internet access. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- Shared gateway: The queries per second (QPS) limit for a single user for this operation is 1,000. If this limit is exceeded, API calls are throttled, which may affect your business. We recommend that you plan your calls accordingly.'."\n"
."\n"
.'- Dedicated gateway: The QPS limit for a single user for this operation is subject to the performance specifications of your KMS instance. For more information, see [Performance metrics](~~480120~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'DeleteAlias' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'AliasName',
'in' => 'query',
'schema' => ['description' => 'The alias that you want to delete.'."\n"
."\n"
.'The value must be 1 to 255 characters in length and must include the alias/ prefix.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alias/example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4c8ae23f-3a42-6791-a4ba-1faa77831c28', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4c8ae23f-3a42-6791-a4ba-1faa77831c28\\"\\n}","errorExample":""},{"type":"xml","example":"<KMS>\\r\\n <RequestId>4c8ae23f-3a42-6791-a4ba-1faa77831c28</RequestId>\\r\\n</KMS>","errorExample":""}]',
'title' => 'DeleteAlias',
'summary' => 'Deletes an alias.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DeleteApplicationAccessPoint' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '54649',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the AAP that you want to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aap_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'bcfefe15-46f0-44a3-bd96-3d422474b71a', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DeleteApplicationAccessPoint',
'summary' => 'Deletes an application access point (AAP).',
'description' => '- For information about the access policy that a RAM user or RAM role requires to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Before you delete an AAP, make sure that it is no longer in use. If you delete an AAP that is in use, related applications cannot access KMS. Proceed with caution.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"bcfefe15-46f0-44a3-bd96-3d422474b71a\\"\\n}","type":"json"}]',
],
'DeleteClientKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '54636',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'ClientKeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the client key.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'KAAP.66abf237-63f6-4625-b8cf-47e1086e****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID. This is a unique identifier that Alibaba Cloud generates for the request. Use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '2312e45f-b2fa-4c34-ad94-3eca50932916', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DeleteClientKey',
'summary' => 'Deletes a client key.',
'description' => '- For information about the access policy required for a RAM user or RAM role to call this API operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Before you delete a ClientKey, make sure that it is no longer in use. Deleting a ClientKey that is in use prevents related applications from accessing KMS. Proceed with caution.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2312e45f-b2fa-4c34-ad94-3eca50932916\\"\\n}","type":"json"}]',
],
'DeleteKeyMaterial' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4162a6af-bc99-40b3-a552-89dcc8aaf7c8', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4162a6af-bc99-40b3-a552-89dcc8aaf7c8\\"\\n}","type":"json"}]',
'title' => 'DeleteKeyMaterial',
'summary' => 'Deletes the imported key material from a CMK. After deletion, the CMK enters the PendingImport state until you re-import key material.',
'description' => 'This operation does not delete the CMK that is created by using the key material.'."\n"
."\n"
.'If the CMK is in the PendingDeletion state, the state of the CMK and the scheduled deletion time do not change after you call this operation. If the CMK is not in the PendingDeletion state, the state of the CMK changes to PendingImport after you call this operation.'."\n"
."\n"
.'After you delete the key material, you can upload only the same key material into the CMK.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'DeleteNetworkRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '54647',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the network control rule to delete.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'networkrule_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is generated by Alibaba Cloud and is unique for each request. You can use it to troubleshoot issues.', 'type' => 'string', 'example' => '3bf02f7a-015b-4f93-be0f-cc043fda2d4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DeleteNetworkRule',
'summary' => 'Deletes a network access rule.',
'description' => '- For information about the access policy that is required to call this OpenAPI as a Resource Access Management (RAM) user or RAM role, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Before deleting the network control rule, ensure that it is not attached to any access policies. Otherwise, related applications cannot access KMS as expected.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3bf02f7a-015b-4f93-be0f-cc043fda2d4\\"\\n}","type":"json"}]',
],
'DeletePolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '54645',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the permission policy that you want to delete.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'policy_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '00a26a33-d992-42f3-9012-5fd12764430f', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"00a26a33-d992-42f3-9012-5fd12764430f\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePolicyResponse>\\n <RequestId>00a26a33-d992-42f3-9012-5fd12764430f</RequestId>\\n</DeletePolicyResponse>","errorExample":""}]',
'title' => 'DeletePolicy',
'summary' => 'Deletes a permission policy.',
'description' => 'Before you delete a permission policy, make sure that the permission policy is not associated with application access points (AAPs). Otherwise, related applications cannot access Key Management Service (KMS).'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'DeleteSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'ForceDeleteWithoutRecovery',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to forcibly delete the secret. If this parameter is set to true, the secret cannot be recovered.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false** (default value)'."\n",
'type' => 'string',
'required' => false,
'example' => 'false',
'default' => 'false',
'enum' => ['false', 'true'],
'title' => '',
],
],
[
'name' => 'RecoveryWindowInDays',
'in' => 'query',
'schema' => ['description' => 'Specifies the recovery period of the secret if you do not forcibly delete it. Default value: 30. Unit: Days.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '10', 'default' => '30', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '38bbed2a-15e0-45ad-98d4-816ad2ccf4ea', 'title' => ''],
'PlannedDeleteTime' => ['description' => 'The time when the secret is scheduled to be deleted.'."\n", 'type' => 'string', 'example' => '2022-09-15T07:02:14Z', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
409 => [
['errorCode' => 'Rejected.ResourceInDeleteWindow', 'errorMessage' => 'secret in delete peroid', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecretName\\": \\"secret001\\",\\n \\"RequestId\\": \\"38bbed2a-15e0-45ad-98d4-816ad2ccf4ea\\",\\n \\"PlannedDeleteTime\\": \\"2022-09-15T07:02:14Z\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSecretResponse>\\n <SecretName>secret001</SecretName>\\n <RequestId>38bbed2a-15e0-45ad-98d4-816ad2ccf4ea</RequestId>\\n <PlannedDeleteTime>2022-09-15T07:02:14Z</PlannedDeleteTime>\\n</DeleteSecretResponse>","errorExample":""}]',
'title' => 'DeleteSecret',
'summary' => 'Deletes a secret.',
'description' => 'If you call this operation without specifying a recovery period, the deleted secret can be recovered within 30 days.'."\n"
."\n"
.'If you specify a recovery period, the deleted secret can be recovered within the recovery period. You can also forcibly delete a secret. A forcibly deleted secret cannot be recovered.'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DescribeAccountKmsStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54556',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'AccountStatus' => ['description' => 'The status of KMS within your Alibaba cloud account. Valid values:'."\n"
."\n"
.'- Enabled: KMS is enabled.'."\n"
."\n"
.'- NotEnabled: KMS is disabled.'."\n"
."\n"
.'- InDebt: Your account is overdue, and KMS stops providing services.'."\n"
."\n"
.'> If your Alibaba Cloud account is overdue, top up your account at the earliest opportunity to avoid impacts on your services.'."\n"
."\n"
.'- Suspended: KMS is suspended.', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3ac84333-d64d-4784-a8bc-997834a7ac6c', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system.', 'description' => ''],
],
[
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DescribeAccountKmsStatus',
'summary' => 'Queries the status of Key Management Service (KMS) within your Alibaba Cloud account.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccountStatus\\": \\"Enabled\\",\\n \\"RequestId\\": \\"3ac84333-d64d-4784-a8bc-997834a7ac6c\\"\\n}","type":"json"}]',
],
'DescribeApplicationAccessPoint' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54652',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the application access point (AAP) to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aap_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'bcfefe15-46f0-44a3-bd96-3d422474b71a', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the AAP.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test', 'title' => ''],
'Name' => ['description' => 'The name of the AAP.', 'type' => 'string', 'example' => 'aap_test', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'aap description', 'title' => ''],
'AuthenticationMethod' => ['description' => 'The authentication method.', 'type' => 'string', 'example' => 'ClientKey', 'title' => ''],
'Policies' => ['description' => 'The attached access policies.', 'type' => 'string', 'example' => '["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DescribeApplicationAccessPoint',
'summary' => 'Retrieves the details of an application access point (AAP).',
'description' => 'For information about the access policy that a Resource Access Management (RAM) user or RAM role must have to call this operation, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"bcfefe15-46f0-44a3-bd96-3d422474b71a\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:119285303511****:applicationaccesspoint/aap_test\\",\\n \\"Name\\": \\"aap_test\\",\\n \\"Description\\": \\"aap description\\",\\n \\"AuthenticationMethod\\": \\"ClientKey\\",\\n \\"Policies\\": \\"[\\\\\\"kst-hzz62ee817bvyyr5x****.efkd\\\\\\",\\\\\\"kst-hzz62ee817bvyyr5x****.eyyp\\\\\\"]\\"\\n}","type":"json"}]',
],
'DescribeKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.'."\n"
."\n"
.'You can also set this parameter to an alias that is bound to the CMK. For more information, see [Overview of aliases](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f', 'title' => ''],
'KeyMetadata' => [
'description' => 'The metadata of the CMK.',
'type' => 'object',
'properties' => [
'DeletionProtection' => ['description' => 'Indicates whether deletion protection is enabled. Valid values:'."\n"
."\n"
.'- Enabled'."\n"
."\n"
.'- Disabled', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'KeyId' => ['description' => 'The ID of the CMK. The ID must be globally unique.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'NextRotationDate' => ['description' => 'The time when the next rotation will be performed.'."\n"
."\n"
.'> This parameter is returned only when the value of the AutomaticRotation parameter is Enabled or Suspended.', 'type' => 'string', 'example' => '2021-07-06T18:22:03Z', 'title' => ''],
'KeyState' => ['description' => 'The status of the CMK.'."\n"
."\n"
.'For more information, see [Impact of CMK status on API operations](~~44211~~).', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'RotationInterval' => ['description' => 'The interval for automatic key rotation.'."\n"
."\n"
.'Unit: seconds.'."\n"
."\n"
.'For example, if the value is 604800s, automatic key rotation is performed at a 7-day interval.'."\n"
."\n"
.'> This parameter is returned only when the value of the AutomaticRotation parameter is Enabled or Suspended.', 'type' => 'string', 'example' => '31536000s', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the CMK.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****', 'title' => ''],
'Creator' => ['description' => 'The Alibaba Cloud account that is used to create the CMK.', 'type' => 'string', 'example' => '154035569884****', 'title' => ''],
'LastRotationDate' => ['description' => 'The time when the last rotation was performed. The time is displayed in UTC. For a new CMK, the value of this parameter is the time when the initial version of the CMK was generated.', 'type' => 'string', 'example' => '2024-05-20T06:34:21Z', 'title' => ''],
'DeleteDate' => ['description' => 'The time at which the CMK is scheduled for deletion. The time is displayed in UTC.'."\n"
."\n"
.'For more information, see [ScheduleKeyDeletion](~~44196~~).'."\n"
."\n"
.'> This parameter is returned only when the value of the KeyState parameter is PendingDeletion.', 'type' => 'string', 'example' => '2024-05-26T18:22:03Z', 'title' => ''],
'PrimaryKeyVersion' => ['description' => 'The ID of the current primary key version for the symmetric CMK.', 'type' => 'string', 'example' => '515e0b0a-624f-45ab-92b5-54f9b551****', 'title' => ''],
'Description' => ['description' => 'The description of the CMK.', 'type' => 'string', 'example' => 'key description example', 'title' => ''],
'KeySpec' => ['description' => 'The type of the CMK.', 'type' => 'string', 'example' => 'Aliyun_AES_256', 'title' => ''],
'Origin' => ['description' => 'The source of the key material for the CMK.', 'type' => 'string', 'example' => 'Aliyun_KMS', 'title' => ''],
'MaterialExpireTime' => ['description' => 'The time when the key material expires. The time is displayed in UTC. If this parameter value is empty, the key material does not expire.', 'type' => 'string', 'example' => '2024-07-06T18:22:03Z', 'title' => ''],
'DeletionProtectionDescription' => ['description' => 'The description of deletion protection.', 'type' => 'string', 'example' => 'The CMK is being used by XXX. Deletion protection is set.', 'title' => ''],
'AutomaticRotation' => ['description' => 'Indicates whether automatic key rotation is enabled. Valid values:'."\n"
."\n"
.'- Enabled'."\n"
."\n"
.'- Disabled'."\n"
."\n"
.'- Suspended'."\n"
."\n"
.'For more information, see [Automatic key rotation](~~134270~~).'."\n"
."\n"
.'> Only symmetric CMKs support automatic key rotation.', 'type' => 'string', 'example' => 'Disabled', 'title' => ''],
'ProtectionLevel' => ['description' => 'The protection level of the CMK.', 'type' => 'string', 'example' => 'HSM', 'title' => ''],
'KeyUsage' => ['description' => 'The usage of the CMK.', 'type' => 'string', 'example' => 'ENCRYPT/DECRYPT', 'title' => ''],
'CreationDate' => ['description' => 'The time when the CMK was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-05-20T06:34:21Z', 'title' => ''],
'DKMSInstanceId' => ['description' => 'The ID of the dedicated KMS instance.', 'type' => 'string', 'example' => 'kst-bjj62d8f5e0sgtx8h****', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f\\",\\n \\"KeyMetadata\\": {\\n \\"DeletionProtection\\": \\"Enabled\\",\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"NextRotationDate\\": \\"2021-07-06T18:22:03Z\\",\\n \\"KeyState\\": \\"Enabled\\",\\n \\"RotationInterval\\": \\"31536000s\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****\\",\\n \\"Creator\\": \\"154035569884****\\",\\n \\"LastRotationDate\\": \\"2024-05-20T06:34:21Z\\",\\n \\"DeleteDate\\": \\"2024-05-26T18:22:03Z\\",\\n \\"PrimaryKeyVersion\\": \\"515e0b0a-624f-45ab-92b5-54f9b551****\\",\\n \\"Description\\": \\"key description example\\",\\n \\"KeySpec\\": \\"Aliyun_AES_256\\",\\n \\"Origin\\": \\"Aliyun_KMS\\",\\n \\"MaterialExpireTime\\": \\"2024-07-06T18:22:03Z\\",\\n \\"DeletionProtectionDescription\\": \\"The CMK is being used by XXX. Deletion protection is set.\\",\\n \\"AutomaticRotation\\": \\"Disabled\\",\\n \\"ProtectionLevel\\": \\"HSM\\",\\n \\"KeyUsage\\": \\"ENCRYPT/DECRYPT\\",\\n \\"CreationDate\\": \\"2024-05-20T06:34:21Z\\",\\n \\"DKMSInstanceId\\": \\"kst-bjj62d8f5e0sgtx8h****\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeKey',
'summary' => 'Queries the metadata of a CMK, such as the key state, usage, and rotation configuration.',
'description' => 'You can query the information about the CMK `05754286-3ba2-4fa6-8d41-4323aca6****` by using parameter settings provided in this topic. The information includes the creator, creation time, status, and deletion protection status of the CMK.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'translator' => 'manual',
],
'DescribeKeyVersion' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK.'."\n"
."\n"
.'You can also set this parameter to an alias that is bound to the CMK. For more information, see [Alias overview](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'KeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK version.'."\n"
."\n"
.'You can call the [ListKeyVersions](~~133966~~) operation to query the versions of the CMK.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7021b6ec-4be7-4d3c-8a68-1e85d4d515a0', 'title' => ''],
'KeyVersion' => [
'description' => 'The metadata of the CMK version.',
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The globally unique ID of the CMK.'."\n"
."\n"
.'> If you set the KeyId parameter in the request to an alias of the CMK, the ID of the CMK to which the alias is bound is returned.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'KeyVersionId' => ['description' => 'The globally unique ID of the CMK version.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'CreationDate' => ['description' => 'The date and time when the CMK version was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-03-25T10:42:40Z', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7021b6ec-4be7-4d3c-8a68-1e85d4d515a0\\",\\n \\"KeyVersion\\": {\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"CreationDate\\": \\"2024-03-25T10:42:40Z\\"\\n }\\n}","type":"json"}]',
'title' => 'DescribeKeyVersion',
'summary' => 'Queries the metadata of a specific CMK version.',
'description' => 'This topic provides an example on how to query the information about a version of the CMK `1234abcd-12ab-34cd-56ef-12345678****`. The ID of the CMK version is `2ab1a983-7072-4bbc-a582-584b5bd8****`. The response shows that the creation time of the CMK version is `2016-03-25T10:42:40Z`.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'DescribeNetworkRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '189660',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the network rule to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'networkrule_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '3bf02f7a-015b-4f93-be0f-cc043fda2d33', 'title' => ''],
'Arn' => ['description' => 'The ARN of the network rule.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:119285303511****:network/networkrule_test', 'title' => ''],
'Type' => ['description' => 'The network type. The only valid value is Private, which means only private IP addresses are supported.', 'type' => 'string', 'example' => 'Private', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Create by kst-hzz62ee817bvyyr5****', 'title' => ''],
'SourcePrivateIp' => ['description' => 'The private IP addresses or private CIDR blocks.', 'type' => 'string', 'example' => '["192.10.XX.XX","192.168.XX.XX/24"]', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DescribeNetworkRule',
'summary' => 'Retrieves the details of a network access rule.',
'description' => 'For information about the required access policy for a Resource Access Management (RAM) user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3bf02f7a-015b-4f93-be0f-cc043fda2d33\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:119285303511****:network/networkrule_test\\",\\n \\"Type\\": \\"Private\\",\\n \\"Description\\": \\"Create by kst-hzz62ee817bvyyr5****\\",\\n \\"SourcePrivateIp\\": \\"[\\\\\\"192.10.XX.XX\\\\\\",\\\\\\"192.168.XX.XX/24\\\\\\"]\\"\\n}","type":"json"}]',
],
'DescribePolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54643',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the permission policy that you want to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'policy_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'f455324b-e229-4066-9f58-9c1cf3fe83a9', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the permission policy.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:119285303511****:policy/policy_test', 'title' => ''],
'Name' => ['description' => 'The name of the permission policy.', 'type' => 'string', 'example' => 'policy_test', 'title' => ''],
'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'policy description', 'title' => ''],
'KmsInstance' => ['description' => 'The scope of the permission policy.', 'type' => 'string', 'example' => 'kst-hzz634e67d126u9p9****', 'title' => ''],
'Permissions' => [
'description' => 'A list of operations that can be performed.',
'type' => 'array',
'items' => ['description' => 'The operations that can be performed.', 'type' => 'string', 'example' => '["RbacPermission/Template/CryptoServiceKeyUser", "RbacPermission/Template/CryptoServiceSecretUser"]', 'title' => ''],
'example' => '["RbacPermission/Template/CryptoServiceKeyUser", "RbacPermission/Template/CryptoServiceSecretUser"]',
'title' => '',
],
'Resources' => [
'description' => 'A list of keys and secrets that are allowed to access.',
'type' => 'array',
'items' => ['description' => 'The keys and secrets that are allowed to access.', 'type' => 'string', 'example' => '["secret/acs/ram/user/ram-secret", "secret/acs/ram/user/acr-master", "key/key-hzz63d9c8d3dfv8cv****"]', 'title' => ''],
'example' => '["secret/acs/ram/user/ram-secret", "secret/acs/ram/user/acr-master", "key/key-hzz63d9c8d3dfv8cv****"]',
'title' => '',
],
'AccessControlRules' => ['description' => 'The network access rule that is associated with the permission policy.', 'type' => 'string', 'example' => '{"NetworkRules":["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]}', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'DescribePolicy',
'summary' => 'Retrieves the details of a permission policy.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"f455324b-e229-4066-9f58-9c1cf3fe83a9\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:119285303511****:policy/policy_test\\",\\n \\"Name\\": \\"policy_test\\",\\n \\"Description\\": \\"policy description\\",\\n \\"KmsInstance\\": \\"kst-hzz634e67d126u9p9****\\",\\n \\"Permissions\\": [\\n \\"[\\\\\\"RbacPermission/Template/CryptoServiceKeyUser\\\\\\", \\\\\\"RbacPermission/Template/CryptoServiceSecretUser\\\\\\"]\\"\\n ],\\n \\"Resources\\": [\\n \\"[\\\\\\"secret/acs/ram/user/ram-secret\\\\\\", \\\\\\"secret/acs/ram/user/acr-master\\\\\\", \\\\\\"key/key-hzz63d9c8d3dfv8cv****\\\\\\"]\\"\\n ],\\n \\"AccessControlRules\\": \\"{\\\\\\"NetworkRules\\\\\\":[\\\\\\"kst-hzz62ee817bvyyr5x****.efkd\\\\\\",\\\\\\"kst-hzz62ee817bvyyr5x****.eyyp\\\\\\"]}\\"\\n}","type":"json"}]',
],
'DescribeRegions' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54561',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '815240e2-aa37-4c26-9cca-05d4df3e8fe6', 'title' => ''],
'Regions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Region' => [
'description' => 'The region.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'DescribeRegions',
'summary' => 'Queries the regions where KMS is available.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-21T07:47:03.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"815240e2-aa37-4c26-9cca-05d4df3e8fe6\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'DescribeSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'FetchTags',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to return the resource tags of the secret. Valid values:'."\n"
."\n"
.'* true: The resource tags are returned.'."\n"
.'* false: The resource tags are not returned. This is the default value.'."\n",
'type' => 'string',
'required' => false,
'example' => 'true',
'default' => 'false',
'enum' => ['false', 'true'],
'title' => '',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'UpdateTime' => ['description' => 'The time when the secret was updated.'."\n", 'type' => 'string', 'example' => '2022-02-21T15:39:26Z', 'title' => ''],
'CreateTime' => ['description' => 'The time when the secret was created.'."\n", 'type' => 'string', 'example' => '2022-02-21T15:39:26Z', 'title' => ''],
'NextRotationDate' => ['description' => 'The time when the next rotation will be performed.'."\n"
."\n"
.'> This parameter is returned when automatic rotation is enabled.'."\n", 'type' => 'string', 'example' => '2022-07-06T18:22:03Z', 'title' => ''],
'EncryptionKeyId' => ['description' => 'The ID of the customer master key (CMK) that is used to encrypt the secret value.'."\n", 'type' => 'string', 'example' => '00aa68af-2c02-4f68-95fe-3435d330****', 'title' => ''],
'RotationInterval' => ['description' => 'The interval for automatic rotation.'."\n"
."\n"
.'The value is in the `integer[unit]` format. `integer` indicates the length of time. `unit`: indicates the time unit. The value of `unit` is fixed as s. For example, if the value is 604800s, automatic rotation is performed at a 7-day interval.'."\n"
."\n"
.'> This parameter is returned when automatic rotation is enabled.'."\n", 'type' => 'string', 'example' => '3153600s', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the secret.'."\n", 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:154035569884****:secret/secret001', 'title' => ''],
'ExtendedConfig' => ['description' => 'The extended configuration of the secret.'."\n"
."\n"
.'> This parameter is returned only for a managed ApsaraDB RDS secret, a managed Resource Access Management (RAM) secret, or a managed Elastic Compute Service (ECS) secret.'."\n", 'type' => 'string', 'example' => '{\\"SecretSubType\\":\\"SingleUser\\", \\"DBInstanceId\\":\\"rm-uf667446pc955****\\", \\"CustomData\\":{} }', 'title' => ''],
'LastRotationDate' => ['description' => 'The time when the last rotation was performed.'."\n"
."\n"
.'> This parameter is returned if the secret was rotated.'."\n", 'type' => 'string', 'example' => '2022-07-05T08:22:03Z', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '93348dfb-3627-4417-8d90-487a76a909c9', 'title' => ''],
'Description' => ['description' => 'The description of the secret.'."\n", 'type' => 'string', 'example' => 'userinfo', 'title' => ''],
'SecretName' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'AutomaticRotation' => ['description' => 'Indicates whether automatic rotation is enabled. Valid values:'."\n"
."\n"
.'* Enabled: indicates that automatic rotation is enabled.'."\n"
.'* Disabled: indicates that automatic rotation is disabled.'."\n"
.'* Invalid: indicates that the status of automatic rotation is abnormal. In this case, Secrets Manager cannot automatically rotate the secret.'."\n"
."\n"
.'> This parameter is returned only for a managed ApsaraDB RDS secret, a managed RAM secret, or a managed ECS secret.'."\n", 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'SecretType' => ['description' => 'The type of the secret. Valid values:'."\n"
."\n"
.'* Generic: indicates a generic secret.'."\n"
.'* Rds: indicates a managed ApsaraDB RDS secret.'."\n"
.'* RAMCredentials: indicates a managed RAM secret.'."\n"
.'* ECS: indicates a managed ECS secret.'."\n", 'type' => 'string', 'example' => 'Rds', 'title' => ''],
'PlannedDeleteTime' => ['description' => 'The time when the secret is scheduled to be deleted.'."\n", 'type' => 'string', 'example' => '2022-03-21T15:45:12Z', 'title' => ''],
'DKMSInstanceId' => ['description' => 'The ID of the dedicated KMS instance.'."\n", 'type' => 'string', 'example' => 'kst-bjj62d8f5e0sgtx8h****', 'title' => ''],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'The resource tags of the secret.'."\n"
."\n"
.'This parameter is not returned if you set the FetchTags parameter to false or you do not specify the FetchTags parameter.'."\n",
'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'val1', 'title' => ''],
'TagKey' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key1', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalTimestamp', 'errorMessage' => 'The input parameter Timestamp that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter timestamp indicates that the request is outside the processing time range.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => 'You are not authorized to perform the operation.'],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateTime\\": \\"2022-02-21T15:39:26Z\\",\\n \\"CreateTime\\": \\"2022-02-21T15:39:26Z\\",\\n \\"NextRotationDate\\": \\"2022-07-06T18:22:03Z\\",\\n \\"EncryptionKeyId\\": \\"00aa68af-2c02-4f68-95fe-3435d330****\\",\\n \\"RotationInterval\\": \\"3153600s\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:154035569884****:secret/secret001\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\\\\\\\\\"SecretSubType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SingleUser\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"DBInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-uf667446pc955****\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CustomData\\\\\\\\\\\\\\":{} }\\",\\n \\"LastRotationDate\\": \\"2022-07-05T08:22:03Z\\",\\n \\"RequestId\\": \\"93348dfb-3627-4417-8d90-487a76a909c9\\",\\n \\"Description\\": \\"userinfo\\",\\n \\"SecretName\\": \\"secret001\\",\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"SecretType\\": \\"Rds\\",\\n \\"PlannedDeleteTime\\": \\"2022-03-21T15:45:12Z\\",\\n \\"DKMSInstanceId\\": \\"kst-bjj62d8f5e0sgtx8h****\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagValue\\": \\"val1\\",\\n \\"TagKey\\": \\"key1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeSecretResponse>\\n <UpdateTime>2020-02-21T15:39:26Z</UpdateTime>\\n <CreateTime>2020-02-21T15:39:26Z</CreateTime>\\n <NextRotationDate>2020-07-06T18:22:03Z</NextRotationDate>\\n <EncryptionKeyId>00aa68af-2c02-4f68-95fe-3435d330****</EncryptionKeyId>\\n <RotationInterval>3153600s</RotationInterval>\\n <Arn>acs:kms:cn-hangzhou:154035569884****:secret/secret001</Arn>\\n <ExtendedConfig>{\\\\\\"SecretSubType\\\\\\":\\\\\\"SingleUser\\\\\\", \\\\\\"DBInstanceId\\\\\\":\\\\\\"rm-uf667446pc955****\\\\\\", \\\\\\"CustomData\\\\\\":{} }</ExtendedConfig>\\n <LastRotationDate>2020-07-05T08:22:03Z</LastRotationDate>\\n <RequestId>93348dfb-3627-4417-8d90-487a76a909c9</RequestId>\\n <Description>userinfo</Description>\\n <SecretName>secret001</SecretName>\\n <AutomaticRotation>Enabled</AutomaticRotation>\\n <SecretType>Rds</SecretType>\\n <PlannedDeleteTime>2020-03-21T15:45:12Z</PlannedDeleteTime>\\n <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>\\n <Tags>\\n <TagValue>val1</TagValue>\\n <TagKey>key1</TagKey>\\n </Tags>\\n</DescribeSecretResponse>","errorExample":""}]',
'title' => 'DescribeSecret',
'summary' => 'Queries the metadata of a secret.',
'description' => 'This operation returns the metadata of a secret. This operation does not return the secret value.'."\n"
."\n"
.'In this example, the metadata of the secret named `secret001` is queried.'."\n",
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'DisableKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2fe70ce2-3303-4fd6-b3ac-472fb2705c62', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2fe70ce2-3303-4fd6-b3ac-472fb2705c62\\"\\n}","errorExample":"//xml response\\n<KMS>\\n <RequestId>2fe70ce2-3303-4fd6-b3ac-472fb2705c62</RequestId>\\n</KMS>\\n"},{"type":"xml","example":"<KMS>\\n <RequestId>2fe70ce2-3303-4fd6-b3ac-472fb2705c62</RequestId>\\n</KMS>\\n","errorExample":"//json response\\n{\\n\\"RequestId\\": \\"2fe70ce2-3303-4fd6-b3ac-472fb2705c62\\"\\n}\\n"}]',
'title' => 'DisableKey',
'summary' => 'Disables a key.',
'description' => 'If a customer master key (CMK) is disabled, the ciphertext encrypted by using this CMK cannot be decrypted until you re-enable it. You can call the [EnableKey](~~35150~~) operation to enable the CMK.'."\n"
."\n"
.'In this example, the CMK whose ID is `1234abcd-12ab-34cd-56ef-12345678****` is disabled.'."\n",
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'EnableKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'efb1cbbd-a093-4278-bc03-639dd4fcc207', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"efb1cbbd-a093-4278-bc03-639dd4fcc207\\"\\n}","errorExample":"//xml response\\n\\n<KMS>\\n <RequestId>efb1cbbd-a093-4278-bc03-639dd4fcc207</RequestId>\\n</KMS>\\n"},{"type":"xml","example":"<KMS>\\r\\n <RequestId>efb1cbbd-a093-4278-bc03-639dd4fcc207</RequestId>\\r\\n</KMS>","errorExample":"//json response\\n{\\n\\"RequestId\\": \\"efb1cbbd-a093-4278-bc03-639dd4fcc207\\"\\n}\\n"}]',
'title' => 'EnableKey',
'summary' => 'Enables a key to encrypt and decrypt data.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'Encrypt' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54566',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify the alias or Amazon Resource Name (ARN) of the key. For more information about aliases, see [Manage aliases](~~480655~~).'."\n"
."\n"
.'> When you access a key in another Alibaba Cloud account, you must specify the ARN of the key. The ARN of a key is in the `acs:kms:${region}:${account}:key/${keyid}` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'Plaintext',
'in' => 'query',
'schema' => ['description' => 'The plaintext to be encrypted. The plaintext must be Base64-encoded.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SGVsbG8gd29y****', 'title' => ''],
],
[
'name' => 'EncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs. If you specify this parameter, you must specify the same parameter when you call the Decrypt operation. For more information, see [EncryptionContext](~~42975~~).', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the dry run feature.'."\n"
."\n"
.'- true: enables the dry run feature.'."\n"
."\n"
.'- false (default): disables the dry run feature.'."\n"
."\n"
.'The dry run feature is used to test API calls and verify the permissions on the resources that you have and the validity of the request parameters. You can view the check results in the response.'."\n"
."\n"
.'- DryRunOperationError: The permissions and parameters are valid. If you do not specify the DryRun parameter, the request is successful.'."\n"
."\n"
.'- ValidationError: The parameters in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version that is used to encrypt the plaintext. It is the primary version of the specified key.', 'type' => 'string', 'example' => '86a9efd9-3d16-4894-bd4f-1fc43f3f****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the key. If you use an alias or an ARN of the key in the request, the ID of the key is returned.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'CiphertextBlob' => ['description' => 'The ciphertext of the data that is encrypted using the primary version of the specified key.', 'type' => 'string', 'example' => 'DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"86a9efd9-3d16-4894-bd4f-1fc43f3f****\\",\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"CiphertextBlob\\": \\"DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****\\",\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\"\\n}","type":"json"}]',
'title' => 'Encrypt',
'summary' => 'Encrypts plaintext by using a symmetric CMK.',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the access policy required to allow a RAM user or RAM role to use this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation is accessible through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or a VPC. To use this method, you must enable Internet access. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- When accessed through a shared gateway, the queries per second (QPS) limit for a single user is 1,000. If the limit is exceeded, requests are throttled, which can affect your business. We recommend that you stay within this limit to avoid throttling.'."\n"
."\n"
.'- When accessed through a dedicated gateway, the QPS limit for a single user is subject to the computing performance specifications of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'- KMS encrypts the specified data using the primary version of a specified key.'."\n"
."\n"
.'- You can encrypt a maximum of 6 KB of data, such as an RSA key, a database password, or other sensitive information.'."\n"
."\n"
.'- If you migrate encrypted data from one region to another, you can call the Encrypt operation in the destination region to re-encrypt the plaintext data key from the source region. This generates a new encrypted data key. You can then call the [Decrypt](~~28950~~) operation to decrypt this new key in the destination region.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ExportDataKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54568',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'CiphertextBlob',
'in' => 'query',
'schema' => ['description' => 'The ciphertext of the data key that is encrypted using a master key (CMK).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901q********', 'title' => ''],
],
[
'name' => 'EncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs. EncryptionContext is the encryption context that is passed in when the data key is encrypted using a CMK. For more information, see [EncryptionContext](~~42975~~).', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'PublicKeyBlob',
'in' => 'query',
'schema' => ['description' => 'The public key in Base64 format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAndKfC2ReLL2+y8a0+ZBBeAft/uBYo86GZiYJuflqgUzKxpyuvlo3uQkBv6b+nx+0tz8g8v7GhpPWMSW5L9mNHYsvYFsa7jTxsYdt17yj6GlUHPuMIs8hr5qbwl38IHU1iIa7nYWwE2fb3ePOvLDACRJVgGpU0yxioW80d2QD+9aU4jF5dlAahcfgsNzo2CXzCUc1+xbmNuq7Rp+H9VJB9dyYOwqnW3RhOLBo21FzpORapf0UiRlrHRpk1V6ez+aE1dofaYh/9bh0m6ioxj7j5hpZbWccuEZTMBKd+cbuBkRhJzc6Tti6qwZbDiu4fUwbZS0Tqpuo1UadiyxMW********', 'title' => ''],
],
[
'name' => 'WrappingKeySpec',
'in' => 'query',
'schema' => ['description' => 'The type of the public key specified by PublicKeyBlob. For more information about key types, see [Introduction to asymmetric keys](~~148147~~).<br> Valid values:<br><br>'."\n"
."\n"
.'- RSA\\_2048'."\n"
."\n"
.'- EC\\_SM2', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSA_2048', 'title' => ''],
],
[
'name' => 'WrappingAlgorithm',
'in' => 'query',
'schema' => ['description' => 'The encryption algorithm that is used to encrypt the data key using the public key specified by PublicKeyBlob. For more information about the algorithms, see [AsymmetricDecrypt](~~148130~~).<br> Valid values:<br><br>'."\n"
."\n"
.'- RSAES\\_OAEP\\_SHA\\_256'."\n"
."\n"
.'- RSAES\\_OAEP\\_SHA\\_1'."\n"
."\n"
.'- SM2PKE', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSAES_OAEP_SHA_256', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the DryRun mode.'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false (default)'."\n"
."\n"
.'The DryRun mode is used to test the API call and verify the permissions on the specified resources and the validity of the request parameters. If you enable the DryRun mode, KMS returns a failure response and a failure reason. The failure reasons include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter was not specified.'."\n"
."\n"
.'- ValidationError: The specified parameters in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform the operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version that is used to decrypt the ciphertext of the specified data key.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the CMK that is used to decrypt the ciphertext of the specified data key.<br> The globally unique identifier of the CMK.<br><br>', 'type' => 'string', 'example' => '202b9877-5a25-46e3-a763-e20791b5****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '4bd560a1-729e-45f1-a3d9-b2a33d61046b', 'title' => ''],
'ExportedDataKey' => ['description' => 'The exported data key that is protected by public key encryption.', 'type' => 'string', 'example' => 'BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\",\\n \\"RequestId\\": \\"4bd560a1-729e-45f1-a3d9-b2a33d61046b\\",\\n \\"ExportedDataKey\\": \\"BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******\\"\\n}","type":"json"}]',
'title' => 'ExportDataKey',
'summary' => 'Exports a data key encrypted by a CMK. The data key is re-encrypted by a public key that you specify for secure transmission.',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the access policy required for a RAM user or RAM role to use this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation is accessible through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS using the public endpoint or a VPC endpoint. To use the public endpoint, you must first enable it. For more information, see [Access the key in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of the KMS instance: `<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`.'."\n"
."\n"
.'### Description'."\n"
."\n"
.'After you call the [GenerateDataKeyWithoutPlaintext](~~134043~~) operation to obtain a data key encrypted by a master key (CMK), you can use the ExportDataKey operation to distribute the data key to other regions or cryptographic modules. The ExportDataKey operation returns the ciphertext of the data key, re-encrypted with the specified public key.'."\n"
."\n"
.'You can import the exported ciphertext into the cryptographic module that holds the corresponding private key. This process lets you securely distribute the data key from KMS to a cryptographic module. After the data key is imported into the cryptographic module, you can use it to encrypt or decrypt data.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'GenerateAndExportDataKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54569',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify the alias or Amazon Resource Name (ARN) of the key. For more information about aliases, see [Manage aliases](~~480655~~).'."\n"
."\n"
.'> To access a key in another Alibaba Cloud account, you must specify the ARN of the key. The key ARN is in the format of `acs:kms:${region}:${account}:key/${keyid}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
[
'name' => 'KeySpec',
'in' => 'query',
'schema' => [
'description' => 'The length of the data key that you want to generate. Valid values:'."\n"
."\n"
.'- AES\\_256: a 256-bit symmetric key.'."\n"
."\n"
.'- AES\\_128: a 128-bit symmetric key.'."\n"
."\n"
.'> We recommend that you use the KeySpec or NumberOfBytes parameter to specify the length of a data key. If you do not specify either of the parameters, KMS generates a 256-bit data key. If you specify both parameters, KMS ignores the KeySpec parameter.',
'type' => 'string',
'required' => false,
'enum' => ['AES_256', ' AES_128'],
'example' => 'AES_256',
'title' => '',
],
],
[
'name' => 'NumberOfBytes',
'in' => 'query',
'schema' => ['description' => 'The length of the data key that you want to generate.'."\n"
."\n"
.'Valid values: 1 to 1024.'."\n"
."\n"
.'Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1024', 'minimum' => '0', 'example' => '32', 'title' => ''],
],
[
'name' => 'EncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs. If you specify this parameter, you must specify the same parameter when you call the Decrypt operation or other operations to re-encrypt the data key. For more information, see [EncryptionContext](~~42975~~).', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'PublicKeyBlob',
'in' => 'query',
'schema' => ['description' => 'The public key that is encoded in Base64.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAndKfC2ReLL2+y8a0+ZBBeAft/uBYo86GZiYJuflqgUzKxpyuvlo3uQkBv6b+nx+0tz8g8v7GhpPWMSW5L9mNHYsvYFsa7jTxsYdt17yj6GlUHPuMIs8hr5qbwl38IHU1iIa7nYWwE2fb3ePOvLDACRJVgGpU0yxioW80d2QD+9aU4jF5dlAahcfgsNzo2CXzCUc1+xbmNuq7Rp+H9VJB9dyYOwqnW3RhOLBo21FzpORapf0UiRlrHRpk1V6ez+aE1dofaYh/9bh0m6ioxj7j5hpZbWccuEZTMBKd+cbuBkRhJzc6Tti6qwZbDiu4fUwbZS0Tqpuo1UadiyxMW********', 'title' => ''],
],
[
'name' => 'WrappingKeySpec',
'in' => 'query',
'schema' => ['description' => 'The type of the key specified by PublicKeyBlob. For more information about key types, see [Introduction to asymmetric keys](~~148147~~).<br> Valid values:<br><br>'."\n"
."\n"
.'- RSA\\_2048'."\n"
."\n"
.'- EC\\_SM2', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSA_2048', 'title' => ''],
],
[
'name' => 'WrappingAlgorithm',
'in' => 'query',
'schema' => ['description' => 'The encryption algorithm that is used to encrypt the data key using the public key specified by PublicKeyBlob. For more information about encryption algorithms, see [AsymmetricDecrypt](~~148130~~).<br> Valid values:<br><br>'."\n"
."\n"
.'- RSAES\\_OAEP\\_SHA\\_256'."\n"
."\n"
.'- RSAES\\_OAEP\\_SHA\\_1'."\n"
."\n"
.'- SM2PKE', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSAES_OAEP_SHA_256', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the dry run feature.'."\n"
."\n"
.'- true: enables the feature.'."\n"
."\n"
.'- false (default): disables the feature.'."\n"
."\n"
.'The DryRun mode is used to test API calls and verify the permissions on the resources that you have access to and the validity of the request parameters. If you enable the DryRun mode, KMS always returns a failure response and the cause of the failure. The following failure causes are included:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter is not specified.'."\n"
."\n"
.'- ValidationError: The parameters specified in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version that is used to encrypt the plaintext. It is the primary version of the specified KMS key.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the key. If you use a key alias or key ARN in the request, the key ID is returned.', 'type' => 'string', 'example' => '599fa825-17de-417e-9554-bb032cc6****', 'title' => ''],
'CiphertextBlob' => ['description' => 'The ciphertext of the data key. The data key is encrypted using the primary version of the specified KMS key.', 'type' => 'string', 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '7021b6ec-4be7-4d3c-8a68-1e85d4d515a0', 'title' => ''],
'ExportedDataKey' => ['description' => 'The exported data key that is protected by the public key.', 'type' => 'string', 'example' => 'BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'InternalFailure', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"599fa825-17de-417e-9554-bb032cc6****\\",\\n \\"CiphertextBlob\\": \\"ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****\\",\\n \\"RequestId\\": \\"7021b6ec-4be7-4d3c-8a68-1e85d4d515a0\\",\\n \\"ExportedDataKey\\": \\"BQKP+1zK6+ZEMxTP5qaVzcsgXtWplYBKm0NXdSnB5FzliFxE1bSiu4dnEIlca2JpeH7yz1/S6fed630H+hIH6DoM25fTLNcKj+mFB0Xnh9m2+HN59Mn4qyTfcUeadnfCXSWcGBouhXFwcdd2rJ3n337bzTf4jm659gZu3L0i6PLuxM9p7mqdwO0cKJPfGVfhnfMz+f4alMg79WB/NNyE2lyX7/qxvV49ObNrrJbKSFiz8Djocaf0IESNLMbfYI5bXjWkJlX92DQbKhibtQW8ZOJ//ZC6t0AWcUoKL6QDm/dg5koQalcleRinpB+QadFm894sLbVZ9+N4GVs*******\\"\\n}","type":"json"}]',
'title' => 'GenerateAndExportDataKey',
'summary' => 'Generates a random data key, encrypts it by using a CMK and a public key that you specify, and returns both ciphertexts.',
'description' => '### Notes'."\n"
."\n"
.'- For more information about the access policy required for a RAM user or RAM role to use this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation is accessible through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or a VPC. To access KMS over the Internet, you must enable Internet access. For more information, see [Access KMS instances over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'We recommend that you import the data key to a cryptographic module for data encryption and data decryption as follows:'."\n"
."\n"
.'1\\. Call the GenerateAndExportDataKey operation to obtain the data key encrypted by a KMS key and a specified public key.'."\n"
."\n"
.'2\\. Save the ciphertext of the data key that is encrypted by the KMS key to KMS or a storage service, such as ApsaraDB, for key backup and recovery.'."\n"
."\n"
.'3\\. Import the ciphertext of the data key that is encrypted by the public key to the cryptographic module that contains the corresponding private key. This process distributes the key from KMS to the cryptographic module. You can then use the data key to encrypt and decrypt data.'."\n"
."\n"
.'> The KMS key that you specify in the request is used only to encrypt the data key and is not used to generate the data key. KMS does not record or store the randomly generated data key. You are responsible for recording the data key or its ciphertext.',
'changeSet' => [],
'extraInfo' => ' ',
'flowControl' => [
'flowControlList' => [],
],
],
'GenerateDataKey' => [
'summary' => 'Generates a random data key for envelope encryption. The data key is returned in both plaintext and ciphertext forms.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54570',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify the alias or the key resource name (ARN) of the key. For more information about aliases, see [Manage aliases](~~480655~~).'."\n"
."\n"
.'> When you access a key in another Alibaba Cloud account, you must enter the ARN of the key. The key ARN is in the format of `acs:kms:${region}:${account}:key/${keyid}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'KeySpec',
'in' => 'query',
'schema' => [
'description' => 'The length of the data key to be generated. Valid values:'."\n"
."\n"
.'- AES\\_256: a 256-bit symmetric key.'."\n"
."\n"
.'- AES\\_128: a 128-bit symmetric key.'."\n"
."\n"
.'> We recommend that you use the KeySpec or NumberOfBytes parameter to specify the length of a data key. If you do not specify either of the parameters, KMS generates a 256-bit data key. If you specify both parameters, KMS ignores the KeySpec parameter.',
'type' => 'string',
'required' => false,
'enum' => ['AES_256', ' AES_128'],
'example' => 'AES_256',
'title' => '',
],
],
[
'name' => 'NumberOfBytes',
'in' => 'query',
'schema' => ['description' => 'The length of the data key that you want to generate. Unit: bytes.'."\n"
."\n"
.'Valid values: 1 to 1024.'."\n"
."\n"
.'Default values:'."\n"
."\n"
.'- If you set KeySpec to AES\\_256, the default value of NumberOfBytes is 32.'."\n"
."\n"
.'- If you set KeySpec to AES\\_128, the default value of NumberOfBytes is 16.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1024', 'minimum' => '0', 'example' => '256', 'title' => ''],
],
[
'name' => 'EncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs.'."\n"
."\n"
.'If you specify this parameter, you must also specify the same parameter when you call the [Decrypt](~~28950~~) operation. For more information, see [EncryptionContext](~~42975~~).', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the DryRun mode.'."\n"
."\n"
.'- true: enables the DryRun mode.'."\n"
."\n"
.'- false (default): disables the DryRun mode.'."\n"
."\n"
.'The DryRun mode is used to test the API call. It verifies whether you have the permissions to access the specified resources and whether the request parameters are valid. If you enable the DryRun mode, KMS always returns a failure response and a failure reason. The failure reasons include the following:'."\n"
."\n"
.'- DryRunOperationError: The request succeeds if the DryRun parameter is not specified.'."\n"
."\n"
.'- ValidationError: The parameters specified in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The globally unique identifier of the key version.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The ID of the key. If you use a key alias or key ARN in the KeyId parameter of the request, the key ID is also returned in the response.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'CiphertextBlob' => ['description' => 'The ciphertext of the data key encrypted by the primary version of the specified key.', 'type' => 'string', 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the request ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '7021b6ec-4be7-4d3c-8a68-1e85d4d515a0', 'title' => ''],
'Plaintext' => ['description' => 'The Base64-encoded plaintext of the data key.', 'type' => 'string', 'example' => 'QmFzZTY0IGVuY29kZWQgcGxhaW50****', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnsupportedOperation', 'errorMessage' => 'This action is not supported.', 'description' => 'The operation is not supported.'],
],
404 => [
['errorCode' => 'Forbidden.AliasNotFound', 'errorMessage' => 'The specified Alias is not found.', 'description' => 'The error message returned because the specified alias does not exist.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
409 => [
['errorCode' => 'Rejected.Disabled', 'errorMessage' => 'The request was rejected because the key state is Disabled.', 'description' => 'The request was rejected because the key state is Disabled.'],
['errorCode' => 'Rejected.PendingDeletion', 'errorMessage' => 'The request was rejected because the key state is PendingDeletion.', 'description' => 'The request was rejected because the key state is PendingDeletion.'],
['errorCode' => 'Rejected.Unavailable', 'errorMessage' => 'The request was rejected because the key state is Unavailable.', 'description' => 'The request was denied because the key status is unavailable.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"CiphertextBlob\\": \\"ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****\\",\\n \\"RequestId\\": \\"7021b6ec-4be7-4d3c-8a68-1e85d4d515a0\\",\\n \\"Plaintext\\": \\"QmFzZTY0IGVuY29kZWQgcGxhaW50****\\"\\n}","type":"json"}]',
'title' => 'GenerateDataKey',
'description' => '- For information about the permissions that are required to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation can be called using a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or a VPC. To access KMS over the Internet, you must enable the public endpoint. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- If you use a shared gateway to call this operation, the queries per second (QPS) limit for a single user is 1,000. If the limit is exceeded, API calls are throttled. This may affect your business. We recommend that you call this operation at a reasonable rate.'."\n"
."\n"
.'- If you use a dedicated gateway to call this operation, the QPS limit for a single user is based on the computing performance of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Description'."\n"
."\n"
.'This operation generates a random data key, encrypts the data key using the specified customer master key (CMK), and returns the plaintext and ciphertext of the data key. You can use the plaintext of the data key to encrypt data locally and outside of KMS. When you store the encrypted data, you must also store the ciphertext of the data key. You can obtain the plaintext of the data key from the Plaintext field and the ciphertext of the data key from the CiphertextBlob field in the response.'."\n"
."\n"
.'The CMK that you specify in the request is used only to encrypt the data key. It is not involved in the generation of the data key. KMS does not record or store the randomly generated data key. You are responsible for the persistence of the ciphertext of the data key.'."\n"
."\n"
.'We recommend that you perform the following steps to encrypt data locally:'."\n"
."\n"
.'1\\. Call the GenerateDataKey operation to obtain a data key for data encryption.'."\n"
."\n"
.'2\\. Use the plaintext of the data key returned in the Plaintext field of the response to encrypt data locally. Then, clear the plaintext of the data key from memory.'."\n"
."\n"
.'3\\. Store the ciphertext of the data key returned in the CiphertextBlob field of the response together with the encrypted data.'."\n"
."\n"
.'To decrypt data locally:'."\n"
."\n"
.'- Call the [Decrypt](~~28950~~) operation to decrypt the stored ciphertext of the data key. This operation returns the plaintext of the data key.'."\n"
."\n"
.'- Use the plaintext of the data key to decrypt data locally. Then, clear the plaintext of the data key from memory.'."\n"
."\n"
.'This topic provides an example of how to generate a random data key for a key with the ID `key-hzz630494463ejqjx****`.',
'requestParamsDescription' => 'For information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'GenerateDataKeyWithoutPlaintext' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54571',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique identifier of the CMK. You can also specify an alias that is bound to the CMK. For more information about how to use an alias, see Alias overview.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '599fa825-17de-417e-9554-bb032cc6****', 'title' => ''],
],
[
'name' => 'KeySpec',
'in' => 'query',
'schema' => [
'description' => 'The length of the data key to generate. Valid values:'."\n"
."\n"
.'- AES\\_256: a 256-bit symmetric key'."\n"
."\n"
.'- AES\\_128: a 128-bit symmetric key'."\n"
."\n"
.'> Use KeySpec or NumberOfBytes to specify the length of the data key. If you do not specify either parameter, KMS generates a 256-bit data key. If you specify both parameters, KMS ignores the KeySpec parameter.',
'type' => 'string',
'required' => false,
'enum' => ['AES_256', ' AES_128'],
'example' => 'AES_256',
'title' => '',
],
],
[
'name' => 'NumberOfBytes',
'in' => 'query',
'schema' => ['description' => 'The length of the data key to generate.<br> Valid values: 1 to 1024.<br> Unit: bytes<br><br><br><br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1024', 'minimum' => '0', 'example' => '256', 'title' => ''],
],
[
'name' => 'EncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string of key-value pairs. If you specify this parameter, you must provide the same parameter when you call the Decrypt operation. For more information, see [EncryptionContext](~~42975~~).', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the DryRun mode.'."\n"
."\n"
.'- true: enables the DryRun mode.'."\n"
."\n"
.'- false (default): disables the DryRun mode.'."\n"
."\n"
.'The DryRun mode is used to test API calls, verify your permissions on the required resources, and check if the request parameters are valid. If you enable the DryRun mode, KMS returns a failure response with a reason. The failure reasons include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter was not specified.'."\n"
."\n"
.'- ValidationError: The request parameters are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The ID of the key version used to encrypt the plaintext. This is the primary version of the specified CMK.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The globally unique identifier of the CMK.'."\n"
."\n"
.'> If you use an alias of the CMK in the KeyId parameter of the request, the ID of the CMK is returned.', 'type' => 'string', 'example' => '599fa825-17de-417e-9554-bb032cc6****', 'title' => ''],
'CiphertextBlob' => ['description' => 'The ciphertext of the data key. The data key is encrypted by the primary version of the specified CMK.', 'type' => 'string', 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. This ID is a globally unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'example' => '7021b6ec-4be7-4d3c-8a68-1e85d4d515a0', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"599fa825-17de-417e-9554-bb032cc6****\\",\\n \\"CiphertextBlob\\": \\"ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901qOjop4bTS****\\",\\n \\"RequestId\\": \\"7021b6ec-4be7-4d3c-8a68-1e85d4d515a0\\"\\n}","type":"json"}]',
'title' => 'GenerateDataKeyWithoutPlaintext',
'summary' => 'Generates a random data key in only ciphertext form, without the plaintext copy.',
'description' => '### Precautions'."\n"
."\n"
.'- For information about the access policy that a RAM user or RAM role needs to use this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation is accessible through a shared gateway or a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: Access KMS over the Internet or through a VPC domain name. This method requires Internet access to be enabled. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: Access KMS through a KMS private endpoint (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'- Calls through a shared gateway: The queries per second (QPS) limit for a single user is 1,000. If you exceed this limit, requests are throttled, which may affect your business. We recommend that you stay within this limit.'."\n"
."\n"
.'- Calls through a dedicated gateway: The QPS limit for a single user depends on the computing performance of your KMS instance. For more information, see [Performance metrics](~~480120~~).'."\n"
."\n"
.'### Details'."\n"
."\n"
.'This operation generates a random data key, encrypts it with a specified symmetric customer master key (CMK), and returns the ciphertext of the data key. This operation provides the same features as [GenerateDataKey](~~28948~~). The only difference is that this operation does not return the plaintext of the data key.'."\n"
."\n"
.'The CMK that you specify in the request is used only to encrypt the data key. It is not used to generate the data key. KMS does not record or store the randomly generated data key.'."\n"
."\n"
.'> - This operation is suitable for systems that do not need to immediately use the data key for data encryption. When encryption is required, the system calls the [Decrypt](~~28950~~) API to decrypt the ciphertext of the data key.'."\n"
.'>'."\n"
.'> - This operation is also suitable for distributed systems with different trust levels. For example, your system stores data in different partitions based on a defined policy. A module pre-creates these data partitions and generates a unique data key for each one. After this module initializes the control plane, it acts as a key distributor and does not produce or consume data. When data plane modules produce and consume data, they first retrieve the ciphertext of the data key for a partition. They then decrypt the ciphertext and use the plaintext data key to encrypt or decrypt data. Finally, they purge the plaintext data key from memory. In such a system, the key distributor does not need to access the plaintext of the data key. It only requires the \\`GenerateDataKeyWithoutPlaintext\\` permission for the relevant CMK. Data producers and consumers do not need to generate new data keys. They only require the \\`Decrypt\\` permission for the relevant CMK.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'GenerateMac' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify a key alias or a key Amazon Resource Name (ARN). For more information about aliases, refer to [Manage key aliases](~~480655~~).'."\n"
.'>When you access a key that belongs to a different Alibaba Cloud account, you must specify the key ARN. The format of a key ARN is `acs:kms:${region}:${account}:key/${keyid}`.', 'type' => 'string', 'required' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'Message',
'in' => 'query',
'schema' => ['description' => 'The data for which you want to generate a message authentication code. '."\n"
."\n"
.'The value is Base64-encoded. For example, if the hexadecimal data is `[0x31, 0x32, 0x33, 0x34]`, the corresponding Base64-encoded value is `MTIzNA==`.', 'type' => 'string', 'required' => true, 'example' => 'VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4=', 'title' => ''],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => ['description' => 'The algorithm that is used to generate the message authentication code. Valid values vary based on the key specification: '."\n"
."\n"
.'- HMAC_SM3'."\n"
."\n"
.'- HMAC_SHA_224'."\n"
."\n"
.'- HMAC_SHA_256'."\n"
."\n"
.'- HMAC_SHA_384'."\n"
."\n"
.'- HMAC_SHA_512', 'type' => 'string', 'required' => true, 'example' => 'HMAC_SHA_256', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable DryRun mode.'."\n"
."\n"
.'- true: enabled'."\n"
.'- false (default): disabled'."\n"
."\n"
.'DryRun mode is used to test API calls and verify whether you have the required permissions on the corresponding resources and whether the request parameters are correctly configured. When DryRun mode is enabled, KMS always returns a failure and provides the failure reason. Failure reasons include:'."\n"
."\n"
.'- DryRunOperationError: The request would succeed without the DryRun parameter.'."\n"
.'- ValidationError: The parameters specified in the request are invalid.'."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4c8ae23f-3a42-6791-a4ba-1faa77831c28'],
'KeyId' => ['description' => 'The globally unique identifier of the customer master key (CMK).'."\n"
."\n"
.'> If the KeyId parameter in the request uses a CMK alias, the response returns the CMK identifier that corresponds to the alias.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'Algorithm' => ['description' => 'The algorithm that is used to generate the message authentication code. Valid values vary based on the key specification: '."\n"
."\n"
.'- HMAC_SM3'."\n"
."\n"
.'- HMAC_SHA_224'."\n"
."\n"
.'- HMAC_SHA_256'."\n"
."\n"
.'- HMAC_SHA_384'."\n"
."\n"
.'- HMAC_SHA_512', 'type' => 'string', 'example' => 'HMAC_SHA_256', 'title' => ''],
'Mac' => ['description' => 'The Base64-encoded message authenticate code.', 'type' => 'string', 'example' => 'vz1Snp+jGJbgydCFRWVWxAwIMdyfKCSp+jnMWQ==', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Generate HMAC message authentication code',
'summary' => 'Generates an HMAC message authentication code for a message by using a specified key.',
'description' => 'For details about the access policy required when a RAM user or RAM role invokes this operation, refer to access control.'."\n"
."\n"
.'This operation can be invoked through a shared gateway or a dedicated gateway. For more information, refer to Alibaba Cloud SDK.'."\n"
."\n"
.'- Shared gateway: Access KMS through a public or VPC endpoint. This method requires you to enable the public network access switch. For more information, refer to accessing keys in a KMS instance over the Internet.'."\n"
.'- Dedicated gateway: Access KMS through a KMS private endpoint (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4c8ae23f-3a42-6791-a4ba-1faa77831c28\\",\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"Algorithm\\": \\"HMAC_SHA_256\\",\\n \\"Mac\\": \\"vz1Snp+jGJbgydCFRWVWxAwIMdyfKCSp+jnMWQ==\\"\\n}","type":"json"}]',
],
'GetClientKey' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '190829',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ClientKeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the client key.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'KAAP.66abf237-63f6-4625-b8cf-47e1086e****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The details of the client key.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. Alibaba Cloud generates this unique ID for each request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '63d849a6-045b-4a57-ad9f-c5f756cea9e9'],
'ClientKeyId' => ['description' => 'The ID of the client key.', 'type' => 'string', 'example' => 'KAAP.66abf237-63f6-4625-b8cf-47e1086e****', 'title' => ''],
'CreateTime' => ['description' => 'The time when the client key was created.', 'type' => 'string', 'example' => '2023-08-31T09:14:38Z', 'title' => ''],
'KeyAlgorithm' => ['description' => 'The algorithm of the private key for the client key.', 'type' => 'string', 'example' => 'RSA_2048', 'title' => ''],
'KeyOrigin' => ['description' => 'The creator of the client key.'."\n"
."\n"
.'Currently, client keys are generated only by KMS. The value is \\`KMS\\_PROVIDED\\`.', 'type' => 'string', 'example' => 'KMS_PROVIDED', 'title' => ''],
'PublicKeyData' => ['description' => 'The content of the public key for the client key.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----', 'title' => ''],
'NotAfter' => ['description' => 'The time when the client key expires.', 'type' => 'string', 'example' => '2028-08-31T17:14:33Z', 'title' => ''],
'NotBefore' => ['description' => 'The time when the validity period of the client key starts.', 'type' => 'string', 'example' => '2023-08-31T17:14:33Z', 'title' => ''],
'AapName' => ['description' => 'The name of the application access point (AAP).', 'type' => 'string', 'example' => 'aap_test', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetClientKey',
'summary' => 'Retrieves information about a client key.',
'description' => 'For information about the access policy required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"63d849a6-045b-4a57-ad9f-c5f756cea9e9\\",\\n \\"ClientKeyId\\": \\"KAAP.66abf237-63f6-4625-b8cf-47e1086e****\\",\\n \\"CreateTime\\": \\"2023-08-31T09:14:38Z\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"KeyOrigin\\": \\"KMS_PROVIDED\\",\\n \\"PublicKeyData\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----\\",\\n \\"NotAfter\\": \\"2028-08-31T17:14:33Z\\",\\n \\"NotBefore\\": \\"2023-08-31T17:14:33Z\\",\\n \\"AapName\\": \\"aap_test\\"\\n}","type":"json"}]',
],
'GetDefaultKmsInstance' => [
'summary' => 'Queries the default KMS instance in a specified region.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '274501',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response message.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => 'bbc4e9ab-c76f-48ca-9c2a-8535772117e2'],
'DefaultKmsInstanceId' => ['description' => 'The ID of the default KMS instance.', 'type' => 'string', 'example' => 'kst-hzz65f176a0ogplgq****', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetDefaultKmsInstance',
'description' => '- For information about the access policy that is required to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This API is for users who migrate from KMS 1.0 to KMS 3.0. After the migration is complete, if you create an Asset without specifying a KMS instance, the Asset is created in the default KMS instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"bbc4e9ab-c76f-48ca-9c2a-8535772117e2\\",\\n \\"DefaultKmsInstanceId\\": \\"kst-hzz65f176a0ogplgq****\\"\\n}","type":"json"}]',
],
'GetKeyPolicy' => [
'summary' => 'Queries the key policy of a CMK in a KMS instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '206082',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID or Alibaba Cloud Resource Name (ARN) of the key.'."\n"
."\n"
.'> When you access a key in another Alibaba Cloud account, you must enter the ARN of the key. The ARN of a key is in the `acs:kms:${region}:${account}:key/${keyid}` format.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'key-hzz630494463ejqjx****'],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => 'The name of the key policy. Only the static value default is supported.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'default'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '381D5D33-BB8F-395F-8EE4-AE3B84B523C8'],
'Policy' => ['description' => 'The key policy.', 'type' => 'string', 'example' => '{"Statement": [{"Action": ["kms:*"],"Effect": "Allow","Principal": {"RAM": ["acs:ram::190325303126****:*","acs:ram::119285303511****:*"]},"Resource": ["*"],"Sid": "kms default key policy"}],"Version": "1" }', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter needed but no provided.', 'description' => 'The required parameters are not specified.'],
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system.', 'description' => 'You are not authorized to perform this operation.'],
['errorCode' => 'Forbidden.KeyPolicyUnSupported', 'errorMessage' => 'The specified key does not support key policy.', 'description' => 'The specified key does not support key policies.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Policy not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"381D5D33-BB8F-395F-8EE4-AE3B84B523C8\\",\\n \\"Policy\\": \\"{\\\\\\"Statement\\\\\\": [{\\\\\\"Action\\\\\\": [\\\\\\"kms:*\\\\\\"],\\\\\\"Effect\\\\\\": \\\\\\"Allow\\\\\\",\\\\\\"Principal\\\\\\": {\\\\\\"RAM\\\\\\": [\\\\\\"acs:ram::190325303126****:*\\\\\\",\\\\\\"acs:ram::119285303511****:*\\\\\\"]},\\\\\\"Resource\\\\\\": [\\\\\\"*\\\\\\"],\\\\\\"Sid\\\\\\": \\\\\\"kms default key policy\\\\\\"}],\\\\\\"Version\\\\\\": \\\\\\"1\\\\\\" }\\"\\n}","type":"json"}]',
'title' => 'GetKeyPolicy',
'description' => '- For more information about the access policy required for a Resource Access Management (RAM) user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Because the key policy name can only be set to default, you must set the PolicyName parameter to default when you query the key policy. Otherwise, a `Not Found` error is returned.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'GetKmsInstance' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '191299',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
],
'parameters' => [
[
'name' => 'KmsInstanceId',
'in' => 'query',
'schema' => ['title' => 'A short description of struct', 'description' => 'The ID of the KMS instance to query.', 'type' => 'string', 'required' => true, 'example' => 'kst-bjj62f5ba3dnpb6v8****'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The details of the KMS instance.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to locate and troubleshoot issues.', 'type' => 'string', 'example' => '46b4a94a-57d2-44b4-9810-1e87d31abb33'],
'KmsInstance' => [
'description' => 'The details of the KMS instance.',
'type' => 'object',
'properties' => [
'InstanceId' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'example' => 'kst-bjj62f5ba3dnpb6v8****', 'title' => ''],
'InstanceName' => ['description' => 'The name of the KMS instance.', 'type' => 'string', 'example' => 'kst-bjj62f5ba3dnpb6v8****', 'title' => ''],
'Status' => ['description' => 'The status of the KMS instance. Valid values:'."\n"
."\n"
.'- `Uninitialized`: The instance is not enabled.'."\n"
."\n"
.'- `Connecting`: The instance is connecting.'."\n"
."\n"
.'- `Connected`: The instance is enabled.'."\n"
."\n"
.'- `Disconnected`: The instance is disconnected.'."\n"
."\n"
.'- `Error`: The instance is in an error state.', 'type' => 'string', 'example' => 'Connected', 'title' => ''],
'CreateTime' => ['description' => 'The creation time of the KMS instance.', 'type' => 'string', 'example' => '2023-09-05T12:44:20Z', 'title' => ''],
'Spec' => ['description' => 'The computing performance of the KMS instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'KeyNum' => ['description' => 'The maximum number of keys that can be created in the KMS instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'SecretNum' => ['description' => 'The maximum number of credentials that can be created in the KMS instance.', 'type' => 'string', 'example' => '10', 'title' => ''],
'VpcNum' => ['description' => 'The maximum number of VPCs that can be associated with the KMS instance for access control.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''],
'VpcId' => ['description' => 'The VPC to which the KMS instance is attached.', 'type' => 'string', 'example' => 'vpc-bp19z7cwmltad5dff****', 'title' => ''],
'ZoneIds' => [
'description' => 'The zones to which the KMS instance is attached.',
'type' => 'array',
'title' => '',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'example' => '"cn-hangzhou-k", "cn-hangzhou-j"',
],
'VswitchIds' => [
'description' => 'The vSwitches in the VPC to which the KMS instance is attached.',
'type' => 'array',
'title' => '',
'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
'example' => 'vsw-bp1i512amda6d10a0****',
],
'EndDate' => ['description' => 'The expiration time of the KMS instance.', 'type' => 'string', 'title' => '', 'example' => '2023-10-05T16:00:00Z'],
'StartDate' => ['description' => 'The time when the KMS instance was enabled.', 'type' => 'string', 'example' => '2023-09-05T12:44:19Z', 'title' => ''],
'CaCertificateChainPem' => ['description' => 'The CA certificate chain for the KMS instance in PEM format.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\r\\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----', 'title' => ''],
'BindVpcs' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'BindVpc' => [
'description' => 'A list of associated VPCs.'."\n"
."\n"
.'> You can associate the KMS instance with additional VPCs in the same region, allowing self-managed applications in those VPCs to access the instance. These VPCs can belong to the same or different Alibaba Cloud accounts.',
'type' => 'array',
'items' => [
'description' => 'Details of an associated VPC.'."\n"
."\n"
.'> You can associate the KMS instance with additional VPCs in the same region, allowing self-managed applications in those VPCs to access the instance. These VPCs can belong to the same or different Alibaba Cloud accounts.',
'type' => 'object',
'properties' => [
'RegionId' => ['description' => 'The region where the VPC is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'VpcId' => ['description' => 'The ID of the VPC.', 'type' => 'string', 'example' => 'vpc-bp19z7djuhtad5dff****', 'title' => ''],
'VpcOwnerId' => ['description' => 'The Alibaba Cloud account to which the VPC belongs.', 'type' => 'string', 'example' => '190325303126****', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch in the VPC.', 'type' => 'string', 'example' => 'vsw-bp1i512amhdje10f1****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'ChargeType' => ['description' => 'The billing method of the instance. Valid values:'."\n"
."\n"
.'- `PREPAY`: subscription'."\n"
."\n"
.'- `POSTPAY`: pay-as-you-go', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''],
'ProductVersion' => ['description' => 'The version of the KMS instance.', 'type' => 'string', 'example' => '3', 'title' => ''],
'SaleStatus' => ['description' => 'The sales status of the instance.', 'type' => 'string', 'example' => 'Normal', 'title' => ''],
'Log' => ['description' => 'Indicates whether logging is enabled for the KMS instance. Valid values: `1` (enabled) and `0` (disabled).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'LogStorage' => ['description' => 'The log storage capacity. Unit: GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''],
'ProductType' => ['description' => 'The product type.<br>Subscription:<br>`kms_ddi_public_cn`: China site<br>`kms_ddi_public_intl`: international site<br>Pay-as-you-go:<br>`kms_ppi_public_cn`: China site<br>`kms_ppi_public_intl`: international site<br><br><br><br><br><br>', 'type' => 'string', 'example' => 'kms_ddi_public_cn', 'title' => ''],
],
'example' => '3',
'title' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalTimestamp', 'errorMessage' => 'The input parameter Timestamp that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter timestamp indicates that the request is outside the processing time range.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46b4a94a-57d2-44b4-9810-1e87d31abb33\\",\\n \\"KmsInstance\\": {\\n \\"InstanceId\\": \\"kst-bjj62f5ba3dnpb6v8****\\",\\n \\"InstanceName\\": \\"kst-bjj62f5ba3dnpb6v8****\\",\\n \\"Status\\": \\"Connected\\",\\n \\"CreateTime\\": \\"2023-09-05T12:44:20Z\\",\\n \\"Spec\\": 1000,\\n \\"KeyNum\\": 1000,\\n \\"SecretNum\\": \\"10\\",\\n \\"VpcNum\\": 5,\\n \\"VpcId\\": \\"vpc-bp19z7cwmltad5dff****\\",\\n \\"ZoneIds\\": [\\n \\"\\"\\n ],\\n \\"VswitchIds\\": [\\n \\"\\"\\n ],\\n \\"EndDate\\": \\"2023-10-05T16:00:00Z\\",\\n \\"StartDate\\": \\"2023-09-05T12:44:19Z\\",\\n \\"CaCertificateChainPem\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\r\\\\\\\\nMIIDuzCCAqOgAwIBAgIJALTKwWAjvbMiMA0GCSqGSIb3DQEBCwUAMHQxCzAJBgNV****-----END CERTIFICATE-----\\",\\n \\"BindVpcs\\": {\\n \\"BindVpc\\": [\\n {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-bp19z7djuhtad5dff****\\",\\n \\"VpcOwnerId\\": \\"190325303126****\\",\\n \\"VSwitchId\\": \\"vsw-bp1i512amhdje10f1****\\"\\n }\\n ]\\n },\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"ProductVersion\\": \\"3\\",\\n \\"SaleStatus\\": \\"Normal\\",\\n \\"Log\\": 1,\\n \\"LogStorage\\": 100,\\n \\"ProductType\\": \\"kms_ddi_public_cn\\"\\n }\\n}","type":"json"}]',
'title' => 'GetKmsInstance',
'summary' => 'Retrieves the details of a KMS instance.',
'description' => 'Refer to [Resource Access Management](~~2767210~~) for the access policy required to call this OpenAPI as a RAM user or RAM role.',
'changeSet' => [
['createdAt' => '2025-11-28T01:56:41.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2025-11-27T11:59:54.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T11:59:49.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T11:47:52.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T11:47:41.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T11:42:12.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T11:39:16.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T08:17:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T08:15:59.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T07:58:43.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-18T03:35:59.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-18T03:28:08.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-18T02:37:21.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
],
'GetKmsInstanceQuotaInfos' => [
'summary' => 'Queries the quota usage and limits for a KMS instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '290515',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'KmsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS instance to query.', 'type' => 'string', 'required' => false, 'example' => 'kst-bjj62f5ba3dnpb6v8****', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource type. Valid values:'."\n"
."\n"
.'- `key`: key quota'."\n"
."\n"
.'- `secret`: secret quota'."\n"
."\n"
.'- `qps`: queries per second (QPS) quota'."\n"
."\n"
.'- `vpc`: Virtual Private Cloud (VPC) quota',
'enumValueTitles' => ['qps' => 'qps', 'vpc' => 'vpc', 'secret' => 'secret', 'key' => 'key'],
'type' => 'string',
'required' => false,
'example' => 'key',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f'],
'KmsInstanceId' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'example' => 'kst-hzz6****', 'title' => ''],
'KmsInstanceQuotaInfos' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ResourceQuota' => ['description' => 'The quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''],
'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'key', 'title' => ''],
'UsedQuantity' => ['description' => 'The quota usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'An array of quota details for the instance.',
'title' => '',
'example' => '',
],
],
'description' => 'The response schema.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceStateInvalid', 'errorMessage' => 'The DKMS instance state is invalid.', 'description' => 'Your dedicated KMS instance is invalid.'],
['errorCode' => 'Forbidden.DKMSInstanceNotFound', 'errorMessage' => 'The specified DKMS Instance is not found.', 'description' => 'Your dedicated KMS instance is not found.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetKmsInstanceQuotaInfos',
'changeSet' => [
['createdAt' => '2025-11-27T08:32:27.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T08:17:00.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T08:15:59.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-27T07:58:43.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-11-18T03:35:59.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f\\",\\n \\"KmsInstanceId\\": \\"kst-hzz6****\\",\\n \\"KmsInstanceQuotaInfos\\": [\\n {\\n \\"ResourceQuota\\": 12,\\n \\"ResourceType\\": \\"key\\",\\n \\"UsedQuantity\\": 10\\n }\\n ]\\n}","type":"json"}]',
],
'GetParametersForImport' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK.'."\n"
."\n"
.'> You can import key material only for CMKs whose Origin parameter is set to EXTERNAL.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202b9877-5a25-46e3-a763-e20791b5****', 'title' => ''],
],
[
'name' => 'WrappingAlgorithm',
'in' => 'query',
'schema' => ['description' => 'The algorithm that is used to encrypt key material.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSAES_PKCS1_V1_5', 'title' => ''],
],
[
'name' => 'WrappingKeySpec',
'in' => 'query',
'schema' => ['description' => 'The type of the public key that is used to encrypt key material.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RSA_2048', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The globally unique ID of the CMK.'."\n"
."\n"
.'The value of this parameter is required when you call the [ImportKeyMaterial](~~68622~~) operation.'."\n", 'type' => 'string', 'example' => '202b9877-5a25-46e3-a763-e20791b5****', 'title' => ''],
'ImportToken' => ['description' => 'The token that is used to import key material.'."\n"
."\n"
.'The token is valid for 24 hours. The value of this parameter is required when you call the [ImportKeyMaterial](~~68622~~) operation.'."\n", 'type' => 'string', 'example' => 'Base64String', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc', 'title' => ''],
'TokenExpireTime' => ['description' => 'The time when the token expires.'."\n", 'type' => 'string', 'example' => '2018-01-25T00:01:02Z', 'title' => ''],
'PublicKey' => ['description' => 'The public key that is used to encrypt key material.'."\n"
."\n"
.'The public key is Base64-encoded.'."\n", 'type' => 'string', 'example' => 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Unsupported.Origin', 'errorMessage' => 'This key origin is not valid for this api', 'description' => 'The key origin is not supported for this API operation.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"KeyId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\",\\n \\"ImportToken\\": \\"Base64String\\",\\n \\"RequestId\\": \\"8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc\\",\\n \\"TokenExpireTime\\": \\"2018-01-25T00:01:02Z\\",\\n \\"PublicKey\\": \\"MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetParametersForImportResponse>\\n <KeyId>202b9877-5a25-46e3-a763-e20791b5****</KeyId>\\n <ImportToken>Base64String</ImportToken>\\n <RequestId>8cdf51fd-bcd6-d79a-0ef4-e52c9b5466dc</RequestId>\\n <TokenExpireTime>2018-01-25T00:01:02Z</TokenExpireTime>\\n <PublicKey>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlls4uIBxD0GG84C+lGBO6Dhpf1J3XimC6cPmPNaKKJMOzoX4tD+C+r7aZv8lZ3vnPfxuxvy/YwG+whUxTEEFUdqJTOIzhPfYucupqKM92crVHIuG+xtMVeHKjyTr+UrtKCsQikqHT+19yDRN/RMoo2HUx0gmEnRyXd8t3JyUXun9FdoxKA08GrsV7nodb9ZsoBLhnev7tTLcXvLyKW6XG1ZQCQm6dPnbnwLeDXR7uK0Lqn9PM28mBIdaiQUQxj2XbM1CoJA+JiyVX3Ptdb+4rqukb4Rb05B80Bs9xV/cf7FIku08l7xGhrGiQFq+DFXwQWtwihXHZxz3LhldU+4ZPwID****</PublicKey>\\n</GetParametersForImportResponse>","errorExample":""}]',
'title' => 'GetParametersForImport',
'summary' => 'Queries the parameters that are used to import key material for a customer master key (CMK).',
'description' => 'The returned parameters can be used to call the [ImportKeyMaterial](https://www.alibabacloud.com/help/en/key-management-service/latest/importkeymaterial) operation.'."\n"
.'- You can import key material only for CMKs whose Origin parameter is set to EXTERNAL.'."\n"
.'- The public key and token that are returned by the GetParametersForImport operation must be used together. The public key and token can be used to import key material only for the CMK that is specified when you call the operation.'."\n"
.'- The public key and token that are returned vary each time you call the GetParametersForImport operation.'."\n"
.'- You must specify the type of the public key and the encryption algorithm that are used to encrypt key material. The following table lists the types of public keys and the encryption algorithms allowed for each type. '."\n"
."\n"
.'| Public key type | Encryption algorithm | Description |'."\n"
.'| --------------- | -------------------- | ----------- |'."\n"
.'| RSA_2048 | RSAES_PKCS1_V1_5 '."\n"
."\n"
.'RSAES_OAEP_SHA_1 '."\n"
."\n"
.'RSAES_OAEP_SHA_256 | CMKs of all regions and all protection levels are supported. '."\n"
."\n"
.'Dedicated Key Management Service (KMS) does not support RSAES_OAEP_SHA_1. |'."\n"
.'| EC_SM2 | SM2PKE | CMKs whose ProtectionLevel is set to HSM are supported. The SM2 algorithm is developed and approved by the State Cryptography Administration of China. The SM2 algorithm can be used only to import key material for a CMK whose ProtectionLevel is set to HSM. You can use the SM2 algorithm only when you enable the Managed HSM feature for KMS in the Chinese mainland. For more information, see [Overview of Managed HSM](https://www.alibabacloud.com/help/en/key-management-service/latest/managed-hsm-overview). |'."\n"
.'For more information, see [Import key material](https://www.alibabacloud.com/help/en/key-management-service/latest/import-key-material). This topic provides an example on how to query the parameters that are used to import key material for a CMK. The ID of the CMK is `1234abcd-12ab-34cd-56ef-12345678****`, the encryption algorithm is `RSAES_PKCS1_V1_5`, and the public key is of the `RSA_2048` type. The parameters that are returned include the ID of the CMK, the public key that is used to encrypt the key material, the token that is used to import the key material, and the time when the token expires.',
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetPublicKey' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique identifier of the customer master key (CMK). This parameter can also be an alias that is bound to the CMK. For more information, see [Use of aliases](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
],
[
'name' => 'KeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The globally unique identifier of the key version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the DryRun mode.'."\n"
."\n"
.'- true: enables the DryRun mode.'."\n"
."\n"
.'- false (default): disables the DryRun mode.'."\n"
."\n"
.'The DryRun mode is used to test API calls, verify your permissions on resources, and check whether the parameters are valid. If you enable the DryRun mode, KMS always returns a failed response and a failure reason. The failure reasons include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter is not specified.'."\n"
."\n"
.'- ValidationError: The specified parameters in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform the operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyVersionId' => ['description' => 'The globally unique identifier of the key version.', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyId' => ['description' => 'The globally unique identifier of the CMK.'."\n"
."\n"
.'> If you specify an alias of the CMK for the KeyId parameter in the request, the ID of the CMK to which the alias is bound is returned.', 'type' => 'string', 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d', 'title' => ''],
'PublicKey' => ['description' => 'The public key in the PEM format.', 'type' => 'string', 'example' => '-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\\nJQIDAQAB\\n-----END PUBLIC KEY-----\\n', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyVersionId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyId\\": \\"5c438b18-05be-40ad-b6c2-3be6752c****\\",\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\",\\n \\"PublicKey\\": \\"-----BEGIN PUBLIC KEY-----\\\\\\\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs5Yu9AEgATN2/e3nUz1K\\\\\\\\nEy6ng8MSPutcse2/VECG/NUF9C6D4IsJ64ShzY3dcn34WYzTOe916eMJFxyrNrSw\\\\\\\\nHtc4UOR5AvaoRrfpgu2uq+i70/ZXrWL+pGb1hgZV8cWheIHMxwrR3IiQlM5qN7EF\\\\\\\\n9BdyWtyBfUGsp0Bn1VqlPc5G0x0a9xU2z9YtP994yDenNVIoIQ6Cov1lIEuwXAb2\\\\\\\\n7boC41ePXwD0JWt41sP+rgCmpjBx00puIG+IlnoReEgI1ZGYmK98GgA/XzmNjZiD\\\\\\\\nyvXJZAcM33Ue85+PkR5iHTtSEbi4QAoqpJabprUzz3Fin2j1dRrcacxGb7p31A9c\\\\\\\\nJQIDAQAB\\\\\\\\n-----END PUBLIC KEY-----\\\\\\\\n\\"\\n}","type":"json"}]',
'title' => 'GetPublicKey',
'summary' => 'Retrieves the public key of an asymmetric key. You can use the public key to encrypt data or verify a signature on your device.',
'description' => '- For more information about the access policy required for a RAM user or RAM role to call this OpenAPI operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation supports both shared gateways and dedicated gateways. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' - Shared gateway: You can access KMS over the Internet or using a VPC domain name. If you access KMS over the Internet, you must enable Internet access. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.' - Dedicated gateway: You can access KMS using the private endpoint of KMS (`<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com`).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'GetRandomPassword' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54579',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PasswordLength',
'in' => 'query',
'schema' => ['description' => 'The number of bytes that the password to be generated contains.'."\n"
."\n"
.'Valid values: 8 to 128.'."\n"
."\n"
.'Default value: 32', 'type' => 'string', 'required' => false, 'docRequired' => false, 'default' => '32', 'example' => '32', 'title' => ''],
],
[
'name' => 'ExcludeCharacters',
'in' => 'query',
'schema' => ['description' => 'The characters that are not included in the password to be generated.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'`Valid characters: 0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ! \\"#$%&\'()*+,-. /:;<=>? @[\\] your_project_id} ~ `.'."\n"
."\n"
.'This parameter is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'ABCabc', 'title' => ''],
],
[
'name' => 'ExcludeLowercase',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to exclude lowercase letters.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'type' => 'string',
'required' => false,
'default' => 'false',
'enum' => ['false', 'true'],
'example' => 'false',
'title' => '',
],
],
[
'name' => 'ExcludeUppercase',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to exclude uppercase letters.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'type' => 'string',
'required' => false,
'default' => 'false',
'enum' => ['false', 'true'],
'example' => 'false',
'title' => '',
],
],
[
'name' => 'ExcludeNumbers',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to exclude digits.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'type' => 'string',
'required' => false,
'default' => 'false',
'enum' => ['false', 'true'],
'example' => 'false',
'title' => '',
],
],
[
'name' => 'ExcludePunctuation',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to exclude special characters.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'type' => 'string',
'required' => false,
'default' => 'false',
'enum' => ['false', 'true'],
'example' => 'false',
'title' => '',
],
],
[
'name' => 'RequireEachIncludedType',
'in' => 'query',
'schema' => [
'description' => 'Specifies whether to include all the preceding character types.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'type' => 'string',
'required' => false,
'docRequired' => false,
'default' => 'true',
'enum' => ['false', 'true'],
'example' => 'true',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RandomPassword' => ['description' => 'The generated random password.', 'type' => 'string', 'example' => 'IxGn>NMmNB(y?iZ<Yc,_H/{2GC\'U****', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6b0cbe25-5e33-467e-972e-7a83c6c97604', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'title' => 'GetRandomPassword',
'summary' => 'Generates a random password string.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RandomPassword\\": \\"IxGn>NMmNB(y?iZ<Yc,_H/{2GC\'U****\\",\\n \\"RequestId\\": \\"6b0cbe25-5e33-467e-972e-7a83c6c97604\\"\\n}","type":"json"}]',
],
'GetSecretPolicy' => [
'summary' => 'Queries the access policy of a specified secret in a KMS instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '206109',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name or Alibaba Cloud Resource Name (ARN) of the credential.'."\n"
."\n"
.'> If you access a credential that belongs to another Alibaba Cloud account, you must specify the ARN of the credential. The ARN of a credential must be in the `acs:kms:${region}:${account}:secret/${secret-name}` format.', 'type' => 'string', 'required' => true, 'example' => 'secret_test', 'title' => ''],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => 'The name of the credential policy. Only the static field default is supported.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use the ID to troubleshoot and locate issues.', 'type' => 'string', 'title' => '', 'example' => '381D5D33-BB8F-395F-8EE4-AE3BB4B523C8'],
'Policy' => ['description' => 'The credential policy.', 'type' => 'string', 'example' => '{"Version":"1","Statement": [{"Sid":"kms default secret policy","Effect":"Allow","Principal":{"RAM": ["acs:ram::119285303511****:*"]},"Action":["kms:*"],"Resource": ["*"] }] }', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter needed but no provided.', 'description' => 'The required parameters are not specified.'],
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system.', 'description' => 'You are not authorized to perform this operation.'],
['errorCode' => 'Forbidden.KeyPolicyUnSupported', 'errorMessage' => 'The specified key does not support key policy.', 'description' => 'The specified key does not support key policies.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceStateInvalid', 'errorMessage' => 'The DKMS instance state is invalid.', 'description' => 'Your dedicated KMS instance is invalid.'],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found.', 'description' => 'The resource is not found.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
503 => [
['errorCode' => 'SerivceUnvailableTemporary', 'errorMessage' => 'Service Unvailable Temporary', 'description' => 'The service is temporarily unavailable.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"381D5D33-BB8F-395F-8EE4-AE3BB4B523C8\\",\\n \\"Policy\\": \\"{\\\\\\"Version\\\\\\":\\\\\\"1\\\\\\",\\\\\\"Statement\\\\\\": [{\\\\\\"Sid\\\\\\":\\\\\\"kms default secret policy\\\\\\",\\\\\\"Effect\\\\\\":\\\\\\"Allow\\\\\\",\\\\\\"Principal\\\\\\":{\\\\\\"RAM\\\\\\": [\\\\\\"acs:ram::119285303511****:*\\\\\\"]},\\\\\\"Action\\\\\\":[\\\\\\"kms:*\\\\\\"],\\\\\\"Resource\\\\\\": [\\\\\\"*\\\\\\"] }] }\\"\\n}","type":"json"}]',
'title' => 'GetSecretPolicy',
'description' => '- For information about the access policy required for a RAM user or RAM role to call this OpenAPI, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- A credential policy name can be set only to default. Therefore, you must set the PolicyName parameter to default when you query the credential policy. Otherwise, a `Not Found` error is returned.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'GetSecretValue' => [
'summary' => 'Retrieve the credential value.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54580',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name or ARN of the credential. '."\n"
.'> When accessing a credential under another Alibaba Cloud account, you must specify the credential ARN. The ARN format is `acs:kms:${region}:${account}:secret/${secret-name}`. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'VersionStage',
'in' => 'query',
'schema' => ['description' => 'The version stage. Default value: ACSCurrent. '."\n"
."\n"
.'If you specify this parameter, the credential value of the specified version stage is returned. If you do not specify this parameter, the credential value of the ACSCurrent version stage is returned. '."\n"
.'> For RDS credentials, PolarDB credentials, Redis/Tair credentials, RAM credentials, and ECS credentials, you can retrieve only the credential values corresponding to the ACSPrevious or ACSCurrent version stages. ', 'type' => 'string', 'required' => false, 'example' => 'ACSCurrent', 'title' => ''],
],
[
'name' => 'VersionId',
'in' => 'query',
'schema' => ['description' => 'Version number.'."\n"
."\n"
.'> The VersionId parameter is not supported for RDS credentials, PolarDB credentials, Redis/Tair credentials, RAM credentials, and ECS credentials. If you specify this parameter, it will be ignored.', 'type' => 'string', 'required' => false, 'example' => 'v1', 'title' => ''],
],
[
'name' => 'FetchExtendedConfig',
'in' => 'query',
'schema' => ['description' => 'Indicates whether to retrieve the extended configuration of the credential. Valid values:'."\n"
."\n"
.'- true: Retrieve '."\n"
.'- false (Default Value): Do not retrieve '."\n"
."\n"
.'> Generic secrets do not support extended configuration. If you specify this parameter, it will be ignored.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Indicates whether to enable DryRun mode.'."\n"
."\n"
.'- true: Enabled '."\n"
.'- false (Default Value): Disabled '."\n"
."\n"
.'DryRun mode is used for Testing API Calls to authenticate whether you have the required permissions on the specified resource and whether the Request Parameters are correctly configured. When DryRun mode is enabled, KMS always returns a failed response along with the failure reason. Possible failure reasons include:'."\n"
."\n"
.'- DryRunOperationError: The request would succeed if the DryRun parameter were not specified. '."\n"
.'- ValidationError: One or more parameters in the request are invalid. '."\n"
.'- AccessDeniedError: You do not have permission to execute this operation on the KMS resource.'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretDataType' => ['description' => 'The value type of the credential. Valid values:'."\n"
.'- text'."\n"
.'- binary', 'type' => 'string', 'example' => 'binary', 'title' => ''],
'CreateTime' => ['description' => 'The time when the credential was created.', 'type' => 'string', 'example' => '2024-02-21T15:39:26Z', 'title' => ''],
'VersionId' => ['description' => 'The version number of the credential.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
'NextRotationDate' => ['description' => 'The time of the next rotation. '."\n"
."\n"
.'> This parameter is returned only when automatic rotation is enabled. ', 'type' => 'string', 'example' => '2024-07-06T18:22:03Z', 'title' => ''],
'SecretData' => ['description' => 'The value of the credential. KMS decrypts the stored ciphertext and returns this parameter. '."\n"
."\n"
.'- For generic secrets, the credential value you specified is returned. '."\n"
."\n"
.'- For RDS credentials and Redis/Tair credentials, the credential value is in the format: `{"AccountName":"","AccountPassword":""}`. '."\n"
."\n"
.'- For RAM credentials, the credential value is in the format: `{"AccessKeyId":"Adfdsfd","AccessKeySecret":"fdsfdsf","GenerateTimestamp": "2023-03-25T10:42:40Z"}`. '."\n"
."\n"
.'- For ECS credentials, the credential value is in one of the following formats: '."\n"
.' - Security token type: `{"UserName":"ecs-user","Password":"H5asdasdsads****"}`. '."\n"
.' - Public-private key pair type (private key in PEM format): `{"UserName":"ecs-user","PublicKey":"ssh-rsa ****mKwnVix9YTFY9Rs= imported-openssh-key","PrivateKey": "d6bee1cb-2e14-4277-ba6b-73786b21****"}`. '."\n"
."\n"
.'- For PolarDB credentials, the credential value is in the format: `{"AccountName":"","AccountPassword":""}`. ', 'type' => 'string', 'example' => 'testdata1', 'title' => ''],
'RotationInterval' => ['description' => 'The epoch for automatic credential rotation. '."\n"
.'The format is `integer[unit]`, where `integer` indicates the time duration and `unit` indicates the time unit. Valid value for `unit`: s (seconds). For example, a 7-day rotation epoch is 604800s.'."\n"
."\n"
.'> This parameter is returned only when automatic rotation is enabled.', 'type' => 'string', 'example' => '604800s', 'title' => ''],
'ExtendedConfig' => ['description' => 'The extended configuration of the credential. '."\n"
."\n"
.'> This parameter is returned only for RDS credentials, PolarDB credentials, Redis/Tair credentials, RAM credentials, or ECS credentials when FetchExtendedConfig is set to true. ', 'type' => 'string', 'example' => '{\\"SecretSubType\\":\\"SingleUser\\", \\"DBInstanceId\\":\\"rm-uf667446pc955****\\", \\"CustomData\\":{} }', 'title' => ''],
'LastRotationDate' => ['description' => 'The time of the most recent rotation. '."\n"
."\n"
.'> This parameter is returned only if the credential has been rotated.', 'type' => 'string', 'example' => '2023-07-05T08:22:03Z', 'title' => ''],
'RequestId' => ['description' => 'The ID of the current request. Alibaba Cloud generates a unique identifier for each request, which can be used for troubleshooting and issue tracking.', 'type' => 'string', 'example' => '6a3e9c36-1150-4881-84d3-eb8672fcafad', 'title' => ''],
'SecretName' => ['description' => 'The name of the credential. ', 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'AutomaticRotation' => ['description' => 'Indicates whether automatic rotation is enabled. Valid values: '."\n"
.'- Enabled: Automatic rotation is enabled. '."\n"
.'- Disabled: Automatic rotation is disabled. '."\n"
.'- Invalid: The rotation status is abnormal, and KMS cannot automatically rotate the credential for you. '."\n"
."\n"
.'> This parameter is returned only for RDS credentials, PolarDB credentials, Redis/Tair credentials, RAM credentials, or ECS credentials. ', 'type' => 'string', 'example' => 'Enabled', 'title' => ''],
'SecretType' => ['description' => 'The type of the credential. Valid values:'."\n"
.'- Generic: generic secret. '."\n"
.'- Rds: RDS credential. '."\n"
.'- Redis: Redis/Tair credential.'."\n"
.'- RAMCredentials: RAM credential. '."\n"
.'- ECS: ECS credential.'."\n"
.'- PolarDB: PolarDB credential.', 'type' => 'string', 'example' => 'Generic', 'title' => ''],
'VersionStages' => [
'itemNode' => true,
'type' => 'object',
'properties' => [
'VersionStage' => [
'description' => 'The status mark of the credential version.',
'type' => 'array',
'items' => ['description' => 'The status mark of the credential version.', 'type' => 'string', 'example' => '{ "VersionStage": [ "ACSCurrent" ] }', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Forbidden.DKMSInstanceStateInvalid', 'errorMessage' => 'The DKMS instance state is invalid.', 'description' => 'Your dedicated KMS instance is invalid.'],
['errorCode' => 'Forbidden.DKMSInstanceNotFound', 'errorMessage' => 'The specified DKMS Instance is not found.', 'description' => 'Your dedicated KMS instance is not found.'],
],
[
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found.', 'description' => 'The resource is not found.'],
],
],
'title' => 'Retrieve Credential Value ',
'description' => '- For details about the access policy that must be granted to a Resource Access Management (RAM) user or RAM role to invoke this OpenAPI operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- If you do not specify a version number or version status, Key Management Service (KMS) returns the credential value of the version marked as ACSCurrent by default.'."\n"
."\n"
.'- If a customer-managed key is used to protect the credential value, the caller must also have the `kms:Decrypt` permission on the corresponding master key.'."\n"
."\n"
.'This topic provides a sample request to retrieve the credential value of a credential named `secret001`. The returned result shows that the credential value `SecretData` is `testdata1`.',
'requestParamsDescription' => 'For more information about common request parameters, see [Common Parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecretDataType\\": \\"binary\\",\\n \\"CreateTime\\": \\"2024-02-21T15:39:26Z\\",\\n \\"VersionId\\": \\"v1\\",\\n \\"NextRotationDate\\": \\"2024-07-06T18:22:03Z\\",\\n \\"SecretData\\": \\"testdata1\\",\\n \\"RotationInterval\\": \\"604800s\\",\\n \\"ExtendedConfig\\": \\"{\\\\\\\\\\\\\\"SecretSubType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SingleUser\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"DBInstanceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rm-uf667446pc955****\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"CustomData\\\\\\\\\\\\\\":{} }\\",\\n \\"LastRotationDate\\": \\"2023-07-05T08:22:03Z\\",\\n \\"RequestId\\": \\"6a3e9c36-1150-4881-84d3-eb8672fcafad\\",\\n \\"SecretName\\": \\"secret001\\",\\n \\"AutomaticRotation\\": \\"Enabled\\",\\n \\"SecretType\\": \\"Generic\\",\\n \\"VersionStages\\": {\\n \\"VersionStage\\": [\\n \\"{ \\\\\\"VersionStage\\\\\\": [ \\\\t\\\\\\"ACSCurrent\\\\\\" \\\\t] }\\"\\n ]\\n }\\n}","type":"json"}]',
'translator' => 'machine',
],
'ImportKeyMaterial' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK to be imported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
[
'name' => 'EncryptedKeyMaterial',
'in' => 'query',
'schema' => ['description' => 'The key material encrypted with the public key returned by **GetParametersForImport**, and then Base64-encoded.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'bCPZx7I6v6KXsqEpr2OXKxuj2CCRtKdwp75Bw+BGncYqBdfjFBYRtOE6HRlT0oeiRDWzwnw9OA54OL36smDJrq4Lo9x0CyYDiuKnRkcKtMtlzW0din7Pd7IlZWWRdVueiw2qpzl7PkUWQGTdsdbzpfJJQ+qj/cRIrk/E83UGyeyytSpgnb+lu0xEYcPajRyWNsbi98N3pqqQzHXNNHO2NJqHlnQgglqTiBEjkGeKFhfKmTc3vjulIdVa3EaVIN6lwWfgx+UUYSrvbA77WDYKlDsZ4SbK2/T7za9Tp1qU7Ynqba7OKGVVj7PMbiaO80AxWZnjUMYCgEp5w7V+seOXqw==', 'title' => ''],
],
[
'name' => 'ImportToken',
'in' => 'query',
'schema' => ['description' => 'The import token obtained by calling **GetParametersForImport**.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Base64String', 'title' => ''],
],
[
'name' => 'KeyMaterialExpireUnix',
'in' => 'query',
'schema' => ['description' => 'The time when the key material expires.'."\n"
."\n"
.'If this parameter is not specified or set this parameter to 0, the key material does not expire.'."\n"
."\n"
.'> The value cannot be earlier than the time when the operation is called (based on the server time).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ec1017cf-ead4-f3ca-babc-c3b34f3dbecb', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidKeyMaterial', 'errorMessage' => 'key material is invalid', 'description' => ''],
['errorCode' => 'InvalidImportToken', 'errorMessage' => 'import token is invalid', 'description' => ''],
['errorCode' => 'ExpiredImportToken', 'errorMessage' => 'import token is expired', 'description' => ''],
['errorCode' => 'Unsupported.Origin', 'errorMessage' => 'This key origin is not valid for this api', 'description' => 'The key origin is not supported for this API operation.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ec1017cf-ead4-f3ca-babc-c3b34f3dbecb\\"\\n}","type":"json"}]',
'title' => 'ImportKeyMaterial',
'summary' => 'Imports externally generated key material into a CMK whose origin is EXTERNAL.',
'description' => 'When you call [CreateKey](~~28947~~) to create a CMK, you can set **Origin** to **EXTERNAL** to specify that the key material comes from an external source. Use this operation to import the key material into such a CMK.'."\n"
."\n"
.'- To view the CMK **Origin**, see [DescribeKey](~~28952~~).'."\n"
."\n"
.'- Before importing key material, call [GetParametersForImport](~~68621~~) to obtain the parameters required for the import, including the public key and import token.'."\n"
."\n"
.'> * For a CMK of type **Aliyun\\_AES\\_256**, the key material must be 256 bits. For a CMK of type **Aliyun\\_SM4**, the key material must be 128 bits.'."\n"
.'>'."\n"
.'> * You can set the expiration time for the key material, or you can set it to never expire.'."\n"
.'>'."\n"
.'> * You can reimport the key material and reset the expiration time for the specified CMK at any time, but the same key material must be imported.'."\n"
.'>'."\n"
.'> * After the imported key material expires or is deleted, the specified CMK becomes unavailable until the same key material is imported again.'."\n"
.'>'."\n"
.'> * The same key material can be imported into multiple CMKs, but data or data keys encrypted by one CMK cannot be decrypted by another CMK.'."\n"
."\n"
.'For more information about the access policy required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ListAliases' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54587',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return.'."\n"
."\n"
.'Pages start from page 1.'."\n"
."\n"
.'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
."\n"
.'Valid values: 0 to 100.'."\n"
."\n"
.'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1b57992c-834b-4811-a889-f8bac1ba0353', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of returned aliases.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Aliases' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Alias' => [
'description' => 'The alias of the user.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The CMK to which the alias belongs.', 'type' => 'string', 'example' => 'key-hzz6****', 'title' => ''],
'AliasArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the alias.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:123456:alias/ExampleAlias1', 'title' => ''],
'AliasName' => ['description' => 'The ID of the alias.', 'type' => 'string', 'example' => 'alias/ExampleAlias1', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'ListAliases',
'summary' => 'Queries all aliases in the current region for the current account.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1b57992c-834b-4811-a889-f8bac1ba0353\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Aliases\\": {\\n \\"Alias\\": [\\n {\\n \\"KeyId\\": \\"key-hzz6****\\",\\n \\"AliasArn\\": \\"acs:kms:cn-hangzhou:123456:alias/ExampleAlias1\\",\\n \\"AliasName\\": \\"alias/ExampleAlias1\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListAliasesByKeyId' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return.'."\n"
."\n"
.'Valid values: an integer that is greater than 0.'."\n"
."\n"
.'Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
."\n"
.'Valid values: 0 to 101.'."\n"
."\n"
.'Default value: 10'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1b57992c-834b-4811-a889-f8bac1ba0353', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of returned CMKs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Aliases' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Alias' => [
'description' => 'An array that consists of aliases.'."\n",
'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The CMK to which an alias is bound.'."\n", 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''],
'AliasArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the alias.'."\n", 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:123456:alias/ExampleAlias1', 'title' => ''],
'AliasName' => ['description' => 'The ID of the alias.'."\n", 'type' => 'string', 'example' => 'alias/ExampleAlias1', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1b57992c-834b-4811-a889-f8bac1ba0353\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Aliases\\": {\\n \\"Alias\\": [\\n {\\n \\"KeyId\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"AliasArn\\": \\"acs:kms:cn-hangzhou:123456:alias/ExampleAlias1\\",\\n \\"AliasName\\": \\"alias/ExampleAlias1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListAliasesByKeyIdResponse>\\n <RequestId>1b57992c-834b-4811-a889-f8bac1ba0353</RequestId>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>1</TotalCount>\\n <Aliases>\\n <KeyId>08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****</KeyId>\\n <AliasArn>acs:kms:cn-hangzhou:123456:alias/ExampleAlias1</AliasArn>\\n <AliasName>alias/ExampleAlias1</AliasName>\\n </Aliases>\\n</ListAliasesByKeyIdResponse>","errorExample":""}]',
'title' => 'ListAliasesByKeyId',
'summary' => 'Queries all aliases that are bound to a key.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-09-22T11:56:41.000Z', 'description' => 'Error codes changed'],
],
],
'ListApplicationAccessPoints' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '54646',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'bcfefe15-46f0-44a3-bd96-3d422474b71a', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'ApplicationAccessPoints' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'ApplicationAccessPoint' => [
'description' => 'A list of AAPs.',
'type' => 'array',
'items' => [
'description' => 'A list of AAPs.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the AAP.', 'type' => 'string', 'example' => 'aap_test', 'title' => ''],
'AuthenticationMethod' => ['description' => 'The authentication method.', 'type' => 'string', 'example' => 'ClientKey', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'ListApplicationAccessPoints',
'summary' => 'Queries all application access points (AAPs) in the current region.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'changeSet' => [
['createdAt' => '2025-10-16T05:41:36.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"bcfefe15-46f0-44a3-bd96-3d422474b71a\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"ApplicationAccessPoints\\": {\\n \\"ApplicationAccessPoint\\": [\\n {\\n \\"Name\\": \\"aap_test\\",\\n \\"AuthenticationMethod\\": \\"ClientKey\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListClientKeys' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '54637',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AapName',
'in' => 'query',
'schema' => ['description' => 'The name of the application access point (AAP).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aap_test', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2312e45f-b2fa-4c34-ad94-3eca50932916', 'title' => ''],
'ClientKeys' => [
'description' => 'A list of client keys.',
'type' => 'array',
'items' => [
'description' => 'A list of client keys.',
'type' => 'object',
'properties' => [
'ClientKeyId' => ['description' => 'The ID of the client key.', 'type' => 'string', 'example' => 'KAAP.66abf237-63f6-4625-b8cf-47e1086e****', 'title' => ''],
'CreateTime' => ['description' => 'The time when the client key was created.', 'type' => 'string', 'example' => '2023-08-31T09:14:38Z', 'title' => ''],
'PublicKeyData' => ['description' => 'The public key of the client key.', 'type' => 'string', 'example' => '-----BEGIN CERTIFICATE-----\\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----', 'title' => ''],
'KeyAlgorithm' => ['description' => 'The private key algorithm of the client key.', 'type' => 'string', 'example' => 'RSA_2048', 'title' => ''],
'NotBefore' => ['description' => 'The beginning of the validity period of the client key.', 'type' => 'string', 'example' => '2023-08-31T17:14:33Z', 'title' => ''],
'NotAfter' => ['description' => 'The end of the validity period of the client key.', 'type' => 'string', 'example' => '2028-08-31T17:14:33Z', 'title' => ''],
'KeyOrigin' => ['description' => 'The provider of the client key.'."\n"
."\n"
.'Currently, only KMS is supported. The value is fixed as KMS\\_PROVIDED.', 'type' => 'string', 'example' => 'KMS_PROVIDED', 'title' => ''],
'AapName' => ['description' => 'The name of the AAP.', 'type' => 'string', 'example' => 'aap_test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListClientKeys',
'summary' => 'Queries all client keys within an AAP.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'changeSet' => [
['createdAt' => '2025-10-16T05:41:35.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2312e45f-b2fa-4c34-ad94-3eca50932916\\",\\n \\"ClientKeys\\": [\\n {\\n \\"ClientKeyId\\": \\"KAAP.66abf237-63f6-4625-b8cf-47e1086e****\\",\\n \\"CreateTime\\": \\"2023-08-31T09:14:38Z\\",\\n \\"PublicKeyData\\": \\"-----BEGIN CERTIFICATE-----\\\\\\\\nMIIDcjCCAlqgAwIBAgIQT/sAVRxwYp54mrw****-----END CERTIFICATE-----\\",\\n \\"KeyAlgorithm\\": \\"RSA_2048\\",\\n \\"NotBefore\\": \\"2023-08-31T17:14:33Z\\",\\n \\"NotAfter\\": \\"2028-08-31T17:14:33Z\\",\\n \\"KeyOrigin\\": \\"KMS_PROVIDED\\",\\n \\"AapName\\": \\"aap_test\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ListKeyVersions' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK. You can also set this parameter to an alias that is bound to the CMK. For more information, see [Use aliases](~~68522~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return.'."\n"
."\n"
.'Pages start from page 1.'."\n"
."\n"
.'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.'."\n"
."\n"
.'Valid values: 0 to 101.'."\n"
."\n"
.'Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'f71204c4-53cd-4eea-b405-653ba2db7e86', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of returned key versions.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'KeyVersions' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KeyVersion' => [
'description' => 'An array that consists of key versions.',
'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The globally unique ID of the CMK.'."\n"
."\n"
.'> If you set the KeyId parameter to the alias of the CMK, the ID of the CMK to which the alias is bound is returned.', 'type' => 'string', 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
'KeyVersionId' => ['description' => 'The globally unique ID of the CMK version.', 'type' => 'string', 'example' => '1e3304fd-68ac-4d5b-8886-ae5f01a1****', 'title' => ''],
'CreationDate' => ['description' => 'The date and time when the CMK version was created. The time is displayed in UTC.', 'type' => 'string', 'example' => '2024-03-25T10:42:40Z', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"f71204c4-53cd-4eea-b405-653ba2db7e86\\",\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 3,\\n \\"KeyVersions\\": {\\n \\"KeyVersion\\": [\\n {\\n \\"KeyId\\": \\"key-hzz630494463ejqjx****\\",\\n \\"KeyVersionId\\": \\"1e3304fd-68ac-4d5b-8886-ae5f01a1****\\",\\n \\"CreationDate\\": \\"2024-03-25T10:42:40Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'ListKeyVersions',
'summary' => 'Queries all versions of a specified CMK.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ListKeys' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54591',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.<br> Valid values: greater than 0.<br> Default value: 1.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page.<br> Valid values: 1 to 100.<br> Default value: 10.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'Filters',
'in' => 'query',
'schema' => ['description' => 'A filter for master keys. The filter consists of 0 to 10 key-value pairs.'."\n"
."\n"
.'- Key'."\n"
."\n"
.' - Description: The property to filter.'."\n"
."\n"
.' - Type: String.'."\n"
."\n"
.'- Values'."\n"
."\n"
.' - Description: The value to be included after filtering.'."\n"
."\n"
.' - Type: String array.'."\n"
."\n"
.' - Length: 0 to 10.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- If \\`Key\\` is set to \\`KeyState\\`, it specifies the key status. Valid values for \\`Value\\` are \\`Enabled\\`, \\`Disabled\\`, \\`PendingDeletion\\`, and \\`PendingImport\\`.'."\n"
."\n"
.'- If \\`Key\\` is set to \\`KeySpec\\`, it specifies the key type. Valid values for \\`Value\\` are \\`Aliyun\\_AES\\_256\\`, \\`Aliyun\\_SM4\\`, \\`RSA\\_2048\\`, \\`EC\\_P256\\`, \\`EC\\_P256K\\`, \\`EC\\_SM2\\`, and \\`Aliyun\\_SM4\\`.<br> Note: You can create keys of the \\`EC\\_SM2\\` and \\`Aliyun\\_SM4\\` types only in regions that support managed HSMs and have passed the compliance assessment of the Office of State Commercial Cryptography Administration (OSCCA). For more information about the supported regions, see [Supported regions](~~125803~~). If you specify \\`EC\\_SM2\\` or \\`Aliyun\\_SM4\\` in a region that does not support these key types, the parameters are ignored.<br>'."\n"
."\n"
.'- If \\`Key\\` is set to \\`KeyUsage\\`, it specifies the key usage. Valid values for \\`Value\\` are \\`ENCRYPT/DECRYPT\\` (for data encryption and decryption) and \\`SIGN/VERIFY\\` (for generating and verifying digital signatures).'."\n"
."\n"
.'- If \\`Key\\` is set to \\`ProtectionLevel\\`, it specifies the protection level of the key. Valid values for \\`Value\\` are \\`SOFTWARE\\` and \\`HSM\\`.<br> Note: The HSM protection level is supported only in specific regions. For more information about the supported regions, see [Supported regions](~~125803~~). If you specify \\`HSM\\` in a region that does not support it, the parameter is ignored.<br>'."\n"
."\n"
.'- If \\`Key\\` is set to \\`CreatorType\\`, it specifies the creator type. Valid values for \\`Value\\` are \\`User\\` (returns master keys created by users) and \\`Service\\` (returns master keys that are automatically created by other Alibaba Cloud services based on your authorization).'."\n"
."\n"
.'- If \\`Key\\` is set to \\`DKMSInstanceId\\`, it specifies the ID of the KMS instance. Set \\`Value\\` as needed.'."\n"
."\n"
.'- If \\`Key\\` is set to \\`keyId\\`, it specifies the key ID. Set \\`Value\\` as needed.'."\n"
."\n"
.'- If \\`Key\\` is set to \\`AliasName\\`, it specifies the key alias. Set \\`Value\\` as needed.'."\n"
."\n"
.'- If \\`Key\\` is set to \\`Creator\\`, it specifies the key creator. Set \\`Value\\` as needed.'."\n"
."\n"
.'- If \\`Key\\` is set to \\`TagKey\\`, it specifies the key of a key tag. Set \\`Value\\` as needed.'."\n"
."\n"
.'- If \\`Key\\` is set to \\`TagValue\\`, it specifies the value of a key tag. Set \\`Value\\` as needed.'."\n"
."\n"
.'The logical relationship between different keys in \\`Filters\\` is \\`AND\\`. The logical relationship between multiple values for the same key is \\`OR\\`. For example, if you enter `[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]`, the semantics are: `(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256)`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. It is a globally unique identifier (GUID) generated by Alibaba Cloud. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => '8252db58-2036-408c-a3d5-56e656dc2551', 'title' => ''],
'TotalCount' => ['description' => 'The total number of master keys.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''],
'Keys' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Key' => [
'description' => 'The master keys.',
'type' => 'array',
'items' => [
'description' => 'The master key.',
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The globally unique identifier of the master key.', 'type' => 'string', 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****', 'title' => ''],
'KeyArn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the master key.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'title' => 'ListKeys',
'summary' => 'Queries the IDs and ARNs of all CMKs in the current region.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-21T07:38:13.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"RequestId\\": \\"8252db58-2036-408c-a3d5-56e656dc2551\\",\\n \\"TotalCount\\": 3,\\n \\"Keys\\": {\\n \\"Key\\": [\\n {\\n \\"KeyId\\": \\"08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****\\",\\n \\"KeyArn\\": \\"acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListKmsInstances' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '191383',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'd3eca5c8-a856-4347-8eb6-e1898c3fda2e'],
'KmsInstances' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'KmsInstance' => [
'itemNode' => true,
'description' => 'A list of KMS instances.',
'title' => '',
'type' => 'array',
'items' => [
'description' => 'A list of KMS instances.',
'type' => 'object',
'properties' => [
'KmsInstanceArn' => ['description' => 'The ARN of the KMS instance.', 'type' => 'string', 'example' => 'acs:kms:pre-hangzhou:120708975881****:keystore/kst-phzz64c9f84eo32dbs****', 'title' => ''],
'KmsInstanceId' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'example' => 'kst-phzz64c9f84eo32dbs****', 'title' => ''],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'TotalCount' => ['description' => 'The total number of KMS instances.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of KMS instances returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalTimestamp', 'errorMessage' => 'The input parameter Timestamp that is mandatory for processing this request is not supplied.', 'description' => 'The input parameter timestamp indicates that the request is outside the processing time range.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListKmsInstances',
'summary' => 'Queries all KMS instances in the current region.',
'description' => 'For more information about the access policy required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"d3eca5c8-a856-4347-8eb6-e1898c3fda2e\\",\\n \\"KmsInstances\\": {\\n \\"KmsInstance\\": [\\n {\\n \\"KmsInstanceArn\\": \\"acs:kms:pre-hangzhou:120708975881****:keystore/kst-phzz64c9f84eo32dbs****\\",\\n \\"KmsInstanceId\\": \\"kst-phzz64c9f84eo32dbs****\\"\\n }\\n ]\\n },\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
],
'ListNetworkRules' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '54654',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3bf02f7a-015b-4f34-be0f-cc043fda2d33', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'NetworkRules' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'NetworkRule' => [
'description' => 'A list of access control rules.',
'type' => 'array',
'items' => [
'description' => 'A list of access control rules.',
'type' => 'object',
'properties' => [
'Type' => ['description' => 'The network type. The value is fixed as Private. Self-managed applications can access KMS instances only over a private virtual private cloud (VPC).', 'type' => 'string', 'example' => 'Private', 'title' => ''],
'Name' => ['description' => 'The name of the access control rule.', 'type' => 'string', 'example' => 'networkrule_test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'ListNetworkRules',
'summary' => 'Queries all network access rules in the current region.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3bf02f7a-015b-4f34-be0f-cc043fda2d33\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"NetworkRules\\": {\\n \\"NetworkRule\\": [\\n {\\n \\"Type\\": \\"Private\\",\\n \\"Name\\": \\"networkrule_test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListPolicies' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '54648',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'b66ad557-9c00-4064-9c8d-b621c3263308', 'title' => ''],
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Policies' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Policy' => [
'description' => 'A list of permission policies.',
'type' => 'array',
'items' => [
'description' => 'A list of permission policies.',
'type' => 'object',
'properties' => [
'Name' => ['description' => 'The name of the permission policy.', 'type' => 'string', 'example' => 'policy_test', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'ListPolicies',
'summary' => 'Queries all permission policies in the current region.',
'description' => 'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"b66ad557-9c00-4064-9c8d-b621c3263308\\",\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"Policies\\": {\\n \\"Policy\\": [\\n {\\n \\"Name\\": \\"policy_test\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'ListResourceTags' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The globally unique ID of the CMK.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4162a6af-bc99-40b3-a552-89dcc8aaf7c8', 'title' => ''],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'The tags of the CMK.'."\n",
'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The globally unique ID of the CMK.'."\n", 'type' => 'string', 'example' => '33caea95-c3e5-4b3e-a9c6-cec76e4e****', 'title' => ''],
'TagValue' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'Test', 'title' => ''],
'TagKey' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'Project', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4162a6af-bc99-40b3-a552-89dcc8aaf7c8\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"KeyId\\": \\"33caea95-c3e5-4b3e-a9c6-cec76e4e****\\",\\n \\"TagValue\\": \\"Test\\",\\n \\"TagKey\\": \\"Project\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListResourceTagsResponse>\\n <RequestId>4162a6af-bc99-40b3-a552-89dcc8aaf7c8</RequestId>\\n <Tags>\\n <KeyId>33caea95-c3e5-4b3e-a9c6-cec76e4e****</KeyId>\\n <TagValue>Test</TagValue>\\n <TagKey>Project</TagKey>\\n </Tags>\\n</ListResourceTagsResponse>","errorExample":""}]',
'title' => 'ListResourceTags',
'summary' => 'Queries the tags of a customer master key (CMK).',
'description' => 'Request format: KeyId="string"'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2022-09-22T11:56:41.000Z', 'description' => 'Error codes changed'],
],
],
'ListSecretVersionIds' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name or Alibaba Cloud Resource Name (ARN) of the credential.'."\n"
."\n"
.'> When you access a credential that belongs to another Alibaba Cloud account, you must specify the ARN of the credential. The ARN of a credential is in the format of `acs:kms:${region}:${account}:secret/${secret-name}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'IncludeDeprecated',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to include credential versions that have no version stages in the response.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- false (default): No'."\n"
."\n"
.'- true: Yes', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The number of the page to return for a paged query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page for a paged query. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the credential.', 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47', 'title' => ''],
'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'VersionIds' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VersionId' => [
'itemNode' => true,
'description' => 'A list of version information of the credential.',
'title' => '',
'type' => 'array',
'items' => [
'description' => 'A list of version information of the credential.',
'type' => 'object',
'properties' => [
'VersionId' => ['description' => 'The version number.', 'type' => 'string', 'example' => 'v1', 'title' => ''],
'CreateTime' => ['description' => 'The time when the version was created.', 'type' => 'string', 'example' => '2024-02-21T15:39:26Z', 'title' => ''],
'VersionStages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VersionStage' => [
'description' => 'The stage labels of the version.',
'title' => '',
'type' => 'array',
'items' => ['description' => 'The stage labels of the version.', 'type' => 'string', 'example' => '{"VersionStage": ["ACSCurrent","uStage1"]}', 'title' => ''],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system', 'description' => ''],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecretName\\": \\"secret001\\",\\n \\"RequestId\\": \\"5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47\\",\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"VersionIds\\": {\\n \\"VersionId\\": [\\n {\\n \\"VersionId\\": \\"v1\\",\\n \\"CreateTime\\": \\"2024-02-21T15:39:26Z\\",\\n \\"VersionStages\\": {\\n \\"VersionStage\\": [\\n \\"{\\\\\\"VersionStage\\\\\\": [\\\\\\"ACSCurrent\\\\\\",\\\\\\"uStage1\\\\\\"]}\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'ListSecretVersionIds',
'summary' => 'Queries all version IDs and stage labels of a specified secret.',
'description' => '- For more information about the access policy required for a RAM user or RAM role to call this OpenAPI, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- The version information does not include the secret value. By default, this operation returns only the secret versions that are marked with a version stage.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ListSecrets' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54594',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'FetchTags',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return resource tags for each secret. Valid values:'."\n"
."\n"
.'- `true`: Resource tags are returned.'."\n"
."\n"
.'- `false` (default): Resource tags are not returned.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => 'The page number.<br>'."\n"
.'The value must be greater than 0.<br>'."\n"
.'Default: 1.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'default' => '1', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page size.<br>'."\n"
.'The value must be between 1 and 100.<br>'."\n"
.'Default: 10.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '2', 'title' => ''],
],
[
'name' => 'Filters',
'in' => 'query',
'schema' => ['description' => 'Filters secrets based on specified conditions. The value is a list of up to 10 key-value pairs. When you filter by tag, the query returns a maximum of 4,000 resources. If more than 4,000 resources match the filter, call the [ListResourceTags](~~120090~~) operation.'."\n"
."\n"
.'- Key'."\n"
."\n"
.' - Description: The filter property.'."\n"
."\n"
.' - Type: String.'."\n"
."\n"
.'- Values'."\n"
."\n"
.' - Description: The filter value.'."\n"
."\n"
.' - Type: String.'."\n"
."\n"
.' - You can specify up to 10 items.'."\n"
."\n"
.'Valid values for Key:'."\n"
."\n"
.'- Set `Key` to **SecretName** to filter by secret name.'."\n"
."\n"
.'- Set `Key` to **Description** to filter by secret description.'."\n"
."\n"
.'- Set `Key` to **TagKey** to filter by tag key.'."\n"
."\n"
.'- Set `Key` to **TagValue** to filter by tag value.'."\n"
."\n"
.'- Set `Key` to **DKMSInstanceId** to filter by KMS instance ID.'."\n"
."\n"
.'- Set Key to **SecretType** to filter by secret type. `Values` can be `Generic`, `RDS`, `Redis`, `RAMCredentials`, `ECS`, or `PolarDB`.'."\n"
."\n"
.'- Set `Key` to **Creator** to filter by the creator of the secret.'."\n"
."\n"
.'If you specify multiple values for a key, the filter applies a logical OR. For example, if you enter `[ {"Key":"SecretName", "Values":["sec1","sec2"]} ]`, this means: `(SecretName=sec1 OR SecretName=sec2)`.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Key":"SecretName", "Values":["Val1","Val2"]}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'RequestId' => ['description' => 'The unique identifier generated by Alibaba Cloud for the request. Use it to locate and troubleshoot issues.', 'type' => 'string', 'example' => '6a6287a0-ff34-4780-a790-fdfca900557f', 'title' => ''],
'TotalCount' => ['description' => 'The number of secrets.', 'type' => 'integer', 'format' => 'int32', 'example' => '55', 'title' => ''],
'SecretList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Secret' => [
'description' => 'The list of secrets.',
'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.', 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'UpdateTime' => ['description' => 'The time when the secret was last updated.', 'type' => 'string', 'example' => '2024-07-17T07:59:05Z', 'title' => ''],
'SecretType' => ['description' => 'The type of the secret. Valid values:'."\n"
."\n"
.'- `Generic`: a generic secret.'."\n"
."\n"
.'- `Rds`: an RDS secret.'."\n"
."\n"
.'- `Redis`: a Redis or Tair secret.'."\n"
."\n"
.'- `RAMCredentials`: a RAM secret.'."\n"
."\n"
.'- `ECS`: an ECS secret.'."\n"
."\n"
.'- `PolarDB`: a PolarDB secret.', 'type' => 'string', 'example' => 'Generic', 'title' => ''],
'PlannedDeleteTime' => ['description' => 'The scheduled deletion time.', 'type' => 'string', 'example' => '2024-08-17T07:59:05Z', 'title' => ''],
'CreateTime' => ['description' => 'The time when the secret was created.', 'type' => 'string', 'example' => '2024-07-17T07:59:05Z', 'title' => ''],
'Tags' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Tag' => [
'description' => 'The resource tags for the secret.'."\n"
.'This parameter is not returned if the `FetchTags` parameter is set to `false` or is not specified.',
'title' => '',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'val1', 'title' => ''],
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''],
],
'description' => 'A resource tag.',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'OwingService' => ['description' => 'The owner service.', 'type' => 'string', 'example' => 'alb', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system', 'description' => ''],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"RequestId\\": \\"6a6287a0-ff34-4780-a790-fdfca900557f\\",\\n \\"TotalCount\\": 55,\\n \\"SecretList\\": {\\n \\"Secret\\": [\\n {\\n \\"SecretName\\": \\"secret001\\",\\n \\"UpdateTime\\": \\"2024-07-17T07:59:05Z\\",\\n \\"SecretType\\": \\"Generic\\",\\n \\"PlannedDeleteTime\\": \\"2024-08-17T07:59:05Z\\",\\n \\"CreateTime\\": \\"2024-07-17T07:59:05Z\\",\\n \\"Tags\\": {\\n \\"Tag\\": [\\n {\\n \\"TagValue\\": \\"val1\\",\\n \\"TagKey\\": \\"key1\\"\\n }\\n ]\\n },\\n \\"OwingService\\": \\"alb\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'ListSecrets',
'summary' => 'Queries all secrets in the current region.',
'description' => '- To call this operation, the RAM user or RAM role must be granted the required policy. For more information, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation returns only secret metadata, not the secret values.'."\n"
."\n"
.'This example shows how to query secrets created by the current user in the current region. `PageNumber` is set to `1` and `PageSize` is set to `2`, returning metadata for two secrets.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ListTagResources' => [
'summary' => 'Lists the tags that are bound to a key or a secret.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '177230',
'abilityTreeNodes' => ['FEATUREkms5QHERY'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the resource.'."\n"
."\n"
.'> Call [DescribeRegions](~~601478~~) to query the most recent region list.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n"
."\n"
.'> If not all results are returned, the NextToken value is included in the response. By default, 200 rows are returned per page. To retrieve the next page, set this parameter to the NextToken value from the previous response.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'caeba0bbb2be03f84eb48b699f0a4883'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The type of resource whose tags you want to query. Valid value:'."\n"
."\n"
.'- key'."\n"
."\n"
.'- secret', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'key'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'A list of resource IDs for which you want to query tags. You can enter a maximum of 50 resource IDs.'."\n"
."\n"
.'Enter multiple resource IDs in the `["ResourceId. 1","ResourceId. 2",...]` format.',
'type' => 'array',
'items' => ['description' => 'The resource IDs for which you want to query tags. You can enter a maximum of 50 resource IDs.'."\n"
."\n"
.'Enter multiple resource IDs in the `["ResourceId. 1","ResourceId. 2",...]` format.', 'type' => 'string', 'required' => false, 'example' => 'key-hzz62f1cb66fa42qo****', 'title' => ''],
'required' => false,
'maxItems' => 51,
'example' => '',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'A list of tags that you want to query. Valid values of N: 1 to 20.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag. A tag consists of a key-value pair.'."\n"
."\n"
.'You can enter up to 20 tags. Enter multiple tags in the `[{"Key":"key1","Value":"value1"},{"Key":"key2","Value":"value2"},..]` format.'."\n"
."\n"
.'> The key cannot start with aliyun or acs:.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'disk-encryption'],
'Value' => ['description' => 'The value of the tag. A tag consists of a key-value pair.'."\n"
."\n"
.'You can enter up to 20 tags. Enter multiple tags in the `[{"Key":"key1","Value":"value1"},{"Key":"key2","Value":"value2"},..]` format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'true'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n"
."\n"
.'- If NextToken is empty ("NextToken": ""), no next page exists.'."\n"
."\n"
.'- If NextToken is not empty, the next query is required, and the value is the token used to start the next query.', 'type' => 'string', 'title' => '', 'example' => 'e71d8a535bd9cc11'],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '00827261-20B7-4562-83F2-4DF39876A45A', 'title' => ''],
'TagResources' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'TagResource' => [
'title' => '',
'description' => 'A list of tags.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'ResourceType' => ['description' => 'The type of the resource.', 'type' => 'string', 'title' => '', 'example' => 'key'],
'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'title' => '', 'example' => 'true'],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'key-hzz62f1cb66fa42qo****'],
'TagKey' => ['description' => 'The key of the tag.', 'type' => 'string', 'title' => '', 'example' => 'disk-encryption'],
],
'title' => '',
'example' => '',
],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified tagKey is duplicate.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceId is not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListTagResources',
'description' => 'For more information about the access policy required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NextToken\\": \\"e71d8a535bd9cc11\\",\\n \\"RequestId\\": \\"00827261-20B7-4562-83F2-4DF39876A45A\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"key\\",\\n \\"TagValue\\": \\"true\\",\\n \\"ResourceId\\": \\"key-hzz62f1cb66fa42qo****\\",\\n \\"TagKey\\": \\"disk-encryption\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'OpenKmsService' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '54596',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3455b9b4-95c1-419d-b310-db6a53b09a39', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'CreateLXOrderFailed', 'errorMessage' => 'Create order failed.', 'description' => ''],
['errorCode' => 'Forbidden.NoRealNameAuthentication', 'errorMessage' => 'Real name authentication is needed.', 'description' => 'You have not passed real name authentication.'],
['errorCode' => 'Forbidden.Opened', 'errorMessage' => 'Your kms service has been opened.', 'description' => 'You have activated Key Management Service.'],
],
],
'title' => 'OpenKmsService',
'summary' => 'Activates Key Management Service (KMS) for your Alibaba Cloud account.',
'description' => '- For more information about the access policies that a RAM user or RAM role needs to call this OpenAPI, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- KMS is a paid service. For more information about billing, see [Billing](~~52608~~).'."\n"
."\n"
.'- You can activate the service for an Alibaba Cloud account only once.'."\n"
."\n"
.'- Make sure that your Alibaba Cloud account has completed real-name verification.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [
['createdAt' => '2025-08-21T07:47:03.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3455b9b4-95c1-419d-b310-db6a53b09a39\\"\\n}","type":"json"}]',
],
'PutSecretValue' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '54597',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'VersionId',
'in' => 'query',
'schema' => ['description' => 'The version number of the secret. The value must be unique in the secret.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'v3', 'title' => ''],
],
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name or Alibaba Cloud Resource Name (ARN) of the secret.'."\n"
."\n"
.'> When you access a secret in another Alibaba Cloud account, you must specify the ARN of the secret. The ARN of a secret is in the format of `acs:kms:${region}:${account}:secret/${secret-name}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'SecretData',
'in' => 'query',
'schema' => ['description' => 'The secret value. The value is encrypted and stored in the specified new version.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'importantdata', 'title' => ''],
],
[
'name' => 'SecretDataType',
'in' => 'query',
'schema' => [
'description' => 'The type of the secret value. Valid values:'."\n"
."\n"
.'- text (default)'."\n"
."\n"
.'- binary',
'type' => 'string',
'required' => false,
'docRequired' => false,
'default' => 'text',
'enum' => ['text', 'binary'],
'example' => 'text',
'title' => '',
],
],
[
'name' => 'VersionStages',
'in' => 'query',
'schema' => ['description' => 'The stage labels that are used to mark the new version. If you do not specify this parameter, KMS marks the new version with ACSCurrent.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '["ACSCurrent","ACSNext"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.', 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'VersionId' => ['description' => 'The version number of the secret.', 'type' => 'string', 'example' => 'v3', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8', 'title' => ''],
'VersionStages' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'VersionStage' => [
'itemNode' => true,
'description' => 'The stage labels of the secret version.',
'title' => '',
'type' => 'array',
'items' => ['description' => 'The stage label of the secret version.', 'type' => 'string', 'example' => '{ "VersionStage": [ "ACSCurrent", "ACSNext" ] }', 'title' => ''],
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
['errorCode' => 'Rejected.LimitExceeded', 'errorMessage' => 'exceed secret limits error', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system', 'description' => ''],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
],
409 => [
['errorCode' => 'Rejected.ResourceExist', 'errorMessage' => 'The request was rejected becasue key already exsit', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'title' => 'PutSecretValue',
'summary' => 'Stores a new version of a secret value for a generic secret.',
'description' => '- For information about the access policy required for a RAM user or RAM role to call this OpenAPI operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation supports only generic secrets. Each generic secret can have a maximum of 10 versions. If the number of versions exceeds the limit, KMS deletes the earliest version.'."\n"
."\n"
.'- By default, the new secret value is marked with ACSCurrent, and the previous version that was marked with ACSCurrent is marked with ACSPrevious. You can specify the VersionStage parameter to overwrite this default behavior.'."\n"
."\n"
.'- This operation stores a new version of a secret value. You cannot use it to modify an existing version of a secret value. You must specify a version number when you store a new version. KMS processes requests based on the following rules:'."\n"
."\n"
.' - If the version number does not exist in the secret, KMS creates a new version and stores the secret value.'."\n"
."\n"
.' - If the version number already exists in the secret, KMS compares the secret value in the request with the stored value. If the values are the same, the request is ignored and a success message is returned. This makes the operation idempotent. If the values are different, the request is rejected.'."\n"
."\n"
.'This topic provides an example of how to store a new version of a secret value for the secret named `secret001`. The new version number (`VersionId`) is `v3` and the secret value (`SecretData`) is `importantdata`.',
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecretName\\": \\"secret001\\",\\n \\"VersionId\\": \\"v3\\",\\n \\"RequestId\\": \\"f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8\\",\\n \\"VersionStages\\": {\\n \\"VersionStage\\": [\\n \\"{ \\\\\\"VersionStage\\\\\\": [ \\\\\\"ACSCurrent\\\\\\", \\\\\\"ACSNext\\\\\\" ] }\\"\\n ]\\n }\\n}","type":"json"}]',
],
'ReEncrypt' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'abilityTreeCode' => '54598',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'CiphertextBlob',
'in' => 'query',
'schema' => ['description' => 'The ciphertext that you want to re-encrypt.<br> This parameter can be the ciphertext that is returned after symmetric or asymmetric key encryption.<br><br>'."\n"
."\n"
.'- Symmetric encryption: the ciphertext that is returned after you call the [Encrypt](~~28949~~), [GenerateDataKey](~~28948~~), [GenerateDataKeyWithoutPlaintext](~~134043~~), or [GenerateAndExportDataKey](~~176804~~) operation.'."\n"
."\n"
.'- Asymmetric key encryption: the data that is encrypted using a public key after you call the [GenerateAndExportDataKey](~~176804~~) operation, or the data that is encrypted using an asymmetric public key in an external system.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ODZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmS7FmDBBQ0BkKsQrtRnidtPwirmDcS0ZuJCU41xxAAWk4Z8qsADfbV0b+i6kQmlvj79dJdGOvtX69Uycs901q********', 'title' => ''],
],
[
'name' => 'SourceKeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the master key that is used to decrypt the ciphertext.<br> The globally unique identifier of the master key.<br><br>'."\n"
."\n"
.'> You must specify this parameter when CiphertextBlob is the data that is encrypted using a public key after asymmetric key encryption.', 'type' => 'string', 'required' => false, 'example' => '5c438b18-05be-40ad-b6c2-3be6752c****', 'title' => ''],
],
[
'name' => 'SourceKeyVersionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key version that is used to decrypt the ciphertext.'."\n"
."\n"
.'> You must specify this parameter when CiphertextBlob is the data that is encrypted using a public key after asymmetric key encryption.', 'type' => 'string', 'required' => false, 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
],
[
'name' => 'SourceEncryptionAlgorithm',
'in' => 'query',
'schema' => ['description' => 'If CiphertextBlob is the result of public key encryption, specify the public key encryption algorithm. For more information about the algorithms, see [AsymmetricDecrypt](~~148130~~).<br> Valid values:<br><br>'."\n"
."\n"
.'- RSAES\\_OAEP\\_SHA\\_256'."\n"
."\n"
.'- RSAES\\_OAEP\\_SHA\\_1'."\n"
."\n"
.'- SM2PKE'."\n"
."\n"
.'> You must specify this parameter when CiphertextBlob is the data that is encrypted using a public key after asymmetric key encryption.', 'type' => 'string', 'required' => false, 'example' => 'RSAES_OAEP_SHA_256', 'title' => ''],
],
[
'name' => 'SourceEncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs. If you specify this parameter when you call the [Encrypt](~~28949~~), [GenerateDataKey](~~28948~~), [GenerateDataKeyWithoutPlaintext](~~134043~~), or [GenerateAndExportDataKey](~~176804~~) operation, you must specify the same parameter to decrypt the data. For more information, see [EncryptionContext](~~42975~~).'."\n"
."\n"
.'> You must specify this parameter when CiphertextBlob is the ciphertext that is returned after symmetric encryption.', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'DestinationKeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the symmetric master key that is used to re-encrypt the data after the ciphertext is decrypted.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
[
'name' => 'DestinationEncryptionContext',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'A JSON string that consists of key-value pairs. This parameter specifies the encryption context for the destination master key.', 'type' => 'object', 'required' => false, 'example' => '{"Example":"Example"}', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the DryRun mode.'."\n"
."\n"
.'- true: enables the DryRun mode.'."\n"
."\n"
.'- false (default): disables the DryRun mode.'."\n"
."\n"
.'The DryRun mode is used to test API calls, verify whether you have the permissions to perform operations on the required resources, and check whether the request parameters are valid. If you enable the DryRun mode, KMS always returns a failure and a reason for the failure. The reasons for the failure include the following:'."\n"
."\n"
.'- DryRunOperationError: The request would have succeeded if the DryRun parameter was not configured.'."\n"
."\n"
.'- ValidationError: The parameters specified in the request are invalid.'."\n"
."\n"
.'- AccessDeniedError: You are not authorized to perform the operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'KeyId' => ['description' => 'The ID of the master key that is used to decrypt the ciphertext.<br> The globally unique identifier of the master key.<br><br>', 'type' => 'string', 'example' => '2ab1a983-7072-4bbc-a582-584b5bd8****', 'title' => ''],
'KeyVersionId' => ['description' => 'The ID of the key version that is used to decrypt the ciphertext of the master key.', 'type' => 'string', 'example' => '202b9877-5a25-46e3-a763-e20791b5****', 'title' => ''],
'CiphertextBlob' => ['description' => 'The ciphertext that is re-encrypted using the specified master key.', 'type' => 'string', 'example' => 'DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. This ID is a globally unique identifier that is generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '207596a2-36d3-4840-b1bd-f87044699bd7', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"KeyId\\": \\"2ab1a983-7072-4bbc-a582-584b5bd8****\\",\\n \\"KeyVersionId\\": \\"202b9877-5a25-46e3-a763-e20791b5****\\",\\n \\"CiphertextBlob\\": \\"DZhOWVmZDktM2QxNi00ODk0LWJkNGYtMWZjNDNmM2YyYWJmaaSl+TztSIMe43nbTH/Z1Wr4XfLftKhAciUmDQXuMRl4WTvKhxjMThjK****\\",\\n \\"RequestId\\": \\"207596a2-36d3-4840-b1bd-f87044699bd7\\"\\n}","type":"json"}]',
'title' => 'ReEncrypt',
'summary' => 'Re-encrypts ciphertext under a different CMK without exposing the plaintext.',
'description' => '### Notes'."\n"
."\n"
.'- For more information about the access policy required to grant a RAM user or RAM role the permission to use this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation is accessible only through a shared gateway, not a dedicated gateway. For more information, see [Alibaba Cloud SDK](~~601559~~).'."\n"
."\n"
.' When using a shared gateway, you access KMS through an Internet or a VPC domain name. This method requires Internet access to be enabled. For more information, see [Access keys in a KMS instance over the Internet](~~2856718~~).'."\n"
."\n"
.'### QPS limits'."\n"
."\n"
.'This operation is accessible only through a shared gateway. The single-user queries per second (QPS) limit is 750. If this limit is exceeded, requests are throttled, which may affect your business. We recommend that you stay within the specified limit.'."\n"
."\n"
.'### Details'."\n"
."\n"
.'You can use the ReEncrypt operation in the following scenarios:'."\n"
."\n"
.'- After a customer master key (CMK) is rotated, you can use the latest key version to re-encrypt data. For more information about automatic key rotation, see [Automatic key rotation](~~134270~~).'."\n"
."\n"
.'- You can re-encrypt data by changing the encryption context without changing the master key.'."\n"
."\n"
.'- You can re-encrypt data or a data key that is encrypted by one master key with another master key in KMS.'."\n"
."\n"
.'The ReEncrypt operation requires the following permissions:'."\n"
."\n"
.'- The kms:ReEncryptFrom permission for the source master key.'."\n"
."\n"
.'- The kms:ReEncryptTo permission for the destination master key.'."\n"
."\n"
.'- You can use kms:ReEncrypt\\* to grant both permissions.',
'requestParamsDescription' => ' '."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ReleaseKmsInstance' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'abilityTreeCode' => '222135',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
],
'parameters' => [
[
'name' => 'KmsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'required' => true, 'example' => 'kst-hzz6****', 'title' => ''],
],
[
'name' => 'ForceDeleteWithoutBackup',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to forcibly release the KMS instance if it has not been backed up.'."\n"
."\n"
.'- true: forcibly releases the instance.'."\n"
."\n"
.'- false (default): does not release the instance.', 'type' => 'string', 'example' => 'false', 'title' => '', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '475f1620-b9d3-4d35-b5c6-3fbdd941423d'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'Rejected.UnsupportedOperation', 'errorMessage' => 'Unsupported operation.', 'description' => 'The operation is not supported.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceNotFound', 'errorMessage' => 'The specified DKMS Instance is not found.', 'description' => 'Your dedicated KMS instance is not found.'],
['errorCode' => 'Forbidden.NoBackup', 'errorMessage' => 'this kms instance no backup, forbidden delete.', 'description' => 'This KMS instance has no backup and is not allowed to be deleted.'],
],
503 => [
['errorCode' => 'SerivceUnvailableTemporary', 'errorMessage' => 'Service Unvailable Temporary', 'description' => 'The service is temporarily unavailable.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ReleaseKmsInstance',
'summary' => 'Releases a pay-as-you-go KMS instance.',
'description' => '- For information about the access policy that is required to allow a RAM user or RAM role to call this OpenAPI operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- Subscription instances cannot be manually released. You can only unsubscribe from them under specific conditions. To unsubscribe, go to the Expenses and Costs page in the console and choose Unsubscribe. For more information, see [Unsubscription policy](~~600418~~).'."\n"
."\n"
.'- After you release an instance, all resources in the instance are also released. Resources that are encrypted using keys in the instance cannot be decrypted, and credentials cannot be retrieved. Before you release an instance, make sure that no data is encrypted by the keys in the instance and no services call the credentials. This prevents service interruptions.'."\n"
."\n"
.'- If your instance is a software key management instance, we recommend that you back up the resources of the instance before you release it. The backed-up resources can be recovered. For more information, see [Backup management](~~2357488~~).'."\n"
."\n"
.'- The billing epoch is daily. Therefore, after you release a pay-as-you-go instance, the bill for the previous day is pushed before 12:00 on the next day.'."\n"
."\n"
.'- Before you release a KMS instance, we recommend that you check whether deletion protection is enabled for the instance in the console. If deletion protection is enabled, disable it in the console before you release the instance. For more information, see [Manage a KMS instance](~~604735~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"475f1620-b9d3-4d35-b5c6-3fbdd941423d\\"\\n}","type":"json"}]',
],
'RestoreSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret you want to restore.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'e4885adf-548f-4ca5-8075-f540bbd3a55f', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system', 'description' => ''],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
],
409 => [
['errorCode' => 'Rejected.ResourceInUse', 'errorMessage' => 'restore normal secret', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecretName\\": \\"secret001\\",\\n \\"RequestId\\": \\"e4885adf-548f-4ca5-8075-f540bbd3a55f\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>e4885adf-548f-4ca5-8075-f540bbd3a55f</RequestId>\\n<SecretName>secret001</SecretName>","errorExample":""}]',
'title' => 'RestoreSecret',
'summary' => 'Restores a deleted secret.',
'description' => 'You can only use this operation to restore a deleted secret that is within its recovery period. If you set **ForceDeleteWithoutRecovery** to **true** when you delete the secret, you cannot restore it.'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'RotateSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RdsSecret/Mysql5.4/MyCred', 'title' => ''],
],
[
'name' => 'VersionId',
'in' => 'query',
'schema' => ['description' => 'The version number of the secret after the secret is rotated.'."\n"
."\n"
.'> The version number is used to ensure the idempotence of the request. Secrets Manager uses this version number to prevent your application from creating the same version of the secret when the application retries a request. If a version number already exists, Secrets Manager ignores the request for rotation and returns a success message.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '000000123', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'VersionId' => ['description' => 'The version number of the secret after the secret is rotated.', 'type' => 'string', 'example' => '000000123', 'title' => ''],
'SecretName' => ['description' => 'The name of the secret.', 'type' => 'string', 'example' => 'RdsSecret/Mysql5.4/MyCred', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '10257c86-269d-43aa-aaf3-90ed4144bb7c', 'title' => ''],
'Arn' => ['description' => 'The Alibaba Cloud Resource Name (ARN) of the secret.', 'type' => 'string', 'example' => 'acs:kms:cn-hangzhou:154035569884****:secret/RdsSecret/Mysql5.4/MyCred', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"VersionId\\": \\"000000123\\",\\n \\"SecretName\\": \\"RdsSecret/Mysql5.4/MyCred\\",\\n \\"RequestId\\": \\"10257c86-269d-43aa-aaf3-90ed4144bb7c\\",\\n \\"Arn\\": \\"acs:kms:cn-hangzhou:154035569884****:secret/RdsSecret/Mysql5.4/MyCred\\"\\n}","type":"json"}]',
'title' => 'RotateSecret',
'summary' => 'Immediately rotates a secret.',
'description' => 'Limits:'."\n"
."\n"
.'• A secret of each Alibaba Cloud account can be rotated for a maximum of 50 times per hour.'."\n"
."\n"
.'• The RotateSecret operation is unavailable for standard secrets.'."\n"
."\n"
.'In this example, the `RdsSecret/Mysql5.4/MyCred` secret is manually rotated, and the version number of the secret is set to `000000123` after the secret is rotated.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'ScheduleKeyDeletion' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the customer master key (CMK). The ID must be globally unique.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7906979c-8e06-46a2-be2d-68e3ccbc****', 'title' => ''],
],
[
'name' => 'PendingWindowInDays',
'in' => 'query',
'schema' => ['description' => 'The scheduled period after which the CMK is deleted. During this period, the CMK is in the PendingDeletion state. After this period ends, you cannot cancel the key deletion task.'."\n"
."\n"
.'Valid values: 7 to 366.'."\n"
."\n"
.'Unit: days.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '366', 'minimum' => '7', 'example' => '7', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3da5b8cc-8107-40ac-a170-793cd181d7b7', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"3da5b8cc-8107-40ac-a170-793cd181d7b7\\"\\n}","errorExample":""},{"type":"xml","example":"<ScheduleKeyDeletionResponse>\\n <RequestId>3da5b8cc-8107-40ac-a170-793cd181d7b7</RequestId>\\n</ScheduleKeyDeletionResponse>","errorExample":""}]',
'title' => 'ScheduleKeyDeletion',
'summary' => 'Deletes a specified customer master key (CMK).',
'description' => 'During the scheduled period, the CMK is in the PendingDeletion state and cannot be used to encrypt data, decrypt data, or generate data keys.'."\n"
."\n"
.'After a CMK is deleted, it cannot be recovered. Data that is encrypted and data keys that are generated by using the CMK cannot be decrypted. To prevent accidental deletion of CMKs, Key Management Service (KMS) allows you to only schedule key deletion tasks. You cannot directly delete CMKs. If you want to delete a CMK, call the [DisableKey](~~35151~~) operation to disable the CMK.'."\n"
."\n"
.'When you call this operation, you must specify a scheduled period between 7 days to 366 days. The scheduled period starts from the time when you submit the request. You can call the [CancelKeyDeletion](~~44197~~) operation to cancel the key deletion task before the scheduled period ends.'."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'SetDeletionProtection' => [
'summary' => 'Enables or disables deletion protection for a customer master key (CMK).',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '54603',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'ProtectedResourceArn',
'in' => 'query',
'schema' => ['description' => 'The ARN of the CMK for which you want to configure deletion protection.<br>'."\n"
.'You can call the [DescribeKey](~~28952~~) operation to query the ARN of the CMK.<br><br>', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'acs:kms:cn-hangzhou:123213123****:key/0225f411-b21d-46d1-be5b-93931c82****', 'title' => ''],
],
[
'name' => 'EnableDeletionProtection',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable deletion protection. Valid values:'."\n"
."\n"
.'- true: enables deletion protection.'."\n"
."\n"
.'- false: disables deletion protection. This is the default value.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DeletionProtectionDescription',
'in' => 'query',
'schema' => ['description' => 'The description of deletion protection.'."\n"
."\n"
.'> This parameter is available only when EnableDeletionProtection is set to true.', 'type' => 'string', 'example' => 'The CMK is being used by XXX. Deletion protection is set.', 'required' => false, 'title' => ''],
],
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key.', 'type' => 'string', 'required' => false, 'example' => 'key-hzz65f3a68554s6ms****', 'title' => ''],
],
[
'name' => 'KmsInstanceId',
'in' => 'query',
'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. The ID is a unique identifier that is generated by Alibaba Cloud for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '3455b9b4-95c1-419d-b310-db6a53b09a39', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3455b9b4-95c1-419d-b310-db6a53b09a39\\"\\n}","type":"json"}]',
'title' => 'SetDeletionProtection',
'description' => '- For more information about the access policy required for a RAM user or RAM role to call this API operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- After you enable deletion protection for a CMK, you cannot delete it. To delete the CMK, you must first disable deletion protection.'."\n"
."\n"
.'- Before you call the SetDeletionProtection operation, ensure that the CMK is not in the PendingDeletion state. You can call the [DescribeKey](~~28952~~) operation to query the status of the CMK.',
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'translator' => 'machine',
],
'SetKeyPolicy' => [
'summary' => 'Sets the key policy for a CMK in a KMS instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '206075',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID or Alibaba Cloud Resource Name (ARN) of the key.'."\n"
."\n"
.'> To access a key of another Alibaba Cloud account, you must specify the ARN of the key. The key ARN is in the format of `acs:kms:${region}:${account}:key/${keyid}`.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'key-hzz630494463ejqjx****'],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => 'The name of the key policy. The name can only be \\`default\\`.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => ['description' => 'The key policy. The policy is in the JSON format. The policy can be up to 32,768 bytes in length.'."\n"
."\n"
.'A key policy contains the following elements:'."\n"
."\n"
.'- Version: The version of the key policy. The value can only be 1.'."\n"
."\n"
.'- Statement: The statement of the key policy. Each key policy can contain one or more statements.'."\n"
."\n"
.'The following code provides an example of a key policy:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Version": "1",'."\n"
.' "Statement": ['."\n"
.' {'."\n"
.' "Sid": "Enable RAM User Permissions",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "RAM": ["acs:ram::112890462****:*"]'."\n"
.' },'."\n"
.' "Action": ['."\n"
.' "kms:*"'."\n"
.' ],'."\n"
.' "Resource": ['."\n"
.' "*"'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'The following section describes the elements in a Statement:'."\n"
."\n"
.'- Sid: Optional. The custom statement identifier. The value can be up to 128 characters in length and can contain uppercase letters, lowercase letters, digits, and the following special characters: \\_ / + = . @ -.'."\n"
."\n"
.'- Effect: Required. The effect of the policy statement. Valid values: Allow and Deny.'."\n"
."\n"
.'- Principal: Required. The principal that is authorized to access the key. You can set this parameter to the current Alibaba Cloud account, a RAM user or RAM role of the current Alibaba Cloud account, or a RAM user or RAM role of another Alibaba Cloud account.'."\n"
."\n"
.'- Action: Required. The API operations that are allowed or denied. The value must start with kms:. For more information about the operations, see [Key policy overview](~~2716468~~). If you specify an operation that is not included in the list, the operation will not take effect.'."\n"
."\n"
.'- Resource: Required. The key. The value can only be \\*.'."\n"
."\n"
.'- Condition: Optional. The conditions for the policy to take effect. You can use conditions to evaluate the context of an API request to determine whether the policy statement is applicable. The format is `"Condition": {"condition operator": {"condition key": "condition value"}}`. For more information, see [Key policy overview](~~2716468~~).'."\n"
."\n"
.'> After you grant permissions to a RAM user or RAM role of another Alibaba Cloud account, you must use the Alibaba Cloud account to which the RAM user or RAM role belongs to grant the RAM user or RAM role the permissions to use the key in the RAM console. For more information, see [Custom policies for KMS](~~480682~~), [Grant permissions to a RAM user](~~116146~~), and [Grant permissions to a RAM role](~~116147~~).', 'type' => 'string', 'required' => true, 'example' => '{"Statement":[{"Action":["kms:*"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:*"]},"Resource":["*"],"Sid":"kms default key policy"},{"Action":["kms:List*","kms:Describe*","kms:Create*","kms:Enable*","kms:Disable*","kms:Get*","kms:Set*","kms:Update*","kms:Delete*","kms:Cancel*","kms:TagResource","kms:UntagResource","kms:ImportKeyMaterial","kms:ScheduleKeyDeletion"],"Effect":"Allow","Principal":{"RAM":["acs:ram::119285303511****:user/for_test_policy"]},"Resource":["*"]}],"Version":"1"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud. You can use the ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '381D5D33-BB8F-395F-8EE4-AE3BB4B523C8'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter needed but no provided.', 'description' => 'The required parameters are not specified.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system.', 'description' => 'You are not authorized to perform this operation.'],
['errorCode' => 'Forbidden.KeyPolicyUnSupported', 'errorMessage' => 'The specified key does not support key policy.', 'description' => 'The specified key does not support key policies.'],
['errorCode' => 'Rejected.ShareQuotaExceedLimit', 'errorMessage' => 'Instance Share Quota Exceed Limit.', 'description' => 'The instance share quota exceeds the limit.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceStateInvalid', 'errorMessage' => 'The DKMS instance state is invalid.', 'description' => 'Your dedicated KMS instance is invalid.'],
],
[
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Policy not found.', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => 'An internal error occurred.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"381D5D33-BB8F-395F-8EE4-AE3BB4B523C8\\"\\n}","type":"json"}]',
'title' => 'SetKeyPolicy',
'description' => '- For information about the access policy required for a RAM user or RAM role to call this API operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- For more information about key policies, see [Key policy overview](~~2716468~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'SetSecretPolicy' => [
'summary' => 'Sets the access policy for a secret in a KMS instance.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '206088',
'abilityTreeNodes' => ['FEATUREkms52EQP9'],
],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name or Alibaba Cloud Resource Name (ARN) of the secret.'."\n"
."\n"
.'> When you access a secret in another Alibaba Cloud account, you must specify the ARN of the secret. The ARN of a secret is in the format of `acs:kms:${region}:${account}:secret/${secret-name}`.', 'type' => 'string', 'title' => '', 'required' => true, 'example' => 'secret_test'],
],
[
'name' => 'PolicyName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret policy. The value can only be \\`default\\`.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''],
],
[
'name' => 'Policy',
'in' => 'query',
'schema' => ['description' => 'The content of the secret policy. The value must be in the JSON format. The value can be up to 32,768 bytes in length.'."\n"
."\n"
.'A secret policy contains the following elements:'."\n"
."\n"
.'- Version: The version of the secret policy. The value can only be 1.'."\n"
."\n"
.'- Statement: The statement of the secret policy. Each secret policy can contain one or more statements.'."\n"
."\n"
.'The following code shows the format of a secret policy:'."\n"
."\n"
.'```'."\n"
.'{'."\n"
.' "Version": "1",'."\n"
.' "Statement": ['."\n"
.' {'."\n"
.' "Sid": "Enable RAM User Permissions",'."\n"
.' "Effect": "Allow",'."\n"
.' "Principal": {'."\n"
.' "RAM": ["acs:ram::12345678****:*"]'."\n"
.' },'."\n"
.' "Action": ['."\n"
.' "kms:*"'."\n"
.' ],'."\n"
.' "Resource": ['."\n"
.' "*"'."\n"
.' ]'."\n"
.' }'."\n"
.' ]'."\n"
.'}'."\n"
.'```'."\n"
."\n"
.'The following section describes the elements in a statement:'."\n"
."\n"
.'- Sid: Optional. The custom identifier of the statement. The value can be up to 128 characters in length and can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), and special characters, including underscores (\\_), forward slashes (/), equal signs (=), plus signs (+), periods (.), at signs (@), and hyphens (-).'."\n"
."\n"
.'- Effect: Required. Specifies whether to allow or deny the permissions in the statement. Valid values: Allow and Deny.'."\n"
."\n"
.'- Principal: Required. The principal that is authorized to access the secret. You can set this parameter to the current Alibaba Cloud account (the account to which the secret belongs), a RAM user or RAM role of the current Alibaba Cloud account, or a RAM user or RAM role of another Alibaba Cloud account.'."\n"
."\n"
.'- Action: Required. The API operations that are allowed or denied. The value must start with \\`kms:\\`. For a list of supported operations, see [Secret policy overview](~~2716465~~). If you specify an operation that is not in the list, the operation does not take effect.'."\n"
."\n"
.'- Resource: Required. The value can only be \\`\\*\\`, which indicates the current KMS secret.'."\n"
."\n"
.'- Condition: Optional. The conditions for the authorization to take effect. You can use conditions to evaluate the context of an API request to determine whether a policy statement is applicable. The format is `"Condition": {"condition operator": {"condition key": "condition value"}}`. For more information, see [Secret policy overview](~~2716465~~).'."\n"
."\n"
.'> After you grant permissions to a RAM user or RAM role of another Alibaba Cloud account, you must go to the RAM console and use the Alibaba Cloud account to which the RAM user or RAM role belongs to grant the RAM user or RAM role the permissions to use the secret. For more information, see [Custom policies for KMS](~~480682~~), [Grant permissions to a RAM user](~~116146~~), and [Grant permissions to a RAM role](~~116147~~).', 'type' => 'string', 'required' => true, 'example' => '{"Version":"1","Statement": [{"Sid":"kms default secret policy","Effect":"Allow","Principal":{"RAM": ["acs:ram::119285303511****:*"]},"Action":["kms:*"],"Resource": ["*"] }] }', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => '',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is a unique identifier generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '381D5D33-BB8F-395F-8EE4-AE3BB4B523C8'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter', 'errorMessage' => 'The parameter needed but no provided.', 'description' => 'The required parameters are not specified.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system.', 'description' => 'You are not authorized to perform this operation.'],
['errorCode' => 'Forbidden.KeyPolicyUnSupported', 'errorMessage' => 'The specified key does not support key policy.', 'description' => 'The specified key does not support key policies.'],
['errorCode' => 'Rejected.ShareQuotaExceedLimit', 'errorMessage' => 'Instance Share Quota Exceed Limit.', 'description' => 'The instance share quota exceeds the limit.'],
],
403 => [
['errorCode' => 'Forbidden.DKMSInstanceStateInvalid', 'errorMessage' => 'The DKMS instance state is invalid.', 'description' => 'Your dedicated KMS instance is invalid.'],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found.', 'description' => 'The resource is not found.'],
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
503 => [
['errorCode' => 'SerivceUnvailableTemporary', 'errorMessage' => 'Service Unvailable Temporary', 'description' => 'The service is temporarily unavailable.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"381D5D33-BB8F-395F-8EE4-AE3BB4B523C8\\"\\n}","type":"json"}]',
'title' => 'SetSecretPolicy',
'description' => '- For information about the access policy that a RAM user or RAM role requires to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- For more information about secret policies, see [Secret policy overview](~~2716465~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'TagResource' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the customer master key (CMK). The ID must be globally unique.'."\n"
."\n"
.'> You can configure only one of the KeyId, SecretName, and CertificateId parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'schema' => ['description' => 'One or more tags that you want to add. The value is in the array format.'."\n"
."\n"
.'Tag attributes:'."\n"
."\n"
.'- TagKey: the tag key.'."\n"
."\n"
.'- TagValue: the tag value.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}]', 'title' => ''],
],
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret.'."\n"
."\n"
.'> You can configure only one of the KeyId, SecretName, and CertificateId parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'MyDbC****', 'title' => ''],
],
[
'name' => 'CertificateId',
'in' => 'query',
'schema' => ['description' => 'The ID of the certificate.'."\n"
."\n"
.'> You can configure only one of the KeyId, SecretName, and CertificateId parameters.', 'type' => 'string', 'required' => false, 'example' => '770dbe42-e146-43d1-a55a-1355db86****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4162a6af-bc99-40b3-a552-89dcc8aaf7c8', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4162a6af-bc99-40b3-a552-89dcc8aaf7c8\\"\\n}","type":"json"}]',
'title' => 'TagResource',
'summary' => 'Adds tags to a CMK, secret, or certificate.',
'description' => 'You can add up to 10 tags to a CMK, secret, or certificate.'."\n"
."\n"
.'In this example, the tags `[{"TagKey":"S1key1","TagValue":"S1val1"},{"TagKey":"S1key2","TagValue":"S2val2"}]` are added to the CMK whose ID is `08c33a6f-4e0a-4a1b-a3fa-7ddf****`.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'TagResources' => [
'summary' => 'Adds tags to one or more keys or secrets.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '177226',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the resource.'."\n"
."\n"
.'> You can call the [DescribeRegions](~~601478~~) to query the most recent region list.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The type of the resource to which you want to add tags. Valid values:'."\n"
."\n"
.'- key'."\n"
."\n"
.'- secret', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'key'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'The IDs of the resources to which you want to add tags. You can enter a maximum of 50 resource IDs.'."\n"
."\n"
.'Enter multiple resource IDs in the `["ResourceId. 1","ResourceId. 2",...]` format.',
'type' => 'array',
'items' => ['description' => 'The IDs of the resources to which you want to add tags. You can enter a maximum of 50 resource IDs.'."\n"
."\n"
.'Enter multiple resource IDs in the `["ResourceId. 1","ResourceId. 2",...]` format.', 'type' => 'string', 'required' => false, 'example' => 'key-hzz62f1cb66fa42qo****', 'title' => ''],
'required' => true,
'maxItems' => 51,
'example' => '',
],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'A list of tags. You can enter up to 20 tags.'."\n"
."\n"
.'A tag consists of a key-value pair. Enter multiple tags in the `[{"Key":"key1","Value":"value1"},{"Key":"key2","Value":"value2"},..]` format.',
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The key of the tag. A tag consists of a key-value pair.'."\n"
."\n"
.'You can enter up to 20 tags. Enter multiple tags in the `[{"Key":"key1","Value":"value1"},{"Key":"key2","Value":"value2"},..]` format.'."\n"
."\n"
.'Each key can be up to 128 characters in length and can contain letters, digits, forward slashes (/), backslashes (\\), underscores (\\_), hyphens (-), periods (.), plus signs (+), equal signs (=), colons (:), and at signs (@).'."\n"
."\n"
.'> The key cannot start with aliyun or acs:.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'disk-encryption'],
'Value' => ['description' => 'The value of the tag. A tag consists of a key-value pair.'."\n"
."\n"
.'You can enter up to 20 tags. Enter multiple tags in the `[{"Key":"key1","Value":"value1"},{"Key":"key2","Value":"value2"},..]` format.'."\n"
."\n"
.'Each value can be up to 128 characters in length and can contain letters, digits, forward slashes (/), backslashes (\\), underscores (\\_), hyphens (-), periods (.), plus signs (+), equal signs (=), colons (:), and at signs (@).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'true'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 21,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '598d0219-45cd-4477-84ad-85a52d9debcf'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter.TagValue', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''],
['errorCode' => 'InvalidParameter.TagKey', 'errorMessage' => 'The specified parameter is not valid.', 'description' => ''],
['errorCode' => 'Duplicate.TagKey', 'errorMessage' => 'The specified tagKey is duplicate.', 'description' => ''],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceId is not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'TagResources',
'description' => 'You can add multiple tags to multiple keys or multiple secrets at a time.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"598d0219-45cd-4477-84ad-85a52d9debcf\\"\\n}","type":"json"}]',
],
'UntagResource' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. This is the globally unique identifier (GUID) of the master key (CMK).'."\n"
."\n"
.'> You must specify one and only one of the KeyId, SecretName, and CertificateId parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '08c33a6f-4e0a-4a1b-a3fa-7ddf****', 'title' => ''],
],
[
'name' => 'TagKeys',
'in' => 'query',
'schema' => ['description' => 'One or more tag keys. Separate multiple tag keys with commas (,).<br> You need to specify only tag keys, not tag values.<br> The tag key can be 1 to 128 bytes in length.<br><br>', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["tagkey1","tagkey2"]', 'title' => ''],
],
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the credential.'."\n"
."\n"
.'> You must specify one and only one of the KeyId, SecretName, and CertificateId parameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'MyDbC****', 'title' => ''],
],
[
'name' => 'CertificateId',
'in' => 'query',
'schema' => ['description' => 'The ID of the certificate.'."\n"
."\n"
.'> You must specify one and only one of the KeyId, SecretName, and CertificateId parameters.', 'type' => 'string', 'required' => false, 'example' => '770dbe42-e146-43d1-a55a-1355db86****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. This ID is generated by Alibaba Cloud to uniquely identify the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '4162a6af-bc99-40b3-a552-89dcc8aaf7c8', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4162a6af-bc99-40b3-a552-89dcc8aaf7c8\\"\\n}","type":"json"}]',
'title' => 'UntagResource',
'summary' => 'Removes tags from a CMK, secret, or certificate.',
'description' => 'For information about the access policy that is required for a RAM user or RAM role to call this OpenAPI operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'This topic provides an example of how to detach tags with the tag keys tagkey1 and tagkey2 from the key with the ID `08c33a6f-4e0a-4a1b-a3fa-7ddf****`.',
'requestParamsDescription' => 'For information about common request parameters, see [Common parameters](~~69007~~).',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'UntagResources' => [
'summary' => 'Removes tags from keys or secrets.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'systemTags' => [
'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '177229',
'abilityTreeNodes' => ['FEATUREkms5QHERY'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The region ID of the resource.'."\n"
."\n"
.'> You can call the [DescribeRegions](~~601478~~) operation to query the most recent region list.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The type of the resource from which you want to remove tags. Valid values:'."\n"
."\n"
.'* key'."\n"
.'* secret'."\n", 'type' => 'string', 'required' => true, 'example' => 'key'],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to remove all tags from resources. Valid values:'."\n"
."\n"
.'* true'."\n"
.'* false (default)'."\n"
."\n"
.'> This parameter takes effect only when you specify an empty tag key.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'The IDs of the resources from which you want to remove tags. You can enter up to 50 resource IDs.'."\n"
."\n"
.'Enter multiple resource IDs in the `["ResourceId.1","ResourceId.2",...]` format.'."\n",
'type' => 'array',
'items' => ['description' => 'The IDs of the resources from which you want to remove tags. You can enter up to 50 resource IDs.'."\n"
."\n"
.'Enter multiple resource IDs in the `["ResourceId.1","ResourceId.2",...]` format.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key-hzz62f1cb66fa42qo****', 'title' => ''],
'required' => true,
'maxItems' => 51,
'example' => '',
],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'title' => '',
'description' => 'The keys of the tags that you want to remove. You can enter up to 20 tag keys.'."\n"
."\n"
.'Enter multiple tag keys in the `["key.1","key.2",...]` format.'."\n"
."\n"
.'> The tag key cannot start with aliyun or acs:.'."\n",
'type' => 'array',
'items' => ['description' => 'The keys of the tags that you want to remove. You can enter up to 20 tag keys.'."\n"
."\n"
.'Enter multiple tag keys in the `["key.1","key.2",...]` format.'."\n"
."\n"
.'> The tag key cannot start with aliyun or acs:.'."\n", 'type' => 'string', 'required' => false, 'example' => 'disk-encryption', 'title' => ''],
'required' => false,
'maxItems' => 21,
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'b1f210dc-e52c-4a86-b9dd-7492343d46c7', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
['errorCode' => 'InvalidResourceId.NotFound', 'errorMessage' => 'The specified ResourceId is not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"b1f210dc-e52c-4a86-b9dd-7492343d46c7\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n <RequestId>b1f210dc-e52c-4a86-b9dd-7492343d46c7</RequestId>\\n</UntagResourcesResponse>","errorExample":""}]',
'title' => 'UntagResources',
'description' => 'You can remove multiple tags from multiple keys or multiple secrets at a time. You cannot remove tags that start with aliyun or acs:.'."\n"
."\n"
.'If you enter multiple tag keys in the request parameters and only some of the tag keys are associated with resources, the operation can be called and the tags whose keys are associated with resources are removed from the resources.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
],
],
],
'UpdateAlias' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
[
'name' => 'AliasName',
'in' => 'query',
'schema' => ['description' => 'The alias that you want to bind.'."\n"
."\n"
.'The value must be 1 to 255 characters in length and must include the alias/ prefix.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'alias/example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '1d2baaf3-d357-46c2-832e-13560c2bd9cd', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1d2baaf3-d357-46c2-832e-13560c2bd9cd\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAliasResponse>\\n <RequestId>1d2baaf3-d357-46c2-832e-13560c2bd9cd</RequestId>\\n</UpdateAliasResponse>","errorExample":""}]',
'title' => 'UpdateAlias',
'summary' => 'Binds an existing alias to a different customer master key (CMK) ID.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'UpdateApplicationAccessPoint' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '54640',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the AAP that you want to update.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aap_test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'aap description', 'title' => ''],
],
[
'name' => 'Policies',
'in' => 'query',
'schema' => ['description' => 'The permission policy that you want to update.'."\n"
.'> You can associate up to three permission policies with each AAP.', 'type' => 'string', 'required' => false, 'example' => '["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.', 'type' => 'string', 'example' => 'bcfefe15-46f0-44a3-bd96-3d422474b71a', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'An invalid value is specified for the parameter.'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"bcfefe15-46f0-44a3-bd96-3d422474b71a\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateApplicationAccessPointResponse>\\n <RequestId>bcfefe15-46f0-44a3-bd96-3d422474b71a</RequestId>\\n</UpdateApplicationAccessPointResponse>","errorExample":""}]',
'title' => 'UpdateApplicationAccessPoint',
'summary' => 'Updates the information about an application access point (AAP).',
'description' => 'The update takes effect immediately after an AAP information is updated. Exercise caution when you perform this operation. You can update the description of an AAP and the permission policies that are associated with the AAP. You cannot update the name of the AAP.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'UpdateKeyDescription' => [
'summary' => 'Updates the description of a CMK.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CMK. The ID must be globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234abcd-12ab-34cd-56ef-12345678****', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the CMK. This description includes the purpose of the CMK, such as the types of data that you want to protect and applications that can use the CMK.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key description example', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3455b9b4-95c1-419d-b310-db6a53b09a39', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3455b9b4-95c1-419d-b310-db6a53b09a39\\"\\n}","type":"json"}]',
'title' => 'UpdateKeyDescription',
'description' => 'This operation replaces the description of a customer master key (CMK) with the description that you specify. The original description of the CMK is specified by the Description parameter when you call the [DescribeKey](~~28952~~) operation. Use this operation to add, modify, or delete the description of a CMK.'."\n"
."\n"
.'For more information about the access policy required for a RAM user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'UpdateKmsInstanceBindVpc' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'none',
'abilityTreeCode' => '193192',
'abilityTreeNodes' => ['FEATUREkms586TOR'],
],
'parameters' => [
[
'name' => 'KmsInstanceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the KMS instance.', 'type' => 'string', 'required' => true, 'example' => 'kst-phzz64f722a1buamw0****', 'title' => ''],
],
[
'name' => 'BindVpcs',
'in' => 'query',
'schema' => ['description' => 'The VPC configuration. Each VPC configuration contains the following parameters:'."\n"
."\n"
.'- VpcId: The ID of the VPC.'."\n"
."\n"
.'- VSwitchId: The vSwitch in the VPC.'."\n"
."\n"
.'- RegionID: The region where the VPC resides.'."\n"
."\n"
.'- VpcOwnerId: The Alibaba Cloud account that owns the VPC.'."\n"
."\n"
.'The value is a JSON string in the following format: `[{"VpcId":"${VpcId}","VSwitchId":"${VSwitchId}","RegionId":"${RegionId}","VpcOwnerId":${VpcOwnerId}},...]`.', 'type' => 'string', 'required' => true, 'example' => '[{"VpcId":"vpc-bp1go9qvmj78j4f4c****","VSwitchId":"vsw-bp16c5pvvcf0fp5b9****","RegionId":"cn-hangzhou","VpcOwnerId":120708975881****},{"VpcId":"vpc-bp14c07ucxg6h1xjm****","VSwitchId":"vsw-bp1wujtnspi1l3gvu****","RegionId":"cn-hangzhou","VpcOwnerId":119285303511****}]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response schema.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. This ID is generated by Alibaba Cloud and is unique to the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'd3eca5c8-a856-4347-8eb6-e1898c3fda2e'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateKmsInstanceBindVpc',
'summary' => 'Updates the VPC bindings of a KMS instance.',
'description' => '- For information about the access policy required for a Resource Access Management (RAM) user or RAM role to call this operation, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- If your self-managed application is deployed in multiple VPCs in the same region, you can bind the KMS instance to additional VPCs. These VPCs are in addition to the one that you specified when you enabled the instance.'."\n"
."\n"
.' These VPCs can belong to the same Alibaba Cloud account or different Alibaba Cloud accounts. After the configuration is complete, self-managed applications in these VPCs can access the specified KMS instance.'."\n"
."\n"
.' > If the VPCs belong to different Alibaba Cloud accounts, you must first configure resource sharing to share the vSwitch resources from those accounts with the Alibaba Cloud account that owns the KMS instance. For more information, see [Access a KMS instance from multiple VPCs in the same region](~~2393236~~).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"d3eca5c8-a856-4347-8eb6-e1898c3fda2e\\"\\n}","type":"json"}]',
],
'UpdateNetworkRule' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '54644',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the network control rule that you want to update.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'networkrule_test', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The updated description.', 'type' => 'string', 'required' => false, 'example' => 'Create by kst-hzz62ee817bvyyr5****', 'title' => ''],
],
[
'name' => 'SourcePrivateIp',
'in' => 'query',
'schema' => ['description' => 'The updated private IP addresses or private CIDR blocks. Separate multiple IP addresses or private CIDR blocks with a comma (,).', 'type' => 'string', 'required' => false, 'example' => '["192.10.XX.XX","192.168.XX.XX/24"]', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '3bf02f7a-015b-4f34-be0f-cc043fda2d85', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'title' => 'UpdateNetworkRule',
'summary' => 'Updates a network access rule.',
'description' => '- For more information about the access policy required for a Resource Access Management (RAM) user or RAM role to call this operation, see [Access control](~~2767210~~).'."\n"
."\n"
.'- You can only modify the private IP addresses and description of a network control rule. The name and network type cannot be modified.'."\n"
."\n"
.'- When you update a network control rule, the access policies attached to it are also updated. Proceed with caution.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3bf02f7a-015b-4f34-be0f-cc043fda2d85\\"\\n}","type":"json"}]',
],
'UpdatePolicy' => [
'summary' => 'Updates a permission policy.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'abilityTreeCode' => '54641',
'abilityTreeNodes' => ['FEATUREkms9F3ZXA'],
],
'parameters' => [
[
'name' => 'Name',
'in' => 'query',
'schema' => ['description' => 'The name of the permission policy that you want to update.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'policy_test', 'title' => ''],
],
[
'name' => 'Permissions',
'in' => 'query',
'schema' => ['description' => 'The operations that are supported by the updated policy. Valid values:'."\n"
."\n"
.'* RbacPermission/Template/CryptoServiceKeyUser: allows you to perform cryptographic operations.'."\n"
.'* RbacPermission/Template/CryptoServiceSecretUser: allows you to perform secret-related operations.'."\n"
."\n"
.'You can select both.'."\n", 'type' => 'string', 'required' => false, 'example' => '["RbacPermission/Template/CryptoServiceKeyUser", "RbacPermission/Template/CryptoServiceSecretUser"]', 'title' => ''],
],
[
'name' => 'Resources',
'in' => 'query',
'schema' => ['description' => 'The key and secret that are allowed to access after the update.'."\n"
."\n"
.'* Key: Enter a key in the `key/${KeyId}` format. To allow access to all keys of a KMS instance, enter key/\\*.'."\n"
.'* Secret: Enter a secret in the `secret/${SecretName}` format. To allow access to all secrets of a KMS instance, enter secret/\\*.'."\n", 'type' => 'string', 'required' => false, 'example' => '["secret/acs/ram/user/ram-secret", "secret/acs/ram/user/acr-master", "key/key-hzz63d9c8d3dfv8cv****"]', 'title' => ''],
],
[
'name' => 'AccessControlRules',
'in' => 'query',
'schema' => ['description' => 'The access control rule.'."\n"
."\n"
.'> For more information about how to query created access control rules, see [ListNetworkRules](~~2539433~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '{"NetworkRules":["kst-hzz62ee817bvyyr5x****.efkd","kst-hzz62ee817bvyyr5x****.eyyp"]}', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'policy description', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'f455324b-e229-4066-9f58-9c1cf3fe83a8', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is not valid.', 'description' => 'An invalid value is specified for the parameter.'],
],
404 => [
['errorCode' => 'InvalidAccessKeyId.NotFound', 'errorMessage' => 'The Access Key ID provided does not exist in our records.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"f455324b-e229-4066-9f58-9c1cf3fe83a8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdatePolicyResponse>\\n <RequestId>f455324b-e229-4066-9f58-9c1cf3fe83a8</RequestId>\\n</UpdatePolicyResponse>","errorExample":""}]',
'title' => 'UpdatePolicy',
'description' => '- You can update the role-based access control (RBAC) permissions, accessible resources, access control rules, and description of a permission policy. You cannot update the name or scope of a permission policy.'."\n"
.'- Updating a permission policy affects all application access points (AAPs) that are bound to the permission policy. Exercise caution when you perform this operation.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'UpdateRotationPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the customer master key (CMK). The ID must be globally unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'key-hzz62f1cb66fa42qo****', 'title' => ''],
],
[
'name' => 'EnableAutomaticRotation',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable automatic key rotation. Valid values:'."\n"
."\n"
.'- true: enables automatic key rotation.'."\n"
."\n"
.'- false: disables automatic key rotation.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RotationInterval',
'in' => 'query',
'schema' => ['description' => 'The period of automatic key rotation. Specify the value in the integer\\[unit] format. The following units are supported: d (day), h (hour), m (minute), and s (second). For example, you can use either 7d or 604800s to specify a seven-day period. The period can range from 7 days to 730 days.'."\n"
."\n"
.'> If you set the EnableAutomaticRotation parameter to true, you must also specify this parameter. If you set the EnableAutomaticRotation parameter to false, you can leave this parameter unspecified.', 'type' => 'string', 'required' => false, 'example' => '30d', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'efb1cbbd-a093-4278-bc03-639dd4fcc207', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Rejected.UnsupportedOperation', 'errorMessage' => 'Unsupported operation.', 'description' => 'The operation is not supported.'],
['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter RotationInterval is not valid.', 'description' => 'Invalid RotationInterval parameter value.'],
],
404 => [
['errorCode' => 'Forbidden.KeyNotFound', 'errorMessage' => 'The specified Key is not found.', 'description' => 'The error message returned because the specified CMK does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"efb1cbbd-a093-4278-bc03-639dd4fcc207\\"\\n}","type":"json"}]',
'title' => 'UpdateRotationPolicy',
'summary' => 'Updates the automatic rotation policy of a CMK.',
'description' => 'When automatic key rotation is enabled, KMS automatically creates a key version after the preset rotation period arrives. In addition, KMS sets the new key version as the primary key version.'."\n"
."\n"
.'An automatic key rotation policy cannot be configured for the following keys:'."\n"
."\n"
.'- Asymmetric key'."\n"
."\n"
.'- Service-managed key'."\n"
."\n"
.'- Bring your own key (BYOK) that is imported into KMS'."\n"
."\n"
.'- Key that is not in the **Enabled** state'."\n"
."\n"
.'In this example, automatic key rotation is enabled for a CMK whose ID is `1234abcd-12ab-34cd-56ef-12345678****`. The automatic rotation period is 30 days.'."\n"
."\n"
.'For more information about the access policy required by a RAM user or RAM role to call this API, see [Resource Access Management](~~2767210~~).',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'UpdateSecret' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'Description',
'in' => 'query',
'schema' => ['description' => 'The description of the secret.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'datainfo', 'title' => ''],
],
[
'name' => 'ExtendedConfig.CustomData',
'in' => 'query',
'style' => 'json',
'schema' => ['description' => 'The custom data in the extended configuration of the secret.'."\n"
."\n"
.'> * If this parameter is specified, the existing extended configuration of the secret is updated.'."\n"
.'> * This parameter is unavailable for generic secrets.', 'type' => 'object', 'required' => false, 'example' => '{"DBName":"app1","Port":"3306"}', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system', 'description' => ''],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
],
409 => [
['errorCode' => 'Rejected.ResourceExist', 'errorMessage' => 'The request was rejected becasue key already exsit', 'description' => ''],
['errorCode' => 'Rejected.ResourceInDeleteWindow', 'errorMessage' => 'secret in delete peroid', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecretName\\": \\"secret001\\",\\n \\"RequestId\\": \\"5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateSecretResponse>\\n <SecretName>secret001</SecretName>\\n <RequestId>5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47</RequestId>\\n</UpdateSecretResponse>","errorExample":""}]',
'title' => 'UpdateSecret',
'summary' => 'Updates the metadata of a secret.',
'description' => 'In this example, the metadata of the `secret001` secret is updated. The `Description` parameter is set to `datainfo`.'."\n",
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'UpdateSecretRotationPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'RdsSecret/Mysql5.4/MyCred', 'title' => ''],
],
[
'name' => 'EnableAutomaticRotation',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable automatic rotation. Valid values:'."\n"
."\n"
.'* true: enables automatic rotation.'."\n"
.'* false: does not enable automatic rotation. This is the default value.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''],
],
[
'name' => 'RotationInterval',
'in' => 'query',
'schema' => ['description' => 'The interval for automatic rotation. Valid values: 6 hours to 8,760 hours (365 days).'."\n"
."\n"
.'The value is in the `integer[unit]` format.````'."\n"
."\n"
.'The unit can be d (day), h (hour), m (minute), or s (second). For example, both 7d and 604800s indicate a seven-day interval.'."\n"
."\n"
.'> This parameter is required if you set the EnableAutomaticRotation parameter to true. This parameter is ignored if you set the EnableAutomaticRotation parameter to false or does not specify the EnableAutomaticRotation parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '30d', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.'."\n", 'type' => 'string', 'example' => 'RdsSecret/Mysql5.4/MyCred', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '2c124f6f-4210-499f-b88a-69f54004d2d8', 'title' => ''],
],
'description' => '',
'title' => '',
],
],
],
'errorCodes' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"SecretName\\": \\"RdsSecret/Mysql5.4/MyCred\\",\\n \\"RequestId\\": \\"2c124f6f-4210-499f-b88a-69f54004d2d8\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateSecretRotationPolicyResponse>\\n <SecretName>RdsSecret/Mysql5.4/MyCred</SecretName>\\n <RequestId>2c124f6f-4210-499f-b88a-69f54004d2d8</RequestId>\\n</UpdateSecretRotationPolicyResponse>","errorExample":""}]',
'title' => 'UpdateSecretRotationPolicy',
'summary' => 'Updates the rotation policy of a secret.',
'description' => 'After automatic rotation is enabled, Secrets Manager schedules the first automatic rotation by adding the preset rotation interval to the timestamp of the last rotation.'."\n"
."\n"
.'Limits: The UpdateSecretRotationPolicy operation cannot be used to update the rotation policy of generic secrets.'."\n"
."\n"
.'In this example, the rotation policy of the `RdsSecret/Mysql5.4/MyCred` secret is updated. The following settings are modified:'."\n"
."\n"
.'* The `EnableAutomaticRotation` parameter is set to `true`, which indicates that automatic rotation is enabled.'."\n"
.'* The `RotationInterval` parameter is set to `30d`, which indicates that the interval for automatic rotation is 30 days.'."\n",
'requestParamsDescription' => 'For more information about common request parameters, see [Common parameters](~~69007~~).'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'UpdateSecretVersionStage' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'SecretName',
'in' => 'query',
'schema' => ['description' => 'The name or Alibaba Cloud Resource Name (ARN) of the secret.'."\n"
."\n"
.'> To access a secret in a different Alibaba Cloud account, you must specify the ARN of the secret. The ARN is in the format of `acs:kms:${region}:${account}:secret/${secret-name}`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'secret001', 'title' => ''],
],
[
'name' => 'VersionStage',
'in' => 'query',
'schema' => ['description' => 'The version stage of the secret.'."\n"
."\n"
.'**Scenario 1: Add a version stage to a specified secret version.**'."\n"
."\n"
.'Specify this parameter and MoveToVersion. Do not specify RemoveFromVersion. This parameter can be set to ACSCurrent, ACSPrevious, or a custom stage.'."\n"
."\n"
.'**Scenario 2: Remove a version stage from a specified secret version.**'."\n"
."\n"
.'Specify this parameter and RemoveFromVersion. Do not specify MoveToVersion. This parameter must be set to a custom stage.'."\n"
."\n"
.'> ACSCurrent and ACSPrevious are system-reserved stages. You cannot directly remove them. You can only remove them from one secret version and attach them to another.'."\n"
."\n"
.'**Scenario 3: Remove a version stage from a specified secret version and attach it to another secret version.**'."\n"
."\n"
.'Specify this parameter, MoveToVersion, and RemoveFromVersion. This parameter can be set to ACSCurrent, ACSPrevious, or a custom stage.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ACSCurrent', 'title' => ''],
],
[
'name' => 'RemoveFromVersion',
'in' => 'query',
'schema' => ['description' => 'The version number of the secret. This parameter specifies that the version stage set by VersionStage is removed from this version.'."\n"
."\n"
.'> You must specify at least one of RemoveFromVersion and MoveToVersion.', 'type' => 'string', 'required' => false, 'example' => '001', 'title' => ''],
],
[
'name' => 'MoveToVersion',
'in' => 'query',
'schema' => ['description' => 'The version number of the secret. This parameter specifies that the version stage set by VersionStage is attached to this version.'."\n"
."\n"
.'> - You must specify at least one of RemoveFromVersion and MoveToVersion.'."\n"
.'>'."\n"
.'> - If you set VersionStage to ACSCurrent or ACSPrevious, you must specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '002', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'SecretName' => ['description' => 'The name of the secret.', 'type' => 'string', 'example' => 'secret001', 'title' => ''],
'RequestId' => ['description' => 'The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '8cad259f-4d77-40ec-bbd7-b9c47a423bb9', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidParameter', 'errorMessage' => 'some of the specified parameters "\\" is not valid', 'description' => ''],
['errorCode' => 'Rejected.LimitExceeded', 'errorMessage' => 'exceed secret limits error', 'description' => ''],
['errorCode' => 'Rejected.InvalidRequest', 'errorMessage' => 'param mismatch', 'description' => ''],
['errorCode' => 'Rejected.UnsupportedOperation', 'errorMessage' => 'secret stages in unnormal status', 'description' => ''],
],
403 => [
['errorCode' => 'Forbidden.NoPermission', 'errorMessage' => 'This operation is forbidden by permission system', 'description' => ''],
],
[
['errorCode' => 'Forbidden.ResourceNotFound', 'errorMessage' => 'Resource not found', 'description' => ''],
],
409 => [
['errorCode' => 'Rejected.ResourceInDeleteWindow', 'errorMessage' => 'secret in delete peroid', 'description' => ''],
],
500 => [
['errorCode' => 'InternalFailure', 'errorMessage' => 'Internal Failure', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"SecretName\\": \\"secret001\\",\\n \\"RequestId\\": \\"8cad259f-4d77-40ec-bbd7-b9c47a423bb9\\"\\n}","type":"json"}]',
'title' => 'UpdateSecretVersionStage',
'summary' => 'Moves a version stage label to a different version of a secret.',
'description' => '- For more information about the access policy that is required to call this operation as a Resource Access Management (RAM) user or RAM role, see [Resource Access Management](~~2767210~~).'."\n"
."\n"
.'- This operation supports only generic secrets. You can perform the following operations:'."\n"
."\n"
.' - Add a version stage to a specified secret version.'."\n"
."\n"
.' - Remove a version stage from a specified secret version.'."\n"
."\n"
.' - Remove a version stage from a specified secret version and attach it to another secret version.'."\n"
."\n"
.'- The total number of version stages for each generic secret cannot exceed 8.'."\n"
."\n"
.'This topic provides an example of how to update the version stage of the secret named `secret001`. In this example, the `ACSCurrent` stage is used to mark version `002`.',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
],
'VerifyMac' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/json'],
'produces' => ['application/json'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREkmsZ5VV9Q'],
],
'parameters' => [
[
'name' => 'KeyId',
'in' => 'query',
'schema' => ['description' => 'The ID of the key. You can also specify a key alias or key Amazon Resource Name (ARN). For more information about aliases, refer to [Manage key aliases](~~480655~~).'."\n"
.'>To access a key in a different Alibaba Cloud account, you must specify the key ARN. The key ARN is in the format of `acs:kms:${region}:${account}:key/${keyid}`.', 'type' => 'string', 'required' => true, 'example' => 'key-hzz630494463ejqjx****', 'title' => ''],
],
[
'name' => 'Mac',
'in' => 'query',
'schema' => ['description' => 'The Base64-encoding message authentication code to verify.', 'type' => 'string', 'required' => true, 'example' => 'vz1Snp+jGJbgydCFRWVWxAwIMdyfKCSp+jnMWQ=='."\n", 'title' => ''],
],
[
'name' => 'Message',
'in' => 'query',
'schema' => ['description' => 'The original message data. '."\n"
."\n"
.'Use Base64 encoding. For example, if the hexadecimal content of the message for which you want to generate a message authentication code is `[0x31, 0x32, 0x33, 0x34]`, the corresponding Base64-encoded value is `MTIzNA==`.', 'type' => 'string', 'required' => true, 'example' => 'VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZy4=', 'title' => ''],
],
[
'name' => 'Algorithm',
'in' => 'query',
'schema' => ['description' => 'The algorithm used to generate the message authentication code. Valid values vary based on the key specification: '."\n"
."\n"
.'- HMAC_SM3'."\n"
."\n"
.'- HMAC_SHA_224'."\n"
."\n"
.'- HMAC_SHA_256'."\n"
."\n"
.'- HMAC_SHA_384'."\n"
."\n"
.'- HMAC_SHA_512', 'type' => 'string', 'required' => true, 'example' => 'HMAC_SHA_256', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable DryRun mode. Valid values:'."\n"
.'- true: enables DryRun mode.'."\n"
.'- false (default): disables DryRun mode.'."\n"
."\n"
.'DryRun mode is used to test API calls and verify whether you have the required permissions on the corresponding resources and whether the request parameters are correctly configured. When DryRun mode is enabled, KMS always returns a failure and provides the failure reason. Failure reasons include:'."\n"
.'- DryRunOperationError: The request would succeed if the DryRun parameter is not specified.'."\n"
.'- ValidationError: The parameters specified in the request are invalid.'."\n"
.'- AccessDeniedError: You are not authorized to perform this operation on the KMS resource.', 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8'],
'KeyId' => ['description' => 'The globally unique identifier of the customer master key (CMK).'."\n"
."\n"
.'> If the KeyId parameter in the request is set to an alias of the CMK, the CMK ID corresponding to the alias is returned in the response.', 'type' => 'string', 'example' => 'key-hzz62f1cb66fa42qo***', 'title' => ''],
'Algorithm' => ['description' => 'The algorithm used to generate the message authentication code. Valid values vary based on the key specification: '."\n"
."\n"
.'- HMAC_SM3'."\n"
."\n"
.'- HMAC_SHA_224'."\n"
."\n"
.'- HMAC_SHA_256'."\n"
."\n"
.'- HMAC_SHA_384'."\n"
."\n"
.'- HMAC_SHA_512', 'type' => 'string', 'example' => 'HMAC_SHA_256', 'title' => ''],
'Value' => ['description' => 'Indicates whether the message authentication code verification is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Verify HMAC message authentication code',
'summary' => 'Verifies the HMAC message authentication code of a specific message by using a specified key.',
'description' => 'For details about the access policy required when a RAM user or RAM role invokes this operation, refer to access control.'."\n"
."\n"
.'This operation can be invoked through a shared gateway or a dedicated gateway. For more information, refer to Alibaba Cloud SDK.'."\n"
."\n"
.'- Shared gateway: Access KMS through a public or VPC endpoint. This method requires you to enable the public network access switch. For more information, refer to accessing keys in a KMS instance over the Internet.'."\n"
.'- Dedicated gateway: Access KMS through a KMS private endpoint (<YOUR_KMS_INSTANCE_ID>.cryptoservice.kms.aliyuncs.com).',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8\\",\\n \\"KeyId\\": \\"key-hzz62f1cb66fa42qo***\\",\\n \\"Algorithm\\": \\"HMAC_SHA_256\\",\\n \\"Value\\": true\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-northeast-1.aliyuncs.com', 'endpoint' => 'kms.ap-northeast-1.aliyuncs.com', 'vpc' => 'kms-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-northeast-2.aliyuncs.com', 'endpoint' => 'kms.ap-northeast-2.aliyuncs.com', 'vpc' => 'kms-vpc.ap-northeast-2.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-southeast-1.aliyuncs.com', 'endpoint' => 'kms.ap-southeast-1.aliyuncs.com', 'vpc' => 'kms-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-southeast-2.aliyuncs.com', 'endpoint' => 'kms.ap-southeast-2.aliyuncs.com', 'vpc' => 'kms-vpc.ap-southeast-2.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-southeast-3.aliyuncs.com', 'endpoint' => 'kms.ap-southeast-3.aliyuncs.com', 'vpc' => 'kms-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-southeast-5.aliyuncs.com', 'endpoint' => 'kms.ap-southeast-5.aliyuncs.com', 'vpc' => 'kms-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-southeast-6.aliyuncs.com', 'endpoint' => 'kms.ap-southeast-6.aliyuncs.com', 'vpc' => 'kms-vpc.ap-southeast-6.aliyuncs.com'],
['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.ap-southeast-7.aliyuncs.com', 'endpoint' => 'kms.ap-southeast-7.aliyuncs.com', 'vpc' => 'kms-vpc.ap-southeast-7.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-beijing.aliyuncs.com', 'endpoint' => 'kms.cn-beijing.aliyuncs.com', 'vpc' => 'kms-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-chengdu.aliyuncs.com', 'endpoint' => 'kms.cn-chengdu.aliyuncs.com', 'vpc' => 'kms-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-fuzhou.aliyuncs.com', 'endpoint' => 'kms.cn-fuzhou.aliyuncs.com', 'vpc' => 'kms-vpc.cn-fuzhou.aliyuncs.com'],
['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-guangzhou.aliyuncs.com', 'endpoint' => 'kms.cn-guangzhou.aliyuncs.com', 'vpc' => 'kms-vpc.cn-guangzhou.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-hangzhou.aliyuncs.com', 'endpoint' => 'kms.cn-hangzhou.aliyuncs.com', 'vpc' => 'kms-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-heyuan.aliyuncs.com', 'endpoint' => 'kms.cn-heyuan.aliyuncs.com', 'vpc' => 'kms-vpc.cn-heyuan.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-hongkong.aliyuncs.com', 'endpoint' => 'kms.cn-hongkong.aliyuncs.com', 'vpc' => 'kms-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-huhehaote.aliyuncs.com', 'endpoint' => 'kms.cn-huhehaote.aliyuncs.com', 'vpc' => 'kms-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-qingdao.aliyuncs.com', 'endpoint' => 'kms.cn-qingdao.aliyuncs.com', 'vpc' => 'kms-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-shanghai.aliyuncs.com', 'endpoint' => 'kms.cn-shanghai.aliyuncs.com', 'vpc' => 'kms-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-shenzhen.aliyuncs.com', 'endpoint' => 'kms.cn-shenzhen.aliyuncs.com', 'vpc' => 'kms-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'kms.cn-wuhan-lr.aliyuncs.com', 'vpc' => 'kms-vpc.cn-wuhan-lr.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'kms.cn-wulanchabu.aliyuncs.com', 'vpc' => 'kms-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'kms.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'kms-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'kms.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'kms.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'kms-vpc.cn-zhengzhou-jva.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'kms.us-west-1.aliyuncs.com', 'endpoint' => 'kms.us-west-1.aliyuncs.com', 'vpc' => 'kms-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'kms.us-east-1.aliyuncs.com', 'endpoint' => 'kms.us-east-1.aliyuncs.com', 'vpc' => 'kms-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'na-south-1', 'regionName' => 'Mexico', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'kms.na-south-1.aliyuncs.com', 'endpoint' => 'kms.na-south-1.aliyuncs.com', 'vpc' => 'kms-vpc.na-south-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'kms.eu-west-1.aliyuncs.com', 'endpoint' => 'kms.eu-west-1.aliyuncs.com', 'vpc' => 'kms-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'kms.eu-central-1.aliyuncs.com', 'endpoint' => 'kms.eu-central-1.aliyuncs.com', 'vpc' => 'kms-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'kms.me-east-1.aliyuncs.com', 'endpoint' => 'kms.me-east-1.aliyuncs.com', 'vpc' => 'kms-vpc.me-east-1.aliyuncs.com'],
['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'kms.me-central-1.aliyuncs.com', 'endpoint' => 'kms.me-central-1.aliyuncs.com', 'vpc' => 'kms-vpc.me-central-1.aliyuncs.com'],
['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'kms.ap-south-1.aliyuncs.com', 'endpoint' => 'kms.ap-south-1.aliyuncs.com', 'vpc' => 'kms-vpc.ap-south-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'kms.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'kms.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'kms-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'kms.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'kms.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'kms-vpc.cn-shanghai-finance-1.aliyuncs.com'],
['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'kms.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'kms.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'kms-vpc.cn-heyuan-acdr-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'kms.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'kms.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'kms-vpc.cn-hangzhou-finance.aliyuncs.com'],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'kms.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'kms.cn-beijing-finance-1.aliyuncs.com', 'vpc' => 'kms-vpc.cn-beijing-finance-1.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'AliasAlreadyExists', 'message' => 'AliasName already exists.', 'http_code' => 400, 'description' => 'Alias already exists.'],
['code' => 'Certificate.ContentMismatch', 'message' => 'Content mismatch is detected in certificate %s.', 'http_code' => 403, 'description' => 'The content of the certificate does not match.'],
['code' => 'Certificate.DecryptionError', 'message' => 'Failed to decrypt data with certificate private key.', 'http_code' => 403, 'description' => 'Failed to decrypt data by using the private key of the certificate. Check whether the passed ciphertext or algorithm is valid.'],
['code' => 'Certificate.Expired', 'message' => 'The certificate has expired or is not yet valid.', 'http_code' => 400, 'description' => 'The certificate is expired or invalid.'],
['code' => 'Certificate.InvalidPrivateKey', 'message' => 'The private key decrypted is not a valid SM2 private key.', 'http_code' => 403, 'description' => 'The decrypted private key is not a valid SM2-based private key.'],
['code' => 'Certificate.InvalidSymmetricKey', 'message' => 'The symmetric key length is invalid for algorithm %s.', 'http_code' => 403, 'description' => 'The length of the decrypted symmetric key is invalid.'],
['code' => 'Certificate.IsInvalid', 'message' => 'CA certificate in the certificate chain has expired.', 'http_code' => 403, 'description' => 'An invalid certificate exists in the certificate chain.'],
['code' => 'Certificate.NotFound', 'message' => 'The specified certificate is not found.', 'http_code' => 404, 'description' => 'The specified certificate does not exist.'],
['code' => 'Certificate.ParseError', 'message' => 'Failed to parse the certificate.', 'http_code' => 403, 'description' => 'Failed to parse the certificate.'],
['code' => 'Certificate.ParseError', 'message' => 'Failed to parse the certificate. Please upload a certificate in the PEM format.', 'http_code' => 403, 'description' => 'Failed to parse the certificate. Upload a certificate in the PEM format.'],
['code' => 'Certificate.PrivateKeyMismatch', 'message' => 'The private key does not match the public key in certificate.', 'http_code' => 403, 'description' => 'The decrypted private key does not match the public key in the certificate.'],
['code' => 'Certificate.StatusError', 'message' => 'The certificate has not been activated.', 'http_code' => 404, 'description' => 'The certificate is not activated.'],
['code' => 'Certificate.UnsupportedKeySpec', 'message' => 'The key type in the certificate is not supported.', 'http_code' => 403, 'description' => 'The key type of the certificate is not supported.'],
['code' => 'Certificate.UnsupportedOperation', 'message' => 'This operation is not supported for certificates with %s %s.', 'http_code' => 403, 'description' => 'The type or protection level of the key in the certificate does not support the operation.'],
['code' => 'CreateLXOrderFailed', 'message' => 'Fail to create the order.', 'http_code' => 400, 'description' => 'Failed to create the order.'],
['code' => 'DependencyViolation.Key', 'message' => 'The dedicated key instance cannot be deleted when some keys dependent with it.', 'http_code' => 400, 'description' => 'The dedicated KSM instance failed to be deleted because keys that depend on the dedicated KMS instance exist.'],
['code' => 'Duplicate.TagKey', 'message' => 'The specified tagKey is duplicate.', 'http_code' => 400, 'description' => ''],
['code' => 'Forbidden.Access', 'message' => 'Current ip not in ip white list', 'http_code' => 403, 'description' => 'The IP address is not in the whitelist.'],
['code' => 'Forbidden.AccessKey', 'message' => null, 'http_code' => null, 'description' => 'This AccessKey is not enabled.'],
['code' => 'Forbidden.AccessKey', 'message' => 'This AccessKey is not enabled.', 'http_code' => 403, 'description' => 'The AccessKey is not enabled.'],
['code' => 'Forbidden.AliasNotFound', 'message' => 'The specified Alias is not found.', 'http_code' => 404, 'description' => 'The error message returned because the specified alias does not exist.'],
['code' => 'Forbidden.DeletionProtection', 'message' => 'The specified key is under delete protection, can not be deleted.', 'http_code' => 403, 'description' => 'Deletion protection is enabled for your key, and you cannot delete your key.'],
['code' => 'Forbidden.DependencyNotReady', 'message' => 'The dependency resource in your account is not ready. Please try again later.', 'http_code' => 403, 'description' => 'The dependent resources within the account are not ready. Try again later.'],
['code' => 'Forbidden.DKMSInstanceNotFound', 'message' => 'The specified DKMS Instance is not found.', 'http_code' => 403, 'description' => 'Your dedicated KMS instance is not found.'],
['code' => 'Forbidden.DKMSInstanceStateInvalid', 'message' => 'The DKMS instance state is invalid.', 'http_code' => 403, 'description' => 'Your dedicated KMS instance is invalid.'],
['code' => 'Forbidden.ExtendLimit', 'message' => 'The maximum number of client keys is exceeded.', 'http_code' => 403, 'description' => 'The number of client keys has reached the upper limit.'],
['code' => 'Forbidden.InDebt', 'message' => 'The user has an overdue payment.', 'http_code' => 403, 'description' => 'The current user has overdue payments.'],
['code' => 'Forbidden.InDebt', 'message' => 'Current user is indebted.', 'http_code' => 403, 'description' => 'Current user is indebted.'],
['code' => 'Forbidden.InDebtOverdue', 'message' => 'The user has an overdue payment.', 'http_code' => 403, 'description' => 'The current user has overdue payments.'],
['code' => 'Forbidden.KeyNotFound', 'message' => 'The specified Key is not found.', 'http_code' => 404, 'description' => 'The error message returned because the specified CMK does not exist.'],
['code' => 'Forbidden.KeyNotFound', 'message' => 'The specified key does not exist.', 'http_code' => 404, 'description' => 'The specified key does not exist.'],
['code' => 'Forbidden.KeyPolicyUnSupported', 'message' => 'The specified key does not support key policy.', 'http_code' => 400, 'description' => 'The specified key does not support key policies.'],
['code' => 'Forbidden.KeyVersionNotFound', 'message' => 'The specified Key version is not found.', 'http_code' => 404, 'description' => 'The specified key version cannot be found.'],
['code' => 'Forbidden.KmsServiceNotEnabled', 'message' => 'KMS has not been activated for the user. Obtain access permissions first.', 'http_code' => 403, 'description' => 'KMS is not activated for the current user. You must obtain the permissions to access KMS.'],
['code' => 'Forbidden.NoBackup', 'message' => 'this kms instance no backup, forbidden delete.', 'http_code' => 403, 'description' => 'This KMS instance has no backup and is not allowed to be deleted.'],
['code' => 'Forbidden.NoPermission', 'message' => null, 'http_code' => null, 'description' => 'This operation is forbidden by permission system.'],
['code' => 'Forbidden.NoPermission', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 403, 'description' => 'You are not authorized to perform the operation.'],
['code' => 'Forbidden.NoPermission', 'message' => 'This operation is forbidden by permission system.', 'http_code' => 400, 'description' => 'You are not authorized to perform this operation.'],
['code' => 'Forbidden.NoPermission.SLR', 'message' => 'You are not authorized to perform the action: ram:CreateServiceLinkedRole', 'http_code' => 403, 'description' => 'You are not authorized to perform the ram:CreateServiceLinkedRole operation.'],
['code' => 'Forbidden.NoRealNameAuthentication', 'message' => 'Real name authentication is needed.', 'http_code' => 400, 'description' => 'You have not passed real name authentication.'],
['code' => 'Forbidden.Opened', 'message' => 'Your kms service has been opened.', 'http_code' => 400, 'description' => 'You have activated Key Management Service.'],
['code' => 'Forbidden.ProhibitedByRiskControl', 'message' => 'Current user is prohibited by risk control.', 'http_code' => 403, 'description' => 'The current user does not have access permissions based on risk control rules.'],
['code' => 'Forbidden.ResourceNotFound', 'message' => 'The resource is not found.', 'http_code' => 404, 'description' => 'The resource does not exist.'],
['code' => 'Forbidden.ResourceNotFound', 'message' => 'Resource not found.', 'http_code' => 404, 'description' => 'The resource is not found.'],
['code' => 'Forbidden.ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 404, 'description' => 'The specified resource cannot be found.'],
['code' => 'Forbidden.ResourceNotFound', 'message' => 'Policy not found.', 'http_code' => 404, 'description' => ''],
['code' => 'Forbidden.RotateCommandIdNotFound', 'message' => 'The region does not support key rotation. Rotation commands have not be configured.', 'http_code' => 404, 'description' => 'Rotation is not supported in this region because the command is not specified.'],
['code' => 'Forbidden.UbsmsInvalidBid', 'message' => 'Your account partner does not support KMS.', 'http_code' => 403, 'description' => 'The cooperative partner of your account does not support KMS.'],
['code' => 'Forbidden.UbsmsInvalidUserid', 'message' => 'Your user ID is Invalid for UBSMS.', 'http_code' => 403, 'description' => 'Your user ID is invalid for UBSMS.'],
['code' => 'IllegalTimestamp', 'message' => 'The input parameter Timestamp that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The input parameter timestamp indicates that the request is outside the processing time range.'],
['code' => 'IllegalTimestamp', 'message' => 'The input parameter "Timestamp" that is required for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The input parameter "Timestamp" was not provided or is invalid (for example, it has expired).'],
['code' => 'IncompleteSignature', 'message' => null, 'http_code' => null, 'description' => 'The request signature does not conform to Aliyun standards.'],
['code' => 'IncompleteSignature', 'message' => 'The request signature does not conform to Alibaba Cloud standards.', 'http_code' => 400, 'description' => 'The signature does not match. Check whether the Access Key ID, Access Key secret, and signature method are valid. For more information, see Signature mechanism.'],
['code' => 'IncompleteSignature', 'message' => 'The request signature does not conform to Aliyun standards.', 'http_code' => 400, 'description' => 'The signature does not conform to standards.'],
['code' => 'InternalFailure', 'message' => null, 'http_code' => null, 'description' => 'Internal Failure.'],
['code' => 'InternalFailure', 'message' => 'Internal Failure.', 'http_code' => 500, 'description' => ''],
['code' => 'InternalFailure', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => 'An internal error occurred.'],
['code' => 'InternalFailure', 'message' => 'Internal Failure', 'http_code' => 500, 'description' => 'An internal error occurred.'],
['code' => 'InvalidAccessKeyId.NotFound', 'message' => 'The specified AccessKey ID does not exist.', 'http_code' => 404, 'description' => 'The AccessKey ID is not found.'],
['code' => 'InvalidHeader', 'message' => 'The specified header is not valid.', 'http_code' => 400, 'description' => 'The specified request header in your request is invalid.'],
['code' => 'InvalidInstance.NotFound', 'message' => 'The specified ECS instance is not found.', 'http_code' => 404, 'description' => 'The specified ECS instance is not found.'],
['code' => 'InvalidParameter', 'message' => null, 'http_code' => null, 'description' => 'Invalid parameter.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'An invalid value is specified for the parameter.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => 'An invalid value is specified for the parameter.'],
['code' => 'InvalidParameter', 'message' => 'The specified parameter RotationInterval is not valid.', 'http_code' => 400, 'description' => 'Invalid RotationInterval parameter value.'],
['code' => 'InvalidParameter.TagKey', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidParameter.TagValue', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => ''],
['code' => 'InvalidResourceId.NotFound', 'message' => 'The specified ResourceId is not found.', 'http_code' => 404, 'description' => ''],
['code' => 'MissingHeader', 'message' => 'The request header is required.', 'http_code' => 400, 'description' => 'The request header is not specified.'],
['code' => 'MissingParameter', 'message' => null, 'http_code' => null, 'description' => 'Missing parameter.'],
['code' => 'MissingParameter', 'message' => 'The parameter needed but no provided.', 'http_code' => 400, 'description' => 'The required parameters are not specified.'],
['code' => 'ParseRequestHeaderException', 'message' => 'The server cannot parse the request header.', 'http_code' => 400, 'description' => 'The server failed to parse the request header. Check the request header information.'],
['code' => 'ParseRequestParameterException', 'message' => 'The server cannot parse the request parameters.', 'http_code' => 400, 'description' => 'The server failed to parse the parameters. Check the input parameters.'],
['code' => 'ParseRequestParameterException', 'message' => 'server parse parameters exception,please check your input params.', 'http_code' => 400, 'description' => 'Failed to parse the parameter.'],
['code' => 'PrivateCA.CertificateMismatch', 'message' => 'The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.', 'http_code' => 400, 'description' => 'The certificate does not match.'],
['code' => 'PrivateCA.InvalidState', 'message' => 'The state of the private CA does not allow this action to occur.', 'http_code' => 400, 'description' => 'The status of the CA certificate does not support the current operation.'],
['code' => 'PrivateCA.MalformedCertificate', 'message' => 'One or more fields in the certificate are invalid.', 'http_code' => 400, 'description' => 'Failed to read or parse the certificate.'],
['code' => 'PrivateCA.MalformedCertificateChain', 'message' => 'One or more certificates in the certificate chain are invalid.', 'http_code' => 400, 'description' => 'Failed to read or parse the certificate chain.'],
['code' => 'PrivateCA.MalformedCSR', 'message' => 'The certificate signing request is invalid.', 'http_code' => 400, 'description' => 'Failed to read or parse the CSR file.'],
['code' => 'PrivateCA.ResourceNotFound', 'message' => 'A resource such as a private CA or certificate cannot be found.', 'http_code' => 400, 'description' => 'The specified resource cannot be found.'],
['code' => 'Rejected.AvailableVSwitchNotEnough', 'message' => 'The vSwitch does not have enough IP addresses for creating dedicated KMS instances.', 'http_code' => 400, 'description' => 'Your vSwitch does not have sufficient IP addresses to create dedicated KMS instances.'],
['code' => 'Rejected.Connecting', 'message' => 'The request was denied. The DKMS Instance is connecting to CloudHSM instance.', 'http_code' => 409, 'description' => 'The request is rejected because the dedicated KMS instance is connecting to an HSM cluster.'],
['code' => 'Rejected.Creating', 'message' => 'The request was denied. The secret is creating.', 'http_code' => 409, 'description' => 'The secret is being created.'],
['code' => 'Rejected.Disabled', 'message' => null, 'http_code' => null, 'description' => 'The specified Key is not Enable.'],
['code' => 'Rejected.Disabled', 'message' => 'The request was rejected because the key state is Disabled.', 'http_code' => 409, 'description' => 'The request was rejected because the key state is Disabled.'],
['code' => 'Rejected.DisabledAutomaticRotation', 'message' => 'The request was rejected because the secret has been disabled to rotate automatically.', 'http_code' => 403, 'description' => 'The request is rejected because invalid secrets cannot be automatically rotated.'],
['code' => 'Rejected.InvalidRequest', 'message' => 'The parameter values do not match.', 'http_code' => 400, 'description' => 'The parameters do not match.'],
['code' => 'Rejected.LimitExceeded', 'message' => null, 'http_code' => null, 'description' => 'User Key Limit Exceeded.'],
['code' => 'Rejected.LimitExceeded', 'message' => 'The secret quota is exceeded.', 'http_code' => 400, 'description' => 'You cannot create more resources.'],
['code' => 'Rejected.LimitExceeded', 'message' => 'The request was rejected because user create resource limit was exceeded', 'http_code' => 400, 'description' => 'The request is rejected because the number of created resources reaches the upper limit.'],
['code' => 'Rejected.NotInRotating', 'message' => 'The secret cannot be rotated. Access denied.', 'http_code' => 409, 'description' => 'The request is denied. Your secret cannot be rotated.'],
['code' => 'Rejected.PendingDeletion', 'message' => 'The request was rejected because the key state is PendingDeletion.', 'http_code' => 409, 'description' => 'The request was rejected because the key state is PendingDeletion.'],
['code' => 'Rejected.Replicating', 'message' => 'The request was denied. The secret is replicating.', 'http_code' => 409, 'description' => 'The request is rejected because your secret is being copied.'],
['code' => 'Rejected.ResourceConflict', 'message' => 'Please check whether the key index 1024 is available.', 'http_code' => 409, 'description' => 'Check whether the key index is valid.'],
['code' => 'Rejected.ResourceExist', 'message' => 'The request was rejected because the resource already exists.', 'http_code' => 409, 'description' => 'The resource already exists.'],
['code' => 'Rejected.ResourceExist', 'message' => 'The resource already exists.', 'http_code' => 409, 'description' => 'The resource already exists.'],
['code' => 'Rejected.ResourceInDeleteWindow', 'message' => 'The secret is planned to be deleted.', 'http_code' => 409, 'description' => 'The secret is to be deleted.'],
['code' => 'Rejected.ResourceInUse', 'message' => 'The operation failed because the secret is not in the pre-deletion state.', 'http_code' => 409, 'description' => 'You cannot call this operation because the secret is not in the pending deletion state.'],
['code' => 'Rejected.Rotating', 'message' => 'The request was denied. The secret is rotating.', 'http_code' => 403, 'description' => 'The access is denied because the secret is being rotated.'],
['code' => 'Rejected.SecretType', 'message' => 'The request was denied. The secret type does not support the action.', 'http_code' => 403, 'description' => 'The request is denied because the secret type does not support the operation.'],
['code' => 'Rejected.SecurityGroupLimitExceeded', 'message' => 'The request was rejected because user create resource limit was exceeded', 'http_code' => 400, 'description' => 'You cannot create more security groups.'],
['code' => 'Rejected.ShareQuotaExceedLimit', 'message' => 'Instance Share Quota Exceed Limit.', 'http_code' => 400, 'description' => 'The instance share quota exceeds the limit.'],
['code' => 'Rejected.StateModifiedFailed', 'message' => null, 'http_code' => null, 'description' => 'Keystate modified failed.'],
['code' => 'Rejected.StateModifiedFailed', 'message' => 'keystate modified failed', 'http_code' => 409, 'description' => 'Failed to modify the status of the key.'],
['code' => 'Rejected.Throttling', 'message' => 'The QPS upper limit is exceeded.', 'http_code' => 429, 'description' => 'The traffic reaches the upper limit.'],
['code' => 'Rejected.Throttling', 'message' => 'QPS Limit Exceeded', 'http_code' => 429, 'description' => 'The QPS reaches the upper limit.'],
['code' => 'Rejected.Unavailable', 'message' => 'The request was rejected because the key state is Unavailable.', 'http_code' => 409, 'description' => 'The request was denied because the key status is unavailable.'],
['code' => 'Rejected.UnsupportedOperation', 'message' => 'Unsupported operation.', 'http_code' => 400, 'description' => 'The operation is not supported.'],
['code' => 'Rejected.UnsupportedOperation', 'message' => 'You cannot perform an operation on the specified key.', 'http_code' => 400, 'description' => 'This API does not support operations on the key.'],
['code' => 'Rejected.VSwitchNotEnable', 'message' => 'The vSwitch is not enabled.', 'http_code' => 400, 'description' => 'The vSwitch is not enabled.'],
['code' => 'Rejected.VSwitchNotFound', 'message' => 'The vSwitch is not found.', 'http_code' => 404, 'description' => 'The vSwitch is not found.'],
['code' => 'SerivceUnvailableTemporary', 'message' => 'The service is temporarily unavailable.', 'http_code' => 503, 'description' => 'The service is temporary unavailable.'],
['code' => 'SerivceUnvailableTemporary', 'message' => 'Service Unvailable Temporary', 'http_code' => 503, 'description' => 'The service is temporarily unavailable.'],
['code' => 'Unsupported.Alias', 'message' => 'Alias is not valid for this api', 'http_code' => 400, 'description' => 'The alias is invalid.'],
['code' => 'Unsupported.NetworkTypeVerify', 'message' => 'The specified region does not support the VPC network type.', 'http_code' => 400, 'description' => 'KMS in the specified region does not support the VPC network type.'],
['code' => 'Unsupported.Origin', 'message' => 'The key origin is invalid for this API operation.', 'http_code' => 400, 'description' => 'The key origin is invalid for this API operation.'],
['code' => 'Unsupported.Origin', 'message' => 'This key origin is not valid for this api', 'http_code' => 400, 'description' => 'The key origin is not supported for this API operation.'],
['code' => 'Unsupported.ProtectionLevel', 'message' => 'This protection level is not valid for this region.', 'http_code' => 400, 'description' => 'This protection level is not supported in the region.'],
['code' => 'Unsupported.SecretType', 'message' => 'This secret type is not valid for this api.', 'http_code' => 400, 'description' => 'The specified secret type is not supported.'],
['code' => 'Unsupported.UserType', 'message' => 'RAM cannot create a service linked role for a BID account.', 'http_code' => 403, 'description' => 'RAM does not support creating service-linked roles for virtual users.'],
['code' => 'UnsupportedHTTPMethod', 'message' => null, 'http_code' => null, 'description' => 'This http method not supported.'],
['code' => 'UnsupportedHTTPMethod', 'message' => 'This http method not supported.', 'http_code' => 400, 'description' => 'The HTTP method is not supported.'],
['code' => 'UnsupportedHTTPMethod', 'message' => 'This http method is not supported.', 'http_code' => 400, 'description' => 'The HTTP method is not supported.'],
['code' => 'UnsupportedOperation', 'message' => 'This action is not supported.', 'http_code' => 400, 'description' => 'The operation is not supported.'],
['code' => 'UnsupportedOperation.NotPrimaryReplica', 'message' => 'This replica is not primary. Only the primary replica can be updated or deleted.', 'http_code' => 400, 'description' => 'This replica is not the primary replica. Only the primary replica can be updated or deleted.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ListManagedQuotas'],
],
'createdAt' => '2026-01-26T07:51:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-28T01:56:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T11:59:54.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T11:59:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T11:47:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T11:42:12.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T11:39:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstanceQuotaInfos'],
],
'createdAt' => '2025-11-27T08:32:27.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstanceQuotaInfos'],
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T08:17:00.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstanceQuotaInfos'],
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T08:15:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstanceQuotaInfos'],
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-27T07:58:43.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstanceQuotaInfos'],
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-18T03:35:59.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-18T03:28:08.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'GetKmsInstance'],
],
'createdAt' => '2025-11-18T02:37:21.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ListManagedQuotas'],
],
'createdAt' => '2025-10-27T07:26:20.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ListManagedQuotas'],
],
'createdAt' => '2025-10-27T07:26:15.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ListClientKeys'],
['description' => 'OpenAPI offline', 'api' => 'ListApplicationAccessPoints'],
],
'createdAt' => '2025-10-16T05:41:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'ListClientKeys'],
['description' => 'OpenAPI offline', 'api' => 'ListApplicationAccessPoints'],
],
'createdAt' => '2025-10-16T05:41:35.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'DescribeRegions'],
['description' => 'OpenAPI offline', 'api' => 'OpenKmsService'],
],
'createdAt' => '2025-08-21T07:47:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'OpenAPI offline', 'api' => 'DescribeRegions'],
['description' => 'OpenAPI offline', 'api' => 'OpenKmsService'],
],
'createdAt' => '2025-08-21T07:47:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'ListKeys'],
],
'createdAt' => '2025-08-21T07:38:13.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'ListKeys'],
],
'createdAt' => '2025-08-21T07:38:13.000Z',
'description' => '',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'],
],
],
];
|