forked from docs/doc-exports
Wang , Deng Ke
21e968a153
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>
97 lines
10 KiB
HTML
97 lines
10 KiB
HTML
<a name="rds_05_0013"></a><a name="rds_05_0013"></a>
|
|
|
|
<h1 class="topictitle1">Manually Switching Primary/Standby DB Instances</h1>
|
|
<div id="body32001227"><div class="section" id="rds_05_0013__en-us_topic_0231317997_section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0013__en-us_topic_0231317997_p19142153232816">This API is used to manually switch primary/standby DB instances as required.</p>
|
|
<ul id="rds_05_0013__en-us_topic_0231317997_ul12259155218373"><li id="rds_05_0013__en-us_topic_0231317997_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_0013__en-us_topic_0231317997_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_0013__en-us_topic_0231317997_section9207631102915"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0013__en-us_topic_0231317997_ul33533615300"><li id="rds_05_0013__en-us_topic_0231317997_li68131788300">This API is supported for primary/standby and cluster DB instances.</li><li id="rds_05_0013__en-us_topic_0231317997_li1382166144012">Primary/standby DB instances cannot be manually switched if they are in any of the following statuses:<ul id="rds_05_0013__en-us_topic_0231317997_ul6591513144117"><li id="rds_05_0013__en-us_topic_0231317997_li17461710114118">For MySQL, PostgreSQL and SQLServer: creating, rebooting, upgrading, changing instance class, restoring, changing port, or creating database account</li></ul>
|
|
<ul id="rds_05_0013__en-us_topic_0231317997_ul121619592404"><li id="rds_05_0013__en-us_topic_0231317997_li1312613287414">For MySQL: deleting database account</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0013__en-us_topic_0231317997_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0013__en-us_topic_0231317997_ul53354139141429"><li id="rds_05_0013__en-us_topic_0231317997_li1270098217262">URI format<p id="rds_05_0013__en-us_topic_0231317997_p30251930154721"><a name="rds_05_0013__en-us_topic_0231317997_li1270098217262"></a><a name="en-us_topic_0231317997_li1270098217262"></a>PUT https://{<em id="rds_05_0013__en-us_topic_0231317997_i2475051121512">Endpoint</em>}/v3/{<em id="rds_05_0013__en-us_topic_0231317997_i148911057155316">project_id</em>}/instances/{<em id="rds_05_0013__en-us_topic_0231317997_i923712547">instance_id</em>}/failover</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0013__en-us_topic_0231317997_ul49831254144655"><li id="rds_05_0013__en-us_topic_0231317997_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0013__en-us_topic_0231317997_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0013__en-us_topic_0231317997_row60083059"><th align="left" class="cellrowborder" valign="top" width="20.93%" id="mcps1.3.3.3.1.1.2.4.1.1"><p id="rds_05_0013__en-us_topic_0231317997_p34889605"><strong id="rds_05_0013__en-us_topic_0231317997_b492244919264">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.6%" id="mcps1.3.3.3.1.1.2.4.1.2"><p id="rds_05_0013__en-us_topic_0231317997_p7485743"><strong id="rds_05_0013__en-us_topic_0231317997_b1318365032613">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_0013__en-us_topic_0231317997_p2365466"><strong id="rds_05_0013__en-us_topic_0231317997_b34092508261">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0013__en-us_topic_0231317997_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0013__en-us_topic_0231317997_p17679057">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0013__en-us_topic_0231317997_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_0013__en-us_topic_0231317997_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0013__en-us_topic_0231317997_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_05_0013__en-us_topic_0231317997_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0013__en-us_topic_0231317997_p41557789155220">instance_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.6%" headers="mcps1.3.3.3.1.1.2.4.1.2 "><p id="rds_05_0013__en-us_topic_0231317997_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_0013__en-us_topic_0231317997_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0013__en-us_topic_0231317997_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0013__en-us_topic_0231317997_ul5099287616954"><li id="rds_05_0013__en-us_topic_0231317997_li5628270116954">Parameter description<p id="rds_05_0013__en-us_topic_0231317997_p185221257337"><a name="rds_05_0013__en-us_topic_0231317997_li5628270116954"></a><a name="en-us_topic_0231317997_li5628270116954"></a>None</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0013__ul6438172212339"><li id="rds_05_0013__li4411135064210">Example<p id="rds_05_0013__p1454414211213"><a name="rds_05_0013__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0013__en-us_topic_0231317997_ul18318676175816"><li id="rds_05_0013__en-us_topic_0231317997_li30650356175816">Request example<pre class="codeblock" id="rds_05_0013__en-us_topic_0231317997_codeblock26701898174649">{}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0013__en-us_topic_0231317997_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0013__en-us_topic_0231317997_ul12573920"><li id="rds_05_0013__en-us_topic_0231317997_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0013__en-us_topic_0231317997_table394616341361" frame="border" border="1" rules="all"><thead align="left"><tr id="rds_05_0013__en-us_topic_0231317997_row69478341366"><th align="left" class="cellrowborder" valign="top" width="25.1%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="rds_05_0013__en-us_topic_0231317997_p69471134123611"><strong id="rds_05_0013__en-us_topic_0231317997_b337475925813">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="74.9%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="rds_05_0013__en-us_topic_0231317997_p159479347366"><strong id="rds_05_0013__en-us_topic_0231317997_b246319215918">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0013__en-us_topic_0231317997_row14947193443620"><td class="cellrowborder" valign="top" width="25.1%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="rds_05_0013__en-us_topic_0231317997_p1994703413361">workflowId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="74.9%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="rds_05_0013__en-us_topic_0231317997_p2947934123610">Indicates the workflow ID.</p>
|
|
<p id="rds_05_0013__p1145784310228">For details about how to query this parameter, see <a href="rds_01_0009.html">Obtaining Task Information</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0013__en-us_topic_0231317997_row494715344363"><td class="cellrowborder" valign="top" width="25.1%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="rds_05_0013__en-us_topic_0231317997_p107113562134">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="74.9%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="rds_05_0013__en-us_topic_0231317997_p8947134193611">Indicates the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0013__en-us_topic_0231317997_row85753587363"><td class="cellrowborder" valign="top" width="25.1%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="rds_05_0013__en-us_topic_0231317997_p257535863613">nodeId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="74.9%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="rds_05_0013__p17764175018715">Indicates former slave node that becomes a master node.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0013__en-us_topic_0231317997_ul16665627"><li id="rds_05_0013__en-us_topic_0231317997_li15772917">Example normal response<pre class="codeblock" id="rds_05_0013__en-us_topic_0231317997_codeblock314170531760">{
|
|
"workflowId":"072beb09-0573-40bf-bfe8-4be5cec9e85a",
|
|
"instanceId":"794c38e5309344818f4b33b86ebce9b4in03",
|
|
"nodeId":"b94ba815747040f1b0d641cd13364a06no03"
|
|
}</pre>
|
|
</li><li id="rds_05_0013__en-us_topic_0231317997_li68218279114">Abnormal response<p id="rds_05_0013__en-us_topic_0231317997_p28475059"><a name="rds_05_0013__en-us_topic_0231317997_li68218279114"></a><a name="en-us_topic_0231317997_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_05_0013__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0013__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0013__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0013__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0013__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0013__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0013__en-us_topic_0032347778_p0723374409"><a name="rds_05_0013__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_0013__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0013__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>
|
|
|