forked from docs/doc-exports
Wang , Deng Ke
60010eb9d0
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>
147 lines
11 KiB
HTML
147 lines
11 KiB
HTML
<a name="dds_api_0056"></a><a name="dds_api_0056"></a>
|
|
|
|
<h1 class="topictitle1">Binding an <span id="text637619162710"></span><span id="text230210193713">EIP</span></h1>
|
|
<div id="body1579243011623"><div class="section" id="dds_api_0056__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0056__p3631239417316">This API is used to bind an EIP to a node in a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0056__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0056__ul17254124925714"><li id="dds_api_0056__li1225474925710">This operation cannot be performed on frozen or abnormal instances.</li><li id="dds_api_0056__li34011952125719">Hidden nodes do not support this operation.</li><li id="dds_api_0056__li8254174925716">Multiple EIPs cannot be bound to the same node.</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0056__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0056__ul3084351717316"><li id="dds_api_0056__li915620217316">URI format<p id="dds_api_0056__p912862005412"><a name="dds_api_0056__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/bind-eip</p>
|
|
</li><li id="dds_api_0056__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0056__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0056__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_0056__p34889605">Name</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_0056__p7485743">Mandatory</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_0056__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0056__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0056__p1432114339588">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_0056__p1632116331589">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_0056__p132163345811">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0056__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0056__p4321533105814">node_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_0056__p19321143375817">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_0056__p64876368584">Specifies the ID of the node to which the EIP is to be bound.</p>
|
|
<ul id="dds_api_0056__ul86468509587"><li id="dds_api_0056__li4646205019589">Select the mongos node in a cluster instance</li><li id="dds_api_0056__li16646750165814">Select the primary or secondary node in a replica set instance.</li><li id="dds_api_0056__li1646175015588">Select the primary node in a single node instance</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0056__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0056__ul5099287616954"><li id="dds_api_0056__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0056__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0056__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0056__p1204887716954">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.75%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0056__p15184124818564">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="21.64%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0056__p3643495116954">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="43.44%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0056__p222501215320">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0056__row794180116954"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0056__p13944466595">public_ip_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.75%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0056__p11944568594">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0056__p6944464597">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.44%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0056__p99446625913">Specifies the ID of the <span id="dds_api_0056__text1557110391688"></span><span id="dds_api_0056__text2530742781">EIP</span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0056__row8551715205814"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0056__p179444655912">public_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.75%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0056__p14944766597">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="21.64%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0056__p10944196155920">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="43.44%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0056__p9944146135916">Specifies the <span id="dds_api_0056__text929254812817"></span><span id="dds_api_0056__text3721257187">EIP</span>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0056__ul1041877316954"><li id="dds_api_0056__li2666010016954">Example request<div class="p" id="dds_api_0056__p768794513156"><a name="dds_api_0056__li2666010016954"></a><a name="li2666010016954"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/bind-eip<pre class="codeblock" id="dds_api_0056__codeblock194584421510">{
|
|
"public_ip": "10.145.51.128",
|
|
"public_ip_id": "45da4782-e0c8-4aa4-a290-b8740014f710"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0056__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0056__ul12573920"><li id="dds_api_0056__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0056__table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0056__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_0056__p9439626">Name</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_0056__p26412257">Type</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_0056__p327014214317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0056__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0056__p5246123017">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_0056__p1424121218015">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_0056__p18240121408">Indicates the workflow ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0056__row263544116490"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0056__p6247122020">node_name</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_0056__p22431218014">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_0056__p724312808">Indicates the node name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0056__row10449661708"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0056__p1624012806">node_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_0056__p424171215015">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_0056__p3243121009">Indicates the node ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0056__row1487223207"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0056__p1524812808">public_ip_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_0056__p1224161213015">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_0056__p3245121109">Indicates the ID of the <span id="dds_api_0056__text078319344212"></span><span id="dds_api_0056__text12784103174216">EIP</span>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0056__row18968501305"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0056__p152412121104">public_ip</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_0056__p8241912106">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_0056__p1249121507">Indicates the <span id="dds_api_0056__text4921944114113"></span><span id="dds_api_0056__text292264410415">EIP</span>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0056__ul16665627"><li id="dds_api_0056__li15772917">Response example<pre class="codeblock" id="dds_api_0056__codeblock660937479172">{
|
|
"job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
|
"node_id":"52a4c096bb1f455d8d866956a959519eno02",
|
|
"node_name":"mongodb-8977_mongos_node_1",
|
|
"public_ip":"10.145.51.128",
|
|
"public_ip_id":"45da4782-e0c8-4aa4-a290-b8740014f710"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0056__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0056__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0056__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0056__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0056__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>
|
|
|