vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
2c9359c16c3ecaa767e89ba2b715c166e6851a2f
doc-exports/docs/ims/api-ref/en-us_topic_0000001411479497.html
Hasko, Vladimir 0c7b91f4bd Initial import of IMS API 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2022-10-05 08:51:25 +00:00

197 lines
16 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000001411479497"></a><a name="EN-US_TOPIC_0000001411479497"></a>
<h1 class="topictitle1">Querying Image Members (Native OpenStack API)</h1>
<div id="body1472781317558"><div class="section" id="EN-US_TOPIC_0000001411479497__section24723024"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001411479497__p46640084">This API is used to query the tenants with whom an image is shared using search criteria and to display the tenants in a list.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001411479497__section21180630"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001411479497__p56283646">GET /v2/images/{image_id}/members</p>
<div class="p" id="EN-US_TOPIC_0000001411479497__p284911004210"><a href="#EN-US_TOPIC_0000001411479497__table27262282">Table 1</a> lists the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001411479497__table27262282"></a><a name="table27262282"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001411479497__table27262282" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001411479497__row27551015"><th align="left" class="cellrowborder" valign="top" width="25.75%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0000001411479497__p17039762"><strong id="EN-US_TOPIC_0000001411479497__b65605719162353">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0000001411479497__p38043494"><strong id="EN-US_TOPIC_0000001411479497__b45657467162356">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.61%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0000001411479497__p1119157921331">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.830000000000002%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0000001411479497__p61624137">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001411479497__row25499238"><td class="cellrowborder" valign="top" width="25.75%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001411479497__p52172387">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001411479497__p65213800">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.61%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001411479497__p3410274521331">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.830000000000002%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001411479497__p47826462">Specifies the image ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001411479497__section56407950"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001411479497__ul100113315364"><li id="EN-US_TOPIC_0000001411479497__li1185173504213">Request parameters<p id="EN-US_TOPIC_0000001411479497__p596153854212"><a name="EN-US_TOPIC_0000001411479497__li1185173504213"></a><a name="li1185173504213"></a>None</p>
</li><li id="EN-US_TOPIC_0000001411479497__li901833193617">Example request<pre class="codeblock" id="EN-US_TOPIC_0000001411479497__codeblock15382642173442">GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001411479497__section37909503"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001411479497__ul6090658817582"><li id="EN-US_TOPIC_0000001411479497__li1128838317582">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001411479497__table3448659117582" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001411479497__row1240616417582"><th align="left" class="cellrowborder" valign="top" width="30.486951304869514%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0000001411479497__p6537523417582">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.078292170782923%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0000001411479497__p3416692117582">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.434756524347556%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0000001411479497__p1605720117582">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001411479497__row2556488117582"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p202041354101614">members</p>
</td>
<td class="cellrowborder" valign="top" width="17.078292170782923%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p102036546164">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p1420210549169">Specifies the members.</p>
<p id="EN-US_TOPIC_0000001411479497__p05981305593">For details, see <a href="#EN-US_TOPIC_0000001411479497__table47745347163">Table 2</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row5330047317582"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p2237105217582">schema</p>
</td>
<td class="cellrowborder" valign="top" width="17.078292170782923%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p939051217582">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p2243400117582">Specifies the sharing schema.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001411479497__table47745347163"></a><a name="table47745347163"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001411479497__table47745347163" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure description of the members field</caption><thead align="left"><tr id="EN-US_TOPIC_0000001411479497__row177518341163"><th align="left" class="cellrowborder" valign="top" width="30.486951304869514%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001411479497__p157751734151616">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.987401259874016%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001411479497__p377543421614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.525647435256474%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001411479497__p14775103451614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001411479497__row877510347162"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p27752348167">status</p>
</td>
<td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p57752347164">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.525647435256474%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p17755341167">Specifies the image sharing status.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row2775113417167"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p577543414167">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p17775534161611">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.525647435256474%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p47756349164">Specifies the time when a shared image was created. The value is in UTC format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row1477583419160"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p577523419160">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p187759346162">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.525647435256474%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p1277553417163">Specifies the time when a shared image was updated. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row8776634121612"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p2776113410160">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p197761034141614">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.525647435256474%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p7776143461612">Specifies the image ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row4776183417161"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p6776203420161">member_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p1377620348165">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.525647435256474%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p147761734171613">Specifies the member ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row8776163481619"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001411479497__p37761534151618">schema</p>
</td>
<td class="cellrowborder" valign="top" width="25.987401259874016%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001411479497__p11776163431611">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.525647435256474%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001411479497__p7776123401620">Specifies the sharing schema.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001411479497__li1839392718049">Example response<pre class="codeblock" id="EN-US_TOPIC_0000001411479497__codeblock196137214713">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000001411479497__screen1782369418021"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 1
2
3
4
5
6
7
8
9
10
11
12
13</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="p">{</span>
<span class="s">&quot;members&quot;</span><span class="p">:</span> <span class="o">[</span>
<span class="p">{</span>
<span class="s">&quot;status&quot;</span><span class="p">:</span> <span class="s">&quot;accepted&quot;</span><span class="p">,</span>
<span class="s">&quot;created_at&quot;</span><span class="p">:</span> <span class="s">&quot;2016-09-01T02:05:14Z&quot;</span><span class="p">,</span>
<span class="s">&quot;updated_at&quot;</span><span class="p">:</span> <span class="s">&quot;2016-09-01T02:37:11Z&quot;</span><span class="p">,</span>
<span class="s">&quot;image_id&quot;</span><span class="p">:</span> <span class="s">&quot;d164b5df-1bc3-4c3f-893e-3e471fd16e64&quot;</span><span class="p">,</span>
<span class="s">&quot;member_id&quot;</span><span class="p">:</span> <span class="s">&quot;edc89b490d7d4392898e19b2deb34797&quot;</span><span class="p">,</span>
<span class="s">&quot;schema&quot;</span><span class="p">:</span> <span class="s">&quot;/v2/schemas/member&quot;</span>
<span class="p">}</span>
<span class="o">]</span><span class="p">,</span>
<span class="s">&quot;schema&quot;</span><span class="p">:</span> <span class="s">&quot;/v2/schemas/members&quot;</span>
<span class="p">}</span>
</pre></div>
</td></tr></table></div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001411479497__section61374531"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0000001411479497__ul31470215"><li id="EN-US_TOPIC_0000001411479497__li14796483">Normal<p id="EN-US_TOPIC_0000001411479497__p66059488"><a name="EN-US_TOPIC_0000001411479497__li14796483"></a><a name="li14796483"></a>200</p>
</li><li id="EN-US_TOPIC_0000001411479497__li57664488">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001411479497__table271454817439" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001411479497__row3541095017439"><th align="left" class="cellrowborder" valign="top" width="46.54%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0000001411479497__p4971469317439"><strong id="EN-US_TOPIC_0000001411479497__b63549115204622">Returned Value</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.459999999999994%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0000001411479497__p35835717439"><strong id="EN-US_TOPIC_0000001411479497__b84235270616929">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001411479497__row2902697417439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001411479497__p237466317439">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001411479497__p5812997617439">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row5340773917439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001411479497__p3105962817439">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001411479497__p3280197817439">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row2678235117439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001411479497__p2188683517439">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001411479497__p2800317417439">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row16775501191954"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001411479497__p19013873191957">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001411479497__p63728762191957">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row5070198217439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001411479497__p1321988617439">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001411479497__p6417782617439">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001411479497__row4072952517439"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0000001411479497__p1075724317439">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0000001411479497__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_0000001361039248.html">Image Sharing (Native OpenStack APIs)</a></div>
</div>
</div>
View Git Blame Copy Permalink