forked from docs/doc-exports
Wang , Deng Ke
5208dcae7b
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>
149 lines
12 KiB
HTML
149 lines
12 KiB
HTML
<a name="en-us_topic_0034943368"></a><a name="en-us_topic_0034943368"></a>
|
|
|
|
<h1 class="topictitle1">Rebooting a DB Instance</h1>
|
|
<div id="body1470368157651"><div class="section" id="en-us_topic_0034943368__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0034943368__p52780252141331">This API is used to reboot a DB instance.</p>
|
|
<div class="notice" id="en-us_topic_0034943368__note19647914151512"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="en-us_topic_0034943368__p757016191831">The RDS DB instance will be unavailable during the reboot process. Exercise caution when performing this operation.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943368__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0034943368__ul53354139141429"><li id="en-us_topic_0034943368__li1270098217262">URI format<p id="en-us_topic_0034943368__p66079617141421"><a name="en-us_topic_0034943368__li1270098217262"></a><a name="li1270098217262"></a>PATH: /rds/v1/{project_id}/instances/{instanceId}/action</p>
|
|
<p id="en-us_topic_0034943368__p30251930154721">Method: POST</p>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034943368__ul49831254144655"><li id="en-us_topic_0034943368__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943368__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943368__row60083059"><th align="left" class="cellrowborder" valign="top" width="21.86%" id="mcps1.3.2.3.1.1.2.4.1.1"><p id="en-us_topic_0034943368__p34889605"><strong id="en-us_topic_0034943368__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.939999999999998%" id="mcps1.3.2.3.1.1.2.4.1.2"><p id="en-us_topic_0034943368__p7485743"><strong id="en-us_topic_0034943368__b842352706102346_1">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.2%" id="mcps1.3.2.3.1.1.2.4.1.3"><p id="en-us_topic_0034943368__p2365466"><strong id="en-us_topic_0034943368__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943368__row57385070"><td class="cellrowborder" valign="top" width="21.86%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="en-us_topic_0034943368__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.939999999999998%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="en-us_topic_0034943368__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.2%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="en-us_topic_0034943368__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0034943368__row2864326155157"><td class="cellrowborder" valign="top" width="21.86%" headers="mcps1.3.2.3.1.1.2.4.1.1 "><p id="en-us_topic_0034943368__p41557789155220">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.939999999999998%" headers="mcps1.3.2.3.1.1.2.4.1.2 "><p id="en-us_topic_0034943368__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.2%" headers="mcps1.3.2.3.1.1.2.4.1.3 "><p id="en-us_topic_0034943368__p7417132564016">Specifies the primary node ID of the DB instance.</p>
|
|
<div class="note" id="en-us_topic_0034943368__note18250133224019"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="en-us_topic_0034943368__p142501332164011">This field is not the DB instance ID. You are advised to use API v3 and the DB instance ID to perform related operations.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0034943368__li61827782155332">Restrictions<p id="en-us_topic_0034943368__p4434302416126"><a name="en-us_topic_0034943368__li61827782155332"></a><a name="li61827782155332"></a>The DB instance cannot reboot when it is being created, scaled, backed up, restored, or its instance class is being changed.</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943368__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0034943368__ul5099287616954"><li id="en-us_topic_0034943368__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943368__table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943368__row61525259"><th align="left" class="cellrowborder" valign="top" width="23.14%" id="mcps1.3.3.2.1.1.2.5.1.1"><p id="en-us_topic_0034943368__p17490046"><strong id="en-us_topic_0034943368__b84235270691445_5">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.86%" id="mcps1.3.3.2.1.1.2.5.1.2"><p id="en-us_topic_0034943368__p7407659"><strong id="en-us_topic_0034943368__b842352706102346_5">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.3"><p id="en-us_topic_0034943368__p63149496"><strong id="en-us_topic_0034943368__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.1.2.5.1.4"><p id="en-us_topic_0034943368__p14835533"><strong id="en-us_topic_0034943368__b842352706163417_5">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943368__row60827539"><td class="cellrowborder" valign="top" width="23.14%" headers="mcps1.3.3.2.1.1.2.5.1.1 "><p id="en-us_topic_0034943368__p28083633">restart</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.86%" headers="mcps1.3.3.2.1.1.2.5.1.2 "><p id="en-us_topic_0034943368__p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.3 "><p id="en-us_topic_0034943368__p42890904">None</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.1.2.5.1.4 "><p id="en-us_topic_0034943368__p49586916144357">This parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034943368__ul18318676175816"><li id="en-us_topic_0034943368__li30650356175816">Request example<pre class="codeblock" id="en-us_topic_0034943368__codeblock26701898174649">{
|
|
"restart": {}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943368__section28521534113742"><h4 class="sectiontitle">Normal Response</h4><ul id="en-us_topic_0034943368__ul12573920"><li id="en-us_topic_0034943368__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943368__table11854613" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="en-us_topic_0034943368__row48728718"><th align="left" class="cellrowborder" valign="top" width="24.122412241224122%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="en-us_topic_0034943368__p54712068"><strong id="en-us_topic_0034943368__b84235270691445_7">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.544254425442546%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="en-us_topic_0034943368__p2492560"><strong id="en-us_topic_0034943368__b842352706164541_3">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="en-us_topic_0034943368__p570775"><strong id="en-us_topic_0034943368__b842352706163417_7">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943368__row46232835"><td class="cellrowborder" valign="top" width="24.122412241224122%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="en-us_topic_0034943368__p53872188">extendparam</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.544254425442546%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="en-us_topic_0034943368__p1571113">Dictionary data structure. For details, see <a href="#en-us_topic_0034943368__table52869820">Table 4</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="en-us_topic_0034943368__p4491214">Indicates the returned <strong id="en-us_topic_0034943368__b842352706113519">extendparam</strong> key-value pair.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0034943368__table52869820"></a><a name="table52869820"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943368__table52869820" frame="border" border="1" rules="all"><caption><b>Table 4 </b>extendparam field data structure description</caption><thead align="left"><tr id="en-us_topic_0034943368__row50931783"><th align="left" class="cellrowborder" valign="top" width="23.932393239323936%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="en-us_topic_0034943368__p31833731"><strong id="en-us_topic_0034943368__b84235270691445_9">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="42.734273427342735%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="en-us_topic_0034943368__p28395444"><strong id="en-us_topic_0034943368__b842352706164541_5">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="en-us_topic_0034943368__p18329666"><strong id="en-us_topic_0034943368__b842352706163417_9">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943368__row8307988"><td class="cellrowborder" valign="top" width="23.932393239323936%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="en-us_topic_0034943368__p1858451">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="42.734273427342735%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="en-us_topic_0034943368__p16316838">List data structure. For details, see <a href="#en-us_topic_0034943368__table32267243">Table 5</a>.</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="en-us_topic_0034943368__p16706408">Indicates the returned <strong id="en-us_topic_0034943368__b842352706113940">jobs</strong> parameter information.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="en-us_topic_0034943368__table32267243"></a><a name="table32267243"></a><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0034943368__table32267243" frame="border" border="1" rules="all"><caption><b>Table 5 </b>jobs field data structure description</caption><thead align="left"><tr id="en-us_topic_0034943368__row9230088"><th align="left" class="cellrowborder" valign="top" width="24.69%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="en-us_topic_0034943368__p9439626"><strong id="en-us_topic_0034943368__b84235270691445_11">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="41.980000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="en-us_topic_0034943368__p26412257"><strong id="en-us_topic_0034943368__b842352706164541_7">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="en-us_topic_0034943368__p59018101"><strong id="en-us_topic_0034943368__b842352706163417_11">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0034943368__row15736877"><td class="cellrowborder" valign="top" width="24.69%" headers="mcps1.3.4.2.1.3.2.4.1.1 "><p id="en-us_topic_0034943368__p66727538">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="41.980000000000004%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="en-us_topic_0034943368__p36221483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="en-us_topic_0034943368__p48259009">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="en-us_topic_0034943368__ul16665627"><li id="en-us_topic_0034943368__li15772917">Response example<pre class="codeblock" id="en-us_topic_0034943368__codeblock314170531760">{
|
|
"extendparam": {
|
|
"jobs": [
|
|
{
|
|
"id": "2b414788-a600-4883-a023-90e2eb0ea227"
|
|
}
|
|
]
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0034943368__section51597550"><h4 class="sectiontitle">Abnormal Response</h4><p id="en-us_topic_0034943368__p28475059">For details, see <a href="en-us_topic_0032488197.html">Abnormal Request Results</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rds_06_0016.html">DB Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|