youjiageng1/doc-exports
1
0
Fork 0
forked from laiweijian4/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0082.html
Wang , Deng Ke 60010eb9d0 dds 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-13 08:55:41 +00:00

137 lines
10 KiB
HTML
Raw Permalink Blame History

<a name="dds_api_0082"></a><a name="dds_api_0082"></a>
<h1 class="topictitle1">Obtaining the List of Database Collections That Can Be Restored</h1>
<div id="body0000001071749063"><div class="section" id="dds_api_0082__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0082__p3631239417316">This API is used to obtain the list of databases collections that can be restored.</p>
</div>
<div class="section" id="dds_api_0082__section107191613546"><h4 class="sectiontitle">Constraints</h4><p id="dds_api_0082__p2089016402544">This API applies only to replica sets.</p>
</div>
<div class="section" id="dds_api_0082__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0082__ul3084351717316"><li id="dds_api_0082__li915620217316">URI format<p id="dds_api_0082__p11252125861417"><a name="dds_api_0082__li915620217316"></a><a name="li915620217316"></a>GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restore-collection?db_name={db_name}&amp;restore_time={restore_time}&amp;offset={offset}&amp;limit={limit}</p>
</li><li id="dds_api_0082__li125261019191420">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0082__table09241131141220" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0082__row15922153191213"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0082__p5922183151210">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_0082__p1192233181219">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_0082__p1592220319120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0082__row4922431161213"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0082__p892233171216">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_0082__p4922131131220">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_0082__p492218313123">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="dds_api_0082__row1992311319125"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0082__p129231231201214">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_0082__p5923193151214">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_0082__p1192343117129">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_0082__row6923113161216"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0082__p692313117126">db_name</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_0082__p09231331121213">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_0082__p1892317311125">Specifies the database name.</p>
</td>
</tr>
<tr id="dds_api_0082__row14923831151219"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0082__p13923431151214">restore_time</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_0082__p3923831111219">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_0082__p5923931171219">Specifies the restoration time point.</p>
<p id="dds_api_0082__p3923133141212">The value is a UNIX timestamp, in milliseconds. The time zone is UTC.</p>
</td>
</tr>
<tr id="dds_api_0082__row4924103115124"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0082__p20923143111216">offset</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_0082__p99233313127">No</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_0082__p11923103111217">Specifies the index position.</p>
<ul id="dds_api_0082__ul199151558171514"><li id="dds_api_0082__li1091611588152">The value is an integer greater than or equal to 0.</li><li id="dds_api_0082__li211591151617">If this parameter is not transferred, the value is <strong id="dds_api_0082__b12675598511">0</strong> by default.</li></ul>
</td>
</tr>
<tr id="dds_api_0082__row15924143161216"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0082__p0924123151217">limit</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_0082__p119244319123">No</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_0082__p19246318129">Specifies the upper limit of the number of queried records.</p>
<ul id="dds_api_0082__ul161953812165"><li id="dds_api_0082__li111958821610">The value ranges from 1 to 100.</li><li id="dds_api_0082__li65665109162">If this parameter is not transferred, the first 100 records are queried by default.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0082__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0082__ul672936152018"><li id="dds_api_0082__li2729262204">Example request<p id="dds_api_0082__p85421023172013"><a name="dds_api_0082__li2729262204"></a><a name="li2729262204"></a>Get https://dds.eu-de.otc.t-systems.com/v3/056538411200d4cd2f79c003c7606412/instances/d5833c2854a4486cb7960f829269e211in02/restore-collection?db_name=mydbx&amp;restore_time=1607689584000&amp;limit=10&amp;offset=0</p>
</li></ul>
</div>
<div class="section" id="dds_api_0082__section1344184113014"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0082__ul234413411101"><li id="dds_api_0082__li203446411204">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0082__table193444411001" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0082__row1134510414018"><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_0082__p14345541801">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_0082__p934517417013">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_0082__p113453415018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0082__row17345174118015"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0082__p15345194118017">collections</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_0082__p034514111019">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_0082__p11345144117015">Indicates the list of collections. Each element in the list indicates a collection.</p>
</td>
</tr>
<tr id="dds_api_0082__row534634113012"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0082__p63466411208">total_count</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_0082__p1134619411004">Integer</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_0082__p334618411209">Indicates the total number of collections.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0082__table1034614412001" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0082__row153471041604"><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_0082__p113474414015">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_0082__p1534715411902">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_0082__p1734794119016">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0082__row834811411108"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="dds_api_0082__p1334813411709">name</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_0082__p15348741202">String</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_0082__p6348114114016">Indicates the collection name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0082__ul1034812411108"><li id="dds_api_0082__li123481141800">Response example<pre class="codeblock" id="dds_api_0082__codeblock1934816411604">{
"collections": [
"dds-test"
],
"total_count": 1
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0082__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0082__dds_api_0018_p16131712193312">Status Code:200.</p>
<p id="dds_api_0082__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_0082__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0082__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>
View Git Blame Copy Permalink