vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2034.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

789 lines
55 KiB
HTML
Raw Blame History

<a name="evs_04_2034"></a><a name="evs_04_2034"></a>
<h1 class="topictitle1">Querying Details of EVS Disks by Tag</h1>
<div id="body1521598770071"><p id="evs_04_2034__p853351716020"></p>
<div class="section" id="evs_04_2034__section5299350116935"><h4 class="sectiontitle">Function</h4><p id="evs_04_2034__p6461522216935">This API is used to query the details of EVS disks by tag.</p>
</div>
<div class="section" id="evs_04_2034__section4466609116935"><h4 class="sectiontitle">Constraints</h4><p id="evs_04_2034__p6118358516935">None</p>
</div>
<div class="section" id="evs_04_2034__section1378135716935"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2034__ul4254812316935"><li id="evs_04_2034__li4738879116935">URI format<p id="evs_04_2034__p1078735017222"><a name="evs_04_2034__li4738879116935"></a><a name="li4738879116935"></a>POST /v2/{project_id}/os-vendor-volumes/resource_instances/action</p>
</li><li id="evs_04_2034__li1328688716935">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table28484833104128" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row60547305104128"><th align="left" class="cellrowborder" valign="top" width="28.57%" id="mcps1.3.4.2.2.1.1.4.1.1"><p id="evs_04_2034__p5384679104128">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.2.1.1.4.1.2"><p id="evs_04_2034__p33505894104128">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.9%" id="mcps1.3.4.2.2.1.1.4.1.3"><p id="evs_04_2034__p29622926104128">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row50646790104128"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.4.2.2.1.1.4.1.1 "><p id="evs_04_2034__p8749302104128">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.2.1.1.4.1.2 "><p id="evs_04_2034__p37604871104128">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44.9%" headers="mcps1.3.4.2.2.1.1.4.1.3 "><p id="evs_04_2034__p26095712104128">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2034__section33444519162337"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2034__ul24651555162337"><li id="evs_04_2034__li20537403162337">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table50618906162337" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row13155682162337"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.5.2.1.1.1.5.1.1"><p id="evs_04_2034__p58977321162337">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.5.2.1.1.1.5.1.2"><p id="evs_04_2034__p12433688162337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.11%" id="mcps1.3.5.2.1.1.1.5.1.3"><p id="evs_04_2034__p495832162337">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.89%" id="mcps1.3.5.2.1.1.1.5.1.4"><p id="evs_04_2034__p40162449162337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row31932906162337"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.1.1.5.1.1 "><p id="evs_04_2034__p36428555162337">tags</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.1.1.5.1.2 "><p id="evs_04_2034__p65031837162337">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="16.11%" headers="mcps1.3.5.2.1.1.1.5.1.3 "><p id="evs_04_2034__p33087431162337">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.3.5.2.1.1.1.5.1.4 "><p id="evs_04_2034__p62836274162337">The key-value pairs of tags. For details, see <a href="#evs_04_2034__li8528152083214">Parameters in the tags field</a>.</p>
<p id="evs_04_2034__p1858507716">One tag list can contain a maximum of 10 keys.</p>
<p id="evs_04_2034__p175842500716">Tag keys in a tag list must be unique.</p>
<p id="evs_04_2034__p14391151142511">When multiple keys are specified in a tag list, only the disks having all specified keys are queried.</p>
<div class="note" id="evs_04_2034__note1461127173813"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2034__evs_04_2032_p1970754173519">If multiple tag lists are specified in the request, only the disks that meet the requirements of the last tag list are queried.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2034__row862173882314"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.1.1.5.1.1 "><p id="evs_04_2034__p1487452192311">limit</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.1.1.5.1.2 "><p id="evs_04_2034__p08795219233">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.11%" headers="mcps1.3.5.2.1.1.1.5.1.3 "><p id="evs_04_2034__p47340819249">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.3.5.2.1.1.1.5.1.4 "><p id="evs_04_2034__p987115282319">The number of query records.</p>
<p id="evs_04_2034__p118795218237">The value ranges from <strong id="evs_04_2034__b12563958171410">1</strong> to <strong id="evs_04_2034__b20564115881414">1000</strong>, and the default value is <strong id="evs_04_2034__b35648589144">1000</strong>. The returned value cannot exceed this limit.</p>
</td>
</tr>
<tr id="evs_04_2034__row94258428238"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.1.1.5.1.1 "><p id="evs_04_2034__p3871352132317">offset</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.1.1.5.1.2 "><p id="evs_04_2034__p38720529235">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.11%" headers="mcps1.3.5.2.1.1.1.5.1.3 "><p id="evs_04_2034__p17737483247">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.3.5.2.1.1.1.5.1.4 "><p id="evs_04_2034__p68718528233">The index location.</p>
<p id="evs_04_2034__p787185218237">The minimum value is <strong id="evs_04_2034__b18744142621611">0</strong>, which is also the default value.</p>
<p id="evs_04_2034__p387145252319">The first record in the query result is the offset+1 record that meets the query criteria.</p>
</td>
</tr>
<tr id="evs_04_2034__row6793144415239"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.1.1.5.1.1 "><p id="evs_04_2034__p1687152172313">action</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.1.1.5.1.2 "><p id="evs_04_2034__p1187552192314">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.11%" headers="mcps1.3.5.2.1.1.1.5.1.3 "><p id="evs_04_2034__p97390817249">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.3.5.2.1.1.1.5.1.4 "><p id="evs_04_2034__p987652192316">The operation identifier.</p>
<p id="evs_04_2034__p118795202312">Specifying <strong id="evs_04_2034__b130008727820429">filter</strong> queries the details of disks by tag.</p>
</td>
</tr>
<tr id="evs_04_2034__row8888748016"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.5.2.1.1.1.5.1.1 "><p id="evs_04_2034__p159133101403">matches</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.5.2.1.1.1.5.1.2 "><p id="evs_04_2034__p1623519196018">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="16.11%" headers="mcps1.3.5.2.1.1.1.5.1.3 "><p id="evs_04_2034__p109131110706">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.3.5.2.1.1.1.5.1.4 "><p id="evs_04_2034__p129139109019">The query criteria that the resource supports. For details, see <a href="#evs_04_2034__li15751146383">Parameters in the matches field</a>.</p>
<p id="evs_04_2034__p1547919526720">Tag keys in a list must be unique.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li8528152083214"><a name="evs_04_2034__li8528152083214"></a><a name="li8528152083214"></a>Parameters in the <strong id="evs_04_2034__b226795913461">tags</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table205290203323" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row13530142033210"><th align="left" class="cellrowborder" valign="top" width="15.409999999999998%" id="mcps1.3.5.2.2.2.1.5.1.1"><p id="evs_04_2034__p19530182011329">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.040000000000001%" id="mcps1.3.5.2.2.2.1.5.1.2"><p id="evs_04_2034__p20530120163211">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.5.2.2.2.1.5.1.3"><p id="evs_04_2034__p8530122014321">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.629999999999995%" id="mcps1.3.5.2.2.2.1.5.1.4"><p id="evs_04_2034__p18533172017325">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row253510208321"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.5.2.2.2.1.5.1.1 "><p id="evs_04_2034__p17535320203220">key</p>
</td>
<td class="cellrowborder" valign="top" width="15.040000000000001%" headers="mcps1.3.5.2.2.2.1.5.1.2 "><p id="evs_04_2034__p175351020123212">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.5.2.2.2.1.5.1.3 "><p id="evs_04_2034__p953522010321">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.629999999999995%" headers="mcps1.3.5.2.2.2.1.5.1.4 "><p id="evs_04_2034__p1520310020114">The tag key.</p>
</td>
</tr>
<tr id="evs_04_2034__row853810204325"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.5.2.2.2.1.5.1.1 "><p id="evs_04_2034__p1053816201325">values</p>
</td>
<td class="cellrowborder" valign="top" width="15.040000000000001%" headers="mcps1.3.5.2.2.2.1.5.1.2 "><p id="evs_04_2034__p13538520153211">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.5.2.2.2.1.5.1.3 "><p id="evs_04_2034__p1538920193219">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="52.629999999999995%" headers="mcps1.3.5.2.2.2.1.5.1.4 "><p id="evs_04_2034__p945418465250">The tag value.</p>
<ul id="evs_04_2034__ul133722079613"><li id="evs_04_2034__li2372279616">One value list can contain a maximum of 10 values.</li><li id="evs_04_2034__li113721171964">Tag values in a value list must be unique.</li><li id="evs_04_2034__li83722071069">If the value list is left empty, any tag value can be matched. When multiple values are specified in a value list and the key requirements are met, disks that have any of the specified values are queried.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li15751146383"><a name="evs_04_2034__li15751146383"></a><a name="li15751146383"></a>Parameters in the <strong id="evs_04_2034__b842352706191916">matches</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table0778462086" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row38414461289"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.5.2.3.2.1.5.1.1"><p id="evs_04_2034__p1487946584">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.5.2.3.2.1.5.1.2"><p id="evs_04_2034__p119224615820">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22%" id="mcps1.3.5.2.3.2.1.5.1.3"><p id="evs_04_2034__p194174619818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41%" id="mcps1.3.5.2.3.2.1.5.1.4"><p id="evs_04_2034__p109604613817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row14989461387"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.2.3.2.1.5.1.1 "><p id="evs_04_2034__p810194617814">key</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.3.2.1.5.1.2 "><p id="evs_04_2034__p17102646681">String</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.5.2.3.2.1.5.1.3 "><p id="evs_04_2034__p131037466813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.5.2.3.2.1.5.1.4 "><p id="evs_04_2034__p12710163971119">The tag key.</p>
<p id="evs_04_2034__p1110654618817">The value can be as follows:</p>
<ul id="evs_04_2034__ul168395111111"><li id="evs_04_2034__li11683051151119"><strong id="evs_04_2034__b842352706202849">resource_name</strong>: the disk name</li><li id="evs_04_2034__li46830510115"><strong id="evs_04_2034__b842352706183338">service_type</strong>: the service type</li></ul>
</td>
</tr>
<tr id="evs_04_2034__row81181246181"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.5.2.3.2.1.5.1.1 "><p id="evs_04_2034__p111201646386">value</p>
</td>
<td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.5.2.3.2.1.5.1.2 "><p id="evs_04_2034__p7121346287">String</p>
</td>
<td class="cellrowborder" valign="top" width="22%" headers="mcps1.3.5.2.3.2.1.5.1.3 "><p id="evs_04_2034__p1122164618815">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="41%" headers="mcps1.3.5.2.3.2.1.5.1.4 "><p id="evs_04_2034__p91249461180">The tag value.</p>
<ul id="evs_04_2034__ul1956812345128"><li id="evs_04_2034__li135689349128">It can contain up to 255 characters.</li><li id="evs_04_2034__li1232812377129">If <strong id="evs_04_2034__b84235270621231">resource_name</strong> is specified for <strong id="evs_04_2034__b84235270621234">key</strong>, the tag value uses a fuzzy match.</li><li id="evs_04_2034__li68802052141910">If <strong id="evs_04_2034__b2868140172818">service_type</strong> is specified for <strong id="evs_04_2034__b148698409282">key</strong>, the value can be <strong id="evs_04_2034__b2870194092817">EVS</strong> and is case-insensitive.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2034__ul38440191162337"><li id="evs_04_2034__li10417406162337">Example request<pre class="screen" id="evs_04_2034__screen14894115119151">{
"offset": "100",
"limit": "100",
"action": "filter",
"tags": [
{
"key": "key1",
"values": [
"value1",
"value2"
]
}
],
"matches": [
{
"key": "resource_name",
"value": "resource1"
},
{
"key": "service_type",
"value": "EVS"
}
]
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2034__section3215934016935"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2034__ul5476973316935"><li id="evs_04_2034__li2316555316935">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table716338716935" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row2937460716935"><th align="left" class="cellrowborder" valign="top" width="22.37%" id="mcps1.3.6.2.1.1.1.4.1.1"><p id="evs_04_2034__p3053299616935">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.6.2.1.1.1.4.1.2"><p id="evs_04_2034__p5725363416935">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.89%" id="mcps1.3.6.2.1.1.1.4.1.3"><p id="evs_04_2034__p3278200616935">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row63271571172633"><td class="cellrowborder" valign="top" width="22.37%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="evs_04_2034__p24723652172633">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="evs_04_2034__p56458834172633">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.89%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="evs_04_2034__p52593571172633">The total number of disks that meet the query criteria.</p>
</td>
</tr>
<tr id="evs_04_2034__row96879441311"><td class="cellrowborder" valign="top" width="22.37%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="evs_04_2034__p261775003110">resources</p>
</td>
<td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="evs_04_2034__p1361765083118">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="57.89%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="evs_04_2034__p06172508319">The list of disks that meet the query criteria. For details, see <a href="#evs_04_2034__li95931326163214">Parameters in the resources field</a>.</p>
</td>
</tr>
<tr id="evs_04_2034__row961262962717"><td class="cellrowborder" valign="top" width="22.37%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="evs_04_2034__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="evs_04_2034__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.89%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="evs_04_2034__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2034__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li95931326163214"><a name="evs_04_2034__li95931326163214"></a><a name="li95931326163214"></a>Parameters in the <strong id="evs_04_2034__b147647740">resources</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table8575132033210" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row156391220173215"><th align="left" class="cellrowborder" valign="top" width="23.380000000000003%" id="mcps1.3.6.2.2.2.1.4.1.1"><p id="evs_04_2034__p1963910206321">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.48%" id="mcps1.3.6.2.2.2.1.4.1.2"><p id="evs_04_2034__p18639920103214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.6.2.2.2.1.4.1.3"><p id="evs_04_2034__p176391320153219">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row106392209321"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.6.2.2.2.1.4.1.1 "><p id="evs_04_2034__p6639920143219">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.6.2.2.2.1.4.1.2 "><p id="evs_04_2034__p1864042093215">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.6.2.2.2.1.4.1.3 "><p id="evs_04_2034__p17640112015324">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2034__row964062083211"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.6.2.2.2.1.4.1.1 "><p id="evs_04_2034__p2640152023219">resource_name</p>
</td>
<td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.6.2.2.2.1.4.1.2 "><p id="evs_04_2034__p3640720123212">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.6.2.2.2.1.4.1.3 "><p id="evs_04_2034__p1964019207321">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2034__row116403209327"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.6.2.2.2.1.4.1.1 "><p id="evs_04_2034__p1664015207321">resource_detail</p>
</td>
<td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.6.2.2.2.1.4.1.2 "><p id="evs_04_2034__p11640192033218">object</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.6.2.2.2.1.4.1.3 "><p id="evs_04_2034__p1640520123214">The disk details.</p>
</td>
</tr>
<tr id="evs_04_2034__row56401020193215"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.6.2.2.2.1.4.1.1 "><p id="evs_04_2034__p67147811575">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.6.2.2.2.1.4.1.2 "><p id="evs_04_2034__p1471498145720">Array of Map&lt;String,String&gt; objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.6.2.2.2.1.4.1.3 "><p id="evs_04_2034__p57141487576">The tag list.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li13511133812426">Parameters in the <strong id="evs_04_2034__b220164211228">VolumeDetailForTag</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__response_VolumeDetailForTag" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row12605142742318"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.3.2.1.4.1.1"><p id="evs_04_2034__p13607127102310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.3.2.1.4.1.2"><p id="evs_04_2034__p7607192710230">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.3.2.1.4.1.3"><p id="evs_04_2034__p12607627102310">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row15605627102315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p186071127152320">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p66071827182318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p7607127112318">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2034__row360542752312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p3608827102311">links</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p14608202720239">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p19608427202311">The disk URI. For details, see <a href="#evs_04_2034__li16431748455">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2034__row4605172772315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p660852715239">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p10608927162318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p360811278230">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2034__row1960552782313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p460972714236">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p260962717236">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p1360942742316">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2034__row260562742318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p166091727142313">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p26091427172314">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p1360902716235">The disk URI. For details, see <a href="#evs_04_2034__li1300192465115">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2034__row16605727162310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p126101327152318">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p261032712315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p13610112711234">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2034__row0605112702310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p761017274231">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p76101627152317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p861042752320">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row116051827162319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p1961142752311">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p3611027142314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p16611162712310">The source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_2034__p361102714232">This field is currently not supported.</p>
</td>
</tr>
<tr id="evs_04_2034__row18605162715237"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p206111127132317">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1611162752315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p206112027182312">The snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_2034__row660532715237"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p56126278232">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p36127276230">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p16612162716239">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2034__row186051327112320"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p8612927192317">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p46121627182311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p18612227132318">The time when the disk was created. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2034__row196057278233"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p1361317275230">os-vol-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p9613142792317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p1561317273231">The ID of the tenant to which the disk belongs. The tenant ID is the same as the project ID.</p>
</td>
</tr>
<tr id="evs_04_2034__row860582762318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p16131527172316">volume_image_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p6613227112319">Map&lt;String,Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p9613627122319">The metadata of the disk image.</p>
<div class="note" id="evs_04_2034__note4614142720235"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2034__p761422772315">Note:</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2034__row17605927172312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p126148276232">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p16141827152319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p156158276233">The disk type.</p>
</td>
</tr>
<tr id="evs_04_2034__row1960582718234"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p1161502792316">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1661510272235">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p13615527162311">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2034__row1660502702314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p161513271239">consistencygroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p16615102732318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p106152276235">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row12605127182317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p6616132711237">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p16616172752312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p861682722313">Whether the disk is bootable. The value can be <strong id="evs_04_2034__b13984324173219">true</strong> (a bootable disk) or <strong id="evs_04_2034__b159851724183218">false</strong> (a non-bootable disk).</p>
</td>
</tr>
<tr id="evs_04_2034__row1860513279238"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p261642718233">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1161616279233">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p10617102792313">The disk metadata. For details, see <a href="#evs_04_2034__li267602085611">Parameters in the VolumeMetadata field</a>.</p>
</td>
</tr>
<tr id="evs_04_2034__row10605172722316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p0617162732319">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1461772716236">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p26179277235">The time when the disk was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2034__row9606122782312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p1261715279232">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p96171827182310">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p661810274238">This field is currently not supported.</p>
</td>
</tr>
<tr id="evs_04_2034__row1606927152317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p5618127102315">replication_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1361882720236">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p16618192752318">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row1560612712231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p9618102732311">os-volume-replication:extended_status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p126187277235">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p16618182711239">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row17606162710233"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p18619827142315">os-vol-mig-status-attr:migstat</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p7825192713237">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p12825427112312">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row76060279231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p48256278236">os-vol-mig-status-attr:name_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p68251127192314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p48251272233">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row1760672714234"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p5825112712238">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1382582714234">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p1825132711230">Whether the disk is shareable. The value can be <strong id="evs_04_2034__b10137105813315">true</strong> (shared disk) or <strong id="evs_04_2034__b713816584313">false</strong> (common disk). This field is no longer used. Use <strong id="evs_04_2034__b194611180320">multiattach</strong>.</p>
</td>
</tr>
<tr id="evs_04_2034__row1660692702315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p178251227112314">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p08250273238">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p12825122722315">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2034__row56061027152319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p2082516273231">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1825172712230">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p11826227142319">The service type. The value can be <strong id="evs_04_2034__b15304182763312">EVS</strong>, <strong id="evs_04_2034__b1630419275339">DSS</strong>, or <strong id="evs_04_2034__b1230572711337">DESS</strong>.</p>
</td>
</tr>
<tr id="evs_04_2034__row16061327172313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p1826227142313">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p128261127142319">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p10826927182315">Whether the disk is shareable.</p>
</td>
</tr>
<tr id="evs_04_2034__row16061727152317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p19826727142314">dedicated_storage_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1826162716239">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p08261627172319">The ID of the DSS storage pool accommodating the disk.</p>
</td>
</tr>
<tr id="evs_04_2034__row46067275233"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p682619270235">dedicated_storage_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p882662712318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p118261827182311">The name of the DSS storage pool accommodating the disk.</p>
</td>
</tr>
<tr id="evs_04_2034__row1160652720232"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p68261227142314">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p182618275235">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p1982612792314">The disk tags. This field has values if the disk has tags. Or, it is left empty.</p>
</td>
</tr>
<tr id="evs_04_2034__row13606112782315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p382692722316">wwn</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p182602717239">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p882622710238">The unique identifier used when attaching the disk.</p>
</td>
</tr>
<tr id="evs_04_2034__row4606122732317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.1 "><p id="evs_04_2034__p282692717231">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.3.2.1.4.1.2 "><p id="evs_04_2034__p682612717234">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.3.2.1.4.1.3 "><p id="evs_04_2034__p14826627182314">The ID of the enterprise project that the disk has been added to.</p>
<div class="note" id="evs_04_2034__note482652762319"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2034__p128267278231">Note:</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li16431748455"><a name="evs_04_2034__li16431748455"></a><a name="li16431748455"></a>Parameters in the <strong id="evs_04_2034__b8422162518246">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table108511514510" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row110410515455"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.6.2.4.2.1.4.1.1"><p id="evs_04_2034__p5104452450">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.6.2.4.2.1.4.1.2"><p id="evs_04_2034__p51042515459">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.59595959595959%" id="mcps1.3.6.2.4.2.1.4.1.3"><p id="evs_04_2034__p151041659453">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row151049524514"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.6.2.4.2.1.4.1.1 "><p id="evs_04_2034__p10104105104512">href</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.6.2.4.2.1.4.1.2 "><p id="evs_04_2034__p4104195144510">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.6.2.4.2.1.4.1.3 "><p id="evs_04_2034__p1110418510459">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2034__row171041759454"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.6.2.4.2.1.4.1.1 "><p id="evs_04_2034__p410411574520">rel</p>
</td>
<td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.6.2.4.2.1.4.1.2 "><p id="evs_04_2034__p31041594516">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.59595959595959%" headers="mcps1.3.6.2.4.2.1.4.1.3 "><p id="evs_04_2034__p310411517454">The shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li1300192465115"><a name="evs_04_2034__li1300192465115"></a><a name="li1300192465115"></a>Parameters in the <strong id="evs_04_2034__b134281306358">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__response_Attachment" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row6625192752312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.5.2.1.4.1.1"><p id="evs_04_2034__p5827102782311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.5.2.1.4.1.2"><p id="evs_04_2034__p12827727192315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.5.2.1.4.1.3"><p id="evs_04_2034__p18271927172313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row1462532792313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p0827122711234">attached_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p4827112772315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p88278279232">The time when the disk was attached.</p>
<p id="evs_04_2034__p1082842717235">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2034__row16625112752316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p1882812722315">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p88281272232">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p158281127102318">The ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_2034__row1362592702316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p11828192719236">device</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p3828727202314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p782862722319">The device name.</p>
</td>
</tr>
<tr id="evs_04_2034__row14625827142315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p482810273239">host_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p118281927142314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p8828142732313">The name of the physical host housing the cloud server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2034__row2062582792318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p182862722311">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p14828627102319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p128281277236">The ID of the attached disk.</p>
</td>
</tr>
<tr id="evs_04_2034__row1162532719234"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p78281027182310">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p198281927142312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p128281127132311">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2034__row16625327182316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.1 "><p id="evs_04_2034__p12828152742317">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.5.2.1.4.1.2 "><p id="evs_04_2034__p082812279234">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.5.2.1.4.1.3 "><p id="evs_04_2034__p1582811279230">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li267602085611"><a name="evs_04_2034__li267602085611"></a><a name="li267602085611"></a>Parameters in the <strong id="evs_04_2034__b19297181618360">VolumeMetadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__response_VolumeMetadata" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row06281427192310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.6.2.1.4.1.1"><p id="evs_04_2034__p1082842762311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.6.2.6.2.1.4.1.2"><p id="evs_04_2034__p6828112717237">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.6.2.6.2.1.4.1.3"><p id="evs_04_2034__p382882752313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row1362862712314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.1 "><p id="evs_04_2034__p178299272236">__system__cmkid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.2 "><p id="evs_04_2034__p1282912712230">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.6.2.1.4.1.3 "><p id="evs_04_2034__p1682902715235">The encryption CMK ID in <strong id="evs_04_2034__b10337132833617">metadata</strong>. This parameter is used together with <strong id="evs_04_2034__b11337182833620">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2034__b1533819289366">cmkid</strong> is fixed at 36 bytes.</p>
<div class="note" id="evs_04_2034__note20829172719238"><span class="notetitle"> NOTE: </span><div class="notebody"></div></div>
</td>
</tr>
<tr id="evs_04_2034__row15628172712235"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.1 "><p id="evs_04_2034__p4829152710233">__system__encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.2 "><p id="evs_04_2034__p168291277234">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.6.2.1.4.1.3 "><p id="evs_04_2034__p482911276236">The encryption field in <strong id="evs_04_2034__b4940101018373">metadata</strong>. The value can be <strong id="evs_04_2034__b4940010133714">0</strong> (not encrypted) or <strong id="evs_04_2034__b1694111083710">1</strong> (encrypted). If this parameter does not appear, the encryption attribute of the disk is the same as that of the data source. If the disk is not created from a data source, the disk is not encrypted by default.</p>
</td>
</tr>
<tr id="evs_04_2034__row8628112716231"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.1 "><p id="evs_04_2034__p082932715239">full_clone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.2 "><p id="evs_04_2034__p18298276231">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.6.2.1.4.1.3 "><p id="evs_04_2034__p982982752310">The method of creation when the disk is created from a snapshot.</p>
<ul id="evs_04_2034__ul19829172714234"><li id="evs_04_2034__li58295274231"><strong id="evs_04_2034__b140864283813">0</strong>: linked clone</li><li id="evs_04_2034__li118291276233"><strong id="evs_04_2034__b889674733814">1</strong>: full clone</li></ul>
</td>
</tr>
<tr id="evs_04_2034__row18629102717238"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.1 "><p id="evs_04_2034__p582911271239">hw:passthrough</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.6.2.6.2.1.4.1.2 "><p id="evs_04_2034__p1829182711231">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.6.2.6.2.1.4.1.3 "><ul id="evs_04_2034__ul7829152722318"><li id="evs_04_2034__li20829182792312">Value <strong id="evs_04_2034__b79113559386">true</strong> indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported.</li><li id="evs_04_2034__li38291327112319">Value <strong id="evs_04_2034__b20454175183919">false</strong> indicates the VBD device type, which supports only simple SCSI read/write commands.</li><li id="evs_04_2034__li6829627102319">If this parameter does not appear, the disk device type is VBD.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li0419202382514"><a name="evs_04_2034__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2034__b161287572395">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.6.2.7.2.1.4.1.1"><p id="evs_04_2034__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.6.2.7.2.1.4.1.2"><p id="evs_04_2034__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.6.2.7.2.1.4.1.3"><p id="evs_04_2034__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.6.2.7.2.1.4.1.1 "><p id="evs_04_2034__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.6.2.7.2.1.4.1.2 "><p id="evs_04_2034__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.6.2.7.2.1.4.1.3 "><p id="evs_04_2034__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2034__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.6.2.7.2.1.4.1.1 "><p id="evs_04_2034__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.6.2.7.2.1.4.1.2 "><p id="evs_04_2034__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.6.2.7.2.1.4.1.3 "><p id="evs_04_2034__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2034__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></ul>
<ul id="evs_04_2034__ul3313111816935"><li id="evs_04_2034__li2974460716935">Example response<pre class="screen" id="evs_04_2034__screen2563155212168">{
"total_count": 1,
"resources": [{
"resource_name": "resource1",
"resource_detail": {
"attachments": [{
"server_id": "2080869e-ba46-4ea5-b45e-3191ac0f1d54",
"attachment_id": "1335f039-7a42-4d1e-be49-ac584db0ba0b",
"attached_at": "2019-08-06T07:00:21.842812",
"host_name": null,
"volume_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"device": "/dev/vda",
"id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
}],
"links": [{
"href": "https://volume.Region.dc1.domainname.com/v2/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"rel": "self"
},
{
"href": "https://volume.Region.dc1.domainname.com/051375756c80d5eb2ff0c014498645fb/volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"rel": "bookmark"
}],
"availability_zone": "kvmxen.dc1",
"os-vol-host-attr:host": "az21.dc1#2",
"encrypted": false,
"updated_at": "2019-08-09T06:19:35.874737",
"os-volume-replication:extended_status": null,
"replication_status": "disabled",
"snapshot_id": null,
"id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2",
"size": 40,
"user_id": "75f26e17348643bfb7718578b04635c2",
"os-vol-tenant-attr:tenant_id": "051375756c80d5eb2ff0c014498645fb",
"service_type": "EVS",
"os-vol-mig-status-attr:migstat": null,
"metadata": {
},
"status": "in-use",
"volume_image_metadata": {
"size": "0",
"__quick_start": "False",
"container_format": "bare",
"min_ram": "0",
"image_name": "test-hua-centos7.3-0725",
"image_id": "c6c153a6-dde8-4bac-8e40-3d7619436934",
"__os_type": "Linux",
"min_disk": "20",
"__support_kvm": "true",
"virtual_env_type": "FusionCompute",
"__description": "",
"__os_version": "CentOS 7.3 64bit",
"__os_bit": "64",
"__image_source_type": "uds",
"__support_xen": "true",
"file_format": "zvhd2",
"checksum": "d41d8cd98f00b204e9800998ecf8427e",
"__imagetype": "gold",
"disk_format": "zvhd2",
"__image_cache_type": "Not_Cache",
"__isregistered": "true",
"__image_location": "192.168.46.200:5443:pcsimsregion:c6c153a6-dde8-4bac-8e40-3d7619436934",
"__image_size": "911269888",
"__platform": "CentOS"
},
"description": "",
"multiattach": false,
"source_volid": null,
"consistencygroup_id": null,
"os-vol-mig-status-attr:name_id": null,
"name": "resource1",
"bootable": "true",
"created_at": "2019-08-06T06:59:03.056682",
"volume_type": "SAS",
"shareable": false,
},
"tags": [{
"key": "key1",
"value": "value1"
},
{
"key": "key1",
"value": "value2"
}],
"resource_id": "7fa6b592-ac75-460d-a28a-bb17429d1eb2"
}]
}</pre>
<p id="evs_04_2034__p52821068113531">or</p>
<pre class="screen" id="evs_04_2034__screen41555256154916">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2034__p5655715720175">In the preceding example, <strong id="evs_04_2034__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2034__b842352706144438">badRequest</strong> or <strong id="evs_04_2034__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2034__screen27858742154933">{
"computeFault": {
"message": "The server has either erred or is incapable of performing the requested operation.",
"code": 500
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2034__section6050296116935"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2034__ul179279516935"><li id="evs_04_2034__li1613516116935">Normal<p id="evs_04_2034__p1099872616935"><a name="evs_04_2034__li1613516116935"></a><a name="li1613516116935"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2034__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2034__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_2024.html">Tag Management</a></div>
</div>
</div>
View Git Blame Copy Permalink