forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
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>
131 lines
12 KiB
HTML
131 lines
12 KiB
HTML
<a name="EN-US_TOPIC_0000001947569481"></a><a name="EN-US_TOPIC_0000001947569481"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Restoration Time Range</h1>
|
|
<div id="body0000001295986461"><div class="section" id="EN-US_TOPIC_0000001947569481__section583917715413"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001947569481__p1183914784115">This API is used to query the restoration time range of an instance. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001947569481__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569481__section1083977194116"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>GET https://{<em id="EN-US_TOPIC_0000001947569481__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/restore-time?date={date}</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_li4411135064210"></a><a name="en-us_topic_0248254028_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/d2113b7c60154636b94bea1320b6a874in14/restore-time?date=2022-04-17</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569481__li1426911711361">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569481__table1583967134111" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569481__row18391975413"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="EN-US_TOPIC_0000001947569481__p383920720419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.3.1.2.5.1.2"><p id="EN-US_TOPIC_0000001947569481__p188403716413">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.3.1.2.5.1.3"><p id="EN-US_TOPIC_0000001947569481__p15840147164114">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.2.3.1.2.5.1.4"><p id="EN-US_TOPIC_0000001947569481__p28400744119">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569481__row168391873416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569481__p984057154115">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569481__p084020744115">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569481__p14840177114112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569481__p19528455451">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001947569481__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569481__row483913754120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569481__p1584014754115">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569481__p138406715412">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569481__p12840177144111">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569481__p2201242204518">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001947569481__row13307115013395"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001947569481__p1690715483915">date</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001947569481__p390717547391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001947569481__p2090712548398">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001947569481__p16907145463919">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="EN-US_TOPIC_0000001947569481__section1384215704117"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001947569481__p4242161854618">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569481__section1784420719411"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001947569481__ul1853893174610"><li id="EN-US_TOPIC_0000001947569481__li1538031154617">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569481__response_GetRestoreTimeResponse" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569481__row384511716411"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001947569481__p2084516715411">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001947569481__p198458717411">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001947569481__p188456734112">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569481__row2845137164117"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569481__p15845772418">restore_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569481__p46971305459">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569481__p14846775415">Restoration time ranges.</p>
|
|
<p id="EN-US_TOPIC_0000001947569481__p1383313214717">For details, see <a href="#EN-US_TOPIC_0000001947569481__response_restore_time">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001947569481__response_restore_time"></a><a name="response_restore_time"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001947569481__response_restore_time" frame="border" border="1" rules="all"><caption><b>Table 3 </b>restore_time field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001947569481__row6846879418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001947569481__p1184610712419">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001947569481__p15846117194115">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001947569481__p5846187154116">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001947569481__row88468744112"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569481__p784618754114">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569481__p884717734116">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569481__p884720716411">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="EN-US_TOPIC_0000001947569481__row1784615734119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001947569481__p168473764114">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001947569481__p1847187124114">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001947569481__p584710774115">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></ul>
|
|
<ul id="EN-US_TOPIC_0000001947569481__ul19216147184815"><li id="EN-US_TOPIC_0000001947569481__li13216127164810">Example normal response</li></ul>
|
|
<pre class="codeblock" id="EN-US_TOPIC_0000001947569481__codeblock1781323211387">{
|
|
"restore_time": [
|
|
{
|
|
"start_time": 1652084311000,
|
|
"end_time": 1652092839000
|
|
},
|
|
{
|
|
"start_time": 1652092847000,
|
|
"end_time": 1652094792000
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001947569481__ul15104171101812"><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0128427215_li15857509162">Abnormal response<p id="EN-US_TOPIC_0000001947569481__en-us_topic_0000001655675456_en-us_topic_0128427214_p172314336131"><a name="EN-US_TOPIC_0000001947569481__en-us_topic_0128427215_li15857509162"></a><a name="en-us_topic_0128427215_li15857509162"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569481__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001947569481__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001947569481__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001947569481__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0025.html">Backup Management</a></div>
|
|
</div>
|
|
</div>
|
|
|