forked from docs/doc-exports
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
130 lines
12 KiB
HTML
130 lines
12 KiB
HTML
<a name="rds_14_0001"></a><a name="rds_14_0001"></a>
|
|
|
|
<h1 class="topictitle1">Modifying Recycling Policy</h1>
|
|
<div id="body32001227"><div class="section" id="rds_14_0001__en-us_topic_0293125502_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_14_0001__en-us_topic_0293125502_p5753583532">This API is used to modify the recycling policy for the recycle bin.</p>
|
|
<ul id="rds_14_0001__en-us_topic_0293125502_ul12259155218373"><li id="rds_14_0001__en-us_topic_0293125502_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_14_0001__en-us_topic_0293125502_en-us_topic_0110967248_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_14_0001__en-us_topic_0293125502_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_14_0001__en-us_topic_0293125502_ul53354139141429"><li id="rds_14_0001__en-us_topic_0293125502_li1270098217262">URI format<p id="rds_14_0001__en-us_topic_0293125502_p66079617141421"><a name="rds_14_0001__en-us_topic_0293125502_li1270098217262"></a><a name="en-us_topic_0293125502_li1270098217262"></a>PUT https://{<em id="rds_14_0001__en-us_topic_0293125502_i86129260155">Endpoint</em>}/v3/{project_id}/instances/recycle-policy</p>
|
|
</li></ul>
|
|
<ul id="rds_14_0001__en-us_topic_0293125502_ul49831254144655"><li id="rds_14_0001__en-us_topic_0293125502_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0001__en-us_topic_0293125502_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_14_0001__en-us_topic_0293125502_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.979999999999997%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_14_0001__en-us_topic_0293125502_p34889605">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.55%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_14_0001__en-us_topic_0293125502_p7485743">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_14_0001__en-us_topic_0293125502_p2365466">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0001__en-us_topic_0293125502_row57385070"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_14_0001__en-us_topic_0293125502_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_14_0001__en-us_topic_0293125502_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_14_0001__en-us_topic_0293125502_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_14_0001__en-us_topic_0293125502_p181691757183820">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_14_0001__en-us_topic_0293125502_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_14_0001__en-us_topic_0293125502_ul5099287616954"><li id="rds_14_0001__en-us_topic_0293125502_li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0001__en-us_topic_0293125502_table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_14_0001__en-us_topic_0293125502_row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_14_0001__en-us_topic_0293125502_p17490046">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_14_0001__en-us_topic_0293125502_p7407659">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_14_0001__en-us_topic_0293125502_p63149496">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_14_0001__en-us_topic_0293125502_p14835533">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0001__en-us_topic_0293125502_row14585161119435"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_14_0001__en-us_topic_0293125502_p1249514203221">recycle_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_14_0001__en-us_topic_0293125502_p195857114438">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_14_0001__en-us_topic_0293125502_p15633192181419">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_14_0001__en-us_topic_0293125502_p1712621921413">Each element is associated with the recycle bin.</p>
|
|
<p id="rds_14_0001__en-us_topic_0293125502_p15578338103011">For details on the element structure, see <a href="#rds_14_0001__en-us_topic_0293125502_table20307125662116">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="rds_14_0001__en-us_topic_0293125502_table20307125662116"></a><a name="en-us_topic_0293125502_table20307125662116"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0001__en-us_topic_0293125502_table20307125662116" frame="border" border="1" rules="all"><caption><b>Table 3 </b>recycle_policy elements</caption><thead align="left"><tr id="rds_14_0001__en-us_topic_0293125502_row18306205682117"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="rds_14_0001__en-us_topic_0293125502_p5305115613215">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="rds_14_0001__en-us_topic_0293125502_p173057569218">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="rds_14_0001__en-us_topic_0293125502_p0306656172110">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="rds_14_0001__en-us_topic_0293125502_p33060564212">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0001__en-us_topic_0293125502_row1130715612212"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="rds_14_0001__p330695662116">retention_period_in_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="rds_14_0001__p3307185682115">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="rds_14_0001__p20307115619211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="rds_14_0001__p2030765622115">Period of retaining deleted DB instances from 1 day to 7 days.</p>
|
|
<p id="rds_14_0001__p1492855135416">If this parameter is left blank, the retention period is 7 days by default.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_14_0001__ul104194315311"><li id="rds_14_0001__en-us_topic_0293125502_li4411135064210">Example<p id="rds_14_0001__en-us_topic_0293125502_p1454414211213"><a name="rds_14_0001__en-us_topic_0293125502_li4411135064210"></a><a name="en-us_topic_0293125502_li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy</p>
|
|
</li></ul>
|
|
<ul id="rds_14_0001__ul104431450633"><li id="rds_14_0001__li11443155012320">Request example<pre class="codeblock" id="rds_14_0001__codeblock13443175014310">{
|
|
"recycle_policy":
|
|
{
|
|
"retention_period_in_days":"1"
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_14_0001__en-us_topic_0293125502_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_14_0001__en-us_topic_0293125502_ul99341059052"><li id="rds_14_0001__en-us_topic_0293125502_li10799193816479">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0001__en-us_topic_0293125502_table668693854710" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="rds_14_0001__en-us_topic_0293125502_row579917386473"><th align="left" class="cellrowborder" valign="top" width="33.68%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_14_0001__en-us_topic_0293125502_p11799738114718">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.47%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_14_0001__en-us_topic_0293125502_p879983818477">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="32.85%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_14_0001__en-us_topic_0293125502_p1799538174710">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0001__en-us_topic_0293125502_row1379923812473"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_14_0001__en-us_topic_0293125502_p5799103874712">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.47%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_14_0001__en-us_topic_0293125502_p879983854715">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="32.85%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_14_0001__en-us_topic_0293125502_p177991438194711">Returns <strong id="rds_14_0001__en-us_topic_0293125502_b1099785166961">success</strong> if the invoking is successful.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_14_0001__en-us_topic_0293125502_ul107522057173418"><li id="rds_14_0001__en-us_topic_0293125502_li735719919138">Example normal response<pre class="codeblock" id="rds_14_0001__en-us_topic_0293125502_codeblock053262517133">{
|
|
"result": "success"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="rds_14_0001__en-us_topic_0293125502_ul26818564"><li id="rds_14_0001__en-us_topic_0293125502_li33014451514">Abnormal response<p id="rds_14_0001__en-us_topic_0293125502_en-us_topic_0110967248_p014165512396"><a name="rds_14_0001__en-us_topic_0293125502_li33014451514"></a><a name="en-us_topic_0293125502_li33014451514"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="rds_14_0001__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_14_0001__en-us_topic_0032347778_ul7858132212142"><li id="rds_14_0001__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_14_0001__en-us_topic_0032347778_p1040982941020"><a name="rds_14_0001__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_14_0001__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_14_0001__en-us_topic_0032347778_p0723374409"><a name="rds_14_0001__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_14_0001__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_14_0001__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_14_0000.html">Recycling a DB Instance</a></div>
|
|
</div>
|
|
</div>
|
|
|