forked from docs/doc-exports
zhangyue
ccbf63b495
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com> Co-authored-by: zhangyue <zhangyue164@huawei.com> Co-committed-by: zhangyue <zhangyue164@huawei.com>
226 lines
16 KiB
HTML
226 lines
16 KiB
HTML
<a name="evs_04_2072"></a><a name="evs_04_2072"></a>
|
|
|
|
<h1 class="topictitle1">Querying Details About an EVS Disk Type</h1>
|
|
<div id="body65573909"><div class="section" id="evs_04_2072__section48630964"><h4 class="sectiontitle">Function</h4><p id="evs_04_2072__p9886408">This API is used to query details about an EVS disk type.</p>
|
|
</div>
|
|
<div class="section" id="evs_04_2072__section35025494"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2072__ul62601592"><li id="evs_04_2072__li26543418">URI format<p id="evs_04_2072__p2533231"><a name="evs_04_2072__li26543418"></a><a name="li26543418"></a>GET /v2/{project_id}/types/{type_id}</p>
|
|
</li><li id="evs_04_2072__li22799085">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2072__table3865173" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2072__row43603258"><th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2072__p42202994">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2072__p62999330">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.739999999999995%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2072__p2672115">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2072__row15114764"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2072__p16336406">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2072__p48180537">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.739999999999995%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2072__p10309404">Specifies the project ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row25675773"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2072__p66471715">type_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2072__p15499871">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.739999999999995%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2072__p47530006">Specifies the disk type ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2072__section46793998"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2072__ul11152033120"><li id="evs_04_2072__li1815190173113">Example request<pre class="screen" id="evs_04_2072__screen1411685103115">GET https://{endpoint}/v2/{project_id}/types/6c81c680-df58-4512-81e7-ecf66d160638</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2072__section18492804"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2072__ul56592155"><li id="evs_04_2072__li1342431110465">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2072__table154241211124616" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2072__row342551116468"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2072__p14251411164617">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2072__p642517110469">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2072__p104258110465">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2072__row8425131110465"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2072__p2425101134615">volume_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2072__p5425011174619">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2072__p9425181174611">Specifies the details of queried disk types. For details, see <a href="#evs_04_2072__li27654073201555">Parameters in the volume_type field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row1742591164617"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2072__p129522216412">error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2072__p1595262111415">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2072__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2072__li0419202382514">Parameters in the error field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2072__li27654073201555"><a name="evs_04_2072__li27654073201555"></a><a name="li27654073201555"></a>Parameters in the <strong id="evs_04_2072__b249641714614">volume_type</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2072__table6170753515253" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2072__row4217445215253"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2072__p6068742915253">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2072__p1673474815253">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2072__p658034115253">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2072__row6324564115253"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2072__p2262329715253">extra_specs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2072__p2054778215253">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2072__p5940085315253">Specifies the disk type specifications. For details, see <a href="#evs_04_2072__li1957456185414">Parameters in the extra_specs field</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row1760216615253"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2072__p1648936615253">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2072__p6057028715253">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2072__p5006999315253">Specifies the name of the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row4797675615253"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2072__p6091205315253">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2072__p3492929915253">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2072__p6147315615253">Specifies the ID of the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row29065010162354"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2072__p42044028162413">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2072__p50123125162413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2072__p24390255162413">Specifies the description of the disk type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row18405511162410"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2072__p63756107162413">qos_specs_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2072__p63971081162413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2072__p15431098162413"><span id="evs_04_2072__text381293214497">The reserved field.</span></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__row4485204316243"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2072__p42090474162413">is_public</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2072__p53885223162413">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2072__p11454306162413"><span id="evs_04_2072__text3111131184916">The reserved field.</span></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2072__li1957456185414"><a name="evs_04_2072__li1957456185414"></a><a name="li1957456185414"></a>Parameters in the <strong id="evs_04_2072__evs_04_2071_b89866567401">extra_specs</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2072__evs_04_2071_table1763545695210" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2072__evs_04_2071_row16361656165213"><th align="left" class="cellrowborder" valign="top" width="21.45%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_2072__evs_04_2071_p1763619566527">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.41%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_2072__evs_04_2071_p18636105619529">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_2072__evs_04_2071_p186361556155214">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2072__evs_04_2071_row56365565526"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2072__evs_04_2071_p063625610529">volume_backend_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2072__evs_04_2071_p3636165635219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2072__evs_04_2071_p17636185614527">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__evs_04_2071_row156362568523"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2072__evs_04_2071_p863675695214">availability-zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2072__evs_04_2071_p8636175665214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2072__evs_04_2071_p18636356185213">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__evs_04_2071_row17844276596"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2072__evs_04_2071_p178418274593">HW:availability_zone</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2072__evs_04_2071_p168416276599">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2072__evs_04_2071_p1540410211408">The reserved field.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__evs_04_2071_row3637135611527"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2072__evs_04_2071_p163710561529">RESKEY:availability_zones</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2072__evs_04_2071_p166374562525">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2072__evs_04_2071_p3637756205214">The AZs that support the current disk type.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2072__li0419202382514"><a name="evs_04_2072__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2072__evs_04_2013_b1288034833610">error</strong> field
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2072__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2072__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_2072__evs_04_2013_p19541716103019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_2072__evs_04_2013_p39375186103019">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_2072__evs_04_2013_p38578950103019">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="evs_04_2072__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2072__evs_04_2013_p46815658103019">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2072__evs_04_2013_p33971979103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2072__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="evs_04_2072__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2072__evs_04_2013_p59870541103019">code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2072__evs_04_2013_p17675690103019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2072__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
|
<p id="evs_04_2072__evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="evs_04_2072__li39567352">Example response<pre class="screen" id="evs_04_2072__screen19209987162328">{
|
|
"volume_type": {
|
|
"extra_specs": {
|
|
"volume_backend_name": "SAS",
|
|
"availability-zone": "az-dc-1"
|
|
},
|
|
"name": "SAS",
|
|
"qos_specs_id": null,
|
|
"is_public": true,
|
|
"id": "ea6e3c13-aac5-46e0-b280-745ed272e662",
|
|
"description": null
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2072__p51797270">or</p>
|
|
<pre class="screen" id="evs_04_2072__screen26431093145556">{
|
|
"error": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
<p id="evs_04_2072__p47489758202021">In the preceding example, <strong id="evs_04_2072__evs_04_2070_b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2072__evs_04_2070_b842352706144438">badrequest</strong> or <strong id="evs_04_2072__evs_04_2070_b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
|
<pre class="screen" id="evs_04_2072__screen5868199202121">{
|
|
"badrequest": {
|
|
"message": "XXXX",
|
|
"code": "XXX"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2072__section32217513"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2072__ul20852350"><li id="evs_04_2072__li53453427">Normal<p id="evs_04_2072__p11318800"><a name="evs_04_2072__li53453427"></a><a name="li53453427"></a>200</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="evs_04_2072__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2072__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2064.html">Disk Management</a></div>
|
|
</div>
|
|
</div>
|
|
|