forked from docs/doc-exports
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com> Co-authored-by: wangdengke2 <wangdengke2@huawei.com> Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
142 lines
13 KiB
HTML
142 lines
13 KiB
HTML
<a name="rds_05_0020"></a><a name="rds_05_0020"></a>
|
|
|
|
<h1 class="topictitle1">Changing a Floating IP Address</h1>
|
|
<div id="body32001227"><div class="section" id="rds_05_0020__en-us_topic_0238844980_section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0020__en-us_topic_0238844980_p324485510540">This API is used to change the floating IP address of a DB instance.</p>
|
|
<ul id="rds_05_0020__en-us_topic_0238844980_ul12259155218373"><li id="rds_05_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_section9207631102915"><h4 class="sectiontitle">Constraints</h4><p id="rds_05_0020__p231193123811">The floating IP address cannot be changed if the DB instance is in any of the following statuses: creating, rebooting, upgrading, changing instance class, creating users, or deleting users.</p>
|
|
</div>
|
|
<div class="section" id="rds_05_0020__en-us_topic_0238844980_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0020__en-us_topic_0238844980_ul53354139141429"><li id="rds_05_0020__en-us_topic_0238844980_li4411135064210">URI format<p id="rds_05_0020__en-us_topic_0238844980_p30251930154721"><a name="rds_05_0020__en-us_topic_0238844980_li4411135064210"></a><a name="en-us_topic_0238844980_li4411135064210"></a>PUT https://{<em id="rds_05_0020__en-us_topic_0238844980_i2475051121512">Endpoint</em>}/v3/{<em id="rds_05_0020__en-us_topic_0238844980_i148911057155316">project_id</em>}/instances/{<em id="rds_05_0020__en-us_topic_0238844980_i923712547">instance_id</em>}/ip</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0020__en-us_topic_0238844980_ul49831254144655"><li id="rds_05_0020__en-us_topic_0238844980_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0020__en-us_topic_0238844980_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_p34889605"><strong id="rds_05_0020__en-us_topic_0238844980_b38698166175">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_0020__en-us_topic_0238844980_p7485743"><strong id="rds_05_0020__en-us_topic_0238844980_b1497171791711">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_0020__en-us_topic_0238844980_p2365466"><strong id="rds_05_0020__en-us_topic_0238844980_b118261317101718">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0020__en-us_topic_0238844980_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_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_0020__en-us_topic_0238844980_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0020__en-us_topic_0238844980_section3074340117316"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0020__table12536623333" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="rds_05_0020__row153612211337"><th align="left" class="cellrowborder" valign="top" width="19.7%" id="mcps1.3.4.2.2.5.1.1"><p id="rds_05_0020__p95111733143318">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.780000000000001%" id="mcps1.3.4.2.2.5.1.2"><p id="rds_05_0020__p13511123373311">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.959999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="rds_05_0020__p125111433133312">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.559999999999995%" id="mcps1.3.4.2.2.5.1.4"><p id="rds_05_0020__p551110331335">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0020__row353717218338"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_05_0020__p18511533163317">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_05_0020__p13511153333312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_05_0020__p55111833183319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_05_0020__p35111331332">The content type.</p>
|
|
<p id="rds_05_0020__p1351133311330">The default value is <strong id="rds_05_0020__b105111133143310">application/json</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="rds_05_0020__row05378213331"><td class="cellrowborder" valign="top" width="19.7%" headers="mcps1.3.4.2.2.5.1.1 "><p id="rds_05_0020__p1163015550331">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.780000000000001%" headers="mcps1.3.4.2.2.5.1.2 "><p id="rds_05_0020__p1963035563316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.959999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="rds_05_0020__p1630105520331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.559999999999995%" headers="mcps1.3.4.2.2.5.1.4 "><p id="rds_05_0020__p1086851153317">Specifies the user token.</p>
|
|
<p id="rds_05_0020__p1057635831">The user token is a response to the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0020__en-us_topic_0238844980_table11236435" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0020__en-us_topic_0238844980_row61525259"><th align="left" class="cellrowborder" valign="top" width="22.550000000000004%" id="mcps1.3.4.3.2.5.1.1"><p id="rds_05_0020__en-us_topic_0238844980_p17490046"><strong id="rds_05_0020__en-us_topic_0238844980_b14201123013178">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.060000000000002%" id="mcps1.3.4.3.2.5.1.2"><p id="rds_05_0020__en-us_topic_0238844980_p7407659"><strong id="rds_05_0020__en-us_topic_0238844980_b8675133081715">Mandatory</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.71%" id="mcps1.3.4.3.2.5.1.3"><p id="rds_05_0020__en-us_topic_0238844980_p63149496"><strong id="rds_05_0020__en-us_topic_0238844980_b1496033061715">Type</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="44.68%" id="mcps1.3.4.3.2.5.1.4"><p id="rds_05_0020__en-us_topic_0238844980_p14835533"><strong id="rds_05_0020__en-us_topic_0238844980_b0307163110179">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0020__en-us_topic_0238844980_row60827539"><td class="cellrowborder" valign="top" width="22.550000000000004%" headers="mcps1.3.4.3.2.5.1.1 "><p id="rds_05_0020__en-us_topic_0238844980_p15429124315910">new_ip</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.060000000000002%" headers="mcps1.3.4.3.2.5.1.2 "><p id="rds_05_0020__en-us_topic_0238844980_p60181840">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.71%" headers="mcps1.3.4.3.2.5.1.3 "><p id="rds_05_0020__en-us_topic_0238844980_p42890904">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="44.68%" headers="mcps1.3.4.3.2.5.1.4 "><p id="rds_05_0020__en-us_topic_0238844980_p10705173145713">Indicates the private IP address.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="rds_05_0020__section867962816410"><h4 class="sectiontitle">Example Request</h4><p id="rds_05_0020__p63961636141">Change the floating IP address of a DB instance.</p>
|
|
<pre class="screen" id="rds_05_0020__screen155318105126">PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/ip
|
|
|
|
{
|
|
"new_ip": "192.168.0.1"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="rds_05_0020__en-us_topic_0238844980_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0020__en-us_topic_0238844980_ul12573920"><li id="rds_05_0020__en-us_topic_0238844980_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0020__en-us_topic_0238844980_table394616341361" frame="border" border="1" rules="all"><thead align="left"><tr id="rds_05_0020__en-us_topic_0238844980_row69478341366"><th align="left" class="cellrowborder" valign="top" width="25.1%" id="mcps1.3.6.2.1.1.1.3.1.1"><p id="rds_05_0020__en-us_topic_0238844980_p69471134123611"><strong id="rds_05_0020__en-us_topic_0238844980_b1995245101716">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="74.9%" id="mcps1.3.6.2.1.1.1.3.1.2"><p id="rds_05_0020__en-us_topic_0238844980_p159479347366"><strong id="rds_05_0020__en-us_topic_0238844980_b1232134616176">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0020__en-us_topic_0238844980_row14947193443620"><td class="cellrowborder" valign="top" width="25.1%" headers="mcps1.3.6.2.1.1.1.3.1.1 "><p id="rds_05_0020__en-us_topic_0238844980_p1994703413361">workflowId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="74.9%" headers="mcps1.3.6.2.1.1.1.3.1.2 "><p id="rds_05_0020__en-us_topic_0238844980_p2947934123610">Indicates the workflow ID.</p>
|
|
<p id="rds_05_0020__p1145784310228">For details about how to query this parameter, see <a href="rds_13_0003.html">Obtaining Information About a Task with a Specified ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0020__en-us_topic_0238844980_ul189926552558"><li id="rds_05_0020__en-us_topic_0238844980_li15772917">Example normal response<pre class="screen" id="rds_05_0020__screen91418335518">{
|
|
"workflowId":"83abc7bc-2c70-4534-8565-351187b37715"
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="rds_05_0020__en-us_topic_0238844980_ul16665627"><li id="rds_05_0020__en-us_topic_0238844980_li68218279114">Abnormal response<p id="rds_05_0020__en-us_topic_0238844980_p28475059"><a name="rds_05_0020__en-us_topic_0238844980_li68218279114"></a><a name="en-us_topic_0238844980_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_0020__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0020__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0020__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0020__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0020__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0020__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0020__en-us_topic_0032347778_p0723374409"><a name="rds_05_0020__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_0020__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0020__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="rds_07_0000.html">Database Security</a></div>
|
|
</div>
|
|
</div>
|
|
|