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>
130 lines
9.9 KiB
HTML
130 lines
9.9 KiB
HTML
<a name="dds_api_0058"></a><a name="dds_api_0058"></a>
|
|
|
|
<h1 class="topictitle1">Changing a Private IP Address</h1>
|
|
<div id="body1540173589336"><div class="section" id="dds_api_0058__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0058__p3631239417316">This API is used to change the private IP address of a DB instance.</p>
|
|
</div>
|
|
<div class="section" id="dds_api_0058__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0058__ul1349153115110"><li id="dds_api_0058__li15447401739">This operation cannot be performed on frozen or abnormal instances.</li><li id="dds_api_0058__li544194011316">An in-use IP address cannot be used as the new private IP address of a DB instance.</li><li id="dds_api_0058__li644184019313">Changing the private IP address will cause the original database connection address to become invalid. If an EIP has been bound to the DB instance, do not unbind the EIP when the private IP address is being changed.</li><li id="dds_api_0058__li6449409314">This operation is not allowed if connection address switchover is enabled.</li><li id="dds_api_0058__li171681511134">Currently, only the IPv4 address is supported.</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0058__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0058__ul3084351717316"><li id="dds_api_0058__li915620217316">URI format<p id="dds_api_0058__p912862005412"><a name="dds_api_0058__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-internal-ip</p>
|
|
</li><li id="dds_api_0058__li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0058__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0058__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_0058__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_0058__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_0058__p2775334615440">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0058__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0058__p732920567115">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_0058__p532935613116">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_0058__p4329756415">Specifies the project ID of a tenant in a region.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0058__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0058__p963319528116">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_0058__p1032910565114">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_0058__p15330656516">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_0058__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0058__ul5099287616954"><li id="dds_api_0058__li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0058__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0058__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_0058__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_0058__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_0058__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_0058__p222501215320">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0058__row794180116954"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0058__p37323919416">new_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_0058__p107333911419">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_0058__p18748396418">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_0058__p9742039644">Specifies the new IP address, which must be in an available VPC CIDR block. Only IPv4 is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0058__row8551715205814"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0058__p18744391445">node_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_0058__p18743391446">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_0058__p374439545">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_0058__p17749394417">Specifies the node ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0058__ul1041877316954"><li id="dds_api_0058__li2666010016954">Example request<div class="p" id="dds_api_0058__p175104144204"><a name="dds_api_0058__li2666010016954"></a><a name="li2666010016954"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-internal-ip<pre class="codeblock" id="dds_api_0058__codeblock14529111052020">{
|
|
"node_id": "52a4c096bb1f455d8d866956a959519eno02",
|
|
"new_ip": "192.168.0.133"
|
|
}</pre>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0058__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0058__ul12573920"><li id="dds_api_0058__li46056421">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0058__table32267243" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0058__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_0058__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_0058__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_0058__p327014214317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dds_api_0058__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0058__p0284191519">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_0058__p12284591654">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_0058__p12284892515">Indicates the workflow ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0058__row263544116490"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0058__p152841292510">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_0058__p02841592516">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_0058__p112848911516">Indicates the node ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dds_api_0058__row10449661708"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0058__p112841191650">new_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_0058__p162840913517">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_0058__p142841591758">Indicates the new private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="dds_api_0058__ul16665627"><li id="dds_api_0058__li15772917">Response example<pre class="codeblock" id="dds_api_0058__codeblock660937479172">{
|
|
"job_id":"3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
|
"node_id":"52a4c096bb1f455d8d866956a959519eno02",
|
|
"new_ip":"192.168.0.133"
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dds_api_0058__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0058__dds_api_0018_p16131712193312">Status Code:200.</p>
|
|
<p id="dds_api_0058__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_0058__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0058__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>
|
|
|