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
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'ROA', 'product' => 'hcs-mgw', 'version' => '2024-06-26'],
'directories' => [
[
'children' => ['ListJobHistory'],
'type' => 'directory',
'title' => 'Node',
],
[
'children' => ['GetAddress', 'ListAddress', 'VerifyAddress'],
'type' => 'directory',
'title' => 'Data address',
],
[
'children' => [
'CreateAddress', 'CreateAgent', 'CreateJob', 'CreateReport', 'CreateTunnel', 'DeleteAddress', 'DeleteAgent', 'DeleteJob', 'DeleteTunnel', 'GetAgent', 'GetAgentStatus', 'GetJob', 'GetJobResult', 'GetReport', 'GetTunnel', 'ListAgent', 'ListJob', 'ListTunnel', 'UpdateAddress', 'UpdateJob',
'UpdateTunnel',
],
'title' => 'Others',
'type' => 'directory',
],
],
'components' => [
'schemas' => [
'AddressDetail' => [
'title' => '数据地址详情。',
'description' => 'Contains the address details.',
'type' => 'object',
'properties' => [
'AddressType' => ['title' => '数据地址类型。', 'description' => 'The address type. Valid values:'."\n"
."\n"
.'Object storage: `oss`, `s3`, `qiniu`, `cos`, `bos`, `obs`, `ks3`, `ucloud`, `upyun`, `azure`, `gcp`, and `tos`.'."\n"
."\n"
.'File storage: `local`, `obsfs`, and `ftp`.'."\n"
."\n"
.'Inventory: `inv`.', 'type' => 'string', 'required' => true, 'example' => 'oss'],
'Bucket' => ['title' => '数据存储空间。', 'description' => 'The name of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_bucket'],
'Domain' => ['title' => '数据存储空间的域名。', 'description' => 'The domain of the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_domain'],
'Prefix' => ['title' => '数据地址前缀。', 'description' => 'The object prefix in the bucket.', 'type' => 'string', 'example' => 'test_prefix'],
'AccessId' => ['title' => '数据存储空间AccessKeyId。', 'description' => 'The AccessKey ID used to access the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_access_id'],
'AccessSecret' => ['title' => '数据存储空间SecretAccessKey。', 'description' => 'The AccessKey Secret used to access the bucket.', 'type' => 'string', 'required' => true, 'example' => 'test_secret_key'],
'Role' => ['title' => '授权角色。数据存储空间是OSS时,可以指定授权角色,无需指定存储空间的AK。', 'description' => 'The authorization role. If the bucket is an OSS bucket, you can use this role to grant access instead of an AccessKey.', 'type' => 'string', 'example' => 'test_role'],
'InvDomain' => ['title' => '列表存储空间的域名。', 'description' => 'The domain of the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_domain'],
'InvBucket' => ['title' => '列表存储空间。', 'description' => 'The name of the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_bucket'],
'InvAccessId' => ['title' => '列表存储空间AccessKeyId。', 'description' => 'The AccessKey ID used to access the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_access_id'],
'InvAccessSecret' => ['title' => '列表存储空间SecretAccessKey。', 'description' => 'The AccessKey Secret used to access the inventory bucket.', 'type' => 'string', 'example' => 'test_inv_secret_key'],
'InvPath' => ['title' => '列表清单文件。指定清单列表和格式。', 'description' => 'The path to the manifest file, which lists the objects and their format.', 'type' => 'string', 'example' => 'manifest.json'],
'InvRole' => ['title' => '列表存储空间授权角色。列表存储空间是OSS时,可以指定授权角色,无需指定列表存储空间的AK。', 'description' => 'The authorization role for the inventory bucket. If the inventory bucket is an OSS bucket, you can use this role to grant access instead of an AccessKey.', 'type' => 'string', 'example' => 'test_inv_role'],
'InvLocation' => ['title' => '列表存储空间类型。取值:oss,s3,cos。', 'description' => 'The type of the inventory bucket.<br>'."\n"
.'Valid values: `oss` and `s3`.<br>', 'type' => 'string', 'example' => 'oss'],
'AgentList' => ['title' => '关联代理。通过专线/VPN等方式访问数据,需要关联代理。', 'description' => 'A list of agents required to access data over a leased line or a VPN connection.', 'type' => 'string', 'example' => 'agent1,agent2'],
'RegionId' => ['title' => '数据存储空间区域。数据存储空间是OSS时,必须指定存储空间区域,无需指定存储空间域名。', 'description' => 'The region of the bucket. This parameter is required for OSS buckets and eliminates the need to specify a domain. Use the OSS-specific region ID format.', 'type' => 'string', 'example' => 'oss-cn-hangzhou'],
'InvRegionId' => ['title' => '列表存储空间区域。列表存储空间是OSS时,必须指定列表存储空间区域,无需指定列表存储空间域名。', 'description' => 'The region of the inventory bucket. This parameter is required for OSS inventory buckets and eliminates the need to specify a domain. Use the OSS-specific region ID format.', 'type' => 'string', 'example' => 'oss-cn-hangzhou'],
'DataType' => ['title' => '通用清单使用,当AddressType是inv时,DataType表示实际的存储类型,可取值为: oss、s3等', 'description' => 'Specifies the underlying storage type, such as `oss`, `s3`, or `obs`, when `AddressType` is `inv`.', 'type' => 'string', 'example' => 'oss'],
'HdfsAuthConfig' => ['description' => '', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/HdfsAuthConfig'],
],
'example' => '',
],
'Audit' => [
'title' => '审计方式。',
'description' => 'The audit method.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'LogMode' => ['title' => '日志推送。取值: off,不推送日志;basic,仅推送文件迁移失败日志;detail,推送文件迁移成功和失败日志。推送迁移日志到SLS,需要创建AliyunOSSImportSlsAuditRole角色,并对角色完成授权。', 'description' => 'Specifies whether to push migration logs to Simple Log Service (SLS). To push migration logs to SLS, you must create the AliyunOSSImportSlsAuditRole role and grant the required permissions to the role. Valid values: off, basic, and detail. off: does not push migration logs. basic: pushes only migration failure logs. detail: pushes migration success logs and migration failure logs.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'off'],
],
],
'CreateAddressInfo' => [
'title' => '创建数据地址详情。',
'description' => 'The information about the data address.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Name' => ['title' => '数据地址名称。取值:英文小写字母、数字和特殊字符-和_,最短 3 字符, 最长 63 个字符,区分大小写,utf8 编码并且不可以- 和_开头,不能为空。', 'description' => 'The name of the data address.\\'."\n"
.'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_name'],
'AddressDetail' => ['title' => '数据地址详情。', 'description' => 'The details of the data address.'."\n", 'visibility' => 'Public', 'required' => true, '$ref' => '#/components/schemas/AddressDetail'],
'Tags' => ['title' => '标签,KeyValue格式。 允许字符:英文大小写字母、数字和特殊字符-_,。长度限制:1KB。', 'description' => 'The tags in the key:value format.\\'."\n"
.'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
],
'parseType' => 'struct',
],
'CreateAgentInfo' => [
'title' => '创建代理详情。',
'description' => 'The information about the agent.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Name' => ['title' => '代理名称。取值:英文小写字母、数字和特殊字符-和_,最短 3 字符, 最长 63 个字符,区分大小写,utf8 编码并且不可以- 和_开头,不能为空。', 'description' => 'The name of the agent.\\'."\n"
.'The name can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name must be 3 to 63 characters in length. The name is case-sensitive and encoded in UTF-8. The name cannot start with a hyphen (-) or an underscore (\\_). You must specify a name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_name'],
'DeployMethod' => ['title' => '代理的部署方式。取值:default。', 'description' => 'The deployment mode of the agent.\\'."\n"
.'Set the value to default, which specifies the independent process mode.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'default'],
'AgentEndpoint' => ['title' => '代理访问方式,支持公网,专线/VPN等。取值:public,vpc。', 'description' => 'The method that is used to access the agent.\\'."\n"
.'Valid values: public and vpc.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'vpc'],
'Tags' => ['title' => '标签,KeyValue格式。 允许字符:英文大小写字母、数字和特殊字符-_,。长度限制:1KB。', 'description' => 'The tags in the key:value format.\\'."\n"
.'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
'TunnelId' => ['title' => '通道ID。', 'description' => 'The tunnel ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'test_tunnel_id'],
],
],
'CreateJobInfo' => [
'title' => '创建迁移任务详情。',
'description' => 'Details of the migration task to create.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '任务名称。取值:英文小写字母、数字和特殊字符-和_,最短 3 字符, 最长 63 个字符,区分大小写,utf8 编码并且不可以- 和_开头,不能为空。', 'description' => 'The task name.<br>'."\n"
.'The name must be 3 to 63 characters in length and can contain lowercase letters, digits, hyphens (-), and underscores (\\_). The name is case-sensitive and must be UTF-8 encoded. It cannot start with a hyphen (-) or an underscore (\\_). This parameter cannot be empty.<br>', 'type' => 'string', 'required' => true, 'example' => 'test_name'],
'SrcAddress' => ['title' => '源数据地址名称。', 'description' => 'The name of the source data address.', 'type' => 'string', 'required' => true, 'example' => 'test_src_address'],
'DestAddress' => ['title' => '目的数据地址名称。', 'description' => 'The name of the destination data address.', 'type' => 'string', 'required' => true, 'example' => 'test_dest_address'],
'OverwriteMode' => ['title' => '文件覆盖方式。取值:never,不覆盖;always,覆盖;', 'description' => 'The file overwrite mode.<br>'."\n"
.'Valid values: \\`never\\` and \\`always\\`. \\`never\\`: Does not overwrite existing files. \\`always\\`: Overwrites existing files.<br>', 'type' => 'string', 'required' => true, 'example' => 'always'],
'TransferMode' => ['title' => '文件传输方式。取值:all,强制覆盖;lastmodified,根据最后修改时间覆盖。 OverwriteMode与TransferMode结合使用,分别设置: always,all:强制覆盖 always, lastmodified:根据文件最后修改时间覆盖 never,all:不覆盖。', 'description' => 'The file transfer mode.<br>'."\n"
.'Valid values: \\`all\\` (full transfer) and \\`lastmodified\\` (incremental transfer).<br>'."\n"
.'\\`OverwriteMode\\` and \\`TransferMode\\` are used together:<br><br>'."\n"
."\n"
.'- \\`always\\` and \\`all\\`: Forces a full overwrite.'."\n"
."\n"
.'- \\`always\\` and \\`lastmodified\\`: Overwrites files based on their last modified time.'."\n"
."\n"
.'- \\`never\\` and an empty value for \\`TransferMode\\`: Does not overwrite files with the same name.', 'type' => 'string', 'required' => true, 'example' => 'all'],
'Tags' => ['title' => '标签,KeyValue格式。 允许字符:英文大小写字母、数字和特殊字符-_,。长度限制:1KB。', 'description' => 'The tags, in key-value format.<br>'."\n"
.'Allowed characters include uppercase and lowercase letters, digits, hyphens (-), and underscores (\\_). The maximum length is 1024 characters.<br>', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
'ParentVersion' => ['title' => '父任务ID。创建失败文件重试子任务时可以指定父任务ID。', 'description' => 'The parent task ID. Specify this ID when you create a subtask to retry failed file transfers.', 'type' => 'string', 'example' => '6af62558-970d-4f44-8663-4e297170fd6a'],
'ConvertSymlinkTarget' => ['title' => '是否转换软链接Target。当源和目的数据地址是oss到local,local到oss,local到local时,可以指定转换软链接Target,使得迁移后的软链接能够正常访问。', 'description' => 'Specifies whether to transform the target of a symbolic link. When migrating data from OSS to a local server, from a local server to OSS, or between two local servers, set this parameter to \\`true\\` to ensure that symbolic links can be accessed after migration.', 'type' => 'boolean', 'example' => 'false'],
'Audit' => ['title' => '审计方式。', 'description' => 'The audit method.', '$ref' => '#/components/schemas/Audit', 'example' => ''],
'EnableMultiVersioning' => ['title' => '是否迁移多版本。暂不支持多版本迁移。', 'description' => 'Specifies whether to migrate multiple object versions. Multi-version migration is not supported.', 'type' => 'boolean', 'example' => 'false'],
'FilterRule' => ['title' => '过滤规则。', 'description' => 'The filter rule.', '$ref' => '#/components/schemas/FilterRule', 'example' => ''],
'ImportQos' => ['title' => '任务限流。', 'description' => 'The task throttling settings.', '$ref' => '#/components/schemas/ImportQos', 'example' => ''],
'ScheduleRule' => ['title' => '调度规则。', 'description' => 'The scheduling rule.', '$ref' => '#/components/schemas/ScheduleRule', 'example' => ''],
'CreateReport' => ['title' => '是否创建迁移报告。', 'description' => 'Specifies whether to create a migration report.', 'type' => 'boolean', 'example' => 'true'],
'WithStorageClass' => ['description' => 'Specifies whether to migrate the StorageClass property. This is allowed only for OSS-to-OSS migration.', 'title' => '是否迁移StorageClass属性,只允许oss->oss', 'type' => 'boolean', 'example' => 'false'],
'TargetStorageClass' => ['description' => 'Specifies the StorageClass for destination files. The destination address can only be OSS. Valid values: Standard, IA, Archive, ColdArchive, DeepColdArchive.', 'title' => '指定设置目的文件的storageClass,目的地址只能是oss。 合法值:Standard IA Archive ColdArchive DeepColdArchive', 'type' => 'string', 'example' => 'Standard'],
'WithLastModifyTime' => ['description' => 'Specifies whether to preserve the lastModifyTime. Default value: true.', 'title' => '是否保留lastModifyTime,默认true', 'type' => 'boolean', 'example' => 'true'],
'AppendableToNormal' => ['description' => 'Specifies whether to migrate appendable files as normal or multipart files. Default value: false.', 'title' => '是否把appendable文件迁成normal/multipart文件,默认false', 'type' => 'boolean', 'example' => 'false'],
],
'example' => '',
],
'CreateReportInfo' => [
'title' => '创建迁移报告详情。',
'description' => 'The information about the migration report.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'JobName' => ['title' => '任务名称。', 'description' => 'The task name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_job_name'],
'Version' => ['title' => '任务ID。', 'description' => 'The task ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_job_id'],
'RuntimeId' => ['title' => '任务执行ID。', 'description' => 'The execution ID of the task.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'CreateTunnelInfo' => [
'title' => '创建通道详情。',
'description' => 'The information about the tunnel.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'TunnelQos' => ['title' => '通道限流。', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/TunnelQos'],
'Tags' => ['title' => '标签,KeyValue格式。 允许字符:英文大小写字母、数字和特殊字符-_,。长度限制:1KB。', 'description' => 'The tags in the key:value format.\\'."\n"
.'The value can contain letters, digits, hyphens (-), underscores (\\_), and commas (,). The value can be up to 1,024 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'a:a'],
],
'required' => false,
],
'Excludes' => [
'title' => 'A short description of struct',
'description' => '排除过滤器',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'TimeFilter' => [
'title' => 'timeFilter',
'description' => 'timeFilter',
'visibility' => 'Public',
'type' => 'array',
'items' => ['visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TimeFilter'],
],
'Regex' => [
'title' => 'regex',
'description' => 'regex',
'visibility' => 'Public',
'type' => 'array',
'items' => ['visibility' => 'Public', 'type' => 'string', 'extendType' => 'true'],
],
],
],
'FileTypeFilters' => [
'title' => '文件类型过滤器。',
'description' => 'The filter based on the file type.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'ExcludeSymlink' => ['title' => '过滤软链接。', 'description' => 'Specifies whether to filter out symbolic links.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'fasle'],
'ExcludeDir' => ['title' => '过滤目录文件。', 'description' => 'Specifies whether to filter out files in directories.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'fasle'],
],
],
'FilterRule' => [
'title' => '过滤规则。',
'description' => 'The filtering rule.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'KeyFilters' => ['title' => '文件名过滤器。', 'description' => 'The filter based on the file name.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/KeyFilters'],
'LastModifiedFilters' => ['title' => '文件修改时间过滤器。', 'description' => 'The filter based on the file modification time.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/LastModifiedFilters'],
'FileTypeFilters' => ['title' => '文件类型过滤器。', 'description' => 'The filter based on the file type.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/FileTypeFilters'],
],
],
'GetAddressResp' => [
'title' => '获取数据地址详情。',
'description' => 'The queried data address.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Owner' => ['title' => '数据地址拥有者。', 'description' => 'The owner of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_owner'],
'Name' => ['title' => '数据地址名称。', 'description' => 'The name of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_name'],
'AddressDetail' => ['title' => '数据地址详情。', 'description' => 'The details of the data address.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/AddressDetail'],
'CreateTime' => ['title' => '创建时间', 'description' => 'The time when the data address was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01 12:00:00'],
'ModifyTime' => ['title' => '修改时间。', 'description' => 'The time when the data address was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01 12:00:00'],
'VerifyTime' => ['title' => '数据地址校验时间。', 'description' => 'The time when the data address was verified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01 12:00:00'],
'Version' => ['title' => '数据地址ID', 'description' => 'The ID of the data address.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_id'],
'Tags' => ['title' => '标签。', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
'Status' => [
'title' => '数据地址状态。',
'description' => 'The state of the data address.'."\n",
'visibility' => 'Public',
'type' => 'string',
'enumValueTitles' => ['unavailable' => 'unavailable', 'available' => 'available', 'notVerify' => 'notVerify'],
'example' => 'avaliable',
],
'VerifyResult' => ['title' => '数据地址校验结果。', 'description' => 'The verification result of the data address.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/VerifyResp'],
],
],
'GetAgentResp' => [
'title' => '获取代理详情。',
'description' => 'The queried agent.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Owner' => ['title' => '代理拥有者。', 'description' => 'The agent owner.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_owner'],
'Name' => ['title' => '代理名称。', 'description' => 'The agent name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_name'],
'CreateTime' => ['title' => '创建时间', 'description' => 'The time when the agent was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'ModifyTime' => ['title' => '修改时间', 'description' => 'The time when the agent was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'DeployMethod' => ['title' => '代理部署方式。', 'description' => 'The deployment mode of the agent.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'default'],
'AgentEndpoint' => ['title' => '代理访问方式。', 'description' => 'The method that is used to access the agent.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'vpc'],
'ActivationKey' => ['title' => '代理安全码。', 'description' => 'The security code of the agent.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '6af62558-970d-4f44-8663-4e297170fd6a'],
'Tags' => ['title' => '标记。', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
'Version' => ['title' => '代理ID。', 'description' => 'The agent ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_agent_id'],
'TunnelId' => ['title' => '通道ID。', 'description' => 'The tunnel ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_tunnel_id'],
],
],
'GetAgentStatusResp' => [
'title' => '获取代理状态详情。',
'description' => 'The queried state of the agent.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Status' => ['title' => '代理状态。取值:OK,Disconnected,NoResponse。', 'description' => 'The agent state.\\'."\n"
.'Valid values: OK, Disconnected, and NoResponse.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'OK'],
],
'parseType' => 'struct',
],
'GetJobResp' => [
'title' => '任务详情。',
'description' => 'The details of the job.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '任务名称。', 'description' => 'The name of the job.', 'type' => 'string', 'example' => 'test_name'],
'SrcAddress' => ['title' => '源数据地址名称。', 'description' => 'The name of the source data address.', 'type' => 'string', 'example' => 'test_src_address'],
'DestAddress' => ['title' => '目的数据地址名称。', 'description' => 'The name of the destination data address.', 'type' => 'string', 'example' => 'test_dest_address'],
'Status' => ['title' => '任务状态。', 'description' => 'The status of the job.'."\n"
."\n"
.'IMPORT\\_JOB\\_BEGIN: The job is created.'."\n"
."\n"
.'IMPORT\\_JOB\\_LAUNCHING: The job is starting.'."\n"
."\n"
.'IMPORT\\_JOB\\_PREPARING: The job is preparing.'."\n"
."\n"
.'IMPORT\\_JOB\\_DOING: The job is running.'."\n"
."\n"
.'IMPORT\\_JOB\\_SUSPEND: The job is paused.'."\n"
."\n"
.'IMPORT\\_JOB\\_CLOSING: The job is shutting down.'."\n"
."\n"
.'IMPORT\\_JOB\\_FINISHED: The job is finished.'."\n"
."\n"
.'IMPORT\\_JOB\\_INTERRUPTED: The job is abnormally interrupted.'."\n"
."\n"
.'IMPORT\\_JOB\\_CONFIRMED: The migration is complete, and the user has confirmed data integrity and consistency.'."\n"
."\n"
.'IMPORT\\_JOB\\_DELETING: The job is being deleted.', 'type' => 'string', 'example' => 'IMPORT_JOB_DOING'],
'EnableMultiVersioning' => ['title' => '是否开启多版本。', 'description' => 'Indicates whether multi-versioning is enabled.', 'type' => 'boolean', 'example' => 'false'],
'CreateTime' => ['title' => '任务创建时间。', 'description' => 'The time when the job was created.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'ModifyTime' => ['title' => '任务修改时间。', 'description' => 'The time when the job was last modified.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'Version' => ['title' => '任务ID。', 'description' => 'The ID of the job.', 'type' => 'string', 'example' => 'test_id'],
'Audit' => ['title' => '审计方式。', 'description' => 'The audit method.', '$ref' => '#/components/schemas/Audit', 'example' => ''],
'OverwriteMode' => ['title' => '文件覆盖方式。', 'description' => 'The file overwrite mode.', 'type' => 'string', 'example' => 'always'],
'TransferMode' => ['title' => '文件传输方式。', 'description' => 'The file transfer mode.', 'type' => 'string', 'example' => 'all'],
'Tags' => ['title' => '标记。', 'description' => 'The tags.', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
'ParentName' => ['title' => '父任务名称,非重试任务该。值为空', 'description' => 'The name of the parent job.', 'type' => 'string', 'example' => 'test_parent_name'],
'ParentVersion' => ['title' => '父任务ID,非重试任务该值为空', 'description' => 'The ID of the parent job.', 'type' => 'string', 'example' => '7db93837-a5ee-4e3a-b3c8-800e7947dabc'],
'ConvertSymlinkTarget' => ['title' => '是否转换软链接Target。', 'description' => 'Indicates whether to convert the target of the symbolic link.', 'type' => 'boolean', 'example' => 'false'],
'CreateReport' => ['title' => '是否生成迁移报告。', 'description' => 'Indicates whether to generate a migration report.', 'type' => 'boolean', 'example' => 'false'],
'Owner' => ['title' => '拥有者,即迁移服务控制台主账号', 'description' => 'The owner.', 'type' => 'string', 'example' => 'test_owner'],
'FilterRule' => ['title' => '过滤规则。', 'description' => 'The filter rule.', '$ref' => '#/components/schemas/FilterRule', 'example' => ''],
'ImportQos' => ['title' => '任务限流。', 'description' => 'The rate limiting rule for the job.', '$ref' => '#/components/schemas/ImportQos', 'example' => ''],
'ScheduleRule' => ['title' => '调度规则。', 'description' => 'The scheduling rule.', '$ref' => '#/components/schemas/ScheduleRule', 'example' => ''],
'WithStorageClass' => ['title' => '是否迁移StorageClass属性,只允许oss->oss。', 'description' => 'Specifies whether to migrate the StorageClass property. This is allowed only for migrations from OSS to OSS.', 'type' => 'boolean', 'example' => 'false'],
'TargetStorageClass' => ['title' => '指定设置目的文件的storageClass,目的地址只能是oss。 合法值:Standard IA Archive ColdArchive DeepColdArchive。', 'description' => 'Specifies the StorageClass of the destination file. The destination address must be an OSS address. Valid values: Standard, IA, Archive, ColdArchive, and DeepColdArchive.', 'type' => 'string', 'example' => 'Standard'],
'WithLastModifyTime' => ['title' => '是否保留lastModifyTime,默认true', 'description' => 'Specifies whether to retain the lastModifyTime property. The default value is true.', 'type' => 'boolean', 'example' => 'true'],
'AppendableToNormal' => ['title' => '是否把appendable文件迁成normal/multipart文件,默认false', 'description' => 'Specifies whether to migrate appendable files as normal or multipart files. The default value is false.', 'type' => 'boolean', 'example' => 'true'],
],
'example' => '',
],
'GetJobResultResp' => [
'title' => '任务重试信息详情。',
'description' => 'The results of a migration job, including retry information for failed files and migration statistics.',
'type' => 'object',
'properties' => [
'ReadyRetry' => ['title' => '失败文件是否可重试。取值:NoNeed,无需重试;Ready,失败文件列表准备完成;NotReady,失败文件列表准备中。', 'description' => 'The retry readiness status for failed files. Valid values: NoNeed indicates that all files were migrated successfully and no retry is required. Ready indicates that the failed file list has been generated and is available for retry. NotReady indicates that the failed file list is being generated.<br><br>', 'type' => 'string', 'example' => 'Ready'],
'InvPath' => ['title' => '失败文件列表清单文件。构造新的数据地址时,填入InvPath字段。', 'description' => 'The path to the manifest file that lists the failed files. Use this value as the InvPath parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'mainfest.json'],
'InvBucket' => ['title' => '失败文件列表存储空间。构造新的数据地址时,填入InvBucket字段。', 'description' => 'The name of the bucket that stores the failed file list. Use this value as the InvBucket parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_sys_bucket'],
'InvDomain' => ['title' => '失败文件列表存储空间域名。构造新的数据地址时,填入InvDomain字段。', 'description' => 'The endpoint of the bucket that stores the failed file list. Use this value as the InvDomain parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_domain'],
'InvLocation' => ['title' => '失败文件列表存储空间类型。构造新的数据地址时,填入InvLocation字段。', 'description' => 'The storage type of the bucket that stores the failed file list, such as oss. Use this value as the InvLocation parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'oss'],
'InvAccessId' => ['title' => '失败文件列表存储空间的AccessKeyId。构造新的数据地址时,填入InvAccessId字段。', 'description' => 'The AccessKey ID that is used to access the bucket where the failed file list is stored. Use this value as the InvAccessId parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_access_id'],
'InvAccessSecret' => ['title' => '失败文件列表存储空间的SecretAccessKey。构造新的数据地址时,填入InvAccessSecret字段。', 'description' => 'The AccessKey secret that is used to access the bucket where the failed file list is stored. Use this value as the InvAccessSecret parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_secret_key'],
'InvRegionId' => ['title' => '失败文件存储空间区域。构造新的数据地址时,填入InvRegionId字段。', 'description' => 'The region ID of the bucket that stores the failed file list. Use this value as the InvRegionId parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'test_region_id'],
'AddressType' => ['title' => '根据失败文件列表构造的地址类型。构造新的数据地址时,填入AddressType字段。', 'description' => 'The data address type for the retry job. This value indicates that the data address is constructed from a failed file inventory. Use this value as the AddressType parameter when you create a data address for a retry job.', 'type' => 'string', 'example' => 'ossinv'],
'TotalObjectCount' => ['title' => '总文件数量。', 'description' => 'The total number of objects in the source data address.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'CopiedObjectCount' => ['title' => '迁移成功的文件数量。包括成功和跳过的文件。', 'description' => 'The number of objects that were processed successfully. This value includes both migrated objects and skipped objects.', 'type' => 'integer', 'format' => 'int64', 'example' => '800'],
'FailedObjectCount' => ['title' => '迁移失败的文件数量。', 'description' => 'The number of objects that failed to migrate.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
'TotalObjectSize' => ['title' => '文件总数据量。', 'description' => 'The total size of all objects in the source data address. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'CopiedObjectSize' => ['title' => '迁移成功的文件数据量。', 'description' => 'The total size of objects that were processed successfully. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '800'],
'Version' => ['title' => '任务ID。', 'description' => 'The unique identifier of the migration job.', 'type' => 'string', 'example' => 'test_job_id'],
'SkippedObjectCount' => ['title' => '跳过的文件数量。', 'description' => 'The number of objects that were skipped during migration. Objects are skipped when they already exist at the destination and meet the configured skip conditions.', 'type' => 'integer', 'example' => '5000', 'format' => 'int64'],
'SkippedObjectSize' => ['title' => '跳过的文件size。', 'description' => 'The total size of objects that were skipped during migration. Unit: bytes.', 'type' => 'integer', 'example' => '1000000', 'format' => 'int64'],
],
'example' => '',
],
'GetReportResp' => [
'title' => '迁移报告详情。',
'description' => 'The queried migration report.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Status' => ['title' => '迁移报告状态。取值:Running,生成中;NotExist,不存在;Finished,生成完成;Failed,生成失败。', 'description' => 'The state of the migration report.\\'."\n"
.'Valid values: Running, NotExist, Finished, and Failed.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Running'],
'ReportCreateTime' => ['title' => '迁移报告创建时间。', 'description' => 'The time when the migration report was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'ReportEndTime' => ['title' => '迁移报告生成结束时间。', 'description' => 'The time when the migration report was generated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'TotalCount' => ['title' => '迁移文件总数量。', 'description' => 'The total number of files.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
'CopiedCount' => ['title' => '迁移文件成功数量。', 'description' => 'The number of files that are migrated.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '800'],
'SkippedCount' => ['title' => '迁移文件跳过数量。', 'description' => 'The number of files that are skipped.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'FailedCount' => ['title' => '迁移文件失败数量。', 'description' => 'The number of files that failed to be migrated.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
'JobCreateTime' => ['title' => '任务创建时间。', 'description' => 'The time when the task was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'JobEndTime' => ['title' => '任务结束时间。', 'description' => 'The time when the task ended.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'JobExecuteTime' => ['title' => '任务执行时间。', 'description' => 'The task duration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1000s'],
'TotalListPrefix' => ['title' => '文件列表所在位置。', 'description' => 'The path of files.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_total_prefix/'],
'SkippedListPrefix' => ['title' => '跳过文件列表所在位置。', 'description' => 'The path of files that are skipped.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_skipped_prefix/'],
'FailedListPrefix' => ['title' => '失败文件列表所在位置。', 'description' => 'The path of files that failed to be migrated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_failed_prefix/'],
'ErrorMessage' => ['title' => '异常信息。', 'description' => 'The error message.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test error msg.'],
],
'example' => '',
],
'GetTunnelResp' => [
'title' => '获取通道详情。',
'description' => 'The queried tunnel.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Owner' => ['title' => '通道拥有者。', 'description' => 'The tunnel owner.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_owner'],
'TunnelId' => ['title' => '通道ID。', 'description' => 'The tunnel ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_tunnel_id'],
'CreateTime' => ['title' => '创建时间。', 'description' => 'The time when the tunnel was created.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'ModifyTime' => ['title' => '修改时间。', 'description' => 'The time when the tunnel was last modified.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'Tags' => ['title' => '标签。', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
'TunnelQos' => ['title' => '通道限流。', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/TunnelQos', 'example' => ''],
],
'example' => '',
],
'HdfsAuthConfig' => [
'type' => 'object',
'properties' => [
'UserName' => ['description' => 'The username for HDFS authentication.', 'type' => 'string', 'title' => '', 'example' => ''],
'AuthType' => ['description' => 'The authentication type for HDFS.', 'type' => 'string', 'title' => '', 'example' => ''],
],
'description' => 'Authentication configuration for HDFS.',
'title' => '',
'example' => '',
],
'ImportQos' => [
'title' => '任务限流。',
'description' => 'The throttling settings of the task.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'MaxBandWidth' => ['title' => '带宽,单位bit/s。', 'description' => 'The maximum bandwidth. Unit: bit/s.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'],
'MaxImportTaskQps' => ['title' => '每秒迁移文件数。', 'description' => 'The number of files that are migrated per second.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
],
],
'Includes' => [
'title' => 'A short description of struct',
'description' => '包含过滤器。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'TimeFilter' => [
'title' => 'timeFilter',
'description' => 'timeFilter',
'visibility' => 'Public',
'type' => 'array',
'items' => ['visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TimeFilter', 'description' => '最后修改时间过滤器。'],
],
'Regex' => [
'title' => 'regex match',
'description' => 'regex match',
'visibility' => 'Public',
'type' => 'array',
'items' => ['visibility' => 'Public', 'type' => 'string', 'extendType' => 'true', 'description' => '文件名正则表达式。'],
],
],
],
'JobHistory' => [
'title' => '任务运行历史。',
'description' => 'The details of the job run history.',
'type' => 'object',
'properties' => [
'Name' => ['title' => '任务名称。', 'description' => 'The job name.', 'type' => 'string', 'example' => 'test_name'],
'JobVersion' => ['title' => '任务ID。', 'description' => 'The job ID.', 'type' => 'string', 'example' => 'test_id'],
'RuntimeId' => ['title' => '执行记录ID。', 'description' => 'The task execution ID.', 'type' => 'string', 'example' => '1'],
'CommitId' => ['title' => '状态变更ID。', 'description' => 'The ID of the job status change.', 'type' => 'string', 'example' => '2'],
'StartTime' => ['title' => '当前状态开始时间。', 'description' => 'The start time of the current status.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'EndTime' => ['title' => '当前状态结束时间。', 'description' => 'The end time of the current status.', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'Status' => ['title' => '任务状态。', 'description' => 'The job status.', 'type' => 'string', 'example' => 'IMPORT_JOB_DOING'],
'TotalCount' => ['title' => '迁移文件总数量。', 'description' => 'The total number of files.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'default' => '0'],
'CopiedCount' => ['title' => '迁移文件完成数量。', 'description' => 'The number of files whose migration is complete. This includes files that were successfully migrated and files that were skipped.', 'type' => 'integer', 'format' => 'int64', 'example' => '900', 'default' => '0'],
'FailedCount' => ['title' => '迁移文件失败数量。', 'description' => 'The number of files that failed to be migrated.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'default' => '0'],
'TotalSize' => ['title' => '迁移文件总Size,单位Byte。', 'description' => 'The total size of the files, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'default' => '0'],
'CopiedSize' => ['title' => '迁移文件Size,单位Byte。', 'description' => 'The size of the migrated files, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'default' => '0'],
'RuntimeState' => ['title' => '运行状态。取值:Normal/Interrupt。', 'description' => 'The running status.<br>'."\n"
.'Valid values: \\`Normal\\` (Normal) and \\`Interrupt\\` (Abnormal interruption).<br><br>', 'type' => 'string', 'example' => 'Normal'],
'Message' => ['title' => '异常信息。', 'description' => 'The exception message.', 'type' => 'string', 'example' => 'test error msg.'],
'Operator' => ['title' => '操作者。', 'description' => 'The operator.<br>'."\n"
.'Valid values: \\`user\\` and \\`system\\`.<br><br>', 'type' => 'string', 'example' => 'user'],
'ListStatus' => ['title' => '数据列举状态。取值:Listing,Finished。', 'description' => 'The data listing status.<br>'."\n"
.'Valid values: \\`Listing\\` (Listing in progress) and \\`Finished\\` (Listing complete).<br><br>', 'type' => 'string', 'example' => 'Listing'],
'SkippedCount' => ['title' => '跳过的文件数', 'description' => 'The number of skipped files.', 'type' => 'integer', 'example' => '1000', 'format' => 'int64'],
'SkippedSize' => ['title' => '跳过的文件大小', 'description' => 'The size of skipped files.', 'type' => 'integer', 'example' => '100000', 'format' => 'int64'],
],
'required' => false,
'example' => '',
],
'KeyExcludes' => [
'title' => 'A short description of struct',
'description' => '排除文件名。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Regex' => [
'title' => '过滤规则',
'description' => '正则表达式列表。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '正则表达式。', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true'],
],
],
],
'KeyFilterItem' => [
'title' => '文件名过滤项。',
'description' => 'The filter based on the file name.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Regex' => [
'title' => '正则表达式列表。',
'description' => 'The regular expressions.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The regular expression.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '.*\\.jpg$', 'extendType' => 'true'],
],
],
],
'KeyFilters' => [
'title' => '文件名过滤器。',
'description' => 'The filter based on the file name.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Includes' => ['title' => '包含文件名', 'description' => 'The included file name.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/KeyFilterItem'],
'Excludes' => ['title' => '排除文件名。', 'description' => 'The excluded file name.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/KeyFilterItem'],
],
],
'KeyIncludes' => [
'title' => 'A short description of struct',
'description' => '包含文件名。',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Regex' => [
'title' => '过滤规则',
'description' => '正则表达式列表。',
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => '正则表达式。', 'visibility' => 'Public', 'type' => 'string', 'extendType' => 'true'],
],
],
],
'LastModifiedFilters' => [
'title' => '文件修改时间过滤器。',
'description' => 'The filter based on the file modification time.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Includes' => ['title' => '包含文件修改时间。', 'description' => 'The included file modification time.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/LastModifyFilterItem'],
'Excludes' => ['title' => '排除文件修改时间。', 'description' => 'The excluded file modification time.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/LastModifyFilterItem'],
],
],
'LastModifyFilterItem' => [
'title' => '文件修改时间过滤项。',
'description' => 'The filter based on the file modification time.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'TimeFilter' => [
'title' => '时间过滤器列表。',
'description' => 'The time filters.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The time filter.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/TimeFilter'],
],
],
],
'ListAddressResp' => [
'title' => '数据地址列表详情。',
'description' => 'The queried data addresses.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'],
'NextMarker' => ['title' => '下次列举数据地址的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_marker'],
'ImportAddress' => [
'title' => '数据地址列表。',
'description' => 'The data addresses.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The data address.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetAddressResp', 'title' => '', 'example' => ''],
'example' => '',
],
],
'example' => '',
],
'ListAgentResp' => [
'title' => '代理列表详情。',
'description' => 'The queried agents.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'],
'NextMarker' => ['title' => '下次列举代理的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_next_marker'],
'ImportAgent' => [
'title' => '代理列表。',
'description' => 'The agents.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The agent.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetAgentResp', 'title' => '', 'example' => ''],
'example' => '',
],
],
'example' => '',
],
'ListJobHistoryResp' => [
'title' => '任务运行历史列表详情。',
'description' => 'The execution history of migration tasks.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'true'],
'NextMarker' => ['title' => '下次列举任务运行历史的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_next_marker'],
'JobHistory' => [
'title' => '任务运行历史列表。',
'description' => 'The execution history of migration tasks.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The execution history of the migration task.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/JobHistory', 'title' => '', 'example' => ''],
'example' => '',
],
],
'example' => '',
],
'ListJobInfo' => [
'title' => '任务列表详情。',
'description' => 'The queried tasks.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'],
'NextMarker' => ['title' => '下次列举任务的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_next_marker'],
'ImportJob' => [
'title' => '任务列表。',
'description' => 'The tasks.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The task details.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/CreateJobInfo', 'title' => '', 'example' => ''],
'example' => '',
],
],
'required' => false,
'example' => '',
],
'ListJobResp' => [
'title' => '任务列表详情。',
'description' => 'The queried tasks.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'NextMarker' => ['title' => '下次列举任务的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_nex_marker'],
'Truncated' => ['title' => '是否截断。', 'description' => 'Indicates whether the queried results are truncated.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true'],
'ImportJob' => [
'title' => '任务详情列表。',
'description' => 'The queried tasks.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The task details.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetJobResp', 'title' => '', 'example' => ''],
'example' => '',
],
],
'example' => '',
],
'ListTunnelResp' => [
'title' => '通道列表详情。',
'description' => 'The queried tunnels.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Truncated' => [
'title' => '是否截断。',
'description' => 'Indicates whether the queried results are truncated.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'* true'."\n"
.'* false'."\n",
'visibility' => 'Public',
'type' => 'boolean',
'enumValueTitles' => ['true' => 'true', 'false' => 'false'],
'example' => 'true',
],
'NextMarker' => ['title' => '下次列举通道的起点。', 'description' => 'The position from which the next list operation starts.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_marker'],
'ImportTunnel' => [
'title' => '通道列表。',
'description' => 'The queried tunnels.'."\n",
'visibility' => 'Public',
'type' => 'array',
'items' => ['description' => 'The tunnel details.'."\n", 'visibility' => 'Public', 'extendType' => 'true', '$ref' => '#/components/schemas/GetTunnelResp'],
],
],
],
'ScheduleRule' => [
'title' => '调度规则。',
'description' => 'The scheduling rule.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'StartCronExpression' => ['title' => '启动时间,Cron表达式,间隔不低于1小时。', 'description' => 'The time when the migration task started. You can use a CRON expression to specify the time. The interval at which the migration task is run is at least 1 hour.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0 0 * * * ?'],
'SuspendCronExpression' => ['title' => '暂停时间,Cron表达式,间隔不低于1小时。', 'description' => 'The time when the migration task paused. You can use a CRON expression to specify the time. The interval at which the migration task is run is at least 1 hour.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0 0 * * * ?'],
'MaxScheduleCount' => ['title' => '自动调度轮次限制,任务执行ID在轮次限制内(任务从开始到结束为一轮执行)会根据启动时间和暂停时间自动调度,超过轮次限制不再自动调度,但是依然可以手动执行。', 'description' => 'The maximum number of times that the migration task is automatically scheduled. Each time the migration task is run, the execution ID increases by one until the task is run the specified number of times. The task is automatically scheduled based on the specified start time and pause time. The task is no longer automatically scheduled after the task is run the specified number of times. However, you can still manually start the task.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
'TimeFilter' => [
'title' => '时间过滤器。',
'description' => 'The time filter.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'StartTime' => ['title' => '开始时间。', 'description' => 'The time when the migration task started.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2006-01-01T00:00:00Z'],
'EndTime' => ['title' => '结束时间。', 'description' => 'The time when the migration task ended.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '2006-12-31T59:59:59Z'],
],
],
'TunnelQos' => [
'title' => '通道限流。',
'description' => 'The throttling settings of the tunnel.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'MaxQps' => ['title' => '通道的Qps限流,取值大于等于0。默认值是0,表示不受限制。', 'description' => 'The maximum queries per second (QPS) of the tunnel.\\'."\n"
.'Valid values: values greater than or equal to 0. Default value: 0. The default value indicates that the QPS of the tunnel is not limited.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
'MaxBandwidth' => ['title' => '通道的带宽限流,单位 Byte/s。 取值:不低于10485760 (10MBps) 。默认值是0,表示不受限制。', 'description' => 'The maximum bandwidth of the tunnel. Unit: byte/s.\\'."\n"
.'Valid values: values greater than or equal to 10485760. Default value: 0. The default value indicates that the bandwidth of the tunnel is not limited.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1073741824'],
],
],
'UpdateAddressInfo' => [
'title' => '更新数据地址详情。',
'description' => 'The information about the data address.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'AgentList' => ['title' => '代理列表。', 'description' => 'The agents.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'agent1,agent2,agent3'],
],
],
'UpdateJobInfo' => [
'title' => '更新任务详情。',
'description' => 'The details of the migration job to update.',
'type' => 'object',
'properties' => [
'Status' => ['title' => '任务状态。 取值: IMPORT_JOB_LAUNCHING,启动任务; IMPORT_JOB_SUSPEND,暂停任务; IMPORT_JOB_CLOSING,关闭任务。', 'description' => 'The status of the migration job. Valid values: `IMPORT_JOB_LAUNCHING` (starts the job), `IMPORT_JOB_SUSPEND` (pauses the job), and `IMPORT_JOB_CLOSING` (stops the job).', 'type' => 'string', 'example' => 'IMPORT_JOB_LAUNCHING'],
'ImportQos' => ['title' => '任务限流。', 'description' => 'The throttling configuration of the migration job.', '$ref' => '#/components/schemas/ImportQos', 'example' => ''],
],
'example' => '',
],
'UpdateTunnelInfo' => [
'title' => '更新通道详情。',
'description' => 'The information about the tunnel.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'TunnelQos' => ['title' => '通道限流', 'description' => 'The throttling settings of the tunnel.'."\n", 'visibility' => 'Public', '$ref' => '#/components/schemas/TunnelQos'],
'Tags' => ['title' => '标签', 'description' => 'The tags.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'K1:V1,K2:V2'],
],
],
'VerifyAddressResp' => [
'title' => '校验数据地址详情。',
'description' => 'Verify the details of the data address.',
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'Status' => ['title' => '数据地址校验状态。', 'description' => 'The status of the data address verification.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'avaliable'],
'VerifyTime' => ['title' => '数据地址校验时间。', 'description' => 'The time when the data address is verified.', 'visibility' => 'Public', 'type' => 'string', 'example' => '2024-05-01T12:00:00.000Z'],
'ErrorCode' => ['title' => '数据校验错误码。', 'description' => 'Data verification error code.', 'visibility' => 'Public', 'type' => 'string', 'example' => '400'],
'ErrorMessage' => ['title' => '数据校验错误信息。', 'description' => 'Data validation error message.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'Invalid argument.'],
],
],
'VerifyResp' => [
'title' => '数据地址校验详情。',
'description' => 'The verification result of the data address.'."\n",
'visibility' => 'Public',
'type' => 'object',
'properties' => [
'HttpCode' => ['title' => 'Http Status。', 'description' => 'The HTTP status code.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '200'],
'ErrorCode' => ['title' => '校验失败的错误码。', 'description' => 'The error code.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'InvalidArgument'],
'ErrorMsg' => ['title' => '校验失败的错误信息。', 'description' => 'The error message.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Invalid argument.'],
],
],
],
],
'apis' => [
'CreateAddress' => [
'summary' => 'Creates a data address.',
'path' => '/address',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227759',
'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for creating the data address.'."\n",
'type' => 'object',
'properties' => [
'ImportAddress' => ['description' => 'The details for creating the data address.'."\n", 'required' => false, '$ref' => '#/components/schemas/CreateAddressInfo', 'title' => '', 'example' => ''],
],
'required' => false,
'title' => '',
'example' => '',
],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'CreateAddress',
'description' => '* To create a data address, you must have the permission on mgw:CreateImportAddress.'."\n"
.'* If you want to use an agent to migrate data, you must create an agent first and then associate the agent with a data address when you create the data address.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddress'],
],
],
],
'CreateAgent' => [
'summary' => 'The request boy for creating the agent.',
'path' => '/agent',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227652',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for creating the agent.',
'type' => 'object',
'properties' => [
'ImportAgent' => ['description' => 'The details for creating the agent.', 'required' => false, '$ref' => '#/components/schemas/CreateAgentInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'CreateAgent',
'description' => '* To create an agent, you must have the permission on mgw:CreateImportAgent.'."\n"
.'* If you want to migrate data to Alibaba Cloud over an Express Connect circuit or a VPN gateway, or migrate data from a self-managed storage space to Alibaba Cloud, you can deploy an agent.'."\n"
.'* Before you create an agent, you must create a tunnel. An agent must be associated with a tunnel.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgent'],
],
],
],
'CreateJob' => [
'summary' => 'Creates a migration task.',
'path' => '/job',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227788',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for creating the migration task.',
'type' => 'object',
'properties' => [
'ImportJob' => ['description' => 'The details for creating the migration task.', 'required' => true, '$ref' => '#/components/schemas/CreateJobInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'CreateJob',
'description' => '* To create a migration task, you must have the permission on mgw:CreateImportJob.'."\n"
.'* Before you create a migration task, you must create data addresses.'."\n"
.'* A migration task can run multiple rounds. Each round has an execution ID.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
],
],
],
'CreateReport' => [
'summary' => 'Creates a migration report.',
'path' => '/report',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '228203',
'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for creating the migration report.'."\n",
'type' => 'object',
'properties' => [
'CreateReport' => ['description' => 'The details for creating the migration report.'."\n", 'required' => false, '$ref' => '#/components/schemas/CreateReportInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'CreateReport',
'description' => '* To create a migration report, you must have the permission on mgw:CreateImportReport.'."\n"
.'* If you specify that a migration report is to be generated when you create a migration task, you do not need to call this operation. If you do not specify that a migration report is to be generated when you create a migration task, you can call this operation to create a migration report for an execution with the specified ID.'."\n",
'changeSet' => [],
],
'CreateTunnel' => [
'summary' => 'Creates a tunnel.',
'path' => '/tunnel',
'methods' => ['post'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '230272',
'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for creating the tunnel.'."\n",
'type' => 'object',
'properties' => [
'ImportTunnel' => ['description' => 'The details for creating the tunnel.'."\n", 'required' => false, '$ref' => '#/components/schemas/CreateTunnelInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [
'headers' => [
'x-oss-import-tunnel-id' => [
'schema' => ['title' => '', 'type' => 'string'],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'CreateTunnel',
'description' => '* To create a tunnel, you must have the permission on mgw:CreateImportTunnel.'."\n"
.'* When you use an agent to migrate data, the agent must be associated with a tunnel.'."\n"
.'* A tunnel can be associated with multiple agents. You can throttle the traffic of the agents that are associated with the same tunnel by setting the bandwidth and the number of requests per second for the tunnel.'."\n",
'responseParamsDescription' => 'If the tunnel is created, a tunnel ID is returned in the response header x-oss-import-tunnel-id.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTunnel'],
],
],
],
'DeleteAddress' => [
'summary' => 'Deletes a data address.',
'path' => '/address/{addressName}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227769',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'addressName',
'in' => 'path',
'schema' => ['description' => 'The name of the data address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'DeleteAddress',
'description' => '* To delete a data address, you must have the permission on mgw:DeleteImportAddress.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddress'],
],
],
],
'DeleteAgent' => [
'summary' => 'Deletes an agent.',
'path' => '/agent/{agentName}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227661',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'agentName',
'in' => 'path',
'schema' => ['description' => 'The agent name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'DeleteAgent',
'description' => '* To delete an agent, you must have the permission on mgw:DeleteImportAgent.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAgent'],
],
],
],
'DeleteJob' => [
'summary' => 'Deletes a migration task.',
'path' => '/job/{jobName}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227829',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'forceDelete',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'Specifies whether to force delete the subtask. If the task has subtasks and you set this parameter to true, the task and its subtasks are forcibly deleted. If this parameter is set to false, the task and its subtasks fail to be deleted.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
[
'name' => 'jobName',
'in' => 'path',
'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'DeleteJob',
'description' => '* To delete a migration task, you must have the permission on mgw:DeleteImportJob.'."\n"
.'* The operation to delete a migration task is asynchronous. The migration task remains in the Deleting state until it is deleted.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJob'],
],
],
],
'DeleteTunnel' => [
'summary' => 'Deletes a tunnel.',
'path' => '/tunnel/{tunnelId}',
'methods' => ['delete'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227642',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'tunnelId',
'in' => 'path',
'schema' => ['description' => 'The tunnel ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '0b583032-a495-452f-8c0d-692296b51bf9', 'title' => ''],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'DeleteTunnel',
'description' => '* To delete a tunnel, you must have the permission on mgw:DeleteImportTunnel.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTunnel'],
],
],
],
'GetAddress' => [
'summary' => 'Obtains the details of a data address.',
'path' => '/address/{addressName}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227766',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'addressName',
'in' => 'path',
'schema' => [
'description' => 'The name of the data address.',
'enumValueTitles' => [],
'type' => 'string',
'required' => true,
'example' => 'test_address_name',
'title' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- s:s.',
'type' => 'object',
'properties' => [
'ImportAddress' => [
'description' => 'The details for obtaining the data address.'."\n"
."\n"
.'Valid values:'."\n"
."\n"
.'- 1:1',
'enumValueTitles' => [1 => '1'],
'$ref' => '#/components/schemas/GetAddressResp',
'title' => '',
'example' => '',
],
],
'enumValueTitles' => ['s' => 's'],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'GetAddress',
'description' => '- To query the information about a data address, you must have the permission on mgw:GetImportAddress.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddress'],
],
],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAddress>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <AddressDetail>\\n <AddressType>oss</AddressType>\\n <Bucket>test_bucket</Bucket>\\n <Domain>test_domain</Domain>\\n <Prefix>test_prefix</Prefix>\\n <AccessId>test_access_id</AccessId>\\n <AccessSecret>test_secret_key</AccessSecret>\\n <Role>test_role</Role>\\n <InvDomain>test_inv_domain</InvDomain>\\n <InvBucket>test_inv_bucket</InvBucket>\\n <InvAccessId>test_inv_access_id</InvAccessId>\\n <InvAccessSecret>test_inv_secret_key</InvAccessSecret>\\n <InvPath>manifest.json</InvPath>\\n <InvRole>test_inv_role</InvRole>\\n <InvLocation>oss</InvLocation>\\n <AgentList>agent1,agent2</AgentList>\\n <RegionId>oss-cn-hangzhou</RegionId>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <DataType>oss</DataType>\\n <HdfsAuthConfig>\\n <UserName/>\\n <AuthType/>\\n </HdfsAuthConfig>\\n </AddressDetail>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <Version>test_id</Version>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Status>avaliable</Status>\\n <VerifyResult>\\n <HttpCode>200</HttpCode>\\n <ErrorCode>InvalidArgument</ErrorCode>\\n <ErrorMsg>Invalid argument.</ErrorMsg>\\n </VerifyResult>\\n</ImportAddress>","type":"xml"}]',
],
'GetAgent' => [
'summary' => 'Obtains the details of an agent.',
'path' => '/agent/{agentName}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227655',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'agentName',
'in' => 'path',
'schema' => ['description' => 'The agent name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportAgent' => ['description' => 'The details for obtaining the details of the agent.'."\n", '$ref' => '#/components/schemas/GetAgentResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgent>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <CreateTime>2024-05-01T12:00:00.000Z</CreateTime>\\n <ModifyTime>2024-05-01T12:00:00.000Z</ModifyTime>\\n <DeployMethod>default</DeployMethod>\\n <AgentEndpoint>vpc</AgentEndpoint>\\n <ActivationKey>6af62558-970d-4f44-8663-4e297170fd6a</ActivationKey>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Version>test_agent_id</Version>\\n <TunnelId>test_tunnel_id</TunnelId>\\n</ImportAgent>","type":"xml"}]',
'title' => 'GetAgent',
'description' => '* To query the information about an agent, you must have the permission on mgw:GetImportAgent.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgent'],
],
],
],
'GetAgentStatus' => [
'summary' => 'Obtains the running status of an agent.',
'path' => '/agent/{agentName}?status',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227750',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'agentName',
'in' => 'path',
'schema' => ['description' => 'The agent name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportAgentStatus' => ['description' => 'The details for obtaining the status of the agent.'."\n", '$ref' => '#/components/schemas/GetAgentStatusResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgentStatus>\\n <Status>OK</Status>\\n</ImportAgentStatus>","type":"xml"}]',
'title' => 'GetAgentStatus',
'description' => '* To query the status of an agent, you must have the permission on mgw:GetImportAgent.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatus'],
],
],
],
'GetJob' => [
'summary' => 'Obtains the details of a migration task.',
'path' => '/job/{jobName}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227824',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'byVersion',
'in' => 'query',
'allowEmptyValue' => true,
'schema' => ['description' => 'Specifies whether to obtain the details of the migration task by using the task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''],
],
[
'name' => 'jobName',
'in' => 'path',
'schema' => ['description' => 'The name of the migration task. If the byVersion parameter is set to true, this parameter indicates the ID of the migration task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportJob' => ['description' => 'The details for obtaining the details of the migration task.'."\n", '$ref' => '#/components/schemas/GetJobResp', 'title' => ''],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJob>\\n <Name>test_name</Name>\\n <SrcAddress>test_src_address</SrcAddress>\\n <DestAddress>test_dest_address</DestAddress>\\n <Status>IMPORT_JOB_DOING</Status>\\n <EnableMultiVersioning>false</EnableMultiVersioning>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Version>test_id</Version>\\n <Audit>\\n <LogMode>off</LogMode>\\n </Audit>\\n <OverwriteMode>always</OverwriteMode>\\n <TransferMode>all</TransferMode>\\n <Tags>K1:V1,K2:V2</Tags>\\n <ParentName>test_parent_name</ParentName>\\n <ParentVersion>7db93837-a5ee-4e3a-b3c8-800e7947dabc</ParentVersion>\\n <ConvertSymlinkTarget>false</ConvertSymlinkTarget>\\n <CreateReport>false</CreateReport>\\n <Owner>test_owner</Owner>\\n <FilterRule>\\n <KeyFilters>\\n <Includes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Includes>\\n <Excludes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Excludes>\\n </KeyFilters>\\n <LastModifiedFilters>\\n <Includes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Includes>\\n <Excludes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Excludes>\\n </LastModifiedFilters>\\n <FileTypeFilters>\\n <ExcludeSymlink>true</ExcludeSymlink>\\n <ExcludeDir>true</ExcludeDir>\\n </FileTypeFilters>\\n </FilterRule>\\n <ImportQos>\\n <MaxBandWidth>1073741824</MaxBandWidth>\\n <MaxImportTaskQps>1000</MaxImportTaskQps>\\n </ImportQos>\\n <ScheduleRule>\\n <StartCronExpression>0 0 * * * ?</StartCronExpression>\\n <SuspendCronExpression>0 0 * * * ?</SuspendCronExpression>\\n <MaxScheduleCount>1</MaxScheduleCount>\\n </ScheduleRule>\\n</ImportJob>","type":"xml"}]',
'title' => 'GetJob',
'description' => '* To query the information about a migration task, you must have the permission on mgw:GetImportJob.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'],
],
],
],
'GetJobResult' => [
'summary' => 'Obtains the list of files that fail to be migrated when files fail to be migrated during a migration task.',
'path' => '/job/{jobName}?jobResult',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '228198',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'jobName',
'in' => 'path',
'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'runtimeId',
'in' => 'query',
'schema' => ['description' => 'The execution ID of the task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportJobResult' => ['description' => 'The details for obtaining the retries of the migration task.'."\n", '$ref' => '#/components/schemas/GetJobResultResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJobResult>\\n <ReadyRetry>Ready</ReadyRetry>\\n <InvPath>mainfest.json</InvPath>\\n <InvBucket>test_sys_bucket</InvBucket>\\n <InvDomain>test_domain</InvDomain>\\n <InvLocation>oss</InvLocation>\\n <InvAccessId>test_access_id</InvAccessId>\\n <InvAccessSecret>test_secret_key</InvAccessSecret>\\n <InvRegionId>test_region_id</InvRegionId>\\n <AddressType>ossinv</AddressType>\\n <TotalObjectCount>1000</TotalObjectCount>\\n <CopiedObjectCount>800</CopiedObjectCount>\\n <FailedObjectCount>200</FailedObjectCount>\\n <TotalObjectSize>1000</TotalObjectSize>\\n <CopiedObjectSize>800</CopiedObjectSize>\\n <Version>test_job_id</Version>\\n</ImportJobResult>","type":"xml"}]',
'title' => 'GetJobResult',
'description' => '* To query the retry information about a migration task, you must have the permission on mgw:GetImportJobResult.'."\n"
.'* If files fail to be migrated during a migration task, a list of files that fail to be migrated is generated. You can call this operation to query this list. You can create a data address based on this list and create a subtask. This way, you can migrate these files again.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobResult'],
],
],
],
'GetReport' => [
'summary' => 'Obtains the details of a migration report.',
'path' => '/report',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '228380',
'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'version',
'in' => 'query',
'schema' => ['description' => 'The ID of the migration task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_id', 'title' => ''],
],
[
'name' => 'runtimeId',
'in' => 'query',
'schema' => ['description' => 'The execution ID of the migration task.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'GetReportResponse' => ['description' => 'The details for obtaining the migration report.'."\n", '$ref' => '#/components/schemas/GetReportResp', 'title' => ''],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<GetReportResponse>\\n <Status>Running</Status>\\n <ReportCreateTime>2024-05-01 12:00:00</ReportCreateTime>\\n <ReportEndTime>2024-05-01 12:00:00</ReportEndTime>\\n <TotalCount>1000</TotalCount>\\n <CopiedCount>800</CopiedCount>\\n <SkippedCount>100</SkippedCount>\\n <FailedCount>100</FailedCount>\\n <JobCreateTime>2024-05-01 12:00:00</JobCreateTime>\\n <JobEndTime>2024-05-01 12:00:00</JobEndTime>\\n <JobExecuteTime>1000</JobExecuteTime>\\n <TotalListPrefix>test_total_prefix/</TotalListPrefix>\\n <SkippedListPrefix>test_skipped_prefix/</SkippedListPrefix>\\n <FailedListPrefix>test_failed_prefix/</FailedListPrefix>\\n <ErrorMessage>test error msg.</ErrorMessage>\\n</GetReportResponse>","type":"xml"}]',
'title' => 'GetReport',
'description' => '* To query the information about a migration report, you must have the permission on mgw:GetImportReport.'."\n"
.'* The migration report is pushed to the destination data address. For more information, see the "View a migration report" section of the "Subsequent operations" topic in migration tutorials.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReport'],
],
],
],
'GetTunnel' => [
'summary' => 'Obtains the details of a tunnel.',
'path' => '/tunnel/{tunnelId}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227629',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'tunnelId',
'in' => 'path',
'schema' => ['description' => 'The tunnel ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '0b583032-a495-452f-8c0d-692296b51bf9', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportTunnel' => ['description' => 'The details for obtaining the details of the tunnel.'."\n", '$ref' => '#/components/schemas/GetTunnelResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportTunnel>\\n <Owner>test_owner</Owner>\\n <TunnelId>test_tunnel_id</TunnelId>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Tags>key1:value1,key2:value2</Tags>\\n <TunnelQos>\\n <MaxQps>100</MaxQps>\\n <MaxBandwidth>1073741824</MaxBandwidth>\\n </TunnelQos>\\n</ImportTunnel>","type":"xml"}]',
'title' => 'GetTunnel',
'description' => '* To query the information about a tunnel, you must have the permission on mgw:GetImportTunnel.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTunnel'],
],
],
],
'ListAddress' => [
'summary' => 'Lists the data addresses created by a user in the specific region.',
'path' => '/addresslist',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227770',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'marker',
'in' => 'query',
'schema' => ['description' => 'The marker after which the migration addresses are listed.<br>'."\n"
.'By default, this parameter is left empty.', 'type' => 'string', 'required' => false, 'example' => 'test_marker', 'title' => ''],
],
[
'name' => 'count',
'in' => 'query',
'schema' => ['description' => 'Specifies the number of migration addresses to be returned.<br>'."\n"
.'Valid values: 0 - 1000 (excluding 0).<br>'."\n"
.'Default value: 1000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'ImportAddressList' => ['description' => 'The details of migration addresses.', '$ref' => '#/components/schemas/ListAddressResp', 'title' => '', 'example' => ''],
],
'title' => '',
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'ListAddress',
'description' => '- To query a list of data addresses, you must have the permission on mgw:ListImportAddress.',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddress'],
],
],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAddressList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_marker</NextMarker>\\n <ImportAddress>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <AddressDetail>\\n <AddressType>oss</AddressType>\\n <Bucket>test_bucket</Bucket>\\n <Domain>test_domain</Domain>\\n <Prefix>test_prefix</Prefix>\\n <AccessId>test_access_id</AccessId>\\n <AccessSecret>test_secret_key</AccessSecret>\\n <Role>test_role</Role>\\n <InvDomain>test_inv_domain</InvDomain>\\n <InvBucket>test_inv_bucket</InvBucket>\\n <InvAccessId>test_inv_access_id</InvAccessId>\\n <InvAccessSecret>test_inv_secret_key</InvAccessSecret>\\n <InvPath>manifest.json</InvPath>\\n <InvRole>test_inv_role</InvRole>\\n <InvLocation>oss</InvLocation>\\n <AgentList>agent1,agent2</AgentList>\\n <RegionId>oss-cn-hangzhou</RegionId>\\n <InvRegionId>oss-cn-hangzhou</InvRegionId>\\n <DataType>oss</DataType>\\n <HdfsAuthConfig>\\n <UserName/>\\n <AuthType/>\\n </HdfsAuthConfig>\\n </AddressDetail>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <VerifyTime>2024-05-01 12:00:00</VerifyTime>\\n <Version>test_id</Version>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Status>avaliable</Status>\\n <VerifyResult>\\n <HttpCode>200</HttpCode>\\n <ErrorCode>InvalidArgument</ErrorCode>\\n <ErrorMsg>Invalid argument.</ErrorMsg>\\n </VerifyResult>\\n </ImportAddress>\\n</ImportAddressList>","type":"xml"}]',
],
'ListAgent' => [
'summary' => 'Lists the agents created by a user in the specific region.',
'path' => '/agentlist',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227670',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'marker',
'in' => 'query',
'schema' => ['description' => 'The marker after which the agents are listed.\\'."\n"
.'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_agent', 'title' => ''],
],
[
'name' => 'count',
'in' => 'query',
'schema' => ['description' => 'Specifies the number of agents to be returned.\\'."\n"
.'Valid values: 0 - 1000.\\'."\n"
.'Default value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportAgentList' => ['description' => 'The details of the agents.'."\n", '$ref' => '#/components/schemas/ListAgentResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportAgentList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_next_marker</NextMarker>\\n <ImportAgent>\\n <Owner>test_owner</Owner>\\n <Name>test_name</Name>\\n <CreateTime>2024-05-01T12:00:00.000Z</CreateTime>\\n <ModifyTime>2024-05-01T12:00:00.000Z</ModifyTime>\\n <DeployMethod>default</DeployMethod>\\n <AgentEndpoint>vpc</AgentEndpoint>\\n <ActivationKey>6af62558-970d-4f44-8663-4e297170fd6a</ActivationKey>\\n <Tags>K1:V1,K2:V2</Tags>\\n <Version>test_agent_id</Version>\\n <TunnelId>test_tunnel_id</TunnelId>\\n </ImportAgent>\\n</ImportAgentList>","type":"xml"}]',
'title' => 'ListAgent',
'description' => '* To query a list of agents, you must have the permission on mgw:ListImportAgent.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'],
],
],
],
'ListJob' => [
'summary' => 'Lists the migration tasks created by a user in the specific region.',
'path' => '/joblist',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227837',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'marker',
'in' => 'query',
'schema' => ['description' => 'The marker after which the migration tasks are listed.\\'."\n"
.'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_marker', 'title' => ''],
],
[
'name' => 'count',
'in' => 'query',
'schema' => ['description' => 'Specifies the number of migration tasks to be returned.\\'."\n"
.'Valid values: 0 - 1000 (excluding 0).\\'."\n"
.'Default value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1000', 'title' => ''],
],
[
'name' => 'parentName',
'in' => 'query',
'schema' => ['description' => 'The name of the parent task. If this parameter is specified, all subtasks of the parent task are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_parent_job_name', 'title' => ''],
],
[
'name' => 'all',
'in' => 'query',
'schema' => ['description' => 'Specifies whether to return subtasks.\\'."\n"
.'Valid values: true and false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response parameters.'."\n",
'type' => 'object',
'properties' => [
'ImportJobList' => ['description' => 'The queried migration tasks.'."\n", '$ref' => '#/components/schemas/ListJobResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportJobList>\\n <NextMarker>test_nex_marker</NextMarker>\\n <Truncated>true</Truncated>\\n <ImportJob>\\n <Name>test_name</Name>\\n <SrcAddress>test_src_address</SrcAddress>\\n <DestAddress>test_dest_address</DestAddress>\\n <Status>IMPORT_JOB_DOING</Status>\\n <EnableMultiVersioning>false</EnableMultiVersioning>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Version>test_id</Version>\\n <Audit>\\n <LogMode>off</LogMode>\\n </Audit>\\n <OverwriteMode>always</OverwriteMode>\\n <TransferMode>all</TransferMode>\\n <Tags>K1:V1,K2:V2</Tags>\\n <ParentName>test_parent_name</ParentName>\\n <ParentVersion>7db93837-a5ee-4e3a-b3c8-800e7947dabc</ParentVersion>\\n <ConvertSymlinkTarget>false</ConvertSymlinkTarget>\\n <CreateReport>false</CreateReport>\\n <Owner>test_owner</Owner>\\n <FilterRule>\\n <KeyFilters>\\n <Includes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Includes>\\n <Excludes>\\n <Regex>.*\\\\.jpg$</Regex>\\n </Excludes>\\n </KeyFilters>\\n <LastModifiedFilters>\\n <Includes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Includes>\\n <Excludes>\\n <TimeFilter>\\n <StartTime>2006-01-01T00:00:00Z</StartTime>\\n <EndTime>2006-12-31T59:59:59Z</EndTime>\\n </TimeFilter>\\n </Excludes>\\n </LastModifiedFilters>\\n <FileTypeFilters>\\n <ExcludeSymlink>true</ExcludeSymlink>\\n <ExcludeDir>true</ExcludeDir>\\n </FileTypeFilters>\\n </FilterRule>\\n <ImportQos>\\n <MaxBandWidth>1073741824</MaxBandWidth>\\n <MaxImportTaskQps>1000</MaxImportTaskQps>\\n </ImportQos>\\n <ScheduleRule>\\n <StartCronExpression>0 0 * * * ?</StartCronExpression>\\n <SuspendCronExpression>0 0 * * * ?</SuspendCronExpression>\\n <MaxScheduleCount>1</MaxScheduleCount>\\n </ScheduleRule>\\n </ImportJob>\\n</ImportJobList>","type":"xml"}]',
'title' => 'ListJob',
'description' => '* To query a list of migration tasks, you must have the permission on mgw:ListImportJob.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJob'],
],
],
],
'ListJobHistory' => [
'summary' => 'Lists the run history of a migration task.',
'path' => '/jobhistory/{jobName}',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '228201',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'jobName',
'in' => 'path',
'schema' => ['description' => 'The name of the migration task whose run history to retrieve.', 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''],
],
[
'name' => 'runtimeId',
'in' => 'query',
'schema' => ['description' => 'The execution ID of a specific run. Specify this parameter to retrieve the run history for only that execution.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'marker',
'in' => 'query',
'schema' => ['description' => 'The pagination token. Set this parameter to the marker value returned in the previous response to retrieve the next page of results. If not specified, results are returned from the beginning.', 'type' => 'string', 'required' => false, 'example' => 'test_marker', 'title' => ''],
],
[
'name' => 'count',
'in' => 'query',
'schema' => ['description' => 'The maximum number of history entries to return.<br> Valid values: 1 to 1000.<br> Default value: 1000.<br><br>', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response body.',
'type' => 'object',
'properties' => [
'JobHistoryList' => ['description' => 'The list of task run history entries.', '$ref' => '#/components/schemas/ListJobHistoryResp', 'title' => '', 'example' => ''],
],
'example' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<JobHistoryList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_next_marker</NextMarker>\\n <JobHistory>\\n <Name>test_name</Name>\\n <JobVersion>test_id</JobVersion>\\n <RuntimeId>1</RuntimeId>\\n <CommitId>2</CommitId>\\n <StartTime>2024-05-01T12:00:00.000Z</StartTime>\\n <EndTime>2024-05-01T12:00:00.000Z</EndTime>\\n <Status>IMPORT_JOB_DOING</Status>\\n <TotalCount>1000</TotalCount>\\n <CopiedCount>900</CopiedCount>\\n <FailedCount>100</FailedCount>\\n <TotalSize>1000</TotalSize>\\n <CopiedSize>1000</CopiedSize>\\n <RuntimeState>Normal</RuntimeState>\\n <Message>test error msg.</Message>\\n <Operator>user</Operator>\\n <ListStatus>Listing</ListStatus>\\n <SkippedCount>1000</SkippedCount>\\n <SkippedSize>100000</SkippedSize>\\n </JobHistory>\\n</JobHistoryList>","type":"xml"}]',
'title' => 'ListJobHistory',
'description' => '- Call this operation to retrieve the run history of a specified migration task. A migration task can have multiple runs, each identified by a unique execution ID. The run history records status changes that occur during each execution.'."\n"
."\n"
.'- Required permission: mgw:ListImportJobHistory',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobHistory'],
],
],
],
'ListTunnel' => [
'summary' => 'Lists tunnels.',
'path' => '/tunnellist',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227644',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'marker',
'in' => 'query',
'schema' => ['description' => 'The marker after which tunnels are listed.\\'."\n"
.'By default, this parameter is left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''],
],
[
'name' => 'count',
'in' => 'query',
'schema' => ['description' => 'Specifies the number of tunnels to be returned.\\'."\n"
.'Valid values: 0 - 1000.\\'."\n"
.'Default value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'ImportTunnelList' => ['description' => 'The details of the tunnels.'."\n", '$ref' => '#/components/schemas/ListTunnelResp', 'title' => ''],
],
'title' => '',
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<ImportTunnelList>\\n <Truncated>true</Truncated>\\n <NextMarker>test_marker</NextMarker>\\n <ImportTunnel>\\n <Owner>test_owner</Owner>\\n <TunnelId>test_tunnel_id</TunnelId>\\n <CreateTime>2024-05-01 12:00:00</CreateTime>\\n <ModifyTime>2024-05-01 12:00:00</ModifyTime>\\n <Tags>key1:value1,key2:value2</Tags>\\n <TunnelQos>\\n <MaxQps>100</MaxQps>\\n <MaxBandwidth>1073741824</MaxBandwidth>\\n </TunnelQos>\\n </ImportTunnel>\\n</ImportTunnelList>","type":"xml"}]',
'title' => 'ListTunnel',
'description' => '* To query a list of tunnels, you must have the permission on mgw:ListImportTunnel.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTunnel'],
],
],
],
'UpdateAddress' => [
'summary' => 'Updates a data address.',
'path' => '/address/{addressName}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '232066',
'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'addressName',
'in' => 'path',
'schema' => ['description' => 'The name of the data address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_address_name', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for updating the data address.'."\n",
'type' => 'object',
'properties' => [
'ImportAddress' => ['description' => 'The details for updating the data address.'."\n", 'required' => false, '$ref' => '#/components/schemas/UpdateAddressInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'UpdateAddress',
'description' => '* To update a data address, you must have the permission on mgw:UpdateImportAddress.'."\n"
.'* If the data address is associated with an agent, you can scale up or down the agent.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddress'],
],
],
],
'UpdateJob' => [
'summary' => 'Updates the status or throttling of a task.',
'path' => '/job/{jobName}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227839',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
],
'parameters' => [
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for updating the task.'."\n",
'type' => 'object',
'properties' => [
'ImportJob' => ['description' => 'The details for updating the task.'."\n", 'required' => false, '$ref' => '#/components/schemas/UpdateJobInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
[
'name' => 'jobName',
'in' => 'path',
'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_job_name', 'title' => ''],
],
],
'responses' => [],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'UpdateJob',
'description' => '* To update a migration task, you must have the permission on mgw:UpdateImportJob.'."\n"
.'* You can update only the status or throttling settings of a task in a single request.'."\n",
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateJob'],
],
],
],
'UpdateTunnel' => [
'summary' => 'Updates a tunnel.',
'path' => '/tunnel/{tunnelId}',
'methods' => ['put'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227625',
'abilityTreeNodes' => ['FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgwXWJG7U', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18'],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'tunnelId',
'in' => 'path',
'schema' => ['description' => 'The tunnel ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''],
],
[
'name' => 'body',
'in' => 'body',
'style' => 'xml',
'schema' => [
'description' => 'The request body for updating the tunnel.'."\n",
'type' => 'object',
'properties' => [
'ImportTunnel' => ['description' => 'The details for updating the tunnel.'."\n", 'required' => false, '$ref' => '#/components/schemas/UpdateTunnelInfo', 'title' => ''],
],
'required' => false,
'title' => '',
],
],
],
'responses' => [
200 => [],
],
'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<root/>","type":"xml"}]',
'title' => 'UpdateTunnel',
'description' => '* To update a tunnel, you must have the permission on mgw:UpdateImportTunnel.'."\n",
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTunnel'],
],
],
],
'VerifyAddress' => [
'summary' => 'Verifies whether a data address is available.',
'path' => '/address/{addressName}?verify',
'methods' => ['get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'consumes' => ['application/xml'],
'produces' => ['application/xml'],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '227775',
'abilityTreeNodes' => ['FEATUREhcs_mgwI6FP9O', 'FEATUREhcs_mgwYHC96G', 'FEATUREhcs_mgw6RQIAN', 'FEATUREhcs_mgw3H53CV', 'FEATUREhcs_mgw3ZWPXE', 'FEATUREhcs_mgwXQ9G18', 'FEATUREhcs_mgwBC9F99', 'FEATUREhcs_mgw6BJDT2', 'FEATUREhcs_mgwXWJG7U'],
],
'parameters' => [
[
'name' => 'addressName',
'in' => 'path',
'schema' => ['description' => 'The name of the data address.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_address_name', 'title' => ''],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
'description' => 'The response body.'."\n",
'type' => 'object',
'properties' => [
'VerifyAddressResponse' => ['description' => 'The details for verifying the data address.'."\n", '$ref' => '#/components/schemas/VerifyAddressResp', 'title' => ''],
],
],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'VerifyAddress',
'description' => '* To verify a data address, you must have the permission on mgw:VerifyImportAddress.'."\n"
.'* A data address may not be available even if the data address passes the availability verification. The data migration results prevail.'."\n",
'changeSet' => [],
'responseDemo' => '[{"errorExample":"","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" standalone=\\"yes\\"?>\\n<VerifyAddressResponse>\\n <Status>avaliable</Status>\\n <VerifyTime>2024-05-01T12:00:00.000Z</VerifyTime>\\n <ErrorCode>400</ErrorCode>\\n <ErrorMessage>Invalid argument.</ErrorMessage>\\n</VerifyAddressResponse>","type":"xml"}]',
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyAddress'],
],
],
],
],
'endpoints' => [
['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-northeast-1.mgw.aliyuncs.com', 'endpoint' => 'ap-northeast-1.mgw.aliyuncs.com', 'vpc' => 'ap-northeast-1.mgw-internal.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'ap-southeast-1.mgw.aliyuncs.com', 'endpoint' => 'ap-southeast-1.mgw.aliyuncs.com', 'vpc' => 'ap-southeast-1.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-beijing.mgw.aliyuncs.com', 'endpoint' => 'cn-beijing.mgw.aliyuncs.com', 'vpc' => 'cn-beijing.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-chengdu.mgw.aliyuncs.com', 'endpoint' => 'cn-chengdu.mgw.aliyuncs.com', 'vpc' => 'cn-chengdu.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hangzhou.mgw.aliyuncs.com', 'endpoint' => 'cn-hangzhou.mgw.aliyuncs.com', 'vpc' => 'cn-hangzhou.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-hongkong.mgw.aliyuncs.com', 'endpoint' => 'cn-hongkong.mgw.aliyuncs.com', 'vpc' => 'cn-hongkong.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shanghai.mgw.aliyuncs.com', 'endpoint' => 'cn-shanghai.mgw.aliyuncs.com', 'vpc' => 'cn-shanghai.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-shenzhen.mgw.aliyuncs.com', 'endpoint' => 'cn-shenzhen.mgw.aliyuncs.com', 'vpc' => 'cn-shenzhen.mgw-internal.aliyuncs.com'],
['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cn-wulanchabu.mgw.aliyuncs.com', 'endpoint' => 'cn-wulanchabu.mgw.aliyuncs.com', 'vpc' => 'cn-wulanchabu.mgw-internal.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'us-east-1.mgw.aliyuncs.com', 'endpoint' => 'us-east-1.mgw.aliyuncs.com', 'vpc' => 'us-east-1.mgw-internal.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'eu-central-1.mgw.aliyuncs.com', 'endpoint' => 'eu-central-1.mgw.aliyuncs.com', 'vpc' => 'eu-central-1.mgw-internal.aliyuncs.com'],
],
'errorCodes' => [
['code' => 'ApiAccessDeniedError', 'message' => 'This version of the online migration service is no longer supported since 2025-01-10 00:00:00 CST, please use our new service.', 'http_code' => 403, 'description' => 'The old version of the online migration service will be officially offline on January 10, 2025. Please go to the new version of the console to use.'],
['code' => 'ImportAddressAlreadyExist', 'message' => 'The specified import address already exist.', 'http_code' => 409, 'description' => 'Data address with the same name already exists.'],
['code' => 'ImportAddressIsOccupied', 'message' => 'The import address is occupied by import job.', 'http_code' => 409, 'description' => 'The data address is in use.'],
['code' => 'ImportAddressNumExceed', 'message' => 'Import address num exceeded.', 'http_code' => 400, 'description' => 'The number of data addresses exceeds the limit.'],
['code' => 'ImportAddressTypeInvalid', 'message' => 'Src or dest import address type is invalid.', 'http_code' => 400, 'description' => 'Illegal type of source or destination address.'],
['code' => 'ImportAgentAlreadyExist', 'message' => 'The specified import agent already exist.', 'http_code' => 409, 'description' => 'An agent with the same name already exists.'],
['code' => 'ImportAgentIsOccupied', 'message' => 'The import agent is occupied by import address.', 'http_code' => 409, 'description' => 'The agent is being used.'],
['code' => 'ImportAgentNumExceed', 'message' => 'Import agent num exceeded.', 'http_code' => 400, 'description' => 'The number of agents exceeds the limit.'],
['code' => 'ImportJobAlreadyExist', 'message' => 'The specified import job already exist.', 'http_code' => 409, 'description' => 'A task with the same name already exists.'],
['code' => 'ImportJobConcurrencyExceed', 'message' => 'Concurrency running job exceed limit.', 'http_code' => 400, 'description' => 'The number of concurrent tasks exceeds the upper limit.'],
['code' => 'ImportJobConflictOnUpdateStatus', 'message' => 'Update import job status conflict.', 'http_code' => 409, 'description' => 'Concurrent update task status conflict.'],
['code' => 'ImportJobHasDescendants', 'message' => 'The job has descendants.', 'http_code' => 409, 'description' => 'There are subtasks for this task.'],
['code' => 'ImportJobInDeleting', 'message' => 'Import job is in deleting.', 'http_code' => 409, 'description' => 'Task is being deleted.'],
['code' => 'ImportJobNumExceed', 'message' => 'Import job num exceeded.', 'http_code' => 400, 'description' => 'The number of tasks exceeds the limit.'],
['code' => 'ImportJobRepeatedOnSameAddress', 'message' => 'Already has job on the same srcAddress and destAddress.', 'http_code' => 409, 'description' => 'A task with the same origin and destination address already exists.'],
['code' => 'ImportJobUpdateConcurrently', 'message' => 'There is other request update the job concurrently.', 'http_code' => 409, 'description' => 'Concurrent update task status conflict.'],
['code' => 'ImportTunnelIsOccupied', 'message' => 'The import tunnel is occupied by import agent.', 'http_code' => 400, 'description' => 'The channel is being used.'],
['code' => 'InternalError', 'message' => 'Internal server error.', 'http_code' => 500, 'description' => 'Internal server error.'],
['code' => 'InvalidImportJobStatus', 'message' => 'The specified import job status is invalid.', 'http_code' => 400, 'description' => 'Illegal task status.'],
['code' => 'MissingArgument', 'message' => 'Missing argument.', 'http_code' => 400, 'description' => 'Required parameters are missing.'],
['code' => 'NoSuchImportAddress', 'message' => 'The specified import address does not exist.', 'http_code' => 404, 'description' => 'The data address does not exist.'],
['code' => 'NoSuchImportAgent', 'message' => 'The specified import agent does not exist.', 'http_code' => 404, 'description' => 'Agent does not exist.'],
['code' => 'NoSuchImportJob', 'message' => 'The specified import job does not exist.', 'http_code' => 404, 'description' => 'The task does not exist.'],
['code' => 'NoSuchImportJobParent', 'message' => 'The specified import job\'s parent does not exist.', 'http_code' => 404, 'description' => 'The parent task does not exist.'],
['code' => 'NoSuchImportJobRunTimeId', 'message' => 'The specified import job runtime id not exist.', 'http_code' => 404, 'description' => 'The specified task execution ID does not exist.'],
['code' => 'QpsLimitExceeded', 'message' => 'Qps limit for the operation is exceeded.', 'http_code' => 503, 'description' => 'Request frequency exceeds limit.'],
],
'changeSet' => [],
'flowControl' => [
'flowControlList' => [
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJob'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJob'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'VerifyAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgent'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTunnel'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatus'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateJob'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAgent'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateJob'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetReport'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTunnel'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteJob'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetJobResult'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListJobHistory'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAgent'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAgent'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddress'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTunnel'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTunnel'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTunnel'],
['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateReport'],
],
],
];
|