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>
136 lines
12 KiB
HTML
136 lines
12 KiB
HTML
<a name="dcs-api-0312021"></a><a name="dcs-api-0312021"></a>
|
|
|
|
<h1 class="topictitle1">Restoring a DCS Instance</h1>
|
|
<div id="body1500349379433"><div class="section" id="dcs-api-0312021__en-us_topic_0166889595_section17787161851016"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312021__en-us_topic_0166889595_p61151091696">This API is used to restore a specified DCS instance.</p>
|
|
<div class="note" id="dcs-api-0312021__en-us_topic_0166889595_note979571410307"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dcs-api-0312021__en-us_topic_0166889595_p109623444015">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-0312021__en-us_topic_0166889595_section10627123311133"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312021__en-us_topic_0166889595_p10356042663">POST /v1.0/{project_id}/instances/{instance_id}/restores</p>
|
|
<div class="p" id="dcs-api-0312021__en-us_topic_0166889595_p939123033811"><a href="#dcs-api-0312021__en-us_topic_0166889595_table1899262913382">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312021__en-us_topic_0166889595_table1899262913382"></a><a name="en-us_topic_0166889595_table1899262913382"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312021__en-us_topic_0166889595_table1899262913382" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312021__en-us_topic_0166889595_row1599115293389"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_p1991329193814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312021__en-us_topic_0166889595_row11992929163813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_row17992929193810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_p199212910384">DCS instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312021__en-us_topic_0166889595_section17412144620133"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="dcs-api-0312021__en-us_topic_0166889595_p036841715408"><strong id="dcs-api-0312021__en-us_topic_0166889595_b147569354109">Request parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312021__en-us_topic_0166889595_p9769133510383"><a href="#dcs-api-0312021__en-us_topic_0166889595_table153111335113816">Table 2</a> describes the request parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312021__en-us_topic_0166889595_table153111335113816"></a><a name="en-us_topic_0166889595_table153111335113816"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312021__en-us_topic_0166889595_table153111335113816" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_p173101235153817">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312021__en-us_topic_0166889595_row1631133513386"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312021__en-us_topic_0166889595_p1476162018711">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-0312021__en-us_topic_0166889595_p44761620072">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-0312021__en-us_topic_0166889595_p194761220279">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-0312021__en-us_topic_0166889595_p047619201376">Description of DCS instance restoration</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312021__en-us_topic_0166889595_row1231173523817"><td class="cellrowborder" valign="top" width="20.202020202020204%" headers="mcps1.3.3.3.2.2.5.1.1 "><p id="dcs-api-0312021__en-us_topic_0166889595_p1047692020713">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.3.3.2.2.5.1.2 "><p id="dcs-api-0312021__en-us_topic_0166889595_p54767201077">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-0312021__en-us_topic_0166889595_p3476132013716">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.3.3.2.2.5.1.4 "><p id="dcs-api-0312021__en-us_topic_0166889595_p04761220579">ID of the backup record</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<p id="dcs-api-0312021__en-us_topic_0166889595_p18178425164011"><strong id="dcs-api-0312021__en-us_topic_0166889595_b82552429107">Example request</strong></p>
|
|
<p id="dcs-api-0312021__en-us_topic_0166889595_p204524246402">Request URL:</p>
|
|
<pre class="screen" id="dcs-api-0312021__en-us_topic_0166889595_screen79231314141120">POST https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/restores</pre>
|
|
<div class="p" id="dcs-api-0312021__en-us_topic_0166889595_p20420191115118">Example:<pre class="screen" id="dcs-api-0312021__en-us_topic_0166889595_screen13274335164015">{
|
|
"remark":"restore instance",
|
|
"<span style="color:#222222;">backup_id</span>":"8ba256cb-e5ac-44f6-a3da-c03d8f0e5029"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312021__en-us_topic_0166889595_section1417213312142"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312021__en-us_topic_0166889595_p193854910404"><strong id="dcs-api-0312021__en-us_topic_0166889595_b157281948131011">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312021__en-us_topic_0166889595_p1799214576389"><a href="#dcs-api-0312021__en-us_topic_0166889595_table1861319576383">Table 3</a> describes the response parameter.
|
|
<div class="tablenoborder"><a name="dcs-api-0312021__en-us_topic_0166889595_table1861319576383"></a><a name="en-us_topic_0166889595_table1861319576383"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312021__en-us_topic_0166889595_table1861319576383" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312021__en-us_topic_0166889595_row1961225712388"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_p26121157123820">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312021__en-us_topic_0166889595_row166121557203812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312021__en-us_topic_0166889595_p2679426285">restore_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312021__en-us_topic_0166889595_p12679192617817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312021__en-us_topic_0166889595_p1767952618810">ID of the restoration record</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="msonormal" id="dcs-api-0312021__en-us_topic_0166889595_p279219520416"><strong id="dcs-api-0312021__en-us_topic_0166889595_b1827014553106">Example response</strong><pre class="screen" id="dcs-api-0312021__en-us_topic_0166889595_screen18861710144112">{
|
|
"restore_id": "a6155972-800c-4170-a479-3231e907d2f6"
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312021__en-us_topic_0166889595_section4860101417132"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312021__en-us_topic_0166889595_p586081451311"><a href="#dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_table486141410130"></a><a name="en-us_topic_0166889595_table486141410130"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312021__en-us_topic_0166889595_table486141410130" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312021__en-us_topic_0166889595_row18616141139"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_p18861111415138">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312021__en-us_topic_0166889595_row786131451312"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312021__en-us_topic_0166889595_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-0312021__en-us_topic_0166889595_p48619143136">Restoration 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>
|
|
|