vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2071.html
zhangyue ccbf63b495 EVS API DOC 
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>
2024-05-16 09:08:21 +00:00

243 lines
16 KiB
HTML
Raw Blame History

<a name="evs_04_2071"></a><a name="evs_04_2071"></a>
<h1 class="topictitle1">Querying EVS Disk Types</h1>
<div id="body20084682"><div class="section" id="evs_04_2071__section18389930"><h4 class="sectiontitle">Function</h4><p id="evs_04_2071__p16246551">This API is used to query EVS disk types and display the query results in a list.</p>
</div>
<div class="section" id="evs_04_2071__section31291646"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2071__ul40902273"><li id="evs_04_2071__li32576140">URI format<p id="evs_04_2071__p21421675"><a name="evs_04_2071__li32576140"></a><a name="li32576140"></a>GET /v2/{project_id}/types</p>
</li><li id="evs_04_2071__li58577354">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2071__table57434139" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2071__row461342"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2071__p37368736">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2071__p6968762">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2071__p27598869">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2071__row20915929"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2071__p16468652">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2071__p58892473">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2071__p5560998">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2071__section13189358"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2071__ul11152033120"><li id="evs_04_2071__li1815190173113">Example request<pre class="screen" id="evs_04_2071__screen1411685103115">GET https://{endpoint}/v2/{project_id}/types</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2071__section51595365"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2071__ul45596481"><li id="evs_04_2071__li671139114119">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2071__table157189144113" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2071__row37118915416"><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_2071__p671295419">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_2071__p47159114117">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_2071__p1671199174116">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2071__row177120964114"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2071__p14711298413">volume_types</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_2071__p971892416">list</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_2071__p157117910419">The list of queried disk types. For details, see <a href="#evs_04_2071__li61994451201537">Parameters in the volume_types field</a>.</p>
</td>
</tr>
<tr id="evs_04_2071__row971797416"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2071__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_2071__evs_04_2010_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_2071__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2071__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2071__li61994451201537"><a name="evs_04_2071__li61994451201537"></a><a name="li61994451201537"></a>Parameters in the <strong id="evs_04_2071__b146171129133">volume_types</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2071__table5015685217931" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2071__row3525603317931"><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_2071__p3716642517931">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_2071__p459600531514">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_2071__p4241583117931">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2071__row1313028517931"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2071__p5692013517931">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_2071__p317768361514">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_2071__p5928829717931">The disk type specifications. For details, see <a href="#evs_04_2071__li963595619529">Parameters in the extra_specs field</a>.</p>
</td>
</tr>
<tr id="evs_04_2071__row6655870217931"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2071__p2254579917931">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_2071__p378706671514">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_2071__p1505171317931">The disk type name.</p>
</td>
</tr>
<tr id="evs_04_2071__row124769217931"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2071__p3395425317931">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_2071__p476251801514">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_2071__p3954068517931">The disk type ID.</p>
</td>
</tr>
<tr id="evs_04_2071__row17240824161631"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2071__p54329535161631">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_2071__p38616177161631">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_2071__p24780220161631">The disk type description.</p>
</td>
</tr>
<tr id="evs_04_2071__row1027115162029"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2071__p16087523162029">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_2071__p28020971162029">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_2071__p34413580162029">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2071__row12948331162139"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2071__p42181927162139">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_2071__p61292894162139">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_2071__p26369379162139">The reserved field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2071__li963595619529"><a name="evs_04_2071__li963595619529"></a><a name="li963595619529"></a>Parameters in the <strong id="evs_04_2071__b89866567401">extra_specs</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2071__table1763545695210" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2071__p186361556155214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_2071__p17636185614527">The reserved field.</p>
</td>
</tr>
<tr id="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_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_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_2071__p18636356185213">The reserved field.</p>
</td>
</tr>
<tr id="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_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_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_2071__p1540410211408">The reserved field.</p>
</td>
</tr>
<tr id="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_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_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_2071__p3637756205214">The AZs that support the current disk type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2071__li0419202382514"><a name="evs_04_2071__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2071__b119167498481">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2071__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2071__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_2071__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_2071__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_2071__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2071__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_2071__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_2071__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_2071__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2071__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_2071__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_2071__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_2071__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2071__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_2071__li7715150">Example response<pre class="screen" id="evs_04_2071__screen15737158123212">{
"volume_types": [
{
"extra_specs": {
"volume_backend_name": "SAS",
"availability-zone": "az-dc-1"
},
"name": "SAS",
"qos_specs_id": null,
"id": "6c81c680-df58-4512-81e7-ecf66d160638",
"is_public": true,
"description": null
},
{
"extra_specs": {
"volume_backend_name": "SAS",
"availability-zone": "az-dc-1"
},
"name": "SAS",
"qos_specs_id": "585f29d6-7147-42e7-bfb8-ca214f640f6f",
"is_public": true,
"id": "ea6e3c13-aac5-46e0-b280-745ed272e662",
"description": null
},
{
"extra_specs": {
"volume_backend_name": "SSD",
"availability-zone": "az-dc-1"
},
"name": "SSD",
"qos_specs_id": "39b0c29a-308b-4f86-b478-5d3d02a43837",
"is_public": true,
"id": "6f2dee9e-82f0-4be3-ad89-bae605a3d24f",
"description": null
}
]
}</pre>
<p id="evs_04_2071__p14737145863211">or</p>
<pre class="screen" id="evs_04_2071__screen2737175823217">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2071__p1573765823218">In the preceding example, <strong id="evs_04_2071__b5209141520494">error</strong> indicates a general error, for example, <strong id="evs_04_2071__b172101315154910">badrequest</strong> or <strong id="evs_04_2071__b1211161564912">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2071__screen473775853215">{
"badrequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2071__section61705107"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2071__ul35416756"><li id="evs_04_2071__li50315352">Normal<p id="evs_04_2071__p50184984"><a name="evs_04_2071__li50315352"></a><a name="li50315352"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2071__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2071__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>
View Git Blame Copy Permalink