doc-exports/docs/css/api-ref/css_03_0037.html
Zheng, Xiu 99a2d77599 css api 23.5.1 20240520
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>
2024-06-07 17:47:08 +00:00

85 lines
7.0 KiB
HTML

<a name="css_03_0037"></a><a name="css_03_0037"></a>
<h1 class="topictitle1">(Not Recommended) Automatically Configuring Basic Settings of a Cluster Snapshot</h1>
<div id="body1533004597644"><div class="note" id="css_03_0037__note6978201320578"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="css_03_0037__p11979413195717">The API for automatically configuring a cluster snapshot can automatically create OBS buckets and agencies for storing snapshots. If you have multiple clusters, an OBS bucket will be created for each cluster via this API during automatic configuration and consume your OBS quota. Too many OBS buckets will be difficult to manage. You are advised to perform operations in <a href="css_03_0030.html">Modifying Basic Configurations of a Cluster Snapshot</a>.</p>
</div></div>
<div class="section" id="css_03_0037__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0037__p21061341164917">This API is used to automatically set basic configurations for a cluster snapshot, including configuring OBS buckets and IAM agency.</p>
<ul id="css_03_0037__ul1443815755818"><li id="css_03_0037__li1826981220199"><span class="parmname" id="css_03_0037__parmname162861412121915"><b>OBS Bucket</b></span>: Enter the location of the OBS bucket used for storing snapshots.</li><li id="css_03_0037__li145919296198"><span class="parmname" id="css_03_0037__parmname1910460484162930"><b>IAM Agency</b></span>: Authorize you to use OBS in IAM so that snapshots must be stored in OBS.</li></ul>
</div>
<div class="section" id="css_03_0037__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0037__screen1695846201113">POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting</pre>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0037__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0037__row4445336913"><th align="left" class="cellrowborder" valign="top" width="25.77%" id="mcps1.3.3.3.2.5.1.1"><p id="css_03_0037__p54417338910">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.740000000000002%" id="mcps1.3.3.3.2.5.1.2"><p id="css_03_0037__p1644733693">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.56%" id="mcps1.3.3.3.2.5.1.3"><p id="css_03_0037__p11441233696">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.930000000000003%" id="mcps1.3.3.3.2.5.1.4"><p id="css_03_0037__p124403319916">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0037__row94414331098"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0037__p0441331398">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0037__p9444331997">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.56%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0037__p144412334919">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0037__p18449331896">Project ID. For details, see <a href="css_03_0071.html">Obtaining a Project ID and Name</a>.</p>
</td>
</tr>
<tr id="css_03_0037__row14453320917"><td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.3.3.2.5.1.1 "><p id="css_03_0037__p2044193314920">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.740000000000002%" headers="mcps1.3.3.3.2.5.1.2 "><p id="css_03_0037__p24410331398">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.56%" headers="mcps1.3.3.3.2.5.1.3 "><p id="css_03_0037__p844133316918">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.930000000000003%" headers="mcps1.3.3.3.2.5.1.4 "><p id="css_03_0037__p13441833493">ID of the cluster where snapshots are to be backed up.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="css_03_0037__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0037__p8754481256">None</p>
</div>
<div class="section" id="css_03_0037__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0037__p13371130193116">None</p>
</div>
<div class="section" id="css_03_0037__section1468819386395"><h4 class="sectiontitle">Examples</h4><p id="css_03_0037__p64419337911">Example request</p>
<pre class="screen" id="css_03_0037__screen7841540829">POST /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/auto_setting</pre>
</div>
<div class="section" id="css_03_0037__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0037__p1147144641213"><a href="#css_03_0037__table209491933101317">Table 2</a> describes the status code.</p>
<div class="tablenoborder"><a name="css_03_0037__table209491933101317"></a><a name="table209491933101317"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0037__table209491933101317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="css_03_0037__row194918333132"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.7.3.2.4.1.1"><p id="css_03_0037__p6531343171310">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.7.3.2.4.1.2"><p id="css_03_0037__p16534124318132">Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.7.3.2.4.1.3"><p id="css_03_0037__p1453710437131">Status Code Description</p>
</th>
</tr>
</thead>
<tbody><tr id="css_03_0037__row09491533111315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0037__p1656994351310">200</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0037__p134136431055">OK</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0037__p134136431458">The request is processed successfully.</p>
</td>
</tr>
<tr id="css_03_0037__row1184954102013"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.1 "><p id="css_03_0037__p111841154132019">406</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.2 "><p id="css_03_0037__en-us_topic_0122640420_p19980869">Not Acceptable</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.7.3.2.4.1.3 "><p id="css_03_0037__en-us_topic_0122640420_p7837682">The server cannot fulfill the request according to the content characteristics of the request.</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>