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>
89 lines
9.2 KiB
HTML
89 lines
9.2 KiB
HTML
<a name="EN-US_TOPIC_0000001917130696"></a><a name="EN-US_TOPIC_0000001917130696"></a>
|
|
|
|
<h1 class="topictitle1">Rebooting a DB Instance</h1>
|
|
<div id="body0000001266605793"><div class="section" id="EN-US_TOPIC_0000001917130696__en-us_topic_0128427215_section44230431101549"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000001917130696__en-us_topic_0128427215_p1350220403353">This API is used to reboot a DB instance. Before calling this API:</p>
|
|
<ul id="EN-US_TOPIC_0000001917130696__en-us_topic_0128427213_ul12259155218373"><li id="EN-US_TOPIC_0000001917130696__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_0000001917130696__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_0000001917130696__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_0000001917130696__section1065584185219"><h4 class="sectiontitle">Constraints</h4><p id="EN-US_TOPIC_0000001917130696__p1411733512256">The instance cannot reboot when it is being created, scaled, backed up, and restored.</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917130696__section1665514413522"><h4 class="sectiontitle">URI</h4><ul id="EN-US_TOPIC_0000001917130696__ul678017383810"><li id="EN-US_TOPIC_0000001917130696__en-us_topic_0248254028_li7794173834713">URI format<p id="EN-US_TOPIC_0000001917130696__p1365554111521"><a name="EN-US_TOPIC_0000001917130696__en-us_topic_0248254028_li7794173834713"></a><a name="en-us_topic_0248254028_li7794173834713"></a>POST https://{<em id="EN-US_TOPIC_0000001917130696__en-us_topic_0128427213_i1958383021511">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/restart</p>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001917130696__ul10251171635519"><li id="EN-US_TOPIC_0000001917130696__li198676491484">Example<p id="EN-US_TOPIC_0000001917130696__en-us_topic_0128427213_p1454414211213"><a name="EN-US_TOPIC_0000001917130696__li198676491484"></a><a name="li198676491484"></a>https://gaussdb.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/restart</p>
|
|
</li><li id="EN-US_TOPIC_0000001917130696__li142517165555">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130696__table19656441155216" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130696__row7656154111522"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.1.2.5.1.1"><p id="EN-US_TOPIC_0000001917130696__p865619419522">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.1.2.5.1.2"><p id="EN-US_TOPIC_0000001917130696__p16656104115211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.1.2.5.1.3"><p id="EN-US_TOPIC_0000001917130696__p665614113527">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.1.2.5.1.4"><p id="EN-US_TOPIC_0000001917130696__p16657204119524">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917130696__row1965619412520"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130696__p165717414528">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130696__p96571416524">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130696__p196579413523">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130696__en-us_topic_0128427215_p52580603101549">Project ID of a tenant in a region.</p>
|
|
<p id="EN-US_TOPIC_0000001917130696__p8544202712219">To obtain this value, see <a href="opengauss_api_0034.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0000001917130696__row465684185220"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.1.2.5.1.1 "><p id="EN-US_TOPIC_0000001917130696__p11657124119524">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.1.2.5.1.2 "><p id="EN-US_TOPIC_0000001917130696__p1465754185210">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.1.2.5.1.3 "><p id="EN-US_TOPIC_0000001917130696__p3658164118523">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.1.2.5.1.4 "><p id="EN-US_TOPIC_0000001917130696__p065817419522">DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917130696__section14894143404015"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0000001917130696__p1815362431617">None</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0000001917130696__section15662144115522"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0000001917130696__ul17292240155510"><li id="EN-US_TOPIC_0000001917130696__li1529213401557">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001917130696__response_JobId" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0000001917130696__row766274185219"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="EN-US_TOPIC_0000001917130696__p1663134135211">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="EN-US_TOPIC_0000001917130696__p176631341155214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="EN-US_TOPIC_0000001917130696__p196637413529">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0000001917130696__row1866214119525"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="EN-US_TOPIC_0000001917130696__p4663164175219">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="EN-US_TOPIC_0000001917130696__p1566314115216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="EN-US_TOPIC_0000001917130696__p17663541115213">Task ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="EN-US_TOPIC_0000001917130696__en-us_topic_0248254028_ul1135712981319"><li id="EN-US_TOPIC_0000001917130696__en-us_topic_0248254028_li735719919138">Example normal response<pre class="codeblock" id="EN-US_TOPIC_0000001917130696__en-us_topic_0248254028_codeblock053262517133">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<ul id="EN-US_TOPIC_0000001917130696__ul188115303381"><li id="EN-US_TOPIC_0000001917130696__li5811133003820">Abnormal response<p id="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0128427213_p29415884"><a name="EN-US_TOPIC_0000001917130696__li5811133003820"></a><a name="li5811133003820"></a>For details, see <a href="opengauss_api_0031.html">Abnormal Request Results</a>.</p>
|
|
</li></ul>
|
|
<div class="section" id="EN-US_TOPIC_0000001917130696__en-us_topic_0248254028_section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_ul7858132212142"><li id="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411">Normal<p id="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_p1040982941020"><a name="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a><a name="en-us_topic_0000001704033841_en-us_topic_0110967248_li58581622171411"></a>202</p>
|
|
</li><li id="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149">Abnormal<p id="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_p65078394148"><a name="EN-US_TOPIC_0000001917130696__en-us_topic_0000001704033841_en-us_topic_0110967248_li11583183218149"></a><a name="en-us_topic_0000001704033841_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_0000001917130696__en-us_topic_0248254028_section946032144017"><h4 class="sectiontitle">Error Code</h4><p id="EN-US_TOPIC_0000001917130696__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_0014.html">Instance Management</a></div>
|
|
</div>
|
|
</div>
|
|
|