Add virtual_size attribute to list images response
Closes-Bug: #1279866 Change-Id: Id2c5e05b3040d0829a4f8b1834f6410f043d7fff author: Diane Fleming
This commit is contained in:
Diane Fleming
@@ -41,11 +41,23 @@
|
||||
<wadl:method href="#updateImage-v2"/>
|
||||
<wadl:method href="#deleteImage-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="image-data-v2">
|
||||
<title>Image data</title>
|
||||
<para>Upload and download raw image data.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#file">
|
||||
<wadl:method href="#storeImageFile-v2"/>
|
||||
<wadl:method href="#getImageFile-v2"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="image-tags-v2">
|
||||
<title>Image tags</title>
|
||||
<para>Add and delete image tags.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="../wadls/image-api/src/v2/os-image-v2.wadl#tag">
|
||||
<wadl:method href="#addImageTag-v2"/>
|
||||
|
||||
@@ -53,7 +53,7 @@
|
||||
<representation mediaType="application/json"/>
|
||||
</response>
|
||||
'>
|
||||
<!ENTITY imageListParameters '
|
||||
<!ENTITY imageListReqParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="limit"
|
||||
style="query" required="false" type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@@ -166,7 +166,173 @@
|
||||
<code>?tag="cirros"</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY imageIdParameter '
|
||||
<!ENTITY imagesParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="images"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>An <code>images</code> object.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY imageParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="image"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>An <code>image</code> object.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY statusParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="status"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The image status.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY deleted_atParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="deleted_at"
|
||||
style="plain" required="true" type="xsd:datetime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The date and time when the image was deleted.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY nameParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="name"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The name of the image.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY deletedParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="deleted"
|
||||
style="plain" required="true" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Indicates whether the image has been deleted.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY container_formatParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="container_format" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The container format of image. Valid values are ami,
|
||||
ari, aki, bare, and ovf.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY created_atParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="created_at"
|
||||
style="plain" required="true" type="xsd:datetime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The date and time when the image was created.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY disk_formatParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="disk_format"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The disk format of the image. Valid values are
|
||||
ami, ari, aki, vhd, vmdk, raw, qcow2, vdi, and iso.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY updated_atParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="updated_at"
|
||||
style="plain" required="true" type="xsd:datetime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The date and time when the image was last updated.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY min_diskParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="min_disk"
|
||||
style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The minimum disk size required to boot the image, in
|
||||
GBs.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY protectedParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="protected"
|
||||
style="plain" required="true" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Defines whether the image can be deleted.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY idParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="id"
|
||||
style="plain" required="true" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The unique ID for the image.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY min_ramParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="min_ram"
|
||||
style="plain" required="true" type="csapi:uuid">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The minimum amount of RAM required to boot the image, in MBs.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY check_sumParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="check_sum"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Hash of the image data used. The Image Service uses this value for
|
||||
verification.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY ownerParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="owner"
|
||||
style="plain" required="true" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The ID of the owner, or tenant, of the image.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY is_publicParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="is_public"
|
||||
style="plain" required="true" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Defines whether the image is public.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY virtual_sizeParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="virtual_size"
|
||||
style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The virtual size of the image.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY propertiesParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="properties"
|
||||
style="plain" required="true" type="xsd:dict">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>Properties, if any, that are associated with the image.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY sizeParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="size"
|
||||
style="plain" required="true" type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The size of the image data, in bytes.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
<!ENTITY image_idParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="image_id"
|
||||
style="template" type="csapi:uuid" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
@@ -174,32 +340,26 @@
|
||||
title="Image ID"><para>Image ID stored through the image API.
|
||||
Typically a UUID.</para></wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY imageTagParameter ' <param xmlns="http://wadl.dev.java.net/2009/02" name="tag"
|
||||
<!ENTITY tagParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="tag"
|
||||
style="template" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
||||
title="Tag"><para>Image tag.</para></wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY memberIdParameter '<param xmlns="http://wadl.dev.java.net/2009/02" name="member_id"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" title="Tag">
|
||||
<para>Image tag.</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY member_idParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" name="member_id"
|
||||
style="template" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
||||
title="Members"><para>Image member ID. For example, the tenant
|
||||
ID of the user with whom the image is being
|
||||
shared.</para></wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY statusParameter '<param xmlns="http://wadl.dev.java.net/2009/02" name="status"
|
||||
style="plain" type="xsd:string" required="true">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
||||
title="Image member status">
|
||||
<para>Status to which this image member should be set. Valid
|
||||
values are <code>pending</code>, <code>accepted</code>,
|
||||
and <code>rejected</code>.</para>
|
||||
</wadl:doc>
|
||||
</param>' >
|
||||
</param>'>
|
||||
<!-- Useful for describing APIs -->
|
||||
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
||||
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
||||
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
||||
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|
||||
<!ENTITY PATCH '<command xmlns="http://docbook.org/ns/docbook">PATCH</command>'>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!-- (C) 2012-2013 OpenStack Foundation, All Rights Reserved -->
|
||||
<!-- (C) 2012-2014 OpenStack Foundation, All Rights Reserved -->
|
||||
<!--*******************************************************-->
|
||||
<!-- Import Common XML Entities -->
|
||||
<!-- -->
|
||||
@@ -34,15 +34,6 @@
|
||||
<resource id="Images" type="#ImageList" path="images">
|
||||
<method href="#createImage-v2"/>
|
||||
<resource path="{image_id}" id="image_id">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="image_id" style="template"
|
||||
type="csapi:uuid" required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Image ID"><para>Image
|
||||
ID stored through the image API.
|
||||
Typically a UUID.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getImage-v2"/>
|
||||
<method href="#updateImage-v2"/>
|
||||
<method href="#deleteImage-v2"/>
|
||||
@@ -52,16 +43,8 @@
|
||||
</resource>
|
||||
<resource id="Tags" path="tags">
|
||||
<resource path="{tag}" id="tag">
|
||||
<param
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="tag" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
title="Tag"><para>Image
|
||||
tag.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#addImageTag-v2"/>
|
||||
&tagParameter; <method
|
||||
href="#addImageTag-v2"/>
|
||||
<method href="#deleteImageTag-v2"/>
|
||||
</resource>
|
||||
</resource>
|
||||
@@ -69,19 +52,8 @@
|
||||
path="members">
|
||||
<method href="#createImageMember-v2"/>
|
||||
<resource path="{member_id}" id="member_id">
|
||||
<param
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="member_id" style="template"
|
||||
type="xsd:string">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Members"
|
||||
><para>Image member ID. For
|
||||
example, the tenant ID of the user
|
||||
with whom the image is being
|
||||
shared.</para></wadl:doc>
|
||||
</param>
|
||||
<method href="#getImageMember-v2"/>
|
||||
&member_idParameter; <method
|
||||
href="#getImageMember-v2"/>
|
||||
<method href="#deleteImageMember-v2"/>
|
||||
<method href="#updateImageMember-v2"/>
|
||||
</resource>
|
||||
@@ -118,6 +90,68 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<!-- images methods -->
|
||||
<method name="GET" id="listImages-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List images">
|
||||
<para role="shortdesc">Lists public virtual machine (VM)
|
||||
images. (Since Image API v2.0.)</para>
|
||||
<para>Returns a subset of the larger collection of images
|
||||
and a link that you can use to get the next set of
|
||||
images. You should always check for the presence of a
|
||||
<code>next</code> link and use it as the URI in a
|
||||
subsequent HTTP GET request. You should follow this
|
||||
pattern until a <code>next</code> link is no longer
|
||||
provided. The next link preserves any query parameters
|
||||
that you send in your initial request. You can use the
|
||||
<code>first</code> link to jump back to the first
|
||||
page of the collection. If you prefer to paginate
|
||||
through images manually, use the <code>limit</code>
|
||||
and <code>marker</code> parameters.</para>
|
||||
<para>The list operation accepts several types of query
|
||||
parameters that let you filter the results of the
|
||||
returned collection.</para>
|
||||
<para>A client can provide direct comparison filters using
|
||||
most image attributes, such as
|
||||
<code>name=Ubuntu</code>,
|
||||
<code>visibility=public</code>, and so on. A
|
||||
client cannot filter on tags or anything defined as a
|
||||
<code>link</code> in the json-schema, such as
|
||||
self, file, or schema.</para>
|
||||
<para>You can use the <code>size_min</code> and
|
||||
<code>size_max</code> query parameters to perform
|
||||
greater-than and less-than filtering of images based
|
||||
on their <code>size</code> attribute. The size is
|
||||
measured in bytes and refers to the size of an image
|
||||
when it is stored on disk.</para>
|
||||
<para>For example, sending a <code>size_min</code> filter
|
||||
of 1048576 and <code>size_max</code> of 4194304
|
||||
filters the container to include only images that are
|
||||
between 1 and 4 MB.</para>
|
||||
<para>You can sort the results of this operation by using
|
||||
the <code>sort_key</code> and <code>sort_dir</code>
|
||||
parameters. The API uses the natural sorting of
|
||||
whatever image attribute is provided as the
|
||||
<code>sort_key</code>.</para>
|
||||
</wadl:doc>
|
||||
<request> &imageListReqParameters; </request>
|
||||
<response status="200"> &imagesParameter; &statusParameter;
|
||||
&deleted_atParameter; &nameParameter; &deletedParameter;
|
||||
&container_formatParameter; &created_atParameter;
|
||||
&disk_formatParameter; &updated_atParameter;
|
||||
&min_diskParameter; &protectedParameter; &idParameter;
|
||||
&min_ramParameter; &check_sumParameter; &ownerParameter;
|
||||
&is_publicParameter; &virtual_sizeParameter;
|
||||
&propertiesParameter; <representation
|
||||
mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="createImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create image">
|
||||
@@ -169,8 +203,16 @@
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</request>
|
||||
<response status="201">
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
<response status="201"> &imageParameter; &statusParameter;
|
||||
&deletedParameter; &container_formatParameter;
|
||||
&min_ramParameter; &updated_atParameter; &ownerParameter;
|
||||
&min_diskParameter; &is_publicParameter;
|
||||
&deleted_atParameter; &idParameter; &sizeParameter;
|
||||
&virtual_sizeParameter; &nameParameter;
|
||||
&check_sumParameter; &created_atParameter;
|
||||
&disk_formatParameter; &propertiesParameter;
|
||||
&protectedParameter; <param
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="location" style="plain" type="xsd:anyURI"
|
||||
required="true"
|
||||
path="/common:version/atom:link[@rel='self']/@href">
|
||||
@@ -190,6 +232,7 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<!-- images/{image_id} methods -->
|
||||
<method name="PATCH" id="updateImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Update image">
|
||||
@@ -206,16 +249,16 @@
|
||||
(Since Image API v2.2)</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>You can also use the PATCH method to add or remove
|
||||
<para>You can also use the &PATCH; method to add or remove
|
||||
image properties.</para>
|
||||
<para>For information about the PATCH method and the
|
||||
<para>For information about the &PATCH; method and the
|
||||
available media types, see <link
|
||||
xlink:href="http://docs.openstack.org/api/openstack-image-service/2.0/content/appendix-b-http-patch-media-types.html"
|
||||
>Appendix B: HTTP PATCH media types</link> in the
|
||||
<citetitle>OpenStack Image Service API v2
|
||||
Reference</citetitle>.</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; <representation
|
||||
<request> &image_idParameter; <representation
|
||||
mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@@ -233,7 +276,6 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<!-- Get Image -->
|
||||
<method name="GET" id="getImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Get image details">
|
||||
@@ -241,7 +283,7 @@
|
||||
(Since Image API v2.0.)</para>
|
||||
<para>Response body is a single image entity.</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; </request>
|
||||
<request> &image_idParameter;</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
@@ -252,85 +294,6 @@
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listImages-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List images">
|
||||
<para role="shortdesc">Lists public virtual machine (VM)
|
||||
images. (Since Image API v2.0.)</para>
|
||||
<para>Returns a subset of the larger collection of images
|
||||
and a link that you can use to get the next set of
|
||||
images. You should always check for the presence of a
|
||||
<code>next</code> link and use it as the URI in a
|
||||
subsequent HTTP GET request. You should follow this
|
||||
pattern until a <code>next</code> link is no longer
|
||||
provided. The next link preserves any query parameters
|
||||
that you send in your initial request. You can use the
|
||||
<code>first</code> link to jump back to the first
|
||||
page of the collection. If you prefer to paginate
|
||||
through images manually, use the <code>limit</code>
|
||||
and <code>marker</code> parameters.</para>
|
||||
<para>The list operation accepts several types of query
|
||||
parameters that let you filter the results of the
|
||||
returned collection.</para>
|
||||
<para>A client can provide direct comparison filters using
|
||||
most image attributes, such as
|
||||
<code>name=Ubuntu</code>,
|
||||
<code>visibility=public</code>, and so on. A
|
||||
client cannot filter on tags or anything defined as a
|
||||
<code>link</code> in the json-schema, such as
|
||||
self, file, or schema.</para>
|
||||
<para>You can use the <code>size_min</code> and
|
||||
<code>size_max</code> query parameters to perform
|
||||
greater-than and less-than filtering of images based
|
||||
on their <code>size</code> attribute. The size is
|
||||
measured in bytes and refers to the size of an image
|
||||
when it is stored on disk.</para>
|
||||
<para>For example, sending a <code>size_min</code> filter
|
||||
of 1048576 and <code>size_max</code> of 4194304
|
||||
filters the container to include only images that are
|
||||
between 1 and 4 MB.</para>
|
||||
<para>You can sort the results of this operation by using
|
||||
the <code>sort_key</code> and <code>sort_dir</code>
|
||||
parameters. The API uses the natural sorting of
|
||||
whatever image attribute is provided as the
|
||||
<code>sort_key</code>.</para>
|
||||
</wadl:doc>
|
||||
<request> &imageListParameters; </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-list-response.json"/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listImageMembers-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List image members">
|
||||
<para role="shortdesc">Lists the tenants with whom this
|
||||
image has been shared. (Since Image API v2.1.)</para>
|
||||
<para>If a user with whom this image is shared makes this
|
||||
call, the member list contains only information for
|
||||
that user.</para>
|
||||
<para>If a user with whom this image has not been shared
|
||||
makes this call, the call returns the HTTP 404 status
|
||||
code.</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter;</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-members-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="404"/>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteImage-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Delete image">
|
||||
@@ -344,10 +307,11 @@
|
||||
response is empty and returns the HTTP 204 status
|
||||
code.</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; </request>
|
||||
<request> &image_idParameter;</request>
|
||||
<response status="204"/>
|
||||
<response status="403"/>
|
||||
</method>
|
||||
<!-- images/{image_id}/file methods -->
|
||||
<method name="PUT" id="storeImageFile-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Upload binary image data">
|
||||
@@ -360,7 +324,7 @@
|
||||
accessible in its entirety by issuing a &GET; request
|
||||
to the same URI.</para>
|
||||
</wadl:doc>
|
||||
<request>&imageIdParameter;</request>
|
||||
<request> &image_idParameter;</request>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<method name="GET" id="getImageFile-v2">
|
||||
@@ -377,16 +341,17 @@
|
||||
<para>If no image data exists, returns the HTTP 204 status
|
||||
code.</para>
|
||||
</wadl:doc>
|
||||
<request>&imageIdParameter;</request>
|
||||
<request> &image_idParameter; </request>
|
||||
<response status="200 204"/>
|
||||
</method>
|
||||
<!-- images/{image_id}/tags/{tag} methods -->
|
||||
<method name="PUT" id="addImageTag-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Add image tag">
|
||||
<para role="shortdesc">Adds a specified tag to a specified
|
||||
image. (Since Image API v2.0.)</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; &imageTagParameter; </request>
|
||||
<request> &image_idParameter; &tagParameter;</request>
|
||||
<response status="200"/>
|
||||
</method>
|
||||
<method name="DELETE" id="deleteImageTag-v2">
|
||||
@@ -395,9 +360,10 @@
|
||||
<para role="shortdesc">Deletes a specified tag from a
|
||||
specified image. (Since Image API v2.0.)</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; &imageTagParameter; </request>
|
||||
<request> &image_idParameter; &tagParameter;</request>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
<!-- images/{image_id}/members methods -->
|
||||
<method name="GET" id="getImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" title="Show image member details"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
@@ -405,25 +371,51 @@
|
||||
<para>Response body is a single image member entity.
|
||||
(Since Image API 2.2.)</para>
|
||||
</wadl:doc>
|
||||
<request>&imageIdParameter; &memberIdParameter;</request>
|
||||
<request> &image_idParameter; &member_idParameter; </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<doc xml:lang="EN">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-member-details-response.json"
|
||||
/>
|
||||
</doc>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="listImageMembers-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="List image members">
|
||||
<para role="shortdesc">Lists the tenants with whom this
|
||||
image has been shared. (Since Image API v2.1.)</para>
|
||||
<para>If a user with whom this image is shared makes this
|
||||
call, the member list contains only information for
|
||||
that user.</para>
|
||||
<para>If a user with whom this image has not been shared
|
||||
makes this call, the call returns the HTTP 404 status
|
||||
code.</para>
|
||||
</wadl:doc>
|
||||
<request> &image_idParameter; </request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
href="samples/image-members-list-response.json"
|
||||
/>
|
||||
</wadl:doc>
|
||||
</representation>
|
||||
</response>
|
||||
<response status="404"/>
|
||||
</method>
|
||||
<method name="POST" id="createImageMember-v2">
|
||||
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
|
||||
title="Create image member">
|
||||
<para role="shortdesc">Adds a specified tenant ID as an
|
||||
image member. (Since Image API v2.1.)</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; &memberIdParameter;
|
||||
<representation mediaType="application/json">
|
||||
<request> &image_idParameter; <representation
|
||||
mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
@@ -450,9 +442,8 @@
|
||||
specified member of the specified image. (Since Image
|
||||
API v2.1.)</para>
|
||||
</wadl:doc>
|
||||
<request> &imageIdParameter; &memberIdParameter;
|
||||
&statusParameter; <representation
|
||||
mediaType="application/json">
|
||||
<request> &image_idParameter; &member_idParameter;
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xml:lang="EN"
|
||||
xmlns="http://docbook.org/ns/docbook">
|
||||
<xsdxt:code
|
||||
@@ -479,7 +470,7 @@
|
||||
the member list of the specified image. (Since Image
|
||||
API v2.1.)</para>
|
||||
</wadl:doc>
|
||||
<request>&imageIdParameter;</request>
|
||||
<request> &image_idParameter; &member_idParameter;</request>
|
||||
<response status="204"/>
|
||||
</method>
|
||||
</application>
|
||||
|
||||
@@ -1,15 +1,24 @@
|
||||
{
|
||||
"id": "e7db3b45-8db7-47ad-8109-3fb55c2c24fd",
|
||||
"name": "Ubuntu 12.10",
|
||||
"status": "queued",
|
||||
"visibility": "public",
|
||||
"tags": [
|
||||
"ubuntu",
|
||||
"quantal"
|
||||
],
|
||||
"created_at": "2012-08-11T17:15:52Z",
|
||||
"updated_at": "2012-08-11T17:15:52Z",
|
||||
"self": "/v2/images/e7db3b45-8db7-47ad-8109-3fb55c2c24fd",
|
||||
"file": "/v2/images/e7db3b45-8db7-47ad-8109-3fb55c2c24fd/file",
|
||||
"schema": "/v2/schemas/image"
|
||||
"image":{
|
||||
"status":"queued",
|
||||
"deleted":false,
|
||||
"container_format":null,
|
||||
"min_ram":0,
|
||||
"updated_at":"2014-05-05T21:15:26",
|
||||
"owner":"f3490b9d3efd47df9e6e91845a1d647b",
|
||||
"min_disk":0,
|
||||
"is_public":false,
|
||||
"deleted_at":null,
|
||||
"id":"e7db3b45-8db7-47ad-8109-3fb55c2c24fd",
|
||||
"size":0,
|
||||
"virtual_size":null,
|
||||
"name":"Ubuntu 12.10",
|
||||
"checksum":null,
|
||||
"created_at":"2014-05-05T21:15:26",
|
||||
"disk_format":null,
|
||||
"properties":{
|
||||
|
||||
},
|
||||
"protected":false
|
||||
}
|
||||
}
|
||||
@@ -1,17 +1,22 @@
|
||||
{
|
||||
"id": "da3b75d9-3f4a-40e7-8a2c-bfab23927dea",
|
||||
"name": "cirros-0.3.0-x86_64-uec-ramdisk",
|
||||
"status": "active",
|
||||
"visibility": "public",
|
||||
"size": 2254249,
|
||||
"checksum": "2cec138d7dae2aa59038ef8c9aec2390",
|
||||
"tags": [
|
||||
"ping",
|
||||
"pong"
|
||||
],
|
||||
"created_at": "2012-08-10T19:23:50Z",
|
||||
"updated_at": "2012-08-10T19:23:50Z",
|
||||
"self": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea",
|
||||
"file": "/v2/images/da3b75d9-3f4a-40e7-8a2c-bfab23927dea/file",
|
||||
"schema": "/v2/schemas/image"
|
||||
"status":"active",
|
||||
"name":"cirros-0.3.2-x86_64-disk",
|
||||
"tags":[
|
||||
|
||||
],
|
||||
"container_format":"bare",
|
||||
"created_at":"2014-05-05T17:15:10Z",
|
||||
"disk_format":"qcow2",
|
||||
"updated_at":"2014-05-05T17:15:11Z",
|
||||
"visibility":"public",
|
||||
"self":"/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27",
|
||||
"min_disk":0,
|
||||
"protected":false,
|
||||
"id":"1bea47ed-f6a9-463b-b423-14b9cca9ad27",
|
||||
"file":"/v2/images/1bea47ed-f6a9-463b-b423-14b9cca9ad27/file",
|
||||
"checksum":"64d7c1cd2b6f60c92c14662941cb7913",
|
||||
"owner":"5ef70662f8b34079a6eddb8da9d75fe8",
|
||||
"size":13167616,
|
||||
"min_ram":0,
|
||||
"schema":"/v2/schemas/image"
|
||||
}
|
||||
@@ -1,64 +1,48 @@
|
||||
{
|
||||
"images": [
|
||||
{
|
||||
"status": "active",
|
||||
"name": "cirros-0.3.1-x86_64-uec",
|
||||
"deleted": false,
|
||||
"container_format": "ami",
|
||||
"created_at": "2013-08-29T19:18:26",
|
||||
"disk_format": "ami",
|
||||
"updated_at": "2013-08-29T19:18:26",
|
||||
"id": "e0b7734d-2331-42a3-b19e-067adc0da17d",
|
||||
"min_disk": 0,
|
||||
"protected": false,
|
||||
"min_ram": 0,
|
||||
"checksum": "f8a2eeee2dc65b3d9b6e63678955bd83",
|
||||
"owner": "f7ac731cc11f40efbc03a9f9e1d1d21f",
|
||||
"is_public": true,
|
||||
"deleted_at": null,
|
||||
"properties": {
|
||||
"kernel_id": "75bf193b-237b-435e-8712-896c51484de9",
|
||||
"ramdisk_id": "19eee81c-f972-44e1-a952-1dceee148c47"
|
||||
},
|
||||
"size": 25165824
|
||||
},
|
||||
{
|
||||
"status": "active",
|
||||
"name": "cirros-0.3.1-x86_64-uec-kernel",
|
||||
"deleted": false,
|
||||
"container_format": "aki",
|
||||
"created_at": "2013-08-29T19:18:24",
|
||||
"disk_format": "aki",
|
||||
"updated_at": "2013-08-29T19:18:24",
|
||||
"id": "75bf193b-237b-435e-8712-896c51484de9",
|
||||
"min_disk": 0,
|
||||
"protected": false,
|
||||
"min_ram": 0,
|
||||
"checksum": "c352f4e7121c6eae958bc1570324f17e",
|
||||
"owner": "f7ac731cc11f40efbc03a9f9e1d1d21f",
|
||||
"is_public": true,
|
||||
"deleted_at": null,
|
||||
"properties": {},
|
||||
"size": 4955792
|
||||
},
|
||||
{
|
||||
"status": "active",
|
||||
"name": "cirros-0.3.1-x86_64-uec-ramdisk",
|
||||
"deleted": false,
|
||||
"container_format": "ari",
|
||||
"created_at": "2013-08-29T19:18:25",
|
||||
"disk_format": "ari",
|
||||
"updated_at": "2013-08-29T19:18:25",
|
||||
"id": "19eee81c-f972-44e1-a952-1dceee148c47",
|
||||
"min_disk": 0,
|
||||
"protected": false,
|
||||
"min_ram": 0,
|
||||
"checksum": "69c33642f44ca552ba4bb8b66ad97e85",
|
||||
"owner": "f7ac731cc11f40efbc03a9f9e1d1d21f",
|
||||
"is_public": true,
|
||||
"deleted_at": null,
|
||||
"properties": {},
|
||||
"size": 3714968
|
||||
}
|
||||
]
|
||||
"images":[
|
||||
{
|
||||
"status":"active",
|
||||
"deleted_at":null,
|
||||
"name":"cirros-0.3.2-x86_64-disk",
|
||||
"deleted":false,
|
||||
"container_format":"bare",
|
||||
"created_at":"2014-05-05T17:15:10",
|
||||
"disk_format":"qcow2",
|
||||
"updated_at":"2014-05-05T17:15:11",
|
||||
"min_disk":0,
|
||||
"protected":false,
|
||||
"id":"1bea47ed-f6a9-463b-b423-14b9cca9ad27",
|
||||
"min_ram":0,
|
||||
"checksum":"64d7c1cd2b6f60c92c14662941cb7913",
|
||||
"owner":"5ef70662f8b34079a6eddb8da9d75fe8",
|
||||
"is_public":true,
|
||||
"virtual_size":null,
|
||||
"properties":{
|
||||
|
||||
},
|
||||
"size":13167616
|
||||
},
|
||||
{
|
||||
"status":"active",
|
||||
"deleted_at":null,
|
||||
"name":"F17-x86_64-cfntools",
|
||||
"deleted":false,
|
||||
"container_format":"bare",
|
||||
"created_at":"2014-05-05T17:15:11",
|
||||
"disk_format":"qcow2",
|
||||
"updated_at":"2014-05-05T17:15:16",
|
||||
"min_disk":0,
|
||||
"protected":false,
|
||||
"id":"781b3762-9469-4cec-b58d-3349e5de4e9c",
|
||||
"min_ram":0,
|
||||
"checksum":"afab0f79bac770d61d24b4d0560b5f70",
|
||||
"owner":"5ef70662f8b34079a6eddb8da9d75fe8",
|
||||
"is_public":true,
|
||||
"virtual_size":null,
|
||||
"properties":{
|
||||
|
||||
},
|
||||
"size":476704768
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user