forked from docs/doc-exports
guoyanyan
db3ca7e730
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: guoyanyan <guoyanyan3@huawei.com> Co-committed-by: guoyanyan <guoyanyan3@huawei.com>
193 lines
16 KiB
HTML
193 lines
16 KiB
HTML
<a name="EN-US_TOPIC_0065817710"></a><a name="EN-US_TOPIC_0065817710"></a>
|
|
|
|
<h1 class="topictitle1">Querying Detailed Information About Disks (Discarded)</h1>
|
|
<div id="body1499652824862"><div class="section" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_section28902385"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p15524502">This API is used to query detailed information about disks.</p>
|
|
<p id="EN-US_TOPIC_0065817710__p143761914155614">This API has been discarded. Use the EVS API "Querying Details About All Disks (OpenStack Cinder API v2)".</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_section58794873"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p742294318453">GET /v2/{project_id}/os-volumes/detail</p>
|
|
<p id="EN-US_TOPIC_0065817710__p1693920395613">GET /v2.1/{project_id}/os-volumes/detail</p>
|
|
<div class="p" id="EN-US_TOPIC_0065817710__p155595308566"><a href="#EN-US_TOPIC_0065817710__en-us_topic_0057973210_table2814978410562">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817710__en-us_topic_0057973210_table2814978410562"></a><a name="en-us_topic_0057973210_table2814978410562"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_table2814978410562" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row4149654710562"><th align="left" class="cellrowborder" valign="top" width="33%" id="mcps1.3.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0065817710__p5187119">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0065817710__p17503500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44%" id="mcps1.3.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0065817710__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row3491217610562"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p931403110562">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p1623904210562">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44%" headers="mcps1.3.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_section46007812"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817710__p3747514711">N/A</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_section11417132"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817710__p118081621125718"><a href="#EN-US_TOPIC_0065817710__en-us_topic_0057973210_table20675657">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817710__en-us_topic_0057973210_table20675657"></a><a name="en-us_topic_0057973210_table20675657"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_table20675657" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row8633818"><th align="left" class="cellrowborder" valign="top" width="30.023002300230022%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0065817710__p62404314">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30.023002300230022%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0065817710__p3528183">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.953995399539956%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0065817710__p17347392">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row10702812"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p61621426">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p25279646">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p33755089">Specifies the disk ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row35360353"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p45616319">displayName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p3934325">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p43305739">Specifies the disk name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row54207338"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p28718233">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p44475525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p14578865">Specifies the disk status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row64100928"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p24792666">attachments</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p62048949">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p20789580">Specifies the attachment information about a disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row52888500"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p56110116">availabilityZone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p48625528">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p63661294">Specifies the AZ to which the disk belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row36080735"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p36858462">createdAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p32745478">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p27609454">Specifies the time when the disk was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row47158499"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p61742075">displayDescription</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p35052192">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p62465711">Specifies the disk description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row25320488"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p37693619">volumeType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p33284303">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p6071512">Specifies the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row54643614"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p64056647">snapshotId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p21205924">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p15397020">Specifies the snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row4355456"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p17247680">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p54884857">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p60492147">Specifies the disk metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row7558414"><td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p8251823">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30.023002300230022%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p64417965">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.953995399539956%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p61755870">Specifies the disk size.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_table10694153118228" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065817710__b1354696268114057">attachments</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row1770213111229"><th align="left" class="cellrowborder" valign="top" width="26.502650265026507%" id="mcps1.3.5.2.4.1.1"><p id="EN-US_TOPIC_0065817710__p928012114918">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.81248124812481%" id="mcps1.3.5.2.4.1.2"><p id="EN-US_TOPIC_0065817710__p142801315498">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.684868486848686%" id="mcps1.3.5.2.4.1.3"><p id="EN-US_TOPIC_0065817710__p4295171184915">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row17709183112211"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p5711203142219">device</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.81248124812481%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p371215313222">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.684868486848686%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p87146313224">Specifies the directory to which the disk is mounted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row11715153182215"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p197177319224">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.81248124812481%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p1719183182216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.684868486848686%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p97211331142215">Specifies the ID of the attached resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row117221431132216"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p37244312222">serverId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.81248124812481%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p11726103113222">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.684868486848686%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p18728731122219">Specifies the <span id="EN-US_TOPIC_0065817710__text1394815101417">ECS</span> ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_row1729193182219"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p673013122218">volumeId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.81248124812481%" headers="mcps1.3.5.2.4.1.2 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p1573210319222">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.684868486848686%" headers="mcps1.3.5.2.4.1.3 "><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_p97342312223">Specifies the ID of the attached disk.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_section35645325"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065817710__screen92051516120">GET https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/detail
|
|
GET https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/detail</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817710__section1142813459392"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817710__screen1944014513910">{
|
|
"volumes": [
|
|
{
|
|
"status": "available",
|
|
"attachments": [{}],
|
|
"availabilityZone": "nova",
|
|
"createdAt": "2016-05-20T07:57:56.299000",
|
|
"displayDescription": null,
|
|
"volumeType": null,
|
|
"dispalyName": "test",
|
|
"snapshotId": null,
|
|
"metadata": {},
|
|
"id": "70b14513-faad-4646-b7ab-a065cef282b4",
|
|
"size": 1
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817710__en-us_topic_0057973210_en-us_topic_0020212692_p23670760">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_0267427881.html">Disk Management (OpenStack Nova APIs)</a></div>
|
|
</div>
|
|
</div>
|
|
|