.. -*- rst -*- ========= Flavors ========= Show and manage server flavors. Flavors are a way to describe the basic dimensions of a server to be created including how much ``cpu``, ``ram``, and ``disk space`` are allocated to a server built with this flavor. List Flavors ============ .. rest_method:: GET /flavors Lists all flavors accessible to your project. Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403) Request ------- .. rest_parameters:: parameters.yaml - sort_key: sort_key_flavor - sort_dir: sort_dir_flavor - limit: limit - marker: marker - minDisk: minDisk - minRam: minRam - is_public: flavor_is_public_query Response -------- .. rest_parameters:: parameters.yaml - flavors: flavors - id: flavor_id_body - name: flavor_name - description: flavor_description_resp - links: links **Example List Flavors (v2.55)** .. literalinclude:: ../../doc/api_samples/flavors/v2.55/flavors-list-resp.json :language: javascript Create Flavor ============= .. rest_method:: POST /flavors Creates a flavor. Creating a flavor is typically only available to administrators of a cloud because this has implications for scheduling efficiently in the cloud. .. note:: Flavors with special characters in the flavor ID, except the hyphen '-', underscore '_', spaces and dots '.', are not permitted. Flavor IDs are meant to be UUIDs. Serialized strings separated/grouped by "-" represent the default flavor ID or UUID. eg: 01cc74d8-4816-4bef-835b-e36ff188c406. Only for backward compatibility, an integer as a flavor ID is permitted. Normal response codes: 200 Error response codes: badRequest(400), unauthorized(401), forbidden(403), conflict(409) Request ------- .. rest_parameters:: parameters.yaml - flavor: flavor - name: flavor_name - description: flavor_description - id: flavor_id_body_create - ram: flavor_ram - disk: flavor_disk - vcpus: flavor_cpus - OS-FLV-EXT-DATA:ephemeral: flavor_ephem_disk_in - swap: flavor_swap_in - rxtx_factor: flavor_rxtx_factor_in - os-flavor-access:is_public: flavor_is_public_in **Example Create Flavor (v2.55)** .. literalinclude:: ../../doc/api_samples/flavor-manage/v2.55/flavor-create-post-req.json :language: javascript Response -------- .. rest_parameters:: parameters.yaml - flavor: flavor - name: flavor_name - description: flavor_description_resp - id: flavor_id_body - ram: flavor_ram - disk: flavor_disk - vcpus: flavor_cpus - links: links - OS-FLV-EXT-DATA:ephemeral: flavor_ephem_disk - OS-FLV-DISABLED:disabled: flavor_disabled - swap: flavor_swap - rxtx_factor: flavor_rxtx_factor - os-flavor-access:is_public: flavor_is_public - extra_specs: extra_specs_2_61 **Example Create Flavor (v2.75)** .. literalinclude:: ../../doc/api_samples/flavor-manage/v2.75/flavor-create-post-resp.json :language: javascript List Flavors With Details ========================= .. rest_method:: GET /flavors/detail Lists flavors with details. Normal response codes: 200 Error response codes: badRequest(400), unauthorized(401), forbidden(403) Request ------- .. rest_parameters:: parameters.yaml - sort_key: sort_key_flavor - sort_dir: sort_dir_flavor - limit: limit - marker: marker - minDisk: minDisk - minRam: minRam - is_public: flavor_is_public_query Response -------- .. rest_parameters:: parameters.yaml - flavors: flavors - name: flavor_name - description: flavor_description_resp - id: flavor_id_body - ram: flavor_ram - disk: flavor_disk - vcpus: flavor_cpus - links: links - OS-FLV-EXT-DATA:ephemeral: flavor_ephem_disk - OS-FLV-DISABLED:disabled: flavor_disabled - swap: flavor_swap - rxtx_factor: flavor_rxtx_factor - os-flavor-access:is_public: flavor_is_public - extra_specs: extra_specs_2_61 **Example List Flavors With Details (v2.75)** .. literalinclude:: ../../doc/api_samples/flavors/v2.75/flavors-detail-resp.json :language: javascript Show Flavor Details =================== .. rest_method:: GET /flavors/{flavor_id} Shows details for a flavor. Normal response codes: 200 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) Request ------- .. rest_parameters:: parameters.yaml - flavor_id: flavor_id Response -------- .. rest_parameters:: parameters.yaml - flavor: flavor - name: flavor_name - description: flavor_description_resp - id: flavor_id_body - ram: flavor_ram - disk: flavor_disk - vcpus: flavor_cpus - links: links - OS-FLV-EXT-DATA:ephemeral: flavor_ephem_disk - OS-FLV-DISABLED:disabled: flavor_disabled - swap: flavor_swap - rxtx_factor: flavor_rxtx_factor - os-flavor-access:is_public: flavor_is_public - extra_specs: extra_specs_2_61 **Example Show Flavor Details (v2.75)** .. literalinclude:: ../../doc/api_samples/flavors/v2.75/flavor-get-resp.json :language: javascript Update Flavor Description ========================= .. rest_method:: PUT /flavors/{flavor_id} Updates a flavor description. This API is available starting with microversion 2.55. Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. Normal response codes: 200 Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404) Request ------- .. rest_parameters:: parameters.yaml - flavor_id: flavor_id - flavor: flavor - description: flavor_description_required **Example Update Flavor Description (v2.55)** .. literalinclude:: ../../doc/api_samples/flavor-manage/v2.55/flavor-update-req.json :language: javascript Response -------- .. rest_parameters:: parameters.yaml - flavor: flavor - name: flavor_name - description: flavor_description_resp_no_min - id: flavor_id_body - ram: flavor_ram - disk: flavor_disk - vcpus: flavor_cpus - links: links - OS-FLV-EXT-DATA:ephemeral: flavor_ephem_disk - OS-FLV-DISABLED:disabled: flavor_disabled - swap: flavor_swap - rxtx_factor: flavor_rxtx_factor - os-flavor-access:is_public: flavor_is_public - extra_specs: extra_specs_2_61 **Example Update Flavor Description (v2.75)** .. literalinclude:: ../../doc/api_samples/flavor-manage/v2.75/flavor-update-resp.json :language: javascript Delete Flavor ============= .. rest_method:: DELETE /flavors/{flavor_id} Deletes a flavor. This is typically an admin only action. Deleting a flavor that is in use by existing servers is not recommended as it can cause incorrect data to be returned to the user under some operations. Normal response codes: 202 Error response codes: unauthorized(401), forbidden(403), itemNotFound(404) Request ------- .. rest_parameters:: parameters.yaml - flavor_id: flavor_id Response -------- No body content is returned on a successful DELETE.