forked from docs/doc-exports
Ru, Li Yi
48f239743a
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>
87 lines
11 KiB
HTML
87 lines
11 KiB
HTML
<a name="rds_05_0025"></a><a name="rds_05_0025"></a>
|
|
|
|
<h1 class="topictitle1">Stopping an Instance</h1>
|
|
<div id="body0000001372665913"><div class="section" id="rds_05_0025__en-us_topic_0000001209984756_section4850156117316"><h4 class="sectiontitle">Function</h4><p id="rds_05_0025__en-us_topic_0000001209984756_p5753583532">This API is used to stop a pay-per-use DB instance. The instance can be stopped for up to seven days.</p>
|
|
<ul id="rds_05_0025__en-us_topic_0293125646_ul12259155218373"><li id="rds_05_0025__en-us_topic_0293125646_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_0025__en-us_topic_0293125646_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_0025__en-us_topic_0000001209984756_section8749123851810"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0025__en-us_topic_0000001209984756_ul898620351104"><li id="rds_05_0025__en-us_topic_0000001269177305_li11986203514101">This API is supported for MySQL and PostgreSQL DB engines.</li><li id="rds_05_0025__en-us_topic_0000001209984756_li1398653513106">If you stop a primary instance, read replicas (if there are any) will also be stopped. They are stopped for up to seven days. You cannot stop a read replica without stopping the primary instance.</li><li id="rds_05_0025__en-us_topic_0000001209984756_li1998653551019">A stopped MySQL DB instance will not be moved to the recycle bin after being deleted.</li><li id="rds_05_0025__li1884112515133">A stopped PostgreSQL DB instance cannot be deleted.</li><li id="rds_05_0025__en-us_topic_0000001209984756_li149865358104">If you do not manually start your stopped DB instance after seven days, your DB instance is automatically started during the next maintenance window.</li><li id="rds_05_0025__en-us_topic_0000001209984756_li14986935141010">After an instance is stopped, the ECS is no longer billed. Other resources, including EIPs, storage resources, and backups, are still billed.</li><li id="rds_05_0025__en-us_topic_0000001209984756_li10986535101011">An instance cannot be stopped if it is in any of the following statuses:<p id="rds_05_0025__p18470427131012"><a name="rds_05_0025__en-us_topic_0000001209984756_li10986535101011"></a><a name="en-us_topic_0000001209984756_li10986535101011"></a>Creating, rebooting, scaling up, changing instance class, restoring, and changing port</p>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0025__en-us_topic_0000001209984756_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0025__en-us_topic_0000001209984756_ul53354139141429"><li id="rds_05_0025__en-us_topic_0000001209984756_li1270098217262">URI format<p id="rds_05_0025__en-us_topic_0000001209984756_p66079617141421"><a name="rds_05_0025__en-us_topic_0000001209984756_li1270098217262"></a><a name="en-us_topic_0000001209984756_li1270098217262"></a>POST https://{<em id="rds_05_0025__en-us_topic_0000001209984756_i86129260155">Endpoint</em>}/v3/{project_id}/instances/{instance_id}/action/shutdown</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0025__en-us_topic_0000001209984756_ul49831254144655"><li id="rds_05_0025__en-us_topic_0000001209984756_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0025__en-us_topic_0000001209984756_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0025__en-us_topic_0000001209984756_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.979999999999997%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_05_0025__en-us_topic_0000001209984756_p34889605"><strong id="rds_05_0025__b8137733151">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.55%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_05_0025__en-us_topic_0000001209984756_p7485743"><strong id="rds_05_0025__b73781236256">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.470000000000006%" id="mcps1.3.3.3.1.1.2.4.1.3"><p id="rds_05_0025__en-us_topic_0000001209984756_p2365466"><strong id="rds_05_0025__b31073384515">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0025__en-us_topic_0000001209984756_row57385070"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0025__en-us_topic_0000001209984756_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0025__en-us_topic_0000001209984756_p22717550">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0025__en-us_topic_0000001209984756_p28182251">Project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0025__en-us_topic_0000001209984756_p181691757183820">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_0025__en-us_topic_0000001209984756_row2864326155157"><td class="cellrowborder" valign="top" width="20.979999999999997%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0025__en-us_topic_0000001209984756_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.55%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0025__en-us_topic_0000001209984756_p10737742155220">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.470000000000006%" headers="mcps1.3.3.3.1.1.2.4.1.3 "><p id="rds_05_0025__en-us_topic_0000001209984756_p981962520456">Instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0025__en-us_topic_0000001209984756_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0025__en-us_topic_0000001209984756_ul19618193651111"><li id="rds_05_0025__en-us_topic_0000001209984756_li16189364119">Parameter description<p id="rds_05_0025__en-us_topic_0000001209984756_p185221257337"><a name="rds_05_0025__en-us_topic_0000001209984756_li16189364119"></a><a name="en-us_topic_0000001209984756_li16189364119"></a>None</p>
|
|
</li><li id="rds_05_0025__en-us_topic_0000001209984756_li4411135064210">Example<p id="rds_05_0025__en-us_topic_0000001209984756_p1454414211213"><a name="rds_05_0025__en-us_topic_0000001209984756_li4411135064210"></a><a name="en-us_topic_0000001209984756_li4411135064210"></a>POST https://rds.eu-de.otc.t-systems.com/v3/054ea741f700d4a32f1bc00f5c80dd4c/instances/5b409baece064984a1b3eef6addae50cin01/action/shutdown</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0025__en-us_topic_0000001209984756_ul9619143618117"><li id="rds_05_0025__en-us_topic_0000001209984756_li461923631120">Request example<pre class="codeblock" id="rds_05_0025__en-us_topic_0000001209984756_codeblock06198367118">{}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0025__en-us_topic_0000001209984756_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0025__en-us_topic_0000001209984756_ul5817813181213"><li id="rds_05_0025__en-us_topic_0000001209984756_li17817513161216">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0025__en-us_topic_0000001209984756_table32267243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0025__en-us_topic_0000001209984756_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_05_0025__en-us_topic_0000001209984756_p9439626"><strong id="rds_05_0025__b129690170910">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_05_0025__en-us_topic_0000001209984756_p26412257"><strong id="rds_05_0025__b955512221197">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_05_0025__en-us_topic_0000001209984756_p59018101"><strong id="rds_05_0025__b861612241899">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0025__en-us_topic_0000001209984756_row15736877"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="rds_05_0025__en-us_topic_0000001209984756_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_05_0025__en-us_topic_0000001209984756_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_05_0025__en-us_topic_0000001209984756_p48259009">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0025__en-us_topic_0000001209984756_ul1595619589111"><li id="rds_05_0025__en-us_topic_0000001209984756_li13817101381220">Example normal response<pre class="codeblock" id="rds_05_0025__en-us_topic_0000001209984756_codeblock314170531760">{
|
|
"job_id": "2b414788a6004883a02390e2eb0ea227"
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="rds_05_0025__ul26818564"><li id="rds_05_0025__li33014451514">Abnormal response<p id="rds_05_0025__en-us_topic_0110967248_p014165512396"><a name="rds_05_0025__li33014451514"></a><a name="li33014451514"></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_0025__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0025__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0025__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0025__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0025__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0025__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0025__en-us_topic_0032347778_p0723374409"><a name="rds_05_0025__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_0025__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0025__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>
|
|
|