forked from docs/doc-exports
wangdengke2
8d0926f0e5
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>
163 lines
12 KiB
HTML
163 lines
12 KiB
HTML
<a name="nosql_api_0032"></a><a name="nosql_api_0032"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Manual Backup</h1>
|
|
<div id="body0000001409030149"><div class="section" id="nosql_api_0032__section236251215256"><h4 class="sectiontitle">Function</h4><p id="nosql_api_0032__p104874125253">This API is used to create a manual backup.</p>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section1148013134418"><h4 class="sectiontitle">Constraints</h4><p id="nosql_api_0032__p890316349410">This API supports the following instance type:</p>
|
|
<ul id="nosql_api_0032__ul34403331744"><li id="nosql_api_0032__li39031534646"><span id="nosql_api_0032__text1890343413410">GeminiDB Cassandra</span></li></ul>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section43653122250"><h4 class="sectiontitle">URI</h4><p id="nosql_api_0032__p124875129254">POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0032__table1236791214255" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="nosql_api_0032__row164876121256"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="nosql_api_0032__p148716122253">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="nosql_api_0032__p748711252514">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="nosql_api_0032__p17487181217250">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="nosql_api_0032__p19487131212256">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_api_0032__row548761211253"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_api_0032__p1748771210254">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_api_0032__p1048720124252">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_api_0032__p19487101282518">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_api_0032__p1848731217254">Project ID of a user in a region. To obtain this value, see <a href="nosql_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_api_0032__row2487131216257"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="nosql_api_0032__p3487141232511">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="nosql_api_0032__p0487131219253">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="nosql_api_0032__p74871812142513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="nosql_api_0032__p194871912192516">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section143831912162511"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0032__table438451212254" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="nosql_api_0032__nosql_06_0002_row12368317383"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="nosql_api_0032__nosql_06_0002_p936941712818">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="nosql_api_0032__nosql_06_0002_p2369717883">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="nosql_api_0032__nosql_06_0002_p93709171881">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="nosql_api_0032__nosql_06_0002_p1937018171381">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_api_0032__nosql_06_0002_row1896919103549"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_api_0032__nosql_06_0002_p047832135015">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_api_0032__nosql_06_0002_p34785216504">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_api_0032__nosql_06_0002_p082192665218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_api_0032__nosql_06_0002_en-us_topic_0121682347_p1486815116337">MIME type of the request body. <strong id="nosql_api_0032__nosql_06_0002_b1528010571035">application/json</strong> is recommended.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_api_0032__nosql_06_0002_row163681217987"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="nosql_api_0032__nosql_06_0002_p1937017171284">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="nosql_api_0032__nosql_06_0002_p15371517489">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="nosql_api_0032__nosql_06_0002_p1437119171810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="nosql_api_0032__nosql_06_0002_p1237131714819">User token.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0032__table8389512192513" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="nosql_api_0032__row248811123251"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.1"><p id="nosql_api_0032__p548861252515">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.2"><p id="nosql_api_0032__p14488121215255">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.5.1.3"><p id="nosql_api_0032__p54881012202518">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.3.2.5.1.4"><p id="nosql_api_0032__p174881112142513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_api_0032__row20488181292515"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_api_0032__p13488111216253">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_api_0032__p16488151252510">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_api_0032__p948915127251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_api_0032__p2489151252510">Manual backup name.</p>
|
|
<p id="nosql_api_0032__p6489171216259">The name can include 4 to 64 characters and must start with a letter. It is case-sensitive and can contain only letters, digits, hyphens (-), and underscores (_).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_api_0032__row10489131213256"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.1 "><p id="nosql_api_0032__p12489161262518">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.2 "><p id="nosql_api_0032__p15489191222517">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.5.1.3 "><p id="nosql_api_0032__p4489111211251">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.3.2.5.1.4 "><p id="nosql_api_0032__p348941216258">Manual backup description.</p>
|
|
<p id="nosql_api_0032__p1048911123253">The description can include a maximum of 256 characters and cannot contain the following special characters: >!<"&'=</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section18397212162519"><h4 class="sectiontitle">Response Parameters</h4><p id="nosql_api_0032__p1648921272519"><strong id="nosql_api_0032__b86031842124514">Status code: 202</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="nosql_api_0032__table93981012182513" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="nosql_api_0032__row3489141217255"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.3.2.4.1.1"><p id="nosql_api_0032__p1848941282519">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.5.3.2.4.1.2"><p id="nosql_api_0032__p64895127259">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="nosql_api_0032__p15489912192511">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="nosql_api_0032__row2048981219256"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_api_0032__p1848941213255">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_api_0032__p144896120255">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_api_0032__p194891712192519">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="nosql_api_0032__row948951222510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.3.2.4.1.1 "><p id="nosql_api_0032__p1448911252518">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.5.3.2.4.1.2 "><p id="nosql_api_0032__p154901412132513">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="nosql_api_0032__p144901012172519">Backup ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section640417129257"><h4 class="sectiontitle">Example Request</h4><ul id="nosql_api_0032__ul16894796285"><li id="nosql_api_0032__li08941596286">URI example<pre class="screen" id="nosql_api_0032__screen9191139162918">POST https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/backups </pre>
|
|
</li><li id="nosql_api_0032__li119031955202817">Creating a manual backup<pre class="screen" id="nosql_api_0032__screen5490101292513">{
|
|
"name" : "backup-4f57",
|
|
"description" : "manual backup"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section1440811126252"><h4 class="sectiontitle">Example Response</h4><p id="nosql_api_0032__p54902125255"><strong id="nosql_api_0032__b10523204518457">Status code: 202</strong></p>
|
|
<p id="nosql_api_0032__p3490312172512">Success</p>
|
|
<pre class="screen" id="nosql_api_0032__screen10490512192512">{
|
|
"job_id" : "8061ceaf-b319-4315-9338-7f3de8e26f05",
|
|
"backup_id" : "646d88d0b03f4fd2ae944ae2a33bcb6ain06"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section19107202213585"><h4 class="sectiontitle">Status Codes</h4><p id="nosql_api_0032__en-us_topic_0000001354223196_p201216122353">See <a href="nosql_status_code.html">Status Codes</a>.</p>
|
|
</div>
|
|
<div class="section" id="nosql_api_0032__section21121922155813"><h4 class="sectiontitle">Error Codes</h4><p id="nosql_api_0032__en-us_topic_0000001354223196_p1265915205719">See <a href="nosql_error_code.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000003.html">Backups and Restorations</a></div>
|
|
</div>
|
|
</div>
|
|
|