yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
8c3286488e65fe8cefd35e465ae3063759ab742c
doc-exports/docs/css/api-ref/UpdateSnapshotSetting.html
zhengxiu 8f6b8d3664 css api 25.6.0 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: zhengxiu <zhengxiu@huawei.com>
Co-committed-by: zhengxiu <zhengxiu@huawei.com>
2025-11-25 11:21:12 +00:00

370 lines
38 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="UpdateSnapshotSetting"></a><a name="UpdateSnapshotSetting"></a>
<h1 class="topictitle1">Modifying Basic Configurations of a Cluster Snapshot</h1>
<div id="body1708331107508"><div class="section" id="UpdateSnapshotSetting__section16720442112"><h4 class="sectiontitle">Function</h4><p id="UpdateSnapshotSetting__p871744151115">This API is used to modify the basic configurations for a cluster snapshot, including OBS buckets and IAM agency.</p>
<ul id="UpdateSnapshotSetting__ul1719442112"><li id="UpdateSnapshotSetting__li4754417111"><p id="UpdateSnapshotSetting__p776443113"><a name="UpdateSnapshotSetting__li4754417111"></a><a name="li4754417111"></a><strong id="UpdateSnapshotSetting__b68154415119">OBS Bucket</strong>: Enter the location of the OBS bucket used for storing snapshots.</p>
</li><li id="UpdateSnapshotSetting__li28194412116"><p id="UpdateSnapshotSetting__p7884414117"><a name="UpdateSnapshotSetting__li28194412116"></a><a name="li28194412116"></a><strong id="UpdateSnapshotSetting__b12834414118">Backup Path</strong>: Enter the storage path of the snapshot in the OBS bucket.</p>
</li><li id="UpdateSnapshotSetting__li18804412116"><p id="UpdateSnapshotSetting__p10864414118"><a name="UpdateSnapshotSetting__li18804412116"></a><a name="li18804412116"></a><strong id="UpdateSnapshotSetting__b178174411116">IAM Agency</strong>: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.</p>
</li></ul>
<p id="UpdateSnapshotSetting__p7820446116">You can also use this API to enable the snapshot function.</p>
</div>
<div class="section" id="UpdateSnapshotSetting__section12818448116"><h4 class="sectiontitle">Calling Method</h4><p id="UpdateSnapshotSetting__p1816445111">For details, see <a href="css_03_0077.html">Calling APIs</a>.</p>
</div>
<div class="section" id="UpdateSnapshotSetting__section168194418112"><h4 class="sectiontitle">URI</h4><p id="UpdateSnapshotSetting__p5884413111">POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSnapshotSetting__table2099441110" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="UpdateSnapshotSetting__row109244111117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="UpdateSnapshotSetting__p20984491119">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="UpdateSnapshotSetting__p19844191112">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="UpdateSnapshotSetting__p1897441119">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="UpdateSnapshotSetting__p149944151120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateSnapshotSetting__row5964461114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateSnapshotSetting__p179744161112">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateSnapshotSetting__p910344191110">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateSnapshotSetting__p610114481116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateSnapshotSetting__p18101844121111"><strong id="UpdateSnapshotSetting__b131004414115">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p1610744121111">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="UpdateSnapshotSetting__p410744191116"><strong id="UpdateSnapshotSetting__b5106445116">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p1510174417114">N/A</p>
<p id="UpdateSnapshotSetting__p11014447112"><strong id="UpdateSnapshotSetting__b1310154421114">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p171044481118">Project ID of the account.</p>
<p id="UpdateSnapshotSetting__p151064417119"><strong id="UpdateSnapshotSetting__b1910134418114">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p201054419119">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row8910446111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="UpdateSnapshotSetting__p161054461117">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="UpdateSnapshotSetting__p1101144161119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="UpdateSnapshotSetting__p41034411116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="UpdateSnapshotSetting__p8104441112"><strong id="UpdateSnapshotSetting__b91114445116">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p31174431116">ID of the target cluster For details about how to obtain the cluster ID, see <a href="css_03_0101.html">Obtaining the Cluster ID</a>.</p>
<p id="UpdateSnapshotSetting__p911744121119"><strong id="UpdateSnapshotSetting__b4111844191113">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p1911644171111">N/A</p>
<p id="UpdateSnapshotSetting__p811114491112"><strong id="UpdateSnapshotSetting__b17111044111113">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p11154415116">Cluster ID.</p>
<p id="UpdateSnapshotSetting__p12112044201118"><strong id="UpdateSnapshotSetting__b71174471118">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p151124419111">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateSnapshotSetting__section1411184418113"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSnapshotSetting__request_UpdateSnapshotSettingReq" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="UpdateSnapshotSetting__row1812114410119"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="UpdateSnapshotSetting__p131254471116">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="UpdateSnapshotSetting__p101354461111">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="UpdateSnapshotSetting__p141354461110">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="UpdateSnapshotSetting__p1713144121112">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateSnapshotSetting__row121213444112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p151344420118">bucket</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p1013644171119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p16131644201111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p1813144416118"><strong id="UpdateSnapshotSetting__b913144410111">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p1113134451116">Name of the OBS bucket used for backup.</p>
<p id="UpdateSnapshotSetting__p11394471111"><strong id="UpdateSnapshotSetting__b111334481114">Constraints</strong>:</p>
<ul id="UpdateSnapshotSetting__ul5138442111"><li id="UpdateSnapshotSetting__li613114471112"><p id="UpdateSnapshotSetting__p13131644161116"><a name="UpdateSnapshotSetting__li613114471112"></a><a name="li613114471112"></a>Storage class: standard.</p>
</li><li id="UpdateSnapshotSetting__li813644191114"><p id="UpdateSnapshotSetting__p813194461120"><a name="UpdateSnapshotSetting__li813644191114"></a><a name="li813644191114"></a>Region: the same as that of the cluster.</p>
</li></ul>
<p id="UpdateSnapshotSetting__p1413134410114"><strong id="UpdateSnapshotSetting__b121312445117">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p713744191119">N/A</p>
<p id="UpdateSnapshotSetting__p17137447112"><strong id="UpdateSnapshotSetting__b113114411110">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p4131744171117">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row41214420110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p114104421114">agency</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p18141244111119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p51414448115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p121484411111"><strong id="UpdateSnapshotSetting__b81474451116">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p514104451119">Agency name. You can create an agency to allow CSS to call other cloud services.</p>
<p id="UpdateSnapshotSetting__p111414412116"><strong id="UpdateSnapshotSetting__b1414204419113">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p1014104421112">The value can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). It cannot contain Chinese characters or other special characters.</p>
<p id="UpdateSnapshotSetting__p514104417116"><strong id="UpdateSnapshotSetting__b31484411116">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p11145446117">N/A</p>
<p id="UpdateSnapshotSetting__p71444431113"><strong id="UpdateSnapshotSetting__b1914134461112">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p91464461120">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row91224461116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p1914174491118">base_path</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p214174471111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p214154420115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p1515174410117"><strong id="UpdateSnapshotSetting__b1151244201111">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p51574431113">Storage path of the snapshot in the OBS bucket.</p>
<p id="UpdateSnapshotSetting__p61574431117"><strong id="UpdateSnapshotSetting__b171511445115">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p715194416117">N/A</p>
<p id="UpdateSnapshotSetting__p31513449119"><strong id="UpdateSnapshotSetting__b131574418118">Value range</strong>:</p>
<ul id="UpdateSnapshotSetting__ul18154440119"><li id="UpdateSnapshotSetting__li6151944121116"><p id="UpdateSnapshotSetting__p215184421112"><a name="UpdateSnapshotSetting__li6151944121116"></a><a name="li6151944121116"></a>The backup path cannot contain the following characters: \:*?"&lt;&gt;|'{}. Additionally, it cannot:</p>
</li><li id="UpdateSnapshotSetting__li19151344151115"><p id="UpdateSnapshotSetting__p141584412115"><a name="UpdateSnapshotSetting__li19151344151115"></a><a name="li19151344151115"></a>Start with a slash (/).</p>
</li><li id="UpdateSnapshotSetting__li61524491119"><p id="UpdateSnapshotSetting__p1159441115"><a name="UpdateSnapshotSetting__li61524491119"></a><a name="li61524491119"></a>Start or end with a period (.).</p>
</li><li id="UpdateSnapshotSetting__li1515134431113"><p id="UpdateSnapshotSetting__p18151144141117"><a name="UpdateSnapshotSetting__li1515134431113"></a><a name="li1515134431113"></a>Contain more than two consecutive slashes (/) or periods (.).</p>
</li><li id="UpdateSnapshotSetting__li51574412119"><p id="UpdateSnapshotSetting__p131514431117"><a name="UpdateSnapshotSetting__li51574412119"></a><a name="li51574412119"></a>Exceed 512 characters.</p>
</li></ul>
<p id="UpdateSnapshotSetting__p16151744101117"><strong id="UpdateSnapshotSetting__b81554415112">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p1015104421118">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row1812144412111"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p6156449119">max_snapshot_bytes_per_seconds</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p71514442115">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p4169444110">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p516154418118"><strong id="UpdateSnapshotSetting__b1616144419115">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p131624481112">This parameter sets the maximum backup speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual backup speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.</p>
<p id="UpdateSnapshotSetting__p1916174420111"><strong id="UpdateSnapshotSetting__b5164449111">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p4162044191115">N/A</p>
<p id="UpdateSnapshotSetting__p1516944111110"><strong id="UpdateSnapshotSetting__b7161644121113">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p181616446117">The following values and formats are allowed:</p>
<ul id="UpdateSnapshotSetting__ul1616184471115"><li id="UpdateSnapshotSetting__li101664461119"><p id="UpdateSnapshotSetting__p91694414115"><a name="UpdateSnapshotSetting__li101664461119"></a><a name="li101664461119"></a>Number + Unit</p>
</li></ul>
<p id="UpdateSnapshotSetting__p21619441110">The number ranges from 0 to 9999.</p>
<p id="UpdateSnapshotSetting__p1216154421113">The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).</p>
<p id="UpdateSnapshotSetting__p1816204491114"><strong id="UpdateSnapshotSetting__b31613449119">0mb</strong> means there is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.</p>
<ul id="UpdateSnapshotSetting__ul316124410116"><li id="UpdateSnapshotSetting__li11161144191110"><p id="UpdateSnapshotSetting__p15161044191110"><a name="UpdateSnapshotSetting__li11161144191110"></a><a name="li11161144191110"></a>0</p>
</li></ul>
<p id="UpdateSnapshotSetting__p19167449119">There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.</p>
<ul id="UpdateSnapshotSetting__ul31612441114"><li id="UpdateSnapshotSetting__li7167442115"><p id="UpdateSnapshotSetting__p12161944151111"><a name="UpdateSnapshotSetting__li7167442115"></a><a name="li7167442115"></a>-1</p>
</li></ul>
<p id="UpdateSnapshotSetting__p1916744201120">There is no speed limit. An overly high backup speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.</p>
<p id="UpdateSnapshotSetting__p1217944201117"><strong id="UpdateSnapshotSetting__b31704441113">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p121774401112">The default value is 40 MB. If this parameter is left blank, the default value is used.</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row1512944191114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p617114419113">max_restore_bytes_per_seconds</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p20175446118">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p111754416114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p1617744141110"><strong id="UpdateSnapshotSetting__b1617444181117">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p1117154481112">This parameter sets the maximum recovery speed per node (bytes per second). When it is exceeded, flow control is triggered to prevent excessive resource usage and ensure system stability. The actual recovery speed may not reach the configured value, as it depends on many factors, such as OBS performance and disk I/O.</p>
<p id="UpdateSnapshotSetting__p12172044131111"><strong id="UpdateSnapshotSetting__b17177449118">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p14172441115">For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter. If Maximum recovery speed (per second) is lower than indices.recovery.max_bytes_per_sec, flow control is triggered when the former is reached. If Maximum recovery speed (per second) is higher than indices.recovery.max_bytes_per_sec, flow control is triggered when the latter is reached.</p>
<p id="UpdateSnapshotSetting__p91734451117"><strong id="UpdateSnapshotSetting__b10171344201117">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p1017044151113">The following values and formats are allowed:</p>
<ul id="UpdateSnapshotSetting__ul14179447116"><li id="UpdateSnapshotSetting__li1417184411113"><p id="UpdateSnapshotSetting__p171715444114"><a name="UpdateSnapshotSetting__li1417184411113"></a><a name="li1417184411113"></a>Number + Unit</p>
</li></ul>
<p id="UpdateSnapshotSetting__p19171044181114">The number ranges from 0 to 9999.</p>
<p id="UpdateSnapshotSetting__p1171644111119">The unit can be k, kb, m, mb, g, gb, t, tb, p, pb, or b (case-insensitive).</p>
<p id="UpdateSnapshotSetting__p817644131111"><strong id="UpdateSnapshotSetting__b17178448115">0mb</strong> means there is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.</p>
<ul id="UpdateSnapshotSetting__ul71854419119"><li id="UpdateSnapshotSetting__li141864471117"><p id="UpdateSnapshotSetting__p161854431117"><a name="UpdateSnapshotSetting__li141864471117"></a><a name="li141864471117"></a>0</p>
</li></ul>
<p id="UpdateSnapshotSetting__p518184413119">There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.</p>
<ul id="UpdateSnapshotSetting__ul418114451110"><li id="UpdateSnapshotSetting__li10187443114"><p id="UpdateSnapshotSetting__p1118544121117"><a name="UpdateSnapshotSetting__li10187443114"></a><a name="li10187443114"></a>-1</p>
</li></ul>
<p id="UpdateSnapshotSetting__p131814421118">There is no speed limit. (However, for OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the recovery speed is also limited by the indices.recovery.max_bytes_per_sec parameter.) An overly high recovery speed may lead to excessive resource usage, which may impact system stability. Therefore, set this parameter carefully.</p>
<p id="UpdateSnapshotSetting__p13188441113"><strong id="UpdateSnapshotSetting__b131810443118">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p1118744151114">For Elasticsearch clusters of 7.6.2 or earlier, the default setting is <strong id="UpdateSnapshotSetting__b9181244181115">40mb</strong>.</p>
<p id="UpdateSnapshotSetting__p1018944151116">For OpenSearch clusters and Elasticsearch clusters later than 7.6.2, the default setting is no limit, but the recovery speed is still limited by the indices.recovery.max_bytes_per_sec parameter.</p>
<p id="UpdateSnapshotSetting__p318194417118">If this parameter is left blank, the default setting is used.</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row4129441117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p161824410111">enable</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p171818440118">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p1118124418111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p6181544171113"><strong id="UpdateSnapshotSetting__b218184413113">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p918194417113">Whether to enable the automatic snapshot creation policy.</p>
<p id="UpdateSnapshotSetting__p11181644181111"><strong id="UpdateSnapshotSetting__b21824416115">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p219194412111">N/A</p>
<p id="UpdateSnapshotSetting__p181934413117"><strong id="UpdateSnapshotSetting__b201911446116">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p16192445113"><strong id="UpdateSnapshotSetting__b141944410117">true</strong>: The automatic snapshot creation policy is enabled.</p>
<p id="UpdateSnapshotSetting__p719184417111">false: disabled.</p>
<p id="UpdateSnapshotSetting__p41911444118"><strong id="UpdateSnapshotSetting__b151904416110">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p1219204414112">false</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row91224451112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p1319644111110">indices</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p1219244101117">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p12191744131115">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p319124415117"><strong id="UpdateSnapshotSetting__b2019184481116">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p151964416111">Name of the index to be backed up.</p>
<p id="UpdateSnapshotSetting__p419104431112"><strong id="UpdateSnapshotSetting__b1219844141110">Constraints</strong>:</p>
<ul id="UpdateSnapshotSetting__ul8191344171115"><li id="UpdateSnapshotSetting__li171924419113"><p id="UpdateSnapshotSetting__p16595445185"><a name="UpdateSnapshotSetting__li171924419113"></a><a name="li171924419113"></a>indicates all indexes and is valid only when enable is set to true.</p>
</li><li id="UpdateSnapshotSetting__li62012445112"><p id="UpdateSnapshotSetting__p13201844121111"><a name="UpdateSnapshotSetting__li62012445112"></a><a name="li62012445112"></a>The value cannot contain uppercase letters, spaces, or the following characters: "&lt;|&gt;/?</p>
</li></ul>
<p id="UpdateSnapshotSetting__p62024481119"><strong id="UpdateSnapshotSetting__b2203449114">Value range</strong>:</p>
<ul id="UpdateSnapshotSetting__ul102015445111"><li id="UpdateSnapshotSetting__li10207447113"><p id="UpdateSnapshotSetting__p192044413115"><a name="UpdateSnapshotSetting__li10207447113"></a><a name="li10207447113"></a>If this parameter is left blank, all indexes in the snapshot are restored by default.</p>
</li><li id="UpdateSnapshotSetting__li320104417110"><p id="UpdateSnapshotSetting__p1220154421115"><a name="UpdateSnapshotSetting__li320104417110"></a><a name="li320104417110"></a>To restore specified indexes, for example, index1, index2, and Index3, specify the indexes.</p>
</li></ul>
<p id="UpdateSnapshotSetting__p32016446116">You can use an asterisk (<em id="UpdateSnapshotSetting__i820144419114">) to match multiple indexes. For example, index</em> indicates that all indexes with the prefix <strong id="UpdateSnapshotSetting__b720744121110">index</strong> will be restored.</p>
<p id="UpdateSnapshotSetting__p1120244171116"><strong id="UpdateSnapshotSetting__b2020244131113">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p1920104418117">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row21224441115"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p1820844111112">prefix</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p7207446113">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p920104411111">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p821444161117"><strong id="UpdateSnapshotSetting__b22117449112">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p8211442119">Prefix of a snapshot that is automatically created, which is manually entered.</p>
<p id="UpdateSnapshotSetting__p92144413116"><strong id="UpdateSnapshotSetting__b821184411119">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p1021104411117">This parameter is mandatory when <strong id="UpdateSnapshotSetting__b1521114417113">enable</strong> is set to <strong id="UpdateSnapshotSetting__b62116444118">true</strong>.</p>
<p id="UpdateSnapshotSetting__p7211644181112"><strong id="UpdateSnapshotSetting__b19212449119">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p162124461116">Enter up to 32 characters and start with a lowercase letter. Lowercase letters, digits, hyphens (-), and underscores (_) are allowed.</p>
<p id="UpdateSnapshotSetting__p1321244131117"><strong id="UpdateSnapshotSetting__b112119447115">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p192124421112">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row0121344161114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p5211344171119">period</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p921104411114">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p521124451116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p17211944171110"><strong id="UpdateSnapshotSetting__b121124491116">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p1221184410117">Time when a snapshot is created every day.</p>
<p id="UpdateSnapshotSetting__p22120448117"><strong id="UpdateSnapshotSetting__b1221444191116">Constraints</strong>:</p>
<div class="note" id="UpdateSnapshotSetting__note122264417118"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="UpdateSnapshotSetting__p521144141116">When frequency is set to HOUR, you do not need to specify period. By default, snapshot creation starts from the next hour after the settings are successful.</p>
</div></div>
<ul id="UpdateSnapshotSetting__ul922044141118"><li id="UpdateSnapshotSetting__li72254461113"><p id="UpdateSnapshotSetting__p1422174413114"><a name="UpdateSnapshotSetting__li72254461113"></a><a name="li72254461113"></a>This parameter is mandatory when enable is set to true.</p>
</li></ul>
<p id="UpdateSnapshotSetting__p522544181119"><strong id="UpdateSnapshotSetting__b1224442110">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p422944141115">Snapshots can only be created on the hour. The time format is the time followed by the time zone, specifically, <strong id="UpdateSnapshotSetting__b7221344131114">HH:mm z</strong>. In the format, <strong id="UpdateSnapshotSetting__b19221144171110">HH:mm</strong> refers to the hour time and <strong id="UpdateSnapshotSetting__b1222204410118">z</strong> refers to the time zone. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00.</p>
<p id="UpdateSnapshotSetting__p10222044131120"><strong id="UpdateSnapshotSetting__b11225447113">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p13227447116">00:00 GMT+08:00</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row212174461118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p142234421117">keepday</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p12216444112">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p1622174421118">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p152244418117"><strong id="UpdateSnapshotSetting__b522244181112">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p122844111117">Customize the number of snapshots to be retained. Expired snapshots will be automatically deleted on the half hour. The deletion policy applies only to auto snapshots that are executed at the same frequency as the current automatic snapshot creation policy.</p>
<p id="UpdateSnapshotSetting__p92264431114"><strong id="UpdateSnapshotSetting__b1523444141117">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p623344101110">This parameter is mandatory when <strong id="UpdateSnapshotSetting__b62364451114">enable</strong> is set to <strong id="UpdateSnapshotSetting__b20231144141111">true</strong>.</p>
<p id="UpdateSnapshotSetting__p22314431118"><strong id="UpdateSnapshotSetting__b423134418116">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p623154417114">1–90</p>
<p id="UpdateSnapshotSetting__p123344151119"><strong id="UpdateSnapshotSetting__b12374461118">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p14239449116">N/A</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row01217440116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p192374471119">frequency</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p423124471111">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p4239447119">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p5239442113"><strong id="UpdateSnapshotSetting__b172394412112">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p6237442114">Frequency of automatically creating snapshots.</p>
<p id="UpdateSnapshotSetting__p192394413118"><strong id="UpdateSnapshotSetting__b102354411112">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p123044121112">N/A</p>
<p id="UpdateSnapshotSetting__p112364415110"><strong id="UpdateSnapshotSetting__b92394481114">Value range</strong>:</p>
<ul id="UpdateSnapshotSetting__ul132314412113"><li id="UpdateSnapshotSetting__li192344421116"><p id="UpdateSnapshotSetting__p11235446110"><a name="UpdateSnapshotSetting__li192344421116"></a><a name="li192344421116"></a>HOUR: Execute once every hour on the hour.</p>
</li><li id="UpdateSnapshotSetting__li142413441117"><p id="UpdateSnapshotSetting__p524114491120"><a name="UpdateSnapshotSetting__li142413441117"></a><a name="li142413441117"></a>DAY: Execute once every day.</p>
</li><li id="UpdateSnapshotSetting__li122418449118"><p id="UpdateSnapshotSetting__p72414416111"><a name="UpdateSnapshotSetting__li122418449118"></a><a name="li122418449118"></a>SUN, MON, TUE, WED, THU, FRI, and SAT: Execute the task at the specified day of every week. For example, SUN indicates that the task is executed once every Sunday.</p>
</li><li id="UpdateSnapshotSetting__li1924194410118"><p id="UpdateSnapshotSetting__p924164451118"><a name="UpdateSnapshotSetting__li1924194410118"></a><a name="li1924194410118"></a>The number of retained snapshots depends on the execution frequency and indexes set in the automatic snapshot creation policy. If the execution interval is short or the index data volume is large, the number of retained automatic snapshots may not reach the preset value. Set this value based on actual conditions.</p>
</li></ul>
<p id="UpdateSnapshotSetting__p1024154414116"><strong id="UpdateSnapshotSetting__b224124461115">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p132411443112">DAY</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row1128440119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="UpdateSnapshotSetting__p2024154415114">delete_auto</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="UpdateSnapshotSetting__p9172344121110">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="UpdateSnapshotSetting__p51724447116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="UpdateSnapshotSetting__p161725449119"><strong id="UpdateSnapshotSetting__b121721344181116">Definition</strong>:</p>
<p id="UpdateSnapshotSetting__p117216444111">Whether to clear all the automatically created snapshots when the automatic snapshot creation policy is disabled.</p>
<p id="UpdateSnapshotSetting__p13172104414113"><strong id="UpdateSnapshotSetting__b6172124491119">Constraints</strong>:</p>
<p id="UpdateSnapshotSetting__p111721644171111">This parameter is valid only when enable is set to false, indicating that automatic backup is disabled.</p>
<p id="UpdateSnapshotSetting__p1317214441118"><strong id="UpdateSnapshotSetting__b16172124451110">Value range</strong>:</p>
<p id="UpdateSnapshotSetting__p101721044171110"><strong id="UpdateSnapshotSetting__b20172444111113">true</strong>: Delete all automatically created snapshots when an automatic snapshot creation policy is disabled.</p>
<p id="UpdateSnapshotSetting__p217394431118">false: Retain automatically created snapshots when an automatic snapshot creation policy is disabled.</p>
<p id="UpdateSnapshotSetting__p0173244121117"><strong id="UpdateSnapshotSetting__b1173124431111">Default value</strong>:</p>
<p id="UpdateSnapshotSetting__p181731446116">false</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateSnapshotSetting__section5173184411118"><h4 class="sectiontitle">Response Parameters</h4><p id="UpdateSnapshotSetting__p111731644111118"><strong id="UpdateSnapshotSetting__b1617317447113">Status code: 200</strong></p>
<p id="UpdateSnapshotSetting__p5173184491112">Request succeeded.</p>
<p id="UpdateSnapshotSetting__p1173134413115">None</p>
</div>
<div class="section" id="UpdateSnapshotSetting__section17173154461111"><h4 class="sectiontitle">Example Requests</h4><p id="UpdateSnapshotSetting__p8173134471111">Enable the snapshot function.</p>
<pre class="screen" id="UpdateSnapshotSetting__screen1917324418113">POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/index_snapshot/setting
{
"bucket" : "test-bucket",
"agency" : "usearch",
"base_path" : "css_repository/Es-name",
"max_snapshot_bytes_per_seconds" : 0,
"max_restore_bytes_per_seconds" : 0
}</pre>
</div>
<div class="section" id="UpdateSnapshotSetting__section41731844151115"><h4 class="sectiontitle">Example Responses</h4><p id="UpdateSnapshotSetting__p1417364413111">None</p>
</div>
<div class="section" id="UpdateSnapshotSetting__section317564491113"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="UpdateSnapshotSetting__status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="UpdateSnapshotSetting__row16318441113"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="UpdateSnapshotSetting__p717524417113">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="UpdateSnapshotSetting__p181751844181118">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="UpdateSnapshotSetting__row83134491114"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateSnapshotSetting__p9175044191112">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateSnapshotSetting__p10175194451118">Request succeeded.</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row731344111111"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateSnapshotSetting__p19175344151118">406</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateSnapshotSetting__p1017584414114">The server could not fulfill the request according to the content characteristics of the request.</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row1531444121116"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateSnapshotSetting__p13175114412114">412</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateSnapshotSetting__p13175244181118">The server did not meet one of the preconditions contained in the request.</p>
</td>
</tr>
<tr id="UpdateSnapshotSetting__row133134401118"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="UpdateSnapshotSetting__p41755442113">504</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="UpdateSnapshotSetting__p9175144471112">A gateway timeout error occurred.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="UpdateSnapshotSetting__section1176944171116"><h4 class="sectiontitle">Error Codes</h4><p id="UpdateSnapshotSetting__p2176134401111">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>
View Git Blame Copy Permalink