1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
|
<?php return [
'version' => '1.0',
'info' => ['style' => 'RPC', 'product' => 'Dbs', 'version' => '2021-01-01'],
'directories' => [
[
'children' => ['DescribeDownloadBackupSetStorageInfo', 'DescribeDownloadSupport', 'CreateDownload', 'DescribeDownloadTask', 'RetryDownloadTask'],
'type' => 'directory',
'title' => '高级下载',
'id' => 47065,
],
[
'children' => ['DescribeBackupDataList', 'CreateAdvancedPolicy', 'DeleteSandboxInstance', 'DescribeSandboxRecoveryTime', 'DescribeSandboxInstances', 'DescribeSandboxBackupSets', 'DescribeCostInfoByDbsInstance', 'ChangeResourceGroup', 'DescribeBackupPolicy', 'ModifyBackupPolicy'],
'type' => 'directory',
'title' => '其他',
'id' => 47070,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'ChangeResourceGroup' => [
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => ['description' => '资源ID。 ', 'type' => 'string', 'required' => true, 'example' => 'dbs1jyajqk******'],
],
[
'name' => 'NewResourceGroupId',
'in' => 'query',
'schema' => ['description' => '要替换的新的资源组ID。', 'type' => 'string', 'required' => true, 'example' => 'rg-aekz4kee6******'],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => ['description' => '资源类型,固定为backupplan。', 'type' => 'string', 'required' => true, 'example' => 'backupplan'],
],
[
'name' => 'ClientToken',
'in' => 'query',
'schema' => ['description' => '用于保证请求的幂等性,防止重复提交请求。', 'type' => 'string', 'required' => false, 'example' => 'dbs'],
],
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '是否转组成功,返回值如下:'."\n"
."\n"
.'- **true**:成功'."\n"
.'- **false**:失败', 'type' => 'string', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '04EBD9F5-F06F-5302-8499-005C72*******'],
'ErrCode' => ['description' => '调用出错时返回的错误码。', 'type' => 'string', 'example' => 'Request.Forbidden'],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功'."\n"
.'- **false**:请求失败', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '调用错误时返回的错误信息。'."\n", 'type' => 'string', 'example' => 'RAM DENY'],
'Code' => ['description' => '接口状态码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Message' => ['description' => '附加信息', 'type' => 'string', 'example' => 'The resource group is forbidden to operate'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => 'DBS资源转组API',
'summary' => '资源转组。',
'changeSet' => [
['createdAt' => '2023-12-22T02:05:16.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"04EBD9F5-F06F-5302-8499-005C72*******\\",\\n \\"ErrCode\\": \\"Request.Forbidden\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"RAM DENY\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The resource group is forbidden to operate\\"\\n}","type":"json"}]',
],
'CreateAdvancedPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '221987',
'abilityTreeNodes' => ['FEATUREcbsXXHSAX'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['title' => '地域', 'description' => '备份集所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['title' => '实例名', 'description' => 'PolarDB实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze3nrr64c5****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数详情。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1EFBAC73-4A72-5AD0-BE27-932491FCB848'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'instanceName can not be empty.'],
'Data' => ['description' => '高级备份策略是否生效,返回值如下:'."\n"
."\n"
.'- **true**:生效'."\n"
.'- **false**:未生效', 'type' => 'boolean', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. '],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
'Success' => ['description' => '是否执行成功。返回值:'."\n"
.'- true:执行成功'."\n"
.'- false:执行失败', 'type' => 'string', 'example' => 'true'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '开启高级备份策略',
'summary' => '为PolarDB实例开启高级备份策略。',
'description' => '### 适用引擎'."\n"
.'PolarDB MySQL版'."\n"
."\n"
.'> 当前该接口仅针对特定客户开放使用,如有需求,请到DBS客户咨询群(钉钉群号:35585947)申请使用。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dbs:CreateAdvancedPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1EFBAC73-4A72-5AD0-BE27-932491FCB848\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": true,\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]',
],
'CreateDownload' => [
'summary' => '创建高级下载任务。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '119762',
'abilityTreeNodes' => ['FEATUREcbs04Q4EK'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID,您可调用[DescribeDBInstanceAttribute(RDS实例)](~~26231~~)或[DescribeDBClusterAttribute(PolarDB实例)](~~2319132~~)查询。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-wz994c1t1****'],
],
[
'name' => 'BakSetType',
'in' => 'query',
'schema' => ['description' => '下载任务类型,取值如下:'."\n"
."\n"
.'- **full**:全量备份集下载。'."\n"
.'- **pitr**:任意时间点下载。', 'type' => 'string', 'required' => false, 'example' => 'full'],
],
[
'name' => 'BakSetId',
'in' => 'query',
'schema' => ['description' => '备份集ID,您可调用[DescribeBackups(RDS实例)](~~26273~~)或[DescribeBackups(PolarDB实例)](~~2319224~~)接口获取该参数值。'."\n"
."\n"
.'> 当BakSetType=full时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '146005****'],
],
[
'name' => 'DownloadPointInTime',
'in' => 'query',
'schema' => ['description' => '下载任意时间点。Long类型时间戳形式,单位为毫秒(ms)。'."\n"
."\n"
.'> 当BakSetType=pitr时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => '1661331864000'],
],
[
'name' => 'BakSetSize',
'in' => 'query',
'schema' => ['description' => '全量备份集大小,您可调用[DescribeBackups(RDS实例)](~~26273~~)或[DescribeBackups(PolarDB实例)](~~2319224~~)接口查询,单位为字节(Byte)。', 'type' => 'string', 'required' => false, 'example' => '216****'],
],
[
'name' => 'FormatType',
'in' => 'query',
'schema' => [
'description' => '下载转换的目标格式,取值如下:'."\n"
."\n"
.'- **CSV**'."\n"
.'- **SQL**'."\n"
.'- **Parquet**'."\n"
.'- **Bson**'."\n"
.'- **qp.xb**'."\n"
."\n"
.'> 该参数为必填项。其中,Bson格式当且仅当实例类型为MongoDB时才能进行选择;qp.xb格式当且仅当实例类型为RDS MySQL时才能进行选择。',
'type' => 'string',
'required' => false,
'enumValueTitles' => ['qp.xb' => 'qp.xb', 'csv' => 'csv', 'bson' => 'bson', 'csv-with-header' => 'csv-with-header', 'parquet' => 'parquet', 'sql' => 'sql'],
'example' => 'CSV',
],
],
[
'name' => 'TargetType',
'in' => 'query',
'schema' => ['description' => '下载目标类型,取值如下:'."\n"
."\n"
.'- **OSS**'."\n"
.'- **URL**', 'type' => 'string', 'required' => false, 'example' => 'OSS'],
],
[
'name' => 'TargetBucket',
'in' => 'query',
'schema' => ['description' => 'OSS Bucket名称。'."\n"
."\n"
.'- 当TargetType=OSS时,该参数必填。'."\n"
.'- 请确认您的账号已拥有**AliyunDBSDefaultRole**权限,如何授权,请参见[RAM资源授权](~~26307~~)。您也可访问控制台根据操作指引去授权。', 'type' => 'string', 'required' => false, 'example' => 'test123'],
],
[
'name' => 'TargetPath',
'in' => 'query',
'schema' => ['description' => '数据下载目标路径。'."\n"
."\n"
.'> 当TargetType=OSS时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'test_db/path'],
],
[
'name' => 'TargetOssRegion',
'in' => 'query',
'schema' => ['description' => 'OSS Bucket所在地域。'."\n"
."\n"
.'> 当TargetType=OSS时,该参数必填。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'PrimaryKeyTypeOnly',
'in' => 'query',
'schema' => ['description' => '仅MongoDB引擎需要填写该字段。用于标识库表中主键类型是否唯一。'."\n"
.'是: true; 否: false。', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
[
'name' => 'IsCluster',
'in' => 'query',
'schema' => ['description' => '仅MongoDB引擎需要填写该字段。用于标识当前实例是否为分片集群。'."\n"
.'类型为MongoDB分片集群: true; 类型为其他: false。', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
[
'name' => 'AdminDatabase',
'in' => 'query',
'schema' => ['description' => '仅MongoDB引擎需要填写该字段。用于标识鉴权库名称。默认名称为admin。', 'type' => 'string', 'required' => false, 'example' => 'admin'],
],
[
'name' => 'UseZstd',
'in' => 'query',
'schema' => ['description' => '用于标识压缩包采纳的压缩算法是否为zstd。默认为false。', 'type' => 'string', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['description' => '仅MongoDB引擎分片集群需要填写该字段。分片集群ID。', 'type' => 'string', 'required' => false, 'example' => 'dds-0xid8e5336******'],
],
[
'name' => 'IsPhysical',
'in' => 'query',
'schema' => ['description' => '仅当您的实例类型为RDS MySQL且需要下载qp.xb格式时,该参数才必填。您需要指定该参数为true。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回值如下。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A08F908D-2C35-583F-93C1-ED80753F****'],
'ErrCode' => ['description' => '错误码。'."\n", 'type' => 'string', 'example' => 'DBS.ParamIsInValid'],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功。'."\n"
.'- **false**:请求失败。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'formatType can not be empty'],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'DBS.ParamIsInValid'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'formatType can not be empty'],
'Data' => [
'description' => '返回数据如下。',
'type' => 'object',
'properties' => [
'BakSetId' => ['description' => '全量备份集ID。', 'type' => 'string', 'example' => '146005****'],
'DownloadStatus' => ['description' => '下载任务的状态,返回值如下:'."\n"
."\n"
.'- initializing:初始化。'."\n"
.'- queueing:排队中。'."\n"
.'- running:下载中。'."\n"
.'- failed:下载失败。'."\n"
.'- finished:下载成功。'."\n"
.'- expired:下载过期。'."\n"
."\n"
.'> 下载目标为URL的任务完成3天后会过期。', 'type' => 'string', 'example' => 'initializing'],
'Progress' => ['description' => '已下载表数量/表总数。'."\n"
."\n"
.'> 如果任务当前处理准备阶段,该进度返回为0/0。', 'type' => 'string', 'example' => '0/0'],
'BackupSetTime' => ['description' => '任意时间点下载任务时所对应的时间点,返回格式为时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'example' => '1661373070000'],
'RegionCode' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'],
'TargetPath' => ['description' => '数据下载目标路径。'."\n"
."\n"
.'> 当**TargetType=OSS**时,该参数返回。', 'type' => 'string', 'example' => 'test_db/path'],
'DbList' => ['description' => '当下载任务为库表过滤任务时,该字段返回对应库表信息。', 'type' => 'string', 'example' => 'testdb'],
'ExportDataSize' => ['description' => '导出数据量,单位为字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'ImportDataSize' => ['description' => '处理数据量,单位为字节(Byte)。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
'GmtCreate' => ['description' => '任务创建时间,返回格式为时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'example' => '1661940917570'],
'TaskId' => ['description' => '下载任务ID。', 'type' => 'string', 'example' => 'dt-qxnsfq5s****'],
'Format' => ['description' => '目标转换格式。', 'type' => 'string', 'example' => 'CSV'],
'TargetType' => ['description' => '下载目标类型。', 'type' => 'string', 'example' => 'URL'],
],
],
],
],
],
],
'errorCodes' => [
200 => [
['errorCode' => 'DBS.DownloadTask.CannotFind', 'errorMessage' => 'Can not find download task.', 'description' => '无法找到高级下载任务。'],
['errorCode' => 'DBS.DownloadTask.JobAlreadyExist', 'errorMessage' => 'Job already submit in recent days, please check it.', 'description' => '相同备份集的高级下载任务在近几天被提交过,请检查。'],
['errorCode' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', 'errorMessage' => 'There can be only one running or failed task for the instance.', 'description' => '当前实例只能同时存在一个运行中/失败的任务。'],
['errorCode' => 'DBS.DownloadTask.OssForbid', 'errorMessage' => 'OSS is forbidden to access. Please check your OSS bucket.', 'description' => '访问OSS被拒绝。请检查您的OSS权限配置。'],
['errorCode' => 'DBS.DownloadTask.OssStorageTypeInvalid', 'errorMessage' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', 'description' => '当前OSS bucket类型不支持。请确保您的OSS bucket类型是标准存储类型。'],
['errorCode' => 'Forbidden.InstanceNotFound', 'errorMessage' => 'instance not found', 'description' => '实例不存在'],
['errorCode' => 'DBS.DownloadTask.BakSetError', 'errorMessage' => 'DBS download task bak set error. Your backup set does not meet the requirements.', 'description' => '您选择的备份集不满足高级下载要求。'],
['errorCode' => 'DBS.DownloadTask.CustinIdNotSupport', 'errorMessage' => 'DBS DownloadTask CustinIdNotSupport.', 'description' => '高级下载实例暂不支持下载'],
['errorCode' => 'DBS.DownloadTask.CustinNameNotSupport', 'errorMessage' => 'DBS DownloadTask CustinNameNotSupport.', 'description' => '高级下载实例暂不支持下载。'],
['errorCode' => 'DBS.DownloadTask.DbTypeNotSupport', 'errorMessage' => 'DBS DownloadTask DbTypeNotSupport.', 'description' => '高级下载引擎类型暂不支持'],
['errorCode' => 'DBS.DownloadTask.InstanceInfoNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceInfoNotSupport.', 'description' => '高级下载当前实例不支持下载'],
['errorCode' => 'DBS.DownloadTask.InstanceParamNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceParamNotSupport.', 'description' => '高级下载实例暂不支持下载。'],
['errorCode' => 'DBS.DownloadTask.InstanceStorageTypeNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceStorageTypeNotSupport.', 'description' => '高级下载实例存储类型暂不支持下载。'],
['errorCode' => 'DBS.DownloadTask.InstanceVersionNotSupport', 'errorMessage' => 'DBS DownloadTask InstanceVersionNotSupport.', 'description' => '高级下载引擎版本暂不支持下载。'],
['errorCode' => 'DBS.DownloadTask.NotSupport', 'errorMessage' => 'DBS DownloadTask NotSupport.', 'description' => '高级下载暂不支持下载。'],
['errorCode' => 'DBS.DownloadTask.RegionNotSupport', 'errorMessage' => 'DBS DownloadTask RegionNotSupport.', 'description' => '高级下载地域暂不支持'],
['errorCode' => 'DBS.DownloadTask.UserNotSupport', 'errorMessage' => 'DBS DownloadTask UserNotSupport.', 'description' => '高级下载用户暂不支持下载'],
],
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
['errorCode' => 'DBS.NoPermissionException', 'errorMessage' => 'Rejected by ValidationChecker.', 'description' => 'Rejected by ValidationChecker.'],
],
[
['errorCode' => 'DBS.NotExists', 'errorMessage' => 'data source do not existed.', 'description' => 'DBS.NotExists'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A08F908D-2C35-583F-93C1-ED80753F****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"formatType can not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"formatType can not be empty\\",\\n \\"Data\\": {\\n \\"BakSetId\\": \\"146005****\\",\\n \\"DownloadStatus\\": \\"initializing\\",\\n \\"Progress\\": \\"0/0\\",\\n \\"BackupSetTime\\": 1661373070000,\\n \\"RegionCode\\": \\"cn-beijing\\",\\n \\"TargetPath\\": \\"test_db/path\\",\\n \\"DbList\\": \\"testdb\\",\\n \\"ExportDataSize\\": 0,\\n \\"ImportDataSize\\": 0,\\n \\"GmtCreate\\": 1661940917570,\\n \\"TaskId\\": \\"dt-qxnsfq5s****\\",\\n \\"Format\\": \\"CSV\\",\\n \\"TargetType\\": \\"URL\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateDownloadResponse>\\n <RequestId>A08F908D-2C35-583F-93C1-ED80753F****</RequestId>\\n <Data>\\n <Progress>0/0</Progress>\\n <BackupSetTime>1661373070000</BackupSetTime>\\n <TaskId>dt-qxnsfq5s****</TaskId>\\n <RegionCode>cn-beijing</RegionCode>\\n <ImportDataSize>0</ImportDataSize>\\n <BakSetId>146005****</BakSetId>\\n <GmtCreate>1661940917570</GmtCreate>\\n <Format>csv</Format>\\n <DownloadStatus>initializing</DownloadStatus>\\n <ExportDataSize>0</ExportDataSize>\\n <TargetType>URL</TargetType>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <ErrCode>Success</ErrCode>\\n</CreateDownloadResponse>","errorExample":""}]',
'title' => '创建下载任务',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL(云盘系列)'."\n"
.'- RDS PostgreSQL'."\n"
.'- PolarDB MySQL版'."\n"
.'- MongoDB'."\n"
."\n"
.'### 相关功能文档'."\n"
.'对于符合条件的实例,您可以按任意时间点或按指定备份集创建高级下载任务,并支持选择下载目标为URL或直接将数据写入您的OSS中,后续方便您进行数据分析以及离线归档。'."\n"
.'- [RDS MySQL下载备份](~~98819~~)'."\n"
.'- [RDS PostgreSQL下载备份](~~96774~~)'."\n"
.'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n"
.'- [MongoDB下载备份](~~55011~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'create',
'ramAction' => [
'action' => 'dbs:CreateDownload',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DeleteSandboxInstance' => [
'summary' => '删除沙箱实例。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => ['operationType' => 'delete'],
'parameters' => [
[
'name' => 'BackupPlanId',
'in' => 'query',
'schema' => ['description' => '备份计划ID。'."\n"
.'> 若您的实例为RDS MySQL,请通过[自动添加数据源](~~193091~~)功能,将RDS自动添加至DBS中,即可获取备份计划ID。', 'type' => 'string', 'required' => true, 'example' => '1hxxxx8xxxxxa'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '沙箱实例ID。', 'type' => 'string', 'required' => true, 'example' => '1jxxxxnxxx1xc'],
],
[
'name' => 'ZoneId',
'in' => 'query',
'schema' => ['description' => '目标沙箱实例的可用区ID,该可用区ID需要是PrivateLink服务支持的可用区ID。可通过[DescribeZones](~~469326~~)接口查询指定地域中可用区的列表。'."\n"
."\n"
.'> 使用沙箱功能前需要先开通[PrivateLink](~~459882~~)服务,可通过[OpenPrivateLinkService](~~469322~~)接口开通私网连接服务。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-b'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '报错信息。', 'type' => 'string', 'example' => 'operation forbidden due to sandbox is creating.'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Success' => ['description' => '是否请求成功。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'title' => '释放沙箱实例',
'description' => '当前接口仅支持DBS API服务2021-01-01版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' | 错误码 | 报错消息 | 可能原因 |'."\n"
.'| --------------------------- | ---------------------------------------------- | ------------------------------------------------------------ |'."\n"
.'| Operation.DeniedByJobStatus | operation forbidden due to sandbox is creating | 无法释放正在创建中的沙箱实例。请在沙箱实例处于运行中时,再进行删除。 |',
'changeSet' => [
['createdAt' => '2023-08-18T09:25:36.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'delete',
'ramAction' => [
'action' => 'dbs:DeleteSandboxInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"operation forbidden due to sandbox is creating.\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>41F0B1A5-A615-5C2E-AC01-D511F040D421</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n<ErrCode>Success</ErrCode>","errorExample":""}]',
],
'DescribeBackupDataList' => [
'summary' => '查询PolarDB MySQL版备份数据详情。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '171434',
'abilityTreeNodes' => ['FEATUREcbsUOJI4N'],
],
'parameters' => [
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['title' => '实例名称', 'description' => 'PolarDB实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze3nrr64c5******'],
],
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['title' => '地域', 'description' => '备份集所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'SceneType',
'in' => 'query',
'schema' => ['title' => '场景类型', 'description' => '备份场景类型,当前仅支持**LEVEL_1**,即实例所在地域的一级备份。', 'type' => 'string', 'required' => false, 'example' => 'LEVEL_1'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['title' => '查询开始时间,格式:yyyy-MM-ddTHH:mmZ', 'description' => '查询开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'required' => false, 'example' => '2024-04-17T17:00:16Z'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['title' => '查询结束时间,格式:yyyy-MM-ddTHH:mmZ', 'description' => '查询结束时间,需要大于查询开始时间。格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'required' => false, 'example' => '2024-04-17T17:00:32Z'],
],
[
'name' => 'BackupStatus',
'in' => 'query',
'schema' => ['title' => '备份集状态,OK-备份成功;ERROR-备份失败;', 'description' => '备份集状态,取值如下:'."\n"
."\n"
.'- **OK**:备份成功'."\n"
.'- **ERROR**:备份失败', 'type' => 'string', 'required' => false, 'example' => 'OK'],
],
[
'name' => 'BackupId',
'in' => 'query',
'schema' => ['title' => '备份集ID', 'description' => '备份集ID。', 'type' => 'string', 'required' => false, 'example' => '213064****'],
],
[
'name' => 'BackupMethod',
'in' => 'query',
'schema' => ['title' => '备份方法:Physical-物理备份;Logical-逻辑备份;Snapshot-快照备份;', 'description' => '备份方式,取值如下:'."\n"
."\n"
.'- **Physical**:物理备份'."\n"
.'- **Logical**:逻辑备份'."\n"
.'- **Snapshot**:快照备份', 'type' => 'string', 'required' => false, 'example' => 'Snapshot'],
],
[
'name' => 'BackupMode',
'in' => 'query',
'schema' => ['title' => '备份模式:Automated-自动备份;Manual-手动备份;', 'description' => '备份模式,取值如下:'."\n"
."\n"
.'- **Automated**:系统自动备份'."\n"
.'- **Manual**:手动备份', 'type' => 'string', 'required' => false, 'example' => 'Automated'],
],
[
'name' => 'BackupType',
'in' => 'query',
'schema' => ['title' => '备份类型:FullBackup-全量备份;IncrementBackup-增量备份;', 'description' => '备份类型,取值如下:'."\n"
."\n"
.'- **FullBackup**:全量备份'."\n"
.'- **IncrementBackup**:增量备份', 'type' => 'string', 'required' => false, 'example' => 'FullBackup'],
],
[
'name' => 'BackupScale',
'in' => 'query',
'schema' => ['title' => '备份规格:DBInstance-实例备份;DBTable-库表备份;', 'description' => '备份规格,取值如下:'."\n"
."\n"
.'- **DBInstance**:实例备份'."\n"
.'- **DBTable**:库表备份', 'type' => 'string', 'required' => false, 'example' => 'DBInstance'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['title' => '分页每页大小,默认为20', 'description' => '每页记录数,默认值为20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['title' => '分页页码,从1开始,默认为1', 'description' => '页码,取值范围为大于0但不超过Integer最大值的整数,默认值为1。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'InstanceIsDeleted',
'in' => 'query',
'schema' => ['title' => '实例是否已删除', 'description' => '实例是否已删除,取值如下:'."\n"
."\n"
.'- **true**:已删除'."\n"
.'- **false**:未删除(默认值)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'InstanceRegion',
'in' => 'query',
'schema' => ['title' => '实例原地域', 'description' => '原实例所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'DataSourceId',
'in' => 'query',
'schema' => ['title' => '数据源ID', 'description' => '预留参数,暂无需关注。', 'type' => 'string', 'required' => false, 'example' => 'test****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数详情。',
'type' => 'object',
'properties' => [
'Data' => [
'description' => '返回数据如下。',
'type' => 'object',
'properties' => [
'Content' => [
'description' => '任务详情。',
'type' => 'array',
'items' => [
'description' => '任务详情。',
'type' => 'object',
'properties' => [
'BackupId' => ['title' => '备份集ID', 'description' => '备份集ID。', 'type' => 'string', 'example' => '213088****'],
'BackupName' => ['title' => '备份集名称', 'description' => '备份集名称。', 'type' => 'string', 'example' => 'logic_backup'],
'BackupMode' => ['title' => '备份模式:Automated-自动备份;Manual-手动备份;', 'description' => '备份模式,返回值如下:'."\n"
."\n"
.'- **Automated**:系统自动备份'."\n"
.'- **Manual**:手动备份', 'type' => 'string', 'example' => 'Automated'],
'BackupType' => ['title' => '备份类型:FullBackup-全量备份;IncrementBackup-增量备份;', 'description' => '备份类型,返回值如下:'."\n"
."\n"
.'- **FullBackup**:全量备份'."\n"
.'- **IncrementBackup**:增量备份', 'type' => 'string', 'example' => 'FullBackup'],
'BackupScale' => ['title' => '备份规格:DBInstance-实例备份;DBTable-库表备份;', 'description' => '备份规格,返回值如下:'."\n"
."\n"
.'- **DBInstance**:实例备份'."\n"
.'- **DBTable**:库表备份', 'type' => 'string', 'example' => 'DBInstance'],
'BackupMethod' => ['title' => '备份方法:Physical-物理备份;Logical-逻辑备份;Snapshot-快照备份;', 'description' => '备份方式,返回值如下:'."\n"
."\n"
.'- **Physical**:物理备份'."\n"
.'- **Logical**:逻辑备份'."\n"
.'- **Snapshot**:快照备份', 'type' => 'string', 'example' => 'Snapshot'],
'BackupSize' => ['title' => '备份集大小,单位Byte', 'description' => '备份集大小,单位Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '25669140480'],
'BackupStatus' => ['title' => '备份集状态,OK-备份成功;ERROR-备份失败;', 'description' => '备份集状态,返回值如下:'."\n"
."\n"
.'- **OK**:备份成功'."\n"
.'- **ERROR**:备份失败', 'type' => 'string', 'example' => 'OK'],
'BackupStartTime' => ['title' => '备份开始时间,格式:yyyy-MM-ddTHH:mmZ', 'description' => '备份开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'example' => '2024-04-17T17:00:16Z'],
'BackupEndTime' => ['title' => '备份结束时间,格式:yyyy-MM-ddTHH:mmZ', 'description' => '备份结束时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'example' => '2024-04-17T17:00:32Z'],
'ConsistentTime' => ['title' => '一致性时间点:UnixTimestamp秒级时间戳', 'description' => '一致性快照的时间点,格式为Unix时间戳,单位为秒(s)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1713373221'],
'BackupLocation' => ['title' => '备份存储路径', 'description' => '备份存储路径。', 'type' => 'string', 'example' => 'logic'],
'InstanceName' => ['title' => '实例名称', 'description' => '实例ID。', 'type' => 'string', 'example' => 'pc-2ze3nrr64c5******'],
'Engine' => ['title' => '引擎类型', 'description' => '引擎类型。', 'type' => 'string', 'example' => 'polardb_mysql'],
'EngineVersion' => ['title' => '引擎版本', 'description' => '引擎版本。', 'type' => 'string', 'example' => '5.7'],
'SupportDeletion' => ['title' => '备份集是否支持删除', 'description' => '备份集是否支持删除,返回值如下:'."\n"
."\n"
.'- **0**:支持'."\n"
.'- **1**:不支持', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'Encryption' => ['title' => '加密信息', 'description' => '加密信息。', 'type' => 'string', 'example' => 'psk2'],
'IsAvail' => ['title' => '备份集是否可用,1-可用;0-不可用;', 'description' => '备份集是否可用,返回值如下:'."\n"
."\n"
.'- **1**:可用'."\n"
.'- **0**:不可用', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Checksum' => ['title' => '校验码', 'description' => '校验码。', 'type' => 'string', 'example' => '84a4c16431f969712e6895992719****'],
'BackupDownloadURL' => ['title' => '备份集公网下载链接', 'description' => '备份集公网下载地址。'."\n"
."\n"
.'> 仅当BackupMethod为**Physical**(物理备份)或**Logical**(逻辑备份)时,返回该参数。', 'type' => 'string', 'example' => 'http://oss.com/****'],
'BackupIntranetDownloadURL' => ['title' => '备份集内网下载链接', 'description' => '备份集内网下载地址。'."\n"
.'> 仅当BackupMethod为**Physical**(物理备份)或**Logical**(逻辑备份)时,返回该参数。', 'type' => 'string', 'example' => 'http://oss.com/****'],
'ExpectExpireType' => ['title' => '备份集预期过期类型', 'description' => '备份集预期过期类型,返回值如下:'."\n"
."\n"
.'- NEVER'."\n"
.'- EXPIRED'."\n"
.'- DELAY', 'type' => 'string', 'example' => 'DELAY'],
'ExpectExpireTime' => ['title' => '备份集预期过期时间,格式:yyyy-MM-ddTHH:mmZ', 'description' => '备份集预期过期时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'example' => '2024-04-19T05:00:49Z'],
'PolarSnapshot' => [
'title' => 'PolarDB二级转储信息',
'description' => 'PolarDB二级转储信息。'."\n"
."\n"
.'> 仅当PolarDB实例开启同地域二级转储功能,并且一级备份转储成功后,才会返回PolarSnapshot相关信息。',
'type' => 'object',
'properties' => [
'DumpId' => ['title' => '转储ID', 'description' => '转储ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'abc****'],
'DumpSize' => ['title' => '转储备份大小,单位为Byte', 'description' => '转储备份大小,单位为Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '25669140589'],
'expectExpireType' => ['title' => '备份集预期过期类型', 'description' => '备份集预期过期类型,返回值如下:'."\n"
."\n"
.'- NEVER'."\n"
.'- EXPIRED'."\n"
.'- DELAY', 'type' => 'string', 'example' => 'DELAY'],
'ExpectExpireTime' => ['title' => '备份集预期过期时间,格式:yyyy-MM-ddTHH:mmZ', 'description' => '备份集预期过期时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。', 'type' => 'string', 'example' => '2024-04-19T05:00:49Z'],
],
],
],
],
],
'PageSize' => ['title' => '分页大小', 'description' => '分页大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'],
'PageNumber' => ['title' => '分页页码', 'description' => '分页页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalPages' => ['title' => '分页总页数', 'description' => '分页总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalElements' => ['title' => '总个数', 'description' => '备份集总个数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'Extra' => ['title' => '额外信息', 'description' => '额外信息。', 'type' => 'string', 'example' => 'dbtest'],
],
],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28'],
'ErrCode' => ['description' => '错误码。'."\n", 'type' => 'string', 'example' => 'Request.Forbidden '],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功'."\n"
.'- **false**:请求失败', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。'."\n", 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. '],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询备份数据',
'description' => '### 适用引擎'."\n"
.'PolarDB MySQL版'."\n"
."\n"
.'> 当前该接口仅针对特定客户开放使用,如有需求,请到DBS客户咨询群(钉钉群号:35585947)申请使用。'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[PolarDB MySQL版备份操作](~~88172~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'list',
'ramAction' => [
'action' => 'dbs:DescribeBackupDataList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": [\\n {\\n \\"BackupId\\": \\"213088****\\",\\n \\"BackupName\\": \\"logic_backup\\",\\n \\"BackupMode\\": \\"Automated\\",\\n \\"BackupType\\": \\"FullBackup\\",\\n \\"BackupScale\\": \\"DBInstance\\",\\n \\"BackupMethod\\": \\"Snapshot\\",\\n \\"BackupSize\\": 25669140480,\\n \\"BackupStatus\\": \\"OK\\",\\n \\"BackupStartTime\\": \\"2024-04-17T17:00:16Z\\",\\n \\"BackupEndTime\\": \\"2024-04-17T17:00:32Z\\",\\n \\"ConsistentTime\\": 1713373221,\\n \\"BackupLocation\\": \\"logic\\",\\n \\"InstanceName\\": \\"pc-2ze3nrr64c5******\\",\\n \\"Engine\\": \\"polardb_mysql\\",\\n \\"EngineVersion\\": \\"5.7\\",\\n \\"SupportDeletion\\": 0,\\n \\"Encryption\\": \\"psk2\\",\\n \\"IsAvail\\": 1,\\n \\"Checksum\\": \\"84a4c16431f969712e6895992719****\\",\\n \\"BackupDownloadURL\\": \\"http://oss.com/****\\",\\n \\"BackupIntranetDownloadURL\\": \\"http://oss.com/****\\",\\n \\"ExpectExpireType\\": \\"DELAY\\",\\n \\"ExpectExpireTime\\": \\"2024-04-19T05:00:49Z\\",\\n \\"PolarSnapshot\\": {\\n \\"DumpId\\": 0,\\n \\"DumpSize\\": 25669140589,\\n \\"expectExpireType\\": \\"DELAY\\",\\n \\"ExpectExpireTime\\": \\"2024-04-19T05:00:49Z\\"\\n }\\n }\\n ],\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 1,\\n \\"TotalElements\\": 1,\\n \\"Extra\\": \\"dbtest\\"\\n },\\n \\"RequestId\\": \\"95A5FFD0-7F46-5A7D-9DFE-6A376B4E2A28\\",\\n \\"ErrCode\\": \\"Request.Forbidden\\\\t\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]',
],
'DescribeBackupPolicy' => [
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '215256',
'abilityTreeNodes' => ['FEATUREcbsPNQ3FN'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['title' => '地域', 'description' => '备份集所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['title' => '实例名', 'description' => 'PolarDB实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze3nrr64c5****'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数详情。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '54A63B3B-AA10-1CC3-A6BB-6CCE98D19628'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'instanceName can not be empty.'],
'Data' => [
'description' => '备份策略详情。',
'type' => 'object',
'properties' => [
'PreferredBackupDate' => ['title' => '基础备份的备份周期'."\n", 'description' => '基础备份的备份周期,以一个7位数返回,从左到右每一位分别对应周一到周日,其中1代表备份,0代表不进行备份。', 'type' => 'string', 'example' => '1010101'],
'PreferredBackupWindowBegin' => ['title' => '基础备份窗口开始时间', 'description' => '基础备份窗口开始时间。', 'type' => 'string', 'example' => '23:00Z'],
'PreferredBackupWindow' => ['title' => '基础备份窗口', 'description' => '基础备份窗口。', 'type' => 'string', 'example' => '23:00Z-24:00Z'],
'BackupRetentionPeriod' => ['title' => '基础备份保留时间,若开启高级备份策略,则为一级备份策略中得最长保留时间', 'description' => '基础备份保留时间,若开启高级备份策略,则为一级备份策略中的最长保留时间。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'BackupRetentionPolicyOnClusterDeletion' => ['title' => '已删除实例的归档备份保留策略。取值:'."\n"
.'0:不保留'."\n"
.'1:保留最后一个'."\n"
.'2:全部保留', 'description' => '已删除实例的归档备份保留策略,返回值如下:'."\n"
."\n"
.'- **NONE**:不保留'."\n"
.'- **LATEST**:保留最后一个'."\n"
.'- **ALL**:全部保留', 'type' => 'string', 'example' => 'LATEST'],
'HighFrequencyBakInterval' => ['title' => '高频备份时间', 'description' => '高频备份时间。例如120表示每两小时备份一次,单位为分钟。', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
'BackupPriority' => ['title' => '备库备份的设置。返回值:'."\n"
.'1:优先备库'."\n"
.'2:强制主库', 'description' => '备库备份的设置策略,返回值如下:'."\n"
."\n"
.'- **1**:优先备库'."\n"
.'- **2**:强制主库'."\n"
."\n\n"
.'> 该参数仅适用于RDS SQL Server实例,其他引擎返回值为**0**。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'EnableLogBackup' => ['title' => '是否开启日志备份', 'description' => '是否开启日志备份,返回值如下:'."\n"
."\n"
.'- **1**:开启'."\n"
.'- **0**:未开启', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'LogBackupRetention' => ['title' => '日志备份保留周期', 'description' => '日志备份保留周期。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
'LogBackupLocalRetentionNumber' => ['title' => '本地日志文件保留个数', 'description' => '本地日志文件保留个数。', 'type' => 'integer', 'example' => '10', 'format' => 'int32'],
'EnableBackup' => ['title' => '是否开启备份', 'description' => '是否开启备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'LocalLogRetentionSpace' => ['title' => '本地日志最大空间使用率。', 'description' => '本地日志最大空间使用率。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
'HighSpaceUsageProtection' => ['title' => '在磁盘水位过高时是否强制日志', 'description' => '实例使用空间大于80%,或者剩余空间小于 5 GB时,是否强制清理日志:'."\n"
."\n"
.'- **Disable**:不清理'."\n"
.'- **Enable**:清理', 'type' => 'string', 'example' => 'Enable'],
'Category' => ['title' => '是否开启秒级备份,仅对MySQL生效', 'description' => '是否开启秒级备份,返回值如下:'."\n"
."\n"
.'- **Flash**:已开启秒级备份'."\n"
.'- **Standard**:普通备份'."\n"
."\n"
.'> 该参数仅对MySQL生效。', 'type' => 'string', 'example' => 'Standard'],
'IncBackupInterval' => ['title' => '高频增量备份间隔', 'description' => '高频增量备份间隔。', 'type' => 'integer', 'format' => 'int32', 'example' => '-1'],
'EnableIncBackup' => ['title' => '是否开启增量备份', 'description' => '是否开启增量备份。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
'BackupMethod' => ['title' => '备份方式 S - 快照备份 P-物理备份', 'description' => '备份方式,返回值如下:'."\n"
."\n"
.'- **Physical**:物理备份'."\n"
.'- **Snapshot**:快照备份', 'type' => 'string', 'example' => 'Physical'],
'AdvanceLogPolicies' => [
'description' => '日志备份策略详情。',
'type' => 'array',
'items' => [
'description' => '策略详情。',
'type' => 'object',
'properties' => [
'PolicyId' => ['title' => '备份策略ID', 'description' => '备份策略ID。', 'type' => 'string', 'example' => 'dc13b153acc91141789122c23835****'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型,返回值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源地域。', 'type' => 'string', 'example' => 'cn-beijing'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型,返回值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
'EnableLogBackup' => ['description' => '预留参数,无需关注。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'LogRetentionType' => ['title' => '日志备份保留类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 按天过期', 'description' => '日志备份保留类型,返回值如下:'."\n"
."\n"
.'- **never**:永不过期'."\n"
.'- **delay**:固定天数过期', 'type' => 'string', 'example' => 'delay'],
'LogRetentionValue' => ['title' => '日志备份保留时间', 'description' => '日志备份保留时间。', 'type' => 'string', 'example' => '3'],
'FilterType' => ['description' => '高级策略筛选类型,返回值如下:'."\n"
."\n"
.'crontab:周期调度'."\n"
."\n"
.'event:事件调度', 'type' => 'string', 'example' => 'crontab'],
'FilterKey' => ['description' => '调度类型,返回值如下:'."\n"
."\n"
.'dayOfWeek:按周调度'."\n"
."\n"
.'dayOfMonth:按月调度'."\n"
."\n"
.'dayOfYear:按年调度'."\n"
."\n"
.'backupInterval:固定间隔调度'."\n"
."\n"
.'说明'."\n"
.'仅当 FilterType 为 crontab 时,返回该参数。', 'type' => 'string', 'example' => 'dayOfWeek'],
'FilterValue' => ['description' => '备份周期。', 'type' => 'string', 'example' => '1,2,3,4,5,6,7'],
],
],
],
'AdvanceDataPolicies' => [
'description' => '数据备份策略详情。',
'type' => 'array',
'items' => [
'description' => '策略详情。',
'type' => 'object',
'properties' => [
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID。', 'type' => 'string', 'example' => '71930ac2e9f15e41615e10627c******'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型,返回值如下:'."\n"
."\n"
.'- **crontab**:周期调度'."\n"
.'- **event**:事件调度', 'type' => 'string', 'example' => 'crontab'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,返回值如下:'."\n"
."\n"
.'- **dayOfWeek**:按周调度'."\n"
.'- **dayOfMonth**:按月调度'."\n"
.'- **dayOfYear**:按年调度'."\n"
.'- **backupInterval**:固定间隔调度'."\n"
."\n"
.'> 仅当FilterType为**crontab**时,返回该参数。', 'type' => 'string', 'example' => 'dayOfWeek'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '备份周期。', 'type' => 'string', 'example' => '1,2,3,4,5,6,7'],
'DumpAction' => ['title' => '转储策略'."\n"
.' Copy - 复制'."\n"
.' Move - 转储', 'description' => '转储策略详情,返回值如下:'."\n"
."\n"
.'- **copy**:复制'."\n"
.'- **move**:转储', 'type' => 'string', 'example' => 'copy'],
'RetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '备份集保留周期类型,返回值如下:'."\n"
."\n"
.'- **never**:永不过期'."\n"
.'- **delay**:固定天数过期', 'type' => 'string', 'example' => 'delay'],
'RetentionValue' => ['title' => '过期天数', 'description' => '过期天数。', 'type' => 'string', 'example' => '7'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型,返回值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'example' => 'db'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源地域。', 'type' => 'string', 'example' => 'cn-beijing'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型,返回值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标地域。', 'type' => 'string', 'example' => 'cn-beijing'],
'BakType' => ['title' => '备份类型 F - 全量 L 日志', 'description' => '备份类型,返回值如下:'."\n"
."\n"
.'- **F**:全量备份'."\n"
.'- **L**:日志备份', 'type' => 'string', 'example' => 'F'],
'AutoCreated' => ['title' => '是否系统自动生成', 'description' => '是否为系统自动生成的备份策略,返回值如下:'."\n"
."\n"
.'- **true**:系统生成策略'."\n"
.'- **false**:用户自定义策略', 'type' => 'boolean', 'example' => 'true'],
'StorageClass' => ['description' => '数据存储类型。', 'type' => 'string', 'example' => 'STANDARD'],
],
],
],
'AdvanceIncPolicies' => [
'description' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID', 'type' => 'string', 'example' => 'smp-l0bfdmlr4c***'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'type' => 'string', 'example' => 'crontab'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'type' => 'string', 'example' => 'dayOfMonth'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '具体Filter的值', 'type' => 'string', 'example' => '1'],
'DumpAction' => ['title' => '转储策略'."\n"
.' Copy - 复制'."\n"
.' Move - 转储', 'description' => '转储策略'."\n"
.' Copy - 复制'."\n"
.' Move - 转储', 'type' => 'string', 'example' => 'Copy'],
'RetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'type' => 'string', 'example' => 'delay'],
'RetentionValue' => ['title' => '过期天数', 'description' => '过期天数', 'type' => 'string', 'example' => '365'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'example' => 'db'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源region', 'type' => 'string', 'example' => 'cn-hangzhou'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'example' => 'db'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标region', 'type' => 'string', 'example' => 'cn-hangzhou'],
'BakType' => ['title' => '备份类型 F - 全量 L 日志', 'description' => '备份类型 F - 全量 L 日志', 'type' => 'string', 'example' => 'F'],
'AutoCreated' => ['title' => '是否系统自动生成', 'description' => '是否系统自动生成', 'type' => 'boolean', 'example' => 'true'],
],
'description' => '',
],
],
'PreferredNextBackupTime' => ['type' => 'string', 'example' => '2025-07-08T16:05Z'],
'EnablePitrProtection' => ['type' => 'boolean'],
'LogBackupLocalRetention' => ['type' => 'integer', 'format' => 'int32', 'example' => '7'],
'ColdRetention' => ['type' => 'integer', 'format' => 'int32', 'example' => '30'],
'ColdKeepPolicy' => ['type' => 'integer', 'format' => 'int32', 'example' => '1'],
'ColdKeepCount' => ['type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. '],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功'."\n"
.'- **false**:请求失败', 'type' => 'string', 'example' => 'true'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'title' => '查询备份策略',
'summary' => '查询PolarDB实例备份策略。',
'description' => '### 适用引擎'."\n"
.'PolarDB MySQL版'."\n"
."\n"
.'> 当前该接口仅针对特定客户开放使用,如有需求,请到DBS客户咨询群(钉钉群号:35585947)申请使用。'."\n"
."\n"
.'### 相关功能文档'."\n"
.'[PolarDB MySQL版备份策略](~~280422~~)',
'changeSet' => [
['createdAt' => '2024-05-28T13:59:23.000Z', 'description' => '响应参数发生变更'],
['createdAt' => '2024-05-17T02:21:41.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeBackupPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54A63B3B-AA10-1CC3-A6BB-6CCE98D19628\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupDate\\": \\"1010101\\",\\n \\"PreferredBackupWindowBegin\\": \\"23:00Z\\",\\n \\"PreferredBackupWindow\\": \\"23:00Z-24:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"LATEST\\",\\n \\"HighFrequencyBakInterval\\": 120,\\n \\"BackupPriority\\": 0,\\n \\"EnableLogBackup\\": 1,\\n \\"LogBackupRetention\\": 7,\\n \\"LogBackupLocalRetentionNumber\\": 10,\\n \\"EnableBackup\\": 1,\\n \\"LocalLogRetentionSpace\\": 30,\\n \\"HighSpaceUsageProtection\\": \\"Enable\\",\\n \\"Category\\": \\"Standard\\",\\n \\"IncBackupInterval\\": -1,\\n \\"EnableIncBackup\\": 0,\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"SrcType\\": \\"level1\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"EnableLogBackup\\": 1,\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"LogRetentionValue\\": \\"3\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"PolicyId\\": \\"71930ac2e9f15e41615e10627c******\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfWeek\\",\\n \\"FilterValue\\": \\"1,2,3,4,5,6,7\\",\\n \\"DumpAction\\": \\"copy\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"7\\",\\n \\"SrcType\\": \\"db\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"DestType\\": \\"level1\\",\\n \\"DestRegion\\": \\"cn-beijing\\",\\n \\"BakType\\": \\"F\\",\\n \\"AutoCreated\\": true,\\n \\"StorageClass\\": \\"STANDARD\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"PolicyId\\": \\"smp-l0bfdmlr4c***\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"FilterKey\\": \\"dayOfMonth\\",\\n \\"FilterValue\\": \\"1\\",\\n \\"DumpAction\\": \\"Copy\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"RetentionValue\\": \\"365\\",\\n \\"SrcType\\": \\"db\\",\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"DestType\\": \\"db\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"BakType\\": \\"F\\",\\n \\"AutoCreated\\": true\\n }\\n ],\\n \\"PreferredNextBackupTime\\": \\"2025-07-08T16:05Z\\",\\n \\"EnablePitrProtection\\": true,\\n \\"LogBackupLocalRetention\\": 7,\\n \\"ColdRetention\\": 30,\\n \\"ColdKeepPolicy\\": 1,\\n \\"ColdKeepCount\\": 1\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]',
],
'DescribeCostInfoByDbsInstance' => [
'summary' => '根据dbs实例id获取费用列表',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID,您可以在账单里看到地域信息', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'BackupPlanId',
'in' => 'query',
'schema' => ['description' => '备份计费实例ID。', 'type' => 'string', 'required' => false, 'example' => 'dbsr1l3ro21****'],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '参数说明:'."\n"
.'- **commodity**:商品'."\n"
.'- **product**:产品'."\n"
.'- **moduleCode**:计费项'."\n"
.'- **instanceName**:沙箱实例ID。'."\n"
.'- **backupSetId**:备份集ID。'."\n"
.'- **instanceName**:引擎实例名'."\n"
.'- **backupPlanId**:备份计费实例ID。', 'type' => 'string', 'example' => '{'."\n"
.' "backupPlanComment": "",'."\n"
.' "commodity": "cbs_post",'."\n"
.' "product": "cbs",'."\n"
.' "moduleCode": "BackupStorageSize",'."\n"
.' "instanceName": "d-2zefd6337d766294",'."\n"
.' "backupPlanId": "dbs:d-2zefd6337d766294",'."\n"
.' "moduleName": "mongodb"'."\n"
.' }'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9C397502-B4F2-4E22-AD97-C81F0049F3F3'],
'ErrCode' => ['description' => '错误码。'."\n", 'type' => 'string', 'example' => 'Param.NotFound'],
'Success' => ['description' => '是否请求成功。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid. '],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'title' => '根据dbs实例id获取收费详情。',
'description' => '当前接口仅支持DBS API服务2021-01-01版本。',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeCostInfoByDbsInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"backupPlanComment\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"commodity\\\\\\": \\\\\\"cbs_post\\\\\\",\\\\n \\\\\\"product\\\\\\": \\\\\\"cbs\\\\\\",\\\\n \\\\\\"moduleCode\\\\\\": \\\\\\"BackupStorageSize\\\\\\",\\\\n \\\\\\"instanceName\\\\\\": \\\\\\"d-2zefd6337d766294\\\\\\",\\\\n \\\\\\"backupPlanId\\\\\\": \\\\\\"dbs:d-2zefd6337d766294\\\\\\",\\\\n \\\\\\"moduleName\\\\\\": \\\\\\"mongodb\\\\\\"\\\\n }\\",\\n \\"RequestId\\": \\"9C397502-B4F2-4E22-AD97-C81F0049F3F3\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid. \\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","type":"json"}]',
],
'DescribeDownloadBackupSetStorageInfo' => [
'summary' => '查看下载备份集的存储信息。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '135676',
'abilityTreeNodes' => ['FEATUREcbs04Q4EK'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'Duration',
'in' => 'query',
'schema' => ['description' => '下载目标为URL时,设置链接有效时长。'."\n"
."\n"
.'- 默认URL有效时长为2小时(7200秒)。'."\n"
.'- 有效时长范围可设置5分钟(300秒)~1天(86400秒)。'."\n"
.'- 请转化为秒(s)后传入该值,例如设置链接有效时长为5分钟时,传入300。', 'type' => 'string', 'required' => true, 'example' => '300'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
."\n"
.'> 如果您填写了**InstanceName**,也需填写**BackupSetId**。', 'type' => 'string', 'required' => false, 'example' => 'rm-uf6qqf569n435****'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '下载任务ID。'."\n"
."\n"
.'- 如果不填写任务**TaskId**,则需要填写**BackupSetId**和**InstanceName**。'."\n"
.'- 您可在单击目标实例中的**备份恢复**,在**备份下载**页签下查看**任务ID**。', 'type' => 'string', 'required' => false, 'example' => 'dt-s0ugzak9****'],
],
[
'name' => 'BackupSetId',
'in' => 'query',
'schema' => ['description' => '备份集ID。', 'type' => 'string', 'required' => false, 'example' => '30****'],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['title' => '仅MongoDB依赖,分片集群的集群名', 'description' => '仅MongoDB依赖,分片集群的集群名', 'type' => 'string', 'required' => false, 'example' => 'dds-example'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回值如下。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '44B8C2F5-919D-5D29-BCD5-DEB03467****'],
'ErrCode' => ['description' => '错误码。'."\n", 'type' => 'string', 'example' => 'DBS.ParamIsInValid'],
'Success' => ['description' => '是否执行成功。返回值:'."\n"
.'- **true**:执行成功'."\n"
.'- **false**:执行失败', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。'."\n", 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'DBS.ParamIsInValid'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty'],
'Data' => [
'description' => '返回数据如下。',
'type' => 'object',
'properties' => [
'PublicUrl' => ['description' => '备份集公网下载地址。', 'type' => 'string', 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456'],
'PrivateUrl' => ['description' => '备份集私网下载地址。', 'type' => 'string', 'example' => 'http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123'],
'ExpirationTime' => ['description' => '链接有效期。'."\n"
."\n"
.'> 返回值为时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'example' => '1661329050'],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"44B8C2F5-919D-5D29-BCD5-DEB03467****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Data\\": {\\n \\"PublicUrl\\": \\"http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456\\",\\n \\"PrivateUrl\\": \\"http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123\\",\\n \\"ExpirationTime\\": 1661329050\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDownloadBackupSetStorageInfoResponse>\\n <RequestId>44B8C2F5-919D-5D29-BCD5-DEB03467****</RequestId>\\n <Data>\\n <PrivateUrl>http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou-internal.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_123</PrivateUrl>\\n <PublicUrl>http://dbs-137383785969****-cn-hangzhou-1iv12nblw****.oss-cn-hangzhou.aliyuncs.com/dt-u7u4bufa****/dbs_target_file_path/test_456</PublicUrl>\\n <ExpirationTime>1661329050</ExpirationTime>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <ErrCode>Success</ErrCode>\\n</DescribeDownloadBackupSetStorageInfoResponse>","errorExample":""}]',
'title' => '查看下载备份集的存储信息',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL(云盘系列)'."\n"
.'- RDS PostgreSQL'."\n"
.'- PolarDB MySQL版'."\n"
.'- MongoDB'."\n"
."\n"
.'### 相关功能文档'."\n"
."\n"
.'- [RDS MySQL下载备份](~~98819~~)'."\n"
.'- [RDS PostgreSQL下载备份](~~96774~~)'."\n"
.'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n"
.'- [MongoDB下载备份](~~55011~~)',
'changeSet' => [
['createdAt' => '2022-08-25T07:43:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-03T09:23:52.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeDownloadBackupSetStorageInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'],
],
],
],
],
],
'DescribeDownloadSupport' => [
'summary' => '查询当前实例是否支持高级下载。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcbs04Q4EK'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID,您可以调用[DescribeDBInstanceAttribute](~~26231~~)查询。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-bp1a48p922r4b****'],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['title' => '仅MongoDB依赖,分片集群的集群名', 'description' => '仅MongoDB依赖,分片集群的集群名', 'type' => 'string', 'required' => false, 'example' => 'dds-example'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回值如下。',
'type' => 'object',
'properties' => [
'Data' => ['description' => '是否支持高级下载功能,返回值如下:'."\n"
."\n"
.'- **true**:支持'."\n"
.'- **false**:不支持'."\n", 'type' => 'string', 'example' => 'true'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F1A186F7-7B34-5C11-A903-EE23876B****'],
'ErrCode' => ['description' => '调用出错时返回的错误码。', 'type' => 'string', 'example' => 'DBS.ParamIsInValid'],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功'."\n"
.'- **false**:请求失败', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '调用错误时返回的错误信息。'."\n", 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'DBS.ParamIsInValid'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Argument: regionCode Must not be empty'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'staticInfo' => [],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"F1A186F7-7B34-5C11-A903-EE23876B****\\",\\n \\"ErrCode\\": \\"DBS.ParamIsInValid\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"Argument: regionCode Must not be empty\\",\\n \\"Code\\": \\"DBS.ParamIsInValid\\",\\n \\"Message\\": \\"Argument: regionCode Must not be empty\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeDownloadSupportResponse>\\n <RequestId>F1A186F7-7B34-5C11-A903-EE23876B****</RequestId>\\n <Data>true</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <ErrCode>Success</ErrCode>\\n</DescribeDownloadSupportResponse>","errorExample":""}]',
'title' => '查询当前实例是否支持高级下载',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL(云盘系列)'."\n"
.'- RDS PostgreSQL'."\n"
.'- PolarDB MySQL版'."\n"
.'- MongoDB'."\n"
."\n"
.'### 相关功能文档'."\n"
."\n"
.'您可以按任意时间点或按指定备份集创建高级下载任务,并支持选择下载目标为URL或直接将数据写入您的OSS中,后续方便您进行数据分析以及离线归档。'."\n"
."\n"
.'- [RDS MySQL下载备份](~~98819~~)'."\n"
.'- [RDS PostgreSQL下载备份](~~96774~~)'."\n"
.'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n"
.'- [MongoDB下载备份](~~55011~~)',
'changeSet' => [
['createdAt' => '2022-08-25T07:43:22.000Z', 'description' => '请求参数发生变更'],
['createdAt' => '2022-08-03T09:23:52.000Z', 'description' => 'OpenAPI 下线'],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '400', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDownloadSupport'],
],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeDownloadSupport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'],
],
],
],
],
],
'DescribeDownloadTask' => [
'summary' => '查询RDS MySQL、RDS PostgreSQL、PolarDB MySQL版实例的高级下载任务列表。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcbs04Q4EK'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID,您可以调用[DescribeDBInstanceAttribute](~~26231~~)查询。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例ID。'."\n"
."\n"
.'> 该参数为必填项。', 'type' => 'string', 'required' => false, 'example' => 'rm-bp1imnmcjxdz7****'],
],
[
'name' => 'DatasourceId',
'in' => 'query',
'schema' => ['description' => '数据源DBS标记ID,传入格式为:*ds-${实例ID}_${regionId}*。', 'type' => 'string', 'required' => false, 'example' => 'ds-rm-2ze8g2am97624****_cn-hangzhou'],
],
[
'name' => 'BackupSetId',
'in' => 'query',
'schema' => ['description' => '创建下载任务时生成的备份集ID,您可调用[DescribeBackups](~~26273~~)接口查询。', 'type' => 'string', 'required' => false, 'example' => '216****'],
],
[
'name' => 'State',
'in' => 'query',
'schema' => ['description' => '下载任务的状态,取值如下:'."\n"
."\n"
.'- **initializing**:初始化。'."\n"
.'- **queueing**:排队中。'."\n"
.'- **running**:下载中。'."\n"
.'- **failed**:下载失败。'."\n"
.'- **finished**:下载成功。'."\n"
.'- **expired**:下载过期。', 'type' => 'string', 'required' => false, 'example' => 'queueing'],
],
[
'name' => 'TaskType',
'in' => 'query',
'schema' => ['description' => '下载任务类型,取值如下:'."\n"
."\n"
.'- **full**:全量备份集下载。'."\n"
.'- **pit**r:任意时间点下载。', 'type' => 'string', 'required' => false, 'example' => 'full'],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => ['description' => '按创建时间区间的起始点查询,Long类型时间戳形式,单位为毫秒(ms)。', 'type' => 'string', 'required' => false, 'example' => '1661941554000'],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => ['description' => '按创建时间区间的终止点查询,Long类型时间戳形式,单位为毫秒(ms)。', 'type' => 'string', 'required' => false, 'example' => '1661941556000'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的记录数。', 'type' => 'string', 'required' => false, 'example' => '50'],
],
[
'name' => 'CurrentPage',
'in' => 'query',
'schema' => ['description' => '当前页码。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'OrderDirect',
'in' => 'query',
'schema' => ['description' => '排序方向,取值如下:'."\n"
."\n"
.'- **asc**:正序。'."\n"
.'- **desc**:倒序,为默认值。'."\n", 'type' => 'string', 'required' => false, 'example' => 'desc'],
],
[
'name' => 'OrderColumn',
'in' => 'query',
'schema' => ['description' => '默认按创建时间排序,取值:**gmt_create**。', 'type' => 'string', 'required' => false, 'example' => 'gmt_create'],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['title' => '仅MongoDB依赖,分片集群的集群名', 'description' => '仅MongoDB依赖,分片集群的集群名', 'type' => 'string', 'required' => false, 'example' => 'dds-example'],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数如下。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '5D285EB9-A443-592D-9F3D-A888FAC3****'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'DBS.InternalError'],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功。'."\n"
.'- **false**:请求失败。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'instanceName can not be empty'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'DBS.InternalError'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'instanceName can not be empty'],
'Data' => [
'description' => '任务详情。',
'type' => 'object',
'properties' => [
'PageNumber' => ['description' => '页码,大于0且不超过Integer的最大值,默认值为1。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'TotalPages' => ['description' => '总页数。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
'Extra' => ['description' => '备份数据上云任务的附加信息。', 'type' => 'string', 'example' => 'dbtest'],
'TotalElements' => ['description' => '总备份任务数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'PageSize' => ['description' => '每页的记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
'Content' => [
'type' => 'object',
'itemNode' => true,
'properties' => [
'List' => [
'description' => '任务详情。',
'type' => 'array',
'items' => [
'description' => '任务详情。',
'type' => 'object',
'properties' => [
'TaskId' => ['description' => '下载任务ID。', 'type' => 'string', 'example' => 'dt-qxntlvgu****'],
'RegionCode' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'],
'Format' => ['description' => '下载转换的目标格式,返回值如下:'."\n"
."\n"
.'- **csv**'."\n"
.'- **SQL**'."\n"
.'- **Parquet**', 'type' => 'string', 'example' => 'csv'],
'DbList' => ['description' => '数据库列表。', 'type' => 'string', 'example' => '[dbtest]'],
'BakSetId' => ['description' => '全量备份集ID。', 'type' => 'string', 'example' => '148261****'],
'DownloadStatus' => ['description' => '下载任务的状态,返回值如下:'."\n"
."\n"
.'- **initializing**:初始化。'."\n"
.'- **queueing**:排队中。'."\n"
.'- **running**:下载中。'."\n"
.'- **failed**:下载失败。'."\n"
.'- **finished**:下载成功。'."\n"
.'- **expired**:下载过期。', 'type' => 'string', 'example' => 'queueing'],
'ExportDataSize' => ['description' => '导出数据量,单位为字节(Byte)。', 'type' => 'string', 'example' => '0'],
'ImportDataSize' => ['description' => '处理数据量,单位为字节(Byte)。', 'type' => 'string', 'example' => '0'],
'BackupSetTime' => ['description' => '任意时间点下载任务时所对应的时间点,Long类型时间戳,单位为毫秒(ms)。', 'type' => 'string', 'example' => '1663162216000'],
'TargetType' => ['description' => '下载目标类型,返回值如下:'."\n"
."\n"
.'- **OSS**'."\n"
.'- **URL**', 'type' => 'string', 'example' => 'URL'],
'TargetPath' => ['description' => '当**TargetType=OSS**时,返回数据下载目标路径。', 'type' => 'string', 'example' => 'test_db/path'],
'Progress' => ['description' => '已导出表数量/需导出表总数量。', 'type' => 'string', 'example' => '0/0'],
'GmtCreate' => ['description' => '任务创建时间,返回格式为时间戳形式。', 'type' => 'string', 'example' => '1663321957000'],
],
],
],
],
'description' => '',
],
],
],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"5D285EB9-A443-592D-9F3D-A888FAC3****\\",\\n \\"ErrCode\\": \\"DBS.InternalError\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"instanceName can not be empty\\",\\n \\"Code\\": \\"DBS.InternalError\\",\\n \\"Message\\": \\"instanceName can not be empty\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"TotalPages\\": 2,\\n \\"Extra\\": \\"dbtest\\",\\n \\"TotalElements\\": 1,\\n \\"PageSize\\": 10,\\n \\"Content\\": {\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"dt-qxntlvgu****\\",\\n \\"RegionCode\\": \\"cn-hangzhou\\",\\n \\"Format\\": \\"csv\\",\\n \\"DbList\\": \\"[dbtest]\\",\\n \\"BakSetId\\": \\"148261****\\",\\n \\"DownloadStatus\\": \\"queueing\\",\\n \\"ExportDataSize\\": \\"0\\",\\n \\"ImportDataSize\\": \\"0\\",\\n \\"BackupSetTime\\": \\"1663162216000\\",\\n \\"TargetType\\": \\"URL\\",\\n \\"TargetPath\\": \\"test_db/path\\",\\n \\"Progress\\": \\"0/0\\",\\n \\"GmtCreate\\": \\"1663321957000\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDownloadTaskResponse>\\n <RequestId>5D285EB9-A443-592D-9F3D-A888FAC3****</RequestId>\\n <Data>\\n <Number>0</Number>\\n <Size>20</Size>\\n <Content>\\n <List>\\n <BakSetId>148261****</BakSetId>\\n <Progress>0/0</Progress>\\n <GmtCreate>1663321957000</GmtCreate>\\n <TaskId>dt-qxntlvgu****</TaskId>\\n <Format>csv</Format>\\n <BackupSetTime>1663162216000</BackupSetTime>\\n <RegionCode>cn-hangzhou</RegionCode>\\n <DownloadStatus>queueing</DownloadStatus>\\n <ExportDataSize>0</ExportDataSize>\\n <TargetType>URL</TargetType>\\n <ImportDataSize>0</ImportDataSize>\\n </List>\\n <List>\\n <BakSetId>148145****</BakSetId>\\n <Progress>0/0</Progress>\\n <GmtCreate>1663321935000</GmtCreate>\\n <TaskId>dt-uvbegmuc****</TaskId>\\n <Format>csv</Format>\\n <BackupSetTime>1663055892000</BackupSetTime>\\n <RegionCode>cn-hangzhou</RegionCode>\\n <DownloadStatus>running</DownloadStatus>\\n <ExportDataSize>0</ExportDataSize>\\n <TargetType>URL</TargetType>\\n <ImportDataSize>0</ImportDataSize>\\n </List>\\n </Content>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <ErrCode>Success</ErrCode>\\n</DescribeDownloadTaskResponse>","errorExample":""}]',
'title' => '查询下载任务列表',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL(云盘系列)'."\n"
.'- RDS PostgreSQL'."\n"
.'- PolarDB MySQL版'."\n"
.'- MongoDB'."\n"
."\n"
.'### 相关功能文档'."\n"
."\n"
.'- [RDS MySQL下载备份](~~98819~~)'."\n"
.'- [RDS PostgreSQL下载备份](~~96774~~)'."\n"
.'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n"
.'- [MongoDB下载备份](~~55011~~)',
'changeSet' => [
['createdAt' => '2022-11-16T11:43:03.000Z', 'description' => '响应参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeDownloadTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
],
'DescribeSandboxBackupSets' => [
'summary' => '查询沙箱备份集。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'BackupPlanId',
'in' => 'query',
'schema' => ['description' => '备份计划ID。'."\n"
.'> 若您的实例为RDS MySQL,请通过[自动添加数据源](~~193091~~)功能,将RDS自动添加至DBS中,即可获取备份计划ID。', 'type' => 'string', 'required' => true, 'example' => '1hxxxx8xxxxxa'],
],
[
'name' => 'BackupSetId',
'in' => 'query',
'schema' => ['description' => '备份集ID。若您传入该参数,仅返回该备份集的快照信息;若不传入该参数,将返回该备份计划的所有快照信息。', 'type' => 'string', 'required' => false, 'example' => '1xxxx2xxxxx1e'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的记录数。取值如下:'."\n"
.'- 30(默认)'."\n"
.'- 50'."\n"
.'- 100', 'type' => 'string', 'required' => false, 'example' => '30'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码,大于0且不超过Integer的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '参数说明:'."\n"
.'- **backupSetTime**:快照时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。'."\n"
.'- **backupSetId**:备份集ID。'."\n"
.'- **backupSetType**:快照类型,**Full**表示全量备份集快照、**Inc**表示增量备份快照。'."\n"
.'- **backupPlanId**:备份计划ID。', 'type' => 'string', 'example' => ' "Data": { "number": 2, "size": 2, "content": [ { "backupSetTime": "2021-08-28T23:12:31Z", "backupSetId": "Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134", "backupSetType": "Inc", "backupPlanId": "1hxxxx8xxxxxa" }, { "backupSetTime": "2021-08-28T22:42:28Z", "backupSetId": "1hxxxx8xxxxxa_20210829064228", "backupSetType": "FULL", "backupPlanId": "1hxxxx8xxxxxa" } ], "totalElements": 2 },'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Success' => ['description' => '是否请求成功。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'title' => '查询快照列表',
'description' => '执行该操作前,您需要先开启数据库实例的沙箱功能,详情请参见[RDS MySQL应急恢复](~~203154~~)或[自建MySQL应急恢复(沙箱实例)](~~185577~~)。'."\n"
.'当前接口仅支持DBS API服务2021-01-01版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeSandboxBackupSets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\" \\\\\\"Data\\\\\\": { \\\\\\"number\\\\\\": 2, \\\\\\"size\\\\\\": 2, \\\\\\"content\\\\\\": [ { \\\\\\"backupSetTime\\\\\\": \\\\\\"2021-08-28T23:12:31Z\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134\\\\\\", \\\\\\"backupSetType\\\\\\": \\\\\\"Inc\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\" }, { \\\\\\"backupSetTime\\\\\\": \\\\\\"2021-08-28T22:42:28Z\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"1hxxxx8xxxxxa_20210829064228\\\\\\", \\\\\\"backupSetType\\\\\\": \\\\\\"FULL\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\" } ], \\\\\\"totalElements\\\\\\": 2 },\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>3A6295D0-93C3-1FA4-8D5C-97B05379F519</RequestId>\\n<Data>\\n <number>2</number>\\n <size>2</size>\\n <content>\\n <backupSetTime>2021-08-28T23:12:31Z</backupSetTime>\\n <backupSetId>Inc_1hxxxx8xxxxxa_20210801064200_mysql-bin.000134</backupSetId>\\n <backupSetType>Inc</backupSetType>\\n <backupPlanId>1hxxxx8xxxxxa</backupPlanId>\\n </content>\\n <content>\\n <backupSetTime>2021-08-28T22:42:28Z</backupSetTime>\\n <backupSetId>1hxxxx8xxxxxa_20210829064228</backupSetId>\\n <backupSetType>FULL</backupSetType>\\n <backupPlanId>1hxxxx8xxxxxa</backupPlanId>\\n </content>\\n <totalElements>2</totalElements>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>\\n<ErrCode>Success</ErrCode>","errorExample":""}]',
],
'DescribeSandboxInstances' => [
'summary' => '查看当前账号下的沙箱实例列表。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'BackupPlanId',
'in' => 'query',
'schema' => ['description' => '备份计划ID,您可以通过[DescribeBackupPlanList](~~437215~~)接口获取该参数。'."\n"
.'> 若您的实例为RDS MySQL,请通过[自动添加数据源](~~193091~~)功能,将RDS自动添加至DBS中,即可获取备份计划ID。', 'type' => 'string', 'required' => true, 'example' => '1hxxxx8xxxxxa'],
],
[
'name' => 'InstanceId',
'in' => 'query',
'schema' => ['description' => '沙箱实例ID,您可以通过[CreateSandboxInstance](~~437252~~)接口获取该参数。', 'type' => 'string', 'required' => false, 'example' => '1jxxxxnxxx1xc'],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => ['description' => '每页的记录数。取值:'."\n"
.'- 30(默认)'."\n"
.'- 50'."\n"
.'- 100', 'type' => 'string', 'required' => false, 'example' => '30'],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => ['description' => '页码,大于0且不超过Integer的最大值,默认值为1。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '参数说明:'."\n"
.'- **connectionString**:沙箱实例的连接字符串,格式为IP:Port。当SandboxType为**Sandbox**时,该参数表示沙箱实例的连接地址;当SandboxType为**NFS**时,该参数表示NFS挂载地址。'."\n"
.'- **restoreSeconds**:创建沙箱实例所需的时长,单位为秒。'."\n"
.'- **restoreTime**:恢复的时间点,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。'."\n"
.'- **instanceId**:沙箱实例ID。'."\n"
.'- **backupSetId**:备份集ID。'."\n"
.'- **createTime**:沙箱实例的创建时间,格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。'."\n"
.'- **backupPlanId**:备份计划ID。'."\n"
.'- **vpcId**:专有网络VPC(Virtual Private Cloud) ID。'."\n"
.'- **vpcSwitchId**:VPC交换机ID。'."\n"
.'- **sandboxSpecification**:沙箱实例规格。'."\n"
.'- **status**:沙箱实例状态,运行中(**running**)、预检查通过(**check_pass**)、异常(**stop**)。'."\n", 'type' => 'string', 'example' => ' { "number": 1, "size": 1, "content": [ { "connectionString": "172.26.178.229:3306", "restoreSeconds": 15, "restoreTime": "2021-08-11T07:26:24Z", "instanceId": "1jxxxxx9xxxms", "backupSetId": "1hxxxx8xxxxxa_20210811152624", "createTime": "2021-08-12T07:40:29Z", "backupPlanId": "1hxxxx8xxxxxa", "vpcId": "vpc-bp1dxxxxxjy0xxxxx1xxp", "sandboxSpecification": "MYSQL_1C_1M_SD", "status": "running", "vpcSwitchId": "vsw-bp1bxxxxxumxxxxxwxx2w" } ], "totalElements": 1 }'],
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Success' => ['description' => '是否请求成功。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'title' => '查看沙箱实例列表',
'description' => '当前接口仅支持DBS API服务2021-01-01版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' | 错误码 | 报错消息 | 可能原因 |'."\n"
.'| -------------- | -------------------------- | -------------------------------------- |'."\n"
.'| DBS.NotExisted | no valid job exist with id | InstanceId参数所对应的备份计划不存在。 |',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeSandboxInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\" { \\\\\\"number\\\\\\": 1, \\\\\\"size\\\\\\": 1, \\\\\\"content\\\\\\": [ { \\\\\\"connectionString\\\\\\": \\\\\\"172.26.178.229:3306\\\\\\", \\\\\\"restoreSeconds\\\\\\": 15, \\\\\\"restoreTime\\\\\\": \\\\\\"2021-08-11T07:26:24Z\\\\\\", \\\\\\"instanceId\\\\\\": \\\\\\"1jxxxxx9xxxms\\\\\\", \\\\\\"backupSetId\\\\\\": \\\\\\"1hxxxx8xxxxxa_20210811152624\\\\\\", \\\\\\"createTime\\\\\\": \\\\\\"2021-08-12T07:40:29Z\\\\\\", \\\\\\"backupPlanId\\\\\\": \\\\\\"1hxxxx8xxxxxa\\\\\\", \\\\\\"vpcId\\\\\\": \\\\\\"vpc-bp1dxxxxxjy0xxxxx1xxp\\\\\\", \\\\\\"sandboxSpecification\\\\\\": \\\\\\"MYSQL_1C_1M_SD\\\\\\", \\\\\\"status\\\\\\": \\\\\\"running\\\\\\", \\\\\\"vpcSwitchId\\\\\\": \\\\\\"vsw-bp1bxxxxxumxxxxxwxx2w\\\\\\" } ], \\\\\\"totalElements\\\\\\": 1 }\\",\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>96A7FD36-9C81-5AA1-A605-C98ED00B0931</RequestId>\\n<Data>\\n <number>2</number>\\n <size>2</size>\\n <content>\\n <connectionString>172.27.135.92:3306</connectionString>\\n <restoreSeconds>64</restoreSeconds>\\n <restoreTime>2021-08-16T13:25:21Z</restoreTime>\\n <instanceId>1jxxxxx9xxxxh</instanceId>\\n <backupSetId>BINLOG_1hxxxx8xxxxxa_20210811152624_mysql-bin.000031</backupSetId>\\n <createTime>2021-08-16T13:43:09Z</createTime>\\n <backupPlanId>1hxxxx8xxxxxa</backupPlanId>\\n <vpcId>vpc-bp1dxxxxxjy0xxxxx1xxp</vpcId>\\n <sandboxSpecification>MYSQL_1C_1M_SD</sandboxSpecification>\\n <status>running</status>\\n <vpcSwitchId>vsw-bp1bxxxxxumxxxxxwxxx9</vpcSwitchId>\\n </content>\\n <content>\\n <connectionString>172.26.178.229:3306</connectionString>\\n <restoreSeconds>15</restoreSeconds>\\n <restoreTime>2021-08-11T07:26:24Z</restoreTime>\\n <instanceId>1jxxxxx9xxxms</instanceId>\\n <backupSetId>1hxxxx8xxxxxa_20210811152624</backupSetId>\\n <createTime>2021-08-12T07:40:29Z</createTime>\\n <backupPlanId>1hxxxx8xxxxxa</backupPlanId>\\n <vpcId>vpc-bp1dxxxxxjy0xxxxx1xxp</vpcId>\\n <sandboxSpecification>MYSQL_1C_1M_SD</sandboxSpecification>\\n <status>running</status>\\n <vpcSwitchId>vsw-bp1bxxxxxumxxxxxwxx2w</vpcSwitchId>\\n </content>\\n <totalElements>2</totalElements>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>\\n<ErrCode>Success</ErrCode>","errorExample":""}]',
],
'DescribeSandboxRecoveryTime' => [
'summary' => '查看沙箱实例的可恢复时间范围。',
'methods' => ['post', 'get'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'BackupPlanId',
'in' => 'query',
'schema' => ['description' => '备份计划ID,您可以通过[DescribeBackupPlanList](~~437215~~)接口获取该参数。获取到的备份计划ID传入时,必须去掉前缀dbs,否则将调用失败。'."\n"
."\n"
.'> 若您的实例为RDS MySQL,请通过[自动添加数据源](~~193091~~)功能,将RDS自动添加至DBS中,即可获取备份计划ID。', 'type' => 'string', 'required' => true, 'example' => '1jyjal15l****'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '4F1888AC-1138-4995-B9FE-D2734F61C058'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Success' => ['description' => '是否请求成功。', 'type' => 'string', 'example' => 'true'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Param.NotFound'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Data' => [
'description' => '返回参数。',
'type' => 'object',
'properties' => [
'RecoveryEndTime' => ['description' => '可恢复的截止时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。', 'type' => 'string', 'example' => '2021-08-02T12:01:01Z'],
'BackupPlanId' => ['description' => '沙箱实例的备份计划。', 'type' => 'string', 'example' => '1hxxxx8xxxxxa'],
'RecoveryBeginTime' => ['description' => '可恢复的开始时间,格式:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。', 'type' => 'string', 'example' => '2021-08-01T12:01:01Z'],
],
],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'title' => '查看可恢复时间范围',
'description' => '执行该操作前,您需要先开启数据库实例的沙箱功能,详情请参见[RDS MySQL应急恢复](~~203154~~)或[自建MySQL应急恢复(沙箱实例)](~~185577~~)。'."\n"
.'当前接口仅支持DBS API服务2021-01-01版本。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeSandboxRecoveryTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F1888AC-1138-4995-B9FE-D2734F61C058\\",\\n \\"ErrCode\\": \\"Param.NotFound\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Param.NotFound\\",\\n \\"Message\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Data\\": {\\n \\"RecoveryEndTime\\": \\"2021-08-02T12:01:01Z\\",\\n \\"BackupPlanId\\": \\"1hxxxx8xxxxxa\\",\\n \\"RecoveryBeginTime\\": \\"2021-08-01T12:01:01Z\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<RequestId>2FC5BFF1-C6AB-594A-9C54-34F9E3A67380</RequestId>\\n<Data>\\n <RecoveryEndTime>2021-08-30T10:49:18Z</RecoveryEndTime>\\n <RecoveryBeginTime>2021-08-23T13:25:12Z</RecoveryBeginTime>\\n <BackupPlanId>1hxxxx8xxxxxa</BackupPlanId>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>\\n<ErrCode>Success</ErrCode>","errorExample":""}]',
],
'ModifyBackupPolicy' => [
'summary' => '修改PolarDB实例备份策略。',
'methods' => ['post', 'get'],
'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '221284',
'abilityTreeNodes' => ['FEATUREcbsYWT1H7', 'FEATUREcbsPNQ3FN'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '备份集所在地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
],
[
'name' => 'PreferredBackupWindowBegin',
'in' => 'query',
'schema' => ['description' => '基础备份窗口开始时间。', 'type' => 'string', 'required' => false, 'example' => '17:00Z'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => 'PolarDB实例ID。', 'type' => 'string', 'required' => false, 'example' => 'pc-2ze3nrr64c5****'],
],
[
'name' => 'Category',
'in' => 'query',
'schema' => ['description' => '备份类型'."\n"
.'- **Flash**:秒级备份'."\n"
.'- **Standard**:普通备份', 'type' => 'string', 'required' => false, 'example' => 'Flash'],
],
[
'name' => 'AdvanceLogPolicies',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '备份策略目标地域。',
'type' => 'array',
'items' => [
'title' => '',
'description' => '备份策略源地域。',
'type' => 'object',
'properties' => [
'LogRetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'type' => 'string', 'required' => false, 'example' => 'Never'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level1'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'type' => 'string', 'required' => false, 'example' => 'crontab'],
'ActionType' => ['title' => '操作类型,CREATE,UPDATE,DELETE', 'description' => '操作类型,CREATE,UPDATE,DELETE', 'type' => 'string', 'required' => false, 'example' => 'CREATE'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源region', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'EnableLogBackup' => ['description' => '是否开启日志备份,返回值如下:'."\n"
."\n"
.'- **1**:开启'."\n"
.'- **0**:未开启', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'db'],
'LogRetentionValue' => ['title' => '过期天数', 'description' => '过期天数', 'type' => 'string', 'required' => false, 'example' => '30'],
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID', 'type' => 'string', 'required' => false, 'example' => '31289676-bb8d-4dee-b83e-******'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'type' => 'string', 'required' => false, 'example' => 'dayOfMonth'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标region', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '具体Filter的值', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'AdvanceDataPolicies',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '数据备份策略详情。',
'type' => 'array',
'items' => [
'title' => '',
'description' => '策略详情。',
'type' => 'object',
'properties' => [
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型,取值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level1'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型,取值如下:'."\n"
."\n"
.'- **crontab**:周期调度'."\n"
.'- **event**:事件调度', 'type' => 'string', 'required' => false, 'example' => 'crontab'],
'ActionType' => ['title' => '操作类型,CREATE,UPDATE,DELETE', 'description' => '操作类型,取值如下:'."\n"
."\n"
.'- **CREATE**:新增'."\n"
.'- **UPDATE**:修改'."\n"
.'- **DELETE**:删除', 'type' => 'string', 'required' => false, 'example' => 'UPDATE'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型,取值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'db'],
'OnlyPreserveOneEachDay' => ['title' => '一天之前的高频备份集,是否只保留每天一个', 'description' => '一天之前的高频备份集,是否只保留每天一个', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'RetentionValue' => ['title' => '过期天数', 'description' => '过期天数。', 'type' => 'string', 'required' => false, 'example' => '4'],
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID,可调用[DescribeBackupPolicy](~~2869783~~)查看。', 'type' => 'string', 'required' => false, 'example' => '6s67c7i3y8f8p72808p******'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,取值如下:'."\n"
."\n"
.'- **dayOfWeek**:按周调度'."\n"
.'- **dayOfMonth**:按月调度'."\n"
.'- **dayOfYear**:按年调度'."\n"
.'- **backupInterval**:固定间隔调度'."\n"
."\n"
.'> 仅当FilterType为**crontab**时,返回该参数。', 'type' => 'string', 'required' => false, 'example' => 'backupInterval'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标地域。', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '备份周期。', 'type' => 'string', 'required' => false, 'example' => '180'],
'RetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '备份集保留周期类型,取值如下:'."\n"
."\n"
.'- **never**:永不过期'."\n"
.'- **delay**:固定天数过期', 'type' => 'string', 'required' => false, 'example' => 'delay'],
'StorageClass' => ['description' => 'Bucket的存储类型。 取值范围如下:'."\n"
."\n"
.'- Standard(默认):标准存储'."\n"
.'- IA:低频访问'."\n"
.'- Archive:归档存储'."\n"
.'- ColdArchive:冷归档存储'."\n"
.'- DeepColdArchive:深度冷归档存储', 'type' => 'string', 'required' => false, 'example' => 'Standard'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'AdvanceIncPolicies',
'in' => 'query',
'style' => 'json',
'schema' => [
'description' => '备份策略目标region',
'type' => 'array',
'items' => [
'title' => '',
'description' => '备份策略源region',
'type' => 'object',
'properties' => [
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'level1'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'type' => 'string', 'required' => false, 'example' => 'crontab'],
'ActionType' => ['title' => '操作类型,CREATE,UPDATE,DELETE', 'description' => '操作类型,CREATE,UPDATE,DELETE', 'type' => 'string', 'required' => false, 'example' => 'CREATE'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源region', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'required' => false, 'example' => 'db'],
'OnlyPreserveOneEachDay' => ['title' => '一天之前的高频备份集,是否只保留每天一个', 'description' => '一天之前的高频备份集,是否只保留每天一个', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
'RetentionValue' => ['title' => '过期天数', 'description' => '过期天数', 'type' => 'string', 'required' => false, 'example' => '365'],
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID', 'type' => 'string', 'required' => false, 'example' => '1'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'type' => 'string', 'required' => false, 'example' => 'dayOfMonth'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标region', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '具体Filter的值', 'type' => 'string', 'required' => false, 'example' => '1'],
'RetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'type' => 'string', 'required' => false, 'example' => 'delay'],
],
'required' => false,
],
'required' => false,
],
],
[
'name' => 'BackupRetentionPolicyOnClusterDeletion',
'in' => 'query',
'schema' => ['description' => '已删除实例的归档备份保留策略,返回值如下:'."\n"
."\n"
.'- **NONE**:不保留'."\n"
.'- **LATEST**:保留最后一个'."\n"
.'- **ALL**:全部保留', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'BackupMethod',
'in' => 'query',
'schema' => ['description' => '备份方式,取值如下:'."\n"
.'- **logical**:逻辑备份'."\n"
.'- **physical**:物理备份', 'type' => 'string', 'required' => false, 'example' => 'logical'],
],
[
'name' => 'BackupPriority',
'in' => 'query',
'schema' => ['description' => '备库备份的设置策略,返回值如下:'."\n"
."\n"
.'- **1**:优先备库'."\n"
.'- **2**:强制主库'."\n"
."\n\n"
.'> 该参数仅适用于RDS SQL Server实例,其他引擎返回值为**0**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
'name' => 'EnableIncBackup',
'in' => 'query',
'schema' => ['description' => '是否开启增量备份。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'BackupRetentionPeriod',
'in' => 'query',
'schema' => ['title' => '备份保留天数', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
],
[
'name' => 'HighFrequencyBakInterval',
'in' => 'query',
'schema' => ['title' => '高频备份时间,分钟为单位,例如 120 表示每两小时备份一次', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
],
[
'name' => 'EnableLogBackup',
'in' => 'query',
'schema' => ['title' => '是否开启日志备份 1开 0关', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
[
'name' => 'LogBackupRetention',
'in' => 'query',
'schema' => ['title' => '日志备份保留周期', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
],
[
'name' => 'LogBackupLocalRetentionNumber',
'in' => 'query',
'schema' => ['title' => '本地日志保留个数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
[
'name' => 'LocalLogRetentionSpace',
'in' => 'query',
'schema' => ['title' => '本地日志最大空间使用率', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
],
[
'name' => 'HighSpaceUsageProtection',
'in' => 'query',
'schema' => [
'title' => '实例使用空间大于 80%,或者剩余空间小于 5 GB 时,是否强制清理日志:'."\n"
.'disable:不清理'."\n"
.'enable:清理'."\n",
'type' => 'string',
'example' => 'enable',
'enum' => ['enable', 'disable'],
],
],
[
'name' => 'IncBackupInterval',
'in' => 'query',
'schema' => ['title' => '高频增量备份间隔,单位分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
],
[
'name' => 'EnablePitrProtection',
'in' => 'query',
'schema' => ['title' => '是否开启任意时间点保护', 'type' => 'boolean'],
],
[
'name' => 'PreferredBackupDate',
'in' => 'query',
'schema' => ['title' => '基础备份的备份周期', 'type' => 'string', 'example' => '1111111'],
],
[
'name' => 'LogBackupLocalRetention',
'in' => 'query',
'schema' => ['title' => '本地日志保留时间,单位秒', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
],
[
'name' => 'ColdRetention',
'in' => 'query',
'schema' => ['title' => '冷归档保留天数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
[
'name' => 'ColdKeepCount',
'in' => 'query',
'schema' => ['title' => '冷归档个数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
[
'name' => 'ColdKeepPolicy',
'in' => 'query',
'schema' => [
'title' => '冷归档保留策略',
'type' => 'integer',
'format' => 'int32',
'example' => '0',
'enum' => ['0', '1', '2'],
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '返回参数详情。',
'type' => 'object',
'properties' => [
'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D570F209-A166-50C6-98A3-155A20B218B7'],
'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'instanceName can not be empty.'],
'Data' => [
'description' => '备份策略详情。',
'type' => 'object',
'properties' => [
'PreferredBackupWindowBegin' => ['title' => '基础备份窗口开始时间', 'description' => '基础备份窗口开始时间。', 'type' => 'string', 'example' => '17:00Z'],
'PreferredBackupWindow' => ['title' => '基础备份窗口', 'description' => '基础备份窗口。', 'type' => 'string', 'example' => '17:00Z-18:00Z'],
'Category' => ['description' => '是否开启秒级备份,返回值如下:'."\n"
."\n"
.'- **Flash**:已开启秒级备份'."\n"
.'- **Standard**:普通备份'."\n"
."\n"
.'> 该参数仅对MySQL生效。', 'type' => 'string', 'example' => 'Standard'],
'AdvanceLogPolicies' => [
'description' => '策略详情。',
'type' => 'array',
'items' => [
'description' => '策略详情。',
'type' => 'object',
'properties' => [
'LogRetentionType' => ['title' => '日志备份保留类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 按天过期', 'description' => '日志备份保留类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 按天过期', 'type' => 'string', 'example' => 'delay'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'FilterType' => ['description' => '高级策略筛选类型,返回值如下:'."\n"
."\n"
.'- **crontab**:周期调度'."\n"
.'- **event**:事件调度', 'type' => 'string', 'example' => 'crontab'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源region', 'type' => 'string', 'example' => 'cn-beijing'],
'EnableLogBackup' => ['description' => '预留参数,无需关注。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'PolicyId' => ['title' => '备份策略ID', 'description' => '备份策略ID', 'type' => 'string', 'example' => 'dc13b153acc91141789122c23835****'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标region', 'type' => 'string', 'example' => 'cn-shanghai'],
'LogRetentionValue' => ['title' => '日志备份保留时间', 'description' => '日志备份保留时间', 'type' => 'string', 'example' => '3'],
'FilterKey' => ['description' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'type' => 'string', 'example' => 'dayOfMonth'],
'FilterValue' => ['description' => '备份周期。', 'type' => 'string', 'example' => '1'],
],
],
],
'AdvanceDataPolicies' => [
'description' => '数据备份策略详情。',
'type' => 'array',
'items' => [
'description' => '策略详情。',
'type' => 'object',
'properties' => [
'RetentionValue' => ['title' => '过期天数', 'description' => '过期天数。', 'type' => 'string', 'example' => '4'],
'BakType' => ['title' => '备份类型 F - 全量 L 日志', 'description' => '备份类型,返回值如下:'."\n"
."\n"
.'- **F**:全量备份'."\n"
.'- **L**:日志备份', 'type' => 'string', 'example' => 'F'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,返回值如下:'."\n"
."\n"
.'- **dayOfWeek**:按周调度'."\n"
.'- **dayOfMonth**:按月调度'."\n"
.'- **dayOfYear**:按年调度'."\n"
.'- **backupInterval**:固定间隔调度'."\n"
."\n"
.'> 仅当FilterType为**crontab**时,返回该参数。', 'type' => 'string', 'example' => 'backupInterval'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '备份周期。', 'type' => 'string', 'example' => '180'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型,返回值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型,返回值如下:'."\n"
."\n"
.'- **crontab**:周期调度'."\n"
.'- **event**:事件调度', 'type' => 'string', 'example' => 'crontab'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
'AutoCreated' => ['title' => '是否系统自动生成', 'description' => '是否为系统自动生成的备份策略,返回值如下:'."\n"
."\n"
.'- **true**:系统生成策略'."\n"
.'- **false**:用户自定义策略', 'type' => 'boolean', 'example' => 'false'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型,返回值如下:'."\n"
."\n"
.'- **db**:数据库'."\n"
.'- **level1**:一级备份'."\n"
.'- **level2**:二级备份'."\n"
.'- **level2Cross**:二级跨地域备份', 'type' => 'string', 'example' => 'db'],
'OnlyPreserveOneEachDay' => ['description' => 'onlyPreserveOneEachDay'."\n"
.'- **true**:每天只保留一个'."\n"
.'- **false**:全保留', 'type' => 'boolean', 'example' => 'true'],
'DumpAction' => ['title' => '转储策略'."\n"
.' Copy - 复制'."\n"
.' Move - 转储', 'description' => '转储策略详情,返回值如下:'."\n"
."\n"
.'- **copy**:复制'."\n"
.'- **move**:转储', 'type' => 'string', 'example' => 'copy'],
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID。', 'type' => 'string', 'example' => 'dc13b153acc91141789122c23835****'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标地域。', 'type' => 'string', 'example' => 'cn-shanghai'],
'RetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '备份集保留周期类型,返回值如下:'."\n"
."\n"
.'- **never**:永不过期'."\n"
.'- **delay**:固定天数过期', 'type' => 'string', 'example' => 'delay'],
'StorageClass' => ['description' => '数据存储类型。', 'type' => 'string', 'example' => 'ARCHIVE'],
],
],
],
'AdvanceIncPolicies' => [
'description' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期',
'type' => 'array',
'items' => [
'description' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份',
'type' => 'object',
'properties' => [
'RetentionValue' => ['title' => '过期天数', 'description' => '过期天数', 'type' => 'string', 'example' => '365'],
'BakType' => ['title' => '备份类型 F - 全量 L 日志', 'description' => '备份类型 F - 全量 L 日志', 'type' => 'string', 'example' => 'F'],
'FilterKey' => ['title' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'description' => '调度类型,当前仅当filterType为crontab时有效'."\n"
.'dayOfWeek - 按周调度'."\n"
.'dayOfMonth - 按月调度'."\n"
.'dayOfYear - 按年调度'."\n"
.'backupInterval - 固定间隔调度', 'type' => 'string', 'example' => 'dayOfMonth'],
'FilterValue' => ['title' => '具体Filter的值', 'description' => '具体Filter的值', 'type' => 'string', 'example' => '1'],
'DestType' => ['title' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略目标类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'example' => 'level1'],
'FilterType' => ['title' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'description' => '高级策略筛选类型'."\n"
.' Crontab - 周期调度'."\n"
.' Event - 事件调度', 'type' => 'string', 'example' => 'Crontab'],
'SrcRegion' => ['title' => '备份策略源region', 'description' => '备份策略源region', 'type' => 'string', 'example' => 'cn-hangzhou'],
'AutoCreated' => ['title' => '是否系统自动生成', 'description' => '是否系统自动生成', 'type' => 'boolean', 'example' => 'true'],
'SrcType' => ['title' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'description' => '备份策略源类型'."\n"
.' db - 数据库'."\n"
.' level1 - 一级备份'."\n"
.' level2 - 二级备份'."\n"
.' level2Cross - 二级跨地域备份', 'type' => 'string', 'example' => 'db'],
'OnlyPreserveOneEachDay' => ['description' => '24小时备份保留策略。'."\n"
.'- **true**:超过24小时仅保留当天第1个备份集'."\n"
.'- **false**:全保留', 'type' => 'boolean', 'example' => 'true'],
'DumpAction' => ['title' => '转储策略'."\n"
.' Copy - 复制'."\n"
.' Move - 转储', 'description' => '转储策略'."\n"
.' Copy - 复制'."\n"
.' Move - 转储', 'type' => 'string', 'example' => 'Copy'],
'PolicyId' => ['title' => '高级策略ID', 'description' => '高级策略ID', 'type' => 'string', 'example' => 'smp-8sv763r9boydzb***'],
'DestRegion' => ['title' => '备份策略目标region', 'description' => '备份策略目标region', 'type' => 'string', 'example' => 'cn-hangzhou'],
'RetentionType' => ['title' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'description' => '保留周期类型'."\n"
.' Never - 永不过期'."\n"
.' Delay - 固定天数过期', 'type' => 'string', 'example' => 'Delay'],
],
],
],
'BackupRetentionPolicyOnClusterDeletion' => ['description' => '已删除实例的归档备份保留策略,返回值如下:'."\n"
."\n"
.'- **NONE**:不保留'."\n"
.'- **LATEST**:保留最后一个'."\n"
.'- **ALL**:全部保留', 'type' => 'string', 'example' => 'LATEST'],
'BackupMethod' => ['description' => '备份方式,返回值如下:'."\n"
."\n"
.'- **Physical**:物理备份'."\n"
.'- **Snapshot**:快照备份', 'type' => 'string', 'example' => 'Physical'],
'BackupPriority' => ['description' => '备库备份的设置策略,返回值如下:'."\n"
."\n"
.'- **1**:优先备库'."\n"
.'- **2**:强制主库'."\n"
."\n\n"
.'> 该参数仅适用于RDS SQL Server实例,其他引擎返回值为**0**。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'EnableIncBackup' => ['description' => '是否开启增量备份。', 'type' => 'boolean', 'example' => 'true'],
],
],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Code' => ['description' => '状态码。', 'type' => 'string', 'example' => 'Success'],
'Success' => ['description' => '请求是否成功,返回值如下:'."\n"
.'- **true**:请求成功'."\n"
.'- **false**:请求失败', 'type' => 'string', 'example' => 'true'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
],
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'staticInfo' => ['returnType' => 'synchronous'],
'eventInfo' => [
'enable' => false,
'eventNames' => [],
],
'title' => '修改备份策略',
'description' => '### 适用引擎'."\n"
.'PolarDB MySQL版'."\n"
."\n"
.'> 当前该接口仅针对特定客户开放使用,如有需求,请到DBS客户咨询群(钉钉群号:35585947)申请使用。',
'changeSet' => [
['createdAt' => '2024-09-24T08:37:35.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
['createdAt' => '2024-05-28T13:59:23.000Z', 'description' => '请求参数发生变更'],
],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'update',
'ramAction' => [
'action' => 'dbs:ModifyBackupPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D570F209-A166-50C6-98A3-155A20B218B7\\",\\n \\"Message\\": \\"instanceName can not be empty.\\",\\n \\"Data\\": {\\n \\"PreferredBackupWindowBegin\\": \\"17:00Z\\",\\n \\"PreferredBackupWindow\\": \\"17:00Z-18:00Z\\",\\n \\"Category\\": \\"Standard\\",\\n \\"AdvanceLogPolicies\\": [\\n {\\n \\"LogRetentionType\\": \\"delay\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"SrcRegion\\": \\"cn-beijing\\",\\n \\"EnableLogBackup\\": 1,\\n \\"SrcType\\": \\"level1\\",\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"LogRetentionValue\\": \\"3\\",\\n \\"FilterKey\\": \\"dayOfMonth\\",\\n \\"FilterValue\\": \\"1\\"\\n }\\n ],\\n \\"AdvanceDataPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"4\\",\\n \\"BakType\\": \\"F\\",\\n \\"FilterKey\\": \\"backupInterval\\",\\n \\"FilterValue\\": \\"180\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"crontab\\",\\n \\"SrcRegion\\": \\"cn-shanghai\\",\\n \\"AutoCreated\\": false,\\n \\"SrcType\\": \\"db\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"copy\\",\\n \\"PolicyId\\": \\"dc13b153acc91141789122c23835****\\",\\n \\"DestRegion\\": \\"cn-shanghai\\",\\n \\"RetentionType\\": \\"delay\\",\\n \\"StorageClass\\": \\"ARCHIVE\\"\\n }\\n ],\\n \\"AdvanceIncPolicies\\": [\\n {\\n \\"RetentionValue\\": \\"365\\",\\n \\"BakType\\": \\"F\\",\\n \\"FilterKey\\": \\"dayOfMonth\\",\\n \\"FilterValue\\": \\"1\\",\\n \\"DestType\\": \\"level1\\",\\n \\"FilterType\\": \\"Crontab\\",\\n \\"SrcRegion\\": \\"cn-hangzhou\\",\\n \\"AutoCreated\\": true,\\n \\"SrcType\\": \\"db\\",\\n \\"OnlyPreserveOneEachDay\\": true,\\n \\"DumpAction\\": \\"Copy\\",\\n \\"PolicyId\\": \\"smp-8sv763r9boydzb***\\",\\n \\"DestRegion\\": \\"cn-hangzhou\\",\\n \\"RetentionType\\": \\"Delay\\"\\n }\\n ],\\n \\"BackupRetentionPolicyOnClusterDeletion\\": \\"LATEST\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"BackupPriority\\": 1,\\n \\"EnableIncBackup\\": true\\n },\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrCode\\": \\"Success\\"\\n}","type":"json"}]',
],
'RetryDownloadTask' => [
'summary' => '重试失败的高级下载任务。',
'methods' => ['get', 'post'],
'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => ['FEATUREcbs04Q4EK'],
],
'parameters' => [
[
'name' => 'RegionCode',
'in' => 'query',
'schema' => ['description' => '实例所在地域ID,您可调用[DescribeDBInstanceAttribute(RDS实例)](~~26231~~)或[DescribeDBClusterAttribute(PolarDB实例)](~~2319132~~)查询。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'],
],
[
'name' => 'TaskId',
'in' => 'query',
'schema' => ['description' => '任务ID。', 'type' => 'string', 'required' => false, 'example' => 'dt-example'],
],
[
'name' => 'InstanceName',
'in' => 'query',
'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => false, 'example' => 'rm-example'],
],
[
'name' => 'ClusterName',
'in' => 'query',
'schema' => ['title' => '仅MongoDB依赖,分片集群的集群名', 'description' => '仅MongoDB依赖,分片集群的集群名', 'type' => 'string', 'required' => false, 'example' => 'dds-example'],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'Data' => ['description' => '下载任务详情。', 'type' => 'string', 'example' => '暂无'],
'RequestId' => ['description' => '请求id。', 'type' => 'string', 'example' => '49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX'],
'ErrCode' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
'Success' => ['description' => '是否成功。', 'type' => 'string', 'example' => 'True'],
'ErrMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The specified parameter %s value is not valid.'],
'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'Success'],
'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'instanceName can not be empty.'],
],
'description' => '',
],
],
],
'errorCodes' => [
403 => [
['errorCode' => 'Request.Forbidden', 'errorMessage' => 'Have no Permissions', 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
],
],
'title' => '重试高级下载任务',
'description' => '### 适用引擎'."\n"
."\n"
.'- RDS MySQL(云盘系列)'."\n"
.'- RDS PostgreSQL'."\n"
.'- PolarDB MySQL版'."\n"
.'- MongoDB'."\n"
."\n"
.'### 相关功能文档'."\n"
."\n"
.'- [RDS MySQL下载备份](~~98819~~)'."\n"
.'- [RDS PostgreSQL下载备份](~~96774~~)'."\n"
.'- [PolarDB MySQL版下载备份](~~2627635~~)'."\n"
.'- [MongoDB下载备份](~~55011~~)',
'changeSet' => [],
'flowControl' => [
'flowControlList' => [],
],
'ramActions' => [
[
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:RetryDownloadTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"暂无\\",\\n \\"RequestId\\": \\"49FE4E8E-39B9-56DE-BC07-5AEBFAXXXXXX\\",\\n \\"ErrCode\\": \\"Success\\",\\n \\"Success\\": \\"True\\",\\n \\"ErrMessage\\": \\"The specified parameter %s value is not valid.\\",\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"instanceName can not be empty.\\"\\n}","type":"json"}]',
],
],
'endpoints' => [
['regionId' => 'cn-wulanchabu', 'regionName' => '华北6(乌兰察布)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'dbs-api.cn-wulanchabu.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-wulanchabu.aliyuncs.com'],
['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-beijing.aliyuncs.com'],
['regionId' => 'cn-qingdao', 'regionName' => '华北1(青岛)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-qingdao.aliyuncs.com'],
['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shanghai.aliyuncs.com'],
['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-hongkong.aliyuncs.com'],
['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3(张家口)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-zhangjiakou.aliyuncs.com'],
['regionId' => 'cn-shenzhen', 'regionName' => '华南1(深圳)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shenzhen.aliyuncs.com'],
['regionId' => 'ap-northeast-1', 'regionName' => '日本(东京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.ap-northeast-1.aliyuncs.com', 'endpoint' => 'dbs-api.ap-northeast-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-northeast-1.aliyuncs.com'],
['regionId' => 'cn-chengdu', 'regionName' => '西南1(成都)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-chengdu.aliyuncs.com', 'endpoint' => 'dbs-api.cn-chengdu.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-chengdu.aliyuncs.com'],
['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dbs-api.ap-southeast-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-southeast-1.aliyuncs.com'],
['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚(吉隆坡)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.ap-southeast-3.aliyuncs.com', 'endpoint' => 'dbs-api.ap-southeast-3.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-southeast-3.aliyuncs.com'],
['regionId' => 'cn-huhehaote', 'regionName' => '华北5(呼和浩特)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-huhehaote.aliyuncs.com', 'endpoint' => 'dbs-api.cn-huhehaote.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-huhehaote.aliyuncs.com'],
['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚(雅加达)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.ap-southeast-5.aliyuncs.com', 'endpoint' => 'dbs-api.ap-southeast-5.aliyuncs.com', 'vpc' => 'dbs-api-vpc.ap-southeast-5.aliyuncs.com'],
['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-hangzhou.aliyuncs.com'],
['regionId' => 'us-east-1', 'regionName' => '美国(弗吉尼亚)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.us-east-1.aliyuncs.com'],
['regionId' => 'eu-west-1', 'regionName' => '英国(伦敦)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dbs-api.eu-west-1.aliyuncs.com', 'endpoint' => 'dbs-api.eu-west-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.eu-west-1.aliyuncs.com'],
['regionId' => 'us-west-1', 'regionName' => '美国(硅谷)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.us-west-1.aliyuncs.com'],
['regionId' => 'eu-central-1', 'regionName' => '德国(法兰克福)', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dbs-api.eu-central-1.aliyuncs.com', 'endpoint' => 'dbs-api.eu-central-1.aliyuncs.com', 'vpc' => 'dbs-api-vpc.eu-central-1.aliyuncs.com'],
['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shenzhen-finance-1.aliyuncs.com'],
['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => 'dbs-api-vpc.cn-shanghai-finance-1.aliyuncs.com'],
['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dbs-api.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
],
'errorCodes' => [
['code' => 'BackupPlanNotConfigure', 'message' => 'ConfigureBackupPlanRequest Error', 'http_code' => 200, 'description' => '备份计划配置错误'],
['code' => 'BackupPlanNotDescribe', 'message' => 'describe backup plan failed -> null', 'http_code' => 200, 'description' => '查询备份计划列表失败'],
['code' => 'BackupPlanNotModify', 'message' => 'modify backup source endpoint fail', 'http_code' => 200, 'description' => '修改备份源endpoint失败'],
['code' => 'DBS.DisasterCenter.NoPermission', 'message' => 'no permission for this action.', 'http_code' => 403, 'description' => '该操作无权限。'],
['code' => 'DBS.DownloadTask.BakSetError', 'message' => 'DBS download task bak set error. Your backup set does not meet the requirements.', 'http_code' => 200, 'description' => '您选择的备份集不满足高级下载要求。'],
['code' => 'DBS.DownloadTask.CannotFind', 'message' => 'Can not find download task.', 'http_code' => 200, 'description' => '无法找到高级下载任务。'],
['code' => 'DBS.DownloadTask.CustinIdNotSupport', 'message' => 'DBS DownloadTask CustinIdNotSupport.', 'http_code' => 200, 'description' => '高级下载实例暂不支持下载'],
['code' => 'DBS.DownloadTask.CustinNameNotSupport', 'message' => 'DBS DownloadTask CustinNameNotSupport.', 'http_code' => 200, 'description' => '高级下载实例暂不支持下载。'],
['code' => 'DBS.DownloadTask.DbTypeNotSupport', 'message' => 'DBS DownloadTask DbTypeNotSupport.', 'http_code' => 200, 'description' => '高级下载引擎类型暂不支持'],
['code' => 'DBS.DownloadTask.InstanceInfoNotSupport', 'message' => 'DBS DownloadTask InstanceInfoNotSupport.', 'http_code' => 200, 'description' => '高级下载当前实例不支持下载'],
['code' => 'DBS.DownloadTask.InstanceParamNotSupport', 'message' => 'DBS DownloadTask InstanceParamNotSupport.', 'http_code' => 200, 'description' => '高级下载实例暂不支持下载。'],
['code' => 'DBS.DownloadTask.InstanceStorageTypeNotSupport', 'message' => 'DBS DownloadTask InstanceStorageTypeNotSupport.', 'http_code' => 200, 'description' => '高级下载实例存储类型暂不支持下载。'],
['code' => 'DBS.DownloadTask.InstanceVersionNotSupport', 'message' => 'DBS DownloadTask InstanceVersionNotSupport.', 'http_code' => 200, 'description' => '高级下载引擎版本暂不支持下载。'],
['code' => 'DBS.DownloadTask.JobAlreadyExist', 'message' => 'Job already submit in recent days, please check it.', 'http_code' => 200, 'description' => '相同备份集的高级下载任务在近几天被提交过,请检查。'],
['code' => 'DBS.DownloadTask.NotSupport', 'message' => 'DBS DownloadTask NotSupport.', 'http_code' => 200, 'description' => '高级下载暂不支持下载。'],
['code' => 'DBS.DownloadTask.OnlyOneRunningOrFailedTask', 'message' => 'There can be only one running or failed task for the instance.', 'http_code' => 200, 'description' => '当前实例只能同时存在一个运行中/失败的任务。'],
['code' => 'DBS.DownloadTask.OssForbid', 'message' => 'OSS is forbidden to access. Please check your OSS bucket.', 'http_code' => 200, 'description' => '访问OSS被拒绝。请检查您的OSS权限配置。'],
['code' => 'DBS.DownloadTask.OssStorageTypeInvalid', 'message' => 'Unsupported bucket storage. Please make sure that your OSS bucket\'s storgae type is standard.', 'http_code' => 200, 'description' => '当前OSS bucket类型不支持。请确保您的OSS bucket类型是标准存储类型。'],
['code' => 'DBS.DownloadTask.RegionNotSupport', 'message' => 'DBS DownloadTask RegionNotSupport.', 'http_code' => 200, 'description' => '高级下载地域暂不支持'],
['code' => 'DBS.DownloadTask.UserNotSupport', 'message' => 'DBS DownloadTask UserNotSupport.', 'http_code' => 200, 'description' => '高级下载用户暂不支持下载'],
['code' => 'DBS.NoPermissionException', 'message' => 'Rejected by ValidationChecker.', 'http_code' => 403, 'description' => 'Rejected by ValidationChecker.'],
['code' => 'DBS.NotExists', 'message' => 'data source do not existed.', 'http_code' => 404, 'description' => 'DBS.NotExists'],
['code' => 'DBS.RegionNotSupport', 'message' => 'Request region is not allowed in current gateway.', 'http_code' => 400, 'description' => '当前请求访问了错误的endpoint'],
['code' => 'Forbidden.InstanceNotFound', 'message' => 'instance not found', 'http_code' => 200, 'description' => '实例不存在'],
['code' => 'InternalError', 'message' => 'internal error', 'http_code' => 500, 'description' => '内部错误'],
['code' => 'OperationDenied.JobStatus', 'message' => 'The operation is not permitted.', 'http_code' => 200, 'description' => '当前操作不被允许'],
['code' => 'Request.Forbidden', 'message' => 'Have no Permissions', 'http_code' => 403, 'description' => '当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作'],
['code' => 'UserError', 'message' => 'user error', 'http_code' => 200, 'description' => '用户使用问题'],
['code' => 'UserError', 'message' => 'You must first activate OSS before using DBS to OSS.', 'http_code' => 403, 'description' => 'You must first activate OSS before using DBS -> OSS.'],
],
'changeSet' => [
[
'apis' => [
['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ModifyBackupPolicy'],
],
'createdAt' => '2024-09-24T08:37:03.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'],
['description' => '请求参数发生变更', 'api' => 'ModifyBackupPolicy'],
],
'createdAt' => '2024-05-28T13:59:17.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeBackupPolicy'],
],
'createdAt' => '2024-05-16T11:16:56.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'ChangeResourceGroup'],
],
'createdAt' => '2023-12-21T13:43:30.000Z',
'description' => '',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'CreateSandboxInstance'],
['description' => '请求参数发生变更', 'api' => 'DeleteSandboxInstance'],
],
'createdAt' => '2023-08-18T07:28:29.000Z',
'description' => '',
],
[
'apis' => [
['description' => '响应参数发生变更', 'api' => 'DescribeDownloadTask'],
],
'createdAt' => '2022-11-16T11:45:26.000Z',
'description' => 'DescribeDownloadTask更新,修改分页相关返回字段名',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeDBTablesRecoveryBackupSet'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeDBTablesRecoveryState'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeDBTablesRecoveryTimeRange'],
['description' => 'OpenAPI 下线', 'api' => 'ModifyDBTablesRecoveryState'],
['description' => 'OpenAPI 下线', 'api' => 'SupportDBTableRecovery'],
],
'createdAt' => '2022-10-18T14:32:36.000Z',
'description' => '极速库表恢复openapi',
],
[
'apis' => [
['description' => '请求参数发生变更', 'api' => 'DescribeDownloadBackupSetStorageInfo'],
['description' => '请求参数发生变更', 'api' => 'DescribeDownloadSupport'],
],
'createdAt' => '2022-08-25T07:44:08.000Z',
'description' => '修改参数必填属性',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeDownloadBackupSetStorageInfo'],
['description' => 'OpenAPI 下线', 'api' => 'DescribeDownloadSupport'],
],
'createdAt' => '2022-08-03T09:24:36.000Z',
'description' => 'DBS高级下载V3.2发布',
],
[
'apis' => [
['description' => 'OpenAPI 下线', 'api' => 'DescribeAvailableCrossRegion'],
],
'createdAt' => '2022-07-15T06:34:03.000Z',
'description' => '发布新接口',
],
],
'flowControl' => [
'flowControlList' => [
['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
['threshold' => '400', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDownloadSupport'],
],
],
'ram' => [
'productCode' => 'DBS',
'productName' => '数据库备份',
'ramCodes' => ['dbs'],
'ramLevel' => '资源级',
'ramConditions' => [],
'ramActions' => [
[
'apiName' => 'DescribeSandboxBackupSets',
'description' => '查询快照列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeSandboxBackupSets',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeBackupDataList',
'description' => '查询备份数据',
'operationType' => 'list',
'ramAction' => [
'action' => 'dbs:DescribeBackupDataList',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'conditional', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
[
'apiName' => 'RetryDownloadTask',
'description' => '重试高级下载任务',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:RetryDownloadTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ModifyBackupPolicy',
'description' => '修改备份策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'dbs:ModifyBackupPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateDownload',
'description' => '创建下载任务',
'operationType' => 'create',
'ramAction' => [
'action' => 'dbs:CreateDownload',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
[
'apiName' => 'DescribeBackupPolicy',
'description' => '查询备份策略',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeBackupPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'ChangeResourceGroup',
'description' => 'DBS资源转组API',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:ChangeResourceGroup',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSandboxRecoveryTime',
'description' => '查看可恢复时间范围',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeSandboxRecoveryTime',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeSandboxInstances',
'description' => '查看沙箱实例列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeSandboxInstances',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'CreateAdvancedPolicy',
'description' => '开启高级备份策略',
'operationType' => 'update',
'ramAction' => [
'action' => 'dbs:CreateAdvancedPolicy',
'authLevel' => 'operate',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DeleteSandboxInstance',
'description' => '释放沙箱实例',
'operationType' => 'delete',
'ramAction' => [
'action' => 'dbs:DeleteSandboxInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeCostInfoByDbsInstance',
'description' => '根据dbs实例id获取收费详情。',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeCostInfoByDbsInstance',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
[
'apiName' => 'DescribeDownloadSupport',
'description' => '查询当前实例是否支持高级下载',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeDownloadSupport',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'],
],
],
],
[
'apiName' => 'DescribeDownloadBackupSetStorageInfo',
'description' => '查看下载备份集的存储信息',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeDownloadBackupSetStorageInfo',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'],
],
],
],
[
'apiName' => 'DescribeDownloadTask',
'description' => '查询下载任务列表',
'operationType' => 'get',
'ramAction' => [
'action' => 'dbs:DescribeDownloadTask',
'authLevel' => 'resource',
'actionConditions' => [],
'resources' => [
['validationType' => 'always', 'product' => 'DBS', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
],
],
],
],
'resourceTypes' => [
['validationType' => 'conditional', 'resourceType' => 'DBInstance', 'arn' => 'acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}'],
['validationType' => 'always', 'resourceType' => 'BackupPlan', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:backupplan/{#BackupPlanId}'],
['validationType' => 'always', 'resourceType' => 'DataSource', 'arn' => 'acs:dbs:{#regionId}:{#accountId}:'],
],
],
];
|