forked from docs/doc-exports
Zheng, Xiu
c8d7a6f7c1
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Zheng, Xiu <zhengxiu@huawei.com> Co-committed-by: Zheng, Xiu <zhengxiu@huawei.com>
163 lines
11 KiB
HTML
163 lines
11 KiB
HTML
<a name="css_03_0032"></a><a name="css_03_0032"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Automatic Snapshot Creation Policy for a Cluster</h1>
|
|
<div id="body1522117927446"><div class="section" id="css_03_0032__section874853215915"><h4 class="sectiontitle">Function</h4><p id="css_03_0032__p3877173615415">This API is used to query the automatic snapshot creation policy for a cluster.</p>
|
|
</div>
|
|
<div class="section" id="css_03_0032__section8763193210910"><h4 class="sectiontitle">URI</h4><pre class="screen" id="css_03_0032__screen1695846201113">GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy</pre>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="css_03_0032__table57631032695" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="css_03_0032__row4445336913"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.2.3.2.5.1.1"><p id="css_03_0032__p54417338910">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.3.2.5.1.2"><p id="css_03_0032__p1644733693">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.3.2.5.1.3"><p id="css_03_0032__p11441233696">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.3.2.5.1.4"><p id="css_03_0032__p124403319916">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0032__row94414331098"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0032__p950595565411">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0032__p9444331997">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0032__p144412334919">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0032__p18449331896">Project ID. </p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row14453320917"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.2.3.2.5.1.1 "><p id="css_03_0032__p15505145512547">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.3.2.5.1.2 "><p id="css_03_0032__p24410331398">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.3.2.5.1.3 "><p id="css_03_0032__p844133316918">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.3.2.5.1.4 "><p id="css_03_0032__p13441833493">ID of the cluster, for which the automatic snapshot creation policy is to be queried.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0032__section1477913211910"><h4 class="sectiontitle">Request</h4><p id="css_03_0032__p68217347413">None</p>
|
|
</div>
|
|
<div class="section" id="css_03_0032__section19810103220915"><h4 class="sectiontitle">Response</h4><p id="css_03_0032__p11255155894116"><a href="#css_03_0032__table2282125191510">Table 2</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0032__table2282125191510"></a><a name="table2282125191510"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0032__table2282125191510" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="css_03_0032__row16282195131515"><th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.3.2.4.1.1"><p id="css_03_0032__p4446331696">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.3.2.4.1.2"><p id="css_03_0032__p7440338917">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53%" id="mcps1.3.4.3.2.4.1.3"><p id="css_03_0032__p184453317918">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0032__row142821951181515"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p14081111574">keepday</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p1971181065714">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p4524238185713">Retention days for a snapshot.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row543104310568"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p14087119575">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p3711201095716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p322318256578">Time when a snapshot is created every day.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row142728488564"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p2040821145715">prefix</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p12711110135713">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p11223132516573">Snapshot name prefix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row15272154845619"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p640812125718">bucket</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p147111710175715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p14223325185719">OBS bucket for storing snapshots.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row147413452191"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p5475124511910">basePath</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p6450195481911">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p19475104516193">Storage path of the snapshot in the OBS bucket.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row1215235445612"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p13410312579">agency</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p127123106579">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p7223025185714">Agency used to access OBS buckets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row7152135455612"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p1141041165716">enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p671291020575">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p18223132515717">Whether to enable the automatic snapshot creation policy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__row17550717105720"><td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.4.3.2.4.1.1 "><p id="css_03_0032__p1655111172575">snapshotCmkId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.3.2.4.1.2 "><p id="css_03_0032__p20551117105719">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53%" headers="mcps1.3.4.3.2.4.1.3 "><p id="css_03_0032__p255171705710">Snapshot encryption ID. If the snapshot is not encrypted, value <span class="parmvalue" id="css_03_0032__parmvalue6423185516121"><b>null</b></span> is returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="css_03_0032__section17489545144119"><h4 class="sectiontitle">Examples</h4><p id="css_03_0032__p64419337911">Example request</p>
|
|
<pre class="screen" id="css_03_0032__screen184473316911">GET /v1.0/6204a5bd270343b5885144cf9c8c158d/clusters/ea244205-d641-45d9-9dcb-ab2236bcd07e/index_snapshot/policy</pre>
|
|
<p id="css_03_0032__p1144153313915">Example response</p>
|
|
<div class="p" id="css_03_0032__p080953620403"><pre class="screen" id="css_03_0032__screen14418331595"></pre>
|
|
</div>
|
|
<pre class="screen" id="css_03_0032__screen158121459151614">{
|
|
"keepday":2,
|
|
"period":"16:00 GMT+02:00",
|
|
"prefix":"snapshot",
|
|
"bucket":"es-backup",
|
|
"basePath": "css_repository/tests",
|
|
"agency":"usearch",
|
|
"enable":"true",
|
|
"snapshotCmkId" : "a7d5d58c-0330-4d25-860d-c488a4cb4ba7"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="css_03_0032__section87962546391"><h4 class="sectiontitle">Status Code</h4><p id="css_03_0032__p1147144641213"><a href="#css_03_0032__table18620659263">Table 3</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="css_03_0032__table18620659263"></a><a name="table18620659263"></a><table cellpadding="4" cellspacing="0" summary="" id="css_03_0032__table18620659263" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="css_03_0032__css_03_0031_row194918333132"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.1"><p id="css_03_0032__css_03_0031_p6531343171310">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.2"><p id="css_03_0032__css_03_0031_p16534124318132">Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.6.3.2.4.1.3"><p id="css_03_0032__css_03_0031_p1453710437131">Status Code Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="css_03_0032__css_03_0031_row09491533111315"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0032__css_03_0031_p1656994351310">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0032__css_03_0031_p134136431055">OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0032__css_03_0031_p134136431458">The request is processed successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="css_03_0032__css_03_0031_row1184954102013"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.1 "><p id="css_03_0032__css_03_0031_p111841154132019">406</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.2 "><p id="css_03_0032__css_03_0031_en-us_topic_0122640420_p19980869">Not Acceptable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.6.3.2.4.1.3 "><p id="css_03_0032__css_03_0031_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>
|
|
|