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

234 lines
19 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0049147877"></a><a name="EN-US_TOPIC_0049147877"></a>
<h1 class="topictitle1">Querying a Schema for an Image Sharing Member List (Native OpenStack API)</h1>
<div id="body1487558065041"><div class="section" id="EN-US_TOPIC_0049147877__section16441043104828"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0049147877__p56656069104828">This API is used to query an image sharing member list schema, which allows you to view image sharing member attributes and their data types.</p>
</div>
<div class="section" id="EN-US_TOPIC_0049147877__section40142579104828"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0049147877__p55906962111756">GET /v2/schemas/members</p>
</div>
<div class="section" id="EN-US_TOPIC_0049147877__section40279828104828"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0049147877__p9918320536">Request parameters</p>
<p id="EN-US_TOPIC_0049147877__p139351426193715">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0049147877__section187271391252"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0049147877__p1879463925319">Querying a schema for an image sharing member list</p>
<pre class="screen" id="EN-US_TOPIC_0049147877__screen106991142458">GET https://{Endpoint}/v2/schemas/members</pre>
</div>
<div class="section" id="EN-US_TOPIC_0049147877__section1248471104828"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0049147877__ul34017354104828"><li id="EN-US_TOPIC_0049147877__li37720732104828">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0049147877__table3942269104828" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0049147877__row39362799104828"><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_0049147877__p34270171104828">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_0049147877__p31903489104828">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_0049147877__p34045835104828">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0049147877__row6249241104828"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0049147877__p36426516104828">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_0049147877__p19708015104828">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_0049147877__p52845343104828">Specifies the schema name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row5846040104828"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0049147877__p3767226104828">links</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_0049147877__p20709999104828">Array of objects</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_0049147877__p66897235104828">Specifies the URL for accessing the schema.</p>
<p id="EN-US_TOPIC_0049147877__p13897123335712">For details, see <a href="#EN-US_TOPIC_0049147877__table15641103183416">Table 1</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row65204203104828"><td class="cellrowborder" valign="top" width="30.486951304869514%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0049147877__p47049086104828">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_0049147877__p55391618104828">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_0049147877__p1582015495573">Describes basic image attributes, including the type and usage of each attribute.</p>
<p id="EN-US_TOPIC_0049147877__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_0049147877__table15641103183416"></a><a name="table15641103183416"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0049147877__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_0049147877__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_0049147877__p136411433347">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.18828117188281%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0049147877__p12641193183412">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_0049147877__p164120311348">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0049147877__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_0049147877__p126411432347">href</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0049147877__p1864133173419">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_0049147877__p16411373420">Specifies the domain name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__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_0049147877__p156421039346">rel</p>
</td>
<td class="cellrowborder" valign="top" width="17.18828117188281%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0049147877__p196421736343">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_0049147877__p1164263163416">Specifies the domain name description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0049147877__li752889104828">Example response<pre class="codeblock" id="EN-US_TOPIC_0049147877__codeblock27264038214942">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0049147877__screen2222022105010"><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></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;members&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;{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;members&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;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="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="p">}</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0049147877__section57883339104828"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0049147877__ul58038920104828"><li id="EN-US_TOPIC_0049147877__li52588235104828">Normal<p id="EN-US_TOPIC_0049147877__p3532069104828"><a name="EN-US_TOPIC_0049147877__li52588235104828"></a><a name="li52588235104828"></a>200</p>
</li><li id="EN-US_TOPIC_0049147877__li31788623104828">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0049147877__table17662154104828" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0049147877__row60824774104828"><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_0049147877__p27859693104828">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_0049147877__p42042623104828"><strong id="EN-US_TOPIC_0049147877__b842352706104623">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0049147877__row50009318104828"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147877__p24222986104828">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_0049147877__p15904850104828">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row8925927104828"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147877__p51911521104828">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_0049147877__p44083700104828">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row61208982104828"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147877__p58980480104828">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_0049147877__p12689558104828">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row47097166104828"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147877__p56774098104828">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_0049147877__p35299255104828">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row49257845104828"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147877__p30462542104828">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_0049147877__p51546843104828">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0049147877__row61268409104828"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0049147877__p63794096104828">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_0049147877__p67048143104828">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