forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
126 lines
13 KiB
HTML
126 lines
13 KiB
HTML
<a name="EN-US_TOPIC_0000001917290436"></a><a name="EN-US_TOPIC_0000001917290436"></a>
|
|
|
|
<h1 class="topictitle1">Modifying the Recycling Policy</h1>
|
|
<div id="body0000001362797312"><div class="section" id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_section2161131714317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_p1779463834710">This API is used to modify the recycling policy. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290436__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_section1832017411437"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>PUT https://{<em id="EN-US_TOPIC_0000001917290436__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/recycle-policy</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_li4411135064210"></a><a name="en-us_topic_0248254028_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290436__li899917313338">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_table1986313483146" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_row158631348151416"><th align="left" class="cellrowborder" valign="top" width="22.79%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_p178635485145">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.880000000000003%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_p586384819144">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.330000000000005%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_p3863164871419">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290436__row153821619455"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0128427214_p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0128427214_p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290436__p19528455451">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001917290436__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_ul1387512325219"><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_li387592375220">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290436__table17504161413231" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290436__row1050511141233"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917290436__p17505191417231">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917290436__p16505121414236">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.73%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917290436__p1450581412316">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.78%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917290436__p1250551452317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290436__row14505614192319"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290436__p145053148233">recycle_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290436__p115052014132315">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290436__p105051114182316">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290436__p1750519148236">Recycling policy. For details, see <a href="#EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_table477719232522">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_table477719232522"></a><a name="en-us_topic_0151958051_table477719232522"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_table477719232522" frame="border" border="1" rules="all"><caption><b>Table 3 </b>recycle_policy field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_row118759235520"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_p1587542375213">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_p287512375212">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.75%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_p8875152313526">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.76%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_p198753239523">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_row1387582319526"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_p9875523185210">retention_period_in_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_p168751823115220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0151958051_a9a9492e05cb648e885d1e747a339d04d">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.76%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290436__p95491212195310">Deleted instance retention period.</p>
|
|
<p id="EN-US_TOPIC_0000001917290436__p115491912205318">Value range: <strong id="EN-US_TOPIC_0000001917290436__b16314134110276">1</strong> to <strong id="EN-US_TOPIC_0000001917290436__b14314134112718">7</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290436__section1869723381916"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000001917290436__p917112103203">Setting the retention period of deleted instances to 5 days<pre class="screen" id="EN-US_TOPIC_0000001917290436__screen8987171272015">{
|
|
"recycle_policy": {
|
|
"retention_period_in_days": 5
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290436__section41971257122313"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290436__ul31923327101549"><li id="EN-US_TOPIC_0000001917290436__li18874490101549">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290436__table9721459954" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290436__row77218591559"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290436__p072175912513"><strong id="EN-US_TOPIC_0000001917290436__b1596418616583">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="22.97%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290436__p9721205918516"><strong id="EN-US_TOPIC_0000001917290436__b10909137165815">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.04%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290436__p5721155912518"><strong id="EN-US_TOPIC_0000001917290436__b1681518811589">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290436__row14721135917514"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290436__p16721115910510">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="22.97%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290436__p167219591952">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.04%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290436__p751611617619">Modification result. <strong id="EN-US_TOPIC_0000001917290436__b13489162905819">success</strong> indicates that the modification is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0000001917290436__li27619632">Example normal response<pre class="screen" id="EN-US_TOPIC_0000001917290436__screen1381012297511">{
|
|
"result": "success"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001917290436__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290436__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290436__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290436__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290436__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_newapi_0036.html">Recycle Bin</a></div>
|
|
</div>
|
|
</div>
|
|
|