forked from docs/doc-exports
Wang , Deng Ke
21e968a153
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>
110 lines
12 KiB
HTML
110 lines
12 KiB
HTML
<a name="rds_05_0018"></a><a name="rds_05_0018"></a>
|
|
|
|
<h1 class="topictitle1">Changing a Database Port</h1>
|
|
<div id="body32001227"><div class="section" id="rds_05_0018__en-us_topic_0238844978_section10502114133410"><h4 class="sectiontitle">Function</h4><p id="rds_05_0018__en-us_topic_0238844978_p1369415371019">This API is used to change a database port.</p>
|
|
<ul id="rds_05_0018__en-us_topic_0238844978_ul12259155218373"><li id="rds_05_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_section9207631102915"><h4 class="sectiontitle">Constraints</h4><ul id="rds_05_0018__ul1097011310592"><li id="rds_05_0018__li5970111385913">Changing of port will affect RDS instance access. Relevant Security group rules will need to be adapted. Also access from application/ECS side will need to change accordingly.</li><li id="rds_05_0018__li1872320278111">The database port cannot be changed when a DB instance is being created or rebooted, its specifications are being modified, database users are being created or deleted, or backups are being created for the DB instance.</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0018__en-us_topic_0238844978_section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="rds_05_0018__en-us_topic_0238844978_ul53354139141429"><li id="rds_05_0018__en-us_topic_0238844978_li4411135064210">URI format<p id="rds_05_0018__en-us_topic_0238844978_p30251930154721"><a name="rds_05_0018__en-us_topic_0238844978_li4411135064210"></a><a name="en-us_topic_0238844978_li4411135064210"></a>PUT https://{<em id="rds_05_0018__en-us_topic_0238844978_i2475051121512">Endpoint</em>}/v3/{<em id="rds_05_0018__en-us_topic_0238844978_i148911057155316">project_id</em>}/instances/{<em id="rds_05_0018__en-us_topic_0238844978_i923712547">instance_id</em>}/port</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0018__en-us_topic_0238844978_ul49831254144655"><li id="rds_05_0018__en-us_topic_0238844978_li15430535">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0018__en-us_topic_0238844978_table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_p34889605"><strong id="rds_05_0018__en-us_topic_0238844978_b167598240711">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_0018__en-us_topic_0238844978_p7485743"><strong id="rds_05_0018__en-us_topic_0238844978_b54293251378">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_0018__en-us_topic_0238844978_p2365466"><strong id="rds_05_0018__en-us_topic_0238844978_b6791122510716">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0018__en-us_topic_0238844978_row57385070"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_p28182251">Specifies the project ID of a tenant in a region.</p>
|
|
<p id="rds_05_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_row2864326155157"><td class="cellrowborder" valign="top" width="20.93%" headers="mcps1.3.3.3.1.1.2.4.1.1 "><p id="rds_05_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_p64450739155220">Specifies the DB instance ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0018__en-us_topic_0238844978_section3074340117316"><h4 class="sectiontitle">Request</h4><ul id="rds_05_0018__en-us_topic_0238844978_ul5099287616954"><li id="rds_05_0018__en-us_topic_0238844978_li5628270116954">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0018__en-us_topic_0238844978_table11236435" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="rds_05_0018__en-us_topic_0238844978_row61525259"><th align="left" class="cellrowborder" valign="top" width="22.550000000000004%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="rds_05_0018__en-us_topic_0238844978_p17490046"><strong id="rds_05_0018__en-us_topic_0238844978_b105611039277">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.060000000000002%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="rds_05_0018__en-us_topic_0238844978_p7407659"><strong id="rds_05_0018__en-us_topic_0238844978_b325417402712">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_0018__en-us_topic_0238844978_p63149496"><strong id="rds_05_0018__en-us_topic_0238844978_b196141540176">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_0018__en-us_topic_0238844978_p14835533"><strong id="rds_05_0018__en-us_topic_0238844978_b27978414718">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0018__en-us_topic_0238844978_row60827539"><td class="cellrowborder" valign="top" width="22.550000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="rds_05_0018__en-us_topic_0238844978_p28083633">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.060000000000002%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="rds_05_0018__en-us_topic_0238844978_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_0018__en-us_topic_0238844978_p42890904">Integer</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_0018__p20366185719611">Specifies port information for all DB engines.</p>
|
|
<ul id="rds_05_0018__ul10304361276"><li id="rds_05_0018__li12304869716">The MySQL database port ranges from 1024 to 65535 (excluding 12017 and 33071, which are occupied by the RDS system and cannot be used).</li><li id="rds_05_0018__li19149121211720">The PostgreSQL database port ranges from 2100 to 9500.</li><li id="rds_05_0018__li4993111517717">The Microsoft SQL Server database port is 1433 or ranges from 2100 to 9500 (excluding 5355 and 5985).</li></ul>
|
|
<p id="rds_05_0018__p19366157264">The default values is as follows:</p>
|
|
<ul id="rds_05_0018__ul104991134812"><li id="rds_05_0018__li1049915131082">The default value of MySQL is 3306.</li><li id="rds_05_0018__li1427418498815">The default value of PostgreSQL is 5432.</li><li id="rds_05_0018__li141928152093">The default value of Microsoft SQL Server is 1433.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0018__ul66019506384"><li id="rds_05_0018__li7654145305711">Example<p id="rds_05_0018__p1454414211213"><a name="rds_05_0018__li7654145305711"></a><a name="li7654145305711"></a>PUT https://rds.eu-de.otc.t-systems.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/port</p>
|
|
</li></ul>
|
|
<ul id="rds_05_0018__en-us_topic_0238844978_ul18318676175816"><li id="rds_05_0018__en-us_topic_0238844978_li30650356175816">Request example<pre class="codeblock" id="rds_05_0018__en-us_topic_0238844978_codeblock26701898174649">{
|
|
"port": 8836
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="rds_05_0018__en-us_topic_0238844978_section28521534113742"><h4 class="sectiontitle">Response</h4><ul id="rds_05_0018__en-us_topic_0238844978_ul12573920"><li id="rds_05_0018__en-us_topic_0238844978_li46056421">Normal response
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="rds_05_0018__en-us_topic_0238844978_table394616341361" frame="border" border="1" rules="all"><thead align="left"><tr id="rds_05_0018__en-us_topic_0238844978_row69478341366"><th align="left" class="cellrowborder" valign="top" width="25.1%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="rds_05_0018__en-us_topic_0238844978_p69471134123611"><strong id="rds_05_0018__en-us_topic_0238844978_b488919401111">Name</strong></p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="74.9%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="rds_05_0018__en-us_topic_0238844978_p159479347366"><strong id="rds_05_0018__en-us_topic_0238844978_b1232184113116">Description</strong></p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="rds_05_0018__en-us_topic_0238844978_row14947193443620"><td class="cellrowborder" valign="top" width="25.1%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="rds_05_0018__en-us_topic_0238844978_p1994703413361">workflowId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="74.9%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="rds_05_0018__en-us_topic_0238844978_p2947934123610">Indicates the workflow ID.</p>
|
|
<p id="rds_05_0018__p1145784310228">For details about how to query this parameter, see <a href="rds_01_0009.html">Obtaining Task Information</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<ul id="rds_05_0018__en-us_topic_0238844978_ul16665627"><li id="rds_05_0018__en-us_topic_0238844978_li15772917">Example normal response<pre class="codeblock" id="rds_05_0018__en-us_topic_0238844978_codeblock314170531760">{
|
|
"workflowId":"83abc7bc-2c70-4534-8565-351187b37715"
|
|
}</pre>
|
|
</li><li id="rds_05_0018__en-us_topic_0238844978_li68218279114">Abnormal response<p id="rds_05_0018__en-us_topic_0238844978_p28475059"><a name="rds_05_0018__en-us_topic_0238844978_li68218279114"></a><a name="en-us_topic_0238844978_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_0018__section4778540915440"><h4 class="sectiontitle">Status Code</h4><ul id="rds_05_0018__en-us_topic_0032347778_ul7858132212142"><li id="rds_05_0018__en-us_topic_0032347778_li58581622171411">Normal<p id="rds_05_0018__en-us_topic_0032347778_p1040982941020"><a name="rds_05_0018__en-us_topic_0032347778_li58581622171411"></a><a name="en-us_topic_0032347778_li58581622171411"></a>200</p>
|
|
</li><li id="rds_05_0018__en-us_topic_0032347778_li11583183218149">Abnormal<p id="rds_05_0018__en-us_topic_0032347778_p0723374409"><a name="rds_05_0018__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_0018__section1183074220016"><h4 class="sectiontitle">Error Code</h4><p id="rds_05_0018__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>
|
|
|