~hudson-openstack/glance/milestone-proposed

« back to all changes in this revision

Viewing changes to doc/source/glanceapi.rst

Committer: Tarmac
Author(s): jaypipes at gmail
Date: 2011-05-25 20:37:10 UTC
mfrom: (126.3.4 docs)
Revision ID: tarmac-20110525203710-mia1w08aju55csmo

Documentation for new results filtering in the API and client.

files modified:
doc/source/client.rst

doc/source/glanceapi.rst

doc/source/registries.rst

Show diffs side-by-side

added added

removed removed

doc/source/glanceapi.rst

The `checksum` field is an MD5 checksum of the image file data

Filtering Images Returned via ``GET /images`` and ``GET /images/detail``

------------------------------------------------------------------------

Both the ``GET /images`` and ``GET /images/detail`` requests take query

parameters that serve to filter the returned list of images. The following

100

list details these query parameters.

101

102

* ``name=NAME``

103

104

Filters images having a ``name`` attribute matching ``NAME``.

105

106

* ``container_format=FORMAT``

107

108

Filters images having a ``container_format`` attribute matching ``FORMAT``

109

110

For more information, see :doc:`About Disk and Container Formats <formats>`

111

112

* ``disk_format=FORMAT``

113

114

Filters images having a ``disk_format`` attribute matching ``FORMAT``

115

116

For more information, see :doc:`About Disk and Container Formats <formats>`

117

118

* ``status=STATUS``

119

120

Filters images having a ``status`` attribute matching ``STATUS``

121

122

For more information, see :doc:`About Image Statuses <statuses>`

123

124

* ``size_min=BYTES``

125

126

Filters images having a ``size`` attribute greater than or equal to ``BYTES``

127

128

* ``size_max=BYTES``

129

130

Filters images having a ``size`` attribute less than or equal to ``BYTES``

131

132

Requesting Detailed Metadata on a Specific Image

133

------------------------------------------------

Older »