forked from docs/doc-exports
wangdengke2
87153b4b9b
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
128 lines
9.6 KiB
HTML
128 lines
9.6 KiB
HTML
<a name="dds_api_023"></a><a name="dds_api_023"></a>
|
|
|
|
<h1 class="topictitle1">Configuring the Maintenance Window</h1>
|
|
<div id="body0000002382220405"><div class="section" id="dds_api_023__section4894192115617"><h4 class="sectiontitle">API Description</h4><p id="dds_api_023__p16920121163312">This API is used to modify the time range within which you are allowed to start a task that affects the running of database instances, for example, the time window for upgrading the operating system and database software.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_023__section1389616295612"><h4 class="sectiontitle">URI</h4><ul id="dds_api_023__ul63761938728"><li id="dds_api_023__li7376938129">URI format<div class="p" id="dds_api_023__p1992112117336"><a name="dds_api_023__li7376938129"></a><a name="li7376938129"></a>PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/maintenance-window
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_023__table267516571302" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="dds_api_023__row1674195717302"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.1.1.1.2.5.1.1"><p id="dds_api_023__p16741557113013">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.1.1.1.2.5.1.2"><p id="dds_api_023__p19674135743018">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.1.1.1.2.5.1.3"><p id="dds_api_023__p1567415753014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.2.1.1.1.2.5.1.4"><p id="dds_api_023__p5674195714306">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_023__row8675105713018"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.1.1.1.2.5.1.1 "><p id="dds_api_023__p106759573307">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.1.1.1.2.5.1.2 "><p id="dds_api_023__p186751357103018">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.1.1.1.2.5.1.3 "><p id="dds_api_023__p76754579306">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.1.1.1.2.5.1.4 "><p id="dds_api_023__p99592512291">Project ID of a tenant in a region. To obtain the project ID, see <a href="dds_projectid.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_023__row4675057113013"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.1.1.1.2.5.1.1 "><p id="dds_api_023__p19675135713014">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.1.1.1.2.5.1.2 "><p id="dds_api_023__p9675357153015">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.1.1.1.2.5.1.3 "><p id="dds_api_023__p1567505793012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.1.1.1.2.5.1.4 "><p id="dds_api_023__p89601054291">Instance ID, which can be obtained by calling the API described in <a href="dds_api_0023.html">Querying Instances and Details</a>. If you do not have an instance, call the API described in <a href="dds_api_0020.html">Creating a DB Instance</a> to create one.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_023__section187659393189"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_023__ul115201842123419"><li id="dds_api_023__li8520104293418">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_023__table3520114273420" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="dds_api_023__row2052014427345"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="dds_api_023__p1952084233420">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="dds_api_023__p18520142163419">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="dds_api_023__p17520204214349">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="dds_api_023__p1752034273414">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_023__row1857664812619"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_023__en-us_topic_0121682347_p118689123320">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_023__p89881555713">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_023__p15324829816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_023__p15921049874">Specifies the MIME type of the request body. You are advised to use the default value <strong id="dds_api_023__b79211649670">application/json</strong>. For APIs used to upload objects or images, the value can vary depending on the flow type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_023__row252012424344"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="dds_api_023__p1520134253410">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="dds_api_023__p9520242113417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="dds_api_023__p1520174243418">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="dds_api_023__p19520194203414">User token obtained from IAM. For details, see <a href="dds_api_0010.html">Authentication</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="p" id="dds_api_023__p9521164213345">
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_023__table2521442163413" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="dds_api_023__row13521342173418"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.1.2.5.1.1"><p id="dds_api_023__p195211742203411">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.1.2.5.1.2"><p id="dds_api_023__p5521144273412">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.1.2.1.2.5.1.3"><p id="dds_api_023__p16521842153420">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.1.2.1.2.5.1.4"><p id="dds_api_023__p1952114218345">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_023__row19521542183415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="dds_api_023__p175212426343">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="dds_api_023__p155214427349">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="dds_api_023__p19521114213414">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><p id="dds_api_023__p9291047161811">Start time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time. The value cannot be the same as the end time. Gap between "start_time" and "end_time" must be at least 1h.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_023__row35211142193415"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.1.2.5.1.1 "><p id="dds_api_023__p1752118428342">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.1.2.5.1.2 "><p id="dds_api_023__p45211742193410">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.1.2.1.2.5.1.3 "><p id="dds_api_023__p1552164217349">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.1.2.1.2.5.1.4 "><p id="dds_api_023__p252184293414">End time. The value must be a valid value in the "HH:MM" format. The current time is the UTC time. The value cannot be the same as the start time. Gap between "start_time" and "end_time" must be at least 1h.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
</li><li id="dds_api_023__li152813314112">Example request<p id="dds_api_023__p84639227418"><a name="dds_api_023__li152813314112"></a><a name="li152813314112"></a>Configuring the maintenance window</p>
|
|
<pre class="screen" id="dds_api_023__screen1046310228419">{
|
|
"start_time" : "14:00",
|
|
"end_time" : "15:00"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_023__section1515174210544"><h4 class="sectiontitle">Responses</h4><p id="dds_api_023__p0817328184110">None</p>
|
|
</div>
|
|
<div class="section" id="dds_api_023__section10950024562"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_023__p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_023__p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_023__section8954192115620"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_023__en-us_topic_0122053819_p20466124120334">For details, see <a href="dds_error_code.html">Error Code</a>.</p>
|
|
</div>
|
|
<p id="dds_api_023__p15550175313116"></p>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|