trove/api-ref/source/flavors.inc
Zhao Chao b0577ae97e [api-ref] Update style and instances api.
Doc style:
* use tildes for heading 2 (following the rst convention);
* break source lines exceeded 79 characters (rst convention);
* remove unneccessary blank lines:
  * 4 blank lines between sections;
  * 2 blank lines between sub-sections;
  * 1 blank line between paragraphs in a section/subsection;
  * no blank lines at the bottom of a source file.
* add a space after commas in the middle of a line;

Instances API:
* change the order to match the description at the begin;
* add "Update instance name";
* add "Upgrade datastore version".

Change-Id: I3520e42f6ad97cb30632cf05241cec316409c9be
Signed-off-by: Zhao Chao <zhaochao1984@gmail.com>
2018-01-25 22:55:13 +08:00

82 lines
1.7 KiB
ReStructuredText

.. -*- rst -*-
=================
Flavors (flavors)
=================
Lists all flavors and shows details for a flavor, by ID.
Show flavor details
~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v1.0/{accountId}/flavors/{flavorId}
Shows flavor details with details of the RAM.
This resource is identical to the flavors found in the OpenStack
Compute API, but without the disk property.
The ``flavorId`` parameter must be an integer value. If you use a
floating point value for this parameter, this call truncates the
decimal portion and uses the integer portion as the ``flavorId``
value.
Normal response codes: 200
Error response codes: badRequest(400),unauthorized(401),forbidden(403),
itemNotFound(404), badMethod(405),overLimit(413),unprocessableEntity(422),
instanceFault(500),notImplemented(501), serviceUnavailable(503)
Request
-------
.. rest_parameters:: parameters.yaml
- flavorId: flavorId
- accountId: accountId
Response Example
----------------
.. literalinclude:: samples/db-flavors-by-id-response.json
:language: javascript
List flavors
~~~~~~~~~~~~
.. rest_method:: GET /v1.0/{accountId}/flavors
Lists information for all available flavors.
This operation lists information for all available flavors.
This resource is identical to the flavors found in the OpenStack
Nova API.
Normal response codes: 200
Error response codes: badRequest(400),unauthorized(401),forbidden(403),
itemNotFound(404), badMethod(405),overLimit(413),unprocessableEntity(422),
instanceFault(500),notImplemented(501), serviceUnavailable(503)
Request
-------
.. rest_parameters:: parameters.yaml
- accountId: accountId
Response Example
----------------
.. literalinclude:: samples/db-flavors-response.json
:language: javascript