vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dds/api-ref/dds_api_0027.html
Wang , Deng Ke 60010eb9d0 dds api 2.0.38sp24 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2023-01-13 08:55:41 +00:00

152 lines
11 KiB
HTML
Raw Permalink Blame History

<a name="dds_api_0027"></a><a name="dds_api_0027"></a>
<h1 class="topictitle1">Creating a Manual Backup</h1>
<div id="body1473065823225"><div class="section" id="dds_api_0027__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0027__p3631239417316">This API is used to create a manual backup for a DB instance.</p>
</div>
<div class="section" id="dds_api_0027__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0027__ul3084351717316"><li id="dds_api_0027__li915620217316">URI format<p id="dds_api_0027__p13437820155411"><a name="dds_api_0027__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/backups</p>
</li><li id="dds_api_0027__li21405046">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0027__table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0027__row1482002"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0027__p52933326">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0027__p59740974">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.545454545454554%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0027__p2775334615440">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0027__row44765691"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0027__p512115502311">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0027__p39316155">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="54.545454545454554%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0027__p40188499163133">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0027__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0027__ul15508938183316"><li id="dds_api_0027__li31421758183316">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0027__table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0027__row61525259"><th align="left" class="cellrowborder" valign="top" width="20.3%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dds_api_0027__p17490046">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.75%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dds_api_0027__p7407659">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.95%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dds_api_0027__p63149496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dds_api_0027__p681212491039">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0027__row60827539"><td class="cellrowborder" valign="top" width="20.3%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_0027__p28083633">backup</p>
</td>
<td class="cellrowborder" valign="top" width="25.75%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_0027__p60181840">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="28.95%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_0027__p10432111445315">Object</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_0027__p1935815385512">Specifies the backup parameter objects For more information, see <a href="#dds_api_0027__table35260043174853">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dds_api_0027__table35260043174853"></a><a name="table35260043174853"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0027__table35260043174853" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backup field data structure description</caption><thead align="left"><tr id="dds_api_0027__row29173707174853"><th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="dds_api_0027__p14260042174853">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="27.26%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="dds_api_0027__p14212742174853">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="dds_api_0027__p10381414174853">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="dds_api_0027__p567365314318">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0027__row2025019820560"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0027__p1161524185615">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="27.26%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0027__p1162424145615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0027__p176252485617">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0027__p1613774381112">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
</td>
</tr>
<tr id="dds_api_0027__row1261319148573"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0027__p1245962585719">name</p>
</td>
<td class="cellrowborder" valign="top" width="27.26%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0027__p945962595717">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0027__p1545992513578">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0027__p157412071584">Specifies the manual backup name.</p>
<p id="dds_api_0027__p879010401672">The value must be 4 to 64 characters in length and start with a letter (from A to Z or from a to z). It is case-sensitive and can contain only letters, digits (from 0 to 9), hyphens (-), and underscores (_).</p>
<div class="caution" id="dds_api_0027__note38311931164614"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="dds_api_0027__p168320313469">Name of the Backup has to be unique among all other backups on Project.</p>
</div></div>
</td>
</tr>
<tr id="dds_api_0027__row64070195174853"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0027__p22303345174853">description</p>
</td>
<td class="cellrowborder" valign="top" width="27.26%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="dds_api_0027__p61740531174853">No</p>
</td>
<td class="cellrowborder" valign="top" width="28.000000000000004%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0027__p34927138174853">String</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0027__p1454814446586">Specifies the manual backup description.</p>
<p id="dds_api_0027__p2013512361589">The description must consist of a maximum of 256 characters and cannot contain the following special characters: &gt;!&lt;"&amp;'=</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0027__ul10190321"><li id="dds_api_0027__li24604028">Example request<div class="p" id="dds_api_0027__p86210518312"><a name="dds_api_0027__li24604028"></a><a name="li24604028"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/backups<pre class="codeblock" id="dds_api_0027__codeblock1830517314">{
"backup":{
"instance_id": "a89dab5e39394eccbdb77b19d57b0180in02",
"name": "mybackup1",
"description": "The first Manual backup"
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0027__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0027__ul51626053183341"><li id="dds_api_0027__li7845712183341">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0027__table30427456" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0027__row47542385"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0027__p25727981">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.980000000000004%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0027__p3591713">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0027__p1527375818313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0027__row65226014010"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0027__p145228017020">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0027__p152250501">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0027__p195221001304">The ID of the asynchronous manual backup task.</p>
</td>
</tr>
<tr id="dds_api_0027__row10023380"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0027__p6587426">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0027__p63819464">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0027__p17946858">Manual backup ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0027__ul1226458173158"><li id="dds_api_0027__li11038126173158">Response example<pre class="codeblock" id="dds_api_0027__codeblock126635241585">{
"job_id": "a03b1b8a-b756-467c-8a49-38720c3d23ec",
"backup_id": "bf9ee62a7f7044c583c6765c916c36edbr02"
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0027__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0027__dds_api_0018_p16131712193312">Status Code:200.</p>
<p id="dds_api_0027__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0027__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0027__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_backup_restore.html">Backup and Restoration</a></div>
</div>
</div>
View Git Blame Copy Permalink