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>
112 lines
8.0 KiB
HTML
112 lines
8.0 KiB
HTML
<a name="dds_api_0215"></a><a name="dds_api_0215"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Recycling Policy of a DB Instance</h1>
|
|
<div id="body0000001536931921"><div class="section" id="dds_api_0215__section4894192115617"><h4 class="sectiontitle">API Description</h4><p id="dds_api_0215__p1566734563">This API is used to query the recycling policy of a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0215__section1389616295612"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0215__ul791121595"><li id="dds_api_0215__li591812155912">URI format<p id="dds_api_0215__p066173175615"><a name="dds_api_0215__li591812155912"></a><a name="li591812155912"></a>GET https://{Endpoint}/v3/{project_id}/instances/recycle-policy</p>
|
|
</li><li id="dds_api_0215__li88473612325">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0215__table711554123219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_0215__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_0215__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_0215__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_0215__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_0215__p311424115325">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0215__row711464111321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0215__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_0215__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_0215__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_0215__p911494112324">User token.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0215__row2011524118326"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_0215__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_0215__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_0215__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_0215__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_0215__section187659393189"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0215__ul39241291555"><li id="dds_api_0215__li2092418295517">Example request<p id="dds_api_0215__p13726732356"><a name="dds_api_0215__li2092418295517"></a><a name="li2092418295517"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/recycle-policy</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0215__section15939152205612"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0215__ul18539131631517"><li id="dds_api_0215__li15539916121519">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0215__table46641525244" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_0215__row3664182172419"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0215__p1664285804216">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0215__p36421585425">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0215__p1364217588428">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0215__row96647282410"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0215__p628071519257">recycle_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0215__p1028016151254"><a href="#dds_api_0215__table19191130122514">RecyclePolicy</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0215__p12811315182517">Instance recycling policy.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0215__table19191130122514"></a><a name="table19191130122514"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0215__table19191130122514" frame="border" border="1" rules="all"><caption><b>Table 3 </b>RecyclePolicy</caption><thead align="left"><tr id="dds_api_0215__row0192133018255"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0215__p8989342192510">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0215__p3989144242520">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0215__p16989134218258">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0215__row8192530132517"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0215__p3311362301">enabled</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0215__p931110643015">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0215__p19311662309">Whether to enable the recycling policy.</p>
|
|
<ul id="dds_api_0215__ul23117633015"><li id="dds_api_0215__li731117611303"><strong id="dds_api_0215__b1160745794">true</strong>: Enable the recycling policy.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0215__row141921630202515"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0215__p2311461306">retention_period_in_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0215__p231116619309">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0215__p23118611303">Policy retention period (1 to 7 days). The value must be a positive integer.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0215__ul16464105314172"><li id="dds_api_0215__li124649532175">Response Example<pre class="screen" id="dds_api_0215__screen17389131016313">{
|
|
"recycle_policy" : {
|
|
"enabled" : true,
|
|
"retention_period_in_days" : 3
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0215__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0215__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0215__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_0215__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0215__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
<p id="dds_api_0215__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>
|
|
|