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>
327 lines
29 KiB
HTML
327 lines
29 KiB
HTML
<a name="dcs-api-0312022"></a><a name="dcs-api-0312022"></a>
|
|
|
|
<h1 class="topictitle1">Querying DCS Instance Backup Records</h1>
|
|
<div id="body1500349379436"><div class="section" id="dcs-api-0312022__en-us_topic_0166889605_section10329193461017"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312022__en-us_topic_0166889605_p14652163412920">This API is used to query the backup records of a specified DCS instance.</p>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312022__en-us_topic_0166889605_section10627123311133"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312022__en-us_topic_0166889605_p66477432917">GET /v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}</p>
|
|
<div class="p" id="dcs-api-0312022__en-us_topic_0166889605_p939123033811"><a href="#dcs-api-0312022__en-us_topic_0166889605_table1899262913382">Table 1</a> describes the parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312022__en-us_topic_0166889605_table1899262913382"></a><a name="en-us_topic_0166889605_table1899262913382"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312022__en-us_topic_0166889605_table1899262913382" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312022__en-us_topic_0166889605_row1599115293389"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312022__en-us_topic_0166889605_p15991152913819">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312022__en-us_topic_0166889605_p129916298387">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312022__en-us_topic_0166889605_p13991142913384">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312022__en-us_topic_0166889605_p1991329193814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312022__en-us_topic_0166889605_row11992929163813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1523414741010">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p142349718103">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1323411714108">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312022__en-us_topic_0166889605_p102346716103">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-0312022__en-us_topic_0166889605_row313125212916"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1223415719101">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1923416720108">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p62341677106">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1923487181015">DCS instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row615705910920"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p52344791015">start</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p13235475101">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p62357791015">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312022__en-us_topic_0166889605_p023519761019">Start sequence number of the backup record that is to be queried. By default, this parameter is set to <strong id="dcs-api-0312022__en-us_topic_0166889605_b418831779">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row12603175214915"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p723516711103">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1023514714106">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1223519711016">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312022__en-us_topic_0166889605_p323517191011">Number of backup records displayed on each page. The minimum value of this parameter is <strong id="dcs-api-0312022__en-us_topic_0166889605_b698477872">1</strong>. If this parameter is not set, 10 backup records are displayed on each page by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row199112521997"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p423510710103"><span style="color:#222222;">beginTime</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p22351572101">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p323517712103">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312022__en-us_topic_0166889605_p023514711109">Start time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row12965536911"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p19235147111015"><span style="color:#222222;">endTime</span></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1123511719102">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1323577141014">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1523514741020">End time of the period to be queried. Format: yyyyMMddHHmmss, for example, 20170718235959.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312022__en-us_topic_0166889605_section17412144620133"><h4 class="sectiontitle">Request</h4><p class="msonormal" id="dcs-api-0312022__en-us_topic_0166889605_p036841715408"><strong id="dcs-api-0312022__en-us_topic_0166889605_b13258185116115">Request parameters</strong></p>
|
|
<p id="dcs-api-0312022__en-us_topic_0166889605_p3991135811419">None</p>
|
|
<p id="dcs-api-0312022__en-us_topic_0166889605_p1037415181513"><strong id="dcs-api-0312022__en-us_topic_0166889605_b169913534115">Example request</strong></p>
|
|
<pre class="screen" id="dcs-api-0312022__en-us_topic_0166889605_screen155913010114">GET https://{dcs_endpoint}/v1.0/{project_id}/instances/{instance_id}/backups?start={start}&limit={limit}&beginTime={beginTime}&endTime={endTime}</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312022__en-us_topic_0166889605_section1417213312142"><h4 class="sectiontitle">Response</h4><p class="msonormal" id="dcs-api-0312022__en-us_topic_0166889605_p193854910404"><strong id="dcs-api-0312022__en-us_topic_0166889605_b10223185961111">Response parameters</strong></p>
|
|
<div class="msonormal" id="dcs-api-0312022__en-us_topic_0166889605_p1799214576389"><a href="#dcs-api-0312022__en-us_topic_0166889605_table1861319576383">Table 2</a> describes the response parameters.
|
|
<div class="tablenoborder"><a name="dcs-api-0312022__en-us_topic_0166889605_table1861319576383"></a><a name="en-us_topic_0166889605_table1861319576383"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312022__en-us_topic_0166889605_table1861319576383" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312022__en-us_topic_0166889605_row1961225712388"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312022__en-us_topic_0166889605_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-0312022__en-us_topic_0166889605_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-0312022__en-us_topic_0166889605_p26121157123820">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312022__en-us_topic_0166889605_row166121557203812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1694215159152">backup_record_response</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1394211511516">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p994291518159">Array of the backup records. For details about backup_record_response, see <a href="#dcs-api-0312022__en-us_topic_0166889605_table82951233189">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row13767421219"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1237615425118">total_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p4376042714">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p113765421411">Number of obtained backup records.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312022__en-us_topic_0166889605_table82951233189"></a><a name="en-us_topic_0166889605_table82951233189"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312022__en-us_topic_0166889605_table82951233189" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backup_record_response parameter description</caption><thead align="left"><tr id="dcs-api-0312022__en-us_topic_0166889605_row1529552361817"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312022__en-us_topic_0166889605_p19295182361812">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312022__en-us_topic_0166889605_p5295142341812">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312022__en-us_topic_0166889605_p17295182391816">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312022__en-us_topic_0166889605_row1129512317181"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1353145413181">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p153119547184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1453195431814">Backup status. Options:</p>
|
|
<ul id="dcs-api-0312022__en-us_topic_0166889605_ul7204867542"><li id="dcs-api-0312022__en-us_topic_0166889605_li86752484489"><strong id="dcs-api-0312022__en-us_topic_0166889605_b128611546141815">waiting</strong>: DCS instance restoration is waiting to begin.</li><li id="dcs-api-0312022__en-us_topic_0166889605_li2681184884818"><strong id="dcs-api-0312022__en-us_topic_0166889605_b19181248181814">backuping</strong>: DCS instance backup is in progress.</li><li id="dcs-api-0312022__en-us_topic_0166889605_li5690114814483"><strong id="dcs-api-0312022__en-us_topic_0166889605_b20126174961816">succeed</strong>: DCS instance backup succeeded.</li><li id="dcs-api-0312022__en-us_topic_0166889605_li15695134864814"><strong id="dcs-api-0312022__en-us_topic_0166889605_b82725151816">failed</strong>: DCS instance backup failed.</li><li id="dcs-api-0312022__en-us_topic_0166889605_li10698548154819"><strong id="dcs-api-0312022__en-us_topic_0166889605_b14902105118186">expired</strong>: The backup file expires.</li><li id="dcs-api-0312022__en-us_topic_0166889605_li1670284815482"><strong id="dcs-api-0312022__en-us_topic_0166889605_b2979145221810">deleted</strong>: The backup file has been deleted manually. </li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row1329517231188"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1553115413185">remark</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p7531195417183">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p19532854121812">Description of DCS instance backup</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row89511348141815"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p4532135411187">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1853215544184">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p18532135414189">Time segment in which DCS instance backup was performed</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row3237649111810"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p17532175416181">progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p3532954171818">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p85325542188">Backup progress</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row639864912186"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p05323546184">size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1253219547187">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p6532115419183">Size of the backup file. Unit: byte.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row177581437173119"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p3758123723116">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p20759163719311">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p67591837173119">DCS instance ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row1858120491183"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p253215417181">backup_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p3532115471814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p95321054161817">ID of the backup record</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row10758144910189"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p105321554191816">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p2532115419180">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p5532185417187">Time at which the backup task is created</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row8908349191817"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p12532115461819">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1853255431810">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p6532145417182">Time at which DCS instance backup is completed</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row89415477414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p29421847114119">execution_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p694274712413">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p3942204734120">Time at which the backup starts.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row14234450101811"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p105331954101820">backup_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p753365411815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p195331354111818">Backup type. Options:</p>
|
|
<ul id="dcs-api-0312022__en-us_topic_0166889605_ul6533954131811"><li id="dcs-api-0312022__en-us_topic_0166889605_li2053315543187"><strong id="dcs-api-0312022__en-us_topic_0166889605_b1376692421019">manual</strong>: manual backup</li><li id="dcs-api-0312022__en-us_topic_0166889605_li353345491817"><strong id="dcs-api-0312022__en-us_topic_0166889605_b688010283104">auto</strong>: automatic backup</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row5539165051818"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1353317547181">backup_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p11533105471820">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p553313540185">Name of the backup record</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row1729351953210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p42951719133215">backup_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p5295119143218">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p14295171916328">Backup format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row12951323121812"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p115331954111810">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p19533105415189">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p5533185491810">Error code returned if DCS instance backup fails. For details about error codes, see <a href="#dcs-api-0312022__en-us_topic_0166889605_table1255361919491">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row2060041023717"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1860121043718">is_support_restore</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1479155312376">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312022__en-us_topic_0166889605_p796540154715">An indicator of whether restoration is supported. Options: <strong id="dcs-api-0312022__en-us_topic_0166889605_b1932918451192">TRUE</strong> or <strong id="dcs-api-0312022__en-us_topic_0166889605_b1932917456918">FALSE</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dcs-api-0312022__en-us_topic_0166889605_table1255361919491"></a><a name="en-us_topic_0166889605_table1255361919491"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312022__en-us_topic_0166889605_table1255361919491" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Error codes returned in case of a backup or restoration failure</caption><thead align="left"><tr id="dcs-api-0312022__en-us_topic_0166889605_row1755412199492"><th align="left" class="cellrowborder" valign="top" width="32%" id="mcps1.3.4.5.2.3.1.1"><p id="dcs-api-0312022__en-us_topic_0166889605_p2554171914492">Error Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68%" id="mcps1.3.4.5.2.3.1.2"><p id="dcs-api-0312022__en-us_topic_0166889605_p14554121914917">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312022__en-us_topic_0166889605_row6554319154918"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p115547197491">dcs.08.0001</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1155412195491">Failed to start the backup and restore tool.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row145541819124918"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p85541319184920">dcs.08.0002</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1455401916493">Operation timed out.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row2554519114913"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p555401924915">dcs.08.0003</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p355417197494">Failed to delete bucket.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row75548193491"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p25541319144917">dcs.08.0004</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p3554121974914">Failed to obtain AK/SK.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row1355415199491"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p12554111915490">dcs.08.0005</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p355421919494">Failed to create bucket.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row18554719144912"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1755581920499">dcs.08.0006</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p19555151914490">Failed to obtain backup file size.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row2555161914910"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p15555131994918">dcs.08.0007</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p2555319144916">Data synchronization failed during instance restoration.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dcs-api-0312022__en-us_topic_0166889605_row1111512213330"><td class="cellrowborder" valign="top" width="32%" headers="mcps1.3.4.5.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_p1811642113319">dcs.08.0008</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.4.5.2.3.1.2 "><p id="dcs-api-0312022__en-us_topic_0166889605_p011617219332">Automatic backup of the instance cannot start because the instance is running other jobs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p class="msonormal" id="dcs-api-0312022__en-us_topic_0166889605_p279219520416"><strong id="dcs-api-0312022__en-us_topic_0166889605_b56612918123">Example response</strong></p>
|
|
<pre class="screen" id="dcs-api-0312022__en-us_topic_0166889605_screen4707640114017">{
|
|
"backup_record_response": [
|
|
{
|
|
"status": "succeed",
|
|
"remark": "001",
|
|
"period": null,
|
|
"progress": "100.00",
|
|
"size": 880232,
|
|
"instance_id": "5560df16-cebf-4473-95c4-d1b573c16e79",
|
|
"backup_id": "4631832a-14c6-45b0-a0b3-3abd8f591ad1",
|
|
"created_at": "2019-05-10T08:31:16.166Z",
|
|
"updated_at": "2019-05-10T08:32:30.546Z",
|
|
"execution_at": "2019-05-10T08:31:21.461Z",
|
|
"backup_type": "manual",
|
|
"backup_format": "AOF",
|
|
"backup_name": "backup_20190510163116",
|
|
"error_code": null,
|
|
"is_support_restore": "TRUE"
|
|
}
|
|
],
|
|
"total_num": 1
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dcs-api-0312022__en-us_topic_0166889605_section4860101417132"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312022__en-us_topic_0166889605_p586081451311"><a href="#dcs-api-0312022__en-us_topic_0166889605_table486141410130">Table 5</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-0312022__en-us_topic_0166889605_table486141410130"></a><a name="en-us_topic_0166889605_table486141410130"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312022__en-us_topic_0166889605_table486141410130" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312022__en-us_topic_0166889605_row18616141139"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312022__en-us_topic_0166889605_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-0312022__en-us_topic_0166889605_p18861111415138">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dcs-api-0312022__en-us_topic_0166889605_row786131451312"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312022__en-us_topic_0166889605_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-0312022__en-us_topic_0166889605_p48619143136">DCS instance backup records queried 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>
|
|
|