doc-exports/docs/dds/api-ref/dds_api_0050.html
Ru, Li Yi a6e39ff5b3 DDS_API
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>
2024-05-27 08:52:30 +00:00

77 lines
6.2 KiB
HTML

<a name="dds_api_0050"></a><a name="dds_api_0050"></a>
<h1 class="topictitle1">Performing a Primary/Secondary Switchover in a Replica Set Instance</h1>
<div id="body1508227694255"><div class="section" id="dds_api_0050__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0050__p12728183093920">This API is used to perform a primary/secondary switchover in a replica set instance.</p>
</div>
<div class="section" id="dds_api_0050__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0050__ul082311820560"><li id="dds_api_0050__li1982521814564">This API supports only DDS replica sets.</li><li id="dds_api_0050__li1594964614393">This operation cannot be performed on frozen or abnormal instances.</li></ul>
</div>
<div class="section" id="dds_api_0050__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0050__ul3084351717316"><li id="dds_api_0050__li915620217316">URI format<p id="dds_api_0050__p912862005412"><a name="dds_api_0050__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switchover</p>
</li><li id="dds_api_0050__li15430535">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0050__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0050__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0050__p34889605"><strong id="dds_api_0050__b84235270691445_1">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0050__p7485743"><strong id="dds_api_0050__b4562168172511">Mandatory</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0050__p2775334615440"><strong id="dds_api_0050__b1193810973518">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0050__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0050__p13784132454018">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0050__p22717550">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0050__p57877484163525">Specifies the project ID of a tenant in a region.</p>
</td>
</tr>
<tr id="dds_api_0050__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0050__p157845249405">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0050__p10737742155220">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0050__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dds_api_0050__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0050__ul39241291555"><li id="dds_api_0050__li2092418295517">Example request<p id="dds_api_0050__p13726732356"><a name="dds_api_0050__li2092418295517"></a><a name="li2092418295517"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover</p>
</li></ul>
</div>
<div class="section" id="dds_api_0050__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0050__ul12573920"><li id="dds_api_0050__li46056421">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0050__table32267243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0050__row9230088"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0050__p9439626"><strong id="dds_api_0050__b986813198327">Name</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0050__p26412257"><strong id="dds_api_0050__b11336122111322">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0050__p327014214317"><strong id="dds_api_0050__b67140469511">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="dds_api_0050__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0050__p6751103117513">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0050__p157511931653">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0050__p48259009">Indicates the task ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="dds_api_0050__ul16665627"><li id="dds_api_0050__li15772917">Response example<pre class="codeblock" id="dds_api_0050__codeblock660937479172">{
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
}</pre>
</li></ul>
</div>
<div class="section" id="dds_api_0050__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0050__en-us_topic_0000001387505349_p16131712193312">Status Code:202.</p>
<p id="dds_api_0050__en-us_topic_0000001387505349_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
</div>
<div class="section" id="dds_api_0050__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0050__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
</div>
</div>