vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/csbs/api-ref/en-us_topic_0059304219.html
Wei, Hongmin 8ce662c4dc CSBS API initial version 
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>
2022-10-24 21:06:50 +00:00

448 lines
35 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0059304219"></a><a name="EN-US_TOPIC_0059304219"></a>
<h1 class="topictitle1">Creating a Backup for a Resource</h1>
<div id="body13925796"><div class="section" id="EN-US_TOPIC_0059304219__section21655625"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0059304219__p54247667">This API is used to create a backup for a specified resource.</p>
</div>
<div class="section" id="EN-US_TOPIC_0059304219__section60682897"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304219__ul31984895"><li id="EN-US_TOPIC_0059304219__li19428599">URI format<p id="EN-US_TOPIC_0059304219__p40639663"><a name="EN-US_TOPIC_0059304219__li19428599"></a><a name="li19428599"></a>POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/resources/{resource_id}/action</p>
</li><li id="EN-US_TOPIC_0059304219__li30212648">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table3478379" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row24348515"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0059304219__p26072662">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0059304219__p31510915">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0059304219__p2247312">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0059304219__p47814565">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row47774571"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p44535049">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p50569256">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p2469104">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p65779720">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row55146569"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p37687133">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p32758933">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p36227930">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p48781203">Backup provider ID, which specifies whether the backup object is a server or disk. This parameter has a fixed value. For CSBS, the value is <strong id="EN-US_TOPIC_0059304219__b393514818119">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row36377647"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p60908274">resource_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p34623133">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p53010393">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p65983437">ID of a backup server. For details about how to obtain the server ID, see the <a href="https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0020805967.html" target="_blank" rel="noopener noreferrer">Elastic Cloud Server API Reference</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="notice" id="EN-US_TOPIC_0059304219__note851114467532"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="EN-US_TOPIC_0059304219__p20511164685318">Backup provider IDs mentioned in this document are all <strong id="EN-US_TOPIC_0059304219__b842352706105257">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>.</p>
</div></div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304219__section9275167"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304219__ul43058210"><li id="EN-US_TOPIC_0059304219__li51979576">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table65163008" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row24708790"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0059304219__p55254977">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0059304219__p46468128">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0059304219__p5822012">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0059304219__p1820924">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row13277128"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p1705609">protect</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p3936679">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p50435593">protect_param</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p58751256">Backup parameters</p>
<p id="EN-US_TOPIC_0059304219__p12918262208">For details, see <a href="#EN-US_TOPIC_0059304219__table61231291">Table 3</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li58999259">Parameter description of field <strong id="EN-US_TOPIC_0059304219__b44318764312">protect_param</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304219__table61231291"></a><a name="table61231291"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table61231291" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304219__b46791623183120">protect_param</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row59177776"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="EN-US_TOPIC_0059304219__p28670558">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="EN-US_TOPIC_0059304219__p40613901">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="EN-US_TOPIC_0059304219__p1391717">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="EN-US_TOPIC_0059304219__p45620237">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row4251693"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p8842862">backup_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p45183223">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p35962481">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p27279876">Backup name. The value consists of 1 to 255 characters and can contain only letters, digits, underscores (_), and hyphens (-).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row44192294"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p22806032">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p35349286">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p44719954">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p65546489">Backup description. The value consists of 0 to 255 characters and must not contain a greater-than sign (&gt;) or less-than sign (&lt;).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row1128062331110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p213719391665">incremental</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p913717392612">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p1913714399617">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p12137039566">Backup type. Value <strong id="EN-US_TOPIC_0059304219__b84235270619123">True</strong> indicates incremental backup and value <strong id="EN-US_TOPIC_0059304219__b84235270619127">False</strong> indicates full backup. For the initial backup, full backup is always adopted, in spite of which value is set.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row138818832216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p20918121932210">resource_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p109214199225">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p16925101912220">String</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p593081942216">Entity object type of the backup object</p>
<p id="EN-US_TOPIC_0059304219__p4930919112214">The current value is <strong id="EN-US_TOPIC_0059304219__b842352706174637">OS::Nova::Server</strong> indicating that the backup object is an ECS. If this parameter is not passed, the backup object type defaults to <strong id="EN-US_TOPIC_0059304219__b715618842191047">OS::Nova::Server</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row156291503185"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p166319031813">tags</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p863111081818">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p106311010188">List&lt;resource_tag&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p9244511113310">Tag list</p>
<p id="EN-US_TOPIC_0059304219__p52026988">This list cannot be an empty list.</p>
<p id="EN-US_TOPIC_0059304219__p183916535015">The list can contain up to 10 keys.</p>
<p id="EN-US_TOPIC_0059304219__p1338589319">Keys in this list must be unique.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row4259132585510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p8259325135510">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p1425913251559">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p42591425175510">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p17259112515518">Additional information about the backup object</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li53047495">Parameter description of field <strong id="EN-US_TOPIC_0059304219__b84235270695528">resource_tag</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table896249101917" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304219__b1076030527">resource_tag</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row9162134911197"><th align="left" class="cellrowborder" valign="top" width="19.400000000000002%" id="mcps1.3.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0059304219__p7162249101912">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0059304219__p5162849151912">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.34%" id="mcps1.3.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0059304219__p1916215495193">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.919999999999995%" id="mcps1.3.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0059304219__p151621949111912">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row11162154981914"><td class="cellrowborder" valign="top" width="19.400000000000002%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p91621649171913">key</p>
</td>
<td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p141641249191910">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p1516484971919">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.919999999999995%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p798643483310">Tag key</p>
<p id="EN-US_TOPIC_0059304219__p036816391334">It consists of up to 36 characters.</p>
<p id="EN-US_TOPIC_0059304219__p1815945343312">It cannot be an empty string.</p>
<p id="EN-US_TOPIC_0059304219__p139819543334">Spaces before and after a key will be deprecated.</p>
<p id="EN-US_TOPIC_0059304219__p14766132412516">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row19164144901912"><td class="cellrowborder" valign="top" width="19.400000000000002%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304219__p8164134971913">value</p>
</td>
<td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304219__p1216494911199">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.34%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304219__p2164549151920">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.919999999999995%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304219__p11608421163420">Tag value</p>
<p id="EN-US_TOPIC_0059304219__p489413816351">It consists of up to 43 characters.</p>
<p id="EN-US_TOPIC_0059304219__p14194717123517">It can be an empty string.</p>
<p id="EN-US_TOPIC_0059304219__p1146913338362">Spaces before and after a tag value will be deprecated.</p>
<p id="EN-US_TOPIC_0059304219__p86239316407">It can contain only letters, digits, hyphens (-), and underscores (_).</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<ul id="EN-US_TOPIC_0059304219__ul19995047193"><li id="EN-US_TOPIC_0059304219__li99951644197">Example request<pre class="screen" id="EN-US_TOPIC_0059304219__screen1186351941115">POST
https://{endpoint}/v1/b942cc8342734d15bcb246babb1953cf/providers/fc4d5750-22e7-4798-8a46-f48f62c4c1da/resources/9506416d-db6c-406e-8bca-c0f43793d914/action
{
"protect" : {
"backup_name" : "backup",
"description" : "backup des",
"extra_info" : {
}
}
}</pre>
</li></ul>
<div class="section" id="EN-US_TOPIC_0059304219__section16367643"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304219__ul5011139"><li id="EN-US_TOPIC_0059304219__li45100255">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table3249118" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row31941010"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0059304219__p37085012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0059304219__p45133897">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0059304219__p31967053">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row39194464"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p20635053">checkpoint</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p28006415">protect_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p53927157">Backup response</p>
<p id="EN-US_TOPIC_0059304219__p17581748172717">For details, see <a href="#EN-US_TOPIC_0059304219__table6023603">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li15582370">Parameter description of field <strong id="EN-US_TOPIC_0059304219__b50905282">protect_resp</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304219__table6023603"></a><a name="table6023603"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table6023603" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304219__b160532123216">protect_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row3404451"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.2.2.2.4.1.1"><p id="EN-US_TOPIC_0059304219__p7325143">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.2.2.2.4.1.2"><p id="EN-US_TOPIC_0059304219__p10319892">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.2.2.2.4.1.3"><p id="EN-US_TOPIC_0059304219__p30604909">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row63078563"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p9089949">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p46486015">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p7270838">Backup status</p>
<p id="EN-US_TOPIC_0059304219__p199923219255">Value range: waiting_protect, protecting, available, waiting_restore, restoring, error, waiting_delete, deleting, and deleted</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row65437548"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p65950058">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p47485470">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p21117861">Creation time, for example, <strong id="EN-US_TOPIC_0059304219__b3968854145819">2017-04-18T01:21:52.701973</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row55843024"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p26991099">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p55418550">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p59717526">Backup record ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row586823"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p47532697">resource_graph</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p7136174">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p41159234">Resource diagram, which displays the inclusion relationship between backups and sub-backups</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row34888786"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p7419413">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p24846201">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p66385258">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row60596410"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p9362184">protection_plan</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p20685135">plan_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p64883223">Backup plan information</p>
<p id="EN-US_TOPIC_0059304219__p4797713102910">For details, see <a href="#EN-US_TOPIC_0059304219__table21049687">Table 7</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row657816335619"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p115662037564">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p115691236563">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p125732310569">Additional information</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li47078096">Parameter description of field <strong id="EN-US_TOPIC_0059304219__b31192822">plan_resp</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304219__table21049687"></a><a name="table21049687"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table21049687" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304219__b33041702">plan_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row64306394"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0059304219__p41435424">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0059304219__p66918496">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0059304219__p51689132">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row26070131"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p31305887">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p44806725">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p5466127">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row49195146"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p25383881">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p46556898">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p13012363">Backup policy name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row50002403"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p23662815">resources</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p28932126">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p61800880">Backup object list</p>
<p id="EN-US_TOPIC_0059304219__p8794115120123">For details, see <a href="#EN-US_TOPIC_0059304219__table4765237103212">Table 8</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li19337015">Parameter description of field <strong id="EN-US_TOPIC_0059304219__b22112815">resource</strong>
<div class="tablenoborder"><a name="EN-US_TOPIC_0059304219__table4765237103212"></a><a name="table4765237103212"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table4765237103212" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304219__b7642103510720">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304219__row3761173710329"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.5.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0059304219__p7761183753211">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.5.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0059304219__p197611937173220">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.5.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0059304219__p197611337133215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row176243783215"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p87621337183218">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p177621372321">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p77622037173219">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row1976319377329"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p137621637143211">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p1276353714328">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p07632378329">Entity object type of the backup object. The value is fixed at <strong id="EN-US_TOPIC_0059304219__b1011106231165357">OS::Nova::Server</strong>, indicating that the object type is ECS.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row1576412371327"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p1476483713216">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p127641337173211">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p876473713326">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row77651537153211"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.5.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304219__p7764173719321">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.5.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304219__p276433733213">Dict</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.5.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304219__p2076413773217">Additional information about the backup object</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li41697036">Example response<pre class="screen" id="EN-US_TOPIC_0059304219__screen179411718161219">{
"checkpoint" : {
"status" : "protecting",
"created_at" : "2017-04-18T01:21:52.701973",
"id" : "4468f4b8-7c78-4222-a2ca-346b5d557dd2",
"resource_graph" : null,
"project_id" : "b942cc8342734d15bcb246babb1953cf",
"extra_info" : null,
"protection_plan" : {
"id" : "fake_04f8ea0f-2000-4389-a5ce-93a3e20d0faf",
"resources" : [ {
"type" : "OS::Nova::Server",
"id" : "9506416d-db6c-406e-8bca-c0f43793d914",
"name" : "resource_9506416d-db6c-406e-8bca-c0f43793d914",
"extra_info" : {
}
} ],
"name" : "server protect plan for 9506416d-db6c-406e-8bca-c0f43793d914"
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304219__section13091062"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304219__ul35358604"><li id="EN-US_TOPIC_0059304219__li49791983">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table45474671" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304219__row6907822"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.6.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0059304219__p22662724">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.6.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0059304219__p23741362">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row44002209"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p7409209">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p63275041">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304219__li32604458">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304219__table25004673" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304219__row38855211"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0059304219__p60264372">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0059304219__p49575962">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304219__row56229956"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p58332570">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p27317766">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row44533302"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p50427739">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p58115081">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row53273682"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p20200991">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p25667593">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row29681748"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p55411379">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p59136739">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row62468609"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p26792557">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p22713469">Service internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304219__row3094630"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304219__p49338472">503</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304219__p36993282">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304219__section10566123417416"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304219__p7941238114118">For details, see <a href="en-us_topic_0071888297.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0059304218.html">Resource Management</a></div>
</div>
</div>
View Git Blame Copy Permalink