1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Agency', 'version' => '2022-12-16'],
'directories' => [
[
'children' => ['CreateCustomer', 'GetInviteStatus', 'GetUnassociatedCustomer', 'InviteSubAccount', 'ResendEmail', 'ListCountries'],
'type' => 'directory',
'title' => 'Customer invitation',
],
[
'children' => ['AutomaticWriteOff', 'CustomerQuotaRecordList', 'DeductOutstandingBalance', 'EditEndUserStatus', 'EditNewBuyStatus', 'EditZeroCreditShutdown', 'ExportCustomerQuotaRecord', 'ExportReversedDeductionHistory', 'GetAccountInfo', 'GetCreditInfo', 'GetPurchaseControlRecord', 'GetShutdownPolicyRecord', 'QueryReversedDeductionHistory', 'QueryAutomaticWriteOffChangeRecords', 'SetAccountInfo', 'SetCreditLine', 'SetWarningThreshold'],
'type' => 'directory',
'title' => 'Customer account management',
],
[
'children' => ['CancelSubscriptionBill', 'GetCommissionableProducts', 'GetCustomerOrders', 'GetDailyBill', 'GetMonthlyBill', 'SubscriptionBill'],
'type' => 'directory',
'title' => 'User center',
],
[
'children' => ['GetTier2CouponApprovalDetail', 'ListTier2CouponApproval', 'CancelCoupon', 'CreateCouponTemplate', 'CouponApprovalStatusList', 'DeleteCouponTemplate', 'GetCouponTemplateDetail', 'GetCoupondeductProductCode', 'IssueCouponForCustomer', 'ListCouponUsage', 'QuotaListExportPaged'],
'type' => 'directory',
'title' => 'Coupon management',
],
[
'children' => ['ProcessApproval', 'ListExportTasks', 'InviteSubReseller'],
'type' => 'directory',
'title' => 'Others',
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AutomaticWriteOff' => [
'summary' => 'Before the end-of-month settlement, you can enable the automatic write-off feature. When the consumed but unoffset quota reaches the specified automatic write-off amount, the amount is transferred to the offset quota and can be used for deduction.',
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'CustomerUid',
'in' => 'query',
'schema' => ['description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''],
],
[
'name' => 'AutomaticWriteOffEnabled',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to enable automatic write-off and set the automatic write-off amount. Valid values:'."\n"
.'- true: enables automatic write-off and sets the automatic write-off amount.'."\n"
.'- false: disables automatic write-off.', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
],
[
'name' => 'AutomaticWriteOffAmount',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The automatic write-off amount. This parameter is required if automatic write-off is enabled. Valid values: 100, 500, and 1000.',
'type' => 'integer',
'format' => 'int64',
'enum' => ['100', '500', '1000'],
'required' => false,
'example' => '100',
],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The language of the response. Default value: en. Valid values:'."\n"
.'- en: English.'."\n"
.'- zh: Chinese.'."\n"
.'- ja: Japanese.',
'type' => 'string',
'enum' => ['zh', 'en', 'ja'],
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6fc1309b17543600398356606d0096'],
'Message' => ['title' => '', 'description' => 'The description of the result.', 'type' => 'string', 'example' => '成功'],
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => '200'],
'Data' => ['title' => '', 'description' => 'Indicates whether the setting is successful.', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Set automatic write-off',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6fc1309b17543600398356606d0096\\",\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'CancelCoupon' => [
'summary' => 'Invalidates a coupon.',
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CouponId',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The coupon ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '501001340370350', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERROR_201', 'errorMessage' => 'Parameters are illegal and required fields are empty.', 'description' => 'Parameters are illegal and required fields are empty.'],
['errorCode' => 'ERROR_2311', 'errorMessage' => 'Coupon template does not exist.', 'description' => 'Coupon template does not exist'],
['errorCode' => 'ERROR_1003', 'errorMessage' => 'No permission to operate the object.', 'description' => 'No permission to operate the object.'],
['errorCode' => 'ERROR_2307', 'errorMessage' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', 'description' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Invalidate a coupon',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelCoupon'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:CancelCoupon',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": true\\n}","type":"json"}]',
],
'CancelSubscriptionBill' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'SubscribeType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Subscription type.'."\n"
."\n"
.'- PartnerBillingItemDetailForBillingPeriod: Billing item bill details.'."\n"
.'- PartnerBillingItemDetailMonthly: Billing item monthly bill.'."\n"
.'- PartnerInstanceDetailForBillingPeriod: Instance bill details.'."\n"
.'- PartnerInstanceDetailMonthly: Instance monthly bill.', 'type' => 'string', 'required' => true, 'example' => 'PartnerBillingItemDetailForBillingPeriod'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
'Message' => ['title' => '', 'description' => 'The message returned.', 'type' => 'string', 'example' => '成功'],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35'],
'Data' => ['description' => 'The data returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => [
'title' => '',
'description' => 'The status code.',
'enumValueTitles' => [1008 => 'Unsubscription failed.', 'No subscription record exists.'],
'type' => 'string',
'example' => '200',
],
'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Cancel multi-level distribution bill subscription',
'summary' => 'Unsubscribe from multi-level bills for international channel ecosystem partners.',
'description' => 'Make sure that the caller is an international Alibaba Cloud master reseller partner.'."\n"
."\n"
.'You can unsubscribe from one type of bill file at a time.'."\n"
."\n"
.'After the corresponding bill type is unsubscribed, files are no longer pushed to the specified OSS space.'."\n"
."\n"
.'**This content is published only on the international site.**',
'changeSet' => [
['createdAt' => '2025-01-10T03:58:11.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSubscriptionBill'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:CancelSubscriptionBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'CouponApprovalStatusList' => [
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => 'The coupon template ID.', 'type' => 'string', 'required' => false, 'example' => '5093156', 'title' => ''],
],
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => false, 'example' => '测试优惠券模板', 'title' => ''],
],
[
'name' => 'TemplateStatus',
'in' => 'query',
'schema' => ['description' => 'The coupon template status. Valid values:'."\n"
.'- **1**: Application withdrawn.'."\n"
.'- **2**: Under review.'."\n"
.'- **3**: Review rejected.'."\n"
.'- **4**: Review approved.'."\n"
.'- **5**: Review approved but issuance failed.'."\n"
.'- **6**: Automatically approved.'."\n"
.'- **7**: Automatically approved but issuance failed.', 'type' => 'string', 'required' => false, 'example' => '2', 'title' => ''],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '0', 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'TemplateId' => ['description' => 'The template ID.', 'type' => 'string', 'example' => 'S00000101-100040', 'title' => ''],
'TemplateName' => ['description' => 'The coupon template name.', 'type' => 'string', 'example' => '模板名称', 'title' => ''],
'TemplateStatus' => ['description' => 'The coupon template status. Valid values:'."\n"
.'- **1**: Application withdrawn.'."\n"
.'- **2**: Under review.'."\n"
.'- **3**: Review rejected.'."\n"
.'- **4**: Review approved.'."\n"
.'- **5**: Review approved but issuance failed.'."\n"
.'- **6**: Automatically approved.'."\n"
.'- **7**: Automatically approved but issuance failed.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''],
'TimeOfRequest' => ['description' => 'The time when the application was submitted.', 'type' => 'string', 'example' => '2024-02-02 09:46:59', 'title' => ''],
'IssuerAccount' => ['description' => 'The issuer account.', 'type' => 'string', 'example' => 'test@test.aliyunid.com', 'title' => ''],
'Note' => ['description' => 'The approval comments.', 'type' => 'string', 'example' => '通过', 'title' => ''],
'IssuerUid' => ['description' => 'The UID of the issuer account.', 'type' => 'string', 'example' => '5432738203821334', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query coupon approval status list',
'summary' => 'Queries the list of coupon approval statuses.',
'description' => 'Make sure that the current caller identity is a distribution partner. '."\n"
.'<notice>Available only on the China site.</notice>.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CouponApprovalStatusList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:CouponApprovalStatusList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"TemplateId\\": \\"S00000101-100040\\",\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"TemplateStatus\\": 2,\\n \\"TimeOfRequest\\": \\"2024-02-02 09:46:59\\",\\n \\"IssuerAccount\\": \\"test@test.aliyunid.com\\",\\n \\"Note\\": \\"通过\\",\\n \\"IssuerUid\\": \\"5432738203821334\\"\\n }\\n ]\\n}","type":"json"}]',
],
'CreateCouponTemplate' => [
'summary' => 'Create Coupon Template',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TemplateName',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Template name'."\n"
.'Field length limit: 30', 'type' => 'string', 'required' => true, 'maxLength' => 30, 'example' => '模板名称'],
],
[
'name' => 'ReasonForApplication',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Reason for template application'."\n"
.'Field length limit: 100', 'type' => 'string', 'required' => true, 'maxLength' => 100, 'example' => '模板申请原因'],
],
[
'name' => 'CostBearer',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Coupon cost bearer'."\n"
.'● Partner: borne by the partner'."\n"
.'● Alibaba Cloud: borne by Alibaba Cloud',
'type' => 'string',
'required' => true,
'enum' => ['Partner', 'Alibaba Cloud'],
'example' => 'Partner',
],
],
[
'name' => 'ApplicableProducts',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Applicable products'."\n"
.'● All Products: all products'."\n"
.'● Custom: custom selection',
'type' => 'string',
'required' => true,
'enum' => ['All Products', 'Custom'],
'example' => 'All Products',
],
],
[
'name' => 'ProductType',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '',
'description' => 'Product code list',
'type' => 'array',
'items' => ['description' => 'Product code. The return value from the deductible products API for international channel distribution coupons.', 'type' => 'string', 'required' => false, 'example' => 'code1', 'title' => ''],
'required' => false,
'example' => '',
],
],
[
'name' => 'LimitPerPerson',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Limit per person'."\n"
.'● Limited to 1: each person can claim only one coupon'."\n"
.'● Unlimited: no limit',
'type' => 'string',
'required' => true,
'enum' => ['Limited to 1', 'Unlimited'],
'example' => 'Unlimited',
],
],
[
'name' => 'Value',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Face value'."\n"
.'Must be an integer', 'type' => 'string', 'required' => true, 'example' => '1'],
],
[
'name' => 'ValidUntil',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Validity period'."\n"
.'● Validity Duration: from the date of coupon issuance'."\n"
.'● Custom Timeframe: custom time period',
'type' => 'string',
'required' => true,
'enum' => ['Validity Duration', 'Custom Timeframe'],
'example' => 'Validity Duration',
],
],
[
'name' => 'Vailddate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Start date of the effective period'."\n"
.'Format: yyyy-MM-dd'."\n"
.'Example: 2024-08-26'."\n"
.'Required when the validity period is set to Custom Timeframe', 'type' => 'string', 'required' => false, 'example' => '2024-08-26'],
],
[
'name' => 'Expireddate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'End date of the effective period'."\n"
.'Format: yyyy-MM-dd'."\n"
.'Example: 2024-08-26'."\n"
.'Required when the validity period is set to Custom Timeframe', 'type' => 'string', 'required' => false, 'example' => '2024-08-26'],
],
[
'name' => 'Vaildperioddays',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Duration in days for the relative time period'."\n"
.'Must be a positive integer'."\n"
.'Required when the validity period is set to Validity Duration', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'PurchaseType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'Order type',
'type' => 'string',
'enum' => ['ALL', 'Subscription', 'Pay-As-You-Go'],
'required' => false,
'example' => 'ALL',
],
],
[
'name' => 'CouponDescription',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Coupon remarks'."\n"
.'Length limit: 100', 'type' => 'string', 'required' => false, 'maxLength' => 100, 'example' => '券备注信息'],
],
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Default value: none'."\n"
.'Chinese: zh-CN'."\n"
.'English: en-US'."\n"
.'Japanese: ja', 'type' => 'string', 'required' => true, 'example' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5'],
'Code' => ['title' => '', 'description' => 'Status code. 200 indicates success', 'type' => 'string', 'example' => '200'],
'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '200'],
'Success' => ['description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'Response data',
'type' => 'object',
'properties' => [
'TemplateName' => ['title' => '', 'description' => 'Coupon template name', 'type' => 'string', 'example' => '模板名称'],
'ApplicableProducts' => [
'title' => '',
'description' => 'Applicable products'."\n"
.'● All Products: all products'."\n"
.'● Custom: custom selection',
'type' => 'string',
'enum' => ['Custom', 'All Products'],
'example' => 'Custom',
],
'ProductType' => [
'title' => '',
'description' => 'Product code list',
'type' => 'array',
'items' => ['description' => 'Product code', 'type' => 'string', 'example' => 'code1', 'title' => ''],
'example' => '',
],
'Value' => ['description' => 'Face value', 'type' => 'string', 'example' => '1', 'title' => ''],
'ValidUntil' => [
'title' => '',
'description' => 'Validity period'."\n"
.'● Validity Duration: from the date of coupon issuance'."\n"
.'● Custom Timeframe: custom time period',
'type' => 'string',
'enum' => ['Validity Duration', 'Custom Timeframe'],
'example' => 'Validity Duration',
],
'Vailddate' => ['title' => '', 'description' => 'Start date of the effective period'."\n"
.'Format: yyyy-MM-dd', 'type' => 'string', 'example' => '2024-01-01'],
'Expireddate' => ['title' => '', 'description' => 'End date of the effective period'."\n"
.'Format: yyyy-MM-dd', 'type' => 'string', 'example' => '2024-01-01'],
'Vaildperioddays' => ['description' => 'Duration in days for the relative time period', 'type' => 'string', 'example' => '1', 'title' => ''],
'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2024-04-02 16:15:31'],
'CostBearer' => [
'title' => '',
'description' => 'Coupon cost bearer'."\n"
.'● Partner: borne by the partner'."\n"
.'● Alibaba Cloud: borne by Alibaba Cloud',
'type' => 'string',
'enum' => ['Partner', 'Alibaba Cloud'],
'example' => 'Partner',
],
'Status' => ['title' => '', 'description' => 'Status'."\n"
."\n"
.'CREATED: Created'."\n"
.'APPROVING: Under review'."\n"
.'APPROVED: Approved'."\n"
.'UNAPPROVED: Not approved'."\n"
.'ABANDONED: Abandoned'."\n"
.'EXPIRED: Expired'."\n"
.'EXHAUSTED: Exhausted', 'type' => 'string', 'example' => 'APPROVED'],
'CouponTemplateID' => ['title' => '', 'description' => 'Coupon template ID', 'type' => 'integer', 'format' => 'int64', 'example' => '111111'],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERROR_3070', 'errorMessage' => 'CouponTemplateName must be entered.', 'description' => 'TemplateName name must be entered'],
['errorCode' => 'ERROR_3100', 'errorMessage' => 'System exceptions, please submit a work order.', 'description' => 'System exceptions, please submit a work order.'],
['errorCode' => 'ERROR_3091', 'errorMessage' => 'Coupon template name length over limit.', 'description' => 'Coupon template name length over limit(30 characters).'],
['errorCode' => 'ERROR_3071', 'errorMessage' => 'ApplicableProducts empty, please check.', 'description' => 'ApplicableProducts empty, please check.'],
['errorCode' => 'ERROR_3094', 'errorMessage' => 'Applicable product type parameters are not legal.', 'description' => 'Applicable product type parameters are not legal'],
['errorCode' => 'ERROR_3080', 'errorMessage' => 'Account empty, please check.', 'description' => 'Account is empty, please check'],
['errorCode' => 'ERROR_3090', 'errorMessage' => 'You have no authority.', 'description' => 'You have no authority'],
['errorCode' => 'ERROR_3085', 'errorMessage' => 'Product code is not in international channel partner coupons deductable product list.', 'description' => 'Product code is not in international channel partner coupons deductable product list.'],
['errorCode' => 'ERROR_3072', 'errorMessage' => 'itemCodes empty, please check.', 'description' => 'ProductType is empty, please check'],
['errorCode' => 'ERROR_3101', 'errorMessage' => 'PurchaseType empty, please check .', 'description' => 'PurchaseType empty, please check .'],
['errorCode' => 'ERROR_3073', 'errorMessage' => 'amout empty, please check.', 'description' => 'Value empty, please check.'],
['errorCode' => 'ERROR_3096', 'errorMessage' => 'Coupon value is illegal.', 'description' => 'Coupon value is illegal.'],
['errorCode' => 'ERROR_3074', 'errorMessage' => 'personLimit empty, please check.', 'description' => 'LimitPerPerson empty, please check.'],
['errorCode' => 'ERROR_3095', 'errorMessage' => 'The per-person limit is illegal.', 'description' => 'The per-person limit is illegal.'],
['errorCode' => 'ERROR_3075', 'errorMessage' => 'applyReason empty, please check.', 'description' => 'ReasonForApplication empty, please check.'],
['errorCode' => 'ERROR_3092', 'errorMessage' => 'Reason for template request length over limit.', 'description' => 'Reason for template request length over limit(100 characters)'],
['errorCode' => 'ERROR_3098', 'errorMessage' => 'Coupon Remarks Information length over limit.', 'description' => 'Coupon Remarks Information length over limit(100 characters).'],
['errorCode' => 'ERROR_3093', 'errorMessage' => 'Coupon cost-bearer parameters are not legal.', 'description' => 'Coupon cost-bearer parameters are not legal'],
['errorCode' => 'ERROR_3076', 'errorMessage' => 'effDateType empty, please check.', 'description' => 'effDateType empty, please check.'],
['errorCode' => 'ERROR_3078', 'errorMessage' => 'effDateFrom empty, please check.', 'description' => 'Vailddate empty, please check.'],
['errorCode' => 'ERROR_3079', 'errorMessage' => 'effDateTo empty, please check.', 'description' => 'Expireddate empty, please check .'],
['errorCode' => 'ERROR_3099', 'errorMessage' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'description' => 'The start of the coupon\'s effective time cannot be earlier than the current time.'],
['errorCode' => 'ERROR_3103', 'errorMessage' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'description' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time. '."\n"],
['errorCode' => 'ERROR_3084', 'errorMessage' => 'Coupon cannot be valid for more than 180 days.', 'description' => 'Coupon cannot be valid for more than 180 days'],
['errorCode' => 'ERROR_3077', 'errorMessage' => 'effDateDay empty, please check.', 'description' => 'Vaildperioddays empty, please check.'],
['errorCode' => 'ERROR_3097', 'errorMessage' => 'Time type is illegal.', 'description' => 'Time type is illegal.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Create Coupon Template',
'changeSet' => [
['createdAt' => '2024-09-11T12:09:50.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCouponTemplate'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:CreateCouponTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"ApplicableProducts\\": \\"Custom\\",\\n \\"ProductType\\": [\\n \\"code1\\"\\n ],\\n \\"Value\\": \\"1\\",\\n \\"ValidUntil\\": \\"Validity Duration\\",\\n \\"Vailddate\\": \\"2024-01-01\\",\\n \\"Expireddate\\": \\"2024-01-01\\",\\n \\"Vaildperioddays\\": \\"1\\",\\n \\"CreateTime\\": \\"2024-04-02 16:15:31\\",\\n \\"CostBearer\\": \\"Partner\\",\\n \\"Status\\": \\"APPROVED\\",\\n \\"CouponTemplateID\\": 111111\\n }\\n}","type":"json"}]',
],
'CreateCustomer' => [
'summary' => 'Registers a customer to be invited.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CustomerName',
'in' => 'query',
'schema' => ['description' => 'The customer name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DoorBell Marketing', 'title' => ''],
],
[
'name' => 'CustomerTrade',
'in' => 'query',
'schema' => ['description' => 'The customer industry name.'."\n"
.'Use the Customer Trade enumeration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0205', 'title' => ''],
],
[
'name' => 'CustomerSubTrade',
'in' => 'query',
'schema' => ['description' => 'The customer sub-industry.'."\n"
.'Use the Customer Sub Trade enumeration.', 'type' => 'string', 'required' => false, 'example' => '020501', 'title' => ''],
],
[
'name' => 'CustomerSource',
'in' => 'query',
'schema' => ['description' => 'The customer source.'."\n"
.'Use the Customer Source enumeration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'website', 'title' => ''],
],
[
'name' => 'Nation',
'in' => 'query',
'schema' => ['description' => 'The region to which the customer belongs. Call ListCountries to obtain the list of available regions for the current UID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'AR', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The code that indicates whether the call is successful.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The same as the Code parameter.', 'type' => 'string', 'example' => '12345', 'title' => ''],
'Data' => ['description' => 'Indicates whether the customer is created. If the value is true, the Message contains the CID.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => 'A9B725C7-3DBD-576B-AC91-F6F22AB99A77', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values:'."\n"
.'- True'."\n"
.'- False'."\n"
."\n"
.'This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"12345\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"A9B725C7-3DBD-576B-AC91-F6F22AB99A77\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Register a customer',
'requestParamsDescription' => '### Valid values of CustomerSource'."\n"
.'> The following format is: field displayed on the page — input parameter value.'."\n"
.'- Off-line meeting — Off_line_meeting'."\n"
.'- Website — website'."\n"
.'- Offline marketing event — OFFLINE_MARKETTING_EVENT'."\n"
.'- International enterprise — intl_enterprise'."\n"
.'- Internal transfer — Internal_transfer'."\n"
.'- External channel — External_channel'."\n"
.'- Cold visit — Mobai'."\n"
.'- Referral from existing customer — Old_client_to_introduce'."\n"
.'- Other — Other'."\n"
.'- Customer allocation — ALLOCATE'."\n"
.'- Potential customer recommendation — PotentialRecommend.'."\n"
."\n"
.'### Valid values of Customer Trade'."\n"
.'> The following four-digit input parameter codes are parent codes. Example: parent code = 0603 (four digits).'."\n"
.'If both customer sub trade and customer trade are specified, customer trade must be equal to the parent code of sub trade.'."\n"
.'- Retail and wholesale — 0101'."\n"
.'- E-commerce — 0102'."\n"
.'- Logistics and warehousing — 0103'."\n"
.'- Travel, culture, sports, and entertainment — 0104'."\n"
.'- Apparel, footwear, stationery, and sporting goods — 0105'."\n"
.'- Home appliances — 0106'."\n"
.'- Food, beverages, and tobacco — 0107'."\n"
.'- Agriculture — 0201'."\n"
.'- Steel manufacturing — 0202'."\n"
.'- Equipment manufacturing — 0203'."\n"
.'- General industrial manufacturing — 0204'."\n"
.'- Automobiles, auto parts, and services — 0205'."\n"
.'- Real estate and construction — 0206'."\n"
.'- Banking — 0301'."\n"
.'- Insurance — 0302'."\n"
.'- Securities and capital markets — 0303'."\n"
.'- Financial services — 0304'."\n"
.'- Telecommunications and carriers — 0401'."\n"
.'- Media — 0402'."\n"
.'- Computer hardware — 0403'."\n"
.'- Computer software and services — 0404'."\n"
.'- Internet gaming — 0405'."\n"
.'- Internet services — 0406'."\n"
.'- IoT technology and services — 0407'."\n"
.'- Smart consumer products — 0408'."\n"
.'- Artificial intelligence — 0409'."\n"
.'- Power grid — 0501'."\n"
.'- Oil and petrochemicals — 0502'."\n"
.'- Non-renewable resources — 0503'."\n"
.'- New energy and renewable energy — 0504'."\n"
.'- Chemical industry — 0505'."\n"
.'- Government — 0601'."\n"
.'- Civil-military integration — 0602'."\n"
.'- Healthcare — 0603'."\n"
.'- Education and research institutions — 0604'."\n"
.'- Transportation — 0605'."\n"
.'- Public services — 0606.'."\n"
."\n"
.'### Valid values of customer sub trade'."\n"
."\n"
.'> The customer sub trade code is a six-digit code (for example, 060304), and the parent code is a four-digit code (for example, 0603).'."\n"
.'If both sub trade and customer trade are specified, customer trade must be equal to the parent code of sub trade.'."\n"
."\n"
.'- Media - Internet media — 040201 — 0402'."\n"
.'- Media - Broadcasting and media — 040202 — 0402'."\n"
.'- Automobiles, auto parts, and services - Vehicle manufacturing — 020501 — 0205'."\n"
.'- Automobiles, auto parts, and services - Auto parts manufacturing — 020502 — 0205'."\n"
.'- Automobiles, auto parts, and services - Connected vehicles and auto services — 020503 — 0205'."\n"
.'- Government - Public security, procuratorate, and court — 060101 — 0601'."\n"
.'- Government - Taxation — 060102 — 0601'."\n"
.'- Government - Customs — 060103 — 0601'."\n"
.'- Government - Local government — 060104 — 0601'."\n"
.'- Government - Other government agencies — 060105 — 0601'."\n"
.'- Steel manufacturing - Steel mining — 020201 — 0202'."\n"
.'- Steel manufacturing - Steel production — 020202 — 0202'."\n"
.'- Travel, culture, sports, and entertainment - Travel services — 010401 — 0104'."\n"
.'- Travel, culture, sports, and entertainment - Accommodation and catering — 010402 — 0104'."\n"
.'- Travel, culture, sports, and entertainment - Culture, sports, and entertainment — 010403 — 0104'."\n"
.'- Telecommunications and carriers - Telecommunications equipment — 040101 — 0401'."\n"
.'- Telecommunications and carriers - Carriers — 040102 — 0401'."\n"
.'- Telecommunications and carriers - Telecommunications services — 040103 — 0401'."\n"
.'- Internet services - Social networking — 040601 — 0406'."\n"
.'- Internet services - Internet marketing — 040602 — 0406'."\n"
.'- Internet services - Internet platforms — 040603 — 0406'."\n"
.'- Internet services - Internet information services — 040604 — 0406'."\n"
.'- Education and research institutions - Online education — 060401 — 0604'."\n"
.'- Education and research institutions - Training and educational institutions — 060402 — 0604'."\n"
.'- Education and research institutions - Research institutions — 060403 — 0604'."\n"
.'- Transportation - Railway transportation — 060501 — 0605'."\n"
.'- Transportation - Road transportation — 060502 — 0605'."\n"
.'- Transportation - Water transportation — 060503 — 0605'."\n"
.'- Transportation - Air transportation — 060504 — 0605'."\n"
.'- Transportation - Other transportation — 060505 — 0605'."\n"
.'- Food, beverages, and tobacco - Food manufacturing — 010701 — 0107'."\n"
.'- Food, beverages, and tobacco - Alcoholic beverages, drinks, and refined tea manufacturing — 010702 — 0107'."\n"
.'- Food, beverages, and tobacco - Tobacco products — 010703 — 0107'."\n"
.'- Non-renewable resources - Non-renewable energy extraction — 050301 — 0503'."\n"
.'- Non-renewable resources - Non-renewable energy production and supply — 050302 — 0503'."\n"
.'- Healthcare - Medical services — 060301 — 0603'."\n"
.'- Healthcare - Health services — 060302 — 0603'."\n"
.'- Healthcare - Medical and health equipment — 060303 — 0603'."\n"
.'- Healthcare - Genetic engineering — 060304 — 0603'."\n"
.'- Healthcare - Pharmaceuticals and biotechnology — 060305 — 0603.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomer'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'agency:CreateCustomer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'CustomerQuotaRecordList' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EndUserPk',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5113766248601929'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-01-02'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-09-24'],
],
[
'name' => 'OperationType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n"
.'- all: all types'."\n"
.'- quota_create: creation'."\n"
.'- quota_amount_adjust: quota amount adjustment.', 'type' => 'string', 'required' => true, 'example' => 'all'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language parameter. Default value: en. Valid values:'."\n"
.'- en: English'."\n"
.'- zh: Chinese'."\n"
.'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Data' => [
'description' => 'The list of returned results.',
'type' => 'array',
'items' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'OperationSubmitType' => ['title' => '', 'description' => 'The method by which the operation was submitted. Valid values: API and ACPN.', 'type' => 'string', 'example' => 'ACPN'],
'OperationTime' => ['title' => '', 'description' => 'The time when the operation was performed.', 'type' => 'string', 'example' => '2023-12-15 10:34:36 UTC+8'],
'OperationTypeDesc' => ['title' => '', 'description' => 'The description of the change type.', 'type' => 'string', 'example' => 'Quota Adjustment'],
'OperationUid' => ['title' => '', 'description' => 'The UID of the operator.', 'type' => 'string', 'example' => '5113766248601929'],
'UpdateAfterAmount' => ['title' => '', 'description' => 'The amount after the change.', 'type' => 'string', 'example' => '121.00'],
'UpdateAmount' => ['title' => '', 'description' => 'The change amount.', 'type' => 'string', 'example' => '-100.00'],
'UpdateBeforeAmount' => ['title' => '', 'description' => 'The amount before the change.', 'type' => 'string', 'example' => '221.00'],
'OperationTypeCode' => ['title' => '', 'description' => 'The code of the change type. Valid values:'."\n"
.'- all: all types'."\n"
.'- quota_create: creation'."\n"
.'- quota_amount_adjust: quota amount adjustment.', 'type' => 'string', 'example' => 'quota_amount_adjust'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2103a0ae16849855284594613d874e'],
'Msg' => ['title' => '', 'description' => 'The description of the returned result.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => '', 'description' => 'The status code of the returned result. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query quota adjustment records of a distributor customer',
'summary' => 'Queries the quota adjustment records of a distributor customer on the China site (Chinese mainland). This operation is available only for China site users.',
'description' => 'The caller must be an Alibaba Cloud channel master distributor partner or an Alibaba Cloud channel distributor partner.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CustomerQuotaRecordList'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:CustomerQuotaRecordList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36 UTC+8\\",\\n \\"OperationTypeDesc\\": \\"Quota Adjustment\\",\\n \\"OperationUid\\": \\"5113766248601929\\",\\n \\"UpdateAfterAmount\\": \\"121.00\\",\\n \\"UpdateAmount\\": \\"-100.00\\",\\n \\"UpdateBeforeAmount\\": \\"221.00\\",\\n \\"OperationTypeCode\\": \\"quota_amount_adjust\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a0ae16849855284594613d874e\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'DeductOutstandingBalance' => [
'summary' => 'Reduces the deducted credit of a reseller\'s customer. For example, if the current deducted credit is 500 and the available credit is 1000, a reduction of 300 changes the deducted credit to 200 and the available credit to 1300.'."\n"
.'Note: Sometimes the used credit of a customer may be negative. This indicates that no recovery of the used credit is needed. Wait for the customer to consume the credit. This occurs when a refund is issued while the customer\'s credit is fully used. As a result, the customer\'s credit increases beyond the original limit.'."\n"
.'For example, if the current maximum available credit of a customer is 1000 with no usage, and a refund of 300 occurs, the used credit becomes -300.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID of the reseller\'s customer account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1133166938931507', 'title' => ''],
],
[
'name' => 'DeductAmount',
'in' => 'query',
'schema' => ['description' => 'The amount of deducted credit to reduce.', 'type' => 'string', 'required' => true, 'example' => '300', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'200: OK.'."\n"
.'1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message. The value is the same as the Code parameter value.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call itself is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'This uid is not your EU.', 'description' => 'This user is not your distribution customer'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Reduce deducted credit',
'changeSet' => [
['createdAt' => '2025-01-09T02:09:28.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeductOutstandingBalance'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:DeductOutstandingBalance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
],
'DeleteCouponTemplate' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '6558410265670417297', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4'],
'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERROR_1003', 'errorMessage' => 'No permission to operate the object.', 'description' => 'No permission to operate the object.'],
['errorCode' => 'ERROR_2311', 'errorMessage' => 'Coupon template does not exist.', 'description' => 'Coupon template does not exist'],
['errorCode' => 'ERROR_201', 'errorMessage' => 'Parameters are illegal and required fields are empty.', 'description' => 'Parameters are illegal and required fields are empty.'],
['errorCode' => 'ERROR_2310', 'errorMessage' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'description' => 'The template has a coupon that is being approved so the template cannot be canceled'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Invalidate a coupon template',
'summary' => 'Invalidates a coupon template.',
'description' => 'Make sure that the current caller is a distribution partner. '."\n"
.'<notice>Available only on the China site.</notice>.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCouponTemplate'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:DeleteCouponTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Data\\": true,\\n \\"Success\\": true\\n}","type":"json"}]',
],
'EditEndUserStatus' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the customer to be processed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1792155717328010'],
],
[
'name' => 'CreditStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => '### Shutdown status'."\n"
."\n"
.'- postPayFreeze: pay-as-you-go resource suspension'."\n"
.'- postPayThaw: pay-as-you-go resource resumption.', 'type' => 'string', 'required' => false, 'example' => 'postPayFreeze'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
'Msg' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'success'],
'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => '成功'],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Data' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'string', 'example' => 'true'],
'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'The current customer does not belong to this partner.', 'description' => 'Current customer does not belong to this partner'],
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Set the shutdown status of a customer instance',
'summary' => 'Manages the shutdown status of pay-as-you-go instances for resold subordinate customers by Alibaba Cloud international channel master distributor partners and Alibaba Cloud international channel distributor partners.',
'description' => 'The caller must be an Alibaba Cloud international channel master distributor partner or an Alibaba Cloud international channel distributor partner.'."\n"
."\n"
.'**This content is published only on the China site (Chinese).**.',
'changeSet' => [
['createdAt' => '2025-01-09T03:55:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditEndUserStatus'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:EditEndUserStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'EditNewBuyStatus' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1133166938931507'],
],
[
'name' => 'NewBuyStatus',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The new purchase status. Valid values:'."\n"
."\n"
.'- cancelBan: allows new purchases'."\n"
.'- ban: prohibits new purchases.', 'type' => 'string', 'required' => false, 'example' => 'cancelBan'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
'Msg' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'success'],
'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => '成功'],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Data' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'string', 'example' => 'true'],
'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'The current customer does not belong to this partner.', 'description' => 'Current customer does not belong to this partner'],
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify customer new purchase status',
'summary' => 'Sets the new purchase status of a subordinate reseller customer for an Alibaba Cloud reseller partner.',
'description' => 'The caller must be an Alibaba Cloud reseller partner.'."\n"
."\n"
.'**This content is published only on the China site.**.',
'changeSet' => [
['createdAt' => '2025-01-09T03:55:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditNewBuyStatus'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:EditNewBuyStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"success\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'EditZeroCreditShutdown' => [
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the distributor customer whose shutdown policy you want to modify.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1263644979775567'],
],
[
'name' => 'ShutdownPolicy',
'in' => 'query',
'schema' => [
'title' => '',
'description' => '### **Shutdown policy**'."\n"
.'For more information, refer to the official documentation: https://www.alibabacloud.com/help/zh/channel-platform/latest/shutdowndelayprivilege'."\n"
."\n"
.'- **immediatelyStop**——When the active credit of the distributor customer account is less than 0, the account enters the overdue payment state. New resources cannot be purchased. Pay-as-you-go instances are stopped and no longer incur charges. Upfront instances can be used until they expire. After the instances remain stopped for 15 days, pay-as-you-go instances are released. Because of billing delays, credits may continue to be deducted even after instances are successfully stopped.'."\n"
.'- **delayStop**——The overdraft quota in the delayed shutdown policy is calculated by Alibaba Cloud based on the historical consumption of the account. The minimum overdraft quota is 600 USD, and instances can continue to run for approximately 15 days after the overdue payment occurs. The overdraft quota applies to pay-as-you-go products. After this policy is enabled, when the customer has an overdue payment (active credit < 0) and the overdue amount is within the overdraft quota, instance shutdown is not triggered. The overdraft quota is not the upper limit of the overdue amount. Because of billing delays, credits may continue to be deducted even after instances are successfully stopped. After the instances remain stopped for 15 days, pay-as-you-go instances are released. When the delayed shutdown quota <= remaining credit < 0, you can manually trigger an immediate shutdown.'."\n"
.'- **noStop**——If you select this option, instances are not stopped when the customer has an overdue payment. When the customer has an overdue payment (remaining credit < 0), instance shutdown is not triggered. There is no upper limit on the overdue amount. You must perform a manual operation of "Immediate Shutdown" in ACPN to change the instance status. Use this option with caution.',
'enumValueTitles' => ['immediatelyStop' => 'immediatelyStop', 'noStop' => 'noStop', 'delayStop' => 'delayStop'],
'type' => 'string',
'required' => false,
'example' => 'noStop',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
'Msg' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'SUCCESS'],
'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => '成功'],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Data' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'string', 'example' => 'true'],
'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''],
['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'The current customer does not belong to this partner.', 'description' => 'Current customer does not belong to this partner'],
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Modify customer shutdown policy',
'summary' => 'Modifies the shutdown policy of a subordinate customer by an Alibaba Cloud distributor partner or reseller partner.',
'description' => 'The caller must be an Alibaba Cloud international channel distributor partner or an Alibaba Cloud international channel reseller partner.'."\n"
."\n"
.'**This content is published only on the Chinese site.**.',
'changeSet' => [
['createdAt' => '2025-01-09T03:55:15.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditZeroCreditShutdown'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:EditZeroCreditShutdown',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'ExportCustomerQuotaRecord' => [
'summary' => 'Exports the quota adjustment records of a distributor\'s customer, corresponding to the total budget adjustment details export feature on ACPN.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'EndUserPk',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5113766248601929'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-11-10'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-12-24'],
],
[
'name' => 'OperationType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The operation type. Valid values:'."\n"
.'- all: All operations.'."\n"
.'- quota_create: Creation.'."\n"
.'- quota_amount_adjust: Quota amount adjustment.', 'type' => 'string', 'required' => true, 'example' => 'all'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language parameter. Default value: en. Valid values:'."\n"
.'- en: English.'."\n"
.'- zh: Chinese.'."\n"
.'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210bc4b416874189683843905d9f9a'],
'Msg' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => '', 'description' => 'code', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => '',
'description' => 'The data.',
'type' => 'object',
'properties' => [
'Id' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231'],
'Cost' => ['title' => '', 'description' => 'The estimated time required, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Export distributor customer quota records',
'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.',
'changeSet' => [
['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomerQuotaRecord'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ExportCustomerQuotaRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210bc4b416874189683843905d9f9a\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 1231,\\n \\"Cost\\": 1\\n }\\n}","type":"json"}]',
],
'ExportReversedDeductionHistory' => [
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ExportUid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID for which the reversed deduction details are exported.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-01-01'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-05-01'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language of the exported content. Valid values:'."\n"
.'- en: English.'."\n"
.'- zh: Chinese.'."\n"
.'- ja: Japanese.', 'type' => 'string', 'example' => 'en', 'default' => 'en', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'asfasd123'],
'Message' => ['title' => '', 'description' => 'The description of the response.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => '', 'description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Data' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'Id' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'integer', 'format' => 'int64', 'example' => '2131'],
'Cost' => ['title' => '', 'description' => 'The estimated duration, in minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Export reversed deduction details',
'summary' => 'Exports the reversed deduction details from ACPN.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ExportReversedDeductionHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asfasd123\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"Id\\": 2131,\\n \\"Cost\\": 1\\n }\\n}","type":"json"}]',
],
'GetAccountInfo' => [
'summary' => 'Returns the account information of distributor customers.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID of the distributor customer account. Either this parameter or the UserType parameter is required. If this parameter is left empty, all distributor customer accounts of the specified UserType are queried.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1215848086704806', 'title' => ''],
],
[
'name' => 'UserType',
'in' => 'query',
'schema' => ['description' => 'The type of the distributor customer account. Valid values:'."\n"
.'- 1: End User'."\n"
.'- 2: enterprise customer '."\n"
.'- 3: T2 partner.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page. Maximum value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'- 200: OK'."\n"
.'- 1109: System Error'."\n"
.'- 3029: Invalid UID'."\n"
.'- 3062: Uid and UserType are both empty'."\n"
.'- 3063: UserType value out of range.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'message', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values: True and False. This does not indicate whether subsequent business operations are successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PageInfo' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
'Page' => ['description' => 'The page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'AccountInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'AccountInfo' => [
'description' => 'The list of account information.',
'type' => 'array',
'items' => [
'description' => 'The account information.',
'type' => 'object',
'properties' => [
'SubAccountType' => ['description' => 'The account type. Valid values:'."\n"
.'- 1: end customer of Agency'."\n"
.'- 2: end customer of Reseller'."\n"
.'- 3: enterprise customer'."\n"
.'- 4: Agency-type T2 partner'."\n"
.'- 5: Reseller-type T2 partner'."\n"
.'- 6: Agency+Reseller-type T2 partner.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'AssociationSuccessTime' => ['description' => 'The time when the distributor customer account was associated with the partner account to establish the distributor relationship.', 'type' => 'string', 'example' => '2021-01-01', 'title' => ''],
'AccountNickname' => ['description' => 'The nickname of the distributor customer account. For enterprise customers, this is the company name. For T2 partners, this is the partner name.', 'type' => 'string', 'example' => 'XXX技术有限公司', 'title' => ''],
'Email' => ['description' => 'The email address of the distributor customer account.', 'type' => 'string', 'example' => '1234@qq.com'."\n", 'title' => ''],
'Remark' => ['description' => 'The description of the distributor customer account.', 'type' => 'string', 'example' => '子账号', 'title' => ''],
'Mobile' => ['description' => 'The mobile phone number of the distributor customer account.', 'type' => 'string', 'example' => '13641588680', 'title' => ''],
'AliyunId' => ['description' => 'The Alibaba Cloud logon name of the distributor customer account.', 'type' => 'string', 'example' => '1234@qq.com', 'title' => ''],
'Uid' => ['description' => 'The UID of the distributor customer account.', 'type' => 'integer', 'format' => 'int64', 'example' => '1415740779475837', 'title' => ''],
'Cid' => ['description' => 'The CID of the distributor customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '61479572', 'title' => ''],
'DelayStatus' => ['title' => '', 'description' => 'The suspension policy. Valid values:'."\n"
.'- immediatelyStop: immediately suspends the account.'."\n"
.'- delayStop: suspends the account after a delay. The overdraft quota is specified by the DelayAmount field.'."\n"
.'- noStop: does not suspend the account.', 'type' => 'string', 'example' => 'immediatelyStop'],
'DelayAmount' => ['title' => '', 'description' => 'The overdraft quota when the suspension policy is set to delayStop (delayed suspension).', 'type' => 'string', 'example' => '600'],
'CustomerBd' => ['title' => '', 'description' => 'The business development manager of the customer.', 'type' => 'string', 'example' => '张三'],
'NewBuyStatus' => ['title' => '', 'description' => 'The purchase status. Valid values:'."\n"
.'- Purchase Forbidden: purchasing is prohibited.'."\n"
.'- Normal: purchasing is allowed.', 'type' => 'string', 'example' => 'Normal'],
'CustomerAccountType' => ['title' => '', 'description' => 'The account type of the customer. Valid values:'."\n"
.'- 0: individual'."\n"
.'- 1: enterprise.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'CustomerEnterpriseCertified' => ['title' => '', 'description' => 'Indicates whether the customer has completed enterprise real-name verification. Valid values:'."\n"
.'- 0: no'."\n"
.'- 1: yes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'RegisterCountryCode' => ['title' => '', 'description' => 'The country code of the customer registration country/region.', 'type' => 'string', 'example' => 'CN'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"AccountInfoList\\": {\\n \\"AccountInfo\\": [\\n {\\n \\"SubAccountType\\": 1,\\n \\"AssociationSuccessTime\\": \\"2021-01-01\\",\\n \\"AccountNickname\\": \\"XXX技术有限公司\\",\\n \\"Email\\": \\"1234@qq.com\\\\n\\",\\n \\"Remark\\": \\"子账号\\",\\n \\"Mobile\\": \\"13641588680\\",\\n \\"AliyunId\\": \\"1234@qq.com\\",\\n \\"Uid\\": 1415740779475837,\\n \\"Cid\\": 61479572,\\n \\"DelayStatus\\": \\"immediatelyStop\\",\\n \\"DelayAmount\\": \\"600\\",\\n \\"CustomerBd\\": \\"张三\\",\\n \\"NewBuyStatus\\": \\"Normal\\",\\n \\"CustomerAccountType\\": 1,\\n \\"CustomerEnterpriseCertified\\": 1,\\n \\"RegisterCountryCode\\": \\"CN\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Query distributor customer information',
'changeSet' => [
['createdAt' => '2024-11-05T01:47:08.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2024-04-18T06:55:28.000Z', 'description' => 'Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetAccountInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountInfo'],
],
],
],
'GetCommissionableProducts' => [
'summary' => 'Provides T1-tier international distribution partners with a list of all commission-eligible commodities that are in the "Active" or "Delisted" status. This operation is available only for international users and cannot be called on the China site.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => 'The current page number for pagination. The value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'ListShowStatusList',
'in' => 'query',
'style' => 'simple',
'schema' => [
'description' => 'The list of display statuses for commission commodities.',
'type' => 'array',
'items' => [
'description' => 'The display status of a commission commodity.',
'enumValueTitles' => ['PRE_ONLINE' => '待生效', 'OFF_ONLINE' => '已失效', 'ONLINE' => '生效中', 'OFFLINE' => '已下架'],
'type' => 'string',
'required' => false,
'example' => '["ONLINE","OFFLINE"]',
'title' => '',
],
'required' => false,
'title' => '',
'example' => '',
],
],
[
'name' => 'CommodityCodeList',
'in' => 'query',
'schema' => ['description' => 'The commodity codes. Separate multiple codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '"oceanbase_obpre_public_intl,savingplan_common_public_intl"', 'title' => ''],
],
[
'name' => 'PipCodeList',
'in' => 'query',
'schema' => ['description' => 'The product codes. Separate multiple codes with commas (,).', 'type' => 'string', 'required' => false, 'example' => '"oceanbase"', 'title' => ''],
],
[
'name' => 'RealStartMonth',
'in' => 'query',
'schema' => ['description' => 'The actual start month in the format of "yyyymm".', 'type' => 'string', 'required' => false, 'example' => '“202502”', 'title' => ''],
],
[
'name' => 'RealEndMonth',
'in' => 'query',
'schema' => ['description' => 'The actual end month in the format of "yyyymm".', 'type' => 'string', 'required' => false, 'example' => '“202509”', 'title' => ''],
],
[
'name' => 'FiscalYear',
'in' => 'query',
'schema' => ['description' => 'The fiscal year. If this parameter is left empty, the current fiscal year is used by default.', 'type' => 'string', 'required' => false, 'example' => '“FY26”', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Data' => [
'description' => 'The list of returned data.',
'type' => 'array',
'items' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => '“oceanbase_obpre_public_intl”', 'title' => ''],
'CommodityName' => ['description' => 'The commodity name.', 'type' => 'string', 'example' => '“ApsaraDB for OceanBase Pre”', 'title' => ''],
'ProductCode' => ['description' => 'The product code.', 'type' => 'string', 'example' => '“oceanbase”', 'title' => ''],
'ProductName' => ['description' => 'The product name.', 'type' => 'string', 'example' => '“ApsaraDB for OceanBase”', 'title' => ''],
'Status' => ['description' => 'The display status of the product.', 'type' => 'string', 'example' => '“ONLINE”', 'title' => ''],
'ActualStartMonth' => ['description' => 'The actual start month in the format of "yyyymm".', 'type' => 'string', 'example' => '“202502”', 'title' => ''],
'EndMonth' => ['description' => 'The actual end month in the format of "yyyymm".', 'type' => 'string', 'example' => '“202509”', 'title' => ''],
'EligibleForCommission' => ['description' => 'Indicates whether the commodity is eligible for commission.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
'EligibleForDiscount' => ['description' => 'Indicates whether the commodity is eligible for discount.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
'SevenCoreProducts' => ['description' => 'Indicates whether the commodity is a core product.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
'ProductCampaign' => ['description' => 'Indicates whether the commodity is a product line incentive commodity.', 'type' => 'string', 'example' => 'Yes', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2103a30617045934095083027d88c5', 'title' => ''],
'Code' => ['description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Valid values: True and False. Indicates whether the current API call is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query commission commodity list',
'description' => 'Make sure that the current caller account is a distribution partner. '."\n"
.'<notice>Available only for international users.</notice>.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCommissionableProducts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Data\\": [\\n {\\n \\"CommodityCode\\": \\"“oceanbase_obpre_public_intl”\\",\\n \\"CommodityName\\": \\"“ApsaraDB for OceanBase Pre”\\",\\n \\"ProductCode\\": \\"“oceanbase”\\",\\n \\"ProductName\\": \\"“ApsaraDB for OceanBase”\\",\\n \\"Status\\": \\"“ONLINE”\\",\\n \\"ActualStartMonth\\": \\"“202502”\\",\\n \\"EndMonth\\": \\"“202509”\\",\\n \\"EligibleForCommission\\": \\"Yes\\",\\n \\"EligibleForDiscount\\": \\"Yes\\",\\n \\"SevenCoreProducts\\": \\"Yes\\",\\n \\"ProductCampaign\\": \\"Yes\\"\\n }\\n ],\\n \\"RequestId\\": \\"2103a30617045934095083027d88c5\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetCouponTemplateDetail' => [
'summary' => 'Query Coupon Template Details',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TemplateId',
'in' => 'query',
'schema' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5093156', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Data' => [
'description' => 'The operation result.',
'type' => 'object',
'properties' => [
'TemplateId' => ['description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1576', 'title' => ''],
'TemplateName' => ['description' => 'The coupon template name.', 'type' => 'string', 'example' => '模板名称', 'title' => ''],
'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-21 18:18:22', 'title' => ''],
'ReasonForApplication' => ['description' => 'The reason for template application.', 'type' => 'string', 'example' => '测试的', 'title' => ''],
'CostBearer' => ['description' => 'The coupon cost bearer.'."\n"
.'● cost_by_self: Borne by the partner.'."\n"
.'● aliyun_poc: Borne by Alibaba Cloud.', 'type' => 'string', 'example' => 'aliyun_poc', 'title' => ''],
'ApplicableProducts' => ['description' => 'The applicable products.'."\n"
."\n"
.'- UNIVERSAL: All products.'."\n"
."\n"
.'- Specific product code.', 'type' => 'string', 'example' => 'UNIVERSAL', 'title' => ''],
'LimitPerPerson' => ['description' => 'The limit of coupons per person.'."\n"
."\n"
.'- 1: Limited to one coupon.'."\n"
."\n"
.'- 0: Unlimited.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Denomination' => ['description' => 'The denomination.', 'type' => 'number', 'format' => 'double', 'example' => '100', 'title' => ''],
'ValidUntilType' => ['description' => 'The validity period type.'."\n"
."\n"
.'- 0: Relative time.'."\n"
.'- 1: Absolute time.', 'type' => 'string', 'example' => '0', 'title' => ''],
'ValidUntil' => ['description' => 'The validity period, used in conjunction with the validity type.'."\n"
."\n"
.'- If the validity type is relative time, the validity period indicates the number of valid days.'."\n"
."\n"
.'- If the validity type is absolute time, the validity period indicates a time range.', 'type' => 'string', 'example' => '100', 'title' => ''],
'PurchaseType' => ['description' => 'The order type.'."\n"
.'- ALL: Alibaba Cloud subscription.'."\n"
.'- BILLING: Alibaba Cloud pay-as-you-go billing.', 'type' => 'string', 'example' => 'ALL,BILLING', 'title' => ''],
'CouponDescription' => ['description' => 'The coupon remarks.', 'type' => 'string', 'example' => '测试的', 'title' => ''],
'Status' => ['description' => 'The status.'."\n"
."\n"
.'- APPROVED: Approved.'."\n"
.'- ABANDONED: Abandoned.', 'type' => 'string', 'example' => 'APPROVED', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERROR_201', 'errorMessage' => 'Parameters are illegal and required fields are empty.', 'description' => 'Parameters are illegal and required fields are empty.'],
['errorCode' => 'ERROR_1002', 'errorMessage' => 'No query permission.', 'description' => 'No query permission'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query Coupon Template Details',
'description' => 'Ensure that the current calling account is a distribution partner.'."\n"
.'<notice>Available only for international use.</notice>',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCouponTemplateDetail'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCouponTemplateDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": {\\n \\"TemplateId\\": 1576,\\n \\"TemplateName\\": \\"模板名称\\",\\n \\"CreatedTime\\": \\"2024-11-21 18:18:22\\",\\n \\"ReasonForApplication\\": \\"测试的\\",\\n \\"CostBearer\\": \\"aliyun_poc\\",\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"LimitPerPerson\\": 1,\\n \\"Denomination\\": 100,\\n \\"ValidUntilType\\": \\"0\\",\\n \\"ValidUntil\\": \\"100\\",\\n \\"PurchaseType\\": \\"ALL,BILLING\\",\\n \\"CouponDescription\\": \\"测试的\\",\\n \\"Status\\": \\"APPROVED\\"\\n },\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'GetCoupondeductProductCode' => [
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Multi-language parameter. '."\n"
.'Default value: none.'."\n"
.' Chinese: zh-CN'."\n"
.' English: en-US.', 'type' => 'string', 'required' => true, 'example' => 'zh-CN'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '210e876f16704666020714468dab35'],
'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'200: OK.', 'type' => 'string', 'example' => 'code', 'title' => ''],
'Data' => [
'description' => 'The data.',
'type' => 'array',
'items' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'ProductType' => ['description' => 'The product code.', 'type' => 'any', 'example' => 'code1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERROR_3100', 'errorMessage' => 'System exceptions, please submit a work order.', 'description' => 'System exceptions, please submit a work order.'],
['errorCode' => 'ERROR_3210', 'errorMessage' => 'The current calling UID is not an international channel partner.', 'description' => 'The current calling UID is not an international channel partner'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Query products eligible for international channel distribution coupon offset',
'summary' => 'Queries the products that can be offset by international channel distribution coupons.',
'changeSet' => [
['createdAt' => '2024-09-26T04:14:18.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCoupondeductProductCode'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCoupondeductProductCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"code\\",\\n \\"Data\\": [\\n {\\n \\"ProductType\\": \\"code1\\"\\n }\\n ]\\n}","type":"json"}]',
],
'GetCreditInfo' => [
'summary' => 'Queries the credit control information of a distributor customer. If the distributor customer is of the Agency type, the PopCreditInfoJson parameter in the response is empty. This feature is available only for Reseller and Distributor.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID of the sub-account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1792155717328010', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values:'."\n"
.'- True: Successful.'."\n"
.'- False: Failed.'."\n"
."\n"
.'This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'OutstandingBalance' => ['description' => 'The credit amount consumed by the sub-account that has not yet been paid.', 'type' => 'string', 'example' => '200', 'title' => ''],
'CreditLine' => ['description' => 'The credit limit of the sub-account.', 'type' => 'string', 'example' => '1000', 'title' => ''],
'AccountStatus' => ['description' => 'The credit control status of the sub-account. Valid values:'."\n"
.'1. normal: Normal.'."\n"
.'2. arrearsNotShutdown: The account has an overdue payment but is not shut down.'."\n"
.'3. shutdown: Shut down.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
'AvailableCredit' => ['description' => 'The available credit.', 'type' => 'string', 'example' => '800', 'title' => ''],
'AlarmThreshold' => ['description' => 'The percentage value. When the available credit drops below this percentage of the credit limit, an email notification is sent to the main account.', 'type' => 'string', 'example' => '20', 'title' => ''],
'ZeroCreditShutdownPolicy' => ['description' => 'The policy that the system uses to manage resources when the active credit is 0 or less. Valid values:'."\n"
."\n"
.'1: delayStop. Alibaba Cloud takes over the resources. Instances are shut down after the credit is exhausted with a delay epoch. If payment is not made within 15 days, storage resources are released.'."\n"
."\n"
.'2: noStop. The system does not manage the resource lifecycle of the non-trusteeship linked account. The partner must manage it manually.'."\n"
."\n"
.'3: immediatelyStop. Instances are shut down immediately when the account enters the overdue payment state, which triggers instance shutdown.', 'type' => 'string', 'example' => 'delayStop', 'title' => ''],
'newBuyStatus' => ['description' => 'The status that manages the purchase actions of the customer. Valid values:'."\n"
."\n"
.'- ban: New purchases are prohibited.'."\n"
.'- cancelBan: Normal status.', 'type' => 'string', 'example' => 'ban', 'title' => ''],
'ConsumedUndeductedValue' => ['title' => '', 'description' => 'The total outstanding amount of virtual bills before simulated deduction.', 'type' => 'string', 'example' => '0.000000'],
'PAYGFreezeStatus' => ['description' => 'The freeze status of pay-as-you-go. Valid values:'."\n"
.'- freeze: Frozen.'."\n"
.'- normal: Normal.', 'type' => 'string', 'example' => 'normal', 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OutstandingBalance\\": \\"200\\",\\n \\"CreditLine\\": \\"1000\\",\\n \\"AccountStatus\\": \\"normal\\",\\n \\"AvailableCredit\\": \\"800\\",\\n \\"AlarmThreshold\\": \\"20\\",\\n \\"ZeroCreditShutdownPolicy\\": \\"delayStop\\",\\n \\"newBuyStatus\\": \\"ban\\",\\n \\"ConsumedUndeductedValue\\": \\"0.000000\\",\\n \\"PAYGFreezeStatus\\": \\"normal\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Query budget status information of a distributor customer',
'changeSet' => [
['createdAt' => '2023-12-22T03:27:29.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreditInfo'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCreditInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetCustomerOrders' => [
'summary' => 'Queries customer orders on the China site (Chinese mainland). This operation can be called only on the Chinese mainland site.',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => 'The order ID. This parameter is optional.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '209335720330622', 'title' => ''],
],
[
'name' => 'CustomerAccount',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'required' => false, 'example' => 'test_123'],
],
[
'name' => 'CustomerUid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456'],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The order type. Valid values:'."\n"
.'- BUY: new purchase.'."\n"
.'- UPGRADE: upgrade.'."\n"
.'- DOWNGRADE: downgrade.'."\n"
.'- RENEW: renewal.'."\n"
.'- REFUND: refund.'."\n"
.'- OTHERS: other.',
'enumValueTitles' => [],
'type' => 'string',
'required' => false,
'example' => 'RENEW',
],
],
[
'name' => 'OrderStatus',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The order status. Valid values:'."\n"
.'- 1: unpaid.'."\n"
.'- 2: canceled.'."\n"
.'- 3: paid.',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '3',
],
],
[
'name' => 'TimeType',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The time type. Valid values:'."\n"
.'- 1: payment time.'."\n"
.'- 2: order placement time.',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => true,
'example' => '2',
],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start time. This parameter is used together with TimeType. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', 'example' => '2024-08-13 00:00:00'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The end time. This parameter is used together with TimeType. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => true, 'pattern' => '^\\d{4}(-\\d{2}){2}\\s+\\d{2}(:\\d{2}){2}$', 'example' => '2024-08-23 00:00:00'],
],
[
'name' => 'CustomerManager',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The account manager.', 'type' => 'string', 'required' => false, 'example' => 'myBd'],
],
[
'name' => 'ProductType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The product detail code.', 'type' => 'string', 'required' => false, 'example' => 'vm_intl'],
],
[
'name' => 'OrderSource',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The order source. Valid values:'."\n"
.'- 0: regular customer.'."\n"
.'- 1: enterprise customer.'."\n"
.'- 2: secondary reseller.',
'enumValueTitles' => [],
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '0',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''],
],
[
'name' => 'PageNo',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '500', 'minimum' => '1', 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F'],
'Message' => ['description' => 'The message. The value is the same as the Code parameter.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Msg' => ['description' => 'The message. The value is the same as the Code parameter.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 201: parameter exception.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'Indicates whether the customer was created. If the value is true, the Message contains the CID.',
'type' => 'object',
'properties' => [
'OrderId' => ['description' => 'The order ID. This parameter is optional.', 'type' => 'integer', 'format' => 'int64', 'example' => '236414227150922', 'title' => ''],
'CustomerAccount' => ['title' => '', 'description' => 'The customer account.', 'type' => 'string', 'example' => 'test_123'],
'CustomerNo' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'ProductDetail' => ['title' => '', 'description' => 'The product details.', 'type' => 'string', 'example' => 'oss'],
'ProductType' => ['title' => '', 'description' => 'The product detail code.', 'type' => 'string', 'example' => 'snapshot'],
'OrderType' => ['title' => '', 'description' => 'The order type. Valid values:'."\n"
.'- BUY: new purchase.'."\n"
.'- UPGRADE: upgrade.'."\n"
.'- DOWNGRADE: downgrade.'."\n"
.'- RENEW: renewal.'."\n"
.'- REFUND: refund.'."\n"
.'- OTHERS: other.', 'type' => 'string', 'example' => 'BUY'],
'OriginalCost' => ['title' => '', 'description' => 'The original price of the order.', 'type' => 'number', 'format' => 'double', 'example' => '3.92'],
'PretaxCost' => ['title' => '', 'description' => 'The payable amount.', 'type' => 'number', 'format' => 'double', 'example' => '3.92'],
'OrderStatus' => ['title' => '', 'description' => 'The order status. Valid values:'."\n"
.'- 1: unpaid.'."\n"
.'- 2: canceled.'."\n"
.'- 3: paid.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
'TimeToOrder' => ['title' => '', 'description' => 'The order placement time.', 'type' => 'string', 'example' => '2024-08-13 13:02:02'],
'PaymentTime' => ['title' => '', 'description' => 'The payment time.', 'type' => 'string', 'example' => '2024-08-13 13:02:02'],
'PaymentMethod' => ['title' => '', 'description' => 'The payment method.', 'type' => 'string', 'example' => '3:32'],
'CustomerManager' => ['title' => '', 'description' => 'The account manager.', 'type' => 'string', 'example' => 'myBd'],
'OrderSource' => ['title' => '', 'description' => 'The order source. Valid values:'."\n"
.'- 0: regular customer.'."\n"
.'- 1: enterprise customer.'."\n"
.'- 2: secondary reseller.', 'type' => 'string', 'example' => '0'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query customer orders',
'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel reseller partner.',
'changeSet' => [
['createdAt' => '2025-01-09T05:55:39.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrders'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCustomerOrders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"200\\",\\n \\"Msg\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"OrderId\\": 236414227150922,\\n \\"CustomerAccount\\": \\"test_123\\",\\n \\"CustomerNo\\": 123456,\\n \\"ProductDetail\\": \\"oss\\",\\n \\"ProductType\\": \\"snapshot\\",\\n \\"OrderType\\": \\"BUY\\",\\n \\"OriginalCost\\": 3.92,\\n \\"PretaxCost\\": 3.92,\\n \\"OrderStatus\\": 3,\\n \\"TimeToOrder\\": \\"2024-08-13 13:02:02\\",\\n \\"PaymentTime\\": \\"2024-08-13 13:02:02\\",\\n \\"PaymentMethod\\": \\"3:32\\",\\n \\"CustomerManager\\": \\"myBd\\",\\n \\"OrderSource\\": \\"0\\"\\n }\\n ],\\n \\"PageSize\\": 1,\\n \\"PageNo\\": 1,\\n \\"Total\\": 100\\n}","type":"json"}]',
],
'GetDailyBill' => [
'summary' => 'Retrieves the daily bill of a distributor. This feature is available only for Resellers and Distributors.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Date',
'in' => 'query',
'schema' => ['description' => 'Billing date. Format YYYY-MM-DD.', 'type' => 'string', 'required' => true, 'example' => '2022-11-24', 'title' => ''],
],
[
'name' => 'BillOwner',
'in' => 'query',
'schema' => ['description' => 'The type of bill owner. Valid values:'."\n"
."\n"
.'1: distribution partner account '."\n"
."\n"
.'2: distribution customer account.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'BillType',
'in' => 'query',
'schema' => ['description' => 'The bill type. Valid values:'."\n"
."\n"
.'- DailyOrder (Deprecated)'."\n"
."\n"
.'- DailyBill (Deprecated)'."\n"
."\n"
.'- DailyInstanceBill (Deprecated) '."\n"
.'- DailyInstanceBillV2.', 'type' => 'string', 'required' => true, 'example' => 'DailyInstanceBillV2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System error.'."\n"
.'- 3050: Bill type can only be DailyOrder, DailyBill, or DailyInstanceBill. '."\n"
.'- 3049: Invalid spending time format.'."\n"
.'- 3048: Bill owner can only be 1 or 2.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message corresponding to the Code value.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'BillLinkCSV' => ['description' => 'The download URL of the CSV file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
'SpendingTime' => ['description' => 'The spending time, which corresponds to the specific billing date.', 'type' => 'string', 'example' => '20221201', 'title' => ''],
'BillType' => ['description' => 'The bill type. Same as the BillType request parameter.', 'type' => 'string', 'example' => 'DailyInstanceBillV2', 'title' => ''],
'BillOwner' => ['description' => 'The bill owner. Same as the BillOwner request parameter.', 'type' => 'string', 'example' => '1', 'title' => ''],
'BillLinkXLSX' => ['description' => 'The download URL of the XLSX file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillType\\": \\"DailyInstanceBillV2\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Distributor daily bill',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetDailyBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDailyBill'],
],
],
],
'GetInviteStatus' => [
'summary' => 'Queries the invitation status of customers who have been registered and invited.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InviteStatusList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'inviteId list.',
'type' => 'array',
'items' => [
'description' => 'inviteId list',
'type' => 'object',
'properties' => [
'InviteId' => ['description' => 'The invitation ID. Obtained from the InviteSubAccount operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 5,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code. Error code value: 3057: InviteId is empty.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Valid values: True/False. Indicates whether the current API call is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InviteStatus' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.' - 200: OK.'."\n"
.'- 1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Valid values: True/False. Indicates whether the current API call is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'InviteStatusList' => [
'description' => 'The invitation record status result list.',
'type' => 'object',
'properties' => [
'GmtCreate' => ['description' => 'The time when the invitation email was sent.', 'type' => 'string', 'example' => '2018-02-12', 'title' => ''],
'Status' => ['description' => 'The invitation status. Valid values:'."\n"
.'- 0: The registration URL has not been visited.'."\n"
.'- 1: Registration failed.'."\n"
.'- 2: Registration succeeded.'."\n"
.'- 3: The registration URL has been visited but the form has not been submitted.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''],
'SubAccountType' => ['description' => 'The account type. Valid values:'."\n"
.'- 1: Agency end customer.'."\n"
.'- 2: Reseller end customer.'."\n"
.'- 5: Reseller tier-2 partner.', 'type' => 'string', 'example' => '1', 'title' => ''],
'ParentId' => ['description' => 'The UID of the distributor to which the distribution customer account belongs.', 'type' => 'string', 'example' => '1093238769140523', 'title' => ''],
'AssociationSuccessTime' => ['description' => 'The time when the distribution customer account was successfully associated with the distributor account. This value is empty if no association exists.', 'type' => 'string', 'example' => '2018-02-13', 'title' => ''],
'Cid' => ['description' => 'The CID of the distribution customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''],
'Uid' => ['description' => 'The UID of the distribution customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567890123', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for troubleshooting.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"InviteStatus\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"InviteStatusList\\": {\\n \\"GmtCreate\\": \\"2018-02-12\\",\\n \\"Status\\": 2,\\n \\"SubAccountType\\": \\"1\\",\\n \\"ParentId\\": \\"1093238769140523\\",\\n \\"AssociationSuccessTime\\": \\"2018-02-13\\",\\n \\"Cid\\": 1234567890123,\\n \\"Uid\\": 1234567890123\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Query invitation record status',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetInviteStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInviteStatus'],
],
],
],
'GetMonthlyBill' => [
'summary' => 'Returns the monthly bill of a distributor.'."\n"
.'This feature is available only for Resellers and Distributors.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Month',
'in' => 'query',
'schema' => ['description' => 'Billing Month, Format is YYYY-MM.', 'type' => 'string', 'required' => true, 'example' => '2022-11', 'title' => ''],
],
[
'name' => 'BillOwner',
'in' => 'query',
'schema' => ['description' => 'Bill Owner type.'."\n"
."\n"
.' Value range:'."\n"
."\n"
.'1: Master account '."\n"
."\n"
.'2: Sub account.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'BillType',
'in' => 'query',
'schema' => ['description' => 'Value Range:'."\n"
."\n"
.'MonthlyInvoice'."\n"
."\n"
.'MonthRefundInvoice'."\n"
."\n"
.'MonthlySummary (Deprecated)'."\n"
."\n"
.'MonthlyInstanceAddAdjustBill '."\n"
."\n"
.'MonthlyInstanceRefundBill'."\n"
."\n"
.'MonthlyAddAdjustInvoce'."\n"
."\n"
.'MonthlyRefundAdjustInvoce '."\n"
."\n"
.'MonthlyInstanceConsumeV2 '."\n"
."\n"
.'MarginReportV2.', 'type' => 'string', 'required' => true, 'example' => 'MonthlyInvoice', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'Result code:'."\n"
.'- 200 OK'."\n"
.'- 1109 System error'."\n"
.'- 3030 Account nickname exceeds the maximum length of 150 bytes'."\n"
.'- 3031 Remark exceeds the maximum length of 3000 bytes.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'Same as the Code parameter value.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Candidate values: True/False. Indicates whether the current API call itself is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'RefundInvoiceLink' => ['description' => 'The URL for downloading the refund invoice.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
'BillType' => ['description' => 'Same as the input parameter BillType.', 'type' => 'string', 'example' => 'MonthlyInvoice', 'title' => ''],
'InvoiceLink' => ['description' => 'The URL for downloading the invoice.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
'BillLinkCSV' => ['description' => 'The URL for downloading the CSV file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D', 'title' => ''],
'RefundInvoiceFlag' => ['description' => 'Indicates whether a refund invoice exists. Valid values: True, False.', 'type' => 'boolean', 'example' => 'True', 'title' => ''],
'SpendingTime' => ['description' => 'The spending time, which corresponds to the specific consumption time.', 'type' => 'string', 'example' => '20221201', 'title' => ''],
'BillOwner' => ['description' => 'Same as the input parameter BillOwner.', 'type' => 'string', 'example' => '1', 'title' => ''],
'BillLinkXLSX' => ['description' => 'The URL for downloading the XLSX file. Use the HTTP protocol.', 'type' => 'string', 'example' => 'intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for the request.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RefundInvoiceLink\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"BillType\\": \\"MonthlyInvoice\\",\\n \\"InvoiceLink\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"BillLinkCSV\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\",\\n \\"RefundInvoiceFlag\\": true,\\n \\"SpendingTime\\": \\"20221201\\",\\n \\"BillOwner\\": \\"1\\",\\n \\"BillLinkXLSX\\": \\"intl-reseller-month-bill.oss-ap-southeast-1.aliyuncs.com/statements/month/dts/1064252248461886/202104/Month%20Billing%20Invoice%20202104.pdf?Expires=1671160973&OSSAccessKeyId=TMP.3KhvoD9pW264cPv8sYe8E2zJ5HLWmrijNHgKiKpXcy8yS472BcrvemgTfNrrXKu5fCCdbLr2XhmYAyYPmbCe8zJyEkmYzL&Signature=hns1PgiiYl1WdI%2FdiOqbEdsgmfI%3D\\\\n\\"\\n },\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\"\\n}","type":"json"}]',
'title' => 'Distributor monthly bill',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetMonthlyBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonthlyBill'],
],
],
],
'GetPurchaseControlRecord' => [
'summary' => 'Queries order control change records.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OperationTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start time. If left empty, data from the last six months is returned. The time format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-12-15 10:34:36'],
],
[
'name' => 'CustomerUID',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '292828565558721922'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
'Data' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'The data.',
'type' => 'object',
'properties' => [
'ChangedType' => [
'title' => '',
'description' => 'The change type. Valid values:'."\n"
.'- ban: new purchases are prohibited.'."\n"
.'- cancelBan: the purchase prohibition is canceled.',
'enumValueTitles' => ['cancelBan ' => ' 取消禁止', 'ban ' => '禁止新购'],
'type' => 'string',
'example' => 'ban ',
],
'OperationTime' => ['title' => '', 'description' => 'The operation time (UTC+8).', 'type' => 'string', 'example' => '2023-12-15 10:34:36'],
'OperationPath' => ['title' => '', 'description' => 'The method by which the operation was initiated.', 'type' => 'string', 'example' => 'ACPN'],
'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '292828565558721922'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Code' => ['description' => 'The result code. Value range:'."\n"
.'- 200: OK.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": [\\n {\\n \\"ChangedType\\": \\"ban \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"292828565558721922\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
'title' => 'Query order control change records',
'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPurchaseControlRecord'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:GetPurchaseControlRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'GetShutdownPolicyRecord' => [
'summary' => 'Queries the modification records of the deferred shutdown policy.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'OperationTime',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start time. If left empty, data from the last six months is returned. The time format is yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2025-12-15 10:34:36'],
],
[
'name' => 'CustomerUID',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The customer UID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '292828565558721922'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '100', 'minimum' => '5', 'example' => '20'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35', 'title' => ''],
'Data' => [
'description' => 'Indicates whether the customer was created. If the value is true, the Message contains the CID.',
'type' => 'array',
'items' => [
'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
'CurrentPolicy' => [
'title' => '',
'description' => 'The current policy. Valid values:'."\n"
.'- immediatelyStop: immediate shutdown upon overdue payment.'."\n"
.'- delayStop: deferred shutdown quota applied.'."\n"
.'- noStop: no shutdown upon overdue payment.'."\n"
.'[_single.resp.200.props.Data.items.CurrentPolicy.enum.immediatelyStop ]Immediate shutdown upon overdue payment.'."\n"
.'[_single.resp.200.props.Data.items.CurrentPolicy.enum.noStop ]No shutdown upon overdue payment.'."\n"
.'[_single.resp.200.props.Data.items.CurrentPolicy.enum.delayStop ]Deferred shutdown quota applied.',
'enumValueTitles' => ['immediatelyStop ' => '欠费立即停机', 'noStop ' => '欠费不停机', 'delayStop ' => '享受延停额度'],
'type' => 'string',
'example' => 'noStop ',
],
'PreviousPolicy' => [
'title' => '',
'description' => 'The policy before the change. Valid values:'."\n"
.'- immediatelyStop: immediate shutdown upon overdue payment.'."\n"
.'- delayStop: deferred shutdown quota applied.'."\n"
.'- noStop: no shutdown upon overdue payment.'."\n"
.'[_single.resp.200.props.Data.items.PreviousPolicy.enum.immediatelyStop ]Immediate shutdown upon overdue payment.'."\n"
.'[_single.resp.200.props.Data.items.PreviousPolicy.enum.noStop ]No shutdown upon overdue payment.'."\n"
.'[_single.resp.200.props.Data.items.PreviousPolicy.enum.delayStop ]Deferred shutdown quota applied.',
'enumValueTitles' => ['immediatelyStop ' => '欠费立即停机', 'noStop ' => '欠费不停机', 'delayStop ' => '享受延停额度 '],
'type' => 'string',
'example' => 'immediatelyStop ',
],
'OperationTime' => ['title' => '', 'description' => 'The operation time (UTC+8).', 'type' => 'string', 'example' => '2023-12-15 10:34:36'],
'OperationPath' => [
'title' => '',
'description' => 'The method by which the operation was initiated. Valid values:'."\n"
.'- API: API.'."\n"
.'- ACPN: ACPN.'."\n"
.'- ALIYUN_BIZ: Alibaba Cloud internal.',
'enumValueTitles' => ['ALIYUN_BIZ' => 'Alibaba Cloud internal.', 'API' => 'API', 'ACPN' => 'ACPN'],
'type' => 'string',
'example' => 'ACPN',
],
'Operator' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '11111111111'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNo' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Data\\": [\\n {\\n \\"CurrentPolicy\\": \\"noStop \\",\\n \\"PreviousPolicy\\": \\"immediatelyStop \\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36\\",\\n \\"OperationPath\\": \\"ACPN\\",\\n \\"Operator\\": \\"11111111111\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true,\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
'title' => 'Query deferred shutdown policy modification records',
'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.'."\n"
."\n"
.'**This content is published only on the international site.**.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetShutdownPolicyRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetShutdownPolicyRecord'],
],
],
],
'GetTier2CouponApprovalDetail' => [
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ApplicationSheetId',
'in' => 'query',
'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0b9a079e17691387754512757e6a1b'],
'Code' => ['description' => 'The response code. Valid values:'."\n"
.'- 200: Success.'."\n"
.'- Other values: error codes. For more information, see error codes.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => 'success', 'title' => ''],
'Data' => [
'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
'ApplicationSheetId' => ['description' => 'The application ID.', 'type' => 'string', 'example' => '0b9a079e17691387754512757e6a1b', 'title' => ''],
'ApprovalStatus' => ['description' => 'The approval status. Valid values:'."\n"
.'- 1: Revoked.'."\n"
.'- 2: Pending approval.'."\n"
.'- 3: Rejected.'."\n"
.'- 4: Approved.'."\n"
.'- 5: Approved but issuance failed.'."\n"
.'- 8: Pending processing.', 'type' => 'string', 'example' => '2', 'title' => ''],
'TotalAmount' => ['description' => 'The application amount.', 'type' => 'string', 'example' => '100.00', 'title' => ''],
'RemainingQuota' => ['description' => 'The estimated remaining partner new customer PoC coupon privilege quota after the coupons are issued.', 'type' => 'string', 'example' => '20.00', 'title' => ''],
'ApplicationReason' => ['description' => 'The application reason.', 'type' => 'string', 'example' => '申请原因', 'title' => ''],
'ApplicantInfo' => [
'description' => 'The basic application information.',
'type' => 'object',
'properties' => [
'T2PartnerName' => ['description' => 'The name of the secondary distributor.', 'type' => 'string', 'example' => 'test account', 'title' => ''],
'T2PartnerUid' => ['description' => 'The UID of the secondary distributor.', 'type' => 'integer', 'format' => 'int64', 'example' => '5248516846402795', 'title' => ''],
'ApplicableProducts' => ['description' => 'The applicable products. Valid values:'."\n"
.'- UNIVERSAL: all products.'."\n"
.'- A specific commodity code.', 'type' => 'string', 'example' => 'UNIVERSAL', 'title' => ''],
'ApplicationTime' => ['description' => 'The application time.', 'type' => 'string', 'example' => '2026-01-21 11:24', 'title' => ''],
'ValidUntil' => ['description' => 'The validity period, which is the number of valid days or a valid time range.', 'type' => 'string', 'example' => '2026-01-21 ~ 2199-12-31', 'title' => ''],
'OrderType' => ['description' => 'The order type, which specifies the order type for coupon usage. Valid values:'."\n"
.'- ALL: Alibaba Cloud upfront.'."\n"
.'- BILLING: Alibaba Cloud pay-as-you-go bill.'."\n"
.'- ALL,BILLING: Alibaba Cloud upfront and Alibaba Cloud pay-as-you-go bill.', 'type' => 'string', 'example' => 'ALL,BILLING', 'title' => ''],
],
'title' => '',
'example' => '',
],
'CouponReceiptUidList' => [
'description' => 'The list of UIDs of customers who received the coupons.',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Uid' => ['description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'example' => '1703016242044705', 'title' => ''],
'NominalValue' => ['description' => 'The nominal value.', 'type' => 'string', 'example' => '100.00', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query secondary distributor coupon application details',
'summary' => 'Queries the details of a coupon application submitted by a secondary distributor. This operation is applicable only to distributors.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0b9a079e17691387754512757e6a1b\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"ApplicationSheetId\\": \\"0b9a079e17691387754512757e6a1b\\",\\n \\"ApprovalStatus\\": \\"2\\",\\n \\"TotalAmount\\": \\"100.00\\",\\n \\"RemainingQuota\\": \\"20.00\\",\\n \\"ApplicationReason\\": \\"申请原因\\",\\n \\"ApplicantInfo\\": {\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516846402795,\\n \\"ApplicableProducts\\": \\"UNIVERSAL\\",\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ValidUntil\\": \\"2026-01-21 ~ 2199-12-31\\",\\n \\"OrderType\\": \\"ALL,BILLING\\"\\n },\\n \\"CouponReceiptUidList\\": [\\n {\\n \\"Uid\\": 1703016242044705,\\n \\"NominalValue\\": \\"100.00\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
'GetUnassociatedCustomer' => [
'summary' => 'Retrieves all unassociated customers.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The current page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of records per page for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The error code. Valid values:'."\n"
.'200: OK.'."\n"
.'1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call itself is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'PageInfo' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''],
'Page' => ['description' => 'The current page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
],
'title' => '',
'example' => '',
],
'InviteInfoList' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'InviteInfo' => [
'description' => 'The invitation information list.',
'type' => 'array',
'items' => [
'description' => 'The invitation information.',
'type' => 'object',
'properties' => [
'Status' => ['description' => 'The invitation status. Valid values:'."\n"
.'- 0: The registration URL has not been visited.'."\n"
.'- 1: Registration succeeded.'."\n"
.'- 2: Registration failed.'."\n"
.'- 3: The registration URL has been visited but the form has not been submitted.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'GmtCreate' => ['description' => 'The time when the invitation email was sent.', 'type' => 'string', 'example' => '2023-05-10', 'title' => ''],
'AccountNickname' => ['description' => 'The name of the invited customer.', 'type' => 'string', 'example' => '我的客户', 'title' => ''],
'Email' => ['description' => 'The email address of the invited customer.', 'type' => 'string', 'example' => '12345@qq.com', 'title' => ''],
'InviteId' => ['description' => 'The invitation ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '190', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"PageInfo\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 12,\\n \\"Page\\": 1\\n },\\n \\"InviteInfoList\\": {\\n \\"InviteInfo\\": [\\n {\\n \\"Status\\": 1,\\n \\"GmtCreate\\": \\"2023-05-10\\",\\n \\"AccountNickname\\": \\"我的客户\\",\\n \\"Email\\": \\"12345@qq.com\\",\\n \\"InviteId\\": 190\\n }\\n ]\\n },\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\"\\n}","type":"json"}]',
'title' => 'Query unassociated customers',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetUnassociatedCustomer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUnassociatedCustomer'],
],
],
],
'InviteSubAccount' => [
'summary' => 'Invites a customer to register as a partner customer.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AccountInfoList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of account information for the invitation. A maximum of five accounts can be invited at a time.',
'type' => 'array',
'items' => [
'description' => 'The account information for the invitation.',
'type' => 'object',
'properties' => [
'SubAccountType' => ['description' => 'The type of the sub-account. Valid values:'."\n"
.'- 1: end user of Agency.'."\n"
.'- 2: end user of Reseller. '."\n"
.'- 5: T2 partner of Reseller.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
'EmailAddress' => ['description' => 'The email address of the distribution customer account. The invitation email is sent to this address.', 'type' => 'string', 'required' => true, 'example' => '12345@163.com', 'title' => ''],
'AccountNickname' => ['description' => 'The name of the distribution customer. Valid values:'."\n"
.'- If the distribution customer is an enterprise, this is the company name.'."\n"
.'- If the distribution customer is a T2 reseller partner, this is the partner name.', 'type' => 'string', 'required' => true, 'example' => 'XXX技术有限公司', 'title' => ''],
'CreditLine' => ['description' => 'The total budget quota that the partner allocates to the distribution customer.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''],
'Remark' => ['description' => 'The description of the distribution customer.', 'type' => 'string', 'required' => false, 'example' => '发展xx为客户的邀请', 'title' => ''],
'ZeroCreditShutdownPolicy' => ['description' => 'The shutdown policy that the partner manages for the distribution customer. Valid values:'."\n"
."\n"
.'- 1: delayStop. Alibaba Cloud takes over the resources and the customer enjoys a delayed shutdown quota. When the delayed shutdown quota is exhausted, instance shutdown is triggered. If payment is not made within 15 days, storage resources are released.'."\n"
.'- 2: noStop. Manual management with no shutdown on overdue payment. The system does not manage the resource lifecycle of the non-trusteeship linked account. The partner must manually manage the instance shutdown status of the customer.'."\n"
.'- 3: immediatelyStop. Instances are immediately shut down on overdue payment. When the available quota of the customer account is less than 0, the account enters the overdue payment status and instance shutdown is triggered.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
'NewBuyStatus' => ['description' => 'The initial order placement status. Valid values:'."\n"
."\n"
.'- ban: Purchase is prohibited. After the customer is registered and associated, the customer cannot immediately place orders to purchase cloud resources. You must set the order control to normal before the customer can place orders.'."\n"
.'- normal: Normal. After the customer is registered and associated, the customer can immediately place orders to purchase cloud resources.', 'type' => 'string', 'required' => true, 'example' => 'ban', 'title' => ''],
'CustomerId' => ['description' => 'The customer ID returned by the CreateCustomer API.', 'type' => 'string', 'required' => true, 'example' => '1234567', 'title' => ''],
'CustomerBd' => ['title' => '', 'description' => 'The account manager of the customer. Maximum length: 50 characters.', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => true,
'maxItems' => 5,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The fault code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System Error.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for fault tracking.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API invocation is successful. Valid values: True and False. This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Results' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'Result' => [
'description' => 'The list of invitation send results.',
'type' => 'array',
'items' => [
'description' => 'The invitation result information.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The fault code. 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message returned, which describes the fault code.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Indicates whether the operation is successful. The value is always true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Result' => [
'description' => 'The invitation result details.',
'type' => 'object',
'properties' => [
'RegUrl' => ['description' => 'The registration URL for the distribution customer.', 'type' => 'string', 'example' => 'http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL', 'title' => ''],
'Days' => ['description' => 'The validity period of the registration URL, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
'InviteId' => ['description' => 'The invitation ID, which is used to query the invitation status.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error3017', 'errorMessage' => 'customerRebateType is error, only invite reseller account.', 'description' => 'customerRebateType is error,only invite reseller account.'],
['errorCode' => 'Error3008', 'errorMessage' => 'shutdown status is error.', 'description' => 'shutdown status is error.'],
['errorCode' => 'Error3009', 'errorMessage' => 'customerAccount is error.', 'description' => 'customerAccount is error.'],
['errorCode' => 'Error3010', 'errorMessage' => 'customerNick is empty.', 'description' => 'customerNick is empty.'],
['errorCode' => 'Error3011', 'errorMessage' => 'The length of customerNick greater than 50.', 'description' => 'The length of customerNick greater than 50. '],
['errorCode' => 'Error3012', 'errorMessage' => 'cid is empty.', 'description' => 'cid is empty.'],
['errorCode' => 'Error3013', 'errorMessage' => 'customCredit is empty.', 'description' => 'customCredit is empty.'],
['errorCode' => 'Error3014', 'errorMessage' => 'customCredit is a maximum of 10.', 'description' => 'customCredit is a maximum of 10.'],
['errorCode' => 'Error3015', 'errorMessage' => 'The current account is not a partner.', 'description' => 'The current account is not a distributor'],
['errorCode' => 'Error3016', 'errorMessage' => 'customerRebateType is error, only invite agency account.', 'description' => 'customerRebateType is error,only invite agency account.'],
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
['errorCode' => 'Error3056', 'errorMessage' => 'The value of subAccountType error.', 'description' => 'The value of subAccountType error'],
['errorCode' => 'Error3067', 'errorMessage' => 'Enterprise Customer Invitation Prohibition.', 'description' => 'Enterprise Customer Invitation Prohibition.'],
['errorCode' => 'Error3055', 'errorMessage' => 'subAccountType is null.', 'description' => 'subAccountType is empty'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Results\\": {\\n \\"Result\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RegUrl\\": \\"http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=-4uT%2FMWHnnUdvr5GXVd1AYK8luTnGgH3M7Y3lSCd5M1fxRwAkViTWtDJDpckh0HL\\",\\n \\"Days\\": 15,\\n \\"InviteId\\": 12345\\n }\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => 'Invite a distribution customer',
'changeSet' => [
['createdAt' => '2024-04-18T06:55:28.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2023-10-13T09:19:15.000Z', 'description' => 'Error codes changed, Request parameters changed'],
['createdAt' => '2023-09-07T12:09:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:InviteSubAccount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InviteSubAccount'],
],
],
],
'InviteSubReseller' => [
'path' => '',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'AccountInfoList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => 'The list of account information for the invitation. A maximum of five accounts can be specified at a time.',
'type' => 'array',
'items' => [
'description' => 'The list of account information for the invitation. A maximum of five accounts can be specified at a time.',
'type' => 'object',
'properties' => [
'SubAccountType' => ['description' => 'This parameter is deprecated. You do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''],
'EmailAddress' => ['description' => 'The email address to which the invitation email is sent.', 'type' => 'string', 'required' => false, 'example' => 'nejatox206@getasail.com', 'title' => ''],
'AccountNickname' => ['description' => 'The name of the distribution customer.'."\n"
.'- If the distribution customer is an enterprise, this is the company name.'."\n"
.'- If the distribution customer is a T2 Reseller partner, this is the partner name.', 'type' => 'string', 'required' => false, 'example' => 'XXX技术有限公司', 'title' => ''],
'CreditLine' => ['description' => 'The total budget quota that the partner allocates to the distribution customer.', 'type' => 'string', 'required' => false, 'example' => '100', 'title' => ''],
'Remark' => ['description' => 'The description of the distribution customer.', 'type' => 'string', 'required' => false, 'example' => '发展xx为客户的邀请', 'title' => ''],
'ZeroCreditShutdownPolicy' => ['description' => 'The shutdown policy that the partner sets for the distribution customer.'."\n"
."\n"
.'- 1: delayStop. The account uses the delayed shutdown quota for deferred instance shutdown. Alibaba Cloud takes over the resources. When the delayed shutdown quota is exhausted, instance shutdown is triggered. If the payment is not made within 15 days, storage resources are released.'."\n"
.'- 2: noStop. Manual management with no shutdown on overdue payment. The system does not manage the resource lifecycle of the non-trusteeship linked account. The partner must manually manage the instance shutdown status of the customer.'."\n"
.'- 3: immediatelyStop. Immediate shutdown on overdue payment. When the active quota of the customer account is less than 0, the account enters the overdue payment status and instance shutdown is triggered.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
'NewBuyStatus' => ['description' => 'The initial order placement status. Valid values:'."\n"
."\n"
.'- ban: Purchase is prohibited. After the customer is registered and associated, the customer cannot place orders to purchase cloud resources immediately. You must set the order control to Normal before the customer can place orders.'."\n"
.'- normal: Normal. After the customer is registered and associated, the customer can place orders to purchase cloud resources immediately.', 'type' => 'string', 'required' => false, 'example' => 'Normal', 'title' => ''],
'CustomerBd' => ['description' => 'The customer account manager. The value can be up to 50 characters in length.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''],
'RegisterNation' => ['description' => 'The country or region of the invited T2 Reseller. The value must comply with the ISO 3166-1 alpha-2 code. You can call the ListCountries operation to query the contract coverage area list of the current UID.'."\n"
."\n"
.'The system automatically determines whether the invitation is cross-region based on whether this parameter falls within the T1 contract coverage area.'."\n"
."\n"
.'- If the invitation is cross-region, a cross-region invitation approval process is initiated. After the approval is granted, an invitation registration email is sent to the specified email address.'."\n"
.'- If the invitation is not cross-region, an invitation registration email is sent directly.', 'type' => 'string', 'required' => false, 'example' => 'SG', 'title' => ''],
'CrossScopeRemark' => ['description' => 'The reason for applying for a cross-region association.', 'type' => 'string', 'required' => false, 'example' => 'XXX', 'title' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
'required' => false,
'maxItems' => 100,
'title' => '',
'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Result',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'message', 'type' => 'string', 'example' => '200', 'title' => ''],
'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Results' => [
'description' => 'The invitation result information.',
'type' => 'array',
'items' => [
'description' => 'The invitation result information.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The error code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The prompt message that describes the code.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Always true.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Result' => [
'description' => 'The invitation result details.',
'type' => 'object',
'properties' => [
'RegUrl' => ['description' => 'The registration URL of the T2 Reseller.', 'type' => 'string', 'example' => 'http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX', 'title' => ''],
'Days' => ['description' => 'The validity period of the registration URL, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''],
'InviteId' => ['description' => 'The invitation ID, which is used to query the invitation status.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error3015', 'errorMessage' => 'The current account is not a partner.', 'description' => 'The current account is not a distributor'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Invite T2 resellers',
'summary' => 'Invites T2 Reseller sub-accounts in batch as a T1 partner.',
'description' => '1. The caller of this operation must be a channel master reseller partner on Alibaba Cloud International Website.'."\n"
.'2. The system automatically determines whether the invitation is cross-region based on whether the RegisterNation parameter falls within the T1 contract coverage area. You can call the ListCountries operation to query the contract coverage area.'."\n"
.'- If the invitation is cross-region, a cross-region invitation approval process is initiated. After Alibaba Cloud approves the request, an invitation registration email is sent to the specified email address.'."\n"
.'- If the invitation is not cross-region, an invitation registration email is sent directly.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"RegUrl\\": \\"http://agency-intl.console.aliyun.com/customer/register?intl=true&fxinfo=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\\",\\n \\"Days\\": 15,\\n \\"InviteId\\": 12345\\n }\\n }\\n ]\\n}","type":"json"}]',
],
'IssueCouponForCustomer' => [
'summary' => 'Issues coupons.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CouponTemplateId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the coupon template.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5075915'],
],
[
'name' => 'Uidlist',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The list of UIDs, separated by commas (,). Example: 111,2222.', 'type' => 'string', 'required' => true, 'example' => '111,2222'],
],
[
'name' => 'AcceptLanguage',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language parameter. Default value: none. Valid values:'."\n"
.'- zh-CN: Chinese.'."\n"
.'- en-US: English.', 'type' => 'string', 'required' => false, 'example' => 'zh-CN'],
],
[
'name' => 'IsUseBenefit',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'Specifies whether to use the POC coupon quota. Valid values:'."\n"
.'- true: Uses the POC coupon quota. If all submitted accounts are marked as approval-exempt, the current coupon application skips the approval process, and the POC coupon quota in your partner benefit package is deducted.'."\n"
.'- false: Does not use the POC coupon quota. Regardless of the approval-exempt status of the submitted accounts, your POC coupon privilege quota remains unchanged. In this case, the application follows the standard coupon application approval process.', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'example' => 'true'],
],
[
'name' => 'ApplicationReason',
'in' => 'query',
'schema' => ['title' => '', 'type' => 'string', 'example' => '为客户XXX审批优惠券,该客户是XXXX', 'maxLength' => 500, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'code', 'title' => ''],
'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'data' => [
'description' => 'The returned data.',
'type' => 'object',
'properties' => [
'CouponTemplateId' => ['title' => '', 'description' => 'The ID of the coupon template.', 'type' => 'integer', 'format' => 'int64', 'example' => '5075915'],
'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-03-05 18:24:07', 'title' => ''],
'Uidlist' => ['description' => 'The list of UIDs to which coupons are issued.', 'type' => 'string', 'example' => '111,2222'."\n", 'title' => ''],
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'ERROR_3100', 'errorMessage' => 'System exceptions, please submit a work order.', 'description' => 'System exceptions, please submit a work order.'],
['errorCode' => 'ERROR_3081', 'errorMessage' => 'couponTemplateId empty, please check.', 'description' => 'couponTemplateId empty, please check.'],
['errorCode' => 'ERROR_3082', 'errorMessage' => 'Uidlist empty, please check .', 'description' => 'Uidlist is empty, please check'],
['errorCode' => 'ERROR_3080', 'errorMessage' => 'Account empty, please check.', 'description' => 'Account is empty, please check'],
['errorCode' => 'ERROR_3090', 'errorMessage' => 'You have no authority.', 'description' => 'You have no authority'],
['errorCode' => 'ERROR_3088', 'errorMessage' => 'Coupon template expired, unable to issue coupon.', 'description' => 'Coupon template expired, unable to issue coupon'],
['errorCode' => 'ERROR_3102', 'errorMessage' => 'This coupon template ID was not created by this account.', 'description' => 'This coupon template ID was not created by this account.'],
['errorCode' => 'ERROR_3089', 'errorMessage' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'description' => 'Coupon template issuance limit exceeded, unable to issue coupon'],
['errorCode' => 'ERROR_3086', 'errorMessage' => 'The current uid does not have a distribution relationship and cannot issue a coupon.', 'description' => ''],
['errorCode' => 'ERROR_3087', 'errorMessage' => 'The current uid is not the end user identity, can not issue coupons.', 'description' => 'The current uid is not the end user identity, can not issue coupons.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => 'Issue coupons',
'changeSet' => [
['createdAt' => '2025-02-20T10:29:00.000Z', 'description' => 'Request parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IssueCouponForCustomer'],
],
],
'ramActions' => [
[
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:IssueCouponForCustomer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Code\\": \\"code\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"data\\": {\\n \\"CouponTemplateId\\": 5075915,\\n \\"CreateTime\\": \\"2024-03-05 18:24:07\\",\\n \\"Uidlist\\": \\"111,2222\\\\n\\"\\n }\\n}","type":"json"}]',
],
'ListCountries' => [
'summary' => 'Queries the list of serviceable regions. This feature is available to all distributors. The response returns region codes based on the serviceable countries specified in the distributor contract.',
'methods' => ['get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The error code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System error.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message information.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => 'A747A00F-E096-5244-88B3-3E474BAE3AE4', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call itself is successful. Valid values: True and False. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Data' => [
'description' => 'The list of region codes.',
'type' => 'array',
'items' => ['description' => 'The region code.', 'type' => 'string', 'example' => 'AF', 'title' => ''],
'title' => '',
'example' => '',
],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A747A00F-E096-5244-88B3-3E474BAE3AE4\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n \\"AF\\"\\n ]\\n}","type":"json"}]',
'title' => 'Query serviceable region list',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ListCountries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCountries'],
],
],
],
'ListCouponUsage' => [
'summary' => 'Queries the coupon usage after a distribution partner issues coupons.',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Account',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The Alibaba Cloud customer account.', 'type' => 'string', 'required' => false, 'example' => 'oqevfbveuadcrduzmf@ttirv.net'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The coupon status. Valid values: </br>'."\n"
.'AVAILABLE: Normal. </br>'."\n"
.'EXHAUSTED: Exhausted. </br>'."\n"
.'EXPIRED: Expired. </br>'."\n"
.'ABANDONED: Abandoned. </br>.', 'type' => 'string', 'required' => false, 'example' => 'AVAILABLE'],
],
[
'name' => 'Page',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number. </br> '."\n"
.'Default value: 1. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page. </br>'."\n"
.'Default value: 20. Maximum value: 50. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'example' => '20', 'default' => '20', 'required' => false],
],
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The Alibaba Cloud account UID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1133166938931507'],
],
[
'name' => 'CouponTemplateId',
'in' => 'query',
'schema' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5075915', 'title' => ''],
],
[
'name' => 'T2PartnerUid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The T2 partner UID, such as 123456789.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456768', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The status code of the operation.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['title' => '', 'description' => 'The message returned by the operation.', 'type' => 'string', 'example' => '成功'],
'RequestId' => ['description' => 'The request ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
'PageInfo' => [
'description' => 'The pagination information.',
'type' => 'object',
'properties' => [
'Page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''],
],
'title' => '',
'example' => '',
],
'Data' => [
'description' => 'The returned data.',
'type' => 'array',
'items' => [
'description' => 'The data entries.',
'type' => 'object',
'properties' => [
'CouponTemplateId' => ['description' => 'The coupon template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '503802', 'title' => ''],
'CouponId' => ['description' => 'The coupon ID.', 'type' => 'string', 'example' => '59226280', 'title' => ''],
'Amount' => ['description' => 'The face value of the coupon.', 'type' => 'number', 'format' => 'double', 'example' => '200', 'title' => ''],
'Balance' => ['description' => 'The remaining balance.', 'type' => 'number', 'format' => 'double', 'example' => '0.01', 'title' => ''],
'EffDate' => ['description' => 'The validity period of the coupon.', 'type' => 'string', 'example' => '2023-04-06 00:00:00 ~ 2023-04-07 00:00:00', 'title' => ''],
'Status' => ['description' => 'The coupon status. Valid values: </br>'."\n"
.'AVAILABLE: Normal. </br>'."\n"
.'EXHAUSTED: Exhausted. </br>'."\n"
.'EXPIRED: Expired. </br>'."\n"
.'ABANDONED: Abandoned. </br>.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''],
'Account' => ['description' => 'The Alibaba Cloud account.', 'type' => 'string', 'example' => 'oqevfbveuadcrduzmf@ttirv.net', 'title' => ''],
'PublishDate' => ['description' => 'The time when the coupon was issued.', 'type' => 'string', 'example' => '2023-04-06 19:32:10'."\n", 'title' => ''],
'Uid' => ['description' => 'The Alibaba Cloud UID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1647668856741998', 'title' => ''],
'T2PartnerUid' => ['description' => 'The UID of the tier-2 distributor.', 'type' => 'string', 'example' => '5248516956402795', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"PageInfo\\": {\\n \\"Page\\": 1,\\n \\"PageSize\\": 20,\\n \\"Total\\": 300\\n },\\n \\"Data\\": [\\n {\\n \\"CouponTemplateId\\": 503802,\\n \\"CouponId\\": \\"59226280\\",\\n \\"Amount\\": 200,\\n \\"Balance\\": 0.01,\\n \\"EffDate\\": \\"2023-04-06 00:00:00 ~ 2023-04-07 00:00:00\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"Account\\": \\"oqevfbveuadcrduzmf@ttirv.net\\",\\n \\"PublishDate\\": \\"2023-04-06 19:32:10\\\\n\\",\\n \\"Uid\\": 1647668856741998,\\n \\"T2PartnerUid\\": \\"5248516956402795\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query coupon usage list',
'description' => 'Ensure that the current caller identity is a distribution partner. '."\n"
.'<notice>Available only on the China site.</notice>.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCouponUsage'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ListCouponUsage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListExportTasks' => [
'summary' => 'Queries the list of exported files.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language parameter. Valid values:'."\n"
.'- en: English.'."\n"
.'- zh: Chinese.'."\n"
.'- ja: Japanese.', 'type' => 'string', 'example' => 'en', 'default' => 'en', 'required' => false],
],
[
'name' => 'SceneCode',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The export scenario code. Valid values:'."\n"
.'- intlCustomerQuotaRecord: customer management, quota transaction export.'."\n"
.'- intlExportUsageDeductHistory: customer management, deduction details export.',
'type' => 'string',
'required' => true,
'example' => 'intlExportUsageDeductHistory',
'enum' => ['intlExportUsageDeductHistory', 'intlCustomerQuotaRecord'],
],
],
[
'name' => 'Id',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'integer', 'format' => 'int64', 'example' => '12343', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'asda1231as'],
'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Message' => ['title' => '', 'description' => 'The description of the returned result.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => '', 'description' => 'The status code of the returned result. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Data' => [
'description' => 'The returned list.',
'type' => 'array',
'items' => [
'description' => 'The returned object.',
'type' => 'object',
'properties' => [
'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057'],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-01 10:22:11'."\n"],
'Status' => ['title' => '', 'description' => 'The task status display.', 'type' => 'string', 'example' => 'Export Success'],
'StatusCode' => ['title' => '', 'description' => 'The task status code. Valid values:'."\n"
.'- 2: exporting.'."\n"
.'- 3: export succeeded.'."\n"
.'- -1: export failed.', 'type' => 'string', 'example' => '3'],
'Url' => ['title' => '', 'description' => 'The file download URL.', 'type' => 'string', 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057'],
'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'null'],
'Id' => ['title' => '', 'description' => 'The export task ID, which is a unique identifier.', 'type' => 'integer', 'format' => 'int64', 'example' => '12355'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'InvalidRequest.ExportTask.SceneCodeError', 'errorMessage' => 'The exporting scenario is incorrect.', 'description' => 'Export Scene Error'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2024-11-01 10:22:11\\\\n\\",\\n \\"Status\\": \\"Export Success\\",\\n \\"StatusCode\\": \\"3\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/511376624869_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"null\\",\\n \\"Id\\": 12355\\n }\\n ]\\n}","type":"json"}]',
'title' => 'Query exported file list',
'changeSet' => [
['createdAt' => '2025-11-27T08:25:37.000Z', 'description' => 'Request parameters changed'],
['createdAt' => '2025-11-05T09:01:00.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ListExportTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'ListTier2CouponApproval' => [
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'T2PartnerName',
'in' => 'query',
'schema' => ['description' => 'The name of the secondary distributor.', 'type' => 'string', 'required' => false, 'example' => 'test account', 'title' => ''],
],
[
'name' => 'T2PartnerUid',
'in' => 'query',
'schema' => ['description' => 'The UID of the secondary distributor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5248516956402795', 'title' => ''],
],
[
'name' => 'ApprovalStatus',
'in' => 'query',
'schema' => ['description' => 'The approval status. Valid values:'."\n"
.'- 1: Revoked.'."\n"
.'- 2: Pending approval.'."\n"
.'- 3: Rejected.'."\n"
.'- 4: Approved.'."\n"
.'- 5: Approved but failed to issue.'."\n"
.'- 8: To be processed.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20', 'title' => ''],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'ApplicationSheetId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application.', 'type' => 'string', 'required' => false, 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''],
'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => [
'description' => 'The returned data object.',
'type' => 'array',
'items' => [
'description' => 'The returned data object.',
'type' => 'object',
'properties' => [
'ApplicationSheetId' => ['description' => 'The ID of the application.', 'type' => 'string', 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
'T2PartnerName' => ['description' => 'The name of the secondary distributor.', 'type' => 'string', 'example' => 'test account', 'title' => ''],
'T2PartnerUid' => ['description' => 'The UID of the secondary distributor.', 'type' => 'integer', 'format' => 'int64', 'example' => '5248516956402795', 'title' => ''],
'ApplicationTime' => ['description' => 'The time when the application was submitted.', 'type' => 'string', 'example' => '2026-01-21 11:24', 'title' => ''],
'ApprovalStatus' => ['description' => 'The approval status. Valid values:'."\n"
."\n"
.'- 1: Revoked.'."\n"
.'- 2: Pending approval.'."\n"
.'- 3: Rejected.'."\n"
.'- 4: Approved.'."\n"
.'- 5: Approved but failed to issue.'."\n"
.'- 8: To be processed.', 'type' => 'string', 'example' => '1', 'title' => ''],
'TotalAmount' => ['description' => 'The application amount.', 'type' => 'string', 'example' => '200', 'title' => ''],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'List secondary distributor coupon approvals',
'summary' => 'Queries the list of coupon applications submitted by secondary distributors on behalf of their end users. This operation is applicable only to primary distributors.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": [\\n {\\n \\"ApplicationSheetId\\": \\"d54ca949-9b88-4514-add3-c6029c4027f4\\",\\n \\"T2PartnerName\\": \\"test account\\",\\n \\"T2PartnerUid\\": 5248516956402795,\\n \\"ApplicationTime\\": \\"2026-01-21 11:24\\",\\n \\"ApprovalStatus\\": \\"1\\",\\n \\"TotalAmount\\": \\"200\\"\\n }\\n ]\\n}","type":"json"}]',
],
'ProcessApproval' => [
'path' => '',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'ApplicationSheetId',
'in' => 'query',
'schema' => ['description' => 'The ID of the application form.', 'type' => 'string', 'required' => true, 'example' => 'd54ca949-9b88-4514-add3-c6029c4027f4', 'title' => ''],
],
[
'name' => 'ApprovalAction',
'in' => 'query',
'schema' => ['description' => 'The approval action. Valid values:'."\n"
.'- Approve: approved.'."\n"
.'- Reject: rejected.', 'type' => 'string', 'required' => true, 'example' => 'Approve', 'title' => ''],
],
[
'name' => 'ApprovalComments',
'in' => 'query',
'schema' => ['description' => 'The approval comments.', 'type' => 'string', 'required' => true, 'maxLength' => 500, 'minLength' => 1, 'example' => '同意', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'id of request', 'type' => 'string', 'example' => '23309219-4A34-589D-A3E0-9B2A3BFFD24F'],
'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The prompt message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
'Data' => ['description' => 'The approval result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Approve a general approval process',
'summary' => 'Approves a process that requires partner approval. This operation is applicable only to distributors.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"23309219-4A34-589D-A3E0-9B2A3BFFD24F\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": true\\n}","type":"json"}]',
],
'QueryAutomaticWriteOffChangeRecords' => [
'summary' => 'Queries the change records of the automatic write-off quota. Paging is supported.',
'path' => '',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CustomerUid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => false, 'example' => '2026-06-20'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => false, 'example' => '2026-05-20'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => [
'title' => '',
'description' => 'The language parameter. If not specified, the default value is en. Valid values:'."\n"
.'- en: English.'."\n"
.'- zh: Chinese.'."\n"
.'- ja: Japanese.',
'type' => 'string',
'enum' => ['zh', 'en', 'ja'],
'required' => false,
'example' => 'en',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'The response object.',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8cd24f2917797624314748873d0096'],
'Code' => ['title' => '', 'description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Message' => ['title' => '', 'description' => 'The description of the response.', 'type' => 'string', 'example' => '成功'],
'Data' => [
'description' => 'The list of query results.',
'type' => 'array',
'items' => [
'description' => 'The query result object.',
'type' => 'object',
'properties' => [
'ChangeContent' => ['title' => '', 'description' => 'The content of the operation.', 'type' => 'string', 'example' => '开启自动销账并选择 500 USD'],
'OperationTime' => ['title' => '', 'description' => 'The time of the operation.', 'type' => 'string', 'example' => '2023-12-15 10:34:36 UTC+8'],
'OperateId' => ['title' => '', 'description' => 'The operator.', 'type' => 'string', 'example' => '12312312'],
'OperateSource' => ['title' => '', 'description' => 'The description of how the operation was initiated.', 'type' => 'string', 'example' => 'API'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query automatic write-off change records',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8cd24f2917797624314748873d0096\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": [\\n {\\n \\"ChangeContent\\": \\"开启自动销账并选择 500 USD\\",\\n \\"OperationTime\\": \\"2023-12-15 10:34:36 UTC+8\\",\\n \\"OperateId\\": \\"12312312\\",\\n \\"OperateSource\\": \\"API\\"\\n }\\n ]\\n}","type":"json"}]',
],
'QueryReversedDeductionHistory' => [
'summary' => 'Queries the credit offset details for a specified customer.',
'methods' => ['get', 'post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the customer.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The start date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-07-31'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The end date. Format: yyyy-MM-dd.', 'type' => 'string', 'required' => true, 'example' => '2023-12-31'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of records per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The current page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language parameter. Valid values:'."\n"
.'- en: English'."\n"
.'- zh: Chinese'."\n"
.'- ja: Japanese.', 'type' => 'string', 'example' => 'en', 'default' => 'en', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '12'],
'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Data' => [
'title' => '',
'description' => 'The list data.',
'type' => 'array',
'items' => [
'title' => '',
'description' => 'The list data.',
'type' => 'object',
'properties' => [
'OperationSubmitType' => ['title' => '', 'description' => 'The method by which the operation was submitted. Valid values: API and ACPN.', 'type' => 'string', 'example' => 'ACPN'],
'OperationTime' => ['title' => '', 'description' => 'The time when the operation was performed.', 'type' => 'string', 'example' => '2024-11-01 10:22:11 UTC+8'],
'OperationUid' => ['title' => '', 'description' => 'The UID of the operator.', 'type' => 'string', 'example' => '132'],
'OffsetAmount' => ['title' => '', 'description' => 'The offset amount.', 'type' => 'string', 'example' => '1.00'],
],
'example' => '',
],
'example' => '',
],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'asda1231as'],
'Message' => ['title' => '', 'description' => 'The description of the response.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => '', 'description' => 'The status code of the response. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'Query credit offset details',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:QueryReversedDeductionHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Total\\": 12,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 20,\\n \\"Data\\": [\\n {\\n \\"OperationSubmitType\\": \\"ACPN\\",\\n \\"OperationTime\\": \\"2024-11-01 10:22:11 UTC+8\\",\\n \\"OperationUid\\": \\"132\\",\\n \\"OffsetAmount\\": \\"1.00\\"\\n }\\n ],\\n \\"RequestId\\": \\"asda1231as\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]',
],
'QuotaListExportPaged' => [
'summary' => 'Queries the results of quota journal export tasks for international distribution users. This operation can be called only on the China site (Chinese mainland).',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The page number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
[
'name' => 'Language',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The language parameter. Default value: en. Valid values:'."\n"
.'- en: English.'."\n"
.'- zh: Chinese.'."\n"
.'- ja: Japanese.', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '210e876f16704666020714468dab35'],
'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Msg' => ['title' => '', 'description' => 'The description of the returned result.', 'type' => 'string', 'example' => 'SUCCESS'],
'Code' => ['title' => '', 'description' => 'The status code of the returned result. A value of 200 indicates success.', 'type' => 'string', 'example' => '200'],
'Data' => [
'description' => 'The list of returned results.',
'type' => 'array',
'items' => [
'description' => 'The response data.',
'type' => 'object',
'properties' => [
'FileName' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => '5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057'],
'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2023-12-21 21:31:57 UTC+8'],
'Status' => ['title' => '', 'description' => 'The task status display.', 'type' => 'string', 'example' => '3'],
'StatusCode' => ['title' => '', 'description' => 'The task status code. Valid values:'."\n"
.'- 2: exporting.'."\n"
.'- 3: export succeeded.'."\n"
.'- -1: export failed.', 'type' => 'string', 'example' => 'Export Success'],
'Url' => ['title' => '', 'description' => 'The file download URL.', 'type' => 'string', 'example' => '//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057'],
'Message' => ['title' => '', 'description' => 'The prompt message.', 'type' => 'string', 'example' => 'success'],
],
'title' => '',
'example' => '',
],
'title' => '',
'example' => '',
],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"210e876f16704666020714468dab35\\",\\n \\"Total\\": 10,\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"FileName\\": \\"5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"CreateTime\\": \\"2023-12-21 21:31:57 UTC+8\\",\\n \\"Status\\": \\"3\\",\\n \\"StatusCode\\": \\"Export Success\\",\\n \\"Url\\": \\"//aliyun-eco-market-servic-singapore.oss-ap-southeast-1.aliyuncs.com/5113766248601929_quota_2023-06-22_2023-12-21_all_2023122121310057\\",\\n \\"Message\\": \\"success\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => 'View quota journal export results',
'description' => 'The caller must be an Alibaba Cloud international site channel master distributor partner or an Alibaba Cloud international site channel distributor partner.',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:QuotaListExportPaged',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuotaListExportPaged'],
],
],
],
'ResendEmail' => [
'summary' => 'Resends an invitation email.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'InviteId',
'in' => 'query',
'schema' => ['description' => 'The invitation ID, obtained from the InviteSbuAccount operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '176', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code.'."\n"
.'Error code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System error.'."\n"
.'- 3058: Emails are sent too frequently. A maximum of 10 emails can be sent within 5 minutes.'."\n"
.'- 3057: InviteId is empty.'."\n"
.'- 3060: No sending record found for the specified InviteId.'."\n"
.'- 3061: The registration URL has expired and the email cannot be resent.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The result message.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Valid values: True/False. Indicates whether the current API call itself is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
['errorCode' => 'Error3058', 'errorMessage' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'description' => 'Frequent email flow control limit 10 emails sent within 5 minutes'],
['errorCode' => 'InvalidParam.InviteId.InvalidId', 'errorMessage' => 'No invitation record found based on inviteId.', 'description' => 'No invitation record found based on request ID'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Resend invitation email',
'changeSet' => [
['createdAt' => '2025-01-09T07:28:43.000Z', 'description' => 'Error codes changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResendEmail'],
],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:ResendEmail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
'SetAccountInfo' => [
'summary' => 'Updates sub-account information, including the nickname and remarks.',
'methods' => ['post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AccountNickname',
'in' => 'query',
'schema' => ['description' => 'The nickname of the sub-account. For enterprise customers, this is the company name. For T2 partners, this is the partner name.', 'type' => 'string', 'required' => false, 'example' => '我的账号', 'title' => ''],
],
[
'name' => 'Remark',
'in' => 'query',
'schema' => ['description' => 'The description of the sub-account.', 'type' => 'string', 'required' => false, 'example' => '测试的账号', 'title' => ''],
],
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID of the sub-account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1133166938931507', 'title' => ''],
],
[
'name' => 'CustomerBd',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The customer business manager. Maximum length: 50 characters.', 'type' => 'string', 'required' => false, 'example' => '张三'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: A system error occurred.'."\n"
.'- 3030: The account nickname exceeds the maximum length of 150 bytes.'."\n"
.'- 3031: The remark exceeds the maximum length of 3000 bytes.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => '成功', 'title' => ''],
'Success' => ['description' => 'Valid values: True and False. Indicates whether the current API call itself is successful. This does not indicate the success of subsequent business operations.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID. Alibaba Cloud uses this ID for error tracking.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
['errorCode' => 'Error3030', 'errorMessage' => 'The maximum length of CustomNick is 150.', 'description' => 'Maximum CustomNick length is 150'],
['errorCode' => 'Error3031', 'errorMessage' => 'The maximum length of FxDescription is 3000.', 'description' => 'Maximum FxDescription length is 3000'],
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"成功\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Update sub-account information',
'changeSet' => [
['createdAt' => '2025-01-10T03:58:11.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2024-04-18T06:55:28.000Z', 'description' => 'Request parameters changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:SetAccountInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccountInfo'],
],
],
],
'SetCreditLine' => [
'summary' => 'Sets the credit limit for a reseller customer. This feature is available only for Resellers and Distributors.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID of the sub-account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1263644979775567', 'title' => ''],
],
[
'name' => 'CreditLine',
'in' => 'query',
'schema' => ['description' => 'The new credit limit.', 'type' => 'string', 'required' => true, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System error.'."\n"
.'- 3040: The sub-account is frozen and the operation cannot be completed.'."\n"
.'- 3041: The credit limit is not a number.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message that corresponds to the result code.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the API call is successful. Valid values: True and False. This does not indicate whether the subsequent business operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
['errorCode' => 'Error3040', 'errorMessage' => 'The account is in a frozen state and cannot be operated.', 'description' => 'The account is in a frozen state and cannot be operated.'],
['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'This uid is not your EU.', 'description' => 'This user is not your distribution customer'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Set credit limit for a reseller customer',
'changeSet' => [
['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:SetCreditLine',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCreditLine'],
],
],
],
'SetWarningThreshold' => [
'summary' => 'Sets the credit usage threshold. When a customer\'s available credit falls below the threshold, the reseller is notified by email. This feature is available only for Resellers and Distributors.',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'Uid',
'in' => 'query',
'schema' => ['description' => 'The UID of the reseller customer account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1792155717328010', 'title' => ''],
],
[
'name' => 'WarningValue',
'in' => 'query',
'schema' => ['description' => 'The percentage value. Valid values: 1 to 100. When the available credit drops below this percentage of the total credit limit, an alert email is sent to the reseller partner account.', 'type' => 'string', 'required' => true, 'example' => '20', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => 'The result code. Valid values:'."\n"
.'- 200: OK.'."\n"
.'- 1109: System error.'."\n"
.'- 3040: The sub-account is frozen and the operation cannot be completed.'."\n"
.'- 3044: The alert percentage value is not a number.'."\n"
.'- 3045: The alert percentage value must be from 1 to 100.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Message' => ['description' => 'The message that corresponds to the Code parameter value.', 'type' => 'string', 'example' => '200', 'title' => ''],
'Success' => ['description' => 'Indicates whether the current API call was successful. Valid values: True and False. This does not indicate whether the subsequent business operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'RequestId' => ['description' => 'The request ID. A unique identifier that Alibaba Cloud generates for the request.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4', 'title' => ''],
],
'description' => '',
'title' => '',
'example' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'Error1109', 'errorMessage' => 'system error.', 'description' => 'System exception'],
['errorCode' => 'Error3040', 'errorMessage' => 'The account is in a frozen state and cannot be operated.', 'description' => 'The account is in a frozen state and cannot be operated.'],
['errorCode' => 'Error3044', 'errorMessage' => 'The Value is not a number.', 'description' => 'Value is not a number'],
['errorCode' => 'Error3045', 'errorMessage' => 'The value must be between 1-100.', 'description' => 'Value must be between 1-100'],
['errorCode' => 'InvalidParam.Uid.NotYourEu', 'errorMessage' => 'This uid is not your EU.', 'description' => 'This user is not your distribution customer'],
['errorCode' => 'InvalidRequest.NoPermissions', 'errorMessage' => 'No permissions for the operation.', 'description' => 'You do not have permission to perform this operation.'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"200\\",\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\"\\n}","type":"json"}]',
'title' => 'Set credit usage threshold for a reseller customer',
'changeSet' => [
['createdAt' => '2025-01-10T03:58:11.000Z', 'description' => 'Error codes changed'],
['createdAt' => '2025-01-09T03:44:47.000Z', 'description' => 'Error codes changed'],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:SetWarningThreshold',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWarningThreshold'],
],
],
],
'SubscriptionBill' => [
'summary' => 'Subscribes to multi-level ecosystem partner bills on Alibaba Cloud International and generates bill files to OSS.',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'SubscribeBucket',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The name of the OSS bucket for storing bill files.', 'type' => 'string', 'required' => true, 'example' => 'bill-bucket'],
],
[
'name' => 'BucketOwnerId',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The UID of the account that owns the OSS bucket for storing files.'."\n"
."\n"
.'If a partner subscribes and needs to push files to the OSS bucket of a subordinate partner account, this account must be a subordinate partner account of the partner account. Grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the subordinate partner account. '."\n"
."\n"
.'If a partner subscribes and pushes files to the partner account\'s own OSS bucket, grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the partner account.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5569414254138836'],
],
[
'name' => 'SubscribeType',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The subscription type. Valid values: '."\n"
.'- PartnerBillingItemDetailForBillingPeriod: billing item detail.'."\n"
.'- PartnerBillingItemDetailMonthly: billing item monthly bill.'."\n"
.'- PartnerInstanceDetailForBillingPeriod: instance bill detail.'."\n"
.'- PartnerInstanceDetailMonthly: instance monthly bill.', 'type' => 'string', 'required' => true, 'example' => 'PartnerBillingItemDetailForBillingPeriod'],
],
[
'name' => 'BeginBillingCycle',
'in' => 'query',
'schema' => ['title' => '', 'description' => 'The billing month from which to start pushing bills. Format: yyyy-MM.'."\n"
."\n"
.'After a successful subscription, the system automatically pushes data from the start billing cycle to the current time. Data for up to the last six months (including the current month) can be pushed. If the specified month exceeds this range, the subscription is invalid.', 'type' => 'string', 'required' => true, 'example' => '2022-10'],
],
[
'name' => 'BillFormat',
'in' => 'query',
'schema' => ['description' => 'The bill file format. Valid values:'."\n"
.'- csv'."\n"
.'- parquet'."\n"
."\n"
.'If you subscribe to multiple file types, use separate buckets to avoid file overwriting.', 'type' => 'string', 'required' => true, 'example' => 'csv', 'title' => ''],
],
[
'name' => 'SubscribeSegmentSize',
'in' => 'query',
'schema' => ['description' => 'The row count threshold for a single bill file. If the number of rows exceeds this threshold, the file is automatically split into multiple files. The naming convention for split files is `uid_billType_billCycle_SquenceNo_fileNo`.'."\n"
."\n"
.'All information in the file names is identical except for fileNo. These files belong to the same billing cycle and the same file type but are split into multiple files.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100000', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => '',
'description' => 'result',
'type' => 'object',
'properties' => [
'Message' => ['title' => '', 'description' => 'The message returned.', 'type' => 'string', 'example' => '成功'],
'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9C14ADFE-DF0A-54D4-8BD5-45D0839246B4'],
'Data' => ['description' => 'The data returned.', 'type' => 'boolean', 'example' => 'true', 'title' => ''],
'Code' => [
'title' => '',
'description' => 'The status code.',
'enumValueTitles' => [1001 => 'Invalid subscription bill type.', 'Invalid subscription file type.', 'Invalid start push date.', 'Subscription failed.', 'No subscription permission.', 'Subscription record already exists.', 'Invalid bucket.'],
'type' => 'string',
'example' => '200',
],
'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"9C14ADFE-DF0A-54D4-8BD5-45D0839246B4\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'Subscribe to ecosystem partner bills',
'description' => '- Ensure that the caller is an Alibaba Cloud international master reseller partner.'."\n"
.'- A user can subscribe to one type of bill file at a time.'."\n"
.'- After subscription, bill files generated on the previous day are pushed daily starting from the next day. On the 5th of each month, full bill files for the previous billing cycle are pushed.'."\n"
.'- Bill files generated on a daily basis may be delayed. Delayed bill files are pushed the day after they are generated and may include bills that were delayed from earlier days. Pull the full files for the previous month at the beginning of each month.'."\n"
.'- Grant the [AliyunConsumeDump2OSSRole](https://ram.console.aliyun.com/?spm=api-workbench.API%20Document.0.0.68c71e0fhmTSJp#/role/authorize?request=%7B%22Requests%22:%20%7B%22request1%22:%20%7B%22RoleName%22:%20%22AliyunConsumeDump2OSSRole%22,%20%22TemplateId%22:%20%22Dump2OSSRole%22%7D%7D,%20%22ReturnUrl%22:%20%22https:%2F%2Fusercenter2.aliyun.com%22,%20%22Service%22:%20%22Consume%22%7D) permission to the subscribing user.'."\n"
.'- File names.'."\n"
."\n"
.'```.'."\n"
."\n"
.'BillingItemDetailForBillingPeriod (Billing item detail)'."\n"
.' '."\n"
.'Daily push file name format: UID_PartnerBillingItemDetail_YYYYMMDD_SquenceNo_fileNo. Example: 169**_BillingItemDetail_20190310_0001_01.'."\n"
.' '."\n"
.'Full file name format at the beginning of the next month: UID_PartnerBillingItemDetail_YYYYMM_SquenceNo_fileNo. Example: 169**_BillingItemDetail_201903_0001_01.'."\n"
."\n"
.'InstanceDetailForBillingPeriod (Instance bill detail)'."\n"
.' '."\n"
.' Daily push file name format: UID_PartnerInstanceDetail_YYYYMMDD_SquenceNo_fileNo. Example: 169**_InstanceDetail_20190310_0001_01.'."\n"
.' '."\n"
.'Full file name format at the beginning of the next month: UID_PartnerInstanceDetail_YYYYMM_SquenceNo_fileNo. Example: 169**_InstanceDetail_201903_1999-0001_01.'."\n"
."\n"
.'BillingItemDetailMonthly (Billing item monthly bill)'."\n"
.' '."\n"
.'Daily push file name format: UID_PartnerBillingItemDetailMonthly_YYYYMM_SquenceNo_fileNo. Example: 169**_BillingItemDetailMonthly_201903_0001_01. This file is updated daily with full data from the beginning of the month to the current day, until the 5th of the next month.'."\n"
."\n"
.'InstanceDetailMonthly (Instance monthly bill)'."\n"
.' '."\n"
.'Daily push file name format: UID_PartnerInstanceDetailMonthly_YYYYMM_SquenceNo_fileNo. Example: 169**_InstanceDetailMonthly_201903_0001_01. This file is updated daily with full data from the beginning of the month to the current day, until the 5th of the next month.'."\n"
."\n"
.'fileNo exists only when the number of bill rows reaches the split threshold and the file is split.'."\n"
."\n"
.'```'."\n"
.'**This content is published only on the Chinese site.**.',
'changeSet' => [
['createdAt' => '2024-04-10T06:15:18.000Z', 'description' => 'Response parameters changed'],
['createdAt' => '2022-12-29T13:32:00.000Z', 'description' => 'Response parameters changed'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubscriptionBill'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:SubscriptionBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.ap-southeast-1.aliyuncs.com', 'endpoint' => 'agency.ap-southeast-1.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'agency.aliyuncs.com', 'endpoint' => 'agency.aliyuncs.com', 'vpc' => 'agency-vpc.cn-hangzhou.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'Error1109', 'message' => 'system error.', 'http_code' => 400, 'description' => 'System exception'],
['code' => 'Error3008', 'message' => 'shutdown status is error.', 'http_code' => 400, 'description' => 'shutdown status is error.'],
['code' => 'Error3009', 'message' => 'customerAccount is error.', 'http_code' => 400, 'description' => 'customerAccount is error.'],
['code' => 'Error3010', 'message' => 'customerNick is empty.', 'http_code' => 400, 'description' => 'customerNick is empty.'],
['code' => 'Error3011', 'message' => 'The length of customerNick greater than 50.', 'http_code' => 400, 'description' => 'The length of customerNick greater than 50. '],
['code' => 'Error3012', 'message' => 'cid is empty.', 'http_code' => 400, 'description' => 'cid is empty.'],
['code' => 'Error3013', 'message' => 'customCredit is empty.', 'http_code' => 400, 'description' => 'customCredit is empty.'],
['code' => 'Error3014', 'message' => 'customCredit is a maximum of 10.', 'http_code' => 400, 'description' => 'customCredit is a maximum of 10.'],
['code' => 'Error3015', 'message' => 'The current account is not a partner.', 'http_code' => 400, 'description' => 'The current account is not a distributor'],
['code' => 'Error3016', 'message' => 'customerRebateType is error, only invite agency account.', 'http_code' => 400, 'description' => 'customerRebateType is error,only invite agency account.'],
['code' => 'Error3017', 'message' => 'customerRebateType is error, only invite reseller account.', 'http_code' => 400, 'description' => 'customerRebateType is error,only invite reseller account.'],
['code' => 'Error3030', 'message' => 'The maximum length of CustomNick is 150.', 'http_code' => 400, 'description' => 'Maximum CustomNick length is 150'],
['code' => 'Error3031', 'message' => 'The maximum length of FxDescription is 3000.', 'http_code' => 400, 'description' => 'Maximum FxDescription length is 3000'],
['code' => 'Error3040', 'message' => 'The account is in a frozen state and cannot be operated.', 'http_code' => 400, 'description' => 'The account is in a frozen state and cannot be operated.'],
['code' => 'Error3043', 'message' => 'The range of ShutdownStatus can only be 1 and 2.', 'http_code' => 400, 'description' => 'The range of ShutdownStatus can only be 1 and 2'],
['code' => 'Error3044', 'message' => 'The Value is not a number.', 'http_code' => 400, 'description' => 'Value is not a number'],
['code' => 'Error3045', 'message' => 'The value must be between 1-100.', 'http_code' => 400, 'description' => 'Value must be between 1-100'],
['code' => 'Error3051', 'message' => 'input accounStatus value error, It must be 1,2,3.', 'http_code' => 400, 'description' => 'Wrong value for input AccounStatus, must be 1,2 or 3'],
['code' => 'Error3052', 'message' => 'Your account is currently frozen and cannot be unfrozen for the following customer operations.', 'http_code' => 400, 'description' => ''],
['code' => 'Error3055', 'message' => 'subAccountType is null.', 'http_code' => 400, 'description' => 'subAccountType is empty'],
['code' => 'Error3056', 'message' => 'The value of subAccountType error.', 'http_code' => 400, 'description' => 'The value of subAccountType error'],
['code' => 'Error3058', 'message' => 'Frequent email flow control limit 10 emails sent within 5 minutes.', 'http_code' => 400, 'description' => 'Frequent email flow control limit 10 emails sent within 5 minutes'],
['code' => 'Error3067', 'message' => 'Enterprise Customer Invitation Prohibition.', 'http_code' => 400, 'description' => 'Enterprise Customer Invitation Prohibition.'],
['code' => 'ERROR_1002', 'message' => 'No query permission.', 'http_code' => 400, 'description' => 'No query permission'],
['code' => 'ERROR_1003', 'message' => 'No permission to operate the object.', 'http_code' => 400, 'description' => 'No permission to operate the object.'],
['code' => 'ERROR_201', 'message' => 'Parameters are illegal and required fields are empty.', 'http_code' => 400, 'description' => 'Parameters are illegal and required fields are empty.'],
['code' => 'ERROR_2307', 'message' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided.', 'http_code' => 400, 'description' => 'Coupons not in normal state or coupons for which Alibaba Cloud bears the cost cannot be voided'],
['code' => 'ERROR_2310', 'message' => 'The template has a coupon that is being approved so the template cannot be canceled.', 'http_code' => 400, 'description' => 'The template has a coupon that is being approved so the template cannot be canceled'],
['code' => 'ERROR_2311', 'message' => 'Coupon template does not exist.', 'http_code' => 400, 'description' => 'Coupon template does not exist'],
['code' => 'ERROR_3070', 'message' => 'CouponTemplateName must be entered.', 'http_code' => 400, 'description' => 'TemplateName name must be entered'],
['code' => 'ERROR_3071', 'message' => 'ApplicableProducts empty, please check.', 'http_code' => 400, 'description' => 'ApplicableProducts empty, please check.'],
['code' => 'ERROR_3072', 'message' => 'itemCodes empty, please check.', 'http_code' => 400, 'description' => 'ProductType is empty, please check'],
['code' => 'ERROR_3073', 'message' => 'amout empty, please check.', 'http_code' => 400, 'description' => 'Value empty, please check.'],
['code' => 'ERROR_3074', 'message' => 'personLimit empty, please check.', 'http_code' => 400, 'description' => 'LimitPerPerson empty, please check.'],
['code' => 'ERROR_3075', 'message' => 'applyReason empty, please check.', 'http_code' => 400, 'description' => 'ReasonForApplication empty, please check.'],
['code' => 'ERROR_3076', 'message' => 'effDateType empty, please check.', 'http_code' => 400, 'description' => 'effDateType empty, please check.'],
['code' => 'ERROR_3077', 'message' => 'effDateDay empty, please check.', 'http_code' => 400, 'description' => 'Vaildperioddays empty, please check.'],
['code' => 'ERROR_3078', 'message' => 'effDateFrom empty, please check.', 'http_code' => 400, 'description' => 'Vailddate empty, please check.'],
['code' => 'ERROR_3079', 'message' => 'effDateTo empty, please check.', 'http_code' => 400, 'description' => 'Expireddate empty, please check .'],
['code' => 'ERROR_3080', 'message' => 'Account empty, please check.', 'http_code' => 400, 'description' => 'Account is empty, please check'],
['code' => 'ERROR_3081', 'message' => 'couponTemplateId empty, please check.', 'http_code' => 400, 'description' => 'couponTemplateId empty, please check.'],
['code' => 'ERROR_3082', 'message' => 'Uidlist empty, please check .', 'http_code' => 400, 'description' => 'Uidlist is empty, please check'],
['code' => 'ERROR_3084', 'message' => 'Coupon cannot be valid for more than 180 days.', 'http_code' => 400, 'description' => 'Coupon cannot be valid for more than 180 days'],
['code' => 'ERROR_3085', 'message' => 'Product code is not in international channel partner coupons deductable product list.', 'http_code' => 400, 'description' => 'Product code is not in international channel partner coupons deductable product list.'],
['code' => 'ERROR_3087', 'message' => 'The current uid is not the end user identity, can not issue coupons.', 'http_code' => 400, 'description' => 'The current uid is not the end user identity, can not issue coupons.'],
['code' => 'ERROR_3088', 'message' => 'Coupon template expired, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template expired, unable to issue coupon'],
['code' => 'ERROR_3089', 'message' => 'Coupon template issuance limit exceeded, unable to issue coupon.', 'http_code' => 400, 'description' => 'Coupon template issuance limit exceeded, unable to issue coupon'],
['code' => 'ERROR_3090', 'message' => 'You have no authority.', 'http_code' => 400, 'description' => 'You have no authority'],
['code' => 'ERROR_3091', 'message' => 'Coupon template name length over limit.', 'http_code' => 400, 'description' => 'Coupon template name length over limit(30 characters).'],
['code' => 'ERROR_3092', 'message' => 'Reason for template request length over limit.', 'http_code' => 400, 'description' => 'Reason for template request length over limit(100 characters)'],
['code' => 'ERROR_3093', 'message' => 'Coupon cost-bearer parameters are not legal.', 'http_code' => 400, 'description' => 'Coupon cost-bearer parameters are not legal'],
['code' => 'ERROR_3094', 'message' => 'Applicable product type parameters are not legal.', 'http_code' => 400, 'description' => 'Applicable product type parameters are not legal'],
['code' => 'ERROR_3095', 'message' => 'The per-person limit is illegal.', 'http_code' => 400, 'description' => 'The per-person limit is illegal.'],
['code' => 'ERROR_3096', 'message' => 'Coupon value is illegal.', 'http_code' => 400, 'description' => 'Coupon value is illegal.'],
['code' => 'ERROR_3097', 'message' => 'Time type is illegal.', 'http_code' => 400, 'description' => 'Time type is illegal.'],
['code' => 'ERROR_3098', 'message' => 'Coupon Remarks Information length over limit.', 'http_code' => 400, 'description' => 'Coupon Remarks Information length over limit(100 characters).'],
['code' => 'ERROR_3099', 'message' => 'The start of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The start of the coupon\'s effective time cannot be earlier than the current time.'],
['code' => 'ERROR_3100', 'message' => 'System exceptions, please submit a work order.', 'http_code' => 400, 'description' => 'System exceptions, please submit a work order.'],
['code' => 'ERROR_3101', 'message' => 'PurchaseType empty, please check .', 'http_code' => 400, 'description' => 'PurchaseType empty, please check .'],
['code' => 'ERROR_3102', 'message' => 'This coupon template ID was not created by this account.', 'http_code' => 400, 'description' => 'This coupon template ID was not created by this account.'],
['code' => 'ERROR_3103', 'message' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time.', 'http_code' => 400, 'description' => 'The expiration date of the coupon\'s effective time cannot be earlier than the current time. '."\n"],
['code' => 'ERROR_3210', 'message' => 'The current calling UID is not an international channel partner.', 'http_code' => 400, 'description' => 'The current calling UID is not an international channel partner'],
['code' => 'InvalidParam.InviteId.InvalidId', 'message' => 'No invitation record found based on inviteId.', 'http_code' => 400, 'description' => 'No invitation record found based on request ID'],
['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'This uid is not your EU.', 'http_code' => 400, 'description' => 'This user is not your distribution customer'],
['code' => 'InvalidParam.Uid.NotYourEu', 'message' => 'The current customer does not belong to this partner.', 'http_code' => 400, 'description' => 'Current customer does not belong to this partner'],
['code' => 'InvalidParam.Uid.QuotaListEndDateNullError', 'message' => 'No End Time.', 'http_code' => 400, 'description' => 'End time is empty'],
['code' => 'InvalidParam.Uid.QuotaListStartDateNullError', 'message' => 'No Start Time.', 'http_code' => 400, 'description' => 'The start time is empty.'],
['code' => 'InvalidRequest.ExportTask.SceneCodeError', 'message' => 'The exporting scenario is incorrect.', 'http_code' => 400, 'description' => 'Export Scene Error'],
['code' => 'InvalidRequest.ExportTask.SceneCodeNull', 'message' => 'The exporting scenario is empty.', 'http_code' => 400, 'description' => 'The exported scene is empty.'],
['code' => 'InvalidRequest.NoPermissions', 'message' => 'No permissions for the operation.', 'http_code' => 400, 'description' => 'You do not have permission to perform this operation.'],
['code' => 'InvalidRequest.NoPermissions.NotPartner', 'message' => 'The current caller is not a partner.', 'http_code' => 400, 'description' => 'The current caller is not an eco-partner'],
['code' => 'InvalidRequest.NoPermissions.RamNoPermission', 'message' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.', 'http_code' => 400, 'description' => 'You have no permission to do this operation. Please check with your RAM Policy configuration.'],
],
'changeSet' => [
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'ListExportTasks'],
],
'createdAt' => '2025-11-27T08:25:45.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'ListExportTasks'],
],
'createdAt' => '2025-11-05T09:01:09.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'GetAccountInfo'],
],
'createdAt' => '2024-11-05T01:47:16.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed', 'api' => 'GetCoupondeductProductCode'],
],
'createdAt' => '2024-09-26T04:14:39.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed', 'api' => 'CreateCouponTemplate'],
],
'createdAt' => '2024-09-11T12:09:57.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'GetAccountInfo'],
['description' => 'Request parameters changed', 'api' => 'InviteSubAccount'],
['description' => 'Request parameters changed', 'api' => 'SetAccountInfo'],
],
'createdAt' => '2024-04-18T06:55:35.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'GetCreditInfo'],
],
'createdAt' => '2023-12-22T03:27:36.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Error codes changed, Request parameters changed', 'api' => 'InviteSubAccount'],
],
'createdAt' => '2023-10-13T09:19:47.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Request parameters changed, Response parameters changed', 'api' => 'InviteSubAccount'],
],
'createdAt' => '2023-09-07T12:09:10.000Z',
'description' => '',
],
[
'apis' => [
['description' => 'Response parameters changed', 'api' => 'SubscriptionBill'],
],
'createdAt' => '2022-12-29T13:32:39.000Z',
'description' => '添加设置信控接口',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCouponTemplate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ExportCustomerQuotaRecord'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetAccountInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeductOutstandingBalance'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditNewBuyStatus'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCountries'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CouponApprovalStatusList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuotaListExportPaged'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInviteStatus'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCouponTemplateDetail'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetShutdownPolicyRecord'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubscriptionBill'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUnassociatedCustomer'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAccountInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetWarningThreshold'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCoupondeductProductCode'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResendEmail'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDailyBill'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCouponUsage'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditEndUserStatus'],
['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCreditInfo'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelSubscriptionBill'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelCoupon'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InviteSubAccount'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCreditLine'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPurchaseControlRecord'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerOrders'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCouponTemplate'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditZeroCreditShutdown'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CustomerQuotaRecordList'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCustomer'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMonthlyBill'],
['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IssueCouponForCustomer'],
],
],
'ram' => [
'productCode' => 'Agency',
'productName' => 'Alibaba Cloud Channel Partner',
'ramCodes' => ['agency'],
'ramLevel' => 'OPERATION',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DeductOutstandingBalance',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:DeductOutstandingBalance',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCouponUsage',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ListCouponUsage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EditEndUserStatus',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:EditEndUserStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCouponTemplate',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:CreateCouponTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetShutdownPolicyRecord',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetShutdownPolicyRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetPurchaseControlRecord',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:GetPurchaseControlRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'InviteSubReseller',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:InviteSubReseller',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetWarningThreshold',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:SetWarningThreshold',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetCreditLine',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:SetCreditLine',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CustomerQuotaRecordList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:CustomerQuotaRecordList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCoupondeductProductCode',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCoupondeductProductCode',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListExportTasks',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ListExportTasks',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SubscriptionBill',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:SubscriptionBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetMonthlyBill',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetMonthlyBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCreditInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCreditInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'InviteSubAccount',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:InviteSubAccount',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetAccountInfo',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:SetAccountInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateCustomer',
'description' => '',
'operationType' => 'create',
'ramAction' => [
'action' => 'agency:CreateCustomer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCouponTemplateDetail',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCouponTemplateDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CouponApprovalStatusList',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:CouponApprovalStatusList',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QueryReversedDeductionHistory',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:QueryReversedDeductionHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelSubscriptionBill',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:CancelSubscriptionBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCustomerOrders',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCustomerOrders',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EditZeroCreditShutdown',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:EditZeroCreditShutdown',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCommissionableProducts',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetCommissionableProducts',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetInviteStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetInviteStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetDailyBill',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetDailyBill',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'CancelCoupon',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:CancelCoupon',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetAccountInfo',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetAccountInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResendEmail',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:ResendEmail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteCouponTemplate',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:DeleteCouponTemplate',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportReversedDeductionHistory',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ExportReversedDeductionHistory',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ExportCustomerQuotaRecord',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ExportCustomerQuotaRecord',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'EditNewBuyStatus',
'description' => '',
'operationType' => 'update',
'ramAction' => [
'action' => 'agency:EditNewBuyStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'QuotaListExportPaged',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:QuotaListExportPaged',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetUnassociatedCustomer',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:GetUnassociatedCustomer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListCountries',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'agency:ListCountries',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
[
'apiName' => 'IssueCouponForCustomer',
'description' => '',
'operationType' => 'none',
'ramAction' => [
'action' => 'agency:IssueCouponForCustomer',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Agency', 'resourceType' => 'All Resource', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [],
],
];
|