forked from laiweijian4/doc-exports
Wang , Deng Ke
60010eb9d0
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>
123 lines
8.8 KiB
HTML
123 lines
8.8 KiB
HTML
<a name="dds_api_0080"></a><a name="dds_api_0080"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Restoration Time Ranges</h1>
|
|
<div id="body0000001071940873"><div class="section" id="dds_api_0080__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0080__p3631239417316">This API is used to query the restoration time range of a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0080__section107191613546"><h4 class="sectiontitle">Constraints</h4><p id="dds_api_0080__p2089016402544">Currently, this API only supports replica set instances and cluster instances 4.0.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0080__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0080__ul3084351717316"><li id="dds_api_0080__li915620217316">URI format<p id="dds_api_0080__p11252125861417"><a name="dds_api_0080__li915620217316"></a><a name="li915620217316"></a>GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-time?date={yyyy-mm-dd}</p>
|
|
</li><li id="dds_api_0080__li13422134112549">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0080__table1842212410542" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0080__row042115413544"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0080__p7421164112545">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0080__p114212041125412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0080__p9421104120549">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0080__row54223412548"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0080__p24224414549">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0080__p1042214413545">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0080__p74221241175416">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0080__row942216417545"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0080__p142210415543">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0080__p1642234165410">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0080__p1242234118542">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0080__row18422041185415"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0080__p1442224115413">date</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0080__p742214416545">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0080__p4422641145417">Specifies the date to be queried in UTC time zone. The value is in the yyyy-mm-dd format.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0080__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0080__ul165986401164"><li id="dds_api_0080__li75981540201616">Example request<p id="dds_api_0080__p03776433160"><a name="dds_api_0080__li75981540201616"></a><a name="li75981540201616"></a>Get https://dds.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-time?date=2020-12-12</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0080__section159842033154219"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0080__ul11984193315426"><li id="dds_api_0080__li298433314216">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0080__table2098493313423" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0080__row18984193384216"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0080__p14984163316426">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0080__p1798523315428">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0080__p18985133316429">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0080__row19985113314216"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0080__p198533318422">restore_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0080__p1498513311427">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0080__p29854331425">Indicates the restoration time ranges. For details, see <a href="#dds_api_0080__table15985133144213">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0080__table15985133144213"></a><a name="table15985133144213"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0080__table15985133144213" frame="border" border="1" rules="all"><caption><b>Table 3 </b>restore_time parameters</caption><thead align="left"><tr id="dds_api_0080__row19985733134213"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="dds_api_0080__p3985123314217">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="dds_api_0080__p698613344217">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="dds_api_0080__p109861033124211">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0080__row4986233184211"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0080__p169861533204213">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0080__p9986123344216">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0080__p09861133114219">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="dds_api_0080__row1598610332427"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0080__p13986103320420">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="dds_api_0080__p698653354219">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="dds_api_0080__p1498610335421">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></ul>
|
|
<ul id="dds_api_0080__ul139864337422"><li id="dds_api_0080__li0986183314217">Response example<pre class="codeblock" id="dds_api_0080__codeblock7987733104211">{
|
|
"restore_time": [
|
|
{
|
|
"start_time": 1607731200000,
|
|
"end_time": 1607756414000
|
|
},
|
|
{
|
|
"start_time": 1607756825000,
|
|
"end_time": 1607761999000
|
|
},
|
|
{
|
|
"start_time": 1607762943000,
|
|
"end_time": 1607817599000
|
|
}
|
|
]
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0080__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0080__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0080__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_0080__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0080__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_backup_restore.html">Backup and Restoration</a></div>
|
|
</div>
|
|
</div>
|
|
|