forked from docs/doc-exports
Wang , Deng Ke
4c6bc53817
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
126 lines
8.8 KiB
HTML
126 lines
8.8 KiB
HTML
<a name="dds_api_0138"></a><a name="dds_api_0138"></a>
|
|
|
|
<h1 class="topictitle1">Setting the Recycle Bin Policy</h1>
|
|
<div id="body0000001486372018"><div class="section" id="dds_api_0138__section4894192115617"><h4 class="sectiontitle">API Description</h4><p id="dds_api_0138__p1566734563">This API is used to set the recycle bin policy for an instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0138__section1389616295612"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0138__ul791121595"><li id="dds_api_0138__li591812155912">URI format<p id="dds_api_0138__p066173175615"><a name="dds_api_0138__li591812155912"></a><a name="li591812155912"></a>PUT https://{Endpoint}/v3/{project_id}/instances/recycle-policy</p>
|
|
</li><li id="dds_api_0138__li88473612325">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0138__table711554123219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_0138__row311444193210"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dds_api_0138__p12114941103212">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dds_api_0138__p13114174163218">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dds_api_0138__p181143414320">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dds_api_0138__p311424115325">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0138__row711464111321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0138__p21141941113214">x-auth-token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0138__p11114124113323">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0138__p1211444153217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0138__p911494112324">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0138__row2011524118326"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0138__p6115124110328">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dds_api_0138__p111516411323">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dds_api_0138__p171151741183215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dds_api_0138__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0138__section187659393189"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0138__ul9190352124619"><li id="dds_api_0138__li10190205210465">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0138__table1592092105616" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request body parameters</caption><thead align="left"><tr id="dds_api_0138__row86813195610"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dds_api_0138__p268153135615">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dds_api_0138__p1768933563">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dds_api_0138__p168438562">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dds_api_0138__p126813375619">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0138__row146853205615"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0138__p1268163175615">recycle_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0138__p368113175614">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0138__p136818335616">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0138__p1669632563">Instance recycling policy. For details, see <a href="#dds_api_0138__table159257245612">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0138__table159257245612"></a><a name="table159257245612"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0138__table159257245612" frame="border" border="1" rules="all"><caption><b>Table 3 </b>RecyclePolicy</caption><thead align="left"><tr id="dds_api_0138__row14691937561"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dds_api_0138__p6691313569">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dds_api_0138__p1069193105614">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dds_api_0138__p176953145617">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dds_api_0138__p36915375616">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0138__row19692375613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0138__p269103155610">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0138__p6692031568">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0138__p107043145619">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0138__p157015385613">The recycling policy is enabled and cannot be disabled.</p>
|
|
<ul id="dds_api_0138__ul6701739568"><li id="dds_api_0138__li970739562"><strong id="dds_api_0138__b14795114016469">true</strong>: The recycling policy is enabled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0138__row27018312568"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0138__p107015385613">retention_period_in_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0138__p17705305617">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0138__p67018310561">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0138__p14701631569">Policy retention duration (1 to 7 days). The value is a positive integer. If this parameter is left blank, the policy is retained for 7 days by default.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0138__ul122071734151911"><li id="dds_api_0138__li920733411191">Request example<pre class="screen" id="dds_api_0138__screen129985420142">PUT https://dds.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy
|
|
|
|
{
|
|
"recycle_policy" : {
|
|
"enabled" : true,
|
|
"retention_period_in_days" : 3
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0138__section15939152205612"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0138__ul18539131631517"><li id="dds_api_0138__li15539916121519">Parameter description<p id="dds_api_0138__p25861221143018"><a name="dds_api_0138__li15539916121519"></a><a name="li15539916121519"></a>None</p>
|
|
</li></ul>
|
|
<ul id="dds_api_0138__ul16464105314172"><li id="dds_api_0138__li124649532175">Response example<p id="dds_api_0138__p641117651818"><a name="dds_api_0138__li124649532175"></a><a name="li124649532175"></a>None</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0138__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0138__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0138__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0138__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0138__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
<p id="dds_api_0138__p8060118"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|