forked from docs/doc-exports
Ru, Li Yi
9457035d64
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>
112 lines
9.5 KiB
HTML
112 lines
9.5 KiB
HTML
<a name="rds_06_0003"></a><a name="rds_06_0003"></a>
|
|
|
|
<h1 class="topictitle1">Rebooting a DB Instance</h1>
|
|
<div id="body1544170274118"><div class="section" id="rds_06_0003__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_06_0003__p52780252141331">This API is used to reboot a DB instance.</p>
|
|
<ul id="rds_06_0003__ul12259155218373"><li id="rds_06_0003__en-us_topic_0240111818_li836513175363">Before calling an API, you need to understand the API in <a href="rds_03_0001.html">Authentication</a>.</li><li id="rds_06_0003__en-us_topic_0240111818_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 class="notice" id="rds_06_0003__note19647914151512"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="rds_06_0003__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="rds_06_0003__section9207631102915"><h4 class="sectiontitle">Constraints</h4><p id="rds_06_0003__p231193123811">The DB instance cannot reboot when it is being created, scaled, backed up, restored, or its instance class or port is being changed.</p>
|
|
</div>
|
|
<div class="section" id="rds_06_0003__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_06_0003__ul53354139141429"><li id="rds_06_0003__li1270098217262">URI format<p id="rds_06_0003__p30251930154721"><a name="rds_06_0003__li1270098217262"></a><a name="li1270098217262"></a>POST https://{<em id="rds_06_0003__i2475051121512">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/action</p>
|
|
</li></ul>
|
|
<ul id="rds_06_0003__ul49831254144655"><li id="rds_06_0003__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0003__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_06_0003__row60083059"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_06_0003__p34889605"><strong id="rds_06_0003__b84235270691445">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_06_0003__p7485743"><strong id="rds_06_0003__b2839234163213">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_06_0003__p2365466"><strong id="rds_06_0003__b842352706163417">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0003__row57385070"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_06_0003__p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_06_0003__p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_06_0003__p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_06_0003__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_06_0003__row2864326155157"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_06_0003__p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_06_0003__p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_06_0003__p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_06_0003__section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_06_0003__ul5099287616954"><li id="rds_06_0003__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0003__table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_06_0003__row61525259"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_06_0003__p17490046"><strong id="rds_06_0003__b84235270691445_1">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_06_0003__p7407659"><strong id="rds_06_0003__b889383483218">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_06_0003__p63149496"><strong id="rds_06_0003__b842352706164541">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_06_0003__p14835533"><strong id="rds_06_0003__b842352706163417_1">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0003__row60827539"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_06_0003__p28083633">restart</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_06_0003__p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_06_0003__p42890904">None</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_06_0003__p49586916144357">This parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_06_0003__ul92711537102715"><li id="rds_06_0003__li4411135064210">Example<p id="rds_06_0003__p1454414211213"><a name="rds_06_0003__li4411135064210"></a><a name="li4411135064210"></a>POST https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/action</p>
|
|
</li></ul>
|
|
<ul id="rds_06_0003__ul18318676175816"><li id="rds_06_0003__li30650356175816">Request example<pre class="codeblock" id="rds_06_0003__codeblock26701898174649">{
|
|
"restart": {}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_06_0003__section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_06_0003__ul12573920"><li id="rds_06_0003__li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_06_0003__table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_06_0003__row9230088"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="rds_06_0003__p9439626"><strong id="rds_06_0003__b84235270691445_2">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="rds_06_0003__p26412257"><strong id="rds_06_0003__b842352706164541_1">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="rds_06_0003__p59018101"><strong id="rds_06_0003__b842352706163417_2">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_06_0003__row15736877"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_06_0003__p66727538">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="rds_06_0003__p36221483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="rds_06_0003__p48259009">Indicates the task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_06_0003__ul16665627"><li id="rds_06_0003__li15772917">Example normal response<pre class="codeblock" id="rds_06_0003__codeblock314170531760">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li><li id="rds_06_0003__li68218279114">Abnormal Response<p id="rds_06_0003__p28475059"><a name="rds_06_0003__li68218279114"></a><a name="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_06_0003__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_06_0003__rds_01_0002_en-us_topic_0032347778_ul7858132212142"><li id="rds_06_0003__rds_01_0002_en-us_topic_0032347778_li58581622171411">Normal<p id="rds_06_0003__rds_01_0002_en-us_topic_0032347778_p1040982941020"><a name="rds_06_0003__rds_01_0002_en-us_topic_0032347778_li58581622171411"></a><a name="rds_01_0002_en-us_topic_0032347778_li58581622171411"></a>202</p>
|
|
</li><li id="rds_06_0003__rds_01_0002_en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_06_0003__rds_01_0002_en-us_topic_0032347778_p0723374409"><a name="rds_06_0003__rds_01_0002_en-us_topic_0032347778_li11583183218149"></a><a name="rds_01_0002_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_06_0003__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_06_0003__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>
|
|
|