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_0065817709"></a><a name="EN-US_TOPIC_0065817709"></a>
|
|
|
|
<h1 class="topictitle1">Querying Brief Information About Disks (Discarded)</h1>
|
|
<div id="body1499652824862"><div class="section" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_section52409933"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p49716802">This API is used to query brief information about disks.</p>
|
|
<p id="EN-US_TOPIC_0065817709__p132575110566">This API has been discarded. Use the EVS API "Querying EVS Disks (OpenStack Cinder API v2)".</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_section1927356"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0065817709__p15859123111557">GET /v2/{project_id}/os-volumes</p>
|
|
<p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p742294318453">GET /v2.1/{project_id}/os-volumes</p>
|
|
<div class="p" id="EN-US_TOPIC_0065817709__p94892575414"><a href="#EN-US_TOPIC_0065817709__en-us_topic_0057973209_table2814978410562">Table 1</a> describes the parameters in the URI.
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817709__en-us_topic_0057973209_table2814978410562"></a><a name="en-us_topic_0057973209_table2814978410562"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_table2814978410562" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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_0065817709__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_0065817709__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_0065817709__p8497414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row3491217610562"><td class="cellrowborder" valign="top" width="33%" headers="mcps1.3.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_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_0065817709__p37593705">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_section62865382"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p39272452">N/A</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_section28917527"><h4 class="sectiontitle">Response</h4><p id="EN-US_TOPIC_0065817709__p7598136105413"><a href="#EN-US_TOPIC_0065817709__en-us_topic_0057973209_table26952071">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0065817709__en-us_topic_0057973209_table26952071"></a><a name="en-us_topic_0057973209_table26952071"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_table26952071" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row27956541"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.1"><p id="EN-US_TOPIC_0065817709__p62404314">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.2"><p id="EN-US_TOPIC_0065817709__p3528183">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.3.2.4.1.3"><p id="EN-US_TOPIC_0065817709__p17347392">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row31251660"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p48356531">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p24564930">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p42128507">Specifies the disk ID in UUID format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row43612244"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p42930836">displayName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p54845664">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p4678079">Specifies the disk name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row42102716"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p54876848">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p15839667">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p39539981">Specifies the disk status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row20315511"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p34943688">attachments</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p11866445">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p9464853">Specifies the attachment information about a disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row18074813"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p54773733">availabilityZone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p7487365">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p917327">Specifies the AZ to which the disk belongs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row8255951"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p64752280">createdAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p10443326">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p512574">Specifies the time when the disk was created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row4613174"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p38122810">displayDescription</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p939935">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p60011947">Specifies the disk description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row3236611"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p60838957">volumeType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p29008475">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p3869669">Specifies the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row34827024"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p2416665">snapshotId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p61532138">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p52543238">Specifies the snapshot ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row3127100"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p51968558">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p48703693">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p39631152">Specifies the disk metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row21136050"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p34298471">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.2 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p26712781">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.3.2.4.1.3 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_p41316042">Specifies the disk size.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_table10694153118228" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="EN-US_TOPIC_0065817709__b177485126911416">attachments</strong> field description</caption><thead align="left"><tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row1770213111229"><th align="left" class="cellrowborder" valign="top" width="26.502650265026507%" id="mcps1.3.5.2.4.1.1"><p id="EN-US_TOPIC_0065817709__p74471434194813">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_0065817709__p7463193414486">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_0065817709__p746323444816">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row17709183112211"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_p87146313224">Specifies the directory to which the disk is mounted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row11715153182215"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_p97211331142215">Specifies the ID of the attached resource.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row117221431132216"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_p18728731122219">Specifies the <span id="EN-US_TOPIC_0065817709__text55119302124">ECS</span> ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_row1729193182219"><td class="cellrowborder" valign="top" width="26.502650265026507%" headers="mcps1.3.5.2.4.1.1 "><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_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_0065817709__en-us_topic_0057973209_p97342312223">Specifies the ID of the attached disk.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_section58931151"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="EN-US_TOPIC_0065817709__screen933172710543">GET https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes
|
|
GET https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes</pre>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0065817709__section11315915113914"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="EN-US_TOPIC_0065817709__screen4322191511393">{
|
|
"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_0065817709__en-us_topic_0057973209_en-us_topic_0020212692_section22960139"><h4 class="sectiontitle">Returned Values</h4><p id="EN-US_TOPIC_0065817709__en-us_topic_0057973209_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>
|
|
|