yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
a41a4e0331fbc0beff63bb28fa59228cc9a751df
doc-exports/docs/taurusdb/api-ref/gaussdb_06_0004.html
wangdengke2 1aae9268b0 taurusdb_api 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-06-17 09:00:31 +00:00

384 lines
28 KiB
HTML
Raw Blame History

<a name="gaussdb_06_0004"></a><a name="gaussdb_06_0004"></a>
<h1 class="topictitle1">Querying Backups</h1>
<div id="body1595840412324"><div class="section" id="gaussdb_06_0004__section44230431101549"><h4 class="sectiontitle">Function</h4><p id="gaussdb_06_0004__p1350220403353">This API is used to query backups according to search criteria. Before using this API:</p>
<ul id="gaussdb_06_0004__ul924420236520"><li id="gaussdb_06_0004__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_06_0004__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_06_0004__section5851175031813"><h4 class="sectiontitle">URI</h4><p id="gaussdb_06_0004__p17851185018183">GET /v3/{project_id}/backups</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__table13853650161811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="gaussdb_06_0004__row16852185051817"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="gaussdb_06_0004__p1385315041812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="gaussdb_06_0004__p385325061818">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="gaussdb_06_0004__p16853175016182">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="gaussdb_06_0004__p185385020183">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row1285219508186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_06_0004__p168535501186">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_06_0004__p1685310509184">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_06_0004__p985415501188">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_06_0004__p15291141622316">Project ID of a tenant in a region.</p>
<p id="gaussdb_06_0004__p142913166239">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__table19855105001814" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="gaussdb_06_0004__row38541550111815"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="gaussdb_06_0004__p19855175081816">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="gaussdb_06_0004__p6855250121820">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="gaussdb_06_0004__p9855195010183">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="gaussdb_06_0004__p188559504180">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row118541750111817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p18855115041817">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p1685505019186">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p1785655061812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p8856165021813">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row3854550131814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p1785695011184">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p158562507183">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p128561150121818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p0856185051814">Backup ID.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row15854185011812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p4856185031812">backup_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p1085725001812">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p88571850201817">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p1651493115">Backup type. Value: </p>
<p id="gaussdb_06_0004__p1312122814118"><strong id="gaussdb_06_0004__b16121528918">auto</strong>: automated full backup </p>
<p id="gaussdb_06_0004__p86691525418"><strong id="gaussdb_06_0004__b26151941518">manual</strong>: manual full backup</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row28546500185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p38571850171817">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p12857135018185">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p148571850121818">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p11857150171811">Index offset. If <strong id="gaussdb_06_0004__b103628945464738">offset</strong> is set to <em id="gaussdb_06_0004__i32232192664738">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="gaussdb_06_0004__b157152991264738">0</strong> by default, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row2854205011816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p0858155014188">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p9858150161817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p385885011815">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p16858150141813">Number of records to be queried. The default value is <strong id="gaussdb_06_0004__b17564162054914">100</strong>. The value must be a positive integer. The minimum value is <strong id="gaussdb_06_0004__b7570122084913">1</strong> and the maximum value is <strong id="gaussdb_06_0004__b1757192094912">100</strong>.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row188541850111812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p385813507189">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p12858175071811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p185811506183">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p158597507185">Query start time. The format is "yyyy-mm-ddThh:mm:ssZ". <strong id="gaussdb_06_0004__b1354432331613">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_06_0004__b155511223201618">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row158541750181815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="gaussdb_06_0004__p168593501183">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="gaussdb_06_0004__p6859185021817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="gaussdb_06_0004__p0859145021813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="gaussdb_06_0004__p19859175016180">Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. <strong id="gaussdb_06_0004__b1583492681613">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_06_0004__b11834102631612">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_06_0004__section785925021810"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_06_0004__row1860125081816"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_06_0004__p1986025015182">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_06_0004__p386035015185">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_06_0004__p1086075011810">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_06_0004__p1086145061814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row19860550111813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_06_0004__p88611950111813">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_06_0004__p17861195017188">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_06_0004__p1486115019182">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_06_0004__p6861155015182">User token.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row686055011185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_06_0004__p5861125031819">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_06_0004__p78611550131815">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_06_0004__p3862150191815">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_06_0004__p886295021820">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_06_0004__section2862195010181"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_06_0004__p2862185019185"><strong id="gaussdb_06_0004__b146022827125043">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__response_MysqlBackupListResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_06_0004__row11862145017188"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_06_0004__p9863145019186">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_06_0004__p586355017183">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_06_0004__p1986385011813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row1086285021819"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_06_0004__p2863650191817">backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_06_0004__p12863125013180">Array of <a href="#gaussdb_06_0004__response_backups">backups</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_06_0004__p1886485014189">Backup information.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row148627504188"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_06_0004__p13864155011187">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_06_0004__p16864135013184">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_06_0004__p1864135011816">Total number of backup files.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_06_0004__response_backups"></a><a name="response_backups"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__response_backups" frame="border" border="1" rules="all"><caption><b>Table 5 </b>backups</caption><thead align="left"><tr id="gaussdb_06_0004__row8864125013189"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_06_0004__p128656501186">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_06_0004__p18650506189">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_06_0004__p586555012186">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row68647504186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p4865205041817">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p1486619502189">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p1286615018181">Backup ID.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row12864750101813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p3866175016188">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p786618501183">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p5866165071814">Backup name.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row1486445011180"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p08661650161815">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p286611502189">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p386712507182">Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="gaussdb_06_0004__b1017911289167">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_06_0004__b718062818165">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row4864165031810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p17867185016183">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p1186714507184">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p1086714501180">Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="gaussdb_06_0004__b8439629151613">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_06_0004__b94401729161618">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row118656507182"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p58671503189">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p386745016188">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p4868195021811">Backup status. Value:</p>
<ul id="gaussdb_06_0004__ul5868125020188"><li id="gaussdb_06_0004__li38681050121814"><strong id="gaussdb_06_0004__b1159912413189">BUILDING</strong>: Backup in progress</li><li id="gaussdb_06_0004__li18681750151815"><strong id="gaussdb_06_0004__b828319621814">COMPLETED</strong>: Backup completed</li><li id="gaussdb_06_0004__li586815507187"><strong id="gaussdb_06_0004__b69472067723941">FAILED</strong>: Backup failed</li><li id="gaussdb_06_0004__li108681450161810"><strong id="gaussdb_06_0004__b36774674423941">AVAILABLE</strong>: Backup available</li></ul>
<p id="gaussdb_06_0004__p0868135020185">Valid value:</p>
<ul id="gaussdb_06_0004__ul11868750201810"><li id="gaussdb_06_0004__li1868250151812">BUILDING</li><li id="gaussdb_06_0004__li28681050141816">COMPLETED</li><li id="gaussdb_06_0004__li1086985011813">FAILED</li><li id="gaussdb_06_0004__li1086975010186">AVAILABLE</li></ul>
</td>
</tr>
<tr id="gaussdb_06_0004__row3865185016185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p1869185020189">take_up_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p686915501185">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p17869195013187">Backup duration in minutes.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row4865145018183"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p12869350111817">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p186935012183">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p14870750121816">Backup type. Value:</p>
<ul id="gaussdb_06_0004__ul158701050161815"><li id="gaussdb_06_0004__li12870165081818"><strong id="gaussdb_06_0004__b6262912323941">auto</strong>: automated full backup</li><li id="gaussdb_06_0004__li4870175013187"><strong id="gaussdb_06_0004__b1320081816183">manual</strong>: manual full backup</li></ul>
<p id="gaussdb_06_0004__p158701650131811">Valid value:</p>
<ul id="gaussdb_06_0004__ul98702500181"><li id="gaussdb_06_0004__li0870115011185">auto</li><li id="gaussdb_06_0004__li178709500182">manual</li></ul>
</td>
</tr>
<tr id="gaussdb_06_0004__row186555081818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p1587115012188">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p887116507183">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p14871165018182">Backup size in MB.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row78653509186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p2871350161813">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p1387115504189"><a href="#gaussdb_06_0004__response_MysqlDatastore">MysqlDatastore</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p14871115081814">Database information.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row1486515015185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p0871350121815">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p15872115019187">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p11872165021812">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row18651150181814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0004__p1687365011817">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0004__p5874150141814">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0004__p587495051816">Description of the backup file.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_06_0004__response_MysqlDatastore"></a><a name="response_MysqlDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__response_MysqlDatastore" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MysqlDatastore</caption><thead align="left"><tr id="gaussdb_06_0004__row168746501181"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_06_0004__p7874165091810">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="gaussdb_06_0004__p138751650101813">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="gaussdb_06_0004__p17875450101812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row15874105014185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_06_0004__p3875105001819">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_06_0004__p10875105021819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_06_0004__p887519509181">DB engine. Currently, only gaussdb-mysql is supported.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row1787415011812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_06_0004__p487516504186">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_06_0004__p187555018181">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_06_0004__p13876150131813">DB version.</p>
<p id="gaussdb_06_0004__p1587685011818">To obtain details about supported DB engine versions, call the API for querying the DB engine versions.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_06_0004__p1287635031817"><strong id="gaussdb_06_0004__b30194680425235">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_06_0004__row98761150101818"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_06_0004__p1387714504185">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="gaussdb_06_0004__p138771750191818">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="gaussdb_06_0004__p5877135011813">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row138769502182"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_06_0004__p287765061810">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_06_0004__p1487775021812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_06_0004__p16877135071812">Error code.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row19876650171818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_06_0004__p38783504185">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_06_0004__p3878205012185">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_06_0004__p187885010186">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_06_0004__p10878950151815"><strong id="gaussdb_06_0004__b287825012187">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0004__table12878205011187" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_06_0004__row787816509188"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_06_0004__p1487985015187">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="gaussdb_06_0004__p1087911504188">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="gaussdb_06_0004__p11879165001818">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0004__row1878105019186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_06_0004__p1879650141812">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_06_0004__p10879165016186">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_06_0004__p1487911502180">Error code.</p>
</td>
</tr>
<tr id="gaussdb_06_0004__row78787501180"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_06_0004__p1988095001819">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_06_0004__p17880145016181">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_06_0004__p088095016182">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_06_0004__section0880350111814"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_06_0004__screen3319512141820">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=43e4feaab48f11e89039fa163ebaa7e4br01&amp;backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&amp;backup_type=auto&amp;offset=0&amp;limit=10&amp;begin_time=2020-07-06T10:41:14+0800&amp;end_time=2020-07-16T10:41:14+0800</pre>
</div>
<div class="section" id="gaussdb_06_0004__section13881150171810"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_06_0004__p108821508184"><strong id="gaussdb_06_0004__b41082943325043">Status code: 200</strong></p>
<div class="p" id="gaussdb_06_0004__p988205041812">Success.<pre class="screen" id="gaussdb_06_0004__screen9882135051810">{
"backups" : [ {
"id" : "c0c9f155c7b7423a9d30f0175998b63bbr01",
"name" : "TaurusDB-e747-20200705185048266",
"begin_time" : "2020-07-06T10:41:14+0800",
"end_time" : "2020-07-16T10:41:14+0800",
"take_up_time" : 2,
"status" : "COMPLETED",
"type" : "auto",
"size" : 2803,
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0"
},
"instance_id" : "c0c9f155c7b7423a9d30f0175998b63bbr01"
} ],
"total_count" : 1
}</pre>
</div>
</div>
<div class="section" id="gaussdb_06_0004__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_06_0004__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_06_0004__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_06_0004__p19357163913406">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_06_0002.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink