Files
doc-exports/docs/taurusdb/api-ref/gaussdb_06_0003.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

291 lines
20 KiB
HTML

<a name="gaussdb_06_0003"></a><a name="gaussdb_06_0003"></a>
<h1 class="topictitle1">Creating a Manual Backup</h1>
<div id="body1595840412324"><div class="section" id="gaussdb_06_0003__section4284989"><h4 class="sectiontitle">Function</h4><p id="gaussdb_06_0003__p0506143014918">This API is used to create a manual backup. Before using this API:</p>
<ul id="gaussdb_06_0003__ul924420236520"><li id="gaussdb_06_0003__li136356359522">Learn how to <a href="gaussdb_03_0001.html">authorize and authenticate</a> it.</li><li id="gaussdb_06_0003__li1991981933613">Obtain the required <a href="gaussdb_00_0003.html">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="gaussdb_06_0003__section18530650101819"><h4 class="sectiontitle">URI</h4><p id="gaussdb_06_0003__p145319508181">POST /v3/{project_id}/backups/create</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__table18531185051811" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="gaussdb_06_0003__row4531175031810"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="gaussdb_06_0003__p1453195011814">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_0003__p1253145017186">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_0003__p1553145020188">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_0003__p25321550131816">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row45311550101816"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="gaussdb_06_0003__p253205010189">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="gaussdb_06_0003__p6532175061817">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="gaussdb_06_0003__p175322050121812">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="gaussdb_06_0003__p13201254102013">Project ID of a tenant in a region.</p>
<p id="gaussdb_06_0003__p02011854132017">To obtain this value, see <a href="gaussdb_10_0004.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_06_0003__section165321750191815"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="gaussdb_06_0003__row953225081812"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="gaussdb_06_0003__p115331450131814">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_0003__p55331350111810">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_0003__p135331850101810">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_0003__p1253395016189">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row1653205015185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_06_0003__p4533750131811">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_0003__p15533750111816">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_06_0003__p18533105010184">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_06_0003__p45331350151818">User token.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row2532165001818"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="gaussdb_06_0003__p95341650161810">X-Language</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="gaussdb_06_0003__p7534650111820">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="gaussdb_06_0003__p15341150121813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="gaussdb_06_0003__p353495012187">Language.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__request_MysqlCreateBackupRequest" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="gaussdb_06_0003__row75344505182"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="gaussdb_06_0003__p10535250181813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="gaussdb_06_0003__p453565021812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="gaussdb_06_0003__p18535155061820">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="gaussdb_06_0003__p1153513505186">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row135349507187"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="gaussdb_06_0003__p1553565019185">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="gaussdb_06_0003__p0535135061813">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="gaussdb_06_0003__p253595014180">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="gaussdb_06_0003__p1153525011817">DB instance ID, which is compliant with the UUID format.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row153435081814"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="gaussdb_06_0003__p153595019183">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="gaussdb_06_0003__p953555071818">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="gaussdb_06_0003__p1653645016188">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="gaussdb_06_0003__p6536155019186">Backup name. The value must be 4 to 64 characters in length and start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row0534150201812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="gaussdb_06_0003__p35363507186">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="gaussdb_06_0003__p053625021819">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="gaussdb_06_0003__p35361450191811">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="gaussdb_06_0003__p125361350191814">Backup description. It contains a maximum of 256 characters and cannot contain the special characters (&gt;!&lt;"&amp;'=)</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_06_0003__section153617509182"><h4 class="sectiontitle">Response Parameters</h4><p id="gaussdb_06_0003__p853625017189"><strong id="gaussdb_06_0003__b13865338332347">Status code: 201</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__response_MysqlCreateBackupResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_06_0003__row553745014188"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="gaussdb_06_0003__p1653795071819">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_0003__p1253795011182">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_0003__p353714500187">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row1253718508185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_06_0003__p16537450181817">backup</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_06_0003__p16537150201812"><a href="#gaussdb_06_0003__response_backup">backup</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_06_0003__p1553719508185">Backup information.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row65373505187"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="gaussdb_06_0003__p10538135010181">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="gaussdb_06_0003__p18538115019183">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="gaussdb_06_0003__p85381950161812">Task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="gaussdb_06_0003__response_backup"></a><a name="response_backup"></a><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__response_backup" frame="border" border="1" rules="all"><caption><b>Table 5 </b>backup</caption><thead align="left"><tr id="gaussdb_06_0003__row205382508186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="gaussdb_06_0003__p1653817502187">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_0003__p115391850141818">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_0003__p1539165015189">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row115381450141817"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p20539195051817">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p5539150151819">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p853985061815">Backup ID.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row1153818508189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p12539125017184">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p1053905041811">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p1153935019180">Backup name.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row85387500183"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p105391450141819">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p1354065018188">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p4540950111815">Backup description.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row153885091812"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p954075091816">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p145401450151812">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p105401750171811">Backup start time in the "yyyy-mm-ddThh:mm:ssZ" format, where "T" indicates the start time of the time field, and "Z" indicates the time zone offset.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row253819505186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p195401503189">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p18540195018181">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p35406500188">Backup status. Value:</p>
<ul id="gaussdb_06_0003__ul10540135091818"><li id="gaussdb_06_0003__li1854035014184"><strong id="gaussdb_06_0003__b116455442167">BUILDING</strong>: Backup in progress</li><li id="gaussdb_06_0003__li1154110501183"><strong id="gaussdb_06_0003__b20435149141611">COMPLETED</strong>: Backup completed</li><li id="gaussdb_06_0003__li754165015182"><strong id="gaussdb_06_0003__b4803218624059">FAILED</strong>: Backup failed</li><li id="gaussdb_06_0003__li8541165018189"><strong id="gaussdb_06_0003__b163771746824059">AVAILABLE</strong>: Backup available</li></ul>
<p id="gaussdb_06_0003__p1054118507188">Valid value:</p>
<ul id="gaussdb_06_0003__ul2541125091810"><li id="gaussdb_06_0003__li654175011180">BUILDING</li><li id="gaussdb_06_0003__li1354155012188">COMPLETED</li><li id="gaussdb_06_0003__li454125001811">FAILED</li><li id="gaussdb_06_0003__li105419509188">AVAILABLE</li></ul>
</td>
</tr>
<tr id="gaussdb_06_0003__row9538105031813"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p95416509182">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p1154165015185">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p20542550111819">Backup type. Value:</p>
<p id="gaussdb_06_0003__p1161603919275"><strong id="gaussdb_06_0003__b28171316172">manual</strong>: manual full backup</p>
<p id="gaussdb_06_0003__p35421350141816">Valid value:</p>
<p id="gaussdb_06_0003__p1784184318270">manual</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row15538125019187"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="gaussdb_06_0003__p12542125071811">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="gaussdb_06_0003__p4542175011813">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="gaussdb_06_0003__p1954295011815">DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_06_0003__p145421050161813"><strong id="gaussdb_06_0003__b116261926325234">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__response_MysqlErrorResponse" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_06_0003__row165425505181"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="gaussdb_06_0003__p1754495016186">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="gaussdb_06_0003__p454415503182">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="gaussdb_06_0003__p85447505181">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row1354315031815"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_06_0003__p75445505185">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_06_0003__p1254435091816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_06_0003__p1854415509184">Error code.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row155433501186"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="gaussdb_06_0003__p1154414505183">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="gaussdb_06_0003__p175441650161820">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="gaussdb_06_0003__p354511508183">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="gaussdb_06_0003__p754519501187"><strong id="gaussdb_06_0003__b454545018184">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="gaussdb_06_0003__table55451650161815" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="gaussdb_06_0003__row85451504187"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="gaussdb_06_0003__p85455503185">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="gaussdb_06_0003__p154515013188">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="gaussdb_06_0003__p1554575018183">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="gaussdb_06_0003__row954555019189"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_06_0003__p5546115010184">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_06_0003__p6546105051815">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_06_0003__p15546850151811">Error code.</p>
</td>
</tr>
<tr id="gaussdb_06_0003__row05451504181"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="gaussdb_06_0003__p155461650121814">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="gaussdb_06_0003__p1154625031816">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="gaussdb_06_0003__p11546650181815">Error message.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="gaussdb_06_0003__section11546650181814"><h4 class="sectiontitle">Example Request</h4><p id="gaussdb_06_0003__p155467505182">Creating a Manual Backup</p>
<pre class="screen" id="gaussdb_06_0003__screen25471850151812">
POST https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/backups/create
{
"instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07",
"name" : "backup-1",
"description": "Manual backup"
}</pre>
</div>
<div class="section" id="gaussdb_06_0003__section13547250131810"><h4 class="sectiontitle">Example Response</h4><p id="gaussdb_06_0003__p12547450111814"><strong id="gaussdb_06_0003__b14892713792347">Status code: 201</strong></p>
<p id="gaussdb_06_0003__p954714500187">Success.</p>
<pre class="screen" id="gaussdb_06_0003__screen11547150131818">{
"backup" : {
"id" : "2f4ddb93-b901-4b08-93d8-1d2e472f30fe",
"name" : "backup-1",
"description": "Manual backup"
"begin_time" : "2020-07-07T01:17:05+0800",
"status" : "BUILDING",
"type" : "manual",
"instance_id" : "07033b125fd94a8a96896f8bcfee6ddain07"
},
"job_id" : "e0fbbfc8-1ac4-4721-b9e9-7dd685c5bdd7"
}</pre>
</div>
<div class="section" id="gaussdb_06_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><p id="gaussdb_06_0003__p0723374409">For details, see <a href="gaussdb_10_0002.html">Status Codes</a>.</p>
</div>
<div class="section" id="gaussdb_06_0003__section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="gaussdb_06_0003__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>