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
Zaoxu, Li 305c41bb57 EVS 2.0.38 SP1 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2022-10-19 22:27:18 +00:00

436 lines
28 KiB
HTML
Raw Permalink 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"><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.3.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.3.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.3.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.3.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.3.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.3.2.2.1.1.4.1.3 "><p id="evs_04_2034__p26095712104128">Specifies 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">Parameter description
<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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.2.1.1.1.5.1.4 "><p id="evs_04_2034__p62836274162337">Specifies the key-value pairs of the tag. 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.4.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.4.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.4.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.4.2.1.1.1.5.1.4 "><p id="evs_04_2034__p987115282319">Specifies the number of query records.</p>
<p id="evs_04_2034__p118795218237"><span id="evs_04_2034__text138349551887">The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.</span></p>
</td>
</tr>
<tr id="evs_04_2034__row94258428238"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.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.4.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.4.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.4.2.1.1.1.5.1.4 "><p id="evs_04_2034__p68718528233">Specifies 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.4.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.4.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.4.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.4.2.1.1.1.5.1.4 "><p id="evs_04_2034__p987652192316">Specifies 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.4.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.4.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.4.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.4.2.1.1.1.5.1.4 "><p id="evs_04_2034__p129139109019">Specifies 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 the 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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.2.2.2.1.5.1.4 "><p id="evs_04_2034__p1520310020114">Specifies the tag key.</p>
</td>
</tr>
<tr id="evs_04_2034__row853810204325"><td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.4.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.4.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.4.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.4.2.2.2.1.5.1.4 "><p id="evs_04_2034__p945418465250">Specifies 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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.2.3.2.1.5.1.4 "><p id="evs_04_2034__p12710163971119">Specifies the tag key. The value is of the enumerated type.</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>: disk name.</li><li id="evs_04_2034__li46830510115"><strong id="evs_04_2034__b842352706183338">service_type</strong>: service type.</li></ul>
</td>
</tr>
<tr id="evs_04_2034__row81181246181"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.4.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.4.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.4.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.4.2.3.2.1.5.1.4 "><p id="evs_04_2034__p91249461180">Specifies 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">Parameter description
<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.5.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.5.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.5.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.5.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.5.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.5.2.1.1.1.4.1.3 "><p id="evs_04_2034__p52593571172633">Specifies 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.5.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.5.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.5.2.1.1.1.4.1.3 "><p id="evs_04_2034__p06172508319">Specifies the resources 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.5.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.5.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.5.2.1.1.1.4.1.3 "><p id="evs_04_2034__p109527215417">Specifies the error message returned when 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__b1470279498">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.5.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.5.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.5.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.5.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.5.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.5.2.2.2.1.4.1.3 "><p id="evs_04_2034__p17640112015324">Specifies the disk ID.</p>
</td>
</tr>
<tr id="evs_04_2034__row964062083211"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.5.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.5.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.5.2.2.2.1.4.1.3 "><p id="evs_04_2034__p1964019207321">Specifies the disk name.</p>
</td>
</tr>
<tr id="evs_04_2034__row116403209327"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.5.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.5.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.5.2.2.2.1.4.1.3 "><p id="evs_04_2034__p1640520123214">Specifies the resource details.</p>
</td>
</tr>
<tr id="evs_04_2034__row56401020193215"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2034__p1964012013217">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.48%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2034__p19640142093213">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2034__p1640120143218">Specifies the tag list. For details, see <a href="#evs_04_2034__li3876131217349">Parameters in the tags field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2034__li3876131217349"><a name="evs_04_2034__li3876131217349"></a><a name="li3876131217349"></a>Parameters in the <strong id="evs_04_2034__b1597270326">tags</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2034__table198791012123412" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2034__row8889141218341"><th align="left" class="cellrowborder" valign="top" width="23.380000000000003%" id="mcps1.3.5.2.3.2.1.4.1.1"><p id="evs_04_2034__p68931812203414">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.78%" id="mcps1.3.5.2.3.2.1.4.1.2"><p id="evs_04_2034__p2089701233414">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.84%" id="mcps1.3.5.2.3.2.1.4.1.3"><p id="evs_04_2034__p390341263413">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2034__row14906111253419"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2034__p3909112163416">key</p>
</td>
<td class="cellrowborder" valign="top" width="20.78%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2034__p1912161283417">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.84%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2034__p2866151481">Specifies the tag key.</p>
</td>
</tr>
<tr id="evs_04_2034__row39391412103418"><td class="cellrowborder" valign="top" width="23.380000000000003%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2034__p179412125347">value</p>
</td>
<td class="cellrowborder" valign="top" width="20.78%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2034__p159431312163417">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.84%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2034__p92449569473">Specifies the tag value.</p>
</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__evs_04_2013_b1288034833610">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.5.2.4.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.5.2.4.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.5.2.4.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.5.2.4.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.5.2.4.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.5.2.4.2.1.4.1.3 "><p id="evs_04_2034__evs_04_2013_p21623243103019">Specifies the error message returned when 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.5.2.4.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.5.2.4.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.5.2.4.2.1.4.1.3 "><p id="evs_04_2034__evs_04_2013_p6087468103019">Specifies the error code returned when 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">EVS Tag</a></div>
</div>
</div>
View Git Blame Copy Permalink