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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Linkcard', 'version' => '2021-05-20'],
'directories' => [
[
'children' => ['Renew', 'StopSingleCard', 'ResumeSingleCard', 'RebindResumeSingleCard', 'ForceActivation', 'SetCardStopRule', 'UpdateAutoRechargeSwitch', 'GetCredentialPoolStatistics', 'GetCardFlowInfo', 'GetCardDetail', 'ListCardInfo', 'ListOrder'],
'type' => 'directory',
'title' => '卡',
'id' => 329710,
],
[
'children' => ['AddDirectionalCard', 'AddDirectionalGroup', 'BatchAddDirectionalAddress', 'ListDirectionalAddress', 'ListDirectionalDetail', 'VerifyIotCard'],
'type' => 'directory',
'title' => '定向服务',
'id' => 329723,
],
[
'children' => ['AddTagsToCard', 'GetSimCardStateDistribution', 'AddDirectionalAddress', 'DeleteDirectionalAddress', 'DeleteDirectionalGroup', 'GetCardStatusStatistics', 'GetCardRealStatus', 'GetCardLatestFlow', 'AddCardToDirectionalGroup', 'GetRealNameStatus', 'SendMessage'],
'type' => 'directory',
'title' => '其他',
'id' => 329849,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'AddCardToDirectionalGroup' => [
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'IccidList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '卡号的iccid集合,数量小于等于200',
'type' => 'array',
'items' => ['description' => 'ICCID。', 'type' => 'string', 'required' => true, 'example' => '1111****6225'],
'required' => true,
'maxItems' => 200,
],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组ID。', 'type' => 'string', 'required' => true, 'example' => '10000002595'],
],
[
'name' => 'SerialNo',
'in' => 'query',
'schema' => ['description' => '请求编号,支持幂等。', 'type' => 'string', 'required' => true, 'example' => '123123'],
],
[
'name' => 'AddType',
'in' => 'query',
'schema' => ['description' => '添加的方式:'."\n"
."\n"
.'NEW:仅导入其中待分组的卡'."\n"
."\n"
.'TRANSFER:全量导入(卡从原分组中删除)', 'type' => 'string', 'required' => true, 'example' => 'NEW'],
],
[
'name' => 'MsgNotify',
'in' => 'query',
'schema' => ['description' => '执行成功后是否通过MQ推送,默认false: '."\n"
."\n"
.'false:不推送 '."\n"
."\n"
.'true: 推送', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ApiProduct',
'in' => 'formData',
'schema' => ['description' => 'Linkcard', 'type' => 'string', 'required' => false, 'example' => 'Linkcard'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'AddCardToDirectionalGroupResponse',
'description' => 'AddCardToDirectionalGroupResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:调用成功。'."\n"
."\n"
.'其他:调用失败。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '请求结果。',
'type' => 'object',
'properties' => [
'Result' => ['description' => '执行是否成功。'."\n"
."\n"
.'true:添加成功。'."\n"
."\n"
.'false:添加失败。', 'type' => 'boolean', 'example' => 'true'],
'SerialNo' => ['description' => '请求编号,幂等序列号', 'type' => 'string', 'example' => '123213'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"SerialNo\\": \\"123213\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddCardToDirectionalGroupResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <Result>true</Result>\\n <SerialNo>123213</SerialNo>\\n </Data>\\n</AddCardToDirectionalGroupResponse>","errorExample":""}]',
'title' => '定向分组添加卡片',
'summary' => '定向分组添加卡片。',
'changeSet' => [],
],
'AddDirectionalAddress' => [
'summary' => '定向分组新增目标地址。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000002595'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['description' => '地址类型:'."\n"
."\n"
.'客户配置: user_defined'."\n"
."\n"
.'阿里云预配:aliyun_defined', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'user_defined'],
],
[
'name' => 'AddressType',
'in' => 'query',
'schema' => ['description' => '目标地址类型:'."\n"
."\n"
.'Ip:Ip'."\n"
."\n"
.'域名:Domain', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Domain'],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => ['description' => '目标地址', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*.aliyun.com'],
],
[
'name' => 'SerialNo',
'in' => 'query',
'schema' => ['description' => '请求编号,支持幂等。', 'type' => 'string', 'required' => false, 'example' => '123123'],
],
[
'name' => 'MsgNotify',
'in' => 'query',
'schema' => ['description' => '执行成功后是否通过MQ推送,默认false:'."\n"
.'false:不推送'."\n"
.'true: 推送(目前不支持)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'UrlInsecurityForce',
'in' => 'query',
'schema' => ['description' => '检测到的高危风险域名是否强制添加,默认被拦截,不添加', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Data' => ['description' => '地址是否添加成功。'."\n"
."\n"
.'true:添加成功。'."\n"
."\n"
.'false:添加失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。'."\n"
.'false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:调用成功。'."\n"
."\n"
.'其他:调用失败。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AddDirectionalAddressResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</AddDirectionalAddressResponse>","errorExample":""}]',
'title' => '定向分组新增目标地址',
'changeSet' => [],
],
'AddDirectionalCard' => [
'summary' => '给定向分组中导入定向卡。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '定向分组ID。'."\n"
."\n"
.'您可调用接口[GetCardDetail](~~374328~~)在返回参数中查看定向分组ID(DirectionalGroupId)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5'],
],
[
'name' => 'UploadType',
'in' => 'query',
'schema' => ['description' => '导入类型。'."\n"
."\n"
.'- **NO_GROUP**:仅导入还未分组的定向卡。'."\n"
."\n"
.'- **ALL**:全量导入。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ALL'],
],
[
'name' => 'UploadMethod',
'in' => 'query',
'schema' => ['description' => '导入方式。'."\n"
."\n"
.'- **TAG**:标签,导入指定标签的定向卡。'."\n"
."\n"
.'- **ORDER**:订单,导入指定订单的定向卡。'."\n"
."\n"
.'- **FILE**:批量文件,导入批量文件中的定向卡。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TAG'],
],
[
'name' => 'TagList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签ID列表。导入方式选择为标签时,需填入该参数。',
'type' => 'array',
'items' => ['description' => '标签ID。导入方式选择为标签时,需填入该参数。'."\n"
."\n"
.'标签ID可在物联网无线连接服务控制台的**SIM卡管理** > **标签管理**页面查看。', 'type' => 'string', 'required' => false, 'example' => '5'],
'required' => true,
'docRequired' => true,
'maxItems' => 100,
],
],
[
'name' => 'OrderList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '订单编号列表。导入方式选择为订单时,需填入该参数。',
'type' => 'array',
'items' => ['description' => '订单编号。导入方式选择为订单时,需填入该参数。'."\n"
."\n"
.'订单编号可在物联网无线连接服务控制台的**订单统计** > **订单管理**页面查看。', 'type' => 'string', 'required' => false, 'example' => '2172***80589'],
'required' => false,
'maxItems' => 50,
],
],
[
'name' => 'FileUri',
'in' => 'query',
'schema' => ['description' => '批量文件的OSS路径。导入方式选择为批量文件时,需填入该参数。', 'type' => 'string', 'required' => false, 'example' => 'https://linkcard-user-online.oss-cn-zhangjiakou.aliyuncs.com/DIRECTIONAL_GROUP/20220811/xxxx.csv'],
],
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '定向分组名称。', 'type' => 'string', 'required' => false, 'example' => '测试分组'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '是否导入成功。'."\n"
."\n"
.'- **true**:导入成功。'."\n"
."\n"
.'- **false**:导入失败。', 'type' => 'string', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- 200:调用成功。'."\n"
."\n"
.'- 其他:调用失败。错误码详情,请参见[错误码](~~87387~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AddDirectionalCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</AddDirectionalCardResponse>","errorExample":""}]',
'title' => '定向分组导卡',
'description' => '## 使用说明'."\n"
.'定向卡是指仅能访问指定地址的物联网卡。可以调用接口[VerifyIotCard](~~446797~~)查询物联网卡是否为定向卡。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~30561~~)。',
'changeSet' => [],
],
'AddDirectionalGroup' => [
'summary' => '创建定向分组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'GroupName',
'in' => 'query',
'schema' => ['description' => '给定向分组设置一个名称。'."\n"
."\n"
.'分组名称支持中文、英文、数字及下划线(_),长度不超过30个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试分组', 'maxLength' => 30, 'minLength' => 0],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '定向分组ID。'."\n"
."\n"
.'请记录定向分组ID,后续调用其他接口,例如调用[AddDirectionalCard](~~446808~~)给定向分组里导入物联网卡时需填入定向分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '6'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- 200:调用成功。'."\n"
."\n"
.'- 其他:调用失败。错误码详情,请参见[错误码](~~87387~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 6,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<AddDirectionalGroupResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>系统异常</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</AddDirectionalGroupResponse>","errorExample":""}]',
'title' => '创建定向分组',
'description' => '## 使用说明'."\n"
.'仅新版定向服务菜单支持定向分组功能,如果您使用的是旧版定向服务菜单,无法使用该接口。更多信息,请参见[定向服务](~~279455~~)。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalGroup'],
],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'linkcard:AddDirectionalGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard::{#accountId}:directionalmanage/*'],
],
],
],
],
],
'AddTagsToCard' => [
'summary' => '物联网卡添加标签',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'TagNameList',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '标签名称。',
'type' => 'array',
'items' => ['description' => '标签名称。'."\n"
."\n"
.'参数为空或者空集合的时候代表从卡上删除所有标签。'."\n"
."\n"
.'如标签不存在,则会自动创建该标签并打标。', 'type' => 'string', 'required' => false, 'example' => '测试标签'],
'required' => false,
'maxItems' => 4,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:表示成功。 其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'Data' => [
'description' => '该卡已有标签的集合。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'TagName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '测试标签'],
'TagId' => ['description' => '标签ID。', 'type' => 'string', 'example' => '14'],
],
'description' => '',
],
],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => '卡号不能为空。'],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => '卡不存在或已销户'],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => '非法的请求参数。'],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"TagId\\": \\"14\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddTagsToCardResponse>\\n <Code>200</Code>\\n <Data>\\n <TagName>测试标签</TagName>\\n <TagId>14</TagId>\\n </Data>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n</AddTagsToCardResponse>","errorExample":""}]',
'title' => '物联网卡添加标签',
'changeSet' => [],
],
'BatchAddDirectionalAddress' => [
'summary' => '给定向分组添加访问地址。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '定向分组ID。'."\n"
."\n"
.'您可调用接口[GetCardDetail](~~374328~~)在返回参数中查看定向分组ID(DirectionalGroupId)。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5'],
],
[
'name' => 'Source',
'in' => 'query',
'schema' => ['description' => '地址来源。'."\n"
."\n"
.'- **user_defined**:用户配置。'."\n"
."\n"
.'- **aliyun_defined**:阿里云预配。', 'type' => 'string', 'required' => true, 'example' => 'user_defined'],
],
[
'name' => 'AddressType',
'in' => 'query',
'schema' => ['description' => '地址类型。'."\n"
."\n"
.'- **Ip**:IP地址。'."\n"
."\n"
.'- **Domain**:域名。', 'type' => 'string', 'required' => true, 'example' => 'Domain'],
],
[
'name' => 'ListAddress',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '具体定向地址。',
'type' => 'array',
'items' => ['description' => '具体地址,上限10个。', 'type' => 'string', 'required' => false, 'example' => '*.aliyun.com'],
'required' => true,
'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'BatchAddDirectionalAddressResponse',
'description' => 'BatchAddDirectionalAddressResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- 200:调用成功。'."\n"
."\n"
.'- 其他:调用失败。错误码详情,请参见[错误码](~~87387~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => ['description' => '地址是否添加成功。'."\n"
."\n"
.'- true:添加成功。'."\n"
."\n"
.'- false:添加失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"<BatchAddDirectionalAddressResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>true</Data>\\n</BatchAddDirectionalAddressResponse>","errorExample":""}]',
'title' => '定向地址添加',
'description' => '## 使用说明'."\n"
.'仅新版定向服务菜单支持定向分组功能,如果您使用的是旧版定向服务菜单,无法使用该接口。更多信息,请参见[定向服务](~~279455~~)。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~30561~~)。',
'changeSet' => [],
],
'DeleteDirectionalAddress' => [
'summary' => '定向分组删除目标地址。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000002595'],
],
[
'name' => 'Address',
'in' => 'query',
'schema' => ['description' => '目标地址。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '*.aliyun.com'],
],
[
'name' => 'SerialNo',
'in' => 'query',
'schema' => ['description' => '请求编号,支持幂等。', 'type' => 'string', 'required' => false, 'example' => '123123'],
],
[
'name' => 'MsgNotify',
'in' => 'query',
'schema' => ['description' => '执行成功后是否通过MQ推送,默认false: '."\n"
."\n"
.'false:不推送 '."\n"
."\n"
.'true: 推送', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Data' => ['description' => '操作是否成功。'."\n"
."\n"
.'true:成功。'."\n"
."\n"
.'false:失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:调用成功。'."\n"
."\n"
.'其他:调用失败。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => '请求参数%s非法.'],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => '非法的请求参数。'],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDirectionalAddressResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</DeleteDirectionalAddressResponse>","errorExample":""}]',
'title' => '定向分组删除目标地址',
'changeSet' => [],
],
'DeleteDirectionalGroup' => [
'summary' => '删除定向分组。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '分组ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000002595'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Data' => ['description' => '操作是否成功。'."\n"
."\n"
.'true:成功。'."\n"
."\n"
.'false:失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。'."\n"
.'false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:调用成功。'."\n"
."\n"
.'其他:调用失败。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => '请求参数%s非法.'],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => '非法的请求参数。'],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDirectionalGroupResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Code>200</Code>\\n</DeleteDirectionalGroupResponse>","errorExample":""}]',
'title' => '删除定向分组',
'changeSet' => [],
],
'ForceActivation' => [
'summary' => '同档位套餐的卡强制激活,实现共享流量扩池。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'DateType',
'in' => 'query',
'schema' => ['description' => '套餐类型。'."\n"
."\n"
.'- **sameflowcard**:同档位通用流量套餐。'."\n"
."\n"
.'- **directional_sameflowcard**:同档位定向流量套餐。'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'sameflowcard'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '执行结果。'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.ForceActivationSameFlowCard', 'errorMessage' => 'Only cards in the same flow support forced activation.', 'description' => ''],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
['errorCode' => 'linkcard.check.OnlyUnusedCanForceActivation', 'errorMessage' => 'Only unused cards support forced activation.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ForceActivationResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ForceActivationResponse>","errorExample":""}]',
'title' => '卡的强制激活',
'description' => '## 使用限制'."\n"
."\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'changeSet' => [],
],
'GetCardDetail' => [
'summary' => '查询卡的详情信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的**卡管理页面**查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'ShowPsim',
'in' => 'query',
'schema' => ['description' => '是否展示子卡的详情信息,默认为否。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '物联网卡的实例ID。'."\n"
."\n"
.'只有查询的物联网卡已销户时(即**DestroyCard**为**true**)需要填入该参数。'."\n"
."\n"
.'您可以调用接口[ListCardInfo](~~425529~~)在返回参数中查看物联网卡的实例ID(VsimInstanceId)。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '411****'],
],
[
'name' => 'DestroyCard',
'in' => 'query',
'schema' => ['description' => '查询的物联网卡是否已销户,默认为否。'."\n"
."\n"
.'- **true**:是。'."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '物联网卡的详情信息。',
'type' => 'object',
'properties' => [
'ListPsimCards' => [
'description' => '多网卡的子卡详情。',
'type' => 'array',
'items' => [
'description' => '多网卡的子卡详情。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '物联网卡的状态。'."\n"
."\n"
.'- **10**:可测试。'."\n"
."\n"
.'- **20**:未使用。'."\n"
."\n"
.'- **30**:使用中。'."\n"
."\n"
.'- **35**:已停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'example' => '35'],
'PrivateNetworkSegment' => ['description' => '私网网段(定向卡)。', 'type' => 'string', 'example' => '*.2.*.4'],
'OsStatus' => ['description' => '物联网卡的具体状态。'."\n"
."\n"
.'- **10**:测试期。'."\n"
.'- **20**:静默期。'."\n"
.'- **100**:使用中。'."\n"
.'- **130**:测试期换绑停用。'."\n"
.'- **150**:部分使用中。'."\n"
.'- **200**:主动停用。'."\n"
.'- **300**:达量停用。'."\n"
.'- **400**:信控停用。'."\n"
.'- **500**:换绑停用。'."\n"
.'- **600**:实名停用。'."\n"
.'- **700**:异常停用。'."\n"
.'- **40**:已停机。'."\n"
.'- **50**:已销户。', 'type' => 'string', 'example' => '300'],
'CertifyStatus' => ['description' => '实名认证状态。'."\n"
."\n"
.'- **1**:未认证。'."\n"
."\n"
.'- **2**:已认证。', 'type' => 'string', 'example' => '2'],
'ApnName' => ['description' => 'APN名称。', 'type' => 'string', 'example' => 'cmiot'],
'PeriodAddFlow' => ['description' => '周期累计流量。', 'type' => 'string', 'example' => '130.00MB'],
'Iccid' => ['description' => '子卡的ICCID。', 'type' => 'string', 'example' => '89860321******15668'],
'Vendor' => ['description' => '运营商。'."\n"
."\n"
.'- **CMCC**:移动。'."\n"
."\n"
.'- **CUCC**:联通。'."\n"
."\n"
.'- **CTCC**:电信。', 'type' => 'string', 'example' => 'CMCC'],
'PeriodSmsUse' => ['description' => '周期短信用量。', 'type' => 'string', 'example' => '0'],
'Imsi' => [
'description' => '子卡的IMSI。',
'type' => 'array',
'items' => ['description' => '子卡的IMSI。', 'type' => 'string', 'example' => '460081937******'],
],
'Msisdn' => [
'description' => '子卡的MSISDN。',
'type' => 'array',
'items' => ['description' => '子卡的MSISDN。', 'type' => 'string', 'example' => '1411111******'],
],
'OpenSms' => ['description' => '短信功能开通情况。'."\n"
."\n"
.' - **true**:开通。'."\n"
."\n"
.'- **false**:关闭。', 'type' => 'boolean', 'example' => 'true'],
'Ip' => [
'description' => '物联网卡的IP地址。',
'type' => 'array',
'items' => ['description' => '物联网卡的IP地址。', 'type' => 'string', 'example' => '1.1.*.*'],
],
],
],
],
'VsimCardInfo' => [
'description' => '物联网卡的详情。'."\n"
."\n"
.'当查询多网卡时,展示虚拟卡信息。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '物联网卡状态。'."\n"
."\n"
.'- **10**:可测试。'."\n"
."\n"
.'- **20**:未使用。'."\n"
."\n"
.'- **30**:使用中。'."\n"
."\n"
.'- **35**:已停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'example' => '35'],
'DataType' => ['description' => '流量类型。'."\n"
."\n"
.'- **singlecard**:单卡通用流量。'."\n"
."\n"
.'- **directionalcard**:单卡定向流量。'."\n"
."\n"
.'- **sameflowcard**:同档位池共享流量。'."\n"
."\n"
.'- **directional_sameflowcard**:同档位池共享定向流量。'."\n"
."\n"
.'- **unityPayPool**:统付池通用流量。'."\n"
."\n"
.'- **GREcard**:统付池定向流量。', 'type' => 'string', 'example' => 'sameflowcard'],
'CardLimitSpeedThreshold' => ['description' => '物联网卡达量限速阈值,单位为KB。(暂不支持)', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'],
'PeriodRestFlow' => ['description' => '周期剩余流量。', 'type' => 'string', 'example' => '130.00MB'],
'DirectionalGroupName' => ['description' => '定向分组名称。', 'type' => 'string', 'example' => '测试分组'],
'CredentialType' => ['description' => '套餐凭证类型。'."\n"
."\n"
.'- 单卡套餐示例:CT-SC-M-1-30M(运营商-套餐类型-套餐周期-资费版本-流量包档位)。'."\n"
."\n"
.'- 同档位池套餐示例:CM-SF-M-3-100M(运营商-套餐类型-套餐周期-资费版本-流量包档位)。'."\n"
."\n"
.'- 统付池套餐示例:CU-UPG-M-2-池编号(运营商-套餐类型-套餐周期-资费版本-池编号)。', 'type' => 'string', 'example' => 'CT-SC-M-1-30M'],
'PeriodAddFlow' => ['description' => '周期累计流量。', 'type' => 'string', 'example' => '0KB'],
'DirectionalGroupId' => ['description' => '定向分组ID。', 'type' => 'string', 'example' => '22'],
'PeriodSmsUse' => ['description' => '周期短信用量。', 'type' => 'string', 'example' => '0'],
'OsStatus' => ['description' => '物联网卡的具体状态。'."\n"
."\n"
.'- **10**:测试期。'."\n"
."\n"
.'- **20**:静默期。'."\n"
."\n"
.'- **100**:使用中。'."\n"
."\n"
.'- **150**:部分使用中。'."\n"
."\n"
.'- **200**:主动停用。'."\n"
."\n"
.'- **300**:达量停用。'."\n"
."\n"
.'- **400**:信控停用。'."\n"
."\n"
.'- **500**:换绑停用。'."\n"
."\n"
.'- **600**:实名停用。'."\n"
."\n"
.'- **700**:异常停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'example' => '200'],
'NotifyId' => ['description' => '自动化规则的通知ID。', 'type' => 'string', 'example' => '11111'],
'DataLevel' => ['description' => '流量包档位。', 'type' => 'string', 'example' => '30MB'],
'TagList' => [
'description' => '物联网卡的标签。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'TagName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '测试标签'],
'Id' => ['description' => '标签ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24'],
],
],
'example' => '测试标签',
],
'AliyunOrderId' => ['description' => '物联网卡关联的订单编号。', 'type' => 'string', 'example' => '211519634******'],
'AliFee' => ['description' => '资费版本。', 'type' => 'string', 'example' => 'ali_2'],
'ActiveType' => ['description' => '激活方式。'."\n"
."\n"
.'- **first_data_record**:首话单激活。'."\n"
."\n"
.'- **carrier_status_push**:运营商状态推送激活。'."\n"
."\n"
.'- **silence_expire**:静默期结束激活。'."\n"
."\n"
.'- **manage**:手动激活。'."\n"
."\n"
.'- **test_flow_depleted**:测试流量超套激活。', 'type' => 'string', 'example' => 'first_data_record'],
'IsAutoRecharge' => ['description' => '套餐是否自动续费。'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'AutoLimitResume' => ['description' => '达量停用后,次月是否自动复用。'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'example' => 'true'],
'CredentialInstanceId' => ['description' => '凭证实例ID。', 'type' => 'string', 'example' => '2622***'],
'CredentialLimitSpeedThreshold' => ['description' => '凭证达量限速阈值,单位为KB。(暂不支持)。', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'],
'ExpireTime' => ['description' => '套餐到期时间。', 'type' => 'string', 'example' => '2022-04-30 23:59:59'],
'FlowThresholdUnit' => ['description' => '阈值流量单位。', 'type' => 'string', 'example' => 'KB'],
'ApnName' => ['description' => 'APN名称。', 'type' => 'string', 'example' => 'cmiot'],
'ActiveTime' => ['description' => '激活时间。', 'type' => 'string', 'example' => '2021-11-16 16:35:50'],
'CardLimitStopThreshold' => ['description' => '物联网卡达量停用阈值,单位为KB。(暂不支持)', 'type' => 'integer', 'format' => 'int32', 'example' => '20480'],
'Iccid' => ['description' => '物联网卡的ICCID。', 'type' => 'string', 'example' => '89860321******15668'],
'Vendor' => ['description' => '运营商。'."\n"
."\n"
.'- **CMCC**:移动。'."\n"
."\n"
.'- **CUCC**:联通。'."\n"
."\n"
.'- **CTCC**:电信。'."\n"
."\n"
.'- **VNO**:虚拟运营商。', 'type' => 'string', 'example' => 'CMCC'],
'Period' => ['description' => '套餐结算周期。'."\n"
."\n"
.'- **1101**:月度。'."\n"
."\n"
.'- **1103**:季度。'."\n"
."\n"
.'- **1106**:半年度。'."\n"
."\n"
.'- **1112**:年度。', 'type' => 'string', 'example' => '1101'],
'PrivateNetworkSegment' => ['description' => '私网网段(定向卡)。', 'type' => 'string', 'example' => '1.*.3.*'],
'OpenAccountTime' => ['description' => '开户时间。', 'type' => 'string', 'example' => '2021-11-29 16:12:14'],
'CertifyType' => ['description' => '认证方式。'."\n"
."\n"
.'enterprise:企业认证。', 'type' => 'string', 'example' => 'enterprise'],
'SimType' => ['description' => 'SIM卡类型。'."\n"
."\n"
.'- **nano**:插拔三切卡(消费级)。'."\n"
."\n"
.'- **micro**:插拔双切卡(消费级)。'."\n"
."\n"
.'- **normal**:插拔大卡(消费级)。'."\n"
."\n"
.'- **simplus56**:贴片卡5*6(消费级)。'."\n"
."\n"
.'- **simplus22**:贴片卡2*2(消费级)。'."\n"
."\n"
.'- **industry-normal**:插拔大卡(工业级)。'."\n"
."\n"
.'- **industry-micro**:插拔双切卡(工业级)。'."\n"
."\n"
.'- **industry-nano**:插拔三切卡(工业级)。'."\n"
."\n"
.'- **simplus**:贴片卡5*6(工业级)。'."\n"
."\n"
.'- **industry-simplus22**:贴片卡2*2(工业级)。', 'type' => 'string', 'example' => 'nano'],
'CertifyStatus' => ['description' => '实名认证状态。'."\n"
."\n"
.'- **1**:未认证。'."\n"
."\n"
.'- **2**:已认证。', 'type' => 'string', 'example' => '2'],
'DeviceImei' => ['description' => '设备的IMEI号。', 'type' => 'string', 'example' => '11111111******'],
'VsimInstanceId' => ['description' => '物联网卡的InstanceId值。', 'type' => 'integer', 'format' => 'int32', 'example' => '123456'],
'AutoRebindReuse' => ['description' => '自动换绑重用。'."\n"
."\n"
.'- **true**:开。'."\n"
."\n"
.'- **false**:关。', 'type' => 'boolean', 'example' => 'false'],
'CredentialNo' => ['description' => '套餐凭证。', 'type' => 'string', 'example' => 'CM-***-*-2-**M'],
'CredentialLimitStopThreshold' => ['description' => '凭证达量停用阈值。', 'type' => 'integer', 'format' => 'int32', 'example' => '20480'],
'Imsi' => [
'description' => '物联网卡的IMSI。',
'type' => 'array',
'items' => ['description' => '物联网卡的IMSI。', 'type' => 'string', 'example' => '460081937******'],
],
'Msisdn' => [
'description' => '物联网卡的MSISDN。',
'type' => 'array',
'items' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'example' => '1440993******'],
],
'OpenSms' => ['description' => '短信功能开通情况。'."\n"
."\n"
.'- true:开通。'."\n"
."\n"
.'- false:关闭。', 'type' => 'boolean', 'example' => 'true'],
'Ip' => [
'description' => '物联网卡的IP地址。',
'type' => 'array',
'items' => ['description' => '物联网卡的IP地址。', 'type' => 'string', 'example' => '190.*.*.*'],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.InstanceIdCanNotEmpty', 'errorMessage' => 'InstanceId cannot be empty.', 'description' => ''],
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => ''],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"ListPsimCards\\": [\\n {\\n \\"Status\\": \\"35\\",\\n \\"PrivateNetworkSegment\\": \\"*.2.*.4\\",\\n \\"OsStatus\\": \\"300\\",\\n \\"CertifyStatus\\": \\"2\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"PeriodAddFlow\\": \\"130.00MB\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1411111******\\"\\n ],\\n \\"OpenSms\\": true,\\n \\"Ip\\": [\\n \\"1.1.*.*\\"\\n ]\\n }\\n ],\\n \\"VsimCardInfo\\": {\\n \\"Status\\": \\"35\\",\\n \\"DataType\\": \\"sameflowcard\\",\\n \\"CardLimitSpeedThreshold\\": 1024,\\n \\"PeriodRestFlow\\": \\"130.00MB\\",\\n \\"DirectionalGroupName\\": \\"测试分组\\",\\n \\"CredentialType\\": \\"CT-SC-M-1-30M\\",\\n \\"PeriodAddFlow\\": \\"0KB\\",\\n \\"DirectionalGroupId\\": \\"22\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"OsStatus\\": \\"200\\",\\n \\"NotifyId\\": \\"11111\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"Id\\": 24\\n }\\n ],\\n \\"AliyunOrderId\\": \\"211519634******\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"ActiveType\\": \\"first_data_record\\",\\n \\"IsAutoRecharge\\": true,\\n \\"AutoLimitResume\\": true,\\n \\"CredentialInstanceId\\": \\"2622***\\",\\n \\"CredentialLimitSpeedThreshold\\": 1024,\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\",\\n \\"FlowThresholdUnit\\": \\"KB\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"ActiveTime\\": \\"2021-11-16 16:35:50\\",\\n \\"CardLimitStopThreshold\\": 20480,\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"Period\\": \\"1101\\",\\n \\"PrivateNetworkSegment\\": \\"1.*.3.*\\",\\n \\"OpenAccountTime\\": \\"2021-11-29 16:12:14\\",\\n \\"CertifyType\\": \\"enterprise\\",\\n \\"SimType\\": \\"nano\\",\\n \\"CertifyStatus\\": \\"2\\",\\n \\"DeviceImei\\": \\"11111111******\\",\\n \\"VsimInstanceId\\": 123456,\\n \\"AutoRebindReuse\\": false,\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"CredentialLimitStopThreshold\\": 20480,\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1440993******\\"\\n ],\\n \\"OpenSms\\": true,\\n \\"Ip\\": [\\n \\"190.*.*.*\\"\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCardDetailResponse>\\n <Code>200</Code>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <ListPsimCards>\\n <Status>35</Status>\\n <PrivateNetworkSegment>*.2.*.4</PrivateNetworkSegment>\\n <OsStatus>300</OsStatus>\\n <CertifyStatus>2</CertifyStatus>\\n <ApnName>cmiot</ApnName>\\n <PeriodAddFlow>130.00MB</PeriodAddFlow>\\n <Iccid>89860321******15668</Iccid>\\n <Vendor>CMCC</Vendor>\\n <PeriodSmsUse>0</PeriodSmsUse>\\n <Imsi>460081937******</Imsi>\\n <Msisdn>1411111******</Msisdn>\\n <OpenSms>true</OpenSms>\\n <Ip>1.1.*.*</Ip>\\n </ListPsimCards>\\n <VsimCardInfo>\\n <Status>35</Status>\\n <DataType>sameflowcard</DataType>\\n <CardLimitSpeedThreshold>1024</CardLimitSpeedThreshold>\\n <PeriodRestFlow>130.00MB</PeriodRestFlow>\\n <DirectionalGroupName>测试分组</DirectionalGroupName>\\n <CredentialType>CT-SC-M-1-30M</CredentialType>\\n <PeriodAddFlow>0KB</PeriodAddFlow>\\n <DirectionalGroupId>22</DirectionalGroupId>\\n <PeriodSmsUse>0</PeriodSmsUse>\\n <OsStatus>200</OsStatus>\\n <NotifyId>11111</NotifyId>\\n <DataLevel>30MB</DataLevel>\\n <TagList>\\n <TagName>测试标签</TagName>\\n <Id>24</Id>\\n </TagList>\\n <AliyunOrderId>211519634******</AliyunOrderId>\\n <AliFee>ali_2</AliFee>\\n <ActiveType>first_data_record</ActiveType>\\n <IsAutoRecharge>true</IsAutoRecharge>\\n <AutoLimitResume>true</AutoLimitResume>\\n <CredentialInstanceId>2622***</CredentialInstanceId>\\n <CredentialLimitSpeedThreshold>1024</CredentialLimitSpeedThreshold>\\n <ExpireTime>2022-04-30 23:59:59</ExpireTime>\\n <FlowThresholdUnit>KB</FlowThresholdUnit>\\n <ApnName>cmiot</ApnName>\\n <ActiveTime>2021-11-16 16:35:50</ActiveTime>\\n <CardLimitStopThreshold>20480</CardLimitStopThreshold>\\n <Iccid>89860321******15668</Iccid>\\n <Vendor>CMCC</Vendor>\\n <Period>1101</Period>\\n <PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>\\n <OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>\\n <CertifyType>enterprise</CertifyType>\\n <SimType>nano</SimType>\\n <CertifyStatus>2</CertifyStatus>\\n <DeviceImei>11111111******</DeviceImei>\\n <VsimInstanceId>123456</VsimInstanceId>\\n <AutoRebindReuse>false</AutoRebindReuse>\\n <CredentialNo>CM-***-*-2-**M</CredentialNo>\\n <CredentialLimitStopThreshold>20480</CredentialLimitStopThreshold>\\n <Imsi>460081937******</Imsi>\\n <Msisdn>1440993******</Msisdn>\\n <OpenSms>true</OpenSms>\\n <Ip>190.*.*.*</Ip>\\n </VsimCardInfo>\\n </Data>\\n</GetCardDetailResponse>","errorExample":""}]',
'title' => '卡详情查询',
'description' => '## 限制说明'."\n"
."\n\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => ' 调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetCardFlowInfo' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'DateList',
'in' => 'query',
'style' => 'repeatList',
'schema' => [
'description' => '需要查询的月份。'."\n"
."\n"
.'最多可以查询6个月,如果为空则获取最近两个月的数据。',
'type' => 'array',
'items' => ['description' => '需要查询的月份。'."\n"
."\n"
.'最多可以查询6个月,如果为空则获取最近两个月的数据。', 'type' => 'string', 'required' => false, 'example' => '["202110","202111"]'],
'required' => false,
'example' => '["202110","202111"]',
'maxItems' => 5,
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '物联网卡的流量信息。',
'type' => 'object',
'properties' => [
'ListVendorDetail' => [
'description' => '网络数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'NetWorkDelay' => ['description' => '网络延迟,单位ms。', 'type' => 'string', 'example' => '20'],
'SignalStrength' => ['description' => '信号强度。', 'type' => 'string', 'example' => '20'],
'Vendor' => ['description' => '物联网卡的运营商。'."\n"
.'- CMCC:移动。'."\n"
.'- CUCC:联通。'."\n"
.'- CTCC:电信。'."\n", 'type' => 'string', 'example' => 'CMCC'],
'UsedFlow' => ['description' => '已用流量。', 'type' => 'string', 'example' => '100MB'],
'Ratio' => ['description' => '用量占比。', 'type' => 'string', 'example' => '80%'],
],
'description' => '',
],
],
'ListCardMonthFlow' => [
'description' => '月用量详情。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'FlowCount' => ['description' => '月总流量统计。', 'type' => 'string', 'example' => '200MB'],
'Month' => ['description' => '流量月份。', 'type' => 'string', 'example' => '202112'],
'ListDayFlow' => [
'description' => '每日用量。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Flow' => ['description' => '日用量。', 'type' => 'string', 'example' => '100MB'],
'Day' => ['description' => '流量日期。', 'type' => 'string', 'example' => '20211201'],
],
'description' => '',
],
],
],
'description' => '',
],
],
'ListPackageDTO' => [
'description' => '套餐包信息。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'EffectiveTime' => ['description' => '套餐生效时间。', 'type' => 'string', 'example' => '2022-03-20 23:59:59'],
'Remark' => ['description' => '备注。', 'type' => 'string', 'example' => '备注内容'],
'PackageName' => ['description' => '套餐名称。', 'type' => 'string', 'example' => '移动-单卡通用流量-月包-30M'],
'ExpireTime' => ['description' => '套餐到期时间。', 'type' => 'string', 'example' => '2022-04-30 23:59:59'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => '卡号不能为空。'],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => '非法的请求参数。'],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => '卡不存在或已销户'],
['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => '卡号有误,卡不存在'],
['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => '卡已经被销户'],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
],
500 => [
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"ListVendorDetail\\": [\\n {\\n \\"NetWorkDelay\\": \\"20\\",\\n \\"SignalStrength\\": \\"20\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"UsedFlow\\": \\"100MB\\",\\n \\"Ratio\\": \\"80%\\"\\n }\\n ],\\n \\"ListCardMonthFlow\\": [\\n {\\n \\"FlowCount\\": \\"200MB\\",\\n \\"Month\\": \\"202112\\",\\n \\"ListDayFlow\\": [\\n {\\n \\"Flow\\": \\"100MB\\",\\n \\"Day\\": \\"20211201\\"\\n }\\n ]\\n }\\n ],\\n \\"ListPackageDTO\\": [\\n {\\n \\"EffectiveTime\\": \\"2022-03-20 23:59:59\\",\\n \\"Remark\\": \\"备注内容\\",\\n \\"PackageName\\": \\"移动-单卡通用流量-月包-30M\\",\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCardFlowInfoResponse>\\n <Code>200</Code>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Data>\\n <ListVendorDetail>\\n <NetWorkDelay>20</NetWorkDelay>\\n <SignalStrength>20</SignalStrength>\\n <Vendor>CMCC</Vendor>\\n </ListVendorDetail>\\n <ListCardMonthFlow>\\n <FlowCount>200MB</FlowCount>\\n <Month>202112</Month>\\n <ListDayFlow>\\n <Flow>100MB</Flow>\\n <Day>20211201</Day>\\n </ListDayFlow>\\n </ListCardMonthFlow>\\n <ListPackageDTO>\\n <EffectiveTime>2022-03-20 23:59:59</EffectiveTime>\\n <Remark>备注内容</Remark>\\n <PackageName>移动-单卡通用流量-月包-30M</PackageName>\\n <ExpireTime>2022-04-30 23:59:59</ExpireTime>\\n </ListPackageDTO>\\n </Data>\\n</GetCardFlowInfoResponse>","errorExample":""}]',
'title' => '卡流量查询',
'summary' => '查询卡的流量信息。',
'description' => '## 限制说明'."\n"
."\n\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetCardLatestFlow' => [
'summary' => '该接口用于查询物联网卡的实时周期用量。',
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['title' => 'iccid', 'description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/sim/card)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'example' => '89860321******15668'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'GetCardLatestFlowResponse',
'description' => 'GetCardLatestFlowResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。'."\n"
.'false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:表示成功。'."\n"
."\n"
.'其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => ['description' => '实时周期用量,带流量单位。', 'type' => 'string', 'example' => '1.00MB'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
['errorCode' => 'linkcard.common.IccidNotExist', 'errorMessage' => 'IccId does not exist.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": \\"1.00MB\\"\\n}","errorExample":""},{"type":"xml","example":"<GetCardLatestFlowResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>1.00MB</Data>\\n</GetCardLatestFlowResponse>","errorExample":""}]',
'title' => 'GetCardLatestFlow',
'changeSet' => [],
],
'GetCardRealStatus' => [
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面查看ICCID。', 'type' => 'string', 'required' => false, 'example' => '89860321******15668'],
],
[
'name' => 'Msisdn',
'in' => 'query',
'schema' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '144******1111'],
],
[
'name' => 'SerialNo',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '轮询查询结果的唯一标识。',
'type' => 'array',
'items' => ['description' => '轮询查询结果的唯一标识。'."\n"
."\n"
.'说明:'."\n"
."\n"
.'1、因该接口运营商能力较弱,查询结果需时,故结合轮询能力使用。'."\n"
."\n"
.'2、在首次请求后,如Status未成功,则返回参数中会带此数据,再用此数据进行结果轮询。', 'type' => 'string', 'required' => false, 'example' => '4f84******7895'],
'required' => false,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetCardRealStatusResponse',
'description' => 'GetCardRealStatusResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:表示成功。 其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回数据。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'SerialNo' => ['description' => '轮询查询结果的唯一标识。'."\n"
."\n"
.'说明:'."\n"
."\n"
.'1、因该接口运营商能力较弱,查询结果需时,故结合轮询能力使用。'."\n"
."\n"
.'2、在首次请求后,如Status未成功,则返回参数中会带此数据,再用此数据进行结果轮询。', 'type' => 'string', 'example' => '4f84******7895'],
'Iccid' => ['description' => '卡的ICCID,当请求ICCID为多网卡主卡时,此处返回子卡ICCID。', 'type' => 'string', 'example' => '89860321******15668'],
'Gprs' => ['description' => '网络服务状态。'."\n"
."\n"
.'true:开通。'."\n"
."\n"
.'false:关闭。', 'type' => 'boolean', 'example' => 'true'],
'Online' => ['description' => '在线状态。'."\n"
."\n"
.'true:在线。'."\n"
."\n"
.'false:不在线。', 'type' => 'boolean', 'example' => 'true'],
'Status' => ['description' => '查询结果状态: '."\n"
."\n"
.'SUCCESS:成功'."\n"
."\n"
.'FAILURE:失败'."\n"
."\n"
.'PROCESSING'."\0".':处理中', 'type' => 'string', 'example' => 'SUCCESS'],
],
'description' => '',
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": [\\n {\\n \\"SerialNo\\": \\"4f84******7895\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Gprs\\": true,\\n \\"Online\\": true,\\n \\"Status\\": \\"SUCCESS\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetCardRealStatusResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <SerialNo>4f84b7a5-90******07895</SerialNo>\\n <Iccid>89860321******15668</Iccid>\\n <Gprs>true</Gprs>\\n <Online>true</Online>\\n <Status>SUCCESS</Status>\\n </Data>\\n</GetCardRealStatusResponse>","errorExample":""}]',
'title' => '智能诊断-查询卡在运营商侧状态',
'summary' => '智能诊断-查询卡在运营商侧状态',
'changeSet' => [],
],
'GetCardStatusStatistics' => [
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:表示成功。'."\n"
.'其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。'."\n"
.'false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'UnbindResumeStatisticsDTO' => [
'description' => '换绑停用数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'FlowOutStatisticsDTO' => [
'description' => '信控停用数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'ErrorStopStatisticsDTO' => [
'description' => '异常停用数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'ExhaustStopStatisticsDTO' => [
'description' => '达量停用数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'UnCertifiedStopStatisticsDTO' => [
'description' => '未实名停用数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'ManageStopStatisticsDTO' => [
'description' => '主动停用数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'ExpireStopStatisticsDTO' => [
'description' => '套餐到期停机数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'WeekWarnStatisticsDTO' => [
'description' => '套餐7天到期预警数据统计。',
'type' => 'object',
'properties' => [
'PoolCount' => ['description' => '统付池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'SingleCardCount' => ['description' => '单卡套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'SameFlowCardCount' => ['description' => '同档位池套餐卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'],
'TotalCount' => ['description' => '总卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
],
],
'RiskWaringStatisticsDTO' => [
'description' => '风险告警统计。与控制台风险告警板块数据一致。',
'type' => 'object',
'properties' => [
'WarningCount' => ['description' => '到期预警数。(7天内套餐到期)', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'WaringTotalCount' => ['description' => '总告警数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'StopCount' => ['description' => '停机/停用数。', 'type' => 'integer', 'format' => 'int64', 'example' => '40'],
'LeftFlowPercentageWarnCount' => ['description' => '余量预警数。(单卡套餐余量不足10%)', 'type' => 'integer', 'format' => 'int64', 'example' => '40'],
],
],
'SingCardPeriodLeftFlowWarnDTO' => [
'description' => '套餐余量不足数据统计。',
'type' => 'object',
'properties' => [
'LessFlowPercentage10Count' => ['description' => '单卡周期套餐余量不足10%的告警数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'LessFlowPercentage30Count' => ['description' => '单卡周期套餐余量不足30%的告警数量.', 'type' => 'integer', 'format' => 'int64', 'example' => '8'],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"UnbindResumeStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"FlowOutStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ErrorStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ExhaustStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"UnCertifiedStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ManageStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"ExpireStopStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"WeekWarnStatisticsDTO\\": {\\n \\"PoolCount\\": 10,\\n \\"SingleCardCount\\": 20,\\n \\"SameFlowCardCount\\": 30,\\n \\"TotalCount\\": 60\\n },\\n \\"RiskWaringStatisticsDTO\\": {\\n \\"WarningCount\\": 20,\\n \\"WaringTotalCount\\": 100,\\n \\"StopCount\\": 40,\\n \\"LeftFlowPercentageWarnCount\\": 40\\n },\\n \\"SingCardPeriodLeftFlowWarnDTO\\": {\\n \\"LessFlowPercentage10Count\\": 5,\\n \\"LessFlowPercentage30Count\\": 8\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCardStatusStatisticsResponse>\\n <code>200</code>\\n <data>\\n <RequestId>DCBDCDBC-0E54-53AC-97A4-6194849CC6BC</RequestId>\\n <Data>\\n <ExhaustStopStatisticsDTO>\\n <TotalCount>8</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>4</SameFlowCardCount>\\n <PoolCount>4</PoolCount>\\n </ExhaustStopStatisticsDTO>\\n <WeekWarnStatisticsDTO>\\n <TotalCount>20</TotalCount>\\n <SingleCardCount>20</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>0</PoolCount>\\n </WeekWarnStatisticsDTO>\\n <FlowOutStatisticsDTO>\\n <TotalCount>12</TotalCount>\\n <SingleCardCount>7</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>5</PoolCount>\\n </FlowOutStatisticsDTO>\\n <SingCardPeriodLeftFlowWarnDTO>\\n <LessFlowPercentage10Count>15</LessFlowPercentage10Count>\\n <LessFlowPercentage30Count>0</LessFlowPercentage30Count>\\n </SingCardPeriodLeftFlowWarnDTO>\\n <ErrorStopStatisticsDTO>\\n <TotalCount>1</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>1</PoolCount>\\n </ErrorStopStatisticsDTO>\\n <ExpireStopStatisticsDTO>\\n <TotalCount>652</TotalCount>\\n <SingleCardCount>506</SingleCardCount>\\n <SameFlowCardCount>146</SameFlowCardCount>\\n <PoolCount>0</PoolCount>\\n </ExpireStopStatisticsDTO>\\n <UnbindResumeStatisticsDTO>\\n <TotalCount>1</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>1</PoolCount>\\n </UnbindResumeStatisticsDTO>\\n <UnCertifiedStopStatisticsDTO>\\n <TotalCount>1</TotalCount>\\n <SingleCardCount>0</SingleCardCount>\\n <SameFlowCardCount>0</SameFlowCardCount>\\n <PoolCount>1</PoolCount>\\n </UnCertifiedStopStatisticsDTO>\\n <RiskWaringStatisticsDTO>\\n <WarningCount>20</WarningCount>\\n <StopCount>825</StopCount>\\n <LeftFlowPercentageWarnCount>15</LeftFlowPercentageWarnCount>\\n <WaringTotalCount>860</WaringTotalCount>\\n </RiskWaringStatisticsDTO>\\n <ManageStopStatisticsDTO>\\n <TotalCount>150</TotalCount>\\n <SingleCardCount>57</SingleCardCount>\\n <SameFlowCardCount>31</SameFlowCardCount>\\n <PoolCount>62</PoolCount>\\n </ManageStopStatisticsDTO>\\n </Data>\\n <ErrorMessage/>\\n <Code/>\\n <Success>true</Success>\\n <LocalizedMessage/>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>DCBDCDBC-0E54-53AC-97A4-6194849CC6BC</requestId>\\n <successResponse>true</successResponse>\\n</GetCardStatusStatisticsResponse>","errorExample":""}]',
'title' => '概览页风险告警',
'summary' => '概览页风险告警',
'changeSet' => [],
],
'GetCredentialPoolStatistics' => [
'summary' => '查询套餐凭证对应的池信息。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Date',
'in' => 'query',
'schema' => ['description' => '要查询的套餐流量使用详情的月份。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '202108'],
],
[
'name' => 'CredentialNO',
'in' => 'query',
'schema' => ['description' => '套餐凭证。获取方法如下:'."\n"
."\n"
.'- 在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的**套餐凭证**页面,查看套餐凭证。'."\n"
."\n"
.'- 调用接口[GetCardDetail](~~374328~~),在返回参数中查看套餐凭证(CredentialNo)。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CM-SF-M-2-12G'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => '系统异常'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- true:调用成功。'."\n"
."\n"
.'- false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '套餐流量使用详情。',
'type' => 'object',
'properties' => [
'PoolUsed' => ['description' => '当月已用流量。', 'type' => 'string', 'example' => '0KB'],
'CredentialNO' => ['description' => '套餐凭证。', 'type' => 'string', 'example' => 'CM-SF-M-2-12G'],
'PoolOutUsed' => ['description' => '当月套餐外流量。', 'type' => 'string', 'example' => '0KB'],
'PoolGrandTotalUsed' => ['description' => '套餐流量使用总量,仅统付池套餐显示该参数。', 'type' => 'string', 'example' => '6.00GB'],
'CredentialType' => ['description' => '套餐凭证类型。'."\n"
."\n"
.'- 单卡套餐示例:CT-SC-M-1-30M(运营商-套餐类型-套餐周期-资费版本-流量包档位)。'."\n"
."\n"
.'- 同档位池套餐示例:CM-SF-M-3-100M(运营商-套餐类型-套餐周期-资费版本-流量包档位)。'."\n"
."\n"
.'- 统付池套餐示例:CU-UPG-M-2-池编号(运营商-套餐类型-套餐周期-资费版本-池编号)。', 'type' => 'string', 'example' => 'CT-SC-M-1-30M'],
'CardTotalNum' => ['description' => '套餐内总卡数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'PoolGrandTotal' => ['description' => '套餐总流量,仅统付池套餐显示该参数。', 'type' => 'string', 'example' => '12.00GB'],
'CardActiveNum' => ['description' => '套餐内的生效卡数(已激活且未停机未销户)。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'EffectiveTotalFlow' => ['description' => '套餐总流量,仅同档位池套餐显示该参数。', 'type' => 'string', 'example' => '12.00GB'],
'EffectiveAvailableFlow' => ['description' => '套餐内可用余量,仅同档位池套餐显示该参数。', 'type' => 'string', 'example' => '6.00GB'],
'PoolAvaiable' => ['description' => '套餐内可用余量,仅统付池套餐显示该参数。', 'type' => 'string', 'example' => '6.00GB'],
'MonthFeatureFee' => ['description' => '月功能费份数,仅统付池套餐显示该参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'CredentialInstanceId' => ['description' => '凭证实例ID。', 'type' => 'string', 'example' => '259****'],
'SmsUsed' => ['description' => '短信用量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'MonthUsedAmount' => ['description' => '月度流量使用总量。', 'type' => 'integer', 'format' => 'int64', 'example' => '3.00GB'],
'MonthExceedFee' => ['description' => '当月功能费超套份数。'."\n"
."\n"
.'大于0代表功能费已超套;等于0或null代表未超套。', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.TimeFormatError', 'errorMessage' => 'Time format error.', 'description' => ''],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PoolUsed\\": \\"0KB\\",\\n \\"CredentialNO\\": \\"CM-SF-M-2-12G\\",\\n \\"PoolOutUsed\\": \\"0KB\\",\\n \\"PoolGrandTotalUsed\\": \\"6.00GB\\",\\n \\"CredentialType\\": \\"CT-SC-M-1-30M\\",\\n \\"CardTotalNum\\": 20,\\n \\"PoolGrandTotal\\": \\"12.00GB\\",\\n \\"CardActiveNum\\": 10,\\n \\"EffectiveTotalFlow\\": \\"12.00GB\\",\\n \\"EffectiveAvailableFlow\\": \\"6.00GB\\",\\n \\"PoolAvaiable\\": \\"6.00GB\\",\\n \\"MonthFeatureFee\\": 100,\\n \\"CredentialInstanceId\\": \\"259****\\",\\n \\"SmsUsed\\": 0,\\n \\"MonthUsedAmount\\": 0,\\n \\"MonthExceedFee\\": 200\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetCredentialPoolStatisticsResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PoolUsed>0KB</PoolUsed>\\n <CredentialNO>CM-SF-M-2-12G</CredentialNO>\\n <PoolOutUsed>0KB</PoolOutUsed>\\n <PoolGrandTotalUsed>6.00GB</PoolGrandTotalUsed>\\n <CredentialType>CM-SF-M-2-12G</CredentialType>\\n <CardTotalNum>20</CardTotalNum>\\n <PoolGrandTotal>12.00GB</PoolGrandTotal>\\n <CardActiveNum>10</CardActiveNum>\\n <EffectiveTotalFlow>12.00GB</EffectiveTotalFlow>\\n <EffectiveAvailableFlow>6.00GB</EffectiveAvailableFlow>\\n <PoolAvaiable>6.00GB</PoolAvaiable>\\n <MonthFeatureFee>100</MonthFeatureFee>\\n <CredentialInstanceId>259****</CredentialInstanceId>\\n <SmsUsed>0</SmsUsed>\\n </Data>\\n</GetCredentialPoolStatisticsResponse>","errorExample":""}]',
'title' => '套餐凭证信息查询',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'GetRealNameStatus' => [
'summary' => '该接口用于查询物联网卡的个人实名状态。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/sim/card)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'example' => '89860321******15668'],
],
[
'name' => 'ListMsisdns',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '多网卡子卡MSISDN。',
'type' => 'array',
'items' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '144******1111'],
'required' => false,
'maxItems' => 10,
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'GetRealNameStatusResponse',
'description' => 'GetRealNameStatusResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。'."\n"
.'false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:表示成功。'."\n"
.'其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'RealNameStatus' => ['description' => '个人实名认证状态。'."\n"
.'NOT_CERTIFIED:未认证'."\n"
.'APPROVING:认证审核中'."\n"
.'CERTIFIED:已认证', 'type' => 'string', 'example' => 'CERTIFIED'],
'Desc' => ['description' => '认证状态描述。', 'type' => 'string', 'example' => '已认证'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
['errorCode' => 'linkcard.common.IccidFormatError', 'errorMessage' => 'Iccid format error.', 'description' => ''],
['errorCode' => 'linkcard.common.VnoCardNotSupported', 'errorMessage' => 'This function does not support vno card.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"RealNameStatus\\": \\"CERTIFIED\\",\\n \\"Desc\\": \\"已认证\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRealNameStatusResponse>\\n <data>\\n <realNameStatus>NOT_CERTIFIED</realNameStatus>\\n <desc>未认证</desc>\\n </data>\\n <requestId>D3778AAD-6A0E-16F8-8074-C4AF604E21B3</requestId>\\n <success>true</success>\\n</GetRealNameStatusResponse>","errorExample":""}]',
'title' => 'GetRealNameStatus',
'changeSet' => [],
],
'GetSimCardStateDistribution' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'CredentialNO',
'in' => 'query',
'schema' => ['description' => '套餐凭证编号,您可在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/sim/license)的凭证管理页面查看。', 'type' => 'string', 'required' => false, 'example' => 'CT-SC-M-2-100M'],
],
[
'name' => 'Date',
'in' => 'query',
'schema' => ['description' => '查询的日期。'."\n"
."\n"
.'格式:yyyyMM。', 'type' => 'string', 'required' => true, 'example' => '202209'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:表示成功。'."\n"
."\n"
.'其它:表示错误码。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。'."\n"
.'false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
'CardCount' => ['description' => '卡总数。', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'TestCount' => ['description' => '可测试卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'UnusedCount' => ['description' => '未使用卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'StopCount' => ['description' => '已停用卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'DestoryedCount' => ['description' => '已销户卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'UsingCount' => ['description' => '使用中卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
'ShutDownCount' => ['description' => '已停机卡数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.check.TimeFormatError', 'errorMessage' => 'Time format error.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CredentialInstanceNotExist', 'errorMessage' => 'The credential instance does not exist.', 'description' => ''],
['errorCode' => 'linkcard.common.CredentialNoNotExist', 'errorMessage' => 'The credentialNo does not exist', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CardCount\\": 100,\\n \\"TestCount\\": 20,\\n \\"UnusedCount\\": 10,\\n \\"StopCount\\": 5,\\n \\"DestoryedCount\\": 0,\\n \\"UsingCount\\": 50,\\n \\"ShutDownCount\\": 10\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetSimCardStateDistributionResponse>\\n <code>200</code>\\n <data>\\n <RequestId>5C06CF1A-959D-10A9-9C56-003EDF663BAF</RequestId>\\n <Data>\\n <StopCount>166</StopCount>\\n <TestCount>50098</TestCount>\\n <UnusedCount>426</UnusedCount>\\n <CardCount>902847</CardCount>\\n <DestoryedCount>340498</DestoryedCount>\\n <UsingCount>511007</UsingCount>\\n <ShutDownCount>652</ShutDownCount>\\n </Data>\\n <Success>true</Success>\\n </data>\\n <httpStatusCode>200</httpStatusCode>\\n <requestId>5C06CF1A-959D-10A9-9C56-003EDF663BAF</requestId>\\n <successResponse>true</successResponse>\\n</GetSimCardStateDistributionResponse>","errorExample":""}]',
'title' => '获取卡状态分布',
'summary' => '获取卡状态分布',
'changeSet' => [],
],
'ListCardInfo' => [
'summary' => '查询卡列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ActiveTimeEnd',
'in' => 'query',
'schema' => ['description' => '物联网卡的激活时间区间:结束时间。'."\n"
."\n"
.'格式为:`yyyy-MM-dd HH:mm:ss`。', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的数量,支持10、15、25、40。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的**卡管理页面**查看ICCID。', 'type' => 'string', 'required' => false, 'example' => '89860321******15668'],
],
[
'name' => 'CredentialNo',
'in' => 'query',
'schema' => ['description' => '套餐凭证。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'CM-***-*-2-**M'],
],
[
'name' => 'Vendor',
'in' => 'query',
'schema' => ['description' => '运营商。'."\n"
."\n"
.'- **CMCC**:移动。'."\n"
."\n"
.'- **CUCC**:联通。'."\n"
."\n"
.'- **CTCC**:电信。'."\n"
."\n"
.'- **VNO**:虚拟运营商。', 'type' => 'string', 'required' => false, 'example' => 'CMCC'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '查询页数,需结合**PageSize**参数组合使用。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'Msisdn',
'in' => 'query',
'schema' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '1440993******'],
],
[
'name' => 'AliyunOrderId',
'in' => 'query',
'schema' => ['description' => '物联网卡关联的订单编号。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => '211519634******'],
],
[
'name' => 'AliFee',
'in' => 'query',
'schema' => ['description' => '资费版本。', 'type' => 'string', 'required' => false, 'example' => 'ali_2'],
],
[
'name' => 'Period',
'in' => 'query',
'schema' => ['description' => '套餐结算周期。'."\n"
."\n"
.'- **1101**:月度。'."\n"
."\n"
.'- **1103**:季度。'."\n"
."\n"
.'- **1106**:半年度。'."\n"
."\n"
.'- **1112**:年度。', 'type' => 'string', 'required' => false, 'example' => '1101'],
],
[
'name' => 'DataType',
'in' => 'query',
'schema' => ['description' => '流量类型。'."\n"
."\n"
.'- **singlecard**:单卡通用流量。'."\n"
."\n"
.'- **directionalcard**:单卡定向流量。'."\n"
."\n"
.'- **sameflowcard**:同档位池共享流量。'."\n"
."\n"
.'- **directional_sameflowcard**:同档位池共享定向流量。'."\n"
."\n"
.'- **unityPayPool**:统付池通用流量。'."\n"
."\n"
.'- **GREcard** :统付池定向流量。', 'type' => 'string', 'required' => false, 'example' => 'sameflowcard'],
],
[
'name' => 'ActiveTimeStart',
'in' => 'query',
'schema' => ['description' => '物联网卡的激活时间区间:开始时间。'."\n"
."\n"
.'格式为:`yyyy-MM-dd HH:mm:ss`。', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59'],
],
[
'name' => 'SimType',
'in' => 'query',
'schema' => ['description' => 'SIM卡类型。'."\n"
."\n"
.'- **nano**:插拔三切卡(消费级)。'."\n"
."\n"
.'- **micro**:插拔双切卡(消费级)。'."\n"
."\n"
.'- **normal**:插拔大卡(消费级)。'."\n"
."\n"
.'- **simplus56**:贴片卡5*6(消费级)。'."\n"
."\n"
.'- **simplus22**:贴片卡2*2(消费级)。'."\n"
."\n"
.'- **industry-normal**:插拔大卡(工业级)。'."\n"
."\n"
.'- **industry-micro**:插拔双切卡(工业级)。'."\n"
."\n"
.'- **industry-nano**:插拔三切卡(工业级)。'."\n"
."\n"
.'- **simplus**:贴片卡5*6(工业级)。'."\n"
."\n"
.'- **industry-simplus22**:贴片卡2*2(工业级)。', 'type' => 'string', 'required' => false, 'example' => 'nano'],
],
[
'name' => 'ExpireTimeEnd',
'in' => 'query',
'schema' => ['description' => '物联网卡的套餐结束时间。'."\n"
."\n"
.'格式为:`yyyy-MM-dd HH:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59'],
],
[
'name' => 'IsAutoRecharge',
'in' => 'query',
'schema' => ['description' => '套餐是否自动续费。'."\n"
."\n"
.'- **true**:是。'."\n"
."\n"
.'- **false**:否。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ExpireTimeStart',
'in' => 'query',
'schema' => ['description' => '物联网卡的套餐开始时间。'."\n"
."\n"
.'格式为:`yyyy-MM-dd HH:mm:ss`', 'type' => 'string', 'required' => false, 'example' => '2022-05-25 23:59:59'],
],
[
'name' => 'OsStatus',
'in' => 'query',
'schema' => ['description' => '物联网卡的具体状态。'."\n"
."\n"
.'- **10**:测试期。'."\n"
."\n"
.'- **20**:静默期。'."\n"
."\n"
.'- **100**:使用中。'."\n"
."\n"
.'- **150**:部分使用中。'."\n"
."\n"
.'- **200**:主动停用。'."\n"
."\n"
.'- **300**:达量停用。'."\n"
."\n"
.'- **400**:信控停用。'."\n"
."\n"
.'- **500**:换绑停用。'."\n"
."\n"
.'- **600**:实名停用。'."\n"
."\n"
.'- **700**:异常停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'required' => false, 'example' => '300'],
],
[
'name' => 'NotifyId',
'in' => 'query',
'schema' => ['description' => '自动化规则的通知ID。', 'type' => 'string', 'required' => false, 'example' => '11111'],
],
[
'name' => 'DataLevel',
'in' => 'query',
'schema' => ['description' => '流量包档位。', 'type' => 'string', 'required' => false, 'example' => '30MB'],
],
[
'name' => 'Status',
'in' => 'query',
'schema' => ['description' => '物联网卡的状态。'."\n"
."\n"
.'- **10**:可测试。'."\n"
."\n"
.'- **20**:未使用。'."\n"
."\n"
.'- **30**:使用中。'."\n"
."\n"
.'- **35**:已停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'required' => false, 'example' => '35'],
],
[
'name' => 'TagName',
'in' => 'query',
'schema' => ['description' => '标签名称。'."\n", 'type' => 'string', 'required' => false, 'example' => '测试标签'],
],
[
'name' => 'CertifyType',
'in' => 'query',
'schema' => ['description' => '认证方式。'."\n"
."\n"
.'仅支持enterprise:企业认证。', 'type' => 'string', 'required' => false, 'example' => 'enterprise'],
],
[
'name' => 'DirectionalGroupId',
'in' => 'query',
'schema' => ['description' => '定向分组ID。', 'type' => 'string', 'required' => false, 'example' => '22'],
],
[
'name' => 'ApnName',
'in' => 'query',
'schema' => ['description' => 'APN名称。'."\n"
."\n", 'type' => 'string', 'required' => false, 'example' => 'cmiot'],
],
[
'name' => 'Imsi',
'in' => 'query',
'schema' => ['description' => '物联网卡的IMSI。', 'type' => 'string', 'required' => false, 'example' => '460081937******'],
],
[
'name' => 'PoolId',
'in' => 'query',
'schema' => ['description' => '池编号。', 'type' => 'string', 'required' => false, 'example' => 'test1'],
],
[
'name' => 'MinFlow',
'in' => 'query',
'schema' => ['description' => '周期用量区间筛选:最小用量(单位MB)。', 'type' => 'string', 'required' => false, 'example' => '20'],
],
[
'name' => 'MaxFlow',
'in' => 'query',
'schema' => ['description' => '周期用量区间筛选:最大用量(单位MB)。', 'type' => 'string', 'required' => false, 'example' => '30'],
],
[
'name' => 'MaxRestFlowPercentage',
'in' => 'query',
'schema' => ['description' => '单卡周期流量剩余比例,仅支持如下三个参数。'."\n"
.'0.1:剩余10%'."\n"
.'0.2:剩余20%'."\n"
.'0.3:剩余30%', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2'],
],
[
'name' => 'NetworkType',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '网络制式:4G,5G。', 'type' => 'string', 'required' => false, 'example' => '4G'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- true:调用成功。'."\n"
."\n"
.'- false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回页面信息。',
'type' => 'object',
'properties' => [
'PageNo' => ['description' => '查询页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页显示的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageCount' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Total' => ['description' => '符合条件的物联网卡总数。', 'type' => 'integer', 'format' => 'int32', 'example' => '199'],
'List' => [
'description' => '卡列表。',
'type' => 'array',
'items' => [
'description' => '卡列表。',
'type' => 'object',
'properties' => [
'Status' => ['description' => '卡的状态。'."\n"
."\n"
.'- **10**:可测试。'."\n"
."\n"
.'- **20**:未使用。'."\n"
."\n"
.'- **30**:使用中。'."\n"
."\n"
.'- **35**:已停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'example' => '35'],
'DataType' => ['description' => '流量类型。'."\n"
."\n"
.'- **singlecard**:单卡通用流量。'."\n"
."\n"
.'- **directionalcard**:单卡定向流量。'."\n"
."\n"
.'- **sameflowcard**:同档位池共享流量。'."\n"
."\n"
.'- **directional_sameflowcard**:同档位池共享定向流量。'."\n"
."\n"
.'- **unityPayPool**:统付池通用流量。'."\n"
."\n"
.'- **GREcard** :统付池定向流量。', 'type' => 'string', 'example' => 'sameflowcard'],
'DirectionalGroupName' => ['description' => '定向分组名称。', 'type' => 'string', 'example' => '测试分组'],
'PeriodRestFlow' => ['description' => '周期剩余流量。', 'type' => 'string', 'example' => '130.00MB'],
'CredentialType' => ['description' => '套餐凭证类型。', 'type' => 'string', 'example' => 'unityPayPool'],
'PeriodAddFlow' => ['description' => '周期累计流量。', 'type' => 'string', 'example' => '0KB'],
'PeriodSmsUse' => ['description' => '周期短信用量。', 'type' => 'string', 'example' => '0'],
'DataLevel' => ['description' => '流量包档位。', 'type' => 'string', 'example' => '30MB'],
'OsStatus' => ['description' => '物联网卡的具体状态。'."\n"
."\n"
.'- **10**:测试期。'."\n"
."\n"
.'- **20**:静默期。'."\n"
."\n"
.'- **100**:使用中。'."\n"
."\n"
.'- **150**:部分使用中。'."\n"
."\n"
.'- **200**:主动停用。'."\n"
."\n"
.'- **300**:达量停用。'."\n"
."\n"
.'- **400**:信控停用。'."\n"
."\n"
.'- **500**:换绑停用。'."\n"
."\n"
.'- **600**:实名停用。'."\n"
."\n"
.'- **700**:异常停用。'."\n"
."\n"
.'- **40**:已停机。'."\n"
."\n"
.'- **50**:已销户。', 'type' => 'string', 'example' => '300'],
'NotifyId' => ['description' => '自动化规则的通知ID。', 'type' => 'string', 'example' => '11111'],
'AliFee' => ['description' => '资费版本。', 'type' => 'string', 'example' => 'ali_2'],
'AliyunOrderId' => ['description' => '物联网卡关联的订单编号。', 'type' => 'string', 'example' => '211519634******'],
'ActiveType' => ['description' => '物联网卡的激活方式。'."\n"
."\n"
.'- **firstdatarecord**:首话单激活。'."\n"
."\n"
.'- **carrierstatuspush**:运营商状态推送激活。'."\n"
."\n"
.'- **silence_expire**:沉默期结束激活。'."\n"
."\n"
.'- **manage**:手动激活。'."\n"
."\n"
.'- **testflowdepleted**:测试期流量超出后激活。', 'type' => 'string', 'example' => 'first_data_record'],
'IsAutoRecharge' => ['description' => '套餐是否自动续费。'."\n"
."\n"
.'- true:是。'."\n"
."\n"
.'- false:否。', 'type' => 'boolean', 'example' => 'true'],
'CredentialInstanceId' => ['description' => '凭证实例ID。', 'type' => 'string', 'example' => '2622***'],
'ExpireTime' => ['description' => '套餐到期时间。', 'type' => 'string', 'example' => '2022-04-30 23:59:59'],
'ApnName' => ['description' => 'APN名称。', 'type' => 'string', 'example' => 'cmiot'],
'ActiveTime' => ['description' => '激活时间。', 'type' => 'string', 'example' => '2021-11-16 16:35:50'],
'Iccid' => ['description' => '物联网卡的ICCID。', 'type' => 'string', 'example' => '89860321******15668'],
'Vendor' => ['description' => '运营商。'."\n"
."\n"
.'- **CMCC**:移动。'."\n"
."\n"
.'- **CUCC**:联通。'."\n"
."\n"
.'- **CTCC**:电信。'."\n"
."\n"
.'- **VNO**:虚拟运营商。', 'type' => 'string', 'example' => 'CMCC'],
'Period' => ['description' => '套餐结算周期。'."\n"
."\n"
.'- **1101**:月度。'."\n"
."\n"
.'- **1103**:季度。'."\n"
."\n"
.'- **1106**:半年度。'."\n"
."\n"
.'- **1112**:年度。', 'type' => 'string', 'example' => '1101'],
'CertifyType' => ['description' => '认证方式。'."\n"
."\n"
.'enterprise:企业认证。', 'type' => 'string', 'example' => 'enterprise'],
'PrivateNetworkSegment' => ['description' => '私网网段(定向卡)。', 'type' => 'string', 'example' => '1.*.3.*'],
'OpenAccountTime' => ['description' => '开户时间。', 'type' => 'string', 'example' => '2021-11-29 16:12:14'],
'SimType' => ['description' => 'SIM卡类型。'."\n"
."\n"
.'- **nano**:插拔三切卡(消费级)。'."\n"
."\n"
.'- **micro**:插拔双切卡(消费级)。'."\n"
."\n"
.'- **normal**:插拔大卡(消费级)。'."\n"
."\n"
.'- **simplus56**:贴片卡5*6(消费级)。'."\n"
."\n"
.'- **simplus22**:贴片卡2*2(消费级)。'."\n"
."\n"
.'- **industry-normal**:插拔大卡(工业级)。'."\n"
."\n"
.'- **industry-micro**:插拔双切卡(工业级)。'."\n"
."\n"
.'- **industry-nano**:插拔三切卡(工业级)。'."\n"
."\n"
.'- **simplus**:贴片卡5*6(工业级)。'."\n"
."\n"
.'- **industry-simplus22**:贴片卡2*2(工业级)。', 'type' => 'string', 'example' => 'nano'],
'VsimInstanceId' => ['description' => '物联网卡的InstanceId值。', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'],
'CredentialNo' => ['description' => '套餐凭证。', 'type' => 'string', 'example' => 'CM-***-*-2-**M'],
'TagList' => [
'description' => '物联网卡的标签。',
'type' => 'array',
'items' => [
'description' => '标签列表。',
'type' => 'object',
'properties' => [
'TagName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '测试标签'],
'Id' => ['description' => '标签ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '24'],
],
],
],
'Imsi' => [
'description' => '物联网卡的IMSI。',
'type' => 'array',
'items' => ['description' => '物联网卡的IMSI。', 'type' => 'string', 'example' => '460081937******'],
],
'Msisdn' => [
'description' => '物联网卡的MSISDN。',
'type' => 'array',
'items' => ['description' => '物联网卡的MSISDN。', 'type' => 'string', 'example' => '1440993******'],
],
'Remark' => ['description' => '备注信息。', 'type' => 'string', 'example' => '备注信息'],
'DirectionalGroupId' => ['description' => '定向分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '55'],
'NetworkType' => ['description' => '网络制式:4G,5G。', 'type' => 'string', 'example' => '4G'],
'FlowLatestModifiedTime' => ['description' => '用量更新时间', 'type' => 'string', 'example' => '2023-08-15 18:20:11'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => ''],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 20,\\n \\"Total\\": 199,\\n \\"List\\": [\\n {\\n \\"Status\\": \\"35\\",\\n \\"DataType\\": \\"sameflowcard\\",\\n \\"DirectionalGroupName\\": \\"测试分组\\",\\n \\"PeriodRestFlow\\": \\"130.00MB\\",\\n \\"CredentialType\\": \\"unityPayPool\\",\\n \\"PeriodAddFlow\\": \\"0KB\\",\\n \\"PeriodSmsUse\\": \\"0\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"OsStatus\\": \\"300\\",\\n \\"NotifyId\\": \\"11111\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"AliyunOrderId\\": \\"211519634******\\",\\n \\"ActiveType\\": \\"first_data_record\\",\\n \\"IsAutoRecharge\\": true,\\n \\"CredentialInstanceId\\": \\"2622***\\",\\n \\"ExpireTime\\": \\"2022-04-30 23:59:59\\",\\n \\"ApnName\\": \\"cmiot\\",\\n \\"ActiveTime\\": \\"2021-11-16 16:35:50\\",\\n \\"Iccid\\": \\"89860321******15668\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"Period\\": \\"1101\\",\\n \\"CertifyType\\": \\"enterprise\\",\\n \\"PrivateNetworkSegment\\": \\"1.*.3.*\\",\\n \\"OpenAccountTime\\": \\"2021-11-29 16:12:14\\",\\n \\"SimType\\": \\"nano\\",\\n \\"VsimInstanceId\\": 123456,\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"TagList\\": [\\n {\\n \\"TagName\\": \\"测试标签\\",\\n \\"Id\\": 24\\n }\\n ],\\n \\"Imsi\\": [\\n \\"460081937******\\"\\n ],\\n \\"Msisdn\\": [\\n \\"1440993******\\"\\n ],\\n \\"Remark\\": \\"备注信息\\",\\n \\"DirectionalGroupId\\": 55,\\n \\"NetworkType\\": \\"4G\\",\\n \\"FlowLatestModifiedTime\\": \\"2023-08-15 18:20:11\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListCardInfoResponse>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <PageCount>20</PageCount>\\n <Total>199</Total>\\n <List>\\n <Status>35</Status>\\n <DataType>sameflowcard</DataType>\\n <DirectionalGroupName>测试分组</DirectionalGroupName>\\n <PeriodRestFlow>130.00MB</PeriodRestFlow>\\n <CredentialType>unityPayPool</CredentialType>\\n <PeriodAddFlow>0KB</PeriodAddFlow>\\n <PeriodSmsUse>0</PeriodSmsUse>\\n <DataLevel>30MB</DataLevel>\\n <OsStatus>300</OsStatus>\\n <NotifyId>11111</NotifyId>\\n <AliFee>ali_2</AliFee>\\n <AliyunOrderId>211519634******</AliyunOrderId>\\n <ActiveType>first_data_record</ActiveType>\\n <IsAutoRecharge>true</IsAutoRecharge>\\n <CredentialInstanceId>2622***</CredentialInstanceId>\\n <ExpireTime>2022-04-30 23:59:59</ExpireTime>\\n <ApnName>cmiot</ApnName>\\n <ActiveTime>2021-11-16 16:35:50</ActiveTime>\\n <Iccid>89860321******15668</Iccid>\\n <Vendor>CMCC</Vendor>\\n <Period>1101</Period>\\n <CertifyType>enterprise</CertifyType>\\n <PrivateNetworkSegment>1.*.3.*</PrivateNetworkSegment>\\n <OpenAccountTime>2021-11-29 16:12:14</OpenAccountTime>\\n <SimType>nano</SimType>\\n <VsimInstanceId>123456</VsimInstanceId>\\n <CredentialNo>CM-***-*-2-**M</CredentialNo>\\n <TagList>\\n <TagName>测试标签</TagName>\\n <Id>24</Id>\\n </TagList>\\n <Imsi>460081937******</Imsi>\\n <Msisdn>1440993******</Msisdn>\\n <Remark>备注信息</Remark>\\n <DirectionalGroupId>55</DirectionalGroupId>\\n </List>\\n </Data>\\n</ListCardInfoResponse>","errorExample":""}]',
'title' => '查询卡列表',
'description' => '### 使用说明'."\n"
.'该接口的请求参数您可以在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)查看并获取,或者调用接口[GetCardDetail](~~374328~~)在返回参数中查看并获取(后者更为推荐)。'."\n",
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'changeSet' => [],
],
'ListDirectionalAddress' => [
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的数量,支持10、15、25、40。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '查询页数,需结合PageSize参数使用。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1'],
],
[
'name' => 'GroupId',
'in' => 'query',
'schema' => ['description' => '定向分组ID。'."\n"
."\n"
.'您可调用接口[GetCardDetail](~~374328~~)在返回参数中查看定向分组ID(DirectionalGroupId)。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '5'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- 200:调用成功。'."\n"
."\n"
.'- 其他:调用失败。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回的访问地址。',
'type' => 'object',
'properties' => [
'PageNo' => ['description' => '查询页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageCount' => ['description' => '列表总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
'Total' => ['description' => '列表总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'],
'List' => [
'description' => '访问地址。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'Address' => ['description' => '定向访问地址。', 'type' => 'string', 'example' => '*.aliyun.com'],
'AddressType' => ['description' => '地址类型。'."\n"
."\n"
.'- **Ip**:IP地址。'."\n"
."\n"
.'- **Domain**:域名。', 'type' => 'string', 'example' => 'Domain'],
'Source' => ['description' => '地址来源。'."\n"
."\n"
.'- **user_defined**:用户配置。'."\n"
."\n"
.'- **aliyun_defined**:阿里云预配。', 'type' => 'string', 'example' => 'user_defined'],
'GroupId' => ['description' => '定向分组ID。', 'type' => 'string', 'example' => '5'],
'State' => ['description' => '地址状态。'."\n"
."\n"
.'- **100**:新增处理中。'."\n"
."\n"
.'- **200**:删除处理中。'."\n"
."\n"
.'- **300**:新增失败。'."\n"
."\n"
.'- **400**:删除失败。'."\n"
."\n"
.'- **500**:新增成功。', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
],
'description' => '',
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 9,\\n \\"Total\\": 90,\\n \\"List\\": [\\n {\\n \\"Address\\": \\"*.aliyun.com\\",\\n \\"AddressType\\": \\"Domain\\",\\n \\"Source\\": \\"user_defined\\",\\n \\"GroupId\\": \\"5\\",\\n \\"State\\": 500\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDirectionalAddressResponse>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <PageCount>9</PageCount>\\n <Total>90</Total>\\n <List>\\n <Address>*.aliyun.com</Address>\\n <AddressType>Domain</AddressType>\\n <Source>user_defined</Source>\\n <GroupId>5</GroupId>\\n <State>500</State>\\n </List>\\n </Data>\\n</ListDirectionalAddressResponse>","errorExample":""}]',
'title' => '查询定向分组信息',
'summary' => '查询定向分组的访问地址列表。',
'description' => '## 使用说明'."\n"
.'仅新版定向服务菜单支持定向分组功能,如果您使用的是旧版定向服务菜单,无法使用该接口。更多信息,请参见[定向服务](~~279455~~)。',
'changeSet' => [],
],
'ListDirectionalDetail' => [
'summary' => '查询物联网卡所在的定向分组及访问地址列表。',
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面,查看ICCID。', 'type' => 'string', 'required' => true, 'example' => '89860321******15668'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '查询的页数,不能为0。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的数量,支持10、15、25、40。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'ListDirectionalDetailResponse',
'description' => 'ListDirectionalDetailResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- 200:调用成功。'."\n"
."\n"
.'- 其他:调用失败。错误码详情,请参见[错误码](~~87387~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回的分组信息及分组内的访问地址清单。',
'type' => 'object',
'properties' => [
'DirectionalGroupId' => ['description' => '定向分组ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
'DirectionalName' => ['description' => '定向分组名称。', 'type' => 'string', 'example' => '测试分组'],
'PaginationResult' => [
'description' => '定向分组内的访问地址列表。',
'type' => 'object',
'properties' => [
'PageNo' => ['description' => '当前页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Total' => ['description' => '列表总数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'],
'PageCount' => ['description' => '列表总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '9'],
'List' => [
'description' => '定向地址列表。',
'type' => 'array',
'items' => [
'description' => '定向地址列表。',
'type' => 'object',
'properties' => [
'GroupId' => ['description' => '定向分组ID。', 'type' => 'string', 'example' => '5'],
'Address' => ['description' => '定向访问地址。', 'type' => 'string', 'example' => '*.aliyun.com'],
'Source' => ['description' => '地址来源。'."\n"
."\n"
.'- **user_defined**:用户配置。'."\n"
."\n"
.'- **aliyun_defined**:阿里云预配。', 'type' => 'string', 'example' => 'user_defined'],
'AddressType' => ['description' => '地址类型。'."\n"
."\n"
.'- **Ip**:IP地址。'."\n"
."\n"
.'- **Domain**:域名。', 'type' => 'string', 'example' => 'Domain'],
'State' => ['description' => '地址状态。'."\n"
."\n"
.'- **100**:新增处理中。'."\n"
."\n"
.'- **200**:删除处理中。'."\n"
."\n"
.'- **300**:新增失败。'."\n"
."\n"
.'- **400**:删除失败。'."\n"
."\n"
.'- **500**:新增成功。', 'type' => 'string', 'example' => '500'],
],
],
],
],
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.directional.notExist', 'errorMessage' => 'Can not find direction group.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"DirectionalGroupId\\": 5,\\n \\"DirectionalName\\": \\"测试分组\\",\\n \\"PaginationResult\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"Total\\": 90,\\n \\"PageCount\\": 9,\\n \\"List\\": [\\n {\\n \\"GroupId\\": \\"5\\",\\n \\"Address\\": \\"*.aliyun.com\\",\\n \\"Source\\": \\"user_defined\\",\\n \\"AddressType\\": \\"Domain\\",\\n \\"State\\": \\"500\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListDirectionalDetailResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>\\n <DirectionalGroupId>5</DirectionalGroupId>\\n <DirectionalName>测试分组</DirectionalName>\\n <PaginationResult>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Total>90</Total>\\n <PageCount>9</PageCount>\\n <List>\\n <GroupId>5</GroupId>\\n <Address>*.aliyun.com</Address>\\n <Source>user_defined</Source>\\n <AddressType>Domain</AddressType>\\n <State>500</State>\\n </List>\\n </PaginationResult>\\n </Data>\\n</ListDirectionalDetailResponse>","errorExample":""}]',
'title' => '查询卡的定向信息',
'description' => '## 使用说明'."\n"
.'仅新版定向服务菜单支持定向分组,如果您使用的是旧版定向服务菜单,无法使用该接口。更多信息,请参见[定向服务](~~279455~~)。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~30561~~)。',
'changeSet' => [],
],
'ListOrder' => [
'summary' => '查询订单列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'OrderId',
'in' => 'query',
'schema' => ['description' => '订单ID。', 'type' => 'string', 'required' => false, 'example' => '21450******0275'],
],
[
'name' => 'StartDate',
'in' => 'query',
'schema' => ['description' => '订单购买的时间区间(开始日期)。'."\n"
."\n"
.'格式:`YYYY-MM-dd`', 'type' => 'string', 'required' => false, 'example' => '2022-04-05'],
],
[
'name' => 'EndDate',
'in' => 'query',
'schema' => ['description' => '订单购买的时间区间(结束日期)。'."\n"
."\n"
.'格式:`YYYY-MM-dd`', 'type' => 'string', 'required' => false, 'example' => '2022-04-05'],
],
[
'name' => 'OrderType',
'in' => 'query',
'schema' => ['description' => '订单类型。'."\n"
."\n"
.'- **NEW**:新购。'."\n"
."\n"
.'- **ADD_FLOW**:扩池。'."\n"
."\n"
.'- **ADD_CARD**:补卡。'."\n"
."\n"
.'- **FUNCTION**:购月功能费。'."\n"
."\n"
.'- **FLOW_PLUS**:购买叠加包。'."\n"
."\n"
.'- **RENEW**:续订套餐。'."\n"
."\n"
.'- **AUTO_RENEW**:自动续订套餐。'."\n", 'type' => 'string', 'required' => false, 'example' => 'NEW'],
],
[
'name' => 'OrderStatus',
'in' => 'query',
'schema' => ['description' => '订单状态。'."\n"
."\n"
.'- **processing**:处理中。'."\n"
."\n"
.'- **failure**:失败。'."\n"
."\n"
.'- **completed**:处理完成。'."\n"
."\n"
.'- **unpaid**:待支付。'."\n"
."\n"
.'- **refunded**:已退款。', 'type' => 'string', 'required' => false, 'example' => 'processing'],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => ['description' => '查询页数,需结合`PageSize`参数使用。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的数量,支持10、15、25、40。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10'],
],
[
'name' => 'CredentialNo',
'in' => 'query',
'schema' => ['description' => '套餐凭证。', 'type' => 'string', 'required' => false, 'example' => 'CT-SF-M-2-100M'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['description' => '是否调用成功。'."\n"
."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => [
'description' => '返回信息。',
'type' => 'object',
'properties' => [
'PageNo' => ['description' => '查询页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'PageSize' => ['description' => '每页的数量。', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'PageCount' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
'Total' => ['description' => '符合条件的总订单数。', 'type' => 'integer', 'format' => 'int32', 'example' => '48'],
'List' => [
'description' => '订单列表。',
'type' => 'array',
'items' => [
'description' => '订单列表。',
'type' => 'object',
'properties' => [
'BillingCycle' => ['description' => '套餐结算周期。'."\n"
."\n"
.'- **1101**:月度。'."\n"
."\n"
.'- **1103**:季度。'."\n"
."\n"
.'- **1106**:半年度。'."\n"
."\n"
.'- **1112**:年度。', 'type' => 'string', 'example' => '1101'],
'BuyNum' => ['description' => '购买张数。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'PoolCapacityUnit' => ['description' => '池容量单位。', 'type' => 'string', 'example' => 'GB'],
'CardPayCount' => ['description' => '支付时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '2022-04-11 16:43:00'],
'CredentialPackage' => ['description' => '套餐凭证。', 'type' => 'string', 'example' => 'AL-UPG-******3_beika4'],
'Vendor' => ['description' => '运营商。'."\n"
."\n"
.'- **CMCC**:移动。'."\n"
."\n"
.'- **CUCC**:联通。'."\n"
."\n"
.'- **CTCC**:电信。'."\n"
."\n"
.'- **VNO**:虚拟运营商。', 'type' => 'string', 'example' => 'CMCC'],
'DataLevel' => ['description' => '流量包档位。', 'type' => 'string', 'example' => '30MB'],
'PayDuration' => ['description' => '购买时长。', 'type' => 'string', 'example' => '12月'],
'AliFee' => ['description' => '资费版本。', 'type' => 'string', 'example' => 'ali_2'],
'OrderStatus' => ['description' => '订单状态。'."\n"
."\n"
.'- **processing**:处理中。'."\n"
."\n"
.'- **failure**:失败。'."\n"
."\n"
.'- **completed**:处理完成。'."\n"
."\n"
.'- **unpaid**:待支付。'."\n"
."\n"
.'- **refunded**:已退款。', 'type' => 'string', 'example' => 'processing'],
'PoolNo' => ['description' => '池编号。', 'type' => 'string', 'example' => 'beika4'],
'FunctionFee' => ['description' => '月功能费份数(统付池专用)。', 'type' => 'integer', 'format' => 'int32', 'example' => '90'],
'PayTime' => ['description' => '购买时间。', 'type' => 'string', 'example' => '2022-04-11 16:43:00'],
'FlowType' => ['description' => '流量类型。'."\n"
."\n"
.'- **singlecard**:单卡通用流量。'."\n"
."\n"
.'- **directionalcard**:单卡定向流量。'."\n"
."\n"
.'- **sameflowcard**:同档位池共享流量。'."\n"
."\n"
.'- **directional_sameflowcard**:同档位池共享定向流量。'."\n"
."\n"
.'- **unityPayPool**:统付池通用流量。'."\n"
."\n"
.'- **GREcard**:统付池定向流量。', 'type' => 'string', 'example' => 'singlecard'],
'PoolCapacity' => ['description' => '池容量,单位参见**PoolCapacityUnit**字段。', 'type' => 'string', 'example' => '200'],
'OrderInfo' => ['description' => '订单信息。', 'type' => 'string', 'example' => '123123'],
'OrderType' => ['description' => '订单类型。'."\n"
."\n"
.'- **NEW**:新购。'."\n"
."\n"
.'- **ADD_FLOW**:扩池。'."\n"
."\n"
.'- **ADD_CARD**:补卡。'."\n"
."\n"
.'- **FUNCTION**:购月功能费。'."\n"
."\n"
.'- **FLOW_PLUS**:购买叠加包。'."\n"
."\n"
.'- **RENEW**:续订套餐。'."\n"
."\n"
.'- **AUTO_RENEW**:自动续订套餐。'."\n", 'type' => 'string', 'example' => 'NEW'],
'OrderId' => ['description' => '订单编号。', 'type' => 'string', 'example' => '21450******0275'],
'CredentialNo' => ['description' => '套餐凭证。', 'type' => 'string', 'example' => 'CM-***-*-2-**M'],
'ExpressNoList' => [
'description' => '物流信息。',
'type' => 'array',
'items' => ['description' => '物流单号。', 'type' => 'string', 'example' => '123123123'],
],
'DeliveryInfo' => [
'description' => '收货信息。',
'type' => 'object',
'properties' => [
'ZipCode' => ['description' => '收货信息:邮编。', 'type' => 'string', 'example' => '100000'],
'Address' => ['description' => '收货信息:地址。', 'type' => 'string', 'example' => '收货地址'],
'Mail' => ['description' => '收货信息:邮箱。', 'type' => 'string', 'example' => 'xxx@xxx.com'],
'Receiver' => ['description' => '收货信息:收件人。', 'type' => 'string', 'example' => '收件人'],
'BuyerMessage' => ['description' => '收货信息:收件电话。', 'type' => 'string', 'example' => '收件电话'],
],
],
'OrderDetailUrl' => ['description' => '订单详情链接。', 'type' => 'string', 'example' => 'https://us******60589'],
'ApnName' => ['description' => 'APN名称。', 'type' => 'string', 'example' => 'CMIOTCZHZA.JS'],
'ApnRegion' => ['description' => 'APN地域。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'ResourceQuantity' => ['description' => 'IP购买数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000'],
'NetworkType' => ['description' => '网络制式:4G,5G。', 'type' => 'string', 'example' => '4G'],
],
],
],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => '非法的请求参数。'],
['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => '阿里云账号无效。'],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
['errorCode' => 'linkcard.common.BusinessProcessError', 'errorMessage' => 'A business processing exception occurred.', 'description' => '业务处理异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": {\\n \\"PageNo\\": 1,\\n \\"PageSize\\": 10,\\n \\"PageCount\\": 5,\\n \\"Total\\": 48,\\n \\"List\\": [\\n {\\n \\"BillingCycle\\": \\"1101\\",\\n \\"BuyNum\\": 100,\\n \\"PoolCapacityUnit\\": \\"GB\\",\\n \\"CardPayCount\\": 0,\\n \\"CredentialPackage\\": \\"AL-UPG-******3_beika4\\",\\n \\"Vendor\\": \\"CMCC\\",\\n \\"DataLevel\\": \\"30MB\\",\\n \\"PayDuration\\": \\"12月\\",\\n \\"AliFee\\": \\"ali_2\\",\\n \\"OrderStatus\\": \\"processing\\",\\n \\"PoolNo\\": \\"beika4\\",\\n \\"FunctionFee\\": 90,\\n \\"PayTime\\": \\"2022-04-11 16:43:00\\",\\n \\"FlowType\\": \\"singlecard\\",\\n \\"PoolCapacity\\": \\"200\\",\\n \\"OrderInfo\\": \\"123123\\",\\n \\"OrderType\\": \\"NEW\\",\\n \\"OrderId\\": \\"21450******0275\\",\\n \\"CredentialNo\\": \\"CM-***-*-2-**M\\",\\n \\"ExpressNoList\\": [\\n \\"123123123\\"\\n ],\\n \\"DeliveryInfo\\": {\\n \\"ZipCode\\": \\"100000\\",\\n \\"Address\\": \\"收货地址\\",\\n \\"Mail\\": \\"xxx@xxx.com\\",\\n \\"Receiver\\": \\"收件人\\",\\n \\"BuyerMessage\\": \\"收件电话\\"\\n },\\n \\"OrderDetailUrl\\": \\"https://us******60589\\",\\n \\"ApnName\\": \\"CMIOTCZHZA.JS\\",\\n \\"ApnRegion\\": \\"cn-hangzhou\\",\\n \\"ResourceQuantity\\": 10000,\\n \\"NetworkType\\": \\"4G\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListOrderResponse>\\n <Code>200</Code>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <PageCount>5</PageCount>\\n <Total>48</Total>\\n <List>\\n <BillingCycle>1101</BillingCycle>\\n <BuyNum>100</BuyNum>\\n <PoolCapacityUnit>GB</PoolCapacityUnit>\\n <CredentialPackage>AL-UPG-******3_beika4</CredentialPackage>\\n <Vendor>CMCC</Vendor>\\n <DataLevel>30MB</DataLevel>\\n <PayDuration>12月</PayDuration>\\n <AliFee>ali_2</AliFee>\\n <OrderStatus>processing</OrderStatus>\\n <PoolNo>beika4</PoolNo>\\n <FunctionFee>90</FunctionFee>\\n <PayTime>2022-04-11 16:43:00</PayTime>\\n <FlowType>singlecard</FlowType>\\n <PoolCapacity>200</PoolCapacity>\\n <OrderInfo>123123</OrderInfo>\\n <OrderType>NEW</OrderType>\\n <OrderId>21450******0275</OrderId>\\n <CredentialNo>CM-***-*-2-**M</CredentialNo>\\n <ExpressNoList>123123123</ExpressNoList>\\n <DeliveryInfo>\\n <ZipCode>100000</ZipCode>\\n <Address>收货地址</Address>\\n <Mail>xxx@xxx.com</Mail>\\n <Receiver>收件人</Receiver>\\n <BuyerMessage>收件电话</BuyerMessage>\\n </DeliveryInfo>\\n <OrderDetailUrl>https://us******60589</OrderDetailUrl>\\n </List>\\n </Data>\\n</ListOrderResponse>","errorExample":""}]',
'title' => '查询订单列表',
'description' => '## 使用限制'."\n"
."\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'changeSet' => [],
],
'RebindResumeSingleCard' => [
'summary' => '将状态为“换绑停用”的单卡操作为“换绑复用”。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'OptMsisdns',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '是否对子卡进行操作,填入子卡的MSISDN。'."\n"
."\n"
.'- 普通单网卡无需传入此参数。'."\n"
.'- 虚拟运营商:'."\n"
.' - 如果传入该参数,则对指定的子卡进行操作。'."\n"
.' - 如果不传入该参数,则对所有子卡进行操作。',
'type' => 'array',
'items' => ['description' => '子卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '141******1111'],
'required' => false,
'example' => ' ["1112******826","1112******827"] ',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '执行结果。'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。'."\n", 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'Iccid cannot be empty. '],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => '卡号不能为空。'],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => '卡不存在或已销户'],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"Iccid cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<RebindResumeSingleCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</RebindResumeSingleCardResponse>","errorExample":""}]',
'title' => '卡的换绑复用',
'description' => '## 使用说明'."\n"
."\n\n"
.'物联网卡与设备是一一对应关系,在物联网卡首次插入设备通电使用产生流量时,就与设备进行了绑定。如果将卡更换至其他设备中使用,将导致卡被锁定,用户可以使用此接口进行解卡。'."\n"
."\n",
'requestParamsDescription' => ' 调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:RebindResumeSingleCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
],
'Renew' => [
'summary' => '卡的套餐续订和叠加包订购,仅适用于单卡套餐和同档位池套餐(统付池套餐请通过控制台进行扩池和购功能费)。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create'],
'parameters' => [
[
'name' => 'ApiProduct',
'in' => 'formData',
'schema' => ['description' => '接口Code。', 'type' => 'string', 'required' => false, 'example' => 'linkcard'],
],
[
'name' => 'ApiRevision',
'in' => 'formData',
'schema' => ['description' => '接口版本。', 'type' => 'string', 'required' => false, 'example' => '2021-05-20'],
],
[
'name' => 'Iccid',
'in' => 'query',
'allowEmptyValue' => false,
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面,查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'RechargeType',
'in' => 'query',
'schema' => ['description' => '充值类型。'."\n"
."\n"
.'- STANDARD:续订套餐。'."\n"
."\n"
.'- OVERLAY :订购叠加包。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'STANDARD'],
],
[
'name' => 'SerialNo',
'in' => 'query',
'schema' => ['description' => '自定义的订单编号,编号需唯一且保持幂等性。'."\n"
."\n"
.'如果您的充值,涉及自有平台的订单管理,如给下游客户充值等,您可填入自有平台已生成的外部订单编号,该接口调用成功后,会生成一个订单编号(OrderNo)。该参数可以方便您将生成的订单编号与外部订单号关联起来。如果非此场景,你可填入任意正整数,例如0。'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12345678'],
],
[
'name' => 'OfferCode',
'in' => 'query',
'schema' => ['description' => '充值类型为订购叠加包时需填写。'."\n"
."\n"
.'具体Code请咨询技术对接人员。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'COM***0203'],
],
[
'name' => 'BuyNum',
'in' => 'query',
'schema' => ['description' => '订购份数。根据物联网卡本身的套餐类型选择订购份数。'."\n"
.'- 续订月套餐:支持1、2、3、6、9、12。'."\n"
."\n"
.'- 续订年套餐:支持1、2、3。'."\n"
."\n"
.'- 订购叠加包:支持1、2、3。', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '12'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
'description' => '返回的订单编号数据。',
'type' => 'object',
'properties' => [
'OrderNo' => ['description' => '接口调用成功后生成的订单编号。', 'type' => 'string', 'example' => '21450******0275'],
'SerialNo' => ['description' => '自定义的订单编号(SerialNo)。', 'type' => 'string', 'example' => '12345678'],
],
],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => ''],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"OrderNo\\": \\"21450******0275\\",\\n \\"SerialNo\\": \\"12345678\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RenewResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <OrderNo>21450******0275</OrderNo>\\n <SerialNo>12345678</SerialNo>\\n </Data>\\n</RenewResponse>","errorExample":""}]',
'title' => '充值',
'description' => '## 使用限制'."\n"
."\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'changeSet' => [],
],
'ResumeSingleCard' => [
'summary' => '将状态为“主动停用”、“大量停用”的单卡操作为“复用”。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'OptMsisdns',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '是否对子卡进行操作,填入子卡的MSISDN。'."\n"
."\n"
.'- 普通单网卡无需传入此参数。'."\n"
.'- 虚拟运营商:'."\n"
.' - 如果传入该参数,则对指定的子卡进行操作。'."\n"
.' - 如果不传入该参数,则对所有子卡进行操作。',
'type' => 'array',
'items' => ['description' => '子卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '141******1111'],
'required' => false,
'example' => '["111******6826","11*******6827"]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '执行结果。'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty. '],
'Code' => ['description' => '接口返回码:'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<ResumeSingleCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</ResumeSingleCardResponse>","errorExample":""}]',
'title' => '卡的主动复用',
'description' => '## 限制说明'."\n"
."\n\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。'."\n",
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'SendMessage' => [
'summary' => '平台短信下发。',
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'TaskName',
'in' => 'formData',
'schema' => ['description' => '自定义任务名称,不能包含特殊字符,最长40个字符。', 'type' => 'string', 'required' => true, 'example' => '任务0912'],
],
[
'name' => 'MessageTemplateId',
'in' => 'formData',
'schema' => ['title' => '模版ID', 'description' => '短信模版编号,可以在控制台查看。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '14'],
],
[
'name' => 'MessageVariableParam',
'in' => 'formData',
'schema' => ['title' => '请求参数', 'description' => '动态参数短信,替换的参数,格式{1}{2}', 'type' => 'string', 'required' => false, 'example' => '{参数1}{参数2}{参数3}'],
],
[
'name' => 'MessageSendTime',
'in' => 'formData',
'schema' => ['title' => '单位:s', 'description' => '时间戳,单位:秒 。'."\n"
."\n"
.'当时间早于当前时间则立即发送,晚于当前时间为定时发送。'."\n"
."\n"
.'最晚不能超过一个月。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1694401634'],
],
[
'name' => 'Msisdns',
'in' => 'formData',
'style' => 'json',
'schema' => [
'description' => '发送短信的目标MSISDN列表',
'type' => 'array',
'items' => ['description' => '发送短信的目标MSISDN', 'type' => 'string', 'required' => false, 'example' => '1411234123412'],
'required' => false,
],
],
[
'name' => 'ApiProduct',
'in' => 'formData',
'schema' => ['description' => 'Linkcard', 'type' => 'string', 'required' => false, 'example' => 'Linkcard'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'SendMessageResponse',
'description' => 'SendMessageResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
."\n"
.'true:调用成功。 false:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'200:调用成功。'."\n"
."\n"
.'其他:调用失败。错误码详情,请参见错误码。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => ' '."\n"
.'调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'DynamicCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'InvokeError'],
'DynamicMessage' => ['description' => '错误码信息', 'type' => 'string', 'example' => '入参不能为空,或不能包含空格'],
'Data' => ['description' => '地址是否添加成功。'."\n"
."\n"
.'true:添加成功。'."\n"
."\n"
.'false:添加失败。', 'type' => 'integer', 'format' => 'int64', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.common.InvalidAliyunPK', 'errorMessage' => 'AliyunPk is invalid.', 'description' => '阿里云账号无效。'],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => '非法的请求参数。'],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"DynamicCode\\": \\"InvokeError\\",\\n \\"DynamicMessage\\": \\"入参不能为空,或不能包含空格\\",\\n \\"Data\\": 0\\n}","errorExample":""},{"type":"xml","example":"<SendMessageResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n</SendMessageResponse>","errorExample":""}]',
'title' => 'SendMessage',
'changeSet' => [],
],
'SetCardStopRule' => [
'summary' => '设置卡的达量停用规则,仅支持同档位池套餐和统付池套餐。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'FlowLimit',
'in' => 'query',
'schema' => ['description' => '达量停用的数值,仅支持正整数,单位:MB。'."\n"
."\n"
.'当月流量达到此数值时将自动停用,可主动复用。'."\n"
."\n\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100'],
],
[
'name' => 'AutoRestore',
'in' => 'query',
'schema' => ['description' => '达量停用后,次月是否自动复用。'."\n"
."\n"
.'- true(默认值):次月自动复用。'."\n"
."\n"
.'- false:次月不自动复用。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '执行结果。'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.RuleMaxValueLimit', 'errorMessage' => 'The maximum value of Rule must be less than 9007199254740991.', 'description' => '达量停用策略数值,必须小于9007199254740991。'],
['errorCode' => 'linkcard.check.RuleMustBePositiveInteger', 'errorMessage' => 'The valid values of Rule are positive integers and zero.', 'description' => '达量停用策略数值,仅支持正整数和0。'],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => '%s..', 'errorMessage' => '%s..', 'description' => '%s..'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<SetCardStopRuleResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</SetCardStopRuleResponse>","errorExample":""}]',
'title' => '设置卡的达量停用规则',
'description' => '## 使用限制'."\n"
."\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'changeSet' => [],
],
'StopSingleCard' => [
'summary' => '将状态为“使用中”的单卡进行自主停用。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面,查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'OptMsisdns',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '是否对子卡进行操作,填入子卡的MSISDN。'."\n"
."\n"
.'- 普通单网卡无需传入此参数。'."\n"
.'- 虚拟运营商:'."\n"
.' - 如果传入该参数,则对指定的子卡进行操作。'."\n"
.' - 如果不传入该参数,则对所有子卡进行操作。',
'type' => 'array',
'items' => ['description' => '子卡的MSISDN。', 'type' => 'string', 'required' => false, 'example' => '141******1111'],
'required' => false,
'example' => '["1112******826","1112******827"] ',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '执行结果。'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。'."\n", 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty. '],
'Code' => ['description' => '接口返回码:'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => ''],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\\\t\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<StopSingleCardResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</StopSingleCardResponse>","errorExample":""}]',
'title' => '卡的主动停用',
'description' => '## 限制说明'."\n"
."\n\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
],
'UpdateAutoRechargeSwitch' => [
'summary' => '该接口用于开启或关闭卡的自动续费功能,仅适用于单卡套餐和同档位池套餐。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => ['operationType' => 'update'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在[物联网SIM服务控制台](https://dyiotnext.console.aliyun.com/?spm=a2c4g.11186623.0.0.6a072d25p4pUg8)的卡管理页面查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
[
'name' => 'Open',
'in' => 'query',
'schema' => ['description' => '自动续费开关。'."\n"
."\n"
.'- **true**:开启自动续费。'."\n"
."\n"
.'- **false**:关闭自动续费。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '执行结果。'."\n"
."\n"
.'- **true**:执行成功。'."\n"
."\n"
.'- **false**:执行失败。', 'type' => 'boolean', 'example' => 'true'],
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => '系统异常'],
'Success' => ['description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- **200**:表示成功。'."\n"
.'- 其它:表示错误码。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
],
'description' => '',
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => '卡不存在或已销户'],
],
403 => [
['errorCode' => '%s.', 'errorMessage' => '%s.', 'description' => '%s.'],
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => '没有RAM权限。'],
],
500 => [
['errorCode' => 'linkcard.system.RPCInvokeError', 'errorMessage' => 'An RPC invoking error occurred', 'description' => 'RPC远程请求错误'],
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => '系统内部异常'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"ErrorMessage\\": \\"系统异常\\",\\n \\"Success\\": true,\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAutoRechargeSwitchResponse>\\n <Data>true</Data>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n</UpdateAutoRechargeSwitchResponse>","errorExample":""}]',
'title' => 'UpdateAutoRechargeSwitch',
'description' => '## 使用限制'."\n"
."\n"
.'单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为20。'."\n"
."\n"
.'> RAM用户共享阿里云账号配额。',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~375336~~)。',
'changeSet' => [],
],
'VerifyIotCard' => [
'summary' => '查询物联网卡是否为定向卡。',
'methods' => ['post', 'get'],
'schemes' => ['https', 'http'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'Iccid',
'in' => 'query',
'schema' => ['description' => '物联网卡的ICCID。'."\n"
."\n"
.'您可在物联网卡上查看ICCID,或者在物联网SIM服务控制台的卡管理页面,查看ICCID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '89860321******15668'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'title' => 'VerifyIotCardResponse',
'description' => 'VerifyIotCardResponse',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID,阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => 'E4F94B97-1D64-4080-BFD2-67461667AA43'],
'Success' => ['title' => '必填', 'description' => '是否调用成功。'."\n"
.'- **true**:调用成功。'."\n"
.'- **false**:调用失败。', 'type' => 'boolean', 'example' => 'true'],
'Code' => ['description' => '接口返回码。'."\n"
."\n"
.'- 200:调用成功。'."\n"
."\n"
.'- 其他:调用失败。错误码详情,请参见[错误码](~~375339~~)。', 'type' => 'string', 'example' => '200'],
'ErrorMessage' => ['description' => '调用失败时,返回的错误信息。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'LocalizedMessage' => ['description' => '根据当前所在地展示对应语言的错误提示。', 'type' => 'string', 'example' => 'InstanceId cannot be empty.'],
'Data' => ['description' => '是否为定向卡。'."\n"
."\n"
.'- **true**:是定向卡。'."\n"
."\n"
.'- **false**:不是定向卡。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
400 => [
['errorCode' => 'linkcard.check.IccidCanNotEmpty', 'errorMessage' => 'Iccid cannot be empty.', 'description' => ''],
['errorCode' => 'linkcard.system.IllegalRequest', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''],
['errorCode' => 'linkcard.common.CardDestroy', 'errorMessage' => 'The card do not exist or destroy.', 'description' => ''],
['errorCode' => 'CardDisabled', 'errorMessage' => 'The SIM card has been permanently disabled.', 'description' => ''],
['errorCode' => 'linkcard.common.CardNotExist', 'errorMessage' => 'The card does not exist.', 'description' => ''],
['errorCode' => 'IllegalParameter', 'errorMessage' => 'The request parameter %s is invalid.', 'description' => ''],
],
403 => [
['errorCode' => 'linkcard.common.RamActionPermissionDeny', 'errorMessage' => 'You do not have the RAM permission.', 'description' => ''],
['errorCode' => 'linkcard.common.RamActionPermissionDeny ', 'errorMessage' => 'You do not have the RAM permission. ', 'description' => ''],
],
500 => [
['errorCode' => 'Service.InternalError', 'errorMessage' => 'An internal error occurred.', 'description' => ''],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E4F94B97-1D64-4080-BFD2-67461667AA43\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"ErrorMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"LocalizedMessage\\": \\"InstanceId cannot be empty.\\",\\n \\"Data\\": true\\n}","errorExample":""},{"type":"xml","example":"<VerifyIotCardResponse>\\n <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <ErrorMessage>InstanceId cannot be empty.</ErrorMessage>\\n <LocalizedMessage>InstanceId cannot be empty.</LocalizedMessage>\\n <Data>true</Data>\\n</VerifyIotCardResponse>","errorExample":""}]',
'title' => '定向卡查询',
'requestParamsDescription' => '调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见[公共参数文档](~~30561~~)。',
'changeSet' => [],
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-2', 'regionName' => '澳大利亚(悉尼)已关停', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'me-east-1', 'regionName' => '阿联酋(迪拜)', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'ap-south-1', 'regionName' => '印度(孟买)已关停', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云(邀测)', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'linkcard.aliyuncs.com', 'endpoint' => 'linkcard.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => '%s.', 'message' => '%s.', 'http_code' => 403, 'description' => '%s.'],
['code' => '%s..', 'message' => '%s..', 'http_code' => 500, 'description' => '%s..'],
['code' => 'BBC.FAIL', 'message' => 'A business processing exception occurred.', 'http_code' => 400, 'description' => '业务处理异常'],
['code' => 'CardDisabled', 'message' => 'The SIM card has been permanently disabled.', 'http_code' => 400, 'description' => '卡已经被销户'],
['code' => 'IdempotentParameterMismatch', 'message' => '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.', 'http_code' => 400, 'description' => '请使用不同的客户端令牌'],
['code' => 'IllegalParameter', 'message' => 'The request parameter %s is invalid.', 'http_code' => 400, 'description' => '请求参数%s非法.'],
['code' => 'linkcard.cha.PolicyAlreadyBound', 'message' => 'Cha policy has already been bound', 'http_code' => 400, 'description' => '组策略已经绑定到其他分组'],
['code' => 'linkcard.cha.ResourceNotExist', 'message' => 'Cha resource does not exist.', 'http_code' => 404, 'description' => '找不到指定的资源。'],
['code' => 'linkcard.check.DataLevelCanNotEmpty', 'message' => 'Data level cannot be empty.', 'http_code' => 400, 'description' => '充值类型为叠加包时,流量档位不能为空。'],
['code' => 'linkcard.check.DataTypeCanNotEmpty', 'message' => 'Data type cannot be empty.', 'http_code' => 400, 'description' => '流量类型不能为空'],
['code' => 'linkcard.check.ForceActivationSameFlowCard', 'message' => 'Only cards in the same flow support forced activation.', 'http_code' => 400, 'description' => '强制激活仅支持同档位的卡。'],
['code' => 'linkcard.check.IccidCanNotEmpty', 'message' => 'Iccid cannot be empty.', 'http_code' => 400, 'description' => '卡号不能为空。'],
['code' => 'linkcard.check.InstanceIdCanNotEmpty', 'message' => 'InstanceId cannot be empty.', 'http_code' => 400, 'description' => '卡实例ID不能为空。'],
['code' => 'linkcard.check.NonCard', 'message' => 'The number of cards triggered by the condition is zero.', 'http_code' => 400, 'description' => '筛选的卡数量为零'],
['code' => 'linkcard.check.OnlyUnusedCanForceActivation', 'message' => 'Only unused cards support forced activation.', 'http_code' => 400, 'description' => '仅支持可测试和未使用状态的卡强制激活。'],
['code' => 'linkcard.check.OssFileFormatError', 'message' => 'The file format is invalid.', 'http_code' => 400, 'description' => '文件格式错误。'],
['code' => 'linkcard.check.OverCardCount', 'message' => 'The number of cards triggered by the condition exceeds the limit.', 'http_code' => 400, 'description' => '筛选的卡数量超限,最多500000张'],
['code' => 'linkcard.check.OverExportCount', 'message' => 'The number of cards owned by the user exceeds the limit.', 'http_code' => 400, 'description' => '导出数量超限。'],
['code' => 'linkcard.check.OverExportCount', 'message' => 'OverExportCount', 'http_code' => 400, 'description' => '最多支持导出数量最多500000张'],
['code' => 'linkcard.check.OverRuleCount', 'message' => 'The number of rules owned by the user exceeds the limit.', 'http_code' => 400, 'description' => '规则超限。'],
['code' => 'linkcard.check.OverThreshold', 'message' => 'The number of Trigger Condition Usage setting exceeds the limit.', 'http_code' => 400, 'description' => '触发条件的用量设置超限。'],
['code' => 'linkcard.check.RuleMaxValueLimit', 'message' => 'The maximum value of Rule must be less than 9007199254740991.', 'http_code' => 400, 'description' => '达量停用策略数值,必须小于9007199254740991。'],
['code' => 'linkcard.check.RuleMustBePositiveInteger', 'message' => 'The valid values of Rule are positive integers and zero.', 'http_code' => 400, 'description' => '达量停用策略数值,仅支持正整数和0。'],
['code' => 'linkcard.check.SerialNoCanNotEmpty', 'message' => 'Serial Number cannot be empty.', 'http_code' => 400, 'description' => '唯一序列号不能为空'],
['code' => 'linkcard.check.SerialNoNotExist', 'message' => 'Serial Number not exist.', 'http_code' => 400, 'description' => '唯一序列号serialNo不存在'],
['code' => 'linkcard.check.StartTimeLessEndTime', 'message' => 'The StartTime must be earlier than the EndTime.', 'http_code' => 400, 'description' => '起始时间必须小于结束时间'],
['code' => 'linkcard.check.TagIdCanNotEmpty', 'message' => 'The TagId must not be empty.', 'http_code' => 400, 'description' => '标签ID不能为空'],
['code' => 'linkcard.check.TimeFormatError', 'message' => 'Time format error.', 'http_code' => 400, 'description' => '传参时间格式错误。'],
['code' => 'linkcard.check.UploadFileBeyondLimit', 'message' => 'The uploaded file exceeds the limit.', 'http_code' => 400, 'description' => '上传文件超出限制。'],
['code' => 'linkcard.check.UploadFileDuplicateCard', 'message' => 'Iccid is duplicated.', 'http_code' => 400, 'description' => '上传文件内有重复卡号。'],
['code' => 'linkcard.check.UploadFileInvalidCard', 'message' => 'Iccid is invalid.', 'http_code' => 400, 'description' => '上传文件内有卡号不合法。'],
['code' => 'linkcard.common.Ambiguous', 'message' => 'The input value is ambiguous.', 'http_code' => 400, 'description' => '输入值存在歧义'],
['code' => 'linkcard.common.BusinessProcessError', 'message' => 'A business processing exception occurred.', 'http_code' => 500, 'description' => '业务处理异常'],
['code' => 'linkcard.common.CardDestroy', 'message' => 'The card do not exist or destroy.', 'http_code' => 400, 'description' => '卡不存在或已销户'],
['code' => 'linkcard.common.CardNotExist', 'message' => 'The card does not exist.', 'http_code' => 400, 'description' => '卡号有误,卡不存在'],
['code' => 'linkcard.common.CredentialInstanceNotExist', 'message' => 'The credential instance does not exist.', 'http_code' => 400, 'description' => '凭证实例不存在'],
['code' => 'linkcard.common.CredentialNoNotExist', 'message' => 'The credentialNo does not exist', 'http_code' => 400, 'description' => '凭证号不存在'],
['code' => 'linkcard.common.IccidFormatError', 'message' => 'Iccid format error.', 'http_code' => 400, 'description' => 'iccid格式错误'],
['code' => 'linkcard.common.IccidNotExist', 'message' => 'IccId does not exist.', 'http_code' => 400, 'description' => 'iccid不存在'],
['code' => 'linkcard.common.InvalidAliyunPK', 'message' => 'AliyunPk is invalid.', 'http_code' => 400, 'description' => '阿里云账号无效。'],
['code' => 'linkcard.common.InvalidCallerTypeError', 'message' => 'This access mode is not supported.', 'http_code' => 400, 'description' => '不支持的访问方式。'],
['code' => 'linkcard.common.RamActionPermissionDeny', 'message' => 'You do not have the RAM permission.', 'http_code' => 403, 'description' => '没有RAM权限。'],
['code' => 'linkcard.common.Retry', 'message' => 'Please try again later', 'http_code' => 400, 'description' => '请稍后重试'],
['code' => 'linkcard.common.SignVerificationFailed', 'message' => 'Sign verification failed.', 'http_code' => 400, 'description' => '验签失败'],
['code' => 'linkcard.common.VnoCardNotSupported', 'message' => 'This function does not support vno card.', 'http_code' => 400, 'description' => '该功能暂不支云鹰卡'],
['code' => 'linkcard.directional.notExist', 'message' => 'Can not find direction group.', 'http_code' => 400, 'description' => '找不到定向网络组'],
['code' => 'linkcard.service.forbidden', 'message' => 'Please cancel agree write to RocketMq before delete', 'http_code' => 403, 'description' => '请在删除前取消写入RocketMq的权限'],
['code' => 'linkcard.system.BatchOperationFailed', 'message' => 'An internal error occurred. Try again later.', 'http_code' => 500, 'description' => '批量操作异常。'],
['code' => 'linkcard.system.CarrierNotSupport', 'message' => 'The carrier of the card does not support.', 'http_code' => 400, 'description' => '卡归属的运营商不支持此功能'],
['code' => 'linkcard.system.IllegalRequest', 'message' => 'The request parameter is invalid.', 'http_code' => 400, 'description' => '非法的请求参数。'],
['code' => 'linkcard.system.RPCInvokeError', 'message' => 'An RPC invoking error occurred', 'http_code' => 500, 'description' => 'RPC远程请求错误'],
['code' => 'RamActionPermissionDeny', 'message' => 'You do not have the RAM permission.', 'http_code' => 403, 'description' => '没有RAM权限。'],
['code' => 'Service.InternalError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => '系统内部异常'],
['code' => 'YX.BusinessError', 'message' => 'A business processing exception occurred.', 'http_code' => 500, 'description' => '业务处理异常'],
['code' => 'YX.RpcError', 'message' => 'An RPC invoking error occurred.', 'http_code' => 500, 'description' => '服务请求出错'],
['code' => 'YX.SystemInvokeError', 'message' => '%s.', 'http_code' => 500, 'description' => '%s.'],
],
'changeSet' => [
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'AddCardToDirectionalGroup'],
['description' => '错误码发生变更', 'api' => 'BatchAddDirectionalAddress'],
['description' => '错误码发生变更', 'api' => 'DeleteDirectionalGroup'],
['description' => '错误码发生变更', 'api' => 'ForceActivation'],
],
'createdAt' => '2025-11-27T07:56:50.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListCardInfo'],
['description' => '响应参数发生变更', 'api' => 'ListOrder'],
],
'createdAt' => '2023-08-03T02:46:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'ForceActivation'],
],
'createdAt' => '2023-06-29T06:52:29.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddTagsToCard'],
],
'createdAt' => '2023-06-29T05:50:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCredentialPoolStatistics'],
],
'createdAt' => '2023-06-28T06:33:04.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'AddDirectionalAddress'],
],
'createdAt' => '2023-05-15T08:05:05.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListOrder'],
],
'createdAt' => '2023-04-12T04:59:49.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'GetCardDetail'],
['description' => '错误码发生变更、响应参数发生变更', 'api' => 'GetCardFlowInfo'],
],
'createdAt' => '2023-03-24T08:24:58.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetRealNameStatus'],
],
'createdAt' => '2023-03-24T08:24:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'ListDirectionalDetail'],
],
'createdAt' => '2023-03-24T08:20:41.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListDirectionalAddress'],
],
'createdAt' => '2023-01-09T08:11:33.000Z',
'description' => '定向组中地址列表增加限制条件',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'GetCardDetail'],
],
'createdAt' => '2022-12-08T06:04:54.000Z',
'description' => '卡详情增加销户提示错误码',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'Renew'],
],
'createdAt' => '2022-11-07T06:20:21.000Z',
'description' => '充值接口增加错误码',
],
[
'apis' => [
['description' => '错误码发生变更', 'api' => 'ForceActivation'],
['description' => '错误码发生变更', 'api' => 'ListDirectionalDetail'],
['description' => '错误码发生变更、响应参数发生变更', 'api' => 'ListOrder'],
['description' => '错误码发生变更、请求参数发生变更', 'api' => 'RebindResumeSingleCard'],
['description' => '错误码发生变更、请求参数发生变更', 'api' => 'ResumeSingleCard'],
['description' => '错误码发生变更、请求参数发生变更', 'api' => 'StopSingleCard'],
['description' => '错误码发生变更', 'api' => 'UpdateAutoRechargeSwitch'],
],
'createdAt' => '2022-10-28T11:23:46.000Z',
'description' => '变更对外开放接口的格式',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ListCardInfo'],
],
'createdAt' => '2022-09-29T01:48:49.000Z',
'description' => '八月份迭代上线',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'AddDirectionalGroup'],
['description' => 'OpenAPI 下线', 'api' => 'BatchAddDirectionalAddress'],
['description' => 'OpenAPI 下线', 'api' => 'ListDirectionalDetail'],
],
'createdAt' => '2022-08-09T12:00:42.000Z',
'description' => '定向网相关的api发布',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'GetMqConfig'],
['description' => 'OpenAPI 下线', 'api' => 'ListMqService'],
['description' => 'OpenAPI 下线', 'api' => 'UpdateMqConfig'],
],
'createdAt' => '2022-06-16T08:05:03.000Z',
'description' => 'MQ业务新增接口',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'Renew'],
],
'createdAt' => '2022-04-20T06:14:10.000Z',
'description' => '变更充值接口offerCode参数文档非必填',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'Renew'],
],
'createdAt' => '2022-04-19T03:32:17.000Z',
'description' => '增加充值接口',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'GetCardDetail'],
],
'createdAt' => '2022-01-20T06:00:57.000Z',
'description' => '发布接口,向上兼容, 开放平台SDK在本次迭代发布后才会上传',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAutoRechargeSwitch'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalGroup'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardLatestFlow'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RebindResumeSingleCard'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResumeSingleCard'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectionalGroup'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardRealStatus'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SetCardStopRule'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddDirectionalCard'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagsToCard'],
['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardFlowInfo'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCardInfo'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Renew'],
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDirectionalAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopSingleCard'],
['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRealNameStatus'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOrder'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSimCardStateDistribution'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ForceActivation'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDirectionalDetail'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardDetail'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCardStatusStatistics'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyIotCard'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddCardToDirectionalGroup'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCredentialPoolStatistics'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDirectionalAddress'],
['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BatchAddDirectionalAddress'],
],
],
'ram' => [
'productCode' => 'Dyiot',
'productName' => '物联网无线连接服务',
'ramCodes' => ['linkcard', 'dyiot'],
'ramLevel' => '操作级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'GetCardDetail',
'description' => 'GetCardDetail',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:GetCardDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCardLatestFlow',
'description' => 'GetCardLatestFlow',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:GetCardLatestFlow',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/{#cardmanageId}'],
],
],
],
[
'apiName' => 'ForceActivation',
'description' => '卡的强制激活',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:ForceActivation',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SendMessage',
'description' => 'SendMessage',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkcard:SendMessage',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'RebindResumeSingleCard',
'description' => '卡的换绑复用',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:RebindResumeSingleCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDirectionalDetail',
'description' => '查询卡的定向信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:ListDirectionalDetail',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ResumeSingleCard',
'description' => 'ResumeSingleCard',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:ResumeSingleCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'VerifyIotCard',
'description' => '定向卡查询',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:VerifyIotCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ListDirectionalAddress',
'description' => '查询定向分组信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:ListDirectionalAddress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDirectionalGroup',
'description' => '删除定向分组',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:DeleteDirectionalGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteDirectionalAddress',
'description' => '定向分组删除目标地址',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:DeleteDirectionalAddress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'BatchAddDirectionalAddress',
'description' => '定向地址添加',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkcard:BatchAddDirectionalAddress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'StopSingleCard',
'description' => '卡的主动停用',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:StopSingleCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddDirectionalAddress',
'description' => '定向分组新增目标地址',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:AddDirectionalAddress',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'Renew',
'description' => '充值',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkcard:Renew',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCardStatusStatistics',
'description' => '概览页风险告警',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:GetCardStatusStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCredentialPoolStatistics',
'description' => 'GetCredentialPoolStatistics',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:GetCredentialPoolStatistics',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetCardRealStatus',
'description' => '',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:GetCardRealStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddTagsToCard',
'description' => '物联网卡添加标签',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:AddTagsToCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'GetSimCardStateDistribution',
'description' => '获取卡状态分布',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:GetSimCardStateDistribution',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'SetCardStopRule',
'description' => '设置卡的达量停用规则',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:SetCardStopRule',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'UpdateAutoRechargeSwitch',
'description' => 'UpdateAutoRechargeSwitch',
'operationType' => 'update',
'ramAction' => [
'action' => 'linkcard:UpdateAutoRechargeSwitch',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddCardToDirectionalGroup',
'description' => '定向分组添加卡片',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:AddCardToDirectionalGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard:*:{#accountId}:directionalmanage/{#DirectionalManageId}'],
],
],
],
[
'apiName' => 'GetRealNameStatus',
'description' => 'GetRealNameStatus',
'operationType' => '',
'ramAction' => [
'action' => 'linkcard:GetRealNameStatus',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddDirectionalCard',
'description' => '定向分组导卡',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkcard:AddDirectionalCard',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'AddDirectionalGroup',
'description' => '创建定向分组',
'operationType' => 'create',
'ramAction' => [
'action' => 'linkcard:AddDirectionalGroup',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard::{#accountId}:directionalmanage/*'],
],
],
],
[
'apiName' => 'GetCardFlowInfo',
'description' => '卡流量查询',
'operationType' => 'get',
'ramAction' => [
'action' => 'linkcard:GetCardFlowInfo',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'Dyiot', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'always', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:*'],
['validationType' => 'always', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/{#cardmanageId}'],
['validationType' => 'always', 'resourceType' => 'CardManage', 'arn' => 'acs:linkcard::{#accountId}:cardmanage/*'],
['validationType' => 'always', 'resourceType' => 'SmsManage', 'arn' => 'acs:linkcard:{#regionId}:{#accountId}:smsmanage/*'],
['validationType' => 'always', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard::{#accountId}:directionalmanage/*'],
['validationType' => 'always', 'resourceType' => 'DashboardManage', 'arn' => 'acs:linkcard::{#accountId}:dashboardmanage/*'],
['validationType' => 'always', 'resourceType' => 'CredentialManage', 'arn' => 'acs:linkcard::{#accountId}:credentialmanage/*'],
['validationType' => 'always', 'resourceType' => 'TagManage', 'arn' => 'acs:linkcard::{#accountId}:tagmanage/*'],
['validationType' => 'always', 'resourceType' => 'DirectionalManage', 'arn' => 'acs:linkcard:*:{#accountId}:directionalmanage/{#DirectionalManageId}'],
],
],
];
|