Sean Dague
f208917c52
This fixes the last json reference warning which exist. It also trims out the baremetal API calls that we don't support any more (we only have the readonly proxy). That was erroneously added to the compute API docs in refactors of api-site last cycle. Change-Id: I08be639b610304049b0959902ed8876559111274
303 lines
6.6 KiB
ReStructuredText
303 lines
6.6 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.
|
|
|
|
List Images
|
|
===========
|
|
|
|
.. rest_method:: GET //v2.1/{tenant_id}/images
|
|
|
|
list images.
|
|
|
|
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
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Images: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/images-list-get-resp.json
|
|
:language: javascript
|
|
|
|
Show Image Details
|
|
==================
|
|
|
|
.. rest_method:: GET //v2.1/{tenant_id}/images/{image_id}
|
|
|
|
Shows details 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
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Image Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/images-details-get-resp.json
|
|
:language: javascript
|
|
|
|
List Images With Details
|
|
==================
|
|
|
|
.. rest_method:: GET //v2.1/{tenant_id}/images/detail
|
|
|
|
List images with details.
|
|
|
|
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
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example List Images Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/images-details-get-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
|
|
--------
|
|
|
|
Create Image Metadata
|
|
=====================
|
|
|
|
.. rest_method:: POST //v2.1/{tenant_id}/images/{image_id}/metadata
|
|
|
|
Create an image metadata.
|
|
|
|
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
|
|
|
|
**Example Create Image Metadata: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-metadata-post-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Create Image Metadata: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-metadata-post-resp.json
|
|
:language: javascript
|
|
|
|
Update Image Metadata
|
|
=====================
|
|
|
|
.. rest_method:: PUT //v2.1/{tenant_id}/images/{image_id}/metadata
|
|
|
|
Update an image metadata
|
|
|
|
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
|
|
|
|
**Example Update Image Metadata: JSON request**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-metadata-put-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Update Image Metadata: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-metadata-put-resp.json
|
|
:language: javascript
|
|
|
|
Show Image Metadata Details
|
|
===========================
|
|
|
|
.. rest_method:: GET //v2.1/{tenant_id}/images/{image_id}/metadata
|
|
|
|
Shows details for an image metadata.
|
|
|
|
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
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Show Image Metadata Details: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-metadata-get-resp.json
|
|
:language: javascript
|
|
|
|
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
|
|
|
|
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 response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-meta-key-get.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-meta-key-put-req.json
|
|
:language: javascript
|
|
|
|
Response
|
|
--------
|
|
|
|
**Example Create Or Update Image Metadata Item: JSON response**
|
|
|
|
.. literalinclude:: ../../doc/api_samples/images/image-meta-key-put-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
|
|
--------
|