forked from docs/doc-exports
wangdengke2
1ddaec1a62
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
98 lines
9.6 KiB
HTML
98 lines
9.6 KiB
HTML
<a name="rds_14_0002"></a><a name="rds_14_0002"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Recycling Policy</h1>
|
|
<div id="body0000002410005437"><div class="section" id="rds_14_0002__en-us_topic_0000001498353329_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_14_0002__en-us_topic_0000001498353329_p5753583532">This API is used to query the recycling policy of the recycle bin.</p>
|
|
<ul id="rds_14_0002__ul18745321174017"><li id="rds_14_0002__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_0002__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_0002__en-us_topic_0000001498353329_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_14_0002__en-us_topic_0000001498353329_ul53354139141429"><li id="rds_14_0002__en-us_topic_0000001498353329_li1270098217262">URI format<p id="rds_14_0002__en-us_topic_0000001498353329_p66079617141421"><a name="rds_14_0002__en-us_topic_0000001498353329_li1270098217262"></a><a name="en-us_topic_0000001498353329_li1270098217262"></a>GET https://{<em id="rds_14_0002__en-us_topic_0000001498353329_i86129260155">endpoint</em>}/v3/{project_id}/instances/recycle-policy</p>
|
|
</li></ul>
|
|
<ul id="rds_14_0002__en-us_topic_0000001498353329_ul49831254144655"><li id="rds_14_0002__en-us_topic_0000001498353329_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0002__en-us_topic_0000001498353329_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_14_0002__en-us_topic_0000001498353329_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_0002__en-us_topic_0000001498353329_p34889605"><strong id="rds_14_0002__b9384515152316">Parameter</strong></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_0002__en-us_topic_0000001498353329_p7485743"><strong id="rds_14_0002__b15737314238">Mandatory</strong></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_0002__en-us_topic_0000001498353329_p2365466"><strong id="rds_14_0002__b5970193217237">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0002__en-us_topic_0000001498353329_row57385070"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_14_0002__en-us_topic_0000001498353329_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_0002__en-us_topic_0000001498353329_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_0002__en-us_topic_0293125502_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_14_0002__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_0002__en-us_topic_0000001498353329_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_14_0002__en-us_topic_0000001498353329_ul5099287616954"><li id="rds_14_0002__en-us_topic_0000001498353329_li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0002__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_14_0002__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_14_0002__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_14_0002__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_14_0002__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_14_0002__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0002__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_14_0002__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_14_0002__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_14_0002__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_14_0002__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_14_0002__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="rds_14_0002__en-us_topic_0000001498353329_li4411135064210">URI example<pre class="screen" id="rds_14_0002__screen20576165017412">GET https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/recycle-policy</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_14_0002__en-us_topic_0000001498353329_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_14_0002__en-us_topic_0000001498353329_ul99341059052"><li id="rds_14_0002__en-us_topic_0000001498353329_li10799193816479">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0002__en-us_topic_0000001498353329_table668693854710" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_14_0002__en-us_topic_0000001498353329_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_0002__en-us_topic_0000001498353329_p11799738114718"><strong id="rds_14_0002__b1265111348241">Parameter</strong></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_0002__en-us_topic_0000001498353329_p879983818477"><strong id="rds_14_0002__b10327113662416">Type</strong></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_0002__en-us_topic_0000001498353329_p1799538174710"><strong id="rds_14_0002__b152081338152414">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_14_0002__en-us_topic_0000001498353329_row1379923812473"><td class="cellrowborder" valign="top" width="33.68%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_14_0002__en-us_topic_0000001498353329_p2062019365599">retention_period_in_days</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_0002__en-us_topic_0000001498353329_p86209367596">Integer</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_0002__p4223161073712">Number of days for retaining instances in the recycle bin.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_14_0002__en-us_topic_0000001498353329_ul107522057173418"><li id="rds_14_0002__en-us_topic_0000001498353329_li735719919138">Example normal response<pre class="screen" id="rds_14_0002__screen19178317873">{
|
|
"retention_period_in_days" : 7
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="rds_14_0002__en-us_topic_0293125502_ul26818564"><li id="rds_14_0002__en-us_topic_0293125502_li33014451514">Abnormal response<p id="rds_14_0002__en-us_topic_0293125502_en-us_topic_0110967248_p014165512396"><a name="rds_14_0002__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_0002__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_14_0002__en-us_topic_0032347778_ul7858132212142"><li id="rds_14_0002__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_14_0002__en-us_topic_0032347778_p1040982941020"><a name="rds_14_0002__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_14_0002__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_14_0002__en-us_topic_0032347778_p0723374409"><a name="rds_14_0002__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_0002__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_14_0002__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>
|
|
|