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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'VpcIpam', 'version' => '2023-02-28'],
'directories' => [
[
'children' => ['RemoveIpamMembers', 'ListIpamMembers', 'AddIpamMembers'],
'type' => 'directory',
'title' => 'IPAM multi-account management',
],
[
'children' => ['OpenVpcIpamService', 'GetVpcIpamServiceStatus', 'DeleteIpam', 'UpdateIpam', 'ListIpams'],
'type' => 'directory',
'title' => 'IPAM',
],
[
'children' => ['CreateIpamScope', 'DeleteIpamScope', 'UpdateIpamScope', 'ListIpamScopes', 'ListIpamResourceCidrs'],
'type' => 'directory',
'title' => 'IPAM scope',
],
[
'children' => ['CreateIpamPool', 'DeleteIpamPool', 'UpdateIpamPool', 'ListIpamPools', 'AddIpamPoolCidr', 'DeleteIpamPoolCidr', 'ListIpamPoolCidrs', 'CreateIpamPoolAllocation', 'DeleteIpamPoolAllocation', 'UpdateIpamPoolAllocation', 'GetIpamPoolAllocation', 'ListIpamPoolAllocations', 'GetIpamPoolNextAvailableCidr'],
'type' => 'directory',
'title' => 'IPAM pool',
],
[
'children' => ['CreateIpamResourceDiscovery', 'DeleteIpamResourceDiscovery', 'UpdateIpamResourceDiscovery', 'ListIpamResourceDiscoveries', 'AssociateIpamResourceDiscovery', 'DissociateIpamResourceDiscovery', 'ListIpamResourceDiscoveryAssociations', 'ListIpamDiscoveredResource', 'ListIpamDiscoveredIpAddresses'],
'type' => 'directory',
'title' => 'Resource discovery',
],
[
'children' => ['ChangeResourceGroup', 'CreateIpam', 'ListTagResources', 'TagResources', 'UntagResources'],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddIpamMembers' => [
'summary' => 'Adds members to an IP Address Manager (IPAM).',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM hosted region.'."\n"
."\n"
.'Call the [DescribeRegions](~~36063~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. The request is checked for required parameters, request format, and service limits. Members are not added to the IPAM trusted service. If the check passes, the DryRunOperation error code is returned. If the check fails, an error is returned.'."\n"
."\n"
.'- **false** (Default): Sends a request. If the request passes the check, the members are added to the IPAM trusted service and an HTTP 2xx status code is returned.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request.'."\n"
."\n"
.'Generate a unique value from your client for each request. The ClientToken parameter supports only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the **RequestId** of the API request as the **ClientToken**. The **RequestId** may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => ' '."\n"
.'123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'Members',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MemberId' => ['description' => 'The member ID.'."\n"
."\n"
.'- **Folder ID**: The ID of the folder.'."\n"
."\n"
.'- **Account UID**: The UID of a member account in the resource directory.', 'type' => 'string', 'required' => false, 'example' => 'fd-ccccncASqa', 'title' => ''],
'MemberType' => [
'description' => 'The member type. Valid values:'."\n"
."\n"
.'- **Folder**: A folder.'."\n"
."\n"
.'- **Account**: A member account in a resource directory.',
'enumValueTitles' => ['Account' => 'A member account in a resource directory', 'Folder' => 'A folder in a resource directory'],
'type' => 'string',
'enum' => ['Account', 'Folder'],
'required' => false,
'example' => 'Folder',
'title' => '',
],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
'description' => 'The members managed by the IPAM trusted service.',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', 'title' => ''],
],
'title' => '',
'description' => 'BaseResult',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.MemberIdNotMatchMemberType', 'errorMessage' => 'The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match.', 'description' => 'The Member Id and Member Type of [%s] in the input Members do not match.'],
['errorCode' => 'OperationDenied.MemberExistInIpamRDService', 'errorMessage' => 'The operation is not allowed because %s is under the management of the IPAM.', 'description' => 'The input parameter %s has already been managed by IPAM trusted service. The same member cannot be managed repeatedly.'],
['errorCode' => 'QuotaExceeded.MemberAccount', 'errorMessage' => 'The operation is not allowed because the number of % managed by IPAM has exceeded the limit, %s/%s.', 'description' => 'The member account managed by IPAM trusted service exceeds the quota limit.'],
['errorCode' => 'OperationDenied.IpamResourceDiscoveryAlreadySharedWithAdmin', 'errorMessage' => 'The operation is not allowed because the resource discovery has been shared with the IPAM delegated administrator by %s.', 'description' => 'The IPAM Trusted Service does not allow the management of accounts that have already shared their resource discovery with the delegated administrator.'],
['errorCode' => 'OperationDenied.IpamRDServiceAlreadyEnabledInOtherRegion', 'errorMessage' => 'The operation is not allowed because the IPAM Resource Directory service is already enabled in another region.', 'description' => 'Only one IPAM instance can be selected to manage resource directory members.'],
['errorCode' => 'OperationDenied.AccountNotRDEntity', 'errorMessage' => 'The operation is not allowed because the caller does not belong to the resource directory.', 'description' => 'The caller does not belong to any resource directory and is not allowed to manage IPAM trusted service members.'],
['errorCode' => 'OperationDenied.NotDelegatedAdminAccount', 'errorMessage' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', 'description' => 'The caller is not the delegated administrator of the IPAM trusted service in the resource directory. IPAM trusted service members are not allowed to be managed.'],
['errorCode' => 'OperationDenied.IpamNotExist', 'errorMessage' => 'The operation is not allowed because the IPAM does not exist.', 'description' => 'IPAM does not exist in the current region. IPAM trusted service members cannot be managed.'],
['errorCode' => 'OperationDenied.DelegateAdminAsMember', 'errorMessage' => 'The operation is not allowed because the IPAM delegate administrator cannot be a member.', 'description' => 'IPAM delegated administrators cannot add themselves as members of the IPAM trusted service.'],
['errorCode' => 'OperationDenied.NoServicePrincipalAdminPrivileges', 'errorMessage' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', 'description' => 'The caller is not the delegated administrator of the IPAM trusted service in the resource directory. IPAM trusted service members are not allowed to be managed.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'AddIpamMembers',
'description' => '- Only the delegated administrator of an IPAM instance in a resource directory can perform multi-account management.'."\n"
."\n"
.'- An IPAM delegated administrator can use an IPAM instance in only one region for multi-account management. A maximum of 1,000 member accounts can be added.'."\n"
."\n"
.' ><notice>'."\n"
."\n"
.' If you add a folder as a member, the system counts all member accounts of the resource directory that are in the folder.'."\n"
."\n"
.' ></notice>'."\n"
."\n"
.'- Members can be of the Folder or Account type.'."\n"
."\n"
.' - Folder: The delegated IPAM administrator can view IP usage in the IPAM effective region for all resource directory member accounts in the folder.'."\n"
."\n"
.' - Account: The delegated IPAM administrator can view IP usage in the IPAM effective region for the specified resource directory member account.'."\n"
."\n"
.'- A managed member cannot share its resource discovery with the IPAM delegated administrator. The IPAM delegated administrator cannot add a member if that member has already shared its resource discovery.'."\n"
."\n"
.'- Adding the first member enables the IPAM trusted service for the resource directory.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\"\\n}","type":"json"}]',
],
'AddIpamPoolCidr' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '173978',
'abilityTreeNodes' => ['FEATUREvpcNCDGSE'],
],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM hosted region.'."\n"
."\n"
.'You can call [DescribeRegions](~~36063~~) to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'Cidr',
'in' => 'query',
'schema' => ['description' => 'The CIDR block to provision.'."\n"
."\n"
.'> Private top-level pools support provisioning only by specifying a CIDR block.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.0/24', 'title' => ''],
],
[
'name' => 'NetmaskLength',
'in' => 'query',
'schema' => ['description' => 'Provisions a CIDR block by specifying a netmask length.'."\n"
."\n"
.'> Public IPv6 top-level pools support provisioning only by specifying a netmask length.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: performs a dry run without provisioning a CIDR block for the IPAM pool. The system checks the required parameters, request format, and business limits. If the check fails, the corresponding error is returned. If the check succeeds, the error code DryRunOperation is returned.'."\n"
.'- **false** (default): sends the request. After the check succeeds, an HTTP 2xx status code is returned and the operation is performed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. A client-generated value that is unique across different requests. ClientToken supports only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId is different for each API request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '558BC336-8B88-53B0-B4AD-980EE900AB01', 'title' => ''],
'Cidr' => ['description' => 'The CIDR block that is successfully provisioned for the IPAM pool.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParam.IpVersion', 'errorMessage' => 'The specified IpVersion is illegal.', 'description' => 'Invalid IpVersion.'],
['errorCode' => 'UnsupportedFeature.PublicIpamScopeType', 'errorMessage' => 'The feature of PublicIpamScopeType is not supported.', 'description' => 'The IPAM you specified does not support the creation of public scope.'],
['errorCode' => 'IllegalParam.IpamPool', 'errorMessage' => 'The specified IPAM pool cannot be empty.', 'description' => 'The IPAM pool cannot be empty.'],
['errorCode' => 'OperationDenied.PoolRegionNotSupportAddPoolCidr', 'errorMessage' => 'The operation is not allowed because pool region does not support adding CIDR.', 'description' => 'The operation was not allowed because the operation to add CIDR could not be performed in the region.'],
['errorCode' => 'OperationDenied.CidrConflictWithTopCidrs', 'errorMessage' => 'The operation is not allowed because the input CIDR conflicts with existing top CIDRs.', 'description' => 'The operation is not allowed because the input CIDR conflicts with existing top CIDRs.'],
['errorCode' => 'OperationDenied.SourceCidrIsNull', 'errorMessage' => 'The operation is not allowed because the source CIDR is null.', 'description' => 'The parent pool does not have a CIDR block.'],
['errorCode' => 'OperationDenied.CidrNotInSourceCidr', 'errorMessage' => 'The operation is not allowed because the input CIDR is not in source CIDR.', 'description' => 'The specified CIDR block does not fall within the CIDR range of the parent pool.'],
['errorCode' => 'ResourceNotFound.SourceIpamPool', 'errorMessage' => 'The dependent source IPAM pool is not found.', 'description' => 'The dependent resource source IPAM Pool does not exist.'],
['errorCode' => 'OperationDenied.CidrConflictWithExistAllocation', 'errorMessage' => 'The operation is not allowed because the input CIDR conflicts with the existing allocation.', 'description' => 'The specified CIDR block conflicts with an existing CIDR block.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'IllegalParam.Cidr', 'errorMessage' => 'The specified CIDR is illegal.', 'description' => 'The CIDR block is invalid.'],
['errorCode' => 'QuotaExceeded.IpamCidrQuotaPerIpamPool', 'errorMessage' => 'The quota of ipamCidrQuotaPerIpamPool count is exceeded.', 'description' => 'The number of CIDR blocks in the IPAM pool exceeds the upper limit.'],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['errorCode' => 'IncorrectStatus.IpamPool', 'errorMessage' => 'The status of the IPAM pool is incorrect.', 'description' => 'The status of the IPAM pool is incorrect.'],
['errorCode' => 'MissingParam.CidrOrNetmaskLength', 'errorMessage' => 'The Cidr or NetmaskLength must be input.', 'description' => 'The Cidr or NetmaskLength must be input.'],
['errorCode' => 'Mismatch.CidrAndPoolIpVersion', 'errorMessage' => 'The ip verion of input Cidr is inconsistent with that of the input IPAM pool.', 'description' => 'The ip verion of input Cidr is inconsistent with that of the input IPAM pool.'],
['errorCode' => 'Mismatch.CidrAndNetmaskLength', 'errorMessage' => 'The mask of the input Cidr is inconsistent with the input NetmaskLength.', 'description' => 'The mask of the input Cidr is inconsistent with the input NetmaskLength.'],
['errorCode' => 'MissingParam.Cidr', 'errorMessage' => 'The Cidr must be input when adding CIDR for IPAM private top pool.', 'description' => 'The Cidr must be input when adding CIDR for IPAM private top pool.'],
['errorCode' => 'UnsupportedFeature.AddCidrForIpamPrivateIpv6Pool', 'errorMessage' => 'Adding CIDR for IPAM private IPv6 pool is not supported for this user.', 'description' => 'Adding CIDR for IPAM private IPv6 pool is not supported for this user.'],
['errorCode' => 'UnsupportedFeature.AddUlaCidrForIpamPublicIpv6Pool', 'errorMessage' => 'Adding ULA CIDR for IPAM public IPv6 pool is not supported.', 'description' => 'Adding ULA CIDR for IPAM public IPv6 pool is not supported.'],
['errorCode' => 'IllegalParam.NetmaskLength', 'errorMessage' => 'The specified NetmaskLength is illegal.', 'description' => 'The specified NetmaskLength is illegal.'],
['errorCode' => 'OperationDenied.CidrConflictWithOfficialGuaCidrs', 'errorMessage' => 'The operation is not allowed because the input CIDR conflicts with official GUA CIDRs.', 'description' => 'The operation is not allowed because the input CIDR conflicts with official GUA CIDRs.'],
['errorCode' => 'OperationDenied.CidrUnavailableInPool', 'errorMessage' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.', 'description' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.'],
['errorCode' => 'OperationDenied.AvailableCidrInsufficient', 'errorMessage' => 'The operation is not allowed because available CIDR is insufficient.', 'description' => 'The operation is not allowed because available CIDR is insufficient.'],
['errorCode' => 'OperationDenied.OfficialCidrInsufficient', 'errorMessage' => 'The operation is not allowed because the official CIDR is insufficient.', 'description' => 'The operation is not allowed because the official CIDR is insufficient.'],
['errorCode' => 'OperationDenied.OfficialCidrUnavailable', 'errorMessage' => 'The operation is not allowed because the official CIDR is unavailable.', 'description' => 'The operation is not allowed because the official CIDR is unavailable.'],
['errorCode' => 'OperationDenied.OfficialCidrTmpUnavailable', 'errorMessage' => 'The operation is not allowed because the official CIDR is temporarily unavailable.', 'description' => 'The operation is not allowed because the official CIDR is temporarily unavailable.'],
['errorCode' => 'UnsupportedFeature.AddUlaCidrForIpamPrivateIpv6Pool', 'errorMessage' => 'Adding ULA CIDR for IPAM private IPv6 pool is not supported for this user.', 'description' => ''],
['errorCode' => 'UnsupportedFeature.AddByoipCidrForIpamPrivateIpv6Pool', 'errorMessage' => 'Adding BYOIP CIDR for IPAM private IPv6 pool is not supported for this user.', 'description' => ''],
['errorCode' => 'OperationDenied.CidrMaskTooSmall', 'errorMessage' => 'The operation is not allowed because the CIDR mask length %s is smaller than the minimum allowed %s.', 'description' => 'The CIDR mask length %s is smaller than the minimum allowed value %s.'],
['errorCode' => 'OperationDenied.CidrMaskTooLarge', 'errorMessage' => 'The operation is not allowed because the CIDR mask length %s is larger than the maximum allowed %s.', 'description' => 'The CIDR mask length %s is larger than the maximum allowed value %s.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'title' => 'Provision a CIDR block for an IPAM pool',
'summary' => 'Provisions a CIDR block for an IPAM pool.',
'description' => '- Before provisioning a CIDR block, make sure that you have created an IPAM pool. You can call **CreateIpamPool** to create an IPAM pool.'."\n"
.'- If the parent pool does not have a provisioned CIDR block, the subpool does not support CIDR block provisioning.'."\n"
.'- If the parent pool has a provisioned CIDR block, the subpool can have a provisioned CIDR block, and the provisioned CIDR block must be a subset of the parent pool\'s provisioned CIDR block.'."\n"
.'- If the parent pool has a provisioned CIDR block and also has CIDR allocations, the CIDR block provisioned for the subpool must not conflict with the existing CIDR allocations.'."\n"
.'- The request to provision a CIDR block for an IPAM pool must be initiated from the IPAM hosted region.'."\n"
.'- The CIDR block provisioned for an IPAM pool must not conflict with CIDR blocks provisioned for other pools within the same scope.'."\n"
.'- The number of CIDR blocks that can be provisioned for a pool is limited. The default maximum for a public IPv6 top-level pool is 1. The default maximum for other types of pools is 50.',
'changeSet' => [
['createdAt' => '2025-05-16T06:50:59.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-04-29T06:52:08.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-04-29T06:51:34.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddIpamPoolCidr'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"558BC336-8B88-53B0-B4AD-980EE900AB01\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\"\\n}","type":"json"}]',
],
'AssociateIpamResourceDiscovery' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error.'."\n"
."\n"
.'- **false** (default): Sends the request. On success, returns a 2xx status and performs the operation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If this parameter is not specified, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is different.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamCreateModel>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E897D16A-50EB-543F-B002-C5A26AB818FF', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'ResourceNotFound.IpamResourceDiscovery', 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'OperationDenied.ResourceDiscoveryAlreadyAssociated', 'errorMessage' => 'You cannot associate the resource discovery because an association already exists.', 'description' => 'You cannot associate the resource discovery because an association already exists.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'AssociateIpamResourceDiscovery',
'summary' => 'Associates a resource discovery with an IPAM instance.',
'description' => '- You can associate a resource discovery instance with an IPAM instance only once.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssociateIpamResourceDiscovery'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E897D16A-50EB-543F-B002-C5A26AB818FF\\"\\n}","type":"json"}]',
],
'ChangeResourceGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the hosted region. Call [DescribeRegions](~~36063~~) to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource whose resource group you want to change.', 'type' => 'string', 'required' => true, 'example' => 'ipam-uq5dcfc2eqhpf4****', 'title' => ''],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the new resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-aek3ctkufaw****', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => 'The resource type. Valid values:'."\n"
."\n"
.'- Ipam: an IPAM instance'."\n"
."\n"
.'- IpamScope: an IPAM scope'."\n"
."\n"
.'- IpamPool: an IPAM pool'."\n"
."\n"
.'- IpamResourceDiscovery: an IPAM resource discovery',
'enumValueTitles' => ['Ipam' => 'Ipam', 'IpamPool' => 'IpamPool', 'IpamScope' => 'IpamScope', 'IpamResourceDiscovery' => 'IpamResourceDiscovery'],
'type' => 'string',
'required' => true,
'example' => 'Ipam',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParam.ResourceGroupId', 'errorMessage' => 'The input parameter ResourceGroupId is invalid.', 'description' => 'The parameter ResourceType is illegal.'],
['errorCode' => 'IllegalParam.ResourceType', 'errorMessage' => 'The input parameter ResourceType is invalid.', 'description' => 'Parameter ResourceType.'],
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
],
],
'title' => 'ChangeResourceGroup',
'summary' => 'Changes the resource group of an IPAM resource.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\"\\n}","type":"json"}]',
],
'CreateIpam' => [
'summary' => 'Creates an IP Address Manager (IPAM).',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM instance is hosted. You can call the [DescribeRegions](~~36063~~) operation to query the most recent region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM.'."\n"
."\n"
.'It must be 1 to 128 characters in length and cannot start with `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''],
],
[
'name' => 'OperatingRegionList',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => 'The effective regions of the IPAM.'."\n",
'type' => 'array',
'items' => ['description' => 'The effective region of the IPAM.'."\n"
."\n"
.'> You can select one or more regions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'IpamDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the IPAM.'."\n"
."\n"
.'It must be 1 to 256 characters in length. Start with a letter but cannot start with `http://` or `https://`. If you do not specify a description, the description is empty by default.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is my first Ipam', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID of the IPAM.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxazb4ph6aiy****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n"
."\n"
.'* **true**: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.'."\n"
.'* **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token used to ensure the idempotence of the request. Use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.'."\n", 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tag list.'."\n",
'type' => 'array',
'items' => [
'description' => 'The tag list.'."\n",
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key of the resource. You can specify at most 20 tag keys. It cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). It must start with a letter but cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value of the resource. You can specify up to 20 tag values. You can specify empty strings as tag values.'."\n"
."\n"
.'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamCreateModel>',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0ED8D006-F706-4D23-88ED-E11ED39DCAC0', 'title' => ''],
'IpamId' => ['description' => 'The ID of the IPAM.'."\n", 'type' => 'string', 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
'PrivateDefaultScopeId' => ['description' => 'The default private scope created by the system after the IPAM is created.'."\n", 'type' => 'string', 'example' => 'ipam-scope-8wiontzmiy6cg0****', 'title' => ''],
'PublicDefaultScopeId' => ['description' => 'The default public scope created by the system after the IPAM is created.'."\n", 'type' => 'string', 'example' => 'ipam-scope-r5c5c7bmym1brc****', 'title' => ''],
'DefaultResourceDiscoveryId' => ['description' => 'The ID of the default resource discovery instance.'."\n", 'type' => 'string', 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
'DefaultResourceDiscoveryAssociationId' => ['description' => 'The ID of the default resource discovery association.'."\n", 'type' => 'string', 'example' => 'ipam-res-disco-assoc-jt5fac8twugdbbgip****', 'title' => ''],
'ResourceDiscoveryAssociationCount' => ['description' => 'The number of discovered resources.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'UnsupportedRegion.Ipam', 'errorMessage' => 'Ipam is not supported in this region.', 'description' => 'IPAM is not supported in this region.'],
['errorCode' => 'QuotaExceeded.IpamQuotaPerRegion', 'errorMessage' => 'The quota of ipamQuotaPerRegion count is exceeded.', 'description' => 'The maximum number allowed by IPAM exceeds the limit.'],
['errorCode' => 'IllegalParam.OperatingRegion', 'errorMessage' => 'The operating region is invalid.', 'description' => 'The operating region is invalid.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationFailed.OperatingRegionsNeedIncludeIpamRegion', 'errorMessage' => 'The operating regions do not contain IPAM region.', 'description' => 'The operating regions do not contain IPAM region.'],
['errorCode' => 'UnsupportedFeature.Ipam', 'errorMessage' => 'IPAM is not supported in this region.', 'description' => 'The IPAM feature is not supported in this region.'],
['errorCode' => 'OptInRequired.Ipam', 'errorMessage' => 'You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.', 'description' => 'You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0ED8D006-F706-4D23-88ED-E11ED39DCAC0\\",\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"PrivateDefaultScopeId\\": \\"ipam-scope-8wiontzmiy6cg0****\\",\\n \\"PublicDefaultScopeId\\": \\"ipam-scope-r5c5c7bmym1brc****\\",\\n \\"DefaultResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"DefaultResourceDiscoveryAssociationId\\": \\"ipam-res-disco-assoc-jt5fac8twugdbbgip****\\",\\n \\"ResourceDiscoveryAssociationCount\\": 1\\n}","type":"json"}]',
'title' => 'CreateIpam',
'description' => '- You can create only one IPAM with each Alibaba Cloud account in each region.'."\n"
.'- Only IPv4 IP addresses can be allocated.'."\n"
."\n"
.'- When you create an IPAM instance:'."\n"
.' - If there is no custom resource discovery in the region, the system creates a default resource discovery associated with the IPAM instance.'."\n"
.' - If there is a custom resource discovery in the region, the system converts it to a default resource discovery and associates it with the IPAM instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpam'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'vpc:CreateIpam',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VpcIpam', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CreateIpamPool' => [
'summary' => 'Create an IPAM address pool.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the IPAM. You can call the [DescribeRegions](~~36063~~) API to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamScopeId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM scope.', 'type' => 'string', 'required' => true, 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
],
[
'name' => 'IpamPoolName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM address pool.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''],
],
[
'name' => 'IpamPoolDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the IPAM address pool.'."\n"
."\n"
.'The description must be 1 to 256 characters in length and must start with an uppercase or lowercase English letter or a Chinese character. It cannot start with `http://` or `https://`. If this parameter is not specified, the description is empty by default.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID of the IPAM address pool.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxazb4ph6aiy****', 'title' => ''],
],
[
'name' => 'PoolRegionId',
'in' => 'query',
'schema' => ['description' => 'The region where the IPAM address pool takes effect.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'SourceIpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the source IPAM address pool.'."\n"
."\n"
.'> If this parameter is not specified, the created address pool is a parent address pool.', 'type' => 'string', 'required' => false, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'AllocationDefaultCidrMask',
'in' => 'query',
'schema' => ['description' => 'The default CIDR mask for allocations from the IPAM address pool.'."\n"
."\n"
.'> The IPv4 CIDR mask ranges from **0** to **32** bits. The IPv6 CIDR mask ranges from **0** to **128** bits.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '28', 'title' => ''],
],
[
'name' => 'AllocationMaxCidrMask',
'in' => 'query',
'schema' => ['description' => 'The maximum CIDR mask for allocations from the IPAM address pool.'."\n"
."\n"
.'> The IPv4 CIDR mask ranges from **0** to **32** bits. The IPv6 CIDR mask ranges from **0** to **128** bits.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''],
],
[
'name' => 'AllocationMinCidrMask',
'in' => 'query',
'schema' => ['description' => 'The minimum CIDR mask for allocations from the IPAM address pool.'."\n"
."\n"
.'> The IPv4 CIDR mask ranges from **0** to **32** bits. The IPv6 CIDR mask ranges from **0** to **128** bits.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform only a dry run, without performing the actual request. Valid values:'."\n"
."\n"
.'- **true**: performs only a dry run. The system checks the request for potential issues, including missing required parameters, request format, and instance status. If the request fails the dry run, an error message is returned. If the request passes the dry run, DryRunOperation is returned.'."\n"
.'- **false** (default): performs a dry run and performs the actual request. If the request passes the dry run, an HTTP 2xx status code is returned and the operation is directly performed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotency of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => ['description' => 'The IP address protocol version. Valid values:'."\n"
."\n"
.'- **IPv4**: IPv4.'."\n"
."\n"
.'- **IPv6**: IPv6.', 'type' => 'string', 'required' => false, 'example' => 'IPv4', 'title' => ''],
],
[
'name' => 'Ipv6Isp',
'in' => 'query',
'schema' => ['description' => 'The type of IPv6 CIDR block. This parameter takes effect only for public IPv6 address pools. Valid values:'."\n"
."\n"
.'- **BGP** (default): Alibaba Cloud BGP IPv6.'."\n"
.'- **ChinaMobile**: China Mobile (single-line).'."\n"
.'- **ChinaUnicom**: China Unicom (single-line).'."\n"
.'- **ChinaTelecom**: China Telecom (single-line).'."\n"
."\n"
.'> If you are a user who has activated the single-line bandwidth whitelist, this field can be set to **ChinaTelecom** (China Telecom), **ChinaUnicom** (China Unicom), or **ChinaMobile** (China Mobile).', 'type' => 'string', 'required' => false, 'example' => 'BGP', 'title' => ''],
],
[
'name' => 'AutoImport',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the auto-import feature for the address pool.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tag list.',
'type' => 'array',
'items' => [
'description' => 'The tag information.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key of the resource. A maximum of 20 tag keys are supported. Once this value is specified, it cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length and must start with a letter or Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.'."\n"
."\n"
.'> You must specify at least one of the **ResourceId.N** and **Tag.N** (**Tag.N.Key** and **Tag.N.Value**) parameters.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value of the resource. A maximum of 20 tag values are supported. Once this value is specified, it can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n"
."\n"
.'> You must specify at least one of the **ResourceId.N** and **Tag.N** (**Tag.N.Key** and **Tag.N.Value**) parameters.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned information.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', 'title' => ''],
'IpamPoolId' => ['description' => 'The instance ID of the IPAM address pool.', 'type' => 'string', 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.IpamScope', 'errorMessage' => 'The specified resource of IPAM scope is not found.', 'description' => 'The input IPAM scope does not exist.'],
['errorCode' => 'ResourceNotFound.SourceIpamPool', 'errorMessage' => 'The dependent source IPAM pool is not found.', 'description' => 'The dependent resource source IPAM Pool does not exist.'],
['errorCode' => 'UnsupportedFeature.PublicIpamScopeType', 'errorMessage' => 'The feature of PublicIpamScopeType is not supported.', 'description' => 'The IPAM you specified does not support the creation of public scope.'],
['errorCode' => 'IllegalParam.AllocationDefaultNetmask', 'errorMessage' => 'The specified AllocationDefaultNetmask is illegal.', 'description' => 'AllocationDefaultNetmask parameter is illegal.'],
['errorCode' => 'IllegalParam.AllocationMaxNetmask', 'errorMessage' => 'The specified AllocationMaxNetmask is illegal.', 'description' => 'AllocationMaxNetmask parameter is illegal.'],
['errorCode' => 'IllegalParam.AllocationMinNetmask', 'errorMessage' => 'The specified AllocationMinNetmask is illegal.', 'description' => 'AllocationMinNetmask parameter is illegal.'],
['errorCode' => 'IllegalParam.IpVersion', 'errorMessage' => 'The specified IpVersion is illegal.', 'description' => 'Invalid IpVersion.'],
['errorCode' => 'QuotaExceeded.IpamPoolQuotaDepth', 'errorMessage' => 'The quota of IpamPoolQuotaDepth count is exceeded.', 'description' => 'Maximum number of IPAM address pool depth allowed exceeds limit'],
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'IllegalParam.PoolRegionId', 'errorMessage' => 'The specified PoolRegionId is illegal.', 'description' => 'PoolRegionId parameter is illegal.'],
['errorCode' => 'QuotaExceeded.IpamSubPoolQuotaPerIpamPool', 'errorMessage' => 'The quota of ipamSubPoolQuotaPerIpamPool count is exceeded.', 'description' => 'The number of sub-pools for the IPAM pool exceeds the limit.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'IncorrectStatus.IpamPool', 'errorMessage' => 'The status of the IPAM pool is incorrect.', 'description' => 'The status of the IPAM pool is incorrect.'],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['errorCode' => 'UnsupportedFeature.IpamPublicIpv4Pool', 'errorMessage' => 'The feature of public IPv4 pool is not supported in IPAM.', 'description' => 'The feature of public IPv4 pool is not supported in IPAM.'],
['errorCode' => 'OperationDenied.IpamPublicIpv6PoolNeedPoolRegion', 'errorMessage' => 'The public IPv6 pool cannot be created in IPAM when its pool region is empty.', 'description' => 'The public IPv6 pool cannot be created in IPAM when its pool region is empty.'],
['errorCode' => 'IllegalParam.Ipv6Isp', 'errorMessage' => 'The specified Ipv6Isp is illegal.', 'description' => 'The specified Ipv6Isp is illegal.'],
['errorCode' => 'UnsupportedFeature.Ipv6Isp', 'errorMessage' => 'The Ipv6Isp feature is not supported.', 'description' => 'The Ipv6Isp feature is not supported.'],
['errorCode' => 'UnsupportedRegion.Ipv6Isp', 'errorMessage' => 'The current region does not support this feature.', 'description' => 'The current region does not support this feature.'],
['errorCode' => 'QuotaExceeded.IpamPublicIpv6TopPoolQuotaPerRegionIsp', 'errorMessage' => 'The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.', 'description' => 'The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.'],
['errorCode' => 'Mismatch.IpamScopeAndSourceIpamPool', 'errorMessage' => 'The input source IPAM pool is not in the input IPAM scope.', 'description' => 'The input source IPAM pool is not in the input IPAM scope.'],
['errorCode' => 'Mismatch.Ipv6IspAndSourceIpamPool', 'errorMessage' => 'The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.', 'description' => 'The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.'],
['errorCode' => 'UnsupportedFeature.IpamIpv6', 'errorMessage' => 'The feature of IPv6 is not supported in this region.', 'description' => 'The feature of IPv6 is not supported in this region.'],
['errorCode' => 'Mismatch.ChildIpVersionAndParentIpVersion', 'errorMessage' => 'The ChildIpVersion and ParentIpVersion are mismatched.', 'description' => 'The ChildIpVersion and ParentIpVersion are mismatched.'],
['errorCode' => 'Mismatch.ChildPoolRegionAndParentPoolRegion', 'errorMessage' => 'The ChildPoolRegion and ParentPoolRegion are mismatched.', 'description' => 'The ChildPoolRegion and ParentPoolRegion are mismatched.'],
['errorCode' => 'Mismatch.ChildIpamScopeAndParentIpamScope', 'errorMessage' => 'The ChildIpamScope and ParentIpamScope are mismatched.', 'description' => 'The ChildIpamScope and ParentIpamScope are mismatched.'],
['errorCode' => 'Mismatch.ChildIpv6IspAndParentIpv6Isp', 'errorMessage' => 'The ChildIpv6Isp and ParentIpv6Isp are mismatched.', 'description' => 'The ChildIpv6Isp and ParentIpv6Isp are mismatched.'],
],
],
'title' => 'Create IPAM Address Pool',
'description' => '- The default maximum number of public IPv6 top-level pools per ISP type per region is 1.',
'changeSet' => [
['createdAt' => '2025-05-16T06:50:59.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-04-29T06:52:08.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-04-29T06:51:34.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamPool'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\"\\n}","type":"json"}]',
],
'CreateIpamPoolAllocation' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where you want to create the custom reserved CIDR block.'."\n"
."\n"
.'You can call [DescribeRegions](~~36063~~) to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'Cidr',
'in' => 'query',
'schema' => ['description' => 'The CIDR block to allocate from the IPAM pool.'."\n"
."\n"
.'> You must specify either the **Cidr** or **CidrMask** parameter.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.0/24', 'title' => ''],
],
[
'name' => 'CidrMask',
'in' => 'query',
'schema' => ['description' => 'The mask of the CIDR block to allocate from the IPAM pool.'."\n"
."\n"
.'> You must specify either the **Cidr** or **CidrMask** parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Sends a check request. The custom reserved CIDR block is not created. The system checks for required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the DryRunOperation error code is returned.'."\n"
."\n"
.'- **false** (default): Sends a normal request. After the request passes the check, a 2xx HTTP status code is returned and the custom reserved CIDR block is created.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Generate a value on your client to make sure that the value is unique among different requests. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the custom reserved CIDR block.'."\n"
."\n"
.'The description must be 1 to 256 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. The default value is an empty string.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationName',
'in' => 'query',
'schema' => ['description' => 'The name of the custom reserved CIDR block.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test name', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamPoolAllocationCreateModel>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2', 'title' => ''],
'IpamPoolAllocationId' => ['description' => 'The ID of the custom reserved CIDR block.', 'type' => 'string', 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
'Cidr' => ['description' => 'The allocated CIDR block.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
'SourceCidr' => ['description' => 'The source CIDR block.', 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.ResourceTypeIsNotCustom', 'errorMessage' => 'The operation is not allowed because the resource type is not Custom.', 'description' => 'The operation is not allowed because the resource type is not Custom.'],
['errorCode' => 'MissingParam.CidrOrCidrMask', 'errorMessage' => 'The CIDR or CIDR Mask must be input.', 'description' => 'The CIDR or CIDR Mask must be input.'],
['errorCode' => 'OperationDenied.IpamPoolNotInRegion', 'errorMessage' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.', 'description' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.'],
['errorCode' => 'OperationDenied.RequestRegionInvalid', 'errorMessage' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', 'description' => 'The operation is not called in the region of the pool.'],
['errorCode' => 'IllegalParam.Cidr', 'errorMessage' => 'The specified CIDR is illegal.', 'description' => 'The CIDR block is invalid.'],
['errorCode' => 'IllegalParam.CidrMask', 'errorMessage' => 'The specified CidrMask is illegal.', 'description' => 'Invalid CidrMask.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.AvailableCidrInsufficient', 'errorMessage' => 'The operation is not allowed because available CIDR is insufficient.', 'description' => 'The operation is not allowed because available CIDR is insufficient.'],
['errorCode' => 'OperationDenied.CidrInExcludeCidrs', 'errorMessage' => 'The operation is not allowed because the input CIDR is within the illegal CIDRs.', 'description' => 'The operation is not allowed because the input CIDR is within the illegal CIDRs.'],
['errorCode' => 'OperationDenied.CidrUnavailableInPool', 'errorMessage' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.', 'description' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.'],
['errorCode' => 'OperationDenied.CidrMaskTooLarge', 'errorMessage' => 'The operation is denied because the CIDR mask %s is larger than the allocationMaxNetmask %s of the pool.', 'description' => 'The operation is denied because the CIDR mask %s is larger than the allocationMaxNetmask %s of the pool.'],
['errorCode' => 'OperationDenied.CidrMaskTooSmall', 'errorMessage' => 'The operation is denied because the CIDR mask %s is less than the allocationMinNetmask %s of the pool.', 'description' => 'The operation is denied because the CIDR mask %s is less than the allocationMinNetmask %s of the pool.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'title' => 'CreateIpamPoolAllocation',
'summary' => 'Creates a custom reserved CIDR block from an IPAM pool.',
'description' => '- Before you create a custom reserved CIDR block, ensure that you have created an IPAM pool and added a CIDR block to it. You can call the **CreateIpamPool** operation to create an IPAM pool and the **AddIpamPoolCidr** operation to add a CIDR block to the pool.'."\n"
."\n"
.'- When you specify the Cidr or CidrMask parameter to create a custom reserved CIDR block, the mask must be within the range specified for the IPAM pool.'."\n"
."\n"
.'- If an IPAM pool has a region attribute, the request to create a custom reserved CIDR block must be initiated from the region where the pool is located.'."\n"
."\n"
.'- The custom reserved CIDR block must not conflict with existing CIDR block allocations in the IPAM pool.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamPoolAllocation'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE9CDAE5-341E-5D0B-AC8A-2BAC707D3EB2\\",\\n \\"IpamPoolAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.0.0/16\\"\\n}","type":"json"}]',
],
'CreateIpamResourceDiscovery' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The request region.'."\n"
."\n"
.'> The request region is the hosted region of the resource discovery instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryName',
'in' => 'query',
'schema' => ['description' => 'The name of the resource discovery.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the resource discovery.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''],
],
[
'name' => 'OperatingRegionList',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => 'The list of regions where the resource discovery is effective.',
'type' => 'array',
'items' => ['description' => 'The region where the resource discovery is effective.'."\n"
."\n"
.'> The request region must be included.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
'required' => true,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2sermdd6****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Sends a check request without creating the resource discovery instance. The system checks for required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the DryRunOperation error code is returned.'."\n"
."\n"
.'- **false** (default): Sends a normal request. After the request passes the check, an HTTP 2xx status code is returned and the resource discovery instance is created.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Generate a unique parameter value from your client. The client token supports only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length. It must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (\\_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and it cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamCreateModel>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', 'title' => ''],
'IpamResourceDiscoveryId' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParam.OperatingRegion', 'errorMessage' => 'The operating region is invalid.', 'description' => 'The operating region is invalid.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.OperatingRegionsNeedIncludeHomeRegion', 'errorMessage' => 'The operating regions do not contain home region.', 'description' => 'The operating regions do not contain home region.'],
['errorCode' => 'QuotaExceeded.IpamResourceDiscoveryQuotaPerRegion', 'errorMessage' => 'The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.', 'description' => 'The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.'],
['errorCode' => 'OperationDenied.UnexpectedType', 'errorMessage' => 'The operation is not allowed because the input type is unexpected.', 'description' => 'The operation is not allowed because the input type is unexpected.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'CreateIpamResourceDiscovery',
'summary' => 'Creates a resource discovery instance of a custom type.',
'description' => '- Each Alibaba Cloud account can have only one resource discovery instance in each region.'."\n"
."\n"
.'- This operation creates only resource discovery instances of a custom type.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamResourceDiscovery'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\",\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\"\\n}","type":"json"}]',
],
'CreateIpamScope' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM instance is hosted. Call the [DescribeRegions](~~36063~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'IpamScopeName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM scope.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IpamScopeDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the IPAM scope.'."\n"
."\n"
.'The description must be 1 to 256 characters in length and must start with a letter. It cannot start with `http://` or `https://`. The default value is an empty string.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group to which the IPAM scope belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxazb4ph6aiy****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Sends a check request but does not create the IPAM scope. The request is checked for valid AccessKeys, RAM user permissions, and required parameters. If the check fails, a corresponding error is returned. If the check passes, the `DryRunOperation` error code is returned.'."\n"
."\n"
.'- **false** (default): Sends a normal request. If the request passes the check, a 2xx HTTP status code is returned and the IPAM scope is created.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. Generate a unique value from your client. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each API request may be different.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'IpamScopeType',
'in' => 'query',
'schema' => ['description' => 'The type of the IPAM scope: **private**.'."\n"
."\n"
.'> Currently, you can create only private scopes.', 'type' => 'string', 'required' => false, 'example' => 'private', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key of the resource. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length. It must start with a letter and can contain digits, periods (.), underscores (\\_), and hyphens (-). The tag key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamScopeCreateModel>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E897D16A-50EB-543F-B002-C5A26AB818FF', 'title' => ''],
'IpamScopeId' => ['description' => 'The ID of the IPAM scope.', 'type' => 'string', 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'UnsupportedFeature.PublicIpamScopeType', 'errorMessage' => 'The feature of PublicIpamScopeType is not supported.', 'description' => 'The IPAM you specified does not support the creation of public scope.'],
['errorCode' => 'QuotaExceeded.IpamScopeQuotaPerIpam', 'errorMessage' => 'The quota of ipamScopeQuotaPerIpam count is exceeded.', 'description' => 'The maximum number allowed for the IPAM scope of action exceeds the limit.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
],
],
'title' => 'CreateIpamScope',
'summary' => 'Creates scopes for IPAM to manage private and public IP addresses.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamScope'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E897D16A-50EB-543F-B002-C5A26AB818FF\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\"\\n}","type":"json"}]',
],
'DeleteIpam' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM instance is deployed. You can call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error.'."\n"
."\n"
.'- **false** (default): Sends the request. On success, returns a 2xx status and the IPAM instance is deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID of each API request is unique.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '30A20EE2-6223-5D0F-BF49-D7C78F206063', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'OperationFailed.IpamScopeExist', 'errorMessage' => 'The operation is failed because user IPAM scope exist.', 'description' => 'The operation failed because a user-defined scope exists.'],
['errorCode' => 'OperationFailed.IpamPoolExist', 'errorMessage' => 'The operation is failed because user IPAM pool exist.', 'description' => 'The operation failed because IPAM has a user-created address pool.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.SharedResourceDiscoveryAssociated', 'errorMessage' => 'The operation is not allowed because the IPAM is associated with a shared resource discovery.', 'description' => 'The operation is not allowed because the IPAM is associated with a shared resource discovery.'],
['errorCode' => 'DependencyViolation.ShareResource', 'errorMessage' => 'The operation is not allowed because the default resource discovery of this IPAM is sharing.', 'description' => 'The operation is not allowed because the default resource discovery of this IPAM is sharing.'],
['errorCode' => 'DependencyViolation.IpamMembers', 'errorMessage' => 'The IPAM [%s] has managed members [%s], so the IPAM cannot be deleted.', 'description' => 'IPAM[%s] has managed member [%s], this IPAM cannot be deleted.'],
],
],
'title' => 'DeleteIpam',
'summary' => 'Deletes an IPAM instance.',
'description' => '## Prerequisites'."\n"
."\n"
.'- Before you delete an IPAM instance, ensure that all IPAM pools in the instance are deleted. You can call the **DeleteIpamPool** operation to delete the IPAM pools.'."\n"
."\n"
.'- Before you delete an IPAM instance, ensure that all custom IPAM scopes in the instance are deleted. You can call the **DeleteIpamScope** operation to delete the IPAM scopes.'."\n"
."\n"
.'- Before you delete an IPAM instance, ensure that the default resource discovery instance is not shared.'."\n"
."\n"
.'- Before you delete an IPAM instance, ensure that no shared resource discovery instances are associated with the IPAM instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpam'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'vpc:DeleteIpam',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VpcIpam', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"30A20EE2-6223-5D0F-BF49-D7C78F206063\\"\\n}","type":"json"}]',
],
'DeleteIpamPool' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the IPAM managed region. You can call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: performs a dry run without actually deleting the IPAM pool instance. The system checks whether the required parameters are specified, the request format is valid, and the instance status is correct. If the check fails, the corresponding error is returned. If the check succeeds, DryRunOperation is returned.'."\n"
.'- **false** (default): sends a normal request. After the request passes the check, an HTTP 2xx status code is returned and the operation is directly performed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that the value is unique among different requests. The ClientToken value can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned information list.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '57B7DCCA-F192-5528-8AF3-2FE1413228C9', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.PoolRegionNotSupportDeletePool', 'errorMessage' => 'The operation is not allowed because of pool region not support delete.', 'description' => 'The operation was denied because the delete address pool operation could not be performed in the domain.'],
['errorCode' => 'DependencyViolation.SubCidr', 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', 'description' => 'The specified resource is dependent on other resources and the current operation is not allowed.'],
['errorCode' => 'DependencyViolation.CustomCidrs', 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', 'description' => 'The specified resource is dependent on other resources and the current operation is not allowed.'],
['errorCode' => 'Forbidden.SubPool', 'errorMessage' => 'The IPAM pool contains subpools.', 'description' => 'The IPAM address pool contains subpools and cannot be deleted.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['errorCode' => 'IncorrectStatus.IpamPool', 'errorMessage' => 'The status of the IPAM pool is incorrect.', 'description' => 'The status of the IPAM pool is incorrect.'],
['errorCode' => 'DependencyViolation.ShareResource', 'errorMessage' => 'The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.', 'description' => 'The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.'],
['errorCode' => 'DependencyViolation.PoolCidr', 'errorMessage' => 'The operation is not allowed because the IpamPool has pool CIDR dependency %s.', 'description' => 'The IpamPool cannot be deleted because it has pool CIDR dependency %s.'],
['errorCode' => 'OperationDenied.IpamPoolAllocationExist', 'errorMessage' => 'The operation is not allowed because the IpamPool has existing allocations.', 'description' => 'The IpamPool cannot be deleted because it has existing allocations.'],
['errorCode' => 'DependencyViolation.CustomPoolAllocation', 'errorMessage' => 'The operation is not allowed because the IpamPool has custom pool allocation dependency.', 'description' => 'The IpamPool cannot be deleted because it has custom pool allocation dependency.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'title' => 'Delete an IPAM pool instance',
'summary' => 'Deletes an IPAM pool instance.',
'description' => '### Usage notes'."\n"
."\n"
.'- Before deleting a parent pool, make sure that all subpools under the parent pool have been deleted.'."\n"
.'- When a parent pool has an effective region configured and has addresses that have already been allocated, the parent pool cannot be deleted.'."\n"
.'- When a subpool has an effective region configured and has addresses that have already been allocated, the subpool cannot be deleted.'."\n"
."\n"
.'- When a pool has a sharing relationship, the pool cannot be deleted.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamPool'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"57B7DCCA-F192-5528-8AF3-2FE1413228C9\\"\\n}","type":"json"}]',
],
'DeleteIpamPoolAllocation' => [
'summary' => 'Releases a CIDR allocation from an IP Address Management (IPAM) address pool. Supported allocation types include virtual private cloud (VPC) and custom allocation.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the CIDR block allocation that you want to release is located.'."\n"
."\n"
.'You can call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CIDR block allocation that you want to release.', 'type' => 'string', 'required' => true, 'example' => 'ipam-alloc-c4vhvr3b22mmc6****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: performs a dry run. The system checks the required parameters, request format, and service limits. The CIDR block allocation is not released. If the check fails, an error message is returned. If the check succeeds, the \\`DryRunOperation\\` error code is returned.'."\n"
."\n"
.'- **false** (default): sends a normal request. If the request passes the check, a 2xx HTTP status code is returned and the CIDR block allocation is released.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId is unique for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B90776C8-F703-51D5-893A-AD1CA699D535', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.ResourceTypeIsNotCustom', 'errorMessage' => 'The operation is not allowed because the resource type is not Custom.', 'description' => 'The operation is not allowed because the resource type is not Custom.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'ResourceNotFound.IpamPoolAllocation', 'errorMessage' => 'The specified resource of IPAM pool allocation is not found.', 'description' => 'The specified allocation does not exist.'],
['errorCode' => 'OperationDenied.UnexpectedResourceType', 'errorMessage' => 'The operation is not allowed because the resource type is unexpected.', 'description' => 'The operation is not allowed because the resource type is unexpected.'],
['errorCode' => 'OperationDenied.Unauthorized', 'errorMessage' => 'The operation is denied because the user is not authorized.', 'description' => 'The operation is denied because the user is not authorized.'],
['errorCode' => 'OperationDenied.RequestRegionInvalid', 'errorMessage' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', 'description' => 'The operation is not called in the region of the pool.'],
['errorCode' => 'OperationDenied.Ipv6VpcNotSupport', 'errorMessage' => 'The allocation of IPv6 VPC is not supported to delete.', 'description' => 'The allocation of IPv6 VPC is not supported to delete.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B90776C8-F703-51D5-893A-AD1CA699D535\\"\\n}","type":"json"}]',
'title' => 'DeleteIpamPoolAllocation',
'changeSet' => [
['createdAt' => '2025-05-16T06:50:59.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamPoolAllocation'],
],
],
'ramActions' => [],
],
'DeleteIpamPoolCidr' => [
'summary' => 'Deletes a provisioned CIDR block from an IP Address Manager (IPAM) pool.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM is hosted.'."\n"
."\n"
.'For more information, see [DescribeRegions](~~36063~~).', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'Cidr',
'in' => 'query',
'schema' => ['description' => 'The provisioned CIDR block to delete.'."\n"
."\n"
.'> Only IPv4 CIDR blocks are supported.', 'type' => 'string', 'required' => true, 'example' => '192.168.1.0/24', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error.'."\n"
."\n"
.'- **false** (default): Sends the request. On success, returns a 2xx status and performs the operation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID can differ for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'BaseResult',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F28A239E-F88D-500E-ADE7-FA5E8CA3A170', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.IpamPoolCidr', 'errorMessage' => 'The specified resource of IPAM pool CIDR is not found.', 'description' => 'The CIDR block of the IPAM pool does not exist.'],
['errorCode' => 'OperationDenied.PoolRegionNotSupportDeletePoolCidr', 'errorMessage' => 'The operation is not allowed because pool region does not support deleting cidr.', 'description' => 'You cannot delete CIDR blocks in this region.'],
['errorCode' => 'OperationDenied.IpamPoolAllocationExist', 'errorMessage' => 'The operation is not allowed because of the existence of IPAM pool allocation.', 'description' => 'The operation is not allowed because an allocation exists.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['errorCode' => 'IncorrectStatus.IpamPool', 'errorMessage' => 'The status of the IPAM pool is incorrect.', 'description' => 'The status of the IPAM pool is incorrect.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F28A239E-F88D-500E-ADE7-FA5E8CA3A170\\"\\n}","type":"json"}]',
'title' => 'DeleteIpamPoolCidr',
'description' => '- If CIDR blocks are provisioned in both a parent pool and its sub-pools, delete the CIDR blocks from the sub-pools before you delete the CIDR block from the parent pool.'."\n"
."\n"
.'- If a CIDR block is provisioned only in a parent pool, you can delete the CIDR block directly from the parent pool.'."\n"
."\n"
.'- If allocations exist from the provisioned CIDR block, delete the allocations before you delete the CIDR block.'."\n"
."\n"
.'- Requests to delete a provisioned CIDR block from an IPAM pool must be sent from the region where the IPAM is deployed.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamPoolCidr'],
],
],
'ramActions' => [],
],
'DeleteIpamResourceDiscovery' => [
'summary' => 'Deletes a resource discovery instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error.'."\n"
."\n"
.'- **false** (default): Sends the request. On success, returns a 2xx status and performs the operation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the request ID as the client token. The request ID is unique for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamCreateModel>',
'description' => 'The data returned.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9F8315CB-560E-5F1E-B069-6E44B440CAF8', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['errorCode' => 'ResourceNotFound.IpamResourceDiscovery', 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
['errorCode' => 'OperationDenied.UnexpectedType', 'errorMessage' => 'The operation is not allowed because the input type is unexpected.', 'description' => 'The operation is not allowed because the input type is unexpected.'],
['errorCode' => 'DependencyViolation.ShareResource', 'errorMessage' => 'The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.', 'description' => 'The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DeleteIpamResourceDiscovery',
'description' => '- A resource discovery instance cannot be deleted if it is shared.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamResourceDiscovery'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F8315CB-560E-5F1E-B069-6E44B440CAF8\\"\\n}","type":"json"}]',
],
'DeleteIpamScope' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM is hosted. Call the [DescribeRegions](~~36063~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamScopeId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM scope.', 'type' => 'string', 'required' => true, 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: performs a dry run. The system checks whether the required parameters are specified, the request format is valid, and the service limits are met. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned.'."\n"
."\n"
.'- **false** (default): sends the request. If the request passes the check, an HTTP 2xx status code is returned and the IPAM scope is deleted.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Generate a value for this parameter on your client to make sure that the value is unique among different requests. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is different.', 'type' => 'string', 'required' => false, 'example' => '88144bdb-b190-4813-a3f5-66cc86694162', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9F8315CB-560E-5F1E-B069-6E44B440CAF8', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.IpamScope', 'errorMessage' => 'The specified resource of IPAM scope is not found.', 'description' => 'The input IPAM scope does not exist.'],
['errorCode' => 'IncorrectStatus.IpamScope', 'errorMessage' => 'The status of the IPAM scope is incorrect.', 'description' => 'The status of the IPAM scope is incorrect.'],
['errorCode' => 'OperationDenied.DeleteDefaultScope', 'errorMessage' => 'The operation is not allowed because of deleting default scope.', 'description' => 'The operation was denied because the default IPAM scope was deleted.'],
['errorCode' => 'OperationFailed.IpamPoolExist', 'errorMessage' => 'The operation is failed because user IPAM pool exist.', 'description' => 'The operation failed because IPAM has a user-created address pool.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
],
],
'title' => 'DeleteIpamScope',
'summary' => 'Deletes an IPAM scope.',
'description' => '### Usage notes'."\n"
."\n"
.'- You cannot delete the two default IPAM scopes that the system automatically creates.'."\n"
."\n"
.'- Before you delete a custom IPAM scope, ensure that all IPAM pools in the scope are deleted. You can call the **DeleteIpamPool** operation to delete an IPAM pool.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamScope'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9F8315CB-560E-5F1E-B069-6E44B440CAF8\\"\\n}","type":"json"}]',
],
'DissociateIpamResourceDiscovery' => [
'summary' => 'Disassociates a resource discovery from an IP Address Manager (IPAM) instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM.', 'type' => 'string', 'required' => true, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the resource discovery.', 'type' => 'string', 'required' => true, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error.'."\n"
."\n"
.'- **false** (default): Sends the request. On success, returns a 2xx status and disassociates the resource discovery from the IPAM instance. On failure, returns an error.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamCreateModel>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '86137597-443F-5B66-B9B6-8514E0C50B8F', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'ResourceNotFound.IpamResourceDiscovery', 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'ResourceNotFound.ResourceDiscoveryAssociation', 'errorMessage' => 'You cannot disassociate from the resource discovery because no association exists.', 'description' => 'You cannot disassociate from the resource discovery because no association exists.'],
['errorCode' => 'OperationDenied.DissociateSelfSystemIpamResourceDiscovery', 'errorMessage' => 'The operation is not allowed because the default resource discovery cannot be disassociated.', 'description' => 'The operation is not allowed because the default resource discovery cannot be disassociated.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DissociateIpamResourceDiscovery',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DissociateIpamResourceDiscovery'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86137597-443F-5B66-B9B6-8514E0C50B8F\\"\\n}","type":"json"}]',
],
'GetIpamPoolAllocation' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region of the IPAM pool to which the CIDR block allocation belongs.'."\n"
."\n"
.'> If the IPAM pool has a region attribute, this parameter specifies the region of the IPAM pool. If the IPAM pool does not have a region attribute, this parameter specifies the managed region of IPAM.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM pool allocation.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamPoolAllocModel>',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3748DEFF-68BE-5EED-9937-7C1D0C21BAB4'],
'IpamPoolAllocationId' => ['description' => 'The ID of the IPAM pool allocation.', 'type' => 'string', 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
'Cidr' => ['description' => 'The allocated CIDR block.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
'SourceCidr' => ['description' => 'The source CIDR block.', 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''],
'ResourceId' => ['description' => 'The ID of the resource to which the CIDR block is allocated.', 'type' => 'string', 'example' => 'vpc-bp16qjewdsunr41m1****', 'title' => ''],
'ResourceType' => ['description' => 'The type of the resource to which the CIDR block is allocated. Valid values:'."\n"
."\n"
.'- **VPC**: The resource is a VPC.'."\n"
."\n"
.'- **IpamPool**: The resource is a sub-pool.'."\n"
."\n"
.'- **Custom**: The resource is a custom reserved CIDR block.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'ResourceRegionId' => ['description' => 'The ID of the region where the resource is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceOwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the resource belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1616080591216318', 'title' => ''],
'RegionId' => ['description' => 'The region of the IPAM pool to which the CIDR block allocation belongs.'."\n"
."\n"
.'> If the IPAM pool has a region attribute, this parameter specifies the region of the IPAM pool. If the IPAM pool does not have a region attribute, this parameter specifies the managed region of IPAM.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'IpamPoolId' => ['description' => 'The ID of the IPAM pool.', 'type' => 'string', 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
'Status' => ['description' => 'The status of the allocation. Valid values:'."\n"
."\n"
.'- **Created**'."\n"
."\n"
.'- **Deleted**', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'CreationTime' => ['description' => 'The time when the allocation was created.', 'type' => 'string', 'example' => '2024-10-15T10:24:19+08:00', 'title' => ''],
'IpamPoolAllocationDescription' => ['description' => 'The description of the IPAM pool allocation.'."\n"
."\n"
.'The description must be 1 to 256 characters long. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. If you do not specify this parameter, the description is empty.', 'type' => 'string', 'example' => 'ipam pool allocation description', 'title' => ''],
'IpamPoolAllocationName' => ['description' => 'The name of the IPAM pool allocation.'."\n"
."\n"
.'The name must be 1 to 128 characters long and cannot start with `http://` or `https://`.', 'type' => 'string', 'example' => 'ipam pool allocation name', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.IpamPoolAllocation', 'errorMessage' => 'The specified resource of IPAM pool allocation is not found.', 'description' => 'The specified allocation does not exist.'],
['errorCode' => 'OperationDenied.IpamRegionNotSupportGetPoolAllocation', 'errorMessage' => 'The operation is not allowed because IPAM region does not support getting the allocation.', 'description' => 'The operation is not allowed because IPAM region does not support getting the allocation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetIpamPoolAllocation',
'summary' => 'Queries a specified CIDR block allocation in an IPAM pool.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetIpamPoolAllocation'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3748DEFF-68BE-5EED-9937-7C1D0C21BAB4\\",\\n \\"IpamPoolAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.0.0/16\\",\\n \\"ResourceId\\": \\"vpc-bp16qjewdsunr41m1****\\",\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceOwnerId\\": 1616080591216318,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"Status\\": \\"Created\\",\\n \\"CreationTime\\": \\"2024-10-15T10:24:19+08:00\\",\\n \\"IpamPoolAllocationDescription\\": \\"ipam pool allocation description\\",\\n \\"IpamPoolAllocationName\\": \\"ipam pool allocation name\\"\\n}","type":"json"}]',
],
'GetIpamPoolNextAvailableCidr' => [
'summary' => 'Retrieves an available CIDR block from an IPAM pool.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region of the IPAM pool.'."\n"
."\n"
.'> If the IPAM pool has a region property, this parameter specifies the region where the pool is active. If the IPAM pool does not have a region property, this parameter specifies the managed region of IPAM.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ipam-pool-6rcq3tobayc20t****'],
],
[
'name' => 'CidrBlock',
'in' => 'query',
'schema' => ['description' => 'The CIDR block to be allocated.'."\n"
."\n"
.'> You must specify CidrBlock or CidrMask.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '172.68.0.0/26'],
],
[
'name' => 'CidrMask',
'in' => 'query',
'schema' => ['description' => 'The mask length of the CIDR block to be allocated.'."\n"
."\n"
.'> You must specify CidrBlock or CidrMask.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '26'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. The ClientToken value can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId of each request is unique.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '123e4567-e89b-12d3-a456-426655440000'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamPoolAllocModel>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82'],
'CidrBlock' => ['description' => 'The available CIDR block.', 'type' => 'string', 'title' => '', 'example' => '172.68.0.0/26'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParam.CidrOrCidrMask', 'errorMessage' => 'The CIDR or CIDR Mask must be input.', 'description' => 'The CIDR or CIDR Mask must be input.'],
['errorCode' => 'ResourceNotEnough.IpamPoolCidr', 'errorMessage' => 'The specified resource of IPAM pool CIDR is not enough.', 'description' => 'The specified resource of IPAM pool CIDR is not enough.'],
['errorCode' => 'OperationDenied.IpamRegionNotSupportGetPoolAvailableCidr', 'errorMessage' => 'The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.', 'description' => 'The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.'],
['errorCode' => 'IllegalParam.Cidr', 'errorMessage' => 'The specified CIDR is illegal.', 'description' => 'The CIDR block is invalid.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetIpamPoolNextAvailableCidr',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetIpamPoolNextAvailableCidr'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'vpc:GetIpamPoolNextAvailableCidr',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VpcIpam', 'resourceType' => 'IpamPool', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"29FC6758-9B7C-5CC7-8CBF-4DD846FE7D82\\",\\n \\"CidrBlock\\": \\"172.68.0.0/26\\"\\n}","type":"json"}]',
],
'GetVpcIpamServiceStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the **RequestId** of the request as the **ClientToken**. The **RequestId** may be different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the managed region of IPAM.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2FEE9FFF-57EE-5832-BE88-9308352F3B68', 'title' => ''],
'Enabled' => ['description' => 'Indicates whether the IPAM service is enabled.'."\n"
."\n"
.'- **true**: The service is enabled.'."\n"
."\n"
.'- **false**: The service is not enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetVpcIpamServiceStatus',
'summary' => 'Retrieves the status of the IPAM service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetVpcIpamServiceStatus'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FEE9FFF-57EE-5832-BE88-9308352F3B68\\",\\n \\"Enabled\\": true\\n}","type":"json"}]',
],
'ListIpamDiscoveredIpAddresses' => [
'summary' => 'Lists the IP addresses used by discovered resources in a VPC or vSwitch.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the resource discovery instance is hosted.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The ID of a discovered VPC.'."\n"
."\n"
.'> You must specify at least one of VpcId and VSwitchId.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1fjfnrg3av6zb9e****', 'title' => ''],
],
[
'name' => 'VSwitchId',
'in' => 'query',
'schema' => ['description' => 'The ID of a discovered VSwitch.'."\n"
."\n"
.'> You must specify at least one of VpcId and VSwitchId.', 'type' => 'string', 'required' => false, 'example' => 'vsw-bp1bmwg5u07e1l3q0is4w', 'title' => ''],
],
[
'name' => 'Cidr',
'in' => 'query',
'schema' => ['description' => 'The CIDR block to search for used IP addresses in a VPC or vSwitch. To query a specific IP address, use a /32 prefix length.'."\n"
."\n"
.'> Only IPv4 CIDR blocks are supported.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.0/24', 'title' => ''],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => [
'description' => 'The IP protocol version. Valid value:'."\n"
."\n"
.'- **IPv4**',
'enumValueTitles' => ['IPv4' => ''],
'type' => 'string',
'enum' => ['IPv4'],
'required' => false,
'example' => 'IPv4',
'title' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token used to retrieve the next page of results. Valid values:'."\n"
."\n"
.'- Do not specify this parameter for your first request.'."\n"
."\n"
.'- If a next page exists, set this parameter to the value of **NextToken** returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 200. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'default' => '100', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'IpamDiscoveredIpAddresses' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp1fjfnrg3av6zb9e****', 'title' => ''],
'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1bmwg5u07e1l3q0is4w', 'title' => ''],
'IpVersion' => ['description' => 'The IP version. Valid value:'."\n"
."\n"
.'- **IPv4**: Indicates the IPv4 protocol.', 'type' => 'string', 'example' => 'IPv4', 'title' => ''],
'IpAddress' => ['description' => 'The IP address in use.', 'type' => 'string', 'example' => '192.168.10.40/32', 'title' => ''],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'eni-bp1001jpjhzmgc5m****', 'title' => ''],
'ResourceRegionId' => ['description' => 'The ID of the region in which the resource resides.', 'type' => 'string', 'example' => 'cn-shenzhen', 'title' => ''],
'ResourceServiceType' => ['description' => 'The cloud service to which the resource belongs.', 'type' => 'string', 'example' => 'ENI', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'Details of the used IP addresses.',
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The pagination token. Use this token in a subsequent request to retrieve the next page of results. Valid values:'."\n"
."\n"
.'- Empty: All results have been returned.'."\n"
."\n"
.'- If **NextToken** has a value, it is the token for the next page of results.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 200. Default value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9F8315CB-560E-5F1E-B069-6E44B440CAF8', 'title' => ''],
],
'title' => '',
'description' => 'The response object.',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.IpamResourceDiscovery', 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
['errorCode' => 'MissingParam.IpamResourceDiscoveryId', 'errorMessage' => 'The IpamResourceDiscoveryId must be input.', 'description' => 'The IpamResourceDiscoveryId must be input.'],
['errorCode' => 'Forbidden.IpResourceAccess', 'errorMessage' => 'The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s.', 'description' => 'The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s.'],
['errorCode' => 'IllegalParamFormat.%s', 'errorMessage' => 'The param of %s is illegal.', 'description' => 'The param of %s is illegal.'],
['errorCode' => 'ResourceNotFound.IpamDiscoveredResource', 'errorMessage' => 'The queried %s is not found among IPAM discovered resources.', 'description' => 'The queried %s is not found among IPAM discovered resources.'],
['errorCode' => 'Mismatch.VpcIdAndVSwitchId', 'errorMessage' => 'VpcId and VSwitchId do not match.', 'description' => 'VpcId and VSwitchId do not match.'],
['errorCode' => 'MissingParam.VpcIdAndVSwitchId', 'errorMessage' => 'VpcId and VSwitchId cannot both be empty please provide at least one.', 'description' => 'VpcId and VSwitchId cannot both be empty please provide at least one.'],
['errorCode' => 'Mismatch.IpamResourceDiscoveryAndResource', 'errorMessage' => 'The IPAM resource discovery %s and the queried %s do not match.', 'description' => 'The IPAM resource discovery %s and the queried %s do not match.'],
['errorCode' => 'ResourceNotFound.IpamDiscoveredResource.Vpc', 'errorMessage' => 'The queried VPC %s is not found among IPAM discovered resources.', 'description' => 'The queried VPC %s is not found among IPAM discovered resources.'],
['errorCode' => 'ResourceNotFound.IpamDiscoveredResource.VSwitch', 'errorMessage' => 'The queried VSwitch %s is not found among IPAM discovered resources.', 'description' => 'The queried VSwitch %s is not found among IPAM discovered resources.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListIpamDiscoveredIpAddresses',
'description' => 'Supported query combinations:'."\n"
."\n"
.'- `VpcId` only'."\n"
."\n"
.'- `VSwitchId` only'."\n"
."\n"
.'- `VpcId` + `VSwitchId`'."\n"
."\n"
.'- `VpcId` + `CidrBlock`'."\n"
."\n"
.'- `VSwitchId` + `CidrBlock`'."\n"
."\n"
.'- `VpcId` + `VSwitchId` + `CidrBlock`',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamDiscoveredIpAddresses\\": [\\n {\\n \\"VpcId\\": \\"vpc-bp1fjfnrg3av6zb9e****\\",\\n \\"VSwitchId\\": \\"vsw-bp1bmwg5u07e1l3q0is4w\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"IpAddress\\": \\"192.168.10.40/32\\",\\n \\"ResourceId\\": \\"eni-bp1001jpjhzmgc5m****\\",\\n \\"ResourceRegionId\\": \\"cn-shenzhen\\",\\n \\"ResourceServiceType\\": \\"ENI\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 100,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"9F8315CB-560E-5F1E-B069-6E44B440CAF8\\"\\n}","type":"json"}]',
],
'ListIpamDiscoveredResource' => [
'summary' => 'Queries resource information under a resource discovery.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The hosted region ID of the resource discovery instance.'."\n"
."\n"
.'You can call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The resource discovery instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'ResourceRegionId',
'in' => 'query',
'schema' => ['description' => 'The operating region of the resource discovery.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- **VPC**: VPC.'."\n"
."\n"
.'- **VSwitch**: vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token. Valid values:'."\n"
."\n"
.'- If this is the first query or no subsequent query exists, leave this parameter empty.'."\n"
.'- If a subsequent query exists, set this parameter to the **NextToken** value returned in the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned information list.',
'type' => 'object',
'properties' => [
'IpamDiscoveredResources' => [
'description' => 'The resources.',
'type' => 'array',
'items' => [
'description' => 'The resources.',
'type' => 'object',
'properties' => [
'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '132193271328****', 'title' => ''],
'ResourceType' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- **VPC**: VPC.'."\n"
."\n"
.'- **VSwitch**: vSwitch.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'vpc-uf611fp465c7dyb4z****', 'title' => ''],
'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => ''],
'ResourceOwnerId' => ['description' => 'The Alibaba Cloud account ID of the resource ownership.', 'type' => 'integer', 'format' => 'int64', 'example' => '132193271328****', 'title' => ''],
'ResourceRegionId' => ['description' => 'The region ID of the resource ownership.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'Cidr' => ['description' => 'The CIDR block of the resource.', 'type' => 'string', 'example' => '192.168.1.0/32', 'title' => ''],
'IpUsage' => ['description' => 'The IP utilization rate, in decimal format.', 'type' => 'string', 'example' => '0', 'title' => ''],
'IpCountDetail' => [
'description' => 'The details of the resource IP address count.',
'type' => 'object',
'properties' => [
'FreeIpCount' => ['description' => 'The number of available IP addresses.', 'type' => 'string', 'title' => '', 'example' => ''],
'TotalIpCount' => ['description' => 'The total number of IP addresses.', 'type' => 'string', 'title' => '', 'example' => ''],
'UsedIpCount' => ['description' => 'The number of allocated IP addresses.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
'IpamResourceDiscoveryId' => ['description' => 'The resource discovery instance ID.', 'type' => 'string', 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
'VpcId' => ['description' => 'The instance ID of the VPC-connected instance to which the resource belongs.', 'type' => 'string', 'example' => 'vpc-uf611fp465c7dyb4z****', 'title' => ''],
'DiscoveryTime' => ['description' => 'The time when the resource was discovered.'."\n"
."\n"
.'> If the resource has not been modified since it was created, the discovery time remains unchanged.', 'type' => 'string', 'example' => '2024-01-01 00:00:00', 'title' => ''],
'SourceCidr' => ['description' => 'The source CIDR block.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The pagination token. Valid values:'."\n"
.'- If **NextToken** is empty, no subsequent query exists.'."\n"
.'- If **NextToken** has a return value, the value indicates the token for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3748DEFF-68BE-5EED-9937-7C1D0C21BAB4', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParam.ResourceRegion', 'errorMessage' => 'The input parameter ResourceRegionId is invalid.', 'description' => 'The input parameter ResourceRegionId is invalid.'],
['errorCode' => 'ResourceNotFound.IpamResourceDiscovery', 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
['errorCode' => 'MissingParam.IpamResourceDiscoveryId', 'errorMessage' => 'The IpamResourceDiscoveryId must be input.', 'description' => 'The IpamResourceDiscoveryId must be input.'],
['errorCode' => 'MissingParam.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId must be input.', 'description' => 'The ResourceRegionId must be input.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamDiscoveredResources\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceId\\": \\"vpc-uf611fp465c7dyb4z****\\",\\n \\"ResourceName\\": \\"\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"Cidr\\": \\"192.168.1.0/32\\",\\n \\"IpUsage\\": \\"0\\",\\n \\"IpCountDetail\\": {\\n \\"FreeIpCount\\": \\"\\",\\n \\"TotalIpCount\\": \\"\\",\\n \\"UsedIpCount\\": \\"\\"\\n },\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"VpcId\\": \\"vpc-uf611fp465c7dyb4z****\\",\\n \\"DiscoveryTime\\": \\"2024-01-01 00:00:00\\",\\n \\"SourceCidr\\": \\"192.168.1.0/24\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"3748DEFF-68BE-5EED-9937-7C1D0C21BAB4\\"\\n}","type":"json"}]',
'title' => 'Query resource information under a resource discovery',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamDiscoveredResource'],
],
],
'ramActions' => [],
],
'ListIpamMembers' => [
'summary' => 'Lists the members managed by the IPAM trusted service.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the hosted region of the IPAM. Call the [DescribeRegions](~~448570~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'MemberIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => ['description' => 'The ID of a member managed by the IPAM trusted service.', 'type' => 'string', 'required' => false, 'example' => 'fd-ccccncASqa', 'title' => ''],
'maxItems' => 100,
'description' => 'A list of IDs of members managed by the IPAM trusted service.',
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no more results are available.'."\n"
."\n"
.'- If **NextToken** has a value, the value is the token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'MemberInfos' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'CreationTime' => ['description' => 'The time when the member was added.', 'type' => 'string', 'example' => '2025-07-11T07:18:07Z', 'title' => ''],
'MemberId' => ['description' => 'The member ID.'."\n"
."\n"
.'- **Folder ID**: The ID of the folder.'."\n"
."\n"
.'- **Account UID**: The UID of the member account in the resource directory.', 'type' => 'string', 'example' => 'fd-ccccncASqa', 'title' => ''],
'MemberType' => ['description' => 'The type of the member. Valid values:'."\n"
."\n"
.'- **Folder**: The member is a folder.'."\n"
."\n"
.'- **Account**: The member is a member account in the resource directory.', 'type' => 'string', 'example' => 'Folder', 'title' => ''],
'Status' => ['description' => 'The status of the member managed by the IPAM trusted service. Valid values:'."\n"
."\n"
.'- **Created**: The member is managed.'."\n"
."\n"
.'- **Deleted**: The member is removed.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'description' => 'A list of members managed by the IPAM trusted service.',
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no more results are available.'."\n"
."\n"
.'- If **NextToken** has a value, the value is the token for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B90776C8-F703-51D5-893A-AD1CA699D535', 'title' => ''],
],
'title' => '',
'description' => 'ListTokenResult',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.IpamNotExist', 'errorMessage' => 'The operation is not allowed because the IPAM does not exist.', 'description' => 'IPAM does not exist in the current region. IPAM trusted service members cannot be managed.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListIpamMembers',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'vpc:ListIpamMembers',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VpcIpam', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"MemberInfos\\": [\\n {\\n \\"CreationTime\\": \\"2025-07-11T07:18:07Z\\",\\n \\"MemberId\\": \\"fd-ccccncASqa\\",\\n \\"MemberType\\": \\"Folder\\",\\n \\"Status\\": \\"Created\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 6,\\n \\"RequestId\\": \\"B90776C8-F703-51D5-893A-AD1CA699D535\\"\\n}","type":"json"}]',
],
'ListIpamPoolAllocations' => [
'summary' => 'Queries CIDR block allocations in an IPAM pool.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region of the IPAM pool that contains the CIDR block allocation.'."\n"
."\n"
.'> If the IPAM pool has a specific region, this parameter specifies that region. If the IPAM pool does not have a specific region, this parameter specifies the managed region of IPAM.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'A list of instance IDs of the IPAM pool CIDR block allocations.',
'type' => 'array',
'items' => ['description' => 'The instance ID of an IPAM pool CIDR block allocation. The list can contain up to 20 instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'Cidr',
'in' => 'query',
'schema' => ['description' => 'The allocated CIDR block that you want to query.'."\n"
."\n"
.'> Only IPv4 CIDR blocks are supported.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.0/24', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM pool CIDR block allocation.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test name', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no next page exists.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that determines the start point of the next query.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamPoolAllocationModel>',
'description' => 'The list of returned information.',
'type' => 'object',
'properties' => [
'IpamPoolAllocations' => [
'description' => 'A list of IPAM pool CIDR block allocations.',
'type' => 'array',
'items' => [
'description' => 'A list of IPAM pool CIDR block allocations.',
'type' => 'object',
'properties' => [
'IpamPoolAllocationId' => ['description' => 'The instance ID of the IPAM pool CIDR block allocation.', 'type' => 'string', 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
'Cidr' => ['description' => 'The allocated CIDR block.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
'SourceCidr' => ['description' => 'The source CIDR block.', 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''],
'ResourceId' => ['description' => 'The ID of the resource to which the CIDR block is allocated.', 'type' => 'string', 'example' => 'vpc-bp16qjewdsunr41m1****', 'title' => ''],
'ResourceType' => [
'description' => 'The type of the resource to which the CIDR block is allocated. Valid values:'."\n"
."\n"
.'- **VPC**: The resource is a VPC.'."\n"
."\n"
.'- **IpamPool**: The resource is a child IPAM pool.'."\n"
."\n"
.'- **Custom**: The resource is a custom reserved CIDR block.',
'enumValueTitles' => [],
'type' => 'string',
'example' => 'Custom',
'title' => '',
],
'ResourceRegionId' => ['description' => 'The ID of the region where the resource is deployed.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'ResourceOwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the resource belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '132193271328****', 'title' => ''],
'RegionId' => ['description' => 'The region of the IPAM pool that contains the CIDR block allocation.'."\n"
."\n"
.'> If the IPAM pool has a specific region, this parameter specifies that region. If the IPAM pool does not have a specific region, this parameter specifies the managed region of IPAM.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'IpamPoolId' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
'Status' => ['description' => 'The status of the instance. Valid values:'."\n"
."\n"
.'- **Created**: The instance is created.'."\n"
."\n"
.'- **Deleted**: The instance is deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'CreationTime' => ['description' => 'The time when the instance was created.', 'type' => 'string', 'example' => '2023-05-19T08:59:18Z', 'title' => ''],
'IpamPoolAllocationDescription' => ['description' => 'The description of the IPAM pool CIDR block allocation.', 'type' => 'string', 'example' => 'test description', 'title' => ''],
'IpamPoolAllocationName' => ['description' => 'The name of the IPAM pool CIDR block allocation.', 'type' => 'string', 'example' => 'test name', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no next page exists.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that determines the start point of the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that meet the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned for the current query.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3748DEFF-68BE-5EED-9937-7C1D0C21BAB4', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.IpamRegionNotSupportListPoolAllocation', 'errorMessage' => 'The operation is not allowed because IPAM region does not support listing allocations.', 'description' => 'The operation is not allowed because IPAM region does not support listing allocations.'],
],
],
'title' => 'ListIpamPoolAllocations',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamPoolAllocations'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamPoolAllocations\\": [\\n {\\n \\"IpamPoolAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.0.0/16\\",\\n \\"ResourceId\\": \\"vpc-bp16qjewdsunr41m1****\\",\\n \\"ResourceType\\": \\"Custom\\",\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"Status\\": \\"Created\\",\\n \\"CreationTime\\": \\"2023-05-19T08:59:18Z\\",\\n \\"IpamPoolAllocationDescription\\": \\"test description\\",\\n \\"IpamPoolAllocationName\\": \\"test name\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"3748DEFF-68BE-5EED-9937-7C1D0C21BAB4\\"\\n}","type":"json"}]',
],
'ListIpamPoolCidrs' => [
'summary' => 'Queries the provisioned CIDR blocks of an IPAM pool.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM is created.'."\n"
."\n"
.'Call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'Cidr',
'in' => 'query',
'schema' => ['description' => 'The provisioned CIDR block to query.'."\n"
."\n"
.'> Only IPv4 CIDR blocks are supported.', 'type' => 'string', 'required' => false, 'example' => '192.168.1.0/24', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. Set the value to the `NextToken` value that is returned in the last call. You do not need to specify this parameter for the first call.'."\n"
."\n"
.'- If **NextToken** is empty, no further query is needed.'."\n"
."\n"
.'- If **NextToken** has a value, use it as the token for the next query.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamPoolCidrModel>',
'description' => 'The information that is returned.',
'type' => 'object',
'properties' => [
'IpamPoolCidrs' => [
'description' => 'A list of provisioned CIDR blocks of the IPAM pool.',
'type' => 'array',
'items' => [
'description' => 'The details of a provisioned CIDR block.',
'type' => 'object',
'properties' => [
'IpamPoolId' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
'Cidr' => ['description' => 'The provisioned CIDR block.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
'Status' => ['description' => 'The instance status of the provisioned CIDR block of the IPAM pool. Valid values:'."\n"
."\n"
.'- **Created**: The CIDR block is created.'."\n"
."\n"
.'- **Deleted**: The CIDR block is deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token that is used to retrieve the next page of results.'."\n"
."\n"
.'- If this parameter is empty, no more results are to be returned.'."\n"
."\n"
.'- If a value is returned, the value is the token that is used for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9E7CCB95-62E0-534D-9B9A-71F27E8B71B1', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.PoolRegionNotSupportListPoolCidr', 'errorMessage' => 'The operation is not allowed because pool region does not support listing cidrs.', 'description' => 'You cannot query CIDR blocks in this region.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamPoolCidrs\\": [\\n {\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"Status\\": \\"Created\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"9E7CCB95-62E0-534D-9B9A-71F27E8B71B1\\"\\n}","type":"json"}]',
'title' => 'ListIpamPoolCidrs',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamPoolCidrs'],
],
],
'ramActions' => [],
],
'ListIpamPools' => [
'summary' => 'Queries IPAM pools.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the managed region. You can call the [DescribeRegions](~~36063~~) operation to query region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamScopeId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM scope.', 'type' => 'string', 'required' => false, 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
],
[
'name' => 'IpamPoolIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'A list of IPAM pool IDs. You can specify up to 100 IDs.',
'type' => 'array',
'items' => ['description' => 'The ID of the IPAM pool.', 'type' => 'string', 'required' => false, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'IpamPoolName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM pool.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'SourceIpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The ID of the source IPAM pool.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ipam-pool-lfnwi4jok1ss0g****'],
],
[
'name' => 'PoolRegionId',
'in' => 'query',
'schema' => ['description' => 'The region where the IPAM pool is available.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group to which the IPAM pool belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2sermdd6****', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify up to 20 tag keys. The key cannot be an empty string.'."\n"
."\n"
.'The key can be up to 64 characters in length. It must start with a letter and can contain digits, periods (.), underscores (\\_), and hyphens (-). The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value. You can specify up to 20 tag values. The value can be an empty string.'."\n"
."\n"
.'The value can be up to 128 characters in length and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results. Valid values:'."\n"
."\n"
.'- You do not need to specify this parameter for the first call.'."\n"
."\n"
.'- Set this parameter to the value of NextToken that was returned in the previous call.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'IsShared',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the address pool is a shared pool.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'IpVersion',
'in' => 'query',
'schema' => ['description' => 'The IP version. Valid values:'."\n"
."\n"
.'- **IPv4**'."\n"
."\n"
.'- **IPv6**', 'type' => 'string', 'required' => false, 'example' => 'IPv4', 'title' => ''],
],
[
'name' => 'Ipv6Isp',
'in' => 'query',
'schema' => ['description' => 'The line type of the IPv6 CIDR block. This parameter is valid only for public IPv6 address pools. Valid values:'."\n"
."\n"
.'- **BGP** (default): Alibaba Cloud BGP IPv6.'."\n"
."\n"
.'- **ChinaMobile**'."\n"
."\n"
.'- **ChinaUnicom**'."\n"
."\n"
.'- **ChinaTelecom**'."\n"
."\n"
.'> If your account is whitelisted for single-line bandwidth, you can set this parameter to **ChinaTelecom**, **ChinaUnicom**, or **ChinaMobile**.', 'type' => 'string', 'required' => false, 'example' => 'BGP', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamPoolModel>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'IpamPools' => [
'description' => 'A list of IPAM pools.',
'type' => 'array',
'items' => [
'description' => 'A list of IPAM pools.',
'type' => 'object',
'properties' => [
'IpamId' => ['description' => 'The ID of the IPAM instance.', 'type' => 'string', 'example' => 'ipam-b5mtlx3q7xcnyr****', 'title' => ''],
'IpamScopeId' => ['description' => 'The ID of the IPAM scope.', 'type' => 'string', 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
'IpamScopeType' => ['description' => 'The type of the IPAM scope. Valid values:'."\n"
."\n"
.'- **public**: the public network.'."\n"
."\n"
.'- **private**: the private network.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'IpamPoolId' => ['description' => 'The ID of the IPAM pool.', 'type' => 'string', 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
'IpamPoolName' => ['description' => 'The name of the IPAM pool.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'IpamPoolDescription' => ['description' => 'The description of the IPAM pool.', 'type' => 'string', 'example' => 'test description', 'title' => ''],
'CreateTime' => ['description' => 'The time when the IPAM pool was created.', 'type' => 'string', 'example' => '2023-04-19T16:49:01Z', 'title' => ''],
'RegionId' => ['description' => 'The ID of the region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'PoolDepth' => ['description' => 'The depth of the IPAM pool. Valid values: 0 to **10**.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'HasSubPool' => ['description' => 'Indicates whether the IPAM pool has sub-pools. Valid values:'."\n"
."\n"
.'- **true**'."\n"
."\n"
.'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'SourceIpamPoolId' => ['description' => 'The ID of the source IPAM pool.', 'type' => 'string', 'example' => 'ipam-pool-lfnwi4jok1ss0g****', 'title' => ''],
'Status' => ['description' => 'The status of the IPAM pool. Valid values:'."\n"
."\n"
.'- **Creating**'."\n"
."\n"
.'- **Created**'."\n"
."\n"
.'- **Modifying**'."\n"
."\n"
.'- **Deleting**'."\n"
."\n"
.'- **Deleted**', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'IpVersion' => ['description' => 'The IP version.', 'type' => 'string', 'example' => 'IPv4', 'title' => ''],
'AllocationDefaultCidrMask' => ['description' => 'The default subnet mask for the IPAM pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '28', 'title' => ''],
'AllocationMaxCidrMask' => ['description' => 'The maximum subnet mask for the IPAM pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '32', 'title' => ''],
'AllocationMinCidrMask' => ['description' => 'The minimum subnet mask for the IPAM pool.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group to which the IPAM pool belongs.', 'type' => 'string', 'example' => 'rg-acfmxazb4ph6aiy****', 'title' => ''],
'Tags' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'FinanceJoshua', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PoolRegionId' => ['description' => 'The ID of the region where the IPAM pool is available.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'IpamRegionId' => ['description' => 'The managed region of the IPAM instance to which the IPAM pool belongs.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'OwnerId' => ['description' => 'The Alibaba Cloud account ID of the owner of the IPAM pool.', 'type' => 'integer', 'format' => 'int64', 'example' => '1210123456******', 'title' => ''],
'AutoImport' => ['description' => 'Indicates whether auto import is enabled for the address pool.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'IsShared' => ['description' => 'Indicates whether the address pool is a shared pool.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Ipv6Isp' => ['description' => 'The line type of the IPv6 CIDR block.', 'type' => 'string', 'example' => 'BGP', 'title' => ''],
'Cidrs' => [
'type' => 'array',
'items' => ['description' => 'The CIDR block that is provisioned for the address pool.', 'type' => 'string', 'example' => '10.214.0.0/16', 'title' => ''],
'description' => 'The CIDR blocks that are provisioned for the address pool.',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no next page exists.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that is used for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B54867DE-83DC-56B4-A57E-69A03119D0B1', 'title' => ''],
],
'example' => '',
],
],
],
'title' => 'ListIpamPools',
'changeSet' => [
['createdAt' => '2025-05-16T06:50:59.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-04-29T06:52:08.000Z', 'description' => 'OpenAPI offline'],
['createdAt' => '2025-04-29T06:51:34.000Z', 'description' => 'OpenAPI offline'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamPools'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamPools\\": [\\n {\\n \\"IpamId\\": \\"ipam-b5mtlx3q7xcnyr****\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\",\\n \\"IpamScopeType\\": \\"private\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t****\\",\\n \\"IpamPoolName\\": \\"test\\",\\n \\"IpamPoolDescription\\": \\"test description\\",\\n \\"CreateTime\\": \\"2023-04-19T16:49:01Z\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"PoolDepth\\": 2,\\n \\"HasSubPool\\": true,\\n \\"SourceIpamPoolId\\": \\"ipam-pool-lfnwi4jok1ss0g****\\",\\n \\"Status\\": \\"Created\\",\\n \\"IpVersion\\": \\"IPv4\\",\\n \\"AllocationDefaultCidrMask\\": 28,\\n \\"AllocationMaxCidrMask\\": 32,\\n \\"AllocationMinCidrMask\\": 8,\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph6aiy****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"PoolRegionId\\": \\"cn-hangzhou\\",\\n \\"IpamRegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0,\\n \\"AutoImport\\": true,\\n \\"IsShared\\": true,\\n \\"Ipv6Isp\\": \\"BGP\\",\\n \\"Cidrs\\": [\\n \\"10.214.0.0/16\\"\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"B54867DE-83DC-56B4-A57E-69A03119D0B1\\"\\n}","type":"json"}]',
],
'ListIpamResourceCidrs' => [
'summary' => 'Queries resources within an IPAM scope.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where IPAM is hosted.'."\n"
."\n"
.'You can call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamScopeId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM scope.', 'type' => 'string', 'required' => false, 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.'."\n"
."\n"
.'> **IpamPoolId** cannot be the instance ID of a shared IPAM pool.', 'type' => 'string', 'required' => false, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp16qjewdsunr41m1****', 'title' => ''],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- **VPC**: The resource type is VPC.'."\n"
.'- **VSwitch**: The resource type is vSwitch.', 'type' => 'string', 'required' => false, 'example' => 'VPC', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token. Valid values:'."\n"
."\n"
.'- If this is the first request or no more results exist, leave this parameter empty.'."\n"
.'- If more results exist, set this parameter to the NextToken value returned in the previous API call.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'VpcId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the VPC-connected instance to which the resource belongs.', 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1fjfnrg3av6zb9e****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The returned information list.',
'type' => 'object',
'properties' => [
'IpamResourceCidrs' => [
'description' => 'The list of resource information.',
'type' => 'array',
'items' => [
'description' => 'The list of resource information.',
'type' => 'object',
'properties' => [
'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '132193271328****', 'title' => ''],
'ResourceType' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- **VPC**: The resource type is VPC.'."\n"
.'- **VSwitch**: The resource type is vSwitch.', 'type' => 'string', 'example' => 'VPC', 'title' => ''],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'example' => 'vpc-bp16qjewdsunr41m1****', 'title' => ''],
'ResourceName' => ['description' => 'The resource name.', 'type' => 'string', 'title' => '', 'example' => ''],
'ResourceOwnerId' => ['description' => 'The Alibaba Cloud account ID of the resource ownership.', 'type' => 'integer', 'format' => 'int64', 'example' => '132193271328****', 'title' => ''],
'ResourceRegionId' => ['description' => 'The ID of the region where the resource takes effect.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'Cidr' => ['description' => 'The CIDR block of the resource.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
'SourceCidr' => ['description' => 'The source CIDR block.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
'Status' => ['description' => 'The status of the resource in the IPAM pool. Valid values:'."\n"
."\n"
.'- **Created**: created.'."\n"
.'- **Deleted**: deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'ManagementStatus' => ['description' => 'The management status of the resource.'."\n"
."\n"
.'- **Managed**: The resource has a CIDR block allocated from an IPAM pool. IPAM monitors the resource for potential CIDR overlap and compliance with pool allocation rules.'."\n"
.'- **Unmanaged**: The resource does not have a CIDR block allocated from an IPAM pool. IPAM monitors the resource for potential CIDRs that comply with pool allocation rules and monitors CIDRs for overlap.'."\n"
.'- **Ignored**: The resource has been excluded from monitoring. Ignored resources are not evaluated for overlap or allocation rule compliance. When a resource is ignored, any space allocated to it from an IPAM pool is returned to the pool, and the resource is not re-imported through automatic import (if an automatic import allocation rule is configured for the pool).', 'type' => 'string', 'example' => 'Managed', 'title' => ''],
'ComplianceStatus' => ['description' => 'The compliance status of the resource.'."\n"
."\n"
.'- **Compliant**: The CIDR block of the managed resource complies with the allocation rules of the IPAM pool.'."\n"
.'- **Noncompliant**: The CIDR block of the managed resource does not comply with one or more allocation rules of the IPAM pool.'."\n"
.'- **Ignored**: The resource has been excluded from monitoring. Ignored resources are not evaluated for overlap or allocation rule compliance.'."\n"
.'- **Unmanaged**: The resource does not have a CIDR block allocated from an IPAM pool. IPAM does not monitor whether the CIDR block of the resource complies with the allocation rules of the pool, but monitors the CIDR block for overlap.', 'type' => 'string', 'example' => 'Compliant', 'title' => ''],
'OverlapStatus' => ['description' => 'The overlap status of the resource.'."\n"
."\n"
.'- **Nonoverlapping**: The CIDR block of the resource does not overlap with other CIDR blocks within the same scope.'."\n"
.'- **Overlapping**: The CIDR block of the resource overlaps with another CIDR block within the same scope.'."\n"
.'- **Ignored**: The resource has been excluded from monitoring. Ignored resources are not evaluated for overlap or allocation rule compliance.', 'type' => 'string', 'example' => 'Nonoverlapping', 'title' => ''],
'IpUsage' => ['description' => 'The IP utilization rate, expressed as a decimal.', 'type' => 'string', 'example' => '0', 'title' => ''],
'IpCountDetail' => [
'description' => 'The details of the resource IP address count.',
'type' => 'object',
'properties' => [
'FreeIpCount' => ['description' => 'The number of available IP addresses.', 'type' => 'string', 'example' => '252', 'title' => ''],
'TotalIpCount' => ['description' => 'The total number of IP addresses.', 'type' => 'string', 'example' => '256', 'title' => ''],
'UsedIpCount' => ['description' => 'The number of allocated IP addresses.', 'type' => 'string', 'example' => '4', 'title' => ''],
],
'title' => '',
'example' => '',
],
'IpamId' => ['description' => 'The instance ID of the IPAM.', 'type' => 'string', 'example' => 'ipam-uq5dcfc2eqhpf4****', 'title' => ''],
'IpamScopeId' => ['description' => 'The instance ID of the IPAM scope.', 'type' => 'string', 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
'IpamPoolId' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'example' => 'ipam-pool-6rcq3tobayc20t***', 'title' => ''],
'IpamAllocationId' => ['description' => 'The instance ID of the IPAM pool CIDR allocation.', 'type' => 'string', 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
'VpcId' => ['description' => 'The instance ID of the VPC-connected instance to which the resource belongs.', 'type' => 'string', 'example' => 'vpc-bp1fjfnrg3av6zb9e****', 'title' => ''],
'OverlapDetail' => [
'description' => 'The list of resources that overlap with the current resource.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'OverlapResourceId' => ['description' => 'The instance ID of the resource that overlaps with the current resource.', 'type' => 'string', 'example' => 'vpc-aq3fjgnig5av6jb8d****', 'title' => ''],
'OverlapResourceRegion' => ['description' => 'The region of the instance that overlaps with the current resource.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'OverlapResourceCidr' => ['description' => 'The CIDR block of the resource that overlaps with the current resource.', 'type' => 'string', 'example' => '192.168.1.0/24', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The pagination token. Valid values:'."\n"
.'- If **NextToken** is empty, no more results exist.'."\n"
.'- If **NextToken** is returned, the value indicates the token for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned under the current query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '49A9DE56-B68C-5FFC-BC06-509D086F287C', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Forbidden.QueryShareResource', 'errorMessage' => 'Authentication is failed for querying a shared IPAM pool.', 'description' => 'Authentication is failed for querying a shared IPAM pool.'],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamResourceCidrs\\": [\\n {\\n \\"AliUid\\": 0,\\n \\"ResourceType\\": \\"VPC\\",\\n \\"ResourceId\\": \\"vpc-bp16qjewdsunr41m1****\\",\\n \\"ResourceName\\": \\"\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceRegionId\\": \\"cn-hangzhou\\",\\n \\"Cidr\\": \\"192.168.1.0/24\\",\\n \\"SourceCidr\\": \\"192.168.1.0/24\\",\\n \\"Status\\": \\"Created\\",\\n \\"ManagementStatus\\": \\"Managed\\",\\n \\"ComplianceStatus\\": \\"Compliant\\",\\n \\"OverlapStatus\\": \\"Nonoverlapping\\",\\n \\"IpUsage\\": \\"0\\",\\n \\"IpCountDetail\\": {\\n \\"FreeIpCount\\": \\"252\\",\\n \\"TotalIpCount\\": \\"256\\",\\n \\"UsedIpCount\\": \\"4\\"\\n },\\n \\"IpamId\\": \\"ipam-uq5dcfc2eqhpf4****\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\",\\n \\"IpamPoolId\\": \\"ipam-pool-6rcq3tobayc20t***\\",\\n \\"IpamAllocationId\\": \\"ipam-pool-alloc-112za33e4****\\",\\n \\"VpcId\\": \\"vpc-bp1fjfnrg3av6zb9e****\\",\\n \\"OverlapDetail\\": [\\n {\\n \\"OverlapResourceId\\": \\"vpc-aq3fjgnig5av6jb8d****\\",\\n \\"OverlapResourceRegion\\": \\"cn-hangzhou\\",\\n \\"OverlapResourceCidr\\": \\"192.168.1.0/24\\"\\n }\\n ]\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"49A9DE56-B68C-5FFC-BC06-509D086F287C\\"\\n}","type":"json"}]',
'title' => 'Query resources within an IPAM scope',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamResourceCidrs'],
],
],
'ramActions' => [],
],
'ListIpamResourceDiscoveries' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~36063~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group to which the resource discovery belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2sermdd6****', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The IDs of the resource discovery instances. You can query up to 100 instances at a time.',
'type' => 'array',
'items' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'required' => false, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'IpamResourceDiscoveryName',
'in' => 'query',
'schema' => ['description' => 'The name of the resource discovery.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with http\\:// or https\\://.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Type',
'in' => 'query',
'schema' => ['description' => 'The type of the resource discovery.'."\n"
."\n"
.'> The following types are supported:'."\n"
.'>'."\n"
.'> - system: a default resource discovery created by the system.'."\n"
.'>'."\n"
.'> - custom: a custom resource discovery created by a user.', 'type' => 'string', 'required' => false, 'example' => 'system', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify up to 20 tag keys. The key cannot be an empty string.'."\n"
."\n"
.'A tag key can be up to 64 characters in length. It must start with a letter or a Chinese character and can contain digits, periods (.), underscores (\\_), and hyphens (-). The key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value. You can specify up to 20 tag values. The value can be an empty string.'."\n"
."\n"
.'A tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token for the next page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no more results are available.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that is used for the next query.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
[
'name' => 'IsShared',
'in' => 'query',
'schema' => ['description' => 'Specifies whether the resource discovery is shared.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamResourceDiscoveryModel>',
'description' => 'The list of returned results.',
'type' => 'object',
'properties' => [
'IpamResourceDiscoveries' => [
'description' => 'The list of resource discovery instances.',
'type' => 'array',
'items' => [
'description' => 'The list of resource discovery instances.',
'type' => 'object',
'properties' => [
'IpamResourceDiscoveryId' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
'IpamResourceDiscoveryName' => ['description' => 'The name of the resource discovery.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'IpamResourceDiscoveryDescription' => ['description' => 'The description of the resource discovery.', 'type' => 'string', 'example' => 'test description', 'title' => ''],
'OperatingRegionList' => [
'description' => 'The list of operating regions of the resource discovery.',
'type' => 'array',
'items' => ['description' => 'The operating region of the resource discovery.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'title' => '',
'example' => '',
],
'Type' => ['description' => 'The type of the resource discovery.', 'type' => 'string', 'example' => 'system', 'title' => ''],
'IpamResourceDiscoveryStatus' => ['description' => 'The status of the resource discovery instance. Valid values:'."\n"
."\n"
.'- **Creating**: The instance is being created.'."\n"
."\n"
.'- **Created**: The instance is created.'."\n"
."\n"
.'- **Modifying**: The instance is being modified.'."\n"
."\n"
.'- **Deleting**: The instance is being deleted.'."\n"
."\n"
.'- **Deleted**: The instance is deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group to which the resource discovery belongs.', 'type' => 'string', 'example' => 'rg-aek2sermdd6****', 'title' => ''],
'CreateTime' => ['description' => 'The time when the resource discovery was created.', 'type' => 'string', 'example' => '2022-07-01T02:05:23Z', 'title' => ''],
'Tags' => [
'description' => 'The list of tags.',
'type' => 'array',
'items' => [
'description' => 'The list of tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'FinanceJoshua', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The ID of the region where the resource discovery instance is located.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'OwnerId' => ['description' => 'The Alibaba Cloud account of the owner of the resource discovery instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1210123456******', 'title' => ''],
'ShareType' => ['description' => 'The sharing status of the resource.'."\n"
."\n"
.'- If this parameter is empty, the resource discovery is a regular instance.'."\n"
."\n"
.'- If this parameter is set to Shared, the resource discovery is a shared resource.'."\n"
."\n"
.'- If this parameter is set to Sharing, the resource discovery is being shared.', 'type' => 'string', 'example' => 'Shared', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token for the next page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no more results are available.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that is used for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '86137597-443F-5B66-B9B6-8514E0C50B8F', 'title' => ''],
],
'example' => '',
],
],
],
'title' => 'ListIpamResourceDiscoveries',
'summary' => 'Retrieves a list of IPAM resource discovery instances.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamResourceDiscoveries'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamResourceDiscoveries\\": [\\n {\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"IpamResourceDiscoveryName\\": \\"test\\",\\n \\"IpamResourceDiscoveryDescription\\": \\"test description\\",\\n \\"OperatingRegionList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"Type\\": \\"system\\",\\n \\"IpamResourceDiscoveryStatus\\": \\"Created\\",\\n \\"ResourceGroupId\\": \\"rg-aek2sermdd6****\\",\\n \\"CreateTime\\": \\"2022-07-01T02:05:23Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0,\\n \\"ShareType\\": \\"Shared\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 1,\\n \\"RequestId\\": \\"86137597-443F-5B66-B9B6-8514E0C50B8F\\"\\n}","type":"json"}]',
],
'ListIpamResourceDiscoveryAssociations' => [
'summary' => 'Lists the associations between resource discoveries and IP Address Managers (IPAMs).',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM instance.', 'type' => 'string', 'required' => false, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'required' => false, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used to retrieve the next page of results.'."\n"
."\n"
.'- For the first query, leave this parameter empty.'."\n"
."\n"
.'- For a subsequent query, set this parameter to the NextToken value returned from the previous response.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamResourceDiscoveryModel>',
'description' => 'The list of returned information.',
'type' => 'object',
'properties' => [
'IpamResourceDiscoveryAssociations' => [
'description' => 'A list of association details.',
'type' => 'array',
'items' => [
'description' => 'A list of association details.',
'type' => 'object',
'properties' => [
'IpamResourceDiscoveryId' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
'IpamId' => ['description' => 'The ID of the IPAM instance.', 'type' => 'string', 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
'Status' => ['description' => 'The association status. Valid values:'."\n"
."\n"
.'- **Created**'."\n"
."\n"
.'- **Deleted**', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'IpamResourceDiscoveryOwnerId' => ['description' => 'The ID of the Alibaba Cloud account that owns the resource discovery instance.', 'type' => 'string', 'example' => '1210123456******', 'title' => ''],
'IpamResourceDiscoveryType' => ['description' => 'The type of the resource discovery. Valid values:'."\n"
."\n"
.'- **system**: a default resource discovery that is automatically created by the system.'."\n"
."\n"
.'- **custom**: a custom resource discovery that is created by a user.', 'type' => 'string', 'example' => 'custom', 'title' => ''],
'IpamResourceDiscoveryStatus' => ['description' => 'The status of the resource discovery instance. Valid values:'."\n"
."\n"
.'- **Creating**'."\n"
."\n"
.'- **Created**'."\n"
."\n"
.'- **Modifying**'."\n"
."\n"
.'- **Deleting**'."\n"
."\n"
.'- **Deleted**', 'type' => 'string', 'example' => 'Created', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token to use to retrieve the next page of results. This value is empty when there are no more results to return.'."\n"
."\n"
.'- If **NextToken** is empty, no subsequent query is needed.'."\n"
."\n"
.'- If **NextToken** is not empty, its value is the token to start the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries that match the query criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F28A239E-F88D-500E-ADE7-FA5E8CA3A170', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListIpamResourceDiscoveryAssociations',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamResourceDiscoveryAssociations'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamResourceDiscoveryAssociations\\": [\\n {\\n \\"IpamResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"Status\\": \\"Created\\",\\n \\"IpamResourceDiscoveryOwnerId\\": \\"1210123456******\\",\\n \\"IpamResourceDiscoveryType\\": \\"custom\\",\\n \\"IpamResourceDiscoveryStatus\\": \\"Created\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"F28A239E-F88D-500E-ADE7-FA5E8CA3A170\\"\\n}","type":"json"}]',
],
'ListIpamScopes' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'list'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM instance is deployed. You can call the [DescribeRegions](~~36063~~) operation to obtain the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM.', 'type' => 'string', 'required' => false, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'IpamScopeType',
'in' => 'query',
'schema' => ['description' => 'The type of the IPAM scope. Valid values:'."\n"
."\n"
.'- **public**: the public scope.'."\n"
."\n"
.'- **private**: the private scope.', 'type' => 'string', 'required' => false, 'example' => 'private', 'title' => ''],
],
[
'name' => 'IpamScopeIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The instance IDs of the IPAM scopes.',
'type' => 'array',
'items' => ['description' => 'The instance ID of an IPAM scope. You can specify up to 20 instance IDs.', 'type' => 'string', 'required' => false, 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'IpamScopeName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM scope.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group to which the IPAM scope belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2sermdd6****', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length. It must start with a letter. It can contain digits, periods (.), underscores (\\_), and hyphens (-). The tag key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value of the resource. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length. It cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used for the next query. Valid values:'."\n"
."\n"
.'- You do not need to specify this parameter for the first query.'."\n"
."\n"
.'- For a subsequent query, set this parameter to the NextToken value returned from the last query.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamScopeModel>',
'description' => 'The information returned.',
'type' => 'object',
'properties' => [
'IpamScopes' => [
'description' => 'A list of IPAM scopes.',
'type' => 'array',
'items' => [
'description' => 'A list of IPAM scopes.',
'type' => 'object',
'properties' => [
'CreateTime' => ['description' => 'The time when the IPAM scope was created.', 'type' => 'string', 'example' => '2022-04-18T03:12:37Z', 'title' => ''],
'IpamScopeId' => ['description' => 'The instance ID of the IPAM scope.', 'type' => 'string', 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
'IpamScopeType' => ['description' => 'The type of the IPAM scope. Valid values:'."\n"
."\n"
.'- **public**: the public scope.'."\n"
."\n"
.'- **private**: the private scope.', 'type' => 'string', 'example' => 'private', 'title' => ''],
'Status' => ['description' => 'The status of the IPAM scope. Valid values:'."\n"
."\n"
.'- **Creating**: The IPAM scope is being created.'."\n"
."\n"
.'- **Created**: The IPAM scope is created.'."\n"
."\n"
.'- **Deleting**: The IPAM scope is being deleted.'."\n"
."\n"
.'- **Deleted**: The IPAM scope is deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'IpamId' => ['description' => 'The instance ID of the IPAM.', 'type' => 'string', 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
'PoolCount' => ['description' => 'The number of IPAM pools in the IPAM scope.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'IpamScopeName' => ['description' => 'The name of the IPAM scope.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'IpamScopeDescription' => ['description' => 'The description of the IPAM scope.', 'type' => 'string', 'example' => 'test description', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group to which the IPAM scope belongs.', 'type' => 'string', 'example' => 'rg-acfmxazb4ph6aiy****', 'title' => ''],
'Tags' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'FinanceDept', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'IsDefault' => ['description' => 'Indicates whether the scope is the default scope. Valid values:'."\n"
."\n"
.'- **true**: The scope is the default scope.'."\n"
."\n"
.'- **false**: The scope is not the default scope.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RegionId' => ['description' => 'The region ID of the IPAM scope.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the IPAM scope belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1210123456******', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token that is used for the next page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no next page exists.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that is used for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8859C501-97E7-53D4-B94B-2A9E16003B22', 'title' => ''],
],
'example' => '',
],
],
],
'title' => 'ListIpamScopes',
'summary' => 'Queries IPAM scopes.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamScopes'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IpamScopes\\": [\\n {\\n \\"CreateTime\\": \\"2022-04-18T03:12:37Z\\",\\n \\"IpamScopeId\\": \\"ipam-scope-glfmcyldpm8lsy****\\",\\n \\"IpamScopeType\\": \\"private\\",\\n \\"Status\\": \\"Created\\",\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"PoolCount\\": 2,\\n \\"IpamScopeName\\": \\"test\\",\\n \\"IpamScopeDescription\\": \\"test description\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxazb4ph6aiy****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceDept\\"\\n }\\n ],\\n \\"IsDefault\\": true,\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 1000,\\n \\"MaxResults\\": 10,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"8859C501-97E7-53D4-B94B-2A9E16003B22\\"\\n}","type":"json"}]',
],
'ListIpams' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the hosted region of the IPAM. You can call [DescribeRegions](~~448570~~) to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceGroupId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource group to which the IPAM belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2sermdd6****', 'title' => ''],
],
[
'name' => 'IpamIds',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The IDs of the IPAMs. You can specify up to 100 IPAM IDs.',
'type' => 'array',
'items' => ['description' => 'The ID of the IPAM.', 'type' => 'string', 'required' => false, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'IpamName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'Tags',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length. It must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (\\_), and hyphens (-). It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
."\n"
.'- You do not need to specify this parameter for the first request or when no next page exists.'."\n"
."\n"
.'- If a next page exists, set the value to the NextToken value returned in the last API call.', 'type' => 'string', 'required' => false, 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<IpamModel>',
'description' => 'The information returned.',
'type' => 'object',
'properties' => [
'Ipams' => [
'description' => 'A list of IPAM instances.',
'type' => 'array',
'items' => [
'description' => 'A list of IPAM instances.',
'type' => 'object',
'properties' => [
'IpamId' => ['description' => 'The ID of the IPAM.', 'type' => 'string', 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
'IpamName' => ['description' => 'The name of the IPAM.', 'type' => 'string', 'example' => 'test', 'title' => ''],
'IpamDescription' => ['description' => 'The description of the IPAM.', 'type' => 'string', 'example' => 'test description', 'title' => ''],
'OperatingRegionList' => [
'description' => 'The list of operating regions of the IPAM.',
'type' => 'array',
'items' => ['description' => 'The operating region of the IPAM.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'title' => '',
'example' => '',
],
'PrivateDefaultScopeId' => ['description' => 'The ID of the default private scope that is automatically created when you create the IPAM.', 'type' => 'string', 'example' => 'ipam-scope-okoerbco6unqfr****', 'title' => ''],
'PublicDefaultScopeId' => ['description' => 'The ID of the default public scope that is automatically created when you create the IPAM.', 'type' => 'string', 'example' => 'ipam-scope-ovb76p1g1m19dr****', 'title' => ''],
'ScopeCount' => ['description' => 'The number of scopes in the IPAM. Valid values: 2 to **5**.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'IpamStatus' => ['description' => 'The status of the IPAM. Valid values:'."\n"
."\n"
.'- **Creating**: The IPAM is being created.'."\n"
."\n"
.'- **Created**: The IPAM is created.'."\n"
."\n"
.'- **Deleting**: The IPAM is being deleted.'."\n"
."\n"
.'- **Deleted**: The IPAM is deleted.', 'type' => 'string', 'example' => 'Created', 'title' => ''],
'ResourceGroupId' => ['description' => 'The ID of the resource group to which the IPAM belongs.', 'type' => 'string', 'example' => 'rg-aek2dbprgpt****', 'title' => ''],
'CreateTime' => ['description' => 'The time when the IPAM was created.', 'type' => 'string', 'example' => '2022-07-01T02:05:23Z', 'title' => ''],
'Tags' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'FinanceJoshua', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RegionId' => ['description' => 'The ID of the region where the IPAM is created.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''],
'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account to which the IPAM belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1210123456******', 'title' => ''],
'DefaultResourceDiscoveryId' => ['description' => 'The ID of the default resource discovery.', 'type' => 'string', 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
'DefaultResourceDiscoveryAssociationId' => ['description' => 'The ID of the default resource discovery association.', 'type' => 'string', 'example' => 'ipam-res-disco-assoc-jt5fac8twugdbbgip****', 'title' => ''],
'ResourceDiscoveryAssociationCount' => ['description' => 'The number of resource discovery associations.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no next page exists.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that is used for the next query.', 'type' => 'string', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****', 'title' => ''],
'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'MaxResults' => ['description' => 'The maximum number of entries returned per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''],
'Count' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '23CA0A0B-B0F5-5495-B355-7D9A9203A46B', 'title' => ''],
],
'example' => '',
],
],
],
'title' => 'ListIpams',
'summary' => 'Queries one or more IPAMs.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpams'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ipams\\": [\\n {\\n \\"IpamId\\": \\"ipam-ccxbnsbhew0d6t****\\",\\n \\"IpamName\\": \\"test\\",\\n \\"IpamDescription\\": \\"test description\\",\\n \\"OperatingRegionList\\": [\\n \\"cn-hangzhou\\"\\n ],\\n \\"PrivateDefaultScopeId\\": \\"ipam-scope-okoerbco6unqfr****\\",\\n \\"PublicDefaultScopeId\\": \\"ipam-scope-ovb76p1g1m19dr****\\",\\n \\"ScopeCount\\": 2,\\n \\"IpamStatus\\": \\"Created\\",\\n \\"ResourceGroupId\\": \\"rg-aek2dbprgpt****\\",\\n \\"CreateTime\\": \\"2022-07-01T02:05:23Z\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"FinanceDept\\",\\n \\"Value\\": \\"FinanceJoshua\\"\\n }\\n ],\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"OwnerId\\": 0,\\n \\"DefaultResourceDiscoveryId\\": \\"ipam-res-disco-jt5f2af2u6nk2z321****\\",\\n \\"DefaultResourceDiscoveryAssociationId\\": \\"ipam-res-disco-assoc-jt5fac8twugdbbgip****\\",\\n \\"ResourceDiscoveryAssociationCount\\": 1\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 20,\\n \\"Count\\": 10,\\n \\"RequestId\\": \\"23CA0A0B-B0F5-5495-B355-7D9A9203A46B\\"\\n}","type":"json"}]',
],
'ListTagResources' => [
'summary' => 'Queries the tags that are associated with resources.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource IDs.',
'type' => 'array',
'items' => ['description' => 'The resource ID. You can specify up to 50 resource IDs.'."\n"
."\n"
.'> You must specify **ResourceId.N** or **Tag.N** (**Tag.N.Key** and **Tag.N.Value**).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ipam-ccxbnsbhew0d6t****'],
'required' => false,
'maxItems' => 51,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- **IPAM**: IPAM'."\n"
."\n"
.'- **IPAMSCOPE**: IPAM scope'."\n"
."\n"
.'- **IPAMPOOL**: IPAM address pool', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'IPAM'],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags.',
'type' => 'array',
'items' => [
'description' => 'The tags.',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify up to 20 tag keys. The tag key cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length. It must start with a letter or a Chinese character and can contain digits, periods (.), underscores (\\_), and hyphens (-). The tag key cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`.'."\n"
."\n"
.'> You must specify **ResourceId.N** or **Tag.N** (**Tag.N.Key** and **Tag.N.Value**).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'FinanceDept'],
'Value' => ['description' => 'The tag value. You can specify up to 20 tag values. The tag value can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length and cannot contain `http://` or `https://`.'."\n"
."\n"
.'> You must specify **ResourceId.N** or **Tag.N** (**Tag.N.Key** and **Tag.N.Value**).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'FinanceJoshua'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => ['description' => 'The token that is used for the next query. Valid values:'."\n"
."\n"
.'- You do not need to specify this parameter for the first query.'."\n"
."\n"
.'- For a subsequent query, set this parameter to the NextToken value returned from the last API call.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'],
],
[
'name' => 'MaxResults',
'in' => 'query',
'schema' => ['description' => 'The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'title' => '', 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListTokenResult<TagResourceModel>',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'TagResources' => [
'description' => 'The details of the resources and their tags.',
'type' => 'array',
'items' => [
'description' => 'The details of the resources and their tags.',
'type' => 'object',
'properties' => [
'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => 'FinanceDept'],
'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'FinanceJoshua'],
'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'title' => '', 'example' => 'ipam-uq5dcfc2eqhpf4****'],
'ResourceType' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'- **IPAM**: IPAM'."\n"
."\n"
.'- **IPAMSCOPE**: IPAM scope'."\n"
."\n"
.'- **IPAMPOOL**: IPAM address pool', 'type' => 'string', 'title' => '', 'example' => 'IPAM'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'NextToken' => ['description' => 'The token that is used for the next query. Valid values:'."\n"
."\n"
.'- If **NextToken** is empty, no more results are returned.'."\n"
."\n"
.'- If a value is returned for **NextToken**, the value is the token that is used for the next query.', 'type' => 'string', 'title' => '', 'example' => 'FFmyTO70tTpLG6I3FmYAXGKPd****'],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '672053AB-90C9-5693-AB96-458F137A5ED6'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParamSize.ResourceIds', 'errorMessage' => 'The number of Param ResourceIds exceeded the limit.', 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['errorCode' => 'IllegalParamSize.Tags', 'errorMessage' => 'The number of Parameter Tags exceeded the limit.', 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceIds not passed in.'],
['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceType not passed in.'],
['errorCode' => 'MissingParameter.TagsAndResourceIds', 'errorMessage' => 'The input parameter Tags and ResourceIds that is mandatory for processing this request is not supplied.', 'description' => 'The Tags and ResourceIds parameters are not passed in.'],
['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceType not passed in.'],
['errorCode' => 'DuplicatedParam.TagKey', 'errorMessage' => 'TagKey duplicate.', 'description' => 'TagKey parameter duplicate'],
['errorCode' => 'IllegalParam.TagKey', 'errorMessage' => 'The input parameter TagKey is invalid.', 'description' => 'Illegal parameter TagKey.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListTagResources',
'description' => '### Usage notes'."\n"
."\n"
.'- You must specify at least **ResourceId.N** or **Tag.N** (**Tag.N.Key** and **Tag.N.Value**) in a request to identify the resources to query.'."\n"
."\n"
.'- **Tag.N** is a resource tag that consists of a key-value pair. If you specify only **Tag.N.Key**, all tag values associated with the tag key are returned. An error is returned if you specify only **Tag.N.Value**.'."\n"
."\n"
.'- If you specify both **Tag.N** and **ResourceId.N**, the query returns only the resources that are specified by **ResourceId.N** and are associated with all the specified tag key-value pairs.'."\n"
."\n"
.'- If you specify multiple tag key-value pairs, the query returns only resources that are associated with all the specified key-value pairs.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'vpc:ListTagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'Ipam', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}'],
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'IpamPool', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}'],
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'IpamScope', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TagResources\\": [\\n {\\n \\"TagKey\\": \\"FinanceDept\\",\\n \\"TagValue\\": \\"FinanceJoshua\\",\\n \\"ResourceId\\": \\"ipam-uq5dcfc2eqhpf4****\\",\\n \\"ResourceType\\": \\"IPAM\\"\\n }\\n ],\\n \\"NextToken\\": \\"FFmyTO70tTpLG6I3FmYAXGKPd****\\",\\n \\"RequestId\\": \\"672053AB-90C9-5693-AB96-458F137A5ED6\\"\\n}","type":"json"}]',
],
'OpenVpcIpamService' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.'."\n"
."\n"
.'This token is generated by the client and must be unique for each request. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the \\`RequestId\\` of the request as the \\`ClientToken\\`. The \\`RequestId\\` may be different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the managed region for IPAM.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F814C37-B032-5477-AF5A-2925D0593CD4', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''],
],
'description' => 'The returned data.',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationFailed.ExceedPurchaseLimit', 'errorMessage' => 'You have reached the limit of purchase quantity.', 'description' => 'The purchase limit is reached.'],
['errorCode' => 'Forbidden.RAM', 'errorMessage' => 'The user is not authorized to operate on the specified resource, or the API operation does not support RAM.', 'description' => 'The user is not authorized to operate on the specified resource, or the API operation does not support RAM.'],
['errorCode' => 'OperationFailed.AliGroupUserCanNotBuyInnerCommodity', 'errorMessage' => 'IPAM has no group cloud product label, and users within the group are not allowed to purchase.', 'description' => 'IPAM does not have a merchandise tag and cannot be purchased by an internal group user.'],
['errorCode' => 'Order.NoRealNameAuthentication', 'errorMessage' => 'Real-name verification has not been completed for the account.', 'description' => 'You have not performed real-name authentication. Please go to the account center to complete real-name authentication.'],
['errorCode' => 'OperationFailed.BasicInfoUncompleted', 'errorMessage' => 'You have not completed your basic personal information, please complete the information and try again.', 'description' => 'Your basic information is incomplete. Specify the information and try again.'],
['errorCode' => 'OperationFailed.AccountBalanceInsufficient', 'errorMessage' => 'The account balance of this user is insufficient to place the order.', 'description' => 'The account balance of this user is insufficient to place the order.'],
],
],
'title' => 'OpenVpcIpamService',
'summary' => 'Activates the IP Address Management (IPAM) service.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'OpenVpcIpamService'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'vpc:OpenVpcIpamService',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VpcIpam', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F814C37-B032-5477-AF5A-2925D0593CD4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\"\\n}","type":"json"}]',
],
'RemoveIpamMembers' => [
'summary' => 'Removes members from the IPAM trusted service.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM is hosted. To get the region ID, call the [DescribeRegions](~~36063~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. The system checks the required parameters, the request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned. The members are not removed.'."\n"
."\n"
.'- **false** (default): Sends a request. If the request passes the check, a 2xx HTTP status code is returned, and the members are removed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among different requests. The ClientToken parameter can contain only ASCII characters. Note: If you do not specify this parameter, the system uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'Members',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'MemberId' => ['description' => 'The member ID.'."\n"
."\n"
.'- **Folder ID**: The ID of the folder.'."\n"
."\n"
.'- **Account UID**: The UID of the member account in the resource directory.', 'type' => 'string', 'required' => false, 'example' => 'Folder', 'title' => ''],
'MemberType' => [
'description' => 'The type of the member. Valid values:'."\n"
."\n"
.'- **Folder**: The member is a folder.'."\n"
."\n"
.'- **Account**: The member is a member account in the resource directory.',
'enumValueTitles' => ['Account' => 'Member account in a resource directory', 'Folder' => 'Folder'],
'type' => 'string',
'enum' => ['Account', 'Folder'],
'required' => false,
'example' => 'fd-ccccncASqa',
'title' => '',
],
],
'required' => false,
'description' => '',
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 10,
'minItems' => 1,
'description' => 'The members managed by the IPAM trusted service.',
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '3F814C37-B032-5477-AF5A-2925D0593CD4', 'title' => ''],
],
'title' => '',
'description' => 'BaseResult',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.MemberIdNotMatchMemberType', 'errorMessage' => 'The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match.', 'description' => 'The Member Id and Member Type of [%s] in the input Members do not match.'],
['errorCode' => 'OperationDenied.IpamRDServiceMemberNotExist', 'errorMessage' => 'The operation is not allowed because %s is not managed by the IPAM.', 'description' => 'The member %s to be removed from the input parameter is not managed by IPAM trusted service.'],
['errorCode' => 'OperationDenied.IpamRDServiceNotEnableInOperationRegion', 'errorMessage' => 'The operation is not allowed because the IPAM RD service is not enabled in the current region.', 'description' => 'The IPAM instance in the operating region does not manage any resource directory members.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'RemoveIpamMembers',
'description' => '- If the delegated IPAM administrator removes the last member, the IPAM trusted service is disabled for the resource directory.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3F814C37-B032-5477-AF5A-2925D0593CD4\\"\\n}","type":"json"}]',
],
'TagResources' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the resource.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The IDs of the resources.'."\n",
'type' => 'array',
'items' => ['description' => 'The ID of the resource. You can enter at most 20 resource IDs.'."\n"
."\n"
.'> When you call this operation, you must specify ResourceId.N.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ipam-uq5dcfc2eqhpf4****', 'title' => ''],
'required' => true,
'maxItems' => 51,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'* **IPAM**'."\n"
.'* **IPAMSCOPE**'."\n"
.'* **IPAMPOOL**', 'type' => 'string', 'required' => true, 'example' => 'IPAM', 'title' => ''],
],
[
'name' => 'Tag',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The tags to add to the resources.'."\n",
'type' => 'array',
'items' => [
'description' => '',
'type' => 'object',
'properties' => [
'Key' => ['description' => 'The tag key. You can specify at most 20 tag keys. The tag key cannot be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). It cannot start with a `aliyun` or `acs:`, and cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'Value' => ['description' => 'The tag value. You can specify at most 20 tag values. The tag value can be an empty string.'."\n"
."\n"
.'The tag value can be up to 128 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). It cannot start with a `aliyun` or `acs:`, and cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FinanceJoshua', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 21,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BF872550-9700-52FD-839C-4D3F05543FA8', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceIds not passed in.'],
['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceType not passed in.'],
['errorCode' => 'MissingParameter.TagKey', 'errorMessage' => 'The input parameter TagKey that is mandatory for processing this request is not supplied.', 'description' => 'The parameter Tags was not passed in.'],
['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceType not passed in.'],
['errorCode' => 'MissingParameter.TagValue', 'errorMessage' => 'The input parameter TagValue that is mandatory for processing this request is not supplied.', 'description' => 'The parameter Tags was not passed in.'],
['errorCode' => 'IllegalParamSize.ResourceIds', 'errorMessage' => 'The number of Param ResourceIds exceeded the limit.', 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['errorCode' => 'IllegalParamSize.Tags', 'errorMessage' => 'The number of Parameter Tags exceeded the limit.', 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['errorCode' => 'DuplicatedParam.TagKey', 'errorMessage' => 'TagKey duplicate.', 'description' => 'TagKey parameter duplicate'],
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'ResourceNotFound.IpamScope', 'errorMessage' => 'The specified resource of IPAM scope is not found.', 'description' => 'The input IPAM scope does not exist.'],
['errorCode' => 'IllegalParam.TagKey', 'errorMessage' => 'The input parameter TagKey is invalid.', 'description' => 'Illegal parameter TagKey.'],
['errorCode' => 'DuplicatedParam.ResourceIds', 'errorMessage' => 'The parameter of ResourceIds contains duplicate values.', 'description' => ''],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'TagResources',
'summary' => 'Adds a tag to a resource.',
'description' => '### [](#)Usage notes'."\n"
."\n"
.'Tags are used to classify instances. Each tag consists of a key-value pair. Before you use tags, take note of the following items:'."\n"
."\n"
.'* Each tag key that is added to an instance must be unique.'."\n"
.'* You cannot create tags without adding them to instances. All tags must be added to instances.'."\n"
.'* You can add at most 20 tags to each instance. Before you add a tag to an instance, the system automatically checks the number of existing tags. An error message is returned if the maximum number of tags is reached.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'vpc:TagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'Ipam', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}'],
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'IpamPool', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}'],
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'IpamScope', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF872550-9700-52FD-839C-4D3F05543FA8\\"\\n}","type":"json"}]',
],
'UntagResources' => [
'summary' => 'Removes a tag from a resource.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The region ID of the resource.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'ResourceId',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The resource IDs.'."\n",
'type' => 'array',
'items' => ['description' => 'The resource ID. You can specify at most 20 resource IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ipam-uq5dcfc2eqhpf4****', 'title' => ''],
'required' => true,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => 'The resource type. Valid values:'."\n"
."\n"
.'* **IPAM**'."\n"
.'* **IPAMSCOPE**'."\n"
.'* **IPAMPOOL**', 'type' => 'string', 'required' => true, 'example' => 'IPAM', 'title' => ''],
],
[
'name' => 'TagKey',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The keys of the tags that you want to remove from the resource.'."\n",
'type' => 'array',
'items' => ['description' => 'The key of the tag that you want to remove. You can specify up to 20 tag keys. It can be an empty string.'."\n"
."\n"
.'The tag key can be up to 64 characters in length and can contain letters, digits, periods (.), underscores (\\_), and hyphens (-). The tag key must start with a letter but cannot start with `aliyun` or `acs:`. The tag key cannot contain `http://` or `https://`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'FinanceDept', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'All',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to remove all tags from the specified resource. Valid values:'."\n"
."\n"
.'* **true**'."\n"
.'* **false** (default)'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '44C884BD-2D56-5637-A523-1FA920A01E7D', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'MissingParameter.ResourceIds', 'errorMessage' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceIds not passed in.'],
['errorCode' => 'MissingParameter.ResourceType', 'errorMessage' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceType not passed in.'],
['errorCode' => 'IllegalParamSize.ResourceIds', 'errorMessage' => 'The number of Param ResourceIds exceeded the limit.', 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['errorCode' => 'IllegalParamSize.Tags', 'errorMessage' => 'The number of Parameter Tags exceeded the limit.', 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['errorCode' => 'IllegalParam.ResourceType', 'errorMessage' => 'The input parameter ResourceType is invalid.', 'description' => 'Parameter ResourceType.'],
['errorCode' => 'MissingParameter.Tags', 'errorMessage' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', 'description' => 'Parameter ResourceType not passed in.'],
['errorCode' => 'IllegalParam.TagKey', 'errorMessage' => 'The input parameter TagKey is invalid.', 'description' => 'Illegal parameter TagKey.'],
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'ResourceNotFound.IpamScope', 'errorMessage' => 'The specified resource of IPAM scope is not found.', 'description' => 'The input IPAM scope does not exist.'],
['errorCode' => 'DuplicatedParam.ResourceIds', 'errorMessage' => 'The parameter of ResourceIds contains duplicate values.', 'description' => ''],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UntagResources',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'vpc:UntagResources',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'Ipam', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipam/{#IpamId}'],
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'IpamPool', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipampool/{#IpamPoolId}'],
['validationType' => 'conditional', 'product' => 'VpcIpam', 'resourceType' => 'IpamScope', 'arn' => 'acs:vpc:{#regionId}:{#accountId}:ipamscope/{#IpamScopeId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"44C884BD-2D56-5637-A523-1FA920A01E7D\\"\\n}","type":"json"}]',
],
'UpdateIpam' => [
'summary' => 'Modifies an IP Address Management (IPAM) instance.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the hosted region. You can call the [DescribeRegions](~~36063~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM.', 'type' => 'string', 'required' => true, 'example' => 'ipam-ccxbnsbhew0d6t****', 'title' => ''],
],
[
'name' => 'IpamName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM. The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.'."\n"
."\n"
.'The value must be 1 to 128 characters long and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IpamDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the IPAM. The description must be 1 to 256 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. If you do not specify this parameter, the description is empty.'."\n"
."\n"
.'It must be 1 to 256 characters in length and start with a letter or a Chinese character, but cannot start with `http://` or `https://`. The default value is empty.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'AddOperatingRegion',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of operating regions to add to the IPAM.',
'type' => 'array',
'items' => ['description' => 'The operating region to add to the IPAM.', 'type' => 'string', 'required' => false, 'example' => 'eu-central-1', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'RemoveOperatingRegion',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of operating regions to remove from the IPAM.',
'type' => 'array',
'items' => ['description' => 'The operating region to remove from the IPAM.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. The system checks the required parameters, request format, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.'."\n"
."\n"
.'- **false** (default): Sends the request. If the request passes the check, a 2xx HTTP status code is returned and the IPAM instance is modified.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. ClientToken can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID for each request is unique.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F4650E33-895C-53F0-9CD5-D1338F322DE8', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.Ipam', 'errorMessage' => 'The specified resource of ipam is not found.', 'description' => 'The IPAM entered does not exist.'],
['errorCode' => 'IllegalParam.OperatingRegion', 'errorMessage' => 'The operating region is invalid.', 'description' => 'The operating region is invalid.'],
['errorCode' => 'DependencyViolation.IpamPool', 'errorMessage' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', 'description' => 'The specified resource is dependent on other resources and the current operation is not allowed.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.IpamRegionCannotBeRemoved', 'errorMessage' => 'The IPAM region cannot be removed.', 'description' => 'The IPAM region cannot be removed.'],
],
],
'title' => 'UpdateIpam',
'description' => '- The managed region of an IPAM instance cannot be removed.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpam'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F4650E33-895C-53F0-9CD5-D1338F322DE8\\"\\n}","type":"json"}]',
],
'UpdateIpamPool' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the hosted region of the IPAM. Call [DescribeRegions](~~448570~~) to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamPoolId',
'in' => 'query',
'schema' => ['description' => 'The instance ID of the IPAM pool.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-6rcq3tobayc20t****', 'title' => ''],
],
[
'name' => 'IpamPoolName',
'in' => 'query',
'schema' => ['description' => 'The new name of the IPAM pool.'."\n"
."\n"
.'The name must be 1 to 128 characters in length and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IpamPoolDescription',
'in' => 'query',
'schema' => ['description' => 'The new description of the IPAM pool.'."\n"
."\n"
.'The description must be 1 to 256 characters in length. It must start with a letter or a Chinese character and cannot start with `http://` or `https://`. If you do not specify this parameter, the value is not changed. By default, the value is empty.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'AllocationDefaultCidrMask',
'in' => 'query',
'schema' => ['description' => 'The new default network mask for the IPAM pool.'."\n"
."\n"
.'Valid values: **0 to 32**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '28', 'title' => ''],
],
[
'name' => 'AllocationMaxCidrMask',
'in' => 'query',
'schema' => ['description' => 'The new maximum network mask for the IPAM pool.'."\n"
."\n"
.'Valid values: **0 to 32**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''],
],
[
'name' => 'AllocationMinCidrMask',
'in' => 'query',
'schema' => ['description' => 'The new minimum network mask for the IPAM pool.'."\n"
."\n"
.'Valid values: **0 to 32**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8', 'title' => ''],
],
[
'name' => 'ClearAllocationDefaultCidrMask',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to clear the default network mask of the IPAM pool. Valid values:'."\n"
."\n"
.'- **true**: Yes.'."\n"
."\n"
.'- **false**: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Sends a check request without modifying the IPAM pool. The system checks for required parameters, request format, and service limits. If the check fails, an error message is returned. If the check succeeds, the \\`DryRunOperation\\` error code is returned.'."\n"
."\n"
.'- **false** (default): Sends a normal request. After the request passes the check, a 2xx HTTP status code is returned and the IPAM pool is modified.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token that is used to ensure the idempotence of the request. Generate a unique token for each request. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID of each API request is different.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
[
'name' => 'AutoImport',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to enable the auto import feature for the address pool.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9DED57B9-7654-5B6D-93F7-BCA5839FEE38', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'OperationDenied.PoolRegionNotSupportUpdatePool', 'errorMessage' => 'The operation is not allowed because of pool region not support update.', 'description' => 'The operation was denied because the update address pool operation could not be performed in the domain'],
['errorCode' => 'IllegalParam.AllocationDefaultNetmask', 'errorMessage' => 'The specified AllocationDefaultNetmask is illegal.', 'description' => 'AllocationDefaultNetmask parameter is illegal.'],
['errorCode' => 'IllegalParam.AllocationMaxNetmask', 'errorMessage' => 'The specified AllocationMaxNetmask is illegal.', 'description' => 'AllocationMaxNetmask parameter is illegal.'],
['errorCode' => 'IllegalParam.AllocationMinNetmask', 'errorMessage' => 'The specified AllocationMinNetmask is illegal.', 'description' => 'AllocationMinNetmask parameter is illegal.'],
['errorCode' => 'IllegalParam.IpVersion', 'errorMessage' => 'The specified IpVersion is illegal.', 'description' => 'Invalid IpVersion.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
],
],
'title' => 'UpdateIpamPool',
'summary' => 'Updates the basic information of an IPAM pool.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamPool'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DED57B9-7654-5B6D-93F7-BCA5839FEE38\\"\\n}","type":"json"}]',
],
'UpdateIpamPoolAllocation' => [
'summary' => 'Updates a CIDR allocation from an IPAM address pool.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the CIDR allocation is located. To obtain a region ID, call the [DescribeRegions](~~36063~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Sends a check request without modifying the CIDR allocation. The system checks for required parameters, request format, and service limits. If the check fails, an error is returned. If the check passes, the DryRunOperation error code is returned.'."\n"
."\n"
.'- **false** (default): Sends a normal request. After the check passes, an HTTP 2xx status code is returned and the CIDR allocation is modified.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'A client token to ensure the idempotence of the request. Generate a unique value from your client for each request. ClientToken supports only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system uses the request ID as the client token. The request ID is different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000'."\n", 'title' => ''],
],
[
'name' => 'IpamPoolAllocationDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the CIDR allocation.'."\n"
."\n"
.'The description must be 1 to 256 characters long and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. If you do not specify this parameter, the description is empty.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationName',
'in' => 'query',
'schema' => ['description' => 'The name of the CIDR allocation.'."\n"
."\n"
.'The name must be 1 to 128 characters long. It cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test name', 'title' => ''],
],
[
'name' => 'IpamPoolAllocationId',
'in' => 'query',
'schema' => ['description' => 'The ID of the CIDR allocation.', 'type' => 'string', 'required' => true, 'example' => 'ipam-pool-alloc-112za33e4****', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F4650E33-895C-53F0-9CD5-D1338F322DE8', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.Unauthorized', 'errorMessage' => 'The operation is denied because the user is not authorized.', 'description' => 'The operation is denied because the user is not authorized.'],
['errorCode' => 'OperationDenied.RequestRegionInvalid', 'errorMessage' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', 'description' => 'The operation is not called in the region of the pool.'],
],
404 => [
['errorCode' => 'ResourceNotFound.IpamPool', 'errorMessage' => 'The dependent IPAM pool is not found.', 'description' => 'The IPAM pool does not exist.'],
['errorCode' => 'ResourceNotFound.IpamPoolAllocation', 'errorMessage' => 'The specified resource of IPAM pool allocation is not found.', 'description' => ''],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateIpamPoolAllocation',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamPoolAllocation'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'vpc:UpdateIpamPoolAllocation',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'VpcIpam', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F4650E33-895C-53F0-9CD5-D1338F322DE8\\"\\n}","type":"json"}]',
],
'UpdateIpamResourceDiscovery' => [
'summary' => 'Modifies a resource discovery instance.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryId',
'in' => 'query',
'schema' => ['description' => 'The ID of the resource discovery instance.', 'type' => 'string', 'required' => true, 'example' => 'ipam-res-disco-jt5f2af2u6nk2z321****', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryName',
'in' => 'query',
'schema' => ['description' => 'The name of the resource discovery.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IpamResourceDiscoveryDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the resource discovery.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'AddOperatingRegion',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => 'The operating regions to add to the resource discovery.',
'type' => 'array',
'items' => ['description' => 'The operating region to add to the resource discovery.', 'type' => 'string', 'required' => false, 'example' => 'eu-central-1', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'RemoveOperatingRegion',
'in' => 'query',
'allowEmptyValue' => false,
'style' => 'repeatList',
'schema' => [
'description' => 'The operating regions to remove from the resource discovery.',
'type' => 'array',
'items' => ['description' => 'The operating region to remove from the resource discovery.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''],
'required' => false,
'maxItems' => 100,
'minItems' => 1,
'title' => '',
'example' => '',
],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. Checks parameters, syntax, and quotas and limits, with no changes being made. Returns DryRunOperation if validation succeeds; otherwise returns an error.'."\n"
."\n"
.'- **false** (default): Sends the request. On success, returns a 2xx status and performs the operation.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'Ensures idempotency. Provide a unique ASCII token generated by your client. A new token is provided for each distinct request.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'PlainResult<IpamCreateModel>',
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BB2C39DE-CEB8-595A-981A-F2EFCBE7324E', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParam.OperatingRegion', 'errorMessage' => 'The operating region is invalid.', 'description' => 'The operating region is invalid.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
['errorCode' => 'OperationDenied.OperateShareResource', 'errorMessage' => 'The operation is not allowed because the instance is a shared resource.', 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['errorCode' => 'OperationDenied.UnexpectedType', 'errorMessage' => 'The operation is not allowed because the input type is unexpected.', 'description' => 'The operation is not allowed because the input type is unexpected.'],
['errorCode' => 'OperationDenied.RemoveResourceDiscoveryHomeRegion', 'errorMessage' => 'The home region of IPAM resource discovery cannot be removed.', 'description' => 'The home region of IPAM resource discovery cannot be removed.'],
['errorCode' => 'ResourceNotFound.IpamResourceDiscovery', 'errorMessage' => 'The dependent instance of IPAM resource discovery is not found.', 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateIpamResourceDiscovery',
'description' => '- You can add or remove operating regions only for custom resource discovery instances.'."\n"
."\n"
.'- When you remove an operating region from a resource discovery instance, you cannot remove the managed region of the resource discovery instance.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamResourceDiscovery'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BB2C39DE-CEB8-595A-981A-F2EFCBE7324E\\"\\n}","type":"json"}]',
],
'UpdateIpamScope' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'RegionId',
'in' => 'query',
'schema' => ['description' => 'The ID of the region where the IPAM is hosted. Call the [DescribeRegions](~~36063~~) operation to get the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''],
],
[
'name' => 'IpamScopeId',
'in' => 'query',
'schema' => ['description' => 'The ID of the IPAM scope.', 'type' => 'string', 'required' => true, 'example' => 'ipam-scope-glfmcyldpm8lsy****', 'title' => ''],
],
[
'name' => 'IpamScopeName',
'in' => 'query',
'schema' => ['description' => 'The name of the IPAM scope.'."\n"
."\n"
.'The name must be 1 to 128 characters long and cannot start with `http://` or `https://`.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''],
],
[
'name' => 'IpamScopeDescription',
'in' => 'query',
'schema' => ['description' => 'The description of the IPAM scope.'."\n"
."\n"
.'The description must be 1 to 256 characters long. It must start with a letter and cannot start with `http://` or `https://`. If you do not specify this parameter, the value is not modified.', 'type' => 'string', 'required' => false, 'example' => 'test description', 'title' => ''],
],
[
'name' => 'DryRun',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to perform a dry run. Valid values:'."\n"
."\n"
.'- **true**: Performs a dry run. The system checks the request for potential issues, including missing required parameters, incorrect request format, and instance status. If the request fails the dry run, an error is returned. If the request passes the dry run, the DryRunOperation error code is returned.'."\n"
."\n"
.'- **false** (Default): Sends a normal request. After the request passes the check, the operation is performed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. Generate a value for this parameter that is unique among different requests. The token can contain only ASCII characters.'."\n"
."\n"
.'> If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is unique.', 'type' => 'string', 'required' => false, 'example' => '123e4567-e89b-12d3-a456-426655440000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BaseResult',
'description' => 'The response.',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'BA8054F5-852A-570A-ACFF-BCA63E0B02D5', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ResourceNotFound.IpamScope', 'errorMessage' => 'The specified resource of IPAM scope is not found.', 'description' => 'The input IPAM scope does not exist.'],
['errorCode' => 'IncorrectStatus.IpamScope', 'errorMessage' => 'The status of the IPAM scope is incorrect.', 'description' => 'The status of the IPAM scope is incorrect.'],
['errorCode' => 'DryRunOperation', 'errorMessage' => 'Request validation has been passed with DryRun flag set.', 'description' => ''],
],
],
'title' => 'UpdateIpamScope',
'summary' => 'Updates the basic information of an IPAM scope.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamScope'],
],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA8054F5-852A-570A-ACFF-BCA63E0B02D5\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-northeast-1.aliyuncs.com', 'endpoint' => 'vpcipam.ap-northeast-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-northeast-2.aliyuncs.com', 'endpoint' => 'vpcipam.ap-northeast-2.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-southeast-1.aliyuncs.com', 'endpoint' => 'vpcipam.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-southeast-2.aliyuncs.com', 'endpoint' => 'vpcipam.ap-southeast-2.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-southeast-3.aliyuncs.com', 'endpoint' => 'vpcipam.ap-southeast-3.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-southeast-5.aliyuncs.com', 'endpoint' => 'vpcipam.ap-southeast-5.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-southeast-6.aliyuncs.com', 'endpoint' => 'vpcipam.ap-southeast-6.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.ap-southeast-7.aliyuncs.com', 'endpoint' => 'vpcipam.ap-southeast-7.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-beijing.aliyuncs.com', 'endpoint' => 'vpcipam.cn-beijing.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-chengdu.aliyuncs.com', 'endpoint' => 'vpcipam.cn-chengdu.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-fuzhou', 'regionName' => 'China (Fuzhou - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-fuzhou.aliyuncs.com', 'endpoint' => 'vpcipam.cn-fuzhou.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-guangzhou.aliyuncs.com', 'endpoint' => 'vpcipam.cn-guangzhou.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-hangzhou.aliyuncs.com', 'endpoint' => 'vpcipam.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-heyuan.aliyuncs.com', 'endpoint' => 'vpcipam.cn-heyuan.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-hongkong.aliyuncs.com', 'endpoint' => 'vpcipam.cn-hongkong.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-huhehaote.aliyuncs.com', 'endpoint' => 'vpcipam.cn-huhehaote.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-nanjing', 'regionName' => 'China (Nanjing - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-nanjing.aliyuncs.com', 'endpoint' => 'vpcipam.cn-nanjing.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-qingdao.aliyuncs.com', 'endpoint' => 'vpcipam.cn-qingdao.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-shanghai.aliyuncs.com', 'endpoint' => 'vpcipam.cn-shanghai.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-shenzhen.aliyuncs.com', 'endpoint' => 'vpcipam.cn-shenzhen.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-wuhan-lr', 'regionName' => 'China (Wuhan - Local Region)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-wuhan-lr.aliyuncs.com', 'endpoint' => 'vpcipam.cn-wuhan-lr.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'vpcipam.cn-wulanchabu.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'vpcipam.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'vpcipam.cn-zhangjiakou.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'vpcipam.us-west-1.aliyuncs.com', 'endpoint' => 'vpcipam.us-west-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'vpcipam.us-east-1.aliyuncs.com', 'endpoint' => 'vpcipam.us-east-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'vpcipam.eu-west-1.aliyuncs.com', 'endpoint' => 'vpcipam.eu-west-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'vpcipam.eu-central-1.aliyuncs.com', 'endpoint' => 'vpcipam.eu-central-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'vpcipam.me-east-1.aliyuncs.com', 'endpoint' => 'vpcipam.me-east-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'vpcipam.me-central-1.aliyuncs.com', 'endpoint' => 'vpcipam.me-central-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'vpcipam.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'vpcipam.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'vpcipam.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'vpcipam.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'vpcipam.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'vpcipam.cn-hangzhou-finance.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'vpcipam.cn-beijing-finance-1.aliyuncs.com', 'endpoint' => 'vpcipam.cn-beijing-finance-1.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'DependencyViolation.CustomCidrs', 'message' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', 'http_code' => 400, 'description' => 'The specified resource is dependent on other resources and the current operation is not allowed.'],
['code' => 'DependencyViolation.CustomPoolAllocation', 'message' => 'The operation is not allowed because the IpamPool has custom pool allocation dependency.', 'http_code' => 400, 'description' => 'The IpamPool cannot be deleted because it has custom pool allocation dependency.'],
['code' => 'DependencyViolation.IpamMembers', 'message' => 'The IPAM [%s] has managed members [%s], so the IPAM cannot be deleted.', 'http_code' => 400, 'description' => 'IPAM[%s] has managed member [%s], this IPAM cannot be deleted.'],
['code' => 'DependencyViolation.IpamPool', 'message' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', 'http_code' => 400, 'description' => 'The specified resource is dependent on other resources and the current operation is not allowed.'],
['code' => 'DependencyViolation.PoolCidr', 'message' => 'The operation is not allowed because the IpamPool has pool CIDR dependency %s.', 'http_code' => 400, 'description' => 'The IpamPool cannot be deleted because it has pool CIDR dependency %s.'],
['code' => 'DependencyViolation.ShareResource', 'message' => 'The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.', 'http_code' => 400, 'description' => 'The specified resource of IPAM pool depends on resource sharing, so the operation cannot be completed.'],
['code' => 'DependencyViolation.ShareResource', 'message' => 'The operation is not allowed because the default resource discovery of this IPAM is sharing.', 'http_code' => 400, 'description' => 'The operation is not allowed because the default resource discovery of this IPAM is sharing.'],
['code' => 'DependencyViolation.ShareResource', 'message' => 'The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.', 'http_code' => 400, 'description' => 'The specified resource of IPAM resource discovery depends on resource sharing, so the operation cannot be completed.'],
['code' => 'DependencyViolation.SubCidr', 'message' => 'The specified resource of %s depends on %s, so the operation cannot be completed.', 'http_code' => 400, 'description' => 'The specified resource is dependent on other resources and the current operation is not allowed.'],
['code' => 'DryRunOperation', 'message' => 'Request validation has been passed with DryRun flag set.', 'http_code' => 400, 'description' => ''],
['code' => 'DuplicatedParam.TagKey', 'message' => 'TagKey duplicate.', 'http_code' => 400, 'description' => 'TagKey parameter duplicate'],
['code' => 'Forbidden.IpResourceAccess', 'message' => 'The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s.', 'http_code' => 400, 'description' => 'The IPAM resource discovery instance in the parameters is not allowed to access the IP address of resource %s.'],
['code' => 'Forbidden.QueryShareResource', 'message' => 'Authentication is failed for querying a shared IPAM pool.', 'http_code' => 400, 'description' => 'Authentication is failed for querying a shared IPAM pool.'],
['code' => 'Forbidden.RAM', 'message' => 'The user is not authorized to operate on the specified resource, or the API operation does not support RAM.', 'http_code' => 400, 'description' => 'The user is not authorized to operate on the specified resource, or the API operation does not support RAM.'],
['code' => 'Forbidden.SubPool', 'message' => 'The IPAM pool contains subpools.', 'http_code' => 400, 'description' => 'The IPAM address pool contains subpools and cannot be deleted.'],
['code' => 'IllegalParam.AllocationDefaultNetmask', 'message' => 'The specified AllocationDefaultNetmask is illegal.', 'http_code' => 400, 'description' => 'AllocationDefaultNetmask parameter is illegal.'],
['code' => 'IllegalParam.AllocationMaxNetmask', 'message' => 'The specified AllocationMaxNetmask is illegal.', 'http_code' => 400, 'description' => 'AllocationMaxNetmask parameter is illegal.'],
['code' => 'IllegalParam.AllocationMinNetmask', 'message' => 'The specified AllocationMinNetmask is illegal.', 'http_code' => 400, 'description' => 'AllocationMinNetmask parameter is illegal.'],
['code' => 'IllegalParam.Cidr', 'message' => 'The specified CIDR is illegal.', 'http_code' => 400, 'description' => 'The CIDR block is invalid.'],
['code' => 'IllegalParam.CidrMask', 'message' => 'The specified CidrMask is illegal.', 'http_code' => 400, 'description' => 'Invalid CidrMask.'],
['code' => 'IllegalParam.IpamPool', 'message' => 'The specified IPAM pool cannot be empty.', 'http_code' => 400, 'description' => 'The IPAM pool cannot be empty.'],
['code' => 'IllegalParam.Ipv6Isp', 'message' => 'The specified Ipv6Isp is illegal.', 'http_code' => 400, 'description' => 'The specified Ipv6Isp is illegal.'],
['code' => 'IllegalParam.IpVersion', 'message' => 'The specified IpVersion is illegal.', 'http_code' => 400, 'description' => 'Invalid IpVersion.'],
['code' => 'IllegalParam.NetmaskLength', 'message' => 'The specified NetmaskLength is illegal.', 'http_code' => 400, 'description' => 'The specified NetmaskLength is illegal.'],
['code' => 'IllegalParam.OperatingRegion', 'message' => 'The operating region is invalid.', 'http_code' => 400, 'description' => 'The operating region is invalid.'],
['code' => 'IllegalParam.PoolRegionId', 'message' => 'The specified PoolRegionId is illegal.', 'http_code' => 400, 'description' => 'PoolRegionId parameter is illegal.'],
['code' => 'IllegalParam.ResourceGroupId', 'message' => 'The input parameter ResourceGroupId is invalid.', 'http_code' => 400, 'description' => 'The parameter ResourceType is illegal.'],
['code' => 'IllegalParam.ResourceRegion', 'message' => 'The input parameter ResourceRegionId is invalid.', 'http_code' => 400, 'description' => 'The input parameter ResourceRegionId is invalid.'],
['code' => 'IllegalParam.ResourceType', 'message' => 'The input parameter ResourceType is invalid.', 'http_code' => 400, 'description' => 'Parameter ResourceType.'],
['code' => 'IllegalParam.TagKey', 'message' => 'The input parameter TagKey is invalid.', 'http_code' => 400, 'description' => 'Illegal parameter TagKey.'],
['code' => 'IllegalParamFormat.%s', 'message' => 'The param of %s is illegal.', 'http_code' => 400, 'description' => 'The param of %s is illegal.'],
['code' => 'IllegalParamSize.ResourceIds', 'message' => 'The number of Param ResourceIds exceeded the limit.', 'http_code' => 400, 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['code' => 'IllegalParamSize.Tags', 'message' => 'The number of Parameter Tags exceeded the limit.', 'http_code' => 400, 'description' => 'The number of ResourceIds parameters passed in exceeds the limit.'],
['code' => 'IncorrectStatus.IpamPool', 'message' => 'The status of the IPAM pool is incorrect.', 'http_code' => 400, 'description' => 'The status of the IPAM pool is incorrect.'],
['code' => 'IncorrectStatus.IpamResourceDiscovery', 'message' => 'The status of the IPAM resource discovery is incorrect.', 'http_code' => 400, 'description' => 'The status of the IPAM resource discovery is incorrect.'],
['code' => 'IncorrectStatus.IpamScope', 'message' => 'The status of the IPAM scope is incorrect.', 'http_code' => 400, 'description' => 'The status of the IPAM scope is incorrect.'],
['code' => 'Mismatch.ChildIpamScopeAndParentIpamScope', 'message' => 'The ChildIpamScope and ParentIpamScope are mismatched.', 'http_code' => 400, 'description' => 'The ChildIpamScope and ParentIpamScope are mismatched.'],
['code' => 'Mismatch.ChildIpv6IspAndParentIpv6Isp', 'message' => 'The ChildIpv6Isp and ParentIpv6Isp are mismatched.', 'http_code' => 400, 'description' => 'The ChildIpv6Isp and ParentIpv6Isp are mismatched.'],
['code' => 'Mismatch.ChildIpVersionAndParentIpVersion', 'message' => 'The ChildIpVersion and ParentIpVersion are mismatched.', 'http_code' => 400, 'description' => 'The ChildIpVersion and ParentIpVersion are mismatched.'],
['code' => 'Mismatch.ChildPoolRegionAndParentPoolRegion', 'message' => 'The ChildPoolRegion and ParentPoolRegion are mismatched.', 'http_code' => 400, 'description' => 'The ChildPoolRegion and ParentPoolRegion are mismatched.'],
['code' => 'Mismatch.CidrAndNetmaskLength', 'message' => 'The mask of the input Cidr is inconsistent with the input NetmaskLength.', 'http_code' => 400, 'description' => 'The mask of the input Cidr is inconsistent with the input NetmaskLength.'],
['code' => 'Mismatch.CidrAndPoolIpVersion', 'message' => 'The ip verion of input Cidr is inconsistent with that of the input IPAM pool.', 'http_code' => 400, 'description' => 'The ip verion of input Cidr is inconsistent with that of the input IPAM pool.'],
['code' => 'Mismatch.IpamResourceDiscoveryAndResource', 'message' => 'The IPAM resource discovery %s and the queried %s do not match.', 'http_code' => 400, 'description' => 'The IPAM resource discovery %s and the queried %s do not match.'],
['code' => 'Mismatch.IpamScopeAndSourceIpamPool', 'message' => 'The input source IPAM pool is not in the input IPAM scope.', 'http_code' => 400, 'description' => 'The input source IPAM pool is not in the input IPAM scope.'],
['code' => 'Mismatch.Ipv6IspAndSourceIpamPool', 'message' => 'The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.', 'http_code' => 400, 'description' => 'The input Ipv6Isp is inconsistent with the Ipv6Isp of the input source IPAM pool.'],
['code' => 'Mismatch.VpcIdAndVSwitchId', 'message' => 'VpcId and VSwitchId do not match.', 'http_code' => 400, 'description' => 'VpcId and VSwitchId do not match.'],
['code' => 'MissingParam.Cidr', 'message' => 'The Cidr must be input when adding CIDR for IPAM private top pool.', 'http_code' => 400, 'description' => 'The Cidr must be input when adding CIDR for IPAM private top pool.'],
['code' => 'MissingParam.CidrOrCidrMask', 'message' => 'The CIDR or CIDR Mask must be input.', 'http_code' => 400, 'description' => 'The CIDR or CIDR Mask must be input.'],
['code' => 'MissingParam.CidrOrNetmaskLength', 'message' => 'The Cidr or NetmaskLength must be input.', 'http_code' => 400, 'description' => 'The Cidr or NetmaskLength must be input.'],
['code' => 'MissingParam.IpamResourceDiscoveryId', 'message' => 'The IpamResourceDiscoveryId must be input.', 'http_code' => 400, 'description' => 'The IpamResourceDiscoveryId must be input.'],
['code' => 'MissingParam.ResourceRegionId', 'message' => 'The ResourceRegionId must be input.', 'http_code' => 400, 'description' => 'The ResourceRegionId must be input.'],
['code' => 'MissingParam.VpcIdAndVSwitchId', 'message' => 'VpcId and VSwitchId cannot both be empty please provide at least one.', 'http_code' => 400, 'description' => 'VpcId and VSwitchId cannot both be empty please provide at least one.'],
['code' => 'MissingParameter.ResourceIds', 'message' => 'The input parameter ResourceIds that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'Parameter ResourceIds not passed in.'],
['code' => 'MissingParameter.ResourceType', 'message' => 'The input parameter ResourceType that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'Parameter ResourceType not passed in.'],
['code' => 'MissingParameter.TagKey', 'message' => 'The input parameter TagKey that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The parameter Tags was not passed in.'],
['code' => 'MissingParameter.Tags', 'message' => 'The input parameter Tags that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'Parameter ResourceType not passed in.'],
['code' => 'MissingParameter.TagsAndResourceIds', 'message' => 'The input parameter Tags and ResourceIds that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The Tags and ResourceIds parameters are not passed in.'],
['code' => 'MissingParameter.TagValue', 'message' => 'The input parameter TagValue that is mandatory for processing this request is not supplied.', 'http_code' => 400, 'description' => 'The parameter Tags was not passed in.'],
['code' => 'OperationDenied.AccountNotRDEntity', 'message' => 'The operation is not allowed because the caller does not belong to the resource directory.', 'http_code' => 400, 'description' => 'The caller does not belong to any resource directory and is not allowed to manage IPAM trusted service members.'],
['code' => 'OperationDenied.AutoImportNeedPoolRegion', 'message' => 'The automatic import is not supported for the IPAM pool whose pool region is empty.', 'http_code' => 400, 'description' => 'The automatic import is not supported for the IPAM pool whose pool region is empty.'],
['code' => 'OperationDenied.AvailableCidrInsufficient', 'message' => 'The operation is not allowed because available CIDR is insufficient.', 'http_code' => 400, 'description' => 'The operation is not allowed because available CIDR is insufficient.'],
['code' => 'OperationDenied.CidrConflictWithExistAllocation', 'message' => 'The operation is not allowed because the input CIDR conflicts with the existing allocation.', 'http_code' => 400, 'description' => 'The specified CIDR block conflicts with an existing CIDR block.'],
['code' => 'OperationDenied.CidrConflictWithOfficialGuaCidrs', 'message' => 'The operation is not allowed because the input CIDR conflicts with official GUA CIDRs.', 'http_code' => 400, 'description' => 'The operation is not allowed because the input CIDR conflicts with official GUA CIDRs.'],
['code' => 'OperationDenied.CidrConflictWithTopCidrs', 'message' => 'The operation is not allowed because the input CIDR conflicts with existing top CIDRs.', 'http_code' => 400, 'description' => 'The operation is not allowed because the input CIDR conflicts with existing top CIDRs.'],
['code' => 'OperationDenied.CidrInExcludeCidrs', 'message' => 'The operation is not allowed because the input CIDR is within the illegal CIDRs.', 'http_code' => 400, 'description' => 'The operation is not allowed because the input CIDR is within the illegal CIDRs.'],
['code' => 'OperationDenied.CidrMaskTooLarge', 'message' => 'The operation is denied because the CIDR mask %s is larger than the allocationMaxNetmask %s of the pool.', 'http_code' => 400, 'description' => 'The operation is denied because the CIDR mask %s is larger than the allocationMaxNetmask %s of the pool.'],
['code' => 'OperationDenied.CidrMaskTooLarge', 'message' => 'The operation is not allowed because the CIDR mask length %s is larger than the maximum allowed %s.', 'http_code' => 400, 'description' => 'The CIDR mask length %s is larger than the maximum allowed value %s.'],
['code' => 'OperationDenied.CidrMaskTooSmall', 'message' => 'The operation is denied because the CIDR mask %s is less than the allocationMinNetmask %s of the pool.', 'http_code' => 400, 'description' => 'The operation is denied because the CIDR mask %s is less than the allocationMinNetmask %s of the pool.'],
['code' => 'OperationDenied.CidrMaskTooSmall', 'message' => 'The operation is not allowed because the CIDR mask length %s is smaller than the minimum allowed %s.', 'http_code' => 400, 'description' => 'The CIDR mask length %s is smaller than the minimum allowed value %s.'],
['code' => 'OperationDenied.CidrNotInSourceCidr', 'message' => 'The operation is not allowed because the input CIDR is not in source CIDR.', 'http_code' => 400, 'description' => 'The specified CIDR block does not fall within the CIDR range of the parent pool.'],
['code' => 'OperationDenied.CidrUnavailableInPool', 'message' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.', 'http_code' => 400, 'description' => 'The operation is not allowed because the CIDR is unavailable in the IPAM pool.'],
['code' => 'OperationDenied.CreateVpcOrAssociateVpcCidrBlock', 'message' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.', 'http_code' => 400, 'description' => 'The operation is denied because you cannot create a VPC or add a secondary CIDR block to a VPC from a pool that does not have the region attribute.'],
['code' => 'OperationDenied.DelegateAdminAsMember', 'message' => 'The operation is not allowed because the IPAM delegate administrator cannot be a member.', 'http_code' => 400, 'description' => 'IPAM delegated administrators cannot add themselves as members of the IPAM trusted service.'],
['code' => 'OperationDenied.DeleteDefaultScope', 'message' => 'The operation is not allowed because of deleting default scope.', 'http_code' => 400, 'description' => 'The operation was denied because the default IPAM scope was deleted.'],
['code' => 'OperationDenied.DissociateSelfSystemIpamResourceDiscovery', 'message' => 'The operation is not allowed because the default resource discovery cannot be disassociated.', 'http_code' => 400, 'description' => 'The operation is not allowed because the default resource discovery cannot be disassociated.'],
['code' => 'OperationDenied.IpamNotExist', 'message' => 'The operation is not allowed because the IPAM does not exist.', 'http_code' => 400, 'description' => 'IPAM does not exist in the current region. IPAM trusted service members cannot be managed.'],
['code' => 'OperationDenied.IpamPoolAllocationExist', 'message' => 'The operation is not allowed because of the existence of IPAM pool allocation.', 'http_code' => 400, 'description' => 'The operation is not allowed because an allocation exists.'],
['code' => 'OperationDenied.IpamPoolAllocationExist', 'message' => 'The operation is not allowed because the IpamPool has existing allocations.', 'http_code' => 400, 'description' => 'The IpamPool cannot be deleted because it has existing allocations.'],
['code' => 'OperationDenied.IpamPoolNotInRegion', 'message' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.', 'http_code' => 400, 'description' => 'The operation is not allowed because the IPAM pool not in specific region does not support creating VPC or associating CIDR for VPC.'],
['code' => 'OperationDenied.IpamPublicIpv6PoolNeedPoolRegion', 'message' => 'The public IPv6 pool cannot be created in IPAM when its pool region is empty.', 'http_code' => 400, 'description' => 'The public IPv6 pool cannot be created in IPAM when its pool region is empty.'],
['code' => 'OperationDenied.IpamRDServiceAlreadyEnabledInOtherRegion', 'message' => 'The operation is not allowed because the IPAM Resource Directory service is already enabled in another region.', 'http_code' => 400, 'description' => 'Only one IPAM instance can be selected to manage resource directory members.'],
['code' => 'OperationDenied.IpamRDServiceMemberNotExist', 'message' => 'The operation is not allowed because %s is not managed by the IPAM.', 'http_code' => 400, 'description' => 'The member %s to be removed from the input parameter is not managed by IPAM trusted service.'],
['code' => 'OperationDenied.IpamRDServiceNotEnableInOperationRegion', 'message' => 'The operation is not allowed because the IPAM RD service is not enabled in the current region.', 'http_code' => 400, 'description' => 'The IPAM instance in the operating region does not manage any resource directory members.'],
['code' => 'OperationDenied.IpamRegionCannotBeRemoved', 'message' => 'The IPAM region cannot be removed.', 'http_code' => 400, 'description' => 'The IPAM region cannot be removed.'],
['code' => 'OperationDenied.IpamRegionNotSupportGetPoolAllocation', 'message' => 'The operation is not allowed because IPAM region does not support getting the allocation.', 'http_code' => 400, 'description' => 'The operation is not allowed because IPAM region does not support getting the allocation.'],
['code' => 'OperationDenied.IpamRegionNotSupportGetPoolAvailableCidr', 'message' => 'The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.', 'http_code' => 400, 'description' => 'The operation is not allowed because IPAM region does not support getting available CIDR of IPAM pool.'],
['code' => 'OperationDenied.IpamRegionNotSupportListPoolAllocation', 'message' => 'The operation is not allowed because IPAM region does not support listing allocations.', 'http_code' => 400, 'description' => 'The operation is not allowed because IPAM region does not support listing allocations.'],
['code' => 'OperationDenied.IpamResourceDiscoveryAlreadySharedWithAdmin', 'message' => 'The operation is not allowed because the resource discovery has been shared with the IPAM delegated administrator by %s.', 'http_code' => 400, 'description' => 'The IPAM Trusted Service does not allow the management of accounts that have already shared their resource discovery with the delegated administrator.'],
['code' => 'OperationDenied.Ipv6VpcNotSupport', 'message' => 'The allocation of IPv6 VPC is not supported to delete.', 'http_code' => 400, 'description' => 'The allocation of IPv6 VPC is not supported to delete.'],
['code' => 'OperationDenied.MemberExistInIpamRDService', 'message' => 'The operation is not allowed because %s is under the management of the IPAM.', 'http_code' => 400, 'description' => 'The input parameter %s has already been managed by IPAM trusted service. The same member cannot be managed repeatedly.'],
['code' => 'OperationDenied.MemberIdNotMatchMemberType', 'message' => 'The operation is not allowed because the Member ID and Member Type of members [%s] in the input parameters do not match.', 'http_code' => 400, 'description' => 'The Member Id and Member Type of [%s] in the input Members do not match.'],
['code' => 'OperationDenied.NoServicePrincipalAdminPrivileges', 'message' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', 'http_code' => 400, 'description' => 'The caller is not the delegated administrator of the IPAM trusted service in the resource directory. IPAM trusted service members are not allowed to be managed.'],
['code' => 'OperationDenied.NotDelegatedAdminAccount', 'message' => 'The operation is not allowed because the caller is not the delegated IPAM admin for the resource directory.', 'http_code' => 400, 'description' => 'The caller is not the delegated administrator of the IPAM trusted service in the resource directory. IPAM trusted service members are not allowed to be managed.'],
['code' => 'OperationDenied.OfficialCidrInsufficient', 'message' => 'The operation is not allowed because the official CIDR is insufficient.', 'http_code' => 400, 'description' => 'The operation is not allowed because the official CIDR is insufficient.'],
['code' => 'OperationDenied.OfficialCidrTmpUnavailable', 'message' => 'The operation is not allowed because the official CIDR is temporarily unavailable.', 'http_code' => 400, 'description' => 'The operation is not allowed because the official CIDR is temporarily unavailable.'],
['code' => 'OperationDenied.OfficialCidrUnavailable', 'message' => 'The operation is not allowed because the official CIDR is unavailable.', 'http_code' => 400, 'description' => 'The operation is not allowed because the official CIDR is unavailable.'],
['code' => 'OperationDenied.OperateShareResource', 'message' => 'The operation is not allowed because the instance is a shared resource.', 'http_code' => 400, 'description' => 'The operation is not allowed because the instance is a shared resource.'],
['code' => 'OperationDenied.OperatingRegionsNeedIncludeHomeRegion', 'message' => 'The operating regions do not contain home region.', 'http_code' => 400, 'description' => 'The operating regions do not contain home region.'],
['code' => 'OperationDenied.OwnerAlreadyManagedByRecipientIpam', 'message' => 'The operation is not allowed because the resource owner is already managed by the resource recipient\'s IPAM.', 'http_code' => 400, 'description' => 'IPAM-managed member accounts are prohibited from sharing resource discovery with the IPAM delegated administrator.'],
['code' => 'OperationDenied.PoolRegionNotSupportAddPoolCidr', 'message' => 'The operation is not allowed because pool region does not support adding CIDR.', 'http_code' => 400, 'description' => 'The operation was not allowed because the operation to add CIDR could not be performed in the region.'],
['code' => 'OperationDenied.PoolRegionNotSupportDeletePool', 'message' => 'The operation is not allowed because of pool region not support delete.', 'http_code' => 400, 'description' => 'The operation was denied because the delete address pool operation could not be performed in the domain.'],
['code' => 'OperationDenied.PoolRegionNotSupportDeletePoolCidr', 'message' => 'The operation is not allowed because pool region does not support deleting cidr.', 'http_code' => 400, 'description' => 'You cannot delete CIDR blocks in this region.'],
['code' => 'OperationDenied.PoolRegionNotSupportListPoolCidr', 'message' => 'The operation is not allowed because pool region does not support listing cidrs.', 'http_code' => 400, 'description' => 'You cannot query CIDR blocks in this region.'],
['code' => 'OperationDenied.PoolRegionNotSupportUpdatePool', 'message' => 'The operation is not allowed because of pool region not support update.', 'http_code' => 400, 'description' => 'The operation was denied because the update address pool operation could not be performed in the domain'],
['code' => 'OperationDenied.RemoveResourceDiscoveryHomeRegion', 'message' => 'The home region of IPAM resource discovery cannot be removed.', 'http_code' => 400, 'description' => 'The home region of IPAM resource discovery cannot be removed.'],
['code' => 'OperationDenied.RequestRegionInvalid', 'message' => 'The operation is not allowed because the request is not invoked in the region of the IPAM pool.', 'http_code' => 400, 'description' => 'The operation is not called in the region of the pool.'],
['code' => 'OperationDenied.ResourceDiscoveryAlreadyAssociated', 'message' => 'You cannot associate the resource discovery because an association already exists.', 'http_code' => 400, 'description' => 'You cannot associate the resource discovery because an association already exists.'],
['code' => 'OperationDenied.ResourceRegionInvalid', 'message' => 'The operation is denied because the resource is in a different region than the IPAM pool.', 'http_code' => 400, 'description' => 'The resource and the pool are in different regions.'],
['code' => 'OperationDenied.ResourceShareExist', 'message' => 'The operation is not allowed because the resource sharing already exists.', 'http_code' => 400, 'description' => 'The operation is not allowed because the resource sharing already exists.'],
['code' => 'OperationDenied.ResourceTypeIsNotCustom', 'message' => 'The operation is not allowed because the resource type is not Custom.', 'http_code' => 400, 'description' => 'The operation is not allowed because the resource type is not Custom.'],
['code' => 'OperationDenied.SharedResourceDiscoveryAssociated', 'message' => 'The operation is not allowed because the IPAM is associated with a shared resource discovery.', 'http_code' => 400, 'description' => 'The operation is not allowed because the IPAM is associated with a shared resource discovery.'],
['code' => 'OperationDenied.SourceCidrIsNull', 'message' => 'The operation is not allowed because the source CIDR is null.', 'http_code' => 400, 'description' => 'The parent pool does not have a CIDR block.'],
['code' => 'OperationDenied.Unauthorized', 'message' => 'The operation is denied because the user is not authorized.', 'http_code' => 400, 'description' => 'The operation is denied because the user is not authorized.'],
['code' => 'OperationDenied.UnexpectedResourceType', 'message' => 'The operation is not allowed because the resource type is unexpected.', 'http_code' => 400, 'description' => 'The operation is not allowed because the resource type is unexpected.'],
['code' => 'OperationDenied.UnexpectedType', 'message' => 'The operation is not allowed because the input type is unexpected.', 'http_code' => 400, 'description' => 'The operation is not allowed because the input type is unexpected.'],
['code' => 'OperationFailed.AccountBalanceInsufficient', 'message' => 'The account balance of this user is insufficient to place the order.', 'http_code' => 400, 'description' => 'The account balance of this user is insufficient to place the order.'],
['code' => 'OperationFailed.AliGroupUserCanNotBuyInnerCommodity', 'message' => 'IPAM has no group cloud product label, and users within the group are not allowed to purchase.', 'http_code' => 400, 'description' => 'IPAM does not have a merchandise tag and cannot be purchased by an internal group user.'],
['code' => 'OperationFailed.BasicInfoUncompleted', 'message' => 'You have not completed your basic personal information, please complete the information and try again.', 'http_code' => 400, 'description' => 'Your basic information is incomplete. Specify the information and try again.'],
['code' => 'OperationFailed.ExceedPurchaseLimit', 'message' => 'You have reached the limit of purchase quantity.', 'http_code' => 400, 'description' => 'The purchase limit is reached.'],
['code' => 'OperationFailed.IpamPoolExist', 'message' => 'The operation is failed because user IPAM pool exist.', 'http_code' => 400, 'description' => 'The operation failed because IPAM has a user-created address pool.'],
['code' => 'OperationFailed.IpamScopeExist', 'message' => 'The operation is failed because user IPAM scope exist.', 'http_code' => 400, 'description' => 'The operation failed because a user-defined scope exists.'],
['code' => 'OperationFailed.OperatingRegionsNeedIncludeIpamRegion', 'message' => 'The operating regions do not contain IPAM region.', 'http_code' => 400, 'description' => 'The operating regions do not contain IPAM region.'],
['code' => 'OptInRequired.Ipam', 'message' => 'You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.', 'http_code' => 400, 'description' => 'You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.'],
['code' => 'Order.NoRealNameAuthentication', 'message' => 'Real-name verification has not been completed for the account.', 'http_code' => 400, 'description' => 'You have not performed real-name authentication. Please go to the account center to complete real-name authentication.'],
['code' => 'QuotaExceeded.IpamCidrQuotaPerIpamPool', 'message' => 'The quota of ipamCidrQuotaPerIpamPool count is exceeded.', 'http_code' => 400, 'description' => 'The number of CIDR blocks in the IPAM pool exceeds the upper limit.'],
['code' => 'QuotaExceeded.IpamPoolQuotaDepth', 'message' => 'The quota of IpamPoolQuotaDepth count is exceeded.', 'http_code' => 400, 'description' => 'Maximum number of IPAM address pool depth allowed exceeds limit'],
['code' => 'QuotaExceeded.IpamPublicIpv6TopPoolQuotaPerRegionIsp', 'message' => 'The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.', 'http_code' => 400, 'description' => 'The number of public IPv6 top pool in IPAM for this ISP owned by the user in this region exceeds the limit.'],
['code' => 'QuotaExceeded.IpamQuotaPerRegion', 'message' => 'The quota of ipamQuotaPerRegion count is exceeded.', 'http_code' => 400, 'description' => 'The maximum number allowed by IPAM exceeds the limit.'],
['code' => 'QuotaExceeded.IpamResourceDiscoveryQuotaPerRegion', 'message' => 'The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.', 'http_code' => 400, 'description' => 'The number of non-shared IPAM resource discoveries owned by the user in this region exceeds the limit.'],
['code' => 'QuotaExceeded.IpamScopeQuotaPerIpam', 'message' => 'The quota of ipamScopeQuotaPerIpam count is exceeded.', 'http_code' => 400, 'description' => 'The maximum number allowed for the IPAM scope of action exceeds the limit.'],
['code' => 'QuotaExceeded.IpamSubPoolQuotaPerIpamPool', 'message' => 'The quota of ipamSubPoolQuotaPerIpamPool count is exceeded.', 'http_code' => 400, 'description' => 'The number of sub-pools for the IPAM pool exceeds the limit.'],
['code' => 'QuotaExceeded.MemberAccount', 'message' => 'The operation is not allowed because the number of % managed by IPAM has exceeded the limit, %s/%s.', 'http_code' => 400, 'description' => 'The member account managed by IPAM trusted service exceeds the quota limit.'],
['code' => 'QuotaExceeded.ResourceSharePerIpamPool', 'message' => 'The IPAM pool exceeds the limit for sharing.', 'http_code' => 400, 'description' => 'The IPAM pool exceeds the limit for sharing.'],
['code' => 'QuotaExceeded.ResourceSharePerIpamResourceDiscovery', 'message' => 'The IPAM resource discovery exceeds the limit for sharing.', 'http_code' => 400, 'description' => 'The IPAM resource discovery exceeds the limit for sharing.'],
['code' => 'QuotaExceeded.SharedIpamPoolPerUser', 'message' => 'The number of shared IPAM pools owned by a user exceeds the limit.', 'http_code' => 400, 'description' => 'The number of shared IPAM pools owned by a user exceeds the limit.'],
['code' => 'QuotaExceeded.SharedIpamResourceDiscoveryPerUser', 'message' => 'The number of shared IPAM resource discoveries owned by a user exceeds the limit.', 'http_code' => 400, 'description' => 'The number of shared IPAM resource discoveries owned by a user exceeds the limit.'],
['code' => 'ResourceNotEnough.IpamPoolCidr', 'message' => 'The specified resource of IPAM pool CIDR is not enough.', 'http_code' => 400, 'description' => 'The specified resource of IPAM pool CIDR is not enough.'],
['code' => 'ResourceNotFound.Ipam', 'message' => 'The specified resource of ipam is not found.', 'http_code' => 400, 'description' => 'The IPAM entered does not exist.'],
['code' => 'ResourceNotFound.IpamDiscoveredResource', 'message' => 'The queried %s is not found among IPAM discovered resources.', 'http_code' => 400, 'description' => 'The queried %s is not found among IPAM discovered resources.'],
['code' => 'ResourceNotFound.IpamDiscoveredResource.Vpc', 'message' => 'The queried VPC %s is not found among IPAM discovered resources.', 'http_code' => 400, 'description' => 'The queried VPC %s is not found among IPAM discovered resources.'],
['code' => 'ResourceNotFound.IpamDiscoveredResource.VSwitch', 'message' => 'The queried VSwitch %s is not found among IPAM discovered resources.', 'http_code' => 400, 'description' => 'The queried VSwitch %s is not found among IPAM discovered resources.'],
['code' => 'ResourceNotFound.IpamPool', 'message' => 'The dependent IPAM pool is not found.', 'http_code' => 404, 'description' => 'The IPAM pool does not exist.'],
['code' => 'ResourceNotFound.IpamPoolAllocation', 'message' => 'The specified resource of IPAM pool allocation is not found.', 'http_code' => 400, 'description' => 'The specified allocation does not exist.'],
['code' => 'ResourceNotFound.IpamPoolCidr', 'message' => 'The specified resource of IPAM pool CIDR is not found.', 'http_code' => 400, 'description' => 'The CIDR block of the IPAM pool does not exist.'],
['code' => 'ResourceNotFound.IpamResourceDiscovery', 'message' => 'The dependent instance of IPAM resource discovery is not found.', 'http_code' => 400, 'description' => 'The dependent instance of IPAM resource discovery is not found.'],
['code' => 'ResourceNotFound.IpamScope', 'message' => 'The specified resource of IPAM scope is not found.', 'http_code' => 400, 'description' => 'The input IPAM scope does not exist.'],
['code' => 'ResourceNotFound.ResourceDiscoveryAssociation', 'message' => 'You cannot disassociate from the resource discovery because no association exists.', 'http_code' => 400, 'description' => 'You cannot disassociate from the resource discovery because no association exists.'],
['code' => 'ResourceNotFound.SourceIpamPool', 'message' => 'The dependent source IPAM pool is not found.', 'http_code' => 400, 'description' => 'The dependent resource source IPAM Pool does not exist.'],
['code' => 'UnsupportedFeature.AddCidrForIpamPrivateIpv6Pool', 'message' => 'Adding CIDR for IPAM private IPv6 pool is not supported for this user.', 'http_code' => 400, 'description' => 'Adding CIDR for IPAM private IPv6 pool is not supported for this user.'],
['code' => 'UnsupportedFeature.AddUlaCidrForIpamPublicIpv6Pool', 'message' => 'Adding ULA CIDR for IPAM public IPv6 pool is not supported.', 'http_code' => 400, 'description' => 'Adding ULA CIDR for IPAM public IPv6 pool is not supported.'],
['code' => 'UnsupportedFeature.Ipam', 'message' => 'IPAM is not supported in this region.', 'http_code' => 400, 'description' => 'The IPAM feature is not supported in this region.'],
['code' => 'UnsupportedFeature.IpamIpv6', 'message' => 'The feature of IPv6 is not supported in this region.', 'http_code' => 400, 'description' => 'The feature of IPv6 is not supported in this region.'],
['code' => 'UnsupportedFeature.IpamPublicIpv4Pool', 'message' => 'The feature of public IPv4 pool is not supported in IPAM.', 'http_code' => 400, 'description' => 'The feature of public IPv4 pool is not supported in IPAM.'],
['code' => 'UnsupportedFeature.Ipv6Isp', 'message' => 'The Ipv6Isp feature is not supported.', 'http_code' => 400, 'description' => 'The Ipv6Isp feature is not supported.'],
['code' => 'UnsupportedFeature.PublicIpamScopeType', 'message' => 'The feature of PublicIpamScopeType is not supported.', 'http_code' => 400, 'description' => 'The IPAM you specified does not support the creation of public scope.'],
['code' => 'UnsupportedRegion.Ipam', 'message' => 'Ipam is not supported in this region.', 'http_code' => 400, 'description' => 'IPAM is not supported in this region.'],
['code' => 'UnsupportedRegion.Ipv6Isp', 'message' => 'The current region does not support this feature.', 'http_code' => 400, 'description' => 'The current region does not support this feature.'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamResourceDiscoveryAssociations'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DissociateIpamResourceDiscovery'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamPools'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListTagResources'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpam'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UntagResources'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamPoolAllocations'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetVpcIpamServiceStatus'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamPoolCidrs'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AssociateIpamResourceDiscovery'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamPool'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamResourceDiscovery'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamPool'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamPoolAllocation'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamResourceCidrs'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamScope'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'OpenVpcIpamService'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamResourceDiscovery'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamPoolAllocation'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetIpamPoolNextAvailableCidr'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamPoolCidr'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AddIpamPoolCidr'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpam'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpams'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamPoolAllocation'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamScope'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetIpamPoolAllocation'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamResourceDiscoveries'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteIpamScope'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpam'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamDiscoveredResource'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'TagResources'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListIpamScopes'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateIpamResourceDiscovery'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ChangeResourceGroup'],
['threshold' => '300', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateIpamPool'],
],
],
'ram' => [
'productCode' => 'VpcIpam',
'productName' => 'Virtual Private Cloud',
'ramCodes' => ['vpc'],
'ramLevel' => 'RESOURCE',
'ramConditions' => [],
'ramActions' => [],
'resourceTypes' => [],
],
];
|