doc-exports/docs/evs/api-ref/evs_04_2040.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

157 lines
12 KiB
HTML

<a name="evs_04_2040"></a><a name="evs_04_2040"></a>
<h1 class="topictitle1">Resetting Tags of an EVS Resource (Deprecated)</h1>
<div id="body1501053401642"><div class="section" id="evs_04_2040__section5299350116935"><h4 class="sectiontitle">Function</h4><p id="evs_04_2040__p6461522216935">This API is used to reset the tags of an EVS resource, and the existing tags will be deleted.</p>
<div class="notice" id="evs_04_2040__note6325143016124"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="evs_04_2040__p3239196016124">This API call exists for compatibility reasons only and is not meant to be used.</p>
</div></div>
</div>
<div class="section" id="evs_04_2040__section4466609116935"><h4 class="sectiontitle">Constraints</h4><ul id="evs_04_2040__evs_04_2036_ul532574125517"><li id="evs_04_2040__evs_04_2036_li17231162092">A tag is composed of a key-value pair.<ul id="evs_04_2040__evs_04_2036_ul122415167919"><li id="evs_04_2040__evs_04_2036_li812515558919">Key:<ul id="evs_04_2040__evs_04_2036_ul10797172141011"><li id="evs_04_2040__evs_04_2036_li5265857497">Must be unique for each resource.</li><li id="evs_04_2040__evs_04_2036_li101753591999">Can contain a maximum of 36 characters.</li><li id="evs_04_2040__evs_04_2036_li62561612913">Can contain only digits, letters, hyphens (-), and underscores (_).</li></ul>
</li><li id="evs_04_2040__evs_04_2036_li1465414388108">Value:<ul id="evs_04_2040__evs_04_2036_ul16158406109"><li id="evs_04_2040__evs_04_2036_li7306115011101">Can contain a maximum of 43 characters.</li><li id="evs_04_2040__evs_04_2036_li826416293">Can contain only digits, letters, hyphens (-), and underscores (_).</li></ul>
</li></ul>
</li></ul>
<ul id="evs_04_2040__evs_04_2036_ul39193963153533"><li id="evs_04_2040__evs_04_2036_li67093010153619">A maximum of 10 tags can be created for an EVS resource.</li></ul>
</div>
<div class="section" id="evs_04_2040__section1378135716935"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2040__ul4254812316935"><li id="evs_04_2040__li4738879116935">URI format<p id="evs_04_2040__p65672080161524"><a name="evs_04_2040__li4738879116935"></a><a name="li4738879116935"></a>PUT /v2/{project_id}/os-vendor-tags/{resource_type}/{resource_id}</p>
</li><li id="evs_04_2040__li1328688716935">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2040__table28484833104128" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2040__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_2040__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_2040__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_2040__p29622926104128">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2040__row50646790104128"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2040__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_2040__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_2040__p26095712104128">Specifies the project ID.</p>
</td>
</tr>
<tr id="evs_04_2040__row40869685152038"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2040__p33171521152058">resource_type</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_2040__p2538652152058">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_2040__p42707547152038">Specifies the resource type. The value can be <strong id="evs_04_2040__b842352706193556">volumes</strong>, <strong id="evs_04_2040__b84235270619367">snapshots</strong>, or <strong id="evs_04_2040__b842352706193615">backups</strong>.</p>
</td>
</tr>
<tr id="evs_04_2040__row255647152042"><td class="cellrowborder" valign="top" width="28.57%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2040__p38738380152058">resource_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_2040__p50801043152058">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_2040__p33198438152042">Specifies the resource ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2040__section33444519162337"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2040__ul24651555162337"><li id="evs_04_2040__li20537403162337">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2040__table50618906162337" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2040__row13155682162337"><th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="evs_04_2040__p58977321162337">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.15%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="evs_04_2040__p12433688162337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.72%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="evs_04_2040__p495832162337">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46.96%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="evs_04_2040__p40162449162337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2040__row31932906162337"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="evs_04_2040__p36428555162337">tags</p>
</td>
<td class="cellrowborder" valign="top" width="15.15%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="evs_04_2040__p65031837162337">Object</p>
</td>
<td class="cellrowborder" valign="top" width="20.72%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="evs_04_2040__p33087431162337">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="46.96%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="evs_04_2040__p62836274162337">Specifies the key-value pair of the tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2040__li28655559162337">Description of the request header parameter
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2040__evs_04_2036_table2028154215261" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2040__evs_04_2036_row5873922415261"><th align="left" class="cellrowborder" valign="top" width="17.23%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="evs_04_2040__evs_04_2036_p1076316158116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.49%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="evs_04_2040__evs_04_2036_p1398844406">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.240000000000002%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="evs_04_2040__evs_04_2036_p69908410015">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.04%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="evs_04_2040__evs_04_2036_p1727312315261">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2040__evs_04_2036_row5694570715261"><td class="cellrowborder" valign="top" width="17.23%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="evs_04_2040__evs_04_2036_p4919953115261">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="17.49%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="evs_04_2040__evs_04_2036_p209931941909">Object</p>
</td>
<td class="cellrowborder" valign="top" width="18.240000000000002%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="evs_04_2040__evs_04_2036_p399418412010">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="47.04%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="evs_04_2040__evs_04_2036_p2823169515261">Specifies the type. The value can be <strong id="evs_04_2040__evs_04_2036_b842352706194129">application/json</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2040__ul38440191162337"><li id="evs_04_2040__li10417406162337">Example request<pre class="screen" id="evs_04_2040__screen46518247165050">{
"tags": {
"key_new": "value_new"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2040__section31780302162337"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2040__ul24067652162337"><li id="evs_04_2040__li15282284162337">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2040__table3322832162337" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2040__row13298017162337"><th align="left" class="cellrowborder" valign="top" width="21.66%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2040__p3397559162337">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.11%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2040__p6766862162337">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.230000000000004%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2040__p38425053162337">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2040__row25421606162337"><td class="cellrowborder" valign="top" width="21.66%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2040__p45884175162337">tags</p>
</td>
<td class="cellrowborder" valign="top" width="19.11%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2040__p25630656162337">Object</p>
</td>
<td class="cellrowborder" valign="top" width="59.230000000000004%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2040__p55032476162337">Specifies the key-value pair of the tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2040__ul25530242162337"><li id="evs_04_2040__li28445591162337">Example response<pre class="screen" id="evs_04_2040__screen15704805154650">{
"tags": {
"key_new": "value_new"
}
}</pre>
<p id="evs_04_2040__p22391547162337">or</p>
<pre class="screen" id="evs_04_2040__screen5932723415475">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2040__p1775982162337">In the preceding example, <strong id="evs_04_2040__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2040__b842352706144438">badRequest</strong> or <strong id="evs_04_2040__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2040__screen12416580154722">{
"badRequest": {
"message": "Invalid tags: Tags property key contains invalid characters.",
"code": 400
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2040__section9636891162337"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2040__ul42390696162337"><li id="evs_04_2040__li45971946162337">Normal<p id="evs_04_2040__p11094333162337"><a name="evs_04_2040__li45971946162337"></a><a name="li45971946162337"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2040__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2040__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>