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_11_0023.html
wangdengke2 ee9f8aa0b6 taurusdb_api 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
2025-10-30 15:48:33 +00:00

380 lines
32 KiB
HTML
Raw Blame History

<a name="gaussdb_11_0023"></a><a name="gaussdb_11_0023"></a>
<h1 class="topictitle1">Querying Backups</h1>
<div id="body8662426"><div class="section" id="gaussdb_11_0023__en-us_topic_0000001251145110_section44230431101549"><h4 class="sectiontitle">Function</h4><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p1350220403353">This API is used to query backups according to search criteria. Before calling this API:</p>
<ul id="gaussdb_11_0023__en-us_topic_0000001251145110_ul924420236520"><li id="gaussdb_11_0023__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_11_0023__en-us_topic_0000001267522832_en-us_topic_0000001250985350_li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_11_0023__en-us_topic_0000001251145110_section31729879101549"><h4 class="sectiontitle">URI</h4><ul id="gaussdb_11_0023__en-us_topic_0000001251145110_ul19983374101549"><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li45632644101549">URI format<p id="gaussdb_11_0023__en-us_topic_0000001251145110_p8040618101549"><a name="gaussdb_11_0023__en-us_topic_0000001251145110_li45632644101549"></a><a name="en-us_topic_0000001251145110_li45632644101549"></a>GET https://{endpoint}/mysql/v3/{project_id}/backups?instance_id={instance_id}&amp;backup_id={backup_id}&amp;backup_type={backup_type}&amp;offset={offset}&amp;limit={limit}&amp;begin_time={begin _time}&amp;end_time={end_time}</p>
</li><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li54691335131412">URI example<p id="gaussdb_11_0023__p8831102411208"><a name="gaussdb_11_0023__en-us_topic_0000001251145110_li54691335131412"></a><a name="en-us_topic_0000001251145110_li54691335131412"></a>GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=c3ec2c6148ad4d71b1a8411a62df0d3cin07&amp;backup_id=43e4feaab48f11e89039fa163ebaa7e4br01&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</p>
</li><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li47310355101549">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001251145110_table23140016101549" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row27795795101549"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.2.2.3.1.2.5.1.1"><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p36866898101549"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b32177663564738">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.2.3.1.2.5.1.2"><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p156174610411">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.2.2.3.1.2.5.1.3"><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p33428750101549">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.2.2.3.1.2.5.1.4"><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p23374190101549"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b160254341864738">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row14261210101549"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p104922035165518">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p1956194615414">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p18047737101549">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p52580603101549">Project ID of a tenant in a region.</p>
<p id="gaussdb_11_0023__en-us_topic_0000001251145110_p16476914175718">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row197844933113"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p2153719152911">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p8572046164115">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p346994410599">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p84691144145915">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row2489615125917"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p16469194410599">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p857164618412">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p6469124415911">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p117335212295">Backup ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row1525110198591"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p1773813251016">backup_type</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p15734616412">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p12738925418">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p763172401218">Backup type. Value:</p>
<ul id="gaussdb_11_0023__en-us_topic_0000001251145110_ul363142461210"><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li14631102419125"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b9681345131518">auto</strong>: automated full backup</li><li id="gaussdb_11_0023__en-us_topic_0000001251145110_li146311124111218"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b96513542159">manual</strong>: manual full backup</li></ul>
</td>
</tr>
<tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row4676255803"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p135955121367">offset</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p95951612169">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p373812511115">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p1318733012217">Index offset. If <strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b103628945464738">offset</strong> is set to <em id="gaussdb_11_0023__en-us_topic_0000001251145110_i32232192664738">N</em>, the resource query starts from the N+1 piece of data. The value is <strong id="gaussdb_11_0023__en-us_topic_0000001251145110_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_11_0023__en-us_topic_0000001251145110_row391114581019"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p873811251313">limit</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p75794618416">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p147381257113">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p1936202713141">Number of records to be queried. The default value is <strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b17564162054914">100</strong>. The value must be a positive integer. The minimum value is <strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b7570122084913">1</strong> and the maximum value is <strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b1757192094912">100</strong>.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row57790155118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p173811251019">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p1757194617418">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p073882514117">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p15869755141419">Query start time. The format is "yyyy-mm-ddThh:mm:ssZ".</p>
<p id="gaussdb_11_0023__en-us_topic_0000001251145110_p28691955181413"><strong id="gaussdb_11_0023__b092395019127">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0023__b19929115091214">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__en-us_topic_0000001251145110_row378505943118"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.2.2.3.1.2.5.1.1 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p18469644135918">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.2.3.1.2.5.1.2 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p18662331144013">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.2.2.3.1.2.5.1.3 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p64691544165913">No</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.2.3.1.2.5.1.4 "><p id="gaussdb_11_0023__en-us_topic_0000001251145110_p20211151551516">Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time.</p>
<p id="gaussdb_11_0023__en-us_topic_0000001251145110_p15211715121514"><strong id="gaussdb_11_0023__b85665351213">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0023__b175645317123">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="gaussdb_11_0023__section1766342783315"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001181244186_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_11_0023__row26636275331"><th align="left" class="cellrowborder" valign="top" width="19.99%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_11_0023__p136632027123318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.01%" id="mcps1.3.3.2.2.5.1.2"><p id="gaussdb_11_0023__p18663122713314">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="gaussdb_11_0023__p10663112713331">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="gaussdb_11_0023__p9663127183317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__row186632278332"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0023__p196631127143316">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20.01%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0023__p6664142710332">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0023__p9664102715337">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0023__p966472710334">User token.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row13663427173312"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0023__p2664152715338">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20.01%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0023__p1966415278339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0023__p2664142783315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0023__p20664102733318">Language.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row113371333887"><td class="cellrowborder" valign="top" width="19.99%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_11_0023__p15665114311157">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20.01%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_11_0023__p36651643101518">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_11_0023__p10665443181514">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_11_0023__p1866504318159">MIME type of the request body. You are advised to use the default value <strong id="gaussdb_11_0023__b52973931674232">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0023__section1466442783316"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_11_0023__p2664142713315"><strong id="gaussdb_11_0023__b566417277339">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001181244186_response_MysqlBackupListResponse" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0023__row126651027113316"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_11_0023__p16665182773311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="gaussdb_11_0023__p366611274336">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="gaussdb_11_0023__p0666172711336">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__row156651427143317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0023__p166642715336">backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0023__p666612277336">Array of <a href="#gaussdb_11_0023__en-us_topic_0000001181244186_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_11_0023__p0666627163319">Backup information.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row14665102716331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_11_0023__p466612716334">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_11_0023__p4666527123310">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_11_0023__p13667172712330">Total number of backup files.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0023__en-us_topic_0000001181244186_response_backups"></a><a name="en-us_topic_0000001181244186_response_backups"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001181244186_response_backups" frame="border" border="1" rules="all"><caption><b>Table 4 </b>backups</caption><thead align="left"><tr id="gaussdb_11_0023__row666752733320"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_11_0023__p13667132743316">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="gaussdb_11_0023__p11667142753314">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="gaussdb_11_0023__p366862773317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__row566792723319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p366852753312">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p766832723319">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p13668112712332">Backup ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row9667727173319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p5668527113315">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p76681527173311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p1668727103311">Backup name.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row1166712275331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p15668102717333">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p186681527143318">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p531904105013">Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="gaussdb_11_0023__p13669327203310"><strong id="gaussdb_11_0023__b72211323181214">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0023__b14228223111212">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row1666702763317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p10669202718335">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p666952753314">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p29678635015">Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format.</p>
<p id="gaussdb_11_0023__p176697279333"><strong id="gaussdb_11_0023__b219762711122">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="gaussdb_11_0023__b1219822719121">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row16673272335"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p1466952715338">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p1266911272332">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p879391122016">Backup status. Value:</p>
<ul id="gaussdb_11_0023__ul167931311192015"><li id="gaussdb_11_0023__li7793121110207"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b1112910387513">BUILDING</strong>: Backup in progress</li><li id="gaussdb_11_0023__li2079351152015"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b153013401953">COMPLETED</strong>: Backup completed</li><li id="gaussdb_11_0023__li6793811122013"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b460574210518">FAILED</strong>: Backup failed</li><li id="gaussdb_11_0023__li3793131172015"><strong id="gaussdb_11_0023__en-us_topic_0000001251145110_b1433684410515">AVAILABLE</strong>: Backup available</li></ul>
</td>
</tr>
<tr id="gaussdb_11_0023__row1466722773315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p2670152763316">take_up_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p56701027103313">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p2067013275335">Backup duration in minutes.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row17667727203315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p11670102716338">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p1767022723310">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p919461732116">Backup type. Value:</p>
<ul id="gaussdb_11_0023__ul2194161716215"><li id="gaussdb_11_0023__li3194141762118"><strong id="gaussdb_11_0023__b1941838993">auto</strong>: automated full backup</li><li id="gaussdb_11_0023__li11194151719213"><strong id="gaussdb_11_0023__b1029399587">manual</strong>: manual full backup</li></ul>
</td>
</tr>
<tr id="gaussdb_11_0023__row8667427113311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p10671162716334">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p10671172723314">Double</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p1671112733318">Backup size in MB.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row16667127103315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p1667118278332">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p2671102710333"><a href="#gaussdb_11_0023__en-us_topic_0000001181244186_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_11_0023__p10671127133311">Database information.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row3667172714338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p267132716335">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p186711527123315">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p267112753315">DB instance ID.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row15667172783310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_11_0023__p13672827173315">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_11_0023__p5672142718332">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_11_0023__p186721827113311">Description of the backup file.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_11_0023__en-us_topic_0000001181244186_response_MysqlDatastore"></a><a name="en-us_topic_0000001181244186_response_MysqlDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001181244186_response_MysqlDatastore" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MysqlDatastore</caption><thead align="left"><tr id="gaussdb_11_0023__row1267214276338"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="gaussdb_11_0023__p16731275333">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="gaussdb_11_0023__p12673162793317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="gaussdb_11_0023__p7673027153318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__row66721727183318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0023__p967392716337">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0023__p1867322733310">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0023__p1467362753317">DB engine. Currently, only <strong id="gaussdb_11_0023__b90927553474232">gaussdb-mysql</strong> is supported.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row1767282753310"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="gaussdb_11_0023__p267320274335">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="gaussdb_11_0023__p06731027103312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="gaussdb_11_0023__p18673192763317">DB version.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0023__p1567414276332"><strong id="gaussdb_11_0023__b1562206017257">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__en-us_topic_0000001181244186_response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0023__row15674727103310"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="gaussdb_11_0023__p17674727163317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="gaussdb_11_0023__p1467417273331">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="gaussdb_11_0023__p5674182719338">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__row1767418278330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0023__p1674192711334">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0023__p2067462793320">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0023__p66751227173318">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row4674102783313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="gaussdb_11_0023__p126757271336">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="gaussdb_11_0023__p20675202793317">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="gaussdb_11_0023__p186751427113316">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_11_0023__p867514272338"><strong id="gaussdb_11_0023__b164571722164015">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_11_0023__table86756275330" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_11_0023__row8675162773312"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="gaussdb_11_0023__p20675102763310">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="gaussdb_11_0023__p14676327183317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="gaussdb_11_0023__p126767273332">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_11_0023__row1767592723314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_11_0023__p15676132743314">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_11_0023__p206767277337">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_11_0023__p3676102713338">Error code.</p>
</td>
</tr>
<tr id="gaussdb_11_0023__row12675142717331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="gaussdb_11_0023__p6676927143319">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="gaussdb_11_0023__p1867682715338">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="gaussdb_11_0023__p1167672773319">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_11_0023__section22615336152"><h4 class="sectiontitle">Example Request</h4><pre class="screen" id="gaussdb_11_0023__screen2234915105816">GET https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=ba62a0b83a1b42bfab275829d86ac0fdin07&amp;backup_id=c0c9f155c7b7423a9d30f0175998b63bbr01&amp;backup_type=auto&amp;offset=0&amp;limit=10&amp;begin_time=2020-07-06T10:41:14+0200&amp;end_time=2020-07-16T10:41:14+0200</pre>
</div>
<div class="section" id="gaussdb_11_0023__section18677227113311"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_11_0023__p7677142719332"><strong id="gaussdb_11_0023__b7677927173316">Status code: 200</strong></p>
<p id="gaussdb_11_0023__p14677327193311">Success.</p>
<pre class="screen" id="gaussdb_11_0023__screen17677152713337">{
"backups" : [ {
"id" : "1fe4feaab48f11e6654hfa163eba87e4b66u",
"name" : "TaurusDB-e747-20200705185048266",
"begin_time" : "2018-08-06T12:41:14+0200",
"end_time" : "2018-08-06T12:45:14+0200",
"take_up_time" : 2,
"status" : "COMPLETED",
"type" : "auto",
"size" : 2803,
"datastore" : {
"type" : "gaussdb-mysql",
"version" : "8.0"
},
"instance_id" : "43e4feaab48f11e89039fa163ebaa7e4br01"
} ],
"total_count" : 1
}</pre>
</div>
<div class="section" id="gaussdb_11_0023__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_11_0023__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_11_0023__section2557116171718"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_11_0023__p855716160178">For details, see <a href="gaussdb_10_0003.html">Error Codes</a>.</p>
</div>
<p id="gaussdb_11_0023__en-us_topic_0000001251145110_p8060118"></p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="gaussdb_11_0021.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink