Revision 27d75ee0
b/doc/rapi.rst | ||
---|---|---|
357 | 357 |
|
358 | 358 |
Cluster information resource. |
359 | 359 |
|
360 |
It supports the following commands: ``GET``. |
|
360 |
.. rapi_resource_details:: /2/info |
|
361 |
|
|
361 | 362 |
|
362 | 363 |
.. _rapi-res-info+get: |
363 | 364 |
|
... | ... | |
406 | 407 |
|
407 | 408 |
Redistribute configuration to all nodes. |
408 | 409 |
|
409 |
It supports the following commands: ``PUT``.
|
|
410 |
.. rapi_resource_details:: /2/redistribute-config
|
|
410 | 411 |
|
411 | 412 |
|
412 | 413 |
.. _rapi-res-redistribute-config+put: |
... | ... | |
426 | 427 |
``/2/features`` |
427 | 428 |
+++++++++++++++ |
428 | 429 |
|
430 |
.. rapi_resource_details:: /2/features |
|
431 |
|
|
429 | 432 |
|
430 | 433 |
.. _rapi-res-features+get: |
431 | 434 |
|
... | ... | |
461 | 464 |
|
462 | 465 |
Modifies cluster parameters. |
463 | 466 |
|
464 |
Supports the following commands: ``PUT``.
|
|
467 |
.. rapi_resource_details:: /2/modify
|
|
465 | 468 |
|
466 | 469 |
|
467 | 470 |
.. _rapi-res-modify+put: |
... | ... | |
487 | 490 |
|
488 | 491 |
The groups resource. |
489 | 492 |
|
490 |
It supports the following commands: ``GET``, ``POST``. |
|
493 |
.. rapi_resource_details:: /2/groups |
|
494 |
|
|
491 | 495 |
|
492 | 496 |
.. _rapi-res-groups+get: |
493 | 497 |
|
... | ... | |
572 | 576 |
|
573 | 577 |
Returns information about a node group. |
574 | 578 |
|
575 |
It supports the following commands: ``GET``, ``DELETE``. |
|
579 |
.. rapi_resource_details:: /2/groups/[group_name] |
|
580 |
|
|
576 | 581 |
|
577 | 582 |
.. _rapi-res-groups-group_name+get: |
578 | 583 |
|
... | ... | |
605 | 610 |
|
606 | 611 |
Modifies the parameters of a node group. |
607 | 612 |
|
608 |
Supports the following commands: ``PUT``. |
|
613 |
.. rapi_resource_details:: /2/groups/[group_name]/modify |
|
614 |
|
|
609 | 615 |
|
610 | 616 |
.. _rapi-res-groups-group_name-modify+put: |
611 | 617 |
|
... | ... | |
631 | 637 |
|
632 | 638 |
Renames a node group. |
633 | 639 |
|
634 |
Supports the following commands: ``PUT``. |
|
640 |
.. rapi_resource_details:: /2/groups/[group_name]/rename |
|
641 |
|
|
635 | 642 |
|
636 | 643 |
.. _rapi-res-groups-group_name-rename+put: |
637 | 644 |
|
... | ... | |
657 | 664 |
|
658 | 665 |
Assigns nodes to a group. |
659 | 666 |
|
660 |
Supports the following commands: ``PUT``.
|
|
667 |
.. rapi_resource_details:: /2/groups/[group_name]/assign-nodes
|
|
661 | 668 |
|
662 | 669 |
.. _rapi-res-groups-group_name-assign-nodes+put: |
663 | 670 |
|
... | ... | |
682 | 689 |
|
683 | 690 |
Manages per-nodegroup tags. |
684 | 691 |
|
685 |
Supports the following commands: ``GET``, ``PUT``, ``DELETE``. |
|
692 |
.. rapi_resource_details:: /2/groups/[group_name]/tags |
|
693 |
|
|
686 | 694 |
|
687 | 695 |
.. _rapi-res-groups-group_name-tags+get: |
688 | 696 |
|
... | ... | |
730 | 738 |
|
731 | 739 |
The networks resource. |
732 | 740 |
|
733 |
It supports the following commands: ``GET``, ``POST``.
|
|
741 |
.. rapi_resource_details:: /2/networks
|
|
734 | 742 |
|
735 | 743 |
|
736 | 744 |
.. _rapi-res-networks+get: |
... | ... | |
810 | 818 |
|
811 | 819 |
Returns information about a network. |
812 | 820 |
|
813 |
It supports the following commands: ``GET``, ``DELETE``.
|
|
821 |
.. rapi_resource_details:: /2/networks/[network_name]
|
|
814 | 822 |
|
815 | 823 |
|
816 | 824 |
.. _rapi-res-networks-network_name+get: |
... | ... | |
845 | 853 |
|
846 | 854 |
Modifies the parameters of a network. |
847 | 855 |
|
848 |
Supports the following commands: ``PUT``.
|
|
856 |
.. rapi_resource_details:: /2/networks/[network_name]/modify
|
|
849 | 857 |
|
850 | 858 |
|
851 | 859 |
.. _rapi-res-networks-network_name-modify+put: |
... | ... | |
871 | 879 |
|
872 | 880 |
Connects a network to a nodegroup. |
873 | 881 |
|
874 |
Supports the following commands: ``PUT``.
|
|
882 |
.. rapi_resource_details:: /2/networks/[network_name]/connect
|
|
875 | 883 |
|
876 | 884 |
|
877 | 885 |
.. _rapi-res-networks-network_name-connect+put: |
... | ... | |
897 | 905 |
|
898 | 906 |
Disonnects a network from a nodegroup. |
899 | 907 |
|
900 |
Supports the following commands: ``PUT``.
|
|
908 |
.. rapi_resource_details:: /2/networks/[network_name]/disconnect
|
|
901 | 909 |
|
902 | 910 |
|
903 | 911 |
.. _rapi-res-networks-network_name-disconnect+put: |
... | ... | |
923 | 931 |
|
924 | 932 |
Manages per-network tags. |
925 | 933 |
|
926 |
Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
|
|
934 |
.. rapi_resource_details:: /2/networks/[network_name]/tags
|
|
927 | 935 |
|
928 | 936 |
|
929 | 937 |
.. _rapi-res-networks-network_name-tags+get: |
... | ... | |
973 | 981 |
|
974 | 982 |
Tries to allocate multiple instances. |
975 | 983 |
|
976 |
It supports the following commands: ``POST``
|
|
984 |
.. rapi_resource_details:: /2/instances-multi-alloc
|
|
977 | 985 |
|
978 | 986 |
|
979 | 987 |
.. _rapi-res-instances-multi-alloc+post: |
... | ... | |
997 | 1005 |
|
998 | 1006 |
The instances resource. |
999 | 1007 |
|
1000 |
It supports the following commands: ``GET``, ``POST``.
|
|
1008 |
.. rapi_resource_details:: /2/instances
|
|
1001 | 1009 |
|
1002 | 1010 |
|
1003 | 1011 |
.. _rapi-res-instances+get: |
... | ... | |
1096 | 1104 |
|
1097 | 1105 |
Instance-specific resource. |
1098 | 1106 |
|
1099 |
It supports the following commands: ``GET``, ``DELETE``.
|
|
1107 |
.. rapi_resource_details:: /2/instances/[instance_name]
|
|
1100 | 1108 |
|
1101 | 1109 |
|
1102 | 1110 |
.. _rapi-res-instances-instance_name+get: |
... | ... | |
1129 | 1137 |
``/2/instances/[instance_name]/info`` |
1130 | 1138 |
+++++++++++++++++++++++++++++++++++++++ |
1131 | 1139 |
|
1132 |
It supports the following commands: ``GET``.
|
|
1140 |
.. rapi_resource_details:: /2/instances/[instance_name]/info
|
|
1133 | 1141 |
|
1134 | 1142 |
|
1135 | 1143 |
.. _rapi-res-instances-instance_name-info+get: |
... | ... | |
1154 | 1162 |
|
1155 | 1163 |
Reboots URI for an instance. |
1156 | 1164 |
|
1157 |
It supports the following commands: ``POST``.
|
|
1165 |
.. rapi_resource_details:: /2/instances/[instance_name]/reboot
|
|
1158 | 1166 |
|
1159 | 1167 |
|
1160 | 1168 |
.. _rapi-res-instances-instance_name-reboot+post: |
... | ... | |
1191 | 1199 |
|
1192 | 1200 |
Instance shutdown URI. |
1193 | 1201 |
|
1194 |
It supports the following commands: ``PUT``.
|
|
1202 |
.. rapi_resource_details:: /2/instances/[instance_name]/shutdown
|
|
1195 | 1203 |
|
1196 | 1204 |
|
1197 | 1205 |
.. _rapi-res-instances-instance_name-shutdown+put: |
... | ... | |
1218 | 1226 |
|
1219 | 1227 |
Instance startup URI. |
1220 | 1228 |
|
1221 |
It supports the following commands: ``PUT``.
|
|
1229 |
.. rapi_resource_details:: /2/instances/[instance_name]/startup
|
|
1222 | 1230 |
|
1223 | 1231 |
|
1224 | 1232 |
.. _rapi-res-instances-instance_name-startup+put: |
... | ... | |
1245 | 1253 |
|
1246 | 1254 |
Installs the operating system again. |
1247 | 1255 |
|
1248 |
It supports the following commands: ``POST``.
|
|
1256 |
.. rapi_resource_details:: /2/instances/[instance_name]/reinstall
|
|
1249 | 1257 |
|
1250 | 1258 |
|
1251 | 1259 |
.. _rapi-res-instances-instance_name-reinstall+post: |
... | ... | |
1276 | 1284 |
|
1277 | 1285 |
Replaces disks on an instance. |
1278 | 1286 |
|
1279 |
It supports the following commands: ``POST``.
|
|
1287 |
.. rapi_resource_details:: /2/instances/[instance_name]/replace-disks
|
|
1280 | 1288 |
|
1281 | 1289 |
|
1282 | 1290 |
.. _rapi-res-instances-instance_name-replace-disks+post: |
... | ... | |
1306 | 1314 |
|
1307 | 1315 |
Activate disks on an instance. |
1308 | 1316 |
|
1309 |
It supports the following commands: ``PUT``.
|
|
1317 |
.. rapi_resource_details:: /2/instances/[instance_name]/activate-disks
|
|
1310 | 1318 |
|
1311 | 1319 |
|
1312 | 1320 |
.. _rapi-res-instances-instance_name-activate-disks+put: |
... | ... | |
1329 | 1337 |
|
1330 | 1338 |
Deactivate disks on an instance. |
1331 | 1339 |
|
1332 |
It supports the following commands: ``PUT``.
|
|
1340 |
.. rapi_resource_details:: /2/instances/[instance_name]/deactivate-disks
|
|
1333 | 1341 |
|
1334 | 1342 |
|
1335 | 1343 |
.. _rapi-res-instances-instance_name-deactivate-disks+put: |
... | ... | |
1349 | 1357 |
``/2/instances/[instance_name]/recreate-disks`` |
1350 | 1358 |
+++++++++++++++++++++++++++++++++++++++++++++++++ |
1351 | 1359 |
|
1352 |
Recreate disks of an instance. Supports the following commands: |
|
1353 |
``POST``. |
|
1360 |
Recreate disks of an instance. |
|
1361 |
|
|
1362 |
.. rapi_resource_details:: /2/instances/[instance_name]/recreate-disks |
|
1354 | 1363 |
|
1355 | 1364 |
|
1356 | 1365 |
.. _rapi-res-instances-instance_name-recreate-disks+post: |
... | ... | |
1377 | 1386 |
|
1378 | 1387 |
Grows one disk of an instance. |
1379 | 1388 |
|
1380 |
Supports the following commands: ``POST``.
|
|
1389 |
.. rapi_resource_details:: /2/instances/[instance_name]/disk/[disk_index]/grow
|
|
1381 | 1390 |
|
1382 | 1391 |
|
1383 | 1392 |
.. _rapi-res-instances-instance_name-disk-disk_index-grow+post: |
... | ... | |
1404 | 1413 |
|
1405 | 1414 |
Prepares an export of an instance. |
1406 | 1415 |
|
1407 |
It supports the following commands: ``PUT``.
|
|
1416 |
.. rapi_resource_details:: /2/instances/[instance_name]/prepare-export
|
|
1408 | 1417 |
|
1409 | 1418 |
|
1410 | 1419 |
.. _rapi-res-instances-instance_name-prepare-export+put: |
... | ... | |
1426 | 1435 |
|
1427 | 1436 |
Exports an instance. |
1428 | 1437 |
|
1429 |
It supports the following commands: ``PUT``.
|
|
1438 |
.. rapi_resource_details:: /2/instances/[instance_name]/export
|
|
1430 | 1439 |
|
1431 | 1440 |
|
1432 | 1441 |
.. _rapi-res-instances-instance_name-export+put: |
... | ... | |
1454 | 1463 |
|
1455 | 1464 |
Migrates an instance. |
1456 | 1465 |
|
1457 |
Supports the following commands: ``PUT``.
|
|
1466 |
.. rapi_resource_details:: /2/instances/[instance_name]/migrate
|
|
1458 | 1467 |
|
1459 | 1468 |
|
1460 | 1469 |
.. _rapi-res-instances-instance_name-migrate+put: |
... | ... | |
1481 | 1490 |
|
1482 | 1491 |
Does a failover of an instance. |
1483 | 1492 |
|
1484 |
Supports the following commands: ``PUT``.
|
|
1493 |
.. rapi_resource_details:: /2/instances/[instance_name]/failover
|
|
1485 | 1494 |
|
1486 | 1495 |
|
1487 | 1496 |
.. _rapi-res-instances-instance_name-failover+put: |
... | ... | |
1508 | 1517 |
|
1509 | 1518 |
Renames an instance. |
1510 | 1519 |
|
1511 |
Supports the following commands: ``PUT``.
|
|
1520 |
.. rapi_resource_details:: /2/instances/[instance_name]/rename
|
|
1512 | 1521 |
|
1513 | 1522 |
|
1514 | 1523 |
.. _rapi-res-instances-instance_name-rename+put: |
... | ... | |
1535 | 1544 |
|
1536 | 1545 |
Modifies an instance. |
1537 | 1546 |
|
1538 |
Supports the following commands: ``PUT``.
|
|
1547 |
.. rapi_resource_details:: /2/instances/[instance_name]/modify
|
|
1539 | 1548 |
|
1540 | 1549 |
|
1541 | 1550 |
.. _rapi-res-instances-instance_name-modify+put: |
... | ... | |
1562 | 1571 |
|
1563 | 1572 |
Request information for connecting to instance's console. |
1564 | 1573 |
|
1565 |
.. pyassert:: |
|
1566 |
|
|
1567 |
not (hasattr(rlib2.R_2_instances_name_console, "PUT") or |
|
1568 |
hasattr(rlib2.R_2_instances_name_console, "POST") or |
|
1569 |
hasattr(rlib2.R_2_instances_name_console, "DELETE")) |
|
1570 |
|
|
1571 |
Supports the following commands: ``GET``. Requires authentication with |
|
1572 |
one of the following options: |
|
1573 |
:pyeval:`utils.CommaJoin(rlib2.R_2_instances_name_console.GET_ACCESS)`. |
|
1574 |
.. rapi_resource_details:: /2/instances/[instance_name]/console |
|
1574 | 1575 |
|
1575 | 1576 |
|
1576 | 1577 |
.. _rapi-res-instances-instance_name-console+get: |
... | ... | |
1633 | 1634 |
|
1634 | 1635 |
Manages per-instance tags. |
1635 | 1636 |
|
1636 |
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
|
|
1637 |
.. rapi_resource_details:: /2/instances/[instance_name]/tags
|
|
1637 | 1638 |
|
1638 | 1639 |
|
1639 | 1640 |
.. _rapi-res-instances-instance_name-tags+get: |
... | ... | |
1683 | 1684 |
|
1684 | 1685 |
The ``/2/jobs`` resource. |
1685 | 1686 |
|
1686 |
It supports the following commands: ``GET``.
|
|
1687 |
.. rapi_resource_details:: /2/jobs
|
|
1687 | 1688 |
|
1688 | 1689 |
|
1689 | 1690 |
.. _rapi-res-jobs+get: |
... | ... | |
1709 | 1710 |
``/2/jobs/[job_id]`` |
1710 | 1711 |
++++++++++++++++++++ |
1711 | 1712 |
|
1712 |
|
|
1713 | 1713 |
Individual job URI. |
1714 | 1714 |
|
1715 |
It supports the following commands: ``GET``, ``DELETE``.
|
|
1715 |
.. rapi_resource_details:: /2/jobs/[job_id]
|
|
1716 | 1716 |
|
1717 | 1717 |
|
1718 | 1718 |
.. _rapi-res-jobs-job_id+get: |
... | ... | |
1816 | 1816 |
``/2/jobs/[job_id]/wait`` |
1817 | 1817 |
+++++++++++++++++++++++++ |
1818 | 1818 |
|
1819 |
.. rapi_resource_details:: /2/jobs/[job_id]/wait |
|
1820 |
|
|
1819 | 1821 |
|
1820 | 1822 |
.. _rapi-res-jobs-job_id-wait+get: |
1821 | 1823 |
|
... | ... | |
1846 | 1848 |
|
1847 | 1849 |
Nodes resource. |
1848 | 1850 |
|
1849 |
It supports the following commands: ``GET``.
|
|
1851 |
.. rapi_resource_details:: /2/nodes
|
|
1850 | 1852 |
|
1851 | 1853 |
|
1852 | 1854 |
.. _rapi-res-nodes+get: |
... | ... | |
1902 | 1904 |
|
1903 | 1905 |
Returns information about a node. |
1904 | 1906 |
|
1905 |
It supports the following commands: ``GET``.
|
|
1907 |
.. rapi_resource_details:: /2/nodes/[node_name]
|
|
1906 | 1908 |
|
1907 | 1909 |
|
1908 | 1910 |
.. _rapi-res-nodes-node_name+get: |
... | ... | |
1919 | 1921 |
``/2/nodes/[node_name]/powercycle`` |
1920 | 1922 |
+++++++++++++++++++++++++++++++++++ |
1921 | 1923 |
|
1922 |
Powercycles a node. Supports the following commands: ``POST``. |
|
1924 |
Powercycles a node. |
|
1925 |
|
|
1926 |
.. rapi_resource_details:: /2/nodes/[node_name]/powercycle |
|
1923 | 1927 |
|
1924 | 1928 |
|
1925 | 1929 |
.. _rapi-res-nodes-node_name-powercycle+post: |
... | ... | |
1941 | 1945 |
|
1942 | 1946 |
Evacuates instances off a node. |
1943 | 1947 |
|
1944 |
It supports the following commands: ``POST``.
|
|
1948 |
.. rapi_resource_details:: /2/nodes/[node_name]/evacuate
|
|
1945 | 1949 |
|
1946 | 1950 |
|
1947 | 1951 |
.. _rapi-res-nodes-node_name-evacuate+post: |
... | ... | |
1973 | 1977 |
|
1974 | 1978 |
Migrates all primary instances from a node. |
1975 | 1979 |
|
1976 |
It supports the following commands: ``POST``. |
|
1980 |
.. rapi_resource_details:: /2/nodes/[node_name]/migrate |
|
1981 |
|
|
1977 | 1982 |
|
1978 | 1983 |
.. _rapi-res-nodes-node_name-migrate+post: |
1979 | 1984 |
|
... | ... | |
2002 | 2007 |
|
2003 | 2008 |
Manages node role. |
2004 | 2009 |
|
2005 |
It supports the following commands: ``GET``, ``PUT``.
|
|
2010 |
.. rapi_resource_details:: /2/nodes/[node_name]/role
|
|
2006 | 2011 |
|
2007 | 2012 |
The role is always one of the following: |
2008 | 2013 |
|
... | ... | |
2050 | 2055 |
``/2/nodes/[node_name]/modify`` |
2051 | 2056 |
+++++++++++++++++++++++++++++++ |
2052 | 2057 |
|
2053 |
Modifies the parameters of a node. Supports the following commands: |
|
2054 |
``POST``. |
|
2058 |
Modifies the parameters of a node. |
|
2059 |
|
|
2060 |
.. rapi_resource_details:: /2/nodes/[node_name]/modify |
|
2055 | 2061 |
|
2056 | 2062 |
|
2057 | 2063 |
.. _rapi-res-nodes-node_name-modify+post: |
... | ... | |
2078 | 2084 |
|
2079 | 2085 |
Manages storage units on the node. |
2080 | 2086 |
|
2087 |
.. rapi_resource_details:: /2/nodes/[node_name]/storage |
|
2088 |
|
|
2089 |
|
|
2081 | 2090 |
.. _rapi-res-nodes-node_name-storage+get: |
2082 | 2091 |
|
2083 | 2092 |
``GET`` |
... | ... | |
2103 | 2112 |
|
2104 | 2113 |
Modifies storage units on the node. |
2105 | 2114 |
|
2115 |
.. rapi_resource_details:: /2/nodes/[node_name]/storage/modify |
|
2116 |
|
|
2106 | 2117 |
|
2107 | 2118 |
.. _rapi-res-nodes-node_name-storage-modify+put: |
2108 | 2119 |
|
... | ... | |
2128 | 2139 |
|
2129 | 2140 |
Repairs a storage unit on the node. |
2130 | 2141 |
|
2142 |
.. rapi_resource_details:: /2/nodes/[node_name]/storage/repair |
|
2143 |
|
|
2131 | 2144 |
|
2132 | 2145 |
.. _rapi-res-nodes-node_name-storage-repair+put: |
2133 | 2146 |
|
... | ... | |
2157 | 2170 |
|
2158 | 2171 |
Manages per-node tags. |
2159 | 2172 |
|
2160 |
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
|
|
2173 |
.. rapi_resource_details:: /2/nodes/[node_name]/tags
|
|
2161 | 2174 |
|
2162 | 2175 |
|
2163 | 2176 |
.. _rapi-res-nodes-node_name-tags+get: |
... | ... | |
2210 | 2223 |
:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the :doc:`query2 |
2211 | 2224 |
design document <design-query2>` for more details. |
2212 | 2225 |
|
2213 |
.. pyassert:: |
|
2214 |
|
|
2215 |
(rlib2.R_2_query.GET_ACCESS == rlib2.R_2_query.PUT_ACCESS and |
|
2216 |
not (hasattr(rlib2.R_2_query, "POST") or |
|
2217 |
hasattr(rlib2.R_2_query, "DELETE"))) |
|
2218 |
|
|
2219 |
Supports the following commands: ``GET``, ``PUT``. Requires |
|
2220 |
authentication with one of the following options: |
|
2221 |
:pyeval:`utils.CommaJoin(rlib2.R_2_query.GET_ACCESS)`. |
|
2226 |
.. rapi_resource_details:: /2/query/[resource] |
|
2222 | 2227 |
|
2223 | 2228 |
|
2224 | 2229 |
.. _rapi-res-query-resource+get: |
... | ... | |
2252 | 2257 |
:pyeval:`utils.CommaJoin(constants.QR_VIA_RAPI)`. See the |
2253 | 2258 |
:doc:`query2 design document <design-query2>` for more details. |
2254 | 2259 |
|
2255 |
Supports the following commands: ``GET``.
|
|
2260 |
.. rapi_resource_details:: /2/query/[resource]/fields
|
|
2256 | 2261 |
|
2257 | 2262 |
|
2258 | 2263 |
.. _rapi-res-query-resource-fields+get: |
... | ... | |
2272 | 2277 |
|
2273 | 2278 |
OS resource. |
2274 | 2279 |
|
2275 |
It supports the following commands: ``GET``.
|
|
2280 |
.. rapi_resource_details:: /2/os
|
|
2276 | 2281 |
|
2277 | 2282 |
|
2278 | 2283 |
.. _rapi-res-os+get: |
... | ... | |
2297 | 2302 |
|
2298 | 2303 |
Manages cluster tags. |
2299 | 2304 |
|
2300 |
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
|
|
2305 |
.. rapi_resource_details:: /2/tags
|
|
2301 | 2306 |
|
2302 | 2307 |
|
2303 | 2308 |
.. _rapi-res-tags+get: |
... | ... | |
2350 | 2355 |
This resource should be used to determine the remote API version and to |
2351 | 2356 |
adapt clients accordingly. |
2352 | 2357 |
|
2353 |
It supports the following commands: ``GET``. |
|
2358 |
.. rapi_resource_details:: /version |
|
2359 |
|
|
2354 | 2360 |
|
2355 | 2361 |
.. _rapi-res-version+get: |
2356 | 2362 |
|
Also available in: Unified diff