forked from docs/doc-exports
Zheng, Xiu
99a2d77599
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
154 lines
13 KiB
HTML
154 lines
13 KiB
HTML
<a name="css_03_0030"></a><a name="css_03_0030"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Basic Configurations of a Cluster Snapshot</h1>
|
|
<div id="body1522117927446"><div class="note" id="css_03_0030__note064123419614"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_03_0030__p06523414613">Using this API will automatically enable the snapshot function.</p>
|
|
</div></div>
|
|
<div class="section" id="css_03_0030__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0030__p21061341164917">This API is used to modify the basic configurations of a cluster snapshot. The basic configurations include the OBS bucket and IAM agency.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0030__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0030__screen1695846201113">POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0030__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0030__row4445336913"><th align="left" class="cellrowborder" valign="top" width="22.96%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0030__p54417338910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.42%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0030__p1644733693">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.770000000000001%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0030__p11441233696">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="39.85%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0030__p124403319916">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0030__row94414331098"><td class="cellrowborder" valign="top" width="22.96%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0030__p0441331398">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0030__p9444331997">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0030__p144412334919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.85%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0030__p79381117123713">Project ID. For details about how to obtain a project ID, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row14453320917"><td class="cellrowborder" valign="top" width="22.96%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0030__p2044193314920">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.42%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0030__p24410331398">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.770000000000001%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0030__p844133316918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="39.85%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0030__p13441833493">ID of the cluster where index data is to be backed up.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0030__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0030__p182014109391"><a href="#css_03_0030__table82481020121413">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0030__table82481020121413"></a><a name="table82481020121413"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0030__table82481020121413" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0030__row18248112010149"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.4.3.2.5.1.1"><p id="css_03_0030__p10441033494">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.5.1.2"><p id="css_03_0030__p74493316910">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.4.3.2.5.1.3"><p id="css_03_0030__p1044533896">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47%" id="mcps1.3.4.3.2.5.1.4"><p id="css_03_0030__p154413335917">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0030__row18248182013148"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0030__p837215054813">bucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0030__p4441233891">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0030__p186181046114912">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0030__p9448924192218">OBS bucket used for index data backup. If there is snapshot data in an OBS bucket, only the OBS bucket is used and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row973213447485"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0030__p1973364414814">basePath</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0030__p1273354413481">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0030__p1673316448484">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0030__p1773364418486">Storage path of the snapshot in the OBS bucket.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row243315404483"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0030__p1343434015485">agency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0030__p443424054812">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0030__p1543414094815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0030__p194341340174817">IAM agency used to access OBS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row38700500107"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.4.3.2.5.1.1 "><p id="css_03_0030__p1687235031013">snapshotCmkId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.2 "><p id="css_03_0030__p387285051014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.4.3.2.5.1.3 "><p id="css_03_0030__p158722506102">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47%" headers="mcps1.3.4.3.2.5.1.4 "><p id="css_03_0030__p10872450111011">Key ID used for snapshot encryption.</p>
|
|
<ul id="css_03_0030__ul67444552406"><li id="css_03_0030__li1985427205916">The Default Master Keys cannot be used to create grants. Specifically, you cannot use Default Master Keys whose aliases end with <span class="parmvalue" id="css_03_0030__parmvalue57857014910"><b>/default</b></span> in KMS to encrypt snapshots.</li><li id="css_03_0030__li125611344125910">If a snapshot has been stored in the OBS bucket, you cannot modify the parameters for encrypting the snapshot.</li><li id="css_03_0030__li172633168116">If the key used for encryption is in the <span class="parmname" id="css_03_0030__parmname1130319716920"><b>Pending deletion</b></span> or <span class="parmname" id="css_03_0030__parmname11303571691"><b>disable</b></span> state, you cannot perform backup and restoration operations on the cluster. Specifically, new snapshots cannot be created for the cluster, and existing snapshots cannot be used for restoration. In this case, switch to the KMS management console and change the state of the target key to <strong id="css_03_0030__b175201618915">enable</strong> so that backup and restore operations are allowed on the cluster.</li><li id="css_03_0030__li116645272515">If the key used for encryption is deleted, backup and restore operations are not allowed on the cluster. In addition, the deleted key cannot be restored. Therefore, exercise caution when deleting a key.</li><li id="css_03_0030__li13758744163915">You are advised to disable the automatic snapshot creation function if the key is deleted or is in the <span class="parmname" id="css_03_0030__parmname102307044718"><b>Pending deletion</b></span> or <span class="parmname" id="css_03_0030__parmname9231209470"><b>disable</b></span> state. In this condition, automatic snapshot creation is allowed based on the configured snapshot policy. However, all automatic snapshot creation tasks will fail, and the failed tasks are displayed in the failed task list in the <strong id="css_03_0030__b1223219074714">Failed Tasks</strong> dialog box.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0030__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0030__p13371130193116">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0030__section1468819386395"><h4 class="sectiontitle">Examples</h4><p id="css_03_0030__p64419337911">Example request</p>
|
|
<pre class="screen" id="css_03_0030__screen7841540829">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/setting
|
|
{
|
|
"bucket":"test-bucket",
|
|
"agency":"usearch",
|
|
"snapshotCmkId":"42546bb1-8025-4ad1-868f-600729c341aea"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0030__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0030__p1147144641213"><a href="#css_03_0030__table209491933101317">Table 3</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0030__table209491933101317"></a><a name="table209491933101317"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0030__table209491933101317" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="css_03_0030__row194918333132"><th align="left" class="cellrowborder" valign="top" width="26.38263826382638%" id="mcps1.3.7.3.2.4.1.1"><p id="css_03_0030__p6531343171310">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="37.11371137113711%" id="mcps1.3.7.3.2.4.1.2"><p id="css_03_0030__p16534124318132">Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.5036503650365%" id="mcps1.3.7.3.2.4.1.3"><p id="css_03_0030__p1453710437131">Status Code Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0030__row09491533111315"><td class="cellrowborder" valign="top" width="26.38263826382638%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0030__p1656994351310">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.11371137113711%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0030__p134136431055">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.5036503650365%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0030__p134136431458">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row1184954102013"><td class="cellrowborder" valign="top" width="26.38263826382638%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0030__p111841154132019">406</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.11371137113711%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0030__en-us_topic_0122640420_p19980869">Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.5036503650365%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0030__en-us_topic_0122640420_p7837682">The server cannot fulfill the request according to the content characteristics of the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row7968201612229"><td class="cellrowborder" valign="top" width="26.38263826382638%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0030__p496891614227">412</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.11371137113711%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0030__en-us_topic_0122640420_p21784659">Precondition Failed</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.5036503650365%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0030__en-us_topic_0122640420_p19726930">The server does not meet one of the preconditions that the requester puts on the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0030__row442289174116"><td class="cellrowborder" valign="top" width="26.38263826382638%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0030__p242417954112">504</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="37.11371137113711%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0030__p1842419154117">Gateway Timeout</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.5036503650365%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0030__p104244912411">A gateway timeout error occurred.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="css_03_0010.html">Snapshot Management APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|