doc-exports/docs/ims/api-ref/en-us_topic_0000001360879708.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

169 lines
14 KiB
HTML

<a name="EN-US_TOPIC_0000001360879708"></a><a name="EN-US_TOPIC_0000001360879708"></a>
<h1 class="topictitle1">Querying Image Member Details (Native OpenStack API)</h1>
<div id="body1472781317557"><div class="section" id="EN-US_TOPIC_0000001360879708__section16095919"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001360879708__p12149135153825">This API is used to query details about a tenant with whom the image is shared.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001360879708__section10645546"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000001360879708__p54992765">GET /v2/images/{image_id}/members/{member_id}</p>
<p id="EN-US_TOPIC_0000001360879708__p0259144710402"><a href="#EN-US_TOPIC_0000001360879708__table30282311">Table 1</a> lists the parameters in the URI.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001360879708__table30282311"></a><a name="table30282311"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001360879708__table30282311" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001360879708__row19672999"><th align="left" class="cellrowborder" valign="top" width="30.826917308269174%" id="mcps1.3.2.4.2.5.1.1"><p id="EN-US_TOPIC_0000001360879708__p50009058"><strong id="EN-US_TOPIC_0000001360879708__b229287162313">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.858214178582145%" id="mcps1.3.2.4.2.5.1.2"><p id="EN-US_TOPIC_0000001360879708__p24201902"><strong id="EN-US_TOPIC_0000001360879708__b44062192162316">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.48795120487951%" id="mcps1.3.2.4.2.5.1.3"><p id="EN-US_TOPIC_0000001360879708__p265296612135">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.826917308269174%" id="mcps1.3.2.4.2.5.1.4"><p id="EN-US_TOPIC_0000001360879708__p14197042">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001360879708__row41227749"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001360879708__p51113363">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001360879708__p46541742">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.48795120487951%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001360879708__p14189122135">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001360879708__p11784733">Specifies the image ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__row2063059215392"><td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.4.2.5.1.1 "><p id="EN-US_TOPIC_0000001360879708__p6493862015397">member_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.858214178582145%" headers="mcps1.3.2.4.2.5.1.2 "><p id="EN-US_TOPIC_0000001360879708__p2553690515397">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.48795120487951%" headers="mcps1.3.2.4.2.5.1.3 "><p id="EN-US_TOPIC_0000001360879708__p5522341415397">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.826917308269174%" headers="mcps1.3.2.4.2.5.1.4 "><p id="EN-US_TOPIC_0000001360879708__p4391153115397">Specifies the member ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001360879708__section28701056"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001360879708__ul1979218258361"><li id="EN-US_TOPIC_0000001360879708__li1951392964119">Request parameters<p id="EN-US_TOPIC_0000001360879708__p1964313516413"><a name="EN-US_TOPIC_0000001360879708__li1951392964119"></a><a name="li1951392964119"></a>None</p>
</li><li id="EN-US_TOPIC_0000001360879708__li15792182583615">Example request<pre class="codeblock" id="EN-US_TOPIC_0000001360879708__codeblock709371891739">GET https://{Endpoint}/v2/images/d164b5df-1bc3-4c3f-893e-3e471fd16e64/members/edc89b490d7d4392898e19b2deb34797</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001360879708__section56982912"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001360879708__ul4360927144536"><li id="EN-US_TOPIC_0000001360879708__li469292331109">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001360879708__table16258230194835" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001360879708__row23919935194835"><th align="left" class="cellrowborder" valign="top" width="34.21%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0000001360879708__p58466603194835">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.259999999999998%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0000001360879708__p38174436194835">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.53%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0000001360879708__p5121617194835">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001360879708__row12197851194835"><td class="cellrowborder" valign="top" width="34.21%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001360879708__p4684891915441">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001360879708__p1716373215441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001360879708__p4808503715441">Specifies the image sharing status.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__row48777806194835"><td class="cellrowborder" valign="top" width="34.21%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001360879708__p2316530815441">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001360879708__p5311862715441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001360879708__p764152715441">Specifies the time when a shared image was created. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__row43890908194835"><td class="cellrowborder" valign="top" width="34.21%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001360879708__p63809815441">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001360879708__p2581736815441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001360879708__p1083208215441">Specifies the time when a shared image was updated. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__row49474582194835"><td class="cellrowborder" valign="top" width="34.21%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001360879708__p4485096415441">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001360879708__p6192026915441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001360879708__p4948586215441">Specifies the image ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__row12639379194835"><td class="cellrowborder" valign="top" width="34.21%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001360879708__p3773344215441">member_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001360879708__p451900915441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001360879708__p3049545915441">Specifies the member ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__row13178544194835"><td class="cellrowborder" valign="top" width="34.21%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0000001360879708__p1815619715441">schema</p>
</td>
<td class="cellrowborder" valign="top" width="16.259999999999998%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0000001360879708__p458118315441">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.53%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0000001360879708__p3553152415441">Specifies the sharing schema.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001360879708__li39248344144536">Example response<pre class="codeblock" id="EN-US_TOPIC_0000001360879708__codeblock196137214713">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0000001360879708__screen12526993174750"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2
3
4
5
6
7
8</pre></div></td><td class="code"><div class="highlight"><pre><span></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>
</pre></div>
</td></tr></table></div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001360879708__section61374531"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0000001360879708__ul31470215"><li id="EN-US_TOPIC_0000001360879708__li14796483">Normal<p id="EN-US_TOPIC_0000001360879708__p66059488"><a name="EN-US_TOPIC_0000001360879708__li14796483"></a><a name="li14796483"></a>200</p>
</li><li id="EN-US_TOPIC_0000001360879708__li57664488">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001360879708__table271454817439" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__p4971469317439"><strong>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_0000001360879708__p35835717439"><strong id="EN-US_TOPIC_0000001360879708__b5556627162323">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__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_0000001360879708__p5812997617439">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__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_0000001360879708__p3280197817439">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__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_0000001360879708__p2800317417439">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__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_0000001360879708__p63728762191957">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__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_0000001360879708__p6417782617439">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001360879708__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_0000001360879708__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_0000001360879708__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>