forked from docs/doc-exports
Ru, Li Yi
d97aea4dd2
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com> Co-authored-by: Ru, Li Yi <liyiru7@huawei.com> Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
208 lines
23 KiB
HTML
208 lines
23 KiB
HTML
<a name="EN-US_TOPIC_0000001917290732"></a><a name="EN-US_TOPIC_0000001917290732"></a>
|
|
|
|
<h1 class="topictitle1">Configuring an Automated Backup Policy</h1>
|
|
<div id="body0000001161647854"><div class="section" id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_section2161131714317"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_p1779463834710">This API is used to configure an automated backup policy. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li3231171417412">Learn how to <a href="opengauss_api_0010.html">authenticate</a> this API.</li><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0000001917290508_en-us_topic_0000001791349281_li41227910453">Understand the API in <a href="opengauss_api_0012.html">Using APIs</a>.</li><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0000001917290508_en-us_topic_0000001791349281_en-us_topic_0110967248_li1991981933613">Obtain the required <a href="https://docs.otc.t-systems.com/regions-and-endpoints/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_section1832017411437"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_ul1794193834712"><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_p8795103874717"><a name="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>PUT https://{<em id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{<em id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_i8287192519110">project_id</em>}/instances/{<em id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_i575217298119">instance_id</em>}/backups/policy</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_li4411135064210">Example<p id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_p1454414211213"><a name="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_li4411135064210"></a><a name="en-us_topic_0248254028_li4411135064210"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/backups/policy</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290732__li175510491623">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_table1986313483146" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_row158631348151416"><th align="left" class="cellrowborder" valign="top" width="22.79%" id="mcps1.3.2.2.3.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_p178635485145"><strong id="EN-US_TOPIC_0000001917290732__b6754925123213">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.880000000000003%" id="mcps1.3.2.2.3.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_p586384819144"><strong id="EN-US_TOPIC_0000001917290732__b15891132683214">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.330000000000005%" id="mcps1.3.2.2.3.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_p3863164871419"><strong id="EN-US_TOPIC_0000001917290732__b1665062918321">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290732__row153821619455"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427214_p49532829">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427214_p52736237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290732__p19528455451">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p95284517457">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row103812684518"><td class="cellrowborder" valign="top" width="22.79%" headers="mcps1.3.2.2.3.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427214_p1046217474614">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.880000000000003%" headers="mcps1.3.2.2.3.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427214_p246284104619">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.330000000000005%" headers="mcps1.3.2.2.3.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917290732__p2201242204518">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_section1265133172714"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_ul1387512325219"><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_li387592375220">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_table477719232522" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_row118759235520"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_p1587542375213"><strong id="EN-US_TOPIC_0000001917290732__b96681836103218">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_p287512375212"><strong id="EN-US_TOPIC_0000001917290732__b2526137173219">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.75%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_p8875152313526"><strong id="EN-US_TOPIC_0000001917290732__b16421173811323">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.76%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_p198753239523"><strong id="EN-US_TOPIC_0000001917290732__b1599754063217">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_row1387582319526"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_p9875523185210">backup_policy</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_p168751823115220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.75%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0151958051_a9a9492e05cb648e885d1e747a339d04d">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.76%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p880314236313">Backup policy information.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p4803152317314">For details, see <a href="#EN-US_TOPIC_0000001917290732__table365210374319">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001917290732__table365210374319"></a><a name="table365210374319"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917290732__table365210374319" frame="border" border="1" rules="all"><caption><b>Table 3 </b>backup_policy field data structure description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917290732__row1865263714316"><th align="left" class="cellrowborder" valign="top" width="24.81%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0000001917290732__p665214379318"><strong id="EN-US_TOPIC_0000001917290732__b445595515322">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.68%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0000001917290732__p2652637103113"><strong id="EN-US_TOPIC_0000001917290732__b117517120334">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.73%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0000001917290732__p76521937143110"><strong id="EN-US_TOPIC_0000001917290732__b6376318331">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="36.78%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0000001917290732__p36522037143116"><strong id="EN-US_TOPIC_0000001917290732__b31468673311">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917290732__row9652193733112"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p1265283703111">keep_days</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p1865223753116">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p196521437173113">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p3652113711312">Backup retention days</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p12641612193415">The value ranges from 1 to 732.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row380011963416"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p1580061983412">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p480181917347">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p2080181915346">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p4801419183414">Backup time window. The creation of an automated backup will be triggered during the backup time window.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p48167350348">The value cannot be empty. It must be a valid value in the "hh:mm-HH:MM" format. The current time is in the UTC format.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p1842354183418">The value of <strong id="EN-US_TOPIC_0000001917290732__b159042311337">HH</strong> must be 1 greater than the value of <strong id="EN-US_TOPIC_0000001917290732__b1259062353311">hh</strong>. The values of <strong id="EN-US_TOPIC_0000001917290732__b1859014235339">mm</strong> and <strong id="EN-US_TOPIC_0000001917290732__b155911723173313">MM</strong> must be the same and must be <strong id="EN-US_TOPIC_0000001917290732__b159111230336">00</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p20138141211357">Example value:</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p11138201213516">21:00-22:00</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row89047171354"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p1890501783510">period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p9905111712351">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p179051217113510">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p1305123963517">Full backup period. An automated full backup will be created on the specified days of the week.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p20664114619350">The value is a number separated by commas (,), indicating the days of the week. For example, <strong id="EN-US_TOPIC_0000001917290732__b5533120143417">1,2,3,4</strong> indicates that the backup period is Monday, Tuesday, Wednesday, and Thursday.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row5883114123612"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p128831014103616">differential_period</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p11883414193613">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p17883161412363">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p1788320141368">Differential backup interval. Interval for automatic differential backup.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p8901638183619">Its value can be <strong id="EN-US_TOPIC_0000001917290732__b2841191333517">15</strong>, <strong id="EN-US_TOPIC_0000001917290732__b498221716357">30</strong>, <strong id="EN-US_TOPIC_0000001917290732__b090362063513">60</strong>, <strong id="EN-US_TOPIC_0000001917290732__b2743102312351">180</strong>, <strong id="EN-US_TOPIC_0000001917290732__b145211926183519">360</strong>, <strong id="EN-US_TOPIC_0000001917290732__b4905233163514">720</strong>, or <strong id="EN-US_TOPIC_0000001917290732__b7128042153510">1440</strong>. The unit is minute.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p1648184963613">Example value: 30</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row078115517453"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p17816519457">rate_limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p1978116516458">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p6781155110458">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p8781145114518">Upload speed at which data is uploaded to OBS. <strong id="EN-US_TOPIC_0000001917290732__b427114597504">0 MB/s</strong> indicates that the speed is not limited. The upload speed is related to the bandwidth.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p2078783314488">Value range: <strong id="EN-US_TOPIC_0000001917290732__b0278641124711">0</strong>-<strong id="EN-US_TOPIC_0000001917290732__b1527910418470">1024</strong></p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p127871833194816">Minimum value: <strong id="EN-US_TOPIC_0000001917290732__b3829744204717">0</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row556204694814"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p1157184620485">prefetch_block</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p185704613481">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p1157134613486">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p757124613484">Number of prefetch pages from the modified pages in the disk table file during a differential backup. When modified pages are adjacent (for example, with a bulk data load), you can set this parameter to a large value. When modified pages are scattered (for example, random update), you can set this parameter to a small value. The default value is <strong id="EN-US_TOPIC_0000001917290732__b17818894410">64</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p1056821713496">Value: <strong id="EN-US_TOPIC_0000001917290732__b20194172214445">1</strong> to <strong id="EN-US_TOPIC_0000001917290732__b1619412229440">8192</strong></p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p456821724918">Minimum value: <strong id="EN-US_TOPIC_0000001917290732__b51917334443">1</strong>.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p135681617184911">Maximum value: <strong id="EN-US_TOPIC_0000001917290732__b2144736144417">8192</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row1982127134916"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p1821027204919">file_split_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p1082112717492">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p882202724913">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p1382142713491">Size by which full and differential backup files are split, in GB. The value is from <strong id="EN-US_TOPIC_0000001917290732__b740119483449">0</strong> to <strong id="EN-US_TOPIC_0000001917290732__b8401748174412">1024</strong>, but it must be a multiple of 4. The default value is <strong id="EN-US_TOPIC_0000001917290732__b1240104874415">4</strong>. <strong id="EN-US_TOPIC_0000001917290732__b13401194819444">0</strong> indicates the size is not limited.</p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p2038516591493">Value range: <strong id="EN-US_TOPIC_0000001917290732__b669322184517">0</strong>-<strong id="EN-US_TOPIC_0000001917290732__b169112220452">1024</strong></p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p538555919497">Minimum value: <strong id="EN-US_TOPIC_0000001917290732__b9818122820453">0</strong></p>
|
|
<p id="EN-US_TOPIC_0000001917290732__p14385145911498">Maximum value: <strong id="EN-US_TOPIC_0000001917290732__b1734713013450">1024</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row181475321343"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p2147183220340">filesplit_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p0147143214349">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p15346133714355">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p9147183243411">Size by which full and differential backup files are split. Deprecated field. Leave it blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917290732__row1613498151115"><td class="cellrowborder" valign="top" width="24.81%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0000001917290732__p111351283111">enable_standby_backup</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.68%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0000001917290732__p713517819119">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.73%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0000001917290732__p813515819110">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="36.78%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0000001917290732__p171351188111">Whether to enable backup on a standby node. (It is not suitable for single-node instances and instances earlier than 3.100.0.)</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290732__section33901111517"><h4 class="sectiontitle">Example Request</h4><div class="p" id="EN-US_TOPIC_0000001917290732__p1221253012818">Configuring a backup policy for GaussDB (Set backup retention period to seven days and backup time window to 19:00-20:00)<pre class="screen" id="EN-US_TOPIC_0000001917290732__screen6685332513">{
|
|
"backup_policy": {
|
|
"keep_days": 7,
|
|
"start_time": "19:00-20:00",
|
|
"period": "1,2,3,4,5",
|
|
"differential_period": "30",
|
|
"rate_limit": 75 ,
|
|
"prefetch_block": 64 ,
|
|
"file_split_size": 4 ,
|
|
"enable_standby_backup" : false
|
|
}
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_section415313301118"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917290732__ul31923327101549"><li id="EN-US_TOPIC_0000001917290732__li18874490101549">Normal response<p id="EN-US_TOPIC_0000001917290732__p7836161173816"><a name="EN-US_TOPIC_0000001917290732__li18874490101549"></a><a name="li18874490101549"></a>None</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290732__li27619632">Example normal response<p id="EN-US_TOPIC_0000001917290732__p16326175519525"><a name="EN-US_TOPIC_0000001917290732__li27619632"></a><a name="li27619632"></a>{}</p>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_li2072718551485">Abnormal response<p id="EN-US_TOPIC_0000001917290732__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_li2072718551485"></a><a name="en-us_topic_0248254028_li2072718551485"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290732__en-us_topic_0128427213_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0110967248_li58581622171411"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917290732__en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0110967248_li11583183218149"></a>For details, see <a href="opengauss_api_0032.html">Status Codes</a>.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917290732__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917290732__en-us_topic_0000001704033841_en-us_topic_0110967248_p19357163913406">For details, see <a href="opengauss_api_0033.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="opengauss_api_0025.html">Backup Management</a></div>
|
|
</div>
|
|
</div>
|
|
|