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

167 lines
13 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0102682865"></a><a name="EN-US_TOPIC_0102682865"></a>
<h1 class="topictitle1">Querying Tags of an Image</h1>
<div id="body1521538011494"><div class="section" id="EN-US_TOPIC_0102682865__section9600505183747"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0102682865__p39443478183747">This API is used to query all the tags of a specified image.</p>
</div>
<div class="section" id="EN-US_TOPIC_0102682865__section26015555183747"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0102682865__p1141951812328">GET /v2/{project_id}/images/{image_id}/tags</p>
<div class="p" id="EN-US_TOPIC_0102682865__p2335192823210"><a href="#EN-US_TOPIC_0102682865__table16231211183747">Table 1</a> lists the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0102682865__table16231211183747"></a><a name="table16231211183747"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102682865__table16231211183747" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0102682865__row34211813183747"><th align="left" class="cellrowborder" valign="top" width="18.55814418558144%" id="mcps1.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0102682865__p19693454183747">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.58804119588041%" id="mcps1.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0102682865__p51665940183747">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.926907309269076%" id="mcps1.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0102682865__p24191582183747">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.926907309269076%" id="mcps1.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0102682865__p13361108183747">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102682865__row8508000183747"><td class="cellrowborder" valign="top" width="18.55814418558144%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0102682865__p18059367183747">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.58804119588041%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0102682865__p53522643183747">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30.926907309269076%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0102682865__p40366860183747">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.926907309269076%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0102682865__p48490233183747">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row33758919183747"><td class="cellrowborder" valign="top" width="18.55814418558144%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0102682865__p50117918183747">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.58804119588041%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0102682865__p33019549183747">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="30.926907309269076%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0102682865__p57337837183747">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.926907309269076%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0102682865__p13853238183747">Specifies the image ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0102682865__section57570279183747"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0102682865__p15250184963615">Request parameters</p>
<p id="EN-US_TOPIC_0102682865__p109101722123318">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0102682865__section12967123574417"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0102682865__p111213328368">Querying tags of an image</p>
<pre class="screen" id="EN-US_TOPIC_0102682865__screen1124694054420">GET https://{Endpoint}/v2/fd73a4a14a4a4dfb9771a8475e5198ea/images/67e17426-359e-49fb-aa12-0bd1756ec240/tags</pre>
</div>
<div class="section" id="EN-US_TOPIC_0102682865__section29913939183747"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0102682865__ul7110020183747"><li id="EN-US_TOPIC_0102682865__li63990188183747">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102682865__table39040786183747" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0102682865__row55439147183747"><th align="left" class="cellrowborder" valign="top" width="33.78337833783378%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0102682865__p61385912183747">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.78337833783378%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0102682865__p32677523183747">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.43324332433243%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0102682865__p29633713183747">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102682865__row51520592183747"><td class="cellrowborder" valign="top" width="33.78337833783378%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0102682865__p12418456183747">tags</p>
</td>
<td class="cellrowborder" valign="top" width="33.78337833783378%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0102682865__p7330880183747">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="32.43324332433243%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0102682865__p56930417183747">Lists the returned tags. For details, see <a href="#EN-US_TOPIC_0102682865__table47961066183747">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0102682865__table47961066183747"></a><a name="table47961066183747"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102682865__table47961066183747" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure description of the tags field</caption><thead align="left"><tr id="EN-US_TOPIC_0102682865__row12649451183747"><th align="left" class="cellrowborder" valign="top" width="34.22%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0102682865__p17972593183747">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.77%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0102682865__p7914788183747">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.01%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0102682865__p37118112183747">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102682865__row53777129183747"><td class="cellrowborder" valign="top" width="34.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0102682865__p60980198183747">key</p>
</td>
<td class="cellrowborder" valign="top" width="33.77%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0102682865__p55145502183747">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.01%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0102682865__p37600681183747">Specifies the tag key.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row2861810183747"><td class="cellrowborder" valign="top" width="34.22%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0102682865__p30480075183747">value</p>
</td>
<td class="cellrowborder" valign="top" width="33.77%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0102682865__p62466949183747">String</p>
</td>
<td class="cellrowborder" valign="top" width="32.01%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0102682865__p26658103183747">Specifies the tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0102682865__li848412151162">Example response<pre class="codeblock" id="EN-US_TOPIC_0102682865__codeblock1148319158162">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0102682865__screen8484141591614"><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></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;tags&quot;</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;value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value0&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;key0&quot;</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;value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;value0&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;key1&quot;</span>
<span class="w"> </span><span class="p">}</span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0102682865__section39295631183747"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0102682865__ul28829553183747"><li id="EN-US_TOPIC_0102682865__li58139392183747">Normal<p id="EN-US_TOPIC_0102682865__p53492480183747"><a name="EN-US_TOPIC_0102682865__li58139392183747"></a><a name="li58139392183747"></a>200</p>
</li><li id="EN-US_TOPIC_0102682865__li11670275183747">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0102682865__table37923619183747" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0102682865__row63239554183747"><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_0102682865__p22130264183747">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_0102682865__p47720966183747">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0102682865__row40193077183747"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0102682865__p34413837183747">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_0102682865__p36057397183747">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row56081118183747"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0102682865__p46276738183747">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_0102682865__p57428298183747">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row47092639183747"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0102682865__p56407449183747">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_0102682865__p5600684183747">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row50406158183747"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0102682865__p56366968183747">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_0102682865__p2321678183747">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row20895110183747"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0102682865__p14782346183747">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_0102682865__p56519407183747">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0102682865__row38912621183747"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0102682865__p64914630183747">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_0102682865__p23593683183747">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_0135481402.html">Image Tagging</a></div>
</div>
</div>
View Git Blame Copy Permalink