vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/opengauss/api-ref/opengauss_newapi_0023.html
Ru, Li Yi d97aea4dd2 opengauss_api 
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>
2024-09-06 09:04:21 +00:00

303 lines
28 KiB
HTML
Raw Permalink Blame History

<a name="EN-US_TOPIC_0000001917290556"></a><a name="EN-US_TOPIC_0000001917290556"></a>
<h1 class="topictitle1">Querying Backups</h1>
<div id="body0000001248988026"><div class="section" id="EN-US_TOPIC_0000001917290556__section126881230154515"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290556__p1368823016451">This API is used to obtain backups of an instance. Before calling this API:</p>
<ul id="EN-US_TOPIC_0000001917290556__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290556__section56881430104513"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000001917290556__p1968863018458">This API can be used to query only manual and automated full backups.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290556__section19688203054510"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290556__ul1336835715110"><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917290556__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001917290556__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>GET https://{<em id="EN-US_TOPIC_0000001917290556__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/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="EN-US_TOPIC_0000001917290556__en-us_topic_0248254028_li4411135064210">Example<ul id="EN-US_TOPIC_0000001917290556__ul11537131295718"><li id="EN-US_TOPIC_0000001917290556__li553751218573">Querying all backups</li></ul>
<p id="EN-US_TOPIC_0000001917290556__p17640747125617">https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/backups</p>
<ul id="EN-US_TOPIC_0000001917290556__ul187950173576"><li id="EN-US_TOPIC_0000001917290556__li1879510177575">Querying instances based on search criteria</li></ul>
<p id="EN-US_TOPIC_0000001917290556__p191403445713">https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/backups?instance_id=88be33e4c5a64ceba42b42da89310111in14&amp;backup_id=88be1234c5a64ceba42b42da89310111br14&amp;backup_type=auto&amp;begin_time=2022-05-09T16:15:50+0800&amp;end_time=2022-05-09T16:20:45+0800&amp;limit=1&amp;offset=1</p>
</li><li id="EN-US_TOPIC_0000001917290556__li215312210262">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290556__table1269073004514" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290556__row66901230114510"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.3.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917290556__p1669053084516">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.3.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917290556__p1469013034513">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.3.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917290556__p166901730134510">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.3.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917290556__p15690133015453">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290556__row1126111393416"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p1357217793411">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p1157237153413">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p45721874347">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p19528455451">Project ID of a tenant in a region.</p>
<p id="EN-US_TOPIC_0000001917290556__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row96901030154515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p1869193010452">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p869133064512">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p4691430134519">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p269163004512">DB instance ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row2690930124513"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p13691133054516">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p11691230154511">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p969163024520">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p969115301455">Backup ID, which is compliant with the UUID format.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1269012300455"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p26912303458">backup_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p2691430114520">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p1769212307454">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p1382795712258">Backup type. Value:</p>
<ul id="EN-US_TOPIC_0000001917290556__ul12692193017454"><li id="EN-US_TOPIC_0000001917290556__li1169213044517"><strong id="EN-US_TOPIC_0000001917290556__b27183523410658">auto</strong>: automated full backup</li><li id="EN-US_TOPIC_0000001917290556__li116924307451"><strong id="EN-US_TOPIC_0000001917290556__b47029087310658">manual</strong>: manual full backup</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1869018309451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p2692113064512">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p1169283014510">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p106921430114518">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p3693173011451">Index offset. If <strong id="EN-US_TOPIC_0000001917290556__b1380732140102230">offset</strong> is set to <em id="EN-US_TOPIC_0000001917290556__i96928346102230">N</em>, the resource query starts from the N+1 piece of data. The default value is <strong id="EN-US_TOPIC_0000001917290556__b2020556273102230">0</strong>, indicating that the query starts from the first piece of data. The value cannot be a negative number.</p>
<p id="EN-US_TOPIC_0000001917290556__p1869314305453">Minimum value: <strong id="EN-US_TOPIC_0000001917290556__b5693193019457">0</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1469013305459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p1469323015457">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p96935308458">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p176931730124511">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p0693103012452">Number of records to be queried. The default value is <strong id="EN-US_TOPIC_0000001917290556__b51628585210658">100</strong>. The value cannot be a negative number. The minimum value is <strong id="EN-US_TOPIC_0000001917290556__b177778801810658">1</strong> and the maximum value is <strong id="EN-US_TOPIC_0000001917290556__b97590395810658">100</strong>.</p>
<p id="EN-US_TOPIC_0000001917290556__p1169383019452">Minimum value: <strong id="EN-US_TOPIC_0000001917290556__b1269303094519">1</strong></p>
<p id="EN-US_TOPIC_0000001917290556__p269313024520">Maximum value: <strong id="EN-US_TOPIC_0000001917290556__b17693153017451">100</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row8690330164510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p66933305452">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p7693183064517">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p126933308453">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p56948307453">Query start time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="EN-US_TOPIC_0000001917290556__b18205205223147">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="EN-US_TOPIC_0000001917290556__b15273302323147">Z</strong> indicates the time zone offset. This parameter must be used together with <strong id="EN-US_TOPIC_0000001917290556__b34731125171014">end_time</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1690830134514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290556__p156941730174515">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290556__p6694103004513">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.3.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290556__p469423016458">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.3.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290556__p7694193074519">Query end time. The format is "yyyy-mm-ddThh:mm:ssZ" and the end time must be later than the start time. <strong id="EN-US_TOPIC_0000001917290556__b59171857338">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="EN-US_TOPIC_0000001917290556__b1091716572316">Z</strong> indicates the time zone offset. This parameter must be used together with <strong id="EN-US_TOPIC_0000001917290556__b7595105012101">begin_time</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290556__section19694203044519"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001917290556__p1787613571341">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290556__section36961030144516"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290556__ul1614161213515"><li id="EN-US_TOPIC_0000001917290556__li146141312173512">Normal response
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290556__response_ListBackupsResponseBody" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290556__row196967302452"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290556__p1169714301453">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290556__p19697113017450">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290556__p16697130134519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290556__row176961430194518"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p56971830164513">backups</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p46971305459">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p669716304458">Backup information.</p>
<p id="EN-US_TOPIC_0000001917290556__p106289367355">For details, see <a href="#EN-US_TOPIC_0000001917290556__response_backups">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row26963302459"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p146971330204513">total_count</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p1369713013451">Long</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p14697143054516">Total number of backup files.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917290556__response_backups"></a><a name="response_backups"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290556__response_backups" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backups field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290556__row969873064515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0000001917290556__p3698203013455">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0000001917290556__p15698430114520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0000001917290556__p15698130194520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290556__row116989307451"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p17698133084511">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p56991030184511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p0699123034512">Backup ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row36987308456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p16699230164510">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p106991730194515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p116992306457">Backup name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row169873024517"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p1469973020452">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p10699830204518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p1669916308457">Description of the backup file.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row10698163084512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p969913044514">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p2699930194511">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p16699230164512">Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="EN-US_TOPIC_0000001917290556__b1041311242">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="EN-US_TOPIC_0000001917290556__b941912419">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1369816308457"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p47006304457">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p14700193004515">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p77011630154519">Backup end time in the "yyyy-mm-ddThh:mm:ssZ" format. <strong id="EN-US_TOPIC_0000001917290556__b1154523510">T</strong> is the separator between the calendar and the hourly notation of time. <strong id="EN-US_TOPIC_0000001917290556__b20159527514">Z</strong> indicates the time zone offset.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row469815309454"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p17701183044517">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p0701113016454">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p167019306457">Backup status.</p>
<p id="EN-US_TOPIC_0000001917290556__p197013309451">Value:</p>
<ul id="EN-US_TOPIC_0000001917290556__ul970123074512"><li id="EN-US_TOPIC_0000001917290556__li1670123014452"><strong id="EN-US_TOPIC_0000001917290556__b2070120308455">BUILDING</strong>: Backup in progress</li><li id="EN-US_TOPIC_0000001917290556__li270113307451"><strong id="EN-US_TOPIC_0000001917290556__b9701193094514">COMPLETED</strong>: Backup completed</li><li id="EN-US_TOPIC_0000001917290556__li670143013451"><strong id="EN-US_TOPIC_0000001917290556__b1970153020459">FAILED</strong>: Backup failed</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1669873044514"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p4701193024516">size</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p157017304459">Double</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p870283018452">Backup size in MB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row3698630124512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p27024306451">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p2070210307452">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p1370203013454">Backup type.</p>
<p id="EN-US_TOPIC_0000001917290556__p0702163044511">Value:</p>
<ul id="EN-US_TOPIC_0000001917290556__ul97025306457"><li id="EN-US_TOPIC_0000001917290556__li77021730194511"><strong id="EN-US_TOPIC_0000001917290556__b194848823910658">auto</strong>: automated full backup</li><li id="EN-US_TOPIC_0000001917290556__li970213019455"><strong id="EN-US_TOPIC_0000001917290556__b18702183016457">manual</strong>: manual full backup</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row126982305453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p1670213306455">datastore</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p187288596377">Object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p47021630154516">Database information.</p>
<p id="EN-US_TOPIC_0000001917290556__p7692636113910">For details, see <a href="#EN-US_TOPIC_0000001917290556__response_OpenGaussDatastore">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row1669863013453"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p7703330114516">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p107031930104512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p8703133013453">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917290556__response_OpenGaussDatastore"></a><a name="response_OpenGaussDatastore"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290556__response_OpenGaussDatastore" frame="border" border="1" rules="all"><caption><b>Table 4 </b>datastore field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290556__row0703133016459"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0000001917290556__p0703203011457">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0000001917290556__p970353084516">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0000001917290556__p1070423014510">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001917290556__row20703123074511"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p1704143014457">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p3704430144518">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p18704430154520">DB engine. The value is case-insensitive and can be:</p>
<p id="EN-US_TOPIC_0000001917290556__p16704530104511"><span id="EN-US_TOPIC_0000001917290556__text12277154912284">GaussDB</span>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001917290556__row15703113012456"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290556__p670417306452">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290556__p1270423034512">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290556__p770423034515">DB engine version. If this parameter is not specified, the latest version is used by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001917290556__ul1215030986"><li id="EN-US_TOPIC_0000001917290556__li12150190283">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917290556__codeblock2089012231757">{
"backups": [
{
"id": "a696cd25e4fc453aa503650225cece8bbr14",
"name": "<span id="EN-US_TOPIC_0000001917290556__text261472736">GaussDB</span>-hly-ha-20220509080110906",
"description": null,
"status": "FAILED",
"size": 0.0,
"type": "auto",
"datastore": {
"type": "<span id="EN-US_TOPIC_0000001917290556__text1216852860">GaussDB</span>",
"version": "1.4"
},
"begin_time": "2022-05-09T16:01:10+0800",
"end_time": "2022-05-09T16:04:31+0800",
"instance_id": "164abc6d35114095bb849d007b19db3bin14"
},
{
"id": "5651c62a7f12461c98020dd3abfe24ccbr14",
"name": "<span id="EN-US_TOPIC_0000001917290556__text1071736334">GaussDB</span>-hly-master-20220509022658257",
"description": null,
"status": "FAILED",
"size": 0.0,
"type": "auto",
"datastore": {
"type": "<span id="EN-US_TOPIC_0000001917290556__text670979031">GaussDB</span>",
"version": "1.4"
},
"begin_time": "2022-05-09T10:26:58+0800",
"end_time": "2022-05-09T10:30:17+0800",
"instance_id": "fd26e3bf26e5467587eec857e4f66ef0in14"
}
],
"total_count": 167
}</pre>
</li></ul>
<ul id="EN-US_TOPIC_0000001917290556__ul15104171101812"><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0128427215_li15857509162">Abnormal response<p id="EN-US_TOPIC_0000001917290556__en-us_topic_0000001655675456_en-us_topic_0128427214_p172314336131"><a name="EN-US_TOPIC_0000001917290556__en-us_topic_0128427215_li15857509162"></a><a name="en-us_topic_0128427215_li15857509162"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290556__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
</li><li id="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290556__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0000001917290556__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290556__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0025.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink