Files
05e9f0a0e00ac9360ba5b1cdab140a3c37057247
nova /api-ref /source /images.inc
Ken'ichi Ohmichi 05e9f0a0e0 Remove 40X and 50X from Normal response codes 
HTTP 40X-50X are not normal response codes at all.
This patch removes them from api-ref.
Part of bp:api-ref-in-rst
Change-Id: I32a29c9e2a3d69720e3a88e17ba36fe45fa902d9
2016年04月18日 16:56:11 -07:00

155 lines
3.5 KiB
ReStructuredText

.. -*- rst -*-
========
Images
========
Lists, shows details for, and deletes images. Also sets, lists, shows
details for, and deletes image metadata.
An image is a collection of files that you use to create and rebuild a
server. By default, operators provide pre-built operating system images.
You can also create custom images. See Compute server actions.
By default, the ``policy.json`` file authorizes all users to view the
image size in the ``OS-EXT-IMG-SIZE:size`` extended attribute.
Show Image Details
==================
.. rest_method:: GET //v2.1/{tenant_id}/images/{image_id}
Shows details for an image.
Normal response codes: 200,203
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- image_id: image_id
Response
--------
**Example Show Image Details: JSON request**
.. literalinclude:: ../../doc/api_samples/images/image-show-resp.json
:language: javascript
Delete Image
============
.. rest_method:: DELETE //v2.1/{tenant_id}/images/{image_id}
Deletes an image.
Normal response codes: 204
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- image_id: image_id
Response
--------
Show Image Metadata Item Details
================================
.. rest_method:: GET //v2.1/{tenant_id}/images/{image_id}/metadata/{key}
Shows details for a metadata item, by key, for an image.
Normal response codes: 200,203
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- image_id: image_id
- key: key
Response
--------
**Example Show Image Metadata Item Details: JSON request**
.. literalinclude:: ../../doc/api_samples/images/image-metadata-item-show-resp.json
:language: javascript
Create Or Update Image Metadata Item
====================================
.. rest_method:: PUT //v2.1/{tenant_id}/images/{image_id}/metadata/{key}
Creates or updates a metadata item, by key, for an image.
Normal response codes: 200
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- image_id: image_id
- key: key
**Example Create Or Update Image Metadata Item: JSON request**
.. literalinclude:: ../../doc/api_samples/images/image-metadata-item-update-req.json
:language: javascript
Response
--------
**Example Create Or Update Image Metadata Item: JSON request**
.. literalinclude:: ../../doc/api_samples/images/image-metadata-item-update-resp.json
:language: javascript
Delete Image Metadata Item
==========================
.. rest_method:: DELETE //v2.1/{tenant_id}/images/{image_id}/metadata/{key}
Deletes a metadata item, by key, for an image.
Normal response codes: 204
Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400),
unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- tenant_id: tenant_id
- image_id: image_id
- key: key
Response
--------