forked from docs/doc-exports
zhengxiu
8f6b8d3664
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: zhengxiu <zhengxiu@huawei.com> Co-committed-by: zhengxiu <zhengxiu@huawei.com>
126 lines
10 KiB
HTML
126 lines
10 KiB
HTML
<a name="DeleteSnapshot"></a><a name="DeleteSnapshot"></a>
|
|
|
|
<h1 class="topictitle1">Deleting a Snapshot</h1>
|
|
<div id="body1708331107508"><div class="section" id="DeleteSnapshot__section1719164416117"><h4 class="sectiontitle">Function</h4><p id="DeleteSnapshot__p101911044131118">CSS allows you to use snapshots to back up and restore Elasticsearch cluster data. By storing a snapshot in an OBS bucket, you save a point-in-time copy of the cluster's data. By restoring this snapshot, you can restore the cluster to a previous state. There are two ways to create snapshots to back up a CSS cluster: automatic and manual.</p>
|
|
<ul id="DeleteSnapshot__ul919164461110"><li id="DeleteSnapshot__li1619174418113"><p id="DeleteSnapshot__p1019110441119"><a name="DeleteSnapshot__li1619174418113"></a><a name="li1619174418113"></a>Automatic snapshot creation: Snapshots are created periodically based on a preset time policy, for example, daily or weekly, to ensure continuous data protection. This reduces manual effort and improves backup reliability and efficiency.</p>
|
|
</li><li id="DeleteSnapshot__li9191124416117"><p id="DeleteSnapshot__p14191164420114"><a name="DeleteSnapshot__li9191124416117"></a><a name="li9191124416117"></a>Manual snapshot creation: You can manually create snapshots when necessary, for example, before performing a mission-critical operation (such as a cluster upgrade), so you can use these snapshots to quickly restore the cluster to a previous state in case anything goes wrong. Manual snapshots provide more flexibility.</p>
|
|
</li></ul>
|
|
<p id="DeleteSnapshot__p119112449118">This API is used to delete a snapshot.</p>
|
|
<div class="note" id="DeleteSnapshot__note14191444181110"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="DeleteSnapshot__p161911544201115">After a snapshot is deleted, its data cannot be restored. Exercise caution.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section21911844111115"><h4 class="sectiontitle">Calling Method</h4><p id="DeleteSnapshot__p319244411115">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section1819264414111"><h4 class="sectiontitle">URI</h4><p id="DeleteSnapshot__p11192144461112">DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteSnapshot__table91931944131120" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="DeleteSnapshot__row1619224412119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="DeleteSnapshot__p81931944141111">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="DeleteSnapshot__p81937445119">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="DeleteSnapshot__p141931644161116">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="DeleteSnapshot__p20193164414119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteSnapshot__row131921144141114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteSnapshot__p61931644191112">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteSnapshot__p1819320448112">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteSnapshot__p1219394411112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteSnapshot__p1719318442119"><strong id="DeleteSnapshot__b719404421111">Definition</strong>:</p>
|
|
<p id="DeleteSnapshot__p01941644181119">Project ID. For details about how to obtain the project ID and name, see <a href="css_03_0071.html">Obtaining the Project ID and Name</a>.</p>
|
|
<p id="DeleteSnapshot__p3194544131113"><strong id="DeleteSnapshot__b141941644111111">Constraints</strong>:</p>
|
|
<p id="DeleteSnapshot__p1319444413114">N/A</p>
|
|
<p id="DeleteSnapshot__p16194044101110"><strong id="DeleteSnapshot__b131942044131112">Value range</strong>:</p>
|
|
<p id="DeleteSnapshot__p1194644131118">Project ID of the account.</p>
|
|
<p id="DeleteSnapshot__p1119454416115"><strong id="DeleteSnapshot__b21941644181114">Default value</strong>:</p>
|
|
<p id="DeleteSnapshot__p71941944171115">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteSnapshot__row15192944151113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteSnapshot__p5194944101119">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteSnapshot__p17194194441112">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteSnapshot__p819412443116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteSnapshot__p1919454413114"><strong id="DeleteSnapshot__b1519464491116">Definition</strong>:</p>
|
|
<p id="DeleteSnapshot__p7194204431115">ID of the cluster to which the to-be-deleted snapshot belongs. For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining a Cluster ID</a>.</p>
|
|
<p id="DeleteSnapshot__p6194144171119"><strong id="DeleteSnapshot__b6194154414118">Constraints</strong>:</p>
|
|
<p id="DeleteSnapshot__p71951644111117">N/A</p>
|
|
<p id="DeleteSnapshot__p1419504451117"><strong id="DeleteSnapshot__b19195174420115">Value range</strong>:</p>
|
|
<p id="DeleteSnapshot__p919518447114">Cluster ID.</p>
|
|
<p id="DeleteSnapshot__p6195644201118"><strong id="DeleteSnapshot__b151951844101116">Default value</strong>:</p>
|
|
<p id="DeleteSnapshot__p1719544411111">N/A</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteSnapshot__row12192134471118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="DeleteSnapshot__p151951444151119">snapshot_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="DeleteSnapshot__p9195114411114">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="DeleteSnapshot__p9195744171116">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="DeleteSnapshot__p0195104411110"><strong id="DeleteSnapshot__b111951344131114">Definition</strong>:</p>
|
|
<p id="DeleteSnapshot__p10195164431120">ID of the snapshot you want to delete.</p>
|
|
<p id="DeleteSnapshot__p1619564451118"><strong id="DeleteSnapshot__b0195184416112">Constraints</strong>:</p>
|
|
<p id="DeleteSnapshot__p20195124410114">N/A</p>
|
|
<p id="DeleteSnapshot__p51961544131117"><strong id="DeleteSnapshot__b191966447118">Value range</strong>:</p>
|
|
<p id="DeleteSnapshot__p61961444101117">N/A</p>
|
|
<p id="DeleteSnapshot__p8196544111117"><strong id="DeleteSnapshot__b10196124471112">Default value</strong>:</p>
|
|
<p id="DeleteSnapshot__p71964447113">N/A</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section1519694441118"><h4 class="sectiontitle">Request Parameters</h4><p id="DeleteSnapshot__p3196114415111">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section5196184481114"><h4 class="sectiontitle">Response Parameters</h4><p id="DeleteSnapshot__p2196194431112"><strong id="DeleteSnapshot__b12196444111116">Status code: 200</strong></p>
|
|
<p id="DeleteSnapshot__p1719684420119">Request succeeded.</p>
|
|
<p id="DeleteSnapshot__p1419614448117">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section1196184481115"><h4 class="sectiontitle">Example Requests</h4><p id="DeleteSnapshot__p319612443118">Delete a snapshot.</p>
|
|
<pre class="screen" id="DeleteSnapshot__screen10196184412113">DELETE https://{Endpoint}/v1.0/{project_id}/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/29a2254e-947f-4463-b65a-5f0b17515fae</pre>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section14196124411116"><h4 class="sectiontitle">Example Responses</h4><p id="DeleteSnapshot__p21971044171116">None</p>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section5205164421112"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="DeleteSnapshot__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="DeleteSnapshot__row1220516446114"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="DeleteSnapshot__p820514410114">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="DeleteSnapshot__p172051444101120">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="DeleteSnapshot__row17205174401113"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="DeleteSnapshot__p1620534416113">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="DeleteSnapshot__p1520594451115">Request succeeded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteSnapshot__row1920584481112"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="DeleteSnapshot__p192061444101110">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="DeleteSnapshot__p1767844471114">Invalid request.</p>
|
|
<p id="DeleteSnapshot__p106791444131115">Modify the request before retry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="DeleteSnapshot__row32051448118"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="DeleteSnapshot__p18679194419117">403</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="DeleteSnapshot__p1667913443117">Request rejected.</p>
|
|
<p id="DeleteSnapshot__p1667944418116">The server has received the request and understood it, but refused to respond to it. The client should not repeat the request without modifications.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="DeleteSnapshot__section267915442115"><h4 class="sectiontitle">Error Codes</h4><p id="DeleteSnapshot__p867918442114">See <a href="css_03_0076.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="snapshot_management.html">Snapshot Management</a></div>
|
|
</div>
|
|
</div>
|
|
|