doc-exports/docs/ims/api-ref/en-us_topic_0020091556.html
Zaoxu, Li c236478734 IMS API DOC
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-05 07:22:50 +00:00

578 lines
50 KiB
HTML

<a name="EN-US_TOPIC_0020091556"></a><a name="EN-US_TOPIC_0020091556"></a>
<h1 class="topictitle1">Querying an Image List Schema (Native OpenStack API)</h1>
<div id="body42007851"><div class="section" id="EN-US_TOPIC_0020091556__section29906272"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020091556__p47192740">This API is used to query an image list schema, which allows you to know details about and the data structure of the image list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020091556__section720995"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020091556__p66760059111743">GET /v2/schemas/images</p>
</div>
<div class="section" id="EN-US_TOPIC_0020091556__section6488958"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0020091556__p9349154718525">Request parameters</p>
<p id="EN-US_TOPIC_0020091556__p232053453512">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020091556__section1034265218413"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0020091556__p10585104213521">Querying an image list schema</p>
<pre class="screen" id="EN-US_TOPIC_0020091556__screen182263557412">GET https://{Endpoint}/v2/schemas/images</pre>
</div>
<div class="section" id="EN-US_TOPIC_0020091556__section58400626"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0020091556__ul10123156162755"><li id="EN-US_TOPIC_0020091556__li3051031511442">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091556__table4863803311445" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020091556__row3629282211445"><th align="left" class="cellrowborder" valign="top" width="31.540000000000003%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0020091556__p5403745111445">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.02%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0020091556__p5399240419951">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.440000000000005%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0020091556__p1495742511445">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091556__row3527303211445"><td class="cellrowborder" valign="top" width="31.540000000000003%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091556__p3854335911445">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.02%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091556__p4358420519951">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.440000000000005%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091556__p3500440311445">Specifies the schema name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row4660417511445"><td class="cellrowborder" valign="top" width="31.540000000000003%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091556__p1684183211445">links</p>
</td>
<td class="cellrowborder" valign="top" width="23.02%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091556__p4065973219951">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="45.440000000000005%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091556__p2201118611445">Specifies the URL for accessing the schema.</p>
<p id="EN-US_TOPIC_0020091556__p123432895413">For details, see <a href="#EN-US_TOPIC_0020091556__table15641103183416">Table 1</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row6388295311445"><td class="cellrowborder" valign="top" width="31.540000000000003%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091556__p713670311445">properties</p>
</td>
<td class="cellrowborder" valign="top" width="23.02%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091556__p510402419951">Object</p>
</td>
<td class="cellrowborder" valign="top" width="45.440000000000005%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091556__p8616104025420">Describes basic image attributes, including the type and usage of each attribute.</p>
<p id="EN-US_TOPIC_0020091556__p4120204111445">For details about the parameters, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020091556__table15641103183416"></a><a name="table15641103183416"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091556__table15641103183416" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure description of the links field</caption><thead align="left"><tr id="EN-US_TOPIC_0020091556__row136411132345"><th align="left" class="cellrowborder" valign="top" width="30.646935306469352%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0020091556__p136411433347">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.127587241275872%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0020091556__p12641193183412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.22547745225477%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0020091556__p164120311348">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091556__row4641634345"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0020091556__p126411432347">href</p>
</td>
<td class="cellrowborder" valign="top" width="24.127587241275872%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0020091556__p1864133173419">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.22547745225477%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0020091556__p16411373420">Specifies the domain name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row146411238348"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0020091556__p156421039346">rel</p>
</td>
<td class="cellrowborder" valign="top" width="24.127587241275872%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0020091556__p196421736343">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.22547745225477%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0020091556__p1164263163416">Specifies the domain name description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020091556__li7084168162755">Example response<pre class="codeblock" id="EN-US_TOPIC_0020091556__codeblock27264038214942">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020091556__screen3460783421492"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal"> 10</span>
<span class="normal"> 11</span>
<span class="normal"> 12</span>
<span class="normal"> 13</span>
<span class="normal"> 14</span>
<span class="normal"> 15</span>
<span class="normal"> 16</span>
<span class="normal"> 17</span>
<span class="normal"> 18</span>
<span class="normal"> 19</span>
<span class="normal"> 20</span>
<span class="normal"> 21</span>
<span class="normal"> 22</span>
<span class="normal"> 23</span>
<span class="normal"> 24</span>
<span class="normal"> 25</span>
<span class="normal"> 26</span>
<span class="normal"> 27</span>
<span class="normal"> 28</span>
<span class="normal"> 29</span>
<span class="normal"> 30</span>
<span class="normal"> 31</span>
<span class="normal"> 32</span>
<span class="normal"> 33</span>
<span class="normal"> 34</span>
<span class="normal"> 35</span>
<span class="normal"> 36</span>
<span class="normal"> 37</span>
<span class="normal"> 38</span>
<span class="normal"> 39</span>
<span class="normal"> 40</span>
<span class="normal"> 41</span>
<span class="normal"> 42</span>
<span class="normal"> 43</span>
<span class="normal"> 44</span>
<span class="normal"> 45</span>
<span class="normal"> 46</span>
<span class="normal"> 47</span>
<span class="normal"> 48</span>
<span class="normal"> 49</span>
<span class="normal"> 50</span>
<span class="normal"> 51</span>
<span class="normal"> 52</span>
<span class="normal"> 53</span>
<span class="normal"> 54</span>
<span class="normal"> 55</span>
<span class="normal"> 56</span>
<span class="normal"> 57</span>
<span class="normal"> 58</span>
<span class="normal"> 59</span>
<span class="normal"> 60</span>
<span class="normal"> 61</span>
<span class="normal"> 62</span>
<span class="normal"> 63</span>
<span class="normal"> 64</span>
<span class="normal"> 65</span>
<span class="normal"> 66</span>
<span class="normal"> 67</span>
<span class="normal"> 68</span>
<span class="normal"> 69</span>
<span class="normal"> 70</span>
<span class="normal"> 71</span>
<span class="normal"> 72</span>
<span class="normal"> 73</span>
<span class="normal"> 74</span>
<span class="normal"> 75</span>
<span class="normal"> 76</span>
<span class="normal"> 77</span>
<span class="normal"> 78</span>
<span class="normal"> 79</span>
<span class="normal"> 80</span>
<span class="normal"> 81</span>
<span class="normal"> 82</span>
<span class="normal"> 83</span>
<span class="normal"> 84</span>
<span class="normal"> 85</span>
<span class="normal"> 86</span>
<span class="normal"> 87</span>
<span class="normal"> 88</span>
<span class="normal"> 89</span>
<span class="normal"> 90</span>
<span class="normal"> 91</span>
<span class="normal"> 92</span>
<span class="normal"> 93</span>
<span class="normal"> 94</span>
<span class="normal"> 95</span>
<span class="normal"> 96</span>
<span class="normal"> 97</span>
<span class="normal"> 98</span>
<span class="normal"> 99</span>
<span class="normal">100</span>
<span class="normal">101</span>
<span class="normal">102</span>
<span class="normal">103</span>
<span class="normal">104</span>
<span class="normal">105</span>
<span class="normal">106</span>
<span class="normal">107</span>
<span class="normal">108</span>
<span class="normal">109</span>
<span class="normal">110</span>
<span class="normal">111</span>
<span class="normal">112</span>
<span class="normal">113</span>
<span class="normal">114</span>
<span class="normal">115</span>
<span class="normal">116</span>
<span class="normal">117</span>
<span class="normal">118</span>
<span class="normal">119</span>
<span class="normal">120</span>
<span class="normal">121</span>
<span class="normal">122</span>
<span class="normal">123</span>
<span class="normal">124</span>
<span class="normal">125</span>
<span class="normal">126</span>
<span class="normal">127</span>
<span class="normal">128</span>
<span class="normal">129</span>
<span class="normal">130</span>
<span class="normal">131</span>
<span class="normal">132</span>
<span class="normal">133</span>
<span class="normal">134</span>
<span class="normal">135</span>
<span class="normal">136</span>
<span class="normal">137</span>
<span class="normal">138</span>
<span class="normal">139</span>
<span class="normal">140</span>
<span class="normal">141</span>
<span class="normal">142</span>
<span class="normal">143</span>
<span class="normal">144</span>
<span class="normal">145</span>
<span class="normal">146</span>
<span class="normal">147</span>
<span class="normal">148</span>
<span class="normal">149</span>
<span class="normal">150</span>
<span class="normal">151</span>
<span class="normal">152</span>
<span class="normal">153</span>
<span class="normal">154</span>
<span class="normal">155</span>
<span class="normal">156</span>
<span class="normal">157</span>
<span class="normal">158</span>
<span class="normal">159</span>
<span class="normal">160</span>
<span class="normal">161</span>
<span class="normal">162</span>
<span class="normal">163</span>
<span class="normal">164</span>
<span class="normal">165</span>
<span class="normal">166</span>
<span class="normal">167</span>
<span class="normal">168</span>
<span class="normal">169</span>
<span class="normal">170</span>
<span class="normal">171</span>
<span class="normal">172</span>
<span class="normal">173</span>
<span class="normal">174</span>
<span class="normal">175</span>
<span class="normal">176</span>
<span class="normal">177</span>
<span class="normal">178</span>
<span class="normal">179</span>
<span class="normal">180</span>
<span class="normal">181</span>
<span class="normal">182</span>
<span class="normal">183</span>
<span class="normal">184</span>
<span class="normal">185</span>
<span class="normal">186</span>
<span class="normal">187</span>
<span class="normal">188</span>
<span class="normal">189</span>
<span class="normal">190</span>
<span class="normal">191</span>
<span class="normal">192</span>
<span class="normal">193</span>
<span class="normal">194</span>
<span class="normal">195</span>
<span class="normal">196</span>
<span class="normal">197</span>
<span class="normal">198</span>
<span class="normal">199</span>
<span class="normal">200</span>
<span class="normal">201</span>
<span class="normal">202</span>
<span class="normal">203</span>
<span class="normal">204</span>
<span class="normal">205</span>
<span class="normal">206</span>
<span class="normal">207</span>
<span class="normal">208</span>
<span class="normal">209</span>
<span class="normal">210</span>
<span class="normal">211</span>
<span class="normal">212</span>
<span class="normal">213</span>
<span class="normal">214</span>
<span class="normal">215</span>
<span class="normal">216</span>
<span class="normal">217</span>
<span class="normal">218</span>
<span class="normal">219</span>
<span class="normal">220</span>
<span class="normal">221</span>
<span class="normal">222</span>
<span class="normal">223</span>
<span class="normal">224</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;images&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;links&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{first}&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;first&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{next}&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;next&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{schema}&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;describedby&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;properties&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;images&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;additionalProperties&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;String&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;image&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;links&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{self}&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;self&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{file}&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;enclosure&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;href&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{schema}&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rel&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;describedby&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;properties&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;enum&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;queued&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;saving&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;active&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;killed&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;deleted&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;pending_delete&quot;</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Status of the image (READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;maxLength&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;array&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;List of strings related to the image&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;kernel_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;pattern&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ID of image stored in Glance that should be used as the kernel when booting an AMI-style image.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;is_base&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;container_format&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;enum&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;ami&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ari&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;aki&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;bare&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ovf&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ova&quot;</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Format of the container&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;min_ram&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Amount of ram (in MB) required to boot image.&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;ramdisk_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;pattern&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ID of image stored in Glance that should be used as the ramdisk when booting an AMI-style image.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;is_base&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;locations&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;items&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;required&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;url&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;metadata&quot;</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;object&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;properties&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;url&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;maxLength&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;metadata&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;object&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;array&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;A set of URLs to access the image file kept in external store&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;visibility&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;enum&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;public&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;private&quot;</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Scope of image accessibility&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;updated_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Date and time of the last image modification (READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;owner&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Owner of the image&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;maxLength&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;file&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;min_disk&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Amount of disk space (in GB) required to boot image.&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;virtual_size&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Virtual size of image in bytes (READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;pattern&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;^([0-9a-fA-F]){8}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){4}-([0-9a-fA-F]){12}$&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;An identifier for the image&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;size&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Size of image file in bytes (READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;instance_uuid&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ID of instance used to create this image.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;is_base&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;os_distro&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Common name of operating system distribution as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;is_base&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Descriptive name for the image&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;maxLength&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">255</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;checksum&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;md5 hash of image contents. (READ-ONLY)&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;maxLength&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">32</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;created_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Date and time of image registration (READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;disk_format&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;enum&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;ami&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ari&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;aki&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;vhd&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;vmdk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;raw&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;qcow2&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;vdi&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;iso&quot;</span>
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Format of the disk&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;os_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Operating system version as specified by the distributor&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;is_base&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;protected&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;boolean&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;If true, image will not be deletable.&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;architecture&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Operating system architecture as specified in http://docs.openstack.org/trunk/openstack-compute/admin/content/adding-images.html&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;is_base&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;direct_url&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;URL to access the image file kept in external store (READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;self&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;schema&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;(READ-ONLY)&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;array&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;schema&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;next&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;string&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">}</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020091556__section55843593"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0020091556__ul12698356"><li id="EN-US_TOPIC_0020091556__li47176343">Normal<p id="EN-US_TOPIC_0020091556__p21933905"><a name="EN-US_TOPIC_0020091556__li47176343"></a><a name="li47176343"></a>200</p>
</li><li id="EN-US_TOPIC_0020091556__li63187419">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091556__table512644917454" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020091556__row5075107217454"><th align="left" class="cellrowborder" valign="top" width="46.54%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0020091556__p1719616917454">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.459999999999994%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0020091556__p5071248317454">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091556__row1407048617454"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091556__p6596756117454">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020091556__p4177219617454">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row4040544817454"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091556__p5161589217454">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020091556__p2013769117454">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row4702149717454"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091556__p5064493517454">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020091556__p859904517454">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row27405030192213"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091556__p15819393192215">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020091556__p6302489192215">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row1028254117454"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091556__p2757951117454">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020091556__p1934790917454">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091556__row3991345717454"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091556__p1176460917454">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020091556__p1340929017454">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0020091554.html">Image Schema (Native OpenStack APIs)</a></div>
</div>
</div>