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>
361 lines
33 KiB
HTML
361 lines
33 KiB
HTML
<a name="rds_14_0003"></a><a name="rds_14_0003"></a>
|
||
|
||
<h1 class="topictitle1">Querying Instances in the Recycle Bin</h1>
|
||
<div id="body0000002409925297"><div class="section" id="rds_14_0003__en-us_topic_0000001498593221_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_14_0003__en-us_topic_0000001498593221_p5753583532">This API is used to query instances in the recycle bin.</p>
|
||
<ul id="rds_14_0003__ul18745321174017"><li id="rds_14_0003__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_0003__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_0003__en-us_topic_0000001498593221_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_14_0003__en-us_topic_0000001498593221_ul53354139141429"><li id="rds_14_0003__en-us_topic_0000001498593221_li1270098217262">URI format<p id="rds_14_0003__en-us_topic_0000001498593221_p66079617141421"><a name="rds_14_0003__en-us_topic_0000001498593221_li1270098217262"></a><a name="en-us_topic_0000001498593221_li1270098217262"></a>GET https://{<em id="rds_14_0003__en-us_topic_0000001498593221_i86129260155">endpoint</em>}/v3/{project_id}/recycle-instances?offset={offset}&limit={limit}</p>
|
||
</li></ul>
|
||
<ul id="rds_14_0003__en-us_topic_0000001498593221_ul49831254144655"><li id="rds_14_0003__en-us_topic_0000001498593221_li15430535">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0003__en-us_topic_0000001498593221_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameters</caption><thead align="left"><tr id="rds_14_0003__en-us_topic_0000001498593221_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_0003__en-us_topic_0000001498593221_p34889605"><strong id="rds_14_0003__b1657357192712">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_0003__en-us_topic_0000001498593221_p7485743"><strong id="rds_14_0003__b755516411288">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_0003__en-us_topic_0000001498593221_p2365466"><strong id="rds_14_0003__b36019622810">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_14_0003__en-us_topic_0000001498593221_row57385070"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_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_0003__en-us_topic_0000001498593221_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_0003__en-us_topic_0293125502_p28182251">Specifies the project ID of a tenant in a region.</p>
|
||
<p id="rds_14_0003__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>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1133415481699"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1187319291015">offset</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_0003__en-us_topic_0000001498593221_p4873112171012">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_0003__p933518142391">Index offset. The query starts from the next piece of data indexed by this parameter.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p1987362121019">The value must be a non-negative number.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1586018541097"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p887417271014">limit</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_0003__en-us_topic_0000001498593221_p1387418211103">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_0003__p1368217013918">Number of records on each page.</p>
|
||
<p id="rds_14_0003__p1075516183917">Value range: [1, 50]</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="rds_14_0003__en-us_topic_0000001498593221_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_14_0003__en-us_topic_0000001498593221_ul5099287616954"><li id="rds_14_0003__en-us_topic_0000001498593221_li5628270116954">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0003__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_14_0003__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_0003__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_0003__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_0003__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_0003__p551110331335">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_14_0003__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_14_0003__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_0003__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_0003__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_0003__p1086851153317">Specifies the user token.</p>
|
||
<p id="rds_14_0003__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_0003__en-us_topic_0000001498593221_li4411135064210">URI example<p id="rds_14_0003__en-us_topic_0000001498593221_p1454414211213"><a name="rds_14_0003__en-us_topic_0000001498593221_li4411135064210"></a><a name="en-us_topic_0000001498593221_li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/recycle-instances?offset=0&limit=10</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="rds_14_0003__en-us_topic_0000001498593221_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_14_0003__en-us_topic_0000001498593221_ul99341059052"><li id="rds_14_0003__en-us_topic_0000001498593221_li10799193816479">Normal response
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0003__en-us_topic_0000001498593221_table668693854710" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters</caption><thead align="left"><tr id="rds_14_0003__en-us_topic_0000001498593221_row579917386473"><th align="left" class="cellrowborder" valign="top" width="19.84%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_14_0003__en-us_topic_0000001498593221_p11799738114718"><strong id="rds_14_0003__b144642315363">Parameter</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="rds_14_0003__en-us_topic_0000001498593221_p879983818477"><strong id="rds_14_0003__b897063214360">Type</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60.11%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="rds_14_0003__en-us_topic_0000001498593221_p1799538174710"><strong id="rds_14_0003__b3130153418367">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_14_0003__en-us_topic_0000001498593221_row1379923812473"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p20811101981210">total_count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1481151961214">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.11%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_14_0003__p1467212694111">Number of data records in the recycle bin.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1745519661210"><td class="cellrowborder" valign="top" width="19.84%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p118111019201215">instances</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p18812419181210">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.11%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1881271917125">Instance information. For details, see <a href="#rds_14_0003__en-us_topic_0000001498593221_table1323681613133">Table 4</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="rds_14_0003__en-us_topic_0000001498593221_table1323681613133"></a><a name="en-us_topic_0000001498593221_table1323681613133"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0003__en-us_topic_0000001498593221_table1323681613133" frame="border" border="1" rules="all"><caption><b>Table 4 </b>instances field data structure description</caption><thead align="left"><tr id="rds_14_0003__en-us_topic_0000001498593221_row1138931611136"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_14_0003__en-us_topic_0000001498593221_p173892166138"><strong id="rds_14_0003__b1754319376377">Parameter</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="rds_14_0003__en-us_topic_0000001498593221_p238941614133"><strong id="rds_14_0003__b16110173973713">Type</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="rds_14_0003__en-us_topic_0000001498593221_p1638911619131"><strong id="rds_14_0003__b1338894153718">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_14_0003__en-us_topic_0000001498593221_row153891163137"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p15389516111315">id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p3389111651318">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p157281818411">Instance ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row4389111612137"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p73898166135">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p738961681315">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p157201820154119">Instance name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row939061661313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p183904169133">ha_mode</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p739021615134">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p172456239418">Instance type. The value is case-insensitive.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001496833745_p72395271390">Enumerated values:</p>
|
||
<ul id="rds_14_0003__ul5469135110439"><li id="rds_14_0003__li15469751194317"><strong id="rds_14_0003__b67425432518">Single</strong>: single-node instance</li><li id="rds_14_0003__li164692512433"><strong id="rds_14_0003__b1481951051">Ha</strong>: primary/standby instance</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row17390131619133"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p739091631314">engine_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p18390151610139">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p83091127194112">DB engine name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1739014168138"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p143907167139">engine_version</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p3390716131319">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p23901016191317">DB engine version.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1439091621316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1339001613137">pay_model</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p53918161137">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p192221344411">Billing mode.</p>
|
||
<p id="rds_14_0003__p4402162424413"><strong id="rds_14_0003__b83591134716">0</strong>: pay-per-use billing</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row3391141621311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p93912162134">created_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p10391181619139">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p114603206453">Creation time. The value is in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p939191616132"><strong id="rds_14_0003__b18209155816414">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_14_0003__b721013588418">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_14_0003__b10210125864112">Z</strong> is <strong id="rds_14_0003__b182109585411">+0100</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row4391161615130"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p163911616161316">deleted_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p10391101614133">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p2351630164515">Deletion time.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p739151619139">The value is in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p19391151601310"><strong id="rds_14_0003__b1914114904315">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_14_0003__b61414497431">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_14_0003__b814149124314">Z</strong> is <strong id="rds_14_0003__b1215124912439">+0100</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row93913167135"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1639171631317">volume_type</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p8391516101310">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p15312124334516">Storage type.</p>
|
||
<ul id="rds_14_0003__en-us_topic_0000001498593221_ul9391816181319"><li id="rds_14_0003__en-us_topic_0000001498593221_li639218161131"><strong id="rds_14_0003__b990673135416">SSD</strong>: cloud SSD storage. This storage type is supported only with general-purpose and dedicated instances.</li><li id="rds_14_0003__en-us_topic_0000001498593221_li639210168131"><strong id="rds_14_0003__b1540121845511">ESSD</strong>: Extreme SSD storage.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1439281641319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p83921816111315">volume_size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p8392131651318">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p1727565713451">Storage space.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p23926165131">40–4000, in GB. The value must be a multiple of 10.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row15392131618130"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p4392161617136">data_vip</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p139241613137">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p13392151618138">Floating IP address.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row1939251620131"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p14392191691319">data_vip_v6</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1239281610135">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1392141641312">Private IPv6 address.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row18392716161310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1739271618139">enterprise_project_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p16392121614131">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p23921416201311">Enterprise project ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row139281619137"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p14392151681312">retained_until</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1392516121314">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p1327702164711">Time until which the instance can be retained.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p8392201616134">The value is in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
||
<p id="rds_14_0003__en-us_topic_0000001498593221_p0393151614139"><strong id="rds_14_0003__b531217318411">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_14_0003__b03124319416">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_14_0003__b83121731947">Z</strong> is <strong id="rds_14_0003__b113133311943">+0100</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row19393516161313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p13936163136">recycle_backup_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p17393141618139">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p9393191610130">Backup ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__en-us_topic_0000001498593221_row83930165131"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__en-us_topic_0000001498593221_p103937168134">recycle_status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__en-us_topic_0000001498593221_p9393111618132">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__en-us_topic_0000001498593221_p1439321612135">Backup status.</p>
|
||
<p id="rds_14_0003__p193111735251">Enumerated values:</p>
|
||
<ul id="rds_14_0003__en-us_topic_0000001498593221_ul23933164133"><li id="rds_14_0003__en-us_topic_0000001498593221_li93931816141318"><strong id="rds_14_0003__b81071903618">BUILDING</strong>: The instance is being backed up and cannot be rebuilt.</li><li id="rds_14_0003__en-us_topic_0000001498593221_li1339341611138"><strong id="rds_14_0003__b169092248611">COMPLETED</strong>: The backup is complete and the instance can be rebuilt.</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row1578155863411"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__p1637317377348">recycle_backups</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__p26641156133419">Array of objects</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p1657805819345">Backups used for restoration. For details, see <a href="#rds_14_0003__table27635217368">Table 5</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row121367403212"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_14_0003__p549162514416">is_serverless</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_14_0003__p1849110251841">Boolean</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_14_0003__p1913644153214">Instance type.</p>
|
||
<ul id="rds_14_0003__ul26999221053"><li id="rds_14_0003__li1869919223518"><strong id="rds_14_0003__b6536324182214">true</strong>: serverless</li><li id="rds_14_0003__li18699222159"><strong id="rds_14_0003__b20552243192210">false</strong>: non-serverless</li></ul>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
|
||
<div class="tablenoborder"><a name="rds_14_0003__table27635217368"></a><a name="table27635217368"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_14_0003__table27635217368" frame="border" border="1" rules="all"><caption><b>Table 5 </b>recycle_backups field data structure description</caption><thead align="left"><tr id="rds_14_0003__row97631924364"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="rds_14_0003__p1576313210369"><strong id="rds_14_0003__b1250673419448">Parameter</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="19.98%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="rds_14_0003__p876362133613"><strong id="rds_14_0003__b1625264527">Type</strong></p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="60.019999999999996%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="rds_14_0003__p27631622366"><strong id="rds_14_0003__b27935415443">Description</strong></p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="rds_14_0003__row5763132203613"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_14_0003__p1776315263618">backup_id</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_14_0003__p176312143618">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_14_0003__p177641125362">Backup ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row92368333369"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_14_0003__p3609203423615">backup_name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_14_0003__p433213516378">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_14_0003__p2243648183714">Backup name.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row6635173714361"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_14_0003__p3991104573610">backup_status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_14_0003__p1893210611376">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_14_0003__p359664713376">Backup status.</p>
|
||
<ul id="rds_14_0003__ul0773274559"><li id="rds_14_0003__li127732713557"><strong id="rds_14_0003__b8961114017453">BUILDING</strong>: backup in progress</li><li id="rds_14_0003__li19773127185511"><strong id="rds_14_0003__b1913204514513">COMPLETED</strong>: backup completed</li><li id="rds_14_0003__li577327155512"><strong id="rds_14_0003__b172941555454">FAILED</strong>: backup failed</li></ul>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row1583915410360"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_14_0003__p167610490368">backup_create_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_14_0003__p7338147103712">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_14_0003__p419514713718">Backup creation time.</p>
|
||
<p id="rds_14_0003__p92195383612">The value is in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
||
<p id="rds_14_0003__p122205319367"><strong id="rds_14_0003__b92135320361">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_14_0003__b728536361">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_14_0003__b3275311366">Z</strong> is <strong id="rds_14_0003__b202653143615">+0100</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row1689719534367"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_14_0003__p112835533612">backup_update_at</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_14_0003__p480297103714">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_14_0003__p275554610374">Backup end time.</p>
|
||
<p id="rds_14_0003__p14321456163614">The value is in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
|
||
<p id="rds_14_0003__p532205633614"><strong id="rds_14_0003__b173295683615">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="rds_14_0003__b13320562362">Z</strong> indicates the time zone offset. For example, if the time zone offset is one hour, the value of <strong id="rds_14_0003__b7328563368">Z</strong> is <strong id="rds_14_0003__b17321566364">+0100</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="rds_14_0003__row181131707376"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="rds_14_0003__p112065118378">backup_size</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="19.98%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="rds_14_0003__p105151631183720">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="60.019999999999996%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="rds_14_0003__p17959736113715">Backup size, in MB.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
<ul id="rds_14_0003__en-us_topic_0000001498593221_ul107522057173418"><li id="rds_14_0003__en-us_topic_0000001498593221_li735719919138">Example normal response<pre class="screen" id="rds_14_0003__screen1198219491279">{
|
||
"total_count": 1,
|
||
"instances": [
|
||
{
|
||
"id": "f55da7ba462f414da2f9505fda3562b9in01",
|
||
"name": "mysql_57_ha_test3",
|
||
"ha_mode": "Ha",
|
||
"engine_name": "mysql",
|
||
"engine_version": "5.7.44",
|
||
"pay_model": "0",
|
||
"created_at": "2025-09-02T09:04:06+0000",
|
||
"deleted_at": "2025-09-03T10:06:33+0000",
|
||
"volume_type": "SSD",
|
||
"volume_size": 40,
|
||
"data_vip": "172.168.235.59",
|
||
"enterprise_project_id": "0",
|
||
"retained_until": "2025-09-10T10:07:05+0000",
|
||
"recycle_backup_id": "37a3d791431045a782d72496d384150abr01",
|
||
"recycle_status": "COMPLETED",
|
||
"recycle_backups": [
|
||
{
|
||
"backup_id": "37a3d791431045a782d72496d384150abr01",
|
||
"backup_name": "mysql-f55da7ba462f414da2f9505fda3562b9in01-20250903100705426",
|
||
"backup_status": "COMPLETED",
|
||
"backup_create_at": "2025-09-03T10:07:05+0000",
|
||
"backup_update_at": "2025-09-03T10:08:20+0000",
|
||
"backup_size": 3600
|
||
}
|
||
],
|
||
"is_serverless": false
|
||
}
|
||
]
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<ul id="rds_14_0003__en-us_topic_0293125502_ul26818564"><li id="rds_14_0003__en-us_topic_0293125502_li33014451514">Abnormal response<p id="rds_14_0003__en-us_topic_0293125502_en-us_topic_0110967248_p014165512396"><a name="rds_14_0003__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_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_14_0003__en-us_topic_0032347778_ul7858132212142"><li id="rds_14_0003__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_14_0003__en-us_topic_0032347778_p1040982941020"><a name="rds_14_0003__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
||
</li><li id="rds_14_0003__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_14_0003__en-us_topic_0032347778_p0723374409"><a name="rds_14_0003__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_0003__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_14_0003__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>
|
||
|