forked from docs/doc-exports
Chen, Junjie
a03981f7be
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com> Co-authored-by: Chen, Junjie <chenjunjie@huawei.com> Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
126 lines
11 KiB
HTML
126 lines
11 KiB
HTML
<a name="dcs-api-0312020"></a><a name="dcs-api-0312020"></a>
|
|
|
|
<h1 class="topictitle1">Backing Up a DCS Instance</h1>
|
|
<div id="body1500349379431"><div class="section" id="dcs-api-0312020__en-us_topic_0166889614_section1525575419919"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312020__en-us_topic_0166889614_p19882631109">This API is used to back up a specified DCS instance.</p>
|
|
<div class="note" id="dcs-api-0312020__en-us_topic_0166889614_note979571410307"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dcs-api-0312020__en-us_topic_0166889614_p13795121413306">Only master/standby and cluster DCS instances can be backed up and restored, while single-node instances cannot.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312020__en-us_topic_0166889614_section10627123311133"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312020__en-us_topic_0166889614_p187021256006">POST /v1.0/{project_id}/instances/{instance_id}/backups</p>
|
|
<div class="p" id="dcs-api-0312020__en-us_topic_0166889614_p939123033811"><a href="#dcs-api-0312020__en-us_topic_0166889614_table1899262913382">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312020__en-us_topic_0166889614_table1899262913382"></a><a name="en-us_topic_0166889614_table1899262913382"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312020__en-us_topic_0166889614_table1899262913382" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312020__en-us_topic_0166889614_row1599115293389"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312020__en-us_topic_0166889614_p15991152913819">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312020__en-us_topic_0166889614_p129916298387">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312020__en-us_topic_0166889614_p13991142913384">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312020__en-us_topic_0166889614_p1991329193814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312020__en-us_topic_0166889614_row11992929163813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312020__en-us_topic_0166889614_p159911329153817">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312020__en-us_topic_0166889614_p18992192943819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312020__en-us_topic_0166889614_p9992172933814">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312020__en-us_topic_0166889614_p20992829103811">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312020__en-us_topic_0166889614_row17992929193810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312020__en-us_topic_0166889614_p1899282919384">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312020__en-us_topic_0166889614_p15992229153810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312020__en-us_topic_0166889614_p199921129133818">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312020__en-us_topic_0166889614_p199212910384">DCS instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312020__en-us_topic_0166889614_section17412144620133"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="dcs-api-0312020__en-us_topic_0166889614_p036841715408"><strong id="dcs-api-0312020__en-us_topic_0166889614_b355213523815">Request parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312020__en-us_topic_0166889614_p9769133510383"><a href="#dcs-api-0312020__en-us_topic_0166889614_table153111335113816">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312020__en-us_topic_0166889614_table153111335113816"></a><a name="en-us_topic_0166889614_table153111335113816"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312020__en-us_topic_0166889614_table153111335113816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312020__en-us_topic_0166889614_row73117359383"><th align="left" class="cellrowborder" valign="top" width="20.202020202020204%" id="mcps1.3.3.3.2.2.5.1.1"><p id="dcs-api-0312020__en-us_topic_0166889614_p1031043517387">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.16161616161616%" id="mcps1.3.3.3.2.2.5.1.2"><p id="dcs-api-0312020__en-us_topic_0166889614_p19310113593814">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.18181818181818%" id="mcps1.3.3.3.2.2.5.1.3"><p id="dcs-api-0312020__en-us_topic_0166889614_p93101035183813">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45.45454545454545%" id="mcps1.3.3.3.2.2.5.1.4"><p id="dcs-api-0312020__en-us_topic_0166889614_p173101235153817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312020__en-us_topic_0166889614_row1631133513386"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312020__en-us_topic_0166889614_p287019311111">remark</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312020__en-us_topic_0166889614_p1387014311215">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.18181818181818%" headers="mcps1.3.3.3.2.2.5.1.3 "><p id="dcs-api-0312020__en-us_topic_0166889614_p287033113111">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312020__en-us_topic_0166889614_p1587016314112">Description of DCS instance backup.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="dcs-api-0312020__en-us_topic_0166889614_p18178425164011"><strong id="dcs-api-0312020__en-us_topic_0166889614_b1858318104910">Example request</strong></p>
|
|
<ul id="dcs-api-0312020__en-us_topic_0166889614_ul2697151942818"><li id="dcs-api-0312020__en-us_topic_0166889614_li12698151912283">Request URL:<pre class="screen" id="dcs-api-0312020__en-us_topic_0166889614_screen2984653121012">POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups</pre>
|
|
</li></ul>
|
|
<ul id="dcs-api-0312020__en-us_topic_0166889614_ul11970142418284"><li id="dcs-api-0312020__en-us_topic_0166889614_li1197022411286">Example:<pre class="screen" id="dcs-api-0312020__en-us_topic_0166889614_screen13274335164015">{
|
|
"remark": "Backup instances"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312020__en-us_topic_0166889614_section1417213312142"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312020__en-us_topic_0166889614_p193854910404"><strong id="dcs-api-0312020__en-us_topic_0166889614_b11201191712919">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312020__en-us_topic_0166889614_p1799214576389"><a href="#dcs-api-0312020__en-us_topic_0166889614_table1861319576383">Table 3</a> describes the response parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312020__en-us_topic_0166889614_table1861319576383"></a><a name="en-us_topic_0166889614_table1861319576383"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312020__en-us_topic_0166889614_table1861319576383" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312020__en-us_topic_0166889614_row1961225712388"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312020__en-us_topic_0166889614_p136126577389">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312020__en-us_topic_0166889614_p76121757113816">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312020__en-us_topic_0166889614_p26121157123820">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312020__en-us_topic_0166889614_row166121557203812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312020__en-us_topic_0166889614_p1461218271754">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312020__en-us_topic_0166889614_p6612727959">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312020__en-us_topic_0166889614_p19612327552">ID of the backup record</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="msonormal" id="dcs-api-0312020__en-us_topic_0166889614_p279219520416"><strong id="dcs-api-0312020__en-us_topic_0166889614_b14568112518911">Example response</strong><pre class="screen" id="dcs-api-0312020__en-us_topic_0166889614_screen18861710144112">{
|
|
"backup_id": "548ceeff-2cbb-47ab-9a1c-7b085a8c08d7"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312020__en-us_topic_0166889614_section4860101417132"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312020__en-us_topic_0166889614_p586081451311"><a href="#dcs-api-0312020__en-us_topic_0166889614_table486141410130">Table 4</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>.</p>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312020__en-us_topic_0166889614_table486141410130"></a><a name="en-us_topic_0166889614_table486141410130"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312020__en-us_topic_0166889614_table486141410130" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312020__en-us_topic_0166889614_row18616141139"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312020__en-us_topic_0166889614_p1986191418133">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312020__en-us_topic_0166889614_p18861111415138">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312020__en-us_topic_0166889614_row786131451312"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312020__en-us_topic_0166889614_p6861114181311">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312020__en-us_topic_0166889614_p48619143136">Backup task created successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0514005.html">Backup and Restoration APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|