1
0
forked from docs/doc-exports
doc-exports/docs/dds/api-ref/dds_api_021.html
Ru, Li Yi 1706f95907 dds_api
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
2024-01-31 18:40:18 +00:00

256 lines
19 KiB
HTML

<a name="dds_api_021"></a><a name="dds_api_021"></a>
<h1 class="topictitle1">Querying DB Instances in the Recycle Bin</h1>
<div id="body0000001537371725"><div class="section" id="dds_api_021__section4894192115617"><h4 class="sectiontitle">API Description</h4><p id="dds_api_021__p1566734563">This API is used to query DB instances in the recycle bin.</p>
</div>
<div class="section" id="dds_api_021__section1389616295612"><h4 class="sectiontitle">URI</h4><ul id="dds_api_021__ul791121595"><li id="dds_api_021__li591812155912">URI format<p id="dds_api_021__p066173175615"><a name="dds_api_021__li591812155912"></a><a name="li591812155912"></a>GET https://{Endpoint}/v3/{project_id}/recycle-instances</p>
</li><li id="dds_api_021__li88473612325">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_021__table711554123219" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request parameters</caption><thead align="left"><tr id="dds_api_021__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_021__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_021__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_021__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_021__p311424115325">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_021__row711464111321"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_021__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_021__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_021__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_021__p911494112324">User token.</p>
</td>
</tr>
<tr id="dds_api_021__row2011524118326"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dds_api_021__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_021__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_021__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_021__p57877484163525">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_021__table1480719372429" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="dds_api_021__row78071737114216"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dds_api_021__p13807637104219">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dds_api_021__p380733784215">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dds_api_021__p28071037204214">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dds_api_021__p13807143734218">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_021__row5808143719423"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dds_api_021__p198082372428">offset</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dds_api_021__p38081637134211">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dds_api_021__p168081937104212">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dds_api_021__p8808537144211">Index offset. If <strong id="dds_api_021__b173219594464">offset</strong> is set to <em id="dds_api_021__i832115984612">N</em>, the resource query starts from the N+1 piece of data. The default value is <strong id="dds_api_021__b113275994611">0</strong>, indicating that the query starts from the first piece of data. The value must be a positive integer.</p>
</td>
</tr>
<tr id="dds_api_021__row1580810372429"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dds_api_021__p4808153794211">limit</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dds_api_021__p1180833711427">No</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dds_api_021__p17808173720428">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dds_api_021__p8808123794212">Number of records displayed on each page. The default value is <strong id="dds_api_021__b1210810370474">100</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_021__section187659393189"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_021__ul39241291555"><li id="dds_api_021__li2092418295517">Example request<p id="dds_api_021__p13726732356"><a name="dds_api_021__li2092418295517"></a><a name="li2092418295517"></a>GET https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/recycle-instances</p>
</li></ul>
</div>
<div class="section" id="dds_api_021__section15939152205612"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_021__ul18539131631517"><li id="dds_api_021__li15539916121519">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_021__table46641525244" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="dds_api_021__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_021__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_021__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_021__p1364217588428">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_021__row9202313329"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_021__p142771424722">total_count</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_021__p3277102419219">Integer</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_021__p32772241214">Total number of records.</p>
</td>
</tr>
<tr id="dds_api_021__row96647282410"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_021__p628071519257">instances</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_021__p47051556123">Array of <a href="#dds_api_021__table88115251643">Table 4</a> objects</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_021__p12811315182517">Instance information.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_021__table88115251643"></a><a name="table88115251643"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_021__table88115251643" frame="border" border="1" rules="all"><caption><b>Table 4 </b>RecycleInstance</caption><thead align="left"><tr id="dds_api_021__row88119253416"><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_021__p1990217354519">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_021__p16902143513512">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_021__p1990218352520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_021__row1681132515410"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p168115491957">id</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_021__p20811849857">String</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_021__p28114910512">DB instance ID.</p>
</td>
</tr>
<tr id="dds_api_021__row48232510416"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p10813491259">name</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_021__p208116491055">String</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_021__p981104915510">DB instance name.</p>
</td>
</tr>
<tr id="dds_api_021__row082425747"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p15814491355">mode</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_021__p14811491755">String</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_021__p4815499514">Instance type. Cluster, replica set, and single node instances are supported. The value can be:</p>
<ul id="dds_api_021__ul138113491358"><li id="dds_api_021__li11813494511">Sharding</li><li id="dds_api_021__li118111491952">ReplicaSet</li><li id="dds_api_021__li128114916511">Single</li></ul>
</td>
</tr>
<tr id="dds_api_021__row1465783520"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p28218499519">datastore</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_021__p17823499519"><a href="#dds_api_021__table38663369715">Table 5</a> object</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_021__p12821491958">Database information.</p>
</td>
</tr>
<tr id="dds_api_021__row1624314171159"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p158284911512">pay_mode</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_021__p19824497519">String</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_021__p188264917515">Billing mode.</p>
<ul id="dds_api_021__ul2082649254"><li id="dds_api_021__li48213493518"><strong id="dds_api_021__b2971233175219">0</strong>: indicates the instance is billed on a pay-per-use basis.</li><li id="dds_api_021__li15825491752"><strong id="dds_api_021__b1194518378524">1</strong>: indicates the instance is billed based on a yearly/monthly basis.</li></ul>
</td>
</tr>
<tr id="dds_api_021__row118089148516"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p1082114919514">enterprise_project_id</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_021__p178244910512">String</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_021__p4825491151">Enterprise project ID. The value <strong id="dds_api_021__b75743117535">0</strong> indicates the default enterprise project.</p>
</td>
</tr>
<tr id="dds_api_021__row12501512657"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p128216490511">backup_id</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_021__p13828491512">String</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_021__p178210493511">Backup ID.</p>
</td>
</tr>
<tr id="dds_api_021__row19726591745"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p12821449953">created_at</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_021__p108210492052">String</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_021__p108213491955">Creation time.</p>
</td>
</tr>
<tr id="dds_api_021__row188291951758"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p19826493518">deleted_at</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_021__p5835491451">String</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_021__p3839496512">Deletion time.</p>
</td>
</tr>
<tr id="dds_api_021__row636531454"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p383134916510">retained_until</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_021__p11831491851">String</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_021__p48304916511">Retention end time.</p>
</td>
</tr>
<tr id="dds_api_021__row121821246132914"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_021__p18183104662911">status</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_021__p518394616293">String</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_021__p9183546202919">Instance backup recycling status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_021__table38663369715"></a><a name="table38663369715"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_021__table38663369715" frame="border" border="1" rules="all"><caption><b>Table 5 </b>RecycleDatastore</caption><thead align="left"><tr id="dds_api_021__row18867736273"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_021__p79267515713">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_021__p19261251273">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_021__p15926195115715">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_021__row11867193620718"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_021__p630175916714">type</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_021__p1730113591871">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_021__p430117593712">Database type. The value is <strong id="dds_api_021__b284510378014">DDS-Community</strong>.</p>
<p id="dds_api_021__p1130117595713">Enumerated values:</p>
<ul id="dds_api_021__ul316515322916"><li id="dds_api_021__li1416573218912">DDS-Community</li></ul>
</td>
</tr>
<tr id="dds_api_021__row986710369711"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_021__p1030212595712">version</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_021__p163023597718">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_021__p193025591871">Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be <strong id="dds_api_021__b1481611362015">3.4, 4.0,</strong> <strong id="dds_api_021__b292149172710">4.2,</strong> or <strong id="dds_api_021__b112241443819">4.4</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_021__ul16464105314172"><li id="dds_api_021__li124649532175">Response Example<pre class="screen" id="dds_api_021__screen17389131016313">{
"total_count" : 1,
"instances" : [ {
"id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in02",
"name" : "test1",
"mode" : "ReplicaSet",
"datastore" : {
"type" : "DDS-Community",
"version" : "4.0"
},
"pay_mode" : "0",
"enterprise_project_id" : "0",
"backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02",
"created_at" : "2022-01-01T10:00:00",
"deleted_at" : "2022-02-01T10:00:00",
"retained_until" : "2022-05-01T10:00:00",
"status" : "Active"
} ]
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_021__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_021__dds_api_0018_p16131712193312">Status Code:200.</p>
<p id="dds_api_021__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_021__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_021__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
<p id="dds_api_021__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>