Has no function, but for legacy reasons the ``GET`` method is supported.
+.. _rapi-res-info:
+
``/2/info``
+++++++++++
It supports the following commands: ``GET``.
+.. _rapi-res-info+get:
+
``GET``
~~~~~~~
}
+.. _rapi-res-redistribute-config:
+
``/2/redistribute-config``
++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-redistribute-config+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_CLUSTER_REDIST_CONF
+.. _rapi-res-features:
+
``/2/features``
+++++++++++++++
+
+.. _rapi-res-features+get:
+
``GET``
~~~~~~~
a new-style result (see resource description)
+.. _rapi-res-modify:
+
``/2/modify``
++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-modify+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_CLUSTER_SET_PARAMS
+.. _rapi-res-groups:
+
``/2/groups``
+++++++++++++
It supports the following commands: ``GET``, ``POST``.
+.. _rapi-res-groups+get:
+
``GET``
~~~~~~~
…
]
+
+.. _rapi-res-groups+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_GROUP_ADD
+.. _rapi-res-groups-group_name:
+
``/2/groups/[group_name]``
++++++++++++++++++++++++++
It supports the following commands: ``GET``, ``DELETE``.
+.. _rapi-res-groups-group_name+get:
+
``GET``
~~~~~~~
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.G_FIELDS))`.
+.. _rapi-res-groups-group_name+delete:
+
``DELETE``
~~~~~~~~~~
.. opcode_result:: OP_GROUP_REMOVE
+.. _rapi-res-groups-group_name-modify:
+
``/2/groups/[group_name]/modify``
+++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+.. _rapi-res-groups-group_name-modify+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_GROUP_SET_PARAMS
+.. _rapi-res-groups-group_name-rename:
+
``/2/groups/[group_name]/rename``
+++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+.. _rapi-res-groups-group_name-rename+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_GROUP_RENAME
+.. _rapi-res-groups-group_name-assign-nodes:
+
``/2/groups/[group_name]/assign-nodes``
+++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+.. _rapi-res-groups-group_name-assign-nodes+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_GROUP_ASSIGN_NODES
+.. _rapi-res-groups-group_name-tags:
``/2/groups/[group_name]/tags``
+++++++++++++++++++++++++++++++
Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+.. _rapi-res-groups-group_name-tags+get:
+
``GET``
~~~~~~~
["tag1", "tag2", "tag3"]
+.. _rapi-res-groups-group_name-tags+put:
+
``PUT``
~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-groups-group_name-tags+delete:
+
``DELETE``
~~~~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-networks:
+
``/2/networks``
+++++++++++++++
It supports the following commands: ``GET``, ``POST``.
+
+.. _rapi-res-networks+get:
+
``GET``
~~~~~~~
…
]
+
+.. _rapi-res-networks+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_NETWORK_ADD
+.. _rapi-res-networks-network_name:
+
``/2/networks/[network_name]``
++++++++++++++++++++++++++++++
It supports the following commands: ``GET``, ``DELETE``.
+
+.. _rapi-res-networks-network_name+get:
+
``GET``
~~~~~~~
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.NET_FIELDS))`.
+
+.. _rapi-res-networks-network_name+delete:
+
``DELETE``
~~~~~~~~~~
.. opcode_result:: OP_NETWORK_REMOVE
+.. _rapi-res-networks-network_name-modify:
+
``/2/networks/[network_name]/modify``
+++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-networks-network_name-modify+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_NETWORK_SET_PARAMS
+.. _rapi-res-networks-network_name-connect:
+
``/2/networks/[network_name]/connect``
++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-networks-network_name-connect+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_NETWORK_CONNECT
+.. _rapi-res-networks-network_name-disconnect:
+
``/2/networks/[network_name]/disconnect``
+++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-networks-network_name-disconnect+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_NETWORK_DISCONNECT
+.. _rapi-res-networks-network_name-tags:
+
``/2/networks/[network_name]/tags``
+++++++++++++++++++++++++++++++++++
Supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+
+.. _rapi-res-networks-network_name-tags+get:
+
``GET``
~~~~~~~
["tag1", "tag2", "tag3"]
+
+.. _rapi-res-networks-network_name-tags+put:
+
``PUT``
~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-networks-network_name-tags+delete:
+
``DELETE``
~~~~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-instances-multi-alloc:
+
``/2/instances-multi-alloc``
++++++++++++++++++++++++++++
It supports the following commands: ``POST``
+
+.. _rapi-res-instances-multi-alloc+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_INSTANCE_MULTI_ALLOC
+.. _rapi-res-instances:
+
``/2/instances``
++++++++++++++++
It supports the following commands: ``GET``, ``POST``.
+
+.. _rapi-res-instances+get:
+
``GET``
~~~~~~~
]
+.. _rapi-res-instances+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_INSTANCE_CREATE
+.. _rapi-res-instances-instance_name:
+
``/2/instances/[instance_name]``
++++++++++++++++++++++++++++++++
It supports the following commands: ``GET``, ``DELETE``.
+
+.. _rapi-res-instances-instance_name+get:
+
``GET``
~~~~~~~
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.I_FIELDS))`.
+
+.. _rapi-res-instances-instance_name+delete:
+
``DELETE``
~~~~~~~~~~
.. opcode_result:: OP_INSTANCE_REMOVE
+.. _rapi-res-instances-instance_name-info:
+
``/2/instances/[instance_name]/info``
+++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``GET``.
+
+.. _rapi-res-instances-instance_name-info+get:
+
``GET``
~~~~~~~
.. opcode_result:: OP_INSTANCE_QUERY_DATA
+.. _rapi-res-instances-instance_name-reboot:
+
``/2/instances/[instance_name]/reboot``
+++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``POST``.
+
+.. _rapi-res-instances-instance_name-reboot+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_INSTANCE_REBOOT
+.. _rapi-res-instances-instance_name-shutdown:
+
``/2/instances/[instance_name]/shutdown``
+++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-shutdown+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_SHUTDOWN
+.. _rapi-res-instances-instance_name-startup:
+
``/2/instances/[instance_name]/startup``
++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-startup+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_STARTUP
+.. _rapi-res-instances-instance_name-reinstall:
+
``/2/instances/[instance_name]/reinstall``
++++++++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``POST``.
+
+.. _rapi-res-instances-instance_name-reinstall+post:
+
``POST``
~~~~~~~~
clients should use the body parameters.
+.. _rapi-res-instances-instance_name-replace-disks:
+
``/2/instances/[instance_name]/replace-disks``
++++++++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``POST``.
+
+.. _rapi-res-instances-instance_name-replace-disks+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_INSTANCE_REPLACE_DISKS
+.. _rapi-res-instances-instance_name-activate-disks:
+
``/2/instances/[instance_name]/activate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-activate-disks+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_ACTIVATE_DISKS
+.. _rapi-res-instances-instance_name-deactivate-disks:
+
``/2/instances/[instance_name]/deactivate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-deactivate-disks+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_DEACTIVATE_DISKS
+.. _rapi-res-instances-instance_name-recreate-disks:
+
``/2/instances/[instance_name]/recreate-disks``
+++++++++++++++++++++++++++++++++++++++++++++++++
Recreate disks of an instance. Supports the following commands:
``POST``.
+
+.. _rapi-res-instances-instance_name-recreate-disks+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_INSTANCE_RECREATE_DISKS
+.. _rapi-res-instances-instance_name-disk-disk_index-grow:
+
``/2/instances/[instance_name]/disk/[disk_index]/grow``
+++++++++++++++++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``POST``.
+
+.. _rapi-res-instances-instance_name-disk-disk_index-grow+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_INSTANCE_GROW_DISK
+.. _rapi-res-instances-instance_name-prepare-export:
+
``/2/instances/[instance_name]/prepare-export``
+++++++++++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-prepare-export+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_BACKUP_PREPARE
+.. _rapi-res-instances-instance_name-export:
+
``/2/instances/[instance_name]/export``
+++++++++++++++++++++++++++++++++++++++++++++++++
It supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-export+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_BACKUP_EXPORT
+.. _rapi-res-instances-instance_name-migrate:
+
``/2/instances/[instance_name]/migrate``
++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-migrate+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_MIGRATE
+.. _rapi-res-instances-instance_name-failover:
+
``/2/instances/[instance_name]/failover``
+++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-failover+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_FAILOVER
+.. _rapi-res-instances-instance_name-rename:
+
``/2/instances/[instance_name]/rename``
++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-rename+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_RENAME
+.. _rapi-res-instances-instance_name-modify:
+
``/2/instances/[instance_name]/modify``
++++++++++++++++++++++++++++++++++++++++
Supports the following commands: ``PUT``.
+
+.. _rapi-res-instances-instance_name-modify+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_INSTANCE_SET_PARAMS
+.. _rapi-res-instances-instance_name-console:
+
``/2/instances/[instance_name]/console``
++++++++++++++++++++++++++++++++++++++++
one of the following options:
:pyeval:`utils.CommaJoin(rlib2.R_2_instances_name_console.GET_ACCESS)`.
+
+.. _rapi-res-instances-instance_name-console+get:
+
``GET``
~~~~~~~
VNC display number (:pyeval:`constants.CONS_VNC` only)
+.. _rapi-res-instances-instance_name-tags:
+
``/2/instances/[instance_name]/tags``
+++++++++++++++++++++++++++++++++++++
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+
+.. _rapi-res-instances-instance_name-tags+get:
+
``GET``
~~~~~~~
["tag1", "tag2", "tag3"]
+
+.. _rapi-res-instances-instance_name-tags+put:
+
``PUT``
~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-instances-instance_name-tags+delete:
+
``DELETE``
~~~~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-jobs:
+
``/2/jobs``
+++++++++++
It supports the following commands: ``GET``.
+
+.. _rapi-res-jobs+get:
+
``GET``
~~~~~~~
fields are not the same as for per-job requests):
:pyeval:`utils.CommaJoin(sorted(rlib2.J_FIELDS_BULK))`.
+
+.. _rapi-res-jobs-job_id:
+
``/2/jobs/[job_id]``
++++++++++++++++++++
It supports the following commands: ``GET``, ``DELETE``.
+
+.. _rapi-res-jobs-job_id+get:
+
``GET``
~~~~~~~
while by a resource we refer to an instance's disk, or NIC, etc.
+.. _rapi-res-jobs-job_id+delete:
+
``DELETE``
~~~~~~~~~~
Cancel a not-yet-started job.
+.. _rapi-res-jobs-job_id-wait:
+
``/2/jobs/[job_id]/wait``
+++++++++++++++++++++++++
+
+.. _rapi-res-jobs-job_id-wait+get:
+
``GET``
~~~~~~~
``job_info`` and ``log_entries`` otherwise.
+.. _rapi-res-nodes:
+
``/2/nodes``
++++++++++++
It supports the following commands: ``GET``.
+
+.. _rapi-res-nodes+get:
+
``GET``
~~~~~~~
…
]
+
+.. _rapi-res-nodes-node_name:
+
``/2/nodes/[node_name]``
+++++++++++++++++++++++++++++++++
It supports the following commands: ``GET``.
+
+.. _rapi-res-nodes-node_name+get:
+
+``GET``
+~~~~~~~
+
Returned fields: :pyeval:`utils.CommaJoin(sorted(rlib2.N_FIELDS))`.
+
+
+.. _rapi-res-nodes-node_name-powercycle:
+
``/2/nodes/[node_name]/powercycle``
+++++++++++++++++++++++++++++++++++
Powercycles a node. Supports the following commands: ``POST``.
+
+.. _rapi-res-nodes-node_name-powercycle+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_NODE_POWERCYCLE
+.. _rapi-res-nodes-node_name-evacuate:
+
``/2/nodes/[node_name]/evacuate``
+++++++++++++++++++++++++++++++++
It supports the following commands: ``POST``.
+
+.. _rapi-res-nodes-node_name-evacuate+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_NODE_EVACUATE
+.. _rapi-res-nodes-node_name-migrate:
+
``/2/nodes/[node_name]/migrate``
+++++++++++++++++++++++++++++++++
It supports the following commands: ``POST``.
+.. _rapi-res-nodes-node_name-migrate+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_NODE_MIGRATE
+.. _rapi-res-nodes-node_name-role:
+
``/2/nodes/[node_name]/role``
+++++++++++++++++++++++++++++
modified via RAPI, only via the command line (``gnt-cluster
master-failover``).
+
+.. _rapi-res-nodes-node_name-role+get:
+
``GET``
~~~~~~~
"master-candidate"
+
+.. _rapi-res-nodes-node_name-role+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_NODE_SET_PARAMS
+.. _rapi-res-nodes-node_name-modify:
+
``/2/nodes/[node_name]/modify``
+++++++++++++++++++++++++++++++
Modifies the parameters of a node. Supports the following commands:
``POST``.
+
+.. _rapi-res-nodes-node_name-modify+post:
+
``POST``
~~~~~~~~
.. opcode_result:: OP_NODE_SET_PARAMS
+.. _rapi-res-nodes-node_name-storage:
+
``/2/nodes/[node_name]/storage``
++++++++++++++++++++++++++++++++
Manages storage units on the node.
+.. _rapi-res-nodes-node_name-storage+get:
+
``GET``
~~~~~~~
``output_fields``. The result will be a job id, using which the result
can be retrieved.
+
+.. _rapi-res-nodes-node_name-storage-modify:
+
``/2/nodes/[node_name]/storage/modify``
+++++++++++++++++++++++++++++++++++++++
Modifies storage units on the node.
+
+.. _rapi-res-nodes-node_name-storage-modify+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_NODE_MODIFY_STORAGE
+.. _rapi-res-nodes-node_name-storage-repair:
+
``/2/nodes/[node_name]/storage/repair``
+++++++++++++++++++++++++++++++++++++++
Repairs a storage unit on the node.
+
+.. _rapi-res-nodes-node_name-storage-repair+put:
+
``PUT``
~~~~~~~
.. opcode_result:: OP_REPAIR_NODE_STORAGE
+.. _rapi-res-nodes-node_name-tags:
+
``/2/nodes/[node_name]/tags``
+++++++++++++++++++++++++++++
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+
+.. _rapi-res-nodes-node_name-tags+get:
+
``GET``
~~~~~~~
["tag1", "tag2", "tag3"]
+
+.. _rapi-res-nodes-node_name-tags+put:
+
``PUT``
~~~~~~~
It supports the ``dry-run`` argument.
+
+.. _rapi-res-nodes-node_name-tags+delete:
+
``DELETE``
~~~~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-query-resource:
+
``/2/query/[resource]``
+++++++++++++++++++++++
authentication with one of the following options:
:pyeval:`utils.CommaJoin(rlib2.R_2_query.GET_ACCESS)`.
+
+.. _rapi-res-query-resource+get:
+
``GET``
~~~~~~~
named "fields", containing a comma-separated list of field names. Does
not support filtering.
+
+.. _rapi-res-query-resource+put:
+
``PUT``
~~~~~~~
operators.
+.. _rapi-res-query-resource-fields:
+
``/2/query/[resource]/fields``
++++++++++++++++++++++++++++++
Supports the following commands: ``GET``.
+
+.. _rapi-res-query-resource-fields+get:
+
``GET``
~~~~~~~
list of field names.
+.. _rapi-res-os:
+
``/2/os``
+++++++++
It supports the following commands: ``GET``.
+
+.. _rapi-res-os+get:
+
``GET``
~~~~~~~
["debian-etch"]
+
+.. _rapi-res-tags:
+
``/2/tags``
+++++++++++
It supports the following commands: ``GET``, ``PUT``, ``DELETE``.
+
+.. _rapi-res-tags+get:
+
``GET``
~~~~~~~
["tag1", "tag2", "tag3"]
+
+.. _rapi-res-tags+put:
+
``PUT``
~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-tags+delete:
+
``DELETE``
~~~~~~~~~~
It supports the ``dry-run`` argument.
+.. _rapi-res-version:
+
``/version``
++++++++++++
It supports the following commands: ``GET``.
+.. _rapi-res-version+get:
+
``GET``
~~~~~~~