forked from docs/doc-exports
Ru, Li Yi
108b794fed
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>
276 lines
22 KiB
HTML
276 lines
22 KiB
HTML
<a name="dds_api_0029"></a><a name="dds_api_0029"></a>
|
|
|
|
<h1 class="topictitle1">Querying the Backup List</h1>
|
|
<div id="body1470378083917"><div class="section" id="dds_api_0029__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0029__p3631239417316">This API is used to query backups based on specified conditions.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0029__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0029__ul3084351717316"><li id="dds_api_0029__li915620217316">URI format<p id="dds_api_0029__p2567371617050"><a name="dds_api_0029__li915620217316"></a><a name="li915620217316"></a>GET https://{Endpoint}/v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}&mode={mode}</p>
|
|
</li><li id="dds_api_0029__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0029__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0029__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.6%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0029__p34889605">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0029__p7485743">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.150000000000006%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0029__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0029__row57385070"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row2864326155157"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p10737742155220">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p64450739155220">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_0029__row116836431146"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p15683443151415">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p1568316439148">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p116832437149">Specifies the backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row93931049203017"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p840844912305">backup_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p134086490304">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p1165494613813">Specifies the backup type.</p>
|
|
<ul id="dds_api_0029__ul189282231193"><li id="dds_api_0029__li88283251911"><strong id="dds_api_0029__b1728141861314">Auto</strong>: indicates automated full backup.</li><li id="dds_api_0029__li344972812913"><strong id="dds_api_0029__b1496494301314">Manual</strong> indicates manual full backup.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row115851253324"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p7585625113212">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p14241079113">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p68771249161712">Specifies the index position. The query starts from the next instance creation time indexed by this parameter under a specified project. If offset is set to N, the resource query starts from the N+1 piece of data.</p>
|
|
<p id="dds_api_0029__p164514316252">The value must be greater than or equal to <strong id="dds_api_0029__b18725195618144">0</strong>. If this parameter is not transferred, offset is set to <strong id="dds_api_0029__b89541508156">0</strong> by default, indicating that the query starts from the latest created DB instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row16990146131215"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p139904468126">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p4990946181217">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p16281630205219">Specifies the maximum allowed number of backups to be queried.</p>
|
|
<p id="dds_api_0029__p15258114142818">The value ranges from 1 to 100. If this parameter is not transferred, the first 100 DB instances are queried by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row820715219196"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p1250401361914">begin_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p5426101961917">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p1942671971913">Specifies the start time of the query. The format is <strong id="dds_api_0029__b1513763517211">yyyy-mm-dd hh:mm:ss</strong>. The value is in UTC format.</p>
|
|
<div class="note" id="dds_api_0029__note1546714962017"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0029__p9467189102011">When <strong id="dds_api_0029__b84235270693530">end_time</strong> is not empty, <strong id="dds_api_0029__b84235270693547">begin_time</strong> is mandatory.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row659875021813"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p1050431341917">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p14262196190">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p1542651981915">Specifies the end time of the query. The format is "yyyy-mm-dd hh:mm:ss". The value is in UTC format.</p>
|
|
<div class="note" id="dds_api_0029__note10667645111414"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dds_api_0029__p14667845141419">When <strong id="dds_api_0029__b1080410805">begin_time</strong> is not empty, <strong id="dds_api_0029__b293981368">end_time</strong> is mandatory.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row81718152376"><td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0029__p0517622143711">mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0029__p75171221377">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.150000000000006%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0029__p1651762216375">Specifies the DB instance mode.</p>
|
|
<p id="dds_api_0029__p13109191614434">Valid value:</p>
|
|
<ul id="dds_api_0029__ul81041227194312"><li id="dds_api_0029__li510432718434">Sharding</li><li id="dds_api_0029__li18104102719439">ReplicaSet</li><li id="dds_api_0029__li110552717434">Single</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0029__section43121332947"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0029__ul1268219198117"><li id="dds_api_0029__li196839191810">Example request<p id="dds_api_0029__p134457231213"><a name="dds_api_0029__li196839191810"></a><a name="li196839191810"></a>GET https://dds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c0c9f155c7b7423a9d30f0175998b63bin01&offset=0&limit=10&begin_time=2018-08-06 10:41:14&end_time=2018-08-16 10:41:14</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0029__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0029__ul12573920"><li id="dds_api_0029__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0029__table11854613" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0029__row48728718"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0029__p54712068">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0029__p2492560">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0029__p1775051517420">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0029__row46232835"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0029__p53872188">backups</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0029__p1709311145416">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0029__p4491214">Indicates the backup list. For more information, see <a href="#dds_api_0029__table52869820">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row1115175204712"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0029__p611517554719">total_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0029__p2756199134714">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0029__p1011512524711">Indicates the total number of queried records.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0029__table52869820"></a><a name="table52869820"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0029__table52869820" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backups field data structure description</caption><thead align="left"><tr id="dds_api_0029__row50931783"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0029__p31833731">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0029__p28395444">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0029__p1371413186414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0029__row8307988"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p127914503011">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p027913523010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p172799513012">Indicates the backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row938736142915"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p92797519305">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p52796523018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p72791658307">Indicates the backup name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row127211224164720"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p62796513300">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p10279255302">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p827914583018">Indicates the ID of the DB instance from which the backup was created. You can obtain the ID by calling the API for querying DB 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_0029__row971173424719"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p490524414474">instance_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p29051544154717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p209053449470">Indicates the name of the DB instance for which the backup is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row6347181713495"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p7348151764915">datastore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p1116113295411">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p5348141711498">Indicates the database version. For more information, see <a href="#dds_api_0029__table1313585821318">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row144491595298"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p4279155173020">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p11279125203010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p19151125810483">Indicates the backup type.</p>
|
|
<ul id="dds_api_0029__ul1115185812489"><li id="dds_api_0029__li151531358134810"><strong id="dds_api_0029__b1901186509">Auto</strong>: indicates automated full backup.</li><li id="dds_api_0029__li815610584487"><strong id="dds_api_0029__b03859588419">Manual</strong> indicates manual full backup.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row168721916122920"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p527917513306">begin_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p1527919573018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p727911543019">Indicates the backup start time. The format of the start time is <strong id="dds_api_0029__b2733501443">yyyy-mm-dd hh:mm:ss</strong>. The value is in UTC format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row1938722120299"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p1227912514309">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p627916517309">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p2027975153016">Indicates the backup end time. The format of the end time is <strong id="dds_api_0029__b1287013202410">yyyy-mm-dd hh:mm:ss</strong>. The value is in UTC format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row11137171415500"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p0266111913505">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p17269141916503">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p17271141965018">Indicates the backup status. Valid value:</p>
|
|
<ul id="dds_api_0029__ul56764245010"><li id="dds_api_0029__li1867154255015">BUILDING: Backup in progress</li><li id="dds_api_0029__li116716428508">COMPLETED: Backup completed</li><li id="dds_api_0029__li16675425503">FAILED: Backup failed</li><li id="dds_api_0029__li2676427508">DISABLED: Backup being deleted</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row27033171511"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p5118424195115">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p151213249518">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p7124162412513">Indicates the backup size in KB.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row15919185905215"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0029__p17941151435310">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0029__p1494111147539">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0029__p169413149535">Indicates the backup description.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0029__table1313585821318"></a><a name="table1313585821318"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0029__table1313585821318" frame="border" border="1" rules="all"><caption><b>Table 4 </b>datastore field data structure description</caption><thead align="left"><tr id="dds_api_0029__row713725891315"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0029__p1237992741419"><strong id="dds_api_0029__b197782325217">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0029__p153799270147">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0029__p84634231148">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0029__row11371558111320"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0029__p854819191411">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0029__p145511192148">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0029__p145546921412">Indicates the DB engine.</p>
|
|
<p id="dds_api_0029__p17556209171412">Valid value: <strong id="dds_api_0029__b5665132172519">DDS-Community</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0029__row26286119148"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="dds_api_0029__p1855916912149">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0029__p1656114951410">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0029__p125691591144">Indicates the database of version 3.4, 4.0, 4.2, or 4.4. The value is <strong id="dds_api_0029__b023384751015">3.4</strong>, <strong id="dds_api_0029__b4673163032710">4.0</strong>, <strong id="dds_api_0029__b996614223148">4.2</strong>, or <strong id="dds_api_0029__b12233124771012">4.4</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0029__ul16665627"><li id="dds_api_0029__li15772917">Response example<pre class="codeblock" id="dds_api_0029__codeblock314170531760">{
|
|
"backups": [
|
|
{
|
|
"id": "43e4feaab48f11e89039fa163ebaa7e4br01",
|
|
"name": "backup-test",
|
|
"instance_id": "43e4feaab48f11e89039fa163ebaa7e4br01",
|
|
"instance_name": "cluster-test",
|
|
"datastore" : {
|
|
"type" : "DDS-Community",
|
|
"version" : "4.0"
|
|
},
|
|
"type": "auto",
|
|
"begin_time": "2018-08-06 12:41:14",
|
|
"end_time": "2018-08-06 12:43:14",
|
|
"status": "COMPLETED",
|
|
"size": 2803,
|
|
"description": "backup description"
|
|
}
|
|
],
|
|
"total_count":1
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0029__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0029__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0029__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_0029__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0029__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>
|
|
|