doc-exports/docs/rds/api-ref/rds_09_0011.html
Wang , Deng Ke 21e968a153 rds api 2.0.38sp24 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-12 13:50:31 +00:00

119 lines
10 KiB
HTML

<a name="rds_09_0011"></a><a name="rds_09_0011"></a>
<h1 class="topictitle1">Querying the Restoration Time Range</h1>
<div id="body1539585280981"><div class="section" id="rds_09_0011__section117711820496"><h4 class="sectiontitle">Function</h4><p id="rds_09_0011__p1639433018917">This API is used to query the restoration time range of a DB instance.</p>
<ul id="rds_09_0011__ul12259155218373"><li id="rds_09_0011__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_09_0011__en-us_topic_0240111818_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_09_0011__section12081471012"><h4 class="sectiontitle">URI</h4><ul id="rds_09_0011__ul13194498"><li id="rds_09_0011__li615041019120">URI format<p id="rds_09_0011__p615031011219"><a name="rds_09_0011__li615041019120"></a><a name="li615041019120"></a>GET https://{<em id="rds_09_0011__i1453413618162">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/restore-time</p>
</li><li id="rds_09_0011__li22221662">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0011__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0011__row46529701"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="rds_09_0011__p10809459"><strong id="rds_09_0011__b84235270691445">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="rds_09_0011__p3150961"><strong id="rds_09_0011__b15425194843415">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="rds_09_0011__p53901255"><strong id="rds_09_0011__b842352706163417">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_09_0011__row3925534"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0011__p49532829">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0011__p52736237">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0011__p43776822">Specifies the project ID of a tenant in a region.</p>
<p id="rds_09_0011__p35595331581">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_09_0011__row1653872173019"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0011__p41557789155220">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0011__p10737742155220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0011__p64450739155220">Specifies the DB instance ID.</p>
</td>
</tr>
<tr id="rds_09_0011__row1721214212488"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="rds_09_0011__p28121034122014">date</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="rds_09_0011__p621272134811">No</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="rds_09_0011__p02131525485">Specifies the date to be queried. The value is in the yyyy-mm-dd format, and the time zone is UTC.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_09_0011__section14812194415198"><h4 class="sectiontitle">Request</h4><ul id="rds_09_0011__ul1183180183717"><li id="rds_09_0011__li1283110163719">Request parameters<p id="rds_09_0011__p848415163614"><a name="rds_09_0011__li1283110163719"></a><a name="li1283110163719"></a>None</p>
</li></ul>
<ul id="rds_09_0011__ul71041223135313"><li id="rds_09_0011__li4411135064210">Example<p id="rds_09_0011__p1454414211213"><a name="rds_09_0011__li4411135064210"></a><a name="li4411135064210"></a>GET https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/restore-time</p>
</li></ul>
</div>
<div class="section" id="rds_09_0011__section1229512143106"><h4 class="sectiontitle">Response</h4><ul id="rds_09_0011__ul1727710432014"><li id="rds_09_0011__li2692330110">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0011__table6426756154514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_09_0011__row142645664510"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="rds_09_0011__p17490046"><strong id="rds_09_0011__b1518835274">Name</strong></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="rds_09_0011__p63149496"><strong id="rds_09_0011__b842352706164541">Type</strong></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="rds_09_0011__p14835533"><strong id="rds_09_0011__b1328857837">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_09_0011__row34264566458"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="rds_09_0011__p28083633">restore_time</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="rds_09_0011__p42890904">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="rds_09_0011__p61847473">Indicates the list of the restoration time range.</p>
<p id="rds_09_0011__p196515516555">For details, see <a href="#rds_09_0011__table163715367507">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="rds_09_0011__table163715367507"></a><a name="table163715367507"></a><table cellpadding="4" cellspacing="0" summary="" id="rds_09_0011__table163715367507" frame="border" border="1" rules="all"><caption><b>Table 3 </b>restore_time field data structure description</caption><thead align="left"><tr id="rds_09_0011__row9637103616501"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="rds_09_0011__p6927161055116"><strong id="rds_09_0011__b912524502">Name</strong></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="rds_09_0011__p1792911005118"><strong id="rds_09_0011__b537653064">Type</strong></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="rds_09_0011__p16930810145119"><strong id="rds_09_0011__b858650289">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_09_0011__row1863793617509"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0011__p22303345174853">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0011__p34927138174853">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0011__p30482871191015">Indicates the start time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
</td>
</tr>
<tr id="rds_09_0011__row1637173618507"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="rds_09_0011__p8056259175641">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="rds_09_0011__p42443136175641">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="rds_09_0011__p8983181183415">Indicates the end time of the restoration time range in the UNIX timestamp format. The unit is millisecond and the time zone is UTC.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="rds_09_0011__li158029471019">Example normal response<pre class="codeblock" id="rds_09_0011__codeblock1177712336332">{
"restore_time": [
{
"start_time": 1532001446987,
"end_time": 1532742139000
}
]
}</pre>
</li><li id="rds_09_0011__li1473555318317">Abnormal Response<p id="rds_09_0011__p29415884"><a name="rds_09_0011__li1473555318317"></a><a name="li1473555318317"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="rds_09_0011__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_09_0011__en-us_topic_0032347778_ul7858132212142"><li id="rds_09_0011__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_09_0011__en-us_topic_0032347778_p1040982941020"><a name="rds_09_0011__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_09_0011__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_09_0011__en-us_topic_0032347778_p0723374409"><a name="rds_09_0011__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_09_0011__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_09_0011__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="en-us_topic_0032347777.html">Backup and Restoration</a></div>
</div>
</div>