Revision 0dbaa9ca doc/rapi.rst
b/doc/rapi.rst | ||
---|---|---|
337 | 337 |
|
338 | 338 |
The groups resource. |
339 | 339 |
|
340 |
It supports the following commands: ``GET``. |
|
340 |
It supports the following commands: ``GET``, ``POST``.
|
|
341 | 341 |
|
342 | 342 |
``GET`` |
343 | 343 |
~~~~~~~ |
... | ... | |
383 | 383 |
} |
384 | 384 |
] |
385 | 385 |
|
386 |
``POST`` |
|
387 |
~~~~~~~~ |
|
388 |
|
|
389 |
Creates a node group. |
|
390 |
|
|
391 |
If the optional bool *dry-run* argument is provided, the job will not be |
|
392 |
actually executed, only the pre-execution checks will be done. |
|
393 |
|
|
394 |
Returns: a job ID that can be used later for polling. |
|
395 |
|
|
396 |
Body parameters: |
|
397 |
|
|
398 |
``name`` (string, required) |
|
399 |
Node group name. |
|
400 |
|
|
401 |
|
|
386 | 402 |
``/2/groups/[group_name]`` |
387 |
+++++++++++++++++++++++++++++++++
|
|
403 |
++++++++++++++++++++++++++ |
|
388 | 404 |
|
389 | 405 |
Returns information about a node group. |
390 | 406 |
|
391 |
It supports the following commands: ``GET``. |
|
407 |
It supports the following commands: ``GET``, ``DELETE``. |
|
408 |
|
|
409 |
``GET`` |
|
410 |
~~~~~~~ |
|
411 |
|
|
412 |
Returns information about a node group, similar to the bulk output from |
|
413 |
the node group list. |
|
414 |
|
|
415 |
``DELETE`` |
|
416 |
~~~~~~~~~~ |
|
417 |
|
|
418 |
Deletes a node group. |
|
419 |
|
|
420 |
It supports the ``dry-run`` argument. |
|
421 |
|
|
422 |
|
|
423 |
``/2/groups/[group_name]/rename`` |
|
424 |
+++++++++++++++++++++++++++++++++ |
|
425 |
|
|
426 |
Renames a node group. |
|
427 |
|
|
428 |
Supports the following commands: ``PUT``. |
|
429 |
|
|
430 |
``PUT`` |
|
431 |
~~~~~~~ |
|
432 |
|
|
433 |
Returns a job ID. |
|
434 |
|
|
435 |
Body parameters: |
|
436 |
|
|
437 |
``new_name`` (string, required) |
|
438 |
New node group name. |
|
392 | 439 |
|
393 | 440 |
|
394 | 441 |
``/2/instances`` |
Also available in: Unified diff