vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/ecs/api-ref/en-us_topic_0065817697.html
Artem Goncharov 3196b64bfc
move doc sources to other location (#3) 
move doc sources to other location

Reviewed-by: OpenTelekomCloud Bot <None>
2022-04-27 16:24:25 +00:00

222 lines
18 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0065817697"></a><a name="EN-US_TOPIC_0065817697"></a>
<h1 class="topictitle1">Querying Details About a Specified Image (Discarded)</h1>
<div id="body1499652824861"><div class="section" id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_section56055574"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_p39331393">This API is used to query the details about the specified image.</p>
<p id="EN-US_TOPIC_0065817697__p14165715134410">This API has been discarded. Use the API described in "Querying Images (Native OpenStack API)".</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_section34738119"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817697__p1998019943718">GET /v2/{project_id}/images/{image_id}</p>
<p id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_p17835728145012">GET /v2.1/{project_id}/images/{image_id}</p>
<div class="p" id="EN-US_TOPIC_0065817697__p1221421185016"><a href="#EN-US_TOPIC_0065817697__table105393143396">Table 1</a> describes the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817697__table105393143396"></a><a name="table105393143396"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817697__table105393143396" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817697__row135398142394"><th align="left" class="cellrowborder" valign="top" width="23.472347234723472%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065817697__p18679020203913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.3020302030203%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065817697__p196792203393">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.22562256225623%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065817697__p8679102018395">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817697__row15392146399"><td class="cellrowborder" valign="top" width="23.472347234723472%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p1167912202398">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.3020302030203%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p7679152018395">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.22562256225623%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p2067912208392">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row45393148398"><td class="cellrowborder" valign="top" width="23.472347234723472%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p66791120163916">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.3020302030203%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p1679020173910">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="56.22562256225623%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p1767912013912">Specifies the image ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_section24047537"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_p56054053">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_section15101241"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817697__p3192102805112"><a href="#EN-US_TOPIC_0065817697__table128661753193915">Table 2</a> describes the response parameters.</p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817697__table128661753193915"></a><a name="table128661753193915"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817697__table128661753193915" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817697__row1586795319396"><th align="left" class="cellrowborder" valign="top" width="25.180000000000003%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0065817697__p138055754016">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0065817697__p680614794017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.82%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0065817697__p88063794014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817697__row1867185312398"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p1380613704018">id</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p180617717402">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p68067717402">Specifies the image ID in UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row586712532394"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p680617754011">links</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p4806772406">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p1580610734010">Specifies the shortcut link of the image.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row14867553123910"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p208061475402">name</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p6806137124012">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p1880617114019">Specifies the image name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row286713539397"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p1980610754010">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p148061876409">Object</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p6806579403">Specifies the key pair of the metadata.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row1486725343918"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p1780647144015">OS-EXT-IMG-SIZE:size</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p11806177124016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p14806177124011">Specifies the image size. The value must be greater than zero.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row8867135319391"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p16806770409">minDisk</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p4806127174019">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p1180687114011">Specifies the minimum disk size in GB required by the image. The value must be greater than zero.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row128675536392"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p158067714408">minRam</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p17806770409">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p1806207204016">Specifies the minimum memory size in GB required by the image. The value must be greater than zero.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row786755319398"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p18061877409">progress</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p78061973408">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p8806107114020">Specifies the image upload progress. The value must be greater than zero.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row78671753133915"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p1280613774016">status</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p11806271404">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p128061378408">Specifies the image status.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row158671753123915"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p178061773401">created</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p1680667124018">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p12806876404">Specifies the image creation time. The value is in ISO8601 format, such as <strong id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_b49080483">2013-06-09T06:42:18Z</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__row2867195313392"><td class="cellrowborder" valign="top" width="25.180000000000003%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817697__p1480612717408">updated</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817697__p98071773408">String</p>
</td>
<td class="cellrowborder" valign="top" width="46.82%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817697__p1180719774018">Specifies the image update time. The value is in ISO8601 format, such as <strong id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_b59084293">2013-06-09T06:42:18Z</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817697__table82851550164111" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_b842352706145746">links</strong> parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_row54901254195115"><th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_p131661047125817">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.43%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_p15166194715818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.3%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_p10166194719587">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="39.300000000000004%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_p91661478589">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_row1549185415113"><td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p1449195414513">href</p>
</td>
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p1449195455118">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p449195425114">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.300000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p18491754135111">Specifies the link of the corresponding resource.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_row16491145435118"><td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p4491155415518">rel</p>
</td>
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p2491185485110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p1449165411514">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.300000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p44540131181624">The value can be:</p>
<ul id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_ul50320171175059"><li id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_li36094530175059"><strong id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_b11003816175111">self</strong>: A self link contains a version link to the resource. Use these links when the link is followed immediately.</li><li id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_li65166619175136"><strong id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_b60630642175154">bookmark</strong>: A bookmark link provides a permanent link to a resource, which is suitable for long term storage.</li><li id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_li46931809175232"><strong id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_b28772520175321">alternate</strong>: An alternate link can contain an alternate representation of the resource. For example, an OpenStack Compute image may have an alternate representation in the OpenStack image service.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_row15491195465112"><td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p149145411510">type</p>
</td>
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p1949195405118">No</p>
</td>
<td class="cellrowborder" valign="top" width="25.3%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p649155425114">String</p>
</td>
<td class="cellrowborder" valign="top" width="39.300000000000004%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0065817697__en-us_topic_0065817695_en-us_topic_0057973086_p1671811201581">The type attribute provides a hint as to the type of representation to expect when following the link.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_section1693441"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065817697__screen161921584520">GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/images/17a1890b-0fa4-485e-8505-14e294017988
GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/images/17a1890b-0fa4-485e-8505-14e294017988</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817697__section1027013622314"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817697__screen32938612320">{
"image": {
"status": "ACTIVE",
"updated": "2015-12-27T02:52:25Z",
"name": "cirror",
"links": [
{
"href": "https://compute.localdomain.com:8001/v2/719e9483f42d4784a089862ac4c3e8d0/images/17a1890b-0fa4-485e-8505-14e294017988",
"rel": "self"
},
{
"href": "https://compute.localdomain.com:8001/719e9483f42d4784a089862ac4c3e8d0/images/17a1890b-0fa4-485e-8505-14e294017988",
"rel": "bookmark"
},
{
"href": "https://https://image.az2.dc1.domainname.com:443/719e9483f42d4784a089862ac4c3e8d0/images/17a1890b-0fa4-485e-8505-14e294017988",
"type": "application/vnd.openstack.image",
"rel": "alternate"
}
],
"created": "2015-12-27T02:52:24Z",
"minDisk": 0,
"progress": 100,
"minRam": 0,
"metadata": {
"__os_version": "CentOS 4.4 32bit",
"file_format": "img",
"file_name": "**.img",
"describe": "",
"__os_type": "Linux",
"virtual_env_type": "KVM",
"hw_disk_bus": "scsi"
},
"id": "17a1890b-0fa4-485e-8505-14e294017988",
"OS-EXT-IMG-SIZE:size": 13167616
}
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_section3564114017426"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817697__en-us_topic_0057973108_en-us_topic_0057972976_p5693111841619">See <a href="en-us_topic_0022067716.html">Returned Values for General Requests</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0065817680.html">Image Management (OpenStack Nova APIs)</a></div>
</div>
</div>
View Git Blame Copy Permalink