forked from docs/doc-exports
Wang , Deng Ke
60010eb9d0
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
118 lines
8.8 KiB
HTML
118 lines
8.8 KiB
HTML
<a name="dds_api_0030"></a><a name="dds_api_0030"></a>
|
|
|
|
<h1 class="topictitle1">Querying an Automated Backup Policy</h1>
|
|
<div id="body1473065787050"><div class="section" id="dds_api_0030__section117711820496"><h4 class="sectiontitle">Function</h4><p id="dds_api_0030__p1639433018917">This API is used to query an automated backup policy.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0030__section12081471012"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0030__ul13194498"><li id="dds_api_0030__li51641620">URI format<p id="dds_api_0030__p62121397"><a name="dds_api_0030__li51641620"></a><a name="li51641620"></a>GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/backups/policy</p>
|
|
</li><li id="dds_api_0030__li22221662">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0030__table65777232" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0030__row46529701"><th align="left" class="cellrowborder" valign="top" width="30.183018301830185%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0030__p10809459">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="29.27292729272927%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0030__p3150961">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.54405440544054%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0030__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0030__row3925534"><td class="cellrowborder" valign="top" width="30.183018301830185%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0030__p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.27292729272927%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0030__p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.54405440544054%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0030__p43776822">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0030__row5911165722911"><td class="cellrowborder" valign="top" width="30.183018301830185%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0030__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="29.27292729272927%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0030__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.54405440544054%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0030__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0030__section420839121019"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0030__ul046917251847"><li id="dds_api_0030__li646919251746">Example request<p id="dds_api_0030__p176941826453"><a name="dds_api_0030__li646919251746"></a><a name="li646919251746"></a>GET https://dds.eu-de.otc.t-systems.com/v3/97b026aa9cc4417888c14c84a1ad9860/instances/cc6345c64cec47499182467ea0dd432ain02/backups/policy</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0030__section1229512143106"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0030__ul1727710432014"><li id="dds_api_0030__li227714320010">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0030__table6426756154514" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0030__row142645664510"><th align="left" class="cellrowborder" valign="top" width="28.032803280328032%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0030__p17490046">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.82318231823182%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0030__p63149496">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.144014401440145%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0030__p957518322411">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0030__row34264566458"><td class="cellrowborder" valign="top" width="28.032803280328032%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0030__p28083633">backup_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.82318231823182%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0030__p1649395225614">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.144014401440145%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0030__p61847473">Indicates the backup policy object, including the backup retention period (days) and start time. For more information, see <a href="#dds_api_0030__table163715367507">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dds_api_0030__table163715367507"></a><a name="table163715367507"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0030__table163715367507" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backup_policy field data structure description</caption><thead align="left"><tr id="dds_api_0030__row9637103616501"><th align="left" class="cellrowborder" valign="top" width="28.352835283528353%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0030__p6927161055116">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="31.613161316131617%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0030__p1792911005118">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40.03400340034003%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0030__p17266173510416">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0030__row1863793617509"><td class="cellrowborder" valign="top" width="28.352835283528353%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0030__p22303345174853">keep_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.613161316131617%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0030__p34927138174853">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03400340034003%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0030__p30482871191015">Indicates the number of days to retain the backup files.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0030__row1637173618507"><td class="cellrowborder" valign="top" width="28.352835283528353%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0030__p8056259175641">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.613161316131617%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0030__p42443136175641">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03400340034003%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0030__p8983181183415">Indicates the backup time window. Automated backups will be triggered during the backup time window.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0030__row166371436195010"><td class="cellrowborder" valign="top" width="28.352835283528353%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0030__p146385361506">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="31.613161316131617%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0030__p1363812362509">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40.03400340034003%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0030__p11638173615018">Indicates the backup cycle configuration. Data will be automatically backed up on the selected days every week.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="dds_api_0030__li158029471019">Response example<div class="p" id="dds_api_0030__p52911330198"><a name="dds_api_0030__li158029471019"></a><a name="li158029471019"></a>In case the automated backup policy is enabled:<pre class="codeblock" id="dds_api_0030__codeblock1791783883317">{
|
|
"backup_policy": {
|
|
"keep_days": 7,
|
|
"start_time": "19:00-20:00",
|
|
"period": "1,2,4,5,6"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="p" id="dds_api_0030__p1869520171398">In case the automated backup policy is disabled:<pre class="codeblock" id="dds_api_0030__codeblock13695017797">{
|
|
"backup_policy": {
|
|
"keep_days": 0
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0030__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0030__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0030__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0030__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0030__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_backup_restore.html">Backup and Restoration</a></div>
|
|
</div>
|
|
</div>
|
|
|