doc-exports/docs/rds/api-ref/rds_05_0016.html
Wang , Deng Ke 21e968a153 rds api 2.0.38sp24 version
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>
2023-01-12 13:50:31 +00:00

100 lines
10 KiB
HTML

<a name="rds_05_0016"></a><a name="rds_05_0016"></a>
<h1 class="topictitle1">Configuring the Maintenance Window</h1>
<div id="body32001227"><div class="section" id="rds_05_0016__en-us_topic_0238844975_section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0016__en-us_topic_0238844975_p19142153232816">This API is used to change the maintenance window as required. To prevent service interruption, the maintenance window should fall within the off-peak hours.</p>
<ul id="rds_05_0016__en-us_topic_0238844975_ul12259155218373"><li id="rds_05_0016__en-us_topic_0238844975_en-us_topic_0110967248_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_05_0016__en-us_topic_0238844975_en-us_topic_0110967248_li1991981933613">Before calling this API, obtain the required <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">region and endpoint</a>.</li></ul>
</div>
<div class="section" id="rds_05_0016__en-us_topic_0238844975_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0016__en-us_topic_0238844975_ul53354139141429"><li id="rds_05_0016__en-us_topic_0238844975_li1270098217262">URI format<p id="rds_05_0016__en-us_topic_0238844975_p30251930154721"><a name="rds_05_0016__en-us_topic_0238844975_li1270098217262"></a><a name="en-us_topic_0238844975_li1270098217262"></a>PUT https://{<em id="rds_05_0016__en-us_topic_0238844975_i2475051121512">Endpoint</em>}/v3/{<em id="rds_05_0016__en-us_topic_0238844975_i148911057155316">project_id</em>}/instances/{<em id="rds_05_0016__en-us_topic_0238844975_i923712547">instance_id</em>}/ops-window</p>
</li></ul>
<ul id="rds_05_0016__en-us_topic_0238844975_ul49831254144655"><li id="rds_05_0016__en-us_topic_0238844975_li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0016__en-us_topic_0238844975_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0016__en-us_topic_0238844975_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="rds_05_0016__en-us_topic_0238844975_p34889605"><strong id="rds_05_0016__en-us_topic_0238844975_b136971420155019">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="rds_05_0016__en-us_topic_0238844975_p7485743"><strong id="rds_05_0016__en-us_topic_0238844975_b3712162105015">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="rds_05_0016__en-us_topic_0238844975_p2365466"><strong id="rds_05_0016__en-us_topic_0238844975_b2079252313504">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0016__en-us_topic_0238844975_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_05_0016__en-us_topic_0238844975_p17679057">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_05_0016__en-us_topic_0238844975_p22717550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_05_0016__en-us_topic_0238844975_p28182251">Specifies the project ID of a tenant in a region.</p>
<p id="rds_05_0016__en-us_topic_0238844975_p14611855135510">For details about how to obtain the project ID, see <a href="rds_03_0002.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="rds_05_0016__en-us_topic_0238844975_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="rds_05_0016__en-us_topic_0238844975_p41557789155220">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="rds_05_0016__en-us_topic_0238844975_p10737742155220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="rds_05_0016__en-us_topic_0238844975_p64450739155220">Specifies the DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_05_0016__en-us_topic_0238844975_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0016__en-us_topic_0238844975_ul5099287616954"><li id="rds_05_0016__en-us_topic_0238844975_li5628270116954">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0016__en-us_topic_0238844975_table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0016__en-us_topic_0238844975_row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="rds_05_0016__en-us_topic_0238844975_p17490046"><strong id="rds_05_0016__en-us_topic_0238844975_b1853144411504">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="rds_05_0016__en-us_topic_0238844975_p7407659"><strong id="rds_05_0016__en-us_topic_0238844975_b14639144412501">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="rds_05_0016__en-us_topic_0238844975_p63149496"><strong id="rds_05_0016__en-us_topic_0238844975_b0355124510502">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="rds_05_0016__en-us_topic_0238844975_p14835533"><strong id="rds_05_0016__en-us_topic_0238844975_b3329164611509">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0016__en-us_topic_0238844975_row60827539"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_05_0016__en-us_topic_0238844975_p28083633">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_05_0016__en-us_topic_0238844975_p60181840">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_05_0016__en-us_topic_0238844975_p42890904">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_05_0016__en-us_topic_0238844975_p4388917103812">Specifies the start time.</p>
<p id="rds_05_0016__p144363282818">The value must be a valid value in the "HH:MM" format. The current time is in the UTC format.</p>
</td>
</tr>
<tr id="rds_05_0016__en-us_topic_0238844975_row16585403499"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="rds_05_0016__en-us_topic_0238844975_p158515054915">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="rds_05_0016__en-us_topic_0238844975_p658513054918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="rds_05_0016__en-us_topic_0238844975_p115852015496">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="rds_05_0016__en-us_topic_0238844975_p335171319610">Specifies the end time.</p>
<p id="rds_05_0016__p21491226203613">The value must be a valid value in the "HH:MM" format. The current time is in the UTC format.</p>
<div class="note" id="rds_05_0016__en-us_topic_0238844975_note19771183819238"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="rds_05_0016__p14354195553014">The interval between the start time and end time must be four hours.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="rds_05_0016__ul21296187373"><li id="rds_05_0016__li4411135064210">Example<p id="rds_05_0016__p1454414211213"><a name="rds_05_0016__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ops-window</p>
</li></ul>
<ul id="rds_05_0016__en-us_topic_0238844975_ul18318676175816"><li id="rds_05_0016__en-us_topic_0238844975_li30650356175816">Request example<pre class="codeblock" id="rds_05_0016__en-us_topic_0238844975_codeblock4169151821715">{
"start_time": "22:00",
"end_time":"02:00"
}</pre>
</li></ul>
</div>
<div class="section" id="rds_05_0016__en-us_topic_0238844975_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0016__en-us_topic_0238844975_ul16665627"><li id="rds_05_0016__en-us_topic_0238844975_li15772917">Example normal response<pre class="codeblock" id="rds_05_0016__en-us_topic_0238844975_codeblock314170531760">{}</pre>
</li><li id="rds_05_0016__en-us_topic_0238844975_li68218279114">Abnormal response<p id="rds_05_0016__en-us_topic_0238844975_p28475059"><a name="rds_05_0016__en-us_topic_0238844975_li68218279114"></a><a name="en-us_topic_0238844975_li68218279114"></a>For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
</li></ul>
</div>
<div class="section" id="rds_05_0016__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0016__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0016__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0016__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0016__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_05_0016__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0016__en-us_topic_0032347778_p0723374409"><a name="rds_05_0016__en-us_topic_0032347778_li11583183218149"></a><a name="en-us_topic_0032347778_li11583183218149"></a>For details, see <a href="en-us_topic_0032488240.html">Status Codes</a>.</p>
</li></ul>
</div>
<div class="section" id="rds_05_0016__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0016__en-us_topic_0032347778_p19357163913406">For details, see <a href="en-us_topic_0032488241.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0056887470.html">DB Instance Management</a></div>
</div>
</div>