doc-exports/docs/csbs/api-ref/en-us_topic_0098635095.html
Wei, Hongmin 8ce662c4dc CSBS API initial version
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-24 21:06:50 +00:00

154 lines
12 KiB
HTML

<a name="EN-US_TOPIC_0098635095"></a><a name="EN-US_TOPIC_0098635095"></a>
<h1 class="topictitle1">Removing a Tag from a Backup Policy</h1>
<div id="body1519724141410"><div class="section" id="EN-US_TOPIC_0098635095__section48650648"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0098635095__p56326682">The API is idempotent.</p>
<p class="msonormal" id="EN-US_TOPIC_0098635095__p37178096">When you delete a nonexistent tag, error code <strong id="EN-US_TOPIC_0098635095__b842352706104215">404</strong> will be returned. Tag keys cannot be empty or be empty character strings.</p>
</div>
<div class="section" id="EN-US_TOPIC_0098635095__section35202648"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0098635095__ul58635765"><li id="EN-US_TOPIC_0098635095__li57959838">URI format<p id="EN-US_TOPIC_0098635095__p51876502"><a name="EN-US_TOPIC_0098635095__li57959838"></a><a name="li57959838"></a>DELETE https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags/{key}</p>
<p id="EN-US_TOPIC_0098635095__p64235341"></p>
</li><li id="EN-US_TOPIC_0098635095__li41247165">Request header
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635095__table35680165" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header</caption><thead align="left"><tr id="EN-US_TOPIC_0098635095__row21584674"><th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0098635095__p209623317216">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.77%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0098635095__p15962193221">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0098635095__p99783315213">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0098635095__p6978835213">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635095__row35410022"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635095__p49639570">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635095__p144771859261">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635095__p61382201">MIME type of the body in the request</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635095__p8332830">application/json</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row7886611"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635095__p34835721">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635095__p647610591369">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635095__p3121152">User token</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635095__p9677327">-</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0098635095__ul45666040"><li id="EN-US_TOPIC_0098635095__li8341177">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635095__table7961729" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0098635095__row46636132"><th align="left" class="cellrowborder" valign="top" width="20.792079207920793%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="EN-US_TOPIC_0098635095__p0674144172518">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="EN-US_TOPIC_0098635095__p1367454172514">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.801980198019802%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="EN-US_TOPIC_0098635095__p3674341142516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.663366336633665%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="EN-US_TOPIC_0098635095__p13674104114257">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635095__row60309786"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635095__p53254482">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635095__p18645762">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635095__p33911763">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635095__p65779720">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row1462819"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635095__p51379511">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635095__p990892">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635095__p13153450">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635095__p58796504">Resource ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row59406488"><td class="cellrowborder" valign="top" width="20.792079207920793%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0098635095__p47196242">key</p>
</td>
<td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0098635095__p64799248">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="19.801980198019802%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0098635095__p14247739">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.663366336633665%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0098635095__p13216186">Tag key</p>
<p id="EN-US_TOPIC_0098635095__p482715431313">A tag key consists of up to 127 characters.</p>
<p id="EN-US_TOPIC_0098635095__p182716437311">A tag key cannot be an empty string.</p>
<p id="EN-US_TOPIC_0098635095__p7988143725117">Spaces before and after a key will be deprecated.</p>
<p id="EN-US_TOPIC_0098635095__p98272043731">It cannot contain the following characters: ASCII (0-31), asterisks (*), less-than signs (&lt;), greater-than signs (&gt;), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/). </p>
<p id="EN-US_TOPIC_0098635095__p182644299542">(The code only verifies whether the key is an empty character string, instead of the length and character set. Keys are checked and used after deleting the spaces before and after them. Even invalid tags existing at the bottom layer can be deleted.)</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635095__section48388379"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0098635095__ul63878134"><li id="EN-US_TOPIC_0098635095__li38032294">Example request<pre class="screen" id="EN-US_TOPIC_0098635095__screen1560815753311">DELETE https://{endpoint}/v1/{project_id}/csbs_backup_policy/{resource_id}/tags/{key}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635095__section32842235"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0098635095__ul19124697"><li id="EN-US_TOPIC_0098635095__li37904547">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635095__table5596611" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635095__row30280082"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.4.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0098635095__p36767573">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.4.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0098635095__p25383445">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635095__row42793145"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.4.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635095__p43692714">204</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635095__p49448911">No Content</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0098635095__li42387016">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0098635095__table45938832" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0098635095__row34750807"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.4.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0098635095__p63351959">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.4.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0098635095__p31235064">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0098635095__row47012257"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.4.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635095__p49896507">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635095__p15085294">Invalid parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row1549920"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.4.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635095__p58434666">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635095__p35587488">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row51851944"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.4.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635095__p39257932">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635095__p25775953">You do not have permission to perform this operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row30656991"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.4.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635095__p188376">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635095__p15258501">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0098635095__row3108787"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.4.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0098635095__p50485194">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.4.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0098635095__p62768905">A system exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0098635095__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0098635095__p999593594811">For details, see <a href="en-us_topic_0071888297.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0098466174.html">Tag Management</a></div>
</div>
</div>