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_0059304230.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

382 lines
29 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0059304230"></a><a name="EN-US_TOPIC_0059304230"></a>
<h1 class="topictitle1">Executing a Backup Policy</h1>
<div id="body12125866"><div class="section" id="EN-US_TOPIC_0059304230__section27745186"><h4 class="sectiontitle">Function</h4><p class="msonormal" id="EN-US_TOPIC_0059304230__p42671089">This API is used to manually execute a backup policy and create a backup task.</p>
</div>
<div class="section" id="EN-US_TOPIC_0059304230__section48380088"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0059304230__ul33806176"><li id="EN-US_TOPIC_0059304230__li35820135">URI format<p id="EN-US_TOPIC_0059304230__p53945760"><a name="EN-US_TOPIC_0059304230__li35820135"></a><a name="li35820135"></a>POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints</p>
</li><li id="EN-US_TOPIC_0059304230__li15749798">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table7530457" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row11630735"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="EN-US_TOPIC_0059304230__p45356064">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="EN-US_TOPIC_0059304230__p49962569">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="EN-US_TOPIC_0059304230__p20436323">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="EN-US_TOPIC_0059304230__p44729494">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row23446209"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p20094757">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p17062614">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p39894459">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p65779720">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row24922659"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p5469531">provider_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p40378851">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p49461475">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p46956548">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_0059304230__b6168145214140">fc4d5750-22e7-4798-8a46-f48f62c4c1da</strong>. </p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304230__section32767614"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0059304230__ul45384045"><li id="EN-US_TOPIC_0059304230__li5803229">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table52229063" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row65530572"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0059304230__p625933685013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0059304230__p182592363502">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0059304230__p18274736115011">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0059304230__p16274336125014">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row5129585"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p12843259">checkpoint</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p33671049">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p43000452">checkpoint_req</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p60484563">For details, see the <strong id="EN-US_TOPIC_0059304230__b1527619422077">checkpoint_req</strong> field description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li7490158">Parameter description of field <strong id="EN-US_TOPIC_0059304230__b8867335">checkpoint_req</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table302559" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304230__b1503603113">checkpoint_req</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row61892580"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.2.2.2.5.1.1"><p id="EN-US_TOPIC_0059304230__p1174315396503">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.2.2.2.5.1.2"><p id="EN-US_TOPIC_0059304230__p197431839185015">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.2.2.2.5.1.3"><p id="EN-US_TOPIC_0059304230__p174313914502">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.2.2.2.5.1.4"><p id="EN-US_TOPIC_0059304230__p1874318391501">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row62362224"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p18175365">parameters</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p62918475">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p63231721">checkpoint_param</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p21495816">Backup parameters</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row59244624"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p34085202">plan_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p9437993">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p26279997">String</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p48305013">Backup policy ID. Refer to the backup policy ID that is returned by the API of <a href="en-us_topic_0059304227.html">Querying the Backup Policy List</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li32091938">Parameter description of field<strong id="EN-US_TOPIC_0059304230__b64227841"> checkpoint_param </strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table20391994" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Parameter description of field<strong id="EN-US_TOPIC_0059304230__b878949686"> checkpoint_param </strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row65655933"><th align="left" class="cellrowborder" valign="top" width="25.507449255074494%" id="mcps1.3.3.2.3.2.2.5.1.1"><p id="EN-US_TOPIC_0059304230__p337684013505">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.3.2.2.5.1.2"><p id="EN-US_TOPIC_0059304230__p33764400504">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.3.2.3.2.2.5.1.3"><p id="EN-US_TOPIC_0059304230__p9376164085017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.91540845915409%" id="mcps1.3.3.2.3.2.2.5.1.4"><p id="EN-US_TOPIC_0059304230__p43921840205018">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row24015598"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p66215252">auto_trigger</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p61835195">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p42594890">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p27634090">Whether automatic trigger is enabled</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row47380224"><td class="cellrowborder" valign="top" width="25.507449255074494%" headers="mcps1.3.3.2.3.2.2.5.1.1 "><p id="EN-US_TOPIC_0059304230__p12592924">resources</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.3.2.2.5.1.2 "><p id="EN-US_TOPIC_0059304230__p13393884">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.3.2.3.2.2.5.1.3 "><p id="EN-US_TOPIC_0059304230__p11162792">List&lt;String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="45.91540845915409%" headers="mcps1.3.3.2.3.2.2.5.1.4 "><p id="EN-US_TOPIC_0059304230__p31770985">ID list of resources to be backed up</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li17503417">Example request<pre class="screen" id="EN-US_TOPIC_0059304230__screen1187101332018">POST https://{endpoint}/v1/{project_id}/providers/{provider_id}/checkpoints
{
"checkpoint" : {
"plan_id" : "62171999-3df1-42f7-9513-6f9b1bea4744",
"parameters" : {
"auto_trigger" : false,
"resources" : [ "7a32a8b5-7977-4e24-b5da-e0eb457db75b", "b2b433bf-7dd6-4a74-aa8f-85673dfbda48" ]
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304230__section26473078"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0059304230__ul55334074"><li id="EN-US_TOPIC_0059304230__li28244624">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table52875024" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row50783343"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0059304230__p86411943195020">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0059304230__p1065774315012">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0059304230__p86577430503">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row20239584"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p28793606">checkpoint</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p3397638">checkpoint_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p6773298">See the <strong id="EN-US_TOPIC_0059304230__b5945142883710">checkpoint_resp</strong> field description.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li60959682">Parameter description of field <strong id="EN-US_TOPIC_0059304230__b47637651">checkpoint_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table11766233" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304230__b1587812893">checkpoint_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row37931945"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.2.2.2.4.1.1"><p id="EN-US_TOPIC_0059304230__p550144617506">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.2.2.2.4.1.2"><p id="EN-US_TOPIC_0059304230__p1851744615019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.2.2.2.4.1.3"><p id="EN-US_TOPIC_0059304230__p3517946165011">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row56022305"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p41512818">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p37831566">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p44458025">Status. The value can be <strong id="EN-US_TOPIC_0059304230__b3118910202920">protecting</strong>, <strong id="EN-US_TOPIC_0059304230__b1018331216291">deleting</strong>, <strong id="EN-US_TOPIC_0059304230__b0524913182917">available</strong>, or <strong id="EN-US_TOPIC_0059304230__b7874141413290">error</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row64577910"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p63428245">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p10652664">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p57559436">Creation time, for example, 2016-12-06T21:20:29.898823</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row48272879"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p17789141">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p12243410">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p52192186">Backup record ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row67076492"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p64486787">resource_graph</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p43536399">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p36787444">Resource diagram, which displays the mapping relationship between resources and backups. If the value is null, the backup contains only the resource backup of the entire system.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row62651542"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p41610169">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p5461607">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p16134202512151">Project ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row22088927"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p44372630">protection_plan</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p10578331">plan_resp</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p51538488">Backup policy information</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row1551632045"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.2.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p1953573548">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.2.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p1253893146">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.2.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p195447318418">Additional information about the backup object, such as the backup creation mode</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li61193214">Parameter description of field <strong id="EN-US_TOPIC_0059304230__b33041702">plan_resp</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table13868018" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304230__b176355449334">plan_resp</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row35028525"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0059304230__p14861154825011">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0059304230__p1386124816506">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0059304230__p486111482500">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row24335246"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p24997922">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p64411810">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p49974111">Backup policy ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row47113817"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p58122826">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p31296560">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p51993463">Backup policy name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row65287983"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p53835255">resources</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p19158168">List&lt;resource&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p8307777">Backup object list</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li7661137">Parameter description of field <strong id="EN-US_TOPIC_0059304230__b15504345">resource</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table1841371" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Parameter description of field <strong id="EN-US_TOPIC_0059304230__b1185972480">resource</strong></caption><thead align="left"><tr id="EN-US_TOPIC_0059304230__row58395968"><th align="left" class="cellrowborder" valign="top" width="29.76%" id="mcps1.3.4.2.4.2.2.4.1.1"><p id="EN-US_TOPIC_0059304230__p54231752165020">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.67%" id="mcps1.3.4.2.4.2.2.4.1.2"><p id="EN-US_TOPIC_0059304230__p14381652145018">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.57000000000001%" id="mcps1.3.4.2.4.2.2.4.1.3"><p id="EN-US_TOPIC_0059304230__p043817522505">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row56034597"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p42508527">id</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p61118200">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p51627143">Backup object ID</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row1050513353349"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p10242210163618">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p182422103364">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p98113652114">Entity object type of backup objects</p>
<p id="EN-US_TOPIC_0059304230__p424214104366">The value is fixed at <strong id="EN-US_TOPIC_0059304230__b1846635710161">OS::Nova::Server</strong> (ECSs).</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row9527550"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p33534096">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p34352802">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p31113586">Backup object name</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row9502115994217"><td class="cellrowborder" valign="top" width="29.76%" headers="mcps1.3.4.2.4.2.2.4.1.1 "><p id="EN-US_TOPIC_0059304230__p777318533616">extra_info</p>
</td>
<td class="cellrowborder" valign="top" width="16.67%" headers="mcps1.3.4.2.4.2.2.4.1.2 "><p id="EN-US_TOPIC_0059304230__p10773185103617">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.57000000000001%" headers="mcps1.3.4.2.4.2.2.4.1.3 "><p id="EN-US_TOPIC_0059304230__p1677325193612">Additional information of the resource</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li11586820">Example response<pre class="screen" id="EN-US_TOPIC_0059304230__screen1379713292010">{
"checkpoint" : {
"status" : "protecting",
"created_at" : "2016-12-06T21:20:29.898823",
"id" : "14626f11-b54a-44ea-8e69-7463e527506a",
"resource_graph" : null,
"project_id" : "b942cc8342734d15bcb246babb1953cf",
"protection_plan" : {
"id" : "6a6cda7e-7b89-4b14-8e5c-3b6821a97d2c",
"resources" : [ {
"type" : "OS::Nova::Server",
"id" : "1c960fe4-e679-421a-97cd-4f7463d2344b",
"name" : "server0",
"extra_info": "{}"
} ],
"name" : "backup"
},
"extra_info": "{"created_by": "manual"}"
}
}</pre>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304230__section36931111"><h4 class="sectiontitle">Status Codes</h4><ul id="EN-US_TOPIC_0059304230__ul1251104"><li id="EN-US_TOPIC_0059304230__li11259943">Normal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table34230627" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304230__row32432861"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="EN-US_TOPIC_0059304230__p9816121">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="EN-US_TOPIC_0059304230__p56908304">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row46169932"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p48777045">200</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p58626578">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0059304230__li57877160">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0059304230__table51132396" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0059304230__row21973438"><th align="left" class="cellrowborder" valign="top" width="42.42%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0059304230__p35018071">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.58%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0059304230__p17891472">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0059304230__row39923089"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p12544771">400</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p9493517">Invalid request parameters.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row18332795"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p8561437">401</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p22387820">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row163791"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p13267148">403</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p897193">No operation permission.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row8074739"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p50074116">404</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p29471561">Requested object not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row63917458"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p9931649">500</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p66266137">Service internal error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0059304230__row59524323"><td class="cellrowborder" valign="top" width="42.42%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0059304230__p56740874">503</p>
</td>
<td class="cellrowborder" valign="top" width="57.58%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0059304230__p32608110">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0059304230__section61541938486"><h4 class="sectiontitle">Error Codes</h4><p id="EN-US_TOPIC_0059304230__p999593594811">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_0059304229.html">Backup Management</a></div>
</div>
</div>
View Git Blame Copy Permalink