vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ims/api-ref/en-us_topic_0020091555.html
Zaoxu, Li fdf6843d7a ims_api1226 
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-01-11 14:47:14 +00:00

542 lines
33 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0020091555"></a><a name="EN-US_TOPIC_0020091555"></a>
<h1 class="topictitle1">Querying an Image Schema (Native OpenStack API)</h1>
<div id="body47530006"><div class="section" id="EN-US_TOPIC_0020091555__section10309404"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020091555__p24725298">This API is used to query the image schema, which allows you to view image attributes and their data types.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020091555__section25675773"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020091555__p663755111732">GET /v2/schemas/image</p>
</div>
<div class="section" id="EN-US_TOPIC_0020091555__section29755367"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0020091555__p129873420511">Request parameters</p>
<p id="EN-US_TOPIC_0020091555__p09010492339">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0020091555__section63807311416"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0020091555__p15997202011527">Querying an image schema</p>
<pre class="screen" id="EN-US_TOPIC_0020091555__screen1257835842">GET https://{Endpoint}/v2/schemas/image</pre>
</div>
<div class="section" id="EN-US_TOPIC_0020091555__section66471715"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0020091555__ul10608892151520"><li id="EN-US_TOPIC_0020091555__li1736063111349">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091555__table1672858311351" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020091555__row3075245411351"><th align="left" class="cellrowborder" valign="top" width="30.646935306469352%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0020091555__p792088511351">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.18828117188281%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0020091555__p5897662019837">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.16478352164784%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0020091555__p3761198111351">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091555__row2667160511351"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091555__p1291637311351">additionalProperties</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091555__p1237692119837">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091555__p3959330211351">Specifies the additional attributes.</p>
<p id="EN-US_TOPIC_0020091555__p8731801205">For details, see <a href="#EN-US_TOPIC_0020091555__table5423151115912">Table 1</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row2079540211351"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091555__p670601511351">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091555__p6300656319837">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091555__p631632811351">Specifies the schema name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row5684695611351"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091555__p4120070311351">links</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091555__p325796919837">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091555__p4892261811351">Specifies the URL for accessing the schema.</p>
<p id="EN-US_TOPIC_0020091555__p8416185214528">For details, see <a href="#EN-US_TOPIC_0020091555__table15641103183416">Table 2</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row3765038211351"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020091555__p2978213811351">properties</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020091555__p6256894019837">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020091555__p339831010531">Describes basic image attributes, including the type and usage of each attribute.</p>
<p id="EN-US_TOPIC_0020091555__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_0020091555__table5423151115912"></a><a name="table5423151115912"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091555__table5423151115912" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure description of the additionalProperties field</caption><thead align="left"><tr id="EN-US_TOPIC_0020091555__row642361112917"><th align="left" class="cellrowborder" valign="top" width="23.817618238176184%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0020091555__p242310111393">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.01759824017598%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0020091555__p442341114911">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.16478352164784%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0020091555__p7423311695">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091555__row2042314117915"><td class="cellrowborder" valign="top" width="23.817618238176184%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0020091555__p44231811295">type</p>
</td>
<td class="cellrowborder" valign="top" width="24.01759824017598%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0020091555__p24231911297">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0020091555__p15423131112920">Type</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020091555__table15641103183416"></a><a name="table15641103183416"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091555__table15641103183416" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure description of the links field</caption><thead align="left"><tr id="EN-US_TOPIC_0020091555__row136411132345"><th align="left" class="cellrowborder" valign="top" width="30.646935306469352%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0020091555__p136411433347">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.18828117188281%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0020091555__p12641193183412">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.16478352164784%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0020091555__p164120311348">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091555__row4641634345"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0020091555__p126411432347">href</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0020091555__p1864133173419">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0020091555__p16411373420">Specifies the domain name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row146411238348"><td class="cellrowborder" valign="top" width="30.646935306469352%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0020091555__p156421039346">rel</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0020091555__p196421736343">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.16478352164784%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0020091555__p1164263163416">Specifies the domain name description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020091555__li20696973151520">Example response<pre class="codeblock" id="EN-US_TOPIC_0020091555__codeblock196137214713">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020091555__screen1915124214659"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s">&quot;additionalProperties&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span>
<span class="p">},</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;image&quot;</span><span class="p">,</span>
<span class="s">&quot;links&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="p">{</span>
<span class="s">&quot;href&quot;</span><span class="p">:</span> <span class="s">&quot;{self}&quot;</span><span class="p">,</span>
<span class="s">&quot;rel&quot;</span><span class="p">:</span> <span class="s">&quot;self&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;href&quot;</span><span class="p">:</span> <span class="s">&quot;{file}&quot;</span><span class="p">,</span>
<span class="s">&quot;rel&quot;</span><span class="p">:</span> <span class="s">&quot;enclosure&quot;</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s">&quot;href&quot;</span><span class="p">:</span> <span class="s">&quot;{schema}&quot;</span><span class="p">,</span>
<span class="s">&quot;rel&quot;</span><span class="p">:</span> <span class="s">&quot;describedby&quot;</span>
<span class="p">}</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;properties&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;status&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;enum&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="s">&quot;queued&quot;</span><span class="p">,</span>
<span class="s">&quot;saving&quot;</span><span class="p">,</span>
<span class="s">&quot;active&quot;</span><span class="p">,</span>
<span class="s">&quot;killed&quot;</span><span class="p">,</span>
<span class="s">&quot;deleted&quot;</span><span class="p">,</span>
<span class="s">&quot;pending_delete&quot;</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Status of the image (READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;tags&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;items&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;maxLength&quot;</span><span class="p">:</span> <span class="mi">255</span>
<span class="p">},</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;array&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;List of strings related to the image&quot;</span>
<span class="p">},</span>
<span class="s">&quot;kernel_id&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;pattern&quot;</span><span class="p">:</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="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</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="s">&quot;is_base&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="s">&quot;container_format&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;enum&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="s">&quot;ami&quot;</span><span class="p">,</span>
<span class="s">&quot;ari&quot;</span><span class="p">,</span>
<span class="s">&quot;aki&quot;</span><span class="p">,</span>
<span class="s">&quot;bare&quot;</span><span class="p">,</span>
<span class="s">&quot;ovf&quot;</span><span class="p">,</span>
<span class="s">&quot;ova&quot;</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Format of the container&quot;</span>
<span class="p">},</span>
<span class="s">&quot;min_ram&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Amount of ram (in MB) required to boot image.&quot;</span>
<span class="p">},</span>
<span class="s">&quot;ramdisk_id&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;pattern&quot;</span><span class="p">:</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="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</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="s">&quot;is_base&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="s">&quot;locations&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;items&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;required&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="s">&quot;url&quot;</span><span class="p">,</span>
<span class="s">&quot;metadata&quot;</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;object&quot;</span><span class="p">,</span>
<span class="s">&quot;properties&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;url&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;maxLength&quot;</span><span class="p">:</span> <span class="mi">255</span>
<span class="p">},</span>
<span class="s">&quot;metadata&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;object&quot;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;array&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;A set of URLs to access the image file kept in external store&quot;</span>
<span class="p">},</span>
<span class="s">&quot;visibility&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;enum&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="s">&quot;public&quot;</span><span class="p">,</span>
<span class="s">&quot;private&quot;</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Scope of image accessibility&quot;</span>
<span class="p">},</span>
<span class="s">&quot;updated_at&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Date and time of the last image modification (READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;owner&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Owner of the image&quot;</span><span class="p">,</span>
<span class="s">&quot;maxLength&quot;</span><span class="p">:</span> <span class="mi">255</span>
<span class="p">},</span>
<span class="s">&quot;file&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;(READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;min_disk&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Amount of disk space (in GB) required to boot image.&quot;</span>
<span class="p">},</span>
<span class="s">&quot;virtual_size&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Virtual size of image in bytes (READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;pattern&quot;</span><span class="p">:</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="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;An identifier for the image&quot;</span>
<span class="p">},</span>
<span class="s">&quot;size&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;integer&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Size of image file in bytes (READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;instance_uuid&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;ID of instance used to create this image.&quot;</span><span class="p">,</span>
<span class="s">&quot;is_base&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="s">&quot;os_distro&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</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="s">&quot;is_base&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Descriptive name for the image&quot;</span><span class="p">,</span>
<span class="s">&quot;maxLength&quot;</span><span class="p">:</span> <span class="mi">255</span>
<span class="p">},</span>
<span class="s">&quot;checksum&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;md5 hash of image contents. (READ-ONLY)&quot;</span><span class="p">,</span>
<span class="s">&quot;maxLength&quot;</span><span class="p">:</span> <span class="mi">32</span>
<span class="p">},</span>
<span class="s">&quot;created_at&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Date and time of image registration (READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;disk_format&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;enum&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="s">&quot;ami&quot;</span><span class="p">,</span>
<span class="s">&quot;ari&quot;</span><span class="p">,</span>
<span class="s">&quot;aki&quot;</span><span class="p">,</span>
<span class="s">&quot;vhd&quot;</span><span class="p">,</span>
<span class="s">&quot;vmdk&quot;</span><span class="p">,</span>
<span class="s">&quot;raw&quot;</span><span class="p">,</span>
<span class="s">&quot;qcow2&quot;</span><span class="p">,</span>
<span class="s">&quot;vdi&quot;</span><span class="p">,</span>
<span class="s">&quot;iso&quot;</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Format of the disk&quot;</span>
<span class="p">},</span>
<span class="s">&quot;os_version&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;Operating system version as specified by the distributor&quot;</span><span class="p">,</span>
<span class="s">&quot;is_base&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="s">&quot;protected&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;boolean&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;If true, image will not be deletable.&quot;</span>
<span class="p">},</span>
<span class="s">&quot;architecture&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</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="s">&quot;is_base&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">},</span>
<span class="s">&quot;direct_url&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;URL to access the image file kept in external store (READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;self&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;(READ-ONLY)&quot;</span>
<span class="p">},</span>
<span class="s">&quot;schema&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;string&quot;</span><span class="p">,</span>
<span class="s">&quot;description&quot;</span><span class="p">:</span> <span class="s">&quot;(READ-ONLY)&quot;</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</td></tr></table></div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020091555__section61374531"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0020091555__ul31470215"><li id="EN-US_TOPIC_0020091555__li14796483">Normal<p id="EN-US_TOPIC_0020091555__p66059488"><a name="EN-US_TOPIC_0020091555__li14796483"></a><a name="li14796483"></a>200</p>
</li><li id="EN-US_TOPIC_0020091555__li57664488">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020091555__table271454817439" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020091555__row3541095017439"><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_0020091555__p4971469317439">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_0020091555__p35835717439"><strong id="EN-US_TOPIC_0020091555__b2568302162048">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020091555__row2902697417439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091555__p237466317439">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_0020091555__p5812997617439">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row5340773917439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091555__p3105962817439">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_0020091555__p3280197817439">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row2678235117439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091555__p2188683517439">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_0020091555__p2800317417439">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row16775501191954"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091555__p19013873191957">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_0020091555__p63728762191957">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row5070198217439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091555__p1321988617439">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_0020091555__p6417782617439">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020091555__row4072952517439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020091555__p1075724317439">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_0020091555__p6603036117439">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>
View Git Blame Copy Permalink