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_0049147876.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

166 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0049147876"></a><a name="EN-US_TOPIC_0049147876"></a>
<h1 class="topictitle1">Querying a Schema for an Image Sharing Member (Native OpenStack API)</h1>
<div id="body1487558065041"><div class="section" id="EN-US_TOPIC_0049147876__section4678164010456"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0049147876__p3121650210456">This API is used to query an image sharing member schema, which allows you to view image sharing member attributes and their data types.</p>
</div>
<div class="section" id="EN-US_TOPIC_0049147876__section1251307010456"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0049147876__p28709852111750">GET /v2/schemas/member</p>
</div>
<div class="section" id="EN-US_TOPIC_0049147876__section2411735110456"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0049147876__p162016719539">Request parameters</p>
<p id="EN-US_TOPIC_0049147876__p17316164873615">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0049147876__section75596919514"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0049147876__p164960513522">Querying a schema for an image sharing member</p>
<pre class="screen" id="EN-US_TOPIC_0049147876__screen957813151952">GET https://{Endpoint}/v2/schemas/member</pre>
</div>
<div class="section" id="EN-US_TOPIC_0049147876__section5835198610456"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0049147876__ul2889042610456"><li id="EN-US_TOPIC_0049147876__li5868724710456">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0049147876__table5842318310456" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0049147876__row6525201010456"><th align="left" class="cellrowborder" valign="top" width="30.486951304869514%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0049147876__p5092146210456">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.078292170782923%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0049147876__p2779017510456">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.434756524347556%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0049147876__p3641172510456">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0049147876__row6366858710456"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0049147876__p5688188910456">name</p>
</td>
<td class="cellrowborder" valign="top" width="17.078292170782923%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0049147876__p968421510456">String</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0049147876__p4622397510456">Specifies the schema name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147876__row1336259710456"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0049147876__p862856110456">properties</p>
</td>
<td class="cellrowborder" valign="top" width="17.078292170782923%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0049147876__p3921638110456">Object</p>
</td>
<td class="cellrowborder" valign="top" width="52.434756524347556%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0049147876__p1622165310562">Describes basic image attributes, including the type and usage of each attribute.</p>
<p id="EN-US_TOPIC_0049147876__p4120204111445">For details about the parameters, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0049147876__li2966857710456">Example response<pre class="codeblock" id="EN-US_TOPIC_0049147876__codeblock27264038214942">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0049147876__screen22235237104542"><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></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;member&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;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;pending&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;accepted&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;rejected&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;The status of this image member&quot;</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 member creation&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 last modification of image member&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="s">&quot;image_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;member_id&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;An identifier for the image member (tenantId)&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;readOnly&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">true</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_0049147876__section3184290310456"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0049147876__ul2913831810456"><li id="EN-US_TOPIC_0049147876__li6091827610456">Normal<p id="EN-US_TOPIC_0049147876__p1139357810456"><a name="EN-US_TOPIC_0049147876__li6091827610456"></a><a name="li6091827610456"></a>200</p>
</li><li id="EN-US_TOPIC_0049147876__li3543334610456">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0049147876__table5046465910456" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0049147876__row5279442910456"><th align="left" class="cellrowborder" valign="top" width="46.46%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0049147876__p4849034810456">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.54%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0049147876__p3540414010456">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0049147876__row4916310910456"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147876__p2278886210456">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0049147876__p3395849510456">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147876__row3719100210456"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147876__p5968121110456">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0049147876__p233996110456">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147876__row2105965410456"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147876__p2811042610456">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0049147876__p6235199710456">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147876__row2429706910456"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147876__p2190558110456">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0049147876__p2952161710456">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147876__row6436796410456"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147876__p4642261010456">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0049147876__p213507210456">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147876__row1921565610456"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147876__p1296433510456">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0049147876__p4347817710456">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