doc-exports/docs/rds/api-ref/rds_05_0012.html
Wang , Deng Ke 21e968a153 rds api 2.0.38sp24 version
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>
2023-01-12 13:50:31 +00:00

91 lines
11 KiB
HTML

<a name="rds_05_0012"></a><a name="rds_05_0012"></a>
<h1 class="topictitle1">Changing the Failover Priority</h1>
<div id="body32001227"><div class="section" id="rds_05_0012__en-us_topic_0231317996_section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0012__en-us_topic_0231317996_p19142153232816">This API is used to change the <span class="keyword" id="rds_05_0012__en-us_topic_0231317996_keyword597765755218">failover priority</span> for primary/standby DB instances to meet different service requirements. You can select <strong id="rds_05_0012__en-us_topic_0231317996_b2438281933">Reliability First</strong> or <strong id="rds_05_0012__en-us_topic_0231317996_b1449301117320">Availability First</strong>.</p>
<ul id="rds_05_0012__en-us_topic_0231317996_ul12259155218373"><li id="rds_05_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_section9207631102915"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0012__en-us_topic_0231317996_ul1396256192117"><li id="rds_05_0012__en-us_topic_0231317996_li18257171112113">This API is supported for primary/standby and cluster DB instances.</li><li id="rds_05_0012__en-us_topic_0231317996_li18962106122114">The failover priority cannot be changed if the DB instance is in any of the following statuses: creating, upgrading, creating users, or deleting users.</li></ul>
</div>
<div class="section" id="rds_05_0012__en-us_topic_0231317996_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0012__en-us_topic_0231317996_ul53354139141429"><li id="rds_05_0012__en-us_topic_0231317996_li1270098217262">URI format<p id="rds_05_0012__en-us_topic_0231317996_p30251930154721"><a name="rds_05_0012__en-us_topic_0231317996_li1270098217262"></a><a name="en-us_topic_0231317996_li1270098217262"></a>PUT /v3/{<em id="rds_05_0012__en-us_topic_0231317996_i148911057155316">project_id</em>}/instances/{<em id="rds_05_0012__en-us_topic_0231317996_i923712547">instance_id</em>}/failover/strategy</p>
</li></ul>
<ul id="rds_05_0012__en-us_topic_0231317996_ul49831254144655"><li id="rds_05_0012__en-us_topic_0231317996_li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0012__en-us_topic_0231317996_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_p34889605"><strong id="rds_05_0012__en-us_topic_0231317996_b10835181671017">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_0012__en-us_topic_0231317996_p7485743"><strong id="rds_05_0012__en-us_topic_0231317996_b655018173107">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_0012__en-us_topic_0231317996_p2365466"><strong id="rds_05_0012__en-us_topic_0231317996_b16629186107">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0012__en-us_topic_0231317996_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_p28182251">Specifies the project ID of a tenant in a region.</p>
<p id="rds_05_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_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_0012__en-us_topic_0231317996_p64450739155220">Specifies the DB instance ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="rds_05_0012__en-us_topic_0231317996_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0012__en-us_topic_0231317996_ul5099287616954"><li id="rds_05_0012__en-us_topic_0231317996_li5628270116954">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0012__en-us_topic_0231317996_table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0012__en-us_topic_0231317996_row61525259"><th align="left" class="cellrowborder" valign="top" width="18.110000000000003%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_05_0012__en-us_topic_0231317996_p17490046"><strong id="rds_05_0012__en-us_topic_0231317996_b2049214315109">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.500000000000004%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_05_0012__en-us_topic_0231317996_p7407659"><strong id="rds_05_0012__en-us_topic_0231317996_b1599363115101">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="rds_05_0012__en-us_topic_0231317996_p63149496"><strong id="rds_05_0012__en-us_topic_0231317996_b862253219105">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="rds_05_0012__en-us_topic_0231317996_p14835533"><strong id="rds_05_0012__en-us_topic_0231317996_b8931333161010">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="rds_05_0012__en-us_topic_0231317996_row60827539"><td class="cellrowborder" valign="top" width="18.110000000000003%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_05_0012__en-us_topic_0231317996_p28083633">repairStrategy</p>
</td>
<td class="cellrowborder" valign="top" width="18.500000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_05_0012__en-us_topic_0231317996_p60181840">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="rds_05_0012__en-us_topic_0231317996_p42890904">String</p>
</td>
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="rds_05_0012__en-us_topic_0231317996_p4388917103812">Specifies the failover priority. Valid value:</p>
<ul id="rds_05_0012__en-us_topic_0231317996_ul28431433202424"><li id="rds_05_0012__en-us_topic_0231317996_li54220889202424"><strong id="rds_05_0012__en-us_topic_0231317996_b11885235181311">reliability</strong>: Data reliability is preferentially ensured during the failover to minimize the amount of lost data. It is recommended for services that require high data consistency.</li><li id="rds_05_0012__en-us_topic_0231317996_li53530971202511"><strong id="rds_05_0012__en-us_topic_0231317996_b1821742111315">availability</strong>: Data availability is preferentially ensured during the failover to recover services quickly. It is recommended for services that have high requirements on the database online duration.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="rds_05_0012__ul123061812173116"><li id="rds_05_0012__li4411135064210">Example<p id="rds_05_0012__p1454414211213"><a name="rds_05_0012__li4411135064210"></a><a name="li4411135064210"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/failover/strategy</p>
</li></ul>
<ul id="rds_05_0012__en-us_topic_0231317996_ul18318676175816"><li id="rds_05_0012__en-us_topic_0231317996_li30650356175816">Request example<pre class="codeblock" id="rds_05_0012__en-us_topic_0231317996_codeblock26701898174649">{
"repairStrategy": "availability"
}</pre>
</li></ul>
</div>
<div class="section" id="rds_05_0012__en-us_topic_0231317996_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0012__en-us_topic_0231317996_ul12573920"><li id="rds_05_0012__en-us_topic_0231317996_li46056421">Normal response<p id="rds_05_0012__en-us_topic_0231317996_p4989115420592"><a name="rds_05_0012__en-us_topic_0231317996_li46056421"></a><a name="en-us_topic_0231317996_li46056421"></a>None</p>
</li></ul>
<ul id="rds_05_0012__en-us_topic_0231317996_ul16665627"><li id="rds_05_0012__en-us_topic_0231317996_li15772917">Example normal response<pre class="codeblock" id="rds_05_0012__en-us_topic_0231317996_codeblock314170531760">{}</pre>
</li><li id="rds_05_0012__en-us_topic_0231317996_li68218279114">Abnormal response<p id="rds_05_0012__en-us_topic_0231317996_p28475059"><a name="rds_05_0012__en-us_topic_0231317996_li68218279114"></a><a name="en-us_topic_0231317996_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_0012__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0012__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0012__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0012__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0012__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
</li><li id="rds_05_0012__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0012__en-us_topic_0032347778_p0723374409"><a name="rds_05_0012__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_0012__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0012__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>